diff --git a/static/v2.15.x/CLIReference_Zowe.pdf b/static/v2.15.x/CLIReference_Zowe.pdf new file mode 100644 index 0000000000..ad3d378e40 Binary files /dev/null and b/static/v2.15.x/CLIReference_Zowe.pdf differ diff --git a/static/v2.15.x/Zowe_CLI_Installation_Checklist.xlsx b/static/v2.15.x/Zowe_CLI_Installation_Checklist.xlsx new file mode 100644 index 0000000000..3f625013e0 Binary files /dev/null and b/static/v2.15.x/Zowe_CLI_Installation_Checklist.xlsx differ diff --git a/static/v2.15.x/Zowe_Overview.pdf b/static/v2.15.x/Zowe_Overview.pdf new file mode 100644 index 0000000000..84bf274085 Binary files /dev/null and b/static/v2.15.x/Zowe_Overview.pdf differ diff --git a/static/v2.15.x/typedoc/assets/css/main.css b/static/v2.15.x/typedoc/assets/css/main.css new file mode 100644 index 0000000000..3c0dcab926 --- /dev/null +++ b/static/v2.15.x/typedoc/assets/css/main.css @@ -0,0 +1 @@ +/*! normalize.css v1.1.3 | MIT License | git.io/normalize */article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none;height:0}[hidden]{display:none}html{font-size:100%;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%;font-family:sans-serif}button,input,select,textarea{font-family:sans-serif}body{margin:0}a:focus{outline:thin dotted}a:active,a:hover{outline:0}h1{font-size:2em;margin:.67em 0}h2{font-size:1.5em;margin:.83em 0}h3{font-size:1.17em;margin:1em 0}h4,.tsd-index-panel h3{font-size:1em;margin:1.33em 0}h5{font-size:.83em;margin:1.67em 0}h6{font-size:.67em;margin:2.33em 0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:1em 40px}dfn{font-style:italic}hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}mark{background:#ff0;color:#000}p,pre{margin:1em 0}code,kbd,pre,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre;white-space:pre-wrap;word-wrap:break-word}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:80%}sub{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline;top:-0.5em}sub{bottom:-0.25em}dl,menu,ol,ul{margin:1em 0}dd{margin:0 0 0 40px}menu,ol,ul{padding:0 0 0 40px}nav ul,nav ol{list-style:none;list-style-image:none}img{border:0;-ms-interpolation-mode:bicubic}svg:not(:root){overflow:hidden}figure,form{margin:0}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{border:0;padding:0;white-space:normal;*margin-left:-7px}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,select{text-transform:none}button,html input[type=button]{-webkit-appearance:button;cursor:pointer;*overflow:visible}input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;*overflow:visible}button[disabled],html input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{box-sizing:border-box;padding:0;*height:13px;*width:13px}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top}table{border-collapse:collapse;border-spacing:0}.hljs{display:inline-block;padding:.5em;background:#fff;color:#000}.hljs-comment,.hljs-annotation,.hljs-template_comment,.diff .hljs-header,.hljs-chunk,.apache .hljs-cbracket{color:green}.hljs-keyword,.hljs-id,.hljs-built_in,.css .smalltalk .hljs-class,.hljs-winutils,.bash .hljs-variable,.tex .hljs-command,.hljs-request,.hljs-status,.nginx .hljs-title{color:blue}.xml .hljs-tag{color:blue}.xml .hljs-tag .hljs-value{color:blue}.hljs-string,.hljs-title,.hljs-parent,.hljs-tag .hljs-value,.hljs-rules .hljs-value{color:#a31515}.ruby .hljs-symbol{color:#a31515}.ruby .hljs-symbol .hljs-string{color:#a31515}.hljs-template_tag,.django .hljs-variable,.hljs-addition,.hljs-flow,.hljs-stream,.apache .hljs-tag,.hljs-date,.tex .hljs-formula,.coffeescript .hljs-attribute{color:#a31515}.ruby .hljs-string,.hljs-decorator,.hljs-filter .hljs-argument,.hljs-localvars,.hljs-array,.hljs-attr_selector,.hljs-pseudo,.hljs-pi,.hljs-doctype,.hljs-deletion,.hljs-envvar,.hljs-shebang,.hljs-preprocessor,.hljs-pragma,.userType,.apache .hljs-sqbracket,.nginx .hljs-built_in,.tex .hljs-special,.hljs-prompt{color:#2b91af}.hljs-phpdoc,.hljs-javadoc,.hljs-xmlDocTag{color:gray}.vhdl .hljs-typename{font-weight:bold}.vhdl .hljs-string{color:#666}.vhdl .hljs-literal{color:#a31515}.vhdl .hljs-attribute{color:#00b0e8}.xml .hljs-attribute{color:red}ul.tsd-descriptions>li>:first-child,.tsd-panel>:first-child,.col>:first-child,.col-11>:first-child,.col-10>:first-child,.col-9>:first-child,.col-8>:first-child,.col-7>:first-child,.col-6>:first-child,.col-5>:first-child,.col-4>:first-child,.col-3>:first-child,.col-2>:first-child,.col-1>:first-child,ul.tsd-descriptions>li>:first-child>:first-child,.tsd-panel>:first-child>:first-child,.col>:first-child>:first-child,.col-11>:first-child>:first-child,.col-10>:first-child>:first-child,.col-9>:first-child>:first-child,.col-8>:first-child>:first-child,.col-7>:first-child>:first-child,.col-6>:first-child>:first-child,.col-5>:first-child>:first-child,.col-4>:first-child>:first-child,.col-3>:first-child>:first-child,.col-2>:first-child>:first-child,.col-1>:first-child>:first-child,ul.tsd-descriptions>li>:first-child>:first-child>:first-child,.tsd-panel>:first-child>:first-child>:first-child,.col>:first-child>:first-child>:first-child,.col-11>:first-child>:first-child>:first-child,.col-10>:first-child>:first-child>:first-child,.col-9>:first-child>:first-child>:first-child,.col-8>:first-child>:first-child>:first-child,.col-7>:first-child>:first-child>:first-child,.col-6>:first-child>:first-child>:first-child,.col-5>:first-child>:first-child>:first-child,.col-4>:first-child>:first-child>:first-child,.col-3>:first-child>:first-child>:first-child,.col-2>:first-child>:first-child>:first-child,.col-1>:first-child>:first-child>:first-child{margin-top:0}ul.tsd-descriptions>li>:last-child,.tsd-panel>:last-child,.col>:last-child,.col-11>:last-child,.col-10>:last-child,.col-9>:last-child,.col-8>:last-child,.col-7>:last-child,.col-6>:last-child,.col-5>:last-child,.col-4>:last-child,.col-3>:last-child,.col-2>:last-child,.col-1>:last-child,ul.tsd-descriptions>li>:last-child>:last-child,.tsd-panel>:last-child>:last-child,.col>:last-child>:last-child,.col-11>:last-child>:last-child,.col-10>:last-child>:last-child,.col-9>:last-child>:last-child,.col-8>:last-child>:last-child,.col-7>:last-child>:last-child,.col-6>:last-child>:last-child,.col-5>:last-child>:last-child,.col-4>:last-child>:last-child,.col-3>:last-child>:last-child,.col-2>:last-child>:last-child,.col-1>:last-child>:last-child,ul.tsd-descriptions>li>:last-child>:last-child>:last-child,.tsd-panel>:last-child>:last-child>:last-child,.col>:last-child>:last-child>:last-child,.col-11>:last-child>:last-child>:last-child,.col-10>:last-child>:last-child>:last-child,.col-9>:last-child>:last-child>:last-child,.col-8>:last-child>:last-child>:last-child,.col-7>:last-child>:last-child>:last-child,.col-6>:last-child>:last-child>:last-child,.col-5>:last-child>:last-child>:last-child,.col-4>:last-child>:last-child>:last-child,.col-3>:last-child>:last-child>:last-child,.col-2>:last-child>:last-child>:last-child,.col-1>:last-child>:last-child>:last-child{margin-bottom:0}.container{max-width:1200px;margin:0 auto;padding:0 40px}@media(max-width: 640px){.container{padding:0 20px}}.container-main{padding-bottom:200px}.row{display:flex;position:relative;margin:0 -10px}.row:after{visibility:hidden;display:block;content:"";clear:both;height:0}.col,.col-11,.col-10,.col-9,.col-8,.col-7,.col-6,.col-5,.col-4,.col-3,.col-2,.col-1{box-sizing:border-box;float:left;padding:0 10px}.col-1{width:8.3333333333%}.offset-1{margin-left:8.3333333333%}.col-2{width:16.6666666667%}.offset-2{margin-left:16.6666666667%}.col-3{width:25%}.offset-3{margin-left:25%}.col-4{width:33.3333333333%}.offset-4{margin-left:33.3333333333%}.col-5{width:41.6666666667%}.offset-5{margin-left:41.6666666667%}.col-6{width:50%}.offset-6{margin-left:50%}.col-7{width:58.3333333333%}.offset-7{margin-left:58.3333333333%}.col-8{width:66.6666666667%}.offset-8{margin-left:66.6666666667%}.col-9{width:75%}.offset-9{margin-left:75%}.col-10{width:83.3333333333%}.offset-10{margin-left:83.3333333333%}.col-11{width:91.6666666667%}.offset-11{margin-left:91.6666666667%}.tsd-kind-icon{display:block;position:relative;padding-left:20px;text-indent:-20px}.tsd-kind-icon:before{content:"";display:inline-block;vertical-align:middle;width:17px;height:17px;margin:0 3px 2px 0;background-image:url(../images/icons.png)}@media(-webkit-min-device-pixel-ratio: 1.5),(min-resolution: 144dpi){.tsd-kind-icon:before{background-image:url(../images/icons@2x.png);background-size:238px 204px}}.tsd-signature.tsd-kind-icon:before{background-position:0 -153px}.tsd-kind-object-literal>.tsd-kind-icon:before{background-position:0px -17px}.tsd-kind-object-literal.tsd-is-protected>.tsd-kind-icon:before{background-position:-17px -17px}.tsd-kind-object-literal.tsd-is-private>.tsd-kind-icon:before{background-position:-34px -17px}.tsd-kind-class>.tsd-kind-icon:before{background-position:0px -34px}.tsd-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-17px -34px}.tsd-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-34px -34px}.tsd-kind-class.tsd-has-type-parameter>.tsd-kind-icon:before{background-position:0px -51px}.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected>.tsd-kind-icon:before{background-position:-17px -51px}.tsd-kind-class.tsd-has-type-parameter.tsd-is-private>.tsd-kind-icon:before{background-position:-34px -51px}.tsd-kind-interface>.tsd-kind-icon:before{background-position:0px -68px}.tsd-kind-interface.tsd-is-protected>.tsd-kind-icon:before{background-position:-17px -68px}.tsd-kind-interface.tsd-is-private>.tsd-kind-icon:before{background-position:-34px -68px}.tsd-kind-interface.tsd-has-type-parameter>.tsd-kind-icon:before{background-position:0px -85px}.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected>.tsd-kind-icon:before{background-position:-17px -85px}.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private>.tsd-kind-icon:before{background-position:-34px -85px}.tsd-kind-namespace>.tsd-kind-icon:before{background-position:0px -102px}.tsd-kind-namespace.tsd-is-protected>.tsd-kind-icon:before{background-position:-17px -102px}.tsd-kind-namespace.tsd-is-private>.tsd-kind-icon:before{background-position:-34px -102px}.tsd-kind-module>.tsd-kind-icon:before{background-position:0px -102px}.tsd-kind-module.tsd-is-protected>.tsd-kind-icon:before{background-position:-17px -102px}.tsd-kind-module.tsd-is-private>.tsd-kind-icon:before{background-position:-34px -102px}.tsd-kind-enum>.tsd-kind-icon:before{background-position:0px -119px}.tsd-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-17px -119px}.tsd-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-34px -119px}.tsd-kind-enum-member>.tsd-kind-icon:before{background-position:0px -136px}.tsd-kind-enum-member.tsd-is-protected>.tsd-kind-icon:before{background-position:-17px -136px}.tsd-kind-enum-member.tsd-is-private>.tsd-kind-icon:before{background-position:-34px -136px}.tsd-kind-signature>.tsd-kind-icon:before{background-position:0px -153px}.tsd-kind-signature.tsd-is-protected>.tsd-kind-icon:before{background-position:-17px -153px}.tsd-kind-signature.tsd-is-private>.tsd-kind-icon:before{background-position:-34px -153px}.tsd-kind-type-alias>.tsd-kind-icon:before{background-position:0px -170px}.tsd-kind-type-alias.tsd-is-protected>.tsd-kind-icon:before{background-position:-17px -170px}.tsd-kind-type-alias.tsd-is-private>.tsd-kind-icon:before{background-position:-34px -170px}.tsd-kind-type-alias.tsd-has-type-parameter>.tsd-kind-icon:before{background-position:0px -187px}.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected>.tsd-kind-icon:before{background-position:-17px -187px}.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private>.tsd-kind-icon:before{background-position:-34px -187px}.tsd-kind-variable>.tsd-kind-icon:before{background-position:-136px -0px}.tsd-kind-variable.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -0px}.tsd-kind-variable.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -0px}.tsd-kind-variable.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -0px}.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -0px}.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -0px}.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -0px}.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -0px}.tsd-kind-variable.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -0px}.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -0px}.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -0px}.tsd-kind-variable.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -0px}.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -0px}.tsd-kind-property>.tsd-kind-icon:before{background-position:-136px -0px}.tsd-kind-property.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -0px}.tsd-kind-property.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -0px}.tsd-kind-property.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -0px}.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -0px}.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -0px}.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -0px}.tsd-kind-property.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -0px}.tsd-kind-property.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -0px}.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -0px}.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -0px}.tsd-kind-property.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -0px}.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -0px}.tsd-kind-get-signature>.tsd-kind-icon:before{background-position:-136px -17px}.tsd-kind-get-signature.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -17px}.tsd-kind-get-signature.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -17px}.tsd-kind-get-signature.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -17px}.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -17px}.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -17px}.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -17px}.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -17px}.tsd-kind-get-signature.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -17px}.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -17px}.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -17px}.tsd-kind-get-signature.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -17px}.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -17px}.tsd-kind-set-signature>.tsd-kind-icon:before{background-position:-136px -34px}.tsd-kind-set-signature.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -34px}.tsd-kind-set-signature.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -34px}.tsd-kind-set-signature.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -34px}.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -34px}.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -34px}.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -34px}.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -34px}.tsd-kind-set-signature.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -34px}.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -34px}.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -34px}.tsd-kind-set-signature.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -34px}.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -34px}.tsd-kind-accessor>.tsd-kind-icon:before{background-position:-136px -51px}.tsd-kind-accessor.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -51px}.tsd-kind-accessor.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -51px}.tsd-kind-accessor.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -51px}.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -51px}.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -51px}.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -51px}.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -51px}.tsd-kind-accessor.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -51px}.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -51px}.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -51px}.tsd-kind-accessor.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -51px}.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -51px}.tsd-kind-function>.tsd-kind-icon:before{background-position:-136px -68px}.tsd-kind-function.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -68px}.tsd-kind-function.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -68px}.tsd-kind-function.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -68px}.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -68px}.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -68px}.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -68px}.tsd-kind-function.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -68px}.tsd-kind-function.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -68px}.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -68px}.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -68px}.tsd-kind-function.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -68px}.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -68px}.tsd-kind-method>.tsd-kind-icon:before{background-position:-136px -68px}.tsd-kind-method.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -68px}.tsd-kind-method.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -68px}.tsd-kind-method.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -68px}.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -68px}.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -68px}.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -68px}.tsd-kind-method.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -68px}.tsd-kind-method.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -68px}.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -68px}.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -68px}.tsd-kind-method.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -68px}.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -68px}.tsd-kind-call-signature>.tsd-kind-icon:before{background-position:-136px -68px}.tsd-kind-call-signature.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -68px}.tsd-kind-call-signature.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -68px}.tsd-kind-call-signature.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -68px}.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -68px}.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -68px}.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -68px}.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -68px}.tsd-kind-call-signature.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -68px}.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -68px}.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -68px}.tsd-kind-call-signature.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -68px}.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -68px}.tsd-kind-function.tsd-has-type-parameter>.tsd-kind-icon:before{background-position:-136px -85px}.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -85px}.tsd-kind-function.tsd-has-type-parameter.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -85px}.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -85px}.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -85px}.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -85px}.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -85px}.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -85px}.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -85px}.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -85px}.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -85px}.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -85px}.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -85px}.tsd-kind-method.tsd-has-type-parameter>.tsd-kind-icon:before{background-position:-136px -85px}.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -85px}.tsd-kind-method.tsd-has-type-parameter.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -85px}.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -85px}.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -85px}.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -85px}.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -85px}.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -85px}.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -85px}.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -85px}.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -85px}.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -85px}.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -85px}.tsd-kind-constructor>.tsd-kind-icon:before{background-position:-136px -102px}.tsd-kind-constructor.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -102px}.tsd-kind-constructor.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -102px}.tsd-kind-constructor.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -102px}.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -102px}.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -102px}.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -102px}.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -102px}.tsd-kind-constructor.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -102px}.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -102px}.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -102px}.tsd-kind-constructor.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -102px}.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -102px}.tsd-kind-constructor-signature>.tsd-kind-icon:before{background-position:-136px -102px}.tsd-kind-constructor-signature.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -102px}.tsd-kind-constructor-signature.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -102px}.tsd-kind-constructor-signature.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -102px}.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -102px}.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -102px}.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -102px}.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -102px}.tsd-kind-constructor-signature.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -102px}.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -102px}.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -102px}.tsd-kind-constructor-signature.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -102px}.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -102px}.tsd-kind-index-signature>.tsd-kind-icon:before{background-position:-136px -119px}.tsd-kind-index-signature.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -119px}.tsd-kind-index-signature.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -119px}.tsd-kind-index-signature.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -119px}.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -119px}.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -119px}.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -119px}.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -119px}.tsd-kind-index-signature.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -119px}.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -119px}.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -119px}.tsd-kind-index-signature.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -119px}.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -119px}.tsd-kind-event>.tsd-kind-icon:before{background-position:-136px -136px}.tsd-kind-event.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -136px}.tsd-kind-event.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -136px}.tsd-kind-event.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -136px}.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -136px}.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -136px}.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -136px}.tsd-kind-event.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -136px}.tsd-kind-event.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -136px}.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -136px}.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -136px}.tsd-kind-event.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -136px}.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -136px}.tsd-is-static>.tsd-kind-icon:before{background-position:-136px -153px}.tsd-is-static.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -153px}.tsd-is-static.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -153px}.tsd-is-static.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -153px}.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -153px}.tsd-is-static.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -153px}.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -153px}.tsd-is-static.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -153px}.tsd-is-static.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -153px}.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -153px}.tsd-is-static.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -153px}.tsd-is-static.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -153px}.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -153px}.tsd-is-static.tsd-kind-function>.tsd-kind-icon:before{background-position:-136px -170px}.tsd-is-static.tsd-kind-function.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -170px}.tsd-is-static.tsd-kind-function.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -170px}.tsd-is-static.tsd-kind-function.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -170px}.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -170px}.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -170px}.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -170px}.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -170px}.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -170px}.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -170px}.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -170px}.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -170px}.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -170px}.tsd-is-static.tsd-kind-method>.tsd-kind-icon:before{background-position:-136px -170px}.tsd-is-static.tsd-kind-method.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -170px}.tsd-is-static.tsd-kind-method.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -170px}.tsd-is-static.tsd-kind-method.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -170px}.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -170px}.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -170px}.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -170px}.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -170px}.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -170px}.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -170px}.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -170px}.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -170px}.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -170px}.tsd-is-static.tsd-kind-call-signature>.tsd-kind-icon:before{background-position:-136px -170px}.tsd-is-static.tsd-kind-call-signature.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -170px}.tsd-is-static.tsd-kind-call-signature.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -170px}.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -170px}.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -170px}.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -170px}.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -170px}.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -170px}.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -170px}.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -170px}.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -170px}.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -170px}.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -170px}.tsd-is-static.tsd-kind-event>.tsd-kind-icon:before{background-position:-136px -187px}.tsd-is-static.tsd-kind-event.tsd-is-protected>.tsd-kind-icon:before{background-position:-153px -187px}.tsd-is-static.tsd-kind-event.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -187px}.tsd-is-static.tsd-kind-event.tsd-parent-kind-class>.tsd-kind-icon:before{background-position:-51px -187px}.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited>.tsd-kind-icon:before{background-position:-68px -187px}.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected>.tsd-kind-icon:before{background-position:-85px -187px}.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited>.tsd-kind-icon:before{background-position:-102px -187px}.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -187px}.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum>.tsd-kind-icon:before{background-position:-170px -187px}.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected>.tsd-kind-icon:before{background-position:-187px -187px}.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private>.tsd-kind-icon:before{background-position:-119px -187px}.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface>.tsd-kind-icon:before{background-position:-204px -187px}.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited>.tsd-kind-icon:before{background-position:-221px -187px}@keyframes fade-in{from{opacity:0}to{opacity:1}}@keyframes fade-out{from{opacity:1;visibility:visible}to{opacity:0}}@keyframes fade-in-delayed{0%{opacity:0}33%{opacity:0}100%{opacity:1}}@keyframes fade-out-delayed{0%{opacity:1;visibility:visible}66%{opacity:0}100%{opacity:0}}@keyframes shift-to-left{from{transform:translate(0, 0)}to{transform:translate(-25%, 0)}}@keyframes unshift-to-left{from{transform:translate(-25%, 0)}to{transform:translate(0, 0)}}@keyframes pop-in-from-right{from{transform:translate(100%, 0)}to{transform:translate(0, 0)}}@keyframes pop-out-to-right{from{transform:translate(0, 0);visibility:visible}to{transform:translate(100%, 0)}}body{background:#fdfdfd;font-family:"Segoe UI",sans-serif;font-size:16px;color:#222}a{color:#4da6ff;text-decoration:none}a:hover{text-decoration:underline}code,pre{font-family:Menlo,Monaco,Consolas,"Courier New",monospace;padding:.2em;margin:0;font-size:14px;background-color:rgba(0,0,0,.04)}pre{padding:10px}pre code{padding:0;font-size:100%;background-color:transparent}.tsd-typography{line-height:1.333em}.tsd-typography ul{list-style:square;padding:0 0 0 20px;margin:0}.tsd-typography h4,.tsd-typography .tsd-index-panel h3,.tsd-index-panel .tsd-typography h3,.tsd-typography h5,.tsd-typography h6{font-size:1em;margin:0}.tsd-typography h5,.tsd-typography h6{font-weight:normal}.tsd-typography p,.tsd-typography ul,.tsd-typography ol{margin:1em 0}@media(min-width: 901px)and (max-width: 1024px){html.default .col-content{width:72%}html.default .col-menu{width:28%}html.default .tsd-navigation{padding-left:10px}}@media(max-width: 900px){html.default .col-content{float:none;width:100%}html.default .col-menu{position:fixed !important;overflow:auto;-webkit-overflow-scrolling:touch;z-index:1024;top:0 !important;bottom:0 !important;left:auto !important;right:0 !important;width:100%;padding:20px 20px 0 0;max-width:450px;visibility:hidden;background-color:#fff;transform:translate(100%, 0)}html.default .col-menu>*:last-child{padding-bottom:20px}html.default .overlay{content:"";display:block;position:fixed;z-index:1023;top:0;left:0;right:0;bottom:0;background-color:rgba(0,0,0,.75);visibility:hidden}html.default.to-has-menu .overlay{animation:fade-in .4s}html.default.to-has-menu header,html.default.to-has-menu footer,html.default.to-has-menu .col-content{animation:shift-to-left .4s}html.default.to-has-menu .col-menu{animation:pop-in-from-right .4s}html.default.from-has-menu .overlay{animation:fade-out .4s}html.default.from-has-menu header,html.default.from-has-menu footer,html.default.from-has-menu .col-content{animation:unshift-to-left .4s}html.default.from-has-menu .col-menu{animation:pop-out-to-right .4s}html.default.has-menu body{overflow:hidden}html.default.has-menu .overlay{visibility:visible}html.default.has-menu header,html.default.has-menu footer,html.default.has-menu .col-content{transform:translate(-25%, 0)}html.default.has-menu .col-menu{visibility:visible;transform:translate(0, 0)}}.tsd-page-title{padding:70px 0 20px 0;margin:0 0 40px 0;background:#fff;box-shadow:0 0 5px rgba(0,0,0,.35)}.tsd-page-title h1{margin:0}.tsd-breadcrumb{margin:0;padding:0;color:#707070}.tsd-breadcrumb a{color:#707070;text-decoration:none}.tsd-breadcrumb a:hover{text-decoration:underline}.tsd-breadcrumb li{display:inline}.tsd-breadcrumb li:after{content:" / "}html.minimal .container{margin:0}html.minimal .container-main{padding-top:50px;padding-bottom:0}html.minimal .content-wrap{padding-left:300px}html.minimal .tsd-navigation{position:fixed !important;overflow:auto;-webkit-overflow-scrolling:touch;box-sizing:border-box;z-index:1;left:0;top:40px;bottom:0;width:300px;padding:20px;margin:0}html.minimal .tsd-member .tsd-member{margin-left:0}html.minimal .tsd-page-toolbar{position:fixed;z-index:2}html.minimal #tsd-filter .tsd-filter-group{right:0;transform:none}html.minimal footer{background-color:transparent}html.minimal footer .container{padding:0}html.minimal .tsd-generator{padding:0}@media(max-width: 900px){html.minimal .tsd-navigation{display:none}html.minimal .content-wrap{padding-left:0}}dl.tsd-comment-tags{overflow:hidden}dl.tsd-comment-tags dt{float:left;padding:1px 5px;margin:0 10px 0 0;border-radius:4px;border:1px solid #707070;color:#707070;font-size:.8em;font-weight:normal}dl.tsd-comment-tags dd{margin:0 0 10px 0}dl.tsd-comment-tags dd:before,dl.tsd-comment-tags dd:after{display:table;content:" "}dl.tsd-comment-tags dd pre,dl.tsd-comment-tags dd:after{clear:both}dl.tsd-comment-tags p{margin:0}.tsd-panel.tsd-comment .lead{font-size:1.1em;line-height:1.333em;margin-bottom:2em}.tsd-panel.tsd-comment .lead:last-child{margin-bottom:0}.toggle-protected .tsd-is-private{display:none}.toggle-public .tsd-is-private,.toggle-public .tsd-is-protected,.toggle-public .tsd-is-private-protected{display:none}.toggle-inherited .tsd-is-inherited{display:none}.toggle-only-exported .tsd-is-not-exported{display:none}.toggle-externals .tsd-is-external{display:none}#tsd-filter{position:relative;display:inline-block;height:40px;vertical-align:bottom}.no-filter #tsd-filter{display:none}#tsd-filter .tsd-filter-group{display:inline-block;height:40px;vertical-align:bottom;white-space:nowrap}#tsd-filter input{display:none}@media(max-width: 900px){#tsd-filter .tsd-filter-group{display:block;position:absolute;top:40px;right:20px;height:auto;background-color:#fff;visibility:hidden;transform:translate(50%, 0);box-shadow:0 0 4px rgba(0,0,0,.25)}.has-options #tsd-filter .tsd-filter-group{visibility:visible}.to-has-options #tsd-filter .tsd-filter-group{animation:fade-in .2s}.from-has-options #tsd-filter .tsd-filter-group{animation:fade-out .2s}#tsd-filter label,#tsd-filter .tsd-select{display:block;padding-right:20px}}footer{border-top:1px solid #eee;background-color:#fff}footer.with-border-bottom{border-bottom:1px solid #eee}footer .tsd-legend-group{font-size:0}footer .tsd-legend{display:inline-block;width:25%;padding:0;font-size:16px;list-style:none;line-height:1.333em;vertical-align:top}@media(max-width: 900px){footer .tsd-legend{width:50%}}.tsd-hierarchy{list-style:square;padding:0 0 0 20px;margin:0}.tsd-hierarchy .target{font-weight:bold}.tsd-index-panel .tsd-index-content{margin-bottom:-30px !important}.tsd-index-panel .tsd-index-section{margin-bottom:30px !important}.tsd-index-panel h3{margin:0 -20px 10px -20px;padding:0 20px 10px 20px;border-bottom:1px solid #eee}.tsd-index-panel ul.tsd-index-list{-webkit-column-count:3;-moz-column-count:3;-ms-column-count:3;-o-column-count:3;column-count:3;-webkit-column-gap:20px;-moz-column-gap:20px;-ms-column-gap:20px;-o-column-gap:20px;column-gap:20px;padding:0;list-style:none;line-height:1.333em}@media(max-width: 900px){.tsd-index-panel ul.tsd-index-list{-webkit-column-count:1;-moz-column-count:1;-ms-column-count:1;-o-column-count:1;column-count:1}}@media(min-width: 901px)and (max-width: 1024px){.tsd-index-panel ul.tsd-index-list{-webkit-column-count:2;-moz-column-count:2;-ms-column-count:2;-o-column-count:2;column-count:2}}.tsd-index-panel ul.tsd-index-list li{-webkit-page-break-inside:avoid;-moz-page-break-inside:avoid;-ms-page-break-inside:avoid;-o-page-break-inside:avoid;page-break-inside:avoid}.tsd-index-panel a,.tsd-index-panel .tsd-parent-kind-module a{color:#9600ff}.tsd-index-panel .tsd-parent-kind-interface a{color:#647f1b}.tsd-index-panel .tsd-parent-kind-enum a{color:#937210}.tsd-index-panel .tsd-parent-kind-class a{color:#0672de}.tsd-index-panel .tsd-kind-module a{color:#9600ff}.tsd-index-panel .tsd-kind-interface a{color:#647f1b}.tsd-index-panel .tsd-kind-enum a{color:#937210}.tsd-index-panel .tsd-kind-class a{color:#0672de}.tsd-index-panel .tsd-is-private a{color:#707070}.tsd-flag{display:inline-block;padding:1px 5px;border-radius:4px;color:#fff;background-color:#707070;text-indent:0;font-size:14px;font-weight:normal}.tsd-anchor{position:absolute;top:-100px}.tsd-member{position:relative}.tsd-member .tsd-anchor+h3{margin-top:0;margin-bottom:0;border-bottom:none}.tsd-navigation{margin:0 0 0 40px}.tsd-navigation a{display:block;padding-top:2px;padding-bottom:2px;border-left:2px solid transparent;color:#222;text-decoration:none;transition:border-left-color .1s}.tsd-navigation a:hover{text-decoration:underline}.tsd-navigation ul{margin:0;padding:0;list-style:none}.tsd-navigation li{padding:0}.tsd-navigation.primary{padding-bottom:40px}.tsd-navigation.primary a{display:block;padding-top:6px;padding-bottom:6px}.tsd-navigation.primary ul li a{padding-left:5px}.tsd-navigation.primary ul li li a{padding-left:25px}.tsd-navigation.primary ul li li li a{padding-left:45px}.tsd-navigation.primary ul li li li li a{padding-left:65px}.tsd-navigation.primary ul li li li li li a{padding-left:85px}.tsd-navigation.primary ul li li li li li li a{padding-left:105px}.tsd-navigation.primary>ul{border-bottom:1px solid #eee}.tsd-navigation.primary li{border-top:1px solid #eee}.tsd-navigation.primary li.current>a{font-weight:bold}.tsd-navigation.primary li.label span{display:block;padding:20px 0 6px 5px;color:#707070}.tsd-navigation.primary li.globals+li>span,.tsd-navigation.primary li.globals+li>a{padding-top:20px}.tsd-navigation.secondary{max-height:calc(100vh - 1rem - 40px);overflow:auto;position:-webkit-sticky;position:sticky;top:calc(.5rem + 40px);transition:.3s}.tsd-navigation.secondary.tsd-navigation--toolbar-hide{max-height:calc(100vh - 1rem);top:.5rem}.tsd-navigation.secondary ul{transition:opacity .2s}.tsd-navigation.secondary ul li a{padding-left:25px}.tsd-navigation.secondary ul li li a{padding-left:45px}.tsd-navigation.secondary ul li li li a{padding-left:65px}.tsd-navigation.secondary ul li li li li a{padding-left:85px}.tsd-navigation.secondary ul li li li li li a{padding-left:105px}.tsd-navigation.secondary ul li li li li li li a{padding-left:125px}.tsd-navigation.secondary ul.current a{border-left-color:#eee}.tsd-navigation.secondary li.focus>a,.tsd-navigation.secondary ul.current li.focus>a{border-left-color:#000}.tsd-navigation.secondary li.current{margin-top:20px;margin-bottom:20px;border-left-color:#eee}.tsd-navigation.secondary li.current>a{font-weight:bold}@media(min-width: 901px){.menu-sticky-wrap{position:static}}.tsd-panel{margin:20px 0;padding:20px;background-color:#fff;box-shadow:0 0 4px rgba(0,0,0,.25)}.tsd-panel:empty{display:none}.tsd-panel>h1,.tsd-panel>h2,.tsd-panel>h3{margin:1.5em -20px 10px -20px;padding:0 20px 10px 20px;border-bottom:1px solid #eee}.tsd-panel>h1.tsd-before-signature,.tsd-panel>h2.tsd-before-signature,.tsd-panel>h3.tsd-before-signature{margin-bottom:0;border-bottom:0}.tsd-panel table{display:block;width:100%;overflow:auto;margin-top:10px;word-break:normal;word-break:keep-all}.tsd-panel table th{font-weight:bold}.tsd-panel table th,.tsd-panel table td{padding:6px 13px;border:1px solid #ddd}.tsd-panel table tr{background-color:#fff;border-top:1px solid #ccc}.tsd-panel table tr:nth-child(2n){background-color:#f8f8f8}.tsd-panel-group{margin:60px 0}.tsd-panel-group>h1,.tsd-panel-group>h2,.tsd-panel-group>h3{padding-left:20px;padding-right:20px}#tsd-search{transition:background-color .2s}#tsd-search .title{position:relative;z-index:2}#tsd-search .field{position:absolute;left:0;top:0;right:40px;height:40px}#tsd-search .field input{box-sizing:border-box;position:relative;top:-50px;z-index:1;width:100%;padding:0 10px;opacity:0;outline:0;border:0;background:transparent;color:#222}#tsd-search .field label{position:absolute;overflow:hidden;right:-40px}#tsd-search .field input,#tsd-search .title{transition:opacity .2s}#tsd-search .results{position:absolute;visibility:hidden;top:40px;width:100%;margin:0;padding:0;list-style:none;box-shadow:0 0 4px rgba(0,0,0,.25)}#tsd-search .results li{padding:0 10px;background-color:#fdfdfd}#tsd-search .results li:nth-child(even){background-color:#fff}#tsd-search .results li.state{display:none}#tsd-search .results li.current,#tsd-search .results li:hover{background-color:#eee}#tsd-search .results a{display:block}#tsd-search .results a:before{top:10px}#tsd-search .results span.parent{color:#707070;font-weight:normal}#tsd-search.has-focus{background-color:#eee}#tsd-search.has-focus .field input{top:0;opacity:1}#tsd-search.has-focus .title{z-index:0;opacity:0}#tsd-search.has-focus .results{visibility:visible}#tsd-search.loading .results li.state.loading{display:block}#tsd-search.failure .results li.state.failure{display:block}.tsd-signature{margin:0 0 1em 0;padding:10px;border:1px solid #eee;font-family:Menlo,Monaco,Consolas,"Courier New",monospace;font-size:14px;overflow-x:auto}.tsd-signature.tsd-kind-icon{padding-left:30px}.tsd-signature.tsd-kind-icon:before{top:10px;left:10px}.tsd-panel>.tsd-signature{margin-left:-20px;margin-right:-20px;border-width:1px 0}.tsd-panel>.tsd-signature.tsd-kind-icon{padding-left:40px}.tsd-panel>.tsd-signature.tsd-kind-icon:before{left:20px}.tsd-signature-symbol{color:#707070;font-weight:normal}.tsd-signature-type{font-style:italic;font-weight:normal}.tsd-signatures{padding:0;margin:0 0 1em 0;border:1px solid #eee}.tsd-signatures .tsd-signature{margin:0;border-width:1px 0 0 0;transition:background-color .1s}.tsd-signatures .tsd-signature:first-child{border-top-width:0}.tsd-signatures .tsd-signature.current{background-color:#eee}.tsd-signatures.active>.tsd-signature{cursor:pointer}.tsd-panel>.tsd-signatures{margin-left:-20px;margin-right:-20px;border-width:1px 0}.tsd-panel>.tsd-signatures .tsd-signature.tsd-kind-icon{padding-left:40px}.tsd-panel>.tsd-signatures .tsd-signature.tsd-kind-icon:before{left:20px}.tsd-panel>a.anchor+.tsd-signatures{border-top-width:0;margin-top:-20px}ul.tsd-descriptions{position:relative;overflow:hidden;padding:0;list-style:none}ul.tsd-descriptions.active>.tsd-description{display:none}ul.tsd-descriptions.active>.tsd-description.current{display:block}ul.tsd-descriptions.active>.tsd-description.fade-in{animation:fade-in-delayed .3s}ul.tsd-descriptions.active>.tsd-description.fade-out{animation:fade-out-delayed .3s;position:absolute;display:block;top:0;left:0;right:0;opacity:0;visibility:hidden}ul.tsd-descriptions h4,ul.tsd-descriptions .tsd-index-panel h3,.tsd-index-panel ul.tsd-descriptions h3{font-size:16px;margin:1em 0 .5em 0}ul.tsd-parameters,ul.tsd-type-parameters{list-style:square;margin:0;padding-left:20px}ul.tsd-parameters>li.tsd-parameter-signature,ul.tsd-type-parameters>li.tsd-parameter-signature{list-style:none;margin-left:-20px}ul.tsd-parameters h5,ul.tsd-type-parameters h5{font-size:16px;margin:1em 0 .5em 0}ul.tsd-parameters .tsd-comment,ul.tsd-type-parameters .tsd-comment{margin-top:-0.5em}.tsd-sources{font-size:14px;color:#707070;margin:0 0 1em 0}.tsd-sources a{color:#707070;text-decoration:underline}.tsd-sources ul,.tsd-sources p{margin:0 !important}.tsd-sources ul{list-style:none;padding:0}.tsd-page-toolbar{position:fixed;z-index:1;top:0;left:0;width:100%;height:40px;color:#333;background:#fff;border-bottom:1px solid #eee;transition:transform .3s linear}.tsd-page-toolbar a{color:#333;text-decoration:none}.tsd-page-toolbar a.title{font-weight:bold}.tsd-page-toolbar a.title:hover{text-decoration:underline}.tsd-page-toolbar .table-wrap{display:table;width:100%;height:40px}.tsd-page-toolbar .table-cell{display:table-cell;position:relative;white-space:nowrap;line-height:40px}.tsd-page-toolbar .table-cell:first-child{width:100%}.tsd-page-toolbar--hide{transform:translateY(-100%)}.tsd-select .tsd-select-list li:before,.tsd-select .tsd-select-label:before,.tsd-widget:before{content:"";display:inline-block;width:40px;height:40px;margin:0 -8px 0 0;background-image:url(../images/widgets.png);background-repeat:no-repeat;text-indent:-1024px;vertical-align:bottom}@media(-webkit-min-device-pixel-ratio: 1.5),(min-resolution: 144dpi){.tsd-select .tsd-select-list li:before,.tsd-select .tsd-select-label:before,.tsd-widget:before{background-image:url(../images/widgets@2x.png);background-size:320px 40px}}.tsd-widget{display:inline-block;overflow:hidden;opacity:.6;height:40px;transition:opacity .1s,background-color .2s;vertical-align:bottom;cursor:pointer}.tsd-widget:hover{opacity:.8}.tsd-widget.active{opacity:1;background-color:#eee}.tsd-widget.no-caption{width:40px}.tsd-widget.no-caption:before{margin:0}.tsd-widget.search:before{background-position:0 0}.tsd-widget.menu:before{background-position:-40px 0}.tsd-widget.options:before{background-position:-80px 0}.tsd-widget.options,.tsd-widget.menu{display:none}@media(max-width: 900px){.tsd-widget.options,.tsd-widget.menu{display:inline-block}}input[type=checkbox]+.tsd-widget:before{background-position:-120px 0}input[type=checkbox]:checked+.tsd-widget:before{background-position:-160px 0}.tsd-select{position:relative;display:inline-block;height:40px;transition:opacity .1s,background-color .2s;vertical-align:bottom;cursor:pointer}.tsd-select .tsd-select-label{opacity:.6;transition:opacity .2s}.tsd-select .tsd-select-label:before{background-position:-240px 0}.tsd-select.active .tsd-select-label{opacity:.8}.tsd-select.active .tsd-select-list{visibility:visible;opacity:1;transition-delay:0s}.tsd-select .tsd-select-list{position:absolute;visibility:hidden;top:40px;left:0;margin:0;padding:0;opacity:0;list-style:none;box-shadow:0 0 4px rgba(0,0,0,.25);transition:visibility 0s .2s,opacity .2s}.tsd-select .tsd-select-list li{padding:0 20px 0 0;background-color:#fdfdfd}.tsd-select .tsd-select-list li:before{background-position:40px 0}.tsd-select .tsd-select-list li:nth-child(even){background-color:#fff}.tsd-select .tsd-select-list li:hover{background-color:#eee}.tsd-select .tsd-select-list li.selected:before{background-position:-200px 0}@media(max-width: 900px){.tsd-select .tsd-select-list{top:0;left:auto;right:100%;margin-right:-5px}.tsd-select .tsd-select-label:before{background-position:-280px 0}}img{max-width:100%} diff --git a/static/v2.15.x/typedoc/assets/images/icons.png b/static/v2.15.x/typedoc/assets/images/icons.png new file mode 100644 index 0000000000..3836d5fe46 Binary files /dev/null and b/static/v2.15.x/typedoc/assets/images/icons.png differ diff --git a/static/v2.15.x/typedoc/assets/images/icons@2x.png b/static/v2.15.x/typedoc/assets/images/icons@2x.png new file mode 100644 index 0000000000..5a209e2f6d Binary files /dev/null and b/static/v2.15.x/typedoc/assets/images/icons@2x.png differ diff --git a/static/v2.15.x/typedoc/assets/images/widgets.png b/static/v2.15.x/typedoc/assets/images/widgets.png new file mode 100644 index 0000000000..c7380532ac Binary files /dev/null and b/static/v2.15.x/typedoc/assets/images/widgets.png differ diff --git a/static/v2.15.x/typedoc/assets/images/widgets@2x.png b/static/v2.15.x/typedoc/assets/images/widgets@2x.png new file mode 100644 index 0000000000..4bbbd57272 Binary files /dev/null and b/static/v2.15.x/typedoc/assets/images/widgets@2x.png differ diff --git a/static/v2.15.x/typedoc/assets/js/main.js b/static/v2.15.x/typedoc/assets/js/main.js new file mode 100644 index 0000000000..c2190a936d --- /dev/null +++ b/static/v2.15.x/typedoc/assets/js/main.js @@ -0,0 +1,51 @@ +!function(e){var t={};function r(n){if(t[n])return t[n].exports;var i=t[n]={i:n,l:!1,exports:{}};return e[n].call(i.exports,i,i.exports,r),i.l=!0,i.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var i in e)r.d(n,i,function(t){return e[t]}.bind(null,i));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=2)}([function(e,t,r){var n,i; +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + */!function(){var s,o,a,u,l,c,h,d,f,p,y,m,v,g,x,w,L,E,b,S,k,Q,O,P,T,_,C=function(e){var t=new C.Builder;return t.pipeline.add(C.trimmer,C.stopWordFilter,C.stemmer),t.searchPipeline.add(C.stemmer),e.call(t,t),t.build()};C.version="2.3.9" +/*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */,C.utils={},C.utils.warn=(s=this,function(e){s.console&&console.warn&&console.warn(e)}),C.utils.asString=function(e){return null==e?"":e.toString()},C.utils.clone=function(e){if(null==e)return e;for(var t=Object.create(null),r=Object.keys(e),n=0;n0){var u=C.utils.clone(t)||{};u.position=[o,a],u.index=i.length,i.push(new C.Token(r.slice(o,s),u))}o=s+1}}return i},C.tokenizer.separator=/[\s\-]+/ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */,C.Pipeline=function(){this._stack=[]},C.Pipeline.registeredFunctions=Object.create(null),C.Pipeline.registerFunction=function(e,t){t in this.registeredFunctions&&C.utils.warn("Overwriting existing registered function: "+t),e.label=t,C.Pipeline.registeredFunctions[e.label]=e},C.Pipeline.warnIfFunctionNotRegistered=function(e){e.label&&e.label in this.registeredFunctions||C.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},C.Pipeline.load=function(e){var t=new C.Pipeline;return e.forEach((function(e){var r=C.Pipeline.registeredFunctions[e];if(!r)throw new Error("Cannot load unregistered function: "+e);t.add(r)})),t},C.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach((function(e){C.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)}),this)},C.Pipeline.prototype.after=function(e,t){C.Pipeline.warnIfFunctionNotRegistered(t);var r=this._stack.indexOf(e);if(-1==r)throw new Error("Cannot find existingFn");r+=1,this._stack.splice(r,0,t)},C.Pipeline.prototype.before=function(e,t){C.Pipeline.warnIfFunctionNotRegistered(t);var r=this._stack.indexOf(e);if(-1==r)throw new Error("Cannot find existingFn");this._stack.splice(r,0,t)},C.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);-1!=t&&this._stack.splice(t,1)},C.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=i),s!=e);)n=r-t,i=t+Math.floor(n/2),s=this.elements[2*i];return s==e||s>e?2*i:sa?l+=2:o==a&&(t+=r[u+1]*n[l+1],u+=2,l+=2);return t},C.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},C.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var s,o=i.str.charAt(0);o in i.node.edges?s=i.node.edges[o]:(s=new C.TokenSet,i.node.edges[o]=s),1==i.str.length&&(s.final=!0),n.push({node:s,editsRemaining:i.editsRemaining,str:i.str.slice(1)})}if(0!=i.editsRemaining){if("*"in i.node.edges)var a=i.node.edges["*"];else{a=new C.TokenSet;i.node.edges["*"]=a}if(0==i.str.length&&(a.final=!0),n.push({node:a,editsRemaining:i.editsRemaining-1,str:i.str}),i.str.length>1&&n.push({node:i.node,editsRemaining:i.editsRemaining-1,str:i.str.slice(1)}),1==i.str.length&&(i.node.final=!0),i.str.length>=1){if("*"in i.node.edges)var u=i.node.edges["*"];else{u=new C.TokenSet;i.node.edges["*"]=u}1==i.str.length&&(u.final=!0),n.push({node:u,editsRemaining:i.editsRemaining-1,str:i.str.slice(1)})}if(i.str.length>1){var l,c=i.str.charAt(0),h=i.str.charAt(1);h in i.node.edges?l=i.node.edges[h]:(l=new C.TokenSet,i.node.edges[h]=l),1==i.str.length&&(l.final=!0),n.push({node:l,editsRemaining:i.editsRemaining-1,str:c+i.str.slice(2)})}}}return r},C.TokenSet.fromString=function(e){for(var t=new C.TokenSet,r=t,n=0,i=e.length;n=e;t--){var r=this.uncheckedNodes[t],n=r.child.toString();n in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[n]:(r.child._str=n,this.minimizedNodes[n]=r.child),this.uncheckedNodes.pop()}} +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */,C.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},C.Index.prototype.search=function(e){return this.query((function(t){new C.QueryParser(e,t).parse()}))},C.Index.prototype.query=function(e){for(var t=new C.Query(this.fields),r=Object.create(null),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=0;a1?1:e},C.Builder.prototype.k1=function(e){this._k1=e},C.Builder.prototype.add=function(e,t){var r=e[this._ref],n=Object.keys(this._fields);this._documents[r]=t||{},this.documentCount+=1;for(var i=0;i=this.length)return C.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},C.QueryLexer.prototype.width=function(){return this.pos-this.start},C.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},C.QueryLexer.prototype.backup=function(){this.pos-=1},C.QueryLexer.prototype.acceptDigitRun=function(){var e,t;do{t=(e=this.next()).charCodeAt(0)}while(t>47&&t<58);e!=C.QueryLexer.EOS&&this.backup()},C.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(C.QueryLexer.TERM)),e.ignore(),e.more())return C.QueryLexer.lexText},C.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(C.QueryLexer.EDIT_DISTANCE),C.QueryLexer.lexText},C.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(C.QueryLexer.BOOST),C.QueryLexer.lexText},C.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(C.QueryLexer.TERM)},C.QueryLexer.termSeparator=C.tokenizer.separator,C.QueryLexer.lexText=function(e){for(;;){var t=e.next();if(t==C.QueryLexer.EOS)return C.QueryLexer.lexEOS;if(92!=t.charCodeAt(0)){if(":"==t)return C.QueryLexer.lexField;if("~"==t)return e.backup(),e.width()>0&&e.emit(C.QueryLexer.TERM),C.QueryLexer.lexEditDistance;if("^"==t)return e.backup(),e.width()>0&&e.emit(C.QueryLexer.TERM),C.QueryLexer.lexBoost;if("+"==t&&1===e.width())return e.emit(C.QueryLexer.PRESENCE),C.QueryLexer.lexText;if("-"==t&&1===e.width())return e.emit(C.QueryLexer.PRESENCE),C.QueryLexer.lexText;if(t.match(C.QueryLexer.termSeparator))return C.QueryLexer.lexTerm}else e.escapeCharacter()}},C.QueryParser=function(e,t){this.lexer=new C.QueryLexer(e),this.query=t,this.currentClause={},this.lexemeIdx=0},C.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=C.QueryParser.parseClause;e;)e=e(this);return this.query},C.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},C.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},C.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},C.QueryParser.parseClause=function(e){var t=e.peekLexeme();if(null!=t)switch(t.type){case C.QueryLexer.PRESENCE:return C.QueryParser.parsePresence;case C.QueryLexer.FIELD:return C.QueryParser.parseField;case C.QueryLexer.TERM:return C.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+t.type;throw t.str.length>=1&&(r+=" with value '"+t.str+"'"),new C.QueryParseError(r,t.start,t.end)}},C.QueryParser.parsePresence=function(e){var t=e.consumeLexeme();if(null!=t){switch(t.str){case"-":e.currentClause.presence=C.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=C.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+t.str+"'";throw new C.QueryParseError(r,t.start,t.end)}var n=e.peekLexeme();if(null==n){r="expecting term or field, found nothing";throw new C.QueryParseError(r,t.start,t.end)}switch(n.type){case C.QueryLexer.FIELD:return C.QueryParser.parseField;case C.QueryLexer.TERM:return C.QueryParser.parseTerm;default:r="expecting term or field, found '"+n.type+"'";throw new C.QueryParseError(r,n.start,n.end)}}},C.QueryParser.parseField=function(e){var t=e.consumeLexeme();if(null!=t){if(-1==e.query.allFields.indexOf(t.str)){var r=e.query.allFields.map((function(e){return"'"+e+"'"})).join(", "),n="unrecognised field '"+t.str+"', possible fields: "+r;throw new C.QueryParseError(n,t.start,t.end)}e.currentClause.fields=[t.str];var i=e.peekLexeme();if(null==i){n="expecting term, found nothing";throw new C.QueryParseError(n,t.start,t.end)}switch(i.type){case C.QueryLexer.TERM:return C.QueryParser.parseTerm;default:n="expecting term, found '"+i.type+"'";throw new C.QueryParseError(n,i.start,i.end)}}},C.QueryParser.parseTerm=function(e){var t=e.consumeLexeme();if(null!=t){e.currentClause.term=t.str.toLowerCase(),-1!=t.str.indexOf("*")&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(null!=r)switch(r.type){case C.QueryLexer.TERM:return e.nextClause(),C.QueryParser.parseTerm;case C.QueryLexer.FIELD:return e.nextClause(),C.QueryParser.parseField;case C.QueryLexer.EDIT_DISTANCE:return C.QueryParser.parseEditDistance;case C.QueryLexer.BOOST:return C.QueryParser.parseBoost;case C.QueryLexer.PRESENCE:return e.nextClause(),C.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+r.type+"'";throw new C.QueryParseError(n,r.start,r.end)}else e.nextClause()}},C.QueryParser.parseEditDistance=function(e){var t=e.consumeLexeme();if(null!=t){var r=parseInt(t.str,10);if(isNaN(r)){var n="edit distance must be numeric";throw new C.QueryParseError(n,t.start,t.end)}e.currentClause.editDistance=r;var i=e.peekLexeme();if(null!=i)switch(i.type){case C.QueryLexer.TERM:return e.nextClause(),C.QueryParser.parseTerm;case C.QueryLexer.FIELD:return e.nextClause(),C.QueryParser.parseField;case C.QueryLexer.EDIT_DISTANCE:return C.QueryParser.parseEditDistance;case C.QueryLexer.BOOST:return C.QueryParser.parseBoost;case C.QueryLexer.PRESENCE:return e.nextClause(),C.QueryParser.parsePresence;default:n="Unexpected lexeme type '"+i.type+"'";throw new C.QueryParseError(n,i.start,i.end)}else e.nextClause()}},C.QueryParser.parseBoost=function(e){var t=e.consumeLexeme();if(null!=t){var r=parseInt(t.str,10);if(isNaN(r)){var n="boost must be numeric";throw new C.QueryParseError(n,t.start,t.end)}e.currentClause.boost=r;var i=e.peekLexeme();if(null!=i)switch(i.type){case C.QueryLexer.TERM:return e.nextClause(),C.QueryParser.parseTerm;case C.QueryLexer.FIELD:return e.nextClause(),C.QueryParser.parseField;case C.QueryLexer.EDIT_DISTANCE:return C.QueryParser.parseEditDistance;case C.QueryLexer.BOOST:return C.QueryParser.parseBoost;case C.QueryLexer.PRESENCE:return e.nextClause(),C.QueryParser.parsePresence;default:n="Unexpected lexeme type '"+i.type+"'";throw new C.QueryParseError(n,i.start,i.end)}else e.nextClause()}},void 0===(i="function"==typeof(n=function(){return C})?n.call(t,r,t,e):n)||(e.exports=i)}()},function(e,t,r){},function(e,t,r){"use strict";r.r(t);var n=[];function i(e,t){n.push({selector:t,constructor:e})}var s,o,a=function(){function e(){this.createComponents(document.body)}return e.prototype.createComponents=function(e){n.forEach((function(t){e.querySelectorAll(t.selector).forEach((function(e){e.dataset.hasInstance||(new t.constructor({el:e}),e.dataset.hasInstance=String(!0))}))}))},e}(),u=function(e){this.el=e.el},l=r(0),c=(s=function(e,t){return(s=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])})(e,t)},function(e,t){function r(){this.constructor=e}s(e,t),e.prototype=null===t?Object.create(t):(r.prototype=t.prototype,new r)});!function(e){e[e.Idle=0]="Idle",e[e.Loading=1]="Loading",e[e.Ready=2]="Ready",e[e.Failure=3]="Failure"}(o||(o={}));var h=function(e){function t(t){var r=e.call(this,t)||this;r.query="",r.loadingState=o.Idle,r.hasFocus=!1,r.preventPress=!1,r.data=null,r.index=null,r.resultClicked=!1;var n=document.querySelector("#tsd-search-field"),i=document.querySelector(".results");if(!n||!i)throw new Error("The input field or the result list wrapper are not found");return r.field=n,r.results=i,r.base=r.el.dataset.base+"/",r.bindEvents(),r}return c(t,e),t.prototype.loadIndex=function(){var e=this;if(this.loadingState==o.Idle&&!this.data){setTimeout((function(){e.loadingState==o.Idle&&e.setLoadingState(o.Loading)}),500);var t=this.el.dataset.index;t?fetch(t).then((function(e){if(!e.ok)throw new Error("The search index is missing");return e.json()})).then((function(t){e.data=t,e.index=l.Index.load(t.index),e.setLoadingState(o.Ready)})).catch((function(t){console.error(t),e.setLoadingState(o.Failure)})):this.setLoadingState(o.Failure)}},t.prototype.updateResults=function(){if(this.loadingState==o.Ready&&(this.results.textContent="",this.query&&this.index&&this.data)){var e=this.index.search("*"+this.query+"*");0===e.length&&(e=this.index.search("*"+this.query+"~1*"));for(var t=0,r=Math.min(10,e.length);t"+e+""})),s=n.parent||"";(s=s.replace(new RegExp(this.query,"i"),(function(e){return""+e+""})))&&(i=''+s+"."+i);var a=document.createElement("li");a.classList.value=n.classes,a.innerHTML='\n '+i+"\n ",this.results.appendChild(a)}}},t.prototype.setLoadingState=function(e){this.loadingState!=e&&(this.el.classList.remove(o[this.loadingState].toLowerCase()),this.loadingState=e,this.el.classList.add(o[this.loadingState].toLowerCase()),this.updateResults())},t.prototype.setHasFocus=function(e){this.hasFocus!=e&&(this.hasFocus=e,this.el.classList.toggle("has-focus"),e?(this.setQuery(""),this.field.value=""):this.field.value=this.query)},t.prototype.setQuery=function(e){this.query=e.trim(),this.updateResults()},t.prototype.setCurrentResult=function(e){var t=this.results.querySelector(".current");if(t){var r=1==e?t.nextElementSibling:t.previousElementSibling;r&&(t.classList.remove("current"),r.classList.add("current"))}else(t=this.results.querySelector(1==e?"li:first-child":"li:last-child"))&&t.classList.add("current")},t.prototype.gotoCurrentResult=function(){var e=this.results.querySelector(".current");if(e||(e=this.results.querySelector("li:first-child")),e){var t=e.querySelector("a");t&&(window.location.href=t.href),this.field.blur()}},t.prototype.bindEvents=function(){var e=this;this.results.addEventListener("mousedown",(function(){e.resultClicked=!0})),this.results.addEventListener("mouseup",(function(){e.resultClicked=!1,e.setHasFocus(!1)})),this.field.addEventListener("focusin",(function(){e.setHasFocus(!0),e.loadIndex()})),this.field.addEventListener("focusout",(function(){e.resultClicked?e.resultClicked=!1:setTimeout((function(){return e.setHasFocus(!1)}),100)})),this.field.addEventListener("input",(function(){e.setQuery(e.field.value)})),this.field.addEventListener("keydown",(function(t){13==t.keyCode||27==t.keyCode||38==t.keyCode||40==t.keyCode?(e.preventPress=!0,t.preventDefault(),13==t.keyCode?e.gotoCurrentResult():27==t.keyCode?e.field.blur():38==t.keyCode?e.setCurrentResult(-1):40==t.keyCode&&e.setCurrentResult(1)):e.preventPress=!1})),this.field.addEventListener("keypress",(function(t){e.preventPress&&t.preventDefault()})),document.body.addEventListener("keydown",(function(t){t.altKey||t.ctrlKey||t.metaKey||!e.hasFocus&&t.keyCode>47&&t.keyCode<112&&e.field.focus()}))},t}(u),d=function(){function e(){this.listeners={}}return e.prototype.addEventListener=function(e,t){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(t)},e.prototype.removeEventListener=function(e,t){if(e in this.listeners)for(var r=this.listeners[e],n=0,i=r.length;n=this.scrollTop||0===this.scrollTop,e!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.secondaryNav.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop},t.instance=new t,t}(d),m=function(){var e=function(t,r){return(e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])})(t,r)};return function(t,r){function n(){this.constructor=t}e(t,r),t.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}(),v=function(e){function t(t){var r=e.call(this,t)||this;return r.anchors=[],r.index=-1,y.instance.addEventListener("resize",(function(){return r.onResize()})),y.instance.addEventListener("scroll",(function(e){return r.onScroll(e)})),r.createAnchors(),r}return m(t,e),t.prototype.createAnchors=function(){var e=this,t=window.location.href;-1!=t.indexOf("#")&&(t=t.substr(0,t.indexOf("#"))),this.el.querySelectorAll("a").forEach((function(r){var n=r.href;if(-1!=n.indexOf("#")&&n.substr(0,t.length)==t){var i=n.substr(n.indexOf("#")+1),s=document.querySelector("a.tsd-anchor[name="+i+"]"),o=r.parentNode;s&&o&&e.anchors.push({link:o,anchor:s,position:0})}})),this.onResize()},t.prototype.onResize=function(){for(var e,t=0,r=this.anchors.length;t-1&&r[i].position>t;)i-=1;for(;i-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=i,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))},t}(u),g=function(){var e=function(t,r){return(e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])})(t,r)};return function(t,r){function n(){this.constructor=t}e(t,r),t.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}(),x=function(){function e(e,t){this.signature=e,this.description=t}return e.prototype.addClass=function(e){return this.signature.classList.add(e),this.description.classList.add(e),this},e.prototype.removeClass=function(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this},e}(),w=function(e){function t(t){var r=e.call(this,t)||this;return r.groups=[],r.index=-1,r.createGroups(),r.container&&(r.el.classList.add("active"),Array.from(r.el.children).forEach((function(e){e.addEventListener("touchstart",(function(e){return r.onClick(e)})),e.addEventListener("click",(function(e){return r.onClick(e)}))})),r.container.classList.add("active"),r.setIndex(0)),r}return g(t,e),t.prototype.setIndex=function(e){if(e<0&&(e=0),e>this.groups.length-1&&(e=this.groups.length-1),this.index!=e){var t=this.groups[e];if(this.index>-1){var r=this.groups[this.index];r.removeClass("current").addClass("fade-out"),t.addClass("current"),t.addClass("fade-in"),y.instance.triggerResize(),setTimeout((function(){r.removeClass("fade-out"),t.removeClass("fade-in")}),300)}else t.addClass("current"),y.instance.triggerResize();this.index=e}},t.prototype.createGroups=function(){var e=this.el.children;if(!(e.length<2)){this.container=this.el.nextElementSibling;var t=this.container.children;this.groups=[];for(var r=0;r10}})),document.addEventListener(b,(function(){Q=!1})),document.addEventListener("click",(function(e){k&&(e.preventDefault(),e.stopImmediatePropagation(),k=!1)}));var T=function(){var e=function(t,r){return(e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])})(t,r)};return function(t,r){function n(){this.constructor=t}e(t,r),t.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}(),_=function(e){function t(t){var r=e.call(this,t)||this;return r.className=r.el.dataset.toggle||"",r.el.addEventListener(b,(function(e){return r.onPointerUp(e)})),r.el.addEventListener("click",(function(e){return e.preventDefault()})),document.addEventListener(L,(function(e){return r.onDocumentPointerDown(e)})),document.addEventListener(b,(function(e){return r.onDocumentPointerUp(e)})),r}return T(t,e),t.prototype.setActive=function(e){if(this.active!=e){this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);var t=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(t),setTimeout((function(){return document.documentElement.classList.remove(t)}),500)}},t.prototype.onPointerUp=function(e){O||(this.setActive(!0),e.preventDefault())},t.prototype.onDocumentPointerDown=function(e){if(this.active){if(e.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}},t.prototype.onDocumentPointerUp=function(e){var t=this;if(!O&&this.active&&e.target.closest(".col-menu")){var r=e.target.closest("a");if(r){var n=window.location.href;-1!=n.indexOf("#")&&(n=n.substr(0,n.indexOf("#"))),r.href.substr(0,n.length)==n&&setTimeout((function(){return t.setActive(!1)}),250)}}},t}(u),C=function(){var e=function(t,r){return(e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])})(t,r)};return function(t,r){function n(){this.constructor=t}e(t,r),t.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}(),R=function(){function e(e,t){this.key=e,this.value=t,this.defaultValue=t,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}return e.prototype.initialize=function(){},e.prototype.setValue=function(e){if(this.value!=e){var t=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(t,e)}},e}(),I=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return C(t,e),t.prototype.initialize=function(){var e=this,t=document.querySelector("#tsd-filter-"+this.key);t&&(this.checkbox=t,this.checkbox.addEventListener("change",(function(){e.setValue(e.checkbox.checked)})))},t.prototype.handleValueChange=function(e,t){this.checkbox&&(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))},t.prototype.fromLocalStorage=function(e){return"true"==e},t.prototype.toLocalStorage=function(e){return e?"true":"false"},t}(R),j=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return C(t,e),t.prototype.initialize=function(){var e=this;document.documentElement.classList.add("toggle-"+this.key+this.value);var t=document.querySelector("#tsd-filter-"+this.key);if(t){this.select=t;var r=function(){e.select.classList.add("active")};this.select.addEventListener(L,r),this.select.addEventListener("mouseover",r),this.select.addEventListener("mouseleave",(function(){e.select.classList.remove("active")})),this.select.querySelectorAll("li").forEach((function(r){r.addEventListener(b,(function(r){t.classList.remove("active"),e.setValue(r.target.dataset.value||"")}))})),document.addEventListener(L,(function(t){e.select.contains(t.target)||e.select.classList.remove("active")}))}},t.prototype.handleValueChange=function(e,t){this.select.querySelectorAll("li.selected").forEach((function(e){e.classList.remove("selected")}));var r=this.select.querySelector('li[data-value="'+t+'"]'),n=this.select.querySelector(".tsd-select-label");r&&n&&(r.classList.add("selected"),n.textContent=r.textContent),document.documentElement.classList.remove("toggle-"+e),document.documentElement.classList.add("toggle-"+t)},t.prototype.fromLocalStorage=function(e){return e},t.prototype.toLocalStorage=function(e){return e},t}(R),F=function(e){function t(t){var r=e.call(this,t)||this;return r.optionVisibility=new j("visibility","private"),r.optionInherited=new I("inherited",!0),r.optionExternals=new I("externals",!0),r.optionOnlyExported=new I("only-exported",!1),r}return C(t,e),t.isSupported=function(){try{return void 0!==window.localStorage}catch(e){return!1}},t}(u);r(1);i(h,"#tsd-search"),i(v,".menu-highlight"),i(w,".tsd-signatures"),i(_,"a[data-toggle]"),F.isSupported()?i(F,"#tsd-filter"):document.documentElement.classList.add("no-filter");var N=new a;Object.defineProperty(window,"app",{value:N})}]); \ No newline at end of file diff --git a/static/v2.15.x/typedoc/assets/js/search.json b/static/v2.15.x/typedoc/assets/js/search.json new file mode 100644 index 0000000000..fc56efc8a1 --- /dev/null +++ b/static/v2.15.x/typedoc/assets/js/search.json @@ -0,0 +1 @@ +{"kinds":{"1":"Module","4":"Enumeration","16":"Enumeration member","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","262144":"Accessor","2097152":"Object literal","4194304":"Type alias"},"rows":[{"id":0,"kind":1,"name":"@zowe/core-for-zowe-sdk","url":"modules/_zowe_core_for_zowe_sdk.html","classes":"tsd-kind-module"},{"id":1,"kind":128,"name":"ApimlConstants","url":"classes/_zowe_core_for_zowe_sdk.apimlconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":2,"kind":1024,"name":"SERVICES_ENDPOINT","url":"classes/_zowe_core_for_zowe_sdk.apimlconstants.html#services_endpoint","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ApimlConstants"},{"id":3,"kind":256,"name":"IApimlSvcAttrsLoaded","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlsvcattrsloaded.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":4,"kind":1024,"name":"connProfType","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlsvcattrsloaded.html#connproftype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlSvcAttrsLoaded"},{"id":5,"kind":1024,"name":"pluginName","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlsvcattrsloaded.html#pluginname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlSvcAttrsLoaded"},{"id":6,"kind":256,"name":"IApimlProfileInfo","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlprofileinfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":7,"kind":1024,"name":"profName","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlprofileinfo.html#profname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlProfileInfo"},{"id":8,"kind":1024,"name":"profType","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlprofileinfo.html#proftype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlProfileInfo"},{"id":9,"kind":1024,"name":"basePaths","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlprofileinfo.html#basepaths","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlProfileInfo"},{"id":10,"kind":1024,"name":"pluginConfigs","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlprofileinfo.html#pluginconfigs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlProfileInfo"},{"id":11,"kind":1024,"name":"gatewayUrlConflicts","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlprofileinfo.html#gatewayurlconflicts","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlProfileInfo"},{"id":12,"kind":65536,"name":"__type","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlprofileinfo.html#gatewayurlconflicts.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/core-for-zowe-sdk.IApimlProfileInfo.gatewayUrlConflicts"},{"id":13,"kind":256,"name":"IApimlServiceApiInfo","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlserviceapiinfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":14,"kind":1024,"name":"apiId","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlserviceapiinfo.html#apiid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlServiceApiInfo"},{"id":15,"kind":1024,"name":"gatewayUrl","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlserviceapiinfo.html#gatewayurl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlServiceApiInfo"},{"id":16,"kind":1024,"name":"swaggerUrl","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlserviceapiinfo.html#swaggerurl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlServiceApiInfo"},{"id":17,"kind":1024,"name":"documentationUrl","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlserviceapiinfo.html#documentationurl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlServiceApiInfo"},{"id":18,"kind":1024,"name":"baseUrl","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlserviceapiinfo.html#baseurl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlServiceApiInfo"},{"id":19,"kind":1024,"name":"basePath","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlserviceapiinfo.html#basepath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlServiceApiInfo"},{"id":20,"kind":1024,"name":"defaultApi","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlserviceapiinfo.html#defaultapi","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlServiceApiInfo"},{"id":21,"kind":256,"name":"IApimlServiceAuthentication","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlserviceauthentication.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":22,"kind":1024,"name":"scheme","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlserviceauthentication.html#scheme","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlServiceAuthentication"},{"id":23,"kind":1024,"name":"applid","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlserviceauthentication.html#applid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlServiceAuthentication"},{"id":24,"kind":1024,"name":"supportsSso","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlserviceauthentication.html#supportssso","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlServiceAuthentication"},{"id":25,"kind":256,"name":"IApimlService","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":26,"kind":1024,"name":"serviceId","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html#serviceid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlService"},{"id":27,"kind":1024,"name":"status","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlService"},{"id":28,"kind":1024,"name":"apiml","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html#apiml","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlService"},{"id":29,"kind":65536,"name":"__type","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html#apiml.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/core-for-zowe-sdk.IApimlService.apiml"},{"id":30,"kind":32,"name":"apiInfo","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html#apiml.__type.apiinfo","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/core-for-zowe-sdk.IApimlService.apiml.__type"},{"id":31,"kind":32,"name":"service","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html#apiml.__type.service","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/core-for-zowe-sdk.IApimlService.apiml.__type"},{"id":32,"kind":65536,"name":"__type","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html#apiml.__type.service.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"@zowe/core-for-zowe-sdk.IApimlService.apiml.__type.service"},{"id":33,"kind":32,"name":"title","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html#apiml.__type.service.__type-1.title","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/core-for-zowe-sdk.IApimlService.apiml.__type.service.__type"},{"id":34,"kind":32,"name":"description","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html#apiml.__type.service.__type-1.description","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/core-for-zowe-sdk.IApimlService.apiml.__type.service.__type"},{"id":35,"kind":32,"name":"homePageUrl","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html#apiml.__type.service.__type-1.homepageurl","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/core-for-zowe-sdk.IApimlService.apiml.__type.service.__type"},{"id":36,"kind":32,"name":"authentication","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html#apiml.__type.authentication","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/core-for-zowe-sdk.IApimlService.apiml.__type"},{"id":37,"kind":1024,"name":"instances","url":"interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html#instances","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IApimlService"},{"id":38,"kind":128,"name":"Services","url":"classes/_zowe_core_for_zowe_sdk.services.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":39,"kind":2048,"name":"getPluginApimlConfigs","url":"classes/_zowe_core_for_zowe_sdk.services.html#getpluginapimlconfigs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.Services"},{"id":40,"kind":2048,"name":"getServicesByConfig","url":"classes/_zowe_core_for_zowe_sdk.services.html#getservicesbyconfig","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.Services"},{"id":41,"kind":2048,"name":"convertApimlProfileInfoToProfileConfig","url":"classes/_zowe_core_for_zowe_sdk.services.html#convertapimlprofileinfotoprofileconfig","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.Services"},{"id":42,"kind":256,"name":"IAltProfile","url":"interfaces/_zowe_core_for_zowe_sdk.ialtprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":43,"kind":1024,"name":"altProfName","url":"interfaces/_zowe_core_for_zowe_sdk.ialtprofile.html#altprofname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IAltProfile"},{"id":44,"kind":1024,"name":"altProfType","url":"interfaces/_zowe_core_for_zowe_sdk.ialtprofile.html#altproftype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IAltProfile"},{"id":45,"kind":1024,"name":"altBasePath","url":"interfaces/_zowe_core_for_zowe_sdk.ialtprofile.html#altbasepath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IAltProfile"},{"id":46,"kind":256,"name":"IBaseProfileOverride","url":"interfaces/_zowe_core_for_zowe_sdk.ibaseprofileoverride.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":47,"kind":1024,"name":"propName","url":"interfaces/_zowe_core_for_zowe_sdk.ibaseprofileoverride.html#propname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IBaseProfileOverride"},{"id":48,"kind":1024,"name":"secure","url":"interfaces/_zowe_core_for_zowe_sdk.ibaseprofileoverride.html#secure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IBaseProfileOverride"},{"id":49,"kind":1024,"name":"priorityValue","url":"interfaces/_zowe_core_for_zowe_sdk.ibaseprofileoverride.html#priorityvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IBaseProfileOverride"},{"id":50,"kind":1024,"name":"baseValue","url":"interfaces/_zowe_core_for_zowe_sdk.ibaseprofileoverride.html#basevalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IBaseProfileOverride"},{"id":51,"kind":256,"name":"IProfileRpt","url":"interfaces/_zowe_core_for_zowe_sdk.iprofilerpt.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":52,"kind":1024,"name":"changeForProf","url":"interfaces/_zowe_core_for_zowe_sdk.iprofilerpt.html#changeforprof","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IProfileRpt"},{"id":53,"kind":1024,"name":"profName","url":"interfaces/_zowe_core_for_zowe_sdk.iprofilerpt.html#profname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IProfileRpt"},{"id":54,"kind":1024,"name":"profType","url":"interfaces/_zowe_core_for_zowe_sdk.iprofilerpt.html#proftype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IProfileRpt"},{"id":55,"kind":1024,"name":"basePath","url":"interfaces/_zowe_core_for_zowe_sdk.iprofilerpt.html#basepath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IProfileRpt"},{"id":56,"kind":1024,"name":"pluginNms","url":"interfaces/_zowe_core_for_zowe_sdk.iprofilerpt.html#pluginnms","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IProfileRpt"},{"id":57,"kind":1024,"name":"altProfiles","url":"interfaces/_zowe_core_for_zowe_sdk.iprofilerpt.html#altprofiles","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IProfileRpt"},{"id":58,"kind":1024,"name":"baseOverrides","url":"interfaces/_zowe_core_for_zowe_sdk.iprofilerpt.html#baseoverrides","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IProfileRpt"},{"id":59,"kind":256,"name":"IAutoInitRpt","url":"interfaces/_zowe_core_for_zowe_sdk.iautoinitrpt.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":60,"kind":1024,"name":"configFileNm","url":"interfaces/_zowe_core_for_zowe_sdk.iautoinitrpt.html#configfilenm","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IAutoInitRpt"},{"id":61,"kind":1024,"name":"changeForConfig","url":"interfaces/_zowe_core_for_zowe_sdk.iautoinitrpt.html#changeforconfig","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IAutoInitRpt"},{"id":62,"kind":1024,"name":"startingConfig","url":"interfaces/_zowe_core_for_zowe_sdk.iautoinitrpt.html#startingconfig","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IAutoInitRpt"},{"id":63,"kind":1024,"name":"endingConfig","url":"interfaces/_zowe_core_for_zowe_sdk.iautoinitrpt.html#endingconfig","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IAutoInitRpt"},{"id":64,"kind":1024,"name":"profileRpts","url":"interfaces/_zowe_core_for_zowe_sdk.iautoinitrpt.html#profilerpts","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/core-for-zowe-sdk.IAutoInitRpt"},{"id":65,"kind":256,"name":"IHeaderContent","url":"interfaces/_zowe_core_for_zowe_sdk.iheadercontent.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":66,"kind":128,"name":"ZosmfHeaders","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":67,"kind":1024,"name":"X_IBM_INTRDR_LRECL","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_intrdr_lrecl","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":68,"kind":1024,"name":"X_IBM_INTRDR_RECFM","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_intrdr_recfm","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":69,"kind":1024,"name":"X_IBM_JCL_SYMBOL_PARTIAL","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_jcl_symbol_partial","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":70,"kind":2097152,"name":"X_IBM_INTRDR_CLASS_A","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_intrdr_class_a","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":71,"kind":32,"name":"X-IBM-Intrdr-Class","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_intrdr_class_a.x_ibm_intrdr_class","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_INTRDR_CLASS_A"},{"id":72,"kind":2097152,"name":"X_IBM_INTRDR_RECFM_F","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_intrdr_recfm_f","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":73,"kind":32,"name":"X-IBM-Intrdr-Recfm","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_intrdr_recfm_f.x_ibm_intrdr_recfm-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_INTRDR_RECFM_F"},{"id":74,"kind":2097152,"name":"X_IBM_INTRDR_LRECL_80","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_intrdr_lrecl_80","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":75,"kind":32,"name":"X-IBM-Intrdr-Lrecl","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_intrdr_lrecl_80.x_ibm_intrdr_lrecl-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_INTRDR_LRECL_80"},{"id":76,"kind":2097152,"name":"X_IBM_INTRDR_LRECL_256","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_intrdr_lrecl_256","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":77,"kind":32,"name":"X-IBM-Intrdr-Lrecl","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_intrdr_lrecl_256.x_ibm_intrdr_lrecl-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_INTRDR_LRECL_256"},{"id":78,"kind":2097152,"name":"X_IBM_INTRDR_MODE_TEXT","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_intrdr_mode_text","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":79,"kind":32,"name":"X-IBM-Intrdr-Mode","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_intrdr_mode_text.x_ibm_intrdr_mode","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_INTRDR_MODE_TEXT"},{"id":80,"kind":2097152,"name":"X_IBM_NOTIFICATION_URL","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_notification_url","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":81,"kind":32,"name":"X-IBM-Notification-URL","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_notification_url.x_ibm_notification_url-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_NOTIFICATION_URL"},{"id":82,"kind":2097152,"name":"X_IBM_ATTRIBUTES_BASE","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_attributes_base","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":83,"kind":32,"name":"X-IBM-Attributes","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_attributes_base.x_ibm_attributes","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_ATTRIBUTES_BASE"},{"id":84,"kind":2097152,"name":"X_IBM_JOB_MODIFY_VERSION_1","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_job_modify_version_1","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":85,"kind":32,"name":"X-IBM-Job-Modify-Version","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_job_modify_version_1.x_ibm_job_modify_version","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_JOB_MODIFY_VERSION_1"},{"id":86,"kind":2097152,"name":"X_IBM_JOB_MODIFY_VERSION_2","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_job_modify_version_2","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":87,"kind":32,"name":"X-IBM-Job-Modify-Version","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_job_modify_version_2.x_ibm_job_modify_version-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_JOB_MODIFY_VERSION_2"},{"id":88,"kind":2097152,"name":"X_CSRF_ZOSMF_HEADER","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_csrf_zosmf_header","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":89,"kind":32,"name":"X-CSRF-ZOSMF-HEADER","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_csrf_zosmf_header.x_csrf_zosmf_header-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_CSRF_ZOSMF_HEADER"},{"id":90,"kind":2097152,"name":"X_IBM_BINARY","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_binary","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":91,"kind":32,"name":"X-IBM-Data-Type","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_binary.x_ibm_data_type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_BINARY"},{"id":92,"kind":2097152,"name":"X_IBM_RECORD","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_record","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":93,"kind":32,"name":"X-IBM-Data-Type","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_record.x_ibm_data_type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_RECORD"},{"id":94,"kind":2097152,"name":"X_IBM_BINARY_BY_RECORD","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_binary_by_record","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":95,"kind":32,"name":"X-IBM-Data-Type","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_binary_by_record.x_ibm_data_type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_BINARY_BY_RECORD"},{"id":96,"kind":2097152,"name":"X_IBM_TEXT","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_text","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":97,"kind":32,"name":"X-IBM-Data-Type","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_text.x_ibm_data_type-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_TEXT"},{"id":98,"kind":1024,"name":"X_IBM_TEXT_ENCODING","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_text_encoding","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":99,"kind":2097152,"name":"OCTET_STREAM","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#octet_stream","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":100,"kind":32,"name":"Content-Type","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#octet_stream.content_type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.OCTET_STREAM"},{"id":101,"kind":2097152,"name":"TEXT_PLAIN","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#text_plain","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":102,"kind":32,"name":"Content-Type","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#text_plain.content_type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.TEXT_PLAIN"},{"id":103,"kind":2097152,"name":"X_IBM_MAX_ITEMS","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_max_items","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":104,"kind":32,"name":"X-IBM-Max-Items","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_max_items.x_ibm_max_items-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_MAX_ITEMS"},{"id":105,"kind":2097152,"name":"X_IBM_MIGRATED_RECALL_WAIT","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_migrated_recall_wait","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":106,"kind":32,"name":"X-IBM-Migrated-Recall","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_migrated_recall_wait.x_ibm_migrated_recall-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_MIGRATED_RECALL_WAIT"},{"id":107,"kind":2097152,"name":"X_IBM_MIGRATED_RECALL_NO_WAIT","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_migrated_recall_no_wait","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":108,"kind":32,"name":"X-IBM-Migrated-Recall","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_migrated_recall_no_wait.x_ibm_migrated_recall-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_MIGRATED_RECALL_NO_WAIT"},{"id":109,"kind":2097152,"name":"X_IBM_MIGRATED_RECALL_ERROR","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_migrated_recall_error","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":110,"kind":32,"name":"X-IBM-Migrated-Recall","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_migrated_recall_error.x_ibm_migrated_recall","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_MIGRATED_RECALL_ERROR"},{"id":111,"kind":1024,"name":"IF_NONE_MATCH","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#if_none_match","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":112,"kind":1024,"name":"IF_MATCH","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#if_match","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":113,"kind":1024,"name":"X_IBM_RESPONSE_TIMEOUT","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_response_timeout","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":114,"kind":1024,"name":"X_IBM_RECORD_RANGE","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_record_range","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":115,"kind":1024,"name":"RANGE","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#range","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":116,"kind":2097152,"name":"X_IBM_RETURN_ETAG","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_return_etag","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":117,"kind":32,"name":"X-IBM-Return-Etag","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#x_ibm_return_etag.x_ibm_return_etag-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.X_IBM_RETURN_ETAG"},{"id":118,"kind":2097152,"name":"ACCEPT_ENCODING","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#accept_encoding","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders"},{"id":119,"kind":32,"name":"Accept-Encoding","url":"classes/_zowe_core_for_zowe_sdk.zosmfheaders.html#accept_encoding.accept_encoding-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ZosmfHeaders.ACCEPT_ENCODING"},{"id":120,"kind":128,"name":"ZosmfRestClient","url":"classes/_zowe_core_for_zowe_sdk.zosmfrestclient.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":121,"kind":262144,"name":"log","url":"classes/_zowe_core_for_zowe_sdk.zosmfrestclient.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/core-for-zowe-sdk.ZosmfRestClient"},{"id":122,"kind":2048,"name":"appendHeaders","url":"classes/_zowe_core_for_zowe_sdk.zosmfrestclient.html#appendheaders","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/core-for-zowe-sdk.ZosmfRestClient"},{"id":123,"kind":2048,"name":"processError","url":"classes/_zowe_core_for_zowe_sdk.zosmfrestclient.html#processerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/core-for-zowe-sdk.ZosmfRestClient"},{"id":124,"kind":128,"name":"LoginConstants","url":"classes/_zowe_core_for_zowe_sdk.loginconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":125,"kind":1024,"name":"APIML_V1_RESOURCE","url":"classes/_zowe_core_for_zowe_sdk.loginconstants.html#apiml_v1_resource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.LoginConstants"},{"id":126,"kind":128,"name":"Login","url":"classes/_zowe_core_for_zowe_sdk.login.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":127,"kind":2048,"name":"apimlLogin","url":"classes/_zowe_core_for_zowe_sdk.login.html#apimllogin","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.Login"},{"id":128,"kind":128,"name":"LogoutConstants","url":"classes/_zowe_core_for_zowe_sdk.logoutconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":129,"kind":1024,"name":"APIML_V1_RESOURCE","url":"classes/_zowe_core_for_zowe_sdk.logoutconstants.html#apiml_v1_resource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.LogoutConstants"},{"id":130,"kind":1024,"name":"APIML_V1_TOKEN_EXP_ERR","url":"classes/_zowe_core_for_zowe_sdk.logoutconstants.html#apiml_v1_token_exp_err","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.LogoutConstants"},{"id":131,"kind":2097152,"name":"APIML_V2_LOGOUT_ERR_LIST","url":"classes/_zowe_core_for_zowe_sdk.logoutconstants.html#apiml_v2_logout_err_list","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.LogoutConstants"},{"id":132,"kind":32,"name":"V1_TOKEN_EXPIRED","url":"classes/_zowe_core_for_zowe_sdk.logoutconstants.html#apiml_v2_logout_err_list.v1_token_expired","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.LogoutConstants.APIML_V2_LOGOUT_ERR_LIST"},{"id":133,"kind":32,"name":"V2_TOKEN_EXPIRED","url":"classes/_zowe_core_for_zowe_sdk.logoutconstants.html#apiml_v2_logout_err_list.v2_token_expired","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.LogoutConstants.APIML_V2_LOGOUT_ERR_LIST"},{"id":134,"kind":32,"name":"V2_TOKEN_INVALID","url":"classes/_zowe_core_for_zowe_sdk.logoutconstants.html#apiml_v2_logout_err_list.v2_token_invalid","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.LogoutConstants.APIML_V2_LOGOUT_ERR_LIST"},{"id":135,"kind":32,"name":"V2_TOKEN_MISSING","url":"classes/_zowe_core_for_zowe_sdk.logoutconstants.html#apiml_v2_logout_err_list.v2_token_missing","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.LogoutConstants.APIML_V2_LOGOUT_ERR_LIST"},{"id":136,"kind":128,"name":"Logout","url":"classes/_zowe_core_for_zowe_sdk.logout.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":137,"kind":2048,"name":"apimlLogout","url":"classes/_zowe_core_for_zowe_sdk.logout.html#apimllogout","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.Logout"},{"id":138,"kind":128,"name":"ProfileConstants","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":139,"kind":1024,"name":"BASE_CONNECTION_OPTION_GROUP","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_connection_option_group","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":140,"kind":2097152,"name":"BASE_OPTION_HOST","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_host","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":141,"kind":32,"name":"name","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_host.name-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_HOST"},{"id":142,"kind":32,"name":"aliases","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_host.aliases","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_HOST"},{"id":143,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_host.description-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_HOST"},{"id":144,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_host.type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_HOST"},{"id":145,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_host.group-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_HOST"},{"id":146,"kind":2097152,"name":"BASE_OPTION_PORT","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_port","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":147,"kind":32,"name":"name","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_port.name-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_PORT"},{"id":148,"kind":32,"name":"aliases","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_port.aliases-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_PORT"},{"id":149,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_port.description-16","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_PORT"},{"id":150,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_port.type-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_PORT"},{"id":151,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_port.group-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_PORT"},{"id":152,"kind":2097152,"name":"BASE_OPTION_USER","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_user","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":153,"kind":32,"name":"name","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_user.name-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_USER"},{"id":154,"kind":32,"name":"aliases","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_user.aliases-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_USER"},{"id":155,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_user.description-20","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_USER"},{"id":156,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_user.type-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_USER"},{"id":157,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_user.group-17","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_USER"},{"id":158,"kind":2097152,"name":"BASE_OPTION_PASSWORD","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_password","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":159,"kind":32,"name":"name","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_password.name-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_PASSWORD"},{"id":160,"kind":32,"name":"aliases","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_password.aliases-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_PASSWORD"},{"id":161,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_password.description-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_PASSWORD"},{"id":162,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_password.type-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_PASSWORD"},{"id":163,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_password.group-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_PASSWORD"},{"id":164,"kind":2097152,"name":"BASE_OPTION_REJECT_UNAUTHORIZED","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_reject_unauthorized","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":165,"kind":32,"name":"name","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_reject_unauthorized.name-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_REJECT_UNAUTHORIZED"},{"id":166,"kind":32,"name":"aliases","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_reject_unauthorized.aliases-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_REJECT_UNAUTHORIZED"},{"id":167,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_reject_unauthorized.description-17","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_REJECT_UNAUTHORIZED"},{"id":168,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_reject_unauthorized.type-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_REJECT_UNAUTHORIZED"},{"id":169,"kind":32,"name":"defaultValue","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_reject_unauthorized.defaultvalue","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_REJECT_UNAUTHORIZED"},{"id":170,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_reject_unauthorized.group-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_REJECT_UNAUTHORIZED"},{"id":171,"kind":2097152,"name":"BASE_OPTION_TOKEN_TYPE","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_token_type","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":172,"kind":32,"name":"name","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_token_type.name-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_TOKEN_TYPE"},{"id":173,"kind":32,"name":"aliases","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_token_type.aliases-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_TOKEN_TYPE"},{"id":174,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_token_type.description-18","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_TOKEN_TYPE"},{"id":175,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_token_type.type-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_TOKEN_TYPE"},{"id":176,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_token_type.group-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_TOKEN_TYPE"},{"id":177,"kind":2097152,"name":"BASE_OPTION_TOKEN_VALUE","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_token_value","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":178,"kind":32,"name":"name","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_token_value.name-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_TOKEN_VALUE"},{"id":179,"kind":32,"name":"aliases","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_token_value.aliases-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_TOKEN_VALUE"},{"id":180,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_token_value.description-19","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_TOKEN_VALUE"},{"id":181,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_token_value.type-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_TOKEN_VALUE"},{"id":182,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_token_value.group-16","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_TOKEN_VALUE"},{"id":183,"kind":2097152,"name":"BASE_OPTION_CERT_FILE","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_cert_file","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":184,"kind":32,"name":"name","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_cert_file.name","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_CERT_FILE"},{"id":185,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_cert_file.description-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_CERT_FILE"},{"id":186,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_cert_file.type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_CERT_FILE"},{"id":187,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_cert_file.group-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_CERT_FILE"},{"id":188,"kind":2097152,"name":"BASE_OPTION_CERT_KEY_FILE","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_cert_key_file","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":189,"kind":32,"name":"name","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_cert_key_file.name-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_CERT_KEY_FILE"},{"id":190,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_cert_key_file.description-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_CERT_KEY_FILE"},{"id":191,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_cert_key_file.type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_CERT_KEY_FILE"},{"id":192,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#base_option_cert_key_file.group-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BASE_OPTION_CERT_KEY_FILE"},{"id":193,"kind":1024,"name":"AUTO_INIT_OPTION_GROUP","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_group","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":194,"kind":2097152,"name":"AUTO_INIT_OPTION_HOST","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_host","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":195,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_host.description-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_HOST"},{"id":196,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_host.group-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_HOST"},{"id":197,"kind":2097152,"name":"AUTO_INIT_OPTION_PORT","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_port","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":198,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_port.description-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_PORT"},{"id":199,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_port.group-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_PORT"},{"id":200,"kind":2097152,"name":"AUTO_INIT_OPTION_USER","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_user","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":201,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_user.description-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_USER"},{"id":202,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_user.group-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_USER"},{"id":203,"kind":2097152,"name":"AUTO_INIT_OPTION_PASSWORD","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_password","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":204,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_password.description-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_PASSWORD"},{"id":205,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_password.group-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_PASSWORD"},{"id":206,"kind":2097152,"name":"AUTO_INIT_OPTION_REJECT_UNAUTHORIZED","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_reject_unauthorized","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":207,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_reject_unauthorized.group-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_REJECT_UNAUTHORIZED"},{"id":208,"kind":2097152,"name":"AUTO_INIT_OPTION_TOKEN_TYPE","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_token_type","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":209,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_token_type.description-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_TOKEN_TYPE"},{"id":210,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_token_type.group-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_TOKEN_TYPE"},{"id":211,"kind":2097152,"name":"AUTO_INIT_OPTION_TOKEN_VALUE","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_token_value","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":212,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_token_value.description-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_TOKEN_VALUE"},{"id":213,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_token_value.group-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_TOKEN_VALUE"},{"id":214,"kind":2097152,"name":"AUTO_INIT_OPTION_CERT_FILE","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_cert_file","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":215,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_cert_file.description-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_CERT_FILE"},{"id":216,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_cert_file.group","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_CERT_FILE"},{"id":217,"kind":2097152,"name":"AUTO_INIT_OPTION_CERT_KEY_FILE","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_cert_key_file","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":218,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_cert_key_file.description-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_CERT_KEY_FILE"},{"id":219,"kind":32,"name":"group","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auto_init_option_cert_key_file.group-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.AUTO_INIT_OPTION_CERT_KEY_FILE"},{"id":220,"kind":1024,"name":"AUTH_GROUP_SUMMARY","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auth_group_summary","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":221,"kind":1024,"name":"AUTH_GROUP_DESCRIPTION","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#auth_group_description","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":222,"kind":1024,"name":"APIML_LOGIN_SUMMARY","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_login_summary","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":223,"kind":1024,"name":"APIML_LOGIN_DESCRIPTION","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_login_description","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":224,"kind":2097152,"name":"APIML_LOGIN_EXAMPLE1","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_login_example1","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":225,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_login_example1.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.APIML_LOGIN_EXAMPLE1"},{"id":226,"kind":32,"name":"options","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_login_example1.options","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.APIML_LOGIN_EXAMPLE1"},{"id":227,"kind":2097152,"name":"APIML_LOGIN_EXAMPLE2","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_login_example2","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":228,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_login_example2.description-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.APIML_LOGIN_EXAMPLE2"},{"id":229,"kind":32,"name":"options","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_login_example2.options-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.APIML_LOGIN_EXAMPLE2"},{"id":230,"kind":1024,"name":"APIML_LOGOUT_SUMMARY","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_logout_summary","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":231,"kind":1024,"name":"APIML_LOGOUT_DESCRIPTION","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_logout_description","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":232,"kind":2097152,"name":"APIML_LOGOUT_EXAMPLE1","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_logout_example1","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":233,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_logout_example1.description-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.APIML_LOGOUT_EXAMPLE1"},{"id":234,"kind":32,"name":"options","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_logout_example1.options-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.APIML_LOGOUT_EXAMPLE1"},{"id":235,"kind":2097152,"name":"APIML_LOGOUT_EXAMPLE2","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_logout_example2","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":236,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_logout_example2.description-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.APIML_LOGOUT_EXAMPLE2"},{"id":237,"kind":32,"name":"options","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_logout_example2.options-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.APIML_LOGOUT_EXAMPLE2"},{"id":238,"kind":2097152,"name":"APIML_LOGOUT_OPTION_TOKEN_TYPE","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_logout_option_token_type","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":239,"kind":2097152,"name":"allowableValues","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_logout_option_token_type.allowablevalues","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.APIML_LOGOUT_OPTION_TOKEN_TYPE"},{"id":240,"kind":32,"name":"values","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#apiml_logout_option_token_type.allowablevalues.values","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.APIML_LOGOUT_OPTION_TOKEN_TYPE.allowableValues"},{"id":241,"kind":2097152,"name":"BaseProfile","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/core-for-zowe-sdk.ProfileConstants"},{"id":242,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.type-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile"},{"id":243,"kind":2097152,"name":"schema","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile"},{"id":244,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.type-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema"},{"id":245,"kind":32,"name":"title","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.title","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema"},{"id":246,"kind":32,"name":"description","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.description-21","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema"},{"id":247,"kind":2097152,"name":"properties","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema"},{"id":248,"kind":2097152,"name":"host","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.host","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties"},{"id":249,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.host.type-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.host"},{"id":250,"kind":32,"name":"optionDefinition","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.host.optiondefinition-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.host"},{"id":251,"kind":32,"name":"includeInTemplate","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.host.includeintemplate","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.host"},{"id":252,"kind":2097152,"name":"port","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.port","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties"},{"id":253,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.port.type-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.port"},{"id":254,"kind":32,"name":"optionDefinition","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.port.optiondefinition-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.port"},{"id":255,"kind":2097152,"name":"user","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.user","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties"},{"id":256,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.user.type-19","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.user"},{"id":257,"kind":32,"name":"secure","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.user.secure-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.user"},{"id":258,"kind":32,"name":"optionDefinition","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.user.optiondefinition-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.user"},{"id":259,"kind":32,"name":"includeInTemplate","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.user.includeintemplate-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.user"},{"id":260,"kind":2097152,"name":"password","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.password","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties"},{"id":261,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.password.type-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.password"},{"id":262,"kind":32,"name":"secure","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.password.secure","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.password"},{"id":263,"kind":32,"name":"optionDefinition","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.password.optiondefinition-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.password"},{"id":264,"kind":32,"name":"includeInTemplate","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.password.includeintemplate-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.password"},{"id":265,"kind":2097152,"name":"rejectUnauthorized","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.rejectunauthorized","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties"},{"id":266,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.rejectunauthorized.type-16","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.rejectUnauthorized"},{"id":267,"kind":32,"name":"optionDefinition","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.rejectunauthorized.optiondefinition-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.rejectUnauthorized"},{"id":268,"kind":32,"name":"includeInTemplate","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.rejectunauthorized.includeintemplate-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.rejectUnauthorized"},{"id":269,"kind":2097152,"name":"tokenType","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.tokentype","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties"},{"id":270,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.tokentype.type-17","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.tokenType"},{"id":271,"kind":32,"name":"optionDefinition","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.tokentype.optiondefinition-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.tokenType"},{"id":272,"kind":2097152,"name":"tokenValue","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.tokenvalue","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties"},{"id":273,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.tokenvalue.type-18","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.tokenValue"},{"id":274,"kind":32,"name":"secure","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.tokenvalue.secure-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.tokenValue"},{"id":275,"kind":32,"name":"optionDefinition","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.tokenvalue.optiondefinition-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.tokenValue"},{"id":276,"kind":2097152,"name":"certFile","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.certfile","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties"},{"id":277,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.certfile.type-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.certFile"},{"id":278,"kind":32,"name":"optionDefinition","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.certfile.optiondefinition","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.certFile"},{"id":279,"kind":2097152,"name":"certKeyFile","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.certkeyfile","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties"},{"id":280,"kind":32,"name":"type","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.certkeyfile.type-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.certKeyFile"},{"id":281,"kind":32,"name":"optionDefinition","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.properties.certkeyfile.optiondefinition-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema.properties.certKeyFile"},{"id":282,"kind":32,"name":"required","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.schema.required","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile.schema"},{"id":283,"kind":32,"name":"createProfileExamples","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.createprofileexamples","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile"},{"id":284,"kind":32,"name":"updateProfileExamples","url":"classes/_zowe_core_for_zowe_sdk.profileconstants.html#baseprofile.updateprofileexamples","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.ProfileConstants.BaseProfile"},{"id":285,"kind":2097152,"name":"nozOSMFVersion","url":"modules/_zowe_core_for_zowe_sdk.html#nozosmfversion","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":286,"kind":32,"name":"message","url":"modules/_zowe_core_for_zowe_sdk.html#nozosmfversion.message-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.nozOSMFVersion"},{"id":287,"kind":2097152,"name":"noSession","url":"modules/_zowe_core_for_zowe_sdk.html#nosession","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":288,"kind":32,"name":"message","url":"modules/_zowe_core_for_zowe_sdk.html#nosession.message","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/core-for-zowe-sdk.noSession"},{"id":289,"kind":64,"name":"padLeft","url":"modules/_zowe_core_for_zowe_sdk.html#padleft","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":290,"kind":64,"name":"trimLineToTerminalWidth","url":"modules/_zowe_core_for_zowe_sdk.html#trimlinetoterminalwidth","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":291,"kind":64,"name":"getErrorContext","url":"modules/_zowe_core_for_zowe_sdk.html#geterrorcontext","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":292,"kind":64,"name":"sleep","url":"modules/_zowe_core_for_zowe_sdk.html#sleep","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":293,"kind":64,"name":"readStdin","url":"modules/_zowe_core_for_zowe_sdk.html#readstdin","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":294,"kind":64,"name":"asyncPool","url":"modules/_zowe_core_for_zowe_sdk.html#asyncpool","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":295,"kind":64,"name":"getZoweDir","url":"modules/_zowe_core_for_zowe_sdk.html#getzowedir","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":296,"kind":64,"name":"getDefaultProfile","url":"modules/_zowe_core_for_zowe_sdk.html#getdefaultprofile","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/core-for-zowe-sdk"},{"id":297,"kind":1,"name":"@zowe/imperative","url":"modules/_zowe_imperative.html","classes":"tsd-kind-module"},{"id":298,"kind":256,"name":"IChainedHandlerArgumentMapping","url":"interfaces/_zowe_imperative.ichainedhandlerargumentmapping.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":299,"kind":1024,"name":"from","url":"interfaces/_zowe_imperative.ichainedhandlerargumentmapping.html#from","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IChainedHandlerArgumentMapping"},{"id":300,"kind":1024,"name":"mapFromArguments","url":"interfaces/_zowe_imperative.ichainedhandlerargumentmapping.html#mapfromarguments","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IChainedHandlerArgumentMapping"},{"id":301,"kind":1024,"name":"optional","url":"interfaces/_zowe_imperative.ichainedhandlerargumentmapping.html#optional","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IChainedHandlerArgumentMapping"},{"id":302,"kind":1024,"name":"to","url":"interfaces/_zowe_imperative.ichainedhandlerargumentmapping.html#to","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IChainedHandlerArgumentMapping"},{"id":303,"kind":1024,"name":"value","url":"interfaces/_zowe_imperative.ichainedhandlerargumentmapping.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IChainedHandlerArgumentMapping"},{"id":304,"kind":1024,"name":"applyToHandlers","url":"interfaces/_zowe_imperative.ichainedhandlerargumentmapping.html#applytohandlers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IChainedHandlerArgumentMapping"},{"id":305,"kind":256,"name":"IChainedHandlerEntry","url":"interfaces/_zowe_imperative.ichainedhandlerentry.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":306,"kind":1024,"name":"handler","url":"interfaces/_zowe_imperative.ichainedhandlerentry.html#handler","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IChainedHandlerEntry"},{"id":307,"kind":1024,"name":"mapping","url":"interfaces/_zowe_imperative.ichainedhandlerentry.html#mapping","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IChainedHandlerEntry"},{"id":308,"kind":1024,"name":"silent","url":"interfaces/_zowe_imperative.ichainedhandlerentry.html#silent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IChainedHandlerEntry"},{"id":309,"kind":256,"name":"IImperativeError","url":"interfaces/_zowe_imperative.iimperativeerror.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":310,"kind":1024,"name":"msg","url":"interfaces/_zowe_imperative.iimperativeerror.html#msg","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeError"},{"id":311,"kind":1024,"name":"causeErrors","url":"interfaces/_zowe_imperative.iimperativeerror.html#causeerrors","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeError"},{"id":312,"kind":1024,"name":"additionalDetails","url":"interfaces/_zowe_imperative.iimperativeerror.html#additionaldetails","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeError"},{"id":313,"kind":1024,"name":"stack","url":"interfaces/_zowe_imperative.iimperativeerror.html#stack","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeError"},{"id":314,"kind":1024,"name":"errorCode","url":"interfaces/_zowe_imperative.iimperativeerror.html#errorcode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeError"},{"id":315,"kind":1024,"name":"suppressDump","url":"interfaces/_zowe_imperative.iimperativeerror.html#suppressdump","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeError"},{"id":316,"kind":256,"name":"ILog4jsLayout","url":"interfaces/_zowe_imperative.ilog4jslayout.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":317,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.ilog4jslayout.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILog4jsLayout"},{"id":318,"kind":1024,"name":"pattern","url":"interfaces/_zowe_imperative.ilog4jslayout.html#pattern","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILog4jsLayout"},{"id":319,"kind":256,"name":"ILog4jsAppender","url":"interfaces/_zowe_imperative.ilog4jsappender.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":320,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.ilog4jsappender.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILog4jsAppender"},{"id":321,"kind":1024,"name":"layout","url":"interfaces/_zowe_imperative.ilog4jsappender.html#layout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILog4jsAppender"},{"id":322,"kind":256,"name":"ILog4jsConfig","url":"interfaces/_zowe_imperative.ilog4jsconfig.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":323,"kind":1024,"name":"appenders","url":"interfaces/_zowe_imperative.ilog4jsconfig.html#appenders","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILog4jsConfig"},{"id":324,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.ilog4jsconfig.html#appenders.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.ILog4jsConfig.appenders"},{"id":325,"kind":1024,"name":"categories","url":"interfaces/_zowe_imperative.ilog4jsconfig.html#categories","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILog4jsConfig"},{"id":326,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.ilog4jsconfig.html#categories.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.ILog4jsConfig.categories"},{"id":327,"kind":256,"name":"IConfigLogging","url":"interfaces/_zowe_imperative.iconfiglogging.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":328,"kind":1024,"name":"log4jsConfig","url":"interfaces/_zowe_imperative.iconfiglogging.html#log4jsconfig","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigLogging"},{"id":329,"kind":256,"name":"IExplanationMap","url":"interfaces/_zowe_imperative.iexplanationmap.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":330,"kind":1024,"name":"explainedParentKey","url":"interfaces/_zowe_imperative.iexplanationmap.html#explainedparentkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IExplanationMap"},{"id":331,"kind":1024,"name":"ignoredKeys","url":"interfaces/_zowe_imperative.iexplanationmap.html#ignoredkeys","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IExplanationMap"},{"id":332,"kind":128,"name":"TextUtils","url":"classes/_zowe_imperative.textutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":333,"kind":1024,"name":"DEFAULT_WRAP_WIDTH","url":"classes/_zowe_imperative.textutils.html#default_wrap_width","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":334,"kind":1024,"name":"AVAILABLE_CHALK_COLORS","url":"classes/_zowe_imperative.textutils.html#available_chalk_colors","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":335,"kind":2048,"name":"getRecommendedWidth","url":"classes/_zowe_imperative.textutils.html#getrecommendedwidth","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":336,"kind":2048,"name":"renderWithMustache","url":"classes/_zowe_imperative.textutils.html#renderwithmustache","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":337,"kind":2048,"name":"explainObject","url":"classes/_zowe_imperative.textutils.html#explainobject","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":338,"kind":2048,"name":"prettyJson","url":"classes/_zowe_imperative.textutils.html#prettyjson","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":339,"kind":2048,"name":"getTable","url":"classes/_zowe_imperative.textutils.html#gettable","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":340,"kind":2048,"name":"buildHeaders","url":"classes/_zowe_imperative.textutils.html#buildheaders","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":341,"kind":2048,"name":"wordWrap","url":"classes/_zowe_imperative.textutils.html#wordwrap","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":342,"kind":2048,"name":"indentLines","url":"classes/_zowe_imperative.textutils.html#indentlines","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":343,"kind":2048,"name":"highlightMatches","url":"classes/_zowe_imperative.textutils.html#highlightmatches","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":344,"kind":2048,"name":"formatMessage","url":"classes/_zowe_imperative.textutils.html#formatmessage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":345,"kind":262144,"name":"chalk","url":"classes/_zowe_imperative.textutils.html#chalk","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":346,"kind":2048,"name":"parseKeyValueString","url":"classes/_zowe_imperative.textutils.html#parsekeyvaluestring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":347,"kind":2048,"name":"renderTemplateFromKeyValueArguments","url":"classes/_zowe_imperative.textutils.html#rendertemplatefromkeyvaluearguments","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TextUtils"},{"id":348,"kind":4194304,"name":"ImperativeReject","url":"modules/_zowe_imperative.html#imperativereject","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":349,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#imperativereject.__type-12","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.ImperativeReject"},{"id":350,"kind":4194304,"name":"IConstructor","url":"modules/_zowe_imperative.html#iconstructor","classes":"tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":351,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#iconstructor.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.IConstructor"},{"id":352,"kind":128,"name":"ImperativeExpect","url":"classes/_zowe_imperative.imperativeexpect.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":353,"kind":1024,"name":"ERROR_TAG","url":"classes/_zowe_imperative.imperativeexpect.html#error_tag","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":354,"kind":2048,"name":"expectAndTransform","url":"classes/_zowe_imperative.imperativeexpect.html#expectandtransform","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":355,"kind":2048,"name":"toBeEqual","url":"classes/_zowe_imperative.imperativeexpect.html#tobeequal","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":356,"kind":2048,"name":"toMatchRegExp","url":"classes/_zowe_imperative.imperativeexpect.html#tomatchregexp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":357,"kind":2048,"name":"toNotBeNullOrUndefined","url":"classes/_zowe_imperative.imperativeexpect.html#tonotbenullorundefined","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":358,"kind":2048,"name":"arrayToContain","url":"classes/_zowe_imperative.imperativeexpect.html#arraytocontain","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":359,"kind":2048,"name":"toBeOneOf","url":"classes/_zowe_imperative.imperativeexpect.html#tobeoneof","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":360,"kind":2048,"name":"toBeAnArray","url":"classes/_zowe_imperative.imperativeexpect.html#tobeanarray","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":361,"kind":2048,"name":"keysToBeAnArray","url":"classes/_zowe_imperative.imperativeexpect.html#keystobeanarray","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":362,"kind":2048,"name":"keysToBeDefined","url":"classes/_zowe_imperative.imperativeexpect.html#keystobedefined","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":363,"kind":2048,"name":"toNotBeEqual","url":"classes/_zowe_imperative.imperativeexpect.html#tonotbeequal","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":364,"kind":2048,"name":"keysToBeDefinedAndNonBlank","url":"classes/_zowe_imperative.imperativeexpect.html#keystobedefinedandnonblank","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":365,"kind":2048,"name":"toBeDefinedAndNonBlank","url":"classes/_zowe_imperative.imperativeexpect.html#tobedefinedandnonblank","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":366,"kind":2048,"name":"keysToBeOfType","url":"classes/_zowe_imperative.imperativeexpect.html#keystobeoftype","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":367,"kind":2048,"name":"keysToBeUndefined","url":"classes/_zowe_imperative.imperativeexpect.html#keystobeundefined","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeExpect"},{"id":368,"kind":128,"name":"ExecUtils","url":"classes/_zowe_imperative.executils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":369,"kind":2048,"name":"spawnAndGetOutput","url":"classes/_zowe_imperative.executils.html#spawnandgetoutput","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ExecUtils"},{"id":370,"kind":128,"name":"IO","url":"classes/_zowe_imperative.io.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":371,"kind":1024,"name":"FILE_DELIM","url":"classes/_zowe_imperative.io.html#file_delim","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":372,"kind":1024,"name":"UTF8","url":"classes/_zowe_imperative.io.html#utf8","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":373,"kind":1024,"name":"OS_WIN32","url":"classes/_zowe_imperative.io.html#os_win32","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":374,"kind":1024,"name":"OS_MAC","url":"classes/_zowe_imperative.io.html#os_mac","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":375,"kind":1024,"name":"OS_LINUX","url":"classes/_zowe_imperative.io.html#os_linux","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":376,"kind":2048,"name":"isDir","url":"classes/_zowe_imperative.io.html#isdir","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":377,"kind":2048,"name":"normalizeExtension","url":"classes/_zowe_imperative.io.html#normalizeextension","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":378,"kind":2048,"name":"existsSync","url":"classes/_zowe_imperative.io.html#existssync","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":379,"kind":2048,"name":"createDirSync","url":"classes/_zowe_imperative.io.html#createdirsync","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":380,"kind":2048,"name":"createDirsSync","url":"classes/_zowe_imperative.io.html#createdirssync","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":381,"kind":2048,"name":"createDirsSyncFromFilePath","url":"classes/_zowe_imperative.io.html#createdirssyncfromfilepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":382,"kind":2048,"name":"createSymlinkToDir","url":"classes/_zowe_imperative.io.html#createsymlinktodir","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":383,"kind":2048,"name":"mkdirp","url":"classes/_zowe_imperative.io.html#mkdirp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":384,"kind":2048,"name":"readFileSync","url":"classes/_zowe_imperative.io.html#readfilesync","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":385,"kind":2048,"name":"createReadStream","url":"classes/_zowe_imperative.io.html#createreadstream","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":386,"kind":2048,"name":"createWriteStream","url":"classes/_zowe_imperative.io.html#createwritestream","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":387,"kind":2048,"name":"processNewlines","url":"classes/_zowe_imperative.io.html#processnewlines","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":388,"kind":2048,"name":"getDefaultTextEditor","url":"classes/_zowe_imperative.io.html#getdefaulttexteditor","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":389,"kind":2048,"name":"createFileSync","url":"classes/_zowe_imperative.io.html#createfilesync","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":390,"kind":2048,"name":"giveAccessOnlyToOwner","url":"classes/_zowe_imperative.io.html#giveaccessonlytoowner","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":391,"kind":2048,"name":"writeFileAsync","url":"classes/_zowe_imperative.io.html#writefileasync","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":392,"kind":2048,"name":"writeFile","url":"classes/_zowe_imperative.io.html#writefile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":393,"kind":2048,"name":"writeObject","url":"classes/_zowe_imperative.io.html#writeobject","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":394,"kind":2048,"name":"deleteFile","url":"classes/_zowe_imperative.io.html#deletefile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":395,"kind":2048,"name":"deleteDir","url":"classes/_zowe_imperative.io.html#deletedir","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":396,"kind":2048,"name":"deleteDirTree","url":"classes/_zowe_imperative.io.html#deletedirtree","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":397,"kind":2048,"name":"deleteSymLink","url":"classes/_zowe_imperative.io.html#deletesymlink","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.IO"},{"id":398,"kind":256,"name":"IQueuedMessage","url":"interfaces/_zowe_imperative.iqueuedmessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":399,"kind":1024,"name":"category","url":"interfaces/_zowe_imperative.iqueuedmessage.html#category","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IQueuedMessage"},{"id":400,"kind":1024,"name":"method","url":"interfaces/_zowe_imperative.iqueuedmessage.html#method","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IQueuedMessage"},{"id":401,"kind":1024,"name":"message","url":"interfaces/_zowe_imperative.iqueuedmessage.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IQueuedMessage"},{"id":402,"kind":256,"name":"IConsole","url":"interfaces/_zowe_imperative.iconsole.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":403,"kind":1024,"name":"level","url":"interfaces/_zowe_imperative.iconsole.html#level","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConsole"},{"id":404,"kind":2048,"name":"trace","url":"interfaces/_zowe_imperative.iconsole.html#trace","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IConsole"},{"id":405,"kind":2048,"name":"debug","url":"interfaces/_zowe_imperative.iconsole.html#debug","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IConsole"},{"id":406,"kind":2048,"name":"info","url":"interfaces/_zowe_imperative.iconsole.html#info","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IConsole"},{"id":407,"kind":2048,"name":"warn","url":"interfaces/_zowe_imperative.iconsole.html#warn","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IConsole"},{"id":408,"kind":2048,"name":"error","url":"interfaces/_zowe_imperative.iconsole.html#error","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IConsole"},{"id":409,"kind":2048,"name":"fatal","url":"interfaces/_zowe_imperative.iconsole.html#fatal","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IConsole"},{"id":410,"kind":128,"name":"Console","url":"classes/_zowe_imperative.console.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":411,"kind":1024,"name":"LEVELS","url":"classes/_zowe_imperative.console.html#levels","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Console"},{"id":412,"kind":1024,"name":"LEVEL_DEFAULT","url":"classes/_zowe_imperative.console.html#level_default","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Console"},{"id":413,"kind":2048,"name":"getConsole","url":"classes/_zowe_imperative.console.html#getconsole","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Console"},{"id":414,"kind":2048,"name":"isValidLevel","url":"classes/_zowe_imperative.console.html#isvalidlevel","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Console"},{"id":415,"kind":2048,"name":"validateLevel","url":"classes/_zowe_imperative.console.html#validatelevel","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Console"},{"id":416,"kind":1024,"name":"mPrefix","url":"classes/_zowe_imperative.console.html#mprefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Console"},{"id":417,"kind":1024,"name":"mColor","url":"classes/_zowe_imperative.console.html#mcolor","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Console"},{"id":418,"kind":1024,"name":"mIsOn","url":"classes/_zowe_imperative.console.html#mison","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Console"},{"id":419,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.console.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":420,"kind":1024,"name":"mLevel","url":"classes/_zowe_imperative.console.html#mlevel","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Console"},{"id":421,"kind":2048,"name":"addContext","url":"classes/_zowe_imperative.console.html#addcontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":422,"kind":2048,"name":"removeContext","url":"classes/_zowe_imperative.console.html#removecontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":423,"kind":2048,"name":"clearContext","url":"classes/_zowe_imperative.console.html#clearcontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":424,"kind":2048,"name":"isLevelEnabled","url":"classes/_zowe_imperative.console.html#islevelenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":425,"kind":2048,"name":"isTraceEnabled","url":"classes/_zowe_imperative.console.html#istraceenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":426,"kind":2048,"name":"isDebugEnabled","url":"classes/_zowe_imperative.console.html#isdebugenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":427,"kind":2048,"name":"isInfoEnabled","url":"classes/_zowe_imperative.console.html#isinfoenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":428,"kind":2048,"name":"isWarnEnabled","url":"classes/_zowe_imperative.console.html#iswarnenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":429,"kind":2048,"name":"isErrorEnabled","url":"classes/_zowe_imperative.console.html#iserrorenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":430,"kind":2048,"name":"isFatalEnabled","url":"classes/_zowe_imperative.console.html#isfatalenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":431,"kind":2048,"name":"isFormatEnabled","url":"classes/_zowe_imperative.console.html#isformatenabled","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":432,"kind":2048,"name":"info","url":"classes/_zowe_imperative.console.html#info","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":433,"kind":2048,"name":"trace","url":"classes/_zowe_imperative.console.html#trace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":434,"kind":2048,"name":"debug","url":"classes/_zowe_imperative.console.html#debug","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":435,"kind":2048,"name":"warn","url":"classes/_zowe_imperative.console.html#warn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":436,"kind":2048,"name":"error","url":"classes/_zowe_imperative.console.html#error","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":437,"kind":2048,"name":"fatal","url":"classes/_zowe_imperative.console.html#fatal","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":438,"kind":2048,"name":"writeStderr","url":"classes/_zowe_imperative.console.html#writestderr","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Console"},{"id":439,"kind":2048,"name":"writeStdout","url":"classes/_zowe_imperative.console.html#writestdout","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Console"},{"id":440,"kind":2048,"name":"format","url":"classes/_zowe_imperative.console.html#format","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Console"},{"id":441,"kind":2048,"name":"buildPrefix","url":"classes/_zowe_imperative.console.html#buildprefix","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Console"},{"id":442,"kind":262144,"name":"level","url":"classes/_zowe_imperative.console.html#level","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":443,"kind":262144,"name":"prefix","url":"classes/_zowe_imperative.console.html#prefix","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":444,"kind":262144,"name":"color","url":"classes/_zowe_imperative.console.html#color","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":445,"kind":262144,"name":"on","url":"classes/_zowe_imperative.console.html#on","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.Console"},{"id":446,"kind":128,"name":"LoggerManager","url":"classes/_zowe_imperative.loggermanager.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":447,"kind":1024,"name":"DEFAULT_MAX_QUEUE_SIZE","url":"classes/_zowe_imperative.loggermanager.html#default_max_queue_size","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggerManager"},{"id":448,"kind":1024,"name":"mInstance","url":"classes/_zowe_imperative.loggermanager.html#minstance","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggerManager"},{"id":449,"kind":262144,"name":"instance","url":"classes/_zowe_imperative.loggermanager.html#instance","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerManager"},{"id":450,"kind":1024,"name":"mIsLoggerInit","url":"classes/_zowe_imperative.loggermanager.html#misloggerinit","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.LoggerManager"},{"id":451,"kind":1024,"name":"mLogInMemory","url":"classes/_zowe_imperative.loggermanager.html#mloginmemory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.LoggerManager"},{"id":452,"kind":1024,"name":"mMaxQueueSize","url":"classes/_zowe_imperative.loggermanager.html#mmaxqueuesize","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.LoggerManager"},{"id":453,"kind":1024,"name":"console","url":"classes/_zowe_imperative.loggermanager.html#console","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.LoggerManager"},{"id":454,"kind":1024,"name":"mQueuedMessages","url":"classes/_zowe_imperative.loggermanager.html#mqueuedmessages","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.LoggerManager"},{"id":455,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.loggermanager.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.LoggerManager"},{"id":456,"kind":262144,"name":"isLoggerInit","url":"classes/_zowe_imperative.loggermanager.html#isloggerinit","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.LoggerManager"},{"id":457,"kind":262144,"name":"logInMemory","url":"classes/_zowe_imperative.loggermanager.html#loginmemory","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.LoggerManager"},{"id":458,"kind":262144,"name":"maxQueueSize","url":"classes/_zowe_imperative.loggermanager.html#maxqueuesize","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.LoggerManager"},{"id":459,"kind":262144,"name":"QueuedMessages","url":"classes/_zowe_imperative.loggermanager.html#queuedmessages","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.LoggerManager"},{"id":460,"kind":2048,"name":"queueMessage","url":"classes/_zowe_imperative.loggermanager.html#queuemessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.LoggerManager"},{"id":461,"kind":2048,"name":"dumpQueuedMessages","url":"classes/_zowe_imperative.loggermanager.html#dumpqueuedmessages","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.LoggerManager"},{"id":462,"kind":256,"name":"IImperativeEnvironmentalVariableSetting","url":"interfaces/_zowe_imperative.iimperativeenvironmentalvariablesetting.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":463,"kind":1024,"name":"key","url":"interfaces/_zowe_imperative.iimperativeenvironmentalvariablesetting.html#key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeEnvironmentalVariableSetting"},{"id":464,"kind":1024,"name":"value","url":"interfaces/_zowe_imperative.iimperativeenvironmentalvariablesetting.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeEnvironmentalVariableSetting"},{"id":465,"kind":256,"name":"IImperativeEnvironmentalVariableSettings","url":"interfaces/_zowe_imperative.iimperativeenvironmentalvariablesettings.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":466,"kind":1024,"name":"imperativeLogLevel","url":"interfaces/_zowe_imperative.iimperativeenvironmentalvariablesettings.html#imperativeloglevel","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeEnvironmentalVariableSettings"},{"id":467,"kind":1024,"name":"appLogLevel","url":"interfaces/_zowe_imperative.iimperativeenvironmentalvariablesettings.html#apploglevel","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeEnvironmentalVariableSettings"},{"id":468,"kind":1024,"name":"cliHome","url":"interfaces/_zowe_imperative.iimperativeenvironmentalvariablesettings.html#clihome","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeEnvironmentalVariableSettings"},{"id":469,"kind":1024,"name":"promptPhrase","url":"interfaces/_zowe_imperative.iimperativeenvironmentalvariablesettings.html#promptphrase","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeEnvironmentalVariableSettings"},{"id":470,"kind":1024,"name":"maskOutput","url":"interfaces/_zowe_imperative.iimperativeenvironmentalvariablesettings.html#maskoutput","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeEnvironmentalVariableSettings"},{"id":471,"kind":1024,"name":"pluginsDir","url":"interfaces/_zowe_imperative.iimperativeenvironmentalvariablesettings.html#pluginsdir","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeEnvironmentalVariableSettings"},{"id":472,"kind":128,"name":"Constants","url":"classes/_zowe_imperative.constants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":473,"kind":1024,"name":"FRAMEWORK_DISPLAY_NAME","url":"classes/_zowe_imperative.constants.html#framework_display_name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":474,"kind":1024,"name":"IMPERATIVE_DEFAULT_HOME","url":"classes/_zowe_imperative.constants.html#imperative_default_home","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":475,"kind":1024,"name":"IMPERATIVE_DIRECTORY","url":"classes/_zowe_imperative.constants.html#imperative_directory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":476,"kind":1024,"name":"ERROR_EXIT_CODE","url":"classes/_zowe_imperative.constants.html#error_exit_code","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":477,"kind":1024,"name":"PRIMARY_COMMAND","url":"classes/_zowe_imperative.constants.html#primary_command","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":478,"kind":1024,"name":"PROFILES_DIR","url":"classes/_zowe_imperative.constants.html#profiles_dir","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":479,"kind":1024,"name":"COMMAND_SEGMENT","url":"classes/_zowe_imperative.constants.html#command_segment","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":480,"kind":1024,"name":"GROUP_SEGMENT","url":"classes/_zowe_imperative.constants.html#group_segment","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":481,"kind":1024,"name":"OPTIONS_SEGMENT","url":"classes/_zowe_imperative.constants.html#options_segment","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":482,"kind":1024,"name":"DEFAULT_EXPERIMENTAL_COMMAND_EXPLANATION","url":"classes/_zowe_imperative.constants.html#default_experimental_command_explanation","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":483,"kind":1024,"name":"PRIMARY_SEGMENT_NUMBER","url":"classes/_zowe_imperative.constants.html#primary_segment_number","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":484,"kind":1024,"name":"GROUP_SEGMENT_NUMBER","url":"classes/_zowe_imperative.constants.html#group_segment_number","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":485,"kind":1024,"name":"DEFAULT_SET_PROFILE_OBJECT","url":"classes/_zowe_imperative.constants.html#default_set_profile_object","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":486,"kind":1024,"name":"DEFAULT_SET_PROFILE_OBJECT_ALIAS","url":"classes/_zowe_imperative.constants.html#default_set_profile_object_alias","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":487,"kind":1024,"name":"DEFAULT_SET_GROUP","url":"classes/_zowe_imperative.constants.html#default_set_group","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":488,"kind":1024,"name":"DEFAULT_LIST_PROFILE_OBJECT","url":"classes/_zowe_imperative.constants.html#default_list_profile_object","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":489,"kind":1024,"name":"DEFAULT_LIST_PROFILE_OBJECT_ALIAS","url":"classes/_zowe_imperative.constants.html#default_list_profile_object_alias","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":490,"kind":1024,"name":"DEFAULT_LIST_GROUP","url":"classes/_zowe_imperative.constants.html#default_list_group","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":491,"kind":1024,"name":"GLOBAL_GROUP","url":"classes/_zowe_imperative.constants.html#global_group","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":492,"kind":1024,"name":"JSON_OPTION","url":"classes/_zowe_imperative.constants.html#json_option","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":493,"kind":1024,"name":"JSON_OPTION_ALIAS","url":"classes/_zowe_imperative.constants.html#json_option_alias","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":494,"kind":1024,"name":"HELP_OPTION","url":"classes/_zowe_imperative.constants.html#help_option","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":495,"kind":1024,"name":"HELP_OPTION_ALIAS","url":"classes/_zowe_imperative.constants.html#help_option_alias","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":496,"kind":1024,"name":"HELP_EXAMPLES","url":"classes/_zowe_imperative.constants.html#help_examples","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":497,"kind":1024,"name":"HELP_WEB_OPTION","url":"classes/_zowe_imperative.constants.html#help_web_option","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":498,"kind":1024,"name":"HELP_WEB_OPTION_ALIAS","url":"classes/_zowe_imperative.constants.html#help_web_option_alias","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":499,"kind":1024,"name":"STDIN_OPTION","url":"classes/_zowe_imperative.constants.html#stdin_option","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":500,"kind":1024,"name":"STDIN_OPTION_ALIAS","url":"classes/_zowe_imperative.constants.html#stdin_option_alias","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":501,"kind":1024,"name":"STDIN_DEFAULT_DESCRIPTION","url":"classes/_zowe_imperative.constants.html#stdin_default_description","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":502,"kind":1024,"name":"OPT_LONG_DASH","url":"classes/_zowe_imperative.constants.html#opt_long_dash","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":503,"kind":1024,"name":"OPT_SHORT_DASH","url":"classes/_zowe_imperative.constants.html#opt_short_dash","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":504,"kind":1024,"name":"STDIN_CONTENT_KEY","url":"classes/_zowe_imperative.constants.html#stdin_content_key","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":505,"kind":1024,"name":"CREATE_ACTION","url":"classes/_zowe_imperative.constants.html#create_action","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":506,"kind":1024,"name":"PROFILE_GROUP","url":"classes/_zowe_imperative.constants.html#profile_group","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":507,"kind":1024,"name":"PROFILE_OBJECT","url":"classes/_zowe_imperative.constants.html#profile_object","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":508,"kind":1024,"name":"PROFILE_ALIASES","url":"classes/_zowe_imperative.constants.html#profile_aliases","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":509,"kind":1024,"name":"PROFILE_NAME_OPTION","url":"classes/_zowe_imperative.constants.html#profile_name_option","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":510,"kind":1024,"name":"PROFILE_NAME_OPTION_ALIAS","url":"classes/_zowe_imperative.constants.html#profile_name_option_alias","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":511,"kind":1024,"name":"OVERWRITE_OPTION","url":"classes/_zowe_imperative.constants.html#overwrite_option","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":512,"kind":1024,"name":"DISABLE_DEFAULTS_OPTION","url":"classes/_zowe_imperative.constants.html#disable_defaults_option","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":513,"kind":1024,"name":"DELETE_ACTION","url":"classes/_zowe_imperative.constants.html#delete_action","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":514,"kind":1024,"name":"DETAILS_ACTION","url":"classes/_zowe_imperative.constants.html#details_action","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":515,"kind":1024,"name":"SHOW_DEPS_ACTION","url":"classes/_zowe_imperative.constants.html#show_deps_action","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":516,"kind":1024,"name":"VALIDATE_ACTION","url":"classes/_zowe_imperative.constants.html#validate_action","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":517,"kind":1024,"name":"UPDATE_ACTION","url":"classes/_zowe_imperative.constants.html#update_action","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":518,"kind":1024,"name":"LIST_ACTION","url":"classes/_zowe_imperative.constants.html#list_action","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":519,"kind":1024,"name":"PROFILE_SET_OPTION_ALIAS","url":"classes/_zowe_imperative.constants.html#profile_set_option_alias","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":520,"kind":1024,"name":"SET_ACTION","url":"classes/_zowe_imperative.constants.html#set_action","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":521,"kind":1024,"name":"PROFILE_DELETE_PROFILE_DEPS","url":"classes/_zowe_imperative.constants.html#profile_delete_profile_deps","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":522,"kind":1024,"name":"PROFILE_DELETE_PROFILE_DEPS_ALIAS","url":"classes/_zowe_imperative.constants.html#profile_delete_profile_deps_alias","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":523,"kind":1024,"name":"DEFAULT_HIGHLIGHT_COLOR","url":"classes/_zowe_imperative.constants.html#default_highlight_color","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":524,"kind":1024,"name":"DEFAULT_PROMPT_PHRASE","url":"classes/_zowe_imperative.constants.html#default_prompt_phrase","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":525,"kind":1024,"name":"DEFAULT_MASK_OUTPUT","url":"classes/_zowe_imperative.constants.html#default_mask_output","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":526,"kind":1024,"name":"WEB_HELP_DIR","url":"classes/_zowe_imperative.constants.html#web_help_dir","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":527,"kind":1024,"name":"WEB_DIFF_DIR","url":"classes/_zowe_imperative.constants.html#web_diff_dir","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":528,"kind":1024,"name":"AUTH_GROUP","url":"classes/_zowe_imperative.constants.html#auth_group","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":529,"kind":1024,"name":"LOGIN_ACTION","url":"classes/_zowe_imperative.constants.html#login_action","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":530,"kind":1024,"name":"LOGIN_ACTION_ALIAS","url":"classes/_zowe_imperative.constants.html#login_action_alias","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":531,"kind":1024,"name":"LOGOUT_ACTION","url":"classes/_zowe_imperative.constants.html#logout_action","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":532,"kind":1024,"name":"LOGOUT_ACTION_ALIAS","url":"classes/_zowe_imperative.constants.html#logout_action_alias","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":533,"kind":1024,"name":"AUTO_INIT_ACTION","url":"classes/_zowe_imperative.constants.html#auto_init_action","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":534,"kind":1024,"name":"COMMAND_PROF_TYPE_PROPS","url":"classes/_zowe_imperative.constants.html#command_prof_type_props","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Constants"},{"id":535,"kind":128,"name":"EnvironmentalVariableSettings","url":"classes/_zowe_imperative.environmentalvariablesettings.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":536,"kind":1024,"name":"IMPERATIVE_LOG_LEVEL_KEY_SUFFIX","url":"classes/_zowe_imperative.environmentalvariablesettings.html#imperative_log_level_key_suffix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvironmentalVariableSettings"},{"id":537,"kind":1024,"name":"APP_LOG_LEVEL_KEY_SUFFIX","url":"classes/_zowe_imperative.environmentalvariablesettings.html#app_log_level_key_suffix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvironmentalVariableSettings"},{"id":538,"kind":1024,"name":"APP_MASK_OUTPUT_SUFFIX","url":"classes/_zowe_imperative.environmentalvariablesettings.html#app_mask_output_suffix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvironmentalVariableSettings"},{"id":539,"kind":1024,"name":"CLI_HOME_SUFFIX","url":"classes/_zowe_imperative.environmentalvariablesettings.html#cli_home_suffix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvironmentalVariableSettings"},{"id":540,"kind":1024,"name":"PROMPT_PHRASE_SUFFIX","url":"classes/_zowe_imperative.environmentalvariablesettings.html#prompt_phrase_suffix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvironmentalVariableSettings"},{"id":541,"kind":1024,"name":"CLI_PLUGINS_DIR_SUFFIX","url":"classes/_zowe_imperative.environmentalvariablesettings.html#cli_plugins_dir_suffix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvironmentalVariableSettings"},{"id":542,"kind":2048,"name":"read","url":"classes/_zowe_imperative.environmentalvariablesettings.html#read","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvironmentalVariableSettings"},{"id":543,"kind":256,"name":"IOptionFormat","url":"interfaces/_zowe_imperative.ioptionformat.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":544,"kind":1024,"name":"camelCase","url":"interfaces/_zowe_imperative.ioptionformat.html#camelcase","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionFormat"},{"id":545,"kind":1024,"name":"kebabCase","url":"interfaces/_zowe_imperative.ioptionformat.html#kebabcase","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionFormat"},{"id":546,"kind":1024,"name":"key","url":"interfaces/_zowe_imperative.ioptionformat.html#key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionFormat"},{"id":547,"kind":128,"name":"ProfilesConstants","url":"classes/_zowe_imperative.profilesconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":548,"kind":1024,"name":"PROFILES_COMMAND_TYPE_KEY","url":"classes/_zowe_imperative.profilesconstants.html#profiles_command_type_key","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfilesConstants"},{"id":549,"kind":1024,"name":"PROFILES_OPTION_SECURELY_STORED","url":"classes/_zowe_imperative.profilesconstants.html#profiles_option_securely_stored","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfilesConstants"},{"id":550,"kind":1024,"name":"DEPRECATE_TO_CONFIG_INIT","url":"classes/_zowe_imperative.profilesconstants.html#deprecate_to_config_init","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfilesConstants"},{"id":551,"kind":1024,"name":"DEPRECATE_TO_CONFIG_LIST","url":"classes/_zowe_imperative.profilesconstants.html#deprecate_to_config_list","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfilesConstants"},{"id":552,"kind":1024,"name":"DEPRECATE_TO_CONFIG_EDIT","url":"classes/_zowe_imperative.profilesconstants.html#deprecate_to_config_edit","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfilesConstants"},{"id":553,"kind":1024,"name":"DEPRECATE_TO_CONFIG_SET","url":"classes/_zowe_imperative.profilesconstants.html#deprecate_to_config_set","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfilesConstants"},{"id":554,"kind":256,"name":"IProfileProperty","url":"interfaces/_zowe_imperative.iprofileproperty.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":555,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.iprofileproperty.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileProperty"},{"id":556,"kind":1024,"name":"items","url":"interfaces/_zowe_imperative.iprofileproperty.html#items","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileProperty"},{"id":557,"kind":1024,"name":"properties","url":"interfaces/_zowe_imperative.iprofileproperty.html#properties","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileProperty"},{"id":558,"kind":1024,"name":"secure","url":"interfaces/_zowe_imperative.iprofileproperty.html#secure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileProperty"},{"id":559,"kind":1024,"name":"includeInTemplate","url":"interfaces/_zowe_imperative.iprofileproperty.html#includeintemplate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileProperty"},{"id":560,"kind":256,"name":"IProfileSchema","url":"interfaces/_zowe_imperative.iprofileschema.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":561,"kind":1024,"name":"title","url":"interfaces/_zowe_imperative.iprofileschema.html#title","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileSchema"},{"id":562,"kind":1024,"name":"description","url":"interfaces/_zowe_imperative.iprofileschema.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileSchema"},{"id":563,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.iprofileschema.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileSchema"},{"id":564,"kind":1024,"name":"properties","url":"interfaces/_zowe_imperative.iprofileschema.html#properties","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileSchema"},{"id":565,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iprofileschema.html#properties.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IProfileSchema.properties"},{"id":566,"kind":1024,"name":"version","url":"interfaces/_zowe_imperative.iprofileschema.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileSchema"},{"id":567,"kind":1024,"name":"required","url":"interfaces/_zowe_imperative.iprofileschema.html#required","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileSchema"},{"id":568,"kind":256,"name":"IProfileDependency","url":"interfaces/_zowe_imperative.iprofiledependency.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":569,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.iprofiledependency.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileDependency"},{"id":570,"kind":1024,"name":"required","url":"interfaces/_zowe_imperative.iprofiledependency.html#required","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileDependency"},{"id":571,"kind":1024,"name":"description","url":"interfaces/_zowe_imperative.iprofiledependency.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileDependency"},{"id":572,"kind":256,"name":"IProfileTypeConfiguration","url":"interfaces/_zowe_imperative.iprofiletypeconfiguration.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":573,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.iprofiletypeconfiguration.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileTypeConfiguration"},{"id":574,"kind":1024,"name":"schema","url":"interfaces/_zowe_imperative.iprofiletypeconfiguration.html#schema","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileTypeConfiguration"},{"id":575,"kind":1024,"name":"dependencies","url":"interfaces/_zowe_imperative.iprofiletypeconfiguration.html#dependencies","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileTypeConfiguration"},{"id":576,"kind":1024,"name":"validationPlanModule","url":"interfaces/_zowe_imperative.iprofiletypeconfiguration.html#validationplanmodule","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileTypeConfiguration"},{"id":577,"kind":256,"name":"IDaemonRequest","url":"interfaces/_zowe_imperative.idaemonrequest.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":578,"kind":1024,"name":"exitCode","url":"interfaces/_zowe_imperative.idaemonrequest.html#exitcode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonRequest"},{"id":579,"kind":1024,"name":"stdout","url":"interfaces/_zowe_imperative.idaemonrequest.html#stdout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonRequest"},{"id":580,"kind":1024,"name":"stderr","url":"interfaces/_zowe_imperative.idaemonrequest.html#stderr","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonRequest"},{"id":581,"kind":1024,"name":"prompt","url":"interfaces/_zowe_imperative.idaemonrequest.html#prompt","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonRequest"},{"id":582,"kind":1024,"name":"securePrompt","url":"interfaces/_zowe_imperative.idaemonrequest.html#secureprompt","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonRequest"},{"id":583,"kind":1024,"name":"progress","url":"interfaces/_zowe_imperative.idaemonrequest.html#progress","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonRequest"},{"id":584,"kind":256,"name":"IDaemonResponse","url":"interfaces/_zowe_imperative.idaemonresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":585,"kind":1024,"name":"argv","url":"interfaces/_zowe_imperative.idaemonresponse.html#argv","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonResponse"},{"id":586,"kind":1024,"name":"cwd","url":"interfaces/_zowe_imperative.idaemonresponse.html#cwd","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonResponse"},{"id":587,"kind":1024,"name":"env","url":"interfaces/_zowe_imperative.idaemonresponse.html#env","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonResponse"},{"id":588,"kind":1024,"name":"stdinLength","url":"interfaces/_zowe_imperative.idaemonresponse.html#stdinlength","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonResponse"},{"id":589,"kind":1024,"name":"stdin","url":"interfaces/_zowe_imperative.idaemonresponse.html#stdin","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonResponse"},{"id":590,"kind":1024,"name":"user","url":"interfaces/_zowe_imperative.idaemonresponse.html#user","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonResponse"},{"id":591,"kind":128,"name":"DaemonRequest","url":"classes/_zowe_imperative.daemonrequest.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":592,"kind":1024,"name":"EOW_DELIMITER","url":"classes/_zowe_imperative.daemonrequest.html#eow_delimiter","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.DaemonRequest"},{"id":593,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.daemonrequest.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.DaemonRequest"},{"id":594,"kind":1024,"name":"request","url":"classes/_zowe_imperative.daemonrequest.html#request","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DaemonRequest"},{"id":595,"kind":2048,"name":"create","url":"classes/_zowe_imperative.daemonrequest.html#create","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.DaemonRequest"},{"id":596,"kind":2048,"name":"build","url":"classes/_zowe_imperative.daemonrequest.html#build","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DaemonRequest"},{"id":597,"kind":128,"name":"ConfigConstants","url":"classes/_zowe_imperative.configconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":598,"kind":1024,"name":"INDENT","url":"classes/_zowe_imperative.configconstants.html#indent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigConstants"},{"id":599,"kind":1024,"name":"SECURE_VALUE","url":"classes/_zowe_imperative.configconstants.html#secure_value","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigConstants"},{"id":600,"kind":1024,"name":"SECURE_ACCT","url":"classes/_zowe_imperative.configconstants.html#secure_acct","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigConstants"},{"id":601,"kind":1024,"name":"SKIP_PROMPT","url":"classes/_zowe_imperative.configconstants.html#skip_prompt","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigConstants"},{"id":602,"kind":256,"name":"IConfigProfile","url":"interfaces/_zowe_imperative.iconfigprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":603,"kind":1024,"name":"properties","url":"interfaces/_zowe_imperative.iconfigprofile.html#properties","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigProfile"},{"id":604,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iconfigprofile.html#properties.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IConfigProfile.properties"},{"id":605,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.iconfigprofile.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigProfile"},{"id":606,"kind":1024,"name":"profiles","url":"interfaces/_zowe_imperative.iconfigprofile.html#profiles","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigProfile"},{"id":607,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iconfigprofile.html#profiles.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IConfigProfile.profiles"},{"id":608,"kind":1024,"name":"secure","url":"interfaces/_zowe_imperative.iconfigprofile.html#secure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigProfile"},{"id":609,"kind":256,"name":"IConfig","url":"interfaces/_zowe_imperative.iconfig.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":610,"kind":1024,"name":"$schema","url":"interfaces/_zowe_imperative.iconfig.html#_schema","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfig"},{"id":611,"kind":1024,"name":"defaults","url":"interfaces/_zowe_imperative.iconfig.html#defaults","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfig"},{"id":612,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iconfig.html#defaults.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IConfig.defaults"},{"id":613,"kind":1024,"name":"profiles","url":"interfaces/_zowe_imperative.iconfig.html#profiles","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfig"},{"id":614,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iconfig.html#profiles.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IConfig.profiles"},{"id":615,"kind":1024,"name":"autoStore","url":"interfaces/_zowe_imperative.iconfig.html#autostore","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfig"},{"id":616,"kind":1024,"name":"plugins","url":"interfaces/_zowe_imperative.iconfig.html#plugins","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfig"},{"id":617,"kind":256,"name":"IConfigLayer","url":"interfaces/_zowe_imperative.iconfiglayer.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":618,"kind":1024,"name":"path","url":"interfaces/_zowe_imperative.iconfiglayer.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigLayer"},{"id":619,"kind":1024,"name":"exists","url":"interfaces/_zowe_imperative.iconfiglayer.html#exists","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigLayer"},{"id":620,"kind":1024,"name":"properties","url":"interfaces/_zowe_imperative.iconfiglayer.html#properties","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigLayer"},{"id":621,"kind":1024,"name":"global","url":"interfaces/_zowe_imperative.iconfiglayer.html#global","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigLayer"},{"id":622,"kind":1024,"name":"user","url":"interfaces/_zowe_imperative.iconfiglayer.html#user","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigLayer"},{"id":623,"kind":256,"name":"IConfigVault","url":"interfaces/_zowe_imperative.iconfigvault.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":624,"kind":1024,"name":"load","url":"interfaces/_zowe_imperative.iconfigvault.html#load","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigVault"},{"id":625,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iconfigvault.html#load.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IConfigVault.load"},{"id":626,"kind":1024,"name":"save","url":"interfaces/_zowe_imperative.iconfigvault.html#save","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigVault"},{"id":627,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iconfigvault.html#save.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IConfigVault.save"},{"id":628,"kind":256,"name":"IConfigOpts","url":"interfaces/_zowe_imperative.iconfigopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":629,"kind":1024,"name":"homeDir","url":"interfaces/_zowe_imperative.iconfigopts.html#homedir","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigOpts"},{"id":630,"kind":1024,"name":"projectDir","url":"interfaces/_zowe_imperative.iconfigopts.html#projectdir","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigOpts"},{"id":631,"kind":1024,"name":"vault","url":"interfaces/_zowe_imperative.iconfigopts.html#vault","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigOpts"},{"id":632,"kind":1024,"name":"noLoad","url":"interfaces/_zowe_imperative.iconfigopts.html#noload","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigOpts"},{"id":633,"kind":4194304,"name":"IConfigSecureProperties","url":"modules/_zowe_imperative.html#iconfigsecureproperties","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":634,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#iconfigsecureproperties.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.IConfigSecureProperties"},{"id":635,"kind":4194304,"name":"IConfigSecure","url":"modules/_zowe_imperative.html#iconfigsecure","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":636,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#iconfigsecure.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.IConfigSecure"},{"id":637,"kind":128,"name":"ConfigApi","url":"classes/_zowe_imperative.configapi.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":638,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.configapi.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.ConfigApi"},{"id":639,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.configapi.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.ConfigApi"},{"id":640,"kind":128,"name":"ConfigLayers","url":"classes/_zowe_imperative.configlayers.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":641,"kind":2048,"name":"read","url":"classes/_zowe_imperative.configlayers.html#read","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigLayers"},{"id":642,"kind":2048,"name":"write","url":"classes/_zowe_imperative.configlayers.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigLayers"},{"id":643,"kind":2048,"name":"activate","url":"classes/_zowe_imperative.configlayers.html#activate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigLayers"},{"id":644,"kind":2048,"name":"get","url":"classes/_zowe_imperative.configlayers.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigLayers"},{"id":645,"kind":2048,"name":"set","url":"classes/_zowe_imperative.configlayers.html#set","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigLayers"},{"id":646,"kind":2048,"name":"merge","url":"classes/_zowe_imperative.configlayers.html#merge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigLayers"},{"id":647,"kind":2048,"name":"find","url":"classes/_zowe_imperative.configlayers.html#find","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigLayers"},{"id":648,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.configlayers.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ConfigLayers"},{"id":649,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.configlayers.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ConfigLayers"},{"id":650,"kind":128,"name":"ConfigPlugins","url":"classes/_zowe_imperative.configplugins.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":651,"kind":2048,"name":"get","url":"classes/_zowe_imperative.configplugins.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigPlugins"},{"id":652,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.configplugins.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ConfigPlugins"},{"id":653,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.configplugins.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ConfigPlugins"},{"id":654,"kind":128,"name":"ConfigProfiles","url":"classes/_zowe_imperative.configprofiles.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":655,"kind":2048,"name":"set","url":"classes/_zowe_imperative.configprofiles.html#set","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigProfiles"},{"id":656,"kind":2048,"name":"get","url":"classes/_zowe_imperative.configprofiles.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigProfiles"},{"id":657,"kind":2048,"name":"exists","url":"classes/_zowe_imperative.configprofiles.html#exists","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigProfiles"},{"id":658,"kind":2048,"name":"defaultSet","url":"classes/_zowe_imperative.configprofiles.html#defaultset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigProfiles"},{"id":659,"kind":2048,"name":"defaultGet","url":"classes/_zowe_imperative.configprofiles.html#defaultget","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigProfiles"},{"id":660,"kind":2048,"name":"expandPath","url":"classes/_zowe_imperative.configprofiles.html#expandpath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigProfiles"},{"id":661,"kind":2048,"name":"getProfilePathFromName","url":"classes/_zowe_imperative.configprofiles.html#getprofilepathfromname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigProfiles"},{"id":662,"kind":2048,"name":"getProfileNameFromPath","url":"classes/_zowe_imperative.configprofiles.html#getprofilenamefrompath","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigProfiles"},{"id":663,"kind":2048,"name":"buildProfile","url":"classes/_zowe_imperative.configprofiles.html#buildprofile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigProfiles"},{"id":664,"kind":2048,"name":"findProfile","url":"classes/_zowe_imperative.configprofiles.html#findprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ConfigProfiles"},{"id":665,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.configprofiles.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ConfigProfiles"},{"id":666,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.configprofiles.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ConfigProfiles"},{"id":667,"kind":128,"name":"AbstractCredentialManager","url":"classes/_zowe_imperative.abstractcredentialmanager.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":668,"kind":2048,"name":"initialize","url":"classes/_zowe_imperative.abstractcredentialmanager.html#initialize","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":669,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.abstractcredentialmanager.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":670,"kind":1024,"name":"service","url":"classes/_zowe_imperative.abstractcredentialmanager.html#service","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":671,"kind":1024,"name":"displayName","url":"classes/_zowe_imperative.abstractcredentialmanager.html#displayname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":672,"kind":262144,"name":"name","url":"classes/_zowe_imperative.abstractcredentialmanager.html#name","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":673,"kind":2048,"name":"delete","url":"classes/_zowe_imperative.abstractcredentialmanager.html#delete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":674,"kind":2048,"name":"load","url":"classes/_zowe_imperative.abstractcredentialmanager.html#load","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":675,"kind":2048,"name":"save","url":"classes/_zowe_imperative.abstractcredentialmanager.html#save","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":676,"kind":2048,"name":"secureErrorDetails","url":"classes/_zowe_imperative.abstractcredentialmanager.html#secureerrordetails","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":677,"kind":262144,"name":"possibleSolutions","url":"classes/_zowe_imperative.abstractcredentialmanager.html#possiblesolutions","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":678,"kind":2048,"name":"deleteCredentials","url":"classes/_zowe_imperative.abstractcredentialmanager.html#deletecredentials","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":679,"kind":2048,"name":"loadCredentials","url":"classes/_zowe_imperative.abstractcredentialmanager.html#loadcredentials","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":680,"kind":2048,"name":"saveCredentials","url":"classes/_zowe_imperative.abstractcredentialmanager.html#savecredentials","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCredentialManager"},{"id":681,"kind":4194304,"name":"SecureCredential","url":"modules/_zowe_imperative.html#securecredential","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":682,"kind":4194304,"name":"IImperativeOverrides","url":"modules/_zowe_imperative.html#iimperativeoverrides","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":683,"kind":256,"name":"ICredentialManagerInit","url":"interfaces/_zowe_imperative.icredentialmanagerinit.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":684,"kind":1024,"name":"service","url":"interfaces/_zowe_imperative.icredentialmanagerinit.html#service","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICredentialManagerInit"},{"id":685,"kind":1024,"name":"Manager","url":"interfaces/_zowe_imperative.icredentialmanagerinit.html#manager","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICredentialManagerInit"},{"id":686,"kind":1024,"name":"displayName","url":"interfaces/_zowe_imperative.icredentialmanagerinit.html#displayname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICredentialManagerInit"},{"id":687,"kind":1024,"name":"invalidOnFailure","url":"interfaces/_zowe_imperative.icredentialmanagerinit.html#invalidonfailure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICredentialManagerInit"},{"id":688,"kind":128,"name":"DefaultCredentialManager","url":"classes/_zowe_imperative.defaultcredentialmanager.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":689,"kind":1024,"name":"SVC_NAME","url":"classes/_zowe_imperative.defaultcredentialmanager.html#svc_name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":690,"kind":1024,"name":"keytar","url":"classes/_zowe_imperative.defaultcredentialmanager.html#keytar","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":691,"kind":1024,"name":"loadError","url":"classes/_zowe_imperative.defaultcredentialmanager.html#loaderror","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":692,"kind":1024,"name":"allServices","url":"classes/_zowe_imperative.defaultcredentialmanager.html#allservices","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":693,"kind":1024,"name":"WIN32_CRED_MAX_STRING_LENGTH","url":"classes/_zowe_imperative.defaultcredentialmanager.html#win32_cred_max_string_length","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":694,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.defaultcredentialmanager.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":695,"kind":2048,"name":"initialize","url":"classes/_zowe_imperative.defaultcredentialmanager.html#initialize","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":696,"kind":262144,"name":"possibleSolutions","url":"classes/_zowe_imperative.defaultcredentialmanager.html#possiblesolutions","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":697,"kind":2048,"name":"deleteCredentials","url":"classes/_zowe_imperative.defaultcredentialmanager.html#deletecredentials","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":698,"kind":2048,"name":"loadCredentials","url":"classes/_zowe_imperative.defaultcredentialmanager.html#loadcredentials","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":699,"kind":2048,"name":"saveCredentials","url":"classes/_zowe_imperative.defaultcredentialmanager.html#savecredentials","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":700,"kind":262144,"name":"defaultService","url":"classes/_zowe_imperative.defaultcredentialmanager.html#defaultservice","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":701,"kind":2048,"name":"checkForKeytar","url":"classes/_zowe_imperative.defaultcredentialmanager.html#checkforkeytar","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":702,"kind":2048,"name":"getCredentialsHelper","url":"classes/_zowe_imperative.defaultcredentialmanager.html#getcredentialshelper","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":703,"kind":2048,"name":"setCredentialsHelper","url":"classes/_zowe_imperative.defaultcredentialmanager.html#setcredentialshelper","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":704,"kind":2048,"name":"deleteCredentialsHelper","url":"classes/_zowe_imperative.defaultcredentialmanager.html#deletecredentialshelper","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":705,"kind":2048,"name":"getMissingEntryMessage","url":"classes/_zowe_imperative.defaultcredentialmanager.html#getmissingentrymessage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":706,"kind":1024,"name":"service","url":"classes/_zowe_imperative.defaultcredentialmanager.html#service","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":707,"kind":262144,"name":"name","url":"classes/_zowe_imperative.defaultcredentialmanager.html#name","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":708,"kind":2048,"name":"delete","url":"classes/_zowe_imperative.defaultcredentialmanager.html#delete","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":709,"kind":2048,"name":"load","url":"classes/_zowe_imperative.defaultcredentialmanager.html#load","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":710,"kind":2048,"name":"save","url":"classes/_zowe_imperative.defaultcredentialmanager.html#save","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":711,"kind":2048,"name":"secureErrorDetails","url":"classes/_zowe_imperative.defaultcredentialmanager.html#secureerrordetails","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.DefaultCredentialManager"},{"id":712,"kind":128,"name":"BadCredentialManagerError","url":"classes/_zowe_imperative.badcredentialmanagererror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":713,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.badcredentialmanagererror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.BadCredentialManagerError"},{"id":714,"kind":1024,"name":"mDetails","url":"classes/_zowe_imperative.badcredentialmanagererror.html#mdetails","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BadCredentialManagerError"},{"id":715,"kind":262144,"name":"causeErrors","url":"classes/_zowe_imperative.badcredentialmanagererror.html#causeerrors","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BadCredentialManagerError"},{"id":716,"kind":262144,"name":"additionalDetails","url":"classes/_zowe_imperative.badcredentialmanagererror.html#additionaldetails","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BadCredentialManagerError"},{"id":717,"kind":262144,"name":"details","url":"classes/_zowe_imperative.badcredentialmanagererror.html#details","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BadCredentialManagerError"},{"id":718,"kind":262144,"name":"errorCode","url":"classes/_zowe_imperative.badcredentialmanagererror.html#errorcode","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BadCredentialManagerError"},{"id":719,"kind":262144,"name":"suppressDump","url":"classes/_zowe_imperative.badcredentialmanagererror.html#suppressdump","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BadCredentialManagerError"},{"id":720,"kind":262144,"name":"stack","url":"classes/_zowe_imperative.badcredentialmanagererror.html#stack","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.BadCredentialManagerError"},{"id":721,"kind":262144,"name":"message","url":"classes/_zowe_imperative.badcredentialmanagererror.html#message","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.BadCredentialManagerError"},{"id":722,"kind":1024,"name":"name","url":"classes/_zowe_imperative.badcredentialmanagererror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BadCredentialManagerError"},{"id":723,"kind":128,"name":"InvalidCredentialManager","url":"classes/_zowe_imperative.invalidcredentialmanager.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":724,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.invalidcredentialmanager.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":725,"kind":1024,"name":"service","url":"classes/_zowe_imperative.invalidcredentialmanager.html#service","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":726,"kind":1024,"name":"causeError","url":"classes/_zowe_imperative.invalidcredentialmanager.html#causeerror","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":727,"kind":2048,"name":"deleteCredentials","url":"classes/_zowe_imperative.invalidcredentialmanager.html#deletecredentials","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":728,"kind":2048,"name":"loadCredentials","url":"classes/_zowe_imperative.invalidcredentialmanager.html#loadcredentials","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":729,"kind":2048,"name":"saveCredentials","url":"classes/_zowe_imperative.invalidcredentialmanager.html#savecredentials","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":730,"kind":2048,"name":"initialize","url":"classes/_zowe_imperative.invalidcredentialmanager.html#initialize","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":731,"kind":262144,"name":"name","url":"classes/_zowe_imperative.invalidcredentialmanager.html#name","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":732,"kind":2048,"name":"delete","url":"classes/_zowe_imperative.invalidcredentialmanager.html#delete","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":733,"kind":2048,"name":"load","url":"classes/_zowe_imperative.invalidcredentialmanager.html#load","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":734,"kind":2048,"name":"save","url":"classes/_zowe_imperative.invalidcredentialmanager.html#save","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":735,"kind":2048,"name":"secureErrorDetails","url":"classes/_zowe_imperative.invalidcredentialmanager.html#secureerrordetails","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":736,"kind":262144,"name":"possibleSolutions","url":"classes/_zowe_imperative.invalidcredentialmanager.html#possiblesolutions","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.InvalidCredentialManager"},{"id":737,"kind":128,"name":"CredentialManagerFactory","url":"classes/_zowe_imperative.credentialmanagerfactory.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":738,"kind":2048,"name":"initialize","url":"classes/_zowe_imperative.credentialmanagerfactory.html#initialize","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CredentialManagerFactory"},{"id":739,"kind":1024,"name":"mManager","url":"classes/_zowe_imperative.credentialmanagerfactory.html#mmanager","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CredentialManagerFactory"},{"id":740,"kind":262144,"name":"manager","url":"classes/_zowe_imperative.credentialmanagerfactory.html#manager","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CredentialManagerFactory"},{"id":741,"kind":262144,"name":"initialized","url":"classes/_zowe_imperative.credentialmanagerfactory.html#initialized","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CredentialManagerFactory"},{"id":742,"kind":256,"name":"ICredentialManagerNameMap","url":"interfaces/_zowe_imperative.icredentialmanagernamemap.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":743,"kind":1024,"name":"credMgrDisplayName","url":"interfaces/_zowe_imperative.icredentialmanagernamemap.html#credmgrdisplayname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICredentialManagerNameMap"},{"id":744,"kind":1024,"name":"credMgrPluginName","url":"interfaces/_zowe_imperative.icredentialmanagernamemap.html#credmgrpluginname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICredentialManagerNameMap"},{"id":745,"kind":1024,"name":"credMgrZEName","url":"interfaces/_zowe_imperative.icredentialmanagernamemap.html#credmgrzename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICredentialManagerNameMap"},{"id":746,"kind":256,"name":"ISettingsFile","url":"interfaces/_zowe_imperative.isettingsfile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":747,"kind":1024,"name":"overrides","url":"interfaces/_zowe_imperative.isettingsfile.html#overrides","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISettingsFile"},{"id":748,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.isettingsfile.html#overrides.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.ISettingsFile.overrides"},{"id":749,"kind":128,"name":"CredentialManagerOverride","url":"classes/_zowe_imperative.credentialmanageroverride.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":750,"kind":1024,"name":"CRED_MGR_SETTING_NAME","url":"classes/_zowe_imperative.credentialmanageroverride.html#cred_mgr_setting_name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CredentialManagerOverride"},{"id":751,"kind":1024,"name":"DEFAULT_CRED_MGR_NAME","url":"classes/_zowe_imperative.credentialmanageroverride.html#default_cred_mgr_name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CredentialManagerOverride"},{"id":752,"kind":1024,"name":"KNOWN_CRED_MGRS","url":"classes/_zowe_imperative.credentialmanageroverride.html#known_cred_mgrs","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CredentialManagerOverride"},{"id":753,"kind":2048,"name":"getCredMgrInfoByDisplayName","url":"classes/_zowe_imperative.credentialmanageroverride.html#getcredmgrinfobydisplayname","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CredentialManagerOverride"},{"id":754,"kind":2048,"name":"getCredMgrInfoByPlugin","url":"classes/_zowe_imperative.credentialmanageroverride.html#getcredmgrinfobyplugin","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CredentialManagerOverride"},{"id":755,"kind":2048,"name":"getCredMgrInfoByZEExt","url":"classes/_zowe_imperative.credentialmanageroverride.html#getcredmgrinfobyzeext","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CredentialManagerOverride"},{"id":756,"kind":2048,"name":"getKnownCredMgrs","url":"classes/_zowe_imperative.credentialmanageroverride.html#getknowncredmgrs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CredentialManagerOverride"},{"id":757,"kind":2048,"name":"recordCredMgrInConfig","url":"classes/_zowe_imperative.credentialmanageroverride.html#recordcredmgrinconfig","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CredentialManagerOverride"},{"id":758,"kind":2048,"name":"recordDefaultCredMgrInConfig","url":"classes/_zowe_imperative.credentialmanageroverride.html#recorddefaultcredmgrinconfig","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CredentialManagerOverride"},{"id":759,"kind":2048,"name":"getSettingsFileJson","url":"classes/_zowe_imperative.credentialmanageroverride.html#getsettingsfilejson","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CredentialManagerOverride"},{"id":760,"kind":4194304,"name":"ICredentialManagerConstructor","url":"modules/_zowe_imperative.html#icredentialmanagerconstructor","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":761,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#icredentialmanagerconstructor.__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.ICredentialManagerConstructor"},{"id":762,"kind":128,"name":"ConfigUtils","url":"classes/_zowe_imperative.configutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":763,"kind":2048,"name":"coercePropValue","url":"classes/_zowe_imperative.configutils.html#coercepropvalue","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigUtils"},{"id":764,"kind":2048,"name":"getActiveProfileName","url":"classes/_zowe_imperative.configutils.html#getactiveprofilename","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigUtils"},{"id":765,"kind":2048,"name":"jsonPathMatches","url":"classes/_zowe_imperative.configutils.html#jsonpathmatches","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigUtils"},{"id":766,"kind":2048,"name":"secureSaveError","url":"classes/_zowe_imperative.configutils.html#securesaveerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigUtils"},{"id":767,"kind":128,"name":"ConfigSecure","url":"classes/_zowe_imperative.configsecure.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":768,"kind":1024,"name":"mLoadFailed","url":"classes/_zowe_imperative.configsecure.html#mloadfailed","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ConfigSecure"},{"id":769,"kind":2048,"name":"load","url":"classes/_zowe_imperative.configsecure.html#load","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigSecure"},{"id":770,"kind":2048,"name":"loadCached","url":"classes/_zowe_imperative.configsecure.html#loadcached","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigSecure"},{"id":771,"kind":2048,"name":"save","url":"classes/_zowe_imperative.configsecure.html#save","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigSecure"},{"id":772,"kind":2048,"name":"directSave","url":"classes/_zowe_imperative.configsecure.html#directsave","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigSecure"},{"id":773,"kind":2048,"name":"cacheAndPrune","url":"classes/_zowe_imperative.configsecure.html#cacheandprune","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigSecure"},{"id":774,"kind":2048,"name":"secureFields","url":"classes/_zowe_imperative.configsecure.html#securefields","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigSecure"},{"id":775,"kind":2048,"name":"securePropsForProfile","url":"classes/_zowe_imperative.configsecure.html#securepropsforprofile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigSecure"},{"id":776,"kind":2048,"name":"findSecure","url":"classes/_zowe_imperative.configsecure.html#findsecure","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigSecure"},{"id":777,"kind":2048,"name":"secureInfoForProp","url":"classes/_zowe_imperative.configsecure.html#secureinfoforprop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigSecure"},{"id":778,"kind":2048,"name":"rmUnusedProps","url":"classes/_zowe_imperative.configsecure.html#rmunusedprops","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigSecure"},{"id":779,"kind":262144,"name":"loadFailed","url":"classes/_zowe_imperative.configsecure.html#loadfailed","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ConfigSecure"},{"id":780,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.configsecure.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ConfigSecure"},{"id":781,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.configsecure.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ConfigSecure"},{"id":782,"kind":256,"name":"IConfigSchema","url":"interfaces/_zowe_imperative.iconfigschema.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":783,"kind":1024,"name":"$schema","url":"interfaces/_zowe_imperative.iconfigschema.html#_schema","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigSchema"},{"id":784,"kind":1024,"name":"$version","url":"interfaces/_zowe_imperative.iconfigschema.html#_version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigSchema"},{"id":785,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.iconfigschema.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigSchema"},{"id":786,"kind":1024,"name":"description","url":"interfaces/_zowe_imperative.iconfigschema.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigSchema"},{"id":787,"kind":1024,"name":"properties","url":"interfaces/_zowe_imperative.iconfigschema.html#properties","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigSchema"},{"id":788,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iconfigschema.html#properties.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IConfigSchema.properties"},{"id":789,"kind":256,"name":"IConfigSchemaInfo","url":"interfaces/_zowe_imperative.iconfigschemainfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":790,"kind":1024,"name":"original","url":"interfaces/_zowe_imperative.iconfigschemainfo.html#original","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigSchemaInfo"},{"id":791,"kind":1024,"name":"resolved","url":"interfaces/_zowe_imperative.iconfigschemainfo.html#resolved","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigSchemaInfo"},{"id":792,"kind":1024,"name":"local","url":"interfaces/_zowe_imperative.iconfigschemainfo.html#local","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigSchemaInfo"},{"id":793,"kind":256,"name":"IConfigUpdateSchemaPaths","url":"interfaces/_zowe_imperative.iconfigupdateschemapaths.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":794,"kind":256,"name":"IConfigUpdateSchemaOptions","url":"interfaces/_zowe_imperative.iconfigupdateschemaoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":795,"kind":1024,"name":"layer","url":"interfaces/_zowe_imperative.iconfigupdateschemaoptions.html#layer","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigUpdateSchemaOptions"},{"id":796,"kind":1024,"name":"schema","url":"interfaces/_zowe_imperative.iconfigupdateschemaoptions.html#schema","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigUpdateSchemaOptions"},{"id":797,"kind":1024,"name":"depth","url":"interfaces/_zowe_imperative.iconfigupdateschemaoptions.html#depth","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigUpdateSchemaOptions"},{"id":798,"kind":256,"name":"IConfigUpdateSchemaHelperOptions","url":"interfaces/_zowe_imperative.iconfigupdateschemahelperoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":799,"kind":1024,"name":"layer","url":"interfaces/_zowe_imperative.iconfigupdateschemahelperoptions.html#layer","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigUpdateSchemaHelperOptions"},{"id":800,"kind":1024,"name":"config","url":"interfaces/_zowe_imperative.iconfigupdateschemahelperoptions.html#config","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigUpdateSchemaHelperOptions"},{"id":801,"kind":1024,"name":"updatedPaths","url":"interfaces/_zowe_imperative.iconfigupdateschemahelperoptions.html#updatedpaths","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigUpdateSchemaHelperOptions"},{"id":802,"kind":1024,"name":"updateOptions","url":"interfaces/_zowe_imperative.iconfigupdateschemahelperoptions.html#updateoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigUpdateSchemaHelperOptions"},{"id":803,"kind":128,"name":"JsUtils","url":"classes/_zowe_imperative.jsutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":804,"kind":2048,"name":"isObjEmpty","url":"classes/_zowe_imperative.jsutils.html#isobjempty","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.JsUtils"},{"id":805,"kind":2048,"name":"isUrl","url":"classes/_zowe_imperative.jsutils.html#isurl","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.JsUtils"},{"id":806,"kind":256,"name":"IConfigMergeOpts","url":"interfaces/_zowe_imperative.iconfigmergeopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":807,"kind":1024,"name":"maskSecure","url":"interfaces/_zowe_imperative.iconfigmergeopts.html#masksecure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigMergeOpts"},{"id":808,"kind":1024,"name":"excludeGlobalLayer","url":"interfaces/_zowe_imperative.iconfigmergeopts.html#excludegloballayer","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigMergeOpts"},{"id":809,"kind":1024,"name":"cloneLayers","url":"interfaces/_zowe_imperative.iconfigmergeopts.html#clonelayers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigMergeOpts"},{"id":810,"kind":128,"name":"Config","url":"classes/_zowe_imperative.config.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":811,"kind":1024,"name":"END_OF_TEAM_CONFIG","url":"classes/_zowe_imperative.config.html#end_of_team_config","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Config"},{"id":812,"kind":1024,"name":"END_OF_USER_CONFIG","url":"classes/_zowe_imperative.config.html#end_of_user_config","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Config"},{"id":813,"kind":1024,"name":"mApp","url":"classes/_zowe_imperative.config.html#mapp","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":814,"kind":1024,"name":"mLayers","url":"classes/_zowe_imperative.config.html#mlayers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":815,"kind":1024,"name":"mHomeDir","url":"classes/_zowe_imperative.config.html#mhomedir","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":816,"kind":1024,"name":"mProjectDir","url":"classes/_zowe_imperative.config.html#mprojectdir","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":817,"kind":1024,"name":"mActive","url":"classes/_zowe_imperative.config.html#mactive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":818,"kind":65536,"name":"__type","url":"classes/_zowe_imperative.config.html#mactive.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.Config.mActive"},{"id":819,"kind":32,"name":"user","url":"classes/_zowe_imperative.config.html#mactive.__type.user","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/imperative.Config.mActive.__type"},{"id":820,"kind":32,"name":"global","url":"classes/_zowe_imperative.config.html#mactive.__type.global","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/imperative.Config.mActive.__type"},{"id":821,"kind":1024,"name":"mVault","url":"classes/_zowe_imperative.config.html#mvault","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":822,"kind":1024,"name":"mSecure","url":"classes/_zowe_imperative.config.html#msecure","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":823,"kind":1024,"name":"mApi","url":"classes/_zowe_imperative.config.html#mapi","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Config"},{"id":824,"kind":65536,"name":"__type","url":"classes/_zowe_imperative.config.html#mapi.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.Config.mApi"},{"id":825,"kind":32,"name":"profiles","url":"classes/_zowe_imperative.config.html#mapi.__type-1.profiles","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/imperative.Config.mApi.__type"},{"id":826,"kind":32,"name":"plugins","url":"classes/_zowe_imperative.config.html#mapi.__type-1.plugins","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/imperative.Config.mApi.__type"},{"id":827,"kind":32,"name":"layers","url":"classes/_zowe_imperative.config.html#mapi.__type-1.layers","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/imperative.Config.mApi.__type"},{"id":828,"kind":32,"name":"secure","url":"classes/_zowe_imperative.config.html#mapi.__type-1.secure","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/imperative.Config.mApi.__type"},{"id":829,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.config.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Config"},{"id":830,"kind":1024,"name":"opts","url":"classes/_zowe_imperative.config.html#opts","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":831,"kind":2048,"name":"empty","url":"classes/_zowe_imperative.config.html#empty","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Config"},{"id":832,"kind":2048,"name":"load","url":"classes/_zowe_imperative.config.html#load","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Config"},{"id":833,"kind":2048,"name":"reload","url":"classes/_zowe_imperative.config.html#reload","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":834,"kind":2048,"name":"save","url":"classes/_zowe_imperative.config.html#save","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":835,"kind":2048,"name":"layerPath","url":"classes/_zowe_imperative.config.html#layerpath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Config"},{"id":836,"kind":262144,"name":"api","url":"classes/_zowe_imperative.config.html#api","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":837,"kind":262144,"name":"exists","url":"classes/_zowe_imperative.config.html#exists","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":838,"kind":262144,"name":"paths","url":"classes/_zowe_imperative.config.html#paths","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":839,"kind":262144,"name":"layers","url":"classes/_zowe_imperative.config.html#layers-1","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":840,"kind":262144,"name":"properties","url":"classes/_zowe_imperative.config.html#properties","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":841,"kind":262144,"name":"mProperties","url":"classes/_zowe_imperative.config.html#mproperties","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":842,"kind":262144,"name":"appName","url":"classes/_zowe_imperative.config.html#appname","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":843,"kind":262144,"name":"configName","url":"classes/_zowe_imperative.config.html#configname","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":844,"kind":262144,"name":"userConfigName","url":"classes/_zowe_imperative.config.html#userconfigname","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":845,"kind":262144,"name":"schemaName","url":"classes/_zowe_imperative.config.html#schemaname","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":846,"kind":2048,"name":"getSchemaInfo","url":"classes/_zowe_imperative.config.html#getschemainfo","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":847,"kind":2048,"name":"search","url":"classes/_zowe_imperative.config.html#search","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Config"},{"id":848,"kind":262144,"name":"maskedProperties","url":"classes/_zowe_imperative.config.html#maskedproperties","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":849,"kind":2048,"name":"set","url":"classes/_zowe_imperative.config.html#set","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":850,"kind":2048,"name":"delete","url":"classes/_zowe_imperative.config.html#delete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":851,"kind":2048,"name":"setSchema","url":"classes/_zowe_imperative.config.html#setschema","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":852,"kind":2048,"name":"layerMerge","url":"classes/_zowe_imperative.config.html#layermerge","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":853,"kind":2048,"name":"layerProfiles","url":"classes/_zowe_imperative.config.html#layerprofiles","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":854,"kind":2048,"name":"findLayer","url":"classes/_zowe_imperative.config.html#findlayer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":855,"kind":2048,"name":"layerActive","url":"classes/_zowe_imperative.config.html#layeractive","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":856,"kind":2048,"name":"layerExists","url":"classes/_zowe_imperative.config.html#layerexists","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":857,"kind":2048,"name":"formMainConfigPathNm","url":"classes/_zowe_imperative.config.html#formmainconfigpathnm","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Config"},{"id":858,"kind":256,"name":"ICommandExampleDefinition","url":"interfaces/_zowe_imperative.icommandexampledefinition.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":859,"kind":1024,"name":"options","url":"interfaces/_zowe_imperative.icommandexampledefinition.html#options","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandExampleDefinition"},{"id":860,"kind":1024,"name":"description","url":"interfaces/_zowe_imperative.icommandexampledefinition.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandExampleDefinition"},{"id":861,"kind":1024,"name":"prefix","url":"interfaces/_zowe_imperative.icommandexampledefinition.html#prefix","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandExampleDefinition"},{"id":862,"kind":256,"name":"ICommandOptionAllowableValues","url":"interfaces/_zowe_imperative.icommandoptionallowablevalues.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":863,"kind":1024,"name":"values","url":"interfaces/_zowe_imperative.icommandoptionallowablevalues.html#values","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionAllowableValues"},{"id":864,"kind":1024,"name":"caseSensitive","url":"interfaces/_zowe_imperative.icommandoptionallowablevalues.html#casesensitive","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionAllowableValues"},{"id":865,"kind":256,"name":"ICommandOptionValueImplications","url":"interfaces/_zowe_imperative.icommandoptionvalueimplications.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":866,"kind":1024,"name":"impliedOptionNames","url":"interfaces/_zowe_imperative.icommandoptionvalueimplications.html#impliedoptionnames","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionValueImplications"},{"id":867,"kind":1024,"name":"isCaseSensitive","url":"interfaces/_zowe_imperative.icommandoptionvalueimplications.html#iscasesensitive","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionValueImplications"},{"id":868,"kind":256,"name":"ICommandOptionDefinition","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":869,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":870,"kind":1024,"name":"aliases","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#aliases","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":871,"kind":1024,"name":"description","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":872,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":873,"kind":1024,"name":"hidden","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#hidden","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":874,"kind":1024,"name":"defaultValue","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#defaultvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":875,"kind":1024,"name":"group","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#group","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":876,"kind":1024,"name":"required","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#required","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":877,"kind":1024,"name":"conflictsWith","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#conflictswith","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":878,"kind":1024,"name":"implies","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#implies","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":879,"kind":1024,"name":"impliesOneOf","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#impliesoneof","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":880,"kind":1024,"name":"absenceImplications","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#absenceimplications","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":881,"kind":1024,"name":"allowableValues","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#allowablevalues","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":882,"kind":1024,"name":"numericValueRange","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#numericvaluerange","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":883,"kind":1024,"name":"stringLengthRange","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#stringlengthrange","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":884,"kind":1024,"name":"arrayAllowDuplicate","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#arrayallowduplicate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":885,"kind":1024,"name":"valueImplications","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#valueimplications","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOptionDefinition"},{"id":886,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.icommandoptiondefinition.html#valueimplications.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.ICommandOptionDefinition.valueImplications"},{"id":887,"kind":4194304,"name":"CommandOptionType","url":"modules/_zowe_imperative.html#commandoptiontype","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":888,"kind":256,"name":"ICommandPositionalDefinition","url":"interfaces/_zowe_imperative.icommandpositionaldefinition.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":889,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.icommandpositionaldefinition.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandPositionalDefinition"},{"id":890,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.icommandpositionaldefinition.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandPositionalDefinition"},{"id":891,"kind":1024,"name":"description","url":"interfaces/_zowe_imperative.icommandpositionaldefinition.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandPositionalDefinition"},{"id":892,"kind":1024,"name":"required","url":"interfaces/_zowe_imperative.icommandpositionaldefinition.html#required","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandPositionalDefinition"},{"id":893,"kind":1024,"name":"regex","url":"interfaces/_zowe_imperative.icommandpositionaldefinition.html#regex","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandPositionalDefinition"},{"id":894,"kind":1024,"name":"stringLengthRange","url":"interfaces/_zowe_imperative.icommandpositionaldefinition.html#stringlengthrange","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandPositionalDefinition"},{"id":895,"kind":256,"name":"ICommandDefinitionPassOnIgnore","url":"interfaces/_zowe_imperative.icommanddefinitionpassonignore.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":896,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.icommanddefinitionpassonignore.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinitionPassOnIgnore"},{"id":897,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.icommanddefinitionpassonignore.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinitionPassOnIgnore"},{"id":898,"kind":256,"name":"ICommandDefinitionPassOn","url":"interfaces/_zowe_imperative.icommanddefinitionpasson.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":899,"kind":1024,"name":"property","url":"interfaces/_zowe_imperative.icommanddefinitionpasson.html#property","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinitionPassOn"},{"id":900,"kind":1024,"name":"value","url":"interfaces/_zowe_imperative.icommanddefinitionpasson.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinitionPassOn"},{"id":901,"kind":1024,"name":"ignoreNodes","url":"interfaces/_zowe_imperative.icommanddefinitionpasson.html#ignorenodes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinitionPassOn"},{"id":902,"kind":1024,"name":"merge","url":"interfaces/_zowe_imperative.icommanddefinitionpasson.html#merge","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinitionPassOn"},{"id":903,"kind":256,"name":"ICommandProfile","url":"interfaces/_zowe_imperative.icommandprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":904,"kind":1024,"name":"required","url":"interfaces/_zowe_imperative.icommandprofile.html#required","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfile"},{"id":905,"kind":1024,"name":"optional","url":"interfaces/_zowe_imperative.icommandprofile.html#optional","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfile"},{"id":906,"kind":1024,"name":"suppressOptions","url":"interfaces/_zowe_imperative.icommandprofile.html#suppressoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfile"},{"id":907,"kind":256,"name":"ICommandDefinition","url":"interfaces/_zowe_imperative.icommanddefinition.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":908,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.icommanddefinition.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":909,"kind":1024,"name":"description","url":"interfaces/_zowe_imperative.icommanddefinition.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":910,"kind":1024,"name":"summary","url":"interfaces/_zowe_imperative.icommanddefinition.html#summary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":911,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.icommanddefinition.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":912,"kind":1024,"name":"passOn","url":"interfaces/_zowe_imperative.icommanddefinition.html#passon","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":913,"kind":1024,"name":"aliases","url":"interfaces/_zowe_imperative.icommanddefinition.html#aliases","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":914,"kind":1024,"name":"enableStdin","url":"interfaces/_zowe_imperative.icommanddefinition.html#enablestdin","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":915,"kind":1024,"name":"stdinOptionDescription","url":"interfaces/_zowe_imperative.icommanddefinition.html#stdinoptiondescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":916,"kind":1024,"name":"deprecatedReplacement","url":"interfaces/_zowe_imperative.icommanddefinition.html#deprecatedreplacement","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":917,"kind":1024,"name":"examples","url":"interfaces/_zowe_imperative.icommanddefinition.html#examples","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":918,"kind":1024,"name":"handler","url":"interfaces/_zowe_imperative.icommanddefinition.html#handler","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":919,"kind":1024,"name":"chainedHandlers","url":"interfaces/_zowe_imperative.icommanddefinition.html#chainedhandlers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":920,"kind":1024,"name":"children","url":"interfaces/_zowe_imperative.icommanddefinition.html#children","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":921,"kind":1024,"name":"options","url":"interfaces/_zowe_imperative.icommanddefinition.html#options","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":922,"kind":1024,"name":"positionals","url":"interfaces/_zowe_imperative.icommanddefinition.html#positionals","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":923,"kind":1024,"name":"mustSpecifyOne","url":"interfaces/_zowe_imperative.icommanddefinition.html#mustspecifyone","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":924,"kind":1024,"name":"onlyOneOf","url":"interfaces/_zowe_imperative.icommanddefinition.html#onlyoneof","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":925,"kind":1024,"name":"profile","url":"interfaces/_zowe_imperative.icommanddefinition.html#profile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":926,"kind":1024,"name":"customize","url":"interfaces/_zowe_imperative.icommanddefinition.html#customize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":927,"kind":1024,"name":"experimental","url":"interfaces/_zowe_imperative.icommanddefinition.html#experimental","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":928,"kind":1024,"name":"outputFormatOptions","url":"interfaces/_zowe_imperative.icommanddefinition.html#outputformatoptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandDefinition"},{"id":929,"kind":4194304,"name":"ICommandNodeType","url":"modules/_zowe_imperative.html#icommandnodetype","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":930,"kind":64,"name":"compareCommands","url":"modules/_zowe_imperative.html#comparecommands","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":931,"kind":128,"name":"CommandProfiles","url":"classes/_zowe_imperative.commandprofiles.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":932,"kind":1024,"name":"mMap","url":"classes/_zowe_imperative.commandprofiles.html#mmap","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfiles"},{"id":933,"kind":1024,"name":"mMetaMap","url":"classes/_zowe_imperative.commandprofiles.html#mmetamap","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfiles"},{"id":934,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.commandprofiles.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.CommandProfiles"},{"id":935,"kind":2048,"name":"getMeta","url":"classes/_zowe_imperative.commandprofiles.html#getmeta","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"@zowe/imperative.CommandProfiles"},{"id":936,"kind":2048,"name":"get","url":"classes/_zowe_imperative.commandprofiles.html#get","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"@zowe/imperative.CommandProfiles"},{"id":937,"kind":2048,"name":"getAll","url":"classes/_zowe_imperative.commandprofiles.html#getall","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"@zowe/imperative.CommandProfiles"},{"id":938,"kind":2048,"name":"addMeta","url":"classes/_zowe_imperative.commandprofiles.html#addmeta","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfiles"},{"id":939,"kind":262144,"name":"map","url":"classes/_zowe_imperative.commandprofiles.html#map","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfiles"},{"id":940,"kind":262144,"name":"metaMap","url":"classes/_zowe_imperative.commandprofiles.html#metamap","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfiles"},{"id":941,"kind":2048,"name":"fail","url":"classes/_zowe_imperative.commandprofiles.html#fail","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfiles"},{"id":942,"kind":256,"name":"IPromptOptions","url":"interfaces/_zowe_imperative.ipromptoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":943,"kind":1024,"name":"hideText","url":"interfaces/_zowe_imperative.ipromptoptions.html#hidetext","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPromptOptions"},{"id":944,"kind":1024,"name":"secToWait","url":"interfaces/_zowe_imperative.ipromptoptions.html#sectowait","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPromptOptions"},{"id":945,"kind":1024,"name":"maskChar","url":"interfaces/_zowe_imperative.ipromptoptions.html#maskchar","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPromptOptions"},{"id":946,"kind":256,"name":"IHandlerResponseConsoleApi","url":"interfaces/_zowe_imperative.ihandlerresponseconsoleapi.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":947,"kind":2048,"name":"log","url":"interfaces/_zowe_imperative.ihandlerresponseconsoleapi.html#log","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerResponseConsoleApi"},{"id":948,"kind":2048,"name":"error","url":"interfaces/_zowe_imperative.ihandlerresponseconsoleapi.html#error","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerResponseConsoleApi"},{"id":949,"kind":2048,"name":"errorHeader","url":"interfaces/_zowe_imperative.ihandlerresponseconsoleapi.html#errorheader","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerResponseConsoleApi"},{"id":950,"kind":2048,"name":"prompt","url":"interfaces/_zowe_imperative.ihandlerresponseconsoleapi.html#prompt","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerResponseConsoleApi"},{"id":951,"kind":256,"name":"IHandlerResponseDataApi","url":"interfaces/_zowe_imperative.ihandlerresponsedataapi.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":952,"kind":2048,"name":"setObj","url":"interfaces/_zowe_imperative.ihandlerresponsedataapi.html#setobj","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerResponseDataApi"},{"id":953,"kind":2048,"name":"setMessage","url":"interfaces/_zowe_imperative.ihandlerresponsedataapi.html#setmessage","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerResponseDataApi"},{"id":954,"kind":2048,"name":"setExitCode","url":"interfaces/_zowe_imperative.ihandlerresponsedataapi.html#setexitcode","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerResponseDataApi"},{"id":955,"kind":4,"name":"TaskStage","url":"enums/_zowe_imperative.taskstage.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":956,"kind":16,"name":"IN_PROGRESS","url":"enums/_zowe_imperative.taskstage.html#in_progress","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.TaskStage"},{"id":957,"kind":16,"name":"COMPLETE","url":"enums/_zowe_imperative.taskstage.html#complete","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.TaskStage"},{"id":958,"kind":16,"name":"NOT_STARTED","url":"enums/_zowe_imperative.taskstage.html#not_started","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.TaskStage"},{"id":959,"kind":16,"name":"FAILED","url":"enums/_zowe_imperative.taskstage.html#failed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.TaskStage"},{"id":960,"kind":256,"name":"ITaskWithStatus","url":"interfaces/_zowe_imperative.itaskwithstatus.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":961,"kind":1024,"name":"percentComplete","url":"interfaces/_zowe_imperative.itaskwithstatus.html#percentcomplete","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ITaskWithStatus"},{"id":962,"kind":1024,"name":"statusMessage","url":"interfaces/_zowe_imperative.itaskwithstatus.html#statusmessage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ITaskWithStatus"},{"id":963,"kind":1024,"name":"stageName","url":"interfaces/_zowe_imperative.itaskwithstatus.html#stagename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ITaskWithStatus"},{"id":964,"kind":256,"name":"IPromiseWithProgress","url":"interfaces/_zowe_imperative.ipromisewithprogress.html","classes":"tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":965,"kind":1024,"name":"progress","url":"interfaces/_zowe_imperative.ipromisewithprogress.html#progress","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPromiseWithProgress"},{"id":966,"kind":2048,"name":"then","url":"interfaces/_zowe_imperative.ipromisewithprogress.html#then","classes":"tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited","parent":"@zowe/imperative.IPromiseWithProgress"},{"id":967,"kind":2048,"name":"catch","url":"interfaces/_zowe_imperative.ipromisewithprogress.html#catch","classes":"tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited","parent":"@zowe/imperative.IPromiseWithProgress"},{"id":968,"kind":1024,"name":"Promise","url":"interfaces/_zowe_imperative.ipromisewithprogress.html#promise","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPromiseWithProgress"},{"id":969,"kind":1024,"name":"[Symbol.toStringTag]","url":"interfaces/_zowe_imperative.ipromisewithprogress.html#_symbol_tostringtag_","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IPromiseWithProgress"},{"id":970,"kind":2048,"name":"finally","url":"interfaces/_zowe_imperative.ipromisewithprogress.html#finally","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IPromiseWithProgress"},{"id":971,"kind":128,"name":"TaskProgress","url":"classes/_zowe_imperative.taskprogress.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":972,"kind":1024,"name":"ZERO_PERCENT","url":"classes/_zowe_imperative.taskprogress.html#zero_percent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TaskProgress"},{"id":973,"kind":1024,"name":"TEN_PERCENT","url":"classes/_zowe_imperative.taskprogress.html#ten_percent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TaskProgress"},{"id":974,"kind":1024,"name":"TWENTY_PERCENT","url":"classes/_zowe_imperative.taskprogress.html#twenty_percent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TaskProgress"},{"id":975,"kind":1024,"name":"THIRTY_PERCENT","url":"classes/_zowe_imperative.taskprogress.html#thirty_percent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TaskProgress"},{"id":976,"kind":1024,"name":"FOURTY_PERCENT","url":"classes/_zowe_imperative.taskprogress.html#fourty_percent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TaskProgress"},{"id":977,"kind":1024,"name":"FIFTY_PERCENT","url":"classes/_zowe_imperative.taskprogress.html#fifty_percent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TaskProgress"},{"id":978,"kind":1024,"name":"SIXTY_PERCENT","url":"classes/_zowe_imperative.taskprogress.html#sixty_percent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TaskProgress"},{"id":979,"kind":1024,"name":"SEVENTY_PERCENT","url":"classes/_zowe_imperative.taskprogress.html#seventy_percent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TaskProgress"},{"id":980,"kind":1024,"name":"EIGHTY_PERCENT","url":"classes/_zowe_imperative.taskprogress.html#eighty_percent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TaskProgress"},{"id":981,"kind":1024,"name":"NINETY_PERCENT","url":"classes/_zowe_imperative.taskprogress.html#ninety_percent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TaskProgress"},{"id":982,"kind":1024,"name":"ONE_HUNDRED_PERCENT","url":"classes/_zowe_imperative.taskprogress.html#one_hundred_percent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.TaskProgress"},{"id":983,"kind":128,"name":"Operation","url":"classes/_zowe_imperative.operation.html","classes":"tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":984,"kind":1024,"name":"NO_PARMS","url":"classes/_zowe_imperative.operation.html#no_parms","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Operation"},{"id":985,"kind":1024,"name":"NO_OUTPUT","url":"classes/_zowe_imperative.operation.html#no_output","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Operation"},{"id":986,"kind":2048,"name":"summarizeResults","url":"classes/_zowe_imperative.operation.html#summarizeresults","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Operation"},{"id":987,"kind":1024,"name":"outputSeparator","url":"classes/_zowe_imperative.operation.html#outputseparator","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Operation"},{"id":988,"kind":1024,"name":"infoMessages","url":"classes/_zowe_imperative.operation.html#infomessages","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":989,"kind":1024,"name":"errorMessages","url":"classes/_zowe_imperative.operation.html#errormessages","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":990,"kind":262144,"name":"statusMessage","url":"classes/_zowe_imperative.operation.html#statusmessage","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":991,"kind":262144,"name":"percentComplete","url":"classes/_zowe_imperative.operation.html#percentcomplete","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":992,"kind":262144,"name":"totalOperations","url":"classes/_zowe_imperative.operation.html#totaloperations","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":993,"kind":1024,"name":"log","url":"classes/_zowe_imperative.operation.html#log","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":994,"kind":1024,"name":"mOperationResults","url":"classes/_zowe_imperative.operation.html#moperationresults","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":995,"kind":1024,"name":"mOperationResult","url":"classes/_zowe_imperative.operation.html#moperationresult","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":996,"kind":1024,"name":"mStageName","url":"classes/_zowe_imperative.operation.html#mstagename","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operation"},{"id":997,"kind":1024,"name":"mStatusMessage","url":"classes/_zowe_imperative.operation.html#mstatusmessage","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operation"},{"id":998,"kind":1024,"name":"mPercentComplete","url":"classes/_zowe_imperative.operation.html#mpercentcomplete","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operation"},{"id":999,"kind":1024,"name":"mOperationCompleteCallback","url":"classes/_zowe_imperative.operation.html#moperationcompletecallback","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operation"},{"id":1000,"kind":1024,"name":"mAllFilesCreated","url":"classes/_zowe_imperative.operation.html#mallfilescreated","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operation"},{"id":1001,"kind":1024,"name":"mFilesForUndo","url":"classes/_zowe_imperative.operation.html#mfilesforundo","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operation"},{"id":1002,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.operation.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":1003,"kind":2048,"name":"executeOperation","url":"classes/_zowe_imperative.operation.html#executeoperation","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":1004,"kind":2048,"name":"setStatusMessage","url":"classes/_zowe_imperative.operation.html#setstatusmessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":1005,"kind":2048,"name":"performUndo","url":"classes/_zowe_imperative.operation.html#performundo","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":1006,"kind":2048,"name":"logOperationResults","url":"classes/_zowe_imperative.operation.html#logoperationresults","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":1007,"kind":262144,"name":"operationResult","url":"classes/_zowe_imperative.operation.html#operationresult","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":1008,"kind":262144,"name":"stageName","url":"classes/_zowe_imperative.operation.html#stagename","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":1009,"kind":262144,"name":"allFilesCreated","url":"classes/_zowe_imperative.operation.html#allfilescreated","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":1010,"kind":262144,"name":"fileToUndo","url":"classes/_zowe_imperative.operation.html#filetoundo","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":1011,"kind":262144,"name":"operationName","url":"classes/_zowe_imperative.operation.html#operationname","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":1012,"kind":2048,"name":"setOperationFailed","url":"classes/_zowe_imperative.operation.html#setoperationfailed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":1013,"kind":2048,"name":"setOperationUndoable","url":"classes/_zowe_imperative.operation.html#setoperationundoable","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":1014,"kind":262144,"name":"operationResultMessage","url":"classes/_zowe_imperative.operation.html#operationresultmessage","classes":"tsd-kind-set-signature tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":1015,"kind":262144,"name":"operationSucceeded","url":"classes/_zowe_imperative.operation.html#operationsucceeded","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.Operation"},{"id":1016,"kind":2048,"name":"setOperationUndoFailed","url":"classes/_zowe_imperative.operation.html#setoperationundofailed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":1017,"kind":2048,"name":"setOperationDiverge","url":"classes/_zowe_imperative.operation.html#setoperationdiverge","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":1018,"kind":2048,"name":"setOperationUndoAttempted","url":"classes/_zowe_imperative.operation.html#setoperationundoattempted","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":1019,"kind":2048,"name":"execute","url":"classes/_zowe_imperative.operation.html#execute","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":1020,"kind":2048,"name":"undo","url":"classes/_zowe_imperative.operation.html#undo","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":1021,"kind":2048,"name":"logOperationBeginMessages","url":"classes/_zowe_imperative.operation.html#logoperationbeginmessages","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":1022,"kind":2048,"name":"addResult","url":"classes/_zowe_imperative.operation.html#addresult","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":1023,"kind":2048,"name":"createFile","url":"classes/_zowe_imperative.operation.html#createfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":1024,"kind":2048,"name":"printFilesCreatedList","url":"classes/_zowe_imperative.operation.html#printfilescreatedlist","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":1025,"kind":2048,"name":"addFileCreated","url":"classes/_zowe_imperative.operation.html#addfilecreated","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operation"},{"id":1026,"kind":2048,"name":"deleteAllFilesMarkedForUndo","url":"classes/_zowe_imperative.operation.html#deleteallfilesmarkedforundo","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operation"},{"id":1027,"kind":2048,"name":"logBeginMessage","url":"classes/_zowe_imperative.operation.html#logbeginmessage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operation"},{"id":1028,"kind":2048,"name":"logEndMessage","url":"classes/_zowe_imperative.operation.html#logendmessage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operation"},{"id":1029,"kind":2048,"name":"operationComplete","url":"classes/_zowe_imperative.operation.html#operationcomplete","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operation"},{"id":1030,"kind":2048,"name":"undoComplete","url":"classes/_zowe_imperative.operation.html#undocomplete","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operation"},{"id":1031,"kind":4194304,"name":"IOperationCompleted","url":"modules/_zowe_imperative.html#ioperationcompleted","classes":"tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":1032,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#ioperationcompleted.__type-8","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.IOperationCompleted"},{"id":1033,"kind":4194304,"name":"IOperationUndoCompleted","url":"modules/_zowe_imperative.html#ioperationundocompleted","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1034,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#ioperationundocompleted.__type-10","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.IOperationUndoCompleted"},{"id":1035,"kind":4194304,"name":"IOperationResultReady","url":"modules/_zowe_imperative.html#ioperationresultready","classes":"tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":1036,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#ioperationresultready.__type-9","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.IOperationResultReady"},{"id":1037,"kind":256,"name":"IOperationResult","url":"interfaces/_zowe_imperative.ioperationresult.html","classes":"tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":1038,"kind":1024,"name":"operationName","url":"interfaces/_zowe_imperative.ioperationresult.html#operationname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1039,"kind":1024,"name":"resultMessage","url":"interfaces/_zowe_imperative.ioperationresult.html#resultmessage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1040,"kind":1024,"name":"operationFailed","url":"interfaces/_zowe_imperative.ioperationresult.html#operationfailed","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1041,"kind":1024,"name":"diverge","url":"interfaces/_zowe_imperative.ioperationresult.html#diverge","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1042,"kind":1024,"name":"divergeTo","url":"interfaces/_zowe_imperative.ioperationresult.html#divergeto","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1043,"kind":1024,"name":"continuePath","url":"interfaces/_zowe_imperative.ioperationresult.html#continuepath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1044,"kind":1024,"name":"nextOperationResult","url":"interfaces/_zowe_imperative.ioperationresult.html#nextoperationresult","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1045,"kind":1024,"name":"operationObject","url":"interfaces/_zowe_imperative.ioperationresult.html#operationobject","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1046,"kind":1024,"name":"operationUndoPossible","url":"interfaces/_zowe_imperative.ioperationresult.html#operationundopossible","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1047,"kind":1024,"name":"operationUndoFailed","url":"interfaces/_zowe_imperative.ioperationresult.html#operationundofailed","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1048,"kind":1024,"name":"operationUndoAttempted","url":"interfaces/_zowe_imperative.ioperationresult.html#operationundoattempted","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1049,"kind":1024,"name":"critical","url":"interfaces/_zowe_imperative.ioperationresult.html#critical","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1050,"kind":1024,"name":"infoMessages","url":"interfaces/_zowe_imperative.ioperationresult.html#infomessages","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1051,"kind":1024,"name":"errorMessages","url":"interfaces/_zowe_imperative.ioperationresult.html#errormessages","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1052,"kind":1024,"name":"output","url":"interfaces/_zowe_imperative.ioperationresult.html#output","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOperationResult"},{"id":1053,"kind":128,"name":"Operations","url":"classes/_zowe_imperative.operations.html","classes":"tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":1054,"kind":1024,"name":"mOperationList","url":"classes/_zowe_imperative.operations.html#moperationlist","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operations"},{"id":1055,"kind":1024,"name":"mOverallStatusMessage","url":"classes/_zowe_imperative.operations.html#moverallstatusmessage","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operations"},{"id":1056,"kind":1024,"name":"mCurrentOperation","url":"classes/_zowe_imperative.operations.html#mcurrentoperation","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operations"},{"id":1057,"kind":1024,"name":"mOperationsCompleteCallback","url":"classes/_zowe_imperative.operations.html#moperationscompletecallback","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operations"},{"id":1058,"kind":1024,"name":"mOperationUndoList","url":"classes/_zowe_imperative.operations.html#moperationundolist","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operations"},{"id":1059,"kind":1024,"name":"mOperationUndoIndex","url":"classes/_zowe_imperative.operations.html#moperationundoindex","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operations"},{"id":1060,"kind":1024,"name":"mInputParameters","url":"classes/_zowe_imperative.operations.html#minputparameters","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operations"},{"id":1061,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.operations.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.Operations"},{"id":1062,"kind":2048,"name":"executeOperation","url":"classes/_zowe_imperative.operations.html#executeoperation","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.Operations"},{"id":1063,"kind":2048,"name":"setStatusMessage","url":"classes/_zowe_imperative.operations.html#setstatusmessage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.Operations"},{"id":1064,"kind":262144,"name":"statusMessage","url":"classes/_zowe_imperative.operations.html#statusmessage","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.Operations"},{"id":1065,"kind":262144,"name":"percentComplete","url":"classes/_zowe_imperative.operations.html#percentcomplete","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.Operations"},{"id":1066,"kind":2048,"name":"logOperationResults","url":"classes/_zowe_imperative.operations.html#logoperationresults","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.Operations"},{"id":1067,"kind":262144,"name":"totalOperations","url":"classes/_zowe_imperative.operations.html#totaloperations","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.Operations"},{"id":1068,"kind":2048,"name":"addNextOperation","url":"classes/_zowe_imperative.operations.html#addnextoperation","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1069,"kind":2048,"name":"execute","url":"classes/_zowe_imperative.operations.html#execute","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1070,"kind":2048,"name":"undo","url":"classes/_zowe_imperative.operations.html#undo","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1071,"kind":2048,"name":"logOperationBeginMessages","url":"classes/_zowe_imperative.operations.html#logoperationbeginmessages","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1072,"kind":2048,"name":"operationCompleted","url":"classes/_zowe_imperative.operations.html#operationcompleted","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1073,"kind":2048,"name":"defineOperations","url":"classes/_zowe_imperative.operations.html#defineoperations","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1074,"kind":2048,"name":"executeNextOperation","url":"classes/_zowe_imperative.operations.html#executenextoperation","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operations"},{"id":1075,"kind":2048,"name":"prepareForUndo","url":"classes/_zowe_imperative.operations.html#prepareforundo","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operations"},{"id":1076,"kind":2048,"name":"executeNextUndo","url":"classes/_zowe_imperative.operations.html#executenextundo","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operations"},{"id":1077,"kind":2048,"name":"undoOpComplete","url":"classes/_zowe_imperative.operations.html#undoopcomplete","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Operations"},{"id":1078,"kind":1024,"name":"NO_PARMS","url":"classes/_zowe_imperative.operations.html#no_parms","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Operations"},{"id":1079,"kind":1024,"name":"NO_OUTPUT","url":"classes/_zowe_imperative.operations.html#no_output","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Operations"},{"id":1080,"kind":2048,"name":"summarizeResults","url":"classes/_zowe_imperative.operations.html#summarizeresults","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Operations"},{"id":1081,"kind":1024,"name":"infoMessages","url":"classes/_zowe_imperative.operations.html#infomessages","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.Operations"},{"id":1082,"kind":1024,"name":"errorMessages","url":"classes/_zowe_imperative.operations.html#errormessages","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.Operations"},{"id":1083,"kind":1024,"name":"log","url":"classes/_zowe_imperative.operations.html#log","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1084,"kind":1024,"name":"mOperationResults","url":"classes/_zowe_imperative.operations.html#moperationresults","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1085,"kind":1024,"name":"mOperationResult","url":"classes/_zowe_imperative.operations.html#moperationresult","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1086,"kind":2048,"name":"performUndo","url":"classes/_zowe_imperative.operations.html#performundo","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.Operations"},{"id":1087,"kind":262144,"name":"operationResult","url":"classes/_zowe_imperative.operations.html#operationresult","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.Operations"},{"id":1088,"kind":262144,"name":"stageName","url":"classes/_zowe_imperative.operations.html#stagename","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.Operations"},{"id":1089,"kind":262144,"name":"allFilesCreated","url":"classes/_zowe_imperative.operations.html#allfilescreated","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.Operations"},{"id":1090,"kind":262144,"name":"fileToUndo","url":"classes/_zowe_imperative.operations.html#filetoundo","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.Operations"},{"id":1091,"kind":262144,"name":"operationName","url":"classes/_zowe_imperative.operations.html#operationname","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.Operations"},{"id":1092,"kind":2048,"name":"setOperationFailed","url":"classes/_zowe_imperative.operations.html#setoperationfailed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1093,"kind":2048,"name":"setOperationUndoable","url":"classes/_zowe_imperative.operations.html#setoperationundoable","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1094,"kind":262144,"name":"operationResultMessage","url":"classes/_zowe_imperative.operations.html#operationresultmessage","classes":"tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.Operations"},{"id":1095,"kind":262144,"name":"operationSucceeded","url":"classes/_zowe_imperative.operations.html#operationsucceeded","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.Operations"},{"id":1096,"kind":2048,"name":"setOperationUndoFailed","url":"classes/_zowe_imperative.operations.html#setoperationundofailed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1097,"kind":2048,"name":"setOperationDiverge","url":"classes/_zowe_imperative.operations.html#setoperationdiverge","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1098,"kind":2048,"name":"setOperationUndoAttempted","url":"classes/_zowe_imperative.operations.html#setoperationundoattempted","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1099,"kind":2048,"name":"addResult","url":"classes/_zowe_imperative.operations.html#addresult","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1100,"kind":2048,"name":"createFile","url":"classes/_zowe_imperative.operations.html#createfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1101,"kind":2048,"name":"printFilesCreatedList","url":"classes/_zowe_imperative.operations.html#printfilescreatedlist","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1102,"kind":2048,"name":"addFileCreated","url":"classes/_zowe_imperative.operations.html#addfilecreated","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.Operations"},{"id":1103,"kind":256,"name":"IProgressBarParms","url":"interfaces/_zowe_imperative.iprogressbarparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1104,"kind":1024,"name":"task","url":"interfaces/_zowe_imperative.iprogressbarparms.html#task","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProgressBarParms"},{"id":1105,"kind":1024,"name":"updateInterval","url":"interfaces/_zowe_imperative.iprogressbarparms.html#updateinterval","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProgressBarParms"},{"id":1106,"kind":1024,"name":"stream","url":"interfaces/_zowe_imperative.iprogressbarparms.html#stream","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProgressBarParms"},{"id":1107,"kind":256,"name":"IHandlerProgressApi","url":"interfaces/_zowe_imperative.ihandlerprogressapi.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1108,"kind":2048,"name":"startBar","url":"interfaces/_zowe_imperative.ihandlerprogressapi.html#startbar","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerProgressApi"},{"id":1109,"kind":2048,"name":"endBar","url":"interfaces/_zowe_imperative.ihandlerprogressapi.html#endbar","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerProgressApi"},{"id":1110,"kind":256,"name":"ICommandOutputFormat","url":"interfaces/_zowe_imperative.icommandoutputformat.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1111,"kind":1024,"name":"output","url":"interfaces/_zowe_imperative.icommandoutputformat.html#output","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOutputFormat"},{"id":1112,"kind":1024,"name":"format","url":"interfaces/_zowe_imperative.icommandoutputformat.html#format","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOutputFormat"},{"id":1113,"kind":1024,"name":"fields","url":"interfaces/_zowe_imperative.icommandoutputformat.html#fields","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOutputFormat"},{"id":1114,"kind":1024,"name":"header","url":"interfaces/_zowe_imperative.icommandoutputformat.html#header","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandOutputFormat"},{"id":1115,"kind":4194304,"name":"OUTPUT_FORMAT","url":"modules/_zowe_imperative.html#output_format","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1116,"kind":256,"name":"IHandlerFormatOutputApi","url":"interfaces/_zowe_imperative.ihandlerformatoutputapi.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1117,"kind":1024,"name":"output","url":"interfaces/_zowe_imperative.ihandlerformatoutputapi.html#output","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerFormatOutputApi"},{"id":1118,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.ihandlerformatoutputapi.html#output.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IHandlerFormatOutputApi.output"},{"id":1119,"kind":256,"name":"IHandlerResponseApi","url":"interfaces/_zowe_imperative.ihandlerresponseapi.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1120,"kind":1024,"name":"console","url":"interfaces/_zowe_imperative.ihandlerresponseapi.html#console","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerResponseApi"},{"id":1121,"kind":1024,"name":"data","url":"interfaces/_zowe_imperative.ihandlerresponseapi.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerResponseApi"},{"id":1122,"kind":1024,"name":"progress","url":"interfaces/_zowe_imperative.ihandlerresponseapi.html#progress","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerResponseApi"},{"id":1123,"kind":1024,"name":"format","url":"interfaces/_zowe_imperative.ihandlerresponseapi.html#format","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerResponseApi"},{"id":1124,"kind":256,"name":"ICommandArguments","url":"interfaces/_zowe_imperative.icommandarguments.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1125,"kind":1024,"name":"$0","url":"interfaces/_zowe_imperative.icommandarguments.html#_0","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandArguments"},{"id":1126,"kind":1024,"name":"_","url":"interfaces/_zowe_imperative.icommandarguments.html#_","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandArguments"},{"id":1127,"kind":256,"name":"IHandlerParameters","url":"interfaces/_zowe_imperative.ihandlerparameters.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1128,"kind":1024,"name":"response","url":"interfaces/_zowe_imperative.ihandlerparameters.html#response","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerParameters"},{"id":1129,"kind":1024,"name":"arguments","url":"interfaces/_zowe_imperative.ihandlerparameters.html#arguments","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerParameters"},{"id":1130,"kind":1024,"name":"positionals","url":"interfaces/_zowe_imperative.ihandlerparameters.html#positionals","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerParameters"},{"id":1131,"kind":1024,"name":"profiles","url":"interfaces/_zowe_imperative.ihandlerparameters.html#profiles","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerParameters"},{"id":1132,"kind":1024,"name":"definition","url":"interfaces/_zowe_imperative.ihandlerparameters.html#definition","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerParameters"},{"id":1133,"kind":1024,"name":"fullDefinition","url":"interfaces/_zowe_imperative.ihandlerparameters.html#fulldefinition","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerParameters"},{"id":1134,"kind":1024,"name":"stdin","url":"interfaces/_zowe_imperative.ihandlerparameters.html#stdin","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerParameters"},{"id":1135,"kind":1024,"name":"isChained","url":"interfaces/_zowe_imperative.ihandlerparameters.html#ischained","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHandlerParameters"},{"id":1136,"kind":256,"name":"ICommandHandler","url":"interfaces/_zowe_imperative.icommandhandler.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1137,"kind":2048,"name":"process","url":"interfaces/_zowe_imperative.icommandhandler.html#process","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandHandler"},{"id":1138,"kind":4194304,"name":"ICommandHandlerConstructor","url":"modules/_zowe_imperative.html#icommandhandlerconstructor","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1139,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#icommandhandlerconstructor.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.ICommandHandlerConstructor"},{"id":1140,"kind":256,"name":"ICommandHandlerRequire","url":"interfaces/_zowe_imperative.icommandhandlerrequire.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1141,"kind":1024,"name":"default","url":"interfaces/_zowe_imperative.icommandhandlerrequire.html#default","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandHandlerRequire"},{"id":1142,"kind":256,"name":"IPartialCommandDefinition","url":"interfaces/_zowe_imperative.ipartialcommanddefinition.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1143,"kind":1024,"name":"description","url":"interfaces/_zowe_imperative.ipartialcommanddefinition.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPartialCommandDefinition"},{"id":1144,"kind":1024,"name":"summary","url":"interfaces/_zowe_imperative.ipartialcommanddefinition.html#summary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPartialCommandDefinition"},{"id":1145,"kind":1024,"name":"examples","url":"interfaces/_zowe_imperative.ipartialcommanddefinition.html#examples","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPartialCommandDefinition"},{"id":1146,"kind":1024,"name":"options","url":"interfaces/_zowe_imperative.ipartialcommanddefinition.html#options","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPartialCommandDefinition"},{"id":1147,"kind":256,"name":"ICommandProfileAuthConfig","url":"interfaces/_zowe_imperative.icommandprofileauthconfig.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1148,"kind":1024,"name":"serviceName","url":"interfaces/_zowe_imperative.icommandprofileauthconfig.html#servicename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileAuthConfig"},{"id":1149,"kind":1024,"name":"handler","url":"interfaces/_zowe_imperative.icommandprofileauthconfig.html#handler","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileAuthConfig"},{"id":1150,"kind":1024,"name":"login","url":"interfaces/_zowe_imperative.icommandprofileauthconfig.html#login","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileAuthConfig"},{"id":1151,"kind":1024,"name":"logout","url":"interfaces/_zowe_imperative.icommandprofileauthconfig.html#logout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileAuthConfig"},{"id":1152,"kind":4194304,"name":"HTTP_VERB","url":"modules/_zowe_imperative.html#http_verb","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1153,"kind":256,"name":"IHeaderContent","url":"interfaces/_zowe_imperative.iheadercontent.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1154,"kind":256,"name":"IHTTPSOptions","url":"interfaces/_zowe_imperative.ihttpsoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1155,"kind":1024,"name":"headers","url":"interfaces/_zowe_imperative.ihttpsoptions.html#headers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHTTPSOptions"},{"id":1156,"kind":1024,"name":"hostname","url":"interfaces/_zowe_imperative.ihttpsoptions.html#hostname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHTTPSOptions"},{"id":1157,"kind":1024,"name":"method","url":"interfaces/_zowe_imperative.ihttpsoptions.html#method","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHTTPSOptions"},{"id":1158,"kind":1024,"name":"path","url":"interfaces/_zowe_imperative.ihttpsoptions.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHTTPSOptions"},{"id":1159,"kind":1024,"name":"port","url":"interfaces/_zowe_imperative.ihttpsoptions.html#port","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHTTPSOptions"},{"id":1160,"kind":1024,"name":"rejectUnauthorized","url":"interfaces/_zowe_imperative.ihttpsoptions.html#rejectunauthorized","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHTTPSOptions"},{"id":1161,"kind":1024,"name":"cert","url":"interfaces/_zowe_imperative.ihttpsoptions.html#cert","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHTTPSOptions"},{"id":1162,"kind":1024,"name":"key","url":"interfaces/_zowe_imperative.ihttpsoptions.html#key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHTTPSOptions"},{"id":1163,"kind":1024,"name":"hash","url":"interfaces/_zowe_imperative.ihttpsoptions.html#hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHTTPSOptions"},{"id":1164,"kind":4194304,"name":"CLIENT_PROPERTY","url":"modules/_zowe_imperative.html#client_property","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1165,"kind":256,"name":"IOptionsFullResponse","url":"interfaces/_zowe_imperative.ioptionsfullresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1166,"kind":1024,"name":"resource","url":"interfaces/_zowe_imperative.ioptionsfullresponse.html#resource","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsFullResponse"},{"id":1167,"kind":1024,"name":"dataToReturn","url":"interfaces/_zowe_imperative.ioptionsfullresponse.html#datatoreturn","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsFullResponse"},{"id":1168,"kind":1024,"name":"reqHeaders","url":"interfaces/_zowe_imperative.ioptionsfullresponse.html#reqheaders","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsFullResponse"},{"id":1169,"kind":1024,"name":"writeData","url":"interfaces/_zowe_imperative.ioptionsfullresponse.html#writedata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsFullResponse"},{"id":1170,"kind":1024,"name":"responseStream","url":"interfaces/_zowe_imperative.ioptionsfullresponse.html#responsestream","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsFullResponse"},{"id":1171,"kind":1024,"name":"requestStream","url":"interfaces/_zowe_imperative.ioptionsfullresponse.html#requeststream","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsFullResponse"},{"id":1172,"kind":1024,"name":"normalizeResponseNewLines","url":"interfaces/_zowe_imperative.ioptionsfullresponse.html#normalizeresponsenewlines","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsFullResponse"},{"id":1173,"kind":1024,"name":"normalizeRequestNewLines","url":"interfaces/_zowe_imperative.ioptionsfullresponse.html#normalizerequestnewlines","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsFullResponse"},{"id":1174,"kind":1024,"name":"task","url":"interfaces/_zowe_imperative.ioptionsfullresponse.html#task","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsFullResponse"},{"id":1175,"kind":256,"name":"IRestClientError","url":"interfaces/_zowe_imperative.irestclienterror.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1176,"kind":1024,"name":"httpStatus","url":"interfaces/_zowe_imperative.irestclienterror.html#httpstatus","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientError"},{"id":1177,"kind":1024,"name":"errno","url":"interfaces/_zowe_imperative.irestclienterror.html#errno","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientError"},{"id":1178,"kind":1024,"name":"host","url":"interfaces/_zowe_imperative.irestclienterror.html#host","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientError"},{"id":1179,"kind":1024,"name":"syscall","url":"interfaces/_zowe_imperative.irestclienterror.html#syscall","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientError"},{"id":1180,"kind":1024,"name":"protocol","url":"interfaces/_zowe_imperative.irestclienterror.html#protocol","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientError"},{"id":1181,"kind":1024,"name":"port","url":"interfaces/_zowe_imperative.irestclienterror.html#port","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientError"},{"id":1182,"kind":1024,"name":"basePath","url":"interfaces/_zowe_imperative.irestclienterror.html#basepath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientError"},{"id":1183,"kind":1024,"name":"resource","url":"interfaces/_zowe_imperative.irestclienterror.html#resource","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientError"},{"id":1184,"kind":1024,"name":"headers","url":"interfaces/_zowe_imperative.irestclienterror.html#headers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientError"},{"id":1185,"kind":1024,"name":"payload","url":"interfaces/_zowe_imperative.irestclienterror.html#payload","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientError"},{"id":1186,"kind":1024,"name":"request","url":"interfaces/_zowe_imperative.irestclienterror.html#request","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientError"},{"id":1187,"kind":1024,"name":"source","url":"interfaces/_zowe_imperative.irestclienterror.html#source","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientError"},{"id":1188,"kind":1024,"name":"msg","url":"interfaces/_zowe_imperative.irestclienterror.html#msg","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IRestClientError"},{"id":1189,"kind":1024,"name":"causeErrors","url":"interfaces/_zowe_imperative.irestclienterror.html#causeerrors","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IRestClientError"},{"id":1190,"kind":1024,"name":"additionalDetails","url":"interfaces/_zowe_imperative.irestclienterror.html#additionaldetails","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IRestClientError"},{"id":1191,"kind":1024,"name":"stack","url":"interfaces/_zowe_imperative.irestclienterror.html#stack","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IRestClientError"},{"id":1192,"kind":1024,"name":"errorCode","url":"interfaces/_zowe_imperative.irestclienterror.html#errorcode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IRestClientError"},{"id":1193,"kind":1024,"name":"suppressDump","url":"interfaces/_zowe_imperative.irestclienterror.html#suppressdump","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IRestClientError"},{"id":1194,"kind":4194304,"name":"RestErrorSource","url":"modules/_zowe_imperative.html#resterrorsource","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1195,"kind":32,"name":"HTTP_PROTOCOL","url":"modules/_zowe_imperative.html#http_protocol","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1196,"kind":32,"name":"HTTPS_PROTOCOL","url":"modules/_zowe_imperative.html#https_protocol","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1197,"kind":4194304,"name":"HTTP_PROTOCOL_CHOICES","url":"modules/_zowe_imperative.html#http_protocol_choices","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1198,"kind":32,"name":"AUTH_TYPE_NONE","url":"modules/_zowe_imperative.html#auth_type_none","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1199,"kind":32,"name":"AUTH_TYPE_BASIC","url":"modules/_zowe_imperative.html#auth_type_basic","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1200,"kind":32,"name":"AUTH_TYPE_BEARER","url":"modules/_zowe_imperative.html#auth_type_bearer","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1201,"kind":32,"name":"AUTH_TYPE_TOKEN","url":"modules/_zowe_imperative.html#auth_type_token","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1202,"kind":32,"name":"AUTH_TYPE_CERT_PEM","url":"modules/_zowe_imperative.html#auth_type_cert_pem","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1203,"kind":4194304,"name":"AUTH_TYPE_CHOICES","url":"modules/_zowe_imperative.html#auth_type_choices","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1204,"kind":32,"name":"TOKEN_TYPE_LTPA","url":"modules/_zowe_imperative.html#token_type_ltpa","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1205,"kind":32,"name":"TOKEN_TYPE_JWT","url":"modules/_zowe_imperative.html#token_type_jwt","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1206,"kind":32,"name":"TOKEN_TYPE_APIML","url":"modules/_zowe_imperative.html#token_type_apiml","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1207,"kind":32,"name":"ALL_TOKEN_TYPES","url":"modules/_zowe_imperative.html#all_token_types","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1208,"kind":4194304,"name":"TOKEN_TYPE_CHOICES","url":"modules/_zowe_imperative.html#token_type_choices","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1209,"kind":256,"name":"ISession","url":"interfaces/_zowe_imperative.isession.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1210,"kind":1024,"name":"hostname","url":"interfaces/_zowe_imperative.isession.html#hostname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1211,"kind":1024,"name":"port","url":"interfaces/_zowe_imperative.isession.html#port","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1212,"kind":1024,"name":"user","url":"interfaces/_zowe_imperative.isession.html#user","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1213,"kind":1024,"name":"password","url":"interfaces/_zowe_imperative.isession.html#password","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1214,"kind":1024,"name":"protocol","url":"interfaces/_zowe_imperative.isession.html#protocol","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1215,"kind":1024,"name":"basePath","url":"interfaces/_zowe_imperative.isession.html#basepath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1216,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.isession.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1217,"kind":1024,"name":"base64EncodedAuth","url":"interfaces/_zowe_imperative.isession.html#base64encodedauth","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1218,"kind":1024,"name":"tokenType","url":"interfaces/_zowe_imperative.isession.html#tokentype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1219,"kind":1024,"name":"tokenValue","url":"interfaces/_zowe_imperative.isession.html#tokenvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1220,"kind":1024,"name":"rejectUnauthorized","url":"interfaces/_zowe_imperative.isession.html#rejectunauthorized","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1221,"kind":1024,"name":"cert","url":"interfaces/_zowe_imperative.isession.html#cert","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1222,"kind":1024,"name":"certKey","url":"interfaces/_zowe_imperative.isession.html#certkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1223,"kind":1024,"name":"passphrase","url":"interfaces/_zowe_imperative.isession.html#passphrase","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1224,"kind":1024,"name":"serverCertificate","url":"interfaces/_zowe_imperative.isession.html#servercertificate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1225,"kind":1024,"name":"strictSSL","url":"interfaces/_zowe_imperative.isession.html#strictssl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1226,"kind":1024,"name":"checkServerIdentity","url":"interfaces/_zowe_imperative.isession.html#checkserveridentity","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1227,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.isession.html#checkserveridentity.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.ISession.checkServerIdentity"},{"id":1228,"kind":1024,"name":"secureProtocol","url":"interfaces/_zowe_imperative.isession.html#secureprotocol","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1229,"kind":1024,"name":"storeCookie","url":"interfaces/_zowe_imperative.isession.html#storecookie","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISession"},{"id":1230,"kind":128,"name":"AbstractSession","url":"classes/_zowe_imperative.abstractsession.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1231,"kind":1024,"name":"BASIC_PREFIX","url":"classes/_zowe_imperative.abstractsession.html#basic_prefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1232,"kind":1024,"name":"BEARER_PREFIX","url":"classes/_zowe_imperative.abstractsession.html#bearer_prefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1233,"kind":1024,"name":"DEFAULT_PROTOCOL","url":"classes/_zowe_imperative.abstractsession.html#default_protocol","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1234,"kind":1024,"name":"DEFAULT_TYPE","url":"classes/_zowe_imperative.abstractsession.html#default_type","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1235,"kind":1024,"name":"DEFAULT_HTTP_PORT","url":"classes/_zowe_imperative.abstractsession.html#default_http_port","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1236,"kind":1024,"name":"DEFAULT_HTTPS_PORT","url":"classes/_zowe_imperative.abstractsession.html#default_https_port","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1237,"kind":1024,"name":"DEFAULT_PORT","url":"classes/_zowe_imperative.abstractsession.html#default_port","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1238,"kind":1024,"name":"DEFAULT_BASE_PATH","url":"classes/_zowe_imperative.abstractsession.html#default_base_path","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1239,"kind":1024,"name":"DEFAULT_REJECT_UNAUTHORIZED_SETTING","url":"classes/_zowe_imperative.abstractsession.html#default_reject_unauthorized_setting","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1240,"kind":1024,"name":"DEFAULT_STRICT_SSL","url":"classes/_zowe_imperative.abstractsession.html#default_strict_ssl","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1241,"kind":1024,"name":"DEFAULT_SECURE_PROTOCOL","url":"classes/_zowe_imperative.abstractsession.html#default_secure_protocol","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1242,"kind":1024,"name":"BASIC","url":"classes/_zowe_imperative.abstractsession.html#basic","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1243,"kind":2048,"name":"getUsernameFromAuth","url":"classes/_zowe_imperative.abstractsession.html#getusernamefromauth","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1244,"kind":2048,"name":"getPasswordFromAuth","url":"classes/_zowe_imperative.abstractsession.html#getpasswordfromauth","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1245,"kind":2048,"name":"getBase64Auth","url":"classes/_zowe_imperative.abstractsession.html#getbase64auth","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractSession"},{"id":1246,"kind":1024,"name":"mLog","url":"classes/_zowe_imperative.abstractsession.html#mlog","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractSession"},{"id":1247,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.abstractsession.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.AbstractSession"},{"id":1248,"kind":1024,"name":"mISession","url":"classes/_zowe_imperative.abstractsession.html#misession","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractSession"},{"id":1249,"kind":2048,"name":"storeCookie","url":"classes/_zowe_imperative.abstractsession.html#storecookie","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractSession"},{"id":1250,"kind":2048,"name":"buildSession","url":"classes/_zowe_imperative.abstractsession.html#buildsession","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractSession"},{"id":1251,"kind":262144,"name":"ISession","url":"classes/_zowe_imperative.abstractsession.html#isession","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractSession"},{"id":1252,"kind":128,"name":"Session","url":"classes/_zowe_imperative.session.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1253,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.session.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.Session"},{"id":1254,"kind":2048,"name":"createFromUrl","url":"classes/_zowe_imperative.session.html#createfromurl","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1255,"kind":1024,"name":"BASIC_PREFIX","url":"classes/_zowe_imperative.session.html#basic_prefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1256,"kind":1024,"name":"BEARER_PREFIX","url":"classes/_zowe_imperative.session.html#bearer_prefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1257,"kind":1024,"name":"DEFAULT_PROTOCOL","url":"classes/_zowe_imperative.session.html#default_protocol","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1258,"kind":1024,"name":"DEFAULT_TYPE","url":"classes/_zowe_imperative.session.html#default_type","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1259,"kind":1024,"name":"DEFAULT_HTTP_PORT","url":"classes/_zowe_imperative.session.html#default_http_port","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1260,"kind":1024,"name":"DEFAULT_HTTPS_PORT","url":"classes/_zowe_imperative.session.html#default_https_port","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1261,"kind":1024,"name":"DEFAULT_PORT","url":"classes/_zowe_imperative.session.html#default_port","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1262,"kind":1024,"name":"DEFAULT_BASE_PATH","url":"classes/_zowe_imperative.session.html#default_base_path","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1263,"kind":1024,"name":"DEFAULT_REJECT_UNAUTHORIZED_SETTING","url":"classes/_zowe_imperative.session.html#default_reject_unauthorized_setting","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1264,"kind":1024,"name":"DEFAULT_STRICT_SSL","url":"classes/_zowe_imperative.session.html#default_strict_ssl","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1265,"kind":1024,"name":"DEFAULT_SECURE_PROTOCOL","url":"classes/_zowe_imperative.session.html#default_secure_protocol","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1266,"kind":1024,"name":"BASIC","url":"classes/_zowe_imperative.session.html#basic","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1267,"kind":2048,"name":"getUsernameFromAuth","url":"classes/_zowe_imperative.session.html#getusernamefromauth","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1268,"kind":2048,"name":"getPasswordFromAuth","url":"classes/_zowe_imperative.session.html#getpasswordfromauth","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1269,"kind":2048,"name":"getBase64Auth","url":"classes/_zowe_imperative.session.html#getbase64auth","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.Session"},{"id":1270,"kind":2048,"name":"storeCookie","url":"classes/_zowe_imperative.session.html#storecookie","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.Session"},{"id":1271,"kind":262144,"name":"ISession","url":"classes/_zowe_imperative.session.html#isession","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.Session"},{"id":1272,"kind":256,"name":"IRestClientResponse","url":"interfaces/_zowe_imperative.irestclientresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1273,"kind":1024,"name":"requestSuccess","url":"interfaces/_zowe_imperative.irestclientresponse.html#requestsuccess","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientResponse"},{"id":1274,"kind":1024,"name":"requestFailure","url":"interfaces/_zowe_imperative.irestclientresponse.html#requestfailure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientResponse"},{"id":1275,"kind":1024,"name":"data","url":"interfaces/_zowe_imperative.irestclientresponse.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientResponse"},{"id":1276,"kind":1024,"name":"dataString","url":"interfaces/_zowe_imperative.irestclientresponse.html#datastring","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientResponse"},{"id":1277,"kind":1024,"name":"response","url":"interfaces/_zowe_imperative.irestclientresponse.html#response","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientResponse"},{"id":1278,"kind":1024,"name":"session","url":"interfaces/_zowe_imperative.irestclientresponse.html#session","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientResponse"},{"id":1279,"kind":1024,"name":"log","url":"interfaces/_zowe_imperative.irestclientresponse.html#log","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestClientResponse"},{"id":1280,"kind":256,"name":"IRestOptions","url":"interfaces/_zowe_imperative.irestoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1281,"kind":1024,"name":"resource","url":"interfaces/_zowe_imperative.irestoptions.html#resource","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestOptions"},{"id":1282,"kind":1024,"name":"request","url":"interfaces/_zowe_imperative.irestoptions.html#request","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestOptions"},{"id":1283,"kind":1024,"name":"reqHeaders","url":"interfaces/_zowe_imperative.irestoptions.html#reqheaders","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestOptions"},{"id":1284,"kind":1024,"name":"writeData","url":"interfaces/_zowe_imperative.irestoptions.html#writedata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestOptions"},{"id":1285,"kind":1024,"name":"responseStream","url":"interfaces/_zowe_imperative.irestoptions.html#responsestream","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestOptions"},{"id":1286,"kind":1024,"name":"requestStream","url":"interfaces/_zowe_imperative.irestoptions.html#requeststream","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestOptions"},{"id":1287,"kind":1024,"name":"normalizeResponseNewLines","url":"interfaces/_zowe_imperative.irestoptions.html#normalizeresponsenewlines","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestOptions"},{"id":1288,"kind":1024,"name":"normalizeRequestNewLines","url":"interfaces/_zowe_imperative.irestoptions.html#normalizerequestnewlines","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestOptions"},{"id":1289,"kind":1024,"name":"task","url":"interfaces/_zowe_imperative.irestoptions.html#task","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IRestOptions"},{"id":1290,"kind":128,"name":"Headers","url":"classes/_zowe_imperative.headers.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1291,"kind":1024,"name":"CONTENT_TYPE","url":"classes/_zowe_imperative.headers.html#content_type","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Headers"},{"id":1292,"kind":1024,"name":"CONTENT_LENGTH","url":"classes/_zowe_imperative.headers.html#content_length","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Headers"},{"id":1293,"kind":1024,"name":"CONTENT_ENCODING","url":"classes/_zowe_imperative.headers.html#content_encoding","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Headers"},{"id":1294,"kind":1024,"name":"CONTENT_ENCODING_TYPES","url":"classes/_zowe_imperative.headers.html#content_encoding_types","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Headers"},{"id":1295,"kind":2097152,"name":"APPLICATION_JSON","url":"classes/_zowe_imperative.headers.html#application_json","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Headers"},{"id":1296,"kind":32,"name":"Content-Type","url":"classes/_zowe_imperative.headers.html#application_json.content_type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.Headers.APPLICATION_JSON"},{"id":1297,"kind":2097152,"name":"TEXT_PLAIN","url":"classes/_zowe_imperative.headers.html#text_plain","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Headers"},{"id":1298,"kind":32,"name":"Content-Type","url":"classes/_zowe_imperative.headers.html#text_plain.content_type-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.Headers.TEXT_PLAIN"},{"id":1299,"kind":2097152,"name":"TEXT_PLAIN_UTF8","url":"classes/_zowe_imperative.headers.html#text_plain_utf8","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Headers"},{"id":1300,"kind":32,"name":"Content-Type","url":"classes/_zowe_imperative.headers.html#text_plain_utf8.content_type-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.Headers.TEXT_PLAIN_UTF8"},{"id":1301,"kind":2097152,"name":"OCTET_STREAM","url":"classes/_zowe_imperative.headers.html#octet_stream","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Headers"},{"id":1302,"kind":32,"name":"Content-Type","url":"classes/_zowe_imperative.headers.html#octet_stream.content_type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.Headers.OCTET_STREAM"},{"id":1303,"kind":2097152,"name":"BASIC_AUTHORIZATION","url":"classes/_zowe_imperative.headers.html#basic_authorization","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Headers"},{"id":1304,"kind":32,"name":"Authorization","url":"classes/_zowe_imperative.headers.html#basic_authorization.authorization","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.Headers.BASIC_AUTHORIZATION"},{"id":1305,"kind":2097152,"name":"COOKIE_AUTHORIZATION","url":"classes/_zowe_imperative.headers.html#cookie_authorization","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Headers"},{"id":1306,"kind":32,"name":"Cookie","url":"classes/_zowe_imperative.headers.html#cookie_authorization.cookie","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.Headers.COOKIE_AUTHORIZATION"},{"id":1307,"kind":4194304,"name":"ContentEncoding","url":"modules/_zowe_imperative.html#contentencoding","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1308,"kind":128,"name":"RestConstants","url":"classes/_zowe_imperative.restconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1309,"kind":1024,"name":"HTTP_STATUS_200","url":"classes/_zowe_imperative.restconstants.html#http_status_200","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1310,"kind":1024,"name":"HTTP_STATUS_201","url":"classes/_zowe_imperative.restconstants.html#http_status_201","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1311,"kind":1024,"name":"HTTP_STATUS_202","url":"classes/_zowe_imperative.restconstants.html#http_status_202","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1312,"kind":1024,"name":"HTTP_STATUS_204","url":"classes/_zowe_imperative.restconstants.html#http_status_204","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1313,"kind":1024,"name":"HTTP_STATUS_300","url":"classes/_zowe_imperative.restconstants.html#http_status_300","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1314,"kind":1024,"name":"HTTP_STATUS_400","url":"classes/_zowe_imperative.restconstants.html#http_status_400","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1315,"kind":1024,"name":"HTTP_STATUS_401","url":"classes/_zowe_imperative.restconstants.html#http_status_401","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1316,"kind":1024,"name":"HTTP_STATUS_404","url":"classes/_zowe_imperative.restconstants.html#http_status_404","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1317,"kind":1024,"name":"HTTP_STATUS_500","url":"classes/_zowe_imperative.restconstants.html#http_status_500","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1318,"kind":1024,"name":"PROP_COOKIE","url":"classes/_zowe_imperative.restconstants.html#prop_cookie","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1319,"kind":1024,"name":"QUERY_ID","url":"classes/_zowe_imperative.restconstants.html#query_id","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1320,"kind":1024,"name":"BASIC_PREFIX","url":"classes/_zowe_imperative.restconstants.html#basic_prefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1321,"kind":1024,"name":"BEARER_PREFIX","url":"classes/_zowe_imperative.restconstants.html#bearer_prefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestConstants"},{"id":1322,"kind":128,"name":"RestClientError","url":"classes/_zowe_imperative.restclienterror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1323,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.restclienterror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.RestClientError"},{"id":1324,"kind":1024,"name":"mDetails","url":"classes/_zowe_imperative.restclienterror.html#mdetails","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.RestClientError"},{"id":1325,"kind":262144,"name":"details","url":"classes/_zowe_imperative.restclienterror.html#details","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.RestClientError"},{"id":1326,"kind":262144,"name":"causeErrors","url":"classes/_zowe_imperative.restclienterror.html#causeerrors","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClientError"},{"id":1327,"kind":262144,"name":"additionalDetails","url":"classes/_zowe_imperative.restclienterror.html#additionaldetails","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClientError"},{"id":1328,"kind":262144,"name":"errorCode","url":"classes/_zowe_imperative.restclienterror.html#errorcode","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClientError"},{"id":1329,"kind":262144,"name":"suppressDump","url":"classes/_zowe_imperative.restclienterror.html#suppressdump","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClientError"},{"id":1330,"kind":262144,"name":"stack","url":"classes/_zowe_imperative.restclienterror.html#stack","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.RestClientError"},{"id":1331,"kind":262144,"name":"message","url":"classes/_zowe_imperative.restclienterror.html#message","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.RestClientError"},{"id":1332,"kind":1024,"name":"name","url":"classes/_zowe_imperative.restclienterror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClientError"},{"id":1333,"kind":128,"name":"CompressionUtils","url":"classes/_zowe_imperative.compressionutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1334,"kind":2048,"name":"decompressBuffer","url":"classes/_zowe_imperative.compressionutils.html#decompressbuffer","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CompressionUtils"},{"id":1335,"kind":2048,"name":"decompressStream","url":"classes/_zowe_imperative.compressionutils.html#decompressstream","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CompressionUtils"},{"id":1336,"kind":2048,"name":"decompressError","url":"classes/_zowe_imperative.compressionutils.html#decompresserror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CompressionUtils"},{"id":1337,"kind":2048,"name":"newLinesTransform","url":"classes/_zowe_imperative.compressionutils.html#newlinestransform","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CompressionUtils"},{"id":1338,"kind":2048,"name":"zlibTransform","url":"classes/_zowe_imperative.compressionutils.html#zlibtransform","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CompressionUtils"},{"id":1339,"kind":128,"name":"AbstractRestClient","url":"classes/_zowe_imperative.abstractrestclient.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1340,"kind":1024,"name":"mChunks","url":"classes/_zowe_imperative.abstractrestclient.html#mchunks","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1341,"kind":1024,"name":"mData","url":"classes/_zowe_imperative.abstractrestclient.html#mdata","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1342,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.abstractrestclient.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1343,"kind":1024,"name":"mResolve","url":"classes/_zowe_imperative.abstractrestclient.html#mresolve","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1344,"kind":1024,"name":"mReject","url":"classes/_zowe_imperative.abstractrestclient.html#mreject","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1345,"kind":1024,"name":"mResponse","url":"classes/_zowe_imperative.abstractrestclient.html#mresponse","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1346,"kind":1024,"name":"mContentLength","url":"classes/_zowe_imperative.abstractrestclient.html#mcontentlength","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1347,"kind":1024,"name":"mContentEncoding","url":"classes/_zowe_imperative.abstractrestclient.html#mcontentencoding","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1348,"kind":1024,"name":"mIsJson","url":"classes/_zowe_imperative.abstractrestclient.html#misjson","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1349,"kind":1024,"name":"mNormalizeRequestNewlines","url":"classes/_zowe_imperative.abstractrestclient.html#mnormalizerequestnewlines","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1350,"kind":1024,"name":"mNormalizeResponseNewlines","url":"classes/_zowe_imperative.abstractrestclient.html#mnormalizeresponsenewlines","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1351,"kind":1024,"name":"mResource","url":"classes/_zowe_imperative.abstractrestclient.html#mresource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1352,"kind":1024,"name":"mRequest","url":"classes/_zowe_imperative.abstractrestclient.html#mrequest","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1353,"kind":1024,"name":"mReqHeaders","url":"classes/_zowe_imperative.abstractrestclient.html#mreqheaders","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1354,"kind":1024,"name":"mWriteData","url":"classes/_zowe_imperative.abstractrestclient.html#mwritedata","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1355,"kind":1024,"name":"mResponseStream","url":"classes/_zowe_imperative.abstractrestclient.html#mresponsestream","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1356,"kind":1024,"name":"mRequestStream","url":"classes/_zowe_imperative.abstractrestclient.html#mrequeststream","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1357,"kind":1024,"name":"mTask","url":"classes/_zowe_imperative.abstractrestclient.html#mtask","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1358,"kind":1024,"name":"mBytesReceived","url":"classes/_zowe_imperative.abstractrestclient.html#mbytesreceived","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1359,"kind":1024,"name":"mDecode","url":"classes/_zowe_imperative.abstractrestclient.html#mdecode","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1360,"kind":1024,"name":"lastByteReceived","url":"classes/_zowe_imperative.abstractrestclient.html#lastbytereceived","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1361,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.abstractrestclient.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.AbstractRestClient"},{"id":1362,"kind":1024,"name":"mSession","url":"classes/_zowe_imperative.abstractrestclient.html#msession","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1363,"kind":2048,"name":"request","url":"classes/_zowe_imperative.abstractrestclient.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractRestClient"},{"id":1364,"kind":2048,"name":"appendHeaders","url":"classes/_zowe_imperative.abstractrestclient.html#appendheaders","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractRestClient"},{"id":1365,"kind":2048,"name":"processError","url":"classes/_zowe_imperative.abstractrestclient.html#processerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractRestClient"},{"id":1366,"kind":2048,"name":"buildOptions","url":"classes/_zowe_imperative.abstractrestclient.html#buildoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1367,"kind":2048,"name":"requestHandler","url":"classes/_zowe_imperative.abstractrestclient.html#requesthandler","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1368,"kind":2048,"name":"onData","url":"classes/_zowe_imperative.abstractrestclient.html#ondata","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1369,"kind":2048,"name":"onEnd","url":"classes/_zowe_imperative.abstractrestclient.html#onend","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1370,"kind":2048,"name":"populateError","url":"classes/_zowe_imperative.abstractrestclient.html#populateerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1371,"kind":2048,"name":"appendInputHeaders","url":"classes/_zowe_imperative.abstractrestclient.html#appendinputheaders","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1372,"kind":2048,"name":"setTransferFlags","url":"classes/_zowe_imperative.abstractrestclient.html#settransferflags","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractRestClient"},{"id":1373,"kind":262144,"name":"requestSuccess","url":"classes/_zowe_imperative.abstractrestclient.html#requestsuccess","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractRestClient"},{"id":1374,"kind":262144,"name":"requestFailure","url":"classes/_zowe_imperative.abstractrestclient.html#requestfailure","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractRestClient"},{"id":1375,"kind":262144,"name":"data","url":"classes/_zowe_imperative.abstractrestclient.html#data","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractRestClient"},{"id":1376,"kind":262144,"name":"dataString","url":"classes/_zowe_imperative.abstractrestclient.html#datastring","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractRestClient"},{"id":1377,"kind":262144,"name":"response","url":"classes/_zowe_imperative.abstractrestclient.html#response","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractRestClient"},{"id":1378,"kind":262144,"name":"session","url":"classes/_zowe_imperative.abstractrestclient.html#session","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractRestClient"},{"id":1379,"kind":262144,"name":"log","url":"classes/_zowe_imperative.abstractrestclient.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractRestClient"},{"id":1380,"kind":4194304,"name":"RestClientResolve","url":"modules/_zowe_imperative.html#restclientresolve","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1381,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#restclientresolve.__type-13","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.RestClientResolve"},{"id":1382,"kind":128,"name":"RestClient","url":"classes/_zowe_imperative.restclient.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1383,"kind":2048,"name":"getExpectJSON","url":"classes/_zowe_imperative.restclient.html#getexpectjson","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1384,"kind":2048,"name":"putExpectJSON","url":"classes/_zowe_imperative.restclient.html#putexpectjson","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1385,"kind":2048,"name":"postExpectJSON","url":"classes/_zowe_imperative.restclient.html#postexpectjson","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1386,"kind":2048,"name":"deleteExpectJSON","url":"classes/_zowe_imperative.restclient.html#deleteexpectjson","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1387,"kind":2048,"name":"getExpectBuffer","url":"classes/_zowe_imperative.restclient.html#getexpectbuffer","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1388,"kind":2048,"name":"putExpectBuffer","url":"classes/_zowe_imperative.restclient.html#putexpectbuffer","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1389,"kind":2048,"name":"postExpectBuffer","url":"classes/_zowe_imperative.restclient.html#postexpectbuffer","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1390,"kind":2048,"name":"deleteExpectBuffer","url":"classes/_zowe_imperative.restclient.html#deleteexpectbuffer","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1391,"kind":2048,"name":"getExpectString","url":"classes/_zowe_imperative.restclient.html#getexpectstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1392,"kind":2048,"name":"putExpectString","url":"classes/_zowe_imperative.restclient.html#putexpectstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1393,"kind":2048,"name":"postExpectString","url":"classes/_zowe_imperative.restclient.html#postexpectstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1394,"kind":2048,"name":"deleteExpectString","url":"classes/_zowe_imperative.restclient.html#deleteexpectstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1395,"kind":2048,"name":"getStreamed","url":"classes/_zowe_imperative.restclient.html#getstreamed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1396,"kind":2048,"name":"putStreamed","url":"classes/_zowe_imperative.restclient.html#putstreamed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1397,"kind":2048,"name":"putStreamedRequestOnly","url":"classes/_zowe_imperative.restclient.html#putstreamedrequestonly","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1398,"kind":2048,"name":"postStreamed","url":"classes/_zowe_imperative.restclient.html#poststreamed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1399,"kind":2048,"name":"postStreamedRequestOnly","url":"classes/_zowe_imperative.restclient.html#poststreamedrequestonly","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1400,"kind":2048,"name":"deleteStreamed","url":"classes/_zowe_imperative.restclient.html#deletestreamed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1401,"kind":2048,"name":"getExpectFullResponse","url":"classes/_zowe_imperative.restclient.html#getexpectfullresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1402,"kind":2048,"name":"putExpectFullResponse","url":"classes/_zowe_imperative.restclient.html#putexpectfullresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1403,"kind":2048,"name":"deleteExpectFullResponse","url":"classes/_zowe_imperative.restclient.html#deleteexpectfullresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1404,"kind":2048,"name":"postExpectFullResponse","url":"classes/_zowe_imperative.restclient.html#postexpectfullresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1405,"kind":2048,"name":"hasQueryString","url":"classes/_zowe_imperative.restclient.html#hasquerystring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1406,"kind":2048,"name":"extractExpectedData","url":"classes/_zowe_imperative.restclient.html#extractexpecteddata","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.RestClient"},{"id":1407,"kind":1024,"name":"mChunks","url":"classes/_zowe_imperative.restclient.html#mchunks","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1408,"kind":1024,"name":"mData","url":"classes/_zowe_imperative.restclient.html#mdata","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1409,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.restclient.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1410,"kind":1024,"name":"mResolve","url":"classes/_zowe_imperative.restclient.html#mresolve","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1411,"kind":1024,"name":"mReject","url":"classes/_zowe_imperative.restclient.html#mreject","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1412,"kind":1024,"name":"mResponse","url":"classes/_zowe_imperative.restclient.html#mresponse","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1413,"kind":1024,"name":"mContentLength","url":"classes/_zowe_imperative.restclient.html#mcontentlength","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1414,"kind":1024,"name":"mContentEncoding","url":"classes/_zowe_imperative.restclient.html#mcontentencoding","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1415,"kind":1024,"name":"mIsJson","url":"classes/_zowe_imperative.restclient.html#misjson","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1416,"kind":1024,"name":"mNormalizeRequestNewlines","url":"classes/_zowe_imperative.restclient.html#mnormalizerequestnewlines","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1417,"kind":1024,"name":"mNormalizeResponseNewlines","url":"classes/_zowe_imperative.restclient.html#mnormalizeresponsenewlines","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1418,"kind":1024,"name":"mResource","url":"classes/_zowe_imperative.restclient.html#mresource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1419,"kind":1024,"name":"mRequest","url":"classes/_zowe_imperative.restclient.html#mrequest","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1420,"kind":1024,"name":"mReqHeaders","url":"classes/_zowe_imperative.restclient.html#mreqheaders","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1421,"kind":1024,"name":"mWriteData","url":"classes/_zowe_imperative.restclient.html#mwritedata","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1422,"kind":1024,"name":"mResponseStream","url":"classes/_zowe_imperative.restclient.html#mresponsestream","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1423,"kind":1024,"name":"mRequestStream","url":"classes/_zowe_imperative.restclient.html#mrequeststream","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1424,"kind":1024,"name":"mTask","url":"classes/_zowe_imperative.restclient.html#mtask","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1425,"kind":1024,"name":"mBytesReceived","url":"classes/_zowe_imperative.restclient.html#mbytesreceived","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1426,"kind":1024,"name":"mDecode","url":"classes/_zowe_imperative.restclient.html#mdecode","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1427,"kind":1024,"name":"lastByteReceived","url":"classes/_zowe_imperative.restclient.html#lastbytereceived","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.RestClient"},{"id":1428,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.restclient.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClient"},{"id":1429,"kind":2048,"name":"request","url":"classes/_zowe_imperative.restclient.html#request","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClient"},{"id":1430,"kind":2048,"name":"appendHeaders","url":"classes/_zowe_imperative.restclient.html#appendheaders","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.RestClient"},{"id":1431,"kind":2048,"name":"processError","url":"classes/_zowe_imperative.restclient.html#processerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.RestClient"},{"id":1432,"kind":262144,"name":"requestSuccess","url":"classes/_zowe_imperative.restclient.html#requestsuccess","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClient"},{"id":1433,"kind":262144,"name":"requestFailure","url":"classes/_zowe_imperative.restclient.html#requestfailure","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClient"},{"id":1434,"kind":262144,"name":"data","url":"classes/_zowe_imperative.restclient.html#data","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClient"},{"id":1435,"kind":262144,"name":"dataString","url":"classes/_zowe_imperative.restclient.html#datastring","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClient"},{"id":1436,"kind":262144,"name":"response","url":"classes/_zowe_imperative.restclient.html#response","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClient"},{"id":1437,"kind":262144,"name":"session","url":"classes/_zowe_imperative.restclient.html#session","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClient"},{"id":1438,"kind":262144,"name":"log","url":"classes/_zowe_imperative.restclient.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.RestClient"},{"id":1439,"kind":128,"name":"RestStandAloneUtils","url":"classes/_zowe_imperative.reststandaloneutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1440,"kind":2048,"name":"getUsernameFromAuth","url":"classes/_zowe_imperative.reststandaloneutils.html#getusernamefromauth","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestStandAloneUtils"},{"id":1441,"kind":2048,"name":"getPasswordFromAuth","url":"classes/_zowe_imperative.reststandaloneutils.html#getpasswordfromauth","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.RestStandAloneUtils"},{"id":1442,"kind":1024,"name":"BASIC","url":"classes/_zowe_imperative.reststandaloneutils.html#basic","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.RestStandAloneUtils"},{"id":1443,"kind":256,"name":"IOverridePromptConnProps","url":"interfaces/_zowe_imperative.ioverridepromptconnprops.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1444,"kind":1024,"name":"propertyName","url":"interfaces/_zowe_imperative.ioverridepromptconnprops.html#propertyname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOverridePromptConnProps"},{"id":1445,"kind":1024,"name":"argumentName","url":"interfaces/_zowe_imperative.ioverridepromptconnprops.html#argumentname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOverridePromptConnProps"},{"id":1446,"kind":1024,"name":"propertiesOverridden","url":"interfaces/_zowe_imperative.ioverridepromptconnprops.html#propertiesoverridden","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOverridePromptConnProps"},{"id":1447,"kind":256,"name":"IOptionsForAddConnProps","url":"interfaces/_zowe_imperative.ioptionsforaddconnprops.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1448,"kind":1024,"name":"requestToken","url":"interfaces/_zowe_imperative.ioptionsforaddconnprops.html#requesttoken","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsForAddConnProps"},{"id":1449,"kind":1024,"name":"doPrompting","url":"interfaces/_zowe_imperative.ioptionsforaddconnprops.html#doprompting","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsForAddConnProps"},{"id":1450,"kind":1024,"name":"defaultTokenType","url":"interfaces/_zowe_imperative.ioptionsforaddconnprops.html#defaulttokentype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsForAddConnProps"},{"id":1451,"kind":1024,"name":"propertyOverrides","url":"interfaces/_zowe_imperative.ioptionsforaddconnprops.html#propertyoverrides","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsForAddConnProps"},{"id":1452,"kind":2048,"name":"getValuesBack","url":"interfaces/_zowe_imperative.ioptionsforaddconnprops.html#getvaluesback","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsForAddConnProps"},{"id":1453,"kind":1024,"name":"parms","url":"interfaces/_zowe_imperative.ioptionsforaddconnprops.html#parms","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsForAddConnProps"},{"id":1454,"kind":1024,"name":"serviceDescription","url":"interfaces/_zowe_imperative.ioptionsforaddconnprops.html#servicedescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsForAddConnProps"},{"id":1455,"kind":1024,"name":"autoStore","url":"interfaces/_zowe_imperative.ioptionsforaddconnprops.html#autostore","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IOptionsForAddConnProps"},{"id":1456,"kind":128,"name":"ConnectionPropsForSessCfg","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1457,"kind":2048,"name":"addPropsOrPrompt","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#addpropsorprompt","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"@zowe/imperative.ConnectionPropsForSessCfg"},{"id":1458,"kind":2048,"name":"resolveSessCfgProps","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#resolvesesscfgprops","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"@zowe/imperative.ConnectionPropsForSessCfg"},{"id":1459,"kind":2048,"name":"sessHasCreds","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#sesshascreds","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConnectionPropsForSessCfg"},{"id":1460,"kind":1024,"name":"secureSessCfgProps","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#securesesscfgprops","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConnectionPropsForSessCfg"},{"id":1461,"kind":2097152,"name":"promptTextForValues","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#prompttextforvalues","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConnectionPropsForSessCfg"},{"id":1462,"kind":32,"name":"hostname","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#prompttextforvalues.hostname","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ConnectionPropsForSessCfg.promptTextForValues"},{"id":1463,"kind":32,"name":"port","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#prompttextforvalues.port","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ConnectionPropsForSessCfg.promptTextForValues"},{"id":1464,"kind":32,"name":"user","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#prompttextforvalues.user","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ConnectionPropsForSessCfg.promptTextForValues"},{"id":1465,"kind":32,"name":"password","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#prompttextforvalues.password","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ConnectionPropsForSessCfg.promptTextForValues"},{"id":1466,"kind":2048,"name":"getValuesBack","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#getvaluesback","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConnectionPropsForSessCfg"},{"id":1467,"kind":2048,"name":"clientPrompt","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#clientprompt","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConnectionPropsForSessCfg"},{"id":1468,"kind":2048,"name":"setTypeForTokenRequest","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#settypefortokenrequest","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConnectionPropsForSessCfg"},{"id":1469,"kind":2048,"name":"logSessCfg","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#logsesscfg","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConnectionPropsForSessCfg"},{"id":1470,"kind":2048,"name":"propHasValue","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#prophasvalue","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConnectionPropsForSessCfg"},{"id":1471,"kind":2048,"name":"loadSchemaForSessCfgProps","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#loadschemaforsesscfgprops","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConnectionPropsForSessCfg"},{"id":1472,"kind":2048,"name":"loadSecureSessCfgProps","url":"classes/_zowe_imperative.connectionpropsforsesscfg.html#loadsecuresesscfgprops","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConnectionPropsForSessCfg"},{"id":1473,"kind":256,"name":"IAuthHandlerApi","url":"interfaces/_zowe_imperative.iauthhandlerapi.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1474,"kind":1024,"name":"promptParams","url":"interfaces/_zowe_imperative.iauthhandlerapi.html#promptparams","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IAuthHandlerApi"},{"id":1475,"kind":1024,"name":"createSessCfg","url":"interfaces/_zowe_imperative.iauthhandlerapi.html#createsesscfg","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IAuthHandlerApi"},{"id":1476,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iauthhandlerapi.html#createsesscfg.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IAuthHandlerApi.createSessCfg"},{"id":1477,"kind":1024,"name":"sessionLogin","url":"interfaces/_zowe_imperative.iauthhandlerapi.html#sessionlogin","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IAuthHandlerApi"},{"id":1478,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iauthhandlerapi.html#sessionlogin.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IAuthHandlerApi.sessionLogin"},{"id":1479,"kind":1024,"name":"sessionLogout","url":"interfaces/_zowe_imperative.iauthhandlerapi.html#sessionlogout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IAuthHandlerApi"},{"id":1480,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iauthhandlerapi.html#sessionlogout.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IAuthHandlerApi.sessionLogout"},{"id":1481,"kind":128,"name":"AbstractAuthHandler","url":"classes/_zowe_imperative.abstractauthhandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1482,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.abstractauthhandler.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractAuthHandler"},{"id":1483,"kind":1024,"name":"mDefaultTokenType","url":"classes/_zowe_imperative.abstractauthhandler.html#mdefaulttokentype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractAuthHandler"},{"id":1484,"kind":1024,"name":"mServiceDescription","url":"classes/_zowe_imperative.abstractauthhandler.html#mservicedescription","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractAuthHandler"},{"id":1485,"kind":2048,"name":"process","url":"classes/_zowe_imperative.abstractauthhandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractAuthHandler"},{"id":1486,"kind":2048,"name":"getPromptParams","url":"classes/_zowe_imperative.abstractauthhandler.html#getpromptparams","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractAuthHandler"},{"id":1487,"kind":2048,"name":"getAuthHandlerApi","url":"classes/_zowe_imperative.abstractauthhandler.html#getauthhandlerapi","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractAuthHandler"},{"id":1488,"kind":2048,"name":"createSessCfgFromArgs","url":"classes/_zowe_imperative.abstractauthhandler.html#createsesscfgfromargs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractAuthHandler"},{"id":1489,"kind":2048,"name":"processLogin","url":"classes/_zowe_imperative.abstractauthhandler.html#processlogin","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractAuthHandler"},{"id":1490,"kind":2048,"name":"processLogout","url":"classes/_zowe_imperative.abstractauthhandler.html#processlogout","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractAuthHandler"},{"id":1491,"kind":256,"name":"IConfigAutoStoreFindActiveProfileOpts","url":"interfaces/_zowe_imperative.iconfigautostorefindactiveprofileopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1492,"kind":1024,"name":"params","url":"interfaces/_zowe_imperative.iconfigautostorefindactiveprofileopts.html#params","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreFindActiveProfileOpts"},{"id":1493,"kind":1024,"name":"profileProps","url":"interfaces/_zowe_imperative.iconfigautostorefindactiveprofileopts.html#profileprops","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreFindActiveProfileOpts"},{"id":1494,"kind":1024,"name":"profileTypes","url":"interfaces/_zowe_imperative.iconfigautostorefindactiveprofileopts.html#profiletypes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreFindActiveProfileOpts"},{"id":1495,"kind":1024,"name":"defaultProfileName","url":"interfaces/_zowe_imperative.iconfigautostorefindactiveprofileopts.html#defaultprofilename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreFindActiveProfileOpts"},{"id":1496,"kind":256,"name":"IConfigAutoStoreFindAuthHandlerForProfileOpts","url":"interfaces/_zowe_imperative.iconfigautostorefindauthhandlerforprofileopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1497,"kind":1024,"name":"profilePath","url":"interfaces/_zowe_imperative.iconfigautostorefindauthhandlerforprofileopts.html#profilepath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreFindAuthHandlerForProfileOpts"},{"id":1498,"kind":1024,"name":"cmdArguments","url":"interfaces/_zowe_imperative.iconfigautostorefindauthhandlerforprofileopts.html#cmdarguments","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreFindAuthHandlerForProfileOpts"},{"id":1499,"kind":1024,"name":"defaultBaseProfileName","url":"interfaces/_zowe_imperative.iconfigautostorefindauthhandlerforprofileopts.html#defaultbaseprofilename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreFindAuthHandlerForProfileOpts"},{"id":1500,"kind":1024,"name":"config","url":"interfaces/_zowe_imperative.iconfigautostorefindauthhandlerforprofileopts.html#config","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreFindAuthHandlerForProfileOpts"},{"id":1501,"kind":1024,"name":"params","url":"interfaces/_zowe_imperative.iconfigautostorefindauthhandlerforprofileopts.html#params","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IConfigAutoStoreFindAuthHandlerForProfileOpts"},{"id":1502,"kind":1024,"name":"profileProps","url":"interfaces/_zowe_imperative.iconfigautostorefindauthhandlerforprofileopts.html#profileprops","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IConfigAutoStoreFindAuthHandlerForProfileOpts"},{"id":1503,"kind":1024,"name":"profileTypes","url":"interfaces/_zowe_imperative.iconfigautostorefindauthhandlerforprofileopts.html#profiletypes","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IConfigAutoStoreFindAuthHandlerForProfileOpts"},{"id":1504,"kind":1024,"name":"defaultProfileName","url":"interfaces/_zowe_imperative.iconfigautostorefindauthhandlerforprofileopts.html#defaultprofilename","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IConfigAutoStoreFindAuthHandlerForProfileOpts"},{"id":1505,"kind":256,"name":"IConfigAutoStoreStoreSessCfgPropsOpts","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1506,"kind":1024,"name":"sessCfg","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#sesscfg","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1507,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#sesscfg.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts.sessCfg"},{"id":1508,"kind":1024,"name":"propsToStore","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#propstostore","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1509,"kind":1024,"name":"profileName","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#profilename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1510,"kind":1024,"name":"profileType","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#profiletype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1511,"kind":1024,"name":"setSecure","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#setsecure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1512,"kind":1024,"name":"profilePath","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#profilepath","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1513,"kind":1024,"name":"cmdArguments","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#cmdarguments","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1514,"kind":1024,"name":"defaultBaseProfileName","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#defaultbaseprofilename","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1515,"kind":1024,"name":"config","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#config","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1516,"kind":1024,"name":"params","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#params","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1517,"kind":1024,"name":"profileProps","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#profileprops","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1518,"kind":1024,"name":"profileTypes","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#profiletypes","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1519,"kind":1024,"name":"defaultProfileName","url":"interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html#defaultprofilename","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IConfigAutoStoreStoreSessCfgPropsOpts"},{"id":1520,"kind":128,"name":"ConfigAutoStore","url":"classes/_zowe_imperative.configautostore.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1521,"kind":2048,"name":"findActiveProfile","url":"classes/_zowe_imperative.configautostore.html#findactiveprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigAutoStore"},{"id":1522,"kind":2048,"name":"_findActiveProfile","url":"classes/_zowe_imperative.configautostore.html#_findactiveprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigAutoStore"},{"id":1523,"kind":2048,"name":"findAuthHandlerForProfile","url":"classes/_zowe_imperative.configautostore.html#findauthhandlerforprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigAutoStore"},{"id":1524,"kind":2048,"name":"_findAuthHandlerForProfile","url":"classes/_zowe_imperative.configautostore.html#_findauthhandlerforprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigAutoStore"},{"id":1525,"kind":2048,"name":"storeSessCfgProps","url":"classes/_zowe_imperative.configautostore.html#storesesscfgprops","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigAutoStore"},{"id":1526,"kind":2048,"name":"_storeSessCfgProps","url":"classes/_zowe_imperative.configautostore.html#_storesesscfgprops","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigAutoStore"},{"id":1527,"kind":2048,"name":"fetchTokenForSessCfg","url":"classes/_zowe_imperative.configautostore.html#fetchtokenforsesscfg","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigAutoStore"},{"id":1528,"kind":2048,"name":"_fetchTokenForSessCfg","url":"classes/_zowe_imperative.configautostore.html#_fetchtokenforsesscfg","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigAutoStore"},{"id":1529,"kind":128,"name":"ConfigSchema","url":"classes/_zowe_imperative.configschema.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1530,"kind":1024,"name":"JSON_SCHEMA","url":"classes/_zowe_imperative.configschema.html#json_schema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigSchema"},{"id":1531,"kind":1024,"name":"SCHEMA_VERSION","url":"classes/_zowe_imperative.configschema.html#schema_version","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigSchema"},{"id":1532,"kind":2097152,"name":"explainSchemaSummary","url":"classes/_zowe_imperative.configschema.html#explainschemasummary","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigSchema"},{"id":1533,"kind":32,"name":"$schema","url":"classes/_zowe_imperative.configschema.html#explainschemasummary._schema","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ConfigSchema.explainSchemaSummary"},{"id":1534,"kind":32,"name":"$version","url":"classes/_zowe_imperative.configschema.html#explainschemasummary._version","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ConfigSchema.explainSchemaSummary"},{"id":1535,"kind":2097152,"name":"properties","url":"classes/_zowe_imperative.configschema.html#explainschemasummary.properties","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/imperative.ConfigSchema.explainSchemaSummary"},{"id":1536,"kind":32,"name":"defaults","url":"classes/_zowe_imperative.configschema.html#explainschemasummary.properties.defaults","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ConfigSchema.explainSchemaSummary.properties"},{"id":1537,"kind":32,"name":"explainedParentKey","url":"classes/_zowe_imperative.configschema.html#explainschemasummary.properties.explainedparentkey-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ConfigSchema.explainSchemaSummary.properties"},{"id":1538,"kind":32,"name":"ignoredKeys","url":"classes/_zowe_imperative.configschema.html#explainschemasummary.properties.ignoredkeys-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ConfigSchema.explainSchemaSummary.properties"},{"id":1539,"kind":32,"name":"explainedParentKey","url":"classes/_zowe_imperative.configschema.html#explainschemasummary.explainedparentkey","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ConfigSchema.explainSchemaSummary"},{"id":1540,"kind":32,"name":"ignoredKeys","url":"classes/_zowe_imperative.configschema.html#explainschemasummary.ignoredkeys","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ConfigSchema.explainSchemaSummary"},{"id":1541,"kind":2048,"name":"generateSchema","url":"classes/_zowe_imperative.configschema.html#generateschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigSchema"},{"id":1542,"kind":2048,"name":"parseSchema","url":"classes/_zowe_imperative.configschema.html#parseschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigSchema"},{"id":1543,"kind":2048,"name":"_updateSchemaActive","url":"classes/_zowe_imperative.configschema.html#_updateschemaactive","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigSchema"},{"id":1544,"kind":2048,"name":"_updateSchemaGlobal","url":"classes/_zowe_imperative.configschema.html#_updateschemaglobal","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigSchema"},{"id":1545,"kind":2048,"name":"_updateSchemaAll","url":"classes/_zowe_imperative.configschema.html#_updateschemaall","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigSchema"},{"id":1546,"kind":2048,"name":"buildSchema","url":"classes/_zowe_imperative.configschema.html#buildschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigSchema"},{"id":1547,"kind":2048,"name":"loadSchema","url":"classes/_zowe_imperative.configschema.html#loadschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigSchema"},{"id":1548,"kind":2048,"name":"updateSchema","url":"classes/_zowe_imperative.configschema.html#updateschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigSchema"},{"id":1549,"kind":2048,"name":"findPropertyType","url":"classes/_zowe_imperative.configschema.html#findpropertytype","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigSchema"},{"id":1550,"kind":256,"name":"IApimlSvcAttrs","url":"interfaces/_zowe_imperative.iapimlsvcattrs.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1551,"kind":1024,"name":"apiId","url":"interfaces/_zowe_imperative.iapimlsvcattrs.html#apiid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IApimlSvcAttrs"},{"id":1552,"kind":1024,"name":"gatewayUrl","url":"interfaces/_zowe_imperative.iapimlsvcattrs.html#gatewayurl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IApimlSvcAttrs"},{"id":1553,"kind":1024,"name":"connProfType","url":"interfaces/_zowe_imperative.iapimlsvcattrs.html#connproftype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IApimlSvcAttrs"},{"id":1554,"kind":256,"name":"IDaemonContext","url":"interfaces/_zowe_imperative.idaemoncontext.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1555,"kind":1024,"name":"stream","url":"interfaces/_zowe_imperative.idaemoncontext.html#stream","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonContext"},{"id":1556,"kind":1024,"name":"stdinStream","url":"interfaces/_zowe_imperative.idaemoncontext.html#stdinstream","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonContext"},{"id":1557,"kind":1024,"name":"response","url":"interfaces/_zowe_imperative.idaemoncontext.html#response","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDaemonContext"},{"id":1558,"kind":256,"name":"IImperativeLoggingConfig","url":"interfaces/_zowe_imperative.iimperativeloggingconfig.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1559,"kind":1024,"name":"logFile","url":"interfaces/_zowe_imperative.iimperativeloggingconfig.html#logfile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeLoggingConfig"},{"id":1560,"kind":1024,"name":"level","url":"interfaces/_zowe_imperative.iimperativeloggingconfig.html#level","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeLoggingConfig"},{"id":1561,"kind":1024,"name":"apiName","url":"interfaces/_zowe_imperative.iimperativeloggingconfig.html#apiname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeLoggingConfig"},{"id":1562,"kind":128,"name":"ConfigurationLoader","url":"classes/_zowe_imperative.configurationloader.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1563,"kind":2048,"name":"load","url":"classes/_zowe_imperative.configurationloader.html#load","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigurationLoader"},{"id":1564,"kind":128,"name":"ConfigurationValidator","url":"classes/_zowe_imperative.configurationvalidator.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1565,"kind":2048,"name":"validate","url":"classes/_zowe_imperative.configurationvalidator.html#validate","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigurationValidator"},{"id":1566,"kind":2048,"name":"verifyChalkColor","url":"classes/_zowe_imperative.configurationvalidator.html#verifychalkcolor","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigurationValidator"},{"id":1567,"kind":128,"name":"DefinitionTreeResolver","url":"classes/_zowe_imperative.definitiontreeresolver.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1568,"kind":2048,"name":"resolve","url":"classes/_zowe_imperative.definitiontreeresolver.html#resolve","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.DefinitionTreeResolver"},{"id":1569,"kind":2048,"name":"combineAllCmdDefs","url":"classes/_zowe_imperative.definitiontreeresolver.html#combineallcmddefs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.DefinitionTreeResolver"},{"id":1570,"kind":2048,"name":"addBaseProfile","url":"classes/_zowe_imperative.definitiontreeresolver.html#addbaseprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.DefinitionTreeResolver"},{"id":1571,"kind":262144,"name":"log","url":"classes/_zowe_imperative.definitiontreeresolver.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.DefinitionTreeResolver"},{"id":1572,"kind":128,"name":"LoggerConfigBuilder","url":"classes/_zowe_imperative.loggerconfigbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1573,"kind":1024,"name":"DEFAULT_LANG","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default_lang","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1574,"kind":1024,"name":"DEFAULT_LOG_TYPE_CONSOLE","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default_log_type_console","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1575,"kind":1024,"name":"DEFAULT_LOG_TYPE_PAT","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default_log_type_pat","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1576,"kind":1024,"name":"DEFAULT_LOG_LAYOUT","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default_log_layout","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1577,"kind":1024,"name":"DEFAULT_COLOR_LAYOUT","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default_color_layout","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1578,"kind":1024,"name":"DEFAULT_LOG_TYPE_FILE_SYNC","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default_log_type_file_sync","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1579,"kind":1024,"name":"DEFAULT_BACKEND","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default_backend","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1580,"kind":1024,"name":"DEFAULT","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1581,"kind":1024,"name":"DEFAULT_LOG_DIR","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default_log_dir","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1582,"kind":1024,"name":"DEFAULT_LOG_FILE_DIR","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default_log_file_dir","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1583,"kind":1024,"name":"DEFAULT_LOG_FILE_EXT","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default_log_file_ext","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1584,"kind":1024,"name":"DEFAULT_LOG_FILE_MAX_SIZE","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default_log_file_max_size","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1585,"kind":1024,"name":"DEFAULT_LOG_FILE_BACKUPS","url":"classes/_zowe_imperative.loggerconfigbuilder.html#default_log_file_backups","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1586,"kind":2048,"name":"buildFullLogFile","url":"classes/_zowe_imperative.loggerconfigbuilder.html#buildfulllogfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1587,"kind":2048,"name":"getDefaultIConfigLogging","url":"classes/_zowe_imperative.loggerconfigbuilder.html#getdefaulticonfiglogging","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1588,"kind":2048,"name":"addConsoleAppender","url":"classes/_zowe_imperative.loggerconfigbuilder.html#addconsoleappender","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1589,"kind":2048,"name":"addFileAppender","url":"classes/_zowe_imperative.loggerconfigbuilder.html#addfileappender","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1590,"kind":2048,"name":"getDefaultFileName","url":"classes/_zowe_imperative.loggerconfigbuilder.html#getdefaultfilename","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1591,"kind":2048,"name":"getDefaultLogLevel","url":"classes/_zowe_imperative.loggerconfigbuilder.html#getdefaultloglevel","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerConfigBuilder"},{"id":1592,"kind":256,"name":"IImperativeApi","url":"interfaces/_zowe_imperative.iimperativeapi.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1593,"kind":1024,"name":"imperativeLogger","url":"interfaces/_zowe_imperative.iimperativeapi.html#imperativelogger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeApi"},{"id":1594,"kind":1024,"name":"appLogger","url":"interfaces/_zowe_imperative.iimperativeapi.html#applogger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeApi"},{"id":1595,"kind":128,"name":"ImperativeApi","url":"classes/_zowe_imperative.imperativeapi.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1596,"kind":1024,"name":"mLog","url":"classes/_zowe_imperative.imperativeapi.html#mlog","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeApi"},{"id":1597,"kind":1024,"name":"mCustomLoggerMap","url":"classes/_zowe_imperative.imperativeapi.html#mcustomloggermap","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeApi"},{"id":1598,"kind":65536,"name":"__type","url":"classes/_zowe_imperative.imperativeapi.html#mcustomloggermap.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.ImperativeApi.mCustomLoggerMap"},{"id":1599,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.imperativeapi.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeApi"},{"id":1600,"kind":1024,"name":"mApis","url":"classes/_zowe_imperative.imperativeapi.html#mapis","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeApi"},{"id":1601,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.imperativeapi.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeApi"},{"id":1602,"kind":1024,"name":"mHome","url":"classes/_zowe_imperative.imperativeapi.html#mhome","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeApi"},{"id":1603,"kind":262144,"name":"imperativeLogger","url":"classes/_zowe_imperative.imperativeapi.html#imperativelogger","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeApi"},{"id":1604,"kind":262144,"name":"appLogger","url":"classes/_zowe_imperative.imperativeapi.html#applogger","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeApi"},{"id":1605,"kind":2048,"name":"additionalLogger","url":"classes/_zowe_imperative.imperativeapi.html#additionallogger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeApi"},{"id":1606,"kind":2048,"name":"addAdditionalLogger","url":"classes/_zowe_imperative.imperativeapi.html#addadditionallogger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeApi"},{"id":1607,"kind":2048,"name":"profileManager","url":"classes/_zowe_imperative.imperativeapi.html#profilemanager","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeApi"},{"id":1608,"kind":128,"name":"LoggingConfigurer","url":"classes/_zowe_imperative.loggingconfigurer.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1609,"kind":2048,"name":"configureLogger","url":"classes/_zowe_imperative.loggingconfigurer.html#configurelogger","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggingConfigurer"},{"id":1610,"kind":2048,"name":"configureImperativeLogger","url":"classes/_zowe_imperative.loggingconfigurer.html#configureimperativelogger","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggingConfigurer"},{"id":1611,"kind":2048,"name":"configureAppLogger","url":"classes/_zowe_imperative.loggingconfigurer.html#configureapplogger","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggingConfigurer"},{"id":1612,"kind":2048,"name":"configureLoggerByKey","url":"classes/_zowe_imperative.loggingconfigurer.html#configureloggerbykey","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggingConfigurer"},{"id":1613,"kind":2048,"name":"configureLoggerByKeyHelper","url":"classes/_zowe_imperative.loggingconfigurer.html#configureloggerbykeyhelper","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggingConfigurer"},{"id":1614,"kind":2048,"name":"buildLoggingDefaults","url":"classes/_zowe_imperative.loggingconfigurer.html#buildloggingdefaults","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggingConfigurer"},{"id":1615,"kind":2048,"name":"buildImperativeLoggingDefaults","url":"classes/_zowe_imperative.loggingconfigurer.html#buildimperativeloggingdefaults","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggingConfigurer"},{"id":1616,"kind":2048,"name":"buildAppLoggingDefaults","url":"classes/_zowe_imperative.loggingconfigurer.html#buildapploggingdefaults","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggingConfigurer"},{"id":1617,"kind":2048,"name":"buildLoggingDefaultsByKey","url":"classes/_zowe_imperative.loggingconfigurer.html#buildloggingdefaultsbykey","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggingConfigurer"},{"id":1618,"kind":2048,"name":"normalizeDir","url":"classes/_zowe_imperative.loggingconfigurer.html#normalizedir","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggingConfigurer"},{"id":1619,"kind":128,"name":"UpdateImpConfig","url":"classes/_zowe_imperative.updateimpconfig.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1620,"kind":2048,"name":"addCmdGrp","url":"classes/_zowe_imperative.updateimpconfig.html#addcmdgrp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.UpdateImpConfig"},{"id":1621,"kind":2048,"name":"addProfiles","url":"classes/_zowe_imperative.updateimpconfig.html#addprofiles","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.UpdateImpConfig"},{"id":1622,"kind":128,"name":"PMFConstants","url":"classes/_zowe_imperative.pmfconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1623,"kind":1024,"name":"mInstance","url":"classes/_zowe_imperative.pmfconstants.html#minstance","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.PMFConstants"},{"id":1624,"kind":262144,"name":"instance","url":"classes/_zowe_imperative.pmfconstants.html#instance","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.PMFConstants"},{"id":1625,"kind":1024,"name":"CLI_CORE_PKG_NAME","url":"classes/_zowe_imperative.pmfconstants.html#cli_core_pkg_name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.PMFConstants"},{"id":1626,"kind":1024,"name":"IMPERATIVE_PKG_NAME","url":"classes/_zowe_imperative.pmfconstants.html#imperative_pkg_name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.PMFConstants"},{"id":1627,"kind":1024,"name":"NPM_NAMESPACE","url":"classes/_zowe_imperative.pmfconstants.html#npm_namespace","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.PMFConstants"},{"id":1628,"kind":1024,"name":"PMF_ROOT","url":"classes/_zowe_imperative.pmfconstants.html#pmf_root","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.PMFConstants"},{"id":1629,"kind":1024,"name":"PLUGIN_JSON","url":"classes/_zowe_imperative.pmfconstants.html#plugin_json","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.PMFConstants"},{"id":1630,"kind":1024,"name":"PLUGIN_INSTALL_LOCATION","url":"classes/_zowe_imperative.pmfconstants.html#plugin_install_location","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.PMFConstants"},{"id":1631,"kind":1024,"name":"PLUGIN_NODE_MODULE_LOCATION","url":"classes/_zowe_imperative.pmfconstants.html#plugin_node_module_location","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.PMFConstants"},{"id":1632,"kind":1024,"name":"PLUGIN_USING_CONFIG","url":"classes/_zowe_imperative.pmfconstants.html#plugin_using_config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.PMFConstants"},{"id":1633,"kind":1024,"name":"PLUGIN_CONFIG","url":"classes/_zowe_imperative.pmfconstants.html#plugin_config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.PMFConstants"},{"id":1634,"kind":1024,"name":"PLUGIN_HOME_LOCATION","url":"classes/_zowe_imperative.pmfconstants.html#plugin_home_location","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.PMFConstants"},{"id":1635,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.pmfconstants.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.PMFConstants"},{"id":1636,"kind":256,"name":"IPluginPeerDepends","url":"interfaces/_zowe_imperative.ipluginpeerdepends.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1637,"kind":1024,"name":"peerDepName","url":"interfaces/_zowe_imperative.ipluginpeerdepends.html#peerdepname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPluginPeerDepends"},{"id":1638,"kind":1024,"name":"peerDepVer","url":"interfaces/_zowe_imperative.ipluginpeerdepends.html#peerdepver","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPluginPeerDepends"},{"id":1639,"kind":256,"name":"IPluginCfgProps","url":"interfaces/_zowe_imperative.iplugincfgprops.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1640,"kind":1024,"name":"pluginName","url":"interfaces/_zowe_imperative.iplugincfgprops.html#pluginname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPluginCfgProps"},{"id":1641,"kind":1024,"name":"npmPackageName","url":"interfaces/_zowe_imperative.iplugincfgprops.html#npmpackagename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPluginCfgProps"},{"id":1642,"kind":1024,"name":"impConfig","url":"interfaces/_zowe_imperative.iplugincfgprops.html#impconfig","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPluginCfgProps"},{"id":1643,"kind":1024,"name":"cliDependency","url":"interfaces/_zowe_imperative.iplugincfgprops.html#clidependency","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPluginCfgProps"},{"id":1644,"kind":1024,"name":"impDependency","url":"interfaces/_zowe_imperative.iplugincfgprops.html#impdependency","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPluginCfgProps"},{"id":1645,"kind":256,"name":"IPluginIssues","url":"interfaces/_zowe_imperative.ipluginissues.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1646,"kind":256,"name":"IPluginIssue","url":"interfaces/_zowe_imperative.ipluginissue.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1647,"kind":1024,"name":"issueText","url":"interfaces/_zowe_imperative.ipluginissue.html#issuetext","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPluginIssue"},{"id":1648,"kind":1024,"name":"issueSev","url":"interfaces/_zowe_imperative.ipluginissue.html#issuesev","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPluginIssue"},{"id":1649,"kind":256,"name":"IPluginJsonObject","url":"interfaces/_zowe_imperative.ipluginjsonobject.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1650,"kind":1024,"name":"package","url":"interfaces/_zowe_imperative.ipluginjsonobject.html#package","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPluginJsonObject"},{"id":1651,"kind":1024,"name":"registry","url":"interfaces/_zowe_imperative.ipluginjsonobject.html#registry","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPluginJsonObject"},{"id":1652,"kind":1024,"name":"version","url":"interfaces/_zowe_imperative.ipluginjsonobject.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IPluginJsonObject"},{"id":1653,"kind":256,"name":"IPluginJson","url":"interfaces/_zowe_imperative.ipluginjson.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1654,"kind":4,"name":"IssueSeverity","url":"enums/_zowe_imperative.issueseverity.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1655,"kind":16,"name":"CFG_ERROR","url":"enums/_zowe_imperative.issueseverity.html#cfg_error","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.IssueSeverity"},{"id":1656,"kind":16,"name":"CMD_ERROR","url":"enums/_zowe_imperative.issueseverity.html#cmd_error","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.IssueSeverity"},{"id":1657,"kind":16,"name":"OVER_ERROR","url":"enums/_zowe_imperative.issueseverity.html#over_error","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.IssueSeverity"},{"id":1658,"kind":16,"name":"WARNING","url":"enums/_zowe_imperative.issueseverity.html#warning","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.IssueSeverity"},{"id":1659,"kind":128,"name":"PluginIssues","url":"classes/_zowe_imperative.pluginissues.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1660,"kind":1024,"name":"mInstance","url":"classes/_zowe_imperative.pluginissues.html#minstance","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.PluginIssues"},{"id":1661,"kind":1024,"name":"pluginIssues","url":"classes/_zowe_imperative.pluginissues.html#pluginissues","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginIssues"},{"id":1662,"kind":1024,"name":"installedPlugins","url":"classes/_zowe_imperative.pluginissues.html#installedplugins","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginIssues"},{"id":1663,"kind":262144,"name":"instance","url":"classes/_zowe_imperative.pluginissues.html#instance","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.PluginIssues"},{"id":1664,"kind":2048,"name":"doesPluginHaveIssueSev","url":"classes/_zowe_imperative.pluginissues.html#doespluginhaveissuesev","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.PluginIssues"},{"id":1665,"kind":2048,"name":"getAllIssues","url":"classes/_zowe_imperative.pluginissues.html#getallissues","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.PluginIssues"},{"id":1666,"kind":2048,"name":"getInstalledPlugins","url":"classes/_zowe_imperative.pluginissues.html#getinstalledplugins","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.PluginIssues"},{"id":1667,"kind":2048,"name":"getIssueListForPlugin","url":"classes/_zowe_imperative.pluginissues.html#getissuelistforplugin","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.PluginIssues"},{"id":1668,"kind":2048,"name":"removeIssuesForPlugin","url":"classes/_zowe_imperative.pluginissues.html#removeissuesforplugin","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.PluginIssues"},{"id":1669,"kind":2048,"name":"recordIssue","url":"classes/_zowe_imperative.pluginissues.html#recordissue","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.PluginIssues"},{"id":1670,"kind":256,"name":"ISettingsFilePersistence","url":"interfaces/_zowe_imperative.isettingsfilepersistence.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1671,"kind":2048,"name":"read","url":"interfaces/_zowe_imperative.isettingsfilepersistence.html#read","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.ISettingsFilePersistence"},{"id":1672,"kind":2048,"name":"write","url":"interfaces/_zowe_imperative.isettingsfilepersistence.html#write","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.ISettingsFilePersistence"},{"id":1673,"kind":128,"name":"JSONSettingsFilePersistence","url":"classes/_zowe_imperative.jsonsettingsfilepersistence.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1674,"kind":1024,"name":"path","url":"classes/_zowe_imperative.jsonsettingsfilepersistence.html#path","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.JSONSettingsFilePersistence"},{"id":1675,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.jsonsettingsfilepersistence.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.JSONSettingsFilePersistence"},{"id":1676,"kind":1024,"name":"settingsFile","url":"classes/_zowe_imperative.jsonsettingsfilepersistence.html#settingsfile","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.JSONSettingsFilePersistence"},{"id":1677,"kind":2048,"name":"read","url":"classes/_zowe_imperative.jsonsettingsfilepersistence.html#read","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.JSONSettingsFilePersistence"},{"id":1678,"kind":2048,"name":"write","url":"classes/_zowe_imperative.jsonsettingsfilepersistence.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.JSONSettingsFilePersistence"},{"id":1679,"kind":128,"name":"AppSettings","url":"classes/_zowe_imperative.appsettings.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1680,"kind":2048,"name":"initialize","url":"classes/_zowe_imperative.appsettings.html#initialize","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AppSettings"},{"id":1681,"kind":1024,"name":"mInstance","url":"classes/_zowe_imperative.appsettings.html#minstance","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.AppSettings"},{"id":1682,"kind":1024,"name":"settings","url":"classes/_zowe_imperative.appsettings.html#settings","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AppSettings"},{"id":1683,"kind":1024,"name":"persistence","url":"classes/_zowe_imperative.appsettings.html#persistence","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AppSettings"},{"id":1684,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.appsettings.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.AppSettings"},{"id":1685,"kind":262144,"name":"instance","url":"classes/_zowe_imperative.appsettings.html#instance","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AppSettings"},{"id":1686,"kind":262144,"name":"initialized","url":"classes/_zowe_imperative.appsettings.html#initialized","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AppSettings"},{"id":1687,"kind":2048,"name":"set","url":"classes/_zowe_imperative.appsettings.html#set","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AppSettings"},{"id":1688,"kind":2048,"name":"get","url":"classes/_zowe_imperative.appsettings.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AppSettings"},{"id":1689,"kind":2048,"name":"getNamespace","url":"classes/_zowe_imperative.appsettings.html#getnamespace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AppSettings"},{"id":1690,"kind":2048,"name":"getSettings","url":"classes/_zowe_imperative.appsettings.html#getsettings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AppSettings"},{"id":1691,"kind":2048,"name":"flush","url":"classes/_zowe_imperative.appsettings.html#flush","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AppSettings"},{"id":1692,"kind":128,"name":"PluginManagementFacility","url":"classes/_zowe_imperative.pluginmanagementfacility.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1693,"kind":1024,"name":"mInstance","url":"classes/_zowe_imperative.pluginmanagementfacility.html#minstance","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1694,"kind":262144,"name":"instance","url":"classes/_zowe_imperative.pluginmanagementfacility.html#instance","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1695,"kind":1024,"name":"mAllPluginCfgProps","url":"classes/_zowe_imperative.pluginmanagementfacility.html#mallplugincfgprops","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1696,"kind":262144,"name":"allPluginCfgProps","url":"classes/_zowe_imperative.pluginmanagementfacility.html#allplugincfgprops","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1697,"kind":1024,"name":"mPluginOverrides","url":"classes/_zowe_imperative.pluginmanagementfacility.html#mpluginoverrides","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1698,"kind":262144,"name":"pluginOverrides","url":"classes/_zowe_imperative.pluginmanagementfacility.html#pluginoverrides","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1699,"kind":1024,"name":"pmfConst","url":"classes/_zowe_imperative.pluginmanagementfacility.html#pmfconst","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1700,"kind":1024,"name":"resolvedCliCmdTree","url":"classes/_zowe_imperative.pluginmanagementfacility.html#resolvedclicmdtree","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1701,"kind":1024,"name":"impConfigPropNm","url":"classes/_zowe_imperative.pluginmanagementfacility.html#impconfigpropnm","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1702,"kind":1024,"name":"impLogger","url":"classes/_zowe_imperative.pluginmanagementfacility.html#implogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1703,"kind":1024,"name":"pluginIssues","url":"classes/_zowe_imperative.pluginmanagementfacility.html#pluginissues","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1704,"kind":1024,"name":"npmPkgNmProp","url":"classes/_zowe_imperative.pluginmanagementfacility.html#npmpkgnmprop","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1705,"kind":1024,"name":"noPeerDependency","url":"classes/_zowe_imperative.pluginmanagementfacility.html#nopeerdependency","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1706,"kind":1024,"name":"semver","url":"classes/_zowe_imperative.pluginmanagementfacility.html#semver","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1707,"kind":1024,"name":"wasInitCalled","url":"classes/_zowe_imperative.pluginmanagementfacility.html#wasinitcalled","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1708,"kind":2048,"name":"init","url":"classes/_zowe_imperative.pluginmanagementfacility.html#init","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1709,"kind":2048,"name":"addAllPluginsToHostCli","url":"classes/_zowe_imperative.pluginmanagementfacility.html#addallpluginstohostcli","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1710,"kind":2048,"name":"loadAllPluginCfgProps","url":"classes/_zowe_imperative.pluginmanagementfacility.html#loadallplugincfgprops","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1711,"kind":2048,"name":"requirePluginModuleCallback","url":"classes/_zowe_imperative.pluginmanagementfacility.html#requirepluginmodulecallback","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1712,"kind":2048,"name":"addPluginToHostCli","url":"classes/_zowe_imperative.pluginmanagementfacility.html#addplugintohostcli","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1713,"kind":2048,"name":"addCmdGrpToResolvedCliCmdTree","url":"classes/_zowe_imperative.pluginmanagementfacility.html#addcmdgrptoresolvedclicmdtree","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1714,"kind":2048,"name":"comparePluginVersionToCli","url":"classes/_zowe_imperative.pluginmanagementfacility.html#comparepluginversiontocli","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1715,"kind":2048,"name":"getCliPkgName","url":"classes/_zowe_imperative.pluginmanagementfacility.html#getclipkgname","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1716,"kind":2048,"name":"removeCmdGrpFromResolvedCliCmdTree","url":"classes/_zowe_imperative.pluginmanagementfacility.html#removecmdgrpfromresolvedclicmdtree","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1717,"kind":2048,"name":"conflictingNameOrAlias","url":"classes/_zowe_imperative.pluginmanagementfacility.html#conflictingnameoralias","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1718,"kind":2048,"name":"formPluginRuntimePath","url":"classes/_zowe_imperative.pluginmanagementfacility.html#formpluginruntimepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1719,"kind":2048,"name":"loadPluginCfgProps","url":"classes/_zowe_imperative.pluginmanagementfacility.html#loadplugincfgprops","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1720,"kind":2048,"name":"useOverrideThatFails","url":"classes/_zowe_imperative.pluginmanagementfacility.html#useoverridethatfails","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1721,"kind":2048,"name":"validatePeerDepVersions","url":"classes/_zowe_imperative.pluginmanagementfacility.html#validatepeerdepversions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1722,"kind":2048,"name":"validatePlugin","url":"classes/_zowe_imperative.pluginmanagementfacility.html#validateplugin","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1723,"kind":2048,"name":"validatePluginCmdDefs","url":"classes/_zowe_imperative.pluginmanagementfacility.html#validateplugincmddefs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1724,"kind":2048,"name":"validatePluginProfiles","url":"classes/_zowe_imperative.pluginmanagementfacility.html#validatepluginprofiles","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginManagementFacility"},{"id":1725,"kind":256,"name":"ICommandTreeEntry","url":"interfaces/_zowe_imperative.icommandtreeentry.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1726,"kind":1024,"name":"command","url":"interfaces/_zowe_imperative.icommandtreeentry.html#command","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandTreeEntry"},{"id":1727,"kind":1024,"name":"fullName","url":"interfaces/_zowe_imperative.icommandtreeentry.html#fullname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandTreeEntry"},{"id":1728,"kind":1024,"name":"tree","url":"interfaces/_zowe_imperative.icommandtreeentry.html#tree","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandTreeEntry"},{"id":1729,"kind":128,"name":"CommandUtils","url":"classes/_zowe_imperative.commandutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1730,"kind":2048,"name":"reconstructCommand","url":"classes/_zowe_imperative.commandutils.html#reconstructcommand","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CommandUtils"},{"id":1731,"kind":2048,"name":"optionWasSpecified","url":"classes/_zowe_imperative.commandutils.html#optionwasspecified","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CommandUtils"},{"id":1732,"kind":2048,"name":"getOptionDefinitionFromName","url":"classes/_zowe_imperative.commandutils.html#getoptiondefinitionfromname","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CommandUtils"},{"id":1733,"kind":2048,"name":"addChildAndDescendantsToSearch","url":"classes/_zowe_imperative.commandutils.html#addchildanddescendantstosearch","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandUtils"},{"id":1734,"kind":2048,"name":"flattenCommandTree","url":"classes/_zowe_imperative.commandutils.html#flattencommandtree","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CommandUtils"},{"id":1735,"kind":2048,"name":"flattenCommandTreeWithAliases","url":"classes/_zowe_imperative.commandutils.html#flattencommandtreewithaliases","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CommandUtils"},{"id":1736,"kind":2048,"name":"getFullCommandName","url":"classes/_zowe_imperative.commandutils.html#getfullcommandname","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CommandUtils"},{"id":1737,"kind":4194304,"name":"CommandSegment","url":"modules/_zowe_imperative.html#commandsegment","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1738,"kind":256,"name":"ICommandValidatorResponse","url":"interfaces/_zowe_imperative.icommandvalidatorresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1739,"kind":1024,"name":"valid","url":"interfaces/_zowe_imperative.icommandvalidatorresponse.html#valid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandValidatorResponse"},{"id":1740,"kind":256,"name":"IMessageDefinition","url":"interfaces/_zowe_imperative.imessagedefinition.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1741,"kind":1024,"name":"message","url":"interfaces/_zowe_imperative.imessagedefinition.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IMessageDefinition"},{"id":1742,"kind":1024,"name":"locales","url":"interfaces/_zowe_imperative.imessagedefinition.html#locales","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IMessageDefinition"},{"id":1743,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.imessagedefinition.html#locales.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IMessageDefinition.locales"},{"id":1744,"kind":2097152,"name":"apiErrorHeader","url":"modules/_zowe_imperative.html#apierrorheader","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1745,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#apierrorheader.message","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.apiErrorHeader"},{"id":1746,"kind":2097152,"name":"couldNotInstantiateCommandHandler","url":"modules/_zowe_imperative.html#couldnotinstantiatecommandhandler","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1747,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#couldnotinstantiatecommandhandler.message-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.couldNotInstantiateCommandHandler"},{"id":1748,"kind":2097152,"name":"errorDetailsHeader","url":"modules/_zowe_imperative.html#errordetailsheader","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1749,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#errordetailsheader.message-26","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.errorDetailsHeader"},{"id":1750,"kind":2097152,"name":"unexpectedCommandError","url":"modules/_zowe_imperative.html#unexpectedcommanderror","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1751,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#unexpectedcommanderror.message-68","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.unexpectedCommandError"},{"id":1752,"kind":2097152,"name":"unexpectedCommandPreparationError","url":"modules/_zowe_imperative.html#unexpectedcommandpreparationerror","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1753,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#unexpectedcommandpreparationerror.message-69","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.unexpectedCommandPreparationError"},{"id":1754,"kind":2097152,"name":"unableToLoadRequestedProfilesError","url":"modules/_zowe_imperative.html#unabletoloadrequestedprofileserror","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1755,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#unabletoloadrequestedprofileserror.message-67","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.unableToLoadRequestedProfilesError"},{"id":1756,"kind":2097152,"name":"unexpectedProfileLoadError","url":"modules/_zowe_imperative.html#unexpectedprofileloaderror","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1757,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#unexpectedprofileloaderror.message-71","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.unexpectedProfileLoadError"},{"id":1758,"kind":2097152,"name":"profileLoadError","url":"modules/_zowe_imperative.html#profileloaderror","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1759,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#profileloaderror.message-50","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profileLoadError"},{"id":1760,"kind":2097152,"name":"unexpectedProfilesLoadError","url":"modules/_zowe_imperative.html#unexpectedprofilesloaderror","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1761,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#unexpectedprofilesloaderror.message-73","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.unexpectedProfilesLoadError"},{"id":1762,"kind":2097152,"name":"syntaxErrorHeader","url":"modules/_zowe_imperative.html#syntaxerrorheader","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1763,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#syntaxerrorheader.message-63","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.syntaxErrorHeader"},{"id":1764,"kind":2097152,"name":"createProfilesCommandSummary","url":"modules/_zowe_imperative.html#createprofilescommandsummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1765,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#createprofilescommandsummary.message-16","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.createProfilesCommandSummary"},{"id":1766,"kind":2097152,"name":"createProfilesCommandDesc","url":"modules/_zowe_imperative.html#createprofilescommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1767,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#createprofilescommanddesc.message-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.createProfilesCommandDesc"},{"id":1768,"kind":2097152,"name":"createProfileCommandDesc","url":"modules/_zowe_imperative.html#createprofilecommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1769,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#createprofilecommanddesc.message-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.createProfileCommandDesc"},{"id":1770,"kind":2097152,"name":"createProfileOptionDesc","url":"modules/_zowe_imperative.html#createprofileoptiondesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1771,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#createprofileoptiondesc.message-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.createProfileOptionDesc"},{"id":1772,"kind":2097152,"name":"listProfileLoadedModulesOptionDesc","url":"modules/_zowe_imperative.html#listprofileloadedmodulesoptiondesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1773,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listprofileloadedmodulesoptiondesc.message-36","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listProfileLoadedModulesOptionDesc"},{"id":1774,"kind":2097152,"name":"listProfileVerboseOptionDesc","url":"modules/_zowe_imperative.html#listprofileverboseoptiondesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1775,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listprofileverboseoptiondesc.message-37","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listProfileVerboseOptionDesc"},{"id":1776,"kind":2097152,"name":"listProfileExample","url":"modules/_zowe_imperative.html#listprofileexample","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1777,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listprofileexample.message-34","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listProfileExample"},{"id":1778,"kind":2097152,"name":"listProfileExampleShowContents","url":"modules/_zowe_imperative.html#listprofileexampleshowcontents","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1779,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listprofileexampleshowcontents.message-35","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listProfileExampleShowContents"},{"id":1780,"kind":2097152,"name":"deleteProfileNameDesc","url":"modules/_zowe_imperative.html#deleteprofilenamedesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1781,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#deleteprofilenamedesc.message-22","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.deleteProfileNameDesc"},{"id":1782,"kind":2097152,"name":"deleteProfileExample","url":"modules/_zowe_imperative.html#deleteprofileexample","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1783,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#deleteprofileexample.message-20","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.deleteProfileExample"},{"id":1784,"kind":2097152,"name":"validateProfileNameDesc","url":"modules/_zowe_imperative.html#validateprofilenamedesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1785,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#validateprofilenamedesc.message-80","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateProfileNameDesc"},{"id":1786,"kind":2097152,"name":"selectProfileNameDesc","url":"modules/_zowe_imperative.html#selectprofilenamedesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1787,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#selectprofilenamedesc.message-54","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.selectProfileNameDesc"},{"id":1788,"kind":2097152,"name":"createProfileOptionOverwriteDesc","url":"modules/_zowe_imperative.html#createprofileoptionoverwritedesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1789,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#createprofileoptionoverwritedesc.message-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.createProfileOptionOverwriteDesc"},{"id":1790,"kind":2097152,"name":"createProfileDisableDefaultsDesc","url":"modules/_zowe_imperative.html#createprofiledisabledefaultsdesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1791,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#createprofiledisabledefaultsdesc.message-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.createProfileDisableDefaultsDesc"},{"id":1792,"kind":2097152,"name":"deleteProfilesCommandSummary","url":"modules/_zowe_imperative.html#deleteprofilescommandsummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1793,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#deleteprofilescommandsummary.message-24","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.deleteProfilesCommandSummary"},{"id":1794,"kind":2097152,"name":"deleteProfilesCommandDesc","url":"modules/_zowe_imperative.html#deleteprofilescommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1795,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#deleteprofilescommanddesc.message-23","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.deleteProfilesCommandDesc"},{"id":1796,"kind":2097152,"name":"deleteProfileForceOptionDesc","url":"modules/_zowe_imperative.html#deleteprofileforceoptiondesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1797,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#deleteprofileforceoptiondesc.message-21","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.deleteProfileForceOptionDesc"},{"id":1798,"kind":2097152,"name":"deleteProfileActionDesc","url":"modules/_zowe_imperative.html#deleteprofileactiondesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1799,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#deleteprofileactiondesc.message-17","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.deleteProfileActionDesc"},{"id":1800,"kind":2097152,"name":"deleteProfileCommandDesc","url":"modules/_zowe_imperative.html#deleteprofilecommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1801,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#deleteprofilecommanddesc.message-18","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.deleteProfileCommandDesc"},{"id":1802,"kind":2097152,"name":"deleteProfileDepsDesc","url":"modules/_zowe_imperative.html#deleteprofiledepsdesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1803,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#deleteprofiledepsdesc.message-19","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.deleteProfileDepsDesc"},{"id":1804,"kind":2097152,"name":"showDependenciesCommandDesc","url":"modules/_zowe_imperative.html#showdependenciescommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1805,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#showdependenciescommanddesc.message-62","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.showDependenciesCommandDesc"},{"id":1806,"kind":2097152,"name":"listProfileCommandSummary","url":"modules/_zowe_imperative.html#listprofilecommandsummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1807,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listprofilecommandsummary.message-33","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listProfileCommandSummary"},{"id":1808,"kind":2097152,"name":"listProfileCommandDesc","url":"modules/_zowe_imperative.html#listprofilecommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1809,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listprofilecommanddesc.message-32","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listProfileCommandDesc"},{"id":1810,"kind":2097152,"name":"listProfilesFoundMessage","url":"modules/_zowe_imperative.html#listprofilesfoundmessage","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1811,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listprofilesfoundmessage.message-38","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listProfilesFoundMessage"},{"id":1812,"kind":2097152,"name":"listProfilesNotFoundMessage","url":"modules/_zowe_imperative.html#listprofilesnotfoundmessage","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1813,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listprofilesnotfoundmessage.message-39","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listProfilesNotFoundMessage"},{"id":1814,"kind":2097152,"name":"validateProfileCommandSummary","url":"modules/_zowe_imperative.html#validateprofilecommandsummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1815,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#validateprofilecommandsummary.message-78","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateProfileCommandSummary"},{"id":1816,"kind":2097152,"name":"validateProfileGroupDesc","url":"modules/_zowe_imperative.html#validateprofilegroupdesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1817,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#validateprofilegroupdesc.message-79","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateProfileGroupDesc"},{"id":1818,"kind":2097152,"name":"validateProfileCommandDesc","url":"modules/_zowe_imperative.html#validateprofilecommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1819,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#validateprofilecommanddesc.message-77","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateProfileCommandDesc"},{"id":1820,"kind":2097152,"name":"validateProfileOptionDesc","url":"modules/_zowe_imperative.html#validateprofileoptiondesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1821,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#validateprofileoptiondesc.message-81","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateProfileOptionDesc"},{"id":1822,"kind":2097152,"name":"detailProfileCommandDesc","url":"modules/_zowe_imperative.html#detailprofilecommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1823,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#detailprofilecommanddesc.message-25","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.detailProfileCommandDesc"},{"id":1824,"kind":2097152,"name":"updateProfileActionDesc","url":"modules/_zowe_imperative.html#updateprofileactiondesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1825,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#updateprofileactiondesc.message-74","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateProfileActionDesc"},{"id":1826,"kind":2097152,"name":"updateProfileCommandSummary","url":"modules/_zowe_imperative.html#updateprofilecommandsummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1827,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#updateprofilecommandsummary.message-76","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateProfileCommandSummary"},{"id":1828,"kind":2097152,"name":"updateProfileCommandDesc","url":"modules/_zowe_imperative.html#updateprofilecommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1829,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#updateprofilecommanddesc.message-75","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateProfileCommandDesc"},{"id":1830,"kind":2097152,"name":"listGroupWithOnlyProfilesSummary","url":"modules/_zowe_imperative.html#listgroupwithonlyprofilessummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1831,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listgroupwithonlyprofilessummary.message-31","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listGroupWithOnlyProfilesSummary"},{"id":1832,"kind":2097152,"name":"listGroupWithOnlyProfilesDefinition","url":"modules/_zowe_imperative.html#listgroupwithonlyprofilesdefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1833,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listgroupwithonlyprofilesdefinition.message-30","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listGroupWithOnlyProfilesDefinition"},{"id":1834,"kind":2097152,"name":"listGroupWithOnlyProfileDefaultDesc","url":"modules/_zowe_imperative.html#listgroupwithonlyprofiledefaultdesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1835,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listgroupwithonlyprofiledefaultdesc.message-28","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listGroupWithOnlyProfileDefaultDesc"},{"id":1836,"kind":2097152,"name":"listGroupWithOnlyProfileCommandSummary","url":"modules/_zowe_imperative.html#listgroupwithonlyprofilecommandsummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1837,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listgroupwithonlyprofilecommandsummary.message-27","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listGroupWithOnlyProfileCommandSummary"},{"id":1838,"kind":2097152,"name":"listGroupWithOnlyProfileSetDesc","url":"modules/_zowe_imperative.html#listgroupwithonlyprofilesetdesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1839,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#listgroupwithonlyprofilesetdesc.message-29","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listGroupWithOnlyProfileSetDesc"},{"id":1840,"kind":2097152,"name":"setProfileActionSummary","url":"modules/_zowe_imperative.html#setprofileactionsummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1841,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#setprofileactionsummary.message-59","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setProfileActionSummary"},{"id":1842,"kind":2097152,"name":"setProfileActionDesc","url":"modules/_zowe_imperative.html#setprofileactiondesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1843,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#setprofileactiondesc.message-58","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setProfileActionDesc"},{"id":1844,"kind":2097152,"name":"setGroupWithOnlyProfilesSummary","url":"modules/_zowe_imperative.html#setgroupwithonlyprofilessummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1845,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#setgroupwithonlyprofilessummary.message-57","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setGroupWithOnlyProfilesSummary"},{"id":1846,"kind":2097152,"name":"setGroupWithOnlyProfilesCommandDesc","url":"modules/_zowe_imperative.html#setgroupwithonlyprofilescommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1847,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#setgroupwithonlyprofilescommanddesc.message-55","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setGroupWithOnlyProfilesCommandDesc"},{"id":1848,"kind":2097152,"name":"setProfileOptionDesc","url":"modules/_zowe_imperative.html#setprofileoptiondesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1849,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#setprofileoptiondesc.message-61","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setProfileOptionDesc"},{"id":1850,"kind":2097152,"name":"setProfileExample","url":"modules/_zowe_imperative.html#setprofileexample","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1851,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#setprofileexample.message-60","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setProfileExample"},{"id":1852,"kind":2097152,"name":"setGroupWithOnlyProfilesListDesc","url":"modules/_zowe_imperative.html#setgroupwithonlyprofileslistdesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1853,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#setgroupwithonlyprofileslistdesc.message-56","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setGroupWithOnlyProfilesListDesc"},{"id":1854,"kind":2097152,"name":"profileCreatedSuccessfullyAndPath","url":"modules/_zowe_imperative.html#profilecreatedsuccessfullyandpath","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1855,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#profilecreatedsuccessfullyandpath.message-45","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profileCreatedSuccessfullyAndPath"},{"id":1856,"kind":2097152,"name":"profileUpdatedSuccessfullyAndPath","url":"modules/_zowe_imperative.html#profileupdatedsuccessfullyandpath","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1857,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#profileupdatedsuccessfullyandpath.message-53","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profileUpdatedSuccessfullyAndPath"},{"id":1858,"kind":2097152,"name":"profileReviewMessage","url":"modules/_zowe_imperative.html#profilereviewmessage","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1859,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#profilereviewmessage.message-52","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profileReviewMessage"},{"id":1860,"kind":2097152,"name":"profileCreateErrorHeader","url":"modules/_zowe_imperative.html#profilecreateerrorheader","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1861,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#profilecreateerrorheader.message-43","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profileCreateErrorHeader"},{"id":1862,"kind":2097152,"name":"unableToCreateProfile","url":"modules/_zowe_imperative.html#unabletocreateprofile","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1863,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#unabletocreateprofile.message-64","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.unableToCreateProfile"},{"id":1864,"kind":2097152,"name":"profileCreateErrorDetails","url":"modules/_zowe_imperative.html#profilecreateerrordetails","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1865,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#profilecreateerrordetails.message-42","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profileCreateErrorDetails"},{"id":1866,"kind":2097152,"name":"profileNotDeletedMessage","url":"modules/_zowe_imperative.html#profilenotdeletedmessage","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1867,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#profilenotdeletedmessage.message-51","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profileNotDeletedMessage"},{"id":1868,"kind":2097152,"name":"profileDeletedSuccessfully","url":"modules/_zowe_imperative.html#profiledeletedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1869,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#profiledeletedsuccessfully.message-48","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profileDeletedSuccessfully"},{"id":1870,"kind":2097152,"name":"profileDeleteErrorHeader","url":"modules/_zowe_imperative.html#profiledeleteerrorheader","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1871,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#profiledeleteerrorheader.message-47","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profileDeleteErrorHeader"},{"id":1872,"kind":2097152,"name":"unableToDeleteProfile","url":"modules/_zowe_imperative.html#unabletodeleteprofile","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1873,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#unabletodeleteprofile.message-65","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.unableToDeleteProfile"},{"id":1874,"kind":2097152,"name":"unableToFindProfile","url":"modules/_zowe_imperative.html#unabletofindprofile","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1875,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#unabletofindprofile.message-66","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.unableToFindProfile"},{"id":1876,"kind":2097152,"name":"profileDeleteErrorDetails","url":"modules/_zowe_imperative.html#profiledeleteerrordetails","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1877,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#profiledeleteerrordetails.message-46","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profileDeleteErrorDetails"},{"id":1878,"kind":2097152,"name":"overroteProfileMessage","url":"modules/_zowe_imperative.html#overroteprofilemessage","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1879,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#overroteprofilemessage.message-41","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.overroteProfileMessage"},{"id":1880,"kind":2097152,"name":"profileDesc","url":"modules/_zowe_imperative.html#profiledesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1881,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#profiledesc.message-49","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profileDesc"},{"id":1882,"kind":2097152,"name":"locateProfilesDesc","url":"modules/_zowe_imperative.html#locateprofilesdesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1883,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#locateprofilesdesc.message-40","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.locateProfilesDesc"},{"id":1884,"kind":2097152,"name":"profileCreatedSuccessfully","url":"modules/_zowe_imperative.html#profilecreatedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1885,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#profilecreatedsuccessfully.message-44","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profileCreatedSuccessfully"},{"id":1886,"kind":2097152,"name":"unexpectedProfileCreationError","url":"modules/_zowe_imperative.html#unexpectedprofilecreationerror","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1887,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#unexpectedprofilecreationerror.message-70","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.unexpectedProfileCreationError"},{"id":1888,"kind":2097152,"name":"unexpectedProfileUpdateError","url":"modules/_zowe_imperative.html#unexpectedprofileupdateerror","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1889,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#unexpectedprofileupdateerror.message-72","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.unexpectedProfileUpdateError"},{"id":1890,"kind":2097152,"name":"authCategoryDesc","url":"modules/_zowe_imperative.html#authcategorydesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1891,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#authcategorydesc.message-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.authCategoryDesc"},{"id":1892,"kind":2097152,"name":"authLoginGroupSummary","url":"modules/_zowe_imperative.html#authlogingroupsummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1893,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#authlogingroupsummary.message-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.authLoginGroupSummary"},{"id":1894,"kind":2097152,"name":"authLoginGroupDesc","url":"modules/_zowe_imperative.html#authlogingroupdesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1895,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#authlogingroupdesc.message-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.authLoginGroupDesc"},{"id":1896,"kind":2097152,"name":"authLoginCommandDesc","url":"modules/_zowe_imperative.html#authlogincommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1897,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#authlogincommanddesc.message-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.authLoginCommandDesc"},{"id":1898,"kind":2097152,"name":"authLoginShowTokenDesc","url":"modules/_zowe_imperative.html#authloginshowtokendesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1899,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#authloginshowtokendesc.message-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.authLoginShowTokenDesc"},{"id":1900,"kind":2097152,"name":"authLogoutGroupSummary","url":"modules/_zowe_imperative.html#authlogoutgroupsummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1901,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#authlogoutgroupsummary.message-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.authLogoutGroupSummary"},{"id":1902,"kind":2097152,"name":"authLogoutGroupDesc","url":"modules/_zowe_imperative.html#authlogoutgroupdesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1903,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#authlogoutgroupdesc.message-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.authLogoutGroupDesc"},{"id":1904,"kind":2097152,"name":"authLogoutCommandDesc","url":"modules/_zowe_imperative.html#authlogoutcommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1905,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#authlogoutcommanddesc.message-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.authLogoutCommandDesc"},{"id":1906,"kind":2097152,"name":"autoInitCommandDesc","url":"modules/_zowe_imperative.html#autoinitcommanddesc","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1907,"kind":32,"name":"message","url":"modules/_zowe_imperative.html#autoinitcommanddesc.message-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.autoInitCommandDesc"},{"id":1908,"kind":256,"name":"ICommandResponse","url":"interfaces/_zowe_imperative.icommandresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1909,"kind":1024,"name":"success","url":"interfaces/_zowe_imperative.icommandresponse.html#success","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponse"},{"id":1910,"kind":1024,"name":"exitCode","url":"interfaces/_zowe_imperative.icommandresponse.html#exitcode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponse"},{"id":1911,"kind":1024,"name":"message","url":"interfaces/_zowe_imperative.icommandresponse.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponse"},{"id":1912,"kind":1024,"name":"stdout","url":"interfaces/_zowe_imperative.icommandresponse.html#stdout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponse"},{"id":1913,"kind":1024,"name":"stderr","url":"interfaces/_zowe_imperative.icommandresponse.html#stderr","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponse"},{"id":1914,"kind":1024,"name":"data","url":"interfaces/_zowe_imperative.icommandresponse.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponse"},{"id":1915,"kind":1024,"name":"error","url":"interfaces/_zowe_imperative.icommandresponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponse"},{"id":1916,"kind":256,"name":"ICommandResponseApi","url":"interfaces/_zowe_imperative.icommandresponseapi.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1917,"kind":1024,"name":"responseFormat","url":"interfaces/_zowe_imperative.icommandresponseapi.html#responseformat","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseApi"},{"id":1918,"kind":1024,"name":"silent","url":"interfaces/_zowe_imperative.icommandresponseapi.html#silent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseApi"},{"id":1919,"kind":2048,"name":"failed","url":"interfaces/_zowe_imperative.icommandresponseapi.html#failed","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseApi"},{"id":1920,"kind":2048,"name":"succeeded","url":"interfaces/_zowe_imperative.icommandresponseapi.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseApi"},{"id":1921,"kind":2048,"name":"setError","url":"interfaces/_zowe_imperative.icommandresponseapi.html#seterror","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseApi"},{"id":1922,"kind":2048,"name":"buildJsonResponse","url":"interfaces/_zowe_imperative.icommandresponseapi.html#buildjsonresponse","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseApi"},{"id":1923,"kind":2048,"name":"writeJsonResponse","url":"interfaces/_zowe_imperative.icommandresponseapi.html#writejsonresponse","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseApi"},{"id":1924,"kind":2048,"name":"endProgressBar","url":"interfaces/_zowe_imperative.icommandresponseapi.html#endprogressbar","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseApi"},{"id":1925,"kind":4194304,"name":"COMMAND_RESPONSE_FORMAT","url":"modules/_zowe_imperative.html#command_response_format","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1926,"kind":256,"name":"ICommandResponseParms","url":"interfaces/_zowe_imperative.icommandresponseparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1927,"kind":1024,"name":"stream","url":"interfaces/_zowe_imperative.icommandresponseparms.html#stream","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseParms"},{"id":1928,"kind":1024,"name":"args","url":"interfaces/_zowe_imperative.icommandresponseparms.html#args","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseParms"},{"id":1929,"kind":1024,"name":"definition","url":"interfaces/_zowe_imperative.icommandresponseparms.html#definition","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseParms"},{"id":1930,"kind":1024,"name":"primaryTextColor","url":"interfaces/_zowe_imperative.icommandresponseparms.html#primarytextcolor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseParms"},{"id":1931,"kind":1024,"name":"silent","url":"interfaces/_zowe_imperative.icommandresponseparms.html#silent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseParms"},{"id":1932,"kind":1024,"name":"responseFormat","url":"interfaces/_zowe_imperative.icommandresponseparms.html#responseformat","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseParms"},{"id":1933,"kind":1024,"name":"progressBarSpinner","url":"interfaces/_zowe_imperative.icommandresponseparms.html#progressbarspinner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandResponseParms"},{"id":1934,"kind":128,"name":"OptionConstants","url":"classes/_zowe_imperative.optionconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1935,"kind":2097152,"name":"RESPONSE_FORMAT_FILTER_OPTION","url":"classes/_zowe_imperative.optionconstants.html#response_format_filter_option","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.OptionConstants"},{"id":1936,"kind":32,"name":"name","url":"classes/_zowe_imperative.optionconstants.html#response_format_filter_option.name","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_FILTER_OPTION"},{"id":1937,"kind":32,"name":"aliases","url":"classes/_zowe_imperative.optionconstants.html#response_format_filter_option.aliases","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_FILTER_OPTION"},{"id":1938,"kind":32,"name":"description","url":"classes/_zowe_imperative.optionconstants.html#response_format_filter_option.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_FILTER_OPTION"},{"id":1939,"kind":32,"name":"type","url":"classes/_zowe_imperative.optionconstants.html#response_format_filter_option.type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_FILTER_OPTION"},{"id":1940,"kind":32,"name":"group","url":"classes/_zowe_imperative.optionconstants.html#response_format_filter_option.group","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_FILTER_OPTION"},{"id":1941,"kind":2097152,"name":"RESPONSE_FORMAT_HEADER_OPTION","url":"classes/_zowe_imperative.optionconstants.html#response_format_header_option","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.OptionConstants"},{"id":1942,"kind":32,"name":"name","url":"classes/_zowe_imperative.optionconstants.html#response_format_header_option.name-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_HEADER_OPTION"},{"id":1943,"kind":32,"name":"aliases","url":"classes/_zowe_imperative.optionconstants.html#response_format_header_option.aliases-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_HEADER_OPTION"},{"id":1944,"kind":32,"name":"description","url":"classes/_zowe_imperative.optionconstants.html#response_format_header_option.description-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_HEADER_OPTION"},{"id":1945,"kind":32,"name":"type","url":"classes/_zowe_imperative.optionconstants.html#response_format_header_option.type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_HEADER_OPTION"},{"id":1946,"kind":32,"name":"group","url":"classes/_zowe_imperative.optionconstants.html#response_format_header_option.group-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_HEADER_OPTION"},{"id":1947,"kind":32,"name":"defaultValue","url":"classes/_zowe_imperative.optionconstants.html#response_format_header_option.defaultvalue","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_HEADER_OPTION"},{"id":1948,"kind":1024,"name":"RESPONSE_FORMAT_TYPES","url":"classes/_zowe_imperative.optionconstants.html#response_format_types","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.OptionConstants"},{"id":1949,"kind":2097152,"name":"RESPONSE_FORMAT_OPTION","url":"classes/_zowe_imperative.optionconstants.html#response_format_option","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.OptionConstants"},{"id":1950,"kind":32,"name":"name","url":"classes/_zowe_imperative.optionconstants.html#response_format_option.name-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_OPTION"},{"id":1951,"kind":32,"name":"aliases","url":"classes/_zowe_imperative.optionconstants.html#response_format_option.aliases-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_OPTION"},{"id":1952,"kind":32,"name":"description","url":"classes/_zowe_imperative.optionconstants.html#response_format_option.description-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_OPTION"},{"id":1953,"kind":32,"name":"type","url":"classes/_zowe_imperative.optionconstants.html#response_format_option.type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_OPTION"},{"id":1954,"kind":2097152,"name":"allowableValues","url":"classes/_zowe_imperative.optionconstants.html#response_format_option.allowablevalues","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_OPTION"},{"id":1955,"kind":32,"name":"values","url":"classes/_zowe_imperative.optionconstants.html#response_format_option.allowablevalues.values","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_OPTION.allowableValues"},{"id":1956,"kind":32,"name":"caseSensitive","url":"classes/_zowe_imperative.optionconstants.html#response_format_option.allowablevalues.casesensitive","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_OPTION.allowableValues"},{"id":1957,"kind":32,"name":"group","url":"classes/_zowe_imperative.optionconstants.html#response_format_option.group-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.OptionConstants.RESPONSE_FORMAT_OPTION"},{"id":1958,"kind":128,"name":"CommandResponse","url":"classes/_zowe_imperative.commandresponse.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":1959,"kind":1024,"name":"RESPONSE_ERR_TAG","url":"classes/_zowe_imperative.commandresponse.html#response_err_tag","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandResponse"},{"id":1960,"kind":1024,"name":"MAX_COLUMN_WIDTH","url":"classes/_zowe_imperative.commandresponse.html#max_column_width","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandResponse"},{"id":1961,"kind":1024,"name":"mControl","url":"classes/_zowe_imperative.commandresponse.html#mcontrol","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1962,"kind":1024,"name":"mSilent","url":"classes/_zowe_imperative.commandresponse.html#msilent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1963,"kind":1024,"name":"mSucceeded","url":"classes/_zowe_imperative.commandresponse.html#msucceeded","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1964,"kind":1024,"name":"mExitCode","url":"classes/_zowe_imperative.commandresponse.html#mexitcode","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1965,"kind":1024,"name":"mPrimaryTextColor","url":"classes/_zowe_imperative.commandresponse.html#mprimarytextcolor","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1966,"kind":1024,"name":"mStderr","url":"classes/_zowe_imperative.commandresponse.html#mstderr","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1967,"kind":1024,"name":"mStdout","url":"classes/_zowe_imperative.commandresponse.html#mstdout","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1968,"kind":1024,"name":"mMessage","url":"classes/_zowe_imperative.commandresponse.html#mmessage","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1969,"kind":1024,"name":"mData","url":"classes/_zowe_imperative.commandresponse.html#mdata","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1970,"kind":1024,"name":"mError","url":"classes/_zowe_imperative.commandresponse.html#merror","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1971,"kind":1024,"name":"mProgressBar","url":"classes/_zowe_imperative.commandresponse.html#mprogressbar","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1972,"kind":1024,"name":"mProgressApi","url":"classes/_zowe_imperative.commandresponse.html#mprogressapi","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1973,"kind":1024,"name":"mDataApi","url":"classes/_zowe_imperative.commandresponse.html#mdataapi","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1974,"kind":1024,"name":"mConsoleApi","url":"classes/_zowe_imperative.commandresponse.html#mconsoleapi","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1975,"kind":1024,"name":"mFormatApi","url":"classes/_zowe_imperative.commandresponse.html#mformatapi","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1976,"kind":1024,"name":"mResponseFormat","url":"classes/_zowe_imperative.commandresponse.html#mresponseformat","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1977,"kind":1024,"name":"mProgressBarSpinnerChars","url":"classes/_zowe_imperative.commandresponse.html#mprogressbarspinnerchars","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1978,"kind":1024,"name":"mDefinition","url":"classes/_zowe_imperative.commandresponse.html#mdefinition","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1979,"kind":1024,"name":"mArguments","url":"classes/_zowe_imperative.commandresponse.html#marguments","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1980,"kind":1024,"name":"mStream","url":"classes/_zowe_imperative.commandresponse.html#mstream","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1981,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.commandresponse.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1982,"kind":262144,"name":"format","url":"classes/_zowe_imperative.commandresponse.html#format","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1983,"kind":262144,"name":"console","url":"classes/_zowe_imperative.commandresponse.html#console","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1984,"kind":262144,"name":"data","url":"classes/_zowe_imperative.commandresponse.html#data","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1985,"kind":262144,"name":"progress","url":"classes/_zowe_imperative.commandresponse.html#progress","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1986,"kind":262144,"name":"silent","url":"classes/_zowe_imperative.commandresponse.html#silent","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1987,"kind":2048,"name":"failed","url":"classes/_zowe_imperative.commandresponse.html#failed","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1988,"kind":2048,"name":"succeeded","url":"classes/_zowe_imperative.commandresponse.html#succeeded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1989,"kind":2048,"name":"bufferStdout","url":"classes/_zowe_imperative.commandresponse.html#bufferstdout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1990,"kind":2048,"name":"bufferStderr","url":"classes/_zowe_imperative.commandresponse.html#bufferstderr","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1991,"kind":2048,"name":"setError","url":"classes/_zowe_imperative.commandresponse.html#seterror","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1992,"kind":2048,"name":"buildJsonResponse","url":"classes/_zowe_imperative.commandresponse.html#buildjsonresponse","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1993,"kind":2048,"name":"writeJsonResponse","url":"classes/_zowe_imperative.commandresponse.html#writejsonresponse","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1994,"kind":262144,"name":"responseFormat","url":"classes/_zowe_imperative.commandresponse.html#responseformat","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1995,"kind":2048,"name":"endProgressBar","url":"classes/_zowe_imperative.commandresponse.html#endprogressbar","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandResponse"},{"id":1996,"kind":2048,"name":"endStream","url":"classes/_zowe_imperative.commandresponse.html#endstream","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1997,"kind":2048,"name":"setDaemonExitCode","url":"classes/_zowe_imperative.commandresponse.html#setdaemonexitcode","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1998,"kind":262144,"name":"control","url":"classes/_zowe_imperative.commandresponse.html#control","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":1999,"kind":2048,"name":"formatMessage","url":"classes/_zowe_imperative.commandresponse.html#formatmessage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":2000,"kind":2048,"name":"writeAndBufferStdout","url":"classes/_zowe_imperative.commandresponse.html#writeandbufferstdout","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":2001,"kind":2048,"name":"writeStdout","url":"classes/_zowe_imperative.commandresponse.html#writestdout","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":2002,"kind":2048,"name":"writeStream","url":"classes/_zowe_imperative.commandresponse.html#writestream","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":2003,"kind":2048,"name":"writeAndBufferStderr","url":"classes/_zowe_imperative.commandresponse.html#writeandbufferstderr","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":2004,"kind":2048,"name":"writeStderr","url":"classes/_zowe_imperative.commandresponse.html#writestderr","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":2005,"kind":2048,"name":"write","url":"classes/_zowe_imperative.commandresponse.html#write","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandResponse"},{"id":2006,"kind":128,"name":"SharedOptions","url":"classes/_zowe_imperative.sharedoptions.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2007,"kind":2048,"name":"readStdinIfRequested","url":"classes/_zowe_imperative.sharedoptions.html#readstdinifrequested","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.SharedOptions"},{"id":2008,"kind":2048,"name":"readStdin","url":"classes/_zowe_imperative.sharedoptions.html#readstdin","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.SharedOptions"},{"id":2009,"kind":256,"name":"ICommandValidatorError","url":"interfaces/_zowe_imperative.icommandvalidatorerror.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2010,"kind":1024,"name":"message","url":"interfaces/_zowe_imperative.icommandvalidatorerror.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandValidatorError"},{"id":2011,"kind":1024,"name":"optionInError","url":"interfaces/_zowe_imperative.icommandvalidatorerror.html#optioninerror","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandValidatorError"},{"id":2012,"kind":1024,"name":"definition","url":"interfaces/_zowe_imperative.icommandvalidatorerror.html#definition","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandValidatorError"},{"id":2013,"kind":128,"name":"SyntaxValidator","url":"classes/_zowe_imperative.syntaxvalidator.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2014,"kind":1024,"name":"SHORT","url":"classes/_zowe_imperative.syntaxvalidator.html#short","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.SyntaxValidator"},{"id":2015,"kind":1024,"name":"LONG","url":"classes/_zowe_imperative.syntaxvalidator.html#long","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.SyntaxValidator"},{"id":2016,"kind":1024,"name":"mCommandDefinition","url":"classes/_zowe_imperative.syntaxvalidator.html#mcommanddefinition","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2017,"kind":1024,"name":"mDefinitionTree","url":"classes/_zowe_imperative.syntaxvalidator.html#mdefinitiontree","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2018,"kind":1024,"name":"mOptionDefinitionsMap","url":"classes/_zowe_imperative.syntaxvalidator.html#moptiondefinitionsmap","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2019,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.syntaxvalidator.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2020,"kind":1024,"name":"mErrorList","url":"classes/_zowe_imperative.syntaxvalidator.html#merrorlist","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2021,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.syntaxvalidator.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.SyntaxValidator"},{"id":2022,"kind":2048,"name":"validate","url":"classes/_zowe_imperative.syntaxvalidator.html#validate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.SyntaxValidator"},{"id":2023,"kind":2048,"name":"validateSyntax","url":"classes/_zowe_imperative.syntaxvalidator.html#validatesyntax","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2024,"kind":2048,"name":"invalidJsonString","url":"classes/_zowe_imperative.syntaxvalidator.html#invalidjsonstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2025,"kind":2048,"name":"fileOptionError","url":"classes/_zowe_imperative.syntaxvalidator.html#fileoptionerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2026,"kind":2048,"name":"getMustacheSummaryForOption","url":"classes/_zowe_imperative.syntaxvalidator.html#getmustachesummaryforoption","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2027,"kind":2048,"name":"getDashFormOfOption","url":"classes/_zowe_imperative.syntaxvalidator.html#getdashformofoption","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2028,"kind":2048,"name":"getOptionDefinitionFromName","url":"classes/_zowe_imperative.syntaxvalidator.html#getoptiondefinitionfromname","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2029,"kind":2048,"name":"checkIfAllowable","url":"classes/_zowe_imperative.syntaxvalidator.html#checkifallowable","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2030,"kind":2048,"name":"missingOptionError","url":"classes/_zowe_imperative.syntaxvalidator.html#missingoptionerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2031,"kind":2048,"name":"positionalParameterInvalid","url":"classes/_zowe_imperative.syntaxvalidator.html#positionalparameterinvalid","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2032,"kind":2048,"name":"validateOptionValueRange","url":"classes/_zowe_imperative.syntaxvalidator.html#validateoptionvaluerange","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2033,"kind":2048,"name":"validateOptionValueLength","url":"classes/_zowe_imperative.syntaxvalidator.html#validateoptionvaluelength","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2034,"kind":2048,"name":"validateArrayDuplicate","url":"classes/_zowe_imperative.syntaxvalidator.html#validatearrayduplicate","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2035,"kind":2048,"name":"optionDependencyError","url":"classes/_zowe_imperative.syntaxvalidator.html#optiondependencyerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2036,"kind":2048,"name":"implicationAlternativeError","url":"classes/_zowe_imperative.syntaxvalidator.html#implicationalternativeerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2037,"kind":2048,"name":"absenceImplicationError","url":"classes/_zowe_imperative.syntaxvalidator.html#absenceimplicationerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2038,"kind":2048,"name":"optionCombinationInvalidError","url":"classes/_zowe_imperative.syntaxvalidator.html#optioncombinationinvaliderror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2039,"kind":2048,"name":"specifiedMultipleTimesError","url":"classes/_zowe_imperative.syntaxvalidator.html#specifiedmultipletimeserror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2040,"kind":2048,"name":"notAnArrayError","url":"classes/_zowe_imperative.syntaxvalidator.html#notanarrayerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2041,"kind":2048,"name":"invalidOptionError","url":"classes/_zowe_imperative.syntaxvalidator.html#invalidoptionerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2042,"kind":2048,"name":"valueRequiresAdditionalOption","url":"classes/_zowe_imperative.syntaxvalidator.html#valuerequiresadditionaloption","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2043,"kind":2048,"name":"validateBoolean","url":"classes/_zowe_imperative.syntaxvalidator.html#validateboolean","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2044,"kind":2048,"name":"validateNumeric","url":"classes/_zowe_imperative.syntaxvalidator.html#validatenumeric","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2045,"kind":2048,"name":"mustSpecifyOneError","url":"classes/_zowe_imperative.syntaxvalidator.html#mustspecifyoneerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2046,"kind":2048,"name":"onlyOneOfError","url":"classes/_zowe_imperative.syntaxvalidator.html#onlyoneoferror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2047,"kind":2048,"name":"emptyValueError","url":"classes/_zowe_imperative.syntaxvalidator.html#emptyvalueerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2048,"kind":2048,"name":"unknownPositionalError","url":"classes/_zowe_imperative.syntaxvalidator.html#unknownpositionalerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2049,"kind":2048,"name":"missingPositionalParameter","url":"classes/_zowe_imperative.syntaxvalidator.html#missingpositionalparameter","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2050,"kind":2048,"name":"appendValidatorError","url":"classes/_zowe_imperative.syntaxvalidator.html#appendvalidatorerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SyntaxValidator"},{"id":2051,"kind":256,"name":"ICommandProfileTypeConfiguration","url":"interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2052,"kind":1024,"name":"createProfileFromArgumentsHandler","url":"interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html#createprofilefromargumentshandler","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileTypeConfiguration"},{"id":2053,"kind":1024,"name":"updateProfileFromArgumentsHandler","url":"interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html#updateprofilefromargumentshandler","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileTypeConfiguration"},{"id":2054,"kind":1024,"name":"createProfileExamples","url":"interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html#createprofileexamples","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileTypeConfiguration"},{"id":2055,"kind":1024,"name":"updateProfileExamples","url":"interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html#updateprofileexamples","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileTypeConfiguration"},{"id":2056,"kind":1024,"name":"schema","url":"interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html#schema","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"@zowe/imperative.ICommandProfileTypeConfiguration"},{"id":2057,"kind":1024,"name":"authConfig","url":"interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html#authconfig","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileTypeConfiguration"},{"id":2058,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileTypeConfiguration"},{"id":2059,"kind":1024,"name":"dependencies","url":"interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html#dependencies","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileTypeConfiguration"},{"id":2060,"kind":1024,"name":"validationPlanModule","url":"interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html#validationplanmodule","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileTypeConfiguration"},{"id":2061,"kind":256,"name":"ICommandLoadProfile","url":"interfaces/_zowe_imperative.icommandloadprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2062,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.icommandloadprofile.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandLoadProfile"},{"id":2063,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.icommandloadprofile.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandLoadProfile"},{"id":2064,"kind":1024,"name":"userSpecified","url":"interfaces/_zowe_imperative.icommandloadprofile.html#userspecified","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandLoadProfile"},{"id":2065,"kind":1024,"name":"loadDefault","url":"interfaces/_zowe_imperative.icommandloadprofile.html#loaddefault","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandLoadProfile"},{"id":2066,"kind":1024,"name":"optional","url":"interfaces/_zowe_imperative.icommandloadprofile.html#optional","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandLoadProfile"},{"id":2067,"kind":256,"name":"ICommandProfileLoaderParms","url":"interfaces/_zowe_imperative.icommandprofileloaderparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2068,"kind":1024,"name":"commandDefinition","url":"interfaces/_zowe_imperative.icommandprofileloaderparms.html#commanddefinition","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileLoaderParms"},{"id":2069,"kind":1024,"name":"profileManagerFactory","url":"interfaces/_zowe_imperative.icommandprofileloaderparms.html#profilemanagerfactory","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileLoaderParms"},{"id":2070,"kind":1024,"name":"logger","url":"interfaces/_zowe_imperative.icommandprofileloaderparms.html#logger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileLoaderParms"},{"id":2071,"kind":128,"name":"CommandProfileLoader","url":"classes/_zowe_imperative.commandprofileloader.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2072,"kind":2048,"name":"loader","url":"classes/_zowe_imperative.commandprofileloader.html#loader","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2073,"kind":1024,"name":"mCommandDefinition","url":"classes/_zowe_imperative.commandprofileloader.html#mcommanddefinition","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2074,"kind":1024,"name":"mFactory","url":"classes/_zowe_imperative.commandprofileloader.html#mfactory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2075,"kind":1024,"name":"mLog","url":"classes/_zowe_imperative.commandprofileloader.html#mlog","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2076,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.commandprofileloader.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2077,"kind":2048,"name":"loadProfiles","url":"classes/_zowe_imperative.commandprofileloader.html#loadprofiles","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2078,"kind":2048,"name":"buildCommandMap","url":"classes/_zowe_imperative.commandprofileloader.html#buildcommandmap","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2079,"kind":2048,"name":"buildCommandMetaMap","url":"classes/_zowe_imperative.commandprofileloader.html#buildcommandmetamap","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2080,"kind":2048,"name":"constructLoadList","url":"classes/_zowe_imperative.commandprofileloader.html#constructloadlist","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2081,"kind":2048,"name":"buildLoad","url":"classes/_zowe_imperative.commandprofileloader.html#buildload","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2082,"kind":2048,"name":"loadAll","url":"classes/_zowe_imperative.commandprofileloader.html#loadall","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2083,"kind":262144,"name":"factory","url":"classes/_zowe_imperative.commandprofileloader.html#factory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2084,"kind":262144,"name":"definition","url":"classes/_zowe_imperative.commandprofileloader.html#definition","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2085,"kind":262144,"name":"log","url":"classes/_zowe_imperative.commandprofileloader.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProfileLoader"},{"id":2086,"kind":256,"name":"IHelpGenerator","url":"interfaces/_zowe_imperative.ihelpgenerator.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2087,"kind":2048,"name":"buildHelp","url":"interfaces/_zowe_imperative.ihelpgenerator.html#buildhelp","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IHelpGenerator"},{"id":2088,"kind":256,"name":"ICommandPrepared","url":"interfaces/_zowe_imperative.icommandprepared.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2089,"kind":1024,"name":"profiles","url":"interfaces/_zowe_imperative.icommandprepared.html#profiles","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandPrepared"},{"id":2090,"kind":1024,"name":"args","url":"interfaces/_zowe_imperative.icommandprepared.html#args","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandPrepared"},{"id":2091,"kind":256,"name":"IInvokeCommandParms","url":"interfaces/_zowe_imperative.iinvokecommandparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2092,"kind":1024,"name":"arguments","url":"interfaces/_zowe_imperative.iinvokecommandparms.html#arguments","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IInvokeCommandParms"},{"id":2093,"kind":1024,"name":"silent","url":"interfaces/_zowe_imperative.iinvokecommandparms.html#silent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IInvokeCommandParms"},{"id":2094,"kind":1024,"name":"responseFormat","url":"interfaces/_zowe_imperative.iinvokecommandparms.html#responseformat","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IInvokeCommandParms"},{"id":2095,"kind":256,"name":"ICommandProcessorParms","url":"interfaces/_zowe_imperative.icommandprocessorparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2096,"kind":1024,"name":"definition","url":"interfaces/_zowe_imperative.icommandprocessorparms.html#definition","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProcessorParms"},{"id":2097,"kind":1024,"name":"helpGenerator","url":"interfaces/_zowe_imperative.icommandprocessorparms.html#helpgenerator","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProcessorParms"},{"id":2098,"kind":1024,"name":"profileManagerFactory","url":"interfaces/_zowe_imperative.icommandprocessorparms.html#profilemanagerfactory","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProcessorParms"},{"id":2099,"kind":1024,"name":"rootCommandName","url":"interfaces/_zowe_imperative.icommandprocessorparms.html#rootcommandname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProcessorParms"},{"id":2100,"kind":1024,"name":"commandLine","url":"interfaces/_zowe_imperative.icommandprocessorparms.html#commandline","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProcessorParms"},{"id":2101,"kind":1024,"name":"envVariablePrefix","url":"interfaces/_zowe_imperative.icommandprocessorparms.html#envvariableprefix","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProcessorParms"},{"id":2102,"kind":1024,"name":"fullDefinition","url":"interfaces/_zowe_imperative.icommandprocessorparms.html#fulldefinition","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProcessorParms"},{"id":2103,"kind":1024,"name":"promptPhrase","url":"interfaces/_zowe_imperative.icommandprocessorparms.html#promptphrase","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProcessorParms"},{"id":2104,"kind":1024,"name":"config","url":"interfaces/_zowe_imperative.icommandprocessorparms.html#config","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProcessorParms"},{"id":2105,"kind":1024,"name":"daemonContext","url":"interfaces/_zowe_imperative.icommandprocessorparms.html#daemoncontext","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProcessorParms"},{"id":2106,"kind":256,"name":"IWebHelpManager","url":"interfaces/_zowe_imperative.iwebhelpmanager.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2107,"kind":2048,"name":"openRootHelp","url":"interfaces/_zowe_imperative.iwebhelpmanager.html#openroothelp","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IWebHelpManager"},{"id":2108,"kind":2048,"name":"openHelp","url":"interfaces/_zowe_imperative.iwebhelpmanager.html#openhelp","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IWebHelpManager"},{"id":2109,"kind":256,"name":"IHelpGeneratorParms","url":"interfaces/_zowe_imperative.ihelpgeneratorparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2110,"kind":1024,"name":"commandDefinition","url":"interfaces/_zowe_imperative.ihelpgeneratorparms.html#commanddefinition","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHelpGeneratorParms"},{"id":2111,"kind":1024,"name":"fullCommandTree","url":"interfaces/_zowe_imperative.ihelpgeneratorparms.html#fullcommandtree","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHelpGeneratorParms"},{"id":2112,"kind":1024,"name":"experimentalCommandsDescription","url":"interfaces/_zowe_imperative.ihelpgeneratorparms.html#experimentalcommandsdescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHelpGeneratorParms"},{"id":2113,"kind":1024,"name":"skipTextWrap","url":"interfaces/_zowe_imperative.ihelpgeneratorparms.html#skiptextwrap","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHelpGeneratorParms"},{"id":2114,"kind":256,"name":"IHelpGeneratorFactoryParms","url":"interfaces/_zowe_imperative.ihelpgeneratorfactoryparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2115,"kind":1024,"name":"rootCommandName","url":"interfaces/_zowe_imperative.ihelpgeneratorfactoryparms.html#rootcommandname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHelpGeneratorFactoryParms"},{"id":2116,"kind":1024,"name":"produceMarkdown","url":"interfaces/_zowe_imperative.ihelpgeneratorfactoryparms.html#producemarkdown","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHelpGeneratorFactoryParms"},{"id":2117,"kind":1024,"name":"primaryHighlightColor","url":"interfaces/_zowe_imperative.ihelpgeneratorfactoryparms.html#primaryhighlightcolor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IHelpGeneratorFactoryParms"},{"id":2118,"kind":128,"name":"AbstractHelpGenerator","url":"classes/_zowe_imperative.abstracthelpgenerator.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2119,"kind":1024,"name":"SHORT_DASH","url":"classes/_zowe_imperative.abstracthelpgenerator.html#short_dash","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2120,"kind":1024,"name":"LONG_DASH","url":"classes/_zowe_imperative.abstracthelpgenerator.html#long_dash","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2121,"kind":2048,"name":"formatHelpHeader","url":"classes/_zowe_imperative.abstracthelpgenerator.html#formathelpheader","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2122,"kind":1024,"name":"mRootCommandName","url":"classes/_zowe_imperative.abstracthelpgenerator.html#mrootcommandname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2123,"kind":1024,"name":"mCommandDefinition","url":"classes/_zowe_imperative.abstracthelpgenerator.html#mcommanddefinition","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2124,"kind":1024,"name":"mDefinitionTree","url":"classes/_zowe_imperative.abstracthelpgenerator.html#mdefinitiontree","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2125,"kind":1024,"name":"mProduceMarkdown","url":"classes/_zowe_imperative.abstracthelpgenerator.html#mproducemarkdown","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2126,"kind":1024,"name":"mLog","url":"classes/_zowe_imperative.abstracthelpgenerator.html#mlog","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2127,"kind":1024,"name":"mPrimaryHighlightColor","url":"classes/_zowe_imperative.abstracthelpgenerator.html#mprimaryhighlightcolor","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2128,"kind":1024,"name":"mExperimentalCommandDescription","url":"classes/_zowe_imperative.abstracthelpgenerator.html#mexperimentalcommanddescription","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2129,"kind":1024,"name":"groupToOption","url":"classes/_zowe_imperative.abstracthelpgenerator.html#grouptooption","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2130,"kind":65536,"name":"__type","url":"classes/_zowe_imperative.abstracthelpgenerator.html#grouptooption.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.AbstractHelpGenerator.groupToOption"},{"id":2131,"kind":1024,"name":"optionToDescription","url":"classes/_zowe_imperative.abstracthelpgenerator.html#optiontodescription","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2132,"kind":65536,"name":"__type","url":"classes/_zowe_imperative.abstracthelpgenerator.html#optiontodescription.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.AbstractHelpGenerator.optionToDescription"},{"id":2133,"kind":262144,"name":"log","url":"classes/_zowe_imperative.abstracthelpgenerator.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2134,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.abstracthelpgenerator.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2135,"kind":2048,"name":"buildHelp","url":"classes/_zowe_imperative.abstracthelpgenerator.html#buildhelp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2136,"kind":2048,"name":"getOptionAndAliasesString","url":"classes/_zowe_imperative.abstracthelpgenerator.html#getoptionandaliasesstring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2137,"kind":2048,"name":"buildFullCommandHelpText","url":"classes/_zowe_imperative.abstracthelpgenerator.html#buildfullcommandhelptext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2138,"kind":2048,"name":"buildOptionMaps","url":"classes/_zowe_imperative.abstracthelpgenerator.html#buildoptionmaps","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2139,"kind":2048,"name":"getCaseSensitiveFlagByOptionName","url":"classes/_zowe_imperative.abstracthelpgenerator.html#getcasesensitiveflagbyoptionname","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2140,"kind":2048,"name":"renderHelp","url":"classes/_zowe_imperative.abstracthelpgenerator.html#renderhelp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2141,"kind":2048,"name":"explainType","url":"classes/_zowe_imperative.abstracthelpgenerator.html#explaintype","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2142,"kind":2048,"name":"dimGrey","url":"classes/_zowe_imperative.abstracthelpgenerator.html#dimgrey","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2143,"kind":2048,"name":"grey","url":"classes/_zowe_imperative.abstracthelpgenerator.html#grey","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGenerator"},{"id":2144,"kind":128,"name":"DefaultHelpGenerator","url":"classes/_zowe_imperative.defaulthelpgenerator.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2145,"kind":1024,"name":"HELP_INDENT","url":"classes/_zowe_imperative.defaulthelpgenerator.html#help_indent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2146,"kind":1024,"name":"ERROR_TAG","url":"classes/_zowe_imperative.defaulthelpgenerator.html#error_tag","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2147,"kind":1024,"name":"skipTextWrap","url":"classes/_zowe_imperative.defaulthelpgenerator.html#skiptextwrap","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2148,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.defaulthelpgenerator.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2149,"kind":2048,"name":"buildHelp","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildhelp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2150,"kind":2048,"name":"buildFullGroupHelpText","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildfullgrouphelptext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2151,"kind":2048,"name":"buildFullCommandHelpText","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildfullcommandhelptext","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2152,"kind":2048,"name":"buildCommandAndAliases","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildcommandandaliases","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2153,"kind":2048,"name":"buildChildrenSummaryTables","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildchildrensummarytables","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2154,"kind":2048,"name":"buildUsageDiagram","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildusagediagram","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2155,"kind":2048,"name":"buildUsageSection","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildusagesection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2156,"kind":2048,"name":"buildGlobalOptionsSection","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildglobaloptionssection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2157,"kind":2048,"name":"buildDescriptionSection","url":"classes/_zowe_imperative.defaulthelpgenerator.html#builddescriptionsection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2158,"kind":2048,"name":"buildPositionalArgumentsSection","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildpositionalargumentssection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2159,"kind":2048,"name":"buildCommandOptionsSection","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildcommandoptionssection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2160,"kind":2048,"name":"buildOptionText","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildoptiontext","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2161,"kind":2048,"name":"buildHeader","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildheader","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2162,"kind":2048,"name":"buildExamplesSection","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildexamplessection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2163,"kind":2048,"name":"getExperimentalCommandSection","url":"classes/_zowe_imperative.defaulthelpgenerator.html#getexperimentalcommandsection","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2164,"kind":2048,"name":"escapeMarkdown","url":"classes/_zowe_imperative.defaulthelpgenerator.html#escapemarkdown","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2165,"kind":1024,"name":"SHORT_DASH","url":"classes/_zowe_imperative.defaulthelpgenerator.html#short_dash","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2166,"kind":1024,"name":"LONG_DASH","url":"classes/_zowe_imperative.defaulthelpgenerator.html#long_dash","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2167,"kind":2048,"name":"formatHelpHeader","url":"classes/_zowe_imperative.defaulthelpgenerator.html#formathelpheader","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2168,"kind":1024,"name":"mRootCommandName","url":"classes/_zowe_imperative.defaulthelpgenerator.html#mrootcommandname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2169,"kind":1024,"name":"mCommandDefinition","url":"classes/_zowe_imperative.defaulthelpgenerator.html#mcommanddefinition","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2170,"kind":1024,"name":"mDefinitionTree","url":"classes/_zowe_imperative.defaulthelpgenerator.html#mdefinitiontree","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2171,"kind":1024,"name":"mProduceMarkdown","url":"classes/_zowe_imperative.defaulthelpgenerator.html#mproducemarkdown","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2172,"kind":1024,"name":"mLog","url":"classes/_zowe_imperative.defaulthelpgenerator.html#mlog","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2173,"kind":1024,"name":"mPrimaryHighlightColor","url":"classes/_zowe_imperative.defaulthelpgenerator.html#mprimaryhighlightcolor","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2174,"kind":1024,"name":"mExperimentalCommandDescription","url":"classes/_zowe_imperative.defaulthelpgenerator.html#mexperimentalcommanddescription","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2175,"kind":1024,"name":"groupToOption","url":"classes/_zowe_imperative.defaulthelpgenerator.html#grouptooption","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2176,"kind":65536,"name":"__type","url":"classes/_zowe_imperative.defaulthelpgenerator.html#grouptooption.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.DefaultHelpGenerator.groupToOption"},{"id":2177,"kind":1024,"name":"optionToDescription","url":"classes/_zowe_imperative.defaulthelpgenerator.html#optiontodescription","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2178,"kind":65536,"name":"__type","url":"classes/_zowe_imperative.defaulthelpgenerator.html#optiontodescription.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.DefaultHelpGenerator.optionToDescription"},{"id":2179,"kind":262144,"name":"log","url":"classes/_zowe_imperative.defaulthelpgenerator.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2180,"kind":2048,"name":"getOptionAndAliasesString","url":"classes/_zowe_imperative.defaulthelpgenerator.html#getoptionandaliasesstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2181,"kind":2048,"name":"buildOptionMaps","url":"classes/_zowe_imperative.defaulthelpgenerator.html#buildoptionmaps","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2182,"kind":2048,"name":"getCaseSensitiveFlagByOptionName","url":"classes/_zowe_imperative.defaulthelpgenerator.html#getcasesensitiveflagbyoptionname","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2183,"kind":2048,"name":"renderHelp","url":"classes/_zowe_imperative.defaulthelpgenerator.html#renderhelp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2184,"kind":2048,"name":"explainType","url":"classes/_zowe_imperative.defaulthelpgenerator.html#explaintype","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2185,"kind":2048,"name":"dimGrey","url":"classes/_zowe_imperative.defaulthelpgenerator.html#dimgrey","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2186,"kind":2048,"name":"grey","url":"classes/_zowe_imperative.defaulthelpgenerator.html#grey","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.DefaultHelpGenerator"},{"id":2187,"kind":256,"name":"IWebHelpTreeNode","url":"interfaces/_zowe_imperative.iwebhelptreenode.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2188,"kind":1024,"name":"id","url":"interfaces/_zowe_imperative.iwebhelptreenode.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IWebHelpTreeNode"},{"id":2189,"kind":1024,"name":"text","url":"interfaces/_zowe_imperative.iwebhelptreenode.html#text","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IWebHelpTreeNode"},{"id":2190,"kind":1024,"name":"children","url":"interfaces/_zowe_imperative.iwebhelptreenode.html#children","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IWebHelpTreeNode"},{"id":2191,"kind":128,"name":"WebHelpGenerator","url":"classes/_zowe_imperative.webhelpgenerator.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2192,"kind":1024,"name":"sanitizeHomeDir","url":"classes/_zowe_imperative.webhelpgenerator.html#sanitizehomedir","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2193,"kind":1024,"name":"mFullCommandTree","url":"classes/_zowe_imperative.webhelpgenerator.html#mfullcommandtree","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2194,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.webhelpgenerator.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2195,"kind":1024,"name":"mDocsDir","url":"classes/_zowe_imperative.webhelpgenerator.html#mdocsdir","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2196,"kind":1024,"name":"markdownIt","url":"classes/_zowe_imperative.webhelpgenerator.html#markdownit","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2197,"kind":1024,"name":"treeNodes","url":"classes/_zowe_imperative.webhelpgenerator.html#treenodes","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2198,"kind":1024,"name":"aliasList","url":"classes/_zowe_imperative.webhelpgenerator.html#aliaslist","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2199,"kind":65536,"name":"__type","url":"classes/_zowe_imperative.webhelpgenerator.html#aliaslist.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.WebHelpGenerator.aliasList"},{"id":2200,"kind":1024,"name":"singlePageHtml","url":"classes/_zowe_imperative.webhelpgenerator.html#singlepagehtml","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2201,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.webhelpgenerator.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2202,"kind":2048,"name":"buildHelp","url":"classes/_zowe_imperative.webhelpgenerator.html#buildhelp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2203,"kind":2048,"name":"renderMarkdown","url":"classes/_zowe_imperative.webhelpgenerator.html#rendermarkdown","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2204,"kind":2048,"name":"genDocsHeader","url":"classes/_zowe_imperative.webhelpgenerator.html#gendocsheader","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2205,"kind":2048,"name":"genDocsFooter","url":"classes/_zowe_imperative.webhelpgenerator.html#gendocsfooter","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2206,"kind":2048,"name":"genPrintButton","url":"classes/_zowe_imperative.webhelpgenerator.html#genprintbutton","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2207,"kind":2048,"name":"genBreadcrumb","url":"classes/_zowe_imperative.webhelpgenerator.html#genbreadcrumb","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2208,"kind":2048,"name":"buildChildrenSummaryTables","url":"classes/_zowe_imperative.webhelpgenerator.html#buildchildrensummarytables","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2209,"kind":2048,"name":"appendToSinglePageHtml","url":"classes/_zowe_imperative.webhelpgenerator.html#appendtosinglepagehtml","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2210,"kind":2048,"name":"genCommandHelpPage","url":"classes/_zowe_imperative.webhelpgenerator.html#gencommandhelppage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2211,"kind":2048,"name":"buildCmdTreeHtml","url":"classes/_zowe_imperative.webhelpgenerator.html#buildcmdtreehtml","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2212,"kind":2048,"name":"writeTreeData","url":"classes/_zowe_imperative.webhelpgenerator.html#writetreedata","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpGenerator"},{"id":2213,"kind":256,"name":"IWebHelpPackageMetadata","url":"interfaces/_zowe_imperative.iwebhelppackagemetadata.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2214,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.iwebhelppackagemetadata.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IWebHelpPackageMetadata"},{"id":2215,"kind":1024,"name":"version","url":"interfaces/_zowe_imperative.iwebhelppackagemetadata.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IWebHelpPackageMetadata"},{"id":2216,"kind":128,"name":"WebHelpManager","url":"classes/_zowe_imperative.webhelpmanager.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2217,"kind":1024,"name":"mInstance","url":"classes/_zowe_imperative.webhelpmanager.html#minstance","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.WebHelpManager"},{"id":2218,"kind":1024,"name":"mFullCommandTree","url":"classes/_zowe_imperative.webhelpmanager.html#mfullcommandtree","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpManager"},{"id":2219,"kind":262144,"name":"instance","url":"classes/_zowe_imperative.webhelpmanager.html#instance","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.WebHelpManager"},{"id":2220,"kind":2048,"name":"openRootHelp","url":"classes/_zowe_imperative.webhelpmanager.html#openroothelp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.WebHelpManager"},{"id":2221,"kind":2048,"name":"openHelp","url":"classes/_zowe_imperative.webhelpmanager.html#openhelp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.WebHelpManager"},{"id":2222,"kind":262144,"name":"fullCommandTree","url":"classes/_zowe_imperative.webhelpmanager.html#fullcommandtree","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.WebHelpManager"},{"id":2223,"kind":262144,"name":"webHelpDir","url":"classes/_zowe_imperative.webhelpmanager.html#webhelpdir","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpManager"},{"id":2224,"kind":2048,"name":"calcPackageMetadata","url":"classes/_zowe_imperative.webhelpmanager.html#calcpackagemetadata","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpManager"},{"id":2225,"kind":2048,"name":"eqPackageMetadata","url":"classes/_zowe_imperative.webhelpmanager.html#eqpackagemetadata","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpManager"},{"id":2226,"kind":2048,"name":"checkIfMetadataChanged","url":"classes/_zowe_imperative.webhelpmanager.html#checkifmetadatachanged","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpManager"},{"id":2227,"kind":2048,"name":"writePackageMetadata","url":"classes/_zowe_imperative.webhelpmanager.html#writepackagemetadata","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebHelpManager"},{"id":2228,"kind":128,"name":"CommandProcessor","url":"classes/_zowe_imperative.commandprocessor.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2229,"kind":1024,"name":"ENV_SHOW_SECURE_SUFFIX","url":"classes/_zowe_imperative.commandprocessor.html#env_show_secure_suffix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandProcessor"},{"id":2230,"kind":1024,"name":"ERROR_TAG","url":"classes/_zowe_imperative.commandprocessor.html#error_tag","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandProcessor"},{"id":2231,"kind":1024,"name":"mCommandRootName","url":"classes/_zowe_imperative.commandprocessor.html#mcommandrootname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2232,"kind":1024,"name":"mCommandLine","url":"classes/_zowe_imperative.commandprocessor.html#mcommandline","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2233,"kind":1024,"name":"mEnvVariablePrefix","url":"classes/_zowe_imperative.commandprocessor.html#menvvariableprefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2234,"kind":1024,"name":"mPromptPhrase","url":"classes/_zowe_imperative.commandprocessor.html#mpromptphrase","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2235,"kind":1024,"name":"mDefinition","url":"classes/_zowe_imperative.commandprocessor.html#mdefinition","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2236,"kind":1024,"name":"mFullDefinition","url":"classes/_zowe_imperative.commandprocessor.html#mfulldefinition","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2237,"kind":1024,"name":"mHelpGenerator","url":"classes/_zowe_imperative.commandprocessor.html#mhelpgenerator","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2238,"kind":1024,"name":"mProfileManagerFactory","url":"classes/_zowe_imperative.commandprocessor.html#mprofilemanagerfactory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2239,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.commandprocessor.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2240,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.commandprocessor.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2241,"kind":1024,"name":"mDaemonContext","url":"classes/_zowe_imperative.commandprocessor.html#mdaemoncontext","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2242,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.commandprocessor.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2243,"kind":262144,"name":"rootCommand","url":"classes/_zowe_imperative.commandprocessor.html#rootcommand","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2244,"kind":262144,"name":"commandLine","url":"classes/_zowe_imperative.commandprocessor.html#commandline","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2245,"kind":262144,"name":"envVariablePrefix","url":"classes/_zowe_imperative.commandprocessor.html#envvariableprefix","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2246,"kind":262144,"name":"promptPhrase","url":"classes/_zowe_imperative.commandprocessor.html#promptphrase","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2247,"kind":262144,"name":"helpGenerator","url":"classes/_zowe_imperative.commandprocessor.html#helpgenerator","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2248,"kind":262144,"name":"config","url":"classes/_zowe_imperative.commandprocessor.html#config","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2249,"kind":262144,"name":"profileFactory","url":"classes/_zowe_imperative.commandprocessor.html#profilefactory","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2250,"kind":262144,"name":"definition","url":"classes/_zowe_imperative.commandprocessor.html#definition","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2251,"kind":262144,"name":"fullDefinition","url":"classes/_zowe_imperative.commandprocessor.html#fulldefinition","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2252,"kind":2048,"name":"help","url":"classes/_zowe_imperative.commandprocessor.html#help","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2253,"kind":2048,"name":"webHelp","url":"classes/_zowe_imperative.commandprocessor.html#webhelp","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2254,"kind":2048,"name":"validate","url":"classes/_zowe_imperative.commandprocessor.html#validate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2255,"kind":2048,"name":"invoke","url":"classes/_zowe_imperative.commandprocessor.html#invoke","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CommandProcessor"},{"id":2256,"kind":2048,"name":"showInputsOnly","url":"classes/_zowe_imperative.commandprocessor.html#showinputsonly","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2257,"kind":2048,"name":"invalidSyntaxNotification","url":"classes/_zowe_imperative.commandprocessor.html#invalidsyntaxnotification","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2258,"kind":2048,"name":"prepare","url":"classes/_zowe_imperative.commandprocessor.html#prepare","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2259,"kind":262144,"name":"log","url":"classes/_zowe_imperative.commandprocessor.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2260,"kind":2048,"name":"constructResponseObject","url":"classes/_zowe_imperative.commandprocessor.html#constructresponseobject","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2261,"kind":2048,"name":"getStdinStream","url":"classes/_zowe_imperative.commandprocessor.html#getstdinstream","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2262,"kind":2048,"name":"attemptHandlerLoad","url":"classes/_zowe_imperative.commandprocessor.html#attempthandlerload","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2263,"kind":2048,"name":"finishResponse","url":"classes/_zowe_imperative.commandprocessor.html#finishresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2264,"kind":2048,"name":"handleHandlerError","url":"classes/_zowe_imperative.commandprocessor.html#handlehandlererror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandProcessor"},{"id":2265,"kind":256,"name":"IYargsResponse","url":"interfaces/_zowe_imperative.iyargsresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2266,"kind":1024,"name":"success","url":"interfaces/_zowe_imperative.iyargsresponse.html#success","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsResponse"},{"id":2267,"kind":1024,"name":"exitCode","url":"interfaces/_zowe_imperative.iyargsresponse.html#exitcode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsResponse"},{"id":2268,"kind":1024,"name":"message","url":"interfaces/_zowe_imperative.iyargsresponse.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsResponse"},{"id":2269,"kind":1024,"name":"actionPerformed","url":"interfaces/_zowe_imperative.iyargsresponse.html#actionperformed","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsResponse"},{"id":2270,"kind":1024,"name":"commandResponses","url":"interfaces/_zowe_imperative.iyargsresponse.html#commandresponses","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsResponse"},{"id":2271,"kind":1024,"name":"causeErrors","url":"interfaces/_zowe_imperative.iyargsresponse.html#causeerrors","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsResponse"},{"id":2272,"kind":4194304,"name":"ImperativeYargsCommandAction","url":"modules/_zowe_imperative.html#imperativeyargscommandaction","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2273,"kind":128,"name":"CommandYargs","url":"classes/_zowe_imperative.commandyargs.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2274,"kind":2048,"name":"defineOptionsToYargs","url":"classes/_zowe_imperative.commandyargs.html#defineoptionstoyargs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CommandYargs"},{"id":2275,"kind":2048,"name":"defineCommandToYargs","url":"classes/_zowe_imperative.commandyargs.html#definecommandtoyargs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.CommandYargs"},{"id":2276,"kind":2048,"name":"buildPositionalString","url":"classes/_zowe_imperative.commandyargs.html#buildpositionalstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandYargs"},{"id":2277,"kind":2048,"name":"invokeHandlers","url":"classes/_zowe_imperative.commandyargs.html#invokehandlers","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CommandYargs"},{"id":2278,"kind":1024,"name":"STOP_YARGS","url":"classes/_zowe_imperative.commandyargs.html#stop_yargs","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.CommandYargs"},{"id":2279,"kind":1024,"name":"log","url":"classes/_zowe_imperative.commandyargs.html#log","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2280,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.commandyargs.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.CommandYargs"},{"id":2281,"kind":1024,"name":"yargsParms","url":"classes/_zowe_imperative.commandyargs.html#yargsparms","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2282,"kind":262144,"name":"rootCommandName","url":"classes/_zowe_imperative.commandyargs.html#rootcommandname","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2283,"kind":262144,"name":"commandLine","url":"classes/_zowe_imperative.commandyargs.html#commandline","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2284,"kind":262144,"name":"envVariablePrefix","url":"classes/_zowe_imperative.commandyargs.html#envvariableprefix","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2285,"kind":262144,"name":"promptPhrase","url":"classes/_zowe_imperative.commandyargs.html#promptphrase","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2286,"kind":262144,"name":"responseParms","url":"classes/_zowe_imperative.commandyargs.html#responseparms","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2287,"kind":262144,"name":"helpGeneratorFactory","url":"classes/_zowe_imperative.commandyargs.html#helpgeneratorfactory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2288,"kind":262144,"name":"profileManagerFactory","url":"classes/_zowe_imperative.commandyargs.html#profilemanagerfactory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2289,"kind":262144,"name":"definition","url":"classes/_zowe_imperative.commandyargs.html#definition","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.CommandYargs"},{"id":2290,"kind":262144,"name":"yargs","url":"classes/_zowe_imperative.commandyargs.html#yargs","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.CommandYargs"},{"id":2291,"kind":262144,"name":"parents","url":"classes/_zowe_imperative.commandyargs.html#parents","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.CommandYargs"},{"id":2292,"kind":2048,"name":"constructDefinitionTree","url":"classes/_zowe_imperative.commandyargs.html#constructdefinitiontree","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.CommandYargs"},{"id":2293,"kind":2048,"name":"getBrightYargsResponse","url":"classes/_zowe_imperative.commandyargs.html#getbrightyargsresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2294,"kind":2048,"name":"getZoweYargsResponse","url":"classes/_zowe_imperative.commandyargs.html#getzoweyargsresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2295,"kind":2048,"name":"executeHelp","url":"classes/_zowe_imperative.commandyargs.html#executehelp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2296,"kind":2048,"name":"getDepthExamples","url":"classes/_zowe_imperative.commandyargs.html#getdepthexamples","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2297,"kind":2048,"name":"executeWebHelp","url":"classes/_zowe_imperative.commandyargs.html#executewebhelp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CommandYargs"},{"id":2298,"kind":128,"name":"GroupCommandYargs","url":"classes/_zowe_imperative.groupcommandyargs.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2299,"kind":2048,"name":"defineCommandToYargs","url":"classes/_zowe_imperative.groupcommandyargs.html#definecommandtoyargs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2300,"kind":1024,"name":"STOP_YARGS","url":"classes/_zowe_imperative.groupcommandyargs.html#stop_yargs","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2301,"kind":1024,"name":"log","url":"classes/_zowe_imperative.groupcommandyargs.html#log","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2302,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.groupcommandyargs.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2303,"kind":1024,"name":"yargsParms","url":"classes/_zowe_imperative.groupcommandyargs.html#yargsparms","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2304,"kind":262144,"name":"rootCommandName","url":"classes/_zowe_imperative.groupcommandyargs.html#rootcommandname","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2305,"kind":262144,"name":"commandLine","url":"classes/_zowe_imperative.groupcommandyargs.html#commandline","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2306,"kind":262144,"name":"envVariablePrefix","url":"classes/_zowe_imperative.groupcommandyargs.html#envvariableprefix","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2307,"kind":262144,"name":"promptPhrase","url":"classes/_zowe_imperative.groupcommandyargs.html#promptphrase","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2308,"kind":262144,"name":"responseParms","url":"classes/_zowe_imperative.groupcommandyargs.html#responseparms","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2309,"kind":262144,"name":"helpGeneratorFactory","url":"classes/_zowe_imperative.groupcommandyargs.html#helpgeneratorfactory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2310,"kind":262144,"name":"profileManagerFactory","url":"classes/_zowe_imperative.groupcommandyargs.html#profilemanagerfactory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2311,"kind":262144,"name":"definition","url":"classes/_zowe_imperative.groupcommandyargs.html#definition","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2312,"kind":262144,"name":"yargs","url":"classes/_zowe_imperative.groupcommandyargs.html#yargs","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2313,"kind":262144,"name":"parents","url":"classes/_zowe_imperative.groupcommandyargs.html#parents","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2314,"kind":2048,"name":"constructDefinitionTree","url":"classes/_zowe_imperative.groupcommandyargs.html#constructdefinitiontree","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2315,"kind":2048,"name":"getBrightYargsResponse","url":"classes/_zowe_imperative.groupcommandyargs.html#getbrightyargsresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2316,"kind":2048,"name":"getZoweYargsResponse","url":"classes/_zowe_imperative.groupcommandyargs.html#getzoweyargsresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2317,"kind":2048,"name":"executeHelp","url":"classes/_zowe_imperative.groupcommandyargs.html#executehelp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2318,"kind":2048,"name":"getDepthExamples","url":"classes/_zowe_imperative.groupcommandyargs.html#getdepthexamples","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2319,"kind":2048,"name":"executeWebHelp","url":"classes/_zowe_imperative.groupcommandyargs.html#executewebhelp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.GroupCommandYargs"},{"id":2320,"kind":256,"name":"IHelpGeneratorFactory","url":"interfaces/_zowe_imperative.ihelpgeneratorfactory.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2321,"kind":2048,"name":"getHelpGenerator","url":"interfaces/_zowe_imperative.ihelpgeneratorfactory.html#gethelpgenerator","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IHelpGeneratorFactory"},{"id":2322,"kind":256,"name":"IYargsParms","url":"interfaces/_zowe_imperative.iyargsparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2323,"kind":1024,"name":"yargsInstance","url":"interfaces/_zowe_imperative.iyargsparms.html#yargsinstance","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsParms"},{"id":2324,"kind":1024,"name":"commandDefinition","url":"interfaces/_zowe_imperative.iyargsparms.html#commanddefinition","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsParms"},{"id":2325,"kind":1024,"name":"commandResponseParms","url":"interfaces/_zowe_imperative.iyargsparms.html#commandresponseparms","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsParms"},{"id":2326,"kind":1024,"name":"helpGeneratorFactory","url":"interfaces/_zowe_imperative.iyargsparms.html#helpgeneratorfactory","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsParms"},{"id":2327,"kind":1024,"name":"profileManagerFactory","url":"interfaces/_zowe_imperative.iyargsparms.html#profilemanagerfactory","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsParms"},{"id":2328,"kind":1024,"name":"experimentalCommandDescription","url":"interfaces/_zowe_imperative.iyargsparms.html#experimentalcommanddescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsParms"},{"id":2329,"kind":1024,"name":"rootCommandName","url":"interfaces/_zowe_imperative.iyargsparms.html#rootcommandname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsParms"},{"id":2330,"kind":1024,"name":"commandLine","url":"interfaces/_zowe_imperative.iyargsparms.html#commandline","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsParms"},{"id":2331,"kind":1024,"name":"envVariablePrefix","url":"interfaces/_zowe_imperative.iyargsparms.html#envvariableprefix","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsParms"},{"id":2332,"kind":1024,"name":"yargsParent","url":"interfaces/_zowe_imperative.iyargsparms.html#yargsparent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsParms"},{"id":2333,"kind":1024,"name":"promptPhrase","url":"interfaces/_zowe_imperative.iyargsparms.html#promptphrase","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IYargsParms"},{"id":2334,"kind":128,"name":"AbstractCommandYargs","url":"classes/_zowe_imperative.abstractcommandyargs.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2335,"kind":1024,"name":"STOP_YARGS","url":"classes/_zowe_imperative.abstractcommandyargs.html#stop_yargs","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2336,"kind":1024,"name":"log","url":"classes/_zowe_imperative.abstractcommandyargs.html#log","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2337,"kind":1024,"name":"mDefinition","url":"classes/_zowe_imperative.abstractcommandyargs.html#mdefinition","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2338,"kind":1024,"name":"mParent","url":"classes/_zowe_imperative.abstractcommandyargs.html#mparent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2339,"kind":1024,"name":"mYargsInstance","url":"classes/_zowe_imperative.abstractcommandyargs.html#myargsinstance","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2340,"kind":1024,"name":"mCommandResponseParms","url":"classes/_zowe_imperative.abstractcommandyargs.html#mcommandresponseparms","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2341,"kind":1024,"name":"mHelpGeneratorFactory","url":"classes/_zowe_imperative.abstractcommandyargs.html#mhelpgeneratorfactory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2342,"kind":1024,"name":"mProfileManagerFactory","url":"classes/_zowe_imperative.abstractcommandyargs.html#mprofilemanagerfactory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2343,"kind":1024,"name":"mRootCommandName","url":"classes/_zowe_imperative.abstractcommandyargs.html#mrootcommandname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2344,"kind":1024,"name":"mCommandLine","url":"classes/_zowe_imperative.abstractcommandyargs.html#mcommandline","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2345,"kind":1024,"name":"mEnvVariablePrefix","url":"classes/_zowe_imperative.abstractcommandyargs.html#menvvariableprefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2346,"kind":1024,"name":"mPromptPhrase","url":"classes/_zowe_imperative.abstractcommandyargs.html#mpromptphrase","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2347,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.abstractcommandyargs.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2348,"kind":1024,"name":"yargsParms","url":"classes/_zowe_imperative.abstractcommandyargs.html#yargsparms","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2349,"kind":262144,"name":"rootCommandName","url":"classes/_zowe_imperative.abstractcommandyargs.html#rootcommandname","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2350,"kind":262144,"name":"commandLine","url":"classes/_zowe_imperative.abstractcommandyargs.html#commandline","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2351,"kind":262144,"name":"envVariablePrefix","url":"classes/_zowe_imperative.abstractcommandyargs.html#envvariableprefix","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2352,"kind":262144,"name":"promptPhrase","url":"classes/_zowe_imperative.abstractcommandyargs.html#promptphrase","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2353,"kind":262144,"name":"responseParms","url":"classes/_zowe_imperative.abstractcommandyargs.html#responseparms","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2354,"kind":262144,"name":"helpGeneratorFactory","url":"classes/_zowe_imperative.abstractcommandyargs.html#helpgeneratorfactory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2355,"kind":262144,"name":"profileManagerFactory","url":"classes/_zowe_imperative.abstractcommandyargs.html#profilemanagerfactory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2356,"kind":262144,"name":"definition","url":"classes/_zowe_imperative.abstractcommandyargs.html#definition","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2357,"kind":262144,"name":"yargs","url":"classes/_zowe_imperative.abstractcommandyargs.html#yargs","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2358,"kind":262144,"name":"parents","url":"classes/_zowe_imperative.abstractcommandyargs.html#parents","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2359,"kind":2048,"name":"constructDefinitionTree","url":"classes/_zowe_imperative.abstractcommandyargs.html#constructdefinitiontree","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2360,"kind":2048,"name":"defineCommandToYargs","url":"classes/_zowe_imperative.abstractcommandyargs.html#definecommandtoyargs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2361,"kind":2048,"name":"getBrightYargsResponse","url":"classes/_zowe_imperative.abstractcommandyargs.html#getbrightyargsresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2362,"kind":2048,"name":"getZoweYargsResponse","url":"classes/_zowe_imperative.abstractcommandyargs.html#getzoweyargsresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2363,"kind":2048,"name":"executeHelp","url":"classes/_zowe_imperative.abstractcommandyargs.html#executehelp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2364,"kind":2048,"name":"getDepthExamples","url":"classes/_zowe_imperative.abstractcommandyargs.html#getdepthexamples","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2365,"kind":2048,"name":"executeWebHelp","url":"classes/_zowe_imperative.abstractcommandyargs.html#executewebhelp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractCommandYargs"},{"id":2366,"kind":4194304,"name":"YargsCommandCompleted","url":"modules/_zowe_imperative.html#yargscommandcompleted","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2367,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#yargscommandcompleted.__type-15","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.YargsCommandCompleted"},{"id":2368,"kind":4194304,"name":"SecureOperationFunction","url":"modules/_zowe_imperative.html#secureoperationfunction","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2369,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#secureoperationfunction.__type-14","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.SecureOperationFunction"},{"id":2370,"kind":256,"name":"ICliLoadProfile","url":"interfaces/_zowe_imperative.icliloadprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2371,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.icliloadprofile.html#name","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICliLoadProfile"},{"id":2372,"kind":1024,"name":"loadDefault","url":"interfaces/_zowe_imperative.icliloadprofile.html#loaddefault","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICliLoadProfile"},{"id":2373,"kind":1024,"name":"failNotFound","url":"interfaces/_zowe_imperative.icliloadprofile.html#failnotfound","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICliLoadProfile"},{"id":2374,"kind":1024,"name":"loadDependencies","url":"interfaces/_zowe_imperative.icliloadprofile.html#loaddependencies","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICliLoadProfile"},{"id":2375,"kind":1024,"name":"noSecure","url":"interfaces/_zowe_imperative.icliloadprofile.html#nosecure","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICliLoadProfile"},{"id":2376,"kind":256,"name":"ICliLoadAllProfiles","url":"interfaces/_zowe_imperative.icliloadallprofiles.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2377,"kind":1024,"name":"noSecure","url":"interfaces/_zowe_imperative.icliloadallprofiles.html#nosecure","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICliLoadAllProfiles"},{"id":2378,"kind":1024,"name":"typeOnly","url":"interfaces/_zowe_imperative.icliloadallprofiles.html#typeonly","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICliLoadAllProfiles"},{"id":2379,"kind":128,"name":"CliProfileManager","url":"classes/_zowe_imperative.cliprofilemanager.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2380,"kind":2048,"name":"loadAll","url":"classes/_zowe_imperative.cliprofilemanager.html#loadall","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.CliProfileManager"},{"id":2381,"kind":2048,"name":"saveProfile","url":"classes/_zowe_imperative.cliprofilemanager.html#saveprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2382,"kind":2048,"name":"updateProfile","url":"classes/_zowe_imperative.cliprofilemanager.html#updateprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2383,"kind":2048,"name":"loadProfile","url":"classes/_zowe_imperative.cliprofilemanager.html#loadprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2384,"kind":2048,"name":"deleteProfile","url":"classes/_zowe_imperative.cliprofilemanager.html#deleteprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2385,"kind":2048,"name":"validateProfile","url":"classes/_zowe_imperative.cliprofilemanager.html#validateprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2386,"kind":2048,"name":"addProfileInstruction","url":"classes/_zowe_imperative.cliprofilemanager.html#addprofileinstruction","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CliProfileManager"},{"id":2387,"kind":2048,"name":"findOptions","url":"classes/_zowe_imperative.cliprofilemanager.html#findoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CliProfileManager"},{"id":2388,"kind":2048,"name":"processSecureProperties","url":"classes/_zowe_imperative.cliprofilemanager.html#processsecureproperties","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CliProfileManager"},{"id":2389,"kind":2048,"name":"updateProfileFromCliArgs","url":"classes/_zowe_imperative.cliprofilemanager.html#updateprofilefromcliargs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CliProfileManager"},{"id":2390,"kind":2048,"name":"updateProfileFieldsFromCommandArguments","url":"classes/_zowe_imperative.cliprofilemanager.html#updateprofilefieldsfromcommandarguments","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CliProfileManager"},{"id":2391,"kind":2048,"name":"createProfileFromCommandArguments","url":"classes/_zowe_imperative.cliprofilemanager.html#createprofilefromcommandarguments","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CliProfileManager"},{"id":2392,"kind":2048,"name":"insertCliArgumentsIntoProfile","url":"classes/_zowe_imperative.cliprofilemanager.html#insertcliargumentsintoprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CliProfileManager"},{"id":2393,"kind":2048,"name":"insertDependenciesIntoProfileFromCLIArguments","url":"classes/_zowe_imperative.cliprofilemanager.html#insertdependenciesintoprofilefromcliarguments","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.CliProfileManager"},{"id":2394,"kind":2048,"name":"initialize","url":"classes/_zowe_imperative.cliprofilemanager.html#initialize","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.CliProfileManager"},{"id":2395,"kind":2048,"name":"loadDependencies","url":"classes/_zowe_imperative.cliprofilemanager.html#loaddependencies","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2396,"kind":1024,"name":"PROFILE_EXTENSION","url":"classes/_zowe_imperative.cliprofilemanager.html#profile_extension","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.CliProfileManager"},{"id":2397,"kind":1024,"name":"META_FILE_SUFFIX","url":"classes/_zowe_imperative.cliprofilemanager.html#meta_file_suffix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.CliProfileManager"},{"id":2398,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.cliprofilemanager.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.CliProfileManager"},{"id":2399,"kind":262144,"name":"loadCounter","url":"classes/_zowe_imperative.cliprofilemanager.html#loadcounter","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2400,"kind":262144,"name":"log","url":"classes/_zowe_imperative.cliprofilemanager.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2401,"kind":262144,"name":"managerParameters","url":"classes/_zowe_imperative.cliprofilemanager.html#managerparameters","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2402,"kind":262144,"name":"profileType","url":"classes/_zowe_imperative.cliprofilemanager.html#profiletype","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2403,"kind":262144,"name":"productDisplayName","url":"classes/_zowe_imperative.cliprofilemanager.html#productdisplayname","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2404,"kind":262144,"name":"profileTypeConfiguration","url":"classes/_zowe_imperative.cliprofilemanager.html#profiletypeconfiguration","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2405,"kind":262144,"name":"profileTypeConfigurations","url":"classes/_zowe_imperative.cliprofilemanager.html#profiletypeconfigurations","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2406,"kind":262144,"name":"profileTypeSchema","url":"classes/_zowe_imperative.cliprofilemanager.html#profiletypeschema","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2407,"kind":262144,"name":"profileTypeRootDirectory","url":"classes/_zowe_imperative.cliprofilemanager.html#profiletyperootdirectory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2408,"kind":262144,"name":"profileTypeMetaFileName","url":"classes/_zowe_imperative.cliprofilemanager.html#profiletypemetafilename","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2409,"kind":262144,"name":"profileRootDirectory","url":"classes/_zowe_imperative.cliprofilemanager.html#profilerootdirectory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2410,"kind":2048,"name":"getAllProfileNames","url":"classes/_zowe_imperative.cliprofilemanager.html#getallprofilenames","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.CliProfileManager"},{"id":2411,"kind":262144,"name":"configurations","url":"classes/_zowe_imperative.cliprofilemanager.html#configurations","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.CliProfileManager"},{"id":2412,"kind":2048,"name":"save","url":"classes/_zowe_imperative.cliprofilemanager.html#save","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"@zowe/imperative.CliProfileManager"},{"id":2413,"kind":2048,"name":"load","url":"classes/_zowe_imperative.cliprofilemanager.html#load","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"@zowe/imperative.CliProfileManager"},{"id":2414,"kind":2048,"name":"validate","url":"classes/_zowe_imperative.cliprofilemanager.html#validate","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"@zowe/imperative.CliProfileManager"},{"id":2415,"kind":2048,"name":"mergeProfiles","url":"classes/_zowe_imperative.cliprofilemanager.html#mergeprofiles","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.CliProfileManager"},{"id":2416,"kind":2048,"name":"delete","url":"classes/_zowe_imperative.cliprofilemanager.html#delete","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"@zowe/imperative.CliProfileManager"},{"id":2417,"kind":2048,"name":"update","url":"classes/_zowe_imperative.cliprofilemanager.html#update","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"@zowe/imperative.CliProfileManager"},{"id":2418,"kind":2048,"name":"setDefault","url":"classes/_zowe_imperative.cliprofilemanager.html#setdefault","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.CliProfileManager"},{"id":2419,"kind":2048,"name":"clearDefault","url":"classes/_zowe_imperative.cliprofilemanager.html#cleardefault","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.CliProfileManager"},{"id":2420,"kind":2048,"name":"getDefaultProfileName","url":"classes/_zowe_imperative.cliprofilemanager.html#getdefaultprofilename","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.CliProfileManager"},{"id":2421,"kind":2048,"name":"deleteProfileFromDisk","url":"classes/_zowe_imperative.cliprofilemanager.html#deleteprofilefromdisk","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2422,"kind":2048,"name":"validateProfileObject","url":"classes/_zowe_imperative.cliprofilemanager.html#validateprofileobject","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2423,"kind":2048,"name":"validateProfileAgainstSchema","url":"classes/_zowe_imperative.cliprofilemanager.html#validateprofileagainstschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2424,"kind":2048,"name":"constructFullProfilePath","url":"classes/_zowe_imperative.cliprofilemanager.html#constructfullprofilepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2425,"kind":2048,"name":"locateExistingProfile","url":"classes/_zowe_imperative.cliprofilemanager.html#locateexistingprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2426,"kind":2048,"name":"loadFailed","url":"classes/_zowe_imperative.cliprofilemanager.html#loadfailed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2427,"kind":2048,"name":"isProfileEmpty","url":"classes/_zowe_imperative.cliprofilemanager.html#isprofileempty","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2428,"kind":2048,"name":"loadSpecificProfile","url":"classes/_zowe_imperative.cliprofilemanager.html#loadspecificprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.CliProfileManager"},{"id":2429,"kind":2048,"name":"validateRequiredDependenciesAreSpecified","url":"classes/_zowe_imperative.cliprofilemanager.html#validaterequireddependenciesarespecified","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.CliProfileManager"},{"id":2430,"kind":256,"name":"IProfile","url":"interfaces/_zowe_imperative.iprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2431,"kind":1024,"name":"dependencies","url":"interfaces/_zowe_imperative.iprofile.html#dependencies","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfile"},{"id":2432,"kind":256,"name":"IProfileLoaded","url":"interfaces/_zowe_imperative.iprofileloaded.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2433,"kind":1024,"name":"message","url":"interfaces/_zowe_imperative.iprofileloaded.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileLoaded"},{"id":2434,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.iprofileloaded.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileLoaded"},{"id":2435,"kind":1024,"name":"failNotFound","url":"interfaces/_zowe_imperative.iprofileloaded.html#failnotfound","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileLoaded"},{"id":2436,"kind":1024,"name":"referencedBy","url":"interfaces/_zowe_imperative.iprofileloaded.html#referencedby","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileLoaded"},{"id":2437,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.iprofileloaded.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileLoaded"},{"id":2438,"kind":1024,"name":"profile","url":"interfaces/_zowe_imperative.iprofileloaded.html#profile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileLoaded"},{"id":2439,"kind":1024,"name":"dependenciesLoaded","url":"interfaces/_zowe_imperative.iprofileloaded.html#dependenciesloaded","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileLoaded"},{"id":2440,"kind":1024,"name":"dependencyLoadResponses","url":"interfaces/_zowe_imperative.iprofileloaded.html#dependencyloadresponses","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileLoaded"},{"id":2441,"kind":128,"name":"ProfileUtils","url":"classes/_zowe_imperative.profileutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2442,"kind":2048,"name":"constructProfilesRootDirectory","url":"classes/_zowe_imperative.profileutils.html#constructprofilesrootdirectory","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileUtils"},{"id":2443,"kind":2048,"name":"flattenDependencies","url":"classes/_zowe_imperative.profileutils.html#flattendependencies","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileUtils"},{"id":2444,"kind":2048,"name":"getAllTypeNames","url":"classes/_zowe_imperative.profileutils.html#getalltypenames","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileUtils"},{"id":2445,"kind":2048,"name":"getProfileOption","url":"classes/_zowe_imperative.profileutils.html#getprofileoption","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileUtils"},{"id":2446,"kind":2048,"name":"getProfileOptionAlias","url":"classes/_zowe_imperative.profileutils.html#getprofileoptionalias","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileUtils"},{"id":2447,"kind":2048,"name":"getProfileOptionAndAlias","url":"classes/_zowe_imperative.profileutils.html#getprofileoptionandalias","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileUtils"},{"id":2448,"kind":2048,"name":"getProfileMapKey","url":"classes/_zowe_imperative.profileutils.html#getprofilemapkey","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileUtils"},{"id":2449,"kind":2048,"name":"getProfilePropertyKey","url":"classes/_zowe_imperative.profileutils.html#getprofilepropertykey","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileUtils"},{"id":2450,"kind":128,"name":"CommandPreparer","url":"classes/_zowe_imperative.commandpreparer.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2451,"kind":2048,"name":"prepare","url":"classes/_zowe_imperative.commandpreparer.html#prepare","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CommandPreparer"},{"id":2452,"kind":2048,"name":"validateDefinitionTree","url":"classes/_zowe_imperative.commandpreparer.html#validatedefinitiontree","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CommandPreparer"},{"id":2453,"kind":2048,"name":"perfomBasicValidation","url":"classes/_zowe_imperative.commandpreparer.html#perfombasicvalidation","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandPreparer"},{"id":2454,"kind":2048,"name":"performBasicPositionalValidation","url":"classes/_zowe_imperative.commandpreparer.html#performbasicpositionalvalidation","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandPreparer"},{"id":2455,"kind":2048,"name":"performBasicOptionValidation","url":"classes/_zowe_imperative.commandpreparer.html#performbasicoptionvalidation","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandPreparer"},{"id":2456,"kind":2048,"name":"setDefaultValues","url":"classes/_zowe_imperative.commandpreparer.html#setdefaultvalues","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandPreparer"},{"id":2457,"kind":2048,"name":"populatePassOnValueFromParent","url":"classes/_zowe_imperative.commandpreparer.html#populatepassonvaluefromparent","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandPreparer"},{"id":2458,"kind":2048,"name":"appendPassOnOptions","url":"classes/_zowe_imperative.commandpreparer.html#appendpassonoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandPreparer"},{"id":2459,"kind":2048,"name":"appendAutoOptions","url":"classes/_zowe_imperative.commandpreparer.html#appendautooptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandPreparer"},{"id":2460,"kind":2048,"name":"passOn","url":"classes/_zowe_imperative.commandpreparer.html#passon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandPreparer"},{"id":2461,"kind":2048,"name":"ignoreNode","url":"classes/_zowe_imperative.commandpreparer.html#ignorenode","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CommandPreparer"},{"id":2462,"kind":128,"name":"YargsConfigurer","url":"classes/_zowe_imperative.yargsconfigurer.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2463,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.yargsconfigurer.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.YargsConfigurer"},{"id":2464,"kind":1024,"name":"rootCommand","url":"classes/_zowe_imperative.yargsconfigurer.html#rootcommand","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2465,"kind":1024,"name":"yargs","url":"classes/_zowe_imperative.yargsconfigurer.html#yargs","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2466,"kind":1024,"name":"commandRespParms","url":"classes/_zowe_imperative.yargsconfigurer.html#commandrespparms","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2467,"kind":1024,"name":"profileManagerFactory","url":"classes/_zowe_imperative.yargsconfigurer.html#profilemanagerfactory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2468,"kind":1024,"name":"helpGeneratorFactory","url":"classes/_zowe_imperative.yargsconfigurer.html#helpgeneratorfactory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2469,"kind":1024,"name":"experimentalCommandDescription","url":"classes/_zowe_imperative.yargsconfigurer.html#experimentalcommanddescription","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2470,"kind":1024,"name":"rootCommandName","url":"classes/_zowe_imperative.yargsconfigurer.html#rootcommandname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2471,"kind":1024,"name":"commandLine","url":"classes/_zowe_imperative.yargsconfigurer.html#commandline","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2472,"kind":1024,"name":"envVariablePrefix","url":"classes/_zowe_imperative.yargsconfigurer.html#envvariableprefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2473,"kind":1024,"name":"promptPhrase","url":"classes/_zowe_imperative.yargsconfigurer.html#promptphrase","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2474,"kind":2048,"name":"configure","url":"classes/_zowe_imperative.yargsconfigurer.html#configure","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.YargsConfigurer"},{"id":2475,"kind":2048,"name":"buildFailureMessage","url":"classes/_zowe_imperative.yargsconfigurer.html#buildfailuremessage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2476,"kind":2048,"name":"buildFailedCommandDefinition","url":"classes/_zowe_imperative.yargsconfigurer.html#buildfailedcommanddefinition","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2477,"kind":2048,"name":"getClosestCommand","url":"classes/_zowe_imperative.yargsconfigurer.html#getclosestcommand","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2478,"kind":2048,"name":"getResponseFormat","url":"classes/_zowe_imperative.yargsconfigurer.html#getresponseformat","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsConfigurer"},{"id":2479,"kind":128,"name":"YargsDefiner","url":"classes/_zowe_imperative.yargsdefiner.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2480,"kind":1024,"name":"mYargsInstance","url":"classes/_zowe_imperative.yargsdefiner.html#myargsinstance","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsDefiner"},{"id":2481,"kind":1024,"name":"mPrimaryHighlightColor","url":"classes/_zowe_imperative.yargsdefiner.html#mprimaryhighlightcolor","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsDefiner"},{"id":2482,"kind":1024,"name":"mRootCommandName","url":"classes/_zowe_imperative.yargsdefiner.html#mrootcommandname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsDefiner"},{"id":2483,"kind":1024,"name":"mCommandLine","url":"classes/_zowe_imperative.yargsdefiner.html#mcommandline","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsDefiner"},{"id":2484,"kind":1024,"name":"mEnvVariablePrefix","url":"classes/_zowe_imperative.yargsdefiner.html#menvvariableprefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsDefiner"},{"id":2485,"kind":1024,"name":"mHelpFactory","url":"classes/_zowe_imperative.yargsdefiner.html#mhelpfactory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsDefiner"},{"id":2486,"kind":1024,"name":"mProfileManagerFactory","url":"classes/_zowe_imperative.yargsdefiner.html#mprofilemanagerfactory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsDefiner"},{"id":2487,"kind":1024,"name":"mExperimentalCommandDescription","url":"classes/_zowe_imperative.yargsdefiner.html#mexperimentalcommanddescription","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsDefiner"},{"id":2488,"kind":1024,"name":"mPromptPhrase","url":"classes/_zowe_imperative.yargsdefiner.html#mpromptphrase","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsDefiner"},{"id":2489,"kind":1024,"name":"log","url":"classes/_zowe_imperative.yargsdefiner.html#log","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.YargsDefiner"},{"id":2490,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.yargsdefiner.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.YargsDefiner"},{"id":2491,"kind":2048,"name":"define","url":"classes/_zowe_imperative.yargsdefiner.html#define","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.YargsDefiner"},{"id":2492,"kind":128,"name":"AbstractCommandBuilder","url":"classes/_zowe_imperative.abstractcommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2493,"kind":2048,"name":"appendToDocument","url":"classes/_zowe_imperative.abstractcommandbuilder.html#appendtodocument","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractCommandBuilder"},{"id":2494,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.abstractcommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCommandBuilder"},{"id":2495,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.abstractcommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCommandBuilder"},{"id":2496,"kind":2048,"name":"build","url":"classes/_zowe_imperative.abstractcommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractCommandBuilder"},{"id":2497,"kind":128,"name":"ProfilesCommandBuilder","url":"classes/_zowe_imperative.profilescommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2498,"kind":1024,"name":"mSchema","url":"classes/_zowe_imperative.profilescommandbuilder.html#mschema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.ProfilesCommandBuilder"},{"id":2499,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.profilescommandbuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.ProfilesCommandBuilder"},{"id":2500,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.profilescommandbuilder.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.ProfilesCommandBuilder"},{"id":2501,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.profilescommandbuilder.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.ProfilesCommandBuilder"},{"id":2502,"kind":1024,"name":"mProfileConfig","url":"classes/_zowe_imperative.profilescommandbuilder.html#mprofileconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.ProfilesCommandBuilder"},{"id":2503,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.profilescommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfilesCommandBuilder"},{"id":2504,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.profilescommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfilesCommandBuilder"},{"id":2505,"kind":2048,"name":"build","url":"classes/_zowe_imperative.profilescommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfilesCommandBuilder"},{"id":2506,"kind":2048,"name":"buildProfileSegmentFromSchema","url":"classes/_zowe_imperative.profilescommandbuilder.html#buildprofilesegmentfromschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.ProfilesCommandBuilder"},{"id":2507,"kind":2048,"name":"buildOptionsFromProfileSchema","url":"classes/_zowe_imperative.profilescommandbuilder.html#buildoptionsfromprofileschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.ProfilesCommandBuilder"},{"id":2508,"kind":128,"name":"ProfilesCreateCommandBuilder","url":"classes/_zowe_imperative.profilescreatecommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2509,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.profilescreatecommandbuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesCreateCommandBuilder"},{"id":2510,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.profilescreatecommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesCreateCommandBuilder"},{"id":2511,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.profilescreatecommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesCreateCommandBuilder"},{"id":2512,"kind":2048,"name":"buildProfileSegmentFromSchema","url":"classes/_zowe_imperative.profilescreatecommandbuilder.html#buildprofilesegmentfromschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.ProfilesCreateCommandBuilder"},{"id":2513,"kind":1024,"name":"mSchema","url":"classes/_zowe_imperative.profilescreatecommandbuilder.html#mschema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesCreateCommandBuilder"},{"id":2514,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.profilescreatecommandbuilder.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesCreateCommandBuilder"},{"id":2515,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.profilescreatecommandbuilder.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesCreateCommandBuilder"},{"id":2516,"kind":1024,"name":"mProfileConfig","url":"classes/_zowe_imperative.profilescreatecommandbuilder.html#mprofileconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesCreateCommandBuilder"},{"id":2517,"kind":2048,"name":"build","url":"classes/_zowe_imperative.profilescreatecommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfilesCreateCommandBuilder"},{"id":2518,"kind":2048,"name":"buildOptionsFromProfileSchema","url":"classes/_zowe_imperative.profilescreatecommandbuilder.html#buildoptionsfromprofileschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesCreateCommandBuilder"},{"id":2519,"kind":128,"name":"ProfilesUpdateCommandBuilder","url":"classes/_zowe_imperative.profilesupdatecommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2520,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.profilesupdatecommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesUpdateCommandBuilder"},{"id":2521,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.profilesupdatecommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesUpdateCommandBuilder"},{"id":2522,"kind":2048,"name":"buildProfileSegmentFromSchema","url":"classes/_zowe_imperative.profilesupdatecommandbuilder.html#buildprofilesegmentfromschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.ProfilesUpdateCommandBuilder"},{"id":2523,"kind":1024,"name":"mSchema","url":"classes/_zowe_imperative.profilesupdatecommandbuilder.html#mschema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesUpdateCommandBuilder"},{"id":2524,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.profilesupdatecommandbuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfilesUpdateCommandBuilder"},{"id":2525,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.profilesupdatecommandbuilder.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesUpdateCommandBuilder"},{"id":2526,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.profilesupdatecommandbuilder.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesUpdateCommandBuilder"},{"id":2527,"kind":1024,"name":"mProfileConfig","url":"classes/_zowe_imperative.profilesupdatecommandbuilder.html#mprofileconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesUpdateCommandBuilder"},{"id":2528,"kind":2048,"name":"build","url":"classes/_zowe_imperative.profilesupdatecommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfilesUpdateCommandBuilder"},{"id":2529,"kind":2048,"name":"buildOptionsFromProfileSchema","url":"classes/_zowe_imperative.profilesupdatecommandbuilder.html#buildoptionsfromprofileschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesUpdateCommandBuilder"},{"id":2530,"kind":128,"name":"ProfilesDeleteCommandBuilder","url":"classes/_zowe_imperative.profilesdeletecommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2531,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.profilesdeletecommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesDeleteCommandBuilder"},{"id":2532,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.profilesdeletecommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesDeleteCommandBuilder"},{"id":2533,"kind":2048,"name":"buildProfileSegmentFromSchema","url":"classes/_zowe_imperative.profilesdeletecommandbuilder.html#buildprofilesegmentfromschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.ProfilesDeleteCommandBuilder"},{"id":2534,"kind":1024,"name":"mSchema","url":"classes/_zowe_imperative.profilesdeletecommandbuilder.html#mschema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesDeleteCommandBuilder"},{"id":2535,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.profilesdeletecommandbuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfilesDeleteCommandBuilder"},{"id":2536,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.profilesdeletecommandbuilder.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesDeleteCommandBuilder"},{"id":2537,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.profilesdeletecommandbuilder.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesDeleteCommandBuilder"},{"id":2538,"kind":1024,"name":"mProfileConfig","url":"classes/_zowe_imperative.profilesdeletecommandbuilder.html#mprofileconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesDeleteCommandBuilder"},{"id":2539,"kind":2048,"name":"build","url":"classes/_zowe_imperative.profilesdeletecommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfilesDeleteCommandBuilder"},{"id":2540,"kind":2048,"name":"buildOptionsFromProfileSchema","url":"classes/_zowe_imperative.profilesdeletecommandbuilder.html#buildoptionsfromprofileschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesDeleteCommandBuilder"},{"id":2541,"kind":128,"name":"ProfilesValidateCommandBuilder","url":"classes/_zowe_imperative.profilesvalidatecommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2542,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.profilesvalidatecommandbuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesValidateCommandBuilder"},{"id":2543,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.profilesvalidatecommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesValidateCommandBuilder"},{"id":2544,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.profilesvalidatecommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesValidateCommandBuilder"},{"id":2545,"kind":2048,"name":"buildProfileSegmentFromSchema","url":"classes/_zowe_imperative.profilesvalidatecommandbuilder.html#buildprofilesegmentfromschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.ProfilesValidateCommandBuilder"},{"id":2546,"kind":1024,"name":"mSchema","url":"classes/_zowe_imperative.profilesvalidatecommandbuilder.html#mschema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesValidateCommandBuilder"},{"id":2547,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.profilesvalidatecommandbuilder.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesValidateCommandBuilder"},{"id":2548,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.profilesvalidatecommandbuilder.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesValidateCommandBuilder"},{"id":2549,"kind":1024,"name":"mProfileConfig","url":"classes/_zowe_imperative.profilesvalidatecommandbuilder.html#mprofileconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesValidateCommandBuilder"},{"id":2550,"kind":2048,"name":"build","url":"classes/_zowe_imperative.profilesvalidatecommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfilesValidateCommandBuilder"},{"id":2551,"kind":2048,"name":"buildOptionsFromProfileSchema","url":"classes/_zowe_imperative.profilesvalidatecommandbuilder.html#buildoptionsfromprofileschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesValidateCommandBuilder"},{"id":2552,"kind":128,"name":"ProfilesListCommandBuilder","url":"classes/_zowe_imperative.profileslistcommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2553,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.profileslistcommandbuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesListCommandBuilder"},{"id":2554,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.profileslistcommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesListCommandBuilder"},{"id":2555,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.profileslistcommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesListCommandBuilder"},{"id":2556,"kind":2048,"name":"buildProfileSegmentFromSchema","url":"classes/_zowe_imperative.profileslistcommandbuilder.html#buildprofilesegmentfromschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.ProfilesListCommandBuilder"},{"id":2557,"kind":1024,"name":"mSchema","url":"classes/_zowe_imperative.profileslistcommandbuilder.html#mschema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesListCommandBuilder"},{"id":2558,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.profileslistcommandbuilder.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesListCommandBuilder"},{"id":2559,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.profileslistcommandbuilder.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesListCommandBuilder"},{"id":2560,"kind":1024,"name":"mProfileConfig","url":"classes/_zowe_imperative.profileslistcommandbuilder.html#mprofileconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesListCommandBuilder"},{"id":2561,"kind":2048,"name":"build","url":"classes/_zowe_imperative.profileslistcommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfilesListCommandBuilder"},{"id":2562,"kind":2048,"name":"buildOptionsFromProfileSchema","url":"classes/_zowe_imperative.profileslistcommandbuilder.html#buildoptionsfromprofileschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesListCommandBuilder"},{"id":2563,"kind":128,"name":"ProfilesSetCommandBuilder","url":"classes/_zowe_imperative.profilessetcommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2564,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.profilessetcommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesSetCommandBuilder"},{"id":2565,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.profilessetcommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesSetCommandBuilder"},{"id":2566,"kind":2048,"name":"buildProfileSegmentFromSchema","url":"classes/_zowe_imperative.profilessetcommandbuilder.html#buildprofilesegmentfromschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.ProfilesSetCommandBuilder"},{"id":2567,"kind":1024,"name":"mSchema","url":"classes/_zowe_imperative.profilessetcommandbuilder.html#mschema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesSetCommandBuilder"},{"id":2568,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.profilessetcommandbuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfilesSetCommandBuilder"},{"id":2569,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.profilessetcommandbuilder.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesSetCommandBuilder"},{"id":2570,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.profilessetcommandbuilder.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesSetCommandBuilder"},{"id":2571,"kind":1024,"name":"mProfileConfig","url":"classes/_zowe_imperative.profilessetcommandbuilder.html#mprofileconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesSetCommandBuilder"},{"id":2572,"kind":2048,"name":"build","url":"classes/_zowe_imperative.profilessetcommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfilesSetCommandBuilder"},{"id":2573,"kind":2048,"name":"buildOptionsFromProfileSchema","url":"classes/_zowe_imperative.profilessetcommandbuilder.html#buildoptionsfromprofileschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesSetCommandBuilder"},{"id":2574,"kind":128,"name":"CompleteProfilesGroupBuilder","url":"classes/_zowe_imperative.completeprofilesgroupbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2575,"kind":2048,"name":"getProfileGroup","url":"classes/_zowe_imperative.completeprofilesgroupbuilder.html#getprofilegroup","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CompleteProfilesGroupBuilder"},{"id":2576,"kind":128,"name":"ImperativeHelpGeneratorFactory","url":"classes/_zowe_imperative.imperativehelpgeneratorfactory.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2577,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.imperativehelpgeneratorfactory.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeHelpGeneratorFactory"},{"id":2578,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.imperativehelpgeneratorfactory.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ImperativeHelpGeneratorFactory"},{"id":2579,"kind":2048,"name":"getGenerator","url":"classes/_zowe_imperative.imperativehelpgeneratorfactory.html#getgenerator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.ImperativeHelpGeneratorFactory"},{"id":2580,"kind":262144,"name":"config","url":"classes/_zowe_imperative.imperativehelpgeneratorfactory.html#config","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeHelpGeneratorFactory"},{"id":2581,"kind":2048,"name":"getHelpGenerator","url":"classes/_zowe_imperative.imperativehelpgeneratorfactory.html#gethelpgenerator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ImperativeHelpGeneratorFactory"},{"id":2582,"kind":262144,"name":"rootCommandName","url":"classes/_zowe_imperative.imperativehelpgeneratorfactory.html#rootcommandname","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ImperativeHelpGeneratorFactory"},{"id":2583,"kind":262144,"name":"primaryHighlightColor","url":"classes/_zowe_imperative.imperativehelpgeneratorfactory.html#primaryhighlightcolor","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ImperativeHelpGeneratorFactory"},{"id":2584,"kind":262144,"name":"produceMarkdown","url":"classes/_zowe_imperative.imperativehelpgeneratorfactory.html#producemarkdown","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ImperativeHelpGeneratorFactory"},{"id":2585,"kind":262144,"name":"factoryParameters","url":"classes/_zowe_imperative.imperativehelpgeneratorfactory.html#factoryparameters","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ImperativeHelpGeneratorFactory"},{"id":2586,"kind":128,"name":"OverridesLoader","url":"classes/_zowe_imperative.overridesloader.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2587,"kind":1024,"name":"ZOWE_CLI_PACKAGE_NAME","url":"classes/_zowe_imperative.overridesloader.html#zowe_cli_package_name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.OverridesLoader"},{"id":2588,"kind":2048,"name":"load","url":"classes/_zowe_imperative.overridesloader.html#load","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.OverridesLoader"},{"id":2589,"kind":2048,"name":"ensureCredentialManagerLoaded","url":"classes/_zowe_imperative.overridesloader.html#ensurecredentialmanagerloaded","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.OverridesLoader"},{"id":2590,"kind":2048,"name":"loadCredentialManager","url":"classes/_zowe_imperative.overridesloader.html#loadcredentialmanager","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.OverridesLoader"},{"id":2591,"kind":2048,"name":"shouldUseKeytar","url":"classes/_zowe_imperative.overridesloader.html#shouldusekeytar","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.OverridesLoader"},{"id":2592,"kind":2048,"name":"loadSecureConfig","url":"classes/_zowe_imperative.overridesloader.html#loadsecureconfig","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.OverridesLoader"},{"id":2593,"kind":128,"name":"ImperativeProfileManagerFactory","url":"classes/_zowe_imperative.imperativeprofilemanagerfactory.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2594,"kind":1024,"name":"mImperativeApi","url":"classes/_zowe_imperative.imperativeprofilemanagerfactory.html#mimperativeapi","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeProfileManagerFactory"},{"id":2595,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.imperativeprofilemanagerfactory.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeProfileManagerFactory"},{"id":2596,"kind":2048,"name":"getManager","url":"classes/_zowe_imperative.imperativeprofilemanagerfactory.html#getmanager","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ImperativeProfileManagerFactory"},{"id":2597,"kind":128,"name":"AuthCommandBuilder","url":"classes/_zowe_imperative.authcommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2598,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.authcommandbuilder.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AuthCommandBuilder"},{"id":2599,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.authcommandbuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.AuthCommandBuilder"},{"id":2600,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.authcommandbuilder.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AuthCommandBuilder"},{"id":2601,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.authcommandbuilder.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AuthCommandBuilder"},{"id":2602,"kind":1024,"name":"mAuthConfig","url":"classes/_zowe_imperative.authcommandbuilder.html#mauthconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AuthCommandBuilder"},{"id":2603,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.authcommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AuthCommandBuilder"},{"id":2604,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.authcommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AuthCommandBuilder"},{"id":2605,"kind":2048,"name":"build","url":"classes/_zowe_imperative.authcommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AuthCommandBuilder"},{"id":2606,"kind":2048,"name":"buildAuthSegmentFromConfig","url":"classes/_zowe_imperative.authcommandbuilder.html#buildauthsegmentfromconfig","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AuthCommandBuilder"},{"id":2607,"kind":128,"name":"AuthLoginCommandBuilder","url":"classes/_zowe_imperative.authlogincommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2608,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.authlogincommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.AuthLoginCommandBuilder"},{"id":2609,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.authlogincommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.AuthLoginCommandBuilder"},{"id":2610,"kind":2048,"name":"buildAuthSegmentFromConfig","url":"classes/_zowe_imperative.authlogincommandbuilder.html#buildauthsegmentfromconfig","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.AuthLoginCommandBuilder"},{"id":2611,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.authlogincommandbuilder.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.AuthLoginCommandBuilder"},{"id":2612,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.authlogincommandbuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.AuthLoginCommandBuilder"},{"id":2613,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.authlogincommandbuilder.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.AuthLoginCommandBuilder"},{"id":2614,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.authlogincommandbuilder.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.AuthLoginCommandBuilder"},{"id":2615,"kind":1024,"name":"mAuthConfig","url":"classes/_zowe_imperative.authlogincommandbuilder.html#mauthconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.AuthLoginCommandBuilder"},{"id":2616,"kind":2048,"name":"build","url":"classes/_zowe_imperative.authlogincommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.AuthLoginCommandBuilder"},{"id":2617,"kind":128,"name":"AuthLogoutCommandBuilder","url":"classes/_zowe_imperative.authlogoutcommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2618,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.authlogoutcommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.AuthLogoutCommandBuilder"},{"id":2619,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.authlogoutcommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.AuthLogoutCommandBuilder"},{"id":2620,"kind":2048,"name":"buildAuthSegmentFromConfig","url":"classes/_zowe_imperative.authlogoutcommandbuilder.html#buildauthsegmentfromconfig","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.AuthLogoutCommandBuilder"},{"id":2621,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.authlogoutcommandbuilder.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.AuthLogoutCommandBuilder"},{"id":2622,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.authlogoutcommandbuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.AuthLogoutCommandBuilder"},{"id":2623,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.authlogoutcommandbuilder.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.AuthLogoutCommandBuilder"},{"id":2624,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.authlogoutcommandbuilder.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.AuthLogoutCommandBuilder"},{"id":2625,"kind":1024,"name":"mAuthConfig","url":"classes/_zowe_imperative.authlogoutcommandbuilder.html#mauthconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.AuthLogoutCommandBuilder"},{"id":2626,"kind":2048,"name":"build","url":"classes/_zowe_imperative.authlogoutcommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.AuthLogoutCommandBuilder"},{"id":2627,"kind":256,"name":"IImperativeAuthGroupConfig","url":"interfaces/_zowe_imperative.iimperativeauthgroupconfig.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2628,"kind":1024,"name":"authGroup","url":"interfaces/_zowe_imperative.iimperativeauthgroupconfig.html#authgroup","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeAuthGroupConfig"},{"id":2629,"kind":1024,"name":"loginGroup","url":"interfaces/_zowe_imperative.iimperativeauthgroupconfig.html#logingroup","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeAuthGroupConfig"},{"id":2630,"kind":1024,"name":"logoutGroup","url":"interfaces/_zowe_imperative.iimperativeauthgroupconfig.html#logoutgroup","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeAuthGroupConfig"},{"id":2631,"kind":128,"name":"CompleteAuthGroupBuilder","url":"classes/_zowe_imperative.completeauthgroupbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2632,"kind":2048,"name":"getAuthGroup","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#getauthgroup","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CompleteAuthGroupBuilder"},{"id":2633,"kind":2097152,"name":"defaultAuthGroup","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultauthgroup","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CompleteAuthGroupBuilder"},{"id":2634,"kind":32,"name":"name","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultauthgroup.name","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultAuthGroup"},{"id":2635,"kind":32,"name":"description","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultauthgroup.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultAuthGroup"},{"id":2636,"kind":32,"name":"type","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultauthgroup.type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultAuthGroup"},{"id":2637,"kind":32,"name":"children","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultauthgroup.children","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultAuthGroup"},{"id":2638,"kind":2097152,"name":"defaultLoginGroup","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogingroup","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CompleteAuthGroupBuilder"},{"id":2639,"kind":32,"name":"name","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogingroup.name-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultLoginGroup"},{"id":2640,"kind":32,"name":"description","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogingroup.description-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultLoginGroup"},{"id":2641,"kind":32,"name":"summary","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogingroup.summary","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultLoginGroup"},{"id":2642,"kind":32,"name":"aliases","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogingroup.aliases","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultLoginGroup"},{"id":2643,"kind":32,"name":"type","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogingroup.type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultLoginGroup"},{"id":2644,"kind":32,"name":"children","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogingroup.children-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultLoginGroup"},{"id":2645,"kind":2097152,"name":"defaultLogoutGroup","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogoutgroup","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.CompleteAuthGroupBuilder"},{"id":2646,"kind":32,"name":"name","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogoutgroup.name-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultLogoutGroup"},{"id":2647,"kind":32,"name":"description","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogoutgroup.description-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultLogoutGroup"},{"id":2648,"kind":32,"name":"summary","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogoutgroup.summary-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultLogoutGroup"},{"id":2649,"kind":32,"name":"aliases","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogoutgroup.aliases-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultLogoutGroup"},{"id":2650,"kind":32,"name":"type","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogoutgroup.type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultLogoutGroup"},{"id":2651,"kind":32,"name":"children","url":"classes/_zowe_imperative.completeauthgroupbuilder.html#defaultlogoutgroup.children-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.CompleteAuthGroupBuilder.defaultLogoutGroup"},{"id":2652,"kind":256,"name":"ICommandProfileAutoInitConfig","url":"interfaces/_zowe_imperative.icommandprofileautoinitconfig.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2653,"kind":1024,"name":"handler","url":"interfaces/_zowe_imperative.icommandprofileautoinitconfig.html#handler","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileAutoInitConfig"},{"id":2654,"kind":1024,"name":"provider","url":"interfaces/_zowe_imperative.icommandprofileautoinitconfig.html#provider","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileAutoInitConfig"},{"id":2655,"kind":1024,"name":"autoInit","url":"interfaces/_zowe_imperative.icommandprofileautoinitconfig.html#autoinit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileAutoInitConfig"},{"id":2656,"kind":1024,"name":"profileType","url":"interfaces/_zowe_imperative.icommandprofileautoinitconfig.html#profiletype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileAutoInitConfig"},{"id":2657,"kind":128,"name":"AutoInitConstants","url":"classes/_zowe_imperative.autoinitconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2658,"kind":1024,"name":"AUTO_INIT_OPTION_GROUP","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_group","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AutoInitConstants"},{"id":2659,"kind":2097152,"name":"AUTO_INIT_OPTION_USER_CONFIG","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_user_config","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AutoInitConstants"},{"id":2660,"kind":32,"name":"name","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_user_config.name-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_USER_CONFIG"},{"id":2661,"kind":32,"name":"aliases","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_user_config.aliases-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_USER_CONFIG"},{"id":2662,"kind":32,"name":"description","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_user_config.description-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_USER_CONFIG"},{"id":2663,"kind":32,"name":"type","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_user_config.type-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_USER_CONFIG"},{"id":2664,"kind":32,"name":"defaultValue","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_user_config.defaultvalue-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_USER_CONFIG"},{"id":2665,"kind":32,"name":"group","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_user_config.group-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_USER_CONFIG"},{"id":2666,"kind":2097152,"name":"AUTO_INIT_OPTION_GLOBAL_CONFIG","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_global_config","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AutoInitConstants"},{"id":2667,"kind":32,"name":"name","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_global_config.name-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_GLOBAL_CONFIG"},{"id":2668,"kind":32,"name":"aliases","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_global_config.aliases-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_GLOBAL_CONFIG"},{"id":2669,"kind":32,"name":"description","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_global_config.description-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_GLOBAL_CONFIG"},{"id":2670,"kind":32,"name":"type","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_global_config.type-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_GLOBAL_CONFIG"},{"id":2671,"kind":32,"name":"defaultValue","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_global_config.defaultvalue-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_GLOBAL_CONFIG"},{"id":2672,"kind":32,"name":"group","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_global_config.group-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_GLOBAL_CONFIG"},{"id":2673,"kind":2097152,"name":"AUTO_INIT_OPTION_DRY_RUN","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_dry_run","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AutoInitConstants"},{"id":2674,"kind":32,"name":"name","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_dry_run.name","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_DRY_RUN"},{"id":2675,"kind":32,"name":"aliases","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_dry_run.aliases","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_DRY_RUN"},{"id":2676,"kind":32,"name":"description","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_dry_run.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_DRY_RUN"},{"id":2677,"kind":32,"name":"type","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_dry_run.type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_DRY_RUN"},{"id":2678,"kind":32,"name":"conflictsWith","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_dry_run.conflictswith","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_DRY_RUN"},{"id":2679,"kind":32,"name":"group","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_dry_run.group","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_DRY_RUN"},{"id":2680,"kind":2097152,"name":"AUTO_INIT_OPTION_EDIT","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_edit","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AutoInitConstants"},{"id":2681,"kind":32,"name":"name","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_edit.name-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_EDIT"},{"id":2682,"kind":32,"name":"aliases","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_edit.aliases-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_EDIT"},{"id":2683,"kind":32,"name":"description","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_edit.description-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_EDIT"},{"id":2684,"kind":32,"name":"type","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_edit.type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_EDIT"},{"id":2685,"kind":32,"name":"conflictsWith","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_edit.conflictswith-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_EDIT"},{"id":2686,"kind":32,"name":"group","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_edit.group-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_EDIT"},{"id":2687,"kind":2097152,"name":"AUTO_INIT_OPTION_OVERWRITE","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_overwrite","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AutoInitConstants"},{"id":2688,"kind":32,"name":"name","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_overwrite.name-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_OVERWRITE"},{"id":2689,"kind":32,"name":"aliases","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_overwrite.aliases-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_OVERWRITE"},{"id":2690,"kind":32,"name":"description","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_overwrite.description-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_OVERWRITE"},{"id":2691,"kind":32,"name":"type","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_overwrite.type-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_OVERWRITE"},{"id":2692,"kind":32,"name":"defaultValue","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_overwrite.defaultvalue-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_OVERWRITE"},{"id":2693,"kind":32,"name":"group","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_overwrite.group-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_OVERWRITE"},{"id":2694,"kind":32,"name":"implies","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_overwrite.implies","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_OVERWRITE"},{"id":2695,"kind":2097152,"name":"AUTO_INIT_OPTION_FOR_SURE","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_for_sure","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AutoInitConstants"},{"id":2696,"kind":32,"name":"name","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_for_sure.name-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_FOR_SURE"},{"id":2697,"kind":32,"name":"aliases","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_for_sure.aliases-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_FOR_SURE"},{"id":2698,"kind":32,"name":"description","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_for_sure.description-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_FOR_SURE"},{"id":2699,"kind":32,"name":"type","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_for_sure.type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_FOR_SURE"},{"id":2700,"kind":32,"name":"defaultValue","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_for_sure.defaultvalue","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_FOR_SURE"},{"id":2701,"kind":32,"name":"group","url":"classes/_zowe_imperative.autoinitconstants.html#auto_init_option_for_sure.group-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.AutoInitConstants.AUTO_INIT_OPTION_FOR_SURE"},{"id":2702,"kind":128,"name":"AutoInitCommandBuilder","url":"classes/_zowe_imperative.autoinitcommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2703,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.autoinitcommandbuilder.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AutoInitCommandBuilder"},{"id":2704,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.autoinitcommandbuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.AutoInitCommandBuilder"},{"id":2705,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.autoinitcommandbuilder.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AutoInitCommandBuilder"},{"id":2706,"kind":1024,"name":"mAutoInitConfig","url":"classes/_zowe_imperative.autoinitcommandbuilder.html#mautoinitconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AutoInitCommandBuilder"},{"id":2707,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.autoinitcommandbuilder.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AutoInitCommandBuilder"},{"id":2708,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.autoinitcommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AutoInitCommandBuilder"},{"id":2709,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.autoinitcommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AutoInitCommandBuilder"},{"id":2710,"kind":2048,"name":"build","url":"classes/_zowe_imperative.autoinitcommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AutoInitCommandBuilder"},{"id":2711,"kind":2048,"name":"buildAutoInitSegmentFromConfig","url":"classes/_zowe_imperative.autoinitcommandbuilder.html#buildautoinitsegmentfromconfig","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AutoInitCommandBuilder"},{"id":2712,"kind":128,"name":"CompleteAutoInitCommandBuilder","url":"classes/_zowe_imperative.completeautoinitcommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2713,"kind":2048,"name":"getAutoInitCommand","url":"classes/_zowe_imperative.completeautoinitcommandbuilder.html#getautoinitcommand","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CompleteAutoInitCommandBuilder"},{"id":2714,"kind":128,"name":"EnvFileUtils","url":"classes/_zowe_imperative.envfileutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2715,"kind":1024,"name":"environmentJSON","url":"classes/_zowe_imperative.envfileutils.html#environmentjson","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvFileUtils"},{"id":2716,"kind":2048,"name":"setEnvironmentForApp","url":"classes/_zowe_imperative.envfileutils.html#setenvironmentforapp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvFileUtils"},{"id":2717,"kind":2048,"name":"resetEnvironmentForApp","url":"classes/_zowe_imperative.envfileutils.html#resetenvironmentforapp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvFileUtils"},{"id":2718,"kind":2048,"name":"getEnvironmentFilePath","url":"classes/_zowe_imperative.envfileutils.html#getenvironmentfilepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvFileUtils"},{"id":2719,"kind":2048,"name":"getUserHomeEnvironmentFilePath","url":"classes/_zowe_imperative.envfileutils.html#getuserhomeenvironmentfilepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvFileUtils"},{"id":2720,"kind":2048,"name":"getCliHomeEnvironmentFilePath","url":"classes/_zowe_imperative.envfileutils.html#getclihomeenvironmentfilepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvFileUtils"},{"id":2721,"kind":128,"name":"Imperative","url":"classes/_zowe_imperative.imperative.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2722,"kind":1024,"name":"DEFAULT_DEBUG_FILE","url":"classes/_zowe_imperative.imperative.html#default_debug_file","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2723,"kind":262144,"name":"rootCommandName","url":"classes/_zowe_imperative.imperative.html#rootcommandname","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2724,"kind":262144,"name":"commandLine","url":"classes/_zowe_imperative.imperative.html#commandline","classes":"tsd-kind-accessor tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2725,"kind":262144,"name":"fullCommandTree","url":"classes/_zowe_imperative.imperative.html#fullcommandtree","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2726,"kind":2048,"name":"init","url":"classes/_zowe_imperative.imperative.html#init","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2727,"kind":262144,"name":"console","url":"classes/_zowe_imperative.imperative.html#console","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2728,"kind":2048,"name":"parse","url":"classes/_zowe_imperative.imperative.html#parse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2729,"kind":2048,"name":"getProfileConfiguration","url":"classes/_zowe_imperative.imperative.html#getprofileconfiguration","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2730,"kind":2048,"name":"getHelpGenerator","url":"classes/_zowe_imperative.imperative.html#gethelpgenerator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2731,"kind":262144,"name":"api","url":"classes/_zowe_imperative.imperative.html#api","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2732,"kind":2048,"name":"highlightWithPrimaryColor","url":"classes/_zowe_imperative.imperative.html#highlightwithprimarycolor","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2733,"kind":262144,"name":"envVariablePrefix","url":"classes/_zowe_imperative.imperative.html#envvariableprefix","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2734,"kind":2048,"name":"highlightWithSecondaryColor","url":"classes/_zowe_imperative.imperative.html#highlightwithsecondarycolor","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2735,"kind":1024,"name":"mApi","url":"classes/_zowe_imperative.imperative.html#mapi","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2736,"kind":1024,"name":"mConsoleLog","url":"classes/_zowe_imperative.imperative.html#mconsolelog","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2737,"kind":1024,"name":"mFullCommandTree","url":"classes/_zowe_imperative.imperative.html#mfullcommandtree","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2738,"kind":1024,"name":"mRootCommandName","url":"classes/_zowe_imperative.imperative.html#mrootcommandname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2739,"kind":1024,"name":"mCommandLine","url":"classes/_zowe_imperative.imperative.html#mcommandline","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2740,"kind":1024,"name":"mHelpGeneratorFactory","url":"classes/_zowe_imperative.imperative.html#mhelpgeneratorfactory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2741,"kind":262144,"name":"log","url":"classes/_zowe_imperative.imperative.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2742,"kind":2048,"name":"initAppSettings","url":"classes/_zowe_imperative.imperative.html#initappsettings","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2743,"kind":2048,"name":"initLogging","url":"classes/_zowe_imperative.imperative.html#initlogging","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2744,"kind":2048,"name":"initProfiles","url":"classes/_zowe_imperative.imperative.html#initprofiles","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2745,"kind":2048,"name":"defineCommands","url":"classes/_zowe_imperative.imperative.html#definecommands","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2746,"kind":2048,"name":"constructApiObject","url":"classes/_zowe_imperative.imperative.html#constructapiobject","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2747,"kind":2048,"name":"constructAppLoggerApi","url":"classes/_zowe_imperative.imperative.html#constructapploggerapi","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2748,"kind":2048,"name":"constructImperativeLoggerApi","url":"classes/_zowe_imperative.imperative.html#constructimperativeloggerapi","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2749,"kind":2048,"name":"constructConsoleApi","url":"classes/_zowe_imperative.imperative.html#constructconsoleapi","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2750,"kind":2048,"name":"constructDynamicLoggersApi","url":"classes/_zowe_imperative.imperative.html#constructdynamicloggersapi","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2751,"kind":2048,"name":"getResolvedCmdTree","url":"classes/_zowe_imperative.imperative.html#getresolvedcmdtree","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2752,"kind":2048,"name":"getPreparedCmdTree","url":"classes/_zowe_imperative.imperative.html#getpreparedcmdtree","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2753,"kind":2048,"name":"addAutoGeneratedCommands","url":"classes/_zowe_imperative.imperative.html#addautogeneratedcommands","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.Imperative"},{"id":2754,"kind":128,"name":"AbstractPluginLifeCycle","url":"classes/_zowe_imperative.abstractpluginlifecycle.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2755,"kind":2048,"name":"postInstall","url":"classes/_zowe_imperative.abstractpluginlifecycle.html#postinstall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractPluginLifeCycle"},{"id":2756,"kind":2048,"name":"preUninstall","url":"classes/_zowe_imperative.abstractpluginlifecycle.html#preuninstall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractPluginLifeCycle"},{"id":2757,"kind":128,"name":"BaseAuthHandler","url":"classes/_zowe_imperative.baseauthhandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2758,"kind":1024,"name":"mSession","url":"classes/_zowe_imperative.baseauthhandler.html#msession","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2759,"kind":2048,"name":"doLogin","url":"classes/_zowe_imperative.baseauthhandler.html#dologin","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2760,"kind":2048,"name":"doLogout","url":"classes/_zowe_imperative.baseauthhandler.html#dologout","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2761,"kind":2048,"name":"getPromptParams","url":"classes/_zowe_imperative.baseauthhandler.html#getpromptparams","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2762,"kind":2048,"name":"getAuthHandlerApi","url":"classes/_zowe_imperative.baseauthhandler.html#getauthhandlerapi","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2763,"kind":2048,"name":"processLogin","url":"classes/_zowe_imperative.baseauthhandler.html#processlogin","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2764,"kind":2048,"name":"getBaseProfileName","url":"classes/_zowe_imperative.baseauthhandler.html#getbaseprofilename","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2765,"kind":2048,"name":"promptForBaseProfile","url":"classes/_zowe_imperative.baseauthhandler.html#promptforbaseprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2766,"kind":2048,"name":"showToken","url":"classes/_zowe_imperative.baseauthhandler.html#showtoken","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2767,"kind":2048,"name":"processLogout","url":"classes/_zowe_imperative.baseauthhandler.html#processlogout","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2768,"kind":2048,"name":"processLoginOld","url":"classes/_zowe_imperative.baseauthhandler.html#processloginold","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2769,"kind":2048,"name":"processLogoutOld","url":"classes/_zowe_imperative.baseauthhandler.html#processlogoutold","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2770,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.baseauthhandler.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2771,"kind":1024,"name":"mDefaultTokenType","url":"classes/_zowe_imperative.baseauthhandler.html#mdefaulttokentype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2772,"kind":1024,"name":"mServiceDescription","url":"classes/_zowe_imperative.baseauthhandler.html#mservicedescription","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2773,"kind":2048,"name":"process","url":"classes/_zowe_imperative.baseauthhandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2774,"kind":2048,"name":"createSessCfgFromArgs","url":"classes/_zowe_imperative.baseauthhandler.html#createsesscfgfromargs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BaseAuthHandler"},{"id":2775,"kind":128,"name":"BaseAutoInitHandler","url":"classes/_zowe_imperative.baseautoinithandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2776,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.baseautoinithandler.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.BaseAutoInitHandler"},{"id":2777,"kind":1024,"name":"mServiceDescription","url":"classes/_zowe_imperative.baseautoinithandler.html#mservicedescription","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.BaseAutoInitHandler"},{"id":2778,"kind":1024,"name":"mSession","url":"classes/_zowe_imperative.baseautoinithandler.html#msession","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.BaseAutoInitHandler"},{"id":2779,"kind":2048,"name":"createSessCfgFromArgs","url":"classes/_zowe_imperative.baseautoinithandler.html#createsesscfgfromargs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.BaseAutoInitHandler"},{"id":2780,"kind":2048,"name":"process","url":"classes/_zowe_imperative.baseautoinithandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.BaseAutoInitHandler"},{"id":2781,"kind":2048,"name":"doAutoInit","url":"classes/_zowe_imperative.baseautoinithandler.html#doautoinit","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.BaseAutoInitHandler"},{"id":2782,"kind":2048,"name":"displayAutoInitChanges","url":"classes/_zowe_imperative.baseautoinithandler.html#displayautoinitchanges","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.BaseAutoInitHandler"},{"id":2783,"kind":2048,"name":"processAutoInit","url":"classes/_zowe_imperative.baseautoinithandler.html#processautoinit","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.BaseAutoInitHandler"},{"id":2784,"kind":256,"name":"IConfigBuilderOpts","url":"interfaces/_zowe_imperative.iconfigbuilderopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2785,"kind":1024,"name":"populateProperties","url":"interfaces/_zowe_imperative.iconfigbuilderopts.html#populateproperties","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigBuilderOpts"},{"id":2786,"kind":2048,"name":"getValueBack","url":"interfaces/_zowe_imperative.iconfigbuilderopts.html#getvalueback","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigBuilderOpts"},{"id":2787,"kind":256,"name":"IConfigConvertResult","url":"interfaces/_zowe_imperative.iconfigconvertresult.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2788,"kind":1024,"name":"config","url":"interfaces/_zowe_imperative.iconfigconvertresult.html#config","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigConvertResult"},{"id":2789,"kind":1024,"name":"profilesConverted","url":"interfaces/_zowe_imperative.iconfigconvertresult.html#profilesconverted","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigConvertResult"},{"id":2790,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iconfigconvertresult.html#profilesconverted.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IConfigConvertResult.profilesConverted"},{"id":2791,"kind":1024,"name":"profilesFailed","url":"interfaces/_zowe_imperative.iconfigconvertresult.html#profilesfailed","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IConfigConvertResult"},{"id":2792,"kind":128,"name":"ConfigBuilder","url":"classes/_zowe_imperative.configbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2793,"kind":2048,"name":"build","url":"classes/_zowe_imperative.configbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigBuilder"},{"id":2794,"kind":2048,"name":"buildDefaultProfile","url":"classes/_zowe_imperative.configbuilder.html#builddefaultprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigBuilder"},{"id":2795,"kind":2048,"name":"convert","url":"classes/_zowe_imperative.configbuilder.html#convert","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigBuilder"},{"id":2796,"kind":2048,"name":"convertPropNames","url":"classes/_zowe_imperative.configbuilder.html#convertpropnames","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigBuilder"},{"id":2797,"kind":2048,"name":"getDefaultValue","url":"classes/_zowe_imperative.configbuilder.html#getdefaultvalue","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigBuilder"},{"id":2798,"kind":256,"name":"IProfOpts","url":"interfaces/_zowe_imperative.iprofopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2799,"kind":1024,"name":"overrideWithEnv","url":"interfaces/_zowe_imperative.iprofopts.html#overridewithenv","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfOpts"},{"id":2800,"kind":1024,"name":"requireKeytar","url":"interfaces/_zowe_imperative.iprofopts.html#requirekeytar","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfOpts"},{"id":2801,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.iprofopts.html#requirekeytar.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.IProfOpts.requireKeytar"},{"id":2802,"kind":1024,"name":"credMgrOverride","url":"interfaces/_zowe_imperative.iprofopts.html#credmgroverride","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfOpts"},{"id":2803,"kind":4,"name":"ProfLocType","url":"enums/_zowe_imperative.profloctype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2804,"kind":16,"name":"OLD_PROFILE","url":"enums/_zowe_imperative.profloctype.html#old_profile","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ProfLocType"},{"id":2805,"kind":16,"name":"TEAM_CONFIG","url":"enums/_zowe_imperative.profloctype.html#team_config","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ProfLocType"},{"id":2806,"kind":16,"name":"ENV","url":"enums/_zowe_imperative.profloctype.html#env","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ProfLocType"},{"id":2807,"kind":16,"name":"DEFAULT","url":"enums/_zowe_imperative.profloctype.html#default","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ProfLocType"},{"id":2808,"kind":256,"name":"IProfLoc","url":"interfaces/_zowe_imperative.iprofloc.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2809,"kind":1024,"name":"locType","url":"interfaces/_zowe_imperative.iprofloc.html#loctype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfLoc"},{"id":2810,"kind":1024,"name":"osLoc","url":"interfaces/_zowe_imperative.iprofloc.html#osloc","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfLoc"},{"id":2811,"kind":1024,"name":"jsonLoc","url":"interfaces/_zowe_imperative.iprofloc.html#jsonloc","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfLoc"},{"id":2812,"kind":256,"name":"IProfLocOsLocLayer","url":"interfaces/_zowe_imperative.iproflocosloclayer.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2813,"kind":1024,"name":"user","url":"interfaces/_zowe_imperative.iproflocosloclayer.html#user","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfLocOsLocLayer"},{"id":2814,"kind":1024,"name":"global","url":"interfaces/_zowe_imperative.iproflocosloclayer.html#global","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfLocOsLocLayer"},{"id":2815,"kind":256,"name":"IProfLocOsLoc","url":"interfaces/_zowe_imperative.iproflocosloc.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2816,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.iproflocosloc.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfLocOsLoc"},{"id":2817,"kind":1024,"name":"path","url":"interfaces/_zowe_imperative.iproflocosloc.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfLocOsLoc"},{"id":2818,"kind":1024,"name":"user","url":"interfaces/_zowe_imperative.iproflocosloc.html#user","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IProfLocOsLoc"},{"id":2819,"kind":1024,"name":"global","url":"interfaces/_zowe_imperative.iproflocosloc.html#global","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IProfLocOsLoc"},{"id":2820,"kind":256,"name":"IArgTeamConfigLoc","url":"interfaces/_zowe_imperative.iargteamconfigloc.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2821,"kind":1024,"name":"profileName","url":"interfaces/_zowe_imperative.iargteamconfigloc.html#profilename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IArgTeamConfigLoc"},{"id":2822,"kind":1024,"name":"propName","url":"interfaces/_zowe_imperative.iargteamconfigloc.html#propname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IArgTeamConfigLoc"},{"id":2823,"kind":1024,"name":"configProperties","url":"interfaces/_zowe_imperative.iargteamconfigloc.html#configproperties","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IArgTeamConfigLoc"},{"id":2824,"kind":1024,"name":"osLocInfo","url":"interfaces/_zowe_imperative.iargteamconfigloc.html#oslocinfo","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IArgTeamConfigLoc"},{"id":2825,"kind":256,"name":"IProfArgAttrs","url":"interfaces/_zowe_imperative.iprofargattrs.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2826,"kind":1024,"name":"argName","url":"interfaces/_zowe_imperative.iprofargattrs.html#argname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfArgAttrs"},{"id":2827,"kind":1024,"name":"dataType","url":"interfaces/_zowe_imperative.iprofargattrs.html#datatype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfArgAttrs"},{"id":2828,"kind":1024,"name":"argValue","url":"interfaces/_zowe_imperative.iprofargattrs.html#argvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfArgAttrs"},{"id":2829,"kind":1024,"name":"argLoc","url":"interfaces/_zowe_imperative.iprofargattrs.html#argloc","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfArgAttrs"},{"id":2830,"kind":1024,"name":"secure","url":"interfaces/_zowe_imperative.iprofargattrs.html#secure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfArgAttrs"},{"id":2831,"kind":1024,"name":"inSchema","url":"interfaces/_zowe_imperative.iprofargattrs.html#inschema","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfArgAttrs"},{"id":2832,"kind":4194304,"name":"IProfDataType","url":"modules/_zowe_imperative.html#iprofdatatype","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2833,"kind":4194304,"name":"IProfArgValue","url":"modules/_zowe_imperative.html#iprofargvalue","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2834,"kind":256,"name":"IProfAttrs","url":"interfaces/_zowe_imperative.iprofattrs.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2835,"kind":1024,"name":"profName","url":"interfaces/_zowe_imperative.iprofattrs.html#profname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfAttrs"},{"id":2836,"kind":1024,"name":"profType","url":"interfaces/_zowe_imperative.iprofattrs.html#proftype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfAttrs"},{"id":2837,"kind":1024,"name":"isDefaultProfile","url":"interfaces/_zowe_imperative.iprofattrs.html#isdefaultprofile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfAttrs"},{"id":2838,"kind":1024,"name":"profLoc","url":"interfaces/_zowe_imperative.iprofattrs.html#profloc","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfAttrs"},{"id":2839,"kind":256,"name":"IProfMergeArgOpts","url":"interfaces/_zowe_imperative.iprofmergeargopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2840,"kind":1024,"name":"getSecureVals","url":"interfaces/_zowe_imperative.iprofmergeargopts.html#getsecurevals","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfMergeArgOpts"},{"id":2841,"kind":256,"name":"IProfMergedArg","url":"interfaces/_zowe_imperative.iprofmergedarg.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2842,"kind":1024,"name":"knownArgs","url":"interfaces/_zowe_imperative.iprofmergedarg.html#knownargs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfMergedArg"},{"id":2843,"kind":1024,"name":"missingArgs","url":"interfaces/_zowe_imperative.iprofmergedarg.html#missingargs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfMergedArg"},{"id":2844,"kind":256,"name":"IProfInfoErrParms","url":"interfaces/_zowe_imperative.iprofinfoerrparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2845,"kind":1024,"name":"itemsInError","url":"interfaces/_zowe_imperative.iprofinfoerrparms.html#itemsinerror","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfInfoErrParms"},{"id":2846,"kind":1024,"name":"logger","url":"interfaces/_zowe_imperative.iprofinfoerrparms.html#logger","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IProfInfoErrParms"},{"id":2847,"kind":1024,"name":"tag","url":"interfaces/_zowe_imperative.iprofinfoerrparms.html#tag","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IProfInfoErrParms"},{"id":2848,"kind":128,"name":"ProfInfoErr","url":"classes/_zowe_imperative.profinfoerr.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2849,"kind":1024,"name":"CANT_GET_SCHEMA_URL","url":"classes/_zowe_imperative.profinfoerr.html#cant_get_schema_url","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfInfoErr"},{"id":2850,"kind":1024,"name":"INVALID_PROF_LOC_TYPE","url":"classes/_zowe_imperative.profinfoerr.html#invalid_prof_loc_type","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfInfoErr"},{"id":2851,"kind":1024,"name":"LOAD_CRED_MGR_FAILED","url":"classes/_zowe_imperative.profinfoerr.html#load_cred_mgr_failed","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfInfoErr"},{"id":2852,"kind":1024,"name":"LOAD_SCHEMA_FAILED","url":"classes/_zowe_imperative.profinfoerr.html#load_schema_failed","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfInfoErr"},{"id":2853,"kind":1024,"name":"MISSING_REQ_PROP","url":"classes/_zowe_imperative.profinfoerr.html#missing_req_prop","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfInfoErr"},{"id":2854,"kind":1024,"name":"MUST_READ_FROM_DISK","url":"classes/_zowe_imperative.profinfoerr.html#must_read_from_disk","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfInfoErr"},{"id":2855,"kind":1024,"name":"PROP_NOT_IN_PROFILE","url":"classes/_zowe_imperative.profinfoerr.html#prop_not_in_profile","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfInfoErr"},{"id":2856,"kind":1024,"name":"UNKNOWN_PROP_LOCATION","url":"classes/_zowe_imperative.profinfoerr.html#unknown_prop_location","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfInfoErr"},{"id":2857,"kind":1024,"name":"PROF_NOT_FOUND","url":"classes/_zowe_imperative.profinfoerr.html#prof_not_found","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfInfoErr"},{"id":2858,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.profinfoerr.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfInfoErr"},{"id":2859,"kind":1024,"name":"mItemsInError","url":"classes/_zowe_imperative.profinfoerr.html#mitemsinerror","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfInfoErr"},{"id":2860,"kind":262144,"name":"itemsInError","url":"classes/_zowe_imperative.profinfoerr.html#itemsinerror","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ProfInfoErr"},{"id":2861,"kind":1024,"name":"mDetails","url":"classes/_zowe_imperative.profinfoerr.html#mdetails","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfInfoErr"},{"id":2862,"kind":262144,"name":"causeErrors","url":"classes/_zowe_imperative.profinfoerr.html#causeerrors","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfInfoErr"},{"id":2863,"kind":262144,"name":"additionalDetails","url":"classes/_zowe_imperative.profinfoerr.html#additionaldetails","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfInfoErr"},{"id":2864,"kind":262144,"name":"details","url":"classes/_zowe_imperative.profinfoerr.html#details","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfInfoErr"},{"id":2865,"kind":262144,"name":"errorCode","url":"classes/_zowe_imperative.profinfoerr.html#errorcode","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfInfoErr"},{"id":2866,"kind":262144,"name":"suppressDump","url":"classes/_zowe_imperative.profinfoerr.html#suppressdump","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfInfoErr"},{"id":2867,"kind":262144,"name":"stack","url":"classes/_zowe_imperative.profinfoerr.html#stack","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.ProfInfoErr"},{"id":2868,"kind":262144,"name":"message","url":"classes/_zowe_imperative.profinfoerr.html#message","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.ProfInfoErr"},{"id":2869,"kind":1024,"name":"name","url":"classes/_zowe_imperative.profinfoerr.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfInfoErr"},{"id":2870,"kind":256,"name":"IProfInfoUpdatePropOpts","url":"interfaces/_zowe_imperative.iprofinfoupdatepropopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2871,"kind":1024,"name":"profileType","url":"interfaces/_zowe_imperative.iprofinfoupdatepropopts.html#profiletype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfInfoUpdatePropOpts"},{"id":2872,"kind":1024,"name":"profileName","url":"interfaces/_zowe_imperative.iprofinfoupdatepropopts.html#profilename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfInfoUpdatePropOpts"},{"id":2873,"kind":1024,"name":"forceUpdate","url":"interfaces/_zowe_imperative.iprofinfoupdatepropopts.html#forceupdate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfInfoUpdatePropOpts"},{"id":2874,"kind":1024,"name":"property","url":"interfaces/_zowe_imperative.iprofinfoupdatepropopts.html#property","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IProfInfoUpdatePropOpts"},{"id":2875,"kind":1024,"name":"value","url":"interfaces/_zowe_imperative.iprofinfoupdatepropopts.html#value","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IProfInfoUpdatePropOpts"},{"id":2876,"kind":1024,"name":"setSecure","url":"interfaces/_zowe_imperative.iprofinfoupdatepropopts.html#setsecure","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IProfInfoUpdatePropOpts"},{"id":2877,"kind":256,"name":"IProfInfoUpdateKnownPropOpts","url":"interfaces/_zowe_imperative.iprofinfoupdateknownpropopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2878,"kind":1024,"name":"mergedArgs","url":"interfaces/_zowe_imperative.iprofinfoupdateknownpropopts.html#mergedargs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfInfoUpdateKnownPropOpts"},{"id":2879,"kind":1024,"name":"osLocInfo","url":"interfaces/_zowe_imperative.iprofinfoupdateknownpropopts.html#oslocinfo","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfInfoUpdateKnownPropOpts"},{"id":2880,"kind":1024,"name":"property","url":"interfaces/_zowe_imperative.iprofinfoupdateknownpropopts.html#property","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IProfInfoUpdateKnownPropOpts"},{"id":2881,"kind":1024,"name":"value","url":"interfaces/_zowe_imperative.iprofinfoupdateknownpropopts.html#value","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IProfInfoUpdateKnownPropOpts"},{"id":2882,"kind":1024,"name":"setSecure","url":"interfaces/_zowe_imperative.iprofinfoupdateknownpropopts.html#setsecure","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IProfInfoUpdateKnownPropOpts"},{"id":2883,"kind":256,"name":"IProfInfoUpdatePropCommonOpts","url":"interfaces/_zowe_imperative.iprofinfoupdatepropcommonopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2884,"kind":1024,"name":"property","url":"interfaces/_zowe_imperative.iprofinfoupdatepropcommonopts.html#property","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfInfoUpdatePropCommonOpts"},{"id":2885,"kind":1024,"name":"value","url":"interfaces/_zowe_imperative.iprofinfoupdatepropcommonopts.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfInfoUpdatePropCommonOpts"},{"id":2886,"kind":1024,"name":"setSecure","url":"interfaces/_zowe_imperative.iprofinfoupdatepropcommonopts.html#setsecure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfInfoUpdatePropCommonOpts"},{"id":2887,"kind":256,"name":"IGetAllProfilesOptions","url":"interfaces/_zowe_imperative.igetallprofilesoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2888,"kind":1024,"name":"excludeHomeDir","url":"interfaces/_zowe_imperative.igetallprofilesoptions.html#excludehomedir","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IGetAllProfilesOptions"},{"id":2889,"kind":256,"name":"IProfInfoRemoveKnownPropOpts","url":"interfaces/_zowe_imperative.iprofinforemoveknownpropopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2890,"kind":1024,"name":"mergedArgs","url":"interfaces/_zowe_imperative.iprofinforemoveknownpropopts.html#mergedargs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfInfoRemoveKnownPropOpts"},{"id":2891,"kind":1024,"name":"osLocInfo","url":"interfaces/_zowe_imperative.iprofinforemoveknownpropopts.html#oslocinfo","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfInfoRemoveKnownPropOpts"},{"id":2892,"kind":1024,"name":"property","url":"interfaces/_zowe_imperative.iprofinforemoveknownpropopts.html#property","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IProfInfoRemoveKnownPropOpts"},{"id":2893,"kind":256,"name":"IProfInfoRemoveKnownPropCommonOpts","url":"interfaces/_zowe_imperative.iprofinforemoveknownpropcommonopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2894,"kind":1024,"name":"property","url":"interfaces/_zowe_imperative.iprofinforemoveknownpropcommonopts.html#property","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfInfoRemoveKnownPropCommonOpts"},{"id":2895,"kind":4194304,"name":"IExtendersJsonOpts","url":"modules/_zowe_imperative.html#iextendersjsonopts","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2896,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#iextendersjsonopts.__type-7","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.IExtendersJsonOpts"},{"id":2897,"kind":32,"name":"profileTypes","url":"modules/_zowe_imperative.html#iextendersjsonopts.__type-7.profiletypes","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/imperative.IExtendersJsonOpts.__type"},{"id":2898,"kind":4194304,"name":"IAddProfTypeResult","url":"modules/_zowe_imperative.html#iaddproftyperesult","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2899,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#iaddproftyperesult.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.IAddProfTypeResult"},{"id":2900,"kind":32,"name":"success","url":"modules/_zowe_imperative.html#iaddproftyperesult.__type.success","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/imperative.IAddProfTypeResult.__type"},{"id":2901,"kind":32,"name":"info","url":"modules/_zowe_imperative.html#iaddproftyperesult.__type.info","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/imperative.IAddProfTypeResult.__type"},{"id":2902,"kind":4194304,"name":"IExtenderTypeInfo","url":"modules/_zowe_imperative.html#iextendertypeinfo","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2903,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#iextendertypeinfo.__type-6","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.IExtenderTypeInfo"},{"id":2904,"kind":32,"name":"sourceApp","url":"modules/_zowe_imperative.html#iextendertypeinfo.__type-6.sourceapp","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/imperative.IExtenderTypeInfo.__type"},{"id":2905,"kind":32,"name":"schema","url":"modules/_zowe_imperative.html#iextendertypeinfo.__type-6.schema","classes":"tsd-kind-variable tsd-parent-kind-type-literal","parent":"@zowe/imperative.IExtenderTypeInfo.__type"},{"id":2906,"kind":128,"name":"ProfileInfo","url":"classes/_zowe_imperative.profileinfo.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2907,"kind":1024,"name":"mLoadedConfig","url":"classes/_zowe_imperative.profileinfo.html#mloadedconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2908,"kind":1024,"name":"mUsingTeamConfig","url":"classes/_zowe_imperative.profileinfo.html#musingteamconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2909,"kind":1024,"name":"mAppName","url":"classes/_zowe_imperative.profileinfo.html#mappname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2910,"kind":1024,"name":"mImpLogger","url":"classes/_zowe_imperative.profileinfo.html#mimplogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2911,"kind":1024,"name":"mOldSchoolProfileCache","url":"classes/_zowe_imperative.profileinfo.html#moldschoolprofilecache","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2912,"kind":1024,"name":"mOldSchoolProfileRootDir","url":"classes/_zowe_imperative.profileinfo.html#moldschoolprofilerootdir","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2913,"kind":1024,"name":"mOldSchoolProfileDefaults","url":"classes/_zowe_imperative.profileinfo.html#moldschoolprofiledefaults","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2914,"kind":65536,"name":"__type","url":"classes/_zowe_imperative.profileinfo.html#moldschoolprofiledefaults.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.ProfileInfo.mOldSchoolProfileDefaults"},{"id":2915,"kind":1024,"name":"mOldSchoolProfileTypes","url":"classes/_zowe_imperative.profileinfo.html#moldschoolprofiletypes","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2916,"kind":1024,"name":"mOverrideWithEnv","url":"classes/_zowe_imperative.profileinfo.html#moverridewithenv","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2917,"kind":1024,"name":"mHasValidSchema","url":"classes/_zowe_imperative.profileinfo.html#mhasvalidschema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2918,"kind":1024,"name":"mProfileSchemaCache","url":"classes/_zowe_imperative.profileinfo.html#mprofileschemacache","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2919,"kind":1024,"name":"mCredentials","url":"classes/_zowe_imperative.profileinfo.html#mcredentials","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2920,"kind":1024,"name":"mExtendersJson","url":"classes/_zowe_imperative.profileinfo.html#mextendersjson","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2921,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.profileinfo.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2922,"kind":2048,"name":"updateProperty","url":"classes/_zowe_imperative.profileinfo.html#updateproperty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2923,"kind":2048,"name":"updateKnownProperty","url":"classes/_zowe_imperative.profileinfo.html#updateknownproperty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2924,"kind":2048,"name":"removeKnownProperty","url":"classes/_zowe_imperative.profileinfo.html#removeknownproperty","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2925,"kind":2048,"name":"getAllProfiles","url":"classes/_zowe_imperative.profileinfo.html#getallprofiles","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2926,"kind":2048,"name":"getDefaultProfile","url":"classes/_zowe_imperative.profileinfo.html#getdefaultprofile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2927,"kind":2048,"name":"getTeamConfig","url":"classes/_zowe_imperative.profileinfo.html#getteamconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2928,"kind":2048,"name":"isSecured","url":"classes/_zowe_imperative.profileinfo.html#issecured","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2929,"kind":2048,"name":"createSession","url":"classes/_zowe_imperative.profileinfo.html#createsession","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileInfo"},{"id":2930,"kind":2048,"name":"mergeArgsForProfile","url":"classes/_zowe_imperative.profileinfo.html#mergeargsforprofile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2931,"kind":2048,"name":"mergeArgsForProfileType","url":"classes/_zowe_imperative.profileinfo.html#mergeargsforprofiletype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2932,"kind":2048,"name":"profAttrsToProfLoaded","url":"classes/_zowe_imperative.profileinfo.html#profattrstoprofloaded","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileInfo"},{"id":2933,"kind":2048,"name":"readProfilesFromDisk","url":"classes/_zowe_imperative.profileinfo.html#readprofilesfromdisk","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2934,"kind":262144,"name":"usingTeamConfig","url":"classes/_zowe_imperative.profileinfo.html#usingteamconfig","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2935,"kind":262144,"name":"hasValidSchema","url":"classes/_zowe_imperative.profileinfo.html#hasvalidschema","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2936,"kind":2048,"name":"getOsLocInfo","url":"classes/_zowe_imperative.profileinfo.html#getoslocinfo","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2937,"kind":2048,"name":"loadSecureArg","url":"classes/_zowe_imperative.profileinfo.html#loadsecurearg","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2938,"kind":2048,"name":"initSessCfg","url":"classes/_zowe_imperative.profileinfo.html#initsesscfg","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileInfo"},{"id":2939,"kind":2048,"name":"ensureReadFromDisk","url":"classes/_zowe_imperative.profileinfo.html#ensurereadfromdisk","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2940,"kind":2048,"name":"initImpUtils","url":"classes/_zowe_imperative.profileinfo.html#initimputils","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2941,"kind":2048,"name":"loadAllSchemas","url":"classes/_zowe_imperative.profileinfo.html#loadallschemas","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2942,"kind":2048,"name":"readExtendersJsonFromDisk","url":"classes/_zowe_imperative.profileinfo.html#readextendersjsonfromdisk","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileInfo"},{"id":2943,"kind":2048,"name":"writeExtendersJson","url":"classes/_zowe_imperative.profileinfo.html#writeextendersjson","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileInfo"},{"id":2944,"kind":2048,"name":"addProfileToConfig","url":"classes/_zowe_imperative.profileinfo.html#addprofiletoconfig","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2945,"kind":2048,"name":"updateSchemaAtLayer","url":"classes/_zowe_imperative.profileinfo.html#updateschemaatlayer","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2946,"kind":2048,"name":"omitCmdPropsFromSchema","url":"classes/_zowe_imperative.profileinfo.html#omitcmdpropsfromschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2947,"kind":2048,"name":"addProfileTypeToSchema","url":"classes/_zowe_imperative.profileinfo.html#addprofiletypetoschema","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2948,"kind":2048,"name":"buildSchema","url":"classes/_zowe_imperative.profileinfo.html#buildschema","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2949,"kind":2048,"name":"getProfileTypes","url":"classes/_zowe_imperative.profileinfo.html#getprofiletypes","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2950,"kind":2048,"name":"getSchemaForType","url":"classes/_zowe_imperative.profileinfo.html#getschemafortype","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileInfo"},{"id":2951,"kind":2048,"name":"getTeamSubProfiles","url":"classes/_zowe_imperative.profileinfo.html#getteamsubprofiles","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2952,"kind":2048,"name":"isDefaultTeamProfile","url":"classes/_zowe_imperative.profileinfo.html#isdefaultteamprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2953,"kind":2048,"name":"findTeamOsLocation","url":"classes/_zowe_imperative.profileinfo.html#findteamoslocation","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2954,"kind":2048,"name":"argDataType","url":"classes/_zowe_imperative.profileinfo.html#argdatatype","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2955,"kind":2048,"name":"argTeamConfigLoc","url":"classes/_zowe_imperative.profileinfo.html#argteamconfigloc","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2956,"kind":2048,"name":"argOldProfileLoc","url":"classes/_zowe_imperative.profileinfo.html#argoldprofileloc","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2957,"kind":2048,"name":"oldProfileFilePath","url":"classes/_zowe_imperative.profileinfo.html#oldprofilefilepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2958,"kind":2048,"name":"loadSchema","url":"classes/_zowe_imperative.profileinfo.html#loadschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2959,"kind":2048,"name":"overrideWithEnv","url":"classes/_zowe_imperative.profileinfo.html#overridewithenv","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileInfo"},{"id":2960,"kind":128,"name":"ProfileCredentials","url":"classes/_zowe_imperative.profilecredentials.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2961,"kind":1024,"name":"mSecured","url":"classes/_zowe_imperative.profilecredentials.html#msecured","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileCredentials"},{"id":2962,"kind":1024,"name":"mCredMgrOverride","url":"classes/_zowe_imperative.profilecredentials.html#mcredmgroverride","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileCredentials"},{"id":2963,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.profilecredentials.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.ProfileCredentials"},{"id":2964,"kind":1024,"name":"mProfileInfo","url":"classes/_zowe_imperative.profilecredentials.html#mprofileinfo","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileCredentials"},{"id":2965,"kind":2048,"name":"defaultCredMgrWithKeytar","url":"classes/_zowe_imperative.profilecredentials.html#defaultcredmgrwithkeytar","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileCredentials"},{"id":2966,"kind":262144,"name":"isSecured","url":"classes/_zowe_imperative.profilecredentials.html#issecured","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ProfileCredentials"},{"id":2967,"kind":2048,"name":"loadManager","url":"classes/_zowe_imperative.profilecredentials.html#loadmanager","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfileCredentials"},{"id":2968,"kind":2048,"name":"isTeamConfigSecure","url":"classes/_zowe_imperative.profilecredentials.html#isteamconfigsecure","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileCredentials"},{"id":2969,"kind":2048,"name":"isCredentialManagerInAppSettings","url":"classes/_zowe_imperative.profilecredentials.html#iscredentialmanagerinappsettings","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfileCredentials"},{"id":2970,"kind":256,"name":"IImperativeLogsConfig","url":"interfaces/_zowe_imperative.iimperativelogsconfig.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2971,"kind":1024,"name":"imperativeLogging","url":"interfaces/_zowe_imperative.iimperativelogsconfig.html#imperativelogging","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeLogsConfig"},{"id":2972,"kind":1024,"name":"appLogging","url":"interfaces/_zowe_imperative.iimperativelogsconfig.html#applogging","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeLogsConfig"},{"id":2973,"kind":1024,"name":"additionalLogging","url":"interfaces/_zowe_imperative.iimperativelogsconfig.html#additionallogging","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeLogsConfig"},{"id":2974,"kind":256,"name":"IImperativeConfig","url":"interfaces/_zowe_imperative.iimperativeconfig.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":2975,"kind":1024,"name":"allowPlugins","url":"interfaces/_zowe_imperative.iimperativeconfig.html#allowplugins","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2976,"kind":1024,"name":"allowConfigGroup","url":"interfaces/_zowe_imperative.iimperativeconfig.html#allowconfiggroup","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2977,"kind":1024,"name":"configurationModule","url":"interfaces/_zowe_imperative.iimperativeconfig.html#configurationmodule","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2978,"kind":1024,"name":"commandModuleGlobs","url":"interfaces/_zowe_imperative.iimperativeconfig.html#commandmoduleglobs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2979,"kind":1024,"name":"definitions","url":"interfaces/_zowe_imperative.iimperativeconfig.html#definitions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2980,"kind":1024,"name":"rootCommandDescription","url":"interfaces/_zowe_imperative.iimperativeconfig.html#rootcommanddescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2981,"kind":1024,"name":"customHelpGenerator","url":"interfaces/_zowe_imperative.iimperativeconfig.html#customhelpgenerator","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2982,"kind":1024,"name":"progressBarSpinner","url":"interfaces/_zowe_imperative.iimperativeconfig.html#progressbarspinner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2983,"kind":1024,"name":"defaultHome","url":"interfaces/_zowe_imperative.iimperativeconfig.html#defaulthome","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2984,"kind":1024,"name":"envVariablePrefix","url":"interfaces/_zowe_imperative.iimperativeconfig.html#envvariableprefix","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2985,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.iimperativeconfig.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2986,"kind":1024,"name":"productDisplayName","url":"interfaces/_zowe_imperative.iimperativeconfig.html#productdisplayname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2987,"kind":1024,"name":"profiles","url":"interfaces/_zowe_imperative.iimperativeconfig.html#profiles","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2988,"kind":1024,"name":"baseProfile","url":"interfaces/_zowe_imperative.iimperativeconfig.html#baseprofile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2989,"kind":1024,"name":"authGroupConfig","url":"interfaces/_zowe_imperative.iimperativeconfig.html#authgroupconfig","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2990,"kind":1024,"name":"configAutoInitCommandConfig","url":"interfaces/_zowe_imperative.iimperativeconfig.html#configautoinitcommandconfig","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2991,"kind":1024,"name":"autoGenerateProfileCommands","url":"interfaces/_zowe_imperative.iimperativeconfig.html#autogenerateprofilecommands","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2992,"kind":1024,"name":"logging","url":"interfaces/_zowe_imperative.iimperativeconfig.html#logging","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2993,"kind":1024,"name":"primaryTextColor","url":"interfaces/_zowe_imperative.iimperativeconfig.html#primarytextcolor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2994,"kind":1024,"name":"secondaryTextColor","url":"interfaces/_zowe_imperative.iimperativeconfig.html#secondarytextcolor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2995,"kind":1024,"name":"overrides","url":"interfaces/_zowe_imperative.iimperativeconfig.html#overrides","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2996,"kind":1024,"name":"pluginLifeCycle","url":"interfaces/_zowe_imperative.iimperativeconfig.html#pluginlifecycle","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2997,"kind":1024,"name":"pluginHealthCheck","url":"interfaces/_zowe_imperative.iimperativeconfig.html#pluginhealthcheck","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2998,"kind":1024,"name":"pluginAliases","url":"interfaces/_zowe_imperative.iimperativeconfig.html#pluginaliases","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":2999,"kind":1024,"name":"pluginSummary","url":"interfaces/_zowe_imperative.iimperativeconfig.html#pluginsummary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":3000,"kind":1024,"name":"pluginFirstSteps","url":"interfaces/_zowe_imperative.iimperativeconfig.html#pluginfirststeps","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":3001,"kind":1024,"name":"experimentalCommandDescription","url":"interfaces/_zowe_imperative.iimperativeconfig.html#experimentalcommanddescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":3002,"kind":1024,"name":"webHelpLogoImgPath","url":"interfaces/_zowe_imperative.iimperativeconfig.html#webhelplogoimgpath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":3003,"kind":1024,"name":"webHelpCustomCssPath","url":"interfaces/_zowe_imperative.iimperativeconfig.html#webhelpcustomcsspath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":3004,"kind":1024,"name":"apimlConnLookup","url":"interfaces/_zowe_imperative.iimperativeconfig.html#apimlconnlookup","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":3005,"kind":1024,"name":"daemonMode","url":"interfaces/_zowe_imperative.iimperativeconfig.html#daemonmode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeConfig"},{"id":3006,"kind":128,"name":"ImperativeConfig","url":"classes/_zowe_imperative.imperativeconfig.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3007,"kind":1024,"name":"mInstance","url":"classes/_zowe_imperative.imperativeconfig.html#minstance","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ImperativeConfig"},{"id":3008,"kind":1024,"name":"mDaemonContext","url":"classes/_zowe_imperative.imperativeconfig.html#mdaemoncontext","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeConfig"},{"id":3009,"kind":1024,"name":"mLoadedConfig","url":"classes/_zowe_imperative.imperativeconfig.html#mloadedconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeConfig"},{"id":3010,"kind":1024,"name":"mCommandLine","url":"classes/_zowe_imperative.imperativeconfig.html#mcommandline","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeConfig"},{"id":3011,"kind":1024,"name":"mCallerLocation","url":"classes/_zowe_imperative.imperativeconfig.html#mcallerlocation","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeConfig"},{"id":3012,"kind":1024,"name":"mHostPackageName","url":"classes/_zowe_imperative.imperativeconfig.html#mhostpackagename","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeConfig"},{"id":3013,"kind":1024,"name":"mImperativePackageName","url":"classes/_zowe_imperative.imperativeconfig.html#mimperativepackagename","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeConfig"},{"id":3014,"kind":1024,"name":"mRootCommandName","url":"classes/_zowe_imperative.imperativeconfig.html#mrootcommandname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeConfig"},{"id":3015,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.imperativeconfig.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeConfig"},{"id":3016,"kind":262144,"name":"instance","url":"classes/_zowe_imperative.imperativeconfig.html#instance","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeConfig"},{"id":3017,"kind":262144,"name":"envVariablePrefix","url":"classes/_zowe_imperative.imperativeconfig.html#envvariableprefix","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3018,"kind":262144,"name":"callerLocation","url":"classes/_zowe_imperative.imperativeconfig.html#callerlocation","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3019,"kind":262144,"name":"loadedConfig","url":"classes/_zowe_imperative.imperativeconfig.html#loadedconfig","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3020,"kind":262144,"name":"rootCommandName","url":"classes/_zowe_imperative.imperativeconfig.html#rootcommandname","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3021,"kind":262144,"name":"hostPackageName","url":"classes/_zowe_imperative.imperativeconfig.html#hostpackagename","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3022,"kind":262144,"name":"imperativePackageName","url":"classes/_zowe_imperative.imperativeconfig.html#imperativepackagename","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3023,"kind":2048,"name":"findPackageBinName","url":"classes/_zowe_imperative.imperativeconfig.html#findpackagebinname","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3024,"kind":262144,"name":"cliHome","url":"classes/_zowe_imperative.imperativeconfig.html#clihome","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3025,"kind":262144,"name":"profileDir","url":"classes/_zowe_imperative.imperativeconfig.html#profiledir","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3026,"kind":262144,"name":"callerPackageJson","url":"classes/_zowe_imperative.imperativeconfig.html#callerpackagejson","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3027,"kind":262144,"name":"commandLine","url":"classes/_zowe_imperative.imperativeconfig.html#commandline","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3028,"kind":262144,"name":"daemonContext","url":"classes/_zowe_imperative.imperativeconfig.html#daemoncontext","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3029,"kind":262144,"name":"config","url":"classes/_zowe_imperative.imperativeconfig.html#config","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3030,"kind":2048,"name":"getCallerFile","url":"classes/_zowe_imperative.imperativeconfig.html#getcallerfile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3031,"kind":262144,"name":"profileSchemas","url":"classes/_zowe_imperative.imperativeconfig.html#profileschemas","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeConfig"},{"id":3032,"kind":128,"name":"JSONUtils","url":"classes/_zowe_imperative.jsonutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3033,"kind":2048,"name":"parse","url":"classes/_zowe_imperative.jsonutils.html#parse","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"@zowe/imperative.JSONUtils"},{"id":3034,"kind":128,"name":"NextVerFeatures","url":"classes/_zowe_imperative.nextverfeatures.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3035,"kind":1024,"name":"ENV_VAR_PREFIX","url":"classes/_zowe_imperative.nextverfeatures.html#env_var_prefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.NextVerFeatures"},{"id":3036,"kind":2048,"name":"useV3ErrFormat","url":"classes/_zowe_imperative.nextverfeatures.html#usev3errformat","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.NextVerFeatures"},{"id":3037,"kind":256,"name":"ISystemInfo","url":"interfaces/_zowe_imperative.isysteminfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3038,"kind":1024,"name":"arch","url":"interfaces/_zowe_imperative.isysteminfo.html#arch","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISystemInfo"},{"id":3039,"kind":1024,"name":"platform","url":"interfaces/_zowe_imperative.isysteminfo.html#platform","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISystemInfo"},{"id":3040,"kind":4,"name":"GuiResult","url":"enums/_zowe_imperative.guiresult.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3041,"kind":16,"name":"GUI_AVAILABLE","url":"enums/_zowe_imperative.guiresult.html#gui_available","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.GuiResult"},{"id":3042,"kind":16,"name":"NO_GUI_SSH","url":"enums/_zowe_imperative.guiresult.html#no_gui_ssh","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.GuiResult"},{"id":3043,"kind":16,"name":"NO_GUI_NO_DISPLAY","url":"enums/_zowe_imperative.guiresult.html#no_gui_no_display","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.GuiResult"},{"id":3044,"kind":128,"name":"ProcessUtils","url":"classes/_zowe_imperative.processutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3045,"kind":2048,"name":"nextTick","url":"classes/_zowe_imperative.processutils.html#nexttick","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProcessUtils"},{"id":3046,"kind":2048,"name":"isGuiAvailable","url":"classes/_zowe_imperative.processutils.html#isguiavailable","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProcessUtils"},{"id":3047,"kind":2048,"name":"getBasicSystemInfo","url":"classes/_zowe_imperative.processutils.html#getbasicsysteminfo","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProcessUtils"},{"id":3048,"kind":2048,"name":"openInDefaultApp","url":"classes/_zowe_imperative.processutils.html#openindefaultapp","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProcessUtils"},{"id":3049,"kind":2048,"name":"openInEditor","url":"classes/_zowe_imperative.processutils.html#openineditor","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProcessUtils"},{"id":3050,"kind":2048,"name":"execAndCheckOutput","url":"classes/_zowe_imperative.processutils.html#execandcheckoutput","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProcessUtils"},{"id":3051,"kind":256,"name":"IDiffNameOptions","url":"interfaces/_zowe_imperative.idiffnameoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3052,"kind":1024,"name":"name1","url":"interfaces/_zowe_imperative.idiffnameoptions.html#name1","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDiffNameOptions"},{"id":3053,"kind":1024,"name":"name2","url":"interfaces/_zowe_imperative.idiffnameoptions.html#name2","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDiffNameOptions"},{"id":3054,"kind":256,"name":"IDiffOptions","url":"interfaces/_zowe_imperative.idiffoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3055,"kind":1024,"name":"outputFormat","url":"interfaces/_zowe_imperative.idiffoptions.html#outputformat","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDiffOptions"},{"id":3056,"kind":1024,"name":"contextLinesArg","url":"interfaces/_zowe_imperative.idiffoptions.html#contextlinesarg","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDiffOptions"},{"id":3057,"kind":1024,"name":"name1","url":"interfaces/_zowe_imperative.idiffoptions.html#name1","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IDiffOptions"},{"id":3058,"kind":1024,"name":"name2","url":"interfaces/_zowe_imperative.idiffoptions.html#name2","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IDiffOptions"},{"id":3059,"kind":256,"name":"IWebDiffGenerator","url":"interfaces/_zowe_imperative.iwebdiffgenerator.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3060,"kind":2048,"name":"buildDiffDir","url":"interfaces/_zowe_imperative.iwebdiffgenerator.html#builddiffdir","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IWebDiffGenerator"},{"id":3061,"kind":256,"name":"IWebDiffManager","url":"interfaces/_zowe_imperative.iwebdiffmanager.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3062,"kind":2048,"name":"openDiffs","url":"interfaces/_zowe_imperative.iwebdiffmanager.html#opendiffs","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IWebDiffManager"},{"id":3063,"kind":128,"name":"WebDiffManager","url":"classes/_zowe_imperative.webdiffmanager.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3064,"kind":1024,"name":"mInstance","url":"classes/_zowe_imperative.webdiffmanager.html#minstance","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.WebDiffManager"},{"id":3065,"kind":262144,"name":"instance","url":"classes/_zowe_imperative.webdiffmanager.html#instance","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.WebDiffManager"},{"id":3066,"kind":2048,"name":"openDiffs","url":"classes/_zowe_imperative.webdiffmanager.html#opendiffs","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.WebDiffManager"},{"id":3067,"kind":262144,"name":"webDiffDir","url":"classes/_zowe_imperative.webdiffmanager.html#webdiffdir","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebDiffManager"},{"id":3068,"kind":2048,"name":"genHtmlForDiffs","url":"classes/_zowe_imperative.webdiffmanager.html#genhtmlfordiffs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.WebDiffManager"},{"id":3069,"kind":128,"name":"DiffUtils","url":"classes/_zowe_imperative.diffutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3070,"kind":2048,"name":"getDiffString","url":"classes/_zowe_imperative.diffutils.html#getdiffstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.DiffUtils"},{"id":3071,"kind":2048,"name":"openDiffInbrowser","url":"classes/_zowe_imperative.diffutils.html#opendiffinbrowser","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.DiffUtils"},{"id":3072,"kind":256,"name":"IMetaProfile","url":"interfaces/_zowe_imperative.imetaprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":3073,"kind":1024,"name":"defaultProfile","url":"interfaces/_zowe_imperative.imetaprofile.html#defaultprofile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IMetaProfile"},{"id":3074,"kind":1024,"name":"configuration","url":"interfaces/_zowe_imperative.imetaprofile.html#configuration","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IMetaProfile"},{"id":3075,"kind":128,"name":"ProfileIO","url":"classes/_zowe_imperative.profileio.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3076,"kind":1024,"name":"MAX_YAML_DEPTH","url":"classes/_zowe_imperative.profileio.html#max_yaml_depth","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3077,"kind":2048,"name":"createProfileDirs","url":"classes/_zowe_imperative.profileio.html#createprofiledirs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3078,"kind":2048,"name":"readMetaFile","url":"classes/_zowe_imperative.profileio.html#readmetafile","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3079,"kind":2048,"name":"writeProfile","url":"classes/_zowe_imperative.profileio.html#writeprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3080,"kind":2048,"name":"deleteProfile","url":"classes/_zowe_imperative.profileio.html#deleteprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3081,"kind":2048,"name":"exists","url":"classes/_zowe_imperative.profileio.html#exists","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3082,"kind":2048,"name":"writeMetaFile","url":"classes/_zowe_imperative.profileio.html#writemetafile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3083,"kind":2048,"name":"fileToProfileName","url":"classes/_zowe_imperative.profileio.html#filetoprofilename","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3084,"kind":2048,"name":"getAllProfileDirectories","url":"classes/_zowe_imperative.profileio.html#getallprofiledirectories","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3085,"kind":2048,"name":"getAllProfileNames","url":"classes/_zowe_imperative.profileio.html#getallprofilenames","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3086,"kind":2048,"name":"readProfileFile","url":"classes/_zowe_imperative.profileio.html#readprofilefile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3087,"kind":2048,"name":"crashInTeamConfigMode","url":"classes/_zowe_imperative.profileio.html#crashinteamconfigmode","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3088,"kind":1024,"name":"ERROR_ID","url":"classes/_zowe_imperative.profileio.html#error_id","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ProfileIO"},{"id":3089,"kind":128,"name":"AbstractProfileManager","url":"classes/_zowe_imperative.abstractprofilemanager.html","classes":"tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":3090,"kind":1024,"name":"PROFILE_EXTENSION","url":"classes/_zowe_imperative.abstractprofilemanager.html#profile_extension","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3091,"kind":1024,"name":"META_FILE_SUFFIX","url":"classes/_zowe_imperative.abstractprofilemanager.html#meta_file_suffix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3092,"kind":1024,"name":"mLoadCounter","url":"classes/_zowe_imperative.abstractprofilemanager.html#mloadcounter","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3093,"kind":1024,"name":"mConstructorParms","url":"classes/_zowe_imperative.abstractprofilemanager.html#mconstructorparms","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3094,"kind":1024,"name":"mProfileRootDirectory","url":"classes/_zowe_imperative.abstractprofilemanager.html#mprofilerootdirectory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3095,"kind":1024,"name":"mProfileTypeConfigurations","url":"classes/_zowe_imperative.abstractprofilemanager.html#mprofiletypeconfigurations","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3096,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.abstractprofilemanager.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3097,"kind":1024,"name":"mProfileTypeConfiguration","url":"classes/_zowe_imperative.abstractprofilemanager.html#mprofiletypeconfiguration","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3098,"kind":1024,"name":"mProfileTypeSchema","url":"classes/_zowe_imperative.abstractprofilemanager.html#mprofiletypeschema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3099,"kind":1024,"name":"mProfileTypeRootDirectory","url":"classes/_zowe_imperative.abstractprofilemanager.html#mprofiletyperootdirectory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3100,"kind":1024,"name":"mProfileTypeMetaFileName","url":"classes/_zowe_imperative.abstractprofilemanager.html#mprofiletypemetafilename","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3101,"kind":1024,"name":"mProductDisplayName","url":"classes/_zowe_imperative.abstractprofilemanager.html#mproductdisplayname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3102,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.abstractprofilemanager.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3103,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.abstractprofilemanager.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3104,"kind":262144,"name":"loadCounter","url":"classes/_zowe_imperative.abstractprofilemanager.html#loadcounter","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3105,"kind":262144,"name":"log","url":"classes/_zowe_imperative.abstractprofilemanager.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3106,"kind":262144,"name":"managerParameters","url":"classes/_zowe_imperative.abstractprofilemanager.html#managerparameters","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3107,"kind":262144,"name":"profileType","url":"classes/_zowe_imperative.abstractprofilemanager.html#profiletype","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3108,"kind":262144,"name":"productDisplayName","url":"classes/_zowe_imperative.abstractprofilemanager.html#productdisplayname","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3109,"kind":262144,"name":"profileTypeConfiguration","url":"classes/_zowe_imperative.abstractprofilemanager.html#profiletypeconfiguration","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3110,"kind":262144,"name":"profileTypeConfigurations","url":"classes/_zowe_imperative.abstractprofilemanager.html#profiletypeconfigurations","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3111,"kind":262144,"name":"profileTypeSchema","url":"classes/_zowe_imperative.abstractprofilemanager.html#profiletypeschema","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3112,"kind":262144,"name":"profileTypeRootDirectory","url":"classes/_zowe_imperative.abstractprofilemanager.html#profiletyperootdirectory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3113,"kind":262144,"name":"profileTypeMetaFileName","url":"classes/_zowe_imperative.abstractprofilemanager.html#profiletypemetafilename","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3114,"kind":262144,"name":"profileRootDirectory","url":"classes/_zowe_imperative.abstractprofilemanager.html#profilerootdirectory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3115,"kind":2048,"name":"getAllProfileNames","url":"classes/_zowe_imperative.abstractprofilemanager.html#getallprofilenames","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3116,"kind":262144,"name":"configurations","url":"classes/_zowe_imperative.abstractprofilemanager.html#configurations","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3117,"kind":2048,"name":"save","url":"classes/_zowe_imperative.abstractprofilemanager.html#save","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3118,"kind":2048,"name":"load","url":"classes/_zowe_imperative.abstractprofilemanager.html#load","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3119,"kind":2048,"name":"validate","url":"classes/_zowe_imperative.abstractprofilemanager.html#validate","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3120,"kind":2048,"name":"mergeProfiles","url":"classes/_zowe_imperative.abstractprofilemanager.html#mergeprofiles","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3121,"kind":2048,"name":"delete","url":"classes/_zowe_imperative.abstractprofilemanager.html#delete","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3122,"kind":2048,"name":"update","url":"classes/_zowe_imperative.abstractprofilemanager.html#update","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3123,"kind":2048,"name":"setDefault","url":"classes/_zowe_imperative.abstractprofilemanager.html#setdefault","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3124,"kind":2048,"name":"clearDefault","url":"classes/_zowe_imperative.abstractprofilemanager.html#cleardefault","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3125,"kind":2048,"name":"getDefaultProfileName","url":"classes/_zowe_imperative.abstractprofilemanager.html#getdefaultprofilename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3126,"kind":2048,"name":"loadAll","url":"classes/_zowe_imperative.abstractprofilemanager.html#loadall","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3127,"kind":2048,"name":"saveProfile","url":"classes/_zowe_imperative.abstractprofilemanager.html#saveprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3128,"kind":2048,"name":"loadProfile","url":"classes/_zowe_imperative.abstractprofilemanager.html#loadprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3129,"kind":2048,"name":"deleteProfile","url":"classes/_zowe_imperative.abstractprofilemanager.html#deleteprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3130,"kind":2048,"name":"validateProfile","url":"classes/_zowe_imperative.abstractprofilemanager.html#validateprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3131,"kind":2048,"name":"updateProfile","url":"classes/_zowe_imperative.abstractprofilemanager.html#updateprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3132,"kind":2048,"name":"loadDependencies","url":"classes/_zowe_imperative.abstractprofilemanager.html#loaddependencies","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3133,"kind":2048,"name":"deleteProfileFromDisk","url":"classes/_zowe_imperative.abstractprofilemanager.html#deleteprofilefromdisk","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3134,"kind":2048,"name":"validateProfileObject","url":"classes/_zowe_imperative.abstractprofilemanager.html#validateprofileobject","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3135,"kind":2048,"name":"validateProfileAgainstSchema","url":"classes/_zowe_imperative.abstractprofilemanager.html#validateprofileagainstschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3136,"kind":2048,"name":"constructFullProfilePath","url":"classes/_zowe_imperative.abstractprofilemanager.html#constructfullprofilepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3137,"kind":2048,"name":"locateExistingProfile","url":"classes/_zowe_imperative.abstractprofilemanager.html#locateexistingprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3138,"kind":2048,"name":"loadFailed","url":"classes/_zowe_imperative.abstractprofilemanager.html#loadfailed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3139,"kind":2048,"name":"isProfileEmpty","url":"classes/_zowe_imperative.abstractprofilemanager.html#isprofileempty","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3140,"kind":2048,"name":"loadSpecificProfile","url":"classes/_zowe_imperative.abstractprofilemanager.html#loadspecificprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3141,"kind":2048,"name":"validateRequiredDependenciesAreSpecified","url":"classes/_zowe_imperative.abstractprofilemanager.html#validaterequireddependenciesarespecified","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3142,"kind":2048,"name":"isDependencyOf","url":"classes/_zowe_imperative.abstractprofilemanager.html#isdependencyof","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3143,"kind":2048,"name":"protectAgainstOverwrite","url":"classes/_zowe_imperative.abstractprofilemanager.html#protectagainstoverwrite","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3144,"kind":2048,"name":"constructMetaName","url":"classes/_zowe_imperative.abstractprofilemanager.html#constructmetaname","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3145,"kind":2048,"name":"createProfileTypeDirectory","url":"classes/_zowe_imperative.abstractprofilemanager.html#createprofiletypedirectory","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3146,"kind":2048,"name":"setDefaultInMetaObject","url":"classes/_zowe_imperative.abstractprofilemanager.html#setdefaultinmetaobject","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3147,"kind":2048,"name":"failNotFoundDefaultResponse","url":"classes/_zowe_imperative.abstractprofilemanager.html#failnotfounddefaultresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3148,"kind":2048,"name":"collectAllConfigurations","url":"classes/_zowe_imperative.abstractprofilemanager.html#collectallconfigurations","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3149,"kind":2048,"name":"validateSchema","url":"classes/_zowe_imperative.abstractprofilemanager.html#validateschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3150,"kind":2048,"name":"validateConfigurationDocument","url":"classes/_zowe_imperative.abstractprofilemanager.html#validateconfigurationdocument","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3151,"kind":2048,"name":"validateMetaProfile","url":"classes/_zowe_imperative.abstractprofilemanager.html#validatemetaprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3152,"kind":2048,"name":"readMeta","url":"classes/_zowe_imperative.abstractprofilemanager.html#readmeta","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractProfileManager"},{"id":3153,"kind":256,"name":"IProfileManagerFactory","url":"interfaces/_zowe_imperative.iprofilemanagerfactory.html","classes":"tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":3154,"kind":2048,"name":"getManager","url":"interfaces/_zowe_imperative.iprofilemanagerfactory.html#getmanager","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileManagerFactory"},{"id":3155,"kind":256,"name":"IDeleteProfile","url":"interfaces/_zowe_imperative.ideleteprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3156,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.ideleteprofile.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDeleteProfile"},{"id":3157,"kind":1024,"name":"rejectIfDependency","url":"interfaces/_zowe_imperative.ideleteprofile.html#rejectifdependency","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IDeleteProfile"},{"id":3158,"kind":256,"name":"ILoadAllProfiles","url":"interfaces/_zowe_imperative.iloadallprofiles.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3159,"kind":1024,"name":"noSecure","url":"interfaces/_zowe_imperative.iloadallprofiles.html#nosecure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILoadAllProfiles"},{"id":3160,"kind":1024,"name":"typeOnly","url":"interfaces/_zowe_imperative.iloadallprofiles.html#typeonly","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILoadAllProfiles"},{"id":3161,"kind":256,"name":"ILoadProfile","url":"interfaces/_zowe_imperative.iloadprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3162,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.iloadprofile.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILoadProfile"},{"id":3163,"kind":1024,"name":"loadDefault","url":"interfaces/_zowe_imperative.iloadprofile.html#loaddefault","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILoadProfile"},{"id":3164,"kind":1024,"name":"failNotFound","url":"interfaces/_zowe_imperative.iloadprofile.html#failnotfound","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILoadProfile"},{"id":3165,"kind":1024,"name":"loadDependencies","url":"interfaces/_zowe_imperative.iloadprofile.html#loaddependencies","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILoadProfile"},{"id":3166,"kind":1024,"name":"noSecure","url":"interfaces/_zowe_imperative.iloadprofile.html#nosecure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ILoadProfile"},{"id":3167,"kind":256,"name":"IProfileManager","url":"interfaces/_zowe_imperative.iprofilemanager.html","classes":"tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":3168,"kind":1024,"name":"profileRootDirectory","url":"interfaces/_zowe_imperative.iprofilemanager.html#profilerootdirectory","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileManager"},{"id":3169,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.iprofilemanager.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileManager"},{"id":3170,"kind":1024,"name":"logger","url":"interfaces/_zowe_imperative.iprofilemanager.html#logger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileManager"},{"id":3171,"kind":1024,"name":"typeConfigurations","url":"interfaces/_zowe_imperative.iprofilemanager.html#typeconfigurations","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileManager"},{"id":3172,"kind":1024,"name":"loadCounter","url":"interfaces/_zowe_imperative.iprofilemanager.html#loadcounter","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileManager"},{"id":3173,"kind":1024,"name":"productDisplayName","url":"interfaces/_zowe_imperative.iprofilemanager.html#productdisplayname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileManager"},{"id":3174,"kind":256,"name":"IProfileManagerInit","url":"interfaces/_zowe_imperative.iprofilemanagerinit.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3175,"kind":1024,"name":"configuration","url":"interfaces/_zowe_imperative.iprofilemanagerinit.html#configuration","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileManagerInit"},{"id":3176,"kind":1024,"name":"profileRootDirectory","url":"interfaces/_zowe_imperative.iprofilemanagerinit.html#profilerootdirectory","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileManagerInit"},{"id":3177,"kind":1024,"name":"reinitialize","url":"interfaces/_zowe_imperative.iprofilemanagerinit.html#reinitialize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileManagerInit"},{"id":3178,"kind":256,"name":"ISaveProfile","url":"interfaces/_zowe_imperative.isaveprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3179,"kind":1024,"name":"profile","url":"interfaces/_zowe_imperative.isaveprofile.html#profile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISaveProfile"},{"id":3180,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.isaveprofile.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISaveProfile"},{"id":3181,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.isaveprofile.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISaveProfile"},{"id":3182,"kind":1024,"name":"updateDefault","url":"interfaces/_zowe_imperative.isaveprofile.html#updatedefault","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISaveProfile"},{"id":3183,"kind":1024,"name":"overwrite","url":"interfaces/_zowe_imperative.isaveprofile.html#overwrite","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISaveProfile"},{"id":3184,"kind":1024,"name":"disableDefaults","url":"interfaces/_zowe_imperative.isaveprofile.html#disabledefaults","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISaveProfile"},{"id":3185,"kind":256,"name":"ISaveProfileFromCliArgs","url":"interfaces/_zowe_imperative.isaveprofilefromcliargs.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3186,"kind":1024,"name":"args","url":"interfaces/_zowe_imperative.isaveprofilefromcliargs.html#args","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISaveProfileFromCliArgs"},{"id":3187,"kind":1024,"name":"profile","url":"interfaces/_zowe_imperative.isaveprofilefromcliargs.html#profile","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ISaveProfileFromCliArgs"},{"id":3188,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.isaveprofilefromcliargs.html#name","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ISaveProfileFromCliArgs"},{"id":3189,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.isaveprofilefromcliargs.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ISaveProfileFromCliArgs"},{"id":3190,"kind":1024,"name":"updateDefault","url":"interfaces/_zowe_imperative.isaveprofilefromcliargs.html#updatedefault","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ISaveProfileFromCliArgs"},{"id":3191,"kind":1024,"name":"overwrite","url":"interfaces/_zowe_imperative.isaveprofilefromcliargs.html#overwrite","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ISaveProfileFromCliArgs"},{"id":3192,"kind":1024,"name":"disableDefaults","url":"interfaces/_zowe_imperative.isaveprofilefromcliargs.html#disabledefaults","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ISaveProfileFromCliArgs"},{"id":3193,"kind":256,"name":"ISetDefaultProfile","url":"interfaces/_zowe_imperative.isetdefaultprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3194,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.isetdefaultprofile.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ISetDefaultProfile"},{"id":3195,"kind":256,"name":"IUpdateProfile","url":"interfaces/_zowe_imperative.iupdateprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3196,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.iupdateprofile.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IUpdateProfile"},{"id":3197,"kind":1024,"name":"merge","url":"interfaces/_zowe_imperative.iupdateprofile.html#merge","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IUpdateProfile"},{"id":3198,"kind":1024,"name":"profile","url":"interfaces/_zowe_imperative.iupdateprofile.html#profile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IUpdateProfile"},{"id":3199,"kind":256,"name":"IUpdateProfileFromCliArgs","url":"interfaces/_zowe_imperative.iupdateprofilefromcliargs.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3200,"kind":1024,"name":"args","url":"interfaces/_zowe_imperative.iupdateprofilefromcliargs.html#args","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IUpdateProfileFromCliArgs"},{"id":3201,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.iupdateprofilefromcliargs.html#name","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IUpdateProfileFromCliArgs"},{"id":3202,"kind":1024,"name":"merge","url":"interfaces/_zowe_imperative.iupdateprofilefromcliargs.html#merge","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IUpdateProfileFromCliArgs"},{"id":3203,"kind":1024,"name":"profile","url":"interfaces/_zowe_imperative.iupdateprofilefromcliargs.html#profile","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IUpdateProfileFromCliArgs"},{"id":3204,"kind":256,"name":"IValidateProfile","url":"interfaces/_zowe_imperative.ivalidateprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3205,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.ivalidateprofile.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IValidateProfile"},{"id":3206,"kind":1024,"name":"profile","url":"interfaces/_zowe_imperative.ivalidateprofile.html#profile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IValidateProfile"},{"id":3207,"kind":1024,"name":"strict","url":"interfaces/_zowe_imperative.ivalidateprofile.html#strict","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IValidateProfile"},{"id":3208,"kind":256,"name":"IValidateProfileWithSchema","url":"interfaces/_zowe_imperative.ivalidateprofilewithschema.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3209,"kind":1024,"name":"schema","url":"interfaces/_zowe_imperative.ivalidateprofilewithschema.html#schema","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IValidateProfileWithSchema"},{"id":3210,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.ivalidateprofilewithschema.html#name","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IValidateProfileWithSchema"},{"id":3211,"kind":1024,"name":"profile","url":"interfaces/_zowe_imperative.ivalidateprofilewithschema.html#profile","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IValidateProfileWithSchema"},{"id":3212,"kind":1024,"name":"strict","url":"interfaces/_zowe_imperative.ivalidateprofilewithschema.html#strict","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IValidateProfileWithSchema"},{"id":3213,"kind":256,"name":"IValidateProfileForCLI","url":"interfaces/_zowe_imperative.ivalidateprofileforcli.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3214,"kind":1024,"name":"readyForValidation","url":"interfaces/_zowe_imperative.ivalidateprofileforcli.html#readyforvalidation","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IValidateProfileForCLI"},{"id":3215,"kind":1024,"name":"schema","url":"interfaces/_zowe_imperative.ivalidateprofileforcli.html#schema","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IValidateProfileForCLI"},{"id":3216,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.ivalidateprofileforcli.html#name","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IValidateProfileForCLI"},{"id":3217,"kind":1024,"name":"profile","url":"interfaces/_zowe_imperative.ivalidateprofileforcli.html#profile","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IValidateProfileForCLI"},{"id":3218,"kind":1024,"name":"strict","url":"interfaces/_zowe_imperative.ivalidateprofileforcli.html#strict","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.IValidateProfileForCLI"},{"id":3219,"kind":256,"name":"IProfileDeleted","url":"interfaces/_zowe_imperative.iprofiledeleted.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3220,"kind":1024,"name":"path","url":"interfaces/_zowe_imperative.iprofiledeleted.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileDeleted"},{"id":3221,"kind":1024,"name":"message","url":"interfaces/_zowe_imperative.iprofiledeleted.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileDeleted"},{"id":3222,"kind":1024,"name":"defaultCleared","url":"interfaces/_zowe_imperative.iprofiledeleted.html#defaultcleared","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileDeleted"},{"id":3223,"kind":256,"name":"IProfileInitialized","url":"interfaces/_zowe_imperative.iprofileinitialized.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3224,"kind":1024,"name":"message","url":"interfaces/_zowe_imperative.iprofileinitialized.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileInitialized"},{"id":3225,"kind":256,"name":"IProfileSaved","url":"interfaces/_zowe_imperative.iprofilesaved.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3226,"kind":1024,"name":"path","url":"interfaces/_zowe_imperative.iprofilesaved.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileSaved"},{"id":3227,"kind":1024,"name":"message","url":"interfaces/_zowe_imperative.iprofilesaved.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileSaved"},{"id":3228,"kind":1024,"name":"overwritten","url":"interfaces/_zowe_imperative.iprofilesaved.html#overwritten","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileSaved"},{"id":3229,"kind":1024,"name":"profile","url":"interfaces/_zowe_imperative.iprofilesaved.html#profile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileSaved"},{"id":3230,"kind":256,"name":"IProfileUpdated","url":"interfaces/_zowe_imperative.iprofileupdated.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3231,"kind":1024,"name":"path","url":"interfaces/_zowe_imperative.iprofileupdated.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileUpdated"},{"id":3232,"kind":1024,"name":"message","url":"interfaces/_zowe_imperative.iprofileupdated.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileUpdated"},{"id":3233,"kind":1024,"name":"profile","url":"interfaces/_zowe_imperative.iprofileupdated.html#profile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileUpdated"},{"id":3234,"kind":256,"name":"IProfileValidated","url":"interfaces/_zowe_imperative.iprofilevalidated.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3235,"kind":1024,"name":"message","url":"interfaces/_zowe_imperative.iprofilevalidated.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidated"},{"id":3236,"kind":256,"name":"IProfileValidationTask","url":"interfaces/_zowe_imperative.iprofilevalidationtask.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3237,"kind":1024,"name":"description","url":"interfaces/_zowe_imperative.iprofilevalidationtask.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationTask"},{"id":3238,"kind":1024,"name":"name","url":"interfaces/_zowe_imperative.iprofilevalidationtask.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationTask"},{"id":3239,"kind":1024,"name":"associatedEndpoints","url":"interfaces/_zowe_imperative.iprofilevalidationtask.html#associatedendpoints","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationTask"},{"id":3240,"kind":1024,"name":"taskFunction","url":"interfaces/_zowe_imperative.iprofilevalidationtask.html#taskfunction","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationTask"},{"id":3241,"kind":1024,"name":"dependentTasks","url":"interfaces/_zowe_imperative.iprofilevalidationtask.html#dependenttasks","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationTask"},{"id":3242,"kind":4194304,"name":"VALIDATION_OUTCOME","url":"modules/_zowe_imperative.html#validation_outcome","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3243,"kind":4194304,"name":"IProfileValidationTaskFunction","url":"modules/_zowe_imperative.html#iprofilevalidationtaskfunction","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3244,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#iprofilevalidationtaskfunction.__type-11","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/imperative.IProfileValidationTaskFunction"},{"id":3245,"kind":256,"name":"IProfileValidationTaskResult","url":"interfaces/_zowe_imperative.iprofilevalidationtaskresult.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3246,"kind":1024,"name":"outcome","url":"interfaces/_zowe_imperative.iprofilevalidationtaskresult.html#outcome","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationTaskResult"},{"id":3247,"kind":1024,"name":"taskName","url":"interfaces/_zowe_imperative.iprofilevalidationtaskresult.html#taskname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationTaskResult"},{"id":3248,"kind":1024,"name":"resultDescription","url":"interfaces/_zowe_imperative.iprofilevalidationtaskresult.html#resultdescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationTaskResult"},{"id":3249,"kind":1024,"name":"associatedEndpoints","url":"interfaces/_zowe_imperative.iprofilevalidationtaskresult.html#associatedendpoints","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationTaskResult"},{"id":3250,"kind":256,"name":"IProfileValidationReport","url":"interfaces/_zowe_imperative.iprofilevalidationreport.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3251,"kind":1024,"name":"overallResult","url":"interfaces/_zowe_imperative.iprofilevalidationreport.html#overallresult","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationReport"},{"id":3252,"kind":1024,"name":"overallMessage","url":"interfaces/_zowe_imperative.iprofilevalidationreport.html#overallmessage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationReport"},{"id":3253,"kind":1024,"name":"taskResults","url":"interfaces/_zowe_imperative.iprofilevalidationreport.html#taskresults","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationReport"},{"id":3254,"kind":1024,"name":"profile","url":"interfaces/_zowe_imperative.iprofilevalidationreport.html#profile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationReport"},{"id":3255,"kind":256,"name":"IProfileValidationPlan","url":"interfaces/_zowe_imperative.iprofilevalidationplan.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3256,"kind":1024,"name":"tasks","url":"interfaces/_zowe_imperative.iprofilevalidationplan.html#tasks","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationPlan"},{"id":3257,"kind":1024,"name":"failureSuggestions","url":"interfaces/_zowe_imperative.iprofilevalidationplan.html#failuresuggestions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProfileValidationPlan"},{"id":3258,"kind":128,"name":"ProfileValidator","url":"classes/_zowe_imperative.profilevalidator.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3259,"kind":1024,"name":"CUSTOMIZE_PLAN_KEY","url":"classes/_zowe_imperative.profilevalidator.html#customize_plan_key","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileValidator"},{"id":3260,"kind":262144,"name":"PRINT_PLAN_OPTION","url":"classes/_zowe_imperative.profilevalidator.html#print_plan_option","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileValidator"},{"id":3261,"kind":2048,"name":"validate","url":"classes/_zowe_imperative.profilevalidator.html#validate","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileValidator"},{"id":3262,"kind":2048,"name":"getTextDisplayForReport","url":"classes/_zowe_imperative.profilevalidator.html#gettextdisplayforreport","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileValidator"},{"id":3263,"kind":2048,"name":"getTextDisplayForPlan","url":"classes/_zowe_imperative.profilevalidator.html#gettextdisplayforplan","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileValidator"},{"id":3264,"kind":2048,"name":"outcomeToString","url":"classes/_zowe_imperative.profilevalidator.html#outcometostring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ProfileValidator"},{"id":3265,"kind":2048,"name":"countOutcomes","url":"classes/_zowe_imperative.profilevalidator.html#countoutcomes","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ProfileValidator"},{"id":3266,"kind":128,"name":"BasicProfileManager","url":"classes/_zowe_imperative.basicprofilemanager.html","classes":"tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":3267,"kind":2048,"name":"initialize","url":"classes/_zowe_imperative.basicprofilemanager.html#initialize","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.BasicProfileManager"},{"id":3268,"kind":2048,"name":"loadAll","url":"classes/_zowe_imperative.basicprofilemanager.html#loadall","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.BasicProfileManager"},{"id":3269,"kind":2048,"name":"loadDependencies","url":"classes/_zowe_imperative.basicprofilemanager.html#loaddependencies","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3270,"kind":2048,"name":"saveProfile","url":"classes/_zowe_imperative.basicprofilemanager.html#saveprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3271,"kind":2048,"name":"loadProfile","url":"classes/_zowe_imperative.basicprofilemanager.html#loadprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3272,"kind":2048,"name":"deleteProfile","url":"classes/_zowe_imperative.basicprofilemanager.html#deleteprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3273,"kind":2048,"name":"validateProfile","url":"classes/_zowe_imperative.basicprofilemanager.html#validateprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3274,"kind":2048,"name":"updateProfile","url":"classes/_zowe_imperative.basicprofilemanager.html#updateprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3275,"kind":1024,"name":"PROFILE_EXTENSION","url":"classes/_zowe_imperative.basicprofilemanager.html#profile_extension","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.BasicProfileManager"},{"id":3276,"kind":1024,"name":"META_FILE_SUFFIX","url":"classes/_zowe_imperative.basicprofilemanager.html#meta_file_suffix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"@zowe/imperative.BasicProfileManager"},{"id":3277,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.basicprofilemanager.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BasicProfileManager"},{"id":3278,"kind":262144,"name":"loadCounter","url":"classes/_zowe_imperative.basicprofilemanager.html#loadcounter","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3279,"kind":262144,"name":"log","url":"classes/_zowe_imperative.basicprofilemanager.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3280,"kind":262144,"name":"managerParameters","url":"classes/_zowe_imperative.basicprofilemanager.html#managerparameters","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3281,"kind":262144,"name":"profileType","url":"classes/_zowe_imperative.basicprofilemanager.html#profiletype","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3282,"kind":262144,"name":"productDisplayName","url":"classes/_zowe_imperative.basicprofilemanager.html#productdisplayname","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3283,"kind":262144,"name":"profileTypeConfiguration","url":"classes/_zowe_imperative.basicprofilemanager.html#profiletypeconfiguration","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3284,"kind":262144,"name":"profileTypeConfigurations","url":"classes/_zowe_imperative.basicprofilemanager.html#profiletypeconfigurations","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3285,"kind":262144,"name":"profileTypeSchema","url":"classes/_zowe_imperative.basicprofilemanager.html#profiletypeschema","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3286,"kind":262144,"name":"profileTypeRootDirectory","url":"classes/_zowe_imperative.basicprofilemanager.html#profiletyperootdirectory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3287,"kind":262144,"name":"profileTypeMetaFileName","url":"classes/_zowe_imperative.basicprofilemanager.html#profiletypemetafilename","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3288,"kind":262144,"name":"profileRootDirectory","url":"classes/_zowe_imperative.basicprofilemanager.html#profilerootdirectory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3289,"kind":2048,"name":"getAllProfileNames","url":"classes/_zowe_imperative.basicprofilemanager.html#getallprofilenames","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BasicProfileManager"},{"id":3290,"kind":262144,"name":"configurations","url":"classes/_zowe_imperative.basicprofilemanager.html#configurations","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BasicProfileManager"},{"id":3291,"kind":2048,"name":"save","url":"classes/_zowe_imperative.basicprofilemanager.html#save","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"@zowe/imperative.BasicProfileManager"},{"id":3292,"kind":2048,"name":"load","url":"classes/_zowe_imperative.basicprofilemanager.html#load","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"@zowe/imperative.BasicProfileManager"},{"id":3293,"kind":2048,"name":"validate","url":"classes/_zowe_imperative.basicprofilemanager.html#validate","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"@zowe/imperative.BasicProfileManager"},{"id":3294,"kind":2048,"name":"mergeProfiles","url":"classes/_zowe_imperative.basicprofilemanager.html#mergeprofiles","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BasicProfileManager"},{"id":3295,"kind":2048,"name":"delete","url":"classes/_zowe_imperative.basicprofilemanager.html#delete","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"@zowe/imperative.BasicProfileManager"},{"id":3296,"kind":2048,"name":"update","url":"classes/_zowe_imperative.basicprofilemanager.html#update","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"@zowe/imperative.BasicProfileManager"},{"id":3297,"kind":2048,"name":"setDefault","url":"classes/_zowe_imperative.basicprofilemanager.html#setdefault","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BasicProfileManager"},{"id":3298,"kind":2048,"name":"clearDefault","url":"classes/_zowe_imperative.basicprofilemanager.html#cleardefault","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BasicProfileManager"},{"id":3299,"kind":2048,"name":"getDefaultProfileName","url":"classes/_zowe_imperative.basicprofilemanager.html#getdefaultprofilename","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.BasicProfileManager"},{"id":3300,"kind":2048,"name":"deleteProfileFromDisk","url":"classes/_zowe_imperative.basicprofilemanager.html#deleteprofilefromdisk","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3301,"kind":2048,"name":"validateProfileObject","url":"classes/_zowe_imperative.basicprofilemanager.html#validateprofileobject","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3302,"kind":2048,"name":"validateProfileAgainstSchema","url":"classes/_zowe_imperative.basicprofilemanager.html#validateprofileagainstschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3303,"kind":2048,"name":"constructFullProfilePath","url":"classes/_zowe_imperative.basicprofilemanager.html#constructfullprofilepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3304,"kind":2048,"name":"locateExistingProfile","url":"classes/_zowe_imperative.basicprofilemanager.html#locateexistingprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3305,"kind":2048,"name":"loadFailed","url":"classes/_zowe_imperative.basicprofilemanager.html#loadfailed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3306,"kind":2048,"name":"isProfileEmpty","url":"classes/_zowe_imperative.basicprofilemanager.html#isprofileempty","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3307,"kind":2048,"name":"loadSpecificProfile","url":"classes/_zowe_imperative.basicprofilemanager.html#loadspecificprofile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.BasicProfileManager"},{"id":3308,"kind":2048,"name":"validateRequiredDependenciesAreSpecified","url":"classes/_zowe_imperative.basicprofilemanager.html#validaterequireddependenciesarespecified","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-private","parent":"@zowe/imperative.BasicProfileManager"},{"id":3309,"kind":128,"name":"AbstractProfileManagerFactory","url":"classes/_zowe_imperative.abstractprofilemanagerfactory.html","classes":"tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter","parent":"@zowe/imperative"},{"id":3310,"kind":2048,"name":"getManager","url":"classes/_zowe_imperative.abstractprofilemanagerfactory.html#getmanager","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractProfileManagerFactory"},{"id":3311,"kind":128,"name":"BasicProfileManagerFactory","url":"classes/_zowe_imperative.basicprofilemanagerfactory.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3312,"kind":1024,"name":"mProfilesRootDirectory","url":"classes/_zowe_imperative.basicprofilemanagerfactory.html#mprofilesrootdirectory","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.BasicProfileManagerFactory"},{"id":3313,"kind":1024,"name":"mTypeConfigurations","url":"classes/_zowe_imperative.basicprofilemanagerfactory.html#mtypeconfigurations","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.BasicProfileManagerFactory"},{"id":3314,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.basicprofilemanagerfactory.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.BasicProfileManagerFactory"},{"id":3315,"kind":2048,"name":"getManager","url":"classes/_zowe_imperative.basicprofilemanagerfactory.html#getmanager","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.BasicProfileManagerFactory"},{"id":3316,"kind":262144,"name":"profilesRootDirectory","url":"classes/_zowe_imperative.basicprofilemanagerfactory.html#profilesrootdirectory","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.BasicProfileManagerFactory"},{"id":3317,"kind":262144,"name":"typeConfigurations","url":"classes/_zowe_imperative.basicprofilemanagerfactory.html#typeconfigurations","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.BasicProfileManagerFactory"},{"id":3318,"kind":256,"name":"ICommandProfileProperty","url":"interfaces/_zowe_imperative.icommandprofileproperty.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3319,"kind":1024,"name":"optionDefinition","url":"interfaces/_zowe_imperative.icommandprofileproperty.html#optiondefinition","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileProperty"},{"id":3320,"kind":1024,"name":"optionDefinitions","url":"interfaces/_zowe_imperative.icommandprofileproperty.html#optiondefinitions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandProfileProperty"},{"id":3321,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.icommandprofileproperty.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileProperty"},{"id":3322,"kind":1024,"name":"items","url":"interfaces/_zowe_imperative.icommandprofileproperty.html#items","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileProperty"},{"id":3323,"kind":1024,"name":"properties","url":"interfaces/_zowe_imperative.icommandprofileproperty.html#properties","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileProperty"},{"id":3324,"kind":1024,"name":"secure","url":"interfaces/_zowe_imperative.icommandprofileproperty.html#secure","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileProperty"},{"id":3325,"kind":1024,"name":"includeInTemplate","url":"interfaces/_zowe_imperative.icommandprofileproperty.html#includeintemplate","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileProperty"},{"id":3326,"kind":256,"name":"ICommandProfileSchema","url":"interfaces/_zowe_imperative.icommandprofileschema.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3327,"kind":1024,"name":"properties","url":"interfaces/_zowe_imperative.icommandprofileschema.html#properties","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"@zowe/imperative.ICommandProfileSchema"},{"id":3328,"kind":65536,"name":"__type","url":"interfaces/_zowe_imperative.icommandprofileschema.html#properties.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/imperative.ICommandProfileSchema.properties"},{"id":3329,"kind":1024,"name":"title","url":"interfaces/_zowe_imperative.icommandprofileschema.html#title","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileSchema"},{"id":3330,"kind":1024,"name":"description","url":"interfaces/_zowe_imperative.icommandprofileschema.html#description","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileSchema"},{"id":3331,"kind":1024,"name":"type","url":"interfaces/_zowe_imperative.icommandprofileschema.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileSchema"},{"id":3332,"kind":1024,"name":"version","url":"interfaces/_zowe_imperative.icommandprofileschema.html#version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileSchema"},{"id":3333,"kind":1024,"name":"required","url":"interfaces/_zowe_imperative.icommandprofileschema.html#required","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/imperative.ICommandProfileSchema"},{"id":3334,"kind":256,"name":"ICommandHandlerResponseChecker","url":"interfaces/_zowe_imperative.icommandhandlerresponsechecker.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3335,"kind":2048,"name":"process","url":"interfaces/_zowe_imperative.icommandhandlerresponsechecker.html#process","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandHandlerResponseChecker"},{"id":3336,"kind":256,"name":"ICommandHandlerResponseValidator","url":"interfaces/_zowe_imperative.icommandhandlerresponsevalidator.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3337,"kind":2048,"name":"validate","url":"interfaces/_zowe_imperative.icommandhandlerresponsevalidator.html#validate","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"@zowe/imperative.ICommandHandlerResponseValidator"},{"id":3338,"kind":128,"name":"FailedCommandHandler","url":"classes/_zowe_imperative.failedcommandhandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3339,"kind":2048,"name":"process","url":"classes/_zowe_imperative.failedcommandhandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.FailedCommandHandler"},{"id":3340,"kind":128,"name":"AbstractHelpGeneratorFactory","url":"classes/_zowe_imperative.abstracthelpgeneratorfactory.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3341,"kind":1024,"name":"mRootCommandName","url":"classes/_zowe_imperative.abstracthelpgeneratorfactory.html#mrootcommandname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractHelpGeneratorFactory"},{"id":3342,"kind":1024,"name":"mPrimaryHighlightColor","url":"classes/_zowe_imperative.abstracthelpgeneratorfactory.html#mprimaryhighlightcolor","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractHelpGeneratorFactory"},{"id":3343,"kind":1024,"name":"mProduceMarkdown","url":"classes/_zowe_imperative.abstracthelpgeneratorfactory.html#mproducemarkdown","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractHelpGeneratorFactory"},{"id":3344,"kind":1024,"name":"mParms","url":"classes/_zowe_imperative.abstracthelpgeneratorfactory.html#mparms","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.AbstractHelpGeneratorFactory"},{"id":3345,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.abstracthelpgeneratorfactory.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.AbstractHelpGeneratorFactory"},{"id":3346,"kind":2048,"name":"getHelpGenerator","url":"classes/_zowe_imperative.abstracthelpgeneratorfactory.html#gethelpgenerator","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.AbstractHelpGeneratorFactory"},{"id":3347,"kind":2048,"name":"getGenerator","url":"classes/_zowe_imperative.abstracthelpgeneratorfactory.html#getgenerator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGeneratorFactory"},{"id":3348,"kind":262144,"name":"rootCommandName","url":"classes/_zowe_imperative.abstracthelpgeneratorfactory.html#rootcommandname","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGeneratorFactory"},{"id":3349,"kind":262144,"name":"primaryHighlightColor","url":"classes/_zowe_imperative.abstracthelpgeneratorfactory.html#primaryhighlightcolor","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGeneratorFactory"},{"id":3350,"kind":262144,"name":"produceMarkdown","url":"classes/_zowe_imperative.abstracthelpgeneratorfactory.html#producemarkdown","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGeneratorFactory"},{"id":3351,"kind":262144,"name":"factoryParameters","url":"classes/_zowe_imperative.abstracthelpgeneratorfactory.html#factoryparameters","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected","parent":"@zowe/imperative.AbstractHelpGeneratorFactory"},{"id":3352,"kind":128,"name":"HelpConstants","url":"classes/_zowe_imperative.helpconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3353,"kind":1024,"name":"HDR_PROF_REQS","url":"classes/_zowe_imperative.helpconstants.html#hdr_prof_reqs","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.HelpConstants"},{"id":3354,"kind":128,"name":"HelpGeneratorFactory","url":"classes/_zowe_imperative.helpgeneratorfactory.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3355,"kind":2048,"name":"getGenerator","url":"classes/_zowe_imperative.helpgeneratorfactory.html#getgenerator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.HelpGeneratorFactory"},{"id":3356,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.helpgeneratorfactory.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.HelpGeneratorFactory"},{"id":3357,"kind":2048,"name":"getHelpGenerator","url":"classes/_zowe_imperative.helpgeneratorfactory.html#gethelpgenerator","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.HelpGeneratorFactory"},{"id":3358,"kind":262144,"name":"rootCommandName","url":"classes/_zowe_imperative.helpgeneratorfactory.html#rootcommandname","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.HelpGeneratorFactory"},{"id":3359,"kind":262144,"name":"primaryHighlightColor","url":"classes/_zowe_imperative.helpgeneratorfactory.html#primaryhighlightcolor","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.HelpGeneratorFactory"},{"id":3360,"kind":262144,"name":"produceMarkdown","url":"classes/_zowe_imperative.helpgeneratorfactory.html#producemarkdown","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.HelpGeneratorFactory"},{"id":3361,"kind":262144,"name":"factoryParameters","url":"classes/_zowe_imperative.helpgeneratorfactory.html#factoryparameters","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.HelpGeneratorFactory"},{"id":3362,"kind":128,"name":"HandlerResponse","url":"classes/_zowe_imperative.handlerresponse.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3363,"kind":1024,"name":"mApis","url":"classes/_zowe_imperative.handlerresponse.html#mapis","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.HandlerResponse"},{"id":3364,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.handlerresponse.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.HandlerResponse"},{"id":3365,"kind":262144,"name":"console","url":"classes/_zowe_imperative.handlerresponse.html#console","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.HandlerResponse"},{"id":3366,"kind":262144,"name":"data","url":"classes/_zowe_imperative.handlerresponse.html#data","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.HandlerResponse"},{"id":3367,"kind":262144,"name":"progress","url":"classes/_zowe_imperative.handlerresponse.html#progress","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.HandlerResponse"},{"id":3368,"kind":262144,"name":"format","url":"classes/_zowe_imperative.handlerresponse.html#format","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.HandlerResponse"},{"id":3369,"kind":128,"name":"CliUtils","url":"classes/_zowe_imperative.cliutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3370,"kind":1024,"name":"CENSOR_RESPONSE","url":"classes/_zowe_imperative.cliutils.html#censor_response","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3371,"kind":1024,"name":"CENSORED_OPTIONS","url":"classes/_zowe_imperative.cliutils.html#censored_options","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3372,"kind":2048,"name":"getDashFormOfOption","url":"classes/_zowe_imperative.cliutils.html#getdashformofoption","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3373,"kind":2048,"name":"censorCLIArgs","url":"classes/_zowe_imperative.cliutils.html#censorcliargs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3374,"kind":2048,"name":"censorYargsArguments","url":"classes/_zowe_imperative.cliutils.html#censoryargsarguments","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3375,"kind":2048,"name":"getOptValueFromProfiles","url":"classes/_zowe_imperative.cliutils.html#getoptvaluefromprofiles","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3376,"kind":2048,"name":"mergeArguments","url":"classes/_zowe_imperative.cliutils.html#mergearguments","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3377,"kind":2048,"name":"extractEnvForOptions","url":"classes/_zowe_imperative.cliutils.html#extractenvforoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3378,"kind":2048,"name":"extractArrayFromEnvValue","url":"classes/_zowe_imperative.cliutils.html#extractarrayfromenvvalue","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3379,"kind":2048,"name":"getEnvValForOption","url":"classes/_zowe_imperative.cliutils.html#getenvvalforoption","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3380,"kind":2048,"name":"getPositionalSyntaxString","url":"classes/_zowe_imperative.cliutils.html#getpositionalsyntaxstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3381,"kind":2048,"name":"formatHelpHeader","url":"classes/_zowe_imperative.cliutils.html#formathelpheader","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3382,"kind":2048,"name":"showMsgWhenDeprecated","url":"classes/_zowe_imperative.cliutils.html#showmsgwhendeprecated","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3383,"kind":2048,"name":"setOptionValue","url":"classes/_zowe_imperative.cliutils.html#setoptionvalue","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3384,"kind":2048,"name":"promptForInput","url":"classes/_zowe_imperative.cliutils.html#promptforinput","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3385,"kind":2048,"name":"sleep","url":"classes/_zowe_imperative.cliutils.html#sleep","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3386,"kind":2048,"name":"promptWithTimeout","url":"classes/_zowe_imperative.cliutils.html#promptwithtimeout","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3387,"kind":2048,"name":"readPrompt","url":"classes/_zowe_imperative.cliutils.html#readprompt","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3388,"kind":2048,"name":"buildBaseArgs","url":"classes/_zowe_imperative.cliutils.html#buildbaseargs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3389,"kind":2048,"name":"getOptionFormat","url":"classes/_zowe_imperative.cliutils.html#getoptionformat","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.CliUtils"},{"id":3390,"kind":128,"name":"LoggerUtils","url":"classes/_zowe_imperative.loggerutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3391,"kind":1024,"name":"CENSOR_RESPONSE","url":"classes/_zowe_imperative.loggerutils.html#censor_response","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3392,"kind":1024,"name":"CENSORED_OPTIONS","url":"classes/_zowe_imperative.loggerutils.html#censored_options","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3393,"kind":1024,"name":"SECURE_PROMPT_OPTIONS","url":"classes/_zowe_imperative.loggerutils.html#secure_prompt_options","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3394,"kind":2048,"name":"censorCLIArgs","url":"classes/_zowe_imperative.loggerutils.html#censorcliargs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3395,"kind":2048,"name":"censorYargsArguments","url":"classes/_zowe_imperative.loggerutils.html#censoryargsarguments","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3396,"kind":1024,"name":"mConfig","url":"classes/_zowe_imperative.loggerutils.html#mconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3397,"kind":262144,"name":"config","url":"classes/_zowe_imperative.loggerutils.html#config","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3398,"kind":1024,"name":"mLayer","url":"classes/_zowe_imperative.loggerutils.html#mlayer","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3399,"kind":262144,"name":"layer","url":"classes/_zowe_imperative.loggerutils.html#layer","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3400,"kind":1024,"name":"mSecureFields","url":"classes/_zowe_imperative.loggerutils.html#msecurefields","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3401,"kind":262144,"name":"secureFields","url":"classes/_zowe_imperative.loggerutils.html#securefields","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3402,"kind":1024,"name":"mProfiles","url":"classes/_zowe_imperative.loggerutils.html#mprofiles","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3403,"kind":262144,"name":"profileSchemas","url":"classes/_zowe_imperative.loggerutils.html#profileschemas","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3404,"kind":2048,"name":"setProfileSchemas","url":"classes/_zowe_imperative.loggerutils.html#setprofileschemas","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3405,"kind":2048,"name":"isSpecialValue","url":"classes/_zowe_imperative.loggerutils.html#isspecialvalue","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3406,"kind":2048,"name":"censorRawData","url":"classes/_zowe_imperative.loggerutils.html#censorrawdata","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.LoggerUtils"},{"id":3407,"kind":128,"name":"Logger","url":"classes/_zowe_imperative.logger.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3408,"kind":1024,"name":"DEFAULT_IMPERATIVE_NAME","url":"classes/_zowe_imperative.logger.html#default_imperative_name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Logger"},{"id":3409,"kind":1024,"name":"DEFAULT_APP_NAME","url":"classes/_zowe_imperative.logger.html#default_app_name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Logger"},{"id":3410,"kind":1024,"name":"DEFAULT_CONSOLE_NAME","url":"classes/_zowe_imperative.logger.html#default_console_name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Logger"},{"id":3411,"kind":1024,"name":"DEFAULT_VALID_LOG_LEVELS","url":"classes/_zowe_imperative.logger.html#default_valid_log_levels","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Logger"},{"id":3412,"kind":2048,"name":"getLoggerCategory","url":"classes/_zowe_imperative.logger.html#getloggercategory","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Logger"},{"id":3413,"kind":2048,"name":"getImperativeLogger","url":"classes/_zowe_imperative.logger.html#getimperativelogger","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Logger"},{"id":3414,"kind":2048,"name":"getAppLogger","url":"classes/_zowe_imperative.logger.html#getapplogger","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Logger"},{"id":3415,"kind":2048,"name":"setLogInMemory","url":"classes/_zowe_imperative.logger.html#setloginmemory","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Logger"},{"id":3416,"kind":2048,"name":"writeInMemoryMessages","url":"classes/_zowe_imperative.logger.html#writeinmemorymessages","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Logger"},{"id":3417,"kind":2048,"name":"isValidLevel","url":"classes/_zowe_imperative.logger.html#isvalidlevel","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Logger"},{"id":3418,"kind":2048,"name":"getConsoleLogger","url":"classes/_zowe_imperative.logger.html#getconsolelogger","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Logger"},{"id":3419,"kind":2048,"name":"initLogger","url":"classes/_zowe_imperative.logger.html#initlogger","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.Logger"},{"id":3420,"kind":1024,"name":"initStatus","url":"classes/_zowe_imperative.logger.html#initstatus","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Logger"},{"id":3421,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.logger.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.Logger"},{"id":3422,"kind":1024,"name":"mJsLogger","url":"classes/_zowe_imperative.logger.html#mjslogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Logger"},{"id":3423,"kind":1024,"name":"category","url":"classes/_zowe_imperative.logger.html#category","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Logger"},{"id":3424,"kind":2048,"name":"trace","url":"classes/_zowe_imperative.logger.html#trace","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Logger"},{"id":3425,"kind":2048,"name":"debug","url":"classes/_zowe_imperative.logger.html#debug","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Logger"},{"id":3426,"kind":2048,"name":"info","url":"classes/_zowe_imperative.logger.html#info","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Logger"},{"id":3427,"kind":2048,"name":"warn","url":"classes/_zowe_imperative.logger.html#warn","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Logger"},{"id":3428,"kind":2048,"name":"error","url":"classes/_zowe_imperative.logger.html#error","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Logger"},{"id":3429,"kind":2048,"name":"fatal","url":"classes/_zowe_imperative.logger.html#fatal","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Logger"},{"id":3430,"kind":2048,"name":"simple","url":"classes/_zowe_imperative.logger.html#simple","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Logger"},{"id":3431,"kind":2048,"name":"logError","url":"classes/_zowe_imperative.logger.html#logerror","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.Logger"},{"id":3432,"kind":2048,"name":"getCallerFileAndLineTag","url":"classes/_zowe_imperative.logger.html#getcallerfileandlinetag","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Logger"},{"id":3433,"kind":262144,"name":"level","url":"classes/_zowe_imperative.logger.html#level","classes":"tsd-kind-accessor tsd-parent-kind-class","parent":"@zowe/imperative.Logger"},{"id":3434,"kind":262144,"name":"logService","url":"classes/_zowe_imperative.logger.html#logservice","classes":"tsd-kind-accessor tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.Logger"},{"id":3435,"kind":256,"name":"IImperativeErrorParms","url":"interfaces/_zowe_imperative.iimperativeerrorparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3436,"kind":1024,"name":"logger","url":"interfaces/_zowe_imperative.iimperativeerrorparms.html#logger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeErrorParms"},{"id":3437,"kind":1024,"name":"tag","url":"interfaces/_zowe_imperative.iimperativeerrorparms.html#tag","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IImperativeErrorParms"},{"id":3438,"kind":128,"name":"ImperativeError","url":"classes/_zowe_imperative.imperativeerror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3439,"kind":1024,"name":"mMessage","url":"classes/_zowe_imperative.imperativeerror.html#mmessage","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImperativeError"},{"id":3440,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.imperativeerror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeError"},{"id":3441,"kind":1024,"name":"mDetails","url":"classes/_zowe_imperative.imperativeerror.html#mdetails","classes":"tsd-kind-property tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeError"},{"id":3442,"kind":262144,"name":"causeErrors","url":"classes/_zowe_imperative.imperativeerror.html#causeerrors","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeError"},{"id":3443,"kind":262144,"name":"additionalDetails","url":"classes/_zowe_imperative.imperativeerror.html#additionaldetails","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeError"},{"id":3444,"kind":262144,"name":"details","url":"classes/_zowe_imperative.imperativeerror.html#details","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeError"},{"id":3445,"kind":262144,"name":"errorCode","url":"classes/_zowe_imperative.imperativeerror.html#errorcode","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeError"},{"id":3446,"kind":262144,"name":"suppressDump","url":"classes/_zowe_imperative.imperativeerror.html#suppressdump","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/imperative.ImperativeError"},{"id":3447,"kind":262144,"name":"stack","url":"classes/_zowe_imperative.imperativeerror.html#stack","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ImperativeError"},{"id":3448,"kind":262144,"name":"message","url":"classes/_zowe_imperative.imperativeerror.html#message","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ImperativeError"},{"id":3449,"kind":1024,"name":"name","url":"classes/_zowe_imperative.imperativeerror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ImperativeError"},{"id":3450,"kind":1024,"name":"Error","url":"classes/_zowe_imperative.imperativeerror.html#error","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ImperativeError"},{"id":3451,"kind":128,"name":"ChainedHandlerService","url":"classes/_zowe_imperative.chainedhandlerservice.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3452,"kind":2048,"name":"getArguments","url":"classes/_zowe_imperative.chainedhandlerservice.html#getarguments","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ChainedHandlerService"},{"id":3453,"kind":2097152,"name":"MOCKED_COMMAND_TREE","url":"modules/_zowe_imperative.html#mocked_command_tree","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3454,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#mocked_command_tree.name","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.MOCKED_COMMAND_TREE"},{"id":3455,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#mocked_command_tree.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.MOCKED_COMMAND_TREE"},{"id":3456,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#mocked_command_tree.type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.MOCKED_COMMAND_TREE"},{"id":3457,"kind":32,"name":"children","url":"modules/_zowe_imperative.html#mocked_command_tree.children","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.MOCKED_COMMAND_TREE"},{"id":3458,"kind":2097152,"name":"listDefinition","url":"modules/_zowe_imperative.html#listdefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3459,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#listdefinition.name-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listDefinition"},{"id":3460,"kind":32,"name":"aliases","url":"modules/_zowe_imperative.html#listdefinition.aliases-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listDefinition"},{"id":3461,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#listdefinition.type-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listDefinition"},{"id":3462,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#listdefinition.summary-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listDefinition"},{"id":3463,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#listdefinition.description-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listDefinition"},{"id":3464,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#listdefinition.handler-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listDefinition"},{"id":3465,"kind":32,"name":"positionals","url":"modules/_zowe_imperative.html#listdefinition.positionals-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listDefinition"},{"id":3466,"kind":32,"name":"options","url":"modules/_zowe_imperative.html#listdefinition.options-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listDefinition"},{"id":3467,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#listdefinition.examples-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.listDefinition"},{"id":3468,"kind":2097152,"name":"initDefinition","url":"modules/_zowe_imperative.html#initdefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3469,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#initdefinition.name-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.initDefinition"},{"id":3470,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#initdefinition.type-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.initDefinition"},{"id":3471,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#initdefinition.handler-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.initDefinition"},{"id":3472,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#initdefinition.summary-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.initDefinition"},{"id":3473,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#initdefinition.description-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.initDefinition"},{"id":3474,"kind":32,"name":"options","url":"modules/_zowe_imperative.html#initdefinition.options-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.initDefinition"},{"id":3475,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#initdefinition.examples-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.initDefinition"},{"id":3476,"kind":2097152,"name":"schemaDefinition","url":"modules/_zowe_imperative.html#schemadefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3477,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#schemadefinition.name-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.schemaDefinition"},{"id":3478,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#schemadefinition.type-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.schemaDefinition"},{"id":3479,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#schemadefinition.handler-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.schemaDefinition"},{"id":3480,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#schemadefinition.summary-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.schemaDefinition"},{"id":3481,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#schemadefinition.description-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.schemaDefinition"},{"id":3482,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#schemadefinition.examples-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.schemaDefinition"},{"id":3483,"kind":2097152,"name":"profilesDefinition","url":"modules/_zowe_imperative.html#profilesdefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3484,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#profilesdefinition.name-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profilesDefinition"},{"id":3485,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#profilesdefinition.type-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profilesDefinition"},{"id":3486,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#profilesdefinition.handler-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profilesDefinition"},{"id":3487,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#profilesdefinition.summary-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profilesDefinition"},{"id":3488,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#profilesdefinition.description-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profilesDefinition"},{"id":3489,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#profilesdefinition.examples-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.profilesDefinition"},{"id":3490,"kind":2097152,"name":"secureDefinition","url":"modules/_zowe_imperative.html#securedefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3491,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#securedefinition.name-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.secureDefinition"},{"id":3492,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#securedefinition.type-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.secureDefinition"},{"id":3493,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#securedefinition.handler-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.secureDefinition"},{"id":3494,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#securedefinition.summary-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.secureDefinition"},{"id":3495,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#securedefinition.description-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.secureDefinition"},{"id":3496,"kind":32,"name":"options","url":"modules/_zowe_imperative.html#securedefinition.options-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.secureDefinition"},{"id":3497,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#securedefinition.examples-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.secureDefinition"},{"id":3498,"kind":2097152,"name":"setDefinition","url":"modules/_zowe_imperative.html#setdefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3499,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#setdefinition.name-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setDefinition"},{"id":3500,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#setdefinition.type-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setDefinition"},{"id":3501,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#setdefinition.handler-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setDefinition"},{"id":3502,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#setdefinition.summary-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setDefinition"},{"id":3503,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#setdefinition.description-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setDefinition"},{"id":3504,"kind":32,"name":"positionals","url":"modules/_zowe_imperative.html#setdefinition.positionals-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setDefinition"},{"id":3505,"kind":32,"name":"options","url":"modules/_zowe_imperative.html#setdefinition.options-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setDefinition"},{"id":3506,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#setdefinition.examples-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.setDefinition"},{"id":3507,"kind":2097152,"name":"editDefinition","url":"modules/_zowe_imperative.html#editdefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3508,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#editdefinition.name-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.editDefinition"},{"id":3509,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#editdefinition.type-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.editDefinition"},{"id":3510,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#editdefinition.handler-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.editDefinition"},{"id":3511,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#editdefinition.summary-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.editDefinition"},{"id":3512,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#editdefinition.description-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.editDefinition"},{"id":3513,"kind":32,"name":"options","url":"modules/_zowe_imperative.html#editdefinition.options-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.editDefinition"},{"id":3514,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#editdefinition.examples-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.editDefinition"},{"id":3515,"kind":2097152,"name":"importDefinition","url":"modules/_zowe_imperative.html#importdefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3516,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#importdefinition.name-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.importDefinition"},{"id":3517,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#importdefinition.type-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.importDefinition"},{"id":3518,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#importdefinition.handler-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.importDefinition"},{"id":3519,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#importdefinition.summary-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.importDefinition"},{"id":3520,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#importdefinition.description-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.importDefinition"},{"id":3521,"kind":32,"name":"positionals","url":"modules/_zowe_imperative.html#importdefinition.positionals-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.importDefinition"},{"id":3522,"kind":32,"name":"options","url":"modules/_zowe_imperative.html#importdefinition.options-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.importDefinition"},{"id":3523,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#importdefinition.examples-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.importDefinition"},{"id":3524,"kind":2097152,"name":"convertProfilesDefinition","url":"modules/_zowe_imperative.html#convertprofilesdefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3525,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#convertprofilesdefinition.name-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.convertProfilesDefinition"},{"id":3526,"kind":32,"name":"aliases","url":"modules/_zowe_imperative.html#convertprofilesdefinition.aliases-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.convertProfilesDefinition"},{"id":3527,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#convertprofilesdefinition.type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.convertProfilesDefinition"},{"id":3528,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#convertprofilesdefinition.handler-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.convertProfilesDefinition"},{"id":3529,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#convertprofilesdefinition.summary-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.convertProfilesDefinition"},{"id":3530,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#convertprofilesdefinition.description-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.convertProfilesDefinition"},{"id":3531,"kind":32,"name":"options","url":"modules/_zowe_imperative.html#convertprofilesdefinition.options","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.convertProfilesDefinition"},{"id":3532,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#convertprofilesdefinition.examples-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.convertProfilesDefinition"},{"id":3533,"kind":2097152,"name":"ReportEnvDefinition","url":"modules/_zowe_imperative.html#reportenvdefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3534,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#reportenvdefinition.name-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ReportEnvDefinition"},{"id":3535,"kind":32,"name":"aliases","url":"modules/_zowe_imperative.html#reportenvdefinition.aliases","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ReportEnvDefinition"},{"id":3536,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#reportenvdefinition.type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ReportEnvDefinition"},{"id":3537,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#reportenvdefinition.handler","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ReportEnvDefinition"},{"id":3538,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#reportenvdefinition.summary","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ReportEnvDefinition"},{"id":3539,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#reportenvdefinition.description-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ReportEnvDefinition"},{"id":3540,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#reportenvdefinition.examples","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.ReportEnvDefinition"},{"id":3541,"kind":2097152,"name":"updateSchemasDefinition","url":"modules/_zowe_imperative.html#updateschemasdefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3542,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#updateschemasdefinition.name-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateSchemasDefinition"},{"id":3543,"kind":32,"name":"aliases","url":"modules/_zowe_imperative.html#updateschemasdefinition.aliases-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateSchemasDefinition"},{"id":3544,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#updateschemasdefinition.type-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateSchemasDefinition"},{"id":3545,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#updateschemasdefinition.summary-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateSchemasDefinition"},{"id":3546,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#updateschemasdefinition.description-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateSchemasDefinition"},{"id":3547,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#updateschemasdefinition.handler-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateSchemasDefinition"},{"id":3548,"kind":32,"name":"positionals","url":"modules/_zowe_imperative.html#updateschemasdefinition.positionals-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateSchemasDefinition"},{"id":3549,"kind":32,"name":"options","url":"modules/_zowe_imperative.html#updateschemasdefinition.options-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateSchemasDefinition"},{"id":3550,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#updateschemasdefinition.examples-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateSchemasDefinition"},{"id":3551,"kind":128,"name":"ConfigManagementFacility","url":"classes/_zowe_imperative.configmanagementfacility.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3552,"kind":1024,"name":"mInstance","url":"classes/_zowe_imperative.configmanagementfacility.html#minstance","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.ConfigManagementFacility"},{"id":3553,"kind":1024,"name":"impLogger","url":"classes/_zowe_imperative.configmanagementfacility.html#implogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ConfigManagementFacility"},{"id":3554,"kind":262144,"name":"instance","url":"classes/_zowe_imperative.configmanagementfacility.html#instance","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.ConfigManagementFacility"},{"id":3555,"kind":2048,"name":"init","url":"classes/_zowe_imperative.configmanagementfacility.html#init","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConfigManagementFacility"},{"id":3556,"kind":64,"name":"findNpmOnPath","url":"modules/_zowe_imperative.html#findnpmonpath","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3557,"kind":64,"name":"installPackages","url":"modules/_zowe_imperative.html#installpackages","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3558,"kind":64,"name":"getRegistry","url":"modules/_zowe_imperative.html#getregistry","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3559,"kind":64,"name":"npmLogin","url":"modules/_zowe_imperative.html#npmlogin","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3560,"kind":64,"name":"getPackageInfo","url":"modules/_zowe_imperative.html#getpackageinfo","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3561,"kind":64,"name":"updateExtendersJson","url":"modules/_zowe_imperative.html#updateextendersjson","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3562,"kind":64,"name":"install","url":"modules/_zowe_imperative.html#install","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3563,"kind":2097152,"name":"onlyForTesting","url":"modules/_zowe_imperative.html#onlyfortesting","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3564,"kind":32,"name":"callPluginPostInstall","url":"modules/_zowe_imperative.html#onlyfortesting.callpluginpostinstall","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.onlyForTesting"},{"id":3565,"kind":64,"name":"updateAndGetRemovedTypes","url":"modules/_zowe_imperative.html#updateandgetremovedtypes","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3566,"kind":64,"name":"uninstall","url":"modules/_zowe_imperative.html#uninstall","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3567,"kind":64,"name":"update","url":"modules/_zowe_imperative.html#update","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3568,"kind":128,"name":"ConvertProfilesHandler","url":"classes/_zowe_imperative.convertprofileshandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3569,"kind":1024,"name":"ZOWE_CLI_PACKAGE_NAME","url":"classes/_zowe_imperative.convertprofileshandler.html#zowe_cli_package_name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ConvertProfilesHandler"},{"id":3570,"kind":1024,"name":"ZOWE_CLI_SECURE_PLUGIN_NAME","url":"classes/_zowe_imperative.convertprofileshandler.html#zowe_cli_secure_plugin_name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ConvertProfilesHandler"},{"id":3571,"kind":1024,"name":"keytar","url":"classes/_zowe_imperative.convertprofileshandler.html#keytar","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ConvertProfilesHandler"},{"id":3572,"kind":2048,"name":"process","url":"classes/_zowe_imperative.convertprofileshandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ConvertProfilesHandler"},{"id":3573,"kind":2048,"name":"getOldPluginInfo","url":"classes/_zowe_imperative.convertprofileshandler.html#getoldplugininfo","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ConvertProfilesHandler"},{"id":3574,"kind":2048,"name":"getOldProfileCount","url":"classes/_zowe_imperative.convertprofileshandler.html#getoldprofilecount","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ConvertProfilesHandler"},{"id":3575,"kind":2048,"name":"removeOverride","url":"classes/_zowe_imperative.convertprofileshandler.html#removeoverride","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ConvertProfilesHandler"},{"id":3576,"kind":2048,"name":"checkKeytarAvailable","url":"classes/_zowe_imperative.convertprofileshandler.html#checkkeytaravailable","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ConvertProfilesHandler"},{"id":3577,"kind":2048,"name":"findOldSecureProps","url":"classes/_zowe_imperative.convertprofileshandler.html#findoldsecureprops","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ConvertProfilesHandler"},{"id":3578,"kind":2048,"name":"deleteOldSecureProps","url":"classes/_zowe_imperative.convertprofileshandler.html#deleteoldsecureprops","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ConvertProfilesHandler"},{"id":3579,"kind":128,"name":"EditHandler","url":"classes/_zowe_imperative.edithandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3580,"kind":2048,"name":"process","url":"classes/_zowe_imperative.edithandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.EditHandler"},{"id":3581,"kind":128,"name":"ImportHandler","url":"classes/_zowe_imperative.importhandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3582,"kind":1024,"name":"params","url":"classes/_zowe_imperative.importhandler.html#params","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImportHandler"},{"id":3583,"kind":2048,"name":"process","url":"classes/_zowe_imperative.importhandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ImportHandler"},{"id":3584,"kind":2048,"name":"buildSession","url":"classes/_zowe_imperative.importhandler.html#buildsession","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImportHandler"},{"id":3585,"kind":2048,"name":"fetchConfig","url":"classes/_zowe_imperative.importhandler.html#fetchconfig","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImportHandler"},{"id":3586,"kind":2048,"name":"downloadSchema","url":"classes/_zowe_imperative.importhandler.html#downloadschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ImportHandler"},{"id":3587,"kind":128,"name":"InitHandler","url":"classes/_zowe_imperative.inithandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3588,"kind":1024,"name":"params","url":"classes/_zowe_imperative.inithandler.html#params","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.InitHandler"},{"id":3589,"kind":1024,"name":"promptProps","url":"classes/_zowe_imperative.inithandler.html#promptprops","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.InitHandler"},{"id":3590,"kind":2048,"name":"process","url":"classes/_zowe_imperative.inithandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.InitHandler"},{"id":3591,"kind":2048,"name":"initWithSchema","url":"classes/_zowe_imperative.inithandler.html#initwithschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.InitHandler"},{"id":3592,"kind":2048,"name":"initForDryRun","url":"classes/_zowe_imperative.inithandler.html#initfordryrun","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.InitHandler"},{"id":3593,"kind":2048,"name":"promptForProp","url":"classes/_zowe_imperative.inithandler.html#promptforprop","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.InitHandler"},{"id":3594,"kind":128,"name":"ListHandler","url":"classes/_zowe_imperative.listhandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3595,"kind":2048,"name":"process","url":"classes/_zowe_imperative.listhandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ListHandler"},{"id":3596,"kind":128,"name":"ProfilesHandler","url":"classes/_zowe_imperative.profileshandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3597,"kind":2048,"name":"process","url":"classes/_zowe_imperative.profileshandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ProfilesHandler"},{"id":3598,"kind":2048,"name":"build","url":"classes/_zowe_imperative.profileshandler.html#build","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ProfilesHandler"},{"id":3599,"kind":4,"name":"ItemId","url":"enums/_zowe_imperative.itemid.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3600,"kind":16,"name":"ZOWE_VER","url":"enums/_zowe_imperative.itemid.html#zowe_ver","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3601,"kind":16,"name":"NODEJS_VER","url":"enums/_zowe_imperative.itemid.html#nodejs_ver","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3602,"kind":16,"name":"NVM_VER","url":"enums/_zowe_imperative.itemid.html#nvm_ver","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3603,"kind":16,"name":"PLATFORM","url":"enums/_zowe_imperative.itemid.html#platform","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3604,"kind":16,"name":"ARCHITECTURE","url":"enums/_zowe_imperative.itemid.html#architecture","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3605,"kind":16,"name":"OS_PATH","url":"enums/_zowe_imperative.itemid.html#os_path","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3606,"kind":16,"name":"ZOWE_CLI_HOME","url":"enums/_zowe_imperative.itemid.html#zowe_cli_home","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3607,"kind":16,"name":"ZOWE_APP_LOG_LEVEL","url":"enums/_zowe_imperative.itemid.html#zowe_app_log_level","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3608,"kind":16,"name":"ZOWE_IMPERATIVE_LOG_LEVEL","url":"enums/_zowe_imperative.itemid.html#zowe_imperative_log_level","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3609,"kind":16,"name":"OTHER_ZOWE_VARS","url":"enums/_zowe_imperative.itemid.html#other_zowe_vars","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3610,"kind":16,"name":"NPM_VER","url":"enums/_zowe_imperative.itemid.html#npm_ver","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3611,"kind":16,"name":"ZOWE_CONFIG_TYPE","url":"enums/_zowe_imperative.itemid.html#zowe_config_type","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3612,"kind":16,"name":"ZOWE_PLUGINS","url":"enums/_zowe_imperative.itemid.html#zowe_plugins","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/imperative.ItemId"},{"id":3613,"kind":256,"name":"IProbTest","url":"interfaces/_zowe_imperative.iprobtest.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3614,"kind":1024,"name":"itemId","url":"interfaces/_zowe_imperative.iprobtest.html#itemid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProbTest"},{"id":3615,"kind":1024,"name":"probExpr","url":"interfaces/_zowe_imperative.iprobtest.html#probexpr","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProbTest"},{"id":3616,"kind":1024,"name":"probMsg","url":"interfaces/_zowe_imperative.iprobtest.html#probmsg","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IProbTest"},{"id":3617,"kind":32,"name":"probTests","url":"modules/_zowe_imperative.html#probtests","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3618,"kind":256,"name":"IGetItemVal","url":"interfaces/_zowe_imperative.igetitemval.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3619,"kind":1024,"name":"itemVal","url":"interfaces/_zowe_imperative.igetitemval.html#itemval","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IGetItemVal"},{"id":3620,"kind":1024,"name":"itemValMsg","url":"interfaces/_zowe_imperative.igetitemval.html#itemvalmsg","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IGetItemVal"},{"id":3621,"kind":1024,"name":"itemProbMsg","url":"interfaces/_zowe_imperative.igetitemval.html#itemprobmsg","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IGetItemVal"},{"id":3622,"kind":256,"name":"IGetItemOpts","url":"interfaces/_zowe_imperative.igetitemopts.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3623,"kind":1024,"name":"progressApi","url":"interfaces/_zowe_imperative.igetitemopts.html#progressapi","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.IGetItemOpts"},{"id":3624,"kind":128,"name":"EnvQuery","url":"classes/_zowe_imperative.envquery.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3625,"kind":1024,"name":"divider","url":"classes/_zowe_imperative.envquery.html#divider","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3626,"kind":1024,"name":"indent","url":"classes/_zowe_imperative.envquery.html#indent","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3627,"kind":1024,"name":"eolMatch","url":"classes/_zowe_imperative.envquery.html#eolmatch","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3628,"kind":1024,"name":"allEolRegex","url":"classes/_zowe_imperative.envquery.html#alleolregex","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3629,"kind":1024,"name":"lastEolRegex","url":"classes/_zowe_imperative.envquery.html#lasteolregex","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3630,"kind":2048,"name":"getEnvItemVal","url":"classes/_zowe_imperative.envquery.html#getenvitemval","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3631,"kind":2048,"name":"detectProbVal","url":"classes/_zowe_imperative.envquery.html#detectprobval","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3632,"kind":2048,"name":"getCmdOutput","url":"classes/_zowe_imperative.envquery.html#getcmdoutput","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3633,"kind":2048,"name":"getConfigInfo","url":"classes/_zowe_imperative.envquery.html#getconfiginfo","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3634,"kind":2048,"name":"getEnvItemProblems","url":"classes/_zowe_imperative.envquery.html#getenvitemproblems","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3635,"kind":2048,"name":"getNpmInfo","url":"classes/_zowe_imperative.envquery.html#getnpminfo","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3636,"kind":2048,"name":"getOtherZoweEnvVars","url":"classes/_zowe_imperative.envquery.html#getotherzoweenvvars","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3637,"kind":2048,"name":"getPluginInfo","url":"classes/_zowe_imperative.envquery.html#getplugininfo","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3638,"kind":2048,"name":"getZoweVer","url":"classes/_zowe_imperative.envquery.html#getzowever","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3639,"kind":2048,"name":"updateProgressBar","url":"classes/_zowe_imperative.envquery.html#updateprogressbar","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.EnvQuery"},{"id":3640,"kind":128,"name":"ReportEnvHandler","url":"classes/_zowe_imperative.reportenvhandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3641,"kind":2048,"name":"process","url":"classes/_zowe_imperative.reportenvhandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ReportEnvHandler"},{"id":3642,"kind":2048,"name":"displayEnvReport","url":"classes/_zowe_imperative.reportenvhandler.html#displayenvreport","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ReportEnvHandler"},{"id":3643,"kind":2048,"name":"displayEnvItem","url":"classes/_zowe_imperative.reportenvhandler.html#displayenvitem","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ReportEnvHandler"},{"id":3644,"kind":128,"name":"SchemaHandler","url":"classes/_zowe_imperative.schemahandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3645,"kind":2048,"name":"process","url":"classes/_zowe_imperative.schemahandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.SchemaHandler"},{"id":3646,"kind":128,"name":"SecureHandler","url":"classes/_zowe_imperative.securehandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3647,"kind":1024,"name":"params","url":"classes/_zowe_imperative.securehandler.html#params","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SecureHandler"},{"id":3648,"kind":2048,"name":"process","url":"classes/_zowe_imperative.securehandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.SecureHandler"},{"id":3649,"kind":2048,"name":"handlePromptForAuthToken","url":"classes/_zowe_imperative.securehandler.html#handlepromptforauthtoken","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.SecureHandler"},{"id":3650,"kind":128,"name":"SetHandler","url":"classes/_zowe_imperative.sethandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3651,"kind":2048,"name":"process","url":"classes/_zowe_imperative.sethandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.SetHandler"},{"id":3652,"kind":128,"name":"UpdateSchemasHandler","url":"classes/_zowe_imperative.updateschemashandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3653,"kind":2048,"name":"process","url":"classes/_zowe_imperative.updateschemashandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.UpdateSchemasHandler"},{"id":3654,"kind":128,"name":"DefaultRootCommandHandler","url":"classes/_zowe_imperative.defaultrootcommandhandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3655,"kind":2048,"name":"process","url":"classes/_zowe_imperative.defaultrootcommandhandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.DefaultRootCommandHandler"},{"id":3656,"kind":128,"name":"PluginRequireProvider","url":"classes/_zowe_imperative.pluginrequireprovider.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3657,"kind":2048,"name":"createPluginHooks","url":"classes/_zowe_imperative.pluginrequireprovider.html#createpluginhooks","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.PluginRequireProvider"},{"id":3658,"kind":2048,"name":"destroyPluginHooks","url":"classes/_zowe_imperative.pluginrequireprovider.html#destroypluginhooks","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/imperative.PluginRequireProvider"},{"id":3659,"kind":1024,"name":"mInstance","url":"classes/_zowe_imperative.pluginrequireprovider.html#minstance","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.PluginRequireProvider"},{"id":3660,"kind":2048,"name":"sanitizeExpression","url":"classes/_zowe_imperative.pluginrequireprovider.html#sanitizeexpression","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/imperative.PluginRequireProvider"},{"id":3661,"kind":1024,"name":"origRequire","url":"classes/_zowe_imperative.pluginrequireprovider.html#origrequire","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginRequireProvider"},{"id":3662,"kind":1024,"name":"regex","url":"classes/_zowe_imperative.pluginrequireprovider.html#regex","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginRequireProvider"},{"id":3663,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.pluginrequireprovider.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginRequireProvider"},{"id":3664,"kind":1024,"name":"modules","url":"classes/_zowe_imperative.pluginrequireprovider.html#modules","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.PluginRequireProvider"},{"id":3665,"kind":2097152,"name":"installDefinition","url":"modules/_zowe_imperative.html#installdefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3666,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#installdefinition.name-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.installDefinition"},{"id":3667,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#installdefinition.type-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.installDefinition"},{"id":3668,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#installdefinition.summary-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.installDefinition"},{"id":3669,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#installdefinition.description-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.installDefinition"},{"id":3670,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#installdefinition.handler-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.installDefinition"},{"id":3671,"kind":32,"name":"positionals","url":"modules/_zowe_imperative.html#installdefinition.positionals-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.installDefinition"},{"id":3672,"kind":32,"name":"options","url":"modules/_zowe_imperative.html#installdefinition.options-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.installDefinition"},{"id":3673,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#installdefinition.examples-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.installDefinition"},{"id":3674,"kind":64,"name":"runValidatePlugin","url":"modules/_zowe_imperative.html#runvalidateplugin","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3675,"kind":128,"name":"InstallHandler","url":"classes/_zowe_imperative.installhandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3676,"kind":1024,"name":"console","url":"classes/_zowe_imperative.installhandler.html#console","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.InstallHandler"},{"id":3677,"kind":2048,"name":"process","url":"classes/_zowe_imperative.installhandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.InstallHandler"},{"id":3678,"kind":2097152,"name":"firststepsDefinition","url":"modules/_zowe_imperative.html#firststepsdefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3679,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#firststepsdefinition.name-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.firststepsDefinition"},{"id":3680,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#firststepsdefinition.type-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.firststepsDefinition"},{"id":3681,"kind":32,"name":"aliases","url":"modules/_zowe_imperative.html#firststepsdefinition.aliases-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.firststepsDefinition"},{"id":3682,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#firststepsdefinition.summary-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.firststepsDefinition"},{"id":3683,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#firststepsdefinition.description-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.firststepsDefinition"},{"id":3684,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#firststepsdefinition.handler-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.firststepsDefinition"},{"id":3685,"kind":32,"name":"positionals","url":"modules/_zowe_imperative.html#firststepsdefinition.positionals","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.firststepsDefinition"},{"id":3686,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#firststepsdefinition.examples-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.firststepsDefinition"},{"id":3687,"kind":128,"name":"FirststepsHandler","url":"classes/_zowe_imperative.firststepshandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3688,"kind":1024,"name":"console","url":"classes/_zowe_imperative.firststepshandler.html#console","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.FirststepsHandler"},{"id":3689,"kind":2048,"name":"process","url":"classes/_zowe_imperative.firststepshandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.FirststepsHandler"},{"id":3690,"kind":2097152,"name":"uninstallDefinition","url":"modules/_zowe_imperative.html#uninstalldefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3691,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#uninstalldefinition.name-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.uninstallDefinition"},{"id":3692,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#uninstalldefinition.type-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.uninstallDefinition"},{"id":3693,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#uninstalldefinition.summary-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.uninstallDefinition"},{"id":3694,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#uninstalldefinition.description-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.uninstallDefinition"},{"id":3695,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#uninstalldefinition.handler-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.uninstallDefinition"},{"id":3696,"kind":32,"name":"positionals","url":"modules/_zowe_imperative.html#uninstalldefinition.positionals-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.uninstallDefinition"},{"id":3697,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#uninstalldefinition.examples-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.uninstallDefinition"},{"id":3698,"kind":128,"name":"UninstallHandler","url":"classes/_zowe_imperative.uninstallhandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3699,"kind":1024,"name":"console","url":"classes/_zowe_imperative.uninstallhandler.html#console","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.UninstallHandler"},{"id":3700,"kind":2048,"name":"process","url":"classes/_zowe_imperative.uninstallhandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.UninstallHandler"},{"id":3701,"kind":2048,"name":"callPluginPreUninstall","url":"classes/_zowe_imperative.uninstallhandler.html#callpluginpreuninstall","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.UninstallHandler"},{"id":3702,"kind":2097152,"name":"updateDefinition","url":"modules/_zowe_imperative.html#updatedefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3703,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#updatedefinition.name-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateDefinition"},{"id":3704,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#updatedefinition.type-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateDefinition"},{"id":3705,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#updatedefinition.summary-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateDefinition"},{"id":3706,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#updatedefinition.description-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateDefinition"},{"id":3707,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#updatedefinition.handler-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateDefinition"},{"id":3708,"kind":32,"name":"positionals","url":"modules/_zowe_imperative.html#updatedefinition.positionals-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateDefinition"},{"id":3709,"kind":32,"name":"options","url":"modules/_zowe_imperative.html#updatedefinition.options-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateDefinition"},{"id":3710,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#updatedefinition.examples-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.updateDefinition"},{"id":3711,"kind":128,"name":"UpdateHandler","url":"classes/_zowe_imperative.updatehandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3712,"kind":1024,"name":"console","url":"classes/_zowe_imperative.updatehandler.html#console","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.UpdateHandler"},{"id":3713,"kind":2048,"name":"process","url":"classes/_zowe_imperative.updatehandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.UpdateHandler"},{"id":3714,"kind":2097152,"name":"validateDefinition","url":"modules/_zowe_imperative.html#validatedefinition","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3715,"kind":32,"name":"name","url":"modules/_zowe_imperative.html#validatedefinition.name-16","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateDefinition"},{"id":3716,"kind":32,"name":"type","url":"modules/_zowe_imperative.html#validatedefinition.type-16","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateDefinition"},{"id":3717,"kind":32,"name":"summary","url":"modules/_zowe_imperative.html#validatedefinition.summary-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateDefinition"},{"id":3718,"kind":32,"name":"description","url":"modules/_zowe_imperative.html#validatedefinition.description-16","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateDefinition"},{"id":3719,"kind":32,"name":"handler","url":"modules/_zowe_imperative.html#validatedefinition.handler-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateDefinition"},{"id":3720,"kind":32,"name":"positionals","url":"modules/_zowe_imperative.html#validatedefinition.positionals-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateDefinition"},{"id":3721,"kind":32,"name":"options","url":"modules/_zowe_imperative.html#validatedefinition.options-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateDefinition"},{"id":3722,"kind":32,"name":"examples","url":"modules/_zowe_imperative.html#validatedefinition.examples-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/imperative.validateDefinition"},{"id":3723,"kind":128,"name":"ValidateHandler","url":"classes/_zowe_imperative.validatehandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3724,"kind":1024,"name":"pluginIssues","url":"classes/_zowe_imperative.validatehandler.html#pluginissues","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ValidateHandler"},{"id":3725,"kind":2048,"name":"process","url":"classes/_zowe_imperative.validatehandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ValidateHandler"},{"id":3726,"kind":2048,"name":"displayPluginIssues","url":"classes/_zowe_imperative.validatehandler.html#displaypluginissues","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ValidateHandler"},{"id":3727,"kind":128,"name":"PluginRequireAlreadyCreatedError","url":"classes/_zowe_imperative.pluginrequirealreadycreatederror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3728,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.pluginrequirealreadycreatederror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.PluginRequireAlreadyCreatedError"},{"id":3729,"kind":1024,"name":"mDetails","url":"classes/_zowe_imperative.pluginrequirealreadycreatederror.html#mdetails","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireAlreadyCreatedError"},{"id":3730,"kind":262144,"name":"causeErrors","url":"classes/_zowe_imperative.pluginrequirealreadycreatederror.html#causeerrors","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireAlreadyCreatedError"},{"id":3731,"kind":262144,"name":"additionalDetails","url":"classes/_zowe_imperative.pluginrequirealreadycreatederror.html#additionaldetails","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireAlreadyCreatedError"},{"id":3732,"kind":262144,"name":"details","url":"classes/_zowe_imperative.pluginrequirealreadycreatederror.html#details","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireAlreadyCreatedError"},{"id":3733,"kind":262144,"name":"errorCode","url":"classes/_zowe_imperative.pluginrequirealreadycreatederror.html#errorcode","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireAlreadyCreatedError"},{"id":3734,"kind":262144,"name":"suppressDump","url":"classes/_zowe_imperative.pluginrequirealreadycreatederror.html#suppressdump","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireAlreadyCreatedError"},{"id":3735,"kind":262144,"name":"stack","url":"classes/_zowe_imperative.pluginrequirealreadycreatederror.html#stack","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.PluginRequireAlreadyCreatedError"},{"id":3736,"kind":262144,"name":"message","url":"classes/_zowe_imperative.pluginrequirealreadycreatederror.html#message","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.PluginRequireAlreadyCreatedError"},{"id":3737,"kind":1024,"name":"name","url":"classes/_zowe_imperative.pluginrequirealreadycreatederror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireAlreadyCreatedError"},{"id":3738,"kind":128,"name":"PluginRequireNotCreatedError","url":"classes/_zowe_imperative.pluginrequirenotcreatederror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3739,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.pluginrequirenotcreatederror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.PluginRequireNotCreatedError"},{"id":3740,"kind":1024,"name":"mDetails","url":"classes/_zowe_imperative.pluginrequirenotcreatederror.html#mdetails","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireNotCreatedError"},{"id":3741,"kind":262144,"name":"causeErrors","url":"classes/_zowe_imperative.pluginrequirenotcreatederror.html#causeerrors","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireNotCreatedError"},{"id":3742,"kind":262144,"name":"additionalDetails","url":"classes/_zowe_imperative.pluginrequirenotcreatederror.html#additionaldetails","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireNotCreatedError"},{"id":3743,"kind":262144,"name":"details","url":"classes/_zowe_imperative.pluginrequirenotcreatederror.html#details","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireNotCreatedError"},{"id":3744,"kind":262144,"name":"errorCode","url":"classes/_zowe_imperative.pluginrequirenotcreatederror.html#errorcode","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireNotCreatedError"},{"id":3745,"kind":262144,"name":"suppressDump","url":"classes/_zowe_imperative.pluginrequirenotcreatederror.html#suppressdump","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireNotCreatedError"},{"id":3746,"kind":262144,"name":"stack","url":"classes/_zowe_imperative.pluginrequirenotcreatederror.html#stack","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.PluginRequireNotCreatedError"},{"id":3747,"kind":262144,"name":"message","url":"classes/_zowe_imperative.pluginrequirenotcreatederror.html#message","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.PluginRequireNotCreatedError"},{"id":3748,"kind":1024,"name":"name","url":"classes/_zowe_imperative.pluginrequirenotcreatederror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.PluginRequireNotCreatedError"},{"id":3749,"kind":128,"name":"ProfilesShowDependenciesCommandBuilder","url":"classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3750,"kind":2048,"name":"getAction","url":"classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html#getaction","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesShowDependenciesCommandBuilder"},{"id":3751,"kind":2048,"name":"buildFull","url":"classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html#buildfull","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.ProfilesShowDependenciesCommandBuilder"},{"id":3752,"kind":2048,"name":"buildProfileSegmentFromSchema","url":"classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html#buildprofilesegmentfromschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"@zowe/imperative.ProfilesShowDependenciesCommandBuilder"},{"id":3753,"kind":1024,"name":"mSchema","url":"classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html#mschema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesShowDependenciesCommandBuilder"},{"id":3754,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfilesShowDependenciesCommandBuilder"},{"id":3755,"kind":1024,"name":"mProfileType","url":"classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html#mprofiletype","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesShowDependenciesCommandBuilder"},{"id":3756,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesShowDependenciesCommandBuilder"},{"id":3757,"kind":1024,"name":"mProfileConfig","url":"classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html#mprofileconfig","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesShowDependenciesCommandBuilder"},{"id":3758,"kind":2048,"name":"build","url":"classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html#build","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.ProfilesShowDependenciesCommandBuilder"},{"id":3759,"kind":2048,"name":"buildOptionsFromProfileSchema","url":"classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html#buildoptionsfromprofileschema","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"@zowe/imperative.ProfilesShowDependenciesCommandBuilder"},{"id":3760,"kind":128,"name":"CreateProfilesHandler","url":"classes/_zowe_imperative.createprofileshandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3761,"kind":2048,"name":"process","url":"classes/_zowe_imperative.createprofileshandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.CreateProfilesHandler"},{"id":3762,"kind":128,"name":"ListProfilesHandler","url":"classes/_zowe_imperative.listprofileshandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3763,"kind":2048,"name":"process","url":"classes/_zowe_imperative.listprofileshandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ListProfilesHandler"},{"id":3764,"kind":128,"name":"NewDeleteProfilesHandler","url":"classes/_zowe_imperative.newdeleteprofileshandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3765,"kind":2048,"name":"process","url":"classes/_zowe_imperative.newdeleteprofileshandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.NewDeleteProfilesHandler"},{"id":3766,"kind":128,"name":"SetDefaultProfilesHandler","url":"classes/_zowe_imperative.setdefaultprofileshandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3767,"kind":2048,"name":"process","url":"classes/_zowe_imperative.setdefaultprofileshandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.SetDefaultProfilesHandler"},{"id":3768,"kind":128,"name":"ShowDependenciesProfilesHandler","url":"classes/_zowe_imperative.showdependenciesprofileshandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3769,"kind":2048,"name":"process","url":"classes/_zowe_imperative.showdependenciesprofileshandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ShowDependenciesProfilesHandler"},{"id":3770,"kind":128,"name":"UpdateProfilesHandler","url":"classes/_zowe_imperative.updateprofileshandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3771,"kind":2048,"name":"process","url":"classes/_zowe_imperative.updateprofileshandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.UpdateProfilesHandler"},{"id":3772,"kind":128,"name":"ValidateProfileHandler","url":"classes/_zowe_imperative.validateprofilehandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3773,"kind":1024,"name":"mLogger","url":"classes/_zowe_imperative.validateprofilehandler.html#mlogger","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/imperative.ValidateProfileHandler"},{"id":3774,"kind":2048,"name":"process","url":"classes/_zowe_imperative.validateprofilehandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/imperative.ValidateProfileHandler"},{"id":3775,"kind":32,"name":"loggerUtilsRequire","url":"modules/_zowe_imperative.html#loggerutilsrequire","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3776,"kind":128,"name":"SettingsAlreadyInitialized","url":"classes/_zowe_imperative.settingsalreadyinitialized.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3777,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.settingsalreadyinitialized.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.SettingsAlreadyInitialized"},{"id":3778,"kind":1024,"name":"mDetails","url":"classes/_zowe_imperative.settingsalreadyinitialized.html#mdetails","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsAlreadyInitialized"},{"id":3779,"kind":262144,"name":"causeErrors","url":"classes/_zowe_imperative.settingsalreadyinitialized.html#causeerrors","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsAlreadyInitialized"},{"id":3780,"kind":262144,"name":"additionalDetails","url":"classes/_zowe_imperative.settingsalreadyinitialized.html#additionaldetails","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsAlreadyInitialized"},{"id":3781,"kind":262144,"name":"details","url":"classes/_zowe_imperative.settingsalreadyinitialized.html#details","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsAlreadyInitialized"},{"id":3782,"kind":262144,"name":"errorCode","url":"classes/_zowe_imperative.settingsalreadyinitialized.html#errorcode","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsAlreadyInitialized"},{"id":3783,"kind":262144,"name":"suppressDump","url":"classes/_zowe_imperative.settingsalreadyinitialized.html#suppressdump","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsAlreadyInitialized"},{"id":3784,"kind":262144,"name":"stack","url":"classes/_zowe_imperative.settingsalreadyinitialized.html#stack","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.SettingsAlreadyInitialized"},{"id":3785,"kind":262144,"name":"message","url":"classes/_zowe_imperative.settingsalreadyinitialized.html#message","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.SettingsAlreadyInitialized"},{"id":3786,"kind":1024,"name":"name","url":"classes/_zowe_imperative.settingsalreadyinitialized.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsAlreadyInitialized"},{"id":3787,"kind":128,"name":"SettingsNotInitialized","url":"classes/_zowe_imperative.settingsnotinitialized.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3788,"kind":512,"name":"constructor","url":"classes/_zowe_imperative.settingsnotinitialized.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"@zowe/imperative.SettingsNotInitialized"},{"id":3789,"kind":1024,"name":"mDetails","url":"classes/_zowe_imperative.settingsnotinitialized.html#mdetails","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsNotInitialized"},{"id":3790,"kind":262144,"name":"causeErrors","url":"classes/_zowe_imperative.settingsnotinitialized.html#causeerrors","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsNotInitialized"},{"id":3791,"kind":262144,"name":"additionalDetails","url":"classes/_zowe_imperative.settingsnotinitialized.html#additionaldetails","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsNotInitialized"},{"id":3792,"kind":262144,"name":"details","url":"classes/_zowe_imperative.settingsnotinitialized.html#details","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsNotInitialized"},{"id":3793,"kind":262144,"name":"errorCode","url":"classes/_zowe_imperative.settingsnotinitialized.html#errorcode","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsNotInitialized"},{"id":3794,"kind":262144,"name":"suppressDump","url":"classes/_zowe_imperative.settingsnotinitialized.html#suppressdump","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsNotInitialized"},{"id":3795,"kind":262144,"name":"stack","url":"classes/_zowe_imperative.settingsnotinitialized.html#stack","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.SettingsNotInitialized"},{"id":3796,"kind":262144,"name":"message","url":"classes/_zowe_imperative.settingsnotinitialized.html#message","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"@zowe/imperative.SettingsNotInitialized"},{"id":3797,"kind":1024,"name":"name","url":"classes/_zowe_imperative.settingsnotinitialized.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"@zowe/imperative.SettingsNotInitialized"},{"id":3798,"kind":32,"name":"ClipboardJS","url":"modules/_zowe_imperative.html#clipboardjs","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3799,"kind":64,"name":"arrayFrom","url":"modules/_zowe_imperative.html#arrayfrom","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3800,"kind":32,"name":"isInIframe","url":"modules/_zowe_imperative.html#isiniframe","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3801,"kind":32,"name":"links","url":"modules/_zowe_imperative.html#links","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3802,"kind":64,"name":"setTooltip","url":"modules/_zowe_imperative.html#settooltip","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3803,"kind":32,"name":"clipboard","url":"modules/_zowe_imperative.html#clipboard","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3804,"kind":64,"name":"findCurrentCmdAnchor","url":"modules/_zowe_imperative.html#findcurrentcmdanchor","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3805,"kind":256,"name":"ITreeNode","url":"interfaces/_zowe_imperative.itreenode.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3806,"kind":1024,"name":"id","url":"interfaces/_zowe_imperative.itreenode.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ITreeNode"},{"id":3807,"kind":1024,"name":"text","url":"interfaces/_zowe_imperative.itreenode.html#text","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ITreeNode"},{"id":3808,"kind":1024,"name":"children","url":"interfaces/_zowe_imperative.itreenode.html#children","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/imperative.ITreeNode"},{"id":3809,"kind":32,"name":"scrollIntoView","url":"modules/_zowe_imperative.html#scrollintoview","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3810,"kind":32,"name":"headerStr","url":"modules/_zowe_imperative.html#headerstr","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3811,"kind":32,"name":"footerStr","url":"modules/_zowe_imperative.html#footerstr","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3812,"kind":32,"name":"treeNodes","url":"modules/_zowe_imperative.html#treenodes","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3813,"kind":32,"name":"aliasList","url":"modules/_zowe_imperative.html#aliaslist","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3814,"kind":65536,"name":"__type","url":"modules/_zowe_imperative.html#aliaslist.__type-16","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"@zowe/imperative.aliasList"},{"id":3815,"kind":32,"name":"urlParams","url":"modules/_zowe_imperative.html#urlparams","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3816,"kind":32,"name":"currentNodeId","url":"modules/_zowe_imperative.html#currentnodeid","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3817,"kind":32,"name":"currentView","url":"modules/_zowe_imperative.html#currentview","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3818,"kind":32,"name":"searchTimeout","url":"modules/_zowe_imperative.html#searchtimeout","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3819,"kind":64,"name":"flattenNodes","url":"modules/_zowe_imperative.html#flattennodes","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3820,"kind":64,"name":"getJstreeThemeName","url":"modules/_zowe_imperative.html#getjstreethemename","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3821,"kind":64,"name":"permuteSearchStr","url":"modules/_zowe_imperative.html#permutesearchstr","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3822,"kind":64,"name":"updateCurrentNode","url":"modules/_zowe_imperative.html#updatecurrentnode","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3823,"kind":64,"name":"onTreeContextMenu","url":"modules/_zowe_imperative.html#ontreecontextmenu","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3824,"kind":64,"name":"onTreeSearch","url":"modules/_zowe_imperative.html#ontreesearch","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3825,"kind":64,"name":"onTreeLoaded","url":"modules/_zowe_imperative.html#ontreeloaded","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3826,"kind":64,"name":"onTreeSelectionChanged","url":"modules/_zowe_imperative.html#ontreeselectionchanged","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3827,"kind":64,"name":"onSearchTextChanged","url":"modules/_zowe_imperative.html#onsearchtextchanged","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3828,"kind":64,"name":"onDocsPageChanged","url":"modules/_zowe_imperative.html#ondocspagechanged","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3829,"kind":64,"name":"loadTree","url":"modules/_zowe_imperative.html#loadtree","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3830,"kind":64,"name":"toggleTree","url":"modules/_zowe_imperative.html#toggletree","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3831,"kind":64,"name":"changeView","url":"modules/_zowe_imperative.html#changeview","classes":"tsd-kind-function tsd-parent-kind-module","parent":"@zowe/imperative"},{"id":3832,"kind":1,"name":"@zowe/provisioning-for-zowe-sdk","url":"modules/_zowe_provisioning_for_zowe_sdk.html","classes":"tsd-kind-module"},{"id":3833,"kind":128,"name":"ProvisioningConstants","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3834,"kind":1024,"name":"RESOURCE","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html#resource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningConstants"},{"id":3835,"kind":1024,"name":"INSTANCES_RESOURCE","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html#instances_resource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningConstants"},{"id":3836,"kind":1024,"name":"TEMPLATES_RESOURCES","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html#templates_resources","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningConstants"},{"id":3837,"kind":1024,"name":"ACTIONS_RESOURCES","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html#actions_resources","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningConstants"},{"id":3838,"kind":1024,"name":"VARIABLES_RESOURCE","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html#variables_resource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningConstants"},{"id":3839,"kind":1024,"name":"RESOURCE_TYPE","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html#resource_type","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningConstants"},{"id":3840,"kind":1024,"name":"RESOURCE_EXTERNAL_NAME","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html#resource_external_name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningConstants"},{"id":3841,"kind":1024,"name":"RESOURCE_PROVISION_RUN","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html#resource_provision_run","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningConstants"},{"id":3842,"kind":1024,"name":"ZOSMF_VERSION","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html#zosmf_version","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningConstants"},{"id":3843,"kind":2097152,"name":"noSessionProvisioning","url":"modules/_zowe_provisioning_for_zowe_sdk.html#nosessionprovisioning","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3844,"kind":32,"name":"message","url":"modules/_zowe_provisioning_for_zowe_sdk.html#nosessionprovisioning.message-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.noSessionProvisioning"},{"id":3845,"kind":2097152,"name":"noTemplateName","url":"modules/_zowe_provisioning_for_zowe_sdk.html#notemplatename","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3846,"kind":32,"name":"message","url":"modules/_zowe_provisioning_for_zowe_sdk.html#notemplatename.message-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.noTemplateName"},{"id":3847,"kind":2097152,"name":"noAccountInfo","url":"modules/_zowe_provisioning_for_zowe_sdk.html#noaccountinfo","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3848,"kind":32,"name":"message","url":"modules/_zowe_provisioning_for_zowe_sdk.html#noaccountinfo.message","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.noAccountInfo"},{"id":3849,"kind":2097152,"name":"noInstanceId","url":"modules/_zowe_provisioning_for_zowe_sdk.html#noinstanceid","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3850,"kind":32,"name":"message","url":"modules/_zowe_provisioning_for_zowe_sdk.html#noinstanceid.message-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.noInstanceId"},{"id":3851,"kind":2097152,"name":"noActionName","url":"modules/_zowe_provisioning_for_zowe_sdk.html#noactionname","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3852,"kind":32,"name":"message","url":"modules/_zowe_provisioning_for_zowe_sdk.html#noactionname.message-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.noActionName"},{"id":3853,"kind":128,"name":"ProvisioningValidator","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningvalidator.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3854,"kind":2048,"name":"validateSession","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningvalidator.html#validatesession","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningValidator"},{"id":3855,"kind":2048,"name":"validateString","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningvalidator.html#validatestring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningValidator"},{"id":3856,"kind":2048,"name":"validateNotEmptyString","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningvalidator.html#validatenotemptystring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningValidator"},{"id":3857,"kind":128,"name":"DeleteInstance","url":"classes/_zowe_provisioning_for_zowe_sdk.deleteinstance.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3858,"kind":2048,"name":"deleteDeprovisionedInstance","url":"classes/_zowe_provisioning_for_zowe_sdk.deleteinstance.html#deletedeprovisionedinstance","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.DeleteInstance"},{"id":3859,"kind":256,"name":"IPublishedTemplate","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3860,"kind":1024,"name":"name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplate"},{"id":3861,"kind":1024,"name":"version","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplate"},{"id":3862,"kind":1024,"name":"owner","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplate"},{"id":3863,"kind":1024,"name":"state","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html#state","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplate"},{"id":3864,"kind":1024,"name":"description","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplate"},{"id":3865,"kind":1024,"name":"generated-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html#generated_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplate"},{"id":3866,"kind":1024,"name":"object-id","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html#object_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplate"},{"id":3867,"kind":1024,"name":"domain-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html#domain_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplate"},{"id":3868,"kind":1024,"name":"software-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html#software_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplate"},{"id":3869,"kind":2097152,"name":"explainPublishedTemplateSummary","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatesummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3870,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatesummary.explainedparentkey-19","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplateSummary"},{"id":3871,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatesummary.ignoredkeys-19","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplateSummary"},{"id":3872,"kind":2097152,"name":"explainPublishedTemplateFull","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatefull","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3873,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatefull.explainedparentkey-16","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplateFull"},{"id":3874,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatefull.ignoredkeys-16","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplateFull"},{"id":3875,"kind":256,"name":"IPublishedTemplates","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplates.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3876,"kind":1024,"name":"psc-list","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplates.html#psc_list","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplates"},{"id":3877,"kind":2097152,"name":"explainPublishedTemplatesSummary","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatessummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3878,"kind":32,"name":"psc-list","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatessummary.psc_list-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplatesSummary"},{"id":3879,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatessummary.explainedparentkey-21","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplatesSummary"},{"id":3880,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatessummary.ignoredkeys-21","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplatesSummary"},{"id":3881,"kind":2097152,"name":"explainPublishedTemplatesFull","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatesfull","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3882,"kind":32,"name":"psc-list","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatesfull.psc_list","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplatesFull"},{"id":3883,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatesfull.explainedparentkey-20","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplatesFull"},{"id":3884,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplatesfull.ignoredkeys-20","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplatesFull"},{"id":3885,"kind":128,"name":"ListCatalogTemplates","url":"classes/_zowe_provisioning_for_zowe_sdk.listcatalogtemplates.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3886,"kind":2048,"name":"listCatalogCommon","url":"classes/_zowe_provisioning_for_zowe_sdk.listcatalogtemplates.html#listcatalogcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ListCatalogTemplates"},{"id":3887,"kind":256,"name":"IProvisionedInstanceVariable","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariable.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3888,"kind":1024,"name":"name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariable.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceVariable"},{"id":3889,"kind":1024,"name":"value","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariable.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceVariable"},{"id":3890,"kind":1024,"name":"visibility","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariable.html#visibility","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceVariable"},{"id":3891,"kind":1024,"name":"update-registry","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariable.html#update_registry","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceVariable"},{"id":3892,"kind":2097152,"name":"explainProvisionedInstanceVariable","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancevariable","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3893,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancevariable.explainedparentkey-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceVariable"},{"id":3894,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancevariable.ignoredkeys-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceVariable"},{"id":3895,"kind":2097152,"name":"explainPromptVariable","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpromptvariable","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3896,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpromptvariable.explainedparentkey-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPromptVariable"},{"id":3897,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpromptvariable.ignoredkeys-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPromptVariable"},{"id":3898,"kind":2097152,"name":"explainAtCreateVariable","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainatcreatevariable","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3899,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainatcreatevariable.explainedparentkey-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainAtCreateVariable"},{"id":3900,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainatcreatevariable.ignoredkeys-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainAtCreateVariable"},{"id":3901,"kind":256,"name":"IProvisionedInstanceActions","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3902,"kind":1024,"name":"name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3903,"kind":1024,"name":"type","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3904,"kind":1024,"name":"command","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#command","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3905,"kind":1024,"name":"instructions","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#instructions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3906,"kind":1024,"name":"is-deprovision","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#is_deprovision","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3907,"kind":1024,"name":"command-run-as-user","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#command_run_as_user","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3908,"kind":1024,"name":"command-sol-key","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#command_sol_key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3909,"kind":1024,"name":"command-unsol-key","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#command_unsol_key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3910,"kind":1024,"name":"command-detect-time","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#command_detect_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3911,"kind":1024,"name":"workflow-definition-file","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#workflow_definition_file","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3912,"kind":1024,"name":"workflow-variable-input-file","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#workflow_variable_input_file","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3913,"kind":1024,"name":"workflow-clean-after-complete","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#workflow_clean_after_complete","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3914,"kind":1024,"name":"variables","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#variables","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3915,"kind":1024,"name":"prompt-variables","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#prompt_variables","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3916,"kind":1024,"name":"at-create-variables","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html#at_create_variables","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceActions"},{"id":3917,"kind":2097152,"name":"explainProvisionedInstanceActionsFull","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceactionsfull","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3918,"kind":32,"name":"variables","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceactionsfull.variables","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceActionsFull"},{"id":3919,"kind":32,"name":"prompt-variables","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceactionsfull.prompt_variables","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceActionsFull"},{"id":3920,"kind":32,"name":"at-create-variables","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceactionsfull.at_create_variables","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceActionsFull"},{"id":3921,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceactionsfull.explainedparentkey-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceActionsFull"},{"id":3922,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceactionsfull.ignoredkeys-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceActionsFull"},{"id":3923,"kind":2097152,"name":"explainProvisionedInstanceActionsSummary","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceactionssummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3924,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceactionssummary.explainedparentkey-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceActionsSummary"},{"id":3925,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceactionssummary.ignoredkeys-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceActionsSummary"},{"id":3926,"kind":256,"name":"IProvisionedInstance","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3927,"kind":1024,"name":"type","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3928,"kind":1024,"name":"system","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#system","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3929,"kind":1024,"name":"sysplex","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#sysplex","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3930,"kind":1024,"name":"vendor","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#vendor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3931,"kind":1024,"name":"version","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3932,"kind":1024,"name":"description","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3933,"kind":1024,"name":"owner","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3934,"kind":1024,"name":"provider","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#provider","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3935,"kind":1024,"name":"state","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#state","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3936,"kind":1024,"name":"ssin","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#ssin","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3937,"kind":1024,"name":"email","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#email","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3938,"kind":1024,"name":"object-id","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#object_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3939,"kind":1024,"name":"object-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#object_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3940,"kind":1024,"name":"object-uri","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#object_uri","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3941,"kind":1024,"name":"registry-type","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#registry_type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3942,"kind":1024,"name":"external-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#external_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3943,"kind":1024,"name":"system-nickname","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#system_nickname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3944,"kind":1024,"name":"catalog-object-id","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#catalog_object_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3945,"kind":1024,"name":"catalog-object-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#catalog_object_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3946,"kind":1024,"name":"workflow-key","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#workflow_key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3947,"kind":1024,"name":"workflow-clean-after-provisioned","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#workflow_clean_after_provisioned","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3948,"kind":1024,"name":"jobs-disposition","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#jobs_disposition","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3949,"kind":1024,"name":"created-time","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#created_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3950,"kind":1024,"name":"last-modified-time","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#last_modified_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3951,"kind":1024,"name":"created-by-user","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#created_by_user","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3952,"kind":1024,"name":"last-modified-by-user","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#last_modified_by_user","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3953,"kind":1024,"name":"last-action-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#last_action_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3954,"kind":1024,"name":"last-action-object-id","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#last_action_object_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3955,"kind":1024,"name":"last-action-state","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#last_action_state","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3956,"kind":1024,"name":"user-data","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#user_data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3957,"kind":1024,"name":"user-data-id","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#user_data_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3958,"kind":1024,"name":"tenant-id","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#tenant_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3959,"kind":1024,"name":"tenant-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#tenant_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3960,"kind":1024,"name":"domain-id","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#domain_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3961,"kind":1024,"name":"domain-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#domain_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3962,"kind":1024,"name":"job-statement","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#job_statement","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3963,"kind":1024,"name":"account-info","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#account_info","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3964,"kind":1024,"name":"runAsUser-audit","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#runasuser_audit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3965,"kind":1024,"name":"workflow-start-time","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#workflow_start_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3966,"kind":1024,"name":"workflow-stop-time","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#workflow_stop_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3967,"kind":1024,"name":"variables","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#variables","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3968,"kind":1024,"name":"actions","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html#actions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstance"},{"id":3969,"kind":2097152,"name":"explainProvisionedInstanceSummary","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3970,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesummary.ignoredkeys-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceSummary"},{"id":3971,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesummary.explainedparentkey-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceSummary"},{"id":3972,"kind":2097152,"name":"explainProvisionedInstanceSummaryWithVars","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesummarywithvars","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3973,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesummarywithvars.explainedparentkey-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceSummaryWithVars"},{"id":3974,"kind":32,"name":"variables","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesummarywithvars.variables-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceSummaryWithVars"},{"id":3975,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesummarywithvars.ignoredkeys-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceSummaryWithVars"},{"id":3976,"kind":2097152,"name":"explainProvisionedInstanceSummaryWithActions","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesummarywithactions","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3977,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesummarywithactions.explainedparentkey-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceSummaryWithActions"},{"id":3978,"kind":32,"name":"actions","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesummarywithactions.actions-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceSummaryWithActions"},{"id":3979,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesummarywithactions.ignoredkeys-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceSummaryWithActions"},{"id":3980,"kind":2097152,"name":"explainProvisionedInstanceExtended","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceextended","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3981,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceextended.explainedparentkey-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceExtended"},{"id":3982,"kind":32,"name":"actions","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceextended.actions","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceExtended"},{"id":3983,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstanceextended.ignoredkeys-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceExtended"},{"id":3984,"kind":2097152,"name":"explainProvisionedInstanceFull","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancefull","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3985,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancefull.explainedparentkey-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceFull"},{"id":3986,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancefull.ignoredkeys-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceFull"},{"id":3987,"kind":32,"name":"variables","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancefull.variables-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceFull"},{"id":3988,"kind":32,"name":"actions","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancefull.actions-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstanceFull"},{"id":3989,"kind":128,"name":"ListInstanceInfo","url":"classes/_zowe_provisioning_for_zowe_sdk.listinstanceinfo.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3990,"kind":2048,"name":"listInstanceCommon","url":"classes/_zowe_provisioning_for_zowe_sdk.listinstanceinfo.html#listinstancecommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ListInstanceInfo"},{"id":3991,"kind":256,"name":"IProvisionedInstanceVariables","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariables.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3992,"kind":1024,"name":"variables","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariables.html#variables","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstanceVariables"},{"id":3993,"kind":128,"name":"ListInstanceVariables","url":"classes/_zowe_provisioning_for_zowe_sdk.listinstancevariables.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3994,"kind":2048,"name":"listVariablesCommon","url":"classes/_zowe_provisioning_for_zowe_sdk.listinstancevariables.html#listvariablescommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ListInstanceVariables"},{"id":3995,"kind":2048,"name":"getResourcesQuery","url":"classes/_zowe_provisioning_for_zowe_sdk.listinstancevariables.html#getresourcesquery","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ListInstanceVariables"},{"id":3996,"kind":256,"name":"IProvisionedInstances","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstances.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3997,"kind":1024,"name":"scr-list","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstances.html#scr_list","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionedInstances"},{"id":3998,"kind":2097152,"name":"explainProvisionedInstancesSummary","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancessummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":3999,"kind":32,"name":"scr-list","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancessummary.scr_list-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstancesSummary"},{"id":4000,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancessummary.explainedparentkey-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstancesSummary"},{"id":4001,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancessummary.ignoredkeys-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstancesSummary"},{"id":4002,"kind":2097152,"name":"explainProvisionedInstancesFull","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesfull","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4003,"kind":32,"name":"scr-list","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesfull.scr_list","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstancesFull"},{"id":4004,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesfull.explainedparentkey-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstancesFull"},{"id":4005,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisionedinstancesfull.ignoredkeys-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionedInstancesFull"},{"id":4006,"kind":128,"name":"ListRegistryInstances","url":"classes/_zowe_provisioning_for_zowe_sdk.listregistryinstances.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4007,"kind":2048,"name":"listRegistryCommon","url":"classes/_zowe_provisioning_for_zowe_sdk.listregistryinstances.html#listregistrycommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ListRegistryInstances"},{"id":4008,"kind":2048,"name":"listFilteredRegistry","url":"classes/_zowe_provisioning_for_zowe_sdk.listregistryinstances.html#listfilteredregistry","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ListRegistryInstances"},{"id":4009,"kind":2048,"name":"getResourcesQuery","url":"classes/_zowe_provisioning_for_zowe_sdk.listregistryinstances.html#getresourcesquery","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ListRegistryInstances"},{"id":4010,"kind":256,"name":"IPromptVariable","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4011,"kind":1024,"name":"name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4012,"kind":1024,"name":"value","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4013,"kind":1024,"name":"required","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#required","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4014,"kind":1024,"name":"label","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#label","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4015,"kind":1024,"name":"description","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4016,"kind":1024,"name":"abstract","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#abstract","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4017,"kind":1024,"name":"type","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4018,"kind":1024,"name":"must-be-choice","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#must_be_choice","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4019,"kind":1024,"name":"choices","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#choices","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4020,"kind":1024,"name":"regex","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#regex","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4021,"kind":1024,"name":"multi-line","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#multi_line","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4022,"kind":1024,"name":"min","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#min","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4023,"kind":1024,"name":"max","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#max","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4024,"kind":1024,"name":"places","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#places","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4025,"kind":1024,"name":"error-message","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPromptVariable"},{"id":4026,"kind":2097152,"name":"explainPromptVariableSummary","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpromptvariablesummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4027,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpromptvariablesummary.ignoredkeys-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPromptVariableSummary"},{"id":4028,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpromptvariablesummary.explainedparentkey-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPromptVariableSummary"},{"id":4029,"kind":2097152,"name":"explainPromptVariableFull","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpromptvariablefull","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4030,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpromptvariablefull.ignoredkeys-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPromptVariableFull"},{"id":4031,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpromptvariablefull.explainedparentkey-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPromptVariableFull"},{"id":4032,"kind":256,"name":"IPublishedTemplateInfo","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4033,"kind":1024,"name":"name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplateInfo"},{"id":4034,"kind":1024,"name":"version","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplateInfo"},{"id":4035,"kind":1024,"name":"owner","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplateInfo"},{"id":4036,"kind":1024,"name":"state","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html#state","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplateInfo"},{"id":4037,"kind":1024,"name":"description","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplateInfo"},{"id":4038,"kind":1024,"name":"generated-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html#generated_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplateInfo"},{"id":4039,"kind":1024,"name":"object-id","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html#object_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplateInfo"},{"id":4040,"kind":1024,"name":"domain-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html#domain_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplateInfo"},{"id":4041,"kind":1024,"name":"software-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html#software_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplateInfo"},{"id":4042,"kind":1024,"name":"prompt-variables","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html#prompt_variables","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPublishedTemplateInfo"},{"id":4043,"kind":2097152,"name":"explainPublishedTemplateInfoSummary","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplateinfosummary","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4044,"kind":32,"name":"prompt-variables","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplateinfosummary.prompt_variables-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplateInfoSummary"},{"id":4045,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplateinfosummary.ignoredkeys-18","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplateInfoSummary"},{"id":4046,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplateinfosummary.explainedparentkey-18","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplateInfoSummary"},{"id":4047,"kind":2097152,"name":"explainPublishedTemplateInfoFull","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplateinfofull","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4048,"kind":32,"name":"prompt-variables","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplateinfofull.prompt_variables-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplateInfoFull"},{"id":4049,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplateinfofull.ignoredkeys-17","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplateInfoFull"},{"id":4050,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainpublishedtemplateinfofull.explainedparentkey-17","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainPublishedTemplateInfoFull"},{"id":4051,"kind":128,"name":"ListTemplateInfo","url":"classes/_zowe_provisioning_for_zowe_sdk.listtemplateinfo.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4052,"kind":2048,"name":"listTemplateCommon","url":"classes/_zowe_provisioning_for_zowe_sdk.listtemplateinfo.html#listtemplatecommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ListTemplateInfo"},{"id":4053,"kind":2048,"name":"getResourcesQuery","url":"classes/_zowe_provisioning_for_zowe_sdk.listtemplateinfo.html#getresourcesquery","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ListTemplateInfo"},{"id":4054,"kind":256,"name":"IPerformActionResponse","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iperformactionresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4055,"kind":1024,"name":"action-id","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iperformactionresponse.html#action_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPerformActionResponse"},{"id":4056,"kind":1024,"name":"action-uri","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iperformactionresponse.html#action_uri","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPerformActionResponse"},{"id":4057,"kind":2097152,"name":"explainActionResponse","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainactionresponse","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4058,"kind":32,"name":"action-id","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainactionresponse.action_id","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainActionResponse"},{"id":4059,"kind":32,"name":"action-uri","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainactionresponse.action_uri","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainActionResponse"},{"id":4060,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainactionresponse.explainedparentkey","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainActionResponse"},{"id":4061,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainactionresponse.ignoredkeys","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainActionResponse"},{"id":4062,"kind":128,"name":"PerformAction","url":"classes/_zowe_provisioning_for_zowe_sdk.performaction.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4063,"kind":2048,"name":"doProvisioningActionCommon","url":"classes/_zowe_provisioning_for_zowe_sdk.performaction.html#doprovisioningactioncommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.PerformAction"},{"id":4064,"kind":2048,"name":"getResourcesQuery","url":"classes/_zowe_provisioning_for_zowe_sdk.performaction.html#getresourcesquery","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.PerformAction"},{"id":4065,"kind":256,"name":"ITemplateRegistryInfo","url":"interfaces/_zowe_provisioning_for_zowe_sdk.itemplateregistryinfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4066,"kind":1024,"name":"object-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.itemplateregistryinfo.html#object_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.ITemplateRegistryInfo"},{"id":4067,"kind":1024,"name":"object-id","url":"interfaces/_zowe_provisioning_for_zowe_sdk.itemplateregistryinfo.html#object_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.ITemplateRegistryInfo"},{"id":4068,"kind":1024,"name":"object-uri","url":"interfaces/_zowe_provisioning_for_zowe_sdk.itemplateregistryinfo.html#object_uri","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.ITemplateRegistryInfo"},{"id":4069,"kind":1024,"name":"external-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.itemplateregistryinfo.html#external_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.ITemplateRegistryInfo"},{"id":4070,"kind":1024,"name":"system-nickname","url":"interfaces/_zowe_provisioning_for_zowe_sdk.itemplateregistryinfo.html#system_nickname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.ITemplateRegistryInfo"},{"id":4071,"kind":2097152,"name":"explainTemplateRegistryInfoResponse","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateregistryinforesponse","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4072,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateregistryinforesponse.explainedparentkey-22","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainTemplateRegistryInfoResponse"},{"id":4073,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateregistryinforesponse.ignoredkeys-22","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainTemplateRegistryInfoResponse"},{"id":4074,"kind":32,"name":"external-name","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateregistryinforesponse.external_name","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainTemplateRegistryInfoResponse"},{"id":4075,"kind":32,"name":"object-id","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateregistryinforesponse.object_id","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainTemplateRegistryInfoResponse"},{"id":4076,"kind":256,"name":"ITemplateWorkflowInfo","url":"interfaces/_zowe_provisioning_for_zowe_sdk.itemplateworkflowinfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4077,"kind":1024,"name":"workflowKey","url":"interfaces/_zowe_provisioning_for_zowe_sdk.itemplateworkflowinfo.html#workflowkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.ITemplateWorkflowInfo"},{"id":4078,"kind":1024,"name":"workflowDescription","url":"interfaces/_zowe_provisioning_for_zowe_sdk.itemplateworkflowinfo.html#workflowdescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.ITemplateWorkflowInfo"},{"id":4079,"kind":1024,"name":"workflowID","url":"interfaces/_zowe_provisioning_for_zowe_sdk.itemplateworkflowinfo.html#workflowid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.ITemplateWorkflowInfo"},{"id":4080,"kind":1024,"name":"workflowVersion","url":"interfaces/_zowe_provisioning_for_zowe_sdk.itemplateworkflowinfo.html#workflowversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.ITemplateWorkflowInfo"},{"id":4081,"kind":1024,"name":"vendor","url":"interfaces/_zowe_provisioning_for_zowe_sdk.itemplateworkflowinfo.html#vendor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.ITemplateWorkflowInfo"},{"id":4082,"kind":2097152,"name":"explainTemplateWorkflowInfoResponse","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateworkflowinforesponse","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4083,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateworkflowinforesponse.explainedparentkey-23","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainTemplateWorkflowInfoResponse"},{"id":4084,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateworkflowinforesponse.ignoredkeys-23","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainTemplateWorkflowInfoResponse"},{"id":4085,"kind":32,"name":"workflowKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateworkflowinforesponse.workflowkey","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainTemplateWorkflowInfoResponse"},{"id":4086,"kind":32,"name":"workflowDescription","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateworkflowinforesponse.workflowdescription","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainTemplateWorkflowInfoResponse"},{"id":4087,"kind":32,"name":"workflowID","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateworkflowinforesponse.workflowid","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainTemplateWorkflowInfoResponse"},{"id":4088,"kind":32,"name":"workflowVersion","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateworkflowinforesponse.workflowversion","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainTemplateWorkflowInfoResponse"},{"id":4089,"kind":32,"name":"vendor","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explaintemplateworkflowinforesponse.vendor","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainTemplateWorkflowInfoResponse"},{"id":4090,"kind":256,"name":"IProvisionTemplateResponse","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisiontemplateresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4091,"kind":1024,"name":"system-nickname","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisiontemplateresponse.html#system_nickname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionTemplateResponse"},{"id":4092,"kind":1024,"name":"registry-info","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisiontemplateresponse.html#registry_info","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionTemplateResponse"},{"id":4093,"kind":1024,"name":"workflow-info","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisiontemplateresponse.html#workflow_info","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionTemplateResponse"},{"id":4094,"kind":2097152,"name":"explainProvisionTemplateResponse","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisiontemplateresponse","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4095,"kind":32,"name":"system-nickname","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisiontemplateresponse.system_nickname","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionTemplateResponse"},{"id":4096,"kind":32,"name":"explainedParentKey","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisiontemplateresponse.explainedparentkey-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionTemplateResponse"},{"id":4097,"kind":32,"name":"ignoredKeys","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisiontemplateresponse.ignoredkeys-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionTemplateResponse"},{"id":4098,"kind":32,"name":"registry-info","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisiontemplateresponse.registry_info","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionTemplateResponse"},{"id":4099,"kind":32,"name":"workflow-info","url":"modules/_zowe_provisioning_for_zowe_sdk.html#explainprovisiontemplateresponse.workflow_info","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/provisioning-for-zowe-sdk.explainProvisionTemplateResponse"},{"id":4100,"kind":256,"name":"IPropertiesInput","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipropertiesinput.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4101,"kind":1024,"name":"name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipropertiesinput.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPropertiesInput"},{"id":4102,"kind":1024,"name":"value","url":"interfaces/_zowe_provisioning_for_zowe_sdk.ipropertiesinput.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IPropertiesInput"},{"id":4103,"kind":256,"name":"IProvisionOptionals","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionoptionals.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4104,"kind":1024,"name":"input-variables","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionoptionals.html#input_variables","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionOptionals"},{"id":4105,"kind":1024,"name":"domain-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionoptionals.html#domain_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionOptionals"},{"id":4106,"kind":1024,"name":"tenant-name","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionoptionals.html#tenant_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionOptionals"},{"id":4107,"kind":1024,"name":"user-data-id","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionoptionals.html#user_data_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionOptionals"},{"id":4108,"kind":1024,"name":"account-info","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionoptionals.html#account_info","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionOptionals"},{"id":4109,"kind":1024,"name":"user-data","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionoptionals.html#user_data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionOptionals"},{"id":4110,"kind":1024,"name":"systems-nicknames","url":"interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionoptionals.html#systems_nicknames","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/provisioning-for-zowe-sdk.IProvisionOptionals"},{"id":4111,"kind":128,"name":"ProvisionPublishedTemplate","url":"classes/_zowe_provisioning_for_zowe_sdk.provisionpublishedtemplate.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4112,"kind":2048,"name":"provisionTemplateCommon","url":"classes/_zowe_provisioning_for_zowe_sdk.provisionpublishedtemplate.html#provisiontemplatecommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisionPublishedTemplate"},{"id":4113,"kind":2048,"name":"provisionTemplate","url":"classes/_zowe_provisioning_for_zowe_sdk.provisionpublishedtemplate.html#provisiontemplate","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisionPublishedTemplate"},{"id":4114,"kind":128,"name":"ProvisioningService","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningservice.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/provisioning-for-zowe-sdk"},{"id":4115,"kind":2048,"name":"parseProperties","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningservice.html#parseproperties","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningService"},{"id":4116,"kind":2048,"name":"readPropertiesFromYamlFile","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningservice.html#readpropertiesfromyamlfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningService"},{"id":4117,"kind":2048,"name":"checkForPassedOptionalParms","url":"classes/_zowe_provisioning_for_zowe_sdk.provisioningservice.html#checkforpassedoptionalparms","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/provisioning-for-zowe-sdk.ProvisioningService"},{"id":4118,"kind":1,"name":"@zowe/zos-console-for-zowe-sdk","url":"modules/_zowe_zos_console_for_zowe_sdk.html","classes":"tsd-kind-module"},{"id":4119,"kind":256,"name":"IZosmfCollectResponse","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfcollectresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4120,"kind":1024,"name":"cmd-response","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfcollectresponse.html#cmd_response","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IZosmfCollectResponse"},{"id":4121,"kind":1024,"name":"sol-key-detected","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfcollectresponse.html#sol_key_detected","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IZosmfCollectResponse"},{"id":4122,"kind":256,"name":"IZosmfIssueParms","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4123,"kind":1024,"name":"cmd","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueparms.html#cmd","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IZosmfIssueParms"},{"id":4124,"kind":1024,"name":"sol-key","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueparms.html#sol_key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IZosmfIssueParms"},{"id":4125,"kind":1024,"name":"system","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueparms.html#system","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IZosmfIssueParms"},{"id":4126,"kind":1024,"name":"async","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueparms.html#async","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IZosmfIssueParms"},{"id":4127,"kind":256,"name":"IZosmfIssueResponse","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4128,"kind":1024,"name":"cmd-response-url","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueresponse.html#cmd_response_url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IZosmfIssueResponse"},{"id":4129,"kind":1024,"name":"cmd-response","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueresponse.html#cmd_response","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IZosmfIssueResponse"},{"id":4130,"kind":1024,"name":"cmd-response-uri","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueresponse.html#cmd_response_uri","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IZosmfIssueResponse"},{"id":4131,"kind":1024,"name":"cmd-response-key","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueresponse.html#cmd_response_key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IZosmfIssueResponse"},{"id":4132,"kind":1024,"name":"sol-key-detected","url":"interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueresponse.html#sol_key_detected","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IZosmfIssueResponse"},{"id":4133,"kind":256,"name":"IConsoleParms","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4134,"kind":1024,"name":"consoleName","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleparms.html#consolename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IConsoleParms"},{"id":4135,"kind":1024,"name":"processResponses","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleparms.html#processresponses","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IConsoleParms"},{"id":4136,"kind":256,"name":"ICollectParms","url":"interfaces/_zowe_zos_console_for_zowe_sdk.icollectparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4137,"kind":1024,"name":"commandResponseKey","url":"interfaces/_zowe_zos_console_for_zowe_sdk.icollectparms.html#commandresponsekey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.ICollectParms"},{"id":4138,"kind":1024,"name":"waitToCollect","url":"interfaces/_zowe_zos_console_for_zowe_sdk.icollectparms.html#waittocollect","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.ICollectParms"},{"id":4139,"kind":1024,"name":"followUpAttempts","url":"interfaces/_zowe_zos_console_for_zowe_sdk.icollectparms.html#followupattempts","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.ICollectParms"},{"id":4140,"kind":1024,"name":"consoleName","url":"interfaces/_zowe_zos_console_for_zowe_sdk.icollectparms.html#consolename","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-console-for-zowe-sdk.ICollectParms"},{"id":4141,"kind":1024,"name":"processResponses","url":"interfaces/_zowe_zos_console_for_zowe_sdk.icollectparms.html#processresponses","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-console-for-zowe-sdk.ICollectParms"},{"id":4142,"kind":256,"name":"IConsoleResponse","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4143,"kind":1024,"name":"success","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleresponse.html#success","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IConsoleResponse"},{"id":4144,"kind":1024,"name":"zosmfResponse","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleresponse.html#zosmfresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IConsoleResponse"},{"id":4145,"kind":1024,"name":"failureResponse","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleresponse.html#failureresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IConsoleResponse"},{"id":4146,"kind":1024,"name":"commandResponse","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleresponse.html#commandresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IConsoleResponse"},{"id":4147,"kind":1024,"name":"lastResponseKey","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleresponse.html#lastresponsekey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IConsoleResponse"},{"id":4148,"kind":1024,"name":"keywordDetected","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleresponse.html#keyworddetected","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IConsoleResponse"},{"id":4149,"kind":1024,"name":"cmdResponseUrl","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleresponse.html#cmdresponseurl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IConsoleResponse"},{"id":4150,"kind":256,"name":"IIssueParms","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iissueparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4151,"kind":1024,"name":"command","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iissueparms.html#command","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IIssueParms"},{"id":4152,"kind":1024,"name":"sysplexSystem","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iissueparms.html#sysplexsystem","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IIssueParms"},{"id":4153,"kind":1024,"name":"solicitedKeyword","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iissueparms.html#solicitedkeyword","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IIssueParms"},{"id":4154,"kind":1024,"name":"async","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iissueparms.html#async","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-console-for-zowe-sdk.IIssueParms"},{"id":4155,"kind":1024,"name":"consoleName","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iissueparms.html#consolename","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-console-for-zowe-sdk.IIssueParms"},{"id":4156,"kind":1024,"name":"processResponses","url":"interfaces/_zowe_zos_console_for_zowe_sdk.iissueparms.html#processresponses","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-console-for-zowe-sdk.IIssueParms"},{"id":4157,"kind":4194304,"name":"ConsoleResponse","url":"modules/_zowe_zos_console_for_zowe_sdk.html#consoleresponse","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4158,"kind":65536,"name":"__type","url":"modules/_zowe_zos_console_for_zowe_sdk.html#consoleresponse.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleResponse"},{"id":4159,"kind":128,"name":"ConsoleConstants","url":"classes/_zowe_zos_console_for_zowe_sdk.consoleconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4160,"kind":1024,"name":"CLASS","url":"classes/_zowe_zos_console_for_zowe_sdk.consoleconstants.html#class","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleConstants"},{"id":4161,"kind":1024,"name":"RESOURCE","url":"classes/_zowe_zos_console_for_zowe_sdk.consoleconstants.html#resource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleConstants"},{"id":4162,"kind":1024,"name":"RES_DEF_CN","url":"classes/_zowe_zos_console_for_zowe_sdk.consoleconstants.html#res_def_cn","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleConstants"},{"id":4163,"kind":1024,"name":"SOL_MSGS","url":"classes/_zowe_zos_console_for_zowe_sdk.consoleconstants.html#sol_msgs","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleConstants"},{"id":4164,"kind":1024,"name":"DEFAULT_FOLLOWUP_ATTEMPTS","url":"classes/_zowe_zos_console_for_zowe_sdk.consoleconstants.html#default_followup_attempts","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleConstants"},{"id":4165,"kind":1024,"name":"DEFAULT_TIMEOUT","url":"classes/_zowe_zos_console_for_zowe_sdk.consoleconstants.html#default_timeout","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleConstants"},{"id":4166,"kind":2097152,"name":"displayResponse","url":"modules/_zowe_zos_console_for_zowe_sdk.html#displayresponse","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4167,"kind":32,"name":"message","url":"modules/_zowe_zos_console_for_zowe_sdk.html#displayresponse.message-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-console-for-zowe-sdk.displayResponse"},{"id":4168,"kind":2097152,"name":"displayError","url":"modules/_zowe_zos_console_for_zowe_sdk.html#displayerror","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4169,"kind":32,"name":"message","url":"modules/_zowe_zos_console_for_zowe_sdk.html#displayerror.message-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-console-for-zowe-sdk.displayError"},{"id":4170,"kind":2097152,"name":"displayCollectResponse","url":"modules/_zowe_zos_console_for_zowe_sdk.html#displaycollectresponse","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4171,"kind":32,"name":"message","url":"modules/_zowe_zos_console_for_zowe_sdk.html#displaycollectresponse.message-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-console-for-zowe-sdk.displayCollectResponse"},{"id":4172,"kind":2097152,"name":"displayCollectError","url":"modules/_zowe_zos_console_for_zowe_sdk.html#displaycollecterror","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4173,"kind":32,"name":"message","url":"modules/_zowe_zos_console_for_zowe_sdk.html#displaycollecterror.message-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-console-for-zowe-sdk.displayCollectError"},{"id":4174,"kind":2097152,"name":"decreaseCounter","url":"modules/_zowe_zos_console_for_zowe_sdk.html#decreasecounter","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4175,"kind":32,"name":"message","url":"modules/_zowe_zos_console_for_zowe_sdk.html#decreasecounter.message-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-console-for-zowe-sdk.decreaseCounter"},{"id":4176,"kind":2097152,"name":"resetCounter","url":"modules/_zowe_zos_console_for_zowe_sdk.html#resetcounter","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4177,"kind":32,"name":"message","url":"modules/_zowe_zos_console_for_zowe_sdk.html#resetcounter.message-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-console-for-zowe-sdk.resetCounter"},{"id":4178,"kind":2097152,"name":"noZosmfInput","url":"modules/_zowe_zos_console_for_zowe_sdk.html#nozosmfinput","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4179,"kind":32,"name":"message","url":"modules/_zowe_zos_console_for_zowe_sdk.html#nozosmfinput.message-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-console-for-zowe-sdk.noZosmfInput"},{"id":4180,"kind":2097152,"name":"noConsoleInput","url":"modules/_zowe_zos_console_for_zowe_sdk.html#noconsoleinput","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4181,"kind":32,"name":"message","url":"modules/_zowe_zos_console_for_zowe_sdk.html#noconsoleinput.message-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-console-for-zowe-sdk.noConsoleInput"},{"id":4182,"kind":2097152,"name":"noConsoleName","url":"modules/_zowe_zos_console_for_zowe_sdk.html#noconsolename","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4183,"kind":32,"name":"message","url":"modules/_zowe_zos_console_for_zowe_sdk.html#noconsolename.message-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-console-for-zowe-sdk.noConsoleName"},{"id":4184,"kind":2097152,"name":"noCommandKey","url":"modules/_zowe_zos_console_for_zowe_sdk.html#nocommandkey","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4185,"kind":32,"name":"message","url":"modules/_zowe_zos_console_for_zowe_sdk.html#nocommandkey.message-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-console-for-zowe-sdk.noCommandKey"},{"id":4186,"kind":2097152,"name":"noCollectParameters","url":"modules/_zowe_zos_console_for_zowe_sdk.html#nocollectparameters","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4187,"kind":32,"name":"message","url":"modules/_zowe_zos_console_for_zowe_sdk.html#nocollectparameters.message-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-console-for-zowe-sdk.noCollectParameters"},{"id":4188,"kind":2097152,"name":"collectProcessingDetails","url":"modules/_zowe_zos_console_for_zowe_sdk.html#collectprocessingdetails","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4189,"kind":32,"name":"message","url":"modules/_zowe_zos_console_for_zowe_sdk.html#collectprocessingdetails.message","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-console-for-zowe-sdk.collectProcessingDetails"},{"id":4190,"kind":128,"name":"ConsoleResponseService","url":"classes/_zowe_zos_console_for_zowe_sdk.consoleresponseservice.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4191,"kind":2048,"name":"populate","url":"classes/_zowe_zos_console_for_zowe_sdk.consoleresponseservice.html#populate","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleResponseService"},{"id":4192,"kind":2048,"name":"populateError","url":"classes/_zowe_zos_console_for_zowe_sdk.consoleresponseservice.html#populateerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleResponseService"},{"id":4193,"kind":2048,"name":"getEmptyConsoleResponse","url":"classes/_zowe_zos_console_for_zowe_sdk.consoleresponseservice.html#getemptyconsoleresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleResponseService"},{"id":4194,"kind":2048,"name":"isLastZosmfResponseEmpty","url":"classes/_zowe_zos_console_for_zowe_sdk.consoleresponseservice.html#islastzosmfresponseempty","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleResponseService"},{"id":4195,"kind":128,"name":"IssueCommand","url":"classes/_zowe_zos_console_for_zowe_sdk.issuecommand.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4196,"kind":2048,"name":"issueCommon","url":"classes/_zowe_zos_console_for_zowe_sdk.issuecommand.html#issuecommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.IssueCommand"},{"id":4197,"kind":2048,"name":"issueDefConsoleCommon","url":"classes/_zowe_zos_console_for_zowe_sdk.issuecommand.html#issuedefconsolecommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.IssueCommand"},{"id":4198,"kind":2048,"name":"issue","url":"classes/_zowe_zos_console_for_zowe_sdk.issuecommand.html#issue","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.IssueCommand"},{"id":4199,"kind":2048,"name":"issueSimple","url":"classes/_zowe_zos_console_for_zowe_sdk.issuecommand.html#issuesimple","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.IssueCommand"},{"id":4200,"kind":2048,"name":"issueAndCollect","url":"classes/_zowe_zos_console_for_zowe_sdk.issuecommand.html#issueandcollect","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.IssueCommand"},{"id":4201,"kind":2048,"name":"getResource","url":"classes/_zowe_zos_console_for_zowe_sdk.issuecommand.html#getresource","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.IssueCommand"},{"id":4202,"kind":2048,"name":"buildZosmfConsoleApiParameters","url":"classes/_zowe_zos_console_for_zowe_sdk.issuecommand.html#buildzosmfconsoleapiparameters","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.IssueCommand"},{"id":4203,"kind":128,"name":"ConsoleValidator","url":"classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4204,"kind":2048,"name":"validateCommonParms","url":"classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html#validatecommonparms","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleValidator"},{"id":4205,"kind":2048,"name":"validateIssueParms","url":"classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html#validateissueparms","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleValidator"},{"id":4206,"kind":2048,"name":"validateIssueSimpleParms","url":"classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html#validateissuesimpleparms","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleValidator"},{"id":4207,"kind":2048,"name":"validateCollectParm","url":"classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html#validatecollectparm","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleValidator"},{"id":4208,"kind":2048,"name":"validateIssueParm","url":"classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html#validateissueparm","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleValidator"},{"id":4209,"kind":2048,"name":"validateCollectCommonParms","url":"classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html#validatecollectcommonparms","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleValidator"},{"id":4210,"kind":2048,"name":"validateCollectParms","url":"classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html#validatecollectparms","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleValidator"},{"id":4211,"kind":2048,"name":"validateSession","url":"classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html#validatesession","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleValidator"},{"id":4212,"kind":2048,"name":"validateConsoleName","url":"classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html#validateconsolename","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.ConsoleValidator"},{"id":4213,"kind":128,"name":"CollectCommand","url":"classes/_zowe_zos_console_for_zowe_sdk.collectcommand.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-console-for-zowe-sdk"},{"id":4214,"kind":2048,"name":"collectCommon","url":"classes/_zowe_zos_console_for_zowe_sdk.collectcommand.html#collectcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.CollectCommand"},{"id":4215,"kind":2048,"name":"collectDefConsoleCommon","url":"classes/_zowe_zos_console_for_zowe_sdk.collectcommand.html#collectdefconsolecommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.CollectCommand"},{"id":4216,"kind":2048,"name":"collect","url":"classes/_zowe_zos_console_for_zowe_sdk.collectcommand.html#collect","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.CollectCommand"},{"id":4217,"kind":2048,"name":"getResource","url":"classes/_zowe_zos_console_for_zowe_sdk.collectcommand.html#getresource","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.CollectCommand"},{"id":4218,"kind":1024,"name":"TO_SECONDS","url":"classes/_zowe_zos_console_for_zowe_sdk.collectcommand.html#to_seconds","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.CollectCommand"},{"id":4219,"kind":2048,"name":"getFollowUpAttempts","url":"classes/_zowe_zos_console_for_zowe_sdk.collectcommand.html#getfollowupattempts","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.CollectCommand"},{"id":4220,"kind":2048,"name":"getTimeout","url":"classes/_zowe_zos_console_for_zowe_sdk.collectcommand.html#gettimeout","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-console-for-zowe-sdk.CollectCommand"},{"id":4221,"kind":1,"name":"@zowe/zos-files-for-zowe-sdk","url":"modules/_zowe_zos_files_for_zowe_sdk.html","classes":"tsd-kind-module"},{"id":4222,"kind":2097152,"name":"ZosFilesConstants","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4223,"kind":32,"name":"RESOURCE","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.resource","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4224,"kind":32,"name":"RES_DS_FILES","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_ds_files","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4225,"kind":32,"name":"RES_USS_FILES","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_uss_files","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4226,"kind":32,"name":"RES_ZFS_FILES","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_zfs_files","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4227,"kind":32,"name":"RES_MFS","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_mfs","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4228,"kind":32,"name":"RES_DS_MEMBERS","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_ds_members","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4229,"kind":32,"name":"RES_AMS","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_ams","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4230,"kind":32,"name":"RES_PATH","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_path","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4231,"kind":32,"name":"RES_FSNAME","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_fsname","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4232,"kind":32,"name":"RES_USER","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_user","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4233,"kind":32,"name":"RES_GROUP","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_group","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4234,"kind":32,"name":"RES_MTIME","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_mtime","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4235,"kind":32,"name":"RES_NAME","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_name","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4236,"kind":32,"name":"RES_SIZE","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_size","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4237,"kind":32,"name":"RES_PERM","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_perm","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4238,"kind":32,"name":"RES_TYPE","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4239,"kind":32,"name":"RES_DEPTH","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_depth","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4240,"kind":32,"name":"RES_FILESYS","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_filesys","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4241,"kind":32,"name":"RES_SYMLINKS","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_symlinks","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4242,"kind":32,"name":"RES_DS_LEVEL","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.res_ds_level","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4243,"kind":32,"name":"MAX_ALLOC_QUANTITY","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.max_alloc_quantity","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4244,"kind":32,"name":"MAX_AMS_LINE","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.max_ams_line","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4245,"kind":32,"name":"MAX_AMS_BUFFER","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.max_ams_buffer","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4246,"kind":32,"name":"MIN_RETAIN_DAYS","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.min_retain_days","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4247,"kind":32,"name":"MAX_RETAIN_DAYS","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.max_retain_days","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4248,"kind":32,"name":"VSAM_DSORG_CHOICES","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.vsam_dsorg_choices","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4249,"kind":32,"name":"VSAM_ALCUNIT_CHOICES","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesconstants.vsam_alcunit_choices","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesConstants"},{"id":4250,"kind":2097152,"name":"ZosFilesMessages","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4251,"kind":2097152,"name":"unsupportedDatasetType","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.unsupporteddatasettype","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4252,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.unsupporteddatasettype.message-79","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.unsupportedDatasetType"},{"id":4253,"kind":2097152,"name":"unsupportedMaskingInDataSetName","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.unsupportedmaskingindatasetname","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4254,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.unsupportedmaskingindatasetname.message-80","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.unsupportedMaskingInDataSetName"},{"id":4255,"kind":2097152,"name":"unsupportedDataType","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.unsupporteddatatype","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4256,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.unsupporteddatatype.message-78","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.unsupportedDataType"},{"id":4257,"kind":2097152,"name":"missingDatasetType","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingdatasettype","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4258,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingdatasettype.message-49","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingDatasetType"},{"id":4259,"kind":2097152,"name":"missingDatasetName","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingdatasetname","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4260,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingdatasetname.message-48","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingDatasetName"},{"id":4261,"kind":2097152,"name":"missingDatasetLikeName","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingdatasetlikename","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4262,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingdatasetlikename.message-47","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingDatasetLikeName"},{"id":4263,"kind":2097152,"name":"missingUSSFileName","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingussfilename","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4264,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingussfilename.message-67","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingUSSFileName"},{"id":4265,"kind":2097152,"name":"missingUSSDirName","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingussdirname","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4266,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingussdirname.message-65","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingUSSDirName"},{"id":4267,"kind":2097152,"name":"missingRequiredTableParameters","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingrequiredtableparameters","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4268,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingrequiredtableparameters.message-63","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingRequiredTableParameters"},{"id":4269,"kind":2097152,"name":"missingPayload","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingpayload","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4270,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingpayload.message-59","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingPayload"},{"id":4271,"kind":2097152,"name":"missingUSSDirectoryName","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingussdirectoryname","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4272,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingussdirectoryname.message-66","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingUSSDirectoryName"},{"id":4273,"kind":2097152,"name":"missingRequestType","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingrequesttype","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4274,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingrequesttype.message-62","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingRequestType"},{"id":4275,"kind":2097152,"name":"missingInputFile","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missinginputfile","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4276,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missinginputfile.message-56","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingInputFile"},{"id":4277,"kind":2097152,"name":"missingInputDirectory","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missinginputdirectory","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4278,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missinginputdirectory.message-55","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingInputDirectory"},{"id":4279,"kind":2097152,"name":"missingInputDir","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missinginputdir","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4280,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missinginputdir.message-54","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingInputDir"},{"id":4281,"kind":2097152,"name":"dataSetCreatedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetcreatedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4282,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetcreatedsuccessfully.message-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.dataSetCreatedSuccessfully"},{"id":4283,"kind":2097152,"name":"datasetDeletedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetdeletedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4284,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetdeletedsuccessfully.message-16","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetDeletedSuccessfully"},{"id":4285,"kind":2097152,"name":"datasetDownloadedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetdownloadedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4286,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetdownloadedsuccessfully.message-19","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetDownloadedSuccessfully"},{"id":4287,"kind":2097152,"name":"datasetDownloadedWithDestination","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetdownloadedwithdestination","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4288,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetdownloadedwithdestination.message-20","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetDownloadedWithDestination"},{"id":4289,"kind":2097152,"name":"ussFileDownloadedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.ussfiledownloadedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4290,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.ussfiledownloadedsuccessfully.message-86","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.ussFileDownloadedSuccessfully"},{"id":4291,"kind":2097152,"name":"ussFileDownloadedWithDestination","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.ussfiledownloadedwithdestination","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4292,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.ussfiledownloadedwithdestination.message-87","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.ussFileDownloadedWithDestination"},{"id":4293,"kind":2097152,"name":"ussFileUploadedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.ussfileuploadedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4294,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.ussfileuploadedsuccessfully.message-88","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.ussFileUploadedSuccessfully"},{"id":4295,"kind":2097152,"name":"ussDirUploadedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.ussdiruploadedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4296,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.ussdiruploadedsuccessfully.message-84","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.ussDirUploadedSuccessfully"},{"id":4297,"kind":2097152,"name":"ussFileDeletedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.ussfiledeletedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4298,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.ussfiledeletedsuccessfully.message-85","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.ussFileDeletedSuccessfully"},{"id":4299,"kind":2097152,"name":"datasetsDownloadedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetsdownloadedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4300,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetsdownloadedsuccessfully.message-25","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetsDownloadedSuccessfully"},{"id":4301,"kind":2097152,"name":"dataSetsMatchedPattern","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetsmatchedpattern","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4302,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetsmatchedpattern.message-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.dataSetsMatchedPattern"},{"id":4303,"kind":2097152,"name":"dataSetUploadedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetuploadedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4304,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetuploadedsuccessfully.message-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.dataSetUploadedSuccessfully"},{"id":4305,"kind":2097152,"name":"noMembersFound","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.nomembersfound","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4306,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.nomembersfound.message-73","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.noMembersFound"},{"id":4307,"kind":2097152,"name":"missingFilesCreateOptions","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingfilescreateoptions","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4308,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingfilescreateoptions.message-51","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingFilesCreateOptions"},{"id":4309,"kind":2097152,"name":"invalidFilesCreateOption","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidfilescreateoption","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4310,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidfilescreateoption.message-36","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.invalidFilesCreateOption"},{"id":4311,"kind":2097152,"name":"invalidDsntypeOption","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invaliddsntypeoption","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4312,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invaliddsntypeoption.message-33","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.invalidDsntypeOption"},{"id":4313,"kind":2097152,"name":"invalidAlcunitOption","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidalcunitoption","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4314,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidalcunitoption.message-31","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.invalidAlcunitOption"},{"id":4315,"kind":2097152,"name":"missingPrimary","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingprimary","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4316,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingprimary.message-60","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingPrimary"},{"id":4317,"kind":2097152,"name":"invalidDsorgOption","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invaliddsorgoption","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4318,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invaliddsorgoption.message-34","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.invalidDsorgOption"},{"id":4319,"kind":2097152,"name":"invalidRecfmOption","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidrecfmoption","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4320,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidrecfmoption.message-42","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.invalidRecfmOption"},{"id":4321,"kind":2097152,"name":"invalidPSDsorgDirblkCombination","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidpsdsorgdirblkcombination","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4322,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidpsdsorgdirblkcombination.message-40","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.invalidPSDsorgDirblkCombination"},{"id":4323,"kind":2097152,"name":"invalidPODsorgDirblkCombination","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidpodsorgdirblkcombination","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4324,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidpodsorgdirblkcombination.message-39","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.invalidPODsorgDirblkCombination"},{"id":4325,"kind":2097152,"name":"maximumAllocationQuantityExceeded","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.maximumallocationquantityexceeded","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4326,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.maximumallocationquantityexceeded.message-44","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.maximumAllocationQuantityExceeded"},{"id":4327,"kind":2097152,"name":"missingRecordLength","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingrecordlength","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4328,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingrecordlength.message-61","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingRecordLength"},{"id":4329,"kind":2097152,"name":"missingStatements","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingstatements","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4330,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingstatements.message-64","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingStatements"},{"id":4331,"kind":2097152,"name":"missingVsamOption","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingvsamoption","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4332,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingvsamoption.message-68","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingVsamOption"},{"id":4333,"kind":2097152,"name":"valueOutOfBounds","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.valueoutofbounds","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4334,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.valueoutofbounds.message-89","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.valueOutOfBounds"},{"id":4335,"kind":2097152,"name":"amsCommandExecutedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.amscommandexecutedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4336,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.amscommandexecutedsuccessfully.message-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.amsCommandExecutedSuccessfully"},{"id":4337,"kind":2097152,"name":"longAmsStatement","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.longamsstatement","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4338,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.longamsstatement.message-43","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.longAmsStatement"},{"id":4339,"kind":2097152,"name":"pathIsNotDirectory","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.pathisnotdirectory","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4340,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.pathisnotdirectory.message-76","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.pathIsNotDirectory"},{"id":4341,"kind":2097152,"name":"uploadDirectoryToDatasetMember","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.uploaddirectorytodatasetmember","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4342,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.uploaddirectorytodatasetmember.message-81","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.uploadDirectoryToDatasetMember"},{"id":4343,"kind":2097152,"name":"uploadDirectoryToPhysicalSequentialDataSet","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.uploaddirectorytophysicalsequentialdataset","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4344,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.uploaddirectorytophysicalsequentialdataset.message-82","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.uploadDirectoryToPhysicalSequentialDataSet"},{"id":4345,"kind":2097152,"name":"missingPatterns","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingpatterns","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4346,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingpatterns.message-58","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingPatterns"},{"id":4347,"kind":2097152,"name":"missingDataSets","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingdatasets","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4348,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingdatasets.message-46","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingDataSets"},{"id":4349,"kind":2097152,"name":"allDataSetsArchived","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.alldatasetsarchived","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4350,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.alldatasetsarchived.message","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.allDataSetsArchived"},{"id":4351,"kind":2097152,"name":"noDataSetsInList","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.nodatasetsinlist","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4352,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.nodatasetsinlist.message-70","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.noDataSetsInList"},{"id":4353,"kind":2097152,"name":"noDataSetsMatchingPattern","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.nodatasetsmatchingpattern","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4354,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.nodatasetsmatchingpattern.message-71","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.noDataSetsMatchingPattern"},{"id":4355,"kind":2097152,"name":"noDataSetsMatchingPatternRemain","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.nodatasetsmatchingpatternremain","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4356,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.nodatasetsmatchingpatternremain.message-72","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.noDataSetsMatchingPatternRemain"},{"id":4357,"kind":2097152,"name":"onlyEmptyPartitionedDataSets","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.onlyemptypartitioneddatasets","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4358,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.onlyemptypartitioneddatasets.message-75","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.onlyEmptyPartitionedDataSets"},{"id":4359,"kind":2097152,"name":"failedToDownloadDataSets","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.failedtodownloaddatasets","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4360,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.failedtodownloaddatasets.message-28","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.failedToDownloadDataSets"},{"id":4361,"kind":2097152,"name":"nodeJsFsError","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.nodejsfserror","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4362,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.nodejsfserror.message-74","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.nodeJsFsError"},{"id":4363,"kind":2097152,"name":"invalidAttributesSyntax","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidattributessyntax","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4364,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidattributessyntax.message-32","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.invalidAttributesSyntax"},{"id":4365,"kind":2097152,"name":"attributesFileNotFound","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.attributesfilenotfound","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4366,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.attributesfilenotfound.message-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.attributesFileNotFound"},{"id":4367,"kind":2097152,"name":"errorReadingAttributesFile","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.errorreadingattributesfile","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4368,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.errorreadingattributesfile.message-27","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.errorReadingAttributesFile"},{"id":4369,"kind":2097152,"name":"errorParsingAttributesFile","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.errorparsingattributesfile","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4370,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.errorparsingattributesfile.message-26","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.errorParsingAttributesFile"},{"id":4371,"kind":2097152,"name":"missingFileSystemName","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingfilesystemname","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4372,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingfilesystemname.message-50","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingFileSystemName"},{"id":4373,"kind":2097152,"name":"missingZfsOption","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingzfsoption","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4374,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingzfsoption.message-69","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingZfsOption"},{"id":4375,"kind":2097152,"name":"invalidPermsOption","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidpermsoption","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4376,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidpermsoption.message-41","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.invalidPermsOption"},{"id":4377,"kind":2097152,"name":"zfsCreatedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.zfscreatedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4378,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.zfscreatedsuccessfully.message-90","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.zfsCreatedSuccessfully"},{"id":4379,"kind":2097152,"name":"zfsDeletedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.zfsdeletedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4380,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.zfsdeletedsuccessfully.message-91","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.zfsDeletedSuccessfully"},{"id":4381,"kind":2097152,"name":"missingMountPoint","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingmountpoint","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4382,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingmountpoint.message-57","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingMountPoint"},{"id":4383,"kind":2097152,"name":"missingFilesMountOptions","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingfilesmountoptions","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4384,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingfilesmountoptions.message-52","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingFilesMountOptions"},{"id":4385,"kind":2097152,"name":"invalidFilesMountOption","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidfilesmountoption","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4386,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidfilesmountoption.message-37","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.invalidFilesMountOption"},{"id":4387,"kind":2097152,"name":"missingFsOption","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingfsoption","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4388,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.missingfsoption.message-53","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.missingFsOption"},{"id":4389,"kind":2097152,"name":"invalidMountModeOption","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidmountmodeoption","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4390,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidmountmodeoption.message-38","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.invalidMountModeOption"},{"id":4391,"kind":2097152,"name":"fsMountedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.fsmountedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4392,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.fsmountedsuccessfully.message-29","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.fsMountedSuccessfully"},{"id":4393,"kind":2097152,"name":"fsUnmountedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.fsunmountedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4394,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.fsunmountedsuccessfully.message-30","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.fsUnmountedSuccessfully"},{"id":4395,"kind":2097152,"name":"ussCreatedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.usscreatedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4396,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.usscreatedsuccessfully.message-83","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.ussCreatedSuccessfully"},{"id":4397,"kind":2097152,"name":"datasetRecalledSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetrecalledsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4398,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetrecalledsuccessfully.message-24","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetRecalledSuccessfully"},{"id":4399,"kind":2097152,"name":"dataSetRenamedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetrenamedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4400,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetrenamedsuccessfully.message-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.dataSetRenamedSuccessfully"},{"id":4401,"kind":2097152,"name":"datasetDeletionRequested","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetdeletionrequested","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4402,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetdeletionrequested.message-17","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetDeletionRequested"},{"id":4403,"kind":2097152,"name":"datasetMigrationRequested","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetmigrationrequested","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4404,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetmigrationrequested.message-22","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetMigrationRequested"},{"id":4405,"kind":2097152,"name":"datasetRecallRequested","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetrecallrequested","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4406,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetrecallrequested.message-23","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetRecallRequested"},{"id":4407,"kind":2097152,"name":"datasetCopiedSuccessfully","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetcopiedsuccessfully","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4408,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetcopiedsuccessfully.message-15","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetCopiedSuccessfully"},{"id":4409,"kind":2097152,"name":"datasetCopiedAbortedNoTargetDS","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetcopiedabortednotargetds","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4410,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetcopiedabortednotargetds.message-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetCopiedAbortedNoTargetDS"},{"id":4411,"kind":2097152,"name":"datasetCopiedAborted","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetcopiedaborted","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4412,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetcopiedaborted.message-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetCopiedAborted"},{"id":4413,"kind":2097152,"name":"datasetMemberCopiedAborted","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetmembercopiedaborted","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4414,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetmembercopiedaborted.message-21","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetMemberCopiedAborted"},{"id":4415,"kind":2097152,"name":"datasetCopiedAbortedNoPDS","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetcopiedabortednopds","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4416,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetcopiedabortednopds.message-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetCopiedAbortedNoPDS"},{"id":4417,"kind":2097152,"name":"datasetCopiedAbortedTargetNotPDSMember","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetcopiedabortedtargetnotpdsmember","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4418,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetcopiedabortedtargetnotpdsmember.message-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetCopiedAbortedTargetNotPDSMember"},{"id":4419,"kind":2097152,"name":"datasetAllocateLikeNotFound","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetallocatelikenotfound","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4420,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetallocatelikenotfound.message-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetAllocateLikeNotFound"},{"id":4421,"kind":2097152,"name":"memberDownloadFailed","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.memberdownloadfailed","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4422,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.memberdownloadfailed.message-45","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.memberDownloadFailed"},{"id":4423,"kind":2097152,"name":"datasetDownloadFailed","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetdownloadfailed","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4424,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.datasetdownloadfailed.message-18","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.datasetDownloadFailed"},{"id":4425,"kind":2097152,"name":"someDownloadsFailed","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.somedownloadsfailed","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4426,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.somedownloadsfailed.message-77","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.someDownloadsFailed"},{"id":4427,"kind":2097152,"name":"attributeTitle","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.attributetitle","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4428,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.attributetitle.message-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.attributeTitle"},{"id":4429,"kind":2097152,"name":"commonFor","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.commonfor","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4430,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.commonfor.message-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.commonFor"},{"id":4431,"kind":2097152,"name":"invalidFileName","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidfilename","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4432,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.invalidfilename.message-35","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.invalidFileName"},{"id":4433,"kind":2097152,"name":"commonWithValue","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.commonwithvalue","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages"},{"id":4434,"kind":32,"name":"message","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosfilesmessages.commonwithvalue.message-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesMessages.commonWithValue"},{"id":4435,"kind":256,"name":"IDataSet","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idataset.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4436,"kind":1024,"name":"dsn","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idataset.html#dsn","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDataSet"},{"id":4437,"kind":1024,"name":"member","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idataset.html#member","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDataSet"},{"id":4438,"kind":256,"name":"IZosFilesOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4439,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosFilesOptions"},{"id":4440,"kind":256,"name":"IOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4441,"kind":1024,"name":"binary","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptions.html#binary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptions"},{"id":4442,"kind":1024,"name":"record","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptions.html#record","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptions"},{"id":4443,"kind":1024,"name":"encoding","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptions.html#encoding","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptions"},{"id":4444,"kind":1024,"name":"localEncoding","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptions.html#localencoding","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptions"},{"id":4445,"kind":1024,"name":"volume","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptions.html#volume","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptions"},{"id":4446,"kind":1024,"name":"task","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptions.html#task","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptions"},{"id":4447,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IOptions"},{"id":4448,"kind":4194304,"name":"CLIENT_PROPERTY","url":"modules/_zowe_zos_files_for_zowe_sdk.html#client_property","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4449,"kind":256,"name":"IOptionsFullResponse","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4450,"kind":1024,"name":"resource","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html#resource","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptionsFullResponse"},{"id":4451,"kind":1024,"name":"dataToReturn","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html#datatoreturn","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptionsFullResponse"},{"id":4452,"kind":1024,"name":"reqHeaders","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html#reqheaders","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptionsFullResponse"},{"id":4453,"kind":1024,"name":"writeData","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html#writedata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptionsFullResponse"},{"id":4454,"kind":1024,"name":"responseStream","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html#responsestream","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptionsFullResponse"},{"id":4455,"kind":1024,"name":"requestStream","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html#requeststream","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptionsFullResponse"},{"id":4456,"kind":1024,"name":"normalizeResponseNewLines","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html#normalizeresponsenewlines","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptionsFullResponse"},{"id":4457,"kind":1024,"name":"normalizeRequestNewLines","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html#normalizerequestnewlines","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptionsFullResponse"},{"id":4458,"kind":1024,"name":"task","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html#task","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IOptionsFullResponse"},{"id":4459,"kind":256,"name":"IRestClientResponse","url":"interfaces/_zowe_zos_files_for_zowe_sdk.irestclientresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4460,"kind":1024,"name":"requestSuccess","url":"interfaces/_zowe_zos_files_for_zowe_sdk.irestclientresponse.html#requestsuccess","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IRestClientResponse"},{"id":4461,"kind":1024,"name":"requestFailure","url":"interfaces/_zowe_zos_files_for_zowe_sdk.irestclientresponse.html#requestfailure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IRestClientResponse"},{"id":4462,"kind":1024,"name":"data","url":"interfaces/_zowe_zos_files_for_zowe_sdk.irestclientresponse.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IRestClientResponse"},{"id":4463,"kind":1024,"name":"dataString","url":"interfaces/_zowe_zos_files_for_zowe_sdk.irestclientresponse.html#datastring","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IRestClientResponse"},{"id":4464,"kind":1024,"name":"response","url":"interfaces/_zowe_zos_files_for_zowe_sdk.irestclientresponse.html#response","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IRestClientResponse"},{"id":4465,"kind":1024,"name":"session","url":"interfaces/_zowe_zos_files_for_zowe_sdk.irestclientresponse.html#session","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IRestClientResponse"},{"id":4466,"kind":1024,"name":"log","url":"interfaces/_zowe_zos_files_for_zowe_sdk.irestclientresponse.html#log","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IRestClientResponse"},{"id":4467,"kind":256,"name":"IUSSFileListResponse","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iussfilelistresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4468,"kind":1024,"name":"name","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iussfilelistresponse.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSFileListResponse"},{"id":4469,"kind":1024,"name":"mode","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iussfilelistresponse.html#mode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSFileListResponse"},{"id":4470,"kind":1024,"name":"size","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iussfilelistresponse.html#size","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSFileListResponse"},{"id":4471,"kind":1024,"name":"uid","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iussfilelistresponse.html#uid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSFileListResponse"},{"id":4472,"kind":1024,"name":"user","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iussfilelistresponse.html#user","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSFileListResponse"},{"id":4473,"kind":1024,"name":"gid","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iussfilelistresponse.html#gid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSFileListResponse"},{"id":4474,"kind":256,"name":"IZosFilesResponse","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4475,"kind":1024,"name":"success","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesresponse.html#success","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosFilesResponse"},{"id":4476,"kind":1024,"name":"commandResponse","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesresponse.html#commandresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosFilesResponse"},{"id":4477,"kind":1024,"name":"apiResponse","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesresponse.html#apiresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosFilesResponse"},{"id":4478,"kind":1024,"name":"errorMessage","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesresponse.html#errormessage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosFilesResponse"},{"id":4479,"kind":4194304,"name":"ZosmfMigratedRecallOptions","url":"modules/_zowe_zos_files_for_zowe_sdk.html#zosmfmigratedrecalloptions","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4480,"kind":256,"name":"ICreateDataSetOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4481,"kind":1024,"name":"volser","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#volser","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4482,"kind":1024,"name":"unit","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#unit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4483,"kind":1024,"name":"dsorg","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#dsorg","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4484,"kind":1024,"name":"alcunit","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#alcunit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4485,"kind":1024,"name":"primary","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#primary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4486,"kind":1024,"name":"secondary","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#secondary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4487,"kind":1024,"name":"dirblk","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#dirblk","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4488,"kind":1024,"name":"avgblk","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#avgblk","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4489,"kind":1024,"name":"recfm","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#recfm","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4490,"kind":1024,"name":"blksize","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#blksize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4491,"kind":1024,"name":"lrecl","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#lrecl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4492,"kind":1024,"name":"storclass","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#storclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4493,"kind":1024,"name":"mgntclass","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#mgntclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4494,"kind":1024,"name":"dataclass","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#dataclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4495,"kind":1024,"name":"dsntype","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#dsntype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4496,"kind":1024,"name":"showAttributes","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#showattributes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4497,"kind":1024,"name":"size","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#size","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4498,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.ICreateDataSetOptions"},{"id":4499,"kind":256,"name":"ICreateUssOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreateussoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4500,"kind":1024,"name":"type","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreateussoptions.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateUssOptions"},{"id":4501,"kind":1024,"name":"mode","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreateussoptions.html#mode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateUssOptions"},{"id":4502,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreateussoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.ICreateUssOptions"},{"id":4503,"kind":256,"name":"ICreateVsamOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4504,"kind":1024,"name":"dsorg","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html#dsorg","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateVsamOptions"},{"id":4505,"kind":1024,"name":"alcunit","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html#alcunit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateVsamOptions"},{"id":4506,"kind":1024,"name":"primary","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html#primary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateVsamOptions"},{"id":4507,"kind":1024,"name":"secondary","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html#secondary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateVsamOptions"},{"id":4508,"kind":1024,"name":"volumes","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html#volumes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateVsamOptions"},{"id":4509,"kind":1024,"name":"storclass","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html#storclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateVsamOptions"},{"id":4510,"kind":1024,"name":"mgntclass","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html#mgntclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateVsamOptions"},{"id":4511,"kind":1024,"name":"dataclass","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html#dataclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateVsamOptions"},{"id":4512,"kind":1024,"name":"retainFor","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html#retainfor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateVsamOptions"},{"id":4513,"kind":1024,"name":"retainTo","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html#retainto","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateVsamOptions"},{"id":4514,"kind":1024,"name":"showAttributes","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html#showattributes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateVsamOptions"},{"id":4515,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.ICreateVsamOptions"},{"id":4516,"kind":256,"name":"ICreateZfsOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4517,"kind":1024,"name":"owner","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateZfsOptions"},{"id":4518,"kind":1024,"name":"group","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html#group","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateZfsOptions"},{"id":4519,"kind":1024,"name":"perms","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html#perms","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateZfsOptions"},{"id":4520,"kind":1024,"name":"cylsPri","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html#cylspri","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateZfsOptions"},{"id":4521,"kind":1024,"name":"cylsSec","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html#cylssec","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateZfsOptions"},{"id":4522,"kind":1024,"name":"storclass","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html#storclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateZfsOptions"},{"id":4523,"kind":1024,"name":"mgntclass","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html#mgntclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateZfsOptions"},{"id":4524,"kind":1024,"name":"dataclass","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html#dataclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateZfsOptions"},{"id":4525,"kind":1024,"name":"volumes","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html#volumes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateZfsOptions"},{"id":4526,"kind":1024,"name":"timeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html#timeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICreateZfsOptions"},{"id":4527,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.ICreateZfsOptions"},{"id":4528,"kind":2097152,"name":"CreateDefaults","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4529,"kind":2097152,"name":"DATA_SET","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults"},{"id":4530,"kind":2097152,"name":"PARTITIONED","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.partitioned","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET"},{"id":4531,"kind":32,"name":"alcunit","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.partitioned.alcunit-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.PARTITIONED"},{"id":4532,"kind":32,"name":"dsorg","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.partitioned.dsorg-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.PARTITIONED"},{"id":4533,"kind":32,"name":"primary","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.partitioned.primary-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.PARTITIONED"},{"id":4534,"kind":32,"name":"dirblk","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.partitioned.dirblk-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.PARTITIONED"},{"id":4535,"kind":32,"name":"recfm","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.partitioned.recfm-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.PARTITIONED"},{"id":4536,"kind":32,"name":"blksize","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.partitioned.blksize-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.PARTITIONED"},{"id":4537,"kind":32,"name":"lrecl","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.partitioned.lrecl-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.PARTITIONED"},{"id":4538,"kind":2097152,"name":"SEQUENTIAL","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.sequential","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET"},{"id":4539,"kind":32,"name":"alcunit","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.sequential.alcunit-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.SEQUENTIAL"},{"id":4540,"kind":32,"name":"dsorg","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.sequential.dsorg-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.SEQUENTIAL"},{"id":4541,"kind":32,"name":"primary","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.sequential.primary-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.SEQUENTIAL"},{"id":4542,"kind":32,"name":"recfm","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.sequential.recfm-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.SEQUENTIAL"},{"id":4543,"kind":32,"name":"blksize","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.sequential.blksize-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.SEQUENTIAL"},{"id":4544,"kind":32,"name":"lrecl","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.sequential.lrecl-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.SEQUENTIAL"},{"id":4545,"kind":2097152,"name":"CLASSIC","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.classic","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET"},{"id":4546,"kind":32,"name":"alcunit","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.classic.alcunit-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.CLASSIC"},{"id":4547,"kind":32,"name":"dsorg","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.classic.dsorg-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.CLASSIC"},{"id":4548,"kind":32,"name":"primary","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.classic.primary-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.CLASSIC"},{"id":4549,"kind":32,"name":"recfm","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.classic.recfm-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.CLASSIC"},{"id":4550,"kind":32,"name":"blksize","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.classic.blksize-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.CLASSIC"},{"id":4551,"kind":32,"name":"lrecl","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.classic.lrecl-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.CLASSIC"},{"id":4552,"kind":32,"name":"dirblk","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.classic.dirblk-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.CLASSIC"},{"id":4553,"kind":2097152,"name":"C","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.c","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET"},{"id":4554,"kind":32,"name":"dsorg","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.c.dsorg-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.C"},{"id":4555,"kind":32,"name":"alcunit","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.c.alcunit-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.C"},{"id":4556,"kind":32,"name":"primary","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.c.primary-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.C"},{"id":4557,"kind":32,"name":"recfm","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.c.recfm-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.C"},{"id":4558,"kind":32,"name":"blksize","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.c.blksize-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.C"},{"id":4559,"kind":32,"name":"lrecl","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.c.lrecl-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.C"},{"id":4560,"kind":32,"name":"dirblk","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.c.dirblk-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.C"},{"id":4561,"kind":2097152,"name":"BINARY","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.binary","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET"},{"id":4562,"kind":32,"name":"dsorg","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.binary.dsorg","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.BINARY"},{"id":4563,"kind":32,"name":"alcunit","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.binary.alcunit","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.BINARY"},{"id":4564,"kind":32,"name":"primary","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.binary.primary","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.BINARY"},{"id":4565,"kind":32,"name":"recfm","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.binary.recfm","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.BINARY"},{"id":4566,"kind":32,"name":"blksize","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.binary.blksize","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.BINARY"},{"id":4567,"kind":32,"name":"lrecl","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.binary.lrecl","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.BINARY"},{"id":4568,"kind":32,"name":"dirblk","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.binary.dirblk","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.BINARY"},{"id":4569,"kind":2097152,"name":"BLANK","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.blank","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET"},{"id":4570,"kind":32,"name":"primary","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.data_set.blank.primary-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.DATA_SET.BLANK"},{"id":4571,"kind":2097152,"name":"VSAM","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.vsam","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults"},{"id":4572,"kind":32,"name":"dsorg","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.vsam.dsorg-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.VSAM"},{"id":4573,"kind":32,"name":"alcunit","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.vsam.alcunit-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.VSAM"},{"id":4574,"kind":32,"name":"primary","url":"modules/_zowe_zos_files_for_zowe_sdk.html#createdefaults.vsam.primary-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-files-for-zowe-sdk.CreateDefaults.VSAM"},{"id":4575,"kind":4,"name":"CreateDataSetTypeEnum","url":"enums/_zowe_zos_files_for_zowe_sdk.createdatasettypeenum.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4576,"kind":16,"name":"DATA_SET_BINARY","url":"enums/_zowe_zos_files_for_zowe_sdk.createdatasettypeenum.html#data_set_binary","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/zos-files-for-zowe-sdk.CreateDataSetTypeEnum"},{"id":4577,"kind":16,"name":"DATA_SET_C","url":"enums/_zowe_zos_files_for_zowe_sdk.createdatasettypeenum.html#data_set_c","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/zos-files-for-zowe-sdk.CreateDataSetTypeEnum"},{"id":4578,"kind":16,"name":"DATA_SET_CLASSIC","url":"enums/_zowe_zos_files_for_zowe_sdk.createdatasettypeenum.html#data_set_classic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/zos-files-for-zowe-sdk.CreateDataSetTypeEnum"},{"id":4579,"kind":16,"name":"DATA_SET_PARTITIONED","url":"enums/_zowe_zos_files_for_zowe_sdk.createdatasettypeenum.html#data_set_partitioned","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/zos-files-for-zowe-sdk.CreateDataSetTypeEnum"},{"id":4580,"kind":16,"name":"DATA_SET_SEQUENTIAL","url":"enums/_zowe_zos_files_for_zowe_sdk.createdatasettypeenum.html#data_set_sequential","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/zos-files-for-zowe-sdk.CreateDataSetTypeEnum"},{"id":4581,"kind":16,"name":"DATA_SET_BLANK","url":"enums/_zowe_zos_files_for_zowe_sdk.createdatasettypeenum.html#data_set_blank","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/zos-files-for-zowe-sdk.CreateDataSetTypeEnum"},{"id":4582,"kind":128,"name":"Invoke","url":"classes/_zowe_zos_files_for_zowe_sdk.invoke.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4583,"kind":2048,"name":"ams","url":"classes/_zowe_zos_files_for_zowe_sdk.invoke.html#ams","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Invoke"},{"id":4584,"kind":256,"name":"IDsmListOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idsmlistoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4585,"kind":1024,"name":"excludePatterns","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idsmlistoptions.html#excludepatterns","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDsmListOptions"},{"id":4586,"kind":1024,"name":"maxConcurrentRequests","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idsmlistoptions.html#maxconcurrentrequests","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDsmListOptions"},{"id":4587,"kind":1024,"name":"task","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idsmlistoptions.html#task","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDsmListOptions"},{"id":4588,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idsmlistoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDsmListOptions"},{"id":4589,"kind":256,"name":"IFsOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ifsoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4590,"kind":1024,"name":"path","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ifsoptions.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IFsOptions"},{"id":4591,"kind":1024,"name":"fsname","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ifsoptions.html#fsname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IFsOptions"},{"id":4592,"kind":1024,"name":"maxLength","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ifsoptions.html#maxlength","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IFsOptions"},{"id":4593,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ifsoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IFsOptions"},{"id":4594,"kind":256,"name":"IListOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ilistoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4595,"kind":1024,"name":"volume","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ilistoptions.html#volume","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IListOptions"},{"id":4596,"kind":1024,"name":"attributes","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ilistoptions.html#attributes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IListOptions"},{"id":4597,"kind":1024,"name":"maxLength","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ilistoptions.html#maxlength","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IListOptions"},{"id":4598,"kind":1024,"name":"start","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ilistoptions.html#start","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IListOptions"},{"id":4599,"kind":1024,"name":"recall","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ilistoptions.html#recall","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IListOptions"},{"id":4600,"kind":1024,"name":"pattern","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ilistoptions.html#pattern","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IListOptions"},{"id":4601,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ilistoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IListOptions"},{"id":4602,"kind":256,"name":"IUSSListOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4603,"kind":1024,"name":"maxLength","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html#maxlength","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSListOptions"},{"id":4604,"kind":1024,"name":"group","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html#group","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSListOptions"},{"id":4605,"kind":1024,"name":"user","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html#user","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSListOptions"},{"id":4606,"kind":1024,"name":"mtime","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html#mtime","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSListOptions"},{"id":4607,"kind":1024,"name":"size","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html#size","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSListOptions"},{"id":4608,"kind":1024,"name":"name","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSListOptions"},{"id":4609,"kind":1024,"name":"perm","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html#perm","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSListOptions"},{"id":4610,"kind":1024,"name":"type","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSListOptions"},{"id":4611,"kind":1024,"name":"depth","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html#depth","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSListOptions"},{"id":4612,"kind":1024,"name":"filesys","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html#filesys","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSListOptions"},{"id":4613,"kind":1024,"name":"symlinks","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html#symlinks","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUSSListOptions"},{"id":4614,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IUSSListOptions"},{"id":4615,"kind":256,"name":"IZosmfListResponse","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4616,"kind":1024,"name":"dsname","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#dsname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4617,"kind":1024,"name":"blksz","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#blksz","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4618,"kind":1024,"name":"catnm","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#catnm","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4619,"kind":1024,"name":"cdate","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#cdate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4620,"kind":1024,"name":"dev","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#dev","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4621,"kind":1024,"name":"dsntp","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#dsntp","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4622,"kind":1024,"name":"dsorg","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#dsorg","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4623,"kind":1024,"name":"edate","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#edate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4624,"kind":1024,"name":"extx","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#extx","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4625,"kind":1024,"name":"lrecl","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#lrecl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4626,"kind":1024,"name":"migr","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#migr","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4627,"kind":1024,"name":"mvol","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#mvol","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4628,"kind":1024,"name":"ovf","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#ovf","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4629,"kind":1024,"name":"rdate","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#rdate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4630,"kind":1024,"name":"recfm","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#recfm","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4631,"kind":1024,"name":"sizex","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#sizex","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4632,"kind":1024,"name":"spacu","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#spacu","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4633,"kind":1024,"name":"used","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#used","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4634,"kind":1024,"name":"vol","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#vol","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4635,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IZosmfListResponse"},{"id":4636,"kind":128,"name":"List","url":"classes/_zowe_zos_files_for_zowe_sdk.list.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4637,"kind":1024,"name":"CONTROL_CHAR_REGEX","url":"classes/_zowe_zos_files_for_zowe_sdk.list.html#control_char_regex","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.List"},{"id":4638,"kind":2048,"name":"allMembers","url":"classes/_zowe_zos_files_for_zowe_sdk.list.html#allmembers","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.List"},{"id":4639,"kind":2048,"name":"dataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.list.html#dataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.List"},{"id":4640,"kind":2048,"name":"fileList","url":"classes/_zowe_zos_files_for_zowe_sdk.list.html#filelist","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.List"},{"id":4641,"kind":2048,"name":"fs","url":"classes/_zowe_zos_files_for_zowe_sdk.list.html#fs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.List"},{"id":4642,"kind":2048,"name":"fsWithPath","url":"classes/_zowe_zos_files_for_zowe_sdk.list.html#fswithpath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.List"},{"id":4643,"kind":2048,"name":"dataSetsMatchingPattern","url":"classes/_zowe_zos_files_for_zowe_sdk.list.html#datasetsmatchingpattern","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.List"},{"id":4644,"kind":262144,"name":"log","url":"classes/_zowe_zos_files_for_zowe_sdk.list.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.List"},{"id":4645,"kind":128,"name":"Create","url":"classes/_zowe_zos_files_for_zowe_sdk.create.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4646,"kind":2048,"name":"dataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.create.html#dataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Create"},{"id":4647,"kind":2048,"name":"dataSetLike","url":"classes/_zowe_zos_files_for_zowe_sdk.create.html#datasetlike","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Create"},{"id":4648,"kind":2048,"name":"dataSetValidateOptions","url":"classes/_zowe_zos_files_for_zowe_sdk.create.html#datasetvalidateoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Create"},{"id":4649,"kind":2048,"name":"vsam","url":"classes/_zowe_zos_files_for_zowe_sdk.create.html#vsam","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Create"},{"id":4650,"kind":2048,"name":"uss","url":"classes/_zowe_zos_files_for_zowe_sdk.create.html#uss","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Create"},{"id":4651,"kind":2048,"name":"zfs","url":"classes/_zowe_zos_files_for_zowe_sdk.create.html#zfs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Create"},{"id":4652,"kind":2048,"name":"vsamConvertToIdcamsOptions","url":"classes/_zowe_zos_files_for_zowe_sdk.create.html#vsamconverttoidcamsoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Create"},{"id":4653,"kind":2048,"name":"vsamFormIdcamsCreateCmd","url":"classes/_zowe_zos_files_for_zowe_sdk.create.html#vsamformidcamscreatecmd","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Create"},{"id":4654,"kind":2048,"name":"vsamValidateOptions","url":"classes/_zowe_zos_files_for_zowe_sdk.create.html#vsamvalidateoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Create"},{"id":4655,"kind":2048,"name":"zfsValidateOptions","url":"classes/_zowe_zos_files_for_zowe_sdk.create.html#zfsvalidateoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Create"},{"id":4656,"kind":256,"name":"IGetOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.igetoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4657,"kind":1024,"name":"range","url":"interfaces/_zowe_zos_files_for_zowe_sdk.igetoptions.html#range","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IGetOptions"},{"id":4658,"kind":1024,"name":"binary","url":"interfaces/_zowe_zos_files_for_zowe_sdk.igetoptions.html#binary","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IGetOptions"},{"id":4659,"kind":1024,"name":"record","url":"interfaces/_zowe_zos_files_for_zowe_sdk.igetoptions.html#record","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IGetOptions"},{"id":4660,"kind":1024,"name":"encoding","url":"interfaces/_zowe_zos_files_for_zowe_sdk.igetoptions.html#encoding","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IGetOptions"},{"id":4661,"kind":1024,"name":"localEncoding","url":"interfaces/_zowe_zos_files_for_zowe_sdk.igetoptions.html#localencoding","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IGetOptions"},{"id":4662,"kind":1024,"name":"volume","url":"interfaces/_zowe_zos_files_for_zowe_sdk.igetoptions.html#volume","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IGetOptions"},{"id":4663,"kind":1024,"name":"task","url":"interfaces/_zowe_zos_files_for_zowe_sdk.igetoptions.html#task","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IGetOptions"},{"id":4664,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.igetoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IGetOptions"},{"id":4665,"kind":256,"name":"IMigrateOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.imigrateoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4666,"kind":1024,"name":"wait","url":"interfaces/_zowe_zos_files_for_zowe_sdk.imigrateoptions.html#wait","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IMigrateOptions"},{"id":4667,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.imigrateoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IMigrateOptions"},{"id":4668,"kind":128,"name":"HMigrate","url":"classes/_zowe_zos_files_for_zowe_sdk.hmigrate.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4669,"kind":2048,"name":"dataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.hmigrate.html#dataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.HMigrate"},{"id":4670,"kind":256,"name":"IDeleteOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideleteoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4671,"kind":1024,"name":"purge","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideleteoptions.html#purge","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDeleteOptions"},{"id":4672,"kind":1024,"name":"wait","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideleteoptions.html#wait","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDeleteOptions"},{"id":4673,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideleteoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDeleteOptions"},{"id":4674,"kind":128,"name":"HDelete","url":"classes/_zowe_zos_files_for_zowe_sdk.hdelete.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4675,"kind":2048,"name":"dataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.hdelete.html#dataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.HDelete"},{"id":4676,"kind":128,"name":"ZosFilesUtils","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4677,"kind":1024,"name":"DSN_SEP","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#dsn_sep","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4678,"kind":1024,"name":"DEFAULT_FILE_EXTENSION","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#default_file_extension","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4679,"kind":1024,"name":"MAX_MEMBER_LENGTH","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#max_member_length","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4680,"kind":2048,"name":"getDirsFromDataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#getdirsfromdataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4681,"kind":2048,"name":"getFullPath","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#getfullpath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4682,"kind":2048,"name":"getFileListFromPath","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#getfilelistfrompath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4683,"kind":2048,"name":"generateHeadersBasedOnOptions","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#generateheadersbasedonoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4684,"kind":2048,"name":"generateMemberName","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#generatemembername","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4685,"kind":2048,"name":"isDataSetNameContainMasking","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#isdatasetnamecontainmasking","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4686,"kind":2048,"name":"normalizeNewline","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#normalizenewline","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4687,"kind":2048,"name":"sanitizeUssPathForRestCall","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#sanitizeusspathforrestcall","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4688,"kind":2048,"name":"formatUnixFilepath","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#formatunixfilepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4689,"kind":2048,"name":"dfsmsHsmCommand","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#dfsmshsmcommand","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4690,"kind":2048,"name":"getDataSetFromName","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html#getdatasetfromname","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesUtils"},{"id":4691,"kind":4,"name":"Tag","url":"enums/_zowe_zos_files_for_zowe_sdk.tag.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4692,"kind":16,"name":"TEXT","url":"enums/_zowe_zos_files_for_zowe_sdk.tag.html#text","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/zos-files-for-zowe-sdk.Tag"},{"id":4693,"kind":16,"name":"BINARY","url":"enums/_zowe_zos_files_for_zowe_sdk.tag.html#binary","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/zos-files-for-zowe-sdk.Tag"},{"id":4694,"kind":16,"name":"MIXED","url":"enums/_zowe_zos_files_for_zowe_sdk.tag.html#mixed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/zos-files-for-zowe-sdk.Tag"},{"id":4695,"kind":128,"name":"Utilities","url":"classes/_zowe_zos_files_for_zowe_sdk.utilities.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4696,"kind":2048,"name":"putUSSPayload","url":"classes/_zowe_zos_files_for_zowe_sdk.utilities.html#putusspayload","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Utilities"},{"id":4697,"kind":2048,"name":"chtag","url":"classes/_zowe_zos_files_for_zowe_sdk.utilities.html#chtag","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Utilities"},{"id":4698,"kind":2048,"name":"isFileTagBinOrAscii","url":"classes/_zowe_zos_files_for_zowe_sdk.utilities.html#isfiletagbinorascii","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Utilities"},{"id":4699,"kind":2048,"name":"applyTaggedEncoding","url":"classes/_zowe_zos_files_for_zowe_sdk.utilities.html#applytaggedencoding","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Utilities"},{"id":4700,"kind":2048,"name":"renameUSSFile","url":"classes/_zowe_zos_files_for_zowe_sdk.utilities.html#renameussfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Utilities"},{"id":4701,"kind":4,"name":"TransferMode","url":"enums/_zowe_zos_files_for_zowe_sdk.transfermode.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4702,"kind":16,"name":"BINARY","url":"enums/_zowe_zos_files_for_zowe_sdk.transfermode.html#binary","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/zos-files-for-zowe-sdk.TransferMode"},{"id":4703,"kind":16,"name":"TEXT","url":"enums/_zowe_zos_files_for_zowe_sdk.transfermode.html#text","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"@zowe/zos-files-for-zowe-sdk.TransferMode"},{"id":4704,"kind":128,"name":"ZosFilesAttributes","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4705,"kind":1024,"name":"MAX_EXPECTED_FIELDS","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#max_expected_fields","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4706,"kind":1024,"name":"MIN_EXPECTED_FIELDS","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#min_expected_fields","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4707,"kind":1024,"name":"attributes","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#attributes","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4708,"kind":1024,"name":"basePath","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#basepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4709,"kind":512,"name":"constructor","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4710,"kind":2048,"name":"loadFromFile","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#loadfromfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4711,"kind":2048,"name":"fileShouldBeUploaded","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#fileshouldbeuploaded","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4712,"kind":2048,"name":"fileShouldBeIgnored","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#fileshouldbeignored","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4713,"kind":2048,"name":"getFileTransferMode","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#getfiletransfermode","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4714,"kind":2048,"name":"getRemoteEncoding","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#getremoteencoding","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4715,"kind":2048,"name":"getLocalEncoding","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#getlocalencoding","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4716,"kind":2048,"name":"parse","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#parse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4717,"kind":2048,"name":"findLastMatchingAttributes","url":"classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html#findlastmatchingattributes","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/zos-files-for-zowe-sdk.ZosFilesAttributes"},{"id":4718,"kind":256,"name":"IDownloadSingleOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4719,"kind":1024,"name":"file","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#file","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4720,"kind":1024,"name":"extension","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#extension","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4721,"kind":1024,"name":"directory","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#directory","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4722,"kind":1024,"name":"returnEtag","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#returnetag","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4723,"kind":1024,"name":"preserveOriginalLetterCase","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#preserveoriginallettercase","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4724,"kind":1024,"name":"overwrite","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#overwrite","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4725,"kind":1024,"name":"stream","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#stream","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4726,"kind":1024,"name":"range","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#range","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4727,"kind":1024,"name":"binary","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#binary","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4728,"kind":1024,"name":"record","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#record","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4729,"kind":1024,"name":"encoding","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#encoding","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4730,"kind":1024,"name":"localEncoding","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#localencoding","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4731,"kind":1024,"name":"volume","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#volume","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4732,"kind":1024,"name":"task","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#task","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4733,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadSingleOptions"},{"id":4734,"kind":256,"name":"IDownloadOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4735,"kind":1024,"name":"excludePatterns","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadoptions.html#excludepatterns","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadOptions"},{"id":4736,"kind":1024,"name":"extensionMap","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadoptions.html#extensionmap","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadOptions"},{"id":4737,"kind":65536,"name":"__type","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadoptions.html#extensionmap.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadOptions.extensionMap"},{"id":4738,"kind":1024,"name":"maxConcurrentRequests","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadoptions.html#maxconcurrentrequests","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadOptions"},{"id":4739,"kind":1024,"name":"failFast","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadoptions.html#failfast","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadOptions"},{"id":4740,"kind":1024,"name":"attributes","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadoptions.html#attributes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadOptions"},{"id":4741,"kind":1024,"name":"includeHidden","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadoptions.html#includehidden","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadOptions"},{"id":4742,"kind":256,"name":"IDownloadDsmResult","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloaddsmresult.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4743,"kind":1024,"name":"downloaded","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloaddsmresult.html#downloaded","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadDsmResult"},{"id":4744,"kind":1024,"name":"failedArchived","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloaddsmresult.html#failedarchived","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadDsmResult"},{"id":4745,"kind":1024,"name":"failedUnsupported","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloaddsmresult.html#failedunsupported","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadDsmResult"},{"id":4746,"kind":1024,"name":"failedWithErrors","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloaddsmresult.html#failedwitherrors","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadDsmResult"},{"id":4747,"kind":65536,"name":"__type","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloaddsmresult.html#failedwitherrors.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadDsmResult.failedWithErrors"},{"id":4748,"kind":256,"name":"IDownloadUssDirResult","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadussdirresult.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4749,"kind":1024,"name":"downloaded","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadussdirresult.html#downloaded","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadUssDirResult"},{"id":4750,"kind":1024,"name":"skippedExisting","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadussdirresult.html#skippedexisting","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadUssDirResult"},{"id":4751,"kind":1024,"name":"failedWithErrors","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadussdirresult.html#failedwitherrors","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadUssDirResult"},{"id":4752,"kind":65536,"name":"__type","url":"interfaces/_zowe_zos_files_for_zowe_sdk.idownloadussdirresult.html#failedwitherrors.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/zos-files-for-zowe-sdk.IDownloadUssDirResult.failedWithErrors"},{"id":4753,"kind":128,"name":"Download","url":"classes/_zowe_zos_files_for_zowe_sdk.download.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4754,"kind":2048,"name":"dataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.download.html#dataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Download"},{"id":4755,"kind":2048,"name":"allMembers","url":"classes/_zowe_zos_files_for_zowe_sdk.download.html#allmembers","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Download"},{"id":4756,"kind":2048,"name":"allDataSets","url":"classes/_zowe_zos_files_for_zowe_sdk.download.html#alldatasets","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Download"},{"id":4757,"kind":2048,"name":"ussFile","url":"classes/_zowe_zos_files_for_zowe_sdk.download.html#ussfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Download"},{"id":4758,"kind":2048,"name":"ussDir","url":"classes/_zowe_zos_files_for_zowe_sdk.download.html#ussdir","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Download"},{"id":4759,"kind":2048,"name":"emptyDownloadDsmResult","url":"classes/_zowe_zos_files_for_zowe_sdk.download.html#emptydownloaddsmresult","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Download"},{"id":4760,"kind":2048,"name":"emptyDownloadUssDirResult","url":"classes/_zowe_zos_files_for_zowe_sdk.download.html#emptydownloadussdirresult","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Download"},{"id":4761,"kind":2048,"name":"buildDownloadDsmResponse","url":"classes/_zowe_zos_files_for_zowe_sdk.download.html#builddownloaddsmresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Download"},{"id":4762,"kind":2048,"name":"buildDownloadUssDirResponse","url":"classes/_zowe_zos_files_for_zowe_sdk.download.html#builddownloadussdirresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Download"},{"id":4763,"kind":2048,"name":"generateHeadersBasedOnOptions","url":"classes/_zowe_zos_files_for_zowe_sdk.download.html#generateheadersbasedonoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Download"},{"id":4764,"kind":2048,"name":"parseAttributeOptions","url":"classes/_zowe_zos_files_for_zowe_sdk.download.html#parseattributeoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Download"},{"id":4765,"kind":128,"name":"Get","url":"classes/_zowe_zos_files_for_zowe_sdk.get.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4766,"kind":2048,"name":"dataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.get.html#dataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Get"},{"id":4767,"kind":2048,"name":"USSFile","url":"classes/_zowe_zos_files_for_zowe_sdk.get.html#ussfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Get"},{"id":4768,"kind":256,"name":"IUploadDir","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploaddir.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4769,"kind":1024,"name":"dirName","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploaddir.html#dirname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadDir"},{"id":4770,"kind":1024,"name":"fullPath","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploaddir.html#fullpath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadDir"},{"id":4771,"kind":256,"name":"IUploadFile","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadfile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4772,"kind":1024,"name":"binary","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadfile.html#binary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadFile"},{"id":4773,"kind":1024,"name":"fileName","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadfile.html#filename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadFile"},{"id":4774,"kind":256,"name":"IUploadMap","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadmap.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4775,"kind":1024,"name":"binary","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadmap.html#binary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadMap"},{"id":4776,"kind":1024,"name":"fileNames","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadmap.html#filenames","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadMap"},{"id":4777,"kind":256,"name":"IUploadOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4778,"kind":1024,"name":"recall","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#recall","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4779,"kind":1024,"name":"recursive","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#recursive","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4780,"kind":1024,"name":"binary_files","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#binary_files","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4781,"kind":1024,"name":"ascii_files","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#ascii_files","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4782,"kind":1024,"name":"filesMap","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#filesmap","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4783,"kind":1024,"name":"attributes","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#attributes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4784,"kind":1024,"name":"maxConcurrentRequests","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#maxconcurrentrequests","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4785,"kind":1024,"name":"etag","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#etag","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4786,"kind":1024,"name":"returnEtag","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#returnetag","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4787,"kind":1024,"name":"includeHidden","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#includehidden","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4788,"kind":1024,"name":"binary","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#binary","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4789,"kind":1024,"name":"record","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#record","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4790,"kind":1024,"name":"encoding","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#encoding","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4791,"kind":1024,"name":"localEncoding","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#localencoding","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4792,"kind":1024,"name":"volume","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#volume","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4793,"kind":1024,"name":"task","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#task","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4794,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IUploadOptions"},{"id":4795,"kind":256,"name":"IUploadResult","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadresult.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4796,"kind":1024,"name":"success","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadresult.html#success","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadResult"},{"id":4797,"kind":1024,"name":"from","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadresult.html#from","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadResult"},{"id":4798,"kind":1024,"name":"to","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadresult.html#to","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadResult"},{"id":4799,"kind":1024,"name":"error","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadresult.html#error","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadResult"},{"id":4800,"kind":1024,"name":"etag","url":"interfaces/_zowe_zos_files_for_zowe_sdk.iuploadresult.html#etag","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IUploadResult"},{"id":4801,"kind":128,"name":"Upload","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4802,"kind":2048,"name":"fileToDataset","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#filetodataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4803,"kind":2048,"name":"dirToPds","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#dirtopds","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4804,"kind":2048,"name":"bufferToDataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#buffertodataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4805,"kind":2048,"name":"streamToDataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#streamtodataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4806,"kind":2048,"name":"pathToDataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#pathtodataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4807,"kind":2048,"name":"bufferToUssFile","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#buffertoussfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4808,"kind":2048,"name":"streamToUssFile","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#streamtoussfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4809,"kind":2048,"name":"fileToUssFile","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#filetoussfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4810,"kind":2048,"name":"dirToUSSDir","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#dirtoussdir","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4811,"kind":2048,"name":"isDirectoryExist","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#isdirectoryexist","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4812,"kind":2048,"name":"dirToUSSDirRecursive","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#dirtoussdirrecursive","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4813,"kind":2048,"name":"uploadFile","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#uploadfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4814,"kind":262144,"name":"log","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4815,"kind":2048,"name":"hasDirs","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#hasdirs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4816,"kind":2048,"name":"getDirs","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#getdirs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4817,"kind":2048,"name":"formatStringForDisplay","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#formatstringfordisplay","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4818,"kind":2048,"name":"generateHeadersBasedOnOptions","url":"classes/_zowe_zos_files_for_zowe_sdk.upload.html#generateheadersbasedonoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Upload"},{"id":4819,"kind":256,"name":"ICopyDatasetOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icopydatasetoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4820,"kind":1024,"name":"from-dataset","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icopydatasetoptions.html#from_dataset","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICopyDatasetOptions"},{"id":4821,"kind":1024,"name":"enq","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icopydatasetoptions.html#enq","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICopyDatasetOptions"},{"id":4822,"kind":1024,"name":"replace","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icopydatasetoptions.html#replace","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICopyDatasetOptions"},{"id":4823,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icopydatasetoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.ICopyDatasetOptions"},{"id":4824,"kind":256,"name":"ICrossLparCopyDatasetOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4825,"kind":1024,"name":"targetVolser","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html#targetvolser","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICrossLparCopyDatasetOptions"},{"id":4826,"kind":1024,"name":"targetManagementClass","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html#targetmanagementclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICrossLparCopyDatasetOptions"},{"id":4827,"kind":1024,"name":"targetStorageClass","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html#targetstorageclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICrossLparCopyDatasetOptions"},{"id":4828,"kind":1024,"name":"targetDataClass","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html#targetdataclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICrossLparCopyDatasetOptions"},{"id":4829,"kind":1024,"name":"overwrite","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html#overwrite","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICrossLparCopyDatasetOptions"},{"id":4830,"kind":1024,"name":"promptFn","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html#promptfn","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.ICrossLparCopyDatasetOptions"},{"id":4831,"kind":65536,"name":"__type","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html#promptfn.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"@zowe/zos-files-for-zowe-sdk.ICrossLparCopyDatasetOptions.promptFn"},{"id":4832,"kind":1024,"name":"from-dataset","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html#from_dataset","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.ICrossLparCopyDatasetOptions"},{"id":4833,"kind":1024,"name":"enq","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html#enq","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.ICrossLparCopyDatasetOptions"},{"id":4834,"kind":1024,"name":"replace","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html#replace","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.ICrossLparCopyDatasetOptions"},{"id":4835,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.ICrossLparCopyDatasetOptions"},{"id":4836,"kind":128,"name":"Copy","url":"classes/_zowe_zos_files_for_zowe_sdk.copy.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4837,"kind":2048,"name":"dataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.copy.html#dataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Copy"},{"id":4838,"kind":2048,"name":"dataSetCrossLPAR","url":"classes/_zowe_zos_files_for_zowe_sdk.copy.html#datasetcrosslpar","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Copy"},{"id":4839,"kind":2048,"name":"generateDatasetOptions","url":"classes/_zowe_zos_files_for_zowe_sdk.copy.html#generatedatasetoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Copy"},{"id":4840,"kind":2048,"name":"convertAlcTozOSMF","url":"classes/_zowe_zos_files_for_zowe_sdk.copy.html#convertalctozosmf","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Copy"},{"id":4841,"kind":256,"name":"IDeleteDatasetOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideletedatasetoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4842,"kind":1024,"name":"volume","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideletedatasetoptions.html#volume","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDeleteDatasetOptions"},{"id":4843,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideletedatasetoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDeleteDatasetOptions"},{"id":4844,"kind":256,"name":"IDeleteVsamOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4845,"kind":1024,"name":"erase","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamoptions.html#erase","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDeleteVsamOptions"},{"id":4846,"kind":1024,"name":"purge","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamoptions.html#purge","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IDeleteVsamOptions"},{"id":4847,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDeleteVsamOptions"},{"id":4848,"kind":256,"name":"IDeleteVsamResponse","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4849,"kind":1024,"name":"apiResponse","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamresponse.html#apiresponse","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"@zowe/zos-files-for-zowe-sdk.IDeleteVsamResponse"},{"id":4850,"kind":1024,"name":"success","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamresponse.html#success","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDeleteVsamResponse"},{"id":4851,"kind":1024,"name":"commandResponse","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamresponse.html#commandresponse","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDeleteVsamResponse"},{"id":4852,"kind":1024,"name":"errorMessage","url":"interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamresponse.html#errormessage","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IDeleteVsamResponse"},{"id":4853,"kind":128,"name":"Delete","url":"classes/_zowe_zos_files_for_zowe_sdk.delete.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4854,"kind":2048,"name":"dataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.delete.html#dataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Delete"},{"id":4855,"kind":2048,"name":"vsam","url":"classes/_zowe_zos_files_for_zowe_sdk.delete.html#vsam","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Delete"},{"id":4856,"kind":2048,"name":"ussFile","url":"classes/_zowe_zos_files_for_zowe_sdk.delete.html#ussfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Delete"},{"id":4857,"kind":2048,"name":"zfs","url":"classes/_zowe_zos_files_for_zowe_sdk.delete.html#zfs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Delete"},{"id":4858,"kind":4194304,"name":"IRecallOptions","url":"modules/_zowe_zos_files_for_zowe_sdk.html#irecalloptions","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4859,"kind":128,"name":"HRecall","url":"classes/_zowe_zos_files_for_zowe_sdk.hrecall.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4860,"kind":2048,"name":"dataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.hrecall.html#dataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.HRecall"},{"id":4861,"kind":4194304,"name":"IMountFsMode","url":"modules/_zowe_zos_files_for_zowe_sdk.html#imountfsmode","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4862,"kind":256,"name":"IMountFsOptions","url":"interfaces/_zowe_zos_files_for_zowe_sdk.imountfsoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4863,"kind":1024,"name":"fs-type","url":"interfaces/_zowe_zos_files_for_zowe_sdk.imountfsoptions.html#fs_type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IMountFsOptions"},{"id":4864,"kind":1024,"name":"mode","url":"interfaces/_zowe_zos_files_for_zowe_sdk.imountfsoptions.html#mode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-files-for-zowe-sdk.IMountFsOptions"},{"id":4865,"kind":1024,"name":"responseTimeout","url":"interfaces/_zowe_zos_files_for_zowe_sdk.imountfsoptions.html#responsetimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-files-for-zowe-sdk.IMountFsOptions"},{"id":4866,"kind":128,"name":"Mount","url":"classes/_zowe_zos_files_for_zowe_sdk.mount.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4867,"kind":2048,"name":"fs","url":"classes/_zowe_zos_files_for_zowe_sdk.mount.html#fs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Mount"},{"id":4868,"kind":2048,"name":"fsValidateOptions","url":"classes/_zowe_zos_files_for_zowe_sdk.mount.html#fsvalidateoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Mount"},{"id":4869,"kind":128,"name":"Rename","url":"classes/_zowe_zos_files_for_zowe_sdk.rename.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4870,"kind":2048,"name":"dataSet","url":"classes/_zowe_zos_files_for_zowe_sdk.rename.html#dataset","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Rename"},{"id":4871,"kind":2048,"name":"dataSetMember","url":"classes/_zowe_zos_files_for_zowe_sdk.rename.html#datasetmember","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Rename"},{"id":4872,"kind":2048,"name":"rename","url":"classes/_zowe_zos_files_for_zowe_sdk.rename.html#rename","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Rename"},{"id":4873,"kind":128,"name":"Unmount","url":"classes/_zowe_zos_files_for_zowe_sdk.unmount.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-files-for-zowe-sdk"},{"id":4874,"kind":2048,"name":"fs","url":"classes/_zowe_zos_files_for_zowe_sdk.unmount.html#fs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-files-for-zowe-sdk.Unmount"},{"id":4875,"kind":1,"name":"@zowe/zos-jobs-for-zowe-sdk","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html","classes":"tsd-kind-module"},{"id":4876,"kind":128,"name":"JobsConstants","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4877,"kind":1024,"name":"STEP_DATA","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#step_data","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4878,"kind":1024,"name":"QUERY_ID","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#query_id","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4879,"kind":1024,"name":"COMBO_ID","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#combo_id","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4880,"kind":1024,"name":"QUERY_OWNER","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#query_owner","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4881,"kind":1024,"name":"QUERY_PREFIX","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#query_prefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4882,"kind":1024,"name":"QUERY_JOBID","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#query_jobid","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4883,"kind":1024,"name":"QUERY_STATUS","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#query_status","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4884,"kind":1024,"name":"QUERY_MAX_JOBS","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#query_max_jobs","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4885,"kind":1024,"name":"DEFAULT_PREFIX","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#default_prefix","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4886,"kind":1024,"name":"DEFAULT_MAX_JOBS","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#default_max_jobs","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4887,"kind":1024,"name":"DEFAULT_STATUS","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#default_status","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4888,"kind":1024,"name":"RESOURCE","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#resource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4889,"kind":1024,"name":"RESOURCE_SPOOL_FILES","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#resource_spool_files","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4890,"kind":1024,"name":"RESOURCE_JCL_CONTENT","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#resource_jcl_content","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4891,"kind":1024,"name":"RESOURCE_SPOOL_CONTENT","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#resource_spool_content","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4892,"kind":1024,"name":"REQUEST_CANCEL","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#request_cancel","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4893,"kind":1024,"name":"DEFAULT_CANCEL_VERSION","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#default_cancel_version","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4894,"kind":1024,"name":"REQUEST_HOLD","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#request_hold","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4895,"kind":1024,"name":"REQUEST_RELEASE","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#request_release","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4896,"kind":1024,"name":"EXEC_DATA","url":"classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html#exec_data","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.JobsConstants"},{"id":4897,"kind":256,"name":"IJobStepData","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobstepdata.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4898,"kind":1024,"name":"smfid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobstepdata.html#smfid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobStepData"},{"id":4899,"kind":1024,"name":"active","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobstepdata.html#active","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobStepData"},{"id":4900,"kind":1024,"name":"step-number","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobstepdata.html#step_number","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobStepData"},{"id":4901,"kind":1024,"name":"proc-step-name","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobstepdata.html#proc_step_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobStepData"},{"id":4902,"kind":1024,"name":"step-name","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobstepdata.html#step_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobStepData"},{"id":4903,"kind":1024,"name":"program-name","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobstepdata.html#program_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobStepData"},{"id":4904,"kind":256,"name":"IJob","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4905,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4906,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4907,"kind":1024,"name":"subsystem","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#subsystem","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4908,"kind":1024,"name":"owner","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4909,"kind":1024,"name":"status","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4910,"kind":1024,"name":"type","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4911,"kind":1024,"name":"class","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#class","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4912,"kind":1024,"name":"retcode","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#retcode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4913,"kind":1024,"name":"step-data","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#step_data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4914,"kind":1024,"name":"url","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4915,"kind":1024,"name":"files-url","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#files_url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4916,"kind":1024,"name":"job-correlator","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#job_correlator","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4917,"kind":1024,"name":"phase","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#phase","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4918,"kind":1024,"name":"phase-name","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#phase_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4919,"kind":1024,"name":"reason-not-running","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html#reason_not_running","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJob"},{"id":4920,"kind":256,"name":"ICancelJobParms","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljobparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4921,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljobparms.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ICancelJobParms"},{"id":4922,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljobparms.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ICancelJobParms"},{"id":4923,"kind":1024,"name":"version","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljobparms.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ICancelJobParms"},{"id":4924,"kind":256,"name":"ICancelJob","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljob.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4925,"kind":1024,"name":"request","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljob.html#request","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ICancelJob"},{"id":4926,"kind":1024,"name":"version","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljob.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ICancelJob"},{"id":4927,"kind":256,"name":"IJobFeedback","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4928,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFeedback"},{"id":4929,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFeedback"},{"id":4930,"kind":1024,"name":"original-jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html#original_jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFeedback"},{"id":4931,"kind":1024,"name":"owner","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFeedback"},{"id":4932,"kind":1024,"name":"member","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html#member","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFeedback"},{"id":4933,"kind":1024,"name":"sysname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html#sysname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFeedback"},{"id":4934,"kind":1024,"name":"job-correlator","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html#job_correlator","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFeedback"},{"id":4935,"kind":1024,"name":"status","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFeedback"},{"id":4936,"kind":1024,"name":"internal-code","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html#internal_code","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFeedback"},{"id":4937,"kind":1024,"name":"message","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFeedback"},{"id":4938,"kind":128,"name":"CancelJobs","url":"classes/_zowe_zos_jobs_for_zowe_sdk.canceljobs.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4939,"kind":2048,"name":"cancelJob","url":"classes/_zowe_zos_jobs_for_zowe_sdk.canceljobs.html#canceljob","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.CancelJobs"},{"id":4940,"kind":2048,"name":"cancelJobForJob","url":"classes/_zowe_zos_jobs_for_zowe_sdk.canceljobs.html#canceljobforjob","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.CancelJobs"},{"id":4941,"kind":2048,"name":"cancelJobCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.canceljobs.html#canceljobcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.CancelJobs"},{"id":4942,"kind":262144,"name":"log","url":"classes/_zowe_zos_jobs_for_zowe_sdk.canceljobs.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.CancelJobs"},{"id":4943,"kind":256,"name":"IDeleteJobParms","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ideletejobparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4944,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ideletejobparms.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDeleteJobParms"},{"id":4945,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ideletejobparms.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDeleteJobParms"},{"id":4946,"kind":1024,"name":"modifyVersion","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ideletejobparms.html#modifyversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDeleteJobParms"},{"id":4947,"kind":128,"name":"DeleteJobs","url":"classes/_zowe_zos_jobs_for_zowe_sdk.deletejobs.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4948,"kind":2048,"name":"deleteJob","url":"classes/_zowe_zos_jobs_for_zowe_sdk.deletejobs.html#deletejob","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.DeleteJobs"},{"id":4949,"kind":2048,"name":"deleteJobForJob","url":"classes/_zowe_zos_jobs_for_zowe_sdk.deletejobs.html#deletejobforjob","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.DeleteJobs"},{"id":4950,"kind":2048,"name":"deleteJobCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.deletejobs.html#deletejobcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.DeleteJobs"},{"id":4951,"kind":262144,"name":"log","url":"classes/_zowe_zos_jobs_for_zowe_sdk.deletejobs.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.DeleteJobs"},{"id":4952,"kind":256,"name":"IDownloadAllSpoolContentParms","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadallspoolcontentparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4953,"kind":1024,"name":"outDir","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadallspoolcontentparms.html#outdir","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDownloadAllSpoolContentParms"},{"id":4954,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadallspoolcontentparms.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDownloadAllSpoolContentParms"},{"id":4955,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadallspoolcontentparms.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDownloadAllSpoolContentParms"},{"id":4956,"kind":1024,"name":"omitJobidDirectory","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadallspoolcontentparms.html#omitjobiddirectory","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDownloadAllSpoolContentParms"},{"id":4957,"kind":1024,"name":"extension","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadallspoolcontentparms.html#extension","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDownloadAllSpoolContentParms"},{"id":4958,"kind":1024,"name":"binary","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadallspoolcontentparms.html#binary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDownloadAllSpoolContentParms"},{"id":4959,"kind":1024,"name":"record","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadallspoolcontentparms.html#record","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDownloadAllSpoolContentParms"},{"id":4960,"kind":256,"name":"IJobFile","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4961,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4962,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4963,"kind":1024,"name":"recfm","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#recfm","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4964,"kind":1024,"name":"byte-count","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#byte_count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4965,"kind":1024,"name":"record-count","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#record_count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4966,"kind":1024,"name":"job-correlator","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#job_correlator","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4967,"kind":1024,"name":"class","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#class","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4968,"kind":1024,"name":"id","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4969,"kind":1024,"name":"ddname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#ddname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4970,"kind":1024,"name":"records-url","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#records_url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4971,"kind":1024,"name":"lrecl","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#lrecl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4972,"kind":1024,"name":"subsystem","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#subsystem","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4973,"kind":1024,"name":"stepname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#stepname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4974,"kind":1024,"name":"procstep","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html#procstep","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFile"},{"id":4975,"kind":256,"name":"IDownloadSpoolContentParms","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadspoolcontentparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4976,"kind":1024,"name":"jobFile","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadspoolcontentparms.html#jobfile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDownloadSpoolContentParms"},{"id":4977,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadspoolcontentparms.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDownloadSpoolContentParms"},{"id":4978,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadspoolcontentparms.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDownloadSpoolContentParms"},{"id":4979,"kind":1024,"name":"stream","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadspoolcontentparms.html#stream","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IDownloadSpoolContentParms"},{"id":4980,"kind":256,"name":"IModifyJob","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjob.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4981,"kind":1024,"name":"class","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjob.html#class","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IModifyJob"},{"id":4982,"kind":1024,"name":"request","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjob.html#request","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IModifyJob"},{"id":4983,"kind":256,"name":"IModifyJobParms","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjobparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4984,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjobparms.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IModifyJobParms"},{"id":4985,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjobparms.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IModifyJobParms"},{"id":4986,"kind":256,"name":"IModifyJobOptions","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjoboptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4987,"kind":1024,"name":"jobclass","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjoboptions.html#jobclass","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IModifyJobOptions"},{"id":4988,"kind":1024,"name":"hold","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjoboptions.html#hold","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IModifyJobOptions"},{"id":4989,"kind":1024,"name":"release","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjoboptions.html#release","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IModifyJobOptions"},{"id":4990,"kind":256,"name":"ICommonJobParms","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.icommonjobparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4991,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.icommonjobparms.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ICommonJobParms"},{"id":4992,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.icommonjobparms.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ICommonJobParms"},{"id":4993,"kind":256,"name":"IGetJobsParms","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.igetjobsparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":4994,"kind":1024,"name":"owner","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.igetjobsparms.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IGetJobsParms"},{"id":4995,"kind":1024,"name":"prefix","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.igetjobsparms.html#prefix","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IGetJobsParms"},{"id":4996,"kind":1024,"name":"status","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.igetjobsparms.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IGetJobsParms"},{"id":4997,"kind":1024,"name":"maxJobs","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.igetjobsparms.html#maxjobs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IGetJobsParms"},{"id":4998,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.igetjobsparms.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IGetJobsParms"},{"id":4999,"kind":1024,"name":"execData","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.igetjobsparms.html#execdata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IGetJobsParms"},{"id":5000,"kind":4194304,"name":"JOB_STATUS","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#job_status","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5001,"kind":32,"name":"JOB_STATUS_ORDER","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#job_status_order","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5002,"kind":256,"name":"IMonitorJobWaitForParms","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imonitorjobwaitforparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5003,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imonitorjobwaitforparms.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IMonitorJobWaitForParms"},{"id":5004,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imonitorjobwaitforparms.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IMonitorJobWaitForParms"},{"id":5005,"kind":1024,"name":"watchDelay","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imonitorjobwaitforparms.html#watchdelay","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IMonitorJobWaitForParms"},{"id":5006,"kind":1024,"name":"status","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imonitorjobwaitforparms.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IMonitorJobWaitForParms"},{"id":5007,"kind":1024,"name":"attempts","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.imonitorjobwaitforparms.html#attempts","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IMonitorJobWaitForParms"},{"id":5008,"kind":256,"name":"ISubmitJclNotifyParm","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclnotifyparm.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5009,"kind":1024,"name":"jcl","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclnotifyparm.html#jcl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJclNotifyParm"},{"id":5010,"kind":1024,"name":"internalReaderRecfm","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclnotifyparm.html#internalreaderrecfm","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJclNotifyParm"},{"id":5011,"kind":1024,"name":"internalReaderLrecl","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclnotifyparm.html#internalreaderlrecl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJclNotifyParm"},{"id":5012,"kind":1024,"name":"watchDelay","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclnotifyparm.html#watchdelay","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJclNotifyParm"},{"id":5013,"kind":1024,"name":"status","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclnotifyparm.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJclNotifyParm"},{"id":5014,"kind":1024,"name":"attempts","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclnotifyparm.html#attempts","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJclNotifyParm"},{"id":5015,"kind":1024,"name":"jclSymbols","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclnotifyparm.html#jclsymbols","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJclNotifyParm"},{"id":5016,"kind":256,"name":"ISubmitJclParms","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5017,"kind":1024,"name":"jcl","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclparms.html#jcl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJclParms"},{"id":5018,"kind":1024,"name":"internalReaderRecfm","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclparms.html#internalreaderrecfm","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJclParms"},{"id":5019,"kind":1024,"name":"internalReaderLrecl","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclparms.html#internalreaderlrecl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJclParms"},{"id":5020,"kind":1024,"name":"jclSymbols","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclparms.html#jclsymbols","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJclParms"},{"id":5021,"kind":256,"name":"ISubmitJobNotifyParm","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobnotifyparm.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5022,"kind":1024,"name":"jobDataSet","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobnotifyparm.html#jobdataset","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobNotifyParm"},{"id":5023,"kind":1024,"name":"watchDelay","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobnotifyparm.html#watchdelay","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobNotifyParm"},{"id":5024,"kind":1024,"name":"status","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobnotifyparm.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobNotifyParm"},{"id":5025,"kind":1024,"name":"attempts","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobnotifyparm.html#attempts","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobNotifyParm"},{"id":5026,"kind":1024,"name":"jclSymbols","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobnotifyparm.html#jclsymbols","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobNotifyParm"},{"id":5027,"kind":256,"name":"ISubmitJobUSSParms","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5028,"kind":1024,"name":"jobUSSFile","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussparms.html#jobussfile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobUSSParms"},{"id":5029,"kind":1024,"name":"jclSymbols","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussparms.html#jclsymbols","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobUSSParms"},{"id":5030,"kind":256,"name":"ISubmitJobUSSNotifyParm","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussnotifyparm.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5031,"kind":1024,"name":"watchDelay","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussnotifyparm.html#watchdelay","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobUSSNotifyParm"},{"id":5032,"kind":1024,"name":"status","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussnotifyparm.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobUSSNotifyParm"},{"id":5033,"kind":1024,"name":"attempts","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussnotifyparm.html#attempts","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobUSSNotifyParm"},{"id":5034,"kind":1024,"name":"jobUSSFile","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussnotifyparm.html#jobussfile","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobUSSNotifyParm"},{"id":5035,"kind":1024,"name":"jclSymbols","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussnotifyparm.html#jclsymbols","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobUSSNotifyParm"},{"id":5036,"kind":256,"name":"ISubmitJobParms","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5037,"kind":1024,"name":"jobDataSet","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobparms.html#jobdataset","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobParms"},{"id":5038,"kind":1024,"name":"jclSymbols","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobparms.html#jclsymbols","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitJobParms"},{"id":5039,"kind":256,"name":"ISubmitParms","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5040,"kind":1024,"name":"jclSource","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html#jclsource","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitParms"},{"id":5041,"kind":1024,"name":"viewAllSpoolContent","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html#viewallspoolcontent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitParms"},{"id":5042,"kind":1024,"name":"waitForActive","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html#waitforactive","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitParms"},{"id":5043,"kind":1024,"name":"waitForOutput","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html#waitforoutput","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitParms"},{"id":5044,"kind":1024,"name":"directory","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html#directory","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitParms"},{"id":5045,"kind":1024,"name":"extension","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html#extension","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitParms"},{"id":5046,"kind":1024,"name":"volume","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html#volume","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitParms"},{"id":5047,"kind":1024,"name":"task","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html#task","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitParms"},{"id":5048,"kind":1024,"name":"jclSymbols","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html#jclsymbols","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISubmitParms"},{"id":5049,"kind":256,"name":"IJobComplete","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5050,"kind":1024,"name":"job-correlator","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html#job_correlator","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobComplete"},{"id":5051,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobComplete"},{"id":5052,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobComplete"},{"id":5053,"kind":1024,"name":"owner","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobComplete"},{"id":5054,"kind":1024,"name":"class","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html#class","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobComplete"},{"id":5055,"kind":1024,"name":"retcode","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html#retcode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobComplete"},{"id":5056,"kind":1024,"name":"completion-type","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html#completion_type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobComplete"},{"id":5057,"kind":1024,"name":"completion-code","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html#completion_code","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobComplete"},{"id":5058,"kind":1024,"name":"abend-code","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html#abend_code","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobComplete"},{"id":5059,"kind":256,"name":"IJobError","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijoberror.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5060,"kind":1024,"name":"rc","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijoberror.html#rc","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobError"},{"id":5061,"kind":1024,"name":"reason","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijoberror.html#reason","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobError"},{"id":5062,"kind":1024,"name":"stack","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijoberror.html#stack","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobError"},{"id":5063,"kind":1024,"name":"category","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijoberror.html#category","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobError"},{"id":5064,"kind":1024,"name":"message","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijoberror.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobError"},{"id":5065,"kind":256,"name":"IJobFileSimple","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfilesimple.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5066,"kind":1024,"name":"id","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfilesimple.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFileSimple"},{"id":5067,"kind":1024,"name":"ddname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfilesimple.html#ddname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFileSimple"},{"id":5068,"kind":1024,"name":"stepname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfilesimple.html#stepname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFileSimple"},{"id":5069,"kind":1024,"name":"record-count","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfilesimple.html#record_count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobFileSimple"},{"id":5070,"kind":256,"name":"IJobSubmit","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobsubmit.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5071,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobsubmit.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobSubmit"},{"id":5072,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobsubmit.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobSubmit"},{"id":5073,"kind":1024,"name":"status","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobsubmit.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobSubmit"},{"id":5074,"kind":1024,"name":"retcode","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobsubmit.html#retcode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.IJobSubmit"},{"id":5075,"kind":256,"name":"ISpoolFile","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ispoolfile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5076,"kind":1024,"name":"id","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ispoolfile.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISpoolFile"},{"id":5077,"kind":1024,"name":"ddName","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ispoolfile.html#ddname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISpoolFile"},{"id":5078,"kind":1024,"name":"stepName","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ispoolfile.html#stepname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISpoolFile"},{"id":5079,"kind":1024,"name":"procName","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ispoolfile.html#procname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISpoolFile"},{"id":5080,"kind":1024,"name":"data","url":"interfaces/_zowe_zos_jobs_for_zowe_sdk.ispoolfile.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-jobs-for-zowe-sdk.ISpoolFile"},{"id":5081,"kind":4194304,"name":"JobDataResolve","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#jobdataresolve","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5082,"kind":65536,"name":"__type","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#jobdataresolve.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/zos-jobs-for-zowe-sdk.JobDataResolve"},{"id":5083,"kind":4194304,"name":"JobResolve","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#jobresolve","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5084,"kind":65536,"name":"__type","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#jobresolve.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/zos-jobs-for-zowe-sdk.JobResolve"},{"id":5085,"kind":128,"name":"ModifyJobs","url":"classes/_zowe_zos_jobs_for_zowe_sdk.modifyjobs.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5086,"kind":2048,"name":"modifyJob","url":"classes/_zowe_zos_jobs_for_zowe_sdk.modifyjobs.html#modifyjob","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.ModifyJobs"},{"id":5087,"kind":2048,"name":"modifyJobCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.modifyjobs.html#modifyjobcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.ModifyJobs"},{"id":5088,"kind":262144,"name":"log","url":"classes/_zowe_zos_jobs_for_zowe_sdk.modifyjobs.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.ModifyJobs"},{"id":5089,"kind":2097152,"name":"ZosJobsMessages","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#zosjobsmessages","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5090,"kind":2097152,"name":"missingUssFilePath","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#zosjobsmessages.missingussfilepath","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-jobs-for-zowe-sdk.ZosJobsMessages"},{"id":5091,"kind":32,"name":"message","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#zosjobsmessages.missingussfilepath.message-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-jobs-for-zowe-sdk.ZosJobsMessages.missingUssFilePath"},{"id":5092,"kind":2097152,"name":"missingDirectoryOption","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#zosjobsmessages.missingdirectoryoption","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-jobs-for-zowe-sdk.ZosJobsMessages"},{"id":5093,"kind":32,"name":"message","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#zosjobsmessages.missingdirectoryoption.message","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-jobs-for-zowe-sdk.ZosJobsMessages.missingDirectoryOption"},{"id":5094,"kind":2097152,"name":"missingJcl","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#zosjobsmessages.missingjcl","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-jobs-for-zowe-sdk.ZosJobsMessages"},{"id":5095,"kind":32,"name":"message","url":"modules/_zowe_zos_jobs_for_zowe_sdk.html#zosjobsmessages.missingjcl.message-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-jobs-for-zowe-sdk.ZosJobsMessages.missingJcl"},{"id":5096,"kind":128,"name":"MonitorJobs","url":"classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5097,"kind":1024,"name":"DEFAULT_WATCH_DELAY","url":"classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html#default_watch_delay","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.MonitorJobs"},{"id":5098,"kind":1024,"name":"DEFAULT_STATUS","url":"classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html#default_status","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.MonitorJobs"},{"id":5099,"kind":1024,"name":"DEFAULT_ATTEMPTS","url":"classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html#default_attempts","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.MonitorJobs"},{"id":5100,"kind":2048,"name":"waitForJobOutputStatus","url":"classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html#waitforjoboutputstatus","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.MonitorJobs"},{"id":5101,"kind":2048,"name":"waitForOutputStatus","url":"classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html#waitforoutputstatus","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.MonitorJobs"},{"id":5102,"kind":2048,"name":"waitForStatusCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html#waitforstatuscommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.MonitorJobs"},{"id":5103,"kind":1024,"name":"log","url":"classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html#log","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.MonitorJobs"},{"id":5104,"kind":2048,"name":"pollForStatus","url":"classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html#pollforstatus","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.MonitorJobs"},{"id":5105,"kind":2048,"name":"checkStatus","url":"classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html#checkstatus","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.MonitorJobs"},{"id":5106,"kind":2048,"name":"constructErrorMsg","url":"classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html#constructerrormsg","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.MonitorJobs"},{"id":5107,"kind":128,"name":"SubmitJobs","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5108,"kind":1024,"name":"singleQuote","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#singlequote","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5109,"kind":2048,"name":"submitJob","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#submitjob","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5110,"kind":2048,"name":"submitUSSJob","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#submitussjob","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5111,"kind":2048,"name":"submitJobCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#submitjobcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5112,"kind":2048,"name":"submitJcl","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#submitjcl","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5113,"kind":2048,"name":"submitJclString","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#submitjclstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5114,"kind":2048,"name":"submitJclCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#submitjclcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5115,"kind":2048,"name":"submitJclNotify","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#submitjclnotify","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5116,"kind":2048,"name":"submitJclNotifyCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#submitjclnotifycommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5117,"kind":2048,"name":"submitJobNotify","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#submitjobnotify","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5118,"kind":2048,"name":"submitUSSJobNotify","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#submitussjobnotify","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5119,"kind":2048,"name":"submitJobNotifyCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#submitjobnotifycommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5120,"kind":2048,"name":"checkSubmitOptions","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#checksubmitoptions","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5121,"kind":2048,"name":"submitNotifyCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#submitnotifycommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5122,"kind":2048,"name":"getSubstitutionHeaders","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#getsubstitutionheaders","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5123,"kind":2048,"name":"formSubstitutionHeader","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#formsubstitutionheader","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5124,"kind":262144,"name":"log","url":"classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.SubmitJobs"},{"id":5125,"kind":128,"name":"GetJobs","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5126,"kind":2048,"name":"getJobs","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getjobs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5127,"kind":2048,"name":"getJobsByPrefix","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getjobsbyprefix","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5128,"kind":2048,"name":"getJobsByOwner","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getjobsbyowner","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5129,"kind":2048,"name":"getJobsByOwnerAndPrefix","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getjobsbyownerandprefix","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5130,"kind":2048,"name":"getJobsByParameters","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getjobsbyparameters","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5131,"kind":2048,"name":"getJob","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getjob","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5132,"kind":2048,"name":"getJobsCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getjobscommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5133,"kind":2048,"name":"getStatus","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getstatus","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5134,"kind":2048,"name":"getStatusForJob","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getstatusforjob","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5135,"kind":2048,"name":"getStatusCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getstatuscommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5136,"kind":2048,"name":"getSpoolFiles","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getspoolfiles","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5137,"kind":2048,"name":"getSpoolFilesForJob","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getspoolfilesforjob","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5138,"kind":2048,"name":"getSpoolFilesCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getspoolfilescommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5139,"kind":2048,"name":"getJcl","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getjcl","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5140,"kind":2048,"name":"getJclForJob","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getjclforjob","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5141,"kind":2048,"name":"getJclCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getjclcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5142,"kind":2048,"name":"getSpoolContent","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getspoolcontent","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5143,"kind":2048,"name":"getSpoolContentById","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getspoolcontentbyid","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5144,"kind":2048,"name":"getSpoolContentCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#getspoolcontentcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5145,"kind":2048,"name":"filterResultsByStatuses","url":"classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html#filterresultsbystatuses","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.GetJobs"},{"id":5146,"kind":128,"name":"DownloadJobs","url":"classes/_zowe_zos_jobs_for_zowe_sdk.downloadjobs.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-jobs-for-zowe-sdk"},{"id":5147,"kind":1024,"name":"DEFAULT_JOBS_OUTPUT_DIR","url":"classes/_zowe_zos_jobs_for_zowe_sdk.downloadjobs.html#default_jobs_output_dir","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.DownloadJobs"},{"id":5148,"kind":1024,"name":"DEFAULT_JOBS_OUTPUT_FILE_EXT","url":"classes/_zowe_zos_jobs_for_zowe_sdk.downloadjobs.html#default_jobs_output_file_ext","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.DownloadJobs"},{"id":5149,"kind":2048,"name":"downloadSpoolContent","url":"classes/_zowe_zos_jobs_for_zowe_sdk.downloadjobs.html#downloadspoolcontent","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.DownloadJobs"},{"id":5150,"kind":2048,"name":"downloadAllSpoolContentCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.downloadjobs.html#downloadallspoolcontentcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.DownloadJobs"},{"id":5151,"kind":2048,"name":"downloadSpoolContentCommon","url":"classes/_zowe_zos_jobs_for_zowe_sdk.downloadjobs.html#downloadspoolcontentcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.DownloadJobs"},{"id":5152,"kind":2048,"name":"getSpoolDownloadFile","url":"classes/_zowe_zos_jobs_for_zowe_sdk.downloadjobs.html#getspooldownloadfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.DownloadJobs"},{"id":5153,"kind":2048,"name":"getSpoolDownloadFilePath","url":"classes/_zowe_zos_jobs_for_zowe_sdk.downloadjobs.html#getspooldownloadfilepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.DownloadJobs"},{"id":5154,"kind":262144,"name":"log","url":"classes/_zowe_zos_jobs_for_zowe_sdk.downloadjobs.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-jobs-for-zowe-sdk.DownloadJobs"},{"id":5155,"kind":1,"name":"@zowe/zos-logs-for-zowe-sdk","url":"modules/_zowe_zos_logs_for_zowe_sdk.html","classes":"tsd-kind-module"},{"id":5156,"kind":256,"name":"IZosLogItemType","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-logs-for-zowe-sdk"},{"id":5157,"kind":1024,"name":"cart","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html#cart","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogItemType"},{"id":5158,"kind":1024,"name":"color","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html#color","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogItemType"},{"id":5159,"kind":1024,"name":"jobName","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogItemType"},{"id":5160,"kind":1024,"name":"message","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogItemType"},{"id":5161,"kind":1024,"name":"messageId","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html#messageid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogItemType"},{"id":5162,"kind":1024,"name":"replyId","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html#replyid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogItemType"},{"id":5163,"kind":1024,"name":"system","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html#system","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogItemType"},{"id":5164,"kind":1024,"name":"type","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogItemType"},{"id":5165,"kind":1024,"name":"subType","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html#subtype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogItemType"},{"id":5166,"kind":1024,"name":"time","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html#time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogItemType"},{"id":5167,"kind":1024,"name":"timestamp","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html#timestamp","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogItemType"},{"id":5168,"kind":256,"name":"IZosLogType","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogtype.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-logs-for-zowe-sdk"},{"id":5169,"kind":1024,"name":"timezone","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogtype.html#timezone","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogType"},{"id":5170,"kind":1024,"name":"nextTimestamp","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogtype.html#nexttimestamp","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogType"},{"id":5171,"kind":1024,"name":"source","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogtype.html#source","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogType"},{"id":5172,"kind":1024,"name":"totalitems","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogtype.html#totalitems","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogType"},{"id":5173,"kind":1024,"name":"items","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogtype.html#items","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogType"},{"id":5174,"kind":256,"name":"IZosLogParms","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-logs-for-zowe-sdk"},{"id":5175,"kind":1024,"name":"startTime","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogparms.html#starttime","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogParms"},{"id":5176,"kind":1024,"name":"direction","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogparms.html#direction","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogParms"},{"id":5177,"kind":1024,"name":"range","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogparms.html#range","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogParms"},{"id":5178,"kind":1024,"name":"processResponses","url":"interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogparms.html#processresponses","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-logs-for-zowe-sdk.IZosLogParms"},{"id":5179,"kind":128,"name":"GetZosLogValidator","url":"classes/_zowe_zos_logs_for_zowe_sdk.getzoslogvalidator.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-logs-for-zowe-sdk"},{"id":5180,"kind":2048,"name":"validateSession","url":"classes/_zowe_zos_logs_for_zowe_sdk.getzoslogvalidator.html#validatesession","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-logs-for-zowe-sdk.GetZosLogValidator"},{"id":5181,"kind":128,"name":"ZosLogConstants","url":"classes/_zowe_zos_logs_for_zowe_sdk.zoslogconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-logs-for-zowe-sdk"},{"id":5182,"kind":1024,"name":"RESOURCE","url":"classes/_zowe_zos_logs_for_zowe_sdk.zoslogconstants.html#resource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-logs-for-zowe-sdk.ZosLogConstants"},{"id":5183,"kind":2097152,"name":"noSessionMessage","url":"modules/_zowe_zos_logs_for_zowe_sdk.html#nosessionmessage","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-logs-for-zowe-sdk"},{"id":5184,"kind":32,"name":"message","url":"modules/_zowe_zos_logs_for_zowe_sdk.html#nosessionmessage.message","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-logs-for-zowe-sdk.noSessionMessage"},{"id":5185,"kind":128,"name":"GetZosLog","url":"classes/_zowe_zos_logs_for_zowe_sdk.getzoslog.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-logs-for-zowe-sdk"},{"id":5186,"kind":2048,"name":"getZosLog","url":"classes/_zowe_zos_logs_for_zowe_sdk.getzoslog.html#getzoslog","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-logs-for-zowe-sdk.GetZosLog"},{"id":5187,"kind":2048,"name":"getResourcePath","url":"classes/_zowe_zos_logs_for_zowe_sdk.getzoslog.html#getresourcepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-logs-for-zowe-sdk.GetZosLog"},{"id":5188,"kind":1,"name":"@zowe/zos-tso-for-zowe-sdk","url":"modules/_zowe_zos_tso_for_zowe_sdk.html","classes":"tsd-kind-module"},{"id":5189,"kind":256,"name":"IStartTsoParms","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istarttsoparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5190,"kind":1024,"name":"logonProcedure","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istarttsoparms.html#logonprocedure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartTsoParms"},{"id":5191,"kind":1024,"name":"characterSet","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istarttsoparms.html#characterset","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartTsoParms"},{"id":5192,"kind":1024,"name":"codePage","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istarttsoparms.html#codepage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartTsoParms"},{"id":5193,"kind":1024,"name":"rows","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istarttsoparms.html#rows","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartTsoParms"},{"id":5194,"kind":1024,"name":"columns","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istarttsoparms.html#columns","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartTsoParms"},{"id":5195,"kind":1024,"name":"account","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istarttsoparms.html#account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartTsoParms"},{"id":5196,"kind":1024,"name":"regionSize","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istarttsoparms.html#regionsize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartTsoParms"},{"id":5197,"kind":128,"name":"TsoConstants","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5198,"kind":1024,"name":"PARM_PROC","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#parm_proc","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5199,"kind":1024,"name":"PARM_CHSET","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#parm_chset","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5200,"kind":1024,"name":"PARM_CPAGE","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#parm_cpage","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5201,"kind":1024,"name":"PARM_ROWS","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#parm_rows","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5202,"kind":1024,"name":"PARM_COLS","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#parm_cols","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5203,"kind":1024,"name":"PARM_ACCT","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#parm_acct","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5204,"kind":1024,"name":"PARM_RSIZE","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#parm_rsize","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5205,"kind":1024,"name":"DEFAULT_CHSET","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#default_chset","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5206,"kind":1024,"name":"DEFAULT_CPAGE","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#default_cpage","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5207,"kind":1024,"name":"DEFAULT_ROWS","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#default_rows","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5208,"kind":1024,"name":"DEFAULT_COLS","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#default_cols","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5209,"kind":1024,"name":"DEFAULT_RSIZE","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#default_rsize","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5210,"kind":1024,"name":"DEFAULT_PROC","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#default_proc","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5211,"kind":1024,"name":"RESOURCE","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#resource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5212,"kind":1024,"name":"RES_START_TSO","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#res_start_tso","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5213,"kind":1024,"name":"RES_DONT_READ_REPLY","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#res_dont_read_reply","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5214,"kind":1024,"name":"RES_PING","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#res_ping","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5215,"kind":1024,"name":"TSO_PROMPT","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#tso_prompt","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5216,"kind":1024,"name":"TSO_MESSAGE","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html#tso_message","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoConstants"},{"id":5217,"kind":2097152,"name":"noSessionTso","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#nosessiontso","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5218,"kind":32,"name":"message","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#nosessiontso.message-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.noSessionTso"},{"id":5219,"kind":2097152,"name":"noTsoStartInput","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#notsostartinput","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5220,"kind":32,"name":"message","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#notsostartinput.message-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.noTsoStartInput"},{"id":5221,"kind":2097152,"name":"noTsoIssueInput","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#notsoissueinput","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5222,"kind":32,"name":"message","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#notsoissueinput.message-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.noTsoIssueInput"},{"id":5223,"kind":2097152,"name":"noTsoStopInput","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#notsostopinput","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5224,"kind":32,"name":"message","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#notsostopinput.message-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.noTsoStopInput"},{"id":5225,"kind":2097152,"name":"noZosmfResponse","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#nozosmfresponse","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5226,"kind":32,"name":"message","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#nozosmfresponse.message-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.noZosmfResponse"},{"id":5227,"kind":2097152,"name":"noPingInput","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#nopinginput","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5228,"kind":32,"name":"message","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#nopinginput.message-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.noPingInput"},{"id":5229,"kind":2097152,"name":"noAccountNumber","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#noaccountnumber","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5230,"kind":32,"name":"message","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#noaccountnumber.message","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.noAccountNumber"},{"id":5231,"kind":2097152,"name":"noServletKeyInput","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#noservletkeyinput","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5232,"kind":32,"name":"message","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#noservletkeyinput.message-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.noServletKeyInput"},{"id":5233,"kind":2097152,"name":"noDataInput","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#nodatainput","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5234,"kind":32,"name":"message","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#nodatainput.message-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.noDataInput"},{"id":5235,"kind":2097152,"name":"noCommandInput","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#nocommandinput","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5236,"kind":32,"name":"message","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#nocommandinput.message-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.noCommandInput"},{"id":5237,"kind":256,"name":"IStopTsoParms","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istoptsoparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5238,"kind":1024,"name":"servletKey","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istoptsoparms.html#servletkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStopTsoParms"},{"id":5239,"kind":256,"name":"IIssueTsoParms","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.iissuetsoparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5240,"kind":1024,"name":"command","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.iissuetsoparms.html#command","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IIssueTsoParms"},{"id":5241,"kind":1024,"name":"accountNumber","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.iissuetsoparms.html#accountnumber","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IIssueTsoParms"},{"id":5242,"kind":1024,"name":"startParams","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.iissuetsoparms.html#startparams","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IIssueTsoParms"},{"id":5243,"kind":256,"name":"IZosmfMessages","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfmessages.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5244,"kind":1024,"name":"messageText","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfmessages.html#messagetext","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfMessages"},{"id":5245,"kind":1024,"name":"messageId","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfmessages.html#messageid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfMessages"},{"id":5246,"kind":1024,"name":"stackTrace","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfmessages.html#stacktrace","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfMessages"},{"id":5247,"kind":256,"name":"IZosmfPingResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfpingresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5248,"kind":1024,"name":"servletKey","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfpingresponse.html#servletkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfPingResponse"},{"id":5249,"kind":1024,"name":"ver","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfpingresponse.html#ver","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfPingResponse"},{"id":5250,"kind":1024,"name":"msgData","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfpingresponse.html#msgdata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfPingResponse"},{"id":5251,"kind":1024,"name":"reused","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfpingresponse.html#reused","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfPingResponse"},{"id":5252,"kind":1024,"name":"timeout","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfpingresponse.html#timeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfPingResponse"},{"id":5253,"kind":128,"name":"TsoProfileConstants","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5254,"kind":1024,"name":"TSO_OPTION_GROUP","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_group","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants"},{"id":5255,"kind":2097152,"name":"TSO_OPTION_ACCOUNT","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_account","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants"},{"id":5256,"kind":32,"name":"name","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_account.name","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_ACCOUNT"},{"id":5257,"kind":32,"name":"aliases","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_account.aliases","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_ACCOUNT"},{"id":5258,"kind":32,"name":"description","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_account.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_ACCOUNT"},{"id":5259,"kind":32,"name":"type","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_account.type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_ACCOUNT"},{"id":5260,"kind":32,"name":"required","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_account.required","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_ACCOUNT"},{"id":5261,"kind":32,"name":"group","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_account.group","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_ACCOUNT"},{"id":5262,"kind":2097152,"name":"TSO_OPTION_ACCOUNT_PROFILE","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_account_profile","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants"},{"id":5263,"kind":32,"name":"required","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_account_profile.required-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_ACCOUNT_PROFILE"},{"id":5264,"kind":2097152,"name":"TSO_OPTION_CHAR_SET","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_char_set","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants"},{"id":5265,"kind":32,"name":"name","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_char_set.name-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_CHAR_SET"},{"id":5266,"kind":32,"name":"aliases","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_char_set.aliases-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_CHAR_SET"},{"id":5267,"kind":32,"name":"description","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_char_set.description-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_CHAR_SET"},{"id":5268,"kind":32,"name":"type","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_char_set.type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_CHAR_SET"},{"id":5269,"kind":32,"name":"defaultValue","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_char_set.defaultvalue","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_CHAR_SET"},{"id":5270,"kind":32,"name":"group","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_char_set.group-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_CHAR_SET"},{"id":5271,"kind":2097152,"name":"TSO_OPTION_CODE_PAGE","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_code_page","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants"},{"id":5272,"kind":32,"name":"name","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_code_page.name-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_CODE_PAGE"},{"id":5273,"kind":32,"name":"aliases","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_code_page.aliases-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_CODE_PAGE"},{"id":5274,"kind":32,"name":"description","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_code_page.description-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_CODE_PAGE"},{"id":5275,"kind":32,"name":"type","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_code_page.type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_CODE_PAGE"},{"id":5276,"kind":32,"name":"defaultValue","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_code_page.defaultvalue-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_CODE_PAGE"},{"id":5277,"kind":32,"name":"group","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_code_page.group-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_CODE_PAGE"},{"id":5278,"kind":2097152,"name":"TSO_OPTION_COLUMNS","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_columns","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants"},{"id":5279,"kind":32,"name":"name","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_columns.name-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_COLUMNS"},{"id":5280,"kind":32,"name":"aliases","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_columns.aliases-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_COLUMNS"},{"id":5281,"kind":32,"name":"description","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_columns.description-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_COLUMNS"},{"id":5282,"kind":32,"name":"type","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_columns.type-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_COLUMNS"},{"id":5283,"kind":32,"name":"defaultValue","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_columns.defaultvalue-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_COLUMNS"},{"id":5284,"kind":32,"name":"group","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_columns.group-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_COLUMNS"},{"id":5285,"kind":2097152,"name":"TSO_OPTION_LOGON_PROCEDURE","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_logon_procedure","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants"},{"id":5286,"kind":32,"name":"name","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_logon_procedure.name-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_LOGON_PROCEDURE"},{"id":5287,"kind":32,"name":"aliases","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_logon_procedure.aliases-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_LOGON_PROCEDURE"},{"id":5288,"kind":32,"name":"description","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_logon_procedure.description-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_LOGON_PROCEDURE"},{"id":5289,"kind":32,"name":"type","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_logon_procedure.type-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_LOGON_PROCEDURE"},{"id":5290,"kind":32,"name":"defaultValue","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_logon_procedure.defaultvalue-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_LOGON_PROCEDURE"},{"id":5291,"kind":32,"name":"group","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_logon_procedure.group-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_LOGON_PROCEDURE"},{"id":5292,"kind":2097152,"name":"TSO_OPTION_REGION_SIZE","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_region_size","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants"},{"id":5293,"kind":32,"name":"name","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_region_size.name-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_REGION_SIZE"},{"id":5294,"kind":32,"name":"aliases","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_region_size.aliases-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_REGION_SIZE"},{"id":5295,"kind":32,"name":"description","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_region_size.description-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_REGION_SIZE"},{"id":5296,"kind":32,"name":"type","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_region_size.type-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_REGION_SIZE"},{"id":5297,"kind":32,"name":"defaultValue","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_region_size.defaultvalue-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_REGION_SIZE"},{"id":5298,"kind":32,"name":"group","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_region_size.group-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_REGION_SIZE"},{"id":5299,"kind":2097152,"name":"TSO_OPTION_ROWS","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_rows","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants"},{"id":5300,"kind":32,"name":"name","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_rows.name-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_ROWS"},{"id":5301,"kind":32,"name":"description","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_rows.description-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_ROWS"},{"id":5302,"kind":32,"name":"type","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_rows.type-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_ROWS"},{"id":5303,"kind":32,"name":"defaultValue","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_rows.defaultvalue-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_ROWS"},{"id":5304,"kind":32,"name":"group","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_option_rows.group-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants.TSO_OPTION_ROWS"},{"id":5305,"kind":1024,"name":"TSO_PROFILE_OPTIONS","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html#tso_profile_options","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoProfileConstants"},{"id":5306,"kind":2097152,"name":"ZosTsoProfile","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5307,"kind":32,"name":"type","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile"},{"id":5308,"kind":2097152,"name":"schema","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile"},{"id":5309,"kind":32,"name":"type","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema"},{"id":5310,"kind":32,"name":"title","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.title","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema"},{"id":5311,"kind":32,"name":"description","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema"},{"id":5312,"kind":2097152,"name":"properties","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema"},{"id":5313,"kind":2097152,"name":"account","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.account","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties"},{"id":5314,"kind":32,"name":"type","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.account.type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.account"},{"id":5315,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.account.optiondefinition","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.account"},{"id":5316,"kind":32,"name":"includeInTemplate","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.account.includeintemplate","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.account"},{"id":5317,"kind":2097152,"name":"characterSet","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.characterset","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties"},{"id":5318,"kind":32,"name":"type","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.characterset.type-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.characterSet"},{"id":5319,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.characterset.optiondefinition-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.characterSet"},{"id":5320,"kind":2097152,"name":"codePage","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.codepage","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties"},{"id":5321,"kind":32,"name":"type","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.codepage.type-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.codePage"},{"id":5322,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.codepage.optiondefinition-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.codePage"},{"id":5323,"kind":32,"name":"includeInTemplate","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.codepage.includeintemplate-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.codePage"},{"id":5324,"kind":2097152,"name":"columns","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.columns","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties"},{"id":5325,"kind":32,"name":"type","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.columns.type-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.columns"},{"id":5326,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.columns.optiondefinition-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.columns"},{"id":5327,"kind":2097152,"name":"logonProcedure","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.logonprocedure","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties"},{"id":5328,"kind":32,"name":"type","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.logonprocedure.type-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.logonProcedure"},{"id":5329,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.logonprocedure.optiondefinition-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.logonProcedure"},{"id":5330,"kind":32,"name":"includeInTemplate","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.logonprocedure.includeintemplate-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.logonProcedure"},{"id":5331,"kind":2097152,"name":"regionSize","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.regionsize","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties"},{"id":5332,"kind":32,"name":"type","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.regionsize.type-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.regionSize"},{"id":5333,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.regionsize.optiondefinition-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.regionSize"},{"id":5334,"kind":2097152,"name":"rows","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.rows","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties"},{"id":5335,"kind":32,"name":"type","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.rows.type-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.rows"},{"id":5336,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.properties.rows.optiondefinition-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema.properties.rows"},{"id":5337,"kind":32,"name":"required","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.schema.required","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile.schema"},{"id":5338,"kind":32,"name":"createProfileExamples","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.createprofileexamples","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile"},{"id":5339,"kind":32,"name":"updateProfileExamples","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#zostsoprofile.updateprofileexamples","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoProfile"},{"id":5340,"kind":256,"name":"ISendTsoParms","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.isendtsoparms.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5341,"kind":1024,"name":"servletKey","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.isendtsoparms.html#servletkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ISendTsoParms"},{"id":5342,"kind":1024,"name":"data","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.isendtsoparms.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ISendTsoParms"},{"id":5343,"kind":256,"name":"ISendResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.isendresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5344,"kind":1024,"name":"success","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.isendresponse.html#success","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ISendResponse"},{"id":5345,"kind":1024,"name":"zosmfResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.isendresponse.html#zosmfresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ISendResponse"},{"id":5346,"kind":1024,"name":"commandResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.isendresponse.html#commandresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ISendResponse"},{"id":5347,"kind":4194304,"name":"SendResponse","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#sendresponse","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5348,"kind":65536,"name":"__type","url":"modules/_zowe_zos_tso_for_zowe_sdk.html#sendresponse.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"@zowe/zos-tso-for-zowe-sdk.SendResponse"},{"id":5349,"kind":256,"name":"ITsoMessage","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5350,"kind":1024,"name":"VERSION","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessage.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ITsoMessage"},{"id":5351,"kind":1024,"name":"DATA","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ITsoMessage"},{"id":5352,"kind":256,"name":"ITsoMessages","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessages.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5353,"kind":1024,"name":"TSO MESSAGE","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessages.html#tso_message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ITsoMessages"},{"id":5354,"kind":1024,"name":"TSO PROMPT","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessages.html#tso_prompt","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ITsoMessages"},{"id":5355,"kind":1024,"name":"TSO RESPONSE","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessages.html#tso_response","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ITsoMessages"},{"id":5356,"kind":256,"name":"ITsoPromptMessage","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsopromptmessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5357,"kind":1024,"name":"VERSION","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsopromptmessage.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ITsoPromptMessage"},{"id":5358,"kind":1024,"name":"HIDDEN","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsopromptmessage.html#hidden","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ITsoPromptMessage"},{"id":5359,"kind":256,"name":"ITsoResponseMessage","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsoresponsemessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5360,"kind":1024,"name":"VERSION","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsoresponsemessage.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ITsoResponseMessage"},{"id":5361,"kind":1024,"name":"DATA","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.itsoresponsemessage.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ITsoResponseMessage"},{"id":5362,"kind":256,"name":"ICollectedResponses","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.icollectedresponses.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5363,"kind":1024,"name":"tsos","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.icollectedresponses.html#tsos","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ICollectedResponses"},{"id":5364,"kind":1024,"name":"messages","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.icollectedresponses.html#messages","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.ICollectedResponses"},{"id":5365,"kind":256,"name":"IStartStopResponses","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponses.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5366,"kind":1024,"name":"success","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponses.html#success","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartStopResponses"},{"id":5367,"kind":1024,"name":"zosmfTsoResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponses.html#zosmftsoresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartStopResponses"},{"id":5368,"kind":1024,"name":"collectedResponses","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponses.html#collectedresponses","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartStopResponses"},{"id":5369,"kind":1024,"name":"failureResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponses.html#failureresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartStopResponses"},{"id":5370,"kind":1024,"name":"servletKey","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponses.html#servletkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartStopResponses"},{"id":5371,"kind":1024,"name":"messages","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponses.html#messages","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartStopResponses"},{"id":5372,"kind":256,"name":"IIssueResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.iissueresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5373,"kind":1024,"name":"success","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.iissueresponse.html#success","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IIssueResponse"},{"id":5374,"kind":1024,"name":"startResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.iissueresponse.html#startresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IIssueResponse"},{"id":5375,"kind":1024,"name":"startReady","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.iissueresponse.html#startready","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IIssueResponse"},{"id":5376,"kind":1024,"name":"stopResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.iissueresponse.html#stopresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IIssueResponse"},{"id":5377,"kind":1024,"name":"zosmfResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.iissueresponse.html#zosmfresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IIssueResponse"},{"id":5378,"kind":1024,"name":"commandResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.iissueresponse.html#commandresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IIssueResponse"},{"id":5379,"kind":256,"name":"IPingResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.ipingresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5380,"kind":1024,"name":"success","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.ipingresponse.html#success","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IPingResponse"},{"id":5381,"kind":1024,"name":"zosmfPingResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.ipingresponse.html#zosmfpingresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IPingResponse"},{"id":5382,"kind":1024,"name":"failureResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.ipingresponse.html#failureresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IPingResponse"},{"id":5383,"kind":1024,"name":"servletKey","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.ipingresponse.html#servletkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IPingResponse"},{"id":5384,"kind":256,"name":"IStartStopResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5385,"kind":1024,"name":"success","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponse.html#success","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartStopResponse"},{"id":5386,"kind":1024,"name":"zosmfTsoResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponse.html#zosmftsoresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartStopResponse"},{"id":5387,"kind":1024,"name":"failureResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponse.html#failureresponse","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartStopResponse"},{"id":5388,"kind":1024,"name":"servletKey","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponse.html#servletkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IStartStopResponse"},{"id":5389,"kind":128,"name":"TsoResponseService","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoresponseservice.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5390,"kind":2048,"name":"populateStartAndStop","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoresponseservice.html#populatestartandstop","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoResponseService"},{"id":5391,"kind":2048,"name":"populateStartAndStopCollectAll","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoresponseservice.html#populatestartandstopcollectall","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoResponseService"},{"id":5392,"kind":2048,"name":"populatePing","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsoresponseservice.html#populateping","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoResponseService"},{"id":5393,"kind":128,"name":"PingTso","url":"classes/_zowe_zos_tso_for_zowe_sdk.pingtso.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5394,"kind":2048,"name":"ping","url":"classes/_zowe_zos_tso_for_zowe_sdk.pingtso.html#ping","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.PingTso"},{"id":5395,"kind":2048,"name":"getResource","url":"classes/_zowe_zos_tso_for_zowe_sdk.pingtso.html#getresource","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.PingTso"},{"id":5396,"kind":128,"name":"StartTso","url":"classes/_zowe_zos_tso_for_zowe_sdk.starttso.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5397,"kind":2048,"name":"startCommon","url":"classes/_zowe_zos_tso_for_zowe_sdk.starttso.html#startcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.StartTso"},{"id":5398,"kind":2048,"name":"start","url":"classes/_zowe_zos_tso_for_zowe_sdk.starttso.html#start","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.StartTso"},{"id":5399,"kind":2048,"name":"setDefaultAddressSpaceParams","url":"classes/_zowe_zos_tso_for_zowe_sdk.starttso.html#setdefaultaddressspaceparams","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.StartTso"},{"id":5400,"kind":2048,"name":"getResourcesQuery","url":"classes/_zowe_zos_tso_for_zowe_sdk.starttso.html#getresourcesquery","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.StartTso"},{"id":5401,"kind":128,"name":"StopTso","url":"classes/_zowe_zos_tso_for_zowe_sdk.stoptso.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5402,"kind":2048,"name":"stopCommon","url":"classes/_zowe_zos_tso_for_zowe_sdk.stoptso.html#stopcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.StopTso"},{"id":5403,"kind":2048,"name":"stop","url":"classes/_zowe_zos_tso_for_zowe_sdk.stoptso.html#stop","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.StopTso"},{"id":5404,"kind":2048,"name":"getResources","url":"classes/_zowe_zos_tso_for_zowe_sdk.stoptso.html#getresources","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.StopTso"},{"id":5405,"kind":128,"name":"ZosTsoBaseHandler","url":"classes/_zowe_zos_tso_for_zowe_sdk.zostsobasehandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5406,"kind":1024,"name":"mTsoStart","url":"classes/_zowe_zos_tso_for_zowe_sdk.zostsobasehandler.html#mtsostart","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoBaseHandler"},{"id":5407,"kind":2048,"name":"process","url":"classes/_zowe_zos_tso_for_zowe_sdk.zostsobasehandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/zos-tso-for-zowe-sdk.ZosTsoBaseHandler"},{"id":5408,"kind":256,"name":"IZosmfTsoResponse","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5409,"kind":1024,"name":"servletKey","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html#servletkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfTsoResponse"},{"id":5410,"kind":1024,"name":"queueID","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html#queueid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfTsoResponse"},{"id":5411,"kind":1024,"name":"ver","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html#ver","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfTsoResponse"},{"id":5412,"kind":1024,"name":"reused","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html#reused","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfTsoResponse"},{"id":5413,"kind":1024,"name":"timeout","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html#timeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfTsoResponse"},{"id":5414,"kind":1024,"name":"msgData","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html#msgdata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfTsoResponse"},{"id":5415,"kind":1024,"name":"sessionID","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html#sessionid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfTsoResponse"},{"id":5416,"kind":1024,"name":"tsoData","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html#tsodata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfTsoResponse"},{"id":5417,"kind":1024,"name":"appData","url":"interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html#appdata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-tso-for-zowe-sdk.IZosmfTsoResponse"},{"id":5418,"kind":128,"name":"TsoValidator","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5419,"kind":2048,"name":"validateSession","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html#validatesession","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoValidator"},{"id":5420,"kind":2048,"name":"validateStartParams","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html#validatestartparams","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoValidator"},{"id":5421,"kind":2048,"name":"validateIssueParams","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html#validateissueparams","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoValidator"},{"id":5422,"kind":2048,"name":"validateStopParams","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html#validatestopparams","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoValidator"},{"id":5423,"kind":2048,"name":"validateStartZosmfResponse","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html#validatestartzosmfresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoValidator"},{"id":5424,"kind":2048,"name":"validatePingParms","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html#validatepingparms","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoValidator"},{"id":5425,"kind":2048,"name":"validateString","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html#validatestring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoValidator"},{"id":5426,"kind":2048,"name":"validateNotEmptyString","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html#validatenotemptystring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoValidator"},{"id":5427,"kind":2048,"name":"validatePingZosmfResponse","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html#validatepingzosmfresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoValidator"},{"id":5428,"kind":2048,"name":"validateErrorMessageFromZosmf","url":"classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html#validateerrormessagefromzosmf","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.TsoValidator"},{"id":5429,"kind":128,"name":"SendTso","url":"classes/_zowe_zos_tso_for_zowe_sdk.sendtso.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5430,"kind":2048,"name":"sendDataToTSOCollect","url":"classes/_zowe_zos_tso_for_zowe_sdk.sendtso.html#senddatatotsocollect","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.SendTso"},{"id":5431,"kind":2048,"name":"sendDataToTSOCommon","url":"classes/_zowe_zos_tso_for_zowe_sdk.sendtso.html#senddatatotsocommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.SendTso"},{"id":5432,"kind":2048,"name":"getDataFromTSO","url":"classes/_zowe_zos_tso_for_zowe_sdk.sendtso.html#getdatafromtso","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.SendTso"},{"id":5433,"kind":2048,"name":"getAllResponses","url":"classes/_zowe_zos_tso_for_zowe_sdk.sendtso.html#getallresponses","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.SendTso"},{"id":5434,"kind":2048,"name":"createResponse","url":"classes/_zowe_zos_tso_for_zowe_sdk.sendtso.html#createresponse","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.SendTso"},{"id":5435,"kind":128,"name":"IssueTso","url":"classes/_zowe_zos_tso_for_zowe_sdk.issuetso.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-tso-for-zowe-sdk"},{"id":5436,"kind":2048,"name":"issueTsoCommand","url":"classes/_zowe_zos_tso_for_zowe_sdk.issuetso.html#issuetsocommand","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.IssueTso"},{"id":5437,"kind":2048,"name":"issueTsoCommandCommon","url":"classes/_zowe_zos_tso_for_zowe_sdk.issuetso.html#issuetsocommandcommon","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-tso-for-zowe-sdk.IssueTso"},{"id":5438,"kind":1,"name":"@zowe/zos-uss-for-zowe-sdk","url":"modules/_zowe_zos_uss_for_zowe_sdk.html","classes":"tsd-kind-module"},{"id":5439,"kind":256,"name":"ISshSession","url":"interfaces/_zowe_zos_uss_for_zowe_sdk.isshsession.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-uss-for-zowe-sdk"},{"id":5440,"kind":1024,"name":"hostname","url":"interfaces/_zowe_zos_uss_for_zowe_sdk.isshsession.html#hostname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-uss-for-zowe-sdk.ISshSession"},{"id":5441,"kind":1024,"name":"port","url":"interfaces/_zowe_zos_uss_for_zowe_sdk.isshsession.html#port","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-uss-for-zowe-sdk.ISshSession"},{"id":5442,"kind":1024,"name":"user","url":"interfaces/_zowe_zos_uss_for_zowe_sdk.isshsession.html#user","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-uss-for-zowe-sdk.ISshSession"},{"id":5443,"kind":1024,"name":"password","url":"interfaces/_zowe_zos_uss_for_zowe_sdk.isshsession.html#password","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-uss-for-zowe-sdk.ISshSession"},{"id":5444,"kind":1024,"name":"privateKey","url":"interfaces/_zowe_zos_uss_for_zowe_sdk.isshsession.html#privatekey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-uss-for-zowe-sdk.ISshSession"},{"id":5445,"kind":1024,"name":"keyPassphrase","url":"interfaces/_zowe_zos_uss_for_zowe_sdk.isshsession.html#keypassphrase","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-uss-for-zowe-sdk.ISshSession"},{"id":5446,"kind":1024,"name":"handshakeTimeout","url":"interfaces/_zowe_zos_uss_for_zowe_sdk.isshsession.html#handshaketimeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-uss-for-zowe-sdk.ISshSession"},{"id":5447,"kind":128,"name":"SshSession","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-uss-for-zowe-sdk"},{"id":5448,"kind":1024,"name":"DEFAULT_SSH_PORT","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#default_ssh_port","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5449,"kind":262144,"name":"ISshSession","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#isshsession","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5450,"kind":1024,"name":"SSH_CONNECTION_OPTION_GROUP","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_connection_option_group","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5451,"kind":2097152,"name":"SSH_OPTION_HOST","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_host","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5452,"kind":32,"name":"name","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_host.name-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_HOST"},{"id":5453,"kind":32,"name":"aliases","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_host.aliases-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_HOST"},{"id":5454,"kind":32,"name":"description","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_host.description-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_HOST"},{"id":5455,"kind":32,"name":"type","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_host.type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_HOST"},{"id":5456,"kind":32,"name":"required","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_host.required","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_HOST"},{"id":5457,"kind":32,"name":"group","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_host.group-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_HOST"},{"id":5458,"kind":1024,"name":"SSH_OPTION_HOST_PROFILE","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_host_profile","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5459,"kind":2097152,"name":"SSH_OPTION_PORT","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_port","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5460,"kind":32,"name":"name","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_port.name-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PORT"},{"id":5461,"kind":32,"name":"aliases","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_port.aliases-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PORT"},{"id":5462,"kind":32,"name":"description","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_port.description-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PORT"},{"id":5463,"kind":32,"name":"type","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_port.type-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PORT"},{"id":5464,"kind":32,"name":"defaultValue","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_port.defaultvalue","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PORT"},{"id":5465,"kind":32,"name":"group","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_port.group-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PORT"},{"id":5466,"kind":2097152,"name":"SSH_OPTION_USER","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_user","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5467,"kind":32,"name":"name","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_user.name-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_USER"},{"id":5468,"kind":32,"name":"aliases","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_user.aliases-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_USER"},{"id":5469,"kind":32,"name":"description","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_user.description-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_USER"},{"id":5470,"kind":32,"name":"type","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_user.type-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_USER"},{"id":5471,"kind":32,"name":"required","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_user.required-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_USER"},{"id":5472,"kind":32,"name":"group","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_user.group-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_USER"},{"id":5473,"kind":1024,"name":"SSH_OPTION_USER_PROFILE","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_user_profile","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5474,"kind":2097152,"name":"SSH_OPTION_PASSWORD","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_password","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5475,"kind":32,"name":"name","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_password.name-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PASSWORD"},{"id":5476,"kind":32,"name":"aliases","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_password.aliases-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PASSWORD"},{"id":5477,"kind":32,"name":"description","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_password.description-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PASSWORD"},{"id":5478,"kind":32,"name":"type","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_password.type-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PASSWORD"},{"id":5479,"kind":32,"name":"group","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_password.group-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PASSWORD"},{"id":5480,"kind":2097152,"name":"SSH_OPTION_PRIVATEKEY","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_privatekey","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5481,"kind":32,"name":"name","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_privatekey.name-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PRIVATEKEY"},{"id":5482,"kind":32,"name":"aliases","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_privatekey.aliases-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PRIVATEKEY"},{"id":5483,"kind":32,"name":"description","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_privatekey.description-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PRIVATEKEY"},{"id":5484,"kind":32,"name":"type","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_privatekey.type-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PRIVATEKEY"},{"id":5485,"kind":32,"name":"group","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_privatekey.group-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_PRIVATEKEY"},{"id":5486,"kind":2097152,"name":"SSH_OPTION_KEYPASSPHRASE","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_keypassphrase","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5487,"kind":32,"name":"name","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_keypassphrase.name-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_KEYPASSPHRASE"},{"id":5488,"kind":32,"name":"aliases","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_keypassphrase.aliases-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_KEYPASSPHRASE"},{"id":5489,"kind":32,"name":"description","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_keypassphrase.description-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_KEYPASSPHRASE"},{"id":5490,"kind":32,"name":"type","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_keypassphrase.type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_KEYPASSPHRASE"},{"id":5491,"kind":32,"name":"group","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_keypassphrase.group-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_KEYPASSPHRASE"},{"id":5492,"kind":2097152,"name":"SSH_OPTION_HANDSHAKETIMEOUT","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_handshaketimeout","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5493,"kind":32,"name":"name","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_handshaketimeout.name","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_HANDSHAKETIMEOUT"},{"id":5494,"kind":32,"name":"aliases","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_handshaketimeout.aliases","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_HANDSHAKETIMEOUT"},{"id":5495,"kind":32,"name":"description","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_handshaketimeout.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_HANDSHAKETIMEOUT"},{"id":5496,"kind":32,"name":"type","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_handshaketimeout.type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_HANDSHAKETIMEOUT"},{"id":5497,"kind":32,"name":"group","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_option_handshaketimeout.group","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession.SSH_OPTION_HANDSHAKETIMEOUT"},{"id":5498,"kind":1024,"name":"SSH_CONNECTION_OPTIONS","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#ssh_connection_options","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5499,"kind":2048,"name":"createSshSessCfgFromArgs","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#createsshsesscfgfromargs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5500,"kind":512,"name":"constructor","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5501,"kind":1024,"name":"mISshSession","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#misshsession","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5502,"kind":262144,"name":"log","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5503,"kind":2048,"name":"buildSession","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html#buildsession","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"@zowe/zos-uss-for-zowe-sdk.SshSession"},{"id":5504,"kind":2097152,"name":"ZosUssMessages","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussmessages","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-uss-for-zowe-sdk"},{"id":5505,"kind":2097152,"name":"allAuthMethodsFailed","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussmessages.allauthmethodsfailed","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssMessages"},{"id":5506,"kind":32,"name":"message","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussmessages.allauthmethodsfailed.message","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssMessages.allAuthMethodsFailed"},{"id":5507,"kind":2097152,"name":"connectionRefused","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussmessages.connectionrefused","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssMessages"},{"id":5508,"kind":32,"name":"message","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussmessages.connectionrefused.message-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssMessages.connectionRefused"},{"id":5509,"kind":2097152,"name":"handshakeTimeout","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussmessages.handshaketimeout","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssMessages"},{"id":5510,"kind":32,"name":"message","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussmessages.handshaketimeout.message-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssMessages.handshakeTimeout"},{"id":5511,"kind":2097152,"name":"unexpected","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussmessages.unexpected","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssMessages"},{"id":5512,"kind":32,"name":"message","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussmessages.unexpected.message-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssMessages.unexpected"},{"id":5513,"kind":2097152,"name":"expiredPassword","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussmessages.expiredpassword","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssMessages"},{"id":5514,"kind":32,"name":"message","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussmessages.expiredpassword.message-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssMessages.expiredPassword"},{"id":5515,"kind":128,"name":"Shell","url":"classes/_zowe_zos_uss_for_zowe_sdk.shell.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-uss-for-zowe-sdk"},{"id":5516,"kind":1024,"name":"startCmdFlag","url":"classes/_zowe_zos_uss_for_zowe_sdk.shell.html#startcmdflag","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.Shell"},{"id":5517,"kind":1024,"name":"connRefusedFlag","url":"classes/_zowe_zos_uss_for_zowe_sdk.shell.html#connrefusedflag","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.Shell"},{"id":5518,"kind":1024,"name":"expiredPasswordFlag","url":"classes/_zowe_zos_uss_for_zowe_sdk.shell.html#expiredpasswordflag","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.Shell"},{"id":5519,"kind":2048,"name":"executeSsh","url":"classes/_zowe_zos_uss_for_zowe_sdk.shell.html#executessh","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.Shell"},{"id":5520,"kind":2048,"name":"executeSshCwd","url":"classes/_zowe_zos_uss_for_zowe_sdk.shell.html#executesshcwd","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.Shell"},{"id":5521,"kind":2048,"name":"authenticationHandler","url":"classes/_zowe_zos_uss_for_zowe_sdk.shell.html#authenticationhandler","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zos-uss-for-zowe-sdk.Shell"},{"id":5522,"kind":32,"name":"startCmdFlag","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#startcmdflag","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"@zowe/zos-uss-for-zowe-sdk"},{"id":5523,"kind":128,"name":"SshBaseHandler","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-uss-for-zowe-sdk"},{"id":5524,"kind":1024,"name":"mSession","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html#msession","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/zos-uss-for-zowe-sdk.SshBaseHandler"},{"id":5525,"kind":1024,"name":"mSshProfile","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html#msshprofile","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/zos-uss-for-zowe-sdk.SshBaseHandler"},{"id":5526,"kind":1024,"name":"mArguments","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html#marguments","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/zos-uss-for-zowe-sdk.SshBaseHandler"},{"id":5527,"kind":1024,"name":"mHandlerParams","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html#mhandlerparams","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/zos-uss-for-zowe-sdk.SshBaseHandler"},{"id":5528,"kind":2048,"name":"process","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/zos-uss-for-zowe-sdk.SshBaseHandler"},{"id":5529,"kind":2048,"name":"fail","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html#fail","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/zos-uss-for-zowe-sdk.SshBaseHandler"},{"id":5530,"kind":262144,"name":"console","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html#console","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/zos-uss-for-zowe-sdk.SshBaseHandler"},{"id":5531,"kind":262144,"name":"format","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html#format","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/zos-uss-for-zowe-sdk.SshBaseHandler"},{"id":5532,"kind":262144,"name":"data","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html#data","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/zos-uss-for-zowe-sdk.SshBaseHandler"},{"id":5533,"kind":262144,"name":"progress","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html#progress","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/zos-uss-for-zowe-sdk.SshBaseHandler"},{"id":5534,"kind":2048,"name":"processCmd","url":"classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html#processcmd","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/zos-uss-for-zowe-sdk.SshBaseHandler"},{"id":5535,"kind":2097152,"name":"ZosUssProfile","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-uss-for-zowe-sdk"},{"id":5536,"kind":32,"name":"type","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile"},{"id":5537,"kind":2097152,"name":"schema","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile"},{"id":5538,"kind":32,"name":"type","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema"},{"id":5539,"kind":32,"name":"title","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.title","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema"},{"id":5540,"kind":32,"name":"description","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema"},{"id":5541,"kind":2097152,"name":"properties","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema"},{"id":5542,"kind":2097152,"name":"host","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.host","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties"},{"id":5543,"kind":32,"name":"type","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.host.type-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.host"},{"id":5544,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.host.optiondefinition-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.host"},{"id":5545,"kind":2097152,"name":"port","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.port","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties"},{"id":5546,"kind":32,"name":"type","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.port.type-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.port"},{"id":5547,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.port.optiondefinition-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.port"},{"id":5548,"kind":32,"name":"includeInTemplate","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.port.includeintemplate","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.port"},{"id":5549,"kind":2097152,"name":"user","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.user","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties"},{"id":5550,"kind":32,"name":"type","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.user.type-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.user"},{"id":5551,"kind":32,"name":"secure","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.user.secure-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.user"},{"id":5552,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.user.optiondefinition-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.user"},{"id":5553,"kind":2097152,"name":"password","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.password","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties"},{"id":5554,"kind":32,"name":"type","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.password.type-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.password"},{"id":5555,"kind":32,"name":"secure","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.password.secure-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.password"},{"id":5556,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.password.optiondefinition-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.password"},{"id":5557,"kind":2097152,"name":"privateKey","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.privatekey","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties"},{"id":5558,"kind":32,"name":"type","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.privatekey.type-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.privateKey"},{"id":5559,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.privatekey.optiondefinition-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.privateKey"},{"id":5560,"kind":2097152,"name":"keyPassphrase","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.keypassphrase","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties"},{"id":5561,"kind":32,"name":"type","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.keypassphrase.type-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.keyPassphrase"},{"id":5562,"kind":32,"name":"secure","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.keypassphrase.secure","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.keyPassphrase"},{"id":5563,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.keypassphrase.optiondefinition-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.keyPassphrase"},{"id":5564,"kind":2097152,"name":"handshakeTimeout","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.handshaketimeout-1","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties"},{"id":5565,"kind":32,"name":"type","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.handshaketimeout-1.type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.handshakeTimeout"},{"id":5566,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.properties.handshaketimeout-1.optiondefinition","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema.properties.handshakeTimeout"},{"id":5567,"kind":32,"name":"required","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.schema.required","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile.schema"},{"id":5568,"kind":32,"name":"createProfileExamples","url":"modules/_zowe_zos_uss_for_zowe_sdk.html#zosussprofile.createprofileexamples","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-uss-for-zowe-sdk.ZosUssProfile"},{"id":5569,"kind":1,"name":"@zowe/zos-workflows-for-zowe-sdk","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html","classes":"tsd-kind-module"},{"id":5570,"kind":128,"name":"WorkflowConstants","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5571,"kind":1024,"name":"RESOURCE","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#resource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5572,"kind":1024,"name":"WORKFLOW_DEFINITION","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#workflow_definition","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5573,"kind":1024,"name":"WORKFLOW_RESOURCE","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#workflow_resource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5574,"kind":1024,"name":"ARCH_WORKFLOW_RESOURCE","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#arch_workflow_resource","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5575,"kind":1024,"name":"START_WORKFLOW","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#start_workflow","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5576,"kind":1024,"name":"ARCHIVE_WORKFLOW","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#archive_workflow","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5577,"kind":1024,"name":"CANCEL_WORKFLOW","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#cancel_workflow","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5578,"kind":1024,"name":"LIST_WORKFLOWS","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#list_workflows","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5579,"kind":1024,"name":"category","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#category","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5580,"kind":1024,"name":"system","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#system","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5581,"kind":1024,"name":"owner","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#owner","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5582,"kind":1024,"name":"vendor","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#vendor","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5583,"kind":1024,"name":"statusName","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#statusname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5584,"kind":1024,"name":"workflowKey","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#workflowkey","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5585,"kind":1024,"name":"workflowName","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#workflowname","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5586,"kind":1024,"name":"WF_NAME","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#wf_name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5587,"kind":1024,"name":"ZOSMF_VERSION","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#zosmf_version","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5588,"kind":1024,"name":"returnData","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#returndata","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5589,"kind":1024,"name":"steps","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#steps","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5590,"kind":1024,"name":"variables","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#variables","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5591,"kind":1024,"name":"filePath","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#filepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5592,"kind":1024,"name":"tempPath","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html#temppath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowConstants"},{"id":5593,"kind":2097152,"name":"noWorkflowKey","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#noworkflowkey","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5594,"kind":32,"name":"message","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#noworkflowkey.message-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-workflows-for-zowe-sdk.noWorkflowKey"},{"id":5595,"kind":2097152,"name":"WrongWorkflowKey","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#wrongworkflowkey","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5596,"kind":32,"name":"message","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#wrongworkflowkey.message","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-workflows-for-zowe-sdk.WrongWorkflowKey"},{"id":5597,"kind":2097152,"name":"noSteps","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#nosteps","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5598,"kind":32,"name":"message","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#nosteps.message-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-workflows-for-zowe-sdk.noSteps"},{"id":5599,"kind":2097152,"name":"noVariables","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#novariables","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5600,"kind":32,"name":"message","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#novariables.message-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-workflows-for-zowe-sdk.noVariables"},{"id":5601,"kind":2097152,"name":"noWorkflowDefinitionFile","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#noworkflowdefinitionfile","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5602,"kind":32,"name":"message","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#noworkflowdefinitionfile.message-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-workflows-for-zowe-sdk.noWorkflowDefinitionFile"},{"id":5603,"kind":2097152,"name":"noWorkflowName","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#noworkflowname","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5604,"kind":32,"name":"message","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#noworkflowname.message-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-workflows-for-zowe-sdk.noWorkflowName"},{"id":5605,"kind":2097152,"name":"noSystemName","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#nosystemname","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5606,"kind":32,"name":"message","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#nosystemname.message-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-workflows-for-zowe-sdk.noSystemName"},{"id":5607,"kind":2097152,"name":"wrongString","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#wrongstring","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5608,"kind":32,"name":"message","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#wrongstring.message-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-workflows-for-zowe-sdk.wrongString"},{"id":5609,"kind":2097152,"name":"noOwner","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#noowner","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5610,"kind":32,"name":"message","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#noowner.message-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-workflows-for-zowe-sdk.noOwner"},{"id":5611,"kind":2097152,"name":"wrongOwner","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#wrongowner","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5612,"kind":32,"name":"message","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#wrongowner.message-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zos-workflows-for-zowe-sdk.wrongOwner"},{"id":5613,"kind":128,"name":"WorkflowValidator","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowvalidator.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5614,"kind":2048,"name":"validateSession","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowvalidator.html#validatesession","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowValidator"},{"id":5615,"kind":2048,"name":"validateString","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowvalidator.html#validatestring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowValidator"},{"id":5616,"kind":2048,"name":"validateNotEmptyString","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowvalidator.html#validatenotemptystring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowValidator"},{"id":5617,"kind":2048,"name":"validateParameter","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowvalidator.html#validateparameter","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowValidator"},{"id":5618,"kind":2048,"name":"validateOwner","url":"classes/_zowe_zos_workflows_for_zowe_sdk.workflowvalidator.html#validateowner","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.WorkflowValidator"},{"id":5619,"kind":256,"name":"IArchivedWorkflow","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iarchivedworkflow.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5620,"kind":1024,"name":"workflowKey","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iarchivedworkflow.html#workflowkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IArchivedWorkflow"},{"id":5621,"kind":128,"name":"ArchiveWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.archiveworkflow.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5622,"kind":2048,"name":"archiveWorkflowByKey","url":"classes/_zowe_zos_workflows_for_zowe_sdk.archiveworkflow.html#archiveworkflowbykey","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.ArchiveWorkflow"},{"id":5623,"kind":128,"name":"ArchivedDeleteWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.archiveddeleteworkflow.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5624,"kind":2048,"name":"archivedDeleteWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.archiveddeleteworkflow.html#archiveddeleteworkflow","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.ArchivedDeleteWorkflow"},{"id":5625,"kind":128,"name":"CancelWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.cancelworkflow.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5626,"kind":2048,"name":"cancelWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.cancelworkflow.html#cancelworkflow","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.CancelWorkflow"},{"id":5627,"kind":256,"name":"IVariable","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariable.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5628,"kind":1024,"name":"name","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariable.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariable"},{"id":5629,"kind":1024,"name":"value","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariable.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariable"},{"id":5630,"kind":256,"name":"ICreateWorkflow","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5631,"kind":1024,"name":"workflowName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html#workflowname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreateWorkflow"},{"id":5632,"kind":1024,"name":"workflowDefinitionFile","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html#workflowdefinitionfile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreateWorkflow"},{"id":5633,"kind":1024,"name":"system","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html#system","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreateWorkflow"},{"id":5634,"kind":1024,"name":"owner","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreateWorkflow"},{"id":5635,"kind":1024,"name":"variableInputFile","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html#variableinputfile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreateWorkflow"},{"id":5636,"kind":1024,"name":"variables","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html#variables","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreateWorkflow"},{"id":5637,"kind":1024,"name":"assignToOwner","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html#assigntoowner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreateWorkflow"},{"id":5638,"kind":1024,"name":"accessType","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html#accesstype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreateWorkflow"},{"id":5639,"kind":1024,"name":"deleteCompletedJobs","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html#deletecompletedjobs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreateWorkflow"},{"id":5640,"kind":4194304,"name":"accessT","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#accesst","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5641,"kind":256,"name":"ICreatedWorkflow","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflow.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5642,"kind":1024,"name":"workflowKey","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflow.html#workflowkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreatedWorkflow"},{"id":5643,"kind":1024,"name":"workflowDescription","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflow.html#workflowdescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreatedWorkflow"},{"id":5644,"kind":1024,"name":"workflowID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflow.html#workflowid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreatedWorkflow"},{"id":5645,"kind":1024,"name":"workflowVersion","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflow.html#workflowversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreatedWorkflow"},{"id":5646,"kind":1024,"name":"vendor","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflow.html#vendor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreatedWorkflow"},{"id":5647,"kind":256,"name":"ICreatedWorkflowLocal","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflowlocal.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5648,"kind":1024,"name":"workflowKey","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflowlocal.html#workflowkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreatedWorkflowLocal"},{"id":5649,"kind":1024,"name":"workflowDescription","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflowlocal.html#workflowdescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreatedWorkflowLocal"},{"id":5650,"kind":1024,"name":"workflowID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflowlocal.html#workflowid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreatedWorkflowLocal"},{"id":5651,"kind":1024,"name":"workflowVersion","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflowlocal.html#workflowversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreatedWorkflowLocal"},{"id":5652,"kind":1024,"name":"vendor","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflowlocal.html#vendor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreatedWorkflowLocal"},{"id":5653,"kind":1024,"name":"failedToDelete","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflowlocal.html#failedtodelete","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreatedWorkflowLocal"},{"id":5654,"kind":1024,"name":"filesKept","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflowlocal.html#fileskept","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.ICreatedWorkflowLocal"},{"id":5655,"kind":128,"name":"CreateWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.createworkflow.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5656,"kind":2048,"name":"parseProperties","url":"classes/_zowe_zos_workflows_for_zowe_sdk.createworkflow.html#parseproperties","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.CreateWorkflow"},{"id":5657,"kind":2048,"name":"createWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.createworkflow.html#createworkflow","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.CreateWorkflow"},{"id":5658,"kind":2048,"name":"createWorkflowLocal","url":"classes/_zowe_zos_workflows_for_zowe_sdk.createworkflow.html#createworkflowlocal","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.CreateWorkflow"},{"id":5659,"kind":2048,"name":"getTempFile","url":"classes/_zowe_zos_workflows_for_zowe_sdk.createworkflow.html#gettempfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.CreateWorkflow"},{"id":5660,"kind":2048,"name":"uploadTempFile","url":"classes/_zowe_zos_workflows_for_zowe_sdk.createworkflow.html#uploadtempfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.CreateWorkflow"},{"id":5661,"kind":2048,"name":"deleteTempFile","url":"classes/_zowe_zos_workflows_for_zowe_sdk.createworkflow.html#deletetempfile","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.CreateWorkflow"},{"id":5662,"kind":256,"name":"IVariableSpecification","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariablespecification.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5663,"kind":1024,"name":"name","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariablespecification.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableSpecification"},{"id":5664,"kind":1024,"name":"scope","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariablespecification.html#scope","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableSpecification"},{"id":5665,"kind":1024,"name":"required","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariablespecification.html#required","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableSpecification"},{"id":5666,"kind":256,"name":"IStepApprovers","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepapprovers.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5667,"kind":1024,"name":"approver","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepapprovers.html#approver","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepApprovers"},{"id":5668,"kind":1024,"name":"approverSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepapprovers.html#approversub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepApprovers"},{"id":5669,"kind":256,"name":"IPropertyMapping","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ipropertymapping.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5670,"kind":1024,"name":"mapFrom","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ipropertymapping.html#mapfrom","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IPropertyMapping"},{"id":5671,"kind":1024,"name":"mapTo","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ipropertymapping.html#mapto","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IPropertyMapping"},{"id":5672,"kind":256,"name":"IStepDefinition","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5673,"kind":1024,"name":"name","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5674,"kind":1024,"name":"title","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#title","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5675,"kind":1024,"name":"description","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5676,"kind":1024,"name":"prereqStep","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#prereqstep","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5677,"kind":1024,"name":"optional","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#optional","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5678,"kind":1024,"name":"steps","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#steps","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5679,"kind":1024,"name":"calledWorkflowDescription","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#calledworkflowdescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5680,"kind":1024,"name":"calledWorkflowID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#calledworkflowid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5681,"kind":1024,"name":"calledWorkflowMD5","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#calledworkflowmd5","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5682,"kind":1024,"name":"calledWorkflowDefinitionFile","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#calledworkflowdefinitionfile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5683,"kind":1024,"name":"calledWorkflowVersion","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#calledworkflowversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5684,"kind":1024,"name":"callingStepAutoEnable","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#callingstepautoenable","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5685,"kind":1024,"name":"callingStepWeight","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#callingstepweight","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5686,"kind":1024,"name":"callingStepSkills","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#callingstepskills","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5687,"kind":1024,"name":"actualStatusCode","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#actualstatuscode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5688,"kind":1024,"name":"approvers","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#approvers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5689,"kind":1024,"name":"autoEnable","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#autoenable","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5690,"kind":1024,"name":"expectedStatusCode","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#expectedstatuscode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5691,"kind":1024,"name":"failedPattern","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#failedpattern","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5692,"kind":1024,"name":"hostname","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#hostname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5693,"kind":1024,"name":"httpMethod","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#httpmethod","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5694,"kind":1024,"name":"instructions","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#instructions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5695,"kind":1024,"name":"instructionsSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#instructionssub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5696,"kind":1024,"name":"isConditionStep","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#isconditionstep","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5697,"kind":1024,"name":"isRestStep","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#isreststep","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5698,"kind":1024,"name":"maxLrecl","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#maxlrecl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5699,"kind":1024,"name":"output","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#output","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5700,"kind":1024,"name":"outputSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#outputsub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5701,"kind":1024,"name":"outputVariablesPrefix","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#outputvariablesprefix","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5702,"kind":1024,"name":"port","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#port","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5703,"kind":1024,"name":"portSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#portsub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5704,"kind":1024,"name":"procName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#procname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5705,"kind":1024,"name":"propertyMappings","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#propertymappings","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5706,"kind":1024,"name":"queryParameters","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#queryparameters","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5707,"kind":1024,"name":"queryParametersSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#queryparameterssub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5708,"kind":1024,"name":"regionSize","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#regionsize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5709,"kind":1024,"name":"requestBody","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#requestbody","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5710,"kind":1024,"name":"requestBodySub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#requestbodysub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5711,"kind":1024,"name":"saveAsDataset","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#saveasdataset","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5712,"kind":1024,"name":"saveAsDatasetSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#saveasdatasetsub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5713,"kind":1024,"name":"saveAsUnixFile","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#saveasunixfile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5714,"kind":1024,"name":"saveAsUnixFileSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#saveasunixfilesub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5715,"kind":1024,"name":"schemeName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#schemename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5716,"kind":1024,"name":"schemeNameSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#schemenamesub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5717,"kind":1024,"name":"scriptParameters","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#scriptparameters","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5718,"kind":1024,"name":"skills","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#skills","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5719,"kind":1024,"name":"submitAs","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#submitas","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5720,"kind":1024,"name":"successPattern","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#successpattern","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5721,"kind":1024,"name":"template","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#template","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5722,"kind":1024,"name":"templateSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#templatesub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5723,"kind":1024,"name":"timeout","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#timeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5724,"kind":1024,"name":"uriPath","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#uripath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5725,"kind":1024,"name":"uriPathSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#uripathsub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5726,"kind":1024,"name":"variable-specifications","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#variable_specifications","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5727,"kind":1024,"name":"weight","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html#weight","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepDefinition"},{"id":5728,"kind":256,"name":"IVariableDefinition","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5729,"kind":1024,"name":"name","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5730,"kind":1024,"name":"scope","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#scope","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5731,"kind":1024,"name":"abstract","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#abstract","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5732,"kind":1024,"name":"category","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#category","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5733,"kind":1024,"name":"choice","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#choice","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5734,"kind":1024,"name":"decimalPlaces","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#decimalplaces","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5735,"kind":1024,"name":"default","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#default","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5736,"kind":1024,"name":"description","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5737,"kind":1024,"name":"exposeToUser","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#exposetouser","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5738,"kind":1024,"name":"maxLength","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#maxlength","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5739,"kind":1024,"name":"maxValue","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#maxvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5740,"kind":1024,"name":"minLength","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#minlength","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5741,"kind":1024,"name":"minValue","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#minvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5742,"kind":1024,"name":"promptAtCreate","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#promptatcreate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5743,"kind":1024,"name":"regularExpression","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#regularexpression","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5744,"kind":1024,"name":"requiredAtCreate","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#requiredatcreate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5745,"kind":1024,"name":"type","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5746,"kind":1024,"name":"validationType","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#validationtype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5747,"kind":1024,"name":"visibility","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html#visibility","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableDefinition"},{"id":5748,"kind":256,"name":"IWorkflowDefinition","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5749,"kind":1024,"name":"workflowDefaultName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#workflowdefaultname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5750,"kind":1024,"name":"workflowDescription","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#workflowdescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5751,"kind":1024,"name":"workflowID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#workflowid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5752,"kind":1024,"name":"workflowVersion","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#workflowversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5753,"kind":1024,"name":"workflowDefinitionFileMD5Value","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#workflowdefinitionfilemd5value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5754,"kind":1024,"name":"vendor","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#vendor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5755,"kind":1024,"name":"isCallable","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#iscallable","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5756,"kind":1024,"name":"containsParallelSteps","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#containsparallelsteps","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5757,"kind":1024,"name":"scope","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#scope","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5758,"kind":1024,"name":"category","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#category","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5759,"kind":1024,"name":"productID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#productid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5760,"kind":1024,"name":"productName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#productname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5761,"kind":1024,"name":"productVersion","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#productversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5762,"kind":1024,"name":"steps","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#steps","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5763,"kind":1024,"name":"variables","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html#variables","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowDefinition"},{"id":5764,"kind":128,"name":"DefinitionWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.definitionworkflow.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5765,"kind":2048,"name":"getWorkflowDefinition","url":"classes/_zowe_zos_workflows_for_zowe_sdk.definitionworkflow.html#getworkflowdefinition","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.DefinitionWorkflow"},{"id":5766,"kind":128,"name":"DeleteWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.deleteworkflow.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5767,"kind":2048,"name":"deleteWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.deleteworkflow.html#deleteworkflow","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.DeleteWorkflow"},{"id":5768,"kind":256,"name":"IWorkflowsInfo","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5769,"kind":1024,"name":"owner","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowsInfo"},{"id":5770,"kind":1024,"name":"workflowKey","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html#workflowkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowsInfo"},{"id":5771,"kind":1024,"name":"workflowName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html#workflowname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowsInfo"},{"id":5772,"kind":1024,"name":"workflowVersion","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html#workflowversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowsInfo"},{"id":5773,"kind":1024,"name":"workflowDescription","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html#workflowdescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowsInfo"},{"id":5774,"kind":1024,"name":"workflowID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html#workflowid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowsInfo"},{"id":5775,"kind":1024,"name":"vendor","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html#vendor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowsInfo"},{"id":5776,"kind":1024,"name":"system","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html#system","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowsInfo"},{"id":5777,"kind":1024,"name":"category","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html#category","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowsInfo"},{"id":5778,"kind":1024,"name":"statusName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html#statusname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowsInfo"},{"id":5779,"kind":1024,"name":"archivedInstanceURI","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html#archivedinstanceuri","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowsInfo"},{"id":5780,"kind":256,"name":"IArchivedWorkflows","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iarchivedworkflows.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5781,"kind":1024,"name":"archivedWorkflows","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iarchivedworkflows.html#archivedworkflows","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IArchivedWorkflows"},{"id":5782,"kind":128,"name":"ListArchivedWorkflows","url":"classes/_zowe_zos_workflows_for_zowe_sdk.listarchivedworkflows.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5783,"kind":2048,"name":"listArchivedWorkflows","url":"classes/_zowe_zos_workflows_for_zowe_sdk.listarchivedworkflows.html#listarchivedworkflows","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.ListArchivedWorkflows"},{"id":5784,"kind":256,"name":"IActiveWorkflows","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iactiveworkflows.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5785,"kind":1024,"name":"workflows","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iactiveworkflows.html#workflows","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IActiveWorkflows"},{"id":5786,"kind":256,"name":"IGetWorkflowsOptions","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.igetworkflowsoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5787,"kind":1024,"name":"zOSMFVersion","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.igetworkflowsoptions.html#zosmfversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IGetWorkflowsOptions"},{"id":5788,"kind":1024,"name":"workflowName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.igetworkflowsoptions.html#workflowname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IGetWorkflowsOptions"},{"id":5789,"kind":1024,"name":"category","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.igetworkflowsoptions.html#category","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IGetWorkflowsOptions"},{"id":5790,"kind":1024,"name":"system","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.igetworkflowsoptions.html#system","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IGetWorkflowsOptions"},{"id":5791,"kind":1024,"name":"owner","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.igetworkflowsoptions.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IGetWorkflowsOptions"},{"id":5792,"kind":1024,"name":"vendor","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.igetworkflowsoptions.html#vendor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IGetWorkflowsOptions"},{"id":5793,"kind":1024,"name":"statusName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.igetworkflowsoptions.html#statusname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IGetWorkflowsOptions"},{"id":5794,"kind":128,"name":"ListWorkflows","url":"classes/_zowe_zos_workflows_for_zowe_sdk.listworkflows.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5795,"kind":2048,"name":"getWorkflows","url":"classes/_zowe_zos_workflows_for_zowe_sdk.listworkflows.html#getworkflows","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.ListWorkflows"},{"id":5796,"kind":2048,"name":"getResourceQuery","url":"classes/_zowe_zos_workflows_for_zowe_sdk.listworkflows.html#getresourcequery","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.ListWorkflows"},{"id":5797,"kind":2048,"name":"getWfKey","url":"classes/_zowe_zos_workflows_for_zowe_sdk.listworkflows.html#getwfkey","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.ListWorkflows"},{"id":5798,"kind":256,"name":"IAutomationStatus","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iautomationstatus.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5799,"kind":1024,"name":"startUser","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iautomationstatus.html#startuser","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IAutomationStatus"},{"id":5800,"kind":1024,"name":"startedTime","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iautomationstatus.html#startedtime","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IAutomationStatus"},{"id":5801,"kind":1024,"name":"stoppedTime","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iautomationstatus.html#stoppedtime","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IAutomationStatus"},{"id":5802,"kind":1024,"name":"currentStepName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iautomationstatus.html#currentstepname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IAutomationStatus"},{"id":5803,"kind":1024,"name":"currentStepNumber","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iautomationstatus.html#currentstepnumber","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IAutomationStatus"},{"id":5804,"kind":1024,"name":"currentStepTitle","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iautomationstatus.html#currentsteptitle","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IAutomationStatus"},{"id":5805,"kind":1024,"name":"messageID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iautomationstatus.html#messageid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IAutomationStatus"},{"id":5806,"kind":1024,"name":"messageText","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iautomationstatus.html#messagetext","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IAutomationStatus"},{"id":5807,"kind":256,"name":"IJobStatus","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobstatus.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5808,"kind":1024,"name":"retcode","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobstatus.html#retcode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobStatus"},{"id":5809,"kind":1024,"name":"jobname","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobstatus.html#jobname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobStatus"},{"id":5810,"kind":1024,"name":"status","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobstatus.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobStatus"},{"id":5811,"kind":1024,"name":"owner","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobstatus.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobStatus"},{"id":5812,"kind":1024,"name":"subsystem","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobstatus.html#subsystem","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobStatus"},{"id":5813,"kind":1024,"name":"_class","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobstatus.html#_class","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobStatus"},{"id":5814,"kind":1024,"name":"type","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobstatus.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobStatus"},{"id":5815,"kind":1024,"name":"jobid","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobstatus.html#jobid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobStatus"},{"id":5816,"kind":256,"name":"IJobFiles","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobfiles.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5817,"kind":1024,"name":"id","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobfiles.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobFiles"},{"id":5818,"kind":1024,"name":"ddname","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobfiles.html#ddname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobFiles"},{"id":5819,"kind":1024,"name":"byte-count","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobfiles.html#byte_count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobFiles"},{"id":5820,"kind":1024,"name":"record-count","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobfiles.html#record_count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobFiles"},{"id":5821,"kind":1024,"name":"_class","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobfiles.html#_class","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobFiles"},{"id":5822,"kind":1024,"name":"stepname","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobfiles.html#stepname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobFiles"},{"id":5823,"kind":1024,"name":"procstep","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobfiles.html#procstep","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobFiles"},{"id":5824,"kind":256,"name":"IJobInfo","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobinfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5825,"kind":1024,"name":"jobstatus","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobinfo.html#jobstatus","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobInfo"},{"id":5826,"kind":1024,"name":"jobfiles","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobinfo.html#jobfiles","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IJobInfo"},{"id":5827,"kind":256,"name":"IStepInfo","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5828,"kind":1024,"name":"name","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5829,"kind":1024,"name":"actualStatusCode","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#actualstatuscode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5830,"kind":1024,"name":"assignees","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#assignees","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5831,"kind":1024,"name":"autoEnable","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#autoenable","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5832,"kind":1024,"name":"calledInstanceKey","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#calledinstancekey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5833,"kind":1024,"name":"calledInstanceScope","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#calledinstancescope","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5834,"kind":1024,"name":"calledInstanceURI","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#calledinstanceuri","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5835,"kind":1024,"name":"calledWorkflowID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#calledworkflowid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5836,"kind":1024,"name":"calledWorkflowVersion","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#calledworkflowversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5837,"kind":1024,"name":"calledWorkflowMD5","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#calledworkflowmd5","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5838,"kind":1024,"name":"calledWorkflowDescription","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#calledworkflowdescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5839,"kind":1024,"name":"calledWorkflowDefinitionFile","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#calledworkflowdefinitionfile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5840,"kind":1024,"name":"description","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5841,"kind":1024,"name":"expectedStatusCode","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#expectedstatuscode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5842,"kind":1024,"name":"failedPattern","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#failedpattern","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5843,"kind":1024,"name":"hasCalledWorkflow","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#hascalledworkflow","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5844,"kind":1024,"name":"hostname","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#hostname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5845,"kind":1024,"name":"httpMethod","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#httpmethod","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5846,"kind":1024,"name":"instructions","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#instructions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5847,"kind":1024,"name":"instructionsSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#instructionssub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5848,"kind":1024,"name":"isConditionStep","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#isconditionstep","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5849,"kind":1024,"name":"isRestStep","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#isreststep","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5850,"kind":1024,"name":"jobInfo","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#jobinfo","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5851,"kind":1024,"name":"maxLrecl","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#maxlrecl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5852,"kind":1024,"name":"optional","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#optional","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5853,"kind":1024,"name":"output","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#output","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5854,"kind":1024,"name":"outputSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#outputsub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5855,"kind":1024,"name":"outputVariablesPrefix","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#outputvariablesprefix","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5856,"kind":1024,"name":"owner","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5857,"kind":1024,"name":"port","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#port","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5858,"kind":1024,"name":"portSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#portsub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5859,"kind":1024,"name":"prereqStep","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#prereqstep","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5860,"kind":1024,"name":"procName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#procname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5861,"kind":1024,"name":"queryParameters","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#queryparameters","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5862,"kind":1024,"name":"queryParametersSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#queryparameterssub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5863,"kind":1024,"name":"regionSize","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#regionsize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5864,"kind":1024,"name":"requestBody","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#requestbody","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5865,"kind":1024,"name":"requestBodySub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#requestbodysub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5866,"kind":1024,"name":"returnCode","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#returncode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5867,"kind":1024,"name":"runAsUser","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#runasuser","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5868,"kind":1024,"name":"runAsUserDynamic","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#runasuserdynamic","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5869,"kind":1024,"name":"saveAsDataset","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#saveasdataset","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5870,"kind":1024,"name":"saveAsDatasetSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#saveasdatasetsub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5871,"kind":1024,"name":"saveAsUnixFile","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#saveasunixfile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5872,"kind":1024,"name":"saveAsUnixFileSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#saveasunixfilesub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5873,"kind":1024,"name":"schemeName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#schemename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5874,"kind":1024,"name":"schemeNameSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#schemenamesub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5875,"kind":1024,"name":"scriptParameters","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#scriptparameters","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5876,"kind":1024,"name":"skills","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#skills","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5877,"kind":1024,"name":"state","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#state","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5878,"kind":1024,"name":"stepNumber","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#stepnumber","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5879,"kind":1024,"name":"steps","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#steps","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5880,"kind":1024,"name":"submitAs","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#submitas","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5881,"kind":1024,"name":"successPattern","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#successpattern","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5882,"kind":1024,"name":"template","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#template","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5883,"kind":1024,"name":"templateSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#templatesub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5884,"kind":1024,"name":"timeout","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#timeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5885,"kind":1024,"name":"title","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#title","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5886,"kind":1024,"name":"uriPath","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#uripath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5887,"kind":1024,"name":"uriPathSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#uripathsub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5888,"kind":1024,"name":"userDefined","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#userdefined","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5889,"kind":1024,"name":"variable-references","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#variable_references","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5890,"kind":1024,"name":"weight","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html#weight","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepInfo"},{"id":5891,"kind":256,"name":"IVariableInfo","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariableinfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5892,"kind":1024,"name":"name","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariableinfo.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableInfo"},{"id":5893,"kind":1024,"name":"scope","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariableinfo.html#scope","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableInfo"},{"id":5894,"kind":1024,"name":"type","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariableinfo.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableInfo"},{"id":5895,"kind":1024,"name":"value","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariableinfo.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableInfo"},{"id":5896,"kind":1024,"name":"visibility","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariableinfo.html#visibility","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IVariableInfo"},{"id":5897,"kind":256,"name":"IWorkflowInfo","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5898,"kind":1024,"name":"workflowName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#workflowname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5899,"kind":1024,"name":"workflowKey","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#workflowkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5900,"kind":1024,"name":"workflowDescription","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#workflowdescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5901,"kind":1024,"name":"workflowID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#workflowid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5902,"kind":1024,"name":"workflowVersion","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#workflowversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5903,"kind":1024,"name":"workflowDefinitionFileMD5Value","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#workflowdefinitionfilemd5value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5904,"kind":1024,"name":"vendor","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#vendor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5905,"kind":1024,"name":"owner","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5906,"kind":1024,"name":"system","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#system","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5907,"kind":1024,"name":"category","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#category","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5908,"kind":1024,"name":"productID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#productid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5909,"kind":1024,"name":"productName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#productname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5910,"kind":1024,"name":"productVersion","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#productversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5911,"kind":1024,"name":"percentComplete","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#percentcomplete","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5912,"kind":1024,"name":"isCallable","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#iscallable","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5913,"kind":1024,"name":"containsParallelSteps","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#containsparallelsteps","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5914,"kind":1024,"name":"scope","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#scope","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5915,"kind":1024,"name":"statusName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#statusname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5916,"kind":1024,"name":"deleteCompletedJobs","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#deletecompletedjobs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5917,"kind":1024,"name":"automationStatus","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#automationstatus","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5918,"kind":1024,"name":"accountInfo","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#accountinfo","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5919,"kind":1024,"name":"jobStatement","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#jobstatement","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5920,"kind":1024,"name":"templateID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#templateid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5921,"kind":1024,"name":"actionID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#actionid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5922,"kind":1024,"name":"registryID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#registryid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5923,"kind":1024,"name":"parentRegistryID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#parentregistryid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5924,"kind":1024,"name":"domainID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#domainid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5925,"kind":1024,"name":"tenantID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#tenantid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5926,"kind":1024,"name":"softwareServiceInstanceName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#softwareserviceinstancename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5927,"kind":1024,"name":"templateName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#templatename","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5928,"kind":1024,"name":"steps","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#steps","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5929,"kind":1024,"name":"variables","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#variables","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5930,"kind":1024,"name":"access","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html#access","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflowInfo"},{"id":5931,"kind":256,"name":"IStepSummary","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5932,"kind":1024,"name":"stepNumber","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#stepnumber","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5933,"kind":1024,"name":"name","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#name","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5934,"kind":1024,"name":"state","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#state","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5935,"kind":1024,"name":"misc","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#misc","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5936,"kind":1024,"name":"actualStatusCode","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#actualstatuscode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5937,"kind":1024,"name":"assignees","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#assignees","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5938,"kind":1024,"name":"autoEnable","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#autoenable","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5939,"kind":1024,"name":"calledInstanceKey","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#calledinstancekey","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5940,"kind":1024,"name":"calledInstanceScope","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#calledinstancescope","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5941,"kind":1024,"name":"calledInstanceURI","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#calledinstanceuri","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5942,"kind":1024,"name":"calledWorkflowID","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#calledworkflowid","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5943,"kind":1024,"name":"calledWorkflowVersion","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#calledworkflowversion","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5944,"kind":1024,"name":"calledWorkflowMD5","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#calledworkflowmd5","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5945,"kind":1024,"name":"calledWorkflowDescription","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#calledworkflowdescription","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5946,"kind":1024,"name":"calledWorkflowDefinitionFile","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#calledworkflowdefinitionfile","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5947,"kind":1024,"name":"description","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#description","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5948,"kind":1024,"name":"expectedStatusCode","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#expectedstatuscode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5949,"kind":1024,"name":"failedPattern","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#failedpattern","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5950,"kind":1024,"name":"hasCalledWorkflow","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#hascalledworkflow","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5951,"kind":1024,"name":"hostname","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#hostname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5952,"kind":1024,"name":"httpMethod","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#httpmethod","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5953,"kind":1024,"name":"instructions","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#instructions","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5954,"kind":1024,"name":"instructionsSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#instructionssub","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5955,"kind":1024,"name":"isConditionStep","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#isconditionstep","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5956,"kind":1024,"name":"isRestStep","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#isreststep","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5957,"kind":1024,"name":"jobInfo","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#jobinfo","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5958,"kind":1024,"name":"maxLrecl","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#maxlrecl","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5959,"kind":1024,"name":"optional","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#optional","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5960,"kind":1024,"name":"output","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#output","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5961,"kind":1024,"name":"outputSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#outputsub","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5962,"kind":1024,"name":"outputVariablesPrefix","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#outputvariablesprefix","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5963,"kind":1024,"name":"owner","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5964,"kind":1024,"name":"port","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#port","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5965,"kind":1024,"name":"portSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#portsub","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5966,"kind":1024,"name":"prereqStep","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#prereqstep","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5967,"kind":1024,"name":"procName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#procname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5968,"kind":1024,"name":"queryParameters","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#queryparameters","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5969,"kind":1024,"name":"queryParametersSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#queryparameterssub","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5970,"kind":1024,"name":"regionSize","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#regionsize","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5971,"kind":1024,"name":"requestBody","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#requestbody","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5972,"kind":1024,"name":"requestBodySub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#requestbodysub","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5973,"kind":1024,"name":"returnCode","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#returncode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5974,"kind":1024,"name":"runAsUser","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#runasuser","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5975,"kind":1024,"name":"runAsUserDynamic","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#runasuserdynamic","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5976,"kind":1024,"name":"saveAsDataset","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#saveasdataset","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5977,"kind":1024,"name":"saveAsDatasetSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#saveasdatasetsub","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5978,"kind":1024,"name":"saveAsUnixFile","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#saveasunixfile","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5979,"kind":1024,"name":"saveAsUnixFileSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#saveasunixfilesub","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5980,"kind":1024,"name":"schemeName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#schemename","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5981,"kind":1024,"name":"schemeNameSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#schemenamesub","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5982,"kind":1024,"name":"scriptParameters","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#scriptparameters","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5983,"kind":1024,"name":"skills","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#skills","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5984,"kind":1024,"name":"steps","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#steps","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5985,"kind":1024,"name":"submitAs","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#submitas","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5986,"kind":1024,"name":"successPattern","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#successpattern","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5987,"kind":1024,"name":"template","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#template","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5988,"kind":1024,"name":"templateSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#templatesub","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5989,"kind":1024,"name":"timeout","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#timeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5990,"kind":1024,"name":"title","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#title","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5991,"kind":1024,"name":"uriPath","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#uripath","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5992,"kind":1024,"name":"uriPathSub","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#uripathsub","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5993,"kind":1024,"name":"userDefined","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#userdefined","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5994,"kind":1024,"name":"variable-references","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#variable_references","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5995,"kind":1024,"name":"weight","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html#weight","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"@zowe/zos-workflows-for-zowe-sdk.IStepSummary"},{"id":5996,"kind":128,"name":"PropertiesWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.propertiesworkflow.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":5997,"kind":2048,"name":"getWorkflowProperties","url":"classes/_zowe_zos_workflows_for_zowe_sdk.propertiesworkflow.html#getworkflowproperties","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.PropertiesWorkflow"},{"id":5998,"kind":2048,"name":"processStepSummaries","url":"classes/_zowe_zos_workflows_for_zowe_sdk.propertiesworkflow.html#processstepsummaries","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.PropertiesWorkflow"},{"id":5999,"kind":256,"name":"IStartWorkflow","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istartworkflow.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":6000,"kind":1024,"name":"resolveConflictByUsing","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istartworkflow.html#resolveconflictbyusing","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStartWorkflow"},{"id":6001,"kind":1024,"name":"stepName","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istartworkflow.html#stepname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStartWorkflow"},{"id":6002,"kind":1024,"name":"performSubsequent","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.istartworkflow.html#performsubsequent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IStartWorkflow"},{"id":6003,"kind":4194304,"name":"startT","url":"modules/_zowe_zos_workflows_for_zowe_sdk.html#startt","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":6004,"kind":128,"name":"StartWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.startworkflow.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":6005,"kind":2048,"name":"startWorkflow","url":"classes/_zowe_zos_workflows_for_zowe_sdk.startworkflow.html#startworkflow","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zos-workflows-for-zowe-sdk.StartWorkflow"},{"id":6006,"kind":256,"name":"IWorkflows","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflows.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zos-workflows-for-zowe-sdk"},{"id":6007,"kind":1024,"name":"workflows","url":"interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflows.html#workflows","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zos-workflows-for-zowe-sdk.IWorkflows"},{"id":6008,"kind":1,"name":"@zowe/zosmf-for-zowe-sdk","url":"modules/_zowe_zosmf_for_zowe_sdk.html","classes":"tsd-kind-module"},{"id":6009,"kind":2097152,"name":"ZosmfConstants","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfconstants","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zosmf-for-zowe-sdk"},{"id":6010,"kind":32,"name":"RESOURCE","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfconstants.resource","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfConstants"},{"id":6011,"kind":32,"name":"INFO","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfconstants.info","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfConstants"},{"id":6012,"kind":32,"name":"TOPOLOGY","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfconstants.topology","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfConstants"},{"id":6013,"kind":32,"name":"SYSTEMS","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfconstants.systems","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfConstants"},{"id":6014,"kind":2097152,"name":"ERROR_CODES","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfconstants.error_codes","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfConstants"},{"id":6015,"kind":32,"name":"BAD_HOST_NAME","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfconstants.error_codes.bad_host_name","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfConstants.ERROR_CODES"},{"id":6016,"kind":32,"name":"BAD_PORT","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfconstants.error_codes.bad_port","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfConstants.ERROR_CODES"},{"id":6017,"kind":32,"name":"SELF_SIGNED_CERT_IN_CHAIN","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfconstants.error_codes.self_signed_cert_in_chain","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfConstants.ERROR_CODES"},{"id":6018,"kind":32,"name":"UNABLE_TO_VERIFY_LEAF_SIGNATURE","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfconstants.error_codes.unable_to_verify_leaf_signature","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfConstants.ERROR_CODES"},{"id":6019,"kind":2097152,"name":"ZosFilesOptions","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosfilesoptions","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zosmf-for-zowe-sdk"},{"id":6020,"kind":2097152,"name":"responseTimeout","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosfilesoptions.responsetimeout","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosFilesOptions"},{"id":6021,"kind":32,"name":"name","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosfilesoptions.responsetimeout.name","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosFilesOptions.responseTimeout"},{"id":6022,"kind":32,"name":"aliases","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosfilesoptions.responsetimeout.aliases","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosFilesOptions.responseTimeout"},{"id":6023,"kind":32,"name":"description","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosfilesoptions.responsetimeout.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosFilesOptions.responseTimeout"},{"id":6024,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosfilesoptions.responsetimeout.type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosFilesOptions.responseTimeout"},{"id":6025,"kind":32,"name":"defaultValue","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosfilesoptions.responsetimeout.defaultvalue","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosFilesOptions.responseTimeout"},{"id":6026,"kind":32,"name":"numericValueRange","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosfilesoptions.responsetimeout.numericvaluerange","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosFilesOptions.responseTimeout"},{"id":6027,"kind":2097152,"name":"ZosmfMessages","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfmessages","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zosmf-for-zowe-sdk"},{"id":6028,"kind":2097152,"name":"missingSession","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfmessages.missingsession","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfMessages"},{"id":6029,"kind":32,"name":"message","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfmessages.missingsession.message-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfMessages.missingSession"},{"id":6030,"kind":2097152,"name":"invalidHostName","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfmessages.invalidhostname","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfMessages"},{"id":6031,"kind":32,"name":"message","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfmessages.invalidhostname.message-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfMessages.invalidHostName"},{"id":6032,"kind":2097152,"name":"invalidPort","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfmessages.invalidport","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfMessages"},{"id":6033,"kind":32,"name":"message","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfmessages.invalidport.message-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfMessages.invalidPort"},{"id":6034,"kind":2097152,"name":"improperRejectUnauthorized","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfmessages.improperrejectunauthorized","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfMessages"},{"id":6035,"kind":32,"name":"message","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfmessages.improperrejectunauthorized.message","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfMessages.improperRejectUnauthorized"},{"id":6036,"kind":256,"name":"IZosmfPluginInfo","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfplugininfo.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zosmf-for-zowe-sdk"},{"id":6037,"kind":1024,"name":"pluginVersion","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfplugininfo.html#pluginversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfPluginInfo"},{"id":6038,"kind":1024,"name":"pluginDefaultName","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfplugininfo.html#plugindefaultname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfPluginInfo"},{"id":6039,"kind":1024,"name":"pluginStatus","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfplugininfo.html#pluginstatus","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfPluginInfo"},{"id":6040,"kind":256,"name":"IZosmfInfoResponse","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfinforesponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zosmf-for-zowe-sdk"},{"id":6041,"kind":1024,"name":"zos_version","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfinforesponse.html#zos_version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfInfoResponse"},{"id":6042,"kind":1024,"name":"zosmf_port","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfinforesponse.html#zosmf_port","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfInfoResponse"},{"id":6043,"kind":1024,"name":"zosmf_version","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfinforesponse.html#zosmf_version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfInfoResponse"},{"id":6044,"kind":1024,"name":"zosmf_hostname","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfinforesponse.html#zosmf_hostname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfInfoResponse"},{"id":6045,"kind":1024,"name":"zosmf_saf_realm","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfinforesponse.html#zosmf_saf_realm","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfInfoResponse"},{"id":6046,"kind":1024,"name":"zosmf_full_version","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfinforesponse.html#zosmf_full_version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfInfoResponse"},{"id":6047,"kind":1024,"name":"api_version","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfinforesponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfInfoResponse"},{"id":6048,"kind":1024,"name":"plugins","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmfinforesponse.html#plugins","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfInfoResponse"},{"id":6049,"kind":128,"name":"CheckStatus","url":"classes/_zowe_zosmf_for_zowe_sdk.checkstatus.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zosmf-for-zowe-sdk"},{"id":6050,"kind":2048,"name":"getZosmfInfo","url":"classes/_zowe_zosmf_for_zowe_sdk.checkstatus.html#getzosmfinfo","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.CheckStatus"},{"id":6051,"kind":262144,"name":"log","url":"classes/_zowe_zosmf_for_zowe_sdk.checkstatus.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.CheckStatus"},{"id":6052,"kind":256,"name":"IDefinedSystem","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zosmf-for-zowe-sdk"},{"id":6053,"kind":1024,"name":"systemNickName","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html#systemnickname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IDefinedSystem"},{"id":6054,"kind":1024,"name":"groupNames","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html#groupnames","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IDefinedSystem"},{"id":6055,"kind":1024,"name":"cpcSerial","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html#cpcserial","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IDefinedSystem"},{"id":6056,"kind":1024,"name":"zosVR","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html#zosvr","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IDefinedSystem"},{"id":6057,"kind":1024,"name":"systemName","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html#systemname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IDefinedSystem"},{"id":6058,"kind":1024,"name":"jesType","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html#jestype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IDefinedSystem"},{"id":6059,"kind":1024,"name":"sysplexName","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html#sysplexname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IDefinedSystem"},{"id":6060,"kind":1024,"name":"jesMemberName","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html#jesmembername","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IDefinedSystem"},{"id":6061,"kind":1024,"name":"httpProxyName","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html#httpproxyname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IDefinedSystem"},{"id":6062,"kind":1024,"name":"ftpDestinationName","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html#ftpdestinationname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IDefinedSystem"},{"id":6063,"kind":1024,"name":"url","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IDefinedSystem"},{"id":6064,"kind":1024,"name":"cpcName","url":"interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html#cpcname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IDefinedSystem"},{"id":6065,"kind":256,"name":"IZosmfListDefinedSystemsResponse","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmflistdefinedsystemsresponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"@zowe/zosmf-for-zowe-sdk"},{"id":6066,"kind":1024,"name":"numRows","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmflistdefinedsystemsresponse.html#numrows","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfListDefinedSystemsResponse"},{"id":6067,"kind":1024,"name":"items","url":"interfaces/_zowe_zosmf_for_zowe_sdk.izosmflistdefinedsystemsresponse.html#items","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"@zowe/zosmf-for-zowe-sdk.IZosmfListDefinedSystemsResponse"},{"id":6068,"kind":128,"name":"ListDefinedSystems","url":"classes/_zowe_zosmf_for_zowe_sdk.listdefinedsystems.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zosmf-for-zowe-sdk"},{"id":6069,"kind":2048,"name":"listDefinedSystems","url":"classes/_zowe_zosmf_for_zowe_sdk.listdefinedsystems.html#listdefinedsystems","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ListDefinedSystems"},{"id":6070,"kind":128,"name":"ZosmfSession","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zosmf-for-zowe-sdk"},{"id":6071,"kind":1024,"name":"ZOSMF_CONNECTION_OPTION_GROUP","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_connection_option_group","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6072,"kind":2097152,"name":"ZOSMF_OPTION_HOST","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_host","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6073,"kind":32,"name":"name","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_host.name-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_HOST"},{"id":6074,"kind":32,"name":"aliases","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_host.aliases-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_HOST"},{"id":6075,"kind":32,"name":"description","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_host.description-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_HOST"},{"id":6076,"kind":32,"name":"type","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_host.type-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_HOST"},{"id":6077,"kind":32,"name":"required","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_host.required","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_HOST"},{"id":6078,"kind":32,"name":"group","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_host.group-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_HOST"},{"id":6079,"kind":1024,"name":"ZOSMF_OPTION_HOST_PROFILE","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_host_profile","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6080,"kind":2097152,"name":"ZOSMF_OPTION_PORT","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_port","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6081,"kind":32,"name":"name","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_port.name-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PORT"},{"id":6082,"kind":32,"name":"aliases","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_port.aliases-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PORT"},{"id":6083,"kind":32,"name":"description","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_port.description-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PORT"},{"id":6084,"kind":32,"name":"type","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_port.type-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PORT"},{"id":6085,"kind":32,"name":"defaultValue","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_port.defaultvalue","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PORT"},{"id":6086,"kind":32,"name":"group","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_port.group-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PORT"},{"id":6087,"kind":2097152,"name":"ZOSMF_OPTION_USER","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_user","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6088,"kind":32,"name":"name","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_user.name-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_USER"},{"id":6089,"kind":32,"name":"aliases","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_user.aliases-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_USER"},{"id":6090,"kind":32,"name":"description","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_user.description-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_USER"},{"id":6091,"kind":32,"name":"type","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_user.type-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_USER"},{"id":6092,"kind":32,"name":"required","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_user.required-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_USER"},{"id":6093,"kind":32,"name":"group","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_user.group-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_USER"},{"id":6094,"kind":1024,"name":"ZOSMF_OPTION_USER_PROFILE","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_user_profile","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6095,"kind":2097152,"name":"ZOSMF_OPTION_PASSWORD","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_password","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6096,"kind":32,"name":"name","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_password.name-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PASSWORD"},{"id":6097,"kind":32,"name":"aliases","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_password.aliases-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PASSWORD"},{"id":6098,"kind":32,"name":"description","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_password.description-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PASSWORD"},{"id":6099,"kind":32,"name":"type","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_password.type-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PASSWORD"},{"id":6100,"kind":32,"name":"required","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_password.required-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PASSWORD"},{"id":6101,"kind":32,"name":"group","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_password.group-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PASSWORD"},{"id":6102,"kind":1024,"name":"ZOSMF_OPTION_PASSWORD_PROFILE","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_password_profile","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6103,"kind":2097152,"name":"ZOSMF_OPTION_REJECT_UNAUTHORIZED","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_reject_unauthorized","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6104,"kind":32,"name":"name","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_reject_unauthorized.name-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_REJECT_UNAUTHORIZED"},{"id":6105,"kind":32,"name":"aliases","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_reject_unauthorized.aliases-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_REJECT_UNAUTHORIZED"},{"id":6106,"kind":32,"name":"description","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_reject_unauthorized.description-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_REJECT_UNAUTHORIZED"},{"id":6107,"kind":32,"name":"type","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_reject_unauthorized.type-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_REJECT_UNAUTHORIZED"},{"id":6108,"kind":32,"name":"defaultValue","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_reject_unauthorized.defaultvalue-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_REJECT_UNAUTHORIZED"},{"id":6109,"kind":32,"name":"group","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_reject_unauthorized.group-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_REJECT_UNAUTHORIZED"},{"id":6110,"kind":2097152,"name":"ZOSMF_OPTION_BASE_PATH","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_base_path","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6111,"kind":32,"name":"name","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_base_path.name","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_BASE_PATH"},{"id":6112,"kind":32,"name":"aliases","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_base_path.aliases","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_BASE_PATH"},{"id":6113,"kind":32,"name":"description","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_base_path.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_BASE_PATH"},{"id":6114,"kind":32,"name":"type","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_base_path.type","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_BASE_PATH"},{"id":6115,"kind":32,"name":"group","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_base_path.group","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_BASE_PATH"},{"id":6116,"kind":2097152,"name":"ZOSMF_OPTION_PROTOCOL","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_protocol","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6117,"kind":32,"name":"name","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_protocol.name-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PROTOCOL"},{"id":6118,"kind":32,"name":"description","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_protocol.description-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PROTOCOL"},{"id":6119,"kind":32,"name":"type","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_protocol.type-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PROTOCOL"},{"id":6120,"kind":32,"name":"defaultValue","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_protocol.defaultvalue-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PROTOCOL"},{"id":6121,"kind":32,"name":"group","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_protocol.group-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PROTOCOL"},{"id":6122,"kind":2097152,"name":"allowableValues","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_protocol.allowablevalues","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PROTOCOL"},{"id":6123,"kind":32,"name":"values","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_protocol.allowablevalues.values","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PROTOCOL.allowableValues"},{"id":6124,"kind":32,"name":"caseSensitive","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_protocol.allowablevalues.casesensitive","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_PROTOCOL.allowableValues"},{"id":6125,"kind":2097152,"name":"ZOSMF_OPTION_CERT_FILE","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_cert_file","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6126,"kind":32,"name":"name","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_cert_file.name-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_CERT_FILE"},{"id":6127,"kind":32,"name":"description","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_cert_file.description-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_CERT_FILE"},{"id":6128,"kind":32,"name":"type","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_cert_file.type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_CERT_FILE"},{"id":6129,"kind":32,"name":"group","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_cert_file.group-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_CERT_FILE"},{"id":6130,"kind":2097152,"name":"ZOSMF_OPTION_CERT_KEY_FILE","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_cert_key_file","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6131,"kind":32,"name":"name","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_cert_key_file.name-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_CERT_KEY_FILE"},{"id":6132,"kind":32,"name":"description","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_cert_key_file.description-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_CERT_KEY_FILE"},{"id":6133,"kind":32,"name":"type","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_cert_key_file.type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_CERT_KEY_FILE"},{"id":6134,"kind":32,"name":"group","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_option_cert_key_file.group-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession.ZOSMF_OPTION_CERT_KEY_FILE"},{"id":6135,"kind":1024,"name":"ZOSMF_CONNECTION_OPTIONS","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#zosmf_connection_options","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6136,"kind":2048,"name":"createSessCfgFromArgs","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#createsesscfgfromargs","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6137,"kind":262144,"name":"log","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html#log","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfSession"},{"id":6138,"kind":128,"name":"ZosmfBaseHandler","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"@zowe/zosmf-for-zowe-sdk"},{"id":6139,"kind":1024,"name":"mSession","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html#msession","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfBaseHandler"},{"id":6140,"kind":1024,"name":"mZosmfProfile","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html#mzosmfprofile","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfBaseHandler"},{"id":6141,"kind":1024,"name":"mZosmfLoadedProfile","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html#mzosmfloadedprofile","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfBaseHandler"},{"id":6142,"kind":1024,"name":"mArguments","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html#marguments","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfBaseHandler"},{"id":6143,"kind":1024,"name":"mHandlerParams","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html#mhandlerparams","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfBaseHandler"},{"id":6144,"kind":2048,"name":"process","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html#process","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfBaseHandler"},{"id":6145,"kind":2048,"name":"fail","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html#fail","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfBaseHandler"},{"id":6146,"kind":262144,"name":"console","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html#console","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfBaseHandler"},{"id":6147,"kind":262144,"name":"format","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html#format","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfBaseHandler"},{"id":6148,"kind":262144,"name":"data","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html#data","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfBaseHandler"},{"id":6149,"kind":262144,"name":"progress","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html#progress","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfBaseHandler"},{"id":6150,"kind":2048,"name":"processCmd","url":"classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html#processcmd","classes":"tsd-kind-method tsd-parent-kind-class","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfBaseHandler"},{"id":6151,"kind":2097152,"name":"ZosmfProfile","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"@zowe/zosmf-for-zowe-sdk"},{"id":6152,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.type-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile"},{"id":6153,"kind":2097152,"name":"schema","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile"},{"id":6154,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.type-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema"},{"id":6155,"kind":32,"name":"title","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.title","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema"},{"id":6156,"kind":32,"name":"description","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.description-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema"},{"id":6157,"kind":2097152,"name":"properties","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema"},{"id":6158,"kind":2097152,"name":"host","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.host","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties"},{"id":6159,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.host.type-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.host"},{"id":6160,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.host.optiondefinition-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.host"},{"id":6161,"kind":2097152,"name":"port","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.port","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties"},{"id":6162,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.port.type-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.port"},{"id":6163,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.port.optiondefinition-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.port"},{"id":6164,"kind":32,"name":"includeInTemplate","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.port.includeintemplate","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.port"},{"id":6165,"kind":2097152,"name":"user","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.user","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties"},{"id":6166,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.user.type-14","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.user"},{"id":6167,"kind":32,"name":"secure","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.user.secure-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.user"},{"id":6168,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.user.optiondefinition-10","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.user"},{"id":6169,"kind":2097152,"name":"password","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.password","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties"},{"id":6170,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.password.type-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.password"},{"id":6171,"kind":32,"name":"secure","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.password.secure","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.password"},{"id":6172,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.password.optiondefinition-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.password"},{"id":6173,"kind":2097152,"name":"rejectUnauthorized","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.rejectunauthorized","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties"},{"id":6174,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.rejectunauthorized.type-12","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.rejectUnauthorized"},{"id":6175,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.rejectunauthorized.optiondefinition-8","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.rejectUnauthorized"},{"id":6176,"kind":2097152,"name":"certFile","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.certfile","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties"},{"id":6177,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.certfile.type-4","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.certFile"},{"id":6178,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.certfile.optiondefinition-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.certFile"},{"id":6179,"kind":2097152,"name":"certKeyFile","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.certkeyfile","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties"},{"id":6180,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.certkeyfile.type-5","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.certKeyFile"},{"id":6181,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.certkeyfile.optiondefinition-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.certKeyFile"},{"id":6182,"kind":2097152,"name":"basePath","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.basepath","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties"},{"id":6183,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.basepath.type-3","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.basePath"},{"id":6184,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.basepath.optiondefinition","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.basePath"},{"id":6185,"kind":2097152,"name":"protocol","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.protocol","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties"},{"id":6186,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.protocol.type-11","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.protocol"},{"id":6187,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.protocol.optiondefinition-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.protocol"},{"id":6188,"kind":2097152,"name":"encoding","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.encoding","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties"},{"id":6189,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.encoding.type-6","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.encoding"},{"id":6190,"kind":2097152,"name":"optionDefinition","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.encoding.optiondefinition-3","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.encoding"},{"id":6191,"kind":32,"name":"name","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.encoding.optiondefinition-3.name-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.encoding.optionDefinition"},{"id":6192,"kind":32,"name":"aliases","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.encoding.optiondefinition-3.aliases-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.encoding.optionDefinition"},{"id":6193,"kind":32,"name":"description","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.encoding.optiondefinition-3.description-2","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.encoding.optionDefinition"},{"id":6194,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.encoding.optiondefinition-3.type-7","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.encoding.optionDefinition"},{"id":6195,"kind":2097152,"name":"responseTimeout","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.responsetimeout-1","classes":"tsd-kind-object-literal tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties"},{"id":6196,"kind":32,"name":"type","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.responsetimeout-1.type-13","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.responseTimeout"},{"id":6197,"kind":32,"name":"optionDefinition","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.properties.responsetimeout-1.optiondefinition-9","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema.properties.responseTimeout"},{"id":6198,"kind":32,"name":"required","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.schema.required","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile.schema"},{"id":6199,"kind":32,"name":"createProfileExamples","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.createprofileexamples","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile"},{"id":6200,"kind":32,"name":"updateProfileExamples","url":"modules/_zowe_zosmf_for_zowe_sdk.html#zosmfprofile.updateprofileexamples","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"@zowe/zosmf-for-zowe-sdk.ZosmfProfile"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,14.058,1,3.907,2,3.907,3,13.516]],["parent/0",[]],["name/1",[4,84.686]],["parent/1",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/2",[5,84.686]],["parent/2",[0,2.482,1,0.69,2,0.69,6,6.806]],["name/3",[7,84.686]],["parent/3",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/4",[8,79.491]],["parent/4",[0,2.482,1,0.69,2,0.69,9,6.389]],["name/5",[10,79.491]],["parent/5",[0,2.482,1,0.69,2,0.69,9,6.389]],["name/6",[11,84.686]],["parent/6",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/7",[12,76.069]],["parent/7",[0,2.482,1,0.69,2,0.69,13,5.744]],["name/8",[14,76.069]],["parent/8",[0,2.482,1,0.69,2,0.69,13,5.744]],["name/9",[15,84.686]],["parent/9",[0,2.482,1,0.69,2,0.69,13,5.744]],["name/10",[16,84.686]],["parent/10",[0,2.482,1,0.69,2,0.69,13,5.744]],["name/11",[17,84.686]],["parent/11",[0,2.482,1,0.69,2,0.69,13,5.744]],["name/12",[18,47.256]],["parent/12",[0,2.482,1,0.69,2,0.69,19,6.806]],["name/13",[20,84.686]],["parent/13",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/14",[21,79.491]],["parent/14",[0,2.482,1,0.69,2,0.69,22,5.491]],["name/15",[23,79.491]],["parent/15",[0,2.482,1,0.69,2,0.69,22,5.491]],["name/16",[24,84.686]],["parent/16",[0,2.482,1,0.69,2,0.69,22,5.491]],["name/17",[25,84.686]],["parent/17",[0,2.482,1,0.69,2,0.69,22,5.491]],["name/18",[26,84.686]],["parent/18",[0,2.482,1,0.69,2,0.69,22,5.491]],["name/19",[27,69.774]],["parent/19",[0,2.482,1,0.69,2,0.69,22,5.491]],["name/20",[28,84.686]],["parent/20",[0,2.482,1,0.69,2,0.69,22,5.491]],["name/21",[29,84.686]],["parent/21",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/22",[30,84.686]],["parent/22",[0,2.482,1,0.69,2,0.69,31,6.114]],["name/23",[32,84.686]],["parent/23",[0,2.482,1,0.69,2,0.69,31,6.114]],["name/24",[33,84.686]],["parent/24",[0,2.482,1,0.69,2,0.69,31,6.114]],["name/25",[34,84.686]],["parent/25",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/26",[35,84.686]],["parent/26",[0,2.482,1,0.69,2,0.69,36,5.908]],["name/27",[37,64.897]],["parent/27",[0,2.482,1,0.69,2,0.69,36,5.908]],["name/28",[38,84.686]],["parent/28",[0,2.482,1,0.69,2,0.69,36,5.908]],["name/29",[18,47.256]],["parent/29",[0,2.482,1,0.69,2,0.69,39,6.806]],["name/30",[40,84.686]],["parent/30",[0,2.482,1,0.69,2,0.69,41,6.114]],["name/31",[42,71.473]],["parent/31",[0,2.482,1,0.69,2,0.69,41,6.114]],["name/32",[18,47.256]],["parent/32",[0,2.482,1,0.69,2,0.69,43,6.806]],["name/33",[44,64.897]],["parent/33",[0,2.482,1,0.69,2,0.69,45,6.114]],["name/34",[46,42.129]],["parent/34",[0,2.482,1,0.69,2,0.69,45,6.114]],["name/35",[47,84.686]],["parent/35",[0,2.482,1,0.69,2,0.69,45,6.114]],["name/36",[48,84.686]],["parent/36",[0,2.482,1,0.69,2,0.69,41,6.114]],["name/37",[49,84.686]],["parent/37",[0,2.482,1,0.69,2,0.69,36,5.908]],["name/38",[50,84.686]],["parent/38",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/39",[51,84.686]],["parent/39",[0,2.482,1,0.69,2,0.69,52,6.114]],["name/40",[53,84.686]],["parent/40",[0,2.482,1,0.69,2,0.69,52,6.114]],["name/41",[54,84.686]],["parent/41",[0,2.482,1,0.69,2,0.69,52,6.114]],["name/42",[55,84.686]],["parent/42",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/43",[56,84.686]],["parent/43",[0,2.482,1,0.69,2,0.69,57,6.114]],["name/44",[58,84.686]],["parent/44",[0,2.482,1,0.69,2,0.69,57,6.114]],["name/45",[59,84.686]],["parent/45",[0,2.482,1,0.69,2,0.69,57,6.114]],["name/46",[60,84.686]],["parent/46",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/47",[61,79.491]],["parent/47",[0,2.482,1,0.69,2,0.69,62,5.908]],["name/48",[63,61.614]],["parent/48",[0,2.482,1,0.69,2,0.69,62,5.908]],["name/49",[64,84.686]],["parent/49",[0,2.482,1,0.69,2,0.69,62,5.908]],["name/50",[65,84.686]],["parent/50",[0,2.482,1,0.69,2,0.69,62,5.908]],["name/51",[66,84.686]],["parent/51",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/52",[67,84.686]],["parent/52",[0,2.482,1,0.69,2,0.69,68,5.491]],["name/53",[12,76.069]],["parent/53",[0,2.482,1,0.69,2,0.69,68,5.491]],["name/54",[14,76.069]],["parent/54",[0,2.482,1,0.69,2,0.69,68,5.491]],["name/55",[27,69.774]],["parent/55",[0,2.482,1,0.69,2,0.69,68,5.491]],["name/56",[69,84.686]],["parent/56",[0,2.482,1,0.69,2,0.69,68,5.491]],["name/57",[70,84.686]],["parent/57",[0,2.482,1,0.69,2,0.69,68,5.491]],["name/58",[71,84.686]],["parent/58",[0,2.482,1,0.69,2,0.69,68,5.491]],["name/59",[72,84.686]],["parent/59",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/60",[73,84.686]],["parent/60",[0,2.482,1,0.69,2,0.69,74,5.744]],["name/61",[75,84.686]],["parent/61",[0,2.482,1,0.69,2,0.69,74,5.744]],["name/62",[76,84.686]],["parent/62",[0,2.482,1,0.69,2,0.69,74,5.744]],["name/63",[77,84.686]],["parent/63",[0,2.482,1,0.69,2,0.69,74,5.744]],["name/64",[78,84.686]],["parent/64",[0,2.482,1,0.69,2,0.69,74,5.744]],["name/65",[79,79.491]],["parent/65",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/66",[80,84.686]],["parent/66",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/67",[81,84.686]],["parent/67",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/68",[83,84.686]],["parent/68",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/69",[84,84.686]],["parent/69",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/70",[85,84.686]],["parent/70",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/71",[86,26.671,87,26.915,88,32.53,89,31.756]],["parent/71",[0,2.482,1,0.69,2,0.69,90,6.806]],["name/72",[91,84.686]],["parent/72",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/73",[86,26.671,87,26.915,88,32.53,92,30]],["parent/73",[0,2.482,1,0.69,2,0.69,93,6.806]],["name/74",[94,84.686]],["parent/74",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/75",[86,26.671,87,26.915,88,32.53,95,29.537]],["parent/75",[0,2.482,1,0.69,2,0.69,96,6.806]],["name/76",[97,84.686]],["parent/76",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/77",[86,26.671,87,26.915,88,32.53,95,29.537]],["parent/77",[0,2.482,1,0.69,2,0.69,98,6.806]],["name/78",[99,84.686]],["parent/78",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/79",[86,26.671,87,26.915,88,32.53,100,33.459]],["parent/79",[0,2.482,1,0.69,2,0.69,101,6.806]],["name/80",[102,84.686]],["parent/80",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/81",[86,26.671,87,26.915,103,38.544,104,31.756]],["parent/81",[0,2.482,1,0.69,2,0.69,105,6.806]],["name/82",[106,84.686]],["parent/82",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/83",[86,32.59,87,32.888,107,39.749]],["parent/83",[0,2.482,1,0.69,2,0.69,108,6.806]],["name/84",[109,84.686]],["parent/84",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/85",[86,22.572,87,22.778,110,26.315,111,30.618,112,23.226]],["parent/85",[0,2.482,1,0.69,2,0.69,113,6.806]],["name/86",[114,84.686]],["parent/86",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/87",[86,22.572,87,22.778,110,26.315,111,30.618,112,23.226]],["parent/87",[0,2.482,1,0.69,2,0.69,115,6.806]],["name/88",[116,84.686]],["parent/88",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/89",[86,26.671,117,38.544,118,38.544,119,36.179]],["parent/89",[0,2.482,1,0.69,2,0.69,120,6.806]],["name/90",[121,84.686]],["parent/90",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/91",[86,26.671,87,26.915,122,25.808,123,17.243]],["parent/91",[0,2.482,1,0.69,2,0.69,124,6.806]],["name/92",[125,84.686]],["parent/92",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/93",[86,26.671,87,26.915,122,25.808,123,17.243]],["parent/93",[0,2.482,1,0.69,2,0.69,126,6.806]],["name/94",[127,84.686]],["parent/94",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/95",[86,26.671,87,26.915,122,25.808,123,17.243]],["parent/95",[0,2.482,1,0.69,2,0.69,128,6.806]],["name/96",[129,84.686]],["parent/96",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/97",[86,26.671,87,26.915,122,25.808,123,17.243]],["parent/97",[0,2.482,1,0.69,2,0.69,130,6.806]],["name/98",[131,84.686]],["parent/98",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/99",[132,79.491]],["parent/99",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/100",[123,27.08,133,49.872]],["parent/100",[0,2.482,1,0.69,2,0.69,134,6.806]],["name/101",[135,79.491]],["parent/101",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/102",[123,27.08,133,49.872]],["parent/102",[0,2.482,1,0.69,2,0.69,136,6.806]],["name/103",[137,84.686]],["parent/103",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/104",[86,26.671,87,26.915,138,36.179,139,32.53]],["parent/104",[0,2.482,1,0.69,2,0.69,140,6.806]],["name/105",[141,84.686]],["parent/105",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/106",[86,26.671,87,26.915,142,34.622,143,32.53]],["parent/106",[0,2.482,1,0.69,2,0.69,144,6.806]],["name/107",[145,84.686]],["parent/107",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/108",[86,26.671,87,26.915,142,34.622,143,32.53]],["parent/108",[0,2.482,1,0.69,2,0.69,146,6.806]],["name/109",[147,84.686]],["parent/109",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/110",[86,26.671,87,26.915,142,34.622,143,32.53]],["parent/110",[0,2.482,1,0.69,2,0.69,148,6.806]],["name/111",[149,84.686]],["parent/111",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/112",[150,84.686]],["parent/112",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/113",[151,84.686]],["parent/113",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/114",[152,84.686]],["parent/114",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/115",[153,73.514]],["parent/115",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/116",[154,84.686]],["parent/116",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/117",[86,26.671,87,26.915,155,38.544,156,34.622]],["parent/117",[0,2.482,1,0.69,2,0.69,157,6.806]],["name/118",[158,84.686]],["parent/118",[0,2.482,1,0.69,2,0.69,82,4.318]],["name/119",[159,60.531,160,49.872]],["parent/119",[0,2.482,1,0.69,2,0.69,161,6.806]],["name/120",[162,84.686]],["parent/120",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/121",[163,53.406]],["parent/121",[0,2.482,1,0.69,2,0.69,164,6.114]],["name/122",[165,76.069]],["parent/122",[0,2.482,1,0.69,2,0.69,164,6.114]],["name/123",[166,76.069]],["parent/123",[0,2.482,1,0.69,2,0.69,164,6.114]],["name/124",[167,84.686]],["parent/124",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/125",[168,79.491]],["parent/125",[0,2.482,1,0.69,2,0.69,169,6.806]],["name/126",[170,79.491]],["parent/126",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/127",[171,84.686]],["parent/127",[0,2.482,1,0.69,2,0.69,172,6.806]],["name/128",[173,84.686]],["parent/128",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/129",[168,79.491]],["parent/129",[0,2.482,1,0.69,2,0.69,174,6.114]],["name/130",[175,84.686]],["parent/130",[0,2.482,1,0.69,2,0.69,174,6.114]],["name/131",[176,84.686]],["parent/131",[0,2.482,1,0.69,2,0.69,174,6.114]],["name/132",[177,84.686]],["parent/132",[0,2.482,1,0.69,2,0.69,178,5.908]],["name/133",[179,84.686]],["parent/133",[0,2.482,1,0.69,2,0.69,178,5.908]],["name/134",[180,84.686]],["parent/134",[0,2.482,1,0.69,2,0.69,178,5.908]],["name/135",[181,84.686]],["parent/135",[0,2.482,1,0.69,2,0.69,178,5.908]],["name/136",[182,79.491]],["parent/136",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/137",[183,84.686]],["parent/137",[0,2.482,1,0.69,2,0.69,184,6.806]],["name/138",[185,84.686]],["parent/138",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/139",[186,84.686]],["parent/139",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/140",[188,84.686]],["parent/140",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/141",[189,39.191]],["parent/141",[0,2.482,1,0.69,2,0.69,190,5.744]],["name/142",[191,49.763]],["parent/142",[0,2.482,1,0.69,2,0.69,190,5.744]],["name/143",[46,42.129]],["parent/143",[0,2.482,1,0.69,2,0.69,190,5.744]],["name/144",[123,37.886]],["parent/144",[0,2.482,1,0.69,2,0.69,190,5.744]],["name/145",[192,48.337]],["parent/145",[0,2.482,1,0.69,2,0.69,190,5.744]],["name/146",[193,84.686]],["parent/146",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/147",[189,39.191]],["parent/147",[0,2.482,1,0.69,2,0.69,194,5.744]],["name/148",[191,49.763]],["parent/148",[0,2.482,1,0.69,2,0.69,194,5.744]],["name/149",[46,42.129]],["parent/149",[0,2.482,1,0.69,2,0.69,194,5.744]],["name/150",[123,37.886]],["parent/150",[0,2.482,1,0.69,2,0.69,194,5.744]],["name/151",[192,48.337]],["parent/151",[0,2.482,1,0.69,2,0.69,194,5.744]],["name/152",[195,84.686]],["parent/152",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/153",[189,39.191]],["parent/153",[0,2.482,1,0.69,2,0.69,196,5.744]],["name/154",[191,49.763]],["parent/154",[0,2.482,1,0.69,2,0.69,196,5.744]],["name/155",[46,42.129]],["parent/155",[0,2.482,1,0.69,2,0.69,196,5.744]],["name/156",[123,37.886]],["parent/156",[0,2.482,1,0.69,2,0.69,196,5.744]],["name/157",[192,48.337]],["parent/157",[0,2.482,1,0.69,2,0.69,196,5.744]],["name/158",[197,84.686]],["parent/158",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/159",[189,39.191]],["parent/159",[0,2.482,1,0.69,2,0.69,198,5.744]],["name/160",[191,49.763]],["parent/160",[0,2.482,1,0.69,2,0.69,198,5.744]],["name/161",[46,42.129]],["parent/161",[0,2.482,1,0.69,2,0.69,198,5.744]],["name/162",[123,37.886]],["parent/162",[0,2.482,1,0.69,2,0.69,198,5.744]],["name/163",[192,48.337]],["parent/163",[0,2.482,1,0.69,2,0.69,198,5.744]],["name/164",[199,84.686]],["parent/164",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/165",[189,39.191]],["parent/165",[0,2.482,1,0.69,2,0.69,200,5.608]],["name/166",[191,49.763]],["parent/166",[0,2.482,1,0.69,2,0.69,200,5.608]],["name/167",[46,42.129]],["parent/167",[0,2.482,1,0.69,2,0.69,200,5.608]],["name/168",[123,37.886]],["parent/168",[0,2.482,1,0.69,2,0.69,200,5.608]],["name/169",[201,59.136]],["parent/169",[0,2.482,1,0.69,2,0.69,200,5.608]],["name/170",[192,48.337]],["parent/170",[0,2.482,1,0.69,2,0.69,200,5.608]],["name/171",[202,84.686]],["parent/171",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/172",[189,39.191]],["parent/172",[0,2.482,1,0.69,2,0.69,203,5.744]],["name/173",[191,49.763]],["parent/173",[0,2.482,1,0.69,2,0.69,203,5.744]],["name/174",[46,42.129]],["parent/174",[0,2.482,1,0.69,2,0.69,203,5.744]],["name/175",[123,37.886]],["parent/175",[0,2.482,1,0.69,2,0.69,203,5.744]],["name/176",[192,48.337]],["parent/176",[0,2.482,1,0.69,2,0.69,203,5.744]],["name/177",[204,84.686]],["parent/177",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/178",[189,39.191]],["parent/178",[0,2.482,1,0.69,2,0.69,205,5.744]],["name/179",[191,49.763]],["parent/179",[0,2.482,1,0.69,2,0.69,205,5.744]],["name/180",[46,42.129]],["parent/180",[0,2.482,1,0.69,2,0.69,205,5.744]],["name/181",[123,37.886]],["parent/181",[0,2.482,1,0.69,2,0.69,205,5.744]],["name/182",[192,48.337]],["parent/182",[0,2.482,1,0.69,2,0.69,205,5.744]],["name/183",[206,84.686]],["parent/183",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/184",[189,39.191]],["parent/184",[0,2.482,1,0.69,2,0.69,207,5.908]],["name/185",[46,42.129]],["parent/185",[0,2.482,1,0.69,2,0.69,207,5.908]],["name/186",[123,37.886]],["parent/186",[0,2.482,1,0.69,2,0.69,207,5.908]],["name/187",[192,48.337]],["parent/187",[0,2.482,1,0.69,2,0.69,207,5.908]],["name/188",[208,84.686]],["parent/188",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/189",[189,39.191]],["parent/189",[0,2.482,1,0.69,2,0.69,209,5.908]],["name/190",[46,42.129]],["parent/190",[0,2.482,1,0.69,2,0.69,209,5.908]],["name/191",[123,37.886]],["parent/191",[0,2.482,1,0.69,2,0.69,209,5.908]],["name/192",[192,48.337]],["parent/192",[0,2.482,1,0.69,2,0.69,209,5.908]],["name/193",[210,79.491]],["parent/193",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/194",[211,84.686]],["parent/194",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/195",[46,42.129]],["parent/195",[0,2.482,1,0.69,2,0.69,212,6.389]],["name/196",[192,48.337]],["parent/196",[0,2.482,1,0.69,2,0.69,212,6.389]],["name/197",[213,84.686]],["parent/197",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/198",[46,42.129]],["parent/198",[0,2.482,1,0.69,2,0.69,214,6.389]],["name/199",[192,48.337]],["parent/199",[0,2.482,1,0.69,2,0.69,214,6.389]],["name/200",[215,84.686]],["parent/200",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/201",[46,42.129]],["parent/201",[0,2.482,1,0.69,2,0.69,216,6.389]],["name/202",[192,48.337]],["parent/202",[0,2.482,1,0.69,2,0.69,216,6.389]],["name/203",[217,84.686]],["parent/203",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/204",[46,42.129]],["parent/204",[0,2.482,1,0.69,2,0.69,218,6.389]],["name/205",[192,48.337]],["parent/205",[0,2.482,1,0.69,2,0.69,218,6.389]],["name/206",[219,84.686]],["parent/206",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/207",[192,48.337]],["parent/207",[0,2.482,1,0.69,2,0.69,220,6.806]],["name/208",[221,84.686]],["parent/208",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/209",[46,42.129]],["parent/209",[0,2.482,1,0.69,2,0.69,222,6.389]],["name/210",[192,48.337]],["parent/210",[0,2.482,1,0.69,2,0.69,222,6.389]],["name/211",[223,84.686]],["parent/211",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/212",[46,42.129]],["parent/212",[0,2.482,1,0.69,2,0.69,224,6.389]],["name/213",[192,48.337]],["parent/213",[0,2.482,1,0.69,2,0.69,224,6.389]],["name/214",[225,84.686]],["parent/214",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/215",[46,42.129]],["parent/215",[0,2.482,1,0.69,2,0.69,226,6.389]],["name/216",[192,48.337]],["parent/216",[0,2.482,1,0.69,2,0.69,226,6.389]],["name/217",[227,84.686]],["parent/217",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/218",[46,42.129]],["parent/218",[0,2.482,1,0.69,2,0.69,228,6.389]],["name/219",[192,48.337]],["parent/219",[0,2.482,1,0.69,2,0.69,228,6.389]],["name/220",[229,84.686]],["parent/220",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/221",[230,84.686]],["parent/221",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/222",[231,84.686]],["parent/222",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/223",[232,84.686]],["parent/223",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/224",[233,84.686]],["parent/224",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/225",[46,42.129]],["parent/225",[0,2.482,1,0.69,2,0.69,234,6.389]],["name/226",[235,59.136]],["parent/226",[0,2.482,1,0.69,2,0.69,234,6.389]],["name/227",[236,84.686]],["parent/227",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/228",[46,42.129]],["parent/228",[0,2.482,1,0.69,2,0.69,237,6.389]],["name/229",[235,59.136]],["parent/229",[0,2.482,1,0.69,2,0.69,237,6.389]],["name/230",[238,84.686]],["parent/230",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/231",[239,84.686]],["parent/231",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/232",[240,84.686]],["parent/232",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/233",[46,42.129]],["parent/233",[0,2.482,1,0.69,2,0.69,241,6.389]],["name/234",[235,59.136]],["parent/234",[0,2.482,1,0.69,2,0.69,241,6.389]],["name/235",[242,84.686]],["parent/235",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/236",[46,42.129]],["parent/236",[0,2.482,1,0.69,2,0.69,243,6.389]],["name/237",[235,59.136]],["parent/237",[0,2.482,1,0.69,2,0.69,243,6.389]],["name/238",[244,84.686]],["parent/238",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/239",[245,73.514]],["parent/239",[0,2.482,1,0.69,2,0.69,246,6.806]],["name/240",[247,73.514]],["parent/240",[0,2.482,1,0.69,2,0.69,248,6.806]],["name/241",[249,79.491]],["parent/241",[0,2.482,1,0.69,2,0.69,187,4.292]],["name/242",[123,37.886]],["parent/242",[0,2.482,1,0.69,2,0.69,250,5.908]],["name/243",[251,62.341]],["parent/243",[0,2.482,1,0.69,2,0.69,250,5.908]],["name/244",[123,37.886]],["parent/244",[0,2.482,1,0.69,2,0.69,252,5.744]],["name/245",[44,64.897]],["parent/245",[0,2.482,1,0.69,2,0.69,252,5.744]],["name/246",[46,42.129]],["parent/246",[0,2.482,1,0.69,2,0.69,252,5.744]],["name/247",[253,62.341]],["parent/247",[0,2.482,1,0.69,2,0.69,252,5.744]],["name/248",[254,73.514]],["parent/248",[0,2.482,1,0.69,2,0.69,255,5.297]],["name/249",[123,37.886]],["parent/249",[0,2.482,1,0.69,2,0.69,256,6.114]],["name/250",[257,52.508]],["parent/250",[0,2.482,1,0.69,2,0.69,256,6.114]],["name/251",[258,63.971]],["parent/251",[0,2.482,1,0.69,2,0.69,256,6.114]],["name/252",[259,63.971]],["parent/252",[0,2.482,1,0.69,2,0.69,255,5.297]],["name/253",[123,37.886]],["parent/253",[0,2.482,1,0.69,2,0.69,260,6.389]],["name/254",[257,52.508]],["parent/254",[0,2.482,1,0.69,2,0.69,260,6.389]],["name/255",[261,58.092]],["parent/255",[0,2.482,1,0.69,2,0.69,255,5.297]],["name/256",[123,37.886]],["parent/256",[0,2.482,1,0.69,2,0.69,262,5.908]],["name/257",[63,61.614]],["parent/257",[0,2.482,1,0.69,2,0.69,262,5.908]],["name/258",[257,52.508]],["parent/258",[0,2.482,1,0.69,2,0.69,262,5.908]],["name/259",[258,63.971]],["parent/259",[0,2.482,1,0.69,2,0.69,262,5.908]],["name/260",[263,69.774]],["parent/260",[0,2.482,1,0.69,2,0.69,255,5.297]],["name/261",[123,37.886]],["parent/261",[0,2.482,1,0.69,2,0.69,264,5.908]],["name/262",[63,61.614]],["parent/262",[0,2.482,1,0.69,2,0.69,264,5.908]],["name/263",[257,52.508]],["parent/263",[0,2.482,1,0.69,2,0.69,264,5.908]],["name/264",[258,63.971]],["parent/264",[0,2.482,1,0.69,2,0.69,264,5.908]],["name/265",[265,73.514]],["parent/265",[0,2.482,1,0.69,2,0.69,255,5.297]],["name/266",[123,37.886]],["parent/266",[0,2.482,1,0.69,2,0.69,266,6.114]],["name/267",[257,52.508]],["parent/267",[0,2.482,1,0.69,2,0.69,266,6.114]],["name/268",[258,63.971]],["parent/268",[0,2.482,1,0.69,2,0.69,266,6.114]],["name/269",[267,79.491]],["parent/269",[0,2.482,1,0.69,2,0.69,255,5.297]],["name/270",[123,37.886]],["parent/270",[0,2.482,1,0.69,2,0.69,268,6.389]],["name/271",[257,52.508]],["parent/271",[0,2.482,1,0.69,2,0.69,268,6.389]],["name/272",[269,79.491]],["parent/272",[0,2.482,1,0.69,2,0.69,255,5.297]],["name/273",[123,37.886]],["parent/273",[0,2.482,1,0.69,2,0.69,270,6.114]],["name/274",[63,61.614]],["parent/274",[0,2.482,1,0.69,2,0.69,270,6.114]],["name/275",[257,52.508]],["parent/275",[0,2.482,1,0.69,2,0.69,270,6.114]],["name/276",[271,79.491]],["parent/276",[0,2.482,1,0.69,2,0.69,255,5.297]],["name/277",[123,37.886]],["parent/277",[0,2.482,1,0.69,2,0.69,272,6.389]],["name/278",[257,52.508]],["parent/278",[0,2.482,1,0.69,2,0.69,272,6.389]],["name/279",[273,79.491]],["parent/279",[0,2.482,1,0.69,2,0.69,255,5.297]],["name/280",[123,37.886]],["parent/280",[0,2.482,1,0.69,2,0.69,274,6.389]],["name/281",[257,52.508]],["parent/281",[0,2.482,1,0.69,2,0.69,274,6.389]],["name/282",[275,58.601]],["parent/282",[0,2.482,1,0.69,2,0.69,252,5.744]],["name/283",[276,71.473]],["parent/283",[0,2.482,1,0.69,2,0.69,250,5.908]],["name/284",[277,73.514]],["parent/284",[0,2.482,1,0.69,2,0.69,250,5.908]],["name/285",[278,84.686]],["parent/285",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/286",[279,32.637]],["parent/286",[0,2.482,1,0.69,2,0.69,280,6.806]],["name/287",[281,84.686]],["parent/287",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/288",[279,32.637]],["parent/288",[0,2.482,1,0.69,2,0.69,282,6.806]],["name/289",[283,84.686]],["parent/289",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/290",[284,84.686]],["parent/290",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/291",[285,84.686]],["parent/291",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/292",[286,79.491]],["parent/292",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/293",[287,79.491]],["parent/293",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/294",[288,84.686]],["parent/294",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/295",[289,84.686]],["parent/295",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/296",[290,79.491]],["parent/296",[0,2.482,1,0.69,2,0.69,3,2.387]],["name/297",[291,25.238]],["parent/297",[]],["name/298",[292,84.686]],["parent/298",[291,3.313]],["name/299",[293,73.514]],["parent/299",[294,9.159]],["name/300",[295,84.686]],["parent/300",[294,9.159]],["name/301",[296,69.774]],["parent/301",[294,9.159]],["name/302",[297,79.491]],["parent/302",[294,9.159]],["name/303",[298,63.971]],["parent/303",[294,9.159]],["name/304",[299,84.686]],["parent/304",[294,9.159]],["name/305",[300,84.686]],["parent/305",[291,3.313]],["name/306",[301,58.092]],["parent/306",[302,9.986]],["name/307",[303,84.686]],["parent/307",[302,9.986]],["name/308",[304,71.473]],["parent/308",[302,9.986]],["name/309",[305,84.686]],["parent/309",[291,3.313]],["name/310",[306,79.491]],["parent/310",[307,9.159]],["name/311",[308,63.971]],["parent/311",[307,9.159]],["name/312",[309,64.897]],["parent/312",[307,9.159]],["name/313",[310,63.971]],["parent/313",[307,9.159]],["name/314",[311,64.897]],["parent/314",[307,9.159]],["name/315",[312,64.897]],["parent/315",[307,9.159]],["name/316",[313,84.686]],["parent/316",[291,3.313]],["name/317",[123,37.886]],["parent/317",[314,10.435]],["name/318",[315,79.491]],["parent/318",[314,10.435]],["name/319",[316,84.686]],["parent/319",[291,3.313]],["name/320",[123,37.886]],["parent/320",[317,10.435]],["name/321",[318,84.686]],["parent/321",[317,10.435]],["name/322",[319,84.686]],["parent/322",[291,3.313]],["name/323",[320,84.686]],["parent/323",[321,10.435]],["name/324",[18,47.256]],["parent/324",[322,11.117]],["name/325",[323,84.686]],["parent/325",[321,10.435]],["name/326",[18,47.256]],["parent/326",[324,11.117]],["name/327",[325,84.686]],["parent/327",[291,3.313]],["name/328",[326,84.686]],["parent/328",[327,11.117]],["name/329",[328,84.686]],["parent/329",[291,3.313]],["name/330",[329,55.105]],["parent/330",[330,10.435]],["name/331",[331,55.105]],["parent/331",[330,10.435]],["name/332",[332,84.686]],["parent/332",[291,3.313]],["name/333",[333,84.686]],["parent/333",[334,7.999]],["name/334",[335,84.686]],["parent/334",[334,7.999]],["name/335",[336,84.686]],["parent/335",[334,7.999]],["name/336",[337,84.686]],["parent/336",[334,7.999]],["name/337",[338,84.686]],["parent/337",[334,7.999]],["name/338",[339,84.686]],["parent/338",[334,7.999]],["name/339",[340,84.686]],["parent/339",[334,7.999]],["name/340",[341,84.686]],["parent/340",[334,7.999]],["name/341",[342,84.686]],["parent/341",[334,7.999]],["name/342",[343,84.686]],["parent/342",[334,7.999]],["name/343",[344,84.686]],["parent/343",[334,7.999]],["name/344",[345,79.491]],["parent/344",[334,7.999]],["name/345",[346,84.686]],["parent/345",[334,7.999]],["name/346",[347,84.686]],["parent/346",[334,7.999]],["name/347",[348,84.686]],["parent/347",[334,7.999]],["name/348",[349,84.686]],["parent/348",[291,3.313]],["name/349",[18,47.256]],["parent/349",[350,11.117]],["name/350",[351,84.686]],["parent/350",[291,3.313]],["name/351",[18,47.256]],["parent/351",[352,11.117]],["name/352",[353,84.686]],["parent/352",[291,3.313]],["name/353",[354,76.069]],["parent/353",[355,7.999]],["name/354",[356,84.686]],["parent/354",[355,7.999]],["name/355",[357,84.686]],["parent/355",[355,7.999]],["name/356",[358,84.686]],["parent/356",[355,7.999]],["name/357",[359,84.686]],["parent/357",[355,7.999]],["name/358",[360,84.686]],["parent/358",[355,7.999]],["name/359",[361,84.686]],["parent/359",[355,7.999]],["name/360",[362,84.686]],["parent/360",[355,7.999]],["name/361",[363,84.686]],["parent/361",[355,7.999]],["name/362",[364,84.686]],["parent/362",[355,7.999]],["name/363",[365,84.686]],["parent/363",[355,7.999]],["name/364",[366,84.686]],["parent/364",[355,7.999]],["name/365",[367,84.686]],["parent/365",[355,7.999]],["name/366",[368,84.686]],["parent/366",[355,7.999]],["name/367",[369,84.686]],["parent/367",[355,7.999]],["name/368",[370,84.686]],["parent/368",[291,3.313]],["name/369",[371,84.686]],["parent/369",[372,11.117]],["name/370",[373,84.686]],["parent/370",[291,3.313]],["name/371",[374,84.686]],["parent/371",[375,7.234]],["name/372",[376,84.686]],["parent/372",[375,7.234]],["name/373",[377,84.686]],["parent/373",[375,7.234]],["name/374",[378,84.686]],["parent/374",[375,7.234]],["name/375",[379,84.686]],["parent/375",[375,7.234]],["name/376",[380,84.686]],["parent/376",[375,7.234]],["name/377",[381,84.686]],["parent/377",[375,7.234]],["name/378",[382,84.686]],["parent/378",[375,7.234]],["name/379",[383,84.686]],["parent/379",[375,7.234]],["name/380",[384,84.686]],["parent/380",[375,7.234]],["name/381",[385,84.686]],["parent/381",[375,7.234]],["name/382",[386,84.686]],["parent/382",[375,7.234]],["name/383",[387,84.686]],["parent/383",[375,7.234]],["name/384",[388,84.686]],["parent/384",[375,7.234]],["name/385",[389,84.686]],["parent/385",[375,7.234]],["name/386",[390,84.686]],["parent/386",[375,7.234]],["name/387",[391,84.686]],["parent/387",[375,7.234]],["name/388",[392,84.686]],["parent/388",[375,7.234]],["name/389",[393,84.686]],["parent/389",[375,7.234]],["name/390",[394,84.686]],["parent/390",[375,7.234]],["name/391",[395,84.686]],["parent/391",[375,7.234]],["name/392",[396,84.686]],["parent/392",[375,7.234]],["name/393",[397,84.686]],["parent/393",[375,7.234]],["name/394",[398,84.686]],["parent/394",[375,7.234]],["name/395",[399,84.686]],["parent/395",[375,7.234]],["name/396",[400,84.686]],["parent/396",[375,7.234]],["name/397",[401,84.686]],["parent/397",[375,7.234]],["name/398",[402,84.686]],["parent/398",[291,3.313]],["name/399",[403,65.914]],["parent/399",[404,9.986]],["name/400",[405,79.491]],["parent/400",[404,9.986]],["name/401",[279,32.637]],["parent/401",[404,9.986]],["name/402",[406,84.686]],["parent/402",[291,3.313]],["name/403",[407,73.514]],["parent/403",[408,8.968]],["name/404",[409,76.069]],["parent/404",[408,8.968]],["name/405",[410,76.069]],["parent/405",[408,8.968]],["name/406",[411,63.971]],["parent/406",[408,8.968]],["name/407",[412,76.069]],["parent/407",[408,8.968]],["name/408",[413,67.046]],["parent/408",[408,8.968]],["name/409",[414,76.069]],["parent/409",[408,8.968]],["name/410",[415,40.51]],["parent/410",[291,3.313]],["name/411",[416,84.686]],["parent/411",[417,6.893]],["name/412",[418,84.686]],["parent/412",[417,6.893]],["name/413",[419,84.686]],["parent/413",[417,6.893]],["name/414",[420,79.491]],["parent/414",[417,6.893]],["name/415",[421,84.686]],["parent/415",[417,6.893]],["name/416",[422,84.686]],["parent/416",[417,6.893]],["name/417",[423,84.686]],["parent/417",[417,6.893]],["name/418",[424,84.686]],["parent/418",[417,6.893]],["name/419",[425,45.531]],["parent/419",[417,6.893]],["name/420",[426,84.686]],["parent/420",[417,6.893]],["name/421",[427,84.686]],["parent/421",[417,6.893]],["name/422",[428,84.686]],["parent/422",[417,6.893]],["name/423",[429,84.686]],["parent/423",[417,6.893]],["name/424",[430,84.686]],["parent/424",[417,6.893]],["name/425",[431,84.686]],["parent/425",[417,6.893]],["name/426",[432,84.686]],["parent/426",[417,6.893]],["name/427",[433,84.686]],["parent/427",[417,6.893]],["name/428",[434,84.686]],["parent/428",[417,6.893]],["name/429",[435,84.686]],["parent/429",[417,6.893]],["name/430",[436,84.686]],["parent/430",[417,6.893]],["name/431",[437,84.686]],["parent/431",[417,6.893]],["name/432",[411,63.971]],["parent/432",[417,6.893]],["name/433",[409,76.069]],["parent/433",[417,6.893]],["name/434",[410,76.069]],["parent/434",[417,6.893]],["name/435",[412,76.069]],["parent/435",[417,6.893]],["name/436",[413,67.046]],["parent/436",[417,6.893]],["name/437",[414,76.069]],["parent/437",[417,6.893]],["name/438",[438,79.491]],["parent/438",[417,6.893]],["name/439",[439,79.491]],["parent/439",[417,6.893]],["name/440",[440,68.319]],["parent/440",[417,6.893]],["name/441",[441,84.686]],["parent/441",[417,6.893]],["name/442",[407,73.514]],["parent/442",[417,6.893]],["name/443",[442,76.069]],["parent/443",[417,6.893]],["name/444",[443,79.491]],["parent/444",[417,6.893]],["name/445",[444,84.686]],["parent/445",[417,6.893]],["name/446",[445,84.686]],["parent/446",[291,3.313]],["name/447",[446,84.686]],["parent/447",[447,7.999]],["name/448",[448,64.897]],["parent/448",[447,7.999]],["name/449",[449,65.914]],["parent/449",[447,7.999]],["name/450",[450,84.686]],["parent/450",[447,7.999]],["name/451",[451,84.686]],["parent/451",[447,7.999]],["name/452",[452,84.686]],["parent/452",[447,7.999]],["name/453",[415,40.51]],["parent/453",[447,7.999]],["name/454",[453,84.686]],["parent/454",[447,7.999]],["name/455",[425,45.531]],["parent/455",[447,7.999]],["name/456",[454,84.686]],["parent/456",[447,7.999]],["name/457",[455,84.686]],["parent/457",[447,7.999]],["name/458",[456,84.686]],["parent/458",[447,7.999]],["name/459",[457,84.686]],["parent/459",[447,7.999]],["name/460",[458,84.686]],["parent/460",[447,7.999]],["name/461",[459,84.686]],["parent/461",[447,7.999]],["name/462",[460,84.686]],["parent/462",[291,3.313]],["name/463",[461,64.897]],["parent/463",[462,10.435]],["name/464",[298,63.971]],["parent/464",[462,10.435]],["name/465",[463,84.686]],["parent/465",[291,3.313]],["name/466",[464,84.686]],["parent/466",[465,9.159]],["name/467",[466,84.686]],["parent/467",[465,9.159]],["name/468",[467,79.491]],["parent/468",[465,9.159]],["name/469",[468,67.046]],["parent/469",[465,9.159]],["name/470",[469,84.686]],["parent/470",[465,9.159]],["name/471",[470,84.686]],["parent/471",[465,9.159]],["name/472",[471,84.686]],["parent/472",[291,3.313]],["name/473",[472,84.686]],["parent/473",[473,6.138]],["name/474",[474,84.686]],["parent/474",[473,6.138]],["name/475",[475,84.686]],["parent/475",[473,6.138]],["name/476",[476,84.686]],["parent/476",[473,6.138]],["name/477",[477,84.686]],["parent/477",[473,6.138]],["name/478",[478,84.686]],["parent/478",[473,6.138]],["name/479",[479,84.686]],["parent/479",[473,6.138]],["name/480",[480,84.686]],["parent/480",[473,6.138]],["name/481",[481,84.686]],["parent/481",[473,6.138]],["name/482",[482,84.686]],["parent/482",[473,6.138]],["name/483",[483,84.686]],["parent/483",[473,6.138]],["name/484",[484,84.686]],["parent/484",[473,6.138]],["name/485",[485,84.686]],["parent/485",[473,6.138]],["name/486",[486,84.686]],["parent/486",[473,6.138]],["name/487",[487,84.686]],["parent/487",[473,6.138]],["name/488",[488,84.686]],["parent/488",[473,6.138]],["name/489",[489,84.686]],["parent/489",[473,6.138]],["name/490",[490,84.686]],["parent/490",[473,6.138]],["name/491",[491,84.686]],["parent/491",[473,6.138]],["name/492",[492,84.686]],["parent/492",[473,6.138]],["name/493",[493,84.686]],["parent/493",[473,6.138]],["name/494",[494,84.686]],["parent/494",[473,6.138]],["name/495",[495,84.686]],["parent/495",[473,6.138]],["name/496",[496,84.686]],["parent/496",[473,6.138]],["name/497",[497,84.686]],["parent/497",[473,6.138]],["name/498",[498,84.686]],["parent/498",[473,6.138]],["name/499",[499,84.686]],["parent/499",[473,6.138]],["name/500",[500,84.686]],["parent/500",[473,6.138]],["name/501",[501,84.686]],["parent/501",[473,6.138]],["name/502",[502,84.686]],["parent/502",[473,6.138]],["name/503",[503,84.686]],["parent/503",[473,6.138]],["name/504",[504,84.686]],["parent/504",[473,6.138]],["name/505",[505,84.686]],["parent/505",[473,6.138]],["name/506",[506,84.686]],["parent/506",[473,6.138]],["name/507",[507,84.686]],["parent/507",[473,6.138]],["name/508",[508,84.686]],["parent/508",[473,6.138]],["name/509",[509,84.686]],["parent/509",[473,6.138]],["name/510",[510,84.686]],["parent/510",[473,6.138]],["name/511",[511,84.686]],["parent/511",[473,6.138]],["name/512",[512,84.686]],["parent/512",[473,6.138]],["name/513",[513,84.686]],["parent/513",[473,6.138]],["name/514",[514,84.686]],["parent/514",[473,6.138]],["name/515",[515,84.686]],["parent/515",[473,6.138]],["name/516",[516,84.686]],["parent/516",[473,6.138]],["name/517",[517,84.686]],["parent/517",[473,6.138]],["name/518",[518,84.686]],["parent/518",[473,6.138]],["name/519",[519,84.686]],["parent/519",[473,6.138]],["name/520",[520,84.686]],["parent/520",[473,6.138]],["name/521",[521,84.686]],["parent/521",[473,6.138]],["name/522",[522,84.686]],["parent/522",[473,6.138]],["name/523",[523,84.686]],["parent/523",[473,6.138]],["name/524",[524,84.686]],["parent/524",[473,6.138]],["name/525",[525,84.686]],["parent/525",[473,6.138]],["name/526",[526,84.686]],["parent/526",[473,6.138]],["name/527",[527,84.686]],["parent/527",[473,6.138]],["name/528",[528,84.686]],["parent/528",[473,6.138]],["name/529",[529,84.686]],["parent/529",[473,6.138]],["name/530",[530,84.686]],["parent/530",[473,6.138]],["name/531",[531,84.686]],["parent/531",[473,6.138]],["name/532",[532,84.686]],["parent/532",[473,6.138]],["name/533",[533,84.686]],["parent/533",[473,6.138]],["name/534",[534,84.686]],["parent/534",[473,6.138]],["name/535",[535,84.686]],["parent/535",[291,3.313]],["name/536",[536,84.686]],["parent/536",[537,8.968]],["name/537",[538,84.686]],["parent/537",[537,8.968]],["name/538",[539,84.686]],["parent/538",[537,8.968]],["name/539",[540,84.686]],["parent/539",[537,8.968]],["name/540",[541,84.686]],["parent/540",[537,8.968]],["name/541",[542,84.686]],["parent/541",[537,8.968]],["name/542",[543,73.514]],["parent/542",[537,8.968]],["name/543",[544,84.686]],["parent/543",[291,3.313]],["name/544",[545,84.686]],["parent/544",[546,9.986]],["name/545",[547,84.686]],["parent/545",[546,9.986]],["name/546",[461,64.897]],["parent/546",[546,9.986]],["name/547",[548,84.686]],["parent/547",[291,3.313]],["name/548",[549,84.686]],["parent/548",[550,9.159]],["name/549",[551,84.686]],["parent/549",[550,9.159]],["name/550",[552,84.686]],["parent/550",[550,9.159]],["name/551",[553,84.686]],["parent/551",[550,9.159]],["name/552",[554,84.686]],["parent/552",[550,9.159]],["name/553",[555,84.686]],["parent/553",[550,9.159]],["name/554",[556,84.686]],["parent/554",[291,3.313]],["name/555",[123,37.886]],["parent/555",[557,9.382]],["name/556",[139,71.473]],["parent/556",[557,9.382]],["name/557",[253,62.341]],["parent/557",[557,9.382]],["name/558",[63,61.614]],["parent/558",[557,9.382]],["name/559",[258,63.971]],["parent/559",[557,9.382]],["name/560",[558,84.686]],["parent/560",[291,3.313]],["name/561",[44,64.897]],["parent/561",[559,9.159]],["name/562",[46,42.129]],["parent/562",[559,9.159]],["name/563",[123,37.886]],["parent/563",[559,9.159]],["name/564",[253,62.341]],["parent/564",[559,9.159]],["name/565",[18,47.256]],["parent/565",[560,11.117]],["name/566",[112,60.3]],["parent/566",[559,9.159]],["name/567",[275,58.601]],["parent/567",[559,9.159]],["name/568",[561,84.686]],["parent/568",[291,3.313]],["name/569",[123,37.886]],["parent/569",[562,9.986]],["name/570",[275,58.601]],["parent/570",[562,9.986]],["name/571",[46,42.129]],["parent/571",[562,9.986]],["name/572",[563,84.686]],["parent/572",[291,3.313]],["name/573",[123,37.886]],["parent/573",[564,9.65]],["name/574",[251,62.341]],["parent/574",[564,9.65]],["name/575",[565,76.069]],["parent/575",[564,9.65]],["name/576",[566,79.491]],["parent/576",[564,9.65]],["name/577",[567,84.686]],["parent/577",[291,3.313]],["name/578",[568,76.069]],["parent/578",[569,9.159]],["name/579",[570,79.491]],["parent/579",[569,9.159]],["name/580",[571,79.491]],["parent/580",[569,9.159]],["name/581",[572,67.046]],["parent/581",[569,9.159]],["name/582",[573,84.686]],["parent/582",[569,9.159]],["name/583",[574,68.319]],["parent/583",[569,9.159]],["name/584",[575,84.686]],["parent/584",[291,3.313]],["name/585",[576,84.686]],["parent/585",[577,9.159]],["name/586",[578,84.686]],["parent/586",[577,9.159]],["name/587",[579,79.491]],["parent/587",[577,9.159]],["name/588",[580,84.686]],["parent/588",[577,9.159]],["name/589",[581,79.491]],["parent/589",[577,9.159]],["name/590",[261,58.092]],["parent/590",[577,9.159]],["name/591",[582,84.686]],["parent/591",[291,3.313]],["name/592",[583,84.686]],["parent/592",[584,9.382]],["name/593",[425,45.531]],["parent/593",[584,9.382]],["name/594",[585,68.319]],["parent/594",[584,9.382]],["name/595",[586,73.514]],["parent/595",[584,9.382]],["name/596",[587,60.3]],["parent/596",[584,9.382]],["name/597",[588,84.686]],["parent/597",[291,3.313]],["name/598",[589,79.491]],["parent/598",[590,9.65]],["name/599",[591,84.686]],["parent/599",[590,9.65]],["name/600",[592,84.686]],["parent/600",[590,9.65]],["name/601",[593,84.686]],["parent/601",[590,9.65]],["name/602",[594,84.686]],["parent/602",[291,3.313]],["name/603",[253,62.341]],["parent/603",[595,9.65]],["name/604",[18,47.256]],["parent/604",[596,11.117]],["name/605",[123,37.886]],["parent/605",[595,9.65]],["name/606",[597,69.774]],["parent/606",[595,9.65]],["name/607",[18,47.256]],["parent/607",[598,11.117]],["name/608",[63,61.614]],["parent/608",[595,9.65]],["name/609",[599,84.686]],["parent/609",[291,3.313]],["name/610",[251,62.341]],["parent/610",[600,9.382]],["name/611",[601,79.491]],["parent/611",[600,9.382]],["name/612",[18,47.256]],["parent/612",[602,11.117]],["name/613",[597,69.774]],["parent/613",[600,9.382]],["name/614",[18,47.256]],["parent/614",[603,11.117]],["name/615",[604,79.491]],["parent/615",[600,9.382]],["name/616",[605,76.069]],["parent/616",[600,9.382]],["name/617",[606,84.686]],["parent/617",[291,3.313]],["name/618",[607,67.046]],["parent/618",[608,9.382]],["name/619",[609,73.514]],["parent/619",[608,9.382]],["name/620",[253,62.341]],["parent/620",[608,9.382]],["name/621",[610,73.514]],["parent/621",[608,9.382]],["name/622",[261,58.092]],["parent/622",[608,9.382]],["name/623",[611,84.686]],["parent/623",[291,3.313]],["name/624",[612,63.971]],["parent/624",[613,10.435]],["name/625",[18,47.256]],["parent/625",[614,11.117]],["name/626",[615,65.914]],["parent/626",[613,10.435]],["name/627",[18,47.256]],["parent/627",[616,11.117]],["name/628",[617,84.686]],["parent/628",[291,3.313]],["name/629",[618,84.686]],["parent/629",[619,9.65]],["name/630",[620,84.686]],["parent/630",[619,9.65]],["name/631",[621,84.686]],["parent/631",[619,9.65]],["name/632",[622,84.686]],["parent/632",[619,9.65]],["name/633",[623,84.686]],["parent/633",[291,3.313]],["name/634",[18,47.256]],["parent/634",[624,11.117]],["name/635",[625,84.686]],["parent/635",[291,3.313]],["name/636",[18,47.256]],["parent/636",[626,11.117]],["name/637",[627,84.686]],["parent/637",[291,3.313]],["name/638",[425,45.531]],["parent/638",[628,10.435]],["name/639",[629,60.936]],["parent/639",[628,10.435]],["name/640",[630,84.686]],["parent/640",[291,3.313]],["name/641",[543,73.514]],["parent/641",[631,8.653]],["name/642",[632,73.514]],["parent/642",[631,8.653]],["name/643",[633,84.686]],["parent/643",[631,8.653]],["name/644",[634,69.774]],["parent/644",[631,8.653]],["name/645",[635,73.514]],["parent/645",[631,8.653]],["name/646",[636,73.514]],["parent/646",[631,8.653]],["name/647",[637,84.686]],["parent/647",[631,8.653]],["name/648",[425,45.531]],["parent/648",[631,8.653]],["name/649",[629,60.936]],["parent/649",[631,8.653]],["name/650",[638,84.686]],["parent/650",[291,3.313]],["name/651",[634,69.774]],["parent/651",[639,9.986]],["name/652",[425,45.531]],["parent/652",[639,9.986]],["name/653",[629,60.936]],["parent/653",[639,9.986]],["name/654",[640,84.686]],["parent/654",[291,3.313]],["name/655",[635,73.514]],["parent/655",[641,8.286]],["name/656",[634,69.774]],["parent/656",[641,8.286]],["name/657",[609,73.514]],["parent/657",[641,8.286]],["name/658",[642,84.686]],["parent/658",[641,8.286]],["name/659",[643,84.686]],["parent/659",[641,8.286]],["name/660",[644,84.686]],["parent/660",[641,8.286]],["name/661",[645,84.686]],["parent/661",[641,8.286]],["name/662",[646,84.686]],["parent/662",[641,8.286]],["name/663",[647,84.686]],["parent/663",[641,8.286]],["name/664",[648,84.686]],["parent/664",[641,8.286]],["name/665",[425,45.531]],["parent/665",[641,8.286]],["name/666",[629,60.936]],["parent/666",[641,8.286]],["name/667",[649,84.686]],["parent/667",[291,3.313]],["name/668",[650,68.319]],["parent/668",[651,8.184]],["name/669",[425,45.531]],["parent/669",[651,8.184]],["name/670",[42,71.473]],["parent/670",[651,8.184]],["name/671",[652,79.491]],["parent/671",[651,8.184]],["name/672",[189,39.191]],["parent/672",[651,8.184]],["name/673",[653,67.046]],["parent/673",[651,8.184]],["name/674",[612,63.971]],["parent/674",[651,8.184]],["name/675",[615,65.914]],["parent/675",[651,8.184]],["name/676",[654,76.069]],["parent/676",[651,8.184]],["name/677",[655,76.069]],["parent/677",[651,8.184]],["name/678",[656,76.069]],["parent/678",[651,8.184]],["name/679",[657,76.069]],["parent/679",[651,8.184]],["name/680",[658,76.069]],["parent/680",[651,8.184]],["name/681",[659,84.686]],["parent/681",[291,3.313]],["name/682",[660,84.686]],["parent/682",[291,3.313]],["name/683",[661,84.686]],["parent/683",[291,3.313]],["name/684",[42,71.473]],["parent/684",[662,9.65]],["name/685",[663,79.491]],["parent/685",[662,9.65]],["name/686",[652,79.491]],["parent/686",[662,9.65]],["name/687",[664,84.686]],["parent/687",[662,9.65]],["name/688",[665,84.686]],["parent/688",[291,3.313]],["name/689",[666,84.686]],["parent/689",[667,7.444]],["name/690",[668,79.491]],["parent/690",[667,7.444]],["name/691",[669,84.686]],["parent/691",[667,7.444]],["name/692",[670,84.686]],["parent/692",[667,7.444]],["name/693",[671,84.686]],["parent/693",[667,7.444]],["name/694",[425,45.531]],["parent/694",[667,7.444]],["name/695",[650,68.319]],["parent/695",[667,7.444]],["name/696",[655,76.069]],["parent/696",[667,7.444]],["name/697",[656,76.069]],["parent/697",[667,7.444]],["name/698",[657,76.069]],["parent/698",[667,7.444]],["name/699",[658,76.069]],["parent/699",[667,7.444]],["name/700",[672,84.686]],["parent/700",[667,7.444]],["name/701",[673,84.686]],["parent/701",[667,7.444]],["name/702",[674,84.686]],["parent/702",[667,7.444]],["name/703",[675,84.686]],["parent/703",[667,7.444]],["name/704",[676,84.686]],["parent/704",[667,7.444]],["name/705",[677,84.686]],["parent/705",[667,7.444]],["name/706",[42,71.473]],["parent/706",[667,7.444]],["name/707",[189,39.191]],["parent/707",[667,7.444]],["name/708",[653,67.046]],["parent/708",[667,7.444]],["name/709",[612,63.971]],["parent/709",[667,7.444]],["name/710",[615,65.914]],["parent/710",[667,7.444]],["name/711",[654,76.069]],["parent/711",[667,7.444]],["name/712",[678,84.686]],["parent/712",[291,3.313]],["name/713",[425,45.531]],["parent/713",[679,8.519]],["name/714",[680,67.046]],["parent/714",[679,8.519]],["name/715",[308,63.971]],["parent/715",[679,8.519]],["name/716",[309,64.897]],["parent/716",[679,8.519]],["name/717",[681,67.046]],["parent/717",[679,8.519]],["name/718",[311,64.897]],["parent/718",[679,8.519]],["name/719",[312,64.897]],["parent/719",[679,8.519]],["name/720",[310,63.971]],["parent/720",[679,8.519]],["name/721",[279,32.637]],["parent/721",[679,8.519]],["name/722",[189,39.191]],["parent/722",[679,8.519]],["name/723",[682,84.686]],["parent/723",[291,3.313]],["name/724",[425,45.531]],["parent/724",[683,8.184]],["name/725",[42,71.473]],["parent/725",[683,8.184]],["name/726",[684,84.686]],["parent/726",[683,8.184]],["name/727",[656,76.069]],["parent/727",[683,8.184]],["name/728",[657,76.069]],["parent/728",[683,8.184]],["name/729",[658,76.069]],["parent/729",[683,8.184]],["name/730",[650,68.319]],["parent/730",[683,8.184]],["name/731",[189,39.191]],["parent/731",[683,8.184]],["name/732",[653,67.046]],["parent/732",[683,8.184]],["name/733",[612,63.971]],["parent/733",[683,8.184]],["name/734",[615,65.914]],["parent/734",[683,8.184]],["name/735",[654,76.069]],["parent/735",[683,8.184]],["name/736",[655,76.069]],["parent/736",[683,8.184]],["name/737",[685,84.686]],["parent/737",[291,3.313]],["name/738",[650,68.319]],["parent/738",[686,9.65]],["name/739",[687,84.686]],["parent/739",[686,9.65]],["name/740",[663,79.491]],["parent/740",[686,9.65]],["name/741",[688,79.491]],["parent/741",[686,9.65]],["name/742",[689,84.686]],["parent/742",[291,3.313]],["name/743",[690,84.686]],["parent/743",[691,9.986]],["name/744",[692,84.686]],["parent/744",[691,9.986]],["name/745",[693,84.686]],["parent/745",[691,9.986]],["name/746",[694,84.686]],["parent/746",[291,3.313]],["name/747",[695,79.491]],["parent/747",[696,11.117]],["name/748",[18,47.256]],["parent/748",[697,11.117]],["name/749",[698,84.686]],["parent/749",[291,3.313]],["name/750",[699,84.686]],["parent/750",[700,8.519]],["name/751",[701,84.686]],["parent/751",[700,8.519]],["name/752",[702,84.686]],["parent/752",[700,8.519]],["name/753",[703,84.686]],["parent/753",[700,8.519]],["name/754",[704,84.686]],["parent/754",[700,8.519]],["name/755",[705,84.686]],["parent/755",[700,8.519]],["name/756",[706,84.686]],["parent/756",[700,8.519]],["name/757",[707,84.686]],["parent/757",[700,8.519]],["name/758",[708,84.686]],["parent/758",[700,8.519]],["name/759",[709,84.686]],["parent/759",[700,8.519]],["name/760",[710,84.686]],["parent/760",[291,3.313]],["name/761",[18,47.256]],["parent/761",[711,11.117]],["name/762",[712,84.686]],["parent/762",[291,3.313]],["name/763",[713,84.686]],["parent/763",[714,9.65]],["name/764",[715,84.686]],["parent/764",[714,9.65]],["name/765",[716,84.686]],["parent/765",[714,9.65]],["name/766",[717,84.686]],["parent/766",[714,9.65]],["name/767",[718,84.686]],["parent/767",[291,3.313]],["name/768",[719,84.686]],["parent/768",[720,8.088]],["name/769",[612,63.971]],["parent/769",[720,8.088]],["name/770",[721,84.686]],["parent/770",[720,8.088]],["name/771",[615,65.914]],["parent/771",[720,8.088]],["name/772",[722,84.686]],["parent/772",[720,8.088]],["name/773",[723,84.686]],["parent/773",[720,8.088]],["name/774",[724,79.491]],["parent/774",[720,8.088]],["name/775",[725,84.686]],["parent/775",[720,8.088]],["name/776",[726,84.686]],["parent/776",[720,8.088]],["name/777",[727,84.686]],["parent/777",[720,8.088]],["name/778",[728,84.686]],["parent/778",[720,8.088]],["name/779",[729,73.514]],["parent/779",[720,8.088]],["name/780",[425,45.531]],["parent/780",[720,8.088]],["name/781",[629,60.936]],["parent/781",[720,8.088]],["name/782",[730,84.686]],["parent/782",[291,3.313]],["name/783",[251,62.341]],["parent/783",[731,9.382]],["name/784",[112,60.3]],["parent/784",[731,9.382]],["name/785",[123,37.886]],["parent/785",[731,9.382]],["name/786",[46,42.129]],["parent/786",[731,9.382]],["name/787",[253,62.341]],["parent/787",[731,9.382]],["name/788",[18,47.256]],["parent/788",[732,11.117]],["name/789",[733,84.686]],["parent/789",[291,3.313]],["name/790",[734,79.491]],["parent/790",[735,9.986]],["name/791",[736,84.686]],["parent/791",[735,9.986]],["name/792",[737,84.686]],["parent/792",[735,9.986]],["name/793",[738,84.686]],["parent/793",[291,3.313]],["name/794",[739,84.686]],["parent/794",[291,3.313]],["name/795",[740,76.069]],["parent/795",[741,9.986]],["name/796",[251,62.341]],["parent/796",[741,9.986]],["name/797",[742,79.491]],["parent/797",[741,9.986]],["name/798",[743,84.686]],["parent/798",[291,3.313]],["name/799",[740,76.069]],["parent/799",[744,9.65]],["name/800",[745,64.897]],["parent/800",[744,9.65]],["name/801",[746,84.686]],["parent/801",[744,9.65]],["name/802",[747,84.686]],["parent/802",[744,9.65]],["name/803",[748,84.686]],["parent/803",[291,3.313]],["name/804",[749,84.686]],["parent/804",[750,10.435]],["name/805",[751,84.686]],["parent/805",[750,10.435]],["name/806",[752,84.686]],["parent/806",[291,3.313]],["name/807",[753,84.686]],["parent/807",[754,9.986]],["name/808",[755,84.686]],["parent/808",[754,9.986]],["name/809",[756,84.686]],["parent/809",[754,9.986]],["name/810",[745,64.897]],["parent/810",[291,3.313]],["name/811",[757,84.686]],["parent/811",[758,6.75]],["name/812",[759,84.686]],["parent/812",[758,6.75]],["name/813",[760,84.686]],["parent/813",[758,6.75]],["name/814",[761,84.686]],["parent/814",[758,6.75]],["name/815",[762,84.686]],["parent/815",[758,6.75]],["name/816",[763,84.686]],["parent/816",[758,6.75]],["name/817",[764,84.686]],["parent/817",[758,6.75]],["name/818",[18,47.256]],["parent/818",[765,11.117]],["name/819",[261,58.092]],["parent/819",[766,10.435]],["name/820",[610,73.514]],["parent/820",[766,10.435]],["name/821",[767,84.686]],["parent/821",[758,6.75]],["name/822",[768,84.686]],["parent/822",[758,6.75]],["name/823",[769,79.491]],["parent/823",[758,6.75]],["name/824",[18,47.256]],["parent/824",[770,11.117]],["name/825",[597,69.774]],["parent/825",[771,9.65]],["name/826",[605,76.069]],["parent/826",[771,9.65]],["name/827",[772,79.491]],["parent/827",[771,9.65]],["name/828",[63,61.614]],["parent/828",[771,9.65]],["name/829",[425,45.531]],["parent/829",[758,6.75]],["name/830",[773,84.686]],["parent/830",[758,6.75]],["name/831",[774,84.686]],["parent/831",[758,6.75]],["name/832",[612,63.971]],["parent/832",[758,6.75]],["name/833",[775,84.686]],["parent/833",[758,6.75]],["name/834",[615,65.914]],["parent/834",[758,6.75]],["name/835",[776,84.686]],["parent/835",[758,6.75]],["name/836",[777,79.491]],["parent/836",[758,6.75]],["name/837",[609,73.514]],["parent/837",[758,6.75]],["name/838",[778,84.686]],["parent/838",[758,6.75]],["name/839",[772,79.491]],["parent/839",[758,6.75]],["name/840",[253,62.341]],["parent/840",[758,6.75]],["name/841",[779,84.686]],["parent/841",[758,6.75]],["name/842",[780,84.686]],["parent/842",[758,6.75]],["name/843",[781,84.686]],["parent/843",[758,6.75]],["name/844",[782,84.686]],["parent/844",[758,6.75]],["name/845",[783,84.686]],["parent/845",[758,6.75]],["name/846",[784,84.686]],["parent/846",[758,6.75]],["name/847",[785,84.686]],["parent/847",[758,6.75]],["name/848",[786,84.686]],["parent/848",[758,6.75]],["name/849",[635,73.514]],["parent/849",[758,6.75]],["name/850",[653,67.046]],["parent/850",[758,6.75]],["name/851",[787,84.686]],["parent/851",[758,6.75]],["name/852",[788,84.686]],["parent/852",[758,6.75]],["name/853",[789,84.686]],["parent/853",[758,6.75]],["name/854",[790,84.686]],["parent/854",[758,6.75]],["name/855",[791,84.686]],["parent/855",[758,6.75]],["name/856",[792,84.686]],["parent/856",[758,6.75]],["name/857",[793,84.686]],["parent/857",[758,6.75]],["name/858",[794,84.686]],["parent/858",[291,3.313]],["name/859",[235,59.136]],["parent/859",[795,9.986]],["name/860",[46,42.129]],["parent/860",[795,9.986]],["name/861",[442,76.069]],["parent/861",[795,9.986]],["name/862",[796,84.686]],["parent/862",[291,3.313]],["name/863",[247,73.514]],["parent/863",[797,10.435]],["name/864",[798,76.069]],["parent/864",[797,10.435]],["name/865",[799,84.686]],["parent/865",[291,3.313]],["name/866",[800,84.686]],["parent/866",[801,10.435]],["name/867",[802,84.686]],["parent/867",[801,10.435]],["name/868",[803,84.686]],["parent/868",[291,3.313]],["name/869",[189,39.191]],["parent/869",[804,7.837]],["name/870",[191,49.763]],["parent/870",[804,7.837]],["name/871",[46,42.129]],["parent/871",[804,7.837]],["name/872",[123,37.886]],["parent/872",[804,7.837]],["name/873",[805,79.491]],["parent/873",[804,7.837]],["name/874",[201,59.136]],["parent/874",[804,7.837]],["name/875",[192,48.337]],["parent/875",[804,7.837]],["name/876",[275,58.601]],["parent/876",[804,7.837]],["name/877",[806,76.069]],["parent/877",[804,7.837]],["name/878",[807,79.491]],["parent/878",[804,7.837]],["name/879",[808,84.686]],["parent/879",[804,7.837]],["name/880",[809,84.686]],["parent/880",[804,7.837]],["name/881",[245,73.514]],["parent/881",[804,7.837]],["name/882",[810,79.491]],["parent/882",[804,7.837]],["name/883",[811,79.491]],["parent/883",[804,7.837]],["name/884",[812,84.686]],["parent/884",[804,7.837]],["name/885",[813,84.686]],["parent/885",[804,7.837]],["name/886",[18,47.256]],["parent/886",[814,11.117]],["name/887",[815,84.686]],["parent/887",[291,3.313]],["name/888",[816,84.686]],["parent/888",[291,3.313]],["name/889",[189,39.191]],["parent/889",[817,9.159]],["name/890",[123,37.886]],["parent/890",[817,9.159]],["name/891",[46,42.129]],["parent/891",[817,9.159]],["name/892",[275,58.601]],["parent/892",[817,9.159]],["name/893",[818,76.069]],["parent/893",[817,9.159]],["name/894",[811,79.491]],["parent/894",[817,9.159]],["name/895",[819,84.686]],["parent/895",[291,3.313]],["name/896",[123,37.886]],["parent/896",[820,10.435]],["name/897",[189,39.191]],["parent/897",[820,10.435]],["name/898",[821,84.686]],["parent/898",[291,3.313]],["name/899",[822,69.774]],["parent/899",[823,9.65]],["name/900",[298,63.971]],["parent/900",[823,9.65]],["name/901",[824,84.686]],["parent/901",[823,9.65]],["name/902",[636,73.514]],["parent/902",[823,9.65]],["name/903",[825,84.686]],["parent/903",[291,3.313]],["name/904",[275,58.601]],["parent/904",[826,9.986]],["name/905",[296,69.774]],["parent/905",[826,9.986]],["name/906",[827,84.686]],["parent/906",[826,9.986]],["name/907",[828,84.686]],["parent/907",[291,3.313]],["name/908",[189,39.191]],["parent/908",[829,7.562]],["name/909",[46,42.129]],["parent/909",[829,7.562]],["name/910",[830,58.092]],["parent/910",[829,7.562]],["name/911",[123,37.886]],["parent/911",[829,7.562]],["name/912",[831,79.491]],["parent/912",[829,7.562]],["name/913",[191,49.763]],["parent/913",[829,7.562]],["name/914",[832,84.686]],["parent/914",[829,7.562]],["name/915",[833,84.686]],["parent/915",[829,7.562]],["name/916",[834,84.686]],["parent/916",[829,7.562]],["name/917",[835,59.136]],["parent/917",[829,7.562]],["name/918",[301,58.092]],["parent/918",[829,7.562]],["name/919",[836,84.686]],["parent/919",[829,7.562]],["name/920",[837,68.319]],["parent/920",[829,7.562]],["name/921",[235,59.136]],["parent/921",[829,7.562]],["name/922",[838,63.971]],["parent/922",[829,7.562]],["name/923",[839,84.686]],["parent/923",[829,7.562]],["name/924",[840,84.686]],["parent/924",[829,7.562]],["name/925",[841,63.123]],["parent/925",[829,7.562]],["name/926",[842,84.686]],["parent/926",[829,7.562]],["name/927",[843,84.686]],["parent/927",[829,7.562]],["name/928",[844,84.686]],["parent/928",[829,7.562]],["name/929",[845,84.686]],["parent/929",[291,3.313]],["name/930",[846,84.686]],["parent/930",[291,3.313]],["name/931",[847,84.686]],["parent/931",[291,3.313]],["name/932",[848,84.686]],["parent/932",[849,8.519]],["name/933",[850,84.686]],["parent/933",[849,8.519]],["name/934",[425,45.531]],["parent/934",[849,8.519]],["name/935",[851,84.686]],["parent/935",[849,8.519]],["name/936",[634,69.774]],["parent/936",[849,8.519]],["name/937",[852,84.686]],["parent/937",[849,8.519]],["name/938",[853,84.686]],["parent/938",[849,8.519]],["name/939",[854,84.686]],["parent/939",[849,8.519]],["name/940",[855,84.686]],["parent/940",[849,8.519]],["name/941",[856,76.069]],["parent/941",[849,8.519]],["name/942",[857,84.686]],["parent/942",[291,3.313]],["name/943",[858,84.686]],["parent/943",[859,9.986]],["name/944",[860,84.686]],["parent/944",[859,9.986]],["name/945",[861,84.686]],["parent/945",[859,9.986]],["name/946",[862,84.686]],["parent/946",[291,3.313]],["name/947",[163,53.406]],["parent/947",[863,9.65]],["name/948",[413,67.046]],["parent/948",[863,9.65]],["name/949",[864,84.686]],["parent/949",[863,9.65]],["name/950",[572,67.046]],["parent/950",[863,9.65]],["name/951",[865,84.686]],["parent/951",[291,3.313]],["name/952",[866,84.686]],["parent/952",[867,9.986]],["name/953",[868,84.686]],["parent/953",[867,9.986]],["name/954",[869,84.686]],["parent/954",[867,9.986]],["name/955",[870,84.686]],["parent/955",[291,3.313]],["name/956",[871,84.686]],["parent/956",[872,9.65]],["name/957",[873,79.491]],["parent/957",[872,9.65]],["name/958",[874,84.686]],["parent/958",[872,9.65]],["name/959",[875,76.069]],["parent/959",[872,9.65]],["name/960",[876,84.686]],["parent/960",[291,3.313]],["name/961",[877,73.514]],["parent/961",[878,9.986]],["name/962",[879,76.069]],["parent/962",[878,9.986]],["name/963",[880,76.069]],["parent/963",[878,9.986]],["name/964",[881,84.686]],["parent/964",[291,3.313]],["name/965",[574,68.319]],["parent/965",[882,9.159]],["name/966",[883,84.686]],["parent/966",[882,9.159]],["name/967",[884,84.686]],["parent/967",[882,9.159]],["name/968",[885,84.686]],["parent/968",[882,9.159]],["name/969",[886,84.686]],["parent/969",[882,9.159]],["name/970",[887,84.686]],["parent/970",[882,9.159]],["name/971",[888,84.686]],["parent/971",[291,3.313]],["name/972",[889,84.686]],["parent/972",[890,8.398]],["name/973",[891,84.686]],["parent/973",[890,8.398]],["name/974",[892,84.686]],["parent/974",[890,8.398]],["name/975",[893,84.686]],["parent/975",[890,8.398]],["name/976",[894,84.686]],["parent/976",[890,8.398]],["name/977",[895,84.686]],["parent/977",[890,8.398]],["name/978",[896,84.686]],["parent/978",[890,8.398]],["name/979",[897,84.686]],["parent/979",[890,8.398]],["name/980",[898,84.686]],["parent/980",[890,8.398]],["name/981",[899,84.686]],["parent/981",[890,8.398]],["name/982",[900,84.686]],["parent/982",[890,8.398]],["name/983",[901,84.686]],["parent/983",[291,3.313]],["name/984",[902,79.491]],["parent/984",[903,6.504]],["name/985",[904,79.491]],["parent/985",[903,6.504]],["name/986",[905,79.491]],["parent/986",[903,6.504]],["name/987",[906,84.686]],["parent/987",[903,6.504]],["name/988",[907,76.069]],["parent/988",[903,6.504]],["name/989",[908,76.069]],["parent/989",[903,6.504]],["name/990",[879,76.069]],["parent/990",[903,6.504]],["name/991",[877,73.514]],["parent/991",[903,6.504]],["name/992",[909,79.491]],["parent/992",[903,6.504]],["name/993",[163,53.406]],["parent/993",[903,6.504]],["name/994",[910,79.491]],["parent/994",[903,6.504]],["name/995",[911,79.491]],["parent/995",[903,6.504]],["name/996",[912,84.686]],["parent/996",[903,6.504]],["name/997",[913,84.686]],["parent/997",[903,6.504]],["name/998",[914,84.686]],["parent/998",[903,6.504]],["name/999",[915,84.686]],["parent/999",[903,6.504]],["name/1000",[916,84.686]],["parent/1000",[903,6.504]],["name/1001",[917,84.686]],["parent/1001",[903,6.504]],["name/1002",[425,45.531]],["parent/1002",[903,6.504]],["name/1003",[918,79.491]],["parent/1003",[903,6.504]],["name/1004",[919,79.491]],["parent/1004",[903,6.504]],["name/1005",[920,79.491]],["parent/1005",[903,6.504]],["name/1006",[921,79.491]],["parent/1006",[903,6.504]],["name/1007",[922,79.491]],["parent/1007",[903,6.504]],["name/1008",[880,76.069]],["parent/1008",[903,6.504]],["name/1009",[923,79.491]],["parent/1009",[903,6.504]],["name/1010",[924,79.491]],["parent/1010",[903,6.504]],["name/1011",[925,76.069]],["parent/1011",[903,6.504]],["name/1012",[926,79.491]],["parent/1012",[903,6.504]],["name/1013",[927,79.491]],["parent/1013",[903,6.504]],["name/1014",[928,79.491]],["parent/1014",[903,6.504]],["name/1015",[929,79.491]],["parent/1015",[903,6.504]],["name/1016",[930,79.491]],["parent/1016",[903,6.504]],["name/1017",[931,79.491]],["parent/1017",[903,6.504]],["name/1018",[932,79.491]],["parent/1018",[903,6.504]],["name/1019",[933,79.491]],["parent/1019",[903,6.504]],["name/1020",[934,79.491]],["parent/1020",[903,6.504]],["name/1021",[935,79.491]],["parent/1021",[903,6.504]],["name/1022",[936,79.491]],["parent/1022",[903,6.504]],["name/1023",[937,79.491]],["parent/1023",[903,6.504]],["name/1024",[938,79.491]],["parent/1024",[903,6.504]],["name/1025",[939,79.491]],["parent/1025",[903,6.504]],["name/1026",[940,84.686]],["parent/1026",[903,6.504]],["name/1027",[941,84.686]],["parent/1027",[903,6.504]],["name/1028",[942,84.686]],["parent/1028",[903,6.504]],["name/1029",[943,84.686]],["parent/1029",[903,6.504]],["name/1030",[944,84.686]],["parent/1030",[903,6.504]],["name/1031",[945,84.686]],["parent/1031",[291,3.313]],["name/1032",[18,47.256]],["parent/1032",[946,11.117]],["name/1033",[947,84.686]],["parent/1033",[291,3.313]],["name/1034",[18,47.256]],["parent/1034",[948,11.117]],["name/1035",[949,84.686]],["parent/1035",[291,3.313]],["name/1036",[18,47.256]],["parent/1036",[950,11.117]],["name/1037",[951,84.686]],["parent/1037",[291,3.313]],["name/1038",[925,76.069]],["parent/1038",[952,7.999]],["name/1039",[953,84.686]],["parent/1039",[952,7.999]],["name/1040",[954,84.686]],["parent/1040",[952,7.999]],["name/1041",[955,84.686]],["parent/1041",[952,7.999]],["name/1042",[956,84.686]],["parent/1042",[952,7.999]],["name/1043",[957,84.686]],["parent/1043",[952,7.999]],["name/1044",[958,84.686]],["parent/1044",[952,7.999]],["name/1045",[959,84.686]],["parent/1045",[952,7.999]],["name/1046",[960,84.686]],["parent/1046",[952,7.999]],["name/1047",[961,84.686]],["parent/1047",[952,7.999]],["name/1048",[962,84.686]],["parent/1048",[952,7.999]],["name/1049",[963,84.686]],["parent/1049",[952,7.999]],["name/1050",[907,76.069]],["parent/1050",[952,7.999]],["name/1051",[908,76.069]],["parent/1051",[952,7.999]],["name/1052",[964,69.774]],["parent/1052",[952,7.999]],["name/1053",[965,84.686]],["parent/1053",[291,3.313]],["name/1054",[966,84.686]],["parent/1054",[967,6.449]],["name/1055",[968,84.686]],["parent/1055",[967,6.449]],["name/1056",[969,84.686]],["parent/1056",[967,6.449]],["name/1057",[970,84.686]],["parent/1057",[967,6.449]],["name/1058",[971,84.686]],["parent/1058",[967,6.449]],["name/1059",[972,84.686]],["parent/1059",[967,6.449]],["name/1060",[973,84.686]],["parent/1060",[967,6.449]],["name/1061",[425,45.531]],["parent/1061",[967,6.449]],["name/1062",[918,79.491]],["parent/1062",[967,6.449]],["name/1063",[919,79.491]],["parent/1063",[967,6.449]],["name/1064",[879,76.069]],["parent/1064",[967,6.449]],["name/1065",[877,73.514]],["parent/1065",[967,6.449]],["name/1066",[921,79.491]],["parent/1066",[967,6.449]],["name/1067",[909,79.491]],["parent/1067",[967,6.449]],["name/1068",[974,84.686]],["parent/1068",[967,6.449]],["name/1069",[933,79.491]],["parent/1069",[967,6.449]],["name/1070",[934,79.491]],["parent/1070",[967,6.449]],["name/1071",[935,79.491]],["parent/1071",[967,6.449]],["name/1072",[975,84.686]],["parent/1072",[967,6.449]],["name/1073",[976,84.686]],["parent/1073",[967,6.449]],["name/1074",[977,84.686]],["parent/1074",[967,6.449]],["name/1075",[978,84.686]],["parent/1075",[967,6.449]],["name/1076",[979,84.686]],["parent/1076",[967,6.449]],["name/1077",[980,84.686]],["parent/1077",[967,6.449]],["name/1078",[902,79.491]],["parent/1078",[967,6.449]],["name/1079",[904,79.491]],["parent/1079",[967,6.449]],["name/1080",[905,79.491]],["parent/1080",[967,6.449]],["name/1081",[907,76.069]],["parent/1081",[967,6.449]],["name/1082",[908,76.069]],["parent/1082",[967,6.449]],["name/1083",[163,53.406]],["parent/1083",[967,6.449]],["name/1084",[910,79.491]],["parent/1084",[967,6.449]],["name/1085",[911,79.491]],["parent/1085",[967,6.449]],["name/1086",[920,79.491]],["parent/1086",[967,6.449]],["name/1087",[922,79.491]],["parent/1087",[967,6.449]],["name/1088",[880,76.069]],["parent/1088",[967,6.449]],["name/1089",[923,79.491]],["parent/1089",[967,6.449]],["name/1090",[924,79.491]],["parent/1090",[967,6.449]],["name/1091",[925,76.069]],["parent/1091",[967,6.449]],["name/1092",[926,79.491]],["parent/1092",[967,6.449]],["name/1093",[927,79.491]],["parent/1093",[967,6.449]],["name/1094",[928,79.491]],["parent/1094",[967,6.449]],["name/1095",[929,79.491]],["parent/1095",[967,6.449]],["name/1096",[930,79.491]],["parent/1096",[967,6.449]],["name/1097",[931,79.491]],["parent/1097",[967,6.449]],["name/1098",[932,79.491]],["parent/1098",[967,6.449]],["name/1099",[936,79.491]],["parent/1099",[967,6.449]],["name/1100",[937,79.491]],["parent/1100",[967,6.449]],["name/1101",[938,79.491]],["parent/1101",[967,6.449]],["name/1102",[939,79.491]],["parent/1102",[967,6.449]],["name/1103",[981,84.686]],["parent/1103",[291,3.313]],["name/1104",[982,64.897]],["parent/1104",[983,9.986]],["name/1105",[984,84.686]],["parent/1105",[983,9.986]],["name/1106",[985,71.473]],["parent/1106",[983,9.986]],["name/1107",[986,84.686]],["parent/1107",[291,3.313]],["name/1108",[987,84.686]],["parent/1108",[988,10.435]],["name/1109",[989,84.686]],["parent/1109",[988,10.435]],["name/1110",[990,84.686]],["parent/1110",[291,3.313]],["name/1111",[964,69.774]],["parent/1111",[991,9.65]],["name/1112",[440,68.319]],["parent/1112",[991,9.65]],["name/1113",[992,84.686]],["parent/1113",[991,9.65]],["name/1114",[119,79.491]],["parent/1114",[991,9.65]],["name/1115",[993,84.686]],["parent/1115",[291,3.313]],["name/1116",[994,84.686]],["parent/1116",[291,3.313]],["name/1117",[964,69.774]],["parent/1117",[995,11.117]],["name/1118",[18,47.256]],["parent/1118",[996,11.117]],["name/1119",[997,84.686]],["parent/1119",[291,3.313]],["name/1120",[415,40.51]],["parent/1120",[998,9.65]],["name/1121",[122,56.704]],["parent/1121",[998,9.65]],["name/1122",[574,68.319]],["parent/1122",[998,9.65]],["name/1123",[440,68.319]],["parent/1123",[998,9.65]],["name/1124",[999,84.686]],["parent/1124",[291,3.313]],["name/1125",[1000,84.686]],["parent/1125",[1001,10.435]],["name/1126",[1002,84.686]],["parent/1126",[1001,10.435]],["name/1127",[1003,84.686]],["parent/1127",[291,3.313]],["name/1128",[1004,63.123]],["parent/1128",[1005,8.801]],["name/1129",[1006,79.491]],["parent/1129",[1005,8.801]],["name/1130",[838,63.971]],["parent/1130",[1005,8.801]],["name/1131",[597,69.774]],["parent/1131",[1005,8.801]],["name/1132",[1007,64.897]],["parent/1132",[1005,8.801]],["name/1133",[1008,76.069]],["parent/1133",[1005,8.801]],["name/1134",[581,79.491]],["parent/1134",[1005,8.801]],["name/1135",[1009,84.686]],["parent/1135",[1005,8.801]],["name/1136",[1010,84.686]],["parent/1136",[291,3.313]],["name/1137",[1011,53.098]],["parent/1137",[1012,11.117]],["name/1138",[1013,84.686]],["parent/1138",[291,3.313]],["name/1139",[18,47.256]],["parent/1139",[1014,11.117]],["name/1140",[1015,84.686]],["parent/1140",[291,3.313]],["name/1141",[1016,73.514]],["parent/1141",[1017,11.117]],["name/1142",[1018,84.686]],["parent/1142",[291,3.313]],["name/1143",[46,42.129]],["parent/1143",[1019,9.65]],["name/1144",[830,58.092]],["parent/1144",[1019,9.65]],["name/1145",[835,59.136]],["parent/1145",[1019,9.65]],["name/1146",[235,59.136]],["parent/1146",[1019,9.65]],["name/1147",[1020,84.686]],["parent/1147",[291,3.313]],["name/1148",[1021,84.686]],["parent/1148",[1022,9.65]],["name/1149",[301,58.092]],["parent/1149",[1022,9.65]],["name/1150",[170,79.491]],["parent/1150",[1022,9.65]],["name/1151",[182,79.491]],["parent/1151",[1022,9.65]],["name/1152",[1023,84.686]],["parent/1152",[291,3.313]],["name/1153",[79,79.491]],["parent/1153",[291,3.313]],["name/1154",[1024,84.686]],["parent/1154",[291,3.313]],["name/1155",[1025,76.069]],["parent/1155",[1026,8.653]],["name/1156",[1027,68.319]],["parent/1156",[1026,8.653]],["name/1157",[405,79.491]],["parent/1157",[1026,8.653]],["name/1158",[607,67.046]],["parent/1158",[1026,8.653]],["name/1159",[259,63.971]],["parent/1159",[1026,8.653]],["name/1160",[265,73.514]],["parent/1160",[1026,8.653]],["name/1161",[1028,79.491]],["parent/1161",[1026,8.653]],["name/1162",[461,64.897]],["parent/1162",[1026,8.653]],["name/1163",[1029,84.686]],["parent/1163",[1026,8.653]],["name/1164",[1030,79.491]],["parent/1164",[291,3.313]],["name/1165",[1031,79.491]],["parent/1165",[291,3.313]],["name/1166",[1032,63.123]],["parent/1166",[1033,8.653]],["name/1167",[1034,79.491]],["parent/1167",[1033,8.653]],["name/1168",[1035,76.069]],["parent/1168",[1033,8.653]],["name/1169",[1036,76.069]],["parent/1169",[1033,8.653]],["name/1170",[1037,76.069]],["parent/1170",[1033,8.653]],["name/1171",[1038,76.069]],["parent/1171",[1033,8.653]],["name/1172",[1039,76.069]],["parent/1172",[1033,8.653]],["name/1173",[1040,76.069]],["parent/1173",[1033,8.653]],["name/1174",[982,64.897]],["parent/1174",[1033,8.653]],["name/1175",[1041,84.686]],["parent/1175",[291,3.313]],["name/1176",[1042,84.686]],["parent/1176",[1043,7.763]],["name/1177",[1044,84.686]],["parent/1177",[1043,7.763]],["name/1178",[254,73.514]],["parent/1178",[1043,7.763]],["name/1179",[1045,84.686]],["parent/1179",[1043,7.763]],["name/1180",[1046,76.069]],["parent/1180",[1043,7.763]],["name/1181",[259,63.971]],["parent/1181",[1043,7.763]],["name/1182",[27,69.774]],["parent/1182",[1043,7.763]],["name/1183",[1032,63.123]],["parent/1183",[1043,7.763]],["name/1184",[1025,76.069]],["parent/1184",[1043,7.763]],["name/1185",[1047,84.686]],["parent/1185",[1043,7.763]],["name/1186",[585,68.319]],["parent/1186",[1043,7.763]],["name/1187",[1048,79.491]],["parent/1187",[1043,7.763]],["name/1188",[306,79.491]],["parent/1188",[1043,7.763]],["name/1189",[308,63.971]],["parent/1189",[1043,7.763]],["name/1190",[309,64.897]],["parent/1190",[1043,7.763]],["name/1191",[310,63.971]],["parent/1191",[1043,7.763]],["name/1192",[311,64.897]],["parent/1192",[1043,7.763]],["name/1193",[312,64.897]],["parent/1193",[1043,7.763]],["name/1194",[1049,84.686]],["parent/1194",[291,3.313]],["name/1195",[1050,84.686]],["parent/1195",[291,3.313]],["name/1196",[1051,84.686]],["parent/1196",[291,3.313]],["name/1197",[1052,84.686]],["parent/1197",[291,3.313]],["name/1198",[1053,84.686]],["parent/1198",[291,3.313]],["name/1199",[1054,84.686]],["parent/1199",[291,3.313]],["name/1200",[1055,84.686]],["parent/1200",[291,3.313]],["name/1201",[1056,84.686]],["parent/1201",[291,3.313]],["name/1202",[1057,84.686]],["parent/1202",[291,3.313]],["name/1203",[1058,84.686]],["parent/1203",[291,3.313]],["name/1204",[1059,84.686]],["parent/1204",[291,3.313]],["name/1205",[1060,84.686]],["parent/1205",[291,3.313]],["name/1206",[1061,84.686]],["parent/1206",[291,3.313]],["name/1207",[1062,84.686]],["parent/1207",[291,3.313]],["name/1208",[1063,84.686]],["parent/1208",[291,3.313]],["name/1209",[1064,76.069]],["parent/1209",[291,3.313]],["name/1210",[1027,68.319]],["parent/1210",[1065,7.693]],["name/1211",[259,63.971]],["parent/1211",[1065,7.693]],["name/1212",[261,58.092]],["parent/1212",[1065,7.693]],["name/1213",[263,69.774]],["parent/1213",[1065,7.693]],["name/1214",[1046,76.069]],["parent/1214",[1065,7.693]],["name/1215",[27,69.774]],["parent/1215",[1065,7.693]],["name/1216",[123,37.886]],["parent/1216",[1065,7.693]],["name/1217",[1066,84.686]],["parent/1217",[1065,7.693]],["name/1218",[267,79.491]],["parent/1218",[1065,7.693]],["name/1219",[269,79.491]],["parent/1219",[1065,7.693]],["name/1220",[265,73.514]],["parent/1220",[1065,7.693]],["name/1221",[1028,79.491]],["parent/1221",[1065,7.693]],["name/1222",[1067,84.686]],["parent/1222",[1065,7.693]],["name/1223",[1068,84.686]],["parent/1223",[1065,7.693]],["name/1224",[1069,84.686]],["parent/1224",[1065,7.693]],["name/1225",[1070,84.686]],["parent/1225",[1065,7.693]],["name/1226",[1071,84.686]],["parent/1226",[1065,7.693]],["name/1227",[18,47.256]],["parent/1227",[1072,11.117]],["name/1228",[1073,84.686]],["parent/1228",[1065,7.693]],["name/1229",[1074,76.069]],["parent/1229",[1065,7.693]],["name/1230",[1075,84.686]],["parent/1230",[291,3.313]],["name/1231",[1076,76.069]],["parent/1231",[1077,7.562]],["name/1232",[1078,76.069]],["parent/1232",[1077,7.562]],["name/1233",[1079,79.491]],["parent/1233",[1077,7.562]],["name/1234",[1080,79.491]],["parent/1234",[1077,7.562]],["name/1235",[1081,79.491]],["parent/1235",[1077,7.562]],["name/1236",[1082,79.491]],["parent/1236",[1077,7.562]],["name/1237",[1083,79.491]],["parent/1237",[1077,7.562]],["name/1238",[1084,79.491]],["parent/1238",[1077,7.562]],["name/1239",[1085,79.491]],["parent/1239",[1077,7.562]],["name/1240",[1086,79.491]],["parent/1240",[1077,7.562]],["name/1241",[1087,79.491]],["parent/1241",[1077,7.562]],["name/1242",[1088,76.069]],["parent/1242",[1077,7.562]],["name/1243",[1089,76.069]],["parent/1243",[1077,7.562]],["name/1244",[1090,76.069]],["parent/1244",[1077,7.562]],["name/1245",[1091,79.491]],["parent/1245",[1077,7.562]],["name/1246",[1092,71.473]],["parent/1246",[1077,7.562]],["name/1247",[425,45.531]],["parent/1247",[1077,7.562]],["name/1248",[1093,84.686]],["parent/1248",[1077,7.562]],["name/1249",[1074,76.069]],["parent/1249",[1077,7.562]],["name/1250",[1094,76.069]],["parent/1250",[1077,7.562]],["name/1251",[1064,76.069]],["parent/1251",[1077,7.562]],["name/1252",[1095,71.473]],["parent/1252",[291,3.313]],["name/1253",[425,45.531]],["parent/1253",[1096,7.693]],["name/1254",[1097,84.686]],["parent/1254",[1096,7.693]],["name/1255",[1076,76.069]],["parent/1255",[1096,7.693]],["name/1256",[1078,76.069]],["parent/1256",[1096,7.693]],["name/1257",[1079,79.491]],["parent/1257",[1096,7.693]],["name/1258",[1080,79.491]],["parent/1258",[1096,7.693]],["name/1259",[1081,79.491]],["parent/1259",[1096,7.693]],["name/1260",[1082,79.491]],["parent/1260",[1096,7.693]],["name/1261",[1083,79.491]],["parent/1261",[1096,7.693]],["name/1262",[1084,79.491]],["parent/1262",[1096,7.693]],["name/1263",[1085,79.491]],["parent/1263",[1096,7.693]],["name/1264",[1086,79.491]],["parent/1264",[1096,7.693]],["name/1265",[1087,79.491]],["parent/1265",[1096,7.693]],["name/1266",[1088,76.069]],["parent/1266",[1096,7.693]],["name/1267",[1089,76.069]],["parent/1267",[1096,7.693]],["name/1268",[1090,76.069]],["parent/1268",[1096,7.693]],["name/1269",[1091,79.491]],["parent/1269",[1096,7.693]],["name/1270",[1074,76.069]],["parent/1270",[1096,7.693]],["name/1271",[1064,76.069]],["parent/1271",[1096,7.693]],["name/1272",[1098,79.491]],["parent/1272",[291,3.313]],["name/1273",[1099,73.514]],["parent/1273",[1100,8.968]],["name/1274",[1101,73.514]],["parent/1274",[1100,8.968]],["name/1275",[122,56.704]],["parent/1275",[1100,8.968]],["name/1276",[1102,73.514]],["parent/1276",[1100,8.968]],["name/1277",[1004,63.123]],["parent/1277",[1100,8.968]],["name/1278",[1095,71.473]],["parent/1278",[1100,8.968]],["name/1279",[163,53.406]],["parent/1279",[1100,8.968]],["name/1280",[1103,84.686]],["parent/1280",[291,3.313]],["name/1281",[1032,63.123]],["parent/1281",[1104,8.653]],["name/1282",[585,68.319]],["parent/1282",[1104,8.653]],["name/1283",[1035,76.069]],["parent/1283",[1104,8.653]],["name/1284",[1036,76.069]],["parent/1284",[1104,8.653]],["name/1285",[1037,76.069]],["parent/1285",[1104,8.653]],["name/1286",[1038,76.069]],["parent/1286",[1104,8.653]],["name/1287",[1039,76.069]],["parent/1287",[1104,8.653]],["name/1288",[1040,76.069]],["parent/1288",[1104,8.653]],["name/1289",[982,64.897]],["parent/1289",[1104,8.653]],["name/1290",[1025,76.069]],["parent/1290",[291,3.313]],["name/1291",[1105,84.686]],["parent/1291",[1106,8.519]],["name/1292",[1107,84.686]],["parent/1292",[1106,8.519]],["name/1293",[1108,84.686]],["parent/1293",[1106,8.519]],["name/1294",[1109,84.686]],["parent/1294",[1106,8.519]],["name/1295",[1110,84.686]],["parent/1295",[1106,8.519]],["name/1296",[123,27.08,133,49.872]],["parent/1296",[1111,11.117]],["name/1297",[135,79.491]],["parent/1297",[1106,8.519]],["name/1298",[123,27.08,133,49.872]],["parent/1298",[1112,11.117]],["name/1299",[1113,84.686]],["parent/1299",[1106,8.519]],["name/1300",[123,27.08,133,49.872]],["parent/1300",[1114,11.117]],["name/1301",[132,79.491]],["parent/1301",[1106,8.519]],["name/1302",[123,27.08,133,49.872]],["parent/1302",[1115,11.117]],["name/1303",[1116,84.686]],["parent/1303",[1106,8.519]],["name/1304",[1117,84.686]],["parent/1304",[1118,11.117]],["name/1305",[1119,84.686]],["parent/1305",[1106,8.519]],["name/1306",[1120,84.686]],["parent/1306",[1121,11.117]],["name/1307",[1122,84.686]],["parent/1307",[291,3.313]],["name/1308",[1123,84.686]],["parent/1308",[291,3.313]],["name/1309",[1124,84.686]],["parent/1309",[1125,8.184]],["name/1310",[1126,84.686]],["parent/1310",[1125,8.184]],["name/1311",[1127,84.686]],["parent/1311",[1125,8.184]],["name/1312",[1128,84.686]],["parent/1312",[1125,8.184]],["name/1313",[1129,84.686]],["parent/1313",[1125,8.184]],["name/1314",[1130,84.686]],["parent/1314",[1125,8.184]],["name/1315",[1131,84.686]],["parent/1315",[1125,8.184]],["name/1316",[1132,84.686]],["parent/1316",[1125,8.184]],["name/1317",[1133,84.686]],["parent/1317",[1125,8.184]],["name/1318",[1134,84.686]],["parent/1318",[1125,8.184]],["name/1319",[1135,79.491]],["parent/1319",[1125,8.184]],["name/1320",[1076,76.069]],["parent/1320",[1125,8.184]],["name/1321",[1078,76.069]],["parent/1321",[1125,8.184]],["name/1322",[1136,84.686]],["parent/1322",[291,3.313]],["name/1323",[425,45.531]],["parent/1323",[1137,8.519]],["name/1324",[680,67.046]],["parent/1324",[1137,8.519]],["name/1325",[681,67.046]],["parent/1325",[1137,8.519]],["name/1326",[308,63.971]],["parent/1326",[1137,8.519]],["name/1327",[309,64.897]],["parent/1327",[1137,8.519]],["name/1328",[311,64.897]],["parent/1328",[1137,8.519]],["name/1329",[312,64.897]],["parent/1329",[1137,8.519]],["name/1330",[310,63.971]],["parent/1330",[1137,8.519]],["name/1331",[279,32.637]],["parent/1331",[1137,8.519]],["name/1332",[189,39.191]],["parent/1332",[1137,8.519]],["name/1333",[1138,84.686]],["parent/1333",[291,3.313]],["name/1334",[1139,84.686]],["parent/1334",[1140,9.382]],["name/1335",[1141,84.686]],["parent/1335",[1140,9.382]],["name/1336",[1142,84.686]],["parent/1336",[1140,9.382]],["name/1337",[1143,84.686]],["parent/1337",[1140,9.382]],["name/1338",[1144,84.686]],["parent/1338",[1140,9.382]],["name/1339",[1145,84.686]],["parent/1339",[291,3.313]],["name/1340",[1146,79.491]],["parent/1340",[1147,6.717]],["name/1341",[1148,76.069]],["parent/1341",[1147,6.717]],["name/1342",[1149,59.136]],["parent/1342",[1147,6.717]],["name/1343",[1150,79.491]],["parent/1343",[1147,6.717]],["name/1344",[1151,79.491]],["parent/1344",[1147,6.717]],["name/1345",[1152,79.491]],["parent/1345",[1147,6.717]],["name/1346",[1153,79.491]],["parent/1346",[1147,6.717]],["name/1347",[1154,79.491]],["parent/1347",[1147,6.717]],["name/1348",[1155,79.491]],["parent/1348",[1147,6.717]],["name/1349",[1156,79.491]],["parent/1349",[1147,6.717]],["name/1350",[1157,79.491]],["parent/1350",[1147,6.717]],["name/1351",[1158,79.491]],["parent/1351",[1147,6.717]],["name/1352",[1159,79.491]],["parent/1352",[1147,6.717]],["name/1353",[1160,79.491]],["parent/1353",[1147,6.717]],["name/1354",[1161,79.491]],["parent/1354",[1147,6.717]],["name/1355",[1162,79.491]],["parent/1355",[1147,6.717]],["name/1356",[1163,79.491]],["parent/1356",[1147,6.717]],["name/1357",[1164,79.491]],["parent/1357",[1147,6.717]],["name/1358",[1165,79.491]],["parent/1358",[1147,6.717]],["name/1359",[1166,79.491]],["parent/1359",[1147,6.717]],["name/1360",[1167,79.491]],["parent/1360",[1147,6.717]],["name/1361",[425,45.531]],["parent/1361",[1147,6.717]],["name/1362",[1168,71.473]],["parent/1362",[1147,6.717]],["name/1363",[585,68.319]],["parent/1363",[1147,6.717]],["name/1364",[165,76.069]],["parent/1364",[1147,6.717]],["name/1365",[166,76.069]],["parent/1365",[1147,6.717]],["name/1366",[1169,84.686]],["parent/1366",[1147,6.717]],["name/1367",[1170,84.686]],["parent/1367",[1147,6.717]],["name/1368",[1171,84.686]],["parent/1368",[1147,6.717]],["name/1369",[1172,84.686]],["parent/1369",[1147,6.717]],["name/1370",[1173,79.491]],["parent/1370",[1147,6.717]],["name/1371",[1174,84.686]],["parent/1371",[1147,6.717]],["name/1372",[1175,84.686]],["parent/1372",[1147,6.717]],["name/1373",[1099,73.514]],["parent/1373",[1147,6.717]],["name/1374",[1101,73.514]],["parent/1374",[1147,6.717]],["name/1375",[122,56.704]],["parent/1375",[1147,6.717]],["name/1376",[1102,73.514]],["parent/1376",[1147,6.717]],["name/1377",[1004,63.123]],["parent/1377",[1147,6.717]],["name/1378",[1095,71.473]],["parent/1378",[1147,6.717]],["name/1379",[163,53.406]],["parent/1379",[1147,6.717]],["name/1380",[1176,84.686]],["parent/1380",[291,3.313]],["name/1381",[18,47.256]],["parent/1381",[1177,11.117]],["name/1382",[1178,84.686]],["parent/1382",[291,3.313]],["name/1383",[1179,84.686]],["parent/1383",[1180,6.272]],["name/1384",[1181,84.686]],["parent/1384",[1180,6.272]],["name/1385",[1182,84.686]],["parent/1385",[1180,6.272]],["name/1386",[1183,84.686]],["parent/1386",[1180,6.272]],["name/1387",[1184,84.686]],["parent/1387",[1180,6.272]],["name/1388",[1185,84.686]],["parent/1388",[1180,6.272]],["name/1389",[1186,84.686]],["parent/1389",[1180,6.272]],["name/1390",[1187,84.686]],["parent/1390",[1180,6.272]],["name/1391",[1188,84.686]],["parent/1391",[1180,6.272]],["name/1392",[1189,84.686]],["parent/1392",[1180,6.272]],["name/1393",[1190,84.686]],["parent/1393",[1180,6.272]],["name/1394",[1191,84.686]],["parent/1394",[1180,6.272]],["name/1395",[1192,84.686]],["parent/1395",[1180,6.272]],["name/1396",[1193,84.686]],["parent/1396",[1180,6.272]],["name/1397",[1194,84.686]],["parent/1397",[1180,6.272]],["name/1398",[1195,84.686]],["parent/1398",[1180,6.272]],["name/1399",[1196,84.686]],["parent/1399",[1180,6.272]],["name/1400",[1197,84.686]],["parent/1400",[1180,6.272]],["name/1401",[1198,84.686]],["parent/1401",[1180,6.272]],["name/1402",[1199,84.686]],["parent/1402",[1180,6.272]],["name/1403",[1200,84.686]],["parent/1403",[1180,6.272]],["name/1404",[1201,84.686]],["parent/1404",[1180,6.272]],["name/1405",[1202,84.686]],["parent/1405",[1180,6.272]],["name/1406",[1203,84.686]],["parent/1406",[1180,6.272]],["name/1407",[1146,79.491]],["parent/1407",[1180,6.272]],["name/1408",[1148,76.069]],["parent/1408",[1180,6.272]],["name/1409",[1149,59.136]],["parent/1409",[1180,6.272]],["name/1410",[1150,79.491]],["parent/1410",[1180,6.272]],["name/1411",[1151,79.491]],["parent/1411",[1180,6.272]],["name/1412",[1152,79.491]],["parent/1412",[1180,6.272]],["name/1413",[1153,79.491]],["parent/1413",[1180,6.272]],["name/1414",[1154,79.491]],["parent/1414",[1180,6.272]],["name/1415",[1155,79.491]],["parent/1415",[1180,6.272]],["name/1416",[1156,79.491]],["parent/1416",[1180,6.272]],["name/1417",[1157,79.491]],["parent/1417",[1180,6.272]],["name/1418",[1158,79.491]],["parent/1418",[1180,6.272]],["name/1419",[1159,79.491]],["parent/1419",[1180,6.272]],["name/1420",[1160,79.491]],["parent/1420",[1180,6.272]],["name/1421",[1161,79.491]],["parent/1421",[1180,6.272]],["name/1422",[1162,79.491]],["parent/1422",[1180,6.272]],["name/1423",[1163,79.491]],["parent/1423",[1180,6.272]],["name/1424",[1164,79.491]],["parent/1424",[1180,6.272]],["name/1425",[1165,79.491]],["parent/1425",[1180,6.272]],["name/1426",[1166,79.491]],["parent/1426",[1180,6.272]],["name/1427",[1167,79.491]],["parent/1427",[1180,6.272]],["name/1428",[425,45.531]],["parent/1428",[1180,6.272]],["name/1429",[585,68.319]],["parent/1429",[1180,6.272]],["name/1430",[165,76.069]],["parent/1430",[1180,6.272]],["name/1431",[166,76.069]],["parent/1431",[1180,6.272]],["name/1432",[1099,73.514]],["parent/1432",[1180,6.272]],["name/1433",[1101,73.514]],["parent/1433",[1180,6.272]],["name/1434",[122,56.704]],["parent/1434",[1180,6.272]],["name/1435",[1102,73.514]],["parent/1435",[1180,6.272]],["name/1436",[1004,63.123]],["parent/1436",[1180,6.272]],["name/1437",[1095,71.473]],["parent/1437",[1180,6.272]],["name/1438",[163,53.406]],["parent/1438",[1180,6.272]],["name/1439",[1204,84.686]],["parent/1439",[291,3.313]],["name/1440",[1089,76.069]],["parent/1440",[1205,9.986]],["name/1441",[1090,76.069]],["parent/1441",[1205,9.986]],["name/1442",[1088,76.069]],["parent/1442",[1205,9.986]],["name/1443",[1206,84.686]],["parent/1443",[291,3.313]],["name/1444",[1207,84.686]],["parent/1444",[1208,9.986]],["name/1445",[1209,84.686]],["parent/1445",[1208,9.986]],["name/1446",[1210,84.686]],["parent/1446",[1208,9.986]],["name/1447",[1211,84.686]],["parent/1447",[291,3.313]],["name/1448",[1212,84.686]],["parent/1448",[1213,8.801]],["name/1449",[1214,84.686]],["parent/1449",[1213,8.801]],["name/1450",[1215,84.686]],["parent/1450",[1213,8.801]],["name/1451",[1216,84.686]],["parent/1451",[1213,8.801]],["name/1452",[1217,79.491]],["parent/1452",[1213,8.801]],["name/1453",[1218,84.686]],["parent/1453",[1213,8.801]],["name/1454",[1219,84.686]],["parent/1454",[1213,8.801]],["name/1455",[604,79.491]],["parent/1455",[1213,8.801]],["name/1456",[1220,84.686]],["parent/1456",[291,3.313]],["name/1457",[1221,84.686]],["parent/1457",[1222,8.286]],["name/1458",[1223,84.686]],["parent/1458",[1222,8.286]],["name/1459",[1224,84.686]],["parent/1459",[1222,8.286]],["name/1460",[1225,84.686]],["parent/1460",[1222,8.286]],["name/1461",[1226,84.686]],["parent/1461",[1222,8.286]],["name/1462",[1027,68.319]],["parent/1462",[1227,9.65]],["name/1463",[259,63.971]],["parent/1463",[1227,9.65]],["name/1464",[261,58.092]],["parent/1464",[1227,9.65]],["name/1465",[263,69.774]],["parent/1465",[1227,9.65]],["name/1466",[1217,79.491]],["parent/1466",[1222,8.286]],["name/1467",[1228,84.686]],["parent/1467",[1222,8.286]],["name/1468",[1229,84.686]],["parent/1468",[1222,8.286]],["name/1469",[1230,84.686]],["parent/1469",[1222,8.286]],["name/1470",[1231,84.686]],["parent/1470",[1222,8.286]],["name/1471",[1232,84.686]],["parent/1471",[1222,8.286]],["name/1472",[1233,84.686]],["parent/1472",[1222,8.286]],["name/1473",[1234,84.686]],["parent/1473",[291,3.313]],["name/1474",[1235,84.686]],["parent/1474",[1236,9.65]],["name/1475",[1237,84.686]],["parent/1475",[1236,9.65]],["name/1476",[18,47.256]],["parent/1476",[1238,11.117]],["name/1477",[1239,84.686]],["parent/1477",[1236,9.65]],["name/1478",[18,47.256]],["parent/1478",[1240,11.117]],["name/1479",[1241,84.686]],["parent/1479",[1236,9.65]],["name/1480",[18,47.256]],["parent/1480",[1242,11.117]],["name/1481",[1243,84.686]],["parent/1481",[291,3.313]],["name/1482",[1244,60.3]],["parent/1482",[1245,8.653]],["name/1483",[1246,79.491]],["parent/1483",[1245,8.653]],["name/1484",[1247,76.069]],["parent/1484",[1245,8.653]],["name/1485",[1011,53.098]],["parent/1485",[1245,8.653]],["name/1486",[1248,79.491]],["parent/1486",[1245,8.653]],["name/1487",[1249,79.491]],["parent/1487",[1245,8.653]],["name/1488",[1250,73.514]],["parent/1488",[1245,8.653]],["name/1489",[1251,79.491]],["parent/1489",[1245,8.653]],["name/1490",[1252,79.491]],["parent/1490",[1245,8.653]],["name/1491",[1253,84.686]],["parent/1491",[291,3.313]],["name/1492",[1254,69.774]],["parent/1492",[1255,9.65]],["name/1493",[1256,76.069]],["parent/1493",[1255,9.65]],["name/1494",[1257,73.514]],["parent/1494",[1255,9.65]],["name/1495",[1258,76.069]],["parent/1495",[1255,9.65]],["name/1496",[1259,84.686]],["parent/1496",[291,3.313]],["name/1497",[1260,79.491]],["parent/1497",[1261,8.801]],["name/1498",[1262,79.491]],["parent/1498",[1261,8.801]],["name/1499",[1263,79.491]],["parent/1499",[1261,8.801]],["name/1500",[745,64.897]],["parent/1500",[1261,8.801]],["name/1501",[1254,69.774]],["parent/1501",[1261,8.801]],["name/1502",[1256,76.069]],["parent/1502",[1261,8.801]],["name/1503",[1257,73.514]],["parent/1503",[1261,8.801]],["name/1504",[1258,76.069]],["parent/1504",[1261,8.801]],["name/1505",[1264,84.686]],["parent/1505",[291,3.313]],["name/1506",[1265,84.686]],["parent/1506",[1266,8.184]],["name/1507",[18,47.256]],["parent/1507",[1267,11.117]],["name/1508",[1268,84.686]],["parent/1508",[1266,8.184]],["name/1509",[1269,76.069]],["parent/1509",[1266,8.184]],["name/1510",[1270,69.774]],["parent/1510",[1266,8.184]],["name/1511",[1271,73.514]],["parent/1511",[1266,8.184]],["name/1512",[1260,79.491]],["parent/1512",[1266,8.184]],["name/1513",[1262,79.491]],["parent/1513",[1266,8.184]],["name/1514",[1263,79.491]],["parent/1514",[1266,8.184]],["name/1515",[745,64.897]],["parent/1515",[1266,8.184]],["name/1516",[1254,69.774]],["parent/1516",[1266,8.184]],["name/1517",[1256,76.069]],["parent/1517",[1266,8.184]],["name/1518",[1257,73.514]],["parent/1518",[1266,8.184]],["name/1519",[1258,76.069]],["parent/1519",[1266,8.184]],["name/1520",[1272,84.686]],["parent/1520",[291,3.313]],["name/1521",[1273,84.686]],["parent/1521",[1274,8.801]],["name/1522",[1275,84.686]],["parent/1522",[1274,8.801]],["name/1523",[1276,84.686]],["parent/1523",[1274,8.801]],["name/1524",[1277,84.686]],["parent/1524",[1274,8.801]],["name/1525",[1278,84.686]],["parent/1525",[1274,8.801]],["name/1526",[1279,84.686]],["parent/1526",[1274,8.801]],["name/1527",[1280,84.686]],["parent/1527",[1274,8.801]],["name/1528",[1281,84.686]],["parent/1528",[1274,8.801]],["name/1529",[1282,84.686]],["parent/1529",[291,3.313]],["name/1530",[1283,84.686]],["parent/1530",[1284,8.286]],["name/1531",[1285,84.686]],["parent/1531",[1284,8.286]],["name/1532",[1286,84.686]],["parent/1532",[1284,8.286]],["name/1533",[251,62.341]],["parent/1533",[1287,9.382]],["name/1534",[112,60.3]],["parent/1534",[1287,9.382]],["name/1535",[253,62.341]],["parent/1535",[1287,9.382]],["name/1536",[601,79.491]],["parent/1536",[1288,9.986]],["name/1537",[329,55.105]],["parent/1537",[1288,9.986]],["name/1538",[331,55.105]],["parent/1538",[1288,9.986]],["name/1539",[329,55.105]],["parent/1539",[1287,9.382]],["name/1540",[331,55.105]],["parent/1540",[1287,9.382]],["name/1541",[1289,84.686]],["parent/1541",[1284,8.286]],["name/1542",[1290,84.686]],["parent/1542",[1284,8.286]],["name/1543",[1291,84.686]],["parent/1543",[1284,8.286]],["name/1544",[1292,84.686]],["parent/1544",[1284,8.286]],["name/1545",[1293,84.686]],["parent/1545",[1284,8.286]],["name/1546",[1294,79.491]],["parent/1546",[1284,8.286]],["name/1547",[1295,79.491]],["parent/1547",[1284,8.286]],["name/1548",[1296,84.686]],["parent/1548",[1284,8.286]],["name/1549",[1297,84.686]],["parent/1549",[1284,8.286]],["name/1550",[1298,84.686]],["parent/1550",[291,3.313]],["name/1551",[21,79.491]],["parent/1551",[1299,9.986]],["name/1552",[23,79.491]],["parent/1552",[1299,9.986]],["name/1553",[8,79.491]],["parent/1553",[1299,9.986]],["name/1554",[1300,84.686]],["parent/1554",[291,3.313]],["name/1555",[985,71.473]],["parent/1555",[1301,9.986]],["name/1556",[1302,84.686]],["parent/1556",[1301,9.986]],["name/1557",[1004,63.123]],["parent/1557",[1301,9.986]],["name/1558",[1303,84.686]],["parent/1558",[291,3.313]],["name/1559",[1304,84.686]],["parent/1559",[1305,9.986]],["name/1560",[407,73.514]],["parent/1560",[1305,9.986]],["name/1561",[1306,84.686]],["parent/1561",[1305,9.986]],["name/1562",[1307,84.686]],["parent/1562",[291,3.313]],["name/1563",[612,63.971]],["parent/1563",[1308,11.117]],["name/1564",[1309,84.686]],["parent/1564",[291,3.313]],["name/1565",[1310,67.046]],["parent/1565",[1311,10.435]],["name/1566",[1312,84.686]],["parent/1566",[1311,10.435]],["name/1567",[1313,84.686]],["parent/1567",[291,3.313]],["name/1568",[1314,84.686]],["parent/1568",[1315,9.65]],["name/1569",[1316,84.686]],["parent/1569",[1315,9.65]],["name/1570",[1317,84.686]],["parent/1570",[1315,9.65]],["name/1571",[163,53.406]],["parent/1571",[1315,9.65]],["name/1572",[1318,84.686]],["parent/1572",[291,3.313]],["name/1573",[1319,84.686]],["parent/1573",[1320,7.693]],["name/1574",[1321,84.686]],["parent/1574",[1320,7.693]],["name/1575",[1322,84.686]],["parent/1575",[1320,7.693]],["name/1576",[1323,84.686]],["parent/1576",[1320,7.693]],["name/1577",[1324,84.686]],["parent/1577",[1320,7.693]],["name/1578",[1325,84.686]],["parent/1578",[1320,7.693]],["name/1579",[1326,84.686]],["parent/1579",[1320,7.693]],["name/1580",[1016,73.514]],["parent/1580",[1320,7.693]],["name/1581",[1327,84.686]],["parent/1581",[1320,7.693]],["name/1582",[1328,84.686]],["parent/1582",[1320,7.693]],["name/1583",[1329,84.686]],["parent/1583",[1320,7.693]],["name/1584",[1330,84.686]],["parent/1584",[1320,7.693]],["name/1585",[1331,84.686]],["parent/1585",[1320,7.693]],["name/1586",[1332,84.686]],["parent/1586",[1320,7.693]],["name/1587",[1333,84.686]],["parent/1587",[1320,7.693]],["name/1588",[1334,84.686]],["parent/1588",[1320,7.693]],["name/1589",[1335,84.686]],["parent/1589",[1320,7.693]],["name/1590",[1336,84.686]],["parent/1590",[1320,7.693]],["name/1591",[1337,84.686]],["parent/1591",[1320,7.693]],["name/1592",[1338,84.686]],["parent/1592",[291,3.313]],["name/1593",[1339,79.491]],["parent/1593",[1340,10.435]],["name/1594",[1341,79.491]],["parent/1594",[1340,10.435]],["name/1595",[1342,84.686]],["parent/1595",[291,3.313]],["name/1596",[1092,71.473]],["parent/1596",[1343,8.398]],["name/1597",[1344,84.686]],["parent/1597",[1343,8.398]],["name/1598",[18,47.256]],["parent/1598",[1345,11.117]],["name/1599",[425,45.531]],["parent/1599",[1343,8.398]],["name/1600",[1346,79.491]],["parent/1600",[1343,8.398]],["name/1601",[629,60.936]],["parent/1601",[1343,8.398]],["name/1602",[1347,84.686]],["parent/1602",[1343,8.398]],["name/1603",[1339,79.491]],["parent/1603",[1343,8.398]],["name/1604",[1341,79.491]],["parent/1604",[1343,8.398]],["name/1605",[1348,84.686]],["parent/1605",[1343,8.398]],["name/1606",[1349,84.686]],["parent/1606",[1343,8.398]],["name/1607",[1350,84.686]],["parent/1607",[1343,8.398]],["name/1608",[1351,84.686]],["parent/1608",[291,3.313]],["name/1609",[1352,84.686]],["parent/1609",[1353,8.519]],["name/1610",[1354,84.686]],["parent/1610",[1353,8.519]],["name/1611",[1355,84.686]],["parent/1611",[1353,8.519]],["name/1612",[1356,84.686]],["parent/1612",[1353,8.519]],["name/1613",[1357,84.686]],["parent/1613",[1353,8.519]],["name/1614",[1358,84.686]],["parent/1614",[1353,8.519]],["name/1615",[1359,84.686]],["parent/1615",[1353,8.519]],["name/1616",[1360,84.686]],["parent/1616",[1353,8.519]],["name/1617",[1361,84.686]],["parent/1617",[1353,8.519]],["name/1618",[1362,84.686]],["parent/1618",[1353,8.519]],["name/1619",[1363,84.686]],["parent/1619",[291,3.313]],["name/1620",[1364,84.686]],["parent/1620",[1365,10.435]],["name/1621",[1366,84.686]],["parent/1621",[1365,10.435]],["name/1622",[1367,84.686]],["parent/1622",[291,3.313]],["name/1623",[448,64.897]],["parent/1623",[1368,8.184]],["name/1624",[449,65.914]],["parent/1624",[1368,8.184]],["name/1625",[1369,84.686]],["parent/1625",[1368,8.184]],["name/1626",[1370,84.686]],["parent/1626",[1368,8.184]],["name/1627",[1371,84.686]],["parent/1627",[1368,8.184]],["name/1628",[1372,84.686]],["parent/1628",[1368,8.184]],["name/1629",[1373,84.686]],["parent/1629",[1368,8.184]],["name/1630",[1374,84.686]],["parent/1630",[1368,8.184]],["name/1631",[1375,84.686]],["parent/1631",[1368,8.184]],["name/1632",[1376,84.686]],["parent/1632",[1368,8.184]],["name/1633",[1377,84.686]],["parent/1633",[1368,8.184]],["name/1634",[1378,84.686]],["parent/1634",[1368,8.184]],["name/1635",[425,45.531]],["parent/1635",[1368,8.184]],["name/1636",[1379,84.686]],["parent/1636",[291,3.313]],["name/1637",[1380,84.686]],["parent/1637",[1381,10.435]],["name/1638",[1382,84.686]],["parent/1638",[1381,10.435]],["name/1639",[1383,84.686]],["parent/1639",[291,3.313]],["name/1640",[10,79.491]],["parent/1640",[1384,9.382]],["name/1641",[1385,84.686]],["parent/1641",[1384,9.382]],["name/1642",[1386,84.686]],["parent/1642",[1384,9.382]],["name/1643",[1387,84.686]],["parent/1643",[1384,9.382]],["name/1644",[1388,84.686]],["parent/1644",[1384,9.382]],["name/1645",[1389,84.686]],["parent/1645",[291,3.313]],["name/1646",[1390,84.686]],["parent/1646",[291,3.313]],["name/1647",[1391,84.686]],["parent/1647",[1392,10.435]],["name/1648",[1393,84.686]],["parent/1648",[1392,10.435]],["name/1649",[1394,84.686]],["parent/1649",[291,3.313]],["name/1650",[1395,84.686]],["parent/1650",[1396,9.986]],["name/1651",[1397,71.473]],["parent/1651",[1396,9.986]],["name/1652",[112,60.3]],["parent/1652",[1396,9.986]],["name/1653",[1398,84.686]],["parent/1653",[291,3.313]],["name/1654",[1399,84.686]],["parent/1654",[291,3.313]],["name/1655",[1400,84.686]],["parent/1655",[1401,9.65]],["name/1656",[1402,84.686]],["parent/1656",[1401,9.65]],["name/1657",[1403,84.686]],["parent/1657",[1401,9.65]],["name/1658",[1404,84.686]],["parent/1658",[1401,9.65]],["name/1659",[1405,73.514]],["parent/1659",[291,3.313]],["name/1660",[448,64.897]],["parent/1660",[1406,8.519]],["name/1661",[1405,73.514]],["parent/1661",[1406,8.519]],["name/1662",[1407,84.686]],["parent/1662",[1406,8.519]],["name/1663",[449,65.914]],["parent/1663",[1406,8.519]],["name/1664",[1408,84.686]],["parent/1664",[1406,8.519]],["name/1665",[1409,84.686]],["parent/1665",[1406,8.519]],["name/1666",[1410,84.686]],["parent/1666",[1406,8.519]],["name/1667",[1411,84.686]],["parent/1667",[1406,8.519]],["name/1668",[1412,84.686]],["parent/1668",[1406,8.519]],["name/1669",[1413,84.686]],["parent/1669",[1406,8.519]],["name/1670",[1414,84.686]],["parent/1670",[291,3.313]],["name/1671",[543,73.514]],["parent/1671",[1415,10.435]],["name/1672",[632,73.514]],["parent/1672",[1415,10.435]],["name/1673",[1416,84.686]],["parent/1673",[291,3.313]],["name/1674",[607,67.046]],["parent/1674",[1417,9.382]],["name/1675",[425,45.531]],["parent/1675",[1417,9.382]],["name/1676",[1418,84.686]],["parent/1676",[1417,9.382]],["name/1677",[543,73.514]],["parent/1677",[1417,9.382]],["name/1678",[632,73.514]],["parent/1678",[1417,9.382]],["name/1679",[1419,84.686]],["parent/1679",[291,3.313]],["name/1680",[650,68.319]],["parent/1680",[1420,8.286]],["name/1681",[448,64.897]],["parent/1681",[1420,8.286]],["name/1682",[1421,84.686]],["parent/1682",[1420,8.286]],["name/1683",[1422,84.686]],["parent/1683",[1420,8.286]],["name/1684",[425,45.531]],["parent/1684",[1420,8.286]],["name/1685",[449,65.914]],["parent/1685",[1420,8.286]],["name/1686",[688,79.491]],["parent/1686",[1420,8.286]],["name/1687",[635,73.514]],["parent/1687",[1420,8.286]],["name/1688",[634,69.774]],["parent/1688",[1420,8.286]],["name/1689",[1423,84.686]],["parent/1689",[1420,8.286]],["name/1690",[1424,84.686]],["parent/1690",[1420,8.286]],["name/1691",[1425,84.686]],["parent/1691",[1420,8.286]],["name/1692",[1426,84.686]],["parent/1692",[291,3.313]],["name/1693",[448,64.897]],["parent/1693",[1427,7.011]],["name/1694",[449,65.914]],["parent/1694",[1427,7.011]],["name/1695",[1428,84.686]],["parent/1695",[1427,7.011]],["name/1696",[1429,84.686]],["parent/1696",[1427,7.011]],["name/1697",[1430,84.686]],["parent/1697",[1427,7.011]],["name/1698",[1431,84.686]],["parent/1698",[1427,7.011]],["name/1699",[1432,84.686]],["parent/1699",[1427,7.011]],["name/1700",[1433,84.686]],["parent/1700",[1427,7.011]],["name/1701",[1434,84.686]],["parent/1701",[1427,7.011]],["name/1702",[1435,79.491]],["parent/1702",[1427,7.011]],["name/1703",[1405,73.514]],["parent/1703",[1427,7.011]],["name/1704",[1436,84.686]],["parent/1704",[1427,7.011]],["name/1705",[1437,84.686]],["parent/1705",[1427,7.011]],["name/1706",[1438,84.686]],["parent/1706",[1427,7.011]],["name/1707",[1439,84.686]],["parent/1707",[1427,7.011]],["name/1708",[1440,76.069]],["parent/1708",[1427,7.011]],["name/1709",[1441,84.686]],["parent/1709",[1427,7.011]],["name/1710",[1442,84.686]],["parent/1710",[1427,7.011]],["name/1711",[1443,84.686]],["parent/1711",[1427,7.011]],["name/1712",[1444,84.686]],["parent/1712",[1427,7.011]],["name/1713",[1445,84.686]],["parent/1713",[1427,7.011]],["name/1714",[1446,84.686]],["parent/1714",[1427,7.011]],["name/1715",[1447,84.686]],["parent/1715",[1427,7.011]],["name/1716",[1448,84.686]],["parent/1716",[1427,7.011]],["name/1717",[1449,84.686]],["parent/1717",[1427,7.011]],["name/1718",[1450,84.686]],["parent/1718",[1427,7.011]],["name/1719",[1451,84.686]],["parent/1719",[1427,7.011]],["name/1720",[1452,84.686]],["parent/1720",[1427,7.011]],["name/1721",[1453,84.686]],["parent/1721",[1427,7.011]],["name/1722",[1454,84.686]],["parent/1722",[1427,7.011]],["name/1723",[1455,84.686]],["parent/1723",[1427,7.011]],["name/1724",[1456,84.686]],["parent/1724",[1427,7.011]],["name/1725",[1457,84.686]],["parent/1725",[291,3.313]],["name/1726",[1458,67.046]],["parent/1726",[1459,9.986]],["name/1727",[1460,84.686]],["parent/1727",[1459,9.986]],["name/1728",[1461,84.686]],["parent/1728",[1459,9.986]],["name/1729",[1462,84.686]],["parent/1729",[291,3.313]],["name/1730",[1463,84.686]],["parent/1730",[1464,8.968]],["name/1731",[1465,84.686]],["parent/1731",[1464,8.968]],["name/1732",[1466,79.491]],["parent/1732",[1464,8.968]],["name/1733",[1467,84.686]],["parent/1733",[1464,8.968]],["name/1734",[1468,84.686]],["parent/1734",[1464,8.968]],["name/1735",[1469,84.686]],["parent/1735",[1464,8.968]],["name/1736",[1470,84.686]],["parent/1736",[1464,8.968]],["name/1737",[1471,84.686]],["parent/1737",[291,3.313]],["name/1738",[1472,84.686]],["parent/1738",[291,3.313]],["name/1739",[1473,84.686]],["parent/1739",[1474,11.117]],["name/1740",[1475,84.686]],["parent/1740",[291,3.313]],["name/1741",[279,32.637]],["parent/1741",[1476,10.435]],["name/1742",[1477,84.686]],["parent/1742",[1476,10.435]],["name/1743",[18,47.256]],["parent/1743",[1478,11.117]],["name/1744",[1479,84.686]],["parent/1744",[291,3.313]],["name/1745",[279,32.637]],["parent/1745",[1480,11.117]],["name/1746",[1481,84.686]],["parent/1746",[291,3.313]],["name/1747",[279,32.637]],["parent/1747",[1482,11.117]],["name/1748",[1483,84.686]],["parent/1748",[291,3.313]],["name/1749",[279,32.637]],["parent/1749",[1484,11.117]],["name/1750",[1485,84.686]],["parent/1750",[291,3.313]],["name/1751",[279,32.637]],["parent/1751",[1486,11.117]],["name/1752",[1487,84.686]],["parent/1752",[291,3.313]],["name/1753",[279,32.637]],["parent/1753",[1488,11.117]],["name/1754",[1489,84.686]],["parent/1754",[291,3.313]],["name/1755",[279,32.637]],["parent/1755",[1490,11.117]],["name/1756",[1491,84.686]],["parent/1756",[291,3.313]],["name/1757",[279,32.637]],["parent/1757",[1492,11.117]],["name/1758",[1493,84.686]],["parent/1758",[291,3.313]],["name/1759",[279,32.637]],["parent/1759",[1494,11.117]],["name/1760",[1495,84.686]],["parent/1760",[291,3.313]],["name/1761",[279,32.637]],["parent/1761",[1496,11.117]],["name/1762",[1497,84.686]],["parent/1762",[291,3.313]],["name/1763",[279,32.637]],["parent/1763",[1498,11.117]],["name/1764",[1499,84.686]],["parent/1764",[291,3.313]],["name/1765",[279,32.637]],["parent/1765",[1500,11.117]],["name/1766",[1501,84.686]],["parent/1766",[291,3.313]],["name/1767",[279,32.637]],["parent/1767",[1502,11.117]],["name/1768",[1503,84.686]],["parent/1768",[291,3.313]],["name/1769",[279,32.637]],["parent/1769",[1504,11.117]],["name/1770",[1505,84.686]],["parent/1770",[291,3.313]],["name/1771",[279,32.637]],["parent/1771",[1506,11.117]],["name/1772",[1507,84.686]],["parent/1772",[291,3.313]],["name/1773",[279,32.637]],["parent/1773",[1508,11.117]],["name/1774",[1509,84.686]],["parent/1774",[291,3.313]],["name/1775",[279,32.637]],["parent/1775",[1510,11.117]],["name/1776",[1511,84.686]],["parent/1776",[291,3.313]],["name/1777",[279,32.637]],["parent/1777",[1512,11.117]],["name/1778",[1513,84.686]],["parent/1778",[291,3.313]],["name/1779",[279,32.637]],["parent/1779",[1514,11.117]],["name/1780",[1515,84.686]],["parent/1780",[291,3.313]],["name/1781",[279,32.637]],["parent/1781",[1516,11.117]],["name/1782",[1517,84.686]],["parent/1782",[291,3.313]],["name/1783",[279,32.637]],["parent/1783",[1518,11.117]],["name/1784",[1519,84.686]],["parent/1784",[291,3.313]],["name/1785",[279,32.637]],["parent/1785",[1520,11.117]],["name/1786",[1521,84.686]],["parent/1786",[291,3.313]],["name/1787",[279,32.637]],["parent/1787",[1522,11.117]],["name/1788",[1523,84.686]],["parent/1788",[291,3.313]],["name/1789",[279,32.637]],["parent/1789",[1524,11.117]],["name/1790",[1525,84.686]],["parent/1790",[291,3.313]],["name/1791",[279,32.637]],["parent/1791",[1526,11.117]],["name/1792",[1527,84.686]],["parent/1792",[291,3.313]],["name/1793",[279,32.637]],["parent/1793",[1528,11.117]],["name/1794",[1529,84.686]],["parent/1794",[291,3.313]],["name/1795",[279,32.637]],["parent/1795",[1530,11.117]],["name/1796",[1531,84.686]],["parent/1796",[291,3.313]],["name/1797",[279,32.637]],["parent/1797",[1532,11.117]],["name/1798",[1533,84.686]],["parent/1798",[291,3.313]],["name/1799",[279,32.637]],["parent/1799",[1534,11.117]],["name/1800",[1535,84.686]],["parent/1800",[291,3.313]],["name/1801",[279,32.637]],["parent/1801",[1536,11.117]],["name/1802",[1537,84.686]],["parent/1802",[291,3.313]],["name/1803",[279,32.637]],["parent/1803",[1538,11.117]],["name/1804",[1539,84.686]],["parent/1804",[291,3.313]],["name/1805",[279,32.637]],["parent/1805",[1540,11.117]],["name/1806",[1541,84.686]],["parent/1806",[291,3.313]],["name/1807",[279,32.637]],["parent/1807",[1542,11.117]],["name/1808",[1543,84.686]],["parent/1808",[291,3.313]],["name/1809",[279,32.637]],["parent/1809",[1544,11.117]],["name/1810",[1545,84.686]],["parent/1810",[291,3.313]],["name/1811",[279,32.637]],["parent/1811",[1546,11.117]],["name/1812",[1547,84.686]],["parent/1812",[291,3.313]],["name/1813",[279,32.637]],["parent/1813",[1548,11.117]],["name/1814",[1549,84.686]],["parent/1814",[291,3.313]],["name/1815",[279,32.637]],["parent/1815",[1550,11.117]],["name/1816",[1551,84.686]],["parent/1816",[291,3.313]],["name/1817",[279,32.637]],["parent/1817",[1552,11.117]],["name/1818",[1553,84.686]],["parent/1818",[291,3.313]],["name/1819",[279,32.637]],["parent/1819",[1554,11.117]],["name/1820",[1555,84.686]],["parent/1820",[291,3.313]],["name/1821",[279,32.637]],["parent/1821",[1556,11.117]],["name/1822",[1557,84.686]],["parent/1822",[291,3.313]],["name/1823",[279,32.637]],["parent/1823",[1558,11.117]],["name/1824",[1559,84.686]],["parent/1824",[291,3.313]],["name/1825",[279,32.637]],["parent/1825",[1560,11.117]],["name/1826",[1561,84.686]],["parent/1826",[291,3.313]],["name/1827",[279,32.637]],["parent/1827",[1562,11.117]],["name/1828",[1563,84.686]],["parent/1828",[291,3.313]],["name/1829",[279,32.637]],["parent/1829",[1564,11.117]],["name/1830",[1565,84.686]],["parent/1830",[291,3.313]],["name/1831",[279,32.637]],["parent/1831",[1566,11.117]],["name/1832",[1567,84.686]],["parent/1832",[291,3.313]],["name/1833",[279,32.637]],["parent/1833",[1568,11.117]],["name/1834",[1569,84.686]],["parent/1834",[291,3.313]],["name/1835",[279,32.637]],["parent/1835",[1570,11.117]],["name/1836",[1571,84.686]],["parent/1836",[291,3.313]],["name/1837",[279,32.637]],["parent/1837",[1572,11.117]],["name/1838",[1573,84.686]],["parent/1838",[291,3.313]],["name/1839",[279,32.637]],["parent/1839",[1574,11.117]],["name/1840",[1575,84.686]],["parent/1840",[291,3.313]],["name/1841",[279,32.637]],["parent/1841",[1576,11.117]],["name/1842",[1577,84.686]],["parent/1842",[291,3.313]],["name/1843",[279,32.637]],["parent/1843",[1578,11.117]],["name/1844",[1579,84.686]],["parent/1844",[291,3.313]],["name/1845",[279,32.637]],["parent/1845",[1580,11.117]],["name/1846",[1581,84.686]],["parent/1846",[291,3.313]],["name/1847",[279,32.637]],["parent/1847",[1582,11.117]],["name/1848",[1583,84.686]],["parent/1848",[291,3.313]],["name/1849",[279,32.637]],["parent/1849",[1584,11.117]],["name/1850",[1585,84.686]],["parent/1850",[291,3.313]],["name/1851",[279,32.637]],["parent/1851",[1586,11.117]],["name/1852",[1587,84.686]],["parent/1852",[291,3.313]],["name/1853",[279,32.637]],["parent/1853",[1588,11.117]],["name/1854",[1589,84.686]],["parent/1854",[291,3.313]],["name/1855",[279,32.637]],["parent/1855",[1590,11.117]],["name/1856",[1591,84.686]],["parent/1856",[291,3.313]],["name/1857",[279,32.637]],["parent/1857",[1592,11.117]],["name/1858",[1593,84.686]],["parent/1858",[291,3.313]],["name/1859",[279,32.637]],["parent/1859",[1594,11.117]],["name/1860",[1595,84.686]],["parent/1860",[291,3.313]],["name/1861",[279,32.637]],["parent/1861",[1596,11.117]],["name/1862",[1597,84.686]],["parent/1862",[291,3.313]],["name/1863",[279,32.637]],["parent/1863",[1598,11.117]],["name/1864",[1599,84.686]],["parent/1864",[291,3.313]],["name/1865",[279,32.637]],["parent/1865",[1600,11.117]],["name/1866",[1601,84.686]],["parent/1866",[291,3.313]],["name/1867",[279,32.637]],["parent/1867",[1602,11.117]],["name/1868",[1603,84.686]],["parent/1868",[291,3.313]],["name/1869",[279,32.637]],["parent/1869",[1604,11.117]],["name/1870",[1605,84.686]],["parent/1870",[291,3.313]],["name/1871",[279,32.637]],["parent/1871",[1606,11.117]],["name/1872",[1607,84.686]],["parent/1872",[291,3.313]],["name/1873",[279,32.637]],["parent/1873",[1608,11.117]],["name/1874",[1609,84.686]],["parent/1874",[291,3.313]],["name/1875",[279,32.637]],["parent/1875",[1610,11.117]],["name/1876",[1611,84.686]],["parent/1876",[291,3.313]],["name/1877",[279,32.637]],["parent/1877",[1612,11.117]],["name/1878",[1613,84.686]],["parent/1878",[291,3.313]],["name/1879",[279,32.637]],["parent/1879",[1614,11.117]],["name/1880",[1615,84.686]],["parent/1880",[291,3.313]],["name/1881",[279,32.637]],["parent/1881",[1616,11.117]],["name/1882",[1617,84.686]],["parent/1882",[291,3.313]],["name/1883",[279,32.637]],["parent/1883",[1618,11.117]],["name/1884",[1619,84.686]],["parent/1884",[291,3.313]],["name/1885",[279,32.637]],["parent/1885",[1620,11.117]],["name/1886",[1621,84.686]],["parent/1886",[291,3.313]],["name/1887",[279,32.637]],["parent/1887",[1622,11.117]],["name/1888",[1623,84.686]],["parent/1888",[291,3.313]],["name/1889",[279,32.637]],["parent/1889",[1624,11.117]],["name/1890",[1625,84.686]],["parent/1890",[291,3.313]],["name/1891",[279,32.637]],["parent/1891",[1626,11.117]],["name/1892",[1627,84.686]],["parent/1892",[291,3.313]],["name/1893",[279,32.637]],["parent/1893",[1628,11.117]],["name/1894",[1629,84.686]],["parent/1894",[291,3.313]],["name/1895",[279,32.637]],["parent/1895",[1630,11.117]],["name/1896",[1631,84.686]],["parent/1896",[291,3.313]],["name/1897",[279,32.637]],["parent/1897",[1632,11.117]],["name/1898",[1633,84.686]],["parent/1898",[291,3.313]],["name/1899",[279,32.637]],["parent/1899",[1634,11.117]],["name/1900",[1635,84.686]],["parent/1900",[291,3.313]],["name/1901",[279,32.637]],["parent/1901",[1636,11.117]],["name/1902",[1637,84.686]],["parent/1902",[291,3.313]],["name/1903",[279,32.637]],["parent/1903",[1638,11.117]],["name/1904",[1639,84.686]],["parent/1904",[291,3.313]],["name/1905",[279,32.637]],["parent/1905",[1640,11.117]],["name/1906",[1641,84.686]],["parent/1906",[291,3.313]],["name/1907",[279,32.637]],["parent/1907",[1642,11.117]],["name/1908",[1643,84.686]],["parent/1908",[291,3.313]],["name/1909",[1644,63.123]],["parent/1909",[1645,8.968]],["name/1910",[568,76.069]],["parent/1910",[1645,8.968]],["name/1911",[279,32.637]],["parent/1911",[1645,8.968]],["name/1912",[570,79.491]],["parent/1912",[1645,8.968]],["name/1913",[571,79.491]],["parent/1913",[1645,8.968]],["name/1914",[122,56.704]],["parent/1914",[1645,8.968]],["name/1915",[413,67.046]],["parent/1915",[1645,8.968]],["name/1916",[1646,84.686]],["parent/1916",[291,3.313]],["name/1917",[1647,73.514]],["parent/1917",[1648,8.801]],["name/1918",[304,71.473]],["parent/1918",[1648,8.801]],["name/1919",[875,76.069]],["parent/1919",[1648,8.801]],["name/1920",[1649,79.491]],["parent/1920",[1648,8.801]],["name/1921",[1650,79.491]],["parent/1921",[1648,8.801]],["name/1922",[1651,79.491]],["parent/1922",[1648,8.801]],["name/1923",[1652,79.491]],["parent/1923",[1648,8.801]],["name/1924",[1653,79.491]],["parent/1924",[1648,8.801]],["name/1925",[1654,84.686]],["parent/1925",[291,3.313]],["name/1926",[1655,84.686]],["parent/1926",[291,3.313]],["name/1927",[985,71.473]],["parent/1927",[1656,8.968]],["name/1928",[1657,73.514]],["parent/1928",[1656,8.968]],["name/1929",[1007,64.897]],["parent/1929",[1656,8.968]],["name/1930",[1658,79.491]],["parent/1930",[1656,8.968]],["name/1931",[304,71.473]],["parent/1931",[1656,8.968]],["name/1932",[1647,73.514]],["parent/1932",[1656,8.968]],["name/1933",[1659,79.491]],["parent/1933",[1656,8.968]],["name/1934",[1660,84.686]],["parent/1934",[291,3.313]],["name/1935",[1661,84.686]],["parent/1935",[1662,9.65]],["name/1936",[189,39.191]],["parent/1936",[1663,9.382]],["name/1937",[191,49.763]],["parent/1937",[1663,9.382]],["name/1938",[46,42.129]],["parent/1938",[1663,9.382]],["name/1939",[123,37.886]],["parent/1939",[1663,9.382]],["name/1940",[192,48.337]],["parent/1940",[1663,9.382]],["name/1941",[1664,84.686]],["parent/1941",[1662,9.65]],["name/1942",[189,39.191]],["parent/1942",[1665,9.159]],["name/1943",[191,49.763]],["parent/1943",[1665,9.159]],["name/1944",[46,42.129]],["parent/1944",[1665,9.159]],["name/1945",[123,37.886]],["parent/1945",[1665,9.159]],["name/1946",[192,48.337]],["parent/1946",[1665,9.159]],["name/1947",[201,59.136]],["parent/1947",[1665,9.159]],["name/1948",[1666,84.686]],["parent/1948",[1662,9.65]],["name/1949",[1667,84.686]],["parent/1949",[1662,9.65]],["name/1950",[189,39.191]],["parent/1950",[1668,9.159]],["name/1951",[191,49.763]],["parent/1951",[1668,9.159]],["name/1952",[46,42.129]],["parent/1952",[1668,9.159]],["name/1953",[123,37.886]],["parent/1953",[1668,9.159]],["name/1954",[245,73.514]],["parent/1954",[1668,9.159]],["name/1955",[247,73.514]],["parent/1955",[1669,10.435]],["name/1956",[798,76.069]],["parent/1956",[1669,10.435]],["name/1957",[192,48.337]],["parent/1957",[1668,9.159]],["name/1958",[1670,69.774]],["parent/1958",[291,3.313]],["name/1959",[1671,84.686]],["parent/1959",[1672,6.504]],["name/1960",[1673,84.686]],["parent/1960",[1672,6.504]],["name/1961",[1674,84.686]],["parent/1961",[1672,6.504]],["name/1962",[1675,84.686]],["parent/1962",[1672,6.504]],["name/1963",[1676,84.686]],["parent/1963",[1672,6.504]],["name/1964",[1677,84.686]],["parent/1964",[1672,6.504]],["name/1965",[1678,84.686]],["parent/1965",[1672,6.504]],["name/1966",[1679,84.686]],["parent/1966",[1672,6.504]],["name/1967",[1680,84.686]],["parent/1967",[1672,6.504]],["name/1968",[1681,79.491]],["parent/1968",[1672,6.504]],["name/1969",[1148,76.069]],["parent/1969",[1672,6.504]],["name/1970",[1682,84.686]],["parent/1970",[1672,6.504]],["name/1971",[1683,84.686]],["parent/1971",[1672,6.504]],["name/1972",[1684,84.686]],["parent/1972",[1672,6.504]],["name/1973",[1685,84.686]],["parent/1973",[1672,6.504]],["name/1974",[1686,84.686]],["parent/1974",[1672,6.504]],["name/1975",[1687,84.686]],["parent/1975",[1672,6.504]],["name/1976",[1688,84.686]],["parent/1976",[1672,6.504]],["name/1977",[1689,84.686]],["parent/1977",[1672,6.504]],["name/1978",[1690,76.069]],["parent/1978",[1672,6.504]],["name/1979",[1691,76.069]],["parent/1979",[1672,6.504]],["name/1980",[1692,84.686]],["parent/1980",[1672,6.504]],["name/1981",[425,45.531]],["parent/1981",[1672,6.504]],["name/1982",[440,68.319]],["parent/1982",[1672,6.504]],["name/1983",[415,40.51]],["parent/1983",[1672,6.504]],["name/1984",[122,56.704]],["parent/1984",[1672,6.504]],["name/1985",[574,68.319]],["parent/1985",[1672,6.504]],["name/1986",[304,71.473]],["parent/1986",[1672,6.504]],["name/1987",[875,76.069]],["parent/1987",[1672,6.504]],["name/1988",[1649,79.491]],["parent/1988",[1672,6.504]],["name/1989",[1693,84.686]],["parent/1989",[1672,6.504]],["name/1990",[1694,84.686]],["parent/1990",[1672,6.504]],["name/1991",[1650,79.491]],["parent/1991",[1672,6.504]],["name/1992",[1651,79.491]],["parent/1992",[1672,6.504]],["name/1993",[1652,79.491]],["parent/1993",[1672,6.504]],["name/1994",[1647,73.514]],["parent/1994",[1672,6.504]],["name/1995",[1653,79.491]],["parent/1995",[1672,6.504]],["name/1996",[1695,84.686]],["parent/1996",[1672,6.504]],["name/1997",[1696,84.686]],["parent/1997",[1672,6.504]],["name/1998",[1697,84.686]],["parent/1998",[1672,6.504]],["name/1999",[345,79.491]],["parent/1999",[1672,6.504]],["name/2000",[1698,84.686]],["parent/2000",[1672,6.504]],["name/2001",[439,79.491]],["parent/2001",[1672,6.504]],["name/2002",[1699,84.686]],["parent/2002",[1672,6.504]],["name/2003",[1700,84.686]],["parent/2003",[1672,6.504]],["name/2004",[438,79.491]],["parent/2004",[1672,6.504]],["name/2005",[632,73.514]],["parent/2005",[1672,6.504]],["name/2006",[1701,84.686]],["parent/2006",[291,3.313]],["name/2007",[1702,84.686]],["parent/2007",[1703,10.435]],["name/2008",[287,79.491]],["parent/2008",[1703,10.435]],["name/2009",[1704,84.686]],["parent/2009",[291,3.313]],["name/2010",[279,32.637]],["parent/2010",[1705,9.986]],["name/2011",[1706,84.686]],["parent/2011",[1705,9.986]],["name/2012",[1007,64.897]],["parent/2012",[1705,9.986]],["name/2013",[1707,84.686]],["parent/2013",[291,3.313]],["name/2014",[1708,84.686]],["parent/2014",[1709,6.82]],["name/2015",[1710,84.686]],["parent/2015",[1709,6.82]],["name/2016",[1711,73.514]],["parent/2016",[1709,6.82]],["name/2017",[1712,76.069]],["parent/2017",[1709,6.82]],["name/2018",[1713,84.686]],["parent/2018",[1709,6.82]],["name/2019",[1149,59.136]],["parent/2019",[1709,6.82]],["name/2020",[1714,84.686]],["parent/2020",[1709,6.82]],["name/2021",[425,45.531]],["parent/2021",[1709,6.82]],["name/2022",[1310,67.046]],["parent/2022",[1709,6.82]],["name/2023",[1715,84.686]],["parent/2023",[1709,6.82]],["name/2024",[1716,84.686]],["parent/2024",[1709,6.82]],["name/2025",[1717,84.686]],["parent/2025",[1709,6.82]],["name/2026",[1718,84.686]],["parent/2026",[1709,6.82]],["name/2027",[1719,79.491]],["parent/2027",[1709,6.82]],["name/2028",[1466,79.491]],["parent/2028",[1709,6.82]],["name/2029",[1720,84.686]],["parent/2029",[1709,6.82]],["name/2030",[1721,84.686]],["parent/2030",[1709,6.82]],["name/2031",[1722,84.686]],["parent/2031",[1709,6.82]],["name/2032",[1723,84.686]],["parent/2032",[1709,6.82]],["name/2033",[1724,84.686]],["parent/2033",[1709,6.82]],["name/2034",[1725,84.686]],["parent/2034",[1709,6.82]],["name/2035",[1726,84.686]],["parent/2035",[1709,6.82]],["name/2036",[1727,84.686]],["parent/2036",[1709,6.82]],["name/2037",[1728,84.686]],["parent/2037",[1709,6.82]],["name/2038",[1729,84.686]],["parent/2038",[1709,6.82]],["name/2039",[1730,84.686]],["parent/2039",[1709,6.82]],["name/2040",[1731,84.686]],["parent/2040",[1709,6.82]],["name/2041",[1732,84.686]],["parent/2041",[1709,6.82]],["name/2042",[1733,84.686]],["parent/2042",[1709,6.82]],["name/2043",[1734,84.686]],["parent/2043",[1709,6.82]],["name/2044",[1735,84.686]],["parent/2044",[1709,6.82]],["name/2045",[1736,84.686]],["parent/2045",[1709,6.82]],["name/2046",[1737,84.686]],["parent/2046",[1709,6.82]],["name/2047",[1738,84.686]],["parent/2047",[1709,6.82]],["name/2048",[1739,84.686]],["parent/2048",[1709,6.82]],["name/2049",[1740,84.686]],["parent/2049",[1709,6.82]],["name/2050",[1741,84.686]],["parent/2050",[1709,6.82]],["name/2051",[1742,84.686]],["parent/2051",[291,3.313]],["name/2052",[1743,84.686]],["parent/2052",[1744,8.653]],["name/2053",[1745,84.686]],["parent/2053",[1744,8.653]],["name/2054",[276,71.473]],["parent/2054",[1744,8.653]],["name/2055",[277,73.514]],["parent/2055",[1744,8.653]],["name/2056",[251,62.341]],["parent/2056",[1744,8.653]],["name/2057",[1746,84.686]],["parent/2057",[1744,8.653]],["name/2058",[123,37.886]],["parent/2058",[1744,8.653]],["name/2059",[565,76.069]],["parent/2059",[1744,8.653]],["name/2060",[566,79.491]],["parent/2060",[1744,8.653]],["name/2061",[1747,84.686]],["parent/2061",[291,3.313]],["name/2062",[123,37.886]],["parent/2062",[1748,9.382]],["name/2063",[189,39.191]],["parent/2063",[1748,9.382]],["name/2064",[1749,84.686]],["parent/2064",[1748,9.382]],["name/2065",[1750,76.069]],["parent/2065",[1748,9.382]],["name/2066",[296,69.774]],["parent/2066",[1748,9.382]],["name/2067",[1751,84.686]],["parent/2067",[291,3.313]],["name/2068",[1752,76.069]],["parent/2068",[1753,9.986]],["name/2069",[1754,68.319]],["parent/2069",[1753,9.986]],["name/2070",[1755,71.473]],["parent/2070",[1753,9.986]],["name/2071",[1756,84.686]],["parent/2071",[291,3.313]],["name/2072",[1757,84.686]],["parent/2072",[1758,8.088]],["name/2073",[1711,73.514]],["parent/2073",[1758,8.088]],["name/2074",[1759,84.686]],["parent/2074",[1758,8.088]],["name/2075",[1092,71.473]],["parent/2075",[1758,8.088]],["name/2076",[425,45.531]],["parent/2076",[1758,8.088]],["name/2077",[1760,84.686]],["parent/2077",[1758,8.088]],["name/2078",[1761,84.686]],["parent/2078",[1758,8.088]],["name/2079",[1762,84.686]],["parent/2079",[1758,8.088]],["name/2080",[1763,84.686]],["parent/2080",[1758,8.088]],["name/2081",[1764,84.686]],["parent/2081",[1758,8.088]],["name/2082",[1765,73.514]],["parent/2082",[1758,8.088]],["name/2083",[1766,84.686]],["parent/2083",[1758,8.088]],["name/2084",[1007,64.897]],["parent/2084",[1758,8.088]],["name/2085",[163,53.406]],["parent/2085",[1758,8.088]],["name/2086",[1767,84.686]],["parent/2086",[291,3.313]],["name/2087",[1768,73.514]],["parent/2087",[1769,11.117]],["name/2088",[1770,84.686]],["parent/2088",[291,3.313]],["name/2089",[597,69.774]],["parent/2089",[1771,10.435]],["name/2090",[1657,73.514]],["parent/2090",[1771,10.435]],["name/2091",[1772,84.686]],["parent/2091",[291,3.313]],["name/2092",[1006,79.491]],["parent/2092",[1773,9.986]],["name/2093",[304,71.473]],["parent/2093",[1773,9.986]],["name/2094",[1647,73.514]],["parent/2094",[1773,9.986]],["name/2095",[1774,84.686]],["parent/2095",[291,3.313]],["name/2096",[1007,64.897]],["parent/2096",[1775,8.519]],["name/2097",[1776,79.491]],["parent/2097",[1775,8.519]],["name/2098",[1754,68.319]],["parent/2098",[1775,8.519]],["name/2099",[1777,63.123]],["parent/2099",[1775,8.519]],["name/2100",[1778,65.914]],["parent/2100",[1775,8.519]],["name/2101",[1779,64.897]],["parent/2101",[1775,8.519]],["name/2102",[1008,76.069]],["parent/2102",[1775,8.519]],["name/2103",[468,67.046]],["parent/2103",[1775,8.519]],["name/2104",[745,64.897]],["parent/2104",[1775,8.519]],["name/2105",[1780,79.491]],["parent/2105",[1775,8.519]],["name/2106",[1781,84.686]],["parent/2106",[291,3.313]],["name/2107",[1782,79.491]],["parent/2107",[1783,10.435]],["name/2108",[1784,79.491]],["parent/2108",[1783,10.435]],["name/2109",[1785,84.686]],["parent/2109",[291,3.313]],["name/2110",[1752,76.069]],["parent/2110",[1786,9.65]],["name/2111",[1787,76.069]],["parent/2111",[1786,9.65]],["name/2112",[1788,84.686]],["parent/2112",[1786,9.65]],["name/2113",[1789,79.491]],["parent/2113",[1786,9.65]],["name/2114",[1790,84.686]],["parent/2114",[291,3.313]],["name/2115",[1777,63.123]],["parent/2115",[1791,9.986]],["name/2116",[1792,73.514]],["parent/2116",[1791,9.986]],["name/2117",[1793,73.514]],["parent/2117",[1791,9.986]],["name/2118",[1794,84.686]],["parent/2118",[291,3.313]],["name/2119",[1795,79.491]],["parent/2119",[1796,7.444]],["name/2120",[1797,79.491]],["parent/2120",[1796,7.444]],["name/2121",[1798,76.069]],["parent/2121",[1796,7.444]],["name/2122",[1799,68.319]],["parent/2122",[1796,7.444]],["name/2123",[1711,73.514]],["parent/2123",[1796,7.444]],["name/2124",[1712,76.069]],["parent/2124",[1796,7.444]],["name/2125",[1800,76.069]],["parent/2125",[1796,7.444]],["name/2126",[1092,71.473]],["parent/2126",[1796,7.444]],["name/2127",[1801,73.514]],["parent/2127",[1796,7.444]],["name/2128",[1802,76.069]],["parent/2128",[1796,7.444]],["name/2129",[1803,79.491]],["parent/2129",[1796,7.444]],["name/2130",[18,47.256]],["parent/2130",[1804,11.117]],["name/2131",[1805,79.491]],["parent/2131",[1796,7.444]],["name/2132",[18,47.256]],["parent/2132",[1806,11.117]],["name/2133",[163,53.406]],["parent/2133",[1796,7.444]],["name/2134",[425,45.531]],["parent/2134",[1796,7.444]],["name/2135",[1768,73.514]],["parent/2135",[1796,7.444]],["name/2136",[1807,79.491]],["parent/2136",[1796,7.444]],["name/2137",[1808,79.491]],["parent/2137",[1796,7.444]],["name/2138",[1809,79.491]],["parent/2138",[1796,7.444]],["name/2139",[1810,79.491]],["parent/2139",[1796,7.444]],["name/2140",[1811,79.491]],["parent/2140",[1796,7.444]],["name/2141",[1812,79.491]],["parent/2141",[1796,7.444]],["name/2142",[1813,79.491]],["parent/2142",[1796,7.444]],["name/2143",[1814,79.491]],["parent/2143",[1796,7.444]],["name/2144",[1815,84.686]],["parent/2144",[291,3.313]],["name/2145",[1816,84.686]],["parent/2145",[1817,6.717]],["name/2146",[354,76.069]],["parent/2146",[1817,6.717]],["name/2147",[1789,79.491]],["parent/2147",[1817,6.717]],["name/2148",[425,45.531]],["parent/2148",[1817,6.717]],["name/2149",[1768,73.514]],["parent/2149",[1817,6.717]],["name/2150",[1818,84.686]],["parent/2150",[1817,6.717]],["name/2151",[1808,79.491]],["parent/2151",[1817,6.717]],["name/2152",[1819,84.686]],["parent/2152",[1817,6.717]],["name/2153",[1820,79.491]],["parent/2153",[1817,6.717]],["name/2154",[1821,84.686]],["parent/2154",[1817,6.717]],["name/2155",[1822,84.686]],["parent/2155",[1817,6.717]],["name/2156",[1823,84.686]],["parent/2156",[1817,6.717]],["name/2157",[1824,84.686]],["parent/2157",[1817,6.717]],["name/2158",[1825,84.686]],["parent/2158",[1817,6.717]],["name/2159",[1826,84.686]],["parent/2159",[1817,6.717]],["name/2160",[1827,84.686]],["parent/2160",[1817,6.717]],["name/2161",[1828,84.686]],["parent/2161",[1817,6.717]],["name/2162",[1829,84.686]],["parent/2162",[1817,6.717]],["name/2163",[1830,84.686]],["parent/2163",[1817,6.717]],["name/2164",[1831,84.686]],["parent/2164",[1817,6.717]],["name/2165",[1795,79.491]],["parent/2165",[1817,6.717]],["name/2166",[1797,79.491]],["parent/2166",[1817,6.717]],["name/2167",[1798,76.069]],["parent/2167",[1817,6.717]],["name/2168",[1799,68.319]],["parent/2168",[1817,6.717]],["name/2169",[1711,73.514]],["parent/2169",[1817,6.717]],["name/2170",[1712,76.069]],["parent/2170",[1817,6.717]],["name/2171",[1800,76.069]],["parent/2171",[1817,6.717]],["name/2172",[1092,71.473]],["parent/2172",[1817,6.717]],["name/2173",[1801,73.514]],["parent/2173",[1817,6.717]],["name/2174",[1802,76.069]],["parent/2174",[1817,6.717]],["name/2175",[1803,79.491]],["parent/2175",[1817,6.717]],["name/2176",[18,47.256]],["parent/2176",[1832,11.117]],["name/2177",[1805,79.491]],["parent/2177",[1817,6.717]],["name/2178",[18,47.256]],["parent/2178",[1833,11.117]],["name/2179",[163,53.406]],["parent/2179",[1817,6.717]],["name/2180",[1807,79.491]],["parent/2180",[1817,6.717]],["name/2181",[1809,79.491]],["parent/2181",[1817,6.717]],["name/2182",[1810,79.491]],["parent/2182",[1817,6.717]],["name/2183",[1811,79.491]],["parent/2183",[1817,6.717]],["name/2184",[1812,79.491]],["parent/2184",[1817,6.717]],["name/2185",[1813,79.491]],["parent/2185",[1817,6.717]],["name/2186",[1814,79.491]],["parent/2186",[1817,6.717]],["name/2187",[1834,84.686]],["parent/2187",[291,3.313]],["name/2188",[1835,58.601]],["parent/2188",[1836,9.986]],["name/2189",[1837,73.514]],["parent/2189",[1836,9.986]],["name/2190",[837,68.319]],["parent/2190",[1836,9.986]],["name/2191",[1838,84.686]],["parent/2191",[291,3.313]],["name/2192",[1839,84.686]],["parent/2192",[1840,7.626]],["name/2193",[1841,76.069]],["parent/2193",[1840,7.626]],["name/2194",[629,60.936]],["parent/2194",[1840,7.626]],["name/2195",[1842,84.686]],["parent/2195",[1840,7.626]],["name/2196",[1843,84.686]],["parent/2196",[1840,7.626]],["name/2197",[1844,79.491]],["parent/2197",[1840,7.626]],["name/2198",[1845,79.491]],["parent/2198",[1840,7.626]],["name/2199",[18,47.256]],["parent/2199",[1846,11.117]],["name/2200",[1847,84.686]],["parent/2200",[1840,7.626]],["name/2201",[425,45.531]],["parent/2201",[1840,7.626]],["name/2202",[1768,73.514]],["parent/2202",[1840,7.626]],["name/2203",[1848,84.686]],["parent/2203",[1840,7.626]],["name/2204",[1849,84.686]],["parent/2204",[1840,7.626]],["name/2205",[1850,84.686]],["parent/2205",[1840,7.626]],["name/2206",[1851,84.686]],["parent/2206",[1840,7.626]],["name/2207",[1852,84.686]],["parent/2207",[1840,7.626]],["name/2208",[1820,79.491]],["parent/2208",[1840,7.626]],["name/2209",[1853,84.686]],["parent/2209",[1840,7.626]],["name/2210",[1854,84.686]],["parent/2210",[1840,7.626]],["name/2211",[1855,84.686]],["parent/2211",[1840,7.626]],["name/2212",[1856,84.686]],["parent/2212",[1840,7.626]],["name/2213",[1857,84.686]],["parent/2213",[291,3.313]],["name/2214",[189,39.191]],["parent/2214",[1858,10.435]],["name/2215",[112,60.3]],["parent/2215",[1858,10.435]],["name/2216",[1859,84.686]],["parent/2216",[291,3.313]],["name/2217",[448,64.897]],["parent/2217",[1860,8.398]],["name/2218",[1841,76.069]],["parent/2218",[1860,8.398]],["name/2219",[449,65.914]],["parent/2219",[1860,8.398]],["name/2220",[1782,79.491]],["parent/2220",[1860,8.398]],["name/2221",[1784,79.491]],["parent/2221",[1860,8.398]],["name/2222",[1787,76.069]],["parent/2222",[1860,8.398]],["name/2223",[1861,84.686]],["parent/2223",[1860,8.398]],["name/2224",[1862,84.686]],["parent/2224",[1860,8.398]],["name/2225",[1863,84.686]],["parent/2225",[1860,8.398]],["name/2226",[1864,84.686]],["parent/2226",[1860,8.398]],["name/2227",[1865,84.686]],["parent/2227",[1860,8.398]],["name/2228",[1866,84.686]],["parent/2228",[291,3.313]],["name/2229",[1867,84.686]],["parent/2229",[1868,6.856]],["name/2230",[354,76.069]],["parent/2230",[1868,6.856]],["name/2231",[1869,84.686]],["parent/2231",[1868,6.856]],["name/2232",[1870,71.473]],["parent/2232",[1868,6.856]],["name/2233",[1871,76.069]],["parent/2233",[1868,6.856]],["name/2234",[1872,76.069]],["parent/2234",[1868,6.856]],["name/2235",[1690,76.069]],["parent/2235",[1868,6.856]],["name/2236",[1873,84.686]],["parent/2236",[1868,6.856]],["name/2237",[1874,84.686]],["parent/2237",[1868,6.856]],["name/2238",[1875,76.069]],["parent/2238",[1868,6.856]],["name/2239",[1149,59.136]],["parent/2239",[1868,6.856]],["name/2240",[629,60.936]],["parent/2240",[1868,6.856]],["name/2241",[1876,79.491]],["parent/2241",[1868,6.856]],["name/2242",[425,45.531]],["parent/2242",[1868,6.856]],["name/2243",[1877,79.491]],["parent/2243",[1868,6.856]],["name/2244",[1778,65.914]],["parent/2244",[1868,6.856]],["name/2245",[1779,64.897]],["parent/2245",[1868,6.856]],["name/2246",[468,67.046]],["parent/2246",[1868,6.856]],["name/2247",[1776,79.491]],["parent/2247",[1868,6.856]],["name/2248",[745,64.897]],["parent/2248",[1868,6.856]],["name/2249",[1878,84.686]],["parent/2249",[1868,6.856]],["name/2250",[1007,64.897]],["parent/2250",[1868,6.856]],["name/2251",[1008,76.069]],["parent/2251",[1868,6.856]],["name/2252",[1879,84.686]],["parent/2252",[1868,6.856]],["name/2253",[1880,84.686]],["parent/2253",[1868,6.856]],["name/2254",[1310,67.046]],["parent/2254",[1868,6.856]],["name/2255",[1881,79.491]],["parent/2255",[1868,6.856]],["name/2256",[1882,84.686]],["parent/2256",[1868,6.856]],["name/2257",[1883,84.686]],["parent/2257",[1868,6.856]],["name/2258",[1884,79.491]],["parent/2258",[1868,6.856]],["name/2259",[163,53.406]],["parent/2259",[1868,6.856]],["name/2260",[1885,84.686]],["parent/2260",[1868,6.856]],["name/2261",[1886,84.686]],["parent/2261",[1868,6.856]],["name/2262",[1887,84.686]],["parent/2262",[1868,6.856]],["name/2263",[1888,84.686]],["parent/2263",[1868,6.856]],["name/2264",[1889,84.686]],["parent/2264",[1868,6.856]],["name/2265",[1890,84.686]],["parent/2265",[291,3.313]],["name/2266",[1644,63.123]],["parent/2266",[1891,9.159]],["name/2267",[568,76.069]],["parent/2267",[1891,9.159]],["name/2268",[279,32.637]],["parent/2268",[1891,9.159]],["name/2269",[1892,84.686]],["parent/2269",[1891,9.159]],["name/2270",[1893,84.686]],["parent/2270",[1891,9.159]],["name/2271",[308,63.971]],["parent/2271",[1891,9.159]],["name/2272",[1894,84.686]],["parent/2272",[291,3.313]],["name/2273",[1895,84.686]],["parent/2273",[291,3.313]],["name/2274",[1896,84.686]],["parent/2274",[1897,7.388]],["name/2275",[1898,76.069]],["parent/2275",[1897,7.388]],["name/2276",[1899,84.686]],["parent/2276",[1897,7.388]],["name/2277",[1900,84.686]],["parent/2277",[1897,7.388]],["name/2278",[1901,76.069]],["parent/2278",[1897,7.388]],["name/2279",[163,53.406]],["parent/2279",[1897,7.388]],["name/2280",[425,45.531]],["parent/2280",[1897,7.388]],["name/2281",[1902,76.069]],["parent/2281",[1897,7.388]],["name/2282",[1777,63.123]],["parent/2282",[1897,7.388]],["name/2283",[1778,65.914]],["parent/2283",[1897,7.388]],["name/2284",[1779,64.897]],["parent/2284",[1897,7.388]],["name/2285",[468,67.046]],["parent/2285",[1897,7.388]],["name/2286",[1903,76.069]],["parent/2286",[1897,7.388]],["name/2287",[1904,69.774]],["parent/2287",[1897,7.388]],["name/2288",[1754,68.319]],["parent/2288",[1897,7.388]],["name/2289",[1007,64.897]],["parent/2289",[1897,7.388]],["name/2290",[1905,73.514]],["parent/2290",[1897,7.388]],["name/2291",[1906,76.069]],["parent/2291",[1897,7.388]],["name/2292",[1907,76.069]],["parent/2292",[1897,7.388]],["name/2293",[1908,76.069]],["parent/2293",[1897,7.388]],["name/2294",[1909,76.069]],["parent/2294",[1897,7.388]],["name/2295",[1910,76.069]],["parent/2295",[1897,7.388]],["name/2296",[1911,76.069]],["parent/2296",[1897,7.388]],["name/2297",[1912,76.069]],["parent/2297",[1897,7.388]],["name/2298",[1913,84.686]],["parent/2298",[291,3.313]],["name/2299",[1898,76.069]],["parent/2299",[1914,7.562]],["name/2300",[1901,76.069]],["parent/2300",[1914,7.562]],["name/2301",[163,53.406]],["parent/2301",[1914,7.562]],["name/2302",[425,45.531]],["parent/2302",[1914,7.562]],["name/2303",[1902,76.069]],["parent/2303",[1914,7.562]],["name/2304",[1777,63.123]],["parent/2304",[1914,7.562]],["name/2305",[1778,65.914]],["parent/2305",[1914,7.562]],["name/2306",[1779,64.897]],["parent/2306",[1914,7.562]],["name/2307",[468,67.046]],["parent/2307",[1914,7.562]],["name/2308",[1903,76.069]],["parent/2308",[1914,7.562]],["name/2309",[1904,69.774]],["parent/2309",[1914,7.562]],["name/2310",[1754,68.319]],["parent/2310",[1914,7.562]],["name/2311",[1007,64.897]],["parent/2311",[1914,7.562]],["name/2312",[1905,73.514]],["parent/2312",[1914,7.562]],["name/2313",[1906,76.069]],["parent/2313",[1914,7.562]],["name/2314",[1907,76.069]],["parent/2314",[1914,7.562]],["name/2315",[1908,76.069]],["parent/2315",[1914,7.562]],["name/2316",[1909,76.069]],["parent/2316",[1914,7.562]],["name/2317",[1910,76.069]],["parent/2317",[1914,7.562]],["name/2318",[1911,76.069]],["parent/2318",[1914,7.562]],["name/2319",[1912,76.069]],["parent/2319",[1914,7.562]],["name/2320",[1915,84.686]],["parent/2320",[291,3.313]],["name/2321",[1916,71.473]],["parent/2321",[1917,11.117]],["name/2322",[1918,84.686]],["parent/2322",[291,3.313]],["name/2323",[1919,84.686]],["parent/2323",[1920,8.398]],["name/2324",[1752,76.069]],["parent/2324",[1920,8.398]],["name/2325",[1921,84.686]],["parent/2325",[1920,8.398]],["name/2326",[1904,69.774]],["parent/2326",[1920,8.398]],["name/2327",[1754,68.319]],["parent/2327",[1920,8.398]],["name/2328",[1922,76.069]],["parent/2328",[1920,8.398]],["name/2329",[1777,63.123]],["parent/2329",[1920,8.398]],["name/2330",[1778,65.914]],["parent/2330",[1920,8.398]],["name/2331",[1779,64.897]],["parent/2331",[1920,8.398]],["name/2332",[1923,84.686]],["parent/2332",[1920,8.398]],["name/2333",[468,67.046]],["parent/2333",[1920,8.398]],["name/2334",[1924,84.686]],["parent/2334",[291,3.313]],["name/2335",[1901,76.069]],["parent/2335",[1925,7.052]],["name/2336",[163,53.406]],["parent/2336",[1925,7.052]],["name/2337",[1690,76.069]],["parent/2337",[1925,7.052]],["name/2338",[1926,84.686]],["parent/2338",[1925,7.052]],["name/2339",[1927,79.491]],["parent/2339",[1925,7.052]],["name/2340",[1928,84.686]],["parent/2340",[1925,7.052]],["name/2341",[1929,79.491]],["parent/2341",[1925,7.052]],["name/2342",[1875,76.069]],["parent/2342",[1925,7.052]],["name/2343",[1799,68.319]],["parent/2343",[1925,7.052]],["name/2344",[1870,71.473]],["parent/2344",[1925,7.052]],["name/2345",[1871,76.069]],["parent/2345",[1925,7.052]],["name/2346",[1872,76.069]],["parent/2346",[1925,7.052]],["name/2347",[425,45.531]],["parent/2347",[1925,7.052]],["name/2348",[1902,76.069]],["parent/2348",[1925,7.052]],["name/2349",[1777,63.123]],["parent/2349",[1925,7.052]],["name/2350",[1778,65.914]],["parent/2350",[1925,7.052]],["name/2351",[1779,64.897]],["parent/2351",[1925,7.052]],["name/2352",[468,67.046]],["parent/2352",[1925,7.052]],["name/2353",[1903,76.069]],["parent/2353",[1925,7.052]],["name/2354",[1904,69.774]],["parent/2354",[1925,7.052]],["name/2355",[1754,68.319]],["parent/2355",[1925,7.052]],["name/2356",[1007,64.897]],["parent/2356",[1925,7.052]],["name/2357",[1905,73.514]],["parent/2357",[1925,7.052]],["name/2358",[1906,76.069]],["parent/2358",[1925,7.052]],["name/2359",[1907,76.069]],["parent/2359",[1925,7.052]],["name/2360",[1898,76.069]],["parent/2360",[1925,7.052]],["name/2361",[1908,76.069]],["parent/2361",[1925,7.052]],["name/2362",[1909,76.069]],["parent/2362",[1925,7.052]],["name/2363",[1910,76.069]],["parent/2363",[1925,7.052]],["name/2364",[1911,76.069]],["parent/2364",[1925,7.052]],["name/2365",[1912,76.069]],["parent/2365",[1925,7.052]],["name/2366",[1930,84.686]],["parent/2366",[291,3.313]],["name/2367",[18,47.256]],["parent/2367",[1931,11.117]],["name/2368",[1932,84.686]],["parent/2368",[291,3.313]],["name/2369",[18,47.256]],["parent/2369",[1933,11.117]],["name/2370",[1934,84.686]],["parent/2370",[291,3.313]],["name/2371",[189,39.191]],["parent/2371",[1935,9.382]],["name/2372",[1750,76.069]],["parent/2372",[1935,9.382]],["name/2373",[1936,76.069]],["parent/2373",[1935,9.382]],["name/2374",[1937,71.473]],["parent/2374",[1935,9.382]],["name/2375",[1938,73.514]],["parent/2375",[1935,9.382]],["name/2376",[1939,84.686]],["parent/2376",[291,3.313]],["name/2377",[1938,73.514]],["parent/2377",[1940,10.435]],["name/2378",[1941,79.491]],["parent/2378",[1940,10.435]],["name/2379",[1942,84.686]],["parent/2379",[291,3.313]],["name/2380",[1765,73.514]],["parent/2380",[1943,6.422]],["name/2381",[1944,76.069]],["parent/2381",[1943,6.422]],["name/2382",[1945,76.069]],["parent/2382",[1943,6.422]],["name/2383",[1946,76.069]],["parent/2383",[1943,6.422]],["name/2384",[1947,73.514]],["parent/2384",[1943,6.422]],["name/2385",[1948,76.069]],["parent/2385",[1943,6.422]],["name/2386",[1949,84.686]],["parent/2386",[1943,6.422]],["name/2387",[1950,84.686]],["parent/2387",[1943,6.422]],["name/2388",[1951,84.686]],["parent/2388",[1943,6.422]],["name/2389",[1952,84.686]],["parent/2389",[1943,6.422]],["name/2390",[1953,84.686]],["parent/2390",[1943,6.422]],["name/2391",[1954,84.686]],["parent/2391",[1943,6.422]],["name/2392",[1955,84.686]],["parent/2392",[1943,6.422]],["name/2393",[1956,84.686]],["parent/2393",[1943,6.422]],["name/2394",[650,68.319]],["parent/2394",[1943,6.422]],["name/2395",[1937,71.473]],["parent/2395",[1943,6.422]],["name/2396",[1957,76.069]],["parent/2396",[1943,6.422]],["name/2397",[1958,76.069]],["parent/2397",[1943,6.422]],["name/2398",[425,45.531]],["parent/2398",[1943,6.422]],["name/2399",[1959,73.514]],["parent/2399",[1943,6.422]],["name/2400",[163,53.406]],["parent/2400",[1943,6.422]],["name/2401",[1960,76.069]],["parent/2401",[1943,6.422]],["name/2402",[1270,69.774]],["parent/2402",[1943,6.422]],["name/2403",[1961,71.473]],["parent/2403",[1943,6.422]],["name/2404",[1962,76.069]],["parent/2404",[1943,6.422]],["name/2405",[1963,76.069]],["parent/2405",[1943,6.422]],["name/2406",[1964,76.069]],["parent/2406",[1943,6.422]],["name/2407",[1965,76.069]],["parent/2407",[1943,6.422]],["name/2408",[1966,76.069]],["parent/2408",[1943,6.422]],["name/2409",[1967,71.473]],["parent/2409",[1943,6.422]],["name/2410",[1968,73.514]],["parent/2410",[1943,6.422]],["name/2411",[1969,76.069]],["parent/2411",[1943,6.422]],["name/2412",[615,65.914]],["parent/2412",[1943,6.422]],["name/2413",[612,63.971]],["parent/2413",[1943,6.422]],["name/2414",[1310,67.046]],["parent/2414",[1943,6.422]],["name/2415",[1970,76.069]],["parent/2415",[1943,6.422]],["name/2416",[653,67.046]],["parent/2416",[1943,6.422]],["name/2417",[1971,71.473]],["parent/2417",[1943,6.422]],["name/2418",[1972,76.069]],["parent/2418",[1943,6.422]],["name/2419",[1973,76.069]],["parent/2419",[1943,6.422]],["name/2420",[1974,76.069]],["parent/2420",[1943,6.422]],["name/2421",[1975,76.069]],["parent/2421",[1943,6.422]],["name/2422",[1976,76.069]],["parent/2422",[1943,6.422]],["name/2423",[1977,76.069]],["parent/2423",[1943,6.422]],["name/2424",[1978,76.069]],["parent/2424",[1943,6.422]],["name/2425",[1979,76.069]],["parent/2425",[1943,6.422]],["name/2426",[729,73.514]],["parent/2426",[1943,6.422]],["name/2427",[1980,76.069]],["parent/2427",[1943,6.422]],["name/2428",[1981,76.069]],["parent/2428",[1943,6.422]],["name/2429",[1982,76.069]],["parent/2429",[1943,6.422]],["name/2430",[1983,84.686]],["parent/2430",[291,3.313]],["name/2431",[565,76.069]],["parent/2431",[1984,11.117]],["name/2432",[1985,84.686]],["parent/2432",[291,3.313]],["name/2433",[279,32.637]],["parent/2433",[1986,8.801]],["name/2434",[123,37.886]],["parent/2434",[1986,8.801]],["name/2435",[1936,76.069]],["parent/2435",[1986,8.801]],["name/2436",[1987,84.686]],["parent/2436",[1986,8.801]],["name/2437",[189,39.191]],["parent/2437",[1986,8.801]],["name/2438",[841,63.123]],["parent/2438",[1986,8.801]],["name/2439",[1988,84.686]],["parent/2439",[1986,8.801]],["name/2440",[1989,84.686]],["parent/2440",[1986,8.801]],["name/2441",[1990,84.686]],["parent/2441",[291,3.313]],["name/2442",[1991,84.686]],["parent/2442",[1992,8.801]],["name/2443",[1993,84.686]],["parent/2443",[1992,8.801]],["name/2444",[1994,84.686]],["parent/2444",[1992,8.801]],["name/2445",[1995,84.686]],["parent/2445",[1992,8.801]],["name/2446",[1996,84.686]],["parent/2446",[1992,8.801]],["name/2447",[1997,84.686]],["parent/2447",[1992,8.801]],["name/2448",[1998,84.686]],["parent/2448",[1992,8.801]],["name/2449",[1999,84.686]],["parent/2449",[1992,8.801]],["name/2450",[2000,84.686]],["parent/2450",[291,3.313]],["name/2451",[1884,79.491]],["parent/2451",[2001,8.398]],["name/2452",[2002,84.686]],["parent/2452",[2001,8.398]],["name/2453",[2003,84.686]],["parent/2453",[2001,8.398]],["name/2454",[2004,84.686]],["parent/2454",[2001,8.398]],["name/2455",[2005,84.686]],["parent/2455",[2001,8.398]],["name/2456",[2006,84.686]],["parent/2456",[2001,8.398]],["name/2457",[2007,84.686]],["parent/2457",[2001,8.398]],["name/2458",[2008,84.686]],["parent/2458",[2001,8.398]],["name/2459",[2009,84.686]],["parent/2459",[2001,8.398]],["name/2460",[831,79.491]],["parent/2460",[2001,8.398]],["name/2461",[2010,84.686]],["parent/2461",[2001,8.398]],["name/2462",[2011,84.686]],["parent/2462",[291,3.313]],["name/2463",[425,45.531]],["parent/2463",[2012,7.916]],["name/2464",[1877,79.491]],["parent/2464",[2012,7.916]],["name/2465",[1905,73.514]],["parent/2465",[2012,7.916]],["name/2466",[2013,84.686]],["parent/2466",[2012,7.916]],["name/2467",[1754,68.319]],["parent/2467",[2012,7.916]],["name/2468",[1904,69.774]],["parent/2468",[2012,7.916]],["name/2469",[1922,76.069]],["parent/2469",[2012,7.916]],["name/2470",[1777,63.123]],["parent/2470",[2012,7.916]],["name/2471",[1778,65.914]],["parent/2471",[2012,7.916]],["name/2472",[1779,64.897]],["parent/2472",[2012,7.916]],["name/2473",[468,67.046]],["parent/2473",[2012,7.916]],["name/2474",[2014,84.686]],["parent/2474",[2012,7.916]],["name/2475",[2015,84.686]],["parent/2475",[2012,7.916]],["name/2476",[2016,84.686]],["parent/2476",[2012,7.916]],["name/2477",[2017,84.686]],["parent/2477",[2012,7.916]],["name/2478",[2018,84.686]],["parent/2478",[2012,7.916]],["name/2479",[2019,84.686]],["parent/2479",[291,3.313]],["name/2480",[1927,79.491]],["parent/2480",[2020,8.286]],["name/2481",[1801,73.514]],["parent/2481",[2020,8.286]],["name/2482",[1799,68.319]],["parent/2482",[2020,8.286]],["name/2483",[1870,71.473]],["parent/2483",[2020,8.286]],["name/2484",[1871,76.069]],["parent/2484",[2020,8.286]],["name/2485",[2021,84.686]],["parent/2485",[2020,8.286]],["name/2486",[1875,76.069]],["parent/2486",[2020,8.286]],["name/2487",[1802,76.069]],["parent/2487",[2020,8.286]],["name/2488",[1872,76.069]],["parent/2488",[2020,8.286]],["name/2489",[163,53.406]],["parent/2489",[2020,8.286]],["name/2490",[425,45.531]],["parent/2490",[2020,8.286]],["name/2491",[2022,84.686]],["parent/2491",[2020,8.286]],["name/2492",[2023,84.686]],["parent/2492",[291,3.313]],["name/2493",[2024,84.686]],["parent/2493",[2025,9.65]],["name/2494",[2026,62.341]],["parent/2494",[2025,9.65]],["name/2495",[2027,62.341]],["parent/2495",[2025,9.65]],["name/2496",[587,60.3]],["parent/2496",[2025,9.65]],["name/2497",[2028,84.686]],["parent/2497",[291,3.313]],["name/2498",[2029,67.046]],["parent/2498",[2030,8.519]],["name/2499",[425,45.531]],["parent/2499",[2030,8.519]],["name/2500",[1244,60.3]],["parent/2500",[2030,8.519]],["name/2501",[1149,59.136]],["parent/2501",[2030,8.519]],["name/2502",[2031,67.046]],["parent/2502",[2030,8.519]],["name/2503",[2027,62.341]],["parent/2503",[2030,8.519]],["name/2504",[2026,62.341]],["parent/2504",[2030,8.519]],["name/2505",[587,60.3]],["parent/2505",[2030,8.519]],["name/2506",[2032,67.046]],["parent/2506",[2030,8.519]],["name/2507",[2033,67.046]],["parent/2507",[2030,8.519]],["name/2508",[2034,84.686]],["parent/2508",[291,3.313]],["name/2509",[425,45.531]],["parent/2509",[2035,8.519]],["name/2510",[2026,62.341]],["parent/2510",[2035,8.519]],["name/2511",[2027,62.341]],["parent/2511",[2035,8.519]],["name/2512",[2032,67.046]],["parent/2512",[2035,8.519]],["name/2513",[2029,67.046]],["parent/2513",[2035,8.519]],["name/2514",[1244,60.3]],["parent/2514",[2035,8.519]],["name/2515",[1149,59.136]],["parent/2515",[2035,8.519]],["name/2516",[2031,67.046]],["parent/2516",[2035,8.519]],["name/2517",[587,60.3]],["parent/2517",[2035,8.519]],["name/2518",[2033,67.046]],["parent/2518",[2035,8.519]],["name/2519",[2036,84.686]],["parent/2519",[291,3.313]],["name/2520",[2026,62.341]],["parent/2520",[2037,8.519]],["name/2521",[2027,62.341]],["parent/2521",[2037,8.519]],["name/2522",[2032,67.046]],["parent/2522",[2037,8.519]],["name/2523",[2029,67.046]],["parent/2523",[2037,8.519]],["name/2524",[425,45.531]],["parent/2524",[2037,8.519]],["name/2525",[1244,60.3]],["parent/2525",[2037,8.519]],["name/2526",[1149,59.136]],["parent/2526",[2037,8.519]],["name/2527",[2031,67.046]],["parent/2527",[2037,8.519]],["name/2528",[587,60.3]],["parent/2528",[2037,8.519]],["name/2529",[2033,67.046]],["parent/2529",[2037,8.519]],["name/2530",[2038,84.686]],["parent/2530",[291,3.313]],["name/2531",[2026,62.341]],["parent/2531",[2039,8.519]],["name/2532",[2027,62.341]],["parent/2532",[2039,8.519]],["name/2533",[2032,67.046]],["parent/2533",[2039,8.519]],["name/2534",[2029,67.046]],["parent/2534",[2039,8.519]],["name/2535",[425,45.531]],["parent/2535",[2039,8.519]],["name/2536",[1244,60.3]],["parent/2536",[2039,8.519]],["name/2537",[1149,59.136]],["parent/2537",[2039,8.519]],["name/2538",[2031,67.046]],["parent/2538",[2039,8.519]],["name/2539",[587,60.3]],["parent/2539",[2039,8.519]],["name/2540",[2033,67.046]],["parent/2540",[2039,8.519]],["name/2541",[2040,84.686]],["parent/2541",[291,3.313]],["name/2542",[425,45.531]],["parent/2542",[2041,8.519]],["name/2543",[2026,62.341]],["parent/2543",[2041,8.519]],["name/2544",[2027,62.341]],["parent/2544",[2041,8.519]],["name/2545",[2032,67.046]],["parent/2545",[2041,8.519]],["name/2546",[2029,67.046]],["parent/2546",[2041,8.519]],["name/2547",[1244,60.3]],["parent/2547",[2041,8.519]],["name/2548",[1149,59.136]],["parent/2548",[2041,8.519]],["name/2549",[2031,67.046]],["parent/2549",[2041,8.519]],["name/2550",[587,60.3]],["parent/2550",[2041,8.519]],["name/2551",[2033,67.046]],["parent/2551",[2041,8.519]],["name/2552",[2042,84.686]],["parent/2552",[291,3.313]],["name/2553",[425,45.531]],["parent/2553",[2043,8.519]],["name/2554",[2026,62.341]],["parent/2554",[2043,8.519]],["name/2555",[2027,62.341]],["parent/2555",[2043,8.519]],["name/2556",[2032,67.046]],["parent/2556",[2043,8.519]],["name/2557",[2029,67.046]],["parent/2557",[2043,8.519]],["name/2558",[1244,60.3]],["parent/2558",[2043,8.519]],["name/2559",[1149,59.136]],["parent/2559",[2043,8.519]],["name/2560",[2031,67.046]],["parent/2560",[2043,8.519]],["name/2561",[587,60.3]],["parent/2561",[2043,8.519]],["name/2562",[2033,67.046]],["parent/2562",[2043,8.519]],["name/2563",[2044,84.686]],["parent/2563",[291,3.313]],["name/2564",[2026,62.341]],["parent/2564",[2045,8.519]],["name/2565",[2027,62.341]],["parent/2565",[2045,8.519]],["name/2566",[2032,67.046]],["parent/2566",[2045,8.519]],["name/2567",[2029,67.046]],["parent/2567",[2045,8.519]],["name/2568",[425,45.531]],["parent/2568",[2045,8.519]],["name/2569",[1244,60.3]],["parent/2569",[2045,8.519]],["name/2570",[1149,59.136]],["parent/2570",[2045,8.519]],["name/2571",[2031,67.046]],["parent/2571",[2045,8.519]],["name/2572",[587,60.3]],["parent/2572",[2045,8.519]],["name/2573",[2033,67.046]],["parent/2573",[2045,8.519]],["name/2574",[2046,84.686]],["parent/2574",[291,3.313]],["name/2575",[2047,84.686]],["parent/2575",[2048,11.117]],["name/2576",[2049,84.686]],["parent/2576",[291,3.313]],["name/2577",[629,60.936]],["parent/2577",[2050,8.653]],["name/2578",[425,45.531]],["parent/2578",[2050,8.653]],["name/2579",[2051,76.069]],["parent/2579",[2050,8.653]],["name/2580",[745,64.897]],["parent/2580",[2050,8.653]],["name/2581",[1916,71.473]],["parent/2581",[2050,8.653]],["name/2582",[1777,63.123]],["parent/2582",[2050,8.653]],["name/2583",[1793,73.514]],["parent/2583",[2050,8.653]],["name/2584",[1792,73.514]],["parent/2584",[2050,8.653]],["name/2585",[2052,76.069]],["parent/2585",[2050,8.653]],["name/2586",[2053,84.686]],["parent/2586",[291,3.313]],["name/2587",[2054,79.491]],["parent/2587",[2055,9.159]],["name/2588",[612,63.971]],["parent/2588",[2055,9.159]],["name/2589",[2056,84.686]],["parent/2589",[2055,9.159]],["name/2590",[2057,84.686]],["parent/2590",[2055,9.159]],["name/2591",[2058,84.686]],["parent/2591",[2055,9.159]],["name/2592",[2059,84.686]],["parent/2592",[2055,9.159]],["name/2593",[2060,84.686]],["parent/2593",[291,3.313]],["name/2594",[2061,84.686]],["parent/2594",[2062,9.986]],["name/2595",[425,45.531]],["parent/2595",[2062,9.986]],["name/2596",[2063,73.514]],["parent/2596",[2062,9.986]],["name/2597",[2064,84.686]],["parent/2597",[291,3.313]],["name/2598",[629,60.936]],["parent/2598",[2065,8.653]],["name/2599",[425,45.531]],["parent/2599",[2065,8.653]],["name/2600",[1244,60.3]],["parent/2600",[2065,8.653]],["name/2601",[1149,59.136]],["parent/2601",[2065,8.653]],["name/2602",[2066,76.069]],["parent/2602",[2065,8.653]],["name/2603",[2027,62.341]],["parent/2603",[2065,8.653]],["name/2604",[2026,62.341]],["parent/2604",[2065,8.653]],["name/2605",[587,60.3]],["parent/2605",[2065,8.653]],["name/2606",[2067,76.069]],["parent/2606",[2065,8.653]],["name/2607",[2068,84.686]],["parent/2607",[291,3.313]],["name/2608",[2026,62.341]],["parent/2608",[2069,8.653]],["name/2609",[2027,62.341]],["parent/2609",[2069,8.653]],["name/2610",[2067,76.069]],["parent/2610",[2069,8.653]],["name/2611",[629,60.936]],["parent/2611",[2069,8.653]],["name/2612",[425,45.531]],["parent/2612",[2069,8.653]],["name/2613",[1244,60.3]],["parent/2613",[2069,8.653]],["name/2614",[1149,59.136]],["parent/2614",[2069,8.653]],["name/2615",[2066,76.069]],["parent/2615",[2069,8.653]],["name/2616",[587,60.3]],["parent/2616",[2069,8.653]],["name/2617",[2070,84.686]],["parent/2617",[291,3.313]],["name/2618",[2026,62.341]],["parent/2618",[2071,8.653]],["name/2619",[2027,62.341]],["parent/2619",[2071,8.653]],["name/2620",[2067,76.069]],["parent/2620",[2071,8.653]],["name/2621",[629,60.936]],["parent/2621",[2071,8.653]],["name/2622",[425,45.531]],["parent/2622",[2071,8.653]],["name/2623",[1244,60.3]],["parent/2623",[2071,8.653]],["name/2624",[1149,59.136]],["parent/2624",[2071,8.653]],["name/2625",[2066,76.069]],["parent/2625",[2071,8.653]],["name/2626",[587,60.3]],["parent/2626",[2071,8.653]],["name/2627",[2072,84.686]],["parent/2627",[291,3.313]],["name/2628",[2073,84.686]],["parent/2628",[2074,9.986]],["name/2629",[2075,84.686]],["parent/2629",[2074,9.986]],["name/2630",[2076,84.686]],["parent/2630",[2074,9.986]],["name/2631",[2077,84.686]],["parent/2631",[291,3.313]],["name/2632",[2078,84.686]],["parent/2632",[2079,9.65]],["name/2633",[2080,84.686]],["parent/2633",[2079,9.65]],["name/2634",[189,39.191]],["parent/2634",[2081,9.65]],["name/2635",[46,42.129]],["parent/2635",[2081,9.65]],["name/2636",[123,37.886]],["parent/2636",[2081,9.65]],["name/2637",[837,68.319]],["parent/2637",[2081,9.65]],["name/2638",[2082,84.686]],["parent/2638",[2079,9.65]],["name/2639",[189,39.191]],["parent/2639",[2083,9.159]],["name/2640",[46,42.129]],["parent/2640",[2083,9.159]],["name/2641",[830,58.092]],["parent/2641",[2083,9.159]],["name/2642",[191,49.763]],["parent/2642",[2083,9.159]],["name/2643",[123,37.886]],["parent/2643",[2083,9.159]],["name/2644",[837,68.319]],["parent/2644",[2083,9.159]],["name/2645",[2084,84.686]],["parent/2645",[2079,9.65]],["name/2646",[189,39.191]],["parent/2646",[2085,9.159]],["name/2647",[46,42.129]],["parent/2647",[2085,9.159]],["name/2648",[830,58.092]],["parent/2648",[2085,9.159]],["name/2649",[191,49.763]],["parent/2649",[2085,9.159]],["name/2650",[123,37.886]],["parent/2650",[2085,9.159]],["name/2651",[837,68.319]],["parent/2651",[2085,9.159]],["name/2652",[2086,84.686]],["parent/2652",[291,3.313]],["name/2653",[301,58.092]],["parent/2653",[2087,9.65]],["name/2654",[2088,79.491]],["parent/2654",[2087,9.65]],["name/2655",[2089,84.686]],["parent/2655",[2087,9.65]],["name/2656",[1270,69.774]],["parent/2656",[2087,9.65]],["name/2657",[2090,84.686]],["parent/2657",[291,3.313]],["name/2658",[210,79.491]],["parent/2658",[2091,8.968]],["name/2659",[2092,84.686]],["parent/2659",[2091,8.968]],["name/2660",[189,39.191]],["parent/2660",[2093,9.159]],["name/2661",[191,49.763]],["parent/2661",[2093,9.159]],["name/2662",[46,42.129]],["parent/2662",[2093,9.159]],["name/2663",[123,37.886]],["parent/2663",[2093,9.159]],["name/2664",[201,59.136]],["parent/2664",[2093,9.159]],["name/2665",[192,48.337]],["parent/2665",[2093,9.159]],["name/2666",[2094,84.686]],["parent/2666",[2091,8.968]],["name/2667",[189,39.191]],["parent/2667",[2095,9.159]],["name/2668",[191,49.763]],["parent/2668",[2095,9.159]],["name/2669",[46,42.129]],["parent/2669",[2095,9.159]],["name/2670",[123,37.886]],["parent/2670",[2095,9.159]],["name/2671",[201,59.136]],["parent/2671",[2095,9.159]],["name/2672",[192,48.337]],["parent/2672",[2095,9.159]],["name/2673",[2096,84.686]],["parent/2673",[2091,8.968]],["name/2674",[189,39.191]],["parent/2674",[2097,9.159]],["name/2675",[191,49.763]],["parent/2675",[2097,9.159]],["name/2676",[46,42.129]],["parent/2676",[2097,9.159]],["name/2677",[123,37.886]],["parent/2677",[2097,9.159]],["name/2678",[806,76.069]],["parent/2678",[2097,9.159]],["name/2679",[192,48.337]],["parent/2679",[2097,9.159]],["name/2680",[2098,84.686]],["parent/2680",[2091,8.968]],["name/2681",[189,39.191]],["parent/2681",[2099,9.159]],["name/2682",[191,49.763]],["parent/2682",[2099,9.159]],["name/2683",[46,42.129]],["parent/2683",[2099,9.159]],["name/2684",[123,37.886]],["parent/2684",[2099,9.159]],["name/2685",[806,76.069]],["parent/2685",[2099,9.159]],["name/2686",[192,48.337]],["parent/2686",[2099,9.159]],["name/2687",[2100,84.686]],["parent/2687",[2091,8.968]],["name/2688",[189,39.191]],["parent/2688",[2101,8.968]],["name/2689",[191,49.763]],["parent/2689",[2101,8.968]],["name/2690",[46,42.129]],["parent/2690",[2101,8.968]],["name/2691",[123,37.886]],["parent/2691",[2101,8.968]],["name/2692",[201,59.136]],["parent/2692",[2101,8.968]],["name/2693",[192,48.337]],["parent/2693",[2101,8.968]],["name/2694",[807,79.491]],["parent/2694",[2101,8.968]],["name/2695",[2102,84.686]],["parent/2695",[2091,8.968]],["name/2696",[189,39.191]],["parent/2696",[2103,9.159]],["name/2697",[191,49.763]],["parent/2697",[2103,9.159]],["name/2698",[46,42.129]],["parent/2698",[2103,9.159]],["name/2699",[123,37.886]],["parent/2699",[2103,9.159]],["name/2700",[201,59.136]],["parent/2700",[2103,9.159]],["name/2701",[192,48.337]],["parent/2701",[2103,9.159]],["name/2702",[2104,84.686]],["parent/2702",[291,3.313]],["name/2703",[629,60.936]],["parent/2703",[2105,8.653]],["name/2704",[425,45.531]],["parent/2704",[2105,8.653]],["name/2705",[1149,59.136]],["parent/2705",[2105,8.653]],["name/2706",[2106,84.686]],["parent/2706",[2105,8.653]],["name/2707",[1244,60.3]],["parent/2707",[2105,8.653]],["name/2708",[2027,62.341]],["parent/2708",[2105,8.653]],["name/2709",[2026,62.341]],["parent/2709",[2105,8.653]],["name/2710",[587,60.3]],["parent/2710",[2105,8.653]],["name/2711",[2107,84.686]],["parent/2711",[2105,8.653]],["name/2712",[2108,84.686]],["parent/2712",[291,3.313]],["name/2713",[2109,84.686]],["parent/2713",[2110,11.117]],["name/2714",[2111,84.686]],["parent/2714",[291,3.313]],["name/2715",[2112,84.686]],["parent/2715",[2113,9.159]],["name/2716",[2114,84.686]],["parent/2716",[2113,9.159]],["name/2717",[2115,84.686]],["parent/2717",[2113,9.159]],["name/2718",[2116,84.686]],["parent/2718",[2113,9.159]],["name/2719",[2117,84.686]],["parent/2719",[2113,9.159]],["name/2720",[2118,84.686]],["parent/2720",[2113,9.159]],["name/2721",[2119,84.686]],["parent/2721",[291,3.313]],["name/2722",[2120,84.686]],["parent/2722",[2121,7.011]],["name/2723",[1777,63.123]],["parent/2723",[2121,7.011]],["name/2724",[1778,65.914]],["parent/2724",[2121,7.011]],["name/2725",[1787,76.069]],["parent/2725",[2121,7.011]],["name/2726",[1440,76.069]],["parent/2726",[2121,7.011]],["name/2727",[415,40.51]],["parent/2727",[2121,7.011]],["name/2728",[2122,76.069]],["parent/2728",[2121,7.011]],["name/2729",[2123,84.686]],["parent/2729",[2121,7.011]],["name/2730",[1916,71.473]],["parent/2730",[2121,7.011]],["name/2731",[777,79.491]],["parent/2731",[2121,7.011]],["name/2732",[2124,84.686]],["parent/2732",[2121,7.011]],["name/2733",[1779,64.897]],["parent/2733",[2121,7.011]],["name/2734",[2125,84.686]],["parent/2734",[2121,7.011]],["name/2735",[769,79.491]],["parent/2735",[2121,7.011]],["name/2736",[2126,84.686]],["parent/2736",[2121,7.011]],["name/2737",[1841,76.069]],["parent/2737",[2121,7.011]],["name/2738",[1799,68.319]],["parent/2738",[2121,7.011]],["name/2739",[1870,71.473]],["parent/2739",[2121,7.011]],["name/2740",[1929,79.491]],["parent/2740",[2121,7.011]],["name/2741",[163,53.406]],["parent/2741",[2121,7.011]],["name/2742",[2127,84.686]],["parent/2742",[2121,7.011]],["name/2743",[2128,84.686]],["parent/2743",[2121,7.011]],["name/2744",[2129,84.686]],["parent/2744",[2121,7.011]],["name/2745",[2130,84.686]],["parent/2745",[2121,7.011]],["name/2746",[2131,84.686]],["parent/2746",[2121,7.011]],["name/2747",[2132,84.686]],["parent/2747",[2121,7.011]],["name/2748",[2133,84.686]],["parent/2748",[2121,7.011]],["name/2749",[2134,84.686]],["parent/2749",[2121,7.011]],["name/2750",[2135,84.686]],["parent/2750",[2121,7.011]],["name/2751",[2136,84.686]],["parent/2751",[2121,7.011]],["name/2752",[2137,84.686]],["parent/2752",[2121,7.011]],["name/2753",[2138,84.686]],["parent/2753",[2121,7.011]],["name/2754",[2139,84.686]],["parent/2754",[291,3.313]],["name/2755",[2140,84.686]],["parent/2755",[2141,10.435]],["name/2756",[2142,84.686]],["parent/2756",[2141,10.435]],["name/2757",[2143,84.686]],["parent/2757",[291,3.313]],["name/2758",[1168,71.473]],["parent/2758",[2144,7.837]],["name/2759",[2145,84.686]],["parent/2759",[2144,7.837]],["name/2760",[2146,84.686]],["parent/2760",[2144,7.837]],["name/2761",[1248,79.491]],["parent/2761",[2144,7.837]],["name/2762",[1249,79.491]],["parent/2762",[2144,7.837]],["name/2763",[1251,79.491]],["parent/2763",[2144,7.837]],["name/2764",[2147,84.686]],["parent/2764",[2144,7.837]],["name/2765",[2148,84.686]],["parent/2765",[2144,7.837]],["name/2766",[2149,84.686]],["parent/2766",[2144,7.837]],["name/2767",[1252,79.491]],["parent/2767",[2144,7.837]],["name/2768",[2150,84.686]],["parent/2768",[2144,7.837]],["name/2769",[2151,84.686]],["parent/2769",[2144,7.837]],["name/2770",[1244,60.3]],["parent/2770",[2144,7.837]],["name/2771",[1246,79.491]],["parent/2771",[2144,7.837]],["name/2772",[1247,76.069]],["parent/2772",[2144,7.837]],["name/2773",[1011,53.098]],["parent/2773",[2144,7.837]],["name/2774",[1250,73.514]],["parent/2774",[2144,7.837]],["name/2775",[2152,84.686]],["parent/2775",[291,3.313]],["name/2776",[1244,60.3]],["parent/2776",[2153,8.801]],["name/2777",[1247,76.069]],["parent/2777",[2153,8.801]],["name/2778",[1168,71.473]],["parent/2778",[2153,8.801]],["name/2779",[1250,73.514]],["parent/2779",[2153,8.801]],["name/2780",[1011,53.098]],["parent/2780",[2153,8.801]],["name/2781",[2154,84.686]],["parent/2781",[2153,8.801]],["name/2782",[2155,84.686]],["parent/2782",[2153,8.801]],["name/2783",[2156,84.686]],["parent/2783",[2153,8.801]],["name/2784",[2157,84.686]],["parent/2784",[291,3.313]],["name/2785",[2158,84.686]],["parent/2785",[2159,10.435]],["name/2786",[2160,84.686]],["parent/2786",[2159,10.435]],["name/2787",[2161,84.686]],["parent/2787",[291,3.313]],["name/2788",[745,64.897]],["parent/2788",[2162,9.986]],["name/2789",[2163,84.686]],["parent/2789",[2162,9.986]],["name/2790",[18,47.256]],["parent/2790",[2164,11.117]],["name/2791",[2165,84.686]],["parent/2791",[2162,9.986]],["name/2792",[2166,84.686]],["parent/2792",[291,3.313]],["name/2793",[587,60.3]],["parent/2793",[2167,9.382]],["name/2794",[2168,84.686]],["parent/2794",[2167,9.382]],["name/2795",[2169,84.686]],["parent/2795",[2167,9.382]],["name/2796",[2170,84.686]],["parent/2796",[2167,9.382]],["name/2797",[2171,84.686]],["parent/2797",[2167,9.382]],["name/2798",[2172,84.686]],["parent/2798",[291,3.313]],["name/2799",[2173,79.491]],["parent/2799",[2174,9.986]],["name/2800",[2175,84.686]],["parent/2800",[2174,9.986]],["name/2801",[18,47.256]],["parent/2801",[2176,11.117]],["name/2802",[2177,84.686]],["parent/2802",[2174,9.986]],["name/2803",[2178,84.686]],["parent/2803",[291,3.313]],["name/2804",[2179,84.686]],["parent/2804",[2180,9.65]],["name/2805",[2181,84.686]],["parent/2805",[2180,9.65]],["name/2806",[579,79.491]],["parent/2806",[2180,9.65]],["name/2807",[1016,73.514]],["parent/2807",[2180,9.65]],["name/2808",[2182,84.686]],["parent/2808",[291,3.313]],["name/2809",[2183,84.686]],["parent/2809",[2184,9.986]],["name/2810",[2185,84.686]],["parent/2810",[2184,9.986]],["name/2811",[2186,84.686]],["parent/2811",[2184,9.986]],["name/2812",[2187,84.686]],["parent/2812",[291,3.313]],["name/2813",[261,58.092]],["parent/2813",[2188,10.435]],["name/2814",[610,73.514]],["parent/2814",[2188,10.435]],["name/2815",[2189,84.686]],["parent/2815",[291,3.313]],["name/2816",[189,39.191]],["parent/2816",[2190,9.65]],["name/2817",[607,67.046]],["parent/2817",[2190,9.65]],["name/2818",[261,58.092]],["parent/2818",[2190,9.65]],["name/2819",[610,73.514]],["parent/2819",[2190,9.65]],["name/2820",[2191,84.686]],["parent/2820",[291,3.313]],["name/2821",[1269,76.069]],["parent/2821",[2192,9.65]],["name/2822",[61,79.491]],["parent/2822",[2192,9.65]],["name/2823",[2193,84.686]],["parent/2823",[2192,9.65]],["name/2824",[2194,76.069]],["parent/2824",[2192,9.65]],["name/2825",[2195,84.686]],["parent/2825",[291,3.313]],["name/2826",[2196,84.686]],["parent/2826",[2197,9.159]],["name/2827",[2198,84.686]],["parent/2827",[2197,9.159]],["name/2828",[2199,84.686]],["parent/2828",[2197,9.159]],["name/2829",[2200,84.686]],["parent/2829",[2197,9.159]],["name/2830",[63,61.614]],["parent/2830",[2197,9.159]],["name/2831",[2201,84.686]],["parent/2831",[2197,9.159]],["name/2832",[2202,84.686]],["parent/2832",[291,3.313]],["name/2833",[2203,84.686]],["parent/2833",[291,3.313]],["name/2834",[2204,84.686]],["parent/2834",[291,3.313]],["name/2835",[12,76.069]],["parent/2835",[2205,9.65]],["name/2836",[14,76.069]],["parent/2836",[2205,9.65]],["name/2837",[2206,84.686]],["parent/2837",[2205,9.65]],["name/2838",[2207,84.686]],["parent/2838",[2205,9.65]],["name/2839",[2208,84.686]],["parent/2839",[291,3.313]],["name/2840",[2209,84.686]],["parent/2840",[2210,11.117]],["name/2841",[2211,84.686]],["parent/2841",[291,3.313]],["name/2842",[2212,84.686]],["parent/2842",[2213,10.435]],["name/2843",[2214,84.686]],["parent/2843",[2213,10.435]],["name/2844",[2215,84.686]],["parent/2844",[291,3.313]],["name/2845",[2216,79.491]],["parent/2845",[2217,9.986]],["name/2846",[1755,71.473]],["parent/2846",[2217,9.986]],["name/2847",[2218,76.069]],["parent/2847",[2217,9.986]],["name/2848",[2219,84.686]],["parent/2848",[291,3.313]],["name/2849",[2220,84.686]],["parent/2849",[2221,7.562]],["name/2850",[2222,84.686]],["parent/2850",[2221,7.562]],["name/2851",[2223,84.686]],["parent/2851",[2221,7.562]],["name/2852",[2224,84.686]],["parent/2852",[2221,7.562]],["name/2853",[2225,84.686]],["parent/2853",[2221,7.562]],["name/2854",[2226,84.686]],["parent/2854",[2221,7.562]],["name/2855",[2227,84.686]],["parent/2855",[2221,7.562]],["name/2856",[2228,84.686]],["parent/2856",[2221,7.562]],["name/2857",[2229,84.686]],["parent/2857",[2221,7.562]],["name/2858",[425,45.531]],["parent/2858",[2221,7.562]],["name/2859",[2230,84.686]],["parent/2859",[2221,7.562]],["name/2860",[2216,79.491]],["parent/2860",[2221,7.562]],["name/2861",[680,67.046]],["parent/2861",[2221,7.562]],["name/2862",[308,63.971]],["parent/2862",[2221,7.562]],["name/2863",[309,64.897]],["parent/2863",[2221,7.562]],["name/2864",[681,67.046]],["parent/2864",[2221,7.562]],["name/2865",[311,64.897]],["parent/2865",[2221,7.562]],["name/2866",[312,64.897]],["parent/2866",[2221,7.562]],["name/2867",[310,63.971]],["parent/2867",[2221,7.562]],["name/2868",[279,32.637]],["parent/2868",[2221,7.562]],["name/2869",[189,39.191]],["parent/2869",[2221,7.562]],["name/2870",[2231,84.686]],["parent/2870",[291,3.313]],["name/2871",[1270,69.774]],["parent/2871",[2232,9.159]],["name/2872",[1269,76.069]],["parent/2872",[2232,9.159]],["name/2873",[2233,84.686]],["parent/2873",[2232,9.159]],["name/2874",[822,69.774]],["parent/2874",[2232,9.159]],["name/2875",[298,63.971]],["parent/2875",[2232,9.159]],["name/2876",[1271,73.514]],["parent/2876",[2232,9.159]],["name/2877",[2234,84.686]],["parent/2877",[291,3.313]],["name/2878",[2235,79.491]],["parent/2878",[2236,9.382]],["name/2879",[2194,76.069]],["parent/2879",[2236,9.382]],["name/2880",[822,69.774]],["parent/2880",[2236,9.382]],["name/2881",[298,63.971]],["parent/2881",[2236,9.382]],["name/2882",[1271,73.514]],["parent/2882",[2236,9.382]],["name/2883",[2237,84.686]],["parent/2883",[291,3.313]],["name/2884",[822,69.774]],["parent/2884",[2238,9.986]],["name/2885",[298,63.971]],["parent/2885",[2238,9.986]],["name/2886",[1271,73.514]],["parent/2886",[2238,9.986]],["name/2887",[2239,84.686]],["parent/2887",[291,3.313]],["name/2888",[2240,84.686]],["parent/2888",[2241,11.117]],["name/2889",[2242,84.686]],["parent/2889",[291,3.313]],["name/2890",[2235,79.491]],["parent/2890",[2243,9.986]],["name/2891",[2194,76.069]],["parent/2891",[2243,9.986]],["name/2892",[822,69.774]],["parent/2892",[2243,9.986]],["name/2893",[2244,84.686]],["parent/2893",[291,3.313]],["name/2894",[822,69.774]],["parent/2894",[2245,11.117]],["name/2895",[2246,84.686]],["parent/2895",[291,3.313]],["name/2896",[18,47.256]],["parent/2896",[2247,11.117]],["name/2897",[1257,73.514]],["parent/2897",[2248,11.117]],["name/2898",[2249,84.686]],["parent/2898",[291,3.313]],["name/2899",[18,47.256]],["parent/2899",[2250,11.117]],["name/2900",[1644,63.123]],["parent/2900",[2251,10.435]],["name/2901",[411,63.971]],["parent/2901",[2251,10.435]],["name/2902",[2252,84.686]],["parent/2902",[291,3.313]],["name/2903",[18,47.256]],["parent/2903",[2253,11.117]],["name/2904",[2254,84.686]],["parent/2904",[2255,10.435]],["name/2905",[251,62.341]],["parent/2905",[2255,10.435]],["name/2906",[2256,84.686]],["parent/2906",[291,3.313]],["name/2907",[2257,79.491]],["parent/2907",[2258,6.37]],["name/2908",[2259,84.686]],["parent/2908",[2258,6.37]],["name/2909",[2260,84.686]],["parent/2909",[2258,6.37]],["name/2910",[2261,84.686]],["parent/2910",[2258,6.37]],["name/2911",[2262,84.686]],["parent/2911",[2258,6.37]],["name/2912",[2263,84.686]],["parent/2912",[2258,6.37]],["name/2913",[2264,84.686]],["parent/2913",[2258,6.37]],["name/2914",[18,47.256]],["parent/2914",[2265,11.117]],["name/2915",[2266,84.686]],["parent/2915",[2258,6.37]],["name/2916",[2267,84.686]],["parent/2916",[2258,6.37]],["name/2917",[2268,84.686]],["parent/2917",[2258,6.37]],["name/2918",[2269,84.686]],["parent/2918",[2258,6.37]],["name/2919",[2270,84.686]],["parent/2919",[2258,6.37]],["name/2920",[2271,84.686]],["parent/2920",[2258,6.37]],["name/2921",[425,45.531]],["parent/2921",[2258,6.37]],["name/2922",[2272,84.686]],["parent/2922",[2258,6.37]],["name/2923",[2273,84.686]],["parent/2923",[2258,6.37]],["name/2924",[2274,84.686]],["parent/2924",[2258,6.37]],["name/2925",[2275,84.686]],["parent/2925",[2258,6.37]],["name/2926",[290,79.491]],["parent/2926",[2258,6.37]],["name/2927",[2276,84.686]],["parent/2927",[2258,6.37]],["name/2928",[2277,79.491]],["parent/2928",[2258,6.37]],["name/2929",[2278,84.686]],["parent/2929",[2258,6.37]],["name/2930",[2279,84.686]],["parent/2930",[2258,6.37]],["name/2931",[2280,84.686]],["parent/2931",[2258,6.37]],["name/2932",[2281,84.686]],["parent/2932",[2258,6.37]],["name/2933",[2282,84.686]],["parent/2933",[2258,6.37]],["name/2934",[2283,84.686]],["parent/2934",[2258,6.37]],["name/2935",[2284,84.686]],["parent/2935",[2258,6.37]],["name/2936",[2285,84.686]],["parent/2936",[2258,6.37]],["name/2937",[2286,84.686]],["parent/2937",[2258,6.37]],["name/2938",[2287,84.686]],["parent/2938",[2258,6.37]],["name/2939",[2288,84.686]],["parent/2939",[2258,6.37]],["name/2940",[2289,84.686]],["parent/2940",[2258,6.37]],["name/2941",[2290,84.686]],["parent/2941",[2258,6.37]],["name/2942",[2291,84.686]],["parent/2942",[2258,6.37]],["name/2943",[2292,84.686]],["parent/2943",[2258,6.37]],["name/2944",[2293,84.686]],["parent/2944",[2258,6.37]],["name/2945",[2294,84.686]],["parent/2945",[2258,6.37]],["name/2946",[2295,84.686]],["parent/2946",[2258,6.37]],["name/2947",[2296,84.686]],["parent/2947",[2258,6.37]],["name/2948",[1294,79.491]],["parent/2948",[2258,6.37]],["name/2949",[2297,84.686]],["parent/2949",[2258,6.37]],["name/2950",[2298,84.686]],["parent/2950",[2258,6.37]],["name/2951",[2299,84.686]],["parent/2951",[2258,6.37]],["name/2952",[2300,84.686]],["parent/2952",[2258,6.37]],["name/2953",[2301,84.686]],["parent/2953",[2258,6.37]],["name/2954",[2302,84.686]],["parent/2954",[2258,6.37]],["name/2955",[2303,84.686]],["parent/2955",[2258,6.37]],["name/2956",[2304,84.686]],["parent/2956",[2258,6.37]],["name/2957",[2305,84.686]],["parent/2957",[2258,6.37]],["name/2958",[1295,79.491]],["parent/2958",[2258,6.37]],["name/2959",[2173,79.491]],["parent/2959",[2258,6.37]],["name/2960",[2306,84.686]],["parent/2960",[291,3.313]],["name/2961",[2307,84.686]],["parent/2961",[2308,8.653]],["name/2962",[2309,84.686]],["parent/2962",[2308,8.653]],["name/2963",[425,45.531]],["parent/2963",[2308,8.653]],["name/2964",[2310,84.686]],["parent/2964",[2308,8.653]],["name/2965",[2311,84.686]],["parent/2965",[2308,8.653]],["name/2966",[2277,79.491]],["parent/2966",[2308,8.653]],["name/2967",[2312,84.686]],["parent/2967",[2308,8.653]],["name/2968",[2313,84.686]],["parent/2968",[2308,8.653]],["name/2969",[2314,84.686]],["parent/2969",[2308,8.653]],["name/2970",[2315,84.686]],["parent/2970",[291,3.313]],["name/2971",[2316,84.686]],["parent/2971",[2317,9.986]],["name/2972",[2318,84.686]],["parent/2972",[2317,9.986]],["name/2973",[2319,84.686]],["parent/2973",[2317,9.986]],["name/2974",[2320,84.686]],["parent/2974",[291,3.313]],["name/2975",[2321,84.686]],["parent/2975",[2322,7.052]],["name/2976",[2323,84.686]],["parent/2976",[2322,7.052]],["name/2977",[2324,84.686]],["parent/2977",[2322,7.052]],["name/2978",[2325,84.686]],["parent/2978",[2322,7.052]],["name/2979",[2326,84.686]],["parent/2979",[2322,7.052]],["name/2980",[2327,84.686]],["parent/2980",[2322,7.052]],["name/2981",[2328,84.686]],["parent/2981",[2322,7.052]],["name/2982",[1659,79.491]],["parent/2982",[2322,7.052]],["name/2983",[2329,84.686]],["parent/2983",[2322,7.052]],["name/2984",[1779,64.897]],["parent/2984",[2322,7.052]],["name/2985",[189,39.191]],["parent/2985",[2322,7.052]],["name/2986",[1961,71.473]],["parent/2986",[2322,7.052]],["name/2987",[597,69.774]],["parent/2987",[2322,7.052]],["name/2988",[249,79.491]],["parent/2988",[2322,7.052]],["name/2989",[2330,84.686]],["parent/2989",[2322,7.052]],["name/2990",[2331,84.686]],["parent/2990",[2322,7.052]],["name/2991",[2332,84.686]],["parent/2991",[2322,7.052]],["name/2992",[2333,84.686]],["parent/2992",[2322,7.052]],["name/2993",[1658,79.491]],["parent/2993",[2322,7.052]],["name/2994",[2334,84.686]],["parent/2994",[2322,7.052]],["name/2995",[695,79.491]],["parent/2995",[2322,7.052]],["name/2996",[2335,84.686]],["parent/2996",[2322,7.052]],["name/2997",[2336,84.686]],["parent/2997",[2322,7.052]],["name/2998",[2337,84.686]],["parent/2998",[2322,7.052]],["name/2999",[2338,84.686]],["parent/2999",[2322,7.052]],["name/3000",[2339,84.686]],["parent/3000",[2322,7.052]],["name/3001",[1922,76.069]],["parent/3001",[2322,7.052]],["name/3002",[2340,84.686]],["parent/3002",[2322,7.052]],["name/3003",[2341,84.686]],["parent/3003",[2322,7.052]],["name/3004",[2342,84.686]],["parent/3004",[2322,7.052]],["name/3005",[2343,84.686]],["parent/3005",[2322,7.052]],["name/3006",[2344,84.686]],["parent/3006",[291,3.313]],["name/3007",[448,64.897]],["parent/3007",[2345,7.335]],["name/3008",[1876,79.491]],["parent/3008",[2345,7.335]],["name/3009",[2257,79.491]],["parent/3009",[2345,7.335]],["name/3010",[1870,71.473]],["parent/3010",[2345,7.335]],["name/3011",[2346,84.686]],["parent/3011",[2345,7.335]],["name/3012",[2347,84.686]],["parent/3012",[2345,7.335]],["name/3013",[2348,84.686]],["parent/3013",[2345,7.335]],["name/3014",[1799,68.319]],["parent/3014",[2345,7.335]],["name/3015",[629,60.936]],["parent/3015",[2345,7.335]],["name/3016",[449,65.914]],["parent/3016",[2345,7.335]],["name/3017",[1779,64.897]],["parent/3017",[2345,7.335]],["name/3018",[2349,84.686]],["parent/3018",[2345,7.335]],["name/3019",[2350,84.686]],["parent/3019",[2345,7.335]],["name/3020",[1777,63.123]],["parent/3020",[2345,7.335]],["name/3021",[2351,84.686]],["parent/3021",[2345,7.335]],["name/3022",[2352,84.686]],["parent/3022",[2345,7.335]],["name/3023",[2353,84.686]],["parent/3023",[2345,7.335]],["name/3024",[467,79.491]],["parent/3024",[2345,7.335]],["name/3025",[2354,84.686]],["parent/3025",[2345,7.335]],["name/3026",[2355,84.686]],["parent/3026",[2345,7.335]],["name/3027",[1778,65.914]],["parent/3027",[2345,7.335]],["name/3028",[1780,79.491]],["parent/3028",[2345,7.335]],["name/3029",[745,64.897]],["parent/3029",[2345,7.335]],["name/3030",[2356,84.686]],["parent/3030",[2345,7.335]],["name/3031",[2357,79.491]],["parent/3031",[2345,7.335]],["name/3032",[2358,84.686]],["parent/3032",[291,3.313]],["name/3033",[2122,76.069]],["parent/3033",[2359,11.117]],["name/3034",[2360,84.686]],["parent/3034",[291,3.313]],["name/3035",[2361,84.686]],["parent/3035",[2362,10.435]],["name/3036",[2363,84.686]],["parent/3036",[2362,10.435]],["name/3037",[2364,84.686]],["parent/3037",[291,3.313]],["name/3038",[2365,84.686]],["parent/3038",[2366,10.435]],["name/3039",[2367,79.491]],["parent/3039",[2366,10.435]],["name/3040",[2368,84.686]],["parent/3040",[291,3.313]],["name/3041",[2369,84.686]],["parent/3041",[2370,9.986]],["name/3042",[2371,84.686]],["parent/3042",[2370,9.986]],["name/3043",[2372,84.686]],["parent/3043",[2370,9.986]],["name/3044",[2373,84.686]],["parent/3044",[291,3.313]],["name/3045",[2374,84.686]],["parent/3045",[2375,9.159]],["name/3046",[2376,84.686]],["parent/3046",[2375,9.159]],["name/3047",[2377,84.686]],["parent/3047",[2375,9.159]],["name/3048",[2378,84.686]],["parent/3048",[2375,9.159]],["name/3049",[2379,84.686]],["parent/3049",[2375,9.159]],["name/3050",[2380,84.686]],["parent/3050",[2375,9.159]],["name/3051",[2381,84.686]],["parent/3051",[291,3.313]],["name/3052",[2382,79.491]],["parent/3052",[2383,10.435]],["name/3053",[2384,79.491]],["parent/3053",[2383,10.435]],["name/3054",[2385,84.686]],["parent/3054",[291,3.313]],["name/3055",[2386,84.686]],["parent/3055",[2387,9.65]],["name/3056",[2388,84.686]],["parent/3056",[2387,9.65]],["name/3057",[2382,79.491]],["parent/3057",[2387,9.65]],["name/3058",[2384,79.491]],["parent/3058",[2387,9.65]],["name/3059",[2389,84.686]],["parent/3059",[291,3.313]],["name/3060",[2390,84.686]],["parent/3060",[2391,11.117]],["name/3061",[2392,84.686]],["parent/3061",[291,3.313]],["name/3062",[2393,79.491]],["parent/3062",[2394,11.117]],["name/3063",[2395,84.686]],["parent/3063",[291,3.313]],["name/3064",[448,64.897]],["parent/3064",[2396,9.382]],["name/3065",[449,65.914]],["parent/3065",[2396,9.382]],["name/3066",[2393,79.491]],["parent/3066",[2396,9.382]],["name/3067",[2397,84.686]],["parent/3067",[2396,9.382]],["name/3068",[2398,84.686]],["parent/3068",[2396,9.382]],["name/3069",[2399,84.686]],["parent/3069",[291,3.313]],["name/3070",[2400,84.686]],["parent/3070",[2401,10.435]],["name/3071",[2402,84.686]],["parent/3071",[2401,10.435]],["name/3072",[2403,84.686]],["parent/3072",[291,3.313]],["name/3073",[2404,84.686]],["parent/3073",[2405,10.435]],["name/3074",[2406,79.491]],["parent/3074",[2405,10.435]],["name/3075",[2407,84.686]],["parent/3075",[291,3.313]],["name/3076",[2408,84.686]],["parent/3076",[2409,8.184]],["name/3077",[2410,84.686]],["parent/3077",[2409,8.184]],["name/3078",[2411,84.686]],["parent/3078",[2409,8.184]],["name/3079",[2412,84.686]],["parent/3079",[2409,8.184]],["name/3080",[1947,73.514]],["parent/3080",[2409,8.184]],["name/3081",[609,73.514]],["parent/3081",[2409,8.184]],["name/3082",[2413,84.686]],["parent/3082",[2409,8.184]],["name/3083",[2414,84.686]],["parent/3083",[2409,8.184]],["name/3084",[2415,84.686]],["parent/3084",[2409,8.184]],["name/3085",[1968,73.514]],["parent/3085",[2409,8.184]],["name/3086",[2416,84.686]],["parent/3086",[2409,8.184]],["name/3087",[2417,84.686]],["parent/3087",[2409,8.184]],["name/3088",[2418,84.686]],["parent/3088",[2409,8.184]],["name/3089",[2419,84.686]],["parent/3089",[291,3.313]],["name/3090",[1957,76.069]],["parent/3090",[2420,6.117]],["name/3091",[1958,76.069]],["parent/3091",[2420,6.117]],["name/3092",[2421,84.686]],["parent/3092",[2420,6.117]],["name/3093",[2422,84.686]],["parent/3093",[2420,6.117]],["name/3094",[2423,84.686]],["parent/3094",[2420,6.117]],["name/3095",[2424,84.686]],["parent/3095",[2420,6.117]],["name/3096",[1244,60.3]],["parent/3096",[2420,6.117]],["name/3097",[2425,84.686]],["parent/3097",[2420,6.117]],["name/3098",[2426,84.686]],["parent/3098",[2420,6.117]],["name/3099",[2427,84.686]],["parent/3099",[2420,6.117]],["name/3100",[2428,84.686]],["parent/3100",[2420,6.117]],["name/3101",[2429,84.686]],["parent/3101",[2420,6.117]],["name/3102",[1149,59.136]],["parent/3102",[2420,6.117]],["name/3103",[425,45.531]],["parent/3103",[2420,6.117]],["name/3104",[1959,73.514]],["parent/3104",[2420,6.117]],["name/3105",[163,53.406]],["parent/3105",[2420,6.117]],["name/3106",[1960,76.069]],["parent/3106",[2420,6.117]],["name/3107",[1270,69.774]],["parent/3107",[2420,6.117]],["name/3108",[1961,71.473]],["parent/3108",[2420,6.117]],["name/3109",[1962,76.069]],["parent/3109",[2420,6.117]],["name/3110",[1963,76.069]],["parent/3110",[2420,6.117]],["name/3111",[1964,76.069]],["parent/3111",[2420,6.117]],["name/3112",[1965,76.069]],["parent/3112",[2420,6.117]],["name/3113",[1966,76.069]],["parent/3113",[2420,6.117]],["name/3114",[1967,71.473]],["parent/3114",[2420,6.117]],["name/3115",[1968,73.514]],["parent/3115",[2420,6.117]],["name/3116",[1969,76.069]],["parent/3116",[2420,6.117]],["name/3117",[615,65.914]],["parent/3117",[2420,6.117]],["name/3118",[612,63.971]],["parent/3118",[2420,6.117]],["name/3119",[1310,67.046]],["parent/3119",[2420,6.117]],["name/3120",[1970,76.069]],["parent/3120",[2420,6.117]],["name/3121",[653,67.046]],["parent/3121",[2420,6.117]],["name/3122",[1971,71.473]],["parent/3122",[2420,6.117]],["name/3123",[1972,76.069]],["parent/3123",[2420,6.117]],["name/3124",[1973,76.069]],["parent/3124",[2420,6.117]],["name/3125",[1974,76.069]],["parent/3125",[2420,6.117]],["name/3126",[1765,73.514]],["parent/3126",[2420,6.117]],["name/3127",[1944,76.069]],["parent/3127",[2420,6.117]],["name/3128",[1946,76.069]],["parent/3128",[2420,6.117]],["name/3129",[1947,73.514]],["parent/3129",[2420,6.117]],["name/3130",[1948,76.069]],["parent/3130",[2420,6.117]],["name/3131",[1945,76.069]],["parent/3131",[2420,6.117]],["name/3132",[1937,71.473]],["parent/3132",[2420,6.117]],["name/3133",[1975,76.069]],["parent/3133",[2420,6.117]],["name/3134",[1976,76.069]],["parent/3134",[2420,6.117]],["name/3135",[1977,76.069]],["parent/3135",[2420,6.117]],["name/3136",[1978,76.069]],["parent/3136",[2420,6.117]],["name/3137",[1979,76.069]],["parent/3137",[2420,6.117]],["name/3138",[729,73.514]],["parent/3138",[2420,6.117]],["name/3139",[1980,76.069]],["parent/3139",[2420,6.117]],["name/3140",[1981,76.069]],["parent/3140",[2420,6.117]],["name/3141",[1982,76.069]],["parent/3141",[2420,6.117]],["name/3142",[2430,84.686]],["parent/3142",[2420,6.117]],["name/3143",[2431,84.686]],["parent/3143",[2420,6.117]],["name/3144",[2432,84.686]],["parent/3144",[2420,6.117]],["name/3145",[2433,84.686]],["parent/3145",[2420,6.117]],["name/3146",[2434,84.686]],["parent/3146",[2420,6.117]],["name/3147",[2435,84.686]],["parent/3147",[2420,6.117]],["name/3148",[2436,84.686]],["parent/3148",[2420,6.117]],["name/3149",[2437,84.686]],["parent/3149",[2420,6.117]],["name/3150",[2438,84.686]],["parent/3150",[2420,6.117]],["name/3151",[2439,84.686]],["parent/3151",[2420,6.117]],["name/3152",[2440,84.686]],["parent/3152",[2420,6.117]],["name/3153",[2441,84.686]],["parent/3153",[291,3.313]],["name/3154",[2063,73.514]],["parent/3154",[2442,11.117]],["name/3155",[2443,84.686]],["parent/3155",[291,3.313]],["name/3156",[189,39.191]],["parent/3156",[2444,10.435]],["name/3157",[2445,84.686]],["parent/3157",[2444,10.435]],["name/3158",[2446,84.686]],["parent/3158",[291,3.313]],["name/3159",[1938,73.514]],["parent/3159",[2447,10.435]],["name/3160",[1941,79.491]],["parent/3160",[2447,10.435]],["name/3161",[2448,84.686]],["parent/3161",[291,3.313]],["name/3162",[189,39.191]],["parent/3162",[2449,9.382]],["name/3163",[1750,76.069]],["parent/3163",[2449,9.382]],["name/3164",[1936,76.069]],["parent/3164",[2449,9.382]],["name/3165",[1937,71.473]],["parent/3165",[2449,9.382]],["name/3166",[1938,73.514]],["parent/3166",[2449,9.382]],["name/3167",[2450,84.686]],["parent/3167",[291,3.313]],["name/3168",[1967,71.473]],["parent/3168",[2451,9.159]],["name/3169",[123,37.886]],["parent/3169",[2451,9.159]],["name/3170",[1755,71.473]],["parent/3170",[2451,9.159]],["name/3171",[2452,79.491]],["parent/3171",[2451,9.159]],["name/3172",[1959,73.514]],["parent/3172",[2451,9.159]],["name/3173",[1961,71.473]],["parent/3173",[2451,9.159]],["name/3174",[2453,84.686]],["parent/3174",[291,3.313]],["name/3175",[2406,79.491]],["parent/3175",[2454,9.986]],["name/3176",[1967,71.473]],["parent/3176",[2454,9.986]],["name/3177",[2455,84.686]],["parent/3177",[2454,9.986]],["name/3178",[2456,84.686]],["parent/3178",[291,3.313]],["name/3179",[841,63.123]],["parent/3179",[2457,9.159]],["name/3180",[189,39.191]],["parent/3180",[2457,9.159]],["name/3181",[123,37.886]],["parent/3181",[2457,9.159]],["name/3182",[2458,79.491]],["parent/3182",[2457,9.159]],["name/3183",[2459,73.514]],["parent/3183",[2457,9.159]],["name/3184",[2460,79.491]],["parent/3184",[2457,9.159]],["name/3185",[2461,84.686]],["parent/3185",[291,3.313]],["name/3186",[1657,73.514]],["parent/3186",[2462,8.968]],["name/3187",[841,63.123]],["parent/3187",[2462,8.968]],["name/3188",[189,39.191]],["parent/3188",[2462,8.968]],["name/3189",[123,37.886]],["parent/3189",[2462,8.968]],["name/3190",[2458,79.491]],["parent/3190",[2462,8.968]],["name/3191",[2459,73.514]],["parent/3191",[2462,8.968]],["name/3192",[2460,79.491]],["parent/3192",[2462,8.968]],["name/3193",[2463,84.686]],["parent/3193",[291,3.313]],["name/3194",[189,39.191]],["parent/3194",[2464,11.117]],["name/3195",[2465,84.686]],["parent/3195",[291,3.313]],["name/3196",[189,39.191]],["parent/3196",[2466,9.986]],["name/3197",[636,73.514]],["parent/3197",[2466,9.986]],["name/3198",[841,63.123]],["parent/3198",[2466,9.986]],["name/3199",[2467,84.686]],["parent/3199",[291,3.313]],["name/3200",[1657,73.514]],["parent/3200",[2468,9.65]],["name/3201",[189,39.191]],["parent/3201",[2468,9.65]],["name/3202",[636,73.514]],["parent/3202",[2468,9.65]],["name/3203",[841,63.123]],["parent/3203",[2468,9.65]],["name/3204",[2469,84.686]],["parent/3204",[291,3.313]],["name/3205",[189,39.191]],["parent/3205",[2470,9.986]],["name/3206",[841,63.123]],["parent/3206",[2470,9.986]],["name/3207",[2471,76.069]],["parent/3207",[2470,9.986]],["name/3208",[2472,84.686]],["parent/3208",[291,3.313]],["name/3209",[251,62.341]],["parent/3209",[2473,9.65]],["name/3210",[189,39.191]],["parent/3210",[2473,9.65]],["name/3211",[841,63.123]],["parent/3211",[2473,9.65]],["name/3212",[2471,76.069]],["parent/3212",[2473,9.65]],["name/3213",[2474,84.686]],["parent/3213",[291,3.313]],["name/3214",[2475,84.686]],["parent/3214",[2476,9.382]],["name/3215",[251,62.341]],["parent/3215",[2476,9.382]],["name/3216",[189,39.191]],["parent/3216",[2476,9.382]],["name/3217",[841,63.123]],["parent/3217",[2476,9.382]],["name/3218",[2471,76.069]],["parent/3218",[2476,9.382]],["name/3219",[2477,84.686]],["parent/3219",[291,3.313]],["name/3220",[607,67.046]],["parent/3220",[2478,9.986]],["name/3221",[279,32.637]],["parent/3221",[2478,9.986]],["name/3222",[2479,84.686]],["parent/3222",[2478,9.986]],["name/3223",[2480,84.686]],["parent/3223",[291,3.313]],["name/3224",[279,32.637]],["parent/3224",[2481,11.117]],["name/3225",[2482,84.686]],["parent/3225",[291,3.313]],["name/3226",[607,67.046]],["parent/3226",[2483,9.65]],["name/3227",[279,32.637]],["parent/3227",[2483,9.65]],["name/3228",[2484,84.686]],["parent/3228",[2483,9.65]],["name/3229",[841,63.123]],["parent/3229",[2483,9.65]],["name/3230",[2485,84.686]],["parent/3230",[291,3.313]],["name/3231",[607,67.046]],["parent/3231",[2486,9.986]],["name/3232",[279,32.637]],["parent/3232",[2486,9.986]],["name/3233",[841,63.123]],["parent/3233",[2486,9.986]],["name/3234",[2487,84.686]],["parent/3234",[291,3.313]],["name/3235",[279,32.637]],["parent/3235",[2488,11.117]],["name/3236",[2489,84.686]],["parent/3236",[291,3.313]],["name/3237",[46,42.129]],["parent/3237",[2490,9.382]],["name/3238",[189,39.191]],["parent/3238",[2490,9.382]],["name/3239",[2491,79.491]],["parent/3239",[2490,9.382]],["name/3240",[2492,84.686]],["parent/3240",[2490,9.382]],["name/3241",[2493,84.686]],["parent/3241",[2490,9.382]],["name/3242",[2494,84.686]],["parent/3242",[291,3.313]],["name/3243",[2495,84.686]],["parent/3243",[291,3.313]],["name/3244",[18,47.256]],["parent/3244",[2496,11.117]],["name/3245",[2497,84.686]],["parent/3245",[291,3.313]],["name/3246",[2498,84.686]],["parent/3246",[2499,9.65]],["name/3247",[2500,84.686]],["parent/3247",[2499,9.65]],["name/3248",[2501,84.686]],["parent/3248",[2499,9.65]],["name/3249",[2491,79.491]],["parent/3249",[2499,9.65]],["name/3250",[2502,84.686]],["parent/3250",[291,3.313]],["name/3251",[2503,84.686]],["parent/3251",[2504,9.65]],["name/3252",[2505,84.686]],["parent/3252",[2504,9.65]],["name/3253",[2506,84.686]],["parent/3253",[2504,9.65]],["name/3254",[841,63.123]],["parent/3254",[2504,9.65]],["name/3255",[2507,84.686]],["parent/3255",[291,3.313]],["name/3256",[2508,84.686]],["parent/3256",[2509,10.435]],["name/3257",[2510,84.686]],["parent/3257",[2509,10.435]],["name/3258",[2511,84.686]],["parent/3258",[291,3.313]],["name/3259",[2512,84.686]],["parent/3259",[2513,8.968]],["name/3260",[2514,84.686]],["parent/3260",[2513,8.968]],["name/3261",[1310,67.046]],["parent/3261",[2513,8.968]],["name/3262",[2515,84.686]],["parent/3262",[2513,8.968]],["name/3263",[2516,84.686]],["parent/3263",[2513,8.968]],["name/3264",[2517,84.686]],["parent/3264",[2513,8.968]],["name/3265",[2518,84.686]],["parent/3265",[2513,8.968]],["name/3266",[2519,84.686]],["parent/3266",[291,3.313]],["name/3267",[650,68.319]],["parent/3267",[2520,6.653]],["name/3268",[1765,73.514]],["parent/3268",[2520,6.653]],["name/3269",[1937,71.473]],["parent/3269",[2520,6.653]],["name/3270",[1944,76.069]],["parent/3270",[2520,6.653]],["name/3271",[1946,76.069]],["parent/3271",[2520,6.653]],["name/3272",[1947,73.514]],["parent/3272",[2520,6.653]],["name/3273",[1948,76.069]],["parent/3273",[2520,6.653]],["name/3274",[1945,76.069]],["parent/3274",[2520,6.653]],["name/3275",[1957,76.069]],["parent/3275",[2520,6.653]],["name/3276",[1958,76.069]],["parent/3276",[2520,6.653]],["name/3277",[425,45.531]],["parent/3277",[2520,6.653]],["name/3278",[1959,73.514]],["parent/3278",[2520,6.653]],["name/3279",[163,53.406]],["parent/3279",[2520,6.653]],["name/3280",[1960,76.069]],["parent/3280",[2520,6.653]],["name/3281",[1270,69.774]],["parent/3281",[2520,6.653]],["name/3282",[1961,71.473]],["parent/3282",[2520,6.653]],["name/3283",[1962,76.069]],["parent/3283",[2520,6.653]],["name/3284",[1963,76.069]],["parent/3284",[2520,6.653]],["name/3285",[1964,76.069]],["parent/3285",[2520,6.653]],["name/3286",[1965,76.069]],["parent/3286",[2520,6.653]],["name/3287",[1966,76.069]],["parent/3287",[2520,6.653]],["name/3288",[1967,71.473]],["parent/3288",[2520,6.653]],["name/3289",[1968,73.514]],["parent/3289",[2520,6.653]],["name/3290",[1969,76.069]],["parent/3290",[2520,6.653]],["name/3291",[615,65.914]],["parent/3291",[2520,6.653]],["name/3292",[612,63.971]],["parent/3292",[2520,6.653]],["name/3293",[1310,67.046]],["parent/3293",[2520,6.653]],["name/3294",[1970,76.069]],["parent/3294",[2520,6.653]],["name/3295",[653,67.046]],["parent/3295",[2520,6.653]],["name/3296",[1971,71.473]],["parent/3296",[2520,6.653]],["name/3297",[1972,76.069]],["parent/3297",[2520,6.653]],["name/3298",[1973,76.069]],["parent/3298",[2520,6.653]],["name/3299",[1974,76.069]],["parent/3299",[2520,6.653]],["name/3300",[1975,76.069]],["parent/3300",[2520,6.653]],["name/3301",[1976,76.069]],["parent/3301",[2520,6.653]],["name/3302",[1977,76.069]],["parent/3302",[2520,6.653]],["name/3303",[1978,76.069]],["parent/3303",[2520,6.653]],["name/3304",[1979,76.069]],["parent/3304",[2520,6.653]],["name/3305",[729,73.514]],["parent/3305",[2520,6.653]],["name/3306",[1980,76.069]],["parent/3306",[2520,6.653]],["name/3307",[1981,76.069]],["parent/3307",[2520,6.653]],["name/3308",[1982,76.069]],["parent/3308",[2520,6.653]],["name/3309",[2521,84.686]],["parent/3309",[291,3.313]],["name/3310",[2063,73.514]],["parent/3310",[2522,11.117]],["name/3311",[2523,84.686]],["parent/3311",[291,3.313]],["name/3312",[2524,84.686]],["parent/3312",[2525,9.159]],["name/3313",[2526,84.686]],["parent/3313",[2525,9.159]],["name/3314",[425,45.531]],["parent/3314",[2525,9.159]],["name/3315",[2063,73.514]],["parent/3315",[2525,9.159]],["name/3316",[2527,84.686]],["parent/3316",[2525,9.159]],["name/3317",[2452,79.491]],["parent/3317",[2525,9.159]],["name/3318",[2528,84.686]],["parent/3318",[291,3.313]],["name/3319",[257,52.508]],["parent/3319",[2529,8.968]],["name/3320",[2530,84.686]],["parent/3320",[2529,8.968]],["name/3321",[123,37.886]],["parent/3321",[2529,8.968]],["name/3322",[139,71.473]],["parent/3322",[2529,8.968]],["name/3323",[253,62.341]],["parent/3323",[2529,8.968]],["name/3324",[63,61.614]],["parent/3324",[2529,8.968]],["name/3325",[258,63.971]],["parent/3325",[2529,8.968]],["name/3326",[2531,84.686]],["parent/3326",[291,3.313]],["name/3327",[253,62.341]],["parent/3327",[2532,9.159]],["name/3328",[18,47.256]],["parent/3328",[2533,11.117]],["name/3329",[44,64.897]],["parent/3329",[2532,9.159]],["name/3330",[46,42.129]],["parent/3330",[2532,9.159]],["name/3331",[123,37.886]],["parent/3331",[2532,9.159]],["name/3332",[112,60.3]],["parent/3332",[2532,9.159]],["name/3333",[275,58.601]],["parent/3333",[2532,9.159]],["name/3334",[2534,84.686]],["parent/3334",[291,3.313]],["name/3335",[1011,53.098]],["parent/3335",[2535,11.117]],["name/3336",[2536,84.686]],["parent/3336",[291,3.313]],["name/3337",[1310,67.046]],["parent/3337",[2537,11.117]],["name/3338",[2538,84.686]],["parent/3338",[291,3.313]],["name/3339",[1011,53.098]],["parent/3339",[2539,11.117]],["name/3340",[2540,84.686]],["parent/3340",[291,3.313]],["name/3341",[1799,68.319]],["parent/3341",[2541,8.398]],["name/3342",[1801,73.514]],["parent/3342",[2541,8.398]],["name/3343",[1800,76.069]],["parent/3343",[2541,8.398]],["name/3344",[2542,84.686]],["parent/3344",[2541,8.398]],["name/3345",[425,45.531]],["parent/3345",[2541,8.398]],["name/3346",[1916,71.473]],["parent/3346",[2541,8.398]],["name/3347",[2051,76.069]],["parent/3347",[2541,8.398]],["name/3348",[1777,63.123]],["parent/3348",[2541,8.398]],["name/3349",[1793,73.514]],["parent/3349",[2541,8.398]],["name/3350",[1792,73.514]],["parent/3350",[2541,8.398]],["name/3351",[2052,76.069]],["parent/3351",[2541,8.398]],["name/3352",[2543,84.686]],["parent/3352",[291,3.313]],["name/3353",[2544,84.686]],["parent/3353",[2545,11.117]],["name/3354",[1904,69.774]],["parent/3354",[291,3.313]],["name/3355",[2051,76.069]],["parent/3355",[2546,8.968]],["name/3356",[425,45.531]],["parent/3356",[2546,8.968]],["name/3357",[1916,71.473]],["parent/3357",[2546,8.968]],["name/3358",[1777,63.123]],["parent/3358",[2546,8.968]],["name/3359",[1793,73.514]],["parent/3359",[2546,8.968]],["name/3360",[1792,73.514]],["parent/3360",[2546,8.968]],["name/3361",[2052,76.069]],["parent/3361",[2546,8.968]],["name/3362",[2547,84.686]],["parent/3362",[291,3.313]],["name/3363",[1346,79.491]],["parent/3363",[2548,9.159]],["name/3364",[425,45.531]],["parent/3364",[2548,9.159]],["name/3365",[415,40.51]],["parent/3365",[2548,9.159]],["name/3366",[122,56.704]],["parent/3366",[2548,9.159]],["name/3367",[574,68.319]],["parent/3367",[2548,9.159]],["name/3368",[440,68.319]],["parent/3368",[2548,9.159]],["name/3369",[2549,84.686]],["parent/3369",[291,3.313]],["name/3370",[2550,79.491]],["parent/3370",[2551,7.626]],["name/3371",[2552,79.491]],["parent/3371",[2551,7.626]],["name/3372",[1719,79.491]],["parent/3372",[2551,7.626]],["name/3373",[2553,79.491]],["parent/3373",[2551,7.626]],["name/3374",[2554,79.491]],["parent/3374",[2551,7.626]],["name/3375",[2555,84.686]],["parent/3375",[2551,7.626]],["name/3376",[2556,84.686]],["parent/3376",[2551,7.626]],["name/3377",[2557,84.686]],["parent/3377",[2551,7.626]],["name/3378",[2558,84.686]],["parent/3378",[2551,7.626]],["name/3379",[2559,84.686]],["parent/3379",[2551,7.626]],["name/3380",[2560,84.686]],["parent/3380",[2551,7.626]],["name/3381",[1798,76.069]],["parent/3381",[2551,7.626]],["name/3382",[2561,84.686]],["parent/3382",[2551,7.626]],["name/3383",[2562,84.686]],["parent/3383",[2551,7.626]],["name/3384",[2563,84.686]],["parent/3384",[2551,7.626]],["name/3385",[286,79.491]],["parent/3385",[2551,7.626]],["name/3386",[2564,84.686]],["parent/3386",[2551,7.626]],["name/3387",[2565,84.686]],["parent/3387",[2551,7.626]],["name/3388",[2566,84.686]],["parent/3388",[2551,7.626]],["name/3389",[2567,84.686]],["parent/3389",[2551,7.626]],["name/3390",[2568,84.686]],["parent/3390",[291,3.313]],["name/3391",[2550,79.491]],["parent/3391",[2569,7.916]],["name/3392",[2552,79.491]],["parent/3392",[2569,7.916]],["name/3393",[2570,84.686]],["parent/3393",[2569,7.916]],["name/3394",[2553,79.491]],["parent/3394",[2569,7.916]],["name/3395",[2554,79.491]],["parent/3395",[2569,7.916]],["name/3396",[629,60.936]],["parent/3396",[2569,7.916]],["name/3397",[745,64.897]],["parent/3397",[2569,7.916]],["name/3398",[2571,84.686]],["parent/3398",[2569,7.916]],["name/3399",[740,76.069]],["parent/3399",[2569,7.916]],["name/3400",[2572,84.686]],["parent/3400",[2569,7.916]],["name/3401",[724,79.491]],["parent/3401",[2569,7.916]],["name/3402",[2573,84.686]],["parent/3402",[2569,7.916]],["name/3403",[2357,79.491]],["parent/3403",[2569,7.916]],["name/3404",[2574,84.686]],["parent/3404",[2569,7.916]],["name/3405",[2575,84.686]],["parent/3405",[2569,7.916]],["name/3406",[2576,84.686]],["parent/3406",[2569,7.916]],["name/3407",[1755,71.473]],["parent/3407",[291,3.313]],["name/3408",[2577,84.686]],["parent/3408",[2578,7.234]],["name/3409",[2579,84.686]],["parent/3409",[2578,7.234]],["name/3410",[2580,84.686]],["parent/3410",[2578,7.234]],["name/3411",[2581,84.686]],["parent/3411",[2578,7.234]],["name/3412",[2582,84.686]],["parent/3412",[2578,7.234]],["name/3413",[2583,84.686]],["parent/3413",[2578,7.234]],["name/3414",[2584,84.686]],["parent/3414",[2578,7.234]],["name/3415",[2585,84.686]],["parent/3415",[2578,7.234]],["name/3416",[2586,84.686]],["parent/3416",[2578,7.234]],["name/3417",[420,79.491]],["parent/3417",[2578,7.234]],["name/3418",[2587,84.686]],["parent/3418",[2578,7.234]],["name/3419",[2588,84.686]],["parent/3419",[2578,7.234]],["name/3420",[2589,84.686]],["parent/3420",[2578,7.234]],["name/3421",[425,45.531]],["parent/3421",[2578,7.234]],["name/3422",[2590,84.686]],["parent/3422",[2578,7.234]],["name/3423",[403,65.914]],["parent/3423",[2578,7.234]],["name/3424",[409,76.069]],["parent/3424",[2578,7.234]],["name/3425",[410,76.069]],["parent/3425",[2578,7.234]],["name/3426",[411,63.971]],["parent/3426",[2578,7.234]],["name/3427",[412,76.069]],["parent/3427",[2578,7.234]],["name/3428",[413,67.046]],["parent/3428",[2578,7.234]],["name/3429",[414,76.069]],["parent/3429",[2578,7.234]],["name/3430",[2591,84.686]],["parent/3430",[2578,7.234]],["name/3431",[2592,84.686]],["parent/3431",[2578,7.234]],["name/3432",[2593,84.686]],["parent/3432",[2578,7.234]],["name/3433",[407,73.514]],["parent/3433",[2578,7.234]],["name/3434",[2594,84.686]],["parent/3434",[2578,7.234]],["name/3435",[2595,84.686]],["parent/3435",[291,3.313]],["name/3436",[1755,71.473]],["parent/3436",[2596,10.435]],["name/3437",[2218,76.069]],["parent/3437",[2596,10.435]],["name/3438",[2597,84.686]],["parent/3438",[291,3.313]],["name/3439",[1681,79.491]],["parent/3439",[2598,8.286]],["name/3440",[425,45.531]],["parent/3440",[2598,8.286]],["name/3441",[680,67.046]],["parent/3441",[2598,8.286]],["name/3442",[308,63.971]],["parent/3442",[2598,8.286]],["name/3443",[309,64.897]],["parent/3443",[2598,8.286]],["name/3444",[681,67.046]],["parent/3444",[2598,8.286]],["name/3445",[311,64.897]],["parent/3445",[2598,8.286]],["name/3446",[312,64.897]],["parent/3446",[2598,8.286]],["name/3447",[310,63.971]],["parent/3447",[2598,8.286]],["name/3448",[279,32.637]],["parent/3448",[2598,8.286]],["name/3449",[189,39.191]],["parent/3449",[2598,8.286]],["name/3450",[413,67.046]],["parent/3450",[2598,8.286]],["name/3451",[2599,84.686]],["parent/3451",[291,3.313]],["name/3452",[2600,84.686]],["parent/3452",[2601,11.117]],["name/3453",[2602,84.686]],["parent/3453",[291,3.313]],["name/3454",[189,39.191]],["parent/3454",[2603,9.65]],["name/3455",[46,42.129]],["parent/3455",[2603,9.65]],["name/3456",[123,37.886]],["parent/3456",[2603,9.65]],["name/3457",[837,68.319]],["parent/3457",[2603,9.65]],["name/3458",[2604,84.686]],["parent/3458",[291,3.313]],["name/3459",[189,39.191]],["parent/3459",[2605,8.653]],["name/3460",[191,49.763]],["parent/3460",[2605,8.653]],["name/3461",[123,37.886]],["parent/3461",[2605,8.653]],["name/3462",[830,58.092]],["parent/3462",[2605,8.653]],["name/3463",[46,42.129]],["parent/3463",[2605,8.653]],["name/3464",[301,58.092]],["parent/3464",[2605,8.653]],["name/3465",[838,63.971]],["parent/3465",[2605,8.653]],["name/3466",[235,59.136]],["parent/3466",[2605,8.653]],["name/3467",[835,59.136]],["parent/3467",[2605,8.653]],["name/3468",[2606,84.686]],["parent/3468",[291,3.313]],["name/3469",[189,39.191]],["parent/3469",[2607,8.968]],["name/3470",[123,37.886]],["parent/3470",[2607,8.968]],["name/3471",[301,58.092]],["parent/3471",[2607,8.968]],["name/3472",[830,58.092]],["parent/3472",[2607,8.968]],["name/3473",[46,42.129]],["parent/3473",[2607,8.968]],["name/3474",[235,59.136]],["parent/3474",[2607,8.968]],["name/3475",[835,59.136]],["parent/3475",[2607,8.968]],["name/3476",[2608,84.686]],["parent/3476",[291,3.313]],["name/3477",[189,39.191]],["parent/3477",[2609,9.159]],["name/3478",[123,37.886]],["parent/3478",[2609,9.159]],["name/3479",[301,58.092]],["parent/3479",[2609,9.159]],["name/3480",[830,58.092]],["parent/3480",[2609,9.159]],["name/3481",[46,42.129]],["parent/3481",[2609,9.159]],["name/3482",[835,59.136]],["parent/3482",[2609,9.159]],["name/3483",[2610,84.686]],["parent/3483",[291,3.313]],["name/3484",[189,39.191]],["parent/3484",[2611,9.159]],["name/3485",[123,37.886]],["parent/3485",[2611,9.159]],["name/3486",[301,58.092]],["parent/3486",[2611,9.159]],["name/3487",[830,58.092]],["parent/3487",[2611,9.159]],["name/3488",[46,42.129]],["parent/3488",[2611,9.159]],["name/3489",[835,59.136]],["parent/3489",[2611,9.159]],["name/3490",[2612,84.686]],["parent/3490",[291,3.313]],["name/3491",[189,39.191]],["parent/3491",[2613,8.968]],["name/3492",[123,37.886]],["parent/3492",[2613,8.968]],["name/3493",[301,58.092]],["parent/3493",[2613,8.968]],["name/3494",[830,58.092]],["parent/3494",[2613,8.968]],["name/3495",[46,42.129]],["parent/3495",[2613,8.968]],["name/3496",[235,59.136]],["parent/3496",[2613,8.968]],["name/3497",[835,59.136]],["parent/3497",[2613,8.968]],["name/3498",[2614,84.686]],["parent/3498",[291,3.313]],["name/3499",[189,39.191]],["parent/3499",[2615,8.801]],["name/3500",[123,37.886]],["parent/3500",[2615,8.801]],["name/3501",[301,58.092]],["parent/3501",[2615,8.801]],["name/3502",[830,58.092]],["parent/3502",[2615,8.801]],["name/3503",[46,42.129]],["parent/3503",[2615,8.801]],["name/3504",[838,63.971]],["parent/3504",[2615,8.801]],["name/3505",[235,59.136]],["parent/3505",[2615,8.801]],["name/3506",[835,59.136]],["parent/3506",[2615,8.801]],["name/3507",[2616,84.686]],["parent/3507",[291,3.313]],["name/3508",[189,39.191]],["parent/3508",[2617,8.968]],["name/3509",[123,37.886]],["parent/3509",[2617,8.968]],["name/3510",[301,58.092]],["parent/3510",[2617,8.968]],["name/3511",[830,58.092]],["parent/3511",[2617,8.968]],["name/3512",[46,42.129]],["parent/3512",[2617,8.968]],["name/3513",[235,59.136]],["parent/3513",[2617,8.968]],["name/3514",[835,59.136]],["parent/3514",[2617,8.968]],["name/3515",[2618,84.686]],["parent/3515",[291,3.313]],["name/3516",[189,39.191]],["parent/3516",[2619,8.801]],["name/3517",[123,37.886]],["parent/3517",[2619,8.801]],["name/3518",[301,58.092]],["parent/3518",[2619,8.801]],["name/3519",[830,58.092]],["parent/3519",[2619,8.801]],["name/3520",[46,42.129]],["parent/3520",[2619,8.801]],["name/3521",[838,63.971]],["parent/3521",[2619,8.801]],["name/3522",[235,59.136]],["parent/3522",[2619,8.801]],["name/3523",[835,59.136]],["parent/3523",[2619,8.801]],["name/3524",[2620,84.686]],["parent/3524",[291,3.313]],["name/3525",[189,39.191]],["parent/3525",[2621,8.801]],["name/3526",[191,49.763]],["parent/3526",[2621,8.801]],["name/3527",[123,37.886]],["parent/3527",[2621,8.801]],["name/3528",[301,58.092]],["parent/3528",[2621,8.801]],["name/3529",[830,58.092]],["parent/3529",[2621,8.801]],["name/3530",[46,42.129]],["parent/3530",[2621,8.801]],["name/3531",[235,59.136]],["parent/3531",[2621,8.801]],["name/3532",[835,59.136]],["parent/3532",[2621,8.801]],["name/3533",[2622,84.686]],["parent/3533",[291,3.313]],["name/3534",[189,39.191]],["parent/3534",[2623,8.968]],["name/3535",[191,49.763]],["parent/3535",[2623,8.968]],["name/3536",[123,37.886]],["parent/3536",[2623,8.968]],["name/3537",[301,58.092]],["parent/3537",[2623,8.968]],["name/3538",[830,58.092]],["parent/3538",[2623,8.968]],["name/3539",[46,42.129]],["parent/3539",[2623,8.968]],["name/3540",[835,59.136]],["parent/3540",[2623,8.968]],["name/3541",[2624,84.686]],["parent/3541",[291,3.313]],["name/3542",[189,39.191]],["parent/3542",[2625,8.653]],["name/3543",[191,49.763]],["parent/3543",[2625,8.653]],["name/3544",[123,37.886]],["parent/3544",[2625,8.653]],["name/3545",[830,58.092]],["parent/3545",[2625,8.653]],["name/3546",[46,42.129]],["parent/3546",[2625,8.653]],["name/3547",[301,58.092]],["parent/3547",[2625,8.653]],["name/3548",[838,63.971]],["parent/3548",[2625,8.653]],["name/3549",[235,59.136]],["parent/3549",[2625,8.653]],["name/3550",[835,59.136]],["parent/3550",[2625,8.653]],["name/3551",[2626,84.686]],["parent/3551",[291,3.313]],["name/3552",[448,64.897]],["parent/3552",[2627,9.65]],["name/3553",[1435,79.491]],["parent/3553",[2627,9.65]],["name/3554",[449,65.914]],["parent/3554",[2627,9.65]],["name/3555",[1440,76.069]],["parent/3555",[2627,9.65]],["name/3556",[2628,84.686]],["parent/3556",[291,3.313]],["name/3557",[2629,84.686]],["parent/3557",[291,3.313]],["name/3558",[2630,84.686]],["parent/3558",[291,3.313]],["name/3559",[2631,84.686]],["parent/3559",[291,3.313]],["name/3560",[2632,84.686]],["parent/3560",[291,3.313]],["name/3561",[2633,84.686]],["parent/3561",[291,3.313]],["name/3562",[2634,84.686]],["parent/3562",[291,3.313]],["name/3563",[2635,84.686]],["parent/3563",[291,3.313]],["name/3564",[2636,84.686]],["parent/3564",[2637,11.117]],["name/3565",[2638,84.686]],["parent/3565",[291,3.313]],["name/3566",[2639,84.686]],["parent/3566",[291,3.313]],["name/3567",[1971,71.473]],["parent/3567",[291,3.313]],["name/3568",[2640,84.686]],["parent/3568",[291,3.313]],["name/3569",[2054,79.491]],["parent/3569",[2641,8.519]],["name/3570",[2642,84.686]],["parent/3570",[2641,8.519]],["name/3571",[668,79.491]],["parent/3571",[2641,8.519]],["name/3572",[1011,53.098]],["parent/3572",[2641,8.519]],["name/3573",[2643,84.686]],["parent/3573",[2641,8.519]],["name/3574",[2644,84.686]],["parent/3574",[2641,8.519]],["name/3575",[2645,84.686]],["parent/3575",[2641,8.519]],["name/3576",[2646,84.686]],["parent/3576",[2641,8.519]],["name/3577",[2647,84.686]],["parent/3577",[2641,8.519]],["name/3578",[2648,84.686]],["parent/3578",[2641,8.519]],["name/3579",[2649,84.686]],["parent/3579",[291,3.313]],["name/3580",[1011,53.098]],["parent/3580",[2650,11.117]],["name/3581",[2651,84.686]],["parent/3581",[291,3.313]],["name/3582",[1254,69.774]],["parent/3582",[2652,9.382]],["name/3583",[1011,53.098]],["parent/3583",[2652,9.382]],["name/3584",[1094,76.069]],["parent/3584",[2652,9.382]],["name/3585",[2653,84.686]],["parent/3585",[2652,9.382]],["name/3586",[2654,84.686]],["parent/3586",[2652,9.382]],["name/3587",[2655,84.686]],["parent/3587",[291,3.313]],["name/3588",[1254,69.774]],["parent/3588",[2656,9.159]],["name/3589",[2657,84.686]],["parent/3589",[2656,9.159]],["name/3590",[1011,53.098]],["parent/3590",[2656,9.159]],["name/3591",[2658,84.686]],["parent/3591",[2656,9.159]],["name/3592",[2659,84.686]],["parent/3592",[2656,9.159]],["name/3593",[2660,84.686]],["parent/3593",[2656,9.159]],["name/3594",[2661,84.686]],["parent/3594",[291,3.313]],["name/3595",[1011,53.098]],["parent/3595",[2662,11.117]],["name/3596",[2663,84.686]],["parent/3596",[291,3.313]],["name/3597",[1011,53.098]],["parent/3597",[2664,10.435]],["name/3598",[587,60.3]],["parent/3598",[2664,10.435]],["name/3599",[2665,79.491]],["parent/3599",[291,3.313]],["name/3600",[2666,84.686]],["parent/3600",[2667,8.184]],["name/3601",[2668,84.686]],["parent/3601",[2667,8.184]],["name/3602",[2669,84.686]],["parent/3602",[2667,8.184]],["name/3603",[2367,79.491]],["parent/3603",[2667,8.184]],["name/3604",[2670,84.686]],["parent/3604",[2667,8.184]],["name/3605",[2671,84.686]],["parent/3605",[2667,8.184]],["name/3606",[2672,84.686]],["parent/3606",[2667,8.184]],["name/3607",[2673,84.686]],["parent/3607",[2667,8.184]],["name/3608",[2674,84.686]],["parent/3608",[2667,8.184]],["name/3609",[2675,84.686]],["parent/3609",[2667,8.184]],["name/3610",[2676,84.686]],["parent/3610",[2667,8.184]],["name/3611",[2677,84.686]],["parent/3611",[2667,8.184]],["name/3612",[2678,84.686]],["parent/3612",[2667,8.184]],["name/3613",[2679,84.686]],["parent/3613",[291,3.313]],["name/3614",[2665,79.491]],["parent/3614",[2680,9.986]],["name/3615",[2681,84.686]],["parent/3615",[2680,9.986]],["name/3616",[2682,84.686]],["parent/3616",[2680,9.986]],["name/3617",[2683,84.686]],["parent/3617",[291,3.313]],["name/3618",[2684,84.686]],["parent/3618",[291,3.313]],["name/3619",[2685,84.686]],["parent/3619",[2686,9.986]],["name/3620",[2687,84.686]],["parent/3620",[2686,9.986]],["name/3621",[2688,84.686]],["parent/3621",[2686,9.986]],["name/3622",[2689,84.686]],["parent/3622",[291,3.313]],["name/3623",[2690,84.686]],["parent/3623",[2691,11.117]],["name/3624",[2692,84.686]],["parent/3624",[291,3.313]],["name/3625",[2693,84.686]],["parent/3625",[2694,7.999]],["name/3626",[589,79.491]],["parent/3626",[2694,7.999]],["name/3627",[2695,84.686]],["parent/3627",[2694,7.999]],["name/3628",[2696,84.686]],["parent/3628",[2694,7.999]],["name/3629",[2697,84.686]],["parent/3629",[2694,7.999]],["name/3630",[2698,84.686]],["parent/3630",[2694,7.999]],["name/3631",[2699,84.686]],["parent/3631",[2694,7.999]],["name/3632",[2700,84.686]],["parent/3632",[2694,7.999]],["name/3633",[2701,84.686]],["parent/3633",[2694,7.999]],["name/3634",[2702,84.686]],["parent/3634",[2694,7.999]],["name/3635",[2703,84.686]],["parent/3635",[2694,7.999]],["name/3636",[2704,84.686]],["parent/3636",[2694,7.999]],["name/3637",[2705,84.686]],["parent/3637",[2694,7.999]],["name/3638",[2706,84.686]],["parent/3638",[2694,7.999]],["name/3639",[2707,84.686]],["parent/3639",[2694,7.999]],["name/3640",[2708,84.686]],["parent/3640",[291,3.313]],["name/3641",[1011,53.098]],["parent/3641",[2709,9.986]],["name/3642",[2710,84.686]],["parent/3642",[2709,9.986]],["name/3643",[2711,84.686]],["parent/3643",[2709,9.986]],["name/3644",[2712,84.686]],["parent/3644",[291,3.313]],["name/3645",[1011,53.098]],["parent/3645",[2713,11.117]],["name/3646",[2714,84.686]],["parent/3646",[291,3.313]],["name/3647",[1254,69.774]],["parent/3647",[2715,9.986]],["name/3648",[1011,53.098]],["parent/3648",[2715,9.986]],["name/3649",[2716,84.686]],["parent/3649",[2715,9.986]],["name/3650",[2717,84.686]],["parent/3650",[291,3.313]],["name/3651",[1011,53.098]],["parent/3651",[2718,11.117]],["name/3652",[2719,84.686]],["parent/3652",[291,3.313]],["name/3653",[1011,53.098]],["parent/3653",[2720,11.117]],["name/3654",[2721,84.686]],["parent/3654",[291,3.313]],["name/3655",[1011,53.098]],["parent/3655",[2722,11.117]],["name/3656",[2723,84.686]],["parent/3656",[291,3.313]],["name/3657",[2724,84.686]],["parent/3657",[2725,8.801]],["name/3658",[2726,84.686]],["parent/3658",[2725,8.801]],["name/3659",[448,64.897]],["parent/3659",[2725,8.801]],["name/3660",[2727,84.686]],["parent/3660",[2725,8.801]],["name/3661",[2728,84.686]],["parent/3661",[2725,8.801]],["name/3662",[818,76.069]],["parent/3662",[2725,8.801]],["name/3663",[425,45.531]],["parent/3663",[2725,8.801]],["name/3664",[2729,84.686]],["parent/3664",[2725,8.801]],["name/3665",[2730,84.686]],["parent/3665",[291,3.313]],["name/3666",[189,39.191]],["parent/3666",[2731,8.801]],["name/3667",[123,37.886]],["parent/3667",[2731,8.801]],["name/3668",[830,58.092]],["parent/3668",[2731,8.801]],["name/3669",[46,42.129]],["parent/3669",[2731,8.801]],["name/3670",[301,58.092]],["parent/3670",[2731,8.801]],["name/3671",[838,63.971]],["parent/3671",[2731,8.801]],["name/3672",[235,59.136]],["parent/3672",[2731,8.801]],["name/3673",[835,59.136]],["parent/3673",[2731,8.801]],["name/3674",[2732,84.686]],["parent/3674",[291,3.313]],["name/3675",[2733,84.686]],["parent/3675",[291,3.313]],["name/3676",[415,40.51]],["parent/3676",[2734,10.435]],["name/3677",[1011,53.098]],["parent/3677",[2734,10.435]],["name/3678",[2735,84.686]],["parent/3678",[291,3.313]],["name/3679",[189,39.191]],["parent/3679",[2736,8.801]],["name/3680",[123,37.886]],["parent/3680",[2736,8.801]],["name/3681",[191,49.763]],["parent/3681",[2736,8.801]],["name/3682",[830,58.092]],["parent/3682",[2736,8.801]],["name/3683",[46,42.129]],["parent/3683",[2736,8.801]],["name/3684",[301,58.092]],["parent/3684",[2736,8.801]],["name/3685",[838,63.971]],["parent/3685",[2736,8.801]],["name/3686",[835,59.136]],["parent/3686",[2736,8.801]],["name/3687",[2737,84.686]],["parent/3687",[291,3.313]],["name/3688",[415,40.51]],["parent/3688",[2738,10.435]],["name/3689",[1011,53.098]],["parent/3689",[2738,10.435]],["name/3690",[2739,84.686]],["parent/3690",[291,3.313]],["name/3691",[189,39.191]],["parent/3691",[2740,8.968]],["name/3692",[123,37.886]],["parent/3692",[2740,8.968]],["name/3693",[830,58.092]],["parent/3693",[2740,8.968]],["name/3694",[46,42.129]],["parent/3694",[2740,8.968]],["name/3695",[301,58.092]],["parent/3695",[2740,8.968]],["name/3696",[838,63.971]],["parent/3696",[2740,8.968]],["name/3697",[835,59.136]],["parent/3697",[2740,8.968]],["name/3698",[2741,84.686]],["parent/3698",[291,3.313]],["name/3699",[415,40.51]],["parent/3699",[2742,9.986]],["name/3700",[1011,53.098]],["parent/3700",[2742,9.986]],["name/3701",[2743,84.686]],["parent/3701",[2742,9.986]],["name/3702",[2744,84.686]],["parent/3702",[291,3.313]],["name/3703",[189,39.191]],["parent/3703",[2745,8.801]],["name/3704",[123,37.886]],["parent/3704",[2745,8.801]],["name/3705",[830,58.092]],["parent/3705",[2745,8.801]],["name/3706",[46,42.129]],["parent/3706",[2745,8.801]],["name/3707",[301,58.092]],["parent/3707",[2745,8.801]],["name/3708",[838,63.971]],["parent/3708",[2745,8.801]],["name/3709",[235,59.136]],["parent/3709",[2745,8.801]],["name/3710",[835,59.136]],["parent/3710",[2745,8.801]],["name/3711",[2746,84.686]],["parent/3711",[291,3.313]],["name/3712",[415,40.51]],["parent/3712",[2747,10.435]],["name/3713",[1011,53.098]],["parent/3713",[2747,10.435]],["name/3714",[2748,84.686]],["parent/3714",[291,3.313]],["name/3715",[189,39.191]],["parent/3715",[2749,8.801]],["name/3716",[123,37.886]],["parent/3716",[2749,8.801]],["name/3717",[830,58.092]],["parent/3717",[2749,8.801]],["name/3718",[46,42.129]],["parent/3718",[2749,8.801]],["name/3719",[301,58.092]],["parent/3719",[2749,8.801]],["name/3720",[838,63.971]],["parent/3720",[2749,8.801]],["name/3721",[235,59.136]],["parent/3721",[2749,8.801]],["name/3722",[835,59.136]],["parent/3722",[2749,8.801]],["name/3723",[2750,84.686]],["parent/3723",[291,3.313]],["name/3724",[1405,73.514]],["parent/3724",[2751,9.986]],["name/3725",[1011,53.098]],["parent/3725",[2751,9.986]],["name/3726",[2752,84.686]],["parent/3726",[2751,9.986]],["name/3727",[2753,84.686]],["parent/3727",[291,3.313]],["name/3728",[425,45.531]],["parent/3728",[2754,8.519]],["name/3729",[680,67.046]],["parent/3729",[2754,8.519]],["name/3730",[308,63.971]],["parent/3730",[2754,8.519]],["name/3731",[309,64.897]],["parent/3731",[2754,8.519]],["name/3732",[681,67.046]],["parent/3732",[2754,8.519]],["name/3733",[311,64.897]],["parent/3733",[2754,8.519]],["name/3734",[312,64.897]],["parent/3734",[2754,8.519]],["name/3735",[310,63.971]],["parent/3735",[2754,8.519]],["name/3736",[279,32.637]],["parent/3736",[2754,8.519]],["name/3737",[189,39.191]],["parent/3737",[2754,8.519]],["name/3738",[2755,84.686]],["parent/3738",[291,3.313]],["name/3739",[425,45.531]],["parent/3739",[2756,8.519]],["name/3740",[680,67.046]],["parent/3740",[2756,8.519]],["name/3741",[308,63.971]],["parent/3741",[2756,8.519]],["name/3742",[309,64.897]],["parent/3742",[2756,8.519]],["name/3743",[681,67.046]],["parent/3743",[2756,8.519]],["name/3744",[311,64.897]],["parent/3744",[2756,8.519]],["name/3745",[312,64.897]],["parent/3745",[2756,8.519]],["name/3746",[310,63.971]],["parent/3746",[2756,8.519]],["name/3747",[279,32.637]],["parent/3747",[2756,8.519]],["name/3748",[189,39.191]],["parent/3748",[2756,8.519]],["name/3749",[2757,84.686]],["parent/3749",[291,3.313]],["name/3750",[2026,62.341]],["parent/3750",[2758,8.519]],["name/3751",[2027,62.341]],["parent/3751",[2758,8.519]],["name/3752",[2032,67.046]],["parent/3752",[2758,8.519]],["name/3753",[2029,67.046]],["parent/3753",[2758,8.519]],["name/3754",[425,45.531]],["parent/3754",[2758,8.519]],["name/3755",[1244,60.3]],["parent/3755",[2758,8.519]],["name/3756",[1149,59.136]],["parent/3756",[2758,8.519]],["name/3757",[2031,67.046]],["parent/3757",[2758,8.519]],["name/3758",[587,60.3]],["parent/3758",[2758,8.519]],["name/3759",[2033,67.046]],["parent/3759",[2758,8.519]],["name/3760",[2759,84.686]],["parent/3760",[291,3.313]],["name/3761",[1011,53.098]],["parent/3761",[2760,11.117]],["name/3762",[2761,84.686]],["parent/3762",[291,3.313]],["name/3763",[1011,53.098]],["parent/3763",[2762,11.117]],["name/3764",[2763,84.686]],["parent/3764",[291,3.313]],["name/3765",[1011,53.098]],["parent/3765",[2764,11.117]],["name/3766",[2765,84.686]],["parent/3766",[291,3.313]],["name/3767",[1011,53.098]],["parent/3767",[2766,11.117]],["name/3768",[2767,84.686]],["parent/3768",[291,3.313]],["name/3769",[1011,53.098]],["parent/3769",[2768,11.117]],["name/3770",[2769,84.686]],["parent/3770",[291,3.313]],["name/3771",[1011,53.098]],["parent/3771",[2770,11.117]],["name/3772",[2771,84.686]],["parent/3772",[291,3.313]],["name/3773",[1149,59.136]],["parent/3773",[2772,10.435]],["name/3774",[1011,53.098]],["parent/3774",[2772,10.435]],["name/3775",[2773,84.686]],["parent/3775",[291,3.313]],["name/3776",[2774,84.686]],["parent/3776",[291,3.313]],["name/3777",[425,45.531]],["parent/3777",[2775,8.519]],["name/3778",[680,67.046]],["parent/3778",[2775,8.519]],["name/3779",[308,63.971]],["parent/3779",[2775,8.519]],["name/3780",[309,64.897]],["parent/3780",[2775,8.519]],["name/3781",[681,67.046]],["parent/3781",[2775,8.519]],["name/3782",[311,64.897]],["parent/3782",[2775,8.519]],["name/3783",[312,64.897]],["parent/3783",[2775,8.519]],["name/3784",[310,63.971]],["parent/3784",[2775,8.519]],["name/3785",[279,32.637]],["parent/3785",[2775,8.519]],["name/3786",[189,39.191]],["parent/3786",[2775,8.519]],["name/3787",[2776,84.686]],["parent/3787",[291,3.313]],["name/3788",[425,45.531]],["parent/3788",[2777,8.519]],["name/3789",[680,67.046]],["parent/3789",[2777,8.519]],["name/3790",[308,63.971]],["parent/3790",[2777,8.519]],["name/3791",[309,64.897]],["parent/3791",[2777,8.519]],["name/3792",[681,67.046]],["parent/3792",[2777,8.519]],["name/3793",[311,64.897]],["parent/3793",[2777,8.519]],["name/3794",[312,64.897]],["parent/3794",[2777,8.519]],["name/3795",[310,63.971]],["parent/3795",[2777,8.519]],["name/3796",[279,32.637]],["parent/3796",[2777,8.519]],["name/3797",[189,39.191]],["parent/3797",[2777,8.519]],["name/3798",[2778,84.686]],["parent/3798",[291,3.313]],["name/3799",[2779,84.686]],["parent/3799",[291,3.313]],["name/3800",[2780,84.686]],["parent/3800",[291,3.313]],["name/3801",[2781,84.686]],["parent/3801",[291,3.313]],["name/3802",[2782,84.686]],["parent/3802",[291,3.313]],["name/3803",[2783,84.686]],["parent/3803",[291,3.313]],["name/3804",[2784,84.686]],["parent/3804",[291,3.313]],["name/3805",[2785,84.686]],["parent/3805",[291,3.313]],["name/3806",[1835,58.601]],["parent/3806",[2786,9.986]],["name/3807",[1837,73.514]],["parent/3807",[2786,9.986]],["name/3808",[837,68.319]],["parent/3808",[2786,9.986]],["name/3809",[2787,84.686]],["parent/3809",[291,3.313]],["name/3810",[2788,84.686]],["parent/3810",[291,3.313]],["name/3811",[2789,84.686]],["parent/3811",[291,3.313]],["name/3812",[1844,79.491]],["parent/3812",[291,3.313]],["name/3813",[1845,79.491]],["parent/3813",[291,3.313]],["name/3814",[18,47.256]],["parent/3814",[2790,11.117]],["name/3815",[2791,84.686]],["parent/3815",[291,3.313]],["name/3816",[2792,84.686]],["parent/3816",[291,3.313]],["name/3817",[2793,84.686]],["parent/3817",[291,3.313]],["name/3818",[2794,84.686]],["parent/3818",[291,3.313]],["name/3819",[2795,84.686]],["parent/3819",[291,3.313]],["name/3820",[2796,84.686]],["parent/3820",[291,3.313]],["name/3821",[2797,84.686]],["parent/3821",[291,3.313]],["name/3822",[2798,84.686]],["parent/3822",[291,3.313]],["name/3823",[2799,84.686]],["parent/3823",[291,3.313]],["name/3824",[2800,84.686]],["parent/3824",[291,3.313]],["name/3825",[2801,84.686]],["parent/3825",[291,3.313]],["name/3826",[2802,84.686]],["parent/3826",[291,3.313]],["name/3827",[2803,84.686]],["parent/3827",[291,3.313]],["name/3828",[2804,84.686]],["parent/3828",[291,3.313]],["name/3829",[2805,84.686]],["parent/3829",[291,3.313]],["name/3830",[2806,84.686]],["parent/3830",[291,3.313]],["name/3831",[2807,84.686]],["parent/3831",[291,3.313]],["name/3832",[1,3.907,2,3.907,3,13.516,2808,14.233]],["parent/3832",[]],["name/3833",[2809,84.686]],["parent/3833",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3834",[1032,63.123]],["parent/3834",[1,0.69,2,0.69,2808,2.513,2810,5.297]],["name/3835",[2811,84.686]],["parent/3835",[1,0.69,2,0.69,2808,2.513,2810,5.297]],["name/3836",[2812,84.686]],["parent/3836",[1,0.69,2,0.69,2808,2.513,2810,5.297]],["name/3837",[2813,84.686]],["parent/3837",[1,0.69,2,0.69,2808,2.513,2810,5.297]],["name/3838",[2814,84.686]],["parent/3838",[1,0.69,2,0.69,2808,2.513,2810,5.297]],["name/3839",[2815,84.686]],["parent/3839",[1,0.69,2,0.69,2808,2.513,2810,5.297]],["name/3840",[2816,84.686]],["parent/3840",[1,0.69,2,0.69,2808,2.513,2810,5.297]],["name/3841",[2817,84.686]],["parent/3841",[1,0.69,2,0.69,2808,2.513,2810,5.297]],["name/3842",[2818,76.069]],["parent/3842",[1,0.69,2,0.69,2808,2.513,2810,5.297]],["name/3843",[2819,84.686]],["parent/3843",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3844",[279,32.637]],["parent/3844",[1,0.69,2,0.69,2808,2.513,2820,6.806]],["name/3845",[2821,84.686]],["parent/3845",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3846",[279,32.637]],["parent/3846",[1,0.69,2,0.69,2808,2.513,2822,6.806]],["name/3847",[2823,84.686]],["parent/3847",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3848",[279,32.637]],["parent/3848",[1,0.69,2,0.69,2808,2.513,2824,6.806]],["name/3849",[2825,84.686]],["parent/3849",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3850",[279,32.637]],["parent/3850",[1,0.69,2,0.69,2808,2.513,2826,6.806]],["name/3851",[2827,84.686]],["parent/3851",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3852",[279,32.637]],["parent/3852",[1,0.69,2,0.69,2808,2.513,2828,6.806]],["name/3853",[2829,84.686]],["parent/3853",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3854",[2830,71.473]],["parent/3854",[1,0.69,2,0.69,2808,2.513,2831,6.114]],["name/3855",[2832,76.069]],["parent/3855",[1,0.69,2,0.69,2808,2.513,2831,6.114]],["name/3856",[2833,76.069]],["parent/3856",[1,0.69,2,0.69,2808,2.513,2831,6.114]],["name/3857",[2834,84.686]],["parent/3857",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3858",[2835,84.686]],["parent/3858",[1,0.69,2,0.69,2808,2.513,2836,6.806]],["name/3859",[2837,84.686]],["parent/3859",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3860",[189,39.191]],["parent/3860",[1,0.69,2,0.69,2808,2.513,2838,5.297]],["name/3861",[112,60.3]],["parent/3861",[1,0.69,2,0.69,2808,2.513,2838,5.297]],["name/3862",[2839,60.3]],["parent/3862",[1,0.69,2,0.69,2808,2.513,2838,5.297]],["name/3863",[2840,69.774]],["parent/3863",[1,0.69,2,0.69,2808,2.513,2838,5.297]],["name/3864",[46,42.129]],["parent/3864",[1,0.69,2,0.69,2808,2.513,2838,5.297]],["name/3865",[189,28.012,2841,56.818]],["parent/3865",[1,0.69,2,0.69,2808,2.513,2838,5.297]],["name/3866",[1835,41.886,2842,45.119]],["parent/3866",[1,0.69,2,0.69,2808,2.513,2838,5.297]],["name/3867",[189,28.012,2843,51.087]],["parent/3867",[1,0.69,2,0.69,2808,2.513,2838,5.297]],["name/3868",[189,28.012,2844,56.818]],["parent/3868",[1,0.69,2,0.69,2808,2.513,2838,5.297]],["name/3869",[2845,84.686]],["parent/3869",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3870",[329,55.105]],["parent/3870",[1,0.69,2,0.69,2808,2.513,2846,6.389]],["name/3871",[331,55.105]],["parent/3871",[1,0.69,2,0.69,2808,2.513,2846,6.389]],["name/3872",[2847,84.686]],["parent/3872",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3873",[329,55.105]],["parent/3873",[1,0.69,2,0.69,2808,2.513,2848,6.389]],["name/3874",[331,55.105]],["parent/3874",[1,0.69,2,0.69,2808,2.513,2848,6.389]],["name/3875",[2849,84.686]],["parent/3875",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3876",[2850,54.372,2851,48.832]],["parent/3876",[1,0.69,2,0.69,2808,2.513,2852,6.806]],["name/3877",[2853,84.686]],["parent/3877",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3878",[2850,54.372,2851,48.832]],["parent/3878",[1,0.69,2,0.69,2808,2.513,2854,6.114]],["name/3879",[329,55.105]],["parent/3879",[1,0.69,2,0.69,2808,2.513,2854,6.114]],["name/3880",[331,55.105]],["parent/3880",[1,0.69,2,0.69,2808,2.513,2854,6.114]],["name/3881",[2855,84.686]],["parent/3881",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3882",[2850,54.372,2851,48.832]],["parent/3882",[1,0.69,2,0.69,2808,2.513,2856,6.114]],["name/3883",[329,55.105]],["parent/3883",[1,0.69,2,0.69,2808,2.513,2856,6.114]],["name/3884",[331,55.105]],["parent/3884",[1,0.69,2,0.69,2808,2.513,2856,6.114]],["name/3885",[2857,84.686]],["parent/3885",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3886",[2858,84.686]],["parent/3886",[1,0.69,2,0.69,2808,2.513,2859,6.806]],["name/3887",[2860,84.686]],["parent/3887",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3888",[189,39.191]],["parent/3888",[1,0.69,2,0.69,2808,2.513,2861,5.908]],["name/3889",[298,63.971]],["parent/3889",[1,0.69,2,0.69,2808,2.513,2861,5.908]],["name/3890",[2862,76.069]],["parent/3890",[1,0.69,2,0.69,2808,2.513,2861,5.908]],["name/3891",[1397,51.087,1971,51.087]],["parent/3891",[1,0.69,2,0.69,2808,2.513,2861,5.908]],["name/3892",[2863,84.686]],["parent/3892",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3893",[329,55.105]],["parent/3893",[1,0.69,2,0.69,2808,2.513,2864,6.389]],["name/3894",[331,55.105]],["parent/3894",[1,0.69,2,0.69,2808,2.513,2864,6.389]],["name/3895",[2865,84.686]],["parent/3895",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3896",[329,55.105]],["parent/3896",[1,0.69,2,0.69,2808,2.513,2866,6.389]],["name/3897",[331,55.105]],["parent/3897",[1,0.69,2,0.69,2808,2.513,2866,6.389]],["name/3898",[2867,84.686]],["parent/3898",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3899",[329,55.105]],["parent/3899",[1,0.69,2,0.69,2808,2.513,2868,6.389]],["name/3900",[331,55.105]],["parent/3900",[1,0.69,2,0.69,2808,2.513,2868,6.389]],["name/3901",[2869,84.686]],["parent/3901",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3902",[189,39.191]],["parent/3902",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3903",[123,37.886]],["parent/3903",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3904",[1458,67.046]],["parent/3904",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3905",[2871,73.514]],["parent/3905",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3906",[2872,60.531,2873,60.531]],["parent/3906",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3907",[261,26.44,1458,30.515,2874,38.544,2875,38.544]],["parent/3907",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3908",[461,36.092,1458,37.287,2876,40.884]],["parent/3908",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3909",[461,36.092,1458,37.287,2877,47.098]],["parent/3909",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3910",[1458,37.287,2878,47.098,2879,38.804]],["parent/3910",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3911",[1007,36.092,2880,36.658,2881,42.305]],["parent/3911",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3912",[2880,30,2881,34.622,2882,33.459,2883,36.179]],["parent/3912",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3913",[873,36.179,2880,30,2884,36.179,2885,36.179]],["parent/3913",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3914",[2886,59.136]],["parent/3914",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3915",[572,47.922,2886,42.269]],["parent/3915",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3916",[586,40.884,2886,32.888,2887,44.208]],["parent/3916",[1,0.69,2,0.69,2808,2.513,2870,4.897]],["name/3917",[2888,84.686]],["parent/3917",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3918",[2886,59.136]],["parent/3918",[1,0.69,2,0.69,2808,2.513,2889,5.744]],["name/3919",[572,47.922,2886,42.269]],["parent/3919",[1,0.69,2,0.69,2808,2.513,2889,5.744]],["name/3920",[586,40.884,2886,32.888,2887,44.208]],["parent/3920",[1,0.69,2,0.69,2808,2.513,2889,5.744]],["name/3921",[329,55.105]],["parent/3921",[1,0.69,2,0.69,2808,2.513,2889,5.744]],["name/3922",[331,55.105]],["parent/3922",[1,0.69,2,0.69,2808,2.513,2889,5.744]],["name/3923",[2890,84.686]],["parent/3923",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3924",[329,55.105]],["parent/3924",[1,0.69,2,0.69,2808,2.513,2891,6.389]],["name/3925",[331,55.105]],["parent/3925",[1,0.69,2,0.69,2808,2.513,2891,6.389]],["name/3926",[2892,84.686]],["parent/3926",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3927",[123,37.886]],["parent/3927",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3928",[2894,63.123]],["parent/3928",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3929",[2895,84.686]],["parent/3929",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3930",[2896,64.897]],["parent/3930",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3931",[112,60.3]],["parent/3931",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3932",[46,42.129]],["parent/3932",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3933",[2839,60.3]],["parent/3933",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3934",[2088,79.491]],["parent/3934",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3935",[2840,69.774]],["parent/3935",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3936",[2897,84.686]],["parent/3936",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3937",[2898,84.686]],["parent/3937",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3938",[1835,41.886,2842,45.119]],["parent/3938",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3939",[189,28.012,2842,45.119]],["parent/3939",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3940",[2842,45.119,2899,51.087]],["parent/3940",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3941",[123,27.08,1397,51.087]],["parent/3941",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3942",[189,28.012,2900,54.372]],["parent/3942",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3943",[2894,45.119,2901,52.545]],["parent/3943",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3944",[1835,32.59,2842,35.106,2902,44.208]],["parent/3944",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3945",[189,21.796,2842,35.106,2902,44.208]],["parent/3945",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3946",[461,46.386,2880,47.114]],["parent/3946",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3947",[2880,30,2884,36.179,2885,36.179,2903,38.544]],["parent/3947",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3948",[2904,22.48,2905,60.531]],["parent/3948",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3949",[2879,49.872,2906,56.818]],["parent/3949",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3950",[2879,38.804,2907,39.749,2908,44.208]],["parent/3950",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3951",[261,32.308,2906,44.208,2909,44.208]],["parent/3951",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3952",[261,26.44,2907,32.53,2908,36.179,2909,36.179]],["parent/3952",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3953",[189,21.796,2907,39.749,2910,37.995]],["parent/3953",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3954",[1835,26.671,2842,28.73,2907,32.53,2910,31.094]],["parent/3954",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3955",[2840,38.804,2907,39.749,2910,37.995]],["parent/3955",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3956",[122,40.53,261,41.523]],["parent/3956",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3957",[122,31.535,261,32.308,1835,32.59]],["parent/3957",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3958",[1835,41.886,2911,54.372]],["parent/3958",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3959",[189,28.012,2911,54.372]],["parent/3959",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3960",[1835,41.886,2843,51.087]],["parent/3960",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3961",[189,28.012,2843,51.087]],["parent/3961",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3962",[110,48.832,2912,60.531]],["parent/3962",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3963",[411,45.725,2913,52.545]],["parent/3963",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3964",[2914,54.372,2915,60.531]],["parent/3964",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3965",[2879,38.804,2880,36.658,2916,42.305]],["parent/3965",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3966",[2879,38.804,2880,36.658,2917,44.208]],["parent/3966",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3967",[2886,59.136]],["parent/3967",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3968",[2918,73.514]],["parent/3968",[1,0.69,2,0.69,2808,2.513,2893,4.073]],["name/3969",[2919,84.686]],["parent/3969",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3970",[331,55.105]],["parent/3970",[1,0.69,2,0.69,2808,2.513,2920,6.389]],["name/3971",[329,55.105]],["parent/3971",[1,0.69,2,0.69,2808,2.513,2920,6.389]],["name/3972",[2921,84.686]],["parent/3972",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3973",[329,55.105]],["parent/3973",[1,0.69,2,0.69,2808,2.513,2922,6.114]],["name/3974",[2886,59.136]],["parent/3974",[1,0.69,2,0.69,2808,2.513,2922,6.114]],["name/3975",[331,55.105]],["parent/3975",[1,0.69,2,0.69,2808,2.513,2922,6.114]],["name/3976",[2923,84.686]],["parent/3976",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3977",[329,55.105]],["parent/3977",[1,0.69,2,0.69,2808,2.513,2924,6.114]],["name/3978",[2918,73.514]],["parent/3978",[1,0.69,2,0.69,2808,2.513,2924,6.114]],["name/3979",[331,55.105]],["parent/3979",[1,0.69,2,0.69,2808,2.513,2924,6.114]],["name/3980",[2925,84.686]],["parent/3980",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3981",[329,55.105]],["parent/3981",[1,0.69,2,0.69,2808,2.513,2926,6.114]],["name/3982",[2918,73.514]],["parent/3982",[1,0.69,2,0.69,2808,2.513,2926,6.114]],["name/3983",[331,55.105]],["parent/3983",[1,0.69,2,0.69,2808,2.513,2926,6.114]],["name/3984",[2927,84.686]],["parent/3984",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3985",[329,55.105]],["parent/3985",[1,0.69,2,0.69,2808,2.513,2928,5.908]],["name/3986",[331,55.105]],["parent/3986",[1,0.69,2,0.69,2808,2.513,2928,5.908]],["name/3987",[2886,59.136]],["parent/3987",[1,0.69,2,0.69,2808,2.513,2928,5.908]],["name/3988",[2918,73.514]],["parent/3988",[1,0.69,2,0.69,2808,2.513,2928,5.908]],["name/3989",[2929,84.686]],["parent/3989",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3990",[2930,84.686]],["parent/3990",[1,0.69,2,0.69,2808,2.513,2931,6.806]],["name/3991",[2932,84.686]],["parent/3991",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3992",[2886,59.136]],["parent/3992",[1,0.69,2,0.69,2808,2.513,2933,6.806]],["name/3993",[2934,84.686]],["parent/3993",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3994",[2935,84.686]],["parent/3994",[1,0.69,2,0.69,2808,2.513,2936,6.389]],["name/3995",[2937,71.473]],["parent/3995",[1,0.69,2,0.69,2808,2.513,2936,6.389]],["name/3996",[2938,84.686]],["parent/3996",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3997",[2851,48.832,2939,54.372]],["parent/3997",[1,0.69,2,0.69,2808,2.513,2940,6.806]],["name/3998",[2941,84.686]],["parent/3998",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/3999",[2851,48.832,2939,54.372]],["parent/3999",[1,0.69,2,0.69,2808,2.513,2942,6.114]],["name/4000",[329,55.105]],["parent/4000",[1,0.69,2,0.69,2808,2.513,2942,6.114]],["name/4001",[331,55.105]],["parent/4001",[1,0.69,2,0.69,2808,2.513,2942,6.114]],["name/4002",[2943,84.686]],["parent/4002",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4003",[2851,48.832,2939,54.372]],["parent/4003",[1,0.69,2,0.69,2808,2.513,2944,6.114]],["name/4004",[329,55.105]],["parent/4004",[1,0.69,2,0.69,2808,2.513,2944,6.114]],["name/4005",[331,55.105]],["parent/4005",[1,0.69,2,0.69,2808,2.513,2944,6.114]],["name/4006",[2945,84.686]],["parent/4006",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4007",[2946,84.686]],["parent/4007",[1,0.69,2,0.69,2808,2.513,2947,6.114]],["name/4008",[2948,84.686]],["parent/4008",[1,0.69,2,0.69,2808,2.513,2947,6.114]],["name/4009",[2937,71.473]],["parent/4009",[1,0.69,2,0.69,2808,2.513,2947,6.114]],["name/4010",[2949,84.686]],["parent/4010",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4011",[189,39.191]],["parent/4011",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4012",[298,63.971]],["parent/4012",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4013",[275,58.601]],["parent/4013",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4014",[2951,84.686]],["parent/4014",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4015",[46,42.129]],["parent/4015",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4016",[2952,79.491]],["parent/4016",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4017",[123,37.886]],["parent/4017",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4018",[2953,47.098,2954,47.098,2955,44.208]],["parent/4018",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4019",[2956,84.686]],["parent/4019",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4020",[818,76.069]],["parent/4020",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4021",[2957,60.531,2958,60.531]],["parent/4021",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4022",[2959,84.686]],["parent/4022",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4023",[138,79.491]],["parent/4023",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4024",[2960,84.686]],["parent/4024",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4025",[279,23.328,413,47.922]],["parent/4025",[1,0.69,2,0.69,2808,2.513,2950,4.897]],["name/4026",[2961,84.686]],["parent/4026",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4027",[331,55.105]],["parent/4027",[1,0.69,2,0.69,2808,2.513,2962,6.389]],["name/4028",[329,55.105]],["parent/4028",[1,0.69,2,0.69,2808,2.513,2962,6.389]],["name/4029",[2963,84.686]],["parent/4029",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4030",[331,55.105]],["parent/4030",[1,0.69,2,0.69,2808,2.513,2964,6.389]],["name/4031",[329,55.105]],["parent/4031",[1,0.69,2,0.69,2808,2.513,2964,6.389]],["name/4032",[2965,84.686]],["parent/4032",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4033",[189,39.191]],["parent/4033",[1,0.69,2,0.69,2808,2.513,2966,5.216]],["name/4034",[112,60.3]],["parent/4034",[1,0.69,2,0.69,2808,2.513,2966,5.216]],["name/4035",[2839,60.3]],["parent/4035",[1,0.69,2,0.69,2808,2.513,2966,5.216]],["name/4036",[2840,69.774]],["parent/4036",[1,0.69,2,0.69,2808,2.513,2966,5.216]],["name/4037",[46,42.129]],["parent/4037",[1,0.69,2,0.69,2808,2.513,2966,5.216]],["name/4038",[189,28.012,2841,56.818]],["parent/4038",[1,0.69,2,0.69,2808,2.513,2966,5.216]],["name/4039",[1835,41.886,2842,45.119]],["parent/4039",[1,0.69,2,0.69,2808,2.513,2966,5.216]],["name/4040",[189,28.012,2843,51.087]],["parent/4040",[1,0.69,2,0.69,2808,2.513,2966,5.216]],["name/4041",[189,28.012,2844,56.818]],["parent/4041",[1,0.69,2,0.69,2808,2.513,2966,5.216]],["name/4042",[572,47.922,2886,42.269]],["parent/4042",[1,0.69,2,0.69,2808,2.513,2966,5.216]],["name/4043",[2967,84.686]],["parent/4043",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4044",[572,47.922,2886,42.269]],["parent/4044",[1,0.69,2,0.69,2808,2.513,2968,6.114]],["name/4045",[331,55.105]],["parent/4045",[1,0.69,2,0.69,2808,2.513,2968,6.114]],["name/4046",[329,55.105]],["parent/4046",[1,0.69,2,0.69,2808,2.513,2968,6.114]],["name/4047",[2969,84.686]],["parent/4047",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4048",[572,47.922,2886,42.269]],["parent/4048",[1,0.69,2,0.69,2808,2.513,2970,6.114]],["name/4049",[331,55.105]],["parent/4049",[1,0.69,2,0.69,2808,2.513,2970,6.114]],["name/4050",[329,55.105]],["parent/4050",[1,0.69,2,0.69,2808,2.513,2970,6.114]],["name/4051",[2971,84.686]],["parent/4051",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4052",[2972,84.686]],["parent/4052",[1,0.69,2,0.69,2808,2.513,2973,6.389]],["name/4053",[2937,71.473]],["parent/4053",[1,0.69,2,0.69,2808,2.513,2973,6.389]],["name/4054",[2974,84.686]],["parent/4054",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4055",[1835,41.886,2910,48.832]],["parent/4055",[1,0.69,2,0.69,2808,2.513,2975,6.389]],["name/4056",[2899,51.087,2910,48.832]],["parent/4056",[1,0.69,2,0.69,2808,2.513,2975,6.389]],["name/4057",[2976,84.686]],["parent/4057",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4058",[1835,41.886,2910,48.832]],["parent/4058",[1,0.69,2,0.69,2808,2.513,2977,5.908]],["name/4059",[2899,51.087,2910,48.832]],["parent/4059",[1,0.69,2,0.69,2808,2.513,2977,5.908]],["name/4060",[329,55.105]],["parent/4060",[1,0.69,2,0.69,2808,2.513,2977,5.908]],["name/4061",[331,55.105]],["parent/4061",[1,0.69,2,0.69,2808,2.513,2977,5.908]],["name/4062",[2978,84.686]],["parent/4062",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4063",[2979,84.686]],["parent/4063",[1,0.69,2,0.69,2808,2.513,2980,6.389]],["name/4064",[2937,71.473]],["parent/4064",[1,0.69,2,0.69,2808,2.513,2980,6.389]],["name/4065",[2981,84.686]],["parent/4065",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4066",[189,28.012,2842,45.119]],["parent/4066",[1,0.69,2,0.69,2808,2.513,2982,5.744]],["name/4067",[1835,41.886,2842,45.119]],["parent/4067",[1,0.69,2,0.69,2808,2.513,2982,5.744]],["name/4068",[2842,45.119,2899,51.087]],["parent/4068",[1,0.69,2,0.69,2808,2.513,2982,5.744]],["name/4069",[189,28.012,2900,54.372]],["parent/4069",[1,0.69,2,0.69,2808,2.513,2982,5.744]],["name/4070",[2894,45.119,2901,52.545]],["parent/4070",[1,0.69,2,0.69,2808,2.513,2982,5.744]],["name/4071",[2983,84.686]],["parent/4071",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4072",[329,55.105]],["parent/4072",[1,0.69,2,0.69,2808,2.513,2984,5.908]],["name/4073",[331,55.105]],["parent/4073",[1,0.69,2,0.69,2808,2.513,2984,5.908]],["name/4074",[189,28.012,2900,54.372]],["parent/4074",[1,0.69,2,0.69,2808,2.513,2984,5.908]],["name/4075",[1835,41.886,2842,45.119]],["parent/4075",[1,0.69,2,0.69,2808,2.513,2984,5.908]],["name/4076",[2985,84.686]],["parent/4076",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4077",[2986,67.046]],["parent/4077",[1,0.69,2,0.69,2808,2.513,2987,5.744]],["name/4078",[2988,68.319]],["parent/4078",[1,0.69,2,0.69,2808,2.513,2987,5.744]],["name/4079",[2989,68.319]],["parent/4079",[1,0.69,2,0.69,2808,2.513,2987,5.744]],["name/4080",[2990,68.319]],["parent/4080",[1,0.69,2,0.69,2808,2.513,2987,5.744]],["name/4081",[2896,64.897]],["parent/4081",[1,0.69,2,0.69,2808,2.513,2987,5.744]],["name/4082",[2991,84.686]],["parent/4082",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4083",[329,55.105]],["parent/4083",[1,0.69,2,0.69,2808,2.513,2992,5.491]],["name/4084",[331,55.105]],["parent/4084",[1,0.69,2,0.69,2808,2.513,2992,5.491]],["name/4085",[2986,67.046]],["parent/4085",[1,0.69,2,0.69,2808,2.513,2992,5.491]],["name/4086",[2988,68.319]],["parent/4086",[1,0.69,2,0.69,2808,2.513,2992,5.491]],["name/4087",[2989,68.319]],["parent/4087",[1,0.69,2,0.69,2808,2.513,2992,5.491]],["name/4088",[2990,68.319]],["parent/4088",[1,0.69,2,0.69,2808,2.513,2992,5.491]],["name/4089",[2896,64.897]],["parent/4089",[1,0.69,2,0.69,2808,2.513,2992,5.491]],["name/4090",[2993,84.686]],["parent/4090",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4091",[2894,45.119,2901,52.545]],["parent/4091",[1,0.69,2,0.69,2808,2.513,2994,6.114]],["name/4092",[411,45.725,1397,51.087]],["parent/4092",[1,0.69,2,0.69,2808,2.513,2994,6.114]],["name/4093",[411,45.725,2880,47.114]],["parent/4093",[1,0.69,2,0.69,2808,2.513,2994,6.114]],["name/4094",[2995,84.686]],["parent/4094",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4095",[2894,45.119,2901,52.545]],["parent/4095",[1,0.69,2,0.69,2808,2.513,2996,5.744]],["name/4096",[329,55.105]],["parent/4096",[1,0.69,2,0.69,2808,2.513,2996,5.744]],["name/4097",[331,55.105]],["parent/4097",[1,0.69,2,0.69,2808,2.513,2996,5.744]],["name/4098",[411,45.725,1397,51.087]],["parent/4098",[1,0.69,2,0.69,2808,2.513,2996,5.744]],["name/4099",[411,45.725,2880,47.114]],["parent/4099",[1,0.69,2,0.69,2808,2.513,2996,5.744]],["name/4100",[2997,84.686]],["parent/4100",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4101",[189,39.191]],["parent/4101",[1,0.69,2,0.69,2808,2.513,2998,6.389]],["name/4102",[298,63.971]],["parent/4102",[1,0.69,2,0.69,2808,2.513,2998,6.389]],["name/4103",[2999,84.686]],["parent/4103",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4104",[2883,56.818,2886,42.269]],["parent/4104",[1,0.69,2,0.69,2808,2.513,3000,5.491]],["name/4105",[189,28.012,2843,51.087]],["parent/4105",[1,0.69,2,0.69,2808,2.513,3000,5.491]],["name/4106",[189,28.012,2911,54.372]],["parent/4106",[1,0.69,2,0.69,2808,2.513,3000,5.491]],["name/4107",[122,31.535,261,32.308,1835,32.59]],["parent/4107",[1,0.69,2,0.69,2808,2.513,3000,5.491]],["name/4108",[411,45.725,2913,52.545]],["parent/4108",[1,0.69,2,0.69,2808,2.513,3000,5.491]],["name/4109",[122,40.53,261,41.523]],["parent/4109",[1,0.69,2,0.69,2808,2.513,3000,5.491]],["name/4110",[3001,56.818,3002,60.531]],["parent/4110",[1,0.69,2,0.69,2808,2.513,3000,5.491]],["name/4111",[3003,84.686]],["parent/4111",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4112",[3004,84.686]],["parent/4112",[1,0.69,2,0.69,2808,2.513,3005,6.389]],["name/4113",[3006,84.686]],["parent/4113",[1,0.69,2,0.69,2808,2.513,3005,6.389]],["name/4114",[3007,84.686]],["parent/4114",[1,0.69,2,0.69,3,2.387,2808,2.513]],["name/4115",[3008,79.491]],["parent/4115",[1,0.69,2,0.69,2808,2.513,3009,6.114]],["name/4116",[3010,84.686]],["parent/4116",[1,0.69,2,0.69,2808,2.513,3009,6.114]],["name/4117",[3011,84.686]],["parent/4117",[1,0.69,2,0.69,2808,2.513,3009,6.114]],["name/4118",[1,3.307,2,3.307,3,11.438,415,15.604,3012,4.654]],["parent/4118",[]],["name/4119",[3013,84.686]],["parent/4119",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4120",[1004,45.119,3014,49.872]],["parent/4120",[1,0.611,2,0.611,415,2.883,3012,0.86,3015,5.657]],["name/4121",[461,36.092,2876,40.884,3016,44.208]],["parent/4121",[1,0.611,2,0.611,415,2.883,3012,0.86,3015,5.657]],["name/4122",[3017,84.686]],["parent/4122",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4123",[3014,69.774]],["parent/4123",[1,0.611,2,0.611,415,2.883,3012,0.86,3018,5.232]],["name/4124",[461,46.386,2876,52.545]],["parent/4124",[1,0.611,2,0.611,415,2.883,3012,0.86,3018,5.232]],["name/4125",[2894,63.123]],["parent/4125",[1,0.611,2,0.611,415,2.883,3012,0.86,3018,5.232]],["name/4126",[3019,79.491]],["parent/4126",[1,0.611,2,0.611,415,2.883,3012,0.86,3018,5.232]],["name/4127",[3020,84.686]],["parent/4127",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4128",[104,38.804,1004,35.106,3014,38.804]],["parent/4128",[1,0.611,2,0.611,415,2.883,3012,0.86,3021,5.087]],["name/4129",[1004,45.119,3014,49.872]],["parent/4129",[1,0.611,2,0.611,415,2.883,3012,0.86,3021,5.087]],["name/4130",[1004,35.106,2899,39.749,3014,38.804]],["parent/4130",[1,0.611,2,0.611,415,2.883,3012,0.86,3021,5.087]],["name/4131",[461,36.092,1004,35.106,3014,38.804]],["parent/4131",[1,0.611,2,0.611,415,2.883,3012,0.86,3021,5.087]],["name/4132",[461,36.092,2876,40.884,3016,44.208]],["parent/4132",[1,0.611,2,0.611,415,2.883,3012,0.86,3021,5.087]],["name/4133",[3022,84.686]],["parent/4133",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4134",[3023,76.069]],["parent/4134",[1,0.611,2,0.611,415,2.883,3012,0.86,3024,5.657]],["name/4135",[3025,73.514]],["parent/4135",[1,0.611,2,0.611,415,2.883,3012,0.86,3024,5.657]],["name/4136",[3026,84.686]],["parent/4136",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4137",[3027,84.686]],["parent/4137",[1,0.611,2,0.611,415,2.883,3012,0.86,3028,5.087]],["name/4138",[3029,84.686]],["parent/4138",[1,0.611,2,0.611,415,2.883,3012,0.86,3028,5.087]],["name/4139",[3030,84.686]],["parent/4139",[1,0.611,2,0.611,415,2.883,3012,0.86,3028,5.087]],["name/4140",[3023,76.069]],["parent/4140",[1,0.611,2,0.611,415,2.883,3012,0.86,3028,5.087]],["name/4141",[3025,73.514]],["parent/4141",[1,0.611,2,0.611,415,2.883,3012,0.86,3028,5.087]],["name/4142",[3031,84.686]],["parent/4142",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4143",[1644,63.123]],["parent/4143",[1,0.611,2,0.611,415,2.883,3012,0.86,3032,4.862]],["name/4144",[3033,76.069]],["parent/4144",[1,0.611,2,0.611,415,2.883,3012,0.86,3032,4.862]],["name/4145",[3034,73.514]],["parent/4145",[1,0.611,2,0.611,415,2.883,3012,0.86,3032,4.862]],["name/4146",[1670,69.774]],["parent/4146",[1,0.611,2,0.611,415,2.883,3012,0.86,3032,4.862]],["name/4147",[3035,84.686]],["parent/4147",[1,0.611,2,0.611,415,2.883,3012,0.86,3032,4.862]],["name/4148",[3036,84.686]],["parent/4148",[1,0.611,2,0.611,415,2.883,3012,0.86,3032,4.862]],["name/4149",[3037,84.686]],["parent/4149",[1,0.611,2,0.611,415,2.883,3012,0.86,3032,4.862]],["name/4150",[3038,84.686]],["parent/4150",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4151",[1458,67.046]],["parent/4151",[1,0.611,2,0.611,415,2.883,3012,0.86,3039,4.966]],["name/4152",[3040,84.686]],["parent/4152",[1,0.611,2,0.611,415,2.883,3012,0.86,3039,4.966]],["name/4153",[3041,84.686]],["parent/4153",[1,0.611,2,0.611,415,2.883,3012,0.86,3039,4.966]],["name/4154",[3019,79.491]],["parent/4154",[1,0.611,2,0.611,415,2.883,3012,0.86,3039,4.966]],["name/4155",[3023,76.069]],["parent/4155",[1,0.611,2,0.611,415,2.883,3012,0.86,3039,4.966]],["name/4156",[3025,73.514]],["parent/4156",[1,0.611,2,0.611,415,2.883,3012,0.86,3039,4.966]],["name/4157",[3042,84.686]],["parent/4157",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4158",[18,47.256]],["parent/4158",[1,0.611,2,0.611,415,2.883,3012,0.86,3043,6.027]],["name/4159",[3044,84.686]],["parent/4159",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4160",[89,69.774]],["parent/4160",[1,0.611,2,0.611,415,2.883,3012,0.86,3045,4.966]],["name/4161",[1032,63.123]],["parent/4161",[1,0.611,2,0.611,415,2.883,3012,0.86,3045,4.966]],["name/4162",[3046,84.686]],["parent/4162",[1,0.611,2,0.611,415,2.883,3012,0.86,3045,4.966]],["name/4163",[3047,84.686]],["parent/4163",[1,0.611,2,0.611,415,2.883,3012,0.86,3045,4.966]],["name/4164",[3048,84.686]],["parent/4164",[1,0.611,2,0.611,415,2.883,3012,0.86,3045,4.966]],["name/4165",[3049,84.686]],["parent/4165",[1,0.611,2,0.611,415,2.883,3012,0.86,3045,4.966]],["name/4166",[3050,84.686]],["parent/4166",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4167",[279,32.637]],["parent/4167",[1,0.611,2,0.611,415,2.883,3012,0.86,3051,6.027]],["name/4168",[3052,84.686]],["parent/4168",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4169",[279,32.637]],["parent/4169",[1,0.611,2,0.611,415,2.883,3012,0.86,3053,6.027]],["name/4170",[3054,84.686]],["parent/4170",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4171",[279,32.637]],["parent/4171",[1,0.611,2,0.611,415,2.883,3012,0.86,3055,6.027]],["name/4172",[3056,84.686]],["parent/4172",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4173",[279,32.637]],["parent/4173",[1,0.611,2,0.611,415,2.883,3012,0.86,3057,6.027]],["name/4174",[3058,84.686]],["parent/4174",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4175",[279,32.637]],["parent/4175",[1,0.611,2,0.611,415,2.883,3012,0.86,3059,6.027]],["name/4176",[3060,84.686]],["parent/4176",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4177",[279,32.637]],["parent/4177",[1,0.611,2,0.611,415,2.883,3012,0.86,3061,6.027]],["name/4178",[3062,84.686]],["parent/4178",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4179",[279,32.637]],["parent/4179",[1,0.611,2,0.611,415,2.883,3012,0.86,3063,6.027]],["name/4180",[3064,84.686]],["parent/4180",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4181",[279,32.637]],["parent/4181",[1,0.611,2,0.611,415,2.883,3012,0.86,3065,6.027]],["name/4182",[3066,84.686]],["parent/4182",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4183",[279,32.637]],["parent/4183",[1,0.611,2,0.611,415,2.883,3012,0.86,3067,6.027]],["name/4184",[3068,84.686]],["parent/4184",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4185",[279,32.637]],["parent/4185",[1,0.611,2,0.611,415,2.883,3012,0.86,3069,6.027]],["name/4186",[3070,84.686]],["parent/4186",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4187",[279,32.637]],["parent/4187",[1,0.611,2,0.611,415,2.883,3012,0.86,3071,6.027]],["name/4188",[3072,84.686]],["parent/4188",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4189",[279,32.637]],["parent/4189",[1,0.611,2,0.611,415,2.883,3012,0.86,3073,6.027]],["name/4190",[3074,84.686]],["parent/4190",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4191",[3075,84.686]],["parent/4191",[1,0.611,2,0.611,415,2.883,3012,0.86,3076,5.232]],["name/4192",[1173,79.491]],["parent/4192",[1,0.611,2,0.611,415,2.883,3012,0.86,3076,5.232]],["name/4193",[3077,84.686]],["parent/4193",[1,0.611,2,0.611,415,2.883,3012,0.86,3076,5.232]],["name/4194",[3078,84.686]],["parent/4194",[1,0.611,2,0.611,415,2.883,3012,0.86,3076,5.232]],["name/4195",[3079,84.686]],["parent/4195",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4196",[3080,84.686]],["parent/4196",[1,0.611,2,0.611,415,2.883,3012,0.86,3081,4.862]],["name/4197",[3082,84.686]],["parent/4197",[1,0.611,2,0.611,415,2.883,3012,0.86,3081,4.862]],["name/4198",[3083,84.686]],["parent/4198",[1,0.611,2,0.611,415,2.883,3012,0.86,3081,4.862]],["name/4199",[3084,84.686]],["parent/4199",[1,0.611,2,0.611,415,2.883,3012,0.86,3081,4.862]],["name/4200",[3085,84.686]],["parent/4200",[1,0.611,2,0.611,415,2.883,3012,0.86,3081,4.862]],["name/4201",[3086,76.069]],["parent/4201",[1,0.611,2,0.611,415,2.883,3012,0.86,3081,4.862]],["name/4202",[3087,84.686]],["parent/4202",[1,0.611,2,0.611,415,2.883,3012,0.86,3081,4.862]],["name/4203",[3088,84.686]],["parent/4203",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4204",[3089,84.686]],["parent/4204",[1,0.611,2,0.611,415,2.883,3012,0.86,3090,4.691]],["name/4205",[3091,84.686]],["parent/4205",[1,0.611,2,0.611,415,2.883,3012,0.86,3090,4.691]],["name/4206",[3092,84.686]],["parent/4206",[1,0.611,2,0.611,415,2.883,3012,0.86,3090,4.691]],["name/4207",[3093,84.686]],["parent/4207",[1,0.611,2,0.611,415,2.883,3012,0.86,3090,4.691]],["name/4208",[3094,84.686]],["parent/4208",[1,0.611,2,0.611,415,2.883,3012,0.86,3090,4.691]],["name/4209",[3095,84.686]],["parent/4209",[1,0.611,2,0.611,415,2.883,3012,0.86,3090,4.691]],["name/4210",[3096,84.686]],["parent/4210",[1,0.611,2,0.611,415,2.883,3012,0.86,3090,4.691]],["name/4211",[2830,71.473]],["parent/4211",[1,0.611,2,0.611,415,2.883,3012,0.86,3090,4.691]],["name/4212",[3097,84.686]],["parent/4212",[1,0.611,2,0.611,415,2.883,3012,0.86,3090,4.691]],["name/4213",[3098,84.686]],["parent/4213",[1,0.611,2,0.611,3,2.113,415,2.883,3012,0.86]],["name/4214",[3099,84.686]],["parent/4214",[1,0.611,2,0.611,415,2.883,3012,0.86,3100,4.862]],["name/4215",[3101,84.686]],["parent/4215",[1,0.611,2,0.611,415,2.883,3012,0.86,3100,4.862]],["name/4216",[3102,84.686]],["parent/4216",[1,0.611,2,0.611,415,2.883,3012,0.86,3100,4.862]],["name/4217",[3086,76.069]],["parent/4217",[1,0.611,2,0.611,415,2.883,3012,0.86,3100,4.862]],["name/4218",[3103,84.686]],["parent/4218",[1,0.611,2,0.611,415,2.883,3012,0.86,3100,4.862]],["name/4219",[3104,84.686]],["parent/4219",[1,0.611,2,0.611,415,2.883,3012,0.86,3100,4.862]],["name/4220",[3105,84.686]],["parent/4220",[1,0.611,2,0.611,415,2.883,3012,0.86,3100,4.862]],["name/4221",[1,3.307,2,3.307,3,11.438,3012,4.654,3106,8.803]],["parent/4221",[]],["name/4222",[3107,84.686]],["parent/4222",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4223",[1032,63.123]],["parent/4223",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4224",[3109,84.686]],["parent/4224",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4225",[3110,84.686]],["parent/4225",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4226",[3111,84.686]],["parent/4226",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4227",[3112,84.686]],["parent/4227",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4228",[3113,84.686]],["parent/4228",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4229",[3114,84.686]],["parent/4229",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4230",[3115,84.686]],["parent/4230",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4231",[3116,84.686]],["parent/4231",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4232",[3117,84.686]],["parent/4232",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4233",[3118,84.686]],["parent/4233",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4234",[3119,84.686]],["parent/4234",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4235",[3120,84.686]],["parent/4235",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4236",[3121,84.686]],["parent/4236",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4237",[3122,84.686]],["parent/4237",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4238",[3123,84.686]],["parent/4238",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4239",[3124,84.686]],["parent/4239",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4240",[3125,84.686]],["parent/4240",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4241",[3126,84.686]],["parent/4241",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4242",[3127,84.686]],["parent/4242",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4243",[3128,84.686]],["parent/4243",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4244",[3129,84.686]],["parent/4244",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4245",[3130,84.686]],["parent/4245",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4246",[3131,84.686]],["parent/4246",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4247",[3132,84.686]],["parent/4247",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4248",[3133,84.686]],["parent/4248",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4249",[3134,84.686]],["parent/4249",[1,0.611,2,0.611,3012,0.86,3106,1.627,3108,3.922]],["name/4250",[3135,84.686]],["parent/4250",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4251",[3136,84.686]],["parent/4251",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4252",[279,32.637]],["parent/4252",[1,0.611,2,0.611,3012,0.86,3106,1.627,3138,6.027]],["name/4253",[3139,84.686]],["parent/4253",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4254",[279,32.637]],["parent/4254",[1,0.611,2,0.611,3012,0.86,3106,1.627,3140,6.027]],["name/4255",[3141,84.686]],["parent/4255",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4256",[279,32.637]],["parent/4256",[1,0.611,2,0.611,3012,0.86,3106,1.627,3142,6.027]],["name/4257",[3143,84.686]],["parent/4257",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4258",[279,32.637]],["parent/4258",[1,0.611,2,0.611,3012,0.86,3106,1.627,3144,6.027]],["name/4259",[3145,84.686]],["parent/4259",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4260",[279,32.637]],["parent/4260",[1,0.611,2,0.611,3012,0.86,3106,1.627,3146,6.027]],["name/4261",[3147,84.686]],["parent/4261",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4262",[279,32.637]],["parent/4262",[1,0.611,2,0.611,3012,0.86,3106,1.627,3148,6.027]],["name/4263",[3149,84.686]],["parent/4263",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4264",[279,32.637]],["parent/4264",[1,0.611,2,0.611,3012,0.86,3106,1.627,3150,6.027]],["name/4265",[3151,84.686]],["parent/4265",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4266",[279,32.637]],["parent/4266",[1,0.611,2,0.611,3012,0.86,3106,1.627,3152,6.027]],["name/4267",[3153,84.686]],["parent/4267",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4268",[279,32.637]],["parent/4268",[1,0.611,2,0.611,3012,0.86,3106,1.627,3154,6.027]],["name/4269",[3155,84.686]],["parent/4269",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4270",[279,32.637]],["parent/4270",[1,0.611,2,0.611,3012,0.86,3106,1.627,3156,6.027]],["name/4271",[3157,84.686]],["parent/4271",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4272",[279,32.637]],["parent/4272",[1,0.611,2,0.611,3012,0.86,3106,1.627,3158,6.027]],["name/4273",[3159,84.686]],["parent/4273",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4274",[279,32.637]],["parent/4274",[1,0.611,2,0.611,3012,0.86,3106,1.627,3160,6.027]],["name/4275",[3161,84.686]],["parent/4275",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4276",[279,32.637]],["parent/4276",[1,0.611,2,0.611,3012,0.86,3106,1.627,3162,6.027]],["name/4277",[3163,84.686]],["parent/4277",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4278",[279,32.637]],["parent/4278",[1,0.611,2,0.611,3012,0.86,3106,1.627,3164,6.027]],["name/4279",[3165,84.686]],["parent/4279",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4280",[279,32.637]],["parent/4280",[1,0.611,2,0.611,3012,0.86,3106,1.627,3166,6.027]],["name/4281",[3167,84.686]],["parent/4281",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4282",[279,32.637]],["parent/4282",[1,0.611,2,0.611,3012,0.86,3106,1.627,3168,6.027]],["name/4283",[3169,84.686]],["parent/4283",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4284",[279,32.637]],["parent/4284",[1,0.611,2,0.611,3012,0.86,3106,1.627,3170,6.027]],["name/4285",[3171,84.686]],["parent/4285",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4286",[279,32.637]],["parent/4286",[1,0.611,2,0.611,3012,0.86,3106,1.627,3172,6.027]],["name/4287",[3173,84.686]],["parent/4287",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4288",[279,32.637]],["parent/4288",[1,0.611,2,0.611,3012,0.86,3106,1.627,3174,6.027]],["name/4289",[3175,84.686]],["parent/4289",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4290",[279,32.637]],["parent/4290",[1,0.611,2,0.611,3012,0.86,3106,1.627,3176,6.027]],["name/4291",[3177,84.686]],["parent/4291",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4292",[279,32.637]],["parent/4292",[1,0.611,2,0.611,3012,0.86,3106,1.627,3178,6.027]],["name/4293",[3179,84.686]],["parent/4293",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4294",[279,32.637]],["parent/4294",[1,0.611,2,0.611,3012,0.86,3106,1.627,3180,6.027]],["name/4295",[3181,84.686]],["parent/4295",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4296",[279,32.637]],["parent/4296",[1,0.611,2,0.611,3012,0.86,3106,1.627,3182,6.027]],["name/4297",[3183,84.686]],["parent/4297",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4298",[279,32.637]],["parent/4298",[1,0.611,2,0.611,3012,0.86,3106,1.627,3184,6.027]],["name/4299",[3185,84.686]],["parent/4299",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4300",[279,32.637]],["parent/4300",[1,0.611,2,0.611,3012,0.86,3106,1.627,3186,6.027]],["name/4301",[3187,84.686]],["parent/4301",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4302",[279,32.637]],["parent/4302",[1,0.611,2,0.611,3012,0.86,3106,1.627,3188,6.027]],["name/4303",[3189,84.686]],["parent/4303",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4304",[279,32.637]],["parent/4304",[1,0.611,2,0.611,3012,0.86,3106,1.627,3190,6.027]],["name/4305",[3191,84.686]],["parent/4305",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4306",[279,32.637]],["parent/4306",[1,0.611,2,0.611,3012,0.86,3106,1.627,3192,6.027]],["name/4307",[3193,84.686]],["parent/4307",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4308",[279,32.637]],["parent/4308",[1,0.611,2,0.611,3012,0.86,3106,1.627,3194,6.027]],["name/4309",[3195,84.686]],["parent/4309",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4310",[279,32.637]],["parent/4310",[1,0.611,2,0.611,3012,0.86,3106,1.627,3196,6.027]],["name/4311",[3197,84.686]],["parent/4311",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4312",[279,32.637]],["parent/4312",[1,0.611,2,0.611,3012,0.86,3106,1.627,3198,6.027]],["name/4313",[3199,84.686]],["parent/4313",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4314",[279,32.637]],["parent/4314",[1,0.611,2,0.611,3012,0.86,3106,1.627,3200,6.027]],["name/4315",[3201,84.686]],["parent/4315",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4316",[279,32.637]],["parent/4316",[1,0.611,2,0.611,3012,0.86,3106,1.627,3202,6.027]],["name/4317",[3203,84.686]],["parent/4317",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4318",[279,32.637]],["parent/4318",[1,0.611,2,0.611,3012,0.86,3106,1.627,3204,6.027]],["name/4319",[3205,84.686]],["parent/4319",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4320",[279,32.637]],["parent/4320",[1,0.611,2,0.611,3012,0.86,3106,1.627,3206,6.027]],["name/4321",[3207,84.686]],["parent/4321",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4322",[279,32.637]],["parent/4322",[1,0.611,2,0.611,3012,0.86,3106,1.627,3208,6.027]],["name/4323",[3209,84.686]],["parent/4323",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4324",[279,32.637]],["parent/4324",[1,0.611,2,0.611,3012,0.86,3106,1.627,3210,6.027]],["name/4325",[3211,84.686]],["parent/4325",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4326",[279,32.637]],["parent/4326",[1,0.611,2,0.611,3012,0.86,3106,1.627,3212,6.027]],["name/4327",[3213,84.686]],["parent/4327",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4328",[279,32.637]],["parent/4328",[1,0.611,2,0.611,3012,0.86,3106,1.627,3214,6.027]],["name/4329",[3215,84.686]],["parent/4329",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4330",[279,32.637]],["parent/4330",[1,0.611,2,0.611,3012,0.86,3106,1.627,3216,6.027]],["name/4331",[3217,84.686]],["parent/4331",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4332",[279,32.637]],["parent/4332",[1,0.611,2,0.611,3012,0.86,3106,1.627,3218,6.027]],["name/4333",[3219,84.686]],["parent/4333",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4334",[279,32.637]],["parent/4334",[1,0.611,2,0.611,3012,0.86,3106,1.627,3220,6.027]],["name/4335",[3221,84.686]],["parent/4335",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4336",[279,32.637]],["parent/4336",[1,0.611,2,0.611,3012,0.86,3106,1.627,3222,6.027]],["name/4337",[3223,84.686]],["parent/4337",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4338",[279,32.637]],["parent/4338",[1,0.611,2,0.611,3012,0.86,3106,1.627,3224,6.027]],["name/4339",[3225,84.686]],["parent/4339",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4340",[279,32.637]],["parent/4340",[1,0.611,2,0.611,3012,0.86,3106,1.627,3226,6.027]],["name/4341",[3227,84.686]],["parent/4341",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4342",[279,32.637]],["parent/4342",[1,0.611,2,0.611,3012,0.86,3106,1.627,3228,6.027]],["name/4343",[3229,84.686]],["parent/4343",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4344",[279,32.637]],["parent/4344",[1,0.611,2,0.611,3012,0.86,3106,1.627,3230,6.027]],["name/4345",[3231,84.686]],["parent/4345",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4346",[279,32.637]],["parent/4346",[1,0.611,2,0.611,3012,0.86,3106,1.627,3232,6.027]],["name/4347",[3233,84.686]],["parent/4347",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4348",[279,32.637]],["parent/4348",[1,0.611,2,0.611,3012,0.86,3106,1.627,3234,6.027]],["name/4349",[3235,84.686]],["parent/4349",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4350",[279,32.637]],["parent/4350",[1,0.611,2,0.611,3012,0.86,3106,1.627,3236,6.027]],["name/4351",[3237,84.686]],["parent/4351",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4352",[279,32.637]],["parent/4352",[1,0.611,2,0.611,3012,0.86,3106,1.627,3238,6.027]],["name/4353",[3239,84.686]],["parent/4353",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4354",[279,32.637]],["parent/4354",[1,0.611,2,0.611,3012,0.86,3106,1.627,3240,6.027]],["name/4355",[3241,84.686]],["parent/4355",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4356",[279,32.637]],["parent/4356",[1,0.611,2,0.611,3012,0.86,3106,1.627,3242,6.027]],["name/4357",[3243,84.686]],["parent/4357",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4358",[279,32.637]],["parent/4358",[1,0.611,2,0.611,3012,0.86,3106,1.627,3244,6.027]],["name/4359",[3245,84.686]],["parent/4359",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4360",[279,32.637]],["parent/4360",[1,0.611,2,0.611,3012,0.86,3106,1.627,3246,6.027]],["name/4361",[3247,84.686]],["parent/4361",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4362",[279,32.637]],["parent/4362",[1,0.611,2,0.611,3012,0.86,3106,1.627,3248,6.027]],["name/4363",[3249,84.686]],["parent/4363",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4364",[279,32.637]],["parent/4364",[1,0.611,2,0.611,3012,0.86,3106,1.627,3250,6.027]],["name/4365",[3251,84.686]],["parent/4365",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4366",[279,32.637]],["parent/4366",[1,0.611,2,0.611,3012,0.86,3106,1.627,3252,6.027]],["name/4367",[3253,84.686]],["parent/4367",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4368",[279,32.637]],["parent/4368",[1,0.611,2,0.611,3012,0.86,3106,1.627,3254,6.027]],["name/4369",[3255,84.686]],["parent/4369",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4370",[279,32.637]],["parent/4370",[1,0.611,2,0.611,3012,0.86,3106,1.627,3256,6.027]],["name/4371",[3257,84.686]],["parent/4371",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4372",[279,32.637]],["parent/4372",[1,0.611,2,0.611,3012,0.86,3106,1.627,3258,6.027]],["name/4373",[3259,84.686]],["parent/4373",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4374",[279,32.637]],["parent/4374",[1,0.611,2,0.611,3012,0.86,3106,1.627,3260,6.027]],["name/4375",[3261,84.686]],["parent/4375",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4376",[279,32.637]],["parent/4376",[1,0.611,2,0.611,3012,0.86,3106,1.627,3262,6.027]],["name/4377",[3263,84.686]],["parent/4377",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4378",[279,32.637]],["parent/4378",[1,0.611,2,0.611,3012,0.86,3106,1.627,3264,6.027]],["name/4379",[3265,84.686]],["parent/4379",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4380",[279,32.637]],["parent/4380",[1,0.611,2,0.611,3012,0.86,3106,1.627,3266,6.027]],["name/4381",[3267,84.686]],["parent/4381",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4382",[279,32.637]],["parent/4382",[1,0.611,2,0.611,3012,0.86,3106,1.627,3268,6.027]],["name/4383",[3269,84.686]],["parent/4383",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4384",[279,32.637]],["parent/4384",[1,0.611,2,0.611,3012,0.86,3106,1.627,3270,6.027]],["name/4385",[3271,84.686]],["parent/4385",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4386",[279,32.637]],["parent/4386",[1,0.611,2,0.611,3012,0.86,3106,1.627,3272,6.027]],["name/4387",[3273,84.686]],["parent/4387",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4388",[279,32.637]],["parent/4388",[1,0.611,2,0.611,3012,0.86,3106,1.627,3274,6.027]],["name/4389",[3275,84.686]],["parent/4389",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4390",[279,32.637]],["parent/4390",[1,0.611,2,0.611,3012,0.86,3106,1.627,3276,6.027]],["name/4391",[3277,84.686]],["parent/4391",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4392",[279,32.637]],["parent/4392",[1,0.611,2,0.611,3012,0.86,3106,1.627,3278,6.027]],["name/4393",[3279,84.686]],["parent/4393",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4394",[279,32.637]],["parent/4394",[1,0.611,2,0.611,3012,0.86,3106,1.627,3280,6.027]],["name/4395",[3281,84.686]],["parent/4395",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4396",[279,32.637]],["parent/4396",[1,0.611,2,0.611,3012,0.86,3106,1.627,3282,6.027]],["name/4397",[3283,84.686]],["parent/4397",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4398",[279,32.637]],["parent/4398",[1,0.611,2,0.611,3012,0.86,3106,1.627,3284,6.027]],["name/4399",[3285,84.686]],["parent/4399",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4400",[279,32.637]],["parent/4400",[1,0.611,2,0.611,3012,0.86,3106,1.627,3286,6.027]],["name/4401",[3287,84.686]],["parent/4401",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4402",[279,32.637]],["parent/4402",[1,0.611,2,0.611,3012,0.86,3106,1.627,3288,6.027]],["name/4403",[3289,84.686]],["parent/4403",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4404",[279,32.637]],["parent/4404",[1,0.611,2,0.611,3012,0.86,3106,1.627,3290,6.027]],["name/4405",[3291,84.686]],["parent/4405",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4406",[279,32.637]],["parent/4406",[1,0.611,2,0.611,3012,0.86,3106,1.627,3292,6.027]],["name/4407",[3293,84.686]],["parent/4407",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4408",[279,32.637]],["parent/4408",[1,0.611,2,0.611,3012,0.86,3106,1.627,3294,6.027]],["name/4409",[3295,84.686]],["parent/4409",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4410",[279,32.637]],["parent/4410",[1,0.611,2,0.611,3012,0.86,3106,1.627,3296,6.027]],["name/4411",[3297,84.686]],["parent/4411",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4412",[279,32.637]],["parent/4412",[1,0.611,2,0.611,3012,0.86,3106,1.627,3298,6.027]],["name/4413",[3299,84.686]],["parent/4413",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4414",[279,32.637]],["parent/4414",[1,0.611,2,0.611,3012,0.86,3106,1.627,3300,6.027]],["name/4415",[3301,84.686]],["parent/4415",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4416",[279,32.637]],["parent/4416",[1,0.611,2,0.611,3012,0.86,3106,1.627,3302,6.027]],["name/4417",[3303,84.686]],["parent/4417",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4418",[279,32.637]],["parent/4418",[1,0.611,2,0.611,3012,0.86,3106,1.627,3304,6.027]],["name/4419",[3305,84.686]],["parent/4419",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4420",[279,32.637]],["parent/4420",[1,0.611,2,0.611,3012,0.86,3106,1.627,3306,6.027]],["name/4421",[3307,84.686]],["parent/4421",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4422",[279,32.637]],["parent/4422",[1,0.611,2,0.611,3012,0.86,3106,1.627,3308,6.027]],["name/4423",[3309,84.686]],["parent/4423",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4424",[279,32.637]],["parent/4424",[1,0.611,2,0.611,3012,0.86,3106,1.627,3310,6.027]],["name/4425",[3311,84.686]],["parent/4425",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4426",[279,32.637]],["parent/4426",[1,0.611,2,0.611,3012,0.86,3106,1.627,3312,6.027]],["name/4427",[3313,84.686]],["parent/4427",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4428",[279,32.637]],["parent/4428",[1,0.611,2,0.611,3012,0.86,3106,1.627,3314,6.027]],["name/4429",[3315,84.686]],["parent/4429",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4430",[279,32.637]],["parent/4430",[1,0.611,2,0.611,3012,0.86,3106,1.627,3316,6.027]],["name/4431",[3317,84.686]],["parent/4431",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4432",[279,32.637]],["parent/4432",[1,0.611,2,0.611,3012,0.86,3106,1.627,3318,6.027]],["name/4433",[3319,84.686]],["parent/4433",[1,0.611,2,0.611,3012,0.86,3106,1.627,3137,3.044]],["name/4434",[279,32.637]],["parent/4434",[1,0.611,2,0.611,3012,0.86,3106,1.627,3320,6.027]],["name/4435",[3321,84.686]],["parent/4435",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4436",[3322,84.686]],["parent/4436",[1,0.611,2,0.611,3012,0.86,3106,1.627,3323,5.657]],["name/4437",[3324,79.491]],["parent/4437",[1,0.611,2,0.611,3012,0.86,3106,1.627,3323,5.657]],["name/4438",[3325,84.686]],["parent/4438",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4439",[3326,56.704]],["parent/4439",[1,0.611,2,0.611,3012,0.86,3106,1.627,3327,6.027]],["name/4440",[3328,84.686]],["parent/4440",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4441",[3329,64.897]],["parent/4441",[1,0.611,2,0.611,3012,0.86,3106,1.627,3330,4.862]],["name/4442",[3331,67.046]],["parent/4442",[1,0.611,2,0.611,3012,0.86,3106,1.627,3330,4.862]],["name/4443",[160,69.774]],["parent/4443",[1,0.611,2,0.611,3012,0.86,3106,1.627,3330,4.862]],["name/4444",[3332,73.514]],["parent/4444",[1,0.611,2,0.611,3012,0.86,3106,1.627,3330,4.862]],["name/4445",[3333,68.319]],["parent/4445",[1,0.611,2,0.611,3012,0.86,3106,1.627,3330,4.862]],["name/4446",[982,64.897]],["parent/4446",[1,0.611,2,0.611,3012,0.86,3106,1.627,3330,4.862]],["name/4447",[3326,56.704]],["parent/4447",[1,0.611,2,0.611,3012,0.86,3106,1.627,3330,4.862]],["name/4448",[1030,79.491]],["parent/4448",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4449",[1031,79.491]],["parent/4449",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4450",[1032,63.123]],["parent/4450",[1,0.611,2,0.611,3012,0.86,3106,1.627,3334,4.691]],["name/4451",[1034,79.491]],["parent/4451",[1,0.611,2,0.611,3012,0.86,3106,1.627,3334,4.691]],["name/4452",[1035,76.069]],["parent/4452",[1,0.611,2,0.611,3012,0.86,3106,1.627,3334,4.691]],["name/4453",[1036,76.069]],["parent/4453",[1,0.611,2,0.611,3012,0.86,3106,1.627,3334,4.691]],["name/4454",[1037,76.069]],["parent/4454",[1,0.611,2,0.611,3012,0.86,3106,1.627,3334,4.691]],["name/4455",[1038,76.069]],["parent/4455",[1,0.611,2,0.611,3012,0.86,3106,1.627,3334,4.691]],["name/4456",[1039,76.069]],["parent/4456",[1,0.611,2,0.611,3012,0.86,3106,1.627,3334,4.691]],["name/4457",[1040,76.069]],["parent/4457",[1,0.611,2,0.611,3012,0.86,3106,1.627,3334,4.691]],["name/4458",[982,64.897]],["parent/4458",[1,0.611,2,0.611,3012,0.86,3106,1.627,3334,4.691]],["name/4459",[1098,79.491]],["parent/4459",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4460",[1099,73.514]],["parent/4460",[1,0.611,2,0.611,3012,0.86,3106,1.627,3335,4.862]],["name/4461",[1101,73.514]],["parent/4461",[1,0.611,2,0.611,3012,0.86,3106,1.627,3335,4.862]],["name/4462",[122,56.704]],["parent/4462",[1,0.611,2,0.611,3012,0.86,3106,1.627,3335,4.862]],["name/4463",[1102,73.514]],["parent/4463",[1,0.611,2,0.611,3012,0.86,3106,1.627,3335,4.862]],["name/4464",[1004,63.123]],["parent/4464",[1,0.611,2,0.611,3012,0.86,3106,1.627,3335,4.862]],["name/4465",[1095,71.473]],["parent/4465",[1,0.611,2,0.611,3012,0.86,3106,1.627,3335,4.862]],["name/4466",[163,53.406]],["parent/4466",[1,0.611,2,0.611,3012,0.86,3106,1.627,3335,4.862]],["name/4467",[3336,84.686]],["parent/4467",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4468",[189,39.191]],["parent/4468",[1,0.611,2,0.611,3012,0.86,3106,1.627,3337,4.966]],["name/4469",[100,73.514]],["parent/4469",[1,0.611,2,0.611,3012,0.86,3106,1.627,3337,4.966]],["name/4470",[3338,76.069]],["parent/4470",[1,0.611,2,0.611,3012,0.86,3106,1.627,3337,4.966]],["name/4471",[3339,84.686]],["parent/4471",[1,0.611,2,0.611,3012,0.86,3106,1.627,3337,4.966]],["name/4472",[261,58.092]],["parent/4472",[1,0.611,2,0.611,3012,0.86,3106,1.627,3337,4.966]],["name/4473",[3340,84.686]],["parent/4473",[1,0.611,2,0.611,3012,0.86,3106,1.627,3337,4.966]],["name/4474",[3341,84.686]],["parent/4474",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4475",[1644,63.123]],["parent/4475",[1,0.611,2,0.611,3012,0.86,3106,1.627,3342,5.232]],["name/4476",[1670,69.774]],["parent/4476",[1,0.611,2,0.611,3012,0.86,3106,1.627,3342,5.232]],["name/4477",[3343,79.491]],["parent/4477",[1,0.611,2,0.611,3012,0.86,3106,1.627,3342,5.232]],["name/4478",[3344,79.491]],["parent/4478",[1,0.611,2,0.611,3012,0.86,3106,1.627,3342,5.232]],["name/4479",[3345,84.686]],["parent/4479",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4480",[3346,84.686]],["parent/4480",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4481",[3347,84.686]],["parent/4481",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4482",[3349,84.686]],["parent/4482",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4483",[3350,65.914]],["parent/4483",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4484",[3351,67.046]],["parent/4484",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4485",[3352,65.914]],["parent/4485",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4486",[3353,79.491]],["parent/4486",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4487",[3354,71.473]],["parent/4487",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4488",[3355,84.686]],["parent/4488",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4489",[92,65.914]],["parent/4489",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4490",[3356,69.774]],["parent/4490",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4491",[95,64.897]],["parent/4491",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4492",[3357,76.069]],["parent/4492",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4493",[3358,76.069]],["parent/4493",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4494",[3359,76.069]],["parent/4494",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4495",[3360,84.686]],["parent/4495",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4496",[3361,79.491]],["parent/4496",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4497",[3338,76.069]],["parent/4497",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4498",[3326,56.704]],["parent/4498",[1,0.611,2,0.611,3012,0.86,3106,1.627,3348,4.209]],["name/4499",[3362,84.686]],["parent/4499",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4500",[123,37.886]],["parent/4500",[1,0.611,2,0.611,3012,0.86,3106,1.627,3363,5.414]],["name/4501",[100,73.514]],["parent/4501",[1,0.611,2,0.611,3012,0.86,3106,1.627,3363,5.414]],["name/4502",[3326,56.704]],["parent/4502",[1,0.611,2,0.611,3012,0.86,3106,1.627,3363,5.414]],["name/4503",[3364,84.686]],["parent/4503",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4504",[3350,65.914]],["parent/4504",[1,0.611,2,0.611,3012,0.86,3106,1.627,3365,4.492]],["name/4505",[3351,67.046]],["parent/4505",[1,0.611,2,0.611,3012,0.86,3106,1.627,3365,4.492]],["name/4506",[3352,65.914]],["parent/4506",[1,0.611,2,0.611,3012,0.86,3106,1.627,3365,4.492]],["name/4507",[3353,79.491]],["parent/4507",[1,0.611,2,0.611,3012,0.86,3106,1.627,3365,4.492]],["name/4508",[3366,79.491]],["parent/4508",[1,0.611,2,0.611,3012,0.86,3106,1.627,3365,4.492]],["name/4509",[3357,76.069]],["parent/4509",[1,0.611,2,0.611,3012,0.86,3106,1.627,3365,4.492]],["name/4510",[3358,76.069]],["parent/4510",[1,0.611,2,0.611,3012,0.86,3106,1.627,3365,4.492]],["name/4511",[3359,76.069]],["parent/4511",[1,0.611,2,0.611,3012,0.86,3106,1.627,3365,4.492]],["name/4512",[3367,84.686]],["parent/4512",[1,0.611,2,0.611,3012,0.86,3106,1.627,3365,4.492]],["name/4513",[3368,84.686]],["parent/4513",[1,0.611,2,0.611,3012,0.86,3106,1.627,3365,4.492]],["name/4514",[3361,79.491]],["parent/4514",[1,0.611,2,0.611,3012,0.86,3106,1.627,3365,4.492]],["name/4515",[3326,56.704]],["parent/4515",[1,0.611,2,0.611,3012,0.86,3106,1.627,3365,4.492]],["name/4516",[3369,84.686]],["parent/4516",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4517",[2839,60.3]],["parent/4517",[1,0.611,2,0.611,3012,0.86,3106,1.627,3370,4.553]],["name/4518",[192,48.337]],["parent/4518",[1,0.611,2,0.611,3012,0.86,3106,1.627,3370,4.553]],["name/4519",[3371,84.686]],["parent/4519",[1,0.611,2,0.611,3012,0.86,3106,1.627,3370,4.553]],["name/4520",[3372,84.686]],["parent/4520",[1,0.611,2,0.611,3012,0.86,3106,1.627,3370,4.553]],["name/4521",[3373,84.686]],["parent/4521",[1,0.611,2,0.611,3012,0.86,3106,1.627,3370,4.553]],["name/4522",[3357,76.069]],["parent/4522",[1,0.611,2,0.611,3012,0.86,3106,1.627,3370,4.553]],["name/4523",[3358,76.069]],["parent/4523",[1,0.611,2,0.611,3012,0.86,3106,1.627,3370,4.553]],["name/4524",[3359,76.069]],["parent/4524",[1,0.611,2,0.611,3012,0.86,3106,1.627,3370,4.553]],["name/4525",[3366,79.491]],["parent/4525",[1,0.611,2,0.611,3012,0.86,3106,1.627,3370,4.553]],["name/4526",[3374,69.774]],["parent/4526",[1,0.611,2,0.611,3012,0.86,3106,1.627,3370,4.553]],["name/4527",[3326,56.704]],["parent/4527",[1,0.611,2,0.611,3012,0.86,3106,1.627,3370,4.553]],["name/4528",[3375,84.686]],["parent/4528",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4529",[3376,84.686]],["parent/4529",[1,0.611,2,0.611,3012,0.86,3106,1.627,3377,5.657]],["name/4530",[3378,84.686]],["parent/4530",[1,0.611,2,0.611,3012,0.86,3106,1.627,3379,4.966]],["name/4531",[3351,67.046]],["parent/4531",[1,0.611,2,0.611,3012,0.86,3106,1.627,3380,4.862]],["name/4532",[3350,65.914]],["parent/4532",[1,0.611,2,0.611,3012,0.86,3106,1.627,3380,4.862]],["name/4533",[3352,65.914]],["parent/4533",[1,0.611,2,0.611,3012,0.86,3106,1.627,3380,4.862]],["name/4534",[3354,71.473]],["parent/4534",[1,0.611,2,0.611,3012,0.86,3106,1.627,3380,4.862]],["name/4535",[92,65.914]],["parent/4535",[1,0.611,2,0.611,3012,0.86,3106,1.627,3380,4.862]],["name/4536",[3356,69.774]],["parent/4536",[1,0.611,2,0.611,3012,0.86,3106,1.627,3380,4.862]],["name/4537",[95,64.897]],["parent/4537",[1,0.611,2,0.611,3012,0.86,3106,1.627,3380,4.862]],["name/4538",[3381,84.686]],["parent/4538",[1,0.611,2,0.611,3012,0.86,3106,1.627,3379,4.966]],["name/4539",[3351,67.046]],["parent/4539",[1,0.611,2,0.611,3012,0.86,3106,1.627,3382,4.966]],["name/4540",[3350,65.914]],["parent/4540",[1,0.611,2,0.611,3012,0.86,3106,1.627,3382,4.966]],["name/4541",[3352,65.914]],["parent/4541",[1,0.611,2,0.611,3012,0.86,3106,1.627,3382,4.966]],["name/4542",[92,65.914]],["parent/4542",[1,0.611,2,0.611,3012,0.86,3106,1.627,3382,4.966]],["name/4543",[3356,69.774]],["parent/4543",[1,0.611,2,0.611,3012,0.86,3106,1.627,3382,4.966]],["name/4544",[95,64.897]],["parent/4544",[1,0.611,2,0.611,3012,0.86,3106,1.627,3382,4.966]],["name/4545",[3383,84.686]],["parent/4545",[1,0.611,2,0.611,3012,0.86,3106,1.627,3379,4.966]],["name/4546",[3351,67.046]],["parent/4546",[1,0.611,2,0.611,3012,0.86,3106,1.627,3384,4.862]],["name/4547",[3350,65.914]],["parent/4547",[1,0.611,2,0.611,3012,0.86,3106,1.627,3384,4.862]],["name/4548",[3352,65.914]],["parent/4548",[1,0.611,2,0.611,3012,0.86,3106,1.627,3384,4.862]],["name/4549",[92,65.914]],["parent/4549",[1,0.611,2,0.611,3012,0.86,3106,1.627,3384,4.862]],["name/4550",[3356,69.774]],["parent/4550",[1,0.611,2,0.611,3012,0.86,3106,1.627,3384,4.862]],["name/4551",[95,64.897]],["parent/4551",[1,0.611,2,0.611,3012,0.86,3106,1.627,3384,4.862]],["name/4552",[3354,71.473]],["parent/4552",[1,0.611,2,0.611,3012,0.86,3106,1.627,3384,4.862]],["name/4553",[3385,84.686]],["parent/4553",[1,0.611,2,0.611,3012,0.86,3106,1.627,3379,4.966]],["name/4554",[3350,65.914]],["parent/4554",[1,0.611,2,0.611,3012,0.86,3106,1.627,3386,4.862]],["name/4555",[3351,67.046]],["parent/4555",[1,0.611,2,0.611,3012,0.86,3106,1.627,3386,4.862]],["name/4556",[3352,65.914]],["parent/4556",[1,0.611,2,0.611,3012,0.86,3106,1.627,3386,4.862]],["name/4557",[92,65.914]],["parent/4557",[1,0.611,2,0.611,3012,0.86,3106,1.627,3386,4.862]],["name/4558",[3356,69.774]],["parent/4558",[1,0.611,2,0.611,3012,0.86,3106,1.627,3386,4.862]],["name/4559",[95,64.897]],["parent/4559",[1,0.611,2,0.611,3012,0.86,3106,1.627,3386,4.862]],["name/4560",[3354,71.473]],["parent/4560",[1,0.611,2,0.611,3012,0.86,3106,1.627,3386,4.862]],["name/4561",[3329,64.897]],["parent/4561",[1,0.611,2,0.611,3012,0.86,3106,1.627,3379,4.966]],["name/4562",[3350,65.914]],["parent/4562",[1,0.611,2,0.611,3012,0.86,3106,1.627,3387,4.862]],["name/4563",[3351,67.046]],["parent/4563",[1,0.611,2,0.611,3012,0.86,3106,1.627,3387,4.862]],["name/4564",[3352,65.914]],["parent/4564",[1,0.611,2,0.611,3012,0.86,3106,1.627,3387,4.862]],["name/4565",[92,65.914]],["parent/4565",[1,0.611,2,0.611,3012,0.86,3106,1.627,3387,4.862]],["name/4566",[3356,69.774]],["parent/4566",[1,0.611,2,0.611,3012,0.86,3106,1.627,3387,4.862]],["name/4567",[95,64.897]],["parent/4567",[1,0.611,2,0.611,3012,0.86,3106,1.627,3387,4.862]],["name/4568",[3354,71.473]],["parent/4568",[1,0.611,2,0.611,3012,0.86,3106,1.627,3387,4.862]],["name/4569",[3388,84.686]],["parent/4569",[1,0.611,2,0.611,3012,0.86,3106,1.627,3379,4.966]],["name/4570",[3352,65.914]],["parent/4570",[1,0.611,2,0.611,3012,0.86,3106,1.627,3389,6.027]],["name/4571",[3390,76.069]],["parent/4571",[1,0.611,2,0.611,3012,0.86,3106,1.627,3377,5.657]],["name/4572",[3350,65.914]],["parent/4572",[1,0.611,2,0.611,3012,0.86,3106,1.627,3391,5.414]],["name/4573",[3351,67.046]],["parent/4573",[1,0.611,2,0.611,3012,0.86,3106,1.627,3391,5.414]],["name/4574",[3352,65.914]],["parent/4574",[1,0.611,2,0.611,3012,0.86,3106,1.627,3391,5.414]],["name/4575",[3392,84.686]],["parent/4575",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4576",[3393,84.686]],["parent/4576",[1,0.611,2,0.611,3012,0.86,3106,1.627,3394,4.966]],["name/4577",[3395,84.686]],["parent/4577",[1,0.611,2,0.611,3012,0.86,3106,1.627,3394,4.966]],["name/4578",[3396,84.686]],["parent/4578",[1,0.611,2,0.611,3012,0.86,3106,1.627,3394,4.966]],["name/4579",[3397,84.686]],["parent/4579",[1,0.611,2,0.611,3012,0.86,3106,1.627,3394,4.966]],["name/4580",[3398,84.686]],["parent/4580",[1,0.611,2,0.611,3012,0.86,3106,1.627,3394,4.966]],["name/4581",[3399,84.686]],["parent/4581",[1,0.611,2,0.611,3012,0.86,3106,1.627,3394,4.966]],["name/4582",[1881,79.491]],["parent/4582",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4583",[3400,84.686]],["parent/4583",[1,0.611,2,0.611,3012,0.86,3106,1.627,3401,6.027]],["name/4584",[3402,84.686]],["parent/4584",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4585",[3403,79.491]],["parent/4585",[1,0.611,2,0.611,3012,0.86,3106,1.627,3404,5.232]],["name/4586",[3405,76.069]],["parent/4586",[1,0.611,2,0.611,3012,0.86,3106,1.627,3404,5.232]],["name/4587",[982,64.897]],["parent/4587",[1,0.611,2,0.611,3012,0.86,3106,1.627,3404,5.232]],["name/4588",[3326,56.704]],["parent/4588",[1,0.611,2,0.611,3012,0.86,3106,1.627,3404,5.232]],["name/4589",[3406,84.686]],["parent/4589",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4590",[607,67.046]],["parent/4590",[1,0.611,2,0.611,3012,0.86,3106,1.627,3407,5.232]],["name/4591",[3408,84.686]],["parent/4591",[1,0.611,2,0.611,3012,0.86,3106,1.627,3407,5.232]],["name/4592",[3409,73.514]],["parent/4592",[1,0.611,2,0.611,3012,0.86,3106,1.627,3407,5.232]],["name/4593",[3326,56.704]],["parent/4593",[1,0.611,2,0.611,3012,0.86,3106,1.627,3407,5.232]],["name/4594",[3410,84.686]],["parent/4594",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4595",[3333,68.319]],["parent/4595",[1,0.611,2,0.611,3012,0.86,3106,1.627,3411,4.862]],["name/4596",[107,71.473]],["parent/4596",[1,0.611,2,0.611,3012,0.86,3106,1.627,3411,4.862]],["name/4597",[3409,73.514]],["parent/4597",[1,0.611,2,0.611,3012,0.86,3106,1.627,3411,4.862]],["name/4598",[2916,76.069]],["parent/4598",[1,0.611,2,0.611,3012,0.86,3106,1.627,3411,4.862]],["name/4599",[143,71.473]],["parent/4599",[1,0.611,2,0.611,3012,0.86,3106,1.627,3411,4.862]],["name/4600",[315,79.491]],["parent/4600",[1,0.611,2,0.611,3012,0.86,3106,1.627,3411,4.862]],["name/4601",[3326,56.704]],["parent/4601",[1,0.611,2,0.611,3012,0.86,3106,1.627,3411,4.862]],["name/4602",[3412,84.686]],["parent/4602",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4603",[3409,73.514]],["parent/4603",[1,0.611,2,0.611,3012,0.86,3106,1.627,3413,4.492]],["name/4604",[192,48.337]],["parent/4604",[1,0.611,2,0.611,3012,0.86,3106,1.627,3413,4.492]],["name/4605",[261,58.092]],["parent/4605",[1,0.611,2,0.611,3012,0.86,3106,1.627,3413,4.492]],["name/4606",[3414,84.686]],["parent/4606",[1,0.611,2,0.611,3012,0.86,3106,1.627,3413,4.492]],["name/4607",[3338,76.069]],["parent/4607",[1,0.611,2,0.611,3012,0.86,3106,1.627,3413,4.492]],["name/4608",[189,39.191]],["parent/4608",[1,0.611,2,0.611,3012,0.86,3106,1.627,3413,4.492]],["name/4609",[3415,84.686]],["parent/4609",[1,0.611,2,0.611,3012,0.86,3106,1.627,3413,4.492]],["name/4610",[123,37.886]],["parent/4610",[1,0.611,2,0.611,3012,0.86,3106,1.627,3413,4.492]],["name/4611",[742,79.491]],["parent/4611",[1,0.611,2,0.611,3012,0.86,3106,1.627,3413,4.492]],["name/4612",[3416,84.686]],["parent/4612",[1,0.611,2,0.611,3012,0.86,3106,1.627,3413,4.492]],["name/4613",[3417,84.686]],["parent/4613",[1,0.611,2,0.611,3012,0.86,3106,1.627,3413,4.492]],["name/4614",[3326,56.704]],["parent/4614",[1,0.611,2,0.611,3012,0.86,3106,1.627,3413,4.492]],["name/4615",[3418,84.686]],["parent/4615",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4616",[3419,84.686]],["parent/4616",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4617",[3421,84.686]],["parent/4617",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4618",[3422,84.686]],["parent/4618",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4619",[3423,84.686]],["parent/4619",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4620",[3424,84.686]],["parent/4620",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4621",[3425,84.686]],["parent/4621",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4622",[3350,65.914]],["parent/4622",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4623",[3426,84.686]],["parent/4623",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4624",[3427,84.686]],["parent/4624",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4625",[95,64.897]],["parent/4625",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4626",[3428,84.686]],["parent/4626",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4627",[3429,84.686]],["parent/4627",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4628",[3430,84.686]],["parent/4628",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4629",[3431,84.686]],["parent/4629",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4630",[92,65.914]],["parent/4630",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4631",[3432,84.686]],["parent/4631",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4632",[3433,84.686]],["parent/4632",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4633",[3434,84.686]],["parent/4633",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4634",[3435,84.686]],["parent/4634",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4635",[3326,56.704]],["parent/4635",[1,0.611,2,0.611,3012,0.86,3106,1.627,3420,4.134]],["name/4636",[2851,68.319]],["parent/4636",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4637",[3436,84.686]],["parent/4637",[1,0.611,2,0.611,3012,0.86,3106,1.627,3437,4.772]],["name/4638",[3438,79.491]],["parent/4638",[1,0.611,2,0.611,3012,0.86,3106,1.627,3437,4.772]],["name/4639",[3439,63.123]],["parent/4639",[1,0.611,2,0.611,3012,0.86,3106,1.627,3437,4.772]],["name/4640",[3440,84.686]],["parent/4640",[1,0.611,2,0.611,3012,0.86,3106,1.627,3437,4.772]],["name/4641",[3441,73.514]],["parent/4641",[1,0.611,2,0.611,3012,0.86,3106,1.627,3437,4.772]],["name/4642",[3442,84.686]],["parent/4642",[1,0.611,2,0.611,3012,0.86,3106,1.627,3437,4.772]],["name/4643",[3443,84.686]],["parent/4643",[1,0.611,2,0.611,3012,0.86,3106,1.627,3437,4.772]],["name/4644",[163,53.406]],["parent/4644",[1,0.611,2,0.611,3012,0.86,3106,1.627,3437,4.772]],["name/4645",[586,73.514]],["parent/4645",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4646",[3439,63.123]],["parent/4646",[1,0.611,2,0.611,3012,0.86,3106,1.627,3444,4.619]],["name/4647",[3445,84.686]],["parent/4647",[1,0.611,2,0.611,3012,0.86,3106,1.627,3444,4.619]],["name/4648",[3446,84.686]],["parent/4648",[1,0.611,2,0.611,3012,0.86,3106,1.627,3444,4.619]],["name/4649",[3390,76.069]],["parent/4649",[1,0.611,2,0.611,3012,0.86,3106,1.627,3444,4.619]],["name/4650",[3447,39.114]],["parent/4650",[1,0.611,2,0.611,3012,0.86,3106,1.627,3444,4.619]],["name/4651",[3448,79.491]],["parent/4651",[1,0.611,2,0.611,3012,0.86,3106,1.627,3444,4.619]],["name/4652",[3449,84.686]],["parent/4652",[1,0.611,2,0.611,3012,0.86,3106,1.627,3444,4.619]],["name/4653",[3450,84.686]],["parent/4653",[1,0.611,2,0.611,3012,0.86,3106,1.627,3444,4.619]],["name/4654",[3451,84.686]],["parent/4654",[1,0.611,2,0.611,3012,0.86,3106,1.627,3444,4.619]],["name/4655",[3452,84.686]],["parent/4655",[1,0.611,2,0.611,3012,0.86,3106,1.627,3444,4.619]],["name/4656",[3453,84.686]],["parent/4656",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4657",[153,73.514]],["parent/4657",[1,0.611,2,0.611,3012,0.86,3106,1.627,3454,4.772]],["name/4658",[3329,64.897]],["parent/4658",[1,0.611,2,0.611,3012,0.86,3106,1.627,3454,4.772]],["name/4659",[3331,67.046]],["parent/4659",[1,0.611,2,0.611,3012,0.86,3106,1.627,3454,4.772]],["name/4660",[160,69.774]],["parent/4660",[1,0.611,2,0.611,3012,0.86,3106,1.627,3454,4.772]],["name/4661",[3332,73.514]],["parent/4661",[1,0.611,2,0.611,3012,0.86,3106,1.627,3454,4.772]],["name/4662",[3333,68.319]],["parent/4662",[1,0.611,2,0.611,3012,0.86,3106,1.627,3454,4.772]],["name/4663",[982,64.897]],["parent/4663",[1,0.611,2,0.611,3012,0.86,3106,1.627,3454,4.772]],["name/4664",[3326,56.704]],["parent/4664",[1,0.611,2,0.611,3012,0.86,3106,1.627,3454,4.772]],["name/4665",[3455,84.686]],["parent/4665",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4666",[3456,79.491]],["parent/4666",[1,0.611,2,0.611,3012,0.86,3106,1.627,3457,5.657]],["name/4667",[3326,56.704]],["parent/4667",[1,0.611,2,0.611,3012,0.86,3106,1.627,3457,5.657]],["name/4668",[3458,84.686]],["parent/4668",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4669",[3439,63.123]],["parent/4669",[1,0.611,2,0.611,3012,0.86,3106,1.627,3459,6.027]],["name/4670",[3460,84.686]],["parent/4670",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4671",[3461,79.491]],["parent/4671",[1,0.611,2,0.611,3012,0.86,3106,1.627,3462,5.414]],["name/4672",[3456,79.491]],["parent/4672",[1,0.611,2,0.611,3012,0.86,3106,1.627,3462,5.414]],["name/4673",[3326,56.704]],["parent/4673",[1,0.611,2,0.611,3012,0.86,3106,1.627,3462,5.414]],["name/4674",[3463,84.686]],["parent/4674",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4675",[3439,63.123]],["parent/4675",[1,0.611,2,0.611,3012,0.86,3106,1.627,3464,6.027]],["name/4676",[3465,84.686]],["parent/4676",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4677",[3466,84.686]],["parent/4677",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4678",[3468,84.686]],["parent/4678",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4679",[3469,84.686]],["parent/4679",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4680",[3470,84.686]],["parent/4680",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4681",[3471,84.686]],["parent/4681",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4682",[3472,84.686]],["parent/4682",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4683",[3473,76.069]],["parent/4683",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4684",[3474,84.686]],["parent/4684",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4685",[3475,84.686]],["parent/4685",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4686",[3476,84.686]],["parent/4686",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4687",[3477,84.686]],["parent/4687",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4688",[3478,84.686]],["parent/4688",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4689",[3479,84.686]],["parent/4689",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4690",[3480,84.686]],["parent/4690",[1,0.611,2,0.611,3012,0.86,3106,1.627,3467,4.385]],["name/4691",[2218,76.069]],["parent/4691",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4692",[1837,73.514]],["parent/4692",[1,0.611,2,0.611,3012,0.86,3106,1.627,3481,5.414]],["name/4693",[3329,64.897]],["parent/4693",[1,0.611,2,0.611,3012,0.86,3106,1.627,3481,5.414]],["name/4694",[3482,84.686]],["parent/4694",[1,0.611,2,0.611,3012,0.86,3106,1.627,3481,5.414]],["name/4695",[3483,84.686]],["parent/4695",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4696",[3484,84.686]],["parent/4696",[1,0.611,2,0.611,3012,0.86,3106,1.627,3485,5.087]],["name/4697",[3486,84.686]],["parent/4697",[1,0.611,2,0.611,3012,0.86,3106,1.627,3485,5.087]],["name/4698",[3487,84.686]],["parent/4698",[1,0.611,2,0.611,3012,0.86,3106,1.627,3485,5.087]],["name/4699",[3488,84.686]],["parent/4699",[1,0.611,2,0.611,3012,0.86,3106,1.627,3485,5.087]],["name/4700",[3489,84.686]],["parent/4700",[1,0.611,2,0.611,3012,0.86,3106,1.627,3485,5.087]],["name/4701",[3490,84.686]],["parent/4701",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4702",[3329,64.897]],["parent/4702",[1,0.611,2,0.611,3012,0.86,3106,1.627,3491,5.657]],["name/4703",[1837,73.514]],["parent/4703",[1,0.611,2,0.611,3012,0.86,3106,1.627,3491,5.657]],["name/4704",[3492,84.686]],["parent/4704",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4705",[3493,84.686]],["parent/4705",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4706",[3495,84.686]],["parent/4706",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4707",[107,71.473]],["parent/4707",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4708",[27,69.774]],["parent/4708",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4709",[425,45.531]],["parent/4709",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4710",[3496,84.686]],["parent/4710",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4711",[3497,84.686]],["parent/4711",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4712",[3498,84.686]],["parent/4712",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4713",[3499,84.686]],["parent/4713",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4714",[3500,84.686]],["parent/4714",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4715",[3501,84.686]],["parent/4715",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4716",[2122,76.069]],["parent/4716",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4717",[3502,84.686]],["parent/4717",[1,0.611,2,0.611,3012,0.86,3106,1.627,3494,4.437]],["name/4718",[3503,84.686]],["parent/4718",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4719",[2881,76.069]],["parent/4719",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4720",[3505,76.069]],["parent/4720",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4721",[3506,79.491]],["parent/4721",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4722",[3507,79.491]],["parent/4722",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4723",[3508,84.686]],["parent/4723",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4724",[2459,73.514]],["parent/4724",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4725",[985,71.473]],["parent/4725",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4726",[153,73.514]],["parent/4726",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4727",[3329,64.897]],["parent/4727",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4728",[3331,67.046]],["parent/4728",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4729",[160,69.774]],["parent/4729",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4730",[3332,73.514]],["parent/4730",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4731",[3333,68.319]],["parent/4731",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4732",[982,64.897]],["parent/4732",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4733",[3326,56.704]],["parent/4733",[1,0.611,2,0.611,3012,0.86,3106,1.627,3504,4.337]],["name/4734",[3509,84.686]],["parent/4734",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4735",[3403,79.491]],["parent/4735",[1,0.611,2,0.611,3012,0.86,3106,1.627,3510,4.966]],["name/4736",[3511,84.686]],["parent/4736",[1,0.611,2,0.611,3012,0.86,3106,1.627,3510,4.966]],["name/4737",[18,47.256]],["parent/4737",[1,0.611,2,0.611,3012,0.86,3106,1.627,3512,6.027]],["name/4738",[3405,76.069]],["parent/4738",[1,0.611,2,0.611,3012,0.86,3106,1.627,3510,4.966]],["name/4739",[3513,84.686]],["parent/4739",[1,0.611,2,0.611,3012,0.86,3106,1.627,3510,4.966]],["name/4740",[107,71.473]],["parent/4740",[1,0.611,2,0.611,3012,0.86,3106,1.627,3510,4.966]],["name/4741",[3514,79.491]],["parent/4741",[1,0.611,2,0.611,3012,0.86,3106,1.627,3510,4.966]],["name/4742",[3515,84.686]],["parent/4742",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4743",[3516,79.491]],["parent/4743",[1,0.611,2,0.611,3012,0.86,3106,1.627,3517,5.232]],["name/4744",[3518,84.686]],["parent/4744",[1,0.611,2,0.611,3012,0.86,3106,1.627,3517,5.232]],["name/4745",[3519,84.686]],["parent/4745",[1,0.611,2,0.611,3012,0.86,3106,1.627,3517,5.232]],["name/4746",[3520,79.491]],["parent/4746",[1,0.611,2,0.611,3012,0.86,3106,1.627,3517,5.232]],["name/4747",[18,47.256]],["parent/4747",[1,0.611,2,0.611,3012,0.86,3106,1.627,3521,6.027]],["name/4748",[3522,84.686]],["parent/4748",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4749",[3516,79.491]],["parent/4749",[1,0.611,2,0.611,3012,0.86,3106,1.627,3523,5.414]],["name/4750",[3524,84.686]],["parent/4750",[1,0.611,2,0.611,3012,0.86,3106,1.627,3523,5.414]],["name/4751",[3520,79.491]],["parent/4751",[1,0.611,2,0.611,3012,0.86,3106,1.627,3523,5.414]],["name/4752",[18,47.256]],["parent/4752",[1,0.611,2,0.611,3012,0.86,3106,1.627,3525,6.027]],["name/4753",[3526,84.686]],["parent/4753",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4754",[3439,63.123]],["parent/4754",[1,0.611,2,0.611,3012,0.86,3106,1.627,3527,4.553]],["name/4755",[3438,79.491]],["parent/4755",[1,0.611,2,0.611,3012,0.86,3106,1.627,3527,4.553]],["name/4756",[3528,84.686]],["parent/4756",[1,0.611,2,0.611,3012,0.86,3106,1.627,3527,4.553]],["name/4757",[3529,76.069]],["parent/4757",[1,0.611,2,0.611,3012,0.86,3106,1.627,3527,4.553]],["name/4758",[3530,84.686]],["parent/4758",[1,0.611,2,0.611,3012,0.86,3106,1.627,3527,4.553]],["name/4759",[3531,84.686]],["parent/4759",[1,0.611,2,0.611,3012,0.86,3106,1.627,3527,4.553]],["name/4760",[3532,84.686]],["parent/4760",[1,0.611,2,0.611,3012,0.86,3106,1.627,3527,4.553]],["name/4761",[3533,84.686]],["parent/4761",[1,0.611,2,0.611,3012,0.86,3106,1.627,3527,4.553]],["name/4762",[3534,84.686]],["parent/4762",[1,0.611,2,0.611,3012,0.86,3106,1.627,3527,4.553]],["name/4763",[3473,76.069]],["parent/4763",[1,0.611,2,0.611,3012,0.86,3106,1.627,3527,4.553]],["name/4764",[3535,84.686]],["parent/4764",[1,0.611,2,0.611,3012,0.86,3106,1.627,3527,4.553]],["name/4765",[634,69.774]],["parent/4765",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4766",[3439,63.123]],["parent/4766",[1,0.611,2,0.611,3012,0.86,3106,1.627,3536,5.657]],["name/4767",[3529,76.069]],["parent/4767",[1,0.611,2,0.611,3012,0.86,3106,1.627,3536,5.657]],["name/4768",[3537,84.686]],["parent/4768",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4769",[3538,84.686]],["parent/4769",[1,0.611,2,0.611,3012,0.86,3106,1.627,3539,5.657]],["name/4770",[3540,84.686]],["parent/4770",[1,0.611,2,0.611,3012,0.86,3106,1.627,3539,5.657]],["name/4771",[3541,84.686]],["parent/4771",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4772",[3329,64.897]],["parent/4772",[1,0.611,2,0.611,3012,0.86,3106,1.627,3542,5.657]],["name/4773",[3543,84.686]],["parent/4773",[1,0.611,2,0.611,3012,0.86,3106,1.627,3542,5.657]],["name/4774",[3544,84.686]],["parent/4774",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4775",[3329,64.897]],["parent/4775",[1,0.611,2,0.611,3012,0.86,3106,1.627,3545,5.657]],["name/4776",[3546,84.686]],["parent/4776",[1,0.611,2,0.611,3012,0.86,3106,1.627,3545,5.657]],["name/4777",[3547,84.686]],["parent/4777",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4778",[143,71.473]],["parent/4778",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4779",[3549,84.686]],["parent/4779",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4780",[3550,84.686]],["parent/4780",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4781",[3551,84.686]],["parent/4781",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4782",[3552,84.686]],["parent/4782",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4783",[107,71.473]],["parent/4783",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4784",[3405,76.069]],["parent/4784",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4785",[156,76.069]],["parent/4785",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4786",[3507,79.491]],["parent/4786",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4787",[3514,79.491]],["parent/4787",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4788",[3329,64.897]],["parent/4788",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4789",[3331,67.046]],["parent/4789",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4790",[160,69.774]],["parent/4790",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4791",[3332,73.514]],["parent/4791",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4792",[3333,68.319]],["parent/4792",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4793",[982,64.897]],["parent/4793",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4794",[3326,56.704]],["parent/4794",[1,0.611,2,0.611,3012,0.86,3106,1.627,3548,4.249]],["name/4795",[3553,84.686]],["parent/4795",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4796",[1644,63.123]],["parent/4796",[1,0.611,2,0.611,3012,0.86,3106,1.627,3554,5.087]],["name/4797",[293,73.514]],["parent/4797",[1,0.611,2,0.611,3012,0.86,3106,1.627,3554,5.087]],["name/4798",[297,79.491]],["parent/4798",[1,0.611,2,0.611,3012,0.86,3106,1.627,3554,5.087]],["name/4799",[413,67.046]],["parent/4799",[1,0.611,2,0.611,3012,0.86,3106,1.627,3554,5.087]],["name/4800",[156,76.069]],["parent/4800",[1,0.611,2,0.611,3012,0.86,3106,1.627,3554,5.087]],["name/4801",[3555,84.686]],["parent/4801",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4802",[3556,84.686]],["parent/4802",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4803",[3558,84.686]],["parent/4803",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4804",[3559,84.686]],["parent/4804",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4805",[3560,84.686]],["parent/4805",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4806",[3561,84.686]],["parent/4806",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4807",[3562,84.686]],["parent/4807",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4808",[3563,84.686]],["parent/4808",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4809",[3564,84.686]],["parent/4809",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4810",[3565,84.686]],["parent/4810",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4811",[3566,84.686]],["parent/4811",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4812",[3567,84.686]],["parent/4812",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4813",[3568,84.686]],["parent/4813",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4814",[163,53.406]],["parent/4814",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4815",[3569,84.686]],["parent/4815",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4816",[3570,84.686]],["parent/4816",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4817",[3571,84.686]],["parent/4817",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4818",[3473,76.069]],["parent/4818",[1,0.611,2,0.611,3012,0.86,3106,1.627,3557,4.249]],["name/4819",[3572,84.686]],["parent/4819",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4820",[293,52.545,3439,45.119]],["parent/4820",[1,0.611,2,0.611,3012,0.86,3106,1.627,3573,5.232]],["name/4821",[3574,79.491]],["parent/4821",[1,0.611,2,0.611,3012,0.86,3106,1.627,3573,5.232]],["name/4822",[3575,79.491]],["parent/4822",[1,0.611,2,0.611,3012,0.86,3106,1.627,3573,5.232]],["name/4823",[3326,56.704]],["parent/4823",[1,0.611,2,0.611,3012,0.86,3106,1.627,3573,5.232]],["name/4824",[3576,84.686]],["parent/4824",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4825",[3577,84.686]],["parent/4825",[1,0.611,2,0.611,3012,0.86,3106,1.627,3578,4.619]],["name/4826",[3579,84.686]],["parent/4826",[1,0.611,2,0.611,3012,0.86,3106,1.627,3578,4.619]],["name/4827",[3580,84.686]],["parent/4827",[1,0.611,2,0.611,3012,0.86,3106,1.627,3578,4.619]],["name/4828",[3581,84.686]],["parent/4828",[1,0.611,2,0.611,3012,0.86,3106,1.627,3578,4.619]],["name/4829",[2459,73.514]],["parent/4829",[1,0.611,2,0.611,3012,0.86,3106,1.627,3578,4.619]],["name/4830",[3582,84.686]],["parent/4830",[1,0.611,2,0.611,3012,0.86,3106,1.627,3578,4.619]],["name/4831",[18,47.256]],["parent/4831",[1,0.611,2,0.611,3012,0.86,3106,1.627,3583,6.027]],["name/4832",[293,52.545,3439,45.119]],["parent/4832",[1,0.611,2,0.611,3012,0.86,3106,1.627,3578,4.619]],["name/4833",[3574,79.491]],["parent/4833",[1,0.611,2,0.611,3012,0.86,3106,1.627,3578,4.619]],["name/4834",[3575,79.491]],["parent/4834",[1,0.611,2,0.611,3012,0.86,3106,1.627,3578,4.619]],["name/4835",[3326,56.704]],["parent/4835",[1,0.611,2,0.611,3012,0.86,3106,1.627,3578,4.619]],["name/4836",[3584,84.686]],["parent/4836",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4837",[3439,63.123]],["parent/4837",[1,0.611,2,0.611,3012,0.86,3106,1.627,3585,5.232]],["name/4838",[3586,84.686]],["parent/4838",[1,0.611,2,0.611,3012,0.86,3106,1.627,3585,5.232]],["name/4839",[3587,84.686]],["parent/4839",[1,0.611,2,0.611,3012,0.86,3106,1.627,3585,5.232]],["name/4840",[3588,84.686]],["parent/4840",[1,0.611,2,0.611,3012,0.86,3106,1.627,3585,5.232]],["name/4841",[3589,84.686]],["parent/4841",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4842",[3333,68.319]],["parent/4842",[1,0.611,2,0.611,3012,0.86,3106,1.627,3590,5.657]],["name/4843",[3326,56.704]],["parent/4843",[1,0.611,2,0.611,3012,0.86,3106,1.627,3590,5.657]],["name/4844",[3591,84.686]],["parent/4844",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4845",[3592,84.686]],["parent/4845",[1,0.611,2,0.611,3012,0.86,3106,1.627,3593,5.414]],["name/4846",[3461,79.491]],["parent/4846",[1,0.611,2,0.611,3012,0.86,3106,1.627,3593,5.414]],["name/4847",[3326,56.704]],["parent/4847",[1,0.611,2,0.611,3012,0.86,3106,1.627,3593,5.414]],["name/4848",[3594,84.686]],["parent/4848",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4849",[3343,79.491]],["parent/4849",[1,0.611,2,0.611,3012,0.86,3106,1.627,3595,5.232]],["name/4850",[1644,63.123]],["parent/4850",[1,0.611,2,0.611,3012,0.86,3106,1.627,3595,5.232]],["name/4851",[1670,69.774]],["parent/4851",[1,0.611,2,0.611,3012,0.86,3106,1.627,3595,5.232]],["name/4852",[3344,79.491]],["parent/4852",[1,0.611,2,0.611,3012,0.86,3106,1.627,3595,5.232]],["name/4853",[653,67.046]],["parent/4853",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4854",[3439,63.123]],["parent/4854",[1,0.611,2,0.611,3012,0.86,3106,1.627,3596,5.232]],["name/4855",[3390,76.069]],["parent/4855",[1,0.611,2,0.611,3012,0.86,3106,1.627,3596,5.232]],["name/4856",[3529,76.069]],["parent/4856",[1,0.611,2,0.611,3012,0.86,3106,1.627,3596,5.232]],["name/4857",[3448,79.491]],["parent/4857",[1,0.611,2,0.611,3012,0.86,3106,1.627,3596,5.232]],["name/4858",[3597,84.686]],["parent/4858",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4859",[3598,84.686]],["parent/4859",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4860",[3439,63.123]],["parent/4860",[1,0.611,2,0.611,3012,0.86,3106,1.627,3599,6.027]],["name/4861",[3600,84.686]],["parent/4861",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4862",[3601,84.686]],["parent/4862",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4863",[123,27.08,3441,52.545]],["parent/4863",[1,0.611,2,0.611,3012,0.86,3106,1.627,3602,5.414]],["name/4864",[100,73.514]],["parent/4864",[1,0.611,2,0.611,3012,0.86,3106,1.627,3602,5.414]],["name/4865",[3326,56.704]],["parent/4865",[1,0.611,2,0.611,3012,0.86,3106,1.627,3602,5.414]],["name/4866",[3603,84.686]],["parent/4866",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4867",[3441,73.514]],["parent/4867",[1,0.611,2,0.611,3012,0.86,3106,1.627,3604,5.657]],["name/4868",[3605,84.686]],["parent/4868",[1,0.611,2,0.611,3012,0.86,3106,1.627,3604,5.657]],["name/4869",[3606,79.491]],["parent/4869",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4870",[3439,63.123]],["parent/4870",[1,0.611,2,0.611,3012,0.86,3106,1.627,3607,5.414]],["name/4871",[3608,84.686]],["parent/4871",[1,0.611,2,0.611,3012,0.86,3106,1.627,3607,5.414]],["name/4872",[3606,79.491]],["parent/4872",[1,0.611,2,0.611,3012,0.86,3106,1.627,3607,5.414]],["name/4873",[3609,84.686]],["parent/4873",[1,0.611,2,0.611,3,2.113,3012,0.86,3106,1.627]],["name/4874",[3441,73.514]],["parent/4874",[1,0.611,2,0.611,3012,0.86,3106,1.627,3610,6.027]],["name/4875",[1,3.307,2,3.307,3,11.438,2904,12.114,3012,4.654]],["parent/4875",[]],["name/4876",[3611,84.686]],["parent/4876",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4877",[3612,84.686]],["parent/4877",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4878",[1135,79.491]],["parent/4878",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4879",[3614,84.686]],["parent/4879",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4880",[3615,84.686]],["parent/4880",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4881",[3616,84.686]],["parent/4881",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4882",[3617,84.686]],["parent/4882",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4883",[3618,84.686]],["parent/4883",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4884",[3619,84.686]],["parent/4884",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4885",[3620,84.686]],["parent/4885",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4886",[3621,84.686]],["parent/4886",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4887",[3622,79.491]],["parent/4887",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4888",[1032,63.123]],["parent/4888",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4889",[3623,84.686]],["parent/4889",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4890",[3624,84.686]],["parent/4890",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4891",[3625,84.686]],["parent/4891",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4892",[3626,84.686]],["parent/4892",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4893",[3627,84.686]],["parent/4893",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4894",[3628,84.686]],["parent/4894",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4895",[3629,84.686]],["parent/4895",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4896",[3630,84.686]],["parent/4896",[1,0.611,2,0.611,2904,2.238,3012,0.86,3613,4.134]],["name/4897",[3631,84.686]],["parent/4897",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4898",[3632,84.686]],["parent/4898",[1,0.611,2,0.611,2904,2.238,3012,0.86,3633,4.966]],["name/4899",[3634,84.686]],["parent/4899",[1,0.611,2,0.611,2904,2.238,3012,0.86,3633,4.966]],["name/4900",[3635,52.545,3636,60.531]],["parent/4900",[1,0.611,2,0.611,2904,2.238,3012,0.86,3633,4.966]],["name/4901",[189,21.796,3635,40.884,3637,47.098]],["parent/4901",[1,0.611,2,0.611,2904,2.238,3012,0.86,3633,4.966]],["name/4902",[189,28.012,3635,52.545]],["parent/4902",[1,0.611,2,0.611,2904,2.238,3012,0.86,3633,4.966]],["name/4903",[189,28.012,3638,60.531]],["parent/4903",[1,0.611,2,0.611,2904,2.238,3012,0.86,3633,4.966]],["name/4904",[3639,84.686]],["parent/4904",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4905",[3640,60.936]],["parent/4905",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4906",[3642,61.614]],["parent/4906",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4907",[3643,76.069]],["parent/4907",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4908",[2839,60.3]],["parent/4908",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4909",[37,64.897]],["parent/4909",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4910",[123,37.886]],["parent/4910",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4911",[89,69.774]],["parent/4911",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4912",[3644,73.514]],["parent/4912",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4913",[122,40.53,3635,52.545]],["parent/4913",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4914",[104,69.774]],["parent/4914",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4915",[104,49.872,3106,16.335]],["parent/4915",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4916",[110,48.832,3645,52.545]],["parent/4916",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4917",[3646,79.491]],["parent/4917",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4918",[189,28.012,3646,56.818]],["parent/4918",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4919",[3647,44.208,3648,47.098,3649,47.098]],["parent/4919",[1,0.611,2,0.611,2904,2.238,3012,0.86,3641,4.337]],["name/4920",[3650,84.686]],["parent/4920",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4921",[3640,60.936]],["parent/4921",[1,0.611,2,0.611,2904,2.238,3012,0.86,3651,5.414]],["name/4922",[3642,61.614]],["parent/4922",[1,0.611,2,0.611,2904,2.238,3012,0.86,3651,5.414]],["name/4923",[112,60.3]],["parent/4923",[1,0.611,2,0.611,2904,2.238,3012,0.86,3651,5.414]],["name/4924",[3652,84.686]],["parent/4924",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4925",[585,68.319]],["parent/4925",[1,0.611,2,0.611,2904,2.238,3012,0.86,3653,5.657]],["name/4926",[112,60.3]],["parent/4926",[1,0.611,2,0.611,2904,2.238,3012,0.86,3653,5.657]],["name/4927",[3654,84.686]],["parent/4927",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4928",[3640,60.936]],["parent/4928",[1,0.611,2,0.611,2904,2.238,3012,0.86,3655,4.619]],["name/4929",[3642,61.614]],["parent/4929",[1,0.611,2,0.611,2904,2.238,3012,0.86,3655,4.619]],["name/4930",[734,56.818,3640,43.555]],["parent/4930",[1,0.611,2,0.611,2904,2.238,3012,0.86,3655,4.619]],["name/4931",[2839,60.3]],["parent/4931",[1,0.611,2,0.611,2904,2.238,3012,0.86,3655,4.619]],["name/4932",[3324,79.491]],["parent/4932",[1,0.611,2,0.611,2904,2.238,3012,0.86,3655,4.619]],["name/4933",[3656,84.686]],["parent/4933",[1,0.611,2,0.611,2904,2.238,3012,0.86,3655,4.619]],["name/4934",[110,48.832,3645,52.545]],["parent/4934",[1,0.611,2,0.611,2904,2.238,3012,0.86,3655,4.619]],["name/4935",[37,64.897]],["parent/4935",[1,0.611,2,0.611,2904,2.238,3012,0.86,3655,4.619]],["name/4936",[3657,60.531,3658,54.372]],["parent/4936",[1,0.611,2,0.611,2904,2.238,3012,0.86,3655,4.619]],["name/4937",[279,32.637]],["parent/4937",[1,0.611,2,0.611,2904,2.238,3012,0.86,3655,4.619]],["name/4938",[3659,84.686]],["parent/4938",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4939",[3660,84.686]],["parent/4939",[1,0.611,2,0.611,2904,2.238,3012,0.86,3661,5.232]],["name/4940",[3662,84.686]],["parent/4940",[1,0.611,2,0.611,2904,2.238,3012,0.86,3661,5.232]],["name/4941",[3663,84.686]],["parent/4941",[1,0.611,2,0.611,2904,2.238,3012,0.86,3661,5.232]],["name/4942",[163,53.406]],["parent/4942",[1,0.611,2,0.611,2904,2.238,3012,0.86,3661,5.232]],["name/4943",[3664,84.686]],["parent/4943",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4944",[3640,60.936]],["parent/4944",[1,0.611,2,0.611,2904,2.238,3012,0.86,3665,5.414]],["name/4945",[3642,61.614]],["parent/4945",[1,0.611,2,0.611,2904,2.238,3012,0.86,3665,5.414]],["name/4946",[3666,84.686]],["parent/4946",[1,0.611,2,0.611,2904,2.238,3012,0.86,3665,5.414]],["name/4947",[3667,84.686]],["parent/4947",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4948",[3668,84.686]],["parent/4948",[1,0.611,2,0.611,2904,2.238,3012,0.86,3669,5.232]],["name/4949",[3670,84.686]],["parent/4949",[1,0.611,2,0.611,2904,2.238,3012,0.86,3669,5.232]],["name/4950",[3671,84.686]],["parent/4950",[1,0.611,2,0.611,2904,2.238,3012,0.86,3669,5.232]],["name/4951",[163,53.406]],["parent/4951",[1,0.611,2,0.611,2904,2.238,3012,0.86,3669,5.232]],["name/4952",[3672,84.686]],["parent/4952",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4953",[3673,84.686]],["parent/4953",[1,0.611,2,0.611,2904,2.238,3012,0.86,3674,4.862]],["name/4954",[3642,61.614]],["parent/4954",[1,0.611,2,0.611,2904,2.238,3012,0.86,3674,4.862]],["name/4955",[3640,60.936]],["parent/4955",[1,0.611,2,0.611,2904,2.238,3012,0.86,3674,4.862]],["name/4956",[3675,84.686]],["parent/4956",[1,0.611,2,0.611,2904,2.238,3012,0.86,3674,4.862]],["name/4957",[3505,76.069]],["parent/4957",[1,0.611,2,0.611,2904,2.238,3012,0.86,3674,4.862]],["name/4958",[3329,64.897]],["parent/4958",[1,0.611,2,0.611,2904,2.238,3012,0.86,3674,4.862]],["name/4959",[3331,67.046]],["parent/4959",[1,0.611,2,0.611,2904,2.238,3012,0.86,3674,4.862]],["name/4960",[3676,84.686]],["parent/4960",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4961",[3640,60.936]],["parent/4961",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4962",[3642,61.614]],["parent/4962",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4963",[92,65.914]],["parent/4963",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4964",[3678,56.818,3679,51.087]],["parent/4964",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4965",[3331,47.922,3679,51.087]],["parent/4965",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4966",[110,48.832,3645,52.545]],["parent/4966",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4967",[89,69.774]],["parent/4967",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4968",[1835,58.601]],["parent/4968",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4969",[3680,73.514]],["parent/4969",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4970",[104,49.872,3681,60.531]],["parent/4970",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4971",[95,64.897]],["parent/4971",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4972",[3643,76.069]],["parent/4972",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4973",[3682,71.473]],["parent/4973",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4974",[3683,79.491]],["parent/4974",[1,0.611,2,0.611,2904,2.238,3012,0.86,3677,4.385]],["name/4975",[3684,84.686]],["parent/4975",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4976",[3685,84.686]],["parent/4976",[1,0.611,2,0.611,2904,2.238,3012,0.86,3686,5.232]],["name/4977",[3642,61.614]],["parent/4977",[1,0.611,2,0.611,2904,2.238,3012,0.86,3686,5.232]],["name/4978",[3640,60.936]],["parent/4978",[1,0.611,2,0.611,2904,2.238,3012,0.86,3686,5.232]],["name/4979",[985,71.473]],["parent/4979",[1,0.611,2,0.611,2904,2.238,3012,0.86,3686,5.232]],["name/4980",[3687,84.686]],["parent/4980",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4981",[89,69.774]],["parent/4981",[1,0.611,2,0.611,2904,2.238,3012,0.86,3688,5.657]],["name/4982",[585,68.319]],["parent/4982",[1,0.611,2,0.611,2904,2.238,3012,0.86,3688,5.657]],["name/4983",[3689,84.686]],["parent/4983",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4984",[3642,61.614]],["parent/4984",[1,0.611,2,0.611,2904,2.238,3012,0.86,3690,5.657]],["name/4985",[3640,60.936]],["parent/4985",[1,0.611,2,0.611,2904,2.238,3012,0.86,3690,5.657]],["name/4986",[3691,84.686]],["parent/4986",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4987",[3692,84.686]],["parent/4987",[1,0.611,2,0.611,2904,2.238,3012,0.86,3693,5.414]],["name/4988",[3694,84.686]],["parent/4988",[1,0.611,2,0.611,2904,2.238,3012,0.86,3693,5.414]],["name/4989",[3695,84.686]],["parent/4989",[1,0.611,2,0.611,2904,2.238,3012,0.86,3693,5.414]],["name/4990",[3696,84.686]],["parent/4990",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4991",[3640,60.936]],["parent/4991",[1,0.611,2,0.611,2904,2.238,3012,0.86,3697,5.657]],["name/4992",[3642,61.614]],["parent/4992",[1,0.611,2,0.611,2904,2.238,3012,0.86,3697,5.657]],["name/4993",[3698,84.686]],["parent/4993",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/4994",[2839,60.3]],["parent/4994",[1,0.611,2,0.611,2904,2.238,3012,0.86,3699,4.966]],["name/4995",[442,76.069]],["parent/4995",[1,0.611,2,0.611,2904,2.238,3012,0.86,3699,4.966]],["name/4996",[37,64.897]],["parent/4996",[1,0.611,2,0.611,2904,2.238,3012,0.86,3699,4.966]],["name/4997",[3700,84.686]],["parent/4997",[1,0.611,2,0.611,2904,2.238,3012,0.86,3699,4.966]],["name/4998",[3640,60.936]],["parent/4998",[1,0.611,2,0.611,2904,2.238,3012,0.86,3699,4.966]],["name/4999",[3701,84.686]],["parent/4999",[1,0.611,2,0.611,2904,2.238,3012,0.86,3699,4.966]],["name/5000",[3702,84.686]],["parent/5000",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5001",[3703,84.686]],["parent/5001",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5002",[3704,84.686]],["parent/5002",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5003",[3640,60.936]],["parent/5003",[1,0.611,2,0.611,2904,2.238,3012,0.86,3705,5.087]],["name/5004",[3642,61.614]],["parent/5004",[1,0.611,2,0.611,2904,2.238,3012,0.86,3705,5.087]],["name/5005",[3706,73.514]],["parent/5005",[1,0.611,2,0.611,2904,2.238,3012,0.86,3705,5.087]],["name/5006",[37,64.897]],["parent/5006",[1,0.611,2,0.611,2904,2.238,3012,0.86,3705,5.087]],["name/5007",[3707,73.514]],["parent/5007",[1,0.611,2,0.611,2904,2.238,3012,0.86,3705,5.087]],["name/5008",[3708,84.686]],["parent/5008",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5009",[3709,79.491]],["parent/5009",[1,0.611,2,0.611,2904,2.238,3012,0.86,3710,4.862]],["name/5010",[3711,79.491]],["parent/5010",[1,0.611,2,0.611,2904,2.238,3012,0.86,3710,4.862]],["name/5011",[3712,79.491]],["parent/5011",[1,0.611,2,0.611,2904,2.238,3012,0.86,3710,4.862]],["name/5012",[3706,73.514]],["parent/5012",[1,0.611,2,0.611,2904,2.238,3012,0.86,3710,4.862]],["name/5013",[37,64.897]],["parent/5013",[1,0.611,2,0.611,2904,2.238,3012,0.86,3710,4.862]],["name/5014",[3707,73.514]],["parent/5014",[1,0.611,2,0.611,2904,2.238,3012,0.86,3710,4.862]],["name/5015",[3713,68.319]],["parent/5015",[1,0.611,2,0.611,2904,2.238,3012,0.86,3710,4.862]],["name/5016",[3714,84.686]],["parent/5016",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5017",[3709,79.491]],["parent/5017",[1,0.611,2,0.611,2904,2.238,3012,0.86,3715,5.232]],["name/5018",[3711,79.491]],["parent/5018",[1,0.611,2,0.611,2904,2.238,3012,0.86,3715,5.232]],["name/5019",[3712,79.491]],["parent/5019",[1,0.611,2,0.611,2904,2.238,3012,0.86,3715,5.232]],["name/5020",[3713,68.319]],["parent/5020",[1,0.611,2,0.611,2904,2.238,3012,0.86,3715,5.232]],["name/5021",[3716,84.686]],["parent/5021",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5022",[3717,79.491]],["parent/5022",[1,0.611,2,0.611,2904,2.238,3012,0.86,3718,5.087]],["name/5023",[3706,73.514]],["parent/5023",[1,0.611,2,0.611,2904,2.238,3012,0.86,3718,5.087]],["name/5024",[37,64.897]],["parent/5024",[1,0.611,2,0.611,2904,2.238,3012,0.86,3718,5.087]],["name/5025",[3707,73.514]],["parent/5025",[1,0.611,2,0.611,2904,2.238,3012,0.86,3718,5.087]],["name/5026",[3713,68.319]],["parent/5026",[1,0.611,2,0.611,2904,2.238,3012,0.86,3718,5.087]],["name/5027",[3719,84.686]],["parent/5027",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5028",[3720,79.491]],["parent/5028",[1,0.611,2,0.611,2904,2.238,3012,0.86,3721,5.657]],["name/5029",[3713,68.319]],["parent/5029",[1,0.611,2,0.611,2904,2.238,3012,0.86,3721,5.657]],["name/5030",[3722,84.686]],["parent/5030",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5031",[3706,73.514]],["parent/5031",[1,0.611,2,0.611,2904,2.238,3012,0.86,3723,5.087]],["name/5032",[37,64.897]],["parent/5032",[1,0.611,2,0.611,2904,2.238,3012,0.86,3723,5.087]],["name/5033",[3707,73.514]],["parent/5033",[1,0.611,2,0.611,2904,2.238,3012,0.86,3723,5.087]],["name/5034",[3720,79.491]],["parent/5034",[1,0.611,2,0.611,2904,2.238,3012,0.86,3723,5.087]],["name/5035",[3713,68.319]],["parent/5035",[1,0.611,2,0.611,2904,2.238,3012,0.86,3723,5.087]],["name/5036",[3724,84.686]],["parent/5036",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5037",[3717,79.491]],["parent/5037",[1,0.611,2,0.611,2904,2.238,3012,0.86,3725,5.657]],["name/5038",[3713,68.319]],["parent/5038",[1,0.611,2,0.611,2904,2.238,3012,0.86,3725,5.657]],["name/5039",[3726,84.686]],["parent/5039",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5040",[3727,84.686]],["parent/5040",[1,0.611,2,0.611,2904,2.238,3012,0.86,3728,4.691]],["name/5041",[3729,84.686]],["parent/5041",[1,0.611,2,0.611,2904,2.238,3012,0.86,3728,4.691]],["name/5042",[3730,84.686]],["parent/5042",[1,0.611,2,0.611,2904,2.238,3012,0.86,3728,4.691]],["name/5043",[3731,84.686]],["parent/5043",[1,0.611,2,0.611,2904,2.238,3012,0.86,3728,4.691]],["name/5044",[3506,79.491]],["parent/5044",[1,0.611,2,0.611,2904,2.238,3012,0.86,3728,4.691]],["name/5045",[3505,76.069]],["parent/5045",[1,0.611,2,0.611,2904,2.238,3012,0.86,3728,4.691]],["name/5046",[3333,68.319]],["parent/5046",[1,0.611,2,0.611,2904,2.238,3012,0.86,3728,4.691]],["name/5047",[982,64.897]],["parent/5047",[1,0.611,2,0.611,2904,2.238,3012,0.86,3728,4.691]],["name/5048",[3713,68.319]],["parent/5048",[1,0.611,2,0.611,2904,2.238,3012,0.86,3728,4.691]],["name/5049",[3732,84.686]],["parent/5049",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5050",[110,48.832,3645,52.545]],["parent/5050",[1,0.611,2,0.611,2904,2.238,3012,0.86,3733,4.691]],["name/5051",[3640,60.936]],["parent/5051",[1,0.611,2,0.611,2904,2.238,3012,0.86,3733,4.691]],["name/5052",[3642,61.614]],["parent/5052",[1,0.611,2,0.611,2904,2.238,3012,0.86,3733,4.691]],["name/5053",[2839,60.3]],["parent/5053",[1,0.611,2,0.611,2904,2.238,3012,0.86,3733,4.691]],["name/5054",[89,69.774]],["parent/5054",[1,0.611,2,0.611,2904,2.238,3012,0.86,3733,4.691]],["name/5055",[3644,73.514]],["parent/5055",[1,0.611,2,0.611,2904,2.238,3012,0.86,3733,4.691]],["name/5056",[123,27.08,3734,56.818]],["parent/5056",[1,0.611,2,0.611,2904,2.238,3012,0.86,3733,4.691]],["name/5057",[3658,54.372,3734,56.818]],["parent/5057",[1,0.611,2,0.611,2904,2.238,3012,0.86,3733,4.691]],["name/5058",[3658,54.372,3735,60.531]],["parent/5058",[1,0.611,2,0.611,2904,2.238,3012,0.86,3733,4.691]],["name/5059",[3736,84.686]],["parent/5059",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5060",[3737,84.686]],["parent/5060",[1,0.611,2,0.611,2904,2.238,3012,0.86,3738,5.087]],["name/5061",[3647,79.491]],["parent/5061",[1,0.611,2,0.611,2904,2.238,3012,0.86,3738,5.087]],["name/5062",[310,63.971]],["parent/5062",[1,0.611,2,0.611,2904,2.238,3012,0.86,3738,5.087]],["name/5063",[403,65.914]],["parent/5063",[1,0.611,2,0.611,2904,2.238,3012,0.86,3738,5.087]],["name/5064",[279,32.637]],["parent/5064",[1,0.611,2,0.611,2904,2.238,3012,0.86,3738,5.087]],["name/5065",[3739,84.686]],["parent/5065",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5066",[1835,58.601]],["parent/5066",[1,0.611,2,0.611,2904,2.238,3012,0.86,3740,5.232]],["name/5067",[3680,73.514]],["parent/5067",[1,0.611,2,0.611,2904,2.238,3012,0.86,3740,5.232]],["name/5068",[3682,71.473]],["parent/5068",[1,0.611,2,0.611,2904,2.238,3012,0.86,3740,5.232]],["name/5069",[3331,47.922,3679,51.087]],["parent/5069",[1,0.611,2,0.611,2904,2.238,3012,0.86,3740,5.232]],["name/5070",[3741,84.686]],["parent/5070",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5071",[3640,60.936]],["parent/5071",[1,0.611,2,0.611,2904,2.238,3012,0.86,3742,5.232]],["name/5072",[3642,61.614]],["parent/5072",[1,0.611,2,0.611,2904,2.238,3012,0.86,3742,5.232]],["name/5073",[37,64.897]],["parent/5073",[1,0.611,2,0.611,2904,2.238,3012,0.86,3742,5.232]],["name/5074",[3644,73.514]],["parent/5074",[1,0.611,2,0.611,2904,2.238,3012,0.86,3742,5.232]],["name/5075",[3743,84.686]],["parent/5075",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5076",[1835,58.601]],["parent/5076",[1,0.611,2,0.611,2904,2.238,3012,0.86,3744,5.087]],["name/5077",[3680,73.514]],["parent/5077",[1,0.611,2,0.611,2904,2.238,3012,0.86,3744,5.087]],["name/5078",[3682,71.473]],["parent/5078",[1,0.611,2,0.611,2904,2.238,3012,0.86,3744,5.087]],["name/5079",[3745,73.514]],["parent/5079",[1,0.611,2,0.611,2904,2.238,3012,0.86,3744,5.087]],["name/5080",[122,56.704]],["parent/5080",[1,0.611,2,0.611,2904,2.238,3012,0.86,3744,5.087]],["name/5081",[3746,84.686]],["parent/5081",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5082",[18,47.256]],["parent/5082",[1,0.611,2,0.611,2904,2.238,3012,0.86,3747,6.027]],["name/5083",[3748,84.686]],["parent/5083",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5084",[18,47.256]],["parent/5084",[1,0.611,2,0.611,2904,2.238,3012,0.86,3749,6.027]],["name/5085",[3750,84.686]],["parent/5085",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5086",[3751,84.686]],["parent/5086",[1,0.611,2,0.611,2904,2.238,3012,0.86,3752,5.414]],["name/5087",[3753,84.686]],["parent/5087",[1,0.611,2,0.611,2904,2.238,3012,0.86,3752,5.414]],["name/5088",[163,53.406]],["parent/5088",[1,0.611,2,0.611,2904,2.238,3012,0.86,3752,5.414]],["name/5089",[3754,84.686]],["parent/5089",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5090",[3755,84.686]],["parent/5090",[1,0.611,2,0.611,2904,2.238,3012,0.86,3756,5.414]],["name/5091",[279,32.637]],["parent/5091",[1,0.611,2,0.611,2904,2.238,3012,0.86,3757,6.027]],["name/5092",[3758,84.686]],["parent/5092",[1,0.611,2,0.611,2904,2.238,3012,0.86,3756,5.414]],["name/5093",[279,32.637]],["parent/5093",[1,0.611,2,0.611,2904,2.238,3012,0.86,3759,6.027]],["name/5094",[3760,84.686]],["parent/5094",[1,0.611,2,0.611,2904,2.238,3012,0.86,3756,5.414]],["name/5095",[279,32.637]],["parent/5095",[1,0.611,2,0.611,2904,2.238,3012,0.86,3761,6.027]],["name/5096",[3762,84.686]],["parent/5096",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5097",[3763,84.686]],["parent/5097",[1,0.611,2,0.611,2904,2.238,3012,0.86,3764,4.619]],["name/5098",[3622,79.491]],["parent/5098",[1,0.611,2,0.611,2904,2.238,3012,0.86,3764,4.619]],["name/5099",[3765,84.686]],["parent/5099",[1,0.611,2,0.611,2904,2.238,3012,0.86,3764,4.619]],["name/5100",[3766,84.686]],["parent/5100",[1,0.611,2,0.611,2904,2.238,3012,0.86,3764,4.619]],["name/5101",[3767,84.686]],["parent/5101",[1,0.611,2,0.611,2904,2.238,3012,0.86,3764,4.619]],["name/5102",[3768,84.686]],["parent/5102",[1,0.611,2,0.611,2904,2.238,3012,0.86,3764,4.619]],["name/5103",[163,53.406]],["parent/5103",[1,0.611,2,0.611,2904,2.238,3012,0.86,3764,4.619]],["name/5104",[3769,84.686]],["parent/5104",[1,0.611,2,0.611,2904,2.238,3012,0.86,3764,4.619]],["name/5105",[3770,79.491]],["parent/5105",[1,0.611,2,0.611,2904,2.238,3012,0.86,3764,4.619]],["name/5106",[3771,84.686]],["parent/5106",[1,0.611,2,0.611,2904,2.238,3012,0.86,3764,4.619]],["name/5107",[3772,84.686]],["parent/5107",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5108",[3773,84.686]],["parent/5108",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5109",[3775,84.686]],["parent/5109",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5110",[3776,84.686]],["parent/5110",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5111",[3777,84.686]],["parent/5111",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5112",[3778,84.686]],["parent/5112",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5113",[3779,84.686]],["parent/5113",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5114",[3780,84.686]],["parent/5114",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5115",[3781,84.686]],["parent/5115",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5116",[3782,84.686]],["parent/5116",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5117",[3783,84.686]],["parent/5117",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5118",[3784,84.686]],["parent/5118",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5119",[3785,84.686]],["parent/5119",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5120",[3786,84.686]],["parent/5120",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5121",[3787,84.686]],["parent/5121",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5122",[3788,84.686]],["parent/5122",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5123",[3789,84.686]],["parent/5123",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5124",[163,53.406]],["parent/5124",[1,0.611,2,0.611,2904,2.238,3012,0.86,3774,4.249]],["name/5125",[3790,79.491]],["parent/5125",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5126",[3790,79.491]],["parent/5126",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5127",[3792,84.686]],["parent/5127",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5128",[3793,84.686]],["parent/5128",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5129",[3794,84.686]],["parent/5129",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5130",[3795,84.686]],["parent/5130",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5131",[3796,84.686]],["parent/5131",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5132",[3797,84.686]],["parent/5132",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5133",[3798,84.686]],["parent/5133",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5134",[3799,84.686]],["parent/5134",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5135",[3800,84.686]],["parent/5135",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5136",[3801,84.686]],["parent/5136",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5137",[3802,84.686]],["parent/5137",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5138",[3803,84.686]],["parent/5138",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5139",[3804,84.686]],["parent/5139",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5140",[3805,84.686]],["parent/5140",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5141",[3806,84.686]],["parent/5141",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5142",[3807,84.686]],["parent/5142",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5143",[3808,84.686]],["parent/5143",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5144",[3809,84.686]],["parent/5144",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5145",[3810,84.686]],["parent/5145",[1,0.611,2,0.611,2904,2.238,3012,0.86,3791,4.134]],["name/5146",[3811,84.686]],["parent/5146",[1,0.611,2,0.611,3,2.113,2904,2.238,3012,0.86]],["name/5147",[3812,84.686]],["parent/5147",[1,0.611,2,0.611,2904,2.238,3012,0.86,3813,4.772]],["name/5148",[3814,84.686]],["parent/5148",[1,0.611,2,0.611,2904,2.238,3012,0.86,3813,4.772]],["name/5149",[3815,84.686]],["parent/5149",[1,0.611,2,0.611,2904,2.238,3012,0.86,3813,4.772]],["name/5150",[3816,84.686]],["parent/5150",[1,0.611,2,0.611,2904,2.238,3012,0.86,3813,4.772]],["name/5151",[3817,84.686]],["parent/5151",[1,0.611,2,0.611,2904,2.238,3012,0.86,3813,4.772]],["name/5152",[3818,84.686]],["parent/5152",[1,0.611,2,0.611,2904,2.238,3012,0.86,3813,4.772]],["name/5153",[3819,84.686]],["parent/5153",[1,0.611,2,0.611,2904,2.238,3012,0.86,3813,4.772]],["name/5154",[163,53.406]],["parent/5154",[1,0.611,2,0.611,2904,2.238,3012,0.86,3813,4.772]],["name/5155",[1,3.307,2,3.307,3,11.438,3012,4.654,3820,20.452]],["parent/5155",[]],["name/5156",[3821,84.686]],["parent/5156",[1,0.611,2,0.611,3,2.113,3012,0.86,3820,3.779]],["name/5157",[3822,84.686]],["parent/5157",[1,0.611,2,0.611,3012,0.86,3820,3.779,3823,4.553]],["name/5158",[443,79.491]],["parent/5158",[1,0.611,2,0.611,3012,0.86,3820,3.779,3823,4.553]],["name/5159",[3642,61.614]],["parent/5159",[1,0.611,2,0.611,3012,0.86,3820,3.779,3823,4.553]],["name/5160",[279,32.637]],["parent/5160",[1,0.611,2,0.611,3012,0.86,3820,3.779,3823,4.553]],["name/5161",[3824,76.069]],["parent/5161",[1,0.611,2,0.611,3012,0.86,3820,3.779,3823,4.553]],["name/5162",[3825,84.686]],["parent/5162",[1,0.611,2,0.611,3012,0.86,3820,3.779,3823,4.553]],["name/5163",[2894,63.123]],["parent/5163",[1,0.611,2,0.611,3012,0.86,3820,3.779,3823,4.553]],["name/5164",[123,37.886]],["parent/5164",[1,0.611,2,0.611,3012,0.86,3820,3.779,3823,4.553]],["name/5165",[3826,84.686]],["parent/5165",[1,0.611,2,0.611,3012,0.86,3820,3.779,3823,4.553]],["name/5166",[2879,69.774]],["parent/5166",[1,0.611,2,0.611,3012,0.86,3820,3.779,3823,4.553]],["name/5167",[3827,84.686]],["parent/5167",[1,0.611,2,0.611,3012,0.86,3820,3.779,3823,4.553]],["name/5168",[3828,84.686]],["parent/5168",[1,0.611,2,0.611,3,2.113,3012,0.86,3820,3.779]],["name/5169",[3829,84.686]],["parent/5169",[1,0.611,2,0.611,3012,0.86,3820,3.779,3830,5.087]],["name/5170",[3831,84.686]],["parent/5170",[1,0.611,2,0.611,3012,0.86,3820,3.779,3830,5.087]],["name/5171",[1048,79.491]],["parent/5171",[1,0.611,2,0.611,3012,0.86,3820,3.779,3830,5.087]],["name/5172",[3832,84.686]],["parent/5172",[1,0.611,2,0.611,3012,0.86,3820,3.779,3830,5.087]],["name/5173",[139,71.473]],["parent/5173",[1,0.611,2,0.611,3012,0.86,3820,3.779,3830,5.087]],["name/5174",[3833,84.686]],["parent/5174",[1,0.611,2,0.611,3,2.113,3012,0.86,3820,3.779]],["name/5175",[3834,84.686]],["parent/5175",[1,0.611,2,0.611,3012,0.86,3820,3.779,3835,5.232]],["name/5176",[3836,84.686]],["parent/5176",[1,0.611,2,0.611,3012,0.86,3820,3.779,3835,5.232]],["name/5177",[153,73.514]],["parent/5177",[1,0.611,2,0.611,3012,0.86,3820,3.779,3835,5.232]],["name/5178",[3025,73.514]],["parent/5178",[1,0.611,2,0.611,3012,0.86,3820,3.779,3835,5.232]],["name/5179",[3837,84.686]],["parent/5179",[1,0.611,2,0.611,3,2.113,3012,0.86,3820,3.779]],["name/5180",[2830,71.473]],["parent/5180",[1,0.611,2,0.611,3012,0.86,3820,3.779,3838,6.027]],["name/5181",[3839,84.686]],["parent/5181",[1,0.611,2,0.611,3,2.113,3012,0.86,3820,3.779]],["name/5182",[1032,63.123]],["parent/5182",[1,0.611,2,0.611,3012,0.86,3820,3.779,3840,6.027]],["name/5183",[3841,84.686]],["parent/5183",[1,0.611,2,0.611,3,2.113,3012,0.86,3820,3.779]],["name/5184",[279,32.637]],["parent/5184",[1,0.611,2,0.611,3012,0.86,3820,3.779,3842,6.027]],["name/5185",[3843,79.491]],["parent/5185",[1,0.611,2,0.611,3,2.113,3012,0.86,3820,3.779]],["name/5186",[3843,79.491]],["parent/5186",[1,0.611,2,0.611,3012,0.86,3820,3.779,3844,5.657]],["name/5187",[3845,84.686]],["parent/5187",[1,0.611,2,0.611,3012,0.86,3820,3.779,3844,5.657]],["name/5188",[1,3.307,2,3.307,3,11.438,3012,4.654,3846,12.524]],["parent/5188",[]],["name/5189",[3847,84.686]],["parent/5189",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5190",[3848,79.491]],["parent/5190",[1,0.611,2,0.611,3012,0.86,3846,2.314,3849,4.862]],["name/5191",[3850,79.491]],["parent/5191",[1,0.611,2,0.611,3012,0.86,3846,2.314,3849,4.862]],["name/5192",[3851,79.491]],["parent/5192",[1,0.611,2,0.611,3012,0.86,3846,2.314,3849,4.862]],["name/5193",[3852,79.491]],["parent/5193",[1,0.611,2,0.611,3012,0.86,3846,2.314,3849,4.862]],["name/5194",[3853,79.491]],["parent/5194",[1,0.611,2,0.611,3012,0.86,3846,2.314,3849,4.862]],["name/5195",[2913,73.514]],["parent/5195",[1,0.611,2,0.611,3012,0.86,3846,2.314,3849,4.862]],["name/5196",[3854,71.473]],["parent/5196",[1,0.611,2,0.611,3012,0.86,3846,2.314,3849,4.862]],["name/5197",[3855,84.686]],["parent/5197",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5198",[3856,84.686]],["parent/5198",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5199",[3858,84.686]],["parent/5199",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5200",[3859,84.686]],["parent/5200",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5201",[3860,84.686]],["parent/5201",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5202",[3861,84.686]],["parent/5202",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5203",[3862,84.686]],["parent/5203",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5204",[3863,84.686]],["parent/5204",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5205",[3864,84.686]],["parent/5205",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5206",[3865,84.686]],["parent/5206",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5207",[3866,84.686]],["parent/5207",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5208",[3867,84.686]],["parent/5208",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5209",[3868,84.686]],["parent/5209",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5210",[3869,84.686]],["parent/5210",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5211",[1032,63.123]],["parent/5211",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5212",[3870,84.686]],["parent/5212",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5213",[3871,84.686]],["parent/5213",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5214",[3872,84.686]],["parent/5214",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5215",[3873,84.686]],["parent/5215",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5216",[3874,84.686]],["parent/5216",[1,0.611,2,0.611,3012,0.86,3846,2.314,3857,4.171]],["name/5217",[3875,84.686]],["parent/5217",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5218",[279,32.637]],["parent/5218",[1,0.611,2,0.611,3012,0.86,3846,2.314,3876,6.027]],["name/5219",[3877,84.686]],["parent/5219",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5220",[279,32.637]],["parent/5220",[1,0.611,2,0.611,3012,0.86,3846,2.314,3878,6.027]],["name/5221",[3879,84.686]],["parent/5221",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5222",[279,32.637]],["parent/5222",[1,0.611,2,0.611,3012,0.86,3846,2.314,3880,6.027]],["name/5223",[3881,84.686]],["parent/5223",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5224",[279,32.637]],["parent/5224",[1,0.611,2,0.611,3012,0.86,3846,2.314,3882,6.027]],["name/5225",[3883,84.686]],["parent/5225",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5226",[279,32.637]],["parent/5226",[1,0.611,2,0.611,3012,0.86,3846,2.314,3884,6.027]],["name/5227",[3885,84.686]],["parent/5227",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5228",[279,32.637]],["parent/5228",[1,0.611,2,0.611,3012,0.86,3846,2.314,3886,6.027]],["name/5229",[3887,84.686]],["parent/5229",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5230",[279,32.637]],["parent/5230",[1,0.611,2,0.611,3012,0.86,3846,2.314,3888,6.027]],["name/5231",[3889,84.686]],["parent/5231",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5232",[279,32.637]],["parent/5232",[1,0.611,2,0.611,3012,0.86,3846,2.314,3890,6.027]],["name/5233",[3891,84.686]],["parent/5233",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5234",[279,32.637]],["parent/5234",[1,0.611,2,0.611,3012,0.86,3846,2.314,3892,6.027]],["name/5235",[3893,84.686]],["parent/5235",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5236",[279,32.637]],["parent/5236",[1,0.611,2,0.611,3012,0.86,3846,2.314,3894,6.027]],["name/5237",[3895,84.686]],["parent/5237",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5238",[3896,68.319]],["parent/5238",[1,0.611,2,0.611,3012,0.86,3846,2.314,3897,6.027]],["name/5239",[3898,84.686]],["parent/5239",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5240",[1458,67.046]],["parent/5240",[1,0.611,2,0.611,3012,0.86,3846,2.314,3899,5.414]],["name/5241",[3900,84.686]],["parent/5241",[1,0.611,2,0.611,3012,0.86,3846,2.314,3899,5.414]],["name/5242",[3901,84.686]],["parent/5242",[1,0.611,2,0.611,3012,0.86,3846,2.314,3899,5.414]],["name/5243",[3902,84.686]],["parent/5243",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5244",[3903,79.491]],["parent/5244",[1,0.611,2,0.611,3012,0.86,3846,2.314,3904,5.414]],["name/5245",[3824,76.069]],["parent/5245",[1,0.611,2,0.611,3012,0.86,3846,2.314,3904,5.414]],["name/5246",[3905,84.686]],["parent/5246",[1,0.611,2,0.611,3012,0.86,3846,2.314,3904,5.414]],["name/5247",[3906,84.686]],["parent/5247",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5248",[3896,68.319]],["parent/5248",[1,0.611,2,0.611,3012,0.86,3846,2.314,3907,5.087]],["name/5249",[3908,79.491]],["parent/5249",[1,0.611,2,0.611,3012,0.86,3846,2.314,3907,5.087]],["name/5250",[3909,79.491]],["parent/5250",[1,0.611,2,0.611,3012,0.86,3846,2.314,3907,5.087]],["name/5251",[3910,79.491]],["parent/5251",[1,0.611,2,0.611,3012,0.86,3846,2.314,3907,5.087]],["name/5252",[3374,69.774]],["parent/5252",[1,0.611,2,0.611,3012,0.86,3846,2.314,3907,5.087]],["name/5253",[3911,84.686]],["parent/5253",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5254",[3912,84.686]],["parent/5254",[1,0.611,2,0.611,3012,0.86,3846,2.314,3913,4.619]],["name/5255",[3914,84.686]],["parent/5255",[1,0.611,2,0.611,3012,0.86,3846,2.314,3913,4.619]],["name/5256",[189,39.191]],["parent/5256",[1,0.611,2,0.611,3012,0.86,3846,2.314,3915,4.966]],["name/5257",[191,49.763]],["parent/5257",[1,0.611,2,0.611,3012,0.86,3846,2.314,3915,4.966]],["name/5258",[46,42.129]],["parent/5258",[1,0.611,2,0.611,3012,0.86,3846,2.314,3915,4.966]],["name/5259",[123,37.886]],["parent/5259",[1,0.611,2,0.611,3012,0.86,3846,2.314,3915,4.966]],["name/5260",[275,58.601]],["parent/5260",[1,0.611,2,0.611,3012,0.86,3846,2.314,3915,4.966]],["name/5261",[192,48.337]],["parent/5261",[1,0.611,2,0.611,3012,0.86,3846,2.314,3915,4.966]],["name/5262",[3916,84.686]],["parent/5262",[1,0.611,2,0.611,3012,0.86,3846,2.314,3913,4.619]],["name/5263",[275,58.601]],["parent/5263",[1,0.611,2,0.611,3012,0.86,3846,2.314,3917,6.027]],["name/5264",[3918,84.686]],["parent/5264",[1,0.611,2,0.611,3012,0.86,3846,2.314,3913,4.619]],["name/5265",[189,39.191]],["parent/5265",[1,0.611,2,0.611,3012,0.86,3846,2.314,3919,4.966]],["name/5266",[191,49.763]],["parent/5266",[1,0.611,2,0.611,3012,0.86,3846,2.314,3919,4.966]],["name/5267",[46,42.129]],["parent/5267",[1,0.611,2,0.611,3012,0.86,3846,2.314,3919,4.966]],["name/5268",[123,37.886]],["parent/5268",[1,0.611,2,0.611,3012,0.86,3846,2.314,3919,4.966]],["name/5269",[201,59.136]],["parent/5269",[1,0.611,2,0.611,3012,0.86,3846,2.314,3919,4.966]],["name/5270",[192,48.337]],["parent/5270",[1,0.611,2,0.611,3012,0.86,3846,2.314,3919,4.966]],["name/5271",[3920,84.686]],["parent/5271",[1,0.611,2,0.611,3012,0.86,3846,2.314,3913,4.619]],["name/5272",[189,39.191]],["parent/5272",[1,0.611,2,0.611,3012,0.86,3846,2.314,3921,4.966]],["name/5273",[191,49.763]],["parent/5273",[1,0.611,2,0.611,3012,0.86,3846,2.314,3921,4.966]],["name/5274",[46,42.129]],["parent/5274",[1,0.611,2,0.611,3012,0.86,3846,2.314,3921,4.966]],["name/5275",[123,37.886]],["parent/5275",[1,0.611,2,0.611,3012,0.86,3846,2.314,3921,4.966]],["name/5276",[201,59.136]],["parent/5276",[1,0.611,2,0.611,3012,0.86,3846,2.314,3921,4.966]],["name/5277",[192,48.337]],["parent/5277",[1,0.611,2,0.611,3012,0.86,3846,2.314,3921,4.966]],["name/5278",[3922,84.686]],["parent/5278",[1,0.611,2,0.611,3012,0.86,3846,2.314,3913,4.619]],["name/5279",[189,39.191]],["parent/5279",[1,0.611,2,0.611,3012,0.86,3846,2.314,3923,4.966]],["name/5280",[191,49.763]],["parent/5280",[1,0.611,2,0.611,3012,0.86,3846,2.314,3923,4.966]],["name/5281",[46,42.129]],["parent/5281",[1,0.611,2,0.611,3012,0.86,3846,2.314,3923,4.966]],["name/5282",[123,37.886]],["parent/5282",[1,0.611,2,0.611,3012,0.86,3846,2.314,3923,4.966]],["name/5283",[201,59.136]],["parent/5283",[1,0.611,2,0.611,3012,0.86,3846,2.314,3923,4.966]],["name/5284",[192,48.337]],["parent/5284",[1,0.611,2,0.611,3012,0.86,3846,2.314,3923,4.966]],["name/5285",[3924,84.686]],["parent/5285",[1,0.611,2,0.611,3012,0.86,3846,2.314,3913,4.619]],["name/5286",[189,39.191]],["parent/5286",[1,0.611,2,0.611,3012,0.86,3846,2.314,3925,4.966]],["name/5287",[191,49.763]],["parent/5287",[1,0.611,2,0.611,3012,0.86,3846,2.314,3925,4.966]],["name/5288",[46,42.129]],["parent/5288",[1,0.611,2,0.611,3012,0.86,3846,2.314,3925,4.966]],["name/5289",[123,37.886]],["parent/5289",[1,0.611,2,0.611,3012,0.86,3846,2.314,3925,4.966]],["name/5290",[201,59.136]],["parent/5290",[1,0.611,2,0.611,3012,0.86,3846,2.314,3925,4.966]],["name/5291",[192,48.337]],["parent/5291",[1,0.611,2,0.611,3012,0.86,3846,2.314,3925,4.966]],["name/5292",[3926,84.686]],["parent/5292",[1,0.611,2,0.611,3012,0.86,3846,2.314,3913,4.619]],["name/5293",[189,39.191]],["parent/5293",[1,0.611,2,0.611,3012,0.86,3846,2.314,3927,4.966]],["name/5294",[191,49.763]],["parent/5294",[1,0.611,2,0.611,3012,0.86,3846,2.314,3927,4.966]],["name/5295",[46,42.129]],["parent/5295",[1,0.611,2,0.611,3012,0.86,3846,2.314,3927,4.966]],["name/5296",[123,37.886]],["parent/5296",[1,0.611,2,0.611,3012,0.86,3846,2.314,3927,4.966]],["name/5297",[201,59.136]],["parent/5297",[1,0.611,2,0.611,3012,0.86,3846,2.314,3927,4.966]],["name/5298",[192,48.337]],["parent/5298",[1,0.611,2,0.611,3012,0.86,3846,2.314,3927,4.966]],["name/5299",[3928,84.686]],["parent/5299",[1,0.611,2,0.611,3012,0.86,3846,2.314,3913,4.619]],["name/5300",[189,39.191]],["parent/5300",[1,0.611,2,0.611,3012,0.86,3846,2.314,3929,5.087]],["name/5301",[46,42.129]],["parent/5301",[1,0.611,2,0.611,3012,0.86,3846,2.314,3929,5.087]],["name/5302",[123,37.886]],["parent/5302",[1,0.611,2,0.611,3012,0.86,3846,2.314,3929,5.087]],["name/5303",[201,59.136]],["parent/5303",[1,0.611,2,0.611,3012,0.86,3846,2.314,3929,5.087]],["name/5304",[192,48.337]],["parent/5304",[1,0.611,2,0.611,3012,0.86,3846,2.314,3929,5.087]],["name/5305",[3930,84.686]],["parent/5305",[1,0.611,2,0.611,3012,0.86,3846,2.314,3913,4.619]],["name/5306",[3931,84.686]],["parent/5306",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5307",[123,37.886]],["parent/5307",[1,0.611,2,0.611,3012,0.86,3846,2.314,3932,5.232]],["name/5308",[251,62.341]],["parent/5308",[1,0.611,2,0.611,3012,0.86,3846,2.314,3932,5.232]],["name/5309",[123,37.886]],["parent/5309",[1,0.611,2,0.611,3012,0.86,3846,2.314,3933,5.087]],["name/5310",[44,64.897]],["parent/5310",[1,0.611,2,0.611,3012,0.86,3846,2.314,3933,5.087]],["name/5311",[46,42.129]],["parent/5311",[1,0.611,2,0.611,3012,0.86,3846,2.314,3933,5.087]],["name/5312",[253,62.341]],["parent/5312",[1,0.611,2,0.611,3012,0.86,3846,2.314,3933,5.087]],["name/5313",[2913,73.514]],["parent/5313",[1,0.611,2,0.611,3012,0.86,3846,2.314,3934,4.862]],["name/5314",[123,37.886]],["parent/5314",[1,0.611,2,0.611,3012,0.86,3846,2.314,3935,5.414]],["name/5315",[257,52.508]],["parent/5315",[1,0.611,2,0.611,3012,0.86,3846,2.314,3935,5.414]],["name/5316",[258,63.971]],["parent/5316",[1,0.611,2,0.611,3012,0.86,3846,2.314,3935,5.414]],["name/5317",[3850,79.491]],["parent/5317",[1,0.611,2,0.611,3012,0.86,3846,2.314,3934,4.862]],["name/5318",[123,37.886]],["parent/5318",[1,0.611,2,0.611,3012,0.86,3846,2.314,3936,5.657]],["name/5319",[257,52.508]],["parent/5319",[1,0.611,2,0.611,3012,0.86,3846,2.314,3936,5.657]],["name/5320",[3851,79.491]],["parent/5320",[1,0.611,2,0.611,3012,0.86,3846,2.314,3934,4.862]],["name/5321",[123,37.886]],["parent/5321",[1,0.611,2,0.611,3012,0.86,3846,2.314,3937,5.414]],["name/5322",[257,52.508]],["parent/5322",[1,0.611,2,0.611,3012,0.86,3846,2.314,3937,5.414]],["name/5323",[258,63.971]],["parent/5323",[1,0.611,2,0.611,3012,0.86,3846,2.314,3937,5.414]],["name/5324",[3853,79.491]],["parent/5324",[1,0.611,2,0.611,3012,0.86,3846,2.314,3934,4.862]],["name/5325",[123,37.886]],["parent/5325",[1,0.611,2,0.611,3012,0.86,3846,2.314,3938,5.657]],["name/5326",[257,52.508]],["parent/5326",[1,0.611,2,0.611,3012,0.86,3846,2.314,3938,5.657]],["name/5327",[3848,79.491]],["parent/5327",[1,0.611,2,0.611,3012,0.86,3846,2.314,3934,4.862]],["name/5328",[123,37.886]],["parent/5328",[1,0.611,2,0.611,3012,0.86,3846,2.314,3939,5.414]],["name/5329",[257,52.508]],["parent/5329",[1,0.611,2,0.611,3012,0.86,3846,2.314,3939,5.414]],["name/5330",[258,63.971]],["parent/5330",[1,0.611,2,0.611,3012,0.86,3846,2.314,3939,5.414]],["name/5331",[3854,71.473]],["parent/5331",[1,0.611,2,0.611,3012,0.86,3846,2.314,3934,4.862]],["name/5332",[123,37.886]],["parent/5332",[1,0.611,2,0.611,3012,0.86,3846,2.314,3940,5.657]],["name/5333",[257,52.508]],["parent/5333",[1,0.611,2,0.611,3012,0.86,3846,2.314,3940,5.657]],["name/5334",[3852,79.491]],["parent/5334",[1,0.611,2,0.611,3012,0.86,3846,2.314,3934,4.862]],["name/5335",[123,37.886]],["parent/5335",[1,0.611,2,0.611,3012,0.86,3846,2.314,3941,5.657]],["name/5336",[257,52.508]],["parent/5336",[1,0.611,2,0.611,3012,0.86,3846,2.314,3941,5.657]],["name/5337",[275,58.601]],["parent/5337",[1,0.611,2,0.611,3012,0.86,3846,2.314,3933,5.087]],["name/5338",[276,71.473]],["parent/5338",[1,0.611,2,0.611,3012,0.86,3846,2.314,3932,5.232]],["name/5339",[277,73.514]],["parent/5339",[1,0.611,2,0.611,3012,0.86,3846,2.314,3932,5.232]],["name/5340",[3942,84.686]],["parent/5340",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5341",[3896,68.319]],["parent/5341",[1,0.611,2,0.611,3012,0.86,3846,2.314,3943,5.657]],["name/5342",[122,56.704]],["parent/5342",[1,0.611,2,0.611,3012,0.86,3846,2.314,3943,5.657]],["name/5343",[3944,84.686]],["parent/5343",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5344",[1644,63.123]],["parent/5344",[1,0.611,2,0.611,3012,0.86,3846,2.314,3945,5.414]],["name/5345",[3033,76.069]],["parent/5345",[1,0.611,2,0.611,3012,0.86,3846,2.314,3945,5.414]],["name/5346",[1670,69.774]],["parent/5346",[1,0.611,2,0.611,3012,0.86,3846,2.314,3945,5.414]],["name/5347",[3946,84.686]],["parent/5347",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5348",[18,47.256]],["parent/5348",[1,0.611,2,0.611,3012,0.86,3846,2.314,3947,6.027]],["name/5349",[3948,84.686]],["parent/5349",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5350",[112,60.3]],["parent/5350",[1,0.611,2,0.611,3012,0.86,3846,2.314,3949,5.657]],["name/5351",[122,56.704]],["parent/5351",[1,0.611,2,0.611,3012,0.86,3846,2.314,3949,5.657]],["name/5352",[3950,84.686]],["parent/5352",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5353",[279,23.328,3846,23.241]],["parent/5353",[1,0.611,2,0.611,3012,0.86,3846,2.314,3951,5.414]],["name/5354",[572,47.922,3846,23.241]],["parent/5354",[1,0.611,2,0.611,3012,0.86,3846,2.314,3951,5.414]],["name/5355",[1004,45.119,3846,23.241]],["parent/5355",[1,0.611,2,0.611,3012,0.86,3846,2.314,3951,5.414]],["name/5356",[3952,84.686]],["parent/5356",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5357",[112,60.3]],["parent/5357",[1,0.611,2,0.611,3012,0.86,3846,2.314,3953,5.657]],["name/5358",[805,79.491]],["parent/5358",[1,0.611,2,0.611,3012,0.86,3846,2.314,3953,5.657]],["name/5359",[3954,84.686]],["parent/5359",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5360",[112,60.3]],["parent/5360",[1,0.611,2,0.611,3012,0.86,3846,2.314,3955,5.657]],["name/5361",[122,56.704]],["parent/5361",[1,0.611,2,0.611,3012,0.86,3846,2.314,3955,5.657]],["name/5362",[3956,84.686]],["parent/5362",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5363",[3957,84.686]],["parent/5363",[1,0.611,2,0.611,3012,0.86,3846,2.314,3958,5.657]],["name/5364",[3959,79.491]],["parent/5364",[1,0.611,2,0.611,3012,0.86,3846,2.314,3958,5.657]],["name/5365",[3960,84.686]],["parent/5365",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5366",[1644,63.123]],["parent/5366",[1,0.611,2,0.611,3012,0.86,3846,2.314,3961,4.966]],["name/5367",[3962,79.491]],["parent/5367",[1,0.611,2,0.611,3012,0.86,3846,2.314,3961,4.966]],["name/5368",[3963,84.686]],["parent/5368",[1,0.611,2,0.611,3012,0.86,3846,2.314,3961,4.966]],["name/5369",[3034,73.514]],["parent/5369",[1,0.611,2,0.611,3012,0.86,3846,2.314,3961,4.966]],["name/5370",[3896,68.319]],["parent/5370",[1,0.611,2,0.611,3012,0.86,3846,2.314,3961,4.966]],["name/5371",[3959,79.491]],["parent/5371",[1,0.611,2,0.611,3012,0.86,3846,2.314,3961,4.966]],["name/5372",[3964,84.686]],["parent/5372",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5373",[1644,63.123]],["parent/5373",[1,0.611,2,0.611,3012,0.86,3846,2.314,3965,4.966]],["name/5374",[3966,84.686]],["parent/5374",[1,0.611,2,0.611,3012,0.86,3846,2.314,3965,4.966]],["name/5375",[3967,84.686]],["parent/5375",[1,0.611,2,0.611,3012,0.86,3846,2.314,3965,4.966]],["name/5376",[3968,84.686]],["parent/5376",[1,0.611,2,0.611,3012,0.86,3846,2.314,3965,4.966]],["name/5377",[3033,76.069]],["parent/5377",[1,0.611,2,0.611,3012,0.86,3846,2.314,3965,4.966]],["name/5378",[1670,69.774]],["parent/5378",[1,0.611,2,0.611,3012,0.86,3846,2.314,3965,4.966]],["name/5379",[3969,84.686]],["parent/5379",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5380",[1644,63.123]],["parent/5380",[1,0.611,2,0.611,3012,0.86,3846,2.314,3970,5.232]],["name/5381",[3971,84.686]],["parent/5381",[1,0.611,2,0.611,3012,0.86,3846,2.314,3970,5.232]],["name/5382",[3034,73.514]],["parent/5382",[1,0.611,2,0.611,3012,0.86,3846,2.314,3970,5.232]],["name/5383",[3896,68.319]],["parent/5383",[1,0.611,2,0.611,3012,0.86,3846,2.314,3970,5.232]],["name/5384",[3972,84.686]],["parent/5384",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5385",[1644,63.123]],["parent/5385",[1,0.611,2,0.611,3012,0.86,3846,2.314,3973,5.232]],["name/5386",[3962,79.491]],["parent/5386",[1,0.611,2,0.611,3012,0.86,3846,2.314,3973,5.232]],["name/5387",[3034,73.514]],["parent/5387",[1,0.611,2,0.611,3012,0.86,3846,2.314,3973,5.232]],["name/5388",[3896,68.319]],["parent/5388",[1,0.611,2,0.611,3012,0.86,3846,2.314,3973,5.232]],["name/5389",[3974,84.686]],["parent/5389",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5390",[3975,84.686]],["parent/5390",[1,0.611,2,0.611,3012,0.86,3846,2.314,3976,5.414]],["name/5391",[3977,84.686]],["parent/5391",[1,0.611,2,0.611,3012,0.86,3846,2.314,3976,5.414]],["name/5392",[3978,84.686]],["parent/5392",[1,0.611,2,0.611,3012,0.86,3846,2.314,3976,5.414]],["name/5393",[3979,84.686]],["parent/5393",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5394",[3980,84.686]],["parent/5394",[1,0.611,2,0.611,3012,0.86,3846,2.314,3981,5.657]],["name/5395",[3086,76.069]],["parent/5395",[1,0.611,2,0.611,3012,0.86,3846,2.314,3981,5.657]],["name/5396",[3982,84.686]],["parent/5396",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5397",[3983,84.686]],["parent/5397",[1,0.611,2,0.611,3012,0.86,3846,2.314,3984,5.232]],["name/5398",[2916,76.069]],["parent/5398",[1,0.611,2,0.611,3012,0.86,3846,2.314,3984,5.232]],["name/5399",[3985,84.686]],["parent/5399",[1,0.611,2,0.611,3012,0.86,3846,2.314,3984,5.232]],["name/5400",[2937,71.473]],["parent/5400",[1,0.611,2,0.611,3012,0.86,3846,2.314,3984,5.232]],["name/5401",[3986,84.686]],["parent/5401",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5402",[3987,84.686]],["parent/5402",[1,0.611,2,0.611,3012,0.86,3846,2.314,3988,5.414]],["name/5403",[2917,79.491]],["parent/5403",[1,0.611,2,0.611,3012,0.86,3846,2.314,3988,5.414]],["name/5404",[3989,84.686]],["parent/5404",[1,0.611,2,0.611,3012,0.86,3846,2.314,3988,5.414]],["name/5405",[3990,84.686]],["parent/5405",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5406",[3991,84.686]],["parent/5406",[1,0.611,2,0.611,3012,0.86,3846,2.314,3992,5.657]],["name/5407",[1011,53.098]],["parent/5407",[1,0.611,2,0.611,3012,0.86,3846,2.314,3992,5.657]],["name/5408",[3993,84.686]],["parent/5408",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5409",[3896,68.319]],["parent/5409",[1,0.611,2,0.611,3012,0.86,3846,2.314,3994,4.691]],["name/5410",[3995,84.686]],["parent/5410",[1,0.611,2,0.611,3012,0.86,3846,2.314,3994,4.691]],["name/5411",[3908,79.491]],["parent/5411",[1,0.611,2,0.611,3012,0.86,3846,2.314,3994,4.691]],["name/5412",[3910,79.491]],["parent/5412",[1,0.611,2,0.611,3012,0.86,3846,2.314,3994,4.691]],["name/5413",[3374,69.774]],["parent/5413",[1,0.611,2,0.611,3012,0.86,3846,2.314,3994,4.691]],["name/5414",[3909,79.491]],["parent/5414",[1,0.611,2,0.611,3012,0.86,3846,2.314,3994,4.691]],["name/5415",[3996,84.686]],["parent/5415",[1,0.611,2,0.611,3012,0.86,3846,2.314,3994,4.691]],["name/5416",[3997,84.686]],["parent/5416",[1,0.611,2,0.611,3012,0.86,3846,2.314,3994,4.691]],["name/5417",[3998,84.686]],["parent/5417",[1,0.611,2,0.611,3012,0.86,3846,2.314,3994,4.691]],["name/5418",[3999,84.686]],["parent/5418",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5419",[2830,71.473]],["parent/5419",[1,0.611,2,0.611,3012,0.86,3846,2.314,4000,4.619]],["name/5420",[4001,84.686]],["parent/5420",[1,0.611,2,0.611,3012,0.86,3846,2.314,4000,4.619]],["name/5421",[4002,84.686]],["parent/5421",[1,0.611,2,0.611,3012,0.86,3846,2.314,4000,4.619]],["name/5422",[4003,84.686]],["parent/5422",[1,0.611,2,0.611,3012,0.86,3846,2.314,4000,4.619]],["name/5423",[4004,84.686]],["parent/5423",[1,0.611,2,0.611,3012,0.86,3846,2.314,4000,4.619]],["name/5424",[4005,84.686]],["parent/5424",[1,0.611,2,0.611,3012,0.86,3846,2.314,4000,4.619]],["name/5425",[2832,76.069]],["parent/5425",[1,0.611,2,0.611,3012,0.86,3846,2.314,4000,4.619]],["name/5426",[2833,76.069]],["parent/5426",[1,0.611,2,0.611,3012,0.86,3846,2.314,4000,4.619]],["name/5427",[4006,84.686]],["parent/5427",[1,0.611,2,0.611,3012,0.86,3846,2.314,4000,4.619]],["name/5428",[4007,84.686]],["parent/5428",[1,0.611,2,0.611,3012,0.86,3846,2.314,4000,4.619]],["name/5429",[4008,84.686]],["parent/5429",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5430",[4009,84.686]],["parent/5430",[1,0.611,2,0.611,3012,0.86,3846,2.314,4010,5.087]],["name/5431",[4011,84.686]],["parent/5431",[1,0.611,2,0.611,3012,0.86,3846,2.314,4010,5.087]],["name/5432",[4012,84.686]],["parent/5432",[1,0.611,2,0.611,3012,0.86,3846,2.314,4010,5.087]],["name/5433",[4013,84.686]],["parent/5433",[1,0.611,2,0.611,3012,0.86,3846,2.314,4010,5.087]],["name/5434",[4014,84.686]],["parent/5434",[1,0.611,2,0.611,3012,0.86,3846,2.314,4010,5.087]],["name/5435",[4015,84.686]],["parent/5435",[1,0.611,2,0.611,3,2.113,3012,0.86,3846,2.314]],["name/5436",[4016,84.686]],["parent/5436",[1,0.611,2,0.611,3012,0.86,3846,2.314,4017,5.657]],["name/5437",[4018,84.686]],["parent/5437",[1,0.611,2,0.611,3012,0.86,3846,2.314,4017,5.657]],["name/5438",[1,3.307,2,3.307,3,11.438,3012,4.654,3447,15.066]],["parent/5438",[]],["name/5439",[4019,79.491]],["parent/5439",[1,0.611,2,0.611,3,2.113,3012,0.86,3447,2.784]],["name/5440",[1027,68.319]],["parent/5440",[1,0.611,2,0.611,3012,0.86,3447,2.784,4020,4.862]],["name/5441",[259,63.971]],["parent/5441",[1,0.611,2,0.611,3012,0.86,3447,2.784,4020,4.862]],["name/5442",[261,58.092]],["parent/5442",[1,0.611,2,0.611,3012,0.86,3447,2.784,4020,4.862]],["name/5443",[263,69.774]],["parent/5443",[1,0.611,2,0.611,3012,0.86,3447,2.784,4020,4.862]],["name/5444",[4021,79.491]],["parent/5444",[1,0.611,2,0.611,3012,0.86,3447,2.784,4020,4.862]],["name/5445",[4022,79.491]],["parent/5445",[1,0.611,2,0.611,3012,0.86,3447,2.784,4020,4.862]],["name/5446",[4023,76.069]],["parent/5446",[1,0.611,2,0.611,3012,0.86,3447,2.784,4020,4.862]],["name/5447",[4024,84.686]],["parent/5447",[1,0.611,2,0.611,3,2.113,3012,0.86,3447,2.784]],["name/5448",[4025,84.686]],["parent/5448",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5449",[4019,79.491]],["parent/5449",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5450",[4027,84.686]],["parent/5450",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5451",[4028,84.686]],["parent/5451",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5452",[189,39.191]],["parent/5452",[1,0.611,2,0.611,3012,0.86,3447,2.784,4029,4.966]],["name/5453",[191,49.763]],["parent/5453",[1,0.611,2,0.611,3012,0.86,3447,2.784,4029,4.966]],["name/5454",[46,42.129]],["parent/5454",[1,0.611,2,0.611,3012,0.86,3447,2.784,4029,4.966]],["name/5455",[123,37.886]],["parent/5455",[1,0.611,2,0.611,3012,0.86,3447,2.784,4029,4.966]],["name/5456",[275,58.601]],["parent/5456",[1,0.611,2,0.611,3012,0.86,3447,2.784,4029,4.966]],["name/5457",[192,48.337]],["parent/5457",[1,0.611,2,0.611,3012,0.86,3447,2.784,4029,4.966]],["name/5458",[4030,84.686]],["parent/5458",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5459",[4031,84.686]],["parent/5459",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5460",[189,39.191]],["parent/5460",[1,0.611,2,0.611,3012,0.86,3447,2.784,4032,4.966]],["name/5461",[191,49.763]],["parent/5461",[1,0.611,2,0.611,3012,0.86,3447,2.784,4032,4.966]],["name/5462",[46,42.129]],["parent/5462",[1,0.611,2,0.611,3012,0.86,3447,2.784,4032,4.966]],["name/5463",[123,37.886]],["parent/5463",[1,0.611,2,0.611,3012,0.86,3447,2.784,4032,4.966]],["name/5464",[201,59.136]],["parent/5464",[1,0.611,2,0.611,3012,0.86,3447,2.784,4032,4.966]],["name/5465",[192,48.337]],["parent/5465",[1,0.611,2,0.611,3012,0.86,3447,2.784,4032,4.966]],["name/5466",[4033,84.686]],["parent/5466",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5467",[189,39.191]],["parent/5467",[1,0.611,2,0.611,3012,0.86,3447,2.784,4034,4.966]],["name/5468",[191,49.763]],["parent/5468",[1,0.611,2,0.611,3012,0.86,3447,2.784,4034,4.966]],["name/5469",[46,42.129]],["parent/5469",[1,0.611,2,0.611,3012,0.86,3447,2.784,4034,4.966]],["name/5470",[123,37.886]],["parent/5470",[1,0.611,2,0.611,3012,0.86,3447,2.784,4034,4.966]],["name/5471",[275,58.601]],["parent/5471",[1,0.611,2,0.611,3012,0.86,3447,2.784,4034,4.966]],["name/5472",[192,48.337]],["parent/5472",[1,0.611,2,0.611,3012,0.86,3447,2.784,4034,4.966]],["name/5473",[4035,84.686]],["parent/5473",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5474",[4036,84.686]],["parent/5474",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5475",[189,39.191]],["parent/5475",[1,0.611,2,0.611,3012,0.86,3447,2.784,4037,5.087]],["name/5476",[191,49.763]],["parent/5476",[1,0.611,2,0.611,3012,0.86,3447,2.784,4037,5.087]],["name/5477",[46,42.129]],["parent/5477",[1,0.611,2,0.611,3012,0.86,3447,2.784,4037,5.087]],["name/5478",[123,37.886]],["parent/5478",[1,0.611,2,0.611,3012,0.86,3447,2.784,4037,5.087]],["name/5479",[192,48.337]],["parent/5479",[1,0.611,2,0.611,3012,0.86,3447,2.784,4037,5.087]],["name/5480",[4038,84.686]],["parent/5480",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5481",[189,39.191]],["parent/5481",[1,0.611,2,0.611,3012,0.86,3447,2.784,4039,5.087]],["name/5482",[191,49.763]],["parent/5482",[1,0.611,2,0.611,3012,0.86,3447,2.784,4039,5.087]],["name/5483",[46,42.129]],["parent/5483",[1,0.611,2,0.611,3012,0.86,3447,2.784,4039,5.087]],["name/5484",[123,37.886]],["parent/5484",[1,0.611,2,0.611,3012,0.86,3447,2.784,4039,5.087]],["name/5485",[192,48.337]],["parent/5485",[1,0.611,2,0.611,3012,0.86,3447,2.784,4039,5.087]],["name/5486",[4040,84.686]],["parent/5486",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5487",[189,39.191]],["parent/5487",[1,0.611,2,0.611,3012,0.86,3447,2.784,4041,5.087]],["name/5488",[191,49.763]],["parent/5488",[1,0.611,2,0.611,3012,0.86,3447,2.784,4041,5.087]],["name/5489",[46,42.129]],["parent/5489",[1,0.611,2,0.611,3012,0.86,3447,2.784,4041,5.087]],["name/5490",[123,37.886]],["parent/5490",[1,0.611,2,0.611,3012,0.86,3447,2.784,4041,5.087]],["name/5491",[192,48.337]],["parent/5491",[1,0.611,2,0.611,3012,0.86,3447,2.784,4041,5.087]],["name/5492",[4042,84.686]],["parent/5492",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5493",[189,39.191]],["parent/5493",[1,0.611,2,0.611,3012,0.86,3447,2.784,4043,5.087]],["name/5494",[191,49.763]],["parent/5494",[1,0.611,2,0.611,3012,0.86,3447,2.784,4043,5.087]],["name/5495",[46,42.129]],["parent/5495",[1,0.611,2,0.611,3012,0.86,3447,2.784,4043,5.087]],["name/5496",[123,37.886]],["parent/5496",[1,0.611,2,0.611,3012,0.86,3447,2.784,4043,5.087]],["name/5497",[192,48.337]],["parent/5497",[1,0.611,2,0.611,3012,0.86,3447,2.784,4043,5.087]],["name/5498",[4044,84.686]],["parent/5498",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5499",[4045,84.686]],["parent/5499",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5500",[425,45.531]],["parent/5500",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5501",[4046,84.686]],["parent/5501",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5502",[163,53.406]],["parent/5502",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5503",[1094,76.069]],["parent/5503",[1,0.611,2,0.611,3012,0.86,3447,2.784,4026,4.209]],["name/5504",[4047,84.686]],["parent/5504",[1,0.611,2,0.611,3,2.113,3012,0.86,3447,2.784]],["name/5505",[4048,84.686]],["parent/5505",[1,0.611,2,0.611,3012,0.86,3447,2.784,4049,5.087]],["name/5506",[279,32.637]],["parent/5506",[1,0.611,2,0.611,3012,0.86,3447,2.784,4050,6.027]],["name/5507",[4051,84.686]],["parent/5507",[1,0.611,2,0.611,3012,0.86,3447,2.784,4049,5.087]],["name/5508",[279,32.637]],["parent/5508",[1,0.611,2,0.611,3012,0.86,3447,2.784,4052,6.027]],["name/5509",[4023,76.069]],["parent/5509",[1,0.611,2,0.611,3012,0.86,3447,2.784,4049,5.087]],["name/5510",[279,32.637]],["parent/5510",[1,0.611,2,0.611,3012,0.86,3447,2.784,4053,6.027]],["name/5511",[4054,84.686]],["parent/5511",[1,0.611,2,0.611,3012,0.86,3447,2.784,4049,5.087]],["name/5512",[279,32.637]],["parent/5512",[1,0.611,2,0.611,3012,0.86,3447,2.784,4055,6.027]],["name/5513",[4056,84.686]],["parent/5513",[1,0.611,2,0.611,3012,0.86,3447,2.784,4049,5.087]],["name/5514",[279,32.637]],["parent/5514",[1,0.611,2,0.611,3012,0.86,3447,2.784,4057,6.027]],["name/5515",[4058,84.686]],["parent/5515",[1,0.611,2,0.611,3,2.113,3012,0.86,3447,2.784]],["name/5516",[4059,79.491]],["parent/5516",[1,0.611,2,0.611,3012,0.86,3447,2.784,4060,4.966]],["name/5517",[4061,84.686]],["parent/5517",[1,0.611,2,0.611,3012,0.86,3447,2.784,4060,4.966]],["name/5518",[4062,84.686]],["parent/5518",[1,0.611,2,0.611,3012,0.86,3447,2.784,4060,4.966]],["name/5519",[4063,84.686]],["parent/5519",[1,0.611,2,0.611,3012,0.86,3447,2.784,4060,4.966]],["name/5520",[4064,84.686]],["parent/5520",[1,0.611,2,0.611,3012,0.86,3447,2.784,4060,4.966]],["name/5521",[4065,84.686]],["parent/5521",[1,0.611,2,0.611,3012,0.86,3447,2.784,4060,4.966]],["name/5522",[4059,79.491]],["parent/5522",[1,0.611,2,0.611,3,2.113,3012,0.86,3447,2.784]],["name/5523",[4066,84.686]],["parent/5523",[1,0.611,2,0.611,3,2.113,3012,0.86,3447,2.784]],["name/5524",[1168,71.473]],["parent/5524",[1,0.611,2,0.611,3012,0.86,3447,2.784,4067,4.553]],["name/5525",[4068,84.686]],["parent/5525",[1,0.611,2,0.611,3012,0.86,3447,2.784,4067,4.553]],["name/5526",[1691,76.069]],["parent/5526",[1,0.611,2,0.611,3012,0.86,3447,2.784,4067,4.553]],["name/5527",[4069,79.491]],["parent/5527",[1,0.611,2,0.611,3012,0.86,3447,2.784,4067,4.553]],["name/5528",[1011,53.098]],["parent/5528",[1,0.611,2,0.611,3012,0.86,3447,2.784,4067,4.553]],["name/5529",[856,76.069]],["parent/5529",[1,0.611,2,0.611,3012,0.86,3447,2.784,4067,4.553]],["name/5530",[415,40.51]],["parent/5530",[1,0.611,2,0.611,3012,0.86,3447,2.784,4067,4.553]],["name/5531",[440,68.319]],["parent/5531",[1,0.611,2,0.611,3012,0.86,3447,2.784,4067,4.553]],["name/5532",[122,56.704]],["parent/5532",[1,0.611,2,0.611,3012,0.86,3447,2.784,4067,4.553]],["name/5533",[574,68.319]],["parent/5533",[1,0.611,2,0.611,3012,0.86,3447,2.784,4067,4.553]],["name/5534",[4070,79.491]],["parent/5534",[1,0.611,2,0.611,3012,0.86,3447,2.784,4067,4.553]],["name/5535",[4071,84.686]],["parent/5535",[1,0.611,2,0.611,3,2.113,3012,0.86,3447,2.784]],["name/5536",[123,37.886]],["parent/5536",[1,0.611,2,0.611,3012,0.86,3447,2.784,4072,5.414]],["name/5537",[251,62.341]],["parent/5537",[1,0.611,2,0.611,3012,0.86,3447,2.784,4072,5.414]],["name/5538",[123,37.886]],["parent/5538",[1,0.611,2,0.611,3012,0.86,3447,2.784,4073,5.087]],["name/5539",[44,64.897]],["parent/5539",[1,0.611,2,0.611,3012,0.86,3447,2.784,4073,5.087]],["name/5540",[46,42.129]],["parent/5540",[1,0.611,2,0.611,3012,0.86,3447,2.784,4073,5.087]],["name/5541",[253,62.341]],["parent/5541",[1,0.611,2,0.611,3012,0.86,3447,2.784,4073,5.087]],["name/5542",[254,73.514]],["parent/5542",[1,0.611,2,0.611,3012,0.86,3447,2.784,4074,4.862]],["name/5543",[123,37.886]],["parent/5543",[1,0.611,2,0.611,3012,0.86,3447,2.784,4075,5.657]],["name/5544",[257,52.508]],["parent/5544",[1,0.611,2,0.611,3012,0.86,3447,2.784,4075,5.657]],["name/5545",[259,63.971]],["parent/5545",[1,0.611,2,0.611,3012,0.86,3447,2.784,4074,4.862]],["name/5546",[123,37.886]],["parent/5546",[1,0.611,2,0.611,3012,0.86,3447,2.784,4076,5.414]],["name/5547",[257,52.508]],["parent/5547",[1,0.611,2,0.611,3012,0.86,3447,2.784,4076,5.414]],["name/5548",[258,63.971]],["parent/5548",[1,0.611,2,0.611,3012,0.86,3447,2.784,4076,5.414]],["name/5549",[261,58.092]],["parent/5549",[1,0.611,2,0.611,3012,0.86,3447,2.784,4074,4.862]],["name/5550",[123,37.886]],["parent/5550",[1,0.611,2,0.611,3012,0.86,3447,2.784,4077,5.414]],["name/5551",[63,61.614]],["parent/5551",[1,0.611,2,0.611,3012,0.86,3447,2.784,4077,5.414]],["name/5552",[257,52.508]],["parent/5552",[1,0.611,2,0.611,3012,0.86,3447,2.784,4077,5.414]],["name/5553",[263,69.774]],["parent/5553",[1,0.611,2,0.611,3012,0.86,3447,2.784,4074,4.862]],["name/5554",[123,37.886]],["parent/5554",[1,0.611,2,0.611,3012,0.86,3447,2.784,4078,5.414]],["name/5555",[63,61.614]],["parent/5555",[1,0.611,2,0.611,3012,0.86,3447,2.784,4078,5.414]],["name/5556",[257,52.508]],["parent/5556",[1,0.611,2,0.611,3012,0.86,3447,2.784,4078,5.414]],["name/5557",[4021,79.491]],["parent/5557",[1,0.611,2,0.611,3012,0.86,3447,2.784,4074,4.862]],["name/5558",[123,37.886]],["parent/5558",[1,0.611,2,0.611,3012,0.86,3447,2.784,4079,5.657]],["name/5559",[257,52.508]],["parent/5559",[1,0.611,2,0.611,3012,0.86,3447,2.784,4079,5.657]],["name/5560",[4022,79.491]],["parent/5560",[1,0.611,2,0.611,3012,0.86,3447,2.784,4074,4.862]],["name/5561",[123,37.886]],["parent/5561",[1,0.611,2,0.611,3012,0.86,3447,2.784,4080,5.414]],["name/5562",[63,61.614]],["parent/5562",[1,0.611,2,0.611,3012,0.86,3447,2.784,4080,5.414]],["name/5563",[257,52.508]],["parent/5563",[1,0.611,2,0.611,3012,0.86,3447,2.784,4080,5.414]],["name/5564",[4023,76.069]],["parent/5564",[1,0.611,2,0.611,3012,0.86,3447,2.784,4074,4.862]],["name/5565",[123,37.886]],["parent/5565",[1,0.611,2,0.611,3012,0.86,3447,2.784,4081,5.657]],["name/5566",[257,52.508]],["parent/5566",[1,0.611,2,0.611,3012,0.86,3447,2.784,4081,5.657]],["name/5567",[275,58.601]],["parent/5567",[1,0.611,2,0.611,3012,0.86,3447,2.784,4073,5.087]],["name/5568",[276,71.473]],["parent/5568",[1,0.611,2,0.611,3012,0.86,3447,2.784,4072,5.414]],["name/5569",[1,3.307,2,3.307,3,11.438,3012,4.654,4082,10.351]],["parent/5569",[]],["name/5570",[4083,84.686]],["parent/5570",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5571",[1032,63.123]],["parent/5571",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5572",[4085,84.686]],["parent/5572",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5573",[4086,84.686]],["parent/5573",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5574",[4087,84.686]],["parent/5574",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5575",[4088,84.686]],["parent/5575",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5576",[4089,84.686]],["parent/5576",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5577",[4090,84.686]],["parent/5577",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5578",[4091,84.686]],["parent/5578",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5579",[403,65.914]],["parent/5579",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5580",[2894,63.123]],["parent/5580",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5581",[2839,60.3]],["parent/5581",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5582",[2896,64.897]],["parent/5582",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5583",[4092,73.514]],["parent/5583",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5584",[2986,67.046]],["parent/5584",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5585",[4093,71.473]],["parent/5585",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5586",[4094,84.686]],["parent/5586",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5587",[2818,76.069]],["parent/5587",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5588",[4095,84.686]],["parent/5588",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5589",[4096,69.774]],["parent/5589",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5590",[2886,59.136]],["parent/5590",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5591",[4097,84.686]],["parent/5591",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5592",[4098,84.686]],["parent/5592",[1,0.611,2,0.611,3012,0.86,4082,1.913,4084,4.067]],["name/5593",[4099,84.686]],["parent/5593",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5594",[279,32.637]],["parent/5594",[1,0.611,2,0.611,3012,0.86,4082,1.913,4100,6.027]],["name/5595",[4101,84.686]],["parent/5595",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5596",[279,32.637]],["parent/5596",[1,0.611,2,0.611,3012,0.86,4082,1.913,4102,6.027]],["name/5597",[4103,84.686]],["parent/5597",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5598",[279,32.637]],["parent/5598",[1,0.611,2,0.611,3012,0.86,4082,1.913,4104,6.027]],["name/5599",[4105,84.686]],["parent/5599",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5600",[279,32.637]],["parent/5600",[1,0.611,2,0.611,3012,0.86,4082,1.913,4106,6.027]],["name/5601",[4107,84.686]],["parent/5601",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5602",[279,32.637]],["parent/5602",[1,0.611,2,0.611,3012,0.86,4082,1.913,4108,6.027]],["name/5603",[4109,84.686]],["parent/5603",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5604",[279,32.637]],["parent/5604",[1,0.611,2,0.611,3012,0.86,4082,1.913,4110,6.027]],["name/5605",[4111,84.686]],["parent/5605",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5606",[279,32.637]],["parent/5606",[1,0.611,2,0.611,3012,0.86,4082,1.913,4112,6.027]],["name/5607",[4113,84.686]],["parent/5607",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5608",[279,32.637]],["parent/5608",[1,0.611,2,0.611,3012,0.86,4082,1.913,4114,6.027]],["name/5609",[4115,84.686]],["parent/5609",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5610",[279,32.637]],["parent/5610",[1,0.611,2,0.611,3012,0.86,4082,1.913,4116,6.027]],["name/5611",[4117,84.686]],["parent/5611",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5612",[279,32.637]],["parent/5612",[1,0.611,2,0.611,3012,0.86,4082,1.913,4118,6.027]],["name/5613",[4119,84.686]],["parent/5613",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5614",[2830,71.473]],["parent/5614",[1,0.611,2,0.611,3012,0.86,4082,1.913,4120,5.087]],["name/5615",[2832,76.069]],["parent/5615",[1,0.611,2,0.611,3012,0.86,4082,1.913,4120,5.087]],["name/5616",[2833,76.069]],["parent/5616",[1,0.611,2,0.611,3012,0.86,4082,1.913,4120,5.087]],["name/5617",[4121,84.686]],["parent/5617",[1,0.611,2,0.611,3012,0.86,4082,1.913,4120,5.087]],["name/5618",[4122,84.686]],["parent/5618",[1,0.611,2,0.611,3012,0.86,4082,1.913,4120,5.087]],["name/5619",[4123,84.686]],["parent/5619",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5620",[2986,67.046]],["parent/5620",[1,0.611,2,0.611,3012,0.86,4082,1.913,4124,6.027]],["name/5621",[4125,84.686]],["parent/5621",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5622",[4126,84.686]],["parent/5622",[1,0.611,2,0.611,3012,0.86,4082,1.913,4127,6.027]],["name/5623",[4128,79.491]],["parent/5623",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5624",[4128,79.491]],["parent/5624",[1,0.611,2,0.611,3012,0.86,4082,1.913,4129,6.027]],["name/5625",[4130,79.491]],["parent/5625",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5626",[4130,79.491]],["parent/5626",[1,0.611,2,0.611,3012,0.86,4082,1.913,4131,6.027]],["name/5627",[4132,84.686]],["parent/5627",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5628",[189,39.191]],["parent/5628",[1,0.611,2,0.611,3012,0.86,4082,1.913,4133,5.657]],["name/5629",[298,63.971]],["parent/5629",[1,0.611,2,0.611,3012,0.86,4082,1.913,4133,5.657]],["name/5630",[4134,84.686]],["parent/5630",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5631",[4093,71.473]],["parent/5631",[1,0.611,2,0.611,3012,0.86,4082,1.913,4135,4.691]],["name/5632",[4136,84.686]],["parent/5632",[1,0.611,2,0.611,3012,0.86,4082,1.913,4135,4.691]],["name/5633",[2894,63.123]],["parent/5633",[1,0.611,2,0.611,3012,0.86,4082,1.913,4135,4.691]],["name/5634",[2839,60.3]],["parent/5634",[1,0.611,2,0.611,3012,0.86,4082,1.913,4135,4.691]],["name/5635",[4137,84.686]],["parent/5635",[1,0.611,2,0.611,3012,0.86,4082,1.913,4135,4.691]],["name/5636",[2886,59.136]],["parent/5636",[1,0.611,2,0.611,3012,0.86,4082,1.913,4135,4.691]],["name/5637",[4138,84.686]],["parent/5637",[1,0.611,2,0.611,3012,0.86,4082,1.913,4135,4.691]],["name/5638",[4139,84.686]],["parent/5638",[1,0.611,2,0.611,3012,0.86,4082,1.913,4135,4.691]],["name/5639",[4140,79.491]],["parent/5639",[1,0.611,2,0.611,3012,0.86,4082,1.913,4135,4.691]],["name/5640",[4141,84.686]],["parent/5640",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5641",[4142,84.686]],["parent/5641",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5642",[2986,67.046]],["parent/5642",[1,0.611,2,0.611,3012,0.86,4082,1.913,4143,5.087]],["name/5643",[2988,68.319]],["parent/5643",[1,0.611,2,0.611,3012,0.86,4082,1.913,4143,5.087]],["name/5644",[2989,68.319]],["parent/5644",[1,0.611,2,0.611,3012,0.86,4082,1.913,4143,5.087]],["name/5645",[2990,68.319]],["parent/5645",[1,0.611,2,0.611,3012,0.86,4082,1.913,4143,5.087]],["name/5646",[2896,64.897]],["parent/5646",[1,0.611,2,0.611,3012,0.86,4082,1.913,4143,5.087]],["name/5647",[4144,84.686]],["parent/5647",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5648",[2986,67.046]],["parent/5648",[1,0.611,2,0.611,3012,0.86,4082,1.913,4145,4.862]],["name/5649",[2988,68.319]],["parent/5649",[1,0.611,2,0.611,3012,0.86,4082,1.913,4145,4.862]],["name/5650",[2989,68.319]],["parent/5650",[1,0.611,2,0.611,3012,0.86,4082,1.913,4145,4.862]],["name/5651",[2990,68.319]],["parent/5651",[1,0.611,2,0.611,3012,0.86,4082,1.913,4145,4.862]],["name/5652",[2896,64.897]],["parent/5652",[1,0.611,2,0.611,3012,0.86,4082,1.913,4145,4.862]],["name/5653",[4146,84.686]],["parent/5653",[1,0.611,2,0.611,3012,0.86,4082,1.913,4145,4.862]],["name/5654",[4147,84.686]],["parent/5654",[1,0.611,2,0.611,3012,0.86,4082,1.913,4145,4.862]],["name/5655",[4148,79.491]],["parent/5655",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5656",[3008,79.491]],["parent/5656",[1,0.611,2,0.611,3012,0.86,4082,1.913,4149,4.966]],["name/5657",[4148,79.491]],["parent/5657",[1,0.611,2,0.611,3012,0.86,4082,1.913,4149,4.966]],["name/5658",[4150,84.686]],["parent/5658",[1,0.611,2,0.611,3012,0.86,4082,1.913,4149,4.966]],["name/5659",[4151,84.686]],["parent/5659",[1,0.611,2,0.611,3012,0.86,4082,1.913,4149,4.966]],["name/5660",[4152,84.686]],["parent/5660",[1,0.611,2,0.611,3012,0.86,4082,1.913,4149,4.966]],["name/5661",[4153,84.686]],["parent/5661",[1,0.611,2,0.611,3012,0.86,4082,1.913,4149,4.966]],["name/5662",[4154,84.686]],["parent/5662",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5663",[189,39.191]],["parent/5663",[1,0.611,2,0.611,3012,0.86,4082,1.913,4155,5.414]],["name/5664",[4156,71.473]],["parent/5664",[1,0.611,2,0.611,3012,0.86,4082,1.913,4155,5.414]],["name/5665",[275,58.601]],["parent/5665",[1,0.611,2,0.611,3012,0.86,4082,1.913,4155,5.414]],["name/5666",[4157,84.686]],["parent/5666",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5667",[4158,84.686]],["parent/5667",[1,0.611,2,0.611,3012,0.86,4082,1.913,4159,5.657]],["name/5668",[4160,84.686]],["parent/5668",[1,0.611,2,0.611,3012,0.86,4082,1.913,4159,5.657]],["name/5669",[4161,84.686]],["parent/5669",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5670",[4162,84.686]],["parent/5670",[1,0.611,2,0.611,3012,0.86,4082,1.913,4163,5.657]],["name/5671",[4164,84.686]],["parent/5671",[1,0.611,2,0.611,3012,0.86,4082,1.913,4163,5.657]],["name/5672",[4165,84.686]],["parent/5672",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5673",[189,39.191]],["parent/5673",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5674",[44,64.897]],["parent/5674",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5675",[46,42.129]],["parent/5675",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5676",[4167,76.069]],["parent/5676",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5677",[296,69.774]],["parent/5677",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5678",[4096,69.774]],["parent/5678",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5679",[4168,76.069]],["parent/5679",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5680",[4169,76.069]],["parent/5680",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5681",[4170,76.069]],["parent/5681",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5682",[4171,76.069]],["parent/5682",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5683",[4172,76.069]],["parent/5683",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5684",[4173,84.686]],["parent/5684",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5685",[4174,84.686]],["parent/5685",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5686",[4175,84.686]],["parent/5686",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5687",[4176,76.069]],["parent/5687",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5688",[4177,84.686]],["parent/5688",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5689",[4178,76.069]],["parent/5689",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5690",[4179,76.069]],["parent/5690",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5691",[4180,76.069]],["parent/5691",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5692",[1027,68.319]],["parent/5692",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5693",[4181,76.069]],["parent/5693",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5694",[2871,73.514]],["parent/5694",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5695",[4182,76.069]],["parent/5695",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5696",[4183,76.069]],["parent/5696",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5697",[4184,76.069]],["parent/5697",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5698",[4185,76.069]],["parent/5698",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5699",[964,69.774]],["parent/5699",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5700",[4186,76.069]],["parent/5700",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5701",[4187,76.069]],["parent/5701",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5702",[259,63.971]],["parent/5702",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5703",[4188,76.069]],["parent/5703",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5704",[3745,73.514]],["parent/5704",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5705",[4189,84.686]],["parent/5705",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5706",[4190,76.069]],["parent/5706",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5707",[4191,76.069]],["parent/5707",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5708",[3854,71.473]],["parent/5708",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5709",[4192,76.069]],["parent/5709",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5710",[4193,76.069]],["parent/5710",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5711",[4194,76.069]],["parent/5711",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5712",[4195,76.069]],["parent/5712",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5713",[4196,76.069]],["parent/5713",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5714",[4197,76.069]],["parent/5714",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5715",[4198,76.069]],["parent/5715",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5716",[4199,76.069]],["parent/5716",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5717",[4200,76.069]],["parent/5717",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5718",[4201,76.069]],["parent/5718",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5719",[4202,76.069]],["parent/5719",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5720",[4203,76.069]],["parent/5720",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5721",[4204,76.069]],["parent/5721",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5722",[4205,76.069]],["parent/5722",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5723",[3374,69.774]],["parent/5723",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5724",[4206,76.069]],["parent/5724",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5725",[4207,76.069]],["parent/5725",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5726",[2882,52.545,4208,60.531]],["parent/5726",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5727",[4209,76.069]],["parent/5727",[1,0.611,2,0.611,3012,0.86,4082,1.913,4166,3.414]],["name/5728",[4210,84.686]],["parent/5728",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5729",[189,39.191]],["parent/5729",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5730",[4156,71.473]],["parent/5730",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5731",[2952,79.491]],["parent/5731",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5732",[403,65.914]],["parent/5732",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5733",[2955,79.491]],["parent/5733",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5734",[4212,84.686]],["parent/5734",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5735",[1016,73.514]],["parent/5735",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5736",[46,42.129]],["parent/5736",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5737",[4213,84.686]],["parent/5737",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5738",[3409,73.514]],["parent/5738",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5739",[4214,84.686]],["parent/5739",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5740",[4215,84.686]],["parent/5740",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5741",[4216,84.686]],["parent/5741",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5742",[4217,84.686]],["parent/5742",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5743",[4218,84.686]],["parent/5743",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5744",[4219,84.686]],["parent/5744",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5745",[123,37.886]],["parent/5745",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5746",[4220,84.686]],["parent/5746",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5747",[2862,76.069]],["parent/5747",[1,0.611,2,0.611,3012,0.86,4082,1.913,4211,4.171]],["name/5748",[4221,84.686]],["parent/5748",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5749",[4222,84.686]],["parent/5749",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5750",[2988,68.319]],["parent/5750",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5751",[2989,68.319]],["parent/5751",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5752",[2990,68.319]],["parent/5752",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5753",[4224,79.491]],["parent/5753",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5754",[2896,64.897]],["parent/5754",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5755",[4225,79.491]],["parent/5755",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5756",[4226,79.491]],["parent/5756",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5757",[4156,71.473]],["parent/5757",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5758",[403,65.914]],["parent/5758",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5759",[4227,79.491]],["parent/5759",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5760",[4228,79.491]],["parent/5760",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5761",[4229,79.491]],["parent/5761",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5762",[4096,69.774]],["parent/5762",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5763",[2886,59.136]],["parent/5763",[1,0.611,2,0.611,3012,0.86,4082,1.913,4223,4.337]],["name/5764",[4230,84.686]],["parent/5764",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5765",[4231,84.686]],["parent/5765",[1,0.611,2,0.611,3012,0.86,4082,1.913,4232,6.027]],["name/5766",[4233,79.491]],["parent/5766",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5767",[4233,79.491]],["parent/5767",[1,0.611,2,0.611,3012,0.86,4082,1.913,4234,6.027]],["name/5768",[4235,84.686]],["parent/5768",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5769",[2839,60.3]],["parent/5769",[1,0.611,2,0.611,3012,0.86,4082,1.913,4236,4.553]],["name/5770",[2986,67.046]],["parent/5770",[1,0.611,2,0.611,3012,0.86,4082,1.913,4236,4.553]],["name/5771",[4093,71.473]],["parent/5771",[1,0.611,2,0.611,3012,0.86,4082,1.913,4236,4.553]],["name/5772",[2990,68.319]],["parent/5772",[1,0.611,2,0.611,3012,0.86,4082,1.913,4236,4.553]],["name/5773",[2988,68.319]],["parent/5773",[1,0.611,2,0.611,3012,0.86,4082,1.913,4236,4.553]],["name/5774",[2989,68.319]],["parent/5774",[1,0.611,2,0.611,3012,0.86,4082,1.913,4236,4.553]],["name/5775",[2896,64.897]],["parent/5775",[1,0.611,2,0.611,3012,0.86,4082,1.913,4236,4.553]],["name/5776",[2894,63.123]],["parent/5776",[1,0.611,2,0.611,3012,0.86,4082,1.913,4236,4.553]],["name/5777",[403,65.914]],["parent/5777",[1,0.611,2,0.611,3012,0.86,4082,1.913,4236,4.553]],["name/5778",[4092,73.514]],["parent/5778",[1,0.611,2,0.611,3012,0.86,4082,1.913,4236,4.553]],["name/5779",[4237,84.686]],["parent/5779",[1,0.611,2,0.611,3012,0.86,4082,1.913,4236,4.553]],["name/5780",[4238,84.686]],["parent/5780",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5781",[4239,84.686]],["parent/5781",[1,0.611,2,0.611,3012,0.86,4082,1.913,4240,6.027]],["name/5782",[4241,79.491]],["parent/5782",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5783",[4241,79.491]],["parent/5783",[1,0.611,2,0.611,3012,0.86,4082,1.913,4242,6.027]],["name/5784",[4243,84.686]],["parent/5784",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5785",[4082,26.873]],["parent/5785",[1,0.611,2,0.611,3012,0.86,4082,1.913,4244,6.027]],["name/5786",[4245,84.686]],["parent/5786",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5787",[4246,84.686]],["parent/5787",[1,0.611,2,0.611,3012,0.86,4082,1.913,4247,4.862]],["name/5788",[4093,71.473]],["parent/5788",[1,0.611,2,0.611,3012,0.86,4082,1.913,4247,4.862]],["name/5789",[403,65.914]],["parent/5789",[1,0.611,2,0.611,3012,0.86,4082,1.913,4247,4.862]],["name/5790",[2894,63.123]],["parent/5790",[1,0.611,2,0.611,3012,0.86,4082,1.913,4247,4.862]],["name/5791",[2839,60.3]],["parent/5791",[1,0.611,2,0.611,3012,0.86,4082,1.913,4247,4.862]],["name/5792",[2896,64.897]],["parent/5792",[1,0.611,2,0.611,3012,0.86,4082,1.913,4247,4.862]],["name/5793",[4092,73.514]],["parent/5793",[1,0.611,2,0.611,3012,0.86,4082,1.913,4247,4.862]],["name/5794",[4248,84.686]],["parent/5794",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5795",[4249,84.686]],["parent/5795",[1,0.611,2,0.611,3012,0.86,4082,1.913,4250,5.414]],["name/5796",[4251,84.686]],["parent/5796",[1,0.611,2,0.611,3012,0.86,4082,1.913,4250,5.414]],["name/5797",[4252,84.686]],["parent/5797",[1,0.611,2,0.611,3012,0.86,4082,1.913,4250,5.414]],["name/5798",[4253,84.686]],["parent/5798",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5799",[4254,84.686]],["parent/5799",[1,0.611,2,0.611,3012,0.86,4082,1.913,4255,4.772]],["name/5800",[4256,84.686]],["parent/5800",[1,0.611,2,0.611,3012,0.86,4082,1.913,4255,4.772]],["name/5801",[4257,84.686]],["parent/5801",[1,0.611,2,0.611,3012,0.86,4082,1.913,4255,4.772]],["name/5802",[4258,84.686]],["parent/5802",[1,0.611,2,0.611,3012,0.86,4082,1.913,4255,4.772]],["name/5803",[4259,84.686]],["parent/5803",[1,0.611,2,0.611,3012,0.86,4082,1.913,4255,4.772]],["name/5804",[4260,84.686]],["parent/5804",[1,0.611,2,0.611,3012,0.86,4082,1.913,4255,4.772]],["name/5805",[3824,76.069]],["parent/5805",[1,0.611,2,0.611,3012,0.86,4082,1.913,4255,4.772]],["name/5806",[3903,79.491]],["parent/5806",[1,0.611,2,0.611,3012,0.86,4082,1.913,4255,4.772]],["name/5807",[4261,84.686]],["parent/5807",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5808",[3644,73.514]],["parent/5808",[1,0.611,2,0.611,3012,0.86,4082,1.913,4262,4.772]],["name/5809",[3642,61.614]],["parent/5809",[1,0.611,2,0.611,3012,0.86,4082,1.913,4262,4.772]],["name/5810",[37,64.897]],["parent/5810",[1,0.611,2,0.611,3012,0.86,4082,1.913,4262,4.772]],["name/5811",[2839,60.3]],["parent/5811",[1,0.611,2,0.611,3012,0.86,4082,1.913,4262,4.772]],["name/5812",[3643,76.069]],["parent/5812",[1,0.611,2,0.611,3012,0.86,4082,1.913,4262,4.772]],["name/5813",[4263,79.491]],["parent/5813",[1,0.611,2,0.611,3012,0.86,4082,1.913,4262,4.772]],["name/5814",[123,37.886]],["parent/5814",[1,0.611,2,0.611,3012,0.86,4082,1.913,4262,4.772]],["name/5815",[3640,60.936]],["parent/5815",[1,0.611,2,0.611,3012,0.86,4082,1.913,4262,4.772]],["name/5816",[4264,84.686]],["parent/5816",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5817",[1835,58.601]],["parent/5817",[1,0.611,2,0.611,3012,0.86,4082,1.913,4265,4.862]],["name/5818",[3680,73.514]],["parent/5818",[1,0.611,2,0.611,3012,0.86,4082,1.913,4265,4.862]],["name/5819",[3678,56.818,3679,51.087]],["parent/5819",[1,0.611,2,0.611,3012,0.86,4082,1.913,4265,4.862]],["name/5820",[3331,47.922,3679,51.087]],["parent/5820",[1,0.611,2,0.611,3012,0.86,4082,1.913,4265,4.862]],["name/5821",[4263,79.491]],["parent/5821",[1,0.611,2,0.611,3012,0.86,4082,1.913,4265,4.862]],["name/5822",[3682,71.473]],["parent/5822",[1,0.611,2,0.611,3012,0.86,4082,1.913,4265,4.862]],["name/5823",[3683,79.491]],["parent/5823",[1,0.611,2,0.611,3012,0.86,4082,1.913,4265,4.862]],["name/5824",[4266,84.686]],["parent/5824",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5825",[4267,84.686]],["parent/5825",[1,0.611,2,0.611,3012,0.86,4082,1.913,4268,5.657]],["name/5826",[4269,84.686]],["parent/5826",[1,0.611,2,0.611,3012,0.86,4082,1.913,4268,5.657]],["name/5827",[4270,84.686]],["parent/5827",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5828",[189,39.191]],["parent/5828",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5829",[4176,76.069]],["parent/5829",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5830",[4272,79.491]],["parent/5830",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5831",[4178,76.069]],["parent/5831",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5832",[4273,79.491]],["parent/5832",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5833",[4274,79.491]],["parent/5833",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5834",[4275,79.491]],["parent/5834",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5835",[4169,76.069]],["parent/5835",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5836",[4172,76.069]],["parent/5836",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5837",[4170,76.069]],["parent/5837",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5838",[4168,76.069]],["parent/5838",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5839",[4171,76.069]],["parent/5839",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5840",[46,42.129]],["parent/5840",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5841",[4179,76.069]],["parent/5841",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5842",[4180,76.069]],["parent/5842",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5843",[4276,79.491]],["parent/5843",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5844",[1027,68.319]],["parent/5844",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5845",[4181,76.069]],["parent/5845",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5846",[2871,73.514]],["parent/5846",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5847",[4182,76.069]],["parent/5847",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5848",[4183,76.069]],["parent/5848",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5849",[4184,76.069]],["parent/5849",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5850",[4277,79.491]],["parent/5850",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5851",[4185,76.069]],["parent/5851",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5852",[296,69.774]],["parent/5852",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5853",[964,69.774]],["parent/5853",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5854",[4186,76.069]],["parent/5854",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5855",[4187,76.069]],["parent/5855",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5856",[2839,60.3]],["parent/5856",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5857",[259,63.971]],["parent/5857",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5858",[4188,76.069]],["parent/5858",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5859",[4167,76.069]],["parent/5859",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5860",[3745,73.514]],["parent/5860",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5861",[4190,76.069]],["parent/5861",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5862",[4191,76.069]],["parent/5862",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5863",[3854,71.473]],["parent/5863",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5864",[4192,76.069]],["parent/5864",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5865",[4193,76.069]],["parent/5865",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5866",[4278,79.491]],["parent/5866",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5867",[2914,76.069]],["parent/5867",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5868",[4279,79.491]],["parent/5868",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5869",[4194,76.069]],["parent/5869",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5870",[4195,76.069]],["parent/5870",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5871",[4196,76.069]],["parent/5871",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5872",[4197,76.069]],["parent/5872",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5873",[4198,76.069]],["parent/5873",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5874",[4199,76.069]],["parent/5874",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5875",[4200,76.069]],["parent/5875",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5876",[4201,76.069]],["parent/5876",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5877",[2840,69.774]],["parent/5877",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5878",[4280,79.491]],["parent/5878",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5879",[4096,69.774]],["parent/5879",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5880",[4202,76.069]],["parent/5880",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5881",[4203,76.069]],["parent/5881",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5882",[4204,76.069]],["parent/5882",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5883",[4205,76.069]],["parent/5883",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5884",[3374,69.774]],["parent/5884",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5885",[44,64.897]],["parent/5885",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5886",[4206,76.069]],["parent/5886",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5887",[4207,76.069]],["parent/5887",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5888",[4281,79.491]],["parent/5888",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5889",[2882,52.545,4282,56.818]],["parent/5889",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5890",[4209,76.069]],["parent/5890",[1,0.611,2,0.611,3012,0.86,4082,1.913,4271,3.316]],["name/5891",[4283,84.686]],["parent/5891",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5892",[189,39.191]],["parent/5892",[1,0.611,2,0.611,3012,0.86,4082,1.913,4284,5.087]],["name/5893",[4156,71.473]],["parent/5893",[1,0.611,2,0.611,3012,0.86,4082,1.913,4284,5.087]],["name/5894",[123,37.886]],["parent/5894",[1,0.611,2,0.611,3012,0.86,4082,1.913,4284,5.087]],["name/5895",[298,63.971]],["parent/5895",[1,0.611,2,0.611,3012,0.86,4082,1.913,4284,5.087]],["name/5896",[2862,76.069]],["parent/5896",[1,0.611,2,0.611,3012,0.86,4082,1.913,4284,5.087]],["name/5897",[4285,84.686]],["parent/5897",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5898",[4093,71.473]],["parent/5898",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5899",[2986,67.046]],["parent/5899",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5900",[2988,68.319]],["parent/5900",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5901",[2989,68.319]],["parent/5901",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5902",[2990,68.319]],["parent/5902",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5903",[4224,79.491]],["parent/5903",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5904",[2896,64.897]],["parent/5904",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5905",[2839,60.3]],["parent/5905",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5906",[2894,63.123]],["parent/5906",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5907",[403,65.914]],["parent/5907",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5908",[4227,79.491]],["parent/5908",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5909",[4228,79.491]],["parent/5909",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5910",[4229,79.491]],["parent/5910",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5911",[877,73.514]],["parent/5911",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5912",[4225,79.491]],["parent/5912",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5913",[4226,79.491]],["parent/5913",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5914",[4156,71.473]],["parent/5914",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5915",[4092,73.514]],["parent/5915",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5916",[4140,79.491]],["parent/5916",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5917",[4287,84.686]],["parent/5917",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5918",[4288,84.686]],["parent/5918",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5919",[4289,84.686]],["parent/5919",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5920",[4290,84.686]],["parent/5920",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5921",[4291,84.686]],["parent/5921",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5922",[4292,84.686]],["parent/5922",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5923",[4293,84.686]],["parent/5923",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5924",[4294,84.686]],["parent/5924",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5925",[4295,84.686]],["parent/5925",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5926",[4296,84.686]],["parent/5926",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5927",[4297,84.686]],["parent/5927",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5928",[4096,69.774]],["parent/5928",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5929",[2886,59.136]],["parent/5929",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5930",[4298,84.686]],["parent/5930",[1,0.611,2,0.611,3012,0.86,4082,1.913,4286,3.779]],["name/5931",[4299,84.686]],["parent/5931",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5932",[4280,79.491]],["parent/5932",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5933",[189,39.191]],["parent/5933",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5934",[2840,69.774]],["parent/5934",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5935",[4301,84.686]],["parent/5935",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5936",[4176,76.069]],["parent/5936",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5937",[4272,79.491]],["parent/5937",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5938",[4178,76.069]],["parent/5938",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5939",[4273,79.491]],["parent/5939",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5940",[4274,79.491]],["parent/5940",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5941",[4275,79.491]],["parent/5941",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5942",[4169,76.069]],["parent/5942",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5943",[4172,76.069]],["parent/5943",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5944",[4170,76.069]],["parent/5944",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5945",[4168,76.069]],["parent/5945",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5946",[4171,76.069]],["parent/5946",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5947",[46,42.129]],["parent/5947",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5948",[4179,76.069]],["parent/5948",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5949",[4180,76.069]],["parent/5949",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5950",[4276,79.491]],["parent/5950",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5951",[1027,68.319]],["parent/5951",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5952",[4181,76.069]],["parent/5952",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5953",[2871,73.514]],["parent/5953",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5954",[4182,76.069]],["parent/5954",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5955",[4183,76.069]],["parent/5955",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5956",[4184,76.069]],["parent/5956",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5957",[4277,79.491]],["parent/5957",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5958",[4185,76.069]],["parent/5958",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5959",[296,69.774]],["parent/5959",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5960",[964,69.774]],["parent/5960",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5961",[4186,76.069]],["parent/5961",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5962",[4187,76.069]],["parent/5962",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5963",[2839,60.3]],["parent/5963",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5964",[259,63.971]],["parent/5964",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5965",[4188,76.069]],["parent/5965",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5966",[4167,76.069]],["parent/5966",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5967",[3745,73.514]],["parent/5967",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5968",[4190,76.069]],["parent/5968",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5969",[4191,76.069]],["parent/5969",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5970",[3854,71.473]],["parent/5970",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5971",[4192,76.069]],["parent/5971",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5972",[4193,76.069]],["parent/5972",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5973",[4278,79.491]],["parent/5973",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5974",[2914,76.069]],["parent/5974",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5975",[4279,79.491]],["parent/5975",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5976",[4194,76.069]],["parent/5976",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5977",[4195,76.069]],["parent/5977",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5978",[4196,76.069]],["parent/5978",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5979",[4197,76.069]],["parent/5979",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5980",[4198,76.069]],["parent/5980",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5981",[4199,76.069]],["parent/5981",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5982",[4200,76.069]],["parent/5982",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5983",[4201,76.069]],["parent/5983",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5984",[4096,69.774]],["parent/5984",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5985",[4202,76.069]],["parent/5985",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5986",[4203,76.069]],["parent/5986",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5987",[4204,76.069]],["parent/5987",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5988",[4205,76.069]],["parent/5988",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5989",[3374,69.774]],["parent/5989",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5990",[44,64.897]],["parent/5990",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5991",[4206,76.069]],["parent/5991",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5992",[4207,76.069]],["parent/5992",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5993",[4281,79.491]],["parent/5993",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5994",[2882,52.545,4282,56.818]],["parent/5994",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5995",[4209,76.069]],["parent/5995",[1,0.611,2,0.611,3012,0.86,4082,1.913,4300,3.305]],["name/5996",[4302,84.686]],["parent/5996",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/5997",[4303,84.686]],["parent/5997",[1,0.611,2,0.611,3012,0.86,4082,1.913,4304,5.657]],["name/5998",[4305,84.686]],["parent/5998",[1,0.611,2,0.611,3012,0.86,4082,1.913,4304,5.657]],["name/5999",[4306,84.686]],["parent/5999",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/6000",[4307,84.686]],["parent/6000",[1,0.611,2,0.611,3012,0.86,4082,1.913,4308,5.414]],["name/6001",[3682,71.473]],["parent/6001",[1,0.611,2,0.611,3012,0.86,4082,1.913,4308,5.414]],["name/6002",[4309,84.686]],["parent/6002",[1,0.611,2,0.611,3012,0.86,4082,1.913,4308,5.414]],["name/6003",[4310,84.686]],["parent/6003",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/6004",[4311,79.491]],["parent/6004",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/6005",[4311,79.491]],["parent/6005",[1,0.611,2,0.611,3012,0.86,4082,1.913,4312,6.027]],["name/6006",[4313,84.686]],["parent/6006",[1,0.611,2,0.611,3,2.113,3012,0.86,4082,1.913]],["name/6007",[4082,26.873]],["parent/6007",[1,0.611,2,0.611,3012,0.86,4082,1.913,4314,6.027]],["name/6008",[1,3.907,2,3.907,3,13.516,4315,16.049]],["parent/6008",[]],["name/6009",[4316,84.686]],["parent/6009",[1,0.69,2,0.69,3,2.387,4315,2.834]],["name/6010",[1032,63.123]],["parent/6010",[1,0.69,2,0.69,4315,2.834,4317,5.744]],["name/6011",[411,63.971]],["parent/6011",[1,0.69,2,0.69,4315,2.834,4317,5.744]],["name/6012",[4318,84.686]],["parent/6012",[1,0.69,2,0.69,4315,2.834,4317,5.744]],["name/6013",[3001,79.491]],["parent/6013",[1,0.69,2,0.69,4315,2.834,4317,5.744]],["name/6014",[4319,84.686]],["parent/6014",[1,0.69,2,0.69,4315,2.834,4317,5.744]],["name/6015",[4320,84.686]],["parent/6015",[1,0.69,2,0.69,4315,2.834,4321,5.908]],["name/6016",[4322,84.686]],["parent/6016",[1,0.69,2,0.69,4315,2.834,4321,5.908]],["name/6017",[4323,84.686]],["parent/6017",[1,0.69,2,0.69,4315,2.834,4321,5.908]],["name/6018",[4324,84.686]],["parent/6018",[1,0.69,2,0.69,4315,2.834,4321,5.908]],["name/6019",[4325,84.686]],["parent/6019",[1,0.69,2,0.69,3,2.387,4315,2.834]],["name/6020",[3326,56.704]],["parent/6020",[1,0.69,2,0.69,4315,2.834,4326,6.806]],["name/6021",[189,39.191]],["parent/6021",[1,0.69,2,0.69,4315,2.834,4327,5.608]],["name/6022",[191,49.763]],["parent/6022",[1,0.69,2,0.69,4315,2.834,4327,5.608]],["name/6023",[46,42.129]],["parent/6023",[1,0.69,2,0.69,4315,2.834,4327,5.608]],["name/6024",[123,37.886]],["parent/6024",[1,0.69,2,0.69,4315,2.834,4327,5.608]],["name/6025",[201,59.136]],["parent/6025",[1,0.69,2,0.69,4315,2.834,4327,5.608]],["name/6026",[810,79.491]],["parent/6026",[1,0.69,2,0.69,4315,2.834,4327,5.608]],["name/6027",[4328,84.686]],["parent/6027",[1,0.69,2,0.69,3,2.387,4315,2.834]],["name/6028",[4329,84.686]],["parent/6028",[1,0.69,2,0.69,4315,2.834,4330,5.908]],["name/6029",[279,32.637]],["parent/6029",[1,0.69,2,0.69,4315,2.834,4331,6.806]],["name/6030",[4332,84.686]],["parent/6030",[1,0.69,2,0.69,4315,2.834,4330,5.908]],["name/6031",[279,32.637]],["parent/6031",[1,0.69,2,0.69,4315,2.834,4333,6.806]],["name/6032",[4334,84.686]],["parent/6032",[1,0.69,2,0.69,4315,2.834,4330,5.908]],["name/6033",[279,32.637]],["parent/6033",[1,0.69,2,0.69,4315,2.834,4335,6.806]],["name/6034",[4336,84.686]],["parent/6034",[1,0.69,2,0.69,4315,2.834,4330,5.908]],["name/6035",[279,32.637]],["parent/6035",[1,0.69,2,0.69,4315,2.834,4337,6.806]],["name/6036",[4338,84.686]],["parent/6036",[1,0.69,2,0.69,3,2.387,4315,2.834]],["name/6037",[4339,84.686]],["parent/6037",[1,0.69,2,0.69,4315,2.834,4340,6.114]],["name/6038",[4341,84.686]],["parent/6038",[1,0.69,2,0.69,4315,2.834,4340,6.114]],["name/6039",[4342,84.686]],["parent/6039",[1,0.69,2,0.69,4315,2.834,4340,6.114]],["name/6040",[4343,84.686]],["parent/6040",[1,0.69,2,0.69,3,2.387,4315,2.834]],["name/6041",[4344,84.686]],["parent/6041",[1,0.69,2,0.69,4315,2.834,4345,5.388]],["name/6042",[4346,84.686]],["parent/6042",[1,0.69,2,0.69,4315,2.834,4345,5.388]],["name/6043",[2818,76.069]],["parent/6043",[1,0.69,2,0.69,4315,2.834,4345,5.388]],["name/6044",[4347,84.686]],["parent/6044",[1,0.69,2,0.69,4315,2.834,4345,5.388]],["name/6045",[4348,84.686]],["parent/6045",[1,0.69,2,0.69,4315,2.834,4345,5.388]],["name/6046",[4349,84.686]],["parent/6046",[1,0.69,2,0.69,4315,2.834,4345,5.388]],["name/6047",[4350,84.686]],["parent/6047",[1,0.69,2,0.69,4315,2.834,4345,5.388]],["name/6048",[605,76.069]],["parent/6048",[1,0.69,2,0.69,4315,2.834,4345,5.388]],["name/6049",[3770,79.491]],["parent/6049",[1,0.69,2,0.69,3,2.387,4315,2.834]],["name/6050",[4351,84.686]],["parent/6050",[1,0.69,2,0.69,4315,2.834,4352,6.389]],["name/6051",[163,53.406]],["parent/6051",[1,0.69,2,0.69,4315,2.834,4352,6.389]],["name/6052",[4353,84.686]],["parent/6052",[1,0.69,2,0.69,3,2.387,4315,2.834]],["name/6053",[4354,84.686]],["parent/6053",[1,0.69,2,0.69,4315,2.834,4355,5.073]],["name/6054",[4356,84.686]],["parent/6054",[1,0.69,2,0.69,4315,2.834,4355,5.073]],["name/6055",[4357,84.686]],["parent/6055",[1,0.69,2,0.69,4315,2.834,4355,5.073]],["name/6056",[4358,84.686]],["parent/6056",[1,0.69,2,0.69,4315,2.834,4355,5.073]],["name/6057",[4359,84.686]],["parent/6057",[1,0.69,2,0.69,4315,2.834,4355,5.073]],["name/6058",[4360,84.686]],["parent/6058",[1,0.69,2,0.69,4315,2.834,4355,5.073]],["name/6059",[4361,84.686]],["parent/6059",[1,0.69,2,0.69,4315,2.834,4355,5.073]],["name/6060",[4362,84.686]],["parent/6060",[1,0.69,2,0.69,4315,2.834,4355,5.073]],["name/6061",[4363,84.686]],["parent/6061",[1,0.69,2,0.69,4315,2.834,4355,5.073]],["name/6062",[4364,84.686]],["parent/6062",[1,0.69,2,0.69,4315,2.834,4355,5.073]],["name/6063",[104,69.774]],["parent/6063",[1,0.69,2,0.69,4315,2.834,4355,5.073]],["name/6064",[4365,84.686]],["parent/6064",[1,0.69,2,0.69,4315,2.834,4355,5.073]],["name/6065",[4366,84.686]],["parent/6065",[1,0.69,2,0.69,3,2.387,4315,2.834]],["name/6066",[4367,84.686]],["parent/6066",[1,0.69,2,0.69,4315,2.834,4368,6.389]],["name/6067",[139,71.473]],["parent/6067",[1,0.69,2,0.69,4315,2.834,4368,6.389]],["name/6068",[4369,79.491]],["parent/6068",[1,0.69,2,0.69,3,2.387,4315,2.834]],["name/6069",[4369,79.491]],["parent/6069",[1,0.69,2,0.69,4315,2.834,4370,6.806]],["name/6070",[4371,84.686]],["parent/6070",[1,0.69,2,0.69,3,2.387,4315,2.834]],["name/6071",[4372,84.686]],["parent/6071",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6072",[4374,84.686]],["parent/6072",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6073",[189,39.191]],["parent/6073",[1,0.69,2,0.69,4315,2.834,4375,5.608]],["name/6074",[191,49.763]],["parent/6074",[1,0.69,2,0.69,4315,2.834,4375,5.608]],["name/6075",[46,42.129]],["parent/6075",[1,0.69,2,0.69,4315,2.834,4375,5.608]],["name/6076",[123,37.886]],["parent/6076",[1,0.69,2,0.69,4315,2.834,4375,5.608]],["name/6077",[275,58.601]],["parent/6077",[1,0.69,2,0.69,4315,2.834,4375,5.608]],["name/6078",[192,48.337]],["parent/6078",[1,0.69,2,0.69,4315,2.834,4375,5.608]],["name/6079",[4376,84.686]],["parent/6079",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6080",[4377,84.686]],["parent/6080",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6081",[189,39.191]],["parent/6081",[1,0.69,2,0.69,4315,2.834,4378,5.608]],["name/6082",[191,49.763]],["parent/6082",[1,0.69,2,0.69,4315,2.834,4378,5.608]],["name/6083",[46,42.129]],["parent/6083",[1,0.69,2,0.69,4315,2.834,4378,5.608]],["name/6084",[123,37.886]],["parent/6084",[1,0.69,2,0.69,4315,2.834,4378,5.608]],["name/6085",[201,59.136]],["parent/6085",[1,0.69,2,0.69,4315,2.834,4378,5.608]],["name/6086",[192,48.337]],["parent/6086",[1,0.69,2,0.69,4315,2.834,4378,5.608]],["name/6087",[4379,84.686]],["parent/6087",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6088",[189,39.191]],["parent/6088",[1,0.69,2,0.69,4315,2.834,4380,5.608]],["name/6089",[191,49.763]],["parent/6089",[1,0.69,2,0.69,4315,2.834,4380,5.608]],["name/6090",[46,42.129]],["parent/6090",[1,0.69,2,0.69,4315,2.834,4380,5.608]],["name/6091",[123,37.886]],["parent/6091",[1,0.69,2,0.69,4315,2.834,4380,5.608]],["name/6092",[275,58.601]],["parent/6092",[1,0.69,2,0.69,4315,2.834,4380,5.608]],["name/6093",[192,48.337]],["parent/6093",[1,0.69,2,0.69,4315,2.834,4380,5.608]],["name/6094",[4381,84.686]],["parent/6094",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6095",[4382,84.686]],["parent/6095",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6096",[189,39.191]],["parent/6096",[1,0.69,2,0.69,4315,2.834,4383,5.608]],["name/6097",[191,49.763]],["parent/6097",[1,0.69,2,0.69,4315,2.834,4383,5.608]],["name/6098",[46,42.129]],["parent/6098",[1,0.69,2,0.69,4315,2.834,4383,5.608]],["name/6099",[123,37.886]],["parent/6099",[1,0.69,2,0.69,4315,2.834,4383,5.608]],["name/6100",[275,58.601]],["parent/6100",[1,0.69,2,0.69,4315,2.834,4383,5.608]],["name/6101",[192,48.337]],["parent/6101",[1,0.69,2,0.69,4315,2.834,4383,5.608]],["name/6102",[4384,84.686]],["parent/6102",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6103",[4385,84.686]],["parent/6103",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6104",[189,39.191]],["parent/6104",[1,0.69,2,0.69,4315,2.834,4386,5.608]],["name/6105",[191,49.763]],["parent/6105",[1,0.69,2,0.69,4315,2.834,4386,5.608]],["name/6106",[46,42.129]],["parent/6106",[1,0.69,2,0.69,4315,2.834,4386,5.608]],["name/6107",[123,37.886]],["parent/6107",[1,0.69,2,0.69,4315,2.834,4386,5.608]],["name/6108",[201,59.136]],["parent/6108",[1,0.69,2,0.69,4315,2.834,4386,5.608]],["name/6109",[192,48.337]],["parent/6109",[1,0.69,2,0.69,4315,2.834,4386,5.608]],["name/6110",[4387,84.686]],["parent/6110",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6111",[189,39.191]],["parent/6111",[1,0.69,2,0.69,4315,2.834,4388,5.744]],["name/6112",[191,49.763]],["parent/6112",[1,0.69,2,0.69,4315,2.834,4388,5.744]],["name/6113",[46,42.129]],["parent/6113",[1,0.69,2,0.69,4315,2.834,4388,5.744]],["name/6114",[123,37.886]],["parent/6114",[1,0.69,2,0.69,4315,2.834,4388,5.744]],["name/6115",[192,48.337]],["parent/6115",[1,0.69,2,0.69,4315,2.834,4388,5.744]],["name/6116",[4389,84.686]],["parent/6116",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6117",[189,39.191]],["parent/6117",[1,0.69,2,0.69,4315,2.834,4390,5.608]],["name/6118",[46,42.129]],["parent/6118",[1,0.69,2,0.69,4315,2.834,4390,5.608]],["name/6119",[123,37.886]],["parent/6119",[1,0.69,2,0.69,4315,2.834,4390,5.608]],["name/6120",[201,59.136]],["parent/6120",[1,0.69,2,0.69,4315,2.834,4390,5.608]],["name/6121",[192,48.337]],["parent/6121",[1,0.69,2,0.69,4315,2.834,4390,5.608]],["name/6122",[245,73.514]],["parent/6122",[1,0.69,2,0.69,4315,2.834,4390,5.608]],["name/6123",[247,73.514]],["parent/6123",[1,0.69,2,0.69,4315,2.834,4391,6.389]],["name/6124",[798,76.069]],["parent/6124",[1,0.69,2,0.69,4315,2.834,4391,6.389]],["name/6125",[4392,84.686]],["parent/6125",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6126",[189,39.191]],["parent/6126",[1,0.69,2,0.69,4315,2.834,4393,5.908]],["name/6127",[46,42.129]],["parent/6127",[1,0.69,2,0.69,4315,2.834,4393,5.908]],["name/6128",[123,37.886]],["parent/6128",[1,0.69,2,0.69,4315,2.834,4393,5.908]],["name/6129",[192,48.337]],["parent/6129",[1,0.69,2,0.69,4315,2.834,4393,5.908]],["name/6130",[4394,84.686]],["parent/6130",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6131",[189,39.191]],["parent/6131",[1,0.69,2,0.69,4315,2.834,4395,5.908]],["name/6132",[46,42.129]],["parent/6132",[1,0.69,2,0.69,4315,2.834,4395,5.908]],["name/6133",[123,37.886]],["parent/6133",[1,0.69,2,0.69,4315,2.834,4395,5.908]],["name/6134",[192,48.337]],["parent/6134",[1,0.69,2,0.69,4315,2.834,4395,5.908]],["name/6135",[4396,84.686]],["parent/6135",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6136",[1250,73.514]],["parent/6136",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6137",[163,53.406]],["parent/6137",[1,0.69,2,0.69,4315,2.834,4373,4.846]],["name/6138",[4397,84.686]],["parent/6138",[1,0.69,2,0.69,3,2.387,4315,2.834]],["name/6139",[1168,71.473]],["parent/6139",[1,0.69,2,0.69,4315,2.834,4398,5.073]],["name/6140",[4399,84.686]],["parent/6140",[1,0.69,2,0.69,4315,2.834,4398,5.073]],["name/6141",[4400,84.686]],["parent/6141",[1,0.69,2,0.69,4315,2.834,4398,5.073]],["name/6142",[1691,76.069]],["parent/6142",[1,0.69,2,0.69,4315,2.834,4398,5.073]],["name/6143",[4069,79.491]],["parent/6143",[1,0.69,2,0.69,4315,2.834,4398,5.073]],["name/6144",[1011,53.098]],["parent/6144",[1,0.69,2,0.69,4315,2.834,4398,5.073]],["name/6145",[856,76.069]],["parent/6145",[1,0.69,2,0.69,4315,2.834,4398,5.073]],["name/6146",[415,40.51]],["parent/6146",[1,0.69,2,0.69,4315,2.834,4398,5.073]],["name/6147",[440,68.319]],["parent/6147",[1,0.69,2,0.69,4315,2.834,4398,5.073]],["name/6148",[122,56.704]],["parent/6148",[1,0.69,2,0.69,4315,2.834,4398,5.073]],["name/6149",[574,68.319]],["parent/6149",[1,0.69,2,0.69,4315,2.834,4398,5.073]],["name/6150",[4070,79.491]],["parent/6150",[1,0.69,2,0.69,4315,2.834,4398,5.073]],["name/6151",[4401,84.686]],["parent/6151",[1,0.69,2,0.69,3,2.387,4315,2.834]],["name/6152",[123,37.886]],["parent/6152",[1,0.69,2,0.69,4315,2.834,4402,5.908]],["name/6153",[251,62.341]],["parent/6153",[1,0.69,2,0.69,4315,2.834,4402,5.908]],["name/6154",[123,37.886]],["parent/6154",[1,0.69,2,0.69,4315,2.834,4403,5.744]],["name/6155",[44,64.897]],["parent/6155",[1,0.69,2,0.69,4315,2.834,4403,5.744]],["name/6156",[46,42.129]],["parent/6156",[1,0.69,2,0.69,4315,2.834,4403,5.744]],["name/6157",[253,62.341]],["parent/6157",[1,0.69,2,0.69,4315,2.834,4403,5.744]],["name/6158",[254,73.514]],["parent/6158",[1,0.69,2,0.69,4315,2.834,4404,5.141]],["name/6159",[123,37.886]],["parent/6159",[1,0.69,2,0.69,4315,2.834,4405,6.389]],["name/6160",[257,52.508]],["parent/6160",[1,0.69,2,0.69,4315,2.834,4405,6.389]],["name/6161",[259,63.971]],["parent/6161",[1,0.69,2,0.69,4315,2.834,4404,5.141]],["name/6162",[123,37.886]],["parent/6162",[1,0.69,2,0.69,4315,2.834,4406,6.114]],["name/6163",[257,52.508]],["parent/6163",[1,0.69,2,0.69,4315,2.834,4406,6.114]],["name/6164",[258,63.971]],["parent/6164",[1,0.69,2,0.69,4315,2.834,4406,6.114]],["name/6165",[261,58.092]],["parent/6165",[1,0.69,2,0.69,4315,2.834,4404,5.141]],["name/6166",[123,37.886]],["parent/6166",[1,0.69,2,0.69,4315,2.834,4407,6.114]],["name/6167",[63,61.614]],["parent/6167",[1,0.69,2,0.69,4315,2.834,4407,6.114]],["name/6168",[257,52.508]],["parent/6168",[1,0.69,2,0.69,4315,2.834,4407,6.114]],["name/6169",[263,69.774]],["parent/6169",[1,0.69,2,0.69,4315,2.834,4404,5.141]],["name/6170",[123,37.886]],["parent/6170",[1,0.69,2,0.69,4315,2.834,4408,6.114]],["name/6171",[63,61.614]],["parent/6171",[1,0.69,2,0.69,4315,2.834,4408,6.114]],["name/6172",[257,52.508]],["parent/6172",[1,0.69,2,0.69,4315,2.834,4408,6.114]],["name/6173",[265,73.514]],["parent/6173",[1,0.69,2,0.69,4315,2.834,4404,5.141]],["name/6174",[123,37.886]],["parent/6174",[1,0.69,2,0.69,4315,2.834,4409,6.389]],["name/6175",[257,52.508]],["parent/6175",[1,0.69,2,0.69,4315,2.834,4409,6.389]],["name/6176",[271,79.491]],["parent/6176",[1,0.69,2,0.69,4315,2.834,4404,5.141]],["name/6177",[123,37.886]],["parent/6177",[1,0.69,2,0.69,4315,2.834,4410,6.389]],["name/6178",[257,52.508]],["parent/6178",[1,0.69,2,0.69,4315,2.834,4410,6.389]],["name/6179",[273,79.491]],["parent/6179",[1,0.69,2,0.69,4315,2.834,4404,5.141]],["name/6180",[123,37.886]],["parent/6180",[1,0.69,2,0.69,4315,2.834,4411,6.389]],["name/6181",[257,52.508]],["parent/6181",[1,0.69,2,0.69,4315,2.834,4411,6.389]],["name/6182",[27,69.774]],["parent/6182",[1,0.69,2,0.69,4315,2.834,4404,5.141]],["name/6183",[123,37.886]],["parent/6183",[1,0.69,2,0.69,4315,2.834,4412,6.389]],["name/6184",[257,52.508]],["parent/6184",[1,0.69,2,0.69,4315,2.834,4412,6.389]],["name/6185",[1046,76.069]],["parent/6185",[1,0.69,2,0.69,4315,2.834,4404,5.141]],["name/6186",[123,37.886]],["parent/6186",[1,0.69,2,0.69,4315,2.834,4413,6.389]],["name/6187",[257,52.508]],["parent/6187",[1,0.69,2,0.69,4315,2.834,4413,6.389]],["name/6188",[160,69.774]],["parent/6188",[1,0.69,2,0.69,4315,2.834,4404,5.141]],["name/6189",[123,37.886]],["parent/6189",[1,0.69,2,0.69,4315,2.834,4414,6.389]],["name/6190",[257,52.508]],["parent/6190",[1,0.69,2,0.69,4315,2.834,4414,6.389]],["name/6191",[189,39.191]],["parent/6191",[1,0.69,2,0.69,4315,2.834,4415,5.908]],["name/6192",[191,49.763]],["parent/6192",[1,0.69,2,0.69,4315,2.834,4415,5.908]],["name/6193",[46,42.129]],["parent/6193",[1,0.69,2,0.69,4315,2.834,4415,5.908]],["name/6194",[123,37.886]],["parent/6194",[1,0.69,2,0.69,4315,2.834,4415,5.908]],["name/6195",[3326,56.704]],["parent/6195",[1,0.69,2,0.69,4315,2.834,4404,5.141]],["name/6196",[123,37.886]],["parent/6196",[1,0.69,2,0.69,4315,2.834,4416,6.389]],["name/6197",[257,52.508]],["parent/6197",[1,0.69,2,0.69,4315,2.834,4416,6.389]],["name/6198",[275,58.601]],["parent/6198",[1,0.69,2,0.69,4315,2.834,4403,5.744]],["name/6199",[276,71.473]],["parent/6199",[1,0.69,2,0.69,4315,2.834,4402,5.908]],["name/6200",[277,73.514]],["parent/6200",[1,0.69,2,0.69,4315,2.834,4402,5.908]]],"invertedIndex":[["0",{"_index":1000,"name":{"1125":{}},"parent":{}}],["_",{"_index":1002,"name":{"1126":{}},"parent":{}}],["__type",{"_index":18,"name":{"12":{},"29":{},"32":{},"324":{},"326":{},"349":{},"351":{},"565":{},"604":{},"607":{},"612":{},"614":{},"625":{},"627":{},"634":{},"636":{},"748":{},"761":{},"788":{},"818":{},"824":{},"886":{},"1032":{},"1034":{},"1036":{},"1118":{},"1139":{},"1227":{},"1381":{},"1476":{},"1478":{},"1480":{},"1507":{},"1598":{},"1743":{},"2130":{},"2132":{},"2176":{},"2178":{},"2199":{},"2367":{},"2369":{},"2790":{},"2801":{},"2896":{},"2899":{},"2903":{},"2914":{},"3244":{},"3328":{},"3814":{},"4158":{},"4737":{},"4747":{},"4752":{},"4831":{},"5082":{},"5084":{},"5348":{}},"parent":{}}],["_class",{"_index":4263,"name":{"5813":{},"5821":{}},"parent":{}}],["_fetchtokenforsesscfg",{"_index":1281,"name":{"1528":{}},"parent":{}}],["_findactiveprofile",{"_index":1275,"name":{"1522":{}},"parent":{}}],["_findauthhandlerforprofile",{"_index":1277,"name":{"1524":{}},"parent":{}}],["_storesesscfgprops",{"_index":1279,"name":{"1526":{}},"parent":{}}],["_updateschemaactive",{"_index":1291,"name":{"1543":{}},"parent":{}}],["_updateschemaall",{"_index":1293,"name":{"1545":{}},"parent":{}}],["_updateschemaglobal",{"_index":1292,"name":{"1544":{}},"parent":{}}],["abend",{"_index":3735,"name":{"5058":{}},"parent":{}}],["absenceimplicationerror",{"_index":1728,"name":{"2037":{}},"parent":{}}],["absenceimplications",{"_index":809,"name":{"880":{}},"parent":{}}],["abstract",{"_index":2952,"name":{"4016":{},"5731":{}},"parent":{}}],["abstractauthhandler",{"_index":1243,"name":{"1481":{}},"parent":{}}],["abstractcommandbuilder",{"_index":2023,"name":{"2492":{}},"parent":{}}],["abstractcommandyargs",{"_index":1924,"name":{"2334":{}},"parent":{}}],["abstractcredentialmanager",{"_index":649,"name":{"667":{}},"parent":{}}],["abstracthelpgenerator",{"_index":1794,"name":{"2118":{}},"parent":{}}],["abstracthelpgeneratorfactory",{"_index":2540,"name":{"3340":{}},"parent":{}}],["abstractpluginlifecycle",{"_index":2139,"name":{"2754":{}},"parent":{}}],["abstractprofilemanager",{"_index":2419,"name":{"3089":{}},"parent":{}}],["abstractprofilemanagerfactory",{"_index":2521,"name":{"3309":{}},"parent":{}}],["abstractrestclient",{"_index":1145,"name":{"1339":{}},"parent":{}}],["abstractsession",{"_index":1075,"name":{"1230":{}},"parent":{}}],["accept",{"_index":159,"name":{"119":{}},"parent":{}}],["accept_encoding",{"_index":158,"name":{"118":{}},"parent":{}}],["access",{"_index":4298,"name":{"5930":{}},"parent":{}}],["accesst",{"_index":4141,"name":{"5640":{}},"parent":{}}],["accesstype",{"_index":4139,"name":{"5638":{}},"parent":{}}],["account",{"_index":2913,"name":{"3963":{},"4108":{},"5195":{},"5313":{}},"parent":{}}],["accountinfo",{"_index":4288,"name":{"5918":{}},"parent":{}}],["accountnumber",{"_index":3900,"name":{"5241":{}},"parent":{}}],["action",{"_index":2910,"name":{"3953":{},"3954":{},"3955":{},"4055":{},"4056":{},"4058":{},"4059":{}},"parent":{}}],["actionid",{"_index":4291,"name":{"5921":{}},"parent":{}}],["actionperformed",{"_index":1892,"name":{"2269":{}},"parent":{}}],["actions",{"_index":2918,"name":{"3968":{},"3978":{},"3982":{},"3988":{}},"parent":{}}],["actions_resources",{"_index":2813,"name":{"3837":{}},"parent":{}}],["activate",{"_index":633,"name":{"643":{}},"parent":{}}],["active",{"_index":3634,"name":{"4899":{}},"parent":{}}],["actualstatuscode",{"_index":4176,"name":{"5687":{},"5829":{},"5936":{}},"parent":{}}],["addadditionallogger",{"_index":1349,"name":{"1606":{}},"parent":{}}],["addallpluginstohostcli",{"_index":1441,"name":{"1709":{}},"parent":{}}],["addautogeneratedcommands",{"_index":2138,"name":{"2753":{}},"parent":{}}],["addbaseprofile",{"_index":1317,"name":{"1570":{}},"parent":{}}],["addchildanddescendantstosearch",{"_index":1467,"name":{"1733":{}},"parent":{}}],["addcmdgrp",{"_index":1364,"name":{"1620":{}},"parent":{}}],["addcmdgrptoresolvedclicmdtree",{"_index":1445,"name":{"1713":{}},"parent":{}}],["addconsoleappender",{"_index":1334,"name":{"1588":{}},"parent":{}}],["addcontext",{"_index":427,"name":{"421":{}},"parent":{}}],["addfileappender",{"_index":1335,"name":{"1589":{}},"parent":{}}],["addfilecreated",{"_index":939,"name":{"1025":{},"1102":{}},"parent":{}}],["additionaldetails",{"_index":309,"name":{"312":{},"716":{},"1190":{},"1327":{},"2863":{},"3443":{},"3731":{},"3742":{},"3780":{},"3791":{}},"parent":{}}],["additionallogger",{"_index":1348,"name":{"1605":{}},"parent":{}}],["additionallogging",{"_index":2319,"name":{"2973":{}},"parent":{}}],["addmeta",{"_index":853,"name":{"938":{}},"parent":{}}],["addnextoperation",{"_index":974,"name":{"1068":{}},"parent":{}}],["addplugintohostcli",{"_index":1444,"name":{"1712":{}},"parent":{}}],["addprofileinstruction",{"_index":1949,"name":{"2386":{}},"parent":{}}],["addprofiles",{"_index":1366,"name":{"1621":{}},"parent":{}}],["addprofiletoconfig",{"_index":2293,"name":{"2944":{}},"parent":{}}],["addprofiletypetoschema",{"_index":2296,"name":{"2947":{}},"parent":{}}],["addpropsorprompt",{"_index":1221,"name":{"1457":{}},"parent":{}}],["addresult",{"_index":936,"name":{"1022":{},"1099":{}},"parent":{}}],["after",{"_index":2885,"name":{"3913":{},"3947":{}},"parent":{}}],["alcunit",{"_index":3351,"name":{"4484":{},"4505":{},"4531":{},"4539":{},"4546":{},"4555":{},"4563":{},"4573":{}},"parent":{}}],["aliases",{"_index":191,"name":{"142":{},"148":{},"154":{},"160":{},"166":{},"173":{},"179":{},"870":{},"913":{},"1937":{},"1943":{},"1951":{},"2642":{},"2649":{},"2661":{},"2668":{},"2675":{},"2682":{},"2689":{},"2697":{},"3460":{},"3526":{},"3535":{},"3543":{},"3681":{},"5257":{},"5266":{},"5273":{},"5280":{},"5287":{},"5294":{},"5453":{},"5461":{},"5468":{},"5476":{},"5482":{},"5488":{},"5494":{},"6022":{},"6074":{},"6082":{},"6089":{},"6097":{},"6105":{},"6112":{},"6192":{}},"parent":{}}],["aliaslist",{"_index":1845,"name":{"2198":{},"3813":{}},"parent":{}}],["all_token_types",{"_index":1062,"name":{"1207":{}},"parent":{}}],["allauthmethodsfailed",{"_index":4048,"name":{"5505":{}},"parent":{}}],["alldatasets",{"_index":3528,"name":{"4756":{}},"parent":{}}],["alldatasetsarchived",{"_index":3235,"name":{"4349":{}},"parent":{}}],["alleolregex",{"_index":2696,"name":{"3628":{}},"parent":{}}],["allfilescreated",{"_index":923,"name":{"1009":{},"1089":{}},"parent":{}}],["allmembers",{"_index":3438,"name":{"4638":{},"4755":{}},"parent":{}}],["allowablevalues",{"_index":245,"name":{"239":{},"881":{},"1954":{},"6122":{}},"parent":{}}],["allowconfiggroup",{"_index":2323,"name":{"2976":{}},"parent":{}}],["allowplugins",{"_index":2321,"name":{"2975":{}},"parent":{}}],["allplugincfgprops",{"_index":1429,"name":{"1696":{}},"parent":{}}],["allservices",{"_index":670,"name":{"692":{}},"parent":{}}],["altbasepath",{"_index":59,"name":{"45":{}},"parent":{}}],["altprofiles",{"_index":70,"name":{"57":{}},"parent":{}}],["altprofname",{"_index":56,"name":{"43":{}},"parent":{}}],["altproftype",{"_index":58,"name":{"44":{}},"parent":{}}],["ams",{"_index":3400,"name":{"4583":{}},"parent":{}}],["amscommandexecutedsuccessfully",{"_index":3221,"name":{"4335":{}},"parent":{}}],["api",{"_index":777,"name":{"836":{},"2731":{}},"parent":{}}],["api_version",{"_index":4350,"name":{"6047":{}},"parent":{}}],["apierrorheader",{"_index":1479,"name":{"1744":{}},"parent":{}}],["apiid",{"_index":21,"name":{"14":{},"1551":{}},"parent":{}}],["apiinfo",{"_index":40,"name":{"30":{}},"parent":{}}],["apiml",{"_index":38,"name":{"28":{}},"parent":{}}],["apiml_login_description",{"_index":232,"name":{"223":{}},"parent":{}}],["apiml_login_example1",{"_index":233,"name":{"224":{}},"parent":{}}],["apiml_login_example2",{"_index":236,"name":{"227":{}},"parent":{}}],["apiml_login_summary",{"_index":231,"name":{"222":{}},"parent":{}}],["apiml_logout_description",{"_index":239,"name":{"231":{}},"parent":{}}],["apiml_logout_example1",{"_index":240,"name":{"232":{}},"parent":{}}],["apiml_logout_example2",{"_index":242,"name":{"235":{}},"parent":{}}],["apiml_logout_option_token_type",{"_index":244,"name":{"238":{}},"parent":{}}],["apiml_logout_summary",{"_index":238,"name":{"230":{}},"parent":{}}],["apiml_v1_resource",{"_index":168,"name":{"125":{},"129":{}},"parent":{}}],["apiml_v1_token_exp_err",{"_index":175,"name":{"130":{}},"parent":{}}],["apiml_v2_logout_err_list",{"_index":176,"name":{"131":{}},"parent":{}}],["apimlconnlookup",{"_index":2342,"name":{"3004":{}},"parent":{}}],["apimlconstants",{"_index":4,"name":{"1":{}},"parent":{}}],["apimllogin",{"_index":171,"name":{"127":{}},"parent":{}}],["apimllogout",{"_index":183,"name":{"137":{}},"parent":{}}],["apiname",{"_index":1306,"name":{"1561":{}},"parent":{}}],["apiresponse",{"_index":3343,"name":{"4477":{},"4849":{}},"parent":{}}],["app_log_level_key_suffix",{"_index":538,"name":{"537":{}},"parent":{}}],["app_mask_output_suffix",{"_index":539,"name":{"538":{}},"parent":{}}],["appdata",{"_index":3998,"name":{"5417":{}},"parent":{}}],["appendautooptions",{"_index":2009,"name":{"2459":{}},"parent":{}}],["appenders",{"_index":320,"name":{"323":{}},"parent":{}}],["appendheaders",{"_index":165,"name":{"122":{},"1364":{},"1430":{}},"parent":{}}],["appendinputheaders",{"_index":1174,"name":{"1371":{}},"parent":{}}],["appendpassonoptions",{"_index":2008,"name":{"2458":{}},"parent":{}}],["appendtodocument",{"_index":2024,"name":{"2493":{}},"parent":{}}],["appendtosinglepagehtml",{"_index":1853,"name":{"2209":{}},"parent":{}}],["appendvalidatorerror",{"_index":1741,"name":{"2050":{}},"parent":{}}],["application_json",{"_index":1110,"name":{"1295":{}},"parent":{}}],["applid",{"_index":32,"name":{"23":{}},"parent":{}}],["applogger",{"_index":1341,"name":{"1594":{},"1604":{}},"parent":{}}],["applogging",{"_index":2318,"name":{"2972":{}},"parent":{}}],["apploglevel",{"_index":466,"name":{"467":{}},"parent":{}}],["applytaggedencoding",{"_index":3488,"name":{"4699":{}},"parent":{}}],["applytohandlers",{"_index":299,"name":{"304":{}},"parent":{}}],["appname",{"_index":780,"name":{"842":{}},"parent":{}}],["approver",{"_index":4158,"name":{"5667":{}},"parent":{}}],["approvers",{"_index":4177,"name":{"5688":{}},"parent":{}}],["approversub",{"_index":4160,"name":{"5668":{}},"parent":{}}],["appsettings",{"_index":1419,"name":{"1679":{}},"parent":{}}],["arch",{"_index":2365,"name":{"3038":{}},"parent":{}}],["arch_workflow_resource",{"_index":4087,"name":{"5574":{}},"parent":{}}],["architecture",{"_index":2670,"name":{"3604":{}},"parent":{}}],["archive_workflow",{"_index":4089,"name":{"5576":{}},"parent":{}}],["archiveddeleteworkflow",{"_index":4128,"name":{"5623":{},"5624":{}},"parent":{}}],["archivedinstanceuri",{"_index":4237,"name":{"5779":{}},"parent":{}}],["archivedworkflows",{"_index":4239,"name":{"5781":{}},"parent":{}}],["archiveworkflow",{"_index":4125,"name":{"5621":{}},"parent":{}}],["archiveworkflowbykey",{"_index":4126,"name":{"5622":{}},"parent":{}}],["argdatatype",{"_index":2302,"name":{"2954":{}},"parent":{}}],["argloc",{"_index":2200,"name":{"2829":{}},"parent":{}}],["argname",{"_index":2196,"name":{"2826":{}},"parent":{}}],["argoldprofileloc",{"_index":2304,"name":{"2956":{}},"parent":{}}],["args",{"_index":1657,"name":{"1928":{},"2090":{},"3186":{},"3200":{}},"parent":{}}],["argteamconfigloc",{"_index":2303,"name":{"2955":{}},"parent":{}}],["argumentname",{"_index":1209,"name":{"1445":{}},"parent":{}}],["arguments",{"_index":1006,"name":{"1129":{},"2092":{}},"parent":{}}],["argv",{"_index":576,"name":{"585":{}},"parent":{}}],["argvalue",{"_index":2199,"name":{"2828":{}},"parent":{}}],["arrayallowduplicate",{"_index":812,"name":{"884":{}},"parent":{}}],["arrayfrom",{"_index":2779,"name":{"3799":{}},"parent":{}}],["arraytocontain",{"_index":360,"name":{"358":{}},"parent":{}}],["as",{"_index":2875,"name":{"3907":{}},"parent":{}}],["ascii_files",{"_index":3551,"name":{"4781":{}},"parent":{}}],["assignees",{"_index":4272,"name":{"5830":{},"5937":{}},"parent":{}}],["assigntoowner",{"_index":4138,"name":{"5637":{}},"parent":{}}],["associatedendpoints",{"_index":2491,"name":{"3239":{},"3249":{}},"parent":{}}],["async",{"_index":3019,"name":{"4126":{},"4154":{}},"parent":{}}],["asyncpool",{"_index":288,"name":{"294":{}},"parent":{}}],["at",{"_index":2887,"name":{"3916":{},"3920":{}},"parent":{}}],["attempthandlerload",{"_index":1887,"name":{"2262":{}},"parent":{}}],["attempts",{"_index":3707,"name":{"5007":{},"5014":{},"5025":{},"5033":{}},"parent":{}}],["attributes",{"_index":107,"name":{"83":{},"4596":{},"4707":{},"4740":{},"4783":{}},"parent":{}}],["attributesfilenotfound",{"_index":3251,"name":{"4365":{}},"parent":{}}],["attributetitle",{"_index":3313,"name":{"4427":{}},"parent":{}}],["audit",{"_index":2915,"name":{"3964":{}},"parent":{}}],["auth_group",{"_index":528,"name":{"528":{}},"parent":{}}],["auth_group_description",{"_index":230,"name":{"221":{}},"parent":{}}],["auth_group_summary",{"_index":229,"name":{"220":{}},"parent":{}}],["auth_type_basic",{"_index":1054,"name":{"1199":{}},"parent":{}}],["auth_type_bearer",{"_index":1055,"name":{"1200":{}},"parent":{}}],["auth_type_cert_pem",{"_index":1057,"name":{"1202":{}},"parent":{}}],["auth_type_choices",{"_index":1058,"name":{"1203":{}},"parent":{}}],["auth_type_none",{"_index":1053,"name":{"1198":{}},"parent":{}}],["auth_type_token",{"_index":1056,"name":{"1201":{}},"parent":{}}],["authcategorydesc",{"_index":1625,"name":{"1890":{}},"parent":{}}],["authcommandbuilder",{"_index":2064,"name":{"2597":{}},"parent":{}}],["authconfig",{"_index":1746,"name":{"2057":{}},"parent":{}}],["authentication",{"_index":48,"name":{"36":{}},"parent":{}}],["authenticationhandler",{"_index":4065,"name":{"5521":{}},"parent":{}}],["authgroup",{"_index":2073,"name":{"2628":{}},"parent":{}}],["authgroupconfig",{"_index":2330,"name":{"2989":{}},"parent":{}}],["authlogincommandbuilder",{"_index":2068,"name":{"2607":{}},"parent":{}}],["authlogincommanddesc",{"_index":1631,"name":{"1896":{}},"parent":{}}],["authlogingroupdesc",{"_index":1629,"name":{"1894":{}},"parent":{}}],["authlogingroupsummary",{"_index":1627,"name":{"1892":{}},"parent":{}}],["authloginshowtokendesc",{"_index":1633,"name":{"1898":{}},"parent":{}}],["authlogoutcommandbuilder",{"_index":2070,"name":{"2617":{}},"parent":{}}],["authlogoutcommanddesc",{"_index":1639,"name":{"1904":{}},"parent":{}}],["authlogoutgroupdesc",{"_index":1637,"name":{"1902":{}},"parent":{}}],["authlogoutgroupsummary",{"_index":1635,"name":{"1900":{}},"parent":{}}],["authorization",{"_index":1117,"name":{"1304":{}},"parent":{}}],["auto_init_action",{"_index":533,"name":{"533":{}},"parent":{}}],["auto_init_option_cert_file",{"_index":225,"name":{"214":{}},"parent":{}}],["auto_init_option_cert_key_file",{"_index":227,"name":{"217":{}},"parent":{}}],["auto_init_option_dry_run",{"_index":2096,"name":{"2673":{}},"parent":{}}],["auto_init_option_edit",{"_index":2098,"name":{"2680":{}},"parent":{}}],["auto_init_option_for_sure",{"_index":2102,"name":{"2695":{}},"parent":{}}],["auto_init_option_global_config",{"_index":2094,"name":{"2666":{}},"parent":{}}],["auto_init_option_group",{"_index":210,"name":{"193":{},"2658":{}},"parent":{}}],["auto_init_option_host",{"_index":211,"name":{"194":{}},"parent":{}}],["auto_init_option_overwrite",{"_index":2100,"name":{"2687":{}},"parent":{}}],["auto_init_option_password",{"_index":217,"name":{"203":{}},"parent":{}}],["auto_init_option_port",{"_index":213,"name":{"197":{}},"parent":{}}],["auto_init_option_reject_unauthorized",{"_index":219,"name":{"206":{}},"parent":{}}],["auto_init_option_token_type",{"_index":221,"name":{"208":{}},"parent":{}}],["auto_init_option_token_value",{"_index":223,"name":{"211":{}},"parent":{}}],["auto_init_option_user",{"_index":215,"name":{"200":{}},"parent":{}}],["auto_init_option_user_config",{"_index":2092,"name":{"2659":{}},"parent":{}}],["autoenable",{"_index":4178,"name":{"5689":{},"5831":{},"5938":{}},"parent":{}}],["autogenerateprofilecommands",{"_index":2332,"name":{"2991":{}},"parent":{}}],["autoinit",{"_index":2089,"name":{"2655":{}},"parent":{}}],["autoinitcommandbuilder",{"_index":2104,"name":{"2702":{}},"parent":{}}],["autoinitcommanddesc",{"_index":1641,"name":{"1906":{}},"parent":{}}],["autoinitconstants",{"_index":2090,"name":{"2657":{}},"parent":{}}],["automationstatus",{"_index":4287,"name":{"5917":{}},"parent":{}}],["autostore",{"_index":604,"name":{"615":{},"1455":{}},"parent":{}}],["available_chalk_colors",{"_index":335,"name":{"334":{}},"parent":{}}],["avgblk",{"_index":3355,"name":{"4488":{}},"parent":{}}],["bad_host_name",{"_index":4320,"name":{"6015":{}},"parent":{}}],["bad_port",{"_index":4322,"name":{"6016":{}},"parent":{}}],["badcredentialmanagererror",{"_index":678,"name":{"712":{}},"parent":{}}],["base64encodedauth",{"_index":1066,"name":{"1217":{}},"parent":{}}],["base_connection_option_group",{"_index":186,"name":{"139":{}},"parent":{}}],["base_option_cert_file",{"_index":206,"name":{"183":{}},"parent":{}}],["base_option_cert_key_file",{"_index":208,"name":{"188":{}},"parent":{}}],["base_option_host",{"_index":188,"name":{"140":{}},"parent":{}}],["base_option_password",{"_index":197,"name":{"158":{}},"parent":{}}],["base_option_port",{"_index":193,"name":{"146":{}},"parent":{}}],["base_option_reject_unauthorized",{"_index":199,"name":{"164":{}},"parent":{}}],["base_option_token_type",{"_index":202,"name":{"171":{}},"parent":{}}],["base_option_token_value",{"_index":204,"name":{"177":{}},"parent":{}}],["base_option_user",{"_index":195,"name":{"152":{}},"parent":{}}],["baseauthhandler",{"_index":2143,"name":{"2757":{}},"parent":{}}],["baseautoinithandler",{"_index":2152,"name":{"2775":{}},"parent":{}}],["baseoverrides",{"_index":71,"name":{"58":{}},"parent":{}}],["basepath",{"_index":27,"name":{"19":{},"55":{},"1182":{},"1215":{},"4708":{},"6182":{}},"parent":{}}],["basepaths",{"_index":15,"name":{"9":{}},"parent":{}}],["baseprofile",{"_index":249,"name":{"241":{},"2988":{}},"parent":{}}],["baseurl",{"_index":26,"name":{"18":{}},"parent":{}}],["basevalue",{"_index":65,"name":{"50":{}},"parent":{}}],["basic",{"_index":1088,"name":{"1242":{},"1266":{},"1442":{}},"parent":{}}],["basic_authorization",{"_index":1116,"name":{"1303":{}},"parent":{}}],["basic_prefix",{"_index":1076,"name":{"1231":{},"1255":{},"1320":{}},"parent":{}}],["basicprofilemanager",{"_index":2519,"name":{"3266":{}},"parent":{}}],["basicprofilemanagerfactory",{"_index":2523,"name":{"3311":{}},"parent":{}}],["be",{"_index":2954,"name":{"4018":{}},"parent":{}}],["bearer_prefix",{"_index":1078,"name":{"1232":{},"1256":{},"1321":{}},"parent":{}}],["binary",{"_index":3329,"name":{"4441":{},"4561":{},"4658":{},"4693":{},"4702":{},"4727":{},"4772":{},"4775":{},"4788":{},"4958":{}},"parent":{}}],["binary_files",{"_index":3550,"name":{"4780":{}},"parent":{}}],["blank",{"_index":3388,"name":{"4569":{}},"parent":{}}],["blksize",{"_index":3356,"name":{"4490":{},"4536":{},"4543":{},"4550":{},"4558":{},"4566":{}},"parent":{}}],["blksz",{"_index":3421,"name":{"4617":{}},"parent":{}}],["bufferstderr",{"_index":1694,"name":{"1990":{}},"parent":{}}],["bufferstdout",{"_index":1693,"name":{"1989":{}},"parent":{}}],["buffertodataset",{"_index":3559,"name":{"4804":{}},"parent":{}}],["buffertoussfile",{"_index":3562,"name":{"4807":{}},"parent":{}}],["build",{"_index":587,"name":{"596":{},"2496":{},"2505":{},"2517":{},"2528":{},"2539":{},"2550":{},"2561":{},"2572":{},"2605":{},"2616":{},"2626":{},"2710":{},"2793":{},"3598":{},"3758":{}},"parent":{}}],["buildapploggingdefaults",{"_index":1360,"name":{"1616":{}},"parent":{}}],["buildauthsegmentfromconfig",{"_index":2067,"name":{"2606":{},"2610":{},"2620":{}},"parent":{}}],["buildautoinitsegmentfromconfig",{"_index":2107,"name":{"2711":{}},"parent":{}}],["buildbaseargs",{"_index":2566,"name":{"3388":{}},"parent":{}}],["buildchildrensummarytables",{"_index":1820,"name":{"2153":{},"2208":{}},"parent":{}}],["buildcmdtreehtml",{"_index":1855,"name":{"2211":{}},"parent":{}}],["buildcommandandaliases",{"_index":1819,"name":{"2152":{}},"parent":{}}],["buildcommandmap",{"_index":1761,"name":{"2078":{}},"parent":{}}],["buildcommandmetamap",{"_index":1762,"name":{"2079":{}},"parent":{}}],["buildcommandoptionssection",{"_index":1826,"name":{"2159":{}},"parent":{}}],["builddefaultprofile",{"_index":2168,"name":{"2794":{}},"parent":{}}],["builddescriptionsection",{"_index":1824,"name":{"2157":{}},"parent":{}}],["builddiffdir",{"_index":2390,"name":{"3060":{}},"parent":{}}],["builddownloaddsmresponse",{"_index":3533,"name":{"4761":{}},"parent":{}}],["builddownloadussdirresponse",{"_index":3534,"name":{"4762":{}},"parent":{}}],["buildexamplessection",{"_index":1829,"name":{"2162":{}},"parent":{}}],["buildfailedcommanddefinition",{"_index":2016,"name":{"2476":{}},"parent":{}}],["buildfailuremessage",{"_index":2015,"name":{"2475":{}},"parent":{}}],["buildfull",{"_index":2027,"name":{"2495":{},"2503":{},"2511":{},"2521":{},"2532":{},"2544":{},"2555":{},"2565":{},"2603":{},"2609":{},"2619":{},"2708":{},"3751":{}},"parent":{}}],["buildfullcommandhelptext",{"_index":1808,"name":{"2137":{},"2151":{}},"parent":{}}],["buildfullgrouphelptext",{"_index":1818,"name":{"2150":{}},"parent":{}}],["buildfulllogfile",{"_index":1332,"name":{"1586":{}},"parent":{}}],["buildglobaloptionssection",{"_index":1823,"name":{"2156":{}},"parent":{}}],["buildheader",{"_index":1828,"name":{"2161":{}},"parent":{}}],["buildheaders",{"_index":341,"name":{"340":{}},"parent":{}}],["buildhelp",{"_index":1768,"name":{"2087":{},"2135":{},"2149":{},"2202":{}},"parent":{}}],["buildimperativeloggingdefaults",{"_index":1359,"name":{"1615":{}},"parent":{}}],["buildjsonresponse",{"_index":1651,"name":{"1922":{},"1992":{}},"parent":{}}],["buildload",{"_index":1764,"name":{"2081":{}},"parent":{}}],["buildloggingdefaults",{"_index":1358,"name":{"1614":{}},"parent":{}}],["buildloggingdefaultsbykey",{"_index":1361,"name":{"1617":{}},"parent":{}}],["buildoptionmaps",{"_index":1809,"name":{"2138":{},"2181":{}},"parent":{}}],["buildoptions",{"_index":1169,"name":{"1366":{}},"parent":{}}],["buildoptionsfromprofileschema",{"_index":2033,"name":{"2507":{},"2518":{},"2529":{},"2540":{},"2551":{},"2562":{},"2573":{},"3759":{}},"parent":{}}],["buildoptiontext",{"_index":1827,"name":{"2160":{}},"parent":{}}],["buildpositionalargumentssection",{"_index":1825,"name":{"2158":{}},"parent":{}}],["buildpositionalstring",{"_index":1899,"name":{"2276":{}},"parent":{}}],["buildprefix",{"_index":441,"name":{"441":{}},"parent":{}}],["buildprofile",{"_index":647,"name":{"663":{}},"parent":{}}],["buildprofilesegmentfromschema",{"_index":2032,"name":{"2506":{},"2512":{},"2522":{},"2533":{},"2545":{},"2556":{},"2566":{},"3752":{}},"parent":{}}],["buildschema",{"_index":1294,"name":{"1546":{},"2948":{}},"parent":{}}],["buildsession",{"_index":1094,"name":{"1250":{},"3584":{},"5503":{}},"parent":{}}],["buildusagediagram",{"_index":1821,"name":{"2154":{}},"parent":{}}],["buildusagesection",{"_index":1822,"name":{"2155":{}},"parent":{}}],["buildzosmfconsoleapiparameters",{"_index":3087,"name":{"4202":{}},"parent":{}}],["by",{"_index":2909,"name":{"3951":{},"3952":{}},"parent":{}}],["byte",{"_index":3678,"name":{"4964":{},"5819":{}},"parent":{}}],["c",{"_index":3385,"name":{"4553":{}},"parent":{}}],["cacheandprune",{"_index":723,"name":{"773":{}},"parent":{}}],["calcpackagemetadata",{"_index":1862,"name":{"2224":{}},"parent":{}}],["calledinstancekey",{"_index":4273,"name":{"5832":{},"5939":{}},"parent":{}}],["calledinstancescope",{"_index":4274,"name":{"5833":{},"5940":{}},"parent":{}}],["calledinstanceuri",{"_index":4275,"name":{"5834":{},"5941":{}},"parent":{}}],["calledworkflowdefinitionfile",{"_index":4171,"name":{"5682":{},"5839":{},"5946":{}},"parent":{}}],["calledworkflowdescription",{"_index":4168,"name":{"5679":{},"5838":{},"5945":{}},"parent":{}}],["calledworkflowid",{"_index":4169,"name":{"5680":{},"5835":{},"5942":{}},"parent":{}}],["calledworkflowmd5",{"_index":4170,"name":{"5681":{},"5837":{},"5944":{}},"parent":{}}],["calledworkflowversion",{"_index":4172,"name":{"5683":{},"5836":{},"5943":{}},"parent":{}}],["callerlocation",{"_index":2349,"name":{"3018":{}},"parent":{}}],["callerpackagejson",{"_index":2355,"name":{"3026":{}},"parent":{}}],["callingstepautoenable",{"_index":4173,"name":{"5684":{}},"parent":{}}],["callingstepskills",{"_index":4175,"name":{"5686":{}},"parent":{}}],["callingstepweight",{"_index":4174,"name":{"5685":{}},"parent":{}}],["callpluginpostinstall",{"_index":2636,"name":{"3564":{}},"parent":{}}],["callpluginpreuninstall",{"_index":2743,"name":{"3701":{}},"parent":{}}],["camelcase",{"_index":545,"name":{"544":{}},"parent":{}}],["cancel_workflow",{"_index":4090,"name":{"5577":{}},"parent":{}}],["canceljob",{"_index":3660,"name":{"4939":{}},"parent":{}}],["canceljobcommon",{"_index":3663,"name":{"4941":{}},"parent":{}}],["canceljobforjob",{"_index":3662,"name":{"4940":{}},"parent":{}}],["canceljobs",{"_index":3659,"name":{"4938":{}},"parent":{}}],["cancelworkflow",{"_index":4130,"name":{"5625":{},"5626":{}},"parent":{}}],["cant_get_schema_url",{"_index":2220,"name":{"2849":{}},"parent":{}}],["cart",{"_index":3822,"name":{"5157":{}},"parent":{}}],["casesensitive",{"_index":798,"name":{"864":{},"1956":{},"6124":{}},"parent":{}}],["catalog",{"_index":2902,"name":{"3944":{},"3945":{}},"parent":{}}],["catch",{"_index":884,"name":{"967":{}},"parent":{}}],["categories",{"_index":323,"name":{"325":{}},"parent":{}}],["category",{"_index":403,"name":{"399":{},"3423":{},"5063":{},"5579":{},"5732":{},"5758":{},"5777":{},"5789":{},"5907":{}},"parent":{}}],["catnm",{"_index":3422,"name":{"4618":{}},"parent":{}}],["causeerror",{"_index":684,"name":{"726":{}},"parent":{}}],["causeerrors",{"_index":308,"name":{"311":{},"715":{},"1189":{},"1326":{},"2271":{},"2862":{},"3442":{},"3730":{},"3741":{},"3779":{},"3790":{}},"parent":{}}],["cdate",{"_index":3423,"name":{"4619":{}},"parent":{}}],["censor_response",{"_index":2550,"name":{"3370":{},"3391":{}},"parent":{}}],["censorcliargs",{"_index":2553,"name":{"3373":{},"3394":{}},"parent":{}}],["censored_options",{"_index":2552,"name":{"3371":{},"3392":{}},"parent":{}}],["censorrawdata",{"_index":2576,"name":{"3406":{}},"parent":{}}],["censoryargsarguments",{"_index":2554,"name":{"3374":{},"3395":{}},"parent":{}}],["cert",{"_index":1028,"name":{"1161":{},"1221":{}},"parent":{}}],["certfile",{"_index":271,"name":{"276":{},"6176":{}},"parent":{}}],["certkey",{"_index":1067,"name":{"1222":{}},"parent":{}}],["certkeyfile",{"_index":273,"name":{"279":{},"6179":{}},"parent":{}}],["cfg_error",{"_index":1400,"name":{"1655":{}},"parent":{}}],["chainedhandlers",{"_index":836,"name":{"919":{}},"parent":{}}],["chainedhandlerservice",{"_index":2599,"name":{"3451":{}},"parent":{}}],["chalk",{"_index":346,"name":{"345":{}},"parent":{}}],["changeforconfig",{"_index":75,"name":{"61":{}},"parent":{}}],["changeforprof",{"_index":67,"name":{"52":{}},"parent":{}}],["changeview",{"_index":2807,"name":{"3831":{}},"parent":{}}],["characterset",{"_index":3850,"name":{"5191":{},"5317":{}},"parent":{}}],["checkforkeytar",{"_index":673,"name":{"701":{}},"parent":{}}],["checkforpassedoptionalparms",{"_index":3011,"name":{"4117":{}},"parent":{}}],["checkifallowable",{"_index":1720,"name":{"2029":{}},"parent":{}}],["checkifmetadatachanged",{"_index":1864,"name":{"2226":{}},"parent":{}}],["checkkeytaravailable",{"_index":2646,"name":{"3576":{}},"parent":{}}],["checkserveridentity",{"_index":1071,"name":{"1226":{}},"parent":{}}],["checkstatus",{"_index":3770,"name":{"5105":{},"6049":{}},"parent":{}}],["checksubmitoptions",{"_index":3786,"name":{"5120":{}},"parent":{}}],["children",{"_index":837,"name":{"920":{},"2190":{},"2637":{},"2644":{},"2651":{},"3457":{},"3808":{}},"parent":{}}],["choice",{"_index":2955,"name":{"4018":{},"5733":{}},"parent":{}}],["choices",{"_index":2956,"name":{"4019":{}},"parent":{}}],["chtag",{"_index":3486,"name":{"4697":{}},"parent":{}}],["class",{"_index":89,"name":{"71":{},"4160":{},"4911":{},"4967":{},"4981":{},"5054":{}},"parent":{}}],["classic",{"_index":3383,"name":{"4545":{}},"parent":{}}],["clean",{"_index":2884,"name":{"3913":{},"3947":{}},"parent":{}}],["clearcontext",{"_index":429,"name":{"423":{}},"parent":{}}],["cleardefault",{"_index":1973,"name":{"2419":{},"3124":{},"3298":{}},"parent":{}}],["cli_core_pkg_name",{"_index":1369,"name":{"1625":{}},"parent":{}}],["cli_home_suffix",{"_index":540,"name":{"539":{}},"parent":{}}],["cli_plugins_dir_suffix",{"_index":542,"name":{"541":{}},"parent":{}}],["clidependency",{"_index":1387,"name":{"1643":{}},"parent":{}}],["client_property",{"_index":1030,"name":{"1164":{},"4448":{}},"parent":{}}],["clientprompt",{"_index":1228,"name":{"1467":{}},"parent":{}}],["clihome",{"_index":467,"name":{"468":{},"3024":{}},"parent":{}}],["clipboard",{"_index":2783,"name":{"3803":{}},"parent":{}}],["clipboardjs",{"_index":2778,"name":{"3798":{}},"parent":{}}],["cliprofilemanager",{"_index":1942,"name":{"2379":{}},"parent":{}}],["cliutils",{"_index":2549,"name":{"3369":{}},"parent":{}}],["clonelayers",{"_index":756,"name":{"809":{}},"parent":{}}],["cmd",{"_index":3014,"name":{"4120":{},"4123":{},"4128":{},"4129":{},"4130":{},"4131":{}},"parent":{}}],["cmd_error",{"_index":1402,"name":{"1656":{}},"parent":{}}],["cmdarguments",{"_index":1262,"name":{"1498":{},"1513":{}},"parent":{}}],["cmdresponseurl",{"_index":3037,"name":{"4149":{}},"parent":{}}],["code",{"_index":3658,"name":{"4936":{},"5057":{},"5058":{}},"parent":{}}],["codepage",{"_index":3851,"name":{"5192":{},"5320":{}},"parent":{}}],["coercepropvalue",{"_index":713,"name":{"763":{}},"parent":{}}],["collect",{"_index":3102,"name":{"4216":{}},"parent":{}}],["collectallconfigurations",{"_index":2436,"name":{"3148":{}},"parent":{}}],["collectcommand",{"_index":3098,"name":{"4213":{}},"parent":{}}],["collectcommon",{"_index":3099,"name":{"4214":{}},"parent":{}}],["collectdefconsolecommon",{"_index":3101,"name":{"4215":{}},"parent":{}}],["collectedresponses",{"_index":3963,"name":{"5368":{}},"parent":{}}],["collectprocessingdetails",{"_index":3072,"name":{"4188":{}},"parent":{}}],["color",{"_index":443,"name":{"444":{},"5158":{}},"parent":{}}],["columns",{"_index":3853,"name":{"5194":{},"5324":{}},"parent":{}}],["combineallcmddefs",{"_index":1316,"name":{"1569":{}},"parent":{}}],["combo_id",{"_index":3614,"name":{"4879":{}},"parent":{}}],["command",{"_index":1458,"name":{"1726":{},"3904":{},"3907":{},"3908":{},"3909":{},"3910":{},"4151":{},"5240":{}},"parent":{}}],["command_prof_type_props",{"_index":534,"name":{"534":{}},"parent":{}}],["command_response_format",{"_index":1654,"name":{"1925":{}},"parent":{}}],["command_segment",{"_index":479,"name":{"479":{}},"parent":{}}],["commanddefinition",{"_index":1752,"name":{"2068":{},"2110":{},"2324":{}},"parent":{}}],["commandline",{"_index":1778,"name":{"2100":{},"2244":{},"2283":{},"2305":{},"2330":{},"2350":{},"2471":{},"2724":{},"3027":{}},"parent":{}}],["commandmoduleglobs",{"_index":2325,"name":{"2978":{}},"parent":{}}],["commandoptiontype",{"_index":815,"name":{"887":{}},"parent":{}}],["commandpreparer",{"_index":2000,"name":{"2450":{}},"parent":{}}],["commandprocessor",{"_index":1866,"name":{"2228":{}},"parent":{}}],["commandprofileloader",{"_index":1756,"name":{"2071":{}},"parent":{}}],["commandprofiles",{"_index":847,"name":{"931":{}},"parent":{}}],["commandresponse",{"_index":1670,"name":{"1958":{},"4146":{},"4476":{},"4851":{},"5346":{},"5378":{}},"parent":{}}],["commandresponsekey",{"_index":3027,"name":{"4137":{}},"parent":{}}],["commandresponseparms",{"_index":1921,"name":{"2325":{}},"parent":{}}],["commandresponses",{"_index":1893,"name":{"2270":{}},"parent":{}}],["commandrespparms",{"_index":2013,"name":{"2466":{}},"parent":{}}],["commandsegment",{"_index":1471,"name":{"1737":{}},"parent":{}}],["commandutils",{"_index":1462,"name":{"1729":{}},"parent":{}}],["commandyargs",{"_index":1895,"name":{"2273":{}},"parent":{}}],["commonfor",{"_index":3315,"name":{"4429":{}},"parent":{}}],["commonwithvalue",{"_index":3319,"name":{"4433":{}},"parent":{}}],["comparecommands",{"_index":846,"name":{"930":{}},"parent":{}}],["comparepluginversiontocli",{"_index":1446,"name":{"1714":{}},"parent":{}}],["complete",{"_index":873,"name":{"957":{},"3913":{}},"parent":{}}],["completeauthgroupbuilder",{"_index":2077,"name":{"2631":{}},"parent":{}}],["completeautoinitcommandbuilder",{"_index":2108,"name":{"2712":{}},"parent":{}}],["completeprofilesgroupbuilder",{"_index":2046,"name":{"2574":{}},"parent":{}}],["completion",{"_index":3734,"name":{"5056":{},"5057":{}},"parent":{}}],["compressionutils",{"_index":1138,"name":{"1333":{}},"parent":{}}],["config",{"_index":745,"name":{"800":{},"810":{},"1500":{},"1515":{},"2104":{},"2248":{},"2580":{},"2788":{},"3029":{},"3397":{}},"parent":{}}],["configapi",{"_index":627,"name":{"637":{}},"parent":{}}],["configautoinitcommandconfig",{"_index":2331,"name":{"2990":{}},"parent":{}}],["configautostore",{"_index":1272,"name":{"1520":{}},"parent":{}}],["configbuilder",{"_index":2166,"name":{"2792":{}},"parent":{}}],["configconstants",{"_index":588,"name":{"597":{}},"parent":{}}],["configfilenm",{"_index":73,"name":{"60":{}},"parent":{}}],["configlayers",{"_index":630,"name":{"640":{}},"parent":{}}],["configmanagementfacility",{"_index":2626,"name":{"3551":{}},"parent":{}}],["configname",{"_index":781,"name":{"843":{}},"parent":{}}],["configplugins",{"_index":638,"name":{"650":{}},"parent":{}}],["configprofiles",{"_index":640,"name":{"654":{}},"parent":{}}],["configproperties",{"_index":2193,"name":{"2823":{}},"parent":{}}],["configschema",{"_index":1282,"name":{"1529":{}},"parent":{}}],["configsecure",{"_index":718,"name":{"767":{}},"parent":{}}],["configuration",{"_index":2406,"name":{"3074":{},"3175":{}},"parent":{}}],["configurationloader",{"_index":1307,"name":{"1562":{}},"parent":{}}],["configurationmodule",{"_index":2324,"name":{"2977":{}},"parent":{}}],["configurations",{"_index":1969,"name":{"2411":{},"3116":{},"3290":{}},"parent":{}}],["configurationvalidator",{"_index":1309,"name":{"1564":{}},"parent":{}}],["configure",{"_index":2014,"name":{"2474":{}},"parent":{}}],["configureapplogger",{"_index":1355,"name":{"1611":{}},"parent":{}}],["configureimperativelogger",{"_index":1354,"name":{"1610":{}},"parent":{}}],["configurelogger",{"_index":1352,"name":{"1609":{}},"parent":{}}],["configureloggerbykey",{"_index":1356,"name":{"1612":{}},"parent":{}}],["configureloggerbykeyhelper",{"_index":1357,"name":{"1613":{}},"parent":{}}],["configutils",{"_index":712,"name":{"762":{}},"parent":{}}],["conflictingnameoralias",{"_index":1449,"name":{"1717":{}},"parent":{}}],["conflictswith",{"_index":806,"name":{"877":{},"2678":{},"2685":{}},"parent":{}}],["connectionpropsforsesscfg",{"_index":1220,"name":{"1456":{}},"parent":{}}],["connectionrefused",{"_index":4051,"name":{"5507":{}},"parent":{}}],["connproftype",{"_index":8,"name":{"4":{},"1553":{}},"parent":{}}],["connrefusedflag",{"_index":4061,"name":{"5517":{}},"parent":{}}],["console",{"_index":415,"name":{"410":{},"453":{},"1120":{},"1983":{},"2727":{},"3365":{},"3676":{},"3688":{},"3699":{},"3712":{},"4118":{},"5530":{},"6146":{}},"parent":{"4119":{},"4120":{},"4121":{},"4122":{},"4123":{},"4124":{},"4125":{},"4126":{},"4127":{},"4128":{},"4129":{},"4130":{},"4131":{},"4132":{},"4133":{},"4134":{},"4135":{},"4136":{},"4137":{},"4138":{},"4139":{},"4140":{},"4141":{},"4142":{},"4143":{},"4144":{},"4145":{},"4146":{},"4147":{},"4148":{},"4149":{},"4150":{},"4151":{},"4152":{},"4153":{},"4154":{},"4155":{},"4156":{},"4157":{},"4158":{},"4159":{},"4160":{},"4161":{},"4162":{},"4163":{},"4164":{},"4165":{},"4166":{},"4167":{},"4168":{},"4169":{},"4170":{},"4171":{},"4172":{},"4173":{},"4174":{},"4175":{},"4176":{},"4177":{},"4178":{},"4179":{},"4180":{},"4181":{},"4182":{},"4183":{},"4184":{},"4185":{},"4186":{},"4187":{},"4188":{},"4189":{},"4190":{},"4191":{},"4192":{},"4193":{},"4194":{},"4195":{},"4196":{},"4197":{},"4198":{},"4199":{},"4200":{},"4201":{},"4202":{},"4203":{},"4204":{},"4205":{},"4206":{},"4207":{},"4208":{},"4209":{},"4210":{},"4211":{},"4212":{},"4213":{},"4214":{},"4215":{},"4216":{},"4217":{},"4218":{},"4219":{},"4220":{}}}],["consoleconstants",{"_index":3044,"name":{"4159":{}},"parent":{}}],["consolename",{"_index":3023,"name":{"4134":{},"4140":{},"4155":{}},"parent":{}}],["consoleresponse",{"_index":3042,"name":{"4157":{}},"parent":{}}],["consoleresponseservice",{"_index":3074,"name":{"4190":{}},"parent":{}}],["consolevalidator",{"_index":3088,"name":{"4203":{}},"parent":{}}],["constants",{"_index":471,"name":{"472":{}},"parent":{}}],["constructapiobject",{"_index":2131,"name":{"2746":{}},"parent":{}}],["constructapploggerapi",{"_index":2132,"name":{"2747":{}},"parent":{}}],["constructconsoleapi",{"_index":2134,"name":{"2749":{}},"parent":{}}],["constructdefinitiontree",{"_index":1907,"name":{"2292":{},"2314":{},"2359":{}},"parent":{}}],["constructdynamicloggersapi",{"_index":2135,"name":{"2750":{}},"parent":{}}],["constructerrormsg",{"_index":3771,"name":{"5106":{}},"parent":{}}],["constructfullprofilepath",{"_index":1978,"name":{"2424":{},"3136":{},"3303":{}},"parent":{}}],["constructimperativeloggerapi",{"_index":2133,"name":{"2748":{}},"parent":{}}],["constructloadlist",{"_index":1763,"name":{"2080":{}},"parent":{}}],["constructmetaname",{"_index":2432,"name":{"3144":{}},"parent":{}}],["constructor",{"_index":425,"name":{"419":{},"455":{},"593":{},"638":{},"648":{},"652":{},"665":{},"669":{},"694":{},"713":{},"724":{},"780":{},"829":{},"934":{},"1002":{},"1061":{},"1247":{},"1253":{},"1323":{},"1361":{},"1428":{},"1599":{},"1635":{},"1675":{},"1684":{},"1981":{},"2021":{},"2076":{},"2134":{},"2148":{},"2201":{},"2242":{},"2280":{},"2302":{},"2347":{},"2398":{},"2463":{},"2490":{},"2499":{},"2509":{},"2524":{},"2535":{},"2542":{},"2553":{},"2568":{},"2578":{},"2595":{},"2599":{},"2612":{},"2622":{},"2704":{},"2858":{},"2921":{},"2963":{},"3103":{},"3277":{},"3314":{},"3345":{},"3356":{},"3364":{},"3421":{},"3440":{},"3663":{},"3728":{},"3739":{},"3754":{},"3777":{},"3788":{},"4709":{},"5500":{}},"parent":{}}],["constructprofilesrootdirectory",{"_index":1991,"name":{"2442":{}},"parent":{}}],["constructresponseobject",{"_index":1885,"name":{"2260":{}},"parent":{}}],["containsparallelsteps",{"_index":4226,"name":{"5756":{},"5913":{}},"parent":{}}],["content",{"_index":133,"name":{"100":{},"102":{},"1296":{},"1298":{},"1300":{},"1302":{}},"parent":{}}],["content_encoding",{"_index":1108,"name":{"1293":{}},"parent":{}}],["content_encoding_types",{"_index":1109,"name":{"1294":{}},"parent":{}}],["content_length",{"_index":1107,"name":{"1292":{}},"parent":{}}],["content_type",{"_index":1105,"name":{"1291":{}},"parent":{}}],["contentencoding",{"_index":1122,"name":{"1307":{}},"parent":{}}],["contextlinesarg",{"_index":2388,"name":{"3056":{}},"parent":{}}],["continuepath",{"_index":957,"name":{"1043":{}},"parent":{}}],["control",{"_index":1697,"name":{"1998":{}},"parent":{}}],["control_char_regex",{"_index":3436,"name":{"4637":{}},"parent":{}}],["convert",{"_index":2169,"name":{"2795":{}},"parent":{}}],["convertalctozosmf",{"_index":3588,"name":{"4840":{}},"parent":{}}],["convertapimlprofileinfotoprofileconfig",{"_index":54,"name":{"41":{}},"parent":{}}],["convertprofilesdefinition",{"_index":2620,"name":{"3524":{}},"parent":{}}],["convertprofileshandler",{"_index":2640,"name":{"3568":{}},"parent":{}}],["convertpropnames",{"_index":2170,"name":{"2796":{}},"parent":{}}],["cookie",{"_index":1120,"name":{"1306":{}},"parent":{}}],["cookie_authorization",{"_index":1119,"name":{"1305":{}},"parent":{}}],["copy",{"_index":3584,"name":{"4836":{}},"parent":{}}],["correlator",{"_index":3645,"name":{"4916":{},"4934":{},"4966":{},"5050":{}},"parent":{}}],["couldnotinstantiatecommandhandler",{"_index":1481,"name":{"1746":{}},"parent":{}}],["count",{"_index":3679,"name":{"4964":{},"4965":{},"5069":{},"5819":{},"5820":{}},"parent":{}}],["countoutcomes",{"_index":2518,"name":{"3265":{}},"parent":{}}],["cpcname",{"_index":4365,"name":{"6064":{}},"parent":{}}],["cpcserial",{"_index":4357,"name":{"6055":{}},"parent":{}}],["crashinteamconfigmode",{"_index":2417,"name":{"3087":{}},"parent":{}}],["create",{"_index":586,"name":{"595":{},"3916":{},"3920":{},"4645":{}},"parent":{}}],["create_action",{"_index":505,"name":{"505":{}},"parent":{}}],["created",{"_index":2906,"name":{"3949":{},"3951":{}},"parent":{}}],["createdatasettypeenum",{"_index":3392,"name":{"4575":{}},"parent":{}}],["createdefaults",{"_index":3375,"name":{"4528":{}},"parent":{}}],["createdirssync",{"_index":384,"name":{"380":{}},"parent":{}}],["createdirssyncfromfilepath",{"_index":385,"name":{"381":{}},"parent":{}}],["createdirsync",{"_index":383,"name":{"379":{}},"parent":{}}],["createfile",{"_index":937,"name":{"1023":{},"1100":{}},"parent":{}}],["createfilesync",{"_index":393,"name":{"389":{}},"parent":{}}],["createfromurl",{"_index":1097,"name":{"1254":{}},"parent":{}}],["createpluginhooks",{"_index":2724,"name":{"3657":{}},"parent":{}}],["createprofilecommanddesc",{"_index":1503,"name":{"1768":{}},"parent":{}}],["createprofiledirs",{"_index":2410,"name":{"3077":{}},"parent":{}}],["createprofiledisabledefaultsdesc",{"_index":1525,"name":{"1790":{}},"parent":{}}],["createprofileexamples",{"_index":276,"name":{"283":{},"2054":{},"5338":{},"5568":{},"6199":{}},"parent":{}}],["createprofilefromargumentshandler",{"_index":1743,"name":{"2052":{}},"parent":{}}],["createprofilefromcommandarguments",{"_index":1954,"name":{"2391":{}},"parent":{}}],["createprofileoptiondesc",{"_index":1505,"name":{"1770":{}},"parent":{}}],["createprofileoptionoverwritedesc",{"_index":1523,"name":{"1788":{}},"parent":{}}],["createprofilescommanddesc",{"_index":1501,"name":{"1766":{}},"parent":{}}],["createprofilescommandsummary",{"_index":1499,"name":{"1764":{}},"parent":{}}],["createprofileshandler",{"_index":2759,"name":{"3760":{}},"parent":{}}],["createprofiletypedirectory",{"_index":2433,"name":{"3145":{}},"parent":{}}],["createreadstream",{"_index":389,"name":{"385":{}},"parent":{}}],["createresponse",{"_index":4014,"name":{"5434":{}},"parent":{}}],["createsesscfg",{"_index":1237,"name":{"1475":{}},"parent":{}}],["createsesscfgfromargs",{"_index":1250,"name":{"1488":{},"2774":{},"2779":{},"6136":{}},"parent":{}}],["createsession",{"_index":2278,"name":{"2929":{}},"parent":{}}],["createsshsesscfgfromargs",{"_index":4045,"name":{"5499":{}},"parent":{}}],["createsymlinktodir",{"_index":386,"name":{"382":{}},"parent":{}}],["createworkflow",{"_index":4148,"name":{"5655":{},"5657":{}},"parent":{}}],["createworkflowlocal",{"_index":4150,"name":{"5658":{}},"parent":{}}],["createwritestream",{"_index":390,"name":{"386":{}},"parent":{}}],["cred_mgr_setting_name",{"_index":699,"name":{"750":{}},"parent":{}}],["credentialmanagerfactory",{"_index":685,"name":{"737":{}},"parent":{}}],["credentialmanageroverride",{"_index":698,"name":{"749":{}},"parent":{}}],["credmgrdisplayname",{"_index":690,"name":{"743":{}},"parent":{}}],["credmgroverride",{"_index":2177,"name":{"2802":{}},"parent":{}}],["credmgrpluginname",{"_index":692,"name":{"744":{}},"parent":{}}],["credmgrzename",{"_index":693,"name":{"745":{}},"parent":{}}],["critical",{"_index":963,"name":{"1049":{}},"parent":{}}],["csrf",{"_index":117,"name":{"89":{}},"parent":{}}],["currentnodeid",{"_index":2792,"name":{"3816":{}},"parent":{}}],["currentstepname",{"_index":4258,"name":{"5802":{}},"parent":{}}],["currentstepnumber",{"_index":4259,"name":{"5803":{}},"parent":{}}],["currentsteptitle",{"_index":4260,"name":{"5804":{}},"parent":{}}],["currentview",{"_index":2793,"name":{"3817":{}},"parent":{}}],["customhelpgenerator",{"_index":2328,"name":{"2981":{}},"parent":{}}],["customize",{"_index":842,"name":{"926":{}},"parent":{}}],["customize_plan_key",{"_index":2512,"name":{"3259":{}},"parent":{}}],["cwd",{"_index":578,"name":{"586":{}},"parent":{}}],["cylspri",{"_index":3372,"name":{"4520":{}},"parent":{}}],["cylssec",{"_index":3373,"name":{"4521":{}},"parent":{}}],["daemoncontext",{"_index":1780,"name":{"2105":{},"3028":{}},"parent":{}}],["daemonmode",{"_index":2343,"name":{"3005":{}},"parent":{}}],["daemonrequest",{"_index":582,"name":{"591":{}},"parent":{}}],["data",{"_index":122,"name":{"91":{},"93":{},"95":{},"97":{},"1121":{},"1275":{},"1375":{},"1434":{},"1914":{},"1984":{},"3366":{},"3956":{},"3957":{},"4107":{},"4109":{},"4462":{},"4913":{},"5080":{},"5342":{},"5351":{},"5361":{},"5532":{},"6148":{}},"parent":{}}],["data_set",{"_index":3376,"name":{"4529":{}},"parent":{}}],["data_set_binary",{"_index":3393,"name":{"4576":{}},"parent":{}}],["data_set_blank",{"_index":3399,"name":{"4581":{}},"parent":{}}],["data_set_c",{"_index":3395,"name":{"4577":{}},"parent":{}}],["data_set_classic",{"_index":3396,"name":{"4578":{}},"parent":{}}],["data_set_partitioned",{"_index":3397,"name":{"4579":{}},"parent":{}}],["data_set_sequential",{"_index":3398,"name":{"4580":{}},"parent":{}}],["dataclass",{"_index":3359,"name":{"4494":{},"4511":{},"4524":{}},"parent":{}}],["dataset",{"_index":3439,"name":{"4639":{},"4646":{},"4669":{},"4675":{},"4754":{},"4766":{},"4820":{},"4832":{},"4837":{},"4854":{},"4860":{},"4870":{}},"parent":{}}],["datasetallocatelikenotfound",{"_index":3305,"name":{"4419":{}},"parent":{}}],["datasetcopiedaborted",{"_index":3297,"name":{"4411":{}},"parent":{}}],["datasetcopiedabortednopds",{"_index":3301,"name":{"4415":{}},"parent":{}}],["datasetcopiedabortednotargetds",{"_index":3295,"name":{"4409":{}},"parent":{}}],["datasetcopiedabortedtargetnotpdsmember",{"_index":3303,"name":{"4417":{}},"parent":{}}],["datasetcopiedsuccessfully",{"_index":3293,"name":{"4407":{}},"parent":{}}],["datasetcreatedsuccessfully",{"_index":3167,"name":{"4281":{}},"parent":{}}],["datasetcrosslpar",{"_index":3586,"name":{"4838":{}},"parent":{}}],["datasetdeletedsuccessfully",{"_index":3169,"name":{"4283":{}},"parent":{}}],["datasetdeletionrequested",{"_index":3287,"name":{"4401":{}},"parent":{}}],["datasetdownloadedsuccessfully",{"_index":3171,"name":{"4285":{}},"parent":{}}],["datasetdownloadedwithdestination",{"_index":3173,"name":{"4287":{}},"parent":{}}],["datasetdownloadfailed",{"_index":3309,"name":{"4423":{}},"parent":{}}],["datasetlike",{"_index":3445,"name":{"4647":{}},"parent":{}}],["datasetmember",{"_index":3608,"name":{"4871":{}},"parent":{}}],["datasetmembercopiedaborted",{"_index":3299,"name":{"4413":{}},"parent":{}}],["datasetmigrationrequested",{"_index":3289,"name":{"4403":{}},"parent":{}}],["datasetrecalledsuccessfully",{"_index":3283,"name":{"4397":{}},"parent":{}}],["datasetrecallrequested",{"_index":3291,"name":{"4405":{}},"parent":{}}],["datasetrenamedsuccessfully",{"_index":3285,"name":{"4399":{}},"parent":{}}],["datasetsdownloadedsuccessfully",{"_index":3185,"name":{"4299":{}},"parent":{}}],["datasetsmatchedpattern",{"_index":3187,"name":{"4301":{}},"parent":{}}],["datasetsmatchingpattern",{"_index":3443,"name":{"4643":{}},"parent":{}}],["datasetuploadedsuccessfully",{"_index":3189,"name":{"4303":{}},"parent":{}}],["datasetvalidateoptions",{"_index":3446,"name":{"4648":{}},"parent":{}}],["datastring",{"_index":1102,"name":{"1276":{},"1376":{},"1435":{},"4463":{}},"parent":{}}],["datatoreturn",{"_index":1034,"name":{"1167":{},"4451":{}},"parent":{}}],["datatype",{"_index":2198,"name":{"2827":{}},"parent":{}}],["ddname",{"_index":3680,"name":{"4969":{},"5067":{},"5077":{},"5818":{}},"parent":{}}],["debug",{"_index":410,"name":{"405":{},"434":{},"3425":{}},"parent":{}}],["decimalplaces",{"_index":4212,"name":{"5734":{}},"parent":{}}],["decompressbuffer",{"_index":1139,"name":{"1334":{}},"parent":{}}],["decompresserror",{"_index":1142,"name":{"1336":{}},"parent":{}}],["decompressstream",{"_index":1141,"name":{"1335":{}},"parent":{}}],["decreasecounter",{"_index":3058,"name":{"4174":{}},"parent":{}}],["default",{"_index":1016,"name":{"1141":{},"1580":{},"2807":{},"5735":{}},"parent":{}}],["default_app_name",{"_index":2579,"name":{"3409":{}},"parent":{}}],["default_attempts",{"_index":3765,"name":{"5099":{}},"parent":{}}],["default_backend",{"_index":1326,"name":{"1579":{}},"parent":{}}],["default_base_path",{"_index":1084,"name":{"1238":{},"1262":{}},"parent":{}}],["default_cancel_version",{"_index":3627,"name":{"4893":{}},"parent":{}}],["default_chset",{"_index":3864,"name":{"5205":{}},"parent":{}}],["default_color_layout",{"_index":1324,"name":{"1577":{}},"parent":{}}],["default_cols",{"_index":3867,"name":{"5208":{}},"parent":{}}],["default_console_name",{"_index":2580,"name":{"3410":{}},"parent":{}}],["default_cpage",{"_index":3865,"name":{"5206":{}},"parent":{}}],["default_cred_mgr_name",{"_index":701,"name":{"751":{}},"parent":{}}],["default_debug_file",{"_index":2120,"name":{"2722":{}},"parent":{}}],["default_experimental_command_explanation",{"_index":482,"name":{"482":{}},"parent":{}}],["default_file_extension",{"_index":3468,"name":{"4678":{}},"parent":{}}],["default_followup_attempts",{"_index":3048,"name":{"4164":{}},"parent":{}}],["default_highlight_color",{"_index":523,"name":{"523":{}},"parent":{}}],["default_http_port",{"_index":1081,"name":{"1235":{},"1259":{}},"parent":{}}],["default_https_port",{"_index":1082,"name":{"1236":{},"1260":{}},"parent":{}}],["default_imperative_name",{"_index":2577,"name":{"3408":{}},"parent":{}}],["default_jobs_output_dir",{"_index":3812,"name":{"5147":{}},"parent":{}}],["default_jobs_output_file_ext",{"_index":3814,"name":{"5148":{}},"parent":{}}],["default_lang",{"_index":1319,"name":{"1573":{}},"parent":{}}],["default_list_group",{"_index":490,"name":{"490":{}},"parent":{}}],["default_list_profile_object",{"_index":488,"name":{"488":{}},"parent":{}}],["default_list_profile_object_alias",{"_index":489,"name":{"489":{}},"parent":{}}],["default_log_dir",{"_index":1327,"name":{"1581":{}},"parent":{}}],["default_log_file_backups",{"_index":1331,"name":{"1585":{}},"parent":{}}],["default_log_file_dir",{"_index":1328,"name":{"1582":{}},"parent":{}}],["default_log_file_ext",{"_index":1329,"name":{"1583":{}},"parent":{}}],["default_log_file_max_size",{"_index":1330,"name":{"1584":{}},"parent":{}}],["default_log_layout",{"_index":1323,"name":{"1576":{}},"parent":{}}],["default_log_type_console",{"_index":1321,"name":{"1574":{}},"parent":{}}],["default_log_type_file_sync",{"_index":1325,"name":{"1578":{}},"parent":{}}],["default_log_type_pat",{"_index":1322,"name":{"1575":{}},"parent":{}}],["default_mask_output",{"_index":525,"name":{"525":{}},"parent":{}}],["default_max_jobs",{"_index":3621,"name":{"4886":{}},"parent":{}}],["default_max_queue_size",{"_index":446,"name":{"447":{}},"parent":{}}],["default_port",{"_index":1083,"name":{"1237":{},"1261":{}},"parent":{}}],["default_prefix",{"_index":3620,"name":{"4885":{}},"parent":{}}],["default_proc",{"_index":3869,"name":{"5210":{}},"parent":{}}],["default_prompt_phrase",{"_index":524,"name":{"524":{}},"parent":{}}],["default_protocol",{"_index":1079,"name":{"1233":{},"1257":{}},"parent":{}}],["default_reject_unauthorized_setting",{"_index":1085,"name":{"1239":{},"1263":{}},"parent":{}}],["default_rows",{"_index":3866,"name":{"5207":{}},"parent":{}}],["default_rsize",{"_index":3868,"name":{"5209":{}},"parent":{}}],["default_secure_protocol",{"_index":1087,"name":{"1241":{},"1265":{}},"parent":{}}],["default_set_group",{"_index":487,"name":{"487":{}},"parent":{}}],["default_set_profile_object",{"_index":485,"name":{"485":{}},"parent":{}}],["default_set_profile_object_alias",{"_index":486,"name":{"486":{}},"parent":{}}],["default_ssh_port",{"_index":4025,"name":{"5448":{}},"parent":{}}],["default_status",{"_index":3622,"name":{"4887":{},"5098":{}},"parent":{}}],["default_strict_ssl",{"_index":1086,"name":{"1240":{},"1264":{}},"parent":{}}],["default_timeout",{"_index":3049,"name":{"4165":{}},"parent":{}}],["default_type",{"_index":1080,"name":{"1234":{},"1258":{}},"parent":{}}],["default_valid_log_levels",{"_index":2581,"name":{"3411":{}},"parent":{}}],["default_watch_delay",{"_index":3763,"name":{"5097":{}},"parent":{}}],["default_wrap_width",{"_index":333,"name":{"333":{}},"parent":{}}],["defaultapi",{"_index":28,"name":{"20":{}},"parent":{}}],["defaultauthgroup",{"_index":2080,"name":{"2633":{}},"parent":{}}],["defaultbaseprofilename",{"_index":1263,"name":{"1499":{},"1514":{}},"parent":{}}],["defaultcleared",{"_index":2479,"name":{"3222":{}},"parent":{}}],["defaultcredentialmanager",{"_index":665,"name":{"688":{}},"parent":{}}],["defaultcredmgrwithkeytar",{"_index":2311,"name":{"2965":{}},"parent":{}}],["defaultget",{"_index":643,"name":{"659":{}},"parent":{}}],["defaulthelpgenerator",{"_index":1815,"name":{"2144":{}},"parent":{}}],["defaulthome",{"_index":2329,"name":{"2983":{}},"parent":{}}],["defaultlogingroup",{"_index":2082,"name":{"2638":{}},"parent":{}}],["defaultlogoutgroup",{"_index":2084,"name":{"2645":{}},"parent":{}}],["defaultprofile",{"_index":2404,"name":{"3073":{}},"parent":{}}],["defaultprofilename",{"_index":1258,"name":{"1495":{},"1504":{},"1519":{}},"parent":{}}],["defaultrootcommandhandler",{"_index":2721,"name":{"3654":{}},"parent":{}}],["defaults",{"_index":601,"name":{"611":{},"1536":{}},"parent":{}}],["defaultservice",{"_index":672,"name":{"700":{}},"parent":{}}],["defaultset",{"_index":642,"name":{"658":{}},"parent":{}}],["defaulttokentype",{"_index":1215,"name":{"1450":{}},"parent":{}}],["defaultvalue",{"_index":201,"name":{"169":{},"874":{},"1947":{},"2664":{},"2671":{},"2692":{},"2700":{},"5269":{},"5276":{},"5283":{},"5290":{},"5297":{},"5303":{},"5464":{},"6025":{},"6085":{},"6108":{},"6120":{}},"parent":{}}],["define",{"_index":2022,"name":{"2491":{}},"parent":{}}],["definecommands",{"_index":2130,"name":{"2745":{}},"parent":{}}],["definecommandtoyargs",{"_index":1898,"name":{"2275":{},"2299":{},"2360":{}},"parent":{}}],["defineoperations",{"_index":976,"name":{"1073":{}},"parent":{}}],["defineoptionstoyargs",{"_index":1896,"name":{"2274":{}},"parent":{}}],["definition",{"_index":1007,"name":{"1132":{},"1929":{},"2012":{},"2084":{},"2096":{},"2250":{},"2289":{},"2311":{},"2356":{},"3911":{}},"parent":{}}],["definitions",{"_index":2326,"name":{"2979":{}},"parent":{}}],["definitiontreeresolver",{"_index":1313,"name":{"1567":{}},"parent":{}}],["definitionworkflow",{"_index":4230,"name":{"5764":{}},"parent":{}}],["delete",{"_index":653,"name":{"673":{},"708":{},"732":{},"850":{},"2416":{},"3121":{},"3295":{},"4853":{}},"parent":{}}],["delete_action",{"_index":513,"name":{"513":{}},"parent":{}}],["deleteallfilesmarkedforundo",{"_index":940,"name":{"1026":{}},"parent":{}}],["deletecompletedjobs",{"_index":4140,"name":{"5639":{},"5916":{}},"parent":{}}],["deletecredentials",{"_index":656,"name":{"678":{},"697":{},"727":{}},"parent":{}}],["deletecredentialshelper",{"_index":676,"name":{"704":{}},"parent":{}}],["deletedeprovisionedinstance",{"_index":2835,"name":{"3858":{}},"parent":{}}],["deletedir",{"_index":399,"name":{"395":{}},"parent":{}}],["deletedirtree",{"_index":400,"name":{"396":{}},"parent":{}}],["deleteexpectbuffer",{"_index":1187,"name":{"1390":{}},"parent":{}}],["deleteexpectfullresponse",{"_index":1200,"name":{"1403":{}},"parent":{}}],["deleteexpectjson",{"_index":1183,"name":{"1386":{}},"parent":{}}],["deleteexpectstring",{"_index":1191,"name":{"1394":{}},"parent":{}}],["deletefile",{"_index":398,"name":{"394":{}},"parent":{}}],["deleteinstance",{"_index":2834,"name":{"3857":{}},"parent":{}}],["deletejob",{"_index":3668,"name":{"4948":{}},"parent":{}}],["deletejobcommon",{"_index":3671,"name":{"4950":{}},"parent":{}}],["deletejobforjob",{"_index":3670,"name":{"4949":{}},"parent":{}}],["deletejobs",{"_index":3667,"name":{"4947":{}},"parent":{}}],["deleteoldsecureprops",{"_index":2648,"name":{"3578":{}},"parent":{}}],["deleteprofile",{"_index":1947,"name":{"2384":{},"3080":{},"3129":{},"3272":{}},"parent":{}}],["deleteprofileactiondesc",{"_index":1533,"name":{"1798":{}},"parent":{}}],["deleteprofilecommanddesc",{"_index":1535,"name":{"1800":{}},"parent":{}}],["deleteprofiledepsdesc",{"_index":1537,"name":{"1802":{}},"parent":{}}],["deleteprofileexample",{"_index":1517,"name":{"1782":{}},"parent":{}}],["deleteprofileforceoptiondesc",{"_index":1531,"name":{"1796":{}},"parent":{}}],["deleteprofilefromdisk",{"_index":1975,"name":{"2421":{},"3133":{},"3300":{}},"parent":{}}],["deleteprofilenamedesc",{"_index":1515,"name":{"1780":{}},"parent":{}}],["deleteprofilescommanddesc",{"_index":1529,"name":{"1794":{}},"parent":{}}],["deleteprofilescommandsummary",{"_index":1527,"name":{"1792":{}},"parent":{}}],["deletestreamed",{"_index":1197,"name":{"1400":{}},"parent":{}}],["deletesymlink",{"_index":401,"name":{"397":{}},"parent":{}}],["deletetempfile",{"_index":4153,"name":{"5661":{}},"parent":{}}],["deleteworkflow",{"_index":4233,"name":{"5766":{},"5767":{}},"parent":{}}],["dependencies",{"_index":565,"name":{"575":{},"2059":{},"2431":{}},"parent":{}}],["dependenciesloaded",{"_index":1988,"name":{"2439":{}},"parent":{}}],["dependencyloadresponses",{"_index":1989,"name":{"2440":{}},"parent":{}}],["dependenttasks",{"_index":2493,"name":{"3241":{}},"parent":{}}],["deprecate_to_config_edit",{"_index":554,"name":{"552":{}},"parent":{}}],["deprecate_to_config_init",{"_index":552,"name":{"550":{}},"parent":{}}],["deprecate_to_config_list",{"_index":553,"name":{"551":{}},"parent":{}}],["deprecate_to_config_set",{"_index":555,"name":{"553":{}},"parent":{}}],["deprecatedreplacement",{"_index":834,"name":{"916":{}},"parent":{}}],["deprovision",{"_index":2873,"name":{"3906":{}},"parent":{}}],["depth",{"_index":742,"name":{"797":{},"4611":{}},"parent":{}}],["description",{"_index":46,"name":{"34":{},"143":{},"149":{},"155":{},"161":{},"167":{},"174":{},"180":{},"185":{},"190":{},"195":{},"198":{},"201":{},"204":{},"209":{},"212":{},"215":{},"218":{},"225":{},"228":{},"233":{},"236":{},"246":{},"562":{},"571":{},"786":{},"860":{},"871":{},"891":{},"909":{},"1143":{},"1938":{},"1944":{},"1952":{},"2635":{},"2640":{},"2647":{},"2662":{},"2669":{},"2676":{},"2683":{},"2690":{},"2698":{},"3237":{},"3330":{},"3455":{},"3463":{},"3473":{},"3481":{},"3488":{},"3495":{},"3503":{},"3512":{},"3520":{},"3530":{},"3539":{},"3546":{},"3669":{},"3683":{},"3694":{},"3706":{},"3718":{},"3864":{},"3932":{},"4015":{},"4037":{},"5258":{},"5267":{},"5274":{},"5281":{},"5288":{},"5295":{},"5301":{},"5311":{},"5454":{},"5462":{},"5469":{},"5477":{},"5483":{},"5489":{},"5495":{},"5540":{},"5675":{},"5736":{},"5840":{},"5947":{},"6023":{},"6075":{},"6083":{},"6090":{},"6098":{},"6106":{},"6113":{},"6118":{},"6127":{},"6132":{},"6156":{},"6193":{}},"parent":{}}],["destroypluginhooks",{"_index":2726,"name":{"3658":{}},"parent":{}}],["detailprofilecommanddesc",{"_index":1557,"name":{"1822":{}},"parent":{}}],["details",{"_index":681,"name":{"717":{},"1325":{},"2864":{},"3444":{},"3732":{},"3743":{},"3781":{},"3792":{}},"parent":{}}],["details_action",{"_index":514,"name":{"514":{}},"parent":{}}],["detect",{"_index":2878,"name":{"3910":{}},"parent":{}}],["detected",{"_index":3016,"name":{"4121":{},"4132":{}},"parent":{}}],["detectprobval",{"_index":2699,"name":{"3631":{}},"parent":{}}],["dev",{"_index":3424,"name":{"4620":{}},"parent":{}}],["dfsmshsmcommand",{"_index":3479,"name":{"4689":{}},"parent":{}}],["diffutils",{"_index":2399,"name":{"3069":{}},"parent":{}}],["dimgrey",{"_index":1813,"name":{"2142":{},"2185":{}},"parent":{}}],["dirblk",{"_index":3354,"name":{"4487":{},"4534":{},"4552":{},"4560":{},"4568":{}},"parent":{}}],["direction",{"_index":3836,"name":{"5176":{}},"parent":{}}],["directory",{"_index":3506,"name":{"4721":{},"5044":{}},"parent":{}}],["directsave",{"_index":722,"name":{"772":{}},"parent":{}}],["dirname",{"_index":3538,"name":{"4769":{}},"parent":{}}],["dirtopds",{"_index":3558,"name":{"4803":{}},"parent":{}}],["dirtoussdir",{"_index":3565,"name":{"4810":{}},"parent":{}}],["dirtoussdirrecursive",{"_index":3567,"name":{"4812":{}},"parent":{}}],["disable_defaults_option",{"_index":512,"name":{"512":{}},"parent":{}}],["disabledefaults",{"_index":2460,"name":{"3184":{},"3192":{}},"parent":{}}],["displayautoinitchanges",{"_index":2155,"name":{"2782":{}},"parent":{}}],["displaycollecterror",{"_index":3056,"name":{"4172":{}},"parent":{}}],["displaycollectresponse",{"_index":3054,"name":{"4170":{}},"parent":{}}],["displayenvitem",{"_index":2711,"name":{"3643":{}},"parent":{}}],["displayenvreport",{"_index":2710,"name":{"3642":{}},"parent":{}}],["displayerror",{"_index":3052,"name":{"4168":{}},"parent":{}}],["displayname",{"_index":652,"name":{"671":{},"686":{}},"parent":{}}],["displaypluginissues",{"_index":2752,"name":{"3726":{}},"parent":{}}],["displayresponse",{"_index":3050,"name":{"4166":{}},"parent":{}}],["disposition",{"_index":2905,"name":{"3948":{}},"parent":{}}],["diverge",{"_index":955,"name":{"1041":{}},"parent":{}}],["divergeto",{"_index":956,"name":{"1042":{}},"parent":{}}],["divider",{"_index":2693,"name":{"3625":{}},"parent":{}}],["doautoinit",{"_index":2154,"name":{"2781":{}},"parent":{}}],["documentationurl",{"_index":25,"name":{"17":{}},"parent":{}}],["doespluginhaveissuesev",{"_index":1408,"name":{"1664":{}},"parent":{}}],["dologin",{"_index":2145,"name":{"2759":{}},"parent":{}}],["dologout",{"_index":2146,"name":{"2760":{}},"parent":{}}],["domain",{"_index":2843,"name":{"3867":{},"3960":{},"3961":{},"4040":{},"4105":{}},"parent":{}}],["domainid",{"_index":4294,"name":{"5924":{}},"parent":{}}],["doprompting",{"_index":1214,"name":{"1449":{}},"parent":{}}],["doprovisioningactioncommon",{"_index":2979,"name":{"4063":{}},"parent":{}}],["download",{"_index":3526,"name":{"4753":{}},"parent":{}}],["downloadallspoolcontentcommon",{"_index":3816,"name":{"5150":{}},"parent":{}}],["downloaded",{"_index":3516,"name":{"4743":{},"4749":{}},"parent":{}}],["downloadjobs",{"_index":3811,"name":{"5146":{}},"parent":{}}],["downloadschema",{"_index":2654,"name":{"3586":{}},"parent":{}}],["downloadspoolcontent",{"_index":3815,"name":{"5149":{}},"parent":{}}],["downloadspoolcontentcommon",{"_index":3817,"name":{"5151":{}},"parent":{}}],["dsn",{"_index":3322,"name":{"4436":{}},"parent":{}}],["dsn_sep",{"_index":3466,"name":{"4677":{}},"parent":{}}],["dsname",{"_index":3419,"name":{"4616":{}},"parent":{}}],["dsntp",{"_index":3425,"name":{"4621":{}},"parent":{}}],["dsntype",{"_index":3360,"name":{"4495":{}},"parent":{}}],["dsorg",{"_index":3350,"name":{"4483":{},"4504":{},"4532":{},"4540":{},"4547":{},"4554":{},"4562":{},"4572":{},"4622":{}},"parent":{}}],["dumpqueuedmessages",{"_index":459,"name":{"461":{}},"parent":{}}],["edate",{"_index":3426,"name":{"4623":{}},"parent":{}}],["editdefinition",{"_index":2616,"name":{"3507":{}},"parent":{}}],["edithandler",{"_index":2649,"name":{"3579":{}},"parent":{}}],["eighty_percent",{"_index":898,"name":{"980":{}},"parent":{}}],["email",{"_index":2898,"name":{"3937":{}},"parent":{}}],["empty",{"_index":774,"name":{"831":{}},"parent":{}}],["emptydownloaddsmresult",{"_index":3531,"name":{"4759":{}},"parent":{}}],["emptydownloadussdirresult",{"_index":3532,"name":{"4760":{}},"parent":{}}],["emptyvalueerror",{"_index":1738,"name":{"2047":{}},"parent":{}}],["enablestdin",{"_index":832,"name":{"914":{}},"parent":{}}],["encoding",{"_index":160,"name":{"119":{},"4443":{},"4660":{},"4729":{},"4790":{},"6188":{}},"parent":{}}],["end_of_team_config",{"_index":757,"name":{"811":{}},"parent":{}}],["end_of_user_config",{"_index":759,"name":{"812":{}},"parent":{}}],["endbar",{"_index":989,"name":{"1109":{}},"parent":{}}],["endingconfig",{"_index":77,"name":{"63":{}},"parent":{}}],["endprogressbar",{"_index":1653,"name":{"1924":{},"1995":{}},"parent":{}}],["endstream",{"_index":1695,"name":{"1996":{}},"parent":{}}],["enq",{"_index":3574,"name":{"4821":{},"4833":{}},"parent":{}}],["ensurecredentialmanagerloaded",{"_index":2056,"name":{"2589":{}},"parent":{}}],["ensurereadfromdisk",{"_index":2288,"name":{"2939":{}},"parent":{}}],["env",{"_index":579,"name":{"587":{},"2806":{}},"parent":{}}],["env_show_secure_suffix",{"_index":1867,"name":{"2229":{}},"parent":{}}],["env_var_prefix",{"_index":2361,"name":{"3035":{}},"parent":{}}],["envfileutils",{"_index":2111,"name":{"2714":{}},"parent":{}}],["environmentalvariablesettings",{"_index":535,"name":{"535":{}},"parent":{}}],["environmentjson",{"_index":2112,"name":{"2715":{}},"parent":{}}],["envquery",{"_index":2692,"name":{"3624":{}},"parent":{}}],["envvariableprefix",{"_index":1779,"name":{"2101":{},"2245":{},"2284":{},"2306":{},"2331":{},"2351":{},"2472":{},"2733":{},"2984":{},"3017":{}},"parent":{}}],["eolmatch",{"_index":2695,"name":{"3627":{}},"parent":{}}],["eow_delimiter",{"_index":583,"name":{"592":{}},"parent":{}}],["eqpackagemetadata",{"_index":1863,"name":{"2225":{}},"parent":{}}],["erase",{"_index":3592,"name":{"4845":{}},"parent":{}}],["errno",{"_index":1044,"name":{"1177":{}},"parent":{}}],["error",{"_index":413,"name":{"408":{},"436":{},"948":{},"1915":{},"3428":{},"3450":{},"4025":{},"4799":{}},"parent":{}}],["error_codes",{"_index":4319,"name":{"6014":{}},"parent":{}}],["error_exit_code",{"_index":476,"name":{"476":{}},"parent":{}}],["error_id",{"_index":2418,"name":{"3088":{}},"parent":{}}],["error_tag",{"_index":354,"name":{"353":{},"2146":{},"2230":{}},"parent":{}}],["errorcode",{"_index":311,"name":{"314":{},"718":{},"1192":{},"1328":{},"2865":{},"3445":{},"3733":{},"3744":{},"3782":{},"3793":{}},"parent":{}}],["errordetailsheader",{"_index":1483,"name":{"1748":{}},"parent":{}}],["errorheader",{"_index":864,"name":{"949":{}},"parent":{}}],["errormessage",{"_index":3344,"name":{"4478":{},"4852":{}},"parent":{}}],["errormessages",{"_index":908,"name":{"989":{},"1051":{},"1082":{}},"parent":{}}],["errorparsingattributesfile",{"_index":3255,"name":{"4369":{}},"parent":{}}],["errorreadingattributesfile",{"_index":3253,"name":{"4367":{}},"parent":{}}],["escapemarkdown",{"_index":1831,"name":{"2164":{}},"parent":{}}],["etag",{"_index":156,"name":{"117":{},"4785":{},"4800":{}},"parent":{}}],["examples",{"_index":835,"name":{"917":{},"1145":{},"3467":{},"3475":{},"3482":{},"3489":{},"3497":{},"3506":{},"3514":{},"3523":{},"3532":{},"3540":{},"3550":{},"3673":{},"3686":{},"3697":{},"3710":{},"3722":{}},"parent":{}}],["excludegloballayer",{"_index":755,"name":{"808":{}},"parent":{}}],["excludehomedir",{"_index":2240,"name":{"2888":{}},"parent":{}}],["excludepatterns",{"_index":3403,"name":{"4585":{},"4735":{}},"parent":{}}],["exec_data",{"_index":3630,"name":{"4896":{}},"parent":{}}],["execandcheckoutput",{"_index":2380,"name":{"3050":{}},"parent":{}}],["execdata",{"_index":3701,"name":{"4999":{}},"parent":{}}],["execute",{"_index":933,"name":{"1019":{},"1069":{}},"parent":{}}],["executehelp",{"_index":1910,"name":{"2295":{},"2317":{},"2363":{}},"parent":{}}],["executenextoperation",{"_index":977,"name":{"1074":{}},"parent":{}}],["executenextundo",{"_index":979,"name":{"1076":{}},"parent":{}}],["executeoperation",{"_index":918,"name":{"1003":{},"1062":{}},"parent":{}}],["executessh",{"_index":4063,"name":{"5519":{}},"parent":{}}],["executesshcwd",{"_index":4064,"name":{"5520":{}},"parent":{}}],["executewebhelp",{"_index":1912,"name":{"2297":{},"2319":{},"2365":{}},"parent":{}}],["executils",{"_index":370,"name":{"368":{}},"parent":{}}],["exists",{"_index":609,"name":{"619":{},"657":{},"837":{},"3081":{}},"parent":{}}],["existssync",{"_index":382,"name":{"378":{}},"parent":{}}],["exitcode",{"_index":568,"name":{"578":{},"1910":{},"2267":{}},"parent":{}}],["expandpath",{"_index":644,"name":{"660":{}},"parent":{}}],["expectandtransform",{"_index":356,"name":{"354":{}},"parent":{}}],["expectedstatuscode",{"_index":4179,"name":{"5690":{},"5841":{},"5948":{}},"parent":{}}],["experimental",{"_index":843,"name":{"927":{}},"parent":{}}],["experimentalcommanddescription",{"_index":1922,"name":{"2328":{},"2469":{},"3001":{}},"parent":{}}],["experimentalcommandsdescription",{"_index":1788,"name":{"2112":{}},"parent":{}}],["expiredpassword",{"_index":4056,"name":{"5513":{}},"parent":{}}],["expiredpasswordflag",{"_index":4062,"name":{"5518":{}},"parent":{}}],["explainactionresponse",{"_index":2976,"name":{"4057":{}},"parent":{}}],["explainatcreatevariable",{"_index":2867,"name":{"3898":{}},"parent":{}}],["explainedparentkey",{"_index":329,"name":{"330":{},"1537":{},"1539":{},"3870":{},"3873":{},"3879":{},"3883":{},"3893":{},"3896":{},"3899":{},"3921":{},"3924":{},"3971":{},"3973":{},"3977":{},"3981":{},"3985":{},"4000":{},"4004":{},"4028":{},"4031":{},"4046":{},"4050":{},"4060":{},"4072":{},"4083":{},"4096":{}},"parent":{}}],["explainobject",{"_index":338,"name":{"337":{}},"parent":{}}],["explainpromptvariable",{"_index":2865,"name":{"3895":{}},"parent":{}}],["explainpromptvariablefull",{"_index":2963,"name":{"4029":{}},"parent":{}}],["explainpromptvariablesummary",{"_index":2961,"name":{"4026":{}},"parent":{}}],["explainprovisionedinstanceactionsfull",{"_index":2888,"name":{"3917":{}},"parent":{}}],["explainprovisionedinstanceactionssummary",{"_index":2890,"name":{"3923":{}},"parent":{}}],["explainprovisionedinstanceextended",{"_index":2925,"name":{"3980":{}},"parent":{}}],["explainprovisionedinstancefull",{"_index":2927,"name":{"3984":{}},"parent":{}}],["explainprovisionedinstancesfull",{"_index":2943,"name":{"4002":{}},"parent":{}}],["explainprovisionedinstancessummary",{"_index":2941,"name":{"3998":{}},"parent":{}}],["explainprovisionedinstancesummary",{"_index":2919,"name":{"3969":{}},"parent":{}}],["explainprovisionedinstancesummarywithactions",{"_index":2923,"name":{"3976":{}},"parent":{}}],["explainprovisionedinstancesummarywithvars",{"_index":2921,"name":{"3972":{}},"parent":{}}],["explainprovisionedinstancevariable",{"_index":2863,"name":{"3892":{}},"parent":{}}],["explainprovisiontemplateresponse",{"_index":2995,"name":{"4094":{}},"parent":{}}],["explainpublishedtemplatefull",{"_index":2847,"name":{"3872":{}},"parent":{}}],["explainpublishedtemplateinfofull",{"_index":2969,"name":{"4047":{}},"parent":{}}],["explainpublishedtemplateinfosummary",{"_index":2967,"name":{"4043":{}},"parent":{}}],["explainpublishedtemplatesfull",{"_index":2855,"name":{"3881":{}},"parent":{}}],["explainpublishedtemplatessummary",{"_index":2853,"name":{"3877":{}},"parent":{}}],["explainpublishedtemplatesummary",{"_index":2845,"name":{"3869":{}},"parent":{}}],["explainschemasummary",{"_index":1286,"name":{"1532":{}},"parent":{}}],["explaintemplateregistryinforesponse",{"_index":2983,"name":{"4071":{}},"parent":{}}],["explaintemplateworkflowinforesponse",{"_index":2991,"name":{"4082":{}},"parent":{}}],["explaintype",{"_index":1812,"name":{"2141":{},"2184":{}},"parent":{}}],["exposetouser",{"_index":4213,"name":{"5737":{}},"parent":{}}],["extension",{"_index":3505,"name":{"4720":{},"4957":{},"5045":{}},"parent":{}}],["extensionmap",{"_index":3511,"name":{"4736":{}},"parent":{}}],["external",{"_index":2900,"name":{"3942":{},"4069":{},"4074":{}},"parent":{}}],["extractarrayfromenvvalue",{"_index":2558,"name":{"3378":{}},"parent":{}}],["extractenvforoptions",{"_index":2557,"name":{"3377":{}},"parent":{}}],["extractexpecteddata",{"_index":1203,"name":{"1406":{}},"parent":{}}],["extx",{"_index":3427,"name":{"4624":{}},"parent":{}}],["factory",{"_index":1766,"name":{"2083":{}},"parent":{}}],["factoryparameters",{"_index":2052,"name":{"2585":{},"3351":{},"3361":{}},"parent":{}}],["fail",{"_index":856,"name":{"941":{},"5529":{},"6145":{}},"parent":{}}],["failed",{"_index":875,"name":{"959":{},"1919":{},"1987":{}},"parent":{}}],["failedarchived",{"_index":3518,"name":{"4744":{}},"parent":{}}],["failedcommandhandler",{"_index":2538,"name":{"3338":{}},"parent":{}}],["failedpattern",{"_index":4180,"name":{"5691":{},"5842":{},"5949":{}},"parent":{}}],["failedtodelete",{"_index":4146,"name":{"5653":{}},"parent":{}}],["failedtodownloaddatasets",{"_index":3245,"name":{"4359":{}},"parent":{}}],["failedunsupported",{"_index":3519,"name":{"4745":{}},"parent":{}}],["failedwitherrors",{"_index":3520,"name":{"4746":{},"4751":{}},"parent":{}}],["failfast",{"_index":3513,"name":{"4739":{}},"parent":{}}],["failnotfound",{"_index":1936,"name":{"2373":{},"2435":{},"3164":{}},"parent":{}}],["failnotfounddefaultresponse",{"_index":2435,"name":{"3147":{}},"parent":{}}],["failureresponse",{"_index":3034,"name":{"4145":{},"5369":{},"5382":{},"5387":{}},"parent":{}}],["failuresuggestions",{"_index":2510,"name":{"3257":{}},"parent":{}}],["fatal",{"_index":414,"name":{"409":{},"437":{},"3429":{}},"parent":{}}],["fetchconfig",{"_index":2653,"name":{"3585":{}},"parent":{}}],["fetchtokenforsesscfg",{"_index":1280,"name":{"1527":{}},"parent":{}}],["fields",{"_index":992,"name":{"1113":{}},"parent":{}}],["fifty_percent",{"_index":895,"name":{"977":{}},"parent":{}}],["file",{"_index":2881,"name":{"3911":{},"3912":{},"4719":{}},"parent":{}}],["file_delim",{"_index":374,"name":{"371":{}},"parent":{}}],["filelist",{"_index":3440,"name":{"4640":{}},"parent":{}}],["filename",{"_index":3543,"name":{"4773":{}},"parent":{}}],["filenames",{"_index":3546,"name":{"4776":{}},"parent":{}}],["fileoptionerror",{"_index":1717,"name":{"2025":{}},"parent":{}}],["filepath",{"_index":4097,"name":{"5591":{}},"parent":{}}],["files",{"_index":3106,"name":{"4221":{},"4915":{}},"parent":{"4222":{},"4223":{},"4224":{},"4225":{},"4226":{},"4227":{},"4228":{},"4229":{},"4230":{},"4231":{},"4232":{},"4233":{},"4234":{},"4235":{},"4236":{},"4237":{},"4238":{},"4239":{},"4240":{},"4241":{},"4242":{},"4243":{},"4244":{},"4245":{},"4246":{},"4247":{},"4248":{},"4249":{},"4250":{},"4251":{},"4252":{},"4253":{},"4254":{},"4255":{},"4256":{},"4257":{},"4258":{},"4259":{},"4260":{},"4261":{},"4262":{},"4263":{},"4264":{},"4265":{},"4266":{},"4267":{},"4268":{},"4269":{},"4270":{},"4271":{},"4272":{},"4273":{},"4274":{},"4275":{},"4276":{},"4277":{},"4278":{},"4279":{},"4280":{},"4281":{},"4282":{},"4283":{},"4284":{},"4285":{},"4286":{},"4287":{},"4288":{},"4289":{},"4290":{},"4291":{},"4292":{},"4293":{},"4294":{},"4295":{},"4296":{},"4297":{},"4298":{},"4299":{},"4300":{},"4301":{},"4302":{},"4303":{},"4304":{},"4305":{},"4306":{},"4307":{},"4308":{},"4309":{},"4310":{},"4311":{},"4312":{},"4313":{},"4314":{},"4315":{},"4316":{},"4317":{},"4318":{},"4319":{},"4320":{},"4321":{},"4322":{},"4323":{},"4324":{},"4325":{},"4326":{},"4327":{},"4328":{},"4329":{},"4330":{},"4331":{},"4332":{},"4333":{},"4334":{},"4335":{},"4336":{},"4337":{},"4338":{},"4339":{},"4340":{},"4341":{},"4342":{},"4343":{},"4344":{},"4345":{},"4346":{},"4347":{},"4348":{},"4349":{},"4350":{},"4351":{},"4352":{},"4353":{},"4354":{},"4355":{},"4356":{},"4357":{},"4358":{},"4359":{},"4360":{},"4361":{},"4362":{},"4363":{},"4364":{},"4365":{},"4366":{},"4367":{},"4368":{},"4369":{},"4370":{},"4371":{},"4372":{},"4373":{},"4374":{},"4375":{},"4376":{},"4377":{},"4378":{},"4379":{},"4380":{},"4381":{},"4382":{},"4383":{},"4384":{},"4385":{},"4386":{},"4387":{},"4388":{},"4389":{},"4390":{},"4391":{},"4392":{},"4393":{},"4394":{},"4395":{},"4396":{},"4397":{},"4398":{},"4399":{},"4400":{},"4401":{},"4402":{},"4403":{},"4404":{},"4405":{},"4406":{},"4407":{},"4408":{},"4409":{},"4410":{},"4411":{},"4412":{},"4413":{},"4414":{},"4415":{},"4416":{},"4417":{},"4418":{},"4419":{},"4420":{},"4421":{},"4422":{},"4423":{},"4424":{},"4425":{},"4426":{},"4427":{},"4428":{},"4429":{},"4430":{},"4431":{},"4432":{},"4433":{},"4434":{},"4435":{},"4436":{},"4437":{},"4438":{},"4439":{},"4440":{},"4441":{},"4442":{},"4443":{},"4444":{},"4445":{},"4446":{},"4447":{},"4448":{},"4449":{},"4450":{},"4451":{},"4452":{},"4453":{},"4454":{},"4455":{},"4456":{},"4457":{},"4458":{},"4459":{},"4460":{},"4461":{},"4462":{},"4463":{},"4464":{},"4465":{},"4466":{},"4467":{},"4468":{},"4469":{},"4470":{},"4471":{},"4472":{},"4473":{},"4474":{},"4475":{},"4476":{},"4477":{},"4478":{},"4479":{},"4480":{},"4481":{},"4482":{},"4483":{},"4484":{},"4485":{},"4486":{},"4487":{},"4488":{},"4489":{},"4490":{},"4491":{},"4492":{},"4493":{},"4494":{},"4495":{},"4496":{},"4497":{},"4498":{},"4499":{},"4500":{},"4501":{},"4502":{},"4503":{},"4504":{},"4505":{},"4506":{},"4507":{},"4508":{},"4509":{},"4510":{},"4511":{},"4512":{},"4513":{},"4514":{},"4515":{},"4516":{},"4517":{},"4518":{},"4519":{},"4520":{},"4521":{},"4522":{},"4523":{},"4524":{},"4525":{},"4526":{},"4527":{},"4528":{},"4529":{},"4530":{},"4531":{},"4532":{},"4533":{},"4534":{},"4535":{},"4536":{},"4537":{},"4538":{},"4539":{},"4540":{},"4541":{},"4542":{},"4543":{},"4544":{},"4545":{},"4546":{},"4547":{},"4548":{},"4549":{},"4550":{},"4551":{},"4552":{},"4553":{},"4554":{},"4555":{},"4556":{},"4557":{},"4558":{},"4559":{},"4560":{},"4561":{},"4562":{},"4563":{},"4564":{},"4565":{},"4566":{},"4567":{},"4568":{},"4569":{},"4570":{},"4571":{},"4572":{},"4573":{},"4574":{},"4575":{},"4576":{},"4577":{},"4578":{},"4579":{},"4580":{},"4581":{},"4582":{},"4583":{},"4584":{},"4585":{},"4586":{},"4587":{},"4588":{},"4589":{},"4590":{},"4591":{},"4592":{},"4593":{},"4594":{},"4595":{},"4596":{},"4597":{},"4598":{},"4599":{},"4600":{},"4601":{},"4602":{},"4603":{},"4604":{},"4605":{},"4606":{},"4607":{},"4608":{},"4609":{},"4610":{},"4611":{},"4612":{},"4613":{},"4614":{},"4615":{},"4616":{},"4617":{},"4618":{},"4619":{},"4620":{},"4621":{},"4622":{},"4623":{},"4624":{},"4625":{},"4626":{},"4627":{},"4628":{},"4629":{},"4630":{},"4631":{},"4632":{},"4633":{},"4634":{},"4635":{},"4636":{},"4637":{},"4638":{},"4639":{},"4640":{},"4641":{},"4642":{},"4643":{},"4644":{},"4645":{},"4646":{},"4647":{},"4648":{},"4649":{},"4650":{},"4651":{},"4652":{},"4653":{},"4654":{},"4655":{},"4656":{},"4657":{},"4658":{},"4659":{},"4660":{},"4661":{},"4662":{},"4663":{},"4664":{},"4665":{},"4666":{},"4667":{},"4668":{},"4669":{},"4670":{},"4671":{},"4672":{},"4673":{},"4674":{},"4675":{},"4676":{},"4677":{},"4678":{},"4679":{},"4680":{},"4681":{},"4682":{},"4683":{},"4684":{},"4685":{},"4686":{},"4687":{},"4688":{},"4689":{},"4690":{},"4691":{},"4692":{},"4693":{},"4694":{},"4695":{},"4696":{},"4697":{},"4698":{},"4699":{},"4700":{},"4701":{},"4702":{},"4703":{},"4704":{},"4705":{},"4706":{},"4707":{},"4708":{},"4709":{},"4710":{},"4711":{},"4712":{},"4713":{},"4714":{},"4715":{},"4716":{},"4717":{},"4718":{},"4719":{},"4720":{},"4721":{},"4722":{},"4723":{},"4724":{},"4725":{},"4726":{},"4727":{},"4728":{},"4729":{},"4730":{},"4731":{},"4732":{},"4733":{},"4734":{},"4735":{},"4736":{},"4737":{},"4738":{},"4739":{},"4740":{},"4741":{},"4742":{},"4743":{},"4744":{},"4745":{},"4746":{},"4747":{},"4748":{},"4749":{},"4750":{},"4751":{},"4752":{},"4753":{},"4754":{},"4755":{},"4756":{},"4757":{},"4758":{},"4759":{},"4760":{},"4761":{},"4762":{},"4763":{},"4764":{},"4765":{},"4766":{},"4767":{},"4768":{},"4769":{},"4770":{},"4771":{},"4772":{},"4773":{},"4774":{},"4775":{},"4776":{},"4777":{},"4778":{},"4779":{},"4780":{},"4781":{},"4782":{},"4783":{},"4784":{},"4785":{},"4786":{},"4787":{},"4788":{},"4789":{},"4790":{},"4791":{},"4792":{},"4793":{},"4794":{},"4795":{},"4796":{},"4797":{},"4798":{},"4799":{},"4800":{},"4801":{},"4802":{},"4803":{},"4804":{},"4805":{},"4806":{},"4807":{},"4808":{},"4809":{},"4810":{},"4811":{},"4812":{},"4813":{},"4814":{},"4815":{},"4816":{},"4817":{},"4818":{},"4819":{},"4820":{},"4821":{},"4822":{},"4823":{},"4824":{},"4825":{},"4826":{},"4827":{},"4828":{},"4829":{},"4830":{},"4831":{},"4832":{},"4833":{},"4834":{},"4835":{},"4836":{},"4837":{},"4838":{},"4839":{},"4840":{},"4841":{},"4842":{},"4843":{},"4844":{},"4845":{},"4846":{},"4847":{},"4848":{},"4849":{},"4850":{},"4851":{},"4852":{},"4853":{},"4854":{},"4855":{},"4856":{},"4857":{},"4858":{},"4859":{},"4860":{},"4861":{},"4862":{},"4863":{},"4864":{},"4865":{},"4866":{},"4867":{},"4868":{},"4869":{},"4870":{},"4871":{},"4872":{},"4873":{},"4874":{}}}],["fileshouldbeignored",{"_index":3498,"name":{"4712":{}},"parent":{}}],["fileshouldbeuploaded",{"_index":3497,"name":{"4711":{}},"parent":{}}],["fileskept",{"_index":4147,"name":{"5654":{}},"parent":{}}],["filesmap",{"_index":3552,"name":{"4782":{}},"parent":{}}],["filesys",{"_index":3416,"name":{"4612":{}},"parent":{}}],["filetodataset",{"_index":3556,"name":{"4802":{}},"parent":{}}],["filetoprofilename",{"_index":2414,"name":{"3083":{}},"parent":{}}],["filetoundo",{"_index":924,"name":{"1010":{},"1090":{}},"parent":{}}],["filetoussfile",{"_index":3564,"name":{"4809":{}},"parent":{}}],["filterresultsbystatuses",{"_index":3810,"name":{"5145":{}},"parent":{}}],["finally",{"_index":887,"name":{"970":{}},"parent":{}}],["find",{"_index":637,"name":{"647":{}},"parent":{}}],["findactiveprofile",{"_index":1273,"name":{"1521":{}},"parent":{}}],["findauthhandlerforprofile",{"_index":1276,"name":{"1523":{}},"parent":{}}],["findcurrentcmdanchor",{"_index":2784,"name":{"3804":{}},"parent":{}}],["findlastmatchingattributes",{"_index":3502,"name":{"4717":{}},"parent":{}}],["findlayer",{"_index":790,"name":{"854":{}},"parent":{}}],["findnpmonpath",{"_index":2628,"name":{"3556":{}},"parent":{}}],["findoldsecureprops",{"_index":2647,"name":{"3577":{}},"parent":{}}],["findoptions",{"_index":1950,"name":{"2387":{}},"parent":{}}],["findpackagebinname",{"_index":2353,"name":{"3023":{}},"parent":{}}],["findprofile",{"_index":648,"name":{"664":{}},"parent":{}}],["findpropertytype",{"_index":1297,"name":{"1549":{}},"parent":{}}],["findsecure",{"_index":726,"name":{"776":{}},"parent":{}}],["findteamoslocation",{"_index":2301,"name":{"2953":{}},"parent":{}}],["finishresponse",{"_index":1888,"name":{"2263":{}},"parent":{}}],["firststepsdefinition",{"_index":2735,"name":{"3678":{}},"parent":{}}],["firststepshandler",{"_index":2737,"name":{"3687":{}},"parent":{}}],["flattencommandtree",{"_index":1468,"name":{"1734":{}},"parent":{}}],["flattencommandtreewithaliases",{"_index":1469,"name":{"1735":{}},"parent":{}}],["flattendependencies",{"_index":1993,"name":{"2443":{}},"parent":{}}],["flattennodes",{"_index":2795,"name":{"3819":{}},"parent":{}}],["flush",{"_index":1425,"name":{"1691":{}},"parent":{}}],["followupattempts",{"_index":3030,"name":{"4139":{}},"parent":{}}],["footerstr",{"_index":2789,"name":{"3811":{}},"parent":{}}],["for",{"_index":1,"name":{"0":{},"3832":{},"4118":{},"4221":{},"4875":{},"5155":{},"5188":{},"5438":{},"5569":{},"6008":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"127":{},"128":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"177":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{},"202":{},"203":{},"204":{},"205":{},"206":{},"207":{},"208":{},"209":{},"210":{},"211":{},"212":{},"213":{},"214":{},"215":{},"216":{},"217":{},"218":{},"219":{},"220":{},"221":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"228":{},"229":{},"230":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{},"250":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{},"259":{},"260":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"279":{},"280":{},"281":{},"282":{},"283":{},"284":{},"285":{},"286":{},"287":{},"288":{},"289":{},"290":{},"291":{},"292":{},"293":{},"294":{},"295":{},"296":{},"3833":{},"3834":{},"3835":{},"3836":{},"3837":{},"3838":{},"3839":{},"3840":{},"3841":{},"3842":{},"3843":{},"3844":{},"3845":{},"3846":{},"3847":{},"3848":{},"3849":{},"3850":{},"3851":{},"3852":{},"3853":{},"3854":{},"3855":{},"3856":{},"3857":{},"3858":{},"3859":{},"3860":{},"3861":{},"3862":{},"3863":{},"3864":{},"3865":{},"3866":{},"3867":{},"3868":{},"3869":{},"3870":{},"3871":{},"3872":{},"3873":{},"3874":{},"3875":{},"3876":{},"3877":{},"3878":{},"3879":{},"3880":{},"3881":{},"3882":{},"3883":{},"3884":{},"3885":{},"3886":{},"3887":{},"3888":{},"3889":{},"3890":{},"3891":{},"3892":{},"3893":{},"3894":{},"3895":{},"3896":{},"3897":{},"3898":{},"3899":{},"3900":{},"3901":{},"3902":{},"3903":{},"3904":{},"3905":{},"3906":{},"3907":{},"3908":{},"3909":{},"3910":{},"3911":{},"3912":{},"3913":{},"3914":{},"3915":{},"3916":{},"3917":{},"3918":{},"3919":{},"3920":{},"3921":{},"3922":{},"3923":{},"3924":{},"3925":{},"3926":{},"3927":{},"3928":{},"3929":{},"3930":{},"3931":{},"3932":{},"3933":{},"3934":{},"3935":{},"3936":{},"3937":{},"3938":{},"3939":{},"3940":{},"3941":{},"3942":{},"3943":{},"3944":{},"3945":{},"3946":{},"3947":{},"3948":{},"3949":{},"3950":{},"3951":{},"3952":{},"3953":{},"3954":{},"3955":{},"3956":{},"3957":{},"3958":{},"3959":{},"3960":{},"3961":{},"3962":{},"3963":{},"3964":{},"3965":{},"3966":{},"3967":{},"3968":{},"3969":{},"3970":{},"3971":{},"3972":{},"3973":{},"3974":{},"3975":{},"3976":{},"3977":{},"3978":{},"3979":{},"3980":{},"3981":{},"3982":{},"3983":{},"3984":{},"3985":{},"3986":{},"3987":{},"3988":{},"3989":{},"3990":{},"3991":{},"3992":{},"3993":{},"3994":{},"3995":{},"3996":{},"3997":{},"3998":{},"3999":{},"4000":{},"4001":{},"4002":{},"4003":{},"4004":{},"4005":{},"4006":{},"4007":{},"4008":{},"4009":{},"4010":{},"4011":{},"4012":{},"4013":{},"4014":{},"4015":{},"4016":{},"4017":{},"4018":{},"4019":{},"4020":{},"4021":{},"4022":{},"4023":{},"4024":{},"4025":{},"4026":{},"4027":{},"4028":{},"4029":{},"4030":{},"4031":{},"4032":{},"4033":{},"4034":{},"4035":{},"4036":{},"4037":{},"4038":{},"4039":{},"4040":{},"4041":{},"4042":{},"4043":{},"4044":{},"4045":{},"4046":{},"4047":{},"4048":{},"4049":{},"4050":{},"4051":{},"4052":{},"4053":{},"4054":{},"4055":{},"4056":{},"4057":{},"4058":{},"4059":{},"4060":{},"4061":{},"4062":{},"4063":{},"4064":{},"4065":{},"4066":{},"4067":{},"4068":{},"4069":{},"4070":{},"4071":{},"4072":{},"4073":{},"4074":{},"4075":{},"4076":{},"4077":{},"4078":{},"4079":{},"4080":{},"4081":{},"4082":{},"4083":{},"4084":{},"4085":{},"4086":{},"4087":{},"4088":{},"4089":{},"4090":{},"4091":{},"4092":{},"4093":{},"4094":{},"4095":{},"4096":{},"4097":{},"4098":{},"4099":{},"4100":{},"4101":{},"4102":{},"4103":{},"4104":{},"4105":{},"4106":{},"4107":{},"4108":{},"4109":{},"4110":{},"4111":{},"4112":{},"4113":{},"4114":{},"4115":{},"4116":{},"4117":{},"4119":{},"4120":{},"4121":{},"4122":{},"4123":{},"4124":{},"4125":{},"4126":{},"4127":{},"4128":{},"4129":{},"4130":{},"4131":{},"4132":{},"4133":{},"4134":{},"4135":{},"4136":{},"4137":{},"4138":{},"4139":{},"4140":{},"4141":{},"4142":{},"4143":{},"4144":{},"4145":{},"4146":{},"4147":{},"4148":{},"4149":{},"4150":{},"4151":{},"4152":{},"4153":{},"4154":{},"4155":{},"4156":{},"4157":{},"4158":{},"4159":{},"4160":{},"4161":{},"4162":{},"4163":{},"4164":{},"4165":{},"4166":{},"4167":{},"4168":{},"4169":{},"4170":{},"4171":{},"4172":{},"4173":{},"4174":{},"4175":{},"4176":{},"4177":{},"4178":{},"4179":{},"4180":{},"4181":{},"4182":{},"4183":{},"4184":{},"4185":{},"4186":{},"4187":{},"4188":{},"4189":{},"4190":{},"4191":{},"4192":{},"4193":{},"4194":{},"4195":{},"4196":{},"4197":{},"4198":{},"4199":{},"4200":{},"4201":{},"4202":{},"4203":{},"4204":{},"4205":{},"4206":{},"4207":{},"4208":{},"4209":{},"4210":{},"4211":{},"4212":{},"4213":{},"4214":{},"4215":{},"4216":{},"4217":{},"4218":{},"4219":{},"4220":{},"4222":{},"4223":{},"4224":{},"4225":{},"4226":{},"4227":{},"4228":{},"4229":{},"4230":{},"4231":{},"4232":{},"4233":{},"4234":{},"4235":{},"4236":{},"4237":{},"4238":{},"4239":{},"4240":{},"4241":{},"4242":{},"4243":{},"4244":{},"4245":{},"4246":{},"4247":{},"4248":{},"4249":{},"4250":{},"4251":{},"4252":{},"4253":{},"4254":{},"4255":{},"4256":{},"4257":{},"4258":{},"4259":{},"4260":{},"4261":{},"4262":{},"4263":{},"4264":{},"4265":{},"4266":{},"4267":{},"4268":{},"4269":{},"4270":{},"4271":{},"4272":{},"4273":{},"4274":{},"4275":{},"4276":{},"4277":{},"4278":{},"4279":{},"4280":{},"4281":{},"4282":{},"4283":{},"4284":{},"4285":{},"4286":{},"4287":{},"4288":{},"4289":{},"4290":{},"4291":{},"4292":{},"4293":{},"4294":{},"4295":{},"4296":{},"4297":{},"4298":{},"4299":{},"4300":{},"4301":{},"4302":{},"4303":{},"4304":{},"4305":{},"4306":{},"4307":{},"4308":{},"4309":{},"4310":{},"4311":{},"4312":{},"4313":{},"4314":{},"4315":{},"4316":{},"4317":{},"4318":{},"4319":{},"4320":{},"4321":{},"4322":{},"4323":{},"4324":{},"4325":{},"4326":{},"4327":{},"4328":{},"4329":{},"4330":{},"4331":{},"4332":{},"4333":{},"4334":{},"4335":{},"4336":{},"4337":{},"4338":{},"4339":{},"4340":{},"4341":{},"4342":{},"4343":{},"4344":{},"4345":{},"4346":{},"4347":{},"4348":{},"4349":{},"4350":{},"4351":{},"4352":{},"4353":{},"4354":{},"4355":{},"4356":{},"4357":{},"4358":{},"4359":{},"4360":{},"4361":{},"4362":{},"4363":{},"4364":{},"4365":{},"4366":{},"4367":{},"4368":{},"4369":{},"4370":{},"4371":{},"4372":{},"4373":{},"4374":{},"4375":{},"4376":{},"4377":{},"4378":{},"4379":{},"4380":{},"4381":{},"4382":{},"4383":{},"4384":{},"4385":{},"4386":{},"4387":{},"4388":{},"4389":{},"4390":{},"4391":{},"4392":{},"4393":{},"4394":{},"4395":{},"4396":{},"4397":{},"4398":{},"4399":{},"4400":{},"4401":{},"4402":{},"4403":{},"4404":{},"4405":{},"4406":{},"4407":{},"4408":{},"4409":{},"4410":{},"4411":{},"4412":{},"4413":{},"4414":{},"4415":{},"4416":{},"4417":{},"4418":{},"4419":{},"4420":{},"4421":{},"4422":{},"4423":{},"4424":{},"4425":{},"4426":{},"4427":{},"4428":{},"4429":{},"4430":{},"4431":{},"4432":{},"4433":{},"4434":{},"4435":{},"4436":{},"4437":{},"4438":{},"4439":{},"4440":{},"4441":{},"4442":{},"4443":{},"4444":{},"4445":{},"4446":{},"4447":{},"4448":{},"4449":{},"4450":{},"4451":{},"4452":{},"4453":{},"4454":{},"4455":{},"4456":{},"4457":{},"4458":{},"4459":{},"4460":{},"4461":{},"4462":{},"4463":{},"4464":{},"4465":{},"4466":{},"4467":{},"4468":{},"4469":{},"4470":{},"4471":{},"4472":{},"4473":{},"4474":{},"4475":{},"4476":{},"4477":{},"4478":{},"4479":{},"4480":{},"4481":{},"4482":{},"4483":{},"4484":{},"4485":{},"4486":{},"4487":{},"4488":{},"4489":{},"4490":{},"4491":{},"4492":{},"4493":{},"4494":{},"4495":{},"4496":{},"4497":{},"4498":{},"4499":{},"4500":{},"4501":{},"4502":{},"4503":{},"4504":{},"4505":{},"4506":{},"4507":{},"4508":{},"4509":{},"4510":{},"4511":{},"4512":{},"4513":{},"4514":{},"4515":{},"4516":{},"4517":{},"4518":{},"4519":{},"4520":{},"4521":{},"4522":{},"4523":{},"4524":{},"4525":{},"4526":{},"4527":{},"4528":{},"4529":{},"4530":{},"4531":{},"4532":{},"4533":{},"4534":{},"4535":{},"4536":{},"4537":{},"4538":{},"4539":{},"4540":{},"4541":{},"4542":{},"4543":{},"4544":{},"4545":{},"4546":{},"4547":{},"4548":{},"4549":{},"4550":{},"4551":{},"4552":{},"4553":{},"4554":{},"4555":{},"4556":{},"4557":{},"4558":{},"4559":{},"4560":{},"4561":{},"4562":{},"4563":{},"4564":{},"4565":{},"4566":{},"4567":{},"4568":{},"4569":{},"4570":{},"4571":{},"4572":{},"4573":{},"4574":{},"4575":{},"4576":{},"4577":{},"4578":{},"4579":{},"4580":{},"4581":{},"4582":{},"4583":{},"4584":{},"4585":{},"4586":{},"4587":{},"4588":{},"4589":{},"4590":{},"4591":{},"4592":{},"4593":{},"4594":{},"4595":{},"4596":{},"4597":{},"4598":{},"4599":{},"4600":{},"4601":{},"4602":{},"4603":{},"4604":{},"4605":{},"4606":{},"4607":{},"4608":{},"4609":{},"4610":{},"4611":{},"4612":{},"4613":{},"4614":{},"4615":{},"4616":{},"4617":{},"4618":{},"4619":{},"4620":{},"4621":{},"4622":{},"4623":{},"4624":{},"4625":{},"4626":{},"4627":{},"4628":{},"4629":{},"4630":{},"4631":{},"4632":{},"4633":{},"4634":{},"4635":{},"4636":{},"4637":{},"4638":{},"4639":{},"4640":{},"4641":{},"4642":{},"4643":{},"4644":{},"4645":{},"4646":{},"4647":{},"4648":{},"4649":{},"4650":{},"4651":{},"4652":{},"4653":{},"4654":{},"4655":{},"4656":{},"4657":{},"4658":{},"4659":{},"4660":{},"4661":{},"4662":{},"4663":{},"4664":{},"4665":{},"4666":{},"4667":{},"4668":{},"4669":{},"4670":{},"4671":{},"4672":{},"4673":{},"4674":{},"4675":{},"4676":{},"4677":{},"4678":{},"4679":{},"4680":{},"4681":{},"4682":{},"4683":{},"4684":{},"4685":{},"4686":{},"4687":{},"4688":{},"4689":{},"4690":{},"4691":{},"4692":{},"4693":{},"4694":{},"4695":{},"4696":{},"4697":{},"4698":{},"4699":{},"4700":{},"4701":{},"4702":{},"4703":{},"4704":{},"4705":{},"4706":{},"4707":{},"4708":{},"4709":{},"4710":{},"4711":{},"4712":{},"4713":{},"4714":{},"4715":{},"4716":{},"4717":{},"4718":{},"4719":{},"4720":{},"4721":{},"4722":{},"4723":{},"4724":{},"4725":{},"4726":{},"4727":{},"4728":{},"4729":{},"4730":{},"4731":{},"4732":{},"4733":{},"4734":{},"4735":{},"4736":{},"4737":{},"4738":{},"4739":{},"4740":{},"4741":{},"4742":{},"4743":{},"4744":{},"4745":{},"4746":{},"4747":{},"4748":{},"4749":{},"4750":{},"4751":{},"4752":{},"4753":{},"4754":{},"4755":{},"4756":{},"4757":{},"4758":{},"4759":{},"4760":{},"4761":{},"4762":{},"4763":{},"4764":{},"4765":{},"4766":{},"4767":{},"4768":{},"4769":{},"4770":{},"4771":{},"4772":{},"4773":{},"4774":{},"4775":{},"4776":{},"4777":{},"4778":{},"4779":{},"4780":{},"4781":{},"4782":{},"4783":{},"4784":{},"4785":{},"4786":{},"4787":{},"4788":{},"4789":{},"4790":{},"4791":{},"4792":{},"4793":{},"4794":{},"4795":{},"4796":{},"4797":{},"4798":{},"4799":{},"4800":{},"4801":{},"4802":{},"4803":{},"4804":{},"4805":{},"4806":{},"4807":{},"4808":{},"4809":{},"4810":{},"4811":{},"4812":{},"4813":{},"4814":{},"4815":{},"4816":{},"4817":{},"4818":{},"4819":{},"4820":{},"4821":{},"4822":{},"4823":{},"4824":{},"4825":{},"4826":{},"4827":{},"4828":{},"4829":{},"4830":{},"4831":{},"4832":{},"4833":{},"4834":{},"4835":{},"4836":{},"4837":{},"4838":{},"4839":{},"4840":{},"4841":{},"4842":{},"4843":{},"4844":{},"4845":{},"4846":{},"4847":{},"4848":{},"4849":{},"4850":{},"4851":{},"4852":{},"4853":{},"4854":{},"4855":{},"4856":{},"4857":{},"4858":{},"4859":{},"4860":{},"4861":{},"4862":{},"4863":{},"4864":{},"4865":{},"4866":{},"4867":{},"4868":{},"4869":{},"4870":{},"4871":{},"4872":{},"4873":{},"4874":{},"4876":{},"4877":{},"4878":{},"4879":{},"4880":{},"4881":{},"4882":{},"4883":{},"4884":{},"4885":{},"4886":{},"4887":{},"4888":{},"4889":{},"4890":{},"4891":{},"4892":{},"4893":{},"4894":{},"4895":{},"4896":{},"4897":{},"4898":{},"4899":{},"4900":{},"4901":{},"4902":{},"4903":{},"4904":{},"4905":{},"4906":{},"4907":{},"4908":{},"4909":{},"4910":{},"4911":{},"4912":{},"4913":{},"4914":{},"4915":{},"4916":{},"4917":{},"4918":{},"4919":{},"4920":{},"4921":{},"4922":{},"4923":{},"4924":{},"4925":{},"4926":{},"4927":{},"4928":{},"4929":{},"4930":{},"4931":{},"4932":{},"4933":{},"4934":{},"4935":{},"4936":{},"4937":{},"4938":{},"4939":{},"4940":{},"4941":{},"4942":{},"4943":{},"4944":{},"4945":{},"4946":{},"4947":{},"4948":{},"4949":{},"4950":{},"4951":{},"4952":{},"4953":{},"4954":{},"4955":{},"4956":{},"4957":{},"4958":{},"4959":{},"4960":{},"4961":{},"4962":{},"4963":{},"4964":{},"4965":{},"4966":{},"4967":{},"4968":{},"4969":{},"4970":{},"4971":{},"4972":{},"4973":{},"4974":{},"4975":{},"4976":{},"4977":{},"4978":{},"4979":{},"4980":{},"4981":{},"4982":{},"4983":{},"4984":{},"4985":{},"4986":{},"4987":{},"4988":{},"4989":{},"4990":{},"4991":{},"4992":{},"4993":{},"4994":{},"4995":{},"4996":{},"4997":{},"4998":{},"4999":{},"5000":{},"5001":{},"5002":{},"5003":{},"5004":{},"5005":{},"5006":{},"5007":{},"5008":{},"5009":{},"5010":{},"5011":{},"5012":{},"5013":{},"5014":{},"5015":{},"5016":{},"5017":{},"5018":{},"5019":{},"5020":{},"5021":{},"5022":{},"5023":{},"5024":{},"5025":{},"5026":{},"5027":{},"5028":{},"5029":{},"5030":{},"5031":{},"5032":{},"5033":{},"5034":{},"5035":{},"5036":{},"5037":{},"5038":{},"5039":{},"5040":{},"5041":{},"5042":{},"5043":{},"5044":{},"5045":{},"5046":{},"5047":{},"5048":{},"5049":{},"5050":{},"5051":{},"5052":{},"5053":{},"5054":{},"5055":{},"5056":{},"5057":{},"5058":{},"5059":{},"5060":{},"5061":{},"5062":{},"5063":{},"5064":{},"5065":{},"5066":{},"5067":{},"5068":{},"5069":{},"5070":{},"5071":{},"5072":{},"5073":{},"5074":{},"5075":{},"5076":{},"5077":{},"5078":{},"5079":{},"5080":{},"5081":{},"5082":{},"5083":{},"5084":{},"5085":{},"5086":{},"5087":{},"5088":{},"5089":{},"5090":{},"5091":{},"5092":{},"5093":{},"5094":{},"5095":{},"5096":{},"5097":{},"5098":{},"5099":{},"5100":{},"5101":{},"5102":{},"5103":{},"5104":{},"5105":{},"5106":{},"5107":{},"5108":{},"5109":{},"5110":{},"5111":{},"5112":{},"5113":{},"5114":{},"5115":{},"5116":{},"5117":{},"5118":{},"5119":{},"5120":{},"5121":{},"5122":{},"5123":{},"5124":{},"5125":{},"5126":{},"5127":{},"5128":{},"5129":{},"5130":{},"5131":{},"5132":{},"5133":{},"5134":{},"5135":{},"5136":{},"5137":{},"5138":{},"5139":{},"5140":{},"5141":{},"5142":{},"5143":{},"5144":{},"5145":{},"5146":{},"5147":{},"5148":{},"5149":{},"5150":{},"5151":{},"5152":{},"5153":{},"5154":{},"5156":{},"5157":{},"5158":{},"5159":{},"5160":{},"5161":{},"5162":{},"5163":{},"5164":{},"5165":{},"5166":{},"5167":{},"5168":{},"5169":{},"5170":{},"5171":{},"5172":{},"5173":{},"5174":{},"5175":{},"5176":{},"5177":{},"5178":{},"5179":{},"5180":{},"5181":{},"5182":{},"5183":{},"5184":{},"5185":{},"5186":{},"5187":{},"5189":{},"5190":{},"5191":{},"5192":{},"5193":{},"5194":{},"5195":{},"5196":{},"5197":{},"5198":{},"5199":{},"5200":{},"5201":{},"5202":{},"5203":{},"5204":{},"5205":{},"5206":{},"5207":{},"5208":{},"5209":{},"5210":{},"5211":{},"5212":{},"5213":{},"5214":{},"5215":{},"5216":{},"5217":{},"5218":{},"5219":{},"5220":{},"5221":{},"5222":{},"5223":{},"5224":{},"5225":{},"5226":{},"5227":{},"5228":{},"5229":{},"5230":{},"5231":{},"5232":{},"5233":{},"5234":{},"5235":{},"5236":{},"5237":{},"5238":{},"5239":{},"5240":{},"5241":{},"5242":{},"5243":{},"5244":{},"5245":{},"5246":{},"5247":{},"5248":{},"5249":{},"5250":{},"5251":{},"5252":{},"5253":{},"5254":{},"5255":{},"5256":{},"5257":{},"5258":{},"5259":{},"5260":{},"5261":{},"5262":{},"5263":{},"5264":{},"5265":{},"5266":{},"5267":{},"5268":{},"5269":{},"5270":{},"5271":{},"5272":{},"5273":{},"5274":{},"5275":{},"5276":{},"5277":{},"5278":{},"5279":{},"5280":{},"5281":{},"5282":{},"5283":{},"5284":{},"5285":{},"5286":{},"5287":{},"5288":{},"5289":{},"5290":{},"5291":{},"5292":{},"5293":{},"5294":{},"5295":{},"5296":{},"5297":{},"5298":{},"5299":{},"5300":{},"5301":{},"5302":{},"5303":{},"5304":{},"5305":{},"5306":{},"5307":{},"5308":{},"5309":{},"5310":{},"5311":{},"5312":{},"5313":{},"5314":{},"5315":{},"5316":{},"5317":{},"5318":{},"5319":{},"5320":{},"5321":{},"5322":{},"5323":{},"5324":{},"5325":{},"5326":{},"5327":{},"5328":{},"5329":{},"5330":{},"5331":{},"5332":{},"5333":{},"5334":{},"5335":{},"5336":{},"5337":{},"5338":{},"5339":{},"5340":{},"5341":{},"5342":{},"5343":{},"5344":{},"5345":{},"5346":{},"5347":{},"5348":{},"5349":{},"5350":{},"5351":{},"5352":{},"5353":{},"5354":{},"5355":{},"5356":{},"5357":{},"5358":{},"5359":{},"5360":{},"5361":{},"5362":{},"5363":{},"5364":{},"5365":{},"5366":{},"5367":{},"5368":{},"5369":{},"5370":{},"5371":{},"5372":{},"5373":{},"5374":{},"5375":{},"5376":{},"5377":{},"5378":{},"5379":{},"5380":{},"5381":{},"5382":{},"5383":{},"5384":{},"5385":{},"5386":{},"5387":{},"5388":{},"5389":{},"5390":{},"5391":{},"5392":{},"5393":{},"5394":{},"5395":{},"5396":{},"5397":{},"5398":{},"5399":{},"5400":{},"5401":{},"5402":{},"5403":{},"5404":{},"5405":{},"5406":{},"5407":{},"5408":{},"5409":{},"5410":{},"5411":{},"5412":{},"5413":{},"5414":{},"5415":{},"5416":{},"5417":{},"5418":{},"5419":{},"5420":{},"5421":{},"5422":{},"5423":{},"5424":{},"5425":{},"5426":{},"5427":{},"5428":{},"5429":{},"5430":{},"5431":{},"5432":{},"5433":{},"5434":{},"5435":{},"5436":{},"5437":{},"5439":{},"5440":{},"5441":{},"5442":{},"5443":{},"5444":{},"5445":{},"5446":{},"5447":{},"5448":{},"5449":{},"5450":{},"5451":{},"5452":{},"5453":{},"5454":{},"5455":{},"5456":{},"5457":{},"5458":{},"5459":{},"5460":{},"5461":{},"5462":{},"5463":{},"5464":{},"5465":{},"5466":{},"5467":{},"5468":{},"5469":{},"5470":{},"5471":{},"5472":{},"5473":{},"5474":{},"5475":{},"5476":{},"5477":{},"5478":{},"5479":{},"5480":{},"5481":{},"5482":{},"5483":{},"5484":{},"5485":{},"5486":{},"5487":{},"5488":{},"5489":{},"5490":{},"5491":{},"5492":{},"5493":{},"5494":{},"5495":{},"5496":{},"5497":{},"5498":{},"5499":{},"5500":{},"5501":{},"5502":{},"5503":{},"5504":{},"5505":{},"5506":{},"5507":{},"5508":{},"5509":{},"5510":{},"5511":{},"5512":{},"5513":{},"5514":{},"5515":{},"5516":{},"5517":{},"5518":{},"5519":{},"5520":{},"5521":{},"5522":{},"5523":{},"5524":{},"5525":{},"5526":{},"5527":{},"5528":{},"5529":{},"5530":{},"5531":{},"5532":{},"5533":{},"5534":{},"5535":{},"5536":{},"5537":{},"5538":{},"5539":{},"5540":{},"5541":{},"5542":{},"5543":{},"5544":{},"5545":{},"5546":{},"5547":{},"5548":{},"5549":{},"5550":{},"5551":{},"5552":{},"5553":{},"5554":{},"5555":{},"5556":{},"5557":{},"5558":{},"5559":{},"5560":{},"5561":{},"5562":{},"5563":{},"5564":{},"5565":{},"5566":{},"5567":{},"5568":{},"5570":{},"5571":{},"5572":{},"5573":{},"5574":{},"5575":{},"5576":{},"5577":{},"5578":{},"5579":{},"5580":{},"5581":{},"5582":{},"5583":{},"5584":{},"5585":{},"5586":{},"5587":{},"5588":{},"5589":{},"5590":{},"5591":{},"5592":{},"5593":{},"5594":{},"5595":{},"5596":{},"5597":{},"5598":{},"5599":{},"5600":{},"5601":{},"5602":{},"5603":{},"5604":{},"5605":{},"5606":{},"5607":{},"5608":{},"5609":{},"5610":{},"5611":{},"5612":{},"5613":{},"5614":{},"5615":{},"5616":{},"5617":{},"5618":{},"5619":{},"5620":{},"5621":{},"5622":{},"5623":{},"5624":{},"5625":{},"5626":{},"5627":{},"5628":{},"5629":{},"5630":{},"5631":{},"5632":{},"5633":{},"5634":{},"5635":{},"5636":{},"5637":{},"5638":{},"5639":{},"5640":{},"5641":{},"5642":{},"5643":{},"5644":{},"5645":{},"5646":{},"5647":{},"5648":{},"5649":{},"5650":{},"5651":{},"5652":{},"5653":{},"5654":{},"5655":{},"5656":{},"5657":{},"5658":{},"5659":{},"5660":{},"5661":{},"5662":{},"5663":{},"5664":{},"5665":{},"5666":{},"5667":{},"5668":{},"5669":{},"5670":{},"5671":{},"5672":{},"5673":{},"5674":{},"5675":{},"5676":{},"5677":{},"5678":{},"5679":{},"5680":{},"5681":{},"5682":{},"5683":{},"5684":{},"5685":{},"5686":{},"5687":{},"5688":{},"5689":{},"5690":{},"5691":{},"5692":{},"5693":{},"5694":{},"5695":{},"5696":{},"5697":{},"5698":{},"5699":{},"5700":{},"5701":{},"5702":{},"5703":{},"5704":{},"5705":{},"5706":{},"5707":{},"5708":{},"5709":{},"5710":{},"5711":{},"5712":{},"5713":{},"5714":{},"5715":{},"5716":{},"5717":{},"5718":{},"5719":{},"5720":{},"5721":{},"5722":{},"5723":{},"5724":{},"5725":{},"5726":{},"5727":{},"5728":{},"5729":{},"5730":{},"5731":{},"5732":{},"5733":{},"5734":{},"5735":{},"5736":{},"5737":{},"5738":{},"5739":{},"5740":{},"5741":{},"5742":{},"5743":{},"5744":{},"5745":{},"5746":{},"5747":{},"5748":{},"5749":{},"5750":{},"5751":{},"5752":{},"5753":{},"5754":{},"5755":{},"5756":{},"5757":{},"5758":{},"5759":{},"5760":{},"5761":{},"5762":{},"5763":{},"5764":{},"5765":{},"5766":{},"5767":{},"5768":{},"5769":{},"5770":{},"5771":{},"5772":{},"5773":{},"5774":{},"5775":{},"5776":{},"5777":{},"5778":{},"5779":{},"5780":{},"5781":{},"5782":{},"5783":{},"5784":{},"5785":{},"5786":{},"5787":{},"5788":{},"5789":{},"5790":{},"5791":{},"5792":{},"5793":{},"5794":{},"5795":{},"5796":{},"5797":{},"5798":{},"5799":{},"5800":{},"5801":{},"5802":{},"5803":{},"5804":{},"5805":{},"5806":{},"5807":{},"5808":{},"5809":{},"5810":{},"5811":{},"5812":{},"5813":{},"5814":{},"5815":{},"5816":{},"5817":{},"5818":{},"5819":{},"5820":{},"5821":{},"5822":{},"5823":{},"5824":{},"5825":{},"5826":{},"5827":{},"5828":{},"5829":{},"5830":{},"5831":{},"5832":{},"5833":{},"5834":{},"5835":{},"5836":{},"5837":{},"5838":{},"5839":{},"5840":{},"5841":{},"5842":{},"5843":{},"5844":{},"5845":{},"5846":{},"5847":{},"5848":{},"5849":{},"5850":{},"5851":{},"5852":{},"5853":{},"5854":{},"5855":{},"5856":{},"5857":{},"5858":{},"5859":{},"5860":{},"5861":{},"5862":{},"5863":{},"5864":{},"5865":{},"5866":{},"5867":{},"5868":{},"5869":{},"5870":{},"5871":{},"5872":{},"5873":{},"5874":{},"5875":{},"5876":{},"5877":{},"5878":{},"5879":{},"5880":{},"5881":{},"5882":{},"5883":{},"5884":{},"5885":{},"5886":{},"5887":{},"5888":{},"5889":{},"5890":{},"5891":{},"5892":{},"5893":{},"5894":{},"5895":{},"5896":{},"5897":{},"5898":{},"5899":{},"5900":{},"5901":{},"5902":{},"5903":{},"5904":{},"5905":{},"5906":{},"5907":{},"5908":{},"5909":{},"5910":{},"5911":{},"5912":{},"5913":{},"5914":{},"5915":{},"5916":{},"5917":{},"5918":{},"5919":{},"5920":{},"5921":{},"5922":{},"5923":{},"5924":{},"5925":{},"5926":{},"5927":{},"5928":{},"5929":{},"5930":{},"5931":{},"5932":{},"5933":{},"5934":{},"5935":{},"5936":{},"5937":{},"5938":{},"5939":{},"5940":{},"5941":{},"5942":{},"5943":{},"5944":{},"5945":{},"5946":{},"5947":{},"5948":{},"5949":{},"5950":{},"5951":{},"5952":{},"5953":{},"5954":{},"5955":{},"5956":{},"5957":{},"5958":{},"5959":{},"5960":{},"5961":{},"5962":{},"5963":{},"5964":{},"5965":{},"5966":{},"5967":{},"5968":{},"5969":{},"5970":{},"5971":{},"5972":{},"5973":{},"5974":{},"5975":{},"5976":{},"5977":{},"5978":{},"5979":{},"5980":{},"5981":{},"5982":{},"5983":{},"5984":{},"5985":{},"5986":{},"5987":{},"5988":{},"5989":{},"5990":{},"5991":{},"5992":{},"5993":{},"5994":{},"5995":{},"5996":{},"5997":{},"5998":{},"5999":{},"6000":{},"6001":{},"6002":{},"6003":{},"6004":{},"6005":{},"6006":{},"6007":{},"6009":{},"6010":{},"6011":{},"6012":{},"6013":{},"6014":{},"6015":{},"6016":{},"6017":{},"6018":{},"6019":{},"6020":{},"6021":{},"6022":{},"6023":{},"6024":{},"6025":{},"6026":{},"6027":{},"6028":{},"6029":{},"6030":{},"6031":{},"6032":{},"6033":{},"6034":{},"6035":{},"6036":{},"6037":{},"6038":{},"6039":{},"6040":{},"6041":{},"6042":{},"6043":{},"6044":{},"6045":{},"6046":{},"6047":{},"6048":{},"6049":{},"6050":{},"6051":{},"6052":{},"6053":{},"6054":{},"6055":{},"6056":{},"6057":{},"6058":{},"6059":{},"6060":{},"6061":{},"6062":{},"6063":{},"6064":{},"6065":{},"6066":{},"6067":{},"6068":{},"6069":{},"6070":{},"6071":{},"6072":{},"6073":{},"6074":{},"6075":{},"6076":{},"6077":{},"6078":{},"6079":{},"6080":{},"6081":{},"6082":{},"6083":{},"6084":{},"6085":{},"6086":{},"6087":{},"6088":{},"6089":{},"6090":{},"6091":{},"6092":{},"6093":{},"6094":{},"6095":{},"6096":{},"6097":{},"6098":{},"6099":{},"6100":{},"6101":{},"6102":{},"6103":{},"6104":{},"6105":{},"6106":{},"6107":{},"6108":{},"6109":{},"6110":{},"6111":{},"6112":{},"6113":{},"6114":{},"6115":{},"6116":{},"6117":{},"6118":{},"6119":{},"6120":{},"6121":{},"6122":{},"6123":{},"6124":{},"6125":{},"6126":{},"6127":{},"6128":{},"6129":{},"6130":{},"6131":{},"6132":{},"6133":{},"6134":{},"6135":{},"6136":{},"6137":{},"6138":{},"6139":{},"6140":{},"6141":{},"6142":{},"6143":{},"6144":{},"6145":{},"6146":{},"6147":{},"6148":{},"6149":{},"6150":{},"6151":{},"6152":{},"6153":{},"6154":{},"6155":{},"6156":{},"6157":{},"6158":{},"6159":{},"6160":{},"6161":{},"6162":{},"6163":{},"6164":{},"6165":{},"6166":{},"6167":{},"6168":{},"6169":{},"6170":{},"6171":{},"6172":{},"6173":{},"6174":{},"6175":{},"6176":{},"6177":{},"6178":{},"6179":{},"6180":{},"6181":{},"6182":{},"6183":{},"6184":{},"6185":{},"6186":{},"6187":{},"6188":{},"6189":{},"6190":{},"6191":{},"6192":{},"6193":{},"6194":{},"6195":{},"6196":{},"6197":{},"6198":{},"6199":{},"6200":{}}}],["forceupdate",{"_index":2233,"name":{"2873":{}},"parent":{}}],["format",{"_index":440,"name":{"440":{},"1112":{},"1123":{},"1982":{},"3368":{},"5531":{},"6147":{}},"parent":{}}],["formathelpheader",{"_index":1798,"name":{"2121":{},"2167":{},"3381":{}},"parent":{}}],["formatmessage",{"_index":345,"name":{"344":{},"1999":{}},"parent":{}}],["formatstringfordisplay",{"_index":3571,"name":{"4817":{}},"parent":{}}],["formatunixfilepath",{"_index":3478,"name":{"4688":{}},"parent":{}}],["formmainconfigpathnm",{"_index":793,"name":{"857":{}},"parent":{}}],["formpluginruntimepath",{"_index":1450,"name":{"1718":{}},"parent":{}}],["formsubstitutionheader",{"_index":3789,"name":{"5123":{}},"parent":{}}],["fourty_percent",{"_index":894,"name":{"976":{}},"parent":{}}],["framework_display_name",{"_index":472,"name":{"473":{}},"parent":{}}],["from",{"_index":293,"name":{"299":{},"4797":{},"4820":{},"4832":{}},"parent":{}}],["fs",{"_index":3441,"name":{"4641":{},"4863":{},"4867":{},"4874":{}},"parent":{}}],["fsmountedsuccessfully",{"_index":3277,"name":{"4391":{}},"parent":{}}],["fsname",{"_index":3408,"name":{"4591":{}},"parent":{}}],["fsunmountedsuccessfully",{"_index":3279,"name":{"4393":{}},"parent":{}}],["fsvalidateoptions",{"_index":3605,"name":{"4868":{}},"parent":{}}],["fswithpath",{"_index":3442,"name":{"4642":{}},"parent":{}}],["ftpdestinationname",{"_index":4364,"name":{"6062":{}},"parent":{}}],["fullcommandtree",{"_index":1787,"name":{"2111":{},"2222":{},"2725":{}},"parent":{}}],["fulldefinition",{"_index":1008,"name":{"1133":{},"2102":{},"2251":{}},"parent":{}}],["fullname",{"_index":1460,"name":{"1727":{}},"parent":{}}],["fullpath",{"_index":3540,"name":{"4770":{}},"parent":{}}],["gatewayurl",{"_index":23,"name":{"15":{},"1552":{}},"parent":{}}],["gatewayurlconflicts",{"_index":17,"name":{"11":{}},"parent":{}}],["genbreadcrumb",{"_index":1852,"name":{"2207":{}},"parent":{}}],["gencommandhelppage",{"_index":1854,"name":{"2210":{}},"parent":{}}],["gendocsfooter",{"_index":1850,"name":{"2205":{}},"parent":{}}],["gendocsheader",{"_index":1849,"name":{"2204":{}},"parent":{}}],["generated",{"_index":2841,"name":{"3865":{},"4038":{}},"parent":{}}],["generatedatasetoptions",{"_index":3587,"name":{"4839":{}},"parent":{}}],["generateheadersbasedonoptions",{"_index":3473,"name":{"4683":{},"4763":{},"4818":{}},"parent":{}}],["generatemembername",{"_index":3474,"name":{"4684":{}},"parent":{}}],["generateschema",{"_index":1289,"name":{"1541":{}},"parent":{}}],["genhtmlfordiffs",{"_index":2398,"name":{"3068":{}},"parent":{}}],["genprintbutton",{"_index":1851,"name":{"2206":{}},"parent":{}}],["get",{"_index":634,"name":{"644":{},"651":{},"656":{},"936":{},"1688":{},"4765":{}},"parent":{}}],["getaction",{"_index":2026,"name":{"2494":{},"2504":{},"2510":{},"2520":{},"2531":{},"2543":{},"2554":{},"2564":{},"2604":{},"2608":{},"2618":{},"2709":{},"3750":{}},"parent":{}}],["getactiveprofilename",{"_index":715,"name":{"764":{}},"parent":{}}],["getall",{"_index":852,"name":{"937":{}},"parent":{}}],["getallissues",{"_index":1409,"name":{"1665":{}},"parent":{}}],["getallprofiledirectories",{"_index":2415,"name":{"3084":{}},"parent":{}}],["getallprofilenames",{"_index":1968,"name":{"2410":{},"3085":{},"3115":{},"3289":{}},"parent":{}}],["getallprofiles",{"_index":2275,"name":{"2925":{}},"parent":{}}],["getallresponses",{"_index":4013,"name":{"5433":{}},"parent":{}}],["getalltypenames",{"_index":1994,"name":{"2444":{}},"parent":{}}],["getapplogger",{"_index":2584,"name":{"3414":{}},"parent":{}}],["getarguments",{"_index":2600,"name":{"3452":{}},"parent":{}}],["getauthgroup",{"_index":2078,"name":{"2632":{}},"parent":{}}],["getauthhandlerapi",{"_index":1249,"name":{"1487":{},"2762":{}},"parent":{}}],["getautoinitcommand",{"_index":2109,"name":{"2713":{}},"parent":{}}],["getbase64auth",{"_index":1091,"name":{"1245":{},"1269":{}},"parent":{}}],["getbaseprofilename",{"_index":2147,"name":{"2764":{}},"parent":{}}],["getbasicsysteminfo",{"_index":2377,"name":{"3047":{}},"parent":{}}],["getbrightyargsresponse",{"_index":1908,"name":{"2293":{},"2315":{},"2361":{}},"parent":{}}],["getcallerfile",{"_index":2356,"name":{"3030":{}},"parent":{}}],["getcallerfileandlinetag",{"_index":2593,"name":{"3432":{}},"parent":{}}],["getcasesensitiveflagbyoptionname",{"_index":1810,"name":{"2139":{},"2182":{}},"parent":{}}],["getclihomeenvironmentfilepath",{"_index":2118,"name":{"2720":{}},"parent":{}}],["getclipkgname",{"_index":1447,"name":{"1715":{}},"parent":{}}],["getclosestcommand",{"_index":2017,"name":{"2477":{}},"parent":{}}],["getcmdoutput",{"_index":2700,"name":{"3632":{}},"parent":{}}],["getconfiginfo",{"_index":2701,"name":{"3633":{}},"parent":{}}],["getconsole",{"_index":419,"name":{"413":{}},"parent":{}}],["getconsolelogger",{"_index":2587,"name":{"3418":{}},"parent":{}}],["getcredentialshelper",{"_index":674,"name":{"702":{}},"parent":{}}],["getcredmgrinfobydisplayname",{"_index":703,"name":{"753":{}},"parent":{}}],["getcredmgrinfobyplugin",{"_index":704,"name":{"754":{}},"parent":{}}],["getcredmgrinfobyzeext",{"_index":705,"name":{"755":{}},"parent":{}}],["getdashformofoption",{"_index":1719,"name":{"2027":{},"3372":{}},"parent":{}}],["getdatafromtso",{"_index":4012,"name":{"5432":{}},"parent":{}}],["getdatasetfromname",{"_index":3480,"name":{"4690":{}},"parent":{}}],["getdefaultfilename",{"_index":1336,"name":{"1590":{}},"parent":{}}],["getdefaulticonfiglogging",{"_index":1333,"name":{"1587":{}},"parent":{}}],["getdefaultloglevel",{"_index":1337,"name":{"1591":{}},"parent":{}}],["getdefaultprofile",{"_index":290,"name":{"296":{},"2926":{}},"parent":{}}],["getdefaultprofilename",{"_index":1974,"name":{"2420":{},"3125":{},"3299":{}},"parent":{}}],["getdefaulttexteditor",{"_index":392,"name":{"388":{}},"parent":{}}],["getdefaultvalue",{"_index":2171,"name":{"2797":{}},"parent":{}}],["getdepthexamples",{"_index":1911,"name":{"2296":{},"2318":{},"2364":{}},"parent":{}}],["getdiffstring",{"_index":2400,"name":{"3070":{}},"parent":{}}],["getdirs",{"_index":3570,"name":{"4816":{}},"parent":{}}],["getdirsfromdataset",{"_index":3470,"name":{"4680":{}},"parent":{}}],["getemptyconsoleresponse",{"_index":3077,"name":{"4193":{}},"parent":{}}],["getenvironmentfilepath",{"_index":2116,"name":{"2718":{}},"parent":{}}],["getenvitemproblems",{"_index":2702,"name":{"3634":{}},"parent":{}}],["getenvitemval",{"_index":2698,"name":{"3630":{}},"parent":{}}],["getenvvalforoption",{"_index":2559,"name":{"3379":{}},"parent":{}}],["geterrorcontext",{"_index":285,"name":{"291":{}},"parent":{}}],["getexpectbuffer",{"_index":1184,"name":{"1387":{}},"parent":{}}],["getexpectfullresponse",{"_index":1198,"name":{"1401":{}},"parent":{}}],["getexpectjson",{"_index":1179,"name":{"1383":{}},"parent":{}}],["getexpectstring",{"_index":1188,"name":{"1391":{}},"parent":{}}],["getexperimentalcommandsection",{"_index":1830,"name":{"2163":{}},"parent":{}}],["getfilelistfrompath",{"_index":3472,"name":{"4682":{}},"parent":{}}],["getfiletransfermode",{"_index":3499,"name":{"4713":{}},"parent":{}}],["getfollowupattempts",{"_index":3104,"name":{"4219":{}},"parent":{}}],["getfullcommandname",{"_index":1470,"name":{"1736":{}},"parent":{}}],["getfullpath",{"_index":3471,"name":{"4681":{}},"parent":{}}],["getgenerator",{"_index":2051,"name":{"2579":{},"3347":{},"3355":{}},"parent":{}}],["gethelpgenerator",{"_index":1916,"name":{"2321":{},"2581":{},"2730":{},"3346":{},"3357":{}},"parent":{}}],["getimperativelogger",{"_index":2583,"name":{"3413":{}},"parent":{}}],["getinstalledplugins",{"_index":1410,"name":{"1666":{}},"parent":{}}],["getissuelistforplugin",{"_index":1411,"name":{"1667":{}},"parent":{}}],["getjcl",{"_index":3804,"name":{"5139":{}},"parent":{}}],["getjclcommon",{"_index":3806,"name":{"5141":{}},"parent":{}}],["getjclforjob",{"_index":3805,"name":{"5140":{}},"parent":{}}],["getjob",{"_index":3796,"name":{"5131":{}},"parent":{}}],["getjobs",{"_index":3790,"name":{"5125":{},"5126":{}},"parent":{}}],["getjobsbyowner",{"_index":3793,"name":{"5128":{}},"parent":{}}],["getjobsbyownerandprefix",{"_index":3794,"name":{"5129":{}},"parent":{}}],["getjobsbyparameters",{"_index":3795,"name":{"5130":{}},"parent":{}}],["getjobsbyprefix",{"_index":3792,"name":{"5127":{}},"parent":{}}],["getjobscommon",{"_index":3797,"name":{"5132":{}},"parent":{}}],["getjstreethemename",{"_index":2796,"name":{"3820":{}},"parent":{}}],["getknowncredmgrs",{"_index":706,"name":{"756":{}},"parent":{}}],["getlocalencoding",{"_index":3501,"name":{"4715":{}},"parent":{}}],["getloggercategory",{"_index":2582,"name":{"3412":{}},"parent":{}}],["getmanager",{"_index":2063,"name":{"2596":{},"3154":{},"3310":{},"3315":{}},"parent":{}}],["getmeta",{"_index":851,"name":{"935":{}},"parent":{}}],["getmissingentrymessage",{"_index":677,"name":{"705":{}},"parent":{}}],["getmustachesummaryforoption",{"_index":1718,"name":{"2026":{}},"parent":{}}],["getnamespace",{"_index":1423,"name":{"1689":{}},"parent":{}}],["getnpminfo",{"_index":2703,"name":{"3635":{}},"parent":{}}],["getoldplugininfo",{"_index":2643,"name":{"3573":{}},"parent":{}}],["getoldprofilecount",{"_index":2644,"name":{"3574":{}},"parent":{}}],["getoptionandaliasesstring",{"_index":1807,"name":{"2136":{},"2180":{}},"parent":{}}],["getoptiondefinitionfromname",{"_index":1466,"name":{"1732":{},"2028":{}},"parent":{}}],["getoptionformat",{"_index":2567,"name":{"3389":{}},"parent":{}}],["getoptvaluefromprofiles",{"_index":2555,"name":{"3375":{}},"parent":{}}],["getoslocinfo",{"_index":2285,"name":{"2936":{}},"parent":{}}],["getotherzoweenvvars",{"_index":2704,"name":{"3636":{}},"parent":{}}],["getpackageinfo",{"_index":2632,"name":{"3560":{}},"parent":{}}],["getpasswordfromauth",{"_index":1090,"name":{"1244":{},"1268":{},"1441":{}},"parent":{}}],["getpluginapimlconfigs",{"_index":51,"name":{"39":{}},"parent":{}}],["getplugininfo",{"_index":2705,"name":{"3637":{}},"parent":{}}],["getpositionalsyntaxstring",{"_index":2560,"name":{"3380":{}},"parent":{}}],["getpreparedcmdtree",{"_index":2137,"name":{"2752":{}},"parent":{}}],["getprofileconfiguration",{"_index":2123,"name":{"2729":{}},"parent":{}}],["getprofilegroup",{"_index":2047,"name":{"2575":{}},"parent":{}}],["getprofilemapkey",{"_index":1998,"name":{"2448":{}},"parent":{}}],["getprofilenamefrompath",{"_index":646,"name":{"662":{}},"parent":{}}],["getprofileoption",{"_index":1995,"name":{"2445":{}},"parent":{}}],["getprofileoptionalias",{"_index":1996,"name":{"2446":{}},"parent":{}}],["getprofileoptionandalias",{"_index":1997,"name":{"2447":{}},"parent":{}}],["getprofilepathfromname",{"_index":645,"name":{"661":{}},"parent":{}}],["getprofilepropertykey",{"_index":1999,"name":{"2449":{}},"parent":{}}],["getprofiletypes",{"_index":2297,"name":{"2949":{}},"parent":{}}],["getpromptparams",{"_index":1248,"name":{"1486":{},"2761":{}},"parent":{}}],["getrecommendedwidth",{"_index":336,"name":{"335":{}},"parent":{}}],["getregistry",{"_index":2630,"name":{"3558":{}},"parent":{}}],["getremoteencoding",{"_index":3500,"name":{"4714":{}},"parent":{}}],["getresolvedcmdtree",{"_index":2136,"name":{"2751":{}},"parent":{}}],["getresource",{"_index":3086,"name":{"4201":{},"4217":{},"5395":{}},"parent":{}}],["getresourcepath",{"_index":3845,"name":{"5187":{}},"parent":{}}],["getresourcequery",{"_index":4251,"name":{"5796":{}},"parent":{}}],["getresources",{"_index":3989,"name":{"5404":{}},"parent":{}}],["getresourcesquery",{"_index":2937,"name":{"3995":{},"4009":{},"4053":{},"4064":{},"5400":{}},"parent":{}}],["getresponseformat",{"_index":2018,"name":{"2478":{}},"parent":{}}],["getschemafortype",{"_index":2298,"name":{"2950":{}},"parent":{}}],["getschemainfo",{"_index":784,"name":{"846":{}},"parent":{}}],["getsecurevals",{"_index":2209,"name":{"2840":{}},"parent":{}}],["getservicesbyconfig",{"_index":53,"name":{"40":{}},"parent":{}}],["getsettings",{"_index":1424,"name":{"1690":{}},"parent":{}}],["getsettingsfilejson",{"_index":709,"name":{"759":{}},"parent":{}}],["getspoolcontent",{"_index":3807,"name":{"5142":{}},"parent":{}}],["getspoolcontentbyid",{"_index":3808,"name":{"5143":{}},"parent":{}}],["getspoolcontentcommon",{"_index":3809,"name":{"5144":{}},"parent":{}}],["getspooldownloadfile",{"_index":3818,"name":{"5152":{}},"parent":{}}],["getspooldownloadfilepath",{"_index":3819,"name":{"5153":{}},"parent":{}}],["getspoolfiles",{"_index":3801,"name":{"5136":{}},"parent":{}}],["getspoolfilescommon",{"_index":3803,"name":{"5138":{}},"parent":{}}],["getspoolfilesforjob",{"_index":3802,"name":{"5137":{}},"parent":{}}],["getstatus",{"_index":3798,"name":{"5133":{}},"parent":{}}],["getstatuscommon",{"_index":3800,"name":{"5135":{}},"parent":{}}],["getstatusforjob",{"_index":3799,"name":{"5134":{}},"parent":{}}],["getstdinstream",{"_index":1886,"name":{"2261":{}},"parent":{}}],["getstreamed",{"_index":1192,"name":{"1395":{}},"parent":{}}],["getsubstitutionheaders",{"_index":3788,"name":{"5122":{}},"parent":{}}],["gettable",{"_index":340,"name":{"339":{}},"parent":{}}],["getteamconfig",{"_index":2276,"name":{"2927":{}},"parent":{}}],["getteamsubprofiles",{"_index":2299,"name":{"2951":{}},"parent":{}}],["gettempfile",{"_index":4151,"name":{"5659":{}},"parent":{}}],["gettextdisplayforplan",{"_index":2516,"name":{"3263":{}},"parent":{}}],["gettextdisplayforreport",{"_index":2515,"name":{"3262":{}},"parent":{}}],["gettimeout",{"_index":3105,"name":{"4220":{}},"parent":{}}],["getuserhomeenvironmentfilepath",{"_index":2117,"name":{"2719":{}},"parent":{}}],["getusernamefromauth",{"_index":1089,"name":{"1243":{},"1267":{},"1440":{}},"parent":{}}],["getvalueback",{"_index":2160,"name":{"2786":{}},"parent":{}}],["getvaluesback",{"_index":1217,"name":{"1452":{},"1466":{}},"parent":{}}],["getwfkey",{"_index":4252,"name":{"5797":{}},"parent":{}}],["getworkflowdefinition",{"_index":4231,"name":{"5765":{}},"parent":{}}],["getworkflowproperties",{"_index":4303,"name":{"5997":{}},"parent":{}}],["getworkflows",{"_index":4249,"name":{"5795":{}},"parent":{}}],["getzoslog",{"_index":3843,"name":{"5185":{},"5186":{}},"parent":{}}],["getzoslogvalidator",{"_index":3837,"name":{"5179":{}},"parent":{}}],["getzosmfinfo",{"_index":4351,"name":{"6050":{}},"parent":{}}],["getzowedir",{"_index":289,"name":{"295":{}},"parent":{}}],["getzowever",{"_index":2706,"name":{"3638":{}},"parent":{}}],["getzoweyargsresponse",{"_index":1909,"name":{"2294":{},"2316":{},"2362":{}},"parent":{}}],["gid",{"_index":3340,"name":{"4473":{}},"parent":{}}],["giveaccessonlytoowner",{"_index":394,"name":{"390":{}},"parent":{}}],["global",{"_index":610,"name":{"621":{},"820":{},"2814":{},"2819":{}},"parent":{}}],["global_group",{"_index":491,"name":{"491":{}},"parent":{}}],["grey",{"_index":1814,"name":{"2143":{},"2186":{}},"parent":{}}],["group",{"_index":192,"name":{"145":{},"151":{},"157":{},"163":{},"170":{},"176":{},"182":{},"187":{},"192":{},"196":{},"199":{},"202":{},"205":{},"207":{},"210":{},"213":{},"216":{},"219":{},"875":{},"1940":{},"1946":{},"1957":{},"2665":{},"2672":{},"2679":{},"2686":{},"2693":{},"2701":{},"4518":{},"4604":{},"5261":{},"5270":{},"5277":{},"5284":{},"5291":{},"5298":{},"5304":{},"5457":{},"5465":{},"5472":{},"5479":{},"5485":{},"5491":{},"5497":{},"6078":{},"6086":{},"6093":{},"6101":{},"6109":{},"6115":{},"6121":{},"6129":{},"6134":{}},"parent":{}}],["group_segment",{"_index":480,"name":{"480":{}},"parent":{}}],["group_segment_number",{"_index":484,"name":{"484":{}},"parent":{}}],["groupcommandyargs",{"_index":1913,"name":{"2298":{}},"parent":{}}],["groupnames",{"_index":4356,"name":{"6054":{}},"parent":{}}],["grouptooption",{"_index":1803,"name":{"2129":{},"2175":{}},"parent":{}}],["gui_available",{"_index":2369,"name":{"3041":{}},"parent":{}}],["guiresult",{"_index":2368,"name":{"3040":{}},"parent":{}}],["handlehandlererror",{"_index":1889,"name":{"2264":{}},"parent":{}}],["handlepromptforauthtoken",{"_index":2716,"name":{"3649":{}},"parent":{}}],["handler",{"_index":301,"name":{"306":{},"918":{},"1149":{},"2653":{},"3464":{},"3471":{},"3479":{},"3486":{},"3493":{},"3501":{},"3510":{},"3518":{},"3528":{},"3537":{},"3547":{},"3670":{},"3684":{},"3695":{},"3707":{},"3719":{}},"parent":{}}],["handlerresponse",{"_index":2547,"name":{"3362":{}},"parent":{}}],["handshaketimeout",{"_index":4023,"name":{"5446":{},"5509":{},"5564":{}},"parent":{}}],["hascalledworkflow",{"_index":4276,"name":{"5843":{},"5950":{}},"parent":{}}],["hasdirs",{"_index":3569,"name":{"4815":{}},"parent":{}}],["hash",{"_index":1029,"name":{"1163":{}},"parent":{}}],["hasquerystring",{"_index":1202,"name":{"1405":{}},"parent":{}}],["hasvalidschema",{"_index":2284,"name":{"2935":{}},"parent":{}}],["hdelete",{"_index":3463,"name":{"4674":{}},"parent":{}}],["hdr_prof_reqs",{"_index":2544,"name":{"3353":{}},"parent":{}}],["header",{"_index":119,"name":{"89":{},"1114":{}},"parent":{}}],["headers",{"_index":1025,"name":{"1155":{},"1184":{},"1290":{}},"parent":{}}],["headerstr",{"_index":2788,"name":{"3810":{}},"parent":{}}],["help",{"_index":1879,"name":{"2252":{}},"parent":{}}],["help_examples",{"_index":496,"name":{"496":{}},"parent":{}}],["help_indent",{"_index":1816,"name":{"2145":{}},"parent":{}}],["help_option",{"_index":494,"name":{"494":{}},"parent":{}}],["help_option_alias",{"_index":495,"name":{"495":{}},"parent":{}}],["help_web_option",{"_index":497,"name":{"497":{}},"parent":{}}],["help_web_option_alias",{"_index":498,"name":{"498":{}},"parent":{}}],["helpconstants",{"_index":2543,"name":{"3352":{}},"parent":{}}],["helpgenerator",{"_index":1776,"name":{"2097":{},"2247":{}},"parent":{}}],["helpgeneratorfactory",{"_index":1904,"name":{"2287":{},"2309":{},"2326":{},"2354":{},"2468":{},"3354":{}},"parent":{}}],["hidden",{"_index":805,"name":{"873":{},"5358":{}},"parent":{}}],["hidetext",{"_index":858,"name":{"943":{}},"parent":{}}],["highlightmatches",{"_index":344,"name":{"343":{}},"parent":{}}],["highlightwithprimarycolor",{"_index":2124,"name":{"2732":{}},"parent":{}}],["highlightwithsecondarycolor",{"_index":2125,"name":{"2734":{}},"parent":{}}],["hmigrate",{"_index":3458,"name":{"4668":{}},"parent":{}}],["hold",{"_index":3694,"name":{"4988":{}},"parent":{}}],["homedir",{"_index":618,"name":{"629":{}},"parent":{}}],["homepageurl",{"_index":47,"name":{"35":{}},"parent":{}}],["host",{"_index":254,"name":{"248":{},"1178":{},"5542":{},"6158":{}},"parent":{}}],["hostname",{"_index":1027,"name":{"1156":{},"1210":{},"1462":{},"5440":{},"5692":{},"5844":{},"5951":{}},"parent":{}}],["hostpackagename",{"_index":2351,"name":{"3021":{}},"parent":{}}],["hrecall",{"_index":3598,"name":{"4859":{}},"parent":{}}],["http_protocol",{"_index":1050,"name":{"1195":{}},"parent":{}}],["http_protocol_choices",{"_index":1052,"name":{"1197":{}},"parent":{}}],["http_status_200",{"_index":1124,"name":{"1309":{}},"parent":{}}],["http_status_201",{"_index":1126,"name":{"1310":{}},"parent":{}}],["http_status_202",{"_index":1127,"name":{"1311":{}},"parent":{}}],["http_status_204",{"_index":1128,"name":{"1312":{}},"parent":{}}],["http_status_300",{"_index":1129,"name":{"1313":{}},"parent":{}}],["http_status_400",{"_index":1130,"name":{"1314":{}},"parent":{}}],["http_status_401",{"_index":1131,"name":{"1315":{}},"parent":{}}],["http_status_404",{"_index":1132,"name":{"1316":{}},"parent":{}}],["http_status_500",{"_index":1133,"name":{"1317":{}},"parent":{}}],["http_verb",{"_index":1023,"name":{"1152":{}},"parent":{}}],["httpmethod",{"_index":4181,"name":{"5693":{},"5845":{},"5952":{}},"parent":{}}],["httpproxyname",{"_index":4363,"name":{"6061":{}},"parent":{}}],["https_protocol",{"_index":1051,"name":{"1196":{}},"parent":{}}],["httpstatus",{"_index":1042,"name":{"1176":{}},"parent":{}}],["iactiveworkflows",{"_index":4243,"name":{"5784":{}},"parent":{}}],["iaddproftyperesult",{"_index":2249,"name":{"2898":{}},"parent":{}}],["ialtprofile",{"_index":55,"name":{"42":{}},"parent":{}}],["iapimlprofileinfo",{"_index":11,"name":{"6":{}},"parent":{}}],["iapimlservice",{"_index":34,"name":{"25":{}},"parent":{}}],["iapimlserviceapiinfo",{"_index":20,"name":{"13":{}},"parent":{}}],["iapimlserviceauthentication",{"_index":29,"name":{"21":{}},"parent":{}}],["iapimlsvcattrs",{"_index":1298,"name":{"1550":{}},"parent":{}}],["iapimlsvcattrsloaded",{"_index":7,"name":{"3":{}},"parent":{}}],["iarchivedworkflow",{"_index":4123,"name":{"5619":{}},"parent":{}}],["iarchivedworkflows",{"_index":4238,"name":{"5780":{}},"parent":{}}],["iargteamconfigloc",{"_index":2191,"name":{"2820":{}},"parent":{}}],["iauthhandlerapi",{"_index":1234,"name":{"1473":{}},"parent":{}}],["iautoinitrpt",{"_index":72,"name":{"59":{}},"parent":{}}],["iautomationstatus",{"_index":4253,"name":{"5798":{}},"parent":{}}],["ibaseprofileoverride",{"_index":60,"name":{"46":{}},"parent":{}}],["ibm",{"_index":87,"name":{"71":{},"73":{},"75":{},"77":{},"79":{},"81":{},"83":{},"85":{},"87":{},"91":{},"93":{},"95":{},"97":{},"104":{},"106":{},"108":{},"110":{},"117":{}},"parent":{}}],["icanceljob",{"_index":3652,"name":{"4924":{}},"parent":{}}],["icanceljobparms",{"_index":3650,"name":{"4920":{}},"parent":{}}],["ichainedhandlerargumentmapping",{"_index":292,"name":{"298":{}},"parent":{}}],["ichainedhandlerentry",{"_index":300,"name":{"305":{}},"parent":{}}],["icliloadallprofiles",{"_index":1939,"name":{"2376":{}},"parent":{}}],["icliloadprofile",{"_index":1934,"name":{"2370":{}},"parent":{}}],["icollectedresponses",{"_index":3956,"name":{"5362":{}},"parent":{}}],["icollectparms",{"_index":3026,"name":{"4136":{}},"parent":{}}],["icommandarguments",{"_index":999,"name":{"1124":{}},"parent":{}}],["icommanddefinition",{"_index":828,"name":{"907":{}},"parent":{}}],["icommanddefinitionpasson",{"_index":821,"name":{"898":{}},"parent":{}}],["icommanddefinitionpassonignore",{"_index":819,"name":{"895":{}},"parent":{}}],["icommandexampledefinition",{"_index":794,"name":{"858":{}},"parent":{}}],["icommandhandler",{"_index":1010,"name":{"1136":{}},"parent":{}}],["icommandhandlerconstructor",{"_index":1013,"name":{"1138":{}},"parent":{}}],["icommandhandlerrequire",{"_index":1015,"name":{"1140":{}},"parent":{}}],["icommandhandlerresponsechecker",{"_index":2534,"name":{"3334":{}},"parent":{}}],["icommandhandlerresponsevalidator",{"_index":2536,"name":{"3336":{}},"parent":{}}],["icommandloadprofile",{"_index":1747,"name":{"2061":{}},"parent":{}}],["icommandnodetype",{"_index":845,"name":{"929":{}},"parent":{}}],["icommandoptionallowablevalues",{"_index":796,"name":{"862":{}},"parent":{}}],["icommandoptiondefinition",{"_index":803,"name":{"868":{}},"parent":{}}],["icommandoptionvalueimplications",{"_index":799,"name":{"865":{}},"parent":{}}],["icommandoutputformat",{"_index":990,"name":{"1110":{}},"parent":{}}],["icommandpositionaldefinition",{"_index":816,"name":{"888":{}},"parent":{}}],["icommandprepared",{"_index":1770,"name":{"2088":{}},"parent":{}}],["icommandprocessorparms",{"_index":1774,"name":{"2095":{}},"parent":{}}],["icommandprofile",{"_index":825,"name":{"903":{}},"parent":{}}],["icommandprofileauthconfig",{"_index":1020,"name":{"1147":{}},"parent":{}}],["icommandprofileautoinitconfig",{"_index":2086,"name":{"2652":{}},"parent":{}}],["icommandprofileloaderparms",{"_index":1751,"name":{"2067":{}},"parent":{}}],["icommandprofileproperty",{"_index":2528,"name":{"3318":{}},"parent":{}}],["icommandprofileschema",{"_index":2531,"name":{"3326":{}},"parent":{}}],["icommandprofiletypeconfiguration",{"_index":1742,"name":{"2051":{}},"parent":{}}],["icommandresponse",{"_index":1643,"name":{"1908":{}},"parent":{}}],["icommandresponseapi",{"_index":1646,"name":{"1916":{}},"parent":{}}],["icommandresponseparms",{"_index":1655,"name":{"1926":{}},"parent":{}}],["icommandtreeentry",{"_index":1457,"name":{"1725":{}},"parent":{}}],["icommandvalidatorerror",{"_index":1704,"name":{"2009":{}},"parent":{}}],["icommandvalidatorresponse",{"_index":1472,"name":{"1738":{}},"parent":{}}],["icommonjobparms",{"_index":3696,"name":{"4990":{}},"parent":{}}],["iconfig",{"_index":599,"name":{"609":{}},"parent":{}}],["iconfigautostorefindactiveprofileopts",{"_index":1253,"name":{"1491":{}},"parent":{}}],["iconfigautostorefindauthhandlerforprofileopts",{"_index":1259,"name":{"1496":{}},"parent":{}}],["iconfigautostorestoresesscfgpropsopts",{"_index":1264,"name":{"1505":{}},"parent":{}}],["iconfigbuilderopts",{"_index":2157,"name":{"2784":{}},"parent":{}}],["iconfigconvertresult",{"_index":2161,"name":{"2787":{}},"parent":{}}],["iconfiglayer",{"_index":606,"name":{"617":{}},"parent":{}}],["iconfiglogging",{"_index":325,"name":{"327":{}},"parent":{}}],["iconfigmergeopts",{"_index":752,"name":{"806":{}},"parent":{}}],["iconfigopts",{"_index":617,"name":{"628":{}},"parent":{}}],["iconfigprofile",{"_index":594,"name":{"602":{}},"parent":{}}],["iconfigschema",{"_index":730,"name":{"782":{}},"parent":{}}],["iconfigschemainfo",{"_index":733,"name":{"789":{}},"parent":{}}],["iconfigsecure",{"_index":625,"name":{"635":{}},"parent":{}}],["iconfigsecureproperties",{"_index":623,"name":{"633":{}},"parent":{}}],["iconfigupdateschemahelperoptions",{"_index":743,"name":{"798":{}},"parent":{}}],["iconfigupdateschemaoptions",{"_index":739,"name":{"794":{}},"parent":{}}],["iconfigupdateschemapaths",{"_index":738,"name":{"793":{}},"parent":{}}],["iconfigvault",{"_index":611,"name":{"623":{}},"parent":{}}],["iconsole",{"_index":406,"name":{"402":{}},"parent":{}}],["iconsoleparms",{"_index":3022,"name":{"4133":{}},"parent":{}}],["iconsoleresponse",{"_index":3031,"name":{"4142":{}},"parent":{}}],["iconstructor",{"_index":351,"name":{"350":{}},"parent":{}}],["icopydatasetoptions",{"_index":3572,"name":{"4819":{}},"parent":{}}],["icreatedatasetoptions",{"_index":3346,"name":{"4480":{}},"parent":{}}],["icreatedworkflow",{"_index":4142,"name":{"5641":{}},"parent":{}}],["icreatedworkflowlocal",{"_index":4144,"name":{"5647":{}},"parent":{}}],["icreateussoptions",{"_index":3362,"name":{"4499":{}},"parent":{}}],["icreatevsamoptions",{"_index":3364,"name":{"4503":{}},"parent":{}}],["icreateworkflow",{"_index":4134,"name":{"5630":{}},"parent":{}}],["icreatezfsoptions",{"_index":3369,"name":{"4516":{}},"parent":{}}],["icredentialmanagerconstructor",{"_index":710,"name":{"760":{}},"parent":{}}],["icredentialmanagerinit",{"_index":661,"name":{"683":{}},"parent":{}}],["icredentialmanagernamemap",{"_index":689,"name":{"742":{}},"parent":{}}],["icrosslparcopydatasetoptions",{"_index":3576,"name":{"4824":{}},"parent":{}}],["id",{"_index":1835,"name":{"2188":{},"3806":{},"3866":{},"3938":{},"3944":{},"3954":{},"3957":{},"3958":{},"3960":{},"4039":{},"4055":{},"4058":{},"4067":{},"4075":{},"4107":{},"4968":{},"5066":{},"5076":{},"5817":{}},"parent":{}}],["idaemoncontext",{"_index":1300,"name":{"1554":{}},"parent":{}}],["idaemonrequest",{"_index":567,"name":{"577":{}},"parent":{}}],["idaemonresponse",{"_index":575,"name":{"584":{}},"parent":{}}],["idataset",{"_index":3321,"name":{"4435":{}},"parent":{}}],["idefinedsystem",{"_index":4353,"name":{"6052":{}},"parent":{}}],["ideletedatasetoptions",{"_index":3589,"name":{"4841":{}},"parent":{}}],["ideletejobparms",{"_index":3664,"name":{"4943":{}},"parent":{}}],["ideleteoptions",{"_index":3460,"name":{"4670":{}},"parent":{}}],["ideleteprofile",{"_index":2443,"name":{"3155":{}},"parent":{}}],["ideletevsamoptions",{"_index":3591,"name":{"4844":{}},"parent":{}}],["ideletevsamresponse",{"_index":3594,"name":{"4848":{}},"parent":{}}],["idiffnameoptions",{"_index":2381,"name":{"3051":{}},"parent":{}}],["idiffoptions",{"_index":2385,"name":{"3054":{}},"parent":{}}],["idownloadallspoolcontentparms",{"_index":3672,"name":{"4952":{}},"parent":{}}],["idownloaddsmresult",{"_index":3515,"name":{"4742":{}},"parent":{}}],["idownloadoptions",{"_index":3509,"name":{"4734":{}},"parent":{}}],["idownloadsingleoptions",{"_index":3503,"name":{"4718":{}},"parent":{}}],["idownloadspoolcontentparms",{"_index":3684,"name":{"4975":{}},"parent":{}}],["idownloadussdirresult",{"_index":3522,"name":{"4748":{}},"parent":{}}],["idsmlistoptions",{"_index":3402,"name":{"4584":{}},"parent":{}}],["iexplanationmap",{"_index":328,"name":{"329":{}},"parent":{}}],["iextendersjsonopts",{"_index":2246,"name":{"2895":{}},"parent":{}}],["iextendertypeinfo",{"_index":2252,"name":{"2902":{}},"parent":{}}],["if_match",{"_index":150,"name":{"112":{}},"parent":{}}],["if_none_match",{"_index":149,"name":{"111":{}},"parent":{}}],["ifsoptions",{"_index":3406,"name":{"4589":{}},"parent":{}}],["igetallprofilesoptions",{"_index":2239,"name":{"2887":{}},"parent":{}}],["igetitemopts",{"_index":2689,"name":{"3622":{}},"parent":{}}],["igetitemval",{"_index":2684,"name":{"3618":{}},"parent":{}}],["igetjobsparms",{"_index":3698,"name":{"4993":{}},"parent":{}}],["igetoptions",{"_index":3453,"name":{"4656":{}},"parent":{}}],["igetworkflowsoptions",{"_index":4245,"name":{"5786":{}},"parent":{}}],["ignoredkeys",{"_index":331,"name":{"331":{},"1538":{},"1540":{},"3871":{},"3874":{},"3880":{},"3884":{},"3894":{},"3897":{},"3900":{},"3922":{},"3925":{},"3970":{},"3975":{},"3979":{},"3983":{},"3986":{},"4001":{},"4005":{},"4027":{},"4030":{},"4045":{},"4049":{},"4061":{},"4073":{},"4084":{},"4097":{}},"parent":{}}],["ignorenode",{"_index":2010,"name":{"2461":{}},"parent":{}}],["ignorenodes",{"_index":824,"name":{"901":{}},"parent":{}}],["ihandlerformatoutputapi",{"_index":994,"name":{"1116":{}},"parent":{}}],["ihandlerparameters",{"_index":1003,"name":{"1127":{}},"parent":{}}],["ihandlerprogressapi",{"_index":986,"name":{"1107":{}},"parent":{}}],["ihandlerresponseapi",{"_index":997,"name":{"1119":{}},"parent":{}}],["ihandlerresponseconsoleapi",{"_index":862,"name":{"946":{}},"parent":{}}],["ihandlerresponsedataapi",{"_index":865,"name":{"951":{}},"parent":{}}],["iheadercontent",{"_index":79,"name":{"65":{},"1153":{}},"parent":{}}],["ihelpgenerator",{"_index":1767,"name":{"2086":{}},"parent":{}}],["ihelpgeneratorfactory",{"_index":1915,"name":{"2320":{}},"parent":{}}],["ihelpgeneratorfactoryparms",{"_index":1790,"name":{"2114":{}},"parent":{}}],["ihelpgeneratorparms",{"_index":1785,"name":{"2109":{}},"parent":{}}],["ihttpsoptions",{"_index":1024,"name":{"1154":{}},"parent":{}}],["iimperativeapi",{"_index":1338,"name":{"1592":{}},"parent":{}}],["iimperativeauthgroupconfig",{"_index":2072,"name":{"2627":{}},"parent":{}}],["iimperativeconfig",{"_index":2320,"name":{"2974":{}},"parent":{}}],["iimperativeenvironmentalvariablesetting",{"_index":460,"name":{"462":{}},"parent":{}}],["iimperativeenvironmentalvariablesettings",{"_index":463,"name":{"465":{}},"parent":{}}],["iimperativeerror",{"_index":305,"name":{"309":{}},"parent":{}}],["iimperativeerrorparms",{"_index":2595,"name":{"3435":{}},"parent":{}}],["iimperativeloggingconfig",{"_index":1303,"name":{"1558":{}},"parent":{}}],["iimperativelogsconfig",{"_index":2315,"name":{"2970":{}},"parent":{}}],["iimperativeoverrides",{"_index":660,"name":{"682":{}},"parent":{}}],["iinvokecommandparms",{"_index":1772,"name":{"2091":{}},"parent":{}}],["iissueparms",{"_index":3038,"name":{"4150":{}},"parent":{}}],["iissueresponse",{"_index":3964,"name":{"5372":{}},"parent":{}}],["iissuetsoparms",{"_index":3898,"name":{"5239":{}},"parent":{}}],["ijob",{"_index":3639,"name":{"4904":{}},"parent":{}}],["ijobcomplete",{"_index":3732,"name":{"5049":{}},"parent":{}}],["ijoberror",{"_index":3736,"name":{"5059":{}},"parent":{}}],["ijobfeedback",{"_index":3654,"name":{"4927":{}},"parent":{}}],["ijobfile",{"_index":3676,"name":{"4960":{}},"parent":{}}],["ijobfiles",{"_index":4264,"name":{"5816":{}},"parent":{}}],["ijobfilesimple",{"_index":3739,"name":{"5065":{}},"parent":{}}],["ijobinfo",{"_index":4266,"name":{"5824":{}},"parent":{}}],["ijobstatus",{"_index":4261,"name":{"5807":{}},"parent":{}}],["ijobstepdata",{"_index":3631,"name":{"4897":{}},"parent":{}}],["ijobsubmit",{"_index":3741,"name":{"5070":{}},"parent":{}}],["ilistoptions",{"_index":3410,"name":{"4594":{}},"parent":{}}],["iloadallprofiles",{"_index":2446,"name":{"3158":{}},"parent":{}}],["iloadprofile",{"_index":2448,"name":{"3161":{}},"parent":{}}],["ilog4jsappender",{"_index":316,"name":{"319":{}},"parent":{}}],["ilog4jsconfig",{"_index":319,"name":{"322":{}},"parent":{}}],["ilog4jslayout",{"_index":313,"name":{"316":{}},"parent":{}}],["imessagedefinition",{"_index":1475,"name":{"1740":{}},"parent":{}}],["imetaprofile",{"_index":2403,"name":{"3072":{}},"parent":{}}],["imigrateoptions",{"_index":3455,"name":{"4665":{}},"parent":{}}],["imodifyjob",{"_index":3687,"name":{"4980":{}},"parent":{}}],["imodifyjoboptions",{"_index":3691,"name":{"4986":{}},"parent":{}}],["imodifyjobparms",{"_index":3689,"name":{"4983":{}},"parent":{}}],["imonitorjobwaitforparms",{"_index":3704,"name":{"5002":{}},"parent":{}}],["imountfsmode",{"_index":3600,"name":{"4861":{}},"parent":{}}],["imountfsoptions",{"_index":3601,"name":{"4862":{}},"parent":{}}],["impconfig",{"_index":1386,"name":{"1642":{}},"parent":{}}],["impconfigpropnm",{"_index":1434,"name":{"1701":{}},"parent":{}}],["impdependency",{"_index":1388,"name":{"1644":{}},"parent":{}}],["imperative",{"_index":2119,"name":{"2721":{}},"parent":{}}],["imperative_default_home",{"_index":474,"name":{"474":{}},"parent":{}}],["imperative_directory",{"_index":475,"name":{"475":{}},"parent":{}}],["imperative_log_level_key_suffix",{"_index":536,"name":{"536":{}},"parent":{}}],["imperative_pkg_name",{"_index":1370,"name":{"1626":{}},"parent":{}}],["imperativeapi",{"_index":1342,"name":{"1595":{}},"parent":{}}],["imperativeconfig",{"_index":2344,"name":{"3006":{}},"parent":{}}],["imperativeerror",{"_index":2597,"name":{"3438":{}},"parent":{}}],["imperativeexpect",{"_index":353,"name":{"352":{}},"parent":{}}],["imperativehelpgeneratorfactory",{"_index":2049,"name":{"2576":{}},"parent":{}}],["imperativelogger",{"_index":1339,"name":{"1593":{},"1603":{}},"parent":{}}],["imperativelogging",{"_index":2316,"name":{"2971":{}},"parent":{}}],["imperativeloglevel",{"_index":464,"name":{"466":{}},"parent":{}}],["imperativepackagename",{"_index":2352,"name":{"3022":{}},"parent":{}}],["imperativeprofilemanagerfactory",{"_index":2060,"name":{"2593":{}},"parent":{}}],["imperativereject",{"_index":349,"name":{"348":{}},"parent":{}}],["imperativeyargscommandaction",{"_index":1894,"name":{"2272":{}},"parent":{}}],["implicationalternativeerror",{"_index":1727,"name":{"2036":{}},"parent":{}}],["impliedoptionnames",{"_index":800,"name":{"866":{}},"parent":{}}],["implies",{"_index":807,"name":{"878":{},"2694":{}},"parent":{}}],["impliesoneof",{"_index":808,"name":{"879":{}},"parent":{}}],["implogger",{"_index":1435,"name":{"1702":{},"3553":{}},"parent":{}}],["importdefinition",{"_index":2618,"name":{"3515":{}},"parent":{}}],["importhandler",{"_index":2651,"name":{"3581":{}},"parent":{}}],["improperrejectunauthorized",{"_index":4336,"name":{"6034":{}},"parent":{}}],["in_progress",{"_index":871,"name":{"956":{}},"parent":{}}],["includehidden",{"_index":3514,"name":{"4741":{},"4787":{}},"parent":{}}],["includeintemplate",{"_index":258,"name":{"251":{},"259":{},"264":{},"268":{},"559":{},"3325":{},"5316":{},"5323":{},"5330":{},"5548":{},"6164":{}},"parent":{}}],["indent",{"_index":589,"name":{"598":{},"3626":{}},"parent":{}}],["indentlines",{"_index":343,"name":{"342":{}},"parent":{}}],["info",{"_index":411,"name":{"406":{},"432":{},"2901":{},"3426":{},"3963":{},"4092":{},"4093":{},"4098":{},"4099":{},"4108":{},"6011":{}},"parent":{}}],["infomessages",{"_index":907,"name":{"988":{},"1050":{},"1081":{}},"parent":{}}],["init",{"_index":1440,"name":{"1708":{},"2726":{},"3555":{}},"parent":{}}],["initappsettings",{"_index":2127,"name":{"2742":{}},"parent":{}}],["initdefinition",{"_index":2606,"name":{"3468":{}},"parent":{}}],["initfordryrun",{"_index":2659,"name":{"3592":{}},"parent":{}}],["inithandler",{"_index":2655,"name":{"3587":{}},"parent":{}}],["initialize",{"_index":650,"name":{"668":{},"695":{},"730":{},"738":{},"1680":{},"2394":{},"3267":{}},"parent":{}}],["initialized",{"_index":688,"name":{"741":{},"1686":{}},"parent":{}}],["initimputils",{"_index":2289,"name":{"2940":{}},"parent":{}}],["initlogger",{"_index":2588,"name":{"3419":{}},"parent":{}}],["initlogging",{"_index":2128,"name":{"2743":{}},"parent":{}}],["initprofiles",{"_index":2129,"name":{"2744":{}},"parent":{}}],["initsesscfg",{"_index":2287,"name":{"2938":{}},"parent":{}}],["initstatus",{"_index":2589,"name":{"3420":{}},"parent":{}}],["initwithschema",{"_index":2658,"name":{"3591":{}},"parent":{}}],["input",{"_index":2883,"name":{"3912":{},"4104":{}},"parent":{}}],["inschema",{"_index":2201,"name":{"2831":{}},"parent":{}}],["insertcliargumentsintoprofile",{"_index":1955,"name":{"2392":{}},"parent":{}}],["insertdependenciesintoprofilefromcliarguments",{"_index":1956,"name":{"2393":{}},"parent":{}}],["install",{"_index":2634,"name":{"3562":{}},"parent":{}}],["installdefinition",{"_index":2730,"name":{"3665":{}},"parent":{}}],["installedplugins",{"_index":1407,"name":{"1662":{}},"parent":{}}],["installhandler",{"_index":2733,"name":{"3675":{}},"parent":{}}],["installpackages",{"_index":2629,"name":{"3557":{}},"parent":{}}],["instance",{"_index":449,"name":{"449":{},"1624":{},"1663":{},"1685":{},"1694":{},"2219":{},"3016":{},"3065":{},"3554":{}},"parent":{}}],["instances",{"_index":49,"name":{"37":{}},"parent":{}}],["instances_resource",{"_index":2811,"name":{"3835":{}},"parent":{}}],["instructions",{"_index":2871,"name":{"3905":{},"5694":{},"5846":{},"5953":{}},"parent":{}}],["instructionssub",{"_index":4182,"name":{"5695":{},"5847":{},"5954":{}},"parent":{}}],["internal",{"_index":3657,"name":{"4936":{}},"parent":{}}],["internalreaderlrecl",{"_index":3712,"name":{"5011":{},"5019":{}},"parent":{}}],["internalreaderrecfm",{"_index":3711,"name":{"5010":{},"5018":{}},"parent":{}}],["intrdr",{"_index":88,"name":{"71":{},"73":{},"75":{},"77":{},"79":{}},"parent":{}}],["invalid_prof_loc_type",{"_index":2222,"name":{"2850":{}},"parent":{}}],["invalidalcunitoption",{"_index":3199,"name":{"4313":{}},"parent":{}}],["invalidattributessyntax",{"_index":3249,"name":{"4363":{}},"parent":{}}],["invalidcredentialmanager",{"_index":682,"name":{"723":{}},"parent":{}}],["invaliddsntypeoption",{"_index":3197,"name":{"4311":{}},"parent":{}}],["invaliddsorgoption",{"_index":3203,"name":{"4317":{}},"parent":{}}],["invalidfilename",{"_index":3317,"name":{"4431":{}},"parent":{}}],["invalidfilescreateoption",{"_index":3195,"name":{"4309":{}},"parent":{}}],["invalidfilesmountoption",{"_index":3271,"name":{"4385":{}},"parent":{}}],["invalidhostname",{"_index":4332,"name":{"6030":{}},"parent":{}}],["invalidjsonstring",{"_index":1716,"name":{"2024":{}},"parent":{}}],["invalidmountmodeoption",{"_index":3275,"name":{"4389":{}},"parent":{}}],["invalidonfailure",{"_index":664,"name":{"687":{}},"parent":{}}],["invalidoptionerror",{"_index":1732,"name":{"2041":{}},"parent":{}}],["invalidpermsoption",{"_index":3261,"name":{"4375":{}},"parent":{}}],["invalidpodsorgdirblkcombination",{"_index":3209,"name":{"4323":{}},"parent":{}}],["invalidport",{"_index":4334,"name":{"6032":{}},"parent":{}}],["invalidpsdsorgdirblkcombination",{"_index":3207,"name":{"4321":{}},"parent":{}}],["invalidrecfmoption",{"_index":3205,"name":{"4319":{}},"parent":{}}],["invalidsyntaxnotification",{"_index":1883,"name":{"2257":{}},"parent":{}}],["invoke",{"_index":1881,"name":{"2255":{},"4582":{}},"parent":{}}],["invokehandlers",{"_index":1900,"name":{"2277":{}},"parent":{}}],["io",{"_index":373,"name":{"370":{}},"parent":{}}],["ioperationcompleted",{"_index":945,"name":{"1031":{}},"parent":{}}],["ioperationresult",{"_index":951,"name":{"1037":{}},"parent":{}}],["ioperationresultready",{"_index":949,"name":{"1035":{}},"parent":{}}],["ioperationundocompleted",{"_index":947,"name":{"1033":{}},"parent":{}}],["ioptionformat",{"_index":544,"name":{"543":{}},"parent":{}}],["ioptions",{"_index":3328,"name":{"4440":{}},"parent":{}}],["ioptionsforaddconnprops",{"_index":1211,"name":{"1447":{}},"parent":{}}],["ioptionsfullresponse",{"_index":1031,"name":{"1165":{},"4449":{}},"parent":{}}],["ioverridepromptconnprops",{"_index":1206,"name":{"1443":{}},"parent":{}}],["ipartialcommanddefinition",{"_index":1018,"name":{"1142":{}},"parent":{}}],["iperformactionresponse",{"_index":2974,"name":{"4054":{}},"parent":{}}],["ipingresponse",{"_index":3969,"name":{"5379":{}},"parent":{}}],["iplugincfgprops",{"_index":1383,"name":{"1639":{}},"parent":{}}],["ipluginissue",{"_index":1390,"name":{"1646":{}},"parent":{}}],["ipluginissues",{"_index":1389,"name":{"1645":{}},"parent":{}}],["ipluginjson",{"_index":1398,"name":{"1653":{}},"parent":{}}],["ipluginjsonobject",{"_index":1394,"name":{"1649":{}},"parent":{}}],["ipluginpeerdepends",{"_index":1379,"name":{"1636":{}},"parent":{}}],["iprobtest",{"_index":2679,"name":{"3613":{}},"parent":{}}],["iprofargattrs",{"_index":2195,"name":{"2825":{}},"parent":{}}],["iprofargvalue",{"_index":2203,"name":{"2833":{}},"parent":{}}],["iprofattrs",{"_index":2204,"name":{"2834":{}},"parent":{}}],["iprofdatatype",{"_index":2202,"name":{"2832":{}},"parent":{}}],["iprofile",{"_index":1983,"name":{"2430":{}},"parent":{}}],["iprofiledeleted",{"_index":2477,"name":{"3219":{}},"parent":{}}],["iprofiledependency",{"_index":561,"name":{"568":{}},"parent":{}}],["iprofileinitialized",{"_index":2480,"name":{"3223":{}},"parent":{}}],["iprofileloaded",{"_index":1985,"name":{"2432":{}},"parent":{}}],["iprofilemanager",{"_index":2450,"name":{"3167":{}},"parent":{}}],["iprofilemanagerfactory",{"_index":2441,"name":{"3153":{}},"parent":{}}],["iprofilemanagerinit",{"_index":2453,"name":{"3174":{}},"parent":{}}],["iprofileproperty",{"_index":556,"name":{"554":{}},"parent":{}}],["iprofilerpt",{"_index":66,"name":{"51":{}},"parent":{}}],["iprofilesaved",{"_index":2482,"name":{"3225":{}},"parent":{}}],["iprofileschema",{"_index":558,"name":{"560":{}},"parent":{}}],["iprofiletypeconfiguration",{"_index":563,"name":{"572":{}},"parent":{}}],["iprofileupdated",{"_index":2485,"name":{"3230":{}},"parent":{}}],["iprofilevalidated",{"_index":2487,"name":{"3234":{}},"parent":{}}],["iprofilevalidationplan",{"_index":2507,"name":{"3255":{}},"parent":{}}],["iprofilevalidationreport",{"_index":2502,"name":{"3250":{}},"parent":{}}],["iprofilevalidationtask",{"_index":2489,"name":{"3236":{}},"parent":{}}],["iprofilevalidationtaskfunction",{"_index":2495,"name":{"3243":{}},"parent":{}}],["iprofilevalidationtaskresult",{"_index":2497,"name":{"3245":{}},"parent":{}}],["iprofinfoerrparms",{"_index":2215,"name":{"2844":{}},"parent":{}}],["iprofinforemoveknownpropcommonopts",{"_index":2244,"name":{"2893":{}},"parent":{}}],["iprofinforemoveknownpropopts",{"_index":2242,"name":{"2889":{}},"parent":{}}],["iprofinfoupdateknownpropopts",{"_index":2234,"name":{"2877":{}},"parent":{}}],["iprofinfoupdatepropcommonopts",{"_index":2237,"name":{"2883":{}},"parent":{}}],["iprofinfoupdatepropopts",{"_index":2231,"name":{"2870":{}},"parent":{}}],["iprofloc",{"_index":2182,"name":{"2808":{}},"parent":{}}],["iproflocosloc",{"_index":2189,"name":{"2815":{}},"parent":{}}],["iproflocosloclayer",{"_index":2187,"name":{"2812":{}},"parent":{}}],["iprofmergeargopts",{"_index":2208,"name":{"2839":{}},"parent":{}}],["iprofmergedarg",{"_index":2211,"name":{"2841":{}},"parent":{}}],["iprofopts",{"_index":2172,"name":{"2798":{}},"parent":{}}],["iprogressbarparms",{"_index":981,"name":{"1103":{}},"parent":{}}],["ipromisewithprogress",{"_index":881,"name":{"964":{}},"parent":{}}],["ipromptoptions",{"_index":857,"name":{"942":{}},"parent":{}}],["ipromptvariable",{"_index":2949,"name":{"4010":{}},"parent":{}}],["ipropertiesinput",{"_index":2997,"name":{"4100":{}},"parent":{}}],["ipropertymapping",{"_index":4161,"name":{"5669":{}},"parent":{}}],["iprovisionedinstance",{"_index":2892,"name":{"3926":{}},"parent":{}}],["iprovisionedinstanceactions",{"_index":2869,"name":{"3901":{}},"parent":{}}],["iprovisionedinstances",{"_index":2938,"name":{"3996":{}},"parent":{}}],["iprovisionedinstancevariable",{"_index":2860,"name":{"3887":{}},"parent":{}}],["iprovisionedinstancevariables",{"_index":2932,"name":{"3991":{}},"parent":{}}],["iprovisionoptionals",{"_index":2999,"name":{"4103":{}},"parent":{}}],["iprovisiontemplateresponse",{"_index":2993,"name":{"4090":{}},"parent":{}}],["ipublishedtemplate",{"_index":2837,"name":{"3859":{}},"parent":{}}],["ipublishedtemplateinfo",{"_index":2965,"name":{"4032":{}},"parent":{}}],["ipublishedtemplates",{"_index":2849,"name":{"3875":{}},"parent":{}}],["iqueuedmessage",{"_index":402,"name":{"398":{}},"parent":{}}],["irecalloptions",{"_index":3597,"name":{"4858":{}},"parent":{}}],["irestclienterror",{"_index":1041,"name":{"1175":{}},"parent":{}}],["irestclientresponse",{"_index":1098,"name":{"1272":{},"4459":{}},"parent":{}}],["irestoptions",{"_index":1103,"name":{"1280":{}},"parent":{}}],["is",{"_index":2872,"name":{"3906":{}},"parent":{}}],["isaveprofile",{"_index":2456,"name":{"3178":{}},"parent":{}}],["isaveprofilefromcliargs",{"_index":2461,"name":{"3185":{}},"parent":{}}],["iscallable",{"_index":4225,"name":{"5755":{},"5912":{}},"parent":{}}],["iscasesensitive",{"_index":802,"name":{"867":{}},"parent":{}}],["ischained",{"_index":1009,"name":{"1135":{}},"parent":{}}],["isconditionstep",{"_index":4183,"name":{"5696":{},"5848":{},"5955":{}},"parent":{}}],["iscredentialmanagerinappsettings",{"_index":2314,"name":{"2969":{}},"parent":{}}],["isdatasetnamecontainmasking",{"_index":3475,"name":{"4685":{}},"parent":{}}],["isdebugenabled",{"_index":432,"name":{"426":{}},"parent":{}}],["isdefaultprofile",{"_index":2206,"name":{"2837":{}},"parent":{}}],["isdefaultteamprofile",{"_index":2300,"name":{"2952":{}},"parent":{}}],["isdependencyof",{"_index":2430,"name":{"3142":{}},"parent":{}}],["isdir",{"_index":380,"name":{"376":{}},"parent":{}}],["isdirectoryexist",{"_index":3566,"name":{"4811":{}},"parent":{}}],["isendresponse",{"_index":3944,"name":{"5343":{}},"parent":{}}],["isendtsoparms",{"_index":3942,"name":{"5340":{}},"parent":{}}],["iserrorenabled",{"_index":435,"name":{"429":{}},"parent":{}}],["isession",{"_index":1064,"name":{"1209":{},"1251":{},"1271":{}},"parent":{}}],["isetdefaultprofile",{"_index":2463,"name":{"3193":{}},"parent":{}}],["isettingsfile",{"_index":694,"name":{"746":{}},"parent":{}}],["isettingsfilepersistence",{"_index":1414,"name":{"1670":{}},"parent":{}}],["isfatalenabled",{"_index":436,"name":{"430":{}},"parent":{}}],["isfiletagbinorascii",{"_index":3487,"name":{"4698":{}},"parent":{}}],["isformatenabled",{"_index":437,"name":{"431":{}},"parent":{}}],["isguiavailable",{"_index":2376,"name":{"3046":{}},"parent":{}}],["isinfoenabled",{"_index":433,"name":{"427":{}},"parent":{}}],["isiniframe",{"_index":2780,"name":{"3800":{}},"parent":{}}],["islastzosmfresponseempty",{"_index":3078,"name":{"4194":{}},"parent":{}}],["islevelenabled",{"_index":430,"name":{"424":{}},"parent":{}}],["isloggerinit",{"_index":454,"name":{"456":{}},"parent":{}}],["isobjempty",{"_index":749,"name":{"804":{}},"parent":{}}],["ispoolfile",{"_index":3743,"name":{"5075":{}},"parent":{}}],["isprofileempty",{"_index":1980,"name":{"2427":{},"3139":{},"3306":{}},"parent":{}}],["isreststep",{"_index":4184,"name":{"5697":{},"5849":{},"5956":{}},"parent":{}}],["issecured",{"_index":2277,"name":{"2928":{},"2966":{}},"parent":{}}],["isshsession",{"_index":4019,"name":{"5439":{},"5449":{}},"parent":{}}],["isspecialvalue",{"_index":2575,"name":{"3405":{}},"parent":{}}],["issue",{"_index":3083,"name":{"4198":{}},"parent":{}}],["issueandcollect",{"_index":3085,"name":{"4200":{}},"parent":{}}],["issuecommand",{"_index":3079,"name":{"4195":{}},"parent":{}}],["issuecommon",{"_index":3080,"name":{"4196":{}},"parent":{}}],["issuedefconsolecommon",{"_index":3082,"name":{"4197":{}},"parent":{}}],["issuesev",{"_index":1393,"name":{"1648":{}},"parent":{}}],["issueseverity",{"_index":1399,"name":{"1654":{}},"parent":{}}],["issuesimple",{"_index":3084,"name":{"4199":{}},"parent":{}}],["issuetext",{"_index":1391,"name":{"1647":{}},"parent":{}}],["issuetso",{"_index":4015,"name":{"5435":{}},"parent":{}}],["issuetsocommand",{"_index":4016,"name":{"5436":{}},"parent":{}}],["issuetsocommandcommon",{"_index":4018,"name":{"5437":{}},"parent":{}}],["istartstopresponse",{"_index":3972,"name":{"5384":{}},"parent":{}}],["istartstopresponses",{"_index":3960,"name":{"5365":{}},"parent":{}}],["istarttsoparms",{"_index":3847,"name":{"5189":{}},"parent":{}}],["istartworkflow",{"_index":4306,"name":{"5999":{}},"parent":{}}],["isteamconfigsecure",{"_index":2313,"name":{"2968":{}},"parent":{}}],["istepapprovers",{"_index":4157,"name":{"5666":{}},"parent":{}}],["istepdefinition",{"_index":4165,"name":{"5672":{}},"parent":{}}],["istepinfo",{"_index":4270,"name":{"5827":{}},"parent":{}}],["istepsummary",{"_index":4299,"name":{"5931":{}},"parent":{}}],["istoptsoparms",{"_index":3895,"name":{"5237":{}},"parent":{}}],["istraceenabled",{"_index":431,"name":{"425":{}},"parent":{}}],["isubmitjclnotifyparm",{"_index":3708,"name":{"5008":{}},"parent":{}}],["isubmitjclparms",{"_index":3714,"name":{"5016":{}},"parent":{}}],["isubmitjobnotifyparm",{"_index":3716,"name":{"5021":{}},"parent":{}}],["isubmitjobparms",{"_index":3724,"name":{"5036":{}},"parent":{}}],["isubmitjobussnotifyparm",{"_index":3722,"name":{"5030":{}},"parent":{}}],["isubmitjobussparms",{"_index":3719,"name":{"5027":{}},"parent":{}}],["isubmitparms",{"_index":3726,"name":{"5039":{}},"parent":{}}],["isurl",{"_index":751,"name":{"805":{}},"parent":{}}],["isvalidlevel",{"_index":420,"name":{"414":{},"3417":{}},"parent":{}}],["iswarnenabled",{"_index":434,"name":{"428":{}},"parent":{}}],["isysteminfo",{"_index":2364,"name":{"3037":{}},"parent":{}}],["itaskwithstatus",{"_index":876,"name":{"960":{}},"parent":{}}],["itemid",{"_index":2665,"name":{"3599":{},"3614":{}},"parent":{}}],["itemplateregistryinfo",{"_index":2981,"name":{"4065":{}},"parent":{}}],["itemplateworkflowinfo",{"_index":2985,"name":{"4076":{}},"parent":{}}],["itemprobmsg",{"_index":2688,"name":{"3621":{}},"parent":{}}],["items",{"_index":139,"name":{"104":{},"556":{},"3322":{},"5173":{},"6067":{}},"parent":{}}],["itemsinerror",{"_index":2216,"name":{"2845":{},"2860":{}},"parent":{}}],["itemval",{"_index":2685,"name":{"3619":{}},"parent":{}}],["itemvalmsg",{"_index":2687,"name":{"3620":{}},"parent":{}}],["itreenode",{"_index":2785,"name":{"3805":{}},"parent":{}}],["itsomessage",{"_index":3948,"name":{"5349":{}},"parent":{}}],["itsomessages",{"_index":3950,"name":{"5352":{}},"parent":{}}],["itsopromptmessage",{"_index":3952,"name":{"5356":{}},"parent":{}}],["itsoresponsemessage",{"_index":3954,"name":{"5359":{}},"parent":{}}],["iupdateprofile",{"_index":2465,"name":{"3195":{}},"parent":{}}],["iupdateprofilefromcliargs",{"_index":2467,"name":{"3199":{}},"parent":{}}],["iuploaddir",{"_index":3537,"name":{"4768":{}},"parent":{}}],["iuploadfile",{"_index":3541,"name":{"4771":{}},"parent":{}}],["iuploadmap",{"_index":3544,"name":{"4774":{}},"parent":{}}],["iuploadoptions",{"_index":3547,"name":{"4777":{}},"parent":{}}],["iuploadresult",{"_index":3553,"name":{"4795":{}},"parent":{}}],["iussfilelistresponse",{"_index":3336,"name":{"4467":{}},"parent":{}}],["iusslistoptions",{"_index":3412,"name":{"4602":{}},"parent":{}}],["ivalidateprofile",{"_index":2469,"name":{"3204":{}},"parent":{}}],["ivalidateprofileforcli",{"_index":2474,"name":{"3213":{}},"parent":{}}],["ivalidateprofilewithschema",{"_index":2472,"name":{"3208":{}},"parent":{}}],["ivariable",{"_index":4132,"name":{"5627":{}},"parent":{}}],["ivariabledefinition",{"_index":4210,"name":{"5728":{}},"parent":{}}],["ivariableinfo",{"_index":4283,"name":{"5891":{}},"parent":{}}],["ivariablespecification",{"_index":4154,"name":{"5662":{}},"parent":{}}],["iwebdiffgenerator",{"_index":2389,"name":{"3059":{}},"parent":{}}],["iwebdiffmanager",{"_index":2392,"name":{"3061":{}},"parent":{}}],["iwebhelpmanager",{"_index":1781,"name":{"2106":{}},"parent":{}}],["iwebhelppackagemetadata",{"_index":1857,"name":{"2213":{}},"parent":{}}],["iwebhelptreenode",{"_index":1834,"name":{"2187":{}},"parent":{}}],["iworkflowdefinition",{"_index":4221,"name":{"5748":{}},"parent":{}}],["iworkflowinfo",{"_index":4285,"name":{"5897":{}},"parent":{}}],["iworkflows",{"_index":4313,"name":{"6006":{}},"parent":{}}],["iworkflowsinfo",{"_index":4235,"name":{"5768":{}},"parent":{}}],["iyargsparms",{"_index":1918,"name":{"2322":{}},"parent":{}}],["iyargsresponse",{"_index":1890,"name":{"2265":{}},"parent":{}}],["izosfilesoptions",{"_index":3325,"name":{"4438":{}},"parent":{}}],["izosfilesresponse",{"_index":3341,"name":{"4474":{}},"parent":{}}],["izoslogitemtype",{"_index":3821,"name":{"5156":{}},"parent":{}}],["izoslogparms",{"_index":3833,"name":{"5174":{}},"parent":{}}],["izoslogtype",{"_index":3828,"name":{"5168":{}},"parent":{}}],["izosmfcollectresponse",{"_index":3013,"name":{"4119":{}},"parent":{}}],["izosmfinforesponse",{"_index":4343,"name":{"6040":{}},"parent":{}}],["izosmfissueparms",{"_index":3017,"name":{"4122":{}},"parent":{}}],["izosmfissueresponse",{"_index":3020,"name":{"4127":{}},"parent":{}}],["izosmflistdefinedsystemsresponse",{"_index":4366,"name":{"6065":{}},"parent":{}}],["izosmflistresponse",{"_index":3418,"name":{"4615":{}},"parent":{}}],["izosmfmessages",{"_index":3902,"name":{"5243":{}},"parent":{}}],["izosmfpingresponse",{"_index":3906,"name":{"5247":{}},"parent":{}}],["izosmfplugininfo",{"_index":4338,"name":{"6036":{}},"parent":{}}],["izosmftsoresponse",{"_index":3993,"name":{"5408":{}},"parent":{}}],["jcl",{"_index":3709,"name":{"5009":{},"5017":{}},"parent":{}}],["jclsource",{"_index":3727,"name":{"5040":{}},"parent":{}}],["jclsymbols",{"_index":3713,"name":{"5015":{},"5020":{},"5026":{},"5029":{},"5035":{},"5038":{},"5048":{}},"parent":{}}],["jesmembername",{"_index":4362,"name":{"6060":{}},"parent":{}}],["jestype",{"_index":4360,"name":{"6058":{}},"parent":{}}],["job",{"_index":110,"name":{"85":{},"87":{},"3962":{},"4916":{},"4934":{},"4966":{},"5050":{}},"parent":{}}],["job_status",{"_index":3702,"name":{"5000":{}},"parent":{}}],["job_status_order",{"_index":3703,"name":{"5001":{}},"parent":{}}],["jobclass",{"_index":3692,"name":{"4987":{}},"parent":{}}],["jobdataresolve",{"_index":3746,"name":{"5081":{}},"parent":{}}],["jobdataset",{"_index":3717,"name":{"5022":{},"5037":{}},"parent":{}}],["jobfile",{"_index":3685,"name":{"4976":{}},"parent":{}}],["jobfiles",{"_index":4269,"name":{"5826":{}},"parent":{}}],["jobid",{"_index":3640,"name":{"4905":{},"4921":{},"4928":{},"4930":{},"4944":{},"4955":{},"4961":{},"4978":{},"4985":{},"4991":{},"4998":{},"5003":{},"5051":{},"5071":{},"5815":{}},"parent":{}}],["jobinfo",{"_index":4277,"name":{"5850":{},"5957":{}},"parent":{}}],["jobname",{"_index":3642,"name":{"4906":{},"4922":{},"4929":{},"4945":{},"4954":{},"4962":{},"4977":{},"4984":{},"4992":{},"5004":{},"5052":{},"5072":{},"5159":{},"5809":{}},"parent":{}}],["jobresolve",{"_index":3748,"name":{"5083":{}},"parent":{}}],["jobs",{"_index":2904,"name":{"3948":{},"4875":{}},"parent":{"4876":{},"4877":{},"4878":{},"4879":{},"4880":{},"4881":{},"4882":{},"4883":{},"4884":{},"4885":{},"4886":{},"4887":{},"4888":{},"4889":{},"4890":{},"4891":{},"4892":{},"4893":{},"4894":{},"4895":{},"4896":{},"4897":{},"4898":{},"4899":{},"4900":{},"4901":{},"4902":{},"4903":{},"4904":{},"4905":{},"4906":{},"4907":{},"4908":{},"4909":{},"4910":{},"4911":{},"4912":{},"4913":{},"4914":{},"4915":{},"4916":{},"4917":{},"4918":{},"4919":{},"4920":{},"4921":{},"4922":{},"4923":{},"4924":{},"4925":{},"4926":{},"4927":{},"4928":{},"4929":{},"4930":{},"4931":{},"4932":{},"4933":{},"4934":{},"4935":{},"4936":{},"4937":{},"4938":{},"4939":{},"4940":{},"4941":{},"4942":{},"4943":{},"4944":{},"4945":{},"4946":{},"4947":{},"4948":{},"4949":{},"4950":{},"4951":{},"4952":{},"4953":{},"4954":{},"4955":{},"4956":{},"4957":{},"4958":{},"4959":{},"4960":{},"4961":{},"4962":{},"4963":{},"4964":{},"4965":{},"4966":{},"4967":{},"4968":{},"4969":{},"4970":{},"4971":{},"4972":{},"4973":{},"4974":{},"4975":{},"4976":{},"4977":{},"4978":{},"4979":{},"4980":{},"4981":{},"4982":{},"4983":{},"4984":{},"4985":{},"4986":{},"4987":{},"4988":{},"4989":{},"4990":{},"4991":{},"4992":{},"4993":{},"4994":{},"4995":{},"4996":{},"4997":{},"4998":{},"4999":{},"5000":{},"5001":{},"5002":{},"5003":{},"5004":{},"5005":{},"5006":{},"5007":{},"5008":{},"5009":{},"5010":{},"5011":{},"5012":{},"5013":{},"5014":{},"5015":{},"5016":{},"5017":{},"5018":{},"5019":{},"5020":{},"5021":{},"5022":{},"5023":{},"5024":{},"5025":{},"5026":{},"5027":{},"5028":{},"5029":{},"5030":{},"5031":{},"5032":{},"5033":{},"5034":{},"5035":{},"5036":{},"5037":{},"5038":{},"5039":{},"5040":{},"5041":{},"5042":{},"5043":{},"5044":{},"5045":{},"5046":{},"5047":{},"5048":{},"5049":{},"5050":{},"5051":{},"5052":{},"5053":{},"5054":{},"5055":{},"5056":{},"5057":{},"5058":{},"5059":{},"5060":{},"5061":{},"5062":{},"5063":{},"5064":{},"5065":{},"5066":{},"5067":{},"5068":{},"5069":{},"5070":{},"5071":{},"5072":{},"5073":{},"5074":{},"5075":{},"5076":{},"5077":{},"5078":{},"5079":{},"5080":{},"5081":{},"5082":{},"5083":{},"5084":{},"5085":{},"5086":{},"5087":{},"5088":{},"5089":{},"5090":{},"5091":{},"5092":{},"5093":{},"5094":{},"5095":{},"5096":{},"5097":{},"5098":{},"5099":{},"5100":{},"5101":{},"5102":{},"5103":{},"5104":{},"5105":{},"5106":{},"5107":{},"5108":{},"5109":{},"5110":{},"5111":{},"5112":{},"5113":{},"5114":{},"5115":{},"5116":{},"5117":{},"5118":{},"5119":{},"5120":{},"5121":{},"5122":{},"5123":{},"5124":{},"5125":{},"5126":{},"5127":{},"5128":{},"5129":{},"5130":{},"5131":{},"5132":{},"5133":{},"5134":{},"5135":{},"5136":{},"5137":{},"5138":{},"5139":{},"5140":{},"5141":{},"5142":{},"5143":{},"5144":{},"5145":{},"5146":{},"5147":{},"5148":{},"5149":{},"5150":{},"5151":{},"5152":{},"5153":{},"5154":{}}}],["jobsconstants",{"_index":3611,"name":{"4876":{}},"parent":{}}],["jobstatement",{"_index":4289,"name":{"5919":{}},"parent":{}}],["jobstatus",{"_index":4267,"name":{"5825":{}},"parent":{}}],["jobussfile",{"_index":3720,"name":{"5028":{},"5034":{}},"parent":{}}],["json_option",{"_index":492,"name":{"492":{}},"parent":{}}],["json_option_alias",{"_index":493,"name":{"493":{}},"parent":{}}],["json_schema",{"_index":1283,"name":{"1530":{}},"parent":{}}],["jsonloc",{"_index":2186,"name":{"2811":{}},"parent":{}}],["jsonpathmatches",{"_index":716,"name":{"765":{}},"parent":{}}],["jsonsettingsfilepersistence",{"_index":1416,"name":{"1673":{}},"parent":{}}],["jsonutils",{"_index":2358,"name":{"3032":{}},"parent":{}}],["jsutils",{"_index":748,"name":{"803":{}},"parent":{}}],["kebabcase",{"_index":547,"name":{"545":{}},"parent":{}}],["key",{"_index":461,"name":{"463":{},"546":{},"1162":{},"3908":{},"3909":{},"3946":{},"4121":{},"4124":{},"4131":{},"4132":{}},"parent":{}}],["keypassphrase",{"_index":4022,"name":{"5445":{},"5560":{}},"parent":{}}],["keystobeanarray",{"_index":363,"name":{"361":{}},"parent":{}}],["keystobedefined",{"_index":364,"name":{"362":{}},"parent":{}}],["keystobedefinedandnonblank",{"_index":366,"name":{"364":{}},"parent":{}}],["keystobeoftype",{"_index":368,"name":{"366":{}},"parent":{}}],["keystobeundefined",{"_index":369,"name":{"367":{}},"parent":{}}],["keytar",{"_index":668,"name":{"690":{},"3571":{}},"parent":{}}],["keyworddetected",{"_index":3036,"name":{"4148":{}},"parent":{}}],["known_cred_mgrs",{"_index":702,"name":{"752":{}},"parent":{}}],["knownargs",{"_index":2212,"name":{"2842":{}},"parent":{}}],["label",{"_index":2951,"name":{"4014":{}},"parent":{}}],["last",{"_index":2907,"name":{"3950":{},"3952":{},"3953":{},"3954":{},"3955":{}},"parent":{}}],["lastbytereceived",{"_index":1167,"name":{"1360":{},"1427":{}},"parent":{}}],["lasteolregex",{"_index":2697,"name":{"3629":{}},"parent":{}}],["lastresponsekey",{"_index":3035,"name":{"4147":{}},"parent":{}}],["layer",{"_index":740,"name":{"795":{},"799":{},"3399":{}},"parent":{}}],["layeractive",{"_index":791,"name":{"855":{}},"parent":{}}],["layerexists",{"_index":792,"name":{"856":{}},"parent":{}}],["layermerge",{"_index":788,"name":{"852":{}},"parent":{}}],["layerpath",{"_index":776,"name":{"835":{}},"parent":{}}],["layerprofiles",{"_index":789,"name":{"853":{}},"parent":{}}],["layers",{"_index":772,"name":{"827":{},"839":{}},"parent":{}}],["layout",{"_index":318,"name":{"321":{}},"parent":{}}],["level",{"_index":407,"name":{"403":{},"442":{},"1560":{},"3433":{}},"parent":{}}],["level_default",{"_index":418,"name":{"412":{}},"parent":{}}],["levels",{"_index":416,"name":{"411":{}},"parent":{}}],["line",{"_index":2958,"name":{"4021":{}},"parent":{}}],["links",{"_index":2781,"name":{"3801":{}},"parent":{}}],["list",{"_index":2851,"name":{"3876":{},"3878":{},"3882":{},"3997":{},"3999":{},"4003":{},"4636":{}},"parent":{}}],["list_action",{"_index":518,"name":{"518":{}},"parent":{}}],["list_workflows",{"_index":4091,"name":{"5578":{}},"parent":{}}],["listarchivedworkflows",{"_index":4241,"name":{"5782":{},"5783":{}},"parent":{}}],["listcatalogcommon",{"_index":2858,"name":{"3886":{}},"parent":{}}],["listcatalogtemplates",{"_index":2857,"name":{"3885":{}},"parent":{}}],["listdefinedsystems",{"_index":4369,"name":{"6068":{},"6069":{}},"parent":{}}],["listdefinition",{"_index":2604,"name":{"3458":{}},"parent":{}}],["listfilteredregistry",{"_index":2948,"name":{"4008":{}},"parent":{}}],["listgroupwithonlyprofilecommandsummary",{"_index":1571,"name":{"1836":{}},"parent":{}}],["listgroupwithonlyprofiledefaultdesc",{"_index":1569,"name":{"1834":{}},"parent":{}}],["listgroupwithonlyprofilesdefinition",{"_index":1567,"name":{"1832":{}},"parent":{}}],["listgroupwithonlyprofilesetdesc",{"_index":1573,"name":{"1838":{}},"parent":{}}],["listgroupwithonlyprofilessummary",{"_index":1565,"name":{"1830":{}},"parent":{}}],["listhandler",{"_index":2661,"name":{"3594":{}},"parent":{}}],["listinstancecommon",{"_index":2930,"name":{"3990":{}},"parent":{}}],["listinstanceinfo",{"_index":2929,"name":{"3989":{}},"parent":{}}],["listinstancevariables",{"_index":2934,"name":{"3993":{}},"parent":{}}],["listprofilecommanddesc",{"_index":1543,"name":{"1808":{}},"parent":{}}],["listprofilecommandsummary",{"_index":1541,"name":{"1806":{}},"parent":{}}],["listprofileexample",{"_index":1511,"name":{"1776":{}},"parent":{}}],["listprofileexampleshowcontents",{"_index":1513,"name":{"1778":{}},"parent":{}}],["listprofileloadedmodulesoptiondesc",{"_index":1507,"name":{"1772":{}},"parent":{}}],["listprofilesfoundmessage",{"_index":1545,"name":{"1810":{}},"parent":{}}],["listprofileshandler",{"_index":2761,"name":{"3762":{}},"parent":{}}],["listprofilesnotfoundmessage",{"_index":1547,"name":{"1812":{}},"parent":{}}],["listprofileverboseoptiondesc",{"_index":1509,"name":{"1774":{}},"parent":{}}],["listregistrycommon",{"_index":2946,"name":{"4007":{}},"parent":{}}],["listregistryinstances",{"_index":2945,"name":{"4006":{}},"parent":{}}],["listtemplatecommon",{"_index":2972,"name":{"4052":{}},"parent":{}}],["listtemplateinfo",{"_index":2971,"name":{"4051":{}},"parent":{}}],["listvariablescommon",{"_index":2935,"name":{"3994":{}},"parent":{}}],["listworkflows",{"_index":4248,"name":{"5794":{}},"parent":{}}],["load",{"_index":612,"name":{"624":{},"674":{},"709":{},"733":{},"769":{},"832":{},"1563":{},"2413":{},"2588":{},"3118":{},"3292":{}},"parent":{}}],["load_cred_mgr_failed",{"_index":2223,"name":{"2851":{}},"parent":{}}],["load_schema_failed",{"_index":2224,"name":{"2852":{}},"parent":{}}],["loadall",{"_index":1765,"name":{"2082":{},"2380":{},"3126":{},"3268":{}},"parent":{}}],["loadallplugincfgprops",{"_index":1442,"name":{"1710":{}},"parent":{}}],["loadallschemas",{"_index":2290,"name":{"2941":{}},"parent":{}}],["loadcached",{"_index":721,"name":{"770":{}},"parent":{}}],["loadcounter",{"_index":1959,"name":{"2399":{},"3104":{},"3172":{},"3278":{}},"parent":{}}],["loadcredentialmanager",{"_index":2057,"name":{"2590":{}},"parent":{}}],["loadcredentials",{"_index":657,"name":{"679":{},"698":{},"728":{}},"parent":{}}],["loaddefault",{"_index":1750,"name":{"2065":{},"2372":{},"3163":{}},"parent":{}}],["loaddependencies",{"_index":1937,"name":{"2374":{},"2395":{},"3132":{},"3165":{},"3269":{}},"parent":{}}],["loadedconfig",{"_index":2350,"name":{"3019":{}},"parent":{}}],["loader",{"_index":1757,"name":{"2072":{}},"parent":{}}],["loaderror",{"_index":669,"name":{"691":{}},"parent":{}}],["loadfailed",{"_index":729,"name":{"779":{},"2426":{},"3138":{},"3305":{}},"parent":{}}],["loadfromfile",{"_index":3496,"name":{"4710":{}},"parent":{}}],["loadmanager",{"_index":2312,"name":{"2967":{}},"parent":{}}],["loadplugincfgprops",{"_index":1451,"name":{"1719":{}},"parent":{}}],["loadprofile",{"_index":1946,"name":{"2383":{},"3128":{},"3271":{}},"parent":{}}],["loadprofiles",{"_index":1760,"name":{"2077":{}},"parent":{}}],["loadschema",{"_index":1295,"name":{"1547":{},"2958":{}},"parent":{}}],["loadschemaforsesscfgprops",{"_index":1232,"name":{"1471":{}},"parent":{}}],["loadsecurearg",{"_index":2286,"name":{"2937":{}},"parent":{}}],["loadsecureconfig",{"_index":2059,"name":{"2592":{}},"parent":{}}],["loadsecuresesscfgprops",{"_index":1233,"name":{"1472":{}},"parent":{}}],["loadspecificprofile",{"_index":1981,"name":{"2428":{},"3140":{},"3307":{}},"parent":{}}],["loadtree",{"_index":2805,"name":{"3829":{}},"parent":{}}],["local",{"_index":737,"name":{"792":{}},"parent":{}}],["localencoding",{"_index":3332,"name":{"4444":{},"4661":{},"4730":{},"4791":{}},"parent":{}}],["locales",{"_index":1477,"name":{"1742":{}},"parent":{}}],["locateexistingprofile",{"_index":1979,"name":{"2425":{},"3137":{},"3304":{}},"parent":{}}],["locateprofilesdesc",{"_index":1617,"name":{"1882":{}},"parent":{}}],["loctype",{"_index":2183,"name":{"2809":{}},"parent":{}}],["log",{"_index":163,"name":{"121":{},"947":{},"993":{},"1083":{},"1279":{},"1379":{},"1438":{},"1571":{},"2085":{},"2133":{},"2179":{},"2259":{},"2279":{},"2301":{},"2336":{},"2400":{},"2489":{},"2741":{},"3105":{},"3279":{},"4466":{},"4644":{},"4814":{},"4942":{},"4951":{},"5088":{},"5103":{},"5124":{},"5154":{},"5502":{},"6051":{},"6137":{}},"parent":{}}],["log4jsconfig",{"_index":326,"name":{"328":{}},"parent":{}}],["logbeginmessage",{"_index":941,"name":{"1027":{}},"parent":{}}],["logendmessage",{"_index":942,"name":{"1028":{}},"parent":{}}],["logerror",{"_index":2592,"name":{"3431":{}},"parent":{}}],["logfile",{"_index":1304,"name":{"1559":{}},"parent":{}}],["logger",{"_index":1755,"name":{"2070":{},"2846":{},"3170":{},"3407":{},"3436":{}},"parent":{}}],["loggerconfigbuilder",{"_index":1318,"name":{"1572":{}},"parent":{}}],["loggermanager",{"_index":445,"name":{"446":{}},"parent":{}}],["loggerutils",{"_index":2568,"name":{"3390":{}},"parent":{}}],["loggerutilsrequire",{"_index":2773,"name":{"3775":{}},"parent":{}}],["logging",{"_index":2333,"name":{"2992":{}},"parent":{}}],["loggingconfigurer",{"_index":1351,"name":{"1608":{}},"parent":{}}],["login",{"_index":170,"name":{"126":{},"1150":{}},"parent":{}}],["login_action",{"_index":529,"name":{"529":{}},"parent":{}}],["login_action_alias",{"_index":530,"name":{"530":{}},"parent":{}}],["loginconstants",{"_index":167,"name":{"124":{}},"parent":{}}],["logingroup",{"_index":2075,"name":{"2629":{}},"parent":{}}],["loginmemory",{"_index":455,"name":{"457":{}},"parent":{}}],["logonprocedure",{"_index":3848,"name":{"5190":{},"5327":{}},"parent":{}}],["logoperationbeginmessages",{"_index":935,"name":{"1021":{},"1071":{}},"parent":{}}],["logoperationresults",{"_index":921,"name":{"1006":{},"1066":{}},"parent":{}}],["logout",{"_index":182,"name":{"136":{},"1151":{}},"parent":{}}],["logout_action",{"_index":531,"name":{"531":{}},"parent":{}}],["logout_action_alias",{"_index":532,"name":{"532":{}},"parent":{}}],["logoutconstants",{"_index":173,"name":{"128":{}},"parent":{}}],["logoutgroup",{"_index":2076,"name":{"2630":{}},"parent":{}}],["logs",{"_index":3820,"name":{"5155":{}},"parent":{"5156":{},"5157":{},"5158":{},"5159":{},"5160":{},"5161":{},"5162":{},"5163":{},"5164":{},"5165":{},"5166":{},"5167":{},"5168":{},"5169":{},"5170":{},"5171":{},"5172":{},"5173":{},"5174":{},"5175":{},"5176":{},"5177":{},"5178":{},"5179":{},"5180":{},"5181":{},"5182":{},"5183":{},"5184":{},"5185":{},"5186":{},"5187":{}}}],["logservice",{"_index":2594,"name":{"3434":{}},"parent":{}}],["logsesscfg",{"_index":1230,"name":{"1469":{}},"parent":{}}],["long",{"_index":1710,"name":{"2015":{}},"parent":{}}],["long_dash",{"_index":1797,"name":{"2120":{},"2166":{}},"parent":{}}],["longamsstatement",{"_index":3223,"name":{"4337":{}},"parent":{}}],["lrecl",{"_index":95,"name":{"75":{},"77":{},"4491":{},"4537":{},"4544":{},"4551":{},"4559":{},"4567":{},"4625":{},"4971":{}},"parent":{}}],["mactive",{"_index":764,"name":{"817":{}},"parent":{}}],["mallfilescreated",{"_index":916,"name":{"1000":{}},"parent":{}}],["mallplugincfgprops",{"_index":1428,"name":{"1695":{}},"parent":{}}],["manager",{"_index":663,"name":{"685":{},"740":{}},"parent":{}}],["managerparameters",{"_index":1960,"name":{"2401":{},"3106":{},"3280":{}},"parent":{}}],["map",{"_index":854,"name":{"939":{}},"parent":{}}],["mapfrom",{"_index":4162,"name":{"5670":{}},"parent":{}}],["mapfromarguments",{"_index":295,"name":{"300":{}},"parent":{}}],["mapi",{"_index":769,"name":{"823":{},"2735":{}},"parent":{}}],["mapis",{"_index":1346,"name":{"1600":{},"3363":{}},"parent":{}}],["mapp",{"_index":760,"name":{"813":{}},"parent":{}}],["mapping",{"_index":303,"name":{"307":{}},"parent":{}}],["mappname",{"_index":2260,"name":{"2909":{}},"parent":{}}],["mapto",{"_index":4164,"name":{"5671":{}},"parent":{}}],["marguments",{"_index":1691,"name":{"1979":{},"5526":{},"6142":{}},"parent":{}}],["markdownit",{"_index":1843,"name":{"2196":{}},"parent":{}}],["maskchar",{"_index":861,"name":{"945":{}},"parent":{}}],["maskedproperties",{"_index":786,"name":{"848":{}},"parent":{}}],["maskoutput",{"_index":469,"name":{"470":{}},"parent":{}}],["masksecure",{"_index":753,"name":{"807":{}},"parent":{}}],["mauthconfig",{"_index":2066,"name":{"2602":{},"2615":{},"2625":{}},"parent":{}}],["mautoinitconfig",{"_index":2106,"name":{"2706":{}},"parent":{}}],["max",{"_index":138,"name":{"104":{},"4023":{}},"parent":{}}],["max_alloc_quantity",{"_index":3128,"name":{"4243":{}},"parent":{}}],["max_ams_buffer",{"_index":3130,"name":{"4245":{}},"parent":{}}],["max_ams_line",{"_index":3129,"name":{"4244":{}},"parent":{}}],["max_column_width",{"_index":1673,"name":{"1960":{}},"parent":{}}],["max_expected_fields",{"_index":3493,"name":{"4705":{}},"parent":{}}],["max_member_length",{"_index":3469,"name":{"4679":{}},"parent":{}}],["max_retain_days",{"_index":3132,"name":{"4247":{}},"parent":{}}],["max_yaml_depth",{"_index":2408,"name":{"3076":{}},"parent":{}}],["maxconcurrentrequests",{"_index":3405,"name":{"4586":{},"4738":{},"4784":{}},"parent":{}}],["maximumallocationquantityexceeded",{"_index":3211,"name":{"4325":{}},"parent":{}}],["maxjobs",{"_index":3700,"name":{"4997":{}},"parent":{}}],["maxlength",{"_index":3409,"name":{"4592":{},"4597":{},"4603":{},"5738":{}},"parent":{}}],["maxlrecl",{"_index":4185,"name":{"5698":{},"5851":{},"5958":{}},"parent":{}}],["maxqueuesize",{"_index":456,"name":{"458":{}},"parent":{}}],["maxvalue",{"_index":4214,"name":{"5739":{}},"parent":{}}],["mbytesreceived",{"_index":1165,"name":{"1358":{},"1425":{}},"parent":{}}],["mcallerlocation",{"_index":2346,"name":{"3011":{}},"parent":{}}],["mchunks",{"_index":1146,"name":{"1340":{},"1407":{}},"parent":{}}],["mcolor",{"_index":423,"name":{"417":{}},"parent":{}}],["mcommanddefinition",{"_index":1711,"name":{"2016":{},"2073":{},"2123":{},"2169":{}},"parent":{}}],["mcommandline",{"_index":1870,"name":{"2232":{},"2344":{},"2483":{},"2739":{},"3010":{}},"parent":{}}],["mcommandresponseparms",{"_index":1928,"name":{"2340":{}},"parent":{}}],["mcommandrootname",{"_index":1869,"name":{"2231":{}},"parent":{}}],["mconfig",{"_index":629,"name":{"639":{},"649":{},"653":{},"666":{},"781":{},"1601":{},"2194":{},"2240":{},"2577":{},"2598":{},"2611":{},"2621":{},"2703":{},"3015":{},"3396":{}},"parent":{}}],["mconsoleapi",{"_index":1686,"name":{"1974":{}},"parent":{}}],["mconsolelog",{"_index":2126,"name":{"2736":{}},"parent":{}}],["mconstructorparms",{"_index":2422,"name":{"3093":{}},"parent":{}}],["mcontentencoding",{"_index":1154,"name":{"1347":{},"1414":{}},"parent":{}}],["mcontentlength",{"_index":1153,"name":{"1346":{},"1413":{}},"parent":{}}],["mcontrol",{"_index":1674,"name":{"1961":{}},"parent":{}}],["mcredentials",{"_index":2270,"name":{"2919":{}},"parent":{}}],["mcredmgroverride",{"_index":2309,"name":{"2962":{}},"parent":{}}],["mcurrentoperation",{"_index":969,"name":{"1056":{}},"parent":{}}],["mcustomloggermap",{"_index":1344,"name":{"1597":{}},"parent":{}}],["mdaemoncontext",{"_index":1876,"name":{"2241":{},"3008":{}},"parent":{}}],["mdata",{"_index":1148,"name":{"1341":{},"1408":{},"1969":{}},"parent":{}}],["mdataapi",{"_index":1685,"name":{"1973":{}},"parent":{}}],["mdecode",{"_index":1166,"name":{"1359":{},"1426":{}},"parent":{}}],["mdefaulttokentype",{"_index":1246,"name":{"1483":{},"2771":{}},"parent":{}}],["mdefinition",{"_index":1690,"name":{"1978":{},"2235":{},"2337":{}},"parent":{}}],["mdefinitiontree",{"_index":1712,"name":{"2017":{},"2124":{},"2170":{}},"parent":{}}],["mdetails",{"_index":680,"name":{"714":{},"1324":{},"2861":{},"3441":{},"3729":{},"3740":{},"3778":{},"3789":{}},"parent":{}}],["mdocsdir",{"_index":1842,"name":{"2195":{}},"parent":{}}],["member",{"_index":3324,"name":{"4437":{},"4932":{}},"parent":{}}],["memberdownloadfailed",{"_index":3307,"name":{"4421":{}},"parent":{}}],["menvvariableprefix",{"_index":1871,"name":{"2233":{},"2345":{},"2484":{}},"parent":{}}],["merge",{"_index":636,"name":{"646":{},"902":{},"3197":{},"3202":{}},"parent":{}}],["mergeargsforprofile",{"_index":2279,"name":{"2930":{}},"parent":{}}],["mergeargsforprofiletype",{"_index":2280,"name":{"2931":{}},"parent":{}}],["mergearguments",{"_index":2556,"name":{"3376":{}},"parent":{}}],["mergedargs",{"_index":2235,"name":{"2878":{},"2890":{}},"parent":{}}],["mergeprofiles",{"_index":1970,"name":{"2415":{},"3120":{},"3294":{}},"parent":{}}],["merror",{"_index":1682,"name":{"1970":{}},"parent":{}}],["merrorlist",{"_index":1714,"name":{"2020":{}},"parent":{}}],["message",{"_index":279,"name":{"286":{},"288":{},"401":{},"721":{},"1331":{},"1741":{},"1745":{},"1747":{},"1749":{},"1751":{},"1753":{},"1755":{},"1757":{},"1759":{},"1761":{},"1763":{},"1765":{},"1767":{},"1769":{},"1771":{},"1773":{},"1775":{},"1777":{},"1779":{},"1781":{},"1783":{},"1785":{},"1787":{},"1789":{},"1791":{},"1793":{},"1795":{},"1797":{},"1799":{},"1801":{},"1803":{},"1805":{},"1807":{},"1809":{},"1811":{},"1813":{},"1815":{},"1817":{},"1819":{},"1821":{},"1823":{},"1825":{},"1827":{},"1829":{},"1831":{},"1833":{},"1835":{},"1837":{},"1839":{},"1841":{},"1843":{},"1845":{},"1847":{},"1849":{},"1851":{},"1853":{},"1855":{},"1857":{},"1859":{},"1861":{},"1863":{},"1865":{},"1867":{},"1869":{},"1871":{},"1873":{},"1875":{},"1877":{},"1879":{},"1881":{},"1883":{},"1885":{},"1887":{},"1889":{},"1891":{},"1893":{},"1895":{},"1897":{},"1899":{},"1901":{},"1903":{},"1905":{},"1907":{},"1911":{},"2010":{},"2268":{},"2433":{},"2868":{},"3221":{},"3224":{},"3227":{},"3232":{},"3235":{},"3448":{},"3736":{},"3747":{},"3785":{},"3796":{},"3844":{},"3846":{},"3848":{},"3850":{},"3852":{},"4025":{},"4167":{},"4169":{},"4171":{},"4173":{},"4175":{},"4177":{},"4179":{},"4181":{},"4183":{},"4185":{},"4187":{},"4189":{},"4252":{},"4254":{},"4256":{},"4258":{},"4260":{},"4262":{},"4264":{},"4266":{},"4268":{},"4270":{},"4272":{},"4274":{},"4276":{},"4278":{},"4280":{},"4282":{},"4284":{},"4286":{},"4288":{},"4290":{},"4292":{},"4294":{},"4296":{},"4298":{},"4300":{},"4302":{},"4304":{},"4306":{},"4308":{},"4310":{},"4312":{},"4314":{},"4316":{},"4318":{},"4320":{},"4322":{},"4324":{},"4326":{},"4328":{},"4330":{},"4332":{},"4334":{},"4336":{},"4338":{},"4340":{},"4342":{},"4344":{},"4346":{},"4348":{},"4350":{},"4352":{},"4354":{},"4356":{},"4358":{},"4360":{},"4362":{},"4364":{},"4366":{},"4368":{},"4370":{},"4372":{},"4374":{},"4376":{},"4378":{},"4380":{},"4382":{},"4384":{},"4386":{},"4388":{},"4390":{},"4392":{},"4394":{},"4396":{},"4398":{},"4400":{},"4402":{},"4404":{},"4406":{},"4408":{},"4410":{},"4412":{},"4414":{},"4416":{},"4418":{},"4420":{},"4422":{},"4424":{},"4426":{},"4428":{},"4430":{},"4432":{},"4434":{},"4937":{},"5064":{},"5091":{},"5093":{},"5095":{},"5160":{},"5184":{},"5218":{},"5220":{},"5222":{},"5224":{},"5226":{},"5228":{},"5230":{},"5232":{},"5234":{},"5236":{},"5353":{},"5506":{},"5508":{},"5510":{},"5512":{},"5514":{},"5594":{},"5596":{},"5598":{},"5600":{},"5602":{},"5604":{},"5606":{},"5608":{},"5610":{},"5612":{},"6029":{},"6031":{},"6033":{},"6035":{}},"parent":{}}],["messageid",{"_index":3824,"name":{"5161":{},"5245":{},"5805":{}},"parent":{}}],["messages",{"_index":3959,"name":{"5364":{},"5371":{}},"parent":{}}],["messagetext",{"_index":3903,"name":{"5244":{},"5806":{}},"parent":{}}],["meta_file_suffix",{"_index":1958,"name":{"2397":{},"3091":{},"3276":{}},"parent":{}}],["metamap",{"_index":855,"name":{"940":{}},"parent":{}}],["method",{"_index":405,"name":{"400":{},"1157":{}},"parent":{}}],["mexitcode",{"_index":1677,"name":{"1964":{}},"parent":{}}],["mexperimentalcommanddescription",{"_index":1802,"name":{"2128":{},"2174":{},"2487":{}},"parent":{}}],["mextendersjson",{"_index":2271,"name":{"2920":{}},"parent":{}}],["mfactory",{"_index":1759,"name":{"2074":{}},"parent":{}}],["mfilesforundo",{"_index":917,"name":{"1001":{}},"parent":{}}],["mformatapi",{"_index":1687,"name":{"1975":{}},"parent":{}}],["mfullcommandtree",{"_index":1841,"name":{"2193":{},"2218":{},"2737":{}},"parent":{}}],["mfulldefinition",{"_index":1873,"name":{"2236":{}},"parent":{}}],["mgntclass",{"_index":3358,"name":{"4493":{},"4510":{},"4523":{}},"parent":{}}],["mhandlerparams",{"_index":4069,"name":{"5527":{},"6143":{}},"parent":{}}],["mhasvalidschema",{"_index":2268,"name":{"2917":{}},"parent":{}}],["mhelpfactory",{"_index":2021,"name":{"2485":{}},"parent":{}}],["mhelpgenerator",{"_index":1874,"name":{"2237":{}},"parent":{}}],["mhelpgeneratorfactory",{"_index":1929,"name":{"2341":{},"2740":{}},"parent":{}}],["mhome",{"_index":1347,"name":{"1602":{}},"parent":{}}],["mhomedir",{"_index":762,"name":{"815":{}},"parent":{}}],["mhostpackagename",{"_index":2347,"name":{"3012":{}},"parent":{}}],["migr",{"_index":3428,"name":{"4626":{}},"parent":{}}],["migrated",{"_index":142,"name":{"106":{},"108":{},"110":{}},"parent":{}}],["mimperativeapi",{"_index":2061,"name":{"2594":{}},"parent":{}}],["mimperativepackagename",{"_index":2348,"name":{"3013":{}},"parent":{}}],["mimplogger",{"_index":2261,"name":{"2910":{}},"parent":{}}],["min",{"_index":2959,"name":{"4022":{}},"parent":{}}],["min_expected_fields",{"_index":3495,"name":{"4706":{}},"parent":{}}],["min_retain_days",{"_index":3131,"name":{"4246":{}},"parent":{}}],["minlength",{"_index":4215,"name":{"5740":{}},"parent":{}}],["minputparameters",{"_index":973,"name":{"1060":{}},"parent":{}}],["minstance",{"_index":448,"name":{"448":{},"1623":{},"1660":{},"1681":{},"1693":{},"2217":{},"3007":{},"3064":{},"3552":{},"3659":{}},"parent":{}}],["minvalue",{"_index":4216,"name":{"5741":{}},"parent":{}}],["misc",{"_index":4301,"name":{"5935":{}},"parent":{}}],["misession",{"_index":1093,"name":{"1248":{}},"parent":{}}],["misjson",{"_index":1155,"name":{"1348":{},"1415":{}},"parent":{}}],["misloggerinit",{"_index":450,"name":{"450":{}},"parent":{}}],["mison",{"_index":424,"name":{"418":{}},"parent":{}}],["misshsession",{"_index":4046,"name":{"5501":{}},"parent":{}}],["missing_req_prop",{"_index":2225,"name":{"2853":{}},"parent":{}}],["missingargs",{"_index":2214,"name":{"2843":{}},"parent":{}}],["missingdatasetlikename",{"_index":3147,"name":{"4261":{}},"parent":{}}],["missingdatasetname",{"_index":3145,"name":{"4259":{}},"parent":{}}],["missingdatasets",{"_index":3233,"name":{"4347":{}},"parent":{}}],["missingdatasettype",{"_index":3143,"name":{"4257":{}},"parent":{}}],["missingdirectoryoption",{"_index":3758,"name":{"5092":{}},"parent":{}}],["missingfilescreateoptions",{"_index":3193,"name":{"4307":{}},"parent":{}}],["missingfilesmountoptions",{"_index":3269,"name":{"4383":{}},"parent":{}}],["missingfilesystemname",{"_index":3257,"name":{"4371":{}},"parent":{}}],["missingfsoption",{"_index":3273,"name":{"4387":{}},"parent":{}}],["missinginputdir",{"_index":3165,"name":{"4279":{}},"parent":{}}],["missinginputdirectory",{"_index":3163,"name":{"4277":{}},"parent":{}}],["missinginputfile",{"_index":3161,"name":{"4275":{}},"parent":{}}],["missingjcl",{"_index":3760,"name":{"5094":{}},"parent":{}}],["missingmountpoint",{"_index":3267,"name":{"4381":{}},"parent":{}}],["missingoptionerror",{"_index":1721,"name":{"2030":{}},"parent":{}}],["missingpatterns",{"_index":3231,"name":{"4345":{}},"parent":{}}],["missingpayload",{"_index":3155,"name":{"4269":{}},"parent":{}}],["missingpositionalparameter",{"_index":1740,"name":{"2049":{}},"parent":{}}],["missingprimary",{"_index":3201,"name":{"4315":{}},"parent":{}}],["missingrecordlength",{"_index":3213,"name":{"4327":{}},"parent":{}}],["missingrequesttype",{"_index":3159,"name":{"4273":{}},"parent":{}}],["missingrequiredtableparameters",{"_index":3153,"name":{"4267":{}},"parent":{}}],["missingsession",{"_index":4329,"name":{"6028":{}},"parent":{}}],["missingstatements",{"_index":3215,"name":{"4329":{}},"parent":{}}],["missingussdirectoryname",{"_index":3157,"name":{"4271":{}},"parent":{}}],["missingussdirname",{"_index":3151,"name":{"4265":{}},"parent":{}}],["missingussfilename",{"_index":3149,"name":{"4263":{}},"parent":{}}],["missingussfilepath",{"_index":3755,"name":{"5090":{}},"parent":{}}],["missingvsamoption",{"_index":3217,"name":{"4331":{}},"parent":{}}],["missingzfsoption",{"_index":3259,"name":{"4373":{}},"parent":{}}],["mitemsinerror",{"_index":2230,"name":{"2859":{}},"parent":{}}],["mixed",{"_index":3482,"name":{"4694":{}},"parent":{}}],["mjslogger",{"_index":2590,"name":{"3422":{}},"parent":{}}],["mkdirp",{"_index":387,"name":{"383":{}},"parent":{}}],["mlayer",{"_index":2571,"name":{"3398":{}},"parent":{}}],["mlayers",{"_index":761,"name":{"814":{}},"parent":{}}],["mlevel",{"_index":426,"name":{"420":{}},"parent":{}}],["mloadcounter",{"_index":2421,"name":{"3092":{}},"parent":{}}],["mloadedconfig",{"_index":2257,"name":{"2907":{},"3009":{}},"parent":{}}],["mloadfailed",{"_index":719,"name":{"768":{}},"parent":{}}],["mlog",{"_index":1092,"name":{"1246":{},"1596":{},"2075":{},"2126":{},"2172":{}},"parent":{}}],["mlogger",{"_index":1149,"name":{"1342":{},"1409":{},"2019":{},"2239":{},"2501":{},"2515":{},"2526":{},"2537":{},"2548":{},"2559":{},"2570":{},"2601":{},"2614":{},"2624":{},"2705":{},"3102":{},"3756":{},"3773":{}},"parent":{}}],["mloginmemory",{"_index":451,"name":{"451":{}},"parent":{}}],["mmanager",{"_index":687,"name":{"739":{}},"parent":{}}],["mmap",{"_index":848,"name":{"932":{}},"parent":{}}],["mmaxqueuesize",{"_index":452,"name":{"452":{}},"parent":{}}],["mmessage",{"_index":1681,"name":{"1968":{},"3439":{}},"parent":{}}],["mmetamap",{"_index":850,"name":{"933":{}},"parent":{}}],["mnormalizerequestnewlines",{"_index":1156,"name":{"1349":{},"1416":{}},"parent":{}}],["mnormalizeresponsenewlines",{"_index":1157,"name":{"1350":{},"1417":{}},"parent":{}}],["mocked_command_tree",{"_index":2602,"name":{"3453":{}},"parent":{}}],["mode",{"_index":100,"name":{"79":{},"4469":{},"4501":{},"4864":{}},"parent":{}}],["modified",{"_index":2908,"name":{"3950":{},"3952":{}},"parent":{}}],["modify",{"_index":111,"name":{"85":{},"87":{}},"parent":{}}],["modifyjob",{"_index":3751,"name":{"5086":{}},"parent":{}}],["modifyjobcommon",{"_index":3753,"name":{"5087":{}},"parent":{}}],["modifyjobs",{"_index":3750,"name":{"5085":{}},"parent":{}}],["modifyversion",{"_index":3666,"name":{"4946":{}},"parent":{}}],["modules",{"_index":2729,"name":{"3664":{}},"parent":{}}],["moldschoolprofilecache",{"_index":2262,"name":{"2911":{}},"parent":{}}],["moldschoolprofiledefaults",{"_index":2264,"name":{"2913":{}},"parent":{}}],["moldschoolprofilerootdir",{"_index":2263,"name":{"2912":{}},"parent":{}}],["moldschoolprofiletypes",{"_index":2266,"name":{"2915":{}},"parent":{}}],["monitorjobs",{"_index":3762,"name":{"5096":{}},"parent":{}}],["moperationcompletecallback",{"_index":915,"name":{"999":{}},"parent":{}}],["moperationlist",{"_index":966,"name":{"1054":{}},"parent":{}}],["moperationresult",{"_index":911,"name":{"995":{},"1085":{}},"parent":{}}],["moperationresults",{"_index":910,"name":{"994":{},"1084":{}},"parent":{}}],["moperationscompletecallback",{"_index":970,"name":{"1057":{}},"parent":{}}],["moperationundoindex",{"_index":972,"name":{"1059":{}},"parent":{}}],["moperationundolist",{"_index":971,"name":{"1058":{}},"parent":{}}],["moptiondefinitionsmap",{"_index":1713,"name":{"2018":{}},"parent":{}}],["mount",{"_index":3603,"name":{"4866":{}},"parent":{}}],["moverallstatusmessage",{"_index":968,"name":{"1055":{}},"parent":{}}],["moverridewithenv",{"_index":2267,"name":{"2916":{}},"parent":{}}],["mparent",{"_index":1926,"name":{"2338":{}},"parent":{}}],["mparms",{"_index":2542,"name":{"3344":{}},"parent":{}}],["mpercentcomplete",{"_index":914,"name":{"998":{}},"parent":{}}],["mpluginoverrides",{"_index":1430,"name":{"1697":{}},"parent":{}}],["mprefix",{"_index":422,"name":{"416":{}},"parent":{}}],["mprimaryhighlightcolor",{"_index":1801,"name":{"2127":{},"2173":{},"2481":{},"3342":{}},"parent":{}}],["mprimarytextcolor",{"_index":1678,"name":{"1965":{}},"parent":{}}],["mproducemarkdown",{"_index":1800,"name":{"2125":{},"2171":{},"3343":{}},"parent":{}}],["mproductdisplayname",{"_index":2429,"name":{"3101":{}},"parent":{}}],["mprofileconfig",{"_index":2031,"name":{"2502":{},"2516":{},"2527":{},"2538":{},"2549":{},"2560":{},"2571":{},"3757":{}},"parent":{}}],["mprofileinfo",{"_index":2310,"name":{"2964":{}},"parent":{}}],["mprofilemanagerfactory",{"_index":1875,"name":{"2238":{},"2342":{},"2486":{}},"parent":{}}],["mprofilerootdirectory",{"_index":2423,"name":{"3094":{}},"parent":{}}],["mprofiles",{"_index":2573,"name":{"3402":{}},"parent":{}}],["mprofileschemacache",{"_index":2269,"name":{"2918":{}},"parent":{}}],["mprofilesrootdirectory",{"_index":2524,"name":{"3312":{}},"parent":{}}],["mprofiletype",{"_index":1244,"name":{"1482":{},"2500":{},"2514":{},"2525":{},"2536":{},"2547":{},"2558":{},"2569":{},"2600":{},"2613":{},"2623":{},"2707":{},"2770":{},"2776":{},"3096":{},"3755":{}},"parent":{}}],["mprofiletypeconfiguration",{"_index":2425,"name":{"3097":{}},"parent":{}}],["mprofiletypeconfigurations",{"_index":2424,"name":{"3095":{}},"parent":{}}],["mprofiletypemetafilename",{"_index":2428,"name":{"3100":{}},"parent":{}}],["mprofiletyperootdirectory",{"_index":2427,"name":{"3099":{}},"parent":{}}],["mprofiletypeschema",{"_index":2426,"name":{"3098":{}},"parent":{}}],["mprogressapi",{"_index":1684,"name":{"1972":{}},"parent":{}}],["mprogressbar",{"_index":1683,"name":{"1971":{}},"parent":{}}],["mprogressbarspinnerchars",{"_index":1689,"name":{"1977":{}},"parent":{}}],["mprojectdir",{"_index":763,"name":{"816":{}},"parent":{}}],["mpromptphrase",{"_index":1872,"name":{"2234":{},"2346":{},"2488":{}},"parent":{}}],["mproperties",{"_index":779,"name":{"841":{}},"parent":{}}],["mqueuedmessages",{"_index":453,"name":{"454":{}},"parent":{}}],["mreject",{"_index":1151,"name":{"1344":{},"1411":{}},"parent":{}}],["mreqheaders",{"_index":1160,"name":{"1353":{},"1420":{}},"parent":{}}],["mrequest",{"_index":1159,"name":{"1352":{},"1419":{}},"parent":{}}],["mrequeststream",{"_index":1163,"name":{"1356":{},"1423":{}},"parent":{}}],["mresolve",{"_index":1150,"name":{"1343":{},"1410":{}},"parent":{}}],["mresource",{"_index":1158,"name":{"1351":{},"1418":{}},"parent":{}}],["mresponse",{"_index":1152,"name":{"1345":{},"1412":{}},"parent":{}}],["mresponseformat",{"_index":1688,"name":{"1976":{}},"parent":{}}],["mresponsestream",{"_index":1162,"name":{"1355":{},"1422":{}},"parent":{}}],["mrootcommandname",{"_index":1799,"name":{"2122":{},"2168":{},"2343":{},"2482":{},"2738":{},"3014":{},"3341":{}},"parent":{}}],["mschema",{"_index":2029,"name":{"2498":{},"2513":{},"2523":{},"2534":{},"2546":{},"2557":{},"2567":{},"3753":{}},"parent":{}}],["msecure",{"_index":768,"name":{"822":{}},"parent":{}}],["msecured",{"_index":2307,"name":{"2961":{}},"parent":{}}],["msecurefields",{"_index":2572,"name":{"3400":{}},"parent":{}}],["mservicedescription",{"_index":1247,"name":{"1484":{},"2772":{},"2777":{}},"parent":{}}],["msession",{"_index":1168,"name":{"1362":{},"2758":{},"2778":{},"5524":{},"6139":{}},"parent":{}}],["msg",{"_index":306,"name":{"310":{},"1188":{}},"parent":{}}],["msgdata",{"_index":3909,"name":{"5250":{},"5414":{}},"parent":{}}],["msilent",{"_index":1675,"name":{"1962":{}},"parent":{}}],["msshprofile",{"_index":4068,"name":{"5525":{}},"parent":{}}],["mstagename",{"_index":912,"name":{"996":{}},"parent":{}}],["mstatusmessage",{"_index":913,"name":{"997":{}},"parent":{}}],["mstderr",{"_index":1679,"name":{"1966":{}},"parent":{}}],["mstdout",{"_index":1680,"name":{"1967":{}},"parent":{}}],["mstream",{"_index":1692,"name":{"1980":{}},"parent":{}}],["msucceeded",{"_index":1676,"name":{"1963":{}},"parent":{}}],["mtask",{"_index":1164,"name":{"1357":{},"1424":{}},"parent":{}}],["mtime",{"_index":3414,"name":{"4606":{}},"parent":{}}],["mtsostart",{"_index":3991,"name":{"5406":{}},"parent":{}}],["mtypeconfigurations",{"_index":2526,"name":{"3313":{}},"parent":{}}],["multi",{"_index":2957,"name":{"4021":{}},"parent":{}}],["musingteamconfig",{"_index":2259,"name":{"2908":{}},"parent":{}}],["must",{"_index":2953,"name":{"4018":{}},"parent":{}}],["must_read_from_disk",{"_index":2226,"name":{"2854":{}},"parent":{}}],["mustspecifyone",{"_index":839,"name":{"923":{}},"parent":{}}],["mustspecifyoneerror",{"_index":1736,"name":{"2045":{}},"parent":{}}],["mvault",{"_index":767,"name":{"821":{}},"parent":{}}],["mvol",{"_index":3429,"name":{"4627":{}},"parent":{}}],["mwritedata",{"_index":1161,"name":{"1354":{},"1421":{}},"parent":{}}],["myargsinstance",{"_index":1927,"name":{"2339":{},"2480":{}},"parent":{}}],["mzosmfloadedprofile",{"_index":4400,"name":{"6141":{}},"parent":{}}],["mzosmfprofile",{"_index":4399,"name":{"6140":{}},"parent":{}}],["name",{"_index":189,"name":{"141":{},"147":{},"153":{},"159":{},"165":{},"172":{},"178":{},"184":{},"189":{},"672":{},"707":{},"722":{},"731":{},"869":{},"889":{},"897":{},"908":{},"1332":{},"1936":{},"1942":{},"1950":{},"2063":{},"2214":{},"2371":{},"2437":{},"2634":{},"2639":{},"2646":{},"2660":{},"2667":{},"2674":{},"2681":{},"2688":{},"2696":{},"2816":{},"2869":{},"2985":{},"3156":{},"3162":{},"3180":{},"3188":{},"3194":{},"3196":{},"3201":{},"3205":{},"3210":{},"3216":{},"3238":{},"3449":{},"3454":{},"3459":{},"3469":{},"3477":{},"3484":{},"3491":{},"3499":{},"3508":{},"3516":{},"3525":{},"3534":{},"3542":{},"3666":{},"3679":{},"3691":{},"3703":{},"3715":{},"3737":{},"3748":{},"3786":{},"3797":{},"3860":{},"3865":{},"3867":{},"3868":{},"3888":{},"3902":{},"3939":{},"3942":{},"3945":{},"3953":{},"3959":{},"3961":{},"4011":{},"4033":{},"4038":{},"4040":{},"4041":{},"4066":{},"4069":{},"4074":{},"4101":{},"4105":{},"4106":{},"4468":{},"4608":{},"4901":{},"4902":{},"4903":{},"4918":{},"5256":{},"5265":{},"5272":{},"5279":{},"5286":{},"5293":{},"5300":{},"5452":{},"5460":{},"5467":{},"5475":{},"5481":{},"5487":{},"5493":{},"5628":{},"5663":{},"5673":{},"5729":{},"5828":{},"5892":{},"5933":{},"6021":{},"6073":{},"6081":{},"6088":{},"6096":{},"6104":{},"6111":{},"6117":{},"6126":{},"6131":{},"6191":{}},"parent":{}}],["name1",{"_index":2382,"name":{"3052":{},"3057":{}},"parent":{}}],["name2",{"_index":2384,"name":{"3053":{},"3058":{}},"parent":{}}],["newdeleteprofileshandler",{"_index":2763,"name":{"3764":{}},"parent":{}}],["newlinestransform",{"_index":1143,"name":{"1337":{}},"parent":{}}],["nextoperationresult",{"_index":958,"name":{"1044":{}},"parent":{}}],["nexttick",{"_index":2374,"name":{"3045":{}},"parent":{}}],["nexttimestamp",{"_index":3831,"name":{"5170":{}},"parent":{}}],["nextverfeatures",{"_index":2360,"name":{"3034":{}},"parent":{}}],["nickname",{"_index":2901,"name":{"3943":{},"4070":{},"4091":{},"4095":{}},"parent":{}}],["nicknames",{"_index":3002,"name":{"4110":{}},"parent":{}}],["ninety_percent",{"_index":899,"name":{"981":{}},"parent":{}}],["no_gui_no_display",{"_index":2372,"name":{"3043":{}},"parent":{}}],["no_gui_ssh",{"_index":2371,"name":{"3042":{}},"parent":{}}],["no_output",{"_index":904,"name":{"985":{},"1079":{}},"parent":{}}],["no_parms",{"_index":902,"name":{"984":{},"1078":{}},"parent":{}}],["noaccountinfo",{"_index":2823,"name":{"3847":{}},"parent":{}}],["noaccountnumber",{"_index":3887,"name":{"5229":{}},"parent":{}}],["noactionname",{"_index":2827,"name":{"3851":{}},"parent":{}}],["nocollectparameters",{"_index":3070,"name":{"4186":{}},"parent":{}}],["nocommandinput",{"_index":3893,"name":{"5235":{}},"parent":{}}],["nocommandkey",{"_index":3068,"name":{"4184":{}},"parent":{}}],["noconsoleinput",{"_index":3064,"name":{"4180":{}},"parent":{}}],["noconsolename",{"_index":3066,"name":{"4182":{}},"parent":{}}],["nodatainput",{"_index":3891,"name":{"5233":{}},"parent":{}}],["nodatasetsinlist",{"_index":3237,"name":{"4351":{}},"parent":{}}],["nodatasetsmatchingpattern",{"_index":3239,"name":{"4353":{}},"parent":{}}],["nodatasetsmatchingpatternremain",{"_index":3241,"name":{"4355":{}},"parent":{}}],["nodejs_ver",{"_index":2668,"name":{"3601":{}},"parent":{}}],["nodejsfserror",{"_index":3247,"name":{"4361":{}},"parent":{}}],["noinstanceid",{"_index":2825,"name":{"3849":{}},"parent":{}}],["noload",{"_index":622,"name":{"632":{}},"parent":{}}],["nomembersfound",{"_index":3191,"name":{"4305":{}},"parent":{}}],["noowner",{"_index":4115,"name":{"5609":{}},"parent":{}}],["nopeerdependency",{"_index":1437,"name":{"1705":{}},"parent":{}}],["nopinginput",{"_index":3885,"name":{"5227":{}},"parent":{}}],["normalizedir",{"_index":1362,"name":{"1618":{}},"parent":{}}],["normalizeextension",{"_index":381,"name":{"377":{}},"parent":{}}],["normalizenewline",{"_index":3476,"name":{"4686":{}},"parent":{}}],["normalizerequestnewlines",{"_index":1040,"name":{"1173":{},"1288":{},"4457":{}},"parent":{}}],["normalizeresponsenewlines",{"_index":1039,"name":{"1172":{},"1287":{},"4456":{}},"parent":{}}],["nosecure",{"_index":1938,"name":{"2375":{},"2377":{},"3159":{},"3166":{}},"parent":{}}],["noservletkeyinput",{"_index":3889,"name":{"5231":{}},"parent":{}}],["nosession",{"_index":281,"name":{"287":{}},"parent":{}}],["nosessionmessage",{"_index":3841,"name":{"5183":{}},"parent":{}}],["nosessionprovisioning",{"_index":2819,"name":{"3843":{}},"parent":{}}],["nosessiontso",{"_index":3875,"name":{"5217":{}},"parent":{}}],["nosteps",{"_index":4103,"name":{"5597":{}},"parent":{}}],["nosystemname",{"_index":4111,"name":{"5605":{}},"parent":{}}],["not",{"_index":3648,"name":{"4919":{}},"parent":{}}],["not_started",{"_index":874,"name":{"958":{}},"parent":{}}],["notanarrayerror",{"_index":1731,"name":{"2040":{}},"parent":{}}],["notemplatename",{"_index":2821,"name":{"3845":{}},"parent":{}}],["notification",{"_index":103,"name":{"81":{}},"parent":{}}],["notsoissueinput",{"_index":3879,"name":{"5221":{}},"parent":{}}],["notsostartinput",{"_index":3877,"name":{"5219":{}},"parent":{}}],["notsostopinput",{"_index":3881,"name":{"5223":{}},"parent":{}}],["novariables",{"_index":4105,"name":{"5599":{}},"parent":{}}],["noworkflowdefinitionfile",{"_index":4107,"name":{"5601":{}},"parent":{}}],["noworkflowkey",{"_index":4099,"name":{"5593":{}},"parent":{}}],["noworkflowname",{"_index":4109,"name":{"5603":{}},"parent":{}}],["nozosmfinput",{"_index":3062,"name":{"4178":{}},"parent":{}}],["nozosmfresponse",{"_index":3883,"name":{"5225":{}},"parent":{}}],["nozosmfversion",{"_index":278,"name":{"285":{}},"parent":{}}],["npm_namespace",{"_index":1371,"name":{"1627":{}},"parent":{}}],["npm_ver",{"_index":2676,"name":{"3610":{}},"parent":{}}],["npmlogin",{"_index":2631,"name":{"3559":{}},"parent":{}}],["npmpackagename",{"_index":1385,"name":{"1641":{}},"parent":{}}],["npmpkgnmprop",{"_index":1436,"name":{"1704":{}},"parent":{}}],["number",{"_index":3636,"name":{"4900":{}},"parent":{}}],["numericvaluerange",{"_index":810,"name":{"882":{},"6026":{}},"parent":{}}],["numrows",{"_index":4367,"name":{"6066":{}},"parent":{}}],["nvm_ver",{"_index":2669,"name":{"3602":{}},"parent":{}}],["object",{"_index":2842,"name":{"3866":{},"3938":{},"3939":{},"3940":{},"3944":{},"3945":{},"3954":{},"4039":{},"4066":{},"4067":{},"4068":{},"4075":{}},"parent":{}}],["octet_stream",{"_index":132,"name":{"99":{},"1301":{}},"parent":{}}],["old_profile",{"_index":2179,"name":{"2804":{}},"parent":{}}],["oldprofilefilepath",{"_index":2305,"name":{"2957":{}},"parent":{}}],["omitcmdpropsfromschema",{"_index":2295,"name":{"2946":{}},"parent":{}}],["omitjobiddirectory",{"_index":3675,"name":{"4956":{}},"parent":{}}],["on",{"_index":444,"name":{"445":{}},"parent":{}}],["ondata",{"_index":1171,"name":{"1368":{}},"parent":{}}],["ondocspagechanged",{"_index":2804,"name":{"3828":{}},"parent":{}}],["one_hundred_percent",{"_index":900,"name":{"982":{}},"parent":{}}],["onend",{"_index":1172,"name":{"1369":{}},"parent":{}}],["onlyemptypartitioneddatasets",{"_index":3243,"name":{"4357":{}},"parent":{}}],["onlyfortesting",{"_index":2635,"name":{"3563":{}},"parent":{}}],["onlyoneof",{"_index":840,"name":{"924":{}},"parent":{}}],["onlyoneoferror",{"_index":1737,"name":{"2046":{}},"parent":{}}],["onsearchtextchanged",{"_index":2803,"name":{"3827":{}},"parent":{}}],["ontreecontextmenu",{"_index":2799,"name":{"3823":{}},"parent":{}}],["ontreeloaded",{"_index":2801,"name":{"3825":{}},"parent":{}}],["ontreesearch",{"_index":2800,"name":{"3824":{}},"parent":{}}],["ontreeselectionchanged",{"_index":2802,"name":{"3826":{}},"parent":{}}],["opendiffinbrowser",{"_index":2402,"name":{"3071":{}},"parent":{}}],["opendiffs",{"_index":2393,"name":{"3062":{},"3066":{}},"parent":{}}],["openhelp",{"_index":1784,"name":{"2108":{},"2221":{}},"parent":{}}],["openindefaultapp",{"_index":2378,"name":{"3048":{}},"parent":{}}],["openineditor",{"_index":2379,"name":{"3049":{}},"parent":{}}],["openroothelp",{"_index":1782,"name":{"2107":{},"2220":{}},"parent":{}}],["operation",{"_index":901,"name":{"983":{}},"parent":{}}],["operationcomplete",{"_index":943,"name":{"1029":{}},"parent":{}}],["operationcompleted",{"_index":975,"name":{"1072":{}},"parent":{}}],["operationfailed",{"_index":954,"name":{"1040":{}},"parent":{}}],["operationname",{"_index":925,"name":{"1011":{},"1038":{},"1091":{}},"parent":{}}],["operationobject",{"_index":959,"name":{"1045":{}},"parent":{}}],["operationresult",{"_index":922,"name":{"1007":{},"1087":{}},"parent":{}}],["operationresultmessage",{"_index":928,"name":{"1014":{},"1094":{}},"parent":{}}],["operations",{"_index":965,"name":{"1053":{}},"parent":{}}],["operationsucceeded",{"_index":929,"name":{"1015":{},"1095":{}},"parent":{}}],["operationundoattempted",{"_index":962,"name":{"1048":{}},"parent":{}}],["operationundofailed",{"_index":961,"name":{"1047":{}},"parent":{}}],["operationundopossible",{"_index":960,"name":{"1046":{}},"parent":{}}],["opt_long_dash",{"_index":502,"name":{"502":{}},"parent":{}}],["opt_short_dash",{"_index":503,"name":{"503":{}},"parent":{}}],["optional",{"_index":296,"name":{"301":{},"905":{},"2066":{},"5677":{},"5852":{},"5959":{}},"parent":{}}],["optioncombinationinvaliderror",{"_index":1729,"name":{"2038":{}},"parent":{}}],["optionconstants",{"_index":1660,"name":{"1934":{}},"parent":{}}],["optiondefinition",{"_index":257,"name":{"250":{},"254":{},"258":{},"263":{},"267":{},"271":{},"275":{},"278":{},"281":{},"3319":{},"5315":{},"5319":{},"5322":{},"5326":{},"5329":{},"5333":{},"5336":{},"5544":{},"5547":{},"5552":{},"5556":{},"5559":{},"5563":{},"5566":{},"6160":{},"6163":{},"6168":{},"6172":{},"6175":{},"6178":{},"6181":{},"6184":{},"6187":{},"6190":{},"6197":{}},"parent":{}}],["optiondefinitions",{"_index":2530,"name":{"3320":{}},"parent":{}}],["optiondependencyerror",{"_index":1726,"name":{"2035":{}},"parent":{}}],["optioninerror",{"_index":1706,"name":{"2011":{}},"parent":{}}],["options",{"_index":235,"name":{"226":{},"229":{},"234":{},"237":{},"859":{},"921":{},"1146":{},"3466":{},"3474":{},"3496":{},"3505":{},"3513":{},"3522":{},"3531":{},"3549":{},"3672":{},"3709":{},"3721":{}},"parent":{}}],["options_segment",{"_index":481,"name":{"481":{}},"parent":{}}],["optiontodescription",{"_index":1805,"name":{"2131":{},"2177":{}},"parent":{}}],["optionwasspecified",{"_index":1465,"name":{"1731":{}},"parent":{}}],["opts",{"_index":773,"name":{"830":{}},"parent":{}}],["original",{"_index":734,"name":{"790":{},"4930":{}},"parent":{}}],["origrequire",{"_index":2728,"name":{"3661":{}},"parent":{}}],["os_linux",{"_index":379,"name":{"375":{}},"parent":{}}],["os_mac",{"_index":378,"name":{"374":{}},"parent":{}}],["os_path",{"_index":2671,"name":{"3605":{}},"parent":{}}],["os_win32",{"_index":377,"name":{"373":{}},"parent":{}}],["osloc",{"_index":2185,"name":{"2810":{}},"parent":{}}],["oslocinfo",{"_index":2194,"name":{"2824":{},"2879":{},"2891":{}},"parent":{}}],["other_zowe_vars",{"_index":2675,"name":{"3609":{}},"parent":{}}],["outcome",{"_index":2498,"name":{"3246":{}},"parent":{}}],["outcometostring",{"_index":2517,"name":{"3264":{}},"parent":{}}],["outdir",{"_index":3673,"name":{"4953":{}},"parent":{}}],["output",{"_index":964,"name":{"1052":{},"1111":{},"1117":{},"5699":{},"5853":{},"5960":{}},"parent":{}}],["output_format",{"_index":993,"name":{"1115":{}},"parent":{}}],["outputformat",{"_index":2386,"name":{"3055":{}},"parent":{}}],["outputformatoptions",{"_index":844,"name":{"928":{}},"parent":{}}],["outputseparator",{"_index":906,"name":{"987":{}},"parent":{}}],["outputsub",{"_index":4186,"name":{"5700":{},"5854":{},"5961":{}},"parent":{}}],["outputvariablesprefix",{"_index":4187,"name":{"5701":{},"5855":{},"5962":{}},"parent":{}}],["over_error",{"_index":1403,"name":{"1657":{}},"parent":{}}],["overallmessage",{"_index":2505,"name":{"3252":{}},"parent":{}}],["overallresult",{"_index":2503,"name":{"3251":{}},"parent":{}}],["overrides",{"_index":695,"name":{"747":{},"2995":{}},"parent":{}}],["overridesloader",{"_index":2053,"name":{"2586":{}},"parent":{}}],["overridewithenv",{"_index":2173,"name":{"2799":{},"2959":{}},"parent":{}}],["overroteprofilemessage",{"_index":1613,"name":{"1878":{}},"parent":{}}],["overwrite",{"_index":2459,"name":{"3183":{},"3191":{},"4724":{},"4829":{}},"parent":{}}],["overwrite_option",{"_index":511,"name":{"511":{}},"parent":{}}],["overwritten",{"_index":2484,"name":{"3228":{}},"parent":{}}],["ovf",{"_index":3430,"name":{"4628":{}},"parent":{}}],["owner",{"_index":2839,"name":{"3862":{},"3933":{},"4035":{},"4517":{},"4908":{},"4931":{},"4994":{},"5053":{},"5581":{},"5634":{},"5769":{},"5791":{},"5811":{},"5856":{},"5905":{},"5963":{}},"parent":{}}],["package",{"_index":1395,"name":{"1650":{}},"parent":{}}],["padleft",{"_index":283,"name":{"289":{}},"parent":{}}],["params",{"_index":1254,"name":{"1492":{},"1501":{},"1516":{},"3582":{},"3588":{},"3647":{}},"parent":{}}],["parentregistryid",{"_index":4293,"name":{"5923":{}},"parent":{}}],["parents",{"_index":1906,"name":{"2291":{},"2313":{},"2358":{}},"parent":{}}],["parm_acct",{"_index":3862,"name":{"5203":{}},"parent":{}}],["parm_chset",{"_index":3858,"name":{"5199":{}},"parent":{}}],["parm_cols",{"_index":3861,"name":{"5202":{}},"parent":{}}],["parm_cpage",{"_index":3859,"name":{"5200":{}},"parent":{}}],["parm_proc",{"_index":3856,"name":{"5198":{}},"parent":{}}],["parm_rows",{"_index":3860,"name":{"5201":{}},"parent":{}}],["parm_rsize",{"_index":3863,"name":{"5204":{}},"parent":{}}],["parms",{"_index":1218,"name":{"1453":{}},"parent":{}}],["parse",{"_index":2122,"name":{"2728":{},"3033":{},"4716":{}},"parent":{}}],["parseattributeoptions",{"_index":3535,"name":{"4764":{}},"parent":{}}],["parsekeyvaluestring",{"_index":347,"name":{"346":{}},"parent":{}}],["parseproperties",{"_index":3008,"name":{"4115":{},"5656":{}},"parent":{}}],["parseschema",{"_index":1290,"name":{"1542":{}},"parent":{}}],["partitioned",{"_index":3378,"name":{"4530":{}},"parent":{}}],["passon",{"_index":831,"name":{"912":{},"2460":{}},"parent":{}}],["passphrase",{"_index":1068,"name":{"1223":{}},"parent":{}}],["password",{"_index":263,"name":{"260":{},"1213":{},"1465":{},"5443":{},"5553":{},"6169":{}},"parent":{}}],["path",{"_index":607,"name":{"618":{},"1158":{},"1674":{},"2817":{},"3220":{},"3226":{},"3231":{},"4590":{}},"parent":{}}],["pathisnotdirectory",{"_index":3225,"name":{"4339":{}},"parent":{}}],["paths",{"_index":778,"name":{"838":{}},"parent":{}}],["pathtodataset",{"_index":3561,"name":{"4806":{}},"parent":{}}],["pattern",{"_index":315,"name":{"318":{},"4600":{}},"parent":{}}],["payload",{"_index":1047,"name":{"1185":{}},"parent":{}}],["peerdepname",{"_index":1380,"name":{"1637":{}},"parent":{}}],["peerdepver",{"_index":1382,"name":{"1638":{}},"parent":{}}],["percentcomplete",{"_index":877,"name":{"961":{},"991":{},"1065":{},"5911":{}},"parent":{}}],["perfombasicvalidation",{"_index":2003,"name":{"2453":{}},"parent":{}}],["performaction",{"_index":2978,"name":{"4062":{}},"parent":{}}],["performbasicoptionvalidation",{"_index":2005,"name":{"2455":{}},"parent":{}}],["performbasicpositionalvalidation",{"_index":2004,"name":{"2454":{}},"parent":{}}],["performsubsequent",{"_index":4309,"name":{"6002":{}},"parent":{}}],["performundo",{"_index":920,"name":{"1005":{},"1086":{}},"parent":{}}],["perm",{"_index":3415,"name":{"4609":{}},"parent":{}}],["perms",{"_index":3371,"name":{"4519":{}},"parent":{}}],["permutesearchstr",{"_index":2797,"name":{"3821":{}},"parent":{}}],["persistence",{"_index":1422,"name":{"1683":{}},"parent":{}}],["phase",{"_index":3646,"name":{"4917":{},"4918":{}},"parent":{}}],["ping",{"_index":3980,"name":{"5394":{}},"parent":{}}],["pingtso",{"_index":3979,"name":{"5393":{}},"parent":{}}],["places",{"_index":2960,"name":{"4024":{}},"parent":{}}],["platform",{"_index":2367,"name":{"3039":{},"3603":{}},"parent":{}}],["plugin_config",{"_index":1377,"name":{"1633":{}},"parent":{}}],["plugin_home_location",{"_index":1378,"name":{"1634":{}},"parent":{}}],["plugin_install_location",{"_index":1374,"name":{"1630":{}},"parent":{}}],["plugin_json",{"_index":1373,"name":{"1629":{}},"parent":{}}],["plugin_node_module_location",{"_index":1375,"name":{"1631":{}},"parent":{}}],["plugin_using_config",{"_index":1376,"name":{"1632":{}},"parent":{}}],["pluginaliases",{"_index":2337,"name":{"2998":{}},"parent":{}}],["pluginconfigs",{"_index":16,"name":{"10":{}},"parent":{}}],["plugindefaultname",{"_index":4341,"name":{"6038":{}},"parent":{}}],["pluginfirststeps",{"_index":2339,"name":{"3000":{}},"parent":{}}],["pluginhealthcheck",{"_index":2336,"name":{"2997":{}},"parent":{}}],["pluginissues",{"_index":1405,"name":{"1659":{},"1661":{},"1703":{},"3724":{}},"parent":{}}],["pluginlifecycle",{"_index":2335,"name":{"2996":{}},"parent":{}}],["pluginmanagementfacility",{"_index":1426,"name":{"1692":{}},"parent":{}}],["pluginname",{"_index":10,"name":{"5":{},"1640":{}},"parent":{}}],["pluginnms",{"_index":69,"name":{"56":{}},"parent":{}}],["pluginoverrides",{"_index":1431,"name":{"1698":{}},"parent":{}}],["pluginrequirealreadycreatederror",{"_index":2753,"name":{"3727":{}},"parent":{}}],["pluginrequirenotcreatederror",{"_index":2755,"name":{"3738":{}},"parent":{}}],["pluginrequireprovider",{"_index":2723,"name":{"3656":{}},"parent":{}}],["plugins",{"_index":605,"name":{"616":{},"826":{},"6048":{}},"parent":{}}],["pluginsdir",{"_index":470,"name":{"471":{}},"parent":{}}],["pluginstatus",{"_index":4342,"name":{"6039":{}},"parent":{}}],["pluginsummary",{"_index":2338,"name":{"2999":{}},"parent":{}}],["pluginversion",{"_index":4339,"name":{"6037":{}},"parent":{}}],["pmf_root",{"_index":1372,"name":{"1628":{}},"parent":{}}],["pmfconst",{"_index":1432,"name":{"1699":{}},"parent":{}}],["pmfconstants",{"_index":1367,"name":{"1622":{}},"parent":{}}],["pollforstatus",{"_index":3769,"name":{"5104":{}},"parent":{}}],["populate",{"_index":3075,"name":{"4191":{}},"parent":{}}],["populateerror",{"_index":1173,"name":{"1370":{},"4192":{}},"parent":{}}],["populatepassonvaluefromparent",{"_index":2007,"name":{"2457":{}},"parent":{}}],["populateping",{"_index":3978,"name":{"5392":{}},"parent":{}}],["populateproperties",{"_index":2158,"name":{"2785":{}},"parent":{}}],["populatestartandstop",{"_index":3975,"name":{"5390":{}},"parent":{}}],["populatestartandstopcollectall",{"_index":3977,"name":{"5391":{}},"parent":{}}],["port",{"_index":259,"name":{"252":{},"1159":{},"1181":{},"1211":{},"1463":{},"5441":{},"5545":{},"5702":{},"5857":{},"5964":{},"6161":{}},"parent":{}}],["portsub",{"_index":4188,"name":{"5703":{},"5858":{},"5965":{}},"parent":{}}],["positionalparameterinvalid",{"_index":1722,"name":{"2031":{}},"parent":{}}],["positionals",{"_index":838,"name":{"922":{},"1130":{},"3465":{},"3504":{},"3521":{},"3548":{},"3671":{},"3685":{},"3696":{},"3708":{},"3720":{}},"parent":{}}],["possiblesolutions",{"_index":655,"name":{"677":{},"696":{},"736":{}},"parent":{}}],["postexpectbuffer",{"_index":1186,"name":{"1389":{}},"parent":{}}],["postexpectfullresponse",{"_index":1201,"name":{"1404":{}},"parent":{}}],["postexpectjson",{"_index":1182,"name":{"1385":{}},"parent":{}}],["postexpectstring",{"_index":1190,"name":{"1393":{}},"parent":{}}],["postinstall",{"_index":2140,"name":{"2755":{}},"parent":{}}],["poststreamed",{"_index":1195,"name":{"1398":{}},"parent":{}}],["poststreamedrequestonly",{"_index":1196,"name":{"1399":{}},"parent":{}}],["prefix",{"_index":442,"name":{"443":{},"861":{},"4995":{}},"parent":{}}],["prepare",{"_index":1884,"name":{"2258":{},"2451":{}},"parent":{}}],["prepareforundo",{"_index":978,"name":{"1075":{}},"parent":{}}],["prereqstep",{"_index":4167,"name":{"5676":{},"5859":{},"5966":{}},"parent":{}}],["preserveoriginallettercase",{"_index":3508,"name":{"4723":{}},"parent":{}}],["prettyjson",{"_index":339,"name":{"338":{}},"parent":{}}],["preuninstall",{"_index":2142,"name":{"2756":{}},"parent":{}}],["primary",{"_index":3352,"name":{"4485":{},"4506":{},"4533":{},"4541":{},"4548":{},"4556":{},"4564":{},"4570":{},"4574":{}},"parent":{}}],["primary_command",{"_index":477,"name":{"477":{}},"parent":{}}],["primary_segment_number",{"_index":483,"name":{"483":{}},"parent":{}}],["primaryhighlightcolor",{"_index":1793,"name":{"2117":{},"2583":{},"3349":{},"3359":{}},"parent":{}}],["primarytextcolor",{"_index":1658,"name":{"1930":{},"2993":{}},"parent":{}}],["print_plan_option",{"_index":2514,"name":{"3260":{}},"parent":{}}],["printfilescreatedlist",{"_index":938,"name":{"1024":{},"1101":{}},"parent":{}}],["priorityvalue",{"_index":64,"name":{"49":{}},"parent":{}}],["privatekey",{"_index":4021,"name":{"5444":{},"5557":{}},"parent":{}}],["probexpr",{"_index":2681,"name":{"3615":{}},"parent":{}}],["probmsg",{"_index":2682,"name":{"3616":{}},"parent":{}}],["probtests",{"_index":2683,"name":{"3617":{}},"parent":{}}],["proc",{"_index":3637,"name":{"4901":{}},"parent":{}}],["process",{"_index":1011,"name":{"1137":{},"1485":{},"2773":{},"2780":{},"3335":{},"3339":{},"3572":{},"3580":{},"3583":{},"3590":{},"3595":{},"3597":{},"3641":{},"3645":{},"3648":{},"3651":{},"3653":{},"3655":{},"3677":{},"3689":{},"3700":{},"3713":{},"3725":{},"3761":{},"3763":{},"3765":{},"3767":{},"3769":{},"3771":{},"3774":{},"5407":{},"5528":{},"6144":{}},"parent":{}}],["processautoinit",{"_index":2156,"name":{"2783":{}},"parent":{}}],["processcmd",{"_index":4070,"name":{"5534":{},"6150":{}},"parent":{}}],["processerror",{"_index":166,"name":{"123":{},"1365":{},"1431":{}},"parent":{}}],["processlogin",{"_index":1251,"name":{"1489":{},"2763":{}},"parent":{}}],["processloginold",{"_index":2150,"name":{"2768":{}},"parent":{}}],["processlogout",{"_index":1252,"name":{"1490":{},"2767":{}},"parent":{}}],["processlogoutold",{"_index":2151,"name":{"2769":{}},"parent":{}}],["processnewlines",{"_index":391,"name":{"387":{}},"parent":{}}],["processresponses",{"_index":3025,"name":{"4135":{},"4141":{},"4156":{},"5178":{}},"parent":{}}],["processsecureproperties",{"_index":1951,"name":{"2388":{}},"parent":{}}],["processstepsummaries",{"_index":4305,"name":{"5998":{}},"parent":{}}],["processutils",{"_index":2373,"name":{"3044":{}},"parent":{}}],["procname",{"_index":3745,"name":{"5079":{},"5704":{},"5860":{},"5967":{}},"parent":{}}],["procstep",{"_index":3683,"name":{"4974":{},"5823":{}},"parent":{}}],["producemarkdown",{"_index":1792,"name":{"2116":{},"2584":{},"3350":{},"3360":{}},"parent":{}}],["productdisplayname",{"_index":1961,"name":{"2403":{},"2986":{},"3108":{},"3173":{},"3282":{}},"parent":{}}],["productid",{"_index":4227,"name":{"5759":{},"5908":{}},"parent":{}}],["productname",{"_index":4228,"name":{"5760":{},"5909":{}},"parent":{}}],["productversion",{"_index":4229,"name":{"5761":{},"5910":{}},"parent":{}}],["prof_not_found",{"_index":2229,"name":{"2857":{}},"parent":{}}],["profattrstoprofloaded",{"_index":2281,"name":{"2932":{}},"parent":{}}],["profile",{"_index":841,"name":{"925":{},"2438":{},"3179":{},"3187":{},"3198":{},"3203":{},"3206":{},"3211":{},"3217":{},"3229":{},"3233":{},"3254":{}},"parent":{}}],["profile_aliases",{"_index":508,"name":{"508":{}},"parent":{}}],["profile_delete_profile_deps",{"_index":521,"name":{"521":{}},"parent":{}}],["profile_delete_profile_deps_alias",{"_index":522,"name":{"522":{}},"parent":{}}],["profile_extension",{"_index":1957,"name":{"2396":{},"3090":{},"3275":{}},"parent":{}}],["profile_group",{"_index":506,"name":{"506":{}},"parent":{}}],["profile_name_option",{"_index":509,"name":{"509":{}},"parent":{}}],["profile_name_option_alias",{"_index":510,"name":{"510":{}},"parent":{}}],["profile_object",{"_index":507,"name":{"507":{}},"parent":{}}],["profile_set_option_alias",{"_index":519,"name":{"519":{}},"parent":{}}],["profileconstants",{"_index":185,"name":{"138":{}},"parent":{}}],["profilecreatedsuccessfully",{"_index":1619,"name":{"1884":{}},"parent":{}}],["profilecreatedsuccessfullyandpath",{"_index":1589,"name":{"1854":{}},"parent":{}}],["profilecreateerrordetails",{"_index":1599,"name":{"1864":{}},"parent":{}}],["profilecreateerrorheader",{"_index":1595,"name":{"1860":{}},"parent":{}}],["profilecredentials",{"_index":2306,"name":{"2960":{}},"parent":{}}],["profiledeletedsuccessfully",{"_index":1603,"name":{"1868":{}},"parent":{}}],["profiledeleteerrordetails",{"_index":1611,"name":{"1876":{}},"parent":{}}],["profiledeleteerrorheader",{"_index":1605,"name":{"1870":{}},"parent":{}}],["profiledesc",{"_index":1615,"name":{"1880":{}},"parent":{}}],["profiledir",{"_index":2354,"name":{"3025":{}},"parent":{}}],["profilefactory",{"_index":1878,"name":{"2249":{}},"parent":{}}],["profileinfo",{"_index":2256,"name":{"2906":{}},"parent":{}}],["profileio",{"_index":2407,"name":{"3075":{}},"parent":{}}],["profileloaderror",{"_index":1493,"name":{"1758":{}},"parent":{}}],["profilemanager",{"_index":1350,"name":{"1607":{}},"parent":{}}],["profilemanagerfactory",{"_index":1754,"name":{"2069":{},"2098":{},"2288":{},"2310":{},"2327":{},"2355":{},"2467":{}},"parent":{}}],["profilename",{"_index":1269,"name":{"1509":{},"2821":{},"2872":{}},"parent":{}}],["profilenotdeletedmessage",{"_index":1601,"name":{"1866":{}},"parent":{}}],["profilepath",{"_index":1260,"name":{"1497":{},"1512":{}},"parent":{}}],["profileprops",{"_index":1256,"name":{"1493":{},"1502":{},"1517":{}},"parent":{}}],["profilereviewmessage",{"_index":1593,"name":{"1858":{}},"parent":{}}],["profilerootdirectory",{"_index":1967,"name":{"2409":{},"3114":{},"3168":{},"3176":{},"3288":{}},"parent":{}}],["profilerpts",{"_index":78,"name":{"64":{}},"parent":{}}],["profiles",{"_index":597,"name":{"606":{},"613":{},"825":{},"1131":{},"2089":{},"2987":{}},"parent":{}}],["profiles_command_type_key",{"_index":549,"name":{"548":{}},"parent":{}}],["profiles_dir",{"_index":478,"name":{"478":{}},"parent":{}}],["profiles_option_securely_stored",{"_index":551,"name":{"549":{}},"parent":{}}],["profileschemas",{"_index":2357,"name":{"3031":{},"3403":{}},"parent":{}}],["profilescommandbuilder",{"_index":2028,"name":{"2497":{}},"parent":{}}],["profilesconstants",{"_index":548,"name":{"547":{}},"parent":{}}],["profilesconverted",{"_index":2163,"name":{"2789":{}},"parent":{}}],["profilescreatecommandbuilder",{"_index":2034,"name":{"2508":{}},"parent":{}}],["profilesdefinition",{"_index":2610,"name":{"3483":{}},"parent":{}}],["profilesdeletecommandbuilder",{"_index":2038,"name":{"2530":{}},"parent":{}}],["profilesfailed",{"_index":2165,"name":{"2791":{}},"parent":{}}],["profileshandler",{"_index":2663,"name":{"3596":{}},"parent":{}}],["profileslistcommandbuilder",{"_index":2042,"name":{"2552":{}},"parent":{}}],["profilesrootdirectory",{"_index":2527,"name":{"3316":{}},"parent":{}}],["profilessetcommandbuilder",{"_index":2044,"name":{"2563":{}},"parent":{}}],["profilesshowdependenciescommandbuilder",{"_index":2757,"name":{"3749":{}},"parent":{}}],["profilesupdatecommandbuilder",{"_index":2036,"name":{"2519":{}},"parent":{}}],["profilesvalidatecommandbuilder",{"_index":2040,"name":{"2541":{}},"parent":{}}],["profiletype",{"_index":1270,"name":{"1510":{},"2402":{},"2656":{},"2871":{},"3107":{},"3281":{}},"parent":{}}],["profiletypeconfiguration",{"_index":1962,"name":{"2404":{},"3109":{},"3283":{}},"parent":{}}],["profiletypeconfigurations",{"_index":1963,"name":{"2405":{},"3110":{},"3284":{}},"parent":{}}],["profiletypemetafilename",{"_index":1966,"name":{"2408":{},"3113":{},"3287":{}},"parent":{}}],["profiletyperootdirectory",{"_index":1965,"name":{"2407":{},"3112":{},"3286":{}},"parent":{}}],["profiletypes",{"_index":1257,"name":{"1494":{},"1503":{},"1518":{},"2897":{}},"parent":{}}],["profiletypeschema",{"_index":1964,"name":{"2406":{},"3111":{},"3285":{}},"parent":{}}],["profileupdatedsuccessfullyandpath",{"_index":1591,"name":{"1856":{}},"parent":{}}],["profileutils",{"_index":1990,"name":{"2441":{}},"parent":{}}],["profilevalidator",{"_index":2511,"name":{"3258":{}},"parent":{}}],["profinfoerr",{"_index":2219,"name":{"2848":{}},"parent":{}}],["profloc",{"_index":2207,"name":{"2838":{}},"parent":{}}],["profloctype",{"_index":2178,"name":{"2803":{}},"parent":{}}],["profname",{"_index":12,"name":{"7":{},"53":{},"2835":{}},"parent":{}}],["proftype",{"_index":14,"name":{"8":{},"54":{},"2836":{}},"parent":{}}],["program",{"_index":3638,"name":{"4903":{}},"parent":{}}],["progress",{"_index":574,"name":{"583":{},"965":{},"1122":{},"1985":{},"3367":{},"5533":{},"6149":{}},"parent":{}}],["progressapi",{"_index":2690,"name":{"3623":{}},"parent":{}}],["progressbarspinner",{"_index":1659,"name":{"1933":{},"2982":{}},"parent":{}}],["projectdir",{"_index":620,"name":{"630":{}},"parent":{}}],["promise",{"_index":885,"name":{"968":{}},"parent":{}}],["prompt",{"_index":572,"name":{"581":{},"950":{},"3915":{},"3919":{},"4042":{},"4044":{},"4048":{},"5354":{}},"parent":{}}],["prompt_phrase_suffix",{"_index":541,"name":{"540":{}},"parent":{}}],["promptatcreate",{"_index":4217,"name":{"5742":{}},"parent":{}}],["promptfn",{"_index":3582,"name":{"4830":{}},"parent":{}}],["promptforbaseprofile",{"_index":2148,"name":{"2765":{}},"parent":{}}],["promptforinput",{"_index":2563,"name":{"3384":{}},"parent":{}}],["promptforprop",{"_index":2660,"name":{"3593":{}},"parent":{}}],["promptparams",{"_index":1235,"name":{"1474":{}},"parent":{}}],["promptphrase",{"_index":468,"name":{"469":{},"2103":{},"2246":{},"2285":{},"2307":{},"2333":{},"2352":{},"2473":{}},"parent":{}}],["promptprops",{"_index":2657,"name":{"3589":{}},"parent":{}}],["prompttextforvalues",{"_index":1226,"name":{"1461":{}},"parent":{}}],["promptwithtimeout",{"_index":2564,"name":{"3386":{}},"parent":{}}],["prop_cookie",{"_index":1134,"name":{"1318":{}},"parent":{}}],["prop_not_in_profile",{"_index":2227,"name":{"2855":{}},"parent":{}}],["properties",{"_index":253,"name":{"247":{},"557":{},"564":{},"603":{},"620":{},"787":{},"840":{},"1535":{},"3323":{},"3327":{},"5312":{},"5541":{},"6157":{}},"parent":{}}],["propertiesoverridden",{"_index":1210,"name":{"1446":{}},"parent":{}}],["propertiesworkflow",{"_index":4302,"name":{"5996":{}},"parent":{}}],["property",{"_index":822,"name":{"899":{},"2874":{},"2880":{},"2884":{},"2892":{},"2894":{}},"parent":{}}],["propertymappings",{"_index":4189,"name":{"5705":{}},"parent":{}}],["propertyname",{"_index":1207,"name":{"1444":{}},"parent":{}}],["propertyoverrides",{"_index":1216,"name":{"1451":{}},"parent":{}}],["prophasvalue",{"_index":1231,"name":{"1470":{}},"parent":{}}],["propname",{"_index":61,"name":{"47":{},"2822":{}},"parent":{}}],["propstostore",{"_index":1268,"name":{"1508":{}},"parent":{}}],["protectagainstoverwrite",{"_index":2431,"name":{"3143":{}},"parent":{}}],["protocol",{"_index":1046,"name":{"1180":{},"1214":{},"6185":{}},"parent":{}}],["provider",{"_index":2088,"name":{"2654":{},"3934":{}},"parent":{}}],["provisioned",{"_index":2903,"name":{"3947":{}},"parent":{}}],["provisioningconstants",{"_index":2809,"name":{"3833":{}},"parent":{}}],["provisioningservice",{"_index":3007,"name":{"4114":{}},"parent":{}}],["provisioningvalidator",{"_index":2829,"name":{"3853":{}},"parent":{}}],["provisionpublishedtemplate",{"_index":3003,"name":{"4111":{}},"parent":{}}],["provisiontemplate",{"_index":3006,"name":{"4113":{}},"parent":{}}],["provisiontemplatecommon",{"_index":3004,"name":{"4112":{}},"parent":{}}],["psc",{"_index":2850,"name":{"3876":{},"3878":{},"3882":{}},"parent":{}}],["purge",{"_index":3461,"name":{"4671":{},"4846":{}},"parent":{}}],["putexpectbuffer",{"_index":1185,"name":{"1388":{}},"parent":{}}],["putexpectfullresponse",{"_index":1199,"name":{"1402":{}},"parent":{}}],["putexpectjson",{"_index":1181,"name":{"1384":{}},"parent":{}}],["putexpectstring",{"_index":1189,"name":{"1392":{}},"parent":{}}],["putstreamed",{"_index":1193,"name":{"1396":{}},"parent":{}}],["putstreamedrequestonly",{"_index":1194,"name":{"1397":{}},"parent":{}}],["putusspayload",{"_index":3484,"name":{"4696":{}},"parent":{}}],["query_id",{"_index":1135,"name":{"1319":{},"4878":{}},"parent":{}}],["query_jobid",{"_index":3617,"name":{"4882":{}},"parent":{}}],["query_max_jobs",{"_index":3619,"name":{"4884":{}},"parent":{}}],["query_owner",{"_index":3615,"name":{"4880":{}},"parent":{}}],["query_prefix",{"_index":3616,"name":{"4881":{}},"parent":{}}],["query_status",{"_index":3618,"name":{"4883":{}},"parent":{}}],["queryparameters",{"_index":4190,"name":{"5706":{},"5861":{},"5968":{}},"parent":{}}],["queryparameterssub",{"_index":4191,"name":{"5707":{},"5862":{},"5969":{}},"parent":{}}],["queuedmessages",{"_index":457,"name":{"459":{}},"parent":{}}],["queueid",{"_index":3995,"name":{"5410":{}},"parent":{}}],["queuemessage",{"_index":458,"name":{"460":{}},"parent":{}}],["range",{"_index":153,"name":{"115":{},"4657":{},"4726":{},"5177":{}},"parent":{}}],["rc",{"_index":3737,"name":{"5060":{}},"parent":{}}],["rdate",{"_index":3431,"name":{"4629":{}},"parent":{}}],["read",{"_index":543,"name":{"542":{},"641":{},"1671":{},"1677":{}},"parent":{}}],["readextendersjsonfromdisk",{"_index":2291,"name":{"2942":{}},"parent":{}}],["readfilesync",{"_index":388,"name":{"384":{}},"parent":{}}],["readmeta",{"_index":2440,"name":{"3152":{}},"parent":{}}],["readmetafile",{"_index":2411,"name":{"3078":{}},"parent":{}}],["readprofilefile",{"_index":2416,"name":{"3086":{}},"parent":{}}],["readprofilesfromdisk",{"_index":2282,"name":{"2933":{}},"parent":{}}],["readprompt",{"_index":2565,"name":{"3387":{}},"parent":{}}],["readpropertiesfromyamlfile",{"_index":3010,"name":{"4116":{}},"parent":{}}],["readstdin",{"_index":287,"name":{"293":{},"2008":{}},"parent":{}}],["readstdinifrequested",{"_index":1702,"name":{"2007":{}},"parent":{}}],["readyforvalidation",{"_index":2475,"name":{"3214":{}},"parent":{}}],["reason",{"_index":3647,"name":{"4919":{},"5061":{}},"parent":{}}],["recall",{"_index":143,"name":{"106":{},"108":{},"110":{},"4599":{},"4778":{}},"parent":{}}],["recfm",{"_index":92,"name":{"73":{},"4489":{},"4535":{},"4542":{},"4549":{},"4557":{},"4565":{},"4630":{},"4963":{}},"parent":{}}],["reconstructcommand",{"_index":1463,"name":{"1730":{}},"parent":{}}],["record",{"_index":3331,"name":{"4442":{},"4659":{},"4728":{},"4789":{},"4959":{},"4965":{},"5069":{},"5820":{}},"parent":{}}],["recordcredmgrinconfig",{"_index":707,"name":{"757":{}},"parent":{}}],["recorddefaultcredmgrinconfig",{"_index":708,"name":{"758":{}},"parent":{}}],["recordissue",{"_index":1413,"name":{"1669":{}},"parent":{}}],["records",{"_index":3681,"name":{"4970":{}},"parent":{}}],["recursive",{"_index":3549,"name":{"4779":{}},"parent":{}}],["referencedby",{"_index":1987,"name":{"2436":{}},"parent":{}}],["references",{"_index":4282,"name":{"5889":{},"5994":{}},"parent":{}}],["regex",{"_index":818,"name":{"893":{},"3662":{},"4020":{}},"parent":{}}],["regionsize",{"_index":3854,"name":{"5196":{},"5331":{},"5708":{},"5863":{},"5970":{}},"parent":{}}],["registry",{"_index":1397,"name":{"1651":{},"3891":{},"3941":{},"4092":{},"4098":{}},"parent":{}}],["registryid",{"_index":4292,"name":{"5922":{}},"parent":{}}],["regularexpression",{"_index":4218,"name":{"5743":{}},"parent":{}}],["reinitialize",{"_index":2455,"name":{"3177":{}},"parent":{}}],["rejectifdependency",{"_index":2445,"name":{"3157":{}},"parent":{}}],["rejectunauthorized",{"_index":265,"name":{"265":{},"1160":{},"1220":{},"6173":{}},"parent":{}}],["release",{"_index":3695,"name":{"4989":{}},"parent":{}}],["reload",{"_index":775,"name":{"833":{}},"parent":{}}],["removecmdgrpfromresolvedclicmdtree",{"_index":1448,"name":{"1716":{}},"parent":{}}],["removecontext",{"_index":428,"name":{"422":{}},"parent":{}}],["removeissuesforplugin",{"_index":1412,"name":{"1668":{}},"parent":{}}],["removeknownproperty",{"_index":2274,"name":{"2924":{}},"parent":{}}],["removeoverride",{"_index":2645,"name":{"3575":{}},"parent":{}}],["rename",{"_index":3606,"name":{"4869":{},"4872":{}},"parent":{}}],["renameussfile",{"_index":3489,"name":{"4700":{}},"parent":{}}],["renderhelp",{"_index":1811,"name":{"2140":{},"2183":{}},"parent":{}}],["rendermarkdown",{"_index":1848,"name":{"2203":{}},"parent":{}}],["rendertemplatefromkeyvaluearguments",{"_index":348,"name":{"347":{}},"parent":{}}],["renderwithmustache",{"_index":337,"name":{"336":{}},"parent":{}}],["replace",{"_index":3575,"name":{"4822":{},"4834":{}},"parent":{}}],["replyid",{"_index":3825,"name":{"5162":{}},"parent":{}}],["reportenvdefinition",{"_index":2622,"name":{"3533":{}},"parent":{}}],["reportenvhandler",{"_index":2708,"name":{"3640":{}},"parent":{}}],["reqheaders",{"_index":1035,"name":{"1168":{},"1283":{},"4452":{}},"parent":{}}],["request",{"_index":585,"name":{"594":{},"1186":{},"1282":{},"1363":{},"1429":{},"4925":{},"4982":{}},"parent":{}}],["request_cancel",{"_index":3626,"name":{"4892":{}},"parent":{}}],["request_hold",{"_index":3628,"name":{"4894":{}},"parent":{}}],["request_release",{"_index":3629,"name":{"4895":{}},"parent":{}}],["requestbody",{"_index":4192,"name":{"5709":{},"5864":{},"5971":{}},"parent":{}}],["requestbodysub",{"_index":4193,"name":{"5710":{},"5865":{},"5972":{}},"parent":{}}],["requestfailure",{"_index":1101,"name":{"1274":{},"1374":{},"1433":{},"4461":{}},"parent":{}}],["requesthandler",{"_index":1170,"name":{"1367":{}},"parent":{}}],["requeststream",{"_index":1038,"name":{"1171":{},"1286":{},"4455":{}},"parent":{}}],["requestsuccess",{"_index":1099,"name":{"1273":{},"1373":{},"1432":{},"4460":{}},"parent":{}}],["requesttoken",{"_index":1212,"name":{"1448":{}},"parent":{}}],["required",{"_index":275,"name":{"282":{},"567":{},"570":{},"876":{},"892":{},"904":{},"3333":{},"4013":{},"5260":{},"5263":{},"5337":{},"5456":{},"5471":{},"5567":{},"5665":{},"6077":{},"6092":{},"6100":{},"6198":{}},"parent":{}}],["requiredatcreate",{"_index":4219,"name":{"5744":{}},"parent":{}}],["requirekeytar",{"_index":2175,"name":{"2800":{}},"parent":{}}],["requirepluginmodulecallback",{"_index":1443,"name":{"1711":{}},"parent":{}}],["res_ams",{"_index":3114,"name":{"4229":{}},"parent":{}}],["res_def_cn",{"_index":3046,"name":{"4162":{}},"parent":{}}],["res_depth",{"_index":3124,"name":{"4239":{}},"parent":{}}],["res_dont_read_reply",{"_index":3871,"name":{"5213":{}},"parent":{}}],["res_ds_files",{"_index":3109,"name":{"4224":{}},"parent":{}}],["res_ds_level",{"_index":3127,"name":{"4242":{}},"parent":{}}],["res_ds_members",{"_index":3113,"name":{"4228":{}},"parent":{}}],["res_filesys",{"_index":3125,"name":{"4240":{}},"parent":{}}],["res_fsname",{"_index":3116,"name":{"4231":{}},"parent":{}}],["res_group",{"_index":3118,"name":{"4233":{}},"parent":{}}],["res_mfs",{"_index":3112,"name":{"4227":{}},"parent":{}}],["res_mtime",{"_index":3119,"name":{"4234":{}},"parent":{}}],["res_name",{"_index":3120,"name":{"4235":{}},"parent":{}}],["res_path",{"_index":3115,"name":{"4230":{}},"parent":{}}],["res_perm",{"_index":3122,"name":{"4237":{}},"parent":{}}],["res_ping",{"_index":3872,"name":{"5214":{}},"parent":{}}],["res_size",{"_index":3121,"name":{"4236":{}},"parent":{}}],["res_start_tso",{"_index":3870,"name":{"5212":{}},"parent":{}}],["res_symlinks",{"_index":3126,"name":{"4241":{}},"parent":{}}],["res_type",{"_index":3123,"name":{"4238":{}},"parent":{}}],["res_user",{"_index":3117,"name":{"4232":{}},"parent":{}}],["res_uss_files",{"_index":3110,"name":{"4225":{}},"parent":{}}],["res_zfs_files",{"_index":3111,"name":{"4226":{}},"parent":{}}],["resetcounter",{"_index":3060,"name":{"4176":{}},"parent":{}}],["resetenvironmentforapp",{"_index":2115,"name":{"2717":{}},"parent":{}}],["resolve",{"_index":1314,"name":{"1568":{}},"parent":{}}],["resolveconflictbyusing",{"_index":4307,"name":{"6000":{}},"parent":{}}],["resolved",{"_index":736,"name":{"791":{}},"parent":{}}],["resolvedclicmdtree",{"_index":1433,"name":{"1700":{}},"parent":{}}],["resolvesesscfgprops",{"_index":1223,"name":{"1458":{}},"parent":{}}],["resource",{"_index":1032,"name":{"1166":{},"1183":{},"1281":{},"3834":{},"4161":{},"4223":{},"4450":{},"4888":{},"5182":{},"5211":{},"5571":{},"6010":{}},"parent":{}}],["resource_external_name",{"_index":2816,"name":{"3840":{}},"parent":{}}],["resource_jcl_content",{"_index":3624,"name":{"4890":{}},"parent":{}}],["resource_provision_run",{"_index":2817,"name":{"3841":{}},"parent":{}}],["resource_spool_content",{"_index":3625,"name":{"4891":{}},"parent":{}}],["resource_spool_files",{"_index":3623,"name":{"4889":{}},"parent":{}}],["resource_type",{"_index":2815,"name":{"3839":{}},"parent":{}}],["response",{"_index":1004,"name":{"1128":{},"1277":{},"1377":{},"1436":{},"1557":{},"4120":{},"4128":{},"4129":{},"4130":{},"4131":{},"4464":{},"5355":{}},"parent":{}}],["response_err_tag",{"_index":1671,"name":{"1959":{}},"parent":{}}],["response_format_filter_option",{"_index":1661,"name":{"1935":{}},"parent":{}}],["response_format_header_option",{"_index":1664,"name":{"1941":{}},"parent":{}}],["response_format_option",{"_index":1667,"name":{"1949":{}},"parent":{}}],["response_format_types",{"_index":1666,"name":{"1948":{}},"parent":{}}],["responseformat",{"_index":1647,"name":{"1917":{},"1932":{},"1994":{},"2094":{}},"parent":{}}],["responseparms",{"_index":1903,"name":{"2286":{},"2308":{},"2353":{}},"parent":{}}],["responsestream",{"_index":1037,"name":{"1170":{},"1285":{},"4454":{}},"parent":{}}],["responsetimeout",{"_index":3326,"name":{"4439":{},"4447":{},"4498":{},"4502":{},"4515":{},"4527":{},"4588":{},"4593":{},"4601":{},"4614":{},"4635":{},"4664":{},"4667":{},"4673":{},"4733":{},"4794":{},"4823":{},"4835":{},"4843":{},"4847":{},"4865":{},"6020":{},"6195":{}},"parent":{}}],["restclient",{"_index":1178,"name":{"1382":{}},"parent":{}}],["restclienterror",{"_index":1136,"name":{"1322":{}},"parent":{}}],["restclientresolve",{"_index":1176,"name":{"1380":{}},"parent":{}}],["restconstants",{"_index":1123,"name":{"1308":{}},"parent":{}}],["resterrorsource",{"_index":1049,"name":{"1194":{}},"parent":{}}],["reststandaloneutils",{"_index":1204,"name":{"1439":{}},"parent":{}}],["resultdescription",{"_index":2501,"name":{"3248":{}},"parent":{}}],["resultmessage",{"_index":953,"name":{"1039":{}},"parent":{}}],["retainfor",{"_index":3367,"name":{"4512":{}},"parent":{}}],["retainto",{"_index":3368,"name":{"4513":{}},"parent":{}}],["retcode",{"_index":3644,"name":{"4912":{},"5055":{},"5074":{},"5808":{}},"parent":{}}],["return",{"_index":155,"name":{"117":{}},"parent":{}}],["returncode",{"_index":4278,"name":{"5866":{},"5973":{}},"parent":{}}],["returndata",{"_index":4095,"name":{"5588":{}},"parent":{}}],["returnetag",{"_index":3507,"name":{"4722":{},"4786":{}},"parent":{}}],["reused",{"_index":3910,"name":{"5251":{},"5412":{}},"parent":{}}],["rmunusedprops",{"_index":728,"name":{"778":{}},"parent":{}}],["rootcommand",{"_index":1877,"name":{"2243":{},"2464":{}},"parent":{}}],["rootcommanddescription",{"_index":2327,"name":{"2980":{}},"parent":{}}],["rootcommandname",{"_index":1777,"name":{"2099":{},"2115":{},"2282":{},"2304":{},"2329":{},"2349":{},"2470":{},"2582":{},"2723":{},"3020":{},"3348":{},"3358":{}},"parent":{}}],["rows",{"_index":3852,"name":{"5193":{},"5334":{}},"parent":{}}],["run",{"_index":2874,"name":{"3907":{}},"parent":{}}],["runasuser",{"_index":2914,"name":{"3964":{},"5867":{},"5974":{}},"parent":{}}],["runasuserdynamic",{"_index":4279,"name":{"5868":{},"5975":{}},"parent":{}}],["running",{"_index":3649,"name":{"4919":{}},"parent":{}}],["runvalidateplugin",{"_index":2732,"name":{"3674":{}},"parent":{}}],["sanitizeexpression",{"_index":2727,"name":{"3660":{}},"parent":{}}],["sanitizehomedir",{"_index":1839,"name":{"2192":{}},"parent":{}}],["sanitizeusspathforrestcall",{"_index":3477,"name":{"4687":{}},"parent":{}}],["save",{"_index":615,"name":{"626":{},"675":{},"710":{},"734":{},"771":{},"834":{},"2412":{},"3117":{},"3291":{}},"parent":{}}],["saveasdataset",{"_index":4194,"name":{"5711":{},"5869":{},"5976":{}},"parent":{}}],["saveasdatasetsub",{"_index":4195,"name":{"5712":{},"5870":{},"5977":{}},"parent":{}}],["saveasunixfile",{"_index":4196,"name":{"5713":{},"5871":{},"5978":{}},"parent":{}}],["saveasunixfilesub",{"_index":4197,"name":{"5714":{},"5872":{},"5979":{}},"parent":{}}],["savecredentials",{"_index":658,"name":{"680":{},"699":{},"729":{}},"parent":{}}],["saveprofile",{"_index":1944,"name":{"2381":{},"3127":{},"3270":{}},"parent":{}}],["schema",{"_index":251,"name":{"243":{},"574":{},"610":{},"783":{},"796":{},"1533":{},"2056":{},"2905":{},"3209":{},"3215":{},"5308":{},"5537":{},"6153":{}},"parent":{}}],["schema_version",{"_index":1285,"name":{"1531":{}},"parent":{}}],["schemadefinition",{"_index":2608,"name":{"3476":{}},"parent":{}}],["schemahandler",{"_index":2712,"name":{"3644":{}},"parent":{}}],["schemaname",{"_index":783,"name":{"845":{}},"parent":{}}],["scheme",{"_index":30,"name":{"22":{}},"parent":{}}],["schemename",{"_index":4198,"name":{"5715":{},"5873":{},"5980":{}},"parent":{}}],["schemenamesub",{"_index":4199,"name":{"5716":{},"5874":{},"5981":{}},"parent":{}}],["scope",{"_index":4156,"name":{"5664":{},"5730":{},"5757":{},"5893":{},"5914":{}},"parent":{}}],["scr",{"_index":2939,"name":{"3997":{},"3999":{},"4003":{}},"parent":{}}],["scriptparameters",{"_index":4200,"name":{"5717":{},"5875":{},"5982":{}},"parent":{}}],["scrollintoview",{"_index":2787,"name":{"3809":{}},"parent":{}}],["sdk",{"_index":3,"name":{"0":{},"3832":{},"4118":{},"4221":{},"4875":{},"5155":{},"5188":{},"5438":{},"5569":{},"6008":{}},"parent":{"1":{},"3":{},"6":{},"13":{},"21":{},"25":{},"38":{},"42":{},"46":{},"51":{},"59":{},"65":{},"66":{},"120":{},"124":{},"126":{},"128":{},"136":{},"138":{},"285":{},"287":{},"289":{},"290":{},"291":{},"292":{},"293":{},"294":{},"295":{},"296":{},"3833":{},"3843":{},"3845":{},"3847":{},"3849":{},"3851":{},"3853":{},"3857":{},"3859":{},"3869":{},"3872":{},"3875":{},"3877":{},"3881":{},"3885":{},"3887":{},"3892":{},"3895":{},"3898":{},"3901":{},"3917":{},"3923":{},"3926":{},"3969":{},"3972":{},"3976":{},"3980":{},"3984":{},"3989":{},"3991":{},"3993":{},"3996":{},"3998":{},"4002":{},"4006":{},"4010":{},"4026":{},"4029":{},"4032":{},"4043":{},"4047":{},"4051":{},"4054":{},"4057":{},"4062":{},"4065":{},"4071":{},"4076":{},"4082":{},"4090":{},"4094":{},"4100":{},"4103":{},"4111":{},"4114":{},"4119":{},"4122":{},"4127":{},"4133":{},"4136":{},"4142":{},"4150":{},"4157":{},"4159":{},"4166":{},"4168":{},"4170":{},"4172":{},"4174":{},"4176":{},"4178":{},"4180":{},"4182":{},"4184":{},"4186":{},"4188":{},"4190":{},"4195":{},"4203":{},"4213":{},"4222":{},"4250":{},"4435":{},"4438":{},"4440":{},"4448":{},"4449":{},"4459":{},"4467":{},"4474":{},"4479":{},"4480":{},"4499":{},"4503":{},"4516":{},"4528":{},"4575":{},"4582":{},"4584":{},"4589":{},"4594":{},"4602":{},"4615":{},"4636":{},"4645":{},"4656":{},"4665":{},"4668":{},"4670":{},"4674":{},"4676":{},"4691":{},"4695":{},"4701":{},"4704":{},"4718":{},"4734":{},"4742":{},"4748":{},"4753":{},"4765":{},"4768":{},"4771":{},"4774":{},"4777":{},"4795":{},"4801":{},"4819":{},"4824":{},"4836":{},"4841":{},"4844":{},"4848":{},"4853":{},"4858":{},"4859":{},"4861":{},"4862":{},"4866":{},"4869":{},"4873":{},"4876":{},"4897":{},"4904":{},"4920":{},"4924":{},"4927":{},"4938":{},"4943":{},"4947":{},"4952":{},"4960":{},"4975":{},"4980":{},"4983":{},"4986":{},"4990":{},"4993":{},"5000":{},"5001":{},"5002":{},"5008":{},"5016":{},"5021":{},"5027":{},"5030":{},"5036":{},"5039":{},"5049":{},"5059":{},"5065":{},"5070":{},"5075":{},"5081":{},"5083":{},"5085":{},"5089":{},"5096":{},"5107":{},"5125":{},"5146":{},"5156":{},"5168":{},"5174":{},"5179":{},"5181":{},"5183":{},"5185":{},"5189":{},"5197":{},"5217":{},"5219":{},"5221":{},"5223":{},"5225":{},"5227":{},"5229":{},"5231":{},"5233":{},"5235":{},"5237":{},"5239":{},"5243":{},"5247":{},"5253":{},"5306":{},"5340":{},"5343":{},"5347":{},"5349":{},"5352":{},"5356":{},"5359":{},"5362":{},"5365":{},"5372":{},"5379":{},"5384":{},"5389":{},"5393":{},"5396":{},"5401":{},"5405":{},"5408":{},"5418":{},"5429":{},"5435":{},"5439":{},"5447":{},"5504":{},"5515":{},"5522":{},"5523":{},"5535":{},"5570":{},"5593":{},"5595":{},"5597":{},"5599":{},"5601":{},"5603":{},"5605":{},"5607":{},"5609":{},"5611":{},"5613":{},"5619":{},"5621":{},"5623":{},"5625":{},"5627":{},"5630":{},"5640":{},"5641":{},"5647":{},"5655":{},"5662":{},"5666":{},"5669":{},"5672":{},"5728":{},"5748":{},"5764":{},"5766":{},"5768":{},"5780":{},"5782":{},"5784":{},"5786":{},"5794":{},"5798":{},"5807":{},"5816":{},"5824":{},"5827":{},"5891":{},"5897":{},"5931":{},"5996":{},"5999":{},"6003":{},"6004":{},"6006":{},"6009":{},"6019":{},"6027":{},"6036":{},"6040":{},"6049":{},"6052":{},"6065":{},"6068":{},"6070":{},"6138":{},"6151":{}}}],["sdk.apimlconstants",{"_index":6,"name":{},"parent":{"2":{}}}],["sdk.archiveddeleteworkflow",{"_index":4129,"name":{},"parent":{"5624":{}}}],["sdk.archiveworkflow",{"_index":4127,"name":{},"parent":{"5622":{}}}],["sdk.canceljobs",{"_index":3661,"name":{},"parent":{"4939":{},"4940":{},"4941":{},"4942":{}}}],["sdk.cancelworkflow",{"_index":4131,"name":{},"parent":{"5626":{}}}],["sdk.checkstatus",{"_index":4352,"name":{},"parent":{"6050":{},"6051":{}}}],["sdk.collectcommand",{"_index":3100,"name":{},"parent":{"4214":{},"4215":{},"4216":{},"4217":{},"4218":{},"4219":{},"4220":{}}}],["sdk.collectprocessingdetails",{"_index":3073,"name":{},"parent":{"4189":{}}}],["sdk.consoleconstants",{"_index":3045,"name":{},"parent":{"4160":{},"4161":{},"4162":{},"4163":{},"4164":{},"4165":{}}}],["sdk.consoleresponse",{"_index":3043,"name":{},"parent":{"4158":{}}}],["sdk.consoleresponseservice",{"_index":3076,"name":{},"parent":{"4191":{},"4192":{},"4193":{},"4194":{}}}],["sdk.consolevalidator",{"_index":3090,"name":{},"parent":{"4204":{},"4205":{},"4206":{},"4207":{},"4208":{},"4209":{},"4210":{},"4211":{},"4212":{}}}],["sdk.copy",{"_index":3585,"name":{},"parent":{"4837":{},"4838":{},"4839":{},"4840":{}}}],["sdk.create",{"_index":3444,"name":{},"parent":{"4646":{},"4647":{},"4648":{},"4649":{},"4650":{},"4651":{},"4652":{},"4653":{},"4654":{},"4655":{}}}],["sdk.createdatasettypeenum",{"_index":3394,"name":{},"parent":{"4576":{},"4577":{},"4578":{},"4579":{},"4580":{},"4581":{}}}],["sdk.createdefaults",{"_index":3377,"name":{},"parent":{"4529":{},"4571":{}}}],["sdk.createdefaults.data_set",{"_index":3379,"name":{},"parent":{"4530":{},"4538":{},"4545":{},"4553":{},"4561":{},"4569":{}}}],["sdk.createdefaults.data_set.binary",{"_index":3387,"name":{},"parent":{"4562":{},"4563":{},"4564":{},"4565":{},"4566":{},"4567":{},"4568":{}}}],["sdk.createdefaults.data_set.blank",{"_index":3389,"name":{},"parent":{"4570":{}}}],["sdk.createdefaults.data_set.c",{"_index":3386,"name":{},"parent":{"4554":{},"4555":{},"4556":{},"4557":{},"4558":{},"4559":{},"4560":{}}}],["sdk.createdefaults.data_set.classic",{"_index":3384,"name":{},"parent":{"4546":{},"4547":{},"4548":{},"4549":{},"4550":{},"4551":{},"4552":{}}}],["sdk.createdefaults.data_set.partitioned",{"_index":3380,"name":{},"parent":{"4531":{},"4532":{},"4533":{},"4534":{},"4535":{},"4536":{},"4537":{}}}],["sdk.createdefaults.data_set.sequential",{"_index":3382,"name":{},"parent":{"4539":{},"4540":{},"4541":{},"4542":{},"4543":{},"4544":{}}}],["sdk.createdefaults.vsam",{"_index":3391,"name":{},"parent":{"4572":{},"4573":{},"4574":{}}}],["sdk.createworkflow",{"_index":4149,"name":{},"parent":{"5656":{},"5657":{},"5658":{},"5659":{},"5660":{},"5661":{}}}],["sdk.decreasecounter",{"_index":3059,"name":{},"parent":{"4175":{}}}],["sdk.definitionworkflow",{"_index":4232,"name":{},"parent":{"5765":{}}}],["sdk.delete",{"_index":3596,"name":{},"parent":{"4854":{},"4855":{},"4856":{},"4857":{}}}],["sdk.deleteinstance",{"_index":2836,"name":{},"parent":{"3858":{}}}],["sdk.deletejobs",{"_index":3669,"name":{},"parent":{"4948":{},"4949":{},"4950":{},"4951":{}}}],["sdk.deleteworkflow",{"_index":4234,"name":{},"parent":{"5767":{}}}],["sdk.displaycollecterror",{"_index":3057,"name":{},"parent":{"4173":{}}}],["sdk.displaycollectresponse",{"_index":3055,"name":{},"parent":{"4171":{}}}],["sdk.displayerror",{"_index":3053,"name":{},"parent":{"4169":{}}}],["sdk.displayresponse",{"_index":3051,"name":{},"parent":{"4167":{}}}],["sdk.download",{"_index":3527,"name":{},"parent":{"4754":{},"4755":{},"4756":{},"4757":{},"4758":{},"4759":{},"4760":{},"4761":{},"4762":{},"4763":{},"4764":{}}}],["sdk.downloadjobs",{"_index":3813,"name":{},"parent":{"5147":{},"5148":{},"5149":{},"5150":{},"5151":{},"5152":{},"5153":{},"5154":{}}}],["sdk.explainactionresponse",{"_index":2977,"name":{},"parent":{"4058":{},"4059":{},"4060":{},"4061":{}}}],["sdk.explainatcreatevariable",{"_index":2868,"name":{},"parent":{"3899":{},"3900":{}}}],["sdk.explainpromptvariable",{"_index":2866,"name":{},"parent":{"3896":{},"3897":{}}}],["sdk.explainpromptvariablefull",{"_index":2964,"name":{},"parent":{"4030":{},"4031":{}}}],["sdk.explainpromptvariablesummary",{"_index":2962,"name":{},"parent":{"4027":{},"4028":{}}}],["sdk.explainprovisionedinstanceactionsfull",{"_index":2889,"name":{},"parent":{"3918":{},"3919":{},"3920":{},"3921":{},"3922":{}}}],["sdk.explainprovisionedinstanceactionssummary",{"_index":2891,"name":{},"parent":{"3924":{},"3925":{}}}],["sdk.explainprovisionedinstanceextended",{"_index":2926,"name":{},"parent":{"3981":{},"3982":{},"3983":{}}}],["sdk.explainprovisionedinstancefull",{"_index":2928,"name":{},"parent":{"3985":{},"3986":{},"3987":{},"3988":{}}}],["sdk.explainprovisionedinstancesfull",{"_index":2944,"name":{},"parent":{"4003":{},"4004":{},"4005":{}}}],["sdk.explainprovisionedinstancessummary",{"_index":2942,"name":{},"parent":{"3999":{},"4000":{},"4001":{}}}],["sdk.explainprovisionedinstancesummary",{"_index":2920,"name":{},"parent":{"3970":{},"3971":{}}}],["sdk.explainprovisionedinstancesummarywithactions",{"_index":2924,"name":{},"parent":{"3977":{},"3978":{},"3979":{}}}],["sdk.explainprovisionedinstancesummarywithvars",{"_index":2922,"name":{},"parent":{"3973":{},"3974":{},"3975":{}}}],["sdk.explainprovisionedinstancevariable",{"_index":2864,"name":{},"parent":{"3893":{},"3894":{}}}],["sdk.explainprovisiontemplateresponse",{"_index":2996,"name":{},"parent":{"4095":{},"4096":{},"4097":{},"4098":{},"4099":{}}}],["sdk.explainpublishedtemplatefull",{"_index":2848,"name":{},"parent":{"3873":{},"3874":{}}}],["sdk.explainpublishedtemplateinfofull",{"_index":2970,"name":{},"parent":{"4048":{},"4049":{},"4050":{}}}],["sdk.explainpublishedtemplateinfosummary",{"_index":2968,"name":{},"parent":{"4044":{},"4045":{},"4046":{}}}],["sdk.explainpublishedtemplatesfull",{"_index":2856,"name":{},"parent":{"3882":{},"3883":{},"3884":{}}}],["sdk.explainpublishedtemplatessummary",{"_index":2854,"name":{},"parent":{"3878":{},"3879":{},"3880":{}}}],["sdk.explainpublishedtemplatesummary",{"_index":2846,"name":{},"parent":{"3870":{},"3871":{}}}],["sdk.explaintemplateregistryinforesponse",{"_index":2984,"name":{},"parent":{"4072":{},"4073":{},"4074":{},"4075":{}}}],["sdk.explaintemplateworkflowinforesponse",{"_index":2992,"name":{},"parent":{"4083":{},"4084":{},"4085":{},"4086":{},"4087":{},"4088":{},"4089":{}}}],["sdk.get",{"_index":3536,"name":{},"parent":{"4766":{},"4767":{}}}],["sdk.getjobs",{"_index":3791,"name":{},"parent":{"5126":{},"5127":{},"5128":{},"5129":{},"5130":{},"5131":{},"5132":{},"5133":{},"5134":{},"5135":{},"5136":{},"5137":{},"5138":{},"5139":{},"5140":{},"5141":{},"5142":{},"5143":{},"5144":{},"5145":{}}}],["sdk.getzoslog",{"_index":3844,"name":{},"parent":{"5186":{},"5187":{}}}],["sdk.getzoslogvalidator",{"_index":3838,"name":{},"parent":{"5180":{}}}],["sdk.hdelete",{"_index":3464,"name":{},"parent":{"4675":{}}}],["sdk.hmigrate",{"_index":3459,"name":{},"parent":{"4669":{}}}],["sdk.hrecall",{"_index":3599,"name":{},"parent":{"4860":{}}}],["sdk.iactiveworkflows",{"_index":4244,"name":{},"parent":{"5785":{}}}],["sdk.ialtprofile",{"_index":57,"name":{},"parent":{"43":{},"44":{},"45":{}}}],["sdk.iapimlprofileinfo",{"_index":13,"name":{},"parent":{"7":{},"8":{},"9":{},"10":{},"11":{}}}],["sdk.iapimlprofileinfo.gatewayurlconflicts",{"_index":19,"name":{},"parent":{"12":{}}}],["sdk.iapimlservice",{"_index":36,"name":{},"parent":{"26":{},"27":{},"28":{},"37":{}}}],["sdk.iapimlservice.apiml",{"_index":39,"name":{},"parent":{"29":{}}}],["sdk.iapimlservice.apiml.__type",{"_index":41,"name":{},"parent":{"30":{},"31":{},"36":{}}}],["sdk.iapimlservice.apiml.__type.service",{"_index":43,"name":{},"parent":{"32":{}}}],["sdk.iapimlservice.apiml.__type.service.__type",{"_index":45,"name":{},"parent":{"33":{},"34":{},"35":{}}}],["sdk.iapimlserviceapiinfo",{"_index":22,"name":{},"parent":{"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{}}}],["sdk.iapimlserviceauthentication",{"_index":31,"name":{},"parent":{"22":{},"23":{},"24":{}}}],["sdk.iapimlsvcattrsloaded",{"_index":9,"name":{},"parent":{"4":{},"5":{}}}],["sdk.iarchivedworkflow",{"_index":4124,"name":{},"parent":{"5620":{}}}],["sdk.iarchivedworkflows",{"_index":4240,"name":{},"parent":{"5781":{}}}],["sdk.iautoinitrpt",{"_index":74,"name":{},"parent":{"60":{},"61":{},"62":{},"63":{},"64":{}}}],["sdk.iautomationstatus",{"_index":4255,"name":{},"parent":{"5799":{},"5800":{},"5801":{},"5802":{},"5803":{},"5804":{},"5805":{},"5806":{}}}],["sdk.ibaseprofileoverride",{"_index":62,"name":{},"parent":{"47":{},"48":{},"49":{},"50":{}}}],["sdk.icanceljob",{"_index":3653,"name":{},"parent":{"4925":{},"4926":{}}}],["sdk.icanceljobparms",{"_index":3651,"name":{},"parent":{"4921":{},"4922":{},"4923":{}}}],["sdk.icollectedresponses",{"_index":3958,"name":{},"parent":{"5363":{},"5364":{}}}],["sdk.icollectparms",{"_index":3028,"name":{},"parent":{"4137":{},"4138":{},"4139":{},"4140":{},"4141":{}}}],["sdk.icommonjobparms",{"_index":3697,"name":{},"parent":{"4991":{},"4992":{}}}],["sdk.iconsoleparms",{"_index":3024,"name":{},"parent":{"4134":{},"4135":{}}}],["sdk.iconsoleresponse",{"_index":3032,"name":{},"parent":{"4143":{},"4144":{},"4145":{},"4146":{},"4147":{},"4148":{},"4149":{}}}],["sdk.icopydatasetoptions",{"_index":3573,"name":{},"parent":{"4820":{},"4821":{},"4822":{},"4823":{}}}],["sdk.icreatedatasetoptions",{"_index":3348,"name":{},"parent":{"4481":{},"4482":{},"4483":{},"4484":{},"4485":{},"4486":{},"4487":{},"4488":{},"4489":{},"4490":{},"4491":{},"4492":{},"4493":{},"4494":{},"4495":{},"4496":{},"4497":{},"4498":{}}}],["sdk.icreatedworkflow",{"_index":4143,"name":{},"parent":{"5642":{},"5643":{},"5644":{},"5645":{},"5646":{}}}],["sdk.icreatedworkflowlocal",{"_index":4145,"name":{},"parent":{"5648":{},"5649":{},"5650":{},"5651":{},"5652":{},"5653":{},"5654":{}}}],["sdk.icreateussoptions",{"_index":3363,"name":{},"parent":{"4500":{},"4501":{},"4502":{}}}],["sdk.icreatevsamoptions",{"_index":3365,"name":{},"parent":{"4504":{},"4505":{},"4506":{},"4507":{},"4508":{},"4509":{},"4510":{},"4511":{},"4512":{},"4513":{},"4514":{},"4515":{}}}],["sdk.icreateworkflow",{"_index":4135,"name":{},"parent":{"5631":{},"5632":{},"5633":{},"5634":{},"5635":{},"5636":{},"5637":{},"5638":{},"5639":{}}}],["sdk.icreatezfsoptions",{"_index":3370,"name":{},"parent":{"4517":{},"4518":{},"4519":{},"4520":{},"4521":{},"4522":{},"4523":{},"4524":{},"4525":{},"4526":{},"4527":{}}}],["sdk.icrosslparcopydatasetoptions",{"_index":3578,"name":{},"parent":{"4825":{},"4826":{},"4827":{},"4828":{},"4829":{},"4830":{},"4832":{},"4833":{},"4834":{},"4835":{}}}],["sdk.icrosslparcopydatasetoptions.promptfn",{"_index":3583,"name":{},"parent":{"4831":{}}}],["sdk.idataset",{"_index":3323,"name":{},"parent":{"4436":{},"4437":{}}}],["sdk.idefinedsystem",{"_index":4355,"name":{},"parent":{"6053":{},"6054":{},"6055":{},"6056":{},"6057":{},"6058":{},"6059":{},"6060":{},"6061":{},"6062":{},"6063":{},"6064":{}}}],["sdk.ideletedatasetoptions",{"_index":3590,"name":{},"parent":{"4842":{},"4843":{}}}],["sdk.ideletejobparms",{"_index":3665,"name":{},"parent":{"4944":{},"4945":{},"4946":{}}}],["sdk.ideleteoptions",{"_index":3462,"name":{},"parent":{"4671":{},"4672":{},"4673":{}}}],["sdk.ideletevsamoptions",{"_index":3593,"name":{},"parent":{"4845":{},"4846":{},"4847":{}}}],["sdk.ideletevsamresponse",{"_index":3595,"name":{},"parent":{"4849":{},"4850":{},"4851":{},"4852":{}}}],["sdk.idownloadallspoolcontentparms",{"_index":3674,"name":{},"parent":{"4953":{},"4954":{},"4955":{},"4956":{},"4957":{},"4958":{},"4959":{}}}],["sdk.idownloaddsmresult",{"_index":3517,"name":{},"parent":{"4743":{},"4744":{},"4745":{},"4746":{}}}],["sdk.idownloaddsmresult.failedwitherrors",{"_index":3521,"name":{},"parent":{"4747":{}}}],["sdk.idownloadoptions",{"_index":3510,"name":{},"parent":{"4735":{},"4736":{},"4738":{},"4739":{},"4740":{},"4741":{}}}],["sdk.idownloadoptions.extensionmap",{"_index":3512,"name":{},"parent":{"4737":{}}}],["sdk.idownloadsingleoptions",{"_index":3504,"name":{},"parent":{"4719":{},"4720":{},"4721":{},"4722":{},"4723":{},"4724":{},"4725":{},"4726":{},"4727":{},"4728":{},"4729":{},"4730":{},"4731":{},"4732":{},"4733":{}}}],["sdk.idownloadspoolcontentparms",{"_index":3686,"name":{},"parent":{"4976":{},"4977":{},"4978":{},"4979":{}}}],["sdk.idownloadussdirresult",{"_index":3523,"name":{},"parent":{"4749":{},"4750":{},"4751":{}}}],["sdk.idownloadussdirresult.failedwitherrors",{"_index":3525,"name":{},"parent":{"4752":{}}}],["sdk.idsmlistoptions",{"_index":3404,"name":{},"parent":{"4585":{},"4586":{},"4587":{},"4588":{}}}],["sdk.ifsoptions",{"_index":3407,"name":{},"parent":{"4590":{},"4591":{},"4592":{},"4593":{}}}],["sdk.igetjobsparms",{"_index":3699,"name":{},"parent":{"4994":{},"4995":{},"4996":{},"4997":{},"4998":{},"4999":{}}}],["sdk.igetoptions",{"_index":3454,"name":{},"parent":{"4657":{},"4658":{},"4659":{},"4660":{},"4661":{},"4662":{},"4663":{},"4664":{}}}],["sdk.igetworkflowsoptions",{"_index":4247,"name":{},"parent":{"5787":{},"5788":{},"5789":{},"5790":{},"5791":{},"5792":{},"5793":{}}}],["sdk.iissueparms",{"_index":3039,"name":{},"parent":{"4151":{},"4152":{},"4153":{},"4154":{},"4155":{},"4156":{}}}],["sdk.iissueresponse",{"_index":3965,"name":{},"parent":{"5373":{},"5374":{},"5375":{},"5376":{},"5377":{},"5378":{}}}],["sdk.iissuetsoparms",{"_index":3899,"name":{},"parent":{"5240":{},"5241":{},"5242":{}}}],["sdk.ijob",{"_index":3641,"name":{},"parent":{"4905":{},"4906":{},"4907":{},"4908":{},"4909":{},"4910":{},"4911":{},"4912":{},"4913":{},"4914":{},"4915":{},"4916":{},"4917":{},"4918":{},"4919":{}}}],["sdk.ijobcomplete",{"_index":3733,"name":{},"parent":{"5050":{},"5051":{},"5052":{},"5053":{},"5054":{},"5055":{},"5056":{},"5057":{},"5058":{}}}],["sdk.ijoberror",{"_index":3738,"name":{},"parent":{"5060":{},"5061":{},"5062":{},"5063":{},"5064":{}}}],["sdk.ijobfeedback",{"_index":3655,"name":{},"parent":{"4928":{},"4929":{},"4930":{},"4931":{},"4932":{},"4933":{},"4934":{},"4935":{},"4936":{},"4937":{}}}],["sdk.ijobfile",{"_index":3677,"name":{},"parent":{"4961":{},"4962":{},"4963":{},"4964":{},"4965":{},"4966":{},"4967":{},"4968":{},"4969":{},"4970":{},"4971":{},"4972":{},"4973":{},"4974":{}}}],["sdk.ijobfiles",{"_index":4265,"name":{},"parent":{"5817":{},"5818":{},"5819":{},"5820":{},"5821":{},"5822":{},"5823":{}}}],["sdk.ijobfilesimple",{"_index":3740,"name":{},"parent":{"5066":{},"5067":{},"5068":{},"5069":{}}}],["sdk.ijobinfo",{"_index":4268,"name":{},"parent":{"5825":{},"5826":{}}}],["sdk.ijobstatus",{"_index":4262,"name":{},"parent":{"5808":{},"5809":{},"5810":{},"5811":{},"5812":{},"5813":{},"5814":{},"5815":{}}}],["sdk.ijobstepdata",{"_index":3633,"name":{},"parent":{"4898":{},"4899":{},"4900":{},"4901":{},"4902":{},"4903":{}}}],["sdk.ijobsubmit",{"_index":3742,"name":{},"parent":{"5071":{},"5072":{},"5073":{},"5074":{}}}],["sdk.ilistoptions",{"_index":3411,"name":{},"parent":{"4595":{},"4596":{},"4597":{},"4598":{},"4599":{},"4600":{},"4601":{}}}],["sdk.imigrateoptions",{"_index":3457,"name":{},"parent":{"4666":{},"4667":{}}}],["sdk.imodifyjob",{"_index":3688,"name":{},"parent":{"4981":{},"4982":{}}}],["sdk.imodifyjoboptions",{"_index":3693,"name":{},"parent":{"4987":{},"4988":{},"4989":{}}}],["sdk.imodifyjobparms",{"_index":3690,"name":{},"parent":{"4984":{},"4985":{}}}],["sdk.imonitorjobwaitforparms",{"_index":3705,"name":{},"parent":{"5003":{},"5004":{},"5005":{},"5006":{},"5007":{}}}],["sdk.imountfsoptions",{"_index":3602,"name":{},"parent":{"4863":{},"4864":{},"4865":{}}}],["sdk.invoke",{"_index":3401,"name":{},"parent":{"4583":{}}}],["sdk.ioptions",{"_index":3330,"name":{},"parent":{"4441":{},"4442":{},"4443":{},"4444":{},"4445":{},"4446":{},"4447":{}}}],["sdk.ioptionsfullresponse",{"_index":3334,"name":{},"parent":{"4450":{},"4451":{},"4452":{},"4453":{},"4454":{},"4455":{},"4456":{},"4457":{},"4458":{}}}],["sdk.iperformactionresponse",{"_index":2975,"name":{},"parent":{"4055":{},"4056":{}}}],["sdk.ipingresponse",{"_index":3970,"name":{},"parent":{"5380":{},"5381":{},"5382":{},"5383":{}}}],["sdk.iprofilerpt",{"_index":68,"name":{},"parent":{"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"58":{}}}],["sdk.ipromptvariable",{"_index":2950,"name":{},"parent":{"4011":{},"4012":{},"4013":{},"4014":{},"4015":{},"4016":{},"4017":{},"4018":{},"4019":{},"4020":{},"4021":{},"4022":{},"4023":{},"4024":{},"4025":{}}}],["sdk.ipropertiesinput",{"_index":2998,"name":{},"parent":{"4101":{},"4102":{}}}],["sdk.ipropertymapping",{"_index":4163,"name":{},"parent":{"5670":{},"5671":{}}}],["sdk.iprovisionedinstance",{"_index":2893,"name":{},"parent":{"3927":{},"3928":{},"3929":{},"3930":{},"3931":{},"3932":{},"3933":{},"3934":{},"3935":{},"3936":{},"3937":{},"3938":{},"3939":{},"3940":{},"3941":{},"3942":{},"3943":{},"3944":{},"3945":{},"3946":{},"3947":{},"3948":{},"3949":{},"3950":{},"3951":{},"3952":{},"3953":{},"3954":{},"3955":{},"3956":{},"3957":{},"3958":{},"3959":{},"3960":{},"3961":{},"3962":{},"3963":{},"3964":{},"3965":{},"3966":{},"3967":{},"3968":{}}}],["sdk.iprovisionedinstanceactions",{"_index":2870,"name":{},"parent":{"3902":{},"3903":{},"3904":{},"3905":{},"3906":{},"3907":{},"3908":{},"3909":{},"3910":{},"3911":{},"3912":{},"3913":{},"3914":{},"3915":{},"3916":{}}}],["sdk.iprovisionedinstances",{"_index":2940,"name":{},"parent":{"3997":{}}}],["sdk.iprovisionedinstancevariable",{"_index":2861,"name":{},"parent":{"3888":{},"3889":{},"3890":{},"3891":{}}}],["sdk.iprovisionedinstancevariables",{"_index":2933,"name":{},"parent":{"3992":{}}}],["sdk.iprovisionoptionals",{"_index":3000,"name":{},"parent":{"4104":{},"4105":{},"4106":{},"4107":{},"4108":{},"4109":{},"4110":{}}}],["sdk.iprovisiontemplateresponse",{"_index":2994,"name":{},"parent":{"4091":{},"4092":{},"4093":{}}}],["sdk.ipublishedtemplate",{"_index":2838,"name":{},"parent":{"3860":{},"3861":{},"3862":{},"3863":{},"3864":{},"3865":{},"3866":{},"3867":{},"3868":{}}}],["sdk.ipublishedtemplateinfo",{"_index":2966,"name":{},"parent":{"4033":{},"4034":{},"4035":{},"4036":{},"4037":{},"4038":{},"4039":{},"4040":{},"4041":{},"4042":{}}}],["sdk.ipublishedtemplates",{"_index":2852,"name":{},"parent":{"3876":{}}}],["sdk.irestclientresponse",{"_index":3335,"name":{},"parent":{"4460":{},"4461":{},"4462":{},"4463":{},"4464":{},"4465":{},"4466":{}}}],["sdk.isendresponse",{"_index":3945,"name":{},"parent":{"5344":{},"5345":{},"5346":{}}}],["sdk.isendtsoparms",{"_index":3943,"name":{},"parent":{"5341":{},"5342":{}}}],["sdk.ispoolfile",{"_index":3744,"name":{},"parent":{"5076":{},"5077":{},"5078":{},"5079":{},"5080":{}}}],["sdk.isshsession",{"_index":4020,"name":{},"parent":{"5440":{},"5441":{},"5442":{},"5443":{},"5444":{},"5445":{},"5446":{}}}],["sdk.issuecommand",{"_index":3081,"name":{},"parent":{"4196":{},"4197":{},"4198":{},"4199":{},"4200":{},"4201":{},"4202":{}}}],["sdk.issuetso",{"_index":4017,"name":{},"parent":{"5436":{},"5437":{}}}],["sdk.istartstopresponse",{"_index":3973,"name":{},"parent":{"5385":{},"5386":{},"5387":{},"5388":{}}}],["sdk.istartstopresponses",{"_index":3961,"name":{},"parent":{"5366":{},"5367":{},"5368":{},"5369":{},"5370":{},"5371":{}}}],["sdk.istarttsoparms",{"_index":3849,"name":{},"parent":{"5190":{},"5191":{},"5192":{},"5193":{},"5194":{},"5195":{},"5196":{}}}],["sdk.istartworkflow",{"_index":4308,"name":{},"parent":{"6000":{},"6001":{},"6002":{}}}],["sdk.istepapprovers",{"_index":4159,"name":{},"parent":{"5667":{},"5668":{}}}],["sdk.istepdefinition",{"_index":4166,"name":{},"parent":{"5673":{},"5674":{},"5675":{},"5676":{},"5677":{},"5678":{},"5679":{},"5680":{},"5681":{},"5682":{},"5683":{},"5684":{},"5685":{},"5686":{},"5687":{},"5688":{},"5689":{},"5690":{},"5691":{},"5692":{},"5693":{},"5694":{},"5695":{},"5696":{},"5697":{},"5698":{},"5699":{},"5700":{},"5701":{},"5702":{},"5703":{},"5704":{},"5705":{},"5706":{},"5707":{},"5708":{},"5709":{},"5710":{},"5711":{},"5712":{},"5713":{},"5714":{},"5715":{},"5716":{},"5717":{},"5718":{},"5719":{},"5720":{},"5721":{},"5722":{},"5723":{},"5724":{},"5725":{},"5726":{},"5727":{}}}],["sdk.istepinfo",{"_index":4271,"name":{},"parent":{"5828":{},"5829":{},"5830":{},"5831":{},"5832":{},"5833":{},"5834":{},"5835":{},"5836":{},"5837":{},"5838":{},"5839":{},"5840":{},"5841":{},"5842":{},"5843":{},"5844":{},"5845":{},"5846":{},"5847":{},"5848":{},"5849":{},"5850":{},"5851":{},"5852":{},"5853":{},"5854":{},"5855":{},"5856":{},"5857":{},"5858":{},"5859":{},"5860":{},"5861":{},"5862":{},"5863":{},"5864":{},"5865":{},"5866":{},"5867":{},"5868":{},"5869":{},"5870":{},"5871":{},"5872":{},"5873":{},"5874":{},"5875":{},"5876":{},"5877":{},"5878":{},"5879":{},"5880":{},"5881":{},"5882":{},"5883":{},"5884":{},"5885":{},"5886":{},"5887":{},"5888":{},"5889":{},"5890":{}}}],["sdk.istepsummary",{"_index":4300,"name":{},"parent":{"5932":{},"5933":{},"5934":{},"5935":{},"5936":{},"5937":{},"5938":{},"5939":{},"5940":{},"5941":{},"5942":{},"5943":{},"5944":{},"5945":{},"5946":{},"5947":{},"5948":{},"5949":{},"5950":{},"5951":{},"5952":{},"5953":{},"5954":{},"5955":{},"5956":{},"5957":{},"5958":{},"5959":{},"5960":{},"5961":{},"5962":{},"5963":{},"5964":{},"5965":{},"5966":{},"5967":{},"5968":{},"5969":{},"5970":{},"5971":{},"5972":{},"5973":{},"5974":{},"5975":{},"5976":{},"5977":{},"5978":{},"5979":{},"5980":{},"5981":{},"5982":{},"5983":{},"5984":{},"5985":{},"5986":{},"5987":{},"5988":{},"5989":{},"5990":{},"5991":{},"5992":{},"5993":{},"5994":{},"5995":{}}}],["sdk.istoptsoparms",{"_index":3897,"name":{},"parent":{"5238":{}}}],["sdk.isubmitjclnotifyparm",{"_index":3710,"name":{},"parent":{"5009":{},"5010":{},"5011":{},"5012":{},"5013":{},"5014":{},"5015":{}}}],["sdk.isubmitjclparms",{"_index":3715,"name":{},"parent":{"5017":{},"5018":{},"5019":{},"5020":{}}}],["sdk.isubmitjobnotifyparm",{"_index":3718,"name":{},"parent":{"5022":{},"5023":{},"5024":{},"5025":{},"5026":{}}}],["sdk.isubmitjobparms",{"_index":3725,"name":{},"parent":{"5037":{},"5038":{}}}],["sdk.isubmitjobussnotifyparm",{"_index":3723,"name":{},"parent":{"5031":{},"5032":{},"5033":{},"5034":{},"5035":{}}}],["sdk.isubmitjobussparms",{"_index":3721,"name":{},"parent":{"5028":{},"5029":{}}}],["sdk.isubmitparms",{"_index":3728,"name":{},"parent":{"5040":{},"5041":{},"5042":{},"5043":{},"5044":{},"5045":{},"5046":{},"5047":{},"5048":{}}}],["sdk.itemplateregistryinfo",{"_index":2982,"name":{},"parent":{"4066":{},"4067":{},"4068":{},"4069":{},"4070":{}}}],["sdk.itemplateworkflowinfo",{"_index":2987,"name":{},"parent":{"4077":{},"4078":{},"4079":{},"4080":{},"4081":{}}}],["sdk.itsomessage",{"_index":3949,"name":{},"parent":{"5350":{},"5351":{}}}],["sdk.itsomessages",{"_index":3951,"name":{},"parent":{"5353":{},"5354":{},"5355":{}}}],["sdk.itsopromptmessage",{"_index":3953,"name":{},"parent":{"5357":{},"5358":{}}}],["sdk.itsoresponsemessage",{"_index":3955,"name":{},"parent":{"5360":{},"5361":{}}}],["sdk.iuploaddir",{"_index":3539,"name":{},"parent":{"4769":{},"4770":{}}}],["sdk.iuploadfile",{"_index":3542,"name":{},"parent":{"4772":{},"4773":{}}}],["sdk.iuploadmap",{"_index":3545,"name":{},"parent":{"4775":{},"4776":{}}}],["sdk.iuploadoptions",{"_index":3548,"name":{},"parent":{"4778":{},"4779":{},"4780":{},"4781":{},"4782":{},"4783":{},"4784":{},"4785":{},"4786":{},"4787":{},"4788":{},"4789":{},"4790":{},"4791":{},"4792":{},"4793":{},"4794":{}}}],["sdk.iuploadresult",{"_index":3554,"name":{},"parent":{"4796":{},"4797":{},"4798":{},"4799":{},"4800":{}}}],["sdk.iussfilelistresponse",{"_index":3337,"name":{},"parent":{"4468":{},"4469":{},"4470":{},"4471":{},"4472":{},"4473":{}}}],["sdk.iusslistoptions",{"_index":3413,"name":{},"parent":{"4603":{},"4604":{},"4605":{},"4606":{},"4607":{},"4608":{},"4609":{},"4610":{},"4611":{},"4612":{},"4613":{},"4614":{}}}],["sdk.ivariable",{"_index":4133,"name":{},"parent":{"5628":{},"5629":{}}}],["sdk.ivariabledefinition",{"_index":4211,"name":{},"parent":{"5729":{},"5730":{},"5731":{},"5732":{},"5733":{},"5734":{},"5735":{},"5736":{},"5737":{},"5738":{},"5739":{},"5740":{},"5741":{},"5742":{},"5743":{},"5744":{},"5745":{},"5746":{},"5747":{}}}],["sdk.ivariableinfo",{"_index":4284,"name":{},"parent":{"5892":{},"5893":{},"5894":{},"5895":{},"5896":{}}}],["sdk.ivariablespecification",{"_index":4155,"name":{},"parent":{"5663":{},"5664":{},"5665":{}}}],["sdk.iworkflowdefinition",{"_index":4223,"name":{},"parent":{"5749":{},"5750":{},"5751":{},"5752":{},"5753":{},"5754":{},"5755":{},"5756":{},"5757":{},"5758":{},"5759":{},"5760":{},"5761":{},"5762":{},"5763":{}}}],["sdk.iworkflowinfo",{"_index":4286,"name":{},"parent":{"5898":{},"5899":{},"5900":{},"5901":{},"5902":{},"5903":{},"5904":{},"5905":{},"5906":{},"5907":{},"5908":{},"5909":{},"5910":{},"5911":{},"5912":{},"5913":{},"5914":{},"5915":{},"5916":{},"5917":{},"5918":{},"5919":{},"5920":{},"5921":{},"5922":{},"5923":{},"5924":{},"5925":{},"5926":{},"5927":{},"5928":{},"5929":{},"5930":{}}}],["sdk.iworkflows",{"_index":4314,"name":{},"parent":{"6007":{}}}],["sdk.iworkflowsinfo",{"_index":4236,"name":{},"parent":{"5769":{},"5770":{},"5771":{},"5772":{},"5773":{},"5774":{},"5775":{},"5776":{},"5777":{},"5778":{},"5779":{}}}],["sdk.izosfilesoptions",{"_index":3327,"name":{},"parent":{"4439":{}}}],["sdk.izosfilesresponse",{"_index":3342,"name":{},"parent":{"4475":{},"4476":{},"4477":{},"4478":{}}}],["sdk.izoslogitemtype",{"_index":3823,"name":{},"parent":{"5157":{},"5158":{},"5159":{},"5160":{},"5161":{},"5162":{},"5163":{},"5164":{},"5165":{},"5166":{},"5167":{}}}],["sdk.izoslogparms",{"_index":3835,"name":{},"parent":{"5175":{},"5176":{},"5177":{},"5178":{}}}],["sdk.izoslogtype",{"_index":3830,"name":{},"parent":{"5169":{},"5170":{},"5171":{},"5172":{},"5173":{}}}],["sdk.izosmfcollectresponse",{"_index":3015,"name":{},"parent":{"4120":{},"4121":{}}}],["sdk.izosmfinforesponse",{"_index":4345,"name":{},"parent":{"6041":{},"6042":{},"6043":{},"6044":{},"6045":{},"6046":{},"6047":{},"6048":{}}}],["sdk.izosmfissueparms",{"_index":3018,"name":{},"parent":{"4123":{},"4124":{},"4125":{},"4126":{}}}],["sdk.izosmfissueresponse",{"_index":3021,"name":{},"parent":{"4128":{},"4129":{},"4130":{},"4131":{},"4132":{}}}],["sdk.izosmflistdefinedsystemsresponse",{"_index":4368,"name":{},"parent":{"6066":{},"6067":{}}}],["sdk.izosmflistresponse",{"_index":3420,"name":{},"parent":{"4616":{},"4617":{},"4618":{},"4619":{},"4620":{},"4621":{},"4622":{},"4623":{},"4624":{},"4625":{},"4626":{},"4627":{},"4628":{},"4629":{},"4630":{},"4631":{},"4632":{},"4633":{},"4634":{},"4635":{}}}],["sdk.izosmfmessages",{"_index":3904,"name":{},"parent":{"5244":{},"5245":{},"5246":{}}}],["sdk.izosmfpingresponse",{"_index":3907,"name":{},"parent":{"5248":{},"5249":{},"5250":{},"5251":{},"5252":{}}}],["sdk.izosmfplugininfo",{"_index":4340,"name":{},"parent":{"6037":{},"6038":{},"6039":{}}}],["sdk.izosmftsoresponse",{"_index":3994,"name":{},"parent":{"5409":{},"5410":{},"5411":{},"5412":{},"5413":{},"5414":{},"5415":{},"5416":{},"5417":{}}}],["sdk.jobdataresolve",{"_index":3747,"name":{},"parent":{"5082":{}}}],["sdk.jobresolve",{"_index":3749,"name":{},"parent":{"5084":{}}}],["sdk.jobsconstants",{"_index":3613,"name":{},"parent":{"4877":{},"4878":{},"4879":{},"4880":{},"4881":{},"4882":{},"4883":{},"4884":{},"4885":{},"4886":{},"4887":{},"4888":{},"4889":{},"4890":{},"4891":{},"4892":{},"4893":{},"4894":{},"4895":{},"4896":{}}}],["sdk.list",{"_index":3437,"name":{},"parent":{"4637":{},"4638":{},"4639":{},"4640":{},"4641":{},"4642":{},"4643":{},"4644":{}}}],["sdk.listarchivedworkflows",{"_index":4242,"name":{},"parent":{"5783":{}}}],["sdk.listcatalogtemplates",{"_index":2859,"name":{},"parent":{"3886":{}}}],["sdk.listdefinedsystems",{"_index":4370,"name":{},"parent":{"6069":{}}}],["sdk.listinstanceinfo",{"_index":2931,"name":{},"parent":{"3990":{}}}],["sdk.listinstancevariables",{"_index":2936,"name":{},"parent":{"3994":{},"3995":{}}}],["sdk.listregistryinstances",{"_index":2947,"name":{},"parent":{"4007":{},"4008":{},"4009":{}}}],["sdk.listtemplateinfo",{"_index":2973,"name":{},"parent":{"4052":{},"4053":{}}}],["sdk.listworkflows",{"_index":4250,"name":{},"parent":{"5795":{},"5796":{},"5797":{}}}],["sdk.login",{"_index":172,"name":{},"parent":{"127":{}}}],["sdk.loginconstants",{"_index":169,"name":{},"parent":{"125":{}}}],["sdk.logout",{"_index":184,"name":{},"parent":{"137":{}}}],["sdk.logoutconstants",{"_index":174,"name":{},"parent":{"129":{},"130":{},"131":{}}}],["sdk.logoutconstants.apiml_v2_logout_err_list",{"_index":178,"name":{},"parent":{"132":{},"133":{},"134":{},"135":{}}}],["sdk.modifyjobs",{"_index":3752,"name":{},"parent":{"5086":{},"5087":{},"5088":{}}}],["sdk.monitorjobs",{"_index":3764,"name":{},"parent":{"5097":{},"5098":{},"5099":{},"5100":{},"5101":{},"5102":{},"5103":{},"5104":{},"5105":{},"5106":{}}}],["sdk.mount",{"_index":3604,"name":{},"parent":{"4867":{},"4868":{}}}],["sdk.noaccountinfo",{"_index":2824,"name":{},"parent":{"3848":{}}}],["sdk.noaccountnumber",{"_index":3888,"name":{},"parent":{"5230":{}}}],["sdk.noactionname",{"_index":2828,"name":{},"parent":{"3852":{}}}],["sdk.nocollectparameters",{"_index":3071,"name":{},"parent":{"4187":{}}}],["sdk.nocommandinput",{"_index":3894,"name":{},"parent":{"5236":{}}}],["sdk.nocommandkey",{"_index":3069,"name":{},"parent":{"4185":{}}}],["sdk.noconsoleinput",{"_index":3065,"name":{},"parent":{"4181":{}}}],["sdk.noconsolename",{"_index":3067,"name":{},"parent":{"4183":{}}}],["sdk.nodatainput",{"_index":3892,"name":{},"parent":{"5234":{}}}],["sdk.noinstanceid",{"_index":2826,"name":{},"parent":{"3850":{}}}],["sdk.noowner",{"_index":4116,"name":{},"parent":{"5610":{}}}],["sdk.nopinginput",{"_index":3886,"name":{},"parent":{"5228":{}}}],["sdk.noservletkeyinput",{"_index":3890,"name":{},"parent":{"5232":{}}}],["sdk.nosession",{"_index":282,"name":{},"parent":{"288":{}}}],["sdk.nosessionmessage",{"_index":3842,"name":{},"parent":{"5184":{}}}],["sdk.nosessionprovisioning",{"_index":2820,"name":{},"parent":{"3844":{}}}],["sdk.nosessiontso",{"_index":3876,"name":{},"parent":{"5218":{}}}],["sdk.nosteps",{"_index":4104,"name":{},"parent":{"5598":{}}}],["sdk.nosystemname",{"_index":4112,"name":{},"parent":{"5606":{}}}],["sdk.notemplatename",{"_index":2822,"name":{},"parent":{"3846":{}}}],["sdk.notsoissueinput",{"_index":3880,"name":{},"parent":{"5222":{}}}],["sdk.notsostartinput",{"_index":3878,"name":{},"parent":{"5220":{}}}],["sdk.notsostopinput",{"_index":3882,"name":{},"parent":{"5224":{}}}],["sdk.novariables",{"_index":4106,"name":{},"parent":{"5600":{}}}],["sdk.noworkflowdefinitionfile",{"_index":4108,"name":{},"parent":{"5602":{}}}],["sdk.noworkflowkey",{"_index":4100,"name":{},"parent":{"5594":{}}}],["sdk.noworkflowname",{"_index":4110,"name":{},"parent":{"5604":{}}}],["sdk.nozosmfinput",{"_index":3063,"name":{},"parent":{"4179":{}}}],["sdk.nozosmfresponse",{"_index":3884,"name":{},"parent":{"5226":{}}}],["sdk.nozosmfversion",{"_index":280,"name":{},"parent":{"286":{}}}],["sdk.performaction",{"_index":2980,"name":{},"parent":{"4063":{},"4064":{}}}],["sdk.pingtso",{"_index":3981,"name":{},"parent":{"5394":{},"5395":{}}}],["sdk.profileconstants",{"_index":187,"name":{},"parent":{"139":{},"140":{},"146":{},"152":{},"158":{},"164":{},"171":{},"177":{},"183":{},"188":{},"193":{},"194":{},"197":{},"200":{},"203":{},"206":{},"208":{},"211":{},"214":{},"217":{},"220":{},"221":{},"222":{},"223":{},"224":{},"227":{},"230":{},"231":{},"232":{},"235":{},"238":{},"241":{}}}],["sdk.profileconstants.apiml_login_example1",{"_index":234,"name":{},"parent":{"225":{},"226":{}}}],["sdk.profileconstants.apiml_login_example2",{"_index":237,"name":{},"parent":{"228":{},"229":{}}}],["sdk.profileconstants.apiml_logout_example1",{"_index":241,"name":{},"parent":{"233":{},"234":{}}}],["sdk.profileconstants.apiml_logout_example2",{"_index":243,"name":{},"parent":{"236":{},"237":{}}}],["sdk.profileconstants.apiml_logout_option_token_type",{"_index":246,"name":{},"parent":{"239":{}}}],["sdk.profileconstants.apiml_logout_option_token_type.allowablevalues",{"_index":248,"name":{},"parent":{"240":{}}}],["sdk.profileconstants.auto_init_option_cert_file",{"_index":226,"name":{},"parent":{"215":{},"216":{}}}],["sdk.profileconstants.auto_init_option_cert_key_file",{"_index":228,"name":{},"parent":{"218":{},"219":{}}}],["sdk.profileconstants.auto_init_option_host",{"_index":212,"name":{},"parent":{"195":{},"196":{}}}],["sdk.profileconstants.auto_init_option_password",{"_index":218,"name":{},"parent":{"204":{},"205":{}}}],["sdk.profileconstants.auto_init_option_port",{"_index":214,"name":{},"parent":{"198":{},"199":{}}}],["sdk.profileconstants.auto_init_option_reject_unauthorized",{"_index":220,"name":{},"parent":{"207":{}}}],["sdk.profileconstants.auto_init_option_token_type",{"_index":222,"name":{},"parent":{"209":{},"210":{}}}],["sdk.profileconstants.auto_init_option_token_value",{"_index":224,"name":{},"parent":{"212":{},"213":{}}}],["sdk.profileconstants.auto_init_option_user",{"_index":216,"name":{},"parent":{"201":{},"202":{}}}],["sdk.profileconstants.base_option_cert_file",{"_index":207,"name":{},"parent":{"184":{},"185":{},"186":{},"187":{}}}],["sdk.profileconstants.base_option_cert_key_file",{"_index":209,"name":{},"parent":{"189":{},"190":{},"191":{},"192":{}}}],["sdk.profileconstants.base_option_host",{"_index":190,"name":{},"parent":{"141":{},"142":{},"143":{},"144":{},"145":{}}}],["sdk.profileconstants.base_option_password",{"_index":198,"name":{},"parent":{"159":{},"160":{},"161":{},"162":{},"163":{}}}],["sdk.profileconstants.base_option_port",{"_index":194,"name":{},"parent":{"147":{},"148":{},"149":{},"150":{},"151":{}}}],["sdk.profileconstants.base_option_reject_unauthorized",{"_index":200,"name":{},"parent":{"165":{},"166":{},"167":{},"168":{},"169":{},"170":{}}}],["sdk.profileconstants.base_option_token_type",{"_index":203,"name":{},"parent":{"172":{},"173":{},"174":{},"175":{},"176":{}}}],["sdk.profileconstants.base_option_token_value",{"_index":205,"name":{},"parent":{"178":{},"179":{},"180":{},"181":{},"182":{}}}],["sdk.profileconstants.base_option_user",{"_index":196,"name":{},"parent":{"153":{},"154":{},"155":{},"156":{},"157":{}}}],["sdk.profileconstants.baseprofile",{"_index":250,"name":{},"parent":{"242":{},"243":{},"283":{},"284":{}}}],["sdk.profileconstants.baseprofile.schema",{"_index":252,"name":{},"parent":{"244":{},"245":{},"246":{},"247":{},"282":{}}}],["sdk.profileconstants.baseprofile.schema.properties",{"_index":255,"name":{},"parent":{"248":{},"252":{},"255":{},"260":{},"265":{},"269":{},"272":{},"276":{},"279":{}}}],["sdk.profileconstants.baseprofile.schema.properties.certfile",{"_index":272,"name":{},"parent":{"277":{},"278":{}}}],["sdk.profileconstants.baseprofile.schema.properties.certkeyfile",{"_index":274,"name":{},"parent":{"280":{},"281":{}}}],["sdk.profileconstants.baseprofile.schema.properties.host",{"_index":256,"name":{},"parent":{"249":{},"250":{},"251":{}}}],["sdk.profileconstants.baseprofile.schema.properties.password",{"_index":264,"name":{},"parent":{"261":{},"262":{},"263":{},"264":{}}}],["sdk.profileconstants.baseprofile.schema.properties.port",{"_index":260,"name":{},"parent":{"253":{},"254":{}}}],["sdk.profileconstants.baseprofile.schema.properties.rejectunauthorized",{"_index":266,"name":{},"parent":{"266":{},"267":{},"268":{}}}],["sdk.profileconstants.baseprofile.schema.properties.tokentype",{"_index":268,"name":{},"parent":{"270":{},"271":{}}}],["sdk.profileconstants.baseprofile.schema.properties.tokenvalue",{"_index":270,"name":{},"parent":{"273":{},"274":{},"275":{}}}],["sdk.profileconstants.baseprofile.schema.properties.user",{"_index":262,"name":{},"parent":{"256":{},"257":{},"258":{},"259":{}}}],["sdk.propertiesworkflow",{"_index":4304,"name":{},"parent":{"5997":{},"5998":{}}}],["sdk.provisioningconstants",{"_index":2810,"name":{},"parent":{"3834":{},"3835":{},"3836":{},"3837":{},"3838":{},"3839":{},"3840":{},"3841":{},"3842":{}}}],["sdk.provisioningservice",{"_index":3009,"name":{},"parent":{"4115":{},"4116":{},"4117":{}}}],["sdk.provisioningvalidator",{"_index":2831,"name":{},"parent":{"3854":{},"3855":{},"3856":{}}}],["sdk.provisionpublishedtemplate",{"_index":3005,"name":{},"parent":{"4112":{},"4113":{}}}],["sdk.rename",{"_index":3607,"name":{},"parent":{"4870":{},"4871":{},"4872":{}}}],["sdk.resetcounter",{"_index":3061,"name":{},"parent":{"4177":{}}}],["sdk.sendresponse",{"_index":3947,"name":{},"parent":{"5348":{}}}],["sdk.sendtso",{"_index":4010,"name":{},"parent":{"5430":{},"5431":{},"5432":{},"5433":{},"5434":{}}}],["sdk.services",{"_index":52,"name":{},"parent":{"39":{},"40":{},"41":{}}}],["sdk.shell",{"_index":4060,"name":{},"parent":{"5516":{},"5517":{},"5518":{},"5519":{},"5520":{},"5521":{}}}],["sdk.sshbasehandler",{"_index":4067,"name":{},"parent":{"5524":{},"5525":{},"5526":{},"5527":{},"5528":{},"5529":{},"5530":{},"5531":{},"5532":{},"5533":{},"5534":{}}}],["sdk.sshsession",{"_index":4026,"name":{},"parent":{"5448":{},"5449":{},"5450":{},"5451":{},"5458":{},"5459":{},"5466":{},"5473":{},"5474":{},"5480":{},"5486":{},"5492":{},"5498":{},"5499":{},"5500":{},"5501":{},"5502":{},"5503":{}}}],["sdk.sshsession.ssh_option_handshaketimeout",{"_index":4043,"name":{},"parent":{"5493":{},"5494":{},"5495":{},"5496":{},"5497":{}}}],["sdk.sshsession.ssh_option_host",{"_index":4029,"name":{},"parent":{"5452":{},"5453":{},"5454":{},"5455":{},"5456":{},"5457":{}}}],["sdk.sshsession.ssh_option_keypassphrase",{"_index":4041,"name":{},"parent":{"5487":{},"5488":{},"5489":{},"5490":{},"5491":{}}}],["sdk.sshsession.ssh_option_password",{"_index":4037,"name":{},"parent":{"5475":{},"5476":{},"5477":{},"5478":{},"5479":{}}}],["sdk.sshsession.ssh_option_port",{"_index":4032,"name":{},"parent":{"5460":{},"5461":{},"5462":{},"5463":{},"5464":{},"5465":{}}}],["sdk.sshsession.ssh_option_privatekey",{"_index":4039,"name":{},"parent":{"5481":{},"5482":{},"5483":{},"5484":{},"5485":{}}}],["sdk.sshsession.ssh_option_user",{"_index":4034,"name":{},"parent":{"5467":{},"5468":{},"5469":{},"5470":{},"5471":{},"5472":{}}}],["sdk.starttso",{"_index":3984,"name":{},"parent":{"5397":{},"5398":{},"5399":{},"5400":{}}}],["sdk.startworkflow",{"_index":4312,"name":{},"parent":{"6005":{}}}],["sdk.stoptso",{"_index":3988,"name":{},"parent":{"5402":{},"5403":{},"5404":{}}}],["sdk.submitjobs",{"_index":3774,"name":{},"parent":{"5108":{},"5109":{},"5110":{},"5111":{},"5112":{},"5113":{},"5114":{},"5115":{},"5116":{},"5117":{},"5118":{},"5119":{},"5120":{},"5121":{},"5122":{},"5123":{},"5124":{}}}],["sdk.tag",{"_index":3481,"name":{},"parent":{"4692":{},"4693":{},"4694":{}}}],["sdk.transfermode",{"_index":3491,"name":{},"parent":{"4702":{},"4703":{}}}],["sdk.tsoconstants",{"_index":3857,"name":{},"parent":{"5198":{},"5199":{},"5200":{},"5201":{},"5202":{},"5203":{},"5204":{},"5205":{},"5206":{},"5207":{},"5208":{},"5209":{},"5210":{},"5211":{},"5212":{},"5213":{},"5214":{},"5215":{},"5216":{}}}],["sdk.tsoprofileconstants",{"_index":3913,"name":{},"parent":{"5254":{},"5255":{},"5262":{},"5264":{},"5271":{},"5278":{},"5285":{},"5292":{},"5299":{},"5305":{}}}],["sdk.tsoprofileconstants.tso_option_account",{"_index":3915,"name":{},"parent":{"5256":{},"5257":{},"5258":{},"5259":{},"5260":{},"5261":{}}}],["sdk.tsoprofileconstants.tso_option_account_profile",{"_index":3917,"name":{},"parent":{"5263":{}}}],["sdk.tsoprofileconstants.tso_option_char_set",{"_index":3919,"name":{},"parent":{"5265":{},"5266":{},"5267":{},"5268":{},"5269":{},"5270":{}}}],["sdk.tsoprofileconstants.tso_option_code_page",{"_index":3921,"name":{},"parent":{"5272":{},"5273":{},"5274":{},"5275":{},"5276":{},"5277":{}}}],["sdk.tsoprofileconstants.tso_option_columns",{"_index":3923,"name":{},"parent":{"5279":{},"5280":{},"5281":{},"5282":{},"5283":{},"5284":{}}}],["sdk.tsoprofileconstants.tso_option_logon_procedure",{"_index":3925,"name":{},"parent":{"5286":{},"5287":{},"5288":{},"5289":{},"5290":{},"5291":{}}}],["sdk.tsoprofileconstants.tso_option_region_size",{"_index":3927,"name":{},"parent":{"5293":{},"5294":{},"5295":{},"5296":{},"5297":{},"5298":{}}}],["sdk.tsoprofileconstants.tso_option_rows",{"_index":3929,"name":{},"parent":{"5300":{},"5301":{},"5302":{},"5303":{},"5304":{}}}],["sdk.tsoresponseservice",{"_index":3976,"name":{},"parent":{"5390":{},"5391":{},"5392":{}}}],["sdk.tsovalidator",{"_index":4000,"name":{},"parent":{"5419":{},"5420":{},"5421":{},"5422":{},"5423":{},"5424":{},"5425":{},"5426":{},"5427":{},"5428":{}}}],["sdk.unmount",{"_index":3610,"name":{},"parent":{"4874":{}}}],["sdk.upload",{"_index":3557,"name":{},"parent":{"4802":{},"4803":{},"4804":{},"4805":{},"4806":{},"4807":{},"4808":{},"4809":{},"4810":{},"4811":{},"4812":{},"4813":{},"4814":{},"4815":{},"4816":{},"4817":{},"4818":{}}}],["sdk.utilities",{"_index":3485,"name":{},"parent":{"4696":{},"4697":{},"4698":{},"4699":{},"4700":{}}}],["sdk.workflowconstants",{"_index":4084,"name":{},"parent":{"5571":{},"5572":{},"5573":{},"5574":{},"5575":{},"5576":{},"5577":{},"5578":{},"5579":{},"5580":{},"5581":{},"5582":{},"5583":{},"5584":{},"5585":{},"5586":{},"5587":{},"5588":{},"5589":{},"5590":{},"5591":{},"5592":{}}}],["sdk.workflowvalidator",{"_index":4120,"name":{},"parent":{"5614":{},"5615":{},"5616":{},"5617":{},"5618":{}}}],["sdk.wrongowner",{"_index":4118,"name":{},"parent":{"5612":{}}}],["sdk.wrongstring",{"_index":4114,"name":{},"parent":{"5608":{}}}],["sdk.wrongworkflowkey",{"_index":4102,"name":{},"parent":{"5596":{}}}],["sdk.zosfilesattributes",{"_index":3494,"name":{},"parent":{"4705":{},"4706":{},"4707":{},"4708":{},"4709":{},"4710":{},"4711":{},"4712":{},"4713":{},"4714":{},"4715":{},"4716":{},"4717":{}}}],["sdk.zosfilesconstants",{"_index":3108,"name":{},"parent":{"4223":{},"4224":{},"4225":{},"4226":{},"4227":{},"4228":{},"4229":{},"4230":{},"4231":{},"4232":{},"4233":{},"4234":{},"4235":{},"4236":{},"4237":{},"4238":{},"4239":{},"4240":{},"4241":{},"4242":{},"4243":{},"4244":{},"4245":{},"4246":{},"4247":{},"4248":{},"4249":{}}}],["sdk.zosfilesmessages",{"_index":3137,"name":{},"parent":{"4251":{},"4253":{},"4255":{},"4257":{},"4259":{},"4261":{},"4263":{},"4265":{},"4267":{},"4269":{},"4271":{},"4273":{},"4275":{},"4277":{},"4279":{},"4281":{},"4283":{},"4285":{},"4287":{},"4289":{},"4291":{},"4293":{},"4295":{},"4297":{},"4299":{},"4301":{},"4303":{},"4305":{},"4307":{},"4309":{},"4311":{},"4313":{},"4315":{},"4317":{},"4319":{},"4321":{},"4323":{},"4325":{},"4327":{},"4329":{},"4331":{},"4333":{},"4335":{},"4337":{},"4339":{},"4341":{},"4343":{},"4345":{},"4347":{},"4349":{},"4351":{},"4353":{},"4355":{},"4357":{},"4359":{},"4361":{},"4363":{},"4365":{},"4367":{},"4369":{},"4371":{},"4373":{},"4375":{},"4377":{},"4379":{},"4381":{},"4383":{},"4385":{},"4387":{},"4389":{},"4391":{},"4393":{},"4395":{},"4397":{},"4399":{},"4401":{},"4403":{},"4405":{},"4407":{},"4409":{},"4411":{},"4413":{},"4415":{},"4417":{},"4419":{},"4421":{},"4423":{},"4425":{},"4427":{},"4429":{},"4431":{},"4433":{}}}],["sdk.zosfilesmessages.alldatasetsarchived",{"_index":3236,"name":{},"parent":{"4350":{}}}],["sdk.zosfilesmessages.amscommandexecutedsuccessfully",{"_index":3222,"name":{},"parent":{"4336":{}}}],["sdk.zosfilesmessages.attributesfilenotfound",{"_index":3252,"name":{},"parent":{"4366":{}}}],["sdk.zosfilesmessages.attributetitle",{"_index":3314,"name":{},"parent":{"4428":{}}}],["sdk.zosfilesmessages.commonfor",{"_index":3316,"name":{},"parent":{"4430":{}}}],["sdk.zosfilesmessages.commonwithvalue",{"_index":3320,"name":{},"parent":{"4434":{}}}],["sdk.zosfilesmessages.datasetallocatelikenotfound",{"_index":3306,"name":{},"parent":{"4420":{}}}],["sdk.zosfilesmessages.datasetcopiedaborted",{"_index":3298,"name":{},"parent":{"4412":{}}}],["sdk.zosfilesmessages.datasetcopiedabortednopds",{"_index":3302,"name":{},"parent":{"4416":{}}}],["sdk.zosfilesmessages.datasetcopiedabortednotargetds",{"_index":3296,"name":{},"parent":{"4410":{}}}],["sdk.zosfilesmessages.datasetcopiedabortedtargetnotpdsmember",{"_index":3304,"name":{},"parent":{"4418":{}}}],["sdk.zosfilesmessages.datasetcopiedsuccessfully",{"_index":3294,"name":{},"parent":{"4408":{}}}],["sdk.zosfilesmessages.datasetcreatedsuccessfully",{"_index":3168,"name":{},"parent":{"4282":{}}}],["sdk.zosfilesmessages.datasetdeletedsuccessfully",{"_index":3170,"name":{},"parent":{"4284":{}}}],["sdk.zosfilesmessages.datasetdeletionrequested",{"_index":3288,"name":{},"parent":{"4402":{}}}],["sdk.zosfilesmessages.datasetdownloadedsuccessfully",{"_index":3172,"name":{},"parent":{"4286":{}}}],["sdk.zosfilesmessages.datasetdownloadedwithdestination",{"_index":3174,"name":{},"parent":{"4288":{}}}],["sdk.zosfilesmessages.datasetdownloadfailed",{"_index":3310,"name":{},"parent":{"4424":{}}}],["sdk.zosfilesmessages.datasetmembercopiedaborted",{"_index":3300,"name":{},"parent":{"4414":{}}}],["sdk.zosfilesmessages.datasetmigrationrequested",{"_index":3290,"name":{},"parent":{"4404":{}}}],["sdk.zosfilesmessages.datasetrecalledsuccessfully",{"_index":3284,"name":{},"parent":{"4398":{}}}],["sdk.zosfilesmessages.datasetrecallrequested",{"_index":3292,"name":{},"parent":{"4406":{}}}],["sdk.zosfilesmessages.datasetrenamedsuccessfully",{"_index":3286,"name":{},"parent":{"4400":{}}}],["sdk.zosfilesmessages.datasetsdownloadedsuccessfully",{"_index":3186,"name":{},"parent":{"4300":{}}}],["sdk.zosfilesmessages.datasetsmatchedpattern",{"_index":3188,"name":{},"parent":{"4302":{}}}],["sdk.zosfilesmessages.datasetuploadedsuccessfully",{"_index":3190,"name":{},"parent":{"4304":{}}}],["sdk.zosfilesmessages.errorparsingattributesfile",{"_index":3256,"name":{},"parent":{"4370":{}}}],["sdk.zosfilesmessages.errorreadingattributesfile",{"_index":3254,"name":{},"parent":{"4368":{}}}],["sdk.zosfilesmessages.failedtodownloaddatasets",{"_index":3246,"name":{},"parent":{"4360":{}}}],["sdk.zosfilesmessages.fsmountedsuccessfully",{"_index":3278,"name":{},"parent":{"4392":{}}}],["sdk.zosfilesmessages.fsunmountedsuccessfully",{"_index":3280,"name":{},"parent":{"4394":{}}}],["sdk.zosfilesmessages.invalidalcunitoption",{"_index":3200,"name":{},"parent":{"4314":{}}}],["sdk.zosfilesmessages.invalidattributessyntax",{"_index":3250,"name":{},"parent":{"4364":{}}}],["sdk.zosfilesmessages.invaliddsntypeoption",{"_index":3198,"name":{},"parent":{"4312":{}}}],["sdk.zosfilesmessages.invaliddsorgoption",{"_index":3204,"name":{},"parent":{"4318":{}}}],["sdk.zosfilesmessages.invalidfilename",{"_index":3318,"name":{},"parent":{"4432":{}}}],["sdk.zosfilesmessages.invalidfilescreateoption",{"_index":3196,"name":{},"parent":{"4310":{}}}],["sdk.zosfilesmessages.invalidfilesmountoption",{"_index":3272,"name":{},"parent":{"4386":{}}}],["sdk.zosfilesmessages.invalidmountmodeoption",{"_index":3276,"name":{},"parent":{"4390":{}}}],["sdk.zosfilesmessages.invalidpermsoption",{"_index":3262,"name":{},"parent":{"4376":{}}}],["sdk.zosfilesmessages.invalidpodsorgdirblkcombination",{"_index":3210,"name":{},"parent":{"4324":{}}}],["sdk.zosfilesmessages.invalidpsdsorgdirblkcombination",{"_index":3208,"name":{},"parent":{"4322":{}}}],["sdk.zosfilesmessages.invalidrecfmoption",{"_index":3206,"name":{},"parent":{"4320":{}}}],["sdk.zosfilesmessages.longamsstatement",{"_index":3224,"name":{},"parent":{"4338":{}}}],["sdk.zosfilesmessages.maximumallocationquantityexceeded",{"_index":3212,"name":{},"parent":{"4326":{}}}],["sdk.zosfilesmessages.memberdownloadfailed",{"_index":3308,"name":{},"parent":{"4422":{}}}],["sdk.zosfilesmessages.missingdatasetlikename",{"_index":3148,"name":{},"parent":{"4262":{}}}],["sdk.zosfilesmessages.missingdatasetname",{"_index":3146,"name":{},"parent":{"4260":{}}}],["sdk.zosfilesmessages.missingdatasets",{"_index":3234,"name":{},"parent":{"4348":{}}}],["sdk.zosfilesmessages.missingdatasettype",{"_index":3144,"name":{},"parent":{"4258":{}}}],["sdk.zosfilesmessages.missingfilescreateoptions",{"_index":3194,"name":{},"parent":{"4308":{}}}],["sdk.zosfilesmessages.missingfilesmountoptions",{"_index":3270,"name":{},"parent":{"4384":{}}}],["sdk.zosfilesmessages.missingfilesystemname",{"_index":3258,"name":{},"parent":{"4372":{}}}],["sdk.zosfilesmessages.missingfsoption",{"_index":3274,"name":{},"parent":{"4388":{}}}],["sdk.zosfilesmessages.missinginputdir",{"_index":3166,"name":{},"parent":{"4280":{}}}],["sdk.zosfilesmessages.missinginputdirectory",{"_index":3164,"name":{},"parent":{"4278":{}}}],["sdk.zosfilesmessages.missinginputfile",{"_index":3162,"name":{},"parent":{"4276":{}}}],["sdk.zosfilesmessages.missingmountpoint",{"_index":3268,"name":{},"parent":{"4382":{}}}],["sdk.zosfilesmessages.missingpatterns",{"_index":3232,"name":{},"parent":{"4346":{}}}],["sdk.zosfilesmessages.missingpayload",{"_index":3156,"name":{},"parent":{"4270":{}}}],["sdk.zosfilesmessages.missingprimary",{"_index":3202,"name":{},"parent":{"4316":{}}}],["sdk.zosfilesmessages.missingrecordlength",{"_index":3214,"name":{},"parent":{"4328":{}}}],["sdk.zosfilesmessages.missingrequesttype",{"_index":3160,"name":{},"parent":{"4274":{}}}],["sdk.zosfilesmessages.missingrequiredtableparameters",{"_index":3154,"name":{},"parent":{"4268":{}}}],["sdk.zosfilesmessages.missingstatements",{"_index":3216,"name":{},"parent":{"4330":{}}}],["sdk.zosfilesmessages.missingussdirectoryname",{"_index":3158,"name":{},"parent":{"4272":{}}}],["sdk.zosfilesmessages.missingussdirname",{"_index":3152,"name":{},"parent":{"4266":{}}}],["sdk.zosfilesmessages.missingussfilename",{"_index":3150,"name":{},"parent":{"4264":{}}}],["sdk.zosfilesmessages.missingvsamoption",{"_index":3218,"name":{},"parent":{"4332":{}}}],["sdk.zosfilesmessages.missingzfsoption",{"_index":3260,"name":{},"parent":{"4374":{}}}],["sdk.zosfilesmessages.nodatasetsinlist",{"_index":3238,"name":{},"parent":{"4352":{}}}],["sdk.zosfilesmessages.nodatasetsmatchingpattern",{"_index":3240,"name":{},"parent":{"4354":{}}}],["sdk.zosfilesmessages.nodatasetsmatchingpatternremain",{"_index":3242,"name":{},"parent":{"4356":{}}}],["sdk.zosfilesmessages.nodejsfserror",{"_index":3248,"name":{},"parent":{"4362":{}}}],["sdk.zosfilesmessages.nomembersfound",{"_index":3192,"name":{},"parent":{"4306":{}}}],["sdk.zosfilesmessages.onlyemptypartitioneddatasets",{"_index":3244,"name":{},"parent":{"4358":{}}}],["sdk.zosfilesmessages.pathisnotdirectory",{"_index":3226,"name":{},"parent":{"4340":{}}}],["sdk.zosfilesmessages.somedownloadsfailed",{"_index":3312,"name":{},"parent":{"4426":{}}}],["sdk.zosfilesmessages.unsupporteddatasettype",{"_index":3138,"name":{},"parent":{"4252":{}}}],["sdk.zosfilesmessages.unsupporteddatatype",{"_index":3142,"name":{},"parent":{"4256":{}}}],["sdk.zosfilesmessages.unsupportedmaskingindatasetname",{"_index":3140,"name":{},"parent":{"4254":{}}}],["sdk.zosfilesmessages.uploaddirectorytodatasetmember",{"_index":3228,"name":{},"parent":{"4342":{}}}],["sdk.zosfilesmessages.uploaddirectorytophysicalsequentialdataset",{"_index":3230,"name":{},"parent":{"4344":{}}}],["sdk.zosfilesmessages.usscreatedsuccessfully",{"_index":3282,"name":{},"parent":{"4396":{}}}],["sdk.zosfilesmessages.ussdiruploadedsuccessfully",{"_index":3182,"name":{},"parent":{"4296":{}}}],["sdk.zosfilesmessages.ussfiledeletedsuccessfully",{"_index":3184,"name":{},"parent":{"4298":{}}}],["sdk.zosfilesmessages.ussfiledownloadedsuccessfully",{"_index":3176,"name":{},"parent":{"4290":{}}}],["sdk.zosfilesmessages.ussfiledownloadedwithdestination",{"_index":3178,"name":{},"parent":{"4292":{}}}],["sdk.zosfilesmessages.ussfileuploadedsuccessfully",{"_index":3180,"name":{},"parent":{"4294":{}}}],["sdk.zosfilesmessages.valueoutofbounds",{"_index":3220,"name":{},"parent":{"4334":{}}}],["sdk.zosfilesmessages.zfscreatedsuccessfully",{"_index":3264,"name":{},"parent":{"4378":{}}}],["sdk.zosfilesmessages.zfsdeletedsuccessfully",{"_index":3266,"name":{},"parent":{"4380":{}}}],["sdk.zosfilesoptions",{"_index":4326,"name":{},"parent":{"6020":{}}}],["sdk.zosfilesoptions.responsetimeout",{"_index":4327,"name":{},"parent":{"6021":{},"6022":{},"6023":{},"6024":{},"6025":{},"6026":{}}}],["sdk.zosfilesutils",{"_index":3467,"name":{},"parent":{"4677":{},"4678":{},"4679":{},"4680":{},"4681":{},"4682":{},"4683":{},"4684":{},"4685":{},"4686":{},"4687":{},"4688":{},"4689":{},"4690":{}}}],["sdk.zosjobsmessages",{"_index":3756,"name":{},"parent":{"5090":{},"5092":{},"5094":{}}}],["sdk.zosjobsmessages.missingdirectoryoption",{"_index":3759,"name":{},"parent":{"5093":{}}}],["sdk.zosjobsmessages.missingjcl",{"_index":3761,"name":{},"parent":{"5095":{}}}],["sdk.zosjobsmessages.missingussfilepath",{"_index":3757,"name":{},"parent":{"5091":{}}}],["sdk.zoslogconstants",{"_index":3840,"name":{},"parent":{"5182":{}}}],["sdk.zosmfbasehandler",{"_index":4398,"name":{},"parent":{"6139":{},"6140":{},"6141":{},"6142":{},"6143":{},"6144":{},"6145":{},"6146":{},"6147":{},"6148":{},"6149":{},"6150":{}}}],["sdk.zosmfconstants",{"_index":4317,"name":{},"parent":{"6010":{},"6011":{},"6012":{},"6013":{},"6014":{}}}],["sdk.zosmfconstants.error_codes",{"_index":4321,"name":{},"parent":{"6015":{},"6016":{},"6017":{},"6018":{}}}],["sdk.zosmfheaders",{"_index":82,"name":{},"parent":{"67":{},"68":{},"69":{},"70":{},"72":{},"74":{},"76":{},"78":{},"80":{},"82":{},"84":{},"86":{},"88":{},"90":{},"92":{},"94":{},"96":{},"98":{},"99":{},"101":{},"103":{},"105":{},"107":{},"109":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"118":{}}}],["sdk.zosmfheaders.accept_encoding",{"_index":161,"name":{},"parent":{"119":{}}}],["sdk.zosmfheaders.octet_stream",{"_index":134,"name":{},"parent":{"100":{}}}],["sdk.zosmfheaders.text_plain",{"_index":136,"name":{},"parent":{"102":{}}}],["sdk.zosmfheaders.x_csrf_zosmf_header",{"_index":120,"name":{},"parent":{"89":{}}}],["sdk.zosmfheaders.x_ibm_attributes_base",{"_index":108,"name":{},"parent":{"83":{}}}],["sdk.zosmfheaders.x_ibm_binary",{"_index":124,"name":{},"parent":{"91":{}}}],["sdk.zosmfheaders.x_ibm_binary_by_record",{"_index":128,"name":{},"parent":{"95":{}}}],["sdk.zosmfheaders.x_ibm_intrdr_class_a",{"_index":90,"name":{},"parent":{"71":{}}}],["sdk.zosmfheaders.x_ibm_intrdr_lrecl_256",{"_index":98,"name":{},"parent":{"77":{}}}],["sdk.zosmfheaders.x_ibm_intrdr_lrecl_80",{"_index":96,"name":{},"parent":{"75":{}}}],["sdk.zosmfheaders.x_ibm_intrdr_mode_text",{"_index":101,"name":{},"parent":{"79":{}}}],["sdk.zosmfheaders.x_ibm_intrdr_recfm_f",{"_index":93,"name":{},"parent":{"73":{}}}],["sdk.zosmfheaders.x_ibm_job_modify_version_1",{"_index":113,"name":{},"parent":{"85":{}}}],["sdk.zosmfheaders.x_ibm_job_modify_version_2",{"_index":115,"name":{},"parent":{"87":{}}}],["sdk.zosmfheaders.x_ibm_max_items",{"_index":140,"name":{},"parent":{"104":{}}}],["sdk.zosmfheaders.x_ibm_migrated_recall_error",{"_index":148,"name":{},"parent":{"110":{}}}],["sdk.zosmfheaders.x_ibm_migrated_recall_no_wait",{"_index":146,"name":{},"parent":{"108":{}}}],["sdk.zosmfheaders.x_ibm_migrated_recall_wait",{"_index":144,"name":{},"parent":{"106":{}}}],["sdk.zosmfheaders.x_ibm_notification_url",{"_index":105,"name":{},"parent":{"81":{}}}],["sdk.zosmfheaders.x_ibm_record",{"_index":126,"name":{},"parent":{"93":{}}}],["sdk.zosmfheaders.x_ibm_return_etag",{"_index":157,"name":{},"parent":{"117":{}}}],["sdk.zosmfheaders.x_ibm_text",{"_index":130,"name":{},"parent":{"97":{}}}],["sdk.zosmfmessages",{"_index":4330,"name":{},"parent":{"6028":{},"6030":{},"6032":{},"6034":{}}}],["sdk.zosmfmessages.improperrejectunauthorized",{"_index":4337,"name":{},"parent":{"6035":{}}}],["sdk.zosmfmessages.invalidhostname",{"_index":4333,"name":{},"parent":{"6031":{}}}],["sdk.zosmfmessages.invalidport",{"_index":4335,"name":{},"parent":{"6033":{}}}],["sdk.zosmfmessages.missingsession",{"_index":4331,"name":{},"parent":{"6029":{}}}],["sdk.zosmfprofile",{"_index":4402,"name":{},"parent":{"6152":{},"6153":{},"6199":{},"6200":{}}}],["sdk.zosmfprofile.schema",{"_index":4403,"name":{},"parent":{"6154":{},"6155":{},"6156":{},"6157":{},"6198":{}}}],["sdk.zosmfprofile.schema.properties",{"_index":4404,"name":{},"parent":{"6158":{},"6161":{},"6165":{},"6169":{},"6173":{},"6176":{},"6179":{},"6182":{},"6185":{},"6188":{},"6195":{}}}],["sdk.zosmfprofile.schema.properties.basepath",{"_index":4412,"name":{},"parent":{"6183":{},"6184":{}}}],["sdk.zosmfprofile.schema.properties.certfile",{"_index":4410,"name":{},"parent":{"6177":{},"6178":{}}}],["sdk.zosmfprofile.schema.properties.certkeyfile",{"_index":4411,"name":{},"parent":{"6180":{},"6181":{}}}],["sdk.zosmfprofile.schema.properties.encoding",{"_index":4414,"name":{},"parent":{"6189":{},"6190":{}}}],["sdk.zosmfprofile.schema.properties.encoding.optiondefinition",{"_index":4415,"name":{},"parent":{"6191":{},"6192":{},"6193":{},"6194":{}}}],["sdk.zosmfprofile.schema.properties.host",{"_index":4405,"name":{},"parent":{"6159":{},"6160":{}}}],["sdk.zosmfprofile.schema.properties.password",{"_index":4408,"name":{},"parent":{"6170":{},"6171":{},"6172":{}}}],["sdk.zosmfprofile.schema.properties.port",{"_index":4406,"name":{},"parent":{"6162":{},"6163":{},"6164":{}}}],["sdk.zosmfprofile.schema.properties.protocol",{"_index":4413,"name":{},"parent":{"6186":{},"6187":{}}}],["sdk.zosmfprofile.schema.properties.rejectunauthorized",{"_index":4409,"name":{},"parent":{"6174":{},"6175":{}}}],["sdk.zosmfprofile.schema.properties.responsetimeout",{"_index":4416,"name":{},"parent":{"6196":{},"6197":{}}}],["sdk.zosmfprofile.schema.properties.user",{"_index":4407,"name":{},"parent":{"6166":{},"6167":{},"6168":{}}}],["sdk.zosmfrestclient",{"_index":164,"name":{},"parent":{"121":{},"122":{},"123":{}}}],["sdk.zosmfsession",{"_index":4373,"name":{},"parent":{"6071":{},"6072":{},"6079":{},"6080":{},"6087":{},"6094":{},"6095":{},"6102":{},"6103":{},"6110":{},"6116":{},"6125":{},"6130":{},"6135":{},"6136":{},"6137":{}}}],["sdk.zosmfsession.zosmf_option_base_path",{"_index":4388,"name":{},"parent":{"6111":{},"6112":{},"6113":{},"6114":{},"6115":{}}}],["sdk.zosmfsession.zosmf_option_cert_file",{"_index":4393,"name":{},"parent":{"6126":{},"6127":{},"6128":{},"6129":{}}}],["sdk.zosmfsession.zosmf_option_cert_key_file",{"_index":4395,"name":{},"parent":{"6131":{},"6132":{},"6133":{},"6134":{}}}],["sdk.zosmfsession.zosmf_option_host",{"_index":4375,"name":{},"parent":{"6073":{},"6074":{},"6075":{},"6076":{},"6077":{},"6078":{}}}],["sdk.zosmfsession.zosmf_option_password",{"_index":4383,"name":{},"parent":{"6096":{},"6097":{},"6098":{},"6099":{},"6100":{},"6101":{}}}],["sdk.zosmfsession.zosmf_option_port",{"_index":4378,"name":{},"parent":{"6081":{},"6082":{},"6083":{},"6084":{},"6085":{},"6086":{}}}],["sdk.zosmfsession.zosmf_option_protocol",{"_index":4390,"name":{},"parent":{"6117":{},"6118":{},"6119":{},"6120":{},"6121":{},"6122":{}}}],["sdk.zosmfsession.zosmf_option_protocol.allowablevalues",{"_index":4391,"name":{},"parent":{"6123":{},"6124":{}}}],["sdk.zosmfsession.zosmf_option_reject_unauthorized",{"_index":4386,"name":{},"parent":{"6104":{},"6105":{},"6106":{},"6107":{},"6108":{},"6109":{}}}],["sdk.zosmfsession.zosmf_option_user",{"_index":4380,"name":{},"parent":{"6088":{},"6089":{},"6090":{},"6091":{},"6092":{},"6093":{}}}],["sdk.zostsobasehandler",{"_index":3992,"name":{},"parent":{"5406":{},"5407":{}}}],["sdk.zostsoprofile",{"_index":3932,"name":{},"parent":{"5307":{},"5308":{},"5338":{},"5339":{}}}],["sdk.zostsoprofile.schema",{"_index":3933,"name":{},"parent":{"5309":{},"5310":{},"5311":{},"5312":{},"5337":{}}}],["sdk.zostsoprofile.schema.properties",{"_index":3934,"name":{},"parent":{"5313":{},"5317":{},"5320":{},"5324":{},"5327":{},"5331":{},"5334":{}}}],["sdk.zostsoprofile.schema.properties.account",{"_index":3935,"name":{},"parent":{"5314":{},"5315":{},"5316":{}}}],["sdk.zostsoprofile.schema.properties.characterset",{"_index":3936,"name":{},"parent":{"5318":{},"5319":{}}}],["sdk.zostsoprofile.schema.properties.codepage",{"_index":3937,"name":{},"parent":{"5321":{},"5322":{},"5323":{}}}],["sdk.zostsoprofile.schema.properties.columns",{"_index":3938,"name":{},"parent":{"5325":{},"5326":{}}}],["sdk.zostsoprofile.schema.properties.logonprocedure",{"_index":3939,"name":{},"parent":{"5328":{},"5329":{},"5330":{}}}],["sdk.zostsoprofile.schema.properties.regionsize",{"_index":3940,"name":{},"parent":{"5332":{},"5333":{}}}],["sdk.zostsoprofile.schema.properties.rows",{"_index":3941,"name":{},"parent":{"5335":{},"5336":{}}}],["sdk.zosussmessages",{"_index":4049,"name":{},"parent":{"5505":{},"5507":{},"5509":{},"5511":{},"5513":{}}}],["sdk.zosussmessages.allauthmethodsfailed",{"_index":4050,"name":{},"parent":{"5506":{}}}],["sdk.zosussmessages.connectionrefused",{"_index":4052,"name":{},"parent":{"5508":{}}}],["sdk.zosussmessages.expiredpassword",{"_index":4057,"name":{},"parent":{"5514":{}}}],["sdk.zosussmessages.handshaketimeout",{"_index":4053,"name":{},"parent":{"5510":{}}}],["sdk.zosussmessages.unexpected",{"_index":4055,"name":{},"parent":{"5512":{}}}],["sdk.zosussprofile",{"_index":4072,"name":{},"parent":{"5536":{},"5537":{},"5568":{}}}],["sdk.zosussprofile.schema",{"_index":4073,"name":{},"parent":{"5538":{},"5539":{},"5540":{},"5541":{},"5567":{}}}],["sdk.zosussprofile.schema.properties",{"_index":4074,"name":{},"parent":{"5542":{},"5545":{},"5549":{},"5553":{},"5557":{},"5560":{},"5564":{}}}],["sdk.zosussprofile.schema.properties.handshaketimeout",{"_index":4081,"name":{},"parent":{"5565":{},"5566":{}}}],["sdk.zosussprofile.schema.properties.host",{"_index":4075,"name":{},"parent":{"5543":{},"5544":{}}}],["sdk.zosussprofile.schema.properties.keypassphrase",{"_index":4080,"name":{},"parent":{"5561":{},"5562":{},"5563":{}}}],["sdk.zosussprofile.schema.properties.password",{"_index":4078,"name":{},"parent":{"5554":{},"5555":{},"5556":{}}}],["sdk.zosussprofile.schema.properties.port",{"_index":4076,"name":{},"parent":{"5546":{},"5547":{},"5548":{}}}],["sdk.zosussprofile.schema.properties.privatekey",{"_index":4079,"name":{},"parent":{"5558":{},"5559":{}}}],["sdk.zosussprofile.schema.properties.user",{"_index":4077,"name":{},"parent":{"5550":{},"5551":{},"5552":{}}}],["search",{"_index":785,"name":{"847":{}},"parent":{}}],["searchtimeout",{"_index":2794,"name":{"3818":{}},"parent":{}}],["secondary",{"_index":3353,"name":{"4486":{},"4507":{}},"parent":{}}],["secondarytextcolor",{"_index":2334,"name":{"2994":{}},"parent":{}}],["sectowait",{"_index":860,"name":{"944":{}},"parent":{}}],["secure",{"_index":63,"name":{"48":{},"257":{},"262":{},"274":{},"558":{},"608":{},"828":{},"2830":{},"3324":{},"5551":{},"5555":{},"5562":{},"6167":{},"6171":{}},"parent":{}}],["secure_acct",{"_index":592,"name":{"600":{}},"parent":{}}],["secure_prompt_options",{"_index":2570,"name":{"3393":{}},"parent":{}}],["secure_value",{"_index":591,"name":{"599":{}},"parent":{}}],["securecredential",{"_index":659,"name":{"681":{}},"parent":{}}],["securedefinition",{"_index":2612,"name":{"3490":{}},"parent":{}}],["secureerrordetails",{"_index":654,"name":{"676":{},"711":{},"735":{}},"parent":{}}],["securefields",{"_index":724,"name":{"774":{},"3401":{}},"parent":{}}],["securehandler",{"_index":2714,"name":{"3646":{}},"parent":{}}],["secureinfoforprop",{"_index":727,"name":{"777":{}},"parent":{}}],["secureoperationfunction",{"_index":1932,"name":{"2368":{}},"parent":{}}],["secureprompt",{"_index":573,"name":{"582":{}},"parent":{}}],["securepropsforprofile",{"_index":725,"name":{"775":{}},"parent":{}}],["secureprotocol",{"_index":1073,"name":{"1228":{}},"parent":{}}],["securesaveerror",{"_index":717,"name":{"766":{}},"parent":{}}],["securesesscfgprops",{"_index":1225,"name":{"1460":{}},"parent":{}}],["selectprofilenamedesc",{"_index":1521,"name":{"1786":{}},"parent":{}}],["self_signed_cert_in_chain",{"_index":4323,"name":{"6017":{}},"parent":{}}],["semver",{"_index":1438,"name":{"1706":{}},"parent":{}}],["senddatatotsocollect",{"_index":4009,"name":{"5430":{}},"parent":{}}],["senddatatotsocommon",{"_index":4011,"name":{"5431":{}},"parent":{}}],["sendresponse",{"_index":3946,"name":{"5347":{}},"parent":{}}],["sendtso",{"_index":4008,"name":{"5429":{}},"parent":{}}],["sequential",{"_index":3381,"name":{"4538":{}},"parent":{}}],["servercertificate",{"_index":1069,"name":{"1224":{}},"parent":{}}],["service",{"_index":42,"name":{"31":{},"670":{},"684":{},"706":{},"725":{}},"parent":{}}],["servicedescription",{"_index":1219,"name":{"1454":{}},"parent":{}}],["serviceid",{"_index":35,"name":{"26":{}},"parent":{}}],["servicename",{"_index":1021,"name":{"1148":{}},"parent":{}}],["services",{"_index":50,"name":{"38":{}},"parent":{}}],["services_endpoint",{"_index":5,"name":{"2":{}},"parent":{}}],["servletkey",{"_index":3896,"name":{"5238":{},"5248":{},"5341":{},"5370":{},"5383":{},"5388":{},"5409":{}},"parent":{}}],["sesscfg",{"_index":1265,"name":{"1506":{}},"parent":{}}],["sesshascreds",{"_index":1224,"name":{"1459":{}},"parent":{}}],["session",{"_index":1095,"name":{"1252":{},"1278":{},"1378":{},"1437":{},"4465":{}},"parent":{}}],["sessionid",{"_index":3996,"name":{"5415":{}},"parent":{}}],["sessionlogin",{"_index":1239,"name":{"1477":{}},"parent":{}}],["sessionlogout",{"_index":1241,"name":{"1479":{}},"parent":{}}],["set",{"_index":635,"name":{"645":{},"655":{},"849":{},"1687":{}},"parent":{}}],["set_action",{"_index":520,"name":{"520":{}},"parent":{}}],["setcredentialshelper",{"_index":675,"name":{"703":{}},"parent":{}}],["setdaemonexitcode",{"_index":1696,"name":{"1997":{}},"parent":{}}],["setdefault",{"_index":1972,"name":{"2418":{},"3123":{},"3297":{}},"parent":{}}],["setdefaultaddressspaceparams",{"_index":3985,"name":{"5399":{}},"parent":{}}],["setdefaultinmetaobject",{"_index":2434,"name":{"3146":{}},"parent":{}}],["setdefaultprofileshandler",{"_index":2765,"name":{"3766":{}},"parent":{}}],["setdefaultvalues",{"_index":2006,"name":{"2456":{}},"parent":{}}],["setdefinition",{"_index":2614,"name":{"3498":{}},"parent":{}}],["setenvironmentforapp",{"_index":2114,"name":{"2716":{}},"parent":{}}],["seterror",{"_index":1650,"name":{"1921":{},"1991":{}},"parent":{}}],["setexitcode",{"_index":869,"name":{"954":{}},"parent":{}}],["setgroupwithonlyprofilescommanddesc",{"_index":1581,"name":{"1846":{}},"parent":{}}],["setgroupwithonlyprofileslistdesc",{"_index":1587,"name":{"1852":{}},"parent":{}}],["setgroupwithonlyprofilessummary",{"_index":1579,"name":{"1844":{}},"parent":{}}],["sethandler",{"_index":2717,"name":{"3650":{}},"parent":{}}],["setloginmemory",{"_index":2585,"name":{"3415":{}},"parent":{}}],["setmessage",{"_index":868,"name":{"953":{}},"parent":{}}],["setobj",{"_index":866,"name":{"952":{}},"parent":{}}],["setoperationdiverge",{"_index":931,"name":{"1017":{},"1097":{}},"parent":{}}],["setoperationfailed",{"_index":926,"name":{"1012":{},"1092":{}},"parent":{}}],["setoperationundoable",{"_index":927,"name":{"1013":{},"1093":{}},"parent":{}}],["setoperationundoattempted",{"_index":932,"name":{"1018":{},"1098":{}},"parent":{}}],["setoperationundofailed",{"_index":930,"name":{"1016":{},"1096":{}},"parent":{}}],["setoptionvalue",{"_index":2562,"name":{"3383":{}},"parent":{}}],["setprofileactiondesc",{"_index":1577,"name":{"1842":{}},"parent":{}}],["setprofileactionsummary",{"_index":1575,"name":{"1840":{}},"parent":{}}],["setprofileexample",{"_index":1585,"name":{"1850":{}},"parent":{}}],["setprofileoptiondesc",{"_index":1583,"name":{"1848":{}},"parent":{}}],["setprofileschemas",{"_index":2574,"name":{"3404":{}},"parent":{}}],["setschema",{"_index":787,"name":{"851":{}},"parent":{}}],["setsecure",{"_index":1271,"name":{"1511":{},"2876":{},"2882":{},"2886":{}},"parent":{}}],["setstatusmessage",{"_index":919,"name":{"1004":{},"1063":{}},"parent":{}}],["settings",{"_index":1421,"name":{"1682":{}},"parent":{}}],["settingsalreadyinitialized",{"_index":2774,"name":{"3776":{}},"parent":{}}],["settingsfile",{"_index":1418,"name":{"1676":{}},"parent":{}}],["settingsnotinitialized",{"_index":2776,"name":{"3787":{}},"parent":{}}],["settooltip",{"_index":2782,"name":{"3802":{}},"parent":{}}],["settransferflags",{"_index":1175,"name":{"1372":{}},"parent":{}}],["settypefortokenrequest",{"_index":1229,"name":{"1468":{}},"parent":{}}],["seventy_percent",{"_index":897,"name":{"979":{}},"parent":{}}],["sharedoptions",{"_index":1701,"name":{"2006":{}},"parent":{}}],["shell",{"_index":4058,"name":{"5515":{}},"parent":{}}],["short",{"_index":1708,"name":{"2014":{}},"parent":{}}],["short_dash",{"_index":1795,"name":{"2119":{},"2165":{}},"parent":{}}],["shouldusekeytar",{"_index":2058,"name":{"2591":{}},"parent":{}}],["show_deps_action",{"_index":515,"name":{"515":{}},"parent":{}}],["showattributes",{"_index":3361,"name":{"4496":{},"4514":{}},"parent":{}}],["showdependenciescommanddesc",{"_index":1539,"name":{"1804":{}},"parent":{}}],["showdependenciesprofileshandler",{"_index":2767,"name":{"3768":{}},"parent":{}}],["showinputsonly",{"_index":1882,"name":{"2256":{}},"parent":{}}],["showmsgwhendeprecated",{"_index":2561,"name":{"3382":{}},"parent":{}}],["showtoken",{"_index":2149,"name":{"2766":{}},"parent":{}}],["silent",{"_index":304,"name":{"308":{},"1918":{},"1931":{},"1986":{},"2093":{}},"parent":{}}],["simple",{"_index":2591,"name":{"3430":{}},"parent":{}}],["singlepagehtml",{"_index":1847,"name":{"2200":{}},"parent":{}}],["singlequote",{"_index":3773,"name":{"5108":{}},"parent":{}}],["sixty_percent",{"_index":896,"name":{"978":{}},"parent":{}}],["size",{"_index":3338,"name":{"4470":{},"4497":{},"4607":{}},"parent":{}}],["sizex",{"_index":3432,"name":{"4631":{}},"parent":{}}],["skills",{"_index":4201,"name":{"5718":{},"5876":{},"5983":{}},"parent":{}}],["skip_prompt",{"_index":593,"name":{"601":{}},"parent":{}}],["skippedexisting",{"_index":3524,"name":{"4750":{}},"parent":{}}],["skiptextwrap",{"_index":1789,"name":{"2113":{},"2147":{}},"parent":{}}],["sleep",{"_index":286,"name":{"292":{},"3385":{}},"parent":{}}],["smfid",{"_index":3632,"name":{"4898":{}},"parent":{}}],["software",{"_index":2844,"name":{"3868":{},"4041":{}},"parent":{}}],["softwareserviceinstancename",{"_index":4296,"name":{"5926":{}},"parent":{}}],["sol",{"_index":2876,"name":{"3908":{},"4121":{},"4124":{},"4132":{}},"parent":{}}],["sol_msgs",{"_index":3047,"name":{"4163":{}},"parent":{}}],["solicitedkeyword",{"_index":3041,"name":{"4153":{}},"parent":{}}],["somedownloadsfailed",{"_index":3311,"name":{"4425":{}},"parent":{}}],["source",{"_index":1048,"name":{"1187":{},"5171":{}},"parent":{}}],["sourceapp",{"_index":2254,"name":{"2904":{}},"parent":{}}],["spacu",{"_index":3433,"name":{"4632":{}},"parent":{}}],["spawnandgetoutput",{"_index":371,"name":{"369":{}},"parent":{}}],["specifications",{"_index":4208,"name":{"5726":{}},"parent":{}}],["specifiedmultipletimeserror",{"_index":1730,"name":{"2039":{}},"parent":{}}],["ssh_connection_option_group",{"_index":4027,"name":{"5450":{}},"parent":{}}],["ssh_connection_options",{"_index":4044,"name":{"5498":{}},"parent":{}}],["ssh_option_handshaketimeout",{"_index":4042,"name":{"5492":{}},"parent":{}}],["ssh_option_host",{"_index":4028,"name":{"5451":{}},"parent":{}}],["ssh_option_host_profile",{"_index":4030,"name":{"5458":{}},"parent":{}}],["ssh_option_keypassphrase",{"_index":4040,"name":{"5486":{}},"parent":{}}],["ssh_option_password",{"_index":4036,"name":{"5474":{}},"parent":{}}],["ssh_option_port",{"_index":4031,"name":{"5459":{}},"parent":{}}],["ssh_option_privatekey",{"_index":4038,"name":{"5480":{}},"parent":{}}],["ssh_option_user",{"_index":4033,"name":{"5466":{}},"parent":{}}],["ssh_option_user_profile",{"_index":4035,"name":{"5473":{}},"parent":{}}],["sshbasehandler",{"_index":4066,"name":{"5523":{}},"parent":{}}],["sshsession",{"_index":4024,"name":{"5447":{}},"parent":{}}],["ssin",{"_index":2897,"name":{"3936":{}},"parent":{}}],["stack",{"_index":310,"name":{"313":{},"720":{},"1191":{},"1330":{},"2867":{},"3447":{},"3735":{},"3746":{},"3784":{},"3795":{},"5062":{}},"parent":{}}],["stacktrace",{"_index":3905,"name":{"5246":{}},"parent":{}}],["stagename",{"_index":880,"name":{"963":{},"1008":{},"1088":{}},"parent":{}}],["start",{"_index":2916,"name":{"3965":{},"4598":{},"5398":{}},"parent":{}}],["start_workflow",{"_index":4088,"name":{"5575":{}},"parent":{}}],["startbar",{"_index":987,"name":{"1108":{}},"parent":{}}],["startcmdflag",{"_index":4059,"name":{"5516":{},"5522":{}},"parent":{}}],["startcommon",{"_index":3983,"name":{"5397":{}},"parent":{}}],["startedtime",{"_index":4256,"name":{"5800":{}},"parent":{}}],["startingconfig",{"_index":76,"name":{"62":{}},"parent":{}}],["startparams",{"_index":3901,"name":{"5242":{}},"parent":{}}],["startready",{"_index":3967,"name":{"5375":{}},"parent":{}}],["startresponse",{"_index":3966,"name":{"5374":{}},"parent":{}}],["startt",{"_index":4310,"name":{"6003":{}},"parent":{}}],["starttime",{"_index":3834,"name":{"5175":{}},"parent":{}}],["starttso",{"_index":3982,"name":{"5396":{}},"parent":{}}],["startuser",{"_index":4254,"name":{"5799":{}},"parent":{}}],["startworkflow",{"_index":4311,"name":{"6004":{},"6005":{}},"parent":{}}],["state",{"_index":2840,"name":{"3863":{},"3935":{},"3955":{},"4036":{},"5877":{},"5934":{}},"parent":{}}],["statement",{"_index":2912,"name":{"3962":{}},"parent":{}}],["status",{"_index":37,"name":{"27":{},"4909":{},"4935":{},"4996":{},"5006":{},"5013":{},"5024":{},"5032":{},"5073":{},"5810":{}},"parent":{}}],["statusmessage",{"_index":879,"name":{"962":{},"990":{},"1064":{}},"parent":{}}],["statusname",{"_index":4092,"name":{"5583":{},"5778":{},"5793":{},"5915":{}},"parent":{}}],["stderr",{"_index":571,"name":{"580":{},"1913":{}},"parent":{}}],["stdin",{"_index":581,"name":{"589":{},"1134":{}},"parent":{}}],["stdin_content_key",{"_index":504,"name":{"504":{}},"parent":{}}],["stdin_default_description",{"_index":501,"name":{"501":{}},"parent":{}}],["stdin_option",{"_index":499,"name":{"499":{}},"parent":{}}],["stdin_option_alias",{"_index":500,"name":{"500":{}},"parent":{}}],["stdinlength",{"_index":580,"name":{"588":{}},"parent":{}}],["stdinoptiondescription",{"_index":833,"name":{"915":{}},"parent":{}}],["stdinstream",{"_index":1302,"name":{"1556":{}},"parent":{}}],["stdout",{"_index":570,"name":{"579":{},"1912":{}},"parent":{}}],["step",{"_index":3635,"name":{"4900":{},"4901":{},"4902":{},"4913":{}},"parent":{}}],["step_data",{"_index":3612,"name":{"4877":{}},"parent":{}}],["stepname",{"_index":3682,"name":{"4973":{},"5068":{},"5078":{},"5822":{},"6001":{}},"parent":{}}],["stepnumber",{"_index":4280,"name":{"5878":{},"5932":{}},"parent":{}}],["steps",{"_index":4096,"name":{"5589":{},"5678":{},"5762":{},"5879":{},"5928":{},"5984":{}},"parent":{}}],["stop",{"_index":2917,"name":{"3966":{},"5403":{}},"parent":{}}],["stop_yargs",{"_index":1901,"name":{"2278":{},"2300":{},"2335":{}},"parent":{}}],["stopcommon",{"_index":3987,"name":{"5402":{}},"parent":{}}],["stoppedtime",{"_index":4257,"name":{"5801":{}},"parent":{}}],["stopresponse",{"_index":3968,"name":{"5376":{}},"parent":{}}],["stoptso",{"_index":3986,"name":{"5401":{}},"parent":{}}],["storclass",{"_index":3357,"name":{"4492":{},"4509":{},"4522":{}},"parent":{}}],["storecookie",{"_index":1074,"name":{"1229":{},"1249":{},"1270":{}},"parent":{}}],["storesesscfgprops",{"_index":1278,"name":{"1525":{}},"parent":{}}],["stream",{"_index":985,"name":{"1106":{},"1555":{},"1927":{},"4725":{},"4979":{}},"parent":{}}],["streamtodataset",{"_index":3560,"name":{"4805":{}},"parent":{}}],["streamtoussfile",{"_index":3563,"name":{"4808":{}},"parent":{}}],["strict",{"_index":2471,"name":{"3207":{},"3212":{},"3218":{}},"parent":{}}],["strictssl",{"_index":1070,"name":{"1225":{}},"parent":{}}],["stringlengthrange",{"_index":811,"name":{"883":{},"894":{}},"parent":{}}],["submitas",{"_index":4202,"name":{"5719":{},"5880":{},"5985":{}},"parent":{}}],["submitjcl",{"_index":3778,"name":{"5112":{}},"parent":{}}],["submitjclcommon",{"_index":3780,"name":{"5114":{}},"parent":{}}],["submitjclnotify",{"_index":3781,"name":{"5115":{}},"parent":{}}],["submitjclnotifycommon",{"_index":3782,"name":{"5116":{}},"parent":{}}],["submitjclstring",{"_index":3779,"name":{"5113":{}},"parent":{}}],["submitjob",{"_index":3775,"name":{"5109":{}},"parent":{}}],["submitjobcommon",{"_index":3777,"name":{"5111":{}},"parent":{}}],["submitjobnotify",{"_index":3783,"name":{"5117":{}},"parent":{}}],["submitjobnotifycommon",{"_index":3785,"name":{"5119":{}},"parent":{}}],["submitjobs",{"_index":3772,"name":{"5107":{}},"parent":{}}],["submitnotifycommon",{"_index":3787,"name":{"5121":{}},"parent":{}}],["submitussjob",{"_index":3776,"name":{"5110":{}},"parent":{}}],["submitussjobnotify",{"_index":3784,"name":{"5118":{}},"parent":{}}],["subsystem",{"_index":3643,"name":{"4907":{},"4972":{},"5812":{}},"parent":{}}],["subtype",{"_index":3826,"name":{"5165":{}},"parent":{}}],["succeeded",{"_index":1649,"name":{"1920":{},"1988":{}},"parent":{}}],["success",{"_index":1644,"name":{"1909":{},"2266":{},"2900":{},"4143":{},"4475":{},"4796":{},"4850":{},"5344":{},"5366":{},"5373":{},"5380":{},"5385":{}},"parent":{}}],["successpattern",{"_index":4203,"name":{"5720":{},"5881":{},"5986":{}},"parent":{}}],["summarizeresults",{"_index":905,"name":{"986":{},"1080":{}},"parent":{}}],["summary",{"_index":830,"name":{"910":{},"1144":{},"2641":{},"2648":{},"3462":{},"3472":{},"3480":{},"3487":{},"3494":{},"3502":{},"3511":{},"3519":{},"3529":{},"3538":{},"3545":{},"3668":{},"3682":{},"3693":{},"3705":{},"3717":{}},"parent":{}}],["supportssso",{"_index":33,"name":{"24":{}},"parent":{}}],["suppressdump",{"_index":312,"name":{"315":{},"719":{},"1193":{},"1329":{},"2866":{},"3446":{},"3734":{},"3745":{},"3783":{},"3794":{}},"parent":{}}],["suppressoptions",{"_index":827,"name":{"906":{}},"parent":{}}],["svc_name",{"_index":666,"name":{"689":{}},"parent":{}}],["swaggerurl",{"_index":24,"name":{"16":{}},"parent":{}}],["symbol.tostringtag",{"_index":886,"name":{"969":{}},"parent":{}}],["symlinks",{"_index":3417,"name":{"4613":{}},"parent":{}}],["syntaxerrorheader",{"_index":1497,"name":{"1762":{}},"parent":{}}],["syntaxvalidator",{"_index":1707,"name":{"2013":{}},"parent":{}}],["syscall",{"_index":1045,"name":{"1179":{}},"parent":{}}],["sysname",{"_index":3656,"name":{"4933":{}},"parent":{}}],["sysplex",{"_index":2895,"name":{"3929":{}},"parent":{}}],["sysplexname",{"_index":4361,"name":{"6059":{}},"parent":{}}],["sysplexsystem",{"_index":3040,"name":{"4152":{}},"parent":{}}],["system",{"_index":2894,"name":{"3928":{},"3943":{},"4070":{},"4091":{},"4095":{},"4125":{},"5163":{},"5580":{},"5633":{},"5776":{},"5790":{},"5906":{}},"parent":{}}],["systemname",{"_index":4359,"name":{"6057":{}},"parent":{}}],["systemnickname",{"_index":4354,"name":{"6053":{}},"parent":{}}],["systems",{"_index":3001,"name":{"4110":{},"6013":{}},"parent":{}}],["tag",{"_index":2218,"name":{"2847":{},"3437":{},"4691":{}},"parent":{}}],["targetdataclass",{"_index":3581,"name":{"4828":{}},"parent":{}}],["targetmanagementclass",{"_index":3579,"name":{"4826":{}},"parent":{}}],["targetstorageclass",{"_index":3580,"name":{"4827":{}},"parent":{}}],["targetvolser",{"_index":3577,"name":{"4825":{}},"parent":{}}],["task",{"_index":982,"name":{"1104":{},"1174":{},"1289":{},"4446":{},"4458":{},"4587":{},"4663":{},"4732":{},"4793":{},"5047":{}},"parent":{}}],["taskfunction",{"_index":2492,"name":{"3240":{}},"parent":{}}],["taskname",{"_index":2500,"name":{"3247":{}},"parent":{}}],["taskprogress",{"_index":888,"name":{"971":{}},"parent":{}}],["taskresults",{"_index":2506,"name":{"3253":{}},"parent":{}}],["tasks",{"_index":2508,"name":{"3256":{}},"parent":{}}],["taskstage",{"_index":870,"name":{"955":{}},"parent":{}}],["team_config",{"_index":2181,"name":{"2805":{}},"parent":{}}],["template",{"_index":4204,"name":{"5721":{},"5882":{},"5987":{}},"parent":{}}],["templateid",{"_index":4290,"name":{"5920":{}},"parent":{}}],["templatename",{"_index":4297,"name":{"5927":{}},"parent":{}}],["templates_resources",{"_index":2812,"name":{"3836":{}},"parent":{}}],["templatesub",{"_index":4205,"name":{"5722":{},"5883":{},"5988":{}},"parent":{}}],["temppath",{"_index":4098,"name":{"5592":{}},"parent":{}}],["ten_percent",{"_index":891,"name":{"973":{}},"parent":{}}],["tenant",{"_index":2911,"name":{"3958":{},"3959":{},"4106":{}},"parent":{}}],["tenantid",{"_index":4295,"name":{"5925":{}},"parent":{}}],["text",{"_index":1837,"name":{"2189":{},"3807":{},"4692":{},"4703":{}},"parent":{}}],["text_plain",{"_index":135,"name":{"101":{},"1297":{}},"parent":{}}],["text_plain_utf8",{"_index":1113,"name":{"1299":{}},"parent":{}}],["textutils",{"_index":332,"name":{"332":{}},"parent":{}}],["then",{"_index":883,"name":{"966":{}},"parent":{}}],["thirty_percent",{"_index":893,"name":{"975":{}},"parent":{}}],["time",{"_index":2879,"name":{"3910":{},"3949":{},"3950":{},"3965":{},"3966":{},"5166":{}},"parent":{}}],["timeout",{"_index":3374,"name":{"4526":{},"5252":{},"5413":{},"5723":{},"5884":{},"5989":{}},"parent":{}}],["timestamp",{"_index":3827,"name":{"5167":{}},"parent":{}}],["timezone",{"_index":3829,"name":{"5169":{}},"parent":{}}],["title",{"_index":44,"name":{"33":{},"245":{},"561":{},"3329":{},"5310":{},"5539":{},"5674":{},"5885":{},"5990":{},"6155":{}},"parent":{}}],["to",{"_index":297,"name":{"302":{},"4798":{}},"parent":{}}],["to_seconds",{"_index":3103,"name":{"4218":{}},"parent":{}}],["tobeanarray",{"_index":362,"name":{"360":{}},"parent":{}}],["tobedefinedandnonblank",{"_index":367,"name":{"365":{}},"parent":{}}],["tobeequal",{"_index":357,"name":{"355":{}},"parent":{}}],["tobeoneof",{"_index":361,"name":{"359":{}},"parent":{}}],["toggletree",{"_index":2806,"name":{"3830":{}},"parent":{}}],["token_type_apiml",{"_index":1061,"name":{"1206":{}},"parent":{}}],["token_type_choices",{"_index":1063,"name":{"1208":{}},"parent":{}}],["token_type_jwt",{"_index":1060,"name":{"1205":{}},"parent":{}}],["token_type_ltpa",{"_index":1059,"name":{"1204":{}},"parent":{}}],["tokentype",{"_index":267,"name":{"269":{},"1218":{}},"parent":{}}],["tokenvalue",{"_index":269,"name":{"272":{},"1219":{}},"parent":{}}],["tomatchregexp",{"_index":358,"name":{"356":{}},"parent":{}}],["tonotbeequal",{"_index":365,"name":{"363":{}},"parent":{}}],["tonotbenullorundefined",{"_index":359,"name":{"357":{}},"parent":{}}],["topology",{"_index":4318,"name":{"6012":{}},"parent":{}}],["totalitems",{"_index":3832,"name":{"5172":{}},"parent":{}}],["totaloperations",{"_index":909,"name":{"992":{},"1067":{}},"parent":{}}],["trace",{"_index":409,"name":{"404":{},"433":{},"3424":{}},"parent":{}}],["transfermode",{"_index":3490,"name":{"4701":{}},"parent":{}}],["tree",{"_index":1461,"name":{"1728":{}},"parent":{}}],["treenodes",{"_index":1844,"name":{"2197":{},"3812":{}},"parent":{}}],["trimlinetoterminalwidth",{"_index":284,"name":{"290":{}},"parent":{}}],["tso",{"_index":3846,"name":{"5188":{},"5353":{},"5354":{},"5355":{}},"parent":{"5189":{},"5190":{},"5191":{},"5192":{},"5193":{},"5194":{},"5195":{},"5196":{},"5197":{},"5198":{},"5199":{},"5200":{},"5201":{},"5202":{},"5203":{},"5204":{},"5205":{},"5206":{},"5207":{},"5208":{},"5209":{},"5210":{},"5211":{},"5212":{},"5213":{},"5214":{},"5215":{},"5216":{},"5217":{},"5218":{},"5219":{},"5220":{},"5221":{},"5222":{},"5223":{},"5224":{},"5225":{},"5226":{},"5227":{},"5228":{},"5229":{},"5230":{},"5231":{},"5232":{},"5233":{},"5234":{},"5235":{},"5236":{},"5237":{},"5238":{},"5239":{},"5240":{},"5241":{},"5242":{},"5243":{},"5244":{},"5245":{},"5246":{},"5247":{},"5248":{},"5249":{},"5250":{},"5251":{},"5252":{},"5253":{},"5254":{},"5255":{},"5256":{},"5257":{},"5258":{},"5259":{},"5260":{},"5261":{},"5262":{},"5263":{},"5264":{},"5265":{},"5266":{},"5267":{},"5268":{},"5269":{},"5270":{},"5271":{},"5272":{},"5273":{},"5274":{},"5275":{},"5276":{},"5277":{},"5278":{},"5279":{},"5280":{},"5281":{},"5282":{},"5283":{},"5284":{},"5285":{},"5286":{},"5287":{},"5288":{},"5289":{},"5290":{},"5291":{},"5292":{},"5293":{},"5294":{},"5295":{},"5296":{},"5297":{},"5298":{},"5299":{},"5300":{},"5301":{},"5302":{},"5303":{},"5304":{},"5305":{},"5306":{},"5307":{},"5308":{},"5309":{},"5310":{},"5311":{},"5312":{},"5313":{},"5314":{},"5315":{},"5316":{},"5317":{},"5318":{},"5319":{},"5320":{},"5321":{},"5322":{},"5323":{},"5324":{},"5325":{},"5326":{},"5327":{},"5328":{},"5329":{},"5330":{},"5331":{},"5332":{},"5333":{},"5334":{},"5335":{},"5336":{},"5337":{},"5338":{},"5339":{},"5340":{},"5341":{},"5342":{},"5343":{},"5344":{},"5345":{},"5346":{},"5347":{},"5348":{},"5349":{},"5350":{},"5351":{},"5352":{},"5353":{},"5354":{},"5355":{},"5356":{},"5357":{},"5358":{},"5359":{},"5360":{},"5361":{},"5362":{},"5363":{},"5364":{},"5365":{},"5366":{},"5367":{},"5368":{},"5369":{},"5370":{},"5371":{},"5372":{},"5373":{},"5374":{},"5375":{},"5376":{},"5377":{},"5378":{},"5379":{},"5380":{},"5381":{},"5382":{},"5383":{},"5384":{},"5385":{},"5386":{},"5387":{},"5388":{},"5389":{},"5390":{},"5391":{},"5392":{},"5393":{},"5394":{},"5395":{},"5396":{},"5397":{},"5398":{},"5399":{},"5400":{},"5401":{},"5402":{},"5403":{},"5404":{},"5405":{},"5406":{},"5407":{},"5408":{},"5409":{},"5410":{},"5411":{},"5412":{},"5413":{},"5414":{},"5415":{},"5416":{},"5417":{},"5418":{},"5419":{},"5420":{},"5421":{},"5422":{},"5423":{},"5424":{},"5425":{},"5426":{},"5427":{},"5428":{},"5429":{},"5430":{},"5431":{},"5432":{},"5433":{},"5434":{},"5435":{},"5436":{},"5437":{}}}],["tso_message",{"_index":3874,"name":{"5216":{}},"parent":{}}],["tso_option_account",{"_index":3914,"name":{"5255":{}},"parent":{}}],["tso_option_account_profile",{"_index":3916,"name":{"5262":{}},"parent":{}}],["tso_option_char_set",{"_index":3918,"name":{"5264":{}},"parent":{}}],["tso_option_code_page",{"_index":3920,"name":{"5271":{}},"parent":{}}],["tso_option_columns",{"_index":3922,"name":{"5278":{}},"parent":{}}],["tso_option_group",{"_index":3912,"name":{"5254":{}},"parent":{}}],["tso_option_logon_procedure",{"_index":3924,"name":{"5285":{}},"parent":{}}],["tso_option_region_size",{"_index":3926,"name":{"5292":{}},"parent":{}}],["tso_option_rows",{"_index":3928,"name":{"5299":{}},"parent":{}}],["tso_profile_options",{"_index":3930,"name":{"5305":{}},"parent":{}}],["tso_prompt",{"_index":3873,"name":{"5215":{}},"parent":{}}],["tsoconstants",{"_index":3855,"name":{"5197":{}},"parent":{}}],["tsodata",{"_index":3997,"name":{"5416":{}},"parent":{}}],["tsoprofileconstants",{"_index":3911,"name":{"5253":{}},"parent":{}}],["tsoresponseservice",{"_index":3974,"name":{"5389":{}},"parent":{}}],["tsos",{"_index":3957,"name":{"5363":{}},"parent":{}}],["tsovalidator",{"_index":3999,"name":{"5418":{}},"parent":{}}],["twenty_percent",{"_index":892,"name":{"974":{}},"parent":{}}],["type",{"_index":123,"name":{"91":{},"93":{},"95":{},"97":{},"100":{},"102":{},"144":{},"150":{},"156":{},"162":{},"168":{},"175":{},"181":{},"186":{},"191":{},"242":{},"244":{},"249":{},"253":{},"256":{},"261":{},"266":{},"270":{},"273":{},"277":{},"280":{},"317":{},"320":{},"555":{},"563":{},"569":{},"573":{},"605":{},"785":{},"872":{},"890":{},"896":{},"911":{},"1216":{},"1296":{},"1298":{},"1300":{},"1302":{},"1939":{},"1945":{},"1953":{},"2058":{},"2062":{},"2434":{},"2636":{},"2643":{},"2650":{},"2663":{},"2670":{},"2677":{},"2684":{},"2691":{},"2699":{},"3169":{},"3181":{},"3189":{},"3321":{},"3331":{},"3456":{},"3461":{},"3470":{},"3478":{},"3485":{},"3492":{},"3500":{},"3509":{},"3517":{},"3527":{},"3536":{},"3544":{},"3667":{},"3680":{},"3692":{},"3704":{},"3716":{},"3903":{},"3927":{},"3941":{},"4017":{},"4500":{},"4610":{},"4863":{},"4910":{},"5056":{},"5164":{},"5259":{},"5268":{},"5275":{},"5282":{},"5289":{},"5296":{},"5302":{},"5307":{},"5309":{},"5314":{},"5318":{},"5321":{},"5325":{},"5328":{},"5332":{},"5335":{},"5455":{},"5463":{},"5470":{},"5478":{},"5484":{},"5490":{},"5496":{},"5536":{},"5538":{},"5543":{},"5546":{},"5550":{},"5554":{},"5558":{},"5561":{},"5565":{},"5745":{},"5814":{},"5894":{},"6024":{},"6076":{},"6084":{},"6091":{},"6099":{},"6107":{},"6114":{},"6119":{},"6128":{},"6133":{},"6152":{},"6154":{},"6159":{},"6162":{},"6166":{},"6170":{},"6174":{},"6177":{},"6180":{},"6183":{},"6186":{},"6189":{},"6194":{},"6196":{}},"parent":{}}],["typeconfigurations",{"_index":2452,"name":{"3171":{},"3317":{}},"parent":{}}],["typeonly",{"_index":1941,"name":{"2378":{},"3160":{}},"parent":{}}],["uid",{"_index":3339,"name":{"4471":{}},"parent":{}}],["unable_to_verify_leaf_signature",{"_index":4324,"name":{"6018":{}},"parent":{}}],["unabletocreateprofile",{"_index":1597,"name":{"1862":{}},"parent":{}}],["unabletodeleteprofile",{"_index":1607,"name":{"1872":{}},"parent":{}}],["unabletofindprofile",{"_index":1609,"name":{"1874":{}},"parent":{}}],["unabletoloadrequestedprofileserror",{"_index":1489,"name":{"1754":{}},"parent":{}}],["undo",{"_index":934,"name":{"1020":{},"1070":{}},"parent":{}}],["undocomplete",{"_index":944,"name":{"1030":{}},"parent":{}}],["undoopcomplete",{"_index":980,"name":{"1077":{}},"parent":{}}],["unexpected",{"_index":4054,"name":{"5511":{}},"parent":{}}],["unexpectedcommanderror",{"_index":1485,"name":{"1750":{}},"parent":{}}],["unexpectedcommandpreparationerror",{"_index":1487,"name":{"1752":{}},"parent":{}}],["unexpectedprofilecreationerror",{"_index":1621,"name":{"1886":{}},"parent":{}}],["unexpectedprofileloaderror",{"_index":1491,"name":{"1756":{}},"parent":{}}],["unexpectedprofilesloaderror",{"_index":1495,"name":{"1760":{}},"parent":{}}],["unexpectedprofileupdateerror",{"_index":1623,"name":{"1888":{}},"parent":{}}],["uninstall",{"_index":2639,"name":{"3566":{}},"parent":{}}],["uninstalldefinition",{"_index":2739,"name":{"3690":{}},"parent":{}}],["uninstallhandler",{"_index":2741,"name":{"3698":{}},"parent":{}}],["unit",{"_index":3349,"name":{"4482":{}},"parent":{}}],["unknown_prop_location",{"_index":2228,"name":{"2856":{}},"parent":{}}],["unknownpositionalerror",{"_index":1739,"name":{"2048":{}},"parent":{}}],["unmount",{"_index":3609,"name":{"4873":{}},"parent":{}}],["unsol",{"_index":2877,"name":{"3909":{}},"parent":{}}],["unsupporteddatasettype",{"_index":3136,"name":{"4251":{}},"parent":{}}],["unsupporteddatatype",{"_index":3141,"name":{"4255":{}},"parent":{}}],["unsupportedmaskingindatasetname",{"_index":3139,"name":{"4253":{}},"parent":{}}],["update",{"_index":1971,"name":{"2417":{},"3122":{},"3296":{},"3567":{},"3891":{}},"parent":{}}],["update_action",{"_index":517,"name":{"517":{}},"parent":{}}],["updateandgetremovedtypes",{"_index":2638,"name":{"3565":{}},"parent":{}}],["updatecurrentnode",{"_index":2798,"name":{"3822":{}},"parent":{}}],["updatedefault",{"_index":2458,"name":{"3182":{},"3190":{}},"parent":{}}],["updatedefinition",{"_index":2744,"name":{"3702":{}},"parent":{}}],["updatedpaths",{"_index":746,"name":{"801":{}},"parent":{}}],["updateextendersjson",{"_index":2633,"name":{"3561":{}},"parent":{}}],["updatehandler",{"_index":2746,"name":{"3711":{}},"parent":{}}],["updateimpconfig",{"_index":1363,"name":{"1619":{}},"parent":{}}],["updateinterval",{"_index":984,"name":{"1105":{}},"parent":{}}],["updateknownproperty",{"_index":2273,"name":{"2923":{}},"parent":{}}],["updateoptions",{"_index":747,"name":{"802":{}},"parent":{}}],["updateprofile",{"_index":1945,"name":{"2382":{},"3131":{},"3274":{}},"parent":{}}],["updateprofileactiondesc",{"_index":1559,"name":{"1824":{}},"parent":{}}],["updateprofilecommanddesc",{"_index":1563,"name":{"1828":{}},"parent":{}}],["updateprofilecommandsummary",{"_index":1561,"name":{"1826":{}},"parent":{}}],["updateprofileexamples",{"_index":277,"name":{"284":{},"2055":{},"5339":{},"6200":{}},"parent":{}}],["updateprofilefieldsfromcommandarguments",{"_index":1953,"name":{"2390":{}},"parent":{}}],["updateprofilefromargumentshandler",{"_index":1745,"name":{"2053":{}},"parent":{}}],["updateprofilefromcliargs",{"_index":1952,"name":{"2389":{}},"parent":{}}],["updateprofileshandler",{"_index":2769,"name":{"3770":{}},"parent":{}}],["updateprogressbar",{"_index":2707,"name":{"3639":{}},"parent":{}}],["updateproperty",{"_index":2272,"name":{"2922":{}},"parent":{}}],["updateschema",{"_index":1296,"name":{"1548":{}},"parent":{}}],["updateschemaatlayer",{"_index":2294,"name":{"2945":{}},"parent":{}}],["updateschemasdefinition",{"_index":2624,"name":{"3541":{}},"parent":{}}],["updateschemashandler",{"_index":2719,"name":{"3652":{}},"parent":{}}],["upload",{"_index":3555,"name":{"4801":{}},"parent":{}}],["uploaddirectorytodatasetmember",{"_index":3227,"name":{"4341":{}},"parent":{}}],["uploaddirectorytophysicalsequentialdataset",{"_index":3229,"name":{"4343":{}},"parent":{}}],["uploadfile",{"_index":3568,"name":{"4813":{}},"parent":{}}],["uploadtempfile",{"_index":4152,"name":{"5660":{}},"parent":{}}],["uri",{"_index":2899,"name":{"3940":{},"4056":{},"4059":{},"4068":{},"4130":{}},"parent":{}}],["uripath",{"_index":4206,"name":{"5724":{},"5886":{},"5991":{}},"parent":{}}],["uripathsub",{"_index":4207,"name":{"5725":{},"5887":{},"5992":{}},"parent":{}}],["url",{"_index":104,"name":{"81":{},"4128":{},"4914":{},"4915":{},"4970":{},"6063":{}},"parent":{}}],["urlparams",{"_index":2791,"name":{"3815":{}},"parent":{}}],["used",{"_index":3434,"name":{"4633":{}},"parent":{}}],["useoverridethatfails",{"_index":1452,"name":{"1720":{}},"parent":{}}],["user",{"_index":261,"name":{"255":{},"590":{},"622":{},"819":{},"1212":{},"1464":{},"2813":{},"2818":{},"3907":{},"3951":{},"3952":{},"3956":{},"3957":{},"4107":{},"4109":{},"4472":{},"4605":{},"5442":{},"5549":{},"6165":{}},"parent":{}}],["userconfigname",{"_index":782,"name":{"844":{}},"parent":{}}],["userdefined",{"_index":4281,"name":{"5888":{},"5993":{}},"parent":{}}],["userspecified",{"_index":1749,"name":{"2064":{}},"parent":{}}],["usev3errformat",{"_index":2363,"name":{"3036":{}},"parent":{}}],["usingteamconfig",{"_index":2283,"name":{"2934":{}},"parent":{}}],["uss",{"_index":3447,"name":{"4650":{},"5438":{}},"parent":{"5439":{},"5440":{},"5441":{},"5442":{},"5443":{},"5444":{},"5445":{},"5446":{},"5447":{},"5448":{},"5449":{},"5450":{},"5451":{},"5452":{},"5453":{},"5454":{},"5455":{},"5456":{},"5457":{},"5458":{},"5459":{},"5460":{},"5461":{},"5462":{},"5463":{},"5464":{},"5465":{},"5466":{},"5467":{},"5468":{},"5469":{},"5470":{},"5471":{},"5472":{},"5473":{},"5474":{},"5475":{},"5476":{},"5477":{},"5478":{},"5479":{},"5480":{},"5481":{},"5482":{},"5483":{},"5484":{},"5485":{},"5486":{},"5487":{},"5488":{},"5489":{},"5490":{},"5491":{},"5492":{},"5493":{},"5494":{},"5495":{},"5496":{},"5497":{},"5498":{},"5499":{},"5500":{},"5501":{},"5502":{},"5503":{},"5504":{},"5505":{},"5506":{},"5507":{},"5508":{},"5509":{},"5510":{},"5511":{},"5512":{},"5513":{},"5514":{},"5515":{},"5516":{},"5517":{},"5518":{},"5519":{},"5520":{},"5521":{},"5522":{},"5523":{},"5524":{},"5525":{},"5526":{},"5527":{},"5528":{},"5529":{},"5530":{},"5531":{},"5532":{},"5533":{},"5534":{},"5535":{},"5536":{},"5537":{},"5538":{},"5539":{},"5540":{},"5541":{},"5542":{},"5543":{},"5544":{},"5545":{},"5546":{},"5547":{},"5548":{},"5549":{},"5550":{},"5551":{},"5552":{},"5553":{},"5554":{},"5555":{},"5556":{},"5557":{},"5558":{},"5559":{},"5560":{},"5561":{},"5562":{},"5563":{},"5564":{},"5565":{},"5566":{},"5567":{},"5568":{}}}],["usscreatedsuccessfully",{"_index":3281,"name":{"4395":{}},"parent":{}}],["ussdir",{"_index":3530,"name":{"4758":{}},"parent":{}}],["ussdiruploadedsuccessfully",{"_index":3181,"name":{"4295":{}},"parent":{}}],["ussfile",{"_index":3529,"name":{"4757":{},"4767":{},"4856":{}},"parent":{}}],["ussfiledeletedsuccessfully",{"_index":3183,"name":{"4297":{}},"parent":{}}],["ussfiledownloadedsuccessfully",{"_index":3175,"name":{"4289":{}},"parent":{}}],["ussfiledownloadedwithdestination",{"_index":3177,"name":{"4291":{}},"parent":{}}],["ussfileuploadedsuccessfully",{"_index":3179,"name":{"4293":{}},"parent":{}}],["utf8",{"_index":376,"name":{"372":{}},"parent":{}}],["utilities",{"_index":3483,"name":{"4695":{}},"parent":{}}],["v1_token_expired",{"_index":177,"name":{"132":{}},"parent":{}}],["v2_token_expired",{"_index":179,"name":{"133":{}},"parent":{}}],["v2_token_invalid",{"_index":180,"name":{"134":{}},"parent":{}}],["v2_token_missing",{"_index":181,"name":{"135":{}},"parent":{}}],["valid",{"_index":1473,"name":{"1739":{}},"parent":{}}],["validate",{"_index":1310,"name":{"1565":{},"2022":{},"2254":{},"2414":{},"3119":{},"3261":{},"3293":{},"3337":{}},"parent":{}}],["validate_action",{"_index":516,"name":{"516":{}},"parent":{}}],["validatearrayduplicate",{"_index":1725,"name":{"2034":{}},"parent":{}}],["validateboolean",{"_index":1734,"name":{"2043":{}},"parent":{}}],["validatecollectcommonparms",{"_index":3095,"name":{"4209":{}},"parent":{}}],["validatecollectparm",{"_index":3093,"name":{"4207":{}},"parent":{}}],["validatecollectparms",{"_index":3096,"name":{"4210":{}},"parent":{}}],["validatecommonparms",{"_index":3089,"name":{"4204":{}},"parent":{}}],["validateconfigurationdocument",{"_index":2438,"name":{"3150":{}},"parent":{}}],["validateconsolename",{"_index":3097,"name":{"4212":{}},"parent":{}}],["validatedefinition",{"_index":2748,"name":{"3714":{}},"parent":{}}],["validatedefinitiontree",{"_index":2002,"name":{"2452":{}},"parent":{}}],["validateerrormessagefromzosmf",{"_index":4007,"name":{"5428":{}},"parent":{}}],["validatehandler",{"_index":2750,"name":{"3723":{}},"parent":{}}],["validateissueparams",{"_index":4002,"name":{"5421":{}},"parent":{}}],["validateissueparm",{"_index":3094,"name":{"4208":{}},"parent":{}}],["validateissueparms",{"_index":3091,"name":{"4205":{}},"parent":{}}],["validateissuesimpleparms",{"_index":3092,"name":{"4206":{}},"parent":{}}],["validatelevel",{"_index":421,"name":{"415":{}},"parent":{}}],["validatemetaprofile",{"_index":2439,"name":{"3151":{}},"parent":{}}],["validatenotemptystring",{"_index":2833,"name":{"3856":{},"5426":{},"5616":{}},"parent":{}}],["validatenumeric",{"_index":1735,"name":{"2044":{}},"parent":{}}],["validateoptionvaluelength",{"_index":1724,"name":{"2033":{}},"parent":{}}],["validateoptionvaluerange",{"_index":1723,"name":{"2032":{}},"parent":{}}],["validateowner",{"_index":4122,"name":{"5618":{}},"parent":{}}],["validateparameter",{"_index":4121,"name":{"5617":{}},"parent":{}}],["validatepeerdepversions",{"_index":1453,"name":{"1721":{}},"parent":{}}],["validatepingparms",{"_index":4005,"name":{"5424":{}},"parent":{}}],["validatepingzosmfresponse",{"_index":4006,"name":{"5427":{}},"parent":{}}],["validateplugin",{"_index":1454,"name":{"1722":{}},"parent":{}}],["validateplugincmddefs",{"_index":1455,"name":{"1723":{}},"parent":{}}],["validatepluginprofiles",{"_index":1456,"name":{"1724":{}},"parent":{}}],["validateprofile",{"_index":1948,"name":{"2385":{},"3130":{},"3273":{}},"parent":{}}],["validateprofileagainstschema",{"_index":1977,"name":{"2423":{},"3135":{},"3302":{}},"parent":{}}],["validateprofilecommanddesc",{"_index":1553,"name":{"1818":{}},"parent":{}}],["validateprofilecommandsummary",{"_index":1549,"name":{"1814":{}},"parent":{}}],["validateprofilegroupdesc",{"_index":1551,"name":{"1816":{}},"parent":{}}],["validateprofilehandler",{"_index":2771,"name":{"3772":{}},"parent":{}}],["validateprofilenamedesc",{"_index":1519,"name":{"1784":{}},"parent":{}}],["validateprofileobject",{"_index":1976,"name":{"2422":{},"3134":{},"3301":{}},"parent":{}}],["validateprofileoptiondesc",{"_index":1555,"name":{"1820":{}},"parent":{}}],["validaterequireddependenciesarespecified",{"_index":1982,"name":{"2429":{},"3141":{},"3308":{}},"parent":{}}],["validateschema",{"_index":2437,"name":{"3149":{}},"parent":{}}],["validatesession",{"_index":2830,"name":{"3854":{},"4211":{},"5180":{},"5419":{},"5614":{}},"parent":{}}],["validatestartparams",{"_index":4001,"name":{"5420":{}},"parent":{}}],["validatestartzosmfresponse",{"_index":4004,"name":{"5423":{}},"parent":{}}],["validatestopparams",{"_index":4003,"name":{"5422":{}},"parent":{}}],["validatestring",{"_index":2832,"name":{"3855":{},"5425":{},"5615":{}},"parent":{}}],["validatesyntax",{"_index":1715,"name":{"2023":{}},"parent":{}}],["validation_outcome",{"_index":2494,"name":{"3242":{}},"parent":{}}],["validationplanmodule",{"_index":566,"name":{"576":{},"2060":{}},"parent":{}}],["validationtype",{"_index":4220,"name":{"5746":{}},"parent":{}}],["value",{"_index":298,"name":{"303":{},"464":{},"900":{},"2875":{},"2881":{},"2885":{},"3889":{},"4012":{},"4102":{},"5629":{},"5895":{}},"parent":{}}],["valueimplications",{"_index":813,"name":{"885":{}},"parent":{}}],["valueoutofbounds",{"_index":3219,"name":{"4333":{}},"parent":{}}],["valuerequiresadditionaloption",{"_index":1733,"name":{"2042":{}},"parent":{}}],["values",{"_index":247,"name":{"240":{},"863":{},"1955":{},"6123":{}},"parent":{}}],["variable",{"_index":2882,"name":{"3912":{},"5726":{},"5889":{},"5994":{}},"parent":{}}],["variableinputfile",{"_index":4137,"name":{"5635":{}},"parent":{}}],["variables",{"_index":2886,"name":{"3914":{},"3915":{},"3916":{},"3918":{},"3919":{},"3920":{},"3967":{},"3974":{},"3987":{},"3992":{},"4042":{},"4044":{},"4048":{},"4104":{},"5590":{},"5636":{},"5763":{},"5929":{}},"parent":{}}],["variables_resource",{"_index":2814,"name":{"3838":{}},"parent":{}}],["vault",{"_index":621,"name":{"631":{}},"parent":{}}],["vendor",{"_index":2896,"name":{"3930":{},"4081":{},"4089":{},"5582":{},"5646":{},"5652":{},"5754":{},"5775":{},"5792":{},"5904":{}},"parent":{}}],["ver",{"_index":3908,"name":{"5249":{},"5411":{}},"parent":{}}],["verifychalkcolor",{"_index":1312,"name":{"1566":{}},"parent":{}}],["version",{"_index":112,"name":{"85":{},"87":{},"566":{},"784":{},"1534":{},"1652":{},"2215":{},"3332":{},"3861":{},"3931":{},"4034":{},"4923":{},"4926":{},"5350":{},"5357":{},"5360":{}},"parent":{}}],["viewallspoolcontent",{"_index":3729,"name":{"5041":{}},"parent":{}}],["visibility",{"_index":2862,"name":{"3890":{},"5747":{},"5896":{}},"parent":{}}],["vol",{"_index":3435,"name":{"4634":{}},"parent":{}}],["volser",{"_index":3347,"name":{"4481":{}},"parent":{}}],["volume",{"_index":3333,"name":{"4445":{},"4595":{},"4662":{},"4731":{},"4792":{},"4842":{},"5046":{}},"parent":{}}],["volumes",{"_index":3366,"name":{"4508":{},"4525":{}},"parent":{}}],["vsam",{"_index":3390,"name":{"4571":{},"4649":{},"4855":{}},"parent":{}}],["vsam_alcunit_choices",{"_index":3134,"name":{"4249":{}},"parent":{}}],["vsam_dsorg_choices",{"_index":3133,"name":{"4248":{}},"parent":{}}],["vsamconverttoidcamsoptions",{"_index":3449,"name":{"4652":{}},"parent":{}}],["vsamformidcamscreatecmd",{"_index":3450,"name":{"4653":{}},"parent":{}}],["vsamvalidateoptions",{"_index":3451,"name":{"4654":{}},"parent":{}}],["wait",{"_index":3456,"name":{"4666":{},"4672":{}},"parent":{}}],["waitforactive",{"_index":3730,"name":{"5042":{}},"parent":{}}],["waitforjoboutputstatus",{"_index":3766,"name":{"5100":{}},"parent":{}}],["waitforoutput",{"_index":3731,"name":{"5043":{}},"parent":{}}],["waitforoutputstatus",{"_index":3767,"name":{"5101":{}},"parent":{}}],["waitforstatuscommon",{"_index":3768,"name":{"5102":{}},"parent":{}}],["waittocollect",{"_index":3029,"name":{"4138":{}},"parent":{}}],["warn",{"_index":412,"name":{"407":{},"435":{},"3427":{}},"parent":{}}],["warning",{"_index":1404,"name":{"1658":{}},"parent":{}}],["wasinitcalled",{"_index":1439,"name":{"1707":{}},"parent":{}}],["watchdelay",{"_index":3706,"name":{"5005":{},"5012":{},"5023":{},"5031":{}},"parent":{}}],["web_diff_dir",{"_index":527,"name":{"527":{}},"parent":{}}],["web_help_dir",{"_index":526,"name":{"526":{}},"parent":{}}],["webdiffdir",{"_index":2397,"name":{"3067":{}},"parent":{}}],["webdiffmanager",{"_index":2395,"name":{"3063":{}},"parent":{}}],["webhelp",{"_index":1880,"name":{"2253":{}},"parent":{}}],["webhelpcustomcsspath",{"_index":2341,"name":{"3003":{}},"parent":{}}],["webhelpdir",{"_index":1861,"name":{"2223":{}},"parent":{}}],["webhelpgenerator",{"_index":1838,"name":{"2191":{}},"parent":{}}],["webhelplogoimgpath",{"_index":2340,"name":{"3002":{}},"parent":{}}],["webhelpmanager",{"_index":1859,"name":{"2216":{}},"parent":{}}],["weight",{"_index":4209,"name":{"5727":{},"5890":{},"5995":{}},"parent":{}}],["wf_name",{"_index":4094,"name":{"5586":{}},"parent":{}}],["win32_cred_max_string_length",{"_index":671,"name":{"693":{}},"parent":{}}],["wordwrap",{"_index":342,"name":{"341":{}},"parent":{}}],["workflow",{"_index":2880,"name":{"3911":{},"3912":{},"3913":{},"3946":{},"3947":{},"3965":{},"3966":{},"4093":{},"4099":{}},"parent":{}}],["workflow_definition",{"_index":4085,"name":{"5572":{}},"parent":{}}],["workflow_resource",{"_index":4086,"name":{"5573":{}},"parent":{}}],["workflowconstants",{"_index":4083,"name":{"5570":{}},"parent":{}}],["workflowdefaultname",{"_index":4222,"name":{"5749":{}},"parent":{}}],["workflowdefinitionfile",{"_index":4136,"name":{"5632":{}},"parent":{}}],["workflowdefinitionfilemd5value",{"_index":4224,"name":{"5753":{},"5903":{}},"parent":{}}],["workflowdescription",{"_index":2988,"name":{"4078":{},"4086":{},"5643":{},"5649":{},"5750":{},"5773":{},"5900":{}},"parent":{}}],["workflowid",{"_index":2989,"name":{"4079":{},"4087":{},"5644":{},"5650":{},"5751":{},"5774":{},"5901":{}},"parent":{}}],["workflowkey",{"_index":2986,"name":{"4077":{},"4085":{},"5584":{},"5620":{},"5642":{},"5648":{},"5770":{},"5899":{}},"parent":{}}],["workflowname",{"_index":4093,"name":{"5585":{},"5631":{},"5771":{},"5788":{},"5898":{}},"parent":{}}],["workflows",{"_index":4082,"name":{"5569":{},"5785":{},"6007":{}},"parent":{"5570":{},"5571":{},"5572":{},"5573":{},"5574":{},"5575":{},"5576":{},"5577":{},"5578":{},"5579":{},"5580":{},"5581":{},"5582":{},"5583":{},"5584":{},"5585":{},"5586":{},"5587":{},"5588":{},"5589":{},"5590":{},"5591":{},"5592":{},"5593":{},"5594":{},"5595":{},"5596":{},"5597":{},"5598":{},"5599":{},"5600":{},"5601":{},"5602":{},"5603":{},"5604":{},"5605":{},"5606":{},"5607":{},"5608":{},"5609":{},"5610":{},"5611":{},"5612":{},"5613":{},"5614":{},"5615":{},"5616":{},"5617":{},"5618":{},"5619":{},"5620":{},"5621":{},"5622":{},"5623":{},"5624":{},"5625":{},"5626":{},"5627":{},"5628":{},"5629":{},"5630":{},"5631":{},"5632":{},"5633":{},"5634":{},"5635":{},"5636":{},"5637":{},"5638":{},"5639":{},"5640":{},"5641":{},"5642":{},"5643":{},"5644":{},"5645":{},"5646":{},"5647":{},"5648":{},"5649":{},"5650":{},"5651":{},"5652":{},"5653":{},"5654":{},"5655":{},"5656":{},"5657":{},"5658":{},"5659":{},"5660":{},"5661":{},"5662":{},"5663":{},"5664":{},"5665":{},"5666":{},"5667":{},"5668":{},"5669":{},"5670":{},"5671":{},"5672":{},"5673":{},"5674":{},"5675":{},"5676":{},"5677":{},"5678":{},"5679":{},"5680":{},"5681":{},"5682":{},"5683":{},"5684":{},"5685":{},"5686":{},"5687":{},"5688":{},"5689":{},"5690":{},"5691":{},"5692":{},"5693":{},"5694":{},"5695":{},"5696":{},"5697":{},"5698":{},"5699":{},"5700":{},"5701":{},"5702":{},"5703":{},"5704":{},"5705":{},"5706":{},"5707":{},"5708":{},"5709":{},"5710":{},"5711":{},"5712":{},"5713":{},"5714":{},"5715":{},"5716":{},"5717":{},"5718":{},"5719":{},"5720":{},"5721":{},"5722":{},"5723":{},"5724":{},"5725":{},"5726":{},"5727":{},"5728":{},"5729":{},"5730":{},"5731":{},"5732":{},"5733":{},"5734":{},"5735":{},"5736":{},"5737":{},"5738":{},"5739":{},"5740":{},"5741":{},"5742":{},"5743":{},"5744":{},"5745":{},"5746":{},"5747":{},"5748":{},"5749":{},"5750":{},"5751":{},"5752":{},"5753":{},"5754":{},"5755":{},"5756":{},"5757":{},"5758":{},"5759":{},"5760":{},"5761":{},"5762":{},"5763":{},"5764":{},"5765":{},"5766":{},"5767":{},"5768":{},"5769":{},"5770":{},"5771":{},"5772":{},"5773":{},"5774":{},"5775":{},"5776":{},"5777":{},"5778":{},"5779":{},"5780":{},"5781":{},"5782":{},"5783":{},"5784":{},"5785":{},"5786":{},"5787":{},"5788":{},"5789":{},"5790":{},"5791":{},"5792":{},"5793":{},"5794":{},"5795":{},"5796":{},"5797":{},"5798":{},"5799":{},"5800":{},"5801":{},"5802":{},"5803":{},"5804":{},"5805":{},"5806":{},"5807":{},"5808":{},"5809":{},"5810":{},"5811":{},"5812":{},"5813":{},"5814":{},"5815":{},"5816":{},"5817":{},"5818":{},"5819":{},"5820":{},"5821":{},"5822":{},"5823":{},"5824":{},"5825":{},"5826":{},"5827":{},"5828":{},"5829":{},"5830":{},"5831":{},"5832":{},"5833":{},"5834":{},"5835":{},"5836":{},"5837":{},"5838":{},"5839":{},"5840":{},"5841":{},"5842":{},"5843":{},"5844":{},"5845":{},"5846":{},"5847":{},"5848":{},"5849":{},"5850":{},"5851":{},"5852":{},"5853":{},"5854":{},"5855":{},"5856":{},"5857":{},"5858":{},"5859":{},"5860":{},"5861":{},"5862":{},"5863":{},"5864":{},"5865":{},"5866":{},"5867":{},"5868":{},"5869":{},"5870":{},"5871":{},"5872":{},"5873":{},"5874":{},"5875":{},"5876":{},"5877":{},"5878":{},"5879":{},"5880":{},"5881":{},"5882":{},"5883":{},"5884":{},"5885":{},"5886":{},"5887":{},"5888":{},"5889":{},"5890":{},"5891":{},"5892":{},"5893":{},"5894":{},"5895":{},"5896":{},"5897":{},"5898":{},"5899":{},"5900":{},"5901":{},"5902":{},"5903":{},"5904":{},"5905":{},"5906":{},"5907":{},"5908":{},"5909":{},"5910":{},"5911":{},"5912":{},"5913":{},"5914":{},"5915":{},"5916":{},"5917":{},"5918":{},"5919":{},"5920":{},"5921":{},"5922":{},"5923":{},"5924":{},"5925":{},"5926":{},"5927":{},"5928":{},"5929":{},"5930":{},"5931":{},"5932":{},"5933":{},"5934":{},"5935":{},"5936":{},"5937":{},"5938":{},"5939":{},"5940":{},"5941":{},"5942":{},"5943":{},"5944":{},"5945":{},"5946":{},"5947":{},"5948":{},"5949":{},"5950":{},"5951":{},"5952":{},"5953":{},"5954":{},"5955":{},"5956":{},"5957":{},"5958":{},"5959":{},"5960":{},"5961":{},"5962":{},"5963":{},"5964":{},"5965":{},"5966":{},"5967":{},"5968":{},"5969":{},"5970":{},"5971":{},"5972":{},"5973":{},"5974":{},"5975":{},"5976":{},"5977":{},"5978":{},"5979":{},"5980":{},"5981":{},"5982":{},"5983":{},"5984":{},"5985":{},"5986":{},"5987":{},"5988":{},"5989":{},"5990":{},"5991":{},"5992":{},"5993":{},"5994":{},"5995":{},"5996":{},"5997":{},"5998":{},"5999":{},"6000":{},"6001":{},"6002":{},"6003":{},"6004":{},"6005":{},"6006":{},"6007":{}}}],["workflowvalidator",{"_index":4119,"name":{"5613":{}},"parent":{}}],["workflowversion",{"_index":2990,"name":{"4080":{},"4088":{},"5645":{},"5651":{},"5752":{},"5772":{},"5902":{}},"parent":{}}],["write",{"_index":632,"name":{"642":{},"1672":{},"1678":{},"2005":{}},"parent":{}}],["writeandbufferstderr",{"_index":1700,"name":{"2003":{}},"parent":{}}],["writeandbufferstdout",{"_index":1698,"name":{"2000":{}},"parent":{}}],["writedata",{"_index":1036,"name":{"1169":{},"1284":{},"4453":{}},"parent":{}}],["writeextendersjson",{"_index":2292,"name":{"2943":{}},"parent":{}}],["writefile",{"_index":396,"name":{"392":{}},"parent":{}}],["writefileasync",{"_index":395,"name":{"391":{}},"parent":{}}],["writeinmemorymessages",{"_index":2586,"name":{"3416":{}},"parent":{}}],["writejsonresponse",{"_index":1652,"name":{"1923":{},"1993":{}},"parent":{}}],["writemetafile",{"_index":2413,"name":{"3082":{}},"parent":{}}],["writeobject",{"_index":397,"name":{"393":{}},"parent":{}}],["writepackagemetadata",{"_index":1865,"name":{"2227":{}},"parent":{}}],["writeprofile",{"_index":2412,"name":{"3079":{}},"parent":{}}],["writestderr",{"_index":438,"name":{"438":{},"2004":{}},"parent":{}}],["writestdout",{"_index":439,"name":{"439":{},"2001":{}},"parent":{}}],["writestream",{"_index":1699,"name":{"2002":{}},"parent":{}}],["writetreedata",{"_index":1856,"name":{"2212":{}},"parent":{}}],["wrongowner",{"_index":4117,"name":{"5611":{}},"parent":{}}],["wrongstring",{"_index":4113,"name":{"5607":{}},"parent":{}}],["wrongworkflowkey",{"_index":4101,"name":{"5595":{}},"parent":{}}],["x",{"_index":86,"name":{"71":{},"73":{},"75":{},"77":{},"79":{},"81":{},"83":{},"85":{},"87":{},"89":{},"91":{},"93":{},"95":{},"97":{},"104":{},"106":{},"108":{},"110":{},"117":{}},"parent":{}}],["x_csrf_zosmf_header",{"_index":116,"name":{"88":{}},"parent":{}}],["x_ibm_attributes_base",{"_index":106,"name":{"82":{}},"parent":{}}],["x_ibm_binary",{"_index":121,"name":{"90":{}},"parent":{}}],["x_ibm_binary_by_record",{"_index":127,"name":{"94":{}},"parent":{}}],["x_ibm_intrdr_class_a",{"_index":85,"name":{"70":{}},"parent":{}}],["x_ibm_intrdr_lrecl",{"_index":81,"name":{"67":{}},"parent":{}}],["x_ibm_intrdr_lrecl_256",{"_index":97,"name":{"76":{}},"parent":{}}],["x_ibm_intrdr_lrecl_80",{"_index":94,"name":{"74":{}},"parent":{}}],["x_ibm_intrdr_mode_text",{"_index":99,"name":{"78":{}},"parent":{}}],["x_ibm_intrdr_recfm",{"_index":83,"name":{"68":{}},"parent":{}}],["x_ibm_intrdr_recfm_f",{"_index":91,"name":{"72":{}},"parent":{}}],["x_ibm_jcl_symbol_partial",{"_index":84,"name":{"69":{}},"parent":{}}],["x_ibm_job_modify_version_1",{"_index":109,"name":{"84":{}},"parent":{}}],["x_ibm_job_modify_version_2",{"_index":114,"name":{"86":{}},"parent":{}}],["x_ibm_max_items",{"_index":137,"name":{"103":{}},"parent":{}}],["x_ibm_migrated_recall_error",{"_index":147,"name":{"109":{}},"parent":{}}],["x_ibm_migrated_recall_no_wait",{"_index":145,"name":{"107":{}},"parent":{}}],["x_ibm_migrated_recall_wait",{"_index":141,"name":{"105":{}},"parent":{}}],["x_ibm_notification_url",{"_index":102,"name":{"80":{}},"parent":{}}],["x_ibm_record",{"_index":125,"name":{"92":{}},"parent":{}}],["x_ibm_record_range",{"_index":152,"name":{"114":{}},"parent":{}}],["x_ibm_response_timeout",{"_index":151,"name":{"113":{}},"parent":{}}],["x_ibm_return_etag",{"_index":154,"name":{"116":{}},"parent":{}}],["x_ibm_text",{"_index":129,"name":{"96":{}},"parent":{}}],["x_ibm_text_encoding",{"_index":131,"name":{"98":{}},"parent":{}}],["yargs",{"_index":1905,"name":{"2290":{},"2312":{},"2357":{},"2465":{}},"parent":{}}],["yargscommandcompleted",{"_index":1930,"name":{"2366":{}},"parent":{}}],["yargsconfigurer",{"_index":2011,"name":{"2462":{}},"parent":{}}],["yargsdefiner",{"_index":2019,"name":{"2479":{}},"parent":{}}],["yargsinstance",{"_index":1919,"name":{"2323":{}},"parent":{}}],["yargsparent",{"_index":1923,"name":{"2332":{}},"parent":{}}],["yargsparms",{"_index":1902,"name":{"2281":{},"2303":{},"2348":{}},"parent":{}}],["zero_percent",{"_index":889,"name":{"972":{}},"parent":{}}],["zfs",{"_index":3448,"name":{"4651":{},"4857":{}},"parent":{}}],["zfscreatedsuccessfully",{"_index":3263,"name":{"4377":{}},"parent":{}}],["zfsdeletedsuccessfully",{"_index":3265,"name":{"4379":{}},"parent":{}}],["zfsvalidateoptions",{"_index":3452,"name":{"4655":{}},"parent":{}}],["zlibtransform",{"_index":1144,"name":{"1338":{}},"parent":{}}],["zos_version",{"_index":4344,"name":{"6041":{}},"parent":{}}],["zosfilesattributes",{"_index":3492,"name":{"4704":{}},"parent":{}}],["zosfilesconstants",{"_index":3107,"name":{"4222":{}},"parent":{}}],["zosfilesmessages",{"_index":3135,"name":{"4250":{}},"parent":{}}],["zosfilesoptions",{"_index":4325,"name":{"6019":{}},"parent":{}}],["zosfilesutils",{"_index":3465,"name":{"4676":{}},"parent":{}}],["zosjobsmessages",{"_index":3754,"name":{"5089":{}},"parent":{}}],["zoslogconstants",{"_index":3839,"name":{"5181":{}},"parent":{}}],["zosmf",{"_index":118,"name":{"89":{}},"parent":{}}],["zosmf_connection_option_group",{"_index":4372,"name":{"6071":{}},"parent":{}}],["zosmf_connection_options",{"_index":4396,"name":{"6135":{}},"parent":{}}],["zosmf_full_version",{"_index":4349,"name":{"6046":{}},"parent":{}}],["zosmf_hostname",{"_index":4347,"name":{"6044":{}},"parent":{}}],["zosmf_option_base_path",{"_index":4387,"name":{"6110":{}},"parent":{}}],["zosmf_option_cert_file",{"_index":4392,"name":{"6125":{}},"parent":{}}],["zosmf_option_cert_key_file",{"_index":4394,"name":{"6130":{}},"parent":{}}],["zosmf_option_host",{"_index":4374,"name":{"6072":{}},"parent":{}}],["zosmf_option_host_profile",{"_index":4376,"name":{"6079":{}},"parent":{}}],["zosmf_option_password",{"_index":4382,"name":{"6095":{}},"parent":{}}],["zosmf_option_password_profile",{"_index":4384,"name":{"6102":{}},"parent":{}}],["zosmf_option_port",{"_index":4377,"name":{"6080":{}},"parent":{}}],["zosmf_option_protocol",{"_index":4389,"name":{"6116":{}},"parent":{}}],["zosmf_option_reject_unauthorized",{"_index":4385,"name":{"6103":{}},"parent":{}}],["zosmf_option_user",{"_index":4379,"name":{"6087":{}},"parent":{}}],["zosmf_option_user_profile",{"_index":4381,"name":{"6094":{}},"parent":{}}],["zosmf_port",{"_index":4346,"name":{"6042":{}},"parent":{}}],["zosmf_saf_realm",{"_index":4348,"name":{"6045":{}},"parent":{}}],["zosmf_version",{"_index":2818,"name":{"3842":{},"5587":{},"6043":{}},"parent":{}}],["zosmfbasehandler",{"_index":4397,"name":{"6138":{}},"parent":{}}],["zosmfconstants",{"_index":4316,"name":{"6009":{}},"parent":{}}],["zosmfheaders",{"_index":80,"name":{"66":{}},"parent":{}}],["zosmfmessages",{"_index":4328,"name":{"6027":{}},"parent":{}}],["zosmfmigratedrecalloptions",{"_index":3345,"name":{"4479":{}},"parent":{}}],["zosmfpingresponse",{"_index":3971,"name":{"5381":{}},"parent":{}}],["zosmfprofile",{"_index":4401,"name":{"6151":{}},"parent":{}}],["zosmfresponse",{"_index":3033,"name":{"4144":{},"5345":{},"5377":{}},"parent":{}}],["zosmfrestclient",{"_index":162,"name":{"120":{}},"parent":{}}],["zosmfsession",{"_index":4371,"name":{"6070":{}},"parent":{}}],["zosmftsoresponse",{"_index":3962,"name":{"5367":{},"5386":{}},"parent":{}}],["zosmfversion",{"_index":4246,"name":{"5787":{}},"parent":{}}],["zostsobasehandler",{"_index":3990,"name":{"5405":{}},"parent":{}}],["zostsoprofile",{"_index":3931,"name":{"5306":{}},"parent":{}}],["zosussmessages",{"_index":4047,"name":{"5504":{}},"parent":{}}],["zosussprofile",{"_index":4071,"name":{"5535":{}},"parent":{}}],["zosvr",{"_index":4358,"name":{"6056":{}},"parent":{}}],["zowe",{"_index":2,"name":{"0":{},"3832":{},"4118":{},"4221":{},"4875":{},"5155":{},"5188":{},"5438":{},"5569":{},"6008":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"127":{},"128":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"177":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{},"202":{},"203":{},"204":{},"205":{},"206":{},"207":{},"208":{},"209":{},"210":{},"211":{},"212":{},"213":{},"214":{},"215":{},"216":{},"217":{},"218":{},"219":{},"220":{},"221":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"228":{},"229":{},"230":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{},"250":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{},"259":{},"260":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"279":{},"280":{},"281":{},"282":{},"283":{},"284":{},"285":{},"286":{},"287":{},"288":{},"289":{},"290":{},"291":{},"292":{},"293":{},"294":{},"295":{},"296":{},"3833":{},"3834":{},"3835":{},"3836":{},"3837":{},"3838":{},"3839":{},"3840":{},"3841":{},"3842":{},"3843":{},"3844":{},"3845":{},"3846":{},"3847":{},"3848":{},"3849":{},"3850":{},"3851":{},"3852":{},"3853":{},"3854":{},"3855":{},"3856":{},"3857":{},"3858":{},"3859":{},"3860":{},"3861":{},"3862":{},"3863":{},"3864":{},"3865":{},"3866":{},"3867":{},"3868":{},"3869":{},"3870":{},"3871":{},"3872":{},"3873":{},"3874":{},"3875":{},"3876":{},"3877":{},"3878":{},"3879":{},"3880":{},"3881":{},"3882":{},"3883":{},"3884":{},"3885":{},"3886":{},"3887":{},"3888":{},"3889":{},"3890":{},"3891":{},"3892":{},"3893":{},"3894":{},"3895":{},"3896":{},"3897":{},"3898":{},"3899":{},"3900":{},"3901":{},"3902":{},"3903":{},"3904":{},"3905":{},"3906":{},"3907":{},"3908":{},"3909":{},"3910":{},"3911":{},"3912":{},"3913":{},"3914":{},"3915":{},"3916":{},"3917":{},"3918":{},"3919":{},"3920":{},"3921":{},"3922":{},"3923":{},"3924":{},"3925":{},"3926":{},"3927":{},"3928":{},"3929":{},"3930":{},"3931":{},"3932":{},"3933":{},"3934":{},"3935":{},"3936":{},"3937":{},"3938":{},"3939":{},"3940":{},"3941":{},"3942":{},"3943":{},"3944":{},"3945":{},"3946":{},"3947":{},"3948":{},"3949":{},"3950":{},"3951":{},"3952":{},"3953":{},"3954":{},"3955":{},"3956":{},"3957":{},"3958":{},"3959":{},"3960":{},"3961":{},"3962":{},"3963":{},"3964":{},"3965":{},"3966":{},"3967":{},"3968":{},"3969":{},"3970":{},"3971":{},"3972":{},"3973":{},"3974":{},"3975":{},"3976":{},"3977":{},"3978":{},"3979":{},"3980":{},"3981":{},"3982":{},"3983":{},"3984":{},"3985":{},"3986":{},"3987":{},"3988":{},"3989":{},"3990":{},"3991":{},"3992":{},"3993":{},"3994":{},"3995":{},"3996":{},"3997":{},"3998":{},"3999":{},"4000":{},"4001":{},"4002":{},"4003":{},"4004":{},"4005":{},"4006":{},"4007":{},"4008":{},"4009":{},"4010":{},"4011":{},"4012":{},"4013":{},"4014":{},"4015":{},"4016":{},"4017":{},"4018":{},"4019":{},"4020":{},"4021":{},"4022":{},"4023":{},"4024":{},"4025":{},"4026":{},"4027":{},"4028":{},"4029":{},"4030":{},"4031":{},"4032":{},"4033":{},"4034":{},"4035":{},"4036":{},"4037":{},"4038":{},"4039":{},"4040":{},"4041":{},"4042":{},"4043":{},"4044":{},"4045":{},"4046":{},"4047":{},"4048":{},"4049":{},"4050":{},"4051":{},"4052":{},"4053":{},"4054":{},"4055":{},"4056":{},"4057":{},"4058":{},"4059":{},"4060":{},"4061":{},"4062":{},"4063":{},"4064":{},"4065":{},"4066":{},"4067":{},"4068":{},"4069":{},"4070":{},"4071":{},"4072":{},"4073":{},"4074":{},"4075":{},"4076":{},"4077":{},"4078":{},"4079":{},"4080":{},"4081":{},"4082":{},"4083":{},"4084":{},"4085":{},"4086":{},"4087":{},"4088":{},"4089":{},"4090":{},"4091":{},"4092":{},"4093":{},"4094":{},"4095":{},"4096":{},"4097":{},"4098":{},"4099":{},"4100":{},"4101":{},"4102":{},"4103":{},"4104":{},"4105":{},"4106":{},"4107":{},"4108":{},"4109":{},"4110":{},"4111":{},"4112":{},"4113":{},"4114":{},"4115":{},"4116":{},"4117":{},"4119":{},"4120":{},"4121":{},"4122":{},"4123":{},"4124":{},"4125":{},"4126":{},"4127":{},"4128":{},"4129":{},"4130":{},"4131":{},"4132":{},"4133":{},"4134":{},"4135":{},"4136":{},"4137":{},"4138":{},"4139":{},"4140":{},"4141":{},"4142":{},"4143":{},"4144":{},"4145":{},"4146":{},"4147":{},"4148":{},"4149":{},"4150":{},"4151":{},"4152":{},"4153":{},"4154":{},"4155":{},"4156":{},"4157":{},"4158":{},"4159":{},"4160":{},"4161":{},"4162":{},"4163":{},"4164":{},"4165":{},"4166":{},"4167":{},"4168":{},"4169":{},"4170":{},"4171":{},"4172":{},"4173":{},"4174":{},"4175":{},"4176":{},"4177":{},"4178":{},"4179":{},"4180":{},"4181":{},"4182":{},"4183":{},"4184":{},"4185":{},"4186":{},"4187":{},"4188":{},"4189":{},"4190":{},"4191":{},"4192":{},"4193":{},"4194":{},"4195":{},"4196":{},"4197":{},"4198":{},"4199":{},"4200":{},"4201":{},"4202":{},"4203":{},"4204":{},"4205":{},"4206":{},"4207":{},"4208":{},"4209":{},"4210":{},"4211":{},"4212":{},"4213":{},"4214":{},"4215":{},"4216":{},"4217":{},"4218":{},"4219":{},"4220":{},"4222":{},"4223":{},"4224":{},"4225":{},"4226":{},"4227":{},"4228":{},"4229":{},"4230":{},"4231":{},"4232":{},"4233":{},"4234":{},"4235":{},"4236":{},"4237":{},"4238":{},"4239":{},"4240":{},"4241":{},"4242":{},"4243":{},"4244":{},"4245":{},"4246":{},"4247":{},"4248":{},"4249":{},"4250":{},"4251":{},"4252":{},"4253":{},"4254":{},"4255":{},"4256":{},"4257":{},"4258":{},"4259":{},"4260":{},"4261":{},"4262":{},"4263":{},"4264":{},"4265":{},"4266":{},"4267":{},"4268":{},"4269":{},"4270":{},"4271":{},"4272":{},"4273":{},"4274":{},"4275":{},"4276":{},"4277":{},"4278":{},"4279":{},"4280":{},"4281":{},"4282":{},"4283":{},"4284":{},"4285":{},"4286":{},"4287":{},"4288":{},"4289":{},"4290":{},"4291":{},"4292":{},"4293":{},"4294":{},"4295":{},"4296":{},"4297":{},"4298":{},"4299":{},"4300":{},"4301":{},"4302":{},"4303":{},"4304":{},"4305":{},"4306":{},"4307":{},"4308":{},"4309":{},"4310":{},"4311":{},"4312":{},"4313":{},"4314":{},"4315":{},"4316":{},"4317":{},"4318":{},"4319":{},"4320":{},"4321":{},"4322":{},"4323":{},"4324":{},"4325":{},"4326":{},"4327":{},"4328":{},"4329":{},"4330":{},"4331":{},"4332":{},"4333":{},"4334":{},"4335":{},"4336":{},"4337":{},"4338":{},"4339":{},"4340":{},"4341":{},"4342":{},"4343":{},"4344":{},"4345":{},"4346":{},"4347":{},"4348":{},"4349":{},"4350":{},"4351":{},"4352":{},"4353":{},"4354":{},"4355":{},"4356":{},"4357":{},"4358":{},"4359":{},"4360":{},"4361":{},"4362":{},"4363":{},"4364":{},"4365":{},"4366":{},"4367":{},"4368":{},"4369":{},"4370":{},"4371":{},"4372":{},"4373":{},"4374":{},"4375":{},"4376":{},"4377":{},"4378":{},"4379":{},"4380":{},"4381":{},"4382":{},"4383":{},"4384":{},"4385":{},"4386":{},"4387":{},"4388":{},"4389":{},"4390":{},"4391":{},"4392":{},"4393":{},"4394":{},"4395":{},"4396":{},"4397":{},"4398":{},"4399":{},"4400":{},"4401":{},"4402":{},"4403":{},"4404":{},"4405":{},"4406":{},"4407":{},"4408":{},"4409":{},"4410":{},"4411":{},"4412":{},"4413":{},"4414":{},"4415":{},"4416":{},"4417":{},"4418":{},"4419":{},"4420":{},"4421":{},"4422":{},"4423":{},"4424":{},"4425":{},"4426":{},"4427":{},"4428":{},"4429":{},"4430":{},"4431":{},"4432":{},"4433":{},"4434":{},"4435":{},"4436":{},"4437":{},"4438":{},"4439":{},"4440":{},"4441":{},"4442":{},"4443":{},"4444":{},"4445":{},"4446":{},"4447":{},"4448":{},"4449":{},"4450":{},"4451":{},"4452":{},"4453":{},"4454":{},"4455":{},"4456":{},"4457":{},"4458":{},"4459":{},"4460":{},"4461":{},"4462":{},"4463":{},"4464":{},"4465":{},"4466":{},"4467":{},"4468":{},"4469":{},"4470":{},"4471":{},"4472":{},"4473":{},"4474":{},"4475":{},"4476":{},"4477":{},"4478":{},"4479":{},"4480":{},"4481":{},"4482":{},"4483":{},"4484":{},"4485":{},"4486":{},"4487":{},"4488":{},"4489":{},"4490":{},"4491":{},"4492":{},"4493":{},"4494":{},"4495":{},"4496":{},"4497":{},"4498":{},"4499":{},"4500":{},"4501":{},"4502":{},"4503":{},"4504":{},"4505":{},"4506":{},"4507":{},"4508":{},"4509":{},"4510":{},"4511":{},"4512":{},"4513":{},"4514":{},"4515":{},"4516":{},"4517":{},"4518":{},"4519":{},"4520":{},"4521":{},"4522":{},"4523":{},"4524":{},"4525":{},"4526":{},"4527":{},"4528":{},"4529":{},"4530":{},"4531":{},"4532":{},"4533":{},"4534":{},"4535":{},"4536":{},"4537":{},"4538":{},"4539":{},"4540":{},"4541":{},"4542":{},"4543":{},"4544":{},"4545":{},"4546":{},"4547":{},"4548":{},"4549":{},"4550":{},"4551":{},"4552":{},"4553":{},"4554":{},"4555":{},"4556":{},"4557":{},"4558":{},"4559":{},"4560":{},"4561":{},"4562":{},"4563":{},"4564":{},"4565":{},"4566":{},"4567":{},"4568":{},"4569":{},"4570":{},"4571":{},"4572":{},"4573":{},"4574":{},"4575":{},"4576":{},"4577":{},"4578":{},"4579":{},"4580":{},"4581":{},"4582":{},"4583":{},"4584":{},"4585":{},"4586":{},"4587":{},"4588":{},"4589":{},"4590":{},"4591":{},"4592":{},"4593":{},"4594":{},"4595":{},"4596":{},"4597":{},"4598":{},"4599":{},"4600":{},"4601":{},"4602":{},"4603":{},"4604":{},"4605":{},"4606":{},"4607":{},"4608":{},"4609":{},"4610":{},"4611":{},"4612":{},"4613":{},"4614":{},"4615":{},"4616":{},"4617":{},"4618":{},"4619":{},"4620":{},"4621":{},"4622":{},"4623":{},"4624":{},"4625":{},"4626":{},"4627":{},"4628":{},"4629":{},"4630":{},"4631":{},"4632":{},"4633":{},"4634":{},"4635":{},"4636":{},"4637":{},"4638":{},"4639":{},"4640":{},"4641":{},"4642":{},"4643":{},"4644":{},"4645":{},"4646":{},"4647":{},"4648":{},"4649":{},"4650":{},"4651":{},"4652":{},"4653":{},"4654":{},"4655":{},"4656":{},"4657":{},"4658":{},"4659":{},"4660":{},"4661":{},"4662":{},"4663":{},"4664":{},"4665":{},"4666":{},"4667":{},"4668":{},"4669":{},"4670":{},"4671":{},"4672":{},"4673":{},"4674":{},"4675":{},"4676":{},"4677":{},"4678":{},"4679":{},"4680":{},"4681":{},"4682":{},"4683":{},"4684":{},"4685":{},"4686":{},"4687":{},"4688":{},"4689":{},"4690":{},"4691":{},"4692":{},"4693":{},"4694":{},"4695":{},"4696":{},"4697":{},"4698":{},"4699":{},"4700":{},"4701":{},"4702":{},"4703":{},"4704":{},"4705":{},"4706":{},"4707":{},"4708":{},"4709":{},"4710":{},"4711":{},"4712":{},"4713":{},"4714":{},"4715":{},"4716":{},"4717":{},"4718":{},"4719":{},"4720":{},"4721":{},"4722":{},"4723":{},"4724":{},"4725":{},"4726":{},"4727":{},"4728":{},"4729":{},"4730":{},"4731":{},"4732":{},"4733":{},"4734":{},"4735":{},"4736":{},"4737":{},"4738":{},"4739":{},"4740":{},"4741":{},"4742":{},"4743":{},"4744":{},"4745":{},"4746":{},"4747":{},"4748":{},"4749":{},"4750":{},"4751":{},"4752":{},"4753":{},"4754":{},"4755":{},"4756":{},"4757":{},"4758":{},"4759":{},"4760":{},"4761":{},"4762":{},"4763":{},"4764":{},"4765":{},"4766":{},"4767":{},"4768":{},"4769":{},"4770":{},"4771":{},"4772":{},"4773":{},"4774":{},"4775":{},"4776":{},"4777":{},"4778":{},"4779":{},"4780":{},"4781":{},"4782":{},"4783":{},"4784":{},"4785":{},"4786":{},"4787":{},"4788":{},"4789":{},"4790":{},"4791":{},"4792":{},"4793":{},"4794":{},"4795":{},"4796":{},"4797":{},"4798":{},"4799":{},"4800":{},"4801":{},"4802":{},"4803":{},"4804":{},"4805":{},"4806":{},"4807":{},"4808":{},"4809":{},"4810":{},"4811":{},"4812":{},"4813":{},"4814":{},"4815":{},"4816":{},"4817":{},"4818":{},"4819":{},"4820":{},"4821":{},"4822":{},"4823":{},"4824":{},"4825":{},"4826":{},"4827":{},"4828":{},"4829":{},"4830":{},"4831":{},"4832":{},"4833":{},"4834":{},"4835":{},"4836":{},"4837":{},"4838":{},"4839":{},"4840":{},"4841":{},"4842":{},"4843":{},"4844":{},"4845":{},"4846":{},"4847":{},"4848":{},"4849":{},"4850":{},"4851":{},"4852":{},"4853":{},"4854":{},"4855":{},"4856":{},"4857":{},"4858":{},"4859":{},"4860":{},"4861":{},"4862":{},"4863":{},"4864":{},"4865":{},"4866":{},"4867":{},"4868":{},"4869":{},"4870":{},"4871":{},"4872":{},"4873":{},"4874":{},"4876":{},"4877":{},"4878":{},"4879":{},"4880":{},"4881":{},"4882":{},"4883":{},"4884":{},"4885":{},"4886":{},"4887":{},"4888":{},"4889":{},"4890":{},"4891":{},"4892":{},"4893":{},"4894":{},"4895":{},"4896":{},"4897":{},"4898":{},"4899":{},"4900":{},"4901":{},"4902":{},"4903":{},"4904":{},"4905":{},"4906":{},"4907":{},"4908":{},"4909":{},"4910":{},"4911":{},"4912":{},"4913":{},"4914":{},"4915":{},"4916":{},"4917":{},"4918":{},"4919":{},"4920":{},"4921":{},"4922":{},"4923":{},"4924":{},"4925":{},"4926":{},"4927":{},"4928":{},"4929":{},"4930":{},"4931":{},"4932":{},"4933":{},"4934":{},"4935":{},"4936":{},"4937":{},"4938":{},"4939":{},"4940":{},"4941":{},"4942":{},"4943":{},"4944":{},"4945":{},"4946":{},"4947":{},"4948":{},"4949":{},"4950":{},"4951":{},"4952":{},"4953":{},"4954":{},"4955":{},"4956":{},"4957":{},"4958":{},"4959":{},"4960":{},"4961":{},"4962":{},"4963":{},"4964":{},"4965":{},"4966":{},"4967":{},"4968":{},"4969":{},"4970":{},"4971":{},"4972":{},"4973":{},"4974":{},"4975":{},"4976":{},"4977":{},"4978":{},"4979":{},"4980":{},"4981":{},"4982":{},"4983":{},"4984":{},"4985":{},"4986":{},"4987":{},"4988":{},"4989":{},"4990":{},"4991":{},"4992":{},"4993":{},"4994":{},"4995":{},"4996":{},"4997":{},"4998":{},"4999":{},"5000":{},"5001":{},"5002":{},"5003":{},"5004":{},"5005":{},"5006":{},"5007":{},"5008":{},"5009":{},"5010":{},"5011":{},"5012":{},"5013":{},"5014":{},"5015":{},"5016":{},"5017":{},"5018":{},"5019":{},"5020":{},"5021":{},"5022":{},"5023":{},"5024":{},"5025":{},"5026":{},"5027":{},"5028":{},"5029":{},"5030":{},"5031":{},"5032":{},"5033":{},"5034":{},"5035":{},"5036":{},"5037":{},"5038":{},"5039":{},"5040":{},"5041":{},"5042":{},"5043":{},"5044":{},"5045":{},"5046":{},"5047":{},"5048":{},"5049":{},"5050":{},"5051":{},"5052":{},"5053":{},"5054":{},"5055":{},"5056":{},"5057":{},"5058":{},"5059":{},"5060":{},"5061":{},"5062":{},"5063":{},"5064":{},"5065":{},"5066":{},"5067":{},"5068":{},"5069":{},"5070":{},"5071":{},"5072":{},"5073":{},"5074":{},"5075":{},"5076":{},"5077":{},"5078":{},"5079":{},"5080":{},"5081":{},"5082":{},"5083":{},"5084":{},"5085":{},"5086":{},"5087":{},"5088":{},"5089":{},"5090":{},"5091":{},"5092":{},"5093":{},"5094":{},"5095":{},"5096":{},"5097":{},"5098":{},"5099":{},"5100":{},"5101":{},"5102":{},"5103":{},"5104":{},"5105":{},"5106":{},"5107":{},"5108":{},"5109":{},"5110":{},"5111":{},"5112":{},"5113":{},"5114":{},"5115":{},"5116":{},"5117":{},"5118":{},"5119":{},"5120":{},"5121":{},"5122":{},"5123":{},"5124":{},"5125":{},"5126":{},"5127":{},"5128":{},"5129":{},"5130":{},"5131":{},"5132":{},"5133":{},"5134":{},"5135":{},"5136":{},"5137":{},"5138":{},"5139":{},"5140":{},"5141":{},"5142":{},"5143":{},"5144":{},"5145":{},"5146":{},"5147":{},"5148":{},"5149":{},"5150":{},"5151":{},"5152":{},"5153":{},"5154":{},"5156":{},"5157":{},"5158":{},"5159":{},"5160":{},"5161":{},"5162":{},"5163":{},"5164":{},"5165":{},"5166":{},"5167":{},"5168":{},"5169":{},"5170":{},"5171":{},"5172":{},"5173":{},"5174":{},"5175":{},"5176":{},"5177":{},"5178":{},"5179":{},"5180":{},"5181":{},"5182":{},"5183":{},"5184":{},"5185":{},"5186":{},"5187":{},"5189":{},"5190":{},"5191":{},"5192":{},"5193":{},"5194":{},"5195":{},"5196":{},"5197":{},"5198":{},"5199":{},"5200":{},"5201":{},"5202":{},"5203":{},"5204":{},"5205":{},"5206":{},"5207":{},"5208":{},"5209":{},"5210":{},"5211":{},"5212":{},"5213":{},"5214":{},"5215":{},"5216":{},"5217":{},"5218":{},"5219":{},"5220":{},"5221":{},"5222":{},"5223":{},"5224":{},"5225":{},"5226":{},"5227":{},"5228":{},"5229":{},"5230":{},"5231":{},"5232":{},"5233":{},"5234":{},"5235":{},"5236":{},"5237":{},"5238":{},"5239":{},"5240":{},"5241":{},"5242":{},"5243":{},"5244":{},"5245":{},"5246":{},"5247":{},"5248":{},"5249":{},"5250":{},"5251":{},"5252":{},"5253":{},"5254":{},"5255":{},"5256":{},"5257":{},"5258":{},"5259":{},"5260":{},"5261":{},"5262":{},"5263":{},"5264":{},"5265":{},"5266":{},"5267":{},"5268":{},"5269":{},"5270":{},"5271":{},"5272":{},"5273":{},"5274":{},"5275":{},"5276":{},"5277":{},"5278":{},"5279":{},"5280":{},"5281":{},"5282":{},"5283":{},"5284":{},"5285":{},"5286":{},"5287":{},"5288":{},"5289":{},"5290":{},"5291":{},"5292":{},"5293":{},"5294":{},"5295":{},"5296":{},"5297":{},"5298":{},"5299":{},"5300":{},"5301":{},"5302":{},"5303":{},"5304":{},"5305":{},"5306":{},"5307":{},"5308":{},"5309":{},"5310":{},"5311":{},"5312":{},"5313":{},"5314":{},"5315":{},"5316":{},"5317":{},"5318":{},"5319":{},"5320":{},"5321":{},"5322":{},"5323":{},"5324":{},"5325":{},"5326":{},"5327":{},"5328":{},"5329":{},"5330":{},"5331":{},"5332":{},"5333":{},"5334":{},"5335":{},"5336":{},"5337":{},"5338":{},"5339":{},"5340":{},"5341":{},"5342":{},"5343":{},"5344":{},"5345":{},"5346":{},"5347":{},"5348":{},"5349":{},"5350":{},"5351":{},"5352":{},"5353":{},"5354":{},"5355":{},"5356":{},"5357":{},"5358":{},"5359":{},"5360":{},"5361":{},"5362":{},"5363":{},"5364":{},"5365":{},"5366":{},"5367":{},"5368":{},"5369":{},"5370":{},"5371":{},"5372":{},"5373":{},"5374":{},"5375":{},"5376":{},"5377":{},"5378":{},"5379":{},"5380":{},"5381":{},"5382":{},"5383":{},"5384":{},"5385":{},"5386":{},"5387":{},"5388":{},"5389":{},"5390":{},"5391":{},"5392":{},"5393":{},"5394":{},"5395":{},"5396":{},"5397":{},"5398":{},"5399":{},"5400":{},"5401":{},"5402":{},"5403":{},"5404":{},"5405":{},"5406":{},"5407":{},"5408":{},"5409":{},"5410":{},"5411":{},"5412":{},"5413":{},"5414":{},"5415":{},"5416":{},"5417":{},"5418":{},"5419":{},"5420":{},"5421":{},"5422":{},"5423":{},"5424":{},"5425":{},"5426":{},"5427":{},"5428":{},"5429":{},"5430":{},"5431":{},"5432":{},"5433":{},"5434":{},"5435":{},"5436":{},"5437":{},"5439":{},"5440":{},"5441":{},"5442":{},"5443":{},"5444":{},"5445":{},"5446":{},"5447":{},"5448":{},"5449":{},"5450":{},"5451":{},"5452":{},"5453":{},"5454":{},"5455":{},"5456":{},"5457":{},"5458":{},"5459":{},"5460":{},"5461":{},"5462":{},"5463":{},"5464":{},"5465":{},"5466":{},"5467":{},"5468":{},"5469":{},"5470":{},"5471":{},"5472":{},"5473":{},"5474":{},"5475":{},"5476":{},"5477":{},"5478":{},"5479":{},"5480":{},"5481":{},"5482":{},"5483":{},"5484":{},"5485":{},"5486":{},"5487":{},"5488":{},"5489":{},"5490":{},"5491":{},"5492":{},"5493":{},"5494":{},"5495":{},"5496":{},"5497":{},"5498":{},"5499":{},"5500":{},"5501":{},"5502":{},"5503":{},"5504":{},"5505":{},"5506":{},"5507":{},"5508":{},"5509":{},"5510":{},"5511":{},"5512":{},"5513":{},"5514":{},"5515":{},"5516":{},"5517":{},"5518":{},"5519":{},"5520":{},"5521":{},"5522":{},"5523":{},"5524":{},"5525":{},"5526":{},"5527":{},"5528":{},"5529":{},"5530":{},"5531":{},"5532":{},"5533":{},"5534":{},"5535":{},"5536":{},"5537":{},"5538":{},"5539":{},"5540":{},"5541":{},"5542":{},"5543":{},"5544":{},"5545":{},"5546":{},"5547":{},"5548":{},"5549":{},"5550":{},"5551":{},"5552":{},"5553":{},"5554":{},"5555":{},"5556":{},"5557":{},"5558":{},"5559":{},"5560":{},"5561":{},"5562":{},"5563":{},"5564":{},"5565":{},"5566":{},"5567":{},"5568":{},"5570":{},"5571":{},"5572":{},"5573":{},"5574":{},"5575":{},"5576":{},"5577":{},"5578":{},"5579":{},"5580":{},"5581":{},"5582":{},"5583":{},"5584":{},"5585":{},"5586":{},"5587":{},"5588":{},"5589":{},"5590":{},"5591":{},"5592":{},"5593":{},"5594":{},"5595":{},"5596":{},"5597":{},"5598":{},"5599":{},"5600":{},"5601":{},"5602":{},"5603":{},"5604":{},"5605":{},"5606":{},"5607":{},"5608":{},"5609":{},"5610":{},"5611":{},"5612":{},"5613":{},"5614":{},"5615":{},"5616":{},"5617":{},"5618":{},"5619":{},"5620":{},"5621":{},"5622":{},"5623":{},"5624":{},"5625":{},"5626":{},"5627":{},"5628":{},"5629":{},"5630":{},"5631":{},"5632":{},"5633":{},"5634":{},"5635":{},"5636":{},"5637":{},"5638":{},"5639":{},"5640":{},"5641":{},"5642":{},"5643":{},"5644":{},"5645":{},"5646":{},"5647":{},"5648":{},"5649":{},"5650":{},"5651":{},"5652":{},"5653":{},"5654":{},"5655":{},"5656":{},"5657":{},"5658":{},"5659":{},"5660":{},"5661":{},"5662":{},"5663":{},"5664":{},"5665":{},"5666":{},"5667":{},"5668":{},"5669":{},"5670":{},"5671":{},"5672":{},"5673":{},"5674":{},"5675":{},"5676":{},"5677":{},"5678":{},"5679":{},"5680":{},"5681":{},"5682":{},"5683":{},"5684":{},"5685":{},"5686":{},"5687":{},"5688":{},"5689":{},"5690":{},"5691":{},"5692":{},"5693":{},"5694":{},"5695":{},"5696":{},"5697":{},"5698":{},"5699":{},"5700":{},"5701":{},"5702":{},"5703":{},"5704":{},"5705":{},"5706":{},"5707":{},"5708":{},"5709":{},"5710":{},"5711":{},"5712":{},"5713":{},"5714":{},"5715":{},"5716":{},"5717":{},"5718":{},"5719":{},"5720":{},"5721":{},"5722":{},"5723":{},"5724":{},"5725":{},"5726":{},"5727":{},"5728":{},"5729":{},"5730":{},"5731":{},"5732":{},"5733":{},"5734":{},"5735":{},"5736":{},"5737":{},"5738":{},"5739":{},"5740":{},"5741":{},"5742":{},"5743":{},"5744":{},"5745":{},"5746":{},"5747":{},"5748":{},"5749":{},"5750":{},"5751":{},"5752":{},"5753":{},"5754":{},"5755":{},"5756":{},"5757":{},"5758":{},"5759":{},"5760":{},"5761":{},"5762":{},"5763":{},"5764":{},"5765":{},"5766":{},"5767":{},"5768":{},"5769":{},"5770":{},"5771":{},"5772":{},"5773":{},"5774":{},"5775":{},"5776":{},"5777":{},"5778":{},"5779":{},"5780":{},"5781":{},"5782":{},"5783":{},"5784":{},"5785":{},"5786":{},"5787":{},"5788":{},"5789":{},"5790":{},"5791":{},"5792":{},"5793":{},"5794":{},"5795":{},"5796":{},"5797":{},"5798":{},"5799":{},"5800":{},"5801":{},"5802":{},"5803":{},"5804":{},"5805":{},"5806":{},"5807":{},"5808":{},"5809":{},"5810":{},"5811":{},"5812":{},"5813":{},"5814":{},"5815":{},"5816":{},"5817":{},"5818":{},"5819":{},"5820":{},"5821":{},"5822":{},"5823":{},"5824":{},"5825":{},"5826":{},"5827":{},"5828":{},"5829":{},"5830":{},"5831":{},"5832":{},"5833":{},"5834":{},"5835":{},"5836":{},"5837":{},"5838":{},"5839":{},"5840":{},"5841":{},"5842":{},"5843":{},"5844":{},"5845":{},"5846":{},"5847":{},"5848":{},"5849":{},"5850":{},"5851":{},"5852":{},"5853":{},"5854":{},"5855":{},"5856":{},"5857":{},"5858":{},"5859":{},"5860":{},"5861":{},"5862":{},"5863":{},"5864":{},"5865":{},"5866":{},"5867":{},"5868":{},"5869":{},"5870":{},"5871":{},"5872":{},"5873":{},"5874":{},"5875":{},"5876":{},"5877":{},"5878":{},"5879":{},"5880":{},"5881":{},"5882":{},"5883":{},"5884":{},"5885":{},"5886":{},"5887":{},"5888":{},"5889":{},"5890":{},"5891":{},"5892":{},"5893":{},"5894":{},"5895":{},"5896":{},"5897":{},"5898":{},"5899":{},"5900":{},"5901":{},"5902":{},"5903":{},"5904":{},"5905":{},"5906":{},"5907":{},"5908":{},"5909":{},"5910":{},"5911":{},"5912":{},"5913":{},"5914":{},"5915":{},"5916":{},"5917":{},"5918":{},"5919":{},"5920":{},"5921":{},"5922":{},"5923":{},"5924":{},"5925":{},"5926":{},"5927":{},"5928":{},"5929":{},"5930":{},"5931":{},"5932":{},"5933":{},"5934":{},"5935":{},"5936":{},"5937":{},"5938":{},"5939":{},"5940":{},"5941":{},"5942":{},"5943":{},"5944":{},"5945":{},"5946":{},"5947":{},"5948":{},"5949":{},"5950":{},"5951":{},"5952":{},"5953":{},"5954":{},"5955":{},"5956":{},"5957":{},"5958":{},"5959":{},"5960":{},"5961":{},"5962":{},"5963":{},"5964":{},"5965":{},"5966":{},"5967":{},"5968":{},"5969":{},"5970":{},"5971":{},"5972":{},"5973":{},"5974":{},"5975":{},"5976":{},"5977":{},"5978":{},"5979":{},"5980":{},"5981":{},"5982":{},"5983":{},"5984":{},"5985":{},"5986":{},"5987":{},"5988":{},"5989":{},"5990":{},"5991":{},"5992":{},"5993":{},"5994":{},"5995":{},"5996":{},"5997":{},"5998":{},"5999":{},"6000":{},"6001":{},"6002":{},"6003":{},"6004":{},"6005":{},"6006":{},"6007":{},"6009":{},"6010":{},"6011":{},"6012":{},"6013":{},"6014":{},"6015":{},"6016":{},"6017":{},"6018":{},"6019":{},"6020":{},"6021":{},"6022":{},"6023":{},"6024":{},"6025":{},"6026":{},"6027":{},"6028":{},"6029":{},"6030":{},"6031":{},"6032":{},"6033":{},"6034":{},"6035":{},"6036":{},"6037":{},"6038":{},"6039":{},"6040":{},"6041":{},"6042":{},"6043":{},"6044":{},"6045":{},"6046":{},"6047":{},"6048":{},"6049":{},"6050":{},"6051":{},"6052":{},"6053":{},"6054":{},"6055":{},"6056":{},"6057":{},"6058":{},"6059":{},"6060":{},"6061":{},"6062":{},"6063":{},"6064":{},"6065":{},"6066":{},"6067":{},"6068":{},"6069":{},"6070":{},"6071":{},"6072":{},"6073":{},"6074":{},"6075":{},"6076":{},"6077":{},"6078":{},"6079":{},"6080":{},"6081":{},"6082":{},"6083":{},"6084":{},"6085":{},"6086":{},"6087":{},"6088":{},"6089":{},"6090":{},"6091":{},"6092":{},"6093":{},"6094":{},"6095":{},"6096":{},"6097":{},"6098":{},"6099":{},"6100":{},"6101":{},"6102":{},"6103":{},"6104":{},"6105":{},"6106":{},"6107":{},"6108":{},"6109":{},"6110":{},"6111":{},"6112":{},"6113":{},"6114":{},"6115":{},"6116":{},"6117":{},"6118":{},"6119":{},"6120":{},"6121":{},"6122":{},"6123":{},"6124":{},"6125":{},"6126":{},"6127":{},"6128":{},"6129":{},"6130":{},"6131":{},"6132":{},"6133":{},"6134":{},"6135":{},"6136":{},"6137":{},"6138":{},"6139":{},"6140":{},"6141":{},"6142":{},"6143":{},"6144":{},"6145":{},"6146":{},"6147":{},"6148":{},"6149":{},"6150":{},"6151":{},"6152":{},"6153":{},"6154":{},"6155":{},"6156":{},"6157":{},"6158":{},"6159":{},"6160":{},"6161":{},"6162":{},"6163":{},"6164":{},"6165":{},"6166":{},"6167":{},"6168":{},"6169":{},"6170":{},"6171":{},"6172":{},"6173":{},"6174":{},"6175":{},"6176":{},"6177":{},"6178":{},"6179":{},"6180":{},"6181":{},"6182":{},"6183":{},"6184":{},"6185":{},"6186":{},"6187":{},"6188":{},"6189":{},"6190":{},"6191":{},"6192":{},"6193":{},"6194":{},"6195":{},"6196":{},"6197":{},"6198":{},"6199":{},"6200":{}}}],["zowe/core",{"_index":0,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"127":{},"128":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"177":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{},"202":{},"203":{},"204":{},"205":{},"206":{},"207":{},"208":{},"209":{},"210":{},"211":{},"212":{},"213":{},"214":{},"215":{},"216":{},"217":{},"218":{},"219":{},"220":{},"221":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"228":{},"229":{},"230":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{},"250":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{},"259":{},"260":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"279":{},"280":{},"281":{},"282":{},"283":{},"284":{},"285":{},"286":{},"287":{},"288":{},"289":{},"290":{},"291":{},"292":{},"293":{},"294":{},"295":{},"296":{}}}],["zowe/imperative",{"_index":291,"name":{"297":{}},"parent":{"298":{},"305":{},"309":{},"316":{},"319":{},"322":{},"327":{},"329":{},"332":{},"348":{},"350":{},"352":{},"368":{},"370":{},"398":{},"402":{},"410":{},"446":{},"462":{},"465":{},"472":{},"535":{},"543":{},"547":{},"554":{},"560":{},"568":{},"572":{},"577":{},"584":{},"591":{},"597":{},"602":{},"609":{},"617":{},"623":{},"628":{},"633":{},"635":{},"637":{},"640":{},"650":{},"654":{},"667":{},"681":{},"682":{},"683":{},"688":{},"712":{},"723":{},"737":{},"742":{},"746":{},"749":{},"760":{},"762":{},"767":{},"782":{},"789":{},"793":{},"794":{},"798":{},"803":{},"806":{},"810":{},"858":{},"862":{},"865":{},"868":{},"887":{},"888":{},"895":{},"898":{},"903":{},"907":{},"929":{},"930":{},"931":{},"942":{},"946":{},"951":{},"955":{},"960":{},"964":{},"971":{},"983":{},"1031":{},"1033":{},"1035":{},"1037":{},"1053":{},"1103":{},"1107":{},"1110":{},"1115":{},"1116":{},"1119":{},"1124":{},"1127":{},"1136":{},"1138":{},"1140":{},"1142":{},"1147":{},"1152":{},"1153":{},"1154":{},"1164":{},"1165":{},"1175":{},"1194":{},"1195":{},"1196":{},"1197":{},"1198":{},"1199":{},"1200":{},"1201":{},"1202":{},"1203":{},"1204":{},"1205":{},"1206":{},"1207":{},"1208":{},"1209":{},"1230":{},"1252":{},"1272":{},"1280":{},"1290":{},"1307":{},"1308":{},"1322":{},"1333":{},"1339":{},"1380":{},"1382":{},"1439":{},"1443":{},"1447":{},"1456":{},"1473":{},"1481":{},"1491":{},"1496":{},"1505":{},"1520":{},"1529":{},"1550":{},"1554":{},"1558":{},"1562":{},"1564":{},"1567":{},"1572":{},"1592":{},"1595":{},"1608":{},"1619":{},"1622":{},"1636":{},"1639":{},"1645":{},"1646":{},"1649":{},"1653":{},"1654":{},"1659":{},"1670":{},"1673":{},"1679":{},"1692":{},"1725":{},"1729":{},"1737":{},"1738":{},"1740":{},"1744":{},"1746":{},"1748":{},"1750":{},"1752":{},"1754":{},"1756":{},"1758":{},"1760":{},"1762":{},"1764":{},"1766":{},"1768":{},"1770":{},"1772":{},"1774":{},"1776":{},"1778":{},"1780":{},"1782":{},"1784":{},"1786":{},"1788":{},"1790":{},"1792":{},"1794":{},"1796":{},"1798":{},"1800":{},"1802":{},"1804":{},"1806":{},"1808":{},"1810":{},"1812":{},"1814":{},"1816":{},"1818":{},"1820":{},"1822":{},"1824":{},"1826":{},"1828":{},"1830":{},"1832":{},"1834":{},"1836":{},"1838":{},"1840":{},"1842":{},"1844":{},"1846":{},"1848":{},"1850":{},"1852":{},"1854":{},"1856":{},"1858":{},"1860":{},"1862":{},"1864":{},"1866":{},"1868":{},"1870":{},"1872":{},"1874":{},"1876":{},"1878":{},"1880":{},"1882":{},"1884":{},"1886":{},"1888":{},"1890":{},"1892":{},"1894":{},"1896":{},"1898":{},"1900":{},"1902":{},"1904":{},"1906":{},"1908":{},"1916":{},"1925":{},"1926":{},"1934":{},"1958":{},"2006":{},"2009":{},"2013":{},"2051":{},"2061":{},"2067":{},"2071":{},"2086":{},"2088":{},"2091":{},"2095":{},"2106":{},"2109":{},"2114":{},"2118":{},"2144":{},"2187":{},"2191":{},"2213":{},"2216":{},"2228":{},"2265":{},"2272":{},"2273":{},"2298":{},"2320":{},"2322":{},"2334":{},"2366":{},"2368":{},"2370":{},"2376":{},"2379":{},"2430":{},"2432":{},"2441":{},"2450":{},"2462":{},"2479":{},"2492":{},"2497":{},"2508":{},"2519":{},"2530":{},"2541":{},"2552":{},"2563":{},"2574":{},"2576":{},"2586":{},"2593":{},"2597":{},"2607":{},"2617":{},"2627":{},"2631":{},"2652":{},"2657":{},"2702":{},"2712":{},"2714":{},"2721":{},"2754":{},"2757":{},"2775":{},"2784":{},"2787":{},"2792":{},"2798":{},"2803":{},"2808":{},"2812":{},"2815":{},"2820":{},"2825":{},"2832":{},"2833":{},"2834":{},"2839":{},"2841":{},"2844":{},"2848":{},"2870":{},"2877":{},"2883":{},"2887":{},"2889":{},"2893":{},"2895":{},"2898":{},"2902":{},"2906":{},"2960":{},"2970":{},"2974":{},"3006":{},"3032":{},"3034":{},"3037":{},"3040":{},"3044":{},"3051":{},"3054":{},"3059":{},"3061":{},"3063":{},"3069":{},"3072":{},"3075":{},"3089":{},"3153":{},"3155":{},"3158":{},"3161":{},"3167":{},"3174":{},"3178":{},"3185":{},"3193":{},"3195":{},"3199":{},"3204":{},"3208":{},"3213":{},"3219":{},"3223":{},"3225":{},"3230":{},"3234":{},"3236":{},"3242":{},"3243":{},"3245":{},"3250":{},"3255":{},"3258":{},"3266":{},"3309":{},"3311":{},"3318":{},"3326":{},"3334":{},"3336":{},"3338":{},"3340":{},"3352":{},"3354":{},"3362":{},"3369":{},"3390":{},"3407":{},"3435":{},"3438":{},"3451":{},"3453":{},"3458":{},"3468":{},"3476":{},"3483":{},"3490":{},"3498":{},"3507":{},"3515":{},"3524":{},"3533":{},"3541":{},"3551":{},"3556":{},"3557":{},"3558":{},"3559":{},"3560":{},"3561":{},"3562":{},"3563":{},"3565":{},"3566":{},"3567":{},"3568":{},"3579":{},"3581":{},"3587":{},"3594":{},"3596":{},"3599":{},"3613":{},"3617":{},"3618":{},"3622":{},"3624":{},"3640":{},"3644":{},"3646":{},"3650":{},"3652":{},"3654":{},"3656":{},"3665":{},"3674":{},"3675":{},"3678":{},"3687":{},"3690":{},"3698":{},"3702":{},"3711":{},"3714":{},"3723":{},"3727":{},"3738":{},"3749":{},"3760":{},"3762":{},"3764":{},"3766":{},"3768":{},"3770":{},"3772":{},"3775":{},"3776":{},"3787":{},"3798":{},"3799":{},"3800":{},"3801":{},"3802":{},"3803":{},"3804":{},"3805":{},"3809":{},"3810":{},"3811":{},"3812":{},"3813":{},"3815":{},"3816":{},"3817":{},"3818":{},"3819":{},"3820":{},"3821":{},"3822":{},"3823":{},"3824":{},"3825":{},"3826":{},"3827":{},"3828":{},"3829":{},"3830":{},"3831":{}}}],["zowe/imperative.abstractauthhandler",{"_index":1245,"name":{},"parent":{"1482":{},"1483":{},"1484":{},"1485":{},"1486":{},"1487":{},"1488":{},"1489":{},"1490":{}}}],["zowe/imperative.abstractcommandbuilder",{"_index":2025,"name":{},"parent":{"2493":{},"2494":{},"2495":{},"2496":{}}}],["zowe/imperative.abstractcommandyargs",{"_index":1925,"name":{},"parent":{"2335":{},"2336":{},"2337":{},"2338":{},"2339":{},"2340":{},"2341":{},"2342":{},"2343":{},"2344":{},"2345":{},"2346":{},"2347":{},"2348":{},"2349":{},"2350":{},"2351":{},"2352":{},"2353":{},"2354":{},"2355":{},"2356":{},"2357":{},"2358":{},"2359":{},"2360":{},"2361":{},"2362":{},"2363":{},"2364":{},"2365":{}}}],["zowe/imperative.abstractcredentialmanager",{"_index":651,"name":{},"parent":{"668":{},"669":{},"670":{},"671":{},"672":{},"673":{},"674":{},"675":{},"676":{},"677":{},"678":{},"679":{},"680":{}}}],["zowe/imperative.abstracthelpgenerator",{"_index":1796,"name":{},"parent":{"2119":{},"2120":{},"2121":{},"2122":{},"2123":{},"2124":{},"2125":{},"2126":{},"2127":{},"2128":{},"2129":{},"2131":{},"2133":{},"2134":{},"2135":{},"2136":{},"2137":{},"2138":{},"2139":{},"2140":{},"2141":{},"2142":{},"2143":{}}}],["zowe/imperative.abstracthelpgenerator.grouptooption",{"_index":1804,"name":{},"parent":{"2130":{}}}],["zowe/imperative.abstracthelpgenerator.optiontodescription",{"_index":1806,"name":{},"parent":{"2132":{}}}],["zowe/imperative.abstracthelpgeneratorfactory",{"_index":2541,"name":{},"parent":{"3341":{},"3342":{},"3343":{},"3344":{},"3345":{},"3346":{},"3347":{},"3348":{},"3349":{},"3350":{},"3351":{}}}],["zowe/imperative.abstractpluginlifecycle",{"_index":2141,"name":{},"parent":{"2755":{},"2756":{}}}],["zowe/imperative.abstractprofilemanager",{"_index":2420,"name":{},"parent":{"3090":{},"3091":{},"3092":{},"3093":{},"3094":{},"3095":{},"3096":{},"3097":{},"3098":{},"3099":{},"3100":{},"3101":{},"3102":{},"3103":{},"3104":{},"3105":{},"3106":{},"3107":{},"3108":{},"3109":{},"3110":{},"3111":{},"3112":{},"3113":{},"3114":{},"3115":{},"3116":{},"3117":{},"3118":{},"3119":{},"3120":{},"3121":{},"3122":{},"3123":{},"3124":{},"3125":{},"3126":{},"3127":{},"3128":{},"3129":{},"3130":{},"3131":{},"3132":{},"3133":{},"3134":{},"3135":{},"3136":{},"3137":{},"3138":{},"3139":{},"3140":{},"3141":{},"3142":{},"3143":{},"3144":{},"3145":{},"3146":{},"3147":{},"3148":{},"3149":{},"3150":{},"3151":{},"3152":{}}}],["zowe/imperative.abstractprofilemanagerfactory",{"_index":2522,"name":{},"parent":{"3310":{}}}],["zowe/imperative.abstractrestclient",{"_index":1147,"name":{},"parent":{"1340":{},"1341":{},"1342":{},"1343":{},"1344":{},"1345":{},"1346":{},"1347":{},"1348":{},"1349":{},"1350":{},"1351":{},"1352":{},"1353":{},"1354":{},"1355":{},"1356":{},"1357":{},"1358":{},"1359":{},"1360":{},"1361":{},"1362":{},"1363":{},"1364":{},"1365":{},"1366":{},"1367":{},"1368":{},"1369":{},"1370":{},"1371":{},"1372":{},"1373":{},"1374":{},"1375":{},"1376":{},"1377":{},"1378":{},"1379":{}}}],["zowe/imperative.abstractsession",{"_index":1077,"name":{},"parent":{"1231":{},"1232":{},"1233":{},"1234":{},"1235":{},"1236":{},"1237":{},"1238":{},"1239":{},"1240":{},"1241":{},"1242":{},"1243":{},"1244":{},"1245":{},"1246":{},"1247":{},"1248":{},"1249":{},"1250":{},"1251":{}}}],["zowe/imperative.aliaslist",{"_index":2790,"name":{},"parent":{"3814":{}}}],["zowe/imperative.apierrorheader",{"_index":1480,"name":{},"parent":{"1745":{}}}],["zowe/imperative.appsettings",{"_index":1420,"name":{},"parent":{"1680":{},"1681":{},"1682":{},"1683":{},"1684":{},"1685":{},"1686":{},"1687":{},"1688":{},"1689":{},"1690":{},"1691":{}}}],["zowe/imperative.authcategorydesc",{"_index":1626,"name":{},"parent":{"1891":{}}}],["zowe/imperative.authcommandbuilder",{"_index":2065,"name":{},"parent":{"2598":{},"2599":{},"2600":{},"2601":{},"2602":{},"2603":{},"2604":{},"2605":{},"2606":{}}}],["zowe/imperative.authlogincommandbuilder",{"_index":2069,"name":{},"parent":{"2608":{},"2609":{},"2610":{},"2611":{},"2612":{},"2613":{},"2614":{},"2615":{},"2616":{}}}],["zowe/imperative.authlogincommanddesc",{"_index":1632,"name":{},"parent":{"1897":{}}}],["zowe/imperative.authlogingroupdesc",{"_index":1630,"name":{},"parent":{"1895":{}}}],["zowe/imperative.authlogingroupsummary",{"_index":1628,"name":{},"parent":{"1893":{}}}],["zowe/imperative.authloginshowtokendesc",{"_index":1634,"name":{},"parent":{"1899":{}}}],["zowe/imperative.authlogoutcommandbuilder",{"_index":2071,"name":{},"parent":{"2618":{},"2619":{},"2620":{},"2621":{},"2622":{},"2623":{},"2624":{},"2625":{},"2626":{}}}],["zowe/imperative.authlogoutcommanddesc",{"_index":1640,"name":{},"parent":{"1905":{}}}],["zowe/imperative.authlogoutgroupdesc",{"_index":1638,"name":{},"parent":{"1903":{}}}],["zowe/imperative.authlogoutgroupsummary",{"_index":1636,"name":{},"parent":{"1901":{}}}],["zowe/imperative.autoinitcommandbuilder",{"_index":2105,"name":{},"parent":{"2703":{},"2704":{},"2705":{},"2706":{},"2707":{},"2708":{},"2709":{},"2710":{},"2711":{}}}],["zowe/imperative.autoinitcommanddesc",{"_index":1642,"name":{},"parent":{"1907":{}}}],["zowe/imperative.autoinitconstants",{"_index":2091,"name":{},"parent":{"2658":{},"2659":{},"2666":{},"2673":{},"2680":{},"2687":{},"2695":{}}}],["zowe/imperative.autoinitconstants.auto_init_option_dry_run",{"_index":2097,"name":{},"parent":{"2674":{},"2675":{},"2676":{},"2677":{},"2678":{},"2679":{}}}],["zowe/imperative.autoinitconstants.auto_init_option_edit",{"_index":2099,"name":{},"parent":{"2681":{},"2682":{},"2683":{},"2684":{},"2685":{},"2686":{}}}],["zowe/imperative.autoinitconstants.auto_init_option_for_sure",{"_index":2103,"name":{},"parent":{"2696":{},"2697":{},"2698":{},"2699":{},"2700":{},"2701":{}}}],["zowe/imperative.autoinitconstants.auto_init_option_global_config",{"_index":2095,"name":{},"parent":{"2667":{},"2668":{},"2669":{},"2670":{},"2671":{},"2672":{}}}],["zowe/imperative.autoinitconstants.auto_init_option_overwrite",{"_index":2101,"name":{},"parent":{"2688":{},"2689":{},"2690":{},"2691":{},"2692":{},"2693":{},"2694":{}}}],["zowe/imperative.autoinitconstants.auto_init_option_user_config",{"_index":2093,"name":{},"parent":{"2660":{},"2661":{},"2662":{},"2663":{},"2664":{},"2665":{}}}],["zowe/imperative.badcredentialmanagererror",{"_index":679,"name":{},"parent":{"713":{},"714":{},"715":{},"716":{},"717":{},"718":{},"719":{},"720":{},"721":{},"722":{}}}],["zowe/imperative.baseauthhandler",{"_index":2144,"name":{},"parent":{"2758":{},"2759":{},"2760":{},"2761":{},"2762":{},"2763":{},"2764":{},"2765":{},"2766":{},"2767":{},"2768":{},"2769":{},"2770":{},"2771":{},"2772":{},"2773":{},"2774":{}}}],["zowe/imperative.baseautoinithandler",{"_index":2153,"name":{},"parent":{"2776":{},"2777":{},"2778":{},"2779":{},"2780":{},"2781":{},"2782":{},"2783":{}}}],["zowe/imperative.basicprofilemanager",{"_index":2520,"name":{},"parent":{"3267":{},"3268":{},"3269":{},"3270":{},"3271":{},"3272":{},"3273":{},"3274":{},"3275":{},"3276":{},"3277":{},"3278":{},"3279":{},"3280":{},"3281":{},"3282":{},"3283":{},"3284":{},"3285":{},"3286":{},"3287":{},"3288":{},"3289":{},"3290":{},"3291":{},"3292":{},"3293":{},"3294":{},"3295":{},"3296":{},"3297":{},"3298":{},"3299":{},"3300":{},"3301":{},"3302":{},"3303":{},"3304":{},"3305":{},"3306":{},"3307":{},"3308":{}}}],["zowe/imperative.basicprofilemanagerfactory",{"_index":2525,"name":{},"parent":{"3312":{},"3313":{},"3314":{},"3315":{},"3316":{},"3317":{}}}],["zowe/imperative.chainedhandlerservice",{"_index":2601,"name":{},"parent":{"3452":{}}}],["zowe/imperative.cliprofilemanager",{"_index":1943,"name":{},"parent":{"2380":{},"2381":{},"2382":{},"2383":{},"2384":{},"2385":{},"2386":{},"2387":{},"2388":{},"2389":{},"2390":{},"2391":{},"2392":{},"2393":{},"2394":{},"2395":{},"2396":{},"2397":{},"2398":{},"2399":{},"2400":{},"2401":{},"2402":{},"2403":{},"2404":{},"2405":{},"2406":{},"2407":{},"2408":{},"2409":{},"2410":{},"2411":{},"2412":{},"2413":{},"2414":{},"2415":{},"2416":{},"2417":{},"2418":{},"2419":{},"2420":{},"2421":{},"2422":{},"2423":{},"2424":{},"2425":{},"2426":{},"2427":{},"2428":{},"2429":{}}}],["zowe/imperative.cliutils",{"_index":2551,"name":{},"parent":{"3370":{},"3371":{},"3372":{},"3373":{},"3374":{},"3375":{},"3376":{},"3377":{},"3378":{},"3379":{},"3380":{},"3381":{},"3382":{},"3383":{},"3384":{},"3385":{},"3386":{},"3387":{},"3388":{},"3389":{}}}],["zowe/imperative.commandpreparer",{"_index":2001,"name":{},"parent":{"2451":{},"2452":{},"2453":{},"2454":{},"2455":{},"2456":{},"2457":{},"2458":{},"2459":{},"2460":{},"2461":{}}}],["zowe/imperative.commandprocessor",{"_index":1868,"name":{},"parent":{"2229":{},"2230":{},"2231":{},"2232":{},"2233":{},"2234":{},"2235":{},"2236":{},"2237":{},"2238":{},"2239":{},"2240":{},"2241":{},"2242":{},"2243":{},"2244":{},"2245":{},"2246":{},"2247":{},"2248":{},"2249":{},"2250":{},"2251":{},"2252":{},"2253":{},"2254":{},"2255":{},"2256":{},"2257":{},"2258":{},"2259":{},"2260":{},"2261":{},"2262":{},"2263":{},"2264":{}}}],["zowe/imperative.commandprofileloader",{"_index":1758,"name":{},"parent":{"2072":{},"2073":{},"2074":{},"2075":{},"2076":{},"2077":{},"2078":{},"2079":{},"2080":{},"2081":{},"2082":{},"2083":{},"2084":{},"2085":{}}}],["zowe/imperative.commandprofiles",{"_index":849,"name":{},"parent":{"932":{},"933":{},"934":{},"935":{},"936":{},"937":{},"938":{},"939":{},"940":{},"941":{}}}],["zowe/imperative.commandresponse",{"_index":1672,"name":{},"parent":{"1959":{},"1960":{},"1961":{},"1962":{},"1963":{},"1964":{},"1965":{},"1966":{},"1967":{},"1968":{},"1969":{},"1970":{},"1971":{},"1972":{},"1973":{},"1974":{},"1975":{},"1976":{},"1977":{},"1978":{},"1979":{},"1980":{},"1981":{},"1982":{},"1983":{},"1984":{},"1985":{},"1986":{},"1987":{},"1988":{},"1989":{},"1990":{},"1991":{},"1992":{},"1993":{},"1994":{},"1995":{},"1996":{},"1997":{},"1998":{},"1999":{},"2000":{},"2001":{},"2002":{},"2003":{},"2004":{},"2005":{}}}],["zowe/imperative.commandutils",{"_index":1464,"name":{},"parent":{"1730":{},"1731":{},"1732":{},"1733":{},"1734":{},"1735":{},"1736":{}}}],["zowe/imperative.commandyargs",{"_index":1897,"name":{},"parent":{"2274":{},"2275":{},"2276":{},"2277":{},"2278":{},"2279":{},"2280":{},"2281":{},"2282":{},"2283":{},"2284":{},"2285":{},"2286":{},"2287":{},"2288":{},"2289":{},"2290":{},"2291":{},"2292":{},"2293":{},"2294":{},"2295":{},"2296":{},"2297":{}}}],["zowe/imperative.completeauthgroupbuilder",{"_index":2079,"name":{},"parent":{"2632":{},"2633":{},"2638":{},"2645":{}}}],["zowe/imperative.completeauthgroupbuilder.defaultauthgroup",{"_index":2081,"name":{},"parent":{"2634":{},"2635":{},"2636":{},"2637":{}}}],["zowe/imperative.completeauthgroupbuilder.defaultlogingroup",{"_index":2083,"name":{},"parent":{"2639":{},"2640":{},"2641":{},"2642":{},"2643":{},"2644":{}}}],["zowe/imperative.completeauthgroupbuilder.defaultlogoutgroup",{"_index":2085,"name":{},"parent":{"2646":{},"2647":{},"2648":{},"2649":{},"2650":{},"2651":{}}}],["zowe/imperative.completeautoinitcommandbuilder",{"_index":2110,"name":{},"parent":{"2713":{}}}],["zowe/imperative.completeprofilesgroupbuilder",{"_index":2048,"name":{},"parent":{"2575":{}}}],["zowe/imperative.compressionutils",{"_index":1140,"name":{},"parent":{"1334":{},"1335":{},"1336":{},"1337":{},"1338":{}}}],["zowe/imperative.config",{"_index":758,"name":{},"parent":{"811":{},"812":{},"813":{},"814":{},"815":{},"816":{},"817":{},"821":{},"822":{},"823":{},"829":{},"830":{},"831":{},"832":{},"833":{},"834":{},"835":{},"836":{},"837":{},"838":{},"839":{},"840":{},"841":{},"842":{},"843":{},"844":{},"845":{},"846":{},"847":{},"848":{},"849":{},"850":{},"851":{},"852":{},"853":{},"854":{},"855":{},"856":{},"857":{}}}],["zowe/imperative.config.mactive",{"_index":765,"name":{},"parent":{"818":{}}}],["zowe/imperative.config.mactive.__type",{"_index":766,"name":{},"parent":{"819":{},"820":{}}}],["zowe/imperative.config.mapi",{"_index":770,"name":{},"parent":{"824":{}}}],["zowe/imperative.config.mapi.__type",{"_index":771,"name":{},"parent":{"825":{},"826":{},"827":{},"828":{}}}],["zowe/imperative.configapi",{"_index":628,"name":{},"parent":{"638":{},"639":{}}}],["zowe/imperative.configautostore",{"_index":1274,"name":{},"parent":{"1521":{},"1522":{},"1523":{},"1524":{},"1525":{},"1526":{},"1527":{},"1528":{}}}],["zowe/imperative.configbuilder",{"_index":2167,"name":{},"parent":{"2793":{},"2794":{},"2795":{},"2796":{},"2797":{}}}],["zowe/imperative.configconstants",{"_index":590,"name":{},"parent":{"598":{},"599":{},"600":{},"601":{}}}],["zowe/imperative.configlayers",{"_index":631,"name":{},"parent":{"641":{},"642":{},"643":{},"644":{},"645":{},"646":{},"647":{},"648":{},"649":{}}}],["zowe/imperative.configmanagementfacility",{"_index":2627,"name":{},"parent":{"3552":{},"3553":{},"3554":{},"3555":{}}}],["zowe/imperative.configplugins",{"_index":639,"name":{},"parent":{"651":{},"652":{},"653":{}}}],["zowe/imperative.configprofiles",{"_index":641,"name":{},"parent":{"655":{},"656":{},"657":{},"658":{},"659":{},"660":{},"661":{},"662":{},"663":{},"664":{},"665":{},"666":{}}}],["zowe/imperative.configschema",{"_index":1284,"name":{},"parent":{"1530":{},"1531":{},"1532":{},"1541":{},"1542":{},"1543":{},"1544":{},"1545":{},"1546":{},"1547":{},"1548":{},"1549":{}}}],["zowe/imperative.configschema.explainschemasummary",{"_index":1287,"name":{},"parent":{"1533":{},"1534":{},"1535":{},"1539":{},"1540":{}}}],["zowe/imperative.configschema.explainschemasummary.properties",{"_index":1288,"name":{},"parent":{"1536":{},"1537":{},"1538":{}}}],["zowe/imperative.configsecure",{"_index":720,"name":{},"parent":{"768":{},"769":{},"770":{},"771":{},"772":{},"773":{},"774":{},"775":{},"776":{},"777":{},"778":{},"779":{},"780":{},"781":{}}}],["zowe/imperative.configurationloader",{"_index":1308,"name":{},"parent":{"1563":{}}}],["zowe/imperative.configurationvalidator",{"_index":1311,"name":{},"parent":{"1565":{},"1566":{}}}],["zowe/imperative.configutils",{"_index":714,"name":{},"parent":{"763":{},"764":{},"765":{},"766":{}}}],["zowe/imperative.connectionpropsforsesscfg",{"_index":1222,"name":{},"parent":{"1457":{},"1458":{},"1459":{},"1460":{},"1461":{},"1466":{},"1467":{},"1468":{},"1469":{},"1470":{},"1471":{},"1472":{}}}],["zowe/imperative.connectionpropsforsesscfg.prompttextforvalues",{"_index":1227,"name":{},"parent":{"1462":{},"1463":{},"1464":{},"1465":{}}}],["zowe/imperative.console",{"_index":417,"name":{},"parent":{"411":{},"412":{},"413":{},"414":{},"415":{},"416":{},"417":{},"418":{},"419":{},"420":{},"421":{},"422":{},"423":{},"424":{},"425":{},"426":{},"427":{},"428":{},"429":{},"430":{},"431":{},"432":{},"433":{},"434":{},"435":{},"436":{},"437":{},"438":{},"439":{},"440":{},"441":{},"442":{},"443":{},"444":{},"445":{}}}],["zowe/imperative.constants",{"_index":473,"name":{},"parent":{"473":{},"474":{},"475":{},"476":{},"477":{},"478":{},"479":{},"480":{},"481":{},"482":{},"483":{},"484":{},"485":{},"486":{},"487":{},"488":{},"489":{},"490":{},"491":{},"492":{},"493":{},"494":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"504":{},"505":{},"506":{},"507":{},"508":{},"509":{},"510":{},"511":{},"512":{},"513":{},"514":{},"515":{},"516":{},"517":{},"518":{},"519":{},"520":{},"521":{},"522":{},"523":{},"524":{},"525":{},"526":{},"527":{},"528":{},"529":{},"530":{},"531":{},"532":{},"533":{},"534":{}}}],["zowe/imperative.convertprofilesdefinition",{"_index":2621,"name":{},"parent":{"3525":{},"3526":{},"3527":{},"3528":{},"3529":{},"3530":{},"3531":{},"3532":{}}}],["zowe/imperative.convertprofileshandler",{"_index":2641,"name":{},"parent":{"3569":{},"3570":{},"3571":{},"3572":{},"3573":{},"3574":{},"3575":{},"3576":{},"3577":{},"3578":{}}}],["zowe/imperative.couldnotinstantiatecommandhandler",{"_index":1482,"name":{},"parent":{"1747":{}}}],["zowe/imperative.createprofilecommanddesc",{"_index":1504,"name":{},"parent":{"1769":{}}}],["zowe/imperative.createprofiledisabledefaultsdesc",{"_index":1526,"name":{},"parent":{"1791":{}}}],["zowe/imperative.createprofileoptiondesc",{"_index":1506,"name":{},"parent":{"1771":{}}}],["zowe/imperative.createprofileoptionoverwritedesc",{"_index":1524,"name":{},"parent":{"1789":{}}}],["zowe/imperative.createprofilescommanddesc",{"_index":1502,"name":{},"parent":{"1767":{}}}],["zowe/imperative.createprofilescommandsummary",{"_index":1500,"name":{},"parent":{"1765":{}}}],["zowe/imperative.createprofileshandler",{"_index":2760,"name":{},"parent":{"3761":{}}}],["zowe/imperative.credentialmanagerfactory",{"_index":686,"name":{},"parent":{"738":{},"739":{},"740":{},"741":{}}}],["zowe/imperative.credentialmanageroverride",{"_index":700,"name":{},"parent":{"750":{},"751":{},"752":{},"753":{},"754":{},"755":{},"756":{},"757":{},"758":{},"759":{}}}],["zowe/imperative.daemonrequest",{"_index":584,"name":{},"parent":{"592":{},"593":{},"594":{},"595":{},"596":{}}}],["zowe/imperative.defaultcredentialmanager",{"_index":667,"name":{},"parent":{"689":{},"690":{},"691":{},"692":{},"693":{},"694":{},"695":{},"696":{},"697":{},"698":{},"699":{},"700":{},"701":{},"702":{},"703":{},"704":{},"705":{},"706":{},"707":{},"708":{},"709":{},"710":{},"711":{}}}],["zowe/imperative.defaulthelpgenerator",{"_index":1817,"name":{},"parent":{"2145":{},"2146":{},"2147":{},"2148":{},"2149":{},"2150":{},"2151":{},"2152":{},"2153":{},"2154":{},"2155":{},"2156":{},"2157":{},"2158":{},"2159":{},"2160":{},"2161":{},"2162":{},"2163":{},"2164":{},"2165":{},"2166":{},"2167":{},"2168":{},"2169":{},"2170":{},"2171":{},"2172":{},"2173":{},"2174":{},"2175":{},"2177":{},"2179":{},"2180":{},"2181":{},"2182":{},"2183":{},"2184":{},"2185":{},"2186":{}}}],["zowe/imperative.defaulthelpgenerator.grouptooption",{"_index":1832,"name":{},"parent":{"2176":{}}}],["zowe/imperative.defaulthelpgenerator.optiontodescription",{"_index":1833,"name":{},"parent":{"2178":{}}}],["zowe/imperative.defaultrootcommandhandler",{"_index":2722,"name":{},"parent":{"3655":{}}}],["zowe/imperative.definitiontreeresolver",{"_index":1315,"name":{},"parent":{"1568":{},"1569":{},"1570":{},"1571":{}}}],["zowe/imperative.deleteprofileactiondesc",{"_index":1534,"name":{},"parent":{"1799":{}}}],["zowe/imperative.deleteprofilecommanddesc",{"_index":1536,"name":{},"parent":{"1801":{}}}],["zowe/imperative.deleteprofiledepsdesc",{"_index":1538,"name":{},"parent":{"1803":{}}}],["zowe/imperative.deleteprofileexample",{"_index":1518,"name":{},"parent":{"1783":{}}}],["zowe/imperative.deleteprofileforceoptiondesc",{"_index":1532,"name":{},"parent":{"1797":{}}}],["zowe/imperative.deleteprofilenamedesc",{"_index":1516,"name":{},"parent":{"1781":{}}}],["zowe/imperative.deleteprofilescommanddesc",{"_index":1530,"name":{},"parent":{"1795":{}}}],["zowe/imperative.deleteprofilescommandsummary",{"_index":1528,"name":{},"parent":{"1793":{}}}],["zowe/imperative.detailprofilecommanddesc",{"_index":1558,"name":{},"parent":{"1823":{}}}],["zowe/imperative.diffutils",{"_index":2401,"name":{},"parent":{"3070":{},"3071":{}}}],["zowe/imperative.editdefinition",{"_index":2617,"name":{},"parent":{"3508":{},"3509":{},"3510":{},"3511":{},"3512":{},"3513":{},"3514":{}}}],["zowe/imperative.edithandler",{"_index":2650,"name":{},"parent":{"3580":{}}}],["zowe/imperative.envfileutils",{"_index":2113,"name":{},"parent":{"2715":{},"2716":{},"2717":{},"2718":{},"2719":{},"2720":{}}}],["zowe/imperative.environmentalvariablesettings",{"_index":537,"name":{},"parent":{"536":{},"537":{},"538":{},"539":{},"540":{},"541":{},"542":{}}}],["zowe/imperative.envquery",{"_index":2694,"name":{},"parent":{"3625":{},"3626":{},"3627":{},"3628":{},"3629":{},"3630":{},"3631":{},"3632":{},"3633":{},"3634":{},"3635":{},"3636":{},"3637":{},"3638":{},"3639":{}}}],["zowe/imperative.errordetailsheader",{"_index":1484,"name":{},"parent":{"1749":{}}}],["zowe/imperative.executils",{"_index":372,"name":{},"parent":{"369":{}}}],["zowe/imperative.failedcommandhandler",{"_index":2539,"name":{},"parent":{"3339":{}}}],["zowe/imperative.firststepsdefinition",{"_index":2736,"name":{},"parent":{"3679":{},"3680":{},"3681":{},"3682":{},"3683":{},"3684":{},"3685":{},"3686":{}}}],["zowe/imperative.firststepshandler",{"_index":2738,"name":{},"parent":{"3688":{},"3689":{}}}],["zowe/imperative.groupcommandyargs",{"_index":1914,"name":{},"parent":{"2299":{},"2300":{},"2301":{},"2302":{},"2303":{},"2304":{},"2305":{},"2306":{},"2307":{},"2308":{},"2309":{},"2310":{},"2311":{},"2312":{},"2313":{},"2314":{},"2315":{},"2316":{},"2317":{},"2318":{},"2319":{}}}],["zowe/imperative.guiresult",{"_index":2370,"name":{},"parent":{"3041":{},"3042":{},"3043":{}}}],["zowe/imperative.handlerresponse",{"_index":2548,"name":{},"parent":{"3363":{},"3364":{},"3365":{},"3366":{},"3367":{},"3368":{}}}],["zowe/imperative.headers",{"_index":1106,"name":{},"parent":{"1291":{},"1292":{},"1293":{},"1294":{},"1295":{},"1297":{},"1299":{},"1301":{},"1303":{},"1305":{}}}],["zowe/imperative.headers.application_json",{"_index":1111,"name":{},"parent":{"1296":{}}}],["zowe/imperative.headers.basic_authorization",{"_index":1118,"name":{},"parent":{"1304":{}}}],["zowe/imperative.headers.cookie_authorization",{"_index":1121,"name":{},"parent":{"1306":{}}}],["zowe/imperative.headers.octet_stream",{"_index":1115,"name":{},"parent":{"1302":{}}}],["zowe/imperative.headers.text_plain",{"_index":1112,"name":{},"parent":{"1298":{}}}],["zowe/imperative.headers.text_plain_utf8",{"_index":1114,"name":{},"parent":{"1300":{}}}],["zowe/imperative.helpconstants",{"_index":2545,"name":{},"parent":{"3353":{}}}],["zowe/imperative.helpgeneratorfactory",{"_index":2546,"name":{},"parent":{"3355":{},"3356":{},"3357":{},"3358":{},"3359":{},"3360":{},"3361":{}}}],["zowe/imperative.iaddproftyperesult",{"_index":2250,"name":{},"parent":{"2899":{}}}],["zowe/imperative.iaddproftyperesult.__type",{"_index":2251,"name":{},"parent":{"2900":{},"2901":{}}}],["zowe/imperative.iapimlsvcattrs",{"_index":1299,"name":{},"parent":{"1551":{},"1552":{},"1553":{}}}],["zowe/imperative.iargteamconfigloc",{"_index":2192,"name":{},"parent":{"2821":{},"2822":{},"2823":{},"2824":{}}}],["zowe/imperative.iauthhandlerapi",{"_index":1236,"name":{},"parent":{"1474":{},"1475":{},"1477":{},"1479":{}}}],["zowe/imperative.iauthhandlerapi.createsesscfg",{"_index":1238,"name":{},"parent":{"1476":{}}}],["zowe/imperative.iauthhandlerapi.sessionlogin",{"_index":1240,"name":{},"parent":{"1478":{}}}],["zowe/imperative.iauthhandlerapi.sessionlogout",{"_index":1242,"name":{},"parent":{"1480":{}}}],["zowe/imperative.ichainedhandlerargumentmapping",{"_index":294,"name":{},"parent":{"299":{},"300":{},"301":{},"302":{},"303":{},"304":{}}}],["zowe/imperative.ichainedhandlerentry",{"_index":302,"name":{},"parent":{"306":{},"307":{},"308":{}}}],["zowe/imperative.icliloadallprofiles",{"_index":1940,"name":{},"parent":{"2377":{},"2378":{}}}],["zowe/imperative.icliloadprofile",{"_index":1935,"name":{},"parent":{"2371":{},"2372":{},"2373":{},"2374":{},"2375":{}}}],["zowe/imperative.icommandarguments",{"_index":1001,"name":{},"parent":{"1125":{},"1126":{}}}],["zowe/imperative.icommanddefinition",{"_index":829,"name":{},"parent":{"908":{},"909":{},"910":{},"911":{},"912":{},"913":{},"914":{},"915":{},"916":{},"917":{},"918":{},"919":{},"920":{},"921":{},"922":{},"923":{},"924":{},"925":{},"926":{},"927":{},"928":{}}}],["zowe/imperative.icommanddefinitionpasson",{"_index":823,"name":{},"parent":{"899":{},"900":{},"901":{},"902":{}}}],["zowe/imperative.icommanddefinitionpassonignore",{"_index":820,"name":{},"parent":{"896":{},"897":{}}}],["zowe/imperative.icommandexampledefinition",{"_index":795,"name":{},"parent":{"859":{},"860":{},"861":{}}}],["zowe/imperative.icommandhandler",{"_index":1012,"name":{},"parent":{"1137":{}}}],["zowe/imperative.icommandhandlerconstructor",{"_index":1014,"name":{},"parent":{"1139":{}}}],["zowe/imperative.icommandhandlerrequire",{"_index":1017,"name":{},"parent":{"1141":{}}}],["zowe/imperative.icommandhandlerresponsechecker",{"_index":2535,"name":{},"parent":{"3335":{}}}],["zowe/imperative.icommandhandlerresponsevalidator",{"_index":2537,"name":{},"parent":{"3337":{}}}],["zowe/imperative.icommandloadprofile",{"_index":1748,"name":{},"parent":{"2062":{},"2063":{},"2064":{},"2065":{},"2066":{}}}],["zowe/imperative.icommandoptionallowablevalues",{"_index":797,"name":{},"parent":{"863":{},"864":{}}}],["zowe/imperative.icommandoptiondefinition",{"_index":804,"name":{},"parent":{"869":{},"870":{},"871":{},"872":{},"873":{},"874":{},"875":{},"876":{},"877":{},"878":{},"879":{},"880":{},"881":{},"882":{},"883":{},"884":{},"885":{}}}],["zowe/imperative.icommandoptiondefinition.valueimplications",{"_index":814,"name":{},"parent":{"886":{}}}],["zowe/imperative.icommandoptionvalueimplications",{"_index":801,"name":{},"parent":{"866":{},"867":{}}}],["zowe/imperative.icommandoutputformat",{"_index":991,"name":{},"parent":{"1111":{},"1112":{},"1113":{},"1114":{}}}],["zowe/imperative.icommandpositionaldefinition",{"_index":817,"name":{},"parent":{"889":{},"890":{},"891":{},"892":{},"893":{},"894":{}}}],["zowe/imperative.icommandprepared",{"_index":1771,"name":{},"parent":{"2089":{},"2090":{}}}],["zowe/imperative.icommandprocessorparms",{"_index":1775,"name":{},"parent":{"2096":{},"2097":{},"2098":{},"2099":{},"2100":{},"2101":{},"2102":{},"2103":{},"2104":{},"2105":{}}}],["zowe/imperative.icommandprofile",{"_index":826,"name":{},"parent":{"904":{},"905":{},"906":{}}}],["zowe/imperative.icommandprofileauthconfig",{"_index":1022,"name":{},"parent":{"1148":{},"1149":{},"1150":{},"1151":{}}}],["zowe/imperative.icommandprofileautoinitconfig",{"_index":2087,"name":{},"parent":{"2653":{},"2654":{},"2655":{},"2656":{}}}],["zowe/imperative.icommandprofileloaderparms",{"_index":1753,"name":{},"parent":{"2068":{},"2069":{},"2070":{}}}],["zowe/imperative.icommandprofileproperty",{"_index":2529,"name":{},"parent":{"3319":{},"3320":{},"3321":{},"3322":{},"3323":{},"3324":{},"3325":{}}}],["zowe/imperative.icommandprofileschema",{"_index":2532,"name":{},"parent":{"3327":{},"3329":{},"3330":{},"3331":{},"3332":{},"3333":{}}}],["zowe/imperative.icommandprofileschema.properties",{"_index":2533,"name":{},"parent":{"3328":{}}}],["zowe/imperative.icommandprofiletypeconfiguration",{"_index":1744,"name":{},"parent":{"2052":{},"2053":{},"2054":{},"2055":{},"2056":{},"2057":{},"2058":{},"2059":{},"2060":{}}}],["zowe/imperative.icommandresponse",{"_index":1645,"name":{},"parent":{"1909":{},"1910":{},"1911":{},"1912":{},"1913":{},"1914":{},"1915":{}}}],["zowe/imperative.icommandresponseapi",{"_index":1648,"name":{},"parent":{"1917":{},"1918":{},"1919":{},"1920":{},"1921":{},"1922":{},"1923":{},"1924":{}}}],["zowe/imperative.icommandresponseparms",{"_index":1656,"name":{},"parent":{"1927":{},"1928":{},"1929":{},"1930":{},"1931":{},"1932":{},"1933":{}}}],["zowe/imperative.icommandtreeentry",{"_index":1459,"name":{},"parent":{"1726":{},"1727":{},"1728":{}}}],["zowe/imperative.icommandvalidatorerror",{"_index":1705,"name":{},"parent":{"2010":{},"2011":{},"2012":{}}}],["zowe/imperative.icommandvalidatorresponse",{"_index":1474,"name":{},"parent":{"1739":{}}}],["zowe/imperative.iconfig",{"_index":600,"name":{},"parent":{"610":{},"611":{},"613":{},"615":{},"616":{}}}],["zowe/imperative.iconfig.defaults",{"_index":602,"name":{},"parent":{"612":{}}}],["zowe/imperative.iconfig.profiles",{"_index":603,"name":{},"parent":{"614":{}}}],["zowe/imperative.iconfigautostorefindactiveprofileopts",{"_index":1255,"name":{},"parent":{"1492":{},"1493":{},"1494":{},"1495":{}}}],["zowe/imperative.iconfigautostorefindauthhandlerforprofileopts",{"_index":1261,"name":{},"parent":{"1497":{},"1498":{},"1499":{},"1500":{},"1501":{},"1502":{},"1503":{},"1504":{}}}],["zowe/imperative.iconfigautostorestoresesscfgpropsopts",{"_index":1266,"name":{},"parent":{"1506":{},"1508":{},"1509":{},"1510":{},"1511":{},"1512":{},"1513":{},"1514":{},"1515":{},"1516":{},"1517":{},"1518":{},"1519":{}}}],["zowe/imperative.iconfigautostorestoresesscfgpropsopts.sesscfg",{"_index":1267,"name":{},"parent":{"1507":{}}}],["zowe/imperative.iconfigbuilderopts",{"_index":2159,"name":{},"parent":{"2785":{},"2786":{}}}],["zowe/imperative.iconfigconvertresult",{"_index":2162,"name":{},"parent":{"2788":{},"2789":{},"2791":{}}}],["zowe/imperative.iconfigconvertresult.profilesconverted",{"_index":2164,"name":{},"parent":{"2790":{}}}],["zowe/imperative.iconfiglayer",{"_index":608,"name":{},"parent":{"618":{},"619":{},"620":{},"621":{},"622":{}}}],["zowe/imperative.iconfiglogging",{"_index":327,"name":{},"parent":{"328":{}}}],["zowe/imperative.iconfigmergeopts",{"_index":754,"name":{},"parent":{"807":{},"808":{},"809":{}}}],["zowe/imperative.iconfigopts",{"_index":619,"name":{},"parent":{"629":{},"630":{},"631":{},"632":{}}}],["zowe/imperative.iconfigprofile",{"_index":595,"name":{},"parent":{"603":{},"605":{},"606":{},"608":{}}}],["zowe/imperative.iconfigprofile.profiles",{"_index":598,"name":{},"parent":{"607":{}}}],["zowe/imperative.iconfigprofile.properties",{"_index":596,"name":{},"parent":{"604":{}}}],["zowe/imperative.iconfigschema",{"_index":731,"name":{},"parent":{"783":{},"784":{},"785":{},"786":{},"787":{}}}],["zowe/imperative.iconfigschema.properties",{"_index":732,"name":{},"parent":{"788":{}}}],["zowe/imperative.iconfigschemainfo",{"_index":735,"name":{},"parent":{"790":{},"791":{},"792":{}}}],["zowe/imperative.iconfigsecure",{"_index":626,"name":{},"parent":{"636":{}}}],["zowe/imperative.iconfigsecureproperties",{"_index":624,"name":{},"parent":{"634":{}}}],["zowe/imperative.iconfigupdateschemahelperoptions",{"_index":744,"name":{},"parent":{"799":{},"800":{},"801":{},"802":{}}}],["zowe/imperative.iconfigupdateschemaoptions",{"_index":741,"name":{},"parent":{"795":{},"796":{},"797":{}}}],["zowe/imperative.iconfigvault",{"_index":613,"name":{},"parent":{"624":{},"626":{}}}],["zowe/imperative.iconfigvault.load",{"_index":614,"name":{},"parent":{"625":{}}}],["zowe/imperative.iconfigvault.save",{"_index":616,"name":{},"parent":{"627":{}}}],["zowe/imperative.iconsole",{"_index":408,"name":{},"parent":{"403":{},"404":{},"405":{},"406":{},"407":{},"408":{},"409":{}}}],["zowe/imperative.iconstructor",{"_index":352,"name":{},"parent":{"351":{}}}],["zowe/imperative.icredentialmanagerconstructor",{"_index":711,"name":{},"parent":{"761":{}}}],["zowe/imperative.icredentialmanagerinit",{"_index":662,"name":{},"parent":{"684":{},"685":{},"686":{},"687":{}}}],["zowe/imperative.icredentialmanagernamemap",{"_index":691,"name":{},"parent":{"743":{},"744":{},"745":{}}}],["zowe/imperative.idaemoncontext",{"_index":1301,"name":{},"parent":{"1555":{},"1556":{},"1557":{}}}],["zowe/imperative.idaemonrequest",{"_index":569,"name":{},"parent":{"578":{},"579":{},"580":{},"581":{},"582":{},"583":{}}}],["zowe/imperative.idaemonresponse",{"_index":577,"name":{},"parent":{"585":{},"586":{},"587":{},"588":{},"589":{},"590":{}}}],["zowe/imperative.ideleteprofile",{"_index":2444,"name":{},"parent":{"3156":{},"3157":{}}}],["zowe/imperative.idiffnameoptions",{"_index":2383,"name":{},"parent":{"3052":{},"3053":{}}}],["zowe/imperative.idiffoptions",{"_index":2387,"name":{},"parent":{"3055":{},"3056":{},"3057":{},"3058":{}}}],["zowe/imperative.iexplanationmap",{"_index":330,"name":{},"parent":{"330":{},"331":{}}}],["zowe/imperative.iextendersjsonopts",{"_index":2247,"name":{},"parent":{"2896":{}}}],["zowe/imperative.iextendersjsonopts.__type",{"_index":2248,"name":{},"parent":{"2897":{}}}],["zowe/imperative.iextendertypeinfo",{"_index":2253,"name":{},"parent":{"2903":{}}}],["zowe/imperative.iextendertypeinfo.__type",{"_index":2255,"name":{},"parent":{"2904":{},"2905":{}}}],["zowe/imperative.igetallprofilesoptions",{"_index":2241,"name":{},"parent":{"2888":{}}}],["zowe/imperative.igetitemopts",{"_index":2691,"name":{},"parent":{"3623":{}}}],["zowe/imperative.igetitemval",{"_index":2686,"name":{},"parent":{"3619":{},"3620":{},"3621":{}}}],["zowe/imperative.ihandlerformatoutputapi",{"_index":995,"name":{},"parent":{"1117":{}}}],["zowe/imperative.ihandlerformatoutputapi.output",{"_index":996,"name":{},"parent":{"1118":{}}}],["zowe/imperative.ihandlerparameters",{"_index":1005,"name":{},"parent":{"1128":{},"1129":{},"1130":{},"1131":{},"1132":{},"1133":{},"1134":{},"1135":{}}}],["zowe/imperative.ihandlerprogressapi",{"_index":988,"name":{},"parent":{"1108":{},"1109":{}}}],["zowe/imperative.ihandlerresponseapi",{"_index":998,"name":{},"parent":{"1120":{},"1121":{},"1122":{},"1123":{}}}],["zowe/imperative.ihandlerresponseconsoleapi",{"_index":863,"name":{},"parent":{"947":{},"948":{},"949":{},"950":{}}}],["zowe/imperative.ihandlerresponsedataapi",{"_index":867,"name":{},"parent":{"952":{},"953":{},"954":{}}}],["zowe/imperative.ihelpgenerator",{"_index":1769,"name":{},"parent":{"2087":{}}}],["zowe/imperative.ihelpgeneratorfactory",{"_index":1917,"name":{},"parent":{"2321":{}}}],["zowe/imperative.ihelpgeneratorfactoryparms",{"_index":1791,"name":{},"parent":{"2115":{},"2116":{},"2117":{}}}],["zowe/imperative.ihelpgeneratorparms",{"_index":1786,"name":{},"parent":{"2110":{},"2111":{},"2112":{},"2113":{}}}],["zowe/imperative.ihttpsoptions",{"_index":1026,"name":{},"parent":{"1155":{},"1156":{},"1157":{},"1158":{},"1159":{},"1160":{},"1161":{},"1162":{},"1163":{}}}],["zowe/imperative.iimperativeapi",{"_index":1340,"name":{},"parent":{"1593":{},"1594":{}}}],["zowe/imperative.iimperativeauthgroupconfig",{"_index":2074,"name":{},"parent":{"2628":{},"2629":{},"2630":{}}}],["zowe/imperative.iimperativeconfig",{"_index":2322,"name":{},"parent":{"2975":{},"2976":{},"2977":{},"2978":{},"2979":{},"2980":{},"2981":{},"2982":{},"2983":{},"2984":{},"2985":{},"2986":{},"2987":{},"2988":{},"2989":{},"2990":{},"2991":{},"2992":{},"2993":{},"2994":{},"2995":{},"2996":{},"2997":{},"2998":{},"2999":{},"3000":{},"3001":{},"3002":{},"3003":{},"3004":{},"3005":{}}}],["zowe/imperative.iimperativeenvironmentalvariablesetting",{"_index":462,"name":{},"parent":{"463":{},"464":{}}}],["zowe/imperative.iimperativeenvironmentalvariablesettings",{"_index":465,"name":{},"parent":{"466":{},"467":{},"468":{},"469":{},"470":{},"471":{}}}],["zowe/imperative.iimperativeerror",{"_index":307,"name":{},"parent":{"310":{},"311":{},"312":{},"313":{},"314":{},"315":{}}}],["zowe/imperative.iimperativeerrorparms",{"_index":2596,"name":{},"parent":{"3436":{},"3437":{}}}],["zowe/imperative.iimperativeloggingconfig",{"_index":1305,"name":{},"parent":{"1559":{},"1560":{},"1561":{}}}],["zowe/imperative.iimperativelogsconfig",{"_index":2317,"name":{},"parent":{"2971":{},"2972":{},"2973":{}}}],["zowe/imperative.iinvokecommandparms",{"_index":1773,"name":{},"parent":{"2092":{},"2093":{},"2094":{}}}],["zowe/imperative.iloadallprofiles",{"_index":2447,"name":{},"parent":{"3159":{},"3160":{}}}],["zowe/imperative.iloadprofile",{"_index":2449,"name":{},"parent":{"3162":{},"3163":{},"3164":{},"3165":{},"3166":{}}}],["zowe/imperative.ilog4jsappender",{"_index":317,"name":{},"parent":{"320":{},"321":{}}}],["zowe/imperative.ilog4jsconfig",{"_index":321,"name":{},"parent":{"323":{},"325":{}}}],["zowe/imperative.ilog4jsconfig.appenders",{"_index":322,"name":{},"parent":{"324":{}}}],["zowe/imperative.ilog4jsconfig.categories",{"_index":324,"name":{},"parent":{"326":{}}}],["zowe/imperative.ilog4jslayout",{"_index":314,"name":{},"parent":{"317":{},"318":{}}}],["zowe/imperative.imessagedefinition",{"_index":1476,"name":{},"parent":{"1741":{},"1742":{}}}],["zowe/imperative.imessagedefinition.locales",{"_index":1478,"name":{},"parent":{"1743":{}}}],["zowe/imperative.imetaprofile",{"_index":2405,"name":{},"parent":{"3073":{},"3074":{}}}],["zowe/imperative.imperative",{"_index":2121,"name":{},"parent":{"2722":{},"2723":{},"2724":{},"2725":{},"2726":{},"2727":{},"2728":{},"2729":{},"2730":{},"2731":{},"2732":{},"2733":{},"2734":{},"2735":{},"2736":{},"2737":{},"2738":{},"2739":{},"2740":{},"2741":{},"2742":{},"2743":{},"2744":{},"2745":{},"2746":{},"2747":{},"2748":{},"2749":{},"2750":{},"2751":{},"2752":{},"2753":{}}}],["zowe/imperative.imperativeapi",{"_index":1343,"name":{},"parent":{"1596":{},"1597":{},"1599":{},"1600":{},"1601":{},"1602":{},"1603":{},"1604":{},"1605":{},"1606":{},"1607":{}}}],["zowe/imperative.imperativeapi.mcustomloggermap",{"_index":1345,"name":{},"parent":{"1598":{}}}],["zowe/imperative.imperativeconfig",{"_index":2345,"name":{},"parent":{"3007":{},"3008":{},"3009":{},"3010":{},"3011":{},"3012":{},"3013":{},"3014":{},"3015":{},"3016":{},"3017":{},"3018":{},"3019":{},"3020":{},"3021":{},"3022":{},"3023":{},"3024":{},"3025":{},"3026":{},"3027":{},"3028":{},"3029":{},"3030":{},"3031":{}}}],["zowe/imperative.imperativeerror",{"_index":2598,"name":{},"parent":{"3439":{},"3440":{},"3441":{},"3442":{},"3443":{},"3444":{},"3445":{},"3446":{},"3447":{},"3448":{},"3449":{},"3450":{}}}],["zowe/imperative.imperativeexpect",{"_index":355,"name":{},"parent":{"353":{},"354":{},"355":{},"356":{},"357":{},"358":{},"359":{},"360":{},"361":{},"362":{},"363":{},"364":{},"365":{},"366":{},"367":{}}}],["zowe/imperative.imperativehelpgeneratorfactory",{"_index":2050,"name":{},"parent":{"2577":{},"2578":{},"2579":{},"2580":{},"2581":{},"2582":{},"2583":{},"2584":{},"2585":{}}}],["zowe/imperative.imperativeprofilemanagerfactory",{"_index":2062,"name":{},"parent":{"2594":{},"2595":{},"2596":{}}}],["zowe/imperative.imperativereject",{"_index":350,"name":{},"parent":{"349":{}}}],["zowe/imperative.importdefinition",{"_index":2619,"name":{},"parent":{"3516":{},"3517":{},"3518":{},"3519":{},"3520":{},"3521":{},"3522":{},"3523":{}}}],["zowe/imperative.importhandler",{"_index":2652,"name":{},"parent":{"3582":{},"3583":{},"3584":{},"3585":{},"3586":{}}}],["zowe/imperative.initdefinition",{"_index":2607,"name":{},"parent":{"3469":{},"3470":{},"3471":{},"3472":{},"3473":{},"3474":{},"3475":{}}}],["zowe/imperative.inithandler",{"_index":2656,"name":{},"parent":{"3588":{},"3589":{},"3590":{},"3591":{},"3592":{},"3593":{}}}],["zowe/imperative.installdefinition",{"_index":2731,"name":{},"parent":{"3666":{},"3667":{},"3668":{},"3669":{},"3670":{},"3671":{},"3672":{},"3673":{}}}],["zowe/imperative.installhandler",{"_index":2734,"name":{},"parent":{"3676":{},"3677":{}}}],["zowe/imperative.invalidcredentialmanager",{"_index":683,"name":{},"parent":{"724":{},"725":{},"726":{},"727":{},"728":{},"729":{},"730":{},"731":{},"732":{},"733":{},"734":{},"735":{},"736":{}}}],["zowe/imperative.io",{"_index":375,"name":{},"parent":{"371":{},"372":{},"373":{},"374":{},"375":{},"376":{},"377":{},"378":{},"379":{},"380":{},"381":{},"382":{},"383":{},"384":{},"385":{},"386":{},"387":{},"388":{},"389":{},"390":{},"391":{},"392":{},"393":{},"394":{},"395":{},"396":{},"397":{}}}],["zowe/imperative.ioperationcompleted",{"_index":946,"name":{},"parent":{"1032":{}}}],["zowe/imperative.ioperationresult",{"_index":952,"name":{},"parent":{"1038":{},"1039":{},"1040":{},"1041":{},"1042":{},"1043":{},"1044":{},"1045":{},"1046":{},"1047":{},"1048":{},"1049":{},"1050":{},"1051":{},"1052":{}}}],["zowe/imperative.ioperationresultready",{"_index":950,"name":{},"parent":{"1036":{}}}],["zowe/imperative.ioperationundocompleted",{"_index":948,"name":{},"parent":{"1034":{}}}],["zowe/imperative.ioptionformat",{"_index":546,"name":{},"parent":{"544":{},"545":{},"546":{}}}],["zowe/imperative.ioptionsforaddconnprops",{"_index":1213,"name":{},"parent":{"1448":{},"1449":{},"1450":{},"1451":{},"1452":{},"1453":{},"1454":{},"1455":{}}}],["zowe/imperative.ioptionsfullresponse",{"_index":1033,"name":{},"parent":{"1166":{},"1167":{},"1168":{},"1169":{},"1170":{},"1171":{},"1172":{},"1173":{},"1174":{}}}],["zowe/imperative.ioverridepromptconnprops",{"_index":1208,"name":{},"parent":{"1444":{},"1445":{},"1446":{}}}],["zowe/imperative.ipartialcommanddefinition",{"_index":1019,"name":{},"parent":{"1143":{},"1144":{},"1145":{},"1146":{}}}],["zowe/imperative.iplugincfgprops",{"_index":1384,"name":{},"parent":{"1640":{},"1641":{},"1642":{},"1643":{},"1644":{}}}],["zowe/imperative.ipluginissue",{"_index":1392,"name":{},"parent":{"1647":{},"1648":{}}}],["zowe/imperative.ipluginjsonobject",{"_index":1396,"name":{},"parent":{"1650":{},"1651":{},"1652":{}}}],["zowe/imperative.ipluginpeerdepends",{"_index":1381,"name":{},"parent":{"1637":{},"1638":{}}}],["zowe/imperative.iprobtest",{"_index":2680,"name":{},"parent":{"3614":{},"3615":{},"3616":{}}}],["zowe/imperative.iprofargattrs",{"_index":2197,"name":{},"parent":{"2826":{},"2827":{},"2828":{},"2829":{},"2830":{},"2831":{}}}],["zowe/imperative.iprofattrs",{"_index":2205,"name":{},"parent":{"2835":{},"2836":{},"2837":{},"2838":{}}}],["zowe/imperative.iprofile",{"_index":1984,"name":{},"parent":{"2431":{}}}],["zowe/imperative.iprofiledeleted",{"_index":2478,"name":{},"parent":{"3220":{},"3221":{},"3222":{}}}],["zowe/imperative.iprofiledependency",{"_index":562,"name":{},"parent":{"569":{},"570":{},"571":{}}}],["zowe/imperative.iprofileinitialized",{"_index":2481,"name":{},"parent":{"3224":{}}}],["zowe/imperative.iprofileloaded",{"_index":1986,"name":{},"parent":{"2433":{},"2434":{},"2435":{},"2436":{},"2437":{},"2438":{},"2439":{},"2440":{}}}],["zowe/imperative.iprofilemanager",{"_index":2451,"name":{},"parent":{"3168":{},"3169":{},"3170":{},"3171":{},"3172":{},"3173":{}}}],["zowe/imperative.iprofilemanagerfactory",{"_index":2442,"name":{},"parent":{"3154":{}}}],["zowe/imperative.iprofilemanagerinit",{"_index":2454,"name":{},"parent":{"3175":{},"3176":{},"3177":{}}}],["zowe/imperative.iprofileproperty",{"_index":557,"name":{},"parent":{"555":{},"556":{},"557":{},"558":{},"559":{}}}],["zowe/imperative.iprofilesaved",{"_index":2483,"name":{},"parent":{"3226":{},"3227":{},"3228":{},"3229":{}}}],["zowe/imperative.iprofileschema",{"_index":559,"name":{},"parent":{"561":{},"562":{},"563":{},"564":{},"566":{},"567":{}}}],["zowe/imperative.iprofileschema.properties",{"_index":560,"name":{},"parent":{"565":{}}}],["zowe/imperative.iprofiletypeconfiguration",{"_index":564,"name":{},"parent":{"573":{},"574":{},"575":{},"576":{}}}],["zowe/imperative.iprofileupdated",{"_index":2486,"name":{},"parent":{"3231":{},"3232":{},"3233":{}}}],["zowe/imperative.iprofilevalidated",{"_index":2488,"name":{},"parent":{"3235":{}}}],["zowe/imperative.iprofilevalidationplan",{"_index":2509,"name":{},"parent":{"3256":{},"3257":{}}}],["zowe/imperative.iprofilevalidationreport",{"_index":2504,"name":{},"parent":{"3251":{},"3252":{},"3253":{},"3254":{}}}],["zowe/imperative.iprofilevalidationtask",{"_index":2490,"name":{},"parent":{"3237":{},"3238":{},"3239":{},"3240":{},"3241":{}}}],["zowe/imperative.iprofilevalidationtaskfunction",{"_index":2496,"name":{},"parent":{"3244":{}}}],["zowe/imperative.iprofilevalidationtaskresult",{"_index":2499,"name":{},"parent":{"3246":{},"3247":{},"3248":{},"3249":{}}}],["zowe/imperative.iprofinfoerrparms",{"_index":2217,"name":{},"parent":{"2845":{},"2846":{},"2847":{}}}],["zowe/imperative.iprofinforemoveknownpropcommonopts",{"_index":2245,"name":{},"parent":{"2894":{}}}],["zowe/imperative.iprofinforemoveknownpropopts",{"_index":2243,"name":{},"parent":{"2890":{},"2891":{},"2892":{}}}],["zowe/imperative.iprofinfoupdateknownpropopts",{"_index":2236,"name":{},"parent":{"2878":{},"2879":{},"2880":{},"2881":{},"2882":{}}}],["zowe/imperative.iprofinfoupdatepropcommonopts",{"_index":2238,"name":{},"parent":{"2884":{},"2885":{},"2886":{}}}],["zowe/imperative.iprofinfoupdatepropopts",{"_index":2232,"name":{},"parent":{"2871":{},"2872":{},"2873":{},"2874":{},"2875":{},"2876":{}}}],["zowe/imperative.iprofloc",{"_index":2184,"name":{},"parent":{"2809":{},"2810":{},"2811":{}}}],["zowe/imperative.iproflocosloc",{"_index":2190,"name":{},"parent":{"2816":{},"2817":{},"2818":{},"2819":{}}}],["zowe/imperative.iproflocosloclayer",{"_index":2188,"name":{},"parent":{"2813":{},"2814":{}}}],["zowe/imperative.iprofmergeargopts",{"_index":2210,"name":{},"parent":{"2840":{}}}],["zowe/imperative.iprofmergedarg",{"_index":2213,"name":{},"parent":{"2842":{},"2843":{}}}],["zowe/imperative.iprofopts",{"_index":2174,"name":{},"parent":{"2799":{},"2800":{},"2802":{}}}],["zowe/imperative.iprofopts.requirekeytar",{"_index":2176,"name":{},"parent":{"2801":{}}}],["zowe/imperative.iprogressbarparms",{"_index":983,"name":{},"parent":{"1104":{},"1105":{},"1106":{}}}],["zowe/imperative.ipromisewithprogress",{"_index":882,"name":{},"parent":{"965":{},"966":{},"967":{},"968":{},"969":{},"970":{}}}],["zowe/imperative.ipromptoptions",{"_index":859,"name":{},"parent":{"943":{},"944":{},"945":{}}}],["zowe/imperative.iqueuedmessage",{"_index":404,"name":{},"parent":{"399":{},"400":{},"401":{}}}],["zowe/imperative.irestclienterror",{"_index":1043,"name":{},"parent":{"1176":{},"1177":{},"1178":{},"1179":{},"1180":{},"1181":{},"1182":{},"1183":{},"1184":{},"1185":{},"1186":{},"1187":{},"1188":{},"1189":{},"1190":{},"1191":{},"1192":{},"1193":{}}}],["zowe/imperative.irestclientresponse",{"_index":1100,"name":{},"parent":{"1273":{},"1274":{},"1275":{},"1276":{},"1277":{},"1278":{},"1279":{}}}],["zowe/imperative.irestoptions",{"_index":1104,"name":{},"parent":{"1281":{},"1282":{},"1283":{},"1284":{},"1285":{},"1286":{},"1287":{},"1288":{},"1289":{}}}],["zowe/imperative.isaveprofile",{"_index":2457,"name":{},"parent":{"3179":{},"3180":{},"3181":{},"3182":{},"3183":{},"3184":{}}}],["zowe/imperative.isaveprofilefromcliargs",{"_index":2462,"name":{},"parent":{"3186":{},"3187":{},"3188":{},"3189":{},"3190":{},"3191":{},"3192":{}}}],["zowe/imperative.isession",{"_index":1065,"name":{},"parent":{"1210":{},"1211":{},"1212":{},"1213":{},"1214":{},"1215":{},"1216":{},"1217":{},"1218":{},"1219":{},"1220":{},"1221":{},"1222":{},"1223":{},"1224":{},"1225":{},"1226":{},"1228":{},"1229":{}}}],["zowe/imperative.isession.checkserveridentity",{"_index":1072,"name":{},"parent":{"1227":{}}}],["zowe/imperative.isetdefaultprofile",{"_index":2464,"name":{},"parent":{"3194":{}}}],["zowe/imperative.isettingsfile",{"_index":696,"name":{},"parent":{"747":{}}}],["zowe/imperative.isettingsfile.overrides",{"_index":697,"name":{},"parent":{"748":{}}}],["zowe/imperative.isettingsfilepersistence",{"_index":1415,"name":{},"parent":{"1671":{},"1672":{}}}],["zowe/imperative.issueseverity",{"_index":1401,"name":{},"parent":{"1655":{},"1656":{},"1657":{},"1658":{}}}],["zowe/imperative.isysteminfo",{"_index":2366,"name":{},"parent":{"3038":{},"3039":{}}}],["zowe/imperative.itaskwithstatus",{"_index":878,"name":{},"parent":{"961":{},"962":{},"963":{}}}],["zowe/imperative.itemid",{"_index":2667,"name":{},"parent":{"3600":{},"3601":{},"3602":{},"3603":{},"3604":{},"3605":{},"3606":{},"3607":{},"3608":{},"3609":{},"3610":{},"3611":{},"3612":{}}}],["zowe/imperative.itreenode",{"_index":2786,"name":{},"parent":{"3806":{},"3807":{},"3808":{}}}],["zowe/imperative.iupdateprofile",{"_index":2466,"name":{},"parent":{"3196":{},"3197":{},"3198":{}}}],["zowe/imperative.iupdateprofilefromcliargs",{"_index":2468,"name":{},"parent":{"3200":{},"3201":{},"3202":{},"3203":{}}}],["zowe/imperative.ivalidateprofile",{"_index":2470,"name":{},"parent":{"3205":{},"3206":{},"3207":{}}}],["zowe/imperative.ivalidateprofileforcli",{"_index":2476,"name":{},"parent":{"3214":{},"3215":{},"3216":{},"3217":{},"3218":{}}}],["zowe/imperative.ivalidateprofilewithschema",{"_index":2473,"name":{},"parent":{"3209":{},"3210":{},"3211":{},"3212":{}}}],["zowe/imperative.iwebdiffgenerator",{"_index":2391,"name":{},"parent":{"3060":{}}}],["zowe/imperative.iwebdiffmanager",{"_index":2394,"name":{},"parent":{"3062":{}}}],["zowe/imperative.iwebhelpmanager",{"_index":1783,"name":{},"parent":{"2107":{},"2108":{}}}],["zowe/imperative.iwebhelppackagemetadata",{"_index":1858,"name":{},"parent":{"2214":{},"2215":{}}}],["zowe/imperative.iwebhelptreenode",{"_index":1836,"name":{},"parent":{"2188":{},"2189":{},"2190":{}}}],["zowe/imperative.iyargsparms",{"_index":1920,"name":{},"parent":{"2323":{},"2324":{},"2325":{},"2326":{},"2327":{},"2328":{},"2329":{},"2330":{},"2331":{},"2332":{},"2333":{}}}],["zowe/imperative.iyargsresponse",{"_index":1891,"name":{},"parent":{"2266":{},"2267":{},"2268":{},"2269":{},"2270":{},"2271":{}}}],["zowe/imperative.jsonsettingsfilepersistence",{"_index":1417,"name":{},"parent":{"1674":{},"1675":{},"1676":{},"1677":{},"1678":{}}}],["zowe/imperative.jsonutils",{"_index":2359,"name":{},"parent":{"3033":{}}}],["zowe/imperative.jsutils",{"_index":750,"name":{},"parent":{"804":{},"805":{}}}],["zowe/imperative.listdefinition",{"_index":2605,"name":{},"parent":{"3459":{},"3460":{},"3461":{},"3462":{},"3463":{},"3464":{},"3465":{},"3466":{},"3467":{}}}],["zowe/imperative.listgroupwithonlyprofilecommandsummary",{"_index":1572,"name":{},"parent":{"1837":{}}}],["zowe/imperative.listgroupwithonlyprofiledefaultdesc",{"_index":1570,"name":{},"parent":{"1835":{}}}],["zowe/imperative.listgroupwithonlyprofilesdefinition",{"_index":1568,"name":{},"parent":{"1833":{}}}],["zowe/imperative.listgroupwithonlyprofilesetdesc",{"_index":1574,"name":{},"parent":{"1839":{}}}],["zowe/imperative.listgroupwithonlyprofilessummary",{"_index":1566,"name":{},"parent":{"1831":{}}}],["zowe/imperative.listhandler",{"_index":2662,"name":{},"parent":{"3595":{}}}],["zowe/imperative.listprofilecommanddesc",{"_index":1544,"name":{},"parent":{"1809":{}}}],["zowe/imperative.listprofilecommandsummary",{"_index":1542,"name":{},"parent":{"1807":{}}}],["zowe/imperative.listprofileexample",{"_index":1512,"name":{},"parent":{"1777":{}}}],["zowe/imperative.listprofileexampleshowcontents",{"_index":1514,"name":{},"parent":{"1779":{}}}],["zowe/imperative.listprofileloadedmodulesoptiondesc",{"_index":1508,"name":{},"parent":{"1773":{}}}],["zowe/imperative.listprofilesfoundmessage",{"_index":1546,"name":{},"parent":{"1811":{}}}],["zowe/imperative.listprofileshandler",{"_index":2762,"name":{},"parent":{"3763":{}}}],["zowe/imperative.listprofilesnotfoundmessage",{"_index":1548,"name":{},"parent":{"1813":{}}}],["zowe/imperative.listprofileverboseoptiondesc",{"_index":1510,"name":{},"parent":{"1775":{}}}],["zowe/imperative.locateprofilesdesc",{"_index":1618,"name":{},"parent":{"1883":{}}}],["zowe/imperative.logger",{"_index":2578,"name":{},"parent":{"3408":{},"3409":{},"3410":{},"3411":{},"3412":{},"3413":{},"3414":{},"3415":{},"3416":{},"3417":{},"3418":{},"3419":{},"3420":{},"3421":{},"3422":{},"3423":{},"3424":{},"3425":{},"3426":{},"3427":{},"3428":{},"3429":{},"3430":{},"3431":{},"3432":{},"3433":{},"3434":{}}}],["zowe/imperative.loggerconfigbuilder",{"_index":1320,"name":{},"parent":{"1573":{},"1574":{},"1575":{},"1576":{},"1577":{},"1578":{},"1579":{},"1580":{},"1581":{},"1582":{},"1583":{},"1584":{},"1585":{},"1586":{},"1587":{},"1588":{},"1589":{},"1590":{},"1591":{}}}],["zowe/imperative.loggermanager",{"_index":447,"name":{},"parent":{"447":{},"448":{},"449":{},"450":{},"451":{},"452":{},"453":{},"454":{},"455":{},"456":{},"457":{},"458":{},"459":{},"460":{},"461":{}}}],["zowe/imperative.loggerutils",{"_index":2569,"name":{},"parent":{"3391":{},"3392":{},"3393":{},"3394":{},"3395":{},"3396":{},"3397":{},"3398":{},"3399":{},"3400":{},"3401":{},"3402":{},"3403":{},"3404":{},"3405":{},"3406":{}}}],["zowe/imperative.loggingconfigurer",{"_index":1353,"name":{},"parent":{"1609":{},"1610":{},"1611":{},"1612":{},"1613":{},"1614":{},"1615":{},"1616":{},"1617":{},"1618":{}}}],["zowe/imperative.mocked_command_tree",{"_index":2603,"name":{},"parent":{"3454":{},"3455":{},"3456":{},"3457":{}}}],["zowe/imperative.newdeleteprofileshandler",{"_index":2764,"name":{},"parent":{"3765":{}}}],["zowe/imperative.nextverfeatures",{"_index":2362,"name":{},"parent":{"3035":{},"3036":{}}}],["zowe/imperative.onlyfortesting",{"_index":2637,"name":{},"parent":{"3564":{}}}],["zowe/imperative.operation",{"_index":903,"name":{},"parent":{"984":{},"985":{},"986":{},"987":{},"988":{},"989":{},"990":{},"991":{},"992":{},"993":{},"994":{},"995":{},"996":{},"997":{},"998":{},"999":{},"1000":{},"1001":{},"1002":{},"1003":{},"1004":{},"1005":{},"1006":{},"1007":{},"1008":{},"1009":{},"1010":{},"1011":{},"1012":{},"1013":{},"1014":{},"1015":{},"1016":{},"1017":{},"1018":{},"1019":{},"1020":{},"1021":{},"1022":{},"1023":{},"1024":{},"1025":{},"1026":{},"1027":{},"1028":{},"1029":{},"1030":{}}}],["zowe/imperative.operations",{"_index":967,"name":{},"parent":{"1054":{},"1055":{},"1056":{},"1057":{},"1058":{},"1059":{},"1060":{},"1061":{},"1062":{},"1063":{},"1064":{},"1065":{},"1066":{},"1067":{},"1068":{},"1069":{},"1070":{},"1071":{},"1072":{},"1073":{},"1074":{},"1075":{},"1076":{},"1077":{},"1078":{},"1079":{},"1080":{},"1081":{},"1082":{},"1083":{},"1084":{},"1085":{},"1086":{},"1087":{},"1088":{},"1089":{},"1090":{},"1091":{},"1092":{},"1093":{},"1094":{},"1095":{},"1096":{},"1097":{},"1098":{},"1099":{},"1100":{},"1101":{},"1102":{}}}],["zowe/imperative.optionconstants",{"_index":1662,"name":{},"parent":{"1935":{},"1941":{},"1948":{},"1949":{}}}],["zowe/imperative.optionconstants.response_format_filter_option",{"_index":1663,"name":{},"parent":{"1936":{},"1937":{},"1938":{},"1939":{},"1940":{}}}],["zowe/imperative.optionconstants.response_format_header_option",{"_index":1665,"name":{},"parent":{"1942":{},"1943":{},"1944":{},"1945":{},"1946":{},"1947":{}}}],["zowe/imperative.optionconstants.response_format_option",{"_index":1668,"name":{},"parent":{"1950":{},"1951":{},"1952":{},"1953":{},"1954":{},"1957":{}}}],["zowe/imperative.optionconstants.response_format_option.allowablevalues",{"_index":1669,"name":{},"parent":{"1955":{},"1956":{}}}],["zowe/imperative.overridesloader",{"_index":2055,"name":{},"parent":{"2587":{},"2588":{},"2589":{},"2590":{},"2591":{},"2592":{}}}],["zowe/imperative.overroteprofilemessage",{"_index":1614,"name":{},"parent":{"1879":{}}}],["zowe/imperative.pluginissues",{"_index":1406,"name":{},"parent":{"1660":{},"1661":{},"1662":{},"1663":{},"1664":{},"1665":{},"1666":{},"1667":{},"1668":{},"1669":{}}}],["zowe/imperative.pluginmanagementfacility",{"_index":1427,"name":{},"parent":{"1693":{},"1694":{},"1695":{},"1696":{},"1697":{},"1698":{},"1699":{},"1700":{},"1701":{},"1702":{},"1703":{},"1704":{},"1705":{},"1706":{},"1707":{},"1708":{},"1709":{},"1710":{},"1711":{},"1712":{},"1713":{},"1714":{},"1715":{},"1716":{},"1717":{},"1718":{},"1719":{},"1720":{},"1721":{},"1722":{},"1723":{},"1724":{}}}],["zowe/imperative.pluginrequirealreadycreatederror",{"_index":2754,"name":{},"parent":{"3728":{},"3729":{},"3730":{},"3731":{},"3732":{},"3733":{},"3734":{},"3735":{},"3736":{},"3737":{}}}],["zowe/imperative.pluginrequirenotcreatederror",{"_index":2756,"name":{},"parent":{"3739":{},"3740":{},"3741":{},"3742":{},"3743":{},"3744":{},"3745":{},"3746":{},"3747":{},"3748":{}}}],["zowe/imperative.pluginrequireprovider",{"_index":2725,"name":{},"parent":{"3657":{},"3658":{},"3659":{},"3660":{},"3661":{},"3662":{},"3663":{},"3664":{}}}],["zowe/imperative.pmfconstants",{"_index":1368,"name":{},"parent":{"1623":{},"1624":{},"1625":{},"1626":{},"1627":{},"1628":{},"1629":{},"1630":{},"1631":{},"1632":{},"1633":{},"1634":{},"1635":{}}}],["zowe/imperative.processutils",{"_index":2375,"name":{},"parent":{"3045":{},"3046":{},"3047":{},"3048":{},"3049":{},"3050":{}}}],["zowe/imperative.profilecreatedsuccessfully",{"_index":1620,"name":{},"parent":{"1885":{}}}],["zowe/imperative.profilecreatedsuccessfullyandpath",{"_index":1590,"name":{},"parent":{"1855":{}}}],["zowe/imperative.profilecreateerrordetails",{"_index":1600,"name":{},"parent":{"1865":{}}}],["zowe/imperative.profilecreateerrorheader",{"_index":1596,"name":{},"parent":{"1861":{}}}],["zowe/imperative.profilecredentials",{"_index":2308,"name":{},"parent":{"2961":{},"2962":{},"2963":{},"2964":{},"2965":{},"2966":{},"2967":{},"2968":{},"2969":{}}}],["zowe/imperative.profiledeletedsuccessfully",{"_index":1604,"name":{},"parent":{"1869":{}}}],["zowe/imperative.profiledeleteerrordetails",{"_index":1612,"name":{},"parent":{"1877":{}}}],["zowe/imperative.profiledeleteerrorheader",{"_index":1606,"name":{},"parent":{"1871":{}}}],["zowe/imperative.profiledesc",{"_index":1616,"name":{},"parent":{"1881":{}}}],["zowe/imperative.profileinfo",{"_index":2258,"name":{},"parent":{"2907":{},"2908":{},"2909":{},"2910":{},"2911":{},"2912":{},"2913":{},"2915":{},"2916":{},"2917":{},"2918":{},"2919":{},"2920":{},"2921":{},"2922":{},"2923":{},"2924":{},"2925":{},"2926":{},"2927":{},"2928":{},"2929":{},"2930":{},"2931":{},"2932":{},"2933":{},"2934":{},"2935":{},"2936":{},"2937":{},"2938":{},"2939":{},"2940":{},"2941":{},"2942":{},"2943":{},"2944":{},"2945":{},"2946":{},"2947":{},"2948":{},"2949":{},"2950":{},"2951":{},"2952":{},"2953":{},"2954":{},"2955":{},"2956":{},"2957":{},"2958":{},"2959":{}}}],["zowe/imperative.profileinfo.moldschoolprofiledefaults",{"_index":2265,"name":{},"parent":{"2914":{}}}],["zowe/imperative.profileio",{"_index":2409,"name":{},"parent":{"3076":{},"3077":{},"3078":{},"3079":{},"3080":{},"3081":{},"3082":{},"3083":{},"3084":{},"3085":{},"3086":{},"3087":{},"3088":{}}}],["zowe/imperative.profileloaderror",{"_index":1494,"name":{},"parent":{"1759":{}}}],["zowe/imperative.profilenotdeletedmessage",{"_index":1602,"name":{},"parent":{"1867":{}}}],["zowe/imperative.profilereviewmessage",{"_index":1594,"name":{},"parent":{"1859":{}}}],["zowe/imperative.profilescommandbuilder",{"_index":2030,"name":{},"parent":{"2498":{},"2499":{},"2500":{},"2501":{},"2502":{},"2503":{},"2504":{},"2505":{},"2506":{},"2507":{}}}],["zowe/imperative.profilesconstants",{"_index":550,"name":{},"parent":{"548":{},"549":{},"550":{},"551":{},"552":{},"553":{}}}],["zowe/imperative.profilescreatecommandbuilder",{"_index":2035,"name":{},"parent":{"2509":{},"2510":{},"2511":{},"2512":{},"2513":{},"2514":{},"2515":{},"2516":{},"2517":{},"2518":{}}}],["zowe/imperative.profilesdefinition",{"_index":2611,"name":{},"parent":{"3484":{},"3485":{},"3486":{},"3487":{},"3488":{},"3489":{}}}],["zowe/imperative.profilesdeletecommandbuilder",{"_index":2039,"name":{},"parent":{"2531":{},"2532":{},"2533":{},"2534":{},"2535":{},"2536":{},"2537":{},"2538":{},"2539":{},"2540":{}}}],["zowe/imperative.profileshandler",{"_index":2664,"name":{},"parent":{"3597":{},"3598":{}}}],["zowe/imperative.profileslistcommandbuilder",{"_index":2043,"name":{},"parent":{"2553":{},"2554":{},"2555":{},"2556":{},"2557":{},"2558":{},"2559":{},"2560":{},"2561":{},"2562":{}}}],["zowe/imperative.profilessetcommandbuilder",{"_index":2045,"name":{},"parent":{"2564":{},"2565":{},"2566":{},"2567":{},"2568":{},"2569":{},"2570":{},"2571":{},"2572":{},"2573":{}}}],["zowe/imperative.profilesshowdependenciescommandbuilder",{"_index":2758,"name":{},"parent":{"3750":{},"3751":{},"3752":{},"3753":{},"3754":{},"3755":{},"3756":{},"3757":{},"3758":{},"3759":{}}}],["zowe/imperative.profilesupdatecommandbuilder",{"_index":2037,"name":{},"parent":{"2520":{},"2521":{},"2522":{},"2523":{},"2524":{},"2525":{},"2526":{},"2527":{},"2528":{},"2529":{}}}],["zowe/imperative.profilesvalidatecommandbuilder",{"_index":2041,"name":{},"parent":{"2542":{},"2543":{},"2544":{},"2545":{},"2546":{},"2547":{},"2548":{},"2549":{},"2550":{},"2551":{}}}],["zowe/imperative.profileupdatedsuccessfullyandpath",{"_index":1592,"name":{},"parent":{"1857":{}}}],["zowe/imperative.profileutils",{"_index":1992,"name":{},"parent":{"2442":{},"2443":{},"2444":{},"2445":{},"2446":{},"2447":{},"2448":{},"2449":{}}}],["zowe/imperative.profilevalidator",{"_index":2513,"name":{},"parent":{"3259":{},"3260":{},"3261":{},"3262":{},"3263":{},"3264":{},"3265":{}}}],["zowe/imperative.profinfoerr",{"_index":2221,"name":{},"parent":{"2849":{},"2850":{},"2851":{},"2852":{},"2853":{},"2854":{},"2855":{},"2856":{},"2857":{},"2858":{},"2859":{},"2860":{},"2861":{},"2862":{},"2863":{},"2864":{},"2865":{},"2866":{},"2867":{},"2868":{},"2869":{}}}],["zowe/imperative.profloctype",{"_index":2180,"name":{},"parent":{"2804":{},"2805":{},"2806":{},"2807":{}}}],["zowe/imperative.reportenvdefinition",{"_index":2623,"name":{},"parent":{"3534":{},"3535":{},"3536":{},"3537":{},"3538":{},"3539":{},"3540":{}}}],["zowe/imperative.reportenvhandler",{"_index":2709,"name":{},"parent":{"3641":{},"3642":{},"3643":{}}}],["zowe/imperative.restclient",{"_index":1180,"name":{},"parent":{"1383":{},"1384":{},"1385":{},"1386":{},"1387":{},"1388":{},"1389":{},"1390":{},"1391":{},"1392":{},"1393":{},"1394":{},"1395":{},"1396":{},"1397":{},"1398":{},"1399":{},"1400":{},"1401":{},"1402":{},"1403":{},"1404":{},"1405":{},"1406":{},"1407":{},"1408":{},"1409":{},"1410":{},"1411":{},"1412":{},"1413":{},"1414":{},"1415":{},"1416":{},"1417":{},"1418":{},"1419":{},"1420":{},"1421":{},"1422":{},"1423":{},"1424":{},"1425":{},"1426":{},"1427":{},"1428":{},"1429":{},"1430":{},"1431":{},"1432":{},"1433":{},"1434":{},"1435":{},"1436":{},"1437":{},"1438":{}}}],["zowe/imperative.restclienterror",{"_index":1137,"name":{},"parent":{"1323":{},"1324":{},"1325":{},"1326":{},"1327":{},"1328":{},"1329":{},"1330":{},"1331":{},"1332":{}}}],["zowe/imperative.restclientresolve",{"_index":1177,"name":{},"parent":{"1381":{}}}],["zowe/imperative.restconstants",{"_index":1125,"name":{},"parent":{"1309":{},"1310":{},"1311":{},"1312":{},"1313":{},"1314":{},"1315":{},"1316":{},"1317":{},"1318":{},"1319":{},"1320":{},"1321":{}}}],["zowe/imperative.reststandaloneutils",{"_index":1205,"name":{},"parent":{"1440":{},"1441":{},"1442":{}}}],["zowe/imperative.schemadefinition",{"_index":2609,"name":{},"parent":{"3477":{},"3478":{},"3479":{},"3480":{},"3481":{},"3482":{}}}],["zowe/imperative.schemahandler",{"_index":2713,"name":{},"parent":{"3645":{}}}],["zowe/imperative.securedefinition",{"_index":2613,"name":{},"parent":{"3491":{},"3492":{},"3493":{},"3494":{},"3495":{},"3496":{},"3497":{}}}],["zowe/imperative.securehandler",{"_index":2715,"name":{},"parent":{"3647":{},"3648":{},"3649":{}}}],["zowe/imperative.secureoperationfunction",{"_index":1933,"name":{},"parent":{"2369":{}}}],["zowe/imperative.selectprofilenamedesc",{"_index":1522,"name":{},"parent":{"1787":{}}}],["zowe/imperative.session",{"_index":1096,"name":{},"parent":{"1253":{},"1254":{},"1255":{},"1256":{},"1257":{},"1258":{},"1259":{},"1260":{},"1261":{},"1262":{},"1263":{},"1264":{},"1265":{},"1266":{},"1267":{},"1268":{},"1269":{},"1270":{},"1271":{}}}],["zowe/imperative.setdefaultprofileshandler",{"_index":2766,"name":{},"parent":{"3767":{}}}],["zowe/imperative.setdefinition",{"_index":2615,"name":{},"parent":{"3499":{},"3500":{},"3501":{},"3502":{},"3503":{},"3504":{},"3505":{},"3506":{}}}],["zowe/imperative.setgroupwithonlyprofilescommanddesc",{"_index":1582,"name":{},"parent":{"1847":{}}}],["zowe/imperative.setgroupwithonlyprofileslistdesc",{"_index":1588,"name":{},"parent":{"1853":{}}}],["zowe/imperative.setgroupwithonlyprofilessummary",{"_index":1580,"name":{},"parent":{"1845":{}}}],["zowe/imperative.sethandler",{"_index":2718,"name":{},"parent":{"3651":{}}}],["zowe/imperative.setprofileactiondesc",{"_index":1578,"name":{},"parent":{"1843":{}}}],["zowe/imperative.setprofileactionsummary",{"_index":1576,"name":{},"parent":{"1841":{}}}],["zowe/imperative.setprofileexample",{"_index":1586,"name":{},"parent":{"1851":{}}}],["zowe/imperative.setprofileoptiondesc",{"_index":1584,"name":{},"parent":{"1849":{}}}],["zowe/imperative.settingsalreadyinitialized",{"_index":2775,"name":{},"parent":{"3777":{},"3778":{},"3779":{},"3780":{},"3781":{},"3782":{},"3783":{},"3784":{},"3785":{},"3786":{}}}],["zowe/imperative.settingsnotinitialized",{"_index":2777,"name":{},"parent":{"3788":{},"3789":{},"3790":{},"3791":{},"3792":{},"3793":{},"3794":{},"3795":{},"3796":{},"3797":{}}}],["zowe/imperative.sharedoptions",{"_index":1703,"name":{},"parent":{"2007":{},"2008":{}}}],["zowe/imperative.showdependenciescommanddesc",{"_index":1540,"name":{},"parent":{"1805":{}}}],["zowe/imperative.showdependenciesprofileshandler",{"_index":2768,"name":{},"parent":{"3769":{}}}],["zowe/imperative.syntaxerrorheader",{"_index":1498,"name":{},"parent":{"1763":{}}}],["zowe/imperative.syntaxvalidator",{"_index":1709,"name":{},"parent":{"2014":{},"2015":{},"2016":{},"2017":{},"2018":{},"2019":{},"2020":{},"2021":{},"2022":{},"2023":{},"2024":{},"2025":{},"2026":{},"2027":{},"2028":{},"2029":{},"2030":{},"2031":{},"2032":{},"2033":{},"2034":{},"2035":{},"2036":{},"2037":{},"2038":{},"2039":{},"2040":{},"2041":{},"2042":{},"2043":{},"2044":{},"2045":{},"2046":{},"2047":{},"2048":{},"2049":{},"2050":{}}}],["zowe/imperative.taskprogress",{"_index":890,"name":{},"parent":{"972":{},"973":{},"974":{},"975":{},"976":{},"977":{},"978":{},"979":{},"980":{},"981":{},"982":{}}}],["zowe/imperative.taskstage",{"_index":872,"name":{},"parent":{"956":{},"957":{},"958":{},"959":{}}}],["zowe/imperative.textutils",{"_index":334,"name":{},"parent":{"333":{},"334":{},"335":{},"336":{},"337":{},"338":{},"339":{},"340":{},"341":{},"342":{},"343":{},"344":{},"345":{},"346":{},"347":{}}}],["zowe/imperative.unabletocreateprofile",{"_index":1598,"name":{},"parent":{"1863":{}}}],["zowe/imperative.unabletodeleteprofile",{"_index":1608,"name":{},"parent":{"1873":{}}}],["zowe/imperative.unabletofindprofile",{"_index":1610,"name":{},"parent":{"1875":{}}}],["zowe/imperative.unabletoloadrequestedprofileserror",{"_index":1490,"name":{},"parent":{"1755":{}}}],["zowe/imperative.unexpectedcommanderror",{"_index":1486,"name":{},"parent":{"1751":{}}}],["zowe/imperative.unexpectedcommandpreparationerror",{"_index":1488,"name":{},"parent":{"1753":{}}}],["zowe/imperative.unexpectedprofilecreationerror",{"_index":1622,"name":{},"parent":{"1887":{}}}],["zowe/imperative.unexpectedprofileloaderror",{"_index":1492,"name":{},"parent":{"1757":{}}}],["zowe/imperative.unexpectedprofilesloaderror",{"_index":1496,"name":{},"parent":{"1761":{}}}],["zowe/imperative.unexpectedprofileupdateerror",{"_index":1624,"name":{},"parent":{"1889":{}}}],["zowe/imperative.uninstalldefinition",{"_index":2740,"name":{},"parent":{"3691":{},"3692":{},"3693":{},"3694":{},"3695":{},"3696":{},"3697":{}}}],["zowe/imperative.uninstallhandler",{"_index":2742,"name":{},"parent":{"3699":{},"3700":{},"3701":{}}}],["zowe/imperative.updatedefinition",{"_index":2745,"name":{},"parent":{"3703":{},"3704":{},"3705":{},"3706":{},"3707":{},"3708":{},"3709":{},"3710":{}}}],["zowe/imperative.updatehandler",{"_index":2747,"name":{},"parent":{"3712":{},"3713":{}}}],["zowe/imperative.updateimpconfig",{"_index":1365,"name":{},"parent":{"1620":{},"1621":{}}}],["zowe/imperative.updateprofileactiondesc",{"_index":1560,"name":{},"parent":{"1825":{}}}],["zowe/imperative.updateprofilecommanddesc",{"_index":1564,"name":{},"parent":{"1829":{}}}],["zowe/imperative.updateprofilecommandsummary",{"_index":1562,"name":{},"parent":{"1827":{}}}],["zowe/imperative.updateprofileshandler",{"_index":2770,"name":{},"parent":{"3771":{}}}],["zowe/imperative.updateschemasdefinition",{"_index":2625,"name":{},"parent":{"3542":{},"3543":{},"3544":{},"3545":{},"3546":{},"3547":{},"3548":{},"3549":{},"3550":{}}}],["zowe/imperative.updateschemashandler",{"_index":2720,"name":{},"parent":{"3653":{}}}],["zowe/imperative.validatedefinition",{"_index":2749,"name":{},"parent":{"3715":{},"3716":{},"3717":{},"3718":{},"3719":{},"3720":{},"3721":{},"3722":{}}}],["zowe/imperative.validatehandler",{"_index":2751,"name":{},"parent":{"3724":{},"3725":{},"3726":{}}}],["zowe/imperative.validateprofilecommanddesc",{"_index":1554,"name":{},"parent":{"1819":{}}}],["zowe/imperative.validateprofilecommandsummary",{"_index":1550,"name":{},"parent":{"1815":{}}}],["zowe/imperative.validateprofilegroupdesc",{"_index":1552,"name":{},"parent":{"1817":{}}}],["zowe/imperative.validateprofilehandler",{"_index":2772,"name":{},"parent":{"3773":{},"3774":{}}}],["zowe/imperative.validateprofilenamedesc",{"_index":1520,"name":{},"parent":{"1785":{}}}],["zowe/imperative.validateprofileoptiondesc",{"_index":1556,"name":{},"parent":{"1821":{}}}],["zowe/imperative.webdiffmanager",{"_index":2396,"name":{},"parent":{"3064":{},"3065":{},"3066":{},"3067":{},"3068":{}}}],["zowe/imperative.webhelpgenerator",{"_index":1840,"name":{},"parent":{"2192":{},"2193":{},"2194":{},"2195":{},"2196":{},"2197":{},"2198":{},"2200":{},"2201":{},"2202":{},"2203":{},"2204":{},"2205":{},"2206":{},"2207":{},"2208":{},"2209":{},"2210":{},"2211":{},"2212":{}}}],["zowe/imperative.webhelpgenerator.aliaslist",{"_index":1846,"name":{},"parent":{"2199":{}}}],["zowe/imperative.webhelpmanager",{"_index":1860,"name":{},"parent":{"2217":{},"2218":{},"2219":{},"2220":{},"2221":{},"2222":{},"2223":{},"2224":{},"2225":{},"2226":{},"2227":{}}}],["zowe/imperative.yargscommandcompleted",{"_index":1931,"name":{},"parent":{"2367":{}}}],["zowe/imperative.yargsconfigurer",{"_index":2012,"name":{},"parent":{"2463":{},"2464":{},"2465":{},"2466":{},"2467":{},"2468":{},"2469":{},"2470":{},"2471":{},"2472":{},"2473":{},"2474":{},"2475":{},"2476":{},"2477":{},"2478":{}}}],["zowe/imperative.yargsdefiner",{"_index":2020,"name":{},"parent":{"2480":{},"2481":{},"2482":{},"2483":{},"2484":{},"2485":{},"2486":{},"2487":{},"2488":{},"2489":{},"2490":{},"2491":{}}}],["zowe/provisioning",{"_index":2808,"name":{"3832":{}},"parent":{"3833":{},"3834":{},"3835":{},"3836":{},"3837":{},"3838":{},"3839":{},"3840":{},"3841":{},"3842":{},"3843":{},"3844":{},"3845":{},"3846":{},"3847":{},"3848":{},"3849":{},"3850":{},"3851":{},"3852":{},"3853":{},"3854":{},"3855":{},"3856":{},"3857":{},"3858":{},"3859":{},"3860":{},"3861":{},"3862":{},"3863":{},"3864":{},"3865":{},"3866":{},"3867":{},"3868":{},"3869":{},"3870":{},"3871":{},"3872":{},"3873":{},"3874":{},"3875":{},"3876":{},"3877":{},"3878":{},"3879":{},"3880":{},"3881":{},"3882":{},"3883":{},"3884":{},"3885":{},"3886":{},"3887":{},"3888":{},"3889":{},"3890":{},"3891":{},"3892":{},"3893":{},"3894":{},"3895":{},"3896":{},"3897":{},"3898":{},"3899":{},"3900":{},"3901":{},"3902":{},"3903":{},"3904":{},"3905":{},"3906":{},"3907":{},"3908":{},"3909":{},"3910":{},"3911":{},"3912":{},"3913":{},"3914":{},"3915":{},"3916":{},"3917":{},"3918":{},"3919":{},"3920":{},"3921":{},"3922":{},"3923":{},"3924":{},"3925":{},"3926":{},"3927":{},"3928":{},"3929":{},"3930":{},"3931":{},"3932":{},"3933":{},"3934":{},"3935":{},"3936":{},"3937":{},"3938":{},"3939":{},"3940":{},"3941":{},"3942":{},"3943":{},"3944":{},"3945":{},"3946":{},"3947":{},"3948":{},"3949":{},"3950":{},"3951":{},"3952":{},"3953":{},"3954":{},"3955":{},"3956":{},"3957":{},"3958":{},"3959":{},"3960":{},"3961":{},"3962":{},"3963":{},"3964":{},"3965":{},"3966":{},"3967":{},"3968":{},"3969":{},"3970":{},"3971":{},"3972":{},"3973":{},"3974":{},"3975":{},"3976":{},"3977":{},"3978":{},"3979":{},"3980":{},"3981":{},"3982":{},"3983":{},"3984":{},"3985":{},"3986":{},"3987":{},"3988":{},"3989":{},"3990":{},"3991":{},"3992":{},"3993":{},"3994":{},"3995":{},"3996":{},"3997":{},"3998":{},"3999":{},"4000":{},"4001":{},"4002":{},"4003":{},"4004":{},"4005":{},"4006":{},"4007":{},"4008":{},"4009":{},"4010":{},"4011":{},"4012":{},"4013":{},"4014":{},"4015":{},"4016":{},"4017":{},"4018":{},"4019":{},"4020":{},"4021":{},"4022":{},"4023":{},"4024":{},"4025":{},"4026":{},"4027":{},"4028":{},"4029":{},"4030":{},"4031":{},"4032":{},"4033":{},"4034":{},"4035":{},"4036":{},"4037":{},"4038":{},"4039":{},"4040":{},"4041":{},"4042":{},"4043":{},"4044":{},"4045":{},"4046":{},"4047":{},"4048":{},"4049":{},"4050":{},"4051":{},"4052":{},"4053":{},"4054":{},"4055":{},"4056":{},"4057":{},"4058":{},"4059":{},"4060":{},"4061":{},"4062":{},"4063":{},"4064":{},"4065":{},"4066":{},"4067":{},"4068":{},"4069":{},"4070":{},"4071":{},"4072":{},"4073":{},"4074":{},"4075":{},"4076":{},"4077":{},"4078":{},"4079":{},"4080":{},"4081":{},"4082":{},"4083":{},"4084":{},"4085":{},"4086":{},"4087":{},"4088":{},"4089":{},"4090":{},"4091":{},"4092":{},"4093":{},"4094":{},"4095":{},"4096":{},"4097":{},"4098":{},"4099":{},"4100":{},"4101":{},"4102":{},"4103":{},"4104":{},"4105":{},"4106":{},"4107":{},"4108":{},"4109":{},"4110":{},"4111":{},"4112":{},"4113":{},"4114":{},"4115":{},"4116":{},"4117":{}}}],["zowe/zos",{"_index":3012,"name":{"4118":{},"4221":{},"4875":{},"5155":{},"5188":{},"5438":{},"5569":{}},"parent":{"4119":{},"4120":{},"4121":{},"4122":{},"4123":{},"4124":{},"4125":{},"4126":{},"4127":{},"4128":{},"4129":{},"4130":{},"4131":{},"4132":{},"4133":{},"4134":{},"4135":{},"4136":{},"4137":{},"4138":{},"4139":{},"4140":{},"4141":{},"4142":{},"4143":{},"4144":{},"4145":{},"4146":{},"4147":{},"4148":{},"4149":{},"4150":{},"4151":{},"4152":{},"4153":{},"4154":{},"4155":{},"4156":{},"4157":{},"4158":{},"4159":{},"4160":{},"4161":{},"4162":{},"4163":{},"4164":{},"4165":{},"4166":{},"4167":{},"4168":{},"4169":{},"4170":{},"4171":{},"4172":{},"4173":{},"4174":{},"4175":{},"4176":{},"4177":{},"4178":{},"4179":{},"4180":{},"4181":{},"4182":{},"4183":{},"4184":{},"4185":{},"4186":{},"4187":{},"4188":{},"4189":{},"4190":{},"4191":{},"4192":{},"4193":{},"4194":{},"4195":{},"4196":{},"4197":{},"4198":{},"4199":{},"4200":{},"4201":{},"4202":{},"4203":{},"4204":{},"4205":{},"4206":{},"4207":{},"4208":{},"4209":{},"4210":{},"4211":{},"4212":{},"4213":{},"4214":{},"4215":{},"4216":{},"4217":{},"4218":{},"4219":{},"4220":{},"4222":{},"4223":{},"4224":{},"4225":{},"4226":{},"4227":{},"4228":{},"4229":{},"4230":{},"4231":{},"4232":{},"4233":{},"4234":{},"4235":{},"4236":{},"4237":{},"4238":{},"4239":{},"4240":{},"4241":{},"4242":{},"4243":{},"4244":{},"4245":{},"4246":{},"4247":{},"4248":{},"4249":{},"4250":{},"4251":{},"4252":{},"4253":{},"4254":{},"4255":{},"4256":{},"4257":{},"4258":{},"4259":{},"4260":{},"4261":{},"4262":{},"4263":{},"4264":{},"4265":{},"4266":{},"4267":{},"4268":{},"4269":{},"4270":{},"4271":{},"4272":{},"4273":{},"4274":{},"4275":{},"4276":{},"4277":{},"4278":{},"4279":{},"4280":{},"4281":{},"4282":{},"4283":{},"4284":{},"4285":{},"4286":{},"4287":{},"4288":{},"4289":{},"4290":{},"4291":{},"4292":{},"4293":{},"4294":{},"4295":{},"4296":{},"4297":{},"4298":{},"4299":{},"4300":{},"4301":{},"4302":{},"4303":{},"4304":{},"4305":{},"4306":{},"4307":{},"4308":{},"4309":{},"4310":{},"4311":{},"4312":{},"4313":{},"4314":{},"4315":{},"4316":{},"4317":{},"4318":{},"4319":{},"4320":{},"4321":{},"4322":{},"4323":{},"4324":{},"4325":{},"4326":{},"4327":{},"4328":{},"4329":{},"4330":{},"4331":{},"4332":{},"4333":{},"4334":{},"4335":{},"4336":{},"4337":{},"4338":{},"4339":{},"4340":{},"4341":{},"4342":{},"4343":{},"4344":{},"4345":{},"4346":{},"4347":{},"4348":{},"4349":{},"4350":{},"4351":{},"4352":{},"4353":{},"4354":{},"4355":{},"4356":{},"4357":{},"4358":{},"4359":{},"4360":{},"4361":{},"4362":{},"4363":{},"4364":{},"4365":{},"4366":{},"4367":{},"4368":{},"4369":{},"4370":{},"4371":{},"4372":{},"4373":{},"4374":{},"4375":{},"4376":{},"4377":{},"4378":{},"4379":{},"4380":{},"4381":{},"4382":{},"4383":{},"4384":{},"4385":{},"4386":{},"4387":{},"4388":{},"4389":{},"4390":{},"4391":{},"4392":{},"4393":{},"4394":{},"4395":{},"4396":{},"4397":{},"4398":{},"4399":{},"4400":{},"4401":{},"4402":{},"4403":{},"4404":{},"4405":{},"4406":{},"4407":{},"4408":{},"4409":{},"4410":{},"4411":{},"4412":{},"4413":{},"4414":{},"4415":{},"4416":{},"4417":{},"4418":{},"4419":{},"4420":{},"4421":{},"4422":{},"4423":{},"4424":{},"4425":{},"4426":{},"4427":{},"4428":{},"4429":{},"4430":{},"4431":{},"4432":{},"4433":{},"4434":{},"4435":{},"4436":{},"4437":{},"4438":{},"4439":{},"4440":{},"4441":{},"4442":{},"4443":{},"4444":{},"4445":{},"4446":{},"4447":{},"4448":{},"4449":{},"4450":{},"4451":{},"4452":{},"4453":{},"4454":{},"4455":{},"4456":{},"4457":{},"4458":{},"4459":{},"4460":{},"4461":{},"4462":{},"4463":{},"4464":{},"4465":{},"4466":{},"4467":{},"4468":{},"4469":{},"4470":{},"4471":{},"4472":{},"4473":{},"4474":{},"4475":{},"4476":{},"4477":{},"4478":{},"4479":{},"4480":{},"4481":{},"4482":{},"4483":{},"4484":{},"4485":{},"4486":{},"4487":{},"4488":{},"4489":{},"4490":{},"4491":{},"4492":{},"4493":{},"4494":{},"4495":{},"4496":{},"4497":{},"4498":{},"4499":{},"4500":{},"4501":{},"4502":{},"4503":{},"4504":{},"4505":{},"4506":{},"4507":{},"4508":{},"4509":{},"4510":{},"4511":{},"4512":{},"4513":{},"4514":{},"4515":{},"4516":{},"4517":{},"4518":{},"4519":{},"4520":{},"4521":{},"4522":{},"4523":{},"4524":{},"4525":{},"4526":{},"4527":{},"4528":{},"4529":{},"4530":{},"4531":{},"4532":{},"4533":{},"4534":{},"4535":{},"4536":{},"4537":{},"4538":{},"4539":{},"4540":{},"4541":{},"4542":{},"4543":{},"4544":{},"4545":{},"4546":{},"4547":{},"4548":{},"4549":{},"4550":{},"4551":{},"4552":{},"4553":{},"4554":{},"4555":{},"4556":{},"4557":{},"4558":{},"4559":{},"4560":{},"4561":{},"4562":{},"4563":{},"4564":{},"4565":{},"4566":{},"4567":{},"4568":{},"4569":{},"4570":{},"4571":{},"4572":{},"4573":{},"4574":{},"4575":{},"4576":{},"4577":{},"4578":{},"4579":{},"4580":{},"4581":{},"4582":{},"4583":{},"4584":{},"4585":{},"4586":{},"4587":{},"4588":{},"4589":{},"4590":{},"4591":{},"4592":{},"4593":{},"4594":{},"4595":{},"4596":{},"4597":{},"4598":{},"4599":{},"4600":{},"4601":{},"4602":{},"4603":{},"4604":{},"4605":{},"4606":{},"4607":{},"4608":{},"4609":{},"4610":{},"4611":{},"4612":{},"4613":{},"4614":{},"4615":{},"4616":{},"4617":{},"4618":{},"4619":{},"4620":{},"4621":{},"4622":{},"4623":{},"4624":{},"4625":{},"4626":{},"4627":{},"4628":{},"4629":{},"4630":{},"4631":{},"4632":{},"4633":{},"4634":{},"4635":{},"4636":{},"4637":{},"4638":{},"4639":{},"4640":{},"4641":{},"4642":{},"4643":{},"4644":{},"4645":{},"4646":{},"4647":{},"4648":{},"4649":{},"4650":{},"4651":{},"4652":{},"4653":{},"4654":{},"4655":{},"4656":{},"4657":{},"4658":{},"4659":{},"4660":{},"4661":{},"4662":{},"4663":{},"4664":{},"4665":{},"4666":{},"4667":{},"4668":{},"4669":{},"4670":{},"4671":{},"4672":{},"4673":{},"4674":{},"4675":{},"4676":{},"4677":{},"4678":{},"4679":{},"4680":{},"4681":{},"4682":{},"4683":{},"4684":{},"4685":{},"4686":{},"4687":{},"4688":{},"4689":{},"4690":{},"4691":{},"4692":{},"4693":{},"4694":{},"4695":{},"4696":{},"4697":{},"4698":{},"4699":{},"4700":{},"4701":{},"4702":{},"4703":{},"4704":{},"4705":{},"4706":{},"4707":{},"4708":{},"4709":{},"4710":{},"4711":{},"4712":{},"4713":{},"4714":{},"4715":{},"4716":{},"4717":{},"4718":{},"4719":{},"4720":{},"4721":{},"4722":{},"4723":{},"4724":{},"4725":{},"4726":{},"4727":{},"4728":{},"4729":{},"4730":{},"4731":{},"4732":{},"4733":{},"4734":{},"4735":{},"4736":{},"4737":{},"4738":{},"4739":{},"4740":{},"4741":{},"4742":{},"4743":{},"4744":{},"4745":{},"4746":{},"4747":{},"4748":{},"4749":{},"4750":{},"4751":{},"4752":{},"4753":{},"4754":{},"4755":{},"4756":{},"4757":{},"4758":{},"4759":{},"4760":{},"4761":{},"4762":{},"4763":{},"4764":{},"4765":{},"4766":{},"4767":{},"4768":{},"4769":{},"4770":{},"4771":{},"4772":{},"4773":{},"4774":{},"4775":{},"4776":{},"4777":{},"4778":{},"4779":{},"4780":{},"4781":{},"4782":{},"4783":{},"4784":{},"4785":{},"4786":{},"4787":{},"4788":{},"4789":{},"4790":{},"4791":{},"4792":{},"4793":{},"4794":{},"4795":{},"4796":{},"4797":{},"4798":{},"4799":{},"4800":{},"4801":{},"4802":{},"4803":{},"4804":{},"4805":{},"4806":{},"4807":{},"4808":{},"4809":{},"4810":{},"4811":{},"4812":{},"4813":{},"4814":{},"4815":{},"4816":{},"4817":{},"4818":{},"4819":{},"4820":{},"4821":{},"4822":{},"4823":{},"4824":{},"4825":{},"4826":{},"4827":{},"4828":{},"4829":{},"4830":{},"4831":{},"4832":{},"4833":{},"4834":{},"4835":{},"4836":{},"4837":{},"4838":{},"4839":{},"4840":{},"4841":{},"4842":{},"4843":{},"4844":{},"4845":{},"4846":{},"4847":{},"4848":{},"4849":{},"4850":{},"4851":{},"4852":{},"4853":{},"4854":{},"4855":{},"4856":{},"4857":{},"4858":{},"4859":{},"4860":{},"4861":{},"4862":{},"4863":{},"4864":{},"4865":{},"4866":{},"4867":{},"4868":{},"4869":{},"4870":{},"4871":{},"4872":{},"4873":{},"4874":{},"4876":{},"4877":{},"4878":{},"4879":{},"4880":{},"4881":{},"4882":{},"4883":{},"4884":{},"4885":{},"4886":{},"4887":{},"4888":{},"4889":{},"4890":{},"4891":{},"4892":{},"4893":{},"4894":{},"4895":{},"4896":{},"4897":{},"4898":{},"4899":{},"4900":{},"4901":{},"4902":{},"4903":{},"4904":{},"4905":{},"4906":{},"4907":{},"4908":{},"4909":{},"4910":{},"4911":{},"4912":{},"4913":{},"4914":{},"4915":{},"4916":{},"4917":{},"4918":{},"4919":{},"4920":{},"4921":{},"4922":{},"4923":{},"4924":{},"4925":{},"4926":{},"4927":{},"4928":{},"4929":{},"4930":{},"4931":{},"4932":{},"4933":{},"4934":{},"4935":{},"4936":{},"4937":{},"4938":{},"4939":{},"4940":{},"4941":{},"4942":{},"4943":{},"4944":{},"4945":{},"4946":{},"4947":{},"4948":{},"4949":{},"4950":{},"4951":{},"4952":{},"4953":{},"4954":{},"4955":{},"4956":{},"4957":{},"4958":{},"4959":{},"4960":{},"4961":{},"4962":{},"4963":{},"4964":{},"4965":{},"4966":{},"4967":{},"4968":{},"4969":{},"4970":{},"4971":{},"4972":{},"4973":{},"4974":{},"4975":{},"4976":{},"4977":{},"4978":{},"4979":{},"4980":{},"4981":{},"4982":{},"4983":{},"4984":{},"4985":{},"4986":{},"4987":{},"4988":{},"4989":{},"4990":{},"4991":{},"4992":{},"4993":{},"4994":{},"4995":{},"4996":{},"4997":{},"4998":{},"4999":{},"5000":{},"5001":{},"5002":{},"5003":{},"5004":{},"5005":{},"5006":{},"5007":{},"5008":{},"5009":{},"5010":{},"5011":{},"5012":{},"5013":{},"5014":{},"5015":{},"5016":{},"5017":{},"5018":{},"5019":{},"5020":{},"5021":{},"5022":{},"5023":{},"5024":{},"5025":{},"5026":{},"5027":{},"5028":{},"5029":{},"5030":{},"5031":{},"5032":{},"5033":{},"5034":{},"5035":{},"5036":{},"5037":{},"5038":{},"5039":{},"5040":{},"5041":{},"5042":{},"5043":{},"5044":{},"5045":{},"5046":{},"5047":{},"5048":{},"5049":{},"5050":{},"5051":{},"5052":{},"5053":{},"5054":{},"5055":{},"5056":{},"5057":{},"5058":{},"5059":{},"5060":{},"5061":{},"5062":{},"5063":{},"5064":{},"5065":{},"5066":{},"5067":{},"5068":{},"5069":{},"5070":{},"5071":{},"5072":{},"5073":{},"5074":{},"5075":{},"5076":{},"5077":{},"5078":{},"5079":{},"5080":{},"5081":{},"5082":{},"5083":{},"5084":{},"5085":{},"5086":{},"5087":{},"5088":{},"5089":{},"5090":{},"5091":{},"5092":{},"5093":{},"5094":{},"5095":{},"5096":{},"5097":{},"5098":{},"5099":{},"5100":{},"5101":{},"5102":{},"5103":{},"5104":{},"5105":{},"5106":{},"5107":{},"5108":{},"5109":{},"5110":{},"5111":{},"5112":{},"5113":{},"5114":{},"5115":{},"5116":{},"5117":{},"5118":{},"5119":{},"5120":{},"5121":{},"5122":{},"5123":{},"5124":{},"5125":{},"5126":{},"5127":{},"5128":{},"5129":{},"5130":{},"5131":{},"5132":{},"5133":{},"5134":{},"5135":{},"5136":{},"5137":{},"5138":{},"5139":{},"5140":{},"5141":{},"5142":{},"5143":{},"5144":{},"5145":{},"5146":{},"5147":{},"5148":{},"5149":{},"5150":{},"5151":{},"5152":{},"5153":{},"5154":{},"5156":{},"5157":{},"5158":{},"5159":{},"5160":{},"5161":{},"5162":{},"5163":{},"5164":{},"5165":{},"5166":{},"5167":{},"5168":{},"5169":{},"5170":{},"5171":{},"5172":{},"5173":{},"5174":{},"5175":{},"5176":{},"5177":{},"5178":{},"5179":{},"5180":{},"5181":{},"5182":{},"5183":{},"5184":{},"5185":{},"5186":{},"5187":{},"5189":{},"5190":{},"5191":{},"5192":{},"5193":{},"5194":{},"5195":{},"5196":{},"5197":{},"5198":{},"5199":{},"5200":{},"5201":{},"5202":{},"5203":{},"5204":{},"5205":{},"5206":{},"5207":{},"5208":{},"5209":{},"5210":{},"5211":{},"5212":{},"5213":{},"5214":{},"5215":{},"5216":{},"5217":{},"5218":{},"5219":{},"5220":{},"5221":{},"5222":{},"5223":{},"5224":{},"5225":{},"5226":{},"5227":{},"5228":{},"5229":{},"5230":{},"5231":{},"5232":{},"5233":{},"5234":{},"5235":{},"5236":{},"5237":{},"5238":{},"5239":{},"5240":{},"5241":{},"5242":{},"5243":{},"5244":{},"5245":{},"5246":{},"5247":{},"5248":{},"5249":{},"5250":{},"5251":{},"5252":{},"5253":{},"5254":{},"5255":{},"5256":{},"5257":{},"5258":{},"5259":{},"5260":{},"5261":{},"5262":{},"5263":{},"5264":{},"5265":{},"5266":{},"5267":{},"5268":{},"5269":{},"5270":{},"5271":{},"5272":{},"5273":{},"5274":{},"5275":{},"5276":{},"5277":{},"5278":{},"5279":{},"5280":{},"5281":{},"5282":{},"5283":{},"5284":{},"5285":{},"5286":{},"5287":{},"5288":{},"5289":{},"5290":{},"5291":{},"5292":{},"5293":{},"5294":{},"5295":{},"5296":{},"5297":{},"5298":{},"5299":{},"5300":{},"5301":{},"5302":{},"5303":{},"5304":{},"5305":{},"5306":{},"5307":{},"5308":{},"5309":{},"5310":{},"5311":{},"5312":{},"5313":{},"5314":{},"5315":{},"5316":{},"5317":{},"5318":{},"5319":{},"5320":{},"5321":{},"5322":{},"5323":{},"5324":{},"5325":{},"5326":{},"5327":{},"5328":{},"5329":{},"5330":{},"5331":{},"5332":{},"5333":{},"5334":{},"5335":{},"5336":{},"5337":{},"5338":{},"5339":{},"5340":{},"5341":{},"5342":{},"5343":{},"5344":{},"5345":{},"5346":{},"5347":{},"5348":{},"5349":{},"5350":{},"5351":{},"5352":{},"5353":{},"5354":{},"5355":{},"5356":{},"5357":{},"5358":{},"5359":{},"5360":{},"5361":{},"5362":{},"5363":{},"5364":{},"5365":{},"5366":{},"5367":{},"5368":{},"5369":{},"5370":{},"5371":{},"5372":{},"5373":{},"5374":{},"5375":{},"5376":{},"5377":{},"5378":{},"5379":{},"5380":{},"5381":{},"5382":{},"5383":{},"5384":{},"5385":{},"5386":{},"5387":{},"5388":{},"5389":{},"5390":{},"5391":{},"5392":{},"5393":{},"5394":{},"5395":{},"5396":{},"5397":{},"5398":{},"5399":{},"5400":{},"5401":{},"5402":{},"5403":{},"5404":{},"5405":{},"5406":{},"5407":{},"5408":{},"5409":{},"5410":{},"5411":{},"5412":{},"5413":{},"5414":{},"5415":{},"5416":{},"5417":{},"5418":{},"5419":{},"5420":{},"5421":{},"5422":{},"5423":{},"5424":{},"5425":{},"5426":{},"5427":{},"5428":{},"5429":{},"5430":{},"5431":{},"5432":{},"5433":{},"5434":{},"5435":{},"5436":{},"5437":{},"5439":{},"5440":{},"5441":{},"5442":{},"5443":{},"5444":{},"5445":{},"5446":{},"5447":{},"5448":{},"5449":{},"5450":{},"5451":{},"5452":{},"5453":{},"5454":{},"5455":{},"5456":{},"5457":{},"5458":{},"5459":{},"5460":{},"5461":{},"5462":{},"5463":{},"5464":{},"5465":{},"5466":{},"5467":{},"5468":{},"5469":{},"5470":{},"5471":{},"5472":{},"5473":{},"5474":{},"5475":{},"5476":{},"5477":{},"5478":{},"5479":{},"5480":{},"5481":{},"5482":{},"5483":{},"5484":{},"5485":{},"5486":{},"5487":{},"5488":{},"5489":{},"5490":{},"5491":{},"5492":{},"5493":{},"5494":{},"5495":{},"5496":{},"5497":{},"5498":{},"5499":{},"5500":{},"5501":{},"5502":{},"5503":{},"5504":{},"5505":{},"5506":{},"5507":{},"5508":{},"5509":{},"5510":{},"5511":{},"5512":{},"5513":{},"5514":{},"5515":{},"5516":{},"5517":{},"5518":{},"5519":{},"5520":{},"5521":{},"5522":{},"5523":{},"5524":{},"5525":{},"5526":{},"5527":{},"5528":{},"5529":{},"5530":{},"5531":{},"5532":{},"5533":{},"5534":{},"5535":{},"5536":{},"5537":{},"5538":{},"5539":{},"5540":{},"5541":{},"5542":{},"5543":{},"5544":{},"5545":{},"5546":{},"5547":{},"5548":{},"5549":{},"5550":{},"5551":{},"5552":{},"5553":{},"5554":{},"5555":{},"5556":{},"5557":{},"5558":{},"5559":{},"5560":{},"5561":{},"5562":{},"5563":{},"5564":{},"5565":{},"5566":{},"5567":{},"5568":{},"5570":{},"5571":{},"5572":{},"5573":{},"5574":{},"5575":{},"5576":{},"5577":{},"5578":{},"5579":{},"5580":{},"5581":{},"5582":{},"5583":{},"5584":{},"5585":{},"5586":{},"5587":{},"5588":{},"5589":{},"5590":{},"5591":{},"5592":{},"5593":{},"5594":{},"5595":{},"5596":{},"5597":{},"5598":{},"5599":{},"5600":{},"5601":{},"5602":{},"5603":{},"5604":{},"5605":{},"5606":{},"5607":{},"5608":{},"5609":{},"5610":{},"5611":{},"5612":{},"5613":{},"5614":{},"5615":{},"5616":{},"5617":{},"5618":{},"5619":{},"5620":{},"5621":{},"5622":{},"5623":{},"5624":{},"5625":{},"5626":{},"5627":{},"5628":{},"5629":{},"5630":{},"5631":{},"5632":{},"5633":{},"5634":{},"5635":{},"5636":{},"5637":{},"5638":{},"5639":{},"5640":{},"5641":{},"5642":{},"5643":{},"5644":{},"5645":{},"5646":{},"5647":{},"5648":{},"5649":{},"5650":{},"5651":{},"5652":{},"5653":{},"5654":{},"5655":{},"5656":{},"5657":{},"5658":{},"5659":{},"5660":{},"5661":{},"5662":{},"5663":{},"5664":{},"5665":{},"5666":{},"5667":{},"5668":{},"5669":{},"5670":{},"5671":{},"5672":{},"5673":{},"5674":{},"5675":{},"5676":{},"5677":{},"5678":{},"5679":{},"5680":{},"5681":{},"5682":{},"5683":{},"5684":{},"5685":{},"5686":{},"5687":{},"5688":{},"5689":{},"5690":{},"5691":{},"5692":{},"5693":{},"5694":{},"5695":{},"5696":{},"5697":{},"5698":{},"5699":{},"5700":{},"5701":{},"5702":{},"5703":{},"5704":{},"5705":{},"5706":{},"5707":{},"5708":{},"5709":{},"5710":{},"5711":{},"5712":{},"5713":{},"5714":{},"5715":{},"5716":{},"5717":{},"5718":{},"5719":{},"5720":{},"5721":{},"5722":{},"5723":{},"5724":{},"5725":{},"5726":{},"5727":{},"5728":{},"5729":{},"5730":{},"5731":{},"5732":{},"5733":{},"5734":{},"5735":{},"5736":{},"5737":{},"5738":{},"5739":{},"5740":{},"5741":{},"5742":{},"5743":{},"5744":{},"5745":{},"5746":{},"5747":{},"5748":{},"5749":{},"5750":{},"5751":{},"5752":{},"5753":{},"5754":{},"5755":{},"5756":{},"5757":{},"5758":{},"5759":{},"5760":{},"5761":{},"5762":{},"5763":{},"5764":{},"5765":{},"5766":{},"5767":{},"5768":{},"5769":{},"5770":{},"5771":{},"5772":{},"5773":{},"5774":{},"5775":{},"5776":{},"5777":{},"5778":{},"5779":{},"5780":{},"5781":{},"5782":{},"5783":{},"5784":{},"5785":{},"5786":{},"5787":{},"5788":{},"5789":{},"5790":{},"5791":{},"5792":{},"5793":{},"5794":{},"5795":{},"5796":{},"5797":{},"5798":{},"5799":{},"5800":{},"5801":{},"5802":{},"5803":{},"5804":{},"5805":{},"5806":{},"5807":{},"5808":{},"5809":{},"5810":{},"5811":{},"5812":{},"5813":{},"5814":{},"5815":{},"5816":{},"5817":{},"5818":{},"5819":{},"5820":{},"5821":{},"5822":{},"5823":{},"5824":{},"5825":{},"5826":{},"5827":{},"5828":{},"5829":{},"5830":{},"5831":{},"5832":{},"5833":{},"5834":{},"5835":{},"5836":{},"5837":{},"5838":{},"5839":{},"5840":{},"5841":{},"5842":{},"5843":{},"5844":{},"5845":{},"5846":{},"5847":{},"5848":{},"5849":{},"5850":{},"5851":{},"5852":{},"5853":{},"5854":{},"5855":{},"5856":{},"5857":{},"5858":{},"5859":{},"5860":{},"5861":{},"5862":{},"5863":{},"5864":{},"5865":{},"5866":{},"5867":{},"5868":{},"5869":{},"5870":{},"5871":{},"5872":{},"5873":{},"5874":{},"5875":{},"5876":{},"5877":{},"5878":{},"5879":{},"5880":{},"5881":{},"5882":{},"5883":{},"5884":{},"5885":{},"5886":{},"5887":{},"5888":{},"5889":{},"5890":{},"5891":{},"5892":{},"5893":{},"5894":{},"5895":{},"5896":{},"5897":{},"5898":{},"5899":{},"5900":{},"5901":{},"5902":{},"5903":{},"5904":{},"5905":{},"5906":{},"5907":{},"5908":{},"5909":{},"5910":{},"5911":{},"5912":{},"5913":{},"5914":{},"5915":{},"5916":{},"5917":{},"5918":{},"5919":{},"5920":{},"5921":{},"5922":{},"5923":{},"5924":{},"5925":{},"5926":{},"5927":{},"5928":{},"5929":{},"5930":{},"5931":{},"5932":{},"5933":{},"5934":{},"5935":{},"5936":{},"5937":{},"5938":{},"5939":{},"5940":{},"5941":{},"5942":{},"5943":{},"5944":{},"5945":{},"5946":{},"5947":{},"5948":{},"5949":{},"5950":{},"5951":{},"5952":{},"5953":{},"5954":{},"5955":{},"5956":{},"5957":{},"5958":{},"5959":{},"5960":{},"5961":{},"5962":{},"5963":{},"5964":{},"5965":{},"5966":{},"5967":{},"5968":{},"5969":{},"5970":{},"5971":{},"5972":{},"5973":{},"5974":{},"5975":{},"5976":{},"5977":{},"5978":{},"5979":{},"5980":{},"5981":{},"5982":{},"5983":{},"5984":{},"5985":{},"5986":{},"5987":{},"5988":{},"5989":{},"5990":{},"5991":{},"5992":{},"5993":{},"5994":{},"5995":{},"5996":{},"5997":{},"5998":{},"5999":{},"6000":{},"6001":{},"6002":{},"6003":{},"6004":{},"6005":{},"6006":{},"6007":{}}}],["zowe/zosmf",{"_index":4315,"name":{"6008":{}},"parent":{"6009":{},"6010":{},"6011":{},"6012":{},"6013":{},"6014":{},"6015":{},"6016":{},"6017":{},"6018":{},"6019":{},"6020":{},"6021":{},"6022":{},"6023":{},"6024":{},"6025":{},"6026":{},"6027":{},"6028":{},"6029":{},"6030":{},"6031":{},"6032":{},"6033":{},"6034":{},"6035":{},"6036":{},"6037":{},"6038":{},"6039":{},"6040":{},"6041":{},"6042":{},"6043":{},"6044":{},"6045":{},"6046":{},"6047":{},"6048":{},"6049":{},"6050":{},"6051":{},"6052":{},"6053":{},"6054":{},"6055":{},"6056":{},"6057":{},"6058":{},"6059":{},"6060":{},"6061":{},"6062":{},"6063":{},"6064":{},"6065":{},"6066":{},"6067":{},"6068":{},"6069":{},"6070":{},"6071":{},"6072":{},"6073":{},"6074":{},"6075":{},"6076":{},"6077":{},"6078":{},"6079":{},"6080":{},"6081":{},"6082":{},"6083":{},"6084":{},"6085":{},"6086":{},"6087":{},"6088":{},"6089":{},"6090":{},"6091":{},"6092":{},"6093":{},"6094":{},"6095":{},"6096":{},"6097":{},"6098":{},"6099":{},"6100":{},"6101":{},"6102":{},"6103":{},"6104":{},"6105":{},"6106":{},"6107":{},"6108":{},"6109":{},"6110":{},"6111":{},"6112":{},"6113":{},"6114":{},"6115":{},"6116":{},"6117":{},"6118":{},"6119":{},"6120":{},"6121":{},"6122":{},"6123":{},"6124":{},"6125":{},"6126":{},"6127":{},"6128":{},"6129":{},"6130":{},"6131":{},"6132":{},"6133":{},"6134":{},"6135":{},"6136":{},"6137":{},"6138":{},"6139":{},"6140":{},"6141":{},"6142":{},"6143":{},"6144":{},"6145":{},"6146":{},"6147":{},"6148":{},"6149":{},"6150":{},"6151":{},"6152":{},"6153":{},"6154":{},"6155":{},"6156":{},"6157":{},"6158":{},"6159":{},"6160":{},"6161":{},"6162":{},"6163":{},"6164":{},"6165":{},"6166":{},"6167":{},"6168":{},"6169":{},"6170":{},"6171":{},"6172":{},"6173":{},"6174":{},"6175":{},"6176":{},"6177":{},"6178":{},"6179":{},"6180":{},"6181":{},"6182":{},"6183":{},"6184":{},"6185":{},"6186":{},"6187":{},"6188":{},"6189":{},"6190":{},"6191":{},"6192":{},"6193":{},"6194":{},"6195":{},"6196":{},"6197":{},"6198":{},"6199":{},"6200":{}}}],["zowe_app_log_level",{"_index":2673,"name":{"3607":{}},"parent":{}}],["zowe_cli_home",{"_index":2672,"name":{"3606":{}},"parent":{}}],["zowe_cli_package_name",{"_index":2054,"name":{"2587":{},"3569":{}},"parent":{}}],["zowe_cli_secure_plugin_name",{"_index":2642,"name":{"3570":{}},"parent":{}}],["zowe_config_type",{"_index":2677,"name":{"3611":{}},"parent":{}}],["zowe_imperative_log_level",{"_index":2674,"name":{"3608":{}},"parent":{}}],["zowe_plugins",{"_index":2678,"name":{"3612":{}},"parent":{}}],["zowe_ver",{"_index":2666,"name":{"3600":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.apimlconstants.html b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.apimlconstants.html new file mode 100644 index 0000000000..ded7015e22 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.apimlconstants.html @@ -0,0 +1,341 @@ + + + + + + ApimlConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ApimlConstants

+
+
+
+
+
+
+
+
+
+

Class for various APIML constants.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ApimlConstants +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Static Readonly SERVICES_ENDPOINT

+
SERVICES_ENDPOINT: string = "/gateway/api/v1/services"
+ +
+
+

URI for listing APIML services

+
+
+
static
+
+
memberof
+

ApimlConstants

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.login.html b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.login.html new file mode 100644 index 0000000000..5fa78a1185 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.login.html @@ -0,0 +1,354 @@ + + + + + + Login | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Login

+
+
+
+
+
+
+
+
+
+

Class to handle logging onto APIML.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + Login +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static apimlLogin

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.loginconstants.html b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.loginconstants.html new file mode 100644 index 0000000000..3e4b28d89a --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.loginconstants.html @@ -0,0 +1,341 @@ + + + + + + LoginConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class LoginConstants

+
+
+
+
+
+
+
+
+
+

Class for various login constants.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + LoginConstants +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Static Readonly APIML_V1_RESOURCE

+
APIML_V1_RESOURCE: string = "/gateway/api/v1/auth/login"
+ +
+
+

URI base jobs API

+
+
+
static
+
+
memberof
+

LoginConstants

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.logout.html b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.logout.html new file mode 100644 index 0000000000..57c751631f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.logout.html @@ -0,0 +1,354 @@ + + + + + + Logout | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Logout

+
+
+
+
+
+
+
+
+
+

Class to handle logging out of APIML.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + Logout +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static apimlLogout

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.logoutconstants.html b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.logoutconstants.html new file mode 100644 index 0000000000..235e8f0af6 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.logoutconstants.html @@ -0,0 +1,441 @@ + + + + + + LogoutConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class LogoutConstants

+
+
+
+
+
+
+
+
+
+

Class for various logout constants.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + LogoutConstants +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Object literals

+ +
+
+
+
+
+

Properties

+
+ +

Static Readonly APIML_V1_RESOURCE

+
APIML_V1_RESOURCE: string = "/gateway/api/v1/auth/logout"
+ +
+
+

URI base jobs API

+
+
+
static
+
+
memberof
+

LogoutConstants

+
+
+
+
+
+ +

Static Readonly APIML_V1_TOKEN_EXP_ERR

+
APIML_V1_TOKEN_EXP_ERR: string = "TokenExpireException"
+ +
+
+

Zowe Token Expired Error Code

+
+
+
static
+
+
memberof
+

LogoutConstants

+
+
+
+
+
+
+

Object literals

+
+ +

Static Readonly APIML_V2_LOGOUT_ERR_LIST

+
APIML_V2_LOGOUT_ERR_LIST: object
+ +
+
+

Zowe Token Expired Error Codes

+
+
+
static
+
+
memberof
+

LogoutConstants

+
+
+
+
+ +

V1_TOKEN_EXPIRED

+
V1_TOKEN_EXPIRED: string = LogoutConstants.APIML_V1_TOKEN_EXP_ERR
+ +
+
+ +

V2_TOKEN_EXPIRED

+
V2_TOKEN_EXPIRED: string = "org.zowe.apiml.security.expiredToken"
+ +
+
+ +

V2_TOKEN_INVALID

+
V2_TOKEN_INVALID: string = "org.zowe.apiml.security.query.invalidToken"
+ +
+
+ +

V2_TOKEN_MISSING

+
V2_TOKEN_MISSING: string = "org.zowe.apiml.security.query.tokenNotProvided"
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.profileconstants.html b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.profileconstants.html new file mode 100644 index 0000000000..39038f9256 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.profileconstants.html @@ -0,0 +1,2137 @@ + + + + + + ProfileConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfileConstants

+
+
+
+
+
+
+
+
+
+

Class containing the various profile related constants

+
+
+
+
+

Hierarchy

+
    +
  • + ProfileConstants +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly APIML_LOGIN_DESCRIPTION

+
APIML_LOGIN_DESCRIPTION: string = "Log in to Zowe API Mediation Layer authentication service and obtain or update a token.\n" +"\n" +"The token provides authentication to services that support the API ML SSO (Single Sign-On) capability. When you log in, the token is " +"stored in your default base profile until it expires. Base profiles store connection information shared by multiple services (e.g., " +"z/OSMF), and are used if you do not supply connection information in a service profile. To take advantage of the API ML SSO capability, " +"you should omit username and password in service profiles so that the token in the base profile is used."
+ +
+
+

Description of APIML login command

+
+
+
static
+
+
memberof
+

AuthConstants

+
+
+
+
+
+ +

Static Readonly APIML_LOGIN_SUMMARY

+
APIML_LOGIN_SUMMARY: "Log in to API ML authentication service" = "Log in to API ML authentication service"
+ +
+
+

Summary of APIML login command

+
+
+
static
+
+
memberof
+

AuthConstants

+
+
+
+
+
+ +

Static Readonly APIML_LOGOUT_DESCRIPTION

+
APIML_LOGOUT_DESCRIPTION: string = "Log out of the Zowe API Mediation Layer authentication service and revoke the token so it " +"can no longer authenticate. Also remove the token from the default base profile, if it is stored on disk."
+ +
+
+

Description of APIML logout command

+
+
+
static
+
+
memberof
+

AuthConstants

+
+
+
+
+
+ +

Static Readonly APIML_LOGOUT_SUMMARY

+
APIML_LOGOUT_SUMMARY: "Log out of API ML authentication service" = "Log out of API ML authentication service"
+ +
+
+

Summary of APIML logout command

+
+
+
static
+
+
memberof
+

AuthConstants

+
+
+
+
+
+ +

Static Readonly AUTH_GROUP_DESCRIPTION

+
AUTH_GROUP_DESCRIPTION: string = "Connect to Zowe API Mediation Layer authentication service and obtain a token, or disconnect " +"from the authentication service and revoke the token.\n" +"\n" +"The token provides authentication to services that support the API ML SSO (Single Sign-On) capability. When you log in, the token is " +"stored in your default base profile until it expires. Base profiles store connection information shared by multiple services (e.g., " +"z/OSMF), and are used if you do not supply connection information in a service profile. To take advantage of the API ML SSO capability, " +"you should omit username and password in service profiles so that the token in the base profile is used."
+ +
+
+

Description of auth command group

+
+
+
static
+
+
memberof
+

AuthConstants

+
+
+
+
+
+ +

Static Readonly AUTH_GROUP_SUMMARY

+
AUTH_GROUP_SUMMARY: "Connect to Zowe API ML authentication service" = "Connect to Zowe API ML authentication service"
+ +
+
+

Summary of auth command group

+
+
+
static
+
+
memberof
+

AuthConstants

+
+
+
+
+
+ +

Static Readonly AUTO_INIT_OPTION_GROUP

+
AUTO_INIT_OPTION_GROUP: "APIML Connection Options" = "APIML Connection Options"
+ +
+
+

Option used to specify the path to the certificate file for authentication

+
+
+
+
+ +

Static Readonly BASE_CONNECTION_OPTION_GROUP

+
BASE_CONNECTION_OPTION_GROUP: "Base Connection Options" = "Base Connection Options"
+ +
+
+
+

Object literals

+
+ +

Static Readonly APIML_LOGIN_EXAMPLE1

+
APIML_LOGIN_EXAMPLE1: object
+ +
+
+

Example definition for APIML login command

+
+
+
static
+
+
memberof
+

AuthConstants

+
+
+
+
+ +

description

+
description: string = "Log in to an API ML instance to obtain or update the token stored in your base profile"
+ +
+
+ +

options

+
options: string = ""
+ +
+
+
+ +

Static Readonly APIML_LOGIN_EXAMPLE2

+
APIML_LOGIN_EXAMPLE2: object
+ +
+
+

Example definition for APIML login command with show-token

+
+
+
static
+
+
memberof
+

AuthConstants

+
+
+
+
+ +

description

+
description: string = "Log in to an API ML instance to obtain a token without storing it in a profile"
+ +
+
+ +

options

+
options: string = "--show-token"
+ +
+
+
+ +

Static Readonly APIML_LOGOUT_EXAMPLE1

+
APIML_LOGOUT_EXAMPLE1: object
+ +
+
+

Example definition for APIML logout command

+
+
+
static
+
+
memberof
+

AuthConstants

+
+
+
+
+ +

description

+
description: string = "Log out of an API ML instance to revoke the token that was in use and remove it from your base profile"
+ +
+
+ +

options

+
options: string = ""
+ +
+
+
+ +

Static Readonly APIML_LOGOUT_EXAMPLE2

+
APIML_LOGOUT_EXAMPLE2: object
+ +
+
+

Example definition for APIML logout command with token-value

+
+
+
static
+
+
memberof
+

AuthConstants

+
+
+
+
+ +

description

+
description: string = "Log out of an API ML instance to revoke a token that was not stored in a profile"
+ +
+
+ +

options

+
options: string = "--token-value <token>"
+ +
+
+
+ +

Static Readonly APIML_LOGOUT_OPTION_TOKEN_TYPE

+
APIML_LOGOUT_OPTION_TOKEN_TYPE: object
+ +
+
+

Option used in APIML logout command for token-type

+
+
+
+ +

allowableValues

+
allowableValues: object
+ +
+ +

values

+
values: any = SessConstants.ALL_TOKEN_TYPES.map(tk => tk.indexOf(SessConstants.TOKEN_TYPE_APIML) >= 0 ? `^${SessConstants.TOKEN_TYPE_APIML}.*` : tk)
+ +
+
+
+
+ +

Static AUTO_INIT_OPTION_CERT_FILE

+
AUTO_INIT_OPTION_CERT_FILE: object
+ +
+
+

Option used in profile creation and commands for certificate file to be used to interact with login APIs

+
+
+
+ +

description

+
description: string = "The file path to a certificate file to use to authenticate to the API Mediation Layer"
+ +
+
+ +

group

+
group: string = ProfileConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+
+ +

Static AUTO_INIT_OPTION_CERT_KEY_FILE

+
AUTO_INIT_OPTION_CERT_KEY_FILE: object
+ +
+
+

Option used in profile creation and commands for certificate key file to be used to interact with login APIs

+
+
+
+ +

description

+
description: string = "The file path to a certificate key file to use to authenticate to the API Mediation Layer"
+ +
+
+ +

group

+
group: string = ProfileConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+
+ +

Static Readonly AUTO_INIT_OPTION_HOST

+
AUTO_INIT_OPTION_HOST: object
+ +
+
+

Option used in profile creation and commands for hostname

+
+
+
+ +

description

+
description: string = "Host name of the mainframe running the API Mediation Layer."
+ +
+
+ +

group

+
group: string = ProfileConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+
+ +

Static Readonly AUTO_INIT_OPTION_PASSWORD

+
AUTO_INIT_OPTION_PASSWORD: object
+ +
+
+

Option used in profile creation and commands for password/passphrase

+
+
+
+ +

description

+
description: string = "Password to authenticate to the API Mediation Layer on the mainframe."
+ +
+
+ +

group

+
group: string = ProfileConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+
+ +

Static Readonly AUTO_INIT_OPTION_PORT

+
AUTO_INIT_OPTION_PORT: object
+ +
+
+

Option used in profile creation and commands for port

+
+
+
+ +

description

+
description: string = "Port number of API Mediation Layer on the mainframe."
+ +
+
+ +

group

+
group: string = ProfileConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+
+ +

Static Readonly AUTO_INIT_OPTION_REJECT_UNAUTHORIZED

+
AUTO_INIT_OPTION_REJECT_UNAUTHORIZED: object
+ +
+
+

Option used in profile creation and commands for rejectUnauthorized setting for connecting to z/OSMF

+
+
+
+ +

group

+
group: string = ProfileConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+
+ +

Static Readonly AUTO_INIT_OPTION_TOKEN_TYPE

+
AUTO_INIT_OPTION_TOKEN_TYPE: object
+ +
+
+

Option used in profile creation and commands for tokenType

+
+
+
+ +

description

+
description: string = "The type of token to get and use for the API Mediation Layer. " +"Omit this option to use the default token type, which is provided by 'zowe auth login'."
+ +
+
+ +

group

+
group: string = ProfileConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+
+ +

Static Readonly AUTO_INIT_OPTION_TOKEN_VALUE

+
AUTO_INIT_OPTION_TOKEN_VALUE: object
+ +
+
+

Option used in profile creation and commands for tokenValue to be used to interact with APIs

+
+
+
+ +

description

+
description: string = "The value of the token to pass to the API Mediation Layer."
+ +
+
+ +

group

+
group: string = ProfileConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+
+ +

Static Readonly AUTO_INIT_OPTION_USER

+
AUTO_INIT_OPTION_USER: object
+ +
+
+

Option used in profile creation and commands for username / ID

+
+
+
+ +

description

+
description: string = "User name to authenticate to the API Mediation Layer on the mainframe."
+ +
+
+ +

group

+
group: string = ProfileConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+
+ +

Static Readonly BASE_OPTION_CERT_FILE

+
BASE_OPTION_CERT_FILE: object
+ +
+
+

Option used to specify the path to the certificate file for authentication

+
+
+
+ +

description

+
description: string = "The file path to a certificate file to use for authentication.\n\nNote: " +"The CLI does not support certificate files that require a password. " +"For more information, search Troubleshooting PEM Certificates in Zowe Docs."
+ +
+
+ +

group

+
group: string = ProfileConstants.BASE_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "cert-file"
+ +
+
+ +

type

+
type: string = "existingLocalFile"
+ +
+
+
+ +

Static Readonly BASE_OPTION_CERT_KEY_FILE

+
BASE_OPTION_CERT_KEY_FILE: object
+ +
+
+

Option used to specify the path to the certificate file for authentication

+
+
+
+ +

description

+
description: string = "The file path to a certificate key file to use for authentication"
+ +
+
+ +

group

+
group: string = ProfileConstants.BASE_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "cert-key-file"
+ +
+
+ +

type

+
type: string = "existingLocalFile"
+ +
+
+
+ +

Static Readonly BASE_OPTION_HOST

+
BASE_OPTION_HOST: object
+ +
+
+

Option used in profile creation and commands for hostname

+
+
+
+ +

aliases

+
aliases: string[] = ["H"]
+ +
+
+ +

description

+
description: string = "Host name of service on the mainframe."
+ +
+
+ +

group

+
group: string = ProfileConstants.BASE_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "host"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static Readonly BASE_OPTION_PASSWORD

+
BASE_OPTION_PASSWORD: object
+ +
+
+

Option used in profile creation and commands for password/passphrase

+
+
+
+ +

aliases

+
aliases: string[] = ["pass", "pw"]
+ +
+
+ +

description

+
description: string = "Password to authenticate to service on the mainframe."
+ +
+
+ +

group

+
group: string = ProfileConstants.BASE_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "password"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static Readonly BASE_OPTION_PORT

+
BASE_OPTION_PORT: object
+ +
+
+

Option used in profile creation and commands for port

+
+
+
+ +

aliases

+
aliases: string[] = ["P"]
+ +
+
+ +

description

+
description: string = "Port number of service on the mainframe."
+ +
+
+ +

group

+
group: string = ProfileConstants.BASE_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "port"
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

Static Readonly BASE_OPTION_REJECT_UNAUTHORIZED

+
BASE_OPTION_REJECT_UNAUTHORIZED: object
+ +
+
+

Option used in profile creation and commands for rejectUnauthorized setting for connecting to z/OSMF

+
+
+
+ +

aliases

+
aliases: string[] = ["ru"]
+ +
+
+ +

defaultValue

+
defaultValue: boolean = true
+ +
+
+ +

description

+
description: string = "Reject self-signed certificates."
+ +
+
+ +

group

+
group: string = ProfileConstants.BASE_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "reject-unauthorized"
+ +
+
+ +

type

+
type: string = "boolean"
+ +
+
+
+ +

Static Readonly BASE_OPTION_TOKEN_TYPE

+
BASE_OPTION_TOKEN_TYPE: object
+ +
+
+

Option used in profile creation and commands for tokenType

+
+
+
+ +

aliases

+
aliases: string[] = ["tt"]
+ +
+
+ +

description

+
description: string = "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'."
+ +
+
+ +

group

+
group: string = ProfileConstants.BASE_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "token-type"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static Readonly BASE_OPTION_TOKEN_VALUE

+
BASE_OPTION_TOKEN_VALUE: object
+ +
+
+

Option used in profile creation and commands for tokenValue to be used to interact with APIs

+
+
+
+ +

aliases

+
aliases: string[] = ["tv"]
+ +
+
+ +

description

+
description: string = "The value of the token to pass to the API."
+ +
+
+ +

group

+
group: string = ProfileConstants.BASE_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "token-value"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static Readonly BASE_OPTION_USER

+
BASE_OPTION_USER: object
+ +
+
+

Option used in profile creation and commands for username / ID

+
+
+
+ +

aliases

+
aliases: string[] = ["u"]
+ +
+
+ +

description

+
description: string = "User name to authenticate to service on the mainframe."
+ +
+
+ +

group

+
group: string = ProfileConstants.BASE_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "user"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static Readonly BaseProfile

+
BaseProfile: object
+ +
+
+

Profile configuration for SSH profiles

+
+
+
memberof
+

BaseProfile

+
+
+
+
+ +

createProfileExamples

+
createProfileExamples: { description: string; options: string }[] = [{options: "base1 --host example.com --port 443 --user admin --password 123456",description: "Create a profile called 'base1' to connect to host example.com and port 443"},{options: "base2 --host example.com --user admin --password 123456 --reject-unauthorized false",description: "Create a profile called 'base2' to connect to host example.com (default port - 443) " +"and allow self-signed certificates"},{options: "base3 --host example.com --port 1443",description: "Create a profile called 'base3' to connect to host example.com and port 1443, " +" not specifying a username or password so they are not stored on disk; these will need to be specified on every command"},{options: "base4 --reject-unauthorized false",description: "Create a zosmf profile called 'base4' to connect to default port 443 and allow self-signed certificates, " +"not specifying a username, password, or host so they are not stored on disk; these will need to be specified on every command"}]
+ +
+
+ +

type

+
type: string = "base"
+ +
+
+ +

updateProfileExamples

+
updateProfileExamples: { description: string; options: string }[] = [{options: "base1 --user newuser --password newp4ss",description: "Update a base profile named 'base1' with a new username and password"}]
+ +
+
+ +

schema

+
schema: object
+ +
+ +

description

+
description: string = "Base profile that stores values shared by multiple service profiles"
+ +
+
+ +

required

+
required: undefined[] = []
+ +
+
+ +

title

+
title: string = "Base Profile"
+ +
+
+ +

type

+
type: string = "object"
+ +
+
+ +

properties

+
properties: object
+ +
+ +

certFile

+
certFile: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ProfileConstants.BASE_OPTION_CERT_FILE
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

certKeyFile

+
certKeyFile: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ProfileConstants.BASE_OPTION_CERT_KEY_FILE
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

host

+
host: object
+ +
+ +

includeInTemplate

+
includeInTemplate: boolean = true
+ +
+
+ +

optionDefinition

+
optionDefinition: any = ProfileConstants.BASE_OPTION_HOST
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

password

+
password: object
+ +
+ +

includeInTemplate

+
includeInTemplate: boolean = true
+ +
+
+ +

optionDefinition

+
optionDefinition: any = ProfileConstants.BASE_OPTION_PASSWORD
+ +
+
+ +

secure

+
secure: boolean = true
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

port

+
port: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ProfileConstants.BASE_OPTION_PORT
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

rejectUnauthorized

+
rejectUnauthorized: object
+ +
+ +

includeInTemplate

+
includeInTemplate: boolean = true
+ +
+
+ +

optionDefinition

+
optionDefinition: any = ProfileConstants.BASE_OPTION_REJECT_UNAUTHORIZED
+ +
+
+ +

type

+
type: string = "boolean"
+ +
+
+
+ +

tokenType

+
tokenType: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ProfileConstants.BASE_OPTION_TOKEN_TYPE
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

tokenValue

+
tokenValue: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ProfileConstants.BASE_OPTION_TOKEN_VALUE
+ +
+
+ +

secure

+
secure: boolean = true
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

user

+
user: object
+ +
+ +

includeInTemplate

+
includeInTemplate: boolean = true
+ +
+
+ +

optionDefinition

+
optionDefinition: any = ProfileConstants.BASE_OPTION_USER
+ +
+
+ +

secure

+
secure: boolean = true
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.services.html b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.services.html new file mode 100644 index 0000000000..a36a6f45b2 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.services.html @@ -0,0 +1,489 @@ + + + + + + Services | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Services

+
+
+
+
+
+
+
+
+
+

Class to handle listing services on APIML gateway.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + Services +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static convertApimlProfileInfoToProfileConfig

+ +
    +
  • + +
    +
    +

    Converts apiml profile information to team config profile objects to be stored in a zowe.config.json file

    +
    +
    +
    example
    +

    Input: IApimlProfileInfo[] = [ + { + profName: 'zosmf', + profType: 'zosmf', + basePaths: [ '/zosmf/api/v1' ], + pluginConfigs: Set(1) { [IApimlSvcAttrsLoaded] }, + conflictTypes: [ 'profType' ] + }, + { + profName: 'ibmzosmf', + profType: 'zosmf', + basePaths: [ '/ibmzosmf/api/v1' ], + pluginConfigs: Set(1) { [IApimlSvcAttrsLoaded] }, + conflictTypes: [ 'profType' ] + } + ] + Output: IConfig = { + "profiles": { + "zosmf": { + "type": "zosmf", + "properties": { + "basePath": "/zosmf/api/v1" + } + }, + "ibmzosmf": { + "type": "zosmf", + "properties": { + "basePath": "/ibmzosmf/api/v1" + } + } + }, + "defaults": { + // Multiple services were detected. + // Uncomment one of the lines below to set a different default + //"zosmf": "ibmzosmf" + "zosmf": "zosmf" + } + }

    +
    +
    memberof
    +

    Services

    +
    +
    +
    +

    Parameters

    + +

    Returns IConfig

    +

    List of config profile objects

    +
  • +
+
+
+ +

Static getPluginApimlConfigs

+ +
    +
  • + +
    +
    +

    Forms a list of APIML service attributes needed to query APIML for every + REST service for every loaded command group. This information can later + be used to create every connection profile required for every loaded + command group.

    +
    +
    +
    throws
    +

    {ImperativeError} When Imperative.init() has not been called + before getPluginApimlConfigs().

    +
    +
    +
    +

    Returns IApimlSvcAttrsLoaded[]

    +

    The APIML service attributes needed to query APIML.

    +
  • +
+
+
+ +

Static getServicesByConfig

+ +
    +
  • + +
    +
    +

    Calls the services endpoint of the APIML gateway to obtain a list of + services that support Single Sign-On. This list is compared against a + list of APIML service attributes defined in CLI plug-in configs. When a + service's API ID is present in both lists, a profile info object is + generated to store CLI profile info for connecting to that service.

    +
    +
    +
    static
    +
    +
    throws
    +

    {ImperativeError} When session object is undefined or missing + authentication info, or the REST request fails

    +
    +
    memberof
    +

    Services

    +
    +
    +
    +

    Parameters

    + +

    Returns Promise<IApimlProfileInfo[]>

    +

    List of objects containing profile info for APIML services

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.zosmfheaders.html b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.zosmfheaders.html new file mode 100644 index 0000000000..6df650de3f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.zosmfheaders.html @@ -0,0 +1,1334 @@ + + + + + + ZosmfHeaders | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ZosmfHeaders

+
+
+
+
+
+
+
+
+
+

Class to contain default z/OSMF headers

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ZosmfHeaders +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly IF_MATCH

+
IF_MATCH: "If-Match" = "If-Match"
+ +
+
+

Header to check ETag on write + Request returns HTTP 412 if not matched

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+
+ +

Static Readonly IF_NONE_MATCH

+
IF_NONE_MATCH: "If-None-Match" = "If-None-Match"
+ +
+
+

Header to check ETag on read + Request returns HTTP 304 if not modified

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+
+ +

Static Readonly RANGE

+
RANGE: string = "Range"
+ +
+
+

Header to set byte range

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+
+ +

Static Readonly X_IBM_INTRDR_LRECL

+
X_IBM_INTRDR_LRECL: "X-IBM-Intrdr-Lrecl" = "X-IBM-Intrdr-Lrecl"
+ +
+
+

lrecl header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+
+ +

Static Readonly X_IBM_INTRDR_RECFM

+
X_IBM_INTRDR_RECFM: "X-IBM-Intrdr-Recfm" = "X-IBM-Intrdr-Recfm"
+ +
+
+

recfm header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+
+ +

Static Readonly X_IBM_JCL_SYMBOL_PARTIAL

+
X_IBM_JCL_SYMBOL_PARTIAL: "X-IBM-JCL-Symbol-" = "X-IBM-JCL-Symbol-"
+ +
+
+

jcl symbol header to be completed by API

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+
+ +

Static Readonly X_IBM_RECORD_RANGE

+
X_IBM_RECORD_RANGE: string = "X-IBM-Record-Range"
+ +
+
+

Header to set record range

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+
+ +

Static Readonly X_IBM_RESPONSE_TIMEOUT

+
X_IBM_RESPONSE_TIMEOUT: string = "X-IBM-Response-Timeout"
+ +
+
+

Header to set response timeout + Timeout defaults to 30 seconds if not modified

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+
+ +

Static Readonly X_IBM_TEXT_ENCODING

+
X_IBM_TEXT_ENCODING: string = ";fileEncoding="
+ +
+
+

encoding value for text headers

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+
+
+

Object literals

+
+ +

Static Readonly ACCEPT_ENCODING

+
ACCEPT_ENCODING: object
+ +
+
+

Header that specifies GZIP compression is supported + Recent versions of z/OSMF issue a warning if this header is omitted

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

Accept-Encoding

+
Accept-Encoding: string = "gzip"
+ +
+
+
+ +

Static Readonly OCTET_STREAM

+
OCTET_STREAM: object
+ +
+
+

octet stream header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

Content-Type

+
Content-Type: string = "application/octet-stream"
+ +
+
+
+ +

Static Readonly TEXT_PLAIN

+
TEXT_PLAIN: object
+ +
+
+

plain text header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

Content-Type

+
Content-Type: string = "text/plain"
+ +
+
+
+ +

Static Readonly X_CSRF_ZOSMF_HEADER

+
X_CSRF_ZOSMF_HEADER: object
+ +
+
+

security header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-CSRF-ZOSMF-HEADER

+
X-CSRF-ZOSMF-HEADER: boolean = true
+ +
+
+
+ +

Static Readonly X_IBM_ATTRIBUTES_BASE

+
X_IBM_ATTRIBUTES_BASE: object
+ +
+
+

base header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Attributes

+
X-IBM-Attributes: string = "base"
+ +
+
+
+ +

Static Readonly X_IBM_BINARY

+
X_IBM_BINARY: object
+ +
+
+

binary transfer header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Data-Type

+
X-IBM-Data-Type: string = "binary"
+ +
+
+
+ +

Static Readonly X_IBM_BINARY_BY_RECORD

+
X_IBM_BINARY_BY_RECORD: object
+ +
+
+

binary by record header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Data-Type

+
X-IBM-Data-Type: string = "record"
+ +
+
+
+ +

Static Readonly X_IBM_INTRDR_CLASS_A

+
X_IBM_INTRDR_CLASS_A: object
+ +
+
+

job class header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Intrdr-Class

+
X-IBM-Intrdr-Class: string = "A"
+ +
+
+
+ +

Static Readonly X_IBM_INTRDR_LRECL_256

+
X_IBM_INTRDR_LRECL_256: object
+ +
+
+

256 lrecl header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Intrdr-Lrecl

+
X-IBM-Intrdr-Lrecl: string = "256"
+ +
+
+
+ +

Static Readonly X_IBM_INTRDR_LRECL_80

+
X_IBM_INTRDR_LRECL_80: object
+ +
+
+

80 lrecl header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Intrdr-Lrecl

+
X-IBM-Intrdr-Lrecl: string = "80"
+ +
+
+
+ +

Static Readonly X_IBM_INTRDR_MODE_TEXT

+
X_IBM_INTRDR_MODE_TEXT: object
+ +
+
+

text type header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Intrdr-Mode

+
X-IBM-Intrdr-Mode: string = "TEXT"
+ +
+
+
+ +

Static Readonly X_IBM_INTRDR_RECFM_F

+
X_IBM_INTRDR_RECFM_F: object
+ +
+
+

fixed recfm header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Intrdr-Recfm

+
X-IBM-Intrdr-Recfm: string = "F"
+ +
+
+
+ +

Static Readonly X_IBM_JOB_MODIFY_VERSION_1

+
X_IBM_JOB_MODIFY_VERSION_1: object
+ +
+
+

If you use this header, delete job API will be asynchronous. + This is the default setting, so using this header is not really necessary unless you want to be explicit.

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Job-Modify-Version

+
X-IBM-Job-Modify-Version: string = "1.0"
+ +
+
+
+ +

Static Readonly X_IBM_JOB_MODIFY_VERSION_2

+
X_IBM_JOB_MODIFY_VERSION_2: object
+ +
+
+

If you use this header, delete job API will be synchronous. + But using it may cause problems for some users depending on their maintenance level and configuration.

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Job-Modify-Version

+
X-IBM-Job-Modify-Version: string = "2.0"
+ +
+
+
+ +

Static Readonly X_IBM_MAX_ITEMS

+
X_IBM_MAX_ITEMS: object
+ +
+
+

This header value specifies the maximum number of items to return. + To request that all items be returned, set this header to 0. If you omit this header, or specify an incorrect value, + up to 1000 items are returned by default.

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Max-Items

+
X-IBM-Max-Items: string = "0"
+ +
+
+
+ +

Static Readonly X_IBM_MIGRATED_RECALL_ERROR

+
X_IBM_MIGRATED_RECALL_ERROR: object
+ +
+ +

X-IBM-Migrated-Recall

+
X-IBM-Migrated-Recall: string = "error"
+ +
+
+
+ +

Static Readonly X_IBM_MIGRATED_RECALL_NO_WAIT

+
X_IBM_MIGRATED_RECALL_NO_WAIT: object
+ +
+ +

X-IBM-Migrated-Recall

+
X-IBM-Migrated-Recall: string = "nowait"
+ +
+
+
+ +

Static Readonly X_IBM_MIGRATED_RECALL_WAIT

+
X_IBM_MIGRATED_RECALL_WAIT: object
+ +
+
+

data set migrated recall headers

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Migrated-Recall

+
X-IBM-Migrated-Recall: string = "wait"
+ +
+
+
+ +

Static Readonly X_IBM_NOTIFICATION_URL

+
X_IBM_NOTIFICATION_URL: object
+ +
+
+

n/a header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Notification-URL

+
X-IBM-Notification-URL: string = ""
+ +
+
+
+ +

Static Readonly X_IBM_RECORD

+
X_IBM_RECORD: object
+ +
+
+

record transfer header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Data-Type

+
X-IBM-Data-Type: string = "record"
+ +
+
+
+ +

Static Readonly X_IBM_RETURN_ETAG

+
X_IBM_RETURN_ETAG: object
+ +
+
+

Header to force return of ETag in response regardless of file size + By default Etag is returned only for files smaller than a system determined value (which is at least 8mb)

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Return-Etag

+
X-IBM-Return-Etag: string = "true"
+ +
+
+
+ +

Static Readonly X_IBM_TEXT

+
X_IBM_TEXT: object
+ +
+
+

text transfer header

+
+
+
static
+
+
memberof
+

ZosmfHeaders

+
+
+
+
+ +

X-IBM-Data-Type

+
X-IBM-Data-Type: string = "text"
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.zosmfrestclient.html b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.zosmfrestclient.html new file mode 100644 index 0000000000..3c4cd45fd1 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_core_for_zowe_sdk.zosmfrestclient.html @@ -0,0 +1,439 @@ + + + + + + ZosmfRestClient | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ZosmfRestClient

+
+
+
+
+
+
+
+
+
+

Wrapper for invoke z/OSMF API through the RestClient to perform common error + handling and checking and resolve promises according to generic types

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + any +
      +
    • + ZosmfRestClient +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Accessors

+
+ +

log

+ + +
+
+
+

Methods

+
+ +

Protected appendHeaders

+
    +
  • appendHeaders(headers: any[] | undefined): any[]
  • +
+
    +
  • + +
    +
    +

    Append z/OSMF specific headers to the callers headers for cases + where a header is common to every request.

    +
    +
    +
    memberof
    +

    ZosmfRestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      headers: any[] | undefined
      +
      +

      current header array

      +
      +
    • +
    +

    Returns any[]

    +
  • +
+
+
+ +

Protected processError

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractauthhandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractauthhandler.html new file mode 100644 index 0000000000..37bcb53afc --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractauthhandler.html @@ -0,0 +1,521 @@ + + + + + + AbstractAuthHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AbstractAuthHandler

+
+
+
+
+
+
+
+
+
+

This class is used by the auth command handlers as the base class for their implementation.

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Protected Abstract mDefaultTokenType

+
mDefaultTokenType: SessConstants.TOKEN_TYPE_CHOICES
+ +
+
+

The default token type to use if not specified as a command line option

+
+
+
+
+ +

Protected Abstract mProfileType

+
mProfileType: string
+ +
+
+

The profile type where token type and value should be stored

+
+
+
+
+ +

Protected Optional mServiceDescription

+
mServiceDescription: string
+ +
+
+

The description of your service to be used in CLI prompt messages

+
+
+
+
+
+

Methods

+
+ +

Protected Abstract createSessCfgFromArgs

+ + +
+
+ +

Abstract getAuthHandlerApi

+ + +
+
+ +

Abstract getPromptParams

+ + +
+
+ +

process

+ + +
+
+ +

Protected Abstract processLogin

+ + +
+
+ +

Protected Abstract processLogout

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Protected property
  • +
  • Protected method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractcommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractcommandbuilder.html new file mode 100644 index 0000000000..5f5501e0fe --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractcommandbuilder.html @@ -0,0 +1,362 @@ + + + + + + AbstractCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AbstractCommandBuilder

+
+
+
+
+
+
+
+
+
+

profile.schema Command Builder - used in the module loaders to build and append additional profile.schemaside commands as + requested by the module definition.

+
+
+
+
+

Hierarchy

+
    +
  • + AbstractCommandBuilder +
  • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Abstract build

+ + +
+
+ +

Abstract buildFull

+ + +
+
+ +

Abstract getAction

+
    +
  • getAction(): string
  • +
+ +
+
+ +

Static appendToDocument

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractcommandyargs.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractcommandyargs.html new file mode 100644 index 0000000000..8e1f04bef8 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractcommandyargs.html @@ -0,0 +1,1119 @@ + + + + + + AbstractCommandYargs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AbstractCommandYargs

+
+
+
+
+
+
+
+
+
+

Abstract Yargs Bright Command - Contains base methods for defining commands and groups

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected log

+
log: Logger = Logger.getImperativeLogger()
+ +
+
+ +

Private mCommandLine

+
mCommandLine: string
+ +
+
+

The command line.

+
+
+
memberof
+

AbstractCommandYargs

+
+
+
+
+
+ +

Private mCommandResponseParms

+
mCommandResponseParms: ICommandResponseParms
+ +
+
+

Command response parameters - controls command response processing when help and command handlers are invoked

+
+
+
+
+ +

Private mDefinition

+
mDefinition: ICommandDefinition
+ +
+
+

The command definition document

+
+
+
+
+ +

Private mEnvVariablePrefix

+
mEnvVariablePrefix: string
+ +
+
+

Environmental variable name prefix used to construct configuration environmental variables.

+
+
+
memberof
+

AbstractCommandYargs

+
+
+
+
+
+ +

Private mHelpGeneratorFactory

+
mHelpGeneratorFactory: IHelpGeneratorFactory
+ +
+
+

The help generator factory for creating help generators for the commands

+
+
+
+
+ +

Private mParent

+ + +
+
+

The Yargs parent object - used to obtain parent handlers.

+
+
+
+
+ +

Private mProfileManagerFactory

+ + +
+
+

Profile manager factory (for creating managers of certain types)

+
+
+
memberof
+

AbstractCommandYargs

+
+
+
+
+
+ +

Private mPromptPhrase

+
mPromptPhrase: string
+ +
+
+

Prompt phrase which indicates the user would like to be prompted for an argument's value with a hidden text prompt

+
+
+
memberof
+

AbstractCommandYargs

+
+
+
+
+
+ +

Private mRootCommandName

+
mRootCommandName: string
+ +
+
+

The root command name for the CLI.

+
+
+
memberof
+

AbstractCommandYargs

+
+
+
+
+
+ +

Private mYargsInstance

+
mYargsInstance: Argv
+ +
+
+

The Yargs instance to define the command.

+
+
+
+
+ +

Protected yargsParms

+
yargsParms: IYargsParms
+ +
+
+

Parameter object contains parms for Imperative/Yargs and command response objects

+
+
+
+
+ +

Static STOP_YARGS

+
STOP_YARGS: boolean = false
+ +
+
+

TODO: REMOVE THIS, workaround for yargs.fail() problem

+
+
+
+
+
+

Accessors

+
+ +

Protected commandLine

+
    +
  • get commandLine(): string
  • +
+ +
+
+ +

definition

+ + +
+
+ +

Protected envVariablePrefix

+
    +
  • get envVariablePrefix(): string
  • +
+ +
+
+ +

Protected helpGeneratorFactory

+ + +
+
+ +

parents

+ + +
+
+ +

Protected profileManagerFactory

+ + +
+
+ +

Protected promptPhrase

+
    +
  • get promptPhrase(): string
  • +
+ +
+
+ +

Protected responseParms

+ + +
+
+ +

Protected rootCommandName

+
    +
  • get rootCommandName(): string
  • +
+ +
+
+ +

yargs

+
    +
  • get yargs(): Argv
  • +
+ +
+
+
+

Methods

+
+ +

constructDefinitionTree

+ + +
+
+ +

Abstract defineCommandToYargs

+ + +
+
+ +

Protected executeHelp

+ + +
+
+ +

Protected executeWebHelp

+ + +
+
+ +

Protected getBrightYargsResponse

+ + +
+
+ +

Protected getDepthExamples

+ + +
+
+ +

Protected getZoweYargsResponse

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Protected property
  • +
  • Protected method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractcredentialmanager.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractcredentialmanager.html new file mode 100644 index 0000000000..d2d2c79191 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractcredentialmanager.html @@ -0,0 +1,734 @@ + + + + + + AbstractCredentialManager | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AbstractCredentialManager

+
+
+
+
+
+
+
+
+
+

The abstract credential manager defines basic methods that must be implemented by any credential manager + provided to Imperative. The abstract class is used by various methods for proper typing information.

+
+

All credential managers will be instantiated by CredentialManagerFactory.initialize and are + expected to extend the AbstractCredentialManager. This is enforced by requiring your class constructor + to follow the implementation rules specified by the ICredentialManagerConstructor.

+

The constructor signature that the ICredentialManagerConstructor specifies will always be identical to + the constructor signature of the AbstractCredentialManager superclass.

+

Imperative will provide your CLI with a default manager, DefaultCredentialManager. If the default provided + is not to your liking, you can provide your own manager as a parameter on Imperative.init at startup. This is + done by providing it as part of the IImperativeConfig.overrides object.

+
+
see
+

{@link IImperativeOverrides.CredentialManager}

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

Protected constructor

+ +
    +
  • + +
    +
    +

    This class can not be directly instantiated so the constructor is protected. All extending classes must make a call + to super(...) with the expected parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      service: string
      +
      +
      +

      The service that the Credential Manager is running under. Imperative will set this to the + cliName

      +
      +
      +
    • +
    • +
      displayName: string
      +
      +
      +

      The display name of this manager. Used in messaging/logging.

      +
      +
      +
    • +
    +

    Returns AbstractCredentialManager

    +
  • +
+
+
+
+

Properties

+
+ +

Private displayName

+
displayName: string
+ +
+
+

The display name of this manager. Used in messaging/logging.

+
+
+
+
+ +

Protected Readonly service

+
service: string
+ +
+
+

The service that the Credential Manager is running under. Imperative will set this to the + cliName

+
+
+
+
+
+

Accessors

+
+ +

name

+
    +
  • get name(): string
  • +
+ +
+
+ +

Protected possibleSolutions

+
    +
  • get possibleSolutions(): string[] | undefined
  • +
+ +
+
+
+

Methods

+
+ +

delete

+
    +
  • delete(account: string): Promise<void>
  • +
+ +
+
+ +

Protected Abstract deleteCredentials

+
    +
  • deleteCredentials(account: string): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Called by Imperative to delete the credentials of a profile.

    +
    +
    +
    throws
    +

    {ImperativeError} - when the delete operation failed. The error object should have details about what failed.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      account: string
      +
      +

      A user account (or profile identifier)

      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+ +

Optional initialize

+ +
    +
  • + +
    +
    +

    This is an optional method that your Credential Manager may choose to implement. If present, it + will be called by the CredentialManagerFactory.initialize function to allow your + manager to do more initialization after the class has become instantiated.

    +
    +

    Also, since asynchronous operations are not well handled in the constructor, this allows your + Credential Manager to perform any asynchronous operations needed. Your initialize method just + has to return the promise and we'll handle the rest.

    +
    +

    Returns Promise<void>

    +

    A promise of the completion of your initialize function.

    +
  • +
+
+
+ +

load

+
    +
  • load(account: string, optional?: boolean): Promise<string>
  • +
+
    +
  • + +
    +
    +

    Load credentials for an account managed by the credential manager.

    +
    +
    +

    Parameters

    +
      +
    • +
      account: string
      +
      +

      The account (or profile identifier) associated with credentials

      +
      +
    • +
    • +
      Optional optional: boolean
      +
      +

      Set to true if failure to find credentials should be ignored

      +
      +
    • +
    +

    Returns Promise<string>

    +

    The username and password associated with the account.

    +
  • +
+
+
+ +

Protected Abstract loadCredentials

+ +
    +
  • + +
    +
    +

    Called by Imperative to load the credentials of a profile.

    +
    +
    +
    throws
    +

    {ImperativeError} - when the get operation failed. The error object should have details about what failed.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      account: string
      +
      +

      A user account (or profile identifier)

      +
      +
    • +
    • +
      Optional optional: boolean
      +
      +

      Set to true if failure to find credentials should be ignored

      +
      +
    • +
    +

    Returns Promise<SecureCredential>

    +
      +
    • A base64 encoded username:password string
    • +
    +
  • +
+
+
+ +

save

+
    +
  • save(account: string, secureValue: string): Promise<void>
  • +
+ +
+
+ +

Protected Abstract saveCredentials

+ +
    +
  • + +
    +
    +

    Called by Imperative to save the credentials for a profile.

    +
    +
    +
    throws
    +

    {ImperativeError} - when the set operation failed. The error object should have details about what failed.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      account: string
      +
      +

      A user account (or profile identifier)

      +
      +
    • +
    • +
      credentials: SecureCredential
      +
      +

      A base64 encoded username:password string

      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+ +

secureErrorDetails

+
    +
  • secureErrorDetails(): string | undefined
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Protected property
  • +
  • Protected method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.abstracthelpgenerator.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstracthelpgenerator.html new file mode 100644 index 0000000000..d80b019252 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstracthelpgenerator.html @@ -0,0 +1,834 @@ + + + + + + AbstractHelpGenerator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AbstractHelpGenerator

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected groupToOption

+
groupToOption: {}
+ +
+
+

A map of group names to option names and aliases - useful in help text/doc generation + e.g. this.grouptoOption["job options"] -> [ "--async | -a ", "--activate | -A"]

+
+
+
+

Type declaration

+
    +
  • +
    [key: string]: string[]
    +
  • +
+
+
+
+ +

Protected mCommandDefinition

+
mCommandDefinition: ICommandDefinition
+ +
+
+

The command definition for which we are building help

+
+
+
+
+ +

Protected mDefinitionTree

+
mDefinitionTree: ICommandDefinition
+ +
+
+

The full command definition - which includes the parents of the command.

+
+
+
+
+ +

Protected mExperimentalCommandDescription

+
mExperimentalCommandDescription: string = Constants.DEFAULT_EXPERIMENTAL_COMMAND_EXPLANATION
+ +
+
+

The configured experimental command description. + Has a default, generic description which can be overridden through parameters + to the constructor

+
+
+
+
+ +

Protected mLog

+
mLog: Logger
+ +
+
+

Logger

+
+
+
+
+ +

Protected mPrimaryHighlightColor

+
mPrimaryHighlightColor: string
+ +
+
+ +

Protected mProduceMarkdown

+
mProduceMarkdown: boolean = false
+ +
+
+

Produce markdown - not help text.

+
+
+
+
+ +

Protected mRootCommandName

+
mRootCommandName: string
+ +
+
+

The command name being invoked by the user. + For example, when using "banana --help", banana is the command name.

+
+
+
+
+ +

Protected optionToDescription

+
optionToDescription: {}
+ +
+
+

A map of option names and aliases to their descriptions - useful in help text/doc generation + e.g. this.optionToDescription["--async | a"] -> "Don't wait for this job to complete before returning"

+
+
+
+

Type declaration

+
    +
  • +
    [key: string]: string
    +
  • +
+
+
+
+ +

Static LONG_DASH

+
LONG_DASH: string = "--"
+ +
+
+ +

Static SHORT_DASH

+
SHORT_DASH: string = "-"
+ +
+
+
+

Accessors

+
+ +

Protected log

+ + +
+
+
+

Methods

+
+ +

Abstract buildFullCommandHelpText

+
    +
  • buildFullCommandHelpText(includeGlobalOptions: boolean): string
  • +
+ +
+
+ +

Abstract buildHelp

+
    +
  • buildHelp(): string
  • +
+ +
+
+ +

Protected buildOptionMaps

+
    +
  • buildOptionMaps(): void
  • +
+ +
+
+ +

Protected dimGrey

+
    +
  • dimGrey(text: string): any
  • +
+ +
+
+ +

Protected explainType

+ + +
+
+ +

Protected getCaseSensitiveFlagByOptionName

+
    +
  • getCaseSensitiveFlagByOptionName(optionName: string): boolean
  • +
+ +
+
+ +

getOptionAndAliasesString

+ + +
+
+ +

Protected grey

+
    +
  • grey(text: string): any
  • +
+ +
+
+ +

Protected renderHelp

+
    +
  • renderHelp(help: string): string
  • +
+ +
+
+ +

Static formatHelpHeader

+
    +
  • formatHelpHeader(header: string, indent?: string, color: string): string
  • +
+
    +
  • + +
    +
    +

    Get a heading for the CLI / help

    +
    +
    +

    Parameters

    +
      +
    • +
      header: string
      +
      +

      The text you want to display in the header

      +
      +
    • +
    • +
      Default value indent: string = " "
      +
      +

      prefix the the heading and dashes with this string (defaults to one space)

      +
      +
    • +
    • +
      color: string
      +
      +

      the color to highlight the header in

      +
      +
    • +
    +

    Returns string

    +

    the formatted/colored header

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Protected property
  • +
  • Protected method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.abstracthelpgeneratorfactory.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstracthelpgeneratorfactory.html new file mode 100644 index 0000000000..1161f3c892 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstracthelpgeneratorfactory.html @@ -0,0 +1,630 @@ + + + + + + AbstractHelpGeneratorFactory | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AbstractHelpGeneratorFactory

+
+
+
+
+
+
+
+
+
+

The abstract help generator factory class - implemented normally by imperative to provide the help generator + object that should be used for your CLI.

+
+
+
export
+
+
abstract
+
+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mParms

+ + +
+
+

The input parameters to the factory.

+
+
+
memberof
+

AbstractHelpGeneratorFactory

+
+
+
+
+
+ +

Private mPrimaryHighlightColor

+
mPrimaryHighlightColor: string
+ +
+
+

The primary highlight color - for terminal/console coloring

+
+
+
memberof
+

AbstractHelpGeneratorFactory

+
+
+
+
+
+ +

Private mProduceMarkdown

+
mProduceMarkdown: boolean
+ +
+
+

True to produce markdown instead of the "normal" help text

+
+
+
memberof
+

AbstractHelpGeneratorFactory

+
+
+
+
+
+ +

Private mRootCommandName

+
mRootCommandName: string
+ +
+
+

The root command name of your CLI

+
+
+
memberof
+

AbstractHelpGeneratorFactory

+
+
+
+
+
+
+

Accessors

+
+ +

Protected factoryParameters

+ + +
+
+ +

Protected primaryHighlightColor

+
    +
  • get primaryHighlightColor(): string
  • +
+ +
+
+ +

Protected produceMarkdown

+
    +
  • get produceMarkdown(): boolean
  • +
+ +
+
+ +

Protected rootCommandName

+
    +
  • get rootCommandName(): string
  • +
+ +
+
+
+

Methods

+
+ +

Protected Abstract getGenerator

+ + +
+
+ +

getHelpGenerator

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractpluginlifecycle.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractpluginlifecycle.html new file mode 100644 index 0000000000..f9bea44392 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractpluginlifecycle.html @@ -0,0 +1,315 @@ + + + + + + AbstractPluginLifeCycle | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AbstractPluginLifeCycle

+
+
+
+
+
+
+
+
+
+

An optional module of a plugin extends this class to + perform actions during the installation lifecycle of a plugin. + A plugin identifies that it supplies a life cycle class + by specifying the 'pluginLifeCycle' imperative configuration property.

+
+
+
+
+

Hierarchy

+
    +
  • + AbstractPluginLifeCycle +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Abstract postInstall

+
    +
  • postInstall(): Promise<void> | void
  • +
+
    +
  • + +
    +
    +

    This function will be called after a plugin is installed. + A plugin can use this opportunity to perform a sanity test or to + perform some additional setup which is specific to that plugin. + A plugin which provides a specialized credential manager should use + this opportunity to insert itself as an override of the standard + credential manager that is delivered with Zowe CLI.

    +
    +

    If the plugin's postInstall function performs an asynchronous operation, + its postInstall function should return a promise, allowing the CLI + framework to await the postInstall function. If it has no asynchronous + operation, the postInstall function can be written as a synchronous function.

    +
    +
    throws
    +
     An ImperativeError containing a message describing any error
    + that occurred while performing post-install actions.
    +
    +
    +
    +
    +

    Returns Promise<void> | void

    +
  • +
+
+
+ +

Abstract preUninstall

+
    +
  • preUninstall(): Promise<void> | void
  • +
+
    +
  • + +
    +
    +

    This function will be called before a plugin is uninstalled. + This lifecycle hook is intended to replace the capability that used to + be performed by the NPM pre-uninstall action before NPM removed that + capability in NPM version 7. + See https://docs.npmjs.com/cli/v9/using-npm/scripts#a-note-on-a-lack-of-npm-uninstall-scripts

    +
    +

    A plugin can use this opportunity to revert any specialized setup that was + established during the lifetime of the plugin. A plugin which provides a + specialized credential manager should use this opportunity to remove itself as + an override of the standard credential manager that is delivered with Zowe CLI.

    +

    If the plugin's preUninstall function performs an asynchronous operation, + its preUninstall function should return a promise, allowing the CLI + framework to await the preUninstall function. If it has no asynchronous + operation, the preUninstall function can be written as a synchronous function.

    +
    +
    throws
    +
     An ImperativeError containing a message describing any error
    + that occurred while performing pre-uninstall actions.
    +
    +
    +
    +
    +

    Returns Promise<void> | void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractprofilemanager.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractprofilemanager.html new file mode 100644 index 0000000000..00935ea3d0 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractprofilemanager.html @@ -0,0 +1,2702 @@ + + + + + + AbstractProfileManager | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AbstractProfileManager<T>

+
+
+
+
+
+
+
+
+
+

The abstract profile manager contains most (if not all in some cases) methods to manage Imperative profiles. Profiles + are user configuration documents intended to be used on commands, as a convenience, to supply a slew of additional + input and configuration (normally more than would be feasible as command arguments). See the "IProfile" interface + for a detailed description of profiles, their use case, and examples.

+
+

The abstract manager is implemented by (at least as part of Imperative) the BasicProfileManager. The BasicProfileManager + implements the save, load, update, etc. methods in, as the name implies, a "basic" way. In general, the abstract + manager contains all parameter and profile validation code, methods to write/read/etc and the Basic Manager uses + most of the internal methods to perform the "work". The basic manager does in some cases change the default abstract + behavior (such as for loadAll profile and loadDependencies).

+

Imperative, however, uses the the "Cli Profile Manager", which extends the "Basic Profile Manager". The CLI Manager includes + additional capabilities, such as creating or updating a profile from command line arguments.

+

In general, Imperative CLI's will use the "Cli Profile Manager", where the "Basic Profile Manager" is normally sufficient + for usage outside of Imperative (for usage in building extensions to editors, Electron apps, programmatic usage of + APIs built by implementations of Imperative, etc.), although either can be used.

+

It is not an absolute requirement, but in the case of an Imperative CLI, the "Basic Profile Manager initialize()" API + is invoked to create the required directories and sub-directories. This is NOT a requirement, but avoiding "initialize()" + means you must supply all configuration information to the manager when creating an instance. See the "initialize()" API + method in the "BasicProfileManager" for full details.

+
+
export
+
+
abstract
+
+
+
+
+
+

Type parameters

+ +
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ +
    +
  • + +
    +
    +

    Creates an instance of ProfileManager - Performs basic parameter validation and will create the required + profile root directory (if it does not exist) and will attempt to load type configurations from the + existing profile root directory (unless the type definitions are passed on the constructor parameters).

    +
    +
    +
    memberof
    +

    ProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      parms: IProfileManager<T>
      +
      +
      +

      See the interface for details.

      +
      +
      +
    • +
    +

    Returns AbstractProfileManager

    +
  • +
+
+
+
+

Properties

+
+ +

Private mConstructorParms

+
mConstructorParms: IProfileManager<T>
+ +
+
+

Parameters passed on the constructor (normally used to create additional instances of profile manager objects)

+
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Private mLoadCounter

+
mLoadCounter: Map<string, number> = new Map<string, number>()
+ +
+
+

Load counter for this instance of the imperative profile manager. The load counter ensures that we are not + attempting to load circular dependencies by checking if a load (with dependencies) is attempting a load of + the same profile twice. The counts are reset when the loads complete, so state should be preserved correctly.

+
+
+
static
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Private mLogger

+
mLogger: Logger = Logger.getImperativeLogger()
+ +
+
+

Logger instance - must be log4js compatible. Can be the Imperative logger (normally), but is required for + profile manager operation.

+
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Private mProductDisplayName

+
mProductDisplayName: string
+ +
+
+

Product display name of the CLI.

+
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Private mProfileRootDirectory

+
mProfileRootDirectory: string
+ +
+
+

The profile root directory is normally supplied on an Imperative configuration document, but it is the + location where all profile type directories are stored.

+
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Private mProfileType

+
mProfileType: string
+ +
+
+

The profile "type" for this manager - indicating the profile/schema that this manager is working directly with.

+
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Private mProfileTypeConfiguration

+
mProfileTypeConfiguration: T
+ +
+
+

The profile configuration document for the "type" defined to this manager. Contains the schema and dependency + specifications for the profile type.

+
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Private mProfileTypeConfigurations

+
mProfileTypeConfigurations: T[]
+ +
+
+

The full set of profile type configurations. The manager needs to ensure that A) the profile type configuration + is among the set (because it contains schema and dependency specifications) and B) That other type configurations + are available to verify/load dependencies, etc.

+
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Private mProfileTypeMetaFileName

+
mProfileTypeMetaFileName: string
+ +
+
+

The meta file name for this profile type. Of the form "_meta".

+
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Private mProfileTypeRootDirectory

+
mProfileTypeRootDirectory: string
+ +
+
+

The root directory for the type (contained within the profile root directory).

+
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Private mProfileTypeSchema

+
mProfileTypeSchema: IProfileSchema
+ +
+
+

The profile schema for the "type". The JSON schema is used to validate any profiles loaded or saved by this + profile manager for the type.

+
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Static Readonly META_FILE_SUFFIX

+
META_FILE_SUFFIX: string = "_meta"
+ +
+
+

The meta file suffix - always appended to the meta file to distinguish from other profiles. Users then cannot + supply a profile name that would conflict with the meta file.

+
+
+
static
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Static Readonly PROFILE_EXTENSION

+
PROFILE_EXTENSION: string = ".yaml"
+ +
+
+

The default profile file extension (YAML format) - all profiles are stored in YAML format including + the meta profile file.

+
+
+
static
+
+
memberof
+

ProfileManager

+
+
+
+
+
+
+

Accessors

+
+ +

configurations

+ + +
+
+ +

Protected loadCounter

+
    +
  • get loadCounter(): Map<string, number>
  • +
+ +
+
+ +

Protected log

+ + +
+
+ +

Protected managerParameters

+ + +
+
+ +

Protected productDisplayName

+
    +
  • get productDisplayName(): string
  • +
+ +
+
+ +

Protected profileRootDirectory

+
    +
  • get profileRootDirectory(): string
  • +
+ +
+
+ +

Protected profileType

+
    +
  • get profileType(): string
  • +
+ +
+
+ +

Protected profileTypeConfiguration

+
    +
  • get profileTypeConfiguration(): T
  • +
+ +
+
+ +

Protected profileTypeConfigurations

+
    +
  • get profileTypeConfigurations(): T[]
  • +
+ +
+
+ +

Protected profileTypeMetaFileName

+
    +
  • get profileTypeMetaFileName(): string
  • +
+ +
+
+ +

Protected profileTypeRootDirectory

+
    +
  • get profileTypeRootDirectory(): string
  • +
+ +
+
+ +

Protected profileTypeSchema

+ + +
+
+
+

Methods

+
+ +

clearDefault

+
    +
  • clearDefault(): string
  • +
+ +
+
+ +

Private collectAllConfigurations

+
    +
  • collectAllConfigurations(): T[]
  • +
+ +
+
+ +

Protected constructFullProfilePath

+
    +
  • constructFullProfilePath(name: string, type?: string): string
  • +
+
    +
  • + +
    +
    +

    Constructs the full path to the profile of the managers "type".

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      The profile name to construct the path

      +
      +
    • +
    • +
      Default value type: string = this.profileType
      +
    • +
    +

    Returns string

    +
      +
    • The full profile directory.
    • +
    +
  • +
+
+
+ +

Private constructMetaName

+
    +
  • constructMetaName(type?: string): string
  • +
+ +
+
+ +

Private createProfileTypeDirectory

+
    +
  • createProfileTypeDirectory(): string
  • +
+ +
+
+ +

delete

+ +
    +
  • + +
    +
    +

    Deletes a profile from disk. Ensures that the parameters are correct and removes the profile. If the profile is listed as a dependency of + other profiles it will NOT delete the profile unless "rejectIfDependency" is set to false.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      parms: D
      +
      +

      See the interface for details

      +
      +
    • +
    +

    Returns Promise<IProfileDeleted>

    +
      +
    • The promise that is fulfilled with the response object (see interface for details) or rejected + with an Imperative Error.
    • +
    +
  • +
+
+
+ +

Protected Abstract deleteProfile

+ + +
+
+ +

Protected deleteProfileFromDisk

+
    +
  • deleteProfileFromDisk(name: string): string
  • +
+ +
+
+ +

Private failNotFoundDefaultResponse

+ + +
+
+ +

getAllProfileNames

+
    +
  • getAllProfileNames(): string[]
  • +
+
    +
  • + +
    +
    +

    Obtains all profile names for the profile "type" specified on the manager. The names are obtained from the + filesystem (in the profile type directory) and the meta file is NOT returned in the list.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Returns string[]

    +
      +
    • The list of profile names (obtained from disk).
    • +
    +
  • +
+
+
+ +

getDefaultProfileName

+
    +
  • getDefaultProfileName(): string
  • +
+ +
+
+ +

Private isDependencyOf

+ + +
+
+ +

Protected isProfileEmpty

+
    +
  • isProfileEmpty(profile: IProfile): boolean
  • +
+
    +
  • + +
    +
    +

    Checks if the profile object passed is "empty" - meaning it has no contents other than that type or name. + A profile can only specify "dependencies", in the event that it is just acting as a "pointer" to another profile.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      profile: IProfile
      +
      +

      The profile to check for "emptiness".

      +
      +
    • +
    +

    Returns boolean

    +

    True if the profile object is empty.

    +
  • +
+
+
+ +

load

+ +
    +
  • + +
    +
    +

    Load a profile from disk. Ensures that the parameters are valid and loads the profile specified by name OR the default profile if + requested. If load default is requested, any name supplied is ignored.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      parms: L
      +
      +

      See the interface for details.

      +
      +
    • +
    +

    Returns Promise<IProfileLoaded>

    +
      +
    • The promise that is fulfilled with the response object (see interface for details) or rejected + with an Imperative Error.
    • +
    +
  • +
+
+
+ +

Abstract loadAll

+ + +
+
+ +

Protected Abstract loadDependencies

+ +
    +
  • + +
    +
    +

    Load a profiles dependencies - dictacted by the implementation.

    +
    +
    +
    abstract
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      the name of the profile to load dependencies for

      +
      +
    • +
    • +
      profile: IProfile
      +
      +

      The profile to load dependencies for.

      +
      +
    • +
    • +
      failNotFound: boolean
      +
      +

      True to fail "not found" errors

      +
      +
    • +
    +

    Returns Promise<IProfileLoaded[]>

    +
      +
    • The promise fulfilled with response or rejected with an ImperativeError.
    • +
    +
  • +
+
+
+ +

Protected loadFailed

+
    +
  • loadFailed(name: string): void
  • +
+ +
+
+ +

Protected Abstract loadProfile

+ + +
+
+ +

Protected loadSpecificProfile

+
    +
  • loadSpecificProfile(name: string, failNotFound?: boolean, loadDependencies?: boolean): Promise<IProfileLoaded>
  • +
+
    +
  • + +
    +
    +

    Loads a specific profile (by name).

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      The name of the profile to load.

      +
      +
    • +
    • +
      Default value failNotFound: boolean = true
      +
    • +
    • +
      Default value loadDependencies: boolean = true
      +
    • +
    +

    Returns Promise<IProfileLoaded>

    +
      +
    • The promise to fulfill with the response OR reject with an ImperativeError
    • +
    +
  • +
+
+
+ +

Protected locateExistingProfile

+
    +
  • locateExistingProfile(name: string): string
  • +
+ +
+
+ +

mergeProfiles

+ + +
+
+ +

Private protectAgainstOverwrite

+
    +
  • protectAgainstOverwrite(name: string, overwrite: boolean): void
  • +
+
    +
  • + +
    +
    +

    Protects a against an overwrite on a profile save (if requested).

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      The name of the profile to check for existance.

      +
      +
    • +
    • +
      overwrite: boolean
      +
      +

      False to protect against overwrite.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Private readMeta

+
    +
  • readMeta(path: string, type?: string): IMetaProfile<T>
  • +
+ +
+
+ +

save

+ +
    +
  • + +
    +
    +

    Save a profile to disk. Ensures that the profile specified is valid (basic and schema validation) and invokes the implementations + "saveProfile" method to perform the save and formulate the response.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      parms: S
      +
      +

      See interface for details

      +
      +
    • +
    +

    Returns Promise<IProfileSaved>

    +
      +
    • The promise that is fulfilled with the response object (see interface for details) or rejected + with an Imperative Error.
    • +
    +
  • +
+
+
+ +

Protected Abstract saveProfile

+ + +
+
+ +

setDefault

+
    +
  • setDefault(name: string): string
  • +
+
    +
  • + +
    +
    +

    Sets the default profile for the profile managers type.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      The name of the new default

      +
      +
    • +
    +

    Returns string

    +
      +
    • The response string (or an error is thrown if the request cannot be completed);
    • +
    +
  • +
+
+
+ +

Private setDefaultInMetaObject

+
    +
  • setDefaultInMetaObject(meta: IMetaProfile<T>, defaultProfileName: string): void
  • +
+ +
+
+ +

update

+ + +
+
+ +

Protected Abstract updateProfile

+ + +
+
+ +

validate

+ +
    +
  • + +
    +
    +

    Validate a profile. Includes basic and schema validation. Can be called explicitly, but is also called during + loads and saves to protect the integrity of the profiles against the type definitions.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      parms: V
      +
      +

      See the interface for details

      +
      +
    • +
    +

    Returns Promise<IProfileValidated>

    +
      +
    • The promise that is fulfilled with the response object (see interface for details) or rejected + with an Imperative Error.
    • +
    +
  • +
+
+
+ +

Private validateConfigurationDocument

+
    +
  • validateConfigurationDocument(typeConfiguration: T): void
  • +
+ +
+
+ +

Private validateMetaProfile

+
    +
  • validateMetaProfile(meta: IMetaProfile<T>, type?: string): void
  • +
+ +
+
+ +

Protected Abstract validateProfile

+ + +
+
+ +

Protected validateProfileAgainstSchema

+
    +
  • validateProfileAgainstSchema(name: string, profile: IProfile, strict?: boolean): void
  • +
+
    +
  • + +
    +
    +

    Validates the profile against the schema for its type and reports and errors located.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      the name of the profile to validate

      +
      +
    • +
    • +
      profile: IProfile
      +
      +

      The profile to validate.

      +
      +
    • +
    • +
      Default value strict: boolean = false
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Protected validateProfileObject

+
    +
  • validateProfileObject(name: string, type: string, profile: IProfile): void
  • +
+
    +
  • + +
    +
    +

    Performs basic validation of a profile object - ensures that all fields are present (if required).

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      the name of the profile to validate

      +
      +
    • +
    • +
      type: string
      +
      +

      the type of profile to validate

      +
      +
    • +
    • +
      profile: IProfile
      +
      +

      The profile to validate.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Private validateRequiredDependenciesAreSpecified

+
    +
  • validateRequiredDependenciesAreSpecified(profile: IProfile): void
  • +
+
    +
  • + +
    +
    +

    Validates a profiles contents against the required dependencies specified on the profile configuration type document. If the document + indicates that a dependency is required and that dependency is missing from the input profile, an error is thrown.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      profile: IProfile
      +
      +

      The profile to validate dependency specs

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Private validateSchema

+ +
    +
  • + +
    +
    +

    Validate that the schema document passed is well formed for the profile manager usage. Ensures that the + schema is not overloading reserved properties.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      schema: IProfileSchema
      +
      +

      The schema document to validate.

      +
      +
    • +
    • +
      Default value type: string = this.profileType
      +
      +

      the type of profile for the schema - defaults to the current type for this manager

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractprofilemanagerfactory.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractprofilemanagerfactory.html new file mode 100644 index 0000000000..63b5943918 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractprofilemanagerfactory.html @@ -0,0 +1,306 @@ + + + + + + AbstractProfileManagerFactory | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AbstractProfileManagerFactory<T>

+
+
+
+
+
+
+
+
+
+

Abstract profile manager (implemented by imperative, etc.)

+
+
+
export
+
+
abstract
+
+
implements
+

{IProfileManagerFactory}

+
+
+
+
+
+

Type parameters

+ +
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Abstract getManager

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractrestclient.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractrestclient.html new file mode 100644 index 0000000000..0da328673e --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractrestclient.html @@ -0,0 +1,1505 @@ + + + + + + AbstractRestClient | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AbstractRestClient

+
+
+
+
+
+
+
+
+
+

Class to handle http(s) requests, build headers, collect data, report status codes, and header responses + and passes control to session object for maintaining connection information (tokens, checking for timeout, etc...)

+
+
+
export
+
+
abstract
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private lastByteReceived

+
lastByteReceived: number = 0
+ +
+
+

Last byte received when response is being streamed

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mBytesReceived

+
mBytesReceived: number = 0
+ +
+
+

Bytes received from the server response so far

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mChunks

+
mChunks: Buffer[] = []
+ +
+
+

Contains REST chucks

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mContentEncoding

+
mContentEncoding: ContentEncoding
+ +
+
+

If we get a response containing a Content-Encoding header, + and it matches an encoding type that we recognize, + it is saved here

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mContentLength

+
mContentLength: number
+ +
+
+

If we get a response containing a Content-Length header, + it is saved here

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mData

+
mData: Buffer = Buffer.from([])
+ +
+
+

Contains buffered data after all REST chucks are received

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mDecode

+
mDecode: boolean = true
+ +
+
+

Whether or not to try and decode any encoded response

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mIsJson

+
mIsJson: boolean
+ +
+
+

Indicates if payload data is JSON to be stringified before writing

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mLogger

+
mLogger: Logger
+ +
+
+

Instance of logger

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mNormalizeRequestNewlines

+
mNormalizeRequestNewlines: boolean
+ +
+
+

Indicates if request data should have its newlines normalized to /n before sending + each chunk to the server

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mNormalizeResponseNewlines

+
mNormalizeResponseNewlines: boolean
+ +
+
+

Indicates if response data should have its newlines normalized for the current platform + (\r\n for windows, otherwise \n)

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mReject

+ + +
+
+

Reject for errors when obtaining data

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mReqHeaders

+
mReqHeaders: any[]
+ +
+
+

Save req headers

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mRequest

+
mRequest: HTTP_VERB
+ +
+
+

Save request

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mRequestStream

+
mRequestStream: Readable
+ +
+
+

stream for outgoing request data to the server

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mResolve

+ + +
+
+

Resolved when all data has been obtained

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mResource

+
mResource: string
+ +
+
+

Save resource

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mResponse

+
mResponse: any
+ +
+
+

Contain response from http(s) request

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mResponseStream

+
mResponseStream: Writable
+ +
+
+

Stream for incoming response data from the server. + If specified, response data will not be buffered

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mSession

+
mSession: AbstractSession
+ +
+
+

representing connection to this api

+
+
+
+
+ +

Private mTask

+ + +
+
+

Task used to display progress bars or other user feedback mechanisms + Automatically updated if task is specified and streams are provided for upload/download

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mWriteData

+
mWriteData: any
+ +
+
+

Save write data

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+
+

Accessors

+
+ +

data

+
    +
  • get data(): Buffer
  • +
+ +
+
+ +

dataString

+
    +
  • get dataString(): string
  • +
+ +
+
+ +

log

+ + +
+
+ +

requestFailure

+
    +
  • get requestFailure(): boolean
  • +
+ +
+
+ +

requestSuccess

+
    +
  • get requestSuccess(): boolean
  • +
+ +
+
+ +

response

+
    +
  • get response(): any
  • +
+ +
+
+ +

session

+ + +
+
+
+

Methods

+
+ +

Protected appendHeaders

+
    +
  • appendHeaders(headers: any[] | undefined): any[]
  • +
+
    +
  • + +
    +
    +

    Append specific headers for all requests by overriding this implementation

    +
    +
    +
    memberof
    +

    AbstractRestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      headers: any[] | undefined
      +
      +

      list of headers

      +
      +
    • +
    +

    Returns any[]

    +
      +
    • completed list of headers
    • +
    +
  • +
+
+
+ +

Private appendInputHeaders

+ + +
+
+ +

Private buildOptions

+
    +
  • buildOptions(resource: string, request: string, reqHeaders?: any[]): IHTTPSOptions
  • +
+
    +
  • + +
    +
    +

    Build http(s) options based upon session settings and request.

    +
    +
    +
    memberof
    +

    AbstractRestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      resource: string
      +
      +

      URI for this request

      +
      +
    • +
    • +
      request: string
      +
      +

      REST request type GET|PUT|POST|DELETE

      +
      +
    • +
    • +
      Optional reqHeaders: any[]
      +
      +

      option headers to include with request

      +
      +
    • +
    +

    Returns IHTTPSOptions

    +
      +
    • completed options object
    • +
    +
  • +
+
+
+ +

Private onData

+
    +
  • onData(respData: Buffer): void
  • +
+
    +
  • + +
    +
    +

    Method to accumulate and buffer http request response data until our + onEnd method is invoked, at which point all response data has been accounted for. + NOTE(Kelosky): this method may be invoked multiple times.

    +
    +
    +
    memberof
    +

    AbstractRestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      respData: Buffer
      +
      +

      any datatype and content

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Private onEnd

+
    +
  • onEnd(): void
  • +
+
    +
  • + +
    +
    +

    Method that must be implemented to extend the IRestClient class. This is the client specific implementation + for what action to perform after all response data has been collected.

    +
    +
    +
    memberof
    +

    AbstractRestClient

    +
    +
    +
    +

    Returns void

    +
  • +
+
+
+ +

Private populateError

+ +
    +
  • + +
    +
    +

    Construct a throwable rest client error with all "relevant" diagnostic information. + The caller should have the session, so not all input fields are present on the error + response. Only the set required to understand "what may have gone wrong".

    +
    +

    The "exit" point for the implementation error override will also be called here. The + implementation can choose to transform the IImperativeError details however they see + fit.

    +
    +

    Parameters

    +
      +
    • +
      error: IRestClientError
      +
      +

      The base request error. It is expected to already have msg, + causeErrors, and the error source pre-populated.

      +
      +
    • +
    • +
      Optional nodeClientError: any
      +
    • +
    +

    Returns RestClientError

    +
      +
    • The error that can be thrown or rejected.
    • +
    +
  • +
+
+
+ +

Protected processError

+ +
    +
  • + +
    +
    +

    Process and customize errors encountered in your client. + This is called any time an error is thrown from a failed Rest request using this client. + error before receiving any response body from the API. + You can use this, for example, to set the error tag for you client or add additional + details to the error message. + If you return null or undefined, Imperative will use the default error generated + for your failed request.

    +
    +
    +
    memberof
    +

    AbstractRestClient

    +
    +
    +
    +

    Parameters

    + +

    Returns IImperativeError

    +

    processedError - the error with the fields set the way you want them

    +
  • +
+
+
+ +

request

+ +
    +
  • + +
    +
    +

    Perform the actual http REST call with appropriate user input

    +
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    AbstractRestClient

    +
    +
    +
    +

    Parameters

    + +

    Returns Promise<string>

    +
  • +
+
+
+ +

Private requestHandler

+
    +
  • requestHandler(res: any): void
  • +
+ +
+
+ +

Private setTransferFlags

+
    +
  • setTransferFlags(headers: OutgoingHttpHeaders): void
  • +
+
    +
  • + +
    +
    +

    Determine whether we should stringify or leave writable data alone

    +
    +
    +
    memberof
    +

    AbstractRestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      headers: OutgoingHttpHeaders
      +
      +

      options containing populated headers

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractsession.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractsession.html new file mode 100644 index 0000000000..6428ac5fe4 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.abstractsession.html @@ -0,0 +1,908 @@ + + + + + + AbstractSession | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AbstractSession

+
+
+
+
+
+
+
+
+
+

The API session object, serves as the base for sessions and contains the fields that are required by + most API calls (hostname, port, credentials, etc).

+
+
+
export
+
+
abstract
+
+
+
+
+
+

Hierarchy

+
    +
  • + AbstractSession + +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mISession

+
mISession: ISession
+ +
+
+ +

Private mLog

+
mLog: Logger
+ +
+
+

Logging object

+
+
+
+
+ +

Static Readonly BASIC

+
BASIC: RegExp = /^Basic/ig
+ +
+
+

Regex to extract basic from base64 encoded auth

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly BASIC_PREFIX

+
BASIC_PREFIX: string = "Basic "
+ +
+
+

Basic auth prefix

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly BEARER_PREFIX

+
BEARER_PREFIX: string = "Bearer "
+ +
+
+

Bearer auth prefix

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_BASE_PATH

+
DEFAULT_BASE_PATH: "" = ""
+ +
+
+

Default base path. + Our empty string means that we do not use an API mediation layer + base path at the beginning of every resource URL.

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_HTTPS_PORT

+
DEFAULT_HTTPS_PORT: 443 = 443
+ +
+
+

Default https port 443

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_HTTP_PORT

+
DEFAULT_HTTP_PORT: 80 = 80
+ +
+
+

Default http port 80

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_PORT

+
DEFAULT_PORT: 443 = AbstractSession.DEFAULT_HTTPS_PORT
+ +
+
+

Default https port

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_PROTOCOL

+
DEFAULT_PROTOCOL: "https" = SessConstants.HTTPS_PROTOCOL
+ +
+
+

Default protocol

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_REJECT_UNAUTHORIZED_SETTING

+
DEFAULT_REJECT_UNAUTHORIZED_SETTING: true = true
+ +
+
+

Default reject unauthorized

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_SECURE_PROTOCOL

+
DEFAULT_SECURE_PROTOCOL: "SSLv23_method" = "SSLv23_method"
+ +
+
+

Default SSL method

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_STRICT_SSL

+
DEFAULT_STRICT_SSL: true = true
+ +
+
+

Default strict ssl setting

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_TYPE

+
DEFAULT_TYPE: "none" = SessConstants.AUTH_TYPE_NONE
+ +
+
+

Default session type

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+
+

Accessors

+
+ +

ISession

+ + +
+
+
+

Methods

+
+ +

Private buildSession

+ + +
+
+ +

storeCookie

+
    +
  • storeCookie(cookie: any): void
  • +
+ +
+
+ +

Static getBase64Auth

+
    +
  • getBase64Auth(user: string, password: string): string
  • +
+
    +
  • + +
    +
    +

    Create base 64 encoded representation of user and password

    +
    +
    +
    static
    +
    +
    memberof
    +

    AbstractSession

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      user: string
      +
      +

      plain text user

      +
      +
    • +
    • +
      password: string
      +
      +

      plain text password

      +
      +
    • +
    +

    Returns string

    +
      +
    • base 64 encoded auth
    • +
    +
  • +
+
+
+ +

Static getPasswordFromAuth

+
    +
  • getPasswordFromAuth(auth: string): string
  • +
+ +
+
+ +

Static getUsernameFromAuth

+
    +
  • getUsernameFromAuth(auth: string): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.appsettings.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.appsettings.html new file mode 100644 index 0000000000..d03f98151f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.appsettings.html @@ -0,0 +1,624 @@ + + + + + + AppSettings | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AppSettings

+
+
+
+
+
+
+
+
+
+

This class represents settings for an Imperative CLI application that can be configured + by an end user by modifying a settings file. Settings are stored in {@link AppSettings#settings} + in a format specified by ISettingsFile.

+
+
+
+
+

Hierarchy

+
    +
  • + AppSettings +
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private Readonly persistence

+ + +
+
+ +

Private Readonly settings

+
settings: ISettingsFile
+ +
+
+

The settings loaded from the file specified in the constructor.

+
+
+
+
+ +

Static Private mInstance

+
mInstance: AppSettings
+ +
+
+

This is an internal reference to the static settings instance.

+
+
+
+
+
+

Accessors

+
+ +

Static initialized

+
    +
  • get initialized(): boolean
  • +
+ +
+
+ +

Static instance

+ + +
+
+
+

Methods

+
+ +

Private flush

+
    +
  • flush(): void
  • +
+ +
+
+ +

get

+
    +
  • get(namespace: keyof ISettingsFile, key: string): SettingValue
  • +
+ +
+
+ +

getNamespace

+ + +
+
+ +

getSettings

+ + +
+
+ +

set

+
    +
  • set(namespace: keyof ISettingsFile, key: string, value: SettingValue): void
  • +
+ +
+
+ +

Static initialize

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.authcommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.authcommandbuilder.html new file mode 100644 index 0000000000..212f2ac6ac --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.authcommandbuilder.html @@ -0,0 +1,496 @@ + + + + + + AuthCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AuthCommandBuilder

+
+
+
+
+
+
+
+
+
+

Abstract class for generating auth-related commands

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mAuthConfig

+ + +
+
+

the config for the auth type

+
+
+
+
+ +

Protected mConfig

+ + +
+
+

Auth config for the command.

+
+
+
+
+ +

Protected mLogger

+
mLogger: Logger
+ +
+
+

logger instance to use for the builder class

+
+
+
+
+ +

Protected mProfileType

+
mProfileType: string
+ +
+
+

the profile name of the profile type e.g. banana

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

Protected Abstract buildAuthSegmentFromConfig

+ + +
+
+ +

Abstract buildFull

+ + +
+
+ +

Abstract getAction

+
    +
  • getAction(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Protected property
  • +
  • Protected method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.authlogincommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.authlogincommandbuilder.html new file mode 100644 index 0000000000..3516a423bd --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.authlogincommandbuilder.html @@ -0,0 +1,505 @@ + + + + + + AuthLoginCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AuthLoginCommandBuilder

+
+
+
+
+
+
+
+
+
+

Used to build auth login command definitions. + Used automatically if you allow the "auth" command group to be generated

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mAuthConfig

+ + +
+
+

the config for the auth type

+
+
+
+
+ +

Protected mConfig

+ + +
+
+

Auth config for the command.

+
+
+
+
+ +

Protected mLogger

+
mLogger: Logger
+ +
+
+

logger instance to use for the builder class

+
+
+
+
+ +

Protected mProfileType

+
mProfileType: string
+ +
+
+

the profile name of the profile type e.g. banana

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

Protected buildAuthSegmentFromConfig

+ + +
+
+ +

buildFull

+ + +
+
+ +

getAction

+
    +
  • getAction(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Inherited constructor
  • +
  • Inherited method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.authlogoutcommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.authlogoutcommandbuilder.html new file mode 100644 index 0000000000..5ad04f7b57 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.authlogoutcommandbuilder.html @@ -0,0 +1,505 @@ + + + + + + AuthLogoutCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AuthLogoutCommandBuilder

+
+
+
+
+
+
+
+
+
+

Used to build auth logout command definitions. + Used automatically if you allow the "auth" command group to be generated

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mAuthConfig

+ + +
+
+

the config for the auth type

+
+
+
+
+ +

Protected mConfig

+ + +
+
+

Auth config for the command.

+
+
+
+
+ +

Protected mLogger

+
mLogger: Logger
+ +
+
+

logger instance to use for the builder class

+
+
+
+
+ +

Protected mProfileType

+
mProfileType: string
+ +
+
+

the profile name of the profile type e.g. banana

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

Protected buildAuthSegmentFromConfig

+ + +
+
+ +

buildFull

+ + +
+
+ +

getAction

+
    +
  • getAction(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Inherited constructor
  • +
  • Inherited method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.autoinitcommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.autoinitcommandbuilder.html new file mode 100644 index 0000000000..1422b683b2 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.autoinitcommandbuilder.html @@ -0,0 +1,477 @@ + + + + + + AutoInitCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AutoInitCommandBuilder

+
+
+
+
+
+
+
+
+
+

Class for generating auth-related commands

+
+
+
+
+

Hierarchy

+
    +
  • + AutoInitCommandBuilder +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mAutoInitConfig

+ + +
+
+ +

Protected mConfig

+ + +
+
+

Auth config for the command.

+
+
+
+
+ +

Protected mLogger

+
mLogger: Logger
+ +
+
+

logger instance to use for the builder class

+
+
+
+
+ +

Protected Optional mProfileType

+
mProfileType: string
+ +
+
+

the profile name of the profile type e.g. banana

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

Protected buildAutoInitSegmentFromConfig

+ + +
+
+ +

buildFull

+ + +
+
+ +

getAction

+
    +
  • getAction(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Protected property
  • +
  • Protected method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.autoinitconstants.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.autoinitconstants.html new file mode 100644 index 0000000000..7cdac51bed --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.autoinitconstants.html @@ -0,0 +1,726 @@ + + + + + + AutoInitConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class AutoInitConstants

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + AutoInitConstants +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static AUTO_INIT_OPTION_GROUP

+
AUTO_INIT_OPTION_GROUP: string = "Automatic Config Initialization Options"
+ +
+
+
+

Object literals

+
+ +

Static AUTO_INIT_OPTION_DRY_RUN

+
AUTO_INIT_OPTION_DRY_RUN: object
+ +
+
+

Option used to specify whether or not to do a dry run of the initialization

+
+
+
+ +

aliases

+
aliases: string[] = ["dr", "dry"]
+ +
+
+ +

conflictsWith

+
conflictsWith: string[] = ["edit"]
+ +
+
+ +

description

+
description: string = "Display the outcome of the initialization without saving"
+ +
+
+ +

group

+
group: string = AutoInitConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "dry-run"
+ +
+
+ +

type

+
type: "boolean" = "boolean"
+ +
+
+
+ +

Static AUTO_INIT_OPTION_EDIT

+
AUTO_INIT_OPTION_EDIT: object
+ +
+
+

Option used to specify whether or not to open an editor for the config

+
+
+
+ +

aliases

+
aliases: string[] = ["e"]
+ +
+
+ +

conflictsWith

+
conflictsWith: string[] = ["dry-run"]
+ +
+
+ +

description

+
description: string = "Open in editor after initializing the configuration"
+ +
+
+ +

group

+
group: string = AutoInitConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "edit"
+ +
+
+ +

type

+
type: "boolean" = "boolean"
+ +
+
+
+ +

Static AUTO_INIT_OPTION_FOR_SURE

+
AUTO_INIT_OPTION_FOR_SURE: object
+ +
+
+

Option used to confirm an overwrite

+
+
+
+ +

aliases

+
aliases: string[] = ["f"]
+ +
+
+ +

defaultValue

+
defaultValue: boolean = false
+ +
+
+ +

description

+
description: string = "Confirms the overwrite option"
+ +
+
+ +

group

+
group: string = AutoInitConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "for-sure"
+ +
+
+ +

type

+
type: "boolean" = "boolean"
+ +
+
+
+ +

Static AUTO_INIT_OPTION_GLOBAL_CONFIG

+
AUTO_INIT_OPTION_GLOBAL_CONFIG: object
+ +
+
+

Option used to specify whether or not to use the global layer of the config

+
+
+
+ +

aliases

+
aliases: string[] = ["gc"]
+ +
+
+ +

defaultValue

+
defaultValue: boolean = false
+ +
+
+ +

description

+
description: string = "Save config in the global layer"
+ +
+
+ +

group

+
group: string = AutoInitConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "global-config"
+ +
+
+ +

type

+
type: "boolean" = "boolean"
+ +
+
+
+ +

Static AUTO_INIT_OPTION_OVERWRITE

+
AUTO_INIT_OPTION_OVERWRITE: object
+ +
+
+

Option used to specify whether or not to overwrite the config

+
+
+
+ +

aliases

+
aliases: string[] = ["ow"]
+ +
+
+ +

defaultValue

+
defaultValue: boolean = false
+ +
+
+ +

description

+
description: string = "Replaces an existing configuration with a new configuration"
+ +
+
+ +

group

+
group: string = AutoInitConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+ +

implies

+
implies: string[] = ["for-sure"]
+ +
+
+ +

name

+
name: string = "overwrite"
+ +
+
+ +

type

+
type: "boolean" = "boolean"
+ +
+
+
+ +

Static AUTO_INIT_OPTION_USER_CONFIG

+
AUTO_INIT_OPTION_USER_CONFIG: object
+ +
+
+

Option used to specify whether or not to use the user layer of the config

+
+
+
+ +

aliases

+
aliases: string[] = ["uc"]
+ +
+
+ +

defaultValue

+
defaultValue: boolean = false
+ +
+
+ +

description

+
description: string = "Save config in the user layer"
+ +
+
+ +

group

+
group: string = AutoInitConstants.AUTO_INIT_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "user-config"
+ +
+
+ +

type

+
type: "boolean" = "boolean"
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.badcredentialmanagererror.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.badcredentialmanagererror.html new file mode 100644 index 0000000000..6af56cbf02 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.badcredentialmanagererror.html @@ -0,0 +1,559 @@ + + + + + + BadCredentialManagerError | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class BadCredentialManagerError

+
+
+
+
+
+
+
+
+
+

This class represents the error thrown by methods of the InvalidCredentialManager + when initialized by CredentialManagerFactory.initialize

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

mDetails

+ + +
+
+ +

name

+
name: string
+ +
+
+
+

Accessors

+
+ +

additionalDetails

+
    +
  • get additionalDetails(): string
  • +
+ +
+
+ +

causeErrors

+
    +
  • get causeErrors(): any
  • +
+ +
+
+ +

details

+ + +
+
+ +

errorCode

+
    +
  • get errorCode(): string
  • +
+ +
+
+ +

message

+
    +
  • get message(): string
  • +
+ +
+
+ +

stack

+
    +
  • get stack(): string
  • +
+ +
+
+ +

suppressDump

+
    +
  • get suppressDump(): boolean
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.baseauthhandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.baseauthhandler.html new file mode 100644 index 0000000000..dd120bce96 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.baseauthhandler.html @@ -0,0 +1,781 @@ + + + + + + BaseAuthHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class BaseAuthHandler

+
+
+
+
+
+
+
+
+
+

This class is used by the auth command handlers as the base class for their implementation.

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Protected Abstract mDefaultTokenType

+
mDefaultTokenType: SessConstants.TOKEN_TYPE_CHOICES
+ +
+
+

The default token type to use if not specified as a command line option

+
+
+
+
+ +

Protected Abstract mProfileType

+
mProfileType: string
+ +
+
+

The profile type where token type and value should be stored

+
+
+
+
+ +

Protected Optional mServiceDescription

+
mServiceDescription: string
+ +
+
+

The description of your service to be used in CLI prompt messages

+
+
+
+
+ +

Protected mSession

+
mSession: AbstractSession
+ +
+
+

The session being created from the command line arguments / profile

+
+
+
+
+
+

Methods

+
+ +

Protected Abstract createSessCfgFromArgs

+ + +
+
+ +

Protected Abstract doLogin

+ + +
+
+ +

Protected Abstract doLogout

+ + +
+
+ +

getAuthHandlerApi

+ + +
+
+ +

Private getBaseProfileName

+ + +
+
+ +

getPromptParams

+ + +
+
+ +

process

+ + +
+
+ +

Protected processLogin

+ + +
+
+ +

Private processLoginOld

+ + +
+
+ +

Protected processLogout

+ + +
+
+ +

Private processLogoutOld

+ + +
+
+ +

Private promptForBaseProfile

+ + +
+
+ +

Private showToken

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Protected property
  • +
  • Protected method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited method
  • +
+
    +
  • Private method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.baseautoinithandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.baseautoinithandler.html new file mode 100644 index 0000000000..420c122eb7 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.baseautoinithandler.html @@ -0,0 +1,498 @@ + + + + + + BaseAutoInitHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class BaseAutoInitHandler

+
+
+
+
+
+
+
+
+
+

This class is used by the auto init command handler as the base class for its implementation.

+
+
+
+
+

Hierarchy

+
    +
  • + BaseAutoInitHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Protected Abstract mProfileType

+
mProfileType: string
+ +
+
+

The profile type where connection information should be stored

+
+
+
+
+ +

Protected Abstract mServiceDescription

+
mServiceDescription: string
+ +
+
+

The description of your service to be used in CLI prompt messages

+
+
+
+
+ +

Protected mSession

+
mSession: AbstractSession
+ +
+
+

The session being created from the command line arguments / profile

+
+
+
+
+
+

Methods

+
+ +

Protected Abstract createSessCfgFromArgs

+ + +
+
+ +

Protected Abstract displayAutoInitChanges

+ + +
+
+ +

Protected Abstract doAutoInit

+ + +
+
+ +

process

+ + +
+
+ +

Private processAutoInit

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Protected property
  • +
  • Protected method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.basicprofilemanager.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.basicprofilemanager.html new file mode 100644 index 0000000000..0f6a33fcc8 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.basicprofilemanager.html @@ -0,0 +1,2030 @@ + + + + + + BasicProfileManager | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class BasicProfileManager<T>

+
+
+
+
+
+
+
+
+
+

Basic Profile Manager is the most basic implementation of the Imperative Profile Manager. In general, it invokes + all of the utility/services from the Abstract Profile manager to load, save, delete, validate, etc. Imperative + profiles. See the "AbstractProfileManager" header for more profile management details.

+
+

The main differences between the abstract and the basic include:

+
    +
  1. The "loadAll()" API in the basic profile manager loads ALL profiles from all types.
  2. +
  3. The Basic Profile Manager includes the "initialize()" API, which will create all type directories and persist + the schema in the meta files.
  4. +
+

The Basic Profile Manager can be used "stand-alone" from an Imperative CLI. The intent is to provide apps built + using Imperative CLI's to take advantage of the profiles that the user has defined, without having to "locate" the + configuration documents used to construct the CLI's. This is why the initialize() API persists the configuration + documents within the meta files for each type.

+
+
export
+
+
+
+
+
+

Type parameters

+ +
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Static Readonly META_FILE_SUFFIX

+
META_FILE_SUFFIX: string = "_meta"
+ +
+
+

The meta file suffix - always appended to the meta file to distinguish from other profiles. Users then cannot + supply a profile name that would conflict with the meta file.

+
+
+
static
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Static Readonly PROFILE_EXTENSION

+
PROFILE_EXTENSION: string = ".yaml"
+ +
+
+

The default profile file extension (YAML format) - all profiles are stored in YAML format including + the meta profile file.

+
+
+
static
+
+
memberof
+

ProfileManager

+
+
+
+
+
+
+

Accessors

+
+ +

configurations

+ + +
+
+ +

Protected loadCounter

+
    +
  • get loadCounter(): Map<string, number>
  • +
+ +
+
+ +

Protected log

+ + +
+
+ +

Protected managerParameters

+ + +
+
+ +

Protected productDisplayName

+
    +
  • get productDisplayName(): string
  • +
+ +
+
+ +

Protected profileRootDirectory

+
    +
  • get profileRootDirectory(): string
  • +
+ +
+
+ +

Protected profileType

+
    +
  • get profileType(): string
  • +
+ +
+
+ +

Protected profileTypeConfiguration

+
    +
  • get profileTypeConfiguration(): T
  • +
+ +
+
+ +

Protected profileTypeConfigurations

+
    +
  • get profileTypeConfigurations(): T[]
  • +
+ +
+
+ +

Protected profileTypeMetaFileName

+
    +
  • get profileTypeMetaFileName(): string
  • +
+ +
+
+ +

Protected profileTypeRootDirectory

+
    +
  • get profileTypeRootDirectory(): string
  • +
+ +
+
+ +

Protected profileTypeSchema

+ + +
+
+
+

Methods

+
+ +

clearDefault

+
    +
  • clearDefault(): string
  • +
+ +
+
+ +

Protected constructFullProfilePath

+
    +
  • constructFullProfilePath(name: string, type?: string): string
  • +
+ +
+
+ +

delete

+ +
    +
  • + +
    +
    +

    Deletes a profile from disk. Ensures that the parameters are correct and removes the profile. If the profile is listed as a dependency of + other profiles it will NOT delete the profile unless "rejectIfDependency" is set to false.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      parms: D
      +
      +

      See the interface for details

      +
      +
    • +
    +

    Returns Promise<IProfileDeleted>

    +
      +
    • The promise that is fulfilled with the response object (see interface for details) or rejected + with an Imperative Error.
    • +
    +
  • +
+
+
+ +

Protected deleteProfile

+ + +
+
+ +

Protected deleteProfileFromDisk

+
    +
  • deleteProfileFromDisk(name: string): string
  • +
+ +
+
+ +

getAllProfileNames

+
    +
  • getAllProfileNames(): string[]
  • +
+ +
+
+ +

getDefaultProfileName

+
    +
  • getDefaultProfileName(): string
  • +
+ +
+
+ +

Protected isProfileEmpty

+
    +
  • isProfileEmpty(profile: IProfile): boolean
  • +
+
    +
  • + +
    +
    +

    Checks if the profile object passed is "empty" - meaning it has no contents other than that type or name. + A profile can only specify "dependencies", in the event that it is just acting as a "pointer" to another profile.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      profile: IProfile
      +
      +

      The profile to check for "emptiness".

      +
      +
    • +
    +

    Returns boolean

    +

    True if the profile object is empty.

    +
  • +
+
+
+ +

load

+ +
    +
  • + +
    +
    +

    Load a profile from disk. Ensures that the parameters are valid and loads the profile specified by name OR the default profile if + requested. If load default is requested, any name supplied is ignored.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      parms: L
      +
      +

      See the interface for details.

      +
      +
    • +
    +

    Returns Promise<IProfileLoaded>

    +
      +
    • The promise that is fulfilled with the response object (see interface for details) or rejected + with an Imperative Error.
    • +
    +
  • +
+
+
+ +

loadAll

+ + +
+
+ +

Protected loadDependencies

+ + +
+
+ +

Protected loadFailed

+
    +
  • loadFailed(name: string): void
  • +
+ +
+
+ +

Protected loadProfile

+ + +
+
+ +

Protected loadSpecificProfile

+
    +
  • loadSpecificProfile(name: string, failNotFound?: boolean, loadDependencies?: boolean): Promise<IProfileLoaded>
  • +
+ +
+
+ +

Protected locateExistingProfile

+
    +
  • locateExistingProfile(name: string): string
  • +
+ +
+
+ +

mergeProfiles

+ + +
+
+ +

save

+ +
    +
  • + +
    +
    +

    Save a profile to disk. Ensures that the profile specified is valid (basic and schema validation) and invokes the implementations + "saveProfile" method to perform the save and formulate the response.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      parms: S
      +
      +

      See interface for details

      +
      +
    • +
    +

    Returns Promise<IProfileSaved>

    +
      +
    • The promise that is fulfilled with the response object (see interface for details) or rejected + with an Imperative Error.
    • +
    +
  • +
+
+
+ +

Protected saveProfile

+ + +
+
+ +

setDefault

+
    +
  • setDefault(name: string): string
  • +
+ +
+
+ +

update

+ + +
+
+ +

Protected updateProfile

+ + +
+
+ +

validate

+ + +
+
+ +

Protected validateProfile

+ + +
+
+ +

Protected validateProfileAgainstSchema

+
    +
  • validateProfileAgainstSchema(name: string, profile: IProfile, strict?: boolean): void
  • +
+ +
+
+ +

Protected validateProfileObject

+
    +
  • validateProfileObject(name: string, type: string, profile: IProfile): void
  • +
+ +
+
+ +

Private validateRequiredDependenciesAreSpecified

+
    +
  • validateRequiredDependenciesAreSpecified(profile: IProfile): void
  • +
+ +
+
+ +

Static initialize

+ +
    +
  • + +
    +
    +

    Static method to initialize the profile environment. Accepts the profile root directory (normally supplied by + your Imperative configuration documents) and all profile "type" configuration documents and constructs the directories + needed to manage profiles of all types. You must execute this method before beginning to use profiles OR you must + supply all the type configuration documents (normally obtained from your Imperative configuration document) to + the constructor of

    +
    +
    +
    static
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    + +

    Returns Promise<IProfileInitialized[]>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Inherited constructor
  • +
  • Inherited method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.basicprofilemanagerfactory.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.basicprofilemanagerfactory.html new file mode 100644 index 0000000000..5b18cb6ba3 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.basicprofilemanagerfactory.html @@ -0,0 +1,472 @@ + + + + + + BasicProfileManagerFactory | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class BasicProfileManagerFactory

+
+
+
+
+
+
+
+
+
+

A basic profile mananger factory - returns instances of profile managers depending on the types passed.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mProfilesRootDirectory

+
mProfilesRootDirectory: string
+ +
+
+

The root directory where the profiles will be found.

+
+
+
memberof
+

BasicProfileManagerFactory

+
+
+
+
+
+ +

Private mTypeConfigurations

+
mTypeConfigurations: IProfileTypeConfiguration[]
+ +
+
+

Type configurations for the basic profile manager

+
+
+
memberof
+

BasicProfileManagerFactory

+
+
+
+
+
+
+

Accessors

+
+ +

Private profilesRootDirectory

+
    +
  • get profilesRootDirectory(): string
  • +
+ +
+
+ +

Private typeConfigurations

+ + +
+
+
+

Methods

+
+ +

getManager

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.chainedhandlerservice.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.chainedhandlerservice.html new file mode 100644 index 0000000000..10eaea9716 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.chainedhandlerservice.html @@ -0,0 +1,294 @@ + + + + + + ChainedHandlerService | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ChainedHandlerService

+
+
+
+
+
+
+
+
+
+

Service for processing chained handlers and their + argument mappings.

+
+
+
+
+

Hierarchy

+
    +
  • + ChainedHandlerService +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static getArguments

+
    +
  • getArguments(binName: string, chainedHandlerConfigs: IChainedHandlerEntry[], handlerIndex: number, previousResponseObjects: any[], overallArguments: yargs.Arguments, logger: Logger): yargs.Arguments
  • +
+
    +
  • + +
    +
    +

    Get the arguments for the current handler in the chain

    +
    +
    +

    Parameters

    +
      +
    • +
      binName: string
      +
      +

      name of the binary/primary command for this CLI

      +
      +
    • +
    • +
      chainedHandlerConfigs: IChainedHandlerEntry[]
      +
      +

      the configured chained handlers.

      +
      +
    • +
    • +
      handlerIndex: number
      +
      +

      current index into the chained handlers e.g. 0 is the first chained handler

      +
      +
    • +
    • +
      previousResponseObjects: any[]
      +
      +

      command responses completed so far

      +
      +
    • +
    • +
      overallArguments: yargs.Arguments
      +
      +

      arguments specified by the use for the overall chained command

      +
      +
    • +
    • +
      logger: Logger
      +
      +

      a logger to use as we check and perform the argument mappings

      +
      +
    • +
    +

    Returns yargs.Arguments

    +

    fully mapped arguments for this command

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.cliprofilemanager.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.cliprofilemanager.html new file mode 100644 index 0000000000..ed838e21ae --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.cliprofilemanager.html @@ -0,0 +1,2353 @@ + + + + + + CliProfileManager | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CliProfileManager

+
+
+
+
+
+
+
+
+
+

A profile management API compatible with transforming command line arguments into + profiles

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Static Readonly META_FILE_SUFFIX

+
META_FILE_SUFFIX: string = "_meta"
+ +
+
+

The meta file suffix - always appended to the meta file to distinguish from other profiles. Users then cannot + supply a profile name that would conflict with the meta file.

+
+
+
static
+
+
memberof
+

AbstractProfileManager

+
+
+
+
+
+ +

Static Readonly PROFILE_EXTENSION

+
PROFILE_EXTENSION: string = ".yaml"
+ +
+
+

The default profile file extension (YAML format) - all profiles are stored in YAML format including + the meta profile file.

+
+
+
static
+
+
memberof
+

ProfileManager

+
+
+
+
+
+
+

Accessors

+
+ +

configurations

+ + +
+
+ +

Protected loadCounter

+
    +
  • get loadCounter(): Map<string, number>
  • +
+ +
+
+ +

Protected log

+ + +
+
+ +

Protected managerParameters

+ + +
+
+ +

Protected productDisplayName

+
    +
  • get productDisplayName(): string
  • +
+ +
+
+ +

Protected profileRootDirectory

+
    +
  • get profileRootDirectory(): string
  • +
+ +
+
+ +

Protected profileType

+
    +
  • get profileType(): string
  • +
+ +
+
+ +

Protected profileTypeConfiguration

+ + +
+
+ +

Protected profileTypeConfigurations

+ + +
+
+ +

Protected profileTypeMetaFileName

+
    +
  • get profileTypeMetaFileName(): string
  • +
+ +
+
+ +

Protected profileTypeRootDirectory

+
    +
  • get profileTypeRootDirectory(): string
  • +
+ +
+
+ +

Protected profileTypeSchema

+ + +
+
+
+

Methods

+
+ +

Private addProfileInstruction

+
    +
  • addProfileInstruction(errDetails: string): string
  • +
+
    +
  • + +
    +
    +

    After the DefaultCredentialManager reports an error resolution of recreating + a credential, add instruction to recreate the profile.

    +
    +
    +

    Parameters

    +
      +
    • +
      errDetails: string
      +
      +

      The additional details of an error thrown + by DefaultCredentialManager.

      +
      +
    • +
    +

    Returns string

    +

    An error details string that contains an instruction to + recreate the profile (when appropriate).

    +
  • +
+
+
+ +

clearDefault

+
    +
  • clearDefault(): string
  • +
+ +
+
+ +

Protected constructFullProfilePath

+
    +
  • constructFullProfilePath(name: string, type?: string): string
  • +
+ +
+
+ +

Private createProfileFromCommandArguments

+ +
    +
  • + +
    +
    +

    Take command line arguments from the user and create a profile from them using the schema and configuration for + the profile type

    +
    +
    +

    Parameters

    +
      +
    • +
      profileArguments: Arguments
      +
      +

      CLI arguments specified by the user

      +
      +
    • +
    • +
      starterProfile: IProfile
      +
      +

      the profile with name and type to use to start the profile creation

      +
      +
    • +
    +

    Returns Promise<IProfile>

    +

    profile which provides the finished profile on fulfill

    +
  • +
+
+
+ +

delete

+ +
    +
  • + +
    +
    +

    Deletes a profile from disk. Ensures that the parameters are correct and removes the profile. If the profile is listed as a dependency of + other profiles it will NOT delete the profile unless "rejectIfDependency" is set to false.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      parms: D
      +
      +

      See the interface for details

      +
      +
    • +
    +

    Returns Promise<IProfileDeleted>

    +
      +
    • The promise that is fulfilled with the response object (see interface for details) or rejected + with an Imperative Error.
    • +
    +
  • +
+
+
+ +

Protected deleteProfile

+ + +
+
+ +

Protected deleteProfileFromDisk

+
    +
  • deleteProfileFromDisk(name: string): string
  • +
+ +
+
+ +

Private findOptions

+ +
    +
  • + +
    +
    +

    Helper routine to find nested properties + Inspired by the inner function of insertCliArgumentsIntoProfile

    +
    +
    +

    Parameters

    +
      +
    • +
      prop: ICommandProfileProperty
      +
      +

      profile property

      +
      +
    • +
    • +
      propNamePath: string
      +
      +

      Dot notation path of a property (e.g. my.nested.property)

      +
      +
    • +
    • +
      propValue: any
      +
      +

      Current value of the property while traversing down the object tree

      +
      +
    • +
    • +
      Optional secureOp: SecureOperationFunction
      +
      +

      Function to be executed if we are supposed to process secure properties

      +
      +
    • +
    +

    Returns Promise<any>

    +

    Processed version of a property

    +
  • +
+
+
+ +

getAllProfileNames

+
    +
  • getAllProfileNames(): string[]
  • +
+ +
+
+ +

getDefaultProfileName

+
    +
  • getDefaultProfileName(): string
  • +
+ +
+
+ +

Private insertCliArgumentsIntoProfile

+
    +
  • insertCliArgumentsIntoProfile(args: Arguments, profile: IProfile): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Default style of building of profile fields to option definitions defined in the schema + Will only work if there is a one-to-one option definition mapping for schema fields

    +
    +
    +

    Parameters

    +
      +
    • +
      args: Arguments
      +
      +

      the arguments specified by the user

      +
      +
    • +
    • +
      profile: IProfile
      +
      +

      the profile so far, which will be updated

      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+ +

Private insertDependenciesIntoProfileFromCLIArguments

+
    +
  • insertDependenciesIntoProfileFromCLIArguments(args: Arguments, profile: IProfile): void
  • +
+ +
+
+ +

Protected isProfileEmpty

+
    +
  • isProfileEmpty(profile: IProfile): boolean
  • +
+
    +
  • + +
    +
    +

    Checks if the profile object passed is "empty" - meaning it has no contents other than that type or name. + A profile can only specify "dependencies", in the event that it is just acting as a "pointer" to another profile.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      profile: IProfile
      +
      +

      The profile to check for "emptiness".

      +
      +
    • +
    +

    Returns boolean

    +

    True if the profile object is empty.

    +
  • +
+
+
+ +

load

+ +
    +
  • + +
    +
    +

    Load a profile from disk. Ensures that the parameters are valid and loads the profile specified by name OR the default profile if + requested. If load default is requested, any name supplied is ignored.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      parms: L
      +
      +

      See the interface for details.

      +
      +
    • +
    +

    Returns Promise<IProfileLoaded>

    +
      +
    • The promise that is fulfilled with the response object (see interface for details) or rejected + with an Imperative Error.
    • +
    +
  • +
+
+
+ +

loadAll

+ + +
+
+ +

Protected loadDependencies

+ + +
+
+ +

Protected loadFailed

+
    +
  • loadFailed(name: string): void
  • +
+ +
+
+ +

Protected loadProfile

+ + +
+
+ +

Protected loadSpecificProfile

+
    +
  • loadSpecificProfile(name: string, failNotFound?: boolean, loadDependencies?: boolean): Promise<IProfileLoaded>
  • +
+ +
+
+ +

Protected locateExistingProfile

+
    +
  • locateExistingProfile(name: string): string
  • +
+ +
+
+ +

mergeProfiles

+ + +
+
+ +

Private processSecureProperties

+ + +
+
+ +

save

+ +
    +
  • + +
    +
    +

    Save a profile to disk. Ensures that the profile specified is valid (basic and schema validation) and invokes the implementations + "saveProfile" method to perform the save and formulate the response.

    +
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      parms: S
      +
      +

      See interface for details

      +
      +
    • +
    +

    Returns Promise<IProfileSaved>

    +
      +
    • The promise that is fulfilled with the response object (see interface for details) or rejected + with an Imperative Error.
    • +
    +
  • +
+
+
+ +

Protected saveProfile

+ + +
+
+ +

setDefault

+
    +
  • setDefault(name: string): string
  • +
+ +
+
+ +

update

+ + +
+
+ +

Protected updateProfile

+ + +
+
+ +

Private updateProfileFieldsFromCommandArguments

+ +
    +
  • + +
    +
    +

    If a custom handler is provided for update, the handler will be loaded and invoked + in order to build the finished profile

    +
    +
    +

    Parameters

    +
      +
    • +
      oldProfile: IProfile
      +
      +

      the old profile to update

      +
      +
    • +
    • +
      newProfile: IProfile
      +
      +

      new profile which may have fields populated, which will be updated from the CLI args

      +
      +
    • +
    • +
      newArguments: Arguments
      +
      +

      CLi arguments specified by the user

      +
      +
    • +
    • +
      merge: boolean
      +
      +

      should the profiles be merged? (will be skipped if there is a custom update profile handler)

      +
      +
    • +
    +

    Returns Promise<IProfile>

    +
      +
    • promise which provides the finished profile on fulfill
    • +
    +
  • +
+
+
+ +

Private updateProfileFromCliArgs

+ + +
+
+ +

validate

+ + +
+
+ +

Protected validateProfile

+ + +
+
+ +

Protected validateProfileAgainstSchema

+
    +
  • validateProfileAgainstSchema(name: string, profile: IProfile, strict?: boolean): void
  • +
+ +
+
+ +

Protected validateProfileObject

+
    +
  • validateProfileObject(name: string, type: string, profile: IProfile): void
  • +
+ +
+
+ +

Private validateRequiredDependenciesAreSpecified

+
    +
  • validateRequiredDependenciesAreSpecified(profile: IProfile): void
  • +
+ +
+
+ +

Static initialize

+ +
    +
  • + +
    +
    +

    Static method to initialize the profile environment. Accepts the profile root directory (normally supplied by + your Imperative configuration documents) and all profile "type" configuration documents and constructs the directories + needed to manage profiles of all types. You must execute this method before beginning to use profiles OR you must + supply all the type configuration documents (normally obtained from your Imperative configuration document) to + the constructor of

    +
    +
    +
    static
    +
    +
    memberof
    +

    AbstractProfileManager

    +
    +
    +
    +

    Parameters

    + +

    Returns Promise<IProfileInitialized[]>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Inherited constructor
  • +
  • Inherited method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
    +
  • Private method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.cliutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.cliutils.html new file mode 100644 index 0000000000..02200d1931 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.cliutils.html @@ -0,0 +1,1153 @@ + + + + + + CliUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CliUtils

+
+
+
+
+
+
+
+
+
+

Cli Utils contains a set of static methods/helpers that are CLI related (forming options, censoring args, etc.)

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + CliUtils +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static CENSORED_OPTIONS

+
CENSORED_OPTIONS: string[] = ["auth", "p", "pass", "password", "passphrase", "credentials","authentication", "basic-auth", "basicAuth"]
+ +
+
+

A list of cli options/keywords that should normally be censored

+
+
+
static
+
+
memberof
+

CliUtils

+
+
+
+
+
+ +

Static Readonly CENSOR_RESPONSE

+
CENSOR_RESPONSE: "****" = "****"
+ +
+
+

Used as the place holder when censoring arguments in messages/command output

+
+
+
static
+
+
memberof
+

CliUtils

+
+
+
+
+
+
+

Methods

+
+ +

Static buildBaseArgs

+ +
    +
  • + +
    +
    +

    Accepts the yargs argument object and constructs the base imperative + argument object. The objects are identical to maintain compatibility with + existing CLIs and plugins, but the intent is to eventually phase out + having CLIs import anything from Yargs (types, etc).

    +
    +
    +

    Parameters

    +
      +
    • +
      args: Arguments
      +
      +

      Yargs argument object

      +
      +
    • +
    +

    Returns ICommandArguments

    +
      +
    • Imperative argument object
    • +
    +
  • +
+
+
+ +

Static censorCLIArgs

+
    +
  • censorCLIArgs(args: string[]): string[]
  • +
+ +
+
+ +

Static censorYargsArguments

+
    +
  • censorYargsArguments(args: Arguments): Arguments
  • +
+
    +
  • + +
    +
    +

    Copy and censor a yargs argument object before logging

    +
    +
    +

    Parameters

    +
      +
    • +
      args: Arguments
      +
      +

      the args to censor

      +
      +
    • +
    +

    Returns Arguments

    +

    a censored copy of the arguments

    +
  • +
+
+
+ +

Static extractArrayFromEnvValue

+
    +
  • extractArrayFromEnvValue(envValue: string): string[]
  • +
+
    +
  • + +
    +
    +

    Convert an array of strings provided as an environment variable

    +
    +
    +

    Parameters

    +
      +
    • +
      envValue: string
      +
      +

      String form of the array

      +
      +
    • +
    +

    Returns string[]

    +

    String[] based on environment variable

    +
  • +
+
+
+ +

Static extractEnvForOptions

+ +
    +
  • + +
    +
    +

    Accepts the full set of command options and extracts their values from environment variables that are set.

    +
    +
    +

    Parameters

    + +

    Returns ICommandArguments["args"]

    +
      +
    • the argument style object with both camel and kebab case keys for each + option specified in environment variables.
    • +
    +
  • +
+
+
+ +

Static formatHelpHeader

+
    +
  • formatHelpHeader(header: string, indent?: string, color: string): string
  • +
+
    +
  • + +
    +
    +

    Format the help header - normally used in help generation etc.

    +
    +
    +
    static
    +
    +
    memberof
    +

    CliUtils

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      header: string
      +
    • +
    • +
      Default value indent: string = " "
      +
    • +
    • +
      color: string
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

Static getDashFormOfOption

+
    +
  • getDashFormOfOption(optionName: string): string
  • +
+
    +
  • + +
    +
    +

    Get the 'dash form' of an option as it would appear in a user's command, + appending the proper number of dashes depending on the length of the option name

    +
    +
    +

    Parameters

    +
      +
    • +
      optionName: string
      +
      +

      e.g. my-option

      +
      +
    • +
    +

    Returns string

    +
      +
    • e.g. --my-option
    • +
    +
  • +
+
+
+ +

Static getEnvValForOption

+
    +
  • getEnvValForOption(envPrefix: string, cmdOption: string): string | null
  • +
+
    +
  • + +
    +
    +

    Get the value of an environment variable associated with the specified option name. + The environment variable name will be formed by concatenating an environment name prefix, + and the cmdOption using underscore as the delimiter.

    +
    +

    The cmdOption name can be specified in camelCase or in kabab-style. + Regardless of the style, it will be converted to upper case. + We replace dashes in Kabab-style values with underscores. We replace each uppercase + character in a camelCase value with underscore and that character.

    +

    The envPrefix will be used exactly as specified.

    +

    Example: The values myEnv-Prefix and someOptionName would retrieve + the value of an environment variable named + myEnv-Prefix_SOME_OPTION_NAME

    +
    +
    memberof
    +

    CliUtils

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      envPrefix: string
      +
      +

      The prefix for environment variables for this CLI. + Our caller can use the value obtained by ImperativeConfig.instance.envVariablePrefix, + which will use the envVariablePrefix from the Imperative config object, + and will use the rootCommandName as a fallback value.

      +
      +
    • +
    • +
      cmdOption: string
      +
      +

      The name of the option in either camelCase or kabab-style.

      +
      +
    • +
    +

    Returns string | null

    +
      +
    • The value of the environment variable which corresponds + to the supplied option for the supplied command. If no such environment variable + exists we return null.
    • +
    +
  • +
+
+
+ +

Static getOptValueFromProfiles

+ + +
+
+ +

Static getOptionFormat

+ +
    +
  • + +
    +
    +

    Takes a key and converts it to both camelCase and kebab-case.

    +
    +
    +
    example
    +
    Conversion of keys +

    CliUtils.getOptionFormat("helloWorld");

    +

    // returns + const return1 = { + key: "helloWorld", + camelCase: "helloWorld", + kebabCase: "hello-world" + }

    +

    /////////////////////////////////////////////////////

    +

    CliUtils.getOptionFormat("hello-world");

    +

    // returns + const return2 = { + key: "hello-world", + camelCase: "helloWorld", + kebabCase: "hello-world" + }

    +

    /////////////////////////////////////////////////////

    +

    CliUtils.getOptionFormat("hello--------world");

    +

    // returns + const return3 = { + key: "hello--------world", + camelCase: "helloWorld", + kebabCase: "hello-world" + }

    +

    /////////////////////////////////////////////////////

    +

    CliUtils.getOptionFormat("hello-World-");

    +

    // returns + const return4 = { + key: "hello-World-", + camelCase: "helloWorld", + kebabCase: "hello-world" + }

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +
      +

      The key to transform

      +
      +
    • +
    +

    Returns IOptionFormat

    +

    An object that contains the new format.

    +
  • +
+
+
+ +

Static getPositionalSyntaxString

+
    +
  • getPositionalSyntaxString(positionalRequired: boolean, positionalName: string): string
  • +
+
    +
  • + +
    +
    +

    Constructs the yargs style positional argument string.

    +
    +
    +
    static
    +
    +
    memberof
    +

    CliUtils

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      positionalRequired: boolean
      +
      +

      Indicates that this positional is required

      +
      +
    • +
    • +
      positionalName: string
      +
      +

      The name of the positional

      +
      +
    • +
    +

    Returns string

    +
      +
    • The yargs style positional argument string (e.g. );
    • +
    +
  • +
+
+
+ +

Static mergeArguments

+
    +
  • mergeArguments(...args: any[]): any
  • +
+
    +
  • + +
    +
    +

    Using Object.assign(), merges objects in the order they appear in call. Object.assign() copies and overwrites + existing properties in the target object, meaning property precedence is least to most (left to right).

    +
    +

    See details on Object.assign() for nuance.

    +
    +

    Parameters

    +
      +
    • +
      Rest ...args: any[]
      +
      +

      variadic set of objects to be merged

      +
      +
    • +
    +

    Returns any

    +
      +
    • the merged object
    • +
    +
  • +
+
+
+ +

Static promptForInput

+
    +
  • promptForInput(message: string): string
  • +
+
    +
  • + +
    +
    +

    Display a prompt that hides user input and reads from stdin + DOES NOT WORK WITH COMMANDS THAT ALSO READ STDIN + Useful for prompting the user for sensitive info such as passwords + Synchronous

    +
    +
    +
    deprecated
    +

    Use the asynchronous method readPrompt instead

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      The message to display to the user e.g. "Please enter password:"

      +
      +
    • +
    +

    Returns string

    +

    value - the value entered by the user

    +
  • +
+
+
+ +

Static promptWithTimeout

+
    +
  • promptWithTimeout(questionText: string, hideText?: boolean, secToWait?: number): Promise<string>
  • +
+
    +
  • + +
    +
    +

    Prompt the user with a question and wait for an answer, + but only up to the specified timeout.

    +
    +
    +
    deprecated
    +

    Use readPrompt instead which supports more options

    +
    +
    example
    +
     const answer = await CliUtils.promptWithTimeout("Type your answer here: ");
    + if (answer === null) {
    +     // abort the operation that you wanted to perform
    + } else {
    +     // use answer in some operation
    + }
    +
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      questionText: string
      +
      +

      The text with which we will prompt the user.

      +
      +
    • +
    • +
      Default value hideText: boolean = false
      +
      +

      Should we hide the text. True = display stars. + False = display text. Default = false.

      +
      +
    • +
    • +
      Default value secToWait: number = 600
      +
      +

      The number of seconds that we will wait for an answer. + If not supplied, the default is 600 seconds.

      +
      +
    • +
    +

    Returns Promise<string>

    +

    A string containing the user's answer, or null if we timeout.

    +
  • +
+
+
+ +

Static readPrompt

+ +
    +
  • + +
    +
    +

    Prompt the user with a question and wait for an answer, + but only up to the specified timeout.

    +
    +
    +
    example
    +
     const answer = await CliUtils.readPrompt("Type your answer here: ");
    + if (answer === null) {
    +     // abort the operation that you wanted to perform
    + } else {
    +     // use answer in some operation
    + }
    +
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      The text with which we will prompt the user.

      +
      +
    • +
    • +
      Optional opts: IPromptOptions
      +
    • +
    +

    Returns Promise<string | null>

    +

    A string containing the user's answer, or null if we timeout.

    +
  • +
+
+
+ +

Static setOptionValue

+
    +
  • setOptionValue(optName: string, optAliases: string[], value: any): ICommandArguments["args"]
  • +
+
    +
  • + +
    +
    +

    Accepts an option name, and array of option aliases, and their value + and returns the arguments style object.

    +
    +
    +
    example
    +
    Create Argument Object +

    CliUtils.setOptionValue("my-option", ["mo", "o"], "value");

    +

    // returns + { + "myOption": "value", + "my-option": "value", + "mo": "value", + "o": "value" + }

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      optName: string
      +
      +

      The command option name, usually in kebab case (or a single word)

      +
      +
    • +
    • +
      optAliases: string[]
      +
      +

      An array of alias names for this option

      +
      +
    • +
    • +
      value: any
      +
      +

      The value to assign to the argument

      +
      +
    • +
    +

    Returns ICommandArguments["args"]

    +
      +
    • The argument style object
    • +
    +
  • +
+
+
+ +

Static showMsgWhenDeprecated

+ + +
+
+ +

Static sleep

+
    +
  • sleep(timeInMs: number): Promise<unknown>
  • +
+
    +
  • + +
    +
    +

    Sleep for the specified number of miliseconds.

    +
    +
    +
    example
    +
     // create a synchronous delay as follows:
    + await CliUtils.sleep(3000);
    +
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      timeInMs: number
      +
      +

      Number of miliseconds to sleep

      +
      +
    • +
    +

    Returns Promise<unknown>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.commandpreparer.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandpreparer.html new file mode 100644 index 0000000000..9d9ac53fe4 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandpreparer.html @@ -0,0 +1,686 @@ + + + + + + CommandPreparer | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CommandPreparer

+
+
+
+
+
+
+
+
+
+

Command preparer provides static utilities to ensure that command definitions are suitable for Imperative definition.

+
+
+
+
+

Hierarchy

+
    +
  • + CommandPreparer +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static Private appendAutoOptions

+ + +
+
+ +

Static Private appendPassOnOptions

+ + +
+
+ +

Static Private ignoreNode

+ + +
+
+ +

Static Private passOn

+ +
    +
  • + +
    +
    +

    A command definition node can indicate any arbitrary field be "passed on" to it's children. The intention is + to provide convienence for the coder of definition document, when they want to apply the same attributes (such + as reading from stdin OR which profiles are required) to all of its decedents.

    +
    +
    +

    Parameters

    +
      +
    • +
      definition: ICommandDefinition
      +
      +

      the original command document

      +
      +
    • +
    • +
      Optional inherit: ICommandDefinitionPassOn[]
      +
      +

      the current set of attributes/fields being "passed on" - if a "pass on" + specification is found in a child document, it overwrites the parents (takes precedence)

      +
      +
    • +
    +

    Returns void

    +

    A copy of the original with all "passed on" fields.

    +
  • +
+
+
+ +

Static Private perfomBasicValidation

+ +
    +
  • + +
    +
    +

    Perform preliminary (or post prepared) basic validation of the command definition tree. Checks to ensure + that absoultely necessary fields are populated and invalid combos are not present.

    +
    +

    Note: The root command is a bit of a special case, and is immune to some validation - we can't have a + name associated because that would cause an extra segment added in yargs.

    +
    +

    Parameters

    +
      +
    • +
      definition: ICommandDefinition
      +
      +

      The current command definition in the tree

      +
      +
    • +
    • +
      definitions: ICommandDefinition[]
      +
      +

      the current set of definitions we've traversed - for diagnostics

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static Private performBasicOptionValidation

+ +
    +
  • + +
    +
    +

    Perform basic option operand validation. Ensure that the option operands are valid and well formed.

    +
    +
    +
    static
    +
    +
    memberof
    +

    CommandPreparer

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      definition: ICommandDefinition
      +
      +

      The command definition containing options to be validated

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static Private performBasicPositionalValidation

+ +
    +
  • + +
    +
    +

    Perform basic positional operand validation. Ensure that the positional operands are valid and well formed.

    +
    +
    +
    static
    +
    +
    memberof
    +

    CommandPreparer

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      definition: ICommandDefinition
      +
      +

      The command definition containing positionals to be validated

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static Private populatePassOnValueFromParent

+ +
    +
  • + +
    +
    +

    If the "passOn" specification does not indicate a value, we will extract the value/trait from the parent and + populate the "passOn" value. This allows parents to pass on their own properties/traits.

    +
    +
    +
    static
    +
    +
    memberof
    +

    CommandPreparer

    +
    +
    +
    +

    Parameters

    + +

    Returns void

    +
  • +
+
+
+ +

Static prepare

+ + +
+
+ +

Static Private setDefaultValues

+ +
    +
  • + +
    +
    +

    If optional fields have not been populated in the original definition, ensure they are set to the appropriate defaults.

    +
    +
    +
    static
    +
    +
    memberof
    +

    CommandPreparer

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      definition: ICommandDefinition
      +
      +

      the definition tree to set the default values

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static validateDefinitionTree

+ +
    +
  • + +
    +
    +

    Perform preliminary (or post-preparation) basic validation of the command definition tree. Checks to ensure + that absoultely necessary fields are populated and invalid combos are not present.

    +
    +
    +

    Parameters

    +
      +
    • +
      definitionTree: ICommandDefinition
      +
      +

      full tree of command definitions to validate

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.commandprocessor.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandprocessor.html new file mode 100644 index 0000000000..e507565a79 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandprocessor.html @@ -0,0 +1,1411 @@ + + + + + + CommandProcessor | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CommandProcessor

+
+
+
+
+
+
+
+
+
+

The command processor for imperative - accepts the command definition for the command being issued (and a pre-built) + response object and validates syntax, loads profiles, instantiates handlers, & invokes the handlers.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + CommandProcessor +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mCommandLine

+
mCommandLine: string
+ +
+
+

The command line.

+
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Private mCommandRootName

+
mCommandRootName: string
+ +
+
+

The root command name of the CLI (specified in the Imperative Configuration document)

+
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Private mConfig

+
mConfig: Config
+ +
+
+

Config object used to load profiles from active config layers.

+
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Private Optional mDaemonContext

+
mDaemonContext: IDaemonContext
+ +
+
+

The context object defined when in daemon mode.

+
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Private mDefinition

+
mDefinition: ICommandDefinition
+ +
+
+

The command definition node for the command being executed.

+
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Private mEnvVariablePrefix

+
mEnvVariablePrefix: string
+ +
+
+

Environmental variable name prefix used to construct configuration environmental variables.

+
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Private mFullDefinition

+
mFullDefinition: ICommandDefinition
+ +
+
+

The full command definition contains all parents/ancestors of the command being executed.

+
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Private mHelpGenerator

+
mHelpGenerator: IHelpGenerator
+ +
+
+

The help generator to use - normally passed the default generator.

+
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Private mLogger

+
mLogger: Logger = Logger.getImperativeLogger()
+ +
+
+

Imperative Logger instance for logging from the command processor.

+
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Private mProfileManagerFactory

+ + +
+
+

The profile manager to use when loading profiles for commands

+
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Private mPromptPhrase

+
mPromptPhrase: string
+ +
+
+

The phrase used to indicate the user wants to enter the value of an argument in a hidden text prompt

+
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Static Private Readonly ENV_SHOW_SECURE_SUFFIX

+
ENV_SHOW_SECURE_SUFFIX: "_SHOW_SECURE_ARGS" = `_SHOW_SECURE_ARGS`
+ +
+
+

Show secure fields in the output of the command ENV var suffix

+
+
+
static
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Static Private Readonly ERROR_TAG

+
ERROR_TAG: string = "Command Processor Error:"
+ +
+
+

The error tag for imperative errors.

+
+
+
static
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+
+

Accessors

+
+ +

commandLine

+
    +
  • get commandLine(): string
  • +
+ +
+
+ +

config

+ + +
+
+ +

definition

+ + +
+
+ +

envVariablePrefix

+
    +
  • get envVariablePrefix(): string
  • +
+ +
+
+ +

fullDefinition

+ + +
+
+ +

helpGenerator

+ + +
+
+ +

Private log

+ + +
+
+ +

profileFactory

+ + +
+
+ +

promptPhrase

+
    +
  • get promptPhrase(): string
  • +
+ +
+
+ +

rootCommand

+
    +
  • get rootCommand(): string
  • +
+ +
+
+
+

Methods

+
+ +

Private attemptHandlerLoad

+ + +
+
+ +

Private constructResponseObject

+ + +
+
+ +

Private finishResponse

+ + +
+
+ +

Private getStdinStream

+
    +
  • getStdinStream(): stream.Readable
  • +
+
    +
  • + +
    +
    +

    Get stdin stream for the command handler to use. In daemon mode this is + a stream of data received from the daemon client. Otherwise it defaults + to process.stdin.

    +
    +
    +

    Returns stream.Readable

    +

    Readable stream containing stdin data

    +
  • +
+
+
+ +

Private handleHandlerError

+
    +
  • handleHandlerError(handlerErr: Error | string, response: CommandResponse, handlerPath: string): void
  • +
+
    +
  • + +
    +
    +

    Respond to an error encountered when invoking a command handler

    +
    +
    +

    Parameters

    +
      +
    • +
      handlerErr: Error | string
      +
      +

      the error that was encountered

      +
      +
    • +
    • +
      response: CommandResponse
      +
      +

      a response object to print error messages to

      +
      +
    • +
    • +
      handlerPath: string
      +
      +

      path to the handler with which an error was encountered

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

help

+ + +
+
+ +

Private invalidSyntaxNotification

+ + +
+
+ +

invoke

+ +
    +
  • + +
    +
    +

    Invoke the command handler. Locates and requires the module specified by the command definition document, + creates a new object, creates a response object, and invokes the handler. The handler is responsible for + fulfilling the promise when complete.

    +
    +
    +

    Parameters

    + +

    Returns Promise<ICommandResponse>

    +
      +
    • The promise that is fulfilled. A rejection if the promise indicates a + truly exceptional condition (should not occur).
    • +
    +
  • +
+
+
+ +

Private prepare

+ + +
+
+ +

Private showInputsOnly

+ + +
+
+ +

validate

+ + +
+
+ +

webHelp

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.commandprofileloader.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandprofileloader.html new file mode 100644 index 0000000000..efcd30dd8d --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandprofileloader.html @@ -0,0 +1,805 @@ + + + + + + CommandProfileLoader | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CommandProfileLoader

+
+
+
+
+
+
+
+
+
+

The command processor profile loader loads all profiles that are required (or optional) given a command + definitions requirements. It returns the CommandProfiles object (which contains the map and getters for the + command handlers usage).

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + CommandProfileLoader +
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mCommandDefinition

+
mCommandDefinition: ICommandDefinition
+ +
+
+

The input command definition for the command being issued.

+
+
+
memberof
+

CommandProfileLoader

+
+
+
+
+
+ +

Private mFactory

+ + +
+
+

The factory for getting profile manager instances.

+
+
+
memberof
+

CommandProfileLoader

+
+
+
+
+
+ +

Private mLog

+
mLog: Logger
+ +
+
+

Logger - supplied on the constructor - but defaults to the Imperative logger.

+
+
+
memberof
+

CommandProfileLoader

+
+
+
+
+
+
+

Accessors

+
+ +

Private definition

+ + +
+
+ +

Private factory

+ + +
+
+ +

Private log

+ + +
+
+
+

Methods

+
+ +

Private buildCommandMap

+ + +
+
+ +

Private buildCommandMetaMap

+ + +
+
+ +

Private buildLoad

+
    +
  • buildLoad(optional: boolean, types: string[], commandArguments: Arguments): ICommandLoadProfile[]
  • +
+
    +
  • + +
    +
    +

    Builds the control parameters for the loading of each profile name/type.

    +
    +
    +
    memberof
    +

    CommandProfileLoader

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      optional: boolean
      +
      +

      If the profile is optional

      +
      +
    • +
    • +
      types: string[]
      +
      +

      The profile types to load

      +
      +
    • +
    • +
      commandArguments: Arguments
      +
      +

      The command arguments

      +
      +
    • +
    +

    Returns ICommandLoadProfile[]

    +
      +
    • The list of profiles to load (and control parameters)
    • +
    +
  • +
+
+
+ +

Private constructLoadList

+ + +
+
+ +

Private loadAll

+ + +
+
+ +

loadProfiles

+ +
    +
  • + +
    +
    +

    Load the profiles for the command - the command arguments are supplied to grab the profile names from + the arguments supplied by the user.

    +
    +
    +
    memberof
    +

    CommandProfileLoader

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      commandArguments: Arguments
      +
      +

      The command arguments supplied on this command invocation (Yargs style)

      +
      +
    • +
    +

    Returns Promise<CommandProfiles>

    +
      +
    • The promise is fulfilled with the map object OR rejected with an + Imperative error
    • +
    +
  • +
+
+
+ +

Static loader

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.commandprofiles.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandprofiles.html new file mode 100644 index 0000000000..303a7086f0 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandprofiles.html @@ -0,0 +1,677 @@ + + + + + + CommandProfiles | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CommandProfiles

+
+
+
+
+
+
+
+
+
+

Profiles map created by the command profile loader and passed to the handler via parameters. Handlers can + retreive loaded profiles from the map via the profile type.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + CommandProfiles +
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mMap

+
mMap: Map<string, IProfile[]>
+ +
+
+

The loaded profiles map - profiles are retrieved via the type key. More than one profile of a particular type + can be loaded by the command processor (depending on dependencies, etc.)

+
+
+
memberof
+

CommandProfiles

+
+
+
+
+
+ +

Private mMetaMap

+
mMetaMap: Map<string, IProfileLoaded[]> = new Map<string, IProfileLoaded[]>()
+ +
+
+

The loaded profiles map with meta info - profiles are retrieved via the type key. More than one profile of a particular type + can be loaded by the command processor (depending on dependencies, etc.)

+
+
+
memberof
+

CommandProfiles

+
+
+
+
+
+
+

Accessors

+
+ +

Private map

+
    +
  • get map(): Map<string, IProfile[]>
  • +
+ +
+
+ +

Private metaMap

+ + +
+
+
+

Methods

+
+ +

Private addMeta

+ + +
+
+ +

Private fail

+
    +
  • fail(type: string): void
  • +
+
    +
  • + +
    +
    +

    Throw an error failing the get(requested by the caller if no profiles are available)

    +
    +
    +
    memberof
    +

    CommandProfiles

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
      +
      +

      the profile type to get from the map

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

get

+
    +
  • get<T>(type: string, failNotFound?: boolean, name?: string): T
  • +
+
    +
  • + +
    +
    +

    Gets the first (or by name) profile in the map - automatically throws an exception (unless disabled)

    +
    +
    +
    deprecated
    +

    Load profile properties from IHandlerParameters.arguments property instead.

    +
    +
    memberof
    +

    CommandProfiles

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      T: IProfile

      +
      +

      The expected profile mapping to be returned

      +
      +
    • +
    +

    Parameters

    +
      +
    • +
      type: string
      +
      +

      The profile type

      +
      +
    • +
    • +
      Default value failNotFound: boolean = true
      +
    • +
    • +
      Default value name: string = ""
      +
    • +
    +

    Returns T

    +
      +
    • The first profile in the map (or the one located by name)
    • +
    +
  • +
+
+
+ +

getAll

+
    +
  • getAll<T>(type: string, failNotFound?: boolean): T[]
  • +
+
    +
  • + +
    +
    +

    Gets all profiles for the type specified,

    +
    +
    +
    deprecated
    +
    +
    memberof
    +

    CommandProfiles

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      T: IProfile

      +
      +

      extends IProfile

      +
      +
    • +
    +

    Parameters

    +
      +
    • +
      type: string
      +
      +

      The profile type to retrieve loaded profiles

      +
      +
    • +
    • +
      Default value failNotFound: boolean = true
      +
    • +
    +

    Returns T[]

    +
      +
    • The list of profile types
    • +
    +
  • +
+
+
+ +

getMeta

+
    +
  • getMeta<T>(type: string, failNotFound?: boolean, name?: string): T
  • +
+
    +
  • + +
    +
    +

    Gets the first (or by name) meta profile in the map - automatically throws an exception (unless disabled)

    +
    +
    +
    deprecated
    +
    +
    memberof
    +

    CommandProfiles

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      T: IProfileLoaded

      +
      +

      The expected profile mapping to be returned

      +
      +
    • +
    +

    Parameters

    +
      +
    • +
      type: string
      +
      +

      The profile type

      +
      +
    • +
    • +
      Default value failNotFound: boolean = true
      +
    • +
    • +
      Default value name: string = ""
      +
    • +
    +

    Returns T

    +
      +
    • The first profile in the map (or the one located by name)
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.commandresponse.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandresponse.html new file mode 100644 index 0000000000..ef12e68723 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandresponse.html @@ -0,0 +1,1701 @@ + + + + + + CommandResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CommandResponse

+
+
+
+
+
+
+
+
+
+

Command response object allocated by the command processor and used to construct the handler response object + passed to the command handlers. The response object contains all the methods necessary for a command handler (and + the processor) to formulate a command response. Controls buffering of messages and JSON response formats.

+
+

Instances of this class are only manipulated by the command processor. See "HandlerResponse" for the handler response + object.

+
+
export
+
+
implements
+

{ICommandResponseApi}

+
+
+
+
+
+

Hierarchy

+
    +
  • + CommandResponse +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mArguments

+
mArguments: Arguments
+ +
+
+

The arguments passed to the command - may be undefined/null

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mConsoleApi

+ + +
+
+

API instance for the console APIs - used to write messages to stdout/stderr.

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mControl

+ + +
+
+

The full set of control parameters for the response - see the interface for details.

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mData

+
mData: any
+ +
+
+

The "data" object that is placed on the JSON response object of the command

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mDataApi

+ + +
+
+

API instance for the data APIs - used to populate the JSON response object fields.

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mDefinition

+
mDefinition: ICommandDefinition
+ +
+
+

The command definition document - may be undefined/null

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mError

+ + +
+
+

The error object appended to the JSON response to the command - automatically added if the handler rejects + the promise.

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mExitCode

+
mExitCode: number = null
+ +
+
+

Command handler exit code. Will be used when exiting the process at the end of command execution

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mFormatApi

+ + +
+
+

Format APIs for automatically formatting output data

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mMessage

+
mMessage: string = ""
+ +
+
+

The message placed on the response object when the JSON response is built

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mPrimaryTextColor

+
mPrimaryTextColor: string = Constants.DEFAULT_HIGHLIGHT_COLOR
+ +
+
+

The default highlight color for chalk

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mProgressApi

+
mProgressApi: IHandlerProgressApi
+ +
+
+

API instance for the progress bar - used to create/end command progress bars.

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mProgressBar

+
mProgressBar: any
+ +
+
+

Progress bar instance - only one can be present at any given time.

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mProgressBarSpinnerChars

+
mProgressBarSpinnerChars: string = "-oO0)|(0Oo-"
+ +
+
+

The progress bar spinner chars.

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mResponseFormat

+
mResponseFormat: COMMAND_RESPONSE_FORMAT
+ +
+
+

The command response format - JSON, default, etc.

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mSilent

+
mSilent: boolean = false
+ +
+
+

Enable silent mode - means absolutely NO output will be written to the console/terminal.

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mStderr

+
mStderr: Buffer = Buffer.alloc(0)
+ +
+
+

The stderr buffer - collects all messages sent to stderr.

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mStdout

+
mStdout: Buffer = Buffer.alloc(0)
+ +
+
+

The stdout buffer - collects all messages sent to stdout.

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mStream

+
mStream: Socket
+ +
+
+

The stream to write to in daemon mode

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Private mSucceeded

+
mSucceeded: boolean = true
+ +
+
+

Command handler succeeded flag - true if the command succeeded.

+
+
+
memberof
+

CommandResponse

+
+
+
+
+
+ +

Static Private Readonly MAX_COLUMN_WIDTH

+
MAX_COLUMN_WIDTH: 9999 = 9999
+ +
+
+

Max column width for formulating tabular output

+
+
+
static
+
+
memberof
+

CommandProcessor

+
+
+
+
+
+ +

Static Private Readonly RESPONSE_ERR_TAG

+
RESPONSE_ERR_TAG: string = "Command Response Error:"
+ +
+
+

Imperative Error tag for error messaging

+
+
+
static
+
+
memberof
+

CommandResponse

+
+
+
+
+
+
+

Accessors

+
+ +

console

+ + +
+
+ +

Private control

+ + +
+
+ +

data

+ + +
+
+ +

format

+ + +
+
+ +

progress

+ + +
+
+ +

responseFormat

+ + +
+
+ +

silent

+
    +
  • get silent(): boolean
  • +
+ +
+
+
+

Methods

+
+ +

bufferStderr

+
    +
  • bufferStderr(data: Buffer | string): void
  • +
+
    +
  • + +
    +
    +

    Buffer the message (string or buffer) to the stderr buffer. Used to accumulate messages for different reasons + (JSON mode is enabled, etc.).

    +
    +
    +
    memberof
    +

    CommandResponse

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      data: Buffer | string
      +
      +

      The data/messages to buffer.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

bufferStdout

+
    +
  • bufferStdout(data: Buffer | string): void
  • +
+
    +
  • + +
    +
    +

    Buffer the message (string or buffer) to the stdout buffer. Used to accumulate messages for different reasons + (JSON mode is enabled, etc.).

    +
    +
    +
    memberof
    +

    CommandResponse

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      data: Buffer | string
      +
      +

      The data/messages to buffer.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

buildJsonResponse

+ + +
+
+ +

endProgressBar

+
    +
  • endProgressBar(): void
  • +
+ +
+
+ +

Private endStream

+
    +
  • endStream(): void
  • +
+ +
+
+ +

failed

+
    +
  • failed(): void
  • +
+ +
+
+ +

Private formatMessage

+
    +
  • formatMessage(msg: string, ...values: any[]): string
  • +
+
    +
  • + +
    +
    +

    Uses text utils to format the message (format strings).

    +
    +
    +
    memberof
    +

    CommandResponse

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      msg: string
      +
      +

      The format message

      +
      +
    • +
    • +
      Rest ...values: any[]
      +
      +

      The substitution values for the format string

      +
      +
    • +
    +

    Returns string

    +
      +
    • Returns the formatted message
    • +
    +
  • +
+
+
+ +

Private setDaemonExitCode

+
    +
  • setDaemonExitCode(): void
  • +
+ +
+
+ +

setError

+ + +
+
+ +

succeeded

+
    +
  • succeeded(): void
  • +
+ +
+
+ +

Private write

+
    +
  • write(): boolean
  • +
+
    +
  • + +
    +
    +

    Indicates if output should be written immediately to the console/terminal. If silent mode is true or response + format indicates JSON, then write() will return false.

    +
    +
    +
    memberof
    +

    CommandResponse

    +
    +
    +
    +

    Returns boolean

    +
      +
    • True if the output should be written to the console/terminal.
    • +
    +
  • +
+
+
+ +

Private writeAndBufferStderr

+
    +
  • writeAndBufferStderr(data: Buffer | string): void
  • +
+ +
+
+ +

Private writeAndBufferStdout

+
    +
  • writeAndBufferStdout(data: Buffer | string): void
  • +
+ +
+
+ +

writeJsonResponse

+ + +
+
+ +

Private writeStderr

+
    +
  • writeStderr(data: Buffer | string): void
  • +
+ +
+
+ +

Private writeStdout

+
    +
  • writeStdout(data: Buffer | string): void
  • +
+ +
+
+ +

Private writeStream

+
    +
  • writeStream(data: Buffer | string): void
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.commandutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandutils.html new file mode 100644 index 0000000000..3458a15d0a --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandutils.html @@ -0,0 +1,556 @@ + + + + + + CommandUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CommandUtils

+
+
+
+
+
+
+
+
+
+

Command utility class. Place static utils for command processing here.

+
+
+
+
+

Hierarchy

+
    +
  • + CommandUtils +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static Private addChildAndDescendantsToSearch

+ +
    +
  • + +
    +
    +

    Helper recursive function for flattening a given tree definition

    +
    +
    +

    Parameters

    +
      +
    • +
      prefix: string
      +
      +

      Previous command objects to prepend to the given child name

      +
      +
    • +
    • +
      child: ICommandDefinition
      +
      +

      Tree definition to use when searching for descendants

      +
      +
    • +
    • +
      Default value includeAliases: boolean = false
      +
      +

      Indicates whether or not we should include aliases in the recursion

      +
      +
    • +
    • +
      Default value _result: ICommandTreeEntry[] = []
      +
      +

      (recursion) resulting list of flattened descendants

      +
      +
    • +
    • +
      Default value _tree: ICommandDefinition = child
      +
      +

      (recursion) Initial tree definition

      +
      +
    • +
    +

    Returns ICommandTreeEntry[]

    +

    Concatenated list of flattened descendants

    +
  • +
+
+
+ +

Static flattenCommandTree

+ +
    +
  • + +
    +
    +

    Accepts the command definition document tree and flattens to a single level. This is used to make searching + commands and others easily.

    +
    +
    +

    Parameters

    +
      +
    • +
      tree: ICommandDefinition
      +
      +

      The command document tree

      +
      +
    • +
    • +
      Default value includeAliases: boolean = false
      +
      +

      Indicates whether or not we should include aliases in the flattened command tree

      +
      +
    • +
    +

    Returns ICommandTreeEntry[]

    +
      +
    • The flattened document tree
    • +
    +
  • +
+
+
+ +

Static flattenCommandTreeWithAliases

+ +
    +
  • + +
    +
    +

    Accepts the command definition document tree and flattens to a single level, including aliases. This is used to make searching + commands and others easily.

    +
    +
    +
    deprecated
    +

    Use CommandUtils.flattenCommandTree instead

    +
    +
    +
    +

    Parameters

    + +

    Returns ICommandTreeEntry[]

    +
      +
    • The flattened document tree
    • +
    +
  • +
+
+
+ +

Static getFullCommandName

+ + +
+
+ +

Static getOptionDefinitionFromName

+ + +
+
+ +

Static optionWasSpecified

+
    +
  • optionWasSpecified(optionName: string, commandDefinition: ICommandDefinition, args: ICommandArguments["args"]): boolean
  • +
+
    +
  • + +
    +
    +

    Check if an option was specified by the user.

    +
    +
    +

    Parameters

    +
      +
    • +
      optionName: string
      +
      +

      the option to check for.

      +
      +
    • +
    • +
      commandDefinition: ICommandDefinition
      +
      +

      the definition for the command

      +
      +
    • +
    • +
      args: ICommandArguments["args"]
      +
    • +
    +

    Returns boolean

    +

    true: the option was specified by the user. + false: the option was omitted/set to false

    +
  • +
+
+
+ +

Static reconstructCommand

+
    +
  • reconstructCommand(commandArguments: Arguments, commandDefinition: ICommandDefinition): string
  • +
+
    +
  • + +
    +
    +

    Get a representation of the original command as issued by the user .with all canonical forms of options specified. + You only need to supply the "command" segement of your command. The "full command" (including previous groups, etc.) + is extracted from the yargs arguments object "_" property. + TODO: Replace "maincommand" below with the name of the bin - This is new to Imperative.

    +
    +
    +

    Parameters

    +
      +
    • +
      commandArguments: Arguments
      +
      +

      The Yargs style argument object. Requires the "_" (input argv)

      +
      +
    • +
    • +
      commandDefinition: ICommandDefinition
      +
      +

      The command definition document

      +
      +
    • +
    +

    Returns string

    +
      +
    • The reconstructed command (as would have been issued on the console).
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.commandyargs.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandyargs.html new file mode 100644 index 0000000000..5995fc447e --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.commandyargs.html @@ -0,0 +1,1033 @@ + + + + + + CommandYargs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CommandYargs

+
+
+
+
+
+
+
+
+
+

Define an Imperative Command to Yargs. A command implies that an implementation is present (differs from a "group") + and it does not have children.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected log

+
log: Logger = Logger.getImperativeLogger()
+ +
+
+ +

Protected yargsParms

+
yargsParms: IYargsParms
+ +
+
+

Parameter object contains parms for Imperative/Yargs and command response objects

+
+
+
+
+ +

Static STOP_YARGS

+
STOP_YARGS: boolean = false
+ +
+
+

TODO: REMOVE THIS, workaround for yargs.fail() problem

+
+
+
+
+
+

Accessors

+
+ +

Protected commandLine

+
    +
  • get commandLine(): string
  • +
+ +
+
+ +

definition

+ + +
+
+ +

Protected envVariablePrefix

+
    +
  • get envVariablePrefix(): string
  • +
+ +
+
+ +

Protected helpGeneratorFactory

+ + +
+
+ +

parents

+ + +
+
+ +

Protected profileManagerFactory

+ + +
+
+ +

Protected promptPhrase

+
    +
  • get promptPhrase(): string
  • +
+ +
+
+ +

Protected responseParms

+ + +
+
+ +

Protected rootCommandName

+
    +
  • get rootCommandName(): string
  • +
+ +
+
+ +

yargs

+
    +
  • get yargs(): Argv
  • +
+ +
+
+
+

Methods

+
+ +

Private buildPositionalString

+
    +
  • buildPositionalString(): string
  • +
+
    +
  • + +
    +
    +

    Construct the positional argument string for Yargs. The positional arguments are always constructed as + "optional" to yargs. This prevents yargs from "throwing errors" if the user requests --help and the positional + parameters are not specified.

    +
    +
    +

    Returns string

    +

    : The positional argument string used in the Yargs command definition.

    +
  • +
+
+
+ +

constructDefinitionTree

+ + +
+
+ +

defineCommandToYargs

+ + +
+
+ +

Protected executeHelp

+ + +
+
+ +

Protected executeWebHelp

+ + +
+
+ +

Protected getBrightYargsResponse

+ + +
+
+ +

Protected getDepthExamples

+ + +
+
+ +

Protected getZoweYargsResponse

+ + +
+
+ +

Private invokeHandlers

+ + +
+
+ +

Static defineOptionsToYargs

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Inherited constructor
  • +
  • Inherited method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private method
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.completeauthgroupbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.completeauthgroupbuilder.html new file mode 100644 index 0000000000..ec654c1952 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.completeauthgroupbuilder.html @@ -0,0 +1,493 @@ + + + + + + CompleteAuthGroupBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CompleteAuthGroupBuilder

+
+
+
+
+
+
+
+
+
+

Generate a complete group of commands for logging in and out of services + based on provided auth definitions.

+
+
+
+
+

Hierarchy

+
    +
  • + CompleteAuthGroupBuilder +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+

Object literals

+ +
+
+
+
+
+

Methods

+
+ +

Static getAuthGroup

+ + +
+
+
+

Object literals

+
+ +

Static Private defaultAuthGroup

+
defaultAuthGroup: object
+ +
+ +

children

+
children: undefined[] = []
+ +
+
+ +

description

+
description: string = authCategoryDesc.message
+ +
+
+ +

name

+
name: string = Constants.AUTH_GROUP
+ +
+
+ +

type

+
type: "group" = "group"
+ +
+
+
+ +

Static Private defaultLoginGroup

+
defaultLoginGroup: object
+ +
+ +

aliases

+
aliases: string[] = ["li"]
+ +
+
+ +

children

+
children: undefined[] = []
+ +
+
+ +

description

+
description: string = authLoginGroupDesc.message
+ +
+
+ +

name

+
name: string = Constants.LOGIN_ACTION
+ +
+
+ +

summary

+
summary: string = authLoginGroupSummary.message
+ +
+
+ +

type

+
type: "group" = "group"
+ +
+
+
+ +

Static Private defaultLogoutGroup

+
defaultLogoutGroup: object
+ +
+ +

aliases

+
aliases: string[] = ["lo"]
+ +
+
+ +

children

+
children: undefined[] = []
+ +
+
+ +

description

+
description: string = authLogoutGroupDesc.message
+ +
+
+ +

name

+
name: string = Constants.LOGOUT_ACTION
+ +
+
+ +

summary

+
summary: string = authLogoutGroupSummary.message
+ +
+
+ +

type

+
type: "group" = "group"
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.completeautoinitcommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.completeautoinitcommandbuilder.html new file mode 100644 index 0000000000..410ecebfbf --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.completeautoinitcommandbuilder.html @@ -0,0 +1,271 @@ + + + + + + CompleteAutoInitCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CompleteAutoInitCommandBuilder

+
+
+
+
+
+
+
+
+
+

Generate a complete command for automatic initialization of a user configuration

+
+
+
+
+

Hierarchy

+
    +
  • + CompleteAutoInitCommandBuilder +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static getAutoInitCommand

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.completeprofilesgroupbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.completeprofilesgroupbuilder.html new file mode 100644 index 0000000000..1831a6c335 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.completeprofilesgroupbuilder.html @@ -0,0 +1,272 @@ + + + + + + CompleteProfilesGroupBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CompleteProfilesGroupBuilder

+
+
+
+
+
+
+
+
+
+

Generate a complete group of commands for maintaining configuration profiles + based on provided profile definitions.

+
+
+
+
+

Hierarchy

+
    +
  • + CompleteProfilesGroupBuilder +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static getProfileGroup

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.compressionutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.compressionutils.html new file mode 100644 index 0000000000..688aaf42df --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.compressionutils.html @@ -0,0 +1,434 @@ + + + + + + CompressionUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CompressionUtils

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + CompressionUtils +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static decompressBuffer

+ + +
+
+ +

Static Private decompressError

+ + +
+
+ +

Static decompressStream

+
    +
  • decompressStream(responseStream: Writable, encoding: ContentEncoding, normalizeNewLines?: boolean): Duplex
  • +
+
    +
  • + +
    +
    +

    Add zlib decompression transform to a Writable stream. Any compressed + data written to the returned stream will be decompressed using the + specified algorithm.

    +
    +

    The returned stream should only be used internally by a REST client to + write to. Use the original stream to read back the decompressed output + and handle decompression errors.

    +
    +
    throws
    +

    {ImperativeError}

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      responseStream: Writable
      +
      +

      Writable stream that will receive compressed data

      +
      +
    • +
    • +
      encoding: ContentEncoding
      +
      +

      Value of Content-Encoding header

      +
      +
    • +
    • +
      Optional normalizeNewLines: boolean
      +
      +

      Specifies if line endings should be converted

      +
      +
    • +
    +

    Returns Duplex

    +
  • +
+
+
+ +

Static Private newLinesTransform

+
    +
  • newLinesTransform(): Transform
  • +
+ +
+
+ +

Static Private zlibTransform

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.config.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.config.html new file mode 100644 index 0000000000..f0d512a539 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.config.html @@ -0,0 +1,1540 @@ + + + + + + Config | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Config

+
+
+
+
+
+
+
+
+
+

The Config class provides facilities for reading and writing team + configuration files. It is used by Imperative to perform low-level + operations on a team configuration. The intent is that consumer + apps will not typically use the Config class, since end-users are + expected to write team configuration files by directly editing them + in an editor like VSCode.

+
+
+
+
+

Hierarchy

+
    +
  • + Config +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

Private constructor

+ + +
+
+
+

Properties

+
+ +

mActive

+
mActive: { global: boolean; user: boolean }
+ +
+
+

Currently active layer whose properties will be manipulated

+
+
+
internal
+
+
+
+
+

Type declaration

+
    +
  • +
    global: boolean
    +
  • +
  • +
    user: boolean
    +
  • +
+
+
+
+ +

Private mApi

+
mApi: { layers: ConfigLayers; plugins: ConfigPlugins; profiles: ConfigProfiles; secure: ConfigSecure }
+ +
+
+

Cached version of Config APIs

+
+
+
+

Type declaration

+ +
+
+
+ +

mApp

+
mApp: string
+ +
+
+

App name used in config filenames (e.g., my_cli.config.json) + It could be an absolute path, we recommend always using the getter method

+
+
+
internal
+
+
+
+
+
+ +

mHomeDir

+
mHomeDir: string
+ +
+
+

Directory where global config files are located. Defaults to ~/.appName.

+
+
+
internal
+
+
+
+
+
+ +

mLayers

+
mLayers: IConfigLayer[]
+ +
+
+

List to store each of the config layers enumerated in layers enum

+
+
+
internal
+
+
+
+
+
+ +

mProjectDir

+
mProjectDir: string | false
+ +
+
+

Directory where project config files are located. Defaults to working directory.

+
+
+
internal
+
+
+
+
+
+ +

mSecure

+
mSecure: IConfigSecure
+ +
+
+

Secure properties object stored in credential vault

+
+
+
internal
+
+
+
+
+
+ +

mVault

+
mVault: IConfigVault
+ +
+
+

Vault object with methods for loading and saving secure credentials

+
+
+
internal
+
+
+
+
+
+ +

Optional opts

+ + +
+
+

Options to control how Config class behaves

+
+
+
+
+ +

Static Private Readonly END_OF_TEAM_CONFIG

+
END_OF_TEAM_CONFIG: ".config.json" = ".config.json"
+ +
+
+

The trailing portion of a shared config file name

+
+
+
+
+ +

Static Private Readonly END_OF_USER_CONFIG

+
END_OF_USER_CONFIG: ".config.user.json" = ".config.user.json"
+ +
+
+

The trailing portion of a user-specific config file name

+
+
+
+
+
+

Accessors

+
+ +

api

+ + +
+
+ +

appName

+
    +
  • get appName(): string
  • +
+ +
+
+ +

configName

+
    +
  • get configName(): string
  • +
+ +
+
+ +

exists

+
    +
  • get exists(): boolean
  • +
+ +
+
+ +

layers

+ + +
+
+ +

mProperties

+ +
    +
  • + +
    +
    +

    List of properties across all config layers. + Returns the original object, not a clone, so use with caution. + This is used in internal code because cloning a JSONC object is slow.

    +
    +
    +
    internal
    +
    +
    +
    +

    Returns IConfig

    +
  • +
+
+
+ +

maskedProperties

+
    +
  • get maskedProperties(): IConfig
  • +
+ +
+
+ +

paths

+
    +
  • get paths(): string[]
  • +
+ +
+
+ +

properties

+ + +
+
+ +

schemaName

+
    +
  • get schemaName(): string
  • +
+ +
+
+ +

userConfigName

+
    +
  • get userConfigName(): string
  • +
+ +
+
+
+

Methods

+
+ +

delete

+
    +
  • delete(propertyPath: string, opts?: { secure?: boolean }): void
  • +
+
    +
  • + +
    +
    +

    Unset value of a property in the active config layer.

    +
    +
    +

    Parameters

    +
      +
    • +
      propertyPath: string
      +
      +

      Property path

      +
      +
    • +
    • +
      Optional opts: { secure?: boolean }
      +
      +

      Include secure: false to preserve property in secure array

      +
      +
        +
      • +
        Optional secure?: boolean
        +
      • +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

findLayer

+
    +
  • findLayer(user: boolean, global: boolean): IConfigLayer
  • +
+
    +
  • + +
    +
    +

    Find the layer with the specified user and global properties.

    +
    +
    +
    internal
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      user: boolean
      +
      +

      True specifies that you want the user layer.

      +
      +
    • +
    • +
      global: boolean
      +
      +

      True specifies that you want the layer at the global level.

      +
      +
    • +
    +

    Returns IConfigLayer

    +

    The desired layer object. Null if no layer matches.

    +
  • +
+
+
+ +

formMainConfigPathNm

+
    +
  • formMainConfigPathNm(options: any): string
  • +
+
    +
  • + +
    +
    +

    Form the path name of the team config file to display in messages. + Always return the team name (not the user name). + If the a team configuration is active, return the full path to the + config file.

    +
    +
    +

    Parameters

    +
      +
    • +
      options: any
      +
      +

      a map containing option properties. Currently, the only + property supported is a boolean named addPath. + {addPath: true | false}

      +
      +
    • +
    +

    Returns string

    +

    The path (if requested) and file name of the team config file.

    +
  • +
+
+
+ +

getSchemaInfo

+ + +
+
+ +

layerActive

+ + +
+
+ +

layerExists

+
    +
  • layerExists(inDir: string, user?: boolean): boolean
  • +
+
    +
  • + +
    +
    +

    Check if a layer exists in the given path

    +
    +
    +

    Parameters

    +
      +
    • +
      inDir: string
      +
      +

      The directory to which you want to look for the layer.

      +
      +
    • +
    • +
      Optional user: boolean
      +
    • +
    +

    Returns boolean

    +
  • +
+
+
+ +

layerMerge

+ + +
+
+ +

Private layerPath

+
    +
  • layerPath(layer: Layers): string
  • +
+
    +
  • + +
    +
    +

    Get absolute file path for a config layer. + For project config files, We search up from our current directory and + ignore the Zowe hone directory (in case our current directory is under + Zowe home.). For golbal config files we only retrieve config files + from the Zowe home directory.

    +
    +
    +
    internal
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      layer: Layers
      +
      +

      Enum value for config layer

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

layerProfiles

+ + +
+
+ +

reload

+ +
    +
  • + +
    +
    +

    Reload config files from disk in the current project directory.

    +
    +
    +
    throws
    +

    An ImperativeError if the configuration does not load successfully

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional opts: IConfigOpts
      +
      +

      Options to control how Config class behaves

      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+ +

save

+
    +
  • save(allLayers?: boolean): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Save config files to disk and store secure properties in vault.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional allLayers: boolean
      +
      +

      Specify true to save all config layers instead of only the active one

      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+ +

set

+
    +
  • set(propertyPath: string, value: any, opts?: { parseString?: boolean; secure?: boolean }): void
  • +
+
    +
  • + +
    +
    +

    Set value of a property in the active config layer. + TODO: more validation

    +
    +
    +

    Parameters

    +
      +
    • +
      propertyPath: string
      +
      +

      Property path

      +
      +
    • +
    • +
      value: any
      +
      +

      Property value

      +
      +
    • +
    • +
      Optional opts: { parseString?: boolean; secure?: boolean }
      +
      +

      Optional parameters to change behavior

      +
        +
      • parseString - If true, strings will be converted to a more specific
                    type like boolean or number when possible
        +
        +
      • +
      • secure - If true, the property will be stored securely.
               If false, the property will be stored in plain text.
        +
        +
      • +
      +
      +
        +
      • +
        Optional parseString?: boolean
        +
      • +
      • +
        Optional secure?: boolean
        +
      • +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

setSchema

+
    +
  • setSchema(schema: string | object): void
  • +
+
    +
  • + +
    +
    +

    Set the $schema value at the top of the config JSONC. + Also save the schema to disk if an object is provided.

    +
    +
    +

    Parameters

    +
      +
    • +
      schema: string | object
      +
      +

      The URI of JSON schema, or a schema object to use

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static empty

+ + +
+
+ +

Static load

+ +
    +
  • + +
    +
    +

    Load config files from disk and secure properties from vault.

    +
    +
    +
    throws
    +

    An ImperativeError if the configuration does not load successfully

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      app: string
      +
      +

      App name used in config filenames (e.g., my_cli.config.json)

      +
      +
    • +
    • +
      Optional opts: IConfigOpts
      +
      +

      Options to control how Config class behaves

      +
      +
    • +
    +

    Returns Promise<Config>

    +
  • +
+
+
+ +

Static search

+
    +
  • search(file: string, opts?: { ignoreDirs?: string[]; startDir?: string }): string
  • +
+
    +
  • + +
    +
    +

    Search up the directory tree for the directory containing the + specified config file.

    +
    +
    +

    Parameters

    +
      +
    • +
      file: string
      +
      +

      Contains the name of the desired config file

      +
      +
    • +
    • +
      Optional opts: { ignoreDirs?: string[]; startDir?: string }
      +
        +
      • +
        Optional ignoreDirs?: string[]
        +
        +

        Contains an array of directory names to be + ignored (skipped) during the search.

        +
        +
      • +
      • +
        Optional startDir?: string
        +
        +

        Contains the name of the directory where the + search should be started. Defaults to working directory.

        +
        +
      • +
      +
    • +
    +

    Returns string

    +

    The full path name to config file or null if not found.

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configapi.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configapi.html new file mode 100644 index 0000000000..d1aab06dab --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configapi.html @@ -0,0 +1,291 @@ + + + + + + ConfigApi | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigApi

+
+
+
+
+
+
+
+
+
+

Base class from which all Config APIs are derived.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mConfig

+
mConfig: Config
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configautostore.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configautostore.html new file mode 100644 index 0000000000..c937557861 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configautostore.html @@ -0,0 +1,559 @@ + + + + + + ConfigAutoStore | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigAutoStore

+
+
+
+
+
+
+
+
+
+

Class to manage automatic storage of properties in team config.

+
+
+
+
+

Hierarchy

+
    +
  • + ConfigAutoStore +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static Private _fetchTokenForSessCfg

+ + +
+
+ +

Static Private _findActiveProfile

+ + +
+
+ +

Static Private _findAuthHandlerForProfile

+ + +
+
+ +

Static _storeSessCfgProps

+ + +
+
+ +

Static Private fetchTokenForSessCfg

+ +
    +
  • + +
    +
    +

    Retrieves token value that will be auto-stored into session config.

    +
    +
    +

    Parameters

    +
      +
    • +
      params: IHandlerParameters
      +
      +

      CLI handler parameters object

      +
      +
    • +
    • +
      sessCfg: {}
      +
      +

      Session config with credentials for basic or cert auth

      +
      +
        +
      • +
        [key: string]: any
        +
      • +
      +
    • +
    • +
      profilePath: string
      +
      +

      JSON path of profile containing tokenType

      +
      +
    • +
    +

    Returns Promise<boolean>

    +

    True if auth handler was found and token was fetched

    +
  • +
+
+
+ +

Static findActiveProfile

+
    +
  • findActiveProfile(params: IHandlerParameters, profileProps: string[]): [string, string] | undefined
  • +
+
    +
  • + +
    +
    +

    Finds the profile where auto-store properties should be saved.

    +
    +
    +

    Parameters

    +
      +
    • +
      params: IHandlerParameters
      +
      +

      CLI handler parameters object

      +
      +
    • +
    • +
      profileProps: string[]
      +
      +

      List of properties required in the profile schema

      +
      +
    • +
    +

    Returns [string, string] | undefined

    +

    Tuple containing profile type and name, or undefined if no profile was found

    +
  • +
+
+
+ +

Static findAuthHandlerForProfile

+ + +
+
+ +

Static storeSessCfgProps

+ +
    +
  • + +
    +
    +

    Stores session config properties into a team config profile.

    +
    +
    +

    Parameters

    +
      +
    • +
      params: IHandlerParameters
      +
      +

      CLI handler parameters object

      +
      +
    • +
    • +
      sessCfg: {}
      +
      +

      Session config containing properties to store

      +
      +
        +
      • +
        [key: string]: any
        +
      • +
      +
    • +
    • +
      propsToStore: string[]
      +
      +

      Names of properties that should be stored

      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configbuilder.html new file mode 100644 index 0000000000..ea51ff92b2 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configbuilder.html @@ -0,0 +1,411 @@ + + + + + + ConfigBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigBuilder

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ConfigBuilder +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static build

+ + +
+
+ +

Static buildDefaultProfile

+ + +
+
+ +

Static convert

+ +
    +
  • + +
    +
    +

    Convert existing v1 profiles to a Config object and report any conversion failures.

    +
    +
    +

    Parameters

    +
      +
    • +
      profilesRootDir: string
      +
      +

      Root directory where v1 profiles are stored.

      +
      +
    • +
    +

    Returns Promise<IConfigConvertResult>

    +

    Results object including new config and error details for profiles that failed to convert.

    +
  • +
+
+
+ +

Static Private convertPropNames

+ +
    +
  • + +
    +
    +

    Convert a set of known property names that have been renamed for + V2 conformance to their new names.

    +
    +
    +

    Parameters

    +
      +
    • +
      conversionResult: IConfigConvertResult
      +
      +

      The conversion result structure in which we shall + rename obsolete property names to their V2-compliant names.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static Private getDefaultValue

+
    +
  • getDefaultValue(propType: string | string[]): any
  • +
+
    +
  • + +
    +
    +

    Returns empty value that is appropriate for the property type.

    +
    +
    +

    Parameters

    +
      +
    • +
      propType: string | string[]
      +
      +

      The type of profile property

      +
      +
    • +
    +

    Returns any

    +

    Null or empty object

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configconstants.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configconstants.html new file mode 100644 index 0000000000..1e95efd31a --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configconstants.html @@ -0,0 +1,303 @@ + + + + + + ConfigConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigConstants

+
+
+
+
+
+
+
+
+
+

Constants related to team configuration

+
+
+
+
+

Hierarchy

+
    +
  • + ConfigConstants +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Static Readonly INDENT

+
INDENT: number = 4
+ +
+
+

Number of spaces used for indentation in config JSONC files

+
+
+
+
+ +

Static Readonly SECURE_ACCT

+
SECURE_ACCT: "secure_config_props" = "secure_config_props"
+ +
+
+

ID used for storing secure credentials in vault

+
+
+
+
+ +

Static Readonly SECURE_VALUE

+
SECURE_VALUE: "(secure value)" = "(secure value)"
+ +
+
+

A string used to hide the display of secure values

+
+
+
+
+ +

Static Readonly SKIP_PROMPT

+
SKIP_PROMPT: "- Press ENTER to skip: " = "- Press ENTER to skip: "
+ +
+
+

ID used for storing secure credentials in vault

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configlayers.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configlayers.html new file mode 100644 index 0000000000..4e9c5f9b2a --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configlayers.html @@ -0,0 +1,572 @@ + + + + + + ConfigLayers | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigLayers

+
+
+
+
+
+
+
+
+
+

API Class for manipulating config layers.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mConfig

+
mConfig: Config
+ +
+
+
+

Methods

+
+ +

activate

+
    +
  • activate(user: boolean, global: boolean, inDir?: string): void
  • +
+
    +
  • + +
    +
    +

    Select which layer is the currently active layer.

    +
    +
    +

    Parameters

    +
      +
    • +
      user: boolean
      +
      +

      True if you want the user layer.

      +
      +
    • +
    • +
      global: boolean
      +
      +

      True if you want the global layer.

      +
      +
    • +
    • +
      Optional inDir: string
      +
      +

      The directory to which you want to set the file path + for this layer.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

find

+
    +
  • find(profileName: string): { global: boolean; user: boolean }
  • +
+
    +
  • + +
    +
    +

    Finds the highest priority layer where a profile is stored.

    +
    +
    +

    Parameters

    +
      +
    • +
      profileName: string
      +
      +

      Profile name to search for

      +
      +
    • +
    +

    Returns { global: boolean; user: boolean }

    +

    User and global properties, or undefined if profile does not exist

    +
      +
    • +
      global: boolean
      +
    • +
    • +
      user: boolean
      +
    • +
    +
  • +
+
+
+ +

get

+ + +
+
+ +

merge

+ +
    +
  • + +
    +
    +

    Merge properties from the supplied Config object into the active layer. + If dryRun is specified, merge is applied to a copy of the layer and returned. + If dryRun is not specified, merge is applied directly to the layer and nothing is returned.

    +
    +
    +

    Parameters

    +
      +
    • +
      cnfg: IConfig
      +
      +

      The Config object to merge.

      +
      +
    • +
    • +
      Default value dryRun: boolean = false
      +
    • +
    +

    Returns void | IConfigLayer

    +

    The merged config layer or void

    +
  • +
+
+
+ +

read

+
    +
  • read(opts?: { global: boolean; user: boolean }): void
  • +
+
    +
  • + +
    +
    +

    Read a config layer from disk into memory for application use.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional opts: { global: boolean; user: boolean }
      +
      +

      The user and global flags that indicate which of the four + config files (aka layers) is to be read.

      +
      +
        +
      • +
        global: boolean
        +
      • +
      • +
        user: boolean
        +
      • +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

set

+ + +
+
+ +

write

+
    +
  • write(opts?: { global: boolean; user: boolean }): void
  • +
+
    +
  • + +
    +
    +

    Write a config layer to disk.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional opts: { global: boolean; user: boolean }
      +
      +

      The user and global flags that indicate which of the four + config files (aka layers) is to be written.

      +
      +
        +
      • +
        global: boolean
        +
      • +
      • +
        user: boolean
        +
      • +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited constructor
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configmanagementfacility.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configmanagementfacility.html new file mode 100644 index 0000000000..2d77ebfb4b --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configmanagementfacility.html @@ -0,0 +1,328 @@ + + + + + + ConfigManagementFacility | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigManagementFacility

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ConfigManagementFacility +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Private impLogger

+
impLogger: Logger = Logger.getImperativeLogger()
+ +
+
+

Used for internal imperative logging.

+
+
+
+
+ +

Static Private mInstance

+ + +
+
+
+

Accessors

+
+ +

Static instance

+ + +
+
+
+

Methods

+
+ +

init

+
    +
  • init(): void
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configplugins.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configplugins.html new file mode 100644 index 0000000000..022db5d05f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configplugins.html @@ -0,0 +1,313 @@ + + + + + + ConfigPlugins | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigPlugins

+
+
+
+
+
+
+
+
+
+

API Class for manipulating plugins.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mConfig

+
mConfig: Config
+ +
+
+
+

Methods

+
+ +

get

+
    +
  • get(): string[]
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited constructor
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configprofiles.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configprofiles.html new file mode 100644 index 0000000000..2f1d543eaa --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configprofiles.html @@ -0,0 +1,723 @@ + + + + + + ConfigProfiles | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigProfiles

+
+
+
+
+
+
+
+
+
+

API Class for manipulating config profiles.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mConfig

+
mConfig: Config
+ +
+
+
+

Methods

+
+ +

buildProfile

+
    +
  • buildProfile(path: string, profiles: {}): {}
  • +
+
    +
  • + +
    +
    +

    Build the set of properties contained within a set of nested profiles.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +
      +

      The dotted path of desired location.

      +
      +
    • +
    • +
      profiles: {}
      +
      +

      A set of nested profile objects.

      +
      + +
    • +
    +

    Returns {}

    +

    The desired profile object. An empty object if profiles is empty.

    +
      +
    • +
      [key: string]: string
      +
    • +
    +
  • +
+
+
+ +

defaultGet

+
    +
  • defaultGet(profileType: string): {}
  • +
+
    +
  • + +
    +
    +

    Get the profile contents for the default profile of the specified type + of profile within the currently active layer.

    +
    +
    +

    Parameters

    +
      +
    • +
      profileType: string
      +
      +

      The name of the desired type of profile (like zosmf).

      +
      +
    • +
    +

    Returns {}

    +

    An object containing the desired profile, + for example {"host": "lpar.your.domain.net", port: 1234}

    +
      +
    • +
      [key: string]: string
      +
    • +
    +
  • +
+
+
+ +

defaultSet

+
    +
  • defaultSet(profileType: string, value: string): void
  • +
+
    +
  • + +
    +
    +

    Set the default value for the specified type of profile within + the currently active layer.

    +
    +
    +

    Parameters

    +
      +
    • +
      profileType: string
      +
      +

      The name of the desired type of profile (like zosmf).

      +
      +
    • +
    • +
      value: string
      +
      +

      The dotted node path to the profile (like ca32.zosmf).

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

exists

+
    +
  • exists(path: string): boolean
  • +
+
    +
  • + +
    +
    +

    Reports whether or not a profile exists at the specified location.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +
      +

      The dotted path of desired location.

      +
      +
    • +
    +

    Returns boolean

    +

    True if a profile exists. False otherwise.

    +
  • +
+
+
+ +

expandPath

+
    +
  • expandPath(shortPath: string): string
  • +
+
    +
  • + +
    +
    +

    Expands a short path into an expanded path.

    +
    +
    +
    deprecated
    +

    Please use getProfilePathFromName

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      shortPath: string
      +
      +

      The short path.

      +
      +
    • +
    +

    Returns string

    +

    The expanded path.

    +
  • +
+
+
+ +

Private findProfile

+ +
    +
  • + +
    +
    +

    Find a profile at a specified location from within a set of + nested profiles.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +
      +

      The dotted path of desired location.

      +
      +
    • +
    • +
      profiles: {}
      +
      +

      A set of nested profile objects.

      +
      + +
    • +
    +

    Returns IConfigProfile

    +

    The profile object that was found. null if not found.

    +
  • +
+
+
+ +

get

+
    +
  • get(path: string, mustExist?: boolean): {}
  • +
+
    +
  • + +
    +
    +

    Get the profile object located at the specified location.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +
      +

      The dotted path of the location at which to set the profile.

      +
      +
    • +
    • +
      Optional mustExist: boolean
      +
      +

      If false, outer layer profile values will still be + returned when the dotted path does not exist. Default is true.

      +
      +
    • +
    +

    Returns {}

    +
      +
    • +
      [key: string]: string
      +
    • +
    +
  • +
+
+
+ +

getProfileNameFromPath

+
    +
  • getProfileNameFromPath(path: string): string
  • +
+
    +
  • + +
    +
    +

    Obtain the profile name (either nested or not) based on a property path.

    +
    +
    +
    note
    +

    This may be useful for supporting token authentication in a nested configuration

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +
      +

      The property path.

      +
      +
    • +
    +

    Returns string

    +

    The corresponding profile name.

    +
  • +
+
+
+ +

getProfilePathFromName

+
    +
  • getProfilePathFromName(shortPath: string): string
  • +
+ +
+
+ +

set

+ +
    +
  • + +
    +
    +

    Set a profile object at the location identified by the path + within the currently active layer.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +
      +

      The dotted path of the location in which to set the profile.

      +
      +
    • +
    • +
      profile: IConfigProfile
      +
      +

      The JSON profile object to set into the specified location,

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited constructor
  • +
+
    +
  • Private method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configschema.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configschema.html new file mode 100644 index 0000000000..1c77a665bf --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configschema.html @@ -0,0 +1,761 @@ + + + + + + ConfigSchema | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigSchema

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ConfigSchema +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Private Readonly JSON_SCHEMA

+
JSON_SCHEMA: "https://json-schema.org/draft/2020-12/schema" = "https://json-schema.org/draft/2020-12/schema"
+ +
+
+

JSON schema URI stored in $schema property of the schema

+
+
+
readonly
+
+
memberof
+

ConfigSchema

+
+
+
+
+
+ +

Static Private Readonly SCHEMA_VERSION

+
SCHEMA_VERSION: "1.0" = "1.0"
+ +
+
+

Version number stored in $version property of the schema

+
+
+
readonly
+
+
memberof
+

ConfigSchema

+
+
+
+
+
+
+

Methods

+
+ +

Static Private _updateSchemaActive

+ +
    +
  • + +
    +
    +

    HELPER function for updating the active layer's schema files + This operation is divided in 2 steps:

    +
      +
    1. Update the schema file corresponding to the active layer
    2. +
    3. Update the opposite (user/non-user) layer if it exists
    4. +
    +
    +
    +

    Parameters

    +
      +
    • +
      opts: IConfigUpdateSchemaHelperOptions
      +
      +

      The various properties needed to accomplish a recursive UpdateSchema operation

      +
      +
    • +
    • +
      Default value forceSetSchema: boolean = false
      +
      +

      Indicates if we should force the creation of the schema file even if the config doesn't exist (e.g. config init)

      +
      +
    • +
    • +
      Default value checkContrastingLayer: boolean = true
      +
      +

      Indicates if we should check for the opposite (user/non-user) layer

      +
      +
    • +
    +

    Returns IConfigUpdateSchemaPaths

    +

    Object containing the updated schema paths

    +
  • +
+
+
+ +

Static Private _updateSchemaAll

+ +
    +
  • + +
    +
    +

    HELPER function for recursively updating schema files + This operation is divided in 3 steps:

    +
      +
    1. Traverse UP the directory structure while updating the corresponding schema files
    2. +
    3. Update both (User and Non-User) Global configuration's schema files
    4. +
    5. Traverse DOWN the directory structure based on the depth specified
    6. +
    +
    +
    +

    Parameters

    + +

    Returns IConfigUpdateSchemaPaths

    +

    Object containing the updated schema paths

    +
  • +
+
+
+ +

Static Private _updateSchemaGlobal

+ + +
+
+ +

Static buildSchema

+ + +
+
+ +

Static findPropertyType

+ +
    +
  • + +
    +
    +

    Find the type of a property based on schema info.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +
      +

      Path to JSON property in config JSON

      +
      +
    • +
    • +
      config: IConfig
      +
      +

      Team config properties

      +
      +
    • +
    • +
      Optional schema: IConfigSchema
      +
      +

      Config schema definition. Defaults to profile schemas defined in Imperative config.

      +
      +
    • +
    +

    Returns string | undefined

    +
  • +
+
+
+ +

Static Private generateSchema

+ +
    +
  • + +
    +
    +

    Transform an Imperative profile schema to a JSON schema. Removes any + non-JSON-schema properties and translates anything useful.

    +
    +
    +

    Parameters

    + +

    Returns any

    +

    JSON schema for profile properties

    +
  • +
+
+
+ +

Static loadSchema

+ + +
+
+ +

Static parseSchema

+ + +
+
+ +

Static updateSchema

+ + +
+
+
+

Object literals

+
+ +

Static Private Readonly explainSchemaSummary

+
explainSchemaSummary: object
+ +
+
+

Pretty explanation of the schema objects

+
+
+
readonly
+
+
memberof
+

ConfigSchema

+
+
+
+
+ +

$schema

+
$schema: string = "URL"
+ +
+
+ +

$version

+
$version: string = "Version"
+ +
+
+ +

explainedParentKey

+
explainedParentKey: string = "Schema"
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+ +

properties

+
properties: object
+ +
+ +

defaults

+
defaults: string = "Default Definitions"
+ +
+
+ +

explainedParentKey

+
explainedParentKey: string = "Properties"
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configsecure.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configsecure.html new file mode 100644 index 0000000000..6fb188d27a --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configsecure.html @@ -0,0 +1,780 @@ + + + + + + ConfigSecure | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigSecure

+
+
+
+
+
+
+
+
+
+

API Class for manipulating config layers.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mConfig

+
mConfig: Config
+ +
+
+ +

Private mLoadFailed

+
mLoadFailed: boolean
+ +
+
+
+

Accessors

+
+ +

loadFailed

+
    +
  • get loadFailed(): boolean
  • +
+ +
+
+
+

Methods

+
+ +

cacheAndPrune

+
    +
  • cacheAndPrune(opts?: { global: boolean; properties?: IConfig; user: boolean }): void
  • +
+
    +
  • + +
    +
    +

    Copy secure config properties from the specified layer into cached + secure properties. To save secure config properties directly to the + vault, use the asynchronous method save instead.

    +
    +

    Warning: Do not pass an IConfigLayer object into this method unless + you want its properties to be edited.

    +
    +
    internal
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional opts: { global: boolean; properties?: IConfig; user: boolean }
      +
      +

      The user and global flags that specify one of the four + config files (aka layers).

      +
      +
        +
      • +
        global: boolean
        +
      • +
      • +
        Optional properties?: IConfig
        +
        +

        IConfig object cloned from the specified layer. + If specified, secure properties will be removed.

        +
        +
      • +
      • +
        user: boolean
        +
      • +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

directSave

+ + +
+
+ +

findSecure

+
    +
  • findSecure(profiles: {}, path: string): string[]
  • +
+
    +
  • + +
    +
    +

    Recursively find secure property paths inside a team config + "profiles" object.

    +
    +
    +
    internal
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      profiles: {}
      +
      +

      The "profiles" object that is present at the top level + of team config files, and may also be present at lower + levels.

      +
      + +
    • +
    • +
      path: string
      +
      +

      The JSON path to the "profiles" object

      +
      +
    • +
    +

    Returns string[]

    +

    Array of secure property paths

    +
  • +
+
+
+ +

load

+ +
    +
  • + +
    +
    +

    Load the secure application properties from secure storage using the + specified vault interface. The vault interface is placed into our + Config object. The secure values are placed into our Config layers.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional vault: IConfigVault
      +
      +

      Interface for loading and saving to secure storage.

      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+ +

loadCached

+
    +
  • loadCached(opts?: { global: boolean; user: boolean }): void
  • +
+
    +
  • + +
    +
    +

    Copy secure config properties from cached secure properties into the + specified layer. To load secure config properties directly from the + vault, use the asynchronous method load instead.

    +
    +
    +
    internal
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional opts: { global: boolean; user: boolean }
      +
      +

      The user and global flags that specify one of the four + config files (aka layers).

      +
      +
        +
      • +
        global: boolean
        +
      • +
      • +
        user: boolean
        +
      • +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

rmUnusedProps

+
    +
  • rmUnusedProps(): string[]
  • +
+ +
+
+ +

save

+
    +
  • save(allLayers?: boolean): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Save the secure application properties into secure storage using + the vault interface from our config object.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional allLayers: boolean
      +
      +

      Specify true to save all config layers instead of only the active one

      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+ +

secureFields

+
    +
  • secureFields(opts?: { global: boolean; user: boolean }): string[]
  • +
+
    +
  • + +
    +
    +

    List full paths of all secure properties found in a team config file.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional opts: { global: boolean; user: boolean }
      +
      +

      The user and global flags that specify one of the four + config files (aka layers).

      +
      +
        +
      • +
        global: boolean
        +
      • +
      • +
        user: boolean
        +
      • +
      +
    • +
    +

    Returns string[]

    +

    Array of secure property paths + (e.g., "profiles.lpar1.properties.password")

    +
  • +
+
+
+ +

secureInfoForProp

+
    +
  • secureInfoForProp(propertyPath: string, findUp?: boolean): { path: string; prop: string }
  • +
+
    +
  • + +
    +
    +

    Retrieve info that can be used to store a profile property securely.

    +
    +

    For example, to securely store "profiles.lpar1.properties.password", the + name "password" would be stored in "profiles.lpar1.secure".

    +
    +
    internal
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      propertyPath: string
      +
      +

      The full path of the profile property

      +
      +
    • +
    • +
      Optional findUp: boolean
      +
      +

      Specify true to search up in the config file for higher level secure arrays

      +
      +
    • +
    +

    Returns { path: string; prop: string }

    +

    Object with the following attributes:

    +
      +
    • path The JSON path of the secure array
    • +
    • prop The name of the property
    • +
    +
      +
    • +
      path: string
      +
    • +
    • +
      prop: string
      +
    • +
    +
  • +
+
+
+ +

securePropsForProfile

+
    +
  • securePropsForProfile(profileName: string): string[]
  • +
+
    +
  • + +
    +
    +

    List names of secure properties for a profile. They may be defined at + the profile's level, or at a higher level if the config is nested.

    +
    +
    +

    Parameters

    +
      +
    • +
      profileName: string
      +
      +

      Profile name to search for

      +
      +
    • +
    +

    Returns string[]

    +

    Array of secure property names

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited constructor
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configurationloader.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configurationloader.html new file mode 100644 index 0000000000..6b6e1b092c --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configurationloader.html @@ -0,0 +1,286 @@ + + + + + + ConfigurationLoader | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigurationLoader

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ConfigurationLoader +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static load

+ +
    +
  • + +
    +
    +

    Parameters

    +
      +
    • +
      providedConfig: IImperativeConfig
      +
      +

      the configuration provided through the "init" + Imperative API. Pass undefined if no config specified

      +
      +
    • +
    • +
      packageJson: any
      +
      +

      caller's full package.json contents as an object. Used if + providedConfig is undefined.

      +
      +
    • +
    • +
      callerFileRequirer: (file: string) => any
      +
      +

      function that, when provided a string, + returns the require()d contents of a file relative + to where the caller initialized from

      +
      +
        +
      • +
          +
        • (file: string): any
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            file: string
            +
          • +
          +

          Returns any

          +
        • +
        +
      • +
      +
    • +
    +

    Returns IImperativeConfig

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configurationvalidator.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configurationvalidator.html new file mode 100644 index 0000000000..e97cf90bd3 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configurationvalidator.html @@ -0,0 +1,315 @@ + + + + + + ConfigurationValidator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigurationValidator

+
+
+
+
+
+
+
+
+
+

Imperative-internal class to validate configuration + You should not need to call this from your CLI.

+
+
+
+
+

Hierarchy

+
    +
  • + ConfigurationValidator +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static validate

+ + +
+
+ +

Static Private verifyChalkColor

+
    +
  • verifyChalkColor(config: any, colorProperty: string, colorPropertyDescriptiveName: string): void
  • +
+
    +
  • + +
    +
    +

    Private utility to validate a consumer's chalk color setting

    +
    +
    +

    Parameters

    +
      +
    • +
      config: any
      +
      +

      the config object from the consumer

      +
      +
    • +
    • +
      colorProperty: string
      +
      +

      the property of the config object

      +
      +
    • +
    • +
      colorPropertyDescriptiveName: string
      +
      +

      the display name of the color you're validating

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.configutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.configutils.html new file mode 100644 index 0000000000..0cfd871d64 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.configutils.html @@ -0,0 +1,389 @@ + + + + + + ConfigUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConfigUtils

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ConfigUtils +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static coercePropValue

+
    +
  • coercePropValue(value: any, type?: string): any
  • +
+
    +
  • + +
    +
    +

    Coeerces string property value to a boolean or number type.

    +
    +
    +

    Parameters

    +
      +
    • +
      value: any
      +
      +

      String value

      +
      +
    • +
    • +
      Optional type: string
      +
      +

      Property type defined in the schema

      +
      +
    • +
    +

    Returns any

    +

    Boolean, number, or string

    +
  • +
+
+
+ +

Static getActiveProfileName

+
    +
  • getActiveProfileName(profileType: string, cmdArguments?: ICommandArguments, defaultProfileName?: string): string
  • +
+
    +
  • + +
    +
    +

    Retrieves the name of the active profile for the given type. If no such + profile exists, returns the default name which can be used to create a new profile.

    +
    +
    +

    Parameters

    +
      +
    • +
      profileType: string
      +
      +

      The type of CLI profile

      +
      +
    • +
    • +
      Optional cmdArguments: ICommandArguments
      +
      +

      CLI arguments which may specify a profile

      +
      +
    • +
    • +
      Optional defaultProfileName: string
      +
      +

      Name to fall back to if profile doesn't exist. If + not specified, the profile type will be used.

      +
      +
    • +
    +

    Returns string

    +

    The profile name

    +
  • +
+
+
+ +

Static jsonPathMatches

+
    +
  • jsonPathMatches(fullPath: string, partialPath: string): boolean
  • +
+
    +
  • + +
    +
    +

    Checks if partial path is equal to or nested inside full path

    +
    +
    +

    Parameters

    +
      +
    • +
      fullPath: string
      +
      +

      JSON path to profile 1

      +
      +
    • +
    • +
      partialPath: string
      +
      +

      JSON path to profile 2

      +
      +
    • +
    +

    Returns boolean

    +
  • +
+
+
+ +

Static secureSaveError

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.connectionpropsforsesscfg.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.connectionpropsforsesscfg.html new file mode 100644 index 0000000000..dbe76e7a46 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.connectionpropsforsesscfg.html @@ -0,0 +1,844 @@ + + + + + + ConnectionPropsForSessCfg | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConnectionPropsForSessCfg

+
+
+
+
+
+
+
+
+
+

This class adds connection information to an existing session configuration + object for making REST API calls with the Imperative RestClient.

+
+
+
+
+

Hierarchy

+
    +
  • + ConnectionPropsForSessCfg +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Private secureSessCfgProps

+
secureSessCfgProps: Set<string> = new Set(["user", "password", "tokenValue", "passphrase"])
+ +
+
+

List of properties on sessCfg object that should be kept secret and + may not appear in Imperative log files.

+
+

NOTE(Kelosky): redundant from LoggerUtils.SECURE_PROMPT_OPTIONS - leaving + for future date to consolidate

+
+
+
+
+

Methods

+
+ +

Static addPropsOrPrompt

+ +
    +
  • + +
    +
    +

    Create a REST session configuration object starting with the supplied + initialSessCfg and retrieving connection properties from the command + line arguments (or environment, or profile). If required connection + properties are missing we interactively prompt the user for the values. + for any of the following properties: + host + port + user name + password

    +
    +

    Any prompt will timeout after 30 seconds so that this function can + be run from an automated script, and will not indefinitely hang that + script.

    +

    In addition to properties that we prompt for, we will also add the following + properties to the session configuration if they are available. + type + tokenType + tokenValue

    +
    +
    example
    +
     // Within the process() function of a command handler,
    + // do steps similar to the following:
    + const sessCfg: ISession =  {
    +     rejectUnauthorized: commandParameters.arguments.rejectUnauthorized,
    +     basePath: commandParameters.arguments.basePath
    + };
    + const connectableSessCfg = await ConnectionPropsForSessCfg.addPropsOrPrompt<ISession>(
    +      sessCfg, commandParameters.arguments
    + );
    + mySession = new Session(connectableSessCfg);
    +
    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      initialSessCfg: SessCfgType
      +
      +
         An initial session configuration (like ISession, or other
      +   specially defined configuration) that contains your desired
      +   session configuration properties.
      +
      +
      +
    • +
    • +
      cmdArgs: ICommandArguments
      +
      +
         The arguments specified by the user on the command line
      +   (or in environment, or in profile). The contents of the
      +   supplied cmdArgs will be modified.
      +
      +
      +
    • +
    • +
      Default value connOpts: IOptionsForAddConnProps = {}
      +
      +
         Options that alter our connection actions. See IOptionsForAddConnProps.
      +   The connOpts parameter need not be supplied.
      +
      +
      +
    • +
    +

    Returns Promise<SessCfgType>

    +

    A session configuration object with connection information + added to the initialSessCfg. Its intended use is for our + caller to create a session for a REST Client.

    +
  • +
+
+
+ +

Static Private clientPrompt

+
    +
  • clientPrompt(promptText: string, opts: IHandlePromptOptions): Promise<string>
  • +
+ +
+
+ +

Static Private getValuesBack

+ +
    +
  • + +
    +
    +

    Prompts the user to input session config values in a CLI environment. + This is the default implementation of the getValuesBack callback when + connOpts.doPrompting is true.

    +
    +
    +

    Parameters

    + +

    Returns (properties: string[]) => Promise<{}>

    +

    Name-value pairs of connection properties

    +
      +
    • +
        +
      • (properties: string[]): Promise<{}>
      • +
      +
        +
      • +

        Parameters

        +
          +
        • +
          properties: string[]
          +
        • +
        +

        Returns Promise<{}>

        +
      • +
      +
    • +
    +
  • +
+
+
+ +

Static Private loadSchemaForSessCfgProps

+
    +
  • loadSchemaForSessCfgProps(params: IHandlerParameters | undefined, promptForValues: string[]): {}
  • +
+ +
+
+ +

Static Private loadSecureSessCfgProps

+
    +
  • loadSecureSessCfgProps(params: IHandlerParameters | undefined, promptForValues: string[]): void
  • +
+ +
+
+ +

Static Private logSessCfg

+
    +
  • logSessCfg(sessCfg: any): void
  • +
+ +
+
+ +

Static Private propHasValue

+
    +
  • propHasValue(propToTest: any): boolean
  • +
+ +
+
+ +

Static resolveSessCfgProps

+ +
    +
  • + +
    +
    +

    Resolve the overlapping or mutually exclusive properties that can + occur. Ensure that the resulting session configuration object contains + only the applicable properties. The contents of the supplied sessCfg, + cmdArgs, and connOpts will be modified.

    +
    +
    +
    example
    +
     let sessCfg = YouCollectAllProfilePropertiesRelatedToSession();
    + let cmdArgs = YouSetPropertiesRequiredInCmdArgs();
    + ConnectionPropsForSessCfg.resolveSessCfgProps(sessCfg, cmdArgs);
    + sessionToUse = new Session(sessCfg);
    +
    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      sessCfg: SessCfgType
      +
      +
       An initial session configuration that contains your desired
      + session configuration properties.
      +
      +
      +
    • +
    • +
      Default value cmdArgs: ICommandArguments = { $0: "", _: [] }
      +
      +
       The arguments specified by the user on the command line
      + (or in environment, or in profile)
      +
      +
      +
    • +
    • +
      Default value connOpts: IOptionsForAddConnProps = {}
      +
      +
       Options that alter our actions. See IOptionsForAddConnProps.
      + The connOpts parameter need not be supplied.
      + The only option values used by this function are:
      +     connOpts.requestToken
      +     connOpts.defaultTokenType
      +
      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static sessHasCreds

+
    +
  • sessHasCreds(sessToTest: ISession): string | false | true
  • +
+ +
+
+ +

Static Private setTypeForTokenRequest

+
    +
  • setTypeForTokenRequest(sessCfg: any, options: IOptionsForAddConnProps, tokenType: SessConstants.TOKEN_TYPE_CHOICES): void
  • +
+
    +
  • + +
    +
    +

    Determine if we want to request a token. + Set the session's type and tokenType accordingly.

    +
    +
    +

    Parameters

    +
      +
    • +
      sessCfg: any
      +
      +
        The session configuration to be updated.
      +
      +
      +
    • +
    • +
      options: IOptionsForAddConnProps
      +
      +
        Options that alter our actions. See IOptionsForAddConnProps.
      +
      +
      +
    • +
    • +
      tokenType: SessConstants.TOKEN_TYPE_CHOICES
      +
      +
        The type of token that we expect to receive.
      +
      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+

Object literals

+
+ +

Static Private Readonly promptTextForValues

+
promptTextForValues: object
+ +
+
+

List of prompt messages that is used when the CLI prompts for session + config values.

+
+
+
+ +

hostname

+
hostname: string = "Enter the host name of"
+ +
+
+ +

password

+
password: string = "Enter the password for"
+ +
+
+ +

port

+
port: string = "Enter the port number of"
+ +
+
+ +

user

+
user: string = "Enter the user name for"
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.console.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.console.html new file mode 100644 index 0000000000..28448e363d --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.console.html @@ -0,0 +1,1137 @@ + + + + + + Console | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Console

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Console +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new Console(mLevel?: string): Console
  • +
+ +
+
+
+

Properties

+
+ +

Private mColor

+
mColor: boolean
+ +
+
+ +

Private mIsOn

+
mIsOn: boolean
+ +
+
+ +

Private mLevel

+
mLevel: string
+ +
+
+ +

Private mPrefix

+
mPrefix: boolean
+ +
+
+ +

Static Readonly LEVELS

+
LEVELS: string[] = ["trace", "debug", "info", "warn", "error", "fatal", "off"]
+ +
+
+ +

Static Readonly LEVEL_DEFAULT

+
LEVEL_DEFAULT: "warn" = "warn"
+ +
+
+
+

Accessors

+
+ +

color

+
    +
  • get color(): boolean
  • +
  • set color(isEnabled: boolean): void
  • +
+ +
+
+ +

level

+
    +
  • get level(): string
  • +
  • set level(level: string): void
  • +
+ +
+
+ +

on

+
    +
  • get on(): boolean
  • +
  • set on(isOn: boolean): void
  • +
+ +
+
+ +

prefix

+
    +
  • get prefix(): boolean
  • +
  • set prefix(isEnabled: boolean): void
  • +
+ +
+
+
+

Methods

+
+ +

addContext

+
    +
  • addContext(key: string, value: any): void
  • +
+ +
+
+ +

Private buildPrefix

+
    +
  • buildPrefix(type: string): string
  • +
+ +
+
+ +

clearContext

+
    +
  • clearContext(): void
  • +
+ +
+
+ +

debug

+
    +
  • debug(message: any, ...args: any[]): string
  • +
+ +
+
+ +

error

+
    +
  • error(message: any, ...args: any[]): string
  • +
+ +
+
+ +

fatal

+
    +
  • fatal(message: any, ...args: any[]): string
  • +
+ +
+
+ +

Private format

+
    +
  • format(data: string, ...args: any[]): string
  • +
+ +
+
+ +

info

+
    +
  • info(message: any, ...args: any[]): string
  • +
+ +
+
+ +

isDebugEnabled

+
    +
  • isDebugEnabled(): boolean
  • +
+ +
+
+ +

isErrorEnabled

+
    +
  • isErrorEnabled(): boolean
  • +
+ +
+
+ +

isFatalEnabled

+
    +
  • isFatalEnabled(): boolean
  • +
+ +
+
+ +

isFormatEnabled

+
    +
  • isFormatEnabled(): boolean
  • +
+ +
+
+ +

isInfoEnabled

+
    +
  • isInfoEnabled(): boolean
  • +
+ +
+
+ +

isLevelEnabled

+
    +
  • isLevelEnabled(): boolean
  • +
+ +
+
+ +

isTraceEnabled

+
    +
  • isTraceEnabled(): boolean
  • +
+ +
+
+ +

isWarnEnabled

+
    +
  • isWarnEnabled(): boolean
  • +
+ +
+
+ +

removeContext

+
    +
  • removeContext(key: string): void
  • +
+ +
+
+ +

trace

+
    +
  • trace(message: any, ...args: any[]): string
  • +
+ +
+
+ +

warn

+
    +
  • warn(message: any, ...args: any[]): string
  • +
+ +
+
+ +

Private writeStderr

+
    +
  • writeStderr(message: string, ...args: any[]): string
  • +
+ +
+
+ +

Private writeStdout

+
    +
  • writeStdout(message: string, ...args: any[]): string
  • +
+ +
+
+ +

Static getConsole

+
    +
  • getConsole(category: string): Console
  • +
+ +
+
+ +

Static isValidLevel

+
    +
  • isValidLevel(level: string): boolean
  • +
+ +
+
+ +

Static validateLevel

+
    +
  • validateLevel(level: string): void
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
  • Accessor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.constants.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.constants.html new file mode 100644 index 0000000000..0e2b7c078f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.constants.html @@ -0,0 +1,1141 @@ + + + + + + Constants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Constants

+
+
+
+
+
+
+
+
+
+

Imperative constants

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + Constants +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly AUTH_GROUP

+
AUTH_GROUP: "auth" = "auth"
+ +
+
+

Auth group constants

+
+
+
+
+ +

Static Readonly AUTO_INIT_ACTION

+
AUTO_INIT_ACTION: "auto-init" = "auto-init"
+ +
+
+

Auto Init constants

+
+
+
+
+ +

Static Readonly COMMAND_PROF_TYPE_PROPS

+
COMMAND_PROF_TYPE_PROPS: string[] = ["optionDefinition", "optionDefinitions", "includeInTemplate"]
+ +
+
+

ICommandProfileTypeConfiguration properties + (used to omit from schemas registered via ProfileInfo)

+
+
+
+
+ +

Static Readonly COMMAND_SEGMENT

+
COMMAND_SEGMENT: string = "[command]"
+ +
+
+

Syntax diagram

+
+
+
+
+ +

Static Readonly CREATE_ACTION

+
CREATE_ACTION: "create" = "create"
+ +
+
+

Create profile constants

+
+
+
+
+ +

Static Readonly DEFAULT_EXPERIMENTAL_COMMAND_EXPLANATION

+
DEFAULT_EXPERIMENTAL_COMMAND_EXPLANATION: string = "Experimental commands are commands that are not ready for general availability. If you " +"decide to use these commands, you might encounter bugs, incompatibilities with your system, " +"or incomplete help text. "
+ +
+
+

Explanation of experimental features to be used in various places around the CLI

+
+
+
+
+ +

Static Readonly DEFAULT_HIGHLIGHT_COLOR

+
DEFAULT_HIGHLIGHT_COLOR: "yellow" = "yellow"
+ +
+
+ +

Static Readonly DEFAULT_LIST_GROUP

+
DEFAULT_LIST_GROUP: "list" = "list"
+ +
+
+ +

Static Readonly DEFAULT_LIST_PROFILE_OBJECT

+
DEFAULT_LIST_PROFILE_OBJECT: "loaded-profiles" = "loaded-profiles"
+ +
+
+ +

Static Readonly DEFAULT_LIST_PROFILE_OBJECT_ALIAS

+
DEFAULT_LIST_PROFILE_OBJECT_ALIAS: "lbp" = "lbp"
+ +
+
+ +

Static Readonly DEFAULT_MASK_OUTPUT

+
DEFAULT_MASK_OUTPUT: "TRUE" = "TRUE"
+ +
+
+ +

Static Readonly DEFAULT_PROMPT_PHRASE

+
DEFAULT_PROMPT_PHRASE: "PROMPT*" = "PROMPT*"
+ +
+
+ +

Static Readonly DEFAULT_SET_GROUP

+
DEFAULT_SET_GROUP: "set" = "set"
+ +
+
+ +

Static Readonly DEFAULT_SET_PROFILE_OBJECT

+
DEFAULT_SET_PROFILE_OBJECT: "default-profiles" = "default-profiles"
+ +
+
+ +

Static Readonly DEFAULT_SET_PROFILE_OBJECT_ALIAS

+
DEFAULT_SET_PROFILE_OBJECT_ALIAS: "dbp" = "dbp"
+ +
+
+ +

Static Readonly DELETE_ACTION

+
DELETE_ACTION: "delete" = "delete"
+ +
+
+ +

Static Readonly DETAILS_ACTION

+
DETAILS_ACTION: "detail" = "detail"
+ +
+
+ +

Static Readonly DISABLE_DEFAULTS_OPTION

+
DISABLE_DEFAULTS_OPTION: "disable-defaults" = "disable-defaults"
+ +
+
+ +

Static Readonly ERROR_EXIT_CODE

+
ERROR_EXIT_CODE: number = 1
+ +
+
+ +

Static Readonly FRAMEWORK_DISPLAY_NAME

+
FRAMEWORK_DISPLAY_NAME: string = "Imperative"
+ +
+
+ +

Static GLOBAL_GROUP

+
GLOBAL_GROUP: string = "Global Options"
+ +
+
+ +

Static Readonly GROUP_SEGMENT

+
GROUP_SEGMENT: string = "[group]"
+ +
+
+ +

Static Readonly GROUP_SEGMENT_NUMBER

+
GROUP_SEGMENT_NUMBER: number = 2
+ +
+
+ +

Static Readonly HELP_EXAMPLES

+
HELP_EXAMPLES: "help-examples" = "help-examples"
+ +
+
+ +

Static Readonly HELP_OPTION

+
HELP_OPTION: "help" = "help"
+ +
+
+ +

Static Readonly HELP_OPTION_ALIAS

+
HELP_OPTION_ALIAS: "h" = "h"
+ +
+
+ +

Static Readonly HELP_WEB_OPTION

+
HELP_WEB_OPTION: "help-web" = "help-web"
+ +
+
+ +

Static Readonly HELP_WEB_OPTION_ALIAS

+
HELP_WEB_OPTION_ALIAS: "hw" = "hw"
+ +
+
+ +

Static Readonly IMPERATIVE_DEFAULT_HOME

+
IMPERATIVE_DEFAULT_HOME: string = "IMPERATIVE_HOME"
+ +
+
+ +

Static Readonly IMPERATIVE_DIRECTORY

+
IMPERATIVE_DIRECTORY: string = ".imperative"
+ +
+
+ +

Static Readonly JSON_OPTION

+
JSON_OPTION: "response-format-json" = "response-format-json"
+ +
+
+ +

Static Readonly JSON_OPTION_ALIAS

+
JSON_OPTION_ALIAS: "rfj" = "rfj"
+ +
+
+ +

Static Readonly LIST_ACTION

+
LIST_ACTION: "list" = "list"
+ +
+
+ +

Static Readonly LOGIN_ACTION

+
LOGIN_ACTION: "login" = "login"
+ +
+
+ +

Static Readonly LOGIN_ACTION_ALIAS

+
LOGIN_ACTION_ALIAS: "li" = "li"
+ +
+
+ +

Static Readonly LOGOUT_ACTION

+
LOGOUT_ACTION: "logout" = "logout"
+ +
+
+ +

Static Readonly LOGOUT_ACTION_ALIAS

+
LOGOUT_ACTION_ALIAS: "lo" = "lo"
+ +
+
+ +

Static Readonly OPTIONS_SEGMENT

+
OPTIONS_SEGMENT: string = "[options]"
+ +
+
+ +

Static Readonly OPT_LONG_DASH

+
OPT_LONG_DASH: "--" = "--"
+ +
+
+ +

Static Readonly OPT_SHORT_DASH

+
OPT_SHORT_DASH: "-" = "-"
+ +
+
+ +

Static Readonly OVERWRITE_OPTION

+
OVERWRITE_OPTION: "overwrite" = "overwrite"
+ +
+
+ +

Static Readonly PRIMARY_COMMAND

+
PRIMARY_COMMAND: string = "imperative"
+ +
+
+ +

Static Readonly PRIMARY_SEGMENT_NUMBER

+
PRIMARY_SEGMENT_NUMBER: number = 1
+ +
+
+

Segments

+
+
+
+
+ +

Static Readonly PROFILES_DIR

+
PROFILES_DIR: string = "/profiles"
+ +
+
+ +

Static Readonly PROFILE_ALIASES

+
PROFILE_ALIASES: string[] = ["profile", "pr"]
+ +
+
+ +

Static Readonly PROFILE_DELETE_PROFILE_DEPS

+
PROFILE_DELETE_PROFILE_DEPS: "delete-dependent-profiles" = "delete-dependent-profiles"
+ +
+
+ +

Static Readonly PROFILE_DELETE_PROFILE_DEPS_ALIAS

+
PROFILE_DELETE_PROFILE_DEPS_ALIAS: "ddp" = "ddp"
+ +
+
+ +

Static Readonly PROFILE_GROUP

+
PROFILE_GROUP: "profiles" = "profiles"
+ +
+
+ +

Static Readonly PROFILE_NAME_OPTION

+
PROFILE_NAME_OPTION: "profileName" = "profileName"
+ +
+
+ +

Static Readonly PROFILE_NAME_OPTION_ALIAS

+
PROFILE_NAME_OPTION_ALIAS: "pn" = "pn"
+ +
+
+ +

Static Readonly PROFILE_OBJECT

+
PROFILE_OBJECT: "profile" = "profile"
+ +
+
+ +

Static Readonly PROFILE_SET_OPTION_ALIAS

+
PROFILE_SET_OPTION_ALIAS: "{{typeLetter}}n" = `{{typeLetter}}n`
+ +
+
+ +

Static Readonly SET_ACTION

+
SET_ACTION: "set-default" = "set-default"
+ +
+
+ +

Static Readonly SHOW_DEPS_ACTION

+
SHOW_DEPS_ACTION: "show-dependencies" = "show-dependencies"
+ +
+
+ +

Static Readonly STDIN_CONTENT_KEY

+
STDIN_CONTENT_KEY: string = "stdin-content"
+ +
+
+

If you use the stdin option, you will be able to access the contents buffer + through this key on your Arguments object in your command

+
+
+
+
+ +

Static Readonly STDIN_DEFAULT_DESCRIPTION

+
STDIN_DEFAULT_DESCRIPTION: "Pipe data into this command via stdin" = "Pipe data into this command via stdin"
+ +
+
+ +

Static Readonly STDIN_OPTION

+
STDIN_OPTION: "stdin" = "stdin"
+ +
+
+ +

Static Readonly STDIN_OPTION_ALIAS

+
STDIN_OPTION_ALIAS: "pipe" = "pipe"
+ +
+
+ +

Static Readonly UPDATE_ACTION

+
UPDATE_ACTION: "update" = "update"
+ +
+
+ +

Static Readonly VALIDATE_ACTION

+
VALIDATE_ACTION: "validate" = "validate"
+ +
+
+ +

Static Readonly WEB_DIFF_DIR

+
WEB_DIFF_DIR: "web-diff" = "web-diff"
+ +
+
+ +

Static Readonly WEB_HELP_DIR

+
WEB_HELP_DIR: "web-help" = "web-help"
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.convertprofileshandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.convertprofileshandler.html new file mode 100644 index 0000000000..314cc4b011 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.convertprofileshandler.html @@ -0,0 +1,548 @@ + + + + + + ConvertProfilesHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConvertProfilesHandler

+
+
+
+
+
+
+
+
+
+

Handler for the convert profiles command.

+
+
+
+
+

Hierarchy

+
    +
  • + ConvertProfilesHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Private Readonly ZOWE_CLI_PACKAGE_NAME

+
ZOWE_CLI_PACKAGE_NAME: "@zowe/cli" = "@zowe/cli"
+ +
+
+ +

Private Readonly ZOWE_CLI_SECURE_PLUGIN_NAME

+
ZOWE_CLI_SECURE_PLUGIN_NAME: "@zowe/secure-credential-store-for-zowe-cli" = "@zowe/secure-credential-store-for-zowe-cli"
+ +
+
+ +

Private keytar

+
keytar: typeof keytar = undefined
+ +
+
+
+

Methods

+
+ +

Private checkKeytarAvailable

+
    +
  • checkKeytarAvailable(): Promise<boolean>
  • +
+ +
+
+ +

Private deleteOldSecureProps

+ + +
+
+ +

Private findOldSecureProps

+ + +
+
+ +

Private getOldPluginInfo

+
    +
  • getOldPluginInfo(): IOldPluginInfo
  • +
+ +
+
+ +

Private getOldProfileCount

+
    +
  • getOldProfileCount(profilesRootDir: string): number
  • +
+ +
+
+ +

process

+ + +
+
+ +

Private removeOverride

+ +
    +
  • + +
    +
    +

    Remove obsolete Imperative overrides from app settings. This method is + called before uninstalling old plug-ins.

    +
    +

    This method is private because only the convert-profiles command is able + to disable the credential manager and reload it. For all other commands, + the credential manager is loaded in Imperative.init and frozen with + Object.freeze so cannot be modified later on.

    +
    +

    Parameters

    + +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.createprofileshandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.createprofileshandler.html new file mode 100644 index 0000000000..d86b1afbca --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.createprofileshandler.html @@ -0,0 +1,281 @@ + + + + + + CreateProfilesHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CreateProfilesHandler

+
+
+
+
+
+
+
+
+
+

Handler that allows creation of a profile from command line arguments. Intended for usage with the automatically + generated profile create commands, but can be used otherwise.

+
+
+
export
+
+
implements
+

{ICommandHandler}

+
+
+
+
+
+

Hierarchy

+
    +
  • + CreateProfilesHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.credentialmanagerfactory.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.credentialmanagerfactory.html new file mode 100644 index 0000000000..e9ba5fd833 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.credentialmanagerfactory.html @@ -0,0 +1,413 @@ + + + + + + CredentialManagerFactory | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CredentialManagerFactory

+
+
+
+
+
+
+
+
+
+

This is a wrapper class that controls access to the credential manager used within + the Imperative framework. All calls to the credential manager done by Imperative + must go through this class for security reasons.

+
+
+
+
+

Hierarchy

+
    +
  • + CredentialManagerFactory +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Static Private mManager

+ + +
+
+

Static singleton instance of an instantiated AbstractCredentialManager

+
+
+
+
+
+

Accessors

+
+ +

Static initialized

+
    +
  • get initialized(): boolean
  • +
+
    +
  • + +
    +
    +

    The credential manager may not be initialized if Keytar (or a plugin override) is not present. In this + scenario, the default is to store credentials in plain text.

    +
    +
    +

    Returns boolean

    +
      +
    • True if the credential manager has been initialized.
    • +
    +
  • +
+
+
+ +

Static manager

+ + +
+
+
+

Methods

+
+ +

Static initialize

+ +
    +
  • + +
    +
    +

    Initialize the credential manager, then lock the door and throw away the + key. This method can only be called once and should be called by Imperative.init + immediately after the CLI configuration has been loaded.

    +
    +

    This is where any Credential Manager your cli provides will be initialized. First + Imperative will instantiate your manager (or the DefaultCredentialManager if none was provided to + Imperative.init) and will then call your class's initialize method.

    + +

    Dynamic Import of Module

    +
    +

    This method will perform a dynamic import of your {@link IImperativeOverrides.CredentialManager} module when the + Manager parameter is passed as a string. If anything goes wrong during this import or if the module that was exported + doesn't extend the AbstractCredentialManager, this method will throw an error.

    +
    +
    see
    +

    {@link IImperativeOverrides.CredentialManager}

    + +

    Immutable Class Creation

    +
    +

    After this method is complete, the instantiated credential manager will no longer allow changes + to it's direct variable assignments. This means that even your class can only change the values of it's direct + properties in the constructor and the initialize method. However, this does not prevent you from changing values + of properties of one of your classes objects.

    +

    For example, after initialization, your class can not do something like this: this.someProp = 5. This will result + in a JavaScript "Cannot assign to read only property" exception because your class is immutable. + You still will be able to do stuff like this if someProp was already an object: this.someProp.someValue = 5. This + occurs because while Imperative marks your class as immutable (using Object.freeze) the underlying this.someProp + object is still mutable.

    +
    +
    see
    +

    https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze

    + +

    Plugin Provided Overrides

    +
    +

    This class attempts to handle a failed plugin override as well. If this method errors out because of problems + with the Manager parameter, it will check to see if the override was provided by a plugin loaded in the + PluginManagementFacility. The check is done by looking at the value present in the {@link AppSettings#settings} + of the singleton present in AppSettings.instance

    +

    If the it was detected that the Manager was not provided by a plugin, the error encountered is thrown to + the calling function.

    +

    If the initialization option "invalidOnFailure" is true, we will default to using the InvalidCredentialManager + which implements the AbstractCredentialManager methods. All these methods have been designed to throw + the error we caught in the CredentialManagerFactory.initialize function.

    +
    +
    throws
    +

    ImperativeError When it has been detected that this method has been called before. + It is important that this method only executes once.

    +
    +
    throws
    +

    ImperativeError When the module specified by the Manager string references a module that + does not extend AbstractCredentialManager and the override was not provided by a plugin. + When the override is provided by a plugin, we will fall back to the InvalidCredentialManager.

    +
    +
    +
    +

    Parameters

    + +

    Returns Promise<void>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.credentialmanageroverride.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.credentialmanageroverride.html new file mode 100644 index 0000000000..5215db0f04 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.credentialmanageroverride.html @@ -0,0 +1,558 @@ + + + + + + CredentialManagerOverride | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CredentialManagerOverride

+
+
+
+
+
+
+
+
+
+

This class provides access to the known set of credential manager overrides + and functions to manipulate which credential manager is in use. + Other credential managers can replace the default credential manager. + Both CLI plugins and Zowe Explorer extensions can override the default + credential manager. However, only one credential manager will be in effect + on a given computer. The last component to override the credential + manager wins.

+
+
+
+
+

Hierarchy

+
    +
  • + CredentialManagerOverride +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly CRED_MGR_SETTING_NAME

+
CRED_MGR_SETTING_NAME: string = "CredentialManager"
+ +
+
+ +

Static Readonly DEFAULT_CRED_MGR_NAME

+
DEFAULT_CRED_MGR_NAME: string = "@zowe/cli"
+ +
+
+ +

Static Private Readonly KNOWN_CRED_MGRS

+
KNOWN_CRED_MGRS: ICredentialManagerNameMap[] = [{"credMgrDisplayName": this.DEFAULT_CRED_MGR_NAME},{"credMgrDisplayName": "Secrets for Kubernetes","credMgrPluginName": "@zowe/secrets-for-kubernetes-for-zowe-cli","credMgrZEName": "Zowe.secrets-for-kubernetes"}]
+ +
+
+
+

Methods

+
+ +

Static getCredMgrInfoByDisplayName

+ + +
+
+ +

Static getCredMgrInfoByPlugin

+ + +
+
+ +

Static getCredMgrInfoByZEExt

+ + +
+
+ +

Static getKnownCredMgrs

+ + +
+
+ +

Static Private getSettingsFileJson

+
    +
  • getSettingsFileJson(): { fileName: string; json: ISettingsFile }
  • +
+
    +
  • + +
    +
    +

    Get the contents of the $ZOWE_CLI_HOME/settings/imperative.json file. + The resulting JSON is guaranteed to contain the key + 'overrides.CredentialManager'.

    +
    +
    +
    throws
    +

    An ImperativeError if the file does not exist or have the key.

    +
    +
    +
    +

    Returns { fileName: string; json: ISettingsFile }

    +

    A 'settings' object with the properties: fileName and json. + The json object contains the contents of the settings file.

    + +
  • +
+
+
+ +

Static recordCredMgrInConfig

+
    +
  • recordCredMgrInConfig(newCredMgrName: string): void
  • +
+
    +
  • + +
    +
    +

    Record the specified credential manager in the configuration of overrides. + A plugin or ZE extension that provides a credential manager would record + its credential manager name upon installation.

    +
    +
    +
    throws
    +

    An ImperativeError upon error.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      newCredMgrName: string
      +
      +
         The display name of your credential manager.
      +
      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static recordDefaultCredMgrInConfig

+
    +
  • recordDefaultCredMgrInConfig(credMgrToReplace: string): void
  • +
+
    +
  • + +
    +
    +

    Record the default Zowe CLI credential manager in the configuration of + overrides. The specified credential manager will be replaced with the + default Zowe CLI credential manager. A plugin or ZE extension that provides + a credential manager would replace itself with the default credential + manager when it is being uninstalled.

    +
    +
    +
    throws
    +

    An ImperativeError upon error.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      credMgrToReplace: string
      +
      +
         The display name of your credential manager. This name must also
      +   be the credential manager currently recorded in the configuration
      +   of overrides. Otherwise, no replacement will be performed.
      +   Specifying your own name is intended to prevent a plugin from
      +   inadvertently replacing another plugin's credential manager.
      +
      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.daemonrequest.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.daemonrequest.html new file mode 100644 index 0000000000..ed04942104 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.daemonrequest.html @@ -0,0 +1,400 @@ + + + + + + DaemonRequest | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class DaemonRequest

+
+
+
+
+
+
+
+
+
+

Class to handle building a daemon request

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + DaemonRequest +
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private request

+ + +
+
+ +

Static Readonly EOW_DELIMITER

+
EOW_DELIMITER: string = " "
+ +
+
+

End of writing delimiter

+
+
+
static
+
+
memberof
+

DaemonRequest

+
+
+
+
+
+
+

Methods

+
+ +

Private build

+
    +
  • build(): string
  • +
+ +
+
+ +

Static create

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.defaultcredentialmanager.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.defaultcredentialmanager.html new file mode 100644 index 0000000000..e1c32571f3 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.defaultcredentialmanager.html @@ -0,0 +1,1065 @@ + + + + + + DefaultCredentialManager | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class DefaultCredentialManager

+
+
+
+
+
+
+
+
+
+

Default Credential Manager is our implementation of the Imperative Credential Manager. This manager invokes methods + created by the keytar utility (https://www.npmjs.com/package/keytar) to access the secure credential vault on the + user's machine.

+
+ +

Keychains Used by Keytar

+
+ + + + + + + + + + + + + + + + + + + +
OSVault
WindowsCredential Vault
macOSKeychain
LinuxSecret Sevice API/libsecret
+ +

Keytar must be installed by the app using imperative (like zowe-cli).

+
+

On Linux, Keytar will not work out of the box without some additional + configuration to install libsecret. Keytar provides the following + documentation for Linux users to install libsecret:

+
+

Depending on your distribution, you will need to run the following command:

+
    +
  • Debian/Ubuntu: sudo apt-get install libsecret-1-dev
  • +
  • Red Hat-based: sudo yum install libsecret-devel
  • +
  • Arch Linux: sudo pacman -S libsecret
  • +
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private Readonly WIN32_CRED_MAX_STRING_LENGTH

+
WIN32_CRED_MAX_STRING_LENGTH: 2560 = 2560
+ +
+
+

Maximum credential length allowed by Windows 7 and newer.

+
+

We don't support older versions of Windows where the limit is 512 bytes.

+
+
+
+ +

Private allServices

+
allServices: string[]
+ +
+
+

Combined list of services that the plugin will go through

+
+
+
+
+ +

Private keytar

+
keytar: typeof keytar
+ +
+
+

Reference to the lazily loaded keytar module.

+
+
+
+
+ +

Private loadError

+
loadError: ImperativeError
+ +
+
+

Errors that occurred while loading keytar will be stored in here.

+
+

Every method of this class should call the checkForKeytar method before proceeding. It + is this method that will check for keytar and throw this error if it was detected that keytar + wasn't loaded.

+
+
+
+ +

Protected Readonly service

+
service: string
+ +
+
+

The service that the Credential Manager is running under. Imperative will set this to the + cliName

+
+
+
+
+ +

Static Readonly SVC_NAME

+
SVC_NAME: "Zowe" = "Zowe"
+ +
+
+

The service name for our built-in credential manager.

+
+
+
+
+
+

Accessors

+
+ +

Private defaultService

+
    +
  • get defaultService(): string
  • +
+ +
+
+ +

name

+
    +
  • get name(): string
  • +
+ +
+
+ +

Protected possibleSolutions

+
    +
  • get possibleSolutions(): string[]
  • +
+ +
+
+
+

Methods

+
+ +

Private checkForKeytar

+
    +
  • checkForKeytar(): void
  • +
+
    +
  • + +
    +
    +

    This function is called before the {@link deletePassword}, {@link getPassword}, and + {@link setPassword} functions. It will check if keytar is not null and will throw an error + if it is.

    +
    +

    The error thrown will be the contents of loadError or a new ImperativeError. + The former error will be the most common one as we expect failures during the load since keytar + is optional. The latter error will indicate that some unknown condition has happened so we will + create a new ImperativeError with the report suppressed. The report is suppressed because it + may be possible that a detailed report could capture a username and password, which would + probably be a bad thing.

    +
    +
    throws
    +

    ImperativeError when keytar is null or undefined.

    +
    +
    +
    +

    Returns void

    +
  • +
+
+
+ +

delete

+
    +
  • delete(account: string): Promise<void>
  • +
+ +
+
+ +

Protected deleteCredentials

+
    +
  • deleteCredentials(account: string): Promise<void>
  • +
+ +
+
+ +

Private deleteCredentialsHelper

+
    +
  • deleteCredentialsHelper(account: string, keepCurrentSvc?: boolean): Promise<boolean>
  • +
+ +
+
+ +

Private getCredentialsHelper

+ +
    +
  • + +
    +
    +

    Helper to load credentials from vault that supports values longer than + DefaultCredentialManager.WIN32_CRED_MAX_STRING_LENGTH on Windows.

    +
    +
    +

    Parameters

    +
      +
    • +
      service: string
      +
      +

      The string service name.

      +
      +
    • +
    • +
      account: string
      +
      +

      The string account name.

      +
      +
    • +
    +

    Returns Promise<SecureCredential>

    +

    A promise for the credential string.

    +
  • +
+
+
+ +

Private getMissingEntryMessage

+
    +
  • getMissingEntryMessage(account: string): string
  • +
+ +
+
+ +

initialize

+ +
    +
  • + +
    +
    +

    Called by CredentialManagerFactory.initialize before the freeze of the object. This + gives us a chance to load keytar into the class before we are locked down. If a load failure + occurs, we will store the error and throw it once a method of this class tries to execute. This + prevents a missing keytar module from stopping all operation of the cli.

    +
    +

    In the future, we could go even further to have keytar load into a sub-object of this class so + that the load doesn't hold up the main class execution.

    +
    +

    Returns Promise<void>

    +

    A promise that the function has completed.

    +
  • +
+
+
+ +

load

+
    +
  • load(account: string, optional?: boolean): Promise<string>
  • +
+ +
+
+ +

Protected loadCredentials

+ + +
+
+ +

save

+
    +
  • save(account: string, secureValue: string): Promise<void>
  • +
+ +
+
+ +

Protected saveCredentials

+ + +
+
+ +

secureErrorDetails

+
    +
  • secureErrorDetails(): string | undefined
  • +
+ +
+
+ +

Private setCredentialsHelper

+ +
    +
  • + +
    +
    +

    Helper to save credentials to vault that supports values longer than + DefaultCredentialManager.WIN32_CRED_MAX_STRING_LENGTH on Windows.

    +
    +
    +

    Parameters

    +
      +
    • +
      service: string
      +
      +

      The string service name.

      +
      +
    • +
    • +
      account: string
      +
      +

      The string account name.

      +
      +
    • +
    • +
      value: SecureCredential
      +
      +

      The string credential.

      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited method
  • +
+
    +
  • Protected method
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.defaulthelpgenerator.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.defaulthelpgenerator.html new file mode 100644 index 0000000000..b079fdbe4d --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.defaulthelpgenerator.html @@ -0,0 +1,1519 @@ + + + + + + DefaultHelpGenerator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class DefaultHelpGenerator

+
+
+
+
+
+
+
+
+
+

Imperative default help generator. Accepts the command definitions and constructs + the full help text for the command node.

+
+

TODO - Consider removing word wrap on a fixed with and apply dynamically based on terminal sizes

+
+
export
+
+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected groupToOption

+
groupToOption: {}
+ +
+
+

A map of group names to option names and aliases - useful in help text/doc generation + e.g. this.grouptoOption["job options"] -> [ "--async | -a ", "--activate | -A"]

+
+
+
+

Type declaration

+
    +
  • +
    [key: string]: string[]
    +
  • +
+
+
+
+ +

Protected mCommandDefinition

+
mCommandDefinition: ICommandDefinition
+ +
+
+

The command definition for which we are building help

+
+
+
+
+ +

Protected mDefinitionTree

+
mDefinitionTree: ICommandDefinition
+ +
+
+

The full command definition - which includes the parents of the command.

+
+
+
+
+ +

Protected mExperimentalCommandDescription

+
mExperimentalCommandDescription: string = Constants.DEFAULT_EXPERIMENTAL_COMMAND_EXPLANATION
+ +
+
+

The configured experimental command description. + Has a default, generic description which can be overridden through parameters + to the constructor

+
+
+
+
+ +

Protected mLog

+
mLog: Logger
+ +
+
+

Logger

+
+
+
+
+ +

Protected mPrimaryHighlightColor

+
mPrimaryHighlightColor: string
+ +
+
+ +

Protected mProduceMarkdown

+
mProduceMarkdown: boolean = false
+ +
+
+

Produce markdown - not help text.

+
+
+
+
+ +

Protected mRootCommandName

+
mRootCommandName: string
+ +
+
+

The command name being invoked by the user. + For example, when using "banana --help", banana is the command name.

+
+
+
+
+ +

Protected optionToDescription

+
optionToDescription: {}
+ +
+
+

A map of option names and aliases to their descriptions - useful in help text/doc generation + e.g. this.optionToDescription["--async | a"] -> "Don't wait for this job to complete before returning"

+
+
+
+

Type declaration

+
    +
  • +
    [key: string]: string
    +
  • +
+
+
+
+ +

Private skipTextWrap

+
skipTextWrap: boolean = false
+ +
+
+

Indicates that the help generator should skip introducing breaks based on terminal width

+
+
+
memberof
+

IHelpGeneratorParms

+
+
+
+
+
+ +

Static Private Readonly ERROR_TAG

+
ERROR_TAG: string = "Help Generator Error:"
+ +
+
+

Standard imperative error message tag for errors thrown by the help generator

+
+
+
static
+
+
memberof
+

DefaultHelpGenerator

+
+
+
+
+
+ +

Static Readonly HELP_INDENT

+
HELP_INDENT: " " = " "
+ +
+
+

The help indent for spacing/alignment

+
+
+
static
+
+
memberof
+

DefaultHelpGenerator

+
+
+
+
+
+ +

Static LONG_DASH

+
LONG_DASH: string = "--"
+ +
+
+ +

Static SHORT_DASH

+
SHORT_DASH: string = "-"
+ +
+
+
+

Accessors

+
+ +

Protected log

+ + +
+
+
+

Methods

+
+ +

buildChildrenSummaryTables

+
    +
  • buildChildrenSummaryTables(): string
  • +
+ +
+
+ +

buildCommandAndAliases

+ +
    +
  • + +
    +
    +

    Build a string containing the command name and aliases separated by the vertical bar: + command | c

    +
    +
    +
    memberof
    +

    DefaultHelpGenerator

    +
    +
    +
    +

    Parameters

    + +

    Returns string

    +
      +
    • Contains the command name followed by the aliases (e.g. command | c)
    • +
    +
  • +
+
+
+ +

buildCommandOptionsSection

+
    +
  • buildCommandOptionsSection(): string
  • +
+ +
+
+ +

buildDescriptionSection

+
    +
  • buildDescriptionSection(): string
  • +
+ +
+
+ +

buildExamplesSection

+
    +
  • buildExamplesSection(): string
  • +
+
    +
  • + +
    +
    +

    Build the examples text for the command. Examples include the command example (which normally is able to + be copy/pasted verbatim) and the description for the example. + TODO - we should remove wordwrap from this

    +
    +
    +
    memberof
    +

    DefaultHelpGenerator

    +
    +
    +
    +

    Returns string

    +
      +
    • The example text
    • +
    +
  • +
+
+
+ +

buildFullCommandHelpText

+
    +
  • buildFullCommandHelpText(includeGlobalOptions?: boolean): string
  • +
+ +
+
+ +

buildFullGroupHelpText

+
    +
  • buildFullGroupHelpText(): string
  • +
+
    +
  • + +
    +
    +

    Build the help text for a "group" - a group has a set of children The help text contains the standard + description/usage/etc., but unlike a command only displays the next set of "commands" or "groups" that can + be issued after the current node.

    +
    +
    +
    memberof
    +

    DefaultHelpGenerator

    +
    +
    +
    +

    Returns string

    +
      +
    • the full group help text
    • +
    +
  • +
+
+
+ +

buildGlobalOptionsSection

+
    +
  • buildGlobalOptionsSection(): string
  • +
+ +
+
+ +

buildHeader

+
    +
  • buildHeader(header: string): string
  • +
+ +
+
+ +

buildHelp

+
    +
  • buildHelp(): string
  • +
+ +
+
+ +

Protected buildOptionMaps

+
    +
  • buildOptionMaps(): void
  • +
+ +
+
+ +

buildOptionText

+
    +
  • buildOptionText(optionString: string, description: string): string
  • +
+
    +
  • + +
    +
    +

    Build the text for option:

    +
    +

    --option

    +

    The description for this option

    +
    +

    Parameters

    +
      +
    • +
      optionString: string
      +
      +

      The option string (-- form or positional, etc.)

      +
      +
    • +
    • +
      description: string
      +
      +

      The description for the option

      +
      +
    • +
    +

    Returns string

    +
      +
    • The option text
    • +
    +
  • +
+
+
+ +

buildPositionalArgumentsSection

+
    +
  • buildPositionalArgumentsSection(): string
  • +
+
    +
  • + +
    +
    +

    Return the help text format for positional parameters - includes the parameter itself, the optional regex, + and the full description.

    +
    +
    +
    memberof
    +

    DefaultHelpGenerator

    +
    +
    +
    +

    Returns string

    +
      +
    • The help text for each positional parameter.
    • +
    +
  • +
+
+
+ +

buildUsageDiagram

+
    +
  • buildUsageDiagram(): string
  • +
+ +
+
+ +

buildUsageSection

+
    +
  • buildUsageSection(): string
  • +
+ +
+
+ +

Protected dimGrey

+
    +
  • dimGrey(text: string): any
  • +
+ +
+
+ +

Private escapeMarkdown

+
    +
  • escapeMarkdown(text: string): string
  • +
+
    +
  • + +
    +
    +

    Utility function to escape Markdown special characters. + Note: This should only be called once to avoid double escaping.

    +
    +
    +

    Parameters

    +
      +
    • +
      text: string
      +
      +

      The text to escape

      +
      +
    • +
    +

    Returns string

    +
      +
    • The escaped string
    • +
    +
  • +
+
+
+ +

Protected explainType

+ + +
+
+ +

Protected getCaseSensitiveFlagByOptionName

+
    +
  • getCaseSensitiveFlagByOptionName(optionName: string): boolean
  • +
+ +
+
+ +

getExperimentalCommandSection

+
    +
  • getExperimentalCommandSection(): string
  • +
+
    +
  • + +
    +
    +

    Get a blurb explaining experimental commands if this command is experimental

    +
    +
    +
    memberof
    +

    DefaultHelpGenerator

    +
    +
    +
    +

    Returns string

    +
      +
    • If this command is experimental, returns the experimental command explanation block
    • +
    +
  • +
+
+
+ +

getOptionAndAliasesString

+ + +
+
+ +

Protected grey

+
    +
  • grey(text: string): any
  • +
+ +
+
+ +

Protected renderHelp

+
    +
  • renderHelp(help: string): string
  • +
+ +
+
+ +

Static formatHelpHeader

+
    +
  • formatHelpHeader(header: string, indent?: string, color: string): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited method
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.defaultrootcommandhandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.defaultrootcommandhandler.html new file mode 100644 index 0000000000..d0b88af28e --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.defaultrootcommandhandler.html @@ -0,0 +1,261 @@ + + + + + + DefaultRootCommandHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class DefaultRootCommandHandler

+
+
+
+
+
+
+
+
+
+

The default command handler for the top level/root command + Allows the user to check the version of the package. + If they haven't specified --version, the help prints

+
+
+
+
+

Hierarchy

+
    +
  • + DefaultRootCommandHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.definitiontreeresolver.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.definitiontreeresolver.html new file mode 100644 index 0000000000..1a48810209 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.definitiontreeresolver.html @@ -0,0 +1,428 @@ + + + + + + DefinitionTreeResolver | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class DefinitionTreeResolver

+
+
+
+
+
+
+
+
+
+

Combines a root command definition with an array of + command definition trees into a full tree with the command definitions + as children of the root command + For Imperative internal use

+
+
+
+
+

Hierarchy

+
    +
  • + DefinitionTreeResolver +
  • +
+
+
+

Index

+
+
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Accessors

+
+ +

Static Private log

+ + +
+
+
+

Methods

+
+ +

Static Private addBaseProfile

+ + +
+
+ +

Static combineAllCmdDefs

+ +
    +
  • + +
    +
    +

    Combine all of the command definitions supplied explicitly in the cmdDefs parameter + and those command definitions discovered by resolving the supplied cmdModuleGlobs.

    +
    +
    +

    Parameters

    +
      +
    • +
      callerDir: string
      +
      +

      the directory that any childrenModuleGlobs are relative to

      +
      +
    • +
    • +
      Default value cmdDefs: ICommandDefinition[] = []
      +
      +

      An array of already-resolved definitions

      +
      +
    • +
    • +
      Default value cmdModuleGlobs: string[] = []
      +
      +

      list of globs that match definition files

      +
      +
    • +
    • +
      Optional addBaseProfile: boolean
      +
      +

      Specifies whether to add optional base profile to command definitions

      +
      +
    • +
    +

    Returns ICommandDefinition[]

    +
      +
    • An array of all resolved command definitions
    • +
    +
  • +
+
+
+ +

Static resolve

+
    +
  • resolve(rootCommandDescription: string, displayName: string, callerDir: string, errorLogger: Logger, childrenDefinitions?: ICommandDefinition[], childrenModuleGlobs?: string[], addBaseProfile?: boolean): ICommandDefinition
  • +
+
    +
  • + +
    +
    +

    Get a fully constructed tree of command definitions from everything the CLI developer has specified

    +
    +
    +

    Parameters

    +
      +
    • +
      rootCommandDescription: string
      +
      +

      Description to use for the root command (when

      +
      +
    • +
    • +
      displayName: string
      +
      +

      the display name for the product/CLI

      +
      +
    • +
    • +
      callerDir: string
      +
      +

      the directory that any childrenModuleGlobs are relative to

      +
      +
    • +
    • +
      errorLogger: Logger
      +
      +

      a logger instance to be used (e.g. a console logger) for errors

      +
      +
    • +
    • +
      Optional childrenDefinitions: ICommandDefinition[]
      +
      +

      already loaded definitions that have been passed by the user

      +
      +
    • +
    • +
      Optional childrenModuleGlobs: string[]
      +
      +

      list of globs that match definition files

      +
      +
    • +
    • +
      Optional addBaseProfile: boolean
      +
      +

      Specifies whether to add optional base profile to command definitions

      +
      +
    • +
    +

    Returns ICommandDefinition

    +
      +
    • the complete command tree
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.diffutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.diffutils.html new file mode 100644 index 0000000000..327e2dfe06 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.diffutils.html @@ -0,0 +1,308 @@ + + + + + + DiffUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class DiffUtils

+
+
+
+
+
+
+
+
+
+

Utilities to get the diff strings and open the diff strings in terminal and in browser

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + DiffUtils +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static getDiffString

+ + +
+
+ +

Static openDiffInbrowser

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.edithandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.edithandler.html new file mode 100644 index 0000000000..c42eea077a --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.edithandler.html @@ -0,0 +1,272 @@ + + + + + + EditHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class EditHandler

+
+
+
+
+
+
+
+
+
+

Edit config

+
+
+
+
+

Hierarchy

+
    +
  • + EditHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.envfileutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.envfileutils.html new file mode 100644 index 0000000000..17ab060a06 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.envfileutils.html @@ -0,0 +1,475 @@ + + + + + + EnvFileUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class EnvFileUtils

+
+
+
+
+
+
+
+
+
+

Utility to load environment JSON files and set variables

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + EnvFileUtils +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Private environmentJSON

+
environmentJSON: any
+ +
+
+

This variable holds a cached version of the EnvFileJson.

+
+
+
+
+
+

Methods

+
+ +

Static getCliHomeEnvironmentFilePath

+
    +
  • getCliHomeEnvironmentFilePath(appName: string, envPrefix?: string): string
  • +
+
    +
  • + +
    +
    +

    Get the expected path for the user's environment variable file

    +
    +
    +

    Parameters

    +
      +
    • +
      appName: string
      +
      +

      The application name

      +
      +
    • +
    • +
      Optional envPrefix: string
      +
      +

      The environment variable prefix

      +
      +
    • +
    +

    Returns string

    +
      +
    • Returns the path string if it exists, or null if it does not
    • +
    +
  • +
+
+
+ +

Static getEnvironmentFilePath

+
    +
  • getEnvironmentFilePath(appName: string, checkCliHomeVariableFirst?: boolean, envPrefix?: string): string
  • +
+
    +
  • + +
    +
    +

    Get the expected path for the user's environment variable file

    +
    +
    +

    Parameters

    +
      +
    • +
      appName: string
      +
      +

      The application name

      +
      +
    • +
    • +
      Default value checkCliHomeVariableFirst: boolean = false
      +
      +

      Check inside of *_CLI_HOME first if it is defined

      +
      +
    • +
    • +
      Optional envPrefix: string
      +
      +

      environment variable prefix

      +
      +
    • +
    +

    Returns string

    +
      +
    • Returns the path string if it exists, or null if it does not
    • +
    +
  • +
+
+
+ +

Static getUserHomeEnvironmentFilePath

+
    +
  • getUserHomeEnvironmentFilePath(appName: string): string
  • +
+
    +
  • + +
    +
    +

    Get the expected path for the user's environment variable file

    +
    +
    +

    Parameters

    +
      +
    • +
      appName: string
      +
      +

      The application name

      +
      +
    • +
    +

    Returns string

    +
      +
    • Returns the path string if it exists, or null if it does not
    • +
    +
  • +
+
+
+ +

Static resetEnvironmentForApp

+
    +
  • resetEnvironmentForApp(): void
  • +
+ +
+
+ +

Static setEnvironmentForApp

+
    +
  • setEnvironmentForApp(appName: string, checkCliHomeVariableFirst?: boolean, envPrefix?: string): void
  • +
+
    +
  • + +
    +
    +

    Check and read in an environment file from the user home directory using the app name + If the file is valid, set the environment variables + If the file is not valid, display an error and continue

    +
    +
    +
    throws
    +

    {ImperativeError}

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      appName: string
      +
      +

      The application name

      +
      +
    • +
    • +
      Default value checkCliHomeVariableFirst: boolean = false
      +
      +

      Check inside of *_CLI_HOME first if it is defined

      +
      +
    • +
    • +
      Optional envPrefix: string
      +
      +

      The environment variable prefix

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.environmentalvariablesettings.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.environmentalvariablesettings.html new file mode 100644 index 0000000000..174189c445 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.environmentalvariablesettings.html @@ -0,0 +1,436 @@ + + + + + + EnvironmentalVariableSettings | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class EnvironmentalVariableSettings

+
+
+
+
+
+
+
+
+
+

Service for reading environmental variable settings + exposed for CLIs built on Imperative CLI framework

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + EnvironmentalVariableSettings +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly APP_LOG_LEVEL_KEY_SUFFIX

+
APP_LOG_LEVEL_KEY_SUFFIX: "_APP_LOG_LEVEL" = "_APP_LOG_LEVEL"
+ +
+
+

The end of the environmental variable for configuring the log level for the appLogger of your CLI + The prefix will be added to the beginning of this value to construct the full key

+
+
+
memberof
+

EnvironmentalVariableSettings

+
+
+
+
+
+ +

Static Readonly APP_MASK_OUTPUT_SUFFIX

+
APP_MASK_OUTPUT_SUFFIX: "_APP_MASK_OUTPUT" = "_APP_MASK_OUTPUT"
+ +
+
+

The end of the environmental variable for configuring the ability to mask output of your CLI + The prefix will be added to the beginning of this value to construct the full key

+
+
+
memberof
+

EnvironmentalVariableSettings

+
+
+
+
+
+ +

Static Readonly CLI_HOME_SUFFIX

+
CLI_HOME_SUFFIX: "_CLI_HOME" = "_CLI_HOME"
+ +
+
+

The end of the environmental variable for configuring the home directory for your CLI + The prefix will be added to the beginning of this value to construct the full key

+
+
+
memberof
+

EnvironmentalVariableSettings

+
+
+
+
+
+ +

Static Readonly CLI_PLUGINS_DIR_SUFFIX

+
CLI_PLUGINS_DIR_SUFFIX: "_CLI_PLUGINS_DIR" = "_CLI_PLUGINS_DIR"
+ +
+
+

The end of the environmental variable for configuring the plugins directory for your CLI + The prefix will be added to the beginning of this value to contruct the full key

+
+
+
memberof
+

EnvironmentalVariableSettings

+
+
+
+
+
+ +

Static Readonly IMPERATIVE_LOG_LEVEL_KEY_SUFFIX

+
IMPERATIVE_LOG_LEVEL_KEY_SUFFIX: "_IMPERATIVE_LOG_LEVEL" = "_IMPERATIVE_LOG_LEVEL"
+ +
+
+

The end of the environmental variable for configuring the log level for the imperative logger of your CLI + The prefix will be added to the beginning of this value to construct the full key

+
+
+
memberof
+

EnvironmentalVariableSettings

+
+
+
+
+
+ +

Static Readonly PROMPT_PHRASE_SUFFIX

+
PROMPT_PHRASE_SUFFIX: "_PROMPT_PHRASE" = "_PROMPT_PHRASE"
+ +
+
+

The end of the environmental variable for configuring the prompt phrase for your CLI + The prefix will be added to the beginning of this value to construct the full key

+
+
+
memberof
+

EnvironmentalVariableSettings

+
+
+
+
+
+
+

Methods

+
+ +

Static read

+ +
    +
  • + +
    +
    +

    Read all environmental variable settings for a CLI

    +
    +
    +
    memberof
    +

    EnvironmentalVariableSettings

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      prefix: string
      +
      +

      the environmental variables for a CLI will begin with this prefix e.g. "SAMPLE_CLI". + by default, this should be the same as the Imperative.loadedConfig.name field + unless you specify envVariablePrefix on your Imperative configuration

      +
      +
    • +
    +

    Returns IImperativeEnvironmentalVariableSettings

    +
      +
    • object populated with the settings specified by the user
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.envquery.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.envquery.html new file mode 100644 index 0000000000..d0979cbbc3 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.envquery.html @@ -0,0 +1,713 @@ + + + + + + EnvQuery | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class EnvQuery

+
+
+
+
+
+
+
+
+
+

This class encapulates operations for Zowe CLI environment information. + We use the term environment loosely. Sometimes it is an environment variable. + It can also be something in the runtime environment, like version of NodeJS.

+
+
+
+
+

Hierarchy

+
    +
  • + EnvQuery +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Private Readonly allEolRegex

+
allEolRegex: RegExp = new RegExp(EnvQuery.eolMatch, "g")
+ +
+
+ +

Static Private Readonly divider

+
divider: string = `______________________________________________${os.EOL}`
+ +
+
+ +

Static Private Readonly eolMatch

+
eolMatch: string = "( + ?|)"
+ +
+
+ +

Static Private Readonly indent

+
indent: " " = " "
+ +
+
+ +

Static Private Readonly lastEolRegex

+
lastEolRegex: RegExp = new RegExp(EnvQuery.eolMatch + "$")
+ +
+
+
+

Methods

+
+ +

Static Private detectProbVal

+
    +
  • detectProbVal(value: string, probTest: IProbTest): boolean
  • +
+ +
+
+ +

Static Private getCmdOutput

+
    +
  • getCmdOutput(cmdToRun: string, args: string[]): string
  • +
+ +
+
+ +

Static Private getConfigInfo

+ + +
+
+ +

Static Private getEnvItemProblems

+
    +
  • getEnvItemProblems(itemId: ItemId, itemVal: string): string
  • +
+
    +
  • + +
    +
    +

    For the specified itemId, get any known problems.

    +
    +
    +

    Parameters

    +
      +
    • +
      itemId: ItemId
      +
      +

      ID of the environmental item for which we want to detect problems.

      +
      +
    • +
    • +
      itemVal: string
      +
      +

      The value of the environmental item.

      +
      +
    • +
    +

    Returns string

    +

    A string with a message about the problems. An empty string if no problems are detected.

    +
  • +
+
+
+ +

Static getEnvItemVal

+ + +
+
+ +

Static Private getNpmInfo

+ + +
+
+ +

Static Private getOtherZoweEnvVars

+
    +
  • getOtherZoweEnvVars(getResult: IGetItemVal): void
  • +
+ +
+
+ +

Static Private getPluginInfo

+ + +
+
+ +

Static Private getZoweVer

+ + +
+
+ +

Static Private updateProgressBar

+
    +
  • updateProgressBar(doesProgBarExist: boolean, firstUpdate?: boolean): Promise<void>
  • +
+
    +
  • + +
    +
    +

    If a progress bar is in use, pause long enough to let it update its status.

    +
    +
    +

    Parameters

    +
      +
    • +
      doesProgBarExist: boolean
      +
      +
         Is the progress bar availbale for use?
      +
      +
      +
    • +
    • +
      Default value firstUpdate: boolean = false
      +
      +
         Is this our first progress bar update?
      +   Initialization of the progress bar takes extra time.
      +
      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.executils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.executils.html new file mode 100644 index 0000000000..e8f726772b --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.executils.html @@ -0,0 +1,273 @@ + + + + + + ExecUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ExecUtils

+
+
+
+
+
+
+
+
+
+

A collection of utilities related to executing a sub-process.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ExecUtils +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static spawnAndGetOutput

+
    +
  • spawnAndGetOutput(command: string, args?: string[], options?: SpawnSyncOptions): Buffer | string
  • +
+
    +
  • + +
    +
    +

    Spawn a process with arguments and throw an error if the process fails. + Parameters are same as child_process.spawnSync (see Node.js docs). + Use this method if you want the safe argument parsing of spawnSync + combined with the smart output handling of execSync.

    +
    +
    +

    Parameters

    +
      +
    • +
      command: string
      +
    • +
    • +
      Optional args: string[]
      +
    • +
    • +
      Optional options: SpawnSyncOptions
      +
    • +
    +

    Returns Buffer | string

    +

    Contents of stdout as buffer or string

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.failedcommandhandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.failedcommandhandler.html new file mode 100644 index 0000000000..c473c1ccbb --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.failedcommandhandler.html @@ -0,0 +1,259 @@ + + + + + + FailedCommandHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class FailedCommandHandler

+
+
+
+
+
+
+
+
+
+

Handler used to respond to unexpected errors

+
+
+
+
+

Hierarchy

+
    +
  • + FailedCommandHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.firststepshandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.firststepshandler.html new file mode 100644 index 0000000000..b859d2be98 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.firststepshandler.html @@ -0,0 +1,308 @@ + + + + + + FirststepsHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class FirststepsHandler

+
+
+
+
+
+
+
+
+
+

The firststeps command handler for cli plugin firststeps.

+
+
+
see
+

{firststepsDefinition}

+
+
+
+
+
+

Hierarchy

+
    +
  • + FirststepsHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Private console

+
console: Logger = Logger.getImperativeLogger()
+ +
+
+

A logger for this class

+
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.groupcommandyargs.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.groupcommandyargs.html new file mode 100644 index 0000000000..d055a491a5 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.groupcommandyargs.html @@ -0,0 +1,915 @@ + + + + + + GroupCommandYargs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class GroupCommandYargs

+
+
+
+
+
+
+
+
+
+

Imperative define group command to Yargs - defines the group and it's children to Yargs.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected log

+
log: Logger = Logger.getImperativeLogger()
+ +
+
+ +

Protected yargsParms

+
yargsParms: IYargsParms
+ +
+
+

Parameter object contains parms for Imperative/Yargs and command response objects

+
+
+
+
+ +

Static STOP_YARGS

+
STOP_YARGS: boolean = false
+ +
+
+

TODO: REMOVE THIS, workaround for yargs.fail() problem

+
+
+
+
+
+

Accessors

+
+ +

Protected commandLine

+
    +
  • get commandLine(): string
  • +
+ +
+
+ +

definition

+ + +
+
+ +

Protected envVariablePrefix

+
    +
  • get envVariablePrefix(): string
  • +
+ +
+
+ +

Protected helpGeneratorFactory

+ + +
+
+ +

parents

+ + +
+
+ +

Protected profileManagerFactory

+ + +
+
+ +

Protected promptPhrase

+
    +
  • get promptPhrase(): string
  • +
+ +
+
+ +

Protected responseParms

+ + +
+
+ +

Protected rootCommandName

+
    +
  • get rootCommandName(): string
  • +
+ +
+
+ +

yargs

+
    +
  • get yargs(): Argv
  • +
+ +
+
+
+

Methods

+
+ +

constructDefinitionTree

+ + +
+
+ +

defineCommandToYargs

+ + +
+
+ +

Protected executeHelp

+ + +
+
+ +

Protected executeWebHelp

+ + +
+
+ +

Protected getBrightYargsResponse

+ + +
+
+ +

Protected getDepthExamples

+ + +
+
+ +

Protected getZoweYargsResponse

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Inherited constructor
  • +
  • Inherited method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.handlerresponse.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.handlerresponse.html new file mode 100644 index 0000000000..e44a34bb1e --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.handlerresponse.html @@ -0,0 +1,463 @@ + + + + + + HandlerResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class HandlerResponse

+
+
+
+
+
+
+
+
+
+

Handler command response APIs. Passed to command handlers for console messages, data responses, and progress bars. + Handlers can implement their own logging scheme (or use the Imperative.api to obtain an instance of the logger), + but handlers should NEVER write directly to the console and should always use the APIs here to construct responses. + The HandlerResponse object will automatically handle response formats, etc.

+
+
+
export
+
+
implements
+

{IHandlerResponseApi}

+
+
+
+
+
+

Hierarchy

+
    +
  • + HandlerResponse +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mApis

+ + +
+
+

The command response object allocated by the command processor that exposes the APIs intended for the handler + to use.

+
+
+
memberof
+

HandlerResponse

+
+
+
+
+
+
+

Accessors

+
+ +

console

+ + +
+
+ +

data

+ + +
+
+ +

format

+ + +
+
+ +

progress

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.headers.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.headers.html new file mode 100644 index 0000000000..bda660e885 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.headers.html @@ -0,0 +1,428 @@ + + + + + + Headers | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Headers

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Headers +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly CONTENT_ENCODING

+
CONTENT_ENCODING: string = "Content-Encoding"
+ +
+
+ +

Static Readonly CONTENT_ENCODING_TYPES

+
CONTENT_ENCODING_TYPES: ["br", "deflate", "gzip"] = ["br", "deflate", "gzip"] as const
+ +
+
+ +

Static Readonly CONTENT_LENGTH

+
CONTENT_LENGTH: string = "Content-Length"
+ +
+
+ +

Static Readonly CONTENT_TYPE

+
CONTENT_TYPE: string = "Content-Type"
+ +
+
+
+

Object literals

+
+ +

Static Readonly APPLICATION_JSON

+
APPLICATION_JSON: object
+ +
+ +

Content-Type

+
Content-Type: string = "application/json"
+ +
+
+
+ +

Static Readonly BASIC_AUTHORIZATION

+
BASIC_AUTHORIZATION: object
+ +
+ +

Authorization

+
Authorization: string = ""
+ +
+
+
+ +

Static Readonly COOKIE_AUTHORIZATION

+
COOKIE_AUTHORIZATION: object
+ +
+ +

Cookie

+
Cookie: string = ""
+ +
+
+
+ +

Static Readonly OCTET_STREAM

+
OCTET_STREAM: object
+ +
+ +

Content-Type

+
Content-Type: string = "application/octet-stream"
+ +
+
+
+ +

Static Readonly TEXT_PLAIN

+
TEXT_PLAIN: object
+ +
+ +

Content-Type

+
Content-Type: string = "text/plain"
+ +
+
+
+ +

Static Readonly TEXT_PLAIN_UTF8

+
TEXT_PLAIN_UTF8: object
+ +
+ +

Content-Type

+
Content-Type: string = "text/plain; charset=utf8"
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.helpconstants.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.helpconstants.html new file mode 100644 index 0000000000..6381f1b885 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.helpconstants.html @@ -0,0 +1,239 @@ + + + + + + HelpConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class HelpConstants

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + HelpConstants +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Static Readonly HDR_PROF_REQS

+
HDR_PROF_REQS: string = "COMMAND PROFILE USAGE"
+ +
+
+

Help Section Headers

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.helpgeneratorfactory.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.helpgeneratorfactory.html new file mode 100644 index 0000000000..2c2defb755 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.helpgeneratorfactory.html @@ -0,0 +1,524 @@ + + + + + + HelpGeneratorFactory | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class HelpGeneratorFactory

+
+
+
+
+
+
+
+
+
+

The default help generator factory - always supplies the default help generator.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Accessors

+
+ +

Protected factoryParameters

+ + +
+
+ +

Protected primaryHighlightColor

+
    +
  • get primaryHighlightColor(): string
  • +
+ +
+
+ +

Protected produceMarkdown

+
    +
  • get produceMarkdown(): boolean
  • +
+ +
+
+ +

Protected rootCommandName

+
    +
  • get rootCommandName(): string
  • +
+ +
+
+
+

Methods

+
+ +

Protected getGenerator

+ + +
+
+ +

getHelpGenerator

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Inherited constructor
  • +
  • Inherited method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.imperative.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperative.html new file mode 100644 index 0000000000..34438dd210 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperative.html @@ -0,0 +1,1177 @@ + + + + + + Imperative | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Imperative

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Imperative +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly DEFAULT_DEBUG_FILE

+
DEFAULT_DEBUG_FILE: string = join(process.cwd(), "imperative_debug.log")
+ +
+
+ +

Static Private mApi

+ + +
+
+ +

Static Private mCommandLine

+
mCommandLine: string
+ +
+
+ +

Static Private mConsoleLog

+
mConsoleLog: Logger
+ +
+
+ +

Static Private mFullCommandTree

+
mFullCommandTree: ICommandDefinition
+ +
+
+ +

Static Private mHelpGeneratorFactory

+
mHelpGeneratorFactory: IHelpGeneratorFactory
+ +
+
+ +

Static Private mRootCommandName

+
mRootCommandName: string
+ +
+
+
+

Accessors

+
+ +

Static api

+ + +
+
+ +

Static commandLine

+
    +
  • get commandLine(): string
  • +
  • set commandLine(args: string): void
  • +
+ +
+
+ +

Static console

+ +
    +
  • + +
    +
    +

    Returns the default console object to be used for messaging for + imperative fails to initialize or to be used before logging + is initialized.

    +
    +
    +

    Returns Logger

    +

    : an instance of the default console object

    +
  • +
+
+
+ +

Static envVariablePrefix

+
    +
  • get envVariablePrefix(): string
  • +
+
    +
  • + +
    +
    +

    Get the configured environmental variable prefix for the user's CLI

    +
    +
    +
    deprecated
    +

    Please use ImperativeConfig.instance.envVariablePrefix

    +
    +
    +
    +

    Returns string

    +
      +
    • the configured or default prefix for environmental variables for use in the environmental variable service
    • +
    +
  • +
+
+
+ +

Static fullCommandTree

+ + +
+
+ +

Static Private log

+ + +
+
+ +

Static rootCommandName

+
    +
  • get rootCommandName(): string
  • +
+ +
+
+
+

Methods

+
+ +

Static Private addAutoGeneratedCommands

+ + +
+
+ +

Static Private constructApiObject

+ + +
+
+ +

Static Private constructAppLoggerApi

+
    +
  • constructAppLoggerApi(): Logger
  • +
+ +
+
+ +

Static Private constructConsoleApi

+
    +
  • constructConsoleApi(): Logger
  • +
+ +
+
+ +

Static Private constructDynamicLoggersApi

+
    +
  • constructDynamicLoggersApi(api: any): any
  • +
+ +
+
+ +

Static Private constructImperativeLoggerApi

+
    +
  • constructImperativeLoggerApi(): Logger
  • +
+ +
+
+ +

Static Private defineCommands

+ + +
+
+ +

Static getHelpGenerator

+ +
    +
  • + +
    +
    +

    Get the configured help generator for your CLI. If you have not specified a custom generator, + the DefaultHelpGenerator will be used. + You probably won't need to call this from your CLI, but it is used internally.

    +
    +
    +

    Parameters

    +
      +
    • +
      parms: IHelpGeneratorParms
      +
      +

      parameters to the help generator including command definition

      +
      +
    • +
    +

    Returns IHelpGenerator

    +
      +
    • The help generator for the command
    • +
    +
  • +
+
+
+ +

Static Private getPreparedCmdTree

+ + +
+
+ +

Static getProfileConfiguration

+ + +
+
+ +

Static Private getResolvedCmdTree

+ + +
+
+ +

Static highlightWithPrimaryColor

+
    +
  • highlightWithPrimaryColor(text: string): string
  • +
+ +
+
+ +

Static highlightWithSecondaryColor

+
    +
  • highlightWithSecondaryColor(text: string): string
  • +
+
    +
  • + +
    +
    +

    Highlight text with your configured (or default) secondary color

    +
    +
    +

    Parameters

    +
      +
    • +
      text: string
      +
      +

      the text to highlight

      +
      +
    • +
    +

    Returns string

    +
      +
    • the highlighted text
    • +
    +
  • +
+
+
+ +

Static init

+ + +
+
+ +

Static Private initAppSettings

+
    +
  • initAppSettings(): void
  • +
+ +
+
+ +

Static Private initLogging

+
    +
  • initLogging(): void
  • +
+
    +
  • + +
    +
    +

    Init log object such that subsequent calls to the Logger.getImperativeLogger() (or + other similar calls), will contain all necessary categories for logging.

    +
    +

    TODO(Kelosky): handle level setting via global config (trace enabling and such)

    +
    +

    Returns void

    +
  • +
+
+
+ +

Static Private initProfiles

+ +
    +
  • + +
    +
    +

    Initialize the profiles directory with types and meta files. This can be called every startup of the CLI + without issue, but if the meta files or configuration changes, we'll have to re-initialize. + TODO: Determine the re-initialize strategy.

    +
    +
    +
    static
    +
    +
    memberof
    +

    Imperative

    +
    +
    +
    +

    Parameters

    + +

    Returns Promise<void>

    +
  • +
+
+
+ +

Static parse

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeapi.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeapi.html new file mode 100644 index 0000000000..ec4b1e0655 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeapi.html @@ -0,0 +1,536 @@ + + + + + + ImperativeApi | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ImperativeApi

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ImperativeApi +
  • +
+
+
+

Indexable

+
[key: string]: any
+
+
+

index signature for accessing Imperative api via dictionary [] notation.

+
+
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mApis

+ + +
+
+ +

Private mConfig

+ + +
+
+ +

Private mCustomLoggerMap

+
mCustomLoggerMap: {}
+ +
+

Type declaration

+
    +
  • +
    [key: string]: Logger
    +
  • +
+
+
+
+ +

Private mHome

+
mHome: string
+ +
+
+ +

Private mLog

+
mLog: Logger
+ +
+
+

Input parameters to construct the API object

+
+
+
+
+
+

Accessors

+
+ +

appLogger

+ + +
+
+ +

imperativeLogger

+
    +
  • get imperativeLogger(): Logger
  • +
+ +
+
+
+

Methods

+
+ +

addAdditionalLogger

+
    +
  • addAdditionalLogger(name: string, logger: Logger): void
  • +
+ +
+
+ +

additionalLogger

+
    +
  • additionalLogger(name: string): Logger
  • +
+ +
+
+ +

profileManager

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeconfig.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeconfig.html new file mode 100644 index 0000000000..ca9f0f3fc6 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeconfig.html @@ -0,0 +1,1048 @@ + + + + + + ImperativeConfig | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ImperativeConfig

+
+
+
+
+
+
+
+
+
+

This class is used to contain all configuration being set by Imperative. + It is a singleton and should be accessed via ImperativeConfig.instance.

+
+
+
+
+

Hierarchy

+
    +
  • + ImperativeConfig +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Private mCallerLocation

+
mCallerLocation: string = null
+ +
+
+

This parameter is used to contain the caller location of imperative configuration file.

+
+
+
+
+ +

Private mCommandLine

+
mCommandLine: string
+ +
+
+

Current command needed for processing

+
+
+
+
+ +

Private mConfig

+
mConfig: Config
+ +
+
+

The config object

+
+
+
+
+ +

Private mDaemonContext

+
mDaemonContext: IDaemonContext
+ +
+
+

This is the daemon context needed to pass to yargs.fail() in the event that we cannot extract + context through a yargs.parse() call.

+
+
+
memberof
+

ImperativeConfig

+
+
+
+
+
+ +

Private mHostPackageName

+
mHostPackageName: string
+ +
+
+

This is the package name of the host application. It will only be set once accessed to + lessen loads to the host package.json.

+
+
+
+
+ +

Private mImperativePackageName

+
mImperativePackageName: string
+ +
+
+

This is the name of our imperative package. It will only be set once accessed to + lessen loads to the imperative package.json.

+
+

It isn't hardcoded so that the name of our package can change without affecting + modules dependent on it.

+
+
+
+ +

Private mLoadedConfig

+
mLoadedConfig: IImperativeConfig = null
+ +
+
+

This parameter is used as the container of all loaded configuration for + Imperative.

+
+
+
+
+ +

Private mRootCommandName

+
mRootCommandName: string
+ +
+
+

This is our calling CLI's command name (taken from package.json: bin).

+
+
+
+
+ +

Static Private mInstance

+
mInstance: ImperativeConfig = null
+ +
+
+

This is the variable that stores the specific instance of Imperative Config. + Defined as static so that it can be accessed from anywhere.

+
+
+
+
+
+

Accessors

+
+ +

callerLocation

+
    +
  • get callerLocation(): string
  • +
  • set callerLocation(location: string): void
  • +
+ +
+
+ +

callerPackageJson

+
    +
  • get callerPackageJson(): any
  • +
+ +
+
+ +

cliHome

+
    +
  • get cliHome(): string
  • +
+ +
+
+ +

commandLine

+
    +
  • get commandLine(): string
  • +
  • set commandLine(args: string): void
  • +
+ +
+
+ +

config

+ + +
+
+ +

daemonContext

+ + +
+
+ +

envVariablePrefix

+
    +
  • get envVariablePrefix(): string
  • +
+
    +
  • + +
    +
    +

    Get the configured environmental variable prefix for the user's CLI

    +
    +
    +

    Returns string

    +
      +
    • the configured or default prefix for environmental variables for use in the environmental variable service
    • +
    +
  • +
+
+
+ +

hostPackageName

+
    +
  • get hostPackageName(): string
  • +
+ +
+
+ +

imperativePackageName

+
    +
  • get imperativePackageName(): string
  • +
+ +
+
+ +

loadedConfig

+ + +
+
+ +

profileDir

+
    +
  • get profileDir(): string
  • +
+ +
+
+ +

profileSchemas

+
    +
  • get profileSchemas(): {}
  • +
+ +
+
+ +

rootCommandName

+
    +
  • get rootCommandName(): string
  • +
  • set rootCommandName(rootCommandName: string): void
  • +
+ +
+
+ +

Static instance

+ +
    +
  • + +
    +
    +

    Gets a single instance of the PluginIssues. On the first call of + ImperativeConfig.instance, a new Plugin Issues object is initialized and returned. + Every subsequent call will use the one that was first created.

    +
    +
    +

    Returns ImperativeConfig

    +

    The newly initialized PMF object.

    +
  • +
+
+
+
+

Methods

+
+ +

findPackageBinName

+
    +
  • findPackageBinName(): string
  • +
+ +
+
+ +

getCallerFile

+
    +
  • getCallerFile(file: string): any
  • +
+
    +
  • + +
    +
    +

    Require a file from a project using imperative accounting for imperative being contained + separately from the current implementers directory.

    +
    +
    +

    Parameters

    +
      +
    • +
      file: string
      +
      +

      the file to require from project using imperative

      +
      +
    • +
    +

    Returns any

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
  • Accessor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeerror.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeerror.html new file mode 100644 index 0000000000..01c0c339c3 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeerror.html @@ -0,0 +1,622 @@ + + + + + + ImperativeError | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ImperativeError

+
+
+
+
+
+
+
+
+
+
export
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

mDetails

+ + +
+
+ +

Private mMessage

+
mMessage: string
+ +
+
+

The message generated/specified for the error - used for display/message/diagnostic purposes

+
+
+
memberof
+

ImperativeError

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+ +

Static Error

+
Error: ErrorConstructor
+ +
+
+
+

Accessors

+
+ +

additionalDetails

+
    +
  • get additionalDetails(): string
  • +
+ +
+
+ +

causeErrors

+
    +
  • get causeErrors(): any
  • +
+ +
+
+ +

details

+ + +
+
+ +

errorCode

+
    +
  • get errorCode(): string
  • +
+ +
+
+ +

message

+
    +
  • get message(): string
  • +
+ +
+
+ +

stack

+
    +
  • get stack(): string
  • +
+ +
+
+ +

suppressDump

+
    +
  • get suppressDump(): boolean
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Property
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited property
  • +
+
    +
  • Private property
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeexpect.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeexpect.html new file mode 100644 index 0000000000..011a2bab0b --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeexpect.html @@ -0,0 +1,1025 @@ + + + + + + ImperativeExpect | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ImperativeExpect

+
+
+
+
+
+
+
+
+
+

Helper class for paramter validation. Expectations that fail will throw an ImperativeError with a validation + error message.

+
+

All methods allow keys to be specified as "property1.prop.lastprop" for example.

+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ImperativeExpect +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly ERROR_TAG

+
ERROR_TAG: string = "Expect Error"
+ +
+
+

The error tag to append to each error message.

+
+
+
static
+
+
memberof
+

ImperativeExpect

+
+
+
+
+
+
+

Methods

+
+ +

Static arrayToContain

+
    +
  • arrayToContain(arr: any[], compare: (entry: any) => boolean, msg?: string): any
  • +
+
    +
  • + +
    +
    +

    Expect the object passed to be an array that contains a particular entry. + Your compare method is invoked to determine if the entry you're looking for is found within the array.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ImperativeExpect

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      arr: any[]
      +
      +

      the array to search

      +
      +
    • +
    • +
      compare: (entry: any) => boolean
      +
      +

      compare method (passed the parms) - return true if the entry is + found within the array.

      +
      +
        +
      • +
          +
        • (entry: any): boolean
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            entry: any
            +
          • +
          +

          Returns boolean

          +
        • +
        +
      • +
      +
    • +
    • +
      Optional msg: string
      +
    • +
    +

    Returns any

    +
      +
    • If a match is found, it will return the match.
    • +
    +
  • +
+
+
+ +

Static expectAndTransform

+
    +
  • expectAndTransform(expect: () => void, transform: (error: any) => ImperativeError): void
  • +
+
    +
  • + +
    +
    +

    Expect a situation and transform the error (if expect fails). + Accepts two methods of your implementation to: + A) Test the expect (which is intended to throw an ImperativeError) + B) Transform and return a new ImperativeError + This allows you complete control over the contents of the error. If you are only interested in influencing the + message displayed, then use the msg parm on each of the expect functions.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ImperativeExpect

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      expect: () => void
      +
      +

      The method that contains your ImperativeExpect invocation

      +
      +
        +
      • +
          +
        • (): void
        • +
        +
          +
        • +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    • +
      transform: (error: any) => ImperativeError
      +
      +

      Passed the error thrown by the expect and expects you + to return the ImperativeError you would like thrown.

      +
      + +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static keysToBeAnArray

+
    +
  • keysToBeAnArray(obj: {} | any, nonZeroLength: boolean, keys: string[], msg?: string): void
  • +
+
    +
  • + +
    +
    +

    Expect a set of keys (by name) to be defined, of type array, and optionally a non-zero length array.

    +
    +
    +
    static
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      obj: {} | any
      +
      +

      the object for which you would like to assert that certain fields

      +
      +
    • +
    • +
      nonZeroLength: boolean
      +
      +

      if true, the length of the array must be non zero

      +
      +
    • +
    • +
      keys: string[]
      +
      +

      keys in object that should be arrays

      +
      +
    • +
    • +
      Optional msg: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static keysToBeDefined

+
    +
  • keysToBeDefined(obj: {} | any, keys: string[], msg?: string): void
  • +
+
    +
  • + +
    +
    +

    Expect a set of keys (by name) are defined.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ImperativeExpect

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      obj: {} | any
      +
      +

      object to test existence

      +
      +
    • +
    • +
      keys: string[]
      +
      +

      keys in object

      +
      +
    • +
    • +
      Optional msg: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static keysToBeDefinedAndNonBlank

+
    +
  • keysToBeDefinedAndNonBlank(obj: {} | any, keys: string[], msg?: string): void
  • +
+
    +
  • + +
    +
    +

    Expect that a set of keys are defined, of type string, and are non-blank (after trimming).

    +
    +
    +
    static
    +
    +
    memberof
    +

    ImperativeExpect

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      obj: {} | any
      +
      +

      object to test existence

      +
      +
    • +
    • +
      keys: string[]
      +
      +

      keys in object

      +
      +
    • +
    • +
      Optional msg: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static keysToBeOfType

+
    +
  • keysToBeOfType(obj: {} | any, type: string, keys: string[], msg?: string): void
  • +
+
    +
  • + +
    +
    +

    Expect a set of keys to be of a certain type.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ImperativeExpect

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      obj: {} | any
      +
      +

      The input object

      +
      +
    • +
    • +
      type: string
      +
      +

      The type to check for (only primatives - uses "typeof")

      +
      +
    • +
    • +
      keys: string[]
      +
      +

      A list of keys to check in the object

      +
      +
    • +
    • +
      Optional msg: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static keysToBeUndefined

+
    +
  • keysToBeUndefined(obj: {}, keys: string[], msg?: string): void
  • +
+
    +
  • + +
    +
    +

    Expect a set of keys to be undefined.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ImperativeExpect

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      obj: {}
      +
      +

      object to test existence

      +
      +
        +
      • +
        [key: string]: any
        +
      • +
      +
    • +
    • +
      keys: string[]
      +
      +

      keys in object

      +
      +
    • +
    • +
      Optional msg: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static toBeAnArray

+
    +
  • toBeAnArray(arr: any[], msg?: string): void
  • +
+
    +
  • + +
    +
    +

    Check if the input object is an array.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ImperativeExpect

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      arr: any[]
      +
      +

      The array to check

      +
      +
    • +
    • +
      Optional msg: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static toBeDefinedAndNonBlank

+
    +
  • toBeDefinedAndNonBlank(item: string, label: string, msg?: string): void
  • +
+ +
+
+ +

Static toBeEqual

+
    +
  • toBeEqual(value1: any, value2: any, msg?: string): void
  • +
+
    +
  • + +
    +
    +

    Expect that values are equal (via "!==" operator).

    +
    +
    +
    static
    +
    +
    memberof
    +

    ImperativeExpect

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      value1: any
      +
      +

      Value 1

      +
      +
    • +
    • +
      value2: any
      +
      +

      Value 2

      +
      +
    • +
    • +
      Optional msg: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static toBeOneOf

+
    +
  • toBeOneOf(value: any, arr: any[], msg?: string): any
  • +
+
    +
  • + +
    +
    +

    Check if the input is one of several possibilities in a list.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ImperativeExpect

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      value: any
      +
      +

      The value to find in following array

      +
      +
    • +
    • +
      arr: any[]
      +
      +

      The array of possible items we could be expecting

      +
      +
    • +
    • +
      Optional msg: string
      +
    • +
    +

    Returns any

    +
      +
    • If a match is found, it will return the match.
    • +
    +
  • +
+
+
+ +

Static toMatchRegExp

+
    +
  • toMatchRegExp(value: any, myRegex: string, msg?: string): void
  • +
+
    +
  • + +
    +
    +

    Expect that value matches the regular expression (via ".test()" method).

    +
    +
    +
    static
    +
    +
    memberof
    +

    ImperativeExpect

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      value: any
      +
      +

      Value

      +
      +
    • +
    • +
      myRegex: string
      +
      +

      Regular expression

      +
      +
    • +
    • +
      Optional msg: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static toNotBeEqual

+
    +
  • toNotBeEqual(value1: any, value2: any, msg?: string): void
  • +
+
    +
  • + +
    +
    +

    Expect two values to be equal (via "===" operator).

    +
    +
    +
    static
    +
    +
    memberof
    +

    ImperativeExpect

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      value1: any
      +
      +

      Value 1

      +
      +
    • +
    • +
      value2: any
      +
      +

      Value 2

      +
      +
    • +
    • +
      Optional msg: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static toNotBeNullOrUndefined

+
    +
  • toNotBeNullOrUndefined(obj: any, msg?: string): void
  • +
+
    +
  • + +
    +
    +

    Expect the object passed to be defined.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ImperativeExpect

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      obj: any
      +
      +

      The object to check

      +
      +
    • +
    • +
      Optional msg: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativehelpgeneratorfactory.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativehelpgeneratorfactory.html new file mode 100644 index 0000000000..22257e8edd --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativehelpgeneratorfactory.html @@ -0,0 +1,603 @@ + + + + + + ImperativeHelpGeneratorFactory | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ImperativeHelpGeneratorFactory

+
+
+
+
+
+
+
+
+
+

Imperative Help generator factory passed to yargs to build help generators where needed.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mConfig

+ + +
+
+

The imperative configuration object contains control parameters for the help generator factorys

+
+
+
memberof
+

ImperativeHelpGeneratorFactory

+
+
+
+
+
+
+

Accessors

+
+ +

Private config

+ + +
+
+ +

Protected factoryParameters

+ + +
+
+ +

Protected primaryHighlightColor

+
    +
  • get primaryHighlightColor(): string
  • +
+ +
+
+ +

Protected produceMarkdown

+
    +
  • get produceMarkdown(): boolean
  • +
+ +
+
+ +

Protected rootCommandName

+
    +
  • get rootCommandName(): string
  • +
+ +
+
+
+

Methods

+
+ +

Protected getGenerator

+ + +
+
+ +

getHelpGenerator

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited method
  • +
+
    +
  • Protected method
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeprofilemanagerfactory.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeprofilemanagerfactory.html new file mode 100644 index 0000000000..306ee85186 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.imperativeprofilemanagerfactory.html @@ -0,0 +1,346 @@ + + + + + + ImperativeProfileManagerFactory | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ImperativeProfileManagerFactory

+
+
+
+
+
+
+
+
+
+

The imperative profile manager factory returns instances of the cli profile manager

+
+
+
export
+
+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mImperativeApi

+
mImperativeApi: ImperativeApi
+ +
+
+
+

Methods

+
+ +

getManager

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.importhandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.importhandler.html new file mode 100644 index 0000000000..e4e245de6f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.importhandler.html @@ -0,0 +1,411 @@ + + + + + + ImportHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ImportHandler

+
+
+
+
+
+
+
+
+
+

Import config

+
+
+
+
+

Hierarchy

+
    +
  • + ImportHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Private params

+ + +
+
+
+

Methods

+
+ +

Private buildSession

+
    +
  • buildSession(url: URL): Session
  • +
+ +
+
+ +

Private downloadSchema

+
    +
  • downloadSchema(url: URL, filePath: string): Promise<void>
  • +
+ +
+
+ +

Private fetchConfig

+ + +
+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.inithandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.inithandler.html new file mode 100644 index 0000000000..ea70308567 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.inithandler.html @@ -0,0 +1,446 @@ + + + + + + InitHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class InitHandler

+
+
+
+
+
+
+
+
+
+

Init config

+
+
+
+
+

Hierarchy

+
    +
  • + InitHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Private params

+ + +
+
+ +

Private promptProps

+
promptProps: string[]
+ +
+
+

List of property names that have been prompted for.

+
+
+
+
+
+

Methods

+
+ +

Private initForDryRun

+ + +
+
+ +

Private initWithSchema

+
    +
  • initWithSchema(config: Config, user: boolean, overwrite: boolean): Promise<void>
  • +
+ +
+
+ +

process

+ + +
+
+ +

Private promptForProp

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.installhandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.installhandler.html new file mode 100644 index 0000000000..d6a2e518cc --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.installhandler.html @@ -0,0 +1,308 @@ + + + + + + InstallHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class InstallHandler

+
+
+
+
+
+
+
+
+
+

The install command handler for cli plugin install.

+
+
+
see
+

{installDefinition}

+
+
+
+
+
+

Hierarchy

+
    +
  • + InstallHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Private console

+
console: Logger = Logger.getImperativeLogger()
+ +
+
+

A logger for this class

+
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.invalidcredentialmanager.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.invalidcredentialmanager.html new file mode 100644 index 0000000000..22a443daa5 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.invalidcredentialmanager.html @@ -0,0 +1,683 @@ + + + + + + InvalidCredentialManager | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class InvalidCredentialManager

+
+
+
+
+
+
+
+
+
+

NOTE THIS CLASS SHOULD NOT BE EXPORTED FOR PUBLIC CONSUMPTION.

+
+

This class is the fallback class when a credential manager fails to initialize. + All methods in this class must throw te error passed in by the constructor.

+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private Readonly causeError

+
causeError: Error
+ +
+
+

The load failure that has occurred

+
+
+
+
+ +

Protected Readonly service

+
service: string
+ +
+
+

A service that needs to be passed to the superclass

+
+
+
+
+
+

Accessors

+
+ +

name

+
    +
  • get name(): string
  • +
+ +
+
+ +

Protected possibleSolutions

+
    +
  • get possibleSolutions(): string[] | undefined
  • +
+ +
+
+
+

Methods

+
+ +

delete

+
    +
  • delete(account: string): Promise<void>
  • +
+ +
+
+ +

Protected deleteCredentials

+
    +
  • deleteCredentials(account: string): Promise<void>
  • +
+ +
+
+ +

Optional initialize

+ + +
+
+ +

load

+
    +
  • load(account: string, optional?: boolean): Promise<string>
  • +
+ +
+
+ +

Protected loadCredentials

+ + +
+
+ +

save

+
    +
  • save(account: string, secureValue: string): Promise<void>
  • +
+ +
+
+ +

Protected saveCredentials

+ + +
+
+ +

secureErrorDetails

+
    +
  • secureErrorDetails(): string | undefined
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Protected property
  • +
  • Protected method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited method
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.io.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.io.html new file mode 100644 index 0000000000..463ea8c8c7 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.io.html @@ -0,0 +1,1328 @@ + + + + + + IO | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class IO

+
+
+
+
+
+
+
+
+
+

This class will handle common sequences of node I/O and issue messages / + throw errors as neccessary.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + IO +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly FILE_DELIM

+
FILE_DELIM: string = "/"
+ +
+
+

File delimiter

+
+
+
static
+
+
memberof
+

IO

+
+
+
+
+
+ +

Static Readonly OS_LINUX

+
OS_LINUX: "linux" = "linux"
+ +
+
+

Linux OS identifier

+
+
+
static
+
+
memberof
+

IO

+
+
+
+
+
+ +

Static Readonly OS_MAC

+
OS_MAC: "darwin" = "darwin"
+ +
+
+

Mac OS identifier

+
+
+
static
+
+
memberof
+

IO

+
+
+
+
+
+ +

Static Readonly OS_WIN32

+
OS_WIN32: "win32" = "win32"
+ +
+
+

Windows OS identifier

+
+
+
static
+
+
memberof
+

IO

+
+
+
+
+
+ +

Static Readonly UTF8

+
UTF8: "utf8" = "utf8"
+ +
+
+

UTF8 identifier

+
+
+
static
+
+
memberof
+

IO

+
+
+
+
+
+
+

Methods

+
+ +

Static createDirSync

+
    +
  • createDirSync(dir: string): void
  • +
+
    +
  • + +
    +
    +

    Create a directory if it does not yet exist synchronously.

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      dir: string
      +
      +

      directory to create

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static createDirsSync

+
    +
  • createDirsSync(dir: string): void
  • +
+
    +
  • + +
    +
    +

    Create all needed directories for an input directory in the form of: + first/second/third where first will contain director second and second + will contain directory third

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      dir: string
      +
      +

      directory to create all sub directories for

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static createDirsSyncFromFilePath

+
    +
  • createDirsSyncFromFilePath(filePath: string): void
  • +
+
    +
  • + +
    +
    +

    Create all necessary directories for a fully qualified file and its path, + for example, if filePath = oneDir/twoDir/threeDir/file.txt, + oneDir, twoDir, and threeDir will be created.

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      filePath: string
      +
    • +
    +

    Returns void

    +

    [description]

    +
  • +
+
+
+ +

Static createFileSync

+
    +
  • createFileSync(file: string): void
  • +
+
    +
  • + +
    +
    +

    Create a file

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      file: string
      +
      +

      file to create

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static createReadStream

+
    +
  • createReadStream(file: string): Readable
  • +
+
    +
  • + +
    +
    +

    Create a Node.js Readable stream from a file

    +
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      file: string
      +
      +

      the file from which to create a read stream

      +
      +
    • +
    +

    Returns Readable

    +

    Buffer - the content of the file

    +
  • +
+
+
+ +

Static createSymlinkToDir

+
    +
  • createSymlinkToDir(newSymLinkPath: string, existingDirPath: string): void
  • +
+
    +
  • + +
    +
    +

    Create a symbolic link to a directory. If the symbolic link already exists, + re-create it with the specified target directory.

    +
    +
    +

    Parameters

    +
      +
    • +
      newSymLinkPath: string
      +
      +

      the path new symbolic link to be created

      +
      +
    • +
    • +
      existingDirPath: string
      +
      +

      the path the existing directory that we will link to

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static createWriteStream

+
    +
  • createWriteStream(file: string): Writable
  • +
+
    +
  • + +
    +
    +

    Create a Node.js Readable stream from a file

    +
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      file: string
      +
      +

      the file from which to create a read stream

      +
      +
    • +
    +

    Returns Writable

    +

    Buffer - the content of the file

    +
  • +
+
+
+ +

Static deleteDir

+
    +
  • deleteDir(dir: string): void
  • +
+ +
+
+ +

Static deleteDirTree

+
    +
  • deleteDirTree(pathToTreeToDelete: string): void
  • +
+
    +
  • + +
    +
    +

    Recursively delete all files and subdirectories of the specified directory. + Ensure that we do not follow a symlink. Just delete the link.

    +
    +
    +
    params
    +

    {string} pathToTreeToDelete - Path to top directory of the tree + to delete.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      pathToTreeToDelete: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static deleteFile

+
    +
  • deleteFile(file: string): void
  • +
+ +
+
+ +

Static deleteSymLink

+
    +
  • deleteSymLink(symLinkPath: string): void
  • +
+
    +
  • + +
    +
    +

    Delete a symbolic link.

    +
    +
    +

    Parameters

    +
      +
    • +
      symLinkPath: string
      +
      +

      the path to a symbolic link to be deleted

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static existsSync

+
    +
  • existsSync(file: string): boolean
  • +
+
    +
  • + +
    +
    +

    Wraps fs.existsSync so that we dont have to import fs unnecessarily

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      file: string
      +
      +

      file to validate existence against

      +
      +
    • +
    +

    Returns boolean

    +

    true if file exists

    +
  • +
+
+
+ +

Static getDefaultTextEditor

+
    +
  • getDefaultTextEditor(): string
  • +
+
    +
  • + +
    +
    +

    Get default text editor for a given operating system

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Returns string

    +
      +
    • text editor launch string
    • +
    +
  • +
+
+
+ +

Static giveAccessOnlyToOwner

+
    +
  • giveAccessOnlyToOwner(fileName: string): void
  • +
+
    +
  • + +
    +
    +

    Set file access permissions so that only the current user will have access to the file. + On windows, it means "full control" for the current user. + On posix, it means read & write access for the current user. + Obviously, the current user must have permission to change permissions + on the specified file.

    +
    +
    +
    throws
    +

    An ImperativeError when the operation fails.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      fileName: string
      +
      +

      file name for which we modify access.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static isDir

+
    +
  • isDir(dirOrFile: string): boolean
  • +
+
    +
  • + +
    +
    +

    Return whether input file is a directory or file

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      dirOrFile: string
      +
      +

      file path

      +
      +
    • +
    +

    Returns boolean

    +
      +
    • true if file path is a directory, false otherwise
    • +
    +
  • +
+
+
+ +

Static mkdirp

+
    +
  • mkdirp(dir: string): void
  • +
+
    +
  • + +
    +
    +

    Uses the fs-extra package to create a directory (and all subdirectories)

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      dir: string
      +
      +

      the directory (do not include a file name)

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static normalizeExtension

+
    +
  • normalizeExtension(extension: string): string
  • +
+
    +
  • + +
    +
    +

    Take an extension and prefix with a '.' identifier

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      extension: string
      +
      +

      extension to normalize

      +
      +
    • +
    +

    Returns string

    +
      +
    • '.bin' for input 'bin' for example
    • +
    +
  • +
+
+
+ +

Static processNewlines

+
    +
  • processNewlines(original: string, lastByte?: number): string
  • +
+
    +
  • + +
    +
    +

    Process a string so that its line endings are operating system + appropriate before you save it to disk + (basically, if the user is on Windows, change \n to \r\n)

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      original: string
      +
      +

      original input

      +
      +
    • +
    • +
      Optional lastByte: number
      +
      +

      last byte of previous input, if it is being processed in chunks

      +
      +
    • +
    +

    Returns string

    +
      +
    • input with removed newlines
    • +
    +
  • +
+
+
+ +

Static readFileSync

+
    +
  • readFileSync(file: string, normalizeNewLines?: boolean, binary?: boolean): Buffer
  • +
+
    +
  • + +
    +
    +

    Wraps fs.readFileSync so that we dont have to import fs unnecessarily + or specify encoding.

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      file: string
      +
      +

      file to read

      +
      +
    • +
    • +
      Default value normalizeNewLines: boolean = false
      +
      +

      remove Windows line endings (\r\n) in favor of \n

      +
      +
    • +
    • +
      Default value binary: boolean = false
      +
      +

      should the file be read in binary mode? If so, normalizeNewLines is ignored. If false, + the file will be read in UTF-8 encoding

      +
      +
    • +
    +

    Returns Buffer

    +

    Buffer - the content of the file

    +
  • +
+
+
+ +

Static writeFile

+
    +
  • writeFile(file: string, content: Buffer): void
  • +
+
    +
  • + +
    +
    +

    Write a file

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      file: string
      +
      +

      file to create

      +
      +
    • +
    • +
      content: Buffer
      +
      +

      content to write

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static writeFileAsync

+
    +
  • writeFileAsync(file: string, content: string): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Create a file asynchronously

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      file: string
      +
      +

      file to create

      +
      +
    • +
    • +
      content: string
      +
      +

      content to write in the file

      +
      +
    • +
    +

    Returns Promise<void>

    +

    [description]

    +
  • +
+
+
+ +

Static writeObject

+
    +
  • writeObject(configFile: string, object: object): void
  • +
+
    +
  • + +
    +
    +

    Write an object to a file and set consistent formatting on the serialized + JSON object.

    +
    +
    +
    static
    +
    +
    memberof
    +

    IO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      configFile: string
      +
      +

      file to create

      +
      +
    • +
    • +
      object: object
      +
      +

      object to serialize

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.jsonsettingsfilepersistence.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.jsonsettingsfilepersistence.html new file mode 100644 index 0000000000..94a2066e48 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.jsonsettingsfilepersistence.html @@ -0,0 +1,349 @@ + + + + + + JSONSettingsFilePersistence | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class JSONSettingsFilePersistence

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + JSONSettingsFilePersistence +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private Readonly path

+
path: string
+ +
+
+ +

Private Readonly settingsFile

+
settingsFile: string
+ +
+
+
+

Methods

+
+ +

read

+ + +
+
+ +

write

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.jsonutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.jsonutils.html new file mode 100644 index 0000000000..3b3cd8be77 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.jsonutils.html @@ -0,0 +1,283 @@ + + + + + + JSONUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class JSONUtils

+
+
+
+
+
+
+
+
+
+

JSON utility to wrap and throw ImperativeErrors

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + JSONUtils +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static parse

+
    +
  • parse<T>(data: string, failMessage?: string): T
  • +
+
    +
  • + +
    +
    +

    Throw imperative error or return parsed data

    +
    +
    +
    throws
    +

    {ImperativeError} When there was a failure trying to parse a non-zero length data string.

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      T: object

      +
      +

      type to parse

      +
      +
    • +
    +

    Parameters

    +
      +
    • +
      data: string
      +
      +

      string input data to parse as JSON

      +
      +
    • +
    • +
      Optional failMessage: string
      +
    • +
    +

    Returns T

    +
      +
    • parsed object. If data length is 0 then this method will return a null object
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.jsutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.jsutils.html new file mode 100644 index 0000000000..55e06f2d98 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.jsutils.html @@ -0,0 +1,296 @@ + + + + + + JsUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class JsUtils

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + JsUtils +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static isObjEmpty

+
    +
  • isObjEmpty(objToTest: object): boolean
  • +
+
    +
  • + +
    +
    +

    Is the supplied object empty.

    +
    +
    +

    Parameters

    +
      +
    • +
      objToTest: object
      +
      +

      The object to test.

      +
      +
    • +
    +

    Returns boolean

    +
      +
    • True if empty. False otherwise.
    • +
    +
  • +
+
+
+ +

Static isUrl

+
    +
  • isUrl(urlString: string): boolean
  • +
+
    +
  • + +
    +
    +

    Is the supplied string a URL.

    +
    +
    +

    Parameters

    +
      +
    • +
      urlString: string
      +
      +

      The string to test.

      +
      +
    • +
    +

    Returns boolean

    +
      +
    • True if it is a URL. False otherwise.
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.listhandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.listhandler.html new file mode 100644 index 0000000000..5c197bbcbf --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.listhandler.html @@ -0,0 +1,265 @@ + + + + + + ListHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ListHandler

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ListHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.listprofileshandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.listprofileshandler.html new file mode 100644 index 0000000000..9335de8731 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.listprofileshandler.html @@ -0,0 +1,265 @@ + + + + + + ListProfilesHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ListProfilesHandler

+
+
+
+
+
+
+
+
+
+

Handler for the auto-generated list profiles command.

+
+
+
+
+

Hierarchy

+
    +
  • + ListProfilesHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.logger.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.logger.html new file mode 100644 index 0000000000..9c679bcb12 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.logger.html @@ -0,0 +1,1133 @@ + + + + + + Logger | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Logger

+
+
+
+
+
+
+
+
+
+

Note(Kelosky): it seems from the log4js doc that you only get a single + instance of log4js per category. To reconfigure, you should "shutdown" logger.

+
+
+
+
+

Hierarchy

+
    +
  • + Logger +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new Logger(mJsLogger: log4js.Logger | Console, category?: string): Logger
  • +
+ +
+
+
+

Properties

+
+ +

Private Optional category

+
category: string
+ +
+
+ +

Private initStatus

+
initStatus: boolean
+ +
+
+

This flag is being used to monitor the log4js configure status.

+
+
+
+
+ +

Private mJsLogger

+
mJsLogger: log4js.Logger | Console
+ +
+
+ +

Static Readonly DEFAULT_APP_NAME

+
DEFAULT_APP_NAME: "app" = "app"
+ +
+
+ +

Static Readonly DEFAULT_CONSOLE_NAME

+
DEFAULT_CONSOLE_NAME: "console" = "console"
+ +
+
+ +

Static Readonly DEFAULT_IMPERATIVE_NAME

+
DEFAULT_IMPERATIVE_NAME: "imperative" = "imperative"
+ +
+
+ +

Static Readonly DEFAULT_VALID_LOG_LEVELS

+
DEFAULT_VALID_LOG_LEVELS: string[] = ["ALL", "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "MARK", "OFF"]
+ +
+
+
+

Accessors

+
+ +

level

+
    +
  • get level(): string
  • +
  • set level(level: string): void
  • +
+ +
+
+ +

Private logService

+
    +
  • get logService(): any
  • +
  • set logService(service: log4js.Logger | Console): void
  • +
+
    +
  • + +
    +
    +

    Get underlying logger service

    +
    +

    This function also check to see if log4js is configured since the last time it + was called. If yes, then update the logger with to leverage the new configuration.

    +
    +

    Returns any

    +
  • +
  • + +
    +
    +

    Set underlying logger service

    +
    +

    This function also check to see if log4js is configured since the last time it + was called. If yes, then update the logger with to leverage the new configuration.

    +
    +

    Parameters

    +
      +
    • +
      service: log4js.Logger | Console
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+

Methods

+
+ +

debug

+
    +
  • debug(message: string, ...args: any[]): string
  • +
+
    +
  • + +
    +
    +

    Log a message at the "debug" level + Example: 'Got cheese'

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      printf or mustache style template string, or a plain string message

      +
      +
    • +
    • +
      Rest ...args: any[]
      +
      +

      printf or mustache style args

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

error

+
    +
  • error(message: string, ...args: any[]): string
  • +
+
    +
  • + +
    +
    +

    Log a message at the "error" level + Example: 'Cheese is too ripe!'

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      printf or mustache style template string, or a plain string message

      +
      +
    • +
    • +
      Rest ...args: any[]
      +
      +

      printf or mustache style args

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

fatal

+
    +
  • fatal(message: string, ...args: any[]): string
  • +
+
    +
  • + +
    +
    +

    Log a message at the "fatal" level + Example: 'Cheese was breeding ground for listeria.'

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      printf or mustache style template string, or a plain string message

      +
      +
    • +
    • +
      Rest ...args: any[]
      +
      +

      printf or mustache style args

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

Private getCallerFileAndLineTag

+
    +
  • getCallerFileAndLineTag(): string
  • +
+
    +
  • + +
    +
    +

    Obtain .js file name and line number which issued the log message. + NOTE(Kelosky): Consensus seems to be that this may produce a lot of overhead + by creating an Error and obtaining stack information for EVERY log message + that is issued.

    +
    +

    There are also packages available to obtain the appropriate line number.

    +

    Perhaps when a package pops up that gives the appropriate .ts line number + and file name, we'll remove usage of this method.

    +
    +

    Returns string

    +
      +
    • file and line number
    • +
    +
  • +
+
+
+ +

info

+
    +
  • info(message: string, ...args: any[]): string
  • +
+
    +
  • + +
    +
    +

    Log a message at the "info" level + Example: 'Cheese is Gouda'

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      printf or mustache style template string, or a plain string message

      +
      +
    • +
    • +
      Rest ...args: any[]
      +
      +

      printf or mustache style args

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

logError

+ + +
+
+ +

simple

+
    +
  • simple(message: string, ...args: any[]): string
  • +
+
    +
  • + +
    +
    +

    Log a message without CallerFileAndLineTag + Example: 'Cheese that is plain'

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      printf or mustache style template string, or a plain string message

      +
      +
    • +
    • +
      Rest ...args: any[]
      +
      +

      printf or mustache style args

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

trace

+
    +
  • trace(message: string, ...args: any[]): string
  • +
+
    +
  • + +
    +
    +

    Log a message at the "trace" level + Example: 'Entering cheese testing'

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      printf style template string, or a plain string message

      +
      +
    • +
    • +
      Rest ...args: any[]
      +
      +

      printf style args

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

warn

+
    +
  • warn(message: string, ...args: any[]): string
  • +
+
    +
  • + +
    +
    +

    Log a message at the "warn" level + Example: 'Cheese is quite smelly.'

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      printf or mustache style template string, or a plain string message

      +
      +
    • +
    • +
      Rest ...args: any[]
      +
      +

      printf or mustache style args

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

Static getAppLogger

+ + +
+
+ +

Static getConsoleLogger

+
    +
  • getConsoleLogger(): Logger
  • +
+
    +
  • + +
    +
    +

    Return an instance to the console logger which applies TextUtils invoked + through this Logger class.

    +
    +

    Note(Kelosky): this is not the same as obtaining a new Console() directly, + since we can make use of the internationalization and other routines + within this Logger class via this implementation.

    +
    +

    Returns Logger

    +
      +
    • instance of logger set to our app's category
    • +
    +
  • +
+
+
+ +

Static getImperativeLogger

+
    +
  • getImperativeLogger(): Logger
  • +
+
    +
  • + +
    +
    +

    Get accessibility to logging service to invoke log calls, e.g + Logger.getLogger.info("important log info goes here");

    +
    +
    +

    Returns Logger

    +
      +
    • instance of logger set to our app's category
    • +
    +
  • +
+
+
+ +

Static getLoggerCategory

+
    +
  • getLoggerCategory(category: string): Logger
  • +
+
    +
  • + +
    +
    +

    Get accessibility to logging service to invoke log calls, e.g + Logger.getLogger.info("important log info goes here");

    +
    +
    +

    Parameters

    +
      +
    • +
      category: string
      +
      +

      category of logger to obtain

      +
      +
    • +
    +

    Returns Logger

    +
      +
    • instance of logger set to our app's category
    • +
    +
  • +
+
+
+ +

Static initLogger

+ + +
+
+ +

Static isValidLevel

+
    +
  • isValidLevel(testLevel: string): boolean
  • +
+
    +
  • + +
    +
    +

    Test if the input level is a valid value for Log4js.

    +
    +
    +

    Parameters

    +
      +
    • +
      testLevel: string
      +
      +

      input level to be tested

      +
      +
    • +
    +

    Returns boolean

    +
      +
    • status if the input level is valid
    • +
    +
  • +
+
+
+ +

Static setLogInMemory

+
    +
  • setLogInMemory(status: boolean, maxQueueSize?: number): void
  • +
+ +
+
+ +

Static writeInMemoryMessages

+
    +
  • writeInMemoryMessages(file: string): void
  • +
+
    +
  • + +
    +
    +

    Write all messages that was stored in memory to the input file.

    +
    +
    +

    Parameters

    +
      +
    • +
      file: string
      +
      +

      destination file name

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
  • Accessor
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
  • Private accessor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.loggerconfigbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.loggerconfigbuilder.html new file mode 100644 index 0000000000..74a3669b09 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.loggerconfigbuilder.html @@ -0,0 +1,631 @@ + + + + + + LoggerConfigBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class LoggerConfigBuilder

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + LoggerConfigBuilder +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly DEFAULT

+
DEFAULT: "default" = "default"
+ +
+
+ +

Static Readonly DEFAULT_BACKEND

+
DEFAULT_BACKEND: "NONE" = "NONE"
+ +
+
+ +

Static Readonly DEFAULT_COLOR_LAYOUT

+
DEFAULT_COLOR_LAYOUT: string = "%[" + LoggerConfigBuilder.DEFAULT_LOG_LAYOUT + "%]"
+ +
+
+ +

Static Readonly DEFAULT_LANG

+
DEFAULT_LANG: "en" = "en"
+ +
+
+ +

Static Readonly DEFAULT_LOG_DIR

+
DEFAULT_LOG_DIR: string = IO.FILE_DELIM
+ +
+
+ +

Static Readonly DEFAULT_LOG_FILE_BACKUPS

+
DEFAULT_LOG_FILE_BACKUPS: 5 = 5
+ +
+
+ +

Static Readonly DEFAULT_LOG_FILE_DIR

+
DEFAULT_LOG_FILE_DIR: string = "logs" + IO.FILE_DELIM
+ +
+
+ +

Static Readonly DEFAULT_LOG_FILE_EXT

+
DEFAULT_LOG_FILE_EXT: ".log" = ".log"
+ +
+
+ +

Static Readonly DEFAULT_LOG_FILE_MAX_SIZE

+
DEFAULT_LOG_FILE_MAX_SIZE: 10000000 = 10000000
+ +
+
+ +

Static Readonly DEFAULT_LOG_LAYOUT

+
DEFAULT_LOG_LAYOUT: "[%d{yyyy/MM/dd} %d{hh:mm:ss.SSS}] [%p] %m" = "[%d{yyyy/MM/dd} %d{hh:mm:ss.SSS}] [%p] %m"
+ +
+
+ +

Static Readonly DEFAULT_LOG_TYPE_CONSOLE

+
DEFAULT_LOG_TYPE_CONSOLE: "console" = "console"
+ +
+
+ +

Static Readonly DEFAULT_LOG_TYPE_FILE_SYNC

+
DEFAULT_LOG_TYPE_FILE_SYNC: "fileSync" = "fileSync"
+ +
+
+ +

Static Readonly DEFAULT_LOG_TYPE_PAT

+
DEFAULT_LOG_TYPE_PAT: "pattern" = "pattern"
+ +
+
+
+

Methods

+
+ +

Static addConsoleAppender

+ + +
+
+ +

Static addFileAppender

+ +
    +
  • + +
    +
    +

    Returns the constant values defined within the LoggerConfigBuilder for this config object

    +
    +
    +

    Parameters

    +
      +
    • +
      config: IConfigLogging
      +
    • +
    • +
      key: string
      +
    • +
    • +
      Default value categoryName: string = key
      +
    • +
    • +
      Default value filename: string = LoggerConfigBuilder.buildFullLogFile(LoggerConfigBuilder.getDefaultFileName(key))
      +
    • +
    • +
      Optional logLevel: string
      +
    • +
    +

    Returns IConfigLogging

    +
      +
    • default object built
    • +
    +
  • +
+
+
+ +

Static buildFullLogFile

+
    +
  • buildFullLogFile(name: string): string
  • +
+
    +
  • + +
    +
    +

    Build a fully qualified directory to a log file - defaults to the users home directory - Imperative + does NOT use this as the home is set by the CLI configuration document.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      name of the file to append to fully qualified directory

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

Static getDefaultFileName

+
    +
  • getDefaultFileName(name: string): string
  • +
+ +
+
+ +

Static getDefaultIConfigLogging

+ + +
+
+ +

Static getDefaultLogLevel

+
    +
  • getDefaultLogLevel(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.loggermanager.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.loggermanager.html new file mode 100644 index 0000000000..cf1e869e0d --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.loggermanager.html @@ -0,0 +1,649 @@ + + + + + + LoggerManager | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class LoggerManager

+
+
+
+
+
+
+
+
+
+

LoggerManager is a singleton class used to contain logger information.

+
+
+
+
+

Hierarchy

+
    +
  • + LoggerManager +
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private console

+
console: Console
+ +
+
+ +

Private mIsLoggerInit

+
mIsLoggerInit: boolean = false
+ +
+
+ +

Private mLogInMemory

+
mLogInMemory: boolean = false
+ +
+
+ +

Private mMaxQueueSize

+
mMaxQueueSize: number
+ +
+
+ +

Private mQueuedMessages

+
mQueuedMessages: IQueuedMessage[] = []
+ +
+
+ +

Static Private Readonly DEFAULT_MAX_QUEUE_SIZE

+
DEFAULT_MAX_QUEUE_SIZE: 10000 = 10000
+ +
+
+ +

Static Private mInstance

+
mInstance: LoggerManager = null
+ +
+
+
+

Accessors

+
+ +

QueuedMessages

+ + +
+
+ +

isLoggerInit

+
    +
  • get isLoggerInit(): boolean
  • +
  • set isLoggerInit(status: boolean): void
  • +
+ +
+
+ +

logInMemory

+
    +
  • get logInMemory(): boolean
  • +
  • set logInMemory(status: boolean): void
  • +
+ +
+
+ +

maxQueueSize

+
    +
  • get maxQueueSize(): number
  • +
  • set maxQueueSize(size: number): void
  • +
+ +
+
+ +

Static instance

+ + +
+
+
+

Methods

+
+ +

dumpQueuedMessages

+
    +
  • dumpQueuedMessages(file: string): void
  • +
+ +
+
+ +

queueMessage

+
    +
  • queueMessage(category: string, method: string, message: string): void
  • +
+
    +
  • + +
    +
    +

    This function is responsible for gathering all of the input parameters and + store them in the message queue array.

    +
    +

    New messages are to be stored at the top of the array instead of the bottom. + This allow easy removing message from array while looping the array.

    +
    +

    Parameters

    +
      +
    • +
      category: string
      +
      +

      logger category

      +
      +
    • +
    • +
      method: string
      +
      +

      log method

      +
      +
    • +
    • +
      message: string
      +
      +

      log message

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
  • Accessor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.loggerutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.loggerutils.html new file mode 100644 index 0000000000..0b7bce5ca5 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.loggerutils.html @@ -0,0 +1,616 @@ + + + + + + LoggerUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class LoggerUtils

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + LoggerUtils +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static CENSORED_OPTIONS

+
CENSORED_OPTIONS: string[] = ["auth", "p", "pass", "password", "passphrase", "credentials","authentication", "basic-auth", "basicAuth", "tv", "token-value", "tokenValue","cert-file-passphrase", "certFilePassphrase"]
+ +
+
+

NOTE(Kelosky): Ideally we might have a consolidated list for secure fields, but for now we'll just + make sure they're collocated within the same class.

+
+
+
+
+ +

Static Readonly CENSOR_RESPONSE

+
CENSOR_RESPONSE: "****" = "****"
+ +
+
+ +

Static SECURE_PROMPT_OPTIONS

+
SECURE_PROMPT_OPTIONS: string[] = ["user", "password", "tokenValue", "passphrase"]
+ +
+
+ +

Static Private mConfig

+
mConfig: Config = null
+ +
+
+

Singleton implementation of an internal reference of ImperativeConfig.instance.config

+
+
+
+
+ +

Static Private mLayer

+
mLayer: IConfigLayer = null
+ +
+
+

Singleton implementation of an internal reference to the active layer + This should help with performance since one a single copy will be created for censoring data

+
+
+
+
+ +

Static Private mProfiles

+ + +
+
+

Singleton implementation of an internal reference to the loaded profiles

+
+
+
+
+ +

Static Private mSecureFields

+
mSecureFields: string[] = null
+ +
+
+

Singleton implementation of an internal reference to the secure fields stored in the config

+
+
+
+
+
+

Accessors

+
+ +

Static Private config

+ + +
+
+ +

Static Private layer

+ + +
+
+ +

Static profileSchemas

+ + +
+
+ +

Static Private secureFields

+
    +
  • get secureFields(): string[]
  • +
+ +
+
+
+

Methods

+
+ +

Static censorCLIArgs

+
    +
  • censorCLIArgs(args: string[]): string[]
  • +
+ +
+
+ +

Static censorRawData

+
    +
  • censorRawData(data: string, category?: string): string
  • +
+
    +
  • + +
    +
    +

    Copy and censor any sensitive CLI arguments before logging/printing

    +
    +
    +

    Parameters

    +
      +
    • +
      data: string
      +
    • +
    • +
      Default value category: string = ""
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

Static censorYargsArguments

+
    +
  • censorYargsArguments(args: Arguments): Arguments
  • +
+
    +
  • + +
    +
    +

    Copy and censor a yargs argument object before logging

    +
    +
    +

    Parameters

    +
      +
    • +
      args: Arguments
      +
      +

      the args to censor

      +
      +
    • +
    +

    Returns Arguments

    +

    a censored copy of the arguments

    +
  • +
+
+
+ +

Static isSpecialValue

+
    +
  • isSpecialValue(prop: string): boolean
  • +
+
    +
  • + +
    +
    +

    Specifies whether a given property path (e.g. "profiles.lpar1.properties.host") is a special value or not. + Special value: Refers to any value defined as secure in the schema definition. + These values should be already masked by the application (and/or plugin) developer.

    +
    +
    +

    Parameters

    +
      +
    • +
      prop: string
      +
      +
      +

      Property path to determine if it is a special value

      +
      +
      +
    • +
    +

    Returns boolean

    +

    True - if the given property is to be treated as a special value; False - otherwise

    +
  • +
+
+
+ +

Static setProfileSchemas

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.loggingconfigurer.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.loggingconfigurer.html new file mode 100644 index 0000000000..d7093945a3 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.loggingconfigurer.html @@ -0,0 +1,789 @@ + + + + + + LoggingConfigurer | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class LoggingConfigurer

+
+
+
+
+
+
+
+
+
+

Helper class to construct default config, log4js config, and define + log4js configuration document.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + LoggingConfigurer +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static Private buildAppLoggingDefaults

+ + +
+
+ +

Static Private buildImperativeLoggingDefaults

+ + +
+
+ +

Static Private buildLoggingDefaults

+ + +
+
+ +

Static Private buildLoggingDefaultsByKey

+ +
    +
  • + +
    +
    +

    This method overrides any configuration of reserved loggers. + Build minimum console config for default console logger

    +
    +
    +
    static
    +
    +
    memberof
    +

    LoggingConfigurer

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      imperativeConfig: IImperativeConfig
      +
      +

      imperative main config

      +
      +
    • +
    • +
      key: string
      +
      +

      imperative main config

      +
      +
    • +
    • +
      apiName: string
      +
      +

      imperative main config

      +
      +
    • +
    • +
      Default value category: string = apiName
      +
    • +
    +

    Returns IImperativeConfig

    +
      +
    • populated config
    • +
    +
  • +
+
+
+ +

Static Private configureAppLogger

+ +
    +
  • + +
    +
    +

    Configures log4js app appender from imperative config

    +
    +
    +
    static
    +
    +
    memberof
    +

    LoggingConfigurer

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      home: string
      +
      +

      home directory

      +
      +
    • +
    • +
      imperativeConfig: IImperativeConfig
      +
      +

      imperative main config

      +
      +
    • +
    • +
      loggingConfig: IConfigLogging
      +
      +

      log4js config

      +
      +
    • +
    • +
      key: string
      +
      +

      keys within log4js appenders (like the appenders "imperative" key or categories "imperative" key)

      +
      +
    • +
    +

    Returns IConfigLogging

    +
  • +
+
+
+ +

Static Private configureImperativeLogger

+ +
    +
  • + +
    +
    +

    Configures log4js imperative appender from imperative config

    +
    +
    +
    static
    +
    +
    memberof
    +

    LoggingConfigurer

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      home: string
      +
      +

      home directory

      +
      +
    • +
    • +
      imperativeConfig: IImperativeConfig
      +
      +

      imperative main config

      +
      +
    • +
    • +
      loggingConfig: IConfigLogging
      +
      +

      log4js config

      +
      +
    • +
    • +
      key: string
      +
      +

      keys within log4js appenders (like the appenders "imperative" key or categories "imperative" key)

      +
      +
    • +
    +

    Returns IConfigLogging

    +
  • +
+
+
+ +

Static configureLogger

+ + +
+
+ +

Static Private configureLoggerByKey

+ +
    +
  • + +
    +
    +

    Configures log4js appenders from imperative config

    +
    +
    +
    static
    +
    +
    memberof
    +

    LoggingConfigurer

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      home: string
      +
      +

      home directory

      +
      +
    • +
    • +
      imperativeConfig: IImperativeConfig
      +
      +

      imperative main config

      +
      +
    • +
    • +
      loggingConfig: IConfigLogging
      +
      +

      log4js config

      +
      +
    • +
    • +
      entryKey: string
      +
      +

      keys within log4js appenders (like the appenders "imperative" key or categories "imperative" key)

      +
      +
    • +
    • +
      configKey: string
      +
      +

      keys within IImperativeLogsConfig (like imperativeLogging)

      +
      +
    • +
    +

    Returns IConfigLogging

    +
  • +
+
+
+ +

Static Private configureLoggerByKeyHelper

+ + +
+
+ +

Static Private normalizeDir

+
    +
  • normalizeDir(file: string): string
  • +
+
    +
  • + +
    +
    +

    Normalize input file path for logs in the case that a user provides + redundant or missing file delimiters.

    +
    +
    +
    static
    +
    +
    memberof
    +

    LoggingConfigurer

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      file: string
      +
      +

      normalized file

      +
      +
    • +
    +

    Returns string

    +
      +
    • normalized dir
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.newdeleteprofileshandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.newdeleteprofileshandler.html new file mode 100644 index 0000000000..367f815d0f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.newdeleteprofileshandler.html @@ -0,0 +1,245 @@ + + + + + + NewDeleteProfilesHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class NewDeleteProfilesHandler

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.nextverfeatures.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.nextverfeatures.html new file mode 100644 index 0000000000..f2b50e73e2 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.nextverfeatures.html @@ -0,0 +1,283 @@ + + + + + + NextVerFeatures | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class NextVerFeatures

+
+
+
+
+
+
+
+
+
+

This class contains logic to enable users to opt-in to features + that will become standard functionality in the next version of Zowe.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + NextVerFeatures +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Static Private ENV_VAR_PREFIX

+
ENV_VAR_PREFIX: string = "ZOWE"
+ +
+
+
+

Methods

+
+ +

Static useV3ErrFormat

+
    +
  • useV3ErrFormat(): boolean
  • +
+
    +
  • + +
    +
    +

    Identify if we should use the V3 error message format. + That choice is determined by the value of the ZOWE_V3_ERR_FORMAT environment variable.

    +
    +

    TODO:V3_ERR_FORMAT - Remove in V3

    +
    +

    Returns boolean

    +

    True -> Use the V3 format.

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.operation.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.operation.html new file mode 100644 index 0000000000..e08cdca90c --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.operation.html @@ -0,0 +1,1501 @@ + + + + + + Operation | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Operation<T>

+
+
+
+
+
+
+
+

Type parameters

+
    +
  • +

    T

    +
  • +
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new Operation(opName: string, criticalOperation?: boolean): Operation
  • +
+
    +
  • + +
    +
    +

    Action constructor to build action object

    +
    +
    +

    Parameters

    +
      +
    • +
      opName: string
      +
    • +
    • +
      Optional criticalOperation: boolean
      +
      +
      +

      the operation is critical - meaning if it fails the entire operation fails and + the undo methods should be called.

      +
      +
      +
    • +
    +

    Returns Operation

    +
  • +
+
+
+
+

Properties

+
+ +

errorMessages

+
errorMessages: string[] = []
+ +
+
+ +

infoMessages

+
infoMessages: string[] = []
+ +
+
+ +

Protected log

+
log: Logger
+ +
+
+ +

Private mAllFilesCreated

+
mAllFilesCreated: string[] = []
+ +
+
+

The list of all files that have been created by the service function

+
+
+
+
+ +

Private mFilesForUndo

+
mFilesForUndo: string[] = []
+ +
+
+

The list of files that will be cleaned during an undo operation.

+
+
+
+
+ +

Private mOperationCompleteCallback

+
mOperationCompleteCallback: IOperationResultReady<any>
+ +
+
+

The operation has completed and results are ready, this callback is invoked to inform the + caller of executeOperation, that the operation is done.

+
+
+
+
+ +

Protected mOperationResult

+
mOperationResult: IOperationResult<T>
+ +
+
+

the result from the operation

+
+
+
+
+ +

Protected mOperationResults

+
mOperationResults: IOperationResult<any> = null
+ +
+
+

The full list of operation results

+
+
+
+
+ +

Private mPercentComplete

+
mPercentComplete: number = 0
+ +
+
+ +

Private mStageName

+
mStageName: TaskStage = TaskStage.NOT_STARTED
+ +
+
+

The status of the operation

+
+
+
+
+ +

Private mStatusMessage

+
mStatusMessage: string
+ +
+
+

A string describing what is currently happening in the operation e.g. "Submitted job..."

+
+
+
+
+ +

Static Readonly NO_OUTPUT

+
NO_OUTPUT: any = null
+ +
+
+ +

Static Readonly NO_PARMS

+
NO_PARMS: any = null
+ +
+
+ +

Static Private Readonly outputSeparator

+
outputSeparator: "*******************************************************************" = "*******************************************************************"
+ +
+
+

Traverses the results chain and prints results and gives overall failure status

+
+
+
+
+
+

Accessors

+
+ +

allFilesCreated

+
    +
  • get allFilesCreated(): string[]
  • +
+ +
+
+ +

fileToUndo

+
    +
  • get fileToUndo(): string[]
  • +
+ +
+
+ +

operationName

+
    +
  • get operationName(): string
  • +
+ +
+
+ +

operationResult

+ + +
+
+ +

operationResultMessage

+
    +
  • set operationResultMessage(message: string): void
  • +
+ +
+
+ +

operationSucceeded

+
    +
  • get operationSucceeded(): boolean
  • +
+ +
+
+ +

percentComplete

+
    +
  • get percentComplete(): number
  • +
  • set percentComplete(newPercent: number): void
  • +
+ +
+
+ +

stageName

+ + +
+
+ +

statusMessage

+
    +
  • get statusMessage(): string
  • +
+ +
+
+ +

totalOperations

+
    +
  • get totalOperations(): number
  • +
+ +
+
+
+

Methods

+
+ +

Protected addFileCreated

+
    +
  • addFileCreated(fileUndoable: boolean, file: string): void
  • +
+
    +
  • + +
    +
    +

    Add a file created by the operation to the list of all files created and optionally mark this file + as undoable, which will cause the undo operation to attempt to remove the file or directory.

    +
    +
    +

    Parameters

    +
      +
    • +
      fileUndoable: boolean
      +
    • +
    • +
      file: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Protected addResult

+ + +
+
+ +

Protected createFile

+
    +
  • createFile(filePath: string, message: string, saveFileNameForUndo: boolean, isDir: boolean): void
  • +
+
    +
  • + +
    +
    +

    Use this method to create files and optionally push them onto the files created stack that will + be referenced when an undo is required.

    +
    +
    +

    Parameters

    +
      +
    • +
      filePath: string
      +
    • +
    • +
      message: string
      +
    • +
    • +
      saveFileNameForUndo: boolean
      +
    • +
    • +
      isDir: boolean
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Private deleteAllFilesMarkedForUndo

+
    +
  • deleteAllFilesMarkedForUndo(): void
  • +
+
    +
  • + +
    +
    +

    Method that is called after the implementing classes undo to delete all the files that have been + saved during the operation (on the mFilesForUndo list).

    +
    +
    +

    Returns void

    +
  • +
+
+
+ +

Protected Abstract execute

+ +
    +
  • + +
    +
    +

    The execute method must be implemented by the class. This is where the operation performs its + work and sets the result and the course of action (failed, undo possible, etc).

    +
    +
    +

    Parameters

    + +

    Returns void

    +
  • +
+
+
+ +

executeOperation

+ + +
+
+ +

Private logBeginMessage

+
    +
  • logBeginMessage(): void
  • +
+ +
+
+ +

Private logEndMessage

+
    +
  • logEndMessage(): void
  • +
+ +
+
+ +

Protected Abstract logOperationBeginMessages

+
    +
  • logOperationBeginMessages(): void
  • +
+ +
+
+ +

Abstract logOperationResults

+
    +
  • logOperationResults(): void
  • +
+ +
+
+ +

Private operationComplete

+
    +
  • operationComplete(output: any): void
  • +
+
    +
  • + +
    +
    +

    Operation complete callback method. The operation must invoke the callback to indicate that it + has finished. If it does not, the operation sequence will not continue.

    +
    +
    +

    Parameters

    +
      +
    • +
      output: any
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

performUndo

+ +
    +
  • + +
    +
    +

    The perform undo method sets that an attempt was made to perform the undo and invokes the + undo method of the implemented operation.

    +
    +

    Before invoking, any files that have been created and saved on the undo-able list will be cleaned.

    +
    +

    Parameters

    + +

    Returns void

    +
  • +
+
+
+ +

Protected printFilesCreatedList

+
    +
  • printFilesCreatedList(): void
  • +
+ +
+
+ +

Protected setOperationDiverge

+
    +
  • setOperationDiverge(operation: Operation<any>, continuePathAfterDiverge: boolean): void
  • +
+
    +
  • + +
    +
    +

    If the operation decides that a different path is required. You can set the next operation to complete + and whether or not you should continue down the original path

    +
    +
    +

    Parameters

    +
      +
    • +
      operation: Operation<any>
      +
    • +
    • +
      continuePathAfterDiverge: boolean
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Protected setOperationFailed

+
    +
  • setOperationFailed(): void
  • +
+ +
+
+ +

Protected setOperationUndoAttempted

+
    +
  • setOperationUndoAttempted(): void
  • +
+ +
+
+ +

Protected setOperationUndoFailed

+
    +
  • setOperationUndoFailed(): void
  • +
+ +
+
+ +

Protected setOperationUndoable

+
    +
  • setOperationUndoable(): void
  • +
+
    +
  • + +
    +
    +

    Set method to indicate that the operation is "undoable".

    +
    +

    This means that if an operation fails, we will 'rollback' through the completed operations + and undo any that have occurred.

    +
    +

    Returns void

    +
  • +
+
+
+ +

setStatusMessage

+
    +
  • setStatusMessage(message: string, ...args: any[]): void
  • +
+
    +
  • + +
    +
    +

    Set the status message for the operation

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      the message, including any templates you want replaced like %s or "{{myObject}}"

      +
      +
    • +
    • +
      Rest ...args: any[]
      +
      +

      variable args as allowed by printf-like syntax or {myObject: this.myObject}

      +
      +
    • +
    +

    Returns void

    +

    the final translated and formatted string (in case you want to log it etc.)

    +
  • +
+
+
+ +

Protected Abstract undo

+ + +
+
+ +

Private undoComplete

+
    +
  • undoComplete(): void
  • +
+ +
+
+ +

Static summarizeResults

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
  • Accessor
  • +
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Protected property
  • +
  • Protected method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.operations.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.operations.html new file mode 100644 index 0000000000..1c7d4607df --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.operations.html @@ -0,0 +1,1594 @@ + + + + + + Operations | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Operations<T>

+
+
+
+
+
+
+
+
+
+

The Operations class extends Operation and is used to create a 'string' of operations that must + be completed in serial order.

+
+

The implementing class is responsible (in defineOperations) for creating each operation (and + invoking addNextOperation) to add the operations to the list. You must also call "defineOperations" + from your constructor. This allows you to setup anything you need (in your constructor) before defining + the list of operations.

+

You can initiate the operation by invoking performOperation, which will iterate through each operation + defined and perform them in sequence. If a operation chooses to diverge, then

+
+
+
+

Type parameters

+
    +
  • +

    T

    +
  • +
+
+
+

Hierarchy

+
    +
  • + Operation<any> +
      +
    • + Operations +
    • +
    +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new Operations(opName: string, critical?: boolean): Operations
  • +
+ +
+
+
+

Properties

+
+ +

errorMessages

+
errorMessages: string[] = []
+ +
+
+ +

infoMessages

+
infoMessages: string[] = []
+ +
+
+ +

Protected log

+
log: Logger
+ +
+
+ +

Private mCurrentOperation

+
mCurrentOperation: number = 0
+ +
+
+

The current operation that is being executed.

+
+
+
+
+ +

Private mInputParameters

+
mInputParameters: T
+ +
+
+

The input parameters to this string of operations

+
+
+
+
+ +

Private mOperationList

+
mOperationList: Array<Operation<any>> = []
+ +
+
+

The list of operations that should be executed in sequence

+
+
+
+
+ +

Protected mOperationResult

+
mOperationResult: IOperationResult<any>
+ +
+
+

the result from the operation

+
+
+
+
+ +

Protected mOperationResults

+
mOperationResults: IOperationResult<any> = null
+ +
+
+

The full list of operation results

+
+
+
+
+ +

Private mOperationUndoIndex

+
mOperationUndoIndex: number = 0
+ +
+
+

The current operation undo index.

+
+
+
+
+ +

Private mOperationUndoList

+
mOperationUndoList: Array<Operation<any>> = []
+ +
+
+

In the event of an undo request, we will prepare a list that will be traversed to complete + each undo function.

+
+
+
+
+ +

Private mOperationsCompleteCallback

+
mOperationsCompleteCallback: IOperationResultReady<any>
+ +
+
+

the callers operations complete callback

+
+
+
+
+ +

Private mOverallStatusMessage

+
mOverallStatusMessage: string
+ +
+
+

Optionally give a status message in your Operations object instead of + letting the message from your sub-operations come through.

+
+
+
+
+ +

Static Readonly NO_OUTPUT

+
NO_OUTPUT: any = null
+ +
+
+ +

Static Readonly NO_PARMS

+
NO_PARMS: any = null
+ +
+
+
+

Accessors

+
+ +

allFilesCreated

+
    +
  • get allFilesCreated(): string[]
  • +
+ +
+
+ +

fileToUndo

+
    +
  • get fileToUndo(): string[]
  • +
+ +
+
+ +

operationName

+
    +
  • get operationName(): string
  • +
+ +
+
+ +

operationResult

+ + +
+
+ +

operationResultMessage

+
    +
  • set operationResultMessage(message: string): void
  • +
+ +
+
+ +

operationSucceeded

+
    +
  • get operationSucceeded(): boolean
  • +
+ +
+
+ +

percentComplete

+
    +
  • get percentComplete(): number
  • +
+ +
+
+ +

stageName

+ + +
+
+ +

statusMessage

+
    +
  • get statusMessage(): string
  • +
+ +
+
+ +

totalOperations

+
    +
  • get totalOperations(): number
  • +
+ +
+
+
+

Methods

+
+ +

Protected addFileCreated

+
    +
  • addFileCreated(fileUndoable: boolean, file: string): void
  • +
+
    +
  • + +
    +
    +

    Add a file created by the operation to the list of all files created and optionally mark this file + as undoable, which will cause the undo operation to attempt to remove the file or directory.

    +
    +
    +

    Parameters

    +
      +
    • +
      fileUndoable: boolean
      +
    • +
    • +
      file: string
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Protected addNextOperation

+
    +
  • addNextOperation(newOperation: Operation<any>): void
  • +
+ +
+
+ +

Protected addResult

+ + +
+
+ +

Protected createFile

+
    +
  • createFile(filePath: string, message: string, saveFileNameForUndo: boolean, isDir: boolean): void
  • +
+
    +
  • + +
    +
    +

    Use this method to create files and optionally push them onto the files created stack that will + be referenced when an undo is required.

    +
    +
    +

    Parameters

    +
      +
    • +
      filePath: string
      +
    • +
    • +
      message: string
      +
    • +
    • +
      saveFileNameForUndo: boolean
      +
    • +
    • +
      isDir: boolean
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Protected Abstract defineOperations

+
    +
  • defineOperations(): void
  • +
+
    +
  • + +
    +
    +

    Abstract method that must be implemented by the subclass. In this method, you invoke "addNextOperation" + to add all the operations that must be performed when "executeOperation" is invoked.

    +
    +
    +

    Returns void

    +
  • +
+
+
+ +

Protected execute

+
    +
  • execute(): void
  • +
+ +
+
+ +

Private executeNextOperation

+
    +
  • executeNextOperation(input: any): void
  • +
+ +
+
+ +

Private executeNextUndo

+
    +
  • executeNextUndo(): void
  • +
+ +
+
+ +

executeOperation

+ + +
+
+ +

Protected logOperationBeginMessages

+
    +
  • logOperationBeginMessages(): void
  • +
+ +
+
+ +

logOperationResults

+
    +
  • logOperationResults(): void
  • +
+ +
+
+ +

Protected operationCompleted

+
    +
  • operationCompleted(output: any, operationResult: IOperationResult<any>): void
  • +
+ +
+
+ +

performUndo

+ + +
+
+ +

Private prepareForUndo

+
    +
  • prepareForUndo(): void
  • +
+
    +
  • + +
    +
    +

    Prepare a list of operations to 'undo', we will traverse the list calling the undo function of + each operation. Only operations that are marked as 'undoa-able' will be called.

    +
    +

    TODO - we could probably fire off all undo functions here async, but for now they are serial

    +
    +

    Returns void

    +
  • +
+
+
+ +

Protected printFilesCreatedList

+
    +
  • printFilesCreatedList(): void
  • +
+ +
+
+ +

Protected setOperationDiverge

+
    +
  • setOperationDiverge(operation: Operation<any>, continuePathAfterDiverge: boolean): void
  • +
+ +
+
+ +

Protected setOperationFailed

+
    +
  • setOperationFailed(): void
  • +
+ +
+
+ +

Protected setOperationUndoAttempted

+
    +
  • setOperationUndoAttempted(): void
  • +
+ +
+
+ +

Protected setOperationUndoFailed

+
    +
  • setOperationUndoFailed(): void
  • +
+ +
+
+ +

Protected setOperationUndoable

+
    +
  • setOperationUndoable(): void
  • +
+ +
+
+ +

setStatusMessage

+
    +
  • setStatusMessage(message: string, ...args: any[]): string
  • +
+
    +
  • + +
    +
    +

    Set the status message for the overall Operations object, + which takes precedence over the sub-operations' messages

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      the message, including any templates you want replaced like %s or "{{myObject}}"

      +
      +
    • +
    • +
      Rest ...args: any[]
      +
      +

      variable args as allowed by printf-like syntax or {myObject: this.myObject}

      +
      +
    • +
    +

    Returns string

    +

    the final translated and formatted string (in case you want to log it etc.)

    +
  • +
+
+
+ +

Protected undo

+
    +
  • undo(): void
  • +
+ +
+
+ +

Private undoOpComplete

+
    +
  • undoOpComplete(): void
  • +
+ +
+
+ +

Static summarizeResults

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.optionconstants.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.optionconstants.html new file mode 100644 index 0000000000..0c83f31e96 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.optionconstants.html @@ -0,0 +1,536 @@ + + + + + + OptionConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class OptionConstants

+
+
+
+
+
+
+
+
+
+

Option constants - includes static options built/added by request (on imperative config or command definitions).

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + OptionConstants +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly RESPONSE_FORMAT_TYPES

+
RESPONSE_FORMAT_TYPES: string[] = ["table", "list", "object", "string"]
+ +
+
+

The array of available format types (for the response-format-type definition allowable values).

+
+
+
static
+
+
memberof
+

OptionConstants

+
+
+
+
+
+
+

Object literals

+
+ +

Static Readonly RESPONSE_FORMAT_FILTER_OPTION

+
RESPONSE_FORMAT_FILTER_OPTION: object
+ +
+
+

The response format filter options allows users to filter (include) fields/properties in an output table/object. + Enable this option by specifying "outputFormatOptions: true" on your ICommandDefinition document.

+
+
+
static
+
+
memberof
+

OptionConstants

+
+
+
+
+ +

aliases

+
aliases: string[] = ["rff"]
+ +
+
+ +

description

+
description: string = "Filter (include) fields in the response. " +"Accepts an array of field/property names to include in the output response. " +"You can filter JSON objects properties OR table columns/fields. " +"In addition, you can use this option in conjunction with '--response-format-type' " +"to reduce the output of a command to a single field/property or a list of a single field/property."
+ +
+
+ +

group

+
group: string = "Response Format Options"
+ +
+
+ +

name

+
name: string = "response-format-filter"
+ +
+
+ +

type

+
type: "array" = "array"
+ +
+
+
+ +

Static Readonly RESPONSE_FORMAT_HEADER_OPTION

+
RESPONSE_FORMAT_HEADER_OPTION: object
+ +
+
+

The response format header option allows users to include a table header (or not). + Enable this option by specifying "outputFormatOptions: true" on your ICommandDefinition document.

+
+
+
static
+
+
memberof
+

OptionConstants

+
+
+
+
+ +

aliases

+
aliases: string[] = ["rfh"]
+ +
+
+ +

defaultValue

+
defaultValue: null = null
+ +
+
+ +

description

+
description: string = "If "--response-format-type table" is specified, include the column headers in the output."
+ +
+
+ +

group

+
group: string = "Response Format Options"
+ +
+
+ +

name

+
name: string = "response-format-header"
+ +
+
+ +

type

+
type: "boolean" = "boolean"
+ +
+
+
+ +

Static Readonly RESPONSE_FORMAT_OPTION

+
RESPONSE_FORMAT_OPTION: object
+ +
+
+

The response format type option allows users control over handler output (print/console) data format. + Enable this option by specifying "outputFormatOptions: true" on your ICommandDefinition document.

+
+
+
static
+
+
memberof
+

OptionConstants

+
+
+
+
+ +

aliases

+
aliases: string[] = ["rft"]
+ +
+
+ +

description

+
description: string = `The command response output format type. Must be one of the following:` +"\n\ntable: " +"Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. " +"Each property of the object will become a column in the table." +"\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) " +"are stringified and a new line is added after each entry in an array." +"\n\nobject: Formats output data as a list of prettified objects (or single object). " +"Can be used in place of \"table\" to change from tabular output to a list of prettified objects." +"\n\nstring: Formats output data as a string. JSON objects/arrays are stringified."
+ +
+
+ +

group

+
group: string = "Response Format Options"
+ +
+
+ +

name

+
name: string = "response-format-type"
+ +
+
+ +

type

+
type: "string" = "string"
+ +
+
+ +

allowableValues

+
allowableValues: object
+ +
+ +

caseSensitive

+
caseSensitive: false = false
+ +
+
+ +

values

+
values: string[] = OptionConstants.RESPONSE_FORMAT_TYPES
+ +
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.overridesloader.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.overridesloader.html new file mode 100644 index 0000000000..78c2b6718b --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.overridesloader.html @@ -0,0 +1,440 @@ + + + + + + OverridesLoader | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class OverridesLoader

+
+
+
+
+
+
+
+
+
+

Imperative-internal class to load overrides + You should not need to call this from your CLI.

+
+
+
+
+

Hierarchy

+
    +
  • + OverridesLoader +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Private Readonly ZOWE_CLI_PACKAGE_NAME

+
ZOWE_CLI_PACKAGE_NAME: "@zowe/cli" = "@zowe/cli"
+ +
+
+
+

Methods

+
+ +

Static ensureCredentialManagerLoaded

+
    +
  • ensureCredentialManagerLoaded(): Promise<void>
  • +
+ +
+
+ +

Static load

+ + +
+
+ +

Static Private loadCredentialManager

+ +
    +
  • + +
    +
    +

    Initialize the Credential Manager using the supplied override when provided.

    +
    +
    +

    Parameters

    +
      +
    • +
      config: IImperativeConfig
      +
      +

      the current {@link Imperative#loadedConfig}

      +
      +
    • +
    • +
      packageJson: any
      +
      +

      the current package.json

      +
      +
    • +
    • +
      Optional useTeamConfig: boolean
      +
      +

      specify True if team config is active

      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+ +

Static Private loadSecureConfig

+
    +
  • loadSecureConfig(): Promise<void>
  • +
+ +
+
+ +

Static Private shouldUseKeytar

+
    +
  • shouldUseKeytar(packageJson: any, useTeamConfig: boolean): boolean
  • +
+
    +
  • + +
    +
    +

    Check if the DefaultCredentialManager which uses keytar should be enabled. + We require that keytar is listed as a dependency in package.json, and one of the following is true:

    +
      +
    1. AppSettings are not initialized (SDK usage)
    2. +
    3. Team config is active (CLI with v2 profiles)
    4. +
    5. CredentialManager override is host package name (CLI with v1 profiles)
    6. +
    +
    +
    +

    Parameters

    +
      +
    • +
      packageJson: any
      +
      +

      The current package.json of the CLI package

      +
      +
    • +
    • +
      useTeamConfig: boolean
      +
      +

      Specify True if team config is active

      +
      +
    • +
    +

    Returns boolean

    +

    True if DefaultCredentialManager should be used

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginissues.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginissues.html new file mode 100644 index 0000000000..713a7f2171 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginissues.html @@ -0,0 +1,565 @@ + + + + + + PluginIssues | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class PluginIssues

+
+
+
+
+
+
+
+
+
+

This class is used to record and access plugin errors and warnings. + It is a singleton and should be accessed via PluginIssues.instance.

+
+
+
+
+

Hierarchy

+
    +
  • + PluginIssues +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Private installedPlugins

+
installedPlugins: IPluginJson = null
+ +
+
+

The set of installed plugins. We access this class property only + through its accompanying function + [getInstalledPlugins]{@link PluginIssues#getInstalledPlugins} + to ensure that we only read the file once and reduce excessive I/O.

+
+
+
+
+ +

Private pluginIssues

+
pluginIssues: IPluginIssues
+ +
+
+

A map containing issues for each plugin for which problems were detected.

+
+
+
+
+ +

Static Private mInstance

+
mInstance: PluginIssues
+ +
+
+

This is the variable that stores the specific instance of the PluginIssues. + Defined as static so that it can be accessed from anywhere.

+
+
+
+
+
+

Accessors

+
+ +

Static instance

+ + +
+
+
+

Methods

+
+ +

doesPluginHaveIssueSev

+
    +
  • doesPluginHaveIssueSev(pluginName: string, issueSevs: IssueSeverity[]): boolean
  • +
+
    +
  • + +
    +
    +

    Reports whether or not a plugin has any issues with any of the specified + severities.

    +
    +
    +

    Parameters

    +
      +
    • +
      pluginName: string
      +
      +

      The name of the plugin

      +
      +
    • +
    • +
      issueSevs: IssueSeverity[]
      +
      +

      An array of issue severities.

      +
      +
    • +
    +

    Returns boolean

    +
      +
    • True if any plugin issues have any of the severities.
                     False otherwise.
      +
      +
    • +
    +
  • +
+
+
+ +

getAllIssues

+ + +
+
+ +

getInstalledPlugins

+ + +
+
+ +

getIssueListForPlugin

+
    +
  • getIssueListForPlugin(pluginName: string): IPluginIssue[]
  • +
+ +
+
+ +

recordIssue

+
    +
  • recordIssue(pluginName: string, issueSev: IssueSeverity, issueText: string): void
  • +
+
    +
  • + +
    +
    +

    Record an issue that was discovered in a plugin into an in-memory structure. + The plugin issues can later be accessed to report the health of a plugin.

    +
    +
    +

    Parameters

    +
      +
    • +
      pluginName: string
      +
      +

      The name of the plugin

      +
      +
    • +
    • +
      issueSev: IssueSeverity
      +
      +

      The severity of the issue. + Use PluginIssues.ERROR or PluginIssues.WARNING

      +
      +
    • +
    • +
      issueText: string
      +
      +

      The issue message text to record.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

removeIssuesForPlugin

+
    +
  • removeIssuesForPlugin(pluginName: string): void
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginmanagementfacility.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginmanagementfacility.html new file mode 100644 index 0000000000..df77c894b9 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginmanagementfacility.html @@ -0,0 +1,1307 @@ + + + + + + PluginManagementFacility | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class PluginManagementFacility

+
+
+
+
+
+
+
+
+
+

This class is the main engine for the Plugin Management Facility. The + underlying class should be treated as a singleton and should be accessed + via PluginManagmentFacility.instance.

+
+
+
+
+

Hierarchy

+
    +
  • + PluginManagementFacility +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Private Readonly impConfigPropNm

+
impConfigPropNm: "imperative" = "imperative"
+ +
+
+

The property name within package.json that holds the + Imperative configuration object.

+
+
+
+
+ +

Private impLogger

+
impLogger: Logger = Logger.getImperativeLogger()
+ +
+
+

Used for internal imperative logging.

+
+
+
+
+ +

Private mAllPluginCfgProps

+
mAllPluginCfgProps: IPluginCfgProps[] = []
+ +
+
+

Internal reference to the set of configuration properties for all loaded plugins.

+
+
+
+
+ +

Private mPluginOverrides

+
mPluginOverrides: IImperativeOverrides
+ +
+
+

Internal reference to the overrides provided by plugins.

+
+
+
+
+ +

Private Readonly noPeerDependency

+
noPeerDependency: "-1" = "-1"
+ +
+
+ +

Private Readonly npmPkgNmProp

+
npmPkgNmProp: "name" = "name"
+ +
+
+

A set of bright dependencies used by plugins. Each item in the + set contains the dependency's property name, and the the version + of that dependency.

+
+
+
+
+ +

Private pluginIssues

+
pluginIssues: PluginIssues = PluginIssues.instance
+ +
+
+

A class with recorded issues for each plugin for which problems were detected.

+
+
+
+
+ +

Private pmfConst

+
pmfConst: PMFConstants = PMFConstants.instance
+ +
+
+

Used as a short-name access to PMF constants.

+
+
+
+
+ +

Private resolvedCliCmdTree

+
resolvedCliCmdTree: ICommandDefinition = null
+ +
+
+

The CLI command tree with module globs already resolved.

+
+
+
+
+ +

Private Readonly semver

+
semver: any = require("semver")
+ +
+
+

The semantic versioning module (which does not have the + typing to do an 'import').

+
+
+
+
+ +

Private wasInitCalled

+
wasInitCalled: boolean = false
+ +
+
+

Tracker to ensure that [init]{@link PluginManagementFacility#init} was + called. Most methods cannot be used unless init was called first.

+
+
+
+
+ +

Static Private mInstance

+ + +
+
+

This is the variable that stores the specific instance of the PMF. Defined + as static so that it can be accessed from anywhere.

+
+
+
+
+
+

Accessors

+
+ +

allPluginCfgProps

+ + +
+
+ +

pluginOverrides

+ + +
+
+ +

Static instance

+ + +
+
+
+

Methods

+
+ +

addAllPluginsToHostCli

+ + +
+
+ +

Private addCmdGrpToResolvedCliCmdTree

+
    +
  • addCmdGrpToResolvedCliCmdTree(pluginName: string, cmdDefToAdd: ICommandDefinition): boolean
  • +
+
    +
  • + +
    +
    +

    Add a new command group into the host CLI's resolved command tree. + We had to wait until the host CLI was resolved, so that we could check for + name conflicts. So each plugin's commands are added to the host CLI + command tree after both have been resolved.

    +
    +
    +

    Parameters

    +
      +
    • +
      pluginName: string
      +
      +

      the name of the plugin to initialize

      +
      +
    • +
    • +
      cmdDefToAdd: ICommandDefinition
      +
      +

      command definition group to to be added.

      +
      +
    • +
    +

    Returns boolean

    +

    True upon success. False upon error, and errors are recorded in pluginIssues.

    +
  • +
+
+
+ +

Private addPluginToHostCli

+ + +
+
+ +

Private comparePluginVersionToCli

+
    +
  • comparePluginVersionToCli(pluginName: string, pluginVerPropNm: string, pluginVerVal: string, cliVerPropNm: string, cliVerVal: string): void
  • +
+
    +
  • + +
    +
    +

    Compare the version of a plugin version property with a version property + of its base CLI.

    +
    +

    If the versions do not intersect (according so semver rules), then a + PluginIssue is recorded.

    +
    +

    Parameters

    +
      +
    • +
      pluginName: string
      +
      +

      The name of the plugin.

      +
      +
    • +
    • +
      pluginVerPropNm: string
      +
      +

      The name of the plugin property containing a version.

      +
      +
    • +
    • +
      pluginVerVal: string
      +
      +

      value of the plugin's version.

      +
      +
    • +
    • +
      cliVerPropNm: string
      +
      +

      The name of the base CLI property containing a version.

      +
      +
    • +
    • +
      cliVerVal: string
      +
      +

      value of the base CLI's version.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Private conflictingNameOrAlias

+ +
    +
  • + +
    +
    +

    Does the supplied pluginGroupNm match an existing top-level + name or alias in the imperative command tree? + If a conflict occurs, plugIssues.doesPluginHaveError() will return true.

    +
    +
    +

    Parameters

    +
      +
    • +
      pluginName: string
      +
      +

      The name of the plugin that we are checking.

      +
      +
    • +
    • +
      pluginGroupDefinition: ICommandDefinition
      +
      +

      A plugin's command group definition..

      +
      +
    • +
    • +
      cmdTreeDef: ICommandDefinition
      +
      +

      A top-level command tree + definition against which we compare the supplied + pluginGroupNm. It is typically the imperative command tree.

      +
      +
    • +
    +

    Returns { hasConflict: boolean; message: string }

    +
      +
    • {hasConflict, message} - hasConflict: True when we found a conflict.
                               False when find no conflicts.
      +                         message: the message describing the conflict
      +
      +
    • +
    +
      +
    • +
      hasConflict: boolean
      +
    • +
    • +
      message: string
      +
    • +
    +
  • +
+
+
+ +

Private formPluginRuntimePath

+
    +
  • formPluginRuntimePath(pluginName: string, relativePath?: string): string
  • +
+
    +
  • + +
    +
    +

    Form the absolute path to a runtime file for a plugin from a path name + that is relative to the plugin's root directory (where its package.json lives).

    +
    +
    +

    Parameters

    +
      +
    • +
      pluginName: string
      +
      +

      The name of the plugin.

      +
      +
    • +
    • +
      Default value relativePath: string = ""
      +
      +

      A relative path from plugin's root. + Typically supplied as ./lib/blah/blah/blah. + If not supplied, (or supplied as an an empty string, + the result will be a path to + /. + If an absolute path is supplied, it is returned exactly as supplied.

      +
      +
    • +
    +

    Returns string

    +
      +
    • The absolute path to the file.
    • +
    +
  • +
+
+
+ +

Private getCliPkgName

+
    +
  • getCliPkgName(): string
  • +
+ +
+
+ +

init

+
    +
  • init(): void
  • +
+ +
+
+ +

loadAllPluginCfgProps

+
    +
  • loadAllPluginCfgProps(): void
  • +
+
    +
  • + +
    +
    +

    Loads the configuration properties of each plugin. The configuration + information is used when overriding a piece of the imperative + infrastructure with a plugin's capability, when validating each plugin, + and when adding each plugin's commands to the CLI command tree. + Errors are recorded in PluginIssues.

    +
    +
    +

    Returns void

    +
  • +
+
+
+ +

Private loadPluginCfgProps

+ +
    +
  • + +
    +
    +

    Read a plugin's configuration properties. The properties are obtained + from the plugins package.json file, including it's imperative property.

    +
    +
    +

    Parameters

    +
      +
    • +
      pluginName: string
      +
      +

      the name of the plugin

      +
      +
    • +
    +

    Returns IPluginCfgProps

    +
      +
    • The plugin's configuration properties + or null if the plugin's configuration cannot be retrieved. + Errors are recorded in PluginIssues.
    • +
    +
  • +
+
+
+ +

Private removeCmdGrpFromResolvedCliCmdTree

+ + +
+
+ +

requirePluginModuleCallback

+
    +
  • requirePluginModuleCallback(pluginName: string): (relativePath: string) => any
  • +
+
    +
  • + +
    +
    +

    Produces a function that requires a module from a plugin using a relative + path name from the plugin's root to the module. Used as a callback function + from the ConfigurationLoader to load configuration handlers.

    +
    +
    +

    Parameters

    +
      +
    • +
      pluginName: string
      +
      +

      The name of the plugin/module to load.

      +
      +
    • +
    +

    Returns (relativePath: string) => any

    +
      +
    • The method responsible for requiring the module
    • +
    +
      +
    • +
        +
      • (relativePath: string): any
      • +
      +
        +
      • +

        Parameters

        +
          +
        • +
          relativePath: string
          +
        • +
        +

        Returns any

        +
      • +
      +
    • +
    +
  • +
+
+
+ +

Private useOverrideThatFails

+
    +
  • useOverrideThatFails(settingNm: string, overrideDispNm: string, overridePluginNm: string, reasonText: string): void
  • +
+
    +
  • + +
    +
    +

    Due to configuration errors, we use an override that purposely fails.

    +
    +
    +

    Parameters

    +
      +
    • +
      settingNm: string
      +
      +

      The name of the setting being processed.

      +
      +
    • +
    • +
      overrideDispNm: string
      +
      +

      The display name of override being processed.

      +
      +
    • +
    • +
      overridePluginNm: string
      +
      +

      The name of plugin supplying the override.

      +
      +
    • +
    • +
      reasonText: string
      +
      +

      The text describing the reason for the error.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Private validatePeerDepVersions

+ +
    +
  • + +
    +
    +

    Validates that the semver range strings specified by the plugin for + versions of the imperative framework and host CLI program are compatible + with those specified in the host CLI.

    +
    +

    Both range strings come from the package.json files of the plugin and the + hosting CLI. We consider the version ranges to be compatible if the two + ranges intersect. This should allow npm to download one common version + of core and of imperative to be owned by the base CLI and shared by the plugin.

    +

    Any errors are recorded in PluginIssues.

    +
    +

    Parameters

    +
      +
    • +
      pluginCfgProps: IPluginCfgProps
      +
      +

      The configuration properties for this plugin

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Private validatePlugin

+ + +
+
+ +

Private validatePluginCmdDefs

+
    +
  • validatePluginCmdDefs(pluginName: string, pluginCmdDefs: ICommandDefinition[], cmdTreeDepth?: number): void
  • +
+
    +
  • + +
    +
    +

    Validate a plugin's array of command definitions at the specified depth + within the plugin's command definition tree. This is a recursive function + used to navigate down through the command tree, validating as we go. + If errors occur, they are recorded in PlugIssues.

    +
    +
    +

    Parameters

    +
      +
    • +
      pluginName: string
      +
      +

      The name of the plugin.

      +
      +
    • +
    • +
      pluginCmdDefs: ICommandDefinition[]
      +
      +

      Array of plugin commands.

      +
      +
    • +
    • +
      Default value cmdTreeDepth: number = 1
      +
      +

      The depth within the plugin command + tree at which we are validating. It is used within error messages.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Private validatePluginProfiles

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginrequirealreadycreatederror.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginrequirealreadycreatederror.html new file mode 100644 index 0000000000..ba2531262b --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginrequirealreadycreatederror.html @@ -0,0 +1,543 @@ + + + + + + PluginRequireAlreadyCreatedError | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class PluginRequireAlreadyCreatedError

+
+
+
+
+
+
+
+
+
+

This error is thrown when a second call to PluginRequireProvider.createPluginHooks has + been made without destroying a previous hook call.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

mDetails

+ + +
+
+ +

name

+
name: string
+ +
+
+
+

Accessors

+
+ +

additionalDetails

+
    +
  • get additionalDetails(): string
  • +
+ +
+
+ +

causeErrors

+
    +
  • get causeErrors(): any
  • +
+ +
+
+ +

details

+ + +
+
+ +

errorCode

+
    +
  • get errorCode(): string
  • +
+ +
+
+ +

message

+
    +
  • get message(): string
  • +
+ +
+
+ +

stack

+
    +
  • get stack(): string
  • +
+ +
+
+ +

suppressDump

+
    +
  • get suppressDump(): boolean
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginrequirenotcreatederror.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginrequirenotcreatederror.html new file mode 100644 index 0000000000..da5da43305 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginrequirenotcreatederror.html @@ -0,0 +1,543 @@ + + + + + + PluginRequireNotCreatedError | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class PluginRequireNotCreatedError

+
+
+
+
+
+
+
+
+
+

This error is thrown when a call to PluginRequireProvider.destroyPluginHooks has + been made without hooks in place.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

mDetails

+ + +
+
+ +

name

+
name: string
+ +
+
+
+

Accessors

+
+ +

additionalDetails

+
    +
  • get additionalDetails(): string
  • +
+ +
+
+ +

causeErrors

+
    +
  • get causeErrors(): any
  • +
+ +
+
+ +

details

+ + +
+
+ +

errorCode

+
    +
  • get errorCode(): string
  • +
+ +
+
+ +

message

+
    +
  • get message(): string
  • +
+ +
+
+ +

stack

+
    +
  • get stack(): string
  • +
+ +
+
+ +

suppressDump

+
    +
  • get suppressDump(): boolean
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginrequireprovider.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginrequireprovider.html new file mode 100644 index 0000000000..307645ab48 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.pluginrequireprovider.html @@ -0,0 +1,498 @@ + + + + + + PluginRequireProvider | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class PluginRequireProvider

+
+
+
+
+
+
+
+
+
+

This class will allow imperative to intercept calls by plugins so that it can + provide them with the runtime instance of imperative / base cli when necessary.

+
+
+
future
+

Currently this loader is only available from Imperative's internals but + work could be done to make this a true standalone package that either + Imperative depends on or ships as a separate folder under packages.

+
+
example
+
Proper Use of the Module Loader + // Ideally this is the first thing that gets called by your application; however, + // the module loader can be created and destroyed at any point by your application. +

// Initializing the loader + PluginRequireProvider.createPluginHooks(["module-a", "module-b"]);

+

// Now in all places of the application, module-a and module-b will be loaded + // from the package location of process.mainModule (I.E the Host Package). This + // is useful when the Host Package has some sort of plugin infrastructure that + // might require modules to be injected to the plugins.

+

// So this will always be the Host Package module regardless of where it was + // called from. + require("module-a");

+

// But this will act as normal + require("module-c");

+

// It is not necessary to cleanup the module loader before exiting. Your + // application lifecycle may require it to be brought up and down during the + // course of execution. With this in mind, a method has been provided to remove + // the hooks created by createPluginHooks.

+

// Calling this + PluginRequirePriovider.destroyPluginHooks();

+

// Will now cause this to act as normal regardless of how it would have been + // injected before. + require("module-b");

+
+
+
+
+
+

Hierarchy

+
    +
  • + PluginRequireProvider +
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

Private constructor

+ + +
+
+
+

Properties

+
+ +

Private Readonly modules

+
modules: string[]
+ +
+
+

The modules that should be injected from the runtime instance

+
+
+
+
+ +

Private origRequire

+
origRequire: typeof require
+ +
+
+

Reference to the original require function.

+
+
+
+
+ +

Private Readonly regex

+
regex: RegExp
+ +
+
+

Reference to the regular expression used to match modules.

+
+

This property was added to make testing easier.

+
+
+
+ +

Static Private mInstance

+ + +
+
+

Reference to the static singleton instance.

+
+
+
+
+
+

Methods

+
+ +

Static createPluginHooks

+
    +
  • createPluginHooks(modules: string[]): void
  • +
+
    +
  • + +
    +
    +

    Create hooks for the specified modules to be injected at runtime.

    +
    +
    +
    throws
    +

    {PluginRequireAlreadyCreatedError} when hooks have already been added.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      modules: string[]
      +
      +

      An array of modules to inject from the host application.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static destroyPluginHooks

+
    +
  • destroyPluginHooks(): void
  • +
+ +
+
+ +

Static Private sanitizeExpression

+
    +
  • sanitizeExpression(module: string): any
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.pmfconstants.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.pmfconstants.html new file mode 100644 index 0000000000..015401e0d4 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.pmfconstants.html @@ -0,0 +1,505 @@ + + + + + + PMFConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class PMFConstants

+
+
+
+
+
+
+
+
+
+

Constants used by the PMF.

+
+
+
+
+

Hierarchy

+
    +
  • + PMFConstants +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Readonly CLI_CORE_PKG_NAME

+
CLI_CORE_PKG_NAME: string
+ +
+
+

The NPM package name for the command line app's core package.

+
+
+
+
+ +

Readonly IMPERATIVE_PKG_NAME

+
IMPERATIVE_PKG_NAME: string
+ +
+
+

The NPM package name for the command line app's core package.

+
+
+
+
+ +

Readonly NPM_NAMESPACE

+
NPM_NAMESPACE: string
+ +
+
+

The namespace that we use for imperative and our CLI app.

+
+
+
+
+ +

Readonly PLUGIN_CONFIG

+
PLUGIN_CONFIG: Config
+ +
+
+

The config object

+
+
+
+
+ +

Readonly PLUGIN_HOME_LOCATION

+
PLUGIN_HOME_LOCATION: string
+ +
+
+

The home location for plugins

+
+
+
+
+ +

Readonly PLUGIN_INSTALL_LOCATION

+
PLUGIN_INSTALL_LOCATION: string
+ +
+
+

Installation directory for plugins

+
+
+
+
+ +

Readonly PLUGIN_JSON

+
PLUGIN_JSON: string
+ +
+
+

The plugin.json config file location.

+
+
+
+
+ +

Readonly PLUGIN_NODE_MODULE_LOCATION

+
PLUGIN_NODE_MODULE_LOCATION: string[]
+ +
+
+

This stores the plugin node_module location. Since linux and windows can + differ here, this will be PLUGIN_INSTALL_LOCATION appended with either + node_modules or lib/node_modules.

+
+
+
+
+ +

Readonly PLUGIN_USING_CONFIG

+
PLUGIN_USING_CONFIG: boolean
+ +
+
+

Indicates if we are using a configuration file

+
+
+
+
+ +

Readonly PMF_ROOT

+
PMF_ROOT: string
+ +
+
+

The root directory for all plugin related items.

+
+
+
+
+ +

Static Private mInstance

+
mInstance: PMFConstants
+ +
+
+

Internal singleton object for the instance of the constants. This is done + this way because some of the variables need Imperative to have been + initialized first. That initialization happens at run time and not + compile time.

+
+
+
+
+
+

Accessors

+
+ +

Static instance

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Property
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.processutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.processutils.html new file mode 100644 index 0000000000..4bb209d73a --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.processutils.html @@ -0,0 +1,492 @@ + + + + + + ProcessUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProcessUtils

+
+
+
+
+
+
+
+
+
+

A collection of utilities related to the running process.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ProcessUtils +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static execAndCheckOutput

+
    +
  • execAndCheckOutput(command: string, args?: string[], options?: SpawnSyncOptions): Buffer | string
  • +
+
    +
  • + +
    +
    +

    Spawn a process with arguments and throw an error if the process fails. + Parameters are same as child_process.spawnSync (see Node.js docs). + Use this method if you want the safe argument parsing of spawnSync + combined with the smart output handling of execSync.

    +
    +
    +
    deprecated
    +

    Use ExecUtils.spawnAndGetOutput instead.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      command: string
      +
    • +
    • +
      Optional args: string[]
      +
    • +
    • +
      Optional options: SpawnSyncOptions
      +
    • +
    +

    Returns Buffer | string

    +

    Contents of stdout as buffer or string

    +
  • +
+
+
+ +

Static getBasicSystemInfo

+ + +
+
+ +

Static isGuiAvailable

+ + +
+
+ +

Static nextTick

+
    +
  • nextTick(callback: (...args: any[]) => void, ...args: any[]): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Process utility to wrap callback process routines into promises + Turn nextTick into a promise to prevent nesting

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProcessUtils

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      callback: (...args: any[]) => void
      +
      +

      called before promise is resolved

      +
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    • +
      Rest ...args: any[]
      +
      +

      arguments passed to the callback

      +
      +
    • +
    +

    Returns Promise<void>

    +
      +
    • fulfilled whenever callback is invoked
    • +
    +
  • +
+
+
+ +

Static openInDefaultApp

+
    +
  • openInDefaultApp(pathOrUrl: string): void
  • +
+
    +
  • + +
    +
    +

    Open a file or URL in the default application associated with its file + extension or URL protocol. This method is only supported in graphical + environments.

    +
    +
    +

    Parameters

    +
      +
    • +
      pathOrUrl: string
      +
      +

      File path or Internet URL to open

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static openInEditor

+
    +
  • openInEditor(filePath: string, editorOpt?: string, sync?: boolean): void
  • +
+
    +
  • + +
    +
    +

    Open a file in the best editor that can be found in the current + environment. In a graphical environment, the default application + associated with its file extension will be launched. In a command-line + environment, the file will be opened in vi, or the editor in the + the {envVariablePrefix}_EDITOR environment variable if specified.

    +
    +
    +

    Parameters

    +
      +
    • +
      filePath: string
      +
      +

      File path to edit

      +
      +
    • +
    • +
      Optional editorOpt: string
      +
      +

      Chosen editor, can be a path or a valid environment variable name

      +
      +
    • +
    • +
      Optional sync: boolean
      +
      +

      Boolean where true == synchronous and false == asynchronous

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profilecredentials.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilecredentials.html new file mode 100644 index 0000000000..848f31e25b --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilecredentials.html @@ -0,0 +1,485 @@ + + + + + + ProfileCredentials | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfileCredentials

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ProfileCredentials +
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private Optional mCredMgrOverride

+
mCredMgrOverride: ICredentialManagerInit
+ +
+
+ +

Private mProfileInfo

+
mProfileInfo: ProfileInfo
+ +
+
+ +

Private mSecured

+
mSecured: boolean
+ +
+
+
+

Accessors

+
+ +

isSecured

+
    +
  • get isSecured(): boolean
  • +
+
    +
  • + +
    +
    +

    Check if secure credentials will be encrypted or stored in plain text. + If using team config, this will always return true. If using classic + profiles, this will check whether a custom CredentialManager is defined + in the Imperative settings.json file.

    +
    +
    +

    Returns boolean

    +
  • +
+
+
+
+

Methods

+
+ +

Private isCredentialManagerInAppSettings

+
    +
  • isCredentialManagerInAppSettings(): boolean
  • +
+ +
+
+ +

Private isTeamConfigSecure

+
    +
  • isTeamConfigSecure(): boolean
  • +
+ +
+
+ +

loadManager

+ +
    +
  • + +
    +
    +

    Initialize credential manager to be used for secure credential storage. + This method throws if ProfileCredentials.isSecured is false. If the + CredentialManagerFactory is already initialized, it is reused since it + is not possible to reinitialize.

    +
    +
    +

    Returns Promise<void>

    +
  • +
+
+
+ +

Static defaultCredMgrWithKeytar

+ +
    +
  • + +
    +
    +

    Given a custom method to require Keytar, return an object that defines + credential manager settings to replace the default credential manager. + If the credential manager is not overridden, the default implementation + is to require("keytar") from the caller app's node_modules folder.

    +
    +
    +

    Parameters

    +
      +
    • +
      requireKeytar: () => NodeModule
      +
      +

      Callback to require Keytar module for managing secure credentials

      +
      +
        +
      • +
          +
        • (): NodeModule
        • +
        +
          +
        • +

          Returns NodeModule

          +
        • +
        +
      • +
      +
    • +
    +

    Returns ICredentialManagerInit

    +

    Credential manager settings with Keytar module overridden

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profileinfo.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profileinfo.html new file mode 100644 index 0000000000..5b6cf93cbf --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profileinfo.html @@ -0,0 +1,2107 @@ + + + + + + ProfileInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfileInfo

+
+
+
+
+
+
+
+
+
+

This class provides functions to retrieve profile-related information. + It can load the relevant configuration files, merge all possible + profile argument values using the Zowe order-of-precedence, and + access desired profile attributes from the Zowe configuration settings.

+
+

Pseudocode examples:

+
+   // Construct a new object. Use it to read the profiles from disk.
+   // ProfileInfo functions throw a ProfInfoErr exception for errors.
+   // You can catch those errors and test the errorCode for known
+   // values. We are only showing the try/catch on the function
+   // below, but it applies to any ProfileInfo function.
+   profInfo = new ProfileInfo("zowe");
+   try {
+       await profInfo.readProfilesFromDisk();
+   } catch(err) {
+       if (err instanceof ProfInfoErr) {
+           if (err.errcode == ProfInfoErr.CANT_GET_SCHEMA_URL) {
+               youTakeAnAlternateAction();
+           } else {
+               // report the error
+           }
+       } else {
+           // handle other exceptions
+       }
+   }
+
+   // Maybe you want the list of all zosmf profiles
+   let arrayOfProfiles = profInfo.getAllProfiles("zosmf");
+   youDisplayTheListOfProfiles(arrayOfProfiles);
+
+   // Maybe you want the default zosmf profile
+   let zosmfProfile = profInfo.getDefaultProfile("zosmf");
+   youUseTheProfile(zosmfProfile);
+
+   // Maybe you want the arg values for the default JCLCheck profile
+   let jckProfile = profInfo.getDefaultProfile("jclcheck");
+   let jckMergedArgs = profInfo.mergeArgsForProfile(jckProfile);
+   let jckFinalArgs = youPromptForMissingArgsAndCombineWithKnownArgs(
+       jckMergedArgs.knownArgs, jckMergedArgs.missingArgs
+   );
+   youRunJclCheck(jckFinalArgs);
+
+   // Maybe no profile of type "zosmf" even exists.
+   let zosmfProfiles = profInfo.getAllProfiles("zosmf");
+   if (zosmfProfiles.length == 0) {
+       // No zosmf profile exists
+       // Merge any required arg values for the zosmf profile type
+       let zosmfMergedArgs =
+           profInfo.mergeArgsForProfileType("zosmf");
+
+       // Values of secure arguments must be loaded separately. You can
+       // freely log the contents of zosmfMergedArgs without leaking secure
+       // argument values, until they are loaded with the lines below.
+       zosmfMergedArgs.knownArgs.forEach((arg) => {
+           if (arg.secure) arg.argValue = profInfo.loadSecureArg(arg);
+       });
+
+       let finalZosmfArgs =
+           youPromptForMissingArgsAndCombineWithKnownArgs(
+               zosmfMergedArgs.knownArgs,
+               zosmfMergedArgs.missingArgs
+           );
+       youRunSomeZosmfCommand(finalZosmfArgs);
+   }
+
+   // So you want to write to a config file? You must use your own
+   // old-school techniques to write to old-school profiles.
+   // You then use alternate logic for a team config.
+   // You must use the Config API to write to a team configuration.
+   // See the Config class documentation for functions to set
+   // and save team config arguments.
+
+   // Let's save some zosmf arguments from the example above.
+   let yourZosmfArgsToWrite: IProfArgAttrs =
+       youSetValuesToOverwrite(
+           zosmfMergedArgs.knownArgs, zosmfMergedArgs.missingArgs
+       );
+   if (profInfo.usingTeamConfig {
+       let configObj: Config = profInfo.getTeamConfig();
+       youWriteArgValuesUsingConfigObj(
+           configObj, yourZosmfArgsToWrite
+       );
+   } else {
+       youWriteOldSchoolProfiles(yourZosmfArgsToWrite);
+   }
+
+
+
+
+

Hierarchy

+
    +
  • + ProfileInfo +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ +
    +
  • + +
    +
    +

    Constructor for ProfileInfo class.

    +
    +
    +

    Parameters

    +
      +
    • +
      appName: string
      +
      +
      +
         The name of the application (like "zowe" in zowe.config.json)
      +   whose configuration you want to access.
      +
      +
      +
      +
    • +
    • +
      Optional profInfoOpts: IProfOpts
      +
      +
      +
         Options that will control the behavior of ProfileInfo.
      +
      +
      +
      +
    • +
    +

    Returns ProfileInfo

    +
  • +
+
+
+
+

Properties

+
+ +

Private mAppName

+
mAppName: string = null
+ +
+
+ +

Private mCredentials

+
mCredentials: ProfileCredentials
+ +
+
+ +

Private mExtendersJson

+
mExtendersJson: IExtendersJsonOpts
+ +
+
+ +

Private mHasValidSchema

+
mHasValidSchema: boolean = false
+ +
+
+ +

Private mImpLogger

+
mImpLogger: Logger = null
+ +
+
+ +

Private mLoadedConfig

+
mLoadedConfig: Config = null
+ +
+
+ +

Private mOldSchoolProfileCache

+
mOldSchoolProfileCache: IProfileLoaded[] = null
+ +
+
+ +

Private mOldSchoolProfileDefaults

+
mOldSchoolProfileDefaults: {} = null
+ +
+

Type declaration

+
    +
  • +
    [key: string]: string
    +
  • +
+
+
+
+ +

Private mOldSchoolProfileRootDir

+
mOldSchoolProfileRootDir: string = null
+ +
+
+ +

Private mOldSchoolProfileTypes

+
mOldSchoolProfileTypes: string[]
+ +
+
+ +

Private mOverrideWithEnv

+
mOverrideWithEnv: boolean = false
+ +
+
+ +

Private mProfileSchemaCache

+
mProfileSchemaCache: Map<string, IProfileSchema>
+ +
+
+

Cache of profile schema objects mapped by profile type and config path + if applicable. Examples of map keys:

+
    +
  • For team config: "/root/.zowe/zowe.config.json:zosmf"
  • +
  • For old profiles: "zosmf"
  • +
+
+
+
+
+ +

Private mUsingTeamConfig

+
mUsingTeamConfig: boolean = false
+ +
+
+
+

Accessors

+
+ +

hasValidSchema

+
    +
  • get hasValidSchema(): boolean
  • +
+ +
+
+ +

usingTeamConfig

+
    +
  • get usingTeamConfig(): boolean
  • +
+
    +
  • + +
    +
    +

    Returns an indicator of whether we are using a team configuration or + old-school profiles.

    +
    +

    You must call ProfileInfo.readProfilesFromDisk() before calling this function.

    +
    +

    Returns boolean

    +

    True when we are using a team config. False means old-school profiles.

    +
  • +
+
+
+
+

Methods

+
+ +

addProfileToConfig

+
    +
  • addProfileToConfig(profileType: string, layerPath?: string): boolean
  • +
+
    +
  • + +
    +
    +

    Adds a profile type to the loaded Zowe config. + The profile type must first be added to the schema using addProfileTypeToSchema.

    +
    +
    +

    Parameters

    +
      +
    • +
      profileType: string
      +
      +

      The profile type to add

      +
      +
    • +
    • +
      Optional layerPath: string
      +
    • +
    +

    Returns boolean

    +

    true if added to the loaded config; false otherwise

    +
  • +
+
+
+ +

addProfileTypeToSchema

+ +
    +
  • + +
    +
    +

    Adds a profile type to the schema, and tracks its contribution in extenders.json.

    +
    +

    NOTE: readProfilesFromDisk must be called at least once before adding new profile types.

    +
    +

    Parameters

    +
      +
    • +
      profileType: string
      +
      +

      The new profile type to add to the schema

      +
      +
    • +
    • +
      typeInfo: IExtenderTypeInfo
      +
      +

      Type metadata for the profile type (schema, source app., optional version)

      +
      +
    • +
    +

    Returns IAddProfTypeResult

    +

    true if added to the schema; false otherwise

    +
  • +
+
+
+ +

Private argDataType

+
    +
  • argDataType(propType: string | string[]): "string" | "number" | "boolean" | "array" | "object"
  • +
+
    +
  • + +
    +
    +

    Get arg data type from a "typeof" string. Arg data types can be basic + types like string, number, and boolean. If they are any other type or a + union of types, their type will be represented simply as object.

    +
    +
    +

    Parameters

    +
      +
    • +
      propType: string | string[]
      +
      +

      The type of a profile property

      +
      +
    • +
    +

    Returns "string" | "number" | "boolean" | "array" | "object"

    +
  • +
+
+
+ +

Private argOldProfileLoc

+
    +
  • argOldProfileLoc(profileName: string, profileType: string): IProfLoc
  • +
+
    +
  • + +
    +
    +

    Given a profile name and type, compute the profile location object + containing OS location.

    +
    +
    +

    Parameters

    +
      +
    • +
      profileName: string
      +
      +

      Name of an old school profile (e.g., LPAR1)

      +
      +
    • +
    • +
      profileType: string
      +
      +

      Type of an old school profile (e.g., zosmf)

      +
      +
    • +
    +

    Returns IProfLoc

    +
  • +
+
+
+ +

Private argTeamConfigLoc

+ + +
+
+ +

buildSchema

+ + +
+
+ +

Private ensureReadFromDisk

+
    +
  • ensureReadFromDisk(): void
  • +
+ +
+
+ +

Private findTeamOsLocation

+
    +
  • findTeamOsLocation(jsonPath: string, excludeHomeDir?: boolean): string[]
  • +
+
    +
  • + +
    +
    +

    Parameters

    +
      +
    • +
      jsonPath: string
      +
      +

      The long form JSON path of the profile we are searching for.

      +
      +
    • +
    • +
      Optional excludeHomeDir: boolean
      +
      +

      The long form JSON path of the profile we are searching for.

      +
      +
    • +
    +

    Returns string[]

    +

    A string array containing the location of all files containing the specified team profile

    +
  • +
+
+
+ +

getAllProfiles

+ +
    +
  • + +
    +
    +

    Get all of the typed profiles in the configuration.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional profileType: string
      +
      +
         Limit selection to only profiles of the specified type.
      +   If not supplied, the names of all typed profiles are returned.
      +
      +
      +
    • +
    • +
      Optional options: IGetAllProfilesOptions
      +
    • +
    +

    Returns IProfAttrs[]

    +

    An array of profile attribute objects. + In addition to the name, you get the profile type, + an indicator of whether the profile is the default profile + for that type, and the location of that profile.

    +
         If no profile exists for the specified type (or if
    +     no profiles of any kind exist), we return an empty array
    +     ie, length is zero.
    +
    +
  • +
+
+
+ +

getDefaultProfile

+
    +
  • getDefaultProfile(profileType: string): IProfAttrs | null
  • +
+
    +
  • + +
    +
    +

    Get the default profile for the specified profile type.

    +
    +
    +

    Parameters

    +
      +
    • +
      profileType: string
      +
      +
         The type of profile of interest.
      +
      +
      +
    • +
    +

    Returns IProfAttrs | null

    +

    The default profile. If no profile exists + for the specified type, we return null;

    +
  • +
+
+
+ +

getOsLocInfo

+ + +
+
+ +

getProfileTypes

+
    +
  • getProfileTypes(sources?: string[]): string[]
  • +
+ +
+
+ +

getSchemaForType

+ +
    +
  • + +
    +
    +

    Returns the schema object belonging to the specified profile type.

    +
    +
    +

    Parameters

    +
      +
    • +
      profileType: string
      +
      +

      The profile type to retrieve the schema from

      +
      +
    • +
    +

    Returns IProfileSchema

    +

    The schema object provided by the specified profile type

    +
  • +
+
+
+ +

getTeamConfig

+ +
    +
  • + +
    +
    +

    Get the Config object used to manipulate the team configuration on disk.

    +
    +

    Our current market direction is to encourage customers to edit the + team configuration files in their favorite text editor.

    +

    If you must ignore this recommended practice, you must use the Config + class to manipulate the team config files. This class has a more detailed + and therefore more complicated API, but it does contain functions to + write data to the team configuration files.

    +

    You must call ProfileInfo.readProfilesFromDisk() before calling this function.

    +
    +

    Returns Config

    +

    An instance of the Config class that can be used to manipulate + the team configuration on disk.

    +
  • +
+
+
+ +

Private getTeamSubProfiles

+
    +
  • getTeamSubProfiles(path: string, jsonPath: string, profObj: {}, profileType?: string): IProfAttrs[]
  • +
+
    +
  • + +
    +
    +

    Get all of the subprofiles in the configuration.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +
      +
           The short form profile name dotted path
      +
      +
      +
    • +
    • +
      jsonPath: string
      +
      +
           The long form profile dotted path
      +
      +
      +
    • +
    • +
      profObj: {}
      +
      +
           The profiles object from the parent profile.
      +     Contains the subprofiles to search through.
      +
      +
      +
        +
      • +
        [key: string]: any
        +
      • +
      +
    • +
    • +
      Optional profileType: string
      +
      +
           Limit selection to only profiles of the specified type.
      +     If not supplied, the names of all typed profiles are returned.
      +
      +
      +
    • +
    +

    Returns IProfAttrs[]

    +

    An array of profile attribute objects. + In addition to the name, you get the profile type, + an indicator of whether the profile is the default profile + for that type, and the location of that profile.

    +
         If no profile exists for the specified type (or if
    +     no profiles of any kind exist), we return an empty array
    +     ie, length is zero.
    +
    +
  • +
+
+
+ +

Private initImpUtils

+
    +
  • initImpUtils(): void
  • +
+ +
+
+ +

Private isDefaultTeamProfile

+
    +
  • isDefaultTeamProfile(path: string, profileType?: string): boolean
  • +
+
    +
  • + +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +
      +
               The short form profile name dotted path
      +
      +
      +
    • +
    • +
      Optional profileType: string
      +
      +
               Limit selection to profiles of the specified type
      +
      +
      +
    • +
    +

    Returns boolean

    +

    A boolean true if the profile is a default profile, + and a boolean false if the profile is not a default profile

    +
  • +
+
+
+ +

isSecured

+
    +
  • isSecured(): boolean
  • +
+ +
+
+ +

Private loadAllSchemas

+
    +
  • loadAllSchemas(): void
  • +
+
    +
  • + +
    +
    +

    Load any profile schema objects found on disk and cache them. For team + config, we check each config layer and load its schema JSON if there is + one associated. For old school profiles, we load the meta YAML file for + each profile type if it exists in the profile root directory.

    +
    +
    +

    Returns void

    +
  • +
+
+
+ +

Private loadSchema

+ + +
+
+ +

loadSecureArg

+ + +
+
+ +

mergeArgsForProfile

+ +
    +
  • + +
    +
    +

    Merge all of the available values for arguments defined for the + specified profile. Values are retrieved from the following sources. + Each successive source will override the previous source.

    +
      +
    • A default value for the argument that is defined in the profile definition.
    • +
    • A value defined in the base profile.
    • +
    • A value defined in the specified service profile.
    • +
    • For a team configuration, both the base profile values and the + service profile values will be overridden with values from a + zowe.config.user.json file (if it exists).
    • +
    • An environment variable for that argument (if environment overrides + are enabled).
    • +
    +
    +
    +

    Parameters

    +
      +
    • +
      profile: IProfAttrs
      +
      +
         The profile whose arguments are to be merged.
      +
      +
      +
    • +
    • +
      Default value mergeOpts: IProfMergeArgOpts = { getSecureVals: false }
      +
      +
         Options to use when merging arguments.
      +   This parameter is not required. Defaults will be used.
      +
      +
      +
    • +
    +

    Returns IProfMergedArg

    +

    An object that contains an array of known profile argument + values and an array of required profile arguments which + have no value assigned. Either of the two arrays could be + of zero length, depending on the user's configuration and + environment.

    +
         We will return null if the profile does not exist
    +     in the current Zowe configuration.
    +
    +
  • +
+
+
+ +

mergeArgsForProfileType

+ +
    +
  • + +
    +
    +

    Merge all of the available values for arguments defined for the + specified profile type. See mergeArgsForProfile() for details + about the merging algorithm. + The intended use is when no profile of a specific type exists. + The consumer app can prompt for values for missing arguments + and then perform the desired operation.

    +
    +
    +

    Parameters

    +
      +
    • +
      profileType: string
      +
      +
         The type of profile of interest.
      +
      +
      +
    • +
    • +
      Default value mergeOpts: IProfMergeArgOpts = { getSecureVals: false }
      +
      +
         Options to use when merging arguments.
      +   This parameter is not required. Defaults will be used.
      +
      +
      +
    • +
    +

    Returns IProfMergedArg

    +

    The complete set of required properties;

    +
  • +
+
+
+ +

Private oldProfileFilePath

+
    +
  • oldProfileFilePath(profileType: string, profileName: string): string
  • +
+
    +
  • + +
    +
    +

    Given a profile name and type, return the OS location of the associated + YAML file.

    +
    +
    +

    Parameters

    +
      +
    • +
      profileType: string
      +
      +

      Type of an old school profile (e.g., zosmf)

      +
      +
    • +
    • +
      profileName: string
      +
      +

      Name of an old school profile (e.g., LPAR1)

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

Private omitCmdPropsFromSchema

+
    +
  • omitCmdPropsFromSchema(obj: Record<string, any>): Record<string, IProfileProperty>
  • +
+
    +
  • + +
    +
    +

    This helper function removes all command-related properties from the given schema properties object and returns it. + This is so we can easily compare schemas from disk with those that are registered with type ICommandProfileSchema. + It's also been added to avoid a breaking change (as we currently allow ICommandProfileSchema objects to be registered).

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: Record<string, any>
      +
      +

      The properties object from the schema

      +
      +
    • +
    +

    Returns Record<string, IProfileProperty>

    +

    The properties object, but with all of the command-related properties removed

    +
  • +
+
+
+ +

Private overrideWithEnv

+ +
    +
  • + +
    +
    +

    Override values in a merged argument object with values found in + environment variables. The choice to override enviroment variables is + controlled by an option on the ProfileInfo constructor.

    +
    +
    +

    Parameters

    +
      +
    • +
      mergedArgs: IProfMergedArg
      +
      +
       On input, this must be an object containing merged arguments
      + obtained from configuration settings. This function will override
      + values in mergedArgs.knownArgs with values found in environment
      + variables. It will also move arguments from mergedArgs.missingArgs
      + into mergedArgs.knownArgs if a value is found in an environment
      + variable for any missingArgs.
      +
      +
      +
    • +
    • +
      Optional profSchema: IProfileSchema
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

readProfilesFromDisk

+ +
    +
  • + +
    +
    +

    Read either the new team configuration files (if any exist) or + read the old-school profile files.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional teamCfgOpts: IConfigOpts
      +
      +
         The optional choices used when reading a team configuration.
      +   This parameter is ignored, if the end-user is using old-school
      +   profiles.
      +
      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+ +

removeKnownProperty

+ +
    +
  • + +
    +
    +

    Remove a known property from the ProfileInfo class + This method will call the updateKnownProperty method with a value set to undefined and serves as a helper function + to make is easier to understand when a known property is removed.

    +
    +
    +
    example
    +

    The example below describes how to remove a property

    +
        // Using the removeKnownProperty method
    +    profileInfo.removeKnownProperty({mergedArgs, property: "someProperty"});
    +    // Using the updateKnownProperty method
    +    profileInfo.updateKnownProperty({mergedArgs, property: "someProperty", value: undefined, isSecure: false});
    +
    +
    +
    +
    +

    Parameters

    + +

    Returns Promise<boolean>

    +

    Returns a boolean indicating if the property has been removed

    +
  • +
+
+
+ +

updateKnownProperty

+ +
    +
  • + +
    +
    +

    Update a given property with the value provided. + This function only works for properties that can be found in the config files (including secure arrays). + If the property cannot be found, this function will resolve to false + This function supports v1 profiles

    +
    +
    +

    Parameters

    + +

    Returns Promise<boolean>

    +
  • +
+
+
+ +

updateProperty

+ + +
+
+ +

Private updateSchemaAtLayer

+
    +
  • updateSchemaAtLayer(profileType: string, schema: IProfileSchema, versionChanged?: boolean): void
  • +
+
    +
  • + +
    +
    +

    Updates the schema to contain the new profile type. + If the type exists in the cache, it will use the matching layer; if not found, it will use the schema at the active layer.

    +
    +
    +

    Parameters

    +
      +
    • +
      profileType: string
      +
      +

      The profile type to add into the schema

      +
      +
    • +
    • +
      schema: IProfileSchema
      +
    • +
    • +
      Optional versionChanged: boolean
      +
    • +
    +

    Returns void

    +

    true if added to the schema; false otherwise

    +
  • +
+
+
+ +

Static createSession

+ +
    +
  • + +
    +
    +

    Create a session from profile arguments that have been retrieved from + ProfileInfo functions.

    +
    +
    +

    Parameters

    +
      +
    • +
      profArgs: IProfArgAttrs[]
      +
      +
       An array of profile arguments.
      +
      +
      +
    • +
    • +
      Default value connOpts: IOptionsForAddConnProps = {}
      +
      +
       Options that alter our actions. See IOptionsForAddConnProps.
      + The connOpts parameter need not be supplied.
      + Default properties may be added to any supplied connOpts.
      + The only option values used by this function are:
      +     connOpts.requestToken
      +     connOpts.defaultTokenType
      +
      +
      +
    • +
    +

    Returns Session

    +

    A session that can be used to connect to a remote host.

    +
  • +
+
+
+ +

Static initSessCfg

+ +
    +
  • + +
    +
    +

    Initialize a session configuration object with the arguments + from profArgs

    +
    +
    +

    Parameters

    +
      +
    • +
      profArgs: IProfArgAttrs[]
      +
      +
       An array of profile argument attributes.
      +
      +
      +
    • +
    • +
      Optional argNames: string[]
      +
      +
       An array of argument names to load from the profile. Defaults to
      + all arguments that have an associated ISession property.
      +
      +
      +
    • +
    +

    Returns ISession

    +

    A session containing all of the supplied profile argument + attributes that are relevant to a session.

    +
  • +
+
+
+ +

Static profAttrsToProfLoaded

+ +
    +
  • + +
    +
    +

    Convert an IProfAttrs object into an IProfileLoaded objects + This is a convenience function. IProfileLoaded was frequently passed + among functions. This conversion function allows existing code to + acquire values in the IProfAttrs structure but pass those values + around in the older IProfileLoaded structure. The IProfAttrs + properties will be copied as follows:

    +
    +
     IProfileLoaded.name    <-- IProfAttrs.profName
    + IProfileLoaded.type    <-- IProfAttrs.profType
    + IProfileLoaded.profile <-- profAttrs
    +
    +
    +

    Parameters

    +
      +
    • +
      profAttrs: IProfAttrs
      +
      +
       A profile attributes object.
      +
      +
      +
    • +
    • +
      Optional dfltProfLoadedVals: any
      +
      +
       A JSON object containing additional names from IProfileLoaded for
      + which a value should be supplied. IProfileLoaded contains more
      + properties than IProfAttrs. The items in this object will be
      + placed into the resulting IProfileLoaded object.
      + We use type "any" because all of the required properties of
      + IProfileLoaded will not be supplied by dfltProfLoadedVals.
      + If dfltProfLoadedVals is not supplied, only the following minimal
      + set if hard-coded properties will be added to the IProfileLoaded object.
      +
      + IProfileLoaded.message      <-- "" (an empty string)
      + IProfileLoaded.failNotFound <-- false
      +
      +
      +
    • +
    +

    Returns IProfileLoaded

    +

    An IProfileLoaded object;

    +
  • +
+
+
+ +

Static readExtendersJsonFromDisk

+ + +
+
+ +

Static writeExtendersJson

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profileio.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profileio.html new file mode 100644 index 0000000000..a2d7eab63c --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profileio.html @@ -0,0 +1,816 @@ + + + + + + ProfileIO | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfileIO

+
+
+
+
+
+
+
+
+
+

Profile IO methods for writing/reading profiles to disk. The profile managers never invoke "fs" directly. + All "fs" calls are wrapped here and errors are transformed to ImperativeError for error handling/flow throughout + Imperative.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ProfileIO +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Private ERROR_ID

+
ERROR_ID: string = "Profile IO Error"
+ +
+
+

Error IO tag for Imperative Errors

+
+
+
static
+
+
memberof
+

ProfileIO

+
+
+
+
+
+ +

Static Readonly MAX_YAML_DEPTH

+
MAX_YAML_DEPTH: number = 9999
+ +
+
+

The yamljs package requires you to indicate the depth for conversion to yaml. Set to max of 9999.

+
+
+
static
+
+
memberof
+

ProfileIO

+
+
+
+
+
+
+

Methods

+
+ +

Static Private crashInTeamConfigMode

+
    +
  • crashInTeamConfigMode(): void
  • +
+
    +
  • + +
    +
    +

    Crash if we detect that we are running in team-config mode. + You should not be able to operate on old-school profiles + when you are in team-config mode. Give a meaningful + message as part of our crash.

    +
    +
    +

    Returns void

    +
  • +
+
+
+ +

Static createProfileDirs

+
    +
  • createProfileDirs(path: string): void
  • +
+
    +
  • + +
    +
    +

    Creates the full set of directories indicated by the path. Used to create the profile root directory and + type directories.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProfileIO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +
      +

      The directory path to create - creates all necessary subdirectories.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static deleteProfile

+
    +
  • deleteProfile(name: string, fullFilePath: string): void
  • +
+
    +
  • + +
    +
    +

    Delete the profile and ensure it is gone.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProfileIO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      the profile object - really only used for error messages

      +
      +
    • +
    • +
      fullFilePath: string
      +
      +

      the full file path to delete

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static exists

+
    +
  • exists(path: string): string
  • +
+
    +
  • + +
    +
    +

    Checks if the file specified exists.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProfileIO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +
      +

      The file path

      +
      +
    • +
    +

    Returns string

    +
      +
    • the path to the existing file or NULL if not found
    • +
    +
  • +
+
+
+ +

Static fileToProfileName

+
    +
  • fileToProfileName(file: string, ext: string): string
  • +
+
    +
  • + +
    +
    +

    Extracts the profile name from the file path/name

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProfileIO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      file: string
      +
      +

      the file path to extract the profile name

      +
      +
    • +
    • +
      ext: string
      +
      +

      the extension of the file

      +
      +
    • +
    +

    Returns string

    +
      +
    • the profile name
    • +
    +
  • +
+
+
+ +

Static getAllProfileDirectories

+
    +
  • getAllProfileDirectories(profileRootDirectory: string): string[]
  • +
+
    +
  • + +
    +
    +

    Accepts the profiles root directory and returns all directories within. The directories within the root + directory are all assumed to be profile type directories (potentially containing a meta file and profiles + of that type).

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProfileIO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      profileRootDirectory: string
      +
      +

      The profiles root directory to obtain all profiles from.

      +
      +
    • +
    +

    Returns string[]

    +
      +
    • The list of profiles returned or a blank array
    • +
    +
  • +
+
+
+ +

Static getAllProfileNames

+
    +
  • getAllProfileNames(profileTypeDir: string, ext: string, metaNameForType: string): string[]
  • +
+
    +
  • + +
    +
    +

    Accepts the profile directory location for a type, reads all filenames, and returns a list of + profile names that are present within the directory (excluding the meta profile)

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProfileIO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      profileTypeDir: string
      +
      +

      The directory for the type

      +
      +
    • +
    • +
      ext: string
      +
      +

      the extension for the profile files (normally YAML)

      +
      +
    • +
    • +
      metaNameForType: string
      +
      +

      the meta name for this type

      +
      +
    • +
    +

    Returns string[]

    +
      +
    • A list of all profile names (without path/ext)
    • +
    +
  • +
+
+
+ +

Static readMetaFile

+ +
    +
  • + +
    +
    +

    Read the profile meta file using Yaml "safeLoad" (ensures that no code executes, etc. during the load). The + meta profile file for a type contains the default profile specification. The meta profile is ALWAYS in YAML + format (controlled exclusively by the Imperative framework).

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProfileIO

    +
    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      path: string
      +
      +

      The path to the meta profile

      +
      +
    • +
    +

    Returns IMetaProfile<T>

    +
      +
    • The meta profile
    • +
    +
  • +
+
+
+ +

Static readProfileFile

+
    +
  • readProfileFile(filePath: string, type: string): IProfile
  • +
+
    +
  • + +
    +
    +

    Read a profile from disk. Profiles are always assumed to be YAML (YAML "safeLoad" is invoked to perform the load).

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProfileIO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      filePath: string
      +
      +

      Path to the profile.

      +
      +
    • +
    • +
      type: string
      +
      +

      The profile type; used to populate the "type" in the profile object (type property not persisted on disk).

      +
      +
    • +
    +

    Returns IProfile

    +
      +
    • The profile object.
    • +
    +
  • +
+
+
+ +

Static writeMetaFile

+ + +
+
+ +

Static writeProfile

+
    +
  • writeProfile(fullFilePath: string, profile: IProfile): void
  • +
+
    +
  • + +
    +
    +

    Accepts a profile object and writes the profile to the specified location (and optionally converts + the profile to YAML format - the default for Imperative profiles).

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProfileIO

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      fullFilePath: string
      +
      +

      the fully qualified profile path, file, & extension.

      +
      +
    • +
    • +
      profile: IProfile
      +
      +

      the profile object to write to disk.

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profilescommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilescommandbuilder.html new file mode 100644 index 0000000000..7c515e4069 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilescommandbuilder.html @@ -0,0 +1,537 @@ + + + + + + ProfilesCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfilesCommandBuilder

+
+
+
+
+
+
+
+
+
+

Abstract class for generating profile-related commands

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mLogger

+
mLogger: Logger
+ +
+
+

logger instance to use for the builder class

+
+
+
+
+ +

Protected mProfileConfig

+ + +
+
+ +

Protected mProfileType

+
mProfileType: string
+ +
+
+

the name of the profile type e.g. banana

+
+
+
+
+ +

Protected mSchema

+ + +
+
+

Schema for the command.

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

Abstract buildFull

+ + +
+
+ +

Protected buildOptionsFromProfileSchema

+ + +
+
+ +

Protected Abstract buildProfileSegmentFromSchema

+ + +
+
+ +

Abstract getAction

+
    +
  • getAction(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Protected property
  • +
  • Protected method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesconstants.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesconstants.html new file mode 100644 index 0000000000..c7a9d2f6a8 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesconstants.html @@ -0,0 +1,311 @@ + + + + + + ProfilesConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfilesConstants

+
+
+
+
+
+
+
+
+
+

Constants used within the auto-generated profiles group

+
+
+
+
+

Hierarchy

+
    +
  • + ProfilesConstants +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly DEPRECATE_TO_CONFIG_EDIT

+
DEPRECATE_TO_CONFIG_EDIT: "Edit your Zowe V2 configuration" = "Edit your Zowe V2 configuration"
+ +
+
+ +

Static Readonly DEPRECATE_TO_CONFIG_INIT

+
DEPRECATE_TO_CONFIG_INIT: "The 'config init' command" = "The 'config init' command"
+ +
+
+ +

Static Readonly DEPRECATE_TO_CONFIG_LIST

+
DEPRECATE_TO_CONFIG_LIST: "The 'config list' command" = "The 'config list' command"
+ +
+
+ +

Static Readonly DEPRECATE_TO_CONFIG_SET

+
DEPRECATE_TO_CONFIG_SET: "The 'config set' command" = "The 'config set' command"
+ +
+
+ +

Static Readonly PROFILES_COMMAND_TYPE_KEY

+
PROFILES_COMMAND_TYPE_KEY: "profileTypeIdentifier" = "profileTypeIdentifier"
+ +
+
+ +

Static Readonly PROFILES_OPTION_SECURELY_STORED

+
PROFILES_OPTION_SECURELY_STORED: "managed by" = "managed by"
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profilescreatecommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilescreatecommandbuilder.html new file mode 100644 index 0000000000..b14bdb6b2f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilescreatecommandbuilder.html @@ -0,0 +1,532 @@ + + + + + + ProfilesCreateCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfilesCreateCommandBuilder

+
+
+
+
+
+
+
+
+
+

Used to build profile create command definitions. + Used automatically if you allow the "profiles" command group to be generated

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mLogger

+
mLogger: Logger
+ +
+
+

logger instance to use for the builder class

+
+
+
+
+ +

Protected mProfileConfig

+ + +
+
+ +

Protected mProfileType

+
mProfileType: string
+ +
+
+

the name of the profile type e.g. banana

+
+
+
+
+ +

Protected mSchema

+ + +
+
+

Schema for the command.

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

buildFull

+ + +
+
+ +

Protected buildOptionsFromProfileSchema

+ + +
+
+ +

Protected buildProfileSegmentFromSchema

+ + +
+
+ +

getAction

+
    +
  • getAction(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited method
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesdeletecommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesdeletecommandbuilder.html new file mode 100644 index 0000000000..6473aaf48f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesdeletecommandbuilder.html @@ -0,0 +1,532 @@ + + + + + + ProfilesDeleteCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfilesDeleteCommandBuilder

+
+
+
+
+
+
+
+
+
+

Used to build delete profile command definitions. + Used automatically if you allow the "profiles" command group to be generated

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mLogger

+
mLogger: Logger
+ +
+
+

logger instance to use for the builder class

+
+
+
+
+ +

Protected mProfileConfig

+ + +
+
+ +

Protected mProfileType

+
mProfileType: string
+ +
+
+

the name of the profile type e.g. banana

+
+
+
+
+ +

Protected mSchema

+ + +
+
+

Schema for the command.

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

buildFull

+ + +
+
+ +

Protected buildOptionsFromProfileSchema

+ + +
+
+ +

Protected buildProfileSegmentFromSchema

+ + +
+
+ +

getAction

+
    +
  • getAction(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Inherited constructor
  • +
  • Inherited method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profileshandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profileshandler.html new file mode 100644 index 0000000000..7fe8a1c948 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profileshandler.html @@ -0,0 +1,313 @@ + + + + + + ProfilesHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfilesHandler

+
+
+
+
+
+
+
+
+
+

The get command group handler for cli configuration settings.

+
+
+
+
+

Hierarchy

+
    +
  • + ProfilesHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Private build

+
    +
  • build(profiles: {}, path: string, paths: string[]): void
  • +
+ +
+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profileslistcommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profileslistcommandbuilder.html new file mode 100644 index 0000000000..0a78f8621e --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profileslistcommandbuilder.html @@ -0,0 +1,532 @@ + + + + + + ProfilesListCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfilesListCommandBuilder

+
+
+
+
+
+
+
+
+
+

Used to build profile update command definitions. + Used automatically if you allow the "profiles" command group to be generated

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mLogger

+
mLogger: Logger
+ +
+
+

logger instance to use for the builder class

+
+
+
+
+ +

Protected mProfileConfig

+ + +
+
+ +

Protected mProfileType

+
mProfileType: string
+ +
+
+

the name of the profile type e.g. banana

+
+
+
+
+ +

Protected mSchema

+ + +
+
+

Schema for the command.

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

buildFull

+ + +
+
+ +

Protected buildOptionsFromProfileSchema

+ + +
+
+ +

Protected buildProfileSegmentFromSchema

+ + +
+
+ +

getAction

+
    +
  • getAction(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited method
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profilessetcommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilessetcommandbuilder.html new file mode 100644 index 0000000000..054f8cd014 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilessetcommandbuilder.html @@ -0,0 +1,532 @@ + + + + + + ProfilesSetCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfilesSetCommandBuilder

+
+
+
+
+
+
+
+
+
+

Used to build "set default profile" command definitions. + Used automatically if you allow the "profiles" command group to be generated

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mLogger

+
mLogger: Logger
+ +
+
+

logger instance to use for the builder class

+
+
+
+
+ +

Protected mProfileConfig

+ + +
+
+ +

Protected mProfileType

+
mProfileType: string
+ +
+
+

the name of the profile type e.g. banana

+
+
+
+
+ +

Protected mSchema

+ + +
+
+

Schema for the command.

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

buildFull

+ + +
+
+ +

Protected buildOptionsFromProfileSchema

+ + +
+
+ +

Protected buildProfileSegmentFromSchema

+ + +
+
+ +

getAction

+
    +
  • getAction(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Inherited constructor
  • +
  • Inherited method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html new file mode 100644 index 0000000000..39cb6d814e --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesshowdependenciescommandbuilder.html @@ -0,0 +1,532 @@ + + + + + + ProfilesShowDependenciesCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfilesShowDependenciesCommandBuilder

+
+
+
+
+
+
+
+
+
+

Used to build profile create command definitions. + Used automatically if you allow the "profiles" command group to be generated

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mLogger

+
mLogger: Logger
+ +
+
+

logger instance to use for the builder class

+
+
+
+
+ +

Protected mProfileConfig

+ + +
+
+ +

Protected mProfileType

+
mProfileType: string
+ +
+
+

the name of the profile type e.g. banana

+
+
+
+
+ +

Protected mSchema

+ + +
+
+

Schema for the command.

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

buildFull

+ + +
+
+ +

Protected buildOptionsFromProfileSchema

+ + +
+
+ +

Protected buildProfileSegmentFromSchema

+ + +
+
+ +

getAction

+
    +
  • getAction(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Inherited constructor
  • +
  • Inherited method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesupdatecommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesupdatecommandbuilder.html new file mode 100644 index 0000000000..81dd629400 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesupdatecommandbuilder.html @@ -0,0 +1,532 @@ + + + + + + ProfilesUpdateCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfilesUpdateCommandBuilder

+
+
+
+
+
+
+
+
+
+

Used to build profile update command definitions. + Used automatically if you allow the "profiles" command group to be generated

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mLogger

+
mLogger: Logger
+ +
+
+

logger instance to use for the builder class

+
+
+
+
+ +

Protected mProfileConfig

+ + +
+
+ +

Protected mProfileType

+
mProfileType: string
+ +
+
+

the name of the profile type e.g. banana

+
+
+
+
+ +

Protected mSchema

+ + +
+
+

Schema for the command.

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

buildFull

+ + +
+
+ +

Protected buildOptionsFromProfileSchema

+ + +
+
+ +

Protected buildProfileSegmentFromSchema

+ + +
+
+ +

getAction

+
    +
  • getAction(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Inherited constructor
  • +
  • Inherited method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesvalidatecommandbuilder.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesvalidatecommandbuilder.html new file mode 100644 index 0000000000..95475eb181 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilesvalidatecommandbuilder.html @@ -0,0 +1,532 @@ + + + + + + ProfilesValidateCommandBuilder | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfilesValidateCommandBuilder

+
+
+
+
+
+
+
+
+
+

Used to build profile validate command definitions. + Used automatically if you allow the "profiles" command group to be generated

+
+
+
+
+

Hierarchy

+ +
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected mLogger

+
mLogger: Logger
+ +
+
+

logger instance to use for the builder class

+
+
+
+
+ +

Protected mProfileConfig

+ + +
+
+ +

Protected mProfileType

+
mProfileType: string
+ +
+
+

the name of the profile type e.g. banana

+
+
+
+
+ +

Protected mSchema

+ + +
+
+

Schema for the command.

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

buildFull

+ + +
+
+ +

Protected buildOptionsFromProfileSchema

+ + +
+
+ +

Protected buildProfileSegmentFromSchema

+ + +
+
+ +

getAction

+
    +
  • getAction(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited method
  • +
+
    +
  • Protected method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profileutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profileutils.html new file mode 100644 index 0000000000..d93156b164 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profileutils.html @@ -0,0 +1,566 @@ + + + + + + ProfileUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfileUtils

+
+
+
+
+
+
+
+
+
+

Set of static utility methods to assist with creating profile option names from profile types, constructing the + root directory, reforming responses for different purposes, etc.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ProfileUtils +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static constructProfilesRootDirectory

+
    +
  • constructProfilesRootDirectory(home: string): string
  • +
+
    +
  • + +
    +
    +

    Construct the profiles root directory, given the "home" directory.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProfileUtils

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      home: string
      +
      +

      The home directory - normally supplied by Imperative.

      +
      +
    • +
    +

    Returns string

    +
      +
    • The profiles root directory
    • +
    +
  • +
+
+
+ +

Static flattenDependencies

+ +
    +
  • + +
    +
    +

    Accepts an array of responses, which, depending on the depedencies, may have nested depedency arrays, and + flattens to a single level (for ease of printing, etc.).

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProfileUtils

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      dependencyResponses: IProfileLoaded[]
      +
      +

      The list of load responses

      +
      +
    • +
    +

    Returns IProfileLoaded[]

    +
      +
    • The list of load responses flattened to a single level
    • +
    +
  • +
+
+
+ +

Static getAllTypeNames

+ + +
+
+ +

Static getProfileMapKey

+
    +
  • getProfileMapKey(type: string, name: string): string
  • +
+
    +
  • + +
    +
    +

    Create a mapKey value to identify a profile

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
      +
      +

      Type of the profile

      +
      +
    • +
    • +
      name: string
      +
      +

      Name of the profile

      +
      +
    • +
    +

    Returns string

    +
      +
    • Key identifying the profile
    • +
    +
  • +
+
+
+ +

Static getProfileOption

+
    +
  • getProfileOption(type: string): string
  • +
+
    +
  • + +
    +
    +

    Construct the profile option - e.g banana-profile - Used to append to commands automatically + and by the command processor to check if profile options are present.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
      +
    • +
    +

    Returns string

    +
      +
    • The full option name
    • +
    +
  • +
+
+
+ +

Static getProfileOptionAlias

+
    +
  • getProfileOptionAlias(type: string): string
  • +
+
    +
  • + +
    +
    +

    Construct the profile option alias - e.g banana-p- Used to append to commands automatically + and by the command processor to check if profile options are present.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
      +
    • +
    +

    Returns string

    +
      +
    • The alias for the profile option
    • +
    +
  • +
+
+
+ +

Static getProfileOptionAndAlias

+
    +
  • getProfileOptionAndAlias(type: string): [string, string]
  • +
+ +
+
+ +

Static getProfilePropertyKey

+
    +
  • getProfilePropertyKey(type: string, name: string, field: string): string
  • +
+
    +
  • + +
    +
    +

    Create a key value to identify a property on a profile

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
      +
      +

      Type of the profile

      +
      +
    • +
    • +
      name: string
      +
      +
      +

      Name of the profile

      +
      +
      +
    • +
    • +
      field: string
      +
    • +
    +

    Returns string

    +
      +
    • Key identifying the profile
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profilevalidator.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilevalidator.html new file mode 100644 index 0000000000..4bb4942b42 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profilevalidator.html @@ -0,0 +1,549 @@ + + + + + + ProfileValidator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfileValidator

+
+
+
+
+
+
+
+
+
+

API for going through the full validation test for a Brightside CLI profile + and producing validation report

+
+
+
+
+

Hierarchy

+
    +
  • + ProfileValidator +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Static Readonly CUSTOMIZE_PLAN_KEY

+
CUSTOMIZE_PLAN_KEY: "validationPlanModule" = "validationPlanModule"
+ +
+
+

The key used to access the filename for the type containing the profile + validation plan object. On your profile validation command definition, + specify the filename in .customize[CUSTOMIZE_PLAN_KEY]

+
+
+
+
+
+

Accessors

+
+ +

Static PRINT_PLAN_OPTION

+ + +
+
+
+

Methods

+
+ +

Static Private countOutcomes

+ + +
+
+ +

Static getTextDisplayForPlan

+ +
    +
  • + +
    +
    +

    Get a printed/tabular version of your validation plan, + so that the user can see what steps the Brightside CLI will take to validate their profile

    +
    +
    +

    Parameters

    +
      +
    • +
      plan: IProfileValidationPlan
      +
      +

      the plan for profile validation

      +
      +
    • +
    • +
      profile: IProfile
      +
      +

      the profile that would be validated - used only in this case to show a summary of the profile's contents

      +
      +
    • +
    • +
      primaryHighlightColor: string
      +
      +

      primary highlight color for use with chalk

      +
      +
    • +
    +

    Returns string

    +
      +
    • the formatted report
    • +
    +
  • +
+
+
+ +

Static getTextDisplayForReport

+ +
    +
  • + +
    +
    +

    Get a printed/tabular version of your validation report

    +
    +
    +

    Parameters

    +
      +
    • +
      report: IProfileValidationReport
      +
      +

      your completed validation result

      +
      +
    • +
    • +
      plan: IProfileValidationPlan
      +
      +

      the validation plan to use

      +
      +
    • +
    • +
      productDisplayName: string
      +
      +

      the display name for your CLI used in the final result text

      +
      +
    • +
    • +
      primaryHighlightColor: string
      +
      +

      color used to highlight headings and tables (used with chalk package)

      +
      +
    • +
    • +
      profileName: string
      +
      +

      the name of the profile that was validated

      +
      +
    • +
    • +
      profileType: string
      +
      +

      the type of the profile that was validated

      +
      +
    • +
    +

    Returns string

    +
      +
    • the formatted report
    • +
    +
  • +
+
+
+ +

Static outcomeToString

+ + +
+
+ +

Static validate

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.profinfoerr.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.profinfoerr.html new file mode 100644 index 0000000000..6323aed09f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.profinfoerr.html @@ -0,0 +1,797 @@ + + + + + + ProfInfoErr | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProfInfoErr

+
+
+
+
+
+
+
+
+
+

This class is the error exception mechanism for the ProfileInfo API. + It is derived from ImperativeError. We use a separate class so that + our consumer can check the type of error, and then rely on errorCode + values that are unique to ProfInfoErr. ProfInfoErr will always + populate the errorCode property. Our consumer can use the errorCode to + determine if it should process partial results.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

mDetails

+ + +
+
+ +

Private mItemsInError

+
mItemsInError: string[] = []
+ +
+
+

Additional error properties, specific to ProfInfoErr.

+
+
+
+
+ +

name

+
name: string
+ +
+
+ +

Static Readonly CANT_GET_SCHEMA_URL

+
CANT_GET_SCHEMA_URL: string = "CantGetSchemaUrl"
+ +
+
+

Unable to retrieve the schema from a URL reference. + Currently, the ProfiInfo API does not attempt to retrieve a schema + through a URL. A URL does work to provide intellisense in VSCode + when editing a config file.

+
+
+
+
+ +

Static Readonly INVALID_PROF_LOC_TYPE

+
INVALID_PROF_LOC_TYPE: string = "InvalidProfLocType"
+ +
+
+

The specified type of profile location is invalid for the requested operation.

+
+
+
+
+ +

Static Readonly LOAD_CRED_MGR_FAILED

+
LOAD_CRED_MGR_FAILED: string = "LoadCredMgrFailed"
+ +
+
+

Failed to initialize ProfileCredentials and load the credential manager.

+
+
+
+
+ +

Static Readonly LOAD_SCHEMA_FAILED

+
LOAD_SCHEMA_FAILED: string = "LoadSchemaFailed"
+ +
+
+

Failed to load the schema for a specified type of profile.

+
+
+
+
+ +

Static Readonly MISSING_REQ_PROP

+
MISSING_REQ_PROP: string = "MissingProp"
+ +
+
+

A required profile property was not assigned a value.

+
+
+
+
+ +

Static Readonly MUST_READ_FROM_DISK

+
MUST_READ_FROM_DISK: string = "MustReadFromDisk"
+ +
+
+

The ProfileInfo.readProfilesFromDisk function was not called before + a function which requires that prerequisite.

+
+
+
+
+ +

Static Readonly PROF_NOT_FOUND

+
PROF_NOT_FOUND: string = "ProfileNotFound"
+ +
+
+

A specified profile was not found (V1)

+
+
+
+
+ +

Static Readonly PROP_NOT_IN_PROFILE

+
PROP_NOT_IN_PROFILE: string = "PropNotInProfile"
+ +
+
+

A specified property that is expected to exist in a specified profile + does not exist in that profile.

+
+
+
+
+ +

Static Readonly UNKNOWN_PROP_LOCATION

+
UNKNOWN_PROP_LOCATION: string = "UnknownPropLocation"
+ +
+
+

A specified property that is expected to exist in a specified profile + does not have OS and JSON locations defined.

+
+
+
+
+
+

Accessors

+
+ +

additionalDetails

+
    +
  • get additionalDetails(): string
  • +
+ +
+
+ +

causeErrors

+
    +
  • get causeErrors(): any
  • +
+ +
+
+ +

details

+ + +
+
+ +

errorCode

+
    +
  • get errorCode(): string
  • +
+ +
+
+ +

itemsInError

+
    +
  • get itemsInError(): string[]
  • +
+ +
+
+ +

message

+
    +
  • get message(): string
  • +
+ +
+
+ +

stack

+
    +
  • get stack(): string
  • +
+ +
+
+ +

suppressDump

+
    +
  • get suppressDump(): boolean
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited property
  • +
+
    +
  • Private property
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.reportenvhandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.reportenvhandler.html new file mode 100644 index 0000000000..4fee3fa269 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.reportenvhandler.html @@ -0,0 +1,338 @@ + + + + + + ReportEnvHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ReportEnvHandler

+
+
+
+
+
+
+
+
+
+

Handler to report a user's wroking environment.

+
+

We detect and report information from the user environment, including + installed 3rd party prerrequisites. We report those findings.

+

We also maintain a set of known problem conditions (like broken NPM + versions which happen way too often). We use that data to report the + probelem to the customer and any known workaround.

+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ReportEnvHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Private displayEnvItem

+ + +
+
+ +

Private displayEnvReport

+ + +
+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.restclient.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.restclient.html new file mode 100644 index 0000000000..80f4a7fbd6 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.restclient.html @@ -0,0 +1,2839 @@ + + + + + + RestClient | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class RestClient

+
+
+
+
+
+
+
+
+
+

Class to handle http(s) requests, build headers, collect data, report status codes, and header responses + and passes control to session object for maintaining connection information (tokens, checking for timeout, etc...)

+
+
+
export
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private lastByteReceived

+
lastByteReceived: number = 0
+ +
+
+

Last byte received when response is being streamed

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mBytesReceived

+
mBytesReceived: number = 0
+ +
+
+

Bytes received from the server response so far

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mChunks

+
mChunks: Buffer[] = []
+ +
+
+

Contains REST chucks

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mContentEncoding

+
mContentEncoding: ContentEncoding
+ +
+
+

If we get a response containing a Content-Encoding header, + and it matches an encoding type that we recognize, + it is saved here

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mContentLength

+
mContentLength: number
+ +
+
+

If we get a response containing a Content-Length header, + it is saved here

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mData

+
mData: Buffer = Buffer.from([])
+ +
+
+

Contains buffered data after all REST chucks are received

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mDecode

+
mDecode: boolean = true
+ +
+
+

Whether or not to try and decode any encoded response

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mIsJson

+
mIsJson: boolean
+ +
+
+

Indicates if payload data is JSON to be stringified before writing

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mLogger

+
mLogger: Logger
+ +
+
+

Instance of logger

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mNormalizeRequestNewlines

+
mNormalizeRequestNewlines: boolean
+ +
+
+

Indicates if request data should have its newlines normalized to /n before sending + each chunk to the server

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mNormalizeResponseNewlines

+
mNormalizeResponseNewlines: boolean
+ +
+
+

Indicates if response data should have its newlines normalized for the current platform + (\r\n for windows, otherwise \n)

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mReject

+ + +
+
+

Reject for errors when obtaining data

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mReqHeaders

+
mReqHeaders: any[]
+ +
+
+

Save req headers

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mRequest

+
mRequest: HTTP_VERB
+ +
+
+

Save request

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mRequestStream

+
mRequestStream: Readable
+ +
+
+

stream for outgoing request data to the server

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mResolve

+ + +
+
+

Resolved when all data has been obtained

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mResource

+
mResource: string
+ +
+
+

Save resource

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mResponse

+
mResponse: any
+ +
+
+

Contain response from http(s) request

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mResponseStream

+
mResponseStream: Writable
+ +
+
+

Stream for incoming response data from the server. + If specified, response data will not be buffered

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mTask

+ + +
+
+

Task used to display progress bars or other user feedback mechanisms + Automatically updated if task is specified and streams are provided for upload/download

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+ +

Private mWriteData

+
mWriteData: any
+ +
+
+

Save write data

+
+
+
memberof
+

AbstractRestClient

+
+
+
+
+
+
+

Accessors

+
+ +

data

+
    +
  • get data(): Buffer
  • +
+ +
+
+ +

dataString

+
    +
  • get dataString(): string
  • +
+ +
+
+ +

log

+ + +
+
+ +

requestFailure

+
    +
  • get requestFailure(): boolean
  • +
+ +
+
+ +

requestSuccess

+
    +
  • get requestSuccess(): boolean
  • +
+ +
+
+ +

response

+
    +
  • get response(): any
  • +
+ +
+
+ +

session

+ + +
+
+
+

Methods

+
+ +

Protected appendHeaders

+
    +
  • appendHeaders(headers: any[] | undefined): any[]
  • +
+ +
+
+ +

Protected processError

+ +
    +
  • + +
    +
    +

    Process and customize errors encountered in your client. + This is called any time an error is thrown from a failed Rest request using this client. + error before receiving any response body from the API. + You can use this, for example, to set the error tag for you client or add additional + details to the error message. + If you return null or undefined, Imperative will use the default error generated + for your failed request.

    +
    +
    +
    memberof
    +

    AbstractRestClient

    +
    +
    +
    +

    Parameters

    + +

    Returns IImperativeError

    +

    processedError - the error with the fields set the way you want them

    +
  • +
+
+
+ +

request

+ + +
+
+ +

Static deleteExpectBuffer

+ +
    +
  • + +
    +
    +

    REST HTTP DELETE operation

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    +

    Returns Promise<Buffer>

    +
      +
    • response body content from http(s) call
    • +
    +
  • +
+
+
+ +

Static deleteExpectFullResponse

+ + +
+
+ +

Static deleteExpectJSON

+ +
    +
  • + +
    +
    +

    Wrap post for common error handling and supporting generic JSON types

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      T: object

      +
      +

      object type to return

      +
      +
    • +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      the API URI that we are targeting

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers for the http(s) request

      +
      +
    • +
    +

    Returns Promise<T>

    +
      +
    • object on promise
    • +
    +
  • +
+
+
+ +

Static deleteExpectString

+ +
    +
  • + +
    +
    +

    REST HTTP DELETE operation

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    +

    Returns Promise<string>

    +
      +
    • response body content from http(s) call
    • +
    +
  • +
+
+
+ +

Static deleteStreamed

+
    +
  • deleteStreamed(session: AbstractSession, resource: string, reqHeaders?: any[], responseStream: Writable, normalizeResponseNewLines?: boolean, task?: ITaskWithStatus): Promise<string>
  • +
+
    +
  • + +
    +
    +

    REST HTTP DELETE operation

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    • +
      responseStream: Writable
      +
      +

      stream to which the response data will be written

      +
      +
    • +
    • +
      Optional normalizeResponseNewLines: boolean
      +
      +

      streaming only - true if you want newlines to be \r\n on windows + when receiving data from the server to responseStream. Don't set this for binary responses

      +
      +
    • +
    • +
      Optional task: ITaskWithStatus
      +
      +

      task used to update the user on the progress of their request

      +
      +
    • +
    +

    Returns Promise<string>

    +
      +
    • empty string - data is not buffered for streamed requests
    • +
    +
  • +
+
+
+ +

Static Private extractExpectedData

+ +
    +
  • + +
    +
    +

    Helper method to extract requested data from response object + If list is not passed, returns entire response

    +
    +
    +
    static
    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      client: AbstractRestClient
      +
      +

      HTTP(S) response object

      +
      +
    • +
    • +
      Default value toReturn: CLIENT_PROPERTY[] = Object.values(CLIENT_PROPERTY)
      +
      +

      list with object properties to return

      +
      +
    • +
    +

    Returns IRestClientResponse

    +
      +
    • trimmed or full response object based on the list provided
    • +
    +
  • +
+
+
+ +

Static getExpectBuffer

+ +
    +
  • + +
    +
    +

    REST HTTP GET operation

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    +

    Returns Promise<Buffer>

    +
      +
    • response body content from http(s) call
    • +
    +
  • +
+
+
+ +

Static getExpectFullResponse

+ +
    +
  • + +
    +
    +

    REST HTTP GET operation returning full HTTP(S) Response

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    + +

    Returns Promise<IRestClientResponse>

    +
      +
    • full response or filtered based on provided params
    • +
    +
  • +
+
+
+ +

Static getExpectJSON

+ +
    +
  • + +
    +
    +

    Wrap get for common error handling and supporting generic JSON types

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      T: object

      +
      +

      object type to return

      +
      +
    • +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      the API URI that we are targeting

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers for the http(s) request

      +
      +
    • +
    +

    Returns Promise<T>

    +
      +
    • object on promise
    • +
    +
  • +
+
+
+ +

Static getExpectString

+ +
    +
  • + +
    +
    +

    REST HTTP GET operation

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    +

    Returns Promise<string>

    +
      +
    • response body content from http(s) call
    • +
    +
  • +
+
+
+ +

Static getStreamed

+
    +
  • getStreamed(session: AbstractSession, resource: string, reqHeaders?: any[], responseStream: Writable, normalizeResponseNewLines?: boolean, task?: ITaskWithStatus): Promise<string>
  • +
+
    +
  • + +
    +
    +

    REST HTTP GET operation - streaming the response to a writable stream

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    • +
      responseStream: Writable
      +
      +

      the stream to which the response data will be written

      +
      +
    • +
    • +
      Optional normalizeResponseNewLines: boolean
      +
      +

      streaming only - true if you want newlines to be \r\n on windows + when receiving data from the server to responseStream. Don't set this for binary responses

      +
      +
    • +
    • +
      Optional task: ITaskWithStatus
      +
      +

      task used to update the user on the progress of their request

      +
      +
    • +
    +

    Returns Promise<string>

    +
      +
    • empty string - data is not buffered for this request
    • +
    +
  • +
+
+
+ +

Static hasQueryString

+
    +
  • hasQueryString(query: string): boolean
  • +
+
    +
  • + +
    +
    +

    Helper method to return an indicator for whether or not a URI contains a query string.

    +
    +
    +
    static
    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      query: string
      +
      +

      URI

      +
      +
    • +
    +

    Returns boolean

    +
      +
    • true if query is contained within URI
    • +
    +
  • +
+
+
+ +

Static postExpectBuffer

+
    +
  • postExpectBuffer(session: AbstractSession, resource: string, reqHeaders?: any[], data?: any): Promise<Buffer>
  • +
+
    +
  • + +
    +
    +

    REST HTTP POST operation

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    • +
      Optional data: any
      +
      +

      payload data

      +
      +
    • +
    +

    Returns Promise<Buffer>

    +
      +
    • response body content from http(s) call
    • +
    +
  • +
+
+
+ +

Static postExpectFullResponse

+ + +
+
+ +

Static postExpectJSON

+
    +
  • postExpectJSON<T>(session: AbstractSession, resource: string, reqHeaders?: any[], payload?: any): Promise<T>
  • +
+
    +
  • + +
    +
    +

    Wrap post for common error handling and supporting generic JSON types

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      T: object

      +
      +

      object type to return

      +
      +
    • +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      the API URI that we are targeting

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers for the http(s) request

      +
      +
    • +
    • +
      Optional payload: any
      +
      +

      data to write on the http(s) request

      +
      +
    • +
    +

    Returns Promise<T>

    +
      +
    • object on promise
    • +
    +
  • +
+
+
+ +

Static postExpectString

+
    +
  • postExpectString(session: AbstractSession, resource: string, reqHeaders?: any[], data?: any): Promise<string>
  • +
+
    +
  • + +
    +
    +

    REST HTTP POST operation

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    • +
      Optional data: any
      +
      +

      payload data

      +
      +
    • +
    +

    Returns Promise<string>

    +
      +
    • response body content from http(s) call
    • +
    +
  • +
+
+
+ +

Static postStreamed

+
    +
  • postStreamed(session: AbstractSession, resource: string, reqHeaders?: any[], responseStream: Writable, requestStream: Readable, normalizeResponseNewLines?: boolean, normalizeRequestNewLines?: boolean, task?: ITaskWithStatus): Promise<string>
  • +
+
    +
  • + +
    +
    +

    REST HTTP POST operation streaming both the request and the response

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    • +
      responseStream: Writable
      +
      +

      stream to which the response data will be written

      +
      +
    • +
    • +
      requestStream: Readable
      +
      +

      stream from which payload data will be read

      +
      +
    • +
    • +
      Optional normalizeResponseNewLines: boolean
      +
      +

      streaming only - true if you want newlines to be \r\n on windows + when receiving data from the server to responseStream. Don't set this for binary responses

      +
      +
    • +
    • +
      Optional normalizeRequestNewLines: boolean
      +
      +

      streaming only - true if you want \r\n to be replaced with \n when sending + data to the server from requestStream. Don't set this for binary requests

      +
      +
    • +
    • +
      Optional task: ITaskWithStatus
      +
      +

      task used to update the user on the progress of their request

      +
      +
    • +
    +

    Returns Promise<string>

    +
      +
    • empty string - data is not buffered for this request
    • +
    +
  • +
+
+
+ +

Static postStreamedRequestOnly

+
    +
  • postStreamedRequestOnly(session: AbstractSession, resource: string, reqHeaders?: any[], requestStream: Readable, normalizeRequestNewLines?: boolean, task?: ITaskWithStatus): Promise<string>
  • +
+
    +
  • + +
    +
    +

    REST HTTP POST operation, streaming only the request and not the response

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    • +
      requestStream: Readable
      +
      +

      stream from which payload data will be read

      +
      +
    • +
    • +
      Optional normalizeRequestNewLines: boolean
      +
      +

      streaming only - true if you want \r\n to be replaced with \n when sending + data to the server from requestStream. Don't set this for binary requests

      +
      +
    • +
    • +
      Optional task: ITaskWithStatus
      +
      +

      task used to update the user on the progress of their request

      +
      +
    • +
    +

    Returns Promise<string>

    +
      +
    • string of the response
    • +
    +
  • +
+
+
+ +

Static putExpectBuffer

+
    +
  • putExpectBuffer(session: AbstractSession, resource: string, reqHeaders?: any[], data: any): Promise<Buffer>
  • +
+
    +
  • + +
    +
    +

    REST HTTP PUT operation

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    • +
      data: any
      +
      +

      payload data

      +
      +
    • +
    +

    Returns Promise<Buffer>

    +
      +
    • response body content from http(s) call
    • +
    +
  • +
+
+
+ +

Static putExpectFullResponse

+ + +
+
+ +

Static putExpectJSON

+
    +
  • putExpectJSON<T>(session: AbstractSession, resource: string, reqHeaders?: any[], payload: any): Promise<T>
  • +
+
    +
  • + +
    +
    +

    Wrap put for common error handling and supporting generic JSON types

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      T: object

      +
      +

      object type to return

      +
      +
    • +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      the API URI that we are targeting

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers for the http(s) request

      +
      +
    • +
    • +
      payload: any
      +
      +

      data to write on the http(s) request

      +
      +
    • +
    +

    Returns Promise<T>

    +
      +
    • object on promise
    • +
    +
  • +
+
+
+ +

Static putExpectString

+
    +
  • putExpectString(session: AbstractSession, resource: string, reqHeaders?: any[], data: any): Promise<string>
  • +
+
    +
  • + +
    +
    +

    REST HTTP PUT operation

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    • +
      data: any
      +
      +

      payload data

      +
      +
    • +
    +

    Returns Promise<string>

    +
      +
    • response body content from http(s) call
    • +
    +
  • +
+
+
+ +

Static putStreamed

+
    +
  • putStreamed(session: AbstractSession, resource: string, reqHeaders?: any[], responseStream: Writable, requestStream: Readable, normalizeResponseNewLines?: boolean, normalizeRequestNewLines?: boolean, task?: ITaskWithStatus): Promise<string>
  • +
+
    +
  • + +
    +
    +

    REST HTTP PUT operation with streamed response and request

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    • +
      responseStream: Writable
      +
      +

      stream to which the response data will be written

      +
      +
    • +
    • +
      requestStream: Readable
      +
      +

      stream from which payload data will be read

      +
      +
    • +
    • +
      Optional normalizeResponseNewLines: boolean
      +
      +

      streaming only - true if you want newlines to be \r\n on windows + when receiving data from the server to responseStream. Don't set this for binary responses

      +
      +
    • +
    • +
      Optional normalizeRequestNewLines: boolean
      +
      +

      streaming only - true if you want \r\n to be replaced with \n when sending + data to the server from requestStream. Don't set this for binary requests

      +
      +
    • +
    • +
      Optional task: ITaskWithStatus
      +
      +

      task used to update the user on the progress of their request

      +
      +
    • +
    +

    Returns Promise<string>

    +
      +
    • empty string - data is not buffered for streamed requests
    • +
    +
  • +
+
+
+ +

Static putStreamedRequestOnly

+
    +
  • putStreamedRequestOnly(session: AbstractSession, resource: string, reqHeaders?: any[], requestStream: Readable, normalizeRequestNewLines?: boolean, task?: ITaskWithStatus): Promise<string>
  • +
+
    +
  • + +
    +
    +

    REST HTTP PUT operation with only streamed request, buffers response data and returns it

    +
    +
    +
    static
    +
    +
    throws
    +

    if the request gets a status code outside of the 200 range + or other connection problems occur (e.g. connection refused)

    +
    +
    memberof
    +

    RestClient

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      resource: string
      +
      +

      URI for which this request should go against

      +
      +
    • +
    • +
      Default value reqHeaders: any[] = []
      +
      +

      headers to include in the REST request

      +
      +
    • +
    • +
      requestStream: Readable
      +
      +

      stream from which payload data will be read

      +
      +
    • +
    • +
      Optional normalizeRequestNewLines: boolean
      +
      +

      streaming only - true if you want \r\n to be replaced with \n when sending + data to the server from requestStream. Don't set this for binary requests

      +
      +
    • +
    • +
      Optional task: ITaskWithStatus
      +
      +

      task used to update the user on the progress of their request

      +
      +
    • +
    +

    Returns Promise<string>

    +
      +
    • string of the response
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Inherited constructor
  • +
  • Inherited method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.restclienterror.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.restclienterror.html new file mode 100644 index 0000000000..7cb8ba4107 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.restclienterror.html @@ -0,0 +1,555 @@ + + + + + + RestClientError | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class RestClientError

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

mDetails

+ + +
+
+

The IRestClientError details provided by the rest client. Contains + "relevant" diagnostic information such as host/port/request details, etc.

+
+
+
+
+ +

name

+
name: string
+ +
+
+
+

Accessors

+
+ +

additionalDetails

+
    +
  • get additionalDetails(): string
  • +
+ +
+
+ +

causeErrors

+
    +
  • get causeErrors(): any
  • +
+ +
+
+ +

details

+ + +
+
+ +

errorCode

+
    +
  • get errorCode(): string
  • +
+ +
+
+ +

message

+
    +
  • get message(): string
  • +
+ +
+
+ +

stack

+
    +
  • get stack(): string
  • +
+ +
+
+ +

suppressDump

+
    +
  • get suppressDump(): boolean
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Property
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.restconstants.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.restconstants.html new file mode 100644 index 0000000000..5f50aca275 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.restconstants.html @@ -0,0 +1,569 @@ + + + + + + RestConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class RestConstants

+
+
+
+
+
+
+
+
+
+

Constants used for REST client, etc.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + RestConstants +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly BASIC_PREFIX

+
BASIC_PREFIX: string = "Basic "
+ +
+
+

Basic auth

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+ +

Static Readonly BEARER_PREFIX

+
BEARER_PREFIX: string = "Bearer "
+ +
+
+

Bearer auth

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+ +

Static Readonly HTTP_STATUS_200

+
HTTP_STATUS_200: 200 = 200
+ +
+
+

200

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+ +

Static Readonly HTTP_STATUS_201

+
HTTP_STATUS_201: 201 = 201
+ +
+
+

201

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+ +

Static Readonly HTTP_STATUS_202

+
HTTP_STATUS_202: 202 = 202
+ +
+
+

202

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+ +

Static Readonly HTTP_STATUS_204

+
HTTP_STATUS_204: 204 = 204
+ +
+
+

204

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+ +

Static Readonly HTTP_STATUS_300

+
HTTP_STATUS_300: 300 = 300
+ +
+
+

300

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+ +

Static Readonly HTTP_STATUS_400

+
HTTP_STATUS_400: 400 = 400
+ +
+
+

400

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+ +

Static Readonly HTTP_STATUS_401

+
HTTP_STATUS_401: 401 = 401
+ +
+
+

401

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+ +

Static Readonly HTTP_STATUS_404

+
HTTP_STATUS_404: 404 = 404
+ +
+
+

404

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+ +

Static Readonly HTTP_STATUS_500

+
HTTP_STATUS_500: 500 = 500
+ +
+
+

500

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+ +

Static Readonly PROP_COOKIE

+
PROP_COOKIE: string = "set-cookie"
+ +
+
+

Set cookie property

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+ +

Static Readonly QUERY_ID

+
QUERY_ID: "?" = "?"
+ +
+
+

Query identifier

+
+
+
static
+
+
memberof
+

RestConstants

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.reststandaloneutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.reststandaloneutils.html new file mode 100644 index 0000000000..7dcde99b85 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.reststandaloneutils.html @@ -0,0 +1,318 @@ + + + + + + RestStandAloneUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class RestStandAloneUtils

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + RestStandAloneUtils +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Static Private Readonly BASIC

+
BASIC: RegExp = /^Basic/ig
+ +
+
+
+

Methods

+
+ +

Static getPasswordFromAuth

+
    +
  • getPasswordFromAuth(auth: string): string
  • +
+ +
+
+ +

Static getUsernameFromAuth

+
    +
  • getUsernameFromAuth(auth: string): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.schemahandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.schemahandler.html new file mode 100644 index 0000000000..6c7f7eb3a9 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.schemahandler.html @@ -0,0 +1,272 @@ + + + + + + SchemaHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SchemaHandler

+
+
+
+
+
+
+
+
+
+

The get command group handler for cli configuration settings.

+
+
+
+
+

Hierarchy

+
    +
  • + SchemaHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.securehandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.securehandler.html new file mode 100644 index 0000000000..ff0ef2f14f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.securehandler.html @@ -0,0 +1,340 @@ + + + + + + SecureHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SecureHandler

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + SecureHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Private params

+ + +
+
+

The parameters object passed to the command handler.

+
+
+
+
+
+

Methods

+
+ +

Private handlePromptForAuthToken

+
    +
  • handlePromptForAuthToken(config: Config, propPath: string): Promise<string | undefined>
  • +
+
    +
  • + +
    +
    +

    Checks if authentication service is associated with an auth token + property. If an auth service is found, we log in to it obtain the token + instead of prompting for the value.

    +
    +
    +

    Parameters

    +
      +
    • +
      config: Config
      +
      +

      Team config class from which the property was loaded

      +
      +
    • +
    • +
      propPath: string
      +
      +

      JSON property path of the auth token

      +
      +
    • +
    +

    Returns Promise<string | undefined>

    +

    Token value, or undefined if none was obtained

    +
  • +
+
+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.session.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.session.html new file mode 100644 index 0000000000..062d65226a --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.session.html @@ -0,0 +1,898 @@ + + + + + + Session | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Session

+
+
+
+
+
+
+
+
+
+

Non-abstract session class

+
+
+
export
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Static Readonly BASIC

+
BASIC: RegExp = /^Basic/ig
+ +
+
+

Regex to extract basic from base64 encoded auth

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly BASIC_PREFIX

+
BASIC_PREFIX: string = "Basic "
+ +
+
+

Basic auth prefix

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly BEARER_PREFIX

+
BEARER_PREFIX: string = "Bearer "
+ +
+
+

Bearer auth prefix

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_BASE_PATH

+
DEFAULT_BASE_PATH: "" = ""
+ +
+
+

Default base path. + Our empty string means that we do not use an API mediation layer + base path at the beginning of every resource URL.

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_HTTPS_PORT

+
DEFAULT_HTTPS_PORT: 443 = 443
+ +
+
+

Default https port 443

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_HTTP_PORT

+
DEFAULT_HTTP_PORT: 80 = 80
+ +
+
+

Default http port 80

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_PORT

+
DEFAULT_PORT: 443 = AbstractSession.DEFAULT_HTTPS_PORT
+ +
+
+

Default https port

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_PROTOCOL

+
DEFAULT_PROTOCOL: "https" = SessConstants.HTTPS_PROTOCOL
+ +
+
+

Default protocol

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_REJECT_UNAUTHORIZED_SETTING

+
DEFAULT_REJECT_UNAUTHORIZED_SETTING: true = true
+ +
+
+

Default reject unauthorized

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_SECURE_PROTOCOL

+
DEFAULT_SECURE_PROTOCOL: "SSLv23_method" = "SSLv23_method"
+ +
+
+

Default SSL method

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_STRICT_SSL

+
DEFAULT_STRICT_SSL: true = true
+ +
+
+

Default strict ssl setting

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static Readonly DEFAULT_TYPE

+
DEFAULT_TYPE: "none" = SessConstants.AUTH_TYPE_NONE
+ +
+
+

Default session type

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+
+

Accessors

+
+ +

ISession

+ + +
+
+
+

Methods

+
+ +

storeCookie

+
    +
  • storeCookie(cookie: any): void
  • +
+ +
+
+ +

Static createFromUrl

+
    +
  • createFromUrl(url: URL, includePath?: boolean): Session
  • +
+
    +
  • + +
    +
    +

    Creates an instance of Session from a URL object.

    +
    +
    +
    memberof
    +

    Session

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      url: URL
      +
      +

      URL object from the Node.js url library

      +
      +
    • +
    • +
      Optional includePath: boolean
      +
      +

      Specifies whether session base path should be populated. Default value is true.

      +
      +
    • +
    +

    Returns Session

    +
  • +
+
+
+ +

Static getBase64Auth

+
    +
  • getBase64Auth(user: string, password: string): string
  • +
+ +
+
+ +

Static getPasswordFromAuth

+
    +
  • getPasswordFromAuth(auth: string): string
  • +
+ +
+
+ +

Static getUsernameFromAuth

+
    +
  • getUsernameFromAuth(auth: string): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited method
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.setdefaultprofileshandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.setdefaultprofileshandler.html new file mode 100644 index 0000000000..d80b5e338c --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.setdefaultprofileshandler.html @@ -0,0 +1,266 @@ + + + + + + SetDefaultProfilesHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SetDefaultProfilesHandler

+
+
+
+
+
+
+
+
+
+

Handler for the auto generated commands to set the default profile for a type + The default profile is loaded when no specific profile name is specified

+
+
+
+
+

Hierarchy

+
    +
  • + SetDefaultProfilesHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.sethandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.sethandler.html new file mode 100644 index 0000000000..364dfc6bc1 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.sethandler.html @@ -0,0 +1,265 @@ + + + + + + SetHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SetHandler

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + SetHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.settingsalreadyinitialized.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.settingsalreadyinitialized.html new file mode 100644 index 0000000000..8410a4dcd9 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.settingsalreadyinitialized.html @@ -0,0 +1,542 @@ + + + + + + SettingsAlreadyInitialized | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SettingsAlreadyInitialized

+
+
+
+
+
+
+
+
+
+

This class represents an error that is thrown when a second settings singleton attempts to initialize.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

mDetails

+ + +
+
+ +

name

+
name: string
+ +
+
+
+

Accessors

+
+ +

additionalDetails

+
    +
  • get additionalDetails(): string
  • +
+ +
+
+ +

causeErrors

+
    +
  • get causeErrors(): any
  • +
+ +
+
+ +

details

+ + +
+
+ +

errorCode

+
    +
  • get errorCode(): string
  • +
+ +
+
+ +

message

+
    +
  • get message(): string
  • +
+ +
+
+ +

stack

+
    +
  • get stack(): string
  • +
+ +
+
+ +

suppressDump

+
    +
  • get suppressDump(): boolean
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.settingsnotinitialized.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.settingsnotinitialized.html new file mode 100644 index 0000000000..0e1db95062 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.settingsnotinitialized.html @@ -0,0 +1,542 @@ + + + + + + SettingsNotInitialized | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SettingsNotInitialized

+
+
+
+
+
+
+
+
+
+

This class represents an error thrown when a null singleton AppSettings object is referenced.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

mDetails

+ + +
+
+ +

name

+
name: string
+ +
+
+
+

Accessors

+
+ +

additionalDetails

+
    +
  • get additionalDetails(): string
  • +
+ +
+
+ +

causeErrors

+
    +
  • get causeErrors(): any
  • +
+ +
+
+ +

details

+ + +
+
+ +

errorCode

+
    +
  • get errorCode(): string
  • +
+ +
+
+ +

message

+
    +
  • get message(): string
  • +
+ +
+
+ +

stack

+
    +
  • get stack(): string
  • +
+ +
+
+ +

suppressDump

+
    +
  • get suppressDump(): boolean
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Inherited property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.sharedoptions.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.sharedoptions.html new file mode 100644 index 0000000000..730aa3b52e --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.sharedoptions.html @@ -0,0 +1,367 @@ + + + + + + SharedOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SharedOptions

+
+
+
+
+
+
+
+
+
+

Options which can be reused between different Brightside commands

+
+
+
+
+

Hierarchy

+
    +
  • + SharedOptions +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static Private readStdin

+ +
    +
  • + +
    +
    +

    Read from standard in until EOF (if the option was specified)

    +
    +
    +

    Parameters

    +
      +
    • +
      args: Arguments
      +
      +

      arguments for the command

      +
      +
    • +
    • +
      response: CommandResponse
      +
      +

      the response object to write to / log to if necessary

      +
      +
    • +
    • +
      commandType: ICommandNodeType
      +
      +

      what type of command might have the --stdin option? If it's not "command" + this method will return immediately

      +
      +
    • +
    • +
      Default value stream: ReadStream & { fd: 0 } = process.stdin
      +
    • +
    • +
      done: (readErr: IImperativeError, attemptedStdinRead: boolean) => void
      +
      +

      callback for when stdin reading is done. attemptedStdinRead: whether we tried to read standard in + based on the arguments and command definition

      +
      +
        +
      • + +
          +
        • +

          Parameters

          + +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static readStdinIfRequested

+ +
    +
  • + +
    +
    +

    Promise based API for reading the standard in if the arguments dictate to do so. The response is placed in the + arguments to be passed on the the command handlers.

    +
    +
    +
    memberof
    +

    SharedOptions

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      args: Arguments
      +
      +

      The yargs style command line arguments supplied by the user

      +
      +
    • +
    • +
      response: CommandResponse
      +
      +

      The command response object (for messages, etc.)

      +
      +
    • +
    • +
      commandType: ICommandNodeType
      +
      +

      The type of the command

      +
      +
    • +
    • +
      Default value stream: ReadStream & { fd: 0 } = process.stdin
      +
    • +
    +

    Returns Promise<boolean>

    +
      +
    • The promise to be fulfilled (or rejected with an imperative error) - false if
                              stdin was read and false if it wasn't
      +
      +
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.showdependenciesprofileshandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.showdependenciesprofileshandler.html new file mode 100644 index 0000000000..f6d99e8322 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.showdependenciesprofileshandler.html @@ -0,0 +1,265 @@ + + + + + + ShowDependenciesProfilesHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ShowDependenciesProfilesHandler

+
+
+
+
+
+
+
+
+
+

Handler for the auto-generated show dependencies command

+
+
+
+
+

Hierarchy

+
    +
  • + ShowDependenciesProfilesHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.syntaxvalidator.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.syntaxvalidator.html new file mode 100644 index 0000000000..687ddc5a81 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.syntaxvalidator.html @@ -0,0 +1,1547 @@ + + + + + + SyntaxValidator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SyntaxValidator

+
+
+
+
+
+
+
+
+
+

The Imperative default syntax validator. Accepts the input arguments, command + definitions, and a response object. Validates the syntax and issues the + appropriate error messages if necessary.

+
+

TODO - Consider limiting to a single purpose of producing error documents + TODO - that will be outputted by the command processor in a "more structured" + TODO - fasion.

+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + SyntaxValidator +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mCommandDefinition

+
mCommandDefinition: ICommandDefinition
+ +
+
+

The command definition supplied to validate the arguments against.

+
+
+
+
+ +

Private mDefinitionTree

+
mDefinitionTree: ICommandDefinition
+ +
+
+

The full command definition - which includes the parents of the command.

+
+
+
+
+ +

Private mErrorList

+
mErrorList: ICommandValidatorError[] = []
+ +
+
+

The error list that is appended to the error response object.

+
+
+
memberof
+

SyntaxValidator

+
+
+
+
+
+ +

Private mLogger

+
mLogger: Logger = Logger.getImperativeLogger()
+ +
+
+

Get an instance of the logger.

+
+
+
memberof
+

SyntaxValidator

+
+
+
+
+
+ +

Private mOptionDefinitionsMap

+
mOptionDefinitionsMap: any
+ +
+
+

The full list of command options from the command definition

+
+
+
+
+ +

Static LONG

+
LONG: string = "--"
+ +
+
+ +

Static SHORT

+
SHORT: string = "-"
+ +
+
+

Command option short/long

+
+
+
+
+
+

Methods

+
+ +

Private absenceImplicationError

+ + +
+
+ +

Private appendValidatorError

+ + +
+
+ +

Private checkIfAllowable

+ + +
+
+ +

Private emptyValueError

+
    +
  • emptyValueError(responseObject: CommandResponse, optionName: string): void
  • +
+ +
+
+ +

Private fileOptionError

+ + +
+
+ +

Private getDashFormOfOption

+
    +
  • getDashFormOfOption(optionName: string): string
  • +
+
    +
  • + +
    +
    +

    Get the 'dash form' of an option as it would appear in a user's command, + appending the proper number of dashes depending on the length of the option name

    +
    +
    +

    Parameters

    +
      +
    • +
      optionName: string
      +
      +

      e.g. my-option

      +
      +
    • +
    +

    Returns string

    +
      +
    • e.g. --my-option
    • +
    +
  • +
+
+
+ +

Private getMustacheSummaryForOption

+ + +
+
+ +

Private getOptionDefinitionFromName

+ + +
+
+ +

Private implicationAlternativeError

+ + +
+
+ +

Private invalidJsonString

+ +
    +
  • + +
    +
    +

    Issue an error message indicating that the JSON string provided is not valid.

    +
    +
    +

    Parameters

    +
      +
    • +
      error: Error
      +
      +

      the JSON parse try/catch error.

      +
      +
    • +
    • +
      optionDefinition: ICommandOptionDefinition
      +
      +

      The Option definition + Validate the options. Includes automatic validation based on option + and command definition as well as custom validation provided by the user

      +
      +
    • +
    • +
      responseObject: CommandResponse
      +
    • +
    • +
      valueSpecified: any
      +
    • +
    +

    Returns void

    +

    : True if the options are valid, false if there is a syntax error

    +
  • +
+
+
+ +

Private invalidOptionError

+ + +
+
+ +

Private missingOptionError

+ + +
+
+ +

Private missingPositionalParameter

+ + +
+
+ +

Private mustSpecifyOneError

+ + +
+
+ +

Private notAnArrayError

+ + +
+
+ +

Private onlyOneOfError

+
    +
  • onlyOneOfError(responseObject: CommandResponse, specified: string[]): void
  • +
+ +
+
+ +

Private optionCombinationInvalidError

+ + +
+
+ +

Private optionDependencyError

+ + +
+
+ +

Private positionalParameterInvalid

+ + +
+
+ +

Private specifiedMultipleTimesError

+ + +
+
+ +

Private unknownPositionalError

+ + +
+
+ +

validate

+ + +
+
+ +

Private validateArrayDuplicate

+ + +
+
+ +

Private validateBoolean

+ + +
+
+ +

Private validateNumeric

+ + +
+
+ +

Private validateOptionValueLength

+ + +
+
+ +

Private validateOptionValueRange

+ + +
+
+ +

Private validateSyntax

+ + +
+
+ +

Private valueRequiresAdditionalOption

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.taskprogress.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.taskprogress.html new file mode 100644 index 0000000000..0f9c6773e7 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.taskprogress.html @@ -0,0 +1,381 @@ + + + + + + TaskProgress | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class TaskProgress

+
+
+
+
+
+
+
+
+
+

Constants and utilities used in tracking status of a running task

+
+
+
+
+

Hierarchy

+
    +
  • + TaskProgress +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly EIGHTY_PERCENT

+
EIGHTY_PERCENT: 80 = 80
+ +
+
+ +

Static Readonly FIFTY_PERCENT

+
FIFTY_PERCENT: 50 = 50
+ +
+
+ +

Static Readonly FOURTY_PERCENT

+
FOURTY_PERCENT: 40 = 40
+ +
+
+ +

Static Readonly NINETY_PERCENT

+
NINETY_PERCENT: 90 = 90
+ +
+
+ +

Static Readonly ONE_HUNDRED_PERCENT

+
ONE_HUNDRED_PERCENT: 100 = 100
+ +
+
+ +

Static Readonly SEVENTY_PERCENT

+
SEVENTY_PERCENT: 70 = 70
+ +
+
+ +

Static Readonly SIXTY_PERCENT

+
SIXTY_PERCENT: 60 = 60
+ +
+
+ +

Static Readonly TEN_PERCENT

+
TEN_PERCENT: 10 = 10
+ +
+
+ +

Static Readonly THIRTY_PERCENT

+
THIRTY_PERCENT: 30 = 30
+ +
+
+ +

Static Readonly TWENTY_PERCENT

+
TWENTY_PERCENT: 20 = 20
+ +
+
+ +

Static Readonly ZERO_PERCENT

+
ZERO_PERCENT: 0 = 0
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.textutils.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.textutils.html new file mode 100644 index 0000000000..d42e07e0ff --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.textutils.html @@ -0,0 +1,845 @@ + + + + + + TextUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class TextUtils

+
+
+
+
+
+
+
+
+
+

Lightweight utilities for text manipulation/coloring. + Low import impact

+
+
+
+
+

Hierarchy

+
    +
  • + TextUtils +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly AVAILABLE_CHALK_COLORS

+
AVAILABLE_CHALK_COLORS: string[] = ["red", "magenta", "blue", "green", "grey", "yellow", "cyan"]
+ +
+
+ +

Static Readonly DEFAULT_WRAP_WIDTH

+
DEFAULT_WRAP_WIDTH: 80 = 80
+ +
+
+
+

Accessors

+
+ +

Static chalk

+
    +
  • get chalk(): any
  • +
+ +
+
+
+

Methods

+
+ +

Static buildHeaders

+
    +
  • buildHeaders(objects: any[]): string[]
  • +
+
    +
  • + +
    +
    +

    Build table headers from an array of key-value objects

    +
    +
    +

    Parameters

    +
      +
    • +
      objects: any[]
      +
      +

      the key-value objects from which to build headers

      +
      +
    • +
    +

    Returns string[]

    +

    the headers array

    +
  • +
+
+
+ +

Static explainObject

+
    +
  • explainObject(original: any, explanationMap: IExplanationMap, includeUnexplainedKeys?: boolean): any
  • +
+
    +
  • + +
    +
    +

    Replace keys from an object with string explanations for those keys, + primarily so that they can be printed for the user to read.

    +
    +
    +

    Parameters

    +
      +
    • +
      original: any
      +
      +

      the original object e.g. a response from a z/OSMF API {wrdKy4U: "weirdkeyvalue"}

      +
      +
    • +
    • +
      explanationMap: IExplanationMap
      +
      +

      an object that maps the original to the new format

      +
      +
    • +
    • +
      Default value includeUnexplainedKeys: boolean = true
      +
      +

      should keys not covered by + the explanation object be included in the result?

      +
      +
    • +
    +

    Returns any

    +
      +
    • the explained object
    • +
    +
  • +
+
+
+ +

Static formatMessage

+
    +
  • formatMessage(message: string, ...values: any[]): string
  • +
+
    +
  • + +
    +
    +

    Auto-detect whether a message should be formatted with printf-style formatting or mustache + (but don't try to use both!) and format the string accordingly

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      the string message with %s or {{mustache}} style variables

      +
      +
    • +
    • +
      Rest ...values: any[]
      +
      +

      the fields that will resolve the printf or mustache template

      +
      +
    • +
    +

    Returns string

    +
      +
    • a formatted string with the variables inserted
    • +
    +
  • +
+
+
+ +

Static getRecommendedWidth

+
    +
  • getRecommendedWidth(preferredWidth?: number): number
  • +
+
    +
  • + +
    +
    +

    Get the recommended width to wrap text. You can specify a preferred width, + but this method width return

    +
    +
    +

    Parameters

    +
      +
    • +
      Default value preferredWidth: number = TextUtils.DEFAULT_WRAP_WIDTH
      +
      +

      the width you would like to use if supported + by the user's terminal

      +
      +
    • +
    +

    Returns number

    +
      +
    • the width that will work best for the user's terminal
    • +
    +
  • +
+
+
+ +

Static getTable

+
    +
  • getTable(objects: any[], primaryHighlightColor: string, maxColumnWidth?: number, includeHeader?: boolean, includeBorders?: boolean, hardWrap?: boolean, headers?: string[]): string
  • +
+
    +
  • + +
    +
    +

    Parameters

    +
      +
    • +
      objects: any[]
      +
      +

      the key-value objects to convert to a

      +
      +
    • +
    • +
      primaryHighlightColor: string
      +
      +

      the main color to highlight headings of the table with. e.g. "blue"

      +
      +
    • +
    • +
      Optional maxColumnWidth: number
      +
      +

      override the default column width of the table?

      +
      +
    • +
    • +
      Default value includeHeader: boolean = true
      +
      +

      should the table include a header of the field names of the objects

      +
      +
    • +
    • +
      Default value includeBorders: boolean = false
      +
      +

      should the table have borders between the cells?

      +
      +
    • +
    • +
      Default value hardWrap: boolean = false
      +
      +

      hard wrap the text within the width of the table cells (defaults to false)

      +
      +
    • +
    • +
      Optional headers: string[]
      +
      +

      specify which headers in which order to display. if omitted, loops through the rows + and adds object properties as headers in their enumeration order

      +
      +
    • +
    +

    Returns string

    +

    the rendered table

    +
  • +
+
+
+ +

Static highlightMatches

+
    +
  • highlightMatches(text: string, term: RegExp): string
  • +
+
    +
  • + +
    +
    +

    Highlight all matches of a full regex with TextUtils.chalk

    +
    +
    +

    Parameters

    +
      +
    • +
      text: string
      +
      +

      the text you'd like to search for matches

      +
      +
    • +
    • +
      term: RegExp
      +
      +

      a regular expression of terms to highlight

      +
      +
    • +
    +

    Returns string

    +
      +
    • the highlighted string
    • +
    +
  • +
+
+
+ +

Static indentLines

+
    +
  • indentLines(text: string, indent?: string): string
  • +
+
    +
  • + +
    +
    +

    Indent some text

    +
    +
    +

    Parameters

    +
      +
    • +
      text: string
      +
      +

      The text you would like to indent

      +
      +
    • +
    • +
      Default value indent: string = ""
      +
      +

      Add this string to every line of the result

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

Static parseKeyValueString

+
    +
  • parseKeyValueString(keysAndValues: string): {}
  • +
+
    +
  • + +
    +
    +

    Parse a key value string into an object

    +
    +
    +

    Parameters

    +
      +
    • +
      keysAndValues: string
      +
      +

      a string in the format key1=value1,key2=value2,key3=value3. + Note: the key names are case sensitive

      +
      +
    • +
    +

    Returns {}

    +

    the parsed object

    +
      +
    • +
      [key: string]: string
      +
    • +
    +
  • +
+
+
+ +

Static prettyJson

+
    +
  • prettyJson(object: any, options?: any, color?: boolean, append?: string): string
  • +
+
    +
  • + +
    +
    +

    Get a json object in tabular form

    +
    +
    +

    Parameters

    +
      +
    • +
      object: any
      +
    • +
    • +
      Optional options: any
      +
    • +
    • +
      Default value color: boolean = true
      +
      +

      use color on the result?

      +
      +
    • +
    • +
      Default value append: string = ""
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

Static renderTemplateFromKeyValueArguments

+
    +
  • renderTemplateFromKeyValueArguments(template: string, keysAndValues: string): string
  • +
+
    +
  • + +
    +
    +

    Render a mustache template based on arguments from the user

    +
    +
    +
    throws
    +

    an Error if the keysAndValues are not in the expected format

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      template: string
      +
      +

      the mustache-style template string into which you would like to insert your values

      +
      +
    • +
    • +
      keysAndValues: string
      +
      +

      a string in the format key1=value1,key2=value2,key3=value3. + Note: the key names are case sensitive

      +
      +
    • +
    +

    Returns string

    +
      +
    • the rendered template
    • +
    +
  • +
+
+
+ +

Static renderWithMustache

+
    +
  • renderWithMustache(template: string, values: any): string
  • +
+ +
+
+ +

Static wordWrap

+
    +
  • wordWrap(text: string, width?: number, indent?: string, hardWrap?: boolean, trim?: boolean): string
  • +
+
    +
  • + +
    +
    +

    Wrap some text so that it fits within a certain width with the wrap-ansi package

    +
    +
    +

    Parameters

    +
      +
    • +
      text: string
      +
      +

      The text you would like to wrap

      +
      +
    • +
    • +
      Optional width: number
      +
      +

      The width you would like to wrap to - we'll try to determine the + optimal width based on this (the resulting wrap may be wrapped to fewer columns, but not more)

      +
      +
    • +
    • +
      Default value indent: string = ""
      +
      +

      Add this string to every line of the result

      +
      +
    • +
    • +
      Default value hardWrap: boolean = false
      +
      +

      do not allow any letters past the requested width - defaults to false

      +
      +
    • +
    • +
      Default value trim: boolean = true
      +
    • +
    +

    Returns string

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.uninstallhandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.uninstallhandler.html new file mode 100644 index 0000000000..40566329c4 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.uninstallhandler.html @@ -0,0 +1,350 @@ + + + + + + UninstallHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class UninstallHandler

+
+
+
+
+
+
+
+
+
+

The uninstall command handler for cli plugin install.

+
+
+
see
+

{uninstallDefinition}

+
+
+
+
+
+

Hierarchy

+
    +
  • + UninstallHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Private console

+
console: Logger = Logger.getImperativeLogger()
+ +
+
+

A logger for this class

+
+
+
+
+
+

Methods

+
+ +

Private callPluginPreUninstall

+
    +
  • callPluginPreUninstall(pluginPackageNm: string): Promise<void>
  • +
+ +
+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.updatehandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.updatehandler.html new file mode 100644 index 0000000000..31c1c73638 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.updatehandler.html @@ -0,0 +1,308 @@ + + + + + + UpdateHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class UpdateHandler

+
+
+
+
+
+
+
+
+
+

The update command handler for cli plugin install.

+
+
+
see
+

{updateDefinition}

+
+
+
+
+
+

Hierarchy

+
    +
  • + UpdateHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Private console

+
console: Logger = Logger.getImperativeLogger()
+ +
+
+

A logger for this class

+
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.updateimpconfig.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.updateimpconfig.html new file mode 100644 index 0000000000..0706d48f4a --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.updateimpconfig.html @@ -0,0 +1,300 @@ + + + + + + UpdateImpConfig | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class UpdateImpConfig

+
+
+
+
+
+
+
+
+
+

This class is used to update the imperative config object, that was initially + loaded by the Imperative module. It exists in a separate module to avoid + cyclic dependencies that would occur if the functions lived in the + Imperative module.

+
+
+
+
+

Hierarchy

+
    +
  • + UpdateImpConfig +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static addCmdGrp

+ + +
+
+ +

Static addProfiles

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.updateprofileshandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.updateprofileshandler.html new file mode 100644 index 0000000000..9b7a731020 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.updateprofileshandler.html @@ -0,0 +1,266 @@ + + + + + + UpdateProfilesHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class UpdateProfilesHandler

+
+
+
+
+
+
+
+
+
+

Handler for the auto-generated update profile commands + Allows the user to simply update an existing configuration profile

+
+
+
+
+

Hierarchy

+
    +
  • + UpdateProfilesHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.updateschemashandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.updateschemashandler.html new file mode 100644 index 0000000000..08eb680de2 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.updateschemashandler.html @@ -0,0 +1,265 @@ + + + + + + UpdateSchemasHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class UpdateSchemasHandler

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + UpdateSchemasHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.validatehandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.validatehandler.html new file mode 100644 index 0000000000..f29d3ca4b4 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.validatehandler.html @@ -0,0 +1,353 @@ + + + + + + ValidateHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ValidateHandler

+
+
+
+
+
+
+
+
+
+

The validate command handler for the cli plugin validate command.

+
+
+
see
+

{validateDefinition}

+
+
+
+
+
+

Hierarchy

+
    +
  • + ValidateHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Private pluginIssues

+
pluginIssues: PluginIssues = PluginIssues.instance
+ +
+
+

A class with recorded issues for each plugin for which problems were detected.

+
+
+
+
+
+

Methods

+
+ +

Private displayPluginIssues

+
    +
  • displayPluginIssues(pluginName: string, cmdResponse: IHandlerResponseApi, failOnWarning?: boolean): boolean
  • +
+ +
+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.validateprofilehandler.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.validateprofilehandler.html new file mode 100644 index 0000000000..31d12fff67 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.validateprofilehandler.html @@ -0,0 +1,294 @@ + + + + + + ValidateProfileHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ValidateProfileHandler

+
+
+
+
+
+
+
+
+
+

Generic handler for validating a profile and printing a report in response

+
+
+
+
+

Hierarchy

+
    +
  • + ValidateProfileHandler +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Private mLogger

+
mLogger: Logger = Imperative.api.imperativeLogger
+ +
+
+

Get an instance of the imperative logger.

+
+
+
memberof
+

ValidateProfileHandler

+
+
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.webdiffmanager.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.webdiffmanager.html new file mode 100644 index 0000000000..3c07af2956 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.webdiffmanager.html @@ -0,0 +1,423 @@ + + + + + + WebDiffManager | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class WebDiffManager

+
+
+
+
+
+
+
+
+
+

Imperative Web Differences Manager handles the opening of diffs and + constructs the dirs and files if necessary

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + WebDiffManager +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Static Private mInstance

+
mInstance: WebDiffManager = null
+ +
+
+

Singleton instance of this class

+
+
+
static
+
+
memberof
+

WebDiffManager

+
+
+
+
+
+
+

Accessors

+
+ +

Private webDiffDir

+
    +
  • get webDiffDir(): string
  • +
+ +
+
+ +

Static instance

+ + +
+
+
+

Methods

+
+ +

Private genHtmlForDiffs

+
    +
  • genHtmlForDiffs(htmlDiff: string, unifiedStringDiff: string): string
  • +
+
    +
  • + +
    +
    +

    Returns header HTML for web diff page

    +
    +
    +

    Parameters

    +
      +
    • +
      htmlDiff: string
      +
      +

      html diffs of the file changes

      +
      +
    • +
    • +
      unifiedStringDiff: string
      +
      +

      unified string of difference between two files

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

openDiffs

+
    +
  • openDiffs(patchDiff: string): Promise<void>
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.webhelpgenerator.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.webhelpgenerator.html new file mode 100644 index 0000000000..65e88ddfad --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.webhelpgenerator.html @@ -0,0 +1,870 @@ + + + + + + WebHelpGenerator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class WebHelpGenerator

+
+
+
+
+
+
+
+
+
+

Imperative web help generator. Accepts the command definitions and constructs + the full help text for the command node.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + WebHelpGenerator +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private aliasList

+
aliasList: {}
+ +
+
+

Key value list of commands and their aliases

+
+
+
memberof
+

WebHelpGenerator

+
+
+
+
+

Type declaration

+
    +
  • +
    [key: string]: string[]
    +
  • +
+
+
+
+ +

Private mConfig

+ + +
+
+

Imperative config containing data about the CLI

+
+
+
memberof
+

WebHelpGenerator

+
+
+
+
+
+ +

Private mDocsDir

+
mDocsDir: string
+ +
+
+

Output directory for HTML doc pages

+
+
+
memberof
+

WebHelpGenerator

+
+
+
+
+
+ +

Private mFullCommandTree

+
mFullCommandTree: ICommandDefinition
+ +
+
+

Imperative command tree to build help for

+
+
+
memberof
+

WebHelpGenerator

+
+
+
+
+
+ +

Private markdownIt

+
markdownIt: any
+ +
+
+

Markdown-it module used to convert markdown to HTML

+
+
+
memberof
+

WebHelpGenerator

+
+
+
+
+
+ +

sanitizeHomeDir

+
sanitizeHomeDir: boolean = false
+ +
+
+

Specifies whether user's home directory should be redacted from help content

+
+
+
memberof
+

WebHelpGenerator

+
+
+
+
+
+ +

Private singlePageHtml

+
singlePageHtml: string
+ +
+
+

Used to build single page version of web help

+
+
+
memberof
+

WebHelpGenerator

+
+
+
+
+
+ +

Private treeNodes

+
treeNodes: IWebHelpTreeNode[]
+ +
+
+

List of nodes in command tree

+
+
+
memberof
+

WebHelpGenerator

+
+
+
+
+
+
+

Methods

+
+ +

Private appendToSinglePageHtml

+
    +
  • appendToSinglePageHtml(definition: ICommandDefinition, rootCommandName: string, fullCommandName: string, htmlContent: string): void
  • +
+ +
+
+ +

Private buildChildrenSummaryTables

+ + +
+
+ +

Private buildCmdTreeHtml

+ + +
+
+ +

buildHelp

+ + +
+
+ +

Private genBreadcrumb

+
    +
  • genBreadcrumb(rootCommandName: string, fullCommandName: string): string
  • +
+ +
+
+ +

Private genCommandHelpPage

+ + +
+
+ +

Private genDocsFooter

+
    +
  • genDocsFooter(): string
  • +
+ +
+
+ +

Private genDocsHeader

+
    +
  • genDocsHeader(title: string): string
  • +
+ +
+
+ +

Private genPrintButton

+
    +
  • genPrintButton(): string
  • +
+ +
+
+ +

Private renderMarkdown

+
    +
  • renderMarkdown(markdownContent: string): string
  • +
+
    +
  • + +
    +
    +

    Converts Markdown string to HTML string. Any HTML tags contained in the + input Markdown string will be escaped.

    +
    +
    +

    Parameters

    +
      +
    • +
      markdownContent: string
      +
      +

      String containing Markdown content

      +
      +
    • +
    +

    Returns string

    +

    String containing HTML content

    +
  • +
+
+
+ +

Private writeTreeData

+
    +
  • writeTreeData(): void
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.webhelpmanager.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.webhelpmanager.html new file mode 100644 index 0000000000..30e1f73449 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.webhelpmanager.html @@ -0,0 +1,657 @@ + + + + + + WebHelpManager | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class WebHelpManager

+
+
+
+
+
+
+
+
+
+

Imperative web help manager. Single instance class used to launch web help + in browser which handles (re)building web help files first if necessary.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + WebHelpManager +
  • +
+
+
+

Implements

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Private mFullCommandTree

+
mFullCommandTree: ICommandDefinition
+ +
+
+

Imperative command tree to build help for

+
+
+
memberof
+

WebHelpManager

+
+
+
+
+
+ +

Static Private mInstance

+
mInstance: WebHelpManager = null
+ +
+
+

Singleton instance of this class

+
+
+
static
+
+
memberof
+

WebHelpManager

+
+
+
+
+
+
+

Accessors

+
+ +

fullCommandTree

+ + +
+
+ +

Private webHelpDir

+
    +
  • get webHelpDir(): string
  • +
+ +
+
+ +

Static instance

+ + +
+
+
+

Methods

+
+ +

Private calcPackageMetadata

+ + +
+
+ +

Private checkIfMetadataChanged

+
    +
  • checkIfMetadataChanged(): MaybePackageMetadata
  • +
+ +
+
+ +

Private eqPackageMetadata

+ + +
+
+ +

openHelp

+ + +
+
+ +

openRootHelp

+ + +
+
+ +

Private writePackageMetadata

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
  • Accessor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.yargsconfigurer.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.yargsconfigurer.html new file mode 100644 index 0000000000..469bb51a5f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.yargsconfigurer.html @@ -0,0 +1,586 @@ + + + + + + YargsConfigurer | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class YargsConfigurer

+
+
+
+
+
+
+
+
+
+

Before invoking commands, this class configures some settings and callbacks in Yargs, + including what happens on syntax failures.

+
+
+
+
+

Hierarchy

+
    +
  • + YargsConfigurer +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private commandLine

+
commandLine: string
+ +
+
+ +

Private commandRespParms

+
commandRespParms: ICommandResponseParms
+ +
+
+ +

Private envVariablePrefix

+
envVariablePrefix: string
+ +
+
+ +

Private experimentalCommandDescription

+
experimentalCommandDescription: string
+ +
+
+ +

Private helpGeneratorFactory

+
helpGeneratorFactory: IHelpGeneratorFactory
+ +
+
+ +

Private profileManagerFactory

+ + +
+
+ +

Private promptPhrase

+
promptPhrase: string
+ +
+
+ +

Private rootCommand

+
rootCommand: ICommandDefinition
+ +
+
+ +

Private rootCommandName

+
rootCommandName: string
+ +
+
+ +

Private yargs

+
yargs: any
+ +
+
+
+

Methods

+
+ +

Private buildFailedCommandDefinition

+ + +
+
+ +

Private buildFailureMessage

+
    +
  • buildFailureMessage(closestCommand?: string): string
  • +
+ +
+
+ +

configure

+
    +
  • configure(): void
  • +
+ +
+
+ +

Private getClosestCommand

+
    +
  • getClosestCommand(attemptedCommand: string): any
  • +
+ +
+
+ +

Private getResponseFormat

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_imperative.yargsdefiner.html b/static/v2.15.x/typedoc/classes/_zowe_imperative.yargsdefiner.html new file mode 100644 index 0000000000..fce6909c61 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_imperative.yargsdefiner.html @@ -0,0 +1,523 @@ + + + + + + YargsDefiner | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class YargsDefiner

+
+
+
+
+
+
+
+
+
+

Imperative Command Definer - Defines the Imperative command objects to Yargs for processing.

+
+
+
+
+

Hierarchy

+
    +
  • + YargsDefiner +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ +
    +
  • + +
    +
    +

    Build the definer - maintains the Yargs instance for all future definitions.

    +
    +
    +

    Parameters

    +
      +
    • +
      yargsInstance: Argv
      +
    • +
    • +
      primaryHighlightColor: string
      +
      +
      +

      main color to highlight help text headings and other text with

      +
      +
      +
    • +
    • +
      rootCommandName: string
      +
      +
      +

      the display name of the root command (e.g. "bright" or "sample-cli")

      +
      +
      +
    • +
    • +
      commandLine: string
      +
    • +
    • +
      envVariablePrefix: string
      +
      +
      +

      the environment variable prefix

      +
      +
      +
    • +
    • +
      profileManagerFactory: IProfileManagerFactory<ICommandProfileTypeConfiguration>
      +
      +
      +

      profile manager factory that can be used to instantiate new profile managers

      +
      +
      +
    • +
    • +
      helpGeneratorFactory: IHelpGeneratorFactory
      +
      +
      +

      help generator factory that can be used to instantiate new help generators

      +
      +
      +
    • +
    • +
      experimentalCommandDescription: string
      +
      +
      +

      optionally overridden experimental command description to + propagate to yargs services

      +
      +
      +
    • +
    • +
      promptPhrase: string
      +
    • +
    +

    Returns YargsDefiner

    +
  • +
+
+
+
+

Properties

+
+ +

Private log

+
log: Logger = Logger.getImperativeLogger()
+ +
+
+

Logger instance

+
+
+
+
+ +

Private mCommandLine

+
mCommandLine: string
+ +
+
+ +

Private mEnvVariablePrefix

+
mEnvVariablePrefix: string
+ +
+
+ +

Private mExperimentalCommandDescription

+
mExperimentalCommandDescription: string
+ +
+
+ +

Private mHelpFactory

+
mHelpFactory: IHelpGeneratorFactory
+ +
+
+ +

Private mPrimaryHighlightColor

+
mPrimaryHighlightColor: string
+ +
+
+ +

Private mProfileManagerFactory

+ + +
+
+ +

Private mPromptPhrase

+
mPromptPhrase: string
+ +
+
+ +

Private mRootCommandName

+
mRootCommandName: string
+ +
+
+ +

Private mYargsInstance

+
mYargsInstance: Argv
+ +
+
+

The Yargs instance object used to define the commands.

+
+
+
+
+
+

Methods

+
+ +

define

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Private property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.deleteinstance.html b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.deleteinstance.html new file mode 100644 index 0000000000..3d8e631987 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.deleteinstance.html @@ -0,0 +1,287 @@ + + + + + + DeleteInstance | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class DeleteInstance

+
+
+
+
+
+
+
+
+
+

Delete deprovisioned instances.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + DeleteInstance +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static deleteDeprovisionedInstance

+
    +
  • deleteDeprovisionedInstance(session: AbstractSession, zOSMFVersion: string, instanceId: string): any
  • +
+
    +
  • + +
    +
    +

    Performs the delete action against a provisioned software service instance.

    +
    +
    +
    memberof
    +

    DeleteInstance

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      zOSMFVersion: string
      +
      +

      the URI path variable that identifies the version of the z/OSMF software services template service. + The following value is valid: 1.0.

      +
      +
    • +
    • +
      instanceId: string
      +
      +

      the object-id of provisioned instance in the registry.

      +
      +
    • +
    +

    Returns any

    +
    +

    } z/OSMF response is empty object.

    +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listcatalogtemplates.html b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listcatalogtemplates.html new file mode 100644 index 0000000000..b8151be24b --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listcatalogtemplates.html @@ -0,0 +1,279 @@ + + + + + + ListCatalogTemplates | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ListCatalogTemplates

+
+
+
+
+
+
+
+
+
+

Get info about all published templates.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ListCatalogTemplates +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static listCatalogCommon

+ +
    +
  • + +
    +
    +

    This operation returns the catalog of published software service templates.

    +
    +
    +
    memberof
    +

    ListCatalogTemplates

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      zOSMFVersion: string
      +
      +

      the URI path variable that identifies the version of the z/OSMF software services template service. + The following value is valid: 1.0.

      +
      +
    • +
    +

    Returns Promise<any>

    +

    z/OSMF response object, @see {IPublishedTemplates}

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listinstanceinfo.html b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listinstanceinfo.html new file mode 100644 index 0000000000..5b7a35ed1d --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listinstanceinfo.html @@ -0,0 +1,285 @@ + + + + + + ListInstanceInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ListInstanceInfo

+
+
+
+
+
+
+
+
+
+

Get info about a provisioned instance.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ListInstanceInfo +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static listInstanceCommon

+ +
    +
  • + +
    +
    +

    This operation retrieves a published software service instance from the registry instances.

    +
    +
    +
    memberof
    +

    ListInstanceInfo

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      zOSMFVersion: string
      +
      +

      the URI path variable that identifies the version of the z/OSMF software services template service. + The following value is valid: 1.0.

      +
      +
    • +
    • +
      instanceId: string
      +
      +

      the id of the provisioned software service instance.

      +
      +
    • +
    +

    Returns Promise<any>

    +

    z/OSMF response object, @see {IProvisionedInstance}

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listinstancevariables.html b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listinstancevariables.html new file mode 100644 index 0000000000..b6e7d112ea --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listinstancevariables.html @@ -0,0 +1,331 @@ + + + + + + ListInstanceVariables | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ListInstanceVariables

+
+
+
+
+
+
+
+
+
+

Get variables of the provisioned instance.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ListInstanceVariables +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static getResourcesQuery

+
    +
  • getResourcesQuery(zOSMFVersion: string, instanceId: string): string
  • +
+
    +
  • + +
    +
    +

    Builds a resources query from passed parameters which is needed for z/OSMF api URI.

    +
    +
    +
    memberof
    +

    ListInstanceVariables

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      zOSMFVersion: string
      +
      +

      the URI path that identifies the version of the provisioning service.

      +
      +
    • +
    • +
      instanceId: string
      +
      +

      unique id of the provisioned instance .

      +
      +
    • +
    +

    Returns string

    +

    URI path for the REST call.

    +
  • +
+
+
+ +

Static listVariablesCommon

+ +
    +
  • + +
    +
    +

    This operation returns variables of the provisioned instance.

    +
    +
    +
    memberof
    +

    ListInstanceVariables

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      zOSMFVersion: string
      +
      +

      the URI path that identifies the version of the provisioning service.

      +
      +
    • +
    • +
      instanceId: string
      +
      +

      unique id of the provisioned instance .

      +
      +
    • +
    +

    Returns Promise<any>

    +

    z/OSMF response object, @see {IProvisionedInstanceVariable}

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listregistryinstances.html b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listregistryinstances.html new file mode 100644 index 0000000000..d5512884a3 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listregistryinstances.html @@ -0,0 +1,396 @@ + + + + + + ListRegistryInstances | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ListRegistryInstances

+
+
+
+
+
+
+
+
+
+

Get info about all provisioned instances.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ListRegistryInstances +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static getResourcesQuery

+
    +
  • getResourcesQuery(zOSMFVersion: string, type?: string, externalName?: string): string
  • +
+
    +
  • + +
    +
    +

    Builds URI path from provided parameters.

    +
    +
    +
    memberof
    +

    ListRegistryInstances

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      zOSMFVersion: string
      +
      +

      the URI path that identifies the version of the provisioning service.

      +
      +
    • +
    • +
      Optional type: string
      +
      +

      system type of the instance.

      +
      +
    • +
    • +
      Optional externalName: string
      +
      +

      regular expression, specifies the external name of the instance.

      +
      +
    • +
    +

    Returns string

    +

    URI path for the REST call.

    +
  • +
+
+
+ +

Static listFilteredRegistry

+
    +
  • listFilteredRegistry(session: AbstractSession, zOSMFVersion: string, type: string, externalName: string): Promise<any>
  • +
+
    +
  • + +
    +
    +

    This operation returns registry of provisioned instances filtered by type and external name.

    +
    +
    +
    memberof
    +

    ListRegistryInstances

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      zOSMFVersion: string
      +
      +

      the URI path that identifies the version of the provisioning service.

      +
      +
    • +
    • +
      type: string
      +
      +

      system type of the instance.

      +
      +
    • +
    • +
      externalName: string
      +
      +

      regular expression, specifies the external name of the instance.

      +
      +
    • +
    +

    Returns Promise<any>

    +

    z/OSMF response object, @see {IProvisionedInstances}

    +
  • +
+
+
+ +

Static listRegistryCommon

+
    +
  • listRegistryCommon(session: AbstractSession, zOSMFVersion: string, filteredQuery?: string): Promise<any>
  • +
+
    +
  • + +
    +
    +

    This operation returns registry of provisioned instances.

    +
    +
    +
    memberof
    +

    ListRegistryInstances

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      zOSMFVersion: string
      +
      +

      the URI path that identifies the version of the provisioning service.

      +
      +
    • +
    • +
      Optional filteredQuery: string
      +
      +

      URI path with filters for listing filtered registry instances.

      +
      +
    • +
    +

    Returns Promise<any>

    +

    z/OSMF response object, @see {IProvisionedInstances}

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listtemplateinfo.html b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listtemplateinfo.html new file mode 100644 index 0000000000..9ca938a061 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.listtemplateinfo.html @@ -0,0 +1,333 @@ + + + + + + ListTemplateInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ListTemplateInfo

+
+
+
+
+
+
+
+
+
+

Get info about a template.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ListTemplateInfo +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static getResourcesQuery

+
    +
  • getResourcesQuery(zOSMFVersion: string, templateName: string): string
  • +
+
    +
  • + +
    +
    +

    Builds a resources query from passed parameters which is needed for z/OSMF api URI.

    +
    +
    +
    memberof
    +

    ListTemplateInfo

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      zOSMFVersion: string
      +
      +

      is the URI path variable that identifies the version of the z/OSMF software services template service. + The following value is valid: 1.0.

      +
      +
    • +
    • +
      templateName: string
      +
      +

      is the name of published software service template in the catalog.

      +
      +
    • +
    +

    Returns string

    +

    URI for z/OSMF REST call

    +
  • +
+
+
+ +

Static listTemplateCommon

+ +
    +
  • + +
    +
    +

    This operation retrieves a published software service template from the catalog.

    +
    +
    +
    memberof
    +

    ListTemplateInfo

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      zOSMFVersion: string
      +
      +

      the URI path variable that identifies the version of the z/OSMF software services template service. + The following value is valid: 1.0.

      +
      +
    • +
    • +
      templateName: string
      +
      +

      the name of published software service template in the catalog.

      +
      +
    • +
    +

    Returns Promise<any>

    +

    z/OSMF response object, @see {IPublishedTemplateInfo}

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.performaction.html b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.performaction.html new file mode 100644 index 0000000000..539f59e125 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.performaction.html @@ -0,0 +1,345 @@ + + + + + + PerformAction | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class PerformAction

+
+
+
+
+
+
+
+
+
+

Perform an action on published software service template.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + PerformAction +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static doProvisioningActionCommon

+
    +
  • doProvisioningActionCommon(session: AbstractSession, zOSMFVersion: string, instanceId: string, actionName: string): Promise<any>
  • +
+
    +
  • + +
    +
    +

    Performs an action against a provisioned software service instance.

    +
    +
    +
    memberof
    +

    PerformAction

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      zOSMFVersion: string
      +
      +

      the URI path variable that identifies the version of the z/OSMF software services template service. + The following value is valid: 1.0.

      +
      +
    • +
    • +
      instanceId: string
      +
      +

      the object-id of provisioned instance in the registry.

      +
      +
    • +
    • +
      actionName: string
      +
      +

      name of the action to perform.

      +
      +
    • +
    +

    Returns Promise<any>

    +

    z/OSMF response object, @see {IPerformActionResponse}

    +
  • +
+
+
+ +

Static getResourcesQuery

+
    +
  • getResourcesQuery(zOSMFVersion: string, instanceId: string, actionName: string): string
  • +
+
    +
  • + +
    +
    +

    Builds a resources query from passed parameters which is needed for z/OSMF api URI.

    +
    +
    +
    memberof
    +

    PerformAction

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      zOSMFVersion: string
      +
      +

      the URI path variable that identifies the version of the z/OSMF software services template service. + The following value is valid: 1.0.

      +
      +
    • +
    • +
      instanceId: string
      +
      +

      the object-id of provisioned instance in the registry.

      +
      +
    • +
    • +
      actionName: string
      +
      +

      name of the action to perform.

      +
      +
    • +
    +

    Returns string

    +

    URI for z/OSMF REST call

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html new file mode 100644 index 0000000000..273ffc7be7 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.provisioningconstants.html @@ -0,0 +1,465 @@ + + + + + + ProvisioningConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProvisioningConstants

+
+
+
+
+
+
+
+
+
+

Constants for provisioning related info.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ProvisioningConstants +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly ACTIONS_RESOURCES

+
ACTIONS_RESOURCES: string = "actions"
+ +
+
+

URI base for performed actions on a provisioned instance.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+
+ +

Static Readonly INSTANCES_RESOURCE

+
INSTANCES_RESOURCE: string = "scr"
+ +
+
+

URI base for provisioned instances API.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+
+ +

Static Readonly RESOURCE

+
RESOURCE: string = "/zosmf/provisioning/rest"
+ +
+
+

URI base for provisioning API.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+
+ +

Static Readonly RESOURCE_EXTERNAL_NAME

+
RESOURCE_EXTERNAL_NAME: string = "external-name"
+ +
+
+

Parameter for filtering by external name.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+
+ +

Static Readonly RESOURCE_PROVISION_RUN

+
RESOURCE_PROVISION_RUN: string = "run"
+ +
+
+

URI base for provisioning a published template.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+
+ +

Static Readonly RESOURCE_TYPE

+
RESOURCE_TYPE: string = "type"
+ +
+
+

Parameter for filtering by type.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+
+ +

Static Readonly TEMPLATES_RESOURCES

+
TEMPLATES_RESOURCES: string = "psc"
+ +
+
+

URI base for published templates API.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+
+ +

Static Readonly VARIABLES_RESOURCE

+
VARIABLES_RESOURCE: string = "variables"
+ +
+
+

URI base for provisioned instance variables.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+
+ +

Static Readonly ZOSMF_VERSION

+
ZOSMF_VERSION: string = "1.0"
+ +
+
+

Version of the z/OSMF software services template service

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.provisioningservice.html b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.provisioningservice.html new file mode 100644 index 0000000000..d4c22a30a6 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.provisioningservice.html @@ -0,0 +1,396 @@ + + + + + + ProvisioningService | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProvisioningService

+
+
+
+
+
+
+
+
+
+

Service class which helps to filter or edit input parameters.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ProvisioningService +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static checkForPassedOptionalParms

+
    +
  • checkForPassedOptionalParms(properties?: string, propertiesFile?: string, domainName?: string, tenantName?: string, userDataId?: string, userData?: string, accountInfo?: string, systemNickNames?: string[]): IProvisionOptionals
  • +
+
    +
  • + +
    +
    +

    Helper method which checks if optional parameters were passed or not.

    +
    +
    +
    memberof
    +

    ProvisioningService

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional properties: string
      +
      +

      required runtime property objects.

      +
      +
    • +
    • +
      Optional propertiesFile: string
      +
      +

      path of the properties yaml file.

      +
      +
    • +
    • +
      Optional domainName: string
      +
      +

      name of the domain.

      +
      +
    • +
    • +
      Optional tenantName: string
      +
      +

      name of the tenant.

      +
      +
    • +
    • +
      Optional userDataId: string
      +
      +

      ID for the user data specified with user-data.

      +
      +
    • +
    • +
      Optional userData: string
      +
      +

      user data that is passed into the software services registry.

      +
      +
    • +
    • +
      Optional accountInfo: string
      +
      +

      account information to use in the JCL JOB statement.

      +
      +
    • +
    • +
      Optional systemNickNames: string[]
      +
      +

      nicknames of the systems upon which to provision a template.

      +
      +
    • +
    +

    Returns IProvisionOptionals

    +

    object with optional properties, @see {IProvisionOptionals}

    +
  • +
+
+
+ +

Static parseProperties

+ +
    +
  • + +
    +
    +

    Parsers text with properties in key1=val1,key2=val2 format and returns IInputProperty[]

    +
    +
    +
    memberof
    +

    ProvisioningService

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      propertiesText: string
      +
      +

      required runtime property objects passed as a string.

      +
      +
    • +
    +

    Returns IPropertiesInput[]

    +

    array of properties, @see {IPropertiesInput}

    +
  • +
+
+
+ +

Static readPropertiesFromYamlFile

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.provisioningvalidator.html b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.provisioningvalidator.html new file mode 100644 index 0000000000..3d1021fc22 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.provisioningvalidator.html @@ -0,0 +1,369 @@ + + + + + + ProvisioningValidator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProvisioningValidator

+
+
+
+
+
+
+
+
+
+

Class validates parameters for provisioning commands.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ProvisioningValidator +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static validateNotEmptyString

+
    +
  • validateNotEmptyString(text: string, errorMsg: string): void
  • +
+
    +
  • + +
    +
    +

    Validate supplied parameters

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProvisioningValidator

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      text: string
      +
      +

      string to check if empty

      +
      +
    • +
    • +
      errorMsg: string
      +
      +

      message to show in case validation fails

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static validateSession

+ + +
+
+ +

Static validateString

+
    +
  • validateString(text: string, errorMsg: string): void
  • +
+
    +
  • + +
    +
    +

    Validate supplied parameters

    +
    +
    +
    static
    +
    +
    memberof
    +

    ProvisioningValidator

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      text: string
      +
      +

      string to check if not null or undefined

      +
      +
    • +
    • +
      errorMsg: string
      +
      +

      message to show in case validation fails

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.provisionpublishedtemplate.html b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.provisionpublishedtemplate.html new file mode 100644 index 0000000000..7db0ade1f1 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_provisioning_for_zowe_sdk.provisionpublishedtemplate.html @@ -0,0 +1,351 @@ + + + + + + ProvisionPublishedTemplate | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ProvisionPublishedTemplate

+
+
+
+
+
+
+
+
+
+

Provision a published software service template.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ProvisionPublishedTemplate +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static provisionTemplate

+ +
    +
  • + +
    +
    +

    Provision a published software service template, with optional parameters if passed.

    +
    +
    +
    memberof
    +

    ProvisionPublishedTemplate

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      zOSMFVersion: string
      +
      +

      the URI path variable that identifies the version of the z/OSMF software services template service. + The following value is valid: 1.0.

      +
      +
    • +
    • +
      templateName: string
      +
      +

      the name of published software service template.

      +
      +
    • +
    • +
      Optional optionalParms: IProvisionOptionals
      +
      +

      optional parameters for z/OSMF rest call, @see {IProvisionOptionals}.

      +
      +
    • +
    +

    Returns Promise<any>

    +

    z/OSMF response object, @see {IProvisionTemplateResponse}

    +
  • +
+
+
+ +

Static provisionTemplateCommon

+
    +
  • provisionTemplateCommon(session: AbstractSession, zOSMFVersion: string, templateName: string, account: string): Promise<any>
  • +
+
    +
  • + +
    +
    +

    Provision a published software service template only with account number parameter.

    +
    +
    +
    memberof
    +

    ProvisionPublishedTemplate

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      zOSMFVersion: string
      +
      +

      the URI path variable that identifies the version of the z/OSMF software services template service. + The following value is valid: 1.0.

      +
      +
    • +
    • +
      templateName: string
      +
      +

      the name of published software service template.

      +
      +
    • +
    • +
      account: string
      +
      +

      account information to use in the JCL JOB statement.

      +
      +
    • +
    +

    Returns Promise<any>

    +

    z/OSMF response object, @see {IProvisionTemplateResponse}

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.collectcommand.html b/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.collectcommand.html new file mode 100644 index 0000000000..ec997b0417 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.collectcommand.html @@ -0,0 +1,605 @@ + + + + + + CollectCommand | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CollectCommand

+
+
+
+
+
+
+
+
+
+

Get the response to a command that was issued asynchronously with the Issue Command service

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + CollectCommand +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Static Private Readonly TO_SECONDS

+
TO_SECONDS: number = 1000
+ +
+
+
+

Methods

+
+ +

Static collect

+ +
    +
  • + +
    +
    +

    Collect any messages related to the synchronous command response key provided and collect them into IConsoleResponse

    +
    +

    To control additional collection and other behaviors, populate the ICollectParms object according + to your needs (see ICollectParms for details).

    +
    +
    static
    +
    +
    memberof
    +

    CollectCommand

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      parms: ICollectParms
      +
      +

      console collect parameters, @see {ICollectParms}

      +
      +
    • +
    • +
      Optional response: IConsoleResponse
      +
      +

      response from previous command (if present), @see {IConsoleResponse}

      +
      +
    • +
    +

    Returns Promise<IConsoleResponse>

    +

    command response on resolve, @see {IConsoleResponse}

    +
  • +
+
+
+ +

Static collectCommon

+
    +
  • collectCommon(session: AbstractSession, consoleName: string, commandResponseKey: string): any
  • +
+
    +
  • + +
    +
    +

    Collect any messages related to the synchronous command response key provided

    +
    +
    +
    static
    +
    +
    memberof
    +

    CollectCommand

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      consoleName: string
      +
      +

      name of the EMCS console that is used to issue the command

      +
      +
    • +
    • +
      commandResponseKey: string
      +
      +

      command response key from the Issue Command request

      +
      +
    • +
    +

    Returns any

    +

    command response on resolve, @see {IZosmfIssueResponse}

    +
  • +
+
+
+ +

Static collectDefConsoleCommon

+
    +
  • collectDefConsoleCommon(session: AbstractSession, commandResponseKey: string): any
  • +
+
    +
  • + +
    +
    +

    Collect any messages (from default console) related to the synchronous command response key provided

    +
    +
    +
    static
    +
    +
    memberof
    +

    CollectCommand

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      commandResponseKey: string
      +
      +

      command response key from the Issue Command request

      +
      +
    • +
    +

    Returns any

    +

    command response on resolve, @see {IZosmfCollectResponse}

    +
  • +
+
+
+ +

Static Private getFollowUpAttempts

+ + +
+
+ +

Static getResource

+
    +
  • getResource(consoleName: string, commandResponseKey: string): string
  • +
+
    +
  • + +
    +
    +

    Get resource path for collect command

    +
    +
    +
    memberof
    +

    CollectCommand

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      consoleName: string
      +
      +

      name of the EMCS console that is used to issue the command

      +
      +
    • +
    • +
      commandResponseKey: string
      +
      +

      command response key from the Issue Command request

      +
      +
    • +
    +

    Returns string

    +

    resource path

    +
  • +
+
+
+ +

Static Private getTimeout

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.consoleconstants.html b/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.consoleconstants.html new file mode 100644 index 0000000000..8433fb99ea --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.consoleconstants.html @@ -0,0 +1,376 @@ + + + + + + ConsoleConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConsoleConstants

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ConsoleConstants +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly CLASS

+
CLASS: string = "Consoles"
+ +
+
+ +

Static Readonly DEFAULT_FOLLOWUP_ATTEMPTS

+
DEFAULT_FOLLOWUP_ATTEMPTS: number = 1
+ +
+
+ +

Static Readonly DEFAULT_TIMEOUT

+
DEFAULT_TIMEOUT: number = 0
+ +
+
+ +

Static Readonly RESOURCE

+
RESOURCE: string = "/zosmf/restconsoles/consoles"
+ +
+
+ +

Static Readonly RES_DEF_CN

+
RES_DEF_CN: string = "defcn"
+ +
+
+ +

Static Readonly SOL_MSGS

+
SOL_MSGS: string = "/solmsgs"
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.consoleresponseservice.html b/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.consoleresponseservice.html new file mode 100644 index 0000000000..876359c4ea --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.consoleresponseservice.html @@ -0,0 +1,488 @@ + + + + + + ConsoleResponseService | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConsoleResponseService

+
+
+
+
+
+
+
+
+
+

Class contains helper methods for console response commands response processing

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ConsoleResponseService +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static getEmptyConsoleResponse

+ + +
+
+ +

Static isLastZosmfResponseEmpty

+ + +
+
+ +

Static populate

+ +
    +
  • + +
    +
    +

    Populate the console response with the details returned from the z/OSMF console API. + Method takes two parameters: response from z/OSMF command and response to be populated. + Method adds response to a collection of z/OSMF responses, mark response as "succeeded" (response.success = true) + and populate other fields of response with values from z/OSMF sresponse.

    +
    +
    +
    static
    +
    +
    memberof
    +

    ConsoleResponse

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      zosmfResponse: IZosmfIssueResponse
      +
      +

      zosmf console response, @see {IZosmfIssueResponse}

      +
      +
    • +
    • +
      response: IConsoleResponse
      +
      +

      console response to be populated, @see {IConsoleResponse}

      +
      +
    • +
    • +
      Optional processResponses: boolean
      +
      +

      is set to true, append command response string to the console API response

      +
      +
    • +
    +

    Returns IConsoleResponse

    +

    populated console response, @see {IConsoleResponse}

    +
  • +
+
+
+ +

Static populateError

+ +
    +
  • + +
    +
    +

    Populate the console response with the Imperative error message. + Method takes two parameters: Imperative error and response to be populated. + Method save error message info failureResponse field and mark console response as "failed" (response.success = false)

    +
    +
    +
    tatic
    +
    +
    memberof
    +

    ConsoleResponse

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      error: ImperativeError
      +
      +

      Imperative error, @see {ImperativeError}

      +
      +
    • +
    • +
      response: IConsoleResponse
      +
      +

      console response to be populated, @see {IConsoleResponse}

      +
      +
    • +
    +

    Returns IConsoleResponse

    +

    populated console response, @see {IConsoleResponse}

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html b/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html new file mode 100644 index 0000000000..d0504b7521 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.consolevalidator.html @@ -0,0 +1,719 @@ + + + + + + ConsoleValidator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ConsoleValidator

+
+
+
+
+
+
+
+
+
+

Class validates parameters for console commands

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ConsoleValidator +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static validateCollectCommonParms

+
    +
  • validateCollectCommonParms(session: AbstractSession, consoleName: string, commandResponseKey: string): void
  • +
+
    +
  • + +
    +
    +

    Validate supplied parameters

    +
    +
    +
    static
    +
    +
    memberof
    +

    ConsoleValidator

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      consoleName: string
      +
      +

      name of the EMCS console that is used to issue the command

      +
      +
    • +
    • +
      commandResponseKey: string
      +
      +

      command response key from the Issue Command request

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static validateCollectParm

+ + +
+
+ +

Static validateCollectParms

+ + +
+
+ +

Static validateCommonParms

+ +
    +
  • + +
    +
    +

    Validate supplied parameters

    +
    +
    +
    static
    +
    +
    memberof
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      consoleName: string
      +
      +

      name of the EMCS console that is used to issue the command

      +
      +
    • +
    • +
      commandParms: IZosmfIssueParms
      +
      +

      synchronous console issue parameters, @see {IZosmfIssueParms}

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static Private validateConsoleName

+
    +
  • validateConsoleName(consoleName: string): void
  • +
+ +
+
+ +

Static validateIssueParm

+ + +
+
+ +

Static validateIssueParms

+ + +
+
+ +

Static validateIssueSimpleParms

+
    +
  • validateIssueSimpleParms(session: AbstractSession, theCommand: string): void
  • +
+ +
+
+ +

Static Private validateSession

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.issuecommand.html b/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.issuecommand.html new file mode 100644 index 0000000000..9b5c6ab99e --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_console_for_zowe_sdk.issuecommand.html @@ -0,0 +1,652 @@ + + + + + + IssueCommand | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class IssueCommand

+
+
+
+
+
+
+
+
+
+

Issue MVS Console commands by using a system console

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + IssueCommand +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static buildZosmfConsoleApiParameters

+ + +
+
+ +

Static getResource

+
    +
  • getResource(consoleName: string): string
  • +
+
    +
  • + +
    +
    +

    Get resource path for issue command

    +
    +
    +
    static
    +
    +
    memberof
    +

    IssueCommand

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      consoleName: string
      +
      +

      name of the EMCS console that is used to issue the command

      +
      +
    • +
    +

    Returns string

    +

    resource path

    +
  • +
+
+
+ +

Static issue

+ +
    +
  • + +
    +
    +

    Issue an MVS console command command synchronously - meaning solicited (direct command responses) are gathered + immediately after the command is issued. However, after (according to the z/OSMF REST API documentation) + approximately 3 seconds the response will be returned.

    +
    +
    +
    static
    +
    +
    memberof
    +

    IssueCommand

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      parms: IIssueParms
      +
      +

      console issue parameters, @see {IIssueParms}

      +
      +
    • +
    +

    Returns Promise<IConsoleResponse>

    +

    command response on resolve, @see {IConsoleResponse}

    +
  • +
+
+
+ +

Static issueAndCollect

+ +
    +
  • + +
    +
    +

    Issue an MVS console command command synchronously - meaning solicited (direct command responses) are gathered + immediately after the command is issued. However, after (according to the z/OSMF REST API documentation) + approximately 3 seconds the response will be returned.

    +
    +

    To control additional collection and other behaviors, populate the ICollectParms object according + to your needs (see ICollectParms for details).

    +
    +
    static
    +
    +
    memberof
    +

    IssueCommand

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      issueParms: IIssueParms
      +
      +

      console issue parameters, @see {IIssueParms}

      +
      +
    • +
    • +
      collectParms: ICollectParms
      +
      +

      console collect parameters, @see {ICollectParms}

      +
      +
    • +
    +

    Returns Promise<IConsoleResponse>

    +

    command response on resolve, @see {IConsoleResponse}

    +
  • +
+
+
+ +

Static issueCommon

+ +
    +
  • + +
    +
    +

    Issue an MVS console command, returns "raw" z/OSMF response

    +
    +
    +
    static
    +
    +
    memberof
    +

    IssueCommand

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      consoleName: string
      +
      +

      name of the EMCS console that is used to issue the command

      +
      +
    • +
    • +
      commandParms: IZosmfIssueParms
      +
      +

      synchronous console issue parameters, @see {IZosmfIssueParms}

      +
      +
    • +
    +

    Returns any

    +

    command response on resolve, @see {IZosmfIssueResponse}

    +
  • +
+
+
+ +

Static issueDefConsoleCommon

+ +
    +
  • + +
    +
    +

    Issue an MVS console command in default console, returns "raw" z/OSMF response

    +
    +
    +
    static
    +
    +
    memberof
    +

    IssueCommand

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      commandParms: IZosmfIssueParms
      +
      +

      synchronous console issue parameters, @see {IZosmfIssueParms}

      +
      +
    • +
    +

    Returns any

    +

    command response on resolve, @see {IZosmfIssueResponse}

    +
  • +
+
+
+ +

Static issueSimple

+ +
    +
  • + +
    +
    +

    Simple issue console command method. Does not accept parameters, so all defaults on the z/OSMF API are taken.

    +
    +
    +
    static
    +
    +
    memberof
    +

    IssueCommand

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      theCommand: string
      +
      +

      command to issue

      +
      +
    • +
    +

    Returns Promise<IConsoleResponse>

    +

    command response on resolve, @see {IConsoleResponse}

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.copy.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.copy.html new file mode 100644 index 0000000000..04cf48a846 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.copy.html @@ -0,0 +1,430 @@ + + + + + + Copy | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Copy

+
+
+
+
+
+
+
+
+
+

This class holds helper functions that are used to copy the contents of datasets through the + z/OSMF APIs.

+
+
+
+
+

Hierarchy

+
    +
  • + Copy +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static Private convertAlcTozOSMF

+
    +
  • convertAlcTozOSMF(zosmfValue: string): string
  • +
+ +
+
+ +

Static dataSet

+ + +
+
+ +

Static dataSetCrossLPAR

+ + +
+
+ +

Static Private generateDatasetOptions

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.create.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.create.html new file mode 100644 index 0000000000..2416efc7e6 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.create.html @@ -0,0 +1,672 @@ + + + + + + Create | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Create

+
+
+
+
+
+
+
+
+
+

Class to handle creation of data sets

+
+
+
+
+

Hierarchy

+
    +
  • + Create +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static dataSet

+ + +
+
+ +

Static dataSetLike

+ + +
+
+ +

Static dataSetValidateOptions

+ + +
+
+ +

Static uss

+ + +
+
+ +

Static vsam

+ +
    +
  • + +
    +
    +

    Create a VSAM cluster

    +
    +
    +
    example
    +
    
    +    sessCfg: ISession = yourFunctionToCreateSessCfgFromArgs(commandParameters.arguments);
    +    sessCfgWithCreds = await ConnectionPropsForSessCfg.addPropsOrPrompt<ISession>(
    +        sessCfg, commandParameters.arguments
    +    );
    +    session = new Session(sessCfgWithCreds);
    +
    +    // The option keys are defined in ZosFilesCreateOptions,
    +    // ZosFilesCreateExtraOptions and VsamCreateOptions.
    +    //
    +    const createVsamOptions: Partial<ICreateVsamOptions> = {
    +        dsorg: "INDEXED",
    +        size: "640KB",
    +        secondary: 64
    +        showAttributes: true
    +    }));
    +
    +    try {
    +        createResponse = await Create.vsam(
    +            session, "SOME.DATASET.NAME", createVsamOptions
    +        );
    +    }
    +    catch (impErr) {
    +        // handle any error
    +    }
    +
    +    // use the results in createResponse.commandResponse
    +
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      An established z/OSMF session

      +
      +
    • +
    • +
      dataSetName: string
      +
      +

      the name of the dataset for the created cluster

      +
      +
    • +
    • +
      Optional options: Partial<ICreateVsamOptions>
      +
      +

      options for the creation of the cluster

      +
      +
    • +
    +

    Returns Promise<IZosFilesResponse>

    +
  • +
+
+
+ +

Static Private vsamConvertToIdcamsOptions

+ + +
+
+ +

Static Private vsamFormIdcamsCreateCmd

+ + +
+
+ +

Static Private vsamValidateOptions

+ + +
+
+ +

Static zfs

+ + +
+
+ +

Static Private zfsValidateOptions

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.delete.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.delete.html new file mode 100644 index 0000000000..ac47395ad4 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.delete.html @@ -0,0 +1,448 @@ + + + + + + Delete | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Delete

+
+
+
+
+
+
+
+
+
+

This class holds helper functions that are used to delete files through the + z/OSMF APIs.

+
+
+
+
+

Hierarchy

+
    +
  • + Delete +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static dataSet

+ + +
+
+ +

Static ussFile

+ + +
+
+ +

Static vsam

+ + +
+
+ +

Static zfs

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.download.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.download.html new file mode 100644 index 0000000000..77a17fe731 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.download.html @@ -0,0 +1,729 @@ + + + + + + Download | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Download

+
+
+
+
+
+
+
+
+
+

This class holds helper functions that are used to download data sets, members and more through the z/OS MF APIs

+
+
+
+
+

Hierarchy

+
    +
  • + Download +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static allDataSets

+ + +
+
+ +

Static allMembers

+ + +
+
+ +

Static Private buildDownloadDsmResponse

+ + +
+
+ +

Static Private buildDownloadUssDirResponse

+ + +
+
+ +

Static dataSet

+ + +
+
+ +

Static Private emptyDownloadDsmResult

+ + +
+
+ +

Static Private emptyDownloadUssDirResult

+ + +
+
+ +

Static Private generateHeadersBasedOnOptions

+ + +
+
+ +

Static Private parseAttributeOptions

+ + +
+
+ +

Static ussDir

+ + +
+
+ +

Static ussFile

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.get.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.get.html new file mode 100644 index 0000000000..2e7f1b4b31 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.get.html @@ -0,0 +1,331 @@ + + + + + + Get | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Get

+
+
+
+
+
+
+
+
+
+

This class holds helper functions that are used to get the content of data sets or USS files through the z/OSMF APIs

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + Get +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static USSFile

+ + +
+
+ +

Static dataSet

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.hdelete.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.hdelete.html new file mode 100644 index 0000000000..1e76632ae3 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.hdelete.html @@ -0,0 +1,281 @@ + + + + + + HDelete | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class HDelete

+
+
+
+
+
+
+
+
+
+

This class holds helper functions that are used to delete data sets through the + z/OSMF APIs.

+
+
+
+
+

Hierarchy

+
    +
  • + HDelete +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static dataSet

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.hmigrate.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.hmigrate.html new file mode 100644 index 0000000000..b79bbc5dba --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.hmigrate.html @@ -0,0 +1,281 @@ + + + + + + HMigrate | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class HMigrate

+
+
+
+
+
+
+
+
+
+

This class holds helper functions that are used to migrate data sets through the + z/OSMF APIs.

+
+
+
+
+

Hierarchy

+
    +
  • + HMigrate +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static dataSet

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.hrecall.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.hrecall.html new file mode 100644 index 0000000000..abbb96cca1 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.hrecall.html @@ -0,0 +1,281 @@ + + + + + + HRecall | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class HRecall

+
+
+
+
+
+
+
+
+
+

This class holds helper functions that are used to recall data sets through the + z/OSMF APIs.

+
+
+
+
+

Hierarchy

+
    +
  • + HRecall +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static dataSet

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.invoke.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.invoke.html new file mode 100644 index 0000000000..1c30bf603f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.invoke.html @@ -0,0 +1,283 @@ + + + + + + Invoke | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Invoke

+
+
+
+
+
+
+
+
+
+

This class holds helper functions that are used to execute AMS control statements through the z/OS MF APIs

+
+
+
+
+

Hierarchy

+
    +
  • + Invoke +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static ams

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.list.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.list.html new file mode 100644 index 0000000000..26fb9789a8 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.list.html @@ -0,0 +1,590 @@ + + + + + + List | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class List

+
+
+
+
+
+
+
+
+
+

This class holds helper functions that are used to list data sets and its members through the z/OS MF APIs

+
+
+
+
+

Hierarchy

+
    +
  • + List +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Static Private CONTROL_CHAR_REGEX

+
CONTROL_CHAR_REGEX: RegExp = new RegExp(/[\x00-\x1f\x7f\x80-\x9f]/g)
+ +
+
+
+

Accessors

+
+ +

Static Private log

+
    +
  • get log(): any
  • +
+ +
+
+
+

Methods

+
+ +

Static allMembers

+ + +
+
+ +

Static dataSet

+ + +
+
+ +

Static dataSetsMatchingPattern

+ +
    +
  • + +
    +
    +

    List data sets that match a DSLEVEL pattern

    +
    +
    +
    example
    +
    
    +// List all "PS" and "PO" datasets that match the pattern "USER.**.DATASET"
    +await List.dataSetsMatchingPattern(session, "USER.**.DATASET");
    +
    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      patterns: string[]
      +
      +

      Data set patterns to include

      +
      +
    • +
    • +
      Default value options: IDsmListOptions = {}
      +
      +

      Contains options for the z/OSMF request

      +
      +
    • +
    +

    Returns Promise<IZosFilesResponse>

    +

    List of z/OSMF list responses for each data set

    +
  • +
+
+
+ +

Static fileList

+ + +
+
+ +

Static fs

+ + +
+
+ +

Static fsWithPath

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.mount.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.mount.html new file mode 100644 index 0000000000..c83dd0c7e6 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.mount.html @@ -0,0 +1,324 @@ + + + + + + Mount | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Mount

+
+
+
+
+
+
+
+
+
+

This class holds helper functions that are used to mount file systems through the z/OS MF APIs

+
+
+
+
+

Hierarchy

+
    +
  • + Mount +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static fs

+ + +
+
+ +

Static Private fsValidateOptions

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.rename.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.rename.html new file mode 100644 index 0000000000..f74ca11657 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.rename.html @@ -0,0 +1,382 @@ + + + + + + Rename | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Rename

+
+
+
+
+
+
+
+
+
+

Class to handle renaming data sets

+
+
+
+
+

Hierarchy

+
    +
  • + Rename +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static dataSet

+ + +
+
+ +

Static dataSetMember

+ + +
+
+ +

Static Private rename

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.unmount.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.unmount.html new file mode 100644 index 0000000000..80eff4cbe9 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.unmount.html @@ -0,0 +1,286 @@ + + + + + + Unmount | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Unmount

+
+
+
+
+
+
+
+
+
+

This class holds helper functions that are used to unmount file systems through the z/OS MF APIs

+
+
+
+
+

Hierarchy

+
    +
  • + Unmount +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static fs

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.upload.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.upload.html new file mode 100644 index 0000000000..551758687a --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.upload.html @@ -0,0 +1,1030 @@ + + + + + + Upload | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Upload

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Upload +
  • +
+
+
+

Index

+
+ +
+
+
+

Accessors

+
+ +

Static Private log

+ + +
+
+
+

Methods

+
+ +

Static bufferToDataSet

+ + +
+
+ +

Static bufferToUssFile

+ + +
+
+ +

Static dirToPds

+ + +
+
+ +

Static dirToUSSDir

+ + +
+
+ +

Static dirToUSSDirRecursive

+ + +
+
+ +

Static fileToDataset

+ + +
+
+ +

Static fileToUssFile

+ + +
+
+ +

Static Private formatStringForDisplay

+
    +
  • formatStringForDisplay(stringInput: string): string
  • +
+ +
+
+ +

Static Private generateHeadersBasedOnOptions

+ + +
+
+ +

Static Private getDirs

+ + +
+
+ +

Static Private hasDirs

+
    +
  • hasDirs(dirPath: string): boolean
  • +
+ +
+
+ +

Static isDirectoryExist

+ + +
+
+ +

Static pathToDataSet

+ +
    +
  • + +
    +
    +

    Upload content from input path to dataSet or PDS members

    +
    +
    +
    throws
    +

    {ImperativeError} When encounter error scenarios.

    +
    +
    example
    +

    pathToDataSet(session, "file.txt", "ps.name")

    +
    +
    example
    +

    pathToDataset(session, "file.txt", "psd.name(member)")

    +
    +
    example
    +

    pathToDataSet(session, "directory", "pds.name")

    +
    +
    example
    +

    pathToDataset(session, "/full/path/file.txt", "ps.name")

    +

    Note: + This method does everything needed to do from checking if path is file or directory + and if data set is sequential file or PDS to determine what name to be used when + upload content to data set. All you have to specify is a directory and a dsname.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OS connection info

      +
      +
    • +
    • +
      inputPath: string
      +
      +

      User input path to file or directory

      +
      +
    • +
    • +
      dataSetName: string
      +
      +

      Name of the data set to write to

      +
      +
    • +
    • +
      Default value options: IUploadOptions = {}
      +
    • +
    +

    Returns Promise<IZosFilesResponse>

    +

    A response indicating the out come

    +
  • +
+
+
+ +

Static streamToDataSet

+ + +
+
+ +

Static streamToUssFile

+ + +
+
+ +

Static Private uploadFile

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.utilities.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.utilities.html new file mode 100644 index 0000000000..4260ec0d35 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.utilities.html @@ -0,0 +1,483 @@ + + + + + + Utilities | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Utilities

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Utilities +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static applyTaggedEncoding

+ + +
+
+ +

Static chtag

+ +
    +
  • + +
    +
    +

    Changes the tag attributes associate with a file using function chtag

    +
    +

    This function uses a JSON payload to set the information via zosmf utilities function

    +
    +
    throws
    +

    {ImperativeError}

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      ussFileName: string
      +
    • +
    • +
      type: Tag
      +
      +

      enum of chtag type of Test, Binary or Mixed

      +
      +
    • +
    • +
      Optional codeset: string
      +
      +

      optional string describing codeset e.g. IBM-1047

      +
      +
    • +
    +

    Returns Promise<IZosFilesResponse>

    +

    Promise that resolves to response object

    +
  • +
+
+
+ +

Static isFileTagBinOrAscii

+ +
    +
  • + +
    +
    +

    Based upon the files chtag value. Identify how the tagging should be interpretted when transferring the contents + For example an EBCDIC file would always be converted from it's EBCDIC value to the ASCII

    +
    +

    An ASCII file value or binary should not be converted.

    +

    The default value if the tag is not set or in an invalid state correctly is to convert.

    +
    +
    throws
    +

    {ImperativeError}

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      USSFileName: string
      +
      +

      contains the file name

      +
      +
    • +
    +

    Returns Promise<boolean>

    +

    Promise that resolves to true if the file is binary or ASCII text or false if file + should likely be converted to text. Default is false which aligns with the zosmf default behavior converting

    +
  • +
+
+
+ +

Static putUSSPayload

+ +
    +
  • + +
    +
    +

    Retrieve various details from USS file functions

    +
    +

    This function uses a JSON payload to retrieve information via zosmf utilities function

    +
    +
    throws
    +

    {ImperativeError}

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      USSFileName: string
      +
      +

      contains the file name

      +
      +
    • +
    • +
      payload: any
      +
      +

      contains the options to be sent

      +
      +
    • +
    +

    Returns Promise<Buffer>

    +

    Promise that resolves to json information

    +
  • +
+
+
+ +

Static renameUSSFile

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html new file mode 100644 index 0000000000..25700ad529 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.zosfilesattributes.html @@ -0,0 +1,557 @@ + + + + + + ZosFilesAttributes | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ZosFilesAttributes

+
+
+
+
+
+
+
+
+
+

Attributes for a set of files relating to how they will be uploaded to USS

+
+
+
+
+

Hierarchy

+
    +
  • + ZosFilesAttributes +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new ZosFilesAttributes(attributesFileContents: string, basePath?: string): ZosFilesAttributes
  • +
+ +
+
+
+

Properties

+
+ +

Private attributes

+
attributes: Map<string, IUploadAttributes> = new Map<string,IUploadAttributes>()
+ +
+
+ +

Private basePath

+
basePath: string
+ +
+
+ +

Static Private MAX_EXPECTED_FIELDS

+
MAX_EXPECTED_FIELDS: number = 3
+ +
+
+ +

Static Private MIN_EXPECTED_FIELDS

+
MIN_EXPECTED_FIELDS: number = 2
+ +
+
+
+

Methods

+
+ +

fileShouldBeIgnored

+
    +
  • fileShouldBeIgnored(path: string): boolean
  • +
+ +
+
+ +

fileShouldBeUploaded

+
    +
  • fileShouldBeUploaded(path: string): boolean
  • +
+ +
+
+ +

Private findLastMatchingAttributes

+
    +
  • findLastMatchingAttributes(path: string): IUploadAttributes
  • +
+ +
+
+ +

getFileTransferMode

+
    +
  • getFileTransferMode(path: string, preferBinary?: boolean): TransferMode
  • +
+ +
+
+ +

getLocalEncoding

+
    +
  • getLocalEncoding(path: string): string
  • +
+ +
+
+ +

getRemoteEncoding

+
    +
  • getRemoteEncoding(path: string): string
  • +
+ +
+
+ +

Private parse

+
    +
  • parse(attributesFileContents: string): void
  • +
+ +
+
+ +

Static loadFromFile

+
    +
  • loadFromFile(filePath?: string, defaultDir?: string): ZosFilesAttributes | undefined
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html new file mode 100644 index 0000000000..1da5ac9216 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_files_for_zowe_sdk.zosfilesutils.html @@ -0,0 +1,721 @@ + + + + + + ZosFilesUtils | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ZosFilesUtils

+
+
+
+
+
+
+
+
+
+

Common IO utilities

+
+
+
+
+

Hierarchy

+
    +
  • + ZosFilesUtils +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly DEFAULT_FILE_EXTENSION

+
DEFAULT_FILE_EXTENSION: string = "txt"
+ +
+
+

Default file extension

+
+
+
+
+ +

Static Readonly DSN_SEP

+
DSN_SEP: string = "."
+ +
+
+

Data set name qualifier separator

+
+
+
+
+ +

Static Readonly MAX_MEMBER_LENGTH

+
MAX_MEMBER_LENGTH: number = 8
+ +
+
+
+

Methods

+
+ +

Static dfsmsHsmCommand

+ +
    +
  • + +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      dataSetName: string
      +
      +

      -The name of the data set to recall|migrate|delete

      +
      +
    • +
    • +
      returnMessage: string
      +
      +

      Message to return based upon command request

      +
      +
    • +
    • +
      hsmCommand: any
      +
      +

      HsmCommand requested

      +
      +
    • +
    • +
      Default value options: Partial<IDeleteOptions> = {}
      +
      +
        +
        • +
        • If true then the function waits for completion of the request. If false (default) the request is queued.
        • +
        +
      • +
      +
      +
    • +
    +

    Returns Promise<IZosFilesResponse>

    +
  • +
+
+
+ +

Static formatUnixFilepath

+
    +
  • formatUnixFilepath(usspath: string): string
  • +
+ +
+
+ +

Static Private generateHeadersBasedOnOptions

+ + +
+
+ +

Static generateMemberName

+
    +
  • generateMemberName(fileName: string): string
  • +
+
    +
  • + +
    +
    +

    Generate member name from input string base on IBM specification

    +
    +
    +

    Parameters

    +
      +
    • +
      fileName: string
      +
      +

      input name used to generate member name with

      +
      +
    • +
    +

    Returns string

    +

    generated member name

    +
  • +
+
+
+ +

Static getDataSetFromName

+
    +
  • getDataSetFromName(name: string): IDataSet
  • +
+ +
+
+ +

Static getDirsFromDataSet

+
    +
  • getDirsFromDataSet(dataSet: string): string
  • +
+
    +
  • + +
    +
    +

    Break up a dataset name of either: + USER.WORK.JCL(TEMPLATE) to user/work/jcl/template + Or: + USER.WORK.PS to user/work/ps

    +
    +
    +

    Parameters

    +
      +
    • +
      dataSet: string
      +
      +

      data set to break up into folders

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

Static getFileListFromPath

+
    +
  • getFileListFromPath(inputPath: string, inFullPathFormat?: boolean, isIgnoreHidden?: boolean): string[]
  • +
+
    +
  • + +
    +
    +

    Return an array contain the list of all files in the input path. It does not trevor to + directory in the input path.

    +
    +
    +

    Parameters

    +
      +
    • +
      inputPath: string
      +
      +

      input path to gather file list

      +
      +
    • +
    • +
      Default value inFullPathFormat: boolean = true
      +
    • +
    • +
      Default value isIgnoreHidden: boolean = true
      +
    • +
    +

    Returns string[]

    +

    Array of all files finds in path

    +
  • +
+
+
+ +

Static getFullPath

+
    +
  • getFullPath(inputPath: string): string
  • +
+ +
+
+ +

Static isDataSetNameContainMasking

+
    +
  • isDataSetNameContainMasking(dataSetName: string): boolean
  • +
+
    +
  • + +
    +
    +

    Check if the input data set name contain masking characters

    +
    +
    +

    Parameters

    +
      +
    • +
      dataSetName: string
      +
      +

      input data set name to be checked

      +
      +
    • +
    +

    Returns boolean

    +

    status if data set name contain masking characters

    +
  • +
+
+
+ +

Static normalizeNewline

+
    +
  • normalizeNewline(buffer: Buffer): Buffer
  • +
+ +
+
+ +

Static sanitizeUssPathForRestCall

+
    +
  • sanitizeUssPathForRestCall(ussPath: string): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.canceljobs.html b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.canceljobs.html new file mode 100644 index 0000000000..667019e651 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.canceljobs.html @@ -0,0 +1,552 @@ + + + + + + CancelJobs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CancelJobs

+
+
+
+
+
+
+
+
+
+

Class to handle deletion of job information

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + CancelJobs +
  • +
+
+
+

Index

+
+
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Accessors

+
+ +

Static Private log

+ + +
+
+
+

Methods

+
+ +

Static cancelJob

+ +
    +
  • + +
    +
    +

    Cancel and purge a job

    +
    +
    +
    static
    +
    +
    memberof
    +

    CancelJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobname: string
      +
      +

      job name to be translated into parms object

      +
      +
    • +
    • +
      jobid: string
      +
      +

      job id to be translated into parms object

      +
      +
    • +
    • +
      Optional version: string
      +
    • +
    +

    Returns Promise<undefined | IJobFeedback>

    +
      +
    • promise of undefined, or IJobFeedback object returned by API if modifyVersion is 2.0
    • +
    +
  • +
+
+
+ +

Static cancelJobCommon

+ +
    +
  • + +
    +
    +

    Cancel and purge a job + Full version of the API with a parameter object

    +
    +
    +
    static
    +
    +
    memberof
    +

    CancelJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      parms: ICancelJobParms
      +
      +

      parm object (see ICancelJobParms interface for details)

      +
      +
    • +
    +

    Returns Promise<undefined | IJobFeedback>

    +
      +
    • promise of undefined, or IJobFeedback object returned by API if modifyVersion is 2.0
    • +
    +
  • +
+
+
+ +

Static cancelJobForJob

+ +
    +
  • + +
    +
    +

    Cancel and purge a job + Alternative version of the cancel API accepting an IJob object returned from other APIs such as GetJobs and SubmitJobs

    +
    +
    +
    static
    +
    +
    memberof
    +

    CancelJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      job: IJob
      +
      +

      the job that you want to cancel

      +
      +
    • +
    • +
      Optional version: "1.0" | "2.0"
      +
      +

      version of cancel request

      +
      +
    • +
    +

    Returns Promise<undefined | IJobFeedback>

    +
      +
    • promise of undefined, or IJobFeedback object returned by API if modifyVersion is 2.0
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.deletejobs.html b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.deletejobs.html new file mode 100644 index 0000000000..a9c5369907 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.deletejobs.html @@ -0,0 +1,549 @@ + + + + + + DeleteJobs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class DeleteJobs

+
+
+
+
+
+
+
+
+
+

Class to handle deletion of job information

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + DeleteJobs +
  • +
+
+
+

Index

+
+
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Accessors

+
+ +

Static Private log

+ + +
+
+
+

Methods

+
+ +

Static deleteJob

+ +
    +
  • + +
    +
    +

    Cancel and purge a job

    +
    +
    +
    static
    +
    +
    memberof
    +

    DeleteJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobname: string
      +
      +

      job name to be translated into parms object

      +
      +
    • +
    • +
      jobid: string
      +
      +

      job id to be translated into parms object

      +
      +
    • +
    +

    Returns Promise<undefined | IJobFeedback>

    +
      +
    • promise of undefined, or IJobFeedback object returned by API if modifyVersion is 2.0
    • +
    +
  • +
+
+
+ +

Static deleteJobCommon

+ +
    +
  • + +
    +
    +

    Cancel and purge a job + Full version of the API with a parameter object

    +
    +
    +
    static
    +
    +
    memberof
    +

    DeleteJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      parms: IDeleteJobParms
      +
      +

      parm object (see IDeleteJobParms interface for details)

      +
      +
    • +
    +

    Returns Promise<undefined | IJobFeedback>

    +
      +
    • promise of undefined, or IJobFeedback object returned by API if modifyVersion is 2.0
    • +
    +
  • +
+
+
+ +

Static deleteJobForJob

+ +
    +
  • + +
    +
    +

    Cancel and purge a job + Alternative version of the delete API accepting an IJob object returned from other APIs such as GetJobs and SubmitJobs

    +
    +
    +
    static
    +
    +
    memberof
    +

    DeleteJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      job: IJob
      +
      +

      the job that you want to delete

      +
      +
    • +
    • +
      Optional modifyVersion: "1.0" | "2.0"
      +
      +

      version of the X-IBM-Job-Modify-Version header to use (see ZosmfHeaders)

      +
      +
    • +
    +

    Returns Promise<undefined | IJobFeedback>

    +
      +
    • promise of undefined, or IJobFeedback object returned by API if modifyVersion is 2.0
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.downloadjobs.html b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.downloadjobs.html new file mode 100644 index 0000000000..7230330be0 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.downloadjobs.html @@ -0,0 +1,697 @@ + + + + + + DownloadJobs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class DownloadJobs

+
+
+
+
+
+
+
+
+
+

Class to handle downloading of job information

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + DownloadJobs +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly DEFAULT_JOBS_OUTPUT_DIR

+
DEFAULT_JOBS_OUTPUT_DIR: string = "./output"
+ +
+
+

Default directory where output will be placed

+
+
+
static
+
+
memberof
+

DownloadJobs

+
+
+
+
+
+ +

Static Readonly DEFAULT_JOBS_OUTPUT_FILE_EXT

+
DEFAULT_JOBS_OUTPUT_FILE_EXT: string = ".txt"
+ +
+
+

Default extension of downloaded folders

+
+
+
static
+
+
memberof
+

DownloadJobs

+
+
+
+
+
+
+

Accessors

+
+ +

Static Private log

+ + +
+
+
+

Methods

+
+ +

Static downloadAllSpoolContentCommon

+ + +
+
+ +

Static downloadSpoolContent

+ + +
+
+ +

Static downloadSpoolContentCommon

+ + +
+
+ +

Static getSpoolDownloadFile

+
    +
  • getSpoolDownloadFile(jobFile: IJobFile, omitJobidDirectory?: boolean, outDir?: string): string
  • +
+
    +
  • + +
    +
    +

    Get the file where a specified spool file (IJobFile) would be downloaded to

    +
    +
    +
    deprecated
    +

    Use getSpoolDownloadFilePath instead

    +
    +
    static
    +
    +
    memberof
    +

    DownloadJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      jobFile: IJobFile
      +
      +

      the spool file that would be downloaded

      +
      +
    • +
    • +
      Optional omitJobidDirectory: boolean
      +
      +

      if true, the job ID of the jobFile will not be included in the file path

      +
      +
    • +
    • +
      Default value outDir: string = DownloadJobs.DEFAULT_JOBS_OUTPUT_DIR
      +
      +

      parent output directory you would like to download to

      +
      +
    • +
    +

    Returns string

    +

    the file path that the spool file would be downloaded to

    +
  • +
+
+
+ +

Static getSpoolDownloadFilePath

+ +
    +
  • + +
    +
    +

    Get the file where a specified spool file (IJobFile) would be downloaded to

    +
    +
    +
    static
    +
    +
    memberof
    +

    DownloadJobs

    +
    +
    +
    +

    Parameters

    + +

    Returns string

    +

    the file path that the spool file would be downloaded to

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html new file mode 100644 index 0000000000..4aea13bdcc --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.getjobs.html @@ -0,0 +1,1387 @@ + + + + + + GetJobs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class GetJobs

+
+
+
+
+
+
+
+
+
+

Class to handle obtaining of z/OS batch job information

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + GetJobs +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static Private filterResultsByStatuses

+ + +
+
+ +

Static getJcl

+ +
    +
  • + +
    +
    +

    Get JCL from a job.

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobname: string
      +
      +

      the job name for the job for which you want to retrieve JCL

      +
      +
    • +
    • +
      jobid: string
      +
      +

      the job ID for the job for which you want to retrieve JCL

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • job document on resolve
    • +
    +
  • +
+
+
+ +

Static getJclCommon

+ + +
+
+ +

Static getJclForJob

+ +
    +
  • + +
    +
    +

    Get JCL from a job. + Alternate version of the API that accepts an IJob object returned by + other APIs such as SubmitJobs.

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      job: IJob
      +
      +

      the job for which you would like to retrieve JCL

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • promise that resolves to JCL content
    • +
    +
  • +
+
+
+ +

Static getJob

+ +
    +
  • + +
    +
    +

    Get a single job object from an input job id

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobid: string
      +
      +

      the job ID for the job for which you want to get status

      +
      +
    • +
    +

    Returns Promise<IJob>

    +
      +
    • promise that resolves to an IJob object from an input jobid
    • +
    +
  • +
+
+
+ +

Static getJobs

+ +
    +
  • + +
    +
    +

    Get jobs (defaults to the user ID of the session as owner)

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    + +

    Returns Promise<IJob[]>

    +
      +
    • promise that resolves to an array of IJob objects (matching jobs)
    • +
    +
  • +
+
+
+ +

Static getJobsByOwner

+ +
    +
  • + +
    +
    +

    Get jobs that are owned by a certain user or pattern of users

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      owner: string
      +
      +

      owner for which to get jobs. Supports wildcard e.g. IBMU* returns jobs owned by + all users whose ID beings with "IBMU"

      +
      +
    • +
    +

    Returns Promise<IJob[]>

    +
      +
    • promise that resolves to an array of IJob objects (matching jobs)
    • +
    +
  • +
+
+
+ +

Static getJobsByOwnerAndPrefix

+ +
    +
  • + +
    +
    +

    Get a list of jobs that match an owner and prefix

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      owner: string
      +
      +

      owner for which to get jobs. Supports wildcard e.g. IBMU* returns jobs owned by + all users whose ID beings with "IBMU"

      +
      +
    • +
    • +
      prefix: string
      +
      +

      prefix for which to get jobs. Supports wildcard e.g. JOBNM* + returns jobs with names starting with "JOBNM"

      +
      +
    • +
    +

    Returns Promise<IJob[]>

    +
      +
    • promise that resolves to an array of IJob objects (matching jobs)
    • +
    +
  • +
+
+
+ +

Static getJobsByParameters

+ + +
+
+ +

Static getJobsByPrefix

+ +
    +
  • + +
    +
    +

    Get jobs that match a job name preixl + Defaults to jobs owned by the user ID in the session.

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      prefix: string
      +
      +

      job name prefix for which to list jobs. Supports wildcard e.g. JOBNM* + returns jobs with names starting with "JOBNM"

      +
      +
    • +
    +

    Returns Promise<IJob[]>

    +
      +
    • promise that resolves to an array of IJob objects (matching jobs)
    • +
    +
  • +
+
+
+ +

Static getJobsCommon

+ +
    +
  • + +
    +
    +

    Get jobs filtered by owner and prefix.

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      Optional params: IGetJobsParms
      +
      +

      parm object (see IGetJobsParms interface for details)

      +
      +
    • +
    +

    Returns Promise<IJob[]>

    +
      +
    • promise that resolves to an array of IJob objects (matching jobs)
    • +
    +
  • +
+
+
+ +

Static getSpoolContent

+ +
    +
  • + +
    +
    +

    Get spool content from a job (keeping naming convention patter with this duplication function).

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobFile: IJobFile
      +
      +

      the spool file for which you want to retrieve the content

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • promise that resolves to the spool content
    • +
    +
  • +
+
+
+ +

Static getSpoolContentById

+
    +
  • getSpoolContentById(session: AbstractSession, jobname: string, jobid: string, spoolId: number): Promise<any>
  • +
+
    +
  • + +
    +
    +

    Get spool content from a job using the job name, job ID, and spool ID number from z/OSMF

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobname: string
      +
      +

      the job name for the job containing the spool content

      +
      +
    • +
    • +
      jobid: string
      +
      +

      the job id for the job containing the spool content

      +
      +
    • +
    • +
      spoolId: number
      +
      +

      id number assigned by zosmf that identifies the particular job spool file (DD)

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • promise that resolves to the spool content
    • +
    +
  • +
+
+
+ +

Static getSpoolContentCommon

+ +
    +
  • + +
    +
    +

    Get spool content from a job.

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobFile: IJobFile
      +
      +

      the spool file for which you want to retrieve the content

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • promise that resolves to the spool content
    • +
    +
  • +
+
+
+ +

Static getSpoolFiles

+ +
    +
  • + +
    +
    +

    Get a list of all spool files for a job.

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobname: string
      +
      +

      the job name for the job for which you want to get a list of spool files

      +
      +
    • +
    • +
      jobid: string
      +
      +

      the job ID for the job for which you want to get a list of spool files

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • promise that resolves to an array of IJobFile objects
    • +
    +
  • +
+
+
+ +

Static getSpoolFilesCommon

+ + +
+
+ +

Static getSpoolFilesForJob

+ +
    +
  • + +
    +
    +

    Get a list of all job spool files for a job + Alternate version of the API that accepts an IJob object returned by + other APIs such as SubmitJobs.

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      job: IJob
      +
      +

      the job for which you would like to get a list of job spool files

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • promise that resolves to an array of IJobFile objects
    • +
    +
  • +
+
+
+ +

Static getStatus

+ +
    +
  • + +
    +
    +

    Get the status and other details (e.g. owner, return code) for a job

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobname: string
      +
      +

      the job name for the job for which you want to get status

      +
      +
    • +
    • +
      jobid: string
      +
      +

      the job ID for the job for which you want to get status

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • promise that resolves to an IJob object representing the job
    • +
    +
  • +
+
+
+ +

Static getStatusCommon

+ +
    +
  • + +
    +
    +

    Get the status and other details (e.g. owner, return code) for a job

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      parms: ICommonJobParms
      +
      +

      parm object (see ICommonJobParms interface for details)

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • promise that resolves to an IJob object representing the job
    • +
    +
  • +
+
+
+ +

Static getStatusForJob

+ +
    +
  • + +
    +
    +

    Get the status and other details (e.g. owner, return code) for a job + Alternate version of the API that accepts an IJob object returned by + other APIs such as SubmitJobs. Even though the parameter and return + value are of the same type, the IJob object returned will have the + current status of the job.

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      job: IJob
      +
      +

      job object

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • promise that resolves to an IJob object representing the job
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html new file mode 100644 index 0000000000..d65ef422fc --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.jobsconstants.html @@ -0,0 +1,868 @@ + + + + + + JobsConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class JobsConstants

+
+
+
+
+
+
+
+
+
+

Constants for various job related info

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + JobsConstants +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly COMBO_ID

+
COMBO_ID: string = "&"
+ +
+
+

Query parm delimiter

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly DEFAULT_CANCEL_VERSION

+
DEFAULT_CANCEL_VERSION: "2.0" = "2.0"
+ +
+
+

Default version of cancel

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly DEFAULT_MAX_JOBS

+
DEFAULT_MAX_JOBS: number = 1000
+ +
+
+

Maximum number of jobs to obtain

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly DEFAULT_PREFIX

+
DEFAULT_PREFIX: string = "*"
+ +
+
+

Wildcard prefix

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly DEFAULT_STATUS

+
DEFAULT_STATUS: string = "*"
+ +
+
+

Maximum number of jobs to obtain

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly EXEC_DATA

+
EXEC_DATA: string = "exec-data=Y"
+ +
+
+

Execution data query string

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly QUERY_ID

+
QUERY_ID: string = "?"
+ +
+
+

Query identifier

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly QUERY_JOBID

+
QUERY_JOBID: string = "jobid="
+ +
+
+

Query id for getting a specific job id

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly QUERY_MAX_JOBS

+
QUERY_MAX_JOBS: string = "max-jobs="
+ +
+
+

Query id for getting max jobs

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly QUERY_OWNER

+
QUERY_OWNER: string = "owner="
+ +
+
+

Query id for getting job by an owner

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly QUERY_PREFIX

+
QUERY_PREFIX: string = "prefix="
+ +
+
+

Query id for getting a job by prefix

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly QUERY_STATUS

+
QUERY_STATUS: string = "status="
+ +
+
+

Query id for getting a specific job id

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly REQUEST_CANCEL

+
REQUEST_CANCEL: "cancel" = "cancel"
+ +
+
+

Cancel request constant

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly REQUEST_HOLD

+
REQUEST_HOLD: "hold" = "hold"
+ +
+
+

Hold a job

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly REQUEST_RELEASE

+
REQUEST_RELEASE: "release" = "release"
+ +
+
+

Release a job

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly RESOURCE

+
RESOURCE: string = "/zosmf/restjobs/jobs"
+ +
+
+

URI base jobs API

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly RESOURCE_JCL_CONTENT

+
RESOURCE_JCL_CONTENT: string = "/JCL"
+ +
+
+

URI endpoint for getting JCL

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly RESOURCE_SPOOL_CONTENT

+
RESOURCE_SPOOL_CONTENT: string = "/records"
+ +
+
+

URI endpoint for getting spool files

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly RESOURCE_SPOOL_FILES

+
RESOURCE_SPOOL_FILES: string = "/files"
+ +
+
+

URI endpoint for getting spool file content

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+ +

Static Readonly STEP_DATA

+
STEP_DATA: string = "step-data=Y"
+ +
+
+

Step data query string

+
+
+
static
+
+
memberof
+

JobsConstants

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.modifyjobs.html b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.modifyjobs.html new file mode 100644 index 0000000000..c1c0b5aac7 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.modifyjobs.html @@ -0,0 +1,494 @@ + + + + + + ModifyJobs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ModifyJobs

+
+
+
+
+
+
+
+
+
+

Class to handle modify of jobclass and holdStatus information

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ModifyJobs +
  • +
+
+
+

Index

+
+
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Accessors

+
+ +

Static Private log

+ + +
+
+
+

Methods

+
+ +

Static modifyJob

+ + +
+
+ +

Static modifyJobCommon

+ +
    +
  • + +
    +
    +

    Modify a job + Full version of the API with a parameter object

    +
    +
    +
    static
    +
    +
    memberof
    +

    ModifyJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      parms: IModifyJobParms
      +
      +

      parm object (see IModifyJobParms interface for details)

      +
      +
    • +
    • +
      options: IModifyJobOptions
      +
      +

      options object (see IModifyJobOptions interface for details)

      +
      +
    • +
    +

    Returns Promise<undefined | IJobFeedback>

    +
      +
    • promise of undefined, or IJobFeedback object returned by API if modifyVersion is 2.0
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html new file mode 100644 index 0000000000..3a8c8e9be3 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.monitorjobs.html @@ -0,0 +1,784 @@ + + + + + + MonitorJobs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class MonitorJobs

+
+
+
+
+
+
+
+
+
+

APIs for monitoring the status of a job. Use these APIs to wait for a job to enter the specified status. All APIs + in monitor jobs invoke z/OSMF jobs REST endpoints to obtain job status information.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + MonitorJobs +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly DEFAULT_ATTEMPTS

+
DEFAULT_ATTEMPTS: number = Infinity
+ +
+
+

Default number of poll attempts to check for the specified job status.

+
+
+
static
+
+
memberof
+

MonitorJobs

+
+
+
+
+
+ +

Static Readonly DEFAULT_STATUS

+
DEFAULT_STATUS: JOB_STATUS = JOB_STATUS.OUTPUT
+ +
+
+

Default expected job status ("OUTPUT")

+
+
+
static
+
+
memberof
+

MonitorJobs

+
+
+
+
+
+ +

Static Readonly DEFAULT_WATCH_DELAY

+
DEFAULT_WATCH_DELAY: 3000 = 3000
+ +
+
+

The default amount of time (in milliseconds) to wait until the next job status poll.

+
+
+
static
+
+
memberof
+

MonitorJobs

+
+
+
+
+
+ +

Static Private log

+
log: Logger = Logger.getAppLogger()
+ +
+
+

Obtain an instance of the app logger (Brightside).

+
+
+
static
+
+
memberof
+

MonitorJobs

+
+
+
+
+
+
+

Methods

+
+ +

Static Private checkStatus

+ +
    +
  • + +
    +
    +

    Checks the status of the job for the expected status (OR that the job has progressed passed the expected status).

    +
    +
    +
    static
    +
    +
    memberof
    +

    MonitorJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      the session to initiate the z/OSMF getJobStatus request

      +
      +
    • +
    • +
      parms: IMonitorJobWaitForParms
      +
      +

      the monitor jobs parameters containing the jobname, jobid, status, etc.

      +
      +
    • +
    +

    Returns Promise<[boolean, IJob]>

    +
      +
    • promise to fulfill when the job status is obtained (or imperative error)
    • +
    +
  • +
+
+
+ +

Static Private constructErrorMsg

+ +
    +
  • + +
    +
    +

    Constructs the default error message (to be thrown via ImperativeError) for the monitor jobs APIs

    +
    +
    +
    static
    +
    +
    memberof
    +

    MonitorJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      parms: IMonitorJobWaitForParms
      +
      +

      The parameters passed to the API

      +
      +
    • +
    • +
      details: string
      +
      +

      Additional error details string

      +
      +
    • +
    +

    Returns string

    +
      +
    • The error string to be thrown via ImperativeError
    • +
    +
  • +
+
+
+ +

Static Private pollForStatus

+ + +
+
+ +

Static waitForJobOutputStatus

+ +
    +
  • + +
    +
    +

    Given an IJob (has jobname/jobid), waits for the status of the job to be "OUTPUT". This API will poll for + the OUTPUT status once every 3 seconds indefinitely. If the polling interval/duration is NOT sufficient, use + "waitForStatusCommon" to adjust.

    +
    +

    See JSDoc for "waitForStatusCommon" for full details on polling and other logic.

    +
    +
    static
    +
    +
    memberof
    +

    MonitorJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      a Rest client session for z/OSMF

      +
      +
    • +
    • +
      job: IJob
      +
      +

      the z/OS job to wait for (see z/OSMF Jobs APIs for details)

      +
      +
    • +
    +

    Returns Promise<IJob>

    +
      +
    • the promise to be fulfilled with IJob object (or rejected with an ImperativeError)
    • +
    +
  • +
+
+
+ +

Static waitForOutputStatus

+ +
    +
  • + +
    +
    +

    Given the jobname/jobid, waits for the status of the job to be "OUTPUT". This API will poll for the OUTPUT status + once every 3 seconds indefinitely. If the polling interval/duration is NOT sufficient, use + "waitForStatusCommon" to adjust.

    +
    +

    See JSDoc for "waitForStatusCommon" for full details on polling and other logic.

    +
    +
    static
    +
    +
    memberof
    +

    MonitorJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      a Rest client session for z/OSMF

      +
      +
    • +
    • +
      jobname: string
      +
      +

      the z/OS jobname of the job to wait for output status (see z/OSMF Jobs APIs for details)

      +
      +
    • +
    • +
      jobid: string
      +
      +

      the z/OS jobid of the job to wait for output status (see z/OSMF Jobs APIS for details)

      +
      +
    • +
    +

    Returns Promise<IJob>

    +
      +
    • the promise to be fulfilled with IJob object (or rejected with an ImperativeError)
    • +
    +
  • +
+
+
+ +

Static waitForStatusCommon

+ +
    +
  • + +
    +
    +

    Given jobname/jobid, checks for the desired "status" (default is "OUTPUT") continuously (based on the interval + and attempts specified).

    +
    +

    The "order" of natural job status is INPUT > ACTIVE > OUTPUT. If the requested status is earlier in the sequence + than the current status of the job, then the method returns immediately (since the job will never enter the + requested status) with the current status of the job.

    +
    +
    static
    +
    +
    memberof
    +

    MonitorJobs

    +
    +
    +
    +

    Parameters

    + +

    Returns Promise<IJob>

    +
      +
    • the promise to be fulfilled with IJob object (or rejected with an ImperativeError)
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html new file mode 100644 index 0000000000..533410af2f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_jobs_for_zowe_sdk.submitjobs.html @@ -0,0 +1,1200 @@ + + + + + + SubmitJobs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SubmitJobs

+
+
+
+
+
+
+
+
+
+

Class to handle submitting of z/OS batch jobs via z/OSMF

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + SubmitJobs +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Private Readonly singleQuote

+
singleQuote: "'" = "'"
+ +
+
+
+

Accessors

+
+ +

Static Private log

+ + +
+
+
+

Methods

+
+ +

Static checkSubmitOptions

+ + +
+
+ +

Static Private formSubstitutionHeader

+
    +
  • formSubstitutionHeader(symName: string, symDefs: string, valStartInx: number, valEndInx: number): IHeaderContent
  • +
+
    +
  • + +
    +
    +

    Form a header used for JCL symbol substitution

    +
    +
    +
    memberof
    +

    SubmitJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      symName: string
      +
      +
      The name of the JCL substitution symbol
      +
      +
      +
    • +
    • +
      symDefs: string
      +
      +
        The CLI argument that contains all of the JCL substitution symbol definitions
      +
      +
      +
    • +
    • +
      valStartInx: number
      +
      +
        Index into symDefs to the start of the value for symName.
      +
      +
      +
    • +
    • +
      valEndInx: number
      +
      +
        Index into symDefs that is one past the end of the value for symName.
      +
      +
      +
    • +
    +

    Returns IHeaderContent

    +
     Header to add to our set of headers
    +
    +
  • +
+
+
+ +

Static Private getSubstitutionHeaders

+ + +
+
+ +

Static submitJcl

+
    +
  • submitJcl(session: AbstractSession, jcl: string, internalReaderRecfm?: string, internalReaderLrecl?: string): Promise<any>
  • +
+
    +
  • + +
    +
    +

    Submit a string of JCL to run

    +
    +
    +
    static
    +
    +
    memberof
    +

    SubmitJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jcl: string
      +
      +

      string of JCL that you want to be submit

      +
      +
    • +
    • +
      Optional internalReaderRecfm: string
      +
      +

      record format of the jcl you want to submit. "F" (fixed) or "V" (variable)

      +
      +
    • +
    • +
      Optional internalReaderLrecl: string
      +
      +

      logical record length of the jcl you want to submit

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • Promise that resolves to an IJob document with details about the submitted job
    • +
    +
  • +
+
+
+ +

Static submitJclCommon

+ + +
+
+ +

Static submitJclNotify

+
    +
  • submitJclNotify(session: AbstractSession, jcl: string, internalReaderRecfm?: string, internalReaderLrecl?: string): Promise<IJob>
  • +
+
    +
  • + +
    +
    +

    Submit a JCL string to run

    +
    +
    +
    static
    +
    +
    memberof
    +

    SubmitJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jcl: string
      +
      +

      string of JCL that you want to be submit

      +
      +
    • +
    • +
      Optional internalReaderRecfm: string
      +
      +

      record format of the jcl you want to submit. "F" (fixed) or "V" (variable).

      +
      +
    • +
    • +
      Optional internalReaderLrecl: string
      +
      +

      logical record length of the jcl you want to submit

      +
      +
    • +
    +

    Returns Promise<IJob>

    +
      +
    • Promise that resolves to an IJob document with details about the submitted job
    • +
    +
  • +
+
+
+ +

Static submitJclNotifyCommon

+ +
    +
  • + +
    +
    +

    Submit a job from a string of JCL and be notified whenever it reaches the default status on a default polling interval.

    +
    +
    +
    static
    +
    +
    memberof
    +

    SubmitJobs

    +
    +
    +
    +

    Parameters

    + +

    Returns Promise<IJob>

    +
      +
    • Promise that resolves to an IJob document with details about the submitted job
    • +
    +
  • +
+
+
+ +

Static submitJclString

+ + +
+
+ +

Static submitJob

+ +
    +
  • + +
    +
    +

    Submit a job that resides in a z/OS data set.

    +
    +
    +
    static
    +
    +
    memberof
    +

    SubmitJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobDataSet: string
      +
      +

      job data set to be translated into parms object

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • Promise that resolves to an IJob document with details about the submitted job
    • +
    +
  • +
+
+
+ +

Static submitJobCommon

+ + +
+
+ +

Static submitJobNotify

+ +
    +
  • + +
    +
    +

    Submit a job and be notified whenever it reaches the default status on a default polling interval.

    +
    +
    +
    static
    +
    +
    memberof
    +

    SubmitJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobDataSet: string
      +
      +

      job data set to be translated into parms object with assumed defaults

      +
      +
    • +
    +

    Returns Promise<IJob>

    +
      +
    • Promise that resolves to an IJob document with details about the submitted job
    • +
    +
  • +
+
+
+ +

Static submitJobNotifyCommon

+ +
    +
  • + +
    +
    +

    Submit a job from a data set and be notified whenever it reaches a certain status. + If not status is specified, MonitorJobs.DEFAULT_STATUS is assumed. + The polling interval can also be optionally controlled via parms.watchDelay. + If not specified, the default polling is MonitorJobs.DEFAULT_WATCH_DELAY.

    +
    +
    +
    static
    +
    +
    memberof
    +

    SubmitJobs

    +
    +
    +
    +

    Parameters

    + +

    Returns Promise<IJob>

    +
      +
    • Promise that resolves to an IJob document with details about the submitted job
    • +
    +
  • +
+
+
+ +

Static Private submitNotifyCommon

+ +
    +
  • + +
    +
    +

    Common method to watch for a job to reach a certain status whether the job was + submitted through raw JCL statement or through a data set containing JCL.

    +
    +
    +
    static
    +
    +
    memberof
    +

    SubmitJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      job: IJob
      +
      +

      job document for a previously submitted job

      +
      +
    • +
    • +
      status: JOB_STATUS
      +
      +

      status that we want this job to reach before notifying

      +
      +
    • +
    • +
      watchDelay: number
      +
      +

      delay / interval to poll

      +
      +
    • +
    +

    Returns Promise<IJob>

    +
      +
    • Promise that resolves to an IJob document with details about the submitted job
    • +
    +
  • +
+
+
+ +

Static submitUSSJob

+ +
    +
  • + +
    +
    +

    Submit a job that resides in a USS File.

    +
    +
    +
    static
    +
    +
    memberof
    +

    SubmitJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobUSSFile: string
      +
      +

      job USS File to be translated into parms object

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • Promise that resolves to an IJob document with details about the submitted job
    • +
    +
  • +
+
+
+ +

Static submitUSSJobNotify

+ +
    +
  • + +
    +
    +

    Submit a job and be notified whenever it reaches the default status on a default polling interval.

    +
    +
    +
    static
    +
    +
    memberof
    +

    SubmitJobs

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      jobUSSFile: string
      +
      +

      job USS file to be translated into parms object with assumed defaults

      +
      +
    • +
    +

    Returns Promise<IJob>

    +
      +
    • Promise that resolves to an IJob document with details about the submitted job
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_logs_for_zowe_sdk.getzoslog.html b/static/v2.15.x/typedoc/classes/_zowe_zos_logs_for_zowe_sdk.getzoslog.html new file mode 100644 index 0000000000..6de90872c6 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_logs_for_zowe_sdk.getzoslog.html @@ -0,0 +1,341 @@ + + + + + + GetZosLog | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class GetZosLog

+
+
+
+
+
+
+
+
+
+

Get zos log via z/OSMF restful api

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + GetZosLog +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static getResourcePath

+ +
    +
  • + +
    +
    +

    Get resource path for z/OSMF log restful api

    +
    +
    +
    static
    +
    +
    memberof
    +

    GetCommand

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      commandParms: IZosLogParms
      +
      +

      params to compose the resource path

      +
      +
    • +
    +

    Returns string

    +

    resource path

    +
  • +
+
+
+ +

Static getZosLog

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_logs_for_zowe_sdk.getzoslogvalidator.html b/static/v2.15.x/typedoc/classes/_zowe_zos_logs_for_zowe_sdk.getzoslogvalidator.html new file mode 100644 index 0000000000..981fae82b1 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_logs_for_zowe_sdk.getzoslogvalidator.html @@ -0,0 +1,291 @@ + + + + + + GetZosLogValidator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class GetZosLogValidator

+
+
+
+
+
+
+
+
+
+

Class validates parameters for GetZosLog

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + GetZosLogValidator +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static validateSession

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_logs_for_zowe_sdk.zoslogconstants.html b/static/v2.15.x/typedoc/classes/_zowe_zos_logs_for_zowe_sdk.zoslogconstants.html new file mode 100644 index 0000000000..d30ccbcf58 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_logs_for_zowe_sdk.zoslogconstants.html @@ -0,0 +1,252 @@ + + + + + + ZosLogConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ZosLogConstants

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.issuetso.html b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.issuetso.html new file mode 100644 index 0000000000..a62416c68b --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.issuetso.html @@ -0,0 +1,442 @@ + + + + + + IssueTso | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class IssueTso

+
+
+
+
+
+
+
+
+
+

Class to handle issue command to TSO

+
+
+
+
+

Hierarchy

+
    +
  • + IssueTso +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static issueTsoCommand

+ +
    +
  • + +
    +
    +

    API method to start a TSO address space, issue a command, collect responses until prompt is reached, and terminate the address space.

    +
    +
    +
    memberof
    +

    IssueTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      accountNumber: string
      +
      +

      accounting info for Jobs

      +
      +
    • +
    • +
      command: string
      +
      +

      command text to issue to the TSO address space.

      +
      +
    • +
    • +
      Optional startParams: IStartTsoParms
      +
      +

      optional object with required parameters for starting TSO address space, @see {IStartTsoParms}

      +
      +
    • +
    +

    Returns Promise<IIssueResponse>

    +

    IssueTso response object, @see {IIssueResponse}

    +
  • +
+
+
+ +

Static issueTsoCommandCommon

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.pingtso.html b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.pingtso.html new file mode 100644 index 0000000000..d070e3c754 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.pingtso.html @@ -0,0 +1,425 @@ + + + + + + PingTso | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class PingTso

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + PingTso +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static getResource

+
    +
  • getResource(servletKey: string): string
  • +
+
    +
  • + +
    +
    +

    Get resource path for ping command

    +
    +
    +
    static
    +
    +
    memberof
    +

    PingTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      servletKey: string
      +
      +

      servelet key from start API method

      +
      +
    • +
    +

    Returns string

    +

    resource path

    +
  • +
+
+
+ +

Static ping

+ +
    +
  • + +
    +
    +

    Issue a TSO Ping command, returns @param {IPingResponse} result, @see {IPingResponse}

    +
    +
    +
    static
    +
    +
    memberof
    +

    PingTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      servletKey: string
      +
      +

      servletkey for address space to ping, generated by start command

      +
      +
    • +
    +

    Returns Promise<IPingResponse>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.sendtso.html b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.sendtso.html new file mode 100644 index 0000000000..986164c161 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.sendtso.html @@ -0,0 +1,590 @@ + + + + + + SendTso | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SendTso

+
+
+
+
+
+
+
+
+
+

Class to handle sending data to TSO

+
+
+
+
+

Hierarchy

+
    +
  • + SendTso +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static Private createResponse

+ +
    +
  • + +
    +
    +

    Creates ISendResponse object and fills with data

    +
    +
    +
    memberof
    +

    SendTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      allResponses: IZosmfTsoResponse[]
      +
      +

      array of all collected responses

      +
      +
    • +
    • +
      messages: string
      +
      +

      concatenated messages from responses

      +
      +
    • +
    +

    Returns ISendResponse

    +
      +
    • SendTso response object, @see {ISendResponse}
    • +
    +
  • +
+
+
+ +

Static getAllResponses

+ + +
+
+ +

Static getDataFromTSO

+ +
    +
  • + +
    +
    +

    API method is used to get response data from a TSO address space.

    +
    +
    +
    memberof
    +

    SendTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      servletKey: string
      +
      +

      servlet key of address space

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • z/OSMF response object, @see {IZosmfTsoResponse}
    • +
    +
  • +
+
+
+ +

Static sendDataToTSOCollect

+ +
    +
  • + +
    +
    +

    API method to send data to already started TSO address space, but will read TSO data until a PROMPT is reached.

    +
    +
    +
    memberof
    +

    SendTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      servletKey: string
      +
      +

      servlet key returned from a successful start

      +
      +
    • +
    • +
      data: string
      +
      +

      data to send to the TSO address space.

      +
      +
    • +
    +

    Returns Promise<ISendResponse>

    +

    SendTso response object, @see {ISendResponse}

    +
  • +
+
+
+ +

Static sendDataToTSOCommon

+ +
    +
  • + +
    +
    +

    API method to send data to already started TSO address space

    +
    +
    +
    memberof
    +

    SendTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      commandParams: ISendTsoParms
      +
      +

      object with required parameters, @see {ISendTsoParms}

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • z/OSMF response object, @see {IZosmfTsoResponse}
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.starttso.html b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.starttso.html new file mode 100644 index 0000000000..963f929c72 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.starttso.html @@ -0,0 +1,540 @@ + + + + + + StartTso | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class StartTso

+
+
+
+
+
+
+
+
+
+

Start TSO address space and receive servlet key

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + StartTso +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static getResourcesQuery

+ +
    +
  • + +
    +
    +

    Builds a resources query from passed parameters which is needed for z/OSMF api URI.

    +
    +
    +
    memberof
    +

    StartTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      parms: IStartTsoParms
      +
      +

      object with required parameters, @see {IStartTsoParms}

      +
      +
    • +
    +

    Returns string

    +

    URI for z/OSMF REST call

    +
  • +
+
+
+ +

Static setDefaultAddressSpaceParams

+ +
    +
  • + +
    +
    +

    Sets required parameters by default if not provided. If some parameters provided + it uses received and the rest required parameters will be default

    +
    +
    +
    static
    +
    +
    memberof
    +

    StartTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      parms: IStartTsoParms
      +
      +

      object with required parameters, @see {IStartTsoParms}

      +
      +
    • +
    • +
      accountNumber: string
      +
      +

      this key of IStartTsoParms required, because it cannot be default.

      +
      +
    • +
    +

    Returns IStartTsoParms

    +

    object with provided parameters if not the with default

    +
  • +
+
+
+ +

Static start

+ +
    +
  • + +
    +
    +

    Start TSO address space with provided parameters.

    +
    +
    +
    static
    +
    +
    memberof
    +

    StartTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      accountNumber: string
      +
      +

      this key of IStartTsoParms required, because it cannot be default.

      +
      +
    • +
    • +
      Optional parms: IStartTsoParms
      +
      +

      optional object with required parameters, @see {IStartTsoParms}

      +
      +
    • +
    +

    Returns Promise<IStartStopResponses>

    +

    command response on resolve, @see {IStartStopResponses}

    +
  • +
+
+
+ +

Static startCommon

+ +
    +
  • + +
    +
    +

    Start TSO address space with provided parameters

    +
    +
    +
    static
    +
    +
    memberof
    +

    StartTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      commandParms: IStartTsoParms
      +
      +

      object with required parameters, @see {IStartTsoParms}

      +
      +
    • +
    +

    Returns any

    +

    z/OSMF response object, @see {IZosmfTsoResponse}

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.stoptso.html b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.stoptso.html new file mode 100644 index 0000000000..42f0a1f130 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.stoptso.html @@ -0,0 +1,477 @@ + + + + + + StopTso | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class StopTso

+
+
+
+
+
+
+
+
+
+

Stop active TSO address space using servlet key

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + StopTso +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static getResources

+
    +
  • getResources(servletKey: string): string
  • +
+
    +
  • + +
    +
    +

    Generates query parameter needed for z/OSMF REST call

    +
    +
    +
    memberof
    +

    StopTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      servletKey: string
      +
      +

      unique servlet entry identifier

      +
      +
    • +
    +

    Returns string

    +

    generated resources query

    +
  • +
+
+
+ +

Static stop

+ + +
+
+ +

Static stopCommon

+ +
    +
  • + +
    +
    +

    Sends REST call to z/OSMF for stoping active TSO address space

    +
    +
    +
    memberof
    +

    StopTso

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      commandParms: IStopTsoParms
      +
      +

      object with required parameters, @see {IStopTsoParms}

      +
      +
    • +
    +

    Returns Promise<any>

    +

    z/OSMF response object, @see {IZosmfTsoResponse}

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html new file mode 100644 index 0000000000..f0db86f713 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.tsoconstants.html @@ -0,0 +1,839 @@ + + + + + + TsoConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class TsoConstants

+
+
+
+
+
+
+
+
+
+

Constants for TSO related info

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + TsoConstants +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly DEFAULT_CHSET

+
DEFAULT_CHSET: string = "697"
+ +
+
+

Default character-set value

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly DEFAULT_COLS

+
DEFAULT_COLS: string = "80"
+ +
+
+

Default number of columns value

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly DEFAULT_CPAGE

+
DEFAULT_CPAGE: string = "1047"
+ +
+
+

Default code page value

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly DEFAULT_PROC

+
DEFAULT_PROC: string = "IZUFPROC"
+ +
+
+

Default logonProcedure value

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly DEFAULT_ROWS

+
DEFAULT_ROWS: string = "24"
+ +
+
+

Default number of rows value

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly DEFAULT_RSIZE

+
DEFAULT_RSIZE: string = "4096"
+ +
+
+

Default region-size value

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly PARM_ACCT

+
PARM_ACCT: string = "acct"
+ +
+
+

Quert id of account number passed to z/OSMF URI

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly PARM_CHSET

+
PARM_CHSET: string = "chset"
+ +
+
+

Quert id of character-set passed to z/OSMF URI

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly PARM_COLS

+
PARM_COLS: string = "cols"
+ +
+
+

Quert id of columns passed to z/OSMF URI

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly PARM_CPAGE

+
PARM_CPAGE: string = "cpage"
+ +
+
+

Quert id of code page passed to z/OSMF URI

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly PARM_PROC

+
PARM_PROC: string = "proc"
+ +
+
+

Quert id of logonProcedure passed to z/OSMF URI

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly PARM_ROWS

+
PARM_ROWS: string = "rows"
+ +
+
+

Quert id of rows passed to z/OSMF URI

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly PARM_RSIZE

+
PARM_RSIZE: string = "rsize"
+ +
+
+

Quert id of region size passed to z/OSMF URI

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly RESOURCE

+
RESOURCE: string = "/zosmf/tsoApp"
+ +
+
+

URI base for TSO API

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly RES_DONT_READ_REPLY

+
RES_DONT_READ_REPLY: string = "?readReply=false"
+ +
+
+

Param for not reading reply

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly RES_PING

+
RES_PING: string = TsoConstants.RESOURCE + "/" + TsoConstants.RES_START_TSO + "/ping"
+ +
+
+

URI for TSO Ping API

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly RES_START_TSO

+
RES_START_TSO: string = "tso"
+ +
+
+

URI for starting TSO

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly TSO_MESSAGE

+
TSO_MESSAGE: "TSO MESSAGE" = "TSO MESSAGE"
+ +
+
+

Tso response message type - message

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+ +

Static Readonly TSO_PROMPT

+
TSO_PROMPT: "TSO PROMPT" = "TSO PROMPT"
+ +
+
+

Tso response message type - prompt

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html new file mode 100644 index 0000000000..b0e449db33 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.tsoprofileconstants.html @@ -0,0 +1,902 @@ + + + + + + TsoProfileConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class TsoProfileConstants

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + TsoProfileConstants +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly TSO_OPTION_GROUP

+
TSO_OPTION_GROUP: string = "TSO ADDRESS SPACE OPTIONS"
+ +
+
+ +

Static Readonly TSO_PROFILE_OPTIONS

+
TSO_PROFILE_OPTIONS: ICommandOptionDefinition[] = [TsoProfileConstants.TSO_OPTION_ACCOUNT,TsoProfileConstants.TSO_OPTION_CHAR_SET,TsoProfileConstants.TSO_OPTION_CODE_PAGE,TsoProfileConstants.TSO_OPTION_COLUMNS,TsoProfileConstants.TSO_OPTION_LOGON_PROCEDURE,TsoProfileConstants.TSO_OPTION_REGION_SIZE,TsoProfileConstants.TSO_OPTION_ROWS]
+ +
+
+
+

Object literals

+
+ +

Static Readonly TSO_OPTION_ACCOUNT

+
TSO_OPTION_ACCOUNT: object
+ +
+ +

aliases

+
aliases: string[] = ["a"]
+ +
+
+ +

description

+
description: string = "Your z/OS TSO/E accounting information."
+ +
+
+ +

group

+
group: string = TsoProfileConstants.TSO_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "account"
+ +
+
+ +

required

+
required: boolean = true
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static Readonly TSO_OPTION_ACCOUNT_PROFILE

+
TSO_OPTION_ACCOUNT_PROFILE: object
+ +
+ +

required

+
required: boolean = false
+ +
+
+
+ +

Static Readonly TSO_OPTION_CHAR_SET

+
TSO_OPTION_CHAR_SET: object
+ +
+ +

aliases

+
aliases: string[] = ["cs"]
+ +
+
+ +

defaultValue

+
defaultValue: string = "697"
+ +
+
+ +

description

+
description: string = "Character set for address space to convert messages and responses from UTF-8 to EBCDIC."
+ +
+
+ +

group

+
group: string = TsoProfileConstants.TSO_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "character-set"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static Readonly TSO_OPTION_CODE_PAGE

+
TSO_OPTION_CODE_PAGE: object
+ +
+ +

aliases

+
aliases: string[] = ["cp"]
+ +
+
+ +

defaultValue

+
defaultValue: string = "1047"
+ +
+
+ +

description

+
description: string = "Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC."
+ +
+
+ +

group

+
group: string = TsoProfileConstants.TSO_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "code-page"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static Readonly TSO_OPTION_COLUMNS

+
TSO_OPTION_COLUMNS: object
+ +
+ +

aliases

+
aliases: string[] = ["cols"]
+ +
+
+ +

defaultValue

+
defaultValue: number = 80
+ +
+
+ +

description

+
description: string = "The number of columns on a screen."
+ +
+
+ +

group

+
group: string = TsoProfileConstants.TSO_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "columns"
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

Static Readonly TSO_OPTION_LOGON_PROCEDURE

+
TSO_OPTION_LOGON_PROCEDURE: object
+ +
+ +

aliases

+
aliases: string[] = ["l"]
+ +
+
+ +

defaultValue

+
defaultValue: string = "IZUFPROC"
+ +
+
+ +

description

+
description: string = "The logon procedure to use when creating TSO procedures on your behalf."
+ +
+
+ +

group

+
group: string = TsoProfileConstants.TSO_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "logon-procedure"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static Readonly TSO_OPTION_REGION_SIZE

+
TSO_OPTION_REGION_SIZE: object
+ +
+ +

aliases

+
aliases: string[] = ["rs"]
+ +
+
+ +

defaultValue

+
defaultValue: number = 4096
+ +
+
+ +

description

+
description: string = "Region size for the TSO/E address space."
+ +
+
+ +

group

+
group: string = TsoProfileConstants.TSO_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "region-size"
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

Static Readonly TSO_OPTION_ROWS

+
TSO_OPTION_ROWS: object
+ +
+ +

defaultValue

+
defaultValue: number = 24
+ +
+
+ +

description

+
description: string = "The number of rows on a screen."
+ +
+
+ +

group

+
group: string = TsoProfileConstants.TSO_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "rows"
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.tsoresponseservice.html b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.tsoresponseservice.html new file mode 100644 index 0000000000..0b7d36f186 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.tsoresponseservice.html @@ -0,0 +1,474 @@ + + + + + + TsoResponseService | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class TsoResponseService

+
+
+
+
+
+
+
+
+
+

Filter responses from z/OSMF

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + TsoResponseService +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static populatePing

+ + +
+
+ +

Static populateStartAndStop

+ + +
+
+ +

Static populateStartAndStopCollectAll

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html new file mode 100644 index 0000000000..b3f01efe67 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.tsovalidator.html @@ -0,0 +1,777 @@ + + + + + + TsoValidator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class TsoValidator

+
+
+
+
+
+
+
+
+
+

Class validates parameters for TSO commands

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + TsoValidator +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static validateErrorMessageFromZosmf

+ + +
+
+ +

Static validateIssueParams

+ + +
+
+ +

Static validateNotEmptyString

+
    +
  • validateNotEmptyString(text: string, errorMsg: string): void
  • +
+
    +
  • + +
    +
    +

    Validate supplied parameters

    +
    +
    +
    static
    +
    +
    memberof
    +

    TsoValidator

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      text: string
      +
      +

      string to check if empty

      +
      +
    • +
    • +
      errorMsg: string
      +
      +

      message to show in text case validation fails

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static validatePingParms

+
    +
  • validatePingParms(session: AbstractSession, text: string, errorMsg: string): void
  • +
+
    +
  • + +
    +
    +

    Validate supplied parameters

    +
    +
    +
    static
    +
    +
    memberof
    +

    TsoValidator

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      representing connection to this api

      +
      +
    • +
    • +
      text: string
      +
      +

      string to check if not empty or undefined

      +
      +
    • +
    • +
      errorMsg: string
      +
      +

      message to show in text case validation fails

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static validatePingZosmfResponse

+ + +
+
+ +

Static validateSession

+ + +
+
+ +

Static validateStartParams

+ + +
+
+ +

Static validateStartZosmfResponse

+ + +
+
+ +

Static validateStopParams

+ + +
+
+ +

Static validateString

+
    +
  • validateString(text: string, errorMsg: string): void
  • +
+
    +
  • + +
    +
    +

    Validate supplied parameters

    +
    +
    +
    static
    +
    +
    memberof
    +

    TsoValidator

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      text: string
      +
      +

      string to check if not null or undefined

      +
      +
    • +
    • +
      errorMsg: string
      +
      +

      message to show in text case validation fails

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.zostsobasehandler.html b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.zostsobasehandler.html new file mode 100644 index 0000000000..c8e7ed600c --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_tso_for_zowe_sdk.zostsobasehandler.html @@ -0,0 +1,404 @@ + + + + + + ZosTsoBaseHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ZosTsoBaseHandler

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + any +
      +
    • + ZosTsoBaseHandler +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Protected mTsoStart

+
mTsoStart: IStartTsoParms
+ +
+
+

The parameter object required to issue start commands

+
+
+
+
+
+

Methods

+
+ +

process

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_uss_for_zowe_sdk.shell.html b/static/v2.15.x/typedoc/classes/_zowe_zos_uss_for_zowe_sdk.shell.html new file mode 100644 index 0000000000..6ad2fecb3f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_uss_for_zowe_sdk.shell.html @@ -0,0 +1,421 @@ + + + + + + Shell | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Shell

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Shell +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Static Readonly connRefusedFlag

+
connRefusedFlag: "ECONNREFUSED" = "ECONNREFUSED"
+ +
+
+ +

Static Readonly expiredPasswordFlag

+
expiredPasswordFlag: "FOTS1668" = "FOTS1668"
+ +
+
+ +

Static Readonly startCmdFlag

+
startCmdFlag: "@@START OF COMMAND@@" = "@@START OF COMMAND@@"
+ +
+
+
+

Methods

+
+ +

Static Private authenticationHandler

+
    +
  • authenticationHandler(authsAllowed: string[]): (Anonymous function)
  • +
+ +
+
+ +

Static executeSsh

+
    +
  • executeSsh(session: SshSession, command: string, stdoutHandler: (data: string) => void): Promise<any>
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      session: SshSession
      +
    • +
    • +
      command: string
      +
    • +
    • +
      stdoutHandler: (data: string) => void
      +
        +
      • +
          +
        • (data: string): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            data: string
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns Promise<any>

    +
  • +
+
+
+ +

Static executeSshCwd

+
    +
  • executeSshCwd(session: SshSession, command: string, cwd: string, stdoutHandler: (data: string) => void): Promise<any>
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      session: SshSession
      +
    • +
    • +
      command: string
      +
    • +
    • +
      cwd: string
      +
    • +
    • +
      stdoutHandler: (data: string) => void
      +
        +
      • +
          +
        • (data: string): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            data: string
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns Promise<any>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html b/static/v2.15.x/typedoc/classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html new file mode 100644 index 0000000000..79bd36c739 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_uss_for_zowe_sdk.sshbasehandler.html @@ -0,0 +1,554 @@ + + + + + + SshBaseHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SshBaseHandler

+
+
+
+
+
+
+
+
+
+

This class is used by the various handlers in the project as the base class for their implementation.

+
+
+
+
+

Hierarchy

+
    +
  • + SshBaseHandler +
  • +
+
+
+

Implements

+
    +
  • any
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Protected mArguments

+
mArguments: ICommandArguments
+ +
+
+

Command line arguments passed

+
+
+
+
+ +

Protected mHandlerParams

+
mHandlerParams: IHandlerParameters
+ +
+
+

Full set of command handler parameters from imperative

+
+
+
+
+ +

Protected mSession

+
mSession: SshSession
+ +
+
+

The session creating from the command line arguments / profile

+
+
+
+
+ +

Protected mSshProfile

+
mSshProfile: IProfile
+ +
+
+

Loaded z/OS SSH profile if needed

+
+
+
+
+
+

Accessors

+
+ +

console

+ + +
+
+ +

data

+ + +
+
+ +

format

+ + +
+
+ +

progress

+ + +
+
+
+

Methods

+
+ +

fail

+ + +
+
+ +

process

+ + +
+
+ +

Abstract processCmd

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html b/static/v2.15.x/typedoc/classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html new file mode 100644 index 0000000000..f66a100655 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_uss_for_zowe_sdk.sshsession.html @@ -0,0 +1,1080 @@ + + + + + + SshSession | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SshSession

+
+
+
+
+
+
+
+
+
+

Utility Methods for Brightside

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + SshSession +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Private mISshSession

+
mISshSession: ISshSession
+ +
+
+ +

Static Readonly DEFAULT_SSH_PORT

+
DEFAULT_SSH_PORT: 22 = 22
+ +
+
+

Default ssh port 22

+
+
+
static
+
+
memberof
+

AbstractSession

+
+
+
+
+
+ +

Static SSH_CONNECTION_OPTIONS

+
SSH_CONNECTION_OPTIONS: ICommandOptionDefinition[] = [SshSession.SSH_OPTION_HOST,SshSession.SSH_OPTION_PORT,SshSession.SSH_OPTION_USER,SshSession.SSH_OPTION_PASSWORD,SshSession.SSH_OPTION_PRIVATEKEY,SshSession.SSH_OPTION_KEYPASSPHRASE,SshSession.SSH_OPTION_HANDSHAKETIMEOUT]
+ +
+
+

Options related to connecting to z/OS SSH + These options can be filled in if the user creates a profile

+
+
+
+
+ +

Static SSH_CONNECTION_OPTION_GROUP

+
SSH_CONNECTION_OPTION_GROUP: string = "z/OS Ssh Connection Options"
+ +
+
+ +

Static SSH_OPTION_HOST_PROFILE

+
SSH_OPTION_HOST_PROFILE: ICommandOptionDefinition = SshSession.SSH_OPTION_HOST
+ +
+
+
deprecated
+

Use SSH_OPTION_HOST

+
+
+
+
+
+ +

Static SSH_OPTION_USER_PROFILE

+
SSH_OPTION_USER_PROFILE: ICommandOptionDefinition = SshSession.SSH_OPTION_USER
+ +
+
+
deprecated
+

Use SSH_OPTION_USER

+
+
+
+
+
+
+

Accessors

+
+ +

ISshSession

+ + +
+
+ +

Static Private log

+ + +
+
+
+

Methods

+
+ +

Private buildSession

+ + +
+
+ +

Static createSshSessCfgFromArgs

+ + +
+
+
+

Object literals

+
+ +

Static SSH_OPTION_HANDSHAKETIMEOUT

+
SSH_OPTION_HANDSHAKETIMEOUT: object
+ +
+
+

Option used in profile creation to set handshake timeout. If unset, defaults to no timeout.

+
+
+
+ +

aliases

+
aliases: string[] = ["timeout", "to"]
+ +
+
+ +

description

+
description: string = "How long in milliseconds to wait for the SSH handshake to complete."
+ +
+
+ +

group

+
group: string = SshSession.SSH_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "handshakeTimeout"
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

Static SSH_OPTION_HOST

+
SSH_OPTION_HOST: object
+ +
+
+

Option used in profile creation and commands for hostname for z/OS SSH

+
+
+
+ +

aliases

+
aliases: string[] = ["H"]
+ +
+
+ +

description

+
description: string = "The z/OS SSH server host name."
+ +
+
+ +

group

+
group: string = SshSession.SSH_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "host"
+ +
+
+ +

required

+
required: boolean = false
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static SSH_OPTION_KEYPASSPHRASE

+
SSH_OPTION_KEYPASSPHRASE: object
+ +
+
+

Option used in profile creation and commands for passphrase for private key

+
+
+
+ +

aliases

+
aliases: string[] = ["passphrase", "kp"]
+ +
+
+ +

description

+
description: string = "Private key passphrase, which unlocks the private key."
+ +
+
+ +

group

+
group: string = SshSession.SSH_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "keyPassphrase"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static SSH_OPTION_PASSWORD

+
SSH_OPTION_PASSWORD: object
+ +
+
+

Option used in profile creation and commands for password/passphrase for z/OS SSH

+
+
+
+ +

aliases

+
aliases: string[] = ["pass", "pw"]
+ +
+
+ +

description

+
description: string = "Mainframe password, which can be the same as your TSO password."
+ +
+
+ +

group

+
group: string = SshSession.SSH_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "password"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static SSH_OPTION_PORT

+
SSH_OPTION_PORT: object
+ +
+
+

Option used in profile creation and commands for port for z/OS SSH

+
+
+
+ +

aliases

+
aliases: string[] = ["P"]
+ +
+
+ +

defaultValue

+
defaultValue: number = 22
+ +
+
+ +

description

+
description: string = "The z/OS SSH server port."
+ +
+
+ +

group

+
group: string = SshSession.SSH_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "port"
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

Static SSH_OPTION_PRIVATEKEY

+
SSH_OPTION_PRIVATEKEY: object
+ +
+
+

Option used in profile creation and commands for private key path

+
+
+
+ +

aliases

+
aliases: string[] = ["key", "pk"]
+ +
+
+ +

description

+
description: string = "Path to a file containing your private key, that must match a public key stored in the server for authentication"
+ +
+
+ +

group

+
group: string = SshSession.SSH_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "privateKey"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static SSH_OPTION_USER

+
SSH_OPTION_USER: object
+ +
+
+

Option used in profile creation and commands for username / ID for z/OS SSH

+
+
+
+ +

aliases

+
aliases: string[] = ["u"]
+ +
+
+ +

description

+
description: string = "Mainframe user name, which can be the same as your TSO login."
+ +
+
+ +

group

+
group: string = SshSession.SSH_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "user"
+ +
+
+ +

required

+
required: boolean = false
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Constructor
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.archiveddeleteworkflow.html b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.archiveddeleteworkflow.html new file mode 100644 index 0000000000..939eef2b05 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.archiveddeleteworkflow.html @@ -0,0 +1,274 @@ + + + + + + ArchivedDeleteWorkflow | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ArchivedDeleteWorkflow

+
+
+
+
+
+
+
+
+
+

Class to handle deletion of an archived z/OSMF workflow from a z/OS system

+
+
+
+
+

Hierarchy

+
    +
  • + ArchivedDeleteWorkflow +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static archivedDeleteWorkflow

+
    +
  • archivedDeleteWorkflow(session: AbstractSession, workflowKey: string, zOSMFVersion?: string): Promise<any>
  • +
+
    +
  • + +
    +
    +

    Delete archived workflow

    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      workflowKey: string
      +
      +

      Unique identifier of the workflow instance.

      +
      +
    • +
    • +
      Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
      +
      +

      Identifies the version of the zOSMF workflow service.

      +
      +
    • +
    +

    Returns Promise<any>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.archiveworkflow.html b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.archiveworkflow.html new file mode 100644 index 0000000000..78b2a5646f --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.archiveworkflow.html @@ -0,0 +1,283 @@ + + + + + + ArchiveWorkflow | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ArchiveWorkflow

+
+
+
+
+
+
+
+
+
+

Class to handle archiving the workflow instance in z/OSMF

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ArchiveWorkflow +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static archiveWorkflowByKey

+ +
    +
  • + +
    +
    +

    Archives the workflow based on the workflow key

    +
    +
    +
    static
    +
    +
    memberof
    +

    ArchiveWorkflow

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF session

      +
      +
    • +
    • +
      workflowKey: string
      +
      +

      Workflow key of the workflow to be archived

      +
      +
    • +
    • +
      Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
      +
    • +
    +

    Returns Promise<IArchivedWorkflow>

    +

    Promise of the output of the workflow archiving

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.cancelworkflow.html b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.cancelworkflow.html new file mode 100644 index 0000000000..741871a502 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.cancelworkflow.html @@ -0,0 +1,282 @@ + + + + + + CancelWorkflow | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CancelWorkflow

+
+
+
+
+
+
+
+
+
+

Class to handle canceling of zOSMF workflow instance

+
+
+
+
+

Hierarchy

+
    +
  • + CancelWorkflow +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static cancelWorkflow

+ +
    +
  • + +
    +
    +

    Cancel a workflow instance

    +
    +
    +
    memberof
    +

    CancelWorkflow

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      workflowKey: string
      +
      +

      Unique identifier of the workflow instance.

      +
      +
    • +
    • +
      Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
      +
      +

      Identifies the version of the zOSMF workflow service.

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • Promise that specifies the new name of the canceled workflow.
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.createworkflow.html b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.createworkflow.html new file mode 100644 index 0000000000..0e4da885aa --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.createworkflow.html @@ -0,0 +1,611 @@ + + + + + + CreateWorkflow | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CreateWorkflow

+
+
+
+
+
+
+
+
+
+

Class to handle creation of zOSMF workflow instance

+
+
+
+
+

Hierarchy

+
    +
  • + CreateWorkflow +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static createWorkflow

+
    +
  • createWorkflow(session: AbstractSession, WorkflowName: string, WorkflowDefinitionFile: string, systemName: string, Owner: string, VariableInputFile?: string, Variables?: string, AssignToOwner?: boolean, AccessType?: accessT, DeleteCompletedJobs?: boolean, zOSMFVersion?: string): Promise<ICreatedWorkflow>
  • +
+
    +
  • + +
    +
    +

    Create a zOSMF workflow instance

    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      WorkflowName: string
      +
      +

      Name of the workflow that will be created

      +
      +
    • +
    • +
      WorkflowDefinitionFile: string
      +
      +

      Full path to USS file or DATASET/MEMBER with xml

      +
      +
    • +
    • +
      systemName: string
      +
      +

      System where the workflow will run

      +
      +
    • +
    • +
      Owner: string
      +
      +

      User ID of the workflow owner.

      +
      +
    • +
    • +
      Optional VariableInputFile: string
      +
      +

      Properties file with pre-specify values for workflow variables

      +
      +
    • +
    • +
      Optional Variables: string
      +
      +

      A list of one or more variables for the workflow.

      +
      +
    • +
    • +
      Optional AssignToOwner: boolean
      +
      +

      Indicates whether the workflow steps are assigned to the workflow owner

      +
      +
    • +
    • +
      Optional AccessType: accessT
      +
      +

      Specifies the access type for the workflow. Public, Restricted or Private.

      +
      +
    • +
    • +
      Optional DeleteCompletedJobs: boolean
      +
      +

      Specifies whether the job is deleted from the JES spool after it completes successfully.

      +
      +
    • +
    • +
      Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
      +
      +

      Identifies the version of the zOSMF workflow service.

      +
      +
    • +
    +

    Returns Promise<ICreatedWorkflow>

    +
  • +
+
+
+ +

Static createWorkflowLocal

+
    +
  • createWorkflowLocal(session: AbstractSession, WorkflowName: string, WorkflowDefinitionFile: string, systemName: string, Owner: string, VariableInputFile?: string, Variables?: string, AssignToOwner?: boolean, AccessType?: accessT, DeleteCompletedJobs?: boolean, keepFiles?: boolean, customDir?: string, zOSMFVersion?: string): Promise<ICreatedWorkflowLocal>
  • +
+
    +
  • + +
    +
    +

    Create a zOSMF workflow instance using local files

    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      WorkflowName: string
      +
      +

      Name of the workflow that will be created

      +
      +
    • +
    • +
      WorkflowDefinitionFile: string
      +
      +

      Local workflow definition file

      +
      +
    • +
    • +
      systemName: string
      +
      +

      System where the workflow will run

      +
      +
    • +
    • +
      Owner: string
      +
      +

      User ID of the workflow owner.

      +
      +
    • +
    • +
      Optional VariableInputFile: string
      +
      +

      Local properties file with pre-specify values for workflow variables

      +
      +
    • +
    • +
      Optional Variables: string
      +
      +

      A list of one or more variables for the workflow.

      +
      +
    • +
    • +
      Optional AssignToOwner: boolean
      +
      +

      Indicates whether the workflow steps are assigned to the workflow owner

      +
      +
    • +
    • +
      Optional AccessType: accessT
      +
      +

      Specifies the access type for the workflow. Public, Restricted or Private.

      +
      +
    • +
    • +
      Optional DeleteCompletedJobs: boolean
      +
      +

      Specifies whether the job is deleted from the JES spool after it completes successfully.

      +
      +
    • +
    • +
      Optional keepFiles: boolean
      +
      +

      Identifies if the uploaded uss files should be kept.

      +
      +
    • +
    • +
      Optional customDir: string
      +
      +

      Path to specific USS directory in which to upload the temp files.

      +
      +
    • +
    • +
      Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
      +
      +

      Identifies the version of the zOSMF workflow service.

      +
      +
    • +
    +

    Returns Promise<ICreatedWorkflowLocal>

    +
  • +
+
+
+ +

Static deleteTempFile

+ + +
+
+ +

Static getTempFile

+
    +
  • getTempFile(userId: string, localFile: string, customDir?: string): string
  • +
+
    +
  • + +
    +
    +

    Get a full path with file name for a temporary USS file

    +
    +
    +

    Parameters

    +
      +
    • +
      userId: string
      +
      +

      User ID to add to the file name.

      +
      +
    • +
    • +
      localFile: string
      +
      +

      Local file name.

      +
      +
    • +
    • +
      Optional customDir: string
      +
      +

      Custom directory.

      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

Static parseProperties

+
    +
  • parseProperties(propertiesText: string): IVariable[]
  • +
+
    +
  • + +
    +
    +

    copied from ProvisioningService.ts + Parsers text with properties in key1=val1,key2=val2 format and returns IInputProperty[]

    +
    +
    +
    memberof
    +

    ProvisioningService

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      propertiesText: string
      +
      +

      required runtime property objects passed as a string.

      +
      +
    • +
    +

    Returns IVariable[]

    +

    array of properties, @see {IPropertiesInput}

    +
  • +
+
+
+ +

Static uploadTempFile

+ +
    +
  • + +
    +
    +

    Upload USS files to default dir, or a user specified one

    +
    +
    +
    throws
    +

    {ImperativeError} - In case something goes wrong.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info.

      +
      +
    • +
    • +
      localFile: string
      +
      +

      Local file to upload.

      +
      +
    • +
    • +
      remoteFile: string
      +
      +

      Remote location to upload to.

      +
      +
    • +
    +

    Returns Promise<void>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.definitionworkflow.html b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.definitionworkflow.html new file mode 100644 index 0000000000..033b4a9888 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.definitionworkflow.html @@ -0,0 +1,286 @@ + + + + + + DefinitionWorkflow | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class DefinitionWorkflow

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + DefinitionWorkflow +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static getWorkflowDefinition

+ +
    +
  • + +
    +
    +

    This operation returns properties of the workflow. + Parameters indicators are mandatory,request can include steps and variables indicator for requested result.

    +
    +
    +
    memberof
    +

    Definition

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
      +
      +

      the URI path that identifies the version of the provisioning service.

      +
      +
    • +
    • +
      filePath: string
      +
      +

      workflow definition name with path.

      +
      +
    • +
    • +
      steps: boolean
      +
      +

      Optional parameter for listing steps properties.

      +
      +
    • +
    • +
      variables: boolean
      +
      +

      Optional parameter for listing variables properties.

      +
      +
    • +
    +

    Returns Promise<IWorkflowDefinition>

    +

    z/OSMF response object

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.deleteworkflow.html b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.deleteworkflow.html new file mode 100644 index 0000000000..85a08cd3ee --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.deleteworkflow.html @@ -0,0 +1,274 @@ + + + + + + DeleteWorkflow | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class DeleteWorkflow

+
+
+
+
+
+
+
+
+
+

Class to handle deletion of zOSMF workflow instance

+
+
+
+
+

Hierarchy

+
    +
  • + DeleteWorkflow +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static deleteWorkflow

+ +
    +
  • + +
    +
    +

    Delete a workflow instance

    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      workflowKey: string
      +
      +

      Unique identifier of the workflow instance.

      +
      +
    • +
    • +
      Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
      +
      +

      Identifies the version of the zOSMF workflow service.

      +
      +
    • +
    +

    Returns Promise<any>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.listarchivedworkflows.html b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.listarchivedworkflows.html new file mode 100644 index 0000000000..ca88206352 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.listarchivedworkflows.html @@ -0,0 +1,250 @@ + + + + + + ListArchivedWorkflows | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ListArchivedWorkflows

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ListArchivedWorkflows +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static listArchivedWorkflows

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.listworkflows.html b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.listworkflows.html new file mode 100644 index 0000000000..099155626c --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.listworkflows.html @@ -0,0 +1,378 @@ + + + + + + ListWorkflows | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ListWorkflows

+
+
+
+
+
+
+
+
+
+

Get list of workflows from registry.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ListWorkflows +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static getResourceQuery

+ + +
+
+ +

Static getWfKey

+ +
    +
  • + +
    +
    +

    This operation is used to return a worflow-key by given workflow name.

    +
    +
    +
    throws
    +

    {ImperativeError}

    +
    +
    memberof
    +

    ListWorkflows

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      workflowName: string
      +
      +

      workflow name by which to list workflows

      +
      +
    • +
    • +
      Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
      +
      +

      identifies the version of the provisioning service.

      +
      +
    • +
    +

    Returns Promise<string> | null

    +
      +
    • Promise with string containing wf key, or null if none was found
    • +
    +
  • +
+
+
+ +

Static getWorkflows

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.propertiesworkflow.html b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.propertiesworkflow.html new file mode 100644 index 0000000000..d5fa577f1d --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.propertiesworkflow.html @@ -0,0 +1,327 @@ + + + + + + PropertiesWorkflow | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class PropertiesWorkflow

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + PropertiesWorkflow +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static getWorkflowProperties

+ +
    +
  • + +
    +
    +

    This operation returns properties of the workflow. + Parameters indicators are mandatory,request can include steps and variables indicator for requested result.

    +
    +
    +
    memberof
    +

    Properties

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      workflowKey: string
      +
    • +
    • +
      Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
      +
      +

      the URI path that identifies the version of the provisioning service.

      +
      +
    • +
    • +
      Optional steps: boolean
      +
      +

      Optional parameter for listing steps properties.

      +
      +
    • +
    • +
      Optional variables: boolean
      +
      +

      Optional parameter for listing variables properties.

      +
      +
    • +
    +

    Returns Promise<IWorkflowInfo>

    +

    z/OSMF response object

    +
  • +
+
+
+ +

Static Protected processStepSummaries

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.startworkflow.html b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.startworkflow.html new file mode 100644 index 0000000000..d14ebabee9 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.startworkflow.html @@ -0,0 +1,296 @@ + + + + + + StartWorkflow | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class StartWorkflow

+
+
+
+
+
+
+
+
+
+

Class to handle starting of zOSMF workflow instance

+
+
+
+
+

Hierarchy

+
    +
  • + StartWorkflow +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static startWorkflow

+
    +
  • startWorkflow(session: AbstractSession, workflowKey: string, resolveConflict?: startT, step?: string, subsequent?: boolean, zOSMFVersion?: string): Promise<any>
  • +
+
    +
  • + +
    +
    +

    Create a zOSMF workflow instance

    +
    +
    +

    Parameters

    +
      +
    • +
      session: AbstractSession
      +
      +

      z/OSMF connection info

      +
      +
    • +
    • +
      workflowKey: string
      +
      +

      Unique key that workflow instant got assigned by zOSMF

      +
      +
    • +
    • +
      Optional resolveConflict: startT
      +
      +

      Indicates how variable conflicts are to be handled when + the Workflows task reads in the output file from a step. + Allowed values are: outputFileValue, existingValue, + leaveConflict(have to resolve conflict manually)

      +
      +
    • +
    • +
      Optional step: string
      +
      +

      Specifies the step name that will run.

      +
      +
    • +
    • +
      Optional subsequent: boolean
      +
      +

      If the workflow contains any subsequent automated steps, + this property indicates whether z/OSMF is to perform the steps.

      +
      +
    • +
    • +
      Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
      +
      +

      Identifies the version of the zOSMF workflow service.

      +
      +
    • +
    +

    Returns Promise<any>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html new file mode 100644 index 0000000000..3b20eb47ee --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.workflowconstants.html @@ -0,0 +1,803 @@ + + + + + + WorkflowConstants | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class WorkflowConstants

+
+
+
+
+
+
+
+
+
+

Constants for workflow related APIs.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + WorkflowConstants +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static Readonly ARCHIVE_WORKFLOW

+
ARCHIVE_WORKFLOW: string = "operations/archive"
+ +
+
+

URI base for archiving workflow API

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly ARCH_WORKFLOW_RESOURCE

+
ARCH_WORKFLOW_RESOURCE: string = "archivedworkflows"
+ +
+
+

URI base for workflows API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly CANCEL_WORKFLOW

+
CANCEL_WORKFLOW: string = "operations/cancel"
+ +
+
+

URI base for canceling workflow API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly LIST_WORKFLOWS

+
LIST_WORKFLOWS: string = "operations/list"
+ +
+
+

URI base for list workflows from registry API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly RESOURCE

+
RESOURCE: string = "/zosmf/workflow/rest"
+ +
+
+

URI base for workflow API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly START_WORKFLOW

+
START_WORKFLOW: string = "operations/start"
+ +
+
+

URI base for starting workflow API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly WF_NAME

+
WF_NAME: string = "workflowName"
+ +
+
+

URI base for filtering workflow by name API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly WORKFLOW_DEFINITION

+
WORKFLOW_DEFINITION: string = "workflowDefinition"
+ +
+
+

URI base for workflows API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly WORKFLOW_RESOURCE

+
WORKFLOW_RESOURCE: string = "workflows"
+ +
+
+

URI base for workflows API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly ZOSMF_VERSION

+
ZOSMF_VERSION: string = "1.0"
+ +
+
+

Version of the z/OSMF

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly category

+
category: string = "category"
+ +
+
+

URI base for filter workflows from registry API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly filePath

+
filePath: string = "definitionFilePath"
+ +
+
+

URI base for filePath for workflow definition.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly owner

+
owner: string = "owner"
+ +
+
+

URI base for filter workflows from registry API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly returnData

+
returnData: string = "returnData"
+ +
+
+

URI base for returnData for workflow properties from registry API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly statusName

+
statusName: string = "statusName"
+ +
+
+

URI base for filter workflows from registry API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly steps

+
steps: string = "steps"
+ +
+
+

URI base for steps for workflow properties from registry API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly system

+
system: string = "system"
+ +
+
+

URI base for filter workflows from registry API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly tempPath

+
tempPath: string = "/tmp"
+ +
+
+

Default path for uploading temporary files

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly variables

+
variables: string = "variables"
+ +
+
+

URI base for variables for workflow properties from registry API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly vendor

+
vendor: string = "vendor"
+ +
+
+

URI base for filter workflows from registry API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly workflowKey

+
workflowKey: string = "workflowKey"
+ +
+
+

URI base for filter workflows from registry API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+ +

Static Readonly workflowName

+
workflowName: string = "workflowName"
+ +
+
+

URI base for filter workflows from registry API.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.workflowvalidator.html b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.workflowvalidator.html new file mode 100644 index 0000000000..6cc2c9d6e1 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zos_workflows_for_zowe_sdk.workflowvalidator.html @@ -0,0 +1,465 @@ + + + + + + WorkflowValidator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class WorkflowValidator

+
+
+
+
+
+
+
+
+
+

Class validates parameters for workflows commands.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + WorkflowValidator +
  • +
+
+
+

Index

+
+ +
+
+
+

Methods

+
+ +

Static validateNotEmptyString

+
    +
  • validateNotEmptyString(text: string, errorMsg: string): void
  • +
+
    +
  • + +
    +
    +

    Validate supplied parameters

    +
    +
    +
    static
    +
    +
    memberof
    +

    WorkflowValidator

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      text: string
      +
      +

      string to check if empty

      +
      +
    • +
    • +
      errorMsg: string
      +
      +

      message to show in case validation fails

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static validateOwner

+
    +
  • validateOwner(userID: string, errorMsg: string): void
  • +
+
    +
  • + +
    +
    +

    Validate supplied parameter

    +
    +
    +
    static
    +
    +
    memberof
    +

    WorkflowValidator

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      userID: string
      +
      +

      string to check if it is valid user ID regarding IBM

      +
      +
    • +
    • +
      errorMsg: string
      +
      +

      message to show in case validation fails

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static validateParameter

+
    +
  • validateParameter(parameterValue: string, errorMsg: string): void
  • +
+
    +
  • + +
    +
    +

    Validate supplied string for parameters if there is not value "?" or "&"

    +
    +
    +
    static
    +
    +
    memberof
    +

    WorkflowValidator

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      parameterValue: string
      +
      +

      check if the provided parameters does not contain value "?" or "&"

      +
      +
    • +
    • +
      errorMsg: string
      +
      +

      message to show in case validation fails

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Static validateSession

+ + +
+
+ +

Static validateString

+
    +
  • validateString(text: string, errorMsg: string): void
  • +
+
    +
  • + +
    +
    +

    Validate supplied parameters

    +
    +
    +
    static
    +
    +
    memberof
    +

    WorkflowValidator

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      text: string
      +
      +

      string to check if not null or undefined

      +
      +
    • +
    • +
      errorMsg: string
      +
      +

      message to show in case validation fails

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zosmf_for_zowe_sdk.checkstatus.html b/static/v2.15.x/typedoc/classes/_zowe_zosmf_for_zowe_sdk.checkstatus.html new file mode 100644 index 0000000000..6d17bc3189 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zosmf_for_zowe_sdk.checkstatus.html @@ -0,0 +1,338 @@ + + + + + + CheckStatus | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CheckStatus

+
+
+
+
+
+
+
+
+
+

This class holds the helper functions that are used to gather zosmf information throgh the + z/OSMF APIs.

+
+
+
+
+

Hierarchy

+
    +
  • + CheckStatus +
  • +
+
+
+

Index

+
+
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Accessors

+
+ +

Static Private log

+ + +
+
+
+

Methods

+
+ +

Static getZosmfInfo

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zosmf_for_zowe_sdk.listdefinedsystems.html b/static/v2.15.x/typedoc/classes/_zowe_zosmf_for_zowe_sdk.listdefinedsystems.html new file mode 100644 index 0000000000..556ad0194c --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zosmf_for_zowe_sdk.listdefinedsystems.html @@ -0,0 +1,303 @@ + + + + + + ListDefinedSystems | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ListDefinedSystems

+
+
+
+
+
+
+
+
+
+

This class is used to list the systems defined to z/OSMF throgh the + z/OSMF APIs.

+
+
+
+
+

Hierarchy

+
    +
  • + ListDefinedSystems +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Static listDefinedSystems

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Static method
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html b/static/v2.15.x/typedoc/classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html new file mode 100644 index 0000000000..2ee19a6453 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zosmf_for_zowe_sdk.zosmfbasehandler.html @@ -0,0 +1,588 @@ + + + + + + ZosmfBaseHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ZosmfBaseHandler

+
+
+
+
+
+
+
+
+
+

This class is used by the various handlers in the project as the base class for their implementation.

+
+
+
+
+

Hierarchy

+
    +
  • + ZosmfBaseHandler +
  • +
+
+
+

Implements

+
    +
  • any
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Protected mArguments

+
mArguments: ICommandArguments
+ +
+
+

Command line arguments passed

+
+
+
+
+ +

Protected mHandlerParams

+
mHandlerParams: IHandlerParameters
+ +
+
+

Full set of command handler parameters from imperative

+
+
+
+
+ +

Protected mSession

+
mSession: AbstractSession
+ +
+
+

The session creating from the command line arguments / profile

+
+
+
+
+ +

Protected mZosmfLoadedProfile

+
mZosmfLoadedProfile: IProfileLoaded
+ +
+
+

Loaded z/OSMF profile with meta information

+
+
+
+
+ +

Protected mZosmfProfile

+
mZosmfProfile: IProfile
+ +
+
+

Loaded z/OSMF profile if needed

+
+
+
+
+
+

Accessors

+
+ +

console

+ + +
+
+ +

data

+ + +
+
+ +

format

+ + +
+
+ +

progress

+ + +
+
+
+

Methods

+
+ +

fail

+ + +
+
+ +

process

+ + +
+
+ +

Abstract processCmd

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
  • Method
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Enumeration
  • +
+
    +
  • Protected property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html b/static/v2.15.x/typedoc/classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html new file mode 100644 index 0000000000..e31339c3a8 --- /dev/null +++ b/static/v2.15.x/typedoc/classes/_zowe_zosmf_for_zowe_sdk.zosmfsession.html @@ -0,0 +1,1135 @@ + + + + + + ZosmfSession | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ZosmfSession

+
+
+
+
+
+
+
+
+
+

Utility Methods for Brightside

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + ZosmfSession +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Static ZOSMF_CONNECTION_OPTIONS

+
ZOSMF_CONNECTION_OPTIONS: ICommandOptionDefinition[] = [ZosmfSession.ZOSMF_OPTION_HOST,ZosmfSession.ZOSMF_OPTION_PORT,ZosmfSession.ZOSMF_OPTION_USER,ZosmfSession.ZOSMF_OPTION_PASSWORD,ZosmfSession.ZOSMF_OPTION_REJECT_UNAUTHORIZED,ZosmfSession.ZOSMF_OPTION_BASE_PATH,ZosmfSession.ZOSMF_OPTION_PROTOCOL,ZosmfSession.ZOSMF_OPTION_CERT_FILE,ZosmfSession.ZOSMF_OPTION_CERT_KEY_FILE// ZosmfSession.ZOSMF_OPTION_CERT_FILE_PASSPHRASE]
+ +
+
+

Options related to connecting to z/OSMF + These options can be filled in if the user creates a profile

+
+
+
+
+ +

Static ZOSMF_CONNECTION_OPTION_GROUP

+
ZOSMF_CONNECTION_OPTION_GROUP: string = "Zosmf Connection Options"
+ +
+
+ +

Static ZOSMF_OPTION_HOST_PROFILE

+
ZOSMF_OPTION_HOST_PROFILE: any = ZosmfSession.ZOSMF_OPTION_HOST
+ +
+
+

Option used in profile creation and commands for hostname for z/OSMF

+
+
+
deprecated
+

Use ZOSMF_OPTION_HOST instead

+
+
+
+
+
+ +

Static ZOSMF_OPTION_PASSWORD_PROFILE

+
ZOSMF_OPTION_PASSWORD_PROFILE: any = ZosmfSession.ZOSMF_OPTION_PASSWORD
+ +
+
+

Option used in profile creation and commands for password/passphrase for z/OSMF

+
+
+
deprecated
+

Use ZOSMF_OPTION_PASSWORD instead

+
+
+
+
+
+ +

Static ZOSMF_OPTION_USER_PROFILE

+
ZOSMF_OPTION_USER_PROFILE: any = ZosmfSession.ZOSMF_OPTION_USER
+ +
+
+

Option used in profile creation and commands for username / ID for z/OSMF

+
+
+
deprecated
+

Use ZOSMF_OPTION_USER instead

+
+
+
+
+
+
+

Accessors

+
+ +

Static Private log

+ + +
+
+
+

Methods

+
+ +

Static createSessCfgFromArgs

+ + +
+
+
+

Object literals

+
+ +

Static ZOSMF_OPTION_BASE_PATH

+
ZOSMF_OPTION_BASE_PATH: object
+ +
+
+

Option used in profile creation and commands for base path setting for connecting to z/OSMF

+
+
+
+ +

aliases

+
aliases: string[] = ["bp"]
+ +
+
+ +

description

+
description: string = "The base path for your API mediation layer instance." +" Specify this option to prepend the base path to all z/OSMF resources when making REST requests." +" Do not specify this option if you are not using an API mediation layer."
+ +
+
+ +

group

+
group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "base-path"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static ZOSMF_OPTION_CERT_FILE

+
ZOSMF_OPTION_CERT_FILE: object
+ +
+
+

Option used to specify the path to the certificate file for authentication

+
+
+
+ +

description

+
description: string = "The file path to a certificate file to use for authentication"
+ +
+
+ +

group

+
group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "cert-file"
+ +
+
+ +

type

+
type: string = "existingLocalFile"
+ +
+
+
+ +

Static ZOSMF_OPTION_CERT_KEY_FILE

+
ZOSMF_OPTION_CERT_KEY_FILE: object
+ +
+
+

Option used to specify the path to the cert's key file for authentication

+
+
+
+ +

description

+
description: string = "The file path to a certificate key file to use for authentication"
+ +
+
+ +

group

+
group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "cert-key-file"
+ +
+
+ +

type

+
type: string = "existingLocalFile"
+ +
+
+
+ +

Static ZOSMF_OPTION_HOST

+
ZOSMF_OPTION_HOST: object
+ +
+
+

Option used in profile creation and commands for hostname for z/OSMF

+
+
+
+ +

aliases

+
aliases: string[] = ["H"]
+ +
+
+ +

description

+
description: string = "The z/OSMF server host name."
+ +
+
+ +

group

+
group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "host"
+ +
+
+ +

required

+
required: boolean = false
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static ZOSMF_OPTION_PASSWORD

+
ZOSMF_OPTION_PASSWORD: object
+ +
+
+

Option used in profile creation and commands for password/passphrase for z/OSMF

+
+
+
+ +

aliases

+
aliases: string[] = ["pass", "pw"]
+ +
+
+ +

description

+
description: string = "Mainframe (z/OSMF) password, which can be the same as your TSO password."
+ +
+
+ +

group

+
group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "password"
+ +
+
+ +

required

+
required: boolean = false
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

Static ZOSMF_OPTION_PORT

+
ZOSMF_OPTION_PORT: object
+ +
+
+

Option used in profile creation and commands for port for z/OSMF

+
+
+
+ +

aliases

+
aliases: string[] = ["P"]
+ +
+
+ +

defaultValue

+
defaultValue: number = 443
+ +
+
+ +

description

+
description: string = "The z/OSMF server port."
+ +
+
+ +

group

+
group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "port"
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

Static ZOSMF_OPTION_PROTOCOL

+
ZOSMF_OPTION_PROTOCOL: object
+ +
+
+

Option used to specify HTTP or HTTPS Protocol

+
+
+
+ +

defaultValue

+
defaultValue: string = "https"
+ +
+
+ +

description

+
description: string = "The protocol used (HTTP or HTTPS)"
+ +
+
+ +

group

+
group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "protocol"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+ +

allowableValues

+
allowableValues: object
+ +
+ +

caseSensitive

+
caseSensitive: boolean = false
+ +
+
+ +

values

+
values: string[] = ["http", "https"]
+ +
+
+
+
+ +

Static ZOSMF_OPTION_REJECT_UNAUTHORIZED

+
ZOSMF_OPTION_REJECT_UNAUTHORIZED: object
+ +
+
+

Option used in profile creation and commands for rejectUnauthorized setting for connecting to z/OSMF

+
+
+
+ +

aliases

+
aliases: string[] = ["ru"]
+ +
+
+ +

defaultValue

+
defaultValue: boolean = true
+ +
+
+ +

description

+
description: string = "Reject self-signed certificates."
+ +
+
+ +

group

+
group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "reject-unauthorized"
+ +
+
+ +

type

+
type: string = "boolean"
+ +
+
+
+ +

Static ZOSMF_OPTION_USER

+
ZOSMF_OPTION_USER: object
+ +
+
+

Option used in profile creation and commands for username / ID for z/OSMF

+
+
+
+ +

aliases

+
aliases: string[] = ["u"]
+ +
+
+ +

description

+
description: string = "Mainframe (z/OSMF) user name, which can be the same as your TSO login."
+ +
+
+ +

group

+
group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
+ +
+
+ +

name

+
name: string = "user"
+ +
+
+ +

required

+
required: boolean = false
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/enums/_zowe_imperative.guiresult.html b/static/v2.15.x/typedoc/enums/_zowe_imperative.guiresult.html new file mode 100644 index 0000000000..667451959e --- /dev/null +++ b/static/v2.15.x/typedoc/enums/_zowe_imperative.guiresult.html @@ -0,0 +1,273 @@ + + + + + + GuiResult | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration GuiResult

+
+
+
+
+
+
+
+
+
+

This enum represents the possible results from isGuiAvailable.

+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

GUI_AVAILABLE

+
GUI_AVAILABLE: = 0
+ +
+
+

A GUI is available

+
+
+
+
+ +

NO_GUI_NO_DISPLAY

+
NO_GUI_NO_DISPLAY: = 2
+ +
+
+

No GUI because The $DISPLAY environment variable is not set.

+
+
+
+
+ +

NO_GUI_SSH

+
NO_GUI_SSH: = 1
+ +
+
+

No GUI because this is an SSH connection.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/enums/_zowe_imperative.issueseverity.html b/static/v2.15.x/typedoc/enums/_zowe_imperative.issueseverity.html new file mode 100644 index 0000000000..654f698a31 --- /dev/null +++ b/static/v2.15.x/typedoc/enums/_zowe_imperative.issueseverity.html @@ -0,0 +1,297 @@ + + + + + + IssueSeverity | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration IssueSeverity

+
+
+
+
+
+
+
+
+
+

This enum represents the possible severity types of a plugin issue.

+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

CFG_ERROR

+
CFG_ERROR: = "CfgError"
+ +
+
+

Configuration errors. We cannot even properly define this plugin. + The plugin cannot be used.

+
+
+
+
+ +

CMD_ERROR

+
CMD_ERROR: = "CmdError"
+ +
+
+

An error in a plugin's set of commands. + The plugin's commands will not be loaded into the host CLI app. + It's overrides may be used.

+
+
+
+
+ +

OVER_ERROR

+
OVER_ERROR: = "OverrideError"
+ +
+
+

An error in a plugin's override component. + The plugin's overrides will not be used by imperative + It's commands may be added to the host CLI app.

+
+
+
+
+ +

WARNING

+
WARNING: = "Warning"
+ +
+
+

Warnings identify optional items not implemented by a plugin.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/enums/_zowe_imperative.itemid.html b/static/v2.15.x/typedoc/enums/_zowe_imperative.itemid.html new file mode 100644 index 0000000000..3a7cccd726 --- /dev/null +++ b/static/v2.15.x/typedoc/enums/_zowe_imperative.itemid.html @@ -0,0 +1,401 @@ + + + + + + ItemId | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration ItemId

+
+
+
+
+
+
+
+
+
+

This enum represents the runtime environment items of interest. + These are more than just environment variables. + We will report on these items (and report on any detected problems) + in the order that the items are listed below.

+
+
+
+
+

Index

+
+ +
+
+
+

Enumeration members

+
+ +

ARCHITECTURE

+
ARCHITECTURE:
+ +
+
+ +

NODEJS_VER

+
NODEJS_VER:
+ +
+
+ +

NPM_VER

+
NPM_VER:
+ +
+
+ +

NVM_VER

+
NVM_VER:
+ +
+
+ +

OS_PATH

+
OS_PATH:
+ +
+
+ +

OTHER_ZOWE_VARS

+
OTHER_ZOWE_VARS:
+ +
+
+ +

PLATFORM

+
PLATFORM:
+ +
+
+ +

ZOWE_APP_LOG_LEVEL

+
ZOWE_APP_LOG_LEVEL:
+ +
+
+ +

ZOWE_CLI_HOME

+
ZOWE_CLI_HOME:
+ +
+
+ +

ZOWE_CONFIG_TYPE

+
ZOWE_CONFIG_TYPE:
+ +
+
+ +

ZOWE_IMPERATIVE_LOG_LEVEL

+
ZOWE_IMPERATIVE_LOG_LEVEL:
+ +
+
+ +

ZOWE_PLUGINS

+
ZOWE_PLUGINS:
+ +
+
+ +

ZOWE_VER

+
ZOWE_VER:
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/enums/_zowe_imperative.profloctype.html b/static/v2.15.x/typedoc/enums/_zowe_imperative.profloctype.html new file mode 100644 index 0000000000..fab6dddb06 --- /dev/null +++ b/static/v2.15.x/typedoc/enums/_zowe_imperative.profloctype.html @@ -0,0 +1,275 @@ + + + + + + ProfLocType | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration ProfLocType

+
+
+
+
+
+
+
+
+
+

This enum represents the type of location for a property. + Note that properties with location types of ENV and DEFAULT + cannot be stored back to disk. Thus the consumer app must + make its own decision about where to store the property.

+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

DEFAULT

+
DEFAULT:
+ +
+
+ +

ENV

+
ENV:
+ +
+
+ +

OLD_PROFILE

+
OLD_PROFILE: = 0
+ +
+
+ +

TEAM_CONFIG

+
TEAM_CONFIG:
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/enums/_zowe_imperative.taskstage.html b/static/v2.15.x/typedoc/enums/_zowe_imperative.taskstage.html new file mode 100644 index 0000000000..186e0abd9f --- /dev/null +++ b/static/v2.15.x/typedoc/enums/_zowe_imperative.taskstage.html @@ -0,0 +1,273 @@ + + + + + + TaskStage | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration TaskStage

+
+
+
+
+
+
+
+
+
+

Describes the current stage/status of a task in your CLI + Used in operation infrastructure and for progress bars

+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

COMPLETE

+
COMPLETE:
+ +
+
+ +

FAILED

+
FAILED:
+ +
+
+ +

IN_PROGRESS

+
IN_PROGRESS:
+ +
+
+ +

NOT_STARTED

+
NOT_STARTED:
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/enums/_zowe_zos_files_for_zowe_sdk.createdatasettypeenum.html b/static/v2.15.x/typedoc/enums/_zowe_zos_files_for_zowe_sdk.createdatasettypeenum.html new file mode 100644 index 0000000000..3d2394b0c4 --- /dev/null +++ b/static/v2.15.x/typedoc/enums/_zowe_zos_files_for_zowe_sdk.createdatasettypeenum.html @@ -0,0 +1,300 @@ + + + + + + CreateDataSetTypeEnum | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration CreateDataSetTypeEnum

+
+
+
+
+
+
+
+
+
+

Enumerated type that describes the different kinds of data sets that can be created

+
+
+
+
+

Index

+
+ +
+
+
+

Enumeration members

+
+ +

DATA_SET_BINARY

+
DATA_SET_BINARY:
+ +
+
+ +

DATA_SET_BLANK

+
DATA_SET_BLANK:
+ +
+
+ +

DATA_SET_C

+
DATA_SET_C:
+ +
+
+ +

DATA_SET_CLASSIC

+
DATA_SET_CLASSIC:
+ +
+
+ +

DATA_SET_PARTITIONED

+
DATA_SET_PARTITIONED:
+ +
+
+ +

DATA_SET_SEQUENTIAL

+
DATA_SET_SEQUENTIAL:
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/enums/_zowe_zos_files_for_zowe_sdk.tag.html b/static/v2.15.x/typedoc/enums/_zowe_zos_files_for_zowe_sdk.tag.html new file mode 100644 index 0000000000..68c93b47fb --- /dev/null +++ b/static/v2.15.x/typedoc/enums/_zowe_zos_files_for_zowe_sdk.tag.html @@ -0,0 +1,251 @@ + + + + + + Tag | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration Tag

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/enums/_zowe_zos_files_for_zowe_sdk.transfermode.html b/static/v2.15.x/typedoc/enums/_zowe_zos_files_for_zowe_sdk.transfermode.html new file mode 100644 index 0000000000..ddc5e0a06c --- /dev/null +++ b/static/v2.15.x/typedoc/enums/_zowe_zos_files_for_zowe_sdk.transfermode.html @@ -0,0 +1,237 @@ + + + + + + TransferMode | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration TransferMode

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/globals.html b/static/v2.15.x/typedoc/globals.html new file mode 100644 index 0000000000..e542390215 --- /dev/null +++ b/static/v2.15.x/typedoc/globals.html @@ -0,0 +1,200 @@ + + + + + + Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Zowe Node.js SDK - v2.15.0

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/index.html b/static/v2.15.x/typedoc/index.html new file mode 100644 index 0000000000..dbdb2fbcd0 --- /dev/null +++ b/static/v2.15.x/typedoc/index.html @@ -0,0 +1,403 @@ + + + + + + Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Zowe Node.js SDK - v2.15.0

+
+
+
+
+
+
+
+ +

Zowe CLI

+
+

codecov + OpenSSF Best Practices

+

Zowe CLI is a command-line interface that lets you interact with the mainframe in a familiar format. Zowe CLI helps to increase overall productivity, reduce the learning curve for developing mainframe applications, and exploit the ease-of-use of off-platform tools. Zowe CLI lets you use common tools such as Integrated Development Environments (IDEs), shell commands, bash scripts, and build tools for mainframe development. Through its ecosystem of plug-ins, you can automate actions on systems such as IBM Db2, IBM CICS, and more. It provides a set of utilities and services that help developers, DevOps engineers, and more become efficient in supporting and building z/OS applications quickly.

+

This repository also contains the Zowe Node Client SDK. The SDK lets you leverage the underlying APIs to build applications that interface with the mainframe.

+
+ +

Contents

+
+ +
+ +

Documentation

+
+

For information about how to install, configure, and use Zowe CLI, see Zowe CLI Quick Start Documentation. For more detailed instructions, see Zowe CLI Documentation, which also includes examples and tutorials for how to contribute to Zowe CLI and develop CLI plug-ins.

+

Engineering design documentation is contained in the 'docs' directory in this repository. To view the Web Help for all Zowe CLI commands and contributed plug-ins, see the Zowe CLI Web Help. To view all locally accessible commands, run zowe --help-web. For more use cases and tutorials visit Medium.com/zowe.

+
+ +

Contribution Guidelines

+
+

The following information is critical to working with the code, running/writing/maintaining automated tests, developing consistent syntax in your plug-in, and ensuring that your plug-in integrates with Zowe CLI properly:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
For more information about ...See:
General guidelines that apply to contributing to Zowe CLI and Plug-insContribution Guidelines
Conventions and best practices for creating packages and plug-ins for Zowe CLIPackage and Plug-in Guidelines
Guidelines for contributing to Zowe SDKsSDK Guidelines
Guidelines for running tests on Zowe CLITesting Guidelines
Guidelines for running tests on the plug-ins that you buildPlug-in Testing Guidelines
Documentation that describes the features of the Imperative CLI FrameworkAbout Imperative CLI Framework
Naming CLI commands and developing syntaxCommand Format Standards
Versioning conventions for Zowe CLI and Plug-insVersioning Guidelines
Miscellaneous tips for developmentDevelopment Tips
+

Tip:

+ +
+ +

Building Zowe CLI From Source

+
+

Zowe CLI requires NPM version 8 and Cargo version 1.72.0 (or newer) to build from source. Before proceeding, check your NPM version with npm --version and if it's older than 8.x, update with npm install -g npm. To check your version of Cargo, run cargo --version. Cargo can be installed using rustup: https://rustup.rs/. To update Cargo, run the rustup update command.

+

For developers using Linux, the following packages are required to build Zowe CLI from source:

+
    +
  • Debian/Ubuntu:
      +
    • sudo apt install build-essential libsecret-1-dev
    • +
    +
  • +
  • Red Hat-based:
      +
    • sudo dnf group install "Development Tools"
    • +
    • sudo dnf install libsecret-devel
    • +
    +
  • +
  • Arch Linux:
      +
    • sudo pacman -S base-devel libsecret
    • +
    +
  • +
+

The first time that you download Zowe CLI from the GitHub repository, issue the following command to install the required Zowe CLI dependencies and several development tools:

+
npm install
+
+

To build your code changes, issue the following command:

+
npm run build
+
+

When you update package.json to include new dependencies, or when you pull changes that affect package.json, issue the following command to download the dependencies:

+
npm update
+
+

Tip:

+
    +
  • When necessary, you can run the install command again to update dependencies changed in package.json.
  • +
+
+ +

Installing Zowe CLI From Source

+
+

From your copy of this repository, after a build, navigate to the packages/cli directory, then issue the following command to install Zowe CLI from source:

+
npm install -g
+
+

Notes:

+
    +
  • Depending on how you configured npm on Linux or Mac, you might need to prefix the npm install -g command or the npm uninstall -g command with sudo to let npm have write access to the installation directory.
  • +
  • On Windows, the npm install -g command might fail several times due to an EPERM error. This appears to be a bug that npm documented in their GitHub issues. This behaviour does not appear to be specific to installing the Zowe CLI package. Unfortunately, the only solution that we know of is to issue the npm cache clean command and the npm install -g command repeatedly until it works.
  • +
+
+ +

Uninstalling Zowe CLI

+
+

From your local copy of this repository, issue the following command to uninstall Zowe CLI:

+
npm uninstall --global @zowe/cli
+
+
+ +

Configuring Zowe CLI

+
+

Zowe CLI configuration is made up of different profiles. The profiles contain the information that Zowe CLI needs to communicate with the mainframe system. For example, credentials and z/OSMF host name. If you try to use Zowe CLI functionality and you get an error message that Zowe CLI failed to load any profiles, see the zowe profiles create --help command for the group of commands that you are trying to use (if any) to initialize your configuration.

+

The most fundamental Zowe CLI profile is a zosmf profile. Issue the following command to understand how to create a zosmf profile in Zowe CLI:

+
zowe profiles create zosmf-profile --help
+
+

After you create your profile, you can confirm that the properties of your profile can connect to and communicate with your mainframe system successfully by issuing the following command:

+
zowe zosmf check status
+
+

For detailed information about creating service profiles, creating base profiles, or integrating with Zowe API ML, see Using Zowe CLI.

+

Tip:

+
    +
  • When you confirm that your profile connects to and communicates with your mainframe system successfully, you can issue the same command at any time to verify the availability and status of the z/OSMF subsystem on your mainframe.
  • +
+
+ +

Zowe Node Client SDK

+
+

The Zowe Node Client SDK consists of APIs that enable you to build client applications that interface with the mainframe. Use the APIs to build your own client applications or automation scripts, independent of Zowe CLI.

+

For information about downloading and getting started with the SDK, see the Zowe Docs. To view the Zowe Node.js SDK doc, see Zowe SDK Docs.

+

Tip:

+
    +
  • Alternatively, you can import Zowe CLI into your project to call the Node APIs. However, importing all of Zowe CLI will increase the size of your project. For example, use the following statement to import packages from Zowe CLI:

    +
    import { <interfaceName> } from @zowe/cli
    +
    +

    Where <interfaceName> is the name of an interface that you populate (i.e. IIssueParms) or a function that submits requests (i.e IssueCommand).

    +
  • +
+
+ +

Example API Usage

+
+

For example usage syntax, see the readme for each API package in this repository:

+
    +
  • Provisioning: Provision middleware and resources such as IBM CICS, IBM Db2, IBM MQ, and more.
  • +
  • z/OS Console: Perform z/OS console operations.
  • +
  • z/OS Data Sets: Work with data sets on z/OS.
  • +
  • z/OS Jobs: Work with batch jobs on z/OS.
  • +
  • z/OS Logs: Interact with logs on z/OS.
  • +
  • z/OS TSO: Interact with TSO/E adress spaces on z/OS.
  • +
  • z/OS USS: Work with UNIX system services (USS) files on z/OS.
  • +
  • z/OS Workflows: Create and manage z/OSMF workflows on z/OS.
  • +
  • z/OSMF: Return data about z/OSMF, such as connection status or a list of available systems.
  • +
+
+ +

Running System Tests

+
+

In addition to Node.js, you must have a means to execute .sh (bash) scripts, which are required for running integration tests. On Windows, you can install "Git Bash" (bundled with the standard Git installation - check "Use Git and Unix Tools from Windows Command Prompt" installation option).

+

After downloading/installing the prerequisites, ensure that you can execute the following commands and receive success responses:

+
1. `node --version`
+2. `npm --version`
+3. On Windows: `where sh`
+
+

To run Zowe CLI system tests, you need a configured properties file with proper system information present.

+

A dummy properties file is present in the __tests__/__resources__/properties folder, default_properties.yaml. Using this file as a template, you should create a custom_properties.yaml file within the same directory. Git is configured to ignore all properties files in the properties folder, except for the default_properties.yaml file. If the custom_properties.yaml file cannot be found or loaded, an error with relevant details will be thrown when attempting to run tests.

+

You can then run the system tests by issuing the following command:

+
npm run test:system
+
+
+

IMPORTANT! Do not commit configured properties files because they contain security principles and other critical information.

+
+ +

Frequently Asked Questions

+
+

How can I install Zowe CLI as a root user on Mac/Linux?

+
    +
  • You can install the CLI as root so that all users can access the CLI without installing it individually on their user account. As the root user on Mac/Linux, issue the following command:

    +
    npm i -g @zowe/cli@latest --ignore-scripts
    +
    +

    WARNING! If you use this method, plug-ins that are installed as root can only be accessed as root. Users must install plug-ins on their user account or share all profiles/plugins/settings/logs with root. You also might encounter npm errors if you install as root. We recommend that Linux administrators implement a user/group environment where permissions can be more carefully controlled.

    +
  • +
+

What is the difference between V1 and V2?

+
    +
  • V2 uses team profiles and deprecates the Secure Credential Store (SCS) plug-in.

    +

    Connection details can be managed efficiently within one file, promoting a global configuration that can be shared across teams and mainframe services. For more information on how to use profiles, visit Zowe Docs.

    +

    Secure credential encryption is included in the core CLI.

    +
  • +
+
+

Don't see what you're looking for? Browse questions from the community or ask your own in the Q&A section of our repo.

+ +

Project Structure and Governance

+
+

Zowe CLI is a component of the Zowe Open Mainframe Project, part of the Linux Foundation.

+

To learn more about how Zowe is structured and governed, see the Technical Steering Committee Structure and Governance documentation.

+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.ialtprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.ialtprofile.html new file mode 100644 index 0000000000..1e4b3dfd98 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.ialtprofile.html @@ -0,0 +1,353 @@ + + + + + + IAltProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IAltProfile

+
+
+
+
+
+
+
+
+
+

As part of the auto-init output report, this structure + represents the alternate profiles that were not selected + for the profile type.

+
+
+
+
+

Hierarchy

+
    +
  • + IAltProfile +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

altBasePath

+
altBasePath: string
+ +
+
+ +

altProfName

+
altProfName: string
+ +
+
+ +

altProfType

+
altProfType: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlprofileinfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlprofileinfo.html new file mode 100644 index 0000000000..547b46e25d --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlprofileinfo.html @@ -0,0 +1,380 @@ + + + + + + IApimlProfileInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IApimlProfileInfo

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IApimlProfileInfo +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

basePaths

+
basePaths: string[]
+ +
+
+ +

gatewayUrlConflicts

+
gatewayUrlConflicts: {}
+ +
+

Type declaration

+
    +
  • +
    [pluginName: string]: string[]
    +
  • +
+
+
+
+ +

pluginConfigs

+
pluginConfigs: Set<IApimlSvcAttrsLoaded>
+ +
+
+ +

profName

+
profName: string
+ +
+
+ +

profType

+
profType: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html new file mode 100644 index 0000000000..4a8a7e2e4b --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlservice.html @@ -0,0 +1,383 @@ + + + + + + IApimlService | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IApimlService

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IApimlService +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

apiml

+
apiml: { apiInfo: IApimlServiceApiInfo[]; authentication: IApimlServiceAuthentication[]; service: { description: string; homePageUrl: string; title: string } }
+ +
+

Type declaration

+
    +
  • +
    apiInfo: IApimlServiceApiInfo[]
    +
  • +
  • +
    authentication: IApimlServiceAuthentication[]
    +
  • +
  • +
    service: { description: string; homePageUrl: string; title: string }
    +
      +
    • +
      description: string
      +
    • +
    • +
      homePageUrl: string
      +
    • +
    • +
      title: string
      +
    • +
    +
  • +
+
+
+
+ +

instances

+
instances: {}[]
+ +
+
+ +

serviceId

+
serviceId: string
+ +
+
+ +

status

+
status: "DOWN" | "UP"
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlserviceapiinfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlserviceapiinfo.html new file mode 100644 index 0000000000..fec851a37e --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlserviceapiinfo.html @@ -0,0 +1,400 @@ + + + + + + IApimlServiceApiInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IApimlServiceApiInfo

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IApimlServiceApiInfo +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

apiId

+
apiId: string
+ +
+
+ +

basePath

+
basePath: string
+ +
+
+ +

baseUrl

+
baseUrl: string
+ +
+
+ +

defaultApi

+
defaultApi: boolean
+ +
+
+ +

documentationUrl

+
documentationUrl: string
+ +
+
+ +

gatewayUrl

+
gatewayUrl: string
+ +
+
+ +

swaggerUrl

+
swaggerUrl: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlserviceauthentication.html b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlserviceauthentication.html new file mode 100644 index 0000000000..cb4e36a69c --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlserviceauthentication.html @@ -0,0 +1,344 @@ + + + + + + IApimlServiceAuthentication | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IApimlServiceAuthentication

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IApimlServiceAuthentication +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

applid

+
applid: string
+ +
+
+ +

scheme

+
scheme: string
+ +
+
+ +

supportsSso

+
supportsSso: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlsvcattrsloaded.html b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlsvcattrsloaded.html new file mode 100644 index 0000000000..e3478a7264 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iapimlsvcattrsloaded.html @@ -0,0 +1,355 @@ + + + + + + IApimlSvcAttrsLoaded | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IApimlSvcAttrsLoaded

+
+
+
+
+
+
+
+
+
+

Once getPluginApimlConfigs() has processed the loaded ImperativeConfig, + and plugin properties, it returns an array of these structures.

+
+
+
+
+

Hierarchy

+
    +
  • + any +
      +
    • + IApimlSvcAttrsLoaded +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

connProfType

+
connProfType: string
+ +
+
+

Once getPluginApimlConfigs() has processed the loaded ImperativeConfig, + the connProfType will be a required property in the resulting object.

+
+
+
+
+ +

pluginName

+
pluginName: string
+ +
+
+

The plugin name from which these attributes were retrieved. + If retrieved from the core CLI, then the CLI name is used.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iautoinitrpt.html b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iautoinitrpt.html new file mode 100644 index 0000000000..adb82350af --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iautoinitrpt.html @@ -0,0 +1,379 @@ + + + + + + IAutoInitRpt | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IAutoInitRpt

+
+
+
+
+
+
+
+
+
+

This structure is used to form the auto-init output report.

+
+
+
+
+

Hierarchy

+
    +
  • + IAutoInitRpt +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

changeForConfig

+
changeForConfig: string
+ +
+
+ +

configFileNm

+
configFileNm: string
+ +
+
+ +

endingConfig

+
endingConfig: IConfigLayer
+ +
+
+ +

profileRpts

+
profileRpts: IProfileRpt[]
+ +
+
+ +

startingConfig

+
startingConfig: IConfigLayer
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.ibaseprofileoverride.html b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.ibaseprofileoverride.html new file mode 100644 index 0000000000..bc59e8f3bd --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.ibaseprofileoverride.html @@ -0,0 +1,367 @@ + + + + + + IBaseProfileOverride | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IBaseProfileOverride

+
+
+
+
+
+
+
+
+
+

As part of the auto-init output report, this structure + represents profile properties that override properties + defined in the base profile.

+
+
+
+
+

Hierarchy

+
    +
  • + IBaseProfileOverride +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional baseValue

+
baseValue: any
+ +
+
+ +

Optional priorityValue

+
priorityValue: any
+ +
+
+ +

propName

+
propName: string
+ +
+
+ +

secure

+
secure: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iheadercontent.html b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iheadercontent.html new file mode 100644 index 0000000000..53536b3add --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iheadercontent.html @@ -0,0 +1,314 @@ + + + + + + IHeaderContent | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHeaderContent

+
+
+
+
+
+
+
+
+
+

Interface to add index signature to http headers

+
+
+
export
+
+
interface
+

IHeaderContent

+
+
+
+
+
+

Hierarchy

+
    +
  • + IHeaderContent +
  • +
+
+
+

Indexable

+
[key: string]: string
+
+
+

Interface to add index signature to http headers

+
+
+
export
+
+
interface
+

IHeaderContent

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iprofilerpt.html b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iprofilerpt.html new file mode 100644 index 0000000000..8f4a04aa5b --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_core_for_zowe_sdk.iprofilerpt.html @@ -0,0 +1,409 @@ + + + + + + IProfileRpt | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileRpt

+
+
+
+
+
+
+
+
+
+

As part of the auto-init output report, this structure + represents the set of profiles created or modified by + the auto-init command.

+
+
+
+
+

Hierarchy

+
    +
  • + IProfileRpt +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

altProfiles

+
altProfiles: IAltProfile[]
+ +
+
+ +

baseOverrides

+
baseOverrides: IBaseProfileOverride[]
+ +
+
+ +

basePath

+
basePath: string
+ +
+
+ +

changeForProf

+
changeForProf: string
+ +
+
+ +

pluginNms

+
pluginNms: string[]
+ +
+
+ +

profName

+
profName: string
+ +
+
+ +

profType

+
profType: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iapimlsvcattrs.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iapimlsvcattrs.html new file mode 100644 index 0000000000..c4cbc2b5c9 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iapimlsvcattrs.html @@ -0,0 +1,328 @@ + + + + + + IApimlSvcAttrs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IApimlSvcAttrs

+
+
+
+
+
+
+
+
+
+

When a command group or plugin is used with the API Mediation Layer, + the connection properties for communicating to the service associated + with the command group can be retrieved from APIML. These attributes + are used to identify the desired REST service within APIML.

+
+

Information retrieved from APIML using these attributes is then used + to automatically create connection profile properties into a Zowe + team configuration file.

+

Note that the "ibm.zosmf" service apiId is baked into the Zowe CLI. + Therefore, this optional interface need not be specified by a plugin + that requires only a connection to z/OSMF.

+
+
+
+

Hierarchy

+
    +
  • + IApimlSvcAttrs +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

apiId

+
apiId: string
+ +
+
+

The identifier of the REST API to which this command group communicates. + The API ID is defined by the REST service programmer. An example is + "zowe.apiml.apicatalog".

+
+
+
memberof
+

IApimlSvcAttrs

+
+
+
+
+
+ +

Optional connProfType

+
connProfType: string
+ +
+
+

The Zowe-CLI profile type which contains the properties that the command + group uses to connect to its service. The profile type is defined by + the plugin programmer. An example is "db2", which is used by the + zowe-cli-db2-plugin.

+
+

A command group may have multiple profiles, but you specify the profile + in which connection information is maintained. If not specified, the + first profile type defined for the command group will be used. + That is fine if your command group has only one profile type. If you + have more than one profile type, you should really explicitly specify + the correct profile type.

+

When a team configuration file is automatically generated from APIML, + (using the 'zowe config init --apiml' command), a profile of this type + will be created into that generated config file.

+
+
memberof
+

IApimlSvcAttrs

+
+
+
+
+
+ +

Optional gatewayUrl

+
gatewayUrl: string
+ +
+
+

The portion of the URL that directs a REST request to the correct path + for the desired web service. When multiple versions of the same apiId + are hosted on an APIML instance, this attribute identifies the desired + version of the REST API. This attribute is defined by the REST service + programmer. An example is "api/v1". If no gatewayUrl is supplied, but + multiple versions of the REST API exists in APIML, the first instance + of the apiId returned by APIML will be used. You might choose to not + specify a gatewayURL, if your client app supports all available versions + of the associated REST service.

+
+
+
memberof
+

IApimlSvcAttrs

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iargteamconfigloc.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iargteamconfigloc.html new file mode 100644 index 0000000000..20894f9866 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iargteamconfigloc.html @@ -0,0 +1,301 @@ + + + + + + IArgTeamConfigLoc | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IArgTeamConfigLoc

+
+
+
+
+
+
+
+
+
+

Information to identify the arguments corresponding to the team config

+
+
+
+
+

Hierarchy

+
    +
  • + IArgTeamConfigLoc +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional configProperties

+
configProperties: IConfig
+ +
+
+

the config properties

+
+
+
+
+ +

osLocInfo

+
osLocInfo: IProfLocOsLoc
+ +
+
+

the osLoc information

+
+
+
+
+ +

profileName

+
profileName: string
+ +
+
+

the profile name

+
+
+
+
+ +

propName

+
propName: string
+ +
+
+

the property name

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iauthhandlerapi.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iauthhandlerapi.html new file mode 100644 index 0000000000..984bd99f63 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iauthhandlerapi.html @@ -0,0 +1,369 @@ + + + + + + IAuthHandlerApi | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IAuthHandlerApi

+
+
+
+
+
+
+
+
+
+

Auth handler API that provides convenient functions to create a session from + args, and use it to login or logout of an auth service.

+
+
+
+
+

Hierarchy

+
    +
  • + IAuthHandlerApi +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

createSessCfg

+
createSessCfg: (args: ICommandArguments) => ISession
+ +
+
+

Method to create a session config object from CLI arguments. + This is equivalent to the handler method createSessCfgFromArgs.

+
+
+
+

Type declaration

+ +
+
+
+ +

promptParams

+ + +
+
+

Prompting options for adding connection properties. + The properties defaultTokenType and serviceDescription should be defined.

+
+
+
+
+ +

sessionLogin

+
sessionLogin: (session: AbstractSession) => Promise<string>
+ +
+
+

Method to login to authentication service with a session. + This is equivalent to the handler method doLogin.

+
+
+
+

Type declaration

+ +
+
+
+ +

sessionLogout

+
sessionLogout: (session: AbstractSession) => Promise<void>
+ +
+
+

Method to logout of authentication service with a session. + This is equivalent to the handler method doLogout.

+
+
+
+

Type declaration

+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ichainedhandlerargumentmapping.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ichainedhandlerargumentmapping.html new file mode 100644 index 0000000000..adca378dc1 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ichainedhandlerargumentmapping.html @@ -0,0 +1,390 @@ + + + + + + IChainedHandlerArgumentMapping | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IChainedHandlerArgumentMapping

+
+
+
+
+
+
+
+
+
+

Interface describing constructing command line arguments for + chained handlers.

+
+
+
+
+

Hierarchy

+
    +
  • + IChainedHandlerArgumentMapping +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional applyToHandlers

+
applyToHandlers: number[]
+ +
+
+

Which future handlers does this apply to? Optional. + Specify any number of positive integers. The number represents an index ahead of the current handler. + For example, 1 is the next handler and 2 is the handler after next. + You can specify [0] to apply to the current handler, however in that case you must specify "value", + and not "from", since the arguments will be applied before the response object from the handler is available. + If omitted, the mapping applies to the next handler (equivalent to a value of [1] for this field)

+
+
+
memberof
+

IChainedHandlerArgumentMapping

+
+
+
+
+
+ +

Optional from

+
from: string
+ +
+
+

Dot notation property e.g. files[0].filename to copy from the + command response's data field (set via response.data.setObj) of this chained handler to a future chained handler. + If mapFromArguments is specified, the mapping will be from the overall command's arguments + (the command comprised of these chained handlers and mappings).

+
+

Mutually exclusive with 'value'. + The dot notation field is retrieved with the dataobject-parser package.

+
+
memberof
+

IChainedHandlerArgumentMapping

+
+
+
+
+
+ +

Optional mapFromArguments

+
mapFromArguments: boolean
+ +
+
+

If you specify this, values will be copied from the overall command's arguments + instead of the command response of the current handler. + Has no meaning if paired with 'value'

+
+
+
memberof
+

IChainedHandlerArgumentMapping

+
+
+
+
+
+ +

Optional optional

+
optional: boolean
+ +
+
+

Is this mapping optional? + Unless this is true, an error will be thrown if "from" is specified and the specified + field is not found on the command response.

+
+
+
memberof
+

IChainedHandlerArgumentMapping

+
+
+
+
+
+ +

to

+
to: string
+ +
+
+

The name of an argument e.g. "filename" that will be inserted into the "arguments" + field of the handler parameters for the future chained handler. + Required.

+
+
+
memberof
+

IChainedHandlerArgumentMapping

+
+
+
+
+
+ +

Optional value

+
value: any
+ +
+
+

Hard-code a value to pass to the "to" argument field. + Mutually exclusive with "from". + Note: the value should be serializable, since command definitions should be + able to be fully represented in JSON. Values that are not preserved when + doing JSON.parse(JSON.stringify(value)) will cause an error.

+
+
+
memberof
+

IChainedHandlerArgumentMapping

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ichainedhandlerentry.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ichainedhandlerentry.html new file mode 100644 index 0000000000..636b6a2cec --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ichainedhandlerentry.html @@ -0,0 +1,303 @@ + + + + + + IChainedHandlerEntry | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IChainedHandlerEntry

+
+
+
+
+
+
+
+
+
+

A single link in a chain of chained handlers. + Specifies which handler to call and how to direct the output of that handler + into future handlers of the chain.

+
+
+
+
+

Hierarchy

+
    +
  • + IChainedHandlerEntry +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

handler

+
handler: string
+ +
+
+

String path to a module containing a command handler. + exports.default (export default class in Typescript) should be the command handler

+
+
+
memberof
+

IChainedHandlerEntry

+
+
+
+
+
+ +

Optional mapping

+ + +
+
+

When your handler is invoked, you can call response.data.setObj() + If you do, you can map properties of that object to arguments for the next handler, + or a handler further down the chain. See the below interface for more details.

+
+
+
memberof
+

IChainedHandlerEntry

+
+
+
+
+
+ +

Optional silent

+
silent: boolean
+ +
+
+

If you set this to true, this handler will produce no output. + Note: if you specify "true" for the last handler in a chain, the command will not produce the final output.

+
+
+
memberof
+

IChainedHandlerEntry

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icliloadallprofiles.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icliloadallprofiles.html new file mode 100644 index 0000000000..5f3b5ecaf6 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icliloadallprofiles.html @@ -0,0 +1,287 @@ + + + + + + ICliLoadAllProfiles | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICliLoadAllProfiles

+
+
+
+
+
+
+
+
+
+

Optional parameters to profile manager load all profiles

+
+
+
export
+
+
interface
+

ICliLoadAllProfiles

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional noSecure

+
noSecure: boolean
+ +
+
+

If true, do not load secure fields

+
+
+
memberof
+

ILoadAllProfiles

+
+
+
+
+
+ +

Optional typeOnly

+
typeOnly: boolean
+ +
+
+

If true, loads only the profiles of the current instance of the profile + managers "type" - specified when allocating the profile manager.

+
+
+
memberof
+

ILoadAllProfiles

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icliloadprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icliloadprofile.html new file mode 100644 index 0000000000..cda30760f9 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icliloadprofile.html @@ -0,0 +1,368 @@ + + + + + + ICliLoadProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICliLoadProfile

+
+
+
+
+
+
+
+
+
+

Profile Manager "loadProfile" input parameters. Indicates which profile to load (named or default) and if + not finding the profile should be considered and error, etc.

+
+
+
export
+
+
interface
+

ICliLoadProfile

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional failNotFound

+
failNotFound: boolean
+ +
+
+

Under "normal" circumstances, attempting to load a non-existant profile is an error, however, you may indicate + that the profile manager should treat this as a "soft" failure, meaning the promise for the load API will + be fulfilled - with the appropriate status message and no profile.

+
+
+
memberof
+

ILoadProfile

+
+
+
+
+
+ +

Optional loadDefault

+
loadDefault: boolean
+ +
+
+

Load the default profile for the "type" specified in the profile manager instance - if specified, "name" is + ignored.

+
+
+
memberof
+

ILoadProfile

+
+
+
+
+
+ +

Optional loadDependencies

+
loadDependencies: boolean
+ +
+
+

Profiles can have dependencies. Specify "false" if you want to avoid loading the dependencies of this profile. + True is the default.

+
+
+
memberof
+

ILoadProfile

+
+
+
+
+
+ +

Optional name

+
name: string
+ +
+
+

The name of the profile to load - ignored if "loadDefault" is true - the type is indicated by the + instance of the instantiated profile manager.

+
+
+
memberof
+

ILoadProfile

+
+
+
+
+
+ +

Optional noSecure

+
noSecure: boolean
+ +
+
+

If true, fields that indicate "secure" are not loaded. The properties will still be present in the profiles + loaded with a value of "securely_stored".

+
+
+
memberof
+

ILoadProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandarguments.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandarguments.html new file mode 100644 index 0000000000..7e12003ca9 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandarguments.html @@ -0,0 +1,291 @@ + + + + + + ICommandArguments | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandArguments

+
+
+
+
+
+
+
+
+
+

Imperative command arguments. Originally created by Yargs parse and + completed by Imperative. Passed to command handlers.

+
+

The object contains two properties always present ($0 and _) and the rest of + the object will contain the option names, in both camel, kebab, and alias as + the keys with their values being plugged in by from CLI options, ENV vars, + profiles, or default values.

+
+
+
+

Hierarchy

+
    +
  • + ICommandArguments +
  • +
+
+
+

Indexable

+
[key: string]: any
+
+
+

Index signature.

+
+

The object contains two properties always present ($0 and _) and the rest of + the object will contain the option names, in both camel, kebab, and alias as + the keys with their values being plugged in by from CLI options, ENV vars, + profiles, or default values.

+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

$0

+
$0: string
+ +
+
+

The "executable" - normally the main entry point of the node application.

+
+
+
example
+

"main.js"

+
+
+
+
+
+ +

_

+
_: string[]
+ +
+
+

The set of command segments and positional operands in an array.

+
+
+
example
+

["create", "file", "text.txt"]

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommanddefinition.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommanddefinition.html new file mode 100644 index 0000000000..23bce3ab45 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommanddefinition.html @@ -0,0 +1,778 @@ + + + + + + ICommandDefinition | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandDefinition

+
+
+
+
+
+
+
+
+
+

Interface describing the syntax and behavior definition of a command + or group of commands

+
+
+
+
+

Hierarchy

+
    +
  • + ICommandDefinition +
  • +
+
+
+

Indexable

+
[key: string]: any
+
+
+

Index signature

+
+
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional aliases

+
aliases: string[]
+ +
+
+

Aliases - any number of single or more character aliases can be specified.

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional chainedHandlers

+
chainedHandlers: IChainedHandlerEntry[]
+ +
+
+

Build this command from multiple handlers chained together, remapping the response + to arguments for future handlers in the command.

+
+

Limitations of chained handlers include:

+
    +
  • The syntax of the command for each handler is not validated, since the full definition is not provided
  • +
  • You can only map arguments from the "data" field of the command response, so whatever you need + to pass to a future handler in the chain must be passed to response.data.setObj
  • +
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional children

+
children: ICommandDefinition[]
+ +
+
+

The Children for this command - used when the type is provider or group. Use the children to build complex + nested syntaxes - however bright modules must follow the prescribed command syntax structure for Brightside.

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional customize

+
customize: any
+ +
+
+

The command handlers are passed the definition document for the command. You can place any additional + "custom" definition information here.

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional deprecatedReplacement

+
deprecatedReplacement: string
+ +
+
+

If this property exists, the command is deprecated. The property value + is a string that identifies the replacement command. It is used in a + deprecation message similar to the following: + This command is deprecated. + Recommended replacement: value_of_deprecatedReplacement_goes_here

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

description

+
description: string
+ +
+
+

The description - keep group descriptions "small" and include lengthier descriptions for "commands".

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional enableStdin

+
enableStdin: boolean
+ +
+
+

If true, stdin will automatically be read before the handler of this command is invoked.

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional examples

+ + +
+
+

The set of examples displayed in the help for this command.

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional experimental

+
experimental: boolean
+ +
+
+

Is this command experimental? If you set this to true, the command will + be marked with help text indicating that it is experimental. If this command + is of type "group" all descendant commands will be marked experimental + as well.

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional handler

+
handler: string
+ +
+
+

The handler for this command - this is a string literal that is used on the "require" statement to load the + command handler - The handler itself must implement ICommandHandler. A string is used over an actual + instance because we do not want the handler (and its required dependencies) to be loaded before it is issued.

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional mustSpecifyOne

+
mustSpecifyOne: string[]
+ +
+
+

Must specify one indicates that you must specify one of the options listed.

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

The command or group name

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional onlyOneOf

+
onlyOneOf: string[]
+ +
+
+

Only one of the listed options can be specified

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional options

+ + +
+
+

The options to be exposed on the command.

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional outputFormatOptions

+
outputFormatOptions: boolean
+ +
+
+

Enable output format options (e.g. "--response-format-type"). The output format options are applied to data + that is presented to the handler response format APIs (see IHandlerResponseApi, "format" property). The intent + of of the output format options:

+
+
    +
  1. Simplify the code in a command handler. A "common" use-case for handler output is printing tables (or lists) + of JSON objects/data OR a single JSON response object.

    +
  2. +
  3. Passing the data described in (1) to the handler response format API and enabling the format options gives + the user full control over the output format. They can choose to output an array of JSON objects as a table + OR a list of prettified objects. The use can also choose to include table headers and filter fields. The user + can also reduce the output of a table to a single column (or a JSON object to a single property) eliminating + the need to manually code options such as "--only-print-this-one-field"

    +
  4. +
+

See the "ICommandOutputFormat" JSDoc for details on the format types.

+

The options enabled:

+

--response-format-type [table|list|object|string]

+

Allows the user to control the output format of the data. See the "ICommandOutputFormat" interface for details.

+

--response-format-filter [array of fields]

+

Allows the user to include only the fields specified in the filter array.

+

--response-format-header [boolean]

+

Allows the user to optionally include the header with a table.

+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional passOn

+ + +
+
+

Pass on attributes of the current definition node to children

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional positionals

+ + +
+
+

The positional arguments to be exposed on the command.

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional profile

+ + +
+
+

Auto-loading of profile specifications - see the interface definition for more details.

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional stdinOptionDescription

+
stdinOptionDescription: string
+ +
+
+

The description for the stdin option - used if enableStdin is true

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

Optional summary

+
summary: string
+ +
+
+

A shorter (~one line) description of your command

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+ +

type

+ + +
+
+

This documents segment type - either "group" or "command". See the type definition for more detail.

+
+
+
memberof
+

ICommandDefinition

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommanddefinitionpasson.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommanddefinitionpasson.html new file mode 100644 index 0000000000..53023e6f95 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommanddefinitionpasson.html @@ -0,0 +1,313 @@ + + + + + + ICommandDefinitionPassOn | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandDefinitionPassOn

+
+
+
+
+
+
+
+
+
+

Allows you to "pass on" traits from the current definition to all children (assuming they meet the criteria + specified). For example, assume you have a "group" that contains a set of children (commands) that all require the + same profile type. You can "pass on" the profile attribute/trait from the parent or provide the attribute/trait on + the parent that should be passed on to the children (if you do NOT want the trait to apply directly to the parent + itself).

+
+

Note that "pass on" attributes are accumulated if a child node wishes to pass on additional traits to it's + children.

+
+
+
+

Hierarchy

+
    +
  • + ICommandDefinitionPassOn +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional ignoreNodes

+ + +
+
+

You can ignore nodes with a particular name and type. + If name is omitted, then you will ignore all nodes of "type" - and same for if type is omitted.

+
+
+
+
+ +

Optional merge

+
merge: boolean
+ +
+
+

If the value is complex and you do NOT want to completely override the child's value, you can indicate merge. For + example, you can pass on option definitions (as an array) and "push" the passed on options on the child's options + property, rather than completely overwrite any existing options.

+
+
+
+
+ +

property

+
property: string
+ +
+
+

Indicates the property that you wish to "pass on" to all children that meet + the criteria (see applyToNodeTypes and ignoreNodesNamed). For example, you can specify "enabledStdin" + to set the value of "enableStdin" for all children of the definition.

+
+
+
+
+ +

Optional value

+
value: any
+ +
+
+

The value to apply to the property. If the value is omitted, it will take the value from the current node + (parent) and pass that on to each child.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommanddefinitionpassonignore.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommanddefinitionpassonignore.html new file mode 100644 index 0000000000..9bd85278dd --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommanddefinitionpassonignore.html @@ -0,0 +1,246 @@ + + + + + + ICommandDefinitionPassOnIgnore | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandDefinitionPassOnIgnore

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandexampledefinition.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandexampledefinition.html new file mode 100644 index 0000000000..cc83cd3f1d --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandexampledefinition.html @@ -0,0 +1,284 @@ + + + + + + ICommandExampleDefinition | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandExampleDefinition

+
+
+
+
+
+
+
+
+
+

Example command definition - used on command definitions to present examples for the user in the help.

+
+
+
+
+

Hierarchy

+
    +
  • + ICommandExampleDefinition +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+

The example description - what does it do?

+
+
+
+
+ +

options

+
options: string
+ +
+
+

Options for the example command - should be copy/paste-able - besides variable data - i.e. user name

+
+
+
+
+ +

Optional prefix

+
prefix: string
+ +
+
+

Text to prepend to the command and options in the example. + Useful for commands that read stdin + e.g. "echo hello |"

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandhandler.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandhandler.html new file mode 100644 index 0000000000..b2ca10774a --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandhandler.html @@ -0,0 +1,285 @@ + + + + + + ICommandHandler | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandHandler

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandHandler +
  • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

process

+ +
    +
  • + +
    +
    +

    Process method - the handler for this command invocation - processes the command and populates the response + object as needed. Returns a promise that is expected to be fulfilled (never manually rejected).

    +
    +
    +

    Parameters

    + +

    Returns Promise<void>

    +

    : The promise to be fulfilled when the command processing is complete.

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandhandlerrequire.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandhandlerrequire.html new file mode 100644 index 0000000000..fc91720530 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandhandlerrequire.html @@ -0,0 +1,246 @@ + + + + + + ICommandHandlerRequire | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandHandlerRequire

+
+
+
+
+
+
+
+
+
+

This interface defines what the expected module.exports variable should be + for any defined handlers by an implementing cli.

+
+
+
+
+

Hierarchy

+
    +
  • + ICommandHandlerRequire +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

default

+ + +
+
+

In TypeScript, doing an 'export default class' puts the export in exports.default. This takes + advantage of TypeScript language constructs and cleans up the code a bit.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandhandlerresponsechecker.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandhandlerresponsechecker.html new file mode 100644 index 0000000000..9a20d82774 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandhandlerresponsechecker.html @@ -0,0 +1,245 @@ + + + + + + ICommandHandlerResponseChecker | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandHandlerResponseChecker

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandhandlerresponsevalidator.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandhandlerresponsevalidator.html new file mode 100644 index 0000000000..73a3e76353 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandhandlerresponsevalidator.html @@ -0,0 +1,245 @@ + + + + + + ICommandHandlerResponseValidator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandHandlerResponseValidator

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandloadprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandloadprofile.html new file mode 100644 index 0000000000..7ae5e1768a --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandloadprofile.html @@ -0,0 +1,353 @@ + + + + + + ICommandLoadProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandLoadProfile

+
+
+
+
+
+
+
+
+
+

Command profile loader internal parameters. Indicates the profile to be loaded (by name) and + other options/control parameters.

+
+
+
export
+
+
interface
+

ICommandLoadProfile

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandLoadProfile +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

loadDefault

+
loadDefault: boolean
+ +
+
+

Load the default profile for the group. If this option is specified, name is ignored.

+
+
+
memberof
+

ICommandLoadProfile

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

The name of the profile to load for the type specified.

+
+
+
memberof
+

ICommandLoadProfile

+
+
+
+
+
+ +

optional

+
optional: boolean
+ +
+
+

Indicates that a failure to load this profile is not a problem.

+
+
+
memberof
+

ICommandLoadProfile

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

The type of the profile to load.

+
+
+
memberof
+

ICommandLoadProfile

+
+
+
+
+
+ +

userSpecified

+
userSpecified: boolean
+ +
+
+

Indicates that the user specifically named this profile to be loaded (not a default, etc.)

+
+
+
memberof
+

ICommandLoadProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandoptionallowablevalues.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandoptionallowablevalues.html new file mode 100644 index 0000000000..484736b58d --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandoptionallowablevalues.html @@ -0,0 +1,276 @@ + + + + + + ICommandOptionAllowableValues | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandOptionAllowableValues

+
+
+
+
+
+
+
+
+
+

Interface describing what values are allowable + for a particular option.

+
+
+
+
+

Hierarchy

+
    +
  • + ICommandOptionAllowableValues +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional caseSensitive

+
caseSensitive: boolean
+ +
+
+

Should these values be compared in a case sensitive manner?

+
+
+
memberof
+

ICommandOptionAllowableValues

+
+
+
+
+
+ +

values

+
values: string[]
+ +
+
+

Regular expressions for values that the user can specify for this option

+
+

new RegExp(value).test(theValueSpecifiedByUser) will be called during syntax validation. + If none of the values match, the user will get a syntax error.

+
+
memberof
+

ICommandOptionAllowableValues

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandoptiondefinition.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandoptiondefinition.html new file mode 100644 index 0000000000..4534880af0 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandoptiondefinition.html @@ -0,0 +1,679 @@ + + + + + + ICommandOptionDefinition | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandOptionDefinition

+
+
+
+
+
+
+
+
+
+

Used on a command definition to define option flags.

+
+
+
+
+

Hierarchy

+
    +
  • + ICommandOptionDefinition +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional absenceImplications

+
absenceImplications: string[]
+ +
+
+

Not specifying these options implies that you should specify + all options listed in "absenceImplications".

+
+

e.g. if the user does not specify "vacation" then they must specify --job and --hours

+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional aliases

+
aliases: string[]
+ +
+
+

Aliases for your option. These allow the user to specify + the option with a shorter or otherwise alternate name + e.g. name: "puppy", aliases: ["p", "pup"] - + the user can specify --puppy, -p, or --pup

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional allowableValues

+ + +
+
+

What values can be specified for this option? + See the type below for more details.

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional arrayAllowDuplicate

+
arrayAllowDuplicate: boolean
+ +
+
+

If the type is array, this option defines if duplicate values in array + are allowed. Default is true.

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional conflictsWith

+
conflictsWith: string[]
+ +
+
+

Defines which options this one conflicts with.

+
+
+
example
+
A and B can't be specified together + const def: ICommandOptionDefinition = + { + name: "B", + description + conflictsWith: ["A"] + }
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional defaultValue

+
defaultValue: any
+ +
+
+

If the user doesn't specify this option, you can specify a default value here + that will be filled in automatically.

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

description

+
description: string
+ +
+
+

The description of your option - displayed in the help text + for your command.

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional group

+
group: string
+ +
+
+

The group/category for this option. + Options with the same group on the same command are grouped together + under a heading with this text.

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional hidden

+
hidden: boolean
+ +
+
+

Option is hidden from help

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional implies

+
implies: string[]
+ +
+
+

If this option is specified, all options whose name appear in the "implies" + field must also be specified. + e.g. if this option is "vacation", and ["seat", "meal"] is the value for "implies", + then the user will get a syntax error if they specify --vacation but not --seat and --meal

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional impliesOneOf

+
impliesOneOf: string[]
+ +
+
+

If this option is specified, at least one of the options whose name appear in the "impliesOneOf" + field must also be specified. + e.g. if this option is "vacation", and ["seat", "meal"] is the value for "impliesOneOf", + then the user will get a syntax error if they specify --vacation but not either --seat or --meal

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

The canonical/primary name for your option. + This is the first form of the option shown to the user and is + generally how you should refer to your option in documentation and programmatically.

+
+

Note: yargs automatically places the values for --hyphenated-options in a camelCase format + after parsing the command line arguments, so you would be able to access params.arguments.hyphenatedOptions + from your handler as well as params.arguments["hyphenated-options"]'

+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional numericValueRange

+
numericValueRange: [number, number]
+ +
+
+

Acceptable value range for number type options. + the first number is the minimum. the second is the maximum + So the value specified by the user must be min <= value <= max

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional required

+
required: boolean
+ +
+
+

Is this option required? If it's required and the user + does not specify it, they will get a syntax error.

+
+

Note: if you give a defaultValue to an option, it will always be + considered to have been specified.

+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional stringLengthRange

+
stringLengthRange: [number, number]
+ +
+
+

Acceptable length range for string type options. + the first number is the minimum. the second is the maximum + So the length specified by the user must be min <= length <= max

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

type

+ + +
+
+

What type of value will the user specify for this option?

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+
+ +

Optional valueImplications

+
valueImplications: {}
+ +
+
+

If the user specifies a certain value for this option, + then they must also specify other options (similar to a conditional "implies")

+
+
+
memberof
+

ICommandOptionDefinition

+
+
+
+
+

Type declaration

+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandoptionvalueimplications.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandoptionvalueimplications.html new file mode 100644 index 0000000000..4a8d896819 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandoptionvalueimplications.html @@ -0,0 +1,276 @@ + + + + + + ICommandOptionValueImplications | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandOptionValueImplications

+
+
+
+
+
+
+
+
+
+

Interface describing syntax validation rule where specifying a certain + value means that the user must also specify other options

+
+
+
+
+

Hierarchy

+
    +
  • + ICommandOptionValueImplications +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

impliedOptionNames

+
impliedOptionNames: string[]
+ +
+
+

What option names are implied if the value in question is specified

+
+
+
memberof
+

ICommandOptionValueImplications

+
+
+
+
+
+ +

Optional isCaseSensitive

+
isCaseSensitive: boolean
+ +
+
+

Is the value case sensitive? + If yes, the strings will be compared with "===". + Otherwise they will be uppercased before comparing

+
+
+
memberof
+

ICommandOptionValueImplications

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandoutputformat.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandoutputformat.html new file mode 100644 index 0000000000..4731275f3a --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandoutputformat.html @@ -0,0 +1,335 @@ + + + + + + ICommandOutputFormat | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandOutputFormat

+
+
+
+
+
+
+
+
+
+

The output format object is returned from a successful command handler to dictate how the output for the + command should be formatted. This is an optional feature for Imperative and handlers are not required to + return this object (they can format their own output).

+
+

These properties represent the defaults for the handler. If the command definition includes the output format + options, the options take precedence over the default values (see ICommandDefinition for details).

+
+
export
+
+
interface
+

ICommandOutput

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandOutputFormat +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional fields

+
fields: string[]
+ +
+
+

If the response is an object (or an array of objects) these are the top level properties to keep. For example, + if an array of homogeneous objects are returned in the output, the fields that are NOT specified in this array + are removed/deleted from each object.

+
+
+
memberof
+

ICommandOutput

+
+
+
+
+
+ +

format

+ + +
+
+

The output format type (see the type for details). In most cases, any data type returned (on the output property) + can be formatted according to the type specified here.

+
+
+
memberof
+

ICommandOutput

+
+
+
+
+
+ +

Optional header

+
header: boolean
+ +
+
+

If response format table is specified, print the table headings

+
+
+
memberof
+

ICommandOutput

+
+
+
+
+
+ +

output

+
output: any
+ +
+
+

The output data to format. Common output data includes arrays of strings/objects, JSON objects, strings.

+
+
+
memberof
+

ICommandOutputFormat

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandpositionaldefinition.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandpositionaldefinition.html new file mode 100644 index 0000000000..e741e44bb2 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandpositionaldefinition.html @@ -0,0 +1,376 @@ + + + + + + ICommandPositionalDefinition | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandPositionalDefinition

+
+
+
+
+
+
+
+
+
+

Positional option definition - used on a command definition to define positional operands. + Positional operands do not use --dashes. They are values specified after the full command string + e.g. group group group group command mypositional --dash-option

+
+
+
+
+

Hierarchy

+
    +
  • + ICommandPositionalDefinition +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+

The description for the positional operand - used in the help and error messages.

+
+
+
memberof
+

ICommandPositionalDefinition

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

The name of the positional operand.

+
+

This name cannot contain a dash (-) or else the positional argument will not function properly. + This is a limitation of yargs.

+

Appending "..." to the end of a name will allow for a space delimited + array of arguments. So if you specify name = "abcd..." and then + "a b c d" is specified for the positional argument, abcd = ["a", "b", "c", "d"]

+
+
memberof
+

ICommandPositionalDefinition

+
+
+
+
+
+ +

Optional regex

+
regex: string
+ +
+
+

A regex that will be used to match the input for this positional for validation.

+
+
+
memberof
+

ICommandPositionalDefinition

+
+
+
+
+
+ +

Optional required

+
required: boolean
+ +
+
+

True if this positional is required.

+
+
+
memberof
+

ICommandPositionalDefinition

+
+
+
+
+
+ +

Optional stringLengthRange

+
stringLengthRange: [number, number]
+ +
+
+

What is an acceptable length range for your positional? e.g. between 1 and 8 characters: [1,8]

+
+
+
memberof
+

ICommandPositionalDefinition

+
+
+
+
+
+ +

type

+ + +
+
+

The option type - used to validate that the user provided value is acceptable.

+
+
+
memberof
+

ICommandPositionalDefinition

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprepared.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprepared.html new file mode 100644 index 0000000000..2a82f4ba68 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprepared.html @@ -0,0 +1,277 @@ + + + + + + ICommandPrepared | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandPrepared

+
+
+
+
+
+
+
+
+
+

Command Processor prepare response.

+
+
+
export
+
+
interface
+

ICommandPrepared

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandPrepared +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

args

+ + +
+
+

Imperative arguments object. Starts with arguments passed parsed by + Yargs as a base and fills in the rest from ENV/profile/defaults. + Eventually passed to handlers.

+
+
+
+
+ +

profiles

+
profiles: CommandProfiles
+ +
+
+

The profile map object for all profiles loaded for commands.

+
+
+
memberof
+

ICommandPrepared

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprocessorparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprocessorparms.html new file mode 100644 index 0000000000..8fcf92bb45 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprocessorparms.html @@ -0,0 +1,475 @@ + + + + + + ICommandProcessorParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandProcessorParms

+
+
+
+
+
+
+
+
+
+

Parameters to create an instance of the Command Processor. Contains the command definition (for the command + being executed) and help, profiles, etc.

+
+
+
export
+
+
interface
+

ICommandProcessorParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandProcessorParms +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

commandLine

+
commandLine: string
+ +
+
+

The command line.

+
+
+
memberof
+

ICommandProcessorParms

+
+
+
+
+
+ +

Optional config

+
config: Config
+ +
+
+

Config object used to load profiles from active config layers.

+
+
+
memberof
+

ICommandProcessorParms

+
+
+
+
+
+ +

Optional daemonContext

+
daemonContext: IDaemonContext
+ +
+
+

The context object defined when in daemon mode.

+
+
+
memberof
+

ICommandProcessorParms

+
+
+
+
+
+ +

definition

+
definition: ICommandDefinition
+ +
+
+

The command definition node for the command being executed. The command definition is assumed to have a handler + (or handlers).

+
+
+
memberof
+

ICommandProcessorParms

+
+
+
+
+
+ +

envVariablePrefix

+
envVariablePrefix: string
+ +
+
+

Environmental variable name prefix used to construct configuration environmental variables.

+
+
+
memberof
+

ICommandProcessorParms

+
+
+
+
+
+ +

Optional fullDefinition

+
fullDefinition: ICommandDefinition
+ +
+
+

All ancestors (parents) of the command definition for the command being executed. Used in help generation.

+
+
+
memberof
+

ICommandProcessorParms

+
+
+
+
+
+ +

helpGenerator

+
helpGenerator: IHelpGenerator
+ +
+
+

The help generator for the command being executed.

+
+
+
memberof
+

ICommandProcessorParms

+
+
+
+
+
+ +

profileManagerFactory

+ + +
+
+

The profile manager factory allows the command processor to obtain an instance of the profile manager for + the command being issued.

+
+
+
memberof
+

ICommandProcessorParms

+
+
+
+
+
+ +

promptPhrase

+
promptPhrase: string
+ +
+
+

The phrase used to indicate the user wants to enter the value of an argument in a hidden text prompt

+
+
+
memberof
+

ICommandProcessorParms

+
+
+
+
+
+ +

rootCommandName

+
rootCommandName: string
+ +
+
+

The root command name for the CLI - used in help generation, etc.

+
+
+
memberof
+

ICommandProcessorParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofile.html new file mode 100644 index 0000000000..b27945fe21 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofile.html @@ -0,0 +1,314 @@ + + + + + + ICommandProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandProfile

+
+
+
+
+
+
+
+
+
+

Profile load specifications - causes profiles to auto-load for this command and will cause options to be + exposed on the command for the user to specify the desired profile by name. + Profiles specified by the user on the command line always take precedence over defaults.

+
+
+
export
+
+
interface
+

ICommandProfile

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandProfile +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional optional

+
optional: string[]
+ +
+
+

An array of profile "types" that are optional for the execution of this command. + Imperative will automatically attempt to load (the default OR the profile specified by name on the CLI). + If a profile of an optional type cannot be found, the command can still continue. It is the responsiblity of the + handler (for which this profile specification is defined) to properly handle an optional profile not be present + when the handler is invoked.

+
+
+
memberof
+

ICommandProfile

+
+
+
+
+
+ +

Optional required

+
required: string[]
+ +
+
+

An array of profile "types" that are required for the execution of this command. + Imperative will automatically attempt to load (the default OR the profile specified by name on the CLI). + If a profile of a required type cannot be found, the command will fail.

+
+
+
memberof
+

ICommandProfile

+
+
+
+
+
+ +

Optional suppressOptions

+
suppressOptions: string[]
+ +
+
+

An array of profile "types" to suppress automatic generation of options on the command. By default, Imperative + will generate an CLI option in the form "---profile" for each required & optional profile specified on this + object.

+
+
+
memberof
+

ICommandProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileauthconfig.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileauthconfig.html new file mode 100644 index 0000000000..30e2c83dba --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileauthconfig.html @@ -0,0 +1,295 @@ + + + + + + ICommandProfileAuthConfig | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandProfileAuthConfig

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandProfileAuthConfig +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

handler

+
handler: string
+ +
+
+

Path to the handler for the authentication service. + The handler should inherit from Imperative BaseAuthHandler.

+
+
+
+
+ +

Optional login

+ + +
+
+

Command properties for auth login <serviceName>

+
+
+
+
+ +

Optional logout

+ + +
+
+

Command properties for auth logout <serviceName>

+
+
+
+
+ +

serviceName

+
serviceName: string
+ +
+
+

Name of the authentication service

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileautoinitconfig.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileautoinitconfig.html new file mode 100644 index 0000000000..19f7c139bd --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileautoinitconfig.html @@ -0,0 +1,295 @@ + + + + + + ICommandProfileAutoInitConfig | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandProfileAutoInitConfig

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandProfileAutoInitConfig +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional autoInit

+ + +
+
+

Command properties for config auto-init

+
+
+
+
+ +

handler

+
handler: string
+ +
+
+

Path to the handler for the authentication service. + The handler should inherit from Imperative BaseAuthHandler.

+
+
+
+
+ +

Optional profileType

+
profileType: string
+ +
+
+

The type of profile associated with the provider, if any

+
+
+
+
+ +

provider

+
provider: string
+ +
+
+

The provider giving connection information and details for the automatically generated config

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileloaderparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileloaderparms.html new file mode 100644 index 0000000000..5e6548c374 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileloaderparms.html @@ -0,0 +1,305 @@ + + + + + + ICommandProfileLoaderParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandProfileLoaderParms

+
+
+
+
+
+
+
+
+
+

Control parameters for the command profile loader.

+
+
+
export
+
+
interface
+

ICommandProfileLoaderParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandProfileLoaderParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

commandDefinition

+
commandDefinition: ICommandDefinition
+ +
+
+

The command definition document which contains the profile specifications for the command.

+
+
+
memberof
+

ICommandProfileLoaderParms

+
+
+
+
+
+ +

Optional logger

+
logger: Logger
+ +
+
+

Optional logger instance - if not supplied, then Logger.getImperativeLogger() is used.

+
+
+
memberof
+

ICommandProfileLoaderParms

+
+
+
+
+
+ +

profileManagerFactory

+ + +
+
+

The profile Manager factory to create profile manager instances depending on the profile types required + by the command.

+
+
+
memberof
+

ICommandProfileLoaderParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileproperty.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileproperty.html new file mode 100644 index 0000000000..b24638f214 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileproperty.html @@ -0,0 +1,373 @@ + + + + + + ICommandProfileProperty | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandProfileProperty

+
+
+
+
+
+
+
+
+
+

Extended version of a team profile schema property that can include option definitions + for auto-generated commands.

+
+
+
export
+
+
interface
+

ICommandProfileProperty

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional includeInTemplate

+
includeInTemplate: boolean
+ +
+
+

Should this property be defined in a new config JSON template?

+
+
+
memberof
+

IProfileProperty

+
+
+
+
+
+ +

Optional items

+
items: any
+ +
+
+ +

Optional optionDefinition

+
optionDefinition: ICommandOptionDefinition
+ +
+
+

This option definition will be used to auto-generate profile commands. + This is the same type used by normal Imperative command definitions.

+
+
+
+
+ +

Optional optionDefinitions

+
optionDefinitions: ICommandOptionDefinition[]
+ +
+
+ +

Optional properties

+
properties: any
+ +
+
+

Nested properties e.g. banana.origin.zipcode, banana.origin.country

+
+
+
+
+ +

Optional secure

+
secure: boolean
+ +
+
+

Indicates if the given property should be securely stored

+
+
+
+
+ +

type

+
type: string | string[]
+ +
+
+

See ICommandProfileProperty.ts for how to include option definitions + on your schema for auto-generated commands

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileschema.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileschema.html new file mode 100644 index 0000000000..74fa9c0731 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofileschema.html @@ -0,0 +1,387 @@ + + + + + + ICommandProfileSchema | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandProfileSchema

+
+
+
+
+
+
+
+
+
+

Externally exposed version of the profile schema with command options for auto-generated commands

+
+
+
export
+
+
interface
+

ICommandProfileSchema

+
+
+
+
+
+

Hierarchy

+ +
+
+

Indexable

+
[key: string]: any
+
+
+

Any other advanced options available from the JSON schema specification + http://json-schema.org/latest/json-schema-validation.html

+
+
+
export
+
+
interface
+

ICommandProfileSchema

+
+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+

A description of your type of profile

+
+
+
+
+ +

properties

+
properties: {}
+ +
+
+

Command version of the properties field on the schema

+
+
+
+

Type declaration

+
    +
  • +
    [key: string]: ICommandProfileProperty
    +
    +
    +

    General mapping of property name to an ICommandProfileProperty object. + ICommandProfileProperty is the same as IProfileProperty except + that it can contain option definitions for auto-generated commands

    +
    +
    +
  • +
+
+
+
+ +

Optional required

+
required: string[]
+ +
+
+

An array of properties that must be present in the finished profile. + If any of these fields are missing, profile validation will fail.

+
+
+
+
+ +

title

+
title: string
+ +
+
+

A short, descriptive title of your profile type

+
+
+
+
+ +

type

+
type: string
+ +
+
+

Specify "object". This is not the type name + of the profile, but rather a description of the type of data structure (e.g. string, + array). Your profile will be an object with one or more properties.

+
+
+
+
+ +

Optional version

+
version: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html new file mode 100644 index 0000000000..a466230e60 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandprofiletypeconfiguration.html @@ -0,0 +1,470 @@ + + + + + + ICommandProfileTypeConfiguration | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandProfileTypeConfiguration

+
+
+
+
+
+
+
+
+
+

Cmd packages additions to the profile manager type configuration document. Used by the CliProfileManager. Allows + profiles to be built from command arguments. See the "CliProfileManager" for more information.

+
+
+
export
+
+
interface
+

ICommandProfileTypeConfiguration

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional authConfig

+ + +
+
+

Configuration for authentication services to associate with this profile type.

+
+
+
+
+ +

Optional createProfileExamples

+
createProfileExamples: ICommandExampleDefinition[]
+ +
+
+

Examples to be displayed in the help text for the auto generated create profile command.

+
+
+
memberof
+

IProfileTypeConfiguration

+
+
+
+
+
+ +

Optional createProfileFromArgumentsHandler

+
createProfileFromArgumentsHandler: string
+ +
+
+

A handler module which Imperative will require(). + The module's default export should be a handler that calls + appendResponseObject on the provided commandParameters.response + You do NOT have to implement writing the profile to disk -- you only have to produce + the final profile object that you would like to be written.

+
+

This is only required if finished profile can't be created directly from the arguments, e.g. + if you have --user and --password and need to always transform it into a basic auth

+

If omitted, Imperative will just write all fields present from the schema into the profile + without requiring a module

+
+
memberof
+

IProfileTypeConfiguration

+
+
+
+
+
+ +

Optional dependencies

+
dependencies: IProfileDependency[]
+ +
+
+

The profile dependency specification. Indicates the required or optional profiles that a profile is depedent + on. Dependencies are written as part of the profile, but you do NOT need to specify dependencies in your + schema document - this is automatically generated based on your specifications.

+
+
+
memberof
+

IProfileTypeConfiguration

+
+
+
+
+
+ +

schema

+ + +
+
+

The JSON schema document. The schema document provides a way to enforce the contents of a profile. The schema + conforms exactly to the JSON schema specification. You must supply all properties you would like validated + for correctness on the schema, except for "dependencies". Dependency schema checking is generated automatically + if you populate the dependencies property of this document.

+
+
+
+
+ +

type

+
type: string
+ +
+
+

The name of the profile "type" (e.g. "banana"). The type should be indicative of the profile contents (defined + by the profile schema on this document). A "type" is analogous to a category.

+
+
+
memberof
+

IProfileTypeConfiguration

+
+
+
+
+
+ +

Optional updateProfileExamples

+
updateProfileExamples: ICommandExampleDefinition[]
+ +
+
+

Examples to be displayed in the help text for the auto generated update profile command.

+
+
+
memberof
+

IProfileTypeConfiguration

+
+
+
+
+
+ +

Optional updateProfileFromArgumentsHandler

+
updateProfileFromArgumentsHandler: string
+ +
+
+

The module's default export should be a handler that calls appendResponseObject on the provided + commandParameters.response You do NOT have to implement writing the profile to disk -- you only have to produce + the final profile object that you would like to be written.

+
+

This is only required if finished updated profile can't be created directly from the arguments, e.g. + if certain fields that the user might specify mean that other fields should be deleted or updated.

+

If omitted, Imperative will load the old profile, overwrite any fields specified by the user, + and write the updated profile to disk.

+
+
memberof
+

IProfileTypeConfiguration

+
+
+
+
+
+ +

Optional validationPlanModule

+
validationPlanModule: string
+ +
+
+

Path to a module that contains an object that matches the interface IProfileValidationPlan. This is optional, + but if provided a "validate profile" command will be generated to give the user a report on the validity of + their profile.

+
+
+
memberof
+

IProfileTypeConfiguration

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandresponse.html new file mode 100644 index 0000000000..eb37f635ba --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandresponse.html @@ -0,0 +1,408 @@ + + + + + + ICommandResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandResponse

+
+
+
+
+
+
+
+
+
+

Command response object built by the command processor (and command handler). The response object is always + built internally, but displayed to the command issuer if response-format-json is specified.

+
+

For handlers, see the HandlerResponse (IHandlerResponseApi) for the public APIs used to by handlers to create + this response.

+
+
export
+
+
interface
+

ICommandResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional data

+
data: any
+ +
+
+

Handlers (and help, etc.) can choose to append a data object to the response. Not displayed to the console + unless response format JSON is specified.

+
+
+
memberof
+

ICommandResponse

+
+
+
+
+
+ +

Optional error

+ + +
+
+

Error object automatically appended by the command processor when a handler rejects the promise. Contains the + stack and other messages to help diagnosis. Not displayed to the console unless response format JSON is specified.

+
+
+
memberof
+

ICommandResponse

+
+
+
+
+
+ +

exitCode

+
exitCode: number
+ +
+
+

Requested exit code for the process when your command is complete. + If this is not specified, the default is 0 for successful commands and 1 for failed commands + according to the value of the above "success" field.

+
+
+
memberof
+

ICommandResponse

+
+
+
+
+
+ +

message

+
message: string
+ +
+
+

Message appended by the handlers. The message is not displayed on the console, only displayed if response format + JSON is indicated.

+
+
+
memberof
+

ICommandResponse

+
+
+
+
+
+ +

Optional stderr

+
stderr: Buffer
+ +
+
+

The stderr from the command. Buffered regardless of response format specification.

+
+
+
memberof
+

ICommandResponse

+
+
+
+
+
+ +

Optional stdout

+
stdout: Buffer
+ +
+
+

The stdout from the command. Buffered regardless of response format specification.

+
+
+
memberof
+

ICommandResponse

+
+
+
+
+
+ +

success

+
success: boolean
+ +
+
+

Overall command success flag. True indicates that the command handler/processor/help was successful.

+
+
+
memberof
+

ICommandResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandresponseapi.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandresponseapi.html new file mode 100644 index 0000000000..00bb005bd1 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandresponseapi.html @@ -0,0 +1,503 @@ + + + + + + ICommandResponseApi | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandResponseApi

+
+
+
+
+
+
+
+
+
+

Interface for the internal command processor response object, hides the fields that are required to fully build the + response from the handlers.

+
+
+
export
+
+
interface
+

ICommandProcessorResponseApi

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandResponseApi +
  • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

responseFormat

+
responseFormat: COMMAND_RESPONSE_FORMAT
+ +
+
+

Returns the response format that the object was constructed with - indicates how the output should be handled + if response format is JSON, then data is buffered until the end and output at that time.

+
+
+
returns
+
    +
  • The response format for this command.
  • +
+
+
memberof
+

ICommandProcessorResponseApi

+
+
+
+
+
+ +

silent

+
silent: boolean
+ +
+
+

If true, indicates that silent mode is enabled (no output whatsoever is produced by the response object)

+
+
+
returns
+
+
memberof
+

ICommandProcessorResponseApi

+
+
+
+
+
+
+

Methods

+
+ +

buildJsonResponse

+ + +
+
+ +

endProgressBar

+
    +
  • endProgressBar(): void
  • +
+ +
+
+ +

failed

+
    +
  • failed(): void
  • +
+ +
+
+ +

setError

+ + +
+
+ +

succeeded

+
    +
  • succeeded(): void
  • +
+ +
+
+ +

writeJsonResponse

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandresponseparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandresponseparms.html new file mode 100644 index 0000000000..4e7d72fa0d --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandresponseparms.html @@ -0,0 +1,402 @@ + + + + + + ICommandResponseParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandResponseParms

+
+
+
+
+
+
+
+
+
+

Command response control parameters. Indicates how the command response should behave and allows influence over + colorings, etc.

+
+
+
export
+
+
interface
+

ICommandResponseParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandResponseParms +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional args

+
args: Arguments
+ +
+
+

The arguments specified on the command line

+
+
+
memberof
+

ICommandResponseParms

+
+
+
+
+
+ +

Optional definition

+
definition: ICommandDefinition
+ +
+
+

The command definition for this response

+
+
+
memberof
+

ICommandResponseParms

+
+
+
+
+
+ +

Optional primaryTextColor

+
primaryTextColor: string
+ +
+
+

The primary text color used by Chalk package for highlighting messages.

+
+
+
memberof
+

ICommandResponseParms

+
+
+
+
+
+ +

Optional progressBarSpinner

+
progressBarSpinner: string
+ +
+
+

The Progress bar spinner characters.

+
+
+
memberof
+

ICommandResponseParms

+
+
+
+
+
+ +

Optional responseFormat

+
responseFormat: COMMAND_RESPONSE_FORMAT
+ +
+
+

The response format for the command. Controls how output is generated for the command (ignored if silent is + specified). See the type for more details.

+
+
+
memberof
+

ICommandResponseParms

+
+
+
+
+
+ +

Optional silent

+
silent: boolean
+ +
+
+

Silent indicates that the command should produce absolutely no output to stdout/stderr (the console/terminal)

+
+
+
memberof
+

ICommandResponseParms

+
+
+
+
+
+ +

Optional stream

+
stream: any
+ +
+
+

Stream

+
+
+
memberof
+

ICommandResponseParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandtreeentry.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandtreeentry.html new file mode 100644 index 0000000000..887f0822e7 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandtreeentry.html @@ -0,0 +1,268 @@ + + + + + + ICommandTreeEntry | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandTreeEntry

+
+
+
+
+
+
+
+
+
+

Command tree entry describes an entry of a command in the full command tree - used when flattening the command + tree to build fully qualified commands for searching and display purposes

+
+
+
+
+

Hierarchy

+
    +
  • + ICommandTreeEntry +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

command

+ + +
+
+ +

fullName

+
fullName: string
+ +
+
+ +

tree

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandvalidatorerror.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandvalidatorerror.html new file mode 100644 index 0000000000..0bbd830c3f --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandvalidatorerror.html @@ -0,0 +1,305 @@ + + + + + + ICommandValidatorError | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandValidatorError

+
+
+
+
+
+
+
+
+
+

Describes the operand in error and provides the full definition for the option/operand - normally exposed when the + JSON response format is requested.

+
+
+
export
+
+
interface
+

ICommandValidatorError

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandValidatorError +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional definition

+
definition: any
+ +
+
+

The option definition that failed.

+
+
+
memberof
+

ICommandValidatorError

+
+
+
+
+
+ +

message

+
message: string
+ +
+
+

The validation error message.

+
+
+
memberof
+

ICommandValidatorError

+
+
+
+
+
+ +

Optional optionInError

+
optionInError: string
+ +
+
+

The option that failed validation.

+
+
+
memberof
+

ICommandValidatorError

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandvalidatorresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandvalidatorresponse.html new file mode 100644 index 0000000000..c229e26b05 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icommandvalidatorresponse.html @@ -0,0 +1,258 @@ + + + + + + ICommandValidatorResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommandValidatorResponse

+
+
+
+
+
+
+
+
+
+

Syntax validator response. + TODO - In the future, when we supply an the ability to override/extend the SyntaxValidator, we should change the + TODO - validator from printing the syntax errors itself to returning an object with a structured error list.

+
+
+
export
+
+
interface
+

ICommandValidatorResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommandValidatorResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

valid

+
valid: boolean
+ +
+
+

Indicates if the syntax/parameters supplied by the user were valid.

+
+
+
memberof
+

ICommandValidatorResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfig.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfig.html new file mode 100644 index 0000000000..eafe4c7e92 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfig.html @@ -0,0 +1,304 @@ + + + + + + IConfig | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfig

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IConfig +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional $schema

+
$schema: string
+ +
+
+ +

Optional autoStore

+
autoStore: boolean
+ +
+
+ +

defaults

+
defaults: {}
+ +
+

Type declaration

+
    +
  • +
    [key: string]: string
    +
  • +
+
+
+
+ +

Optional plugins

+
plugins: string[]
+ +
+
+ +

profiles

+
profiles: {}
+ +
+

Type declaration

+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigautostorefindactiveprofileopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigautostorefindactiveprofileopts.html new file mode 100644 index 0000000000..429942a2b3 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigautostorefindactiveprofileopts.html @@ -0,0 +1,308 @@ + + + + + + IConfigAutoStoreFindActiveProfileOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigAutoStoreFindActiveProfileOpts

+
+
+
+
+
+
+
+
+
+

Defines the options used by the ConfigAutoStore._findActiveProfile function

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional defaultProfileName

+
defaultProfileName: string
+ +
+
+

Default profile name used if no profiles matched the search for active profiles + Used if params == null

+
+
+
+
+ +

Optional params

+ + +
+
+

CLI Handler Parameters to use when searching for the active profile

+
+
+
+
+ +

Optional profileProps

+
profileProps: string[]
+ +
+
+

List of properties required in the profile schema

+
+
+
+
+ +

Optional profileTypes

+
profileTypes: string[]
+ +
+
+

Optional profile types to look for + Used if params == null

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigautostorefindauthhandlerforprofileopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigautostorefindauthhandlerforprofileopts.html new file mode 100644 index 0000000000..91a42e0dc0 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigautostorefindauthhandlerforprofileopts.html @@ -0,0 +1,395 @@ + + + + + + IConfigAutoStoreFindAuthHandlerForProfileOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigAutoStoreFindAuthHandlerForProfileOpts

+
+
+
+
+
+
+
+
+
+

Defines the options used by the ConfigAutoStore._findAuthHandlerForProfile function

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional cmdArguments

+
cmdArguments: ICommandArguments
+ +
+
+

CLI arguments which may specify a profile

+
+
+
+
+ +

Optional config

+
config: Config
+ +
+
+

Team configuration properties + Overrides ImperativeConfig.instance.config

+
+
+
+
+ +

Optional defaultBaseProfileName

+
defaultBaseProfileName: string
+ +
+
+

Default base profile name + Used if cmdArguments == null

+
+
+
+
+ +

Optional defaultProfileName

+
defaultProfileName: string
+ +
+
+

Default profile name used if no profiles matched the search for active profiles + Used if params == null

+
+
+
+
+ +

Optional params

+ + +
+
+

CLI Handler Parameters to use when searching for the active profile

+
+
+
+
+ +

Optional profilePath

+
profilePath: string
+ +
+
+

JSON path of profile

+
+
+
+
+ +

Optional profileProps

+
profileProps: string[]
+ +
+
+

List of properties required in the profile schema

+
+
+
+
+ +

Optional profileTypes

+
profileTypes: string[]
+ +
+
+

Optional profile types to look for + Used if params == null

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html new file mode 100644 index 0000000000..fd5246b890 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigautostorestoresesscfgpropsopts.html @@ -0,0 +1,499 @@ + + + + + + IConfigAutoStoreStoreSessCfgPropsOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigAutoStoreStoreSessCfgPropsOpts

+
+
+
+
+
+
+
+
+
+

Defines the options used by the ConfigAutoStore._storeSessCfgProps function

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional cmdArguments

+
cmdArguments: ICommandArguments
+ +
+
+

CLI arguments which may specify a profile

+
+
+
+
+ +

Optional config

+
config: Config
+ +
+
+

Team configuration properties + Overrides ImperativeConfig.instance.config

+
+
+
+
+ +

Optional defaultBaseProfileName

+
defaultBaseProfileName: string
+ +
+
+

Default base profile name + Used if cmdArguments == null

+
+
+
+
+ +

Optional defaultProfileName

+
defaultProfileName: string
+ +
+
+

Default profile name used if no profiles matched the search for active profiles + Used if params == null

+
+
+
+
+ +

Optional params

+ + +
+
+

CLI Handler Parameters to use when searching for the active profile

+
+
+
+
+ +

Optional profileName

+
profileName: string
+ +
+
+

Name of the profile where we want to store the properties + Used if params == null

+
+
+
+
+ +

Optional profilePath

+
profilePath: string
+ +
+
+

JSON path of profile

+
+
+
+
+ +

Optional profileProps

+
profileProps: string[]
+ +
+
+

List of properties required in the profile schema

+
+
+
+
+ +

Optional profileType

+
profileType: string
+ +
+
+

Type of the profile where we want to store the properties + Used if params == null

+
+
+
+
+ +

Optional profileTypes

+
profileTypes: string[]
+ +
+
+

Optional profile types to look for + Used if params == null

+
+
+
+
+ +

Optional propsToStore

+
propsToStore: string[]
+ +
+
+

Names of properties that should be stored

+
+
+
+
+ +

Optional sessCfg

+
sessCfg: {}
+ +
+
+

Session config containing properties to store

+
+
+
+

Type declaration

+
    +
  • +
    [key: string]: any
    +
  • +
+
+
+
+ +

Optional setSecure

+
setSecure: boolean
+ +
+
+

Indicates whether or not the property should be stored securely

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigbuilderopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigbuilderopts.html new file mode 100644 index 0000000000..f946668220 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigbuilderopts.html @@ -0,0 +1,291 @@ + + + + + + IConfigBuilderOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigBuilderOpts

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IConfigBuilderOpts +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Optional populateProperties

+
populateProperties: boolean
+ +
+
+

Specify true to populate default values for profile properties with the + IProfileProperty.includeInTemplate flag set to true.

+
+
+
+
+
+

Methods

+
+ +

Optional getValueBack

+ +
    +
  • + +
    +
    +

    Callback that prompts the user to enter a value for a profile property. + The method will be called to populate missing values in the base profile. + It should return the value that the user entered, or null or undefined if + the prompt was cancelled.

    +
    +
    +

    Parameters

    +
      +
    • +
      propName: string
      +
      +

      The name of the property

      +
      +
    • +
    • +
      property: IProfileProperty
      +
      +

      The profile property definition

      +
      +
    • +
    +

    Returns Promise<any>

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigconvertresult.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigconvertresult.html new file mode 100644 index 0000000000..aa6f053a15 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigconvertresult.html @@ -0,0 +1,268 @@ + + + + + + IConfigConvertResult | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigConvertResult

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IConfigConvertResult +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

config

+
config: IConfig
+ +
+
+ +

profilesConverted

+
profilesConverted: {}
+ +
+

Type declaration

+
    +
  • +
    [key: string]: string[]
    +
  • +
+
+
+
+ +

profilesFailed

+
profilesFailed: { error: Error; name?: string; type: string }[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfiglayer.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfiglayer.html new file mode 100644 index 0000000000..703efdd4dc --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfiglayer.html @@ -0,0 +1,288 @@ + + + + + + IConfigLayer | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigLayer

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IConfigLayer +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

exists

+
exists: boolean
+ +
+
+ +

global

+
global: boolean
+ +
+
+ +

path

+
path: string
+ +
+
+ +

properties

+
properties: IConfig
+ +
+
+ +

user

+
user: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfiglogging.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfiglogging.html new file mode 100644 index 0000000000..526dc4c852 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfiglogging.html @@ -0,0 +1,232 @@ + + + + + + IConfigLogging | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigLogging

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigmergeopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigmergeopts.html new file mode 100644 index 0000000000..a3ea5ae275 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigmergeopts.html @@ -0,0 +1,291 @@ + + + + + + IConfigMergeOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigMergeOpts

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IConfigMergeOpts +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional cloneLayers

+
cloneLayers: boolean
+ +
+
+

Indicates whether we should clone layers to prevent accidental edits. + If maskSecure is true, then it is implied that cloneLayers is true.

+
+
+
defaultvalue
+

true

+
+
+
+
+
+ +

Optional excludeGlobalLayer

+
excludeGlobalLayer: boolean
+ +
+
+

Indicates whether we should exclude global layers.

+
+
+
defaultvalue
+

false

+
+
+
+
+
+ +

Optional maskSecure

+
maskSecure: boolean
+ +
+
+

Indicates whether we should mask off secure properties.

+
+
+
defaultvalue
+

false

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigopts.html new file mode 100644 index 0000000000..d5eb14dae1 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigopts.html @@ -0,0 +1,295 @@ + + + + + + IConfigOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigOpts

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IConfigOpts +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional homeDir

+
homeDir: string
+ +
+
+

Directory where global config files are located. Defaults to ~/.appName.

+
+
+
+
+ +

Optional noLoad

+
noLoad: boolean
+ +
+
+

Do not attempt to load the config, meant for when the config is broken

+
+
+
+
+ +

Optional projectDir

+
projectDir: string | false
+ +
+
+

Directory where project config files are located. Defaults to working directory. + Specify false to disable loading of project config files.

+
+
+
+
+ +

Optional vault

+ + +
+
+

Vault object with methods for loading and saving secure credentials

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigprofile.html new file mode 100644 index 0000000000..29e2b5b4b3 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigprofile.html @@ -0,0 +1,290 @@ + + + + + + IConfigProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigProfile

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IConfigProfile +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional profiles

+
profiles: {}
+ +
+

Type declaration

+ +
+
+
+ +

properties

+
properties: {}
+ +
+

Type declaration

+
    +
  • +
    [key: string]: any
    +
  • +
+
+
+
+ +

Optional secure

+
secure: string[]
+ +
+
+ +

Optional type

+
type: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigschema.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigschema.html new file mode 100644 index 0000000000..c4026aa931 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigschema.html @@ -0,0 +1,296 @@ + + + + + + IConfigSchema | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigSchema

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IConfigSchema +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

$schema

+
$schema: string
+ +
+
+ +

$version

+
$version: string
+ +
+
+ +

description

+
description: string
+ +
+
+ +

properties

+
properties: {}
+ +
+

Type declaration

+
    +
  • +
    [key: string]: any
    +
  • +
+
+
+
+ +

type

+
type: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigschemainfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigschemainfo.html new file mode 100644 index 0000000000..8e26819d18 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigschemainfo.html @@ -0,0 +1,260 @@ + + + + + + IConfigSchemaInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigSchemaInfo

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigupdateschemahelperoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigupdateschemahelperoptions.html new file mode 100644 index 0000000000..f4ff351f7d --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigupdateschemahelperoptions.html @@ -0,0 +1,274 @@ + + + + + + IConfigUpdateSchemaHelperOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigUpdateSchemaHelperOptions

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IConfigUpdateSchemaHelperOptions +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

config

+
config: Config
+ +
+
+ +

layer

+ + +
+
+ +

updateOptions

+ + +
+
+ +

updatedPaths

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigupdateschemaoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigupdateschemaoptions.html new file mode 100644 index 0000000000..b447e9a485 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigupdateschemaoptions.html @@ -0,0 +1,260 @@ + + + + + + IConfigUpdateSchemaOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigUpdateSchemaOptions

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IConfigUpdateSchemaOptions +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional depth

+
depth: number
+ +
+
+ +

Optional layer

+
layer: "active" | "global" | "all"
+ +
+
+ +

Optional schema

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigupdateschemapaths.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigupdateschemapaths.html new file mode 100644 index 0000000000..e6218d6d50 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigupdateschemapaths.html @@ -0,0 +1,212 @@ + + + + + + IConfigUpdateSchemaPaths | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigUpdateSchemaPaths

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigvault.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigvault.html new file mode 100644 index 0000000000..f5fc2e8c13 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconfigvault.html @@ -0,0 +1,291 @@ + + + + + + IConfigVault | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConfigVault

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IConfigVault +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

load

+
load: (key: string) => Promise<any>
+ +
+

Type declaration

+
    +
  • + +
      +
    • +

      Parameters

      +
        +
      • +
        key: string
        +
      • +
      +

      Returns Promise<any>

      +
    • +
    +
  • +
+
+
+
+ +

save

+
save: (key: string, value: any) => Promise<void>
+ +
+

Type declaration

+
    +
  • +
      +
    • (key: string, value: any): Promise<void>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        key: string
        +
      • +
      • +
        value: any
        +
      • +
      +

      Returns Promise<void>

      +
    • +
    +
  • +
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconsole.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconsole.html new file mode 100644 index 0000000000..3a634938f7 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iconsole.html @@ -0,0 +1,427 @@ + + + + + + IConsole | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConsole

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IConsole +
  • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

level

+
level: string
+ +
+
+
+

Methods

+
+ +

debug

+
    +
  • debug(message: string, ...args: any[]): void
  • +
+ +
+
+ +

error

+
    +
  • error(message: string, ...args: any[]): void
  • +
+ +
+
+ +

fatal

+
    +
  • fatal(message: string, ...args: any[]): void
  • +
+ +
+
+ +

info

+
    +
  • info(message: string, ...args: any[]): void
  • +
+ +
+
+ +

trace

+
    +
  • trace(message: string, ...args: any[]): void
  • +
+ +
+
+ +

warn

+
    +
  • warn(message: string, ...args: any[]): void
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icredentialmanagerinit.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icredentialmanagerinit.html new file mode 100644 index 0000000000..ac0ecdfbb6 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icredentialmanagerinit.html @@ -0,0 +1,308 @@ + + + + + + ICredentialManagerInit | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICredentialManagerInit

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ICredentialManagerInit +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional Manager

+
Manager: IImperativeOverrides["CredentialManager"]
+ +
+
+

A class that extends AbstractCredentialManager that will + be instantiated and used as the actual credential manager. If a string is + passed, we will attempt to load the module specified in the string as a + class that extends the AbstractCredentialManager. If the class imported + doesn't extend the abstract class, we will throw an error.

+
+

Defaults to the DefaultCredentialManager (uses keytar)

+
+
+
+ +

Optional displayName

+
displayName: string
+ +
+
+

The display name of the credential manager in use. Used in messaging/debugging and + if the credential manager is managing secure profile fields via the imperative + "CliProfileManager", then profiles will display "managed by ${displayName}" for + secure fields in the profile yaml files. Defaults to the service name if not + provided.

+
+

Note: If the credential manager class contains a hard-coded display name, this + parameter is ignored in favor of using their explicit name

+
+
+
+ +

Optional invalidOnFailure

+
invalidOnFailure: boolean
+ +
+
+

If true, will default to using the invalid credential manager (all API calls + throw errors) if initialization of the credential manager fails.

+
+
+
+
+ +

service

+
service: string
+ +
+
+

The service name to be used in the security manager. This value is useful for + credential managers that require a service ID (such as the default manager which + implements Keytar).

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icredentialmanagernamemap.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icredentialmanagernamemap.html new file mode 100644 index 0000000000..211ddb0a7a --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.icredentialmanagernamemap.html @@ -0,0 +1,293 @@ + + + + + + ICredentialManagerNameMap | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICredentialManagerNameMap

+
+
+
+
+
+
+
+
+
+

This interface represents the association of plugin name, VS Code extension name, + and credential manager override name for components that override the default + credential manager. Our imperative module will keep a list of known plugins and + VS Code extensions that can override the default credential manager. The name of + the default credential manager will also be in that list. Imperative will be + able to use this name mapping to identify the correct plugin or extension which + provides a given credential manager override.

+
+
+
+
+

Hierarchy

+
    +
  • + ICredentialManagerNameMap +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

credMgrDisplayName

+
credMgrDisplayName: string
+ +
+
+

Name of the credential manager. This is the name that will be stored in + $ZOWE_CLI_HOME/settings/imperative.json.

+
+
+
+
+ +

Optional credMgrPluginName

+
credMgrPluginName: string
+ +
+
+

Name of the plugin that supplies the credential manager override software. + A credential manager supplier must supply a CLI plugin, or a ZE extension, + or both.

+
+
+
+
+ +

Optional credMgrZEName

+
credMgrZEName: string
+ +
+
+

Name of the Zowe Explorer extension that supplies the credential manager + override software. A credential manager supplier must supply a CLI plugin, + or a ZE extension, or both.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idaemoncontext.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idaemoncontext.html new file mode 100644 index 0000000000..12ca1799aa --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idaemoncontext.html @@ -0,0 +1,304 @@ + + + + + + IDaemonContext | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDaemonContext

+
+
+
+
+
+
+
+
+
+

Allow for passing our own "context" / user data to the Imperative parser

+
+
+
export
+
+
interface
+

IDaemonContext

+
+
+
+
+
+

Hierarchy

+
    +
  • + IDaemonContext +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional response

+
response: IDaemonResponse
+ +
+
+

Daemon response object from socket client

+
+
+
memberof
+

IDaemonContext

+
+
+
+
+
+ +

Optional stdinStream

+
stdinStream: stream.Readable
+ +
+
+

Stream to read input from

+
+
+
memberof
+

IDaemonContext

+
+
+
+
+
+ +

Optional stream

+
stream: Socket
+ +
+
+

Stream to write response to

+
+
+
memberof
+

IDaemonContext

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idaemonrequest.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idaemonrequest.html new file mode 100644 index 0000000000..9fa8876af8 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idaemonrequest.html @@ -0,0 +1,376 @@ + + + + + + IDaemonRequest | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDaemonRequest

+
+
+
+
+
+
+
+
+
+

Option interface to construct request to daemon client

+
+
+
export
+
+
interface
+

IDaemonRequest

+
+
+
+
+
+

Hierarchy

+
    +
  • + IDaemonRequest +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional exitCode

+
exitCode: number
+ +
+
+

Process exit code

+
+
+
memberof
+

IDaemonRequest

+
+
+
+
+
+ +

Optional progress

+
progress: boolean
+ +
+
+

Content is progress spinner

+
+
+
memberof
+

IDaemonRequest

+
+
+
+
+
+ +

Optional prompt

+
prompt: string
+ +
+
+

Content is for prompting

+
+
+
memberof
+

IDaemonRequest

+
+
+
+
+
+ +

Optional securePrompt

+
securePrompt: string
+ +
+
+

Content is for secure prompting

+
+
+
memberof
+

IDaemonRequest

+
+
+
+
+
+ +

Optional stderr

+
stderr: string
+ +
+
+

Content is for stderr

+
+
+
memberof
+

IDaemonRequest

+
+
+
+
+
+ +

Optional stdout

+
stdout: string
+ +
+
+

Content is for stdout

+
+
+
memberof
+

IDaemonRequest

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idaemonresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idaemonresponse.html new file mode 100644 index 0000000000..efca952ff3 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idaemonresponse.html @@ -0,0 +1,349 @@ + + + + + + IDaemonResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDaemonResponse

+
+
+
+
+
+
+
+
+
+

Option interface to construct response from daemon client

+
+
+
export
+
+
interface
+

IDaemonResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IDaemonResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional argv

+
argv: string[]
+ +
+
+

List of CLI arguments received from the daemon client.

+
+
+
+
+ +

Optional cwd

+
cwd: string
+ +
+
+

Current working directory received from the daemon client.

+
+
+
+
+ +

Optional env

+
env: Record<string, string>
+ +
+
+

Environment variables with CLI prefix received from the daemon client.

+
+
+
+
+ +

Optional stdin

+
stdin: string
+ +
+
+

Stdin text received from the daemon client. + This is used for plain text stdin data like replies to prompts.

+
+
+
+
+ +

Optional stdinLength

+
stdinLength: number
+ +
+
+

Length of stdin data received from the daemon client. + The client sends binary stdin data as a multipart request, that contains + a JSON body with stdinLength defined, followed by the raw binary data.

+
+
+
+
+ +

Optional user

+
user: string
+ +
+
+

The user that initiated the request from the daemon client.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ideleteprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ideleteprofile.html new file mode 100644 index 0000000000..4e13417366 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ideleteprofile.html @@ -0,0 +1,280 @@ + + + + + + IDeleteProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDeleteProfile

+
+
+
+
+
+
+
+
+
+

Parameters to the profile manager "delete" API.

+
+
+
export
+
+
interface
+

IDeleteProfile

+
+
+
+
+
+

Hierarchy

+
    +
  • + IDeleteProfile +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+

The name of the profile to delete - the type is specified by the current manager object.

+
+
+
memberof
+

IDeleteProfile

+
+
+
+
+
+ +

Optional rejectIfDependency

+
rejectIfDependency: boolean
+ +
+
+

If true, rejects the deletion of the profile if it is found to be a dependency of another profile.

+
+
+
memberof
+

IDeleteProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idiffnameoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idiffnameoptions.html new file mode 100644 index 0000000000..105bb88a6a --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idiffnameoptions.html @@ -0,0 +1,278 @@ + + + + + + IDiffNameOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDiffNameOptions

+
+
+
+
+
+
+
+
+
+

interface for diff options related to naming

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional name1

+
name1: string
+ +
+
+

Optional name for string1

+
+
+
memberof
+

IDiffOptions

+
+
+
+
+
+ +

Optional name2

+
name2: string
+ +
+
+

Optional name for string2

+
+
+
memberof
+

IDiffOptions

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idiffoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idiffoptions.html new file mode 100644 index 0000000000..334cba54b7 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.idiffoptions.html @@ -0,0 +1,328 @@ + + + + + + IDiffOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDiffOptions

+
+
+
+
+
+
+
+
+
+

interface for diff options

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional contextLinesArg

+
contextLinesArg: number
+ +
+
+

Number of context line arguments

+
+
+
memberof
+

IDiffOptions

+
+
+
+
+
+ +

Optional name1

+
name1: string
+ +
+
+

Optional name for string1

+
+
+
memberof
+

IDiffOptions

+
+
+
+
+
+ +

Optional name2

+
name2: string
+ +
+
+

Optional name for string2

+
+
+
memberof
+

IDiffOptions

+
+
+
+
+
+ +

outputFormat

+
outputFormat: outputFormat
+ +
+
+

Output format of differences between two, to be returned

+
+
+
memberof
+

IDiffOptions

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iexplanationmap.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iexplanationmap.html new file mode 100644 index 0000000000..2b64d901f6 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iexplanationmap.html @@ -0,0 +1,262 @@ + + + + + + IExplanationMap | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IExplanationMap

+
+
+
+
+
+
+
+
+
+

Interface of an explanation map object

+
+
+
+
+

Hierarchy

+
    +
  • + IExplanationMap +
  • +
+
+
+

Indexable

+
[key: string]: string | IExplanationMap
+
+
+

Interface of an explanation map object

+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

explainedParentKey

+
explainedParentKey: string
+ +
+
+ +

ignoredKeys

+
ignoredKeys: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.igetallprofilesoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.igetallprofilesoptions.html new file mode 100644 index 0000000000..95c82c4932 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.igetallprofilesoptions.html @@ -0,0 +1,246 @@ + + + + + + IGetAllProfilesOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IGetAllProfilesOptions

+
+
+
+
+
+
+
+
+
+

Options that will affect the behavior of the ProfileInfo class. + They are supplied on the ProfileInfo getAllProfiles method.

+
+
+
+
+

Hierarchy

+
    +
  • + IGetAllProfilesOptions +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional excludeHomeDir

+
excludeHomeDir: boolean
+ +
+
+

Indicates if the home directory should be excluded + The default is false.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.igetitemopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.igetitemopts.html new file mode 100644 index 0000000000..655ab6ad65 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.igetitemopts.html @@ -0,0 +1,245 @@ + + + + + + IGetItemOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IGetItemOpts

+
+
+
+
+
+
+
+
+
+

This interface represents the the options for getEnvItemVal().

+
+
+
+
+

Hierarchy

+
    +
  • + IGetItemOpts +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional progressApi

+
progressApi: IHandlerProgressApi
+ +
+
+

API to start/end progress bar for long running actions. Since this is a CLI thing, + it is optional in case non-CLI programs want to call the getEnvItemVal function.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.igetitemval.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.igetitemval.html new file mode 100644 index 0000000000..d4c0d25a96 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.igetitemval.html @@ -0,0 +1,267 @@ + + + + + + IGetItemVal | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IGetItemVal

+
+
+
+
+
+
+
+
+
+

This interface represents the result from getEnvItemVal().

+
+
+
+
+

Hierarchy

+
    +
  • + IGetItemVal +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

itemProbMsg

+
itemProbMsg: string
+ +
+
+ +

itemVal

+
itemVal: string
+ +
+
+ +

itemValMsg

+
itemValMsg: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerformatoutputapi.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerformatoutputapi.html new file mode 100644 index 0000000000..342514c440 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerformatoutputapi.html @@ -0,0 +1,253 @@ + + + + + + IHandlerFormatOutputApi | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHandlerFormatOutputApi

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerparameters.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerparameters.html new file mode 100644 index 0000000000..de0d5438c4 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerparameters.html @@ -0,0 +1,432 @@ + + + + + + IHandlerParameters | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHandlerParameters

+
+
+
+
+
+
+
+
+
+

The handler parameters are passed to the instantiated command handler and populated by the command processor. The + parameters supply everything a command handler needs to operate: arguments, response object, profiles, the command + definition document, and more.

+
+

Handlers should NEVER perform their own console/stdout/stderr invocations. The response object is provided for all + messaging and logging capabilities.

+
+
export
+
+
interface
+

IHandlerParameters

+
+
+
+
+
+

Hierarchy

+
    +
  • + IHandlerParameters +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

arguments

+ + +
+
+

The arguments specified by the user on the command line (in the Yargs object format).

+
+
+
memberof
+

IHandlerParameters

+
+
+
+
+
+ +

definition

+
definition: ICommandDefinition
+ +
+
+

The command definition node that defines the command being issued.

+
+
+
memberof
+

IHandlerParameters

+
+
+
+
+
+ +

fullDefinition

+
fullDefinition: ICommandDefinition
+ +
+
+

The full command definition tree that includes the command being issued.

+
+
+
memberof
+

IHandlerParameters

+
+
+
+
+
+ +

Optional isChained

+
isChained: boolean
+ +
+
+

Has your command been invoked from a chained handler? (see ICommandDefinition.chainedHandlers) + You can use this to influence the behavior of your command (e.g. not printing certain messages from within a chained command)

+
+
+
+
+ +

positionals

+
positionals: string[]
+ +
+
+

The positional options specified by the user on the command line.

+
+
+
memberof
+

IHandlerParameters

+
+
+
+
+
+ +

profiles

+
profiles: CommandProfiles
+ +
+
+

The set of profiles loaded for this command handler - the map is built with the key being the type and it + returns the set of profiles loaded of that type. Multiple profiles can be loaded of the same type - depending + on the request and the 0th entry is the first loaded.

+
+
+
deprecated
+

This API only loads v1 profiles. To load v2 profiles, use ImperativeConfig.instance.config.api.profiles.

+
+
memberof
+

IHandlerParameters

+
+
+
+
+
+ +

response

+ + +
+
+

The response object used to issue messages and build responses to the command. No command should be + writing to console/stdout/stderr directly. The response object provides the capability of collecting + responses for the JSON response format (among other capabilities). A handler can choose to log differently, + however a logger is also provided on the command response object.

+
+
+
memberof
+

IHandlerParameters

+
+
+
+
+
+ +

stdin

+
stdin: stream.Readable
+ +
+
+

The input stream that can be used by the command being issued.

+
+
+
memberof
+

IHandlerParameters

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerprogressapi.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerprogressapi.html new file mode 100644 index 0000000000..9a008713f4 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerprogressapi.html @@ -0,0 +1,305 @@ + + + + + + IHandlerProgressApi | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHandlerProgressApi

+
+
+
+
+
+
+
+
+
+

Progress bar APIs for the command handler. Use these methods to start and end progress bars. Only one bar can be + active at any given time. Progress bars are displayed at the users terminal/console (indicates/updates with + progress) and are NOT shown

+
+
+
export
+
+
interface
+

IHandlerProgressApi

+
+
+
+
+
+

Hierarchy

+
    +
  • + IHandlerProgressApi +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

endBar

+
    +
  • endBar(): void
  • +
+ +
+
+ +

startBar

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerresponseapi.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerresponseapi.html new file mode 100644 index 0000000000..9dac2c6af5 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerresponseapi.html @@ -0,0 +1,344 @@ + + + + + + IHandlerResponseApi | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHandlerResponseApi

+
+
+
+
+
+
+
+
+
+

The interface to the object passed to command handlers to formulate responses, print messages, etc. in their + command processing. Handlers should never write directly to stdout/stderr.

+
+
+
export
+
+
interface
+

ICommandResponseApi

+
+
+
+
+
+

Hierarchy

+
    +
  • + IHandlerResponseApi +
  • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

console

+ + +
+
+

Returns the console API object. Used for writing to stdout and stderr. Also buffers the stdout/stderr messages + for population of the ultimate JSON response object.

+
+
+
returns
+
+
memberof
+

IHandlerResponseApi

+
+
+
+
+
+ +

data

+ + +
+
+

The response object is constructed for the purposes of responding to a command with JSON output. The response + object houses additional fields and response areas for programmatic API usage of commands.

+
+
+
returns
+
+
memberof
+

IHandlerResponseApi

+
+
+
+
+
+ +

format

+ + +
+
+

Format and output data according to the defaults specified (and optional overrides specified by the user). Use + when printing/prettifying JSON objects/arrays (it can be used with string data, but string data does not benefit + from the auto-formatting options). In conjunction with with ""

+
+
+
memberof
+

IHandlerResponseApi

+
+
+
+
+
+ +

progress

+ + +
+
+

Apis to create and destroy progress bars during the command.

+
+
+
memberof
+

IHandlerResponseApi

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerresponseconsoleapi.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerresponseconsoleapi.html new file mode 100644 index 0000000000..a9b7694794 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerresponseconsoleapi.html @@ -0,0 +1,414 @@ + + + + + + IHandlerResponseConsoleApi | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHandlerResponseConsoleApi

+
+
+
+
+
+
+
+
+
+

Handler response API for console messages.

+
+
+
export
+
+
interface
+

IHandlerResponseConsoleApi

+
+
+
+
+
+

Hierarchy

+
    +
  • + IHandlerResponseConsoleApi +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

error

+
    +
  • error(message: string | Buffer, ...values: any[]): string
  • +
+
    +
  • + +
    +
    +

    Write a message to stderr (or buffers in silent/JSON mode). Automatically appends a newline to the message.

    +
    +
    +
    memberof
    +

    IHandlerResponseConsoleApi

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      message: string | Buffer
      +
      +

      The message (or format string) to write to stderr

      +
      +
    • +
    • +
      Rest ...values: any[]
      +
      +

      The format string values for substitution/formatting.

      +
      +
    • +
    +

    Returns string

    +
      +
    • The verbatim message written.
    • +
    +
  • +
+
+
+ +

errorHeader

+
    +
  • errorHeader(message: string, delimiter?: string): string
  • +
+
    +
  • + +
    +
    +

    Writes an error header to stderr. The header is colorized (to red), appends a colon (e.g. "Syntax Error:"), + and a new line. The intention of the error header is to begin an error block of text with a "tag" (the header).

    +
    +
    +
    memberof
    +

    IHandlerResponseConsoleApi

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
      +

      The message as the header.

      +
      +
    • +
    • +
      Optional delimiter: string
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

log

+
    +
  • log(message: string | Buffer, ...values: any[]): string
  • +
+
    +
  • + +
    +
    +

    Write a message to stdout (or buffers in silent/JSON mode). Automatically appends a newline to the message.

    +
    +
    +
    memberof
    +

    IHandlerResponseConsoleApi

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      message: string | Buffer
      +
      +

      The message (or format string) to write to stdout.

      +
      +
    • +
    • +
      Rest ...values: any[]
      +
      +

      The format string values for substitution/formatting.

      +
      +
    • +
    +

    Returns string

    +
      +
    • The verbatim message written.
    • +
    +
  • +
+
+
+ +

prompt

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerresponsedataapi.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerresponsedataapi.html new file mode 100644 index 0000000000..adcbe41e4a --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihandlerresponsedataapi.html @@ -0,0 +1,378 @@ + + + + + + IHandlerResponseDataApi | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHandlerResponseDataApi

+
+
+
+
+
+
+
+
+
+

APIs for the command handlers to construct the JSON response object for the command. The JSON response object is + built/written when the "response format JSON" flag is set. The intention is to allow for structured information/data + to be provided to the caller (who is requesting the JSON format of the command output) for programmatic usage of + Imperative commands.

+
+
+
export
+
+
interface
+

IHandlerResponseDataApi

+
+
+
+
+
+

Hierarchy

+
    +
  • + IHandlerResponseDataApi +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

setExitCode

+
    +
  • setExitCode(code: number): number
  • +
+ +
+
+ +

setMessage

+
    +
  • setMessage(message: string, ...values: any[]): string
  • +
+
    +
  • + +
    +
    +

    Sets the JSON response API "message" property. Can optionally be logged. The intent is to provide a short + summary on the response JSON object (for display and other purposes).

    +
    +
    +
    memberof
    +

    IHandlerResponseDataApi

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
    • +
    • +
      Rest ...values: any[]
      +
      +

      Values gets passed to the method TextUtils.formatMessage. + Two possible formats:

      +
        +
      • List of values to be inserted into the string message ("printf" style)
      • +
      • Object containing key-value pairs to be rendered in the Mustache template string message
      • +
      +
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

setObj

+
    +
  • setObj(data: any, merge?: boolean): any
  • +
+
    +
  • + +
    +
    +

    The JSON response object for a command contains a property that is intended to contain any custom object(s)/data + that the command wants to return to the caller.

    +
    +
    +
    memberof
    +

    IHandlerResponseDataApi

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      data: any
      +
      +

      The object to set in the JSON response.

      +
      +
    • +
    • +
      Optional merge: boolean
      +
      +

      If true, will merge the object with the existing data already set.

      +
      +
    • +
    +

    Returns any

    +
      +
    • The object.
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iheadercontent.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iheadercontent.html new file mode 100644 index 0000000000..281e9f2952 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iheadercontent.html @@ -0,0 +1,204 @@ + + + + + + IHeaderContent | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHeaderContent

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihelpgenerator.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihelpgenerator.html new file mode 100644 index 0000000000..2c9f445d10 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihelpgenerator.html @@ -0,0 +1,270 @@ + + + + + + IHelpGenerator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHelpGenerator

+
+
+
+
+
+
+
+
+
+

Help generator API. See the AbstractHelpGenerator+DefaultHelpGenerator for the base implementation.

+
+
+
export
+
+
interface
+

IHelpGenerator

+
+
+
+
+
+

Hierarchy

+
    +
  • + IHelpGenerator +
  • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

buildHelp

+
    +
  • buildHelp(): string
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihelpgeneratorfactory.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihelpgeneratorfactory.html new file mode 100644 index 0000000000..7500e5b286 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihelpgeneratorfactory.html @@ -0,0 +1,281 @@ + + + + + + IHelpGeneratorFactory | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHelpGeneratorFactory

+
+
+
+
+
+
+
+
+
+

Help generator factory interface - implemented by the AbstractHelpGeneratorFactory (which is then extended + to suit the needs of the implementation)

+
+
+
export
+
+
interface
+

IHelpGeneratorFactory

+
+
+
+
+
+

Hierarchy

+
    +
  • + IHelpGeneratorFactory +
  • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

getHelpGenerator

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihelpgeneratorfactoryparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihelpgeneratorfactoryparms.html new file mode 100644 index 0000000000..319e0a0924 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihelpgeneratorfactoryparms.html @@ -0,0 +1,306 @@ + + + + + + IHelpGeneratorFactoryParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHelpGeneratorFactoryParms

+
+
+
+
+
+
+
+
+
+

Input to the help generator factory - normally built by imperative and passed to the command definition + infrastructure - Each instance of the help generator is created with the command being issued (and the + full command tree).

+
+
+
export
+
+
interface
+

IHelpGeneratorFactoryParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IHelpGeneratorFactoryParms +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional primaryHighlightColor

+
primaryHighlightColor: string
+ +
+
+

The primary highlight color - for the chalk package (coloring of console output)

+
+
+
memberof
+

IHelpGeneratorFactoryParms

+
+
+
+
+
+ +

Optional produceMarkdown

+
produceMarkdown: boolean
+ +
+
+

Produce a markdown file (rather than the normal help text output). Useful for providing CLI documentation

+
+
+
memberof
+

IHelpGeneratorFactoryParms

+
+
+
+
+
+ +

rootCommandName

+
rootCommandName: string
+ +
+
+

The root command for your CLI (i.e. the command that identifies your CLI/binary)

+
+
+
memberof
+

IHelpGeneratorFactoryParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihelpgeneratorparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihelpgeneratorparms.html new file mode 100644 index 0000000000..653354d99c --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihelpgeneratorparms.html @@ -0,0 +1,328 @@ + + + + + + IHelpGeneratorParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHelpGeneratorParms

+
+
+
+
+
+
+
+
+
+

The input parameters to the help generator - the command definition and the tree.

+
+
+
export
+
+
interface
+

IHelpGeneratorParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IHelpGeneratorParms +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

commandDefinition

+
commandDefinition: ICommandDefinition
+ +
+
+

The command node for the command currently being issued.

+
+
+
memberof
+

IHelpGeneratorFactoryParms

+
+
+
+
+
+ +

Optional experimentalCommandsDescription

+
experimentalCommandsDescription: string
+ +
+
+

The description text for what "experimental" means in the context of your CLI

+
+
+
memberof
+

IHelpGeneratorParms

+
+
+
+
+
+ +

fullCommandTree

+
fullCommandTree: ICommandDefinition
+ +
+
+

The entire command tree (which includes the command node for the command being issued)

+
+
+
memberof
+

IHelpGeneratorFactoryParms

+
+
+
+
+
+ +

Optional skipTextWrap

+
skipTextWrap: boolean
+ +
+
+

The indicator that the given help generator should skip introducing breaks based on terminal width

+
+
+
memberof
+

IHelpGeneratorParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihttpsoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihttpsoptions.html new file mode 100644 index 0000000000..c46bf615df --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ihttpsoptions.html @@ -0,0 +1,344 @@ + + + + + + IHTTPSOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IHTTPSOptions

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IHTTPSOptions +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional cert

+
cert: string
+ +
+
+ +

Optional hash

+
hash: string
+ +
+
+ +

headers

+
headers: OutgoingHttpHeaders
+ +
+
+ +

hostname

+
hostname: string
+ +
+
+ +

Optional key

+
key: string
+ +
+
+ +

method

+
method: HTTP_VERB
+ +
+
+ +

path

+
path: string
+ +
+
+ +

port

+
port: string
+ +
+
+ +

rejectUnauthorized

+
rejectUnauthorized: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeapi.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeapi.html new file mode 100644 index 0000000000..9dbd609817 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeapi.html @@ -0,0 +1,250 @@ + + + + + + IImperativeApi | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IImperativeApi

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeauthgroupconfig.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeauthgroupconfig.html new file mode 100644 index 0000000000..cfc1e56c09 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeauthgroupconfig.html @@ -0,0 +1,275 @@ + + + + + + IImperativeAuthGroupConfig | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IImperativeAuthGroupConfig

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IImperativeAuthGroupConfig +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional authGroup

+ + +
+
+

Command definition for "auth" command group

+
+
+
+
+ +

Optional loginGroup

+ + +
+
+

Command definition for "auth login" command group

+
+
+
+
+ +

Optional logoutGroup

+ + +
+
+

Command definition for "auth logout" command group

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeconfig.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeconfig.html new file mode 100644 index 0000000000..04b57e44fc --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeconfig.html @@ -0,0 +1,1067 @@ + + + + + + IImperativeConfig | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IImperativeConfig

+
+
+
+
+
+
+
+
+
+

All of the configuration required to set up your Imperative CLI app

+
+
+
+
+

Hierarchy

+
    +
  • + IImperativeConfig +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional allowConfigGroup

+
allowConfigGroup: boolean
+ +
+
+

Boolean flag control whether config command group is enabled or disabled. + This option is assumed to be true by default.

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional allowPlugins

+
allowPlugins: boolean
+ +
+
+

Boolean flag control whether plugins are enable or disable. + This option is assumed to be true by default.

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional apimlConnLookup

+
apimlConnLookup: IApimlSvcAttrs[]
+ +
+
+

The set of attributes used to lookup (within the API Mediation Layer) + the connection properties for the REST service associated with this + command group. We use an array of such attributes in case the command + group is compatible with multiple versions of the associated REST service.

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional authGroupConfig

+ + +
+
+

Use this property to customize the command definitions for the auth command group.

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional autoGenerateProfileCommands

+
autoGenerateProfileCommands: boolean
+ +
+
+

If you specify a list of profile configurations, you can set this to true to + automatically add a set of commands to your CLI to create, update, delete, and otherwise + manage user profiles. + Set this to false to avoid generating these commands. l + Default: true (will generate profile commands if you have defined any profiles)

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional baseProfile

+ + +
+
+

Use this property to configure a base profile for your CLI. A base profile can store shared values for fields + used by other profile types.

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional commandModuleGlobs

+
commandModuleGlobs: string[]
+ +
+
+

Array of globs (see npm glob package for details) relative to the file that + you call Imperative.init() from. + The globs should match modules (javascript files) that contain command definition trees as the default export. + Each tree from each matching file will be treated as children of the root command + Note: absolute file names will also work

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional configAutoInitCommandConfig

+
configAutoInitCommandConfig: ICommandProfileAutoInitConfig
+ +
+
+

Use this property to customize the command definition for the config init command.

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional configurationModule

+
configurationModule: string
+ +
+
+

A path to a module (javascript file) that will return a complete IImperativeConfig + object. If you use this option, anything else you specify in package.json + or your manually provided config object (i.e. Imperative.init({...}) will + be ignored. + Relative to the file that you call Imperative.init() from, unless an absolute path is provided.

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional customHelpGenerator

+
customHelpGenerator: string
+ +
+
+

A path to a module that implements the AbstractHelpGenerator. + Use this

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional daemonMode

+
daemonMode: boolean
+ +
+
+

If Imperative should run in Daemon mode + This should only be specified for CLIs

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional defaultHome

+
defaultHome: string
+ +
+
+

The home directory for your CLI's configuration, logging, + extensions, etc. + e.g. "~"/.myapp" + Defaults to ~/.yourcliname

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional definitions

+
definitions: ICommandDefinition[]
+ +
+
+

Rather than using modules, you can provide an array of definition trees of commands + that will be treated as children of the root command.

+
+

If your configuration object is being used for a plugin, these command definitions + will be added to the set of commands of the CLI into which the plugin is installed.

+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional envVariablePrefix

+
envVariablePrefix: string
+ +
+
+

Environmental variable name prefix used to construct configuration environmental variables + for your CLI. For example, . Note that + the prefix chosen should adhere to the platform env var naming standards for which your CLI + is intended to run.

+
+

Optional

+

Default: "name" value in this config (which defaults from package.json "name")

+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional experimentalCommandDescription

+
experimentalCommandDescription: string
+ +
+
+

Optionally override the block of text that appears in the help text + for commands that are set to experimental:true in their definition. + You can use this to describe what a command being experimental means to your CLI. + If you omit this, a generic block of text (Constants.DEFAULT_EXPERIMENTAL_COMMAND_EXPLANATION) + will be used by default.

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional logging

+ + +
+
+

Use this property to configure imperative logs, your CLI logs, console logs, and create new logs.

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional name

+
name: string
+ +
+
+

Identifier of your CLI following the convention of "name" as is required in a package.json.

+
+

If your configuration object is being used for a plugin, the name property is used as the + group name for your plugin. All plugin commands will be underneath this group. For example, + if the name property is YourPluginName, the plugin supplies a command named YourPluginCmd, + and you install YourPluginName into YourBaseCLI, you would issue a command like: + YourBaseCLI YourPluginName YourPluginCmd + Also see the 'rootCommandDescription' property.

+

Optional

+

Default: package.json ==> name

+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional overrides

+ + +
+
+

Optional - List of overrides you wish Imperative to use instead of the defaults.

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional pluginAliases

+
pluginAliases: string[]
+ +
+
+

If the project you are configuring is an Imperative plugin, + you can assign aliases to the group that is added when a user + installs your plugin.

+
+

So, if your plugin's name is "my-special-plugin" and you specify + ["msp"] as your value for pluginAliases, users can issue the command + "mycli my-special-plugin my-command" or "mycli msp my-command"

+

Note: For plugins only. Ignored when specified on a core/base CLI

+
+
example
+

const config: IImperativeConfig = { + ... + pluginAliases: ["msp"] + ... + }

+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional pluginFirstSteps

+
pluginFirstSteps: string
+ +
+
+

If the project you are configuring is an Imperative plugin, + you can assign the first steps to the plugin, where it will be + visible when running the firststeps command in the root plugins + level help for the core CLI.

+
+

The first steps are a short list of steps required to set up + your plugin for use.

+

Note: For plugins only. Ignored when specified on a core/base CLI

+
+
example
+

const config: IImperativeConfig = { + ... + pluginFirstSteps: "a list of first steps for your plugin" + ... + }

+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional pluginHealthCheck

+
pluginHealthCheck: string
+ +
+
+

A path to a module (javascript file) that will perform a health check for a plugin. + The health check should verify the health of the plugin. + The implementor of a plugin determines what actions + can confirm that the plugin is in an operational state.

+
+

The health check should return true if all plugin health checks pass. + It should return false otherwise.

+

This property is unused for a base CLI.

+

No Zowe CLI command currently calls the health check function.

+
+
deprecated
+
 This property is deprecated. Plugins that want to perform a health check can
+ specify the pluginLifeCycle property to load a class from the plugin.
+ The plugin can implement the postInstall() function of that class to perform
+ a health check, or any other desired operation. Our intention is to remove
+ the pluginHealthCheck property in Zowe V3.
+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional pluginLifeCycle

+
pluginLifeCycle: string
+ +
+
+

A path to a plugin's module (javascript file) that extends the AbstractPluginLifeCycle + class. The functions of that class enable a plugin to perform an action immediately + after its installation and to perform an action before its un-installation.

+
+

See AbstractPluginLifeCycle for the detailed functions.

+
+
+
+ +

Optional pluginSummary

+
pluginSummary: string
+ +
+
+

If the project you are configuring is an Imperative plugin, + you can assign a summary to the plugin that is showed in the + root level help for the core CLI. The summary is a short + description of your plugin's functionality.

+
+

Note: For plugins only. Ignored when specified on a core/base CLI

+
+
example
+

const config: IImperativeConfig = { + ... + pluginSummary: "a brief summary of your group" + ... + }

+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional primaryTextColor

+
primaryTextColor: string
+ +
+
+

Optional - choose a color that will be used for help headings and other highlighting

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional productDisplayName

+
productDisplayName: string
+ +
+
+

The display name for your CLI, used in messages

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional profiles

+ + +
+
+

Use this property to configure the available profile types for your CLI. The "type" indicates a homogeneous grouping + of profiles (think 'category'). The "schema" dictates the structure of this profile type and assists Imperative + with validating profile structure (on load) and helps imperative auto-generate profile manipulation commands.

+
+

If your configuration object is being used for a plugin, these profiles + will be added to the set of profiles of the CLI into which the plugin is installed.

+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional progressBarSpinner

+
progressBarSpinner: string
+ +
+
+

characters that will be looped through in a progress bar e.g. "|/-". + If you don't specify this, a default spinner will be used.

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional rootCommandDescription

+
rootCommandDescription: string
+ +
+
+

The description that will be displayed if the user issues your root command + (e.g. if your CLI's main command, in the "bin" field of package.json, + is "banana", they will see this when they issue "banana --help") + Typically, this is an overview description of your CLI as a whole -- it's purpose, + syntax, and information the user needs the first time they use your CLI

+
+

If your configuration object is being used for a plugin, this property will + be used as the description for the plugin's top-level group. For plugins, + this property must be specified. Also see the 'name' property.

+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional secondaryTextColor

+
secondaryTextColor: string
+ +
+
+

Optional - choose a secondary color that will be used for things like highlighting search results + and other rarer

+
+
+
memberof
+

IImperativeConfig

+
+
+
+
+
+ +

Optional webHelpCustomCssPath

+
webHelpCustomCssPath: string
+ +
+
+

Optionally specify path to a custom CSS file for web help. + It will replace the main.css file that controls the style of the page.

+
+
+
+
+ +

Optional webHelpLogoImgPath

+
webHelpLogoImgPath: string
+ +
+
+

Optionally specify path to an image of logo for your CLI. + It will be displayed at the top of web help pages.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeenvironmentalvariablesetting.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeenvironmentalvariablesetting.html new file mode 100644 index 0000000000..27dddbd74e --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeenvironmentalvariablesetting.html @@ -0,0 +1,266 @@ + + + + + + IImperativeEnvironmentalVariableSetting | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IImperativeEnvironmentalVariableSetting

+
+
+
+
+
+
+
+
+
+

Interface representing a single setting

+
+
+
+
+

Hierarchy

+
    +
  • + IImperativeEnvironmentalVariableSetting +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

key

+
key: string
+ +
+
+

The key to the process.env object + AKA. the environmental variable name + e.g. MYCLI_APP_LOG_LEVEL

+
+
+
+
+ +

value

+
value: string
+ +
+
+

The value specified by the user for this variable, if any + e.g. "DEBUG"

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeenvironmentalvariablesettings.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeenvironmentalvariablesettings.html new file mode 100644 index 0000000000..f5c8343ff2 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeenvironmentalvariablesettings.html @@ -0,0 +1,344 @@ + + + + + + IImperativeEnvironmentalVariableSettings | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IImperativeEnvironmentalVariableSettings

+
+
+
+
+
+
+
+
+
+

Interface representing variables set via environmental + variables for CLIs based on Imperative

+
+
+
+
+

Hierarchy

+
    +
  • + IImperativeEnvironmentalVariableSettings +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional appLogLevel

+ + +
+
+

Override the log level for the app log file (named after your CLI project)

+
+
+
+
+ +

Optional cliHome

+ + +
+
+

The home for the CLI where logs, profiles, and other data are stored

+
+
+
+
+ +

Optional imperativeLogLevel

+ + +
+
+

Override the log level for the "imperative" log file for your CLI

+
+
+
+
+ +

Optional maskOutput

+ + +
+
+

The indication that sensitive data should be obscured in the CLI + default is TRUE

+
+
+
+
+ +

Optional pluginsDir

+ + +
+
+

The directory where CLI plugins are installed. + Default is ${cliHome}/plugins.

+
+
+
+
+ +

Optional promptPhrase

+ + +
+
+

The phrase which, when entered as the value of a command line argument, indicates + Imperative should prompt the user and hide their text entry + default is PROMPT*

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeerror.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeerror.html new file mode 100644 index 0000000000..a86f35bb6c --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeerror.html @@ -0,0 +1,381 @@ + + + + + + IImperativeError | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IImperativeError

+
+
+
+
+
+
+
+
+
+

Defines an error that occurred in the CLI.

+
+
+
export
+
+
interface
+

IImperativeError

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional additionalDetails

+
additionalDetails: string
+ +
+
+

any other extra contextual information (e.g. details pulled out of the cause errors)

+
+
+
memberof
+

IImperativeError

+
+
+
+
+
+ +

Optional causeErrors

+
causeErrors: any
+ +
+
+

Original errors that caused/influenced this one

+
+
+
memberof
+

IImperativeError

+
+
+
+
+
+ +

Optional errorCode

+
errorCode: string
+ +
+
+

If applicable, an error code, for example, HTTP status code surrounding the error

+
+
+
memberof
+

IImperativeError

+
+
+
+
+
+ +

msg

+
msg: string
+ +
+
+

Message text of the error

+
+
+
memberof
+

IImperativeError

+
+
+
+
+
+ +

Optional stack

+
stack: string
+ +
+
+

Error status

+
+
+
memberof
+

IImperativeError

+
+
+
+
+
+ +

Optional suppressDump

+
suppressDump: boolean
+ +
+
+

Whether or not the error should suppress a full error dump, like in Imperative init

+
+
+
memberof
+

IImperativeError

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeerrorparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeerrorparms.html new file mode 100644 index 0000000000..b0c6ee2323 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeerrorparms.html @@ -0,0 +1,287 @@ + + + + + + IImperativeErrorParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IImperativeErrorParms

+
+
+
+
+
+
+
+
+
+

Imperative Standard Error - All Imperative services/utils must thrown an Imperative Error (not a generic Error). + The Imperative Error collects additional diagnostics and most (if not all) Imperative Promises

+
+
+
export
+
+
interface
+

IImperativeErrorParms

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional logger

+
logger: Logger
+ +
+
+

Logger for the Imperative Error (logs messages and the node report that is generated upon request)

+
+
+
memberof
+

IImperativeErrorParms

+
+
+
+
+
+ +

Optional tag

+
tag: string
+ +
+
+

Message tag - prepended to the error message specified. Useful for categorizing error messages + (e.g. "Profile IO Error"). A ": " is appended automatically (e.g. "Profile IO Error: ")

+
+
+
memberof
+

IImperativeErrorParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeloggingconfig.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeloggingconfig.html new file mode 100644 index 0000000000..88143aeb43 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativeloggingconfig.html @@ -0,0 +1,289 @@ + + + + + + IImperativeLoggingConfig | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IImperativeLoggingConfig

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IImperativeLoggingConfig +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional apiName

+
apiName: string
+ +
+
+

"imperative", "app", and "console" are reserved. Use this field to + create additional log API entities. + There is no default. This field is required when defining extra entries, + and its content is ignored for predefined loggers (imperative, console, and app loggers)

+
+
+
+
+ +

Optional level

+
level: string
+ +
+
+

Select a specific log level setting, for example, if a log setting of "fatal" + is used, only "fatal" level messages will appear within the log. However, + if "debug" level messages are selected, "debug", "info", "warn", "error", + and "fatal" messages will appear within the log.

+
+

Accepted values are: + trace, debug, info, warn, error, fatal

+

Default: + debug

+
+
+
+ +

Optional logFile

+
logFile: string
+ +
+
+

Specify a log level name. An app's logging object is accessible via the + Imperative.api.appLogging object.

+
+

Default will direct log output to + ~/./logs/.log

+

is controlled via "name" setting in IImperativeConfig.

+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativelogsconfig.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativelogsconfig.html new file mode 100644 index 0000000000..9451a8f083 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iimperativelogsconfig.html @@ -0,0 +1,283 @@ + + + + + + IImperativeLogsConfig | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IImperativeLogsConfig

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IImperativeLogsConfig +
  • +
+
+
+

Indexable

+
[key: string]: any
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional additionalLogging

+
additionalLogging: IImperativeLoggingConfig[]
+ +
+
+

Use this property to configure additional log files and preferences if needed.

+
+
+
+
+ +

Optional appLogging

+ + +
+
+

Use this property to configure your applications logging preferences. Defaults are provided and this + property must only be supplied to override defaults. See the IImperativeLoggingConfig document for more + information.

+
+
+
+
+ +

Optional imperativeLogging

+
imperativeLogging: IImperativeLoggingConfig
+ +
+
+

Use this property to configure imperative logging preferences. Defaults are provided and this + property must only be supplied to override defaults. See the IImperativeLoggingConfig document for more + information.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iinvokecommandparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iinvokecommandparms.html new file mode 100644 index 0000000000..d58b901491 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iinvokecommandparms.html @@ -0,0 +1,305 @@ + + + + + + IInvokeCommandParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IInvokeCommandParms

+
+
+
+
+
+
+
+
+
+

Parameters to the command processor invoke method.

+
+
+
export
+
+
interface
+

IInvokeCommandParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IInvokeCommandParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

arguments

+
arguments: Arguments
+ +
+
+

The Yargs style arguments for the command processor.

+
+
+
memberof
+

IInvokeCommandParms

+
+
+
+
+
+ +

Optional responseFormat

+
responseFormat: COMMAND_RESPONSE_FORMAT
+ +
+
+

Indicates that the response format to the command should be written in JSON. If silent mode is enabled, then + nothing is written (regardless of this setting)

+
+
+
memberof
+

IInvokeCommandParms

+
+
+
+
+
+ +

Optional silent

+
silent: boolean
+ +
+
+

Indicates that the command should be totally silent (no output to the console).

+
+
+
memberof
+

IInvokeCommandParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iloadallprofiles.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iloadallprofiles.html new file mode 100644 index 0000000000..210389085c --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iloadallprofiles.html @@ -0,0 +1,286 @@ + + + + + + ILoadAllProfiles | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ILoadAllProfiles

+
+
+
+
+
+
+
+
+
+

Optional parameters to profile manager load all profiles

+
+
+
export
+
+
interface
+

ILoadAllProfiles

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional noSecure

+
noSecure: boolean
+ +
+
+

If true, do not load secure fields

+
+
+
memberof
+

ILoadAllProfiles

+
+
+
+
+
+ +

Optional typeOnly

+
typeOnly: boolean
+ +
+
+

If true, loads only the profiles of the current instance of the profile + managers "type" - specified when allocating the profile manager.

+
+
+
memberof
+

ILoadAllProfiles

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iloadprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iloadprofile.html new file mode 100644 index 0000000000..99f8cd36f0 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iloadprofile.html @@ -0,0 +1,364 @@ + + + + + + ILoadProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ILoadProfile

+
+
+
+
+
+
+
+
+
+

Profile Manager "loadProfile" input parameters. Indicates which profile to load (named or default) and if + not finding the profile should be considered and error, etc.

+
+
+
export
+
+
interface
+

ILoadProfile

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional failNotFound

+
failNotFound: boolean
+ +
+
+

Under "normal" circumstances, attempting to load a non-existant profile is an error, however, you may indicate + that the profile manager should treat this as a "soft" failure, meaning the promise for the load API will + be fulfilled - with the appropriate status message and no profile.

+
+
+
memberof
+

ILoadProfile

+
+
+
+
+
+ +

Optional loadDefault

+
loadDefault: boolean
+ +
+
+

Load the default profile for the "type" specified in the profile manager instance - if specified, "name" is + ignored.

+
+
+
memberof
+

ILoadProfile

+
+
+
+
+
+ +

Optional loadDependencies

+
loadDependencies: boolean
+ +
+
+

Profiles can have dependencies. Specify "false" if you want to avoid loading the dependencies of this profile. + True is the default.

+
+
+
memberof
+

ILoadProfile

+
+
+
+
+
+ +

Optional name

+
name: string
+ +
+
+

The name of the profile to load - ignored if "loadDefault" is true - the type is indicated by the + instance of the instantiated profile manager.

+
+
+
memberof
+

ILoadProfile

+
+
+
+
+
+ +

Optional noSecure

+
noSecure: boolean
+ +
+
+

If true, fields that indicate "secure" are not loaded. The properties will still be present in the profiles + loaded with a value of "securely_stored".

+
+
+
memberof
+

ILoadProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ilog4jsappender.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ilog4jsappender.html new file mode 100644 index 0000000000..a68c04b789 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ilog4jsappender.html @@ -0,0 +1,250 @@ + + + + + + ILog4jsAppender | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ILog4jsAppender

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ilog4jsconfig.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ilog4jsconfig.html new file mode 100644 index 0000000000..64b4fa87fe --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ilog4jsconfig.html @@ -0,0 +1,270 @@ + + + + + + ILog4jsConfig | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ILog4jsConfig

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ILog4jsConfig +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

appenders

+
appenders: {}
+ +
+

Type declaration

+ +
+
+
+ +

categories

+
categories: {}
+ +
+

Type declaration

+
    +
  • +
    [key: string]: { appenders: string[]; level: string }
    +
      +
    • +
      appenders: string[]
      +
    • +
    • +
      level: string
      +
    • +
    +
  • +
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ilog4jslayout.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ilog4jslayout.html new file mode 100644 index 0000000000..59283d5b28 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ilog4jslayout.html @@ -0,0 +1,246 @@ + + + + + + ILog4jsLayout | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ILog4jsLayout

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.imessagedefinition.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.imessagedefinition.html new file mode 100644 index 0000000000..1a811db8bb --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.imessagedefinition.html @@ -0,0 +1,254 @@ + + + + + + IMessageDefinition | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IMessageDefinition

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IMessageDefinition +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional locales

+
locales: {}
+ +
+

Type declaration

+
    +
  • +
    [key: string]: string
    +
  • +
+
+
+
+ +

message

+
message: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.imetaprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.imetaprofile.html new file mode 100644 index 0000000000..d5998500bc --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.imetaprofile.html @@ -0,0 +1,294 @@ + + + + + + IMetaProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IMetaProfile<T>

+
+
+
+
+
+
+
+
+
+

The meta profile is saved in each of the profile "type" directories under the profile manager root directory. + The meta profile is always named "_meta" and is always stored in YAML format. The contents contain the + default profile for the type AND the configuration document for the type. The configuration document is persisted + to allow external callers of the Profile Manager APIs (outside of an Imperative init'd environment) to load/save + profiles (useful for programmatic invocation from editor plugins, such as VS Code).

+
+
+
export
+
+
interface
+

IMetaProfile

+
+
+
+
+
+

Type parameters

+ +
+
+

Hierarchy

+
    +
  • + IMetaProfile +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

configuration

+
configuration: T
+ +
+
+

The Configuration Document supplied for this type.

+
+
+
memberof
+

IMetaProfile

+
+
+
+
+
+ +

defaultProfile

+
defaultProfile: string
+ +
+
+

The default profile for the "type" - this profile will be loaded by the manager if the default is requested. + This is a convience for users of the CLI (and programmatic invocation) to avoid having to supply a profile + name for the type. You can also set the default using the Profile Manager APIs.

+
+
+
memberof
+

IMetaProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioperationresult.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioperationresult.html new file mode 100644 index 0000000000..8a99ccc7be --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioperationresult.html @@ -0,0 +1,436 @@ + + + + + + IOperationResult | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IOperationResult<T>

+
+
+
+
+
+
+
+

Type parameters

+
    +
  • +

    T

    +
  • +
+
+
+

Hierarchy

+
    +
  • + IOperationResult +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

continuePath

+
continuePath: boolean
+ +
+
+ +

critical

+
critical: boolean
+ +
+
+ +

diverge

+
diverge: boolean
+ +
+
+ +

divergeTo

+
divergeTo: Operation<any>
+ +
+
+ +

errorMessages

+
errorMessages: string[]
+ +
+
+ +

infoMessages

+
infoMessages: string[]
+ +
+
+ +

nextOperationResult

+
nextOperationResult: IOperationResult<any>
+ +
+
+ +

operationFailed

+
operationFailed: boolean
+ +
+
+ +

operationName

+
operationName: string
+ +
+
+ +

operationObject

+
operationObject: Operation<any>
+ +
+
+ +

operationUndoAttempted

+
operationUndoAttempted: boolean
+ +
+
+ +

operationUndoFailed

+
operationUndoFailed: boolean
+ +
+
+ +

operationUndoPossible

+
operationUndoPossible: boolean
+ +
+
+ +

output

+
output: T
+ +
+
+ +

resultMessage

+
resultMessage: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioptionformat.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioptionformat.html new file mode 100644 index 0000000000..0581f3b0d2 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioptionformat.html @@ -0,0 +1,289 @@ + + + + + + IOptionFormat | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IOptionFormat

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IOptionFormat +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

camelCase

+
camelCase: string
+ +
+
+

The camel cased format of an option.

+
+ +

Example:

+
+

this-is-a-test -> thisIsATest

+
+
+
+ +

kebabCase

+
kebabCase: string
+ +
+
+

The kebab cased format of an option key

+
+ +

Example:

+
+

thisIsATest -> this-is-a-test

+
+
+
+ +

key

+
key: string
+ +
+
+

The untouched original key.

+
+ +

Example:

+
+

thisIsATest-test-here -> thisIsATest-test-here

+

camelCase: thisIsATestTestHere + kebabCase: this-is-a-test-test-here

+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioptionsforaddconnprops.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioptionsforaddconnprops.html new file mode 100644 index 0000000000..38e78ae0f1 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioptionsforaddconnprops.html @@ -0,0 +1,440 @@ + + + + + + IOptionsForAddConnProps | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IOptionsForAddConnProps

+
+
+
+
+
+
+
+
+
+

Interface for options supplied to ConnectionPropsForSessCfg.addPropsOrPrompt()

+
+
+
export
+
+
interface
+

ISession

+
+
+
+
+
+

Hierarchy

+
    +
  • + IOptionsForAddConnProps +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional autoStore

+
autoStore: boolean
+ +
+
+

Specifies if properties that the user was prompted for should be + automatically stored in profiles. Defaults to true when team config + exists.

+
+
+
+
+ +

Optional defaultTokenType

+
defaultTokenType: SessConstants.TOKEN_TYPE_CHOICES
+ +
+
+

Specifies the default token type if not provided on the command line. + Some commands such as "auth login" do not have a "tokenType" command line + option, but still need to specify a default token type. + The default value is TOKEN_TYPE_JWT.

+
+
+
+
+ +

Optional doPrompting

+
doPrompting: boolean
+ +
+
+

Indicates that want to prompt for user name and password when + no form of credentials are supplied. CLI programs typically + want this to be true. A GUI app calling the API may do its + own prompting in the GUI and would set this value to false. + The default value is true.

+
+
+
+
+ +

Optional parms

+ + +
+
+

Specifies full command parameter object if running in a CLI environment (versus) as + a Node.js SDK

+
+
+
memberof
+

IOptionsForAddConnProps

+
+
+
+
+
+ +

Optional propertyOverrides

+
propertyOverrides: IOverridePromptConnProps[]
+ +
+
+

Specifies a list of authentication properties, and what they should override. + If one of these properties is available on the session, do not prompt for the other property.

+
+
+
+
+ +

Optional requestToken

+
requestToken: boolean
+ +
+
+

Indicates that we want to generate a token. + When true, we use the user and password for the operation + to obtain a token. This applies during a login command. + Otherwise, you typically want this to be false. + The default value is false.

+
+
+
+
+ +

Optional serviceDescription

+
serviceDescription: string
+ +
+
+

Specifies the description of your service to be used in CLI prompt + messages. If undefined, the default value is "your service".

+
+
+
+
+
+

Methods

+
+ +

Optional getValuesBack

+
    +
  • getValuesBack(properties: string[]): {}
  • +
+
    +
  • + +
    +
    +

    Specifies the functionality that external applications will use for prompting. + Activate this function to get all the needed properties

    +
    +
    +
    example
    +

    const connectableSessCfg = await ConnectionPropsForSessCfg.addPropsOrPrompt( + sessCfg, commandParameters.arguments, {getValuesBack: YourOwnFunction} + );

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      properties: string[]
      +
    • +
    +

    Returns {}

    +
      +
    • +
      [key: string]: any
      +
    • +
    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioptionsfullresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioptionsfullresponse.html new file mode 100644 index 0000000000..108f7f2bdf --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioptionsfullresponse.html @@ -0,0 +1,450 @@ + + + + + + IOptionsFullResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IOptionsFullResponse

+
+
+
+
+
+
+
+
+
+

Interface to define input options for RestClient GET|POST|PUT|DELETE ExpectFullResponse methods

+
+
+
export
+
+
interface
+

IOptionsFullResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IOptionsFullResponse +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional dataToReturn

+
dataToReturn: CLIENT_PROPERTY[]
+ +
+
+

List of properties to return from REST call

+
+
+
memberof
+

IFullResponseOptions

+
+
+
+
+
+ +

Optional normalizeRequestNewLines

+
normalizeRequestNewLines: boolean
+ +
+
+

true if you want \r\n to be replaced with \n when sending + data to the server from requestStream. Don't set this for binary requests

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

Optional normalizeResponseNewLines

+
normalizeResponseNewLines: boolean
+ +
+
+

true if you want newlines to be \r\n on windows + when receiving data from the server to responseStream. Don't set this for binary responses

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

Optional reqHeaders

+
reqHeaders: any[]
+ +
+
+

Headers to include with request

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

Optional requestStream

+
requestStream: Readable
+ +
+
+

Stream for outgoing request data to the server

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

resource

+
resource: string
+ +
+
+

URI for this request

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

Optional responseStream

+
responseStream: Writable
+ +
+
+

Stream for incoming response data from the server. If specified, response data will not be buffered

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

Optional task

+ + +
+
+

Task that will automatically be updated to report progress of upload or download to user

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

Optional writeData

+
writeData: any
+ +
+
+

Data to write on this REST request

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioverridepromptconnprops.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioverridepromptconnprops.html new file mode 100644 index 0000000000..145e98b924 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ioverridepromptconnprops.html @@ -0,0 +1,293 @@ + + + + + + IOverridePromptConnProps | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IOverridePromptConnProps

+
+
+
+
+
+
+
+
+
+

Interface for overriding the prompting behavior of ConnectionPropsForSessCfg.addPropsOrPrompt()

+
+
+
export
+
+
interface
+

IOverridePromptConnProps

+
+
+
+
+
+

Hierarchy

+
    +
  • + IOverridePromptConnProps +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional argumentName

+
argumentName: string
+ +
+
+

Indicates the CLI argument that should be used to populate the property on the session. + If not supplied, uses a CLI argument that matches the session property name.

+
+
+
+
+ +

propertiesOverridden

+
propertiesOverridden: keyof ISession[]
+ +
+
+

Indicates the prompting fields the property should override. For example, if the property should be the preferred method of authentication, + then it should override user and password. Then, if the property is on the session, it will not prompt for user and password. + Prompting logic is only in place for host, port, user, and password, but cert, certKey, tokenType, and tokenValue may also need + to be overridden.

+
+
+
+
+ +

propertyName

+
propertyName: string
+ +
+
+

Indicates the session property that should be considered in the prompting logic.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipartialcommanddefinition.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipartialcommanddefinition.html new file mode 100644 index 0000000000..700db6e952 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipartialcommanddefinition.html @@ -0,0 +1,321 @@ + + + + + + IPartialCommandDefinition | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPartialCommandDefinition

+
+
+
+
+
+
+
+
+
+

Interface that allows CLIs to override properties on command definitions.

+
+
+
+
+

Hierarchy

+
    +
  • + IPartialCommandDefinition +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional description

+
description: string
+ +
+
+

The description - keep group descriptions "small" and include lengthier descriptions for "commands".

+
+
+
memberof
+

IPartialCommandDefinition

+
+
+
+
+
+ +

Optional examples

+ + +
+
+

The set of examples displayed in the help for this command.

+
+
+
memberof
+

IPartialCommandDefinition

+
+
+
+
+
+ +

Optional options

+ + +
+
+

The options to be exposed on the command.

+
+
+
memberof
+

IPartialCommandDefinition

+
+
+
+
+
+ +

Optional summary

+
summary: string
+ +
+
+

A shorter (~one line) description of your command

+
+
+
memberof
+

IPartialCommandDefinition

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iplugincfgprops.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iplugincfgprops.html new file mode 100644 index 0000000000..168d20a732 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iplugincfgprops.html @@ -0,0 +1,296 @@ + + + + + + IPluginCfgProps | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPluginCfgProps

+
+
+
+
+
+
+
+
+
+

A plugin's configuration properties. + All are obtained from the plugin's package.json.

+
+
+
+
+

Hierarchy

+
    +
  • + IPluginCfgProps +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

cliDependency

+
cliDependency: IPluginPeerDepends
+ +
+
+ +

impConfig

+ + +
+
+ +

impDependency

+
impDependency: IPluginPeerDepends
+ +
+
+ +

npmPackageName

+
npmPackageName: string
+ +
+
+ +

pluginName

+
pluginName: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginissue.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginissue.html new file mode 100644 index 0000000000..b41f1e81c6 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginissue.html @@ -0,0 +1,251 @@ + + + + + + IPluginIssue | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPluginIssue

+
+
+
+
+ +
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginissues.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginissues.html new file mode 100644 index 0000000000..cbd82b5231 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginissues.html @@ -0,0 +1,221 @@ + + + + + + IPluginIssues | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPluginIssues

+
+
+
+
+
+
+
+
+
+

Structure for the list of plugin issues.

+
+
+
+
+

Hierarchy

+
    +
  • + IPluginIssues +
  • +
+
+
+

Indexable

+
[pluginName: string]: { issueList: IPluginIssue[] }
+
+
+

The plugin name is the key into a hash of validation issues.

+
+
+ +
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginjson.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginjson.html new file mode 100644 index 0000000000..970e3a59b2 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginjson.html @@ -0,0 +1,217 @@ + + + + + + IPluginJson | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPluginJson

+
+
+
+
+
+
+
+
+
+

Format of plugins.json file. Represents the list of installed plugins.

+
+
+
+
+

Hierarchy

+
    +
  • + IPluginJson +
  • +
+
+
+

Indexable

+
[key: string]: IPluginJsonObject
+
+
+

Each object key is the name of a plugin and the value is information about + said plugin.

+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginjsonobject.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginjsonobject.html new file mode 100644 index 0000000000..80d7a1b6b4 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginjsonobject.html @@ -0,0 +1,283 @@ + + + + + + IPluginJsonObject | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPluginJsonObject

+
+
+
+
+
+
+
+
+
+

Information about an installed plugin

+
+
+
+
+

Hierarchy

+
    +
  • + IPluginJsonObject +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

package

+
package: string
+ +
+
+

The package location. If this is an npm package, this will be no different + than the key in the JSON file.

+
+
+
+
+ +

registry

+
registry: string
+ +
+
+

The npm registry to install from.

+
+
+
+
+ +

version

+
version: string
+ +
+
+

The version of the installed plugin.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginpeerdepends.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginpeerdepends.html new file mode 100644 index 0000000000..af78936d3e --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipluginpeerdepends.html @@ -0,0 +1,259 @@ + + + + + + IPluginPeerDepends | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPluginPeerDepends

+
+
+
+
+
+
+
+
+
+

Object to hold a plugin's peer dependencies version numbers.

+
+
+
+
+

Hierarchy

+
    +
  • + IPluginPeerDepends +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

peerDepName

+
peerDepName: string
+ +
+
+

Each object key is the name of a plugin's peer dependency + and the value is the version string for that dependency.

+
+
+
+
+ +

peerDepVer

+
peerDepVer: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprobtest.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprobtest.html new file mode 100644 index 0000000000..9f32c522bf --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprobtest.html @@ -0,0 +1,269 @@ + + + + + + IProbTest | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProbTest

+
+
+
+
+
+
+
+
+
+

This is the structure for defining a test to identify if a problem exists + for a given runtime environment item, and the message to give when the + problem is detected.

+
+
+
+
+

Hierarchy

+
    +
  • + IProbTest +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

itemId

+
itemId: ItemId
+ +
+
+ +

probExpr

+
probExpr: string
+ +
+
+ +

probMsg

+
probMsg: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofargattrs.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofargattrs.html new file mode 100644 index 0000000000..6953813dbc --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofargattrs.html @@ -0,0 +1,339 @@ + + + + + + IProfArgAttrs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfArgAttrs

+
+
+
+
+
+
+
+
+
+

The attributes of a profile argument.

+
+
+
+
+

Hierarchy

+
    +
  • + IProfArgAttrs +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

argLoc

+
argLoc: IProfLoc
+ +
+
+

The location of this argument

+
+
+
+
+ +

argName

+
argName: string
+ +
+
+

The name of the argument

+
+
+
+
+ +

argValue

+
argValue: IProfArgValue
+ +
+
+

The value for the argument

+
+
+
+
+ +

dataType

+
dataType: IProfDataType
+ +
+
+

The type of data for this property

+
+
+
+
+ +

Optional inSchema

+
inSchema: boolean
+ +
+
+

Whether the argument value is defined in the schema file

+
+
+
+
+ +

Optional secure

+
secure: boolean
+ +
+
+

Whether the argument value is stored securely

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofattrs.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofattrs.html new file mode 100644 index 0000000000..1b5c060678 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofattrs.html @@ -0,0 +1,304 @@ + + + + + + IProfAttrs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfAttrs

+
+
+
+
+
+
+
+
+
+

The identifying attributes of a profile.

+
+
+
+
+

Hierarchy

+
    +
  • + IProfAttrs +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

isDefaultProfile

+
isDefaultProfile: boolean
+ +
+
+

Indicates if this is the default profile for this type

+
+
+
+
+ +

profLoc

+
profLoc: IProfLoc
+ +
+
+

Location of this profile. + profNmLoc.ProfLocType can never be ProfLocType.ENV or + ProfLocType.DEFAULT, because this is the location of a profile, + not an argument value.

+
+
+
+
+ +

profName

+
profName: string
+ +
+
+

The name of the profile

+
+
+
+
+ +

profType

+
profType: string
+ +
+
+

The profile type (eg. "zosmf")

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofile.html new file mode 100644 index 0000000000..02561940f6 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofile.html @@ -0,0 +1,299 @@ + + + + + + IProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfile

+
+
+
+
+
+
+
+
+
+

Profiles are a user configuration mechanism built into the Imperative framework and profiles are intended to be + exploited on commands that require large sets of configuration items (more than would be feasible on the command + line). In addition, profiles allow users to dynamically and easily switch configuration for the invocation of a + particular command. One common use case for profiles, is storing "connection details" (host, user, API version, + port, credentials, etc.) required by a command to communicate with a remote instance/service.

+
+

Another feature of profiles are "dependencies". A profile can "point to" any number of additional profiles, which + will be loaded when the original is loaded. A common use case for this feature is if you need "connection + details" (to communicate with a remote instance), but the unique serivce you are invoking also requires additional + input/configuration. You can "point to", via the dependencies, the "connection details" profile.

+

Profiles also help you segregate/isolate portions of your CLI (if it is complex enough to warrent). For example, + a common pattern is to organize your CLI via "groups", where each group is isolated and requires seperate + configuration.

+

Profiles are loaded (sometimes automatically, by definition on your commands) for the invocation of that command. + Meaning, they are only loaded when needed/required.

+

See the "ProfileManager" for profile management details.

+
+
export
+
+
interface
+

IProfile

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProfile +
  • +
+
+
+

Indexable

+
[key: string]: any
+
+
+

Indexable.

+
+

Another feature of profiles are "dependencies". A profile can "point to" any number of additional profiles, which + will be loaded when the original is loaded. A common use case for this feature is if you need "connection + details" (to communicate with a remote instance), but the unique serivce you are invoking also requires additional + input/configuration. You can "point to", via the dependencies, the "connection details" profile.

+

Profiles also help you segregate/isolate portions of your CLI (if it is complex enough to warrent). For example, + a common pattern is to organize your CLI via "groups", where each group is isolated and requires seperate + configuration.

+

Profiles are loaded (sometimes automatically, by definition on your commands) for the invocation of that command. + Meaning, they are only loaded when needed/required.

+

See the "ProfileManager" for profile management details.

+
+
export
+
+
interface
+

IProfile

+
+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional dependencies

+
dependencies: Array<{ name?: string; type: string }>
+ +
+
+

The list of profile that this profile is dependent on. Can be explicitly named (for tight coupling of + interdependent profiles). Profile dependencies are useful to help complex CLIs segregate/isolate profile (and + for example, command groups) configurations, while allowing for reuse of configuration where needed. A profile + can have any number of dependencies of any type.

+
+
+
memberof
+

IProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofiledeleted.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofiledeleted.html new file mode 100644 index 0000000000..a42001f265 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofiledeleted.html @@ -0,0 +1,304 @@ + + + + + + IProfileDeleted | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileDeleted

+
+
+
+
+
+
+
+
+
+

The success response to the profile "delete()" API.

+
+
+
export
+
+
interface
+

IProfileDeleted

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProfileDeleted +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional defaultCleared

+
defaultCleared: boolean
+ +
+
+

Specifies whether the default profile was cleared.

+
+
+
memberof
+

IProfileDeleted

+
+
+
+
+
+ +

message

+
message: string
+ +
+
+

The message - for display purposes - e.g. The profile was successfully deleted.

+
+
+
memberof
+

IProfileDeleted

+
+
+
+
+
+ +

path

+
path: string
+ +
+
+

The path to the profile that was deleted.

+
+
+
memberof
+

IProfileDeleted

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofiledependency.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofiledependency.html new file mode 100644 index 0000000000..abb40a5b99 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofiledependency.html @@ -0,0 +1,288 @@ + + + + + + IProfileDependency | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileDependency

+
+
+
+
+
+
+
+
+
+

Definition for a dependency on another profile. + For example you can have a "fruit-ordering" profile which depends on a particular + instance of a "banana" type profile. + This way when you are issuing commands that require a "fruit-ordering" profile, + you can associate a particular set of settings of type "banana".

+
+
+
+
+

Hierarchy

+
    +
  • + IProfileDependency +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional description

+
description: string
+ +
+
+

The description to expose on the auto-generated command line options + on profile create and update commands.

+
+
+
+
+ +

required

+
required: boolean
+ +
+
+

Can the user use your profile without associating a dependent profile with it? + If so, it is not required.

+
+
+
+
+ +

type

+
type: string
+ +
+
+

The name of the profile type

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileinitialized.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileinitialized.html new file mode 100644 index 0000000000..a7c8aebdc9 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileinitialized.html @@ -0,0 +1,257 @@ + + + + + + IProfileInitialized | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileInitialized

+
+
+
+
+
+
+
+
+
+

Response to the Basic profile manager's initialize API - normally provided as an array to the caller indicating + each profile type that was initialized.

+
+
+
export
+
+
interface
+

IProfileInitialized

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProfileInitialized +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

message

+
message: string
+ +
+
+

The message indicating that the profile type was initialized or re-initialized.

+
+
+
memberof
+

IProfileInitialized

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileloaded.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileloaded.html new file mode 100644 index 0000000000..8d2ecddf2d --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileloaded.html @@ -0,0 +1,426 @@ + + + + + + IProfileLoaded | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileLoaded

+
+
+
+
+
+
+
+
+
+

The success response to the profile "load()" API.

+
+
+
export
+
+
interface
+

IProfileLoaded

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProfileLoaded +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional dependenciesLoaded

+
dependenciesLoaded: boolean
+ +
+
+

Indicates that mutliple profiles were loaded - due to dependencies.

+
+
+
memberof
+

IProfileLoaded

+
+
+
+
+
+ +

Optional dependencyLoadResponses

+
dependencyLoadResponses: IProfileLoaded[]
+ +
+
+

Full set of profile loaded responses.

+
+
+
memberof
+

IProfileLoaded

+
+
+
+
+
+ +

failNotFound

+
failNotFound: boolean
+ +
+
+

The "failNotFound" specification value on original request.

+
+
+
memberof
+

IProfileLoaded

+
+
+
+
+
+ +

message

+
message: string
+ +
+
+

API response message - for display and logging purposes

+
+
+
memberof
+

IProfileLoaded

+
+
+
+
+
+ +

Optional name

+
name: string
+ +
+
+

The name of the profile

+
+
+
memberof
+

IProfileLoaded

+
+
+
+
+
+ +

Optional profile

+
profile: IProfile
+ +
+
+

The profile contents.

+
+
+
memberof
+

IProfileLoaded

+
+
+
+
+
+ +

Optional referencedBy

+
referencedBy: string
+ +
+
+

Indicates the a profile type that references this profile - populated when the dependencies are + loaded for a particular profile chain + TODO - this might no longer be necessary - will need to investigate the impact on the command processor (loading profs)

+
+
+
memberof
+

IProfileLoaded

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

The profile "type" of the profile loaded.

+
+
+
memberof
+

IProfileLoaded

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilemanager.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilemanager.html new file mode 100644 index 0000000000..435ce96cae --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilemanager.html @@ -0,0 +1,378 @@ + + + + + + IProfileManager | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileManager<T>

+
+
+
+
+
+
+
+

Type parameters

+ +
+
+

Hierarchy

+
    +
  • + IProfileManager +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional loadCounter

+
loadCounter: Map<string, number>
+ +
+
+

Map of which profile types have been loaded so far, to avoid circular profile loads + Used internally by profile manager classes

+
+
+
+
+ +

Optional logger

+
logger: Logger
+ +
+
+

The logger object to use in the profile manager. Normally the imperative logger, but can be any + arbitrary log4js logger.

+
+
+
memberof
+

IProfileManager

+
+
+
+
+
+ +

Optional productDisplayName

+
productDisplayName: string
+ +
+
+

Product display name of CLI

+
+
+
memberof
+

IProfileManager

+
+
+
+
+
+ +

profileRootDirectory

+
profileRootDirectory: string
+ +
+
+

The profiles directory (normally obtained from the Imperative config). The profile root directory contains + a list of type directories, within each will be the profiles of that type and the meta file. The meta file + for a type contains the default specifications and the profile type configuration document. Use the "initialize" + API method on the Profile Manager to create the appropriate structure based on your configuration documents.

+
+
+
memberof
+

IProfileManager

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

The profile type for this manager - the configuration document for the type can either be supplied on the + "typeConfigurations" property on this object OR the mananger will attempt to extract it from the profile + root directory type meta file. If the type configuration cannot be located, an exception will be thrown.

+
+
+
memberof
+

IProfileManager

+
+
+
+
+
+ +

Optional typeConfigurations

+
typeConfigurations: T[]
+ +
+
+

Contains all profile type configuration documents - used to obtain the schema for the profile type passed on the + profile manager and for dependency loading of profiles of other types.

+
+

If this parameter is NOT supplied to the constructor of the Profile Manager, the manager will attempt to read + the configurations from each of the profile type meta files when the object is being instaitiated. If it fails + to locate a configuration for the profile type specified, manager creation will fail. You can either supply + the configurations to the constructor OR execute the "initialize" static API to create all type directories and + their meta configuration files.

+
+
memberof
+

IProfileManager

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilemanagerfactory.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilemanagerfactory.html new file mode 100644 index 0000000000..cc09f5c99e --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilemanagerfactory.html @@ -0,0 +1,298 @@ + + + + + + IProfileManagerFactory | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileManagerFactory<T>

+
+
+
+
+
+
+
+
+
+

Profile manager factory inteface - implemented by the abstract profile manager in this profiles + package and created by Imperative and other packages that need to influence the way the profile manager + is allocated, configured.

+
+
+
export
+
+
interface
+

IProfileManagerFactory

+
+
+
+
+
+

Type parameters

+ +
+
+

Hierarchy

+
    +
  • + IProfileManagerFactory +
  • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

getManager

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilemanagerinit.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilemanagerinit.html new file mode 100644 index 0000000000..ff034632e8 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilemanagerinit.html @@ -0,0 +1,319 @@ + + + + + + IProfileManagerInit | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileManagerInit

+
+
+
+
+
+
+
+
+
+

Parameters passed on the "basic profile manager" "initialize()" API. The initialization API creates the entire + profile directory structure and persists the configuration documents for each type in their respective meta profile. + The configuration documents are persisted for two reasons:

+
+
    +
  1. To help "external" invocations of the profile manager avoid having to provide the configuration documents. + This makes constructing apps and editor extensions that depend on profiles much simpler and protects the + profiles.

    +
  2. +
  3. Ensures a consistency between versions and updates to the profile structure - we can compare the persisted + profiles against the configuration documents supplied when Imperative is initialized.

    +
  4. +
+
+
export
+
+
interface
+

IProfileManagerInit

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProfileManagerInit +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

configuration

+
configuration: IProfileTypeConfiguration[]
+ +
+
+

The full set of profile "type" configuration documents - Normally supplied by the CLI definition document. See + the interface for full details.

+
+
+
memberof
+

IProfileManagerInit

+
+
+
+
+
+ +

profileRootDirectory

+
profileRootDirectory: string
+ +
+
+

The root directory for the profile manager - this is where all type directories will be initialized. The root is + normally supplied on the configuration document for an Imperative CLI.

+
+
+
memberof
+

IProfileManagerInit

+
+
+
+
+
+ +

Optional reinitialize

+
reinitialize: boolean
+ +
+
+

If true, will re-initialize and profile type directories found. If false, any existing definitions/types/metas + are not touched - Can be called during Imperative init with false, to ensure that nothing is overwritten, but + additional types are added as supplied.

+
+
+
memberof
+

IProfileManagerInit

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileproperty.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileproperty.html new file mode 100644 index 0000000000..a5fb7d9850 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileproperty.html @@ -0,0 +1,326 @@ + + + + + + IProfileProperty | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileProperty

+
+
+
+
+
+
+
+
+
+

A single field in a profile schema which can be serialized to a profile file

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional includeInTemplate

+
includeInTemplate: boolean
+ +
+
+

Should this property be defined in a new config JSON template?

+
+
+
memberof
+

IProfileProperty

+
+
+
+
+
+ +

Optional items

+
items: any
+ +
+
+ +

Optional properties

+
properties: any
+ +
+
+

Nested properties e.g. banana.origin.zipcode, banana.origin.country

+
+
+
+
+ +

Optional secure

+
secure: boolean
+ +
+
+

Indicates if the given property should be securely stored

+
+
+
+
+ +

type

+
type: string | string[]
+ +
+
+

See ICommandProfileProperty.ts for how to include option definitions + on your schema for auto-generated commands

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilesaved.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilesaved.html new file mode 100644 index 0000000000..11b5ca8a07 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilesaved.html @@ -0,0 +1,328 @@ + + + + + + IProfileSaved | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileSaved

+
+
+
+
+
+
+
+
+
+

The success response to the profile "save()" API.

+
+
+
export
+
+
interface
+

IProfileSaved

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProfileSaved +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

message

+
message: string
+ +
+
+

A message describing the result of the profile creation - for display purposes

+
+
+
memberof
+

IProfileSaved

+
+
+
+
+
+ +

overwritten

+
overwritten: boolean
+ +
+
+

True if the profile saved overwrote an existing profile of the same name/type.

+
+
+
memberof
+

IProfileSaved

+
+
+
+
+
+ +

path

+
path: string
+ +
+
+

The path that the new profile was written to

+
+
+
memberof
+

IProfileSaved

+
+
+
+
+
+ +

Optional profile

+
profile: IProfile
+ +
+
+

The contents of the profile saved.

+
+
+
memberof
+

IProfileSaved

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileschema.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileschema.html new file mode 100644 index 0000000000..1c1dae4b3b --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileschema.html @@ -0,0 +1,371 @@ + + + + + + IProfileSchema | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileSchema

+
+
+
+
+
+
+
+
+
+

The JSON Validation schema for your profile type. + Use this to describe the expected structure and contents of your profile, + as well as provide option definitions for create & update profile commands

+
+
+
+
+

Hierarchy

+ +
+
+

Indexable

+
[key: string]: any
+
+
+

Any other advanced options available from the JSON schema specification + http://json-schema.org/latest/json-schema-validation.html

+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+

A description of your type of profile

+
+
+
+
+ +

properties

+
properties: {}
+ +
+
+

These are the properties of your profile object. If your profile deals with + information about bananas, some properties might be "color", "sweetness", + and "origin" of type "string". For each one, you can provide an Imperative + option definition (The same format as your normal command option definitions) + which will be used for auto-generating profile commands.

+
+
+
+

Type declaration

+
    +
  • +
    [key: string]: IProfileProperty
    +
    +
    +

    General mapping of property name to an IProfileProperty object.

    +
    +
    +
  • +
+
+
+
+ +

Optional required

+
required: string[]
+ +
+
+

An array of properties that must be present in the finished profile. + If any of these fields are missing, profile validation will fail.

+
+
+
+
+ +

title

+
title: string
+ +
+
+

A short, descriptive title of your profile type

+
+
+
+
+ +

type

+
type: string
+ +
+
+

Specify "object". This is not the type name + of the profile, but rather a description of the type of data structure (e.g. string, + array). Your profile will be an object with one or more properties.

+
+
+
+
+ +

Optional version

+
version: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofiletypeconfiguration.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofiletypeconfiguration.html new file mode 100644 index 0000000000..609f4739c1 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofiletypeconfiguration.html @@ -0,0 +1,344 @@ + + + + + + IProfileTypeConfiguration | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileTypeConfiguration

+
+
+
+
+
+
+
+
+
+

The profile "type" configuration document. Provides all configuration information for the "type". A profile + "type" is an arbirarty (implementation defined) category used to isolate configuration documents, provide + ease of configuration for complex CLIs (user only configures what they'll use), and allows the CLI to be + extendable in an isolated fashion. See the "IProfile" and "BasicProfileManager" for more detailed profile info.

+
+
+
export
+
+
interface
+

IProfileTypeConfiguration

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional dependencies

+
dependencies: IProfileDependency[]
+ +
+
+

The profile dependency specification. Indicates the required or optional profiles that a profile is depedent + on. Dependencies are written as part of the profile, but you do NOT need to specify dependencies in your + schema document - this is automatically generated based on your specifications.

+
+
+
memberof
+

IProfileTypeConfiguration

+
+
+
+
+
+ +

schema

+ + +
+
+

The JSON schema document. The schema document provides a way to enforce the contents of a profile. The schema + conforms exactly to the JSON schema specification. You must supply all properties you would like validated + for correctness on the schema, except for "dependencies". Dependency schema checking is generated automatically + if you populate the dependencies property of this document.

+
+
+
memberof
+

IProfileTypeConfiguration

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

The name of the profile "type" (e.g. "banana"). The type should be indicative of the profile contents (defined + by the profile schema on this document). A "type" is analogous to a category.

+
+
+
memberof
+

IProfileTypeConfiguration

+
+
+
+
+
+ +

Optional validationPlanModule

+
validationPlanModule: string
+ +
+
+

Path to a module that contains an object that matches the interface IProfileValidationPlan. This is optional, + but if provided a "validate profile" command will be generated to give the user a report on the validity of + their profile.

+
+
+
memberof
+

IProfileTypeConfiguration

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileupdated.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileupdated.html new file mode 100644 index 0000000000..25c7743532 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofileupdated.html @@ -0,0 +1,289 @@ + + + + + + IProfileUpdated | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileUpdated

+
+
+
+
+
+
+
+
+
+

The success response to the profile "update()" API.

+
+
+
export
+
+
interface
+

IProfileUpdated

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProfileUpdated +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

message

+
message: string
+ +
+
+

A message for display purposes

+
+
+
+
+ +

path

+
path: string
+ +
+
+

The path to the profile that was updated

+
+
+
+
+ +

Optional profile

+
profile: IProfile
+ +
+
+

The contents of the profile

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidated.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidated.html new file mode 100644 index 0000000000..3868e48139 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidated.html @@ -0,0 +1,256 @@ + + + + + + IProfileValidated | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileValidated

+
+
+
+
+
+
+
+
+
+

The success response to the profile "validate()" APi.

+
+
+
export
+
+
interface
+

IProfileValidated

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProfileValidated +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

message

+
message: string
+ +
+
+

Message - for display purposes - e.g. The profile was updated.

+
+
+
memberof
+

IProfileValidated

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidationplan.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidationplan.html new file mode 100644 index 0000000000..55138fe9db --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidationplan.html @@ -0,0 +1,265 @@ + + + + + + IProfileValidationPlan | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileValidationPlan

+
+
+
+
+
+
+
+
+
+

An overall plan for validating a profile, composed of multiple tasks

+
+
+
+
+

Hierarchy

+
    +
  • + IProfileValidationPlan +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional failureSuggestions

+
failureSuggestions: string
+ +
+
+

Suggestions to the user that will be displayed in the validation + report in the event profile validation is not successful.

+
+
+
+
+ +

tasks

+ + +
+
+

The tasks to run to validate the profile. + They will be run sequentially in the order specified.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidationreport.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidationreport.html new file mode 100644 index 0000000000..de0da61497 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidationreport.html @@ -0,0 +1,301 @@ + + + + + + IProfileValidationReport | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileValidationReport

+
+
+
+
+
+
+
+
+
+

Complete report of the results of profile validation

+
+
+
+
+

Hierarchy

+
    +
  • + IProfileValidationReport +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

overallMessage

+
overallMessage: string
+ +
+
+

A final message explaining the general result of the report

+
+
+
+
+ +

overallResult

+
overallResult: VALIDATION_OUTCOME
+ +
+
+

Is the profile valid overall?

+
+
+
+
+ +

profile

+
profile: IProfile
+ +
+
+

The profile that was validated

+
+
+
+
+ +

taskResults

+ + +
+
+

List of detailed task results from running the profile validation

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidationtask.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidationtask.html new file mode 100644 index 0000000000..2c893f708a --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidationtask.html @@ -0,0 +1,327 @@ + + + + + + IProfileValidationTask | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileValidationTask

+
+
+
+
+
+
+
+
+
+

Criterion/task used for testing the validity of a profile + You can use any number of these criteria to test different + aspects of the profile

+
+
+
+
+

Hierarchy

+
    +
  • + IProfileValidationTask +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional associatedEndpoints

+
associatedEndpoints: string[]
+ +
+
+

The REST endpoints associated with this task if any, + e.g. ["PUT /zosmf/restjobs/jobs", "GET /zosmf/restjobs/jobs"]

+
+
+
+
+ +

Optional dependentTasks

+
dependentTasks: IProfileValidationTask[]
+ +
+
+

Any tasks you would like to only run if the current task succeeds + (skipped on warning or failure of this, the parent task)

+
+
+
+
+ +

description

+
description: string
+ +
+
+

Long form description of the task you'll take using the + specified profile to test its validity

+
+
+
+
+ +

name

+
name: string
+ +
+
+

The short name of a task e.g. "Submitting a job"

+
+
+
+
+ +

taskFunction

+ + +
+
+

A function which tests the profile with your tasks + Ultimately the result of this function is what determines whether + the profile is valid or not for this task

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidationtaskresult.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidationtaskresult.html new file mode 100644 index 0000000000..95571799f7 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofilevalidationtaskresult.html @@ -0,0 +1,308 @@ + + + + + + IProfileValidationTaskResult | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfileValidationTaskResult

+
+
+
+
+
+
+
+
+
+

Profile validation results for one particular task

+
+
+
+
+

Hierarchy

+
    +
  • + IProfileValidationTaskResult +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional associatedEndpoints

+
associatedEndpoints: string[]
+ +
+
+

Same as the endpoints in the profile validation task. + (will be automatically populated by the validation API)

+
+
+
+
+ +

outcome

+ + +
+
+

Outcome of this task, whether it succeeded, failed, or somewhere in between

+
+
+
+
+ +

resultDescription

+
resultDescription: string
+ +
+
+

A description of the result of the validation test, whether + it succeeded or failed. Example: + Successfully submitted job USER(JOB00001) + or + Failed to submit job due to the following error: + Input was not recognized by the system as a job RC 4 RSN ...

+
+
+
+
+ +

Optional taskName

+
taskName: string
+ +
+
+

Name of the task + (will be automatically populated by the validation API)

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinfoerrparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinfoerrparms.html new file mode 100644 index 0000000000..d23838baa3 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinfoerrparms.html @@ -0,0 +1,305 @@ + + + + + + IProfInfoErrParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfInfoErrParms

+
+
+
+
+
+
+
+
+
+

Options that will affect the behavior of the ProfileInfo class. + They are supplied on the ProfileInfo constructor.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional itemsInError

+
itemsInError: string[]
+ +
+
+

This property is used when an error is returned that is related + to a number of configuration items. For example, if a problem is + identified that affects a subset of profiles, those affected + profiles can be identified in the itemsInError array. An app can + easily identify each affected profile by traversing itemsInError.

+
+
+
+
+ +

Optional logger

+
logger: Logger
+ +
+
+

Logger for the Imperative Error (logs messages and the node report that is generated upon request)

+
+
+
memberof
+

IImperativeErrorParms

+
+
+
+
+
+ +

Optional tag

+
tag: string
+ +
+
+

Message tag - prepended to the error message specified. Useful for categorizing error messages + (e.g. "Profile IO Error"). A ": " is appended automatically (e.g. "Profile IO Error: ")

+
+
+
memberof
+

IImperativeErrorParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinforemoveknownpropcommonopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinforemoveknownpropcommonopts.html new file mode 100644 index 0000000000..d9521fbe5c --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinforemoveknownpropcommonopts.html @@ -0,0 +1,242 @@ + + + + + + IProfInfoRemoveKnownPropCommonOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfInfoRemoveKnownPropCommonOpts

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinforemoveknownpropopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinforemoveknownpropopts.html new file mode 100644 index 0000000000..3f85a9b886 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinforemoveknownpropopts.html @@ -0,0 +1,282 @@ + + + + + + IProfInfoRemoveKnownPropOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfInfoRemoveKnownPropOpts

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

mergedArgs

+
mergedArgs: IProfMergedArg
+ +
+
+

Merged arguments object describing the location of the property to update

+
+
+
+
+ +

Optional osLocInfo

+
osLocInfo: IProfLocOsLoc
+ +
+
+

Optional osLoc information. + This will allow the updateKnownProperty function to switch active layer if needed

+
+
+
+
+ +

property

+
property: string
+ +
+
+

Property to remove

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinfoupdateknownpropopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinfoupdateknownpropopts.html new file mode 100644 index 0000000000..c2d745c686 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinfoupdateknownpropopts.html @@ -0,0 +1,329 @@ + + + + + + IProfInfoUpdateKnownPropOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfInfoUpdateKnownPropOpts

+
+
+
+
+
+
+
+
+
+

Required options to update known properties from the ProfileInfo class.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

mergedArgs

+
mergedArgs: IProfMergedArg
+ +
+
+

Merged arguments object describing the location of the property to update

+
+
+
+
+ +

Optional osLocInfo

+
osLocInfo: IProfLocOsLoc
+ +
+
+

Optional osLoc information. + This will allow the updateKnownProperty function to switch active layer if needed

+
+
+
+
+ +

property

+
property: string
+ +
+
+

Property to update

+
+
+
+
+ +

Optional setSecure

+
setSecure: boolean
+ +
+
+

Specifies if the property should be stored securely or not

+
+
+
+
+ +

value

+
value: IProfArgValue | undefined
+ +
+
+

Value to use when updating the given property

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinfoupdatepropcommonopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinfoupdatepropcommonopts.html new file mode 100644 index 0000000000..8244d6884f --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinfoupdatepropcommonopts.html @@ -0,0 +1,283 @@ + + + + + + IProfInfoUpdatePropCommonOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfInfoUpdatePropCommonOpts

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

property

+
property: string
+ +
+
+

Property to update

+
+
+
+
+ +

Optional setSecure

+
setSecure: boolean
+ +
+
+

Specifies if the property should be stored securely or not

+
+
+
+
+ +

value

+
value: IProfArgValue | undefined
+ +
+
+

Value to use when updating the given property

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinfoupdatepropopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinfoupdatepropopts.html new file mode 100644 index 0000000000..1a4878e516 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofinfoupdatepropopts.html @@ -0,0 +1,358 @@ + + + + + + IProfInfoUpdatePropOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfInfoUpdatePropOpts

+
+
+
+
+
+
+
+
+
+

Required options to update any property from the ProfileInfo class.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional forceUpdate

+
forceUpdate: boolean
+ +
+
+

Force the update to the profile specified even if the property comes from somehwere else

+
+
+
example
+

Token Value could be in the base profile (not in the service profile specified) + and the programmer has the intention of storing the token in the service profile

+
+
default
+

false When the property is not specified, the updateProperty method follows current + procedure of updating the property in the known jsonLoc (e.g. base profile). Otherwise, + the updateProperty method updates the specified profile name-type combination.

+
+
+
+
+
+ +

profileName

+
profileName: string
+ +
+
+

Name of the active profile

+
+
+
+
+ +

profileType

+
profileType: string
+ +
+
+

Type of the active profile

+
+
+
+
+ +

property

+
property: string
+ +
+
+

Property to update

+
+
+
+
+ +

Optional setSecure

+
setSecure: boolean
+ +
+
+

Specifies if the property should be stored securely or not

+
+
+
+
+ +

value

+
value: IProfArgValue | undefined
+ +
+
+

Value to use when updating the given property

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofloc.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofloc.html new file mode 100644 index 0000000000..cd91dd2e52 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofloc.html @@ -0,0 +1,290 @@ + + + + + + IProfLoc | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfLoc

+
+
+
+
+
+
+
+
+
+

The attributes used to identify the location of a given property

+
+
+
+
+

Hierarchy

+
    +
  • + IProfLoc +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional jsonLoc

+
jsonLoc: string
+ +
+
+

For SOURCE_TEAM_CONFIG, this is the dotted path into + the JSON configuration object for the profile. + This property is not used (undefined) for SOURCE_OLD_PROFILE, + because the old-school profiles use a simple name/value pair like: + ArgumentName: value + This property is also not used for ENV or DEFAULT.

+
+
+
+
+ +

locType

+
locType: ProfLocType
+ +
+
+

The type of location for this property

+
+
+
+
+ +

Optional osLoc

+
osLoc: string[]
+ +
+
+

For OLD_PROFILE and TEAM_CONFIG, this is the path to + the file on disk which contains the argument. + For ENV, this is the name of the environment variable. + This is not used for DEFAULT.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iproflocosloc.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iproflocosloc.html new file mode 100644 index 0000000000..13601108d6 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iproflocosloc.html @@ -0,0 +1,308 @@ + + + + + + IProfLocOsLoc | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfLocOsLoc

+
+
+
+
+
+
+
+
+
+

The extended osLoc information

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

global

+
global: boolean
+ +
+
+

Determines if the osLoc is coming form a global layer

+
+
+
+
+ +

name

+
name: string
+ +
+
+

The name of the profile

+
+
+
+
+ +

path

+
path: string
+ +
+
+

Contains the osLoc path information

+
+
+
+
+ +

user

+
user: boolean
+ +
+
+

Determines if the osLoc is coming from a user layer

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iproflocosloclayer.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iproflocosloclayer.html new file mode 100644 index 0000000000..de715cb8d3 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iproflocosloclayer.html @@ -0,0 +1,268 @@ + + + + + + IProfLocOsLocLayer | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfLocOsLocLayer

+
+
+
+
+
+
+
+
+
+

Layer information for IProfLocOsLoc

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

global

+
global: boolean
+ +
+
+

Determines if the osLoc is coming form a global layer

+
+
+
+
+ +

user

+
user: boolean
+ +
+
+

Determines if the osLoc is coming from a user layer

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofmergeargopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofmergeargopts.html new file mode 100644 index 0000000000..680ad371e4 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofmergeargopts.html @@ -0,0 +1,253 @@ + + + + + + IProfMergeArgOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfMergeArgOpts

+
+
+
+
+
+
+
+
+
+

Options that will affect the behavior of the ProfileInfo class. + They are supplied on the ProfileInfo constructor.

+
+
+
+
+

Hierarchy

+
    +
  • + IProfMergeArgOpts +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional getSecureVals

+
getSecureVals: boolean
+ +
+
+

Indicates whether secure values should be loaded when + ProfileInfo.mergeArgsForXXX functions are called. + When true, the secure values are contained in the result of + the function. When false, placeholders are returned in the result + and the calling function must call loadSecureArg() for each such + placeholder to get the actual value. The false option is considered + more secure because actual secure values will not reside in memory + until the calling app explicitly asks for an actual value. + The default is false.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofmergedarg.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofmergedarg.html new file mode 100644 index 0000000000..266da899cc --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofmergedarg.html @@ -0,0 +1,275 @@ + + + + + + IProfMergedArg | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfMergedArg

+
+
+
+
+
+
+
+
+
+

The result object from mergeProfileArgs().

+
+
+
+
+

Hierarchy

+
    +
  • + IProfMergedArg +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

knownArgs

+
knownArgs: IProfArgAttrs[]
+ +
+
+

The list of arguments with known values. + All of the attributes in IProfArgAttrs will be filled in except + when knownArgs[i].argLoc.osLoc (and/or jsonLoc) are not + relevant for the type of location (locType). + Additionally, the missingArgs[i].argValue attribute will be undefined + for arguments with secure = true since their values are sensitive data. + Use ProfileInfo.loadSecureArg to load a secure argument's value.

+
+
+
+
+ +

missingArgs

+
missingArgs: IProfArgAttrs[]
+ +
+
+

The list of required arguments for which no value has been specified. + Obviously, the missingArgs[i].argValue attribute will not exist. + Note that a generated team configuration template can contain some + arguments with an empty string as a value. Such arguments will be + contained in this missing list. The other missing arguments will + have a missingArgs[i].argLoc, derived from the location of the + profile specified to the function mergeProfileArgs().

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofopts.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofopts.html new file mode 100644 index 0000000000..67cd749f71 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprofopts.html @@ -0,0 +1,309 @@ + + + + + + IProfOpts | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProfOpts

+
+
+
+
+
+
+
+
+
+

Options that will affect the behavior of the ProfileInfo class. + They are supplied on the ProfileInfo constructor.

+
+
+
+
+

Hierarchy

+
    +
  • + IProfOpts +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional credMgrOverride

+
credMgrOverride: ICredentialManagerInit
+ +
+
+

Overrides the credential manager class used to load and store secure + properties. If undefined, the default implementation is to use the + Imperative {@link KeytarCredentialManager} which will require("keytar") + from the caller app's node_modules folder.

+
+
+
+
+ +

Optional overrideWithEnv

+
overrideWithEnv: boolean
+ +
+
+

Indicates if environment variables should override values + stored in Zowe configuration profiles on disk. + The default is false.

+
+
+
+
+ +

Optional requireKeytar

+
requireKeytar: () => NodeModule
+ +
+
+

Implements a custom method to require Keytar module which manages + secure credentials. If undefined, the default implementation is to + require("keytar") from the caller app's node_modules folder.

+
+
+
deprecated
+
+
+
+
+

Type declaration

+
    +
  • +
      +
    • (): NodeModule
    • +
    +
      +
    • +

      Returns NodeModule

      +
    • +
    +
  • +
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprogressbarparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprogressbarparms.html new file mode 100644 index 0000000000..b25d264f72 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iprogressbarparms.html @@ -0,0 +1,260 @@ + + + + + + IProgressBarParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProgressBarParms

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipromisewithprogress.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipromisewithprogress.html new file mode 100644 index 0000000000..7a66d505a8 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipromisewithprogress.html @@ -0,0 +1,422 @@ + + + + + + IPromiseWithProgress | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPromiseWithProgress<T>

+
+
+
+
+
+
+
+
+
+

A promise object that also can be tracked for progress bars/ GUIS

+
+
+
+
+

Type parameters

+
    +
  • +

    T

    +
  • +
+
+
+

Hierarchy

+
    +
  • + Promise<T> +
      +
    • + IPromiseWithProgress +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Promise

+
Promise: PromiseConstructor
+ +
+
+ +

Readonly [Symbol.toStringTag]

+
[Symbol.toStringTag]: string
+ +
+
+ +

progress

+
progress: ITaskWithStatus
+ +
+
+
+

Methods

+
+ +

catch

+
    +
  • catch<TResult>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>
  • +
+
    +
  • + +
    +
    +

    Attaches a callback for only the rejection of the Promise.

    +
    +
    +

    Type parameters

    +
      +
    • +

      TResult = never

      +
    • +
    +

    Parameters

    +
      +
    • +
      Optional onrejected: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null
      +
      +

      The callback to execute when the Promise is rejected.

      +
      +
    • +
    +

    Returns Promise<T | TResult>

    +

    A Promise for the completion of the callback.

    +
  • +
+
+
+ +

finally

+
    +
  • finally(onfinally?: (() => void) | undefined | null): Promise<T>
  • +
+
    +
  • + +
    +
    +

    Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The + resolved value cannot be modified from the callback.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional onfinally: (() => void) | undefined | null
      +
      +

      The callback to execute when the Promise is settled (fulfilled or rejected).

      +
      +
    • +
    +

    Returns Promise<T>

    +

    A Promise for the completion of the callback.

    +
  • +
+
+
+ +

then

+
    +
  • then<TResult1, TResult2>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>
  • +
+
    +
  • + +
    +
    +

    Attaches callbacks for the resolution and/or rejection of the Promise.

    +
    +
    +

    Type parameters

    +
      +
    • +

      TResult1 = T

      +
    • +
    • +

      TResult2 = never

      +
    • +
    +

    Parameters

    +
      +
    • +
      Optional onfulfilled: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null
      +
      +

      The callback to execute when the Promise is resolved.

      +
      +
    • +
    • +
      Optional onrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null
      +
      +

      The callback to execute when the Promise is rejected.

      +
      +
    • +
    +

    Returns Promise<TResult1 | TResult2>

    +

    A Promise for the completion of which ever callback is executed.

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipromptoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipromptoptions.html new file mode 100644 index 0000000000..4bc1e7a9f4 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ipromptoptions.html @@ -0,0 +1,304 @@ + + + + + + IPromptOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPromptOptions

+
+
+
+
+
+
+
+
+
+

Interface for prompt options

+
+
+
export
+
+
interface
+

IPromptOptions

+
+
+
+
+
+

Hierarchy

+
    +
  • + IPromptOptions +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional hideText

+
hideText: boolean
+ +
+
+

Whether or not to obscure answered prompt (e.g. for passwords)

+
+
+
memberof
+

IPromptOptions

+
+
+
+
+
+ +

Optional maskChar

+
maskChar: string | null
+ +
+
+

Character to use for masking hidden text

+
+
+
memberof
+

IPromptOptions

+
+
+
+
+
+ +

Optional secToWait

+
secToWait: number
+ +
+
+

How long to wait in seconds for prompting

+
+
+
memberof
+

IPromptOptions

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iqueuedmessage.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iqueuedmessage.html new file mode 100644 index 0000000000..069c97cbdf --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iqueuedmessage.html @@ -0,0 +1,260 @@ + + + + + + IQueuedMessage | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IQueuedMessage

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.irestclienterror.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.irestclienterror.html new file mode 100644 index 0000000000..8bcceac3b5 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.irestclienterror.html @@ -0,0 +1,620 @@ + + + + + + IRestClientError | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IRestClientError

+
+
+
+
+
+
+
+
+
+

REST client error interface. Extends IImperativeError to provide additional + details specified to REST/HTTP errors.

+
+
+
interface
+

IRestClientError

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional additionalDetails

+
additionalDetails: string
+ +
+
+

any other extra contextual information (e.g. details pulled out of the cause errors)

+
+
+
memberof
+

IImperativeError

+
+
+
+
+
+ +

Optional basePath

+
basePath: string
+ +
+
+

The "base path" for the URI. Specified on the session object.

+
+
+
+
+ +

Optional causeErrors

+
causeErrors: any
+ +
+
+

Original errors that caused/influenced this one

+
+
+
memberof
+

IImperativeError

+
+
+
+
+
+ +

Optional errno

+
errno: string
+ +
+
+

The "errno" provided from the Node.js http interface. when client.on("error") + is invoked.

+
+
+
+
+ +

Optional errorCode

+
errorCode: string
+ +
+
+

If applicable, an error code, for example, HTTP status code surrounding the error

+
+
+
memberof
+

IImperativeError

+
+
+
+
+
+ +

Optional headers

+
headers: any[]
+ +
+
+

Any HTTP headers added to the request.

+
+
+
+
+ +

Optional host

+
host: string
+ +
+
+

The hostname supplied on the session object.

+
+
+
+
+ +

Optional httpStatus

+
httpStatus: number
+ +
+
+

The HTTP status code from the request. Might not be populated if a "client" + error occurred (e.g. ECONNREFUSED).

+
+
+
+
+ +

msg

+
msg: string
+ +
+
+

Message text of the error

+
+
+
memberof
+

IImperativeError

+
+
+
+
+
+ +

Optional payload

+
payload: any
+ +
+
+

The request payload.

+
+
+
+
+ +

Optional port

+
port: number
+ +
+
+

The port number of the remote host. Specified on the session object.

+
+
+
+
+ +

Optional protocol

+
protocol: string
+ +
+
+

The protocol used to connect to the remote host. Specified on the session object.

+
+
+
+
+ +

Optional request

+
request: string
+ +
+
+

The HTTP method/verb (e.g. PUT)

+
+
+
+
+ +

Optional resource

+
resource: string
+ +
+
+

The URI or resource of the request being made.

+
+
+
+
+ +

source

+ + +
+
+

The error "source". Indicates where the error occurred in the REST client. + "client" indicates that the error occurred before the request to the remote + system could be fulfilled (normally due to network, bad host/port, etc.). + "http" indicates that a non-OK HTTP status code was presented.

+
+
+
+
+ +

Optional stack

+
stack: string
+ +
+
+

Error status

+
+
+
memberof
+

IImperativeError

+
+
+
+
+
+ +

Optional suppressDump

+
suppressDump: boolean
+ +
+
+

Whether or not the error should suppress a full error dump, like in Imperative init

+
+
+
memberof
+

IImperativeError

+
+
+
+
+
+ +

Optional syscall

+
syscall: string
+ +
+
+

The syscall provided from the Node.js http interface when client.on("error") + is invoked. Usually accompanied by an "errno".

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.irestclientresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.irestclientresponse.html new file mode 100644 index 0000000000..0ebf2db052 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.irestclientresponse.html @@ -0,0 +1,401 @@ + + + + + + IRestClientResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IRestClientResponse

+
+
+
+
+
+
+
+
+
+

Interface to map client's REST call response

+
+
+
export
+
+
interface
+

IRestClientResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IRestClientResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional data

+
data: Buffer
+ +
+
+

Http(s) response body as a buffer

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+ +

Optional dataString

+
dataString: string
+ +
+
+

Http(s) response body as a string

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+ +

Optional log

+
log: Logger
+ +
+
+

Logger object

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+ +

Optional requestFailure

+
requestFailure: boolean
+ +
+
+

Status whether or not a REST request was successful by HTTP status code + Reverse of requestSuccess

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+ +

Optional requestSuccess

+
requestSuccess: boolean
+ +
+
+

Status whether or not a REST request was successful by HTTP status code

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+ +

Optional response

+
response: any
+ +
+
+

Http(s) response object

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+ +

Optional session

+
session: Session
+ +
+
+

Session object

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.irestoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.irestoptions.html new file mode 100644 index 0000000000..759adff768 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.irestoptions.html @@ -0,0 +1,450 @@ + + + + + + IRestOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IRestOptions

+
+
+
+
+
+
+
+
+
+

Interface to define input for AbstractRestClient.request method

+
+
+
export
+
+
interface
+

IRestOptions

+
+
+
+
+
+

Hierarchy

+
    +
  • + IRestOptions +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional normalizeRequestNewLines

+
normalizeRequestNewLines: boolean
+ +
+
+

true if you want \r\n to be replaced with \n when sending + data to the server from requestStream. Don't set this for binary requests

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

Optional normalizeResponseNewLines

+
normalizeResponseNewLines: boolean
+ +
+
+

true if you want newlines to be \r\n on windows + when receiving data from the server to responseStream. Don't set this for binary responses

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

Optional reqHeaders

+
reqHeaders: any[]
+ +
+
+

Headers to include with request

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

request

+
request: HTTP_VERB
+ +
+
+

REST request type GET|PUT|POST|DELETE

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

Optional requestStream

+
requestStream: Readable
+ +
+
+

Stream for outgoing request data to the server

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

resource

+
resource: string
+ +
+
+

URI for this request

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

Optional responseStream

+
responseStream: Writable
+ +
+
+

Stream for incoming response data from the server. If specified, response data will not be buffered

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

Optional task

+ + +
+
+

Task that will automatically be updated to report progress of upload or download to user

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+ +

Optional writeData

+
writeData: any
+ +
+
+

Data to write on this REST request

+
+
+
memberof
+

IRestOptions

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isaveprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isaveprofile.html new file mode 100644 index 0000000000..e2413246f4 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isaveprofile.html @@ -0,0 +1,385 @@ + + + + + + ISaveProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISaveProfile

+
+
+
+
+
+
+
+
+
+

Parameters to the "save()" profile API.

+
+

Note: This profile could contain the following additional arguments, + which will only be kept in memory (for a short period of time) and NOT saved to a file.

+
+
export
+
+
interface
+

ISaveProfile

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional disableDefaults

+
disableDefaults: boolean
+ +
+
+

The argument to disable populating defaults

+
+
+
memberof
+

ISaveProfileFromCliArgs

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

The name of the profile to save

+
+
+
memberof
+

ISaveProfile

+
+
+
+
+
+ +

Optional overwrite

+
overwrite: boolean
+ +
+
+

Set to true to overwrite an existing profile of the same name. If false, an error is thrown if the profile + already exists.

+
+
+
memberof
+

ISaveProfile

+
+
+
+
+
+ +

profile

+
profile: IProfile
+ +
+
+

The profile contents - must extend the IProfile interface to function properly with Imperative. The contents + are always validated against the schema documents (and basic validation occurs)

+
+
+
memberof
+

ISaveProfile

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

The type of profile to save

+
+
+
memberof
+

ISaveProfile

+
+
+
+
+
+ +

Optional updateDefault

+
updateDefault: boolean
+ +
+
+

Set to true to update the default profile for the profile type.

+
+
+
memberof
+

ISaveProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isaveprofilefromcliargs.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isaveprofilefromcliargs.html new file mode 100644 index 0000000000..5e1d640edc --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isaveprofilefromcliargs.html @@ -0,0 +1,414 @@ + + + + + + ISaveProfileFromCliArgs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISaveProfileFromCliArgs

+
+
+
+
+
+
+
+
+
+

Parameters for creating a profile from command line arguments - normally invoked from a command handler that + is pre-built by imperative.

+
+
+
export
+
+
interface
+

ICreateProfileFromArgs

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional args

+
args: Arguments
+ +
+
+

The Yargs style arguments - supplied from the command invocation.

+
+
+
memberof
+

ISaveProfileFromCliArgs

+
+
+
+
+
+ +

Optional disableDefaults

+
disableDefaults: boolean
+ +
+
+

The argument to disable populating defaults

+
+
+
memberof
+

ISaveProfileFromCliArgs

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

The name of the profile to save

+
+
+
memberof
+

ISaveProfile

+
+
+
+
+
+ +

Optional overwrite

+
overwrite: boolean
+ +
+
+

Set to true to overwrite an existing profile of the same name. If false, an error is thrown if the profile + already exists.

+
+
+
memberof
+

ISaveProfile

+
+
+
+
+
+ +

profile

+
profile: IProfile
+ +
+
+

The profile contents - must extend the IProfile interface to function properly with Imperative. The contents + are always validated against the schema documents (and basic validation occurs)

+
+
+
memberof
+

ISaveProfile

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

The type of profile to save

+
+
+
memberof
+

ISaveProfile

+
+
+
+
+
+ +

Optional updateDefault

+
updateDefault: boolean
+ +
+
+

Set to true to update the default profile for the profile type.

+
+
+
memberof
+

ISaveProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isession.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isession.html new file mode 100644 index 0000000000..05a0ea6e8b --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isession.html @@ -0,0 +1,732 @@ + + + + + + ISession | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISession

+
+
+
+
+
+
+
+
+
+

Session interface for maintaining cookie and protocol information

+
+
+
export
+
+
interface
+

ISession

+
+
+
+
+
+

Hierarchy

+
    +
  • + ISession +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional base64EncodedAuth

+
base64EncodedAuth: string
+ +
+
+

Base 64 encoded authentication materials created by base 64 encoding: + Basic :

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional basePath

+
basePath: string
+ +
+
+

The base path (or first part) of the resources that we will access. + It is used to specify the first part of the resource in a URL that + points to any API mediation layer, gateway, or router used at a site + to dispatch web requests to services that are managed by that gateway. + It is pre-pended to the resource path of the underlying service. + When not supplied, or is an empty string we use the the resource path of + the underlying service directly.

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional cert

+
cert: string
+ +
+
+

The file path to the client certificate to use for authentication

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional certKey

+
certKey: string
+ +
+
+

The file path to the client certificate's key to use for authentication

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional checkServerIdentity

+
checkServerIdentity: (host: string, cert: object) => Error | undefined
+ +
+
+

todo

+
+
+
memberof
+

ISession

+
+
+
+
+

Type declaration

+
    +
  • +
      +
    • (host: string, cert: object): Error | undefined
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        host: string
        +
      • +
      • +
        cert: object
        +
      • +
      +

      Returns Error | undefined

      +
    • +
    +
  • +
+
+
+
+ +

Optional hostname

+
hostname: string
+ +
+
+

Host to get data from, not including http(s) from a URL, e.g. jsonplaceholder.typicode.com

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional passphrase

+
passphrase: string
+ +
+
+

The passphrase used to access the client certificate, if in PFX format

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional password

+
password: string
+ +
+
+

Password

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional port

+
port: number
+ +
+
+

Port to obtain data from + 80 is the default for http + 443 is the default 443 for https

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional protocol

+
protocol: SessConstants.HTTP_PROTOCOL_CHOICES
+ +
+
+

Currently only HTTPS is supported

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional rejectUnauthorized

+
rejectUnauthorized: boolean
+ +
+
+

The following options map to TLS options available within the node.js TLS APIs, please + see the official Node.js documentation for these fields

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional secureProtocol

+
secureProtocol: string
+ +
+
+

Default is SSLv23_method

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional serverCertificate

+
serverCertificate: string
+ +
+
+

todo

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional storeCookie

+
storeCookie: boolean
+ +
+
+

Decide whether or not to store a returned cookie. + Only applies to certificates for now.

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional strictSSL

+
strictSSL: boolean
+ +
+
+

see node.js api

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional tokenType

+
tokenType: string
+ +
+
+

Type of token in tokenValue, e.g. LTPA2

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional tokenValue

+
tokenValue: string
+ +
+
+

Token value of type tokenType

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional type

+
type: SessConstants.AUTH_TYPE_CHOICES
+ +
+
+

Type of authentication, none is default + "none" - no authorization header is used + "basic" - use basic auth for every request + "bearer" - use bearer auth for every request. + Indicates use token value provided. + "token" - use cookie auth for every request. + Indicates use token value provided and check for timeout / expiration + if not token is provided, basic auth is used and the tokenType is obtained + from the cookie header and stored as a token value to be used on subsequent + requests

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional user

+
user: string
+ +
+
+

User name for logging in

+
+
+
memberof
+

ISession

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isetdefaultprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isetdefaultprofile.html new file mode 100644 index 0000000000..5cb7e23463 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isetdefaultprofile.html @@ -0,0 +1,256 @@ + + + + + + ISetDefaultProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISetDefaultProfile

+
+
+
+
+
+
+
+
+
+

Parameters for the setDefault Profile Manager API.

+
+
+
export
+
+
interface
+

ISetDefaultProfile

+
+
+
+
+
+

Hierarchy

+
    +
  • + ISetDefaultProfile +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+

The name of the profile to set as the default (the type is indicated by the profile manager object).

+
+
+
memberof
+

ISetDefaultProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isettingsfile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isettingsfile.html new file mode 100644 index 0000000000..1e5a3c81f7 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isettingsfile.html @@ -0,0 +1,250 @@ + + + + + + ISettingsFile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISettingsFile

+
+
+
+
+
+
+
+
+
+

This interface defines the structure of the settings file.

+
+
+
+
+

Hierarchy

+
    +
  • + ISettingsFile +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

overrides

+
overrides: {}
+ +
+
+

The overrides object determines which items will be used for any overrides in + the overrides loader. Overrides can come from the base cli or plugins.

+
+
+
+

Type declaration

+
    +
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isettingsfilepersistence.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isettingsfilepersistence.html new file mode 100644 index 0000000000..2063ea24c1 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isettingsfilepersistence.html @@ -0,0 +1,272 @@ + + + + + + ISettingsFilePersistence | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISettingsFilePersistence

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isysteminfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isysteminfo.html new file mode 100644 index 0000000000..8edab2eef9 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.isysteminfo.html @@ -0,0 +1,280 @@ + + + + + + ISystemInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISystemInfo

+
+
+
+
+
+
+
+
+
+

Information interface for basic system information

+
+
+
export
+
+
interface
+

ISystemInfo

+
+
+
+
+
+

Hierarchy

+
    +
  • + ISystemInfo +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

arch

+
arch: string
+ +
+
+

The system's CPU architecture

+
+
+
memberof
+

ISystemInfo

+
+
+
+
+
+ +

platform

+
platform: string
+ +
+
+

The OS platform in use

+
+
+
memberof
+

ISystemInfo

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.itaskwithstatus.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.itaskwithstatus.html new file mode 100644 index 0000000000..49ac263234 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.itaskwithstatus.html @@ -0,0 +1,291 @@ + + + + + + ITaskWithStatus | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ITaskWithStatus

+
+
+
+
+
+
+
+
+
+

Implement this interface to be able to be tracked by the CLI progress bar or + GUIs

+
+
+
+
+

Hierarchy

+
    +
  • + ITaskWithStatus +
  • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

percentComplete

+
percentComplete: number
+ +
+
+

What percentage complete is your task right now?

+
+
+
+
+ +

stageName

+
stageName: TaskStage
+ +
+
+

Describe the overall status of the task. If the task fails while + in progress, you can set this to TaskStage.FAILED

+
+
+
+
+ +

statusMessage

+
statusMessage: string
+ +
+
+

A very short message describing what is being worked on

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.itreenode.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.itreenode.html new file mode 100644 index 0000000000..2b6ac1d6ab --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.itreenode.html @@ -0,0 +1,260 @@ + + + + + + ITreeNode | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ITreeNode

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ITreeNode +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional children

+
children: ITreeNode[]
+ +
+
+ +

id

+
id: string
+ +
+
+ +

text

+
text: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iupdateprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iupdateprofile.html new file mode 100644 index 0000000000..a018c8a966 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iupdateprofile.html @@ -0,0 +1,309 @@ + + + + + + IUpdateProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IUpdateProfile

+
+
+
+
+
+
+
+
+
+

Parameters to update a profile - The basic implementation simply overwrites the existing profile with the new + contents specified, unless merge is true, and the contents of the old profile are merged with the contents from + the update profile.

+
+

Note: This profile could contains the following additional arguments, + which will only be kept in memory (for a short period of time) and NOT saved to a file.

+
+
export
+
+
interface
+

IUpdateProfile

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional merge

+
merge: boolean
+ +
+
+

Should the contents of the new profile be merged with the contents of the old one?

+
+
+
+
+ +

Optional name

+
name: string
+ +
+
+

The name of the profile to update.

+
+
+
memberof
+

IUpdateProfile

+
+
+
+
+
+ +

Optional profile

+
profile: IProfile
+ +
+
+

The contents of the profile for the update - if merge is NOT specified, simply overwrites the existing + profile with the contents specified here.

+
+
+
memberof
+

IUpdateProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iupdateprofilefromcliargs.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iupdateprofilefromcliargs.html new file mode 100644 index 0000000000..704d693504 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iupdateprofilefromcliargs.html @@ -0,0 +1,322 @@ + + + + + + IUpdateProfileFromCliArgs | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IUpdateProfileFromCliArgs

+
+
+
+
+
+
+
+
+
+

TODO - wasn't this moved???

+
+
+
export
+
+
interface
+

IUpdateProfileFromCliArgs

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

args

+
args: Arguments
+ +
+
+ +

Optional merge

+
merge: boolean
+ +
+
+

Should the contents of the new profile be merged with the contents of the old one?

+
+
+
+
+ +

Optional name

+
name: string
+ +
+
+

The name of the profile to update.

+
+
+
memberof
+

IUpdateProfile

+
+
+
+
+
+ +

Optional profile

+
profile: IProfile
+ +
+
+

The contents of the profile for the update - if merge is NOT specified, simply overwrites the existing + profile with the contents specified here.

+
+
+
memberof
+

IUpdateProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ivalidateprofile.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ivalidateprofile.html new file mode 100644 index 0000000000..7924dcb35f --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ivalidateprofile.html @@ -0,0 +1,310 @@ + + + + + + IValidateProfile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IValidateProfile

+
+
+
+
+
+
+
+
+
+

Parameters to the "validate()" profile manager APIs. Validates a profile structure (basic and schema)

+
+
+
export
+
+
interface
+

IValidateProfile

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+

The name of the profile to validate.

+
+
+
memberof
+

IValidateProfile

+
+
+
+
+
+ +

profile

+
profile: IProfile
+ +
+
+

The profile contents to validate.

+
+
+
memberof
+

IValidateProfile

+
+
+
+
+
+ +

Optional strict

+
strict: boolean
+ +
+
+

Specify true to indicate the "ban unknown properties" specification of JSON schema. Meaning, any properties + found on the input profile that are NOT specified on the schema cause the validation to fail.

+
+
+
memberof
+

IValidateProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ivalidateprofileforcli.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ivalidateprofileforcli.html new file mode 100644 index 0000000000..bf6be72e21 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ivalidateprofileforcli.html @@ -0,0 +1,359 @@ + + + + + + IValidateProfileForCLI | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IValidateProfileForCLI

+
+
+
+
+
+
+
+
+
+

Input to the "validateProfile" internal API. Indicates the schema document to be used for the validation. + Used with the CLI Profile manager - validation is skipped until the profile is fully built

+
+
+
export
+
+
interface
+

IValidateProfileWithSchema

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+

The name of the profile to validate.

+
+
+
memberof
+

IValidateProfile

+
+
+
+
+
+ +

profile

+
profile: IProfile
+ +
+
+

The profile contents to validate.

+
+
+
memberof
+

IValidateProfile

+
+
+
+
+
+ +

readyForValidation

+
readyForValidation: boolean
+ +
+
+

If false/undefined, validation will be skipped until validation + is called again with "true" (indicating that the profile building is complete)

+
+
+
+
+ +

schema

+ + +
+
+

The profile JSON schema document.

+
+
+
memberof
+

IValidateProfileWithSchema

+
+
+
+
+
+ +

Optional strict

+
strict: boolean
+ +
+
+

Specify true to indicate the "ban unknown properties" specification of JSON schema. Meaning, any properties + found on the input profile that are NOT specified on the schema cause the validation to fail.

+
+
+
memberof
+

IValidateProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ivalidateprofilewithschema.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ivalidateprofilewithschema.html new file mode 100644 index 0000000000..5bc2add35e --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.ivalidateprofilewithschema.html @@ -0,0 +1,342 @@ + + + + + + IValidateProfileWithSchema | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IValidateProfileWithSchema

+
+
+
+
+
+
+
+
+
+

Input to the "validateProfile" internal API. Indicates the schema document to be used for the validation.

+
+
+
export
+
+
interface
+

IValidateProfileWithSchema

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+

The name of the profile to validate.

+
+
+
memberof
+

IValidateProfile

+
+
+
+
+
+ +

profile

+
profile: IProfile
+ +
+
+

The profile contents to validate.

+
+
+
memberof
+

IValidateProfile

+
+
+
+
+
+ +

schema

+ + +
+
+

The profile JSON schema document.

+
+
+
memberof
+

IValidateProfileWithSchema

+
+
+
+
+
+ +

Optional strict

+
strict: boolean
+ +
+
+

Specify true to indicate the "ban unknown properties" specification of JSON schema. Meaning, any properties + found on the input profile that are NOT specified on the schema cause the validation to fail.

+
+
+
memberof
+

IValidateProfile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebdiffgenerator.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebdiffgenerator.html new file mode 100644 index 0000000000..20417815db --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebdiffgenerator.html @@ -0,0 +1,259 @@ + + + + + + IWebDiffGenerator | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IWebDiffGenerator

+
+
+
+
+
+
+
+
+
+

Web diff genrator API that handles genration of web diff base launcher + at cli home dir

+
+
+
export
+
+
interface
+

IWebDiffGenerator

+
+
+
+
+
+

Hierarchy

+
    +
  • + IWebDiffGenerator +
  • +
+
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

buildDiffDir

+
    +
  • buildDiffDir(): void
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebdiffmanager.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebdiffmanager.html new file mode 100644 index 0000000000..85f7fa9f84 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebdiffmanager.html @@ -0,0 +1,273 @@ + + + + + + IWebDiffManager | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IWebDiffManager

+
+
+
+
+
+
+
+
+
+

Web diff manager API that handles launching of web diff and generating it if necessary.

+
+
+
export
+
+
interface
+

IWebDiffManager

+
+
+
+
+
+

Hierarchy

+
    +
  • + IWebDiffManager +
  • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

openDiffs

+
    +
  • openDiffs(content: string): void
  • +
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebhelpmanager.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebhelpmanager.html new file mode 100644 index 0000000000..3641914770 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebhelpmanager.html @@ -0,0 +1,324 @@ + + + + + + IWebHelpManager | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IWebHelpManager

+
+
+
+
+
+
+
+
+
+

Web help manager API that handles launching of web help and generating it if necessary.

+
+
+
export
+
+
interface
+

IWebHelpManager

+
+
+
+
+
+

Hierarchy

+
    +
  • + IWebHelpManager +
  • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

openHelp

+ + +
+
+ +

openRootHelp

+ + +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Method
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebhelppackagemetadata.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebhelppackagemetadata.html new file mode 100644 index 0000000000..cb1b53a400 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebhelppackagemetadata.html @@ -0,0 +1,280 @@ + + + + + + IWebHelpPackageMetadata | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IWebHelpPackageMetadata

+
+
+
+
+
+
+
+
+
+

Object containing metadata about a CLI package or plugin

+
+
+
export
+
+
interface
+

IWebHelpPackageMetadata

+
+
+
+
+
+

Hierarchy

+
    +
  • + IWebHelpPackageMetadata +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+

Name of package

+
+
+
memberof
+

IWebHelpPackageMetadata

+
+
+
+
+
+ +

version

+
version: string
+ +
+
+

Version string of package

+
+
+
memberof
+

IWebHelpPackageMetadata

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebhelptreenode.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebhelptreenode.html new file mode 100644 index 0000000000..af54d35a7e --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iwebhelptreenode.html @@ -0,0 +1,304 @@ + + + + + + IWebHelpTreeNode | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IWebHelpTreeNode

+
+
+
+
+
+
+
+
+
+

Recursive object containing data for a node of web help command tree

+
+
+
export
+
+
interface
+

IWebHelpTreeNode

+
+
+
+
+
+

Hierarchy

+
    +
  • + IWebHelpTreeNode +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional children

+
children: IWebHelpTreeNode[]
+ +
+
+

List of child nodes

+
+
+
memberof
+

IWebHelpTreeNode

+
+
+
+
+
+ +

id

+
id: string
+ +
+
+

Name of HTML file corresponding to the node

+
+
+
memberof
+

IWebHelpTreeNode

+
+
+
+
+
+ +

text

+
text: string
+ +
+
+

Display name for the node which includes full name and aliases

+
+
+
memberof
+

IWebHelpTreeNode

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iyargsparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iyargsparms.html new file mode 100644 index 0000000000..39cf592e7c --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iyargsparms.html @@ -0,0 +1,498 @@ + + + + + + IYargsParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IYargsParms

+
+
+
+
+
+
+
+
+
+

Imperative Yargs parameters - used to define imperative commands to Yargs and provides guidance/parameters for + how response objects should be handled when yargs invokes the handlers.

+
+
+
export
+
+
interface
+

IYargsParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IYargsParms +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

commandDefinition

+
commandDefinition: ICommandDefinition
+ +
+
+

The command definition document.

+
+
+
memberof
+

IYargsParms

+
+
+
+
+
+ +

commandLine

+
commandLine: string
+ +
+
+

The command line.

+
+
+
memberof
+

IYargsParms

+
+
+
+
+
+ +

commandResponseParms

+
commandResponseParms: ICommandResponseParms
+ +
+
+

The command response parameters normally scraped from the Imperative configuration document.

+
+
+
memberof
+

IYargsParms

+
+
+
+
+
+ +

envVariablePrefix

+
envVariablePrefix: string
+ +
+
+

Environmental variable name prefix used to construct configuration environmental variables.

+
+
+
memberof
+

IYargsParms

+
+
+
+
+
+ +

experimentalCommandDescription

+
experimentalCommandDescription: string
+ +
+
+

Optionally override the experimental command help text block. + Used to propagate the user's configuration down to different yargs/cmd services.

+
+
+
memberof
+

IYargsParms

+
+
+
+
+
+ +

helpGeneratorFactory

+
helpGeneratorFactory: IHelpGeneratorFactory
+ +
+
+

The help generator factory to be used in this CLI help generation

+
+
+
memberof
+

IYargsParms

+
+
+
+
+
+ +

profileManagerFactory

+
profileManagerFactory: IProfileManagerFactory<any>
+ +
+
+

The profile manager factory to use in this CLI profile management.

+
+
+
memberof
+

IYargsParms

+
+
+
+
+
+ +

promptPhrase

+
promptPhrase: string
+ +
+
+

The phrase used to indicate the user wants to enter the value of an argument in a hidden text prompt

+
+
+
memberof
+

IYargsParms

+
+
+
+
+
+ +

rootCommandName

+
rootCommandName: string
+ +
+
+

Root command name of the CLI.

+
+
+
memberof
+

IYargsParms

+
+
+
+
+
+ +

yargsInstance

+
yargsInstance: Argv
+ +
+
+

The instance of Yargs to define the commands.

+
+
+
memberof
+

IYargsParms

+
+
+
+
+
+ +

Optional yargsParent

+
yargsParent: GroupCommandYargs
+ +
+
+

The Yargs Parent object - only has meaning for nested/group commands.

+
+
+
memberof
+

IYargsParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iyargsresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iyargsresponse.html new file mode 100644 index 0000000000..dc06b03324 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_imperative.iyargsresponse.html @@ -0,0 +1,315 @@ + + + + + + IYargsResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IYargsResponse

+
+
+
+
+
+
+
+
+
+

The Yargs response is provided on the callback for a command definition defined through the Brightside + Yargs definer - when an execution of that command is complete - this response will be given to the callback.

+
+
+
+
+

Hierarchy

+
    +
  • + IYargsResponse +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

actionPerformed

+ + +
+
+ +

Optional causeErrors

+
causeErrors: Error
+ +
+
+ +

Optional commandResponses

+
commandResponses: ICommandResponse[]
+ +
+
+ +

exitCode

+
exitCode: number
+ +
+
+

Requested exit code for the process

+
+
+
+
+ +

message

+
message: string
+ +
+
+ +

success

+
success: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iperformactionresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iperformactionresponse.html new file mode 100644 index 0000000000..83783ba105 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iperformactionresponse.html @@ -0,0 +1,280 @@ + + + + + + IPerformActionResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPerformActionResponse

+
+
+
+
+
+
+
+
+
+

z/OSMF response when to perform an action on a provisioned instance.

+
+
+
export
+
+
interface
+

IPerformActionResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IPerformActionResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

action-id

+
action-id: string
+ +
+
+

The ID of the action object that was created by running the action.

+
+
+
memberof
+

IPerformActionResponse

+
+
+
+
+
+ +

action-uri

+
action-uri: string
+ +
+
+

The URI of the new action object.

+
+
+
memberof
+

IPerformActionResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html new file mode 100644 index 0000000000..fad5b0e65a --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipromptvariable.html @@ -0,0 +1,594 @@ + + + + + + IPromptVariable | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPromptVariable

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IPromptVariable

+
+
+
+
+
+

Hierarchy

+
    +
  • + IPromptVariable +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

abstract

+
abstract: string
+ +
+
+

Brief description of the variable for the UI widget.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

choices

+
choices: string[]
+ +
+
+

Contains allowable choices for the value of the variable.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

description

+
description: string
+ +
+
+

Explanation of what the variable is used for and perhaps what the syntactic requirements are.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

error-message

+
error-message: string
+ +
+
+

Default error message associated with an incorrect value.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

label

+
label: string
+ +
+
+

Short label for the UI widget.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

max

+
max: string
+ +
+
+

For a string type, indicates the maximum string length of the value. + For all other types, indicates the maximum value required.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

min

+
min: string
+ +
+
+

For a string type, indicates the minimum string length of the value. + For all other types, indicates the minimum value required.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

multi-line

+
multi-line: boolean
+ +
+
+

Indicates whether the value requires a multi-line text box.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

must-be-choice

+
must-be-choice: boolean
+ +
+
+

Indicates whether the value must come from the provided choices.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

Name of the property.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

places

+
places: string
+ +
+
+

Maximum number of decimal places that can be specified for a variable of the decimal type.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

regex

+
regex: string
+ +
+
+

Standard regular expression that constrains the variable value.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

required

+
required: boolean
+ +
+
+

Indicates whether the variable value is required during the workflow create process.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

Type of variable element: boolean, string, integer, decimal, time, date.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+ +

value

+
value: string
+ +
+
+

Current value for the property.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipropertiesinput.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipropertiesinput.html new file mode 100644 index 0000000000..1f0e3959ca --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipropertiesinput.html @@ -0,0 +1,280 @@ + + + + + + IPropertiesInput | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPropertiesInput

+
+
+
+
+
+
+
+
+
+

Interface for property objects.

+
+
+
export
+
+
interface
+

IPropertiesInput

+
+
+
+
+
+

Hierarchy

+
    +
  • + IPropertiesInput +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+

Name of the property.

+
+
+
memberof
+

IPropertiesInput

+
+
+
+
+
+ +

value

+
value: string
+ +
+
+

Value of the property.

+
+
+
memberof
+

IPropertiesInput

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html new file mode 100644 index 0000000000..7c9a066249 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstance.html @@ -0,0 +1,1245 @@ + + + + + + IProvisionedInstance | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProvisionedInstance

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IProvisionedInstance

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProvisionedInstance +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional account-info

+
account-info: string
+ +
+
+

The account information.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional actions

+ + +
+
+

The actions for the software.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

catalog-object-id

+
catalog-object-id: string
+ +
+
+

The identifier of the template that is used when partitioning the software represented + by this instance. Only valid when registry-type is catalog.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

catalog-object-name

+
catalog-object-name: string
+ +
+
+

The name of the template that was used when partitioning the software represented by this instance.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

created-by-user

+
created-by-user: string
+ +
+
+

The user ID that created the object.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

created-time

+
created-time: string
+ +
+
+

The time the object was created. The time is in the ISO8601 format.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

description

+
description: string
+ +
+
+

Description for the software.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

domain-id

+
domain-id: string
+ +
+
+

The domain ID.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

domain-name

+
domain-name: string
+ +
+
+

The domain name.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional email

+
email: string
+ +
+
+

Instance owner's email.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

external-name

+
external-name: string
+ +
+
+

External name of the software services instance.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional job-statement

+
job-statement: string
+ +
+
+

Statement of the job.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional jobs-disposition

+
jobs-disposition: string
+ +
+
+

Indicates the disposition of jobs.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

last-action-name

+
last-action-name: string
+ +
+
+

The name of the last action that was performed.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

last-action-object-id

+
last-action-object-id: string
+ +
+
+

The action ID of the last action that was performed.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

last-action-state

+
last-action-state: string
+ +
+
+

The state of the last action that was performed.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

last-modified-by-user

+
last-modified-by-user: string
+ +
+
+

The user ID that last updated the object.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

last-modified-time

+
last-modified-time: string
+ +
+
+

The time the object was updated. The time is in the ISO8601 format.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

object-id

+
object-id: string
+ +
+
+

The object-id for the software services instance.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

object-name

+
object-name: string
+ +
+
+

The object-name for the software services instance.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional object-uri

+
object-uri: string
+ +
+
+

Full request URI to z/OSMF with object-id.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

owner

+
owner: string
+ +
+
+

The user ID that identifies the owner of the software.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

provider

+
provider: string
+ +
+
+

The user ID that identifies the provider of the software.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

registry-type

+
registry-type: string
+ +
+
+

Type of registry object: catalog or general.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional runAsUser-audit

+
runAsUser-audit: boolean
+ +
+
+

Indicates if auditing is performed on workflows and command actions that + are associated with the instance.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional ssin

+
ssin: string
+ +
+
+

Software service instance name, used in generating names for software services instances.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

state

+
state: string
+ +
+
+

The current state of the software.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

sysplex

+
sysplex: string
+ +
+
+

Sysplex on which the software is provisioned.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

system

+
system: string
+ +
+
+

System on which the software is provisioned.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

system-nickname

+
system-nickname: string
+ +
+
+

The name of the system entry in the system entry table of the software.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

tenant-id

+
tenant-id: string
+ +
+
+

The tenant ID.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

tenant-name

+
tenant-name: string
+ +
+
+

The name of the tenant.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

Type of the software.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional user-data

+
user-data: string
+ +
+
+
The user data.
+
+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

user-data-id

+
user-data-id: string
+ +
+
+

The user data ID.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional variables

+ + +
+
+

For workflow type actions, if provided, the prompt variables, which are the variables + that are expected to be prompted for in preparation for running the software services template.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

vendor

+
vendor: string
+ +
+
+

Vendor of the software.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

version

+
version: string
+ +
+
+

Version of the software.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional workflow-clean-after-provisioned

+
workflow-clean-after-provisioned: string
+ +
+
+

The Indication of whether the workflow instance used to provision this instance + will be removed after the workflow is completed. Must be true or false.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional workflow-key

+
workflow-key: string
+ +
+
+

The workflow key that is associated with provisioning the software.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional workflow-start-time

+
workflow-start-time: string
+ +
+
+

The time that workflow processing started, in ISO8601 format.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+ +

Optional workflow-stop-time

+
workflow-stop-time: string
+ +
+
+

The time that workflow automation last stopped, in ISO8601 format.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html new file mode 100644 index 0000000000..7905a12cc0 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstanceactions.html @@ -0,0 +1,597 @@ + + + + + + IProvisionedInstanceActions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProvisionedInstanceActions

+
+
+
+
+
+
+
+
+
+

Interface for provisioned instance actions.

+
+
+
export
+
+
interface
+

IProvisionedInstanceActions

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProvisionedInstanceActions +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

at-create-variables

+
at-create-variables: IProvisionedInstanceVariable[]
+ +
+
+

These are the only variables allowed on input-variables for the do action operation.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

command

+
command: string
+ +
+
+

For command type actions, the command.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

command-detect-time

+
command-detect-time: string
+ +
+
+

For command type actions, if provided, the time in seconds to detect the command-unsol-key. + in the unsolicited messages.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

command-run-as-user

+
command-run-as-user: string
+ +
+
+

For command type actions, if provided, the user ID to be used when the command is run. + This is not valid when the registry-type is general.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

command-sol-key

+
command-sol-key: string
+ +
+
+

For command type actions, if provided, the key to search for in the solicited messages command response.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

command-unsol-key

+
command-unsol-key: string
+ +
+
+

For command type actions, if provided, the key to search for in the unsolicited messages.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

instructions

+
instructions: string
+ +
+
+

For instruction type actions, the instructions.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

is-deprovision

+
is-deprovision: string
+ +
+
+

Indicates if the action deprovisions the software.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

The name of the action. If the name of the action is deprovision, + the action is for deprovisioning the software.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

prompt-variables

+
prompt-variables: IProvisionedInstanceVariable[]
+ +
+
+

For workflow type actions, if provided, the prompt variables, which are the variables + that are expected to be prompted for in preparation for running the software services template.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

The type of the action.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

variables

+ + +
+
+

For workflow type actions, if provided, the workflow variables.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

workflow-clean-after-complete

+
workflow-clean-after-complete: string
+ +
+
+

For workflow type actions, if provided, specifies whether the instance of the workflow + is deleted after it completes.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

workflow-definition-file

+
workflow-definition-file: string
+ +
+
+

For workflow type actions, the workflow definition file.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+ +

workflow-variable-input-file

+
workflow-variable-input-file: string
+ +
+
+

For workflow type actions, if provided, the workflow variable input file.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstances.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstances.html new file mode 100644 index 0000000000..0703dc315f --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstances.html @@ -0,0 +1,256 @@ + + + + + + IProvisionedInstances | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProvisionedInstances

+
+
+
+
+
+
+
+
+
+

The list of provisioned instances.

+
+
+
export
+
+
interface
+

IProvisionedInstances

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProvisionedInstances +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

scr-list

+ + +
+
+

Provisioned software service instances.

+
+
+
memberof
+

IProvisionedInstances

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariable.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariable.html new file mode 100644 index 0000000000..a665981135 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariable.html @@ -0,0 +1,328 @@ + + + + + + IProvisionedInstanceVariable | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProvisionedInstanceVariable

+
+
+
+
+
+
+
+
+
+

Interface for provisioned instance variables.

+
+
+
export
+
+
interface
+

IProvisionedInstanceVariable

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProvisionedInstanceVariable +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+

Name of the variable.

+
+
+
memberof
+

IProvisionedInstanceVariable

+
+
+
+
+
+ +

update-registry

+
update-registry: string
+ +
+
+

Indicates whether to update the variables in the instance from the workflow.

+
+
+
memberof
+

IProvisionedInstanceVariable

+
+
+
+
+
+ +

value

+
value: string
+ +
+
+

Value of the variable.

+
+
+
memberof
+

IProvisionedInstanceVariable

+
+
+
+
+
+ +

visibility

+
visibility: string
+ +
+
+

Visibility of the variable.

+
+
+
memberof
+

IProvisionedInstanceVariable

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariables.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariables.html new file mode 100644 index 0000000000..74bd695d78 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionedinstancevariables.html @@ -0,0 +1,256 @@ + + + + + + IProvisionedInstanceVariables | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProvisionedInstanceVariables

+
+
+
+
+
+
+
+
+
+

The list of variables of the provisioned instance.

+
+
+
export
+
+
interface
+

IProvisionedInstanceVariables

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProvisionedInstanceVariables +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

variables

+ + +
+
+

Variables for the software services instance.

+
+
+
memberof
+

IProvisionedInstanceVariables

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionoptionals.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionoptionals.html new file mode 100644 index 0000000000..a8c4a36160 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisionoptionals.html @@ -0,0 +1,400 @@ + + + + + + IProvisionOptionals | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProvisionOptionals

+
+
+
+
+
+
+
+
+
+

Interface for provisioning the template command of the z/OSMF parameters.

+
+
+
export
+
+
interface
+

IProvisionOptionals

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProvisionOptionals +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

account-info

+
account-info: string
+ +
+
+

Account information to use in the JCL JOB statement.

+
+
+
memberof
+

IProvisionOptionals

+
+
+
+
+
+ +

domain-name

+
domain-name: string
+ +
+
+

Name of the domain.

+
+
+
memberof
+

IProvisionOptionals

+
+
+
+
+
+ +

input-variables

+
input-variables: IPropertiesInput[]
+ +
+
+

Runtime property objects.

+
+
+
memberof
+

IProvisionOptionals

+
+
+
+
+
+ +

systems-nicknames

+
systems-nicknames: string[]
+ +
+
+

Nicknames of the systems upon which to provision the template.

+
+
+
memberof
+

IProvisionOptionals

+
+
+
+
+
+ +

tenant-name

+
tenant-name: string
+ +
+
+

Name of the tenant.

+
+
+
memberof
+

IProvisionOptionals

+
+
+
+
+
+ +

user-data

+
user-data: string
+ +
+
+

User data that is passed into the software services registry.

+
+
+
memberof
+

IProvisionOptionals

+
+
+
+
+
+ +

user-data-id

+
user-data-id: string
+ +
+
+

ID for the user data specified with user-data.

+
+
+
memberof
+

IProvisionOptionals

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisiontemplateresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisiontemplateresponse.html new file mode 100644 index 0000000000..c65fcfdf94 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.iprovisiontemplateresponse.html @@ -0,0 +1,304 @@ + + + + + + IProvisionTemplateResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IProvisionTemplateResponse

+
+
+
+
+
+
+
+
+
+

Interface for provisioning the published template of the z/OSMF API response.

+
+
+
export
+
+
interface
+

IProvisionTemplateResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IProvisionTemplateResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

registry-info

+
registry-info: ITemplateRegistryInfo
+ +
+
+

Object mapping that matches the response body returned from a registry create action.

+
+
+
memberof
+

IProvisionTemplateResponse

+
+
+
+
+
+ +

system-nickname

+
system-nickname: string
+ +
+
+

Nickname of the system that the service is provisioned on.

+
+
+
memberof
+

IProvisionTemplateResponse

+
+
+
+
+
+ +

workflow-info

+
workflow-info: ITemplateWorkflowInfo
+ +
+
+

Object mapping that matches the response body returned from the workflow create action.

+
+
+
memberof
+

IProvisionTemplateResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html new file mode 100644 index 0000000000..f179288e22 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplate.html @@ -0,0 +1,448 @@ + + + + + + IPublishedTemplate | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPublishedTemplate

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IPublishedTemplate

+
+
+
+
+
+

Hierarchy

+
    +
  • + IPublishedTemplate +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+

Description of a template.

+
+
+
memberof
+

IPublishedTemplate

+
+
+
+
+
+ +

domain-name

+
domain-name: string
+ +
+
+

The domain the template is associated with.

+
+
+
memberof
+

IPublishedTemplate

+
+
+
+
+
+ +

generated-name

+
generated-name: string
+ +
+
+

Generated name for a template.

+
+
+
memberof
+

IPublishedTemplate

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

Name of a template.

+
+
+
memberof
+

IPublishedTemplate

+
+
+
+
+
+ +

object-id

+
object-id: string
+ +
+
+

The ID that identifies a template.

+
+
+
memberof
+

IPublishedTemplate

+
+
+
+
+
+ +

owner

+
owner: string
+ +
+
+

Template owner ID.

+
+
+
memberof
+

IPublishedTemplate

+
+
+
+
+
+ +

software-name

+
software-name: string
+ +
+
+

Name of the software that is being provisioned.

+
+
+
memberof
+

IPublishedTemplate

+
+
+
+
+
+ +

state

+
state: string
+ +
+
+

Status of a template.

+
+
+
memberof
+

IPublishedTemplate

+
+
+
+
+
+ +

version

+
version: string
+ +
+
+

Version of a template.

+
+
+
memberof
+

IPublishedTemplate

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html new file mode 100644 index 0000000000..a65106b64d --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplateinfo.html @@ -0,0 +1,472 @@ + + + + + + IPublishedTemplateInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPublishedTemplateInfo

+
+
+
+
+
+
+
+
+
+

The ListTemplateInfo z/OSMF API response.

+
+
+
export
+
+
interface
+

IPublishedTemplateInfo

+
+
+
+
+
+

Hierarchy

+
    +
  • + IPublishedTemplateInfo +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+

Description of the template.

+
+
+
memberof
+

IPublishedTemplateInfo

+
+
+
+
+
+ +

domain-name

+
domain-name: string
+ +
+
+

The domain the template is associated with.

+
+
+
memberof
+

IPublishedTemplateInfo

+
+
+
+
+
+ +

generated-name

+
generated-name: string
+ +
+
+

Generated name for a template.

+
+
+
memberof
+

IPublishedTemplateInfo

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

Name of the template.

+
+
+
memberof
+

IPublishedTemplateInfo

+
+
+
+
+
+ +

object-id

+
object-id: string
+ +
+
+

The ID that identifies a template.

+
+
+
memberof
+

IPublishedTemplateInfo

+
+
+
+
+
+ +

owner

+
owner: string
+ +
+
+

Template owner ID.

+
+
+
memberof
+

IPublishedTemplateInfo

+
+
+
+
+
+ +

prompt-variables

+
prompt-variables: IPromptVariable[]
+ +
+
+

Array the of prompt variables of the template.

+
+
+
memberof
+

IPublishedTemplateInfo

+
+
+
+
+
+ +

software-name

+
software-name: string
+ +
+
+

Name of the software that is being provisioned.

+
+
+
memberof
+

IPublishedTemplateInfo

+
+
+
+
+
+ +

state

+
state: string
+ +
+
+

Status of the template.

+
+
+
memberof
+

IPublishedTemplateInfo

+
+
+
+
+
+ +

version

+
version: string
+ +
+
+

Version of the template.

+
+
+
memberof
+

IPublishedTemplateInfo

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplates.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplates.html new file mode 100644 index 0000000000..9c5a1728c5 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.ipublishedtemplates.html @@ -0,0 +1,256 @@ + + + + + + IPublishedTemplates | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPublishedTemplates

+
+
+
+
+
+
+
+
+
+

The list of published templates.

+
+
+
export
+
+
interface
+

IPublishedTemplates

+
+
+
+
+
+

Hierarchy

+
    +
  • + IPublishedTemplates +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

psc-list

+
psc-list: IPublishedTemplate[]
+ +
+
+

Published software service templates.

+
+
+
memberof
+

IPublishedTemplates

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.itemplateregistryinfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.itemplateregistryinfo.html new file mode 100644 index 0000000000..384b1bd737 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.itemplateregistryinfo.html @@ -0,0 +1,352 @@ + + + + + + ITemplateRegistryInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ITemplateRegistryInfo

+
+
+
+
+
+
+
+
+
+

Interface for the response body returned from a registry create action.

+
+
+
export
+
+
interface
+

ITemplateRegistryInfo

+
+
+
+
+
+

Hierarchy

+
    +
  • + ITemplateRegistryInfo +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

external-name

+
external-name: string
+ +
+
+

External name of the software services instance.

+
+
+
memberof
+

ITemplateRegistryInfo

+
+
+
+
+
+ +

object-id

+
object-id: string
+ +
+
+

ID of the object.

+
+
+
memberof
+

ITemplateRegistryInfo

+
+
+
+
+
+ +

object-name

+
object-name: string
+ +
+
+

Name of the object.

+
+
+
memberof
+

ITemplateRegistryInfo

+
+
+
+
+
+ +

object-uri

+
object-uri: string
+ +
+
+

URI of the object.

+
+
+
memberof
+

ITemplateRegistryInfo

+
+
+
+
+
+ +

system-nickname

+
system-nickname: string
+ +
+
+

The name of the system entry in the system entry table of the software.

+
+
+
memberof
+

ITemplateRegistryInfo

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.itemplateworkflowinfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.itemplateworkflowinfo.html new file mode 100644 index 0000000000..5a113f0196 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_provisioning_for_zowe_sdk.itemplateworkflowinfo.html @@ -0,0 +1,352 @@ + + + + + + ITemplateWorkflowInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ITemplateWorkflowInfo

+
+
+
+
+
+
+
+
+
+

Interface for the response body returned from the creation of a workflow.

+
+
+
export
+
+
interface
+

ITemplateWorkflowInfo

+
+
+
+
+
+

Hierarchy

+
    +
  • + ITemplateWorkflowInfo +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

vendor

+
vendor: string
+ +
+
+

Vendor name.

+
+
+
memberof
+

ITemplateWorkflowInfo

+
+
+
+
+
+ +

workflowDescription

+
workflowDescription: string
+ +
+
+

Description of the workflow.

+
+
+
memberof
+

ITemplateWorkflowInfo

+
+
+
+
+
+ +

workflowID

+
workflowID: string
+ +
+
+

ID of the workflow.

+
+
+
memberof
+

ITemplateWorkflowInfo

+
+
+
+
+
+ +

workflowKey

+
workflowKey: string
+ +
+
+

Unique workflow key.

+
+
+
memberof
+

ITemplateWorkflowInfo

+
+
+
+
+
+ +

workflowVersion

+
workflowVersion: string
+ +
+
+

Version of the workflow.

+
+
+
memberof
+

ITemplateWorkflowInfo

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.icollectparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.icollectparms.html new file mode 100644 index 0000000000..aa73a83263 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.icollectparms.html @@ -0,0 +1,441 @@ + + + + + + ICollectParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICollectParms

+
+
+
+
+
+
+
+
+
+

Interface for Collect command parameters

+
+
+
export
+
+
interface
+

ICollectParms

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

commandResponseKey

+
commandResponseKey: string
+ +
+
+

The command response key for follow up messages + API call.

+
+
+
memberof
+

ICollectParms

+
+
+
+
+
+ +

Optional consoleName

+
consoleName: string
+ +
+
+

The z/OS emcs console to direct the commands.

+
+
+
memberof
+

IConsoleParms

+
+
+
+
+
+ +

Optional followUpAttempts

+
followUpAttempts: number
+ +
+
+

The default is 1, however you may specify the number of follow-up attempts. This can be useful when multiple + multi-line WTO command responses are issued in direct response to a command. zOS consoles do NOT have any + awareness of how many multi-line WTO messages will be issued in response to a command. Use this parameter + in conjunction with waitToCollect to "fine-tune" your requests. The follow-up counter is decremented when + no command response (response text) is present in the request. Meaning, if a command is issued, follow-up + attempts is 1, and the first 2 requests provided command response data, it will issue 1 final + follow up request before returning (resulting in 3 total API calls).

+
+
+
memberof
+

ICollectParms

+
+
+
+
+
+ +

Optional processResponses

+
processResponses: boolean
+ +
+
+

The z/OSMF Console API returns '\r' or '\r\n' where line-breaks. Can attempt to replace these + sequences with '\n', but there may be cases where that is not preferable. Specify false to prevent processing.

+
+
+
memberof
+

IConsoleParms

+
+
+
+
+
+ +

Optional waitToCollect

+
waitToCollect: number
+ +
+
+

Indicates that you would like to wait 'n' number of seconds before issues a follow-up request for + additional messages (assuming a command response key is present). Will wait the specified amount of + time before each follow-up request is issued.

+
+
+
memberof
+

ICollectParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleparms.html new file mode 100644 index 0000000000..ff6af62b89 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleparms.html @@ -0,0 +1,361 @@ + + + + + + IConsoleParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConsoleParms

+
+
+
+
+
+
+
+
+
+

Common z/OS Consoles API Parameters.

+
+
+
export
+
+
interface
+

IConsoleParms

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional consoleName

+
consoleName: string
+ +
+
+

The z/OS emcs console to direct the commands.

+
+
+
memberof
+

IConsoleParms

+
+
+
+
+
+ +

Optional processResponses

+
processResponses: boolean
+ +
+
+

The z/OSMF Console API returns '\r' or '\r\n' where line-breaks. Can attempt to replace these + sequences with '\n', but there may be cases where that is not preferable. Specify false to prevent processing.

+
+
+
memberof
+

IConsoleParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleresponse.html new file mode 100644 index 0000000000..a052b22bd6 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.iconsoleresponse.html @@ -0,0 +1,476 @@ + + + + + + IConsoleResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IConsoleResponse

+
+
+
+
+
+
+
+
+
+

The Console API response.

+
+
+
export
+
+
interface
+

IConsoleResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IConsoleResponse +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional cmdResponseUrl

+
cmdResponseUrl: string
+ +
+
+

The "follow-up" command response URL - you can paste this in the browser to do a "GET" using the command + response key provided in the URI route.

+
+
+
memberof
+

IConsoleResponse

+
+
+
+
+
+ +

commandResponse

+
commandResponse: string
+ +
+
+

The command response text.

+
+
+
type{string}
+
+
memberof
+

IConsoleResponse

+
+
+
+
+
+ +

Optional failureResponse

+
failureResponse: ImperativeError
+ +
+
+

If an error occurs, returns the ImperativeError, which contains casue error.

+
+
+
memberof
+

IConsoleResponse

+
+
+
+
+
+ +

Optional keywordDetected

+
keywordDetected: boolean
+ +
+
+

If the solicited keyword is specified, indicates that the keyword was detected.

+
+
+
memberof
+

IConsoleResponse

+
+
+
+
+
+ +

Optional lastResponseKey

+
lastResponseKey: string
+ +
+
+

The final command response key - used to "follow-up" and check for additional response messages for the command.

+
+
+
memberof
+

IConsoleResponse

+
+
+
+
+
+ +

success

+
success: boolean
+ +
+
+

True if the command was issued and the responses were collected.

+
+
+
memberof
+

IConsoleResponse

+
+
+
+
+
+ +

zosmfResponse

+
zosmfResponse: IZosmfIssueResponse[]
+ +
+
+

The list of zOSMF console API responses. May issue multiple requests (because of user request) or + to ensure that all messages are collected. Each individual response is placed here.

+
+
+
memberof
+

IConsoleResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.iissueparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.iissueparms.html new file mode 100644 index 0000000000..a815fb4db4 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.iissueparms.html @@ -0,0 +1,458 @@ + + + + + + IIssueParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IIssueParms

+
+
+
+
+
+
+
+
+
+

Interface for Issue command parameters

+
+
+
export
+
+
interface
+

IIssueParms

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional async

+
async: string
+ +
+
+

Indicates the method of issuing the command is synchronous or asynchronous. + Default value is "N" - Synchronous request.

+
+
+
memberof
+

IIssueParms

+
+
+
+
+
+ +

command

+
command: string
+ +
+
+

The Command to issue.

+
+
+
memberof
+

IIssueParms

+
+
+
+
+
+ +

Optional consoleName

+
consoleName: string
+ +
+
+

The z/OS emcs console to direct the commands.

+
+
+
memberof
+

IConsoleParms

+
+
+
+
+
+ +

Optional processResponses

+
processResponses: boolean
+ +
+
+

The z/OSMF Console API returns '\r' or '\r\n' where line-breaks. Can attempt to replace these + sequences with '\n', but there may be cases where that is not preferable. Specify false to prevent processing.

+
+
+
memberof
+

IConsoleParms

+
+
+
+
+
+ +

Optional solicitedKeyword

+
solicitedKeyword: string
+ +
+
+

The solicited keyword to check for in the response. Causes the API to return immediately when the keyword + is found, however, it may include solicited command response messages beyond the keyword itself.

+
+
+
memberof
+

IIssueParms

+
+
+
+
+
+ +

Optional sysplexSystem

+
sysplexSystem: string
+ +
+
+

The system (withing the z/OSMF sysplex) to route the command.

+
+
+
memberof
+

IIssueParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.izosmfcollectresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.izosmfcollectresponse.html new file mode 100644 index 0000000000..b26fbbb7dd --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.izosmfcollectresponse.html @@ -0,0 +1,347 @@ + + + + + + IZosmfCollectResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosmfCollectResponse

+
+
+
+
+
+
+
+
+
+

z/OSMF synchronous console command response messages. See the z/OSMF REST API publication for complete details.

+
+
+
export
+
+
interface
+

IZosmfCollectResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IZosmfCollectResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

cmd-response

+
cmd-response: string
+ +
+
+

Command response text.

+
+
+
+
+ +

Optional sol-key-detected

+
sol-key-detected: boolean
+ +
+
+

True if the solicited keyword requested is present.

+
+
+
memberof
+

IZosmfCollectResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueparms.html new file mode 100644 index 0000000000..1149b030d3 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueparms.html @@ -0,0 +1,400 @@ + + + + + + IZosmfIssueParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosmfIssueParms

+
+
+
+
+
+
+
+
+
+

The z/OSMF console API parameters. See the z/OSMF REST API documentation for full details.

+
+
+
export
+
+
interface
+

IZosmfIssueParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IZosmfIssueParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional async

+
async: string
+ +
+
+

The method of issuing the command.

+
+
+
memberof
+

IZosmfIssueParms

+
+
+
+
+
+ +

cmd

+
cmd: string
+ +
+
+

The z/OS console command to issue.

+
+
+
memberof
+

IZosmfIssueParms

+
+
+
+
+
+ +

Optional sol-key

+
sol-key: string
+ +
+
+

The solicited keyword to look for

+
+
+
memberof
+

IZosmfIssueParms

+
+
+
+
+
+ +

Optional system

+
system: string
+ +
+
+

The system in the sysplex to route the command.

+
+
+
memberof
+

IZosmfIssueParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueresponse.html new file mode 100644 index 0000000000..68553d3cc2 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_console_for_zowe_sdk.izosmfissueresponse.html @@ -0,0 +1,424 @@ + + + + + + IZosmfIssueResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosmfIssueResponse

+
+
+
+
+
+
+
+
+
+

z/OSMF synchronous console command response messages. See the z/OSMF REST API publication for complete details.

+
+
+
export
+
+
interface
+

IZosmfIssueResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IZosmfIssueResponse +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

cmd-response

+
cmd-response: string
+ +
+
+

Command response text.

+
+
+
memberof
+

IZosmfIssueResponse

+
+
+
+
+
+ +

Optional cmd-response-key

+
cmd-response-key: string
+ +
+
+

The command response key used for follow-up requests.

+
+
+
memberof
+

IZosmfIssueResponse

+
+
+
+
+
+ +

Optional cmd-response-uri

+
cmd-response-uri: string
+ +
+
+

The follow-up response URI.

+
+
+
memberof
+

IZosmfIssueResponse

+
+
+
+
+
+ +

Optional cmd-response-url

+
cmd-response-url: string
+ +
+
+

Follow-up response URL.

+
+
+
memberof
+

IZosmfIssueResponse

+
+
+
+
+
+ +

Optional sol-key-detected

+
sol-key-detected: boolean
+ +
+
+

True if the solicited keyword requested is present.

+
+
+
memberof
+

IZosmfIssueResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icopydatasetoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icopydatasetoptions.html new file mode 100644 index 0000000000..dfc612d6a0 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icopydatasetoptions.html @@ -0,0 +1,313 @@ + + + + + + ICopyDatasetOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICopyDatasetOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the options that can be sent into the copy data set function.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional enq

+
enq: string
+ +
+
+

Enq option + Allow values are: SHR, SHRW, EXCLU.

+
+
+
+
+ +

from-dataset

+
from-dataset: IDataSet
+ +
+
+

The dataset to copy from.

+
+
+
+
+ +

Optional replace

+
replace: boolean
+ +
+
+

Replace option

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html new file mode 100644 index 0000000000..791d0e5400 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icreatedatasetoptions.html @@ -0,0 +1,581 @@ + + + + + + ICreateDataSetOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICreateDataSetOptions

+
+
+
+
+
+
+
+
+ +
+
export
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional alcunit

+
alcunit: string
+ +
+
+

The unit of space allocation

+
+
+
+
+ +

Optional avgblk

+
avgblk: number
+ +
+
+

The average block

+
+
+
+
+ +

Optional blksize

+
blksize: number
+ +
+
+

The block size

+
+
+
+
+ +

Optional dataclass

+
dataclass: string
+ +
+
+

The data class

+
+
+
+
+ +

Optional dirblk

+
dirblk: number
+ +
+
+

The number of directory blocks

+
+
+
+
+ +

Optional dsntype

+
dsntype: string
+ +
+
+

The data set type

+
+
+
+
+ +

Optional dsorg

+
dsorg: string
+ +
+
+

The data set organization

+
+
+
+
+ +

lrecl

+
lrecl: number
+ +
+
+

The record length

+
+
+
+
+ +

Optional mgntclass

+
mgntclass: string
+ +
+
+

The management class

+
+
+
+
+ +

primary

+
primary: number
+ +
+
+

The primary space allocation

+
+
+
+
+ +

Optional recfm

+
recfm: string
+ +
+
+

The record format

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional secondary

+
secondary: number
+ +
+
+

The secondary space allocation

+
+
+
+
+ +

Optional showAttributes

+
showAttributes: boolean
+ +
+
+

The indicator that we need to show the attributes

+
+

DO NOT SEND THIS TO ZOSMF

+
+
+
+ +

Optional size

+
size: string
+ +
+
+

The abstraction of Allocation unit and Primary Space

+
+

DO NOT SEND THIS TO ZOSMF

+
+
+
+ +

Optional storclass

+
storclass: string
+ +
+
+

The storage class

+
+
+
+
+ +

Optional unit

+
unit: string
+ +
+
+

The device type

+
+
+
+
+ +

Optional volser

+
volser: string
+ +
+
+

The volume serial

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icreateussoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icreateussoptions.html new file mode 100644 index 0000000000..5490a4c376 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icreateussoptions.html @@ -0,0 +1,296 @@ + + + + + + ICreateUssOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICreateUssOptions

+
+
+
+
+
+
+
+
+
+

Interface for the options to the create uss file or directory API.

+
+
+
export
+
+
interface
+

ICreateUssOptions

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional mode

+
mode: string
+ +
+
+
Specifies the file or directory permission bits to be used in creating the file or directory.
+
+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

type

+
type: string
+ +
+
+

The request type

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html new file mode 100644 index 0000000000..fc6c74c2ff --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icreatevsamoptions.html @@ -0,0 +1,467 @@ + + + + + + ICreateVsamOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICreateVsamOptions

+
+
+
+
+
+
+
+
+
+

Interface for the options to the create data-set-vsam API.

+
+
+
export
+
+
interface
+

ICreateVsamOptions

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional alcunit

+
alcunit: string
+ +
+
+

The unit of space allocation

+
+
+
+
+ +

Optional dataclass

+
dataclass: string
+ +
+
+

The data class

+
+
+
+
+ +

Optional dsorg

+
dsorg: string
+ +
+
+

The data set organization

+
+
+
+
+ +

Optional mgntclass

+
mgntclass: string
+ +
+
+

The management class

+
+
+
+
+ +

Optional primary

+
primary: number
+ +
+
+

The primary space allocation

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional retainFor

+
retainFor: number
+ +
+
+

The number of days for which the VSAM cluster will be retained

+
+
+
+
+ +

Optional retainTo

+
retainTo: string
+ +
+
+

The date until which the VSAM cluster will be retained

+
+
+
+
+ +

Optional secondary

+
secondary: number
+ +
+
+

The secondary space allocation

+
+
+
+
+ +

Optional showAttributes

+
showAttributes: boolean
+ +
+
+

The indicator that we need to show the attributes

+
+

DO NOT SEND THIS TO ZOSMF

+
+
+
+ +

Optional storclass

+
storclass: string
+ +
+
+

The storage class

+
+
+
+
+ +

Optional volumes

+
volumes: string
+ +
+
+

The volumes on which to allocate space

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html new file mode 100644 index 0000000000..0f350eb580 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icreatezfsoptions.html @@ -0,0 +1,447 @@ + + + + + + ICreateZfsOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICreateZfsOptions

+
+
+
+
+
+
+
+
+
+

Interface for the options to the create zos-file-system API.

+
+
+
export
+
+
interface
+

ICreateZfsOptions

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

cylsPri

+
cylsPri: number
+ +
+
+

The primary space allocation

+
+
+
+
+ +

Optional cylsSec

+
cylsSec: number
+ +
+
+

The secondary space allocation

+
+
+
+
+ +

Optional dataclass

+
dataclass: string
+ +
+
+

The data class

+
+
+
+
+ +

Optional group

+
group: string
+ +
+
+

The group ID for the root directory

+
+
+
+
+ +

Optional mgntclass

+
mgntclass: string
+ +
+
+

The management class

+
+
+
+
+ +

Optional owner

+
owner: string
+ +
+
+

The user ID for owner of the root directory

+
+
+
+
+ +

Optional perms

+
perms: number
+ +
+
+

The permissions code for the root directory

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional storclass

+
storclass: string
+ +
+
+

The storage class

+
+
+
+
+ +

Optional timeout

+
timeout: number
+ +
+
+

The number of seconds to wait for command to complete

+
+
+
+
+ +

Optional volumes

+
volumes: string[]
+ +
+
+

The volumes on which to allocate space

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html new file mode 100644 index 0000000000..ee128d64c2 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.icrosslparcopydatasetoptions.html @@ -0,0 +1,454 @@ + + + + + + ICrossLparCopyDatasetOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICrossLparCopyDatasetOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the options that can be sent into the copy cross lpar data set function.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional enq

+
enq: string
+ +
+
+

Enq option + Allow values are: SHR, SHRW, EXCLU.

+
+
+
+
+ +

from-dataset

+
from-dataset: IDataSet
+ +
+
+

The dataset to copy from.

+
+
+
+
+ +

Optional overwrite

+
overwrite: boolean
+ +
+
+

Overwrite option

+
+
+
+
+ +

Optional promptFn

+
promptFn: (targetDSN: string) => Promise<boolean>
+ +
+
+

Prompt callback that will be invoked before overwiting a data set.

+
+
+
param
+

Name of data set that already exists

+
+
returns
+

True if target data set should be overwritten

+
+
+
+
+

Type declaration

+
    +
  • +
      +
    • (targetDSN: string): Promise<boolean>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        targetDSN: string
        +
      • +
      +

      Returns Promise<boolean>

      +
    • +
    +
  • +
+
+
+
+ +

Optional replace

+
replace: boolean
+ +
+
+

Replace option

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional targetDataClass

+
targetDataClass: string
+ +
+
+

Target data class

+
+
+
+
+ +

Optional targetManagementClass

+
targetManagementClass: string
+ +
+
+

Target management class

+
+
+
+
+ +

Optional targetStorageClass

+
targetStorageClass: string
+ +
+
+

Target storage class

+
+
+
+
+ +

Optional targetVolser

+
targetVolser: string
+ +
+
+

Target volser

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idataset.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idataset.html new file mode 100644 index 0000000000..01c88ce57f --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idataset.html @@ -0,0 +1,267 @@ + + + + + + IDataSet | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDataSet

+
+
+
+
+
+
+
+
+
+

Interface for data sets

+
+
+
export
+
+
+
+
+
+

Hierarchy

+
    +
  • + IDataSet +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

dsn

+
dsn: string
+ +
+
+

The name of the data set

+
+
+
+
+ +

Optional member

+
member: string
+ +
+
+

The name of the member

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ideletedatasetoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ideletedatasetoptions.html new file mode 100644 index 0000000000..67796f58dd --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ideletedatasetoptions.html @@ -0,0 +1,269 @@ + + + + + + IDeleteDatasetOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDeleteDatasetOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the options that can be sent into the delete data set function.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional volume

+
volume: string
+ +
+
+

The volume where the data set resides.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ideleteoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ideleteoptions.html new file mode 100644 index 0000000000..e0e1e31a68 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ideleteoptions.html @@ -0,0 +1,291 @@ + + + + + + IDeleteOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDeleteOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the options that can be sent into the delete data set function.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional purge

+
purge: boolean
+ +
+
+

If true then the function uses the PURGE=YES on ARCHDEL request. + If false (default) the function uses the PURGE=NO on ARCHDEL request.

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional wait

+
wait: boolean
+ +
+
+

If true then the function waits for completion of the request. + If false (default) the request is queued.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamoptions.html new file mode 100644 index 0000000000..3697fec38b --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamoptions.html @@ -0,0 +1,291 @@ + + + + + + IDeleteVsamOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDeleteVsamOptions

+
+
+
+
+
+
+
+
+
+

This interface defines a few optional options that can be sent on a VSAM + delete operation.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional erase

+
erase: boolean
+ +
+
+

Specifies the data component of a cluster is to be + overwritten with binary zeros when the cluster is deleted.

+
+
+
+
+ +

Optional purge

+
purge: boolean
+ +
+
+

Specifies the entry is to be deleted even if the retention period, + specified in the TO or FOR operand, has not expired.

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamresponse.html new file mode 100644 index 0000000000..bfa5b20cbb --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ideletevsamresponse.html @@ -0,0 +1,312 @@ + + + + + + IDeleteVsamResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDeleteVsamResponse

+
+
+
+
+
+
+
+
+
+

This interface defines the response type of Delete.vsam

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

apiResponse

+
apiResponse: IZosFilesResponse
+ +
+
+

Delete VSAM calls the invoke api, which returns an IZosFilesResponse + object. So the api response will be set to that return object.

+
+
+
+
+ +

commandResponse

+
commandResponse: string
+ +
+
+

Relevant information about the performed file operation.

+
+
+
+
+ +

Optional errorMessage

+
errorMessage: string
+ +
+
+

The error message text. + If not defined, the command response will be used.

+
+
+
+
+ +

success

+
success: boolean
+ +
+
+

Indicates the success of retrieving specified file information.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idownloaddsmresult.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idownloaddsmresult.html new file mode 100644 index 0000000000..0c144a977e --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idownloaddsmresult.html @@ -0,0 +1,318 @@ + + + + + + IDownloadDsmResult | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDownloadDsmResult

+
+
+
+
+
+
+
+
+
+

This interface defines results of the download data sets matching command.

+
+
+
export
+
+
interface
+

IDownloadDsmResult

+
+
+
+
+
+

Hierarchy

+
    +
  • + IDownloadDsmResult +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

downloaded

+
downloaded: string[]
+ +
+
+

List of data set names that have downloaded successfully.

+
+
+
+
+ +

failedArchived

+
failedArchived: string[]
+ +
+
+

List of data set names that failed to download because they are archived.

+
+
+
+
+ +

failedUnsupported

+
failedUnsupported: string[]
+ +
+
+

List of data set names that failed to download because they are an + unsupported type.

+
+
+
+
+ +

failedWithErrors

+
failedWithErrors: {}
+ +
+
+

Object containing key-value pairs of data set names and errors for data + sets that failed to download.

+
+
+
+

Type declaration

+
    +
  • +
    [key: string]: Error
    +
  • +
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idownloadoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idownloadoptions.html new file mode 100644 index 0000000000..365b614b09 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idownloadoptions.html @@ -0,0 +1,373 @@ + + + + + + IDownloadOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDownloadOptions

+
+
+
+
+
+
+
+
+
+

This interface defines options for downloading multiple data sets or USS files

+
+
+
+
+

Hierarchy

+
    +
  • + {} +
      +
    • + IDownloadOptions +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional attributes

+
attributes: ZosFilesAttributes
+ +
+
+

The path to a .zosattributes file used to control file conversion and tagging.

+
+
+
+
+ +

Optional excludePatterns

+
excludePatterns: string[]
+ +
+
+

Exclude data sets that match these DSLEVEL patterns. Any data sets that match + this pattern will not be downloaded

+
+
+
example
+

"ibmuser.*.jcl, ibmuser.rexa."

+
+
deprecated
+

Use the List.dataSetsMatchingPattern API to match data sets and exclude patterns

+
+
+
+
+
+ +

Optional extensionMap

+
extensionMap: {}
+ +
+
+

Map data set names that match your pattern to the desired extension

+
+
+
example
+

cpgm=c,asmpgm=asm

+
+
+
+
+

Type declaration

+
    +
  • +
    [key: string]: string
    +
  • +
+
+
+
+ +

Optional failFast

+
failFast: boolean
+ +
+
+

Indicates if a download operation for multiple files/data sets should fail as soon as the first failure happens. + If set to true, the first failure will throw an error and abort the download operation. + If set to false, individual download failures will be reported after all other downloads have completed. + The default value is true for backward compatibility.

+
+
+
+
+ +

Optional includeHidden

+
includeHidden: boolean
+ +
+
+

Specifies whether hidden files whose names begin with a dot should be downloaded.

+
+
+
+
+ +

Optional maxConcurrentRequests

+
maxConcurrentRequests: number
+ +
+
+

The maximum REST requests to perform at once + Increasing this value results in faster downloads but increases resource consumption + on z/OS and risks encountering an error caused + by making too many requests at once. + Default: 1

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html new file mode 100644 index 0000000000..0328848d4b --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idownloadsingleoptions.html @@ -0,0 +1,557 @@ + + + + + + IDownloadSingleOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDownloadSingleOptions

+
+
+
+
+
+
+
+
+
+

This interface defines options for downloading a single data set or USS file

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional binary

+
binary: boolean
+ +
+
+

The indicator to view the data set or USS file in binary mode + Has priority over record for datasets + If binary and record are both specified, binary is used

+
+
+
+
+ +

Optional directory

+
directory: string
+ +
+
+

The local directory to download all members from a pds

+
+
+
example
+

"./path/to/dir"

+
+
+
+
+
+ +

Optional encoding

+
encoding: string
+ +
+
+

Code page encoding

+
+
+
+
+ +

Optional extension

+
extension: string
+ +
+
+

The extension you want to use for the file

+
+
+
example
+

.txt

+
+
example
+

.c

+
+
+
+
+
+ +

Optional file

+
file: string
+ +
+
+

The local file to download the data set to

+
+
+
example
+

"./path/to/file.txt"

+
+
+
+
+
+ +

Optional localEncoding

+
localEncoding: string
+ +
+
+

The local file encoding to pass as a "Content-Type" header

+
+
+
+
+ +

Optional overwrite

+
overwrite: boolean
+ +
+
+

Specifies whether local files should be overwritten when downloaded.

+
+
+
+
+ +

Optional preserveOriginalLetterCase

+
preserveOriginalLetterCase: boolean
+ +
+
+

Indicates if the created directories and files use the original letter case, which is for data sets always uppercase. + The default value is false for backward compability. + If the option "directory" or "file" is provided, this option doesn't have any effect. + This option has only effect on automatically generated directories and files.

+
+
+
+
+ +

Optional range

+
range: string
+ +
+
+

Range of records to return

+
+
+
memberof
+

IGetOptions

+
+
+
+
+
+ +

Optional record

+
record: boolean
+ +
+
+

The indicator to view the data set in record mode + Should not be specified for USS files + If binary and record are both specified, binary is used

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional returnEtag

+
returnEtag: boolean
+ +
+
+

The indicator to force return of ETag. + If set to 'true' it forces the response to include an "ETag" header, regardless of the size of the response data. + If it is not present, the the default is to only send an Etag for data sets smaller than a system determined length, + which is at least 8MB.

+
+
+
+
+ +

Optional stream

+
stream: Writable
+ +
+
+

Optional stream to read the file contents

+
+
+
+
+ +

Optional task

+ + +
+
+

Task status object used by CLI handlers to create progress bars + Optional

+
+
+
+
+ +

Optional volume

+
volume: string
+ +
+
+

The volume on which the data set is stored

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idownloadussdirresult.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idownloadussdirresult.html new file mode 100644 index 0000000000..8c28e53a05 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idownloadussdirresult.html @@ -0,0 +1,297 @@ + + + + + + IDownloadUssDirResult | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDownloadUssDirResult

+
+
+
+
+
+
+
+
+
+

This interface defines results of the download dir-from-uss command.

+
+
+
export
+
+
interface
+

IDownloadUssDirResult

+
+
+
+
+
+

Hierarchy

+
    +
  • + IDownloadUssDirResult +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

downloaded

+
downloaded: string[]
+ +
+
+

List of file names that have downloaded successfully.

+
+
+
+
+ +

failedWithErrors

+
failedWithErrors: {}
+ +
+
+

Object containing key-value pairs of files and errors for uss files that failed to download.

+
+
+
+

Type declaration

+
    +
  • +
    [key: string]: Error
    +
  • +
+
+
+
+ +

skippedExisting

+
skippedExisting: string[]
+ +
+
+

List of file names that were not downloaded because they already existed on the system.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idsmlistoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idsmlistoptions.html new file mode 100644 index 0000000000..5b68b36adf --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.idsmlistoptions.html @@ -0,0 +1,318 @@ + + + + + + IDsmListOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDsmListOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the options that can be sent into the list data sets matching function

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional excludePatterns

+
excludePatterns: string[]
+ +
+
+

Exclude data sets that match these DSLEVEL patterns. Any data sets that match + this pattern will not be listed

+
+
+
example
+

"ibmuser.*.jcl, ibmuser.rexa."

+
+
+
+
+
+ +

Optional maxConcurrentRequests

+
maxConcurrentRequests: number
+ +
+
+

The maximum REST requests to perform at once + Increasing this value results in faster requests but increases resource consumption + on z/OS and risks encountering an error caused + by making too many requests at once. + Default: 1

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional task

+ + +
+
+

Task status object used by CLI handlers to create progress bars + Optional

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ifsoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ifsoptions.html new file mode 100644 index 0000000000..189e17e329 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ifsoptions.html @@ -0,0 +1,307 @@ + + + + + + IFsOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IFsOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the options that can be sent into the zfs function

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional fsname

+
fsname: string
+ +
+
+

Specifies the name of the mounted file system

+
+
+
+
+ +

Optional maxLength

+
maxLength: number
+ +
+
+

Specifies the maximum number of items to return

+
+
+
+
+ +

Optional path

+
path: string
+ +
+
+

Specifies the path where the file system is mounted

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.igetoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.igetoptions.html new file mode 100644 index 0000000000..7713cb4bbb --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.igetoptions.html @@ -0,0 +1,411 @@ + + + + + + IGetOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IGetOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the options that can be sent to get a data set or USS file function

+
+
+
export
+
+
interface
+

IGetOptions

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional binary

+
binary: boolean
+ +
+
+

The indicator to view the data set or USS file in binary mode + Has priority over record for datasets + If binary and record are both specified, binary is used

+
+
+
+
+ +

Optional encoding

+
encoding: string
+ +
+
+

Code page encoding

+
+
+
+
+ +

Optional localEncoding

+
localEncoding: string
+ +
+
+

The local file encoding to pass as a "Content-Type" header

+
+
+
+
+ +

Optional range

+
range: string
+ +
+
+

Range of records to return

+
+
+
memberof
+

IGetOptions

+
+
+
+
+
+ +

Optional record

+
record: boolean
+ +
+
+

The indicator to view the data set in record mode + Should not be specified for USS files + If binary and record are both specified, binary is used

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional task

+ + +
+
+

Task status object used by CLI handlers to create progress bars + Optional

+
+
+
+
+ +

Optional volume

+
volume: string
+ +
+
+

The volume on which the data set is stored

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ilistoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ilistoptions.html new file mode 100644 index 0000000000..6ee9324e2a --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ilistoptions.html @@ -0,0 +1,364 @@ + + + + + + IListOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IListOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the options that can be sent into the dwanload data set function

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional attributes

+
attributes: boolean
+ +
+
+

The indicator that we want to show more attributes

+
+
+
+
+ +

Optional maxLength

+
maxLength: number
+ +
+
+

The indicator that we want to show less data sets or members

+
+
+
+
+ +

Optional pattern

+
pattern: string
+ +
+
+

An optional pattern for restricting the response list

+
+
+
+
+ +

Optional recall

+ + +
+
+

An optional parameter that specifies how to handle migrated data sets

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional start

+
start: string
+ +
+
+

An optional search parameter that specifies the first data set name to return in the response document

+
+
+
+
+ +

Optional volume

+
volume: string
+ +
+
+

The volume where the data set resides

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.imigrateoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.imigrateoptions.html new file mode 100644 index 0000000000..bbf928991e --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.imigrateoptions.html @@ -0,0 +1,275 @@ + + + + + + IMigrateOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IMigrateOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the options that can be sent into the migrate data set function.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional wait

+
wait: boolean
+ +
+
+

If true then the function waits for completion of the request. + If false (default) the request is queued.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.imountfsoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.imountfsoptions.html new file mode 100644 index 0000000000..9973443cb2 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.imountfsoptions.html @@ -0,0 +1,295 @@ + + + + + + IMountFsOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IMountFsOptions

+
+
+
+
+
+
+
+
+
+

Interface for the options to the mount file-system API.

+
+
+
export
+
+
interface
+

IMountFsOptions

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional fs-type

+
fs-type: string
+ +
+
+

The file system type to mount

+
+
+
+
+ +

Optional mode

+ + +
+
+

The mode for mounting the file system

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ioptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ioptions.html new file mode 100644 index 0000000000..a97bc0be5d --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ioptions.html @@ -0,0 +1,384 @@ + + + + + + IOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the options that can be sent to get a data set or USS file function

+
+
+
export
+
+
interface
+

IOptions

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional binary

+
binary: boolean
+ +
+
+

The indicator to view the data set or USS file in binary mode + Has priority over record for datasets + If binary and record are both specified, binary is used

+
+
+
+
+ +

Optional encoding

+
encoding: string
+ +
+
+

Code page encoding

+
+
+
+
+ +

Optional localEncoding

+
localEncoding: string
+ +
+
+

The local file encoding to pass as a "Content-Type" header

+
+
+
+
+ +

Optional record

+
record: boolean
+ +
+
+

The indicator to view the data set in record mode + Should not be specified for USS files + If binary and record are both specified, binary is used

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional task

+ + +
+
+

Task status object used by CLI handlers to create progress bars + Optional

+
+
+
+
+ +

Optional volume

+
volume: string
+ +
+
+

The volume on which the data set is stored

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html new file mode 100644 index 0000000000..6d95f6a068 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.ioptionsfullresponse.html @@ -0,0 +1,450 @@ + + + + + + IOptionsFullResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IOptionsFullResponse

+
+
+
+
+
+
+
+
+
+

Interface to define input options for RestClient GET|POST|PUT|DELETE ExpectFullResponse methods

+
+
+
export
+
+
interface
+

IOptionsFullResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IOptionsFullResponse +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional dataToReturn

+
dataToReturn: CLIENT_PROPERTY[]
+ +
+
+

List of properties to return from REST call

+
+
+
memberof
+

IFullResponseOptions

+
+
+
+
+
+ +

Optional normalizeRequestNewLines

+
normalizeRequestNewLines: boolean
+ +
+
+

true if you want \r\n to be replaced with \n when sending + data to the server from requestStream. Don't set this for binary requests

+
+
+
memberof
+

IOptionsFullResponse

+
+
+
+
+
+ +

Optional normalizeResponseNewLines

+
normalizeResponseNewLines: boolean
+ +
+
+

true if you want newlines to be \r\n on windows + when receiving data from the server to responseStream. Don't set this for binary responses

+
+
+
memberof
+

IOptionsFullResponse

+
+
+
+
+
+ +

Optional reqHeaders

+
reqHeaders: any[]
+ +
+
+

Headers to include with request

+
+
+
memberof
+

IOptionsFullResponse

+
+
+
+
+
+ +

Optional requestStream

+
requestStream: Readable
+ +
+
+

Stream for outgoing request data to the server

+
+
+
memberof
+

IOptionsFullResponse

+
+
+
+
+
+ +

resource

+
resource: string
+ +
+
+

URI for this request

+
+
+
memberof
+

IOptionsFullResponse

+
+
+
+
+
+ +

Optional responseStream

+
responseStream: Writable
+ +
+
+

Stream for incoming response data from the server. If specified, response data will not be buffered

+
+
+
memberof
+

IOptionsFullResponse

+
+
+
+
+
+ +

Optional task

+ + +
+
+

Task that will automatically be updated to report progress of upload or download to user

+
+
+
memberof
+

IOptionsFullResponse

+
+
+
+
+
+ +

Optional writeData

+
writeData: any
+ +
+
+

Data to write on this REST request

+
+
+
memberof
+

IOptionsFullResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.irestclientresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.irestclientresponse.html new file mode 100644 index 0000000000..7b371410cb --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.irestclientresponse.html @@ -0,0 +1,401 @@ + + + + + + IRestClientResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IRestClientResponse

+
+
+
+
+
+
+
+
+
+

Interface to map client's REST call response

+
+
+
export
+
+
interface
+

IRestClientResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IRestClientResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional data

+
data: Buffer
+ +
+
+

Http(s) response body as a buffer

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+ +

Optional dataString

+
dataString: string
+ +
+
+

Http(s) response body as a string

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+ +

Optional log

+
log: Logger
+ +
+
+

Logger object

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+ +

Optional requestFailure

+
requestFailure: boolean
+ +
+
+

Status whether or not a REST request was successful by HTTP status code + Reverse of requestSuccess

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+ +

Optional requestSuccess

+
requestSuccess: boolean
+ +
+
+

Status whether or not a REST request was successful by HTTP status code

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+ +

Optional response

+
response: any
+ +
+
+

Http(s) response object

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+ +

Optional session

+
session: Session
+ +
+
+

Session object

+
+
+
memberof
+

IRestClientResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploaddir.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploaddir.html new file mode 100644 index 0000000000..20e298f095 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploaddir.html @@ -0,0 +1,263 @@ + + + + + + IUploadDir | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IUploadDir

+
+
+
+
+
+
+
+
+
+

This interface defines the map option that can be sent into the upload uss directory function

+
+
+
+
+

Hierarchy

+
    +
  • + IUploadDir +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

dirName

+
dirName: string
+ +
+
+

directory name

+
+
+
+
+ +

fullPath

+
fullPath: string
+ +
+
+

full path specification (on local host)

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploadfile.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploadfile.html new file mode 100644 index 0000000000..961f0e8d23 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploadfile.html @@ -0,0 +1,263 @@ + + + + + + IUploadFile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IUploadFile

+
+
+
+
+
+
+
+
+
+

This interface defines the map option that can be sent into the upload uss directory function

+
+
+
+
+

Hierarchy

+
    +
  • + IUploadFile +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

binary

+
binary: boolean
+ +
+
+

The indicator to upload the data set in binary mode

+
+
+
+
+ +

fileName

+
fileName: string
+ +
+
+

File name to be uploaded in binary or ascii

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploadmap.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploadmap.html new file mode 100644 index 0000000000..6a3ce5299a --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploadmap.html @@ -0,0 +1,263 @@ + + + + + + IUploadMap | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IUploadMap

+
+
+
+
+
+
+
+
+
+

This interface defines the map option that can be sent into the upload uss directory function

+
+
+
+
+

Hierarchy

+
    +
  • + IUploadMap +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional binary

+
binary: boolean
+ +
+
+

The indicator to upload the data set in binary mode

+
+
+
+
+ +

fileNames

+
fileNames: string[]
+ +
+
+

List of file names to be uploaded in binary or asci

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html new file mode 100644 index 0000000000..2d01e6606a --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploadoptions.html @@ -0,0 +1,578 @@ + + + + + + IUploadOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IUploadOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the options that can be sent into the upload data set function

+
+
+
+
+

Hierarchy

+
    +
  • + IOptions +
      +
    • + IUploadOptions +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional ascii_files

+
ascii_files: string
+ +
+
+

The list of files to be uploaded in ASCII mode

+
+
+
+
+ +

Optional attributes

+
attributes: ZosFilesAttributes
+ +
+
+

The ZosFilesAttributes instance describe upload attributes for the files and directories

+
+
+
+
+ +

Optional binary

+
binary: boolean
+ +
+
+

The indicator to view the data set or USS file in binary mode + Has priority over record for datasets + If binary and record are both specified, binary is used

+
+
+
+
+ +

Optional binary_files

+
binary_files: string
+ +
+
+

The list of files to be uploaded in binary mode

+
+
+
+
+ +

Optional encoding

+
encoding: string
+ +
+
+

Code page encoding

+
+
+
+
+ +

Optional etag

+
etag: string
+ +
+
+

Etag value to pass to z/OSMF API request. + It is used to check if the file was modified on target system before it is updated.

+
+
+
+
+ +

Optional filesMap

+
filesMap: IUploadMap
+ +
+
+

The map of files and their upload mode to be used for binary_files and ascii_files

+
+
+
+
+ +

Optional includeHidden

+
includeHidden: boolean
+ +
+
+

Specifies whether hidden files whose names begin with a dot should be uploaded.

+
+
+
+
+ +

Optional localEncoding

+
localEncoding: string
+ +
+
+

The local file encoding to pass as a "Content-Type" header

+
+
+
+
+ +

Optional maxConcurrentRequests

+
maxConcurrentRequests: number
+ +
+
+

The maximum REST requests to perform at once + Increasing this value results in faster uploads but increases resource consumption + on z/OS and risks encountering an error caused + by making too many requests at once. + Default: 1

+
+
+
+
+ +

Optional recall

+
recall: string
+ +
+
+

The migrated recall option

+
+
+
example
+

"wait, nowait, error"

+
+
+
+
+
+ +

Optional record

+
record: boolean
+ +
+
+

The indicator to view the data set in record mode + Should not be specified for USS files + If binary and record are both specified, binary is used

+
+
+
+
+ +

Optional recursive

+
recursive: boolean
+ +
+
+

The indicator to upload the directories recursively

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional returnEtag

+
returnEtag: boolean
+ +
+
+

The indicator to force return of ETag. + If set to 'true' it forces the response to include an "ETag" header, regardless of the size of the response data. + If it is not present, the the default is to only send an Etag for data sets smaller than a system determined length, + which is at least 8MB.

+
+
+
+
+ +

Optional task

+ + +
+
+

Task status object used by CLI handlers to create progress bars + Optional

+
+
+
+
+ +

Optional volume

+
volume: string
+ +
+
+

The volume on which the data set is stored

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploadresult.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploadresult.html new file mode 100644 index 0000000000..b7fff81080 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iuploadresult.html @@ -0,0 +1,313 @@ + + + + + + IUploadResult | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IUploadResult

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IUploadResult +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional error

+
error: any
+ +
+
+

Optional, any error encounter while uploading the data

+
+
+
+
+ +

Optional etag

+
etag: string
+ +
+
+

Optional, etag set when writing the file

+
+
+
+
+ +

from

+
from: string
+ +
+
+

Name of input file

+
+
+
+
+ +

success

+
success: boolean
+ +
+
+

Upload status

+
+
+
+
+ +

to

+
to: string
+ +
+
+

Name of data set

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iussfilelistresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iussfilelistresponse.html new file mode 100644 index 0000000000..a92c9f439e --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iussfilelistresponse.html @@ -0,0 +1,339 @@ + + + + + + IUSSFileListResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IUSSFileListResponse

+
+
+
+
+
+
+
+
+
+

This interface defines the information that is stored in the download data set API return object

+
+
+
+
+

Hierarchy

+
    +
  • + IUSSFileListResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional gid

+
gid: string
+ +
+
+

The type of the dataset

+
+
+
+
+ +

Optional mode

+
mode: string
+ +
+
+

The block size of the dataset

+
+
+
+
+ +

name

+
name: string
+ +
+
+

The name of the dataset

+
+
+
+
+ +

Optional size

+
size: string
+ +
+
+

The catalog in which the dataset entry is stored

+
+
+
+
+ +

Optional uid

+
uid: string
+ +
+
+

The dataset creation date

+
+
+
+
+ +

Optional user

+
user: string
+ +
+
+

The type of the device the dataset is stored on

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html new file mode 100644 index 0000000000..869e7ecd69 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.iusslistoptions.html @@ -0,0 +1,468 @@ + + + + + + IUSSListOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IUSSListOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the options that can be sent into the USS list files function

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional depth

+
depth: number
+ +
+
+

The depth of the directory structure to list files and directories for

+
+
+
+
+ +

Optional filesys

+
filesys: boolean
+ +
+
+

Whether or not to search all filesystems under the path, or just the same filesystem as the path + True means search all + False means search same

+
+
+
+
+ +

Optional group

+
group: number | string
+ +
+
+

The group owner or GID to filter

+
+
+
+
+ +

Optional maxLength

+
maxLength: number
+ +
+
+

The indicator that we want to show less files

+
+
+
+
+ +

Optional mtime

+
mtime: number | string
+ +
+
+

The modification time to filter, in days + Valid values are either an integer, or an integer with leading plus (+) or minus (-)

+
+
+
+
+ +

Optional name

+
name: string
+ +
+
+

The name of the file or directory to filter

+
+
+
+
+ +

Optional perm

+
perm: string
+ +
+
+

The permission octal mask to use + The type is a string because valid values are either an integer, or an integer with a leading minus (-)

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional size

+
size: number | string
+ +
+
+

The size to filter + Valid values are either an integer, and integer with a suffix (K, M, G), + or an integer with leading plus (+) or minus (-)

+
+
+
+
+ +

Optional symlinks

+
symlinks: boolean
+ +
+
+

Whether to follow symlinks, or report them + True means to report + False means to follow

+
+
+
+
+ +

Optional type

+
type: string
+ +
+
+

The type of file to filter for + Allowed values are: c - character special file, d - directory, f - file, l - symbolic link, p - FIFO (named pipe), and s - socket

+
+
+
+
+ +

Optional user

+
user: number | string
+ +
+
+

The user name or UID to filter

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesoptions.html new file mode 100644 index 0000000000..8163d18712 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesoptions.html @@ -0,0 +1,298 @@ + + + + + + IZosFilesOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosFilesOptions

+
+
+
+
+
+
+
+
+
+

This interface defines the global options that apply to all zosfiles APIs

+
+
+
export
+
+
interface
+

IZosFilesOptions

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesresponse.html new file mode 100644 index 0000000000..46a07e686c --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.izosfilesresponse.html @@ -0,0 +1,311 @@ + + + + + + IZosFilesResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosFilesResponse

+
+
+
+
+
+
+
+
+
+

The ZosFiles API response.

+
+
+
export
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional apiResponse

+
apiResponse: any
+ +
+
+

The api response object, housing any returned header information.

+
+
+
+
+ +

commandResponse

+
commandResponse: string
+ +
+
+

Relevant information about the performed file operation.

+
+
+
+
+ +

Optional errorMessage

+
errorMessage: string
+ +
+
+

The error message text. + If not defined, the command response will be used.

+
+
+
+
+ +

success

+
success: boolean
+ +
+
+

Indicates the success of retrieving specified file information.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html new file mode 100644 index 0000000000..3f4af0471e --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_files_for_zowe_sdk.izosmflistresponse.html @@ -0,0 +1,611 @@ + + + + + + IZosmfListResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosmfListResponse

+
+
+
+
+
+
+
+
+
+

This interface defines the information that is stored in the download data set API return object

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional blksz

+
blksz: string
+ +
+
+

The block size of the dataset

+
+
+
+
+ +

Optional catnm

+
catnm: string
+ +
+
+

The catalog in which the dataset entry is stored

+
+
+
+
+ +

Optional cdate

+
cdate: string
+ +
+
+

The dataset creation date

+
+
+
+
+ +

Optional dev

+
dev: string
+ +
+
+

The type of the device the dataset is stored on

+
+
+
+
+ +

dsname

+
dsname: string
+ +
+
+

The name of the dataset

+
+
+
+
+ +

Optional dsntp

+
dsntp: string
+ +
+
+

The type of the dataset

+
+
+
+
+ +

Optional dsorg

+
dsorg: string
+ +
+
+

The organization of the data set as physical sequential (PS), partitioned (PO), or direct (DA)

+
+
+
+
+ +

Optional edate

+
edate: string
+ +
+
+

The dataset expiration date

+
+
+
+
+ +

Optional extx

+
extx: string
+ +
+
+

The number of extensions the dataset has

+
+
+
+
+ +

Optional lrecl

+
lrecl: string
+ +
+
+

The length, in bytes, of each record in the data set

+
+
+
+
+ +

Optional migr

+
migr: string
+ +
+
+

Indicates if automatic migration to a lower level of storage is active for this dataset

+
+
+
+
+ +

Optional mvol

+
mvol: string
+ +
+
+

Indicates if the dataset is multivolume

+
+
+
+
+ +

Optional ovf

+
ovf: string
+ +
+
+

Open virtualization format

+
+
+
+
+ +

Optional rdate

+
rdate: string
+ +
+
+

The date of the last time the dataset was referred to

+
+
+
+
+ +

Optional recfm

+
recfm: string
+ +
+
+

The record format of the dataset

+
+
+
+
+ +

Optional responseTimeout

+
responseTimeout: number
+ +
+
+

The maximum amount of time for the TSO servlet to wait for a response before returning an error

+
+
+
+
+ +

Optional sizex

+
sizex: string
+ +
+
+

The size of the first extent in tracks

+
+
+
+
+ +

Optional spacu

+
spacu: string
+ +
+
+

The type of space units measurement

+
+
+
+
+ +

Optional used

+
used: string
+ +
+
+

The percentage of used space in the dataset

+
+
+
+
+ +

vol

+
vol: string
+ +
+
+

The volume name on which the dataset is stored

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljob.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljob.html new file mode 100644 index 0000000000..bc9c969911 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljob.html @@ -0,0 +1,397 @@ + + + + + + ICancelJob | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICancelJob

+
+
+
+
+
+
+
+
+
+

Interface for payload to cancel a job.

+
+
+
export
+
+
interface
+

ICancelJob

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICancelJob +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

request

+
request: string
+ +
+
+

"cancel" is currently the only valid value

+
+
+
memberof
+

ICancelJob

+
+
+
+
+
+ +

version

+
version: string
+ +
+
+

Version, at the time of writing, 1.0 or 2.0 are accepted.

+
+
+
memberof
+

ICancelJob

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljobparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljobparms.html new file mode 100644 index 0000000000..ed8b10b653 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.icanceljobparms.html @@ -0,0 +1,421 @@ + + + + + + ICancelJobParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICancelJobParms

+
+
+
+
+
+
+
+
+
+

Interface for cancel job z/OSMF API

+
+
+
export
+
+
interface
+

ICancelJobParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICancelJobParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

jobid

+
jobid: string
+ +
+
+

job id for the job you want to cancel

+
+
+
memberof
+

ICancelJobParms

+
+
+
+
+
+ +

jobname

+
jobname: string
+ +
+
+

job name for the job you want to cancel

+
+
+
memberof
+

ICancelJobParms

+
+
+
+
+
+ +

Optional version

+
version: string
+ +
+
+

version of the cancel request

+
+
+
memberof
+

ICancelJobParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.icommonjobparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.icommonjobparms.html new file mode 100644 index 0000000000..2adea0fd2a --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.icommonjobparms.html @@ -0,0 +1,397 @@ + + + + + + ICommonJobParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICommonJobParms

+
+
+
+
+
+
+
+
+
+

Interface for various job APIs

+
+
+
export
+
+
interface
+

ICommonJobParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICommonJobParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

jobid

+
jobid: string
+ +
+
+

job id for a job

+
+
+
memberof
+

ICommonJobParms

+
+
+
+
+
+ +

jobname

+
jobname: string
+ +
+
+

job name for a job

+
+
+
memberof
+

ICommonJobParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ideletejobparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ideletejobparms.html new file mode 100644 index 0000000000..0a97a3a289 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ideletejobparms.html @@ -0,0 +1,424 @@ + + + + + + IDeleteJobParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDeleteJobParms

+
+
+
+
+
+
+
+
+
+

Interface for delete job (cancel and purge) z/OSMF API

+
+
+
export
+
+
interface
+

IDeleteJobParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IDeleteJobParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

jobid

+
jobid: string
+ +
+
+

job id for the job you want to delete

+
+
+
memberof
+

IDeleteJobParms

+
+
+
+
+
+ +

jobname

+
jobname: string
+ +
+
+

job name for the job you want to delete

+
+
+
memberof
+

IDeleteJobParms

+
+
+
+
+
+ +

Optional modifyVersion

+
modifyVersion: "1.0" | "2.0"
+ +
+
+

Optional + Version of the X-IBM-Job-Modify-Version header to use (see ZosmfHeaders) + If omitted, functionality is the same as if specifying "1.0" - the deletion of the job is asynchronous + If "2.0" is specified, the cancel and purge is synchronous

+
+
+
memberof
+

IDeleteJobParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadallspoolcontentparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadallspoolcontentparms.html new file mode 100644 index 0000000000..17190855a2 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadallspoolcontentparms.html @@ -0,0 +1,523 @@ + + + + + + IDownloadAllSpoolContentParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDownloadAllSpoolContentParms

+
+
+
+
+
+
+
+
+
+

Interface for downloading all spool content with DownloadJobs API

+
+
+
export
+
+
interface
+

IDownloadAllSpoolContentParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IDownloadAllSpoolContentParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional binary

+
binary: boolean
+ +
+
+

If you specify true for this field, the file will be downloaded in binary mode

+
+
+
memberof
+

IDownloadSpoolContentParms

+
+
+
+
+
+ +

Optional extension

+
extension: string
+ +
+
+

The extension to use for the files. Defaults to .txt + e.g. .log

+
+
+
memberof
+

IDownloadAllSpoolContentParms

+
+
+
+
+
+ +

jobid

+
jobid: string
+ +
+
+

JOB ID of the job for which you want to download all output + e.g. JOB00001

+
+
+
memberof
+

IDownloadAllSpoolContentParms

+
+
+
+
+
+ +

jobname

+
jobname: string
+ +
+
+

Name of the job for which you want to download all output + e.g. MYJOBNM

+
+
+
memberof
+

IDownloadAllSpoolContentParms

+
+
+
+
+
+ +

Optional omitJobidDirectory

+
omitJobidDirectory: boolean
+ +
+
+

If you specify false or do not specify this field, a directory with the jobid of the job as the name + will automatically be appended to the outDir. + If you specify true, no directory will be appended to your outDir.

+
+
+
memberof
+

IDownloadAllSpoolContentParms

+
+
+
+
+
+ +

Optional outDir

+
outDir: string
+ +
+
+

The directory to which you would like to download the output + Default value: DownloadJobs.DEFAULT_JOBS_OUTPUT_DIR

+
+
+
memberof
+

IDownloadAllSpoolContentParms

+
+
+
+
+
+ +

Optional record

+
record: boolean
+ +
+
+

If you specify true for this field, the file will be downloaded in record mode

+
+
+
memberof
+

IDownloadSpoolContentParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadspoolcontentparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadspoolcontentparms.html new file mode 100644 index 0000000000..cfc4ae0646 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.idownloadspoolcontentparms.html @@ -0,0 +1,452 @@ + + + + + + IDownloadSpoolContentParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDownloadSpoolContentParms

+
+
+
+
+
+
+
+
+
+

Interface for downloading single spool file with DownloadJobs API

+
+
+
export
+
+
interface
+

IDownloadAllSpoolContentParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + {} +
      +
    • + IDownloadSpoolContentParms +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional jobFile

+
jobFile: IJobFile
+ +
+
+

Job file document for job output we want to download

+
+
+
memberof
+

IDownloadSpoolContentParms

+
+
+
+
+
+ +

Optional jobid

+
jobid: string
+ +
+
+

JOB ID of the job for which you want to download all output + e.g. JOB00001

+
+
+
memberof
+

IDownloadAllSpoolContentParms

+
+
+
+
+
+ +

Optional jobname

+
jobname: string
+ +
+
+

Name of the job for which you want to download all output + e.g. MYJOBNM

+
+
+
memberof
+

IDownloadAllSpoolContentParms

+
+
+
+
+
+ +

Optional stream

+
stream: Writable
+ +
+
+

Optional stream to read the spool contents

+
+
+
memberof
+

IDownloadAllSpoolContentParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.igetjobsparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.igetjobsparms.html new file mode 100644 index 0000000000..ff4f4e4cb7 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.igetjobsparms.html @@ -0,0 +1,497 @@ + + + + + + IGetJobsParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IGetJobsParms

+
+
+
+
+
+
+
+
+
+

Interface for various GetJobs APIs

+
+
+
export
+
+
interface
+

IGetJobsParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IGetJobsParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional execData

+
execData: boolean
+ +
+
+

Return execution data about jobs

+
+
+
memberof
+

IGetJobsParms

+
+
+
+
+
+ +

Optional jobid

+
jobid: string
+ +
+
+

job id for a job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

Optional maxJobs

+
maxJobs: number
+ +
+
+

Max jobs to return in a list + Default: JobsConstants.DEFAULT_MAX_JOBS

+
+
+
memberof
+

IGetJobsParms

+
+
+
+
+
+ +

Optional owner

+
owner: string
+ +
+
+

Owner for which to obtain jobs for. + Default: current user

+
+
+
memberof
+

IGetJobsParms

+
+
+
+
+
+ +

Optional prefix

+
prefix: string
+ +
+
+

Prefix to filter when obtaining jobs. + Default: *

+
+
+
memberof
+

IGetJobsParms

+
+
+
+
+
+ +

Optional status

+
status: string
+ +
+
+

Optional parameter to limit the returned data to only jobs that are currently active. This parameter is case-insensitive + Default: *

+
+
+
memberof
+

IGetJobsParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html new file mode 100644 index 0000000000..e828601567 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijob.html @@ -0,0 +1,713 @@ + + + + + + IJob | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IJob

+
+
+
+
+
+
+
+
+
+

Standard job response document + Represents the attributes and status of a z/OS batch job

+
+
+
export
+
+
interface
+

IJob

+
+
+
+
+
+

Hierarchy

+
    +
  • + IJob +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

class

+
class: string
+ +
+
+

job class

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

files-url

+
files-url: string
+ +
+
+

spool files url for direct reference

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

job-correlator

+
job-correlator: string
+ +
+
+

unique identifier of job (substitute of job name and job id) + If this value is null, the job was submitted to JES3.

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

jobid

+
jobid: string
+ +
+
+

job id for a job + Uniquely identifies a job on a z/OS system

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

jobname

+
jobname: string
+ +
+
+

job name for a job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

owner

+
owner: string
+ +
+
+

owner of the job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

phase

+
phase: number
+ +
+
+

job phase

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

phase-name

+
phase-name: string
+ +
+
+

job phase name

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

Optional reason-not-running

+
reason-not-running: string
+ +
+
+

explaination of error

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

retcode

+
retcode: string
+ +
+
+

return code of the job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

status

+
status: string
+ +
+
+

status of the job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

Optional step-data

+
step-data: IJobStepData[]
+ +
+
+

detailed job step data

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

subsystem

+
subsystem: string
+ +
+
+

The primary or secondary JES subsystem. + If this value is null, the job was processed by the primary subsystem.

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

type of job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

url

+
url: string
+ +
+
+

url for direct reference of job info

+
+
+
memberof
+

IJob

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html new file mode 100644 index 0000000000..05be909407 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobcomplete.html @@ -0,0 +1,565 @@ + + + + + + IJobComplete | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IJobComplete

+
+
+
+
+
+
+
+
+
+

Completed job interface

+
+
+
export
+
+
interface
+

IJobComplete

+
+
+
+
+
+

Hierarchy

+
    +
  • + IJobComplete +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

abend-code

+
abend-code: string
+ +
+
+

Abend code

+
+
+
memberof
+

IJobComplete

+
+
+
+
+
+ +

class

+
class: string
+ +
+
+

Job class

+
+
+
memberof
+

IJobComplete

+
+
+
+
+
+ +

completion-code

+
completion-code: number
+ +
+
+

Completion code

+
+
+
memberof
+

IJobComplete

+
+
+
+
+
+ +

completion-type

+
completion-type: number
+ +
+
+

Completion type

+
+
+
memberof
+

IJobComplete

+
+
+
+
+
+ +

job-correlator

+
job-correlator: string
+ +
+
+

unique identifier of job (substitute of job name and job id)

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

jobid

+
jobid: string
+ +
+
+

job id for a job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

jobname

+
jobname: string
+ +
+
+

job name for a job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

owner

+
owner: string
+ +
+
+

Job owner

+
+
+
memberof
+

IJobComplete

+
+
+
+
+
+ +

retcode

+
retcode: string
+ +
+
+

return code of the job

+
+
+
memberof
+

IJob

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijoberror.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijoberror.html new file mode 100644 index 0000000000..da157763b0 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijoberror.html @@ -0,0 +1,469 @@ + + + + + + IJobError | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IJobError

+
+
+
+
+
+
+
+
+
+

Job error interface

+
+
+
export
+
+
interface
+

IJobError

+
+
+
+
+
+

Hierarchy

+
    +
  • + IJobError +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

category

+
category: number
+ +
+
+

Category error number

+
+
+
memberof
+

IJobError

+
+
+
+
+
+ +

message

+
message: string
+ +
+
+

z/OSMF error message

+
+
+
memberof
+

IJobError

+
+
+
+
+
+ +

rc

+
rc: number
+ +
+
+

Return code number

+
+
+
memberof
+

IJobError

+
+
+
+
+
+ +

reason

+
reason: number
+ +
+
+

Reason code number

+
+
+
memberof
+

IJobError

+
+
+
+
+
+ +

stack

+
stack: string
+ +
+
+

Stack info

+
+
+
memberof
+

IJobError

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html new file mode 100644 index 0000000000..abf71dc85d --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfeedback.html @@ -0,0 +1,589 @@ + + + + + + IJobFeedback | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IJobFeedback

+
+
+
+
+
+
+
+
+
+

Job feedback interface

+
+
+
export
+
+
interface
+

IJobFeedback

+
+
+
+
+
+

Hierarchy

+
    +
  • + IJobFeedback +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

internal-code

+
internal-code: string
+ +
+
+

Internal code

+
+
+
memberof
+

IJobFeedback

+
+
+
+
+
+ +

job-correlator

+
job-correlator: string
+ +
+
+

unique identifier of job (substitute of job name and job id)

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

jobid

+
jobid: string
+ +
+
+

job id for a job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

jobname

+
jobname: string
+ +
+
+

job name for a job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

member

+
member: string
+ +
+
+

Member

+
+
+
memberof
+

IJobFeedback

+
+
+
+
+
+ +

message

+
message: string
+ +
+
+

Message

+
+
+
memberof
+

IJobFeedback

+
+
+
+
+
+ +

original-jobid

+
original-jobid: string
+ +
+
+

Original job id

+
+
+
memberof
+

IJobFeedback

+
+
+
+
+
+ +

owner

+
owner: string
+ +
+
+

Job owner

+
+
+
memberof
+

IJobComplete

+
+
+
+
+
+ +

status

+
status: string
+ +
+
+

status of the job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

sysname

+
sysname: string
+ +
+
+

System name

+
+
+
memberof
+

IJobFeedback

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html new file mode 100644 index 0000000000..08ed2eee71 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfile.html @@ -0,0 +1,691 @@ + + + + + + IJobFile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IJobFile

+
+
+
+
+
+
+
+
+
+

Interface for a job dd + Represents the name and details of an output (spool) DD + for a z/OS batch job

+
+
+
export
+
+
interface
+

IJobFile

+
+
+
+
+
+

Hierarchy

+
    +
  • + IJobFile +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

byte-count

+
byte-count: number
+ +
+
+

Total bytes in the spool file

+
+
+
memberof
+

IJobFile

+
+
+
+
+
+ +

class

+
class: string
+ +
+
+

Job class for which job ran

+
+
+
memberof
+

IJobFile

+
+
+
+
+
+ +

ddname

+
ddname: string
+ +
+
+

DD name of job spool file

+
+
+
memberof
+

IJobFileSimple

+
+
+
+
+
+ +

id

+
id: number
+ +
+
+

Identifier for this spool file. + each IJobFile for a single batch job will have a unique ID

+
+
+
memberof
+

IJobFileSimple

+
+
+
+
+
+ +

job-correlator

+
job-correlator: string
+ +
+
+

unique identifier of job (substitute of job name and job id)

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

jobid

+
jobid: string
+ +
+
+

job id for a job + Uniquely identifies a job on a z/OS system

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

jobname

+
jobname: string
+ +
+
+

job name for a job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

lrecl

+
lrecl: number
+ +
+
+

Job DD lrecl (logical record length - how many bytes each record is)

+
+
+
memberof
+

IJobFile

+
+
+
+
+
+ +

procstep

+
procstep: string
+ +
+
+

If this spool file was produced during a job procedure step, the + name of the step will be here.

+
+
+
memberof
+

IJobStepData

+
+
+
+
+
+ +

recfm

+
recfm: string
+ +
+
+

Record format of the spool file (DD)

+
+
+
memberof
+

IJobFile

+
+
+
+
+
+ +

record-count

+
record-count: number
+ +
+
+

Total records (roughly equivalent to lines) in the spool file

+
+
+
memberof
+

IJobFile

+
+
+
+
+
+ +

records-url

+
records-url: string
+ +
+
+

Direct access to job record content

+
+
+
memberof
+

IJobFile

+
+
+
+
+
+ +

stepname

+
stepname: string
+ +
+
+

The name of the job step during which this spool file was produced

+
+
+
memberof
+

IJobFileSimple

+
+
+
+
+
+ +

subsystem

+
subsystem: string
+ +
+
+

The primary or secondary JES subsystem. + If this value is null, the job was processed by the primary subsystem.

+
+
+
memberof
+

IJobFile

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfilesimple.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfilesimple.html new file mode 100644 index 0000000000..71bf70b327 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobfilesimple.html @@ -0,0 +1,447 @@ + + + + + + IJobFileSimple | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IJobFileSimple

+
+
+
+
+
+
+
+
+
+

Condensed job response interface + Simplified version of an IJob that can be used to + display job details to a user without providing too much detail.l

+
+
+
export
+
+
interface
+

IJobFileSimple

+
+
+
+
+
+

Hierarchy

+
    +
  • + IJobFileSimple +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

ddname

+
ddname: string
+ +
+
+

DD name of job spool file

+
+
+
memberof
+

IJobFileSimple

+
+
+
+
+
+ +

id

+
id: number
+ +
+
+

ID of job that was submitted

+
+
+
memberof
+

IJobFileSimple

+
+
+
+
+
+ +

record-count

+
record-count: number
+ +
+
+

Total records contained within the job dd

+
+
+
memberof
+

IJobFileSimple

+
+
+
+
+
+ +

stepname

+
stepname: string
+ +
+
+

Step for which job dd exists

+
+
+
memberof
+

IJobFileSimple

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobstepdata.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobstepdata.html new file mode 100644 index 0000000000..b76831cef1 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobstepdata.html @@ -0,0 +1,493 @@ + + + + + + IJobStepData | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IJobStepData

+
+
+
+
+
+
+
+
+
+

Step info on a job interface

+
+
+
export
+
+
interface
+

IJobStepData

+
+
+
+
+
+

Hierarchy

+
    +
  • + IJobStepData +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

active

+
active: string
+ +
+
+

ACtive

+
+
+
memberof
+

IJobStepData

+
+
+
+
+
+ +

proc-step-name

+
proc-step-name: string
+ +
+
+

Job relevant proc

+
+
+
memberof
+

IJobStepData

+
+
+
+
+
+ +

program-name

+
program-name: string
+ +
+
+

Program EXEC=

+
+
+
memberof
+

IJobStepData

+
+
+
+
+
+ +

smfid

+
smfid: string
+ +
+
+

smfid

+
+
+
memberof
+

IJobStepData

+
+
+
+
+
+ +

step-name

+
step-name: string
+ +
+
+

Step for which job dd exists

+
+
+
memberof
+

IJobFileSimple

+
+
+
+
+
+ +

step-number

+
step-number: number
+ +
+
+

Job relevant step

+
+
+
memberof
+

IJobStepData

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobsubmit.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobsubmit.html new file mode 100644 index 0000000000..2c95be220f --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ijobsubmit.html @@ -0,0 +1,445 @@ + + + + + + IJobSubmit | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IJobSubmit

+
+
+
+
+
+
+
+
+
+

Job interface for when a job is submitted

+
+
+
export
+
+
interface
+

IJobSubmit

+
+
+
+
+
+

Hierarchy

+
    +
  • + IJobSubmit +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

jobid

+
jobid: string
+ +
+
+

job id for a job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

jobname

+
jobname: string
+ +
+
+

job name for a job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

retcode

+
retcode: string
+ +
+
+

return code of the job

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

status

+
status: string
+ +
+
+

status of the job

+
+
+
memberof
+

IJob

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjob.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjob.html new file mode 100644 index 0000000000..02474a45b5 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjob.html @@ -0,0 +1,387 @@ + + + + + + IModifyJob | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IModifyJob

+
+
+
+
+
+
+
+
+
+

Interface for change job z/OSMF API

+
+
+
export
+
+
interface
+

IModifyJob

+
+
+
+
+
+

Hierarchy

+
    +
  • + IModifyJob +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional class

+
class: string
+ +
+
+

updated class for job

+
+
+
memberof
+

IModifyJob

+
+
+
+
+
+ +

Optional request

+
request: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjoboptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjoboptions.html new file mode 100644 index 0000000000..c0a999c90f --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjoboptions.html @@ -0,0 +1,421 @@ + + + + + + IModifyJobOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IModifyJobOptions

+
+
+
+
+
+
+
+
+
+

Interface for change job z/OSMF API

+
+
+
export
+
+
interface
+

IModifyJobOptions

+
+
+
+
+
+

Hierarchy

+
    +
  • + IModifyJobOptions +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional hold

+
hold: boolean
+ +
+
+

specify this option as true when wanting to hold your job

+
+
+
memberof
+

IModifyJobOptions

+
+
+
+
+
+ +

Optional jobclass

+
jobclass: string
+ +
+
+

new job class to change job to

+
+
+
memberof
+

IModifyJobOptions

+
+
+
+
+
+ +

Optional release

+
release: boolean
+ +
+
+

specify this option as true when wanting to release your job

+
+
+
memberof
+

IModifyJobOptions

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjobparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjobparms.html new file mode 100644 index 0000000000..80eb37b3c0 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.imodifyjobparms.html @@ -0,0 +1,397 @@ + + + + + + IModifyJobParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IModifyJobParms

+
+
+
+
+
+
+
+
+
+

Interface for change job z/OSMF API

+
+
+
export
+
+
interface
+

IModifyJobParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IModifyJobParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

jobid

+
jobid: string
+ +
+
+

job id for the job you want to change

+
+
+
memberof
+

IModifyJobParms

+
+
+
+
+
+ +

jobname

+
jobname: string
+ +
+
+

job name for the job you want to change

+
+
+
memberof
+

IModifyJobParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.imonitorjobwaitforparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.imonitorjobwaitforparms.html new file mode 100644 index 0000000000..fb4514f1cf --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.imonitorjobwaitforparms.html @@ -0,0 +1,497 @@ + + + + + + IMonitorJobWaitForParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IMonitorJobWaitForParms

+
+
+
+
+
+
+
+
+
+

MonitorJobs "waitFor..." APIs parameters interface

+
+
+
export
+
+
interface
+

IMonitorJobParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IMonitorJobWaitForParms +
  • +
+
+
+

Indexable

+
[key: string]: any
+
+
+

MonitorJobs "waitFor..." APIs parameters interface

+
+
+
export
+
+
interface
+

IMonitorJobParms

+
+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional attempts

+
attempts: number
+ +
+
+

Maximum number of poll attempts. Use in conjunction with "watchDelay" to specify your maximum wait + for the expected status. + Default: MonitorJobs.DEFAULT_ATTEMPTS.

+
+
+
memberof
+

IMonitorJobParms

+
+
+
+
+
+ +

jobid

+
jobid: string
+ +
+
+

The z/OS JOBID for the job to monitor. No pre-validation of the JOBID (other than its presence) is performed. + Any errors that you receive regarding invalid JOBID/JOBNAME will be surfaced by z/OSMF. Ensure that your + JOBID specification adheres to the z/OS standards.

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

jobname

+
jobname: string
+ +
+
+

The z/OS JOBNAME for the job to monitor. No pre-validation of the JOBNAME (other than its presence) is performed. + Any errors that you receive regarding invalid JOBID/JOBNAME will be surfaced by z/OSMF. Ensure that your + JOBNAME specification adheres to the z/OS standards.

+
+
+
memberof
+

IJob

+
+
+
+
+
+ +

Optional status

+
status: JOB_STATUS
+ +
+
+

The job status (see z/OSMF Jobs REST APIs documentation - and the JOB_STATUS type for possible options) to + wait for. Note that if the job's status is "further" along in the logical progression (see the JOB_STATUS + documentation for full details) the "waitFor..." API methods will return immediately with the current status. + Default: MonitorJobs.DEFAULT_STATUS.

+
+
+
memberof
+

IMonitorJobParms

+
+
+
+
+
+ +

Optional watchDelay

+
watchDelay: number
+ +
+
+

Watch delay is the polling delay in milliseconds. MonitorJobs will poll every "watchDelay" milliseconds for the + status of the job that is being monitored. Use in conjunction with "attempts" to specify your maximum wait + for the expected status. + Default: MonitorJobs.DEFAULT_WATCHER_DELAY

+
+
+
memberof
+

IMonitorJobParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ispoolfile.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ispoolfile.html new file mode 100644 index 0000000000..0f3ff22532 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.ispoolfile.html @@ -0,0 +1,445 @@ + + + + + + ISpoolFile | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISpoolFile

+
+
+
+
+
+
+
+
+
+

Interface of spool file.

+
+
+
export
+
+
interface
+

ISpoolFile

+
+
+
+
+
+

Hierarchy

+
    +
  • + ISpoolFile +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

data

+
data: string
+ +
+
+

Content of the spool file

+
+
+
+
+ +

ddName

+
ddName: string
+ +
+
+

DD name of job spool file

+
+
+
+
+ +

id

+
id: number
+ +
+
+

Identifier for this spool file.

+
+
+
+
+ +

procName

+
procName: string
+ +
+
+

If this spool file was produced during a job procedure step, the + name of the step will be here

+
+
+
+
+ +

stepName

+
stepName: string
+ +
+
+

The name of the job step during which this spool file was produced

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclnotifyparm.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclnotifyparm.html new file mode 100644 index 0000000000..3b32ebc706 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclnotifyparm.html @@ -0,0 +1,526 @@ + + + + + + ISubmitJclNotifyParm | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISubmitJclNotifyParm

+
+
+
+
+
+
+
+
+
+

Interface for submiting jobs API

+
+
+
export
+
+
interface
+

ISubmitJclNotifyParm

+
+
+
+
+
+

Hierarchy

+
    +
  • + ISubmitJclNotifyParm +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional attempts

+
attempts: number
+ +
+
+

Number of attempts for which will poll before ending. + Default: MonitorJobs.DEFAULT_ATTEMPTS.

+
+
+
memberof
+

ISubmitJclNotifyParm

+
+
+
+
+
+ +

Optional internalReaderLrecl

+
internalReaderLrecl: string
+ +
+
+

Specify internal reader LRECL and corresponding http(s) headers + will be appended to the request accordingly

+
+
+
memberof
+

ISubmitJclNotifyParm

+
+
+
+
+
+ +

Optional internalReaderRecfm

+
internalReaderRecfm: string
+ +
+
+

Specify internal reader RECFM and corresponding http(s) headers + will be appended to the request accordingly + "F" (fixed) or "V" (variable)

+
+
+
memberof
+

ISubmitJclNotifyParm

+
+
+
+
+
+ +

jcl

+
jcl: string
+ +
+
+

JCL to submit, for example: + "//IEFBR14 JOB ()\n" + + "//RUN EXEC PGM=IEFBR14"

+
+
+
memberof
+

ISubmitJclNotifyParm

+
+
+
+
+
+ +

Optional jclSymbols

+
jclSymbols: string
+ +
+
+

A string for JCL symbolic substitution

+
+
+
memberof
+

ISubmitJobParms

+
+
+
+
+
+ +

Optional status

+
status: JOB_STATUS
+ +
+
+

Status for which you'd like to be notified of a completed job. + Default: MonitorJobs.DEFAULT_STATUS.

+
+
+
memberof
+

ISubmitJclNotifyParm

+
+
+
+
+
+ +

Optional watchDelay

+
watchDelay: number
+ +
+
+

Watch delay (polling delay) that the underlying services will use + to report whenever a job is complete in milliseconds. + Default: MonitorJobs.DEFAULT_WATCHER_DELAY

+
+
+
memberof
+

ISubmitJclNotifyParm

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclparms.html new file mode 100644 index 0000000000..90a62ed6ce --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjclparms.html @@ -0,0 +1,450 @@ + + + + + + ISubmitJclParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISubmitJclParms

+
+
+
+
+
+
+
+
+
+

Interface for submit JCL APIs

+
+
+
export
+
+
interface
+

ISubmitJclParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + ISubmitJclParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional internalReaderLrecl

+
internalReaderLrecl: string
+ +
+
+

Specify internal reader LRECL and corresponding http(s) headers + will be appended to the request accordingly

+
+
+
memberof
+

ISubmitJclNotifyParm

+
+
+
+
+
+ +

Optional internalReaderRecfm

+
internalReaderRecfm: string
+ +
+
+

Specify internal reader RECFM and corresponding http(s) headers + will be appended to the request accordingly + "F" (fixed) or "V" (variable)

+
+
+
memberof
+

ISubmitJclNotifyParm

+
+
+
+
+
+ +

jcl

+
jcl: string
+ +
+
+

JCL to submit, for example: + "//IEFBR14 JOB ()\n" + + "//RUN EXEC PGM=IEFBR14"

+
+
+
memberof
+

ISubmitJclNotifyParm

+
+
+
+
+
+ +

Optional jclSymbols

+
jclSymbols: string
+ +
+
+

A string for JCL symbolic substitution

+
+
+
memberof
+

ISubmitJobParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobnotifyparm.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobnotifyparm.html new file mode 100644 index 0000000000..d439775f08 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobnotifyparm.html @@ -0,0 +1,477 @@ + + + + + + ISubmitJobNotifyParm | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISubmitJobNotifyParm

+
+
+
+
+
+
+
+
+
+

Interface for submit job API

+
+
+
export
+
+
interface
+

ISubmitJobNotifyParm

+
+
+
+
+
+

Hierarchy

+
    +
  • + ISubmitJobNotifyParm +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional attempts

+
attempts: number
+ +
+
+

Number of attempts for which will poll before ending. + Default: MonitorJobs.DEFAULT_ATTEMPTS.

+
+
+
memberof
+

ISubmitJclNotifyParm

+
+
+
+
+
+ +

Optional jclSymbols

+
jclSymbols: string
+ +
+
+

A string for JCL symbolic substitution

+
+
+
memberof
+

ISubmitJobParms

+
+
+
+
+
+ +

jobDataSet

+
jobDataSet: string
+ +
+
+

z/OS data set which should contain syntactically correct JCL + Example value: IBMUSER.PUBLIC.CNTL(IEFBR14) + where IEFBR14 contains statements like: + //IEFBR14 JOB () + //RUN EXEC PGM=IEFBR14

+
+
+
memberof
+

ISubmitJobNotifyParm

+
+
+
+
+
+ +

Optional status

+
status: JOB_STATUS
+ +
+
+

Status for which you'd like to be notified of a completed job. + Default: MonitorJobs.DEFAULT_STATUS.

+
+
+
memberof
+

ISubmitJclNotifyParm

+
+
+
+
+
+ +

Optional watchDelay

+
watchDelay: number
+ +
+
+

Watch delay (polling delay) that the underlying services will use + to report whenever a job is complete in milliseconds. + Default: MonitorJobs.DEFAULT_WATCHER_DELAY

+
+
+
memberof
+

ISubmitJclNotifyParm

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobparms.html new file mode 100644 index 0000000000..1587693afb --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobparms.html @@ -0,0 +1,401 @@ + + + + + + ISubmitJobParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISubmitJobParms

+
+
+
+
+
+
+
+
+
+

Interface for submit job API

+
+
+
export
+
+
interface
+

ISubmitJobParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + ISubmitJobParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional jclSymbols

+
jclSymbols: string
+ +
+
+

A string for JCL symbolic substitution

+
+
+
memberof
+

ISubmitJobParms

+
+
+
+
+
+ +

jobDataSet

+
jobDataSet: string
+ +
+
+

z/OS data set which should contain syntactically correct JCL + Example value: IBMUSER.PUBLIC.CNTL(IEFBR14) + where IEFBR14 contains statements like: + //IEFBR14 JOB () + //RUN EXEC PGM=IEFBR14

+
+
+
memberof
+

ISubmitJobParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussnotifyparm.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussnotifyparm.html new file mode 100644 index 0000000000..917958b68d --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussnotifyparm.html @@ -0,0 +1,484 @@ + + + + + + ISubmitJobUSSNotifyParm | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISubmitJobUSSNotifyParm

+
+
+
+
+
+
+
+
+
+

Interface for submit job API

+
+
+
export
+
+
interface
+

ISubmitJobNotifyParm

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional attempts

+
attempts: number
+ +
+
+

Number of attempts for which will poll before ending. + Default: MonitorJobs.DEFAULT_ATTEMPTS.

+
+
+
memberof
+

ISubmitJobUSSNotifyParm

+
+
+
+
+
+ +

Optional jclSymbols

+
jclSymbols: string
+ +
+
+

A string for JCL symbolic substitution

+
+
+
memberof
+

ISubmitJobUSSParms

+
+
+
+
+
+ +

jobUSSFile

+
jobUSSFile: string
+ +
+
+

USS File which should contain syntactically correct JCL + Example value: /u/users/ibmuser/iefbr14.jcl + where the file contains statements like: + //IEFBR14 JOB () + //RUN EXEC PGM=IEFBR14

+
+
+
memberof
+

ISubmitJobUSSParms

+
+
+
+
+
+ +

Optional status

+
status: JOB_STATUS
+ +
+
+

Status for which you'd like to be notified of a completed job. + Default: MonitorJobs.DEFAULT_STATUS.

+
+
+
memberof
+

ISubmitJobUSSNotifyParm

+
+
+
+
+
+ +

Optional watchDelay

+
watchDelay: number
+ +
+
+

Watch delay (polling delay) that the underlying services will use + to report whenever a job is complete in milliseconds. + Default: MonitorJobs.DEFAULT_WATCHER_DELAY

+
+
+
memberof
+

ISubmitJobUSSNotifyParm

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussparms.html new file mode 100644 index 0000000000..55831bf6b4 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitjobussparms.html @@ -0,0 +1,406 @@ + + + + + + ISubmitJobUSSParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISubmitJobUSSParms

+
+
+
+
+
+
+
+
+
+

Interface for submit job API

+
+
+
export
+
+
interface
+

ISubmitJobUSSParms

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional jclSymbols

+
jclSymbols: string
+ +
+
+

A string for JCL symbolic substitution

+
+
+
memberof
+

ISubmitJobUSSParms

+
+
+
+
+
+ +

jobUSSFile

+
jobUSSFile: string
+ +
+
+

USS File which should contain syntactically correct JCL + Example value: /u/users/ibmuser/iefbr14.jcl + where the file contains statements like: + //IEFBR14 JOB () + //RUN EXEC PGM=IEFBR14

+
+
+
memberof
+

ISubmitJobUSSParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html new file mode 100644 index 0000000000..b22f382c31 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_jobs_for_zowe_sdk.isubmitparms.html @@ -0,0 +1,531 @@ + + + + + + ISubmitParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISubmitParms

+
+
+
+
+
+
+
+
+
+

Interface for submit job API

+
+
+
export
+
+
interface
+

ISubmitParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + ISubmitParms +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional directory

+
directory: string
+ +
+
+

Local directory path to download output of the job

+
+
+
+
+ +

Optional extension

+
extension: string
+ +
+
+

A file extension to save the job output with

+
+
+
+
+ +

jclSource

+
jclSource: string
+ +
+
+

USS file which should contain syntactically correct JCL + Example value: IBMUSER.PUBLIC.CNTL(IEFBR14) + where IEFBR14 contains statements like: + //IEFBR14 JOB () + //RUN EXEC PGM=IEFBR14

+
+
+
+
+ +

Optional jclSymbols

+
jclSymbols: string
+ +
+
+

A string for JCL symbolic substitution

+
+
+
memberof
+

ISubmitJobParms

+
+
+
+
+
+ +

Optional task

+ + +
+
+

Task status object used by CLI handlers to create progress bars + for certain job submit requests + Optional

+
+
+
+
+ +

Optional viewAllSpoolContent

+
viewAllSpoolContent: boolean
+ +
+
+

Returns spool content if this option used

+
+
+
+
+ +

Optional volume

+
volume: string
+ +
+
+

The volume on which the data set is stored

+
+
+
+
+ +

Optional waitForActive

+
waitForActive: boolean
+ +
+
+

Wait for the job to reach output status

+
+
+
+
+ +

Optional waitForOutput

+
waitForOutput: boolean
+ +
+
+

Wait for the job to reach output status

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html new file mode 100644 index 0000000000..7267f1ac7c --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogitemtype.html @@ -0,0 +1,514 @@ + + + + + + IZosLogItemType | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosLogItemType

+
+
+
+
+
+
+
+
+
+

Represents the details about one log item

+
+
+
export
+
+
interface
+

IZosLogItemType

+
+
+
+
+
+

Hierarchy

+
    +
  • + IZosLogItemType +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

cart

+
cart: string
+ +
+
+

Eight character command and response token (CART).

+
+
+
memberof
+

IZosLogItemType

+
+
+
+
+
+ +

color

+
color: string
+ +
+
+

The color of the message.

+
+
+
memberof
+

IZosLogItemType

+
+
+
+
+
+ +

jobName

+
jobName: string
+ +
+
+

The name of the job that generates the message.

+
+
+
memberof
+

IZosLogItemType

+
+
+
+
+
+ +

message

+
message: string
+ +
+
+

The content of the message.

+
+
+
memberof
+

IZosLogItemType

+
+
+
+
+
+ +

messageId

+
messageId: string
+ +
+
+

The message ID.

+
+
+
memberof
+

IZosLogItemType

+
+
+
+
+
+ +

replyId

+
replyId: string
+ +
+
+

Reply ID, in decimal.

+
+
+
memberof
+

IZosLogItemType

+
+
+
+
+
+ +

subType

+
subType: string
+ +
+
+

Indicate whether the message is a DOM, WTOR, or HOLD message.

+
+
+
memberof
+

IZosLogItemType

+
+
+
+
+
+ +

system

+
system: string
+ +
+
+

Original eight character system name.

+
+
+
memberof
+

IZosLogItemType

+
+
+
+
+
+ +

time

+
time: string
+ +
+
+

For example, “Thu Feb 03 03:00 GMT 2021”.

+
+
+
memberof
+

IZosLogItemType

+
+
+
+
+
+ +

timestamp

+
timestamp: number
+ +
+
+

UNIX timestamp. For example, 1621920830109.

+
+
+
memberof
+

IZosLogItemType

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

“HARDCOPY”.

+
+
+
memberof
+

IZosLogItemType

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogparms.html new file mode 100644 index 0000000000..937a974965 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogparms.html @@ -0,0 +1,347 @@ + + + + + + IZosLogParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosLogParms

+
+
+
+
+
+
+
+
+
+

The z/OSMF log API parameters. See the z/OSMF REST API documentation for full details.

+
+
+
export
+
+
interface
+

IZosLogParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IZosLogParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional direction

+
direction: "forward" | "backward"
+ +
+
+

The direction param.

+
+
+
memberof
+

ILogParms

+
+
+
+
+
+ +

Optional processResponses

+
processResponses: boolean
+ +
+
+

The z/OSMF Console API returns '\r' or '\r\n' where line-breaks. Can attempt to replace these + sequences with '\n', but there may be cases where that is not preferable. Specify false to prevent processing.

+
+
+
memberof
+

IConsoleParms

+
+
+
+
+
+ +

Optional range

+
range: string
+ +
+
+

The timeRange param.

+
+
+
memberof
+

ILogParms

+
+
+
+
+
+ +

Optional startTime

+
startTime: any
+ +
+
+

The z/OS log api time param.

+
+
+
memberof
+

ILogParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogtype.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogtype.html new file mode 100644 index 0000000000..ab91291747 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_logs_for_zowe_sdk.izoslogtype.html @@ -0,0 +1,374 @@ + + + + + + IZosLogType | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosLogType

+
+
+
+
+
+
+
+
+
+

Standard log response document + Represents the details about the messages and logs

+
+
+
export
+
+
interface
+

IZosLogType

+
+
+
+
+
+

Hierarchy

+
    +
  • + IZosLogType +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

items

+ + +
+
+

JSON array of messages

+
+
+
memberof
+

IZosLogType

+
+
+
+
+
+ +

nextTimestamp

+
nextTimestamp: number
+ +
+
+

The UNIX timestamp. This value could be used in a subsequent request tospecify a starting timestamp. + Logs in the “nextTimestamp” are not returned in the current response.

+
+
+
memberof
+

IZosLogType

+
+
+
+
+
+ +

source

+
source: string
+ +
+
+

Indicates the source of the log. + Value "OPERLOG" indicates the operations log.

+
+
+
memberof
+

IZosLogType

+
+
+
+
+
+ +

timezone

+
timezone: number
+ +
+
+

Specify the timezone of the z/OS system. Valid values for the timezone rangefrom -12 to 12. + For example, "-3" means UTC-3 timezone.

+
+
+
memberof
+

IZosLogType

+
+
+
+
+
+ +

totalitems

+
totalitems: number
+ +
+
+

Total number of messages returned in the response.

+
+
+
memberof
+

IZosLogType

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.icollectedresponses.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.icollectedresponses.html new file mode 100644 index 0000000000..8f56abb536 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.icollectedresponses.html @@ -0,0 +1,380 @@ + + + + + + ICollectedResponses | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICollectedResponses

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ICollectedResponses +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

messages

+
messages: string
+ +
+
+

Appended collected messages including READY prompt at the end.

+
+
+
memberof
+

ICollectedResponses

+
+
+
+
+
+ +

tsos

+ + +
+
+

z/OSMF synchronous most tso command response messages.

+
+
+
memberof
+

ICollectedResponses

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.iissueresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.iissueresponse.html new file mode 100644 index 0000000000..94ca648f48 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.iissueresponse.html @@ -0,0 +1,491 @@ + + + + + + IIssueResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IIssueResponse

+
+
+
+
+
+
+
+
+
+

The TsoSend API response.

+
+
+
export
+
+
interface
+

ISendResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IIssueResponse +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

commandResponse

+
commandResponse: string
+ +
+
+

The command response text.

+
+
+
memberof
+

IIssueResponse

+
+
+
+
+
+ +

startReady

+
startReady: boolean
+ +
+
+

Indicates if started TSO containes "READY " message

+
+
+
memberof
+

IIssueResponse

+
+
+
+
+
+ +

startResponse

+
startResponse: IStartStopResponses
+ +
+
+

zOSMF start TSO API response.

+
+
+
memberof
+

ISendResponse

+
+
+
+
+
+ +

stopResponse

+
stopResponse: IStartStopResponse
+ +
+
+

zOSMF stop TSO API response.

+
+
+
memberof
+

IIssueResponse

+
+
+
+
+
+ +

success

+
success: boolean
+ +
+
+

True if the command was issued and the responses were collected.

+
+
+
memberof
+

IIssueResponse

+
+
+
+
+
+ +

zosmfResponse

+
zosmfResponse: IZosmfTsoResponse[]
+ +
+
+

The list of zOSMF send API responses. May issue multiple requests or + to ensure that all messages are collected. Each individual response is placed here.

+
+
+
memberof
+

IIssueResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.iissuetsoparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.iissuetsoparms.html new file mode 100644 index 0000000000..ea9c1ad393 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.iissuetsoparms.html @@ -0,0 +1,418 @@ + + + + + + IIssueTsoParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IIssueTsoParms

+
+
+
+
+
+
+
+
+
+

Interface for TSO issue command z/OSMF parameters

+
+
+
export
+
+
interface
+

IIssueTsoParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IIssueTsoParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

accountNumber

+
accountNumber: string
+ +
+
+

Accounting info for Jobs

+
+
+
memberof
+

IIssueTsoParms

+
+
+
+
+
+ +

command

+
command: string
+ +
+
+

Command text to issue to the TSO address space.

+
+
+
memberof
+

IIssueTsoParms

+
+
+
+
+
+ +

startParams

+
startParams: IStartTsoParms
+ +
+
+

Interface for TSO start command z/OSMF parameters

+
+
+
memberof
+

IIssueTsoParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.ipingresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.ipingresponse.html new file mode 100644 index 0000000000..66a2ed4192 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.ipingresponse.html @@ -0,0 +1,428 @@ + + + + + + IPingResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPingResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IPingResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional failureResponse

+
failureResponse: ImperativeError
+ +
+
+

If an error occurs, returns the ImperativeError, which contains cause error.

+
+
+
memberof
+

IConsoleResponse

+
+
+
+
+
+ +

servletKey

+
servletKey: string
+ +
+
+

Servlet key from IZosmfPingResponse

+
+
+
memberof
+

IPingResponse

+
+
+
+
+
+ +

success

+
success: boolean
+ +
+
+

True if the command was issued and the responses were collected.

+
+
+
memberof
+

IPingResponse

+
+
+
+
+
+ +

zosmfPingResponse

+
zosmfPingResponse: IZosmfPingResponse
+ +
+
+

Response from z/OSMF to ping rest call

+
+
+
memberof
+

IPingResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.isendresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.isendresponse.html new file mode 100644 index 0000000000..4804ae0a08 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.isendresponse.html @@ -0,0 +1,419 @@ + + + + + + ISendResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISendResponse

+
+
+
+
+
+
+
+
+
+

The TsoSend API response.

+
+
+
export
+
+
interface
+

ISendResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + ISendResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

commandResponse

+
commandResponse: string
+ +
+
+

The command response text.

+
+
+
memberof
+

ISendResponse

+
+
+
+
+
+ +

success

+
success: boolean
+ +
+
+

True if the command was issued and the responses were collected.

+
+
+
memberof
+

ISendResponse

+
+
+
+
+
+ +

zosmfResponse

+
zosmfResponse: IZosmfTsoResponse[]
+ +
+
+

The list of zOSMF send API responses. May issue multiple requests or + to ensure that all messages are collected. Each individual response is placed here.

+
+
+
memberof
+

ISendResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.isendtsoparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.isendtsoparms.html new file mode 100644 index 0000000000..7a5ee88f55 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.isendtsoparms.html @@ -0,0 +1,394 @@ + + + + + + ISendTsoParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISendTsoParms

+
+
+
+
+
+
+
+
+
+

Interface for TSO issue command z/OSMF parameters

+
+
+
export
+
+
interface
+

IIssueTsoParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + ISendTsoParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

data

+
data: string
+ +
+
+

Data to be sent to the active address space

+
+
+
memberof
+

ISendTsoParms

+
+
+
+
+
+ +

servletKey

+
servletKey: string
+ +
+
+

Servlet key of an active address space

+
+
+
memberof
+

ISendTsoParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponse.html new file mode 100644 index 0000000000..e10d31adff --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponse.html @@ -0,0 +1,428 @@ + + + + + + IStartStopResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IStartStopResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IStartStopResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional failureResponse

+
failureResponse: ImperativeError
+ +
+
+

If an error occurs, returns the ImperativeError, which contains cause error.

+
+
+
memberof
+

IStartStopResponse

+
+
+
+
+
+ +

servletKey

+
servletKey: string
+ +
+
+

Servlet key from IZosmfTsoResponse

+
+
+
memberof
+

IStartStopResponse

+
+
+
+
+
+ +

success

+
success: boolean
+ +
+
+

True if the command was issued and the responses were collected.

+
+
+
memberof
+

IStartStopResponse

+
+
+
+
+
+ +

zosmfTsoResponse

+
zosmfTsoResponse: IZosmfTsoResponse
+ +
+
+

Response from z/OSMF to start rest call

+
+
+
memberof
+

IStartStopResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponses.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponses.html new file mode 100644 index 0000000000..00e97d67d7 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.istartstopresponses.html @@ -0,0 +1,476 @@ + + + + + + IStartStopResponses | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IStartStopResponses

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + IStartStopResponses +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

collectedResponses

+
collectedResponses: IZosmfTsoResponse[]
+ +
+
+

Collected responses from z/OSMF

+
+
+
memberof
+

IStartStopResponses

+
+
+
+
+
+ +

Optional failureResponse

+
failureResponse: ImperativeError
+ +
+
+

If an error occurs, returns the ImperativeError, which contains cause error.

+
+
+
memberof
+

IStartStopResponses

+
+
+
+
+
+ +

messages

+
messages: string
+ +
+
+

Appended collected messages including READY prompt at the end.

+
+
+
memberof
+

IStartStopResponses

+
+
+
+
+
+ +

servletKey

+
servletKey: string
+ +
+
+

Servlet key from IZosmfTsoResponse

+
+
+
memberof
+

IStartStopResponses

+
+
+
+
+
+ +

success

+
success: boolean
+ +
+
+

True if the command was issued and the responses were collected.

+
+
+
memberof
+

IStartStopResponses

+
+
+
+
+
+ +

zosmfTsoResponse

+
zosmfTsoResponse: IZosmfTsoResponse
+ +
+
+

Response from z/OSMF to start rest call

+
+
+
memberof
+

IStartStopResponses

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.istarttsoparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.istarttsoparms.html new file mode 100644 index 0000000000..55ea9968fd --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.istarttsoparms.html @@ -0,0 +1,514 @@ + + + + + + IStartTsoParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IStartTsoParms

+
+
+
+
+
+
+
+
+
+

Interface for TSO start command z/OSMF parameters

+
+
+
export
+
+
interface
+

IStartTsoParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IStartTsoParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional account

+
account: string
+ +
+
+

user account number

+
+
+
memberof
+

IStartTsoParms

+
+
+
+
+
+ +

Optional characterSet

+
characterSet: string
+ +
+
+

character set for address space

+
+
+
memberof
+

IStartTsoParms

+
+
+
+
+
+ +

Optional codePage

+
codePage: string
+ +
+
+

code page for tso address space

+
+
+
memberof
+

IStartTsoParms

+
+
+
+
+
+ +

Optional columns

+
columns: string
+ +
+
+

number of columns

+
+
+
memberof
+

IStartTsoParms

+
+
+
+
+
+ +

Optional logonProcedure

+
logonProcedure: string
+ +
+
+

name of the logonProcedure for address space

+
+
+
memberof
+

IStartTsoParms

+
+
+
+
+
+ +

Optional regionSize

+
regionSize: string
+ +
+
+

region size for address space

+
+
+
memberof
+

IStartTsoParms

+
+
+
+
+
+ +

Optional rows

+
rows: string
+ +
+
+

number of rows

+
+
+
memberof
+

IStartTsoParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.istoptsoparms.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.istoptsoparms.html new file mode 100644 index 0000000000..2bb86ff6ed --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.istoptsoparms.html @@ -0,0 +1,370 @@ + + + + + + IStopTsoParms | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IStopTsoParms

+
+
+
+
+
+
+
+
+
+

Interface for TSO stop command z/OSMF parameters

+
+
+
export
+
+
interface
+

IStopTsoParms

+
+
+
+
+
+

Hierarchy

+
    +
  • + IStopTsoParms +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

servletKey

+
servletKey: string
+ +
+
+

servlet key of an active address space

+
+
+
memberof
+

IStopTsoParms

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessage.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessage.html new file mode 100644 index 0000000000..9326a370d0 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessage.html @@ -0,0 +1,394 @@ + + + + + + ITsoMessage | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ITsoMessage

+
+
+
+
+
+
+
+
+
+

TSO Message interface for one of TSO/E messages

+
+
+
export
+
+
interface
+

ITsoMessage

+
+
+
+
+
+

Hierarchy

+
    +
  • + ITsoMessage +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

DATA

+
DATA: string
+ +
+
+

description of the data type

+
+
+
memberof
+

ITsoMessage

+
+
+
+
+
+ +

VERSION

+
VERSION: string
+ +
+
+

JSON version for message format

+
+
+
memberof
+

ITsoMessage

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessages.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessages.html new file mode 100644 index 0000000000..3d498beed3 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.itsomessages.html @@ -0,0 +1,418 @@ + + + + + + ITsoMessages | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ITsoMessages

+
+
+
+
+
+
+
+
+
+

Interface for TSO/E messages

+
+
+
export
+
+
interface
+

ITsoMessages

+
+
+
+
+
+

Hierarchy

+
    +
  • + ITsoMessages +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional TSO MESSAGE

+
TSO MESSAGE: ITsoMessage
+ +
+
+

tso message type of TSO/E messages

+
+
+
memberof
+

ITsoMessages

+
+
+
+
+
+ +

Optional TSO PROMPT

+
TSO PROMPT: ITsoPromptMessage
+ +
+
+

tso prompt message type of TSO/E messages

+
+
+
memberof
+

ITsoMessages

+
+
+
+
+
+ +

Optional TSO RESPONSE

+
TSO RESPONSE: ITsoResponseMessage
+ +
+
+

tso response message type of TSO/E messages

+
+
+
memberof
+

ITsoMessages

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.itsopromptmessage.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.itsopromptmessage.html new file mode 100644 index 0000000000..7f09cc81bb --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.itsopromptmessage.html @@ -0,0 +1,394 @@ + + + + + + ITsoPromptMessage | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ITsoPromptMessage

+
+
+
+
+
+
+
+
+
+

TSO Prompt interface for one of TSO/E messages

+
+
+
export
+
+
interface
+

ITsoPromptMessage

+
+
+
+
+
+

Hierarchy

+
    +
  • + ITsoPromptMessage +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

HIDDEN

+
HIDDEN: string
+ +
+
+

description of the data type

+
+
+
memberof
+

ITsoPromptMessage

+
+
+
+
+
+ +

VERSION

+
VERSION: string
+ +
+
+

JSON version for message format

+
+
+
memberof
+

ITsoPromptMessage

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.itsoresponsemessage.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.itsoresponsemessage.html new file mode 100644 index 0000000000..e033e978ec --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.itsoresponsemessage.html @@ -0,0 +1,394 @@ + + + + + + ITsoResponseMessage | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ITsoResponseMessage

+
+
+
+
+
+
+
+
+
+

TSO Response interface for one of TSO/E messages

+
+
+
export
+
+
interface
+

ITsoResponseMessage

+
+
+
+
+
+

Hierarchy

+
    +
  • + ITsoResponseMessage +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

DATA

+
DATA: string
+ +
+
+

description of the data type

+
+
+
memberof
+

ITsoResponseMessage

+
+
+
+
+
+ +

VERSION

+
VERSION: string
+ +
+
+

JSON version for message format

+
+
+
memberof
+

ITsoResponseMessage

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfmessages.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfmessages.html new file mode 100644 index 0000000000..9fb1a7acef --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfmessages.html @@ -0,0 +1,418 @@ + + + + + + IZosmfMessages | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosmfMessages

+
+
+
+
+
+
+
+
+
+

The z/OSMF Ping API error message parameters. See the z/OSMF REST API documentation for full details.

+
+
+
export
+
+
interface
+

IZosmfMessages

+
+
+
+
+
+

Hierarchy

+
    +
  • + IZosmfMessages +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

messageId

+
messageId: string
+ +
+
+

Error message text ID.

+
+
+
memberof
+

IZosmfMessages

+
+
+
+
+
+ +

messageText

+
messageText: string
+ +
+
+

Error message text.

+
+
+
memberof
+

IZosmfMessages

+
+
+
+
+
+ +

stackTrace

+
stackTrace: string
+ +
+
+

Error message stack trace.

+
+
+
memberof
+

IZosmfMessages

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfpingresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfpingresponse.html new file mode 100644 index 0000000000..75d68ed7a4 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.izosmfpingresponse.html @@ -0,0 +1,466 @@ + + + + + + IZosmfPingResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosmfPingResponse

+
+
+
+
+
+
+
+
+
+

The z/OSMF Ping API parameters. See the z/OSMF REST API documentation for full details.

+
+
+
export
+
+
interface
+

IZosmfPingResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IZosmfPingResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional msgData

+
msgData: IZosmfMessages[]
+ +
+
+

Ping error message response.

+
+
+
memberof
+

IZosmfPingResponse

+
+
+
+
+
+ +

reused

+
reused: boolean
+ +
+
+

Ping reused boolean.

+
+
+
memberof
+

IZosmfPingResponse

+
+
+
+
+
+ +

servletKey

+
servletKey: string
+ +
+
+

Ping servlet key used text.

+
+
+
memberof
+

IZosmfPingResponse

+
+
+
+
+
+ +

timeout

+
timeout: boolean
+ +
+
+

Ping timeout boolean.

+
+
+
memberof
+

IZosmfPingResponse

+
+
+
+
+
+ +

ver

+
ver: string
+ +
+
+

Ping version text.

+
+
+
memberof
+

IZosmfPingResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html new file mode 100644 index 0000000000..f2a64433ed --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_tso_for_zowe_sdk.izosmftsoresponse.html @@ -0,0 +1,562 @@ + + + + + + IZosmfTsoResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosmfTsoResponse

+
+
+
+
+
+
+
+
+
+

z/OSMF synchronous most tso command response messages. See the z/OSMF REST API publication for complete details.

+
+
+
export
+
+
interface
+

IZosmfTsoResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IZosmfTsoResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional appData

+
appData: string
+ +
+
+

application messages

+
+
+
memberof
+

IZosmfTsoResponse

+
+
+
+
+
+ +

Optional msgData

+
msgData: IZosmfMessages[]
+ +
+
+

z/OSMF messages

+
+
+
memberof
+

IZosmfTsoResponse

+
+
+
+
+
+ +

Optional queueID

+
queueID: string
+ +
+
+

message queue ID

+
+
+
memberof
+

IZosmfTsoResponse

+
+
+
+
+
+ +

reused

+
reused: boolean
+ +
+
+

reconnected indicator

+
+
+
memberof
+

IZosmfTsoResponse

+
+
+
+
+
+ +

servletKey

+
servletKey: string
+ +
+
+

unique identifier for the servlet entry

+
+
+
memberof
+

IZosmfTsoResponse

+
+
+
+
+
+ +

Optional sessionID

+
sessionID: string
+ +
+
+

id of the session

+
+
+
memberof
+

IZosmfTsoResponse

+
+
+
+
+
+ +

timeout

+
timeout: boolean
+ +
+
+

timeout indicator

+
+
+
memberof
+

IZosmfTsoResponse

+
+
+
+
+
+ +

Optional tsoData

+
tsoData: ITsoMessages[]
+ +
+
+

TSO/E messages that were received during the request

+
+
+
memberof
+

IZosmfTsoResponse

+
+
+
+
+
+ +

ver

+
ver: string
+ +
+
+

structure version

+
+
+
memberof
+

IZosmfTsoResponse

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_uss_for_zowe_sdk.isshsession.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_uss_for_zowe_sdk.isshsession.html new file mode 100644 index 0000000000..6ecd23185d --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_uss_for_zowe_sdk.isshsession.html @@ -0,0 +1,419 @@ + + + + + + ISshSession | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ISshSession

+
+
+
+
+
+
+
+
+
+

Session interface for maintaining cookie and protocol information

+
+
+
export
+
+
interface
+

ISshSession

+
+
+
+
+
+

Hierarchy

+
    +
  • + ISshSession +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional handshakeTimeout

+
handshakeTimeout: number
+ +
+
+

How long in milliseconds to wait for the SSH handshake to complete. If unset, defaults to 0 - no timeout.

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional hostname

+
hostname: string
+ +
+
+

Host to connect ssh to

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional keyPassphrase

+
keyPassphrase: string
+ +
+
+

password to unlock the private key.

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional password

+
password: string
+ +
+
+

Password

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional port

+
port: number
+ +
+
+

Port to obtain data from + 22 is the default for ssh

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional privateKey

+
privateKey: string
+ +
+
+

Path to a private key that matches with a public key stored in the server for authentication

+
+
+
memberof
+

ISession

+
+
+
+
+
+ +

Optional user

+
user: string
+ +
+
+

User name for logging in

+
+
+
memberof
+

ISession

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iactiveworkflows.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iactiveworkflows.html new file mode 100644 index 0000000000..98c0f35228 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iactiveworkflows.html @@ -0,0 +1,246 @@ + + + + + + IActiveWorkflows | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IActiveWorkflows

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IActiveWorkflows

+
+
+
+
+
+

Hierarchy

+
    +
  • + IActiveWorkflows +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional workflows

+
workflows: IWorkflowsInfo[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iarchivedworkflow.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iarchivedworkflow.html new file mode 100644 index 0000000000..5f02724264 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iarchivedworkflow.html @@ -0,0 +1,256 @@ + + + + + + IArchivedWorkflow | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IArchivedWorkflow

+
+
+
+
+
+
+
+
+
+

Response to the successfully archived workflow

+
+
+
export
+
+
interface
+

IArchivedWorkflow

+
+
+
+
+
+

Hierarchy

+
    +
  • + IArchivedWorkflow +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional workflowKey

+
workflowKey: string
+ +
+
+

Workflow key of the archived workflow

+
+
+
memberof
+

IArchivedWorkflow

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iarchivedworkflows.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iarchivedworkflows.html new file mode 100644 index 0000000000..0b888532ab --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iarchivedworkflows.html @@ -0,0 +1,246 @@ + + + + + + IArchivedWorkflows | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IArchivedWorkflows

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IArchivedWorkflows

+
+
+
+
+
+

Hierarchy

+
    +
  • + IArchivedWorkflows +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional archivedWorkflows

+
archivedWorkflows: IWorkflowsInfo[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iautomationstatus.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iautomationstatus.html new file mode 100644 index 0000000000..647a45024e --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iautomationstatus.html @@ -0,0 +1,424 @@ + + + + + + IAutomationStatus | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IAutomationStatus

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IAutomationStatus

+
+
+
+
+
+

Hierarchy

+
    +
  • + IAutomationStatus +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

currentStepName

+
currentStepName: string
+ +
+
+

Step that is being processed automatically or that caused stop.

+
+
+
memberof
+

IAutomationStatus

+
+
+
+
+
+ +

currentStepNumber

+
currentStepNumber: string
+ +
+
+

The step number.

+
+
+
memberof
+

IAutomationStatus

+
+
+
+
+
+ +

currentStepTitle

+
currentStepTitle: string
+ +
+
+

Step title.

+
+
+
memberof
+

IAutomationStatus

+
+
+
+
+
+ +

messageID

+
messageID: string
+ +
+
+

Message identifier for the accompanying message.

+
+
+
memberof
+

IAutomationStatus

+
+
+
+
+
+ +

messageText

+
messageText: string
+ +
+
+

Message text that describes the reason that automation is stopped.

+
+
+
memberof
+

IAutomationStatus

+
+
+
+
+
+ +

startUser

+
startUser: string
+ +
+
+

User ID of the user who initiated the automation processing.

+
+
+
memberof
+

IAutomationStatus

+
+
+
+
+
+ +

startedTime

+
startedTime: number
+ +
+
+

Time that automation processing started.

+
+
+
memberof
+

IAutomationStatus

+
+
+
+
+
+ +

stoppedTime

+
stoppedTime: number
+ +
+
+

Time that automation processing stopped.

+
+
+
memberof
+

IAutomationStatus

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflow.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflow.html new file mode 100644 index 0000000000..2c73c56d5f --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflow.html @@ -0,0 +1,352 @@ + + + + + + ICreatedWorkflow | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICreatedWorkflow

+
+
+
+
+
+
+
+
+
+

Interface for created workflow objects.

+
+
+
export
+
+
interface
+

IVariable

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICreatedWorkflow +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

vendor

+
vendor: string
+ +
+
+

Workflow vendor.

+
+
+
memberof
+

ICreatedWorkflow

+
+
+
+
+
+ +

workflowDescription

+
workflowDescription: string
+ +
+
+

Description of the workflow.

+
+
+
memberof
+

ICreatedWorkflow

+
+
+
+
+
+ +

workflowID

+
workflowID: string
+ +
+
+

Workflow ID.

+
+
+
memberof
+

ICreatedWorkflow

+
+
+
+
+
+ +

workflowKey

+
workflowKey: string
+ +
+
+

Unique workflow key.

+
+
+
memberof
+

ICreatedWorkflow

+
+
+
+
+
+ +

workflowVersion

+
workflowVersion: string
+ +
+
+

Version of the workflow.

+
+
+
memberof
+

ICreatedWorkflow

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflowlocal.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflowlocal.html new file mode 100644 index 0000000000..9e530046b2 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.icreatedworkflowlocal.html @@ -0,0 +1,400 @@ + + + + + + ICreatedWorkflowLocal | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICreatedWorkflowLocal

+
+
+
+
+
+
+
+
+
+

Interface for created workflow objects.

+
+
+
export
+
+
interface
+

IVariable

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICreatedWorkflowLocal +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional failedToDelete

+
failedToDelete: string[]
+ +
+
+

Uss files that were not deleted.

+
+
+
memberof
+

ICreatedWorkflowLocal

+
+
+
+
+
+ +

Optional filesKept

+
filesKept: string[]
+ +
+
+

Files that were kept

+
+
+
memberof
+

ICreatedWorkflowLocal

+
+
+
+
+
+ +

vendor

+
vendor: string
+ +
+
+

Workflow vendor.

+
+
+
memberof
+

ICreatedWorkflowLocal

+
+
+
+
+
+ +

workflowDescription

+
workflowDescription: string
+ +
+
+

Description of the workflow.

+
+
+
memberof
+

ICreatedWorkflowLocal

+
+
+
+
+
+ +

workflowID

+
workflowID: string
+ +
+
+

Workflow ID.

+
+
+
memberof
+

ICreatedWorkflowLocal

+
+
+
+
+
+ +

workflowKey

+
workflowKey: string
+ +
+
+

Unique workflow key.

+
+
+
memberof
+

ICreatedWorkflowLocal

+
+
+
+
+
+ +

workflowVersion

+
workflowVersion: string
+ +
+
+

Version of the workflow.

+
+
+
memberof
+

ICreatedWorkflowLocal

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html new file mode 100644 index 0000000000..82ec26920f --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.icreateworkflow.html @@ -0,0 +1,452 @@ + + + + + + ICreateWorkflow | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ICreateWorkflow

+
+
+
+
+
+
+
+
+
+

Interface for creating workflow objects.

+
+
+
export
+
+
interface
+

ICreateWorkflow

+
+
+
+
+
+

Hierarchy

+
    +
  • + ICreateWorkflow +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional accessType

+
accessType: accessT
+ +
+
+

Workflow access type

+
+
+
memberof
+

ICreateWorkflow

+
+
+
+
+
+ +

Optional assignToOwner

+
assignToOwner: boolean
+ +
+
+

Assign workflow steps to owner.

+
+
+
memberof
+

ICreateWorkflow

+
+
+
+
+
+ +

Optional deleteCompletedJobs

+
deleteCompletedJobs: boolean
+ +
+
+

Delete completed jobs.

+
+
+
memberof
+

ICreateWorkflow

+
+
+
+
+
+ +

owner

+
owner: string
+ +
+
+

Unique workflow name.

+
+
+
memberof
+

ICreateWorkflow

+
+
+
+
+
+ +

system

+
system: string
+ +
+
+

Unique workflow name.

+
+
+
memberof
+

ICreateWorkflow

+
+
+
+
+
+ +

Optional variableInputFile

+
variableInputFile: string
+ +
+
+

Path to file with variables. + USS file with .properties extension or Dataset

+
+
+
memberof
+

ICreateWorkflow

+
+
+
+
+
+ +

Optional variables

+
variables: IVariable[]
+ +
+
+

Variables to be passed to workflow + Can be used to change values of variables that + are in input file.

+
+
+
memberof
+

ICreateWorkflow

+
+
+
+
+
+ +

workflowDefinitionFile

+
workflowDefinitionFile: string
+ +
+
+

Path to workflow definition file. + Xml in USS or Dataset

+
+
+
memberof
+

ICreateWorkflow

+
+
+
+
+
+ +

workflowName

+
workflowName: string
+ +
+
+

Unique workflow name.

+
+
+
memberof
+

ICreateWorkflow

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.igetworkflowsoptions.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.igetworkflowsoptions.html new file mode 100644 index 0000000000..fad12ac8ff --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.igetworkflowsoptions.html @@ -0,0 +1,416 @@ + + + + + + IGetWorkflowsOptions | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IGetWorkflowsOptions

+
+
+
+
+
+
+
+
+
+

Options for the List Workflows API

+
+
+
export
+
+
interface
+

IGetWorkflowsOptions

+
+
+
+
+
+

Hierarchy

+
    +
  • + IGetWorkflowsOptions +
  • +
+
+
+

Indexable

+
[key: string]: any
+
+
+

Options for the List Workflows API

+
+
+
export
+
+
interface
+

IGetWorkflowsOptions

+
+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional category

+
category: string
+ +
+
+

Category of workflow.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional owner

+
owner: string
+ +
+
+

Unique workflow name.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional statusName

+
statusName: string
+ +
+
+

Unique workflow name.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional system

+
system: string
+ +
+
+

Full name of z/OS system.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional vendor

+
vendor: string
+ +
+
+

Unique workflow name.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional workflowName

+
workflowName: string
+ +
+
+

Unique workflow name.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional zOSMFVersion

+
zOSMFVersion: string
+ +
+
+

Version of z/OS MF Workflow APIs.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobfiles.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobfiles.html new file mode 100644 index 0000000000..b2f813bca1 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobfiles.html @@ -0,0 +1,404 @@ + + + + + + IJobFiles | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IJobFiles

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+

{ _class as class }

+
+
interface
+

IJobFiles

+
+
+
+
+
+

Hierarchy

+
    +
  • + IJobFiles +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

_class

+
_class: string
+ +
+
+

Class that is assigned to the spool file.

+
+
+
export
+

{ _class as class }

+
+
memberof
+

IJobFiles

+
+
+
+
+
+ +

byte-count

+
byte-count: number
+ +
+
+

Number of bytes on spool that is consumed by the spool file.

+
+
+
memberof
+

IJobFiles

+
+
+
+
+
+ +

ddname

+
ddname: string
+ +
+
+

DDNAME for the data set creation.

+
+
+
memberof
+

IJobFiles

+
+
+
+
+
+ +

id

+
id: number
+ +
+
+

Data set number (key).

+
+
+
memberof
+

IJobFiles

+
+
+
+
+
+ +

Optional procstep

+
procstep: string
+ +
+
+

Procedure name for the step that created this data set.

+
+
+
memberof
+

IJobFiles

+
+
+
+
+
+ +

record-count

+
record-count: number
+ +
+
+

Number of records in the spool file.

+
+
+
memberof
+

IJobFiles

+
+
+
+
+
+ +

Optional stepname

+
stepname: string
+ +
+
+

Step name for the step that created this data set.

+
+
+
memberof
+

IJobFiles

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobinfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobinfo.html new file mode 100644 index 0000000000..df28691cf1 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobinfo.html @@ -0,0 +1,280 @@ + + + + + + IJobInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IJobInfo

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IJobInfo

+
+
+
+
+
+

Hierarchy

+
    +
  • + IJobInfo +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

jobfiles

+
jobfiles: IJobFiles
+ +
+
+

Contains an array of one or more objects with details about files created by the job.

+
+
+
memberof
+

IJobInfo

+
+
+
+
+
+ +

Optional jobstatus

+
jobstatus: IJobStatus
+ +
+
+

Contains the jobstatus object, which contains details about the job.

+
+
+
memberof
+

IJobInfo

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobstatus.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobstatus.html new file mode 100644 index 0000000000..7c00f578f6 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ijobstatus.html @@ -0,0 +1,428 @@ + + + + + + IJobStatus | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IJobStatus

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+

{ _class as class }

+
+
interface
+

IJobStatus

+
+
+
+
+
+

Hierarchy

+
    +
  • + IJobStatus +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

_class

+
_class: string
+ +
+
+

Job execution class.

+
+
+
export
+

{ _class as class }

+
+
memberof
+

IJobStatus

+
+
+
+
+
+ +

jobid

+
jobid: string
+ +
+
+

Job identifier.

+
+
+
memberof
+

IJobStatus

+
+
+
+
+
+ +

jobname

+
jobname: string
+ +
+
+

Job name.

+
+
+
memberof
+

IJobStatus

+
+
+
+
+
+ +

owner

+
owner: string
+ +
+
+

User ID associated with the job.

+
+
+
memberof
+

IJobStatus

+
+
+
+
+
+ +

Optional retcode

+
retcode: string
+ +
+
+

Job completion code.

+
+
+
memberof
+

IJobStatus

+
+
+
+
+
+ +

Optional status

+
status: string
+ +
+
+

Job status.

+
+
+
memberof
+

IJobStatus

+
+
+
+
+
+ +

Optional subsystem

+
subsystem: string
+ +
+
+

The primary or secondary JES subsystem.

+
+
+
memberof
+

IJobStatus

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

Job type.

+
+
+
memberof
+

IJobStatus

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ipropertymapping.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ipropertymapping.html new file mode 100644 index 0000000000..aa3dcd04fc --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ipropertymapping.html @@ -0,0 +1,280 @@ + + + + + + IPropertyMapping | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IPropertyMapping

+
+
+
+
+
+
+
+
+
+

Interface for variable objects.

+
+
+
export
+
+
interface
+

IPropertyMapping

+
+
+
+
+
+

Hierarchy

+
    +
  • + IPropertyMapping +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

mapFrom

+
mapFrom: string
+ +
+
+

Property from REST req.

+
+
+
memberof
+

IPropertyMapping

+
+
+
+
+
+ +

mapTo

+
mapTo: string
+ +
+
+

Assigned workflow variable.

+
+
+
memberof
+

IPropertyMapping

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istartworkflow.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istartworkflow.html new file mode 100644 index 0000000000..179a8b21e1 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istartworkflow.html @@ -0,0 +1,306 @@ + + + + + + IStartWorkflow | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IStartWorkflow

+
+
+
+
+
+
+
+
+
+

Interface for starting workflow instance.

+
+
+
export
+
+
interface
+

IStartWorkflow

+
+
+
+
+
+

Hierarchy

+
    +
  • + IStartWorkflow +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional performSubsequent

+
performSubsequent: boolean
+ +
+
+

Perform subsequent steps.

+
+
+
memberof
+

IStartWorkflow

+
+
+
+
+
+ +

Optional resolveConflictByUsing

+
resolveConflictByUsing: startT
+ +
+
+

Resolve conflicts by using output file, + already existing value or leave the + conflict to be handled manually.

+
+
+
memberof
+

IStartWorkflow

+
+
+
+
+
+ +

Optional stepName

+
stepName: string
+ +
+
+

Step name to be run.

+
+
+
memberof
+

IStartWorkflow

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istepapprovers.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istepapprovers.html new file mode 100644 index 0000000000..8bf7feda3e --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istepapprovers.html @@ -0,0 +1,280 @@ + + + + + + IStepApprovers | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IStepApprovers

+
+
+
+
+
+
+
+
+
+

Interface for Step approver object.

+
+
+
export
+
+
interface
+

IStepApprovers

+
+
+
+
+
+

Hierarchy

+
    +
  • + IStepApprovers +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

approver

+
approver: string
+ +
+
+

Id or ids separated by spaces

+
+
+
memberof
+

IStepApprovers

+
+
+
+
+
+ +

approverSub

+
approverSub: boolean
+ +
+
+

Whether in id is substitution.

+
+
+
memberof
+

IStepApprovers

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html new file mode 100644 index 0000000000..8f4fc120f2 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istepdefinition.html @@ -0,0 +1,1552 @@ + + + + + + IStepDefinition | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IStepDefinition

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IStepDefinition

+
+
+
+
+
+

Hierarchy

+
    +
  • + IStepDefinition +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional actualStatusCode

+
actualStatusCode: string
+ +
+
+

HTTP status code.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional approvers

+
approvers: IStepApprovers[]
+ +
+
+

Step approvers.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional autoEnable

+
autoEnable: boolean
+ +
+
+

Indicates whether the step can be performed automatically.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional calledWorkflowDefinitionFile

+
calledWorkflowDefinitionFile: string
+ +
+
+

Workflow definition file that is used to create a new workflow.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional calledWorkflowDescription

+
calledWorkflowDescription: string
+ +
+
+

Describes the workflow to be called.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional calledWorkflowID

+
calledWorkflowID: string
+ +
+
+

Workflow ID of a workflow definition file.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional calledWorkflowMD5

+
calledWorkflowMD5: string
+ +
+
+

128-bit hash value of a workflow definition file.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional calledWorkflowVersion

+
calledWorkflowVersion: string
+ +
+
+

Version of a workflow definition file.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional callingStepAutoEnable

+
callingStepAutoEnable: boolean
+ +
+
+

Indicates whether step can be performed auto.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional callingStepSkills

+
callingStepSkills: string
+ +
+
+

Indicates type of skill to execute the step.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional callingStepWeight

+
callingStepWeight: number
+ +
+
+

Indicates relative dificulty of the step.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

description

+
description: string
+ +
+
+

Step description.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional expectedStatusCode

+
expectedStatusCode: string
+ +
+
+

HTTP status code from the REST API request.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional failedPattern

+
failedPattern: string[]
+ +
+
+

Optional regular expression for program execution failures.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional hostname

+
hostname: string
+ +
+
+

Indicates the hostname or IP address.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional httpMethod

+
httpMethod: string
+ +
+
+

HTTP method that is used for issuing the REST API request.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional instructions

+
instructions: string
+ +
+
+

Instructions on what the user must do to perform the step.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional instructionsSub

+
instructionsSub: boolean
+ +
+
+

Indicates whether the step instructions contain variables.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional isConditionStep

+
isConditionStep: boolean
+ +
+
+

Indicates whether this step is a conditional step.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional isRestStep

+
isRestStep: boolean
+ +
+
+

Indicates whether this step is a REST API step.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional maxLrecl

+
maxLrecl: number
+ +
+
+

Specifies the maximum record length for a job.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

Name of the step.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

optional

+
optional: boolean
+ +
+
+

Indicates whether the step is optional.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional output

+
output: string
+ +
+
+

Name of the output file that is produced by the step.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional outputSub

+
outputSub: boolean
+ +
+
+

Indicates whether the output file name contains variable substitution.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional outputVariablesPrefix

+
outputVariablesPrefix: string
+ +
+
+

Contains a prefix that identifies a string as a variable.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional port

+
port: string
+ +
+
+

Port number that is associated with the REST request.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional portSub

+
portSub: boolean
+ +
+
+

Indicates whether the port number contains variable substitution.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional prereqStep

+
prereqStep: string[]
+ +
+
+

Lists the names of the steps that must be completed before this step.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional procName

+
procName: string
+ +
+
+

Name of the logon procedure that is used to log into the TSO/E.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional propertyMappings

+
propertyMappings: IPropertyMapping[]
+ +
+
+

Array of property mapping.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional queryParameters

+
queryParameters: string
+ +
+
+

Contains the query parameters.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional queryParametersSub

+
queryParametersSub: boolean
+ +
+
+

Indicates whether the query parameters contain variable substitution.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional regionSize

+
regionSize: string
+ +
+
+

Contains the region size for the TSO/E address space.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional requestBody

+
requestBody: string
+ +
+
+

Contains the request body.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional requestBodySub

+
requestBodySub: boolean
+ +
+
+

Indicates whether the request body variable substitution.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional saveAsDataset

+
saveAsDataset: string
+ +
+
+

Data set name that contains the saved JCL.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional saveAsDatasetSub

+
saveAsDatasetSub: boolean
+ +
+
+

Indicates whether the data set name contains variable substitution.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional saveAsUnixFile

+
saveAsUnixFile: string
+ +
+
+

UNIX file name (absolute name) that contains the saved JCL.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional saveAsUnixFileSub

+
saveAsUnixFileSub: boolean
+ +
+
+

Indicates whether the UNIX file name contains variable substitution.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional schemeName

+
schemeName: string
+ +
+
+

Name that is used for the REST request.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional schemeNameSub

+
schemeNameSub: boolean
+ +
+
+

Indicates whether the scheme name contains variable substitution.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional scriptParameters

+
scriptParameters: string[]
+ +
+
+

Contains the input parameters that can be set by the step owner.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional skills

+
skills: string
+ +
+
+

Type of skills that are required to perform the step.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional steps

+ + +
+
+

For a parent step, this is a nested array of step-definition objects.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional submitAs

+
submitAs: string
+ +
+
+

Indicates the type of executable program.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional successPattern

+
successPattern: string
+ +
+
+

Regular expression that is returned for a successful program execution.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional template

+
template: string
+ +
+
+

Indicates the template that is used to run a program or batch job.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional templateSub

+
templateSub: boolean
+ +
+
+

Indicates whether template contains variable substitution.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional timeout

+
timeout: string
+ +
+
+

contains the maximum amount of time that the program can run.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

title

+
title: string
+ +
+
+

Step title.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional uriPath

+
uriPath: string
+ +
+
+

The URI path to use for the REST request.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional uriPathSub

+
uriPathSub: boolean
+ +
+
+

Indicates whether the URI path contains variable substitution.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional variable-specifications

+
variable-specifications: IVariableSpecification[]
+ +
+
+

An array of variable-reference objects.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+ +

Optional weight

+
weight: number
+ +
+
+

The relative difficulty of the step compared to other steps.

+
+
+
memberof
+

IStepDefinition

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html new file mode 100644 index 0000000000..559476b2b0 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istepinfo.html @@ -0,0 +1,1749 @@ + + + + + + IStepInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IStepInfo

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IStepInfo

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional actualStatusCode

+
actualStatusCode: string
+ +
+
+

HTTP status code.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional assignees

+
assignees: string
+ +
+
+

Step assignees.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

autoEnable

+
autoEnable: boolean
+ +
+
+

Indicates whether the step can be performed automatically.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledInstanceKey

+
calledInstanceKey: string
+ +
+
+

Key of the called workflow instance.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledInstanceScope

+
calledInstanceScope: string
+ +
+
+

Scope of the called workflow instance.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledInstanceURI

+
calledInstanceURI: string
+ +
+
+

URI path of the called workflow instance.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledWorkflowDefinitionFile

+
calledWorkflowDefinitionFile: string
+ +
+
+

Workflow definition file that is used to create a new workflow.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledWorkflowDescription

+
calledWorkflowDescription: string
+ +
+
+

Describes the workflow to be called.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledWorkflowID

+
calledWorkflowID: string
+ +
+
+

Workflow ID of a workflow definition file.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledWorkflowMD5

+
calledWorkflowMD5: string
+ +
+
+

128-bit hash value of a workflow definition file.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledWorkflowVersion

+
calledWorkflowVersion: string
+ +
+
+

Version of a workflow definition file.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

description

+
description: string
+ +
+
+

Step description.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional expectedStatusCode

+
expectedStatusCode: string
+ +
+
+

HTTP status code from the REST API request.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional failedPattern

+
failedPattern: string[]
+ +
+
+

Optional regular expression for program execution failures.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional hasCalledWorkflow

+
hasCalledWorkflow: boolean
+ +
+
+

Indicates whether this step calls another workflow.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional hostname

+
hostname: string
+ +
+
+

Indicates the hostname or IP address.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional httpMethod

+
httpMethod: string
+ +
+
+

HTTP method that is used for issuing the REST API request.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional instructions

+
instructions: string
+ +
+
+

Instructions on what the user must do to perform the step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional instructionsSub

+
instructionsSub: boolean
+ +
+
+

Indicates whether the step instructions contain variables.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional isConditionStep

+
isConditionStep: boolean
+ +
+
+

Indicates whether this step is a conditional step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

isRestStep

+
isRestStep: boolean
+ +
+
+

Indicates whether this step is a REST API step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional jobInfo

+
jobInfo: IJobInfo
+ +
+
+

Contains the jobInfo object, which contains details about the job.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional maxLrecl

+
maxLrecl: number
+ +
+
+

Specifies the maximum record length for a job.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

Name of the step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

optional

+
optional: boolean
+ +
+
+

Indicates whether the step is optional.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional output

+
output: string
+ +
+
+

Name of the output file that is produced by the step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional outputSub

+
outputSub: boolean
+ +
+
+

Indicates whether the output file name contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional outputVariablesPrefix

+
outputVariablesPrefix: string
+ +
+
+

Contains a prefix that identifies a string as a variable.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional owner

+
owner: string
+ +
+
+

User ID of the step owner.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional port

+
port: string
+ +
+
+

Port number that is associated with the REST request.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional portSub

+
portSub: boolean
+ +
+
+

Indicates whether the port number contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional prereqStep

+
prereqStep: string[]
+ +
+
+

Lists the names of the steps that must be completed before this step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional procName

+
procName: string
+ +
+
+

Name of the logon procedure that is used to log into the TSO/E.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional queryParameters

+
queryParameters: string
+ +
+
+

Contains the query parameters.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional queryParametersSub

+
queryParametersSub: boolean
+ +
+
+

Indicates whether the query parameters contain variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional regionSize

+
regionSize: string
+ +
+
+

Contains the region size for the TSO/E address space.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional requestBody

+
requestBody: string
+ +
+
+

Contains the request body.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional requestBodySub

+
requestBodySub: boolean
+ +
+
+

Indicates whether the request body variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional returnCode

+
returnCode: string
+ +
+
+

Indicates the return code that was returned when the job was submitted.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

runAsUser

+
runAsUser: string
+ +
+
+

The user ID under which the step is to be performed.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional runAsUserDynamic

+
runAsUserDynamic: boolean
+ +
+
+

Indicates whether the runAsUser ID value can change.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional saveAsDataset

+
saveAsDataset: string
+ +
+
+

Data set name that contains the saved JCL.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional saveAsDatasetSub

+
saveAsDatasetSub: boolean
+ +
+
+

Indicates whether the data set name contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional saveAsUnixFile

+
saveAsUnixFile: string
+ +
+
+

UNIX file name (absolute name) that contains the saved JCL.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional saveAsUnixFileSub

+
saveAsUnixFileSub: boolean
+ +
+
+

Indicates whether the UNIX file name contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional schemeName

+
schemeName: string
+ +
+
+

Name that is used for the REST request.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional schemeNameSub

+
schemeNameSub: boolean
+ +
+
+

Indicates whether the scheme name contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional scriptParameters

+
scriptParameters: string[]
+ +
+
+

Contains the input parameters that can be set by the step owner.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional skills

+
skills: string
+ +
+
+

Type of skills that are required to perform the step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

state

+
state: string
+ +
+
+

State of the step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

stepNumber

+
stepNumber: string
+ +
+
+

The step number.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional steps

+
steps: IStepInfo[]
+ +
+
+

For a parent step, this is a nested array of step-info objects.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional submitAs

+
submitAs: string
+ +
+
+

Indicates the type of executable program.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional successPattern

+
successPattern: string
+ +
+
+

Regular expression that is returned for a successful program execution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional template

+
template: string
+ +
+
+

Indicates the template that is used to run a program or batch job.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional templateSub

+
templateSub: boolean
+ +
+
+

Indicates whether template contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional timeout

+
timeout: string
+ +
+
+

contains the maximum amount of time that the program can run.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

title

+
title: string
+ +
+
+

Step title.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional uriPath

+
uriPath: string
+ +
+
+

The URI path to use for the REST request.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional uriPathSub

+
uriPathSub: boolean
+ +
+
+

Indicates whether the URI path contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

userDefined

+
userDefined: boolean
+ +
+
+

Indicates whether the step was added manually to the workflow.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional variable-references

+
variable-references: IVariable[]
+ +
+
+

An array of variable-reference objects.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional weight

+
weight: number
+ +
+
+

The relative difficulty of the step compared to other steps.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html new file mode 100644 index 0000000000..93088af6cb --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.istepsummary.html @@ -0,0 +1,1837 @@ + + + + + + IStepSummary | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IStepSummary

+
+
+
+
+
+
+
+
+
+

Interface for the step summary

+
+
+
export
+
+
interface
+

IStepSummary

+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional actualStatusCode

+
actualStatusCode: string
+ +
+
+

HTTP status code.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional assignees

+
assignees: string
+ +
+
+

Step assignees.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

autoEnable

+
autoEnable: boolean
+ +
+
+

Indicates whether the step can be performed automatically.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledInstanceKey

+
calledInstanceKey: string
+ +
+
+

Key of the called workflow instance.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledInstanceScope

+
calledInstanceScope: string
+ +
+
+

Scope of the called workflow instance.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledInstanceURI

+
calledInstanceURI: string
+ +
+
+

URI path of the called workflow instance.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledWorkflowDefinitionFile

+
calledWorkflowDefinitionFile: string
+ +
+
+

Workflow definition file that is used to create a new workflow.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledWorkflowDescription

+
calledWorkflowDescription: string
+ +
+
+

Describes the workflow to be called.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledWorkflowID

+
calledWorkflowID: string
+ +
+
+

Workflow ID of a workflow definition file.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledWorkflowMD5

+
calledWorkflowMD5: string
+ +
+
+

128-bit hash value of a workflow definition file.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional calledWorkflowVersion

+
calledWorkflowVersion: string
+ +
+
+

Version of a workflow definition file.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

description

+
description: string
+ +
+
+

Step description.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional expectedStatusCode

+
expectedStatusCode: string
+ +
+
+

HTTP status code from the REST API request.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional failedPattern

+
failedPattern: string[]
+ +
+
+

Optional regular expression for program execution failures.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional hasCalledWorkflow

+
hasCalledWorkflow: boolean
+ +
+
+

Indicates whether this step calls another workflow.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional hostname

+
hostname: string
+ +
+
+

Indicates the hostname or IP address.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional httpMethod

+
httpMethod: string
+ +
+
+

HTTP method that is used for issuing the REST API request.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional instructions

+
instructions: string
+ +
+
+

Instructions on what the user must do to perform the step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional instructionsSub

+
instructionsSub: boolean
+ +
+
+

Indicates whether the step instructions contain variables.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional isConditionStep

+
isConditionStep: boolean
+ +
+
+

Indicates whether this step is a conditional step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

isRestStep

+
isRestStep: boolean
+ +
+
+

Indicates whether this step is a REST API step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional jobInfo

+
jobInfo: IJobInfo
+ +
+
+

Contains the jobInfo object, which contains details about the job.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional maxLrecl

+
maxLrecl: number
+ +
+
+

Specifies the maximum record length for a job.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional misc

+
misc: string
+ +
+
+

Depends on the type of the step. + It can contain JOBID, REST response, etc

+
+
+
memberof
+

IStepSummary

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

Step name

+
+
+
memberof
+

IStepSummary

+
+
+
+
+
+ +

optional

+
optional: boolean
+ +
+
+

Indicates whether the step is optional.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional output

+
output: string
+ +
+
+

Name of the output file that is produced by the step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional outputSub

+
outputSub: boolean
+ +
+
+

Indicates whether the output file name contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional outputVariablesPrefix

+
outputVariablesPrefix: string
+ +
+
+

Contains a prefix that identifies a string as a variable.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional owner

+
owner: string
+ +
+
+

User ID of the step owner.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional port

+
port: string
+ +
+
+

Port number that is associated with the REST request.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional portSub

+
portSub: boolean
+ +
+
+

Indicates whether the port number contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional prereqStep

+
prereqStep: string[]
+ +
+
+

Lists the names of the steps that must be completed before this step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional procName

+
procName: string
+ +
+
+

Name of the logon procedure that is used to log into the TSO/E.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional queryParameters

+
queryParameters: string
+ +
+
+

Contains the query parameters.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional queryParametersSub

+
queryParametersSub: boolean
+ +
+
+

Indicates whether the query parameters contain variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional regionSize

+
regionSize: string
+ +
+
+

Contains the region size for the TSO/E address space.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional requestBody

+
requestBody: string
+ +
+
+

Contains the request body.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional requestBodySub

+
requestBodySub: boolean
+ +
+
+

Indicates whether the request body variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional returnCode

+
returnCode: string
+ +
+
+

Indicates the return code that was returned when the job was submitted.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

runAsUser

+
runAsUser: string
+ +
+
+

The user ID under which the step is to be performed.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional runAsUserDynamic

+
runAsUserDynamic: boolean
+ +
+
+

Indicates whether the runAsUser ID value can change.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional saveAsDataset

+
saveAsDataset: string
+ +
+
+

Data set name that contains the saved JCL.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional saveAsDatasetSub

+
saveAsDatasetSub: boolean
+ +
+
+

Indicates whether the data set name contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional saveAsUnixFile

+
saveAsUnixFile: string
+ +
+
+

UNIX file name (absolute name) that contains the saved JCL.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional saveAsUnixFileSub

+
saveAsUnixFileSub: boolean
+ +
+
+

Indicates whether the UNIX file name contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional schemeName

+
schemeName: string
+ +
+
+

Name that is used for the REST request.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional schemeNameSub

+
schemeNameSub: boolean
+ +
+
+

Indicates whether the scheme name contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional scriptParameters

+
scriptParameters: string[]
+ +
+
+

Contains the input parameters that can be set by the step owner.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional skills

+
skills: string
+ +
+
+

Type of skills that are required to perform the step.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

state

+
state: string
+ +
+
+

State of the step

+
+
+
memberof
+

IStepSummary

+
+
+
+
+
+ +

stepNumber

+
stepNumber: string
+ +
+
+

ID of the step

+
+
+
memberof
+

IStepSummary

+
+
+
+
+
+ +

Optional steps

+
steps: IStepInfo[]
+ +
+
+

For a parent step, this is a nested array of step-info objects.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional submitAs

+
submitAs: string
+ +
+
+

Indicates the type of executable program.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional successPattern

+
successPattern: string
+ +
+
+

Regular expression that is returned for a successful program execution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional template

+
template: string
+ +
+
+

Indicates the template that is used to run a program or batch job.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional templateSub

+
templateSub: boolean
+ +
+
+

Indicates whether template contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional timeout

+
timeout: string
+ +
+
+

contains the maximum amount of time that the program can run.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

title

+
title: string
+ +
+
+

Step title.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional uriPath

+
uriPath: string
+ +
+
+

The URI path to use for the REST request.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional uriPathSub

+
uriPathSub: boolean
+ +
+
+

Indicates whether the URI path contains variable substitution.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

userDefined

+
userDefined: boolean
+ +
+
+

Indicates whether the step was added manually to the workflow.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional variable-references

+
variable-references: IVariable[]
+ +
+
+

An array of variable-reference objects.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+ +

Optional weight

+
weight: number
+ +
+
+

The relative difficulty of the step compared to other steps.

+
+
+
memberof
+

IStepInfo

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariable.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariable.html new file mode 100644 index 0000000000..eaf148ce1f --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariable.html @@ -0,0 +1,280 @@ + + + + + + IVariable | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IVariable

+
+
+
+
+
+
+
+
+
+

Interface for variable objects.

+
+
+
export
+
+
interface
+

IVariable

+
+
+
+
+
+

Hierarchy

+
    +
  • + IVariable +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+

Name of the variable.

+
+
+
memberof
+

IVariable

+
+
+
+
+
+ +

value

+
value: string
+ +
+
+

Value of the variable.

+
+
+
memberof
+

IVariable

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html new file mode 100644 index 0000000000..27a443f7ed --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariabledefinition.html @@ -0,0 +1,688 @@ + + + + + + IVariableDefinition | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IVariableDefinition

+
+
+
+
+
+
+
+
+
+

Interface for variable definition object.

+
+
+
export
+
+
interface
+

IVariableDefinition

+
+
+
+
+
+

Hierarchy

+
    +
  • + IVariableDefinition +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

abstract

+
abstract: string
+ +
+
+

Brief description of variable.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

category

+
category: string
+ +
+
+

Name of logical variable group.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

choice

+
choice: string[]
+ +
+
+

Choice value.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

decimalPlaces

+
decimalPlaces: number
+ +
+
+

Maximum number of decimal places.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

default

+
default: string
+ +
+
+

Default value of variable.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

description

+
description: string
+ +
+
+

Description of variable.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

exposeToUser

+
exposeToUser: boolean
+ +
+
+

Whether variable displayed.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

maxLength

+
maxLength: number
+ +
+
+

Maximum length of variable value.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

maxValue

+
maxValue: string
+ +
+
+

Maximum value of variable.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

minLength

+
minLength: number
+ +
+
+

Minimum length of variable value.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

minValue

+
minValue: string
+ +
+
+

Minimum value of variable.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

name

+
name: string
+ +
+
+

Name of the variable.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

promptAtCreate

+
promptAtCreate: boolean
+ +
+
+

Whether variable is prompted at create.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

regularExpression

+
regularExpression: string
+ +
+
+

Standard regular expression.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

requiredAtCreate

+
requiredAtCreate: boolean
+ +
+
+

Whether variable must be specified.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

scope

+
scope: string
+ +
+
+

Variable scope.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

Type of variable.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

validationType

+
validationType: string
+ +
+
+

Validation type of variable.

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+ +

visibility

+
visibility: string
+ +
+
+

Indicates if display variable to Workflows users (public or private).

+
+
+
memberof
+

IVariableDefinition

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariableinfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariableinfo.html new file mode 100644 index 0000000000..5dca2a3edf --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariableinfo.html @@ -0,0 +1,352 @@ + + + + + + IVariableInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IVariableInfo

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IVariableInfo

+
+
+
+
+
+

Hierarchy

+
    +
  • + IVariableInfo +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+

Name of variable.

+
+
+
memberof
+

IVariableInfo

+
+
+
+
+
+ +

scope

+
scope: string
+ +
+
+

Variable scope.

+
+
+
memberof
+

IVariableInfo

+
+
+
+
+
+ +

type

+
type: string
+ +
+
+

Variable type.

+
+
+
memberof
+

IVariableInfo

+
+
+
+
+
+ +

value

+
value: string
+ +
+
+

Variable value.

+
+
+
memberof
+

IVariableInfo

+
+
+
+
+
+ +

visibility

+
visibility: string
+ +
+
+

Variable visibility (public|private).

+
+
+
memberof
+

IVariableInfo

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariablespecification.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariablespecification.html new file mode 100644 index 0000000000..5bf07af066 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.ivariablespecification.html @@ -0,0 +1,304 @@ + + + + + + IVariableSpecification | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IVariableSpecification

+
+
+
+
+
+
+
+
+
+

Interface for variable-specification object.

+
+
+
export
+
+
interface
+

IVariableSpecification

+
+
+
+
+
+

Hierarchy

+
    +
  • + IVariableSpecification +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+

Name of the variable.

+
+
+
memberof
+

IVariableSpecification

+
+
+
+
+
+ +

required

+
required: boolean
+ +
+
+

Indicates if is variable required.

+
+
+
memberof
+

IVariableSpecification

+
+
+
+
+
+ +

scope

+
scope: string
+ +
+
+

Variable scope.

+
+
+
memberof
+

IVariableSpecification

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html new file mode 100644 index 0000000000..0e782215bc --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowdefinition.html @@ -0,0 +1,592 @@ + + + + + + IWorkflowDefinition | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IWorkflowDefinition

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IWorkflowDefinition

+
+
+
+
+
+

Hierarchy

+
    +
  • + IWorkflowDefinition +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

category

+
category: string
+ +
+
+

Category of workflow.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

Optional containsParallelSteps

+
containsParallelSteps: boolean
+ +
+
+

Indicates if workflow steps can run in parallel.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

isCallable

+
isCallable: boolean
+ +
+
+

Indicates if workflow can be called by other workflow.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

productID

+
productID: string
+ +
+
+

Identifier of product configured via workflow.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

productName

+
productName: string
+ +
+
+

Name of the product configured via workflow.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

productVersion

+
productVersion: string
+ +
+
+

Version of the product configured via workflow.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

scope

+
scope: string
+ +
+
+

Restrict a workflow to one instance only.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

Optional steps

+ + +
+
+

Aray of one or more step-definition objects.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

Optional variables

+
variables: IVariableDefinition[]
+ +
+
+

Aray of one or more variable-definition objects.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

vendor

+
vendor: string
+ +
+
+

Name of the vendor.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

workflowDefaultName

+
workflowDefaultName: string
+ +
+
+

Identifies workflow default name.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

workflowDefinitionFileMD5Value

+
workflowDefinitionFileMD5Value: string
+ +
+
+

128bit hash associated with definition file.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

workflowDescription

+
workflowDescription: string
+ +
+
+

Description of workflow.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

workflowID

+
workflowID: string
+ +
+
+

Short ID that identifies the workflow.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+ +

workflowVersion

+
workflowVersion: string
+ +
+
+

Version of the workflow definition file.

+
+
+
memberof
+

IWorkflowDefinition

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html new file mode 100644 index 0000000000..d5a2407381 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowinfo.html @@ -0,0 +1,1024 @@ + + + + + + IWorkflowInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IWorkflowInfo

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IWorkflowsInfo

+
+
+
+
+
+

Hierarchy

+
    +
  • + IWorkflowInfo +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional access

+
access: string
+ +
+
+

Workflow's access type.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional accountInfo

+
accountInfo: string
+ +
+
+

Account info in JCL JOB.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional actionID

+
actionID: string
+ +
+
+

Action ID for the action object.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional automationStatus

+
automationStatus: IAutomationStatus
+ +
+
+

Details about most recent start request.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional category

+
category: string
+ +
+
+

Category of workflow.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional containsParallelSteps

+
containsParallelSteps: boolean
+ +
+
+

Indicates if workflow steps can run in parallel.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional deleteCompletedJobs

+
deleteCompletedJobs: boolean
+ +
+
+

JOB delete after successfull complete.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional domainID

+
domainID: string
+ +
+
+

Template domain ID.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional isCallable

+
isCallable: boolean
+ +
+
+

Indicates if workflow can be called by other workflow.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional jobStatement

+
jobStatement: string
+ +
+
+

JOB statement in JCL JOB.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional owner

+
owner: string
+ +
+
+

User ID of the workflow owner.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional parentRegistryID

+
parentRegistryID: string
+ +
+
+

ID of software instance parent registry.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional percentComplete

+
percentComplete: number
+ +
+
+

Percentage of the product configured via workflow.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional productID

+
productID: string
+ +
+
+

Identifier of product configured via workflow.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional productName

+
productName: string
+ +
+
+

Name of the product configured via workflow.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional productVersion

+
productVersion: string
+ +
+
+

Version of the product configured via workflow.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional registryID

+
registryID: string
+ +
+
+

ID of software service registry.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional scope

+
scope: string
+ +
+
+

Restrict a workflow to one instance only.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional softwareServiceInstanceName

+
softwareServiceInstanceName: string
+ +
+
+

Created software instance name.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional statusName

+
statusName: string
+ +
+
+

Current workflow status.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional steps

+
steps: IStepInfo[]
+ +
+
+

Aray of one or more step-info object.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional system

+
system: string
+ +
+
+

Full name of z/OS system.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional templateID

+
templateID: string
+ +
+
+

Uniq identifier for the template.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional templateName

+
templateName: string
+ +
+
+

Name of the template.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional tenantID

+
tenantID: string
+ +
+
+

ID of the tenant in resource pool.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional variables

+
variables: IVariableInfo[]
+ +
+
+

Aray of one or more variable-info object.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional vendor

+
vendor: string
+ +
+
+

Name of the vendor.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional workflowDefinitionFileMD5Value

+
workflowDefinitionFileMD5Value: string
+ +
+
+

128bit hash associated with definition file.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional workflowDescription

+
workflowDescription: string
+ +
+
+

Description of workflow.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional workflowID

+
workflowID: string
+ +
+
+

Short ID that identifies the workflow.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional workflowKey

+
workflowKey: string
+ +
+
+

Unique workflow key generated by z/OSMF.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional workflowName

+
workflowName: string
+ +
+
+

Unique workflow name.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+ +

Optional workflowVersion

+
workflowVersion: string
+ +
+
+

Version of the workflow definition file.

+
+
+
memberof
+

IWorkflowInfo

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflows.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflows.html new file mode 100644 index 0000000000..0045772adf --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflows.html @@ -0,0 +1,232 @@ + + + + + + IWorkflows | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IWorkflows

+
+
+
+ +
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html new file mode 100644 index 0000000000..b97eb863ee --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zos_workflows_for_zowe_sdk.iworkflowsinfo.html @@ -0,0 +1,496 @@ + + + + + + IWorkflowsInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IWorkflowsInfo

+
+
+
+
+
+
+
+
+
+

Interface for z/OSMF API response.

+
+
+
export
+
+
interface
+

IWorkflowsInfo

+
+
+
+
+
+

Hierarchy

+
    +
  • + IWorkflowsInfo +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional archivedInstanceURI

+
archivedInstanceURI: string
+ +
+
+

Indicates the URI of archived workflow.

+
+
+
memberof
+

IWorkflowsInfo

+
+
+
+
+
+ +

Optional category

+
category: string
+ +
+
+

The category of the software workflow.

+
+
+
memberof
+

IWorkflowsInfo

+
+
+
+
+
+ +

Optional owner

+
owner: string
+ +
+
+

The user ID that identifies the owner of the software.

+
+
+
memberof
+

IWorkflowsInfo

+
+
+
+
+
+ +

Optional statusName

+
statusName: string
+ +
+
+

Indicates the current workflow status.

+
+
+
memberof
+

IWorkflowsInfo

+
+
+
+
+
+ +

Optional system

+
system: string
+ +
+
+

Nickname of the system on which the workflow is to be performed.

+
+
+
memberof
+

IWorkflowsInfo

+
+
+
+
+
+ +

Optional vendor

+
vendor: string
+ +
+
+

The vendor of the software.

+
+
+
memberof
+

IWorkflowsInfo

+
+
+
+
+
+ +

Optional workflowDescription

+
workflowDescription: string
+ +
+
+

Description of the workflow.

+
+
+
memberof
+

IWorkflowsInfo

+
+
+
+
+
+ +

Optional workflowID

+
workflowID: string
+ +
+
+

Short ID that identifies the workflow.

+
+
+
memberof
+

IWorkflowsInfo

+
+
+
+
+
+ +

Optional workflowKey

+
workflowKey: string
+ +
+
+

Unique workflow key.

+
+
+
memberof
+

IWorkflowsInfo

+
+
+
+
+
+ +

Optional workflowName

+
workflowName: string
+ +
+
+

Descriptive name for the workflow.

+
+
+
memberof
+

IWorkflowsInfo

+
+
+
+
+
+ +

Optional workflowVersion

+
workflowVersion: string
+ +
+
+

Version of the workflow.

+
+
+
memberof
+

IWorkflowsInfo

+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html b/static/v2.15.x/typedoc/interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html new file mode 100644 index 0000000000..c14b52e8c7 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zosmf_for_zowe_sdk.idefinedsystem.html @@ -0,0 +1,493 @@ + + + + + + IDefinedSystem | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IDefinedSystem

+
+
+
+
+
+
+
+
+
+

The Z/OSMF object returned for every defined system.

+
+
+
export
+
+
interface
+

IDefinedSystem

+
+
+
+
+
+

Hierarchy

+
    +
  • + IDefinedSystem +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional cpcName

+
cpcName: string
+ +
+
+

Name specified for the central processor complex (CPC) at the support element (SE) of that processor complex.

+
+
+
+
+ +

Optional cpcSerial

+
cpcSerial: string
+ +
+
+

Serial number of the CPC.

+
+
+
+
+ +

Optional ftpDestinationName

+
ftpDestinationName: string
+ +
+
+

Name of the server definition that specifies the settings required to access the FTP or SFTP server that is running on the system.

+
+
+
+
+ +

Optional groupNames

+
groupNames: string
+ +
+
+

Comma-separated list of the groups to which the system is assigned.

+
+
+
+
+ +

Optional httpProxyName

+
httpProxyName: string
+ +
+
+

Name of the HTTP proxy definition that specifies the settings required to access the system through an HTTP or SOCKS proxy server.

+
+
+
+
+ +

Optional jesMemberName

+
jesMemberName: string
+ +
+
+

JES2 multi-access spool (MAS) member name or JES3 complex member name

+
+
+
+
+ +

Optional jesType

+
jesType: string
+ +
+
+

Type for the primary job entry subsystem running on the system. The type is either JES2 or JES3.

+
+
+
+
+ +

Optional sysplexName

+
sysplexName: string
+ +
+
+

Name of the sysplex where the z/OS system is a member.

+
+
+
+
+ +

Optional systemName

+
systemName: string
+ +
+
+

Name specified for the system on the SYSNAME parameter in the IEASYSxx parmlib member.

+
+
+
+
+ +

Optional systemNickName

+
systemNickName: string
+ +
+
+

Unique name assigned to the system definition.

+
+
+
+
+ +

Optional url

+
url: string
+ +
+
+

URL used to access the z/OSMF instance that resides in the same sysplex as the system identified by the systemName attribute.

+
+
+
+
+ +

Optional zosVR

+
zosVR: string
+ +
+
+

Version of z/OS

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zosmf_for_zowe_sdk.izosmfinforesponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zosmf_for_zowe_sdk.izosmfinforesponse.html new file mode 100644 index 0000000000..c28fc355a4 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zosmf_for_zowe_sdk.izosmfinforesponse.html @@ -0,0 +1,377 @@ + + + + + + IZosmfInfoResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosmfInfoResponse

+
+
+
+
+
+
+
+
+
+

The Z/OSMF info API response.

+
+
+
export
+
+
interface
+

IZosmfInfoResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IZosmfInfoResponse +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: string
+ +
+
+ +

Optional plugins

+
plugins: [IZosmfPluginInfo]
+ +
+
+ +

Optional zos_version

+
zos_version: string
+ +
+
+ +

Optional zosmf_full_version

+
zosmf_full_version: string
+ +
+
+ +

Optional zosmf_hostname

+
zosmf_hostname: string
+ +
+
+ +

Optional zosmf_port

+
zosmf_port: string
+ +
+
+ +

Optional zosmf_saf_realm

+
zosmf_saf_realm: string
+ +
+
+ +

Optional zosmf_version

+
zosmf_version: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zosmf_for_zowe_sdk.izosmflistdefinedsystemsresponse.html b/static/v2.15.x/typedoc/interfaces/_zowe_zosmf_for_zowe_sdk.izosmflistdefinedsystemsresponse.html new file mode 100644 index 0000000000..e3d901ffb1 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zosmf_for_zowe_sdk.izosmflistdefinedsystemsresponse.html @@ -0,0 +1,303 @@ + + + + + + IZosmfListDefinedSystemsResponse | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosmfListDefinedSystemsResponse

+
+
+
+
+
+
+
+
+
+

API response for list systems defined to z/OSMF.

+
+
+
export
+
+
interface
+

IZosmfInfoResponse

+
+
+
+
+
+

Hierarchy

+
    +
  • + IZosmfListDefinedSystemsResponse +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

items

+ + +
+
+

Properties of each defined system.

+
+
+
+
+ +

numRows

+
numRows: number
+ +
+
+

Total items returned.

+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/interfaces/_zowe_zosmf_for_zowe_sdk.izosmfplugininfo.html b/static/v2.15.x/typedoc/interfaces/_zowe_zosmf_for_zowe_sdk.izosmfplugininfo.html new file mode 100644 index 0000000000..20d051bcc5 --- /dev/null +++ b/static/v2.15.x/typedoc/interfaces/_zowe_zosmf_for_zowe_sdk.izosmfplugininfo.html @@ -0,0 +1,307 @@ + + + + + + IZosmfPluginInfo | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface IZosmfPluginInfo

+
+
+
+
+
+
+
+
+
+

The plugin information structure for plugin property of the z/OSMF info response

+
+
+
export
+
+
interface
+

IZosmfPluginInfo

+
+
+
+
+
+

Hierarchy

+
    +
  • + IZosmfPluginInfo +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional pluginDefaultName

+
pluginDefaultName: string
+ +
+
+ +

Optional pluginStatus

+
pluginStatus: string
+ +
+
+ +

Optional pluginVersion

+
pluginVersion: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
  • Property
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/modules/_zowe_core_for_zowe_sdk.html b/static/v2.15.x/typedoc/modules/_zowe_core_for_zowe_sdk.html new file mode 100644 index 0000000000..5a69ecb0f8 --- /dev/null +++ b/static/v2.15.x/typedoc/modules/_zowe_core_for_zowe_sdk.html @@ -0,0 +1,729 @@ + + + + + + @zowe/core-for-zowe-sdk | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @zowe/core-for-zowe-sdk

+
+
+
+
+
+
+
+
+ +

Core package

+
+

The Zowe SDK Core package contains functionality that is shared across all other SDK packages, such as @zowe/zos-files-for-zowe-sdk.

+

Important! You must install the Core package to satisfy the peer dependency requirement for all other SDK packages.

+ +

Core libraries

+
+

The following libraries are included in this package:

+
    +
  • apiml - Defines the Services class, which facilitates managing services hosted by the Zowe API Mediation Layer. It defines methods to load API ML config data for installed CLI plug-ins, obtain data from the API ML services endpoint, and convert this data to a config JSON file.

    +
  • +
  • auth - Contains the Login and Logout classes, which let you handle login and logout from the Zowe API Mediation Layer (or other token-based authentication services). Use the functions Login.apimlLogin and Logout.apimlLogout to store a web token in a local "base profile", which enables a secure connection to the server.

    +
  • +
  • rest - Defines the ZosmfRestClient class, which lets you access z/OSMF REST APIs and is an extension of the Imperative CLI Framework RestClient class. It provides convenience methods, such as appendHeaders and processError, that can be used for any z/OSMF request.

    +
  • +
  • utils - Contains miscellaneous utility methods, such as ProfileUtils.loadDefaultProfile, which automatically loads the username, host, port, etc... that is defined in your default profile configuration. To learn about all available utilities, refer to the comments in the core/utils source code.

    +
  • +
+
+
+
+

Index

+
+ +
+
+
+

Functions

+
+ +

asyncPool

+
    +
  • asyncPool(poolLimit: number, array: any[], iteratorFn: (item: any, array: any[]) => Promise<any>): Promise<any>
  • +
+
    +
  • + +
    +
    +

    Execute multiple promises in a pool with a maximum number of promises + executing at once

    +
    +
    +

    Parameters

    +
      +
    • +
      poolLimit: number
      +
      +

      limit of how many promises should execute at once

      +
      +
    • +
    • +
      array: any[]
      +
      +

      array of objects to convert to promises with iteratorFn

      +
      +
    • +
    • +
      iteratorFn: (item: any, array: any[]) => Promise<any>
      +
      +

      the function that turns an entry in the array into a promise

      +
      +
        +
      • +
          +
        • (item: any, array: any[]): Promise<any>
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            item: any
            +
          • +
          • +
            array: any[]
            +
          • +
          +

          Returns Promise<any>

          +
        • +
        +
      • +
      +
    • +
    +

    Returns Promise<any>

    +
  • +
+
+
+ +

getDefaultProfile

+
    +
  • getDefaultProfile(profileType: string, mergeWithBase?: boolean): Promise<any>
  • +
+
    +
  • + +
    +
    +

    Loads default z/OSMF profile. The profile must have already been + created using Zowe CLI, and not rely on base profiles

    +
    +
    +

    Parameters

    +
      +
    • +
      profileType: string
      +
      +

      The name of the profile type

      +
      +
    • +
    • +
      Optional mergeWithBase: boolean
      +
      +

      Whether or not to merge with the base profile

      +
      +
    • +
    +

    Returns Promise<any>

    +
      +
    • The default profile (or merged profile, if requested)
    • +
    +
  • +
+
+
+ +

getErrorContext

+
    +
  • getErrorContext(content: string | string[], lineIndex: number): string
  • +
+
    +
  • + +
    +
    +

    Produces formatted context of a given error in the specified location of the contents

    +
    +

    NOTE: + The lineIndex is zero-based indexed

    +
    +

    Parameters

    +
      +
    • +
      content: string | string[]
      +
      +

      Indicates the contents or the file path to the file containing the contents to get the error from

      +
      +
    • +
    • +
      lineIndex: number
      +
      +

      Zero-basd indexed location of the error to be printed

      +
      +
    • +
    +

    Returns string

    +

    Few lines (separated by \n) containing error context

    +
  • +
+
+
+ +

getZoweDir

+
    +
  • getZoweDir(): string
  • +
+
    +
  • + +
    +
    +

    Retrieves the Zowe CLI home directory. In the situation Imperative has + not initialized it we mock a default value.

    +
    +
    +

    Returns string

    +
      +
    • Returns the Zowe home directory
    • +
    +
  • +
+
+
+ +

padLeft

+
    +
  • padLeft(str: string, len: number, padChar?: string): string
  • +
+
    +
  • + +
    +
    +

    Adds padding in case you want a longer string.

    +
    +
    +

    Parameters

    +
      +
    • +
      str: string
      +
      +

      string to add the padding to

      +
      +
    • +
    • +
      len: number
      +
      +

      final length of the padded string

      +
      +
    • +
    • +
      Default value padChar: string = " "
      +
    • +
    +

    Returns string

    +

    Padded string

    +
  • +
+
+
+ +

readStdin

+ + +
+
+ +

sleep

+
    +
  • sleep(ms?: number): Promise<void>
  • +
+
    +
  • + +
    +
    +

    This is a simple sleep function to help when waiting for a certain period of + time before continuing.

    +
    +
    +
    example
    +
    Sleeping within code +

    async function doStuff() { + await CoreUtils.sleep(10000); + console.log("You will see this message 10 seconds after function was entered"); + }

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      Default value ms: number = 1000
      +
    • +
    +

    Returns Promise<void>

    +

    Resolves after the specified time is up.

    +
  • +
+
+
+ +

trimLineToTerminalWidth

+
    +
  • trimLineToTerminalWidth(str: string): string
  • +
+
    +
  • + +
    +
    +

    Trims a given line based on the terminal's width. It also replaces tabs with spaces.

    +
    +
    +

    Parameters

    +
      +
    • +
      str: string
      +
      +

      string to be trimmed

      +
      +
    • +
    +

    Returns string

    +

    Trimmed string

    +
  • +
+
+
+
+

Object literals

+
+ +

Const noSession

+
noSession: object
+ +
+
+

Error message that no session was supplied.

+
+
+
static
+
+
memberof
+

CommonConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No session was supplied.`
+ +
+
+
+ +

Const nozOSMFVersion

+
nozOSMFVersion: object
+ +
+
+

Error message that no z/OSMF version parameter string was supplied.

+
+
+
static
+
+
memberof
+

CommonConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No z/OSMF version parameter was supplied.`
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/modules/_zowe_imperative.html b/static/v2.15.x/typedoc/modules/_zowe_imperative.html new file mode 100644 index 0000000000..cd2546b142 --- /dev/null +++ b/static/v2.15.x/typedoc/modules/_zowe_imperative.html @@ -0,0 +1,7645 @@ + + + + + + @zowe/imperative | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @zowe/imperative

+
+
+
+
+
+
+
+
+ +

Imperative CLI Framework

+
+

codecov + OpenSSF Best Practices

+

Imperative CLI Framework is a command processing system that lets you quickly build customized command-line interfaces. Focus on adding functionality for your users rather than creating CLI infrastructure. We provide you with all the tools to get started building your own CLI plug-ins.

+ +

Software Requirements

+
+
    +
  • Install Node.js package manager on your computer. Node.js® is a JavaScript runtime environment on which we architected Imperative CLI Framework.

    +
  • +
  • You must have a means to execute ".sh" (bash) scripts to run integration tests. On Windows, you can install "Git Bash", which is bundled with the standard Git installation - (choose the "Use Git and Unix Tools from Windows Command Prompt" installation option). When you run the integration tests on Windows, you must have Administrative authority to enable the integration tests to create symbolic links.

    +
  • +
+

Note: Broadcom Inc. does not maintain the prerequisite software that Imperative CLI Framework requires. You are responsible for updating Node.js and other prerequisites on your computer. We recommend that you update Node.js regularly to the latest Long Term Support (LTS) version.

+ +

Install Imperative as a Dependency

+
+

Issue the following commands to install Imperative CLI Framework as a dependency.

+
    +
  • Install @latest version:

    +

    Be aware that if you update via @latest, you accept breaking changes into your project.

    +
    npm install @zowe/imperative
    +
    +
  • +
  • Install @zowe-v2-lts version:

    +

    This is a Long Term Support release that is guaranteed to have no breaking changes.

    +
    npm install @zowe/imperative@zowe-v2-lts
    +
    +
  • +
+

Note: If you want to install the bleeding edge version of Imperative, you can append --@zowe:registry=https://zowe.jfrog.io/zowe/api/npm/npm-release/ to the install command to get it from a staging registry. It is not recommended to use this registry for production dependencies.

+ +

Build and Install Imperative CLI Framework from Source

+
+

To build and install the Imperative CLI Framework, follow these steps:

+
    +
  1. Clone the zowe/imperative project to your PC.
  2. +
  3. From the command line, issue cd [relative path]/imperative
  4. +
  5. Issue npm install
  6. +
  7. Issue npm run build
  8. +
  9. Issue npm run test
  10. +
+

To build the entire project (including test stand-alone CLIs): + npm run build

+

To build only imperative source: + npm run build:packages

+ +

Run Tests

+
+ + + + + + + + + + + + + + + + + + + + + + + +
CommandDescription
npm run testRun all automated tests (unit & integration)
npm test:unitRun unit tests
npm test:integrationRun integration tests
npm test:systemRun system tests (requires IPv6 connection)
+

Note: To build and install the test CLIs used by the integration tests:

+
    +
  1. node scripts/sampleCliTool.js build
  2. +
  3. node scripts/sampleCliTool.js install
  4. +
+ +

Sample Applications

+
+

We provide a sample plug-in that you can use to get started developing your own plug-ins. See the Zowe CLI Sample Plug-in.

+ +

Documentation

+
+

We provide documentation that describes how to define commands, work with user profiles, and more! For more information, see the Imperative CLI Framework wiki.

+ +

Contribute

+
+

For information about how you can contribute code to Imperative CLI Framework, see CONTRIBUTING.

+ +

Submit an Issue

+
+

To report a bug or request an enhancement, please submit an issue.

+ +

Versioning

+
+

Imperative CLI Framework uses Semantic Versioning (SemVer) for versioning. For more information, see the Semantic Versioning website.

+ +

Licensing Imperative CLI Framework

+
+

For Imperative CLI Framework licensing rules, requirements, and guidelines, see LICENSE.

+
+
+
+

Index

+
+
+
+

Enumerations

+ +
+
+

Classes

+ +
+
+

Interfaces

+ +
+
+

Type aliases

+ +
+
+

Variables

+ +
+
+

Functions

+ +
+
+

Object literals

+ +
+
+
+
+
+

Type aliases

+
+ +

AUTH_TYPE_CHOICES

+
AUTH_TYPE_CHOICES: typeof AUTH_TYPE_NONE | typeof AUTH_TYPE_BASIC | typeof AUTH_TYPE_BEARER | typeof AUTH_TYPE_TOKEN | typeof AUTH_TYPE_CERT_PEM
+ +
+
+

type that specifies the choice of authentication types

+
+
+
+
+ +

CLIENT_PROPERTY

+
CLIENT_PROPERTY: "requestSuccess" | "requestFailure" | "data" | "dataString" | "response" | "session" | "log"
+ +
+
+

String type definition for properties of abstractRestClient that has a getter set. + This can be safely used in a getter call as a variable for the abstractRestClient object.

+
+
+
export
+
+
+
+
+
+ +

COMMAND_RESPONSE_FORMAT

+
COMMAND_RESPONSE_FORMAT: "json" | "default"
+ +
+
+

The command response format type definition - currently only JSON or default (stdout/stderr) are supported.

+
+
+
export
+
+
+
+
+
+ +

CommandOptionType

+
CommandOptionType: "array" | "boolean" | "count" | "existingLocalFile" | "json" | "number" | "string" | "stringOrEmpty"
+ +
+
+

The type of value that should be specified for an option by the user. + "array": an array of space delimited strings + "boolean": a switch - the user specifies: true "--option-name" or false: "--option-name false" + "count" : accepting only whole numbers as input value + "existingLocalFile": a file for which fs.existsSync returns true + "json": a parseable JSON string + "number" : accepting integers as input value + "string" : string input that does not allow "" as a valid input value + "stringOrEmpty" : allow string to be empty when defined

+
+
+
+
+ +

CommandSegment

+
CommandSegment: "group" | "command"
+ +
+
+

The command segment represents the "level" you are at in the command (for help generation)

+
+
+
+
+ +

ContentEncoding

+
ContentEncoding: typeof CONTENT_ENCODING_TYPES[number]
+ +
+
+ +

HTTP_PROTOCOL_CHOICES

+
HTTP_PROTOCOL_CHOICES: typeof HTTP_PROTOCOL | typeof HTTPS_PROTOCOL
+ +
+
+

type that specifies the choice of protocols

+
+
+
+
+ +

HTTP_VERB

+
HTTP_VERB: "GET" | "PUT" | "POST" | "DELETE"
+ +
+
+ +

IAddProfTypeResult

+
IAddProfTypeResult: { info: string; success: boolean }
+ +
+

Type declaration

+
    +
  • +
    info: string
    +
  • +
  • +
    success: boolean
    +
  • +
+
+
+
+ +

ICommandHandlerConstructor

+
ICommandHandlerConstructor: {}
+ +
+
+

This type is here so that we can indicate an object from a + require can be instantiated.

+
+
+
+

Type declaration

+
    +
+
+
+
+ +

ICommandNodeType

+
ICommandNodeType: "group" | "command"
+ +
+
+

Command Segment type - either "group" or "command".

+
+

"group" implies no handler and should have children. Use groups to logically arrange portions of your CLI. + "command" implies there is a handler and may or may not have children.

+
+
+
+ +

IConfigSecure

+
IConfigSecure: {}
+ +
+

Type declaration

+ +
+
+
+ +

IConfigSecureProperties

+
IConfigSecureProperties: {}
+ +
+

Type declaration

+
    +
  • +
    [key: string]: any
    +
  • +
+
+
+
+ +

IConstructor

+
IConstructor<T>: {}
+ +
+
+

An type that defines a class constructor

+
+
+

Type parameters

+
    +
  • +

    T

    +
  • +
+
+

Type declaration

+
    +
+
+
+
+ +

ICredentialManagerConstructor

+
ICredentialManagerConstructor: {}
+ +
+
+

This interface defines the constructor for a credential manager. This is used by the TypeScript + compiler to verify that any class that wishes to be a Credential Manager adheres to the constructor + arguments sent to it.

+
+

Your class will satisfy this interface when all the following are true:

+
    +
  1. Your class extends AbstractCredentialManager
  2. +
  3. Your constructor has less than or equal to the number of parameters specified in the interface
  4. +
  5. Your constructor has matching parameter types for all parameters accepted
  6. +
+
+
+

Type declaration

+
    +
+
+
+
+ +

IExtenderTypeInfo

+
IExtenderTypeInfo: { schema: IProfileSchema; sourceApp: string }
+ +
+

Type declaration

+ +
+
+
+ +

IExtendersJsonOpts

+
IExtendersJsonOpts: { profileTypes: Record<string, { from: string[]; latestFrom?: string; version?: string }> }
+ +
+
+

This type corresponds to the extenders.json file stored in the CLI home directory.

+
+

Here is an example structure of what extenders.json could look like on disk:

+
{
+    "profileTypes": {
+        "banana": {
+            "from": ["@zowe/banana-for-zowe-cli", "Zowe Explorer Banana Extension"],
+            "version": "v1.1.0",
+            "latestFrom": "Zowe Explorer Banana Extension"
+        }
+    }
+}
+
+
+
+

Type declaration

+
    +
  • +
    profileTypes: Record<string, { from: string[]; latestFrom?: string; version?: string }>
    +
  • +
+
+
+
+ +

IImperativeOverrides

+
IImperativeOverrides: ConstructorOrString<ImperativeOverrides>
+ +
+
+

All of the Default Imperative classes that can be changed by your Imperative CLI app.

+
+

A plugin can also define overrides through the same means as an Imperative CLI app. + When additional overrides provided by plugins are present, Imperative will favor + those classes over ones provided by your application.

+

Whether you are defining an Imperative Plugin or an Imperative CLI app, all keys in + this object are expected to be a class constructor or of type string.

+
    +
  • A class constructor will be instantiated directly from imperative with no additional work + by the provider. (Assuming it is properly defined for the specific key)
  • +
  • A string will trigger imperative to load the module before instantiating it.
      +
    • If the string is absolute, nothing special happens.
    • +
    • If the string is relative, then imperative will base the load on a well known location + depending on if it is a plugin provided override or base cli provided override.
        +
      • For Imperative Plugins: The module is located relative to the packages default import path (e.g require('package-name'))
      • +
      • For Imperative CLI Apps: The module is located relative to the main entry point of your application
      • +
      +
    • +
    +
  • +
+

When defining the location of an overrides as a string, it must adhere to the following format. Otherwise + Imperative will not be able to load the class.

+

Exporting an Anonymous Class

+
export = class {
+  // Code goes here
+};
+
+

Exporting a Named Class

+
export = class YourOverridesClass {
+  // Code goes here
+};
+
+

Using module.exports (Not preferred for TypeScript Users)

+
class YourOverridesClass {
+  // Code goes here
+}
+
+module.exports = YourOverridesClass;
+
+
+
see
+

{@link ImperativeOverrides} for documentation on the available keys.

+
+
+
+
+
+ +

IOperationCompleted

+
IOperationCompleted<T>: (output: T) => void
+ +

Type parameters

+
    +
  • +

    T

    +
  • +
+
+

Type declaration

+
    +
  • +
      +
    • (output: T): void
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        output: T
        +
      • +
      +

      Returns void

      +
    • +
    +
  • +
+
+
+
+ +

IOperationResultReady

+
IOperationResultReady<T>: (output: T, operationResults: IOperationResult<any>) => void
+ +

Type parameters

+
    +
  • +

    T

    +
  • +
+
+

Type declaration

+
    +
  • + +
      +
    • +

      Parameters

      + +

      Returns void

      +
    • +
    +
  • +
+
+
+
+ +

IOperationUndoCompleted

+
IOperationUndoCompleted: () => void
+ +
+

Type declaration

+
    +
  • +
      +
    • (): void
    • +
    +
      +
    • +

      Returns void

      +
    • +
    +
  • +
+
+
+
+ +

IProfArgValue

+
IProfArgValue: string | number | boolean | string[] | object
+ +
+
+

The value for the argument

+
+
+
+
+ +

IProfDataType

+
IProfDataType: "string" | "number" | "boolean" | "array" | "object"
+ +
+
+

The type of data for this property

+
+
+
+
+ +

IProfileValidationTaskFunction

+
IProfileValidationTaskFunction: (profile: any, done: (result: IProfileValidationTaskResult) => void) => void
+ +
+
+

A function that takes a profile and calls a done callback with the result of the + profile validation

+
+
+
+

Type declaration

+ +
+
+
+ +

ImperativeReject

+
ImperativeReject: (error: ImperativeError) => void
+ +
+
+

Definition for a promise rejection method that provides an ImperativeError (or subclass)

+
+
+
+

Type declaration

+ +
+
+
+ +

ImperativeYargsCommandAction

+
ImperativeYargsCommandAction: "syntax validation" | "command handler invoked" | "help invoked"
+ +
+
+

Indicates the action performed.

+
+
+
+
+ +

OUTPUT_FORMAT

+
OUTPUT_FORMAT: "list" | "table" | "string" | "object"
+ +
+
+

The available format types for formatting of output.

+
+ +

list

+
+

Formats the output data as a list of strings. If an array of objects is present in the output, each is stringified + and printed on a newline.

+ +

table

+
+

Formats the output data as a table using the properties as the column headers. You must ensure that the array of + objects is homogeneous for the table to print properly.

+ +

string

+
+

Formats the output data as a string. If the output data is an object/array it is stringified.

+ +

object

+
+

Formats the output a prettified JSON object.

+
+
+
+ +

RestClientResolve

+
RestClientResolve: (data: string) => void
+ +
+

Type declaration

+
    +
  • +
      +
    • (data: string): void
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        data: string
        +
      • +
      +

      Returns void

      +
    • +
    +
  • +
+
+
+
+ +

RestErrorSource

+
RestErrorSource: "client" | "http"
+ +
+
+ +

SecureCredential

+
SecureCredential: string
+ +
+
+

String credential

+
+
+
+
+ +

SecureOperationFunction

+
SecureOperationFunction: (propNamePath: string, propValue?: any, optional?: boolean) => Promise<any>
+ +
+
+

This type defines the signature for a function taht calls the credential manager. This is used by the TypeScript + compiler to verify that any function that wants to call the credential manager have the necessary + arguments sent to it.

+
+
+
+

Type declaration

+
    +
  • +
      +
    • (propNamePath: string, propValue?: any, optional?: boolean): Promise<any>
    • +
    +
      +
    • +
      +
      +

      Parameters

      +
        +
      • +
        propNamePath: string
        +
        +
        +

        The path to a child property

        +
        +
        +
      • +
      • +
        Optional propValue: any
        +
        +
        +

        The value of said property

        +
        +
        +
      • +
      • +
        Optional optional: boolean
        +
        +
        +

        Set to true if failure to find credentials should be ignored

        +
        +
        +
      • +
      +

      Returns Promise<any>

      +
        +
      • The processed value after the secure operation function runs
      • +
      +
    • +
    +
  • +
+
+
+
+ +

TOKEN_TYPE_CHOICES

+
TOKEN_TYPE_CHOICES: typeof TOKEN_TYPE_LTPA | typeof TOKEN_TYPE_JWT | typeof TOKEN_TYPE_APIML
+ +
+
+

type that specifies the choice of token types

+
+
+
+
+ +

VALIDATION_OUTCOME

+
VALIDATION_OUTCOME: "Failed" | "OK" | "Warning"
+ +
+
+ +

YargsCommandCompleted

+
YargsCommandCompleted: (args: Arguments, response: IYargsResponse) => void
+ +
+
+

Callback that is invoked when a command defined to yargs completes execution.

+
+
+
+

Type declaration

+
    +
  • + +
      +
    • +

      Parameters

      + +

      Returns void

      +
    • +
    +
  • +
+
+
+
+
+

Variables

+
+ +

Const ALL_TOKEN_TYPES

+
ALL_TOKEN_TYPES: string[] = [TOKEN_TYPE_APIML,TOKEN_TYPE_JWT,TOKEN_TYPE_LTPA]
+ +
+
+

list that specifies the choice of token types

+
+
+
+
+ +

Const AUTH_TYPE_BASIC

+
AUTH_TYPE_BASIC: "basic" = "basic"
+ +
+
+

Session type property value for basic authentication

+
+
+
+
+ +

Const AUTH_TYPE_BEARER

+
AUTH_TYPE_BEARER: "bearer" = "bearer"
+ +
+
+

Session type property value for bearer token authentication

+
+
+
+
+ +

Const AUTH_TYPE_CERT_PEM

+
AUTH_TYPE_CERT_PEM: "cert-pem" = "cert-pem"
+ +
+
+

Session type property value for certificate authentication, + which uses a certificate file and key file.

+
+
+
+
+ +

Const AUTH_TYPE_NONE

+
AUTH_TYPE_NONE: "none" = "none"
+ +
+
+

Session type property value for no authentication

+
+
+
+
+ +

Const AUTH_TYPE_TOKEN

+
AUTH_TYPE_TOKEN: "token" = "token"
+ +
+
+

Session type property value for cookie token authentication, + which uses a named token type.

+
+
+
+
+ +

Const ClipboardJS

+
ClipboardJS: any
+ +
+
+ +

Const HTTPS_PROTOCOL

+
HTTPS_PROTOCOL: "https" = "https"
+ +
+
+

https protocol

+
+
+
+
+ +

Const HTTP_PROTOCOL

+
HTTP_PROTOCOL: "http" = "http"
+ +
+
+

http protocol

+
+
+
+
+ +

Const TOKEN_TYPE_APIML

+
TOKEN_TYPE_APIML: "apimlAuthenticationToken" = "apimlAuthenticationToken"
+ +
+
+

tokenType property value for an API Mediation Layer token

+
+
+
+
+ +

Const TOKEN_TYPE_JWT

+
TOKEN_TYPE_JWT: "jwtToken" = "jwtToken"
+ +
+
+

tokenType property value for a JWT token

+
+
+
+
+ +

Const TOKEN_TYPE_LTPA

+
TOKEN_TYPE_LTPA: "LtpaToken2" = "LtpaToken2"
+ +
+
+

tokenType property value for IBM's LTPA2 token

+
+
+
+
+ +

Const aliasList

+
aliasList: {}
+ +
+

Type declaration

+
    +
  • +
    [key: string]: string[]
    +
  • +
+
+
+
+ +

Const clipboard

+
clipboard: any = new ClipboardJS(".btn-copy")
+ +
+
+ +

Let currentNodeId

+
currentNodeId: string
+ +
+
+ +

Let currentView

+
currentView: number = +(urlParams.get("v") === "1")
+ +
+
+ +

Const footerStr

+
footerStr: string
+ +
+
+ +

Const headerStr

+
headerStr: string
+ +
+
+ +

Const isInIframe

+
isInIframe: boolean = window.location !== window.parent.location
+ +
+
+ +

Const links

+
links: any = arrayFrom(document.getElementsByTagName("a"))
+ +
+
+ +

Const loggerUtilsRequire

+
loggerUtilsRequire: any = (jest as any).requireActual("../LoggerUtils").LoggerUtils
+ +
+
+ +

Const probTests

+
probTests: IProbTest[] = [{itemId: ItemId.NODEJS_VER,probExpr: "semver.satisfies('{val}', '<18.x || 19.x || >=21.x')",probMsg: "Only Node.js versions 18 and 20 are supported."},{itemId: ItemId.NPM_VER,probExpr: "semver.satisfies('{val}', '8.11.0 || 8.12.0')",probMsg: "NPM versions 8.11.0 and 8.12.0 cause SCS errors in some situations."},{itemId: ItemId.ZOWE_APP_LOG_LEVEL,probExpr: logLevelExpr,probMsg: formatLogLevelMsg("ZOWE_APP_LOG_LEVEL")},{itemId: ItemId.ZOWE_IMPERATIVE_LOG_LEVEL,probExpr: logLevelExpr,probMsg: formatLogLevelMsg("ZOWE_IMPERATIVE_LOG_LEVEL")}]
+ +
+
+

The tests to check for problems that we run for environmental items. + One ItemId can have multiple entries in the array, to check for + different problems. When the probExpr is true, we have a problem, + and we print the probMsg.

+
+
+
+
+ +

Const scrollIntoView

+
scrollIntoView: any
+ +
+
+ +

Let searchTimeout

+
searchTimeout: number = 0
+ +
+
+ +

Const treeNodes

+
treeNodes: ITreeNode[]
+ +
+
+ +

Const urlParams

+
urlParams: URLSearchParams = new URLSearchParams(window.location.search)
+ +
+
+
+

Functions

+
+ +

arrayFrom

+
    +
  • arrayFrom(items: any): any[]
  • +
+ +
+
+ +

changeView

+
    +
  • changeView(newMode: number): void
  • +
+
    +
  • + +
    +
    +

    Change display mode of page

    +
    +
    +

    Parameters

    +
      +
    • +
      newMode: number
      +
      +

      0 = Tree View, 1 = Flat View

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Const compareCommands

+ + +
+
+ +

findCurrentCmdAnchor

+
    +
  • findCurrentCmdAnchor(): any
  • +
+ +
+
+ +

findNpmOnPath

+
    +
  • findNpmOnPath(): string
  • +
+ +
+
+ +

flattenNodes

+ + +
+
+ +

getJstreeThemeName

+
    +
  • getJstreeThemeName(): string
  • +
+ +
+
+ +

getPackageInfo

+
    +
  • getPackageInfo(pkgSpec: string): Promise<{ name: string; version: string }>
  • +
+ +
+
+ +

getRegistry

+
    +
  • getRegistry(): string
  • +
+ +
+
+ +

install

+
    +
  • install(packageLocation: string, registry: string, installFromFile?: boolean): Promise<string>
  • +
+
    +
  • + +
    +
    +

    Common function that abstracts the install process. This function should be called for each + package that needs to be installed. (ex: sample-cli plugin install a b c d -> calls install 4 + times)

    +
    +
    +
    todo
    +

    work needs to be done to support proper sharing of the plugins.json. As of now local plugins can only be reinstalled on the same machine. + (due to how the conversion to an absolute URI happens)

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      packageLocation: string
      +
      +

      A package name or location. This value can be a valid npm package + name or the location of an npm tar file or project folder. Also, + git URLs are also acceptable here (basically anything that npm install supports). If this parameter is a relative path, it will + be converted to an absolute path prior to being passed to the + npm install command.

      +
      +
    • +
    • +
      registry: string
      +
      +

      The npm registry to use, this is expected to be passed by every caller + so if calling functions don't have a registry available, they need + to get it from npm.

      +
      +
    • +
    • +
      Default value installFromFile: boolean = false
      +
    • +
    +

    Returns Promise<string>

    +

    The name of the plugin.

    +
  • +
+
+
+ +

installPackages

+
    +
  • installPackages(prefix: string, registry: string, npmPackage: string): string
  • +
+
    +
  • + +
    +
    +

    Common function that installs a npm package using the local npm cli.

    +
    +
    +

    Parameters

    +
      +
    • +
      prefix: string
      +
      +

      Path where to install npm the npm package.

      +
      +
    • +
    • +
      registry: string
      +
      +

      The npm registry to install from.

      +
      +
    • +
    • +
      npmPackage: string
      +
      +

      The name of package to install.

      +
      +
    • +
    +

    Returns string

    +

    command response

    +
  • +
+
+
+ +

loadTree

+
    +
  • loadTree(): void
  • +
+ +
+
+ +

npmLogin

+
    +
  • npmLogin(registry: string): void
  • +
+ +
+
+ +

onDocsPageChanged

+
    +
  • onDocsPageChanged(e: any): void
  • +
+
    +
  • + +
    +
    +

    Update selected node in command tree after new page loaded in iframe

    +
    +
    +

    Parameters

    +
      +
    • +
      e: any
      +
      +

      Event object sent by postMessage

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

onSearchTextChanged

+
    +
  • onSearchTextChanged(noDelay?: boolean): void
  • +
+
    +
  • + +
    +
    +

    Search command tree after text in search box has changed

    +
    +
    +

    Parameters

    +
      +
    • +
      Default value noDelay: boolean = false
      +
      +

      If true, searches instantly rather than delaying 250 ms

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

onTreeContextMenu

+
    +
  • onTreeContextMenu(node: ITreeNode): {} | { collapseAll: object; expandAll: object }
  • +
+
    +
  • + +
    +
    +

    Generate list of context menu items for a node

    +
    +
    +

    Parameters

    +
      +
    • +
      node: ITreeNode
      +
      +

      Node that was right clicked

      +
      +
    • +
    +

    Returns {} | { collapseAll: object; expandAll: object }

    +

    List of context menu items containing labels and actions

    +
  • +
+
+
+ +

onTreeLoaded

+
    +
  • onTreeLoaded(): void
  • +
+ +
+
+ +

onTreeSearch

+
    +
  • onTreeSearch(permutedSearchStr: string, node: any): boolean
  • +
+
    +
  • + +
    +
    +

    Check if node is matched by a search string

    +
    +
    +

    Parameters

    +
      +
    • +
      permutedSearchStr: string
      +
      +

      NUL-delimited list of search strings

      +
      +
    • +
    • +
      node: any
      +
    • +
    +

    Returns boolean

    +

    True if the node matches

    +
  • +
+
+
+ +

onTreeSelectionChanged

+
    +
  • onTreeSelectionChanged(_: any, data: any): void
  • +
+
    +
  • + +
    +
    +

    Update current node after new node selected in tree

    +
    +
    +

    Parameters

    +
      +
    • +
      _: any
      +
    • +
    • +
      data: any
      +
      +

      jsTree event data

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

permuteSearchStr

+
    +
  • permuteSearchStr(searchStr: string): string
  • +
+
    +
  • + +
    +
    +

    Find all possible combinations of a search string that exist with different aliases

    +
    +
    +

    Parameters

    +
      +
    • +
      searchStr: string
      +
      +

      Search string input by user

      +
      +
    • +
    +

    Returns string

    +

    NUL-delimited list of search strings with all combinations of aliases

    +
  • +
+
+
+ +

runValidatePlugin

+
    +
  • runValidatePlugin(pluginName: string): string
  • +
+
    +
  • + +
    +
    +

    Run another instance of the host CLI command to validate a plugin that has + just been installed. We use a separate process instead of an API call + because when the user re-installs an existing plugin we cannot validate + if the plugin has conflicting command names because the plugin has + already been incorporated into the Imperative command tree, and thus it + could conflict with its own commands. However, if we run a validate command + in a new process, we start with a clean slate and we get accurate results.

    +
    +
    +

    Parameters

    +
      +
    • +
      pluginName: string
      +
      +

      The name of a plugin to be validated.

      +
      +
    • +
    +

    Returns string

    +
      +
    • The text output of the validate plugin command.
    • +
    +
  • +
+
+
+ +

setTooltip

+
    +
  • setTooltip(btn: any, message: string): void
  • +
+
    +
  • + +
    +
    +

    Show tooltip next to copy button that times out after 1 sec

    +
    +
    +

    Parameters

    +
      +
    • +
      btn: any
      +
      +

      Button element the tooltip will show next to

      +
      +
    • +
    • +
      message: string
      +
      +

      Message to show in the tooltip

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

toggleTree

+
    +
  • toggleTree(splitter: any): void
  • +
+ +
+
+ +

uninstall

+
    +
  • uninstall(packageName: string): void
  • +
+ +
+
+ +

update

+
    +
  • update(packageName: string, registry: string): Promise<string>
  • +
+ +
+
+ +

Const updateAndGetRemovedTypes

+
    +
  • updateAndGetRemovedTypes(npmPackage: string): string[]
  • +
+ +
+
+ +

updateCurrentNode

+
    +
  • updateCurrentNode(newNodeId: string, goto: boolean, expand: boolean, force?: boolean): void
  • +
+
    +
  • + +
    +
    +

    Update node that docs are displayed for

    +
    +
    +

    Parameters

    +
      +
    • +
      newNodeId: string
      +
      +

      Node ID to select

      +
      +
    • +
    • +
      goto: boolean
      +
      +

      Whether to load docs page for node

      +
      +
    • +
    • +
      expand: boolean
      +
      +

      Whether to expand tree node

      +
      +
    • +
    • +
      Default value force: boolean = false
      +
      +

      Whether to update node even if already selected

      +
      +
    • +
    +

    Returns void

    +
  • +
+
+
+ +

Const updateExtendersJson

+ + +
+
+
+

Object literals

+
+ +

Const MOCKED_COMMAND_TREE

+
MOCKED_COMMAND_TREE: object
+ +
+ +

children

+
children: { description: string; name: string; options: ({ description: string; name: string; type: "string" } | { description: string; name: string; type: "boolean" })[]; positionals: { description: string; name: string; required: false; type: "string" }[]; type: "command" }[] = [{name: "test-command-one",description: "test command one",type: "command",options: [{name: "test-option",description: "the option",type: "string"},{name: "test-boolean",description: "the boolean option",type: "boolean"}],positionals: [{name: "positional1",description: "the positional option",type: "string",required: false}]},{name: "test-command-two",description: "test command two",type: "command",options: [{name: "test-option",description: "the option",type: "string"},{name: "test-boolean",description: "the boolean option",type: "boolean"}],positionals: [{name: "positional1",description: "the positional option",type: "string",required: false}]}]
+ +
+
+ +

description

+
description: string = "a test group"
+ +
+
+ +

name

+
name: string = "test-group"
+ +
+
+ +

type

+
type: "group" = "group"
+ +
+
+
+ +

Const ReportEnvDefinition

+
ReportEnvDefinition: object
+ +
+
+

Definition for the 'config report-env' command.

+
+
+
+ +

aliases

+
aliases: string[] = ["re"]
+ +
+
+ +

description

+
description: string = "Reports key items from your environment and identifies problem conditions"
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: "Report information and issues about your working environment",options: ""},{description: "Save the report about your working environment to a file",options: "> report.log"}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "Report-env.handler")
+ +
+
+ +

name

+
name: string = "report-env"
+ +
+
+ +

summary

+
summary: string = "Report the state of your working environment"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const apiErrorHeader

+
apiErrorHeader: object
+ +
+ +

message

+
message: string = `${Constants.FRAMEWORK_DISPLAY_NAME} API Error`
+ +
+
+
+ +

Const authCategoryDesc

+
authCategoryDesc: object
+ +
+ +

message

+
message: string = `Connect to token-based authentication services`
+ +
+
+
+ +

Const authLoginCommandDesc

+
authLoginCommandDesc: object
+ +
+ +

message

+
message: string = `Log in to {{type}} authentication service`
+ +
+
+
+ +

Const authLoginGroupDesc

+
authLoginGroupDesc: object
+ +
+ +

message

+
message: string = `${authLoginGroupSummary.message}.`
+ +
+
+
+ +

Const authLoginGroupSummary

+
authLoginGroupSummary: object
+ +
+ +

message

+
message: string = `Log in to an authentication service`
+ +
+
+
+ +

Const authLoginShowTokenDesc

+
authLoginShowTokenDesc: object
+ +
+ +

message

+
message: string = `Show the token when login is successful. If specified, does not save the token to a profile.`
+ +
+
+
+ +

Const authLogoutCommandDesc

+
authLogoutCommandDesc: object
+ +
+ +

message

+
message: string = `Log out of {{type}} authentication service`
+ +
+
+
+ +

Const authLogoutGroupDesc

+
authLogoutGroupDesc: object
+ +
+ +

message

+
message: string = `${authLogoutGroupSummary.message}.`
+ +
+
+
+ +

Const authLogoutGroupSummary

+
authLogoutGroupSummary: object
+ +
+ +

message

+
message: string = `Log out of an authentication service`
+ +
+
+
+ +

Const autoInitCommandDesc

+
autoInitCommandDesc: object
+ +
+ +

message

+
message: string = `Automatically generate a config from {{source}}`
+ +
+
+
+ +

Const convertProfilesDefinition

+
convertProfilesDefinition: object
+ +
+
+

Definition of the convert-profiles command.

+
+
+
+ +

aliases

+
aliases: string[] = ["convert"]
+ +
+
+ +

description

+
description: string = `Convert v1 profiles to a global ${ImperativeConfig.instance.rootCommandName}.config.json file.`
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: "Convert profiles to team config without prompting",options: "--no-prompt"}, {description: "Convert profiles to team config and delete the old profiles",options: "--delete"}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "convert-profiles.handler")
+ +
+
+ +

name

+
name: string = "convert-profiles"
+ +
+
+ +

options

+
options: ({ defaultValue: boolean; description: string; name: string; type: "boolean" } | { description: string; name: string; type: "boolean" })[] = [{name: "prompt",description: "Prompt for confirmation. Use --no-prompt to disable prompting.",type: "boolean",defaultValue: true}, {name: "delete",description: "Delete the existing profiles on disk and any securely stored secrets.",type: "boolean"}]
+ +
+
+ +

summary

+
summary: string = "Convert profiles to team config"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const couldNotInstantiateCommandHandler

+
couldNotInstantiateCommandHandler: object
+ +
+ +

message

+
message: string = `Could not instantiate the handler {{commandHandler}} for ` +`command {{definitionName}}`
+ +
+
+
+ +

Const createProfileCommandDesc

+
createProfileCommandDesc: object
+ +
+ +

message

+
message: string = `Create a {{type}} profile`
+ +
+
+
+ +

Const createProfileDisableDefaultsDesc

+
createProfileDisableDefaultsDesc: object
+ +
+ +

message

+
message: string = `Disable populating profile values of undefined properties with default values.`
+ +
+
+
+ +

Const createProfileOptionDesc

+
createProfileOptionDesc: object
+ +
+ +

message

+
message: string = `Specifies the name of the new {{type}} profile. ` +`You can load this profile by using the name on commands that support the ` +`"--{{type}}-profile" option.`
+ +
+
+
+ +

Const createProfileOptionOverwriteDesc

+
createProfileOptionOverwriteDesc: object
+ +
+ +

message

+
message: string = `Overwrite the {{type}} profile when a profile of the same name exists.`
+ +
+
+
+ +

Const createProfilesCommandDesc

+
createProfilesCommandDesc: object
+ +
+ +

message

+
message: string = `${createProfilesCommandSummary.message}.`
+ +
+
+
+ +

Const createProfilesCommandSummary

+
createProfilesCommandSummary: object
+ +
+ +

message

+
message: string = `Create new configuration profiles`
+ +
+
+
+ +

Const deleteProfileActionDesc

+
deleteProfileActionDesc: object
+ +
+ +

message

+
message: string = `Delete a {{type}} profile.`
+ +
+
+
+ +

Const deleteProfileCommandDesc

+
deleteProfileCommandDesc: object
+ +
+ +

message

+
message: string = `Delete a {{type}} profile.` +` You must specify a profile name to be deleted. To find a list of available profiles for deletion,` +` issue the profiles list command. By default, you will be prompted to confirm the profile removal.`
+ +
+
+
+ +

Const deleteProfileDepsDesc

+
deleteProfileDepsDesc: object
+ +
+ +

message

+
message: string = `Set to true to delete all dependent profiles along with the {{type}} profile.` +`If set to true, a list of dependent profiles will be shown along with a confirmation prompt before the ` +`deletions occur. If set to false, only the {{type}} profile specified will be deleted.`
+ +
+
+
+ +

Const deleteProfileExample

+
deleteProfileExample: object
+ +
+ +

message

+
message: string = `Delete a {{type}} profile named {{name}}`
+ +
+
+
+ +

Const deleteProfileForceOptionDesc

+
deleteProfileForceOptionDesc: object
+ +
+ +

message

+
message: string = `Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before `+ ` deletion occurs.`
+ +
+
+
+ +

Const deleteProfileNameDesc

+
deleteProfileNameDesc: object
+ +
+ +

message

+
message: string = `Specifies the name of the {{type}} ` +` profile to be deleted. ` +`You can also load this profile by using the name on commands that support the ` +`"--{{typeOption}}" option.`
+ +
+
+
+ +

Const deleteProfilesCommandDesc

+
deleteProfilesCommandDesc: object
+ +
+ +

message

+
message: string = `${deleteProfilesCommandSummary.message}.`
+ +
+
+
+ +

Const deleteProfilesCommandSummary

+
deleteProfilesCommandSummary: object
+ +
+ +

message

+
message: string = `Delete existing profiles`
+ +
+
+
+ +

Const detailProfileCommandDesc

+
detailProfileCommandDesc: object
+ +
+ +

message

+
message: string = `Show details of a profile of a selected type.`
+ +
+
+
+ +

Const editDefinition

+
editDefinition: object
+ +
+
+

Definition of the edit command.

+
+
+
+ +

description

+
description: string = `Edit an existing config file in your system's default text editor.\n\n` +`In a graphical environment, the application associated with JSON files will be launched. ` +`In a command-line environment, vi will be launched. To override the command-line editor used, specify it in ` +`the ${ImperativeConfig.instance.loadedConfig.envVariablePrefix}_EDITOR environment variable.`
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: "Edit global config file",options: "--global-config"}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "edit.handler")
+ +
+
+ +

name

+
name: string = "edit"
+ +
+
+ +

options

+
options: { aliases: string[]; defaultValue: boolean; description: string; name: string; type: "boolean" }[] = [{name: "global-config",description: "Target the global config files.",aliases: ["gc"],type: "boolean",defaultValue: false},{name: "user-config",description: "Target the user config files.",aliases: ["uc"],type: "boolean",defaultValue: false}]
+ +
+
+ +

summary

+
summary: string = "edit config files"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const errorDetailsHeader

+
errorDetailsHeader: object
+ +
+ +

message

+
message: string = "Error Details:"
+ +
+
+
+ +

Const firststepsDefinition

+
firststepsDefinition: object
+ +
+
+

Definition of the firststeps command.

+
+
+
+ +

aliases

+
aliases: string[] = ["fs"]
+ +
+
+ +

description

+
description: string = "Show first steps required to set up plugin for use."
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: `Show first steps for a plugin called 'my-plugin'`,options: "my-plugin"}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "showfirststeps.handler")
+ +
+
+ +

name

+
name: string = "show-first-steps"
+ +
+
+ +

positionals

+
positionals: { description: string; name: string; required: false; type: "string" }[] = [{name: "plugin",type: "string",description: pluginDescription,required: false}]
+ +
+
+ +

summary

+
summary: string = "Show first steps for a plugin"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const importDefinition

+
importDefinition: object
+ +
+
+

Definition of the import command.

+
+
+
+ +

description

+
description: string = "Import config files from another location on disk or from an Internet URL.\n\n" +"If the config `$schema` property points to a relative path, the schema will also be imported."
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: "Import config from local file on disk",options: "~/Downloads/zowe.config.json"},{description: "Import global config from Internet URL",options: "https://example.com/zowe.config.json --global-config"}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "import.handler")
+ +
+
+ +

name

+
name: string = "import"
+ +
+
+ +

options

+
options: ({ aliases: string[]; defaultValue: boolean; description: string; name: string; type: "boolean" } | { aliases: string[]; description: string; group: string; implies: string[]; name: string; type: "string" } | { aliases: string[]; defaultValue: boolean; description: string; group: string; name: string; type: "boolean" })[] = [{name: "global-config",description: "Target the global config files.",aliases: ["gc"],type: "boolean",defaultValue: false},{name: "user-config",description: "Target the user config files.",aliases: ["uc"],type: "boolean",defaultValue: false},{name: "overwrite",description: "Overwrite config file if one already exists.",aliases: ["ow"],type: "boolean",defaultValue: false},{name: "user",aliases: ["u"],description: "User name if authentication is required to download the config from a URL.",type: "string",implies: ["password"],group: CONNECTION_OPTION_GROUP},{name: "password",aliases: ["pass", "pw"],description: "Password if authentication is required to download the config from a URL.",type: "string",implies: ["user"],group: CONNECTION_OPTION_GROUP},{name: "reject-unauthorized",aliases: ["ru"],description: "Reject self-signed certificates if config is downloaded from an HTTPS URL.",type: "boolean",defaultValue: true,group: CONNECTION_OPTION_GROUP}]
+ +
+
+ +

positionals

+
positionals: { description: string; name: string; required: true; type: "string" }[] = [{name: "location",description: "File path or URL to import from.",required: true,type: "string"}]
+ +
+
+ +

summary

+
summary: string = "import config files"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const initDefinition

+
initDefinition: object
+ +
+
+

Definition of the init command.

+
+
+
+ +

description

+
description: string = `Initialize config files. Defaults to initializing "${ImperativeConfig.instance.rootCommandName}.config.json" in the current ` +`working directory unless otherwise specified.\n\nUse "--user-config" to init ` +`"${ImperativeConfig.instance.rootCommandName}.config.user.json". Use "--global-config" to initialize the configuration files in your home ` +`"~/.zowe" directory.\n\nUse "--no-prompt" to skip prompting for values in a CI environment.`
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: `Initialize configuration files in your home "~/.zowe" directory`,options: "--global-config"},{description: `Do a dry run of initializing configuration files in your home "~/.zowe" directory`,options: "--global-config --dry-run"},{description: "Initialize the user config files",options: "--user-config"},{description: "Initialize the user config files and do not prompt for secure values",options: "--user-config --prompt false"},{description: "Do a dry run of initializing the user config files and do not prompt for secure values",options: "--user-config --prompt false --dry-run"},{description: "Overwrite any existing global config files",options: "--global-config --overwrite --for-sure"},{description: "Overwrite any existing user config files",options: "--user-config --overwrite --for-sure"}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "init.handler")
+ +
+
+ +

name

+
name: string = "init"
+ +
+
+ +

options

+
options: ({ aliases: string[]; defaultValue: boolean; description: string; name: string; type: "boolean" } | { defaultValue: boolean; description: string; name: string; type: "boolean" } | { aliases: string[]; conflictsWith: string[]; description: string; implies: string[]; name: string; type: "boolean" } | { aliases: string[]; conflictsWith: string[]; description: string; name: string; type: "boolean" })[] = [{name: "global-config",description: "Target the global config files.",aliases: ["gc"],type: "boolean",defaultValue: false},{name: "user-config",description: "Target the user config files.",aliases: ["uc"],type: "boolean",defaultValue: false},{name: "prompt",description: "Prompt for missing values in the base profile. Useful for disabling prompting in CI environments.",type: "boolean",defaultValue: true},{name: "overwrite",description: "Replace existing config files instead of merging the new changes.",aliases: ["ow"],type: "boolean",conflictsWith: ["dry-run"],implies: ["for-sure"]},{name: "for-sure",aliases: ["fs"],description: "Confirms the overwrite option.",type: "boolean",defaultValue: false},{name: "dry-run",description: "Display the outcome of the initialization without saving it.",aliases: ["dr", "dry"],type: "boolean",conflictsWith: ["edit", "overwrite", "prompt"]},{name: "edit",aliases: ["e"],description: "Open in editor after initializing the configuration",type: "boolean",conflictsWith: ["dry-run"]}]
+ +
+
+ +

summary

+
summary: string = "init config files"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const installDefinition

+
installDefinition: object
+ +
+
+

Definition of the install command.

+
+
+
+ +

description

+
description: string = "Install plug-ins to an application."
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: `Install plug-ins saved in ${PMFConstants.instance.PLUGIN_JSON}`,options: ""},{description: "Install plug-ins saved in a properly formatted config file",options: "--file /some/file/path/file_name.json"},{description: "Install a remote plug-in",options: "my-plugin"},{description: "Install a remote plug-in using semver",options: "my-plugin@\"^1.2.3\""},{description: "Install a remote plug-in from the specified registry",options: "my-plugin --registry https://registry.npmjs.org/"},{description: "Install a local folder, local TAR file, and a git URL",options: "./local-file /root/tar/some-tar.tgz git://github.com/project/repository.git#v1.0.0"},{description: "Install a remote plug-in from the registry which requires authorization" +"(don't need to use this flag if you have already logged in before)",options: "my-plugin --registry https://registry.npmjs.org/ --login"}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "install.handler")
+ +
+
+ +

name

+
name: string = "install"
+ +
+
+ +

options

+
options: ({ conflictsWith: string[]; description: string; name: string; required: false; type: "existingLocalFile" } | { description: string; name: string; required: false; type: "string" } | { description: string; implies: string[]; name: string; required: false; type: "boolean" })[] = [{name: "file",type: "existingLocalFile",description: fileDescription,required: false,conflictsWith: ["registry"]},{name: "registry",type: "string",description: registryDescription,required: false},{name: "login",type: "boolean",description: loginDescription,required: false,implies: ["registry"]}]
+ +
+
+ +

positionals

+
positionals: { description: string; name: string; required: false; type: "string" }[] = [{name: "plugin...",type: "string",description: pluginDescription,required: false}]
+ +
+
+ +

summary

+
summary: string = "Install a plug-in"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const listDefinition

+
listDefinition: object
+ +
+ +

aliases

+
aliases: string[] = ["ls"]
+ +
+
+ +

description

+
description: string = "List config properties"
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: "List property names for a specified config property",options: `"defaults"`},{description: "List only root level property names for a specified config property",options: `"defaults" --root`},{description: "List config properties by separating them by their respective config file locations",options: "--locations"},{description: "List only the root level configuration property names",options: "--root"},{description: "List only the root level configuration properties by separating them by their respective config file locations",options: "--locations --root"}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "list.handler")
+ +
+
+ +

name

+
name: string = "list"
+ +
+
+ +

options

+
options: { description: string; name: string; type: "boolean" }[] = [{name: "locations",description: "Separate the config properties into their respective config file locations. " +"Helpful to determine where configuration value is specified.",type: "boolean"},{name: "root",description: "List only the root level property names. " +"For example, specify in addition to '--locations' to get a list of config file paths only.",type: "boolean"}]
+ +
+
+ +

positionals

+
positionals: { description: string; name: string; type: "string" }[] = [{name: "property",description: "The config property to list. Blank to list all properties.",type: "string"}]
+ +
+
+ +

summary

+
summary: string = "list config properties"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const listGroupWithOnlyProfileCommandSummary

+
listGroupWithOnlyProfileCommandSummary: object
+ +
+ +

message

+
message: string = `List {{type}} loaded profiles`
+ +
+
+
+ +

Const listGroupWithOnlyProfileDefaultDesc

+
listGroupWithOnlyProfileDefaultDesc: object
+ +
+ +

message

+
message: string = `Lists all known profiles for this command group. ` +`When you issue a command that requires a profile or set of ` +`profiles, said profiles are loaded by default (or according to override options on the command). You can use this ` +`command to review your configured profiles, and verify your default profile set.`
+ +
+
+
+ +

Const listGroupWithOnlyProfileSetDesc

+
listGroupWithOnlyProfileSetDesc: object
+ +
+ +

message

+
message: string = `To set the default profiles, use the " ` +`{{type}} ${Constants.DEFAULT_SET_GROUP} ${Constants.DEFAULT_SET_PROFILE_OBJECT}" command.`
+ +
+
+
+ +

Const listGroupWithOnlyProfilesDefinition

+
listGroupWithOnlyProfilesDefinition: object
+ +
+ +

message

+
message: string = `List the {{type}} profiles loaded.`
+ +
+
+
+ +

Const listGroupWithOnlyProfilesSummary

+
listGroupWithOnlyProfilesSummary: object
+ +
+ +

message

+
message: string = `List the {{type}} profiles loaded`
+ +
+
+
+ +

Const listProfileCommandDesc

+
listProfileCommandDesc: object
+ +
+ +

message

+
message: string = `List profiles of the type {{type}}.`
+ +
+
+
+ +

Const listProfileCommandSummary

+
listProfileCommandSummary: object
+ +
+ +

message

+
message: string = `List existing profiles`
+ +
+
+
+ +

Const listProfileExample

+
listProfileExample: object
+ +
+ +

message

+
message: string = `List profiles of type {{type}}`
+ +
+
+
+ +

Const listProfileExampleShowContents

+
listProfileExampleShowContents: object
+ +
+ +

message

+
message: string = `List profiles of type {{type}} and display their contents`
+ +
+
+
+ +

Const listProfileLoadedModulesOptionDesc

+
listProfileLoadedModulesOptionDesc: object
+ +
+ +

message

+
message: string = `List {{type}} ` +` profiles that are loaded as part of normal command execution. ` +`This will show you the default profiles being loaded.`
+ +
+
+
+ +

Const listProfileVerboseOptionDesc

+
listProfileVerboseOptionDesc: object
+ +
+ +

message

+
message: string = `List {{type}} ` +` profiles and their contents. ` +`All profile details will be printed as part of command output.`
+ +
+
+
+ +

Const listProfilesFoundMessage

+
listProfilesFoundMessage: object
+ +
+ +

message

+
message: string = `The following profiles were found of the type "{{type}}":`
+ +
+
+
+ +

Const listProfilesNotFoundMessage

+
listProfilesNotFoundMessage: object
+ +
+ +

message

+
message: string = `No profiles were found of the type "{{type}}".`
+ +
+
+
+ +

Const locateProfilesDesc

+
locateProfilesDesc: object
+ +
+ +

message

+
message: string = `Configuration profiles are located and used by searching in the following order,` +` ending the search when a profile is found:`
+ +
+
+
+ +

Const onlyForTesting

+
onlyForTesting: object
+ +
+ +

callPluginPostInstall

+
callPluginPostInstall: callPluginPostInstall = callPluginPostInstall
+ +
+
+
+ +

Const overroteProfileMessage

+
overroteProfileMessage: object
+ +
+ +

message

+
message: string = "Overwrote existing profile for {{profileOption}}."
+ +
+
+
+ +

Const profileCreateErrorDetails

+
profileCreateErrorDetails: object
+ +
+ +

message

+
message: string = "Error Details: {{errorDetails}}"
+ +
+
+
+ +

Const profileCreateErrorHeader

+
profileCreateErrorHeader: object
+ +
+ +

message

+
message: string = "Profile Create Error"
+ +
+
+
+ +

Const profileCreatedSuccessfully

+
profileCreatedSuccessfully: object
+ +
+ +

message

+
message: string = `Profile created successfully.`
+ +
+
+
+ +

Const profileCreatedSuccessfullyAndPath

+
profileCreatedSuccessfullyAndPath: object
+ +
+ +

message

+
message: string = `Profile created successfully! Path:`
+ +
+
+
+ +

Const profileDeleteErrorDetails

+
profileDeleteErrorDetails: object
+ +
+ +

message

+
message: string = "Error Details: {{errorDetails}}"
+ +
+
+
+ +

Const profileDeleteErrorHeader

+
profileDeleteErrorHeader: object
+ +
+ +

message

+
message: string = "Profile Deletion Error"
+ +
+
+
+ +

Const profileDeletedSuccessfully

+
profileDeletedSuccessfully: object
+ +
+ +

message

+
message: string = "Successfully deleted the following profile(s): "
+ +
+
+
+ +

Const profileDesc

+
profileDesc: object
+ +
+ +

message

+
message: string = `Configuration profiles are loaded based on the requirements ` +`of the command:`
+ +
+
+
+ +

Const profileLoadError

+
profileLoadError: object
+ +
+ +

message

+
message: string = `Error loading {{type}} profile: {{profileName}}.\n\n` +`Additional Details:\n\n`
+ +
+
+
+ +

Const profileNotDeletedMessage

+
profileNotDeletedMessage: object
+ +
+ +

message

+
message: string = "No profiles were deleted."
+ +
+
+
+ +

Const profileReviewMessage

+
profileReviewMessage: object
+ +
+ +

message

+
message: string = "Review the created profile and edit if necessary using the profile update command."
+ +
+
+
+ +

Const profileUpdatedSuccessfullyAndPath

+
profileUpdatedSuccessfullyAndPath: object
+ +
+ +

message

+
message: string = `Profile updated successfully! Path:`
+ +
+
+
+ +

Const profilesDefinition

+
profilesDefinition: object
+ +
+
+

Definition of the paths command.

+
+
+
+ +

description

+
description: string = "Displays profile paths."
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: "Display profile paths",options: ""}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "profiles.handler")
+ +
+
+ +

name

+
name: string = "profiles"
+ +
+
+ +

summary

+
summary: string = "displays profile paths"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const schemaDefinition

+
schemaDefinition: object
+ +
+
+

Definition of the paths command.

+
+
+
+ +

description

+
description: string = "Dumps the JSON schema for the config. " +"The schema is dynamically created based on your available plugins. " +"Direct the output of this command to a file and include in your config with '$schema' property to get editor completion."
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: "Display the JSON schema for the config",options: ""}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "schema.handler")
+ +
+
+ +

name

+
name: string = "schema"
+ +
+
+ +

summary

+
summary: string = "dumps the JSON schema for the config"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const secureDefinition

+
secureDefinition: object
+ +
+ +

description

+
description: string = "prompt for secure configuration properties"
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: "Secure the properties in global config",options: "--global-config"},{description: "Secure the properties in user config",options: "--user-config"}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "secure.handler")
+ +
+
+ +

name

+
name: string = "secure"
+ +
+
+ +

options

+
options: { aliases: string[]; defaultValue: boolean; description: string; name: string; type: "boolean" }[] = [{name: "global-config",description: "Secure properties in global config.",aliases: ["gc"],type: "boolean",defaultValue: false},{name: "user-config",description: "Secure properties in user config.",aliases: ["uc"],type: "boolean",defaultValue: false},{name: "prune",description: "Delete properties stored in the vault for team config files that do not exist.",aliases: ["p"],type: "boolean",defaultValue: false}]
+ +
+
+ +

summary

+
summary: string = "secure configuration properties"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const selectProfileNameDesc

+
selectProfileNameDesc: object
+ +
+ +

message

+
message: string = `Specifies the name of the {{type}} ` +`profile to be used with this command. ` +`To see profiles that can be validated, issue the list action for this module. ` +`You can also load this profile by using the name on commands that support the ` +`"--{{typeOption}}" option.`
+ +
+
+
+ +

Const setDefinition

+
setDefinition: object
+ +
+ +

description

+
description: string = "create or update a configuration property"
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: "Set the property in global config",options: `"profiles.host1.profiles.service1.properties.setting" "value" --global-config`},{description: "Set the property in user config",options: `"profiles.host1.profiles.service2.properties.setting" "value" --user-config`},{description: "Set property value to JSON",options: `"profiles.host1.profiles.service3.properties.setting" "{"property":"value"}" --json`},{description: "Store the property value",options: `"profiles.host1.profiles.service1.properties.setting" "value" --secure`},{description: "Set a default zosmf profile",options: `"defaults.zosmf" "zosmfProfileName"`},{description: "Set a default tso profile",options: `"defaults.tso" "tsoProfileName"`}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "set.handler")
+ +
+
+ +

name

+
name: string = "set"
+ +
+
+ +

options

+
options: ({ aliases: string[]; defaultValue: boolean; description: string; name: string; type: "boolean" } | { defaultValue: boolean; description: string; name: string; type: "boolean" } | { description: string; name: string; type: "boolean" })[] = [{name: "global-config",description: "Set the property in global config.",aliases: ["gc"],type: "boolean",defaultValue: false},{name: "user-config",description: "Set the property in user config.",aliases: ["uc"],type: "boolean",defaultValue: false},{name: "json",description: "The property value is JSON.",type: "boolean",defaultValue: false},{name: "secure",description: "Store the property value securely. " +"If omitted, any property named in the secure array of the config file will be saved securely.",type: "boolean"}]
+ +
+
+ +

positionals

+
positionals: ({ description: string; name: string; required: true; type: "string" } | { description: string; name: string; type: "string" })[] = [{name: "property",description: "The property to set. You may specify a path using dot notation (e.g. profiles.host1.profiles.service1.properties.setting)",required: true,type: "string"},{name: "value",description: "The property value to set. The value may be JSON. Use '--json' to indicate.",type: "string"}]
+ +
+
+ +

summary

+
summary: string = "set configuration property"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const setGroupWithOnlyProfilesCommandDesc

+
setGroupWithOnlyProfilesCommandDesc: object
+ +
+ +

message

+
message: string = `The {{type}} set ${Constants.DEFAULT_SET_PROFILE_OBJECT} command allows you to set the default profiles for ` +`this command group. When a {{type}} command is issued and no profile override options are ` +`specified, the default profiles for the command group are automatically loaded for the command based on the ` +`commands profile requirements.`
+ +
+
+
+ +

Const setGroupWithOnlyProfilesListDesc

+
setGroupWithOnlyProfilesListDesc: object
+ +
+ +

message

+
message: string = `To view the default profiles, use the " ` +`{{type}} ${Constants.DEFAULT_LIST_GROUP} ${Constants.DEFAULT_LIST_PROFILE_OBJECT}" command.`
+ +
+
+
+ +

Const setGroupWithOnlyProfilesSummary

+
setGroupWithOnlyProfilesSummary: object
+ +
+ +

message

+
message: string = `Set the defaultprofiles for the {{type}} group`
+ +
+
+
+ +

Const setProfileActionDesc

+
setProfileActionDesc: object
+ +
+ +

message

+
message: string = `${setProfileActionSummary.message}.`
+ +
+
+
+ +

Const setProfileActionSummary

+
setProfileActionSummary: object
+ +
+ +

message

+
message: string = `Set which profiles are loaded by default`
+ +
+
+
+ +

Const setProfileExample

+
setProfileExample: object
+ +
+ +

message

+
message: string = `Set the default profile for type {{type}} to the profile named '{{name}}'`
+ +
+
+
+ +

Const setProfileOptionDesc

+
setProfileOptionDesc: object
+ +
+ +

message

+
message: string = `Specify aprofile for default usage within the {{type}} group. ` +`When you issue commands within the {{type}} group without a profile specified as part of the command, the default ` +`will be loaded instead.`
+ +
+
+
+ +

Const showDependenciesCommandDesc

+
showDependenciesCommandDesc: object
+ +
+ +

message

+
message: string = `View all profiles which may be used within a selected group.`
+ +
+
+
+ +

Const syntaxErrorHeader

+
syntaxErrorHeader: object
+ +
+ +

message

+
message: string = `\nSyntax Error`
+ +
+
+
+ +

Const unableToCreateProfile

+
unableToCreateProfile: object
+ +
+ +

message

+
message: string = "Unable to create the requested profile."
+ +
+
+
+ +

Const unableToDeleteProfile

+
unableToDeleteProfile: object
+ +
+ +

message

+
message: string = "Not all requested profiles could be deleted."
+ +
+
+
+ +

Const unableToFindProfile

+
unableToFindProfile: object
+ +
+ +

message

+
message: string = "Could not find or load the supplied profile name. Error details: "
+ +
+
+
+ +

Const unableToLoadRequestedProfilesError

+
unableToLoadRequestedProfilesError: object
+ +
+ +

message

+
message: string = "Command processing cannot continue: Unable to load requested or default profiles."
+ +
+
+
+ +

Const unexpectedCommandError

+
unexpectedCommandError: object
+ +
+ +

message

+
message: string = "Unexpected Command Error"
+ +
+
+
+ +

Const unexpectedCommandPreparationError

+
unexpectedCommandPreparationError: object
+ +
+ +

message

+
message: string = "An unexpected command preparation error occurred:"
+ +
+
+
+ +

Const unexpectedProfileCreationError

+
unexpectedProfileCreationError: object
+ +
+ +

message

+
message: string = `An unexpected profile creation error occurred: \n{{unexpectedError}}`
+ +
+
+
+ +

Const unexpectedProfileLoadError

+
unexpectedProfileLoadError: object
+ +
+ +

message

+
message: string = "An unexpected profile load error occurred:"
+ +
+
+
+ +

Const unexpectedProfileUpdateError

+
unexpectedProfileUpdateError: object
+ +
+ +

message

+
message: string = `An unexpected profile update error occurred: \n{{unexpectedError}}`
+ +
+
+
+ +

Const unexpectedProfilesLoadError

+
unexpectedProfilesLoadError: object
+ +
+ +

message

+
message: string = "An unexpected error occurred while loading requested profiles:"
+ +
+
+
+ +

Const uninstallDefinition

+
uninstallDefinition: object
+ +
+
+

Definition of the uninstall command.

+
+
+
+ +

description

+
description: string = "Uninstall plug-ins."
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: "Uninstall a plug-in",options : "my-plugin"},]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "uninstall.handler")
+ +
+
+ +

name

+
name: string = "uninstall"
+ +
+
+ +

positionals

+
positionals: { description: string; name: string; required: false; type: "string" }[] = [{name: "plugin...",type: "string",description: pluginDescription,required: false}]
+ +
+
+ +

summary

+
summary: string = "Uninstall a plug-in"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const updateDefinition

+
updateDefinition: object
+ +
+
+

Definition of the update command.

+
+
+
+ +

description

+
description: string = "Update plug-ins."
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: "Update a plug-in",options : "my-plugin"},{description: "Update a remote plug-in from the registry which requires authorization" +"(don't need to use this flag if you have already logged in before)",options: "my-plugin --registry https://registry.npmjs.org/ --login"}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "update.handler")
+ +
+
+ +

name

+
name: string = "update"
+ +
+
+ +

options

+
options: ({ description: string; name: string; required: false; type: "string" } | { description: string; implies: string[]; name: string; required: false; type: "boolean" })[] = [{name: "registry",type: "string",description: registryDescription,required: false},{name: "login",type: "boolean",description: loginDescription,required: false,implies: ["registry"]}]
+ +
+
+ +

positionals

+
positionals: { description: string; name: string; required: false; type: "string" }[] = [{name: "plugin...",type: "string",description: pluginDescription,required: false}]
+ +
+
+ +

summary

+
summary: string = "Update a plug-in"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const updateProfileActionDesc

+
updateProfileActionDesc: object
+ +
+ +

message

+
message: string = `Update a {{type}} profile`
+ +
+
+
+ +

Const updateProfileCommandDesc

+
updateProfileCommandDesc: object
+ +
+ +

message

+
message: string = `Update a {{type}} profile. ` +`You can update any property present within the profile configuration. The updated profile ` +`will be printed so that you can review the result of the updates.`
+ +
+
+
+ +

Const updateProfileCommandSummary

+
updateProfileCommandSummary: object
+ +
+ +

message

+
message: string = `Update existing profiles`
+ +
+
+
+ +

Const updateSchemasDefinition

+
updateSchemasDefinition: object
+ +
+ +

aliases

+
aliases: string[] = ["us"]
+ +
+
+ +

description

+
description: string = "Update schema files by looking up the directory structure.\n\n" +"Schema files up in higher level directories will always be updated. " +"To also update schema files down in lower level directories, specify the `--depth` flag."
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: "Update all schema files found in higher level directories",options: ``},{description: "Update all schema files found in higher level directories and 2 levels down the directory structure",options: `--depth 2`},]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "update-schemas.handler")
+ +
+
+ +

name

+
name: string = "update-schemas"
+ +
+
+ +

options

+
options: { defaultValue: number; description: string; name: string; type: "number" }[] = [{name: "depth",description: "Specifies how many levels down the directory structure should the schemas be updated.",type: "number",defaultValue: 0},]
+ +
+
+ +

positionals

+
positionals: undefined[] = []
+ +
+
+ +

summary

+
summary: string = "update schema files"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const validateDefinition

+
validateDefinition: object
+ +
+
+

Definition of the validate command.

+
+
+
+ +

description

+
description: string = "Validate a plug-in that has been installed."
+ +
+
+ +

examples

+
examples: { description: string; options: string }[] = [{description: `Validate a plug-in named my-plugin`,options : "my-plugin"},{description: "Validate all installed plug-ins",options : ""},{description: "Validate a plug-in named my-plugin, and treat warnings as errors",options : "my-plugin --fail-on-warning"}]
+ +
+
+ +

handler

+
handler: string = join(__dirname, "validate.handler")
+ +
+
+ +

name

+
name: string = "validate"
+ +
+
+ +

options

+
options: ({ aliases: string[]; defaultValue: boolean; description: string; name: string; required: false; type: "boolean" } | { aliases: string[]; defaultValue: boolean; description: string; implies: string[]; name: string; required: false; type: "boolean" })[] = [{name: "fail-on-error",aliases: ["foe"],type: "boolean",description: "Enables throwing an error and setting an error code if plugin validation detects an error",required: false,defaultValue: true},{name: "fail-on-warning",aliases: ["fow"],type: "boolean",description: "Treat validation warnings as errors. Requires fail-on-error.",required: false,defaultValue: false,implies: ["fail-on-error"]}]
+ +
+
+ +

positionals

+
positionals: { description: string; name: string; required: false; type: "string" }[] = [{name: "plugin",type: "string",description: pluginDescription,required: false}]
+ +
+
+ +

summary

+
summary: string = "Validate a plug-in"
+ +
+
+ +

type

+
type: "command" = "command"
+ +
+
+
+ +

Const validateProfileCommandDesc

+
validateProfileCommandDesc: object
+ +
+ +

message

+
message: string = `Test the validity of a {{type}} profile.`
+ +
+
+
+ +

Const validateProfileCommandSummary

+
validateProfileCommandSummary: object
+ +
+ +

message

+
message: string = `Test the validity of a profile`
+ +
+
+
+ +

Const validateProfileGroupDesc

+
validateProfileGroupDesc: object
+ +
+ +

message

+
message: string = `Test the validity of your profiles.`
+ +
+
+
+ +

Const validateProfileNameDesc

+
validateProfileNameDesc: object
+ +
+ +

message

+
message: string = `Specifies the name of the {{type}} ` +` profile to be validated. ` +`If the --print-plan-only option is specified, then only a plan to validate the specified profile will be displayed.`
+ +
+
+
+ +

Const validateProfileOptionDesc

+
validateProfileOptionDesc: object
+ +
+ +

message

+
message: string = `Validate the state of a group.`
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/modules/_zowe_provisioning_for_zowe_sdk.html b/static/v2.15.x/typedoc/modules/_zowe_provisioning_for_zowe_sdk.html new file mode 100644 index 0000000000..314b0bdac2 --- /dev/null +++ b/static/v2.15.x/typedoc/modules/_zowe_provisioning_for_zowe_sdk.html @@ -0,0 +1,1897 @@ + + + + + + @zowe/provisioning-for-zowe-sdk | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @zowe/provisioning-for-zowe-sdk

+
+
+
+
+
+
+
+
+ +

Provisioning Package

+
+

Contains APIs to interact with the z/OS provisioning APIs

+ +

API Examples

+
+

List z/OSMF Published Catalog Templates

+
import { ProfileInfo, TextUtils } from "@zowe/imperative";
+import { explainPublishedTemplatesFull, explainPublishedTemplatesSummary, ListCatalogTemplates,
+    ProvisioningConstants } from "@zowe/provisioning-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const templates = await ListCatalogTemplates.listCatalogCommon(session, ProvisioningConstants.ZOSMF_VERSION);
+    let prettifiedTemplates: any = {};
+    if (process.argv.slice(2).includes("--all") || process.argv.slice(2).includes("-a")) {
+        prettifiedTemplates = TextUtils.explainObject(templates, explainPublishedTemplatesFull, true);
+    } else {
+        prettifiedTemplates = TextUtils.explainObject(templates, explainPublishedTemplatesSummary, false);
+    }
+    const response = "z/OSMF Service Catalog templates\n" + TextUtils.prettyJson(prettifiedTemplates);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+

Provision a Published Software Service Template

+
import { ProfileInfo, TextUtils } from "@zowe/imperative";
+import { ProvisioningConstants, explainProvisionTemplateResponse,
+    ProvisionPublishedTemplate } from "@zowe/provisioning-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const templateName = "myTemplate";
+    const response = await ProvisionPublishedTemplate.provisionTemplate(session,
+        ProvisioningConstants.ZOSMF_VERSION, templateName);
+    let prettyResponse = TextUtils.explainObject(response, explainProvisionTemplateResponse, false);
+    prettyResponse = TextUtils.prettyJson(prettyResponse);
+    console.log(prettyResponse);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+

List Provisioned Instances and Perform an Action to the Matching Instance

+
import { ProfileInfo, TextUtils } from "@zowe/imperative";
+import { explainActionResponse, IProvisionedInstance, ListRegistryInstances, PerformAction,
+    ProvisioningConstants } from "@zowe/provisioning-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const instanceName = "myInstance";
+    const actionName = "myAction";
+    const registry = await ListRegistryInstances.listFilteredRegistry(session,
+        ProvisioningConstants.ZOSMF_VERSION, null, instanceName);
+    const instances: IProvisionedInstance[] = registry["scr-list"];
+    if (instances == null) {
+        console.error("No instance with name " + instanceName + " was found");
+    } else if (instances.length === 1) {
+        const id = instances.pop()["object-id"];
+        const response = await PerformAction.doProvisioningActionCommon(session,
+            ProvisioningConstants.ZOSMF_VERSION, id, actionName);
+        const pretty = TextUtils.explainObject(response, explainActionResponse, false);
+        console.log(TextUtils.prettyJson(pretty));
+    } else if (instances.length > 1) {
+        console.error("Multiple instances with name " + instanceName + " were found");
+    }
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+
+
+
+

Index

+
+
+
+

Classes

+ +
+
+

Interfaces

+ +
+
+

Object literals

+ +
+
+
+
+
+

Object literals

+
+ +

Const explainActionResponse

+
explainActionResponse: object
+ +
+ +

action-id

+
action-id: string = "Action Id"
+ +
+
+ +

action-uri

+
action-uri: string = "Action URI"
+ +
+
+ +

explainedParentKey

+
explainedParentKey: string = "Actions"
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+
+ +

Const explainAtCreateVariable

+
explainAtCreateVariable: object
+ +
+
+

Main explanation map object for create provisioned instance variables.

+
+
+
memberof
+

IProvisionedInstanceVariable

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: string = "At Create Variables"
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+
+ +

Const explainPromptVariable

+
explainPromptVariable: object
+ +
+
+

Main explanation map object for provisioned instance prompt variables output.

+
+
+
memberof
+

IProvisionedInstanceVariable

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: string = "Prompt Variables"
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+
+ +

Const explainPromptVariableFull

+
explainPromptVariableFull: object
+ +
+
+

Main explanation map object for full output.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+
+ +

Const explainPromptVariableSummary

+
explainPromptVariableSummary: object
+ +
+
+

Main explanation map object for summary output.

+
+
+
memberof
+

IPromptVariable

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: string = "required, min, max, must-be-choice, choices"
+ +
+
+
+ +

Const explainProvisionTemplateResponse

+
explainProvisionTemplateResponse: object
+ +
+
+

Main explanation map object for summary output.

+
+
+
memberof
+

IProvisionTemplateResponse

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+ +

registry-info

+
registry-info: any = explainTemplateRegistryInfoResponse
+ +
+
+ +

system-nickname

+
system-nickname: string = "System Nickname"
+ +
+
+ +

workflow-info

+
workflow-info: any = explainTemplateWorkflowInfoResponse
+ +
+
+
+ +

Const explainProvisionedInstanceActionsFull

+
explainProvisionedInstanceActionsFull: object
+ +
+
+

Main explanation map object for full output.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+ +

at-create-variables

+
at-create-variables: any = explainAtCreateVariable
+ +
+
+ +

explainedParentKey

+
explainedParentKey: string = "Actions"
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+ +

prompt-variables

+
prompt-variables: any = explainPromptVariable
+ +
+
+ +

variables

+
variables: any = explainProvisionedInstanceVariable
+ +
+
+
+ +

Const explainProvisionedInstanceActionsSummary

+
explainProvisionedInstanceActionsSummary: object
+ +
+
+

Main explanation map object for summary output.

+
+
+
memberof
+

IProvisionedInstanceActions

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: string = "Actions"
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+
+ +

Const explainProvisionedInstanceExtended

+
explainProvisionedInstanceExtended: object
+ +
+
+

Main explanation map object for extended provisioned instance output.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+ +

actions

+
actions: any = explainProvisionedInstanceActionsSummary
+ +
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: string = "variables"
+ +
+
+
+ +

Const explainProvisionedInstanceFull

+
explainProvisionedInstanceFull: object
+ +
+
+

Main explanation map object for full provisioned instance output.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+ +

actions

+
actions: any = explainProvisionedInstanceActionsFull
+ +
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+ +

variables

+
variables: any = explainProvisionedInstanceVariable
+ +
+
+
+ +

Const explainProvisionedInstanceSummary

+
explainProvisionedInstanceSummary: object
+ +
+
+

Main explanation map object for provisioned instance summary output without variables and actions.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: string = "variables,actions"
+ +
+
+
+ +

Const explainProvisionedInstanceSummaryWithActions

+
explainProvisionedInstanceSummaryWithActions: object
+ +
+
+

Main explanation map object for provisioned instance summary output with actions.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+ +

actions

+
actions: any = explainProvisionedInstanceActionsSummary
+ +
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: string = "variables"
+ +
+
+
+ +

Const explainProvisionedInstanceSummaryWithVars

+
explainProvisionedInstanceSummaryWithVars: object
+ +
+
+

Main explanation map object for provisioned instance summary output with variables.

+
+
+
memberof
+

IProvisionedInstance

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: string = "actions"
+ +
+
+ +

variables

+
variables: any = explainProvisionedInstanceVariable
+ +
+
+
+ +

Const explainProvisionedInstanceVariable

+
explainProvisionedInstanceVariable: object
+ +
+
+

Main explanation map object for the output of provisioned instance variables.

+
+
+
memberof
+

IProvisionedInstanceVariable

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: string = "Variables"
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+
+ +

Const explainProvisionedInstancesFull

+
explainProvisionedInstancesFull: object
+ +
+
+

Main explanation map object for full output.

+
+
+
memberof
+

IProvisionedInstances

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+ +

scr-list

+
scr-list: any = explainProvisionedInstanceFull
+ +
+
+
+ +

Const explainProvisionedInstancesSummary

+
explainProvisionedInstancesSummary: object
+ +
+
+

Main explanation map object for summary output.

+
+
+
memberof
+

IProvisionedInstances

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+ +

scr-list

+
scr-list: any = explainProvisionedInstanceSummary
+ +
+
+
+ +

Const explainPublishedTemplateFull

+
explainPublishedTemplateFull: object
+ +
+
+

Main explanation map object for full output

+
+
+
memberof
+

IPublishedTemplate

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: string = "Published Templates"
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+
+ +

Const explainPublishedTemplateInfoFull

+
explainPublishedTemplateInfoFull: object
+ +
+
+

Main explanation map object for full output

+
+
+
memberof
+

IPublishedTemplateInfo

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+ +

prompt-variables

+
prompt-variables: any = explainPromptVariableFull
+ +
+
+
+ +

Const explainPublishedTemplateInfoSummary

+
explainPublishedTemplateInfoSummary: object
+ +
+
+

Main explanation map object for summary output

+
+
+
memberof
+

IPublishedTemplateInfo

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+ +

prompt-variables

+
prompt-variables: any = explainPromptVariableSummary
+ +
+
+
+ +

Const explainPublishedTemplateSummary

+
explainPublishedTemplateSummary: object
+ +
+
+

Main explanation map object for summary output

+
+
+
memberof
+

IPublishedTemplate

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: string = "Published Templates"
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+
+ +

Const explainPublishedTemplatesFull

+
explainPublishedTemplatesFull: object
+ +
+
+

Main explanation map object for full output.

+
+
+
memberof
+

IPublishedTemplates

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+ +

psc-list

+
psc-list: any = explainPublishedTemplateFull
+ +
+
+
+ +

Const explainPublishedTemplatesSummary

+
explainPublishedTemplatesSummary: object
+ +
+
+

Main explanation map object for summary output.

+
+
+
memberof
+

IPublishedTemplates

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: null = null
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+ +

psc-list

+
psc-list: any = explainPublishedTemplateSummary
+ +
+
+
+ +

Const explainTemplateRegistryInfoResponse

+
explainTemplateRegistryInfoResponse: object
+ +
+
+

Main explanation map object for summary output.

+
+
+
memberof
+

ITemplateRegistryInfo

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: string = "Registry Info"
+ +
+
+ +

external-name

+
external-name: string = "Name"
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+ +

object-id

+
object-id: string = "Id"
+ +
+
+
+ +

Const explainTemplateWorkflowInfoResponse

+
explainTemplateWorkflowInfoResponse: object
+ +
+
+

Main explanation map object for workflow-info response output.

+
+
+
memberof
+

ITemplateRegistryInfo

+
+
+
+
+ +

explainedParentKey

+
explainedParentKey: string = "Workflow Info"
+ +
+
+ +

ignoredKeys

+
ignoredKeys: null = null
+ +
+
+ +

vendor

+
vendor: string = "Vendor"
+ +
+
+ +

workflowDescription

+
workflowDescription: string = "Description"
+ +
+
+ +

workflowID

+
workflowID: string = "Id"
+ +
+
+ +

workflowKey

+
workflowKey: string = "Key"
+ +
+
+ +

workflowVersion

+
workflowVersion: string = "Version"
+ +
+
+
+ +

Const noAccountInfo

+
noAccountInfo: object
+ +
+
+

No account number was provided error message.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No account number was supplied.`
+ +
+
+
+ +

Const noActionName

+
noActionName: object
+ +
+
+

Error message that no template name parameter string was supplied.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No action name parameter was supplied.`
+ +
+
+
+ +

Const noInstanceId

+
noInstanceId: object
+ +
+
+

Error message that no instance-id parameter string was supplied.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No instance-id parameter was supplied.`
+ +
+
+
+ +

Const noSessionProvisioning

+
noSessionProvisioning: object
+ +
+
+

Error message that no session provided.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No session was supplied.`
+ +
+
+
+ +

Const noTemplateName

+
noTemplateName: object
+ +
+
+

Error message that no template name parameter string was supplied.

+
+
+
static
+
+
memberof
+

ProvisioningConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No template name parameter was supplied.`
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/modules/_zowe_zos_console_for_zowe_sdk.html b/static/v2.15.x/typedoc/modules/_zowe_zos_console_for_zowe_sdk.html new file mode 100644 index 0000000000..a626499100 --- /dev/null +++ b/static/v2.15.x/typedoc/modules/_zowe_zos_console_for_zowe_sdk.html @@ -0,0 +1,653 @@ + + + + + + @zowe/zos-console-for-zowe-sdk | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @zowe/zos-console-for-zowe-sdk

+
+
+
+
+
+
+
+
+ +

z/OS Console Package

+
+

Contains APIs to interact with the z/OS console (using z/OSMF console REST endpoints).

+ +

API Examples

+
+

Submit a command to the z/OS console

+
import { ProfileInfo } from "@zowe/imperative";
+import { IIssueParms, IssueCommand } from "@zowe/zos-console-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const parms: IIssueParms = {
+        command: "D IPLINFO",
+        sysplexSystem: undefined,
+        solicitedKeyword: undefined,
+        async: "N"
+    };
+    const response = await IssueCommand.issue(session, parms);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+ +

+
+

Get the response from a command sent to the z/OS console

+
import { ProfileInfo } from "@zowe/imperative";
+import { CollectCommand, ICollectParms } from "@zowe/zos-console-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const parms: ICollectParms = {
+        commandResponseKey: "KEY",
+        waitToCollect: undefined,
+        followUpAttempts: undefined
+    };
+    const response = await CollectCommand.collect(session, parms);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+
+
+
+

Index

+
+ +
+
+
+

Type aliases

+
+ +

ConsoleResponse

+
ConsoleResponse: (response: IConsoleResponse) => void
+ +
+

Type declaration

+ +
+
+
+
+

Object literals

+
+ +

Const collectProcessingDetails

+
collectProcessingDetails: object
+ +
+ +

message

+
message: string = `Collect processing - timeout: {{timer}}, followUpCounter: {{counter}}`
+ +
+
+
+ +

Const decreaseCounter

+
decreaseCounter: object
+ +
+ +

message

+
message: string = `Decreasing follow up counter`
+ +
+
+
+ +

Const displayCollectError

+
displayCollectError: object
+ +
+ +

message

+
message: string = apiErrorHeader.message + ` Collect error: {{data}}`
+ +
+
+
+ +

Const displayCollectResponse

+
displayCollectResponse: object
+ +
+ +

message

+
message: string = `Collect response: {{data}}`
+ +
+
+
+ +

Const displayError

+
displayError: object
+ +
+ +

message

+
message: string = apiErrorHeader.message + ` Populating console error: {{data}}`
+ +
+
+
+ +

Const displayResponse

+
displayResponse: object
+ +
+ +

message

+
message: string = `Populating console response: {{data}}`
+ +
+
+
+ +

Const noCollectParameters

+
noCollectParameters: object
+ +
+ +

message

+
message: string = apiErrorHeader.message + ` No console collect parameters were supplied.`
+ +
+
+
+ +

Const noCommandKey

+
noCommandKey: object
+ +
+ +

message

+
message: string = apiErrorHeader.message + ` No command response key was supplied.`
+ +
+
+
+ +

Const noConsoleInput

+
noConsoleInput: object
+ +
+ +

message

+
message: string = apiErrorHeader.message + ` No console issue parameters were supplied.`
+ +
+
+
+ +

Const noConsoleName

+
noConsoleName: object
+ +
+ +

message

+
message: string = apiErrorHeader.message + ` No console name was supplied.`
+ +
+
+
+ +

Const noZosmfInput

+
noZosmfInput: object
+ +
+ +

message

+
message: string = apiErrorHeader.message + ` No zosmf console input parameters were supplied.`
+ +
+
+
+ +

Const resetCounter

+
resetCounter: object
+ +
+ +

message

+
message: string = `Reset follow up counter`
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/modules/_zowe_zos_files_for_zowe_sdk.html b/static/v2.15.x/typedoc/modules/_zowe_zos_files_for_zowe_sdk.html new file mode 100644 index 0000000000..88d0701f36 --- /dev/null +++ b/static/v2.15.x/typedoc/modules/_zowe_zos_files_for_zowe_sdk.html @@ -0,0 +1,3994 @@ + + + + + + @zowe/zos-files-for-zowe-sdk | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @zowe/zos-files-for-zowe-sdk

+
+
+
+
+
+
+
+
+ +

z/OS Files Package

+
+

Contains APIs to interact with files and data sets on z/OS (using z/OSMF files REST endpoints).

+ +

API Examples

+
+

Create a dataset

+
import { ProfileInfo } from "@zowe/imperative";
+import { Create, CreateDataSetTypeEnum, ICreateDataSetOptions } from "@zowe/zos-files-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const dataset = "ZOWEUSER.PUBLIC.NEW.DATASET";
+    const dataSetType = CreateDataSetTypeEnum.DATA_SET_CLASSIC;
+    const options: ICreateDataSetOptions = {
+        primary: 10,
+        secondary: 1,
+        alcunit: "TRK",
+        lrecl: 80
+    };
+    const response = await Create.dataSet(session, dataSetType, dataset, options);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+ +

+
+

Download all datasets in a partitioned dataset

+
import { ProfileInfo } from "@zowe/imperative";
+import { Download, IDownloadOptions } from "@zowe/zos-files-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const dataset = "ZOWEUSER.PUBLIC.YOUR.DATASET.HERE";
+    const options: IDownloadOptions = { failFast: false };
+    const response = await Download.allMembers(session, dataset, options);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+ +

+
+

List datasets on z/OS

+
import { ProfileInfo } from "@zowe/imperative";
+import { IListOptions, List } from "@zowe/zos-files-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const dataset = "ZOWEUSER.*";
+    const options: IListOptions = {};
+    const response = await List.dataSet(session, dataset, options);
+    for (const obj of response.apiResponse.items) {
+        if (obj) console.log(obj.dsname.toString());
+    }
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+ +

+
+

Upload a file to Unix System Services

+
import { ProfileInfo } from "@zowe/imperative";
+import { IUploadOptions, Upload } from "@zowe/zos-files-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const localFile = "C:/Users/zoweuser/Documents/testFile.txt";
+    const remoteLocation = "/u/zoweuser/file.txt";
+    const options: IUploadOptions = { binary: true };
+    const response = await Upload.fileToUssFile(session, localFile, remoteLocation, options);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+
+
+
+

Index

+
+ +
+
+
+

Type aliases

+
+ +

CLIENT_PROPERTY

+
CLIENT_PROPERTY: "requestSuccess" | "requestFailure" | "data" | "dataString" | "response" | "session" | "log"
+ +
+
+

String type definition for properties of abstractRestClient that have a getter set. + This can be safely used in a getter call as a variable for the abstractRestClient object.

+
+
+
export
+
+
+
+
+
+ +

IMountFsMode

+
IMountFsMode: "rdonly" | "rdwr"
+ +
+
+

Type for the mode option of the mount file-system API.

+
+
+
export
+
+
+
+
+
+ +

IRecallOptions

+
IRecallOptions: IMigrateOptions
+ +
+
+

This interface defines the options that can be sent into the recall data set function.

+
+
+
+
+ +

ZosmfMigratedRecallOptions

+
ZosmfMigratedRecallOptions: "wait" | "nowait" | "error"
+ +
+
+

z/OSMF options for recall of migrated data sets. See the z/OSMF REST API publication for complete details.

+
+
+
export
+
+
+
+
+
+
+

Object literals

+
+ +

Const CreateDefaults

+
CreateDefaults: object
+ +
+
+

Defaults to be used as options for the different types of data sets that can be created

+
+
+
+ +

DATA_SET

+
DATA_SET: object
+ +
+
+

Specifies all the defaults to create non-vsam data sets

+
+
+
+ +

BINARY

+
BINARY: object
+ +
+
+

Specifies the defaults used by the Zos Files API to create a data set used for binaries

+
+
+
+ +

alcunit

+
alcunit: string = "CYL"
+ +
+
+ +

blksize

+
blksize: number = 27998
+ +
+
+ +

dirblk

+
dirblk: number = 25
+ +
+
+ +

dsorg

+
dsorg: string = "PO"
+ +
+
+ +

lrecl

+
lrecl: number = 27998
+ +
+
+ +

primary

+
primary: number = 10
+ +
+
+ +

recfm

+
recfm: string = "U"
+ +
+
+
+ +

BLANK

+
BLANK: object
+ +
+
+

Specifies the defaults used by the Zos Files API to create a blank data set

+
+
+
+ +

primary

+
primary: number = 1
+ +
+
+
+ +

C

+
C: object
+ +
+
+

Specifies the defaults used by the Zos Files API to create a data set used for C code

+
+
+
+ +

alcunit

+
alcunit: string = "CYL"
+ +
+
+ +

blksize

+
blksize: number = 32760
+ +
+
+ +

dirblk

+
dirblk: number = 25
+ +
+
+ +

dsorg

+
dsorg: string = "PO"
+ +
+
+ +

lrecl

+
lrecl: number = 260
+ +
+
+ +

primary

+
primary: number = 1
+ +
+
+ +

recfm

+
recfm: string = "VB"
+ +
+
+
+ +

CLASSIC

+
CLASSIC: object
+ +
+
+

Specifies the defaults used by the Zos Files API to create a classic data set

+
+
+
+ +

alcunit

+
alcunit: string = "CYL"
+ +
+
+ +

blksize

+
blksize: number = 6160
+ +
+
+ +

dirblk

+
dirblk: number = 25
+ +
+
+ +

dsorg

+
dsorg: string = "PO"
+ +
+
+ +

lrecl

+
lrecl: number = 80
+ +
+
+ +

primary

+
primary: number = 1
+ +
+
+ +

recfm

+
recfm: string = "FB"
+ +
+
+
+ +

PARTITIONED

+
PARTITIONED: object
+ +
+
+

Specifies the defaults used by the Zos Files API to create a partitioned data set

+
+
+
+ +

alcunit

+
alcunit: string = "CYL"
+ +
+
+ +

blksize

+
blksize: number = 6160
+ +
+
+ +

dirblk

+
dirblk: number = 5
+ +
+
+ +

dsorg

+
dsorg: string = "PO"
+ +
+
+ +

lrecl

+
lrecl: number = 80
+ +
+
+ +

primary

+
primary: number = 1
+ +
+
+ +

recfm

+
recfm: string = "FB"
+ +
+
+
+ +

SEQUENTIAL

+
SEQUENTIAL: object
+ +
+
+

Specifies the defaults used by the Zos Files API to create a sequential data set

+
+
+
+ +

alcunit

+
alcunit: string = "CYL"
+ +
+
+ +

blksize

+
blksize: number = 6160
+ +
+
+ +

dsorg

+
dsorg: string = "PS"
+ +
+
+ +

lrecl

+
lrecl: number = 80
+ +
+
+ +

primary

+
primary: number = 1
+ +
+
+ +

recfm

+
recfm: string = "FB"
+ +
+
+
+
+ +

VSAM

+
VSAM: object
+ +
+
+

Specifies the defaults used by the Zos Files API to create a VSAM cluster

+
+
+
+ +

alcunit

+
alcunit: string = "KB"
+ +
+
+ +

dsorg

+
dsorg: string = "INDEXED"
+ +
+
+ +

primary

+
primary: number = 840
+ +
+
+
+
+ +

Const ZosFilesConstants

+
ZosFilesConstants: object
+ +
+
+

Constants to be used by the API

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+ +

MAX_ALLOC_QUANTITY

+
MAX_ALLOC_QUANTITY: number = 16777215
+ +
+
+

Maximum value for primary and secondary allocation

+
+
+
+
+ +

MAX_AMS_BUFFER

+
MAX_AMS_BUFFER: number = 2
+ +
+
+

Maximum numbers of characters to allow for the continuation character on AMS statements

+
+
+
+
+ +

MAX_AMS_LINE

+
MAX_AMS_LINE: number = 255
+ +
+
+

Maximum length of an AMS statement

+
+
+
+
+ +

MAX_RETAIN_DAYS

+
MAX_RETAIN_DAYS: number = 93000
+ +
+
+

Maximum numbers of days for which to retain a dataset.

+
+
+
+
+ +

MIN_RETAIN_DAYS

+
MIN_RETAIN_DAYS: number = 0
+ +
+
+

Minimum numbers of days for which to retain a dataset.

+
+
+
+
+ +

RESOURCE

+
RESOURCE: string = "/zosmf/restfiles"
+ +
+
+

Specifies the z/OS data set and file REST interface

+
+
+
+
+ +

RES_AMS

+
RES_AMS: string = "/ams"
+ +
+
+

Indicator of an AMS request

+
+
+
+
+ +

RES_DEPTH

+
RES_DEPTH: string = "depth"
+ +
+
+

Indicator of the depth parameter for files operations

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_DS_FILES

+
RES_DS_FILES: string = "/ds"
+ +
+
+

Indicator of a data set request

+
+
+
+
+ +

RES_DS_LEVEL

+
RES_DS_LEVEL: string = "dslevel"
+ +
+
+

Indicator the query parameters used to qualify the request

+
+
+
+
+ +

RES_DS_MEMBERS

+
RES_DS_MEMBERS: string = "/member"
+ +
+
+

Indicator of a members request

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_FILESYS

+
RES_FILESYS: string = "filesys"
+ +
+
+

Indicator of the filesystem behavior parameter for files operations

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_FSNAME

+
RES_FSNAME: string = "fsname"
+ +
+
+

Indicator of a ds file name

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_GROUP

+
RES_GROUP: string = "group"
+ +
+
+

Indicator of the group parameter for files operations

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_MFS

+
RES_MFS: string = "/mfs"
+ +
+
+

Indicator of a z/OS mfs

+
+
+
+
+ +

RES_MTIME

+
RES_MTIME: string = "mtime"
+ +
+
+

Indicator of the modification time parameter for files operations

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_NAME

+
RES_NAME: string = "name"
+ +
+
+

Indicator of the name parameter for files operations

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_PATH

+
RES_PATH: string = "path"
+ +
+
+

Indicator of a USS File request

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_PERM

+
RES_PERM: string = "perm"
+ +
+
+

Indicator of the permission octal mask parameter for files operations

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_SIZE

+
RES_SIZE: string = "size"
+ +
+
+

Indicator of the size parameter for files operations

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_SYMLINKS

+
RES_SYMLINKS: string = "symlinks"
+ +
+
+

Indicator of the symlink behavior parameter for files operations

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_TYPE

+
RES_TYPE: string = "type"
+ +
+
+

Indicator of the file type parameter for files operations

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_USER

+
RES_USER: string = "user"
+ +
+
+

Indicator of the user parameter for files operations

+
+
+
memberof
+

ZosFilesConstants

+
+
+
+
+
+ +

RES_USS_FILES

+
RES_USS_FILES: string = "/fs"
+ +
+
+

Indicator of a USS File request

+
+
+
+
+ +

RES_ZFS_FILES

+
RES_ZFS_FILES: string = "/mfs/zfs"
+ +
+
+

Indicator of a z/OS file system request

+
+
+
+
+ +

VSAM_ALCUNIT_CHOICES

+
VSAM_ALCUNIT_CHOICES: string[] = ["CYL", "TRK", "MB", "KB", "REC"]
+ +
+
+

The set of allocation unit choices for VSAM files

+
+
+
+
+ +

VSAM_DSORG_CHOICES

+
VSAM_DSORG_CHOICES: string[] = ["INDEXED", "IXD", "LINEAR", "LIN", "NONINDEXED", "NIXD", "NUMBERED", "NUMD", "ZFS"]
+ +
+
+

The set of dataset organization choices for VSAM files

+
+
+
+
+
+ +

Const ZosFilesMessages

+
ZosFilesMessages: object
+ +
+
+

Messages to be used as command responses for different scenarios

+
+
+
memberof
+

ZosFilesMessages

+
+
+
+
+ +

allDataSetsArchived

+
allDataSetsArchived: object
+ +
+
+

Message indicating that all data sets matching the provided patterns are archived.

+
+
+
deprecated
+
+
+
+
+ +

message

+
message: string = "All data sets matching the selected pattern(s) were archived."
+ +
+
+
+ +

amsCommandExecutedSuccessfully

+
amsCommandExecutedSuccessfully: object
+ +
+
+

Message indicating that the AMS commands was executed successfully

+
+
+
+ +

message

+
message: string = "AMS command executed successfully."
+ +
+
+
+ +

attributeTitle

+
attributeTitle: object
+ +
+
+

Message indicating the attributes are used during data set creation

+
+
+
+ +

message

+
message: string = "The following attributes are used during creation:"
+ +
+
+
+ +

attributesFileNotFound

+
attributesFileNotFound: object
+ +
+
+

Messaging indicating an attributes file was not found

+
+
+
+ +

message

+
message: string = "Attributes file {{file}} does not exist"
+ +
+
+
+ +

commonFor

+
commonFor: object
+ +
+
+

Message to be used when throwing an imperative error during data set creation

+
+
+
+ +

message

+
message: string = "for"
+ +
+
+
+ +

commonWithValue

+
commonWithValue: object
+ +
+
+

Message to be used when throwing an imperative error during data set creation

+
+
+
+ +

message

+
message: string = "with value"
+ +
+
+
+ +

dataSetCreatedSuccessfully

+
dataSetCreatedSuccessfully: object
+ +
+
+

Message indicating that the data set was created successfully

+
+
+
+ +

message

+
message: string = "Data set created successfully."
+ +
+
+
+ +

dataSetRenamedSuccessfully

+
dataSetRenamedSuccessfully: object
+ +
+
+

Message indicating that the data set has been renamed successfully.

+
+
+
+ +

message

+
message: string = "Data set renamed successfully."
+ +
+
+
+ +

dataSetUploadedSuccessfully

+
dataSetUploadedSuccessfully: object
+ +
+
+

Message indicating that file is uploaded to data set successfully

+
+
+
+ +

message

+
message: string = "Data set uploaded successfully."
+ +
+
+
+ +

dataSetsMatchedPattern

+
dataSetsMatchedPattern: object
+ +
+
+

Message indicating that the data sets matching pattern were listed successfully

+
+
+
+ +

message

+
message: string = "%d data set(s) were found matching pattern."
+ +
+
+
+ +

datasetAllocateLikeNotFound

+
datasetAllocateLikeNotFound: object
+ +
+
+

Message indicating that the data set allocation was aborted

+
+
+
+ +

message

+
message: string = "Data set allocation aborted. The "allocate like" data set was not found."
+ +
+
+
+ +

datasetCopiedAborted

+
datasetCopiedAborted: object
+ +
+
+

Message indicating that the data set was copied was aborted

+
+
+
+ +

message

+
message: string = "Data set copied aborted. The existing target data set was not overwritten."
+ +
+
+
+ +

datasetCopiedAbortedNoPDS

+
datasetCopiedAbortedNoPDS: object
+ +
+
+

Message indicating that the data set was copied was aborted

+
+
+
+ +

message

+
message: string = "Data set copied aborted. Copying from a PDS to PDS is not supported when using the 'dsclp' option."
+ +
+
+
+ +

datasetCopiedAbortedNoTargetDS

+
datasetCopiedAbortedNoTargetDS: object
+ +
+
+

Message indicating that the data set was copied was aborted

+
+
+
+ +

message

+
message: string = "Data set copied aborted. The source data set was not found."
+ +
+
+
+ +

datasetCopiedAbortedTargetNotPDSMember

+
datasetCopiedAbortedTargetNotPDSMember: object
+ +
+
+

Message indicating that the data set was copied was aborted

+
+
+
+ +

message

+
message: string = "Data set copied aborted. Copying to a PDS without a member name is not supported when using the 'dsclp' option."
+ +
+
+
+ +

datasetCopiedSuccessfully

+
datasetCopiedSuccessfully: object
+ +
+
+

Message indicating that the data set was copied successfully

+
+
+
+ +

message

+
message: string = "Data set copied successfully."
+ +
+
+
+ +

datasetDeletedSuccessfully

+
datasetDeletedSuccessfully: object
+ +
+
+

Message indicating that the data set was deleted successfully

+
+
+
+ +

message

+
message: string = "Data set deleted successfully."
+ +
+
+
+ +

datasetDeletionRequested

+
datasetDeletionRequested: object
+ +
+
+

Message indicating that the data set was deleted successfully.

+
+
+
+ +

message

+
message: string = "Data set deletion requested."
+ +
+
+
+ +

datasetDownloadFailed

+
datasetDownloadFailed: object
+ +
+
+

Message indicating that the following data sets failed to properly download

+
+
+
+ +

message

+
message: string = "Failed to download the following data sets:"
+ +
+
+
+ +

datasetDownloadedSuccessfully

+
datasetDownloadedSuccessfully: object
+ +
+
+

Message indicating that the data set was downloaded successfully

+
+
+
+ +

message

+
message: string = "Data set downloaded successfully."
+ +
+
+
+ +

datasetDownloadedWithDestination

+
datasetDownloadedWithDestination: object
+ +
+
+

Message indicating that the data set was downloaded successfully

+
+
+
+ +

message

+
message: string = "Data set downloaded successfully.Destination: %s"
+ +
+
+
+ +

datasetMemberCopiedAborted

+
datasetMemberCopiedAborted: object
+ +
+
+

Message indicating that the data set member was copied was aborted

+
+
+
+ +

message

+
message: string = "Data set copied aborted. The existing target data set member was not overwritten."
+ +
+
+
+ +

datasetMigrationRequested

+
datasetMigrationRequested: object
+ +
+
+

Message indicating that the data set was migrated successfully.

+
+
+
+ +

message

+
message: string = "Data set migration requested."
+ +
+
+
+ +

datasetRecallRequested

+
datasetRecallRequested: object
+ +
+
+

Message indicating that the data set was recalled successfully.

+
+
+
+ +

message

+
message: string = "Data set recall requested."
+ +
+
+
+ +

datasetRecalledSuccessfully

+
datasetRecalledSuccessfully: object
+ +
+
+

Message indicating that the data set was recalled successfully.

+
+
+
+ +

message

+
message: string = "Data set recall requested."
+ +
+
+
+ +

datasetsDownloadedSuccessfully

+
datasetsDownloadedSuccessfully: object
+ +
+
+

Message indicating that the data sets matching pattern was downloaded successfully

+
+
+
deprecated
+
+
+
+
+ +

message

+
message: string = "Data sets matching pattern downloaded successfully.Destination: %s"
+ +
+
+
+ +

errorParsingAttributesFile

+
errorParsingAttributesFile: object
+ +
+
+

Message indicating an error parsing an attributes file

+
+
+
+ +

message

+
message: string = "Error parsing attributes file {{file}}: {{message}}"
+ +
+
+
+ +

errorReadingAttributesFile

+
errorReadingAttributesFile: object
+ +
+
+

Message indicating an error reading an attributes file

+
+
+
+ +

message

+
message: string = "Could not read attributes file {{file}}: {{message}}"
+ +
+
+
+ +

failedToDownloadDataSets

+
failedToDownloadDataSets: object
+ +
+
+

Message indicating that some or all data sets failed to download

+
+
+
+ +

message

+
message: string = "Failed to download data sets"
+ +
+
+
+ +

fsMountedSuccessfully

+
fsMountedSuccessfully: object
+ +
+
+

Message indicating that the file system was mounted successfully.

+
+
+
+ +

message

+
message: string = "File system mounted successfully."
+ +
+
+
+ +

fsUnmountedSuccessfully

+
fsUnmountedSuccessfully: object
+ +
+
+

Message indicating that the file system was unmounted successfully.

+
+
+
+ +

message

+
message: string = "File system unmounted successfully."
+ +
+
+
+ +

invalidAlcunitOption

+
invalidAlcunitOption: object
+ +
+
+

Message indicating invalid 'create' command 'alcunit' option

+
+
+
+ +

message

+
message: string = "Invalid zos-files create command 'alcunit' option: "
+ +
+
+
+ +

invalidAttributesSyntax

+
invalidAttributesSyntax: object
+ +
+
+

Messaging indicating invalid syntax in .zosattributes file

+
+
+
+ +

message

+
message: string = "Syntax error on line {{lineNumber}} - expected <pattern> <local encoding> <remote encoding>."
+ +
+
+
+ +

invalidDsntypeOption

+
invalidDsntypeOption: object
+ +
+
+

Message indicating invalid 'create' command 'dsntype' option

+
+
+
+ +

message

+
message: string = "Invalid zos-files create command 'dsntype' option: "
+ +
+
+
+ +

invalidDsorgOption

+
invalidDsorgOption: object
+ +
+
+

Message indicating invalid 'create' command 'dsorg' option

+
+
+
+ +

message

+
message: string = "Invalid zos-files create command 'dsorg' option: "
+ +
+
+
+ +

invalidFileName

+
invalidFileName: object
+ +
+
+

Message indicating invalid characters in file name

+
+
+
+ +

message

+
message: string = "Invalid file name. Please check the file name for typos."
+ +
+
+
+ +

invalidFilesCreateOption

+
invalidFilesCreateOption: object
+ +
+
+

Message indicating an invalid 'create' command option

+
+
+
+ +

message

+
message: string = "Invalid zos-files create command option: "
+ +
+
+
+ +

invalidFilesMountOption

+
invalidFilesMountOption: object
+ +
+
+

Message indicating an invalid 'mount' command option

+
+
+
+ +

message

+
message: string = "Invalid zos-files mount command option: "
+ +
+
+
+ +

invalidMountModeOption

+
invalidMountModeOption: object
+ +
+
+

Message indicating invalid 'mount' command 'mode' option

+
+
+
+ +

message

+
message: string = "Invalid zos-files mount command 'mode' value: "
+ +
+
+
+ +

invalidPODsorgDirblkCombination

+
invalidPODsorgDirblkCombination: object
+ +
+
+

Message indicating that directory blocks cannot be zero if the data set organization is 'PO'

+
+
+
+ +

message

+
message: string = "'PO' data set organization (dsorg) specified and the directory blocks (dirblk) is zero."
+ +
+
+
+ +

invalidPSDsorgDirblkCombination

+
invalidPSDsorgDirblkCombination: object
+ +
+
+

Message indicating that directory blocks must be zero if the data set organization is 'PS'

+
+
+
+ +

message

+
message: string = "'PS' data set organization (dsorg) specified and the directory blocks (dirblk) is not zero."
+ +
+
+
+ +

invalidPermsOption

+
invalidPermsOption: object
+ +
+
+

Message indicating invalid 'create' command 'perms' option

+
+
+
+ +

message

+
message: string = "Invalid zos-files create command 'perms' option: "
+ +
+
+
+ +

invalidRecfmOption

+
invalidRecfmOption: object
+ +
+
+

Message indicating invalid 'create' command 'recfm' option

+
+
+
+ +

message

+
message: string = "Invalid zos-files create command 'recfm' option: "
+ +
+
+
+ +

longAmsStatement

+
longAmsStatement: object
+ +
+
+

Message indicating that the AMS commands was too long to be passed to z/OS MF

+
+
+
+ +

message

+
message: string = "Line %d is longer than %d characters (maximum allowed length)%s"
+ +
+
+
+ +

maximumAllocationQuantityExceeded

+
maximumAllocationQuantityExceeded: object
+ +
+
+

Message indicating the maximum allocation quantity has been exceeded

+
+
+
+ +

message

+
message: string = `Maximum allocation quantity of ${ZosFilesConstants.MAX_ALLOC_QUANTITY} exceeded`
+ +
+
+
+ +

memberDownloadFailed

+
memberDownloadFailed: object
+ +
+
+

Message indicating that the following members failed to properly download

+
+
+
+ +

message

+
message: string = "Failed to download the following members:"
+ +
+
+
+ +

missingDataSets

+
missingDataSets: object
+ +
+
+

Message indicating that data set objects were not passed.

+
+
+
+ +

message

+
message: string = "No list of data sets to download was passed."
+ +
+
+
+ +

missingDatasetLikeName

+
missingDatasetLikeName: object
+ +
+
+

Message indicating that the data set "like" name is required

+
+
+
+ +

message

+
message: string = "Specify the name of the data set to "allocate like" from."
+ +
+
+
+ +

missingDatasetName

+
missingDatasetName: object
+ +
+
+

Message indicating that the data set name is required

+
+
+
+ +

message

+
message: string = "Specify the data set name."
+ +
+
+
+ +

missingDatasetType

+
missingDatasetType: object
+ +
+
+

Message indicating that the data set type is required

+
+
+
+ +

message

+
message: string = "Specify the data set type."
+ +
+
+
+ +

missingFileSystemName

+
missingFileSystemName: object
+ +
+
+

Message indicating that the file system name is required

+
+
+
+ +

message

+
message: string = "Specify the file system name."
+ +
+
+
+ +

missingFilesCreateOptions

+
missingFilesCreateOptions: object
+ +
+
+

Message indicating the 'create' command options is null or undefined

+
+
+
+ +

message

+
message: string = "No zos-files create command options."
+ +
+
+
+ +

missingFilesMountOptions

+
missingFilesMountOptions: object
+ +
+
+

Message indicating the 'mount' command options is null or undefined

+
+
+
+ +

message

+
message: string = "No zos-files mount command options."
+ +
+
+
+ +

missingFsOption

+
missingFsOption: object
+ +
+
+

Message indicating that an expected file system option was not supplied.

+
+
+
+ +

message

+
message: string = "To mount a file system, the following option must be supplied: "
+ +
+
+
+ +

missingInputDir

+
missingInputDir: object
+ +
+
+

Message indicating that the input directory is required

+
+
+
+ +

message

+
message: string = "Specify the input directory path."
+ +
+
+
+ +

missingInputDirectory

+
missingInputDirectory: object
+ +
+
+

Message indicating that the input directory path is required

+
+
+
+ +

message

+
message: string = "Specify directory path, to upload."
+ +
+
+
+ +

missingInputFile

+
missingInputFile: object
+ +
+
+

Message indicating that the input file is required

+
+
+
+ +

message

+
message: string = "Specify the input file and, if needed, the path."
+ +
+
+
+ +

missingMountPoint

+
missingMountPoint: object
+ +
+
+

Message indicating that the mount point is required

+
+
+
+ +

message

+
message: string = "Specify the mount point."
+ +
+
+
+ +

missingPatterns

+
missingPatterns: object
+ +
+
+

Message indicating that patterns were not passed.

+
+
+
+ +

message

+
message: string = "No pattern to match data sets passed."
+ +
+
+
+ +

missingPayload

+
missingPayload: object
+ +
+
+

Message indicating that the payload is required

+
+
+
+ +

message

+
message: string = "Specify the payload."
+ +
+
+
+ +

missingPrimary

+
missingPrimary: object
+ +
+
+

Message indicating 'create' command 'primary' option is required

+
+
+
+ +

message

+
message: string = "Specify the primary allocation (primary) to create a data set."
+ +
+
+
+ +

missingRecordLength

+
missingRecordLength: object
+ +
+
+

Message indicating 'create' command 'lrecl' option is required

+
+
+
+ +

message

+
message: string = "Specify the record length (lrecl) to create a data set."
+ +
+
+
+ +

missingRequestType

+
missingRequestType: object
+ +
+
+

Message indicating that the request type is required

+
+
+
+ +

message

+
message: string = "Specify request type, file or directory."
+ +
+
+
+ +

missingRequiredTableParameters

+
missingRequiredTableParameters: object
+ +
+
+

Message indicating that required table parameters are missing for file list

+
+
+
+ +

message

+
message: string = "Options 'depth', 'filesys', and 'symlinks' require a 'group', 'user', 'name', 'size', 'mtime', 'perm', or 'type' option to be " +"specified."
+ +
+
+
+ +

missingStatements

+
missingStatements: object
+ +
+
+

Message indicating that the AMS statements is required

+
+
+
+ +

message

+
message: string = "Missing AMS statements to be submitted."
+ +
+
+
+ +

missingUSSDirName

+
missingUSSDirName: object
+ +
+
+

Message indicating that the USS Dir name is required

+
+
+
+ +

message

+
message: string = "Specify the USS directory name."
+ +
+
+
+ +

missingUSSDirectoryName

+
missingUSSDirectoryName: object
+ +
+
+

Message indicating that the USS directory name is required

+
+
+
+ +

message

+
message: string = "Specify the USS directory name."
+ +
+
+
+ +

missingUSSFileName

+
missingUSSFileName: object
+ +
+
+

Message indicating that the USS File name is required

+
+
+
+ +

message

+
message: string = "Specify the USS file name."
+ +
+
+
+ +

missingVsamOption

+
missingVsamOption: object
+ +
+
+

Message indicating that the an expected VSAM option was not supplied.

+
+
+
+ +

message

+
message: string = "To create a VSAM cluster, the following option must be supplied: "
+ +
+
+
+ +

missingZfsOption

+
missingZfsOption: object
+ +
+
+

Message indicating that an expected ZFS option was not supplied.

+
+
+
+ +

message

+
message: string = "To create a z/OS file system, the following option must be supplied: "
+ +
+
+
+ +

noDataSetsInList

+
noDataSetsInList: object
+ +
+
+

Message indicating that no data sets remain to be downloaded after the excluded ones were filtered out.

+
+
+
deprecated
+
+
+
+
+ +

message

+
message: string = "No data sets left after excluded pattern(s) were filtered out."
+ +
+
+
+ +

noDataSetsMatchingPattern

+
noDataSetsMatchingPattern: object
+ +
+
+

Message indicating that no data sets remain to be downloaded after the excluded ones were filtered out.

+
+
+
+ +

message

+
message: string = "There are no data sets that match the provided pattern(s)."
+ +
+
+
+ +

noDataSetsMatchingPatternRemain

+
noDataSetsMatchingPatternRemain: object
+ +
+
+

Message indicating that no data sets remain to be downloaded after the excluded ones were filtered out.

+
+
+
deprecated
+
+
+
+
+ +

message

+
message: string = "After filtering out the archived files and files that match the exclusion-parameters, no data sets matching" +" the supported organization type remain."
+ +
+
+
+ +

noMembersFound

+
noMembersFound: object
+ +
+
+

Message indicating that the no members were found

+
+
+
+ +

message

+
message: string = "No members found!"
+ +
+
+
+ +

nodeJsFsError

+
nodeJsFsError: object
+ +
+
+

Message indicating that a failure has happened in the NodeJS File System API

+
+
+
+ +

message

+
message: string = "Node.js File System API error"
+ +
+
+
+ +

onlyEmptyPartitionedDataSets

+
onlyEmptyPartitionedDataSets: object
+ +
+
+

Message indicating that only empty partitioned data sets match the provided patterns

+
+
+
deprecated
+
+
+
+
+ +

message

+
message: string = "Only empty partitioned data sets match the provided patterns."
+ +
+
+
+ +

pathIsNotDirectory

+
pathIsNotDirectory: object
+ +
+
+

Message indicating that input path is not a directory

+
+
+
+ +

message

+
message: string = "%s is not a directory"
+ +
+
+
+ +

someDownloadsFailed

+
someDownloadsFailed: object
+ +
+
+

Message indicating that some data set downloads failed

+
+
+
+ +

message

+
message: string = "Some downloads failed, see error details above"
+ +
+
+
+ +

unsupportedDataType

+
unsupportedDataType: object
+ +
+
+

Message indicating that the data type is unsupported for USS files

+
+
+
+ +

message

+
message: string = "Unsupported data type 'record' specified for USS file operation."
+ +
+
+
+ +

unsupportedDatasetType

+
unsupportedDatasetType: object
+ +
+
+

Message indicating that the data set type is unsupported

+
+
+
+ +

message

+
message: string = "Unsupported data set type."
+ +
+
+
+ +

unsupportedMaskingInDataSetName

+
unsupportedMaskingInDataSetName: object
+ +
+ +

message

+
message: string = "Unsupported masking character found in data set name."
+ +
+
+
+ +

uploadDirectoryToDatasetMember

+
uploadDirectoryToDatasetMember: object
+ +
+
+

Message indicating that attempt to upload a directory to a data set member

+
+
+
+ +

message

+
message: string = "Upload a directory to a data set member is not permitted"
+ +
+
+
+ +

uploadDirectoryToPhysicalSequentialDataSet

+
uploadDirectoryToPhysicalSequentialDataSet: object
+ +
+
+

Message indicating that attempt to upload a directory with multiple files to a physical sequential data set

+
+
+
+ +

message

+
message: string = "Upload a directory with multiple files to a physical sequential data set is not permitted"
+ +
+
+
+ +

ussCreatedSuccessfully

+
ussCreatedSuccessfully: object
+ +
+
+

Message indicating that the uss file or directory crated successfully.

+
+
+
+ +

message

+
message: string = "USS file or directory created successfully."
+ +
+
+
+ +

ussDirUploadedSuccessfully

+
ussDirUploadedSuccessfully: object
+ +
+
+

Message indicating that the uss directory was uploaded successfully

+
+
+
+ +

message

+
message: string = "Directory uploaded successfully."
+ +
+
+
+ +

ussFileDeletedSuccessfully

+
ussFileDeletedSuccessfully: object
+ +
+
+

Message indicating that the USS file or directory was deleted successfully

+
+
+
+ +

message

+
message: string = "USS File or directory deleted successfully."
+ +
+
+
+ +

ussFileDownloadedSuccessfully

+
ussFileDownloadedSuccessfully: object
+ +
+
+

Message indicating that the uss file was downloaded successfully

+
+
+
+ +

message

+
message: string = "USS file downloaded successfully."
+ +
+
+
+ +

ussFileDownloadedWithDestination

+
ussFileDownloadedWithDestination: object
+ +
+
+

Message indicating that the uss file was downloaded successfully

+
+
+
+ +

message

+
message: string = "USS file downloaded successfully.Destination: %s"
+ +
+
+
+ +

ussFileUploadedSuccessfully

+
ussFileUploadedSuccessfully: object
+ +
+
+

Message indicating that the uss file was uploaded successfully

+
+
+
+ +

message

+
message: string = "USS file uploaded successfully."
+ +
+
+
+ +

valueOutOfBounds

+
valueOutOfBounds: object
+ +
+
+

Message indicating that the an expected VSAM option was not supplied.

+
+
+
+ +

message

+
message: string = "The {{optionName}} value = '{{value}}' must be between {{minValue}} and {{maxValue}}."
+ +
+
+
+ +

zfsCreatedSuccessfully

+
zfsCreatedSuccessfully: object
+ +
+
+

Message indicating that the ZFS was created successfully

+
+
+
+ +

message

+
message: string = "z/OS file system created successfully."
+ +
+
+
+ +

zfsDeletedSuccessfully

+
zfsDeletedSuccessfully: object
+ +
+
+

Message indicating that the ZFS was deleted successfully

+
+
+
+ +

message

+
message: string = "z/OS file system deleted successfully."
+ +
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/modules/_zowe_zos_jobs_for_zowe_sdk.html b/static/v2.15.x/typedoc/modules/_zowe_zos_jobs_for_zowe_sdk.html new file mode 100644 index 0000000000..4f141956c4 --- /dev/null +++ b/static/v2.15.x/typedoc/modules/_zowe_zos_jobs_for_zowe_sdk.html @@ -0,0 +1,689 @@ + + + + + + @zowe/zos-jobs-for-zowe-sdk | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @zowe/zos-jobs-for-zowe-sdk

+
+
+
+
+
+
+
+
+ +

z/OS Jobs Package

+
+

Contains APIs to interact with jobs on z/OS (using z/OSMF jobs REST endpoints).

+ +

API Examples

+
+

Cancel a job

+
import { ProfileInfo } from "@zowe/imperative";
+import { CancelJobs } from "@zowe/zos-jobs-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const jobName: string = "JOBNAME";
+    const jobId: string = "JOBID";
+    const version: string = undefined;
+    const response = await CancelJobs.cancelJob(session, jobName, jobId, version);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+ +

+
+

Download a job's output

+
import { ProfileInfo } from "@zowe/imperative";
+import { DownloadJobs, IDownloadAllSpoolContentParms } from "@zowe/zos-jobs-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const jobParms: IDownloadAllSpoolContentParms = {
+        jobname: "JOBNAME",
+        jobid: "JOBID",
+        outDir: undefined,
+        extension: ".txt",
+        omitJobidDirectory: false
+    };
+    const response = await DownloadJobs.downloadAllSpoolContentCommon(session, jobParms);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+ +

+
+

Get jobs by owner

+
import { ProfileInfo } from "@zowe/imperative";
+import { GetJobs } from "@zowe/zos-jobs-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const owner: string = session.ISession.user;
+    // This may take awhile...
+    const response = await GetJobs.getJobsByOwner(session, owner);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+ +

+
+

Submit a job

+
import { ProfileInfo } from "@zowe/imperative";
+import { SubmitJobs } from "@zowe/zos-jobs-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const jobDataSet: string = "ZOWEUSER.PUBLIC.MY.DATASET.JCL(MEMBER)";
+    const response = await SubmitJobs.submitJob(session, jobDataSet);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+
+
+
+

Index

+
+ +
+
+
+

Type aliases

+
+ +

JOB_STATUS

+
JOB_STATUS: "ACTIVE" | "OUTPUT" | "INPUT"
+ +
+
+

The possible job status strings (as specified by the z/OSMF documentation). Used in the Jobs APIs for monitoring + jobstatus, etc.

+
+
+
+
+ +

JobDataResolve

+
JobDataResolve: (data: string) => void
+ +
+

Type declaration

+
    +
  • +
      +
    • (data: string): void
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        data: string
        +
      • +
      +

      Returns void

      +
    • +
    +
  • +
+
+
+
+ +

JobResolve

+
JobResolve: (job: IJob) => void
+ +
+

Type declaration

+
    +
  • +
      +
    • (job: IJob): void
    • +
    +
      +
    • +

      Parameters

      + +

      Returns void

      +
    • +
    +
  • +
+
+
+
+
+

Variables

+
+ +

Const JOB_STATUS_ORDER

+
JOB_STATUS_ORDER: JOB_STATUS[] = ["INPUT", "ACTIVE", "OUTPUT"]
+ +
+
+
+

Object literals

+
+ +

Const ZosJobsMessages

+
ZosJobsMessages: object
+ +
+
+

Messages to be used as command responses for different scenarios

+
+
+
+ +

missingDirectoryOption

+
missingDirectoryOption: object
+ +
+
+

Message indicating that the "directory" option needs to be used if "extension" was used

+
+
+
memberof
+

ZosJobsMessages

+
+
+
+
+ +

message

+
message: string = "If you specify --extension option, you must also specify --directory"
+ +
+
+
+ +

missingJcl

+
missingJcl: object
+ +
+
+

Message indicating that no JCL source was given

+
+
+
memberof
+

ZosJobsMessages

+
+
+
+
+ +

message

+
message: string = "No JCL provided"
+ +
+
+
+ +

missingUssFilePath

+
missingUssFilePath: object
+ +
+
+

Message indicating that the USS file path is required

+
+
+
memberof
+

ZosJobsMessages

+
+
+
+
+ +

message

+
message: string = "Specify the USS file path."
+ +
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/modules/_zowe_zos_logs_for_zowe_sdk.html b/static/v2.15.x/typedoc/modules/_zowe_zos_logs_for_zowe_sdk.html new file mode 100644 index 0000000000..6de357e7d9 --- /dev/null +++ b/static/v2.15.x/typedoc/modules/_zowe_zos_logs_for_zowe_sdk.html @@ -0,0 +1,306 @@ + + + + + + @zowe/zos-logs-for-zowe-sdk | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @zowe/zos-logs-for-zowe-sdk

+
+
+
+
+
+
+
+
+ +

z/OS Logs Package

+
+

Contains APIs to interact with logs on z/OS (using z/OSMF log REST endpoints). + z/OSMF version 2.4 or higher is required. Ensure that the z/OSMF Operations Log Support is available via APAR and associated PTFs.

+ +

API Examples

+
+

List z/OS logs

+
import { ProfileInfo } from "@zowe/imperative";
+import { GetZosLog, IZosLogParms } from "@zowe/zos-logs-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const zosLogParms: IZosLogParms = {
+        direction: "backward",
+        range: "1m"
+    };
+    const response = await GetZosLog.getZosLog(session, zosLogParms);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+
+
+
+

Index

+
+
+
+

Classes

+ +
+
+

Interfaces

+ +
+
+

Object literals

+ +
+
+
+
+
+

Object literals

+
+ +

Const noSessionMessage

+
noSessionMessage: object
+ +
+
+

Error message that no session provided.

+
+
+
static
+
+
memberof
+

ZosLogConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No session was supplied.`
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/modules/_zowe_zos_tso_for_zowe_sdk.html b/static/v2.15.x/typedoc/modules/_zowe_zos_tso_for_zowe_sdk.html new file mode 100644 index 0000000000..29ba600a24 --- /dev/null +++ b/static/v2.15.x/typedoc/modules/_zowe_zos_tso_for_zowe_sdk.html @@ -0,0 +1,1169 @@ + + + + + + @zowe/zos-tso-for-zowe-sdk | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @zowe/zos-tso-for-zowe-sdk

+
+
+
+
+
+
+
+
+ +

z/OS TSO Package

+
+

Contains APIs to interact with TSO on z/OS (using z/OSMF TSO REST endpoints).

+ +

API Examples

+
+

Issue the TSO command "status" to display info about jobs for your user ID

+
import { ProfileInfo } from "@zowe/imperative";
+import { IssueTso } from "@zowe/zos-tso-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    // Load account number from default TSO profile (optional)
+    const tsoProfAttrs = profInfo.getDefaultProfile("tso");
+    const tsoMergedArgs = profInfo.mergeArgsForProfile(tsoProfAttrs);
+    const accountNumberFromProfile = tsoMergedArgs.knownArgs.find(
+        arg => arg.argName === "account").argValue as string;
+
+    const accountNumber = accountNumberFromProfile || "ACCT#";
+    const command = "status";
+    const response = await IssueTso.issueTsoCommand(session, accountNumber, command);
+    if (response.success) {
+        console.log(response);
+    } else {
+        throw new Error(`Failed to issue TSO command "${command}"`);
+    }
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+ +

+
+

Demonstrate starting, pinging, and stopping a TSO address space

+
import { ProfileInfo } from "@zowe/imperative";
+import { PingTso, StartTso, StopTso } from "@zowe/zos-tso-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const accountNumber = "ACCT#";
+    const startResponse = await StartTso.start(session, accountNumber, {
+        codePage: "285"
+    });
+
+    const servletKey = startResponse.servletKey;
+    if (startResponse.success) {
+        console.log(`[${servletKey}] Started`);
+    } else {
+        throw new Error("Failed to start TSO address space");
+    }
+
+    const pingResponse = await PingTso.ping(session, servletKey);
+    if (pingResponse.success) {
+        console.log(`[${servletKey}] Ping succeeded`);
+    } else {
+        throw new Error("Failed to ping TSO address space");
+    }
+
+    const stopResponse = await StopTso.stop(session, servletKey);
+    if (stopResponse.success) {
+        console.log(`[${servletKey}] Stopped`);
+    } else {
+        throw new Error("Failed to stop TSO address space");
+    }
+
+    try {
+        await PingTso.ping(session, servletKey);
+    } catch {
+        console.log(`[${servletKey}] Ping failed`);
+    }
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+
+
+
+

Index

+
+ +
+
+
+

Type aliases

+
+ +

SendResponse

+
SendResponse: (response: ISendResponse) => void
+ +
+

Type declaration

+ +
+
+
+
+

Object literals

+
+ +

Const ZosTsoProfile

+
ZosTsoProfile: object
+ +
+
+

Profile configuration for TSO profiles

+
+
+
memberof
+

ZosTsoProfile

+
+
+
+
+ +

createProfileExamples

+
createProfileExamples: { description: string; options: string }[] = [{description: "Create a tso profile called 'myprof' with default settings and JES accounting information of 'IZUACCT'",options: "myprof -a IZUACCT"},{description: "Create a tso profile called 'largeregion' with a region size of 8192, a logon procedure of MYPROC, and " +"JES accounting information of '1234'",options: "largeregion -a 1234 --rs 8192"},{description: "Create a tso profile called 'myprof2' with default settings and region size of 8192, without storing the user " +"account on disk",options: "myprof2 --rs 8192"}]
+ +
+
+ +

type

+
type: string = "tso"
+ +
+
+ +

updateProfileExamples

+
updateProfileExamples: { description: string; options: string }[] = [{description: "Update a tso profile called myprof with new JES accounting information",options: "myprof -a NEWACCT"}]
+ +
+
+ +

schema

+
schema: object
+ +
+ +

description

+
description: string = "z/OS TSO/E User Profile"
+ +
+
+ +

required

+
required: undefined[] = []
+ +
+
+ +

title

+
title: string = "TSO Profile"
+ +
+
+ +

type

+
type: string = "object"
+ +
+
+ +

properties

+
properties: object
+ +
+ +

account

+
account: object
+ +
+ +

includeInTemplate

+
includeInTemplate: boolean = true
+ +
+
+ +

optionDefinition

+
optionDefinition: any = TsoProfileConstants.TSO_OPTION_ACCOUNT_PROFILE
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

characterSet

+
characterSet: object
+ +
+ +

optionDefinition

+
optionDefinition: any = TsoProfileConstants.TSO_OPTION_CHAR_SET
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

codePage

+
codePage: object
+ +
+ +

includeInTemplate

+
includeInTemplate: boolean = true
+ +
+
+ +

optionDefinition

+
optionDefinition: any = TsoProfileConstants.TSO_OPTION_CODE_PAGE
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

columns

+
columns: object
+ +
+ +

optionDefinition

+
optionDefinition: any = TsoProfileConstants.TSO_OPTION_COLUMNS
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

logonProcedure

+
logonProcedure: object
+ +
+ +

includeInTemplate

+
includeInTemplate: boolean = true
+ +
+
+ +

optionDefinition

+
optionDefinition: any = TsoProfileConstants.TSO_OPTION_LOGON_PROCEDURE
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

regionSize

+
regionSize: object
+ +
+ +

optionDefinition

+
optionDefinition: any = TsoProfileConstants.TSO_OPTION_REGION_SIZE
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

rows

+
rows: object
+ +
+ +

optionDefinition

+
optionDefinition: any = TsoProfileConstants.TSO_OPTION_ROWS
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+
+
+
+ +

Const noAccountNumber

+
noAccountNumber: object
+ +
+
+

No account number was provided error message

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No account number was supplied.`
+ +
+
+
+ +

Const noCommandInput

+
noCommandInput: object
+ +
+
+

No command text was provided error message

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No command text was provided.`
+ +
+
+
+ +

Const noDataInput

+
noDataInput: object
+ +
+
+

No data parameter string was supplied error message

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No data parameter string was supplied.`
+ +
+
+
+ +

Const noPingInput

+
noPingInput: object
+ +
+
+

No servlet key was provided for Ping command error message

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No servlet supplied.`
+ +
+
+
+ +

Const noServletKeyInput

+
noServletKeyInput: object
+ +
+
+

No servlet key was provided error message

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No servlet key was supplied.`
+ +
+
+
+ +

Const noSessionTso

+
noSessionTso: object
+ +
+
+

No Session provided error message

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No session was supplied.`
+ +
+
+
+ +

Const noTsoIssueInput

+
noTsoIssueInput: object
+ +
+
+

No input parameters were provided error message

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No tso issue command parameters were supplied.`
+ +
+
+
+ +

Const noTsoStartInput

+
noTsoStartInput: object
+ +
+
+

No input parameters were provided error message

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No tso start address space parameters were supplied.`
+ +
+
+
+ +

Const noTsoStopInput

+
noTsoStopInput: object
+ +
+
+

No input parameters for stop were provided error message

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No tso stop address space parameters were supplied.`
+ +
+
+
+ +

Const noZosmfResponse

+
noZosmfResponse: object
+ +
+
+

No ZOSMF response was received error message

+
+
+
static
+
+
memberof
+

TsoConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No z/OSMF response was received.`
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/modules/_zowe_zos_uss_for_zowe_sdk.html b/static/v2.15.x/typedoc/modules/_zowe_zos_uss_for_zowe_sdk.html new file mode 100644 index 0000000000..68232c287e --- /dev/null +++ b/static/v2.15.x/typedoc/modules/_zowe_zos_uss_for_zowe_sdk.html @@ -0,0 +1,839 @@ + + + + + + @zowe/zos-uss-for-zowe-sdk | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @zowe/zos-uss-for-zowe-sdk

+
+
+
+
+
+
+
+
+ +

z/OS USS Package

+
+

Contains APIs to interact with USS on z/OS (using the z/OS SSH service).

+ +

Installation Instructions

+
+

The z/OS USS SDK has a dependency on the ssh2 package. This package allows for more secure cryptographic ciphers to be used first on supporting hardware. In order to do this, the dependency attempts to build some native modules at install time.

+

If these modules cannot be built, the dependency will continue to function, without the optimal cipher list order. However, some error messaging may be visible. These errors can be safely ignored, if desired.

+

To consume the optimal cipher list and build the native modules, the following software is pre-requisite:

+ +

Windows

+
+

We recommend NodeJS be installed with Chocolatey, which includes most of the required tooling. An additional tool, CMake, will need to be installed in addition to Chocolatey.

+

Alternatively, install the following:

+
    +
  • Python 3.7 or greater
  • +
  • CMake
  • +
  • Choose one of the following:
      +
    • Visual Studio Build Tools
        +
      • "Visual C++ build tools" workload
      • +
      +
    • +
    • Visual Studio Community
        +
      • "Desktop development with C++" workload
      • +
      +
    • +
    +
  • +
+ +

Unix

+
+
    +
  • Python 3.7 or greater
  • +
  • CMake
  • +
  • make
  • +
  • A C/C++ Compiler (i.e. gcc-c++, g++)
  • +
+ +

MacOS

+
+
    +
  • Python 3.7 or greater
  • +
  • CMake
  • +
  • XCode
      +
    • Including XCode Command Line Tools
    • +
    +
  • +
+ +

API Examples

+
+

Check disk space on file system containing home directory

+
import { ProfileInfo } from "@zowe/imperative";
+import { Shell, SshSession } from "@zowe/zos-uss-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default SSH profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const sshProfAttrs = profInfo.getDefaultProfile("ssh");
+    const sshMergedArgs = profInfo.mergeArgsForProfile(sshProfAttrs, { getSecureVals: true });
+    const session = new SshSession(ProfileInfo.initSessCfg(sshMergedArgs.knownArgs));
+
+    await Shell.executeSsh(session, "df .", (data: string) => {
+        if (data.trim()) console.log(data);
+    });
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+ +

+
+

Make a script executable

+
import { ProfileInfo } from "@zowe/imperative";
+import { Shell, SshSession } from "@zowe/zos-uss-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default SSH profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const sshProfAttrs = profInfo.getDefaultProfile("ssh");
+    const sshMergedArgs = profInfo.mergeArgsForProfile(sshProfAttrs, { getSecureVals: true });
+    const session = new SshSession(ProfileInfo.initSessCfg(sshMergedArgs.knownArgs));
+
+    await Shell.executeSshCwd(session, "chmod +x test.sh", "/tmp", (data: string) => {
+        if (data.trim()) throw new Error(data);
+    });
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+
+
+
+

Index

+
+
+
+

Classes

+ +
+
+

Interfaces

+ +
+
+

Variables

+ +
+
+

Object literals

+ +
+
+
+
+
+

Variables

+
+ +

Const startCmdFlag

+
startCmdFlag: "@@START OF COMMAND@@" = Shell.startCmdFlag
+ +
+
+
deprecated
+

Use Shell.startCmdFlag instead.

+
+
+
+
+
+
+

Object literals

+
+ +

Const ZosUssMessages

+
ZosUssMessages: object
+ +
+
+

Messages to be used as command responses for different scenarios

+
+
+
memberof
+

ZosUssMessages

+
+
+
+
+ +

allAuthMethodsFailed

+
allAuthMethodsFailed: object
+ +
+
+

Message indicating that the data set type is unsupported

+
+
+
+ +

message

+
message: string = "All configured authentication methods failed"
+ +
+
+
+ +

connectionRefused

+
connectionRefused: object
+ +
+ +

message

+
message: string = "Connection was refused"
+ +
+
+
+ +

expiredPassword

+
expiredPassword: object
+ +
+ +

message

+
message: string = "Your password has expired"
+ +
+
+
+ +

handshakeTimeout

+
handshakeTimeout: object
+ +
+ +

message

+
message: string = "Timed out while waiting for handshake"
+ +
+
+
+ +

unexpected

+
unexpected: object
+ +
+ +

message

+
message: string = "Connection failed because of an unexpected error"
+ +
+
+
+
+ +

Const ZosUssProfile

+
ZosUssProfile: object
+ +
+
+

Profile configuration for SSH profiles

+
+
+
memberof
+

ZosUssProfile

+
+
+
+
+ +

createProfileExamples

+
createProfileExamples: { description: string; options: string }[] = [{options: "ssh111 --host sshhost --user ibmuser --password myp4ss",description: "Create a ssh profile called 'ssh111' to connect to z/OS SSH server at host 'zos123' and default port 22"},{options: "ssh222 --host sshhost --port 13022 --user ibmuser --password myp4ss",description: "Create a ssh profile called 'ssh222' to connect to z/OS SSH server at host 'zos123' and port 13022"},{options: "ssh333 --host sshhost --user ibmuser --privateKey /path/to/privatekey --keyPassphrase privateKeyPassphrase",description: "Create a ssh profile called 'ssh333' to connect to z/OS SSH server at host 'zos123' " +"using a privatekey '/path/to/privatekey' and its decryption passphrase 'privateKeyPassphrase' " +"for privatekey authentication"},{options: "ssh444 --privateKey /path/to/privatekey",description: "Create a ssh profile called 'ssh444' to connect to z/OS SSH server on default port 22, without specifying " +"username, host, or password, preventing those values from being stored on disk"}]
+ +
+
+ +

type

+
type: string = "ssh"
+ +
+
+ +

schema

+
schema: object
+ +
+ +

description

+
description: string = "z/OS SSH Profile"
+ +
+
+ +

required

+
required: undefined[] = []
+ +
+
+ +

title

+
title: string = "z/OS SSH Profile"
+ +
+
+ +

type

+
type: string = "object"
+ +
+
+ +

properties

+
properties: object
+ +
+ +

handshakeTimeout

+
handshakeTimeout: object
+ +
+ +

optionDefinition

+
optionDefinition: any = SshSession.SSH_OPTION_HANDSHAKETIMEOUT
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

host

+
host: object
+ +
+ +

optionDefinition

+
optionDefinition: any = SshSession.SSH_OPTION_HOST
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

keyPassphrase

+
keyPassphrase: object
+ +
+ +

optionDefinition

+
optionDefinition: any = SshSession.SSH_OPTION_KEYPASSPHRASE
+ +
+
+ +

secure

+
secure: boolean = true
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

password

+
password: object
+ +
+ +

optionDefinition

+
optionDefinition: any = SshSession.SSH_OPTION_PASSWORD
+ +
+
+ +

secure

+
secure: boolean = true
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

port

+
port: object
+ +
+ +

includeInTemplate

+
includeInTemplate: boolean = true
+ +
+
+ +

optionDefinition

+
optionDefinition: any = SshSession.SSH_OPTION_PORT
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

privateKey

+
privateKey: object
+ +
+ +

optionDefinition

+
optionDefinition: any = SshSession.SSH_OPTION_PRIVATEKEY
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

user

+
user: object
+ +
+ +

optionDefinition

+
optionDefinition: any = SshSession.SSH_OPTION_USER
+ +
+
+ +

secure

+
secure: boolean = true
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/modules/_zowe_zos_workflows_for_zowe_sdk.html b/static/v2.15.x/typedoc/modules/_zowe_zos_workflows_for_zowe_sdk.html new file mode 100644 index 0000000000..eb3f0d3e3f --- /dev/null +++ b/static/v2.15.x/typedoc/modules/_zowe_zos_workflows_for_zowe_sdk.html @@ -0,0 +1,774 @@ + + + + + + @zowe/zos-workflows-for-zowe-sdk | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @zowe/zos-workflows-for-zowe-sdk

+
+
+
+
+
+
+
+
+ +

z/OS Workflows Package

+
+

Contains APIs to interact with the z/OS workflows APIs

+ +

API Examples

+
+

List Active Workflow Instance(s) in z/OSMF

+
import { ProfileInfo } from "@zowe/imperative";
+import { IActiveWorkflows, ListWorkflows } from "@zowe/zos-workflows-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const response: IActiveWorkflows = await ListWorkflows.getWorkflows(session);
+    console.log(response.workflows);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+
+
+
+

Index

+
+ +
+
+
+

Type aliases

+
+ +

accessT

+
accessT: "Public" | "Private" | "Restricted"
+ +
+
+ +

startT

+
startT: "outputFileValue" | "existingValue" | "leaveConflict"
+ +
+
+
+

Object literals

+
+ +

Const WrongWorkflowKey

+
WrongWorkflowKey: object
+ +
+
+

Error message that workflow key that was supplied does not exist. + IZUWF5001W: The workflow key "workflowkey" was not found.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+ +

message

+
message: string = "IZUWF5001W"
+ +
+
+
+ +

Const noOwner

+
noOwner: object
+ +
+
+

Error message that no owner parameter string was supplied.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No owner parameter was supplied.`
+ +
+
+
+ +

Const noSteps

+
noSteps: object
+ +
+
+

Error message that no steps parameter was supplied.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No steps parameter was supplied.`
+ +
+
+
+ +

Const noSystemName

+
noSystemName: object
+ +
+
+

Error message that no system name parameter string was supplied.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No system name parameter was supplied.`
+ +
+
+
+ +

Const noVariables

+
noVariables: object
+ +
+
+

Error message that no variables parameter was supplied.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No variables parameter was supplied.`
+ +
+
+
+ +

Const noWorkflowDefinitionFile

+
noWorkflowDefinitionFile: object
+ +
+
+

Error message that no workflow definition file parameter string was supplied.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No workflow definition file parameter was supplied.`
+ +
+
+
+ +

Const noWorkflowKey

+
noWorkflowKey: object
+ +
+
+

Error message that no workflow key string was supplied.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No workflow key parameter was supplied.`
+ +
+
+
+ +

Const noWorkflowName

+
noWorkflowName: object
+ +
+
+

Error message that no workflow name parameter string was supplied.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` No workflow name parameter was supplied.`
+ +
+
+
+ +

Const wrongOwner

+
wrongOwner: object
+ +
+ +

message

+
message: string = apiErrorHeader.message + ` Wrong format of user ID supplied.`
+ +
+
+
+ +

Const wrongString

+
wrongString: object
+ +
+
+

Error message that no system name parameter string was supplied.

+
+
+
static
+
+
memberof
+

WorkflowConstants

+
+
+
+
+ +

message

+
message: string = apiErrorHeader.message + ` Parameter contains wrong character - & or ?.`
+ +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/typedoc/modules/_zowe_zosmf_for_zowe_sdk.html b/static/v2.15.x/typedoc/modules/_zowe_zosmf_for_zowe_sdk.html new file mode 100644 index 0000000000..ef171a0f98 --- /dev/null +++ b/static/v2.15.x/typedoc/modules/_zowe_zosmf_for_zowe_sdk.html @@ -0,0 +1,1176 @@ + + + + + + @zowe/zosmf-for-zowe-sdk | Zowe Node.js SDK - v2.15.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @zowe/zosmf-for-zowe-sdk

+
+
+
+
+
+
+
+
+ +

z/OS Management Facility Package

+
+

Contains APIs to interact with the z/OS Management Facility (using z/OSMF REST endpoints).

+ +

API Examples

+
+

Check z/OSMF status

+
import { ProfileInfo } from "@zowe/imperative";
+import { CheckStatus } from "@zowe/zosmf-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const response = await CheckStatus.getZosmfInfo(session);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+ +

+
+

List systems defined to z/OSMF

+
import { ProfileInfo } from "@zowe/imperative";
+import { ListDefinedSystems } from "@zowe/zosmf-for-zowe-sdk";
+
+(async () => {
+    // Load connection info from default z/OSMF profile
+    const profInfo = new ProfileInfo("zowe");
+    await profInfo.readProfilesFromDisk();
+    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
+    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
+    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
+
+    const response = await ListDefinedSystems.listDefinedSystems(session);
+    console.log(response);
+})().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+
+
+
+
+

Index

+
+ +
+
+
+

Object literals

+
+ +

Const ZosFilesOptions

+
ZosFilesOptions: object
+ +
+
+

Object containing all options to be used by the Download data set API

+
+
+
+ +

responseTimeout

+
responseTimeout: object
+ +
+
+

The files timeout header value

+
+
+
+ +

aliases

+
aliases: string[] = ["rto"]
+ +
+
+ +

defaultValue

+
defaultValue: undefined = undefined
+ +
+
+ +

description

+
description: string = "The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response." +" Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600"
+ +
+
+ +

name

+
name: string = "response-timeout"
+ +
+
+ +

numericValueRange

+
numericValueRange: number[] = [5, 600]
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+
+ +

Const ZosmfConstants

+
ZosmfConstants: object
+ +
+
+

Constants to be used by the z/OSMF API

+
+
+
+ +

INFO

+
INFO: string = "/info"
+ +
+
+

indicator for get info request

+
+
+
+
+ +

RESOURCE

+
RESOURCE: string = "/zosmf"
+ +
+
+

Specifies the z/OS data set and file REST interface

+
+
+
+
+ +

SYSTEMS

+
SYSTEMS: string = "/systems"
+ +
+
+

indicator for get defined systems in zosmf

+
+
+
+
+ +

TOPOLOGY

+
TOPOLOGY: string = "/resttopology"
+ +
+
+

indicator for get topology services

+
+
+
+
+ +

ERROR_CODES

+
ERROR_CODES: object
+ +
+
+

Known error codes return by the API

+
+
+
+ +

BAD_HOST_NAME

+
BAD_HOST_NAME: string = "ENOTFOUND"
+ +
+
+

Error code when unable to connect to host

+
+
+
+
+ +

BAD_PORT

+
BAD_PORT: string = "ECONNREFUSED"
+ +
+
+

Error code when unable to connect to port

+
+
+
+
+ +

SELF_SIGNED_CERT_IN_CHAIN

+
SELF_SIGNED_CERT_IN_CHAIN: string = "SELF_SIGNED_CERT_IN_CHAIN"
+ +
+
+

Error code when self signed certificate in chain

+
+
+
+
+ +

UNABLE_TO_VERIFY_LEAF_SIGNATURE

+
UNABLE_TO_VERIFY_LEAF_SIGNATURE: string = "UNABLE_TO_VERIFY_LEAF_SIGNATURE"
+ +
+
+

Error code when unable to verify the first certificate

+
+
+
+
+
+
+ +

Const ZosmfMessages

+
ZosmfMessages: object
+ +
+
+

Messages to be used as detail display error message when gathering z/OSMF information

+
+
+
+ +

improperRejectUnauthorized

+
improperRejectUnauthorized: object
+ +
+
+

Message indicate that the rejectUnauthorized flag was not set properly

+
+
+
+ +

message

+
message: string = "A self-signed certificate was used ({{causeMsg}}),and your reject-unauthorized option is '{{rejectUnauthorized}}'."
+ +
+
+
+ +

invalidHostName

+
invalidHostName: object
+ +
+
+

Message indicate that unable to connect to specified host name

+
+
+
+ +

message

+
message: string = "Unable to establish connection to host "
+ +
+
+
+ +

invalidPort

+
invalidPort: object
+ +
+
+

Message indicate that unable to establish connection with specified port number

+
+
+
+ +

message

+
message: string = "Unable to establish connection at port "
+ +
+
+
+ +

missingSession

+
missingSession: object
+ +
+
+

Message indicate that input session object is invalid

+
+
+
+ +

message

+
message: string = "Missing profile session information."
+ +
+
+
+
+ +

Const ZosmfProfile

+
ZosmfProfile: object
+ +
+
+

Profile configuration for ZOSMF profiles

+
+
+
memberof
+

ZosmfProfile

+
+
+
+
+ +

createProfileExamples

+
createProfileExamples: { description: string; options: string }[] = [{options: "zos123 --host zos123 --port 1443 --user ibmuser --password myp4ss",description: "Create a zosmf profile called 'zos123' to connect to z/OSMF at host zos123 and port 1443"},{options: "zos124 --host zos124 --user ibmuser --password myp4ss --reject-unauthorized false",description: "Create a zosmf profile called 'zos124' to connect to z/OSMF at the host zos124 (default port - 443) " +"and allow self-signed certificates"},{options: "zos125 --host zos125 --port 1443",description: "Create a zosmf profile called 'zos125' to connect to z/OSMF at the host zos125 and port 1443, " +" not specifying a username or password so they are not stored on disk; these will need to be specified on every command"},{options: "zos126 --reject-unauthorized false",description: "Create a zosmf profile called 'zos126' to connect to z/OSMF on the default port 443 and allow self-signed " +"certificates, not specifying a username, password, or host so they are not stored on disk; these will need to be " +"specified on every command"},{options: "zosAPIML --host zosAPIML --port 7554 --user ibmuser --password myp4ss --reject-unauthorized false --base-path ibmzosmf/api/v1",description: "Create a zosmf profile called 'zosAPIML' to connect to z/OSMF via the Zowe API Mediation Layer running at host " +"'zosAPIML', port '7554', and allow for self-signed certificates. To reduce duplication, you could elect to store the 'host', " +"'port', 'reject-unauthorized', 'user', and 'password' values for the API Mediation Layer in a base profile and only store " +"the 'base-path' of the service in the zosmf profile"}]
+ +
+
+ +

type

+
type: string = "zosmf"
+ +
+
+ +

updateProfileExamples

+
updateProfileExamples: { description: string; options: string }[] = [{options: "zos123 --user newuser --password newp4ss",description: "Update a zosmf profile named 'zos123' with a new username and password"}]
+ +
+
+ +

schema

+
schema: object
+ +
+ +

description

+
description: string = "z/OSMF Profile"
+ +
+
+ +

required

+
required: undefined[] = []
+ +
+
+ +

title

+
title: string = "z/OSMF Profile"
+ +
+
+ +

type

+
type: string = "object"
+ +
+
+ +

properties

+
properties: object
+ +
+ +

basePath

+
basePath: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ZosmfSession.ZOSMF_OPTION_BASE_PATH
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

certFile

+
certFile: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ZosmfSession.ZOSMF_OPTION_CERT_FILE
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

certKeyFile

+
certKeyFile: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ZosmfSession.ZOSMF_OPTION_CERT_KEY_FILE
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

encoding

+
encoding: object
+ +
+ +

type

+
type: string = "string"
+ +
+
+ +

optionDefinition

+
optionDefinition: object
+ +
+ +

aliases

+
aliases: string[] = ["ec"]
+ +
+
+ +

description

+
description: string = "The encoding for download and upload of z/OS data set and USS files." +" The default encoding if not specified is IBM-1047."
+ +
+
+ +

name

+
name: string = "encoding"
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+
+ +

host

+
host: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ZosmfSession.ZOSMF_OPTION_HOST
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

password

+
password: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ZosmfSession.ZOSMF_OPTION_PASSWORD
+ +
+
+ +

secure

+
secure: boolean = true
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

port

+
port: object
+ +
+ +

includeInTemplate

+
includeInTemplate: boolean = true
+ +
+
+ +

optionDefinition

+
optionDefinition: any = ZosmfSession.ZOSMF_OPTION_PORT
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

protocol

+
protocol: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ZosmfSession.ZOSMF_OPTION_PROTOCOL
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+ +

rejectUnauthorized

+
rejectUnauthorized: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ZosmfSession.ZOSMF_OPTION_REJECT_UNAUTHORIZED
+ +
+
+ +

type

+
type: string = "boolean"
+ +
+
+
+ +

responseTimeout

+
responseTimeout: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ZosFilesOptions.responseTimeout
+ +
+
+ +

type

+
type: string = "number"
+ +
+
+
+ +

user

+
user: object
+ +
+ +

optionDefinition

+
optionDefinition: any = ZosmfSession.ZOSMF_OPTION_USER
+ +
+
+ +

secure

+
secure: boolean = true
+ +
+
+ +

type

+
type: string = "string"
+ +
+
+
+
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Object literal
  • +
  • Variable
  • +
  • Function
  • +
  • Type alias
  • +
  • Type alias with type parameter
  • +
+
    +
  • Interface
  • +
  • Interface with type parameter
  • +
+
    +
  • Class
  • +
  • Class with type parameter
  • +
+
    +
  • Enumeration
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/static/v2.15.x/web_help/css/bundle-docs.css b/static/v2.15.x/web_help/css/bundle-docs.css new file mode 100644 index 0000000000..b9ba8eb8be --- /dev/null +++ b/static/v2.15.x/web_help/css/bundle-docs.css @@ -0,0 +1,1104 @@ +:root{--balloon-border-radius: 2px;--balloon-color: rgba(16,16,16,0.95);--balloon-text-color: #fff;--balloon-font-size: 12px;--balloon-move: 4px}button[aria-label][data-balloon-pos]{overflow:visible}[aria-label][data-balloon-pos]{position:relative;cursor:pointer}[aria-label][data-balloon-pos]:after{opacity:0;pointer-events:none;transition:all 0.18s ease-out 0.18s;text-indent:0;font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif;font-weight:normal;font-style:normal;text-shadow:none;font-size:var(--balloon-font-size);background:var(--balloon-color);border-radius:2px;color:var(--balloon-text-color);border-radius:var(--balloon-border-radius);content:attr(aria-label);padding:.5em 1em;position:absolute;white-space:nowrap;z-index:10}[aria-label][data-balloon-pos]:before{width:0;height:0;border:5px solid transparent;border-top-color:var(--balloon-color);opacity:0;pointer-events:none;transition:all 0.18s ease-out 0.18s;content:"";position:absolute;z-index:10}[aria-label][data-balloon-pos]:hover:before,[aria-label][data-balloon-pos]:hover:after,[aria-label][data-balloon-pos][data-balloon-visible]:before,[aria-label][data-balloon-pos][data-balloon-visible]:after,[aria-label][data-balloon-pos]:not([data-balloon-nofocus]):focus:before,[aria-label][data-balloon-pos]:not([data-balloon-nofocus]):focus:after{opacity:1;pointer-events:none}[aria-label][data-balloon-pos].font-awesome:after{font-family:FontAwesome, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif}[aria-label][data-balloon-pos][data-balloon-break]:after{white-space:pre}[aria-label][data-balloon-pos][data-balloon-break][data-balloon-length]:after{white-space:pre-line;word-break:break-word}[aria-label][data-balloon-pos][data-balloon-blunt]:before,[aria-label][data-balloon-pos][data-balloon-blunt]:after{transition:none}[aria-label][data-balloon-pos][data-balloon-pos="up"]:hover:after,[aria-label][data-balloon-pos][data-balloon-pos="up"][data-balloon-visible]:after,[aria-label][data-balloon-pos][data-balloon-pos="down"]:hover:after,[aria-label][data-balloon-pos][data-balloon-pos="down"][data-balloon-visible]:after{transform:translate(-50%, 0)}[aria-label][data-balloon-pos][data-balloon-pos="up"]:hover:before,[aria-label][data-balloon-pos][data-balloon-pos="up"][data-balloon-visible]:before,[aria-label][data-balloon-pos][data-balloon-pos="down"]:hover:before,[aria-label][data-balloon-pos][data-balloon-pos="down"][data-balloon-visible]:before{transform:translate(-50%, 0)}[aria-label][data-balloon-pos][data-balloon-pos*="-left"]:after{left:0}[aria-label][data-balloon-pos][data-balloon-pos*="-left"]:before{left:5px}[aria-label][data-balloon-pos][data-balloon-pos*="-right"]:after{right:0}[aria-label][data-balloon-pos][data-balloon-pos*="-right"]:before{right:5px}[aria-label][data-balloon-pos][data-balloon-po*="-left"]:hover:after,[aria-label][data-balloon-pos][data-balloon-po*="-left"][data-balloon-visible]:after,[aria-label][data-balloon-pos][data-balloon-pos*="-right"]:hover:after,[aria-label][data-balloon-pos][data-balloon-pos*="-right"][data-balloon-visible]:after{transform:translate(0, 0)}[aria-label][data-balloon-pos][data-balloon-po*="-left"]:hover:before,[aria-label][data-balloon-pos][data-balloon-po*="-left"][data-balloon-visible]:before,[aria-label][data-balloon-pos][data-balloon-pos*="-right"]:hover:before,[aria-label][data-balloon-pos][data-balloon-pos*="-right"][data-balloon-visible]:before{transform:translate(0, 0)}[aria-label][data-balloon-pos][data-balloon-pos^="up"]:before,[aria-label][data-balloon-pos][data-balloon-pos^="up"]:after{bottom:100%;transform-origin:top;transform:translate(0, var(--balloon-move))}[aria-label][data-balloon-pos][data-balloon-pos^="up"]:after{margin-bottom:10px}[aria-label][data-balloon-pos][data-balloon-pos="up"]:before,[aria-label][data-balloon-pos][data-balloon-pos="up"]:after{left:50%;transform:translate(-50%, var(--balloon-move))}[aria-label][data-balloon-pos][data-balloon-pos^="down"]:before,[aria-label][data-balloon-pos][data-balloon-pos^="down"]:after{top:100%;transform:translate(0, calc(var(--balloon-move) * -1))}[aria-label][data-balloon-pos][data-balloon-pos^="down"]:after{margin-top:10px}[aria-label][data-balloon-pos][data-balloon-pos^="down"]:before{width:0;height:0;border:5px solid transparent;border-bottom-color:var(--balloon-color)}[aria-label][data-balloon-pos][data-balloon-pos="down"]:after,[aria-label][data-balloon-pos][data-balloon-pos="down"]:before{left:50%;transform:translate(-50%, calc(var(--balloon-move) * -1))}[aria-label][data-balloon-pos][data-balloon-pos="left"]:hover:after,[aria-label][data-balloon-pos][data-balloon-pos="left"][data-balloon-visible]:after,[aria-label][data-balloon-pos][data-balloon-pos="right"]:hover:after,[aria-label][data-balloon-pos][data-balloon-pos="right"][data-balloon-visible]:after{transform:translate(0, -50%)}[aria-label][data-balloon-pos][data-balloon-pos="left"]:hover:before,[aria-label][data-balloon-pos][data-balloon-pos="left"][data-balloon-visible]:before,[aria-label][data-balloon-pos][data-balloon-pos="right"]:hover:before,[aria-label][data-balloon-pos][data-balloon-pos="right"][data-balloon-visible]:before{transform:translate(0, -50%)}[aria-label][data-balloon-pos][data-balloon-pos="left"]:after,[aria-label][data-balloon-pos][data-balloon-pos="left"]:before{right:100%;top:50%;transform:translate(var(--balloon-move), -50%)}[aria-label][data-balloon-pos][data-balloon-pos="left"]:after{margin-right:10px}[aria-label][data-balloon-pos][data-balloon-pos="left"]:before{width:0;height:0;border:5px solid transparent;border-left-color:var(--balloon-color)}[aria-label][data-balloon-pos][data-balloon-pos="right"]:after,[aria-label][data-balloon-pos][data-balloon-pos="right"]:before{left:100%;top:50%;transform:translate(calc(var(--balloon-move) * -1), -50%)}[aria-label][data-balloon-pos][data-balloon-pos="right"]:after{margin-left:10px}[aria-label][data-balloon-pos][data-balloon-pos="right"]:before{width:0;height:0;border:5px solid transparent;border-right-color:var(--balloon-color)}[aria-label][data-balloon-pos][data-balloon-length]:after{white-space:normal}[aria-label][data-balloon-pos][data-balloon-length="small"]:after{width:80px}[aria-label][data-balloon-pos][data-balloon-length="medium"]:after{width:150px}[aria-label][data-balloon-pos][data-balloon-length="large"]:after{width:260px}[aria-label][data-balloon-pos][data-balloon-length="xlarge"]:after{width:380px}@media screen and (max-width: 768px){[aria-label][data-balloon-pos][data-balloon-length="xlarge"]:after{width:90vw}}[aria-label][data-balloon-pos][data-balloon-length="fit"]:after{width:100%} + +@media (prefers-color-scheme: dark) { + .markdown-body { + color-scheme: dark; + --color-prettylights-syntax-comment: #8b949e; + --color-prettylights-syntax-constant: #79c0ff; + --color-prettylights-syntax-entity: #d2a8ff; + --color-prettylights-syntax-storage-modifier-import: #c9d1d9; + --color-prettylights-syntax-entity-tag: #7ee787; + --color-prettylights-syntax-keyword: #ff7b72; + --color-prettylights-syntax-string: #a5d6ff; + --color-prettylights-syntax-variable: #ffa657; + --color-prettylights-syntax-brackethighlighter-unmatched: #f85149; + --color-prettylights-syntax-invalid-illegal-text: #f0f6fc; + --color-prettylights-syntax-invalid-illegal-bg: #8e1519; + --color-prettylights-syntax-carriage-return-text: #f0f6fc; + --color-prettylights-syntax-carriage-return-bg: #b62324; + --color-prettylights-syntax-string-regexp: #7ee787; + --color-prettylights-syntax-markup-list: #f2cc60; + --color-prettylights-syntax-markup-heading: #1f6feb; + --color-prettylights-syntax-markup-italic: #c9d1d9; + --color-prettylights-syntax-markup-bold: #c9d1d9; + --color-prettylights-syntax-markup-deleted-text: #ffdcd7; + --color-prettylights-syntax-markup-deleted-bg: #67060c; + --color-prettylights-syntax-markup-inserted-text: #aff5b4; + --color-prettylights-syntax-markup-inserted-bg: #033a16; + --color-prettylights-syntax-markup-changed-text: #ffdfb6; + --color-prettylights-syntax-markup-changed-bg: #5a1e02; + --color-prettylights-syntax-markup-ignored-text: #c9d1d9; + --color-prettylights-syntax-markup-ignored-bg: #1158c7; + --color-prettylights-syntax-meta-diff-range: #d2a8ff; + --color-prettylights-syntax-brackethighlighter-angle: #8b949e; + --color-prettylights-syntax-sublimelinter-gutter-mark: #484f58; + --color-prettylights-syntax-constant-other-reference-link: #a5d6ff; + --color-fg-default: #c9d1d9; + --color-fg-muted: #8b949e; + --color-fg-subtle: #6e7681; + --color-canvas-default: #0d1117; + --color-canvas-subtle: #161b22; + --color-border-default: #30363d; + --color-border-muted: #21262d; + --color-neutral-muted: rgba(110,118,129,0.4); + --color-accent-fg: #58a6ff; + --color-accent-emphasis: #1f6feb; + --color-attention-subtle: rgba(187,128,9,0.15); + --color-danger-fg: #f85149; + } +} + +@media (prefers-color-scheme: light) { + .markdown-body { + color-scheme: light; + --color-prettylights-syntax-comment: #6e7781; + --color-prettylights-syntax-constant: #0550ae; + --color-prettylights-syntax-entity: #8250df; + --color-prettylights-syntax-storage-modifier-import: #24292f; + --color-prettylights-syntax-entity-tag: #116329; + --color-prettylights-syntax-keyword: #cf222e; + --color-prettylights-syntax-string: #0a3069; + --color-prettylights-syntax-variable: #953800; + --color-prettylights-syntax-brackethighlighter-unmatched: #82071e; + --color-prettylights-syntax-invalid-illegal-text: #f6f8fa; + --color-prettylights-syntax-invalid-illegal-bg: #82071e; + --color-prettylights-syntax-carriage-return-text: #f6f8fa; + --color-prettylights-syntax-carriage-return-bg: #cf222e; + --color-prettylights-syntax-string-regexp: #116329; + --color-prettylights-syntax-markup-list: #3b2300; + --color-prettylights-syntax-markup-heading: #0550ae; + --color-prettylights-syntax-markup-italic: #24292f; + --color-prettylights-syntax-markup-bold: #24292f; + --color-prettylights-syntax-markup-deleted-text: #82071e; + --color-prettylights-syntax-markup-deleted-bg: #ffebe9; + --color-prettylights-syntax-markup-inserted-text: #116329; + --color-prettylights-syntax-markup-inserted-bg: #dafbe1; + --color-prettylights-syntax-markup-changed-text: #953800; + --color-prettylights-syntax-markup-changed-bg: #ffd8b5; + --color-prettylights-syntax-markup-ignored-text: #eaeef2; + --color-prettylights-syntax-markup-ignored-bg: #0550ae; + --color-prettylights-syntax-meta-diff-range: #8250df; + --color-prettylights-syntax-brackethighlighter-angle: #57606a; + --color-prettylights-syntax-sublimelinter-gutter-mark: #8c959f; + --color-prettylights-syntax-constant-other-reference-link: #0a3069; + --color-fg-default: #24292f; + --color-fg-muted: #57606a; + --color-fg-subtle: #6e7781; + --color-canvas-default: #ffffff; + --color-canvas-subtle: #f6f8fa; + --color-border-default: #d0d7de; + --color-border-muted: hsla(210,18%,87%,1); + --color-neutral-muted: rgba(175,184,193,0.2); + --color-accent-fg: #0969da; + --color-accent-emphasis: #0969da; + --color-attention-subtle: #fff8c5; + --color-danger-fg: #cf222e; + } +} + +.markdown-body { + -ms-text-size-adjust: 100%; + -webkit-text-size-adjust: 100%; + margin: 0; + color: var(--color-fg-default); + background-color: var(--color-canvas-default); + font-family: -apple-system,BlinkMacSystemFont,"Segoe UI","Noto Sans",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji"; + font-size: 16px; + line-height: 1.5; + word-wrap: break-word; +} + +.markdown-body .octicon { + display: inline-block; + fill: currentColor; + vertical-align: text-bottom; +} + +.markdown-body h1:hover .anchor .octicon-link:before, +.markdown-body h2:hover .anchor .octicon-link:before, +.markdown-body h3:hover .anchor .octicon-link:before, +.markdown-body h4:hover .anchor .octicon-link:before, +.markdown-body h5:hover .anchor .octicon-link:before, +.markdown-body h6:hover .anchor .octicon-link:before { + width: 16px; + height: 16px; + content: ' '; + display: inline-block; + background-color: currentColor; + -webkit-mask-image: url("data:image/svg+xml,"); + mask-image: url("data:image/svg+xml,"); +} + +.markdown-body details, +.markdown-body figcaption, +.markdown-body figure { + display: block; +} + +.markdown-body summary { + display: list-item; +} + +.markdown-body [hidden] { + display: none !important; +} + +.markdown-body a { + background-color: transparent; + color: var(--color-accent-fg); + text-decoration: none; +} + +.markdown-body abbr[title] { + border-bottom: none; + text-decoration: underline dotted; +} + +.markdown-body b, +.markdown-body strong { + font-weight: var(--base-text-weight-semibold, 600); +} + +.markdown-body dfn { + font-style: italic; +} + +.markdown-body h1 { + margin: .67em 0; + font-weight: var(--base-text-weight-semibold, 600); + padding-bottom: .3em; + font-size: 2em; + border-bottom: 1px solid var(--color-border-muted); +} + +.markdown-body mark { + background-color: var(--color-attention-subtle); + color: var(--color-fg-default); +} + +.markdown-body small { + font-size: 90%; +} + +.markdown-body sub, +.markdown-body sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +.markdown-body sub { + bottom: -0.25em; +} + +.markdown-body sup { + top: -0.5em; +} + +.markdown-body img { + border-style: none; + max-width: 100%; + box-sizing: content-box; + background-color: var(--color-canvas-default); +} + +.markdown-body code, +.markdown-body kbd, +.markdown-body pre, +.markdown-body samp { + font-family: monospace; + font-size: 1em; +} + +.markdown-body figure { + margin: 1em 40px; +} + +.markdown-body hr { + box-sizing: content-box; + overflow: hidden; + background: transparent; + border-bottom: 1px solid var(--color-border-muted); + height: .25em; + padding: 0; + margin: 24px 0; + background-color: var(--color-border-default); + border: 0; +} + +.markdown-body input { + font: inherit; + margin: 0; + overflow: visible; + font-family: inherit; + font-size: inherit; + line-height: inherit; +} + +.markdown-body [type=button], +.markdown-body [type=reset], +.markdown-body [type=submit] { + -webkit-appearance: button; +} + +.markdown-body [type=checkbox], +.markdown-body [type=radio] { + box-sizing: border-box; + padding: 0; +} + +.markdown-body [type=number]::-webkit-inner-spin-button, +.markdown-body [type=number]::-webkit-outer-spin-button { + height: auto; +} + +.markdown-body [type=search]::-webkit-search-cancel-button, +.markdown-body [type=search]::-webkit-search-decoration { + -webkit-appearance: none; +} + +.markdown-body ::-webkit-input-placeholder { + color: inherit; + opacity: .54; +} + +.markdown-body ::-webkit-file-upload-button { + -webkit-appearance: button; + font: inherit; +} + +.markdown-body a:hover { + text-decoration: underline; +} + +.markdown-body ::placeholder { + color: var(--color-fg-subtle); + opacity: 1; +} + +.markdown-body hr::before { + display: table; + content: ""; +} + +.markdown-body hr::after { + display: table; + clear: both; + content: ""; +} + +.markdown-body table { + border-spacing: 0; + border-collapse: collapse; + display: block; + width: max-content; + max-width: 100%; + overflow: auto; +} + +.markdown-body td, +.markdown-body th { + padding: 0; +} + +.markdown-body details summary { + cursor: pointer; +} + +.markdown-body details:not([open])>*:not(summary) { + display: none !important; +} + +.markdown-body a:focus, +.markdown-body [role=button]:focus, +.markdown-body input[type=radio]:focus, +.markdown-body input[type=checkbox]:focus { + outline: 2px solid var(--color-accent-fg); + outline-offset: -2px; + box-shadow: none; +} + +.markdown-body a:focus:not(:focus-visible), +.markdown-body [role=button]:focus:not(:focus-visible), +.markdown-body input[type=radio]:focus:not(:focus-visible), +.markdown-body input[type=checkbox]:focus:not(:focus-visible) { + outline: solid 1px transparent; +} + +.markdown-body a:focus-visible, +.markdown-body [role=button]:focus-visible, +.markdown-body input[type=radio]:focus-visible, +.markdown-body input[type=checkbox]:focus-visible { + outline: 2px solid var(--color-accent-fg); + outline-offset: -2px; + box-shadow: none; +} + +.markdown-body a:not([class]):focus, +.markdown-body a:not([class]):focus-visible, +.markdown-body input[type=radio]:focus, +.markdown-body input[type=radio]:focus-visible, +.markdown-body input[type=checkbox]:focus, +.markdown-body input[type=checkbox]:focus-visible { + outline-offset: 0; +} + +.markdown-body kbd { + display: inline-block; + padding: 3px 5px; + font: 11px ui-monospace,SFMono-Regular,SF Mono,Menlo,Consolas,Liberation Mono,monospace; + line-height: 10px; + color: var(--color-fg-default); + vertical-align: middle; + background-color: var(--color-canvas-subtle); + border: solid 1px var(--color-neutral-muted); + border-bottom-color: var(--color-neutral-muted); + border-radius: 6px; + box-shadow: inset 0 -1px 0 var(--color-neutral-muted); +} + +.markdown-body h1, +.markdown-body h2, +.markdown-body h3, +.markdown-body h4, +.markdown-body h5, +.markdown-body h6 { + margin-top: 24px; + margin-bottom: 16px; + font-weight: var(--base-text-weight-semibold, 600); + line-height: 1.25; +} + +.markdown-body h2 { + font-weight: var(--base-text-weight-semibold, 600); + padding-bottom: .3em; + font-size: 1.5em; + border-bottom: 1px solid var(--color-border-muted); +} + +.markdown-body h3 { + font-weight: var(--base-text-weight-semibold, 600); + font-size: 1.25em; +} + +.markdown-body h4 { + font-weight: var(--base-text-weight-semibold, 600); + font-size: 1em; +} + +.markdown-body h5 { + font-weight: var(--base-text-weight-semibold, 600); + font-size: .875em; +} + +.markdown-body h6 { + font-weight: var(--base-text-weight-semibold, 600); + font-size: .85em; + color: var(--color-fg-muted); +} + +.markdown-body p { + margin-top: 0; + margin-bottom: 10px; +} + +.markdown-body blockquote { + margin: 0; + padding: 0 1em; + color: var(--color-fg-muted); + border-left: .25em solid var(--color-border-default); +} + +.markdown-body ul, +.markdown-body ol { + margin-top: 0; + margin-bottom: 0; + padding-left: 2em; +} + +.markdown-body ol ol, +.markdown-body ul ol { + list-style-type: lower-roman; +} + +.markdown-body ul ul ol, +.markdown-body ul ol ol, +.markdown-body ol ul ol, +.markdown-body ol ol ol { + list-style-type: lower-alpha; +} + +.markdown-body dd { + margin-left: 0; +} + +.markdown-body tt, +.markdown-body code, +.markdown-body samp { + font-family: ui-monospace,SFMono-Regular,SF Mono,Menlo,Consolas,Liberation Mono,monospace; + font-size: 12px; +} + +.markdown-body pre { + margin-top: 0; + margin-bottom: 0; + font-family: ui-monospace,SFMono-Regular,SF Mono,Menlo,Consolas,Liberation Mono,monospace; + font-size: 12px; + word-wrap: normal; +} + +.markdown-body .octicon { + display: inline-block; + overflow: visible !important; + vertical-align: text-bottom; + fill: currentColor; +} + +.markdown-body input::-webkit-outer-spin-button, +.markdown-body input::-webkit-inner-spin-button { + margin: 0; + -webkit-appearance: none; + appearance: none; +} + +.markdown-body::before { + display: table; + content: ""; +} + +.markdown-body::after { + display: table; + clear: both; + content: ""; +} + +.markdown-body>*:first-child { + margin-top: 0 !important; +} + +.markdown-body>*:last-child { + margin-bottom: 0 !important; +} + +.markdown-body a:not([href]) { + color: inherit; + text-decoration: none; +} + +.markdown-body .absent { + color: var(--color-danger-fg); +} + +.markdown-body .anchor { + float: left; + padding-right: 4px; + margin-left: -20px; + line-height: 1; +} + +.markdown-body .anchor:focus { + outline: none; +} + +.markdown-body p, +.markdown-body blockquote, +.markdown-body ul, +.markdown-body ol, +.markdown-body dl, +.markdown-body table, +.markdown-body pre, +.markdown-body details { + margin-top: 0; + margin-bottom: 16px; +} + +.markdown-body blockquote>:first-child { + margin-top: 0; +} + +.markdown-body blockquote>:last-child { + margin-bottom: 0; +} + +.markdown-body h1 .octicon-link, +.markdown-body h2 .octicon-link, +.markdown-body h3 .octicon-link, +.markdown-body h4 .octicon-link, +.markdown-body h5 .octicon-link, +.markdown-body h6 .octicon-link { + color: var(--color-fg-default); + vertical-align: middle; + visibility: hidden; +} + +.markdown-body h1:hover .anchor, +.markdown-body h2:hover .anchor, +.markdown-body h3:hover .anchor, +.markdown-body h4:hover .anchor, +.markdown-body h5:hover .anchor, +.markdown-body h6:hover .anchor { + text-decoration: none; +} + +.markdown-body h1:hover .anchor .octicon-link, +.markdown-body h2:hover .anchor .octicon-link, +.markdown-body h3:hover .anchor .octicon-link, +.markdown-body h4:hover .anchor .octicon-link, +.markdown-body h5:hover .anchor .octicon-link, +.markdown-body h6:hover .anchor .octicon-link { + visibility: visible; +} + +.markdown-body h1 tt, +.markdown-body h1 code, +.markdown-body h2 tt, +.markdown-body h2 code, +.markdown-body h3 tt, +.markdown-body h3 code, +.markdown-body h4 tt, +.markdown-body h4 code, +.markdown-body h5 tt, +.markdown-body h5 code, +.markdown-body h6 tt, +.markdown-body h6 code { + padding: 0 .2em; + font-size: inherit; +} + +.markdown-body summary h1, +.markdown-body summary h2, +.markdown-body summary h3, +.markdown-body summary h4, +.markdown-body summary h5, +.markdown-body summary h6 { + display: inline-block; +} + +.markdown-body summary h1 .anchor, +.markdown-body summary h2 .anchor, +.markdown-body summary h3 .anchor, +.markdown-body summary h4 .anchor, +.markdown-body summary h5 .anchor, +.markdown-body summary h6 .anchor { + margin-left: -40px; +} + +.markdown-body summary h1, +.markdown-body summary h2 { + padding-bottom: 0; + border-bottom: 0; +} + +.markdown-body ul.no-list, +.markdown-body ol.no-list { + padding: 0; + list-style-type: none; +} + +.markdown-body ol[type=a] { + list-style-type: lower-alpha; +} + +.markdown-body ol[type=A] { + list-style-type: upper-alpha; +} + +.markdown-body ol[type=i] { + list-style-type: lower-roman; +} + +.markdown-body ol[type=I] { + list-style-type: upper-roman; +} + +.markdown-body ol[type="1"] { + list-style-type: decimal; +} + +.markdown-body div>ol:not([type]) { + list-style-type: decimal; +} + +.markdown-body ul ul, +.markdown-body ul ol, +.markdown-body ol ol, +.markdown-body ol ul { + margin-top: 0; + margin-bottom: 0; +} + +.markdown-body li>p { + margin-top: 16px; +} + +.markdown-body li+li { + margin-top: .25em; +} + +.markdown-body dl { + padding: 0; +} + +.markdown-body dl dt { + padding: 0; + margin-top: 16px; + font-size: 1em; + font-style: italic; + font-weight: var(--base-text-weight-semibold, 600); +} + +.markdown-body dl dd { + padding: 0 16px; + margin-bottom: 16px; +} + +.markdown-body table th { + font-weight: var(--base-text-weight-semibold, 600); +} + +.markdown-body table th, +.markdown-body table td { + padding: 6px 13px; + border: 1px solid var(--color-border-default); +} + +.markdown-body table tr { + background-color: var(--color-canvas-default); + border-top: 1px solid var(--color-border-muted); +} + +.markdown-body table tr:nth-child(2n) { + background-color: var(--color-canvas-subtle); +} + +.markdown-body table img { + background-color: transparent; +} + +.markdown-body img[align=right] { + padding-left: 20px; +} + +.markdown-body img[align=left] { + padding-right: 20px; +} + +.markdown-body .emoji { + max-width: none; + vertical-align: text-top; + background-color: transparent; +} + +.markdown-body span.frame { + display: block; + overflow: hidden; +} + +.markdown-body span.frame>span { + display: block; + float: left; + width: auto; + padding: 7px; + margin: 13px 0 0; + overflow: hidden; + border: 1px solid var(--color-border-default); +} + +.markdown-body span.frame span img { + display: block; + float: left; +} + +.markdown-body span.frame span span { + display: block; + padding: 5px 0 0; + clear: both; + color: var(--color-fg-default); +} + +.markdown-body span.align-center { + display: block; + overflow: hidden; + clear: both; +} + +.markdown-body span.align-center>span { + display: block; + margin: 13px auto 0; + overflow: hidden; + text-align: center; +} + +.markdown-body span.align-center span img { + margin: 0 auto; + text-align: center; +} + +.markdown-body span.align-right { + display: block; + overflow: hidden; + clear: both; +} + +.markdown-body span.align-right>span { + display: block; + margin: 13px 0 0; + overflow: hidden; + text-align: right; +} + +.markdown-body span.align-right span img { + margin: 0; + text-align: right; +} + +.markdown-body span.float-left { + display: block; + float: left; + margin-right: 13px; + overflow: hidden; +} + +.markdown-body span.float-left span { + margin: 13px 0 0; +} + +.markdown-body span.float-right { + display: block; + float: right; + margin-left: 13px; + overflow: hidden; +} + +.markdown-body span.float-right>span { + display: block; + margin: 13px auto 0; + overflow: hidden; + text-align: right; +} + +.markdown-body code, +.markdown-body tt { + padding: .2em .4em; + margin: 0; + font-size: 85%; + white-space: break-spaces; + background-color: var(--color-neutral-muted); + border-radius: 6px; +} + +.markdown-body code br, +.markdown-body tt br { + display: none; +} + +.markdown-body del code { + text-decoration: inherit; +} + +.markdown-body samp { + font-size: 85%; +} + +.markdown-body pre code { + font-size: 100%; +} + +.markdown-body pre>code { + padding: 0; + margin: 0; + word-break: normal; + white-space: pre; + background: transparent; + border: 0; +} + +.markdown-body .highlight { + margin-bottom: 16px; +} + +.markdown-body .highlight pre { + margin-bottom: 0; + word-break: normal; +} + +.markdown-body .highlight pre, +.markdown-body pre { + padding: 16px; + overflow: auto; + font-size: 85%; + line-height: 1.45; + background-color: var(--color-canvas-subtle); + border-radius: 6px; +} + +.markdown-body pre code, +.markdown-body pre tt { + display: inline; + max-width: auto; + padding: 0; + margin: 0; + overflow: visible; + line-height: inherit; + word-wrap: normal; + background-color: transparent; + border: 0; +} + +.markdown-body .csv-data td, +.markdown-body .csv-data th { + padding: 5px; + overflow: hidden; + font-size: 12px; + line-height: 1; + text-align: left; + white-space: nowrap; +} + +.markdown-body .csv-data .blob-num { + padding: 10px 8px 9px; + text-align: right; + background: var(--color-canvas-default); + border: 0; +} + +.markdown-body .csv-data tr { + border-top: 0; +} + +.markdown-body .csv-data th { + font-weight: var(--base-text-weight-semibold, 600); + background: var(--color-canvas-subtle); + border-top: 0; +} + +.markdown-body [data-footnote-ref]::before { + content: "["; +} + +.markdown-body [data-footnote-ref]::after { + content: "]"; +} + +.markdown-body .footnotes { + font-size: 12px; + color: var(--color-fg-muted); + border-top: 1px solid var(--color-border-default); +} + +.markdown-body .footnotes ol { + padding-left: 16px; +} + +.markdown-body .footnotes ol ul { + display: inline-block; + padding-left: 16px; + margin-top: 16px; +} + +.markdown-body .footnotes li { + position: relative; +} + +.markdown-body .footnotes li:target::before { + position: absolute; + top: -8px; + right: -8px; + bottom: -8px; + left: -24px; + pointer-events: none; + content: ""; + border: 2px solid var(--color-accent-emphasis); + border-radius: 6px; +} + +.markdown-body .footnotes li:target { + color: var(--color-fg-default); +} + +.markdown-body .footnotes .data-footnote-backref g-emoji { + font-family: monospace; +} + +.markdown-body .pl-c { + color: var(--color-prettylights-syntax-comment); +} + +.markdown-body .pl-c1, +.markdown-body .pl-s .pl-v { + color: var(--color-prettylights-syntax-constant); +} + +.markdown-body .pl-e, +.markdown-body .pl-en { + color: var(--color-prettylights-syntax-entity); +} + +.markdown-body .pl-smi, +.markdown-body .pl-s .pl-s1 { + color: var(--color-prettylights-syntax-storage-modifier-import); +} + +.markdown-body .pl-ent { + color: var(--color-prettylights-syntax-entity-tag); +} + +.markdown-body .pl-k { + color: var(--color-prettylights-syntax-keyword); +} + +.markdown-body .pl-s, +.markdown-body .pl-pds, +.markdown-body .pl-s .pl-pse .pl-s1, +.markdown-body .pl-sr, +.markdown-body .pl-sr .pl-cce, +.markdown-body .pl-sr .pl-sre, +.markdown-body .pl-sr .pl-sra { + color: var(--color-prettylights-syntax-string); +} + +.markdown-body .pl-v, +.markdown-body .pl-smw { + color: var(--color-prettylights-syntax-variable); +} + +.markdown-body .pl-bu { + color: var(--color-prettylights-syntax-brackethighlighter-unmatched); +} + +.markdown-body .pl-ii { + color: var(--color-prettylights-syntax-invalid-illegal-text); + background-color: var(--color-prettylights-syntax-invalid-illegal-bg); +} + +.markdown-body .pl-c2 { + color: var(--color-prettylights-syntax-carriage-return-text); + background-color: var(--color-prettylights-syntax-carriage-return-bg); +} + +.markdown-body .pl-sr .pl-cce { + font-weight: bold; + color: var(--color-prettylights-syntax-string-regexp); +} + +.markdown-body .pl-ml { + color: var(--color-prettylights-syntax-markup-list); +} + +.markdown-body .pl-mh, +.markdown-body .pl-mh .pl-en, +.markdown-body .pl-ms { + font-weight: bold; + color: var(--color-prettylights-syntax-markup-heading); +} + +.markdown-body .pl-mi { + font-style: italic; + color: var(--color-prettylights-syntax-markup-italic); +} + +.markdown-body .pl-mb { + font-weight: bold; + color: var(--color-prettylights-syntax-markup-bold); +} + +.markdown-body .pl-md { + color: var(--color-prettylights-syntax-markup-deleted-text); + background-color: var(--color-prettylights-syntax-markup-deleted-bg); +} + +.markdown-body .pl-mi1 { + color: var(--color-prettylights-syntax-markup-inserted-text); + background-color: var(--color-prettylights-syntax-markup-inserted-bg); +} + +.markdown-body .pl-mc { + color: var(--color-prettylights-syntax-markup-changed-text); + background-color: var(--color-prettylights-syntax-markup-changed-bg); +} + +.markdown-body .pl-mi2 { + color: var(--color-prettylights-syntax-markup-ignored-text); + background-color: var(--color-prettylights-syntax-markup-ignored-bg); +} + +.markdown-body .pl-mdr { + font-weight: bold; + color: var(--color-prettylights-syntax-meta-diff-range); +} + +.markdown-body .pl-ba { + color: var(--color-prettylights-syntax-brackethighlighter-angle); +} + +.markdown-body .pl-sg { + color: var(--color-prettylights-syntax-sublimelinter-gutter-mark); +} + +.markdown-body .pl-corl { + text-decoration: underline; + color: var(--color-prettylights-syntax-constant-other-reference-link); +} + +.markdown-body g-emoji { + display: inline-block; + min-width: 1ch; + font-family: "Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol"; + font-size: 1em; + font-style: normal !important; + font-weight: var(--base-text-weight-normal, 400); + line-height: 1; + vertical-align: -0.075em; +} + +.markdown-body g-emoji img { + width: 1em; + height: 1em; +} + +.markdown-body .task-list-item { + list-style-type: none; +} + +.markdown-body .task-list-item label { + font-weight: var(--base-text-weight-normal, 400); +} + +.markdown-body .task-list-item.enabled label { + cursor: pointer; +} + +.markdown-body .task-list-item+.task-list-item { + margin-top: 4px; +} + +.markdown-body .task-list-item .handle { + display: none; +} + +.markdown-body .task-list-item-checkbox { + margin: 0 .2em .25em -1.4em; + vertical-align: middle; +} + +.markdown-body .contains-task-list:dir(rtl) .task-list-item-checkbox { + margin: 0 -1.6em .25em .2em; +} + +.markdown-body .contains-task-list { + position: relative; +} + +.markdown-body .contains-task-list:hover .task-list-item-convert-container, +.markdown-body .contains-task-list:focus-within .task-list-item-convert-container { + display: block; + width: auto; + height: 24px; + overflow: visible; + clip: auto; +} + +.markdown-body ::-webkit-calendar-picker-indicator { + filter: invert(50%); +} diff --git a/static/v2.15.x/web_help/css/bundle.css b/static/v2.15.x/web_help/css/bundle.css new file mode 100644 index 0000000000..e04fb4965c --- /dev/null +++ b/static/v2.15.x/web_help/css/bundle.css @@ -0,0 +1,9 @@ +.jstree-node,.jstree-children,.jstree-container-ul{display:block;margin:0;padding:0;list-style-type:none;list-style-image:none}.jstree-node{white-space:nowrap}.jstree-anchor{display:inline-block;color:black;white-space:nowrap;padding:0 4px 0 1px;margin:0;vertical-align:top}.jstree-anchor:focus{outline:0}.jstree-anchor,.jstree-anchor:link,.jstree-anchor:visited,.jstree-anchor:hover,.jstree-anchor:active{text-decoration:none;color:inherit}.jstree-icon{display:inline-block;text-decoration:none;margin:0;padding:0;vertical-align:top;text-align:center}.jstree-icon:empty{display:inline-block;text-decoration:none;margin:0;padding:0;vertical-align:top;text-align:center}.jstree-ocl{cursor:pointer}.jstree-leaf>.jstree-ocl{cursor:default}.jstree .jstree-open>.jstree-children{display:block}.jstree .jstree-closed>.jstree-children,.jstree .jstree-leaf>.jstree-children{display:none}.jstree-anchor>.jstree-themeicon{margin-right:2px}.jstree-no-icons .jstree-themeicon,.jstree-anchor>.jstree-themeicon-hidden{display:none}.jstree-hidden,.jstree-node.jstree-hidden{display:none}.jstree-rtl .jstree-anchor{padding:0 1px 0 4px}.jstree-rtl .jstree-anchor>.jstree-themeicon{margin-left:2px;margin-right:0}.jstree-rtl .jstree-node{margin-left:0}.jstree-rtl .jstree-container-ul>.jstree-node{margin-right:0}.jstree-wholerow-ul{position:relative;display:inline-block;min-width:100%}.jstree-wholerow-ul .jstree-leaf>.jstree-ocl{cursor:pointer}.jstree-wholerow-ul .jstree-anchor,.jstree-wholerow-ul .jstree-icon{position:relative}.jstree-wholerow-ul .jstree-wholerow{width:100%;cursor:pointer;position:absolute;left:0;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.jstree-contextmenu .jstree-anchor{-webkit-user-select:none;-webkit-touch-callout:none;user-select:none}.vakata-context{display:none}.vakata-context,.vakata-context ul{margin:0;padding:2px;position:absolute;background:#f5f5f5;border:1px solid #979797;box-shadow:2px 2px 2px #999999}.vakata-context ul{list-style:none;left:100%;margin-top:-2.7em;margin-left:-4px}.vakata-context .vakata-context-right ul{left:auto;right:100%;margin-left:auto;margin-right:-4px}.vakata-context li{list-style:none}.vakata-context li>a{display:block;padding:0 2em 0 2em;text-decoration:none;width:auto;color:black;white-space:nowrap;line-height:2.4em;text-shadow:1px 1px 0 white;border-radius:1px}.vakata-context li>a:hover{position:relative;background-color:#e8eff7;box-shadow:0 0 2px #0a6aa1}.vakata-context li>a.vakata-context-parent{background-image:url("data:image/gif;base64,R0lGODlhCwAHAIAAACgoKP///yH5BAEAAAEALAAAAAALAAcAAAIORI4JlrqN1oMSnmmZDQUAOw==");background-position:right center;background-repeat:no-repeat}.vakata-context li>a:focus{outline:0}.vakata-context .vakata-context-no-icons{margin-left:0}.vakata-context .vakata-context-hover>a{position:relative;background-color:#e8eff7;box-shadow:0 0 2px #0a6aa1}.vakata-context .vakata-context-separator>a,.vakata-context .vakata-context-separator>a:hover{background:white;border:0;border-top:1px solid #e2e3e3;height:1px;min-height:1px;max-height:1px;padding:0;margin:0 0 0 2.4em;border-left:1px solid #e0e0e0;text-shadow:0 0 0 transparent;box-shadow:0 0 0 transparent;border-radius:0}.vakata-context .vakata-contextmenu-disabled a,.vakata-context .vakata-contextmenu-disabled a:hover{color:silver;background-color:transparent;border:0;box-shadow:0 0 0}.vakata-context .vakata-contextmenu-disabled>a>i{filter:grayscale(100%)}.vakata-context li>a>i{text-decoration:none;display:inline-block;width:2.4em;height:2.4em;background:transparent;margin:0 0 0 -2em;vertical-align:top;text-align:center;line-height:2.4em}.vakata-context li>a>i:empty{width:2.4em;line-height:2.4em}.vakata-context li>a .vakata-contextmenu-sep{display:inline-block;width:1px;height:2.4em;background:white;margin:0 .5em 0 0;border-left:1px solid #e2e3e3}.vakata-context .vakata-contextmenu-shortcut{font-size:.8em;color:silver;opacity:.5;display:none}.vakata-context-rtl ul{left:auto;right:100%;margin-left:auto;margin-right:-4px}.vakata-context-rtl li>a.vakata-context-parent{background-image:url("data:image/gif;base64,R0lGODlhCwAHAIAAACgoKP///yH5BAEAAAEALAAAAAALAAcAAAINjI+AC7rWHIsPtmoxLAA7");background-position:left center;background-repeat:no-repeat}.vakata-context-rtl .vakata-context-separator>a{margin:0 2.4em 0 0;border-left:0;border-right:1px solid #e2e3e3}.vakata-context-rtl .vakata-context-left ul{right:auto;left:100%;margin-left:-4px;margin-right:auto}.vakata-context-rtl li>a>i{margin:0 -2em 0 0}.vakata-context-rtl li>a .vakata-contextmenu-sep{margin:0 0 0 .5em;border-left-color:white;background:#e2e3e3}#jstree-marker{position:absolute;top:0;left:0;margin:-5px 0 0 0;padding:0;border-right:0;border-top:5px solid transparent;border-bottom:5px solid transparent;border-left:5px solid;width:0;height:0;font-size:0;line-height:0}#jstree-dnd{line-height:16px;margin:0;padding:4px}#jstree-dnd .jstree-icon,#jstree-dnd .jstree-copy{display:inline-block;text-decoration:none;margin:0 2px 0 0;padding:0;width:16px;height:16px}#jstree-dnd .jstree-ok{background:green}#jstree-dnd .jstree-er{background:red}#jstree-dnd .jstree-copy{margin:0 2px 0 2px}.jstree-default .jstree-node,.jstree-default .jstree-icon{background-repeat:no-repeat;background-color:transparent}.jstree-default .jstree-anchor,.jstree-default .jstree-animated,.jstree-default .jstree-wholerow{transition:background-color .15s,box-shadow .15s}.jstree-default .jstree-hovered{background:#e7f4f9;border-radius:2px;box-shadow:inset 0 0 1px #cccccc}.jstree-default .jstree-context{background:#e7f4f9;border-radius:2px;box-shadow:inset 0 0 1px #cccccc}.jstree-default .jstree-clicked{background:#beebff;border-radius:2px;box-shadow:inset 0 0 1px #999999}.jstree-default .jstree-no-icons .jstree-anchor>.jstree-themeicon{display:none}.jstree-default .jstree-disabled{background:transparent;color:#666666}.jstree-default .jstree-disabled.jstree-hovered{background:transparent;box-shadow:none}.jstree-default .jstree-disabled.jstree-clicked{background:#efefef}.jstree-default .jstree-disabled>.jstree-icon{opacity:.8;filter:url("data:image/svg+xml;utf8,#jstree-grayscale");filter:gray;-webkit-filter:grayscale(100%)}.jstree-default .jstree-search{font-style:italic;color:#8b0000;font-weight:bold}.jstree-default .jstree-no-checkboxes .jstree-checkbox{display:none !important}.jstree-default.jstree-checkbox-no-clicked .jstree-clicked{background:transparent;box-shadow:none}.jstree-default.jstree-checkbox-no-clicked .jstree-clicked.jstree-hovered{background:#e7f4f9}.jstree-default.jstree-checkbox-no-clicked>.jstree-wholerow-ul .jstree-wholerow-clicked{background:transparent}.jstree-default.jstree-checkbox-no-clicked>.jstree-wholerow-ul .jstree-wholerow-clicked.jstree-wholerow-hovered{background:#e7f4f9}.jstree-default>.jstree-striped{min-width:100%;display:inline-block;background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAkCAMAAAB/qqA+AAAABlBMVEUAAAAAAAClZ7nPAAAAAnRSTlMNAMM9s3UAAAAXSURBVHjajcEBAQAAAIKg/H/aCQZ70AUBjAATb6YPDgAAAABJRU5ErkJggg==") left top repeat}.jstree-default>.jstree-wholerow-ul .jstree-hovered,.jstree-default>.jstree-wholerow-ul .jstree-clicked{background:transparent;box-shadow:none;border-radius:0}.jstree-default .jstree-wholerow{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.jstree-default .jstree-wholerow-hovered{background:#e7f4f9}.jstree-default .jstree-wholerow-clicked{background:#beebff;background:-webkit-linear-gradient(top, #beebff 0%, #a8e4ff 100%);background:linear-gradient(to bottom, #beebff 0%, #a8e4ff 100%)}.jstree-default .jstree-node{min-height:24px;line-height:24px;margin-left:24px;min-width:24px}.jstree-default .jstree-anchor{line-height:24px;height:24px}.jstree-default .jstree-icon{width:24px;height:24px;line-height:24px}.jstree-default .jstree-icon:empty{width:24px;height:24px;line-height:24px}.jstree-default.jstree-rtl .jstree-node{margin-right:24px}.jstree-default .jstree-wholerow{height:24px}.jstree-default .jstree-node,.jstree-default .jstree-icon{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAYAAABsS6soAAAV40lEQVR42u2dCXQUVbrHKwsEHEWGYZkEVzZ1BEGQBHiAioqiPA++N4gkoKwiyBjGp+AIIjJHkGVgEFAgQSVJY4CQjSWsASGEfU06YctKks6eTkK2Trr/737VXbEJwW2q0jH5vnN+53aqO32rKt2//G/dqm4JgPRr4bLW/fd3BvfPxeW4199v8dctLmMBcnFx/V6LBcgJjBMgFydAFiAXFxcnQBYgJzBOgFycAFmAXFxcnABZgJzAOAFycQJkAXJxcXECZAFyAvsd9h8YGOhU3+3GUI1tfbSqpDPfoz7OHf6ylpM75iL36sYZnAC5uFSodevXISgoyKLT6Sy6oM1m0VYHbdbVBOno9maLuA9BdJ9OB/m2gH5H5f4VqD+zbX3MtnWoptubdWKZ9v3/ItTs315+5sqCn6ZcLxO1aVqDiMIhAmSsqPEfiPv/eegNnZySAmOxEUXGIhQVFaKQKCyC0VgolhejuFjcLqG2GAaDQZaAmv0Xi+cuLyuHsUj0L/rML8xHflEe8grzUGDMk9eJ1q9MPIYeq1b/VEr/NdXVP8mRxBhsuvwFtp7ZKvevlQBNhWkydPtOCZDQWoIOS4AM05BQ4srLzZdFl59fgPyCAhQJ2RQTJKbScllORE21SW7VF6ARZ9OOIvT6BpzN+AHnDcdwMSMW8VnHcT4rBhduHMP5GzE4Jx6jlQDlba+DIuYtpwPhf20eEioOINKwGh+um62NAG0JjwR4WyK03deQKdAhAlTzxaUGPXr0QHNKYMr+bywJUMv9T8fWxLDSnJWZibz8fDndEXl5NhGK5EWpj0SgyEBNARHB32+15Oflwz9hHnYWLsWewn/jbNk2XCgLx/mbYTh7czsOGb/GpcpIhF3bgLzcAojfUVWAe+MO4rPDs7DjQoi8/fYC1J34Fl8mvI/InBUISFmI4JSlWJXgizaz3IerKRtKd/aCqxVgHfFVFMTKNNkESH+Q4O+3oLHIz1ECdGAialb7XxekM2dmZsCQZUBaWhrS09ORlUUSzBUSyJdFWCAwKgIsVluAWyy5uXlYcWYmNmS8jYCcWYg0LkKUcRmiipdhd9FS7Cxagoj8xVh16u/IyctT7e9D9dlXn2PeqTEIMX6Ej2PexHf7gmoFuPW0DsvOz4R/ui+W6Cdg8aWJ+CJuEryDX4I0oWMvLQRIcqNW/tlOgIr4GkqADk2AtPMdnQTpjTd6jA+aYwJsTvtfpwuqyRACTE1LRUpKKlJT05CWfkNIMAs52dlChPny/iiwJSJjSZGq+2aLECBJbXa0DxYmjsKa9LewPmMK/DKnwS9rGjZkvgP/zL/hnwmj8OFBb+Tm5JIALWr07Tq5k+cbUU9iTtwz8D03AAuvvowZh0bg273in+CpQLwf8yreOdsHPke7460jfTA1xguvBg7B518tUV0+9gIk6iZCRYzNIgHSQVd60dFskyPffI4UoCMTYHPa/zTDmpGRiVQhP5oMSUpOkUWYlp6GLLGchoS5QlDykLC4WIsEiByRAP9vvzfmxr2EuQkv4dOEEZifOAKfJLwo5DQM00/1w/9GP4QJ4SPEY9UToDTeY+CQTQ9g1KEOGHmgHYbtc8FrMe3hHfk0Ju19DiOi70H/CAn9wyQ8FSrBc/2DiE08rckkCE1s2AtO+bm+9EdsWj666SZAZeaJXnwLFi6Bo958jSEB/tb2PxVg3f3fUP3faf9r1b9IgBZKeyQ9fYJecAXXk5JlGaaKITGRZchCdrb12JjRKCdAi5oCJMHO2j8ao6I98OaxnpgQ2xNvHXsc42MfEXLywNM7/oBBYXdhXNhw8dhcVYfAH636FH03dIJXuBBcmFV2Q3e2wKAIZ/QLkdBvq4S+gv5ruyI24VTtMVAtBEhiK72+r14B0nJ7tBZgs0yAyjGnunACbLr7n2SWJURPwouL1yM+Lh56/WUkXU8SaTDZOiwWEqRjhMrEgOoJMD8f40Kfw4BQN3iFtsSg8NZCeK0wKLQVPLe74CmBZ2gLeG9/Tp6sUVOAtC2hJ3bjL2v+hCeDJfTeLOEJnSBIQq9ACT0FvVbeh4PnY27Zfi3kl5P4DYou7pYFZ58IFenR/QpNOgE2hmNQzfi0kGa1/2k7KeHFxccjLs5KvBChXrQJCZeRnGSVYEpqmpyI6ZQVtQVI+9snYLS5q5+Ebn5O6LZRwiMbndDdXwIt6yrabv7OGLt9mPxYtQVIUlsfuQldl7fHo99I6L7Bhuj7saUP4cCZw/I+sG6/egJ0laTW1NLxPEWA9igSVH5OPfGvWpp0Amwss5DNVYDNaf/T9tIbW5GfPZQG4/XxSLEdFyS0EqD3ptHmbn4kHRdZgl1F293PWdx2hiJGeoxWAqTtXRO+EQ8u7oCuX7miy1pXdP/8QYQf3V277dbtV1GAdzl3JEiAlPDsBUfCo+WOEiCfB9iMBdjcttdegPG2Vh+nF6kwQW71cjrU3yIAta8E0e3VyYLzFklwnNy+bqZUSK28XBARs1PVE7EVAdJzKtsfdGAb+q3ohQErvLArdv8t8qP9pPSvmgBdXZ8l0SmJT7nigySnCNBefE0+ATKMI4b8ytUeZTdFe7MMN8usbVlZmXwFCB0XrRZocSWIMrSs72qMuldmqHkpniJARW4ETQjtOnUA0ReO1i6zhx6r5hC4rgDtcaQA+VpgplmgfBgADSvrwVJ3mfJhAGr3/xPrcEvfWvb/az4MQa0PLrEdB+xBQqsPToAMwzRKGqLuJEb+NBiGYZq8AB35eZQsQIZhmu1nd7IAGYbhBMgCZBiGEyALkGEYToAsQIZhAXICZAEyDAuQEyALkGFYgJwAWYCqfyYg98+wADkBMgzDAuQEyAmQ+2dYgJwAGYZhAXIC5ATI/TMsQE6ADMOwADkBcgLk/hkWICdAhmFYgJwAOQFy/42flG3vOBE3QqfLKD+zADkBMozqJG+cjN+Cmv2nbZv+I9tnmNNCZtYITOlWqtO2v2tJ2zbDojxG0/5/AUr/DVEfzJ4rfx3AgoVLMG7yLLklRo/x4e8E4QTI/ashgNLrsaguybmd4tuXVWTpVRUQCYWe11yZD1NBCqpuZsJUkonK4nRUltyAqdSA6nJal2yYKwrkx9LvqJXglP7pS59+ilOJ0Qi8vAih54Lk/hsqidH3jyjio2+tI/ERtIwTIMOoIEBTYaog7RasUiq4BRIBteoLMBtn044i4voGnM/4AZeyjiHOcBzxhlj59oUbR3E2/aj8GHqsFgKsu/32+2DL6UD4X5uHhIoDiDSshr//KNXlQ0KrD0V49gK0v79ZJMCG/q7aHj16gBPgj/07av83UAK0VGTGyW/4CoNeTniVWQmoIikW1SfDfLUFaKkqTIFf/FzsLFyCKONKnC0PwfmyCFwoj8SFigjsK/4SCaZd2H5trSxrtQUYrY/Csv0zcTh6jbz99hLUnfgWXya8j8icFQhIWYjglKVYleCLNrPch6stwPqK/unQV4KSAMPCbsgCpNI6BTaaBKh8HWBDvwEbiwQdTVPe/yl+U5ySv5liJgFWCOlVZMZbERKoyNajSgxJZREU3bCToMoCDJluqShIxspT72F95jQE5LyHSOPniCpeJrNbZil2GJdg6ckZqgsw3H8M5p0agxDjR/g45k0c/2F9rfxiozdg2fmZ8E/3xRL9BCy+NBFfxE3ClOBnIU3o2EsLATp7ht8GVUMLsFEkQOVLqx3xBqQd7GgJOjoBNvX9bxXgVFN5+gUhvXiUJZ9EOckwUy+nwcrsRJiEnEy2NGg9LpitsgBnmMvzr+Ef0T74LHEU1maMx7qsKfDLmgY/AzEdW/Pnivtege++v4r1UU+ArpM7efrs6Y05cc/A99wALLz6MmYcGoHYw+sQc3A93o95Fe+c7QOfo93x1pE+mBrjhdGBXojyH6vJELgxCdDhCZAOftKbjyKwo96AjUGCjqI57H8hQOeUb9+uLEs7h7LMS7iZdAI3k4+j/MZFVGRckqVYmS2SoSERVfmUitK1EWDeFcw56I1/xL2ITxKH49PLL2H+5RGYn/giPta/gGmn+mJkdAf4bB8mBJimXgIc7zFwWEBnjDrUASMPtMOwfS54LaY9vCOfxqS9z2FE9D3oHyGhf5iEp0IlDFrngdNXjmoyCcIJ0A7aWIPBUDsD5cg3oBpvQuW/yW9t1UqSv7RVe///2v7V3v8/IUCX5G+nVZannhHyO47ixP0ovXYQpUnHUJYi0mCGNRnKw2MhQvl4oFWAFrXO+UvfJgSYewUf7H8D/xN9PybE9sSkE70w8URPvHX8cfx3dEd4hbfEU2Eu8N7+nLwOag6BdV/9Ff3XdRB9SPAMs8pu6M4WGBThjH4hEvptldBXMHDtAzgbd1A+DNAcBNjsE2B9cAJsWvufEmDyt1OFAM+h9HoMiuP2wBi/F6VXhAivH0FZ6gmRBC8IEcbLQ2IaflYXG1QToHUShIbASRgf8RK8QlsJCbXCANF6hbWGZ6gQ33YXkb6cBS4YG6K+AOm5dpwKwxNr2uLJYAm9N0t4QicIktArUEJPQb9/u+PEhX21E0KcAJv4MUCmeex/WYDfTK0qv3FeJL8DKLoUhaKLUTDG7UbJtf3ysptJsSIRnrBOjAjoNJTkjVNUnQSpzE/BuIAxlu5+zujmJ8l09f+x7epnZWzIME0ESFIL37sCjyxvi0e/kdB9gw3RZ+9l9+PkmUi77ddWgHcqOiGaZ4GZZjEL3IACdErZOMVMEx9W+e2SKby4W7QCIcLSq/tRcv2YfLK0IgC1zwOkU258Al43d5MF6AS59be1fj8K0HvTaLNWAqTtDQ79At0W/xFdv3JFl7WueHzRfTh8OEDedvvt1+pE6DudC0goAqSRgP0yPg+QaZAk2HRPhJ5ioTc2Jb/kM8GCLUg6twVF8UKIl/YICe6xyXF37RUjWlwJoturE4J73ewTMNrsTQjZ+Wyi9nX5NhERs7P2GJyaAqTnLL2+TyZy7zp4rvgLnl7RF8diNtcmPwWtjgFSpaSkoi728iM+/XSPnP6UQzR8JQjDqHAlCF1mZq7Ik8/zk9vyPGsrqDHRZJBJsytB6p58fCeUS/HUFqCS7ojyzHgcPrMDJy/uu01+BD22IS+FI9mR9AgSoXKbltPohK8FZhgVPgyh/gv/Z9T7QQCN5cMImsOHIVDqrTsUVo7/UQrkBMgwDH8cFidAhmFYgJwAGYZhAXICZBiGBcgJkGEYFiAnQIZhWICcABmGYQFyAmQYhgXICZBhGBYgJ0CGYTgBcgJkGIYTIAuQYRhOgCxAhmE4AbIAGYbhBMgCZBgWICdAFiDDsAA5AbIAGYYFyAnw9yDAuvUvSWp3p53xqSS1UnPnMAwLkBNgo/kDRnXp4pu2YEHG7j//eVzdnXGkc+fxBYsX6w+1bTtSSwG6SlJrexpyX7je5dxx/vz5C+pjwIAB3vyGZzgBqizAX1Pt/n6f58pLsy70W95vimoraKvw1q3fy/7wQyAkBIVr1ph2d+zoo9wX7e7uU755swnJySjftq10v02CmshPSEg8dQ+CbjekBG2Su63Ky8phMBhAIuQ3PcMJ0AECvGtmh95+1z7OS6g4gEjDajy8sNs4tQS4VZJmxru4wNC2LYpeeAE1y5ahaNUqU1THjmP3CcpWrzYhMhIIDwdOnkTFli03D3XqNFILAZL46Kv+CFdX12dlETaQBOsTIH0LGq1LXFy8/DNLkOEEqIEA233w8PNvRrwc5jaxY5fbkp9vZ6+Vet/syJwVCEhZiOCUpViV4Is2s9yHq/EH/F6Svj4nVvWGIEtQ1L49qidPRtny5ahYtAhYuRJYvRrYuBHYsgXYswenHnlksRZDUJIeCYe+I7ahJVifAC2C4pJixAsBUktCZAkynABVFGCrtz0Gzjk5yhhi/Agf/DBWL/m0d1dW4g/TOz+x9Py7Of7pvliin4DFlybii7hJeG3r4CRpQsdeKvwBnUQCfGCzJIVcEqtrEOQKjALT4MGwzJ4Ny5w5wLx5wJIlMH/9NU737h1Cv6OlAIf/7bkGl+CdhsD0nbgkv7j4eDkJErROLACGE+B/KEDXyZ08R+/tWTon7hn4nhuAhVdfxtv7RuilN/7kce87Dz45K+aVnHfO9oHP0e5460gfTI3xwiD/HnrJu0MfFY8ByhIMlqRtcZJkyRZPmy8oFlQ++ihqpk4F3n0XVXPmWI737LmNHku/o7UA60pQ62OCNgFabkuBYkl1tQlGIUFaF5IhT4ownADVSIDjPQZ6BnQoGHWoA0YeaIdh+1zwWkx7eO8Yen3i3mezR0Tfg/4REvqHSXgqVEKXL1tek3zc+6o9CUIlUqDHTlfXSxlOTnISLLBJsKJLF+DttxE/YsQFeoxWs8D1CdBeglqnwIEDB/rUJ0DYLaQhMCVCFiDDCVCtY4DjPZ5/6EuXTK9wCZ5hVtkN3dkCgyKc0S9EQr+tEvoK7lvuJpJh5ydUXUF7AbZoMe703XeXJounTRcoSZCGw5WPPYb8adNK7E+RaXoCHOQNs6UGP1fChixAhhOgmrPAPp1fuX+la86TwRJ6b5bwhE4QJKFXoISeAvcvWlyVvB/op7qhbaUTa3CoZcsqvXjKREGSbVKEJJgnKKQk2LcvcidPrtrh7u7TUAJsyCHwkKFDfCxmS7WS+BSsN24NhixAhhOg2qfB+LgP77DINfvRbyR032DDT0K7z9wSJW+PPpqsICU/Z+exu5ycqk+IpzsjoMmQK0TLlrgmhsNZtsmRPDc33OzTB4axY6t3deo0pqlNggwdOtTHbDabYAbMNTUwi+GujLhdU10jD3+VDMgCZDgBanEe4HiPkX/8rEV2169c0WWtK+6d53ZFGnufp2aGpvTn5vbP3e3b44izM2LFU9IpMWeE7La3br0jWJJ2XhQ/Z9gSYW6bNjB4eSGqc+cFWgqwoeXn5eXlNGTIEB9TVVUViY4mPUwmK3TMr4ZaOv4nsHACZDgBangitLfH848t7VrQ/fOu1++U/FQUIM0Adw5wc/tul5BgjIsLDgsRBru60mzvw4QYHm87azsuePnuuxF5773f0e80tROhSYBlpWUmuvKjvNxG2e0ICXICZDgBangliJPk7f5f9rO9WiZA6u97sb2Bbm6bQtu2hRDedtupLsqVIg8EimWHRHehTk6b6LGanAbj4EvhBg8e7G0sNtaUlJbgFm6WoLhEUFosnwJDEmQBMpwAm9aHITjZ0t6bou0mS/jW+7rZ7ntYua+pfRjCwIEDvU2mKnNlZRUqKiqE6MpQUV6ByopKVFeZ5GFxjYAnQRhOgE3z47Cc7PjZ+5rai5mG3B/Mnmv+cM48omb2R5/UzBYt/fzB7HmWD2fPtYj7QfCVIAwnQI0E2Ng3qqm+EJQheOs2LTtS26pNy06t2rh1anUPtS07yUNyBevxSi4uToAsQPCrhYuLEyALkIuLixNgoxYgFxcXV7NNgFxcXFycALm4uLg4AXJxcXE1kgTIMAzTFPh/7ilJ+J+MkXkAAAAASUVORK5CYII=")}.jstree-default .jstree-node{background-position:-292px -4px;background-repeat:repeat-y}.jstree-default .jstree-last{background-image:none}.jstree-default .jstree-open>.jstree-ocl{background-position:-132px -4px}.jstree-default .jstree-closed>.jstree-ocl{background-position:-100px -4px}.jstree-default .jstree-leaf>.jstree-ocl{background-position:-68px -4px}.jstree-default .jstree-themeicon{background-position:-260px -4px}.jstree-default>.jstree-no-dots .jstree-node,.jstree-default>.jstree-no-dots .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default>.jstree-no-dots .jstree-open>.jstree-ocl{background-position:-36px -4px}.jstree-default>.jstree-no-dots .jstree-closed>.jstree-ocl{background-position:-4px -4px}.jstree-default .jstree-disabled{background:transparent}.jstree-default .jstree-disabled.jstree-hovered{background:transparent}.jstree-default .jstree-disabled.jstree-clicked{background:#efefef}.jstree-default .jstree-checkbox{background-position:-164px -4px}.jstree-default .jstree-checkbox:hover{background-position:-164px -36px}.jstree-default.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox,.jstree-default .jstree-checked>.jstree-checkbox{background-position:-228px -4px}.jstree-default.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox:hover,.jstree-default .jstree-checked>.jstree-checkbox:hover{background-position:-228px -36px}.jstree-default .jstree-anchor>.jstree-undetermined{background-position:-196px -4px}.jstree-default .jstree-anchor>.jstree-undetermined:hover{background-position:-196px -36px}.jstree-default .jstree-checkbox-disabled{opacity:.8;filter:url("data:image/svg+xml;utf8,#jstree-grayscale");filter:gray;-webkit-filter:grayscale(100%)}.jstree-default>.jstree-striped{background-size:auto 48px}.jstree-default.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAACAQMAAAB49I5GAAAABlBMVEUAAAAdHRvEkCwcAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjAAMOBgAAGAAJMwQHdQAAAABJRU5ErkJggg==");background-position:100% 1px;background-repeat:repeat-y}.jstree-default.jstree-rtl .jstree-last{background-image:none}.jstree-default.jstree-rtl .jstree-open>.jstree-ocl{background-position:-132px -36px}.jstree-default.jstree-rtl .jstree-closed>.jstree-ocl{background-position:-100px -36px}.jstree-default.jstree-rtl .jstree-leaf>.jstree-ocl{background-position:-68px -36px}.jstree-default.jstree-rtl>.jstree-no-dots .jstree-node,.jstree-default.jstree-rtl>.jstree-no-dots .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default.jstree-rtl>.jstree-no-dots .jstree-open>.jstree-ocl{background-position:-36px -36px}.jstree-default.jstree-rtl>.jstree-no-dots .jstree-closed>.jstree-ocl{background-position:-4px -36px}.jstree-default .jstree-themeicon-custom{background-color:transparent;background-image:none;background-position:0 0}.jstree-default>.jstree-container-ul .jstree-loading>.jstree-ocl{background:url("data:image/gif;base64,R0lGODlhEAAQAPMPAODg4Hp6egAAAFhYWL6+vhQUFJycnDY2NvDw8IqKikZGRiQkJKysrGhoaAQEBP///yH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQFCgAPACwAAAAAEAAQAEAEcPDJh2gbdcqkutETIoqKkCCCMwxA1koA8AAHwRhAIlMaICwIh6C1CyEYh6IkE0oUFEoEgKCcBWSGz4PAnAAWLcGQ15MlTMJYd1ZyUDXSDGelBY0qIkJg/ZoEFgYICToxDBRvIQMBD1kzgSAgBASQDxEAIfkEBQoADwAsAAAAAA8AEAAABF3wyflCk4hOJZcEBaNJB7I4wCIQo2QshSFw0xAjxWEJQpZJA8EBMCEQW7TWg9EIBFjKh2HQaECjH8PoN2EoBlvAL6FgIAwMgPoo1jQABPNVE9DGJXOMIXN/HJVqIxEAIfkEBQoADwAsAAAAABAADwAABFrwyflMolg2qRZCRyY5A9Ihg4hUAtMxE0BIwcGASpIcApAIPU0hFTMABbMJobFSCi4Sgs4AyHyujIBWxH3AupRGotk1BAgIAvqqkiQAcASAjDHM4A8594vPUyIAIfkEBQoADwAsAAAAABAAEAAABFzwySkNvTKgN5QcBPYcAec12CYVRBeiCCAljawEhuEhVqEGpIfqQViIHiWKrIbYGBgMUaNQcIByBtmlIegeKKELYAxQARKW44SQfYzVQgmC0BweCbIm3C23w/UYEQAh+QQFCgAIACwAAAAAEAAOAAAERRDJiUKgWA4pBM/c1iEFKAVeZ5DYUBCIcFheFU+DsGH1Su2YwwSAMPiCHUHJcsmUPkMMQZY5TqYdIkJrSma4FAJQAgZFAAAh+QQFCgAOACwAAAAAEAAQAAAEa9DJ6Qih2CEmU5ABkCEBlyROsogZ0AAnUKAUwYiJYQVHtSgSBCFBQEwQgIHjwJIAOBSEwmDUAK5VimEwUCSu2IxhsSg0ohjAwYBBNh1PCTAIMCKqBUHSUchmGAJKDlBoEwsCFyNpAmwZjn4RACH5BAUKAA8ALAAAAAAQABAAAARb8Mn5AKBYEmkMz9zFeIYCSgkyPgqDWcjDEJbRSMotAXTWFAMM4oJpuCaIJIjRaASTygxDcTgETpMBI4rdPBoxUKCxeCBuh1NBkHhceSDEmkiMOwQXxzE+OIQpEQAh+QQFCgAOACwBAAEADwAPAAAEVtBJIAmRTOpaL2nb5l3N5SCnBlAOEzjAkEgIgIbB8W73lpihICFAzAQ1n4HsSCsFa6zawrHbCASJhGI6U/gEgcXC4JiFAFdKAXE4MgSXwtqxAKo0g2MEACH5BAUKAA8ALAAAAAAQABAAAARd8Mn5EKJY3geAJBsGXB1nhBTidUjiYZtlEYyUGBlsNHiOGS8fBZAoCieAgLL2WRAwrqFCIOhNFIWExiE4eBYGRkPxMCwaEsPTdjjUesHJAtF+DBw+x/cgIec2SjkRACH5BAUKAA4ALAAAAQAQAA8AAARa0MnpEJKAamkl2Vr3bZkGlMYITkxCXFRJqU5T3A3I7MQh/AqQweBCnAwFmcSwcrwmiMaBKVnUEAsFw5EYOAcBCUNmGCgIhS1Mc3CYHYH2hmB1KII15SaRAEUAACH5BAUKAA8ALAAAAQAQAA8AAARY8MlJH6p4IlABx8BFCUJSiQjxEaTwTYBaBQLTidKiZw/hAwNHoRDI+BgfBEOBsVUGkpck0XA+Do+iYuAzNCQBg4QgETMCDQCWV2CiHwYmSN6AIoq8shgTAQAh+QQFCgAPACwAAAEADwAPAAAEWvBJUoC8+BKxspeDwHxS9wCC4AHIaRrjhbCY4RBZKyWHoiSeGQAQWBiBuaGlRRh4cLLAo+BhJKBOYCMwZBhOsNOkQEhIG5aHTn1oPMwPRmB9cb+ljy8pHsNEAAA7") center center no-repeat}.jstree-default .jstree-file{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAYAAABsS6soAAAV40lEQVR42u2dCXQUVbrHKwsEHEWGYZkEVzZ1BEGQBHiAioqiPA++N4gkoKwiyBjGp+AIIjJHkGVgEFAgQSVJY4CQjSWsASGEfU06YctKks6eTkK2Trr/737VXbEJwW2q0jH5vnN+53aqO32rKt2//G/dqm4JgPRr4bLW/fd3BvfPxeW4199v8dctLmMBcnFx/V6LBcgJjBMgFydAFiAXFxcnQBYgJzBOgFycAFmAXFxcnABZgJzAOAFycQJkAXJxcXECZAFyAvsd9h8YGOhU3+3GUI1tfbSqpDPfoz7OHf6ylpM75iL36sYZnAC5uFSodevXISgoyKLT6Sy6oM1m0VYHbdbVBOno9maLuA9BdJ9OB/m2gH5H5f4VqD+zbX3MtnWoptubdWKZ9v3/ItTs315+5sqCn6ZcLxO1aVqDiMIhAmSsqPEfiPv/eegNnZySAmOxEUXGIhQVFaKQKCyC0VgolhejuFjcLqG2GAaDQZaAmv0Xi+cuLyuHsUj0L/rML8xHflEe8grzUGDMk9eJ1q9MPIYeq1b/VEr/NdXVP8mRxBhsuvwFtp7ZKvevlQBNhWkydPtOCZDQWoIOS4AM05BQ4srLzZdFl59fgPyCAhQJ2RQTJKbScllORE21SW7VF6ARZ9OOIvT6BpzN+AHnDcdwMSMW8VnHcT4rBhduHMP5GzE4Jx6jlQDlba+DIuYtpwPhf20eEioOINKwGh+um62NAG0JjwR4WyK03deQKdAhAlTzxaUGPXr0QHNKYMr+bywJUMv9T8fWxLDSnJWZibz8fDndEXl5NhGK5EWpj0SgyEBNARHB32+15Oflwz9hHnYWLsWewn/jbNk2XCgLx/mbYTh7czsOGb/GpcpIhF3bgLzcAojfUVWAe+MO4rPDs7DjQoi8/fYC1J34Fl8mvI/InBUISFmI4JSlWJXgizaz3IerKRtKd/aCqxVgHfFVFMTKNNkESH+Q4O+3oLHIz1ECdGAialb7XxekM2dmZsCQZUBaWhrS09ORlUUSzBUSyJdFWCAwKgIsVluAWyy5uXlYcWYmNmS8jYCcWYg0LkKUcRmiipdhd9FS7Cxagoj8xVh16u/IyctT7e9D9dlXn2PeqTEIMX6Ej2PexHf7gmoFuPW0DsvOz4R/ui+W6Cdg8aWJ+CJuEryDX4I0oWMvLQRIcqNW/tlOgIr4GkqADk2AtPMdnQTpjTd6jA+aYwJsTvtfpwuqyRACTE1LRUpKKlJT05CWfkNIMAs52dlChPny/iiwJSJjSZGq+2aLECBJbXa0DxYmjsKa9LewPmMK/DKnwS9rGjZkvgP/zL/hnwmj8OFBb+Tm5JIALWr07Tq5k+cbUU9iTtwz8D03AAuvvowZh0bg273in+CpQLwf8yreOdsHPke7460jfTA1xguvBg7B518tUV0+9gIk6iZCRYzNIgHSQVd60dFskyPffI4UoCMTYHPa/zTDmpGRiVQhP5oMSUpOkUWYlp6GLLGchoS5QlDykLC4WIsEiByRAP9vvzfmxr2EuQkv4dOEEZifOAKfJLwo5DQM00/1w/9GP4QJ4SPEY9UToDTeY+CQTQ9g1KEOGHmgHYbtc8FrMe3hHfk0Ju19DiOi70H/CAn9wyQ8FSrBc/2DiE08rckkCE1s2AtO+bm+9EdsWj666SZAZeaJXnwLFi6Bo958jSEB/tb2PxVg3f3fUP3faf9r1b9IgBZKeyQ9fYJecAXXk5JlGaaKITGRZchCdrb12JjRKCdAi5oCJMHO2j8ao6I98OaxnpgQ2xNvHXsc42MfEXLywNM7/oBBYXdhXNhw8dhcVYfAH636FH03dIJXuBBcmFV2Q3e2wKAIZ/QLkdBvq4S+gv5ruyI24VTtMVAtBEhiK72+r14B0nJ7tBZgs0yAyjGnunACbLr7n2SWJURPwouL1yM+Lh56/WUkXU8SaTDZOiwWEqRjhMrEgOoJMD8f40Kfw4BQN3iFtsSg8NZCeK0wKLQVPLe74CmBZ2gLeG9/Tp6sUVOAtC2hJ3bjL2v+hCeDJfTeLOEJnSBIQq9ACT0FvVbeh4PnY27Zfi3kl5P4DYou7pYFZ58IFenR/QpNOgE2hmNQzfi0kGa1/2k7KeHFxccjLs5KvBChXrQJCZeRnGSVYEpqmpyI6ZQVtQVI+9snYLS5q5+Ebn5O6LZRwiMbndDdXwIt6yrabv7OGLt9mPxYtQVIUlsfuQldl7fHo99I6L7Bhuj7saUP4cCZw/I+sG6/egJ0laTW1NLxPEWA9igSVH5OPfGvWpp0Amwss5DNVYDNaf/T9tIbW5GfPZQG4/XxSLEdFyS0EqD3ptHmbn4kHRdZgl1F293PWdx2hiJGeoxWAqTtXRO+EQ8u7oCuX7miy1pXdP/8QYQf3V277dbtV1GAdzl3JEiAlPDsBUfCo+WOEiCfB9iMBdjcttdegPG2Vh+nF6kwQW71cjrU3yIAta8E0e3VyYLzFklwnNy+bqZUSK28XBARs1PVE7EVAdJzKtsfdGAb+q3ohQErvLArdv8t8qP9pPSvmgBdXZ8l0SmJT7nigySnCNBefE0+ATKMI4b8ytUeZTdFe7MMN8usbVlZmXwFCB0XrRZocSWIMrSs72qMuldmqHkpniJARW4ETQjtOnUA0ReO1i6zhx6r5hC4rgDtcaQA+VpgplmgfBgADSvrwVJ3mfJhAGr3/xPrcEvfWvb/az4MQa0PLrEdB+xBQqsPToAMwzRKGqLuJEb+NBiGYZq8AB35eZQsQIZhmu1nd7IAGYbhBMgCZBiGEyALkGEYToAsQIZhAXICZAEyDAuQEyALkGFYgJwAWYCqfyYg98+wADkBMgzDAuQEyAmQ+2dYgJwAGYZhAXIC5ATI/TMsQE6ADMOwADkBcgLk/hkWICdAhmFYgJwAOQFy/42flG3vOBE3QqfLKD+zADkBMozqJG+cjN+Cmv2nbZv+I9tnmNNCZtYITOlWqtO2v2tJ2zbDojxG0/5/AUr/DVEfzJ4rfx3AgoVLMG7yLLklRo/x4e8E4QTI/ashgNLrsaguybmd4tuXVWTpVRUQCYWe11yZD1NBCqpuZsJUkonK4nRUltyAqdSA6nJal2yYKwrkx9LvqJXglP7pS59+ilOJ0Qi8vAih54Lk/hsqidH3jyjio2+tI/ERtIwTIMOoIEBTYaog7RasUiq4BRIBteoLMBtn044i4voGnM/4AZeyjiHOcBzxhlj59oUbR3E2/aj8GHqsFgKsu/32+2DL6UD4X5uHhIoDiDSshr//KNXlQ0KrD0V49gK0v79ZJMCG/q7aHj16gBPgj/07av83UAK0VGTGyW/4CoNeTniVWQmoIikW1SfDfLUFaKkqTIFf/FzsLFyCKONKnC0PwfmyCFwoj8SFigjsK/4SCaZd2H5trSxrtQUYrY/Csv0zcTh6jbz99hLUnfgWXya8j8icFQhIWYjglKVYleCLNrPch6stwPqK/unQV4KSAMPCbsgCpNI6BTaaBKh8HWBDvwEbiwQdTVPe/yl+U5ySv5liJgFWCOlVZMZbERKoyNajSgxJZREU3bCToMoCDJluqShIxspT72F95jQE5LyHSOPniCpeJrNbZil2GJdg6ckZqgsw3H8M5p0agxDjR/g45k0c/2F9rfxiozdg2fmZ8E/3xRL9BCy+NBFfxE3ClOBnIU3o2EsLATp7ht8GVUMLsFEkQOVLqx3xBqQd7GgJOjoBNvX9bxXgVFN5+gUhvXiUJZ9EOckwUy+nwcrsRJiEnEy2NGg9LpitsgBnmMvzr+Ef0T74LHEU1maMx7qsKfDLmgY/AzEdW/Pnivtege++v4r1UU+ArpM7efrs6Y05cc/A99wALLz6MmYcGoHYw+sQc3A93o95Fe+c7QOfo93x1pE+mBrjhdGBXojyH6vJELgxCdDhCZAOftKbjyKwo96AjUGCjqI57H8hQOeUb9+uLEs7h7LMS7iZdAI3k4+j/MZFVGRckqVYmS2SoSERVfmUitK1EWDeFcw56I1/xL2ITxKH49PLL2H+5RGYn/giPta/gGmn+mJkdAf4bB8mBJimXgIc7zFwWEBnjDrUASMPtMOwfS54LaY9vCOfxqS9z2FE9D3oHyGhf5iEp0IlDFrngdNXjmoyCcIJ0A7aWIPBUDsD5cg3oBpvQuW/yW9t1UqSv7RVe///2v7V3v8/IUCX5G+nVZannhHyO47ixP0ovXYQpUnHUJYi0mCGNRnKw2MhQvl4oFWAFrXO+UvfJgSYewUf7H8D/xN9PybE9sSkE70w8URPvHX8cfx3dEd4hbfEU2Eu8N7+nLwOag6BdV/9Ff3XdRB9SPAMs8pu6M4WGBThjH4hEvptldBXMHDtAzgbd1A+DNAcBNjsE2B9cAJsWvufEmDyt1OFAM+h9HoMiuP2wBi/F6VXhAivH0FZ6gmRBC8IEcbLQ2IaflYXG1QToHUShIbASRgf8RK8QlsJCbXCANF6hbWGZ6gQ33YXkb6cBS4YG6K+AOm5dpwKwxNr2uLJYAm9N0t4QicIktArUEJPQb9/u+PEhX21E0KcAJv4MUCmeex/WYDfTK0qv3FeJL8DKLoUhaKLUTDG7UbJtf3ysptJsSIRnrBOjAjoNJTkjVNUnQSpzE/BuIAxlu5+zujmJ8l09f+x7epnZWzIME0ESFIL37sCjyxvi0e/kdB9gw3RZ+9l9+PkmUi77ddWgHcqOiGaZ4GZZjEL3IACdErZOMVMEx9W+e2SKby4W7QCIcLSq/tRcv2YfLK0IgC1zwOkU258Al43d5MF6AS59be1fj8K0HvTaLNWAqTtDQ79At0W/xFdv3JFl7WueHzRfTh8OEDedvvt1+pE6DudC0goAqSRgP0yPg+QaZAk2HRPhJ5ioTc2Jb/kM8GCLUg6twVF8UKIl/YICe6xyXF37RUjWlwJoturE4J73ewTMNrsTQjZ+Wyi9nX5NhERs7P2GJyaAqTnLL2+TyZy7zp4rvgLnl7RF8diNtcmPwWtjgFSpaSkoi728iM+/XSPnP6UQzR8JQjDqHAlCF1mZq7Ik8/zk9vyPGsrqDHRZJBJsytB6p58fCeUS/HUFqCS7ojyzHgcPrMDJy/uu01+BD22IS+FI9mR9AgSoXKbltPohK8FZhgVPgyh/gv/Z9T7QQCN5cMImsOHIVDqrTsUVo7/UQrkBMgwDH8cFidAhmFYgJwAGYZhAXICZBiGBcgJkGEYFiAnQIZhWICcABmGYQFyAmQYhgXICZBhGBYgJ0CGYTgBcgJkGIYTIAuQYRhOgCxAhmE4AbIAGYbhBMgCZBgWICdAFiDDsAA5AbIAGYYFyAnw9yDAuvUvSWp3p53xqSS1UnPnMAwLkBNgo/kDRnXp4pu2YEHG7j//eVzdnXGkc+fxBYsX6w+1bTtSSwG6SlJrexpyX7je5dxx/vz5C+pjwIAB3vyGZzgBqizAX1Pt/n6f58pLsy70W95vimoraKvw1q3fy/7wQyAkBIVr1ph2d+zoo9wX7e7uU755swnJySjftq10v02CmshPSEg8dQ+CbjekBG2Su63Ky8phMBhAIuQ3PcMJ0AECvGtmh95+1z7OS6g4gEjDajy8sNs4tQS4VZJmxru4wNC2LYpeeAE1y5ahaNUqU1THjmP3CcpWrzYhMhIIDwdOnkTFli03D3XqNFILAZL46Kv+CFdX12dlETaQBOsTIH0LGq1LXFy8/DNLkOEEqIEA233w8PNvRrwc5jaxY5fbkp9vZ6+Vet/syJwVCEhZiOCUpViV4Is2s9yHq/EH/F6Svj4nVvWGIEtQ1L49qidPRtny5ahYtAhYuRJYvRrYuBHYsgXYswenHnlksRZDUJIeCYe+I7ahJVifAC2C4pJixAsBUktCZAkynABVFGCrtz0Gzjk5yhhi/Agf/DBWL/m0d1dW4g/TOz+x9Py7Of7pvliin4DFlybii7hJeG3r4CRpQsdeKvwBnUQCfGCzJIVcEqtrEOQKjALT4MGwzJ4Ny5w5wLx5wJIlMH/9NU737h1Cv6OlAIf/7bkGl+CdhsD0nbgkv7j4eDkJErROLACGE+B/KEDXyZ08R+/tWTon7hn4nhuAhVdfxtv7RuilN/7kce87Dz45K+aVnHfO9oHP0e5460gfTI3xwiD/HnrJu0MfFY8ByhIMlqRtcZJkyRZPmy8oFlQ++ihqpk4F3n0XVXPmWI737LmNHku/o7UA60pQ62OCNgFabkuBYkl1tQlGIUFaF5IhT4ownADVSIDjPQZ6BnQoGHWoA0YeaIdh+1zwWkx7eO8Yen3i3mezR0Tfg/4REvqHSXgqVEKXL1tek3zc+6o9CUIlUqDHTlfXSxlOTnISLLBJsKJLF+DttxE/YsQFeoxWs8D1CdBeglqnwIEDB/rUJ0DYLaQhMCVCFiDDCVCtY4DjPZ5/6EuXTK9wCZ5hVtkN3dkCgyKc0S9EQr+tEvoK7lvuJpJh5ydUXUF7AbZoMe703XeXJounTRcoSZCGw5WPPYb8adNK7E+RaXoCHOQNs6UGP1fChixAhhOgmrPAPp1fuX+la86TwRJ6b5bwhE4QJKFXoISeAvcvWlyVvB/op7qhbaUTa3CoZcsqvXjKREGSbVKEJJgnKKQk2LcvcidPrtrh7u7TUAJsyCHwkKFDfCxmS7WS+BSsN24NhixAhhOg2qfB+LgP77DINfvRbyR032DDT0K7z9wSJW+PPpqsICU/Z+exu5ycqk+IpzsjoMmQK0TLlrgmhsNZtsmRPDc33OzTB4axY6t3deo0pqlNggwdOtTHbDabYAbMNTUwi+GujLhdU10jD3+VDMgCZDgBanEe4HiPkX/8rEV2169c0WWtK+6d53ZFGnufp2aGpvTn5vbP3e3b44izM2LFU9IpMWeE7La3br0jWJJ2XhQ/Z9gSYW6bNjB4eSGqc+cFWgqwoeXn5eXlNGTIEB9TVVUViY4mPUwmK3TMr4ZaOv4nsHACZDgBangitLfH848t7VrQ/fOu1++U/FQUIM0Adw5wc/tul5BgjIsLDgsRBru60mzvw4QYHm87azsuePnuuxF5773f0e80tROhSYBlpWUmuvKjvNxG2e0ICXICZDgBangliJPk7f5f9rO9WiZA6u97sb2Bbm6bQtu2hRDedtupLsqVIg8EimWHRHehTk6b6LGanAbj4EvhBg8e7G0sNtaUlJbgFm6WoLhEUFosnwJDEmQBMpwAm9aHITjZ0t6bou0mS/jW+7rZ7ntYua+pfRjCwIEDvU2mKnNlZRUqKiqE6MpQUV6ByopKVFeZ5GFxjYAnQRhOgE3z47Cc7PjZ+5rai5mG3B/Mnmv+cM48omb2R5/UzBYt/fzB7HmWD2fPtYj7QfCVIAwnQI0E2Ng3qqm+EJQheOs2LTtS26pNy06t2rh1anUPtS07yUNyBevxSi4uToAsQPCrhYuLEyALkIuLixNgoxYgFxcXV7NNgFxcXFycALm4uLg4AXJxcXE1kgTIMAzTFPh/7ilJ+J+MkXkAAAAASUVORK5CYII=") -100px -68px no-repeat}.jstree-default .jstree-folder{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAYAAABsS6soAAAV40lEQVR42u2dCXQUVbrHKwsEHEWGYZkEVzZ1BEGQBHiAioqiPA++N4gkoKwiyBjGp+AIIjJHkGVgEFAgQSVJY4CQjSWsASGEfU06YctKks6eTkK2Trr/737VXbEJwW2q0jH5vnN+53aqO32rKt2//G/dqm4JgPRr4bLW/fd3BvfPxeW4199v8dctLmMBcnFx/V6LBcgJjBMgFydAFiAXFxcnQBYgJzBOgFycAFmAXFxcnABZgJzAOAFycQJkAXJxcXECZAFyAvsd9h8YGOhU3+3GUI1tfbSqpDPfoz7OHf6ylpM75iL36sYZnAC5uFSodevXISgoyKLT6Sy6oM1m0VYHbdbVBOno9maLuA9BdJ9OB/m2gH5H5f4VqD+zbX3MtnWoptubdWKZ9v3/ItTs315+5sqCn6ZcLxO1aVqDiMIhAmSsqPEfiPv/eegNnZySAmOxEUXGIhQVFaKQKCyC0VgolhejuFjcLqG2GAaDQZaAmv0Xi+cuLyuHsUj0L/rML8xHflEe8grzUGDMk9eJ1q9MPIYeq1b/VEr/NdXVP8mRxBhsuvwFtp7ZKvevlQBNhWkydPtOCZDQWoIOS4AM05BQ4srLzZdFl59fgPyCAhQJ2RQTJKbScllORE21SW7VF6ARZ9OOIvT6BpzN+AHnDcdwMSMW8VnHcT4rBhduHMP5GzE4Jx6jlQDlba+DIuYtpwPhf20eEioOINKwGh+um62NAG0JjwR4WyK03deQKdAhAlTzxaUGPXr0QHNKYMr+bywJUMv9T8fWxLDSnJWZibz8fDndEXl5NhGK5EWpj0SgyEBNARHB32+15Oflwz9hHnYWLsWewn/jbNk2XCgLx/mbYTh7czsOGb/GpcpIhF3bgLzcAojfUVWAe+MO4rPDs7DjQoi8/fYC1J34Fl8mvI/InBUISFmI4JSlWJXgizaz3IerKRtKd/aCqxVgHfFVFMTKNNkESH+Q4O+3oLHIz1ECdGAialb7XxekM2dmZsCQZUBaWhrS09ORlUUSzBUSyJdFWCAwKgIsVluAWyy5uXlYcWYmNmS8jYCcWYg0LkKUcRmiipdhd9FS7Cxagoj8xVh16u/IyctT7e9D9dlXn2PeqTEIMX6Ej2PexHf7gmoFuPW0DsvOz4R/ui+W6Cdg8aWJ+CJuEryDX4I0oWMvLQRIcqNW/tlOgIr4GkqADk2AtPMdnQTpjTd6jA+aYwJsTvtfpwuqyRACTE1LRUpKKlJT05CWfkNIMAs52dlChPny/iiwJSJjSZGq+2aLECBJbXa0DxYmjsKa9LewPmMK/DKnwS9rGjZkvgP/zL/hnwmj8OFBb+Tm5JIALWr07Tq5k+cbUU9iTtwz8D03AAuvvowZh0bg273in+CpQLwf8yreOdsHPke7460jfTA1xguvBg7B518tUV0+9gIk6iZCRYzNIgHSQVd60dFskyPffI4UoCMTYHPa/zTDmpGRiVQhP5oMSUpOkUWYlp6GLLGchoS5QlDykLC4WIsEiByRAP9vvzfmxr2EuQkv4dOEEZifOAKfJLwo5DQM00/1w/9GP4QJ4SPEY9UToDTeY+CQTQ9g1KEOGHmgHYbtc8FrMe3hHfk0Ju19DiOi70H/CAn9wyQ8FSrBc/2DiE08rckkCE1s2AtO+bm+9EdsWj666SZAZeaJXnwLFi6Bo958jSEB/tb2PxVg3f3fUP3faf9r1b9IgBZKeyQ9fYJecAXXk5JlGaaKITGRZchCdrb12JjRKCdAi5oCJMHO2j8ao6I98OaxnpgQ2xNvHXsc42MfEXLywNM7/oBBYXdhXNhw8dhcVYfAH636FH03dIJXuBBcmFV2Q3e2wKAIZ/QLkdBvq4S+gv5ruyI24VTtMVAtBEhiK72+r14B0nJ7tBZgs0yAyjGnunACbLr7n2SWJURPwouL1yM+Lh56/WUkXU8SaTDZOiwWEqRjhMrEgOoJMD8f40Kfw4BQN3iFtsSg8NZCeK0wKLQVPLe74CmBZ2gLeG9/Tp6sUVOAtC2hJ3bjL2v+hCeDJfTeLOEJnSBIQq9ACT0FvVbeh4PnY27Zfi3kl5P4DYou7pYFZ58IFenR/QpNOgE2hmNQzfi0kGa1/2k7KeHFxccjLs5KvBChXrQJCZeRnGSVYEpqmpyI6ZQVtQVI+9snYLS5q5+Ebn5O6LZRwiMbndDdXwIt6yrabv7OGLt9mPxYtQVIUlsfuQldl7fHo99I6L7Bhuj7saUP4cCZw/I+sG6/egJ0laTW1NLxPEWA9igSVH5OPfGvWpp0Amwss5DNVYDNaf/T9tIbW5GfPZQG4/XxSLEdFyS0EqD3ptHmbn4kHRdZgl1F293PWdx2hiJGeoxWAqTtXRO+EQ8u7oCuX7miy1pXdP/8QYQf3V277dbtV1GAdzl3JEiAlPDsBUfCo+WOEiCfB9iMBdjcttdegPG2Vh+nF6kwQW71cjrU3yIAta8E0e3VyYLzFklwnNy+bqZUSK28XBARs1PVE7EVAdJzKtsfdGAb+q3ohQErvLArdv8t8qP9pPSvmgBdXZ8l0SmJT7nigySnCNBefE0+ATKMI4b8ytUeZTdFe7MMN8usbVlZmXwFCB0XrRZocSWIMrSs72qMuldmqHkpniJARW4ETQjtOnUA0ReO1i6zhx6r5hC4rgDtcaQA+VpgplmgfBgADSvrwVJ3mfJhAGr3/xPrcEvfWvb/az4MQa0PLrEdB+xBQqsPToAMwzRKGqLuJEb+NBiGYZq8AB35eZQsQIZhmu1nd7IAGYbhBMgCZBiGEyALkGEYToAsQIZhAXICZAEyDAuQEyALkGFYgJwAWYCqfyYg98+wADkBMgzDAuQEyAmQ+2dYgJwAGYZhAXIC5ATI/TMsQE6ADMOwADkBcgLk/hkWICdAhmFYgJwAOQFy/42flG3vOBE3QqfLKD+zADkBMozqJG+cjN+Cmv2nbZv+I9tnmNNCZtYITOlWqtO2v2tJ2zbDojxG0/5/AUr/DVEfzJ4rfx3AgoVLMG7yLLklRo/x4e8E4QTI/ashgNLrsaguybmd4tuXVWTpVRUQCYWe11yZD1NBCqpuZsJUkonK4nRUltyAqdSA6nJal2yYKwrkx9LvqJXglP7pS59+ilOJ0Qi8vAih54Lk/hsqidH3jyjio2+tI/ERtIwTIMOoIEBTYaog7RasUiq4BRIBteoLMBtn044i4voGnM/4AZeyjiHOcBzxhlj59oUbR3E2/aj8GHqsFgKsu/32+2DL6UD4X5uHhIoDiDSshr//KNXlQ0KrD0V49gK0v79ZJMCG/q7aHj16gBPgj/07av83UAK0VGTGyW/4CoNeTniVWQmoIikW1SfDfLUFaKkqTIFf/FzsLFyCKONKnC0PwfmyCFwoj8SFigjsK/4SCaZd2H5trSxrtQUYrY/Csv0zcTh6jbz99hLUnfgWXya8j8icFQhIWYjglKVYleCLNrPch6stwPqK/unQV4KSAMPCbsgCpNI6BTaaBKh8HWBDvwEbiwQdTVPe/yl+U5ySv5liJgFWCOlVZMZbERKoyNajSgxJZREU3bCToMoCDJluqShIxspT72F95jQE5LyHSOPniCpeJrNbZil2GJdg6ckZqgsw3H8M5p0agxDjR/g45k0c/2F9rfxiozdg2fmZ8E/3xRL9BCy+NBFfxE3ClOBnIU3o2EsLATp7ht8GVUMLsFEkQOVLqx3xBqQd7GgJOjoBNvX9bxXgVFN5+gUhvXiUJZ9EOckwUy+nwcrsRJiEnEy2NGg9LpitsgBnmMvzr+Ef0T74LHEU1maMx7qsKfDLmgY/AzEdW/Pnivtege++v4r1UU+ArpM7efrs6Y05cc/A99wALLz6MmYcGoHYw+sQc3A93o95Fe+c7QOfo93x1pE+mBrjhdGBXojyH6vJELgxCdDhCZAOftKbjyKwo96AjUGCjqI57H8hQOeUb9+uLEs7h7LMS7iZdAI3k4+j/MZFVGRckqVYmS2SoSERVfmUitK1EWDeFcw56I1/xL2ITxKH49PLL2H+5RGYn/giPta/gGmn+mJkdAf4bB8mBJimXgIc7zFwWEBnjDrUASMPtMOwfS54LaY9vCOfxqS9z2FE9D3oHyGhf5iEp0IlDFrngdNXjmoyCcIJ0A7aWIPBUDsD5cg3oBpvQuW/yW9t1UqSv7RVe///2v7V3v8/IUCX5G+nVZannhHyO47ixP0ovXYQpUnHUJYi0mCGNRnKw2MhQvl4oFWAFrXO+UvfJgSYewUf7H8D/xN9PybE9sSkE70w8URPvHX8cfx3dEd4hbfEU2Eu8N7+nLwOag6BdV/9Ff3XdRB9SPAMs8pu6M4WGBThjH4hEvptldBXMHDtAzgbd1A+DNAcBNjsE2B9cAJsWvufEmDyt1OFAM+h9HoMiuP2wBi/F6VXhAivH0FZ6gmRBC8IEcbLQ2IaflYXG1QToHUShIbASRgf8RK8QlsJCbXCANF6hbWGZ6gQ33YXkb6cBS4YG6K+AOm5dpwKwxNr2uLJYAm9N0t4QicIktArUEJPQb9/u+PEhX21E0KcAJv4MUCmeex/WYDfTK0qv3FeJL8DKLoUhaKLUTDG7UbJtf3ysptJsSIRnrBOjAjoNJTkjVNUnQSpzE/BuIAxlu5+zujmJ8l09f+x7epnZWzIME0ESFIL37sCjyxvi0e/kdB9gw3RZ+9l9+PkmUi77ddWgHcqOiGaZ4GZZjEL3IACdErZOMVMEx9W+e2SKby4W7QCIcLSq/tRcv2YfLK0IgC1zwOkU258Al43d5MF6AS59be1fj8K0HvTaLNWAqTtDQ79At0W/xFdv3JFl7WueHzRfTh8OEDedvvt1+pE6DudC0goAqSRgP0yPg+QaZAk2HRPhJ5ioTc2Jb/kM8GCLUg6twVF8UKIl/YICe6xyXF37RUjWlwJoturE4J73ewTMNrsTQjZ+Wyi9nX5NhERs7P2GJyaAqTnLL2+TyZy7zp4rvgLnl7RF8diNtcmPwWtjgFSpaSkoi728iM+/XSPnP6UQzR8JQjDqHAlCF1mZq7Ik8/zk9vyPGsrqDHRZJBJsytB6p58fCeUS/HUFqCS7ojyzHgcPrMDJy/uu01+BD22IS+FI9mR9AgSoXKbltPohK8FZhgVPgyh/gv/Z9T7QQCN5cMImsOHIVDqrTsUVo7/UQrkBMgwDH8cFidAhmFYgJwAGYZhAXICZBiGBcgJkGEYFiAnQIZhWICcABmGYQFyAmQYhgXICZBhGBYgJ0CGYTgBcgJkGIYTIAuQYRhOgCxAhmE4AbIAGYbhBMgCZBgWICdAFiDDsAA5AbIAGYYFyAnw9yDAuvUvSWp3p53xqSS1UnPnMAwLkBNgo/kDRnXp4pu2YEHG7j//eVzdnXGkc+fxBYsX6w+1bTtSSwG6SlJrexpyX7je5dxx/vz5C+pjwIAB3vyGZzgBqizAX1Pt/n6f58pLsy70W95vimoraKvw1q3fy/7wQyAkBIVr1ph2d+zoo9wX7e7uU755swnJySjftq10v02CmshPSEg8dQ+CbjekBG2Su63Ky8phMBhAIuQ3PcMJ0AECvGtmh95+1z7OS6g4gEjDajy8sNs4tQS4VZJmxru4wNC2LYpeeAE1y5ahaNUqU1THjmP3CcpWrzYhMhIIDwdOnkTFli03D3XqNFILAZL46Kv+CFdX12dlETaQBOsTIH0LGq1LXFy8/DNLkOEEqIEA233w8PNvRrwc5jaxY5fbkp9vZ6+Vet/syJwVCEhZiOCUpViV4Is2s9yHq/EH/F6Svj4nVvWGIEtQ1L49qidPRtny5ahYtAhYuRJYvRrYuBHYsgXYswenHnlksRZDUJIeCYe+I7ahJVifAC2C4pJixAsBUktCZAkynABVFGCrtz0Gzjk5yhhi/Agf/DBWL/m0d1dW4g/TOz+x9Py7Of7pvliin4DFlybii7hJeG3r4CRpQsdeKvwBnUQCfGCzJIVcEqtrEOQKjALT4MGwzJ4Ny5w5wLx5wJIlMH/9NU737h1Cv6OlAIf/7bkGl+CdhsD0nbgkv7j4eDkJErROLACGE+B/KEDXyZ08R+/tWTon7hn4nhuAhVdfxtv7RuilN/7kce87Dz45K+aVnHfO9oHP0e5460gfTI3xwiD/HnrJu0MfFY8ByhIMlqRtcZJkyRZPmy8oFlQ++ihqpk4F3n0XVXPmWI737LmNHku/o7UA60pQ62OCNgFabkuBYkl1tQlGIUFaF5IhT4ownADVSIDjPQZ6BnQoGHWoA0YeaIdh+1zwWkx7eO8Yen3i3mezR0Tfg/4REvqHSXgqVEKXL1tek3zc+6o9CUIlUqDHTlfXSxlOTnISLLBJsKJLF+DttxE/YsQFeoxWs8D1CdBeglqnwIEDB/rUJ0DYLaQhMCVCFiDDCVCtY4DjPZ5/6EuXTK9wCZ5hVtkN3dkCgyKc0S9EQr+tEvoK7lvuJpJh5ydUXUF7AbZoMe703XeXJounTRcoSZCGw5WPPYb8adNK7E+RaXoCHOQNs6UGP1fChixAhhOgmrPAPp1fuX+la86TwRJ6b5bwhE4QJKFXoISeAvcvWlyVvB/op7qhbaUTa3CoZcsqvXjKREGSbVKEJJgnKKQk2LcvcidPrtrh7u7TUAJsyCHwkKFDfCxmS7WS+BSsN24NhixAhhOg2qfB+LgP77DINfvRbyR032DDT0K7z9wSJW+PPpqsICU/Z+exu5ycqk+IpzsjoMmQK0TLlrgmhsNZtsmRPDc33OzTB4axY6t3deo0pqlNggwdOtTHbDabYAbMNTUwi+GujLhdU10jD3+VDMgCZDgBanEe4HiPkX/8rEV2169c0WWtK+6d53ZFGnufp2aGpvTn5vbP3e3b44izM2LFU9IpMWeE7La3br0jWJJ2XhQ/Z9gSYW6bNjB4eSGqc+cFWgqwoeXn5eXlNGTIEB9TVVUViY4mPUwmK3TMr4ZaOv4nsHACZDgBangitLfH848t7VrQ/fOu1++U/FQUIM0Adw5wc/tul5BgjIsLDgsRBru60mzvw4QYHm87azsuePnuuxF5773f0e80tROhSYBlpWUmuvKjvNxG2e0ICXICZDgBangliJPk7f5f9rO9WiZA6u97sb2Bbm6bQtu2hRDedtupLsqVIg8EimWHRHehTk6b6LGanAbj4EvhBg8e7G0sNtaUlJbgFm6WoLhEUFosnwJDEmQBMpwAm9aHITjZ0t6bou0mS/jW+7rZ7ntYua+pfRjCwIEDvU2mKnNlZRUqKiqE6MpQUV6ByopKVFeZ5GFxjYAnQRhOgE3z47Cc7PjZ+5rai5mG3B/Mnmv+cM48omb2R5/UzBYt/fzB7HmWD2fPtYj7QfCVIAwnQI0E2Ng3qqm+EJQheOs2LTtS26pNy06t2rh1anUPtS07yUNyBevxSi4uToAsQPCrhYuLEyALkIuLixNgoxYgFxcXV7NNgFxcXFycALm4uLg4AXJxcXE1kgTIMAzTFPh/7ilJ+J+MkXkAAAAASUVORK5CYII=") -260px -4px no-repeat}.jstree-default>.jstree-container-ul>.jstree-node{margin-left:0;margin-right:0}#jstree-dnd.jstree-default{line-height:24px;padding:0 4px}#jstree-dnd.jstree-default .jstree-ok,#jstree-dnd.jstree-default .jstree-er{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAYAAABsS6soAAAV40lEQVR42u2dCXQUVbrHKwsEHEWGYZkEVzZ1BEGQBHiAioqiPA++N4gkoKwiyBjGp+AIIjJHkGVgEFAgQSVJY4CQjSWsASGEfU06YctKks6eTkK2Trr/737VXbEJwW2q0jH5vnN+53aqO32rKt2//G/dqm4JgPRr4bLW/fd3BvfPxeW4199v8dctLmMBcnFx/V6LBcgJjBMgFydAFiAXFxcnQBYgJzBOgFycAFmAXFxcnABZgJzAOAFycQJkAXJxcXECZAFyAvsd9h8YGOhU3+3GUI1tfbSqpDPfoz7OHf6ylpM75iL36sYZnAC5uFSodevXISgoyKLT6Sy6oM1m0VYHbdbVBOno9maLuA9BdJ9OB/m2gH5H5f4VqD+zbX3MtnWoptubdWKZ9v3/ItTs315+5sqCn6ZcLxO1aVqDiMIhAmSsqPEfiPv/eegNnZySAmOxEUXGIhQVFaKQKCyC0VgolhejuFjcLqG2GAaDQZaAmv0Xi+cuLyuHsUj0L/rML8xHflEe8grzUGDMk9eJ1q9MPIYeq1b/VEr/NdXVP8mRxBhsuvwFtp7ZKvevlQBNhWkydPtOCZDQWoIOS4AM05BQ4srLzZdFl59fgPyCAhQJ2RQTJKbScllORE21SW7VF6ARZ9OOIvT6BpzN+AHnDcdwMSMW8VnHcT4rBhduHMP5GzE4Jx6jlQDlba+DIuYtpwPhf20eEioOINKwGh+um62NAG0JjwR4WyK03deQKdAhAlTzxaUGPXr0QHNKYMr+bywJUMv9T8fWxLDSnJWZibz8fDndEXl5NhGK5EWpj0SgyEBNARHB32+15Oflwz9hHnYWLsWewn/jbNk2XCgLx/mbYTh7czsOGb/GpcpIhF3bgLzcAojfUVWAe+MO4rPDs7DjQoi8/fYC1J34Fl8mvI/InBUISFmI4JSlWJXgizaz3IerKRtKd/aCqxVgHfFVFMTKNNkESH+Q4O+3oLHIz1ECdGAialb7XxekM2dmZsCQZUBaWhrS09ORlUUSzBUSyJdFWCAwKgIsVluAWyy5uXlYcWYmNmS8jYCcWYg0LkKUcRmiipdhd9FS7Cxagoj8xVh16u/IyctT7e9D9dlXn2PeqTEIMX6Ej2PexHf7gmoFuPW0DsvOz4R/ui+W6Cdg8aWJ+CJuEryDX4I0oWMvLQRIcqNW/tlOgIr4GkqADk2AtPMdnQTpjTd6jA+aYwJsTvtfpwuqyRACTE1LRUpKKlJT05CWfkNIMAs52dlChPny/iiwJSJjSZGq+2aLECBJbXa0DxYmjsKa9LewPmMK/DKnwS9rGjZkvgP/zL/hnwmj8OFBb+Tm5JIALWr07Tq5k+cbUU9iTtwz8D03AAuvvowZh0bg273in+CpQLwf8yreOdsHPke7460jfTA1xguvBg7B518tUV0+9gIk6iZCRYzNIgHSQVd60dFskyPffI4UoCMTYHPa/zTDmpGRiVQhP5oMSUpOkUWYlp6GLLGchoS5QlDykLC4WIsEiByRAP9vvzfmxr2EuQkv4dOEEZifOAKfJLwo5DQM00/1w/9GP4QJ4SPEY9UToDTeY+CQTQ9g1KEOGHmgHYbtc8FrMe3hHfk0Ju19DiOi70H/CAn9wyQ8FSrBc/2DiE08rckkCE1s2AtO+bm+9EdsWj666SZAZeaJXnwLFi6Bo958jSEB/tb2PxVg3f3fUP3faf9r1b9IgBZKeyQ9fYJecAXXk5JlGaaKITGRZchCdrb12JjRKCdAi5oCJMHO2j8ao6I98OaxnpgQ2xNvHXsc42MfEXLywNM7/oBBYXdhXNhw8dhcVYfAH636FH03dIJXuBBcmFV2Q3e2wKAIZ/QLkdBvq4S+gv5ruyI24VTtMVAtBEhiK72+r14B0nJ7tBZgs0yAyjGnunACbLr7n2SWJURPwouL1yM+Lh56/WUkXU8SaTDZOiwWEqRjhMrEgOoJMD8f40Kfw4BQN3iFtsSg8NZCeK0wKLQVPLe74CmBZ2gLeG9/Tp6sUVOAtC2hJ3bjL2v+hCeDJfTeLOEJnSBIQq9ACT0FvVbeh4PnY27Zfi3kl5P4DYou7pYFZ58IFenR/QpNOgE2hmNQzfi0kGa1/2k7KeHFxccjLs5KvBChXrQJCZeRnGSVYEpqmpyI6ZQVtQVI+9snYLS5q5+Ebn5O6LZRwiMbndDdXwIt6yrabv7OGLt9mPxYtQVIUlsfuQldl7fHo99I6L7Bhuj7saUP4cCZw/I+sG6/egJ0laTW1NLxPEWA9igSVH5OPfGvWpp0Amwss5DNVYDNaf/T9tIbW5GfPZQG4/XxSLEdFyS0EqD3ptHmbn4kHRdZgl1F293PWdx2hiJGeoxWAqTtXRO+EQ8u7oCuX7miy1pXdP/8QYQf3V277dbtV1GAdzl3JEiAlPDsBUfCo+WOEiCfB9iMBdjcttdegPG2Vh+nF6kwQW71cjrU3yIAta8E0e3VyYLzFklwnNy+bqZUSK28XBARs1PVE7EVAdJzKtsfdGAb+q3ohQErvLArdv8t8qP9pPSvmgBdXZ8l0SmJT7nigySnCNBefE0+ATKMI4b8ytUeZTdFe7MMN8usbVlZmXwFCB0XrRZocSWIMrSs72qMuldmqHkpniJARW4ETQjtOnUA0ReO1i6zhx6r5hC4rgDtcaQA+VpgplmgfBgADSvrwVJ3mfJhAGr3/xPrcEvfWvb/az4MQa0PLrEdB+xBQqsPToAMwzRKGqLuJEb+NBiGYZq8AB35eZQsQIZhmu1nd7IAGYbhBMgCZBiGEyALkGEYToAsQIZhAXICZAEyDAuQEyALkGFYgJwAWYCqfyYg98+wADkBMgzDAuQEyAmQ+2dYgJwAGYZhAXIC5ATI/TMsQE6ADMOwADkBcgLk/hkWICdAhmFYgJwAOQFy/42flG3vOBE3QqfLKD+zADkBMozqJG+cjN+Cmv2nbZv+I9tnmNNCZtYITOlWqtO2v2tJ2zbDojxG0/5/AUr/DVEfzJ4rfx3AgoVLMG7yLLklRo/x4e8E4QTI/ashgNLrsaguybmd4tuXVWTpVRUQCYWe11yZD1NBCqpuZsJUkonK4nRUltyAqdSA6nJal2yYKwrkx9LvqJXglP7pS59+ilOJ0Qi8vAih54Lk/hsqidH3jyjio2+tI/ERtIwTIMOoIEBTYaog7RasUiq4BRIBteoLMBtn044i4voGnM/4AZeyjiHOcBzxhlj59oUbR3E2/aj8GHqsFgKsu/32+2DL6UD4X5uHhIoDiDSshr//KNXlQ0KrD0V49gK0v79ZJMCG/q7aHj16gBPgj/07av83UAK0VGTGyW/4CoNeTniVWQmoIikW1SfDfLUFaKkqTIFf/FzsLFyCKONKnC0PwfmyCFwoj8SFigjsK/4SCaZd2H5trSxrtQUYrY/Csv0zcTh6jbz99hLUnfgWXya8j8icFQhIWYjglKVYleCLNrPch6stwPqK/unQV4KSAMPCbsgCpNI6BTaaBKh8HWBDvwEbiwQdTVPe/yl+U5ySv5liJgFWCOlVZMZbERKoyNajSgxJZREU3bCToMoCDJluqShIxspT72F95jQE5LyHSOPniCpeJrNbZil2GJdg6ckZqgsw3H8M5p0agxDjR/g45k0c/2F9rfxiozdg2fmZ8E/3xRL9BCy+NBFfxE3ClOBnIU3o2EsLATp7ht8GVUMLsFEkQOVLqx3xBqQd7GgJOjoBNvX9bxXgVFN5+gUhvXiUJZ9EOckwUy+nwcrsRJiEnEy2NGg9LpitsgBnmMvzr+Ef0T74LHEU1maMx7qsKfDLmgY/AzEdW/Pnivtege++v4r1UU+ArpM7efrs6Y05cc/A99wALLz6MmYcGoHYw+sQc3A93o95Fe+c7QOfo93x1pE+mBrjhdGBXojyH6vJELgxCdDhCZAOftKbjyKwo96AjUGCjqI57H8hQOeUb9+uLEs7h7LMS7iZdAI3k4+j/MZFVGRckqVYmS2SoSERVfmUitK1EWDeFcw56I1/xL2ITxKH49PLL2H+5RGYn/giPta/gGmn+mJkdAf4bB8mBJimXgIc7zFwWEBnjDrUASMPtMOwfS54LaY9vCOfxqS9z2FE9D3oHyGhf5iEp0IlDFrngdNXjmoyCcIJ0A7aWIPBUDsD5cg3oBpvQuW/yW9t1UqSv7RVe///2v7V3v8/IUCX5G+nVZannhHyO47ixP0ovXYQpUnHUJYi0mCGNRnKw2MhQvl4oFWAFrXO+UvfJgSYewUf7H8D/xN9PybE9sSkE70w8URPvHX8cfx3dEd4hbfEU2Eu8N7+nLwOag6BdV/9Ff3XdRB9SPAMs8pu6M4WGBThjH4hEvptldBXMHDtAzgbd1A+DNAcBNjsE2B9cAJsWvufEmDyt1OFAM+h9HoMiuP2wBi/F6VXhAivH0FZ6gmRBC8IEcbLQ2IaflYXG1QToHUShIbASRgf8RK8QlsJCbXCANF6hbWGZ6gQ33YXkb6cBS4YG6K+AOm5dpwKwxNr2uLJYAm9N0t4QicIktArUEJPQb9/u+PEhX21E0KcAJv4MUCmeex/WYDfTK0qv3FeJL8DKLoUhaKLUTDG7UbJtf3ysptJsSIRnrBOjAjoNJTkjVNUnQSpzE/BuIAxlu5+zujmJ8l09f+x7epnZWzIME0ESFIL37sCjyxvi0e/kdB9gw3RZ+9l9+PkmUi77ddWgHcqOiGaZ4GZZjEL3IACdErZOMVMEx9W+e2SKby4W7QCIcLSq/tRcv2YfLK0IgC1zwOkU258Al43d5MF6AS59be1fj8K0HvTaLNWAqTtDQ79At0W/xFdv3JFl7WueHzRfTh8OEDedvvt1+pE6DudC0goAqSRgP0yPg+QaZAk2HRPhJ5ioTc2Jb/kM8GCLUg6twVF8UKIl/YICe6xyXF37RUjWlwJoturE4J73ewTMNrsTQjZ+Wyi9nX5NhERs7P2GJyaAqTnLL2+TyZy7zp4rvgLnl7RF8diNtcmPwWtjgFSpaSkoi728iM+/XSPnP6UQzR8JQjDqHAlCF1mZq7Ik8/zk9vyPGsrqDHRZJBJsytB6p58fCeUS/HUFqCS7ojyzHgcPrMDJy/uu01+BD22IS+FI9mR9AgSoXKbltPohK8FZhgVPgyh/gv/Z9T7QQCN5cMImsOHIVDqrTsUVo7/UQrkBMgwDH8cFidAhmFYgJwAGYZhAXICZBiGBcgJkGEYFiAnQIZhWICcABmGYQFyAmQYhgXICZBhGBYgJ0CGYTgBcgJkGIYTIAuQYRhOgCxAhmE4AbIAGYbhBMgCZBgWICdAFiDDsAA5AbIAGYYFyAnw9yDAuvUvSWp3p53xqSS1UnPnMAwLkBNgo/kDRnXp4pu2YEHG7j//eVzdnXGkc+fxBYsX6w+1bTtSSwG6SlJrexpyX7je5dxx/vz5C+pjwIAB3vyGZzgBqizAX1Pt/n6f58pLsy70W95vimoraKvw1q3fy/7wQyAkBIVr1ph2d+zoo9wX7e7uU755swnJySjftq10v02CmshPSEg8dQ+CbjekBG2Su63Ky8phMBhAIuQ3PcMJ0AECvGtmh95+1z7OS6g4gEjDajy8sNs4tQS4VZJmxru4wNC2LYpeeAE1y5ahaNUqU1THjmP3CcpWrzYhMhIIDwdOnkTFli03D3XqNFILAZL46Kv+CFdX12dlETaQBOsTIH0LGq1LXFy8/DNLkOEEqIEA233w8PNvRrwc5jaxY5fbkp9vZ6+Vet/syJwVCEhZiOCUpViV4Is2s9yHq/EH/F6Svj4nVvWGIEtQ1L49qidPRtny5ahYtAhYuRJYvRrYuBHYsgXYswenHnlksRZDUJIeCYe+I7ahJVifAC2C4pJixAsBUktCZAkynABVFGCrtz0Gzjk5yhhi/Agf/DBWL/m0d1dW4g/TOz+x9Py7Of7pvliin4DFlybii7hJeG3r4CRpQsdeKvwBnUQCfGCzJIVcEqtrEOQKjALT4MGwzJ4Ny5w5wLx5wJIlMH/9NU737h1Cv6OlAIf/7bkGl+CdhsD0nbgkv7j4eDkJErROLACGE+B/KEDXyZ08R+/tWTon7hn4nhuAhVdfxtv7RuilN/7kce87Dz45K+aVnHfO9oHP0e5460gfTI3xwiD/HnrJu0MfFY8ByhIMlqRtcZJkyRZPmy8oFlQ++ihqpk4F3n0XVXPmWI737LmNHku/o7UA60pQ62OCNgFabkuBYkl1tQlGIUFaF5IhT4ownADVSIDjPQZ6BnQoGHWoA0YeaIdh+1zwWkx7eO8Yen3i3mezR0Tfg/4REvqHSXgqVEKXL1tek3zc+6o9CUIlUqDHTlfXSxlOTnISLLBJsKJLF+DttxE/YsQFeoxWs8D1CdBeglqnwIEDB/rUJ0DYLaQhMCVCFiDDCVCtY4DjPZ5/6EuXTK9wCZ5hVtkN3dkCgyKc0S9EQr+tEvoK7lvuJpJh5ydUXUF7AbZoMe703XeXJounTRcoSZCGw5WPPYb8adNK7E+RaXoCHOQNs6UGP1fChixAhhOgmrPAPp1fuX+la86TwRJ6b5bwhE4QJKFXoISeAvcvWlyVvB/op7qhbaUTa3CoZcsqvXjKREGSbVKEJJgnKKQk2LcvcidPrtrh7u7TUAJsyCHwkKFDfCxmS7WS+BSsN24NhixAhhOg2qfB+LgP77DINfvRbyR032DDT0K7z9wSJW+PPpqsICU/Z+exu5ycqk+IpzsjoMmQK0TLlrgmhsNZtsmRPDc33OzTB4axY6t3deo0pqlNggwdOtTHbDabYAbMNTUwi+GujLhdU10jD3+VDMgCZDgBanEe4HiPkX/8rEV2169c0WWtK+6d53ZFGnufp2aGpvTn5vbP3e3b44izM2LFU9IpMWeE7La3br0jWJJ2XhQ/Z9gSYW6bNjB4eSGqc+cFWgqwoeXn5eXlNGTIEB9TVVUViY4mPUwmK3TMr4ZaOv4nsHACZDgBangitLfH848t7VrQ/fOu1++U/FQUIM0Adw5wc/tul5BgjIsLDgsRBru60mzvw4QYHm87azsuePnuuxF5773f0e80tROhSYBlpWUmuvKjvNxG2e0ICXICZDgBangliJPk7f5f9rO9WiZA6u97sb2Bbm6bQtu2hRDedtupLsqVIg8EimWHRHehTk6b6LGanAbj4EvhBg8e7G0sNtaUlJbgFm6WoLhEUFosnwJDEmQBMpwAm9aHITjZ0t6bou0mS/jW+7rZ7ntYua+pfRjCwIEDvU2mKnNlZRUqKiqE6MpQUV6ByopKVFeZ5GFxjYAnQRhOgE3z47Cc7PjZ+5rai5mG3B/Mnmv+cM48omb2R5/UzBYt/fzB7HmWD2fPtYj7QfCVIAwnQI0E2Ng3qqm+EJQheOs2LTtS26pNy06t2rh1anUPtS07yUNyBevxSi4uToAsQPCrhYuLEyALkIuLixNgoxYgFxcXV7NNgFxcXFycALm4uLg4AXJxcXE1kgTIMAzTFPh/7ilJ+J+MkXkAAAAASUVORK5CYII=");background-repeat:no-repeat;background-color:transparent}#jstree-dnd.jstree-default i{background:transparent;width:24px;height:24px;line-height:24px}#jstree-dnd.jstree-default .jstree-ok{background-position:-4px -68px}#jstree-dnd.jstree-default .jstree-er{background-position:-36px -68px}.jstree-default .jstree-ellipsis{overflow:hidden}.jstree-default .jstree-ellipsis .jstree-anchor{width:calc(100% - 24px + 5px);text-overflow:ellipsis;overflow:hidden}.jstree-default.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAACAQMAAAB49I5GAAAABlBMVEUAAAAdHRvEkCwcAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjAAMOBgAAGAAJMwQHdQAAAABJRU5ErkJggg==")}.jstree-default.jstree-rtl .jstree-last{background-image:none}.jstree-default-small .jstree-node{min-height:18px;line-height:18px;margin-left:18px;min-width:18px}.jstree-default-small .jstree-anchor{line-height:18px;height:18px}.jstree-default-small .jstree-icon{width:18px;height:18px;line-height:18px}.jstree-default-small .jstree-icon:empty{width:18px;height:18px;line-height:18px}.jstree-default-small.jstree-rtl .jstree-node{margin-right:18px}.jstree-default-small .jstree-wholerow{height:18px}.jstree-default-small .jstree-node,.jstree-default-small .jstree-icon{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAYAAABsS6soAAAV40lEQVR42u2dCXQUVbrHKwsEHEWGYZkEVzZ1BEGQBHiAioqiPA++N4gkoKwiyBjGp+AIIjJHkGVgEFAgQSVJY4CQjSWsASGEfU06YctKks6eTkK2Trr/737VXbEJwW2q0jH5vnN+53aqO32rKt2//G/dqm4JgPRr4bLW/fd3BvfPxeW4199v8dctLmMBcnFx/V6LBcgJjBMgFydAFiAXFxcnQBYgJzBOgFycAFmAXFxcnABZgJzAOAFycQJkAXJxcXECZAFyAvsd9h8YGOhU3+3GUI1tfbSqpDPfoz7OHf6ylpM75iL36sYZnAC5uFSodevXISgoyKLT6Sy6oM1m0VYHbdbVBOno9maLuA9BdJ9OB/m2gH5H5f4VqD+zbX3MtnWoptubdWKZ9v3/ItTs315+5sqCn6ZcLxO1aVqDiMIhAmSsqPEfiPv/eegNnZySAmOxEUXGIhQVFaKQKCyC0VgolhejuFjcLqG2GAaDQZaAmv0Xi+cuLyuHsUj0L/rML8xHflEe8grzUGDMk9eJ1q9MPIYeq1b/VEr/NdXVP8mRxBhsuvwFtp7ZKvevlQBNhWkydPtOCZDQWoIOS4AM05BQ4srLzZdFl59fgPyCAhQJ2RQTJKbScllORE21SW7VF6ARZ9OOIvT6BpzN+AHnDcdwMSMW8VnHcT4rBhduHMP5GzE4Jx6jlQDlba+DIuYtpwPhf20eEioOINKwGh+um62NAG0JjwR4WyK03deQKdAhAlTzxaUGPXr0QHNKYMr+bywJUMv9T8fWxLDSnJWZibz8fDndEXl5NhGK5EWpj0SgyEBNARHB32+15Oflwz9hHnYWLsWewn/jbNk2XCgLx/mbYTh7czsOGb/GpcpIhF3bgLzcAojfUVWAe+MO4rPDs7DjQoi8/fYC1J34Fl8mvI/InBUISFmI4JSlWJXgizaz3IerKRtKd/aCqxVgHfFVFMTKNNkESH+Q4O+3oLHIz1ECdGAialb7XxekM2dmZsCQZUBaWhrS09ORlUUSzBUSyJdFWCAwKgIsVluAWyy5uXlYcWYmNmS8jYCcWYg0LkKUcRmiipdhd9FS7Cxagoj8xVh16u/IyctT7e9D9dlXn2PeqTEIMX6Ej2PexHf7gmoFuPW0DsvOz4R/ui+W6Cdg8aWJ+CJuEryDX4I0oWMvLQRIcqNW/tlOgIr4GkqADk2AtPMdnQTpjTd6jA+aYwJsTvtfpwuqyRACTE1LRUpKKlJT05CWfkNIMAs52dlChPny/iiwJSJjSZGq+2aLECBJbXa0DxYmjsKa9LewPmMK/DKnwS9rGjZkvgP/zL/hnwmj8OFBb+Tm5JIALWr07Tq5k+cbUU9iTtwz8D03AAuvvowZh0bg273in+CpQLwf8yreOdsHPke7460jfTA1xguvBg7B518tUV0+9gIk6iZCRYzNIgHSQVd60dFskyPffI4UoCMTYHPa/zTDmpGRiVQhP5oMSUpOkUWYlp6GLLGchoS5QlDykLC4WIsEiByRAP9vvzfmxr2EuQkv4dOEEZifOAKfJLwo5DQM00/1w/9GP4QJ4SPEY9UToDTeY+CQTQ9g1KEOGHmgHYbtc8FrMe3hHfk0Ju19DiOi70H/CAn9wyQ8FSrBc/2DiE08rckkCE1s2AtO+bm+9EdsWj666SZAZeaJXnwLFi6Bo958jSEB/tb2PxVg3f3fUP3faf9r1b9IgBZKeyQ9fYJecAXXk5JlGaaKITGRZchCdrb12JjRKCdAi5oCJMHO2j8ao6I98OaxnpgQ2xNvHXsc42MfEXLywNM7/oBBYXdhXNhw8dhcVYfAH636FH03dIJXuBBcmFV2Q3e2wKAIZ/QLkdBvq4S+gv5ruyI24VTtMVAtBEhiK72+r14B0nJ7tBZgs0yAyjGnunACbLr7n2SWJURPwouL1yM+Lh56/WUkXU8SaTDZOiwWEqRjhMrEgOoJMD8f40Kfw4BQN3iFtsSg8NZCeK0wKLQVPLe74CmBZ2gLeG9/Tp6sUVOAtC2hJ3bjL2v+hCeDJfTeLOEJnSBIQq9ACT0FvVbeh4PnY27Zfi3kl5P4DYou7pYFZ58IFenR/QpNOgE2hmNQzfi0kGa1/2k7KeHFxccjLs5KvBChXrQJCZeRnGSVYEpqmpyI6ZQVtQVI+9snYLS5q5+Ebn5O6LZRwiMbndDdXwIt6yrabv7OGLt9mPxYtQVIUlsfuQldl7fHo99I6L7Bhuj7saUP4cCZw/I+sG6/egJ0laTW1NLxPEWA9igSVH5OPfGvWpp0Amwss5DNVYDNaf/T9tIbW5GfPZQG4/XxSLEdFyS0EqD3ptHmbn4kHRdZgl1F293PWdx2hiJGeoxWAqTtXRO+EQ8u7oCuX7miy1pXdP/8QYQf3V277dbtV1GAdzl3JEiAlPDsBUfCo+WOEiCfB9iMBdjcttdegPG2Vh+nF6kwQW71cjrU3yIAta8E0e3VyYLzFklwnNy+bqZUSK28XBARs1PVE7EVAdJzKtsfdGAb+q3ohQErvLArdv8t8qP9pPSvmgBdXZ8l0SmJT7nigySnCNBefE0+ATKMI4b8ytUeZTdFe7MMN8usbVlZmXwFCB0XrRZocSWIMrSs72qMuldmqHkpniJARW4ETQjtOnUA0ReO1i6zhx6r5hC4rgDtcaQA+VpgplmgfBgADSvrwVJ3mfJhAGr3/xPrcEvfWvb/az4MQa0PLrEdB+xBQqsPToAMwzRKGqLuJEb+NBiGYZq8AB35eZQsQIZhmu1nd7IAGYbhBMgCZBiGEyALkGEYToAsQIZhAXICZAEyDAuQEyALkGFYgJwAWYCqfyYg98+wADkBMgzDAuQEyAmQ+2dYgJwAGYZhAXIC5ATI/TMsQE6ADMOwADkBcgLk/hkWICdAhmFYgJwAOQFy/42flG3vOBE3QqfLKD+zADkBMozqJG+cjN+Cmv2nbZv+I9tnmNNCZtYITOlWqtO2v2tJ2zbDojxG0/5/AUr/DVEfzJ4rfx3AgoVLMG7yLLklRo/x4e8E4QTI/ashgNLrsaguybmd4tuXVWTpVRUQCYWe11yZD1NBCqpuZsJUkonK4nRUltyAqdSA6nJal2yYKwrkx9LvqJXglP7pS59+ilOJ0Qi8vAih54Lk/hsqidH3jyjio2+tI/ERtIwTIMOoIEBTYaog7RasUiq4BRIBteoLMBtn044i4voGnM/4AZeyjiHOcBzxhlj59oUbR3E2/aj8GHqsFgKsu/32+2DL6UD4X5uHhIoDiDSshr//KNXlQ0KrD0V49gK0v79ZJMCG/q7aHj16gBPgj/07av83UAK0VGTGyW/4CoNeTniVWQmoIikW1SfDfLUFaKkqTIFf/FzsLFyCKONKnC0PwfmyCFwoj8SFigjsK/4SCaZd2H5trSxrtQUYrY/Csv0zcTh6jbz99hLUnfgWXya8j8icFQhIWYjglKVYleCLNrPch6stwPqK/unQV4KSAMPCbsgCpNI6BTaaBKh8HWBDvwEbiwQdTVPe/yl+U5ySv5liJgFWCOlVZMZbERKoyNajSgxJZREU3bCToMoCDJluqShIxspT72F95jQE5LyHSOPniCpeJrNbZil2GJdg6ckZqgsw3H8M5p0agxDjR/g45k0c/2F9rfxiozdg2fmZ8E/3xRL9BCy+NBFfxE3ClOBnIU3o2EsLATp7ht8GVUMLsFEkQOVLqx3xBqQd7GgJOjoBNvX9bxXgVFN5+gUhvXiUJZ9EOckwUy+nwcrsRJiEnEy2NGg9LpitsgBnmMvzr+Ef0T74LHEU1maMx7qsKfDLmgY/AzEdW/Pnivtege++v4r1UU+ArpM7efrs6Y05cc/A99wALLz6MmYcGoHYw+sQc3A93o95Fe+c7QOfo93x1pE+mBrjhdGBXojyH6vJELgxCdDhCZAOftKbjyKwo96AjUGCjqI57H8hQOeUb9+uLEs7h7LMS7iZdAI3k4+j/MZFVGRckqVYmS2SoSERVfmUitK1EWDeFcw56I1/xL2ITxKH49PLL2H+5RGYn/giPta/gGmn+mJkdAf4bB8mBJimXgIc7zFwWEBnjDrUASMPtMOwfS54LaY9vCOfxqS9z2FE9D3oHyGhf5iEp0IlDFrngdNXjmoyCcIJ0A7aWIPBUDsD5cg3oBpvQuW/yW9t1UqSv7RVe///2v7V3v8/IUCX5G+nVZannhHyO47ixP0ovXYQpUnHUJYi0mCGNRnKw2MhQvl4oFWAFrXO+UvfJgSYewUf7H8D/xN9PybE9sSkE70w8URPvHX8cfx3dEd4hbfEU2Eu8N7+nLwOag6BdV/9Ff3XdRB9SPAMs8pu6M4WGBThjH4hEvptldBXMHDtAzgbd1A+DNAcBNjsE2B9cAJsWvufEmDyt1OFAM+h9HoMiuP2wBi/F6VXhAivH0FZ6gmRBC8IEcbLQ2IaflYXG1QToHUShIbASRgf8RK8QlsJCbXCANF6hbWGZ6gQ33YXkb6cBS4YG6K+AOm5dpwKwxNr2uLJYAm9N0t4QicIktArUEJPQb9/u+PEhX21E0KcAJv4MUCmeex/WYDfTK0qv3FeJL8DKLoUhaKLUTDG7UbJtf3ysptJsSIRnrBOjAjoNJTkjVNUnQSpzE/BuIAxlu5+zujmJ8l09f+x7epnZWzIME0ESFIL37sCjyxvi0e/kdB9gw3RZ+9l9+PkmUi77ddWgHcqOiGaZ4GZZjEL3IACdErZOMVMEx9W+e2SKby4W7QCIcLSq/tRcv2YfLK0IgC1zwOkU258Al43d5MF6AS59be1fj8K0HvTaLNWAqTtDQ79At0W/xFdv3JFl7WueHzRfTh8OEDedvvt1+pE6DudC0goAqSRgP0yPg+QaZAk2HRPhJ5ioTc2Jb/kM8GCLUg6twVF8UKIl/YICe6xyXF37RUjWlwJoturE4J73ewTMNrsTQjZ+Wyi9nX5NhERs7P2GJyaAqTnLL2+TyZy7zp4rvgLnl7RF8diNtcmPwWtjgFSpaSkoi728iM+/XSPnP6UQzR8JQjDqHAlCF1mZq7Ik8/zk9vyPGsrqDHRZJBJsytB6p58fCeUS/HUFqCS7ojyzHgcPrMDJy/uu01+BD22IS+FI9mR9AgSoXKbltPohK8FZhgVPgyh/gv/Z9T7QQCN5cMImsOHIVDqrTsUVo7/UQrkBMgwDH8cFidAhmFYgJwAGYZhAXICZBiGBcgJkGEYFiAnQIZhWICcABmGYQFyAmQYhgXICZBhGBYgJ0CGYTgBcgJkGIYTIAuQYRhOgCxAhmE4AbIAGYbhBMgCZBgWICdAFiDDsAA5AbIAGYYFyAnw9yDAuvUvSWp3p53xqSS1UnPnMAwLkBNgo/kDRnXp4pu2YEHG7j//eVzdnXGkc+fxBYsX6w+1bTtSSwG6SlJrexpyX7je5dxx/vz5C+pjwIAB3vyGZzgBqizAX1Pt/n6f58pLsy70W95vimoraKvw1q3fy/7wQyAkBIVr1ph2d+zoo9wX7e7uU755swnJySjftq10v02CmshPSEg8dQ+CbjekBG2Su63Ky8phMBhAIuQ3PcMJ0AECvGtmh95+1z7OS6g4gEjDajy8sNs4tQS4VZJmxru4wNC2LYpeeAE1y5ahaNUqU1THjmP3CcpWrzYhMhIIDwdOnkTFli03D3XqNFILAZL46Kv+CFdX12dlETaQBOsTIH0LGq1LXFy8/DNLkOEEqIEA233w8PNvRrwc5jaxY5fbkp9vZ6+Vet/syJwVCEhZiOCUpViV4Is2s9yHq/EH/F6Svj4nVvWGIEtQ1L49qidPRtny5ahYtAhYuRJYvRrYuBHYsgXYswenHnlksRZDUJIeCYe+I7ahJVifAC2C4pJixAsBUktCZAkynABVFGCrtz0Gzjk5yhhi/Agf/DBWL/m0d1dW4g/TOz+x9Py7Of7pvliin4DFlybii7hJeG3r4CRpQsdeKvwBnUQCfGCzJIVcEqtrEOQKjALT4MGwzJ4Ny5w5wLx5wJIlMH/9NU737h1Cv6OlAIf/7bkGl+CdhsD0nbgkv7j4eDkJErROLACGE+B/KEDXyZ08R+/tWTon7hn4nhuAhVdfxtv7RuilN/7kce87Dz45K+aVnHfO9oHP0e5460gfTI3xwiD/HnrJu0MfFY8ByhIMlqRtcZJkyRZPmy8oFlQ++ihqpk4F3n0XVXPmWI737LmNHku/o7UA60pQ62OCNgFabkuBYkl1tQlGIUFaF5IhT4ownADVSIDjPQZ6BnQoGHWoA0YeaIdh+1zwWkx7eO8Yen3i3mezR0Tfg/4REvqHSXgqVEKXL1tek3zc+6o9CUIlUqDHTlfXSxlOTnISLLBJsKJLF+DttxE/YsQFeoxWs8D1CdBeglqnwIEDB/rUJ0DYLaQhMCVCFiDDCVCtY4DjPZ5/6EuXTK9wCZ5hVtkN3dkCgyKc0S9EQr+tEvoK7lvuJpJh5ydUXUF7AbZoMe703XeXJounTRcoSZCGw5WPPYb8adNK7E+RaXoCHOQNs6UGP1fChixAhhOgmrPAPp1fuX+la86TwRJ6b5bwhE4QJKFXoISeAvcvWlyVvB/op7qhbaUTa3CoZcsqvXjKREGSbVKEJJgnKKQk2LcvcidPrtrh7u7TUAJsyCHwkKFDfCxmS7WS+BSsN24NhixAhhOg2qfB+LgP77DINfvRbyR032DDT0K7z9wSJW+PPpqsICU/Z+exu5ycqk+IpzsjoMmQK0TLlrgmhsNZtsmRPDc33OzTB4axY6t3deo0pqlNggwdOtTHbDabYAbMNTUwi+GujLhdU10jD3+VDMgCZDgBanEe4HiPkX/8rEV2169c0WWtK+6d53ZFGnufp2aGpvTn5vbP3e3b44izM2LFU9IpMWeE7La3br0jWJJ2XhQ/Z9gSYW6bNjB4eSGqc+cFWgqwoeXn5eXlNGTIEB9TVVUViY4mPUwmK3TMr4ZaOv4nsHACZDgBangitLfH848t7VrQ/fOu1++U/FQUIM0Adw5wc/tul5BgjIsLDgsRBru60mzvw4QYHm87azsuePnuuxF5773f0e80tROhSYBlpWUmuvKjvNxG2e0ICXICZDgBangliJPk7f5f9rO9WiZA6u97sb2Bbm6bQtu2hRDedtupLsqVIg8EimWHRHehTk6b6LGanAbj4EvhBg8e7G0sNtaUlJbgFm6WoLhEUFosnwJDEmQBMpwAm9aHITjZ0t6bou0mS/jW+7rZ7ntYua+pfRjCwIEDvU2mKnNlZRUqKiqE6MpQUV6ByopKVFeZ5GFxjYAnQRhOgE3z47Cc7PjZ+5rai5mG3B/Mnmv+cM48omb2R5/UzBYt/fzB7HmWD2fPtYj7QfCVIAwnQI0E2Ng3qqm+EJQheOs2LTtS26pNy06t2rh1anUPtS07yUNyBevxSi4uToAsQPCrhYuLEyALkIuLixNgoxYgFxcXV7NNgFxcXFycALm4uLg4AXJxcXE1kgTIMAzTFPh/7ilJ+J+MkXkAAAAASUVORK5CYII=")}.jstree-default-small .jstree-node{background-position:-295px -7px;background-repeat:repeat-y}.jstree-default-small .jstree-last{background-image:none}.jstree-default-small .jstree-open>.jstree-ocl{background-position:-135px -7px}.jstree-default-small .jstree-closed>.jstree-ocl{background-position:-103px -7px}.jstree-default-small .jstree-leaf>.jstree-ocl{background-position:-71px -7px}.jstree-default-small .jstree-themeicon{background-position:-263px -7px}.jstree-default-small>.jstree-no-dots .jstree-node,.jstree-default-small>.jstree-no-dots .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-small>.jstree-no-dots .jstree-open>.jstree-ocl{background-position:-39px -7px}.jstree-default-small>.jstree-no-dots .jstree-closed>.jstree-ocl{background-position:-7px -7px}.jstree-default-small .jstree-disabled{background:transparent}.jstree-default-small .jstree-disabled.jstree-hovered{background:transparent}.jstree-default-small .jstree-disabled.jstree-clicked{background:#efefef}.jstree-default-small .jstree-checkbox{background-position:-167px -7px}.jstree-default-small .jstree-checkbox:hover{background-position:-167px -39px}.jstree-default-small.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox,.jstree-default-small .jstree-checked>.jstree-checkbox{background-position:-231px -7px}.jstree-default-small.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox:hover,.jstree-default-small .jstree-checked>.jstree-checkbox:hover{background-position:-231px -39px}.jstree-default-small .jstree-anchor>.jstree-undetermined{background-position:-199px -7px}.jstree-default-small .jstree-anchor>.jstree-undetermined:hover{background-position:-199px -39px}.jstree-default-small .jstree-checkbox-disabled{opacity:.8;filter:url("data:image/svg+xml;utf8,#jstree-grayscale");filter:gray;-webkit-filter:grayscale(100%)}.jstree-default-small>.jstree-striped{background-size:auto 36px}.jstree-default-small.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAACAQMAAAB49I5GAAAABlBMVEUAAAAdHRvEkCwcAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjAAMOBgAAGAAJMwQHdQAAAABJRU5ErkJggg==");background-position:100% 1px;background-repeat:repeat-y}.jstree-default-small.jstree-rtl .jstree-last{background-image:none}.jstree-default-small.jstree-rtl .jstree-open>.jstree-ocl{background-position:-135px -39px}.jstree-default-small.jstree-rtl .jstree-closed>.jstree-ocl{background-position:-103px -39px}.jstree-default-small.jstree-rtl .jstree-leaf>.jstree-ocl{background-position:-71px -39px}.jstree-default-small.jstree-rtl>.jstree-no-dots .jstree-node,.jstree-default-small.jstree-rtl>.jstree-no-dots .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-small.jstree-rtl>.jstree-no-dots .jstree-open>.jstree-ocl{background-position:-39px -39px}.jstree-default-small.jstree-rtl>.jstree-no-dots .jstree-closed>.jstree-ocl{background-position:-7px -39px}.jstree-default-small .jstree-themeicon-custom{background-color:transparent;background-image:none;background-position:0 0}.jstree-default-small>.jstree-container-ul .jstree-loading>.jstree-ocl{background:url("data:image/gif;base64,R0lGODlhEAAQAPMPAODg4Hp6egAAAFhYWL6+vhQUFJycnDY2NvDw8IqKikZGRiQkJKysrGhoaAQEBP///yH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQFCgAPACwAAAAAEAAQAEAEcPDJh2gbdcqkutETIoqKkCCCMwxA1koA8AAHwRhAIlMaICwIh6C1CyEYh6IkE0oUFEoEgKCcBWSGz4PAnAAWLcGQ15MlTMJYd1ZyUDXSDGelBY0qIkJg/ZoEFgYICToxDBRvIQMBD1kzgSAgBASQDxEAIfkEBQoADwAsAAAAAA8AEAAABF3wyflCk4hOJZcEBaNJB7I4wCIQo2QshSFw0xAjxWEJQpZJA8EBMCEQW7TWg9EIBFjKh2HQaECjH8PoN2EoBlvAL6FgIAwMgPoo1jQABPNVE9DGJXOMIXN/HJVqIxEAIfkEBQoADwAsAAAAABAADwAABFrwyflMolg2qRZCRyY5A9Ihg4hUAtMxE0BIwcGASpIcApAIPU0hFTMABbMJobFSCi4Sgs4AyHyujIBWxH3AupRGotk1BAgIAvqqkiQAcASAjDHM4A8594vPUyIAIfkEBQoADwAsAAAAABAAEAAABFzwySkNvTKgN5QcBPYcAec12CYVRBeiCCAljawEhuEhVqEGpIfqQViIHiWKrIbYGBgMUaNQcIByBtmlIegeKKELYAxQARKW44SQfYzVQgmC0BweCbIm3C23w/UYEQAh+QQFCgAIACwAAAAAEAAOAAAERRDJiUKgWA4pBM/c1iEFKAVeZ5DYUBCIcFheFU+DsGH1Su2YwwSAMPiCHUHJcsmUPkMMQZY5TqYdIkJrSma4FAJQAgZFAAAh+QQFCgAOACwAAAAAEAAQAAAEa9DJ6Qih2CEmU5ABkCEBlyROsogZ0AAnUKAUwYiJYQVHtSgSBCFBQEwQgIHjwJIAOBSEwmDUAK5VimEwUCSu2IxhsSg0ohjAwYBBNh1PCTAIMCKqBUHSUchmGAJKDlBoEwsCFyNpAmwZjn4RACH5BAUKAA8ALAAAAAAQABAAAARb8Mn5AKBYEmkMz9zFeIYCSgkyPgqDWcjDEJbRSMotAXTWFAMM4oJpuCaIJIjRaASTygxDcTgETpMBI4rdPBoxUKCxeCBuh1NBkHhceSDEmkiMOwQXxzE+OIQpEQAh+QQFCgAOACwBAAEADwAPAAAEVtBJIAmRTOpaL2nb5l3N5SCnBlAOEzjAkEgIgIbB8W73lpihICFAzAQ1n4HsSCsFa6zawrHbCASJhGI6U/gEgcXC4JiFAFdKAXE4MgSXwtqxAKo0g2MEACH5BAUKAA8ALAAAAAAQABAAAARd8Mn5EKJY3geAJBsGXB1nhBTidUjiYZtlEYyUGBlsNHiOGS8fBZAoCieAgLL2WRAwrqFCIOhNFIWExiE4eBYGRkPxMCwaEsPTdjjUesHJAtF+DBw+x/cgIec2SjkRACH5BAUKAA4ALAAAAQAQAA8AAARa0MnpEJKAamkl2Vr3bZkGlMYITkxCXFRJqU5T3A3I7MQh/AqQweBCnAwFmcSwcrwmiMaBKVnUEAsFw5EYOAcBCUNmGCgIhS1Mc3CYHYH2hmB1KII15SaRAEUAACH5BAUKAA8ALAAAAQAQAA8AAARY8MlJH6p4IlABx8BFCUJSiQjxEaTwTYBaBQLTidKiZw/hAwNHoRDI+BgfBEOBsVUGkpck0XA+Do+iYuAzNCQBg4QgETMCDQCWV2CiHwYmSN6AIoq8shgTAQAh+QQFCgAPACwAAAEADwAPAAAEWvBJUoC8+BKxspeDwHxS9wCC4AHIaRrjhbCY4RBZKyWHoiSeGQAQWBiBuaGlRRh4cLLAo+BhJKBOYCMwZBhOsNOkQEhIG5aHTn1oPMwPRmB9cb+ljy8pHsNEAAA7") center center no-repeat}.jstree-default-small .jstree-file{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAYAAABsS6soAAAV40lEQVR42u2dCXQUVbrHKwsEHEWGYZkEVzZ1BEGQBHiAioqiPA++N4gkoKwiyBjGp+AIIjJHkGVgEFAgQSVJY4CQjSWsASGEfU06YctKks6eTkK2Trr/737VXbEJwW2q0jH5vnN+53aqO32rKt2//G/dqm4JgPRr4bLW/fd3BvfPxeW4199v8dctLmMBcnFx/V6LBcgJjBMgFydAFiAXFxcnQBYgJzBOgFycAFmAXFxcnABZgJzAOAFycQJkAXJxcXECZAFyAvsd9h8YGOhU3+3GUI1tfbSqpDPfoz7OHf6ylpM75iL36sYZnAC5uFSodevXISgoyKLT6Sy6oM1m0VYHbdbVBOno9maLuA9BdJ9OB/m2gH5H5f4VqD+zbX3MtnWoptubdWKZ9v3/ItTs315+5sqCn6ZcLxO1aVqDiMIhAmSsqPEfiPv/eegNnZySAmOxEUXGIhQVFaKQKCyC0VgolhejuFjcLqG2GAaDQZaAmv0Xi+cuLyuHsUj0L/rML8xHflEe8grzUGDMk9eJ1q9MPIYeq1b/VEr/NdXVP8mRxBhsuvwFtp7ZKvevlQBNhWkydPtOCZDQWoIOS4AM05BQ4srLzZdFl59fgPyCAhQJ2RQTJKbScllORE21SW7VF6ARZ9OOIvT6BpzN+AHnDcdwMSMW8VnHcT4rBhduHMP5GzE4Jx6jlQDlba+DIuYtpwPhf20eEioOINKwGh+um62NAG0JjwR4WyK03deQKdAhAlTzxaUGPXr0QHNKYMr+bywJUMv9T8fWxLDSnJWZibz8fDndEXl5NhGK5EWpj0SgyEBNARHB32+15Oflwz9hHnYWLsWewn/jbNk2XCgLx/mbYTh7czsOGb/GpcpIhF3bgLzcAojfUVWAe+MO4rPDs7DjQoi8/fYC1J34Fl8mvI/InBUISFmI4JSlWJXgizaz3IerKRtKd/aCqxVgHfFVFMTKNNkESH+Q4O+3oLHIz1ECdGAialb7XxekM2dmZsCQZUBaWhrS09ORlUUSzBUSyJdFWCAwKgIsVluAWyy5uXlYcWYmNmS8jYCcWYg0LkKUcRmiipdhd9FS7Cxagoj8xVh16u/IyctT7e9D9dlXn2PeqTEIMX6Ej2PexHf7gmoFuPW0DsvOz4R/ui+W6Cdg8aWJ+CJuEryDX4I0oWMvLQRIcqNW/tlOgIr4GkqADk2AtPMdnQTpjTd6jA+aYwJsTvtfpwuqyRACTE1LRUpKKlJT05CWfkNIMAs52dlChPny/iiwJSJjSZGq+2aLECBJbXa0DxYmjsKa9LewPmMK/DKnwS9rGjZkvgP/zL/hnwmj8OFBb+Tm5JIALWr07Tq5k+cbUU9iTtwz8D03AAuvvowZh0bg273in+CpQLwf8yreOdsHPke7460jfTA1xguvBg7B518tUV0+9gIk6iZCRYzNIgHSQVd60dFskyPffI4UoCMTYHPa/zTDmpGRiVQhP5oMSUpOkUWYlp6GLLGchoS5QlDykLC4WIsEiByRAP9vvzfmxr2EuQkv4dOEEZifOAKfJLwo5DQM00/1w/9GP4QJ4SPEY9UToDTeY+CQTQ9g1KEOGHmgHYbtc8FrMe3hHfk0Ju19DiOi70H/CAn9wyQ8FSrBc/2DiE08rckkCE1s2AtO+bm+9EdsWj666SZAZeaJXnwLFi6Bo958jSEB/tb2PxVg3f3fUP3faf9r1b9IgBZKeyQ9fYJecAXXk5JlGaaKITGRZchCdrb12JjRKCdAi5oCJMHO2j8ao6I98OaxnpgQ2xNvHXsc42MfEXLywNM7/oBBYXdhXNhw8dhcVYfAH636FH03dIJXuBBcmFV2Q3e2wKAIZ/QLkdBvq4S+gv5ruyI24VTtMVAtBEhiK72+r14B0nJ7tBZgs0yAyjGnunACbLr7n2SWJURPwouL1yM+Lh56/WUkXU8SaTDZOiwWEqRjhMrEgOoJMD8f40Kfw4BQN3iFtsSg8NZCeK0wKLQVPLe74CmBZ2gLeG9/Tp6sUVOAtC2hJ3bjL2v+hCeDJfTeLOEJnSBIQq9ACT0FvVbeh4PnY27Zfi3kl5P4DYou7pYFZ58IFenR/QpNOgE2hmNQzfi0kGa1/2k7KeHFxccjLs5KvBChXrQJCZeRnGSVYEpqmpyI6ZQVtQVI+9snYLS5q5+Ebn5O6LZRwiMbndDdXwIt6yrabv7OGLt9mPxYtQVIUlsfuQldl7fHo99I6L7Bhuj7saUP4cCZw/I+sG6/egJ0laTW1NLxPEWA9igSVH5OPfGvWpp0Amwss5DNVYDNaf/T9tIbW5GfPZQG4/XxSLEdFyS0EqD3ptHmbn4kHRdZgl1F293PWdx2hiJGeoxWAqTtXRO+EQ8u7oCuX7miy1pXdP/8QYQf3V277dbtV1GAdzl3JEiAlPDsBUfCo+WOEiCfB9iMBdjcttdegPG2Vh+nF6kwQW71cjrU3yIAta8E0e3VyYLzFklwnNy+bqZUSK28XBARs1PVE7EVAdJzKtsfdGAb+q3ohQErvLArdv8t8qP9pPSvmgBdXZ8l0SmJT7nigySnCNBefE0+ATKMI4b8ytUeZTdFe7MMN8usbVlZmXwFCB0XrRZocSWIMrSs72qMuldmqHkpniJARW4ETQjtOnUA0ReO1i6zhx6r5hC4rgDtcaQA+VpgplmgfBgADSvrwVJ3mfJhAGr3/xPrcEvfWvb/az4MQa0PLrEdB+xBQqsPToAMwzRKGqLuJEb+NBiGYZq8AB35eZQsQIZhmu1nd7IAGYbhBMgCZBiGEyALkGEYToAsQIZhAXICZAEyDAuQEyALkGFYgJwAWYCqfyYg98+wADkBMgzDAuQEyAmQ+2dYgJwAGYZhAXIC5ATI/TMsQE6ADMOwADkBcgLk/hkWICdAhmFYgJwAOQFy/42flG3vOBE3QqfLKD+zADkBMozqJG+cjN+Cmv2nbZv+I9tnmNNCZtYITOlWqtO2v2tJ2zbDojxG0/5/AUr/DVEfzJ4rfx3AgoVLMG7yLLklRo/x4e8E4QTI/ashgNLrsaguybmd4tuXVWTpVRUQCYWe11yZD1NBCqpuZsJUkonK4nRUltyAqdSA6nJal2yYKwrkx9LvqJXglP7pS59+ilOJ0Qi8vAih54Lk/hsqidH3jyjio2+tI/ERtIwTIMOoIEBTYaog7RasUiq4BRIBteoLMBtn044i4voGnM/4AZeyjiHOcBzxhlj59oUbR3E2/aj8GHqsFgKsu/32+2DL6UD4X5uHhIoDiDSshr//KNXlQ0KrD0V49gK0v79ZJMCG/q7aHj16gBPgj/07av83UAK0VGTGyW/4CoNeTniVWQmoIikW1SfDfLUFaKkqTIFf/FzsLFyCKONKnC0PwfmyCFwoj8SFigjsK/4SCaZd2H5trSxrtQUYrY/Csv0zcTh6jbz99hLUnfgWXya8j8icFQhIWYjglKVYleCLNrPch6stwPqK/unQV4KSAMPCbsgCpNI6BTaaBKh8HWBDvwEbiwQdTVPe/yl+U5ySv5liJgFWCOlVZMZbERKoyNajSgxJZREU3bCToMoCDJluqShIxspT72F95jQE5LyHSOPniCpeJrNbZil2GJdg6ckZqgsw3H8M5p0agxDjR/g45k0c/2F9rfxiozdg2fmZ8E/3xRL9BCy+NBFfxE3ClOBnIU3o2EsLATp7ht8GVUMLsFEkQOVLqx3xBqQd7GgJOjoBNvX9bxXgVFN5+gUhvXiUJZ9EOckwUy+nwcrsRJiEnEy2NGg9LpitsgBnmMvzr+Ef0T74LHEU1maMx7qsKfDLmgY/AzEdW/Pnivtege++v4r1UU+ArpM7efrs6Y05cc/A99wALLz6MmYcGoHYw+sQc3A93o95Fe+c7QOfo93x1pE+mBrjhdGBXojyH6vJELgxCdDhCZAOftKbjyKwo96AjUGCjqI57H8hQOeUb9+uLEs7h7LMS7iZdAI3k4+j/MZFVGRckqVYmS2SoSERVfmUitK1EWDeFcw56I1/xL2ITxKH49PLL2H+5RGYn/giPta/gGmn+mJkdAf4bB8mBJimXgIc7zFwWEBnjDrUASMPtMOwfS54LaY9vCOfxqS9z2FE9D3oHyGhf5iEp0IlDFrngdNXjmoyCcIJ0A7aWIPBUDsD5cg3oBpvQuW/yW9t1UqSv7RVe///2v7V3v8/IUCX5G+nVZannhHyO47ixP0ovXYQpUnHUJYi0mCGNRnKw2MhQvl4oFWAFrXO+UvfJgSYewUf7H8D/xN9PybE9sSkE70w8URPvHX8cfx3dEd4hbfEU2Eu8N7+nLwOag6BdV/9Ff3XdRB9SPAMs8pu6M4WGBThjH4hEvptldBXMHDtAzgbd1A+DNAcBNjsE2B9cAJsWvufEmDyt1OFAM+h9HoMiuP2wBi/F6VXhAivH0FZ6gmRBC8IEcbLQ2IaflYXG1QToHUShIbASRgf8RK8QlsJCbXCANF6hbWGZ6gQ33YXkb6cBS4YG6K+AOm5dpwKwxNr2uLJYAm9N0t4QicIktArUEJPQb9/u+PEhX21E0KcAJv4MUCmeex/WYDfTK0qv3FeJL8DKLoUhaKLUTDG7UbJtf3ysptJsSIRnrBOjAjoNJTkjVNUnQSpzE/BuIAxlu5+zujmJ8l09f+x7epnZWzIME0ESFIL37sCjyxvi0e/kdB9gw3RZ+9l9+PkmUi77ddWgHcqOiGaZ4GZZjEL3IACdErZOMVMEx9W+e2SKby4W7QCIcLSq/tRcv2YfLK0IgC1zwOkU258Al43d5MF6AS59be1fj8K0HvTaLNWAqTtDQ79At0W/xFdv3JFl7WueHzRfTh8OEDedvvt1+pE6DudC0goAqSRgP0yPg+QaZAk2HRPhJ5ioTc2Jb/kM8GCLUg6twVF8UKIl/YICe6xyXF37RUjWlwJoturE4J73ewTMNrsTQjZ+Wyi9nX5NhERs7P2GJyaAqTnLL2+TyZy7zp4rvgLnl7RF8diNtcmPwWtjgFSpaSkoi728iM+/XSPnP6UQzR8JQjDqHAlCF1mZq7Ik8/zk9vyPGsrqDHRZJBJsytB6p58fCeUS/HUFqCS7ojyzHgcPrMDJy/uu01+BD22IS+FI9mR9AgSoXKbltPohK8FZhgVPgyh/gv/Z9T7QQCN5cMImsOHIVDqrTsUVo7/UQrkBMgwDH8cFidAhmFYgJwAGYZhAXICZBiGBcgJkGEYFiAnQIZhWICcABmGYQFyAmQYhgXICZBhGBYgJ0CGYTgBcgJkGIYTIAuQYRhOgCxAhmE4AbIAGYbhBMgCZBgWICdAFiDDsAA5AbIAGYYFyAnw9yDAuvUvSWp3p53xqSS1UnPnMAwLkBNgo/kDRnXp4pu2YEHG7j//eVzdnXGkc+fxBYsX6w+1bTtSSwG6SlJrexpyX7je5dxx/vz5C+pjwIAB3vyGZzgBqizAX1Pt/n6f58pLsy70W95vimoraKvw1q3fy/7wQyAkBIVr1ph2d+zoo9wX7e7uU755swnJySjftq10v02CmshPSEg8dQ+CbjekBG2Su63Ky8phMBhAIuQ3PcMJ0AECvGtmh95+1z7OS6g4gEjDajy8sNs4tQS4VZJmxru4wNC2LYpeeAE1y5ahaNUqU1THjmP3CcpWrzYhMhIIDwdOnkTFli03D3XqNFILAZL46Kv+CFdX12dlETaQBOsTIH0LGq1LXFy8/DNLkOEEqIEA233w8PNvRrwc5jaxY5fbkp9vZ6+Vet/syJwVCEhZiOCUpViV4Is2s9yHq/EH/F6Svj4nVvWGIEtQ1L49qidPRtny5ahYtAhYuRJYvRrYuBHYsgXYswenHnlksRZDUJIeCYe+I7ahJVifAC2C4pJixAsBUktCZAkynABVFGCrtz0Gzjk5yhhi/Agf/DBWL/m0d1dW4g/TOz+x9Py7Of7pvliin4DFlybii7hJeG3r4CRpQsdeKvwBnUQCfGCzJIVcEqtrEOQKjALT4MGwzJ4Ny5w5wLx5wJIlMH/9NU737h1Cv6OlAIf/7bkGl+CdhsD0nbgkv7j4eDkJErROLACGE+B/KEDXyZ08R+/tWTon7hn4nhuAhVdfxtv7RuilN/7kce87Dz45K+aVnHfO9oHP0e5460gfTI3xwiD/HnrJu0MfFY8ByhIMlqRtcZJkyRZPmy8oFlQ++ihqpk4F3n0XVXPmWI737LmNHku/o7UA60pQ62OCNgFabkuBYkl1tQlGIUFaF5IhT4ownADVSIDjPQZ6BnQoGHWoA0YeaIdh+1zwWkx7eO8Yen3i3mezR0Tfg/4REvqHSXgqVEKXL1tek3zc+6o9CUIlUqDHTlfXSxlOTnISLLBJsKJLF+DttxE/YsQFeoxWs8D1CdBeglqnwIEDB/rUJ0DYLaQhMCVCFiDDCVCtY4DjPZ5/6EuXTK9wCZ5hVtkN3dkCgyKc0S9EQr+tEvoK7lvuJpJh5ydUXUF7AbZoMe703XeXJounTRcoSZCGw5WPPYb8adNK7E+RaXoCHOQNs6UGP1fChixAhhOgmrPAPp1fuX+la86TwRJ6b5bwhE4QJKFXoISeAvcvWlyVvB/op7qhbaUTa3CoZcsqvXjKREGSbVKEJJgnKKQk2LcvcidPrtrh7u7TUAJsyCHwkKFDfCxmS7WS+BSsN24NhixAhhOg2qfB+LgP77DINfvRbyR032DDT0K7z9wSJW+PPpqsICU/Z+exu5ycqk+IpzsjoMmQK0TLlrgmhsNZtsmRPDc33OzTB4axY6t3deo0pqlNggwdOtTHbDabYAbMNTUwi+GujLhdU10jD3+VDMgCZDgBanEe4HiPkX/8rEV2169c0WWtK+6d53ZFGnufp2aGpvTn5vbP3e3b44izM2LFU9IpMWeE7La3br0jWJJ2XhQ/Z9gSYW6bNjB4eSGqc+cFWgqwoeXn5eXlNGTIEB9TVVUViY4mPUwmK3TMr4ZaOv4nsHACZDgBangitLfH848t7VrQ/fOu1++U/FQUIM0Adw5wc/tul5BgjIsLDgsRBru60mzvw4QYHm87azsuePnuuxF5773f0e80tROhSYBlpWUmuvKjvNxG2e0ICXICZDgBangliJPk7f5f9rO9WiZA6u97sb2Bbm6bQtu2hRDedtupLsqVIg8EimWHRHehTk6b6LGanAbj4EvhBg8e7G0sNtaUlJbgFm6WoLhEUFosnwJDEmQBMpwAm9aHITjZ0t6bou0mS/jW+7rZ7ntYua+pfRjCwIEDvU2mKnNlZRUqKiqE6MpQUV6ByopKVFeZ5GFxjYAnQRhOgE3z47Cc7PjZ+5rai5mG3B/Mnmv+cM48omb2R5/UzBYt/fzB7HmWD2fPtYj7QfCVIAwnQI0E2Ng3qqm+EJQheOs2LTtS26pNy06t2rh1anUPtS07yUNyBevxSi4uToAsQPCrhYuLEyALkIuLixNgoxYgFxcXV7NNgFxcXFycALm4uLg4AXJxcXE1kgTIMAzTFPh/7ilJ+J+MkXkAAAAASUVORK5CYII=") -103px -71px no-repeat}.jstree-default-small .jstree-folder{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAYAAABsS6soAAAV40lEQVR42u2dCXQUVbrHKwsEHEWGYZkEVzZ1BEGQBHiAioqiPA++N4gkoKwiyBjGp+AIIjJHkGVgEFAgQSVJY4CQjSWsASGEfU06YctKks6eTkK2Trr/737VXbEJwW2q0jH5vnN+53aqO32rKt2//G/dqm4JgPRr4bLW/fd3BvfPxeW4199v8dctLmMBcnFx/V6LBcgJjBMgFydAFiAXFxcnQBYgJzBOgFycAFmAXFxcnABZgJzAOAFycQJkAXJxcXECZAFyAvsd9h8YGOhU3+3GUI1tfbSqpDPfoz7OHf6ylpM75iL36sYZnAC5uFSodevXISgoyKLT6Sy6oM1m0VYHbdbVBOno9maLuA9BdJ9OB/m2gH5H5f4VqD+zbX3MtnWoptubdWKZ9v3/ItTs315+5sqCn6ZcLxO1aVqDiMIhAmSsqPEfiPv/eegNnZySAmOxEUXGIhQVFaKQKCyC0VgolhejuFjcLqG2GAaDQZaAmv0Xi+cuLyuHsUj0L/rML8xHflEe8grzUGDMk9eJ1q9MPIYeq1b/VEr/NdXVP8mRxBhsuvwFtp7ZKvevlQBNhWkydPtOCZDQWoIOS4AM05BQ4srLzZdFl59fgPyCAhQJ2RQTJKbScllORE21SW7VF6ARZ9OOIvT6BpzN+AHnDcdwMSMW8VnHcT4rBhduHMP5GzE4Jx6jlQDlba+DIuYtpwPhf20eEioOINKwGh+um62NAG0JjwR4WyK03deQKdAhAlTzxaUGPXr0QHNKYMr+bywJUMv9T8fWxLDSnJWZibz8fDndEXl5NhGK5EWpj0SgyEBNARHB32+15Oflwz9hHnYWLsWewn/jbNk2XCgLx/mbYTh7czsOGb/GpcpIhF3bgLzcAojfUVWAe+MO4rPDs7DjQoi8/fYC1J34Fl8mvI/InBUISFmI4JSlWJXgizaz3IerKRtKd/aCqxVgHfFVFMTKNNkESH+Q4O+3oLHIz1ECdGAialb7XxekM2dmZsCQZUBaWhrS09ORlUUSzBUSyJdFWCAwKgIsVluAWyy5uXlYcWYmNmS8jYCcWYg0LkKUcRmiipdhd9FS7Cxagoj8xVh16u/IyctT7e9D9dlXn2PeqTEIMX6Ej2PexHf7gmoFuPW0DsvOz4R/ui+W6Cdg8aWJ+CJuEryDX4I0oWMvLQRIcqNW/tlOgIr4GkqADk2AtPMdnQTpjTd6jA+aYwJsTvtfpwuqyRACTE1LRUpKKlJT05CWfkNIMAs52dlChPny/iiwJSJjSZGq+2aLECBJbXa0DxYmjsKa9LewPmMK/DKnwS9rGjZkvgP/zL/hnwmj8OFBb+Tm5JIALWr07Tq5k+cbUU9iTtwz8D03AAuvvowZh0bg273in+CpQLwf8yreOdsHPke7460jfTA1xguvBg7B518tUV0+9gIk6iZCRYzNIgHSQVd60dFskyPffI4UoCMTYHPa/zTDmpGRiVQhP5oMSUpOkUWYlp6GLLGchoS5QlDykLC4WIsEiByRAP9vvzfmxr2EuQkv4dOEEZifOAKfJLwo5DQM00/1w/9GP4QJ4SPEY9UToDTeY+CQTQ9g1KEOGHmgHYbtc8FrMe3hHfk0Ju19DiOi70H/CAn9wyQ8FSrBc/2DiE08rckkCE1s2AtO+bm+9EdsWj666SZAZeaJXnwLFi6Bo958jSEB/tb2PxVg3f3fUP3faf9r1b9IgBZKeyQ9fYJecAXXk5JlGaaKITGRZchCdrb12JjRKCdAi5oCJMHO2j8ao6I98OaxnpgQ2xNvHXsc42MfEXLywNM7/oBBYXdhXNhw8dhcVYfAH636FH03dIJXuBBcmFV2Q3e2wKAIZ/QLkdBvq4S+gv5ruyI24VTtMVAtBEhiK72+r14B0nJ7tBZgs0yAyjGnunACbLr7n2SWJURPwouL1yM+Lh56/WUkXU8SaTDZOiwWEqRjhMrEgOoJMD8f40Kfw4BQN3iFtsSg8NZCeK0wKLQVPLe74CmBZ2gLeG9/Tp6sUVOAtC2hJ3bjL2v+hCeDJfTeLOEJnSBIQq9ACT0FvVbeh4PnY27Zfi3kl5P4DYou7pYFZ58IFenR/QpNOgE2hmNQzfi0kGa1/2k7KeHFxccjLs5KvBChXrQJCZeRnGSVYEpqmpyI6ZQVtQVI+9snYLS5q5+Ebn5O6LZRwiMbndDdXwIt6yrabv7OGLt9mPxYtQVIUlsfuQldl7fHo99I6L7Bhuj7saUP4cCZw/I+sG6/egJ0laTW1NLxPEWA9igSVH5OPfGvWpp0Amwss5DNVYDNaf/T9tIbW5GfPZQG4/XxSLEdFyS0EqD3ptHmbn4kHRdZgl1F293PWdx2hiJGeoxWAqTtXRO+EQ8u7oCuX7miy1pXdP/8QYQf3V277dbtV1GAdzl3JEiAlPDsBUfCo+WOEiCfB9iMBdjcttdegPG2Vh+nF6kwQW71cjrU3yIAta8E0e3VyYLzFklwnNy+bqZUSK28XBARs1PVE7EVAdJzKtsfdGAb+q3ohQErvLArdv8t8qP9pPSvmgBdXZ8l0SmJT7nigySnCNBefE0+ATKMI4b8ytUeZTdFe7MMN8usbVlZmXwFCB0XrRZocSWIMrSs72qMuldmqHkpniJARW4ETQjtOnUA0ReO1i6zhx6r5hC4rgDtcaQA+VpgplmgfBgADSvrwVJ3mfJhAGr3/xPrcEvfWvb/az4MQa0PLrEdB+xBQqsPToAMwzRKGqLuJEb+NBiGYZq8AB35eZQsQIZhmu1nd7IAGYbhBMgCZBiGEyALkGEYToAsQIZhAXICZAEyDAuQEyALkGFYgJwAWYCqfyYg98+wADkBMgzDAuQEyAmQ+2dYgJwAGYZhAXIC5ATI/TMsQE6ADMOwADkBcgLk/hkWICdAhmFYgJwAOQFy/42flG3vOBE3QqfLKD+zADkBMozqJG+cjN+Cmv2nbZv+I9tnmNNCZtYITOlWqtO2v2tJ2zbDojxG0/5/AUr/DVEfzJ4rfx3AgoVLMG7yLLklRo/x4e8E4QTI/ashgNLrsaguybmd4tuXVWTpVRUQCYWe11yZD1NBCqpuZsJUkonK4nRUltyAqdSA6nJal2yYKwrkx9LvqJXglP7pS59+ilOJ0Qi8vAih54Lk/hsqidH3jyjio2+tI/ERtIwTIMOoIEBTYaog7RasUiq4BRIBteoLMBtn044i4voGnM/4AZeyjiHOcBzxhlj59oUbR3E2/aj8GHqsFgKsu/32+2DL6UD4X5uHhIoDiDSshr//KNXlQ0KrD0V49gK0v79ZJMCG/q7aHj16gBPgj/07av83UAK0VGTGyW/4CoNeTniVWQmoIikW1SfDfLUFaKkqTIFf/FzsLFyCKONKnC0PwfmyCFwoj8SFigjsK/4SCaZd2H5trSxrtQUYrY/Csv0zcTh6jbz99hLUnfgWXya8j8icFQhIWYjglKVYleCLNrPch6stwPqK/unQV4KSAMPCbsgCpNI6BTaaBKh8HWBDvwEbiwQdTVPe/yl+U5ySv5liJgFWCOlVZMZbERKoyNajSgxJZREU3bCToMoCDJluqShIxspT72F95jQE5LyHSOPniCpeJrNbZil2GJdg6ckZqgsw3H8M5p0agxDjR/g45k0c/2F9rfxiozdg2fmZ8E/3xRL9BCy+NBFfxE3ClOBnIU3o2EsLATp7ht8GVUMLsFEkQOVLqx3xBqQd7GgJOjoBNvX9bxXgVFN5+gUhvXiUJZ9EOckwUy+nwcrsRJiEnEy2NGg9LpitsgBnmMvzr+Ef0T74LHEU1maMx7qsKfDLmgY/AzEdW/Pnivtege++v4r1UU+ArpM7efrs6Y05cc/A99wALLz6MmYcGoHYw+sQc3A93o95Fe+c7QOfo93x1pE+mBrjhdGBXojyH6vJELgxCdDhCZAOftKbjyKwo96AjUGCjqI57H8hQOeUb9+uLEs7h7LMS7iZdAI3k4+j/MZFVGRckqVYmS2SoSERVfmUitK1EWDeFcw56I1/xL2ITxKH49PLL2H+5RGYn/giPta/gGmn+mJkdAf4bB8mBJimXgIc7zFwWEBnjDrUASMPtMOwfS54LaY9vCOfxqS9z2FE9D3oHyGhf5iEp0IlDFrngdNXjmoyCcIJ0A7aWIPBUDsD5cg3oBpvQuW/yW9t1UqSv7RVe///2v7V3v8/IUCX5G+nVZannhHyO47ixP0ovXYQpUnHUJYi0mCGNRnKw2MhQvl4oFWAFrXO+UvfJgSYewUf7H8D/xN9PybE9sSkE70w8URPvHX8cfx3dEd4hbfEU2Eu8N7+nLwOag6BdV/9Ff3XdRB9SPAMs8pu6M4WGBThjH4hEvptldBXMHDtAzgbd1A+DNAcBNjsE2B9cAJsWvufEmDyt1OFAM+h9HoMiuP2wBi/F6VXhAivH0FZ6gmRBC8IEcbLQ2IaflYXG1QToHUShIbASRgf8RK8QlsJCbXCANF6hbWGZ6gQ33YXkb6cBS4YG6K+AOm5dpwKwxNr2uLJYAm9N0t4QicIktArUEJPQb9/u+PEhX21E0KcAJv4MUCmeex/WYDfTK0qv3FeJL8DKLoUhaKLUTDG7UbJtf3ysptJsSIRnrBOjAjoNJTkjVNUnQSpzE/BuIAxlu5+zujmJ8l09f+x7epnZWzIME0ESFIL37sCjyxvi0e/kdB9gw3RZ+9l9+PkmUi77ddWgHcqOiGaZ4GZZjEL3IACdErZOMVMEx9W+e2SKby4W7QCIcLSq/tRcv2YfLK0IgC1zwOkU258Al43d5MF6AS59be1fj8K0HvTaLNWAqTtDQ79At0W/xFdv3JFl7WueHzRfTh8OEDedvvt1+pE6DudC0goAqSRgP0yPg+QaZAk2HRPhJ5ioTc2Jb/kM8GCLUg6twVF8UKIl/YICe6xyXF37RUjWlwJoturE4J73ewTMNrsTQjZ+Wyi9nX5NhERs7P2GJyaAqTnLL2+TyZy7zp4rvgLnl7RF8diNtcmPwWtjgFSpaSkoi728iM+/XSPnP6UQzR8JQjDqHAlCF1mZq7Ik8/zk9vyPGsrqDHRZJBJsytB6p58fCeUS/HUFqCS7ojyzHgcPrMDJy/uu01+BD22IS+FI9mR9AgSoXKbltPohK8FZhgVPgyh/gv/Z9T7QQCN5cMImsOHIVDqrTsUVo7/UQrkBMgwDH8cFidAhmFYgJwAGYZhAXICZBiGBcgJkGEYFiAnQIZhWICcABmGYQFyAmQYhgXICZBhGBYgJ0CGYTgBcgJkGIYTIAuQYRhOgCxAhmE4AbIAGYbhBMgCZBgWICdAFiDDsAA5AbIAGYYFyAnw9yDAuvUvSWp3p53xqSS1UnPnMAwLkBNgo/kDRnXp4pu2YEHG7j//eVzdnXGkc+fxBYsX6w+1bTtSSwG6SlJrexpyX7je5dxx/vz5C+pjwIAB3vyGZzgBqizAX1Pt/n6f58pLsy70W95vimoraKvw1q3fy/7wQyAkBIVr1ph2d+zoo9wX7e7uU755swnJySjftq10v02CmshPSEg8dQ+CbjekBG2Su63Ky8phMBhAIuQ3PcMJ0AECvGtmh95+1z7OS6g4gEjDajy8sNs4tQS4VZJmxru4wNC2LYpeeAE1y5ahaNUqU1THjmP3CcpWrzYhMhIIDwdOnkTFli03D3XqNFILAZL46Kv+CFdX12dlETaQBOsTIH0LGq1LXFy8/DNLkOEEqIEA233w8PNvRrwc5jaxY5fbkp9vZ6+Vet/syJwVCEhZiOCUpViV4Is2s9yHq/EH/F6Svj4nVvWGIEtQ1L49qidPRtny5ahYtAhYuRJYvRrYuBHYsgXYswenHnlksRZDUJIeCYe+I7ahJVifAC2C4pJixAsBUktCZAkynABVFGCrtz0Gzjk5yhhi/Agf/DBWL/m0d1dW4g/TOz+x9Py7Of7pvliin4DFlybii7hJeG3r4CRpQsdeKvwBnUQCfGCzJIVcEqtrEOQKjALT4MGwzJ4Ny5w5wLx5wJIlMH/9NU737h1Cv6OlAIf/7bkGl+CdhsD0nbgkv7j4eDkJErROLACGE+B/KEDXyZ08R+/tWTon7hn4nhuAhVdfxtv7RuilN/7kce87Dz45K+aVnHfO9oHP0e5460gfTI3xwiD/HnrJu0MfFY8ByhIMlqRtcZJkyRZPmy8oFlQ++ihqpk4F3n0XVXPmWI737LmNHku/o7UA60pQ62OCNgFabkuBYkl1tQlGIUFaF5IhT4ownADVSIDjPQZ6BnQoGHWoA0YeaIdh+1zwWkx7eO8Yen3i3mezR0Tfg/4REvqHSXgqVEKXL1tek3zc+6o9CUIlUqDHTlfXSxlOTnISLLBJsKJLF+DttxE/YsQFeoxWs8D1CdBeglqnwIEDB/rUJ0DYLaQhMCVCFiDDCVCtY4DjPZ5/6EuXTK9wCZ5hVtkN3dkCgyKc0S9EQr+tEvoK7lvuJpJh5ydUXUF7AbZoMe703XeXJounTRcoSZCGw5WPPYb8adNK7E+RaXoCHOQNs6UGP1fChixAhhOgmrPAPp1fuX+la86TwRJ6b5bwhE4QJKFXoISeAvcvWlyVvB/op7qhbaUTa3CoZcsqvXjKREGSbVKEJJgnKKQk2LcvcidPrtrh7u7TUAJsyCHwkKFDfCxmS7WS+BSsN24NhixAhhOg2qfB+LgP77DINfvRbyR032DDT0K7z9wSJW+PPpqsICU/Z+exu5ycqk+IpzsjoMmQK0TLlrgmhsNZtsmRPDc33OzTB4axY6t3deo0pqlNggwdOtTHbDabYAbMNTUwi+GujLhdU10jD3+VDMgCZDgBanEe4HiPkX/8rEV2169c0WWtK+6d53ZFGnufp2aGpvTn5vbP3e3b44izM2LFU9IpMWeE7La3br0jWJJ2XhQ/Z9gSYW6bNjB4eSGqc+cFWgqwoeXn5eXlNGTIEB9TVVUViY4mPUwmK3TMr4ZaOv4nsHACZDgBangitLfH848t7VrQ/fOu1++U/FQUIM0Adw5wc/tul5BgjIsLDgsRBru60mzvw4QYHm87azsuePnuuxF5773f0e80tROhSYBlpWUmuvKjvNxG2e0ICXICZDgBangliJPk7f5f9rO9WiZA6u97sb2Bbm6bQtu2hRDedtupLsqVIg8EimWHRHehTk6b6LGanAbj4EvhBg8e7G0sNtaUlJbgFm6WoLhEUFosnwJDEmQBMpwAm9aHITjZ0t6bou0mS/jW+7rZ7ntYua+pfRjCwIEDvU2mKnNlZRUqKiqE6MpQUV6ByopKVFeZ5GFxjYAnQRhOgE3z47Cc7PjZ+5rai5mG3B/Mnmv+cM48omb2R5/UzBYt/fzB7HmWD2fPtYj7QfCVIAwnQI0E2Ng3qqm+EJQheOs2LTtS26pNy06t2rh1anUPtS07yUNyBevxSi4uToAsQPCrhYuLEyALkIuLixNgoxYgFxcXV7NNgFxcXFycALm4uLg4AXJxcXE1kgTIMAzTFPh/7ilJ+J+MkXkAAAAASUVORK5CYII=") -263px -7px no-repeat}.jstree-default-small>.jstree-container-ul>.jstree-node{margin-left:0;margin-right:0}#jstree-dnd.jstree-default-small{line-height:18px;padding:0 4px}#jstree-dnd.jstree-default-small .jstree-ok,#jstree-dnd.jstree-default-small .jstree-er{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAYAAABsS6soAAAV40lEQVR42u2dCXQUVbrHKwsEHEWGYZkEVzZ1BEGQBHiAioqiPA++N4gkoKwiyBjGp+AIIjJHkGVgEFAgQSVJY4CQjSWsASGEfU06YctKks6eTkK2Trr/737VXbEJwW2q0jH5vnN+53aqO32rKt2//G/dqm4JgPRr4bLW/fd3BvfPxeW4199v8dctLmMBcnFx/V6LBcgJjBMgFydAFiAXFxcnQBYgJzBOgFycAFmAXFxcnABZgJzAOAFycQJkAXJxcXECZAFyAvsd9h8YGOhU3+3GUI1tfbSqpDPfoz7OHf6ylpM75iL36sYZnAC5uFSodevXISgoyKLT6Sy6oM1m0VYHbdbVBOno9maLuA9BdJ9OB/m2gH5H5f4VqD+zbX3MtnWoptubdWKZ9v3/ItTs315+5sqCn6ZcLxO1aVqDiMIhAmSsqPEfiPv/eegNnZySAmOxEUXGIhQVFaKQKCyC0VgolhejuFjcLqG2GAaDQZaAmv0Xi+cuLyuHsUj0L/rML8xHflEe8grzUGDMk9eJ1q9MPIYeq1b/VEr/NdXVP8mRxBhsuvwFtp7ZKvevlQBNhWkydPtOCZDQWoIOS4AM05BQ4srLzZdFl59fgPyCAhQJ2RQTJKbScllORE21SW7VF6ARZ9OOIvT6BpzN+AHnDcdwMSMW8VnHcT4rBhduHMP5GzE4Jx6jlQDlba+DIuYtpwPhf20eEioOINKwGh+um62NAG0JjwR4WyK03deQKdAhAlTzxaUGPXr0QHNKYMr+bywJUMv9T8fWxLDSnJWZibz8fDndEXl5NhGK5EWpj0SgyEBNARHB32+15Oflwz9hHnYWLsWewn/jbNk2XCgLx/mbYTh7czsOGb/GpcpIhF3bgLzcAojfUVWAe+MO4rPDs7DjQoi8/fYC1J34Fl8mvI/InBUISFmI4JSlWJXgizaz3IerKRtKd/aCqxVgHfFVFMTKNNkESH+Q4O+3oLHIz1ECdGAialb7XxekM2dmZsCQZUBaWhrS09ORlUUSzBUSyJdFWCAwKgIsVluAWyy5uXlYcWYmNmS8jYCcWYg0LkKUcRmiipdhd9FS7Cxagoj8xVh16u/IyctT7e9D9dlXn2PeqTEIMX6Ej2PexHf7gmoFuPW0DsvOz4R/ui+W6Cdg8aWJ+CJuEryDX4I0oWMvLQRIcqNW/tlOgIr4GkqADk2AtPMdnQTpjTd6jA+aYwJsTvtfpwuqyRACTE1LRUpKKlJT05CWfkNIMAs52dlChPny/iiwJSJjSZGq+2aLECBJbXa0DxYmjsKa9LewPmMK/DKnwS9rGjZkvgP/zL/hnwmj8OFBb+Tm5JIALWr07Tq5k+cbUU9iTtwz8D03AAuvvowZh0bg273in+CpQLwf8yreOdsHPke7460jfTA1xguvBg7B518tUV0+9gIk6iZCRYzNIgHSQVd60dFskyPffI4UoCMTYHPa/zTDmpGRiVQhP5oMSUpOkUWYlp6GLLGchoS5QlDykLC4WIsEiByRAP9vvzfmxr2EuQkv4dOEEZifOAKfJLwo5DQM00/1w/9GP4QJ4SPEY9UToDTeY+CQTQ9g1KEOGHmgHYbtc8FrMe3hHfk0Ju19DiOi70H/CAn9wyQ8FSrBc/2DiE08rckkCE1s2AtO+bm+9EdsWj666SZAZeaJXnwLFi6Bo958jSEB/tb2PxVg3f3fUP3faf9r1b9IgBZKeyQ9fYJecAXXk5JlGaaKITGRZchCdrb12JjRKCdAi5oCJMHO2j8ao6I98OaxnpgQ2xNvHXsc42MfEXLywNM7/oBBYXdhXNhw8dhcVYfAH636FH03dIJXuBBcmFV2Q3e2wKAIZ/QLkdBvq4S+gv5ruyI24VTtMVAtBEhiK72+r14B0nJ7tBZgs0yAyjGnunACbLr7n2SWJURPwouL1yM+Lh56/WUkXU8SaTDZOiwWEqRjhMrEgOoJMD8f40Kfw4BQN3iFtsSg8NZCeK0wKLQVPLe74CmBZ2gLeG9/Tp6sUVOAtC2hJ3bjL2v+hCeDJfTeLOEJnSBIQq9ACT0FvVbeh4PnY27Zfi3kl5P4DYou7pYFZ58IFenR/QpNOgE2hmNQzfi0kGa1/2k7KeHFxccjLs5KvBChXrQJCZeRnGSVYEpqmpyI6ZQVtQVI+9snYLS5q5+Ebn5O6LZRwiMbndDdXwIt6yrabv7OGLt9mPxYtQVIUlsfuQldl7fHo99I6L7Bhuj7saUP4cCZw/I+sG6/egJ0laTW1NLxPEWA9igSVH5OPfGvWpp0Amwss5DNVYDNaf/T9tIbW5GfPZQG4/XxSLEdFyS0EqD3ptHmbn4kHRdZgl1F293PWdx2hiJGeoxWAqTtXRO+EQ8u7oCuX7miy1pXdP/8QYQf3V277dbtV1GAdzl3JEiAlPDsBUfCo+WOEiCfB9iMBdjcttdegPG2Vh+nF6kwQW71cjrU3yIAta8E0e3VyYLzFklwnNy+bqZUSK28XBARs1PVE7EVAdJzKtsfdGAb+q3ohQErvLArdv8t8qP9pPSvmgBdXZ8l0SmJT7nigySnCNBefE0+ATKMI4b8ytUeZTdFe7MMN8usbVlZmXwFCB0XrRZocSWIMrSs72qMuldmqHkpniJARW4ETQjtOnUA0ReO1i6zhx6r5hC4rgDtcaQA+VpgplmgfBgADSvrwVJ3mfJhAGr3/xPrcEvfWvb/az4MQa0PLrEdB+xBQqsPToAMwzRKGqLuJEb+NBiGYZq8AB35eZQsQIZhmu1nd7IAGYbhBMgCZBiGEyALkGEYToAsQIZhAXICZAEyDAuQEyALkGFYgJwAWYCqfyYg98+wADkBMgzDAuQEyAmQ+2dYgJwAGYZhAXIC5ATI/TMsQE6ADMOwADkBcgLk/hkWICdAhmFYgJwAOQFy/42flG3vOBE3QqfLKD+zADkBMozqJG+cjN+Cmv2nbZv+I9tnmNNCZtYITOlWqtO2v2tJ2zbDojxG0/5/AUr/DVEfzJ4rfx3AgoVLMG7yLLklRo/x4e8E4QTI/ashgNLrsaguybmd4tuXVWTpVRUQCYWe11yZD1NBCqpuZsJUkonK4nRUltyAqdSA6nJal2yYKwrkx9LvqJXglP7pS59+ilOJ0Qi8vAih54Lk/hsqidH3jyjio2+tI/ERtIwTIMOoIEBTYaog7RasUiq4BRIBteoLMBtn044i4voGnM/4AZeyjiHOcBzxhlj59oUbR3E2/aj8GHqsFgKsu/32+2DL6UD4X5uHhIoDiDSshr//KNXlQ0KrD0V49gK0v79ZJMCG/q7aHj16gBPgj/07av83UAK0VGTGyW/4CoNeTniVWQmoIikW1SfDfLUFaKkqTIFf/FzsLFyCKONKnC0PwfmyCFwoj8SFigjsK/4SCaZd2H5trSxrtQUYrY/Csv0zcTh6jbz99hLUnfgWXya8j8icFQhIWYjglKVYleCLNrPch6stwPqK/unQV4KSAMPCbsgCpNI6BTaaBKh8HWBDvwEbiwQdTVPe/yl+U5ySv5liJgFWCOlVZMZbERKoyNajSgxJZREU3bCToMoCDJluqShIxspT72F95jQE5LyHSOPniCpeJrNbZil2GJdg6ckZqgsw3H8M5p0agxDjR/g45k0c/2F9rfxiozdg2fmZ8E/3xRL9BCy+NBFfxE3ClOBnIU3o2EsLATp7ht8GVUMLsFEkQOVLqx3xBqQd7GgJOjoBNvX9bxXgVFN5+gUhvXiUJZ9EOckwUy+nwcrsRJiEnEy2NGg9LpitsgBnmMvzr+Ef0T74LHEU1maMx7qsKfDLmgY/AzEdW/Pnivtege++v4r1UU+ArpM7efrs6Y05cc/A99wALLz6MmYcGoHYw+sQc3A93o95Fe+c7QOfo93x1pE+mBrjhdGBXojyH6vJELgxCdDhCZAOftKbjyKwo96AjUGCjqI57H8hQOeUb9+uLEs7h7LMS7iZdAI3k4+j/MZFVGRckqVYmS2SoSERVfmUitK1EWDeFcw56I1/xL2ITxKH49PLL2H+5RGYn/giPta/gGmn+mJkdAf4bB8mBJimXgIc7zFwWEBnjDrUASMPtMOwfS54LaY9vCOfxqS9z2FE9D3oHyGhf5iEp0IlDFrngdNXjmoyCcIJ0A7aWIPBUDsD5cg3oBpvQuW/yW9t1UqSv7RVe///2v7V3v8/IUCX5G+nVZannhHyO47ixP0ovXYQpUnHUJYi0mCGNRnKw2MhQvl4oFWAFrXO+UvfJgSYewUf7H8D/xN9PybE9sSkE70w8URPvHX8cfx3dEd4hbfEU2Eu8N7+nLwOag6BdV/9Ff3XdRB9SPAMs8pu6M4WGBThjH4hEvptldBXMHDtAzgbd1A+DNAcBNjsE2B9cAJsWvufEmDyt1OFAM+h9HoMiuP2wBi/F6VXhAivH0FZ6gmRBC8IEcbLQ2IaflYXG1QToHUShIbASRgf8RK8QlsJCbXCANF6hbWGZ6gQ33YXkb6cBS4YG6K+AOm5dpwKwxNr2uLJYAm9N0t4QicIktArUEJPQb9/u+PEhX21E0KcAJv4MUCmeex/WYDfTK0qv3FeJL8DKLoUhaKLUTDG7UbJtf3ysptJsSIRnrBOjAjoNJTkjVNUnQSpzE/BuIAxlu5+zujmJ8l09f+x7epnZWzIME0ESFIL37sCjyxvi0e/kdB9gw3RZ+9l9+PkmUi77ddWgHcqOiGaZ4GZZjEL3IACdErZOMVMEx9W+e2SKby4W7QCIcLSq/tRcv2YfLK0IgC1zwOkU258Al43d5MF6AS59be1fj8K0HvTaLNWAqTtDQ79At0W/xFdv3JFl7WueHzRfTh8OEDedvvt1+pE6DudC0goAqSRgP0yPg+QaZAk2HRPhJ5ioTc2Jb/kM8GCLUg6twVF8UKIl/YICe6xyXF37RUjWlwJoturE4J73ewTMNrsTQjZ+Wyi9nX5NhERs7P2GJyaAqTnLL2+TyZy7zp4rvgLnl7RF8diNtcmPwWtjgFSpaSkoi728iM+/XSPnP6UQzR8JQjDqHAlCF1mZq7Ik8/zk9vyPGsrqDHRZJBJsytB6p58fCeUS/HUFqCS7ojyzHgcPrMDJy/uu01+BD22IS+FI9mR9AgSoXKbltPohK8FZhgVPgyh/gv/Z9T7QQCN5cMImsOHIVDqrTsUVo7/UQrkBMgwDH8cFidAhmFYgJwAGYZhAXICZBiGBcgJkGEYFiAnQIZhWICcABmGYQFyAmQYhgXICZBhGBYgJ0CGYTgBcgJkGIYTIAuQYRhOgCxAhmE4AbIAGYbhBMgCZBgWICdAFiDDsAA5AbIAGYYFyAnw9yDAuvUvSWp3p53xqSS1UnPnMAwLkBNgo/kDRnXp4pu2YEHG7j//eVzdnXGkc+fxBYsX6w+1bTtSSwG6SlJrexpyX7je5dxx/vz5C+pjwIAB3vyGZzgBqizAX1Pt/n6f58pLsy70W95vimoraKvw1q3fy/7wQyAkBIVr1ph2d+zoo9wX7e7uU755swnJySjftq10v02CmshPSEg8dQ+CbjekBG2Su63Ky8phMBhAIuQ3PcMJ0AECvGtmh95+1z7OS6g4gEjDajy8sNs4tQS4VZJmxru4wNC2LYpeeAE1y5ahaNUqU1THjmP3CcpWrzYhMhIIDwdOnkTFli03D3XqNFILAZL46Kv+CFdX12dlETaQBOsTIH0LGq1LXFy8/DNLkOEEqIEA233w8PNvRrwc5jaxY5fbkp9vZ6+Vet/syJwVCEhZiOCUpViV4Is2s9yHq/EH/F6Svj4nVvWGIEtQ1L49qidPRtny5ahYtAhYuRJYvRrYuBHYsgXYswenHnlksRZDUJIeCYe+I7ahJVifAC2C4pJixAsBUktCZAkynABVFGCrtz0Gzjk5yhhi/Agf/DBWL/m0d1dW4g/TOz+x9Py7Of7pvliin4DFlybii7hJeG3r4CRpQsdeKvwBnUQCfGCzJIVcEqtrEOQKjALT4MGwzJ4Ny5w5wLx5wJIlMH/9NU737h1Cv6OlAIf/7bkGl+CdhsD0nbgkv7j4eDkJErROLACGE+B/KEDXyZ08R+/tWTon7hn4nhuAhVdfxtv7RuilN/7kce87Dz45K+aVnHfO9oHP0e5460gfTI3xwiD/HnrJu0MfFY8ByhIMlqRtcZJkyRZPmy8oFlQ++ihqpk4F3n0XVXPmWI737LmNHku/o7UA60pQ62OCNgFabkuBYkl1tQlGIUFaF5IhT4ownADVSIDjPQZ6BnQoGHWoA0YeaIdh+1zwWkx7eO8Yen3i3mezR0Tfg/4REvqHSXgqVEKXL1tek3zc+6o9CUIlUqDHTlfXSxlOTnISLLBJsKJLF+DttxE/YsQFeoxWs8D1CdBeglqnwIEDB/rUJ0DYLaQhMCVCFiDDCVCtY4DjPZ5/6EuXTK9wCZ5hVtkN3dkCgyKc0S9EQr+tEvoK7lvuJpJh5ydUXUF7AbZoMe703XeXJounTRcoSZCGw5WPPYb8adNK7E+RaXoCHOQNs6UGP1fChixAhhOgmrPAPp1fuX+la86TwRJ6b5bwhE4QJKFXoISeAvcvWlyVvB/op7qhbaUTa3CoZcsqvXjKREGSbVKEJJgnKKQk2LcvcidPrtrh7u7TUAJsyCHwkKFDfCxmS7WS+BSsN24NhixAhhOg2qfB+LgP77DINfvRbyR032DDT0K7z9wSJW+PPpqsICU/Z+exu5ycqk+IpzsjoMmQK0TLlrgmhsNZtsmRPDc33OzTB4axY6t3deo0pqlNggwdOtTHbDabYAbMNTUwi+GujLhdU10jD3+VDMgCZDgBanEe4HiPkX/8rEV2169c0WWtK+6d53ZFGnufp2aGpvTn5vbP3e3b44izM2LFU9IpMWeE7La3br0jWJJ2XhQ/Z9gSYW6bNjB4eSGqc+cFWgqwoeXn5eXlNGTIEB9TVVUViY4mPUwmK3TMr4ZaOv4nsHACZDgBangitLfH848t7VrQ/fOu1++U/FQUIM0Adw5wc/tul5BgjIsLDgsRBru60mzvw4QYHm87azsuePnuuxF5773f0e80tROhSYBlpWUmuvKjvNxG2e0ICXICZDgBangliJPk7f5f9rO9WiZA6u97sb2Bbm6bQtu2hRDedtupLsqVIg8EimWHRHehTk6b6LGanAbj4EvhBg8e7G0sNtaUlJbgFm6WoLhEUFosnwJDEmQBMpwAm9aHITjZ0t6bou0mS/jW+7rZ7ntYua+pfRjCwIEDvU2mKnNlZRUqKiqE6MpQUV6ByopKVFeZ5GFxjYAnQRhOgE3z47Cc7PjZ+5rai5mG3B/Mnmv+cM48omb2R5/UzBYt/fzB7HmWD2fPtYj7QfCVIAwnQI0E2Ng3qqm+EJQheOs2LTtS26pNy06t2rh1anUPtS07yUNyBevxSi4uToAsQPCrhYuLEyALkIuLixNgoxYgFxcXV7NNgFxcXFycALm4uLg4AXJxcXE1kgTIMAzTFPh/7ilJ+J+MkXkAAAAASUVORK5CYII=");background-repeat:no-repeat;background-color:transparent}#jstree-dnd.jstree-default-small i{background:transparent;width:18px;height:18px;line-height:18px}#jstree-dnd.jstree-default-small .jstree-ok{background-position:-7px -71px}#jstree-dnd.jstree-default-small .jstree-er{background-position:-39px -71px}.jstree-default-small .jstree-ellipsis{overflow:hidden}.jstree-default-small .jstree-ellipsis .jstree-anchor{width:calc(100% - 18px + 5px);text-overflow:ellipsis;overflow:hidden}.jstree-default-small.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABIAAAACAQMAAABv1h6PAAAABlBMVEUAAAAdHRvEkCwcAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjAAMHBgAAiABBI4gz9AAAAABJRU5ErkJggg==")}.jstree-default-small.jstree-rtl .jstree-last{background-image:none}.jstree-default-large .jstree-node{min-height:32px;line-height:32px;margin-left:32px;min-width:32px}.jstree-default-large .jstree-anchor{line-height:32px;height:32px}.jstree-default-large .jstree-icon{width:32px;height:32px;line-height:32px}.jstree-default-large .jstree-icon:empty{width:32px;height:32px;line-height:32px}.jstree-default-large.jstree-rtl .jstree-node{margin-right:32px}.jstree-default-large .jstree-wholerow{height:32px}.jstree-default-large .jstree-node,.jstree-default-large .jstree-icon{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAYAAABsS6soAAAV40lEQVR42u2dCXQUVbrHKwsEHEWGYZkEVzZ1BEGQBHiAioqiPA++N4gkoKwiyBjGp+AIIjJHkGVgEFAgQSVJY4CQjSWsASGEfU06YctKks6eTkK2Trr/737VXbEJwW2q0jH5vnN+53aqO32rKt2//G/dqm4JgPRr4bLW/fd3BvfPxeW4199v8dctLmMBcnFx/V6LBcgJjBMgFydAFiAXFxcnQBYgJzBOgFycAFmAXFxcnABZgJzAOAFycQJkAXJxcXECZAFyAvsd9h8YGOhU3+3GUI1tfbSqpDPfoz7OHf6ylpM75iL36sYZnAC5uFSodevXISgoyKLT6Sy6oM1m0VYHbdbVBOno9maLuA9BdJ9OB/m2gH5H5f4VqD+zbX3MtnWoptubdWKZ9v3/ItTs315+5sqCn6ZcLxO1aVqDiMIhAmSsqPEfiPv/eegNnZySAmOxEUXGIhQVFaKQKCyC0VgolhejuFjcLqG2GAaDQZaAmv0Xi+cuLyuHsUj0L/rML8xHflEe8grzUGDMk9eJ1q9MPIYeq1b/VEr/NdXVP8mRxBhsuvwFtp7ZKvevlQBNhWkydPtOCZDQWoIOS4AM05BQ4srLzZdFl59fgPyCAhQJ2RQTJKbScllORE21SW7VF6ARZ9OOIvT6BpzN+AHnDcdwMSMW8VnHcT4rBhduHMP5GzE4Jx6jlQDlba+DIuYtpwPhf20eEioOINKwGh+um62NAG0JjwR4WyK03deQKdAhAlTzxaUGPXr0QHNKYMr+bywJUMv9T8fWxLDSnJWZibz8fDndEXl5NhGK5EWpj0SgyEBNARHB32+15Oflwz9hHnYWLsWewn/jbNk2XCgLx/mbYTh7czsOGb/GpcpIhF3bgLzcAojfUVWAe+MO4rPDs7DjQoi8/fYC1J34Fl8mvI/InBUISFmI4JSlWJXgizaz3IerKRtKd/aCqxVgHfFVFMTKNNkESH+Q4O+3oLHIz1ECdGAialb7XxekM2dmZsCQZUBaWhrS09ORlUUSzBUSyJdFWCAwKgIsVluAWyy5uXlYcWYmNmS8jYCcWYg0LkKUcRmiipdhd9FS7Cxagoj8xVh16u/IyctT7e9D9dlXn2PeqTEIMX6Ej2PexHf7gmoFuPW0DsvOz4R/ui+W6Cdg8aWJ+CJuEryDX4I0oWMvLQRIcqNW/tlOgIr4GkqADk2AtPMdnQTpjTd6jA+aYwJsTvtfpwuqyRACTE1LRUpKKlJT05CWfkNIMAs52dlChPny/iiwJSJjSZGq+2aLECBJbXa0DxYmjsKa9LewPmMK/DKnwS9rGjZkvgP/zL/hnwmj8OFBb+Tm5JIALWr07Tq5k+cbUU9iTtwz8D03AAuvvowZh0bg273in+CpQLwf8yreOdsHPke7460jfTA1xguvBg7B518tUV0+9gIk6iZCRYzNIgHSQVd60dFskyPffI4UoCMTYHPa/zTDmpGRiVQhP5oMSUpOkUWYlp6GLLGchoS5QlDykLC4WIsEiByRAP9vvzfmxr2EuQkv4dOEEZifOAKfJLwo5DQM00/1w/9GP4QJ4SPEY9UToDTeY+CQTQ9g1KEOGHmgHYbtc8FrMe3hHfk0Ju19DiOi70H/CAn9wyQ8FSrBc/2DiE08rckkCE1s2AtO+bm+9EdsWj666SZAZeaJXnwLFi6Bo958jSEB/tb2PxVg3f3fUP3faf9r1b9IgBZKeyQ9fYJecAXXk5JlGaaKITGRZchCdrb12JjRKCdAi5oCJMHO2j8ao6I98OaxnpgQ2xNvHXsc42MfEXLywNM7/oBBYXdhXNhw8dhcVYfAH636FH03dIJXuBBcmFV2Q3e2wKAIZ/QLkdBvq4S+gv5ruyI24VTtMVAtBEhiK72+r14B0nJ7tBZgs0yAyjGnunACbLr7n2SWJURPwouL1yM+Lh56/WUkXU8SaTDZOiwWEqRjhMrEgOoJMD8f40Kfw4BQN3iFtsSg8NZCeK0wKLQVPLe74CmBZ2gLeG9/Tp6sUVOAtC2hJ3bjL2v+hCeDJfTeLOEJnSBIQq9ACT0FvVbeh4PnY27Zfi3kl5P4DYou7pYFZ58IFenR/QpNOgE2hmNQzfi0kGa1/2k7KeHFxccjLs5KvBChXrQJCZeRnGSVYEpqmpyI6ZQVtQVI+9snYLS5q5+Ebn5O6LZRwiMbndDdXwIt6yrabv7OGLt9mPxYtQVIUlsfuQldl7fHo99I6L7Bhuj7saUP4cCZw/I+sG6/egJ0laTW1NLxPEWA9igSVH5OPfGvWpp0Amwss5DNVYDNaf/T9tIbW5GfPZQG4/XxSLEdFyS0EqD3ptHmbn4kHRdZgl1F293PWdx2hiJGeoxWAqTtXRO+EQ8u7oCuX7miy1pXdP/8QYQf3V277dbtV1GAdzl3JEiAlPDsBUfCo+WOEiCfB9iMBdjcttdegPG2Vh+nF6kwQW71cjrU3yIAta8E0e3VyYLzFklwnNy+bqZUSK28XBARs1PVE7EVAdJzKtsfdGAb+q3ohQErvLArdv8t8qP9pPSvmgBdXZ8l0SmJT7nigySnCNBefE0+ATKMI4b8ytUeZTdFe7MMN8usbVlZmXwFCB0XrRZocSWIMrSs72qMuldmqHkpniJARW4ETQjtOnUA0ReO1i6zhx6r5hC4rgDtcaQA+VpgplmgfBgADSvrwVJ3mfJhAGr3/xPrcEvfWvb/az4MQa0PLrEdB+xBQqsPToAMwzRKGqLuJEb+NBiGYZq8AB35eZQsQIZhmu1nd7IAGYbhBMgCZBiGEyALkGEYToAsQIZhAXICZAEyDAuQEyALkGFYgJwAWYCqfyYg98+wADkBMgzDAuQEyAmQ+2dYgJwAGYZhAXIC5ATI/TMsQE6ADMOwADkBcgLk/hkWICdAhmFYgJwAOQFy/42flG3vOBE3QqfLKD+zADkBMozqJG+cjN+Cmv2nbZv+I9tnmNNCZtYITOlWqtO2v2tJ2zbDojxG0/5/AUr/DVEfzJ4rfx3AgoVLMG7yLLklRo/x4e8E4QTI/ashgNLrsaguybmd4tuXVWTpVRUQCYWe11yZD1NBCqpuZsJUkonK4nRUltyAqdSA6nJal2yYKwrkx9LvqJXglP7pS59+ilOJ0Qi8vAih54Lk/hsqidH3jyjio2+tI/ERtIwTIMOoIEBTYaog7RasUiq4BRIBteoLMBtn044i4voGnM/4AZeyjiHOcBzxhlj59oUbR3E2/aj8GHqsFgKsu/32+2DL6UD4X5uHhIoDiDSshr//KNXlQ0KrD0V49gK0v79ZJMCG/q7aHj16gBPgj/07av83UAK0VGTGyW/4CoNeTniVWQmoIikW1SfDfLUFaKkqTIFf/FzsLFyCKONKnC0PwfmyCFwoj8SFigjsK/4SCaZd2H5trSxrtQUYrY/Csv0zcTh6jbz99hLUnfgWXya8j8icFQhIWYjglKVYleCLNrPch6stwPqK/unQV4KSAMPCbsgCpNI6BTaaBKh8HWBDvwEbiwQdTVPe/yl+U5ySv5liJgFWCOlVZMZbERKoyNajSgxJZREU3bCToMoCDJluqShIxspT72F95jQE5LyHSOPniCpeJrNbZil2GJdg6ckZqgsw3H8M5p0agxDjR/g45k0c/2F9rfxiozdg2fmZ8E/3xRL9BCy+NBFfxE3ClOBnIU3o2EsLATp7ht8GVUMLsFEkQOVLqx3xBqQd7GgJOjoBNvX9bxXgVFN5+gUhvXiUJZ9EOckwUy+nwcrsRJiEnEy2NGg9LpitsgBnmMvzr+Ef0T74LHEU1maMx7qsKfDLmgY/AzEdW/Pnivtege++v4r1UU+ArpM7efrs6Y05cc/A99wALLz6MmYcGoHYw+sQc3A93o95Fe+c7QOfo93x1pE+mBrjhdGBXojyH6vJELgxCdDhCZAOftKbjyKwo96AjUGCjqI57H8hQOeUb9+uLEs7h7LMS7iZdAI3k4+j/MZFVGRckqVYmS2SoSERVfmUitK1EWDeFcw56I1/xL2ITxKH49PLL2H+5RGYn/giPta/gGmn+mJkdAf4bB8mBJimXgIc7zFwWEBnjDrUASMPtMOwfS54LaY9vCOfxqS9z2FE9D3oHyGhf5iEp0IlDFrngdNXjmoyCcIJ0A7aWIPBUDsD5cg3oBpvQuW/yW9t1UqSv7RVe///2v7V3v8/IUCX5G+nVZannhHyO47ixP0ovXYQpUnHUJYi0mCGNRnKw2MhQvl4oFWAFrXO+UvfJgSYewUf7H8D/xN9PybE9sSkE70w8URPvHX8cfx3dEd4hbfEU2Eu8N7+nLwOag6BdV/9Ff3XdRB9SPAMs8pu6M4WGBThjH4hEvptldBXMHDtAzgbd1A+DNAcBNjsE2B9cAJsWvufEmDyt1OFAM+h9HoMiuP2wBi/F6VXhAivH0FZ6gmRBC8IEcbLQ2IaflYXG1QToHUShIbASRgf8RK8QlsJCbXCANF6hbWGZ6gQ33YXkb6cBS4YG6K+AOm5dpwKwxNr2uLJYAm9N0t4QicIktArUEJPQb9/u+PEhX21E0KcAJv4MUCmeex/WYDfTK0qv3FeJL8DKLoUhaKLUTDG7UbJtf3ysptJsSIRnrBOjAjoNJTkjVNUnQSpzE/BuIAxlu5+zujmJ8l09f+x7epnZWzIME0ESFIL37sCjyxvi0e/kdB9gw3RZ+9l9+PkmUi77ddWgHcqOiGaZ4GZZjEL3IACdErZOMVMEx9W+e2SKby4W7QCIcLSq/tRcv2YfLK0IgC1zwOkU258Al43d5MF6AS59be1fj8K0HvTaLNWAqTtDQ79At0W/xFdv3JFl7WueHzRfTh8OEDedvvt1+pE6DudC0goAqSRgP0yPg+QaZAk2HRPhJ5ioTc2Jb/kM8GCLUg6twVF8UKIl/YICe6xyXF37RUjWlwJoturE4J73ewTMNrsTQjZ+Wyi9nX5NhERs7P2GJyaAqTnLL2+TyZy7zp4rvgLnl7RF8diNtcmPwWtjgFSpaSkoi728iM+/XSPnP6UQzR8JQjDqHAlCF1mZq7Ik8/zk9vyPGsrqDHRZJBJsytB6p58fCeUS/HUFqCS7ojyzHgcPrMDJy/uu01+BD22IS+FI9mR9AgSoXKbltPohK8FZhgVPgyh/gv/Z9T7QQCN5cMImsOHIVDqrTsUVo7/UQrkBMgwDH8cFidAhmFYgJwAGYZhAXICZBiGBcgJkGEYFiAnQIZhWICcABmGYQFyAmQYhgXICZBhGBYgJ0CGYTgBcgJkGIYTIAuQYRhOgCxAhmE4AbIAGYbhBMgCZBgWICdAFiDDsAA5AbIAGYYFyAnw9yDAuvUvSWp3p53xqSS1UnPnMAwLkBNgo/kDRnXp4pu2YEHG7j//eVzdnXGkc+fxBYsX6w+1bTtSSwG6SlJrexpyX7je5dxx/vz5C+pjwIAB3vyGZzgBqizAX1Pt/n6f58pLsy70W95vimoraKvw1q3fy/7wQyAkBIVr1ph2d+zoo9wX7e7uU755swnJySjftq10v02CmshPSEg8dQ+CbjekBG2Su63Ky8phMBhAIuQ3PcMJ0AECvGtmh95+1z7OS6g4gEjDajy8sNs4tQS4VZJmxru4wNC2LYpeeAE1y5ahaNUqU1THjmP3CcpWrzYhMhIIDwdOnkTFli03D3XqNFILAZL46Kv+CFdX12dlETaQBOsTIH0LGq1LXFy8/DNLkOEEqIEA233w8PNvRrwc5jaxY5fbkp9vZ6+Vet/syJwVCEhZiOCUpViV4Is2s9yHq/EH/F6Svj4nVvWGIEtQ1L49qidPRtny5ahYtAhYuRJYvRrYuBHYsgXYswenHnlksRZDUJIeCYe+I7ahJVifAC2C4pJixAsBUktCZAkynABVFGCrtz0Gzjk5yhhi/Agf/DBWL/m0d1dW4g/TOz+x9Py7Of7pvliin4DFlybii7hJeG3r4CRpQsdeKvwBnUQCfGCzJIVcEqtrEOQKjALT4MGwzJ4Ny5w5wLx5wJIlMH/9NU737h1Cv6OlAIf/7bkGl+CdhsD0nbgkv7j4eDkJErROLACGE+B/KEDXyZ08R+/tWTon7hn4nhuAhVdfxtv7RuilN/7kce87Dz45K+aVnHfO9oHP0e5460gfTI3xwiD/HnrJu0MfFY8ByhIMlqRtcZJkyRZPmy8oFlQ++ihqpk4F3n0XVXPmWI737LmNHku/o7UA60pQ62OCNgFabkuBYkl1tQlGIUFaF5IhT4ownADVSIDjPQZ6BnQoGHWoA0YeaIdh+1zwWkx7eO8Yen3i3mezR0Tfg/4REvqHSXgqVEKXL1tek3zc+6o9CUIlUqDHTlfXSxlOTnISLLBJsKJLF+DttxE/YsQFeoxWs8D1CdBeglqnwIEDB/rUJ0DYLaQhMCVCFiDDCVCtY4DjPZ5/6EuXTK9wCZ5hVtkN3dkCgyKc0S9EQr+tEvoK7lvuJpJh5ydUXUF7AbZoMe703XeXJounTRcoSZCGw5WPPYb8adNK7E+RaXoCHOQNs6UGP1fChixAhhOgmrPAPp1fuX+la86TwRJ6b5bwhE4QJKFXoISeAvcvWlyVvB/op7qhbaUTa3CoZcsqvXjKREGSbVKEJJgnKKQk2LcvcidPrtrh7u7TUAJsyCHwkKFDfCxmS7WS+BSsN24NhixAhhOg2qfB+LgP77DINfvRbyR032DDT0K7z9wSJW+PPpqsICU/Z+exu5ycqk+IpzsjoMmQK0TLlrgmhsNZtsmRPDc33OzTB4axY6t3deo0pqlNggwdOtTHbDabYAbMNTUwi+GujLhdU10jD3+VDMgCZDgBanEe4HiPkX/8rEV2169c0WWtK+6d53ZFGnufp2aGpvTn5vbP3e3b44izM2LFU9IpMWeE7La3br0jWJJ2XhQ/Z9gSYW6bNjB4eSGqc+cFWgqwoeXn5eXlNGTIEB9TVVUViY4mPUwmK3TMr4ZaOv4nsHACZDgBangitLfH848t7VrQ/fOu1++U/FQUIM0Adw5wc/tul5BgjIsLDgsRBru60mzvw4QYHm87azsuePnuuxF5773f0e80tROhSYBlpWUmuvKjvNxG2e0ICXICZDgBangliJPk7f5f9rO9WiZA6u97sb2Bbm6bQtu2hRDedtupLsqVIg8EimWHRHehTk6b6LGanAbj4EvhBg8e7G0sNtaUlJbgFm6WoLhEUFosnwJDEmQBMpwAm9aHITjZ0t6bou0mS/jW+7rZ7ntYua+pfRjCwIEDvU2mKnNlZRUqKiqE6MpQUV6ByopKVFeZ5GFxjYAnQRhOgE3z47Cc7PjZ+5rai5mG3B/Mnmv+cM48omb2R5/UzBYt/fzB7HmWD2fPtYj7QfCVIAwnQI0E2Ng3qqm+EJQheOs2LTtS26pNy06t2rh1anUPtS07yUNyBevxSi4uToAsQPCrhYuLEyALkIuLixNgoxYgFxcXV7NNgFxcXFycALm4uLg4AXJxcXE1kgTIMAzTFPh/7ilJ+J+MkXkAAAAASUVORK5CYII=")}.jstree-default-large .jstree-node{background-position:-288px 0;background-repeat:repeat-y}.jstree-default-large .jstree-last{background-image:none}.jstree-default-large .jstree-open>.jstree-ocl{background-position:-128px 0}.jstree-default-large .jstree-closed>.jstree-ocl{background-position:-96px 0}.jstree-default-large .jstree-leaf>.jstree-ocl{background-position:-64px 0}.jstree-default-large .jstree-themeicon{background-position:-256px 0}.jstree-default-large>.jstree-no-dots .jstree-node,.jstree-default-large>.jstree-no-dots .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-large>.jstree-no-dots .jstree-open>.jstree-ocl{background-position:-32px 0}.jstree-default-large>.jstree-no-dots .jstree-closed>.jstree-ocl{background-position:0 0}.jstree-default-large .jstree-disabled{background:transparent}.jstree-default-large .jstree-disabled.jstree-hovered{background:transparent}.jstree-default-large .jstree-disabled.jstree-clicked{background:#efefef}.jstree-default-large .jstree-checkbox{background-position:-160px 0}.jstree-default-large .jstree-checkbox:hover{background-position:-160px -32px}.jstree-default-large.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox,.jstree-default-large .jstree-checked>.jstree-checkbox{background-position:-224px 0}.jstree-default-large.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox:hover,.jstree-default-large .jstree-checked>.jstree-checkbox:hover{background-position:-224px -32px}.jstree-default-large .jstree-anchor>.jstree-undetermined{background-position:-192px 0}.jstree-default-large .jstree-anchor>.jstree-undetermined:hover{background-position:-192px -32px}.jstree-default-large .jstree-checkbox-disabled{opacity:.8;filter:url("data:image/svg+xml;utf8,#jstree-grayscale");filter:gray;-webkit-filter:grayscale(100%)}.jstree-default-large>.jstree-striped{background-size:auto 64px}.jstree-default-large.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAACAQMAAAB49I5GAAAABlBMVEUAAAAdHRvEkCwcAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjAAMOBgAAGAAJMwQHdQAAAABJRU5ErkJggg==");background-position:100% 1px;background-repeat:repeat-y}.jstree-default-large.jstree-rtl .jstree-last{background-image:none}.jstree-default-large.jstree-rtl .jstree-open>.jstree-ocl{background-position:-128px -32px}.jstree-default-large.jstree-rtl .jstree-closed>.jstree-ocl{background-position:-96px -32px}.jstree-default-large.jstree-rtl .jstree-leaf>.jstree-ocl{background-position:-64px -32px}.jstree-default-large.jstree-rtl>.jstree-no-dots .jstree-node,.jstree-default-large.jstree-rtl>.jstree-no-dots .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-large.jstree-rtl>.jstree-no-dots .jstree-open>.jstree-ocl{background-position:-32px -32px}.jstree-default-large.jstree-rtl>.jstree-no-dots .jstree-closed>.jstree-ocl{background-position:0 -32px}.jstree-default-large .jstree-themeicon-custom{background-color:transparent;background-image:none;background-position:0 0}.jstree-default-large>.jstree-container-ul .jstree-loading>.jstree-ocl{background:url("data:image/gif;base64,R0lGODlhEAAQAPMPAODg4Hp6egAAAFhYWL6+vhQUFJycnDY2NvDw8IqKikZGRiQkJKysrGhoaAQEBP///yH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQFCgAPACwAAAAAEAAQAEAEcPDJh2gbdcqkutETIoqKkCCCMwxA1koA8AAHwRhAIlMaICwIh6C1CyEYh6IkE0oUFEoEgKCcBWSGz4PAnAAWLcGQ15MlTMJYd1ZyUDXSDGelBY0qIkJg/ZoEFgYICToxDBRvIQMBD1kzgSAgBASQDxEAIfkEBQoADwAsAAAAAA8AEAAABF3wyflCk4hOJZcEBaNJB7I4wCIQo2QshSFw0xAjxWEJQpZJA8EBMCEQW7TWg9EIBFjKh2HQaECjH8PoN2EoBlvAL6FgIAwMgPoo1jQABPNVE9DGJXOMIXN/HJVqIxEAIfkEBQoADwAsAAAAABAADwAABFrwyflMolg2qRZCRyY5A9Ihg4hUAtMxE0BIwcGASpIcApAIPU0hFTMABbMJobFSCi4Sgs4AyHyujIBWxH3AupRGotk1BAgIAvqqkiQAcASAjDHM4A8594vPUyIAIfkEBQoADwAsAAAAABAAEAAABFzwySkNvTKgN5QcBPYcAec12CYVRBeiCCAljawEhuEhVqEGpIfqQViIHiWKrIbYGBgMUaNQcIByBtmlIegeKKELYAxQARKW44SQfYzVQgmC0BweCbIm3C23w/UYEQAh+QQFCgAIACwAAAAAEAAOAAAERRDJiUKgWA4pBM/c1iEFKAVeZ5DYUBCIcFheFU+DsGH1Su2YwwSAMPiCHUHJcsmUPkMMQZY5TqYdIkJrSma4FAJQAgZFAAAh+QQFCgAOACwAAAAAEAAQAAAEa9DJ6Qih2CEmU5ABkCEBlyROsogZ0AAnUKAUwYiJYQVHtSgSBCFBQEwQgIHjwJIAOBSEwmDUAK5VimEwUCSu2IxhsSg0ohjAwYBBNh1PCTAIMCKqBUHSUchmGAJKDlBoEwsCFyNpAmwZjn4RACH5BAUKAA8ALAAAAAAQABAAAARb8Mn5AKBYEmkMz9zFeIYCSgkyPgqDWcjDEJbRSMotAXTWFAMM4oJpuCaIJIjRaASTygxDcTgETpMBI4rdPBoxUKCxeCBuh1NBkHhceSDEmkiMOwQXxzE+OIQpEQAh+QQFCgAOACwBAAEADwAPAAAEVtBJIAmRTOpaL2nb5l3N5SCnBlAOEzjAkEgIgIbB8W73lpihICFAzAQ1n4HsSCsFa6zawrHbCASJhGI6U/gEgcXC4JiFAFdKAXE4MgSXwtqxAKo0g2MEACH5BAUKAA8ALAAAAAAQABAAAARd8Mn5EKJY3geAJBsGXB1nhBTidUjiYZtlEYyUGBlsNHiOGS8fBZAoCieAgLL2WRAwrqFCIOhNFIWExiE4eBYGRkPxMCwaEsPTdjjUesHJAtF+DBw+x/cgIec2SjkRACH5BAUKAA4ALAAAAQAQAA8AAARa0MnpEJKAamkl2Vr3bZkGlMYITkxCXFRJqU5T3A3I7MQh/AqQweBCnAwFmcSwcrwmiMaBKVnUEAsFw5EYOAcBCUNmGCgIhS1Mc3CYHYH2hmB1KII15SaRAEUAACH5BAUKAA8ALAAAAQAQAA8AAARY8MlJH6p4IlABx8BFCUJSiQjxEaTwTYBaBQLTidKiZw/hAwNHoRDI+BgfBEOBsVUGkpck0XA+Do+iYuAzNCQBg4QgETMCDQCWV2CiHwYmSN6AIoq8shgTAQAh+QQFCgAPACwAAAEADwAPAAAEWvBJUoC8+BKxspeDwHxS9wCC4AHIaRrjhbCY4RBZKyWHoiSeGQAQWBiBuaGlRRh4cLLAo+BhJKBOYCMwZBhOsNOkQEhIG5aHTn1oPMwPRmB9cb+ljy8pHsNEAAA7") center center no-repeat}.jstree-default-large .jstree-file{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAYAAABsS6soAAAV40lEQVR42u2dCXQUVbrHKwsEHEWGYZkEVzZ1BEGQBHiAioqiPA++N4gkoKwiyBjGp+AIIjJHkGVgEFAgQSVJY4CQjSWsASGEfU06YctKks6eTkK2Trr/737VXbEJwW2q0jH5vnN+53aqO32rKt2//G/dqm4JgPRr4bLW/fd3BvfPxeW4199v8dctLmMBcnFx/V6LBcgJjBMgFydAFiAXFxcnQBYgJzBOgFycAFmAXFxcnABZgJzAOAFycQJkAXJxcXECZAFyAvsd9h8YGOhU3+3GUI1tfbSqpDPfoz7OHf6ylpM75iL36sYZnAC5uFSodevXISgoyKLT6Sy6oM1m0VYHbdbVBOno9maLuA9BdJ9OB/m2gH5H5f4VqD+zbX3MtnWoptubdWKZ9v3/ItTs315+5sqCn6ZcLxO1aVqDiMIhAmSsqPEfiPv/eegNnZySAmOxEUXGIhQVFaKQKCyC0VgolhejuFjcLqG2GAaDQZaAmv0Xi+cuLyuHsUj0L/rML8xHflEe8grzUGDMk9eJ1q9MPIYeq1b/VEr/NdXVP8mRxBhsuvwFtp7ZKvevlQBNhWkydPtOCZDQWoIOS4AM05BQ4srLzZdFl59fgPyCAhQJ2RQTJKbScllORE21SW7VF6ARZ9OOIvT6BpzN+AHnDcdwMSMW8VnHcT4rBhduHMP5GzE4Jx6jlQDlba+DIuYtpwPhf20eEioOINKwGh+um62NAG0JjwR4WyK03deQKdAhAlTzxaUGPXr0QHNKYMr+bywJUMv9T8fWxLDSnJWZibz8fDndEXl5NhGK5EWpj0SgyEBNARHB32+15Oflwz9hHnYWLsWewn/jbNk2XCgLx/mbYTh7czsOGb/GpcpIhF3bgLzcAojfUVWAe+MO4rPDs7DjQoi8/fYC1J34Fl8mvI/InBUISFmI4JSlWJXgizaz3IerKRtKd/aCqxVgHfFVFMTKNNkESH+Q4O+3oLHIz1ECdGAialb7XxekM2dmZsCQZUBaWhrS09ORlUUSzBUSyJdFWCAwKgIsVluAWyy5uXlYcWYmNmS8jYCcWYg0LkKUcRmiipdhd9FS7Cxagoj8xVh16u/IyctT7e9D9dlXn2PeqTEIMX6Ej2PexHf7gmoFuPW0DsvOz4R/ui+W6Cdg8aWJ+CJuEryDX4I0oWMvLQRIcqNW/tlOgIr4GkqADk2AtPMdnQTpjTd6jA+aYwJsTvtfpwuqyRACTE1LRUpKKlJT05CWfkNIMAs52dlChPny/iiwJSJjSZGq+2aLECBJbXa0DxYmjsKa9LewPmMK/DKnwS9rGjZkvgP/zL/hnwmj8OFBb+Tm5JIALWr07Tq5k+cbUU9iTtwz8D03AAuvvowZh0bg273in+CpQLwf8yreOdsHPke7460jfTA1xguvBg7B518tUV0+9gIk6iZCRYzNIgHSQVd60dFskyPffI4UoCMTYHPa/zTDmpGRiVQhP5oMSUpOkUWYlp6GLLGchoS5QlDykLC4WIsEiByRAP9vvzfmxr2EuQkv4dOEEZifOAKfJLwo5DQM00/1w/9GP4QJ4SPEY9UToDTeY+CQTQ9g1KEOGHmgHYbtc8FrMe3hHfk0Ju19DiOi70H/CAn9wyQ8FSrBc/2DiE08rckkCE1s2AtO+bm+9EdsWj666SZAZeaJXnwLFi6Bo958jSEB/tb2PxVg3f3fUP3faf9r1b9IgBZKeyQ9fYJecAXXk5JlGaaKITGRZchCdrb12JjRKCdAi5oCJMHO2j8ao6I98OaxnpgQ2xNvHXsc42MfEXLywNM7/oBBYXdhXNhw8dhcVYfAH636FH03dIJXuBBcmFV2Q3e2wKAIZ/QLkdBvq4S+gv5ruyI24VTtMVAtBEhiK72+r14B0nJ7tBZgs0yAyjGnunACbLr7n2SWJURPwouL1yM+Lh56/WUkXU8SaTDZOiwWEqRjhMrEgOoJMD8f40Kfw4BQN3iFtsSg8NZCeK0wKLQVPLe74CmBZ2gLeG9/Tp6sUVOAtC2hJ3bjL2v+hCeDJfTeLOEJnSBIQq9ACT0FvVbeh4PnY27Zfi3kl5P4DYou7pYFZ58IFenR/QpNOgE2hmNQzfi0kGa1/2k7KeHFxccjLs5KvBChXrQJCZeRnGSVYEpqmpyI6ZQVtQVI+9snYLS5q5+Ebn5O6LZRwiMbndDdXwIt6yrabv7OGLt9mPxYtQVIUlsfuQldl7fHo99I6L7Bhuj7saUP4cCZw/I+sG6/egJ0laTW1NLxPEWA9igSVH5OPfGvWpp0Amwss5DNVYDNaf/T9tIbW5GfPZQG4/XxSLEdFyS0EqD3ptHmbn4kHRdZgl1F293PWdx2hiJGeoxWAqTtXRO+EQ8u7oCuX7miy1pXdP/8QYQf3V277dbtV1GAdzl3JEiAlPDsBUfCo+WOEiCfB9iMBdjcttdegPG2Vh+nF6kwQW71cjrU3yIAta8E0e3VyYLzFklwnNy+bqZUSK28XBARs1PVE7EVAdJzKtsfdGAb+q3ohQErvLArdv8t8qP9pPSvmgBdXZ8l0SmJT7nigySnCNBefE0+ATKMI4b8ytUeZTdFe7MMN8usbVlZmXwFCB0XrRZocSWIMrSs72qMuldmqHkpniJARW4ETQjtOnUA0ReO1i6zhx6r5hC4rgDtcaQA+VpgplmgfBgADSvrwVJ3mfJhAGr3/xPrcEvfWvb/az4MQa0PLrEdB+xBQqsPToAMwzRKGqLuJEb+NBiGYZq8AB35eZQsQIZhmu1nd7IAGYbhBMgCZBiGEyALkGEYToAsQIZhAXICZAEyDAuQEyALkGFYgJwAWYCqfyYg98+wADkBMgzDAuQEyAmQ+2dYgJwAGYZhAXIC5ATI/TMsQE6ADMOwADkBcgLk/hkWICdAhmFYgJwAOQFy/42flG3vOBE3QqfLKD+zADkBMozqJG+cjN+Cmv2nbZv+I9tnmNNCZtYITOlWqtO2v2tJ2zbDojxG0/5/AUr/DVEfzJ4rfx3AgoVLMG7yLLklRo/x4e8E4QTI/ashgNLrsaguybmd4tuXVWTpVRUQCYWe11yZD1NBCqpuZsJUkonK4nRUltyAqdSA6nJal2yYKwrkx9LvqJXglP7pS59+ilOJ0Qi8vAih54Lk/hsqidH3jyjio2+tI/ERtIwTIMOoIEBTYaog7RasUiq4BRIBteoLMBtn044i4voGnM/4AZeyjiHOcBzxhlj59oUbR3E2/aj8GHqsFgKsu/32+2DL6UD4X5uHhIoDiDSshr//KNXlQ0KrD0V49gK0v79ZJMCG/q7aHj16gBPgj/07av83UAK0VGTGyW/4CoNeTniVWQmoIikW1SfDfLUFaKkqTIFf/FzsLFyCKONKnC0PwfmyCFwoj8SFigjsK/4SCaZd2H5trSxrtQUYrY/Csv0zcTh6jbz99hLUnfgWXya8j8icFQhIWYjglKVYleCLNrPch6stwPqK/unQV4KSAMPCbsgCpNI6BTaaBKh8HWBDvwEbiwQdTVPe/yl+U5ySv5liJgFWCOlVZMZbERKoyNajSgxJZREU3bCToMoCDJluqShIxspT72F95jQE5LyHSOPniCpeJrNbZil2GJdg6ckZqgsw3H8M5p0agxDjR/g45k0c/2F9rfxiozdg2fmZ8E/3xRL9BCy+NBFfxE3ClOBnIU3o2EsLATp7ht8GVUMLsFEkQOVLqx3xBqQd7GgJOjoBNvX9bxXgVFN5+gUhvXiUJZ9EOckwUy+nwcrsRJiEnEy2NGg9LpitsgBnmMvzr+Ef0T74LHEU1maMx7qsKfDLmgY/AzEdW/Pnivtege++v4r1UU+ArpM7efrs6Y05cc/A99wALLz6MmYcGoHYw+sQc3A93o95Fe+c7QOfo93x1pE+mBrjhdGBXojyH6vJELgxCdDhCZAOftKbjyKwo96AjUGCjqI57H8hQOeUb9+uLEs7h7LMS7iZdAI3k4+j/MZFVGRckqVYmS2SoSERVfmUitK1EWDeFcw56I1/xL2ITxKH49PLL2H+5RGYn/giPta/gGmn+mJkdAf4bB8mBJimXgIc7zFwWEBnjDrUASMPtMOwfS54LaY9vCOfxqS9z2FE9D3oHyGhf5iEp0IlDFrngdNXjmoyCcIJ0A7aWIPBUDsD5cg3oBpvQuW/yW9t1UqSv7RVe///2v7V3v8/IUCX5G+nVZannhHyO47ixP0ovXYQpUnHUJYi0mCGNRnKw2MhQvl4oFWAFrXO+UvfJgSYewUf7H8D/xN9PybE9sSkE70w8URPvHX8cfx3dEd4hbfEU2Eu8N7+nLwOag6BdV/9Ff3XdRB9SPAMs8pu6M4WGBThjH4hEvptldBXMHDtAzgbd1A+DNAcBNjsE2B9cAJsWvufEmDyt1OFAM+h9HoMiuP2wBi/F6VXhAivH0FZ6gmRBC8IEcbLQ2IaflYXG1QToHUShIbASRgf8RK8QlsJCbXCANF6hbWGZ6gQ33YXkb6cBS4YG6K+AOm5dpwKwxNr2uLJYAm9N0t4QicIktArUEJPQb9/u+PEhX21E0KcAJv4MUCmeex/WYDfTK0qv3FeJL8DKLoUhaKLUTDG7UbJtf3ysptJsSIRnrBOjAjoNJTkjVNUnQSpzE/BuIAxlu5+zujmJ8l09f+x7epnZWzIME0ESFIL37sCjyxvi0e/kdB9gw3RZ+9l9+PkmUi77ddWgHcqOiGaZ4GZZjEL3IACdErZOMVMEx9W+e2SKby4W7QCIcLSq/tRcv2YfLK0IgC1zwOkU258Al43d5MF6AS59be1fj8K0HvTaLNWAqTtDQ79At0W/xFdv3JFl7WueHzRfTh8OEDedvvt1+pE6DudC0goAqSRgP0yPg+QaZAk2HRPhJ5ioTc2Jb/kM8GCLUg6twVF8UKIl/YICe6xyXF37RUjWlwJoturE4J73ewTMNrsTQjZ+Wyi9nX5NhERs7P2GJyaAqTnLL2+TyZy7zp4rvgLnl7RF8diNtcmPwWtjgFSpaSkoi728iM+/XSPnP6UQzR8JQjDqHAlCF1mZq7Ik8/zk9vyPGsrqDHRZJBJsytB6p58fCeUS/HUFqCS7ojyzHgcPrMDJy/uu01+BD22IS+FI9mR9AgSoXKbltPohK8FZhgVPgyh/gv/Z9T7QQCN5cMImsOHIVDqrTsUVo7/UQrkBMgwDH8cFidAhmFYgJwAGYZhAXICZBiGBcgJkGEYFiAnQIZhWICcABmGYQFyAmQYhgXICZBhGBYgJ0CGYTgBcgJkGIYTIAuQYRhOgCxAhmE4AbIAGYbhBMgCZBgWICdAFiDDsAA5AbIAGYYFyAnw9yDAuvUvSWp3p53xqSS1UnPnMAwLkBNgo/kDRnXp4pu2YEHG7j//eVzdnXGkc+fxBYsX6w+1bTtSSwG6SlJrexpyX7je5dxx/vz5C+pjwIAB3vyGZzgBqizAX1Pt/n6f58pLsy70W95vimoraKvw1q3fy/7wQyAkBIVr1ph2d+zoo9wX7e7uU755swnJySjftq10v02CmshPSEg8dQ+CbjekBG2Su63Ky8phMBhAIuQ3PcMJ0AECvGtmh95+1z7OS6g4gEjDajy8sNs4tQS4VZJmxru4wNC2LYpeeAE1y5ahaNUqU1THjmP3CcpWrzYhMhIIDwdOnkTFli03D3XqNFILAZL46Kv+CFdX12dlETaQBOsTIH0LGq1LXFy8/DNLkOEEqIEA233w8PNvRrwc5jaxY5fbkp9vZ6+Vet/syJwVCEhZiOCUpViV4Is2s9yHq/EH/F6Svj4nVvWGIEtQ1L49qidPRtny5ahYtAhYuRJYvRrYuBHYsgXYswenHnlksRZDUJIeCYe+I7ahJVifAC2C4pJixAsBUktCZAkynABVFGCrtz0Gzjk5yhhi/Agf/DBWL/m0d1dW4g/TOz+x9Py7Of7pvliin4DFlybii7hJeG3r4CRpQsdeKvwBnUQCfGCzJIVcEqtrEOQKjALT4MGwzJ4Ny5w5wLx5wJIlMH/9NU737h1Cv6OlAIf/7bkGl+CdhsD0nbgkv7j4eDkJErROLACGE+B/KEDXyZ08R+/tWTon7hn4nhuAhVdfxtv7RuilN/7kce87Dz45K+aVnHfO9oHP0e5460gfTI3xwiD/HnrJu0MfFY8ByhIMlqRtcZJkyRZPmy8oFlQ++ihqpk4F3n0XVXPmWI737LmNHku/o7UA60pQ62OCNgFabkuBYkl1tQlGIUFaF5IhT4ownADVSIDjPQZ6BnQoGHWoA0YeaIdh+1zwWkx7eO8Yen3i3mezR0Tfg/4REvqHSXgqVEKXL1tek3zc+6o9CUIlUqDHTlfXSxlOTnISLLBJsKJLF+DttxE/YsQFeoxWs8D1CdBeglqnwIEDB/rUJ0DYLaQhMCVCFiDDCVCtY4DjPZ5/6EuXTK9wCZ5hVtkN3dkCgyKc0S9EQr+tEvoK7lvuJpJh5ydUXUF7AbZoMe703XeXJounTRcoSZCGw5WPPYb8adNK7E+RaXoCHOQNs6UGP1fChixAhhOgmrPAPp1fuX+la86TwRJ6b5bwhE4QJKFXoISeAvcvWlyVvB/op7qhbaUTa3CoZcsqvXjKREGSbVKEJJgnKKQk2LcvcidPrtrh7u7TUAJsyCHwkKFDfCxmS7WS+BSsN24NhixAhhOg2qfB+LgP77DINfvRbyR032DDT0K7z9wSJW+PPpqsICU/Z+exu5ycqk+IpzsjoMmQK0TLlrgmhsNZtsmRPDc33OzTB4axY6t3deo0pqlNggwdOtTHbDabYAbMNTUwi+GujLhdU10jD3+VDMgCZDgBanEe4HiPkX/8rEV2169c0WWtK+6d53ZFGnufp2aGpvTn5vbP3e3b44izM2LFU9IpMWeE7La3br0jWJJ2XhQ/Z9gSYW6bNjB4eSGqc+cFWgqwoeXn5eXlNGTIEB9TVVUViY4mPUwmK3TMr4ZaOv4nsHACZDgBangitLfH848t7VrQ/fOu1++U/FQUIM0Adw5wc/tul5BgjIsLDgsRBru60mzvw4QYHm87azsuePnuuxF5773f0e80tROhSYBlpWUmuvKjvNxG2e0ICXICZDgBangliJPk7f5f9rO9WiZA6u97sb2Bbm6bQtu2hRDedtupLsqVIg8EimWHRHehTk6b6LGanAbj4EvhBg8e7G0sNtaUlJbgFm6WoLhEUFosnwJDEmQBMpwAm9aHITjZ0t6bou0mS/jW+7rZ7ntYua+pfRjCwIEDvU2mKnNlZRUqKiqE6MpQUV6ByopKVFeZ5GFxjYAnQRhOgE3z47Cc7PjZ+5rai5mG3B/Mnmv+cM48omb2R5/UzBYt/fzB7HmWD2fPtYj7QfCVIAwnQI0E2Ng3qqm+EJQheOs2LTtS26pNy06t2rh1anUPtS07yUNyBevxSi4uToAsQPCrhYuLEyALkIuLixNgoxYgFxcXV7NNgFxcXFycALm4uLg4AXJxcXE1kgTIMAzTFPh/7ilJ+J+MkXkAAAAASUVORK5CYII=") -96px -64px no-repeat}.jstree-default-large .jstree-folder{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAYAAABsS6soAAAV40lEQVR42u2dCXQUVbrHKwsEHEWGYZkEVzZ1BEGQBHiAioqiPA++N4gkoKwiyBjGp+AIIjJHkGVgEFAgQSVJY4CQjSWsASGEfU06YctKks6eTkK2Trr/737VXbEJwW2q0jH5vnN+53aqO32rKt2//G/dqm4JgPRr4bLW/fd3BvfPxeW4199v8dctLmMBcnFx/V6LBcgJjBMgFydAFiAXFxcnQBYgJzBOgFycAFmAXFxcnABZgJzAOAFycQJkAXJxcXECZAFyAvsd9h8YGOhU3+3GUI1tfbSqpDPfoz7OHf6ylpM75iL36sYZnAC5uFSodevXISgoyKLT6Sy6oM1m0VYHbdbVBOno9maLuA9BdJ9OB/m2gH5H5f4VqD+zbX3MtnWoptubdWKZ9v3/ItTs315+5sqCn6ZcLxO1aVqDiMIhAmSsqPEfiPv/eegNnZySAmOxEUXGIhQVFaKQKCyC0VgolhejuFjcLqG2GAaDQZaAmv0Xi+cuLyuHsUj0L/rML8xHflEe8grzUGDMk9eJ1q9MPIYeq1b/VEr/NdXVP8mRxBhsuvwFtp7ZKvevlQBNhWkydPtOCZDQWoIOS4AM05BQ4srLzZdFl59fgPyCAhQJ2RQTJKbScllORE21SW7VF6ARZ9OOIvT6BpzN+AHnDcdwMSMW8VnHcT4rBhduHMP5GzE4Jx6jlQDlba+DIuYtpwPhf20eEioOINKwGh+um62NAG0JjwR4WyK03deQKdAhAlTzxaUGPXr0QHNKYMr+bywJUMv9T8fWxLDSnJWZibz8fDndEXl5NhGK5EWpj0SgyEBNARHB32+15Oflwz9hHnYWLsWewn/jbNk2XCgLx/mbYTh7czsOGb/GpcpIhF3bgLzcAojfUVWAe+MO4rPDs7DjQoi8/fYC1J34Fl8mvI/InBUISFmI4JSlWJXgizaz3IerKRtKd/aCqxVgHfFVFMTKNNkESH+Q4O+3oLHIz1ECdGAialb7XxekM2dmZsCQZUBaWhrS09ORlUUSzBUSyJdFWCAwKgIsVluAWyy5uXlYcWYmNmS8jYCcWYg0LkKUcRmiipdhd9FS7Cxagoj8xVh16u/IyctT7e9D9dlXn2PeqTEIMX6Ej2PexHf7gmoFuPW0DsvOz4R/ui+W6Cdg8aWJ+CJuEryDX4I0oWMvLQRIcqNW/tlOgIr4GkqADk2AtPMdnQTpjTd6jA+aYwJsTvtfpwuqyRACTE1LRUpKKlJT05CWfkNIMAs52dlChPny/iiwJSJjSZGq+2aLECBJbXa0DxYmjsKa9LewPmMK/DKnwS9rGjZkvgP/zL/hnwmj8OFBb+Tm5JIALWr07Tq5k+cbUU9iTtwz8D03AAuvvowZh0bg273in+CpQLwf8yreOdsHPke7460jfTA1xguvBg7B518tUV0+9gIk6iZCRYzNIgHSQVd60dFskyPffI4UoCMTYHPa/zTDmpGRiVQhP5oMSUpOkUWYlp6GLLGchoS5QlDykLC4WIsEiByRAP9vvzfmxr2EuQkv4dOEEZifOAKfJLwo5DQM00/1w/9GP4QJ4SPEY9UToDTeY+CQTQ9g1KEOGHmgHYbtc8FrMe3hHfk0Ju19DiOi70H/CAn9wyQ8FSrBc/2DiE08rckkCE1s2AtO+bm+9EdsWj666SZAZeaJXnwLFi6Bo958jSEB/tb2PxVg3f3fUP3faf9r1b9IgBZKeyQ9fYJecAXXk5JlGaaKITGRZchCdrb12JjRKCdAi5oCJMHO2j8ao6I98OaxnpgQ2xNvHXsc42MfEXLywNM7/oBBYXdhXNhw8dhcVYfAH636FH03dIJXuBBcmFV2Q3e2wKAIZ/QLkdBvq4S+gv5ruyI24VTtMVAtBEhiK72+r14B0nJ7tBZgs0yAyjGnunACbLr7n2SWJURPwouL1yM+Lh56/WUkXU8SaTDZOiwWEqRjhMrEgOoJMD8f40Kfw4BQN3iFtsSg8NZCeK0wKLQVPLe74CmBZ2gLeG9/Tp6sUVOAtC2hJ3bjL2v+hCeDJfTeLOEJnSBIQq9ACT0FvVbeh4PnY27Zfi3kl5P4DYou7pYFZ58IFenR/QpNOgE2hmNQzfi0kGa1/2k7KeHFxccjLs5KvBChXrQJCZeRnGSVYEpqmpyI6ZQVtQVI+9snYLS5q5+Ebn5O6LZRwiMbndDdXwIt6yrabv7OGLt9mPxYtQVIUlsfuQldl7fHo99I6L7Bhuj7saUP4cCZw/I+sG6/egJ0laTW1NLxPEWA9igSVH5OPfGvWpp0Amwss5DNVYDNaf/T9tIbW5GfPZQG4/XxSLEdFyS0EqD3ptHmbn4kHRdZgl1F293PWdx2hiJGeoxWAqTtXRO+EQ8u7oCuX7miy1pXdP/8QYQf3V277dbtV1GAdzl3JEiAlPDsBUfCo+WOEiCfB9iMBdjcttdegPG2Vh+nF6kwQW71cjrU3yIAta8E0e3VyYLzFklwnNy+bqZUSK28XBARs1PVE7EVAdJzKtsfdGAb+q3ohQErvLArdv8t8qP9pPSvmgBdXZ8l0SmJT7nigySnCNBefE0+ATKMI4b8ytUeZTdFe7MMN8usbVlZmXwFCB0XrRZocSWIMrSs72qMuldmqHkpniJARW4ETQjtOnUA0ReO1i6zhx6r5hC4rgDtcaQA+VpgplmgfBgADSvrwVJ3mfJhAGr3/xPrcEvfWvb/az4MQa0PLrEdB+xBQqsPToAMwzRKGqLuJEb+NBiGYZq8AB35eZQsQIZhmu1nd7IAGYbhBMgCZBiGEyALkGEYToAsQIZhAXICZAEyDAuQEyALkGFYgJwAWYCqfyYg98+wADkBMgzDAuQEyAmQ+2dYgJwAGYZhAXIC5ATI/TMsQE6ADMOwADkBcgLk/hkWICdAhmFYgJwAOQFy/42flG3vOBE3QqfLKD+zADkBMozqJG+cjN+Cmv2nbZv+I9tnmNNCZtYITOlWqtO2v2tJ2zbDojxG0/5/AUr/DVEfzJ4rfx3AgoVLMG7yLLklRo/x4e8E4QTI/ashgNLrsaguybmd4tuXVWTpVRUQCYWe11yZD1NBCqpuZsJUkonK4nRUltyAqdSA6nJal2yYKwrkx9LvqJXglP7pS59+ilOJ0Qi8vAih54Lk/hsqidH3jyjio2+tI/ERtIwTIMOoIEBTYaog7RasUiq4BRIBteoLMBtn044i4voGnM/4AZeyjiHOcBzxhlj59oUbR3E2/aj8GHqsFgKsu/32+2DL6UD4X5uHhIoDiDSshr//KNXlQ0KrD0V49gK0v79ZJMCG/q7aHj16gBPgj/07av83UAK0VGTGyW/4CoNeTniVWQmoIikW1SfDfLUFaKkqTIFf/FzsLFyCKONKnC0PwfmyCFwoj8SFigjsK/4SCaZd2H5trSxrtQUYrY/Csv0zcTh6jbz99hLUnfgWXya8j8icFQhIWYjglKVYleCLNrPch6stwPqK/unQV4KSAMPCbsgCpNI6BTaaBKh8HWBDvwEbiwQdTVPe/yl+U5ySv5liJgFWCOlVZMZbERKoyNajSgxJZREU3bCToMoCDJluqShIxspT72F95jQE5LyHSOPniCpeJrNbZil2GJdg6ckZqgsw3H8M5p0agxDjR/g45k0c/2F9rfxiozdg2fmZ8E/3xRL9BCy+NBFfxE3ClOBnIU3o2EsLATp7ht8GVUMLsFEkQOVLqx3xBqQd7GgJOjoBNvX9bxXgVFN5+gUhvXiUJZ9EOckwUy+nwcrsRJiEnEy2NGg9LpitsgBnmMvzr+Ef0T74LHEU1maMx7qsKfDLmgY/AzEdW/Pnivtege++v4r1UU+ArpM7efrs6Y05cc/A99wALLz6MmYcGoHYw+sQc3A93o95Fe+c7QOfo93x1pE+mBrjhdGBXojyH6vJELgxCdDhCZAOftKbjyKwo96AjUGCjqI57H8hQOeUb9+uLEs7h7LMS7iZdAI3k4+j/MZFVGRckqVYmS2SoSERVfmUitK1EWDeFcw56I1/xL2ITxKH49PLL2H+5RGYn/giPta/gGmn+mJkdAf4bB8mBJimXgIc7zFwWEBnjDrUASMPtMOwfS54LaY9vCOfxqS9z2FE9D3oHyGhf5iEp0IlDFrngdNXjmoyCcIJ0A7aWIPBUDsD5cg3oBpvQuW/yW9t1UqSv7RVe///2v7V3v8/IUCX5G+nVZannhHyO47ixP0ovXYQpUnHUJYi0mCGNRnKw2MhQvl4oFWAFrXO+UvfJgSYewUf7H8D/xN9PybE9sSkE70w8URPvHX8cfx3dEd4hbfEU2Eu8N7+nLwOag6BdV/9Ff3XdRB9SPAMs8pu6M4WGBThjH4hEvptldBXMHDtAzgbd1A+DNAcBNjsE2B9cAJsWvufEmDyt1OFAM+h9HoMiuP2wBi/F6VXhAivH0FZ6gmRBC8IEcbLQ2IaflYXG1QToHUShIbASRgf8RK8QlsJCbXCANF6hbWGZ6gQ33YXkb6cBS4YG6K+AOm5dpwKwxNr2uLJYAm9N0t4QicIktArUEJPQb9/u+PEhX21E0KcAJv4MUCmeex/WYDfTK0qv3FeJL8DKLoUhaKLUTDG7UbJtf3ysptJsSIRnrBOjAjoNJTkjVNUnQSpzE/BuIAxlu5+zujmJ8l09f+x7epnZWzIME0ESFIL37sCjyxvi0e/kdB9gw3RZ+9l9+PkmUi77ddWgHcqOiGaZ4GZZjEL3IACdErZOMVMEx9W+e2SKby4W7QCIcLSq/tRcv2YfLK0IgC1zwOkU258Al43d5MF6AS59be1fj8K0HvTaLNWAqTtDQ79At0W/xFdv3JFl7WueHzRfTh8OEDedvvt1+pE6DudC0goAqSRgP0yPg+QaZAk2HRPhJ5ioTc2Jb/kM8GCLUg6twVF8UKIl/YICe6xyXF37RUjWlwJoturE4J73ewTMNrsTQjZ+Wyi9nX5NhERs7P2GJyaAqTnLL2+TyZy7zp4rvgLnl7RF8diNtcmPwWtjgFSpaSkoi728iM+/XSPnP6UQzR8JQjDqHAlCF1mZq7Ik8/zk9vyPGsrqDHRZJBJsytB6p58fCeUS/HUFqCS7ojyzHgcPrMDJy/uu01+BD22IS+FI9mR9AgSoXKbltPohK8FZhgVPgyh/gv/Z9T7QQCN5cMImsOHIVDqrTsUVo7/UQrkBMgwDH8cFidAhmFYgJwAGYZhAXICZBiGBcgJkGEYFiAnQIZhWICcABmGYQFyAmQYhgXICZBhGBYgJ0CGYTgBcgJkGIYTIAuQYRhOgCxAhmE4AbIAGYbhBMgCZBgWICdAFiDDsAA5AbIAGYYFyAnw9yDAuvUvSWp3p53xqSS1UnPnMAwLkBNgo/kDRnXp4pu2YEHG7j//eVzdnXGkc+fxBYsX6w+1bTtSSwG6SlJrexpyX7je5dxx/vz5C+pjwIAB3vyGZzgBqizAX1Pt/n6f58pLsy70W95vimoraKvw1q3fy/7wQyAkBIVr1ph2d+zoo9wX7e7uU755swnJySjftq10v02CmshPSEg8dQ+CbjekBG2Su63Ky8phMBhAIuQ3PcMJ0AECvGtmh95+1z7OS6g4gEjDajy8sNs4tQS4VZJmxru4wNC2LYpeeAE1y5ahaNUqU1THjmP3CcpWrzYhMhIIDwdOnkTFli03D3XqNFILAZL46Kv+CFdX12dlETaQBOsTIH0LGq1LXFy8/DNLkOEEqIEA233w8PNvRrwc5jaxY5fbkp9vZ6+Vet/syJwVCEhZiOCUpViV4Is2s9yHq/EH/F6Svj4nVvWGIEtQ1L49qidPRtny5ahYtAhYuRJYvRrYuBHYsgXYswenHnlksRZDUJIeCYe+I7ahJVifAC2C4pJixAsBUktCZAkynABVFGCrtz0Gzjk5yhhi/Agf/DBWL/m0d1dW4g/TOz+x9Py7Of7pvliin4DFlybii7hJeG3r4CRpQsdeKvwBnUQCfGCzJIVcEqtrEOQKjALT4MGwzJ4Ny5w5wLx5wJIlMH/9NU737h1Cv6OlAIf/7bkGl+CdhsD0nbgkv7j4eDkJErROLACGE+B/KEDXyZ08R+/tWTon7hn4nhuAhVdfxtv7RuilN/7kce87Dz45K+aVnHfO9oHP0e5460gfTI3xwiD/HnrJu0MfFY8ByhIMlqRtcZJkyRZPmy8oFlQ++ihqpk4F3n0XVXPmWI737LmNHku/o7UA60pQ62OCNgFabkuBYkl1tQlGIUFaF5IhT4ownADVSIDjPQZ6BnQoGHWoA0YeaIdh+1zwWkx7eO8Yen3i3mezR0Tfg/4REvqHSXgqVEKXL1tek3zc+6o9CUIlUqDHTlfXSxlOTnISLLBJsKJLF+DttxE/YsQFeoxWs8D1CdBeglqnwIEDB/rUJ0DYLaQhMCVCFiDDCVCtY4DjPZ5/6EuXTK9wCZ5hVtkN3dkCgyKc0S9EQr+tEvoK7lvuJpJh5ydUXUF7AbZoMe703XeXJounTRcoSZCGw5WPPYb8adNK7E+RaXoCHOQNs6UGP1fChixAhhOgmrPAPp1fuX+la86TwRJ6b5bwhE4QJKFXoISeAvcvWlyVvB/op7qhbaUTa3CoZcsqvXjKREGSbVKEJJgnKKQk2LcvcidPrtrh7u7TUAJsyCHwkKFDfCxmS7WS+BSsN24NhixAhhOg2qfB+LgP77DINfvRbyR032DDT0K7z9wSJW+PPpqsICU/Z+exu5ycqk+IpzsjoMmQK0TLlrgmhsNZtsmRPDc33OzTB4axY6t3deo0pqlNggwdOtTHbDabYAbMNTUwi+GujLhdU10jD3+VDMgCZDgBanEe4HiPkX/8rEV2169c0WWtK+6d53ZFGnufp2aGpvTn5vbP3e3b44izM2LFU9IpMWeE7La3br0jWJJ2XhQ/Z9gSYW6bNjB4eSGqc+cFWgqwoeXn5eXlNGTIEB9TVVUViY4mPUwmK3TMr4ZaOv4nsHACZDgBangitLfH848t7VrQ/fOu1++U/FQUIM0Adw5wc/tul5BgjIsLDgsRBru60mzvw4QYHm87azsuePnuuxF5773f0e80tROhSYBlpWUmuvKjvNxG2e0ICXICZDgBangliJPk7f5f9rO9WiZA6u97sb2Bbm6bQtu2hRDedtupLsqVIg8EimWHRHehTk6b6LGanAbj4EvhBg8e7G0sNtaUlJbgFm6WoLhEUFosnwJDEmQBMpwAm9aHITjZ0t6bou0mS/jW+7rZ7ntYua+pfRjCwIEDvU2mKnNlZRUqKiqE6MpQUV6ByopKVFeZ5GFxjYAnQRhOgE3z47Cc7PjZ+5rai5mG3B/Mnmv+cM48omb2R5/UzBYt/fzB7HmWD2fPtYj7QfCVIAwnQI0E2Ng3qqm+EJQheOs2LTtS26pNy06t2rh1anUPtS07yUNyBevxSi4uToAsQPCrhYuLEyALkIuLixNgoxYgFxcXV7NNgFxcXFycALm4uLg4AXJxcXE1kgTIMAzTFPh/7ilJ+J+MkXkAAAAASUVORK5CYII=") -256px 0 no-repeat}.jstree-default-large>.jstree-container-ul>.jstree-node{margin-left:0;margin-right:0}#jstree-dnd.jstree-default-large{line-height:32px;padding:0 4px}#jstree-dnd.jstree-default-large .jstree-ok,#jstree-dnd.jstree-default-large .jstree-er{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAYAAABsS6soAAAV40lEQVR42u2dCXQUVbrHKwsEHEWGYZkEVzZ1BEGQBHiAioqiPA++N4gkoKwiyBjGp+AIIjJHkGVgEFAgQSVJY4CQjSWsASGEfU06YctKks6eTkK2Trr/737VXbEJwW2q0jH5vnN+53aqO32rKt2//G/dqm4JgPRr4bLW/fd3BvfPxeW4199v8dctLmMBcnFx/V6LBcgJjBMgFydAFiAXFxcnQBYgJzBOgFycAFmAXFxcnABZgJzAOAFycQJkAXJxcXECZAFyAvsd9h8YGOhU3+3GUI1tfbSqpDPfoz7OHf6ylpM75iL36sYZnAC5uFSodevXISgoyKLT6Sy6oM1m0VYHbdbVBOno9maLuA9BdJ9OB/m2gH5H5f4VqD+zbX3MtnWoptubdWKZ9v3/ItTs315+5sqCn6ZcLxO1aVqDiMIhAmSsqPEfiPv/eegNnZySAmOxEUXGIhQVFaKQKCyC0VgolhejuFjcLqG2GAaDQZaAmv0Xi+cuLyuHsUj0L/rML8xHflEe8grzUGDMk9eJ1q9MPIYeq1b/VEr/NdXVP8mRxBhsuvwFtp7ZKvevlQBNhWkydPtOCZDQWoIOS4AM05BQ4srLzZdFl59fgPyCAhQJ2RQTJKbScllORE21SW7VF6ARZ9OOIvT6BpzN+AHnDcdwMSMW8VnHcT4rBhduHMP5GzE4Jx6jlQDlba+DIuYtpwPhf20eEioOINKwGh+um62NAG0JjwR4WyK03deQKdAhAlTzxaUGPXr0QHNKYMr+bywJUMv9T8fWxLDSnJWZibz8fDndEXl5NhGK5EWpj0SgyEBNARHB32+15Oflwz9hHnYWLsWewn/jbNk2XCgLx/mbYTh7czsOGb/GpcpIhF3bgLzcAojfUVWAe+MO4rPDs7DjQoi8/fYC1J34Fl8mvI/InBUISFmI4JSlWJXgizaz3IerKRtKd/aCqxVgHfFVFMTKNNkESH+Q4O+3oLHIz1ECdGAialb7XxekM2dmZsCQZUBaWhrS09ORlUUSzBUSyJdFWCAwKgIsVluAWyy5uXlYcWYmNmS8jYCcWYg0LkKUcRmiipdhd9FS7Cxagoj8xVh16u/IyctT7e9D9dlXn2PeqTEIMX6Ej2PexHf7gmoFuPW0DsvOz4R/ui+W6Cdg8aWJ+CJuEryDX4I0oWMvLQRIcqNW/tlOgIr4GkqADk2AtPMdnQTpjTd6jA+aYwJsTvtfpwuqyRACTE1LRUpKKlJT05CWfkNIMAs52dlChPny/iiwJSJjSZGq+2aLECBJbXa0DxYmjsKa9LewPmMK/DKnwS9rGjZkvgP/zL/hnwmj8OFBb+Tm5JIALWr07Tq5k+cbUU9iTtwz8D03AAuvvowZh0bg273in+CpQLwf8yreOdsHPke7460jfTA1xguvBg7B518tUV0+9gIk6iZCRYzNIgHSQVd60dFskyPffI4UoCMTYHPa/zTDmpGRiVQhP5oMSUpOkUWYlp6GLLGchoS5QlDykLC4WIsEiByRAP9vvzfmxr2EuQkv4dOEEZifOAKfJLwo5DQM00/1w/9GP4QJ4SPEY9UToDTeY+CQTQ9g1KEOGHmgHYbtc8FrMe3hHfk0Ju19DiOi70H/CAn9wyQ8FSrBc/2DiE08rckkCE1s2AtO+bm+9EdsWj666SZAZeaJXnwLFi6Bo958jSEB/tb2PxVg3f3fUP3faf9r1b9IgBZKeyQ9fYJecAXXk5JlGaaKITGRZchCdrb12JjRKCdAi5oCJMHO2j8ao6I98OaxnpgQ2xNvHXsc42MfEXLywNM7/oBBYXdhXNhw8dhcVYfAH636FH03dIJXuBBcmFV2Q3e2wKAIZ/QLkdBvq4S+gv5ruyI24VTtMVAtBEhiK72+r14B0nJ7tBZgs0yAyjGnunACbLr7n2SWJURPwouL1yM+Lh56/WUkXU8SaTDZOiwWEqRjhMrEgOoJMD8f40Kfw4BQN3iFtsSg8NZCeK0wKLQVPLe74CmBZ2gLeG9/Tp6sUVOAtC2hJ3bjL2v+hCeDJfTeLOEJnSBIQq9ACT0FvVbeh4PnY27Zfi3kl5P4DYou7pYFZ58IFenR/QpNOgE2hmNQzfi0kGa1/2k7KeHFxccjLs5KvBChXrQJCZeRnGSVYEpqmpyI6ZQVtQVI+9snYLS5q5+Ebn5O6LZRwiMbndDdXwIt6yrabv7OGLt9mPxYtQVIUlsfuQldl7fHo99I6L7Bhuj7saUP4cCZw/I+sG6/egJ0laTW1NLxPEWA9igSVH5OPfGvWpp0Amwss5DNVYDNaf/T9tIbW5GfPZQG4/XxSLEdFyS0EqD3ptHmbn4kHRdZgl1F293PWdx2hiJGeoxWAqTtXRO+EQ8u7oCuX7miy1pXdP/8QYQf3V277dbtV1GAdzl3JEiAlPDsBUfCo+WOEiCfB9iMBdjcttdegPG2Vh+nF6kwQW71cjrU3yIAta8E0e3VyYLzFklwnNy+bqZUSK28XBARs1PVE7EVAdJzKtsfdGAb+q3ohQErvLArdv8t8qP9pPSvmgBdXZ8l0SmJT7nigySnCNBefE0+ATKMI4b8ytUeZTdFe7MMN8usbVlZmXwFCB0XrRZocSWIMrSs72qMuldmqHkpniJARW4ETQjtOnUA0ReO1i6zhx6r5hC4rgDtcaQA+VpgplmgfBgADSvrwVJ3mfJhAGr3/xPrcEvfWvb/az4MQa0PLrEdB+xBQqsPToAMwzRKGqLuJEb+NBiGYZq8AB35eZQsQIZhmu1nd7IAGYbhBMgCZBiGEyALkGEYToAsQIZhAXICZAEyDAuQEyALkGFYgJwAWYCqfyYg98+wADkBMgzDAuQEyAmQ+2dYgJwAGYZhAXIC5ATI/TMsQE6ADMOwADkBcgLk/hkWICdAhmFYgJwAOQFy/42flG3vOBE3QqfLKD+zADkBMozqJG+cjN+Cmv2nbZv+I9tnmNNCZtYITOlWqtO2v2tJ2zbDojxG0/5/AUr/DVEfzJ4rfx3AgoVLMG7yLLklRo/x4e8E4QTI/ashgNLrsaguybmd4tuXVWTpVRUQCYWe11yZD1NBCqpuZsJUkonK4nRUltyAqdSA6nJal2yYKwrkx9LvqJXglP7pS59+ilOJ0Qi8vAih54Lk/hsqidH3jyjio2+tI/ERtIwTIMOoIEBTYaog7RasUiq4BRIBteoLMBtn044i4voGnM/4AZeyjiHOcBzxhlj59oUbR3E2/aj8GHqsFgKsu/32+2DL6UD4X5uHhIoDiDSshr//KNXlQ0KrD0V49gK0v79ZJMCG/q7aHj16gBPgj/07av83UAK0VGTGyW/4CoNeTniVWQmoIikW1SfDfLUFaKkqTIFf/FzsLFyCKONKnC0PwfmyCFwoj8SFigjsK/4SCaZd2H5trSxrtQUYrY/Csv0zcTh6jbz99hLUnfgWXya8j8icFQhIWYjglKVYleCLNrPch6stwPqK/unQV4KSAMPCbsgCpNI6BTaaBKh8HWBDvwEbiwQdTVPe/yl+U5ySv5liJgFWCOlVZMZbERKoyNajSgxJZREU3bCToMoCDJluqShIxspT72F95jQE5LyHSOPniCpeJrNbZil2GJdg6ckZqgsw3H8M5p0agxDjR/g45k0c/2F9rfxiozdg2fmZ8E/3xRL9BCy+NBFfxE3ClOBnIU3o2EsLATp7ht8GVUMLsFEkQOVLqx3xBqQd7GgJOjoBNvX9bxXgVFN5+gUhvXiUJZ9EOckwUy+nwcrsRJiEnEy2NGg9LpitsgBnmMvzr+Ef0T74LHEU1maMx7qsKfDLmgY/AzEdW/Pnivtege++v4r1UU+ArpM7efrs6Y05cc/A99wALLz6MmYcGoHYw+sQc3A93o95Fe+c7QOfo93x1pE+mBrjhdGBXojyH6vJELgxCdDhCZAOftKbjyKwo96AjUGCjqI57H8hQOeUb9+uLEs7h7LMS7iZdAI3k4+j/MZFVGRckqVYmS2SoSERVfmUitK1EWDeFcw56I1/xL2ITxKH49PLL2H+5RGYn/giPta/gGmn+mJkdAf4bB8mBJimXgIc7zFwWEBnjDrUASMPtMOwfS54LaY9vCOfxqS9z2FE9D3oHyGhf5iEp0IlDFrngdNXjmoyCcIJ0A7aWIPBUDsD5cg3oBpvQuW/yW9t1UqSv7RVe///2v7V3v8/IUCX5G+nVZannhHyO47ixP0ovXYQpUnHUJYi0mCGNRnKw2MhQvl4oFWAFrXO+UvfJgSYewUf7H8D/xN9PybE9sSkE70w8URPvHX8cfx3dEd4hbfEU2Eu8N7+nLwOag6BdV/9Ff3XdRB9SPAMs8pu6M4WGBThjH4hEvptldBXMHDtAzgbd1A+DNAcBNjsE2B9cAJsWvufEmDyt1OFAM+h9HoMiuP2wBi/F6VXhAivH0FZ6gmRBC8IEcbLQ2IaflYXG1QToHUShIbASRgf8RK8QlsJCbXCANF6hbWGZ6gQ33YXkb6cBS4YG6K+AOm5dpwKwxNr2uLJYAm9N0t4QicIktArUEJPQb9/u+PEhX21E0KcAJv4MUCmeex/WYDfTK0qv3FeJL8DKLoUhaKLUTDG7UbJtf3ysptJsSIRnrBOjAjoNJTkjVNUnQSpzE/BuIAxlu5+zujmJ8l09f+x7epnZWzIME0ESFIL37sCjyxvi0e/kdB9gw3RZ+9l9+PkmUi77ddWgHcqOiGaZ4GZZjEL3IACdErZOMVMEx9W+e2SKby4W7QCIcLSq/tRcv2YfLK0IgC1zwOkU258Al43d5MF6AS59be1fj8K0HvTaLNWAqTtDQ79At0W/xFdv3JFl7WueHzRfTh8OEDedvvt1+pE6DudC0goAqSRgP0yPg+QaZAk2HRPhJ5ioTc2Jb/kM8GCLUg6twVF8UKIl/YICe6xyXF37RUjWlwJoturE4J73ewTMNrsTQjZ+Wyi9nX5NhERs7P2GJyaAqTnLL2+TyZy7zp4rvgLnl7RF8diNtcmPwWtjgFSpaSkoi728iM+/XSPnP6UQzR8JQjDqHAlCF1mZq7Ik8/zk9vyPGsrqDHRZJBJsytB6p58fCeUS/HUFqCS7ojyzHgcPrMDJy/uu01+BD22IS+FI9mR9AgSoXKbltPohK8FZhgVPgyh/gv/Z9T7QQCN5cMImsOHIVDqrTsUVo7/UQrkBMgwDH8cFidAhmFYgJwAGYZhAXICZBiGBcgJkGEYFiAnQIZhWICcABmGYQFyAmQYhgXICZBhGBYgJ0CGYTgBcgJkGIYTIAuQYRhOgCxAhmE4AbIAGYbhBMgCZBgWICdAFiDDsAA5AbIAGYYFyAnw9yDAuvUvSWp3p53xqSS1UnPnMAwLkBNgo/kDRnXp4pu2YEHG7j//eVzdnXGkc+fxBYsX6w+1bTtSSwG6SlJrexpyX7je5dxx/vz5C+pjwIAB3vyGZzgBqizAX1Pt/n6f58pLsy70W95vimoraKvw1q3fy/7wQyAkBIVr1ph2d+zoo9wX7e7uU755swnJySjftq10v02CmshPSEg8dQ+CbjekBG2Su63Ky8phMBhAIuQ3PcMJ0AECvGtmh95+1z7OS6g4gEjDajy8sNs4tQS4VZJmxru4wNC2LYpeeAE1y5ahaNUqU1THjmP3CcpWrzYhMhIIDwdOnkTFli03D3XqNFILAZL46Kv+CFdX12dlETaQBOsTIH0LGq1LXFy8/DNLkOEEqIEA233w8PNvRrwc5jaxY5fbkp9vZ6+Vet/syJwVCEhZiOCUpViV4Is2s9yHq/EH/F6Svj4nVvWGIEtQ1L49qidPRtny5ahYtAhYuRJYvRrYuBHYsgXYswenHnlksRZDUJIeCYe+I7ahJVifAC2C4pJixAsBUktCZAkynABVFGCrtz0Gzjk5yhhi/Agf/DBWL/m0d1dW4g/TOz+x9Py7Of7pvliin4DFlybii7hJeG3r4CRpQsdeKvwBnUQCfGCzJIVcEqtrEOQKjALT4MGwzJ4Ny5w5wLx5wJIlMH/9NU737h1Cv6OlAIf/7bkGl+CdhsD0nbgkv7j4eDkJErROLACGE+B/KEDXyZ08R+/tWTon7hn4nhuAhVdfxtv7RuilN/7kce87Dz45K+aVnHfO9oHP0e5460gfTI3xwiD/HnrJu0MfFY8ByhIMlqRtcZJkyRZPmy8oFlQ++ihqpk4F3n0XVXPmWI737LmNHku/o7UA60pQ62OCNgFabkuBYkl1tQlGIUFaF5IhT4ownADVSIDjPQZ6BnQoGHWoA0YeaIdh+1zwWkx7eO8Yen3i3mezR0Tfg/4REvqHSXgqVEKXL1tek3zc+6o9CUIlUqDHTlfXSxlOTnISLLBJsKJLF+DttxE/YsQFeoxWs8D1CdBeglqnwIEDB/rUJ0DYLaQhMCVCFiDDCVCtY4DjPZ5/6EuXTK9wCZ5hVtkN3dkCgyKc0S9EQr+tEvoK7lvuJpJh5ydUXUF7AbZoMe703XeXJounTRcoSZCGw5WPPYb8adNK7E+RaXoCHOQNs6UGP1fChixAhhOgmrPAPp1fuX+la86TwRJ6b5bwhE4QJKFXoISeAvcvWlyVvB/op7qhbaUTa3CoZcsqvXjKREGSbVKEJJgnKKQk2LcvcidPrtrh7u7TUAJsyCHwkKFDfCxmS7WS+BSsN24NhixAhhOg2qfB+LgP77DINfvRbyR032DDT0K7z9wSJW+PPpqsICU/Z+exu5ycqk+IpzsjoMmQK0TLlrgmhsNZtsmRPDc33OzTB4axY6t3deo0pqlNggwdOtTHbDabYAbMNTUwi+GujLhdU10jD3+VDMgCZDgBanEe4HiPkX/8rEV2169c0WWtK+6d53ZFGnufp2aGpvTn5vbP3e3b44izM2LFU9IpMWeE7La3br0jWJJ2XhQ/Z9gSYW6bNjB4eSGqc+cFWgqwoeXn5eXlNGTIEB9TVVUViY4mPUwmK3TMr4ZaOv4nsHACZDgBangitLfH848t7VrQ/fOu1++U/FQUIM0Adw5wc/tul5BgjIsLDgsRBru60mzvw4QYHm87azsuePnuuxF5773f0e80tROhSYBlpWUmuvKjvNxG2e0ICXICZDgBangliJPk7f5f9rO9WiZA6u97sb2Bbm6bQtu2hRDedtupLsqVIg8EimWHRHehTk6b6LGanAbj4EvhBg8e7G0sNtaUlJbgFm6WoLhEUFosnwJDEmQBMpwAm9aHITjZ0t6bou0mS/jW+7rZ7ntYua+pfRjCwIEDvU2mKnNlZRUqKiqE6MpQUV6ByopKVFeZ5GFxjYAnQRhOgE3z47Cc7PjZ+5rai5mG3B/Mnmv+cM48omb2R5/UzBYt/fzB7HmWD2fPtYj7QfCVIAwnQI0E2Ng3qqm+EJQheOs2LTtS26pNy06t2rh1anUPtS07yUNyBevxSi4uToAsQPCrhYuLEyALkIuLixNgoxYgFxcXV7NNgFxcXFycALm4uLg4AXJxcXE1kgTIMAzTFPh/7ilJ+J+MkXkAAAAASUVORK5CYII=");background-repeat:no-repeat;background-color:transparent}#jstree-dnd.jstree-default-large i{background:transparent;width:32px;height:32px;line-height:32px}#jstree-dnd.jstree-default-large .jstree-ok{background-position:0 -64px}#jstree-dnd.jstree-default-large .jstree-er{background-position:-32px -64px}.jstree-default-large .jstree-ellipsis{overflow:hidden}.jstree-default-large .jstree-ellipsis .jstree-anchor{width:calc(100% - 32px + 5px);text-overflow:ellipsis;overflow:hidden}.jstree-default-large.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAACAQMAAAAD0EyKAAAABlBMVEUAAAAdHRvEkCwcAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjgIIGBgABCgCBvVLXcAAAAABJRU5ErkJggg==")}.jstree-default-large.jstree-rtl .jstree-last{background-image:none}@media (max-width:768px){#jstree-dnd.jstree-dnd-responsive{line-height:40px;font-weight:bold;font-size:1.1em;text-shadow:1px 1px white}#jstree-dnd.jstree-dnd-responsive>i{background:transparent;width:40px;height:40px}#jstree-dnd.jstree-dnd-responsive>.jstree-ok{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAHgCAMAAACsKhCPAAAARVBMVEUAAAAzMzP///////8zMzMzMzPt7e0zMzMzMzMzMzMzMzMzMzPS0tIzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzM8PDyWBIz0AAAAFXRSTlMAAAABAgYGCAoOFB0fIVBZXF38/f7YY/43AAAH/ElEQVR42u3d6brbKAyA4RBPZ82sLb3/S53OaZKx2YKNCJL5+NOeJX54YxsLoXAu16hdTDZ/rWsXwIABAwYMGDBgwIABAzYAvt3mAt+8v80E/uYVE1sAf3ilxAbAd6+QWD/46ZURqwevvCJi7eCNV0IsAPa+cHgv6hUQt4P/60be2yaOvO3iZvD3buS9LeKEdzj40Y+897i4h7cV/H9P8t6j4i7eRvC6L3nvMXEfbxt425u894i4k7cJHPYn790v7uVtAcc9ynv3irt5ZcE+7/VKvKKX9JOl2Cs5aD1hmr2Cj6UnTbVXLvAoNUVesdDSildq8mDGKzQ9FPNaAF8kvQYu6RdiPUG0ZE5L0qv8sfRCrGkiLJu1lPQqDi1fiHUls6Tz0pJepdPDS1ksnJBWuLYk6dWZ4pFO2+lP4kknZvWnaaVT7/oT8dKLK/qXWqSXz/QvpkkvkOpfLu3bbroHrd7iCUoe5itqma9sab7CtPlKD+crLp2vfFhZmhYwYMCAAQMGDBgwYMCAAQMGDBgwYMCAAQMGDBgwYMCAZwbfbnOBb8Kfp9IOvol+DsPLVl53AMsWFvmeYhGwaOmY7KdFuoBliwP1g4XKP/2uNhAsU+B78zvbbRRYqITbDFiqSN8yWHcEIn9JKxeLD1raxdKPJfVi4cDjsNjOY0lIbAssIDYGbhdbAzeLzYFbxfbAjWKD4DaxRXCT2CS4RQyYS5pBi8cSgQehJZMHpockAEjxCCXxDIFlkpaG15aOdWa6pRYW01gu1TponX5BXKjkwWrgcXgRzWhoeXzR0ObkoWGR1OT0sGVR2GICYKri0vnKh800wIABAwYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABAwYMGHAeLPsnxOWPJwuW3iCow5ZDkuCK3nkZrgi5GVzj3dPPbvtKCYHrvPX97LiTlgi41lvbz657hwmA6711/ey8W1ozeI+3pp/d94eTAlcRdpzgoz/vDX63V0QsAJby1gxvusF77zrt4No7bqfXt/7OKPDuUdUg+PDzyCh4/cWBp6Y58PqrI1GCNfD6y0NRkTHwmngsCjQLPhr1Wr2kD0f5Rget47Mam4+lhqSWycAjNyk+a2jZlMQzGUvnkh7nnTw0JC2NzpbS9/WZp4eHk7Rm58OpcXuGBABg82DxpJv5rOVZwWKJc/WJePGlEe1LLeKLX+oX08SXN7Uvl8ovYGtfEJcvUdBe8iBfhKK9qEW+zEh72dJFvpBMeWGaTI62wnwRaRSXAgYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABTwPuV4SiEdy1zEgfuHMhmTpw71JBbeDuxaDKwP3LfXWB31DQrQr8jpJ9leDswU8GfsvHbhSCi4c/Kzh3554KvIJlxyp91zRgwIABAwYMGDBgwLOApXMMnGHAgAEDBnwO8HRJvGnTtPMk4qdbaplvMW265dL5FsTnK3mYr6hlvrKly3SFaZdSaHlasJ0GGDBgwIABAwYMGDBgwIABAwYMGHD3DgIGDBgwYMCAAQMGDBiwRXCi1MEFDTBgwPbAfjqw/20y8Bf/y1zgz/4pngb8EM8DvosnAvufZgP7T7OB/c+zgb/dx7M8hx/t90kiLbE/Y29k8vDDo336ldkSYOPgP/9at7//OD1Y9uM89sBfZgP/Axgw4KnBevbTeg/4MtsZBgwYMGDAgAEDBgwYMGDAgAEDVgj+PBv4ZNs8mmuAAQMGDBgwYMCAAQMGDBgwYMAlsM0GGDBgwIABAwY8A3h524ssg6+A5wIvgPWAu1zBgAEDBjwM7Jy7ujnAj+0RznCGPyD+q1v17UPmEuDwhT79DvjV+6ML/OiY99/Ebvno41N2///qF8PXbXbIeB5s9W2t4I/6w68r8P2nATh83XZPkPW79/i2UvC94vLrE7z5+fY/69tguwvK5t27f1sneLuDSxYcvi7c92X77t0PpgjsnAt6+L2T1/Davf8bjVfhTjfhu+eVgsNdeq7hxXu/nYMXx3v7XKOjqQRH+xJFJzMJTuxmdI2PphAcF4tnQqntd1P7N10TR1MHTuw8lZFuz3tqx6pr+mgqwM7lzm8UPD6fyds7O2VLH00TOLmzWDxdSD6Ia7Yq0TNo7ffGoVaNVxc47uHyCuwyD+KcVwPYFe7fEOwisEuGWlmvJnCqh0sUc0RgV75GouhrFDgMeNP37xJFlTHYlUeBML5+N3jF2+zrmO7hEs0bEmBXHueDGdQYcLSZZaaHS3CThnF11Z2xnSMPAUfdyPVwCVMaV5cY7V6NfZssyAhw1JFsDxcXprDcyzSeK+6LOgIcdSXfwyUakl0ujaf3DEddyUYIYdYyedeqv4ejruQjhBrw62h88ChdFeHXg19H48Ofw5XeLdhlwK+j8fGRlqvzbsAuA84P/4pi6RfdcglwZhGplLZUNFsqdyx4tC7ZG3jvGzluPly89Fw92O0eHAZlPEqDi2sAp46WzgiOALvSPbZqpb65l14dWct8gOB2gt2RvPQwsCvFG5Vgd2DlYRzYlcfnKrDbv7Y0EOyK43MdOJe0zK8ejkrEp7pyBJxOWhbWh4eCXfl6rgKnkpalCoCxYFe8nuvA95xAbY3HYLArXc+V4DBpWa7iGQ12Yf6lHpy5ZlwK7NZv6rCVh+8d+LFUT7cf7F6vnlNc2g+8HGt2wVcVp9w+uPsVwxlWDl4A2wFPN0qPaYABAwYMGLBB8L86UddPrrT/8QAAAABJRU5ErkJggg==");background-position:0 -200px;background-size:120px 240px}#jstree-dnd.jstree-dnd-responsive>.jstree-er{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAHgCAMAAACsKhCPAAAARVBMVEUAAAAzMzP///////8zMzMzMzPt7e0zMzMzMzMzMzMzMzMzMzPS0tIzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzM8PDyWBIz0AAAAFXRSTlMAAAABAgYGCAoOFB0fIVBZXF38/f7YY/43AAAH/ElEQVR42u3d6brbKAyA4RBPZ82sLb3/S53OaZKx2YKNCJL5+NOeJX54YxsLoXAu16hdTDZ/rWsXwIABAwYMGDBgwIABAzYAvt3mAt+8v80E/uYVE1sAf3ilxAbAd6+QWD/46ZURqwevvCJi7eCNV0IsAPa+cHgv6hUQt4P/60be2yaOvO3iZvD3buS9LeKEdzj40Y+897i4h7cV/H9P8t6j4i7eRvC6L3nvMXEfbxt425u894i4k7cJHPYn790v7uVtAcc9ynv3irt5ZcE+7/VKvKKX9JOl2Cs5aD1hmr2Cj6UnTbVXLvAoNUVesdDSildq8mDGKzQ9FPNaAF8kvQYu6RdiPUG0ZE5L0qv8sfRCrGkiLJu1lPQqDi1fiHUls6Tz0pJepdPDS1ksnJBWuLYk6dWZ4pFO2+lP4kknZvWnaaVT7/oT8dKLK/qXWqSXz/QvpkkvkOpfLu3bbroHrd7iCUoe5itqma9sab7CtPlKD+crLp2vfFhZmhYwYMCAAQMGDBgwYMCAAQMGDBgwYMCAAQMGDBgwYMCAZwbfbnOBb8Kfp9IOvol+DsPLVl53AMsWFvmeYhGwaOmY7KdFuoBliwP1g4XKP/2uNhAsU+B78zvbbRRYqITbDFiqSN8yWHcEIn9JKxeLD1raxdKPJfVi4cDjsNjOY0lIbAssIDYGbhdbAzeLzYFbxfbAjWKD4DaxRXCT2CS4RQyYS5pBi8cSgQehJZMHpockAEjxCCXxDIFlkpaG15aOdWa6pRYW01gu1TponX5BXKjkwWrgcXgRzWhoeXzR0ObkoWGR1OT0sGVR2GICYKri0vnKh800wIABAwYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABAwYMGHAeLPsnxOWPJwuW3iCow5ZDkuCK3nkZrgi5GVzj3dPPbvtKCYHrvPX97LiTlgi41lvbz657hwmA6711/ey8W1ozeI+3pp/d94eTAlcRdpzgoz/vDX63V0QsAJby1gxvusF77zrt4No7bqfXt/7OKPDuUdUg+PDzyCh4/cWBp6Y58PqrI1GCNfD6y0NRkTHwmngsCjQLPhr1Wr2kD0f5Rget47Mam4+lhqSWycAjNyk+a2jZlMQzGUvnkh7nnTw0JC2NzpbS9/WZp4eHk7Rm58OpcXuGBABg82DxpJv5rOVZwWKJc/WJePGlEe1LLeKLX+oX08SXN7Uvl8ovYGtfEJcvUdBe8iBfhKK9qEW+zEh72dJFvpBMeWGaTI62wnwRaRSXAgYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABTwPuV4SiEdy1zEgfuHMhmTpw71JBbeDuxaDKwP3LfXWB31DQrQr8jpJ9leDswU8GfsvHbhSCi4c/Kzh3554KvIJlxyp91zRgwIABAwYMGDBgwLOApXMMnGHAgAEDBnwO8HRJvGnTtPMk4qdbaplvMW265dL5FsTnK3mYr6hlvrKly3SFaZdSaHlasJ0GGDBgwIABAwYMGDBgwIABAwYMGHD3DgIGDBgwYMCAAQMGDBiwRXCi1MEFDTBgwPbAfjqw/20y8Bf/y1zgz/4pngb8EM8DvosnAvufZgP7T7OB/c+zgb/dx7M8hx/t90kiLbE/Y29k8vDDo336ldkSYOPgP/9at7//OD1Y9uM89sBfZgP/Axgw4KnBevbTeg/4MtsZBgwYMGDAgAEDBgwYMGDAgAEDVgj+PBv4ZNs8mmuAAQMGDBgwYMCAAQMGDBgwYMAlsM0GGDBgwIABAwY8A3h524ssg6+A5wIvgPWAu1zBgAEDBjwM7Jy7ujnAj+0RznCGPyD+q1v17UPmEuDwhT79DvjV+6ML/OiY99/Ebvno41N2///qF8PXbXbIeB5s9W2t4I/6w68r8P2nATh83XZPkPW79/i2UvC94vLrE7z5+fY/69tguwvK5t27f1sneLuDSxYcvi7c92X77t0PpgjsnAt6+L2T1/Davf8bjVfhTjfhu+eVgsNdeq7hxXu/nYMXx3v7XKOjqQRH+xJFJzMJTuxmdI2PphAcF4tnQqntd1P7N10TR1MHTuw8lZFuz3tqx6pr+mgqwM7lzm8UPD6fyds7O2VLH00TOLmzWDxdSD6Ia7Yq0TNo7ffGoVaNVxc47uHyCuwyD+KcVwPYFe7fEOwisEuGWlmvJnCqh0sUc0RgV75GouhrFDgMeNP37xJFlTHYlUeBML5+N3jF2+zrmO7hEs0bEmBXHueDGdQYcLSZZaaHS3CThnF11Z2xnSMPAUfdyPVwCVMaV5cY7V6NfZssyAhw1JFsDxcXprDcyzSeK+6LOgIcdSXfwyUakl0ujaf3DEddyUYIYdYyedeqv4ejruQjhBrw62h88ChdFeHXg19H48Ofw5XeLdhlwK+j8fGRlqvzbsAuA84P/4pi6RfdcglwZhGplLZUNFsqdyx4tC7ZG3jvGzluPly89Fw92O0eHAZlPEqDi2sAp46WzgiOALvSPbZqpb65l14dWct8gOB2gt2RvPQwsCvFG5Vgd2DlYRzYlcfnKrDbv7Y0EOyK43MdOJe0zK8ejkrEp7pyBJxOWhbWh4eCXfl6rgKnkpalCoCxYFe8nuvA95xAbY3HYLArXc+V4DBpWa7iGQ12Yf6lHpy5ZlwK7NZv6rCVh+8d+LFUT7cf7F6vnlNc2g+8HGt2wVcVp9w+uPsVwxlWDl4A2wFPN0qPaYABAwYMGLBB8L86UddPrrT/8QAAAABJRU5ErkJggg==");background-position:-40px -200px;background-size:120px 240px}#jstree-marker.jstree-dnd-responsive{border-left-width:10px;border-top-width:10px;border-bottom-width:10px;margin-top:-10px}}@media (max-width:768px){.jstree-default-responsive .jstree-icon{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAHgCAMAAACsKhCPAAAARVBMVEUAAAAzMzP///////8zMzMzMzPt7e0zMzMzMzMzMzMzMzMzMzPS0tIzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzM8PDyWBIz0AAAAFXRSTlMAAAABAgYGCAoOFB0fIVBZXF38/f7YY/43AAAH/ElEQVR42u3d6brbKAyA4RBPZ82sLb3/S53OaZKx2YKNCJL5+NOeJX54YxsLoXAu16hdTDZ/rWsXwIABAwYMGDBgwIABAzYAvt3mAt+8v80E/uYVE1sAf3ilxAbAd6+QWD/46ZURqwevvCJi7eCNV0IsAPa+cHgv6hUQt4P/60be2yaOvO3iZvD3buS9LeKEdzj40Y+897i4h7cV/H9P8t6j4i7eRvC6L3nvMXEfbxt425u894i4k7cJHPYn790v7uVtAcc9ynv3irt5ZcE+7/VKvKKX9JOl2Cs5aD1hmr2Cj6UnTbVXLvAoNUVesdDSildq8mDGKzQ9FPNaAF8kvQYu6RdiPUG0ZE5L0qv8sfRCrGkiLJu1lPQqDi1fiHUls6Tz0pJepdPDS1ksnJBWuLYk6dWZ4pFO2+lP4kknZvWnaaVT7/oT8dKLK/qXWqSXz/QvpkkvkOpfLu3bbroHrd7iCUoe5itqma9sab7CtPlKD+crLp2vfFhZmhYwYMCAAQMGDBgwYMCAAQMGDBgwYMCAAQMGDBgwYMCAZwbfbnOBb8Kfp9IOvol+DsPLVl53AMsWFvmeYhGwaOmY7KdFuoBliwP1g4XKP/2uNhAsU+B78zvbbRRYqITbDFiqSN8yWHcEIn9JKxeLD1raxdKPJfVi4cDjsNjOY0lIbAssIDYGbhdbAzeLzYFbxfbAjWKD4DaxRXCT2CS4RQyYS5pBi8cSgQehJZMHpockAEjxCCXxDIFlkpaG15aOdWa6pRYW01gu1TponX5BXKjkwWrgcXgRzWhoeXzR0ObkoWGR1OT0sGVR2GICYKri0vnKh800wIABAwYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABAwYMGHAeLPsnxOWPJwuW3iCow5ZDkuCK3nkZrgi5GVzj3dPPbvtKCYHrvPX97LiTlgi41lvbz657hwmA6711/ey8W1ozeI+3pp/d94eTAlcRdpzgoz/vDX63V0QsAJby1gxvusF77zrt4No7bqfXt/7OKPDuUdUg+PDzyCh4/cWBp6Y58PqrI1GCNfD6y0NRkTHwmngsCjQLPhr1Wr2kD0f5Rget47Mam4+lhqSWycAjNyk+a2jZlMQzGUvnkh7nnTw0JC2NzpbS9/WZp4eHk7Rm58OpcXuGBABg82DxpJv5rOVZwWKJc/WJePGlEe1LLeKLX+oX08SXN7Uvl8ovYGtfEJcvUdBe8iBfhKK9qEW+zEh72dJFvpBMeWGaTI62wnwRaRSXAgYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABTwPuV4SiEdy1zEgfuHMhmTpw71JBbeDuxaDKwP3LfXWB31DQrQr8jpJ9leDswU8GfsvHbhSCi4c/Kzh3554KvIJlxyp91zRgwIABAwYMGDBgwLOApXMMnGHAgAEDBnwO8HRJvGnTtPMk4qdbaplvMW265dL5FsTnK3mYr6hlvrKly3SFaZdSaHlasJ0GGDBgwIABAwYMGDBgwIABAwYMGHD3DgIGDBgwYMCAAQMGDBiwRXCi1MEFDTBgwPbAfjqw/20y8Bf/y1zgz/4pngb8EM8DvosnAvufZgP7T7OB/c+zgb/dx7M8hx/t90kiLbE/Y29k8vDDo336ldkSYOPgP/9at7//OD1Y9uM89sBfZgP/Axgw4KnBevbTeg/4MtsZBgwYMGDAgAEDBgwYMGDAgAEDVgj+PBv4ZNs8mmuAAQMGDBgwYMCAAQMGDBgwYMAlsM0GGDBgwIABAwY8A3h524ssg6+A5wIvgPWAu1zBgAEDBjwM7Jy7ujnAj+0RznCGPyD+q1v17UPmEuDwhT79DvjV+6ML/OiY99/Ebvno41N2///qF8PXbXbIeB5s9W2t4I/6w68r8P2nATh83XZPkPW79/i2UvC94vLrE7z5+fY/69tguwvK5t27f1sneLuDSxYcvi7c92X77t0PpgjsnAt6+L2T1/Davf8bjVfhTjfhu+eVgsNdeq7hxXu/nYMXx3v7XKOjqQRH+xJFJzMJTuxmdI2PphAcF4tnQqntd1P7N10TR1MHTuw8lZFuz3tqx6pr+mgqwM7lzm8UPD6fyds7O2VLH00TOLmzWDxdSD6Ia7Yq0TNo7ffGoVaNVxc47uHyCuwyD+KcVwPYFe7fEOwisEuGWlmvJnCqh0sUc0RgV75GouhrFDgMeNP37xJFlTHYlUeBML5+N3jF2+zrmO7hEs0bEmBXHueDGdQYcLSZZaaHS3CThnF11Z2xnSMPAUfdyPVwCVMaV5cY7V6NfZssyAhw1JFsDxcXprDcyzSeK+6LOgIcdSXfwyUakl0ujaf3DEddyUYIYdYyedeqv4ejruQjhBrw62h88ChdFeHXg19H48Ofw5XeLdhlwK+j8fGRlqvzbsAuA84P/4pi6RfdcglwZhGplLZUNFsqdyx4tC7ZG3jvGzluPly89Fw92O0eHAZlPEqDi2sAp46WzgiOALvSPbZqpb65l14dWct8gOB2gt2RvPQwsCvFG5Vgd2DlYRzYlcfnKrDbv7Y0EOyK43MdOJe0zK8ejkrEp7pyBJxOWhbWh4eCXfl6rgKnkpalCoCxYFe8nuvA95xAbY3HYLArXc+V4DBpWa7iGQ12Yf6lHpy5ZlwK7NZv6rCVh+8d+LFUT7cf7F6vnlNc2g+8HGt2wVcVp9w+uPsVwxlWDl4A2wFPN0qPaYABAwYMGLBB8L86UddPrrT/8QAAAABJRU5ErkJggg==")}.jstree-default-responsive .jstree-node,.jstree-default-responsive .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-responsive .jstree-node{min-height:40px;line-height:40px;margin-left:40px;min-width:40px;white-space:nowrap}.jstree-default-responsive .jstree-anchor{line-height:40px;height:40px}.jstree-default-responsive .jstree-icon,.jstree-default-responsive .jstree-icon:empty{width:40px;height:40px;line-height:40px}.jstree-default-responsive>.jstree-container-ul>.jstree-node{margin-left:0}.jstree-default-responsive.jstree-rtl .jstree-node{margin-left:0;margin-right:40px;background:transparent}.jstree-default-responsive.jstree-rtl .jstree-container-ul>.jstree-node{margin-right:0}.jstree-default-responsive .jstree-ocl,.jstree-default-responsive .jstree-themeicon,.jstree-default-responsive .jstree-checkbox{background-size:120px 240px}.jstree-default-responsive .jstree-leaf>.jstree-ocl,.jstree-default-responsive.jstree-rtl .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-responsive .jstree-open>.jstree-ocl{background-position:0 0 !important}.jstree-default-responsive .jstree-closed>.jstree-ocl{background-position:0 -40px !important}.jstree-default-responsive.jstree-rtl .jstree-closed>.jstree-ocl{background-position:-40px 0 !important}.jstree-default-responsive .jstree-themeicon{background-position:-40px -40px}.jstree-default-responsive .jstree-checkbox,.jstree-default-responsive .jstree-checkbox:hover{background-position:-40px -80px}.jstree-default-responsive.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox,.jstree-default-responsive.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox:hover,.jstree-default-responsive .jstree-checked>.jstree-checkbox,.jstree-default-responsive .jstree-checked>.jstree-checkbox:hover{background-position:0 -80px}.jstree-default-responsive .jstree-anchor>.jstree-undetermined,.jstree-default-responsive .jstree-anchor>.jstree-undetermined:hover{background-position:0 -120px}.jstree-default-responsive .jstree-anchor{font-weight:bold;font-size:1.1em;text-shadow:1px 1px white}.jstree-default-responsive>.jstree-striped{background:transparent}.jstree-default-responsive .jstree-wholerow{border-top:1px solid rgba(255,255,255,0.7);border-bottom:1px solid rgba(64,64,64,0.2);background:#ebebeb;height:40px}.jstree-default-responsive .jstree-wholerow-hovered{background:#e7f4f9}.jstree-default-responsive .jstree-wholerow-clicked{background:#beebff}.jstree-default-responsive .jstree-children .jstree-last>.jstree-wholerow{box-shadow:inset 0 -6px 3px -5px #666666}.jstree-default-responsive .jstree-children .jstree-open>.jstree-wholerow{box-shadow:inset 0 6px 3px -5px #666666;border-top:0}.jstree-default-responsive .jstree-children .jstree-open+.jstree-open{box-shadow:none}.jstree-default-responsive .jstree-node,.jstree-default-responsive .jstree-icon,.jstree-default-responsive .jstree-node>.jstree-ocl,.jstree-default-responsive .jstree-themeicon,.jstree-default-responsive .jstree-checkbox{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAHgCAMAAACsKhCPAAAARVBMVEUAAAAzMzP///////8zMzMzMzPt7e0zMzMzMzMzMzMzMzMzMzPS0tIzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzM8PDyWBIz0AAAAFXRSTlMAAAABAgYGCAoOFB0fIVBZXF38/f7YY/43AAAH/ElEQVR42u3d6brbKAyA4RBPZ82sLb3/S53OaZKx2YKNCJL5+NOeJX54YxsLoXAu16hdTDZ/rWsXwIABAwYMGDBgwIABAzYAvt3mAt+8v80E/uYVE1sAf3ilxAbAd6+QWD/46ZURqwevvCJi7eCNV0IsAPa+cHgv6hUQt4P/60be2yaOvO3iZvD3buS9LeKEdzj40Y+897i4h7cV/H9P8t6j4i7eRvC6L3nvMXEfbxt425u894i4k7cJHPYn790v7uVtAcc9ynv3irt5ZcE+7/VKvKKX9JOl2Cs5aD1hmr2Cj6UnTbVXLvAoNUVesdDSildq8mDGKzQ9FPNaAF8kvQYu6RdiPUG0ZE5L0qv8sfRCrGkiLJu1lPQqDi1fiHUls6Tz0pJepdPDS1ksnJBWuLYk6dWZ4pFO2+lP4kknZvWnaaVT7/oT8dKLK/qXWqSXz/QvpkkvkOpfLu3bbroHrd7iCUoe5itqma9sab7CtPlKD+crLp2vfFhZmhYwYMCAAQMGDBgwYMCAAQMGDBgwYMCAAQMGDBgwYMCAZwbfbnOBb8Kfp9IOvol+DsPLVl53AMsWFvmeYhGwaOmY7KdFuoBliwP1g4XKP/2uNhAsU+B78zvbbRRYqITbDFiqSN8yWHcEIn9JKxeLD1raxdKPJfVi4cDjsNjOY0lIbAssIDYGbhdbAzeLzYFbxfbAjWKD4DaxRXCT2CS4RQyYS5pBi8cSgQehJZMHpockAEjxCCXxDIFlkpaG15aOdWa6pRYW01gu1TponX5BXKjkwWrgcXgRzWhoeXzR0ObkoWGR1OT0sGVR2GICYKri0vnKh800wIABAwYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABAwYMGHAeLPsnxOWPJwuW3iCow5ZDkuCK3nkZrgi5GVzj3dPPbvtKCYHrvPX97LiTlgi41lvbz657hwmA6711/ey8W1ozeI+3pp/d94eTAlcRdpzgoz/vDX63V0QsAJby1gxvusF77zrt4No7bqfXt/7OKPDuUdUg+PDzyCh4/cWBp6Y58PqrI1GCNfD6y0NRkTHwmngsCjQLPhr1Wr2kD0f5Rget47Mam4+lhqSWycAjNyk+a2jZlMQzGUvnkh7nnTw0JC2NzpbS9/WZp4eHk7Rm58OpcXuGBABg82DxpJv5rOVZwWKJc/WJePGlEe1LLeKLX+oX08SXN7Uvl8ovYGtfEJcvUdBe8iBfhKK9qEW+zEh72dJFvpBMeWGaTI62wnwRaRSXAgYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABTwPuV4SiEdy1zEgfuHMhmTpw71JBbeDuxaDKwP3LfXWB31DQrQr8jpJ9leDswU8GfsvHbhSCi4c/Kzh3554KvIJlxyp91zRgwIABAwYMGDBgwLOApXMMnGHAgAEDBnwO8HRJvGnTtPMk4qdbaplvMW265dL5FsTnK3mYr6hlvrKly3SFaZdSaHlasJ0GGDBgwIABAwYMGDBgwIABAwYMGHD3DgIGDBgwYMCAAQMGDBiwRXCi1MEFDTBgwPbAfjqw/20y8Bf/y1zgz/4pngb8EM8DvosnAvufZgP7T7OB/c+zgb/dx7M8hx/t90kiLbE/Y29k8vDDo336ldkSYOPgP/9at7//OD1Y9uM89sBfZgP/Axgw4KnBevbTeg/4MtsZBgwYMGDAgAEDBgwYMGDAgAEDVgj+PBv4ZNs8mmuAAQMGDBgwYMCAAQMGDBgwYMAlsM0GGDBgwIABAwY8A3h524ssg6+A5wIvgPWAu1zBgAEDBjwM7Jy7ujnAj+0RznCGPyD+q1v17UPmEuDwhT79DvjV+6ML/OiY99/Ebvno41N2///qF8PXbXbIeB5s9W2t4I/6w68r8P2nATh83XZPkPW79/i2UvC94vLrE7z5+fY/69tguwvK5t27f1sneLuDSxYcvi7c92X77t0PpgjsnAt6+L2T1/Davf8bjVfhTjfhu+eVgsNdeq7hxXu/nYMXx3v7XKOjqQRH+xJFJzMJTuxmdI2PphAcF4tnQqntd1P7N10TR1MHTuw8lZFuz3tqx6pr+mgqwM7lzm8UPD6fyds7O2VLH00TOLmzWDxdSD6Ia7Yq0TNo7ffGoVaNVxc47uHyCuwyD+KcVwPYFe7fEOwisEuGWlmvJnCqh0sUc0RgV75GouhrFDgMeNP37xJFlTHYlUeBML5+N3jF2+zrmO7hEs0bEmBXHueDGdQYcLSZZaaHS3CThnF11Z2xnSMPAUfdyPVwCVMaV5cY7V6NfZssyAhw1JFsDxcXprDcyzSeK+6LOgIcdSXfwyUakl0ujaf3DEddyUYIYdYyedeqv4ejruQjhBrw62h88ChdFeHXg19H48Ofw5XeLdhlwK+j8fGRlqvzbsAuA84P/4pi6RfdcglwZhGplLZUNFsqdyx4tC7ZG3jvGzluPly89Fw92O0eHAZlPEqDi2sAp46WzgiOALvSPbZqpb65l14dWct8gOB2gt2RvPQwsCvFG5Vgd2DlYRzYlcfnKrDbv7Y0EOyK43MdOJe0zK8ejkrEp7pyBJxOWhbWh4eCXfl6rgKnkpalCoCxYFe8nuvA95xAbY3HYLArXc+V4DBpWa7iGQ12Yf6lHpy5ZlwK7NZv6rCVh+8d+LFUT7cf7F6vnlNc2g+8HGt2wVcVp9w+uPsVwxlWDl4A2wFPN0qPaYABAwYMGLBB8L86UddPrrT/8QAAAABJRU5ErkJggg==");background-size:120px 240px}.jstree-default-responsive .jstree-node{background-position:-80px 0;background-repeat:repeat-y}.jstree-default-responsive .jstree-last{background-image:none}.jstree-default-responsive .jstree-leaf>.jstree-ocl{background-position:-40px -120px}.jstree-default-responsive .jstree-last>.jstree-ocl{background-position:-40px -160px}.jstree-default-responsive .jstree-themeicon-custom{background-color:transparent;background-image:none;background-position:0 0}.jstree-default-responsive .jstree-file{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAHgCAMAAACsKhCPAAAARVBMVEUAAAAzMzP///////8zMzMzMzPt7e0zMzMzMzMzMzMzMzMzMzPS0tIzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzM8PDyWBIz0AAAAFXRSTlMAAAABAgYGCAoOFB0fIVBZXF38/f7YY/43AAAH/ElEQVR42u3d6brbKAyA4RBPZ82sLb3/S53OaZKx2YKNCJL5+NOeJX54YxsLoXAu16hdTDZ/rWsXwIABAwYMGDBgwIABAzYAvt3mAt+8v80E/uYVE1sAf3ilxAbAd6+QWD/46ZURqwevvCJi7eCNV0IsAPa+cHgv6hUQt4P/60be2yaOvO3iZvD3buS9LeKEdzj40Y+897i4h7cV/H9P8t6j4i7eRvC6L3nvMXEfbxt425u894i4k7cJHPYn790v7uVtAcc9ynv3irt5ZcE+7/VKvKKX9JOl2Cs5aD1hmr2Cj6UnTbVXLvAoNUVesdDSildq8mDGKzQ9FPNaAF8kvQYu6RdiPUG0ZE5L0qv8sfRCrGkiLJu1lPQqDi1fiHUls6Tz0pJepdPDS1ksnJBWuLYk6dWZ4pFO2+lP4kknZvWnaaVT7/oT8dKLK/qXWqSXz/QvpkkvkOpfLu3bbroHrd7iCUoe5itqma9sab7CtPlKD+crLp2vfFhZmhYwYMCAAQMGDBgwYMCAAQMGDBgwYMCAAQMGDBgwYMCAZwbfbnOBb8Kfp9IOvol+DsPLVl53AMsWFvmeYhGwaOmY7KdFuoBliwP1g4XKP/2uNhAsU+B78zvbbRRYqITbDFiqSN8yWHcEIn9JKxeLD1raxdKPJfVi4cDjsNjOY0lIbAssIDYGbhdbAzeLzYFbxfbAjWKD4DaxRXCT2CS4RQyYS5pBi8cSgQehJZMHpockAEjxCCXxDIFlkpaG15aOdWa6pRYW01gu1TponX5BXKjkwWrgcXgRzWhoeXzR0ObkoWGR1OT0sGVR2GICYKri0vnKh800wIABAwYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABAwYMGHAeLPsnxOWPJwuW3iCow5ZDkuCK3nkZrgi5GVzj3dPPbvtKCYHrvPX97LiTlgi41lvbz657hwmA6711/ey8W1ozeI+3pp/d94eTAlcRdpzgoz/vDX63V0QsAJby1gxvusF77zrt4No7bqfXt/7OKPDuUdUg+PDzyCh4/cWBp6Y58PqrI1GCNfD6y0NRkTHwmngsCjQLPhr1Wr2kD0f5Rget47Mam4+lhqSWycAjNyk+a2jZlMQzGUvnkh7nnTw0JC2NzpbS9/WZp4eHk7Rm58OpcXuGBABg82DxpJv5rOVZwWKJc/WJePGlEe1LLeKLX+oX08SXN7Uvl8ovYGtfEJcvUdBe8iBfhKK9qEW+zEh72dJFvpBMeWGaTI62wnwRaRSXAgYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABTwPuV4SiEdy1zEgfuHMhmTpw71JBbeDuxaDKwP3LfXWB31DQrQr8jpJ9leDswU8GfsvHbhSCi4c/Kzh3554KvIJlxyp91zRgwIABAwYMGDBgwLOApXMMnGHAgAEDBnwO8HRJvGnTtPMk4qdbaplvMW265dL5FsTnK3mYr6hlvrKly3SFaZdSaHlasJ0GGDBgwIABAwYMGDBgwIABAwYMGHD3DgIGDBgwYMCAAQMGDBiwRXCi1MEFDTBgwPbAfjqw/20y8Bf/y1zgz/4pngb8EM8DvosnAvufZgP7T7OB/c+zgb/dx7M8hx/t90kiLbE/Y29k8vDDo336ldkSYOPgP/9at7//OD1Y9uM89sBfZgP/Axgw4KnBevbTeg/4MtsZBgwYMGDAgAEDBgwYMGDAgAEDVgj+PBv4ZNs8mmuAAQMGDBgwYMCAAQMGDBgwYMAlsM0GGDBgwIABAwY8A3h524ssg6+A5wIvgPWAu1zBgAEDBjwM7Jy7ujnAj+0RznCGPyD+q1v17UPmEuDwhT79DvjV+6ML/OiY99/Ebvno41N2///qF8PXbXbIeB5s9W2t4I/6w68r8P2nATh83XZPkPW79/i2UvC94vLrE7z5+fY/69tguwvK5t27f1sneLuDSxYcvi7c92X77t0PpgjsnAt6+L2T1/Davf8bjVfhTjfhu+eVgsNdeq7hxXu/nYMXx3v7XKOjqQRH+xJFJzMJTuxmdI2PphAcF4tnQqntd1P7N10TR1MHTuw8lZFuz3tqx6pr+mgqwM7lzm8UPD6fyds7O2VLH00TOLmzWDxdSD6Ia7Yq0TNo7ffGoVaNVxc47uHyCuwyD+KcVwPYFe7fEOwisEuGWlmvJnCqh0sUc0RgV75GouhrFDgMeNP37xJFlTHYlUeBML5+N3jF2+zrmO7hEs0bEmBXHueDGdQYcLSZZaaHS3CThnF11Z2xnSMPAUfdyPVwCVMaV5cY7V6NfZssyAhw1JFsDxcXprDcyzSeK+6LOgIcdSXfwyUakl0ujaf3DEddyUYIYdYyedeqv4ejruQjhBrw62h88ChdFeHXg19H48Ofw5XeLdhlwK+j8fGRlqvzbsAuA84P/4pi6RfdcglwZhGplLZUNFsqdyx4tC7ZG3jvGzluPly89Fw92O0eHAZlPEqDi2sAp46WzgiOALvSPbZqpb65l14dWct8gOB2gt2RvPQwsCvFG5Vgd2DlYRzYlcfnKrDbv7Y0EOyK43MdOJe0zK8ejkrEp7pyBJxOWhbWh4eCXfl6rgKnkpalCoCxYFe8nuvA95xAbY3HYLArXc+V4DBpWa7iGQ12Yf6lHpy5ZlwK7NZv6rCVh+8d+LFUT7cf7F6vnlNc2g+8HGt2wVcVp9w+uPsVwxlWDl4A2wFPN0qPaYABAwYMGLBB8L86UddPrrT/8QAAAABJRU5ErkJggg==") 0 -160px no-repeat;background-size:120px 240px}.jstree-default-responsive .jstree-folder{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAHgCAMAAACsKhCPAAAARVBMVEUAAAAzMzP///////8zMzMzMzPt7e0zMzMzMzMzMzMzMzMzMzPS0tIzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzM8PDyWBIz0AAAAFXRSTlMAAAABAgYGCAoOFB0fIVBZXF38/f7YY/43AAAH/ElEQVR42u3d6brbKAyA4RBPZ82sLb3/S53OaZKx2YKNCJL5+NOeJX54YxsLoXAu16hdTDZ/rWsXwIABAwYMGDBgwIABAzYAvt3mAt+8v80E/uYVE1sAf3ilxAbAd6+QWD/46ZURqwevvCJi7eCNV0IsAPa+cHgv6hUQt4P/60be2yaOvO3iZvD3buS9LeKEdzj40Y+897i4h7cV/H9P8t6j4i7eRvC6L3nvMXEfbxt425u894i4k7cJHPYn790v7uVtAcc9ynv3irt5ZcE+7/VKvKKX9JOl2Cs5aD1hmr2Cj6UnTbVXLvAoNUVesdDSildq8mDGKzQ9FPNaAF8kvQYu6RdiPUG0ZE5L0qv8sfRCrGkiLJu1lPQqDi1fiHUls6Tz0pJepdPDS1ksnJBWuLYk6dWZ4pFO2+lP4kknZvWnaaVT7/oT8dKLK/qXWqSXz/QvpkkvkOpfLu3bbroHrd7iCUoe5itqma9sab7CtPlKD+crLp2vfFhZmhYwYMCAAQMGDBgwYMCAAQMGDBgwYMCAAQMGDBgwYMCAZwbfbnOBb8Kfp9IOvol+DsPLVl53AMsWFvmeYhGwaOmY7KdFuoBliwP1g4XKP/2uNhAsU+B78zvbbRRYqITbDFiqSN8yWHcEIn9JKxeLD1raxdKPJfVi4cDjsNjOY0lIbAssIDYGbhdbAzeLzYFbxfbAjWKD4DaxRXCT2CS4RQyYS5pBi8cSgQehJZMHpockAEjxCCXxDIFlkpaG15aOdWa6pRYW01gu1TponX5BXKjkwWrgcXgRzWhoeXzR0ObkoWGR1OT0sGVR2GICYKri0vnKh800wIABAwYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABAwYMGHAeLPsnxOWPJwuW3iCow5ZDkuCK3nkZrgi5GVzj3dPPbvtKCYHrvPX97LiTlgi41lvbz657hwmA6711/ey8W1ozeI+3pp/d94eTAlcRdpzgoz/vDX63V0QsAJby1gxvusF77zrt4No7bqfXt/7OKPDuUdUg+PDzyCh4/cWBp6Y58PqrI1GCNfD6y0NRkTHwmngsCjQLPhr1Wr2kD0f5Rget47Mam4+lhqSWycAjNyk+a2jZlMQzGUvnkh7nnTw0JC2NzpbS9/WZp4eHk7Rm58OpcXuGBABg82DxpJv5rOVZwWKJc/WJePGlEe1LLeKLX+oX08SXN7Uvl8ovYGtfEJcvUdBe8iBfhKK9qEW+zEh72dJFvpBMeWGaTI62wnwRaRSXAgYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABAwYMGDBgwIABTwPuV4SiEdy1zEgfuHMhmTpw71JBbeDuxaDKwP3LfXWB31DQrQr8jpJ9leDswU8GfsvHbhSCi4c/Kzh3554KvIJlxyp91zRgwIABAwYMGDBgwLOApXMMnGHAgAEDBnwO8HRJvGnTtPMk4qdbaplvMW265dL5FsTnK3mYr6hlvrKly3SFaZdSaHlasJ0GGDBgwIABAwYMGDBgwIABAwYMGHD3DgIGDBgwYMCAAQMGDBiwRXCi1MEFDTBgwPbAfjqw/20y8Bf/y1zgz/4pngb8EM8DvosnAvufZgP7T7OB/c+zgb/dx7M8hx/t90kiLbE/Y29k8vDDo336ldkSYOPgP/9at7//OD1Y9uM89sBfZgP/Axgw4KnBevbTeg/4MtsZBgwYMGDAgAEDBgwYMGDAgAEDVgj+PBv4ZNs8mmuAAQMGDBgwYMCAAQMGDBgwYMAlsM0GGDBgwIABAwY8A3h524ssg6+A5wIvgPWAu1zBgAEDBjwM7Jy7ujnAj+0RznCGPyD+q1v17UPmEuDwhT79DvjV+6ML/OiY99/Ebvno41N2///qF8PXbXbIeB5s9W2t4I/6w68r8P2nATh83XZPkPW79/i2UvC94vLrE7z5+fY/69tguwvK5t27f1sneLuDSxYcvi7c92X77t0PpgjsnAt6+L2T1/Davf8bjVfhTjfhu+eVgsNdeq7hxXu/nYMXx3v7XKOjqQRH+xJFJzMJTuxmdI2PphAcF4tnQqntd1P7N10TR1MHTuw8lZFuz3tqx6pr+mgqwM7lzm8UPD6fyds7O2VLH00TOLmzWDxdSD6Ia7Yq0TNo7ffGoVaNVxc47uHyCuwyD+KcVwPYFe7fEOwisEuGWlmvJnCqh0sUc0RgV75GouhrFDgMeNP37xJFlTHYlUeBML5+N3jF2+zrmO7hEs0bEmBXHueDGdQYcLSZZaaHS3CThnF11Z2xnSMPAUfdyPVwCVMaV5cY7V6NfZssyAhw1JFsDxcXprDcyzSeK+6LOgIcdSXfwyUakl0ujaf3DEddyUYIYdYyedeqv4ejruQjhBrw62h88ChdFeHXg19H48Ofw5XeLdhlwK+j8fGRlqvzbsAuA84P/4pi6RfdcglwZhGplLZUNFsqdyx4tC7ZG3jvGzluPly89Fw92O0eHAZlPEqDi2sAp46WzgiOALvSPbZqpb65l14dWct8gOB2gt2RvPQwsCvFG5Vgd2DlYRzYlcfnKrDbv7Y0EOyK43MdOJe0zK8ejkrEp7pyBJxOWhbWh4eCXfl6rgKnkpalCoCxYFe8nuvA95xAbY3HYLArXc+V4DBpWa7iGQ12Yf6lHpy5ZlwK7NZv6rCVh+8d+LFUT7cf7F6vnlNc2g+8HGt2wVcVp9w+uPsVwxlWDl4A2wFPN0qPaYABAwYMGLBB8L86UddPrrT/8QAAAABJRU5ErkJggg==") -40px -40px no-repeat;background-size:120px 240px}.jstree-default-responsive>.jstree-container-ul>.jstree-node{margin-left:0;margin-right:0}} +.jstree-node,.jstree-children,.jstree-container-ul{display:block;margin:0;padding:0;list-style-type:none;list-style-image:none}.jstree-node{white-space:nowrap}.jstree-anchor{display:inline-block;color:black;white-space:nowrap;padding:0 4px 0 1px;margin:0;vertical-align:top}.jstree-anchor:focus{outline:0}.jstree-anchor,.jstree-anchor:link,.jstree-anchor:visited,.jstree-anchor:hover,.jstree-anchor:active{text-decoration:none;color:inherit}.jstree-icon{display:inline-block;text-decoration:none;margin:0;padding:0;vertical-align:top;text-align:center}.jstree-icon:empty{display:inline-block;text-decoration:none;margin:0;padding:0;vertical-align:top;text-align:center}.jstree-ocl{cursor:pointer}.jstree-leaf>.jstree-ocl{cursor:default}.jstree .jstree-open>.jstree-children{display:block}.jstree .jstree-closed>.jstree-children,.jstree .jstree-leaf>.jstree-children{display:none}.jstree-anchor>.jstree-themeicon{margin-right:2px}.jstree-no-icons .jstree-themeicon,.jstree-anchor>.jstree-themeicon-hidden{display:none}.jstree-hidden,.jstree-node.jstree-hidden{display:none}.jstree-rtl .jstree-anchor{padding:0 1px 0 4px}.jstree-rtl .jstree-anchor>.jstree-themeicon{margin-left:2px;margin-right:0}.jstree-rtl .jstree-node{margin-left:0}.jstree-rtl .jstree-container-ul>.jstree-node{margin-right:0}.jstree-wholerow-ul{position:relative;display:inline-block;min-width:100%}.jstree-wholerow-ul .jstree-leaf>.jstree-ocl{cursor:pointer}.jstree-wholerow-ul .jstree-anchor,.jstree-wholerow-ul .jstree-icon{position:relative}.jstree-wholerow-ul .jstree-wholerow{width:100%;cursor:pointer;position:absolute;left:0;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.jstree-contextmenu .jstree-anchor{-webkit-user-select:none;-webkit-touch-callout:none;user-select:none}.vakata-context{display:none}.vakata-context,.vakata-context ul{margin:0;padding:2px;position:absolute;background:#f5f5f5;border:1px solid #979797;box-shadow:2px 2px 2px #999999}.vakata-context ul{list-style:none;left:100%;margin-top:-2.7em;margin-left:-4px}.vakata-context .vakata-context-right ul{left:auto;right:100%;margin-left:auto;margin-right:-4px}.vakata-context li{list-style:none}.vakata-context li>a{display:block;padding:0 2em 0 2em;text-decoration:none;width:auto;color:black;white-space:nowrap;line-height:2.4em;text-shadow:1px 1px 0 white;border-radius:1px}.vakata-context li>a:hover{position:relative;background-color:#e8eff7;box-shadow:0 0 2px #0a6aa1}.vakata-context li>a.vakata-context-parent{background-image:url("data:image/gif;base64,R0lGODlhCwAHAIAAACgoKP///yH5BAEAAAEALAAAAAALAAcAAAIORI4JlrqN1oMSnmmZDQUAOw==");background-position:right center;background-repeat:no-repeat}.vakata-context li>a:focus{outline:0}.vakata-context .vakata-context-no-icons{margin-left:0}.vakata-context .vakata-context-hover>a{position:relative;background-color:#e8eff7;box-shadow:0 0 2px #0a6aa1}.vakata-context .vakata-context-separator>a,.vakata-context .vakata-context-separator>a:hover{background:white;border:0;border-top:1px solid #e2e3e3;height:1px;min-height:1px;max-height:1px;padding:0;margin:0 0 0 2.4em;border-left:1px solid #e0e0e0;text-shadow:0 0 0 transparent;box-shadow:0 0 0 transparent;border-radius:0}.vakata-context .vakata-contextmenu-disabled a,.vakata-context .vakata-contextmenu-disabled a:hover{color:silver;background-color:transparent;border:0;box-shadow:0 0 0}.vakata-context .vakata-contextmenu-disabled>a>i{filter:grayscale(100%)}.vakata-context li>a>i{text-decoration:none;display:inline-block;width:2.4em;height:2.4em;background:transparent;margin:0 0 0 -2em;vertical-align:top;text-align:center;line-height:2.4em}.vakata-context li>a>i:empty{width:2.4em;line-height:2.4em}.vakata-context li>a .vakata-contextmenu-sep{display:inline-block;width:1px;height:2.4em;background:white;margin:0 .5em 0 0;border-left:1px solid #e2e3e3}.vakata-context .vakata-contextmenu-shortcut{font-size:.8em;color:silver;opacity:.5;display:none}.vakata-context-rtl ul{left:auto;right:100%;margin-left:auto;margin-right:-4px}.vakata-context-rtl li>a.vakata-context-parent{background-image:url("data:image/gif;base64,R0lGODlhCwAHAIAAACgoKP///yH5BAEAAAEALAAAAAALAAcAAAINjI+AC7rWHIsPtmoxLAA7");background-position:left center;background-repeat:no-repeat}.vakata-context-rtl .vakata-context-separator>a{margin:0 2.4em 0 0;border-left:0;border-right:1px solid #e2e3e3}.vakata-context-rtl .vakata-context-left ul{right:auto;left:100%;margin-left:-4px;margin-right:auto}.vakata-context-rtl li>a>i{margin:0 -2em 0 0}.vakata-context-rtl li>a .vakata-contextmenu-sep{margin:0 0 0 .5em;border-left-color:white;background:#e2e3e3}#jstree-marker{position:absolute;top:0;left:0;margin:-5px 0 0 0;padding:0;border-right:0;border-top:5px solid transparent;border-bottom:5px solid transparent;border-left:5px solid;width:0;height:0;font-size:0;line-height:0}#jstree-dnd{line-height:16px;margin:0;padding:4px}#jstree-dnd .jstree-icon,#jstree-dnd .jstree-copy{display:inline-block;text-decoration:none;margin:0 2px 0 0;padding:0;width:16px;height:16px}#jstree-dnd .jstree-ok{background:green}#jstree-dnd .jstree-er{background:red}#jstree-dnd .jstree-copy{margin:0 2px 0 2px}.jstree-default-dark .jstree-node,.jstree-default-dark .jstree-icon{background-repeat:no-repeat;background-color:transparent}.jstree-default-dark .jstree-anchor,.jstree-default-dark .jstree-animated,.jstree-default-dark .jstree-wholerow{transition:background-color .15s,box-shadow .15s}.jstree-default-dark .jstree-hovered{background:#555;border-radius:2px;box-shadow:inset 0 0 1px #555}.jstree-default-dark .jstree-context{background:#555;border-radius:2px;box-shadow:inset 0 0 1px #555}.jstree-default-dark .jstree-clicked{background:#5fa2db;border-radius:2px;box-shadow:inset 0 0 1px #666666}.jstree-default-dark .jstree-no-icons .jstree-anchor>.jstree-themeicon{display:none}.jstree-default-dark .jstree-disabled{background:transparent;color:#666666}.jstree-default-dark .jstree-disabled.jstree-hovered{background:transparent;box-shadow:none}.jstree-default-dark .jstree-disabled.jstree-clicked{background:#333333}.jstree-default-dark .jstree-disabled>.jstree-icon{opacity:.8;filter:url("data:image/svg+xml;utf8,#jstree-grayscale");filter:gray;-webkit-filter:grayscale(100%)}.jstree-default-dark .jstree-search{font-style:italic;color:#ffffff;font-weight:bold}.jstree-default-dark .jstree-no-checkboxes .jstree-checkbox{display:none !important}.jstree-default-dark.jstree-checkbox-no-clicked .jstree-clicked{background:transparent;box-shadow:none}.jstree-default-dark.jstree-checkbox-no-clicked .jstree-clicked.jstree-hovered{background:#555}.jstree-default-dark.jstree-checkbox-no-clicked>.jstree-wholerow-ul .jstree-wholerow-clicked{background:transparent}.jstree-default-dark.jstree-checkbox-no-clicked>.jstree-wholerow-ul .jstree-wholerow-clicked.jstree-wholerow-hovered{background:#555}.jstree-default-dark>.jstree-striped{min-width:100%;display:inline-block;background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAkCAMAAAB/qqA+AAAABlBMVEUAAAAAAAClZ7nPAAAAAnRSTlMNAMM9s3UAAAAXSURBVHjajcEBAQAAAIKg/H/aCQZ70AUBjAATb6YPDgAAAABJRU5ErkJggg==") left top repeat}.jstree-default-dark>.jstree-wholerow-ul .jstree-hovered,.jstree-default-dark>.jstree-wholerow-ul .jstree-clicked{background:transparent;box-shadow:none;border-radius:0}.jstree-default-dark .jstree-wholerow{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.jstree-default-dark .jstree-wholerow-hovered{background:#555}.jstree-default-dark .jstree-wholerow-clicked{background:#5fa2db;background:-webkit-linear-gradient(top, #5fa2db 0%, #5fa2db 100%);background:linear-gradient(to bottom, #5fa2db 0%, #5fa2db 100%)}.jstree-default-dark .jstree-node{min-height:24px;line-height:24px;margin-left:24px;min-width:24px}.jstree-default-dark .jstree-anchor{line-height:24px;height:24px}.jstree-default-dark .jstree-icon{width:24px;height:24px;line-height:24px}.jstree-default-dark .jstree-icon:empty{width:24px;height:24px;line-height:24px}.jstree-default-dark.jstree-rtl .jstree-node{margin-right:24px}.jstree-default-dark .jstree-wholerow{height:24px}.jstree-default-dark .jstree-node,.jstree-default-dark .jstree-icon{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAMAAABblVsaAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAABAQEEBAQAAAADAwMAAAAAAADHx8cAAAAAAAC1tbWnp6e+vr4AAAAAAADf39/V1dWwsLCSkpI/Pz/GxsaLi4sgICBoaGiGhobDw8P////o6OiZmZny8vL7+/vq6ur+/v7u7u729vbs7Oz4+Pj09PT19fXf39/b29vj4+PY2NjQ0NDMzMzIyMiPj494eHh0e0YfAAAAHnRSTlMAMQw9GCUrBk9hO6URA6STuXke3tu1hETMkDlGaZn4Iun6AAAE6klEQVR42u2bC1PiMBSFSdK0LMLCIijqbkJaSlse6ur//297C9sBJn3YQGbaej8fnXrskR5PxcZr78Ysr9abTdMfH4INROqBDcQGdgtsYFPxHJeccB3vpjpAOQE47dWkLQ107sQ5d85NdYAfBXfU0Qa6ok9O9IVrrg/YAPSCAHnvCqhDr/2kZcWhlQ0s8ieCXO7pOuXkCKe5evYomGADTaek/wPos8zCpIFcMFqZHzP4Jhn4GwTIRQYvCRC+gBB9TT8dfEUTiRADWnl+gpg2EPw/K/w/Un/DAInIILn6KT/Rz9EvISYNJMKHjlTkVx7g9f72AqQO/Z8fGxgGqKObMFp+fgYNNPC3EOCACeYc86PEVgPLz5CyVUpZgNb8rw+wD9Y/VgA8AGKvgYBTeH7xRqkkLm3g5Uuu/8dJz/X/zNMJ5KrtXX6E+OtNopLN2id5et/343gd+4zmHp+KGXHsmzXQT2G0KD+lIikjVRagNX/ik8s9XSdJJPfbvYwSkqcPWJIolTCaf/xahUFGqNZmDYw3m7jwCnMCQMIb1zX7/mRNLvd0nYRyu3vdbWVIcnXKwjBktOD49OAMsDBroFKq5CcU137H1LHmTxS53NN1LiWEsIX3PFeHjktGi46Ptq9vGa/byKyBUcTM0rHvT0Jyuafp53ciufrZXVSOHuze3v8eeX/bBUYN5PLq/Kz5u8HFvW7g3lgnATTw/Qg0MCCm98Jm2Pd3fspzfjo31rmU+93rkd1eSt611Rjb64GUk4xGrAt2lfY2EOkG2ECkFthApGNgAxtPx0cTGv7wEGwgUhdsIDawW2ADG8rt1wMbioUG2pkP/G4NtDsfaPsPF7pk3rBy/+x4+/OBthoI9vyK+T4L/rbmA+1AB6LYm4jqBJcV/p8V/h89wP58oK0Ggr1feoIGHTTztz8faIOjPTGe7wOWFvztzAcasazKr/wEVykGHTTwtz8faAFHVJxgnCiVzVdVjgTq+kfmX6B/av725gMtNdBPKQ7wOL+nDDpo4G97PtAGlKUTfIXe/DDABzi2/e3PB1p7FlZKEQsTggb+tucD7UBZFJ15N8ffwnygrTsRyXtWOPk3cT6w14ghvi/6N3E+sPOrMd9mPbDjtLeBSDfABiK1wAYiHQMbiNQCG4h0DGwgUgtsINIxsIEthvIO/D/zlxo4Gk6Ho56ONxx66caBjQFcnMF73WXkjKPfjp6gx+8WrtejZDYGtT5EnEF67WT5lfwefJE8DPX8xkJM+PD5XvigGgX468eBX+0N8Ev5raAh9472I2wsgHl/JoApNlBnRKmX5ieA+0eqNfBlIoBAAGPnuwZY+tTx8odTuH5z8wOoOxEHVuOp910v4ZIG0setmAweVll+Oh45JOg/QX7YQI1p4Pv+IoR39880P2Ky8FPmrlmAqzPaGmBJA51FvFFhqJKC/o3o82ydKKU264lRgsSPs0s49tsaYAmeOw+llMHssaB/v2ebMNovolCtJ0ZPImsVHgGHtga4LEuQzwMpZ880Xx7eKRVGT2wOCSpuEqAK5H4v07dAtTVAoDRBCf0rbOg4ip6mlM9hY9TAUGaXsAzbGuCyIsHxCy1Rf46nHmwm46nRrVwQ7Pfbw2sQtDXACjzqadHoiwnpxgAuz2jrYkLt9UBczkI600AEwQYiNcEGIh0DG3hr/gEpF8+LRC337gAAAABJRU5ErkJggg==")}.jstree-default-dark .jstree-node{background-position:-292px -4px;background-repeat:repeat-y}.jstree-default-dark .jstree-last{background-image:none}.jstree-default-dark .jstree-open>.jstree-ocl{background-position:-132px -4px}.jstree-default-dark .jstree-closed>.jstree-ocl{background-position:-100px -4px}.jstree-default-dark .jstree-leaf>.jstree-ocl{background-position:-68px -4px}.jstree-default-dark .jstree-themeicon{background-position:-260px -4px}.jstree-default-dark>.jstree-no-dots .jstree-node,.jstree-default-dark>.jstree-no-dots .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-dark>.jstree-no-dots .jstree-open>.jstree-ocl{background-position:-36px -4px}.jstree-default-dark>.jstree-no-dots .jstree-closed>.jstree-ocl{background-position:-4px -4px}.jstree-default-dark .jstree-disabled{background:transparent}.jstree-default-dark .jstree-disabled.jstree-hovered{background:transparent}.jstree-default-dark .jstree-disabled.jstree-clicked{background:#efefef}.jstree-default-dark .jstree-checkbox{background-position:-164px -4px}.jstree-default-dark .jstree-checkbox:hover{background-position:-164px -36px}.jstree-default-dark.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox,.jstree-default-dark .jstree-checked>.jstree-checkbox{background-position:-228px -4px}.jstree-default-dark.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox:hover,.jstree-default-dark .jstree-checked>.jstree-checkbox:hover{background-position:-228px -36px}.jstree-default-dark .jstree-anchor>.jstree-undetermined{background-position:-196px -4px}.jstree-default-dark .jstree-anchor>.jstree-undetermined:hover{background-position:-196px -36px}.jstree-default-dark .jstree-checkbox-disabled{opacity:.8;filter:url("data:image/svg+xml;utf8,#jstree-grayscale");filter:gray;-webkit-filter:grayscale(100%)}.jstree-default-dark>.jstree-striped{background-size:auto 48px}.jstree-default-dark.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAACAQMAAAB49I5GAAAABlBMVEUAAAAdHRvEkCwcAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjAAMOBgAAGAAJMwQHdQAAAABJRU5ErkJggg==");background-position:100% 1px;background-repeat:repeat-y}.jstree-default-dark.jstree-rtl .jstree-last{background-image:none}.jstree-default-dark.jstree-rtl .jstree-open>.jstree-ocl{background-position:-132px -36px}.jstree-default-dark.jstree-rtl .jstree-closed>.jstree-ocl{background-position:-100px -36px}.jstree-default-dark.jstree-rtl .jstree-leaf>.jstree-ocl{background-position:-68px -36px}.jstree-default-dark.jstree-rtl>.jstree-no-dots .jstree-node,.jstree-default-dark.jstree-rtl>.jstree-no-dots .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-dark.jstree-rtl>.jstree-no-dots .jstree-open>.jstree-ocl{background-position:-36px -36px}.jstree-default-dark.jstree-rtl>.jstree-no-dots .jstree-closed>.jstree-ocl{background-position:-4px -36px}.jstree-default-dark .jstree-themeicon-custom{background-color:transparent;background-image:none;background-position:0 0}.jstree-default-dark>.jstree-container-ul .jstree-loading>.jstree-ocl{background:url("data:image/gif;base64,R0lGODlhEAAQAPMPAEBAQHBwcKqqqoCAgFBQUKCgoGBgYI+Pjzk5OWhoaImJiZiYmFhYWHh4eKenpzMzMyH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQFCgAPACwAAAAAEAAQAEAEcPDJh2gbdcqkutETIoqKkCCCMwxA1koA8AAHwRhAIlMaICwIh6C1CyEYh6IkE0oUFEoEgKCcBWSGz4PAnAAWLcGQ15MlTMJYd1ZyUDXSDGelBY0qIkJg/ZoEFgYICToxDBRvIQMBD1kzgSAgBASQDxEAIfkEBQoADwAsAAAAAA8AEAAABF3wyflCk4hOJZcEBaNJB7I4wCIQo2QshSFw0xAjxWEJQpZJA8EBMCEQW7TWg9EIBFjKh2HQaECjH8PoN2EoBlvAL6FgIAwMgPoo1jQABPNVE9DGJXOMIXN/HJVqIxEAIfkEBQoADwAsAAAAABAADwAABFrwyflMolg2qRZCRyY5A9Ihg4hUAtMxE0BIwcGASpIcApAIPU0hFTMABbMJobFSCi4Sgs4AyHyujIBWxH3AupRGotk1BAgIAvqqkiQAcASAjDHM4A8594vPUyIAIfkEBQoADwAsAAAAABAAEAAABFzwySkNvTKgN5QcBPYcAec12CYVRBeiCCAljawEhuEhVqEGpIfqQViIHiWKrIbYGBgMUaNQcIByBtmlIegeKKELYAxQARKW44SQfYzVQgmC0BweCbIm3C23w/UYEQAh+QQFCgAIACwAAAAAEAAOAAAERRDJiUKgWA4pBM/c1iEFKAVeZ5DYUBCIcFheFU+DsGH1Su2YwwSAMPiCHUHJcsmUPkMMQZY5TqYdIkJrSma4FAJQAgZFAAAh+QQFCgAOACwAAAAAEAAQAAAEa9DJ6Qih2CEmU5ABkCEBlyROsogZ0AAnUKAUwYiJYQVHtSgSBCFBQEwQgIHjwJIAOBSEwmDUAK5VimEwUCSu2IxhsSg0ohjAwYBBNh1PCTAIMCKqBUHSUchmGAJKDlBoEwsCFyNpAmwZjn4RACH5BAUKAA8ALAAAAAAQABAAAARb8Mn5AKBYEmkMz9zFeIYCSgkyPgqDWcjDEJbRSMotAXTWFAMM4oJpuCaIJIjRaASTygxDcTgETpMBI4rdPBoxUKCxeCBuh1NBkHhceSDEmkiMOwQXxzE+OIQpEQAh+QQFCgAOACwBAAEADwAPAAAEVtBJIAmRTOpaL2nb5l3N5SCnBlAOEzjAkEgIgIbB8W73lpihICFAzAQ1n4HsSCsFa6zawrHbCASJhGI6U/gEgcXC4JiFAFdKAXE4MgSXwtqxAKo0g2MEACH5BAUKAA8ALAAAAAAQABAAAARd8Mn5EKJY3geAJBsGXB1nhBTidUjiYZtlEYyUGBlsNHiOGS8fBZAoCieAgLL2WRAwrqFCIOhNFIWExiE4eBYGRkPxMCwaEsPTdjjUesHJAtF+DBw+x/cgIec2SjkRACH5BAUKAA4ALAAAAQAQAA8AAARa0MnpEJKAamkl2Vr3bZkGlMYITkxCXFRJqU5T3A3I7MQh/AqQweBCnAwFmcSwcrwmiMaBKVnUEAsFw5EYOAcBCUNmGCgIhS1Mc3CYHYH2hmB1KII15SaRAEUAACH5BAUKAA8ALAAAAQAQAA8AAARY8MlJH6p4IlABx8BFCUJSiQjxEaTwTYBaBQLTidKiZw/hAwNHoRDI+BgfBEOBsVUGkpck0XA+Do+iYuAzNCQBg4QgETMCDQCWV2CiHwYmSN6AIoq8shgTAQAh+QQFCgAPACwAAAEADwAPAAAEWvBJUoC8+BKxspeDwHxS9wCC4AHIaRrjhbCY4RBZKyWHoiSeGQAQWBiBuaGlRRh4cLLAo+BhJKBOYCMwZBhOsNOkQEhIG5aHTn1oPMwPRmB9cb+ljy8pHsNEAAA7") center center no-repeat}.jstree-default-dark .jstree-file{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAMAAABblVsaAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAABAQEEBAQAAAADAwMAAAAAAADHx8cAAAAAAAC1tbWnp6e+vr4AAAAAAADf39/V1dWwsLCSkpI/Pz/GxsaLi4sgICBoaGiGhobDw8P////o6OiZmZny8vL7+/vq6ur+/v7u7u729vbs7Oz4+Pj09PT19fXf39/b29vj4+PY2NjQ0NDMzMzIyMiPj494eHh0e0YfAAAAHnRSTlMAMQw9GCUrBk9hO6URA6STuXke3tu1hETMkDlGaZn4Iun6AAAE6klEQVR42u2bC1PiMBSFSdK0LMLCIijqbkJaSlse6ur//297C9sBJn3YQGbaej8fnXrskR5PxcZr78Ysr9abTdMfH4INROqBDcQGdgtsYFPxHJeccB3vpjpAOQE47dWkLQ107sQ5d85NdYAfBXfU0Qa6ok9O9IVrrg/YAPSCAHnvCqhDr/2kZcWhlQ0s8ieCXO7pOuXkCKe5evYomGADTaek/wPos8zCpIFcMFqZHzP4Jhn4GwTIRQYvCRC+gBB9TT8dfEUTiRADWnl+gpg2EPw/K/w/Un/DAInIILn6KT/Rz9EvISYNJMKHjlTkVx7g9f72AqQO/Z8fGxgGqKObMFp+fgYNNPC3EOCACeYc86PEVgPLz5CyVUpZgNb8rw+wD9Y/VgA8AGKvgYBTeH7xRqkkLm3g5Uuu/8dJz/X/zNMJ5KrtXX6E+OtNopLN2id5et/343gd+4zmHp+KGXHsmzXQT2G0KD+lIikjVRagNX/ik8s9XSdJJPfbvYwSkqcPWJIolTCaf/xahUFGqNZmDYw3m7jwCnMCQMIb1zX7/mRNLvd0nYRyu3vdbWVIcnXKwjBktOD49OAMsDBroFKq5CcU137H1LHmTxS53NN1LiWEsIX3PFeHjktGi46Ptq9vGa/byKyBUcTM0rHvT0Jyuafp53ciufrZXVSOHuze3v8eeX/bBUYN5PLq/Kz5u8HFvW7g3lgnATTw/Qg0MCCm98Jm2Pd3fspzfjo31rmU+93rkd1eSt611Rjb64GUk4xGrAt2lfY2EOkG2ECkFthApGNgAxtPx0cTGv7wEGwgUhdsIDawW2ADG8rt1wMbioUG2pkP/G4NtDsfaPsPF7pk3rBy/+x4+/OBthoI9vyK+T4L/rbmA+1AB6LYm4jqBJcV/p8V/h89wP58oK0Ggr1feoIGHTTztz8faIOjPTGe7wOWFvztzAcasazKr/wEVykGHTTwtz8faAFHVJxgnCiVzVdVjgTq+kfmX6B/av725gMtNdBPKQ7wOL+nDDpo4G97PtAGlKUTfIXe/DDABzi2/e3PB1p7FlZKEQsTggb+tucD7UBZFJ15N8ffwnygrTsRyXtWOPk3cT6w14ghvi/6N3E+sPOrMd9mPbDjtLeBSDfABiK1wAYiHQMbiNQCG4h0DGwgUgtsINIxsIEthvIO/D/zlxo4Gk6Ho56ONxx66caBjQFcnMF73WXkjKPfjp6gx+8WrtejZDYGtT5EnEF67WT5lfwefJE8DPX8xkJM+PD5XvigGgX468eBX+0N8Ev5raAh9472I2wsgHl/JoApNlBnRKmX5ieA+0eqNfBlIoBAAGPnuwZY+tTx8odTuH5z8wOoOxEHVuOp910v4ZIG0setmAweVll+Oh45JOg/QX7YQI1p4Pv+IoR39880P2Ky8FPmrlmAqzPaGmBJA51FvFFhqJKC/o3o82ydKKU264lRgsSPs0s49tsaYAmeOw+llMHssaB/v2ebMNovolCtJ0ZPImsVHgGHtga4LEuQzwMpZ880Xx7eKRVGT2wOCSpuEqAK5H4v07dAtTVAoDRBCf0rbOg4ip6mlM9hY9TAUGaXsAzbGuCyIsHxCy1Rf46nHmwm46nRrVwQ7Pfbw2sQtDXACjzqadHoiwnpxgAuz2jrYkLt9UBczkI600AEwQYiNcEGIh0DG3hr/gEpF8+LRC337gAAAABJRU5ErkJggg==") -100px -68px no-repeat}.jstree-default-dark .jstree-folder{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAMAAABblVsaAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAABAQEEBAQAAAADAwMAAAAAAADHx8cAAAAAAAC1tbWnp6e+vr4AAAAAAADf39/V1dWwsLCSkpI/Pz/GxsaLi4sgICBoaGiGhobDw8P////o6OiZmZny8vL7+/vq6ur+/v7u7u729vbs7Oz4+Pj09PT19fXf39/b29vj4+PY2NjQ0NDMzMzIyMiPj494eHh0e0YfAAAAHnRSTlMAMQw9GCUrBk9hO6URA6STuXke3tu1hETMkDlGaZn4Iun6AAAE6klEQVR42u2bC1PiMBSFSdK0LMLCIijqbkJaSlse6ur//297C9sBJn3YQGbaej8fnXrskR5PxcZr78Ysr9abTdMfH4INROqBDcQGdgtsYFPxHJeccB3vpjpAOQE47dWkLQ107sQ5d85NdYAfBXfU0Qa6ok9O9IVrrg/YAPSCAHnvCqhDr/2kZcWhlQ0s8ieCXO7pOuXkCKe5evYomGADTaek/wPos8zCpIFcMFqZHzP4Jhn4GwTIRQYvCRC+gBB9TT8dfEUTiRADWnl+gpg2EPw/K/w/Un/DAInIILn6KT/Rz9EvISYNJMKHjlTkVx7g9f72AqQO/Z8fGxgGqKObMFp+fgYNNPC3EOCACeYc86PEVgPLz5CyVUpZgNb8rw+wD9Y/VgA8AGKvgYBTeH7xRqkkLm3g5Uuu/8dJz/X/zNMJ5KrtXX6E+OtNopLN2id5et/343gd+4zmHp+KGXHsmzXQT2G0KD+lIikjVRagNX/ik8s9XSdJJPfbvYwSkqcPWJIolTCaf/xahUFGqNZmDYw3m7jwCnMCQMIb1zX7/mRNLvd0nYRyu3vdbWVIcnXKwjBktOD49OAMsDBroFKq5CcU137H1LHmTxS53NN1LiWEsIX3PFeHjktGi46Ptq9vGa/byKyBUcTM0rHvT0Jyuafp53ciufrZXVSOHuze3v8eeX/bBUYN5PLq/Kz5u8HFvW7g3lgnATTw/Qg0MCCm98Jm2Pd3fspzfjo31rmU+93rkd1eSt611Rjb64GUk4xGrAt2lfY2EOkG2ECkFthApGNgAxtPx0cTGv7wEGwgUhdsIDawW2ADG8rt1wMbioUG2pkP/G4NtDsfaPsPF7pk3rBy/+x4+/OBthoI9vyK+T4L/rbmA+1AB6LYm4jqBJcV/p8V/h89wP58oK0Ggr1feoIGHTTztz8faIOjPTGe7wOWFvztzAcasazKr/wEVykGHTTwtz8faAFHVJxgnCiVzVdVjgTq+kfmX6B/av725gMtNdBPKQ7wOL+nDDpo4G97PtAGlKUTfIXe/DDABzi2/e3PB1p7FlZKEQsTggb+tucD7UBZFJ15N8ffwnygrTsRyXtWOPk3cT6w14ghvi/6N3E+sPOrMd9mPbDjtLeBSDfABiK1wAYiHQMbiNQCG4h0DGwgUgtsINIxsIEthvIO/D/zlxo4Gk6Ho56ONxx66caBjQFcnMF73WXkjKPfjp6gx+8WrtejZDYGtT5EnEF67WT5lfwefJE8DPX8xkJM+PD5XvigGgX468eBX+0N8Ev5raAh9472I2wsgHl/JoApNlBnRKmX5ieA+0eqNfBlIoBAAGPnuwZY+tTx8odTuH5z8wOoOxEHVuOp910v4ZIG0setmAweVll+Oh45JOg/QX7YQI1p4Pv+IoR39880P2Ky8FPmrlmAqzPaGmBJA51FvFFhqJKC/o3o82ydKKU264lRgsSPs0s49tsaYAmeOw+llMHssaB/v2ebMNovolCtJ0ZPImsVHgGHtga4LEuQzwMpZ880Xx7eKRVGT2wOCSpuEqAK5H4v07dAtTVAoDRBCf0rbOg4ip6mlM9hY9TAUGaXsAzbGuCyIsHxCy1Rf46nHmwm46nRrVwQ7Pfbw2sQtDXACjzqadHoiwnpxgAuz2jrYkLt9UBczkI600AEwQYiNcEGIh0DG3hr/gEpF8+LRC337gAAAABJRU5ErkJggg==") -260px -4px no-repeat}.jstree-default-dark>.jstree-container-ul>.jstree-node{margin-left:0;margin-right:0}#jstree-dnd.jstree-default-dark{line-height:24px;padding:0 4px}#jstree-dnd.jstree-default-dark .jstree-ok,#jstree-dnd.jstree-default-dark .jstree-er{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAMAAABblVsaAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAABAQEEBAQAAAADAwMAAAAAAADHx8cAAAAAAAC1tbWnp6e+vr4AAAAAAADf39/V1dWwsLCSkpI/Pz/GxsaLi4sgICBoaGiGhobDw8P////o6OiZmZny8vL7+/vq6ur+/v7u7u729vbs7Oz4+Pj09PT19fXf39/b29vj4+PY2NjQ0NDMzMzIyMiPj494eHh0e0YfAAAAHnRSTlMAMQw9GCUrBk9hO6URA6STuXke3tu1hETMkDlGaZn4Iun6AAAE6klEQVR42u2bC1PiMBSFSdK0LMLCIijqbkJaSlse6ur//297C9sBJn3YQGbaej8fnXrskR5PxcZr78Ysr9abTdMfH4INROqBDcQGdgtsYFPxHJeccB3vpjpAOQE47dWkLQ107sQ5d85NdYAfBXfU0Qa6ok9O9IVrrg/YAPSCAHnvCqhDr/2kZcWhlQ0s8ieCXO7pOuXkCKe5evYomGADTaek/wPos8zCpIFcMFqZHzP4Jhn4GwTIRQYvCRC+gBB9TT8dfEUTiRADWnl+gpg2EPw/K/w/Un/DAInIILn6KT/Rz9EvISYNJMKHjlTkVx7g9f72AqQO/Z8fGxgGqKObMFp+fgYNNPC3EOCACeYc86PEVgPLz5CyVUpZgNb8rw+wD9Y/VgA8AGKvgYBTeH7xRqkkLm3g5Uuu/8dJz/X/zNMJ5KrtXX6E+OtNopLN2id5et/343gd+4zmHp+KGXHsmzXQT2G0KD+lIikjVRagNX/ik8s9XSdJJPfbvYwSkqcPWJIolTCaf/xahUFGqNZmDYw3m7jwCnMCQMIb1zX7/mRNLvd0nYRyu3vdbWVIcnXKwjBktOD49OAMsDBroFKq5CcU137H1LHmTxS53NN1LiWEsIX3PFeHjktGi46Ptq9vGa/byKyBUcTM0rHvT0Jyuafp53ciufrZXVSOHuze3v8eeX/bBUYN5PLq/Kz5u8HFvW7g3lgnATTw/Qg0MCCm98Jm2Pd3fspzfjo31rmU+93rkd1eSt611Rjb64GUk4xGrAt2lfY2EOkG2ECkFthApGNgAxtPx0cTGv7wEGwgUhdsIDawW2ADG8rt1wMbioUG2pkP/G4NtDsfaPsPF7pk3rBy/+x4+/OBthoI9vyK+T4L/rbmA+1AB6LYm4jqBJcV/p8V/h89wP58oK0Ggr1feoIGHTTztz8faIOjPTGe7wOWFvztzAcasazKr/wEVykGHTTwtz8faAFHVJxgnCiVzVdVjgTq+kfmX6B/av725gMtNdBPKQ7wOL+nDDpo4G97PtAGlKUTfIXe/DDABzi2/e3PB1p7FlZKEQsTggb+tucD7UBZFJ15N8ffwnygrTsRyXtWOPk3cT6w14ghvi/6N3E+sPOrMd9mPbDjtLeBSDfABiK1wAYiHQMbiNQCG4h0DGwgUgtsINIxsIEthvIO/D/zlxo4Gk6Ho56ONxx66caBjQFcnMF73WXkjKPfjp6gx+8WrtejZDYGtT5EnEF67WT5lfwefJE8DPX8xkJM+PD5XvigGgX468eBX+0N8Ev5raAh9472I2wsgHl/JoApNlBnRKmX5ieA+0eqNfBlIoBAAGPnuwZY+tTx8odTuH5z8wOoOxEHVuOp910v4ZIG0setmAweVll+Oh45JOg/QX7YQI1p4Pv+IoR39880P2Ky8FPmrlmAqzPaGmBJA51FvFFhqJKC/o3o82ydKKU264lRgsSPs0s49tsaYAmeOw+llMHssaB/v2ebMNovolCtJ0ZPImsVHgGHtga4LEuQzwMpZ880Xx7eKRVGT2wOCSpuEqAK5H4v07dAtTVAoDRBCf0rbOg4ip6mlM9hY9TAUGaXsAzbGuCyIsHxCy1Rf46nHmwm46nRrVwQ7Pfbw2sQtDXACjzqadHoiwnpxgAuz2jrYkLt9UBczkI600AEwQYiNcEGIh0DG3hr/gEpF8+LRC337gAAAABJRU5ErkJggg==");background-repeat:no-repeat;background-color:transparent}#jstree-dnd.jstree-default-dark i{background:transparent;width:24px;height:24px;line-height:24px}#jstree-dnd.jstree-default-dark .jstree-ok{background-position:-4px -68px}#jstree-dnd.jstree-default-dark .jstree-er{background-position:-36px -68px}.jstree-default-dark .jstree-ellipsis{overflow:hidden}.jstree-default-dark .jstree-ellipsis .jstree-anchor{width:calc(100% - 24px + 5px);text-overflow:ellipsis;overflow:hidden}.jstree-default-dark.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAACAQMAAAB49I5GAAAABlBMVEUAAAAdHRvEkCwcAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjAAMOBgAAGAAJMwQHdQAAAABJRU5ErkJggg==")}.jstree-default-dark.jstree-rtl .jstree-last{background-image:none}.jstree-default-dark-small .jstree-node{min-height:18px;line-height:18px;margin-left:18px;min-width:18px}.jstree-default-dark-small .jstree-anchor{line-height:18px;height:18px}.jstree-default-dark-small .jstree-icon{width:18px;height:18px;line-height:18px}.jstree-default-dark-small .jstree-icon:empty{width:18px;height:18px;line-height:18px}.jstree-default-dark-small.jstree-rtl .jstree-node{margin-right:18px}.jstree-default-dark-small .jstree-wholerow{height:18px}.jstree-default-dark-small .jstree-node,.jstree-default-dark-small .jstree-icon{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAMAAABblVsaAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAABAQEEBAQAAAADAwMAAAAAAADHx8cAAAAAAAC1tbWnp6e+vr4AAAAAAADf39/V1dWwsLCSkpI/Pz/GxsaLi4sgICBoaGiGhobDw8P////o6OiZmZny8vL7+/vq6ur+/v7u7u729vbs7Oz4+Pj09PT19fXf39/b29vj4+PY2NjQ0NDMzMzIyMiPj494eHh0e0YfAAAAHnRSTlMAMQw9GCUrBk9hO6URA6STuXke3tu1hETMkDlGaZn4Iun6AAAE6klEQVR42u2bC1PiMBSFSdK0LMLCIijqbkJaSlse6ur//297C9sBJn3YQGbaej8fnXrskR5PxcZr78Ysr9abTdMfH4INROqBDcQGdgtsYFPxHJeccB3vpjpAOQE47dWkLQ107sQ5d85NdYAfBXfU0Qa6ok9O9IVrrg/YAPSCAHnvCqhDr/2kZcWhlQ0s8ieCXO7pOuXkCKe5evYomGADTaek/wPos8zCpIFcMFqZHzP4Jhn4GwTIRQYvCRC+gBB9TT8dfEUTiRADWnl+gpg2EPw/K/w/Un/DAInIILn6KT/Rz9EvISYNJMKHjlTkVx7g9f72AqQO/Z8fGxgGqKObMFp+fgYNNPC3EOCACeYc86PEVgPLz5CyVUpZgNb8rw+wD9Y/VgA8AGKvgYBTeH7xRqkkLm3g5Uuu/8dJz/X/zNMJ5KrtXX6E+OtNopLN2id5et/343gd+4zmHp+KGXHsmzXQT2G0KD+lIikjVRagNX/ik8s9XSdJJPfbvYwSkqcPWJIolTCaf/xahUFGqNZmDYw3m7jwCnMCQMIb1zX7/mRNLvd0nYRyu3vdbWVIcnXKwjBktOD49OAMsDBroFKq5CcU137H1LHmTxS53NN1LiWEsIX3PFeHjktGi46Ptq9vGa/byKyBUcTM0rHvT0Jyuafp53ciufrZXVSOHuze3v8eeX/bBUYN5PLq/Kz5u8HFvW7g3lgnATTw/Qg0MCCm98Jm2Pd3fspzfjo31rmU+93rkd1eSt611Rjb64GUk4xGrAt2lfY2EOkG2ECkFthApGNgAxtPx0cTGv7wEGwgUhdsIDawW2ADG8rt1wMbioUG2pkP/G4NtDsfaPsPF7pk3rBy/+x4+/OBthoI9vyK+T4L/rbmA+1AB6LYm4jqBJcV/p8V/h89wP58oK0Ggr1feoIGHTTztz8faIOjPTGe7wOWFvztzAcasazKr/wEVykGHTTwtz8faAFHVJxgnCiVzVdVjgTq+kfmX6B/av725gMtNdBPKQ7wOL+nDDpo4G97PtAGlKUTfIXe/DDABzi2/e3PB1p7FlZKEQsTggb+tucD7UBZFJ15N8ffwnygrTsRyXtWOPk3cT6w14ghvi/6N3E+sPOrMd9mPbDjtLeBSDfABiK1wAYiHQMbiNQCG4h0DGwgUgtsINIxsIEthvIO/D/zlxo4Gk6Ho56ONxx66caBjQFcnMF73WXkjKPfjp6gx+8WrtejZDYGtT5EnEF67WT5lfwefJE8DPX8xkJM+PD5XvigGgX468eBX+0N8Ev5raAh9472I2wsgHl/JoApNlBnRKmX5ieA+0eqNfBlIoBAAGPnuwZY+tTx8odTuH5z8wOoOxEHVuOp910v4ZIG0setmAweVll+Oh45JOg/QX7YQI1p4Pv+IoR39880P2Ky8FPmrlmAqzPaGmBJA51FvFFhqJKC/o3o82ydKKU264lRgsSPs0s49tsaYAmeOw+llMHssaB/v2ebMNovolCtJ0ZPImsVHgGHtga4LEuQzwMpZ880Xx7eKRVGT2wOCSpuEqAK5H4v07dAtTVAoDRBCf0rbOg4ip6mlM9hY9TAUGaXsAzbGuCyIsHxCy1Rf46nHmwm46nRrVwQ7Pfbw2sQtDXACjzqadHoiwnpxgAuz2jrYkLt9UBczkI600AEwQYiNcEGIh0DG3hr/gEpF8+LRC337gAAAABJRU5ErkJggg==")}.jstree-default-dark-small .jstree-node{background-position:-295px -7px;background-repeat:repeat-y}.jstree-default-dark-small .jstree-last{background-image:none}.jstree-default-dark-small .jstree-open>.jstree-ocl{background-position:-135px -7px}.jstree-default-dark-small .jstree-closed>.jstree-ocl{background-position:-103px -7px}.jstree-default-dark-small .jstree-leaf>.jstree-ocl{background-position:-71px -7px}.jstree-default-dark-small .jstree-themeicon{background-position:-263px -7px}.jstree-default-dark-small>.jstree-no-dots .jstree-node,.jstree-default-dark-small>.jstree-no-dots .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-dark-small>.jstree-no-dots .jstree-open>.jstree-ocl{background-position:-39px -7px}.jstree-default-dark-small>.jstree-no-dots .jstree-closed>.jstree-ocl{background-position:-7px -7px}.jstree-default-dark-small .jstree-disabled{background:transparent}.jstree-default-dark-small .jstree-disabled.jstree-hovered{background:transparent}.jstree-default-dark-small .jstree-disabled.jstree-clicked{background:#efefef}.jstree-default-dark-small .jstree-checkbox{background-position:-167px -7px}.jstree-default-dark-small .jstree-checkbox:hover{background-position:-167px -39px}.jstree-default-dark-small.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox,.jstree-default-dark-small .jstree-checked>.jstree-checkbox{background-position:-231px -7px}.jstree-default-dark-small.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox:hover,.jstree-default-dark-small .jstree-checked>.jstree-checkbox:hover{background-position:-231px -39px}.jstree-default-dark-small .jstree-anchor>.jstree-undetermined{background-position:-199px -7px}.jstree-default-dark-small .jstree-anchor>.jstree-undetermined:hover{background-position:-199px -39px}.jstree-default-dark-small .jstree-checkbox-disabled{opacity:.8;filter:url("data:image/svg+xml;utf8,#jstree-grayscale");filter:gray;-webkit-filter:grayscale(100%)}.jstree-default-dark-small>.jstree-striped{background-size:auto 36px}.jstree-default-dark-small.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAACAQMAAAB49I5GAAAABlBMVEUAAAAdHRvEkCwcAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjAAMOBgAAGAAJMwQHdQAAAABJRU5ErkJggg==");background-position:100% 1px;background-repeat:repeat-y}.jstree-default-dark-small.jstree-rtl .jstree-last{background-image:none}.jstree-default-dark-small.jstree-rtl .jstree-open>.jstree-ocl{background-position:-135px -39px}.jstree-default-dark-small.jstree-rtl .jstree-closed>.jstree-ocl{background-position:-103px -39px}.jstree-default-dark-small.jstree-rtl .jstree-leaf>.jstree-ocl{background-position:-71px -39px}.jstree-default-dark-small.jstree-rtl>.jstree-no-dots .jstree-node,.jstree-default-dark-small.jstree-rtl>.jstree-no-dots .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-dark-small.jstree-rtl>.jstree-no-dots .jstree-open>.jstree-ocl{background-position:-39px -39px}.jstree-default-dark-small.jstree-rtl>.jstree-no-dots .jstree-closed>.jstree-ocl{background-position:-7px -39px}.jstree-default-dark-small .jstree-themeicon-custom{background-color:transparent;background-image:none;background-position:0 0}.jstree-default-dark-small>.jstree-container-ul .jstree-loading>.jstree-ocl{background:url("data:image/gif;base64,R0lGODlhEAAQAPMPAEBAQHBwcKqqqoCAgFBQUKCgoGBgYI+Pjzk5OWhoaImJiZiYmFhYWHh4eKenpzMzMyH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQFCgAPACwAAAAAEAAQAEAEcPDJh2gbdcqkutETIoqKkCCCMwxA1koA8AAHwRhAIlMaICwIh6C1CyEYh6IkE0oUFEoEgKCcBWSGz4PAnAAWLcGQ15MlTMJYd1ZyUDXSDGelBY0qIkJg/ZoEFgYICToxDBRvIQMBD1kzgSAgBASQDxEAIfkEBQoADwAsAAAAAA8AEAAABF3wyflCk4hOJZcEBaNJB7I4wCIQo2QshSFw0xAjxWEJQpZJA8EBMCEQW7TWg9EIBFjKh2HQaECjH8PoN2EoBlvAL6FgIAwMgPoo1jQABPNVE9DGJXOMIXN/HJVqIxEAIfkEBQoADwAsAAAAABAADwAABFrwyflMolg2qRZCRyY5A9Ihg4hUAtMxE0BIwcGASpIcApAIPU0hFTMABbMJobFSCi4Sgs4AyHyujIBWxH3AupRGotk1BAgIAvqqkiQAcASAjDHM4A8594vPUyIAIfkEBQoADwAsAAAAABAAEAAABFzwySkNvTKgN5QcBPYcAec12CYVRBeiCCAljawEhuEhVqEGpIfqQViIHiWKrIbYGBgMUaNQcIByBtmlIegeKKELYAxQARKW44SQfYzVQgmC0BweCbIm3C23w/UYEQAh+QQFCgAIACwAAAAAEAAOAAAERRDJiUKgWA4pBM/c1iEFKAVeZ5DYUBCIcFheFU+DsGH1Su2YwwSAMPiCHUHJcsmUPkMMQZY5TqYdIkJrSma4FAJQAgZFAAAh+QQFCgAOACwAAAAAEAAQAAAEa9DJ6Qih2CEmU5ABkCEBlyROsogZ0AAnUKAUwYiJYQVHtSgSBCFBQEwQgIHjwJIAOBSEwmDUAK5VimEwUCSu2IxhsSg0ohjAwYBBNh1PCTAIMCKqBUHSUchmGAJKDlBoEwsCFyNpAmwZjn4RACH5BAUKAA8ALAAAAAAQABAAAARb8Mn5AKBYEmkMz9zFeIYCSgkyPgqDWcjDEJbRSMotAXTWFAMM4oJpuCaIJIjRaASTygxDcTgETpMBI4rdPBoxUKCxeCBuh1NBkHhceSDEmkiMOwQXxzE+OIQpEQAh+QQFCgAOACwBAAEADwAPAAAEVtBJIAmRTOpaL2nb5l3N5SCnBlAOEzjAkEgIgIbB8W73lpihICFAzAQ1n4HsSCsFa6zawrHbCASJhGI6U/gEgcXC4JiFAFdKAXE4MgSXwtqxAKo0g2MEACH5BAUKAA8ALAAAAAAQABAAAARd8Mn5EKJY3geAJBsGXB1nhBTidUjiYZtlEYyUGBlsNHiOGS8fBZAoCieAgLL2WRAwrqFCIOhNFIWExiE4eBYGRkPxMCwaEsPTdjjUesHJAtF+DBw+x/cgIec2SjkRACH5BAUKAA4ALAAAAQAQAA8AAARa0MnpEJKAamkl2Vr3bZkGlMYITkxCXFRJqU5T3A3I7MQh/AqQweBCnAwFmcSwcrwmiMaBKVnUEAsFw5EYOAcBCUNmGCgIhS1Mc3CYHYH2hmB1KII15SaRAEUAACH5BAUKAA8ALAAAAQAQAA8AAARY8MlJH6p4IlABx8BFCUJSiQjxEaTwTYBaBQLTidKiZw/hAwNHoRDI+BgfBEOBsVUGkpck0XA+Do+iYuAzNCQBg4QgETMCDQCWV2CiHwYmSN6AIoq8shgTAQAh+QQFCgAPACwAAAEADwAPAAAEWvBJUoC8+BKxspeDwHxS9wCC4AHIaRrjhbCY4RBZKyWHoiSeGQAQWBiBuaGlRRh4cLLAo+BhJKBOYCMwZBhOsNOkQEhIG5aHTn1oPMwPRmB9cb+ljy8pHsNEAAA7") center center no-repeat}.jstree-default-dark-small .jstree-file{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAMAAABblVsaAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAABAQEEBAQAAAADAwMAAAAAAADHx8cAAAAAAAC1tbWnp6e+vr4AAAAAAADf39/V1dWwsLCSkpI/Pz/GxsaLi4sgICBoaGiGhobDw8P////o6OiZmZny8vL7+/vq6ur+/v7u7u729vbs7Oz4+Pj09PT19fXf39/b29vj4+PY2NjQ0NDMzMzIyMiPj494eHh0e0YfAAAAHnRSTlMAMQw9GCUrBk9hO6URA6STuXke3tu1hETMkDlGaZn4Iun6AAAE6klEQVR42u2bC1PiMBSFSdK0LMLCIijqbkJaSlse6ur//297C9sBJn3YQGbaej8fnXrskR5PxcZr78Ysr9abTdMfH4INROqBDcQGdgtsYFPxHJeccB3vpjpAOQE47dWkLQ107sQ5d85NdYAfBXfU0Qa6ok9O9IVrrg/YAPSCAHnvCqhDr/2kZcWhlQ0s8ieCXO7pOuXkCKe5evYomGADTaek/wPos8zCpIFcMFqZHzP4Jhn4GwTIRQYvCRC+gBB9TT8dfEUTiRADWnl+gpg2EPw/K/w/Un/DAInIILn6KT/Rz9EvISYNJMKHjlTkVx7g9f72AqQO/Z8fGxgGqKObMFp+fgYNNPC3EOCACeYc86PEVgPLz5CyVUpZgNb8rw+wD9Y/VgA8AGKvgYBTeH7xRqkkLm3g5Uuu/8dJz/X/zNMJ5KrtXX6E+OtNopLN2id5et/343gd+4zmHp+KGXHsmzXQT2G0KD+lIikjVRagNX/ik8s9XSdJJPfbvYwSkqcPWJIolTCaf/xahUFGqNZmDYw3m7jwCnMCQMIb1zX7/mRNLvd0nYRyu3vdbWVIcnXKwjBktOD49OAMsDBroFKq5CcU137H1LHmTxS53NN1LiWEsIX3PFeHjktGi46Ptq9vGa/byKyBUcTM0rHvT0Jyuafp53ciufrZXVSOHuze3v8eeX/bBUYN5PLq/Kz5u8HFvW7g3lgnATTw/Qg0MCCm98Jm2Pd3fspzfjo31rmU+93rkd1eSt611Rjb64GUk4xGrAt2lfY2EOkG2ECkFthApGNgAxtPx0cTGv7wEGwgUhdsIDawW2ADG8rt1wMbioUG2pkP/G4NtDsfaPsPF7pk3rBy/+x4+/OBthoI9vyK+T4L/rbmA+1AB6LYm4jqBJcV/p8V/h89wP58oK0Ggr1feoIGHTTztz8faIOjPTGe7wOWFvztzAcasazKr/wEVykGHTTwtz8faAFHVJxgnCiVzVdVjgTq+kfmX6B/av725gMtNdBPKQ7wOL+nDDpo4G97PtAGlKUTfIXe/DDABzi2/e3PB1p7FlZKEQsTggb+tucD7UBZFJ15N8ffwnygrTsRyXtWOPk3cT6w14ghvi/6N3E+sPOrMd9mPbDjtLeBSDfABiK1wAYiHQMbiNQCG4h0DGwgUgtsINIxsIEthvIO/D/zlxo4Gk6Ho56ONxx66caBjQFcnMF73WXkjKPfjp6gx+8WrtejZDYGtT5EnEF67WT5lfwefJE8DPX8xkJM+PD5XvigGgX468eBX+0N8Ev5raAh9472I2wsgHl/JoApNlBnRKmX5ieA+0eqNfBlIoBAAGPnuwZY+tTx8odTuH5z8wOoOxEHVuOp910v4ZIG0setmAweVll+Oh45JOg/QX7YQI1p4Pv+IoR39880P2Ky8FPmrlmAqzPaGmBJA51FvFFhqJKC/o3o82ydKKU264lRgsSPs0s49tsaYAmeOw+llMHssaB/v2ebMNovolCtJ0ZPImsVHgGHtga4LEuQzwMpZ880Xx7eKRVGT2wOCSpuEqAK5H4v07dAtTVAoDRBCf0rbOg4ip6mlM9hY9TAUGaXsAzbGuCyIsHxCy1Rf46nHmwm46nRrVwQ7Pfbw2sQtDXACjzqadHoiwnpxgAuz2jrYkLt9UBczkI600AEwQYiNcEGIh0DG3hr/gEpF8+LRC337gAAAABJRU5ErkJggg==") -103px -71px no-repeat}.jstree-default-dark-small .jstree-folder{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAMAAABblVsaAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAABAQEEBAQAAAADAwMAAAAAAADHx8cAAAAAAAC1tbWnp6e+vr4AAAAAAADf39/V1dWwsLCSkpI/Pz/GxsaLi4sgICBoaGiGhobDw8P////o6OiZmZny8vL7+/vq6ur+/v7u7u729vbs7Oz4+Pj09PT19fXf39/b29vj4+PY2NjQ0NDMzMzIyMiPj494eHh0e0YfAAAAHnRSTlMAMQw9GCUrBk9hO6URA6STuXke3tu1hETMkDlGaZn4Iun6AAAE6klEQVR42u2bC1PiMBSFSdK0LMLCIijqbkJaSlse6ur//297C9sBJn3YQGbaej8fnXrskR5PxcZr78Ysr9abTdMfH4INROqBDcQGdgtsYFPxHJeccB3vpjpAOQE47dWkLQ107sQ5d85NdYAfBXfU0Qa6ok9O9IVrrg/YAPSCAHnvCqhDr/2kZcWhlQ0s8ieCXO7pOuXkCKe5evYomGADTaek/wPos8zCpIFcMFqZHzP4Jhn4GwTIRQYvCRC+gBB9TT8dfEUTiRADWnl+gpg2EPw/K/w/Un/DAInIILn6KT/Rz9EvISYNJMKHjlTkVx7g9f72AqQO/Z8fGxgGqKObMFp+fgYNNPC3EOCACeYc86PEVgPLz5CyVUpZgNb8rw+wD9Y/VgA8AGKvgYBTeH7xRqkkLm3g5Uuu/8dJz/X/zNMJ5KrtXX6E+OtNopLN2id5et/343gd+4zmHp+KGXHsmzXQT2G0KD+lIikjVRagNX/ik8s9XSdJJPfbvYwSkqcPWJIolTCaf/xahUFGqNZmDYw3m7jwCnMCQMIb1zX7/mRNLvd0nYRyu3vdbWVIcnXKwjBktOD49OAMsDBroFKq5CcU137H1LHmTxS53NN1LiWEsIX3PFeHjktGi46Ptq9vGa/byKyBUcTM0rHvT0Jyuafp53ciufrZXVSOHuze3v8eeX/bBUYN5PLq/Kz5u8HFvW7g3lgnATTw/Qg0MCCm98Jm2Pd3fspzfjo31rmU+93rkd1eSt611Rjb64GUk4xGrAt2lfY2EOkG2ECkFthApGNgAxtPx0cTGv7wEGwgUhdsIDawW2ADG8rt1wMbioUG2pkP/G4NtDsfaPsPF7pk3rBy/+x4+/OBthoI9vyK+T4L/rbmA+1AB6LYm4jqBJcV/p8V/h89wP58oK0Ggr1feoIGHTTztz8faIOjPTGe7wOWFvztzAcasazKr/wEVykGHTTwtz8faAFHVJxgnCiVzVdVjgTq+kfmX6B/av725gMtNdBPKQ7wOL+nDDpo4G97PtAGlKUTfIXe/DDABzi2/e3PB1p7FlZKEQsTggb+tucD7UBZFJ15N8ffwnygrTsRyXtWOPk3cT6w14ghvi/6N3E+sPOrMd9mPbDjtLeBSDfABiK1wAYiHQMbiNQCG4h0DGwgUgtsINIxsIEthvIO/D/zlxo4Gk6Ho56ONxx66caBjQFcnMF73WXkjKPfjp6gx+8WrtejZDYGtT5EnEF67WT5lfwefJE8DPX8xkJM+PD5XvigGgX468eBX+0N8Ev5raAh9472I2wsgHl/JoApNlBnRKmX5ieA+0eqNfBlIoBAAGPnuwZY+tTx8odTuH5z8wOoOxEHVuOp910v4ZIG0setmAweVll+Oh45JOg/QX7YQI1p4Pv+IoR39880P2Ky8FPmrlmAqzPaGmBJA51FvFFhqJKC/o3o82ydKKU264lRgsSPs0s49tsaYAmeOw+llMHssaB/v2ebMNovolCtJ0ZPImsVHgGHtga4LEuQzwMpZ880Xx7eKRVGT2wOCSpuEqAK5H4v07dAtTVAoDRBCf0rbOg4ip6mlM9hY9TAUGaXsAzbGuCyIsHxCy1Rf46nHmwm46nRrVwQ7Pfbw2sQtDXACjzqadHoiwnpxgAuz2jrYkLt9UBczkI600AEwQYiNcEGIh0DG3hr/gEpF8+LRC337gAAAABJRU5ErkJggg==") -263px -7px no-repeat}.jstree-default-dark-small>.jstree-container-ul>.jstree-node{margin-left:0;margin-right:0}#jstree-dnd.jstree-default-dark-small{line-height:18px;padding:0 4px}#jstree-dnd.jstree-default-dark-small .jstree-ok,#jstree-dnd.jstree-default-dark-small .jstree-er{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAMAAABblVsaAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAABAQEEBAQAAAADAwMAAAAAAADHx8cAAAAAAAC1tbWnp6e+vr4AAAAAAADf39/V1dWwsLCSkpI/Pz/GxsaLi4sgICBoaGiGhobDw8P////o6OiZmZny8vL7+/vq6ur+/v7u7u729vbs7Oz4+Pj09PT19fXf39/b29vj4+PY2NjQ0NDMzMzIyMiPj494eHh0e0YfAAAAHnRSTlMAMQw9GCUrBk9hO6URA6STuXke3tu1hETMkDlGaZn4Iun6AAAE6klEQVR42u2bC1PiMBSFSdK0LMLCIijqbkJaSlse6ur//297C9sBJn3YQGbaej8fnXrskR5PxcZr78Ysr9abTdMfH4INROqBDcQGdgtsYFPxHJeccB3vpjpAOQE47dWkLQ107sQ5d85NdYAfBXfU0Qa6ok9O9IVrrg/YAPSCAHnvCqhDr/2kZcWhlQ0s8ieCXO7pOuXkCKe5evYomGADTaek/wPos8zCpIFcMFqZHzP4Jhn4GwTIRQYvCRC+gBB9TT8dfEUTiRADWnl+gpg2EPw/K/w/Un/DAInIILn6KT/Rz9EvISYNJMKHjlTkVx7g9f72AqQO/Z8fGxgGqKObMFp+fgYNNPC3EOCACeYc86PEVgPLz5CyVUpZgNb8rw+wD9Y/VgA8AGKvgYBTeH7xRqkkLm3g5Uuu/8dJz/X/zNMJ5KrtXX6E+OtNopLN2id5et/343gd+4zmHp+KGXHsmzXQT2G0KD+lIikjVRagNX/ik8s9XSdJJPfbvYwSkqcPWJIolTCaf/xahUFGqNZmDYw3m7jwCnMCQMIb1zX7/mRNLvd0nYRyu3vdbWVIcnXKwjBktOD49OAMsDBroFKq5CcU137H1LHmTxS53NN1LiWEsIX3PFeHjktGi46Ptq9vGa/byKyBUcTM0rHvT0Jyuafp53ciufrZXVSOHuze3v8eeX/bBUYN5PLq/Kz5u8HFvW7g3lgnATTw/Qg0MCCm98Jm2Pd3fspzfjo31rmU+93rkd1eSt611Rjb64GUk4xGrAt2lfY2EOkG2ECkFthApGNgAxtPx0cTGv7wEGwgUhdsIDawW2ADG8rt1wMbioUG2pkP/G4NtDsfaPsPF7pk3rBy/+x4+/OBthoI9vyK+T4L/rbmA+1AB6LYm4jqBJcV/p8V/h89wP58oK0Ggr1feoIGHTTztz8faIOjPTGe7wOWFvztzAcasazKr/wEVykGHTTwtz8faAFHVJxgnCiVzVdVjgTq+kfmX6B/av725gMtNdBPKQ7wOL+nDDpo4G97PtAGlKUTfIXe/DDABzi2/e3PB1p7FlZKEQsTggb+tucD7UBZFJ15N8ffwnygrTsRyXtWOPk3cT6w14ghvi/6N3E+sPOrMd9mPbDjtLeBSDfABiK1wAYiHQMbiNQCG4h0DGwgUgtsINIxsIEthvIO/D/zlxo4Gk6Ho56ONxx66caBjQFcnMF73WXkjKPfjp6gx+8WrtejZDYGtT5EnEF67WT5lfwefJE8DPX8xkJM+PD5XvigGgX468eBX+0N8Ev5raAh9472I2wsgHl/JoApNlBnRKmX5ieA+0eqNfBlIoBAAGPnuwZY+tTx8odTuH5z8wOoOxEHVuOp910v4ZIG0setmAweVll+Oh45JOg/QX7YQI1p4Pv+IoR39880P2Ky8FPmrlmAqzPaGmBJA51FvFFhqJKC/o3o82ydKKU264lRgsSPs0s49tsaYAmeOw+llMHssaB/v2ebMNovolCtJ0ZPImsVHgGHtga4LEuQzwMpZ880Xx7eKRVGT2wOCSpuEqAK5H4v07dAtTVAoDRBCf0rbOg4ip6mlM9hY9TAUGaXsAzbGuCyIsHxCy1Rf46nHmwm46nRrVwQ7Pfbw2sQtDXACjzqadHoiwnpxgAuz2jrYkLt9UBczkI600AEwQYiNcEGIh0DG3hr/gEpF8+LRC337gAAAABJRU5ErkJggg==");background-repeat:no-repeat;background-color:transparent}#jstree-dnd.jstree-default-dark-small i{background:transparent;width:18px;height:18px;line-height:18px}#jstree-dnd.jstree-default-dark-small .jstree-ok{background-position:-7px -71px}#jstree-dnd.jstree-default-dark-small .jstree-er{background-position:-39px -71px}.jstree-default-dark-small .jstree-ellipsis{overflow:hidden}.jstree-default-dark-small .jstree-ellipsis .jstree-anchor{width:calc(100% - 18px + 5px);text-overflow:ellipsis;overflow:hidden}.jstree-default-dark-small.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABIAAAACAQMAAABv1h6PAAAABlBMVEUAAAAdHRvEkCwcAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjAAMHBgAAiABBI4gz9AAAAABJRU5ErkJggg==")}.jstree-default-dark-small.jstree-rtl .jstree-last{background-image:none}.jstree-default-dark-large .jstree-node{min-height:32px;line-height:32px;margin-left:32px;min-width:32px}.jstree-default-dark-large .jstree-anchor{line-height:32px;height:32px}.jstree-default-dark-large .jstree-icon{width:32px;height:32px;line-height:32px}.jstree-default-dark-large .jstree-icon:empty{width:32px;height:32px;line-height:32px}.jstree-default-dark-large.jstree-rtl .jstree-node{margin-right:32px}.jstree-default-dark-large .jstree-wholerow{height:32px}.jstree-default-dark-large .jstree-node,.jstree-default-dark-large .jstree-icon{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAMAAABblVsaAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAABAQEEBAQAAAADAwMAAAAAAADHx8cAAAAAAAC1tbWnp6e+vr4AAAAAAADf39/V1dWwsLCSkpI/Pz/GxsaLi4sgICBoaGiGhobDw8P////o6OiZmZny8vL7+/vq6ur+/v7u7u729vbs7Oz4+Pj09PT19fXf39/b29vj4+PY2NjQ0NDMzMzIyMiPj494eHh0e0YfAAAAHnRSTlMAMQw9GCUrBk9hO6URA6STuXke3tu1hETMkDlGaZn4Iun6AAAE6klEQVR42u2bC1PiMBSFSdK0LMLCIijqbkJaSlse6ur//297C9sBJn3YQGbaej8fnXrskR5PxcZr78Ysr9abTdMfH4INROqBDcQGdgtsYFPxHJeccB3vpjpAOQE47dWkLQ107sQ5d85NdYAfBXfU0Qa6ok9O9IVrrg/YAPSCAHnvCqhDr/2kZcWhlQ0s8ieCXO7pOuXkCKe5evYomGADTaek/wPos8zCpIFcMFqZHzP4Jhn4GwTIRQYvCRC+gBB9TT8dfEUTiRADWnl+gpg2EPw/K/w/Un/DAInIILn6KT/Rz9EvISYNJMKHjlTkVx7g9f72AqQO/Z8fGxgGqKObMFp+fgYNNPC3EOCACeYc86PEVgPLz5CyVUpZgNb8rw+wD9Y/VgA8AGKvgYBTeH7xRqkkLm3g5Uuu/8dJz/X/zNMJ5KrtXX6E+OtNopLN2id5et/343gd+4zmHp+KGXHsmzXQT2G0KD+lIikjVRagNX/ik8s9XSdJJPfbvYwSkqcPWJIolTCaf/xahUFGqNZmDYw3m7jwCnMCQMIb1zX7/mRNLvd0nYRyu3vdbWVIcnXKwjBktOD49OAMsDBroFKq5CcU137H1LHmTxS53NN1LiWEsIX3PFeHjktGi46Ptq9vGa/byKyBUcTM0rHvT0Jyuafp53ciufrZXVSOHuze3v8eeX/bBUYN5PLq/Kz5u8HFvW7g3lgnATTw/Qg0MCCm98Jm2Pd3fspzfjo31rmU+93rkd1eSt611Rjb64GUk4xGrAt2lfY2EOkG2ECkFthApGNgAxtPx0cTGv7wEGwgUhdsIDawW2ADG8rt1wMbioUG2pkP/G4NtDsfaPsPF7pk3rBy/+x4+/OBthoI9vyK+T4L/rbmA+1AB6LYm4jqBJcV/p8V/h89wP58oK0Ggr1feoIGHTTztz8faIOjPTGe7wOWFvztzAcasazKr/wEVykGHTTwtz8faAFHVJxgnCiVzVdVjgTq+kfmX6B/av725gMtNdBPKQ7wOL+nDDpo4G97PtAGlKUTfIXe/DDABzi2/e3PB1p7FlZKEQsTggb+tucD7UBZFJ15N8ffwnygrTsRyXtWOPk3cT6w14ghvi/6N3E+sPOrMd9mPbDjtLeBSDfABiK1wAYiHQMbiNQCG4h0DGwgUgtsINIxsIEthvIO/D/zlxo4Gk6Ho56ONxx66caBjQFcnMF73WXkjKPfjp6gx+8WrtejZDYGtT5EnEF67WT5lfwefJE8DPX8xkJM+PD5XvigGgX468eBX+0N8Ev5raAh9472I2wsgHl/JoApNlBnRKmX5ieA+0eqNfBlIoBAAGPnuwZY+tTx8odTuH5z8wOoOxEHVuOp910v4ZIG0setmAweVll+Oh45JOg/QX7YQI1p4Pv+IoR39880P2Ky8FPmrlmAqzPaGmBJA51FvFFhqJKC/o3o82ydKKU264lRgsSPs0s49tsaYAmeOw+llMHssaB/v2ebMNovolCtJ0ZPImsVHgGHtga4LEuQzwMpZ880Xx7eKRVGT2wOCSpuEqAK5H4v07dAtTVAoDRBCf0rbOg4ip6mlM9hY9TAUGaXsAzbGuCyIsHxCy1Rf46nHmwm46nRrVwQ7Pfbw2sQtDXACjzqadHoiwnpxgAuz2jrYkLt9UBczkI600AEwQYiNcEGIh0DG3hr/gEpF8+LRC337gAAAABJRU5ErkJggg==")}.jstree-default-dark-large .jstree-node{background-position:-288px 0;background-repeat:repeat-y}.jstree-default-dark-large .jstree-last{background-image:none}.jstree-default-dark-large .jstree-open>.jstree-ocl{background-position:-128px 0}.jstree-default-dark-large .jstree-closed>.jstree-ocl{background-position:-96px 0}.jstree-default-dark-large .jstree-leaf>.jstree-ocl{background-position:-64px 0}.jstree-default-dark-large .jstree-themeicon{background-position:-256px 0}.jstree-default-dark-large>.jstree-no-dots .jstree-node,.jstree-default-dark-large>.jstree-no-dots .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-dark-large>.jstree-no-dots .jstree-open>.jstree-ocl{background-position:-32px 0}.jstree-default-dark-large>.jstree-no-dots .jstree-closed>.jstree-ocl{background-position:0 0}.jstree-default-dark-large .jstree-disabled{background:transparent}.jstree-default-dark-large .jstree-disabled.jstree-hovered{background:transparent}.jstree-default-dark-large .jstree-disabled.jstree-clicked{background:#efefef}.jstree-default-dark-large .jstree-checkbox{background-position:-160px 0}.jstree-default-dark-large .jstree-checkbox:hover{background-position:-160px -32px}.jstree-default-dark-large.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox,.jstree-default-dark-large .jstree-checked>.jstree-checkbox{background-position:-224px 0}.jstree-default-dark-large.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox:hover,.jstree-default-dark-large .jstree-checked>.jstree-checkbox:hover{background-position:-224px -32px}.jstree-default-dark-large .jstree-anchor>.jstree-undetermined{background-position:-192px 0}.jstree-default-dark-large .jstree-anchor>.jstree-undetermined:hover{background-position:-192px -32px}.jstree-default-dark-large .jstree-checkbox-disabled{opacity:.8;filter:url("data:image/svg+xml;utf8,#jstree-grayscale");filter:gray;-webkit-filter:grayscale(100%)}.jstree-default-dark-large>.jstree-striped{background-size:auto 64px}.jstree-default-dark-large.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAACAQMAAAB49I5GAAAABlBMVEUAAAAdHRvEkCwcAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjAAMOBgAAGAAJMwQHdQAAAABJRU5ErkJggg==");background-position:100% 1px;background-repeat:repeat-y}.jstree-default-dark-large.jstree-rtl .jstree-last{background-image:none}.jstree-default-dark-large.jstree-rtl .jstree-open>.jstree-ocl{background-position:-128px -32px}.jstree-default-dark-large.jstree-rtl .jstree-closed>.jstree-ocl{background-position:-96px -32px}.jstree-default-dark-large.jstree-rtl .jstree-leaf>.jstree-ocl{background-position:-64px -32px}.jstree-default-dark-large.jstree-rtl>.jstree-no-dots .jstree-node,.jstree-default-dark-large.jstree-rtl>.jstree-no-dots .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-dark-large.jstree-rtl>.jstree-no-dots .jstree-open>.jstree-ocl{background-position:-32px -32px}.jstree-default-dark-large.jstree-rtl>.jstree-no-dots .jstree-closed>.jstree-ocl{background-position:0 -32px}.jstree-default-dark-large .jstree-themeicon-custom{background-color:transparent;background-image:none;background-position:0 0}.jstree-default-dark-large>.jstree-container-ul .jstree-loading>.jstree-ocl{background:url("data:image/gif;base64,R0lGODlhEAAQAPMPAEBAQHBwcKqqqoCAgFBQUKCgoGBgYI+Pjzk5OWhoaImJiZiYmFhYWHh4eKenpzMzMyH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQFCgAPACwAAAAAEAAQAEAEcPDJh2gbdcqkutETIoqKkCCCMwxA1koA8AAHwRhAIlMaICwIh6C1CyEYh6IkE0oUFEoEgKCcBWSGz4PAnAAWLcGQ15MlTMJYd1ZyUDXSDGelBY0qIkJg/ZoEFgYICToxDBRvIQMBD1kzgSAgBASQDxEAIfkEBQoADwAsAAAAAA8AEAAABF3wyflCk4hOJZcEBaNJB7I4wCIQo2QshSFw0xAjxWEJQpZJA8EBMCEQW7TWg9EIBFjKh2HQaECjH8PoN2EoBlvAL6FgIAwMgPoo1jQABPNVE9DGJXOMIXN/HJVqIxEAIfkEBQoADwAsAAAAABAADwAABFrwyflMolg2qRZCRyY5A9Ihg4hUAtMxE0BIwcGASpIcApAIPU0hFTMABbMJobFSCi4Sgs4AyHyujIBWxH3AupRGotk1BAgIAvqqkiQAcASAjDHM4A8594vPUyIAIfkEBQoADwAsAAAAABAAEAAABFzwySkNvTKgN5QcBPYcAec12CYVRBeiCCAljawEhuEhVqEGpIfqQViIHiWKrIbYGBgMUaNQcIByBtmlIegeKKELYAxQARKW44SQfYzVQgmC0BweCbIm3C23w/UYEQAh+QQFCgAIACwAAAAAEAAOAAAERRDJiUKgWA4pBM/c1iEFKAVeZ5DYUBCIcFheFU+DsGH1Su2YwwSAMPiCHUHJcsmUPkMMQZY5TqYdIkJrSma4FAJQAgZFAAAh+QQFCgAOACwAAAAAEAAQAAAEa9DJ6Qih2CEmU5ABkCEBlyROsogZ0AAnUKAUwYiJYQVHtSgSBCFBQEwQgIHjwJIAOBSEwmDUAK5VimEwUCSu2IxhsSg0ohjAwYBBNh1PCTAIMCKqBUHSUchmGAJKDlBoEwsCFyNpAmwZjn4RACH5BAUKAA8ALAAAAAAQABAAAARb8Mn5AKBYEmkMz9zFeIYCSgkyPgqDWcjDEJbRSMotAXTWFAMM4oJpuCaIJIjRaASTygxDcTgETpMBI4rdPBoxUKCxeCBuh1NBkHhceSDEmkiMOwQXxzE+OIQpEQAh+QQFCgAOACwBAAEADwAPAAAEVtBJIAmRTOpaL2nb5l3N5SCnBlAOEzjAkEgIgIbB8W73lpihICFAzAQ1n4HsSCsFa6zawrHbCASJhGI6U/gEgcXC4JiFAFdKAXE4MgSXwtqxAKo0g2MEACH5BAUKAA8ALAAAAAAQABAAAARd8Mn5EKJY3geAJBsGXB1nhBTidUjiYZtlEYyUGBlsNHiOGS8fBZAoCieAgLL2WRAwrqFCIOhNFIWExiE4eBYGRkPxMCwaEsPTdjjUesHJAtF+DBw+x/cgIec2SjkRACH5BAUKAA4ALAAAAQAQAA8AAARa0MnpEJKAamkl2Vr3bZkGlMYITkxCXFRJqU5T3A3I7MQh/AqQweBCnAwFmcSwcrwmiMaBKVnUEAsFw5EYOAcBCUNmGCgIhS1Mc3CYHYH2hmB1KII15SaRAEUAACH5BAUKAA8ALAAAAQAQAA8AAARY8MlJH6p4IlABx8BFCUJSiQjxEaTwTYBaBQLTidKiZw/hAwNHoRDI+BgfBEOBsVUGkpck0XA+Do+iYuAzNCQBg4QgETMCDQCWV2CiHwYmSN6AIoq8shgTAQAh+QQFCgAPACwAAAEADwAPAAAEWvBJUoC8+BKxspeDwHxS9wCC4AHIaRrjhbCY4RBZKyWHoiSeGQAQWBiBuaGlRRh4cLLAo+BhJKBOYCMwZBhOsNOkQEhIG5aHTn1oPMwPRmB9cb+ljy8pHsNEAAA7") center center no-repeat}.jstree-default-dark-large .jstree-file{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAMAAABblVsaAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAABAQEEBAQAAAADAwMAAAAAAADHx8cAAAAAAAC1tbWnp6e+vr4AAAAAAADf39/V1dWwsLCSkpI/Pz/GxsaLi4sgICBoaGiGhobDw8P////o6OiZmZny8vL7+/vq6ur+/v7u7u729vbs7Oz4+Pj09PT19fXf39/b29vj4+PY2NjQ0NDMzMzIyMiPj494eHh0e0YfAAAAHnRSTlMAMQw9GCUrBk9hO6URA6STuXke3tu1hETMkDlGaZn4Iun6AAAE6klEQVR42u2bC1PiMBSFSdK0LMLCIijqbkJaSlse6ur//297C9sBJn3YQGbaej8fnXrskR5PxcZr78Ysr9abTdMfH4INROqBDcQGdgtsYFPxHJeccB3vpjpAOQE47dWkLQ107sQ5d85NdYAfBXfU0Qa6ok9O9IVrrg/YAPSCAHnvCqhDr/2kZcWhlQ0s8ieCXO7pOuXkCKe5evYomGADTaek/wPos8zCpIFcMFqZHzP4Jhn4GwTIRQYvCRC+gBB9TT8dfEUTiRADWnl+gpg2EPw/K/w/Un/DAInIILn6KT/Rz9EvISYNJMKHjlTkVx7g9f72AqQO/Z8fGxgGqKObMFp+fgYNNPC3EOCACeYc86PEVgPLz5CyVUpZgNb8rw+wD9Y/VgA8AGKvgYBTeH7xRqkkLm3g5Uuu/8dJz/X/zNMJ5KrtXX6E+OtNopLN2id5et/343gd+4zmHp+KGXHsmzXQT2G0KD+lIikjVRagNX/ik8s9XSdJJPfbvYwSkqcPWJIolTCaf/xahUFGqNZmDYw3m7jwCnMCQMIb1zX7/mRNLvd0nYRyu3vdbWVIcnXKwjBktOD49OAMsDBroFKq5CcU137H1LHmTxS53NN1LiWEsIX3PFeHjktGi46Ptq9vGa/byKyBUcTM0rHvT0Jyuafp53ciufrZXVSOHuze3v8eeX/bBUYN5PLq/Kz5u8HFvW7g3lgnATTw/Qg0MCCm98Jm2Pd3fspzfjo31rmU+93rkd1eSt611Rjb64GUk4xGrAt2lfY2EOkG2ECkFthApGNgAxtPx0cTGv7wEGwgUhdsIDawW2ADG8rt1wMbioUG2pkP/G4NtDsfaPsPF7pk3rBy/+x4+/OBthoI9vyK+T4L/rbmA+1AB6LYm4jqBJcV/p8V/h89wP58oK0Ggr1feoIGHTTztz8faIOjPTGe7wOWFvztzAcasazKr/wEVykGHTTwtz8faAFHVJxgnCiVzVdVjgTq+kfmX6B/av725gMtNdBPKQ7wOL+nDDpo4G97PtAGlKUTfIXe/DDABzi2/e3PB1p7FlZKEQsTggb+tucD7UBZFJ15N8ffwnygrTsRyXtWOPk3cT6w14ghvi/6N3E+sPOrMd9mPbDjtLeBSDfABiK1wAYiHQMbiNQCG4h0DGwgUgtsINIxsIEthvIO/D/zlxo4Gk6Ho56ONxx66caBjQFcnMF73WXkjKPfjp6gx+8WrtejZDYGtT5EnEF67WT5lfwefJE8DPX8xkJM+PD5XvigGgX468eBX+0N8Ev5raAh9472I2wsgHl/JoApNlBnRKmX5ieA+0eqNfBlIoBAAGPnuwZY+tTx8odTuH5z8wOoOxEHVuOp910v4ZIG0setmAweVll+Oh45JOg/QX7YQI1p4Pv+IoR39880P2Ky8FPmrlmAqzPaGmBJA51FvFFhqJKC/o3o82ydKKU264lRgsSPs0s49tsaYAmeOw+llMHssaB/v2ebMNovolCtJ0ZPImsVHgGHtga4LEuQzwMpZ880Xx7eKRVGT2wOCSpuEqAK5H4v07dAtTVAoDRBCf0rbOg4ip6mlM9hY9TAUGaXsAzbGuCyIsHxCy1Rf46nHmwm46nRrVwQ7Pfbw2sQtDXACjzqadHoiwnpxgAuz2jrYkLt9UBczkI600AEwQYiNcEGIh0DG3hr/gEpF8+LRC337gAAAABJRU5ErkJggg==") -96px -64px no-repeat}.jstree-default-dark-large .jstree-folder{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAMAAABblVsaAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAABAQEEBAQAAAADAwMAAAAAAADHx8cAAAAAAAC1tbWnp6e+vr4AAAAAAADf39/V1dWwsLCSkpI/Pz/GxsaLi4sgICBoaGiGhobDw8P////o6OiZmZny8vL7+/vq6ur+/v7u7u729vbs7Oz4+Pj09PT19fXf39/b29vj4+PY2NjQ0NDMzMzIyMiPj494eHh0e0YfAAAAHnRSTlMAMQw9GCUrBk9hO6URA6STuXke3tu1hETMkDlGaZn4Iun6AAAE6klEQVR42u2bC1PiMBSFSdK0LMLCIijqbkJaSlse6ur//297C9sBJn3YQGbaej8fnXrskR5PxcZr78Ysr9abTdMfH4INROqBDcQGdgtsYFPxHJeccB3vpjpAOQE47dWkLQ107sQ5d85NdYAfBXfU0Qa6ok9O9IVrrg/YAPSCAHnvCqhDr/2kZcWhlQ0s8ieCXO7pOuXkCKe5evYomGADTaek/wPos8zCpIFcMFqZHzP4Jhn4GwTIRQYvCRC+gBB9TT8dfEUTiRADWnl+gpg2EPw/K/w/Un/DAInIILn6KT/Rz9EvISYNJMKHjlTkVx7g9f72AqQO/Z8fGxgGqKObMFp+fgYNNPC3EOCACeYc86PEVgPLz5CyVUpZgNb8rw+wD9Y/VgA8AGKvgYBTeH7xRqkkLm3g5Uuu/8dJz/X/zNMJ5KrtXX6E+OtNopLN2id5et/343gd+4zmHp+KGXHsmzXQT2G0KD+lIikjVRagNX/ik8s9XSdJJPfbvYwSkqcPWJIolTCaf/xahUFGqNZmDYw3m7jwCnMCQMIb1zX7/mRNLvd0nYRyu3vdbWVIcnXKwjBktOD49OAMsDBroFKq5CcU137H1LHmTxS53NN1LiWEsIX3PFeHjktGi46Ptq9vGa/byKyBUcTM0rHvT0Jyuafp53ciufrZXVSOHuze3v8eeX/bBUYN5PLq/Kz5u8HFvW7g3lgnATTw/Qg0MCCm98Jm2Pd3fspzfjo31rmU+93rkd1eSt611Rjb64GUk4xGrAt2lfY2EOkG2ECkFthApGNgAxtPx0cTGv7wEGwgUhdsIDawW2ADG8rt1wMbioUG2pkP/G4NtDsfaPsPF7pk3rBy/+x4+/OBthoI9vyK+T4L/rbmA+1AB6LYm4jqBJcV/p8V/h89wP58oK0Ggr1feoIGHTTztz8faIOjPTGe7wOWFvztzAcasazKr/wEVykGHTTwtz8faAFHVJxgnCiVzVdVjgTq+kfmX6B/av725gMtNdBPKQ7wOL+nDDpo4G97PtAGlKUTfIXe/DDABzi2/e3PB1p7FlZKEQsTggb+tucD7UBZFJ15N8ffwnygrTsRyXtWOPk3cT6w14ghvi/6N3E+sPOrMd9mPbDjtLeBSDfABiK1wAYiHQMbiNQCG4h0DGwgUgtsINIxsIEthvIO/D/zlxo4Gk6Ho56ONxx66caBjQFcnMF73WXkjKPfjp6gx+8WrtejZDYGtT5EnEF67WT5lfwefJE8DPX8xkJM+PD5XvigGgX468eBX+0N8Ev5raAh9472I2wsgHl/JoApNlBnRKmX5ieA+0eqNfBlIoBAAGPnuwZY+tTx8odTuH5z8wOoOxEHVuOp910v4ZIG0setmAweVll+Oh45JOg/QX7YQI1p4Pv+IoR39880P2Ky8FPmrlmAqzPaGmBJA51FvFFhqJKC/o3o82ydKKU264lRgsSPs0s49tsaYAmeOw+llMHssaB/v2ebMNovolCtJ0ZPImsVHgGHtga4LEuQzwMpZ880Xx7eKRVGT2wOCSpuEqAK5H4v07dAtTVAoDRBCf0rbOg4ip6mlM9hY9TAUGaXsAzbGuCyIsHxCy1Rf46nHmwm46nRrVwQ7Pfbw2sQtDXACjzqadHoiwnpxgAuz2jrYkLt9UBczkI600AEwQYiNcEGIh0DG3hr/gEpF8+LRC337gAAAABJRU5ErkJggg==") -256px 0 no-repeat}.jstree-default-dark-large>.jstree-container-ul>.jstree-node{margin-left:0;margin-right:0}#jstree-dnd.jstree-default-dark-large{line-height:32px;padding:0 4px}#jstree-dnd.jstree-default-dark-large .jstree-ok,#jstree-dnd.jstree-default-dark-large .jstree-er{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAABgCAMAAABblVsaAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAABAQEEBAQAAAADAwMAAAAAAADHx8cAAAAAAAC1tbWnp6e+vr4AAAAAAADf39/V1dWwsLCSkpI/Pz/GxsaLi4sgICBoaGiGhobDw8P////o6OiZmZny8vL7+/vq6ur+/v7u7u729vbs7Oz4+Pj09PT19fXf39/b29vj4+PY2NjQ0NDMzMzIyMiPj494eHh0e0YfAAAAHnRSTlMAMQw9GCUrBk9hO6URA6STuXke3tu1hETMkDlGaZn4Iun6AAAE6klEQVR42u2bC1PiMBSFSdK0LMLCIijqbkJaSlse6ur//297C9sBJn3YQGbaej8fnXrskR5PxcZr78Ysr9abTdMfH4INROqBDcQGdgtsYFPxHJeccB3vpjpAOQE47dWkLQ107sQ5d85NdYAfBXfU0Qa6ok9O9IVrrg/YAPSCAHnvCqhDr/2kZcWhlQ0s8ieCXO7pOuXkCKe5evYomGADTaek/wPos8zCpIFcMFqZHzP4Jhn4GwTIRQYvCRC+gBB9TT8dfEUTiRADWnl+gpg2EPw/K/w/Un/DAInIILn6KT/Rz9EvISYNJMKHjlTkVx7g9f72AqQO/Z8fGxgGqKObMFp+fgYNNPC3EOCACeYc86PEVgPLz5CyVUpZgNb8rw+wD9Y/VgA8AGKvgYBTeH7xRqkkLm3g5Uuu/8dJz/X/zNMJ5KrtXX6E+OtNopLN2id5et/343gd+4zmHp+KGXHsmzXQT2G0KD+lIikjVRagNX/ik8s9XSdJJPfbvYwSkqcPWJIolTCaf/xahUFGqNZmDYw3m7jwCnMCQMIb1zX7/mRNLvd0nYRyu3vdbWVIcnXKwjBktOD49OAMsDBroFKq5CcU137H1LHmTxS53NN1LiWEsIX3PFeHjktGi46Ptq9vGa/byKyBUcTM0rHvT0Jyuafp53ciufrZXVSOHuze3v8eeX/bBUYN5PLq/Kz5u8HFvW7g3lgnATTw/Qg0MCCm98Jm2Pd3fspzfjo31rmU+93rkd1eSt611Rjb64GUk4xGrAt2lfY2EOkG2ECkFthApGNgAxtPx0cTGv7wEGwgUhdsIDawW2ADG8rt1wMbioUG2pkP/G4NtDsfaPsPF7pk3rBy/+x4+/OBthoI9vyK+T4L/rbmA+1AB6LYm4jqBJcV/p8V/h89wP58oK0Ggr1feoIGHTTztz8faIOjPTGe7wOWFvztzAcasazKr/wEVykGHTTwtz8faAFHVJxgnCiVzVdVjgTq+kfmX6B/av725gMtNdBPKQ7wOL+nDDpo4G97PtAGlKUTfIXe/DDABzi2/e3PB1p7FlZKEQsTggb+tucD7UBZFJ15N8ffwnygrTsRyXtWOPk3cT6w14ghvi/6N3E+sPOrMd9mPbDjtLeBSDfABiK1wAYiHQMbiNQCG4h0DGwgUgtsINIxsIEthvIO/D/zlxo4Gk6Ho56ONxx66caBjQFcnMF73WXkjKPfjp6gx+8WrtejZDYGtT5EnEF67WT5lfwefJE8DPX8xkJM+PD5XvigGgX468eBX+0N8Ev5raAh9472I2wsgHl/JoApNlBnRKmX5ieA+0eqNfBlIoBAAGPnuwZY+tTx8odTuH5z8wOoOxEHVuOp910v4ZIG0setmAweVll+Oh45JOg/QX7YQI1p4Pv+IoR39880P2Ky8FPmrlmAqzPaGmBJA51FvFFhqJKC/o3o82ydKKU264lRgsSPs0s49tsaYAmeOw+llMHssaB/v2ebMNovolCtJ0ZPImsVHgGHtga4LEuQzwMpZ880Xx7eKRVGT2wOCSpuEqAK5H4v07dAtTVAoDRBCf0rbOg4ip6mlM9hY9TAUGaXsAzbGuCyIsHxCy1Rf46nHmwm46nRrVwQ7Pfbw2sQtDXACjzqadHoiwnpxgAuz2jrYkLt9UBczkI600AEwQYiNcEGIh0DG3hr/gEpF8+LRC337gAAAABJRU5ErkJggg==");background-repeat:no-repeat;background-color:transparent}#jstree-dnd.jstree-default-dark-large i{background:transparent;width:32px;height:32px;line-height:32px}#jstree-dnd.jstree-default-dark-large .jstree-ok{background-position:0 -64px}#jstree-dnd.jstree-default-dark-large .jstree-er{background-position:-32px -64px}.jstree-default-dark-large .jstree-ellipsis{overflow:hidden}.jstree-default-dark-large .jstree-ellipsis .jstree-anchor{width:calc(100% - 32px + 5px);text-overflow:ellipsis;overflow:hidden}.jstree-default-dark-large.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAACAQMAAAAD0EyKAAAABlBMVEUAAAAdHRvEkCwcAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjgIIGBgABCgCBvVLXcAAAAABJRU5ErkJggg==")}.jstree-default-dark-large.jstree-rtl .jstree-last{background-image:none}@media (max-width:768px){#jstree-dnd.jstree-dnd-responsive{line-height:40px;font-weight:bold;font-size:1.1em;text-shadow:1px 1px white}#jstree-dnd.jstree-dnd-responsive>i{background:transparent;width:40px;height:40px}#jstree-dnd.jstree-dnd-responsive>.jstree-ok{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAHgCAMAAACsKhCPAAACnVBMVEUAAAAzMzOZmZnl5eXm5ubn5+fo6Ojp6enq6urr6+vs7Ozt7e3u7u7v7+/w8PDx8fHy8vLz8/P09PT19fX29vb39/f4+Pj5+fn6+vr7+/v8/Pz9/f3+/v7///8AAADl5eX///8AAABzc3N0dHR1dXV2dnZ3d3d4eHh5eXl6enp7e3t8fHx9fX1+fn5/f3+AgIAAAAAAAAAAAAAAAAAUFBQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKCgoZGRkbGxtYWFgAAAAAAAAEBAQXFxceHh4kJCRkZGRoaGhvb28AAAAwMDBVVVVWVlZXV1dYWFhZWVlaWlpbW1tcXFxdXV1eXl4AAABUVFROTk5PT09QUFBRUVFSUlJTU1NUVFRVVVVWVlZbW1sAAABLS0tMTEypqamioqKhoaGioqKNjY3a2trc3Nzd3d3f39/h4eHi4uLj4+Pl5eXm5ubn5+fp6enr6+vt7e3v7+/x8fHz8/P09PT29vb39/f5+fn6+vr7+/v9/f2ZmZmoqKipqamqqqqrq6usrKytra2urq6vr6+wsLCxsbGysrKzs7O0tLS1tbW2tra3t7e4uLi5ubm6urq7u7u8vLy9vb2+vr6/v7/AwMDBwcHCwsLDw8PExMTFxcXGxsbHx8fIyMjJycnKysrLy8vMzMzNzc3Ozs7Pz8/Q0NDR0dHS0tLT09PU1NTV1dXW1tbX19fY2NjZ2dna2trb29vc3Nzd3d3e3t7f39/g4ODh4eHi4uLj4+Pk5OTl5eXm5ubn5+fo6Ojp6enq6urr6+vs7Ozt7e3u7u7v7+/w8PDx8fHy8vLz8/P09PT19fX29vb39/f4+Pj5+fn6+vr7+/v8/Pz9/f3+/v7///9VzvWeAAAAhnRSTlMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQECAgICAgICAgICAgICAgIEBQYMDQ4PEBESFBgbJSYoMDEzNjk6PT4+Q0VHR0dHSUtUVFRUVFRUVFRUVVhcXFxcXFxcXFxcYWhoeZGSkqH+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/q32P5YAABYKSURBVHja7d1rkxvVmQfw/3O6NSPLw5hFy2RCPJudrWzCLZCqrs3H2G+QNdnKZuW7xxjjcYwZzGCTweXx3UpIiuLdfpJ9pyouNhjHWQFjiDzQlMsBoVGfy77QXWpJ3ZKmu9U6/YZxS31O//Sc0+f07cFcwKiXjbZ/Lwy3ucfl7A1v3zMxYYsGa7AGa7AGa7AGa3C8wJ5niws6wjEDLz6KB/mYg5tbrTn/OJLIT0yEzflnl3EOwYrNkL1YDlhshuwNXGyG7Q1abA46ZA45fDa8AYvNsOMbtLg72EqhmBvgM//eQMVdwVY6i4yVc22uc+ksMtbmwH2g3Ruk2OzhRTZj5bp4kc1gc0TxBYDlI6VQI2ylswCQrcWxwzuE2M0b9rBU9bqq5np8Nrj33FcPQgTXvS6quR6fDeG9WQjxoNXk7VDN9fjM0/lRyF43cIu3TTXX8dnGeHldwG3eFvFc52dWbqy8LuBUtn1NXdzhBbJ7xsvrbWpZFbt4x6w9u4KLmay72NWbKY6X1wWcs9zFcPXaufHyujVpd/ES1t28m2Pmde3DrmIX7jh63Q9aruLt8fJozKU9iX148ejjy1DtK8/fCt7bbVjKWZkbSnXuY3UhEO217/upSEEp1VqGQtcKgh+Hc9bea0q6kwnEsM8u+KjmQfLcCdn6CxIdXVOFclTAyFn7r0gpVaeYiDE6YH/pp5o88OZxpZqDTMSOr6EQGTBy1sFLSoq2hggiMogO2l/4qycPrL3U8gMSMfbSWwHfd+g5tcxZh9eF4q1BJmIm2GHb96WsPLB2DErKWrMmMCZfPI8I3VvKWUvnoYSQTe2QGQS2ZH/uv6Y8cP4omoJMxJh59EKU7i3lrGNrXAleFxMzGZnH7E8HqSoPXFiSokUs5NJ6lO4t5azj5ypiVW3OBksct/9vsLrywIUjQkjREBtCHL4YpXtLOWt5lTuSC6VAZJhkTi3bdwetLA9cPCSg6p2EGOfi0OUw7y11ik+dccrSEQpkEJnJU/adwWvLA5cOCtEsNoU4cCVK95ZuP3n6VeFACBgGm06dtm8PU10euLJfcCVF5WBN4A4X+69F4d5SbUr48VOvvcK5o0Bmcudr9sfD1ZcHru0V3BHVQxcRc7jYdz38e0u1ReLWM6//TkrCVOqR1+1bw1ZoA9czgvOGmAtJBy+HfW+padKPm8++8TvawvTsG/bNoStUXwPZ3wrOawdrYgLG1KFXS5GJMPDBc2+slJBcsT8YvkKFr4A//JcUNTExZTbPbSIQYeD951dexYr9PkYBxibw9m8Ed2RlsDPBDPPy1w8iAubV0enEcLfAW37A+8Cf/lMKIYQCmSwxnbp+pxCVg1ZtPB5VhRIA/gb8+ddCcCXB2FRq5u2/FCIzLI16qXTWL4F3XhBClpGYTs2+85dCfB9qqR6dvgDe2aPAMD2z6527Id5bWggIjHvAu3uMEpKPvHu3MAkPpuEe8O5vS0j+8W4h1o8eNgbcDeCPGWTvFuL9cGnTDONz4BzsQswfHxYtZxKl+D8g3n7uFPSi33nQ4BEsCzrCGqzBGqzBGhwV8IaOsAZrsAZrsAZrsAZrsAZrsAZr8GSCt+Mq5YaOsAYPDo5S/isd4W0GD5XxauADzUJo4MX5x5EE34ajZTQjvFjJeDWaF8isVHNlvJiLHnixlvFqCHG9dba/fuyWIiSAFmT29Q4r7uIdJtXLNoEXmzNeDS1ODZc+IADwYmvGq0HFc9We+0TnR//UWTkvhtakF9szXg0kXnz8H7rnbn/dZd3eX36VDwW82JnxahDxo/MX/W1w44gTSoQX3TJeDSCmGb9bzFAo4Ecf78x4NYhYfet3i29VSH24cxlE/CDxguFrA1F6EAr4QfLc8ijE+bzfaXFIR+k80EUc17OlrmJ/z0cuPp702aR/GNKwNCKx72EJIQ1LoxKPzbA0wlY9RufDsRT3HIfjKO498YihuM9MK37iflPL2In7v11aiJe4/8kDL9BbxzrGV+/Zgv2d/VDoYAVAydbdJh+7JZUPMkUBPDX/9NGWBEQEIvamx2zBSrllqOoKJqbCBk/NP3O8Ja0WEYHevOX1DTr3nFxdvaH34cX5Z17i7Wmw2JpnL5QQPsBG2E16cf7pFx3RmgQLtPaRd68U3lM4EEPITXpx/umjZd6SEAqMzn/k441QKbjwDDZghBrhxfmnl8r1LDIAESNmXPDjVUJw7hmsSIQZ4cX5pw6XHN6c/oox48LHvt74lZxz6fG7DGSGGOHF+acOfV/mTamgDDDzoj+vksLxDlZMhhfhxfknDxTLDm94iYzEpds+3+iWgjveI2zK0CK8OP/k/u+2yqKe+MogMqau+PUqwR1HePyyATO0Prw4/+S+b0tbvJH2ihLm9LXbvt/Yl4J7BksSYUV4cf5nB/9eLDmi7mVGInn9k4Lts3wluVP2HGHiYfXhR//x0FapVKrWT2QYxtSO7CeFr31XILmPCBs8vD6spODVIxaRYZrJ1B/uFL7yXb4SgnOv92cUF2H14QfJy/sMBsmr6R3N5M637xQGeSZDCu54Bpuh9eE8cP035TKHUCDTmErN/OlO4f4gFUju+ACH16TzwNvNGa/+/JfC3wYpX0kpPDdpCBnexCPfnvHqy8EqYESMfHw3vKllvjXj1RcDVpCYmpZeT4HM6alEiHPpfHPGq3sDlq+mZpTpeRzeMTMV5tlSvpHxamCvo2amtzyDpxPKCfMZj3wt49XAzyE8SCyPxzMeDfE52IXPBy4+H7mr9X3vLQWf8SpUMGKF9QIealmYNPDYRHhh0sDQYA3W4IkGb+gIa7AGa7AGa7AGa7AGa7AGa7DXZdirJhs6whqswRqswRqswbEHDzjeL4xw/rCgIxwcuDUFVmUZJhHWqMsbLdhKmbPrLutbE2Ft+NG6lrc0G6TZ7L57j627f5L9VfWPuWRp0we3W3nrwFIqMHI3sJXOdtskU33Nci7tIwdYj/IArCNj5UIF9/LamzUvshmPTbq3F0A2KLE5jNfzfvb1Bic2h/J63E8P3sDE5nBeT/vpyRuU2A2c8uFtOmh3XVJZb/sSSFZAF7D1WH2EfNg+R+j01g/a3QPctbzqUh+dHwsgxC7g1Ho9njnXmW2r1+63k73L2wCsTLW89T2hRLi2aqkLxae3b3nIWUvrgc3sO6uwZqt/PByNt195AHK1r8xuf5s2u7dAePH2n2n1Ka91xrUnhAh3rplLobg5qNdfMzXD6MNuMa1Nmv17x+8Sz1w6W08VPP7e/uCqMZvBZhy8fcH1aWE2A8TA2xfcmBZml7A+/l4/h8V1xMDbF1zMZHucRMQEXHk3jKrTvky2/V0xqp80ebuo1VzeMN/ZLrBUUI3MVveRuaEaObEIRBm78ibxD9I3XvDw4lxrecrDdwIGK6lUI9OTKmDvdVUlE4hor13JyDufvq5MD+C28jx8J3CwVKi/9KvwN+y7Wk0DRsRon115c/qH6WvKUwK49vL6fyfoJi2kBFONHfwSB66gEgKDDtiVN6efSF8VRF7AHeX1/U7QYMklWC1JjALwBQ5eIqkARgftypvTP0pfchQZnsAd5fX7TuAR5gJGS5+7h8MXlQRjh+3Km8S70xfLAga8RbijvD7fCboPCy6gyGjewQ0cuSRgHLYr190X0utbjiTFPPVhl/I6wJwLKGaGFGHBlWLV5lX9z2c4vI7D9me1k/ryliMNUpBeIuxSXmeEOUGE06QhhQMYbX3uU2RQ/LS2lShvOVCGt5yVruV1gkEBeF3AnCCFUoZo28GWN4mdrbLDGMhD9rdu5bUsgjuCJIiHAC6+ckIKIWr9yf1X39raEoaJV4r9g+KpvHK5LA2JV4ohgHOzDJITMyuXEN0i8pPZrXJZEdjDu/1r8FCeNVsuO4rAHoZyIZ6bDFIqenHVyrnu4L+mX/y2xBmY6SmfYd/yrEZ5oRy0imdeMiAk1PLFWddtZo/8vVRWzJg6U/RymPFTXijgXCpZKpe54OX/TpjMZch0HpQdaZjTyW9ue6nCR3kh3T0snlwpO7xcLpkmY26zQC5gJKZTJ4vesqp4Ly+kCwA5a+WU4MLZIqKOVNJKKaVYIrFjZsX+yFsdnssL64Y4ctbq75SSgkvVPrUgEDHDmJ6ZXbVvea3EY3nhPfKAnPXGKWJU5lyqlmTJRMQMcyo1s2vVvum9Fk/lhflQC3LW6srUVGnLEbL1QMyYkZhOzjyyYn/opxoP5YX72BJy1suPHSuWtpzWpG3EWGI6mTr/TfEDf/X0LS/sB9OQg3XSnD1W5m07aE6df8iL7/uuqHd5EXj0EMgB1skRPgw66vJGDq7s40iXcP6HtD7AMVwmHjzq5+8XdIQ1WIM1WIM1WIM1WINHvWzoCGuwBmuwBmuwBmuwBmuwBmuwBmuwBmuwBocEjlz+Kx3hbQVHIP9VgOBo5L8KDByV/FdBgSOT/yogcHTyXwUDjlD+q0DAUcp/FQQ4UvmvggBHKv9VAOBo5b8KAByt/FcBgJvyX7lMLX/Ci4Hmv9p+cFP+K/ejV8YKMv/V9oOb8l+5H72ajlVj2KZ75tMy+25jxqEPT/L5sAZrsAZrsAZHD9yU28rtBWFq+87Yg5tyW8nORB1NH1BMwE25rapZpVrAjQ8CyX8VCFgqVCxStoup8cFw+a/OevvajY0AmnQlt1XtzzZw44Ph8l/diFAfruS2ouqf7eD6B8HkvwoCXMltRdU/28CND4bLf7URoT5cyX/Fqq62V9gVYwgy/1UgEa7nv1JStoEVSYUg818FMfGo5L8SADrzblTXiMDyX20/uJb/ygQ4M2Xb5MIwTcaDzH+1/eBa/isDKL74VqLtwGSY7MUi4ASW/2r7wbX8V8aslbMOuD4BEGT+qwD6cDX/FZbOWjmgPSPUQ8BKL30XWP6rAMDV/FcKL1/ukv/q0HffO0HlvwoAXMt/Jcq/TTDWkSxISudhgPmvghiWIpX/KghwpPJfBXKJJ0r5rwIBRyn/VTDgCOW/CggcnfxXQYEjk/8qMHBU8l8FCEYk8l8FC4YGxw68oCOswRqswRqswRqswRqswRqswRqswRq8fcvZGxsTFuEvdJPWYA3WYA3WYA3W4EkEe5/0LegIjynY5V34Mb8R3gecerdz3Z4Ff819rMBmbFu/7sM9l7lkaWOiwKl39/7yq/wEgU3cOE3i80nqw+rMUYnPJwlMF45inMUDHKXHWzzIsDTW4oHG4QsHJgyMq/v/7f7nkwTGtYPj2qoHnVpeOWoY+UkA119yufDmexMA5k3vmp74jwlo0sU9idqfjLYmALzZaNMGRNzBUz9q+acznicRPsA/E82v5ZF4L+4RPtL2719P1DgMKJow8P/EbGqpEM+lG9glk1bbjEvFC+ySSasVzOIG7i2m4SO86ulbQeTTqjTpjkxa7QEeEnwjahEWojfYiFmTllKIXmCDhgRvRA0sRK/kUQwUtwgLznuBVfzATm9w7IYlIXqBDRIxbNI9zvAlzPiBnV7gOEa4J5jFDsw575EeTBnjmPGwX4R7grmaLLAZwwj3atLEZQyHJafXdiJ+Jw89IyxEDGdaEwUm1is/eO9PxxI8NZWURvfNEslpM15gc0b1yktq7thpxArM1c7pUo+ppTlt/vv/xglcPNG3xfJinMAxTJXWpw9rcKzBCzrCGqzBGqzBGqzBGqzBGqzBGqzBI18WdIQ1WIM1WIM1OMLgAR+rXNAR1uBogA3hv6E2ttmYjAiLkCI83M+7oPvwoMs/fzph4F0BRthvu9zoiIaIeZPehbFa9DiswRo8ueC5FIqb/rdKlja9r44SeC6dRcb35Gwunc1g0+vqKIHn0lkgm7E6H1C8B2B3l62sdBYutDn31VECz6WzAJDNfONnKyudBTppc+6rowSueoHsPivn09tBm3NfHSVw3Qtcz3gWW/WtWmhzzaujeT7c5AWy7eLd9/p5W8RzLautXATBLV7PYqtlq7p4rm31NovN4b0exVbbVlXxXMfq7RWbI/AC2V+1rXAZlVLtW2Uz2HQpLLsnYhF28SJTah+Kd3soKZsBXAqLWB929dq5zqlH+1LMdDaMJax3FlaMFHhgL3JWp7iT21lYuGCv3t0exYF7/WYQd/Hu87yLHsTb7vUHdo3vN953sa84Y4c5tew43XVvz9xHbX3EAXh7gCunu5t9++/zGJU4CG93cPV0tyF29/rdxR7iQLxdwfXT3Zp4NF5gE13EwXi7gRunu1WxL+/uAcQBeTvBCgB+kL5RyYlHuLEX95tW1BYC9tr36xt4XxTuJ39/vH0jWvvufvtOBAieT1+XSkGBQHR9HwqVFY3dICLaZxcGqVBhfucx0ZZvjejY/h8UEFaTnk9fE6riIyK6eiC582ptRWX3gF7e3icO8+mrQnWA6eoBFEIBSzyRviqElJV2RcTo4qXDTlNOQCLGjP32l4M1v/n0FS5lB5ixKwfxZThNOnlFyXpGPAIj2ucoVf0BQGAM7KD9xWA7Z6UvO/Vfs+mIwJi8fKj+P3ANFlw6eFkKUetmRCBAof5PRmCH7HuDVWelL24J0ZlBkogZ4uIR3Au+SSts4NA6SVkXA6RqPzqRQWQcsTcGO6Ja6QtbjmgcshrZMYkMQ144Wr1oqQLtw/gMS+dJSZc8j8QMRsZR+7PBhhArff57h9d7C4Gamg4zOD9/rDLqBz0sfYpja5KrDjExgpE4Zn86aHte+36L17L4EGMEKCXr/za5XDse+GVaBQB5HH+Tc9Xa2ajiPW7nOzfw5v19seRwWR3vGBhjkEKK2hrH5OL3L1u5wJs0gL/ixFnBFW8SE7EEmdMn7L9iILCVfuu7YsmpexNkJtZw3BGq8RskJN56ycoF3qQB3MXJVcHROMAQGYwlkiftuwPWlForl77fqjToamGnbbx2RopaLcSEYom1g0FPPCrLnZ+eOiO4UztYExmGMbXjlH2nyy/Uf5FSCO5IVSssddq+g5+ePiNrtRCDKaQM4aAFAPjkZ6dXBHckVwogMg1zOnXa/gSDgosnzjFIwZVqLqypFiLTADNPFEMC4/aTK6dF5dBFzKBEcueKfXvwmnLW8kq57CihqLmwei2KDDKndywHfZm2KdXdR0+fOVX59ck0EztmztgfuZ7+eBavnOLcUZJRc2HVWiqrd67YubCaNIBbz6yeFJxDEZtKPbJq38IwYOSs1ZNCKGFMtxR265nm1TmECMbNZ88uK0XCSD6y66x9c9jKctbZZRjcTLUWdvNZ19VhgPHhz88tkymMnbvO2R92O6P3Iz53apqbO1dbC/vw522rQ4sw8MFz515JcnPn6/YHo6guZ62uACvthX3wnOvqMMB4//nXXwVes9/vfs3Gn3jlVZfC3n++ZXWIEQbe+8WJqXJxZP/rnfd+cbz0nufVwVzTat+XH6F+KWIUYl+rtx+82zW53497FPEvAMRnGJOlAzz8nhtirMDbs/zYmDBwo930k4taLxlvcL9l971wIhznZHjbF+FBjln3hi8iqk1a+Ovyce3DsTtKa3CswQs6whqswdu2/D85IzI9LXdOHAAAAABJRU5ErkJggg==");background-position:0 -200px;background-size:120px 240px}#jstree-dnd.jstree-dnd-responsive>.jstree-er{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAHgCAMAAACsKhCPAAACnVBMVEUAAAAzMzOZmZnl5eXm5ubn5+fo6Ojp6enq6urr6+vs7Ozt7e3u7u7v7+/w8PDx8fHy8vLz8/P09PT19fX29vb39/f4+Pj5+fn6+vr7+/v8/Pz9/f3+/v7///8AAADl5eX///8AAABzc3N0dHR1dXV2dnZ3d3d4eHh5eXl6enp7e3t8fHx9fX1+fn5/f3+AgIAAAAAAAAAAAAAAAAAUFBQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKCgoZGRkbGxtYWFgAAAAAAAAEBAQXFxceHh4kJCRkZGRoaGhvb28AAAAwMDBVVVVWVlZXV1dYWFhZWVlaWlpbW1tcXFxdXV1eXl4AAABUVFROTk5PT09QUFBRUVFSUlJTU1NUVFRVVVVWVlZbW1sAAABLS0tMTEypqamioqKhoaGioqKNjY3a2trc3Nzd3d3f39/h4eHi4uLj4+Pl5eXm5ubn5+fp6enr6+vt7e3v7+/x8fHz8/P09PT29vb39/f5+fn6+vr7+/v9/f2ZmZmoqKipqamqqqqrq6usrKytra2urq6vr6+wsLCxsbGysrKzs7O0tLS1tbW2tra3t7e4uLi5ubm6urq7u7u8vLy9vb2+vr6/v7/AwMDBwcHCwsLDw8PExMTFxcXGxsbHx8fIyMjJycnKysrLy8vMzMzNzc3Ozs7Pz8/Q0NDR0dHS0tLT09PU1NTV1dXW1tbX19fY2NjZ2dna2trb29vc3Nzd3d3e3t7f39/g4ODh4eHi4uLj4+Pk5OTl5eXm5ubn5+fo6Ojp6enq6urr6+vs7Ozt7e3u7u7v7+/w8PDx8fHy8vLz8/P09PT19fX29vb39/f4+Pj5+fn6+vr7+/v8/Pz9/f3+/v7///9VzvWeAAAAhnRSTlMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQECAgICAgICAgICAgICAgIEBQYMDQ4PEBESFBgbJSYoMDEzNjk6PT4+Q0VHR0dHSUtUVFRUVFRUVFRUVVhcXFxcXFxcXFxcYWhoeZGSkqH+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/q32P5YAABYKSURBVHja7d1rkxvVmQfw/3O6NSPLw5hFy2RCPJudrWzCLZCqrs3H2G+QNdnKZuW7xxjjcYwZzGCTweXx3UpIiuLdfpJ9pyouNhjHWQFjiDzQlMsBoVGfy77QXWpJ3ZKmu9U6/YZxS31O//Sc0+f07cFcwKiXjbZ/Lwy3ucfl7A1v3zMxYYsGa7AGa7AGa7AGa3C8wJ5niws6wjEDLz6KB/mYg5tbrTn/OJLIT0yEzflnl3EOwYrNkL1YDlhshuwNXGyG7Q1abA46ZA45fDa8AYvNsOMbtLg72EqhmBvgM//eQMVdwVY6i4yVc22uc+ksMtbmwH2g3Ruk2OzhRTZj5bp4kc1gc0TxBYDlI6VQI2ylswCQrcWxwzuE2M0b9rBU9bqq5np8Nrj33FcPQgTXvS6quR6fDeG9WQjxoNXk7VDN9fjM0/lRyF43cIu3TTXX8dnGeHldwG3eFvFc52dWbqy8LuBUtn1NXdzhBbJ7xsvrbWpZFbt4x6w9u4KLmay72NWbKY6X1wWcs9zFcPXaufHyujVpd/ES1t28m2Pmde3DrmIX7jh63Q9aruLt8fJozKU9iX148ejjy1DtK8/fCt7bbVjKWZkbSnXuY3UhEO217/upSEEp1VqGQtcKgh+Hc9bea0q6kwnEsM8u+KjmQfLcCdn6CxIdXVOFclTAyFn7r0gpVaeYiDE6YH/pp5o88OZxpZqDTMSOr6EQGTBy1sFLSoq2hggiMogO2l/4qycPrL3U8gMSMfbSWwHfd+g5tcxZh9eF4q1BJmIm2GHb96WsPLB2DErKWrMmMCZfPI8I3VvKWUvnoYSQTe2QGQS2ZH/uv6Y8cP4omoJMxJh59EKU7i3lrGNrXAleFxMzGZnH7E8HqSoPXFiSokUs5NJ6lO4t5azj5ypiVW3OBksct/9vsLrywIUjQkjREBtCHL4YpXtLOWt5lTuSC6VAZJhkTi3bdwetLA9cPCSg6p2EGOfi0OUw7y11ik+dccrSEQpkEJnJU/adwWvLA5cOCtEsNoU4cCVK95ZuP3n6VeFACBgGm06dtm8PU10euLJfcCVF5WBN4A4X+69F4d5SbUr48VOvvcK5o0Bmcudr9sfD1ZcHru0V3BHVQxcRc7jYdz38e0u1ReLWM6//TkrCVOqR1+1bw1ZoA9czgvOGmAtJBy+HfW+padKPm8++8TvawvTsG/bNoStUXwPZ3wrOawdrYgLG1KFXS5GJMPDBc2+slJBcsT8YvkKFr4A//JcUNTExZTbPbSIQYeD951dexYr9PkYBxibw9m8Ed2RlsDPBDPPy1w8iAubV0enEcLfAW37A+8Cf/lMKIYQCmSwxnbp+pxCVg1ZtPB5VhRIA/gb8+ddCcCXB2FRq5u2/FCIzLI16qXTWL4F3XhBClpGYTs2+85dCfB9qqR6dvgDe2aPAMD2z6527Id5bWggIjHvAu3uMEpKPvHu3MAkPpuEe8O5vS0j+8W4h1o8eNgbcDeCPGWTvFuL9cGnTDONz4BzsQswfHxYtZxKl+D8g3n7uFPSi33nQ4BEsCzrCGqzBGqzBGhwV8IaOsAZrsAZrsAZrsAZrsAZrsAZr8GSCt+Mq5YaOsAYPDo5S/isd4W0GD5XxauADzUJo4MX5x5EE34ajZTQjvFjJeDWaF8isVHNlvJiLHnixlvFqCHG9dba/fuyWIiSAFmT29Q4r7uIdJtXLNoEXmzNeDS1ODZc+IADwYmvGq0HFc9We+0TnR//UWTkvhtakF9szXg0kXnz8H7rnbn/dZd3eX36VDwW82JnxahDxo/MX/W1w44gTSoQX3TJeDSCmGb9bzFAo4Ecf78x4NYhYfet3i29VSH24cxlE/CDxguFrA1F6EAr4QfLc8ijE+bzfaXFIR+k80EUc17OlrmJ/z0cuPp702aR/GNKwNCKx72EJIQ1LoxKPzbA0wlY9RufDsRT3HIfjKO498YihuM9MK37iflPL2In7v11aiJe4/8kDL9BbxzrGV+/Zgv2d/VDoYAVAydbdJh+7JZUPMkUBPDX/9NGWBEQEIvamx2zBSrllqOoKJqbCBk/NP3O8Ja0WEYHevOX1DTr3nFxdvaH34cX5Z17i7Wmw2JpnL5QQPsBG2E16cf7pFx3RmgQLtPaRd68U3lM4EEPITXpx/umjZd6SEAqMzn/k441QKbjwDDZghBrhxfmnl8r1LDIAESNmXPDjVUJw7hmsSIQZ4cX5pw6XHN6c/oox48LHvt74lZxz6fG7DGSGGOHF+acOfV/mTamgDDDzoj+vksLxDlZMhhfhxfknDxTLDm94iYzEpds+3+iWgjveI2zK0CK8OP/k/u+2yqKe+MogMqau+PUqwR1HePyyATO0Prw4/+S+b0tbvJH2ihLm9LXbvt/Yl4J7BksSYUV4cf5nB/9eLDmi7mVGInn9k4Lts3wluVP2HGHiYfXhR//x0FapVKrWT2QYxtSO7CeFr31XILmPCBs8vD6spODVIxaRYZrJ1B/uFL7yXb4SgnOv92cUF2H14QfJy/sMBsmr6R3N5M637xQGeSZDCu54Bpuh9eE8cP035TKHUCDTmErN/OlO4f4gFUju+ACH16TzwNvNGa/+/JfC3wYpX0kpPDdpCBnexCPfnvHqy8EqYESMfHw3vKllvjXj1RcDVpCYmpZeT4HM6alEiHPpfHPGq3sDlq+mZpTpeRzeMTMV5tlSvpHxamCvo2amtzyDpxPKCfMZj3wt49XAzyE8SCyPxzMeDfE52IXPBy4+H7mr9X3vLQWf8SpUMGKF9QIealmYNPDYRHhh0sDQYA3W4IkGb+gIa7AGa7AGa7AGa7AGa7AGa7DXZdirJhs6whqswRqswRqswbEHDzjeL4xw/rCgIxwcuDUFVmUZJhHWqMsbLdhKmbPrLutbE2Ft+NG6lrc0G6TZ7L57j627f5L9VfWPuWRp0we3W3nrwFIqMHI3sJXOdtskU33Nci7tIwdYj/IArCNj5UIF9/LamzUvshmPTbq3F0A2KLE5jNfzfvb1Bic2h/J63E8P3sDE5nBeT/vpyRuU2A2c8uFtOmh3XVJZb/sSSFZAF7D1WH2EfNg+R+j01g/a3QPctbzqUh+dHwsgxC7g1Ho9njnXmW2r1+63k73L2wCsTLW89T2hRLi2aqkLxae3b3nIWUvrgc3sO6uwZqt/PByNt195AHK1r8xuf5s2u7dAePH2n2n1Ka91xrUnhAh3rplLobg5qNdfMzXD6MNuMa1Nmv17x+8Sz1w6W08VPP7e/uCqMZvBZhy8fcH1aWE2A8TA2xfcmBZml7A+/l4/h8V1xMDbF1zMZHucRMQEXHk3jKrTvky2/V0xqp80ebuo1VzeMN/ZLrBUUI3MVveRuaEaObEIRBm78ibxD9I3XvDw4lxrecrDdwIGK6lUI9OTKmDvdVUlE4hor13JyDufvq5MD+C28jx8J3CwVKi/9KvwN+y7Wk0DRsRon115c/qH6WvKUwK49vL6fyfoJi2kBFONHfwSB66gEgKDDtiVN6efSF8VRF7AHeX1/U7QYMklWC1JjALwBQ5eIqkARgftypvTP0pfchQZnsAd5fX7TuAR5gJGS5+7h8MXlQRjh+3Km8S70xfLAga8RbijvD7fCboPCy6gyGjewQ0cuSRgHLYr190X0utbjiTFPPVhl/I6wJwLKGaGFGHBlWLV5lX9z2c4vI7D9me1k/ryliMNUpBeIuxSXmeEOUGE06QhhQMYbX3uU2RQ/LS2lShvOVCGt5yVruV1gkEBeF3AnCCFUoZo28GWN4mdrbLDGMhD9rdu5bUsgjuCJIiHAC6+ckIKIWr9yf1X39raEoaJV4r9g+KpvHK5LA2JV4ohgHOzDJITMyuXEN0i8pPZrXJZEdjDu/1r8FCeNVsuO4rAHoZyIZ6bDFIqenHVyrnu4L+mX/y2xBmY6SmfYd/yrEZ5oRy0imdeMiAk1PLFWddtZo/8vVRWzJg6U/RymPFTXijgXCpZKpe54OX/TpjMZch0HpQdaZjTyW9ue6nCR3kh3T0snlwpO7xcLpkmY26zQC5gJKZTJ4vesqp4Ly+kCwA5a+WU4MLZIqKOVNJKKaVYIrFjZsX+yFsdnssL64Y4ctbq75SSgkvVPrUgEDHDmJ6ZXbVvea3EY3nhPfKAnPXGKWJU5lyqlmTJRMQMcyo1s2vVvum9Fk/lhflQC3LW6srUVGnLEbL1QMyYkZhOzjyyYn/opxoP5YX72BJy1suPHSuWtpzWpG3EWGI6mTr/TfEDf/X0LS/sB9OQg3XSnD1W5m07aE6df8iL7/uuqHd5EXj0EMgB1skRPgw66vJGDq7s40iXcP6HtD7AMVwmHjzq5+8XdIQ1WIM1WIM1WIM1WINHvWzoCGuwBmuwBmuwBmuwBmuwBmuwBmuwBmuwBocEjlz+Kx3hbQVHIP9VgOBo5L8KDByV/FdBgSOT/yogcHTyXwUDjlD+q0DAUcp/FQQ4UvmvggBHKv9VAOBo5b8KAByt/FcBgJvyX7lMLX/Ci4Hmv9p+cFP+K/ejV8YKMv/V9oOb8l+5H72ajlVj2KZ75tMy+25jxqEPT/L5sAZrsAZrsAZHD9yU28rtBWFq+87Yg5tyW8nORB1NH1BMwE25rapZpVrAjQ8CyX8VCFgqVCxStoup8cFw+a/OevvajY0AmnQlt1XtzzZw44Ph8l/diFAfruS2ouqf7eD6B8HkvwoCXMltRdU/28CND4bLf7URoT5cyX/Fqq62V9gVYwgy/1UgEa7nv1JStoEVSYUg818FMfGo5L8SADrzblTXiMDyX20/uJb/ygQ4M2Xb5MIwTcaDzH+1/eBa/isDKL74VqLtwGSY7MUi4ASW/2r7wbX8V8aslbMOuD4BEGT+qwD6cDX/FZbOWjmgPSPUQ8BKL30XWP6rAMDV/FcKL1/ukv/q0HffO0HlvwoAXMt/Jcq/TTDWkSxISudhgPmvghiWIpX/KghwpPJfBXKJJ0r5rwIBRyn/VTDgCOW/CggcnfxXQYEjk/8qMHBU8l8FCEYk8l8FC4YGxw68oCOswRqswRqswRqswRqswRqswRqswRq8fcvZGxsTFuEvdJPWYA3WYA3WYA3W4EkEe5/0LegIjynY5V34Mb8R3gecerdz3Z4Ff819rMBmbFu/7sM9l7lkaWOiwKl39/7yq/wEgU3cOE3i80nqw+rMUYnPJwlMF45inMUDHKXHWzzIsDTW4oHG4QsHJgyMq/v/7f7nkwTGtYPj2qoHnVpeOWoY+UkA119yufDmexMA5k3vmp74jwlo0sU9idqfjLYmALzZaNMGRNzBUz9q+acznicRPsA/E82v5ZF4L+4RPtL2719P1DgMKJow8P/EbGqpEM+lG9glk1bbjEvFC+ySSasVzOIG7i2m4SO86ulbQeTTqjTpjkxa7QEeEnwjahEWojfYiFmTllKIXmCDhgRvRA0sRK/kUQwUtwgLznuBVfzATm9w7IYlIXqBDRIxbNI9zvAlzPiBnV7gOEa4J5jFDsw575EeTBnjmPGwX4R7grmaLLAZwwj3atLEZQyHJafXdiJ+Jw89IyxEDGdaEwUm1is/eO9PxxI8NZWURvfNEslpM15gc0b1yktq7thpxArM1c7pUo+ppTlt/vv/xglcPNG3xfJinMAxTJXWpw9rcKzBCzrCGqzBGqzBGqzBGqzBGqzBGqzBI18WdIQ1WIM1WIM1OMLgAR+rXNAR1uBogA3hv6E2ttmYjAiLkCI83M+7oPvwoMs/fzph4F0BRthvu9zoiIaIeZPehbFa9DiswRo8ueC5FIqb/rdKlja9r44SeC6dRcb35Gwunc1g0+vqKIHn0lkgm7E6H1C8B2B3l62sdBYutDn31VECz6WzAJDNfONnKyudBTppc+6rowSueoHsPivn09tBm3NfHSVw3Qtcz3gWW/WtWmhzzaujeT7c5AWy7eLd9/p5W8RzLautXATBLV7PYqtlq7p4rm31NovN4b0exVbbVlXxXMfq7RWbI/AC2V+1rXAZlVLtW2Uz2HQpLLsnYhF28SJTah+Kd3soKZsBXAqLWB929dq5zqlH+1LMdDaMJax3FlaMFHhgL3JWp7iT21lYuGCv3t0exYF7/WYQd/Hu87yLHsTb7vUHdo3vN953sa84Y4c5tew43XVvz9xHbX3EAXh7gCunu5t9++/zGJU4CG93cPV0tyF29/rdxR7iQLxdwfXT3Zp4NF5gE13EwXi7gRunu1WxL+/uAcQBeTvBCgB+kL5RyYlHuLEX95tW1BYC9tr36xt4XxTuJ39/vH0jWvvufvtOBAieT1+XSkGBQHR9HwqVFY3dICLaZxcGqVBhfucx0ZZvjejY/h8UEFaTnk9fE6riIyK6eiC582ptRWX3gF7e3icO8+mrQnWA6eoBFEIBSzyRviqElJV2RcTo4qXDTlNOQCLGjP32l4M1v/n0FS5lB5ixKwfxZThNOnlFyXpGPAIj2ucoVf0BQGAM7KD9xWA7Z6UvO/Vfs+mIwJi8fKj+P3ANFlw6eFkKUetmRCBAof5PRmCH7HuDVWelL24J0ZlBkogZ4uIR3Au+SSts4NA6SVkXA6RqPzqRQWQcsTcGO6Ja6QtbjmgcshrZMYkMQ144Wr1oqQLtw/gMS+dJSZc8j8QMRsZR+7PBhhArff57h9d7C4Gamg4zOD9/rDLqBz0sfYpja5KrDjExgpE4Zn86aHte+36L17L4EGMEKCXr/za5XDse+GVaBQB5HH+Tc9Xa2ajiPW7nOzfw5v19seRwWR3vGBhjkEKK2hrH5OL3L1u5wJs0gL/ixFnBFW8SE7EEmdMn7L9iILCVfuu7YsmpexNkJtZw3BGq8RskJN56ycoF3qQB3MXJVcHROMAQGYwlkiftuwPWlForl77fqjToamGnbbx2RopaLcSEYom1g0FPPCrLnZ+eOiO4UztYExmGMbXjlH2nyy/Uf5FSCO5IVSssddq+g5+ePiNrtRCDKaQM4aAFAPjkZ6dXBHckVwogMg1zOnXa/gSDgosnzjFIwZVqLqypFiLTADNPFEMC4/aTK6dF5dBFzKBEcueKfXvwmnLW8kq57CihqLmwei2KDDKndywHfZm2KdXdR0+fOVX59ck0EztmztgfuZ7+eBavnOLcUZJRc2HVWiqrd67YubCaNIBbz6yeFJxDEZtKPbJq38IwYOSs1ZNCKGFMtxR265nm1TmECMbNZ88uK0XCSD6y66x9c9jKctbZZRjcTLUWdvNZ19VhgPHhz88tkymMnbvO2R92O6P3Iz53apqbO1dbC/vw522rQ4sw8MFz515JcnPn6/YHo6guZ62uACvthX3wnOvqMMB4//nXXwVes9/vfs3Gn3jlVZfC3n++ZXWIEQbe+8WJqXJxZP/rnfd+cbz0nufVwVzTat+XH6F+KWIUYl+rtx+82zW53497FPEvAMRnGJOlAzz8nhtirMDbs/zYmDBwo930k4taLxlvcL9l971wIhznZHjbF+FBjln3hi8iqk1a+Ovyce3DsTtKa3CswQs6whqswdu2/D85IzI9LXdOHAAAAABJRU5ErkJggg==");background-position:-40px -200px;background-size:120px 240px}#jstree-marker.jstree-dnd-responsive{border-left-width:10px;border-top-width:10px;border-bottom-width:10px;margin-top:-10px}}@media (max-width:768px){.jstree-default-dark-responsive .jstree-icon{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAHgCAMAAACsKhCPAAACnVBMVEUAAAAzMzOZmZnl5eXm5ubn5+fo6Ojp6enq6urr6+vs7Ozt7e3u7u7v7+/w8PDx8fHy8vLz8/P09PT19fX29vb39/f4+Pj5+fn6+vr7+/v8/Pz9/f3+/v7///8AAADl5eX///8AAABzc3N0dHR1dXV2dnZ3d3d4eHh5eXl6enp7e3t8fHx9fX1+fn5/f3+AgIAAAAAAAAAAAAAAAAAUFBQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKCgoZGRkbGxtYWFgAAAAAAAAEBAQXFxceHh4kJCRkZGRoaGhvb28AAAAwMDBVVVVWVlZXV1dYWFhZWVlaWlpbW1tcXFxdXV1eXl4AAABUVFROTk5PT09QUFBRUVFSUlJTU1NUVFRVVVVWVlZbW1sAAABLS0tMTEypqamioqKhoaGioqKNjY3a2trc3Nzd3d3f39/h4eHi4uLj4+Pl5eXm5ubn5+fp6enr6+vt7e3v7+/x8fHz8/P09PT29vb39/f5+fn6+vr7+/v9/f2ZmZmoqKipqamqqqqrq6usrKytra2urq6vr6+wsLCxsbGysrKzs7O0tLS1tbW2tra3t7e4uLi5ubm6urq7u7u8vLy9vb2+vr6/v7/AwMDBwcHCwsLDw8PExMTFxcXGxsbHx8fIyMjJycnKysrLy8vMzMzNzc3Ozs7Pz8/Q0NDR0dHS0tLT09PU1NTV1dXW1tbX19fY2NjZ2dna2trb29vc3Nzd3d3e3t7f39/g4ODh4eHi4uLj4+Pk5OTl5eXm5ubn5+fo6Ojp6enq6urr6+vs7Ozt7e3u7u7v7+/w8PDx8fHy8vLz8/P09PT19fX29vb39/f4+Pj5+fn6+vr7+/v8/Pz9/f3+/v7///9VzvWeAAAAhnRSTlMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQECAgICAgICAgICAgICAgIEBQYMDQ4PEBESFBgbJSYoMDEzNjk6PT4+Q0VHR0dHSUtUVFRUVFRUVFRUVVhcXFxcXFxcXFxcYWhoeZGSkqH+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/q32P5YAABYKSURBVHja7d1rkxvVmQfw/3O6NSPLw5hFy2RCPJudrWzCLZCqrs3H2G+QNdnKZuW7xxjjcYwZzGCTweXx3UpIiuLdfpJ9pyouNhjHWQFjiDzQlMsBoVGfy77QXWpJ3ZKmu9U6/YZxS31O//Sc0+f07cFcwKiXjbZ/Lwy3ucfl7A1v3zMxYYsGa7AGa7AGa7AGa3C8wJ5niws6wjEDLz6KB/mYg5tbrTn/OJLIT0yEzflnl3EOwYrNkL1YDlhshuwNXGyG7Q1abA46ZA45fDa8AYvNsOMbtLg72EqhmBvgM//eQMVdwVY6i4yVc22uc+ksMtbmwH2g3Ruk2OzhRTZj5bp4kc1gc0TxBYDlI6VQI2ylswCQrcWxwzuE2M0b9rBU9bqq5np8Nrj33FcPQgTXvS6quR6fDeG9WQjxoNXk7VDN9fjM0/lRyF43cIu3TTXX8dnGeHldwG3eFvFc52dWbqy8LuBUtn1NXdzhBbJ7xsvrbWpZFbt4x6w9u4KLmay72NWbKY6X1wWcs9zFcPXaufHyujVpd/ES1t28m2Pmde3DrmIX7jh63Q9aruLt8fJozKU9iX148ejjy1DtK8/fCt7bbVjKWZkbSnXuY3UhEO217/upSEEp1VqGQtcKgh+Hc9bea0q6kwnEsM8u+KjmQfLcCdn6CxIdXVOFclTAyFn7r0gpVaeYiDE6YH/pp5o88OZxpZqDTMSOr6EQGTBy1sFLSoq2hggiMogO2l/4qycPrL3U8gMSMfbSWwHfd+g5tcxZh9eF4q1BJmIm2GHb96WsPLB2DErKWrMmMCZfPI8I3VvKWUvnoYSQTe2QGQS2ZH/uv6Y8cP4omoJMxJh59EKU7i3lrGNrXAleFxMzGZnH7E8HqSoPXFiSokUs5NJ6lO4t5azj5ypiVW3OBksct/9vsLrywIUjQkjREBtCHL4YpXtLOWt5lTuSC6VAZJhkTi3bdwetLA9cPCSg6p2EGOfi0OUw7y11ik+dccrSEQpkEJnJU/adwWvLA5cOCtEsNoU4cCVK95ZuP3n6VeFACBgGm06dtm8PU10euLJfcCVF5WBN4A4X+69F4d5SbUr48VOvvcK5o0Bmcudr9sfD1ZcHru0V3BHVQxcRc7jYdz38e0u1ReLWM6//TkrCVOqR1+1bw1ZoA9czgvOGmAtJBy+HfW+padKPm8++8TvawvTsG/bNoStUXwPZ3wrOawdrYgLG1KFXS5GJMPDBc2+slJBcsT8YvkKFr4A//JcUNTExZTbPbSIQYeD951dexYr9PkYBxibw9m8Ed2RlsDPBDPPy1w8iAubV0enEcLfAW37A+8Cf/lMKIYQCmSwxnbp+pxCVg1ZtPB5VhRIA/gb8+ddCcCXB2FRq5u2/FCIzLI16qXTWL4F3XhBClpGYTs2+85dCfB9qqR6dvgDe2aPAMD2z6527Id5bWggIjHvAu3uMEpKPvHu3MAkPpuEe8O5vS0j+8W4h1o8eNgbcDeCPGWTvFuL9cGnTDONz4BzsQswfHxYtZxKl+D8g3n7uFPSi33nQ4BEsCzrCGqzBGqzBGhwV8IaOsAZrsAZrsAZrsAZrsAZrsAZr8GSCt+Mq5YaOsAYPDo5S/isd4W0GD5XxauADzUJo4MX5x5EE34ajZTQjvFjJeDWaF8isVHNlvJiLHnixlvFqCHG9dba/fuyWIiSAFmT29Q4r7uIdJtXLNoEXmzNeDS1ODZc+IADwYmvGq0HFc9We+0TnR//UWTkvhtakF9szXg0kXnz8H7rnbn/dZd3eX36VDwW82JnxahDxo/MX/W1w44gTSoQX3TJeDSCmGb9bzFAo4Ecf78x4NYhYfet3i29VSH24cxlE/CDxguFrA1F6EAr4QfLc8ijE+bzfaXFIR+k80EUc17OlrmJ/z0cuPp702aR/GNKwNCKx72EJIQ1LoxKPzbA0wlY9RufDsRT3HIfjKO498YihuM9MK37iflPL2In7v11aiJe4/8kDL9BbxzrGV+/Zgv2d/VDoYAVAydbdJh+7JZUPMkUBPDX/9NGWBEQEIvamx2zBSrllqOoKJqbCBk/NP3O8Ja0WEYHevOX1DTr3nFxdvaH34cX5Z17i7Wmw2JpnL5QQPsBG2E16cf7pFx3RmgQLtPaRd68U3lM4EEPITXpx/umjZd6SEAqMzn/k441QKbjwDDZghBrhxfmnl8r1LDIAESNmXPDjVUJw7hmsSIQZ4cX5pw6XHN6c/oox48LHvt74lZxz6fG7DGSGGOHF+acOfV/mTamgDDDzoj+vksLxDlZMhhfhxfknDxTLDm94iYzEpds+3+iWgjveI2zK0CK8OP/k/u+2yqKe+MogMqau+PUqwR1HePyyATO0Prw4/+S+b0tbvJH2ihLm9LXbvt/Yl4J7BksSYUV4cf5nB/9eLDmi7mVGInn9k4Lts3wluVP2HGHiYfXhR//x0FapVKrWT2QYxtSO7CeFr31XILmPCBs8vD6spODVIxaRYZrJ1B/uFL7yXb4SgnOv92cUF2H14QfJy/sMBsmr6R3N5M637xQGeSZDCu54Bpuh9eE8cP035TKHUCDTmErN/OlO4f4gFUju+ACH16TzwNvNGa/+/JfC3wYpX0kpPDdpCBnexCPfnvHqy8EqYESMfHw3vKllvjXj1RcDVpCYmpZeT4HM6alEiHPpfHPGq3sDlq+mZpTpeRzeMTMV5tlSvpHxamCvo2amtzyDpxPKCfMZj3wt49XAzyE8SCyPxzMeDfE52IXPBy4+H7mr9X3vLQWf8SpUMGKF9QIealmYNPDYRHhh0sDQYA3W4IkGb+gIa7AGa7AGa7AGa7AGa7AGa7DXZdirJhs6whqswRqswRqswbEHDzjeL4xw/rCgIxwcuDUFVmUZJhHWqMsbLdhKmbPrLutbE2Ft+NG6lrc0G6TZ7L57j627f5L9VfWPuWRp0we3W3nrwFIqMHI3sJXOdtskU33Nci7tIwdYj/IArCNj5UIF9/LamzUvshmPTbq3F0A2KLE5jNfzfvb1Bic2h/J63E8P3sDE5nBeT/vpyRuU2A2c8uFtOmh3XVJZb/sSSFZAF7D1WH2EfNg+R+j01g/a3QPctbzqUh+dHwsgxC7g1Ho9njnXmW2r1+63k73L2wCsTLW89T2hRLi2aqkLxae3b3nIWUvrgc3sO6uwZqt/PByNt195AHK1r8xuf5s2u7dAePH2n2n1Ka91xrUnhAh3rplLobg5qNdfMzXD6MNuMa1Nmv17x+8Sz1w6W08VPP7e/uCqMZvBZhy8fcH1aWE2A8TA2xfcmBZml7A+/l4/h8V1xMDbF1zMZHucRMQEXHk3jKrTvky2/V0xqp80ebuo1VzeMN/ZLrBUUI3MVveRuaEaObEIRBm78ibxD9I3XvDw4lxrecrDdwIGK6lUI9OTKmDvdVUlE4hor13JyDufvq5MD+C28jx8J3CwVKi/9KvwN+y7Wk0DRsRon115c/qH6WvKUwK49vL6fyfoJi2kBFONHfwSB66gEgKDDtiVN6efSF8VRF7AHeX1/U7QYMklWC1JjALwBQ5eIqkARgftypvTP0pfchQZnsAd5fX7TuAR5gJGS5+7h8MXlQRjh+3Km8S70xfLAga8RbijvD7fCboPCy6gyGjewQ0cuSRgHLYr190X0utbjiTFPPVhl/I6wJwLKGaGFGHBlWLV5lX9z2c4vI7D9me1k/ryliMNUpBeIuxSXmeEOUGE06QhhQMYbX3uU2RQ/LS2lShvOVCGt5yVruV1gkEBeF3AnCCFUoZo28GWN4mdrbLDGMhD9rdu5bUsgjuCJIiHAC6+ckIKIWr9yf1X39raEoaJV4r9g+KpvHK5LA2JV4ohgHOzDJITMyuXEN0i8pPZrXJZEdjDu/1r8FCeNVsuO4rAHoZyIZ6bDFIqenHVyrnu4L+mX/y2xBmY6SmfYd/yrEZ5oRy0imdeMiAk1PLFWddtZo/8vVRWzJg6U/RymPFTXijgXCpZKpe54OX/TpjMZch0HpQdaZjTyW9ue6nCR3kh3T0snlwpO7xcLpkmY26zQC5gJKZTJ4vesqp4Ly+kCwA5a+WU4MLZIqKOVNJKKaVYIrFjZsX+yFsdnssL64Y4ctbq75SSgkvVPrUgEDHDmJ6ZXbVvea3EY3nhPfKAnPXGKWJU5lyqlmTJRMQMcyo1s2vVvum9Fk/lhflQC3LW6srUVGnLEbL1QMyYkZhOzjyyYn/opxoP5YX72BJy1suPHSuWtpzWpG3EWGI6mTr/TfEDf/X0LS/sB9OQg3XSnD1W5m07aE6df8iL7/uuqHd5EXj0EMgB1skRPgw66vJGDq7s40iXcP6HtD7AMVwmHjzq5+8XdIQ1WIM1WIM1WIM1WINHvWzoCGuwBmuwBmuwBmuwBmuwBmuwBmuwBmuwBocEjlz+Kx3hbQVHIP9VgOBo5L8KDByV/FdBgSOT/yogcHTyXwUDjlD+q0DAUcp/FQQ4UvmvggBHKv9VAOBo5b8KAByt/FcBgJvyX7lMLX/Ci4Hmv9p+cFP+K/ejV8YKMv/V9oOb8l+5H72ajlVj2KZ75tMy+25jxqEPT/L5sAZrsAZrsAZHD9yU28rtBWFq+87Yg5tyW8nORB1NH1BMwE25rapZpVrAjQ8CyX8VCFgqVCxStoup8cFw+a/OevvajY0AmnQlt1XtzzZw44Ph8l/diFAfruS2ouqf7eD6B8HkvwoCXMltRdU/28CND4bLf7URoT5cyX/Fqq62V9gVYwgy/1UgEa7nv1JStoEVSYUg818FMfGo5L8SADrzblTXiMDyX20/uJb/ygQ4M2Xb5MIwTcaDzH+1/eBa/isDKL74VqLtwGSY7MUi4ASW/2r7wbX8V8aslbMOuD4BEGT+qwD6cDX/FZbOWjmgPSPUQ8BKL30XWP6rAMDV/FcKL1/ukv/q0HffO0HlvwoAXMt/Jcq/TTDWkSxISudhgPmvghiWIpX/KghwpPJfBXKJJ0r5rwIBRyn/VTDgCOW/CggcnfxXQYEjk/8qMHBU8l8FCEYk8l8FC4YGxw68oCOswRqswRqswRqswRqswRqswRqswRq8fcvZGxsTFuEvdJPWYA3WYA3WYA3W4EkEe5/0LegIjynY5V34Mb8R3gecerdz3Z4Ff819rMBmbFu/7sM9l7lkaWOiwKl39/7yq/wEgU3cOE3i80nqw+rMUYnPJwlMF45inMUDHKXHWzzIsDTW4oHG4QsHJgyMq/v/7f7nkwTGtYPj2qoHnVpeOWoY+UkA119yufDmexMA5k3vmp74jwlo0sU9idqfjLYmALzZaNMGRNzBUz9q+acznicRPsA/E82v5ZF4L+4RPtL2719P1DgMKJow8P/EbGqpEM+lG9glk1bbjEvFC+ySSasVzOIG7i2m4SO86ulbQeTTqjTpjkxa7QEeEnwjahEWojfYiFmTllKIXmCDhgRvRA0sRK/kUQwUtwgLznuBVfzATm9w7IYlIXqBDRIxbNI9zvAlzPiBnV7gOEa4J5jFDsw575EeTBnjmPGwX4R7grmaLLAZwwj3atLEZQyHJafXdiJ+Jw89IyxEDGdaEwUm1is/eO9PxxI8NZWURvfNEslpM15gc0b1yktq7thpxArM1c7pUo+ppTlt/vv/xglcPNG3xfJinMAxTJXWpw9rcKzBCzrCGqzBGqzBGqzBGqzBGqzBGqzBI18WdIQ1WIM1WIM1OMLgAR+rXNAR1uBogA3hv6E2ttmYjAiLkCI83M+7oPvwoMs/fzph4F0BRthvu9zoiIaIeZPehbFa9DiswRo8ueC5FIqb/rdKlja9r44SeC6dRcb35Gwunc1g0+vqKIHn0lkgm7E6H1C8B2B3l62sdBYutDn31VECz6WzAJDNfONnKyudBTppc+6rowSueoHsPivn09tBm3NfHSVw3Qtcz3gWW/WtWmhzzaujeT7c5AWy7eLd9/p5W8RzLautXATBLV7PYqtlq7p4rm31NovN4b0exVbbVlXxXMfq7RWbI/AC2V+1rXAZlVLtW2Uz2HQpLLsnYhF28SJTah+Kd3soKZsBXAqLWB929dq5zqlH+1LMdDaMJax3FlaMFHhgL3JWp7iT21lYuGCv3t0exYF7/WYQd/Hu87yLHsTb7vUHdo3vN953sa84Y4c5tew43XVvz9xHbX3EAXh7gCunu5t9++/zGJU4CG93cPV0tyF29/rdxR7iQLxdwfXT3Zp4NF5gE13EwXi7gRunu1WxL+/uAcQBeTvBCgB+kL5RyYlHuLEX95tW1BYC9tr36xt4XxTuJ39/vH0jWvvufvtOBAieT1+XSkGBQHR9HwqVFY3dICLaZxcGqVBhfucx0ZZvjejY/h8UEFaTnk9fE6riIyK6eiC582ptRWX3gF7e3icO8+mrQnWA6eoBFEIBSzyRviqElJV2RcTo4qXDTlNOQCLGjP32l4M1v/n0FS5lB5ixKwfxZThNOnlFyXpGPAIj2ucoVf0BQGAM7KD9xWA7Z6UvO/Vfs+mIwJi8fKj+P3ANFlw6eFkKUetmRCBAof5PRmCH7HuDVWelL24J0ZlBkogZ4uIR3Au+SSts4NA6SVkXA6RqPzqRQWQcsTcGO6Ja6QtbjmgcshrZMYkMQ144Wr1oqQLtw/gMS+dJSZc8j8QMRsZR+7PBhhArff57h9d7C4Gamg4zOD9/rDLqBz0sfYpja5KrDjExgpE4Zn86aHte+36L17L4EGMEKCXr/za5XDse+GVaBQB5HH+Tc9Xa2ajiPW7nOzfw5v19seRwWR3vGBhjkEKK2hrH5OL3L1u5wJs0gL/ixFnBFW8SE7EEmdMn7L9iILCVfuu7YsmpexNkJtZw3BGq8RskJN56ycoF3qQB3MXJVcHROMAQGYwlkiftuwPWlForl77fqjToamGnbbx2RopaLcSEYom1g0FPPCrLnZ+eOiO4UztYExmGMbXjlH2nyy/Uf5FSCO5IVSssddq+g5+ePiNrtRCDKaQM4aAFAPjkZ6dXBHckVwogMg1zOnXa/gSDgosnzjFIwZVqLqypFiLTADNPFEMC4/aTK6dF5dBFzKBEcueKfXvwmnLW8kq57CihqLmwei2KDDKndywHfZm2KdXdR0+fOVX59ck0EztmztgfuZ7+eBavnOLcUZJRc2HVWiqrd67YubCaNIBbz6yeFJxDEZtKPbJq38IwYOSs1ZNCKGFMtxR265nm1TmECMbNZ88uK0XCSD6y66x9c9jKctbZZRjcTLUWdvNZ19VhgPHhz88tkymMnbvO2R92O6P3Iz53apqbO1dbC/vw522rQ4sw8MFz515JcnPn6/YHo6guZ62uACvthX3wnOvqMMB4//nXXwVes9/vfs3Gn3jlVZfC3n++ZXWIEQbe+8WJqXJxZP/rnfd+cbz0nufVwVzTat+XH6F+KWIUYl+rtx+82zW53497FPEvAMRnGJOlAzz8nhtirMDbs/zYmDBwo930k4taLxlvcL9l971wIhznZHjbF+FBjln3hi8iqk1a+Ovyce3DsTtKa3CswQs6whqswdu2/D85IzI9LXdOHAAAAABJRU5ErkJggg==")}.jstree-default-dark-responsive .jstree-node,.jstree-default-dark-responsive .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-dark-responsive .jstree-node{min-height:40px;line-height:40px;margin-left:40px;min-width:40px;white-space:nowrap}.jstree-default-dark-responsive .jstree-anchor{line-height:40px;height:40px}.jstree-default-dark-responsive .jstree-icon,.jstree-default-dark-responsive .jstree-icon:empty{width:40px;height:40px;line-height:40px}.jstree-default-dark-responsive>.jstree-container-ul>.jstree-node{margin-left:0}.jstree-default-dark-responsive.jstree-rtl .jstree-node{margin-left:0;margin-right:40px;background:transparent}.jstree-default-dark-responsive.jstree-rtl .jstree-container-ul>.jstree-node{margin-right:0}.jstree-default-dark-responsive .jstree-ocl,.jstree-default-dark-responsive .jstree-themeicon,.jstree-default-dark-responsive .jstree-checkbox{background-size:120px 240px}.jstree-default-dark-responsive .jstree-leaf>.jstree-ocl,.jstree-default-dark-responsive.jstree-rtl .jstree-leaf>.jstree-ocl{background:transparent}.jstree-default-dark-responsive .jstree-open>.jstree-ocl{background-position:0 0 !important}.jstree-default-dark-responsive .jstree-closed>.jstree-ocl{background-position:0 -40px !important}.jstree-default-dark-responsive.jstree-rtl .jstree-closed>.jstree-ocl{background-position:-40px 0 !important}.jstree-default-dark-responsive .jstree-themeicon{background-position:-40px -40px}.jstree-default-dark-responsive .jstree-checkbox,.jstree-default-dark-responsive .jstree-checkbox:hover{background-position:-40px -80px}.jstree-default-dark-responsive.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox,.jstree-default-dark-responsive.jstree-checkbox-selection .jstree-clicked>.jstree-checkbox:hover,.jstree-default-dark-responsive .jstree-checked>.jstree-checkbox,.jstree-default-dark-responsive .jstree-checked>.jstree-checkbox:hover{background-position:0 -80px}.jstree-default-dark-responsive .jstree-anchor>.jstree-undetermined,.jstree-default-dark-responsive .jstree-anchor>.jstree-undetermined:hover{background-position:0 -120px}.jstree-default-dark-responsive .jstree-anchor{font-weight:bold;font-size:1.1em;text-shadow:1px 1px white}.jstree-default-dark-responsive>.jstree-striped{background:transparent}.jstree-default-dark-responsive .jstree-wholerow{border-top:1px solid #666;border-bottom:1px solid #000;background:#333333;height:40px}.jstree-default-dark-responsive .jstree-wholerow-hovered{background:#555}.jstree-default-dark-responsive .jstree-wholerow-clicked{background:#5fa2db}.jstree-default-dark-responsive .jstree-children .jstree-last>.jstree-wholerow{box-shadow:inset 0 -6px 3px -5px #111111}.jstree-default-dark-responsive .jstree-children .jstree-open>.jstree-wholerow{box-shadow:inset 0 6px 3px -5px #111111;border-top:0}.jstree-default-dark-responsive .jstree-children .jstree-open+.jstree-open{box-shadow:none}.jstree-default-dark-responsive .jstree-node,.jstree-default-dark-responsive .jstree-icon,.jstree-default-dark-responsive .jstree-node>.jstree-ocl,.jstree-default-dark-responsive .jstree-themeicon,.jstree-default-dark-responsive .jstree-checkbox{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAHgCAMAAACsKhCPAAACnVBMVEUAAAAzMzOZmZnl5eXm5ubn5+fo6Ojp6enq6urr6+vs7Ozt7e3u7u7v7+/w8PDx8fHy8vLz8/P09PT19fX29vb39/f4+Pj5+fn6+vr7+/v8/Pz9/f3+/v7///8AAADl5eX///8AAABzc3N0dHR1dXV2dnZ3d3d4eHh5eXl6enp7e3t8fHx9fX1+fn5/f3+AgIAAAAAAAAAAAAAAAAAUFBQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKCgoZGRkbGxtYWFgAAAAAAAAEBAQXFxceHh4kJCRkZGRoaGhvb28AAAAwMDBVVVVWVlZXV1dYWFhZWVlaWlpbW1tcXFxdXV1eXl4AAABUVFROTk5PT09QUFBRUVFSUlJTU1NUVFRVVVVWVlZbW1sAAABLS0tMTEypqamioqKhoaGioqKNjY3a2trc3Nzd3d3f39/h4eHi4uLj4+Pl5eXm5ubn5+fp6enr6+vt7e3v7+/x8fHz8/P09PT29vb39/f5+fn6+vr7+/v9/f2ZmZmoqKipqamqqqqrq6usrKytra2urq6vr6+wsLCxsbGysrKzs7O0tLS1tbW2tra3t7e4uLi5ubm6urq7u7u8vLy9vb2+vr6/v7/AwMDBwcHCwsLDw8PExMTFxcXGxsbHx8fIyMjJycnKysrLy8vMzMzNzc3Ozs7Pz8/Q0NDR0dHS0tLT09PU1NTV1dXW1tbX19fY2NjZ2dna2trb29vc3Nzd3d3e3t7f39/g4ODh4eHi4uLj4+Pk5OTl5eXm5ubn5+fo6Ojp6enq6urr6+vs7Ozt7e3u7u7v7+/w8PDx8fHy8vLz8/P09PT19fX29vb39/f4+Pj5+fn6+vr7+/v8/Pz9/f3+/v7///9VzvWeAAAAhnRSTlMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQECAgICAgICAgICAgICAgIEBQYMDQ4PEBESFBgbJSYoMDEzNjk6PT4+Q0VHR0dHSUtUVFRUVFRUVFRUVVhcXFxcXFxcXFxcYWhoeZGSkqH+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/q32P5YAABYKSURBVHja7d1rkxvVmQfw/3O6NSPLw5hFy2RCPJudrWzCLZCqrs3H2G+QNdnKZuW7xxjjcYwZzGCTweXx3UpIiuLdfpJ9pyouNhjHWQFjiDzQlMsBoVGfy77QXWpJ3ZKmu9U6/YZxS31O//Sc0+f07cFcwKiXjbZ/Lwy3ucfl7A1v3zMxYYsGa7AGa7AGa7AGa3C8wJ5niws6wjEDLz6KB/mYg5tbrTn/OJLIT0yEzflnl3EOwYrNkL1YDlhshuwNXGyG7Q1abA46ZA45fDa8AYvNsOMbtLg72EqhmBvgM//eQMVdwVY6i4yVc22uc+ksMtbmwH2g3Ruk2OzhRTZj5bp4kc1gc0TxBYDlI6VQI2ylswCQrcWxwzuE2M0b9rBU9bqq5np8Nrj33FcPQgTXvS6quR6fDeG9WQjxoNXk7VDN9fjM0/lRyF43cIu3TTXX8dnGeHldwG3eFvFc52dWbqy8LuBUtn1NXdzhBbJ7xsvrbWpZFbt4x6w9u4KLmay72NWbKY6X1wWcs9zFcPXaufHyujVpd/ES1t28m2Pmde3DrmIX7jh63Q9aruLt8fJozKU9iX148ejjy1DtK8/fCt7bbVjKWZkbSnXuY3UhEO217/upSEEp1VqGQtcKgh+Hc9bea0q6kwnEsM8u+KjmQfLcCdn6CxIdXVOFclTAyFn7r0gpVaeYiDE6YH/pp5o88OZxpZqDTMSOr6EQGTBy1sFLSoq2hggiMogO2l/4qycPrL3U8gMSMfbSWwHfd+g5tcxZh9eF4q1BJmIm2GHb96WsPLB2DErKWrMmMCZfPI8I3VvKWUvnoYSQTe2QGQS2ZH/uv6Y8cP4omoJMxJh59EKU7i3lrGNrXAleFxMzGZnH7E8HqSoPXFiSokUs5NJ6lO4t5azj5ypiVW3OBksct/9vsLrywIUjQkjREBtCHL4YpXtLOWt5lTuSC6VAZJhkTi3bdwetLA9cPCSg6p2EGOfi0OUw7y11ik+dccrSEQpkEJnJU/adwWvLA5cOCtEsNoU4cCVK95ZuP3n6VeFACBgGm06dtm8PU10euLJfcCVF5WBN4A4X+69F4d5SbUr48VOvvcK5o0Bmcudr9sfD1ZcHru0V3BHVQxcRc7jYdz38e0u1ReLWM6//TkrCVOqR1+1bw1ZoA9czgvOGmAtJBy+HfW+padKPm8++8TvawvTsG/bNoStUXwPZ3wrOawdrYgLG1KFXS5GJMPDBc2+slJBcsT8YvkKFr4A//JcUNTExZTbPbSIQYeD951dexYr9PkYBxibw9m8Ed2RlsDPBDPPy1w8iAubV0enEcLfAW37A+8Cf/lMKIYQCmSwxnbp+pxCVg1ZtPB5VhRIA/gb8+ddCcCXB2FRq5u2/FCIzLI16qXTWL4F3XhBClpGYTs2+85dCfB9qqR6dvgDe2aPAMD2z6527Id5bWggIjHvAu3uMEpKPvHu3MAkPpuEe8O5vS0j+8W4h1o8eNgbcDeCPGWTvFuL9cGnTDONz4BzsQswfHxYtZxKl+D8g3n7uFPSi33nQ4BEsCzrCGqzBGqzBGhwV8IaOsAZrsAZrsAZrsAZrsAZrsAZr8GSCt+Mq5YaOsAYPDo5S/isd4W0GD5XxauADzUJo4MX5x5EE34ajZTQjvFjJeDWaF8isVHNlvJiLHnixlvFqCHG9dba/fuyWIiSAFmT29Q4r7uIdJtXLNoEXmzNeDS1ODZc+IADwYmvGq0HFc9We+0TnR//UWTkvhtakF9szXg0kXnz8H7rnbn/dZd3eX36VDwW82JnxahDxo/MX/W1w44gTSoQX3TJeDSCmGb9bzFAo4Ecf78x4NYhYfet3i29VSH24cxlE/CDxguFrA1F6EAr4QfLc8ijE+bzfaXFIR+k80EUc17OlrmJ/z0cuPp702aR/GNKwNCKx72EJIQ1LoxKPzbA0wlY9RufDsRT3HIfjKO498YihuM9MK37iflPL2In7v11aiJe4/8kDL9BbxzrGV+/Zgv2d/VDoYAVAydbdJh+7JZUPMkUBPDX/9NGWBEQEIvamx2zBSrllqOoKJqbCBk/NP3O8Ja0WEYHevOX1DTr3nFxdvaH34cX5Z17i7Wmw2JpnL5QQPsBG2E16cf7pFx3RmgQLtPaRd68U3lM4EEPITXpx/umjZd6SEAqMzn/k441QKbjwDDZghBrhxfmnl8r1LDIAESNmXPDjVUJw7hmsSIQZ4cX5pw6XHN6c/oox48LHvt74lZxz6fG7DGSGGOHF+acOfV/mTamgDDDzoj+vksLxDlZMhhfhxfknDxTLDm94iYzEpds+3+iWgjveI2zK0CK8OP/k/u+2yqKe+MogMqau+PUqwR1HePyyATO0Prw4/+S+b0tbvJH2ihLm9LXbvt/Yl4J7BksSYUV4cf5nB/9eLDmi7mVGInn9k4Lts3wluVP2HGHiYfXhR//x0FapVKrWT2QYxtSO7CeFr31XILmPCBs8vD6spODVIxaRYZrJ1B/uFL7yXb4SgnOv92cUF2H14QfJy/sMBsmr6R3N5M637xQGeSZDCu54Bpuh9eE8cP035TKHUCDTmErN/OlO4f4gFUju+ACH16TzwNvNGa/+/JfC3wYpX0kpPDdpCBnexCPfnvHqy8EqYESMfHw3vKllvjXj1RcDVpCYmpZeT4HM6alEiHPpfHPGq3sDlq+mZpTpeRzeMTMV5tlSvpHxamCvo2amtzyDpxPKCfMZj3wt49XAzyE8SCyPxzMeDfE52IXPBy4+H7mr9X3vLQWf8SpUMGKF9QIealmYNPDYRHhh0sDQYA3W4IkGb+gIa7AGa7AGa7AGa7AGa7AGa7DXZdirJhs6whqswRqswRqswbEHDzjeL4xw/rCgIxwcuDUFVmUZJhHWqMsbLdhKmbPrLutbE2Ft+NG6lrc0G6TZ7L57j627f5L9VfWPuWRp0we3W3nrwFIqMHI3sJXOdtskU33Nci7tIwdYj/IArCNj5UIF9/LamzUvshmPTbq3F0A2KLE5jNfzfvb1Bic2h/J63E8P3sDE5nBeT/vpyRuU2A2c8uFtOmh3XVJZb/sSSFZAF7D1WH2EfNg+R+j01g/a3QPctbzqUh+dHwsgxC7g1Ho9njnXmW2r1+63k73L2wCsTLW89T2hRLi2aqkLxae3b3nIWUvrgc3sO6uwZqt/PByNt195AHK1r8xuf5s2u7dAePH2n2n1Ka91xrUnhAh3rplLobg5qNdfMzXD6MNuMa1Nmv17x+8Sz1w6W08VPP7e/uCqMZvBZhy8fcH1aWE2A8TA2xfcmBZml7A+/l4/h8V1xMDbF1zMZHucRMQEXHk3jKrTvky2/V0xqp80ebuo1VzeMN/ZLrBUUI3MVveRuaEaObEIRBm78ibxD9I3XvDw4lxrecrDdwIGK6lUI9OTKmDvdVUlE4hor13JyDufvq5MD+C28jx8J3CwVKi/9KvwN+y7Wk0DRsRon115c/qH6WvKUwK49vL6fyfoJi2kBFONHfwSB66gEgKDDtiVN6efSF8VRF7AHeX1/U7QYMklWC1JjALwBQ5eIqkARgftypvTP0pfchQZnsAd5fX7TuAR5gJGS5+7h8MXlQRjh+3Km8S70xfLAga8RbijvD7fCboPCy6gyGjewQ0cuSRgHLYr190X0utbjiTFPPVhl/I6wJwLKGaGFGHBlWLV5lX9z2c4vI7D9me1k/ryliMNUpBeIuxSXmeEOUGE06QhhQMYbX3uU2RQ/LS2lShvOVCGt5yVruV1gkEBeF3AnCCFUoZo28GWN4mdrbLDGMhD9rdu5bUsgjuCJIiHAC6+ckIKIWr9yf1X39raEoaJV4r9g+KpvHK5LA2JV4ohgHOzDJITMyuXEN0i8pPZrXJZEdjDu/1r8FCeNVsuO4rAHoZyIZ6bDFIqenHVyrnu4L+mX/y2xBmY6SmfYd/yrEZ5oRy0imdeMiAk1PLFWddtZo/8vVRWzJg6U/RymPFTXijgXCpZKpe54OX/TpjMZch0HpQdaZjTyW9ue6nCR3kh3T0snlwpO7xcLpkmY26zQC5gJKZTJ4vesqp4Ly+kCwA5a+WU4MLZIqKOVNJKKaVYIrFjZsX+yFsdnssL64Y4ctbq75SSgkvVPrUgEDHDmJ6ZXbVvea3EY3nhPfKAnPXGKWJU5lyqlmTJRMQMcyo1s2vVvum9Fk/lhflQC3LW6srUVGnLEbL1QMyYkZhOzjyyYn/opxoP5YX72BJy1suPHSuWtpzWpG3EWGI6mTr/TfEDf/X0LS/sB9OQg3XSnD1W5m07aE6df8iL7/uuqHd5EXj0EMgB1skRPgw66vJGDq7s40iXcP6HtD7AMVwmHjzq5+8XdIQ1WIM1WIM1WIM1WINHvWzoCGuwBmuwBmuwBmuwBmuwBmuwBmuwBmuwBocEjlz+Kx3hbQVHIP9VgOBo5L8KDByV/FdBgSOT/yogcHTyXwUDjlD+q0DAUcp/FQQ4UvmvggBHKv9VAOBo5b8KAByt/FcBgJvyX7lMLX/Ci4Hmv9p+cFP+K/ejV8YKMv/V9oOb8l+5H72ajlVj2KZ75tMy+25jxqEPT/L5sAZrsAZrsAZHD9yU28rtBWFq+87Yg5tyW8nORB1NH1BMwE25rapZpVrAjQ8CyX8VCFgqVCxStoup8cFw+a/OevvajY0AmnQlt1XtzzZw44Ph8l/diFAfruS2ouqf7eD6B8HkvwoCXMltRdU/28CND4bLf7URoT5cyX/Fqq62V9gVYwgy/1UgEa7nv1JStoEVSYUg818FMfGo5L8SADrzblTXiMDyX20/uJb/ygQ4M2Xb5MIwTcaDzH+1/eBa/isDKL74VqLtwGSY7MUi4ASW/2r7wbX8V8aslbMOuD4BEGT+qwD6cDX/FZbOWjmgPSPUQ8BKL30XWP6rAMDV/FcKL1/ukv/q0HffO0HlvwoAXMt/Jcq/TTDWkSxISudhgPmvghiWIpX/KghwpPJfBXKJJ0r5rwIBRyn/VTDgCOW/CggcnfxXQYEjk/8qMHBU8l8FCEYk8l8FC4YGxw68oCOswRqswRqswRqswRqswRqswRqswRq8fcvZGxsTFuEvdJPWYA3WYA3WYA3W4EkEe5/0LegIjynY5V34Mb8R3gecerdz3Z4Ff819rMBmbFu/7sM9l7lkaWOiwKl39/7yq/wEgU3cOE3i80nqw+rMUYnPJwlMF45inMUDHKXHWzzIsDTW4oHG4QsHJgyMq/v/7f7nkwTGtYPj2qoHnVpeOWoY+UkA119yufDmexMA5k3vmp74jwlo0sU9idqfjLYmALzZaNMGRNzBUz9q+acznicRPsA/E82v5ZF4L+4RPtL2719P1DgMKJow8P/EbGqpEM+lG9glk1bbjEvFC+ySSasVzOIG7i2m4SO86ulbQeTTqjTpjkxa7QEeEnwjahEWojfYiFmTllKIXmCDhgRvRA0sRK/kUQwUtwgLznuBVfzATm9w7IYlIXqBDRIxbNI9zvAlzPiBnV7gOEa4J5jFDsw575EeTBnjmPGwX4R7grmaLLAZwwj3atLEZQyHJafXdiJ+Jw89IyxEDGdaEwUm1is/eO9PxxI8NZWURvfNEslpM15gc0b1yktq7thpxArM1c7pUo+ppTlt/vv/xglcPNG3xfJinMAxTJXWpw9rcKzBCzrCGqzBGqzBGqzBGqzBGqzBGqzBI18WdIQ1WIM1WIM1OMLgAR+rXNAR1uBogA3hv6E2ttmYjAiLkCI83M+7oPvwoMs/fzph4F0BRthvu9zoiIaIeZPehbFa9DiswRo8ueC5FIqb/rdKlja9r44SeC6dRcb35Gwunc1g0+vqKIHn0lkgm7E6H1C8B2B3l62sdBYutDn31VECz6WzAJDNfONnKyudBTppc+6rowSueoHsPivn09tBm3NfHSVw3Qtcz3gWW/WtWmhzzaujeT7c5AWy7eLd9/p5W8RzLautXATBLV7PYqtlq7p4rm31NovN4b0exVbbVlXxXMfq7RWbI/AC2V+1rXAZlVLtW2Uz2HQpLLsnYhF28SJTah+Kd3soKZsBXAqLWB929dq5zqlH+1LMdDaMJax3FlaMFHhgL3JWp7iT21lYuGCv3t0exYF7/WYQd/Hu87yLHsTb7vUHdo3vN953sa84Y4c5tew43XVvz9xHbX3EAXh7gCunu5t9++/zGJU4CG93cPV0tyF29/rdxR7iQLxdwfXT3Zp4NF5gE13EwXi7gRunu1WxL+/uAcQBeTvBCgB+kL5RyYlHuLEX95tW1BYC9tr36xt4XxTuJ39/vH0jWvvufvtOBAieT1+XSkGBQHR9HwqVFY3dICLaZxcGqVBhfucx0ZZvjejY/h8UEFaTnk9fE6riIyK6eiC582ptRWX3gF7e3icO8+mrQnWA6eoBFEIBSzyRviqElJV2RcTo4qXDTlNOQCLGjP32l4M1v/n0FS5lB5ixKwfxZThNOnlFyXpGPAIj2ucoVf0BQGAM7KD9xWA7Z6UvO/Vfs+mIwJi8fKj+P3ANFlw6eFkKUetmRCBAof5PRmCH7HuDVWelL24J0ZlBkogZ4uIR3Au+SSts4NA6SVkXA6RqPzqRQWQcsTcGO6Ja6QtbjmgcshrZMYkMQ144Wr1oqQLtw/gMS+dJSZc8j8QMRsZR+7PBhhArff57h9d7C4Gamg4zOD9/rDLqBz0sfYpja5KrDjExgpE4Zn86aHte+36L17L4EGMEKCXr/za5XDse+GVaBQB5HH+Tc9Xa2ajiPW7nOzfw5v19seRwWR3vGBhjkEKK2hrH5OL3L1u5wJs0gL/ixFnBFW8SE7EEmdMn7L9iILCVfuu7YsmpexNkJtZw3BGq8RskJN56ycoF3qQB3MXJVcHROMAQGYwlkiftuwPWlForl77fqjToamGnbbx2RopaLcSEYom1g0FPPCrLnZ+eOiO4UztYExmGMbXjlH2nyy/Uf5FSCO5IVSssddq+g5+ePiNrtRCDKaQM4aAFAPjkZ6dXBHckVwogMg1zOnXa/gSDgosnzjFIwZVqLqypFiLTADNPFEMC4/aTK6dF5dBFzKBEcueKfXvwmnLW8kq57CihqLmwei2KDDKndywHfZm2KdXdR0+fOVX59ck0EztmztgfuZ7+eBavnOLcUZJRc2HVWiqrd67YubCaNIBbz6yeFJxDEZtKPbJq38IwYOSs1ZNCKGFMtxR265nm1TmECMbNZ88uK0XCSD6y66x9c9jKctbZZRjcTLUWdvNZ19VhgPHhz88tkymMnbvO2R92O6P3Iz53apqbO1dbC/vw522rQ4sw8MFz515JcnPn6/YHo6guZ62uACvthX3wnOvqMMB4//nXXwVes9/vfs3Gn3jlVZfC3n++ZXWIEQbe+8WJqXJxZP/rnfd+cbz0nufVwVzTat+XH6F+KWIUYl+rtx+82zW53497FPEvAMRnGJOlAzz8nhtirMDbs/zYmDBwo930k4taLxlvcL9l971wIhznZHjbF+FBjln3hi8iqk1a+Ovyce3DsTtKa3CswQs6whqswdu2/D85IzI9LXdOHAAAAABJRU5ErkJggg==");background-size:120px 240px}.jstree-default-dark-responsive .jstree-node{background-position:-80px 0;background-repeat:repeat-y}.jstree-default-dark-responsive .jstree-last{background-image:none}.jstree-default-dark-responsive .jstree-leaf>.jstree-ocl{background-position:-40px -120px}.jstree-default-dark-responsive .jstree-last>.jstree-ocl{background-position:-40px -160px}.jstree-default-dark-responsive .jstree-themeicon-custom{background-color:transparent;background-image:none;background-position:0 0}.jstree-default-dark-responsive .jstree-file{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAHgCAMAAACsKhCPAAACnVBMVEUAAAAzMzOZmZnl5eXm5ubn5+fo6Ojp6enq6urr6+vs7Ozt7e3u7u7v7+/w8PDx8fHy8vLz8/P09PT19fX29vb39/f4+Pj5+fn6+vr7+/v8/Pz9/f3+/v7///8AAADl5eX///8AAABzc3N0dHR1dXV2dnZ3d3d4eHh5eXl6enp7e3t8fHx9fX1+fn5/f3+AgIAAAAAAAAAAAAAAAAAUFBQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKCgoZGRkbGxtYWFgAAAAAAAAEBAQXFxceHh4kJCRkZGRoaGhvb28AAAAwMDBVVVVWVlZXV1dYWFhZWVlaWlpbW1tcXFxdXV1eXl4AAABUVFROTk5PT09QUFBRUVFSUlJTU1NUVFRVVVVWVlZbW1sAAABLS0tMTEypqamioqKhoaGioqKNjY3a2trc3Nzd3d3f39/h4eHi4uLj4+Pl5eXm5ubn5+fp6enr6+vt7e3v7+/x8fHz8/P09PT29vb39/f5+fn6+vr7+/v9/f2ZmZmoqKipqamqqqqrq6usrKytra2urq6vr6+wsLCxsbGysrKzs7O0tLS1tbW2tra3t7e4uLi5ubm6urq7u7u8vLy9vb2+vr6/v7/AwMDBwcHCwsLDw8PExMTFxcXGxsbHx8fIyMjJycnKysrLy8vMzMzNzc3Ozs7Pz8/Q0NDR0dHS0tLT09PU1NTV1dXW1tbX19fY2NjZ2dna2trb29vc3Nzd3d3e3t7f39/g4ODh4eHi4uLj4+Pk5OTl5eXm5ubn5+fo6Ojp6enq6urr6+vs7Ozt7e3u7u7v7+/w8PDx8fHy8vLz8/P09PT19fX29vb39/f4+Pj5+fn6+vr7+/v8/Pz9/f3+/v7///9VzvWeAAAAhnRSTlMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQECAgICAgICAgICAgICAgIEBQYMDQ4PEBESFBgbJSYoMDEzNjk6PT4+Q0VHR0dHSUtUVFRUVFRUVFRUVVhcXFxcXFxcXFxcYWhoeZGSkqH+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/q32P5YAABYKSURBVHja7d1rkxvVmQfw/3O6NSPLw5hFy2RCPJudrWzCLZCqrs3H2G+QNdnKZuW7xxjjcYwZzGCTweXx3UpIiuLdfpJ9pyouNhjHWQFjiDzQlMsBoVGfy77QXWpJ3ZKmu9U6/YZxS31O//Sc0+f07cFcwKiXjbZ/Lwy3ucfl7A1v3zMxYYsGa7AGa7AGa7AGa3C8wJ5niws6wjEDLz6KB/mYg5tbrTn/OJLIT0yEzflnl3EOwYrNkL1YDlhshuwNXGyG7Q1abA46ZA45fDa8AYvNsOMbtLg72EqhmBvgM//eQMVdwVY6i4yVc22uc+ksMtbmwH2g3Ruk2OzhRTZj5bp4kc1gc0TxBYDlI6VQI2ylswCQrcWxwzuE2M0b9rBU9bqq5np8Nrj33FcPQgTXvS6quR6fDeG9WQjxoNXk7VDN9fjM0/lRyF43cIu3TTXX8dnGeHldwG3eFvFc52dWbqy8LuBUtn1NXdzhBbJ7xsvrbWpZFbt4x6w9u4KLmay72NWbKY6X1wWcs9zFcPXaufHyujVpd/ES1t28m2Pmde3DrmIX7jh63Q9aruLt8fJozKU9iX148ejjy1DtK8/fCt7bbVjKWZkbSnXuY3UhEO217/upSEEp1VqGQtcKgh+Hc9bea0q6kwnEsM8u+KjmQfLcCdn6CxIdXVOFclTAyFn7r0gpVaeYiDE6YH/pp5o88OZxpZqDTMSOr6EQGTBy1sFLSoq2hggiMogO2l/4qycPrL3U8gMSMfbSWwHfd+g5tcxZh9eF4q1BJmIm2GHb96WsPLB2DErKWrMmMCZfPI8I3VvKWUvnoYSQTe2QGQS2ZH/uv6Y8cP4omoJMxJh59EKU7i3lrGNrXAleFxMzGZnH7E8HqSoPXFiSokUs5NJ6lO4t5azj5ypiVW3OBksct/9vsLrywIUjQkjREBtCHL4YpXtLOWt5lTuSC6VAZJhkTi3bdwetLA9cPCSg6p2EGOfi0OUw7y11ik+dccrSEQpkEJnJU/adwWvLA5cOCtEsNoU4cCVK95ZuP3n6VeFACBgGm06dtm8PU10euLJfcCVF5WBN4A4X+69F4d5SbUr48VOvvcK5o0Bmcudr9sfD1ZcHru0V3BHVQxcRc7jYdz38e0u1ReLWM6//TkrCVOqR1+1bw1ZoA9czgvOGmAtJBy+HfW+padKPm8++8TvawvTsG/bNoStUXwPZ3wrOawdrYgLG1KFXS5GJMPDBc2+slJBcsT8YvkKFr4A//JcUNTExZTbPbSIQYeD951dexYr9PkYBxibw9m8Ed2RlsDPBDPPy1w8iAubV0enEcLfAW37A+8Cf/lMKIYQCmSwxnbp+pxCVg1ZtPB5VhRIA/gb8+ddCcCXB2FRq5u2/FCIzLI16qXTWL4F3XhBClpGYTs2+85dCfB9qqR6dvgDe2aPAMD2z6527Id5bWggIjHvAu3uMEpKPvHu3MAkPpuEe8O5vS0j+8W4h1o8eNgbcDeCPGWTvFuL9cGnTDONz4BzsQswfHxYtZxKl+D8g3n7uFPSi33nQ4BEsCzrCGqzBGqzBGhwV8IaOsAZrsAZrsAZrsAZrsAZrsAZr8GSCt+Mq5YaOsAYPDo5S/isd4W0GD5XxauADzUJo4MX5x5EE34ajZTQjvFjJeDWaF8isVHNlvJiLHnixlvFqCHG9dba/fuyWIiSAFmT29Q4r7uIdJtXLNoEXmzNeDS1ODZc+IADwYmvGq0HFc9We+0TnR//UWTkvhtakF9szXg0kXnz8H7rnbn/dZd3eX36VDwW82JnxahDxo/MX/W1w44gTSoQX3TJeDSCmGb9bzFAo4Ecf78x4NYhYfet3i29VSH24cxlE/CDxguFrA1F6EAr4QfLc8ijE+bzfaXFIR+k80EUc17OlrmJ/z0cuPp702aR/GNKwNCKx72EJIQ1LoxKPzbA0wlY9RufDsRT3HIfjKO498YihuM9MK37iflPL2In7v11aiJe4/8kDL9BbxzrGV+/Zgv2d/VDoYAVAydbdJh+7JZUPMkUBPDX/9NGWBEQEIvamx2zBSrllqOoKJqbCBk/NP3O8Ja0WEYHevOX1DTr3nFxdvaH34cX5Z17i7Wmw2JpnL5QQPsBG2E16cf7pFx3RmgQLtPaRd68U3lM4EEPITXpx/umjZd6SEAqMzn/k441QKbjwDDZghBrhxfmnl8r1LDIAESNmXPDjVUJw7hmsSIQZ4cX5pw6XHN6c/oox48LHvt74lZxz6fG7DGSGGOHF+acOfV/mTamgDDDzoj+vksLxDlZMhhfhxfknDxTLDm94iYzEpds+3+iWgjveI2zK0CK8OP/k/u+2yqKe+MogMqau+PUqwR1HePyyATO0Prw4/+S+b0tbvJH2ihLm9LXbvt/Yl4J7BksSYUV4cf5nB/9eLDmi7mVGInn9k4Lts3wluVP2HGHiYfXhR//x0FapVKrWT2QYxtSO7CeFr31XILmPCBs8vD6spODVIxaRYZrJ1B/uFL7yXb4SgnOv92cUF2H14QfJy/sMBsmr6R3N5M637xQGeSZDCu54Bpuh9eE8cP035TKHUCDTmErN/OlO4f4gFUju+ACH16TzwNvNGa/+/JfC3wYpX0kpPDdpCBnexCPfnvHqy8EqYESMfHw3vKllvjXj1RcDVpCYmpZeT4HM6alEiHPpfHPGq3sDlq+mZpTpeRzeMTMV5tlSvpHxamCvo2amtzyDpxPKCfMZj3wt49XAzyE8SCyPxzMeDfE52IXPBy4+H7mr9X3vLQWf8SpUMGKF9QIealmYNPDYRHhh0sDQYA3W4IkGb+gIa7AGa7AGa7AGa7AGa7AGa7DXZdirJhs6whqswRqswRqswbEHDzjeL4xw/rCgIxwcuDUFVmUZJhHWqMsbLdhKmbPrLutbE2Ft+NG6lrc0G6TZ7L57j627f5L9VfWPuWRp0we3W3nrwFIqMHI3sJXOdtskU33Nci7tIwdYj/IArCNj5UIF9/LamzUvshmPTbq3F0A2KLE5jNfzfvb1Bic2h/J63E8P3sDE5nBeT/vpyRuU2A2c8uFtOmh3XVJZb/sSSFZAF7D1WH2EfNg+R+j01g/a3QPctbzqUh+dHwsgxC7g1Ho9njnXmW2r1+63k73L2wCsTLW89T2hRLi2aqkLxae3b3nIWUvrgc3sO6uwZqt/PByNt195AHK1r8xuf5s2u7dAePH2n2n1Ka91xrUnhAh3rplLobg5qNdfMzXD6MNuMa1Nmv17x+8Sz1w6W08VPP7e/uCqMZvBZhy8fcH1aWE2A8TA2xfcmBZml7A+/l4/h8V1xMDbF1zMZHucRMQEXHk3jKrTvky2/V0xqp80ebuo1VzeMN/ZLrBUUI3MVveRuaEaObEIRBm78ibxD9I3XvDw4lxrecrDdwIGK6lUI9OTKmDvdVUlE4hor13JyDufvq5MD+C28jx8J3CwVKi/9KvwN+y7Wk0DRsRon115c/qH6WvKUwK49vL6fyfoJi2kBFONHfwSB66gEgKDDtiVN6efSF8VRF7AHeX1/U7QYMklWC1JjALwBQ5eIqkARgftypvTP0pfchQZnsAd5fX7TuAR5gJGS5+7h8MXlQRjh+3Km8S70xfLAga8RbijvD7fCboPCy6gyGjewQ0cuSRgHLYr190X0utbjiTFPPVhl/I6wJwLKGaGFGHBlWLV5lX9z2c4vI7D9me1k/ryliMNUpBeIuxSXmeEOUGE06QhhQMYbX3uU2RQ/LS2lShvOVCGt5yVruV1gkEBeF3AnCCFUoZo28GWN4mdrbLDGMhD9rdu5bUsgjuCJIiHAC6+ckIKIWr9yf1X39raEoaJV4r9g+KpvHK5LA2JV4ohgHOzDJITMyuXEN0i8pPZrXJZEdjDu/1r8FCeNVsuO4rAHoZyIZ6bDFIqenHVyrnu4L+mX/y2xBmY6SmfYd/yrEZ5oRy0imdeMiAk1PLFWddtZo/8vVRWzJg6U/RymPFTXijgXCpZKpe54OX/TpjMZch0HpQdaZjTyW9ue6nCR3kh3T0snlwpO7xcLpkmY26zQC5gJKZTJ4vesqp4Ly+kCwA5a+WU4MLZIqKOVNJKKaVYIrFjZsX+yFsdnssL64Y4ctbq75SSgkvVPrUgEDHDmJ6ZXbVvea3EY3nhPfKAnPXGKWJU5lyqlmTJRMQMcyo1s2vVvum9Fk/lhflQC3LW6srUVGnLEbL1QMyYkZhOzjyyYn/opxoP5YX72BJy1suPHSuWtpzWpG3EWGI6mTr/TfEDf/X0LS/sB9OQg3XSnD1W5m07aE6df8iL7/uuqHd5EXj0EMgB1skRPgw66vJGDq7s40iXcP6HtD7AMVwmHjzq5+8XdIQ1WIM1WIM1WIM1WINHvWzoCGuwBmuwBmuwBmuwBmuwBmuwBmuwBmuwBocEjlz+Kx3hbQVHIP9VgOBo5L8KDByV/FdBgSOT/yogcHTyXwUDjlD+q0DAUcp/FQQ4UvmvggBHKv9VAOBo5b8KAByt/FcBgJvyX7lMLX/Ci4Hmv9p+cFP+K/ejV8YKMv/V9oOb8l+5H72ajlVj2KZ75tMy+25jxqEPT/L5sAZrsAZrsAZHD9yU28rtBWFq+87Yg5tyW8nORB1NH1BMwE25rapZpVrAjQ8CyX8VCFgqVCxStoup8cFw+a/OevvajY0AmnQlt1XtzzZw44Ph8l/diFAfruS2ouqf7eD6B8HkvwoCXMltRdU/28CND4bLf7URoT5cyX/Fqq62V9gVYwgy/1UgEa7nv1JStoEVSYUg818FMfGo5L8SADrzblTXiMDyX20/uJb/ygQ4M2Xb5MIwTcaDzH+1/eBa/isDKL74VqLtwGSY7MUi4ASW/2r7wbX8V8aslbMOuD4BEGT+qwD6cDX/FZbOWjmgPSPUQ8BKL30XWP6rAMDV/FcKL1/ukv/q0HffO0HlvwoAXMt/Jcq/TTDWkSxISudhgPmvghiWIpX/KghwpPJfBXKJJ0r5rwIBRyn/VTDgCOW/CggcnfxXQYEjk/8qMHBU8l8FCEYk8l8FC4YGxw68oCOswRqswRqswRqswRqswRqswRqswRq8fcvZGxsTFuEvdJPWYA3WYA3WYA3W4EkEe5/0LegIjynY5V34Mb8R3gecerdz3Z4Ff819rMBmbFu/7sM9l7lkaWOiwKl39/7yq/wEgU3cOE3i80nqw+rMUYnPJwlMF45inMUDHKXHWzzIsDTW4oHG4QsHJgyMq/v/7f7nkwTGtYPj2qoHnVpeOWoY+UkA119yufDmexMA5k3vmp74jwlo0sU9idqfjLYmALzZaNMGRNzBUz9q+acznicRPsA/E82v5ZF4L+4RPtL2719P1DgMKJow8P/EbGqpEM+lG9glk1bbjEvFC+ySSasVzOIG7i2m4SO86ulbQeTTqjTpjkxa7QEeEnwjahEWojfYiFmTllKIXmCDhgRvRA0sRK/kUQwUtwgLznuBVfzATm9w7IYlIXqBDRIxbNI9zvAlzPiBnV7gOEa4J5jFDsw575EeTBnjmPGwX4R7grmaLLAZwwj3atLEZQyHJafXdiJ+Jw89IyxEDGdaEwUm1is/eO9PxxI8NZWURvfNEslpM15gc0b1yktq7thpxArM1c7pUo+ppTlt/vv/xglcPNG3xfJinMAxTJXWpw9rcKzBCzrCGqzBGqzBGqzBGqzBGqzBGqzBI18WdIQ1WIM1WIM1OMLgAR+rXNAR1uBogA3hv6E2ttmYjAiLkCI83M+7oPvwoMs/fzph4F0BRthvu9zoiIaIeZPehbFa9DiswRo8ueC5FIqb/rdKlja9r44SeC6dRcb35Gwunc1g0+vqKIHn0lkgm7E6H1C8B2B3l62sdBYutDn31VECz6WzAJDNfONnKyudBTppc+6rowSueoHsPivn09tBm3NfHSVw3Qtcz3gWW/WtWmhzzaujeT7c5AWy7eLd9/p5W8RzLautXATBLV7PYqtlq7p4rm31NovN4b0exVbbVlXxXMfq7RWbI/AC2V+1rXAZlVLtW2Uz2HQpLLsnYhF28SJTah+Kd3soKZsBXAqLWB929dq5zqlH+1LMdDaMJax3FlaMFHhgL3JWp7iT21lYuGCv3t0exYF7/WYQd/Hu87yLHsTb7vUHdo3vN953sa84Y4c5tew43XVvz9xHbX3EAXh7gCunu5t9++/zGJU4CG93cPV0tyF29/rdxR7iQLxdwfXT3Zp4NF5gE13EwXi7gRunu1WxL+/uAcQBeTvBCgB+kL5RyYlHuLEX95tW1BYC9tr36xt4XxTuJ39/vH0jWvvufvtOBAieT1+XSkGBQHR9HwqVFY3dICLaZxcGqVBhfucx0ZZvjejY/h8UEFaTnk9fE6riIyK6eiC582ptRWX3gF7e3icO8+mrQnWA6eoBFEIBSzyRviqElJV2RcTo4qXDTlNOQCLGjP32l4M1v/n0FS5lB5ixKwfxZThNOnlFyXpGPAIj2ucoVf0BQGAM7KD9xWA7Z6UvO/Vfs+mIwJi8fKj+P3ANFlw6eFkKUetmRCBAof5PRmCH7HuDVWelL24J0ZlBkogZ4uIR3Au+SSts4NA6SVkXA6RqPzqRQWQcsTcGO6Ja6QtbjmgcshrZMYkMQ144Wr1oqQLtw/gMS+dJSZc8j8QMRsZR+7PBhhArff57h9d7C4Gamg4zOD9/rDLqBz0sfYpja5KrDjExgpE4Zn86aHte+36L17L4EGMEKCXr/za5XDse+GVaBQB5HH+Tc9Xa2ajiPW7nOzfw5v19seRwWR3vGBhjkEKK2hrH5OL3L1u5wJs0gL/ixFnBFW8SE7EEmdMn7L9iILCVfuu7YsmpexNkJtZw3BGq8RskJN56ycoF3qQB3MXJVcHROMAQGYwlkiftuwPWlForl77fqjToamGnbbx2RopaLcSEYom1g0FPPCrLnZ+eOiO4UztYExmGMbXjlH2nyy/Uf5FSCO5IVSssddq+g5+ePiNrtRCDKaQM4aAFAPjkZ6dXBHckVwogMg1zOnXa/gSDgosnzjFIwZVqLqypFiLTADNPFEMC4/aTK6dF5dBFzKBEcueKfXvwmnLW8kq57CihqLmwei2KDDKndywHfZm2KdXdR0+fOVX59ck0EztmztgfuZ7+eBavnOLcUZJRc2HVWiqrd67YubCaNIBbz6yeFJxDEZtKPbJq38IwYOSs1ZNCKGFMtxR265nm1TmECMbNZ88uK0XCSD6y66x9c9jKctbZZRjcTLUWdvNZ19VhgPHhz88tkymMnbvO2R92O6P3Iz53apqbO1dbC/vw522rQ4sw8MFz515JcnPn6/YHo6guZ62uACvthX3wnOvqMMB4//nXXwVes9/vfs3Gn3jlVZfC3n++ZXWIEQbe+8WJqXJxZP/rnfd+cbz0nufVwVzTat+XH6F+KWIUYl+rtx+82zW53497FPEvAMRnGJOlAzz8nhtirMDbs/zYmDBwo930k4taLxlvcL9l971wIhznZHjbF+FBjln3hi8iqk1a+Ovyce3DsTtKa3CswQs6whqswdu2/D85IzI9LXdOHAAAAABJRU5ErkJggg==") 0 -160px no-repeat;background-size:120px 240px}.jstree-default-dark-responsive .jstree-folder{background:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAAHgCAMAAACsKhCPAAACnVBMVEUAAAAzMzOZmZnl5eXm5ubn5+fo6Ojp6enq6urr6+vs7Ozt7e3u7u7v7+/w8PDx8fHy8vLz8/P09PT19fX29vb39/f4+Pj5+fn6+vr7+/v8/Pz9/f3+/v7///8AAADl5eX///8AAABzc3N0dHR1dXV2dnZ3d3d4eHh5eXl6enp7e3t8fHx9fX1+fn5/f3+AgIAAAAAAAAAAAAAAAAAUFBQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKCgoZGRkbGxtYWFgAAAAAAAAEBAQXFxceHh4kJCRkZGRoaGhvb28AAAAwMDBVVVVWVlZXV1dYWFhZWVlaWlpbW1tcXFxdXV1eXl4AAABUVFROTk5PT09QUFBRUVFSUlJTU1NUVFRVVVVWVlZbW1sAAABLS0tMTEypqamioqKhoaGioqKNjY3a2trc3Nzd3d3f39/h4eHi4uLj4+Pl5eXm5ubn5+fp6enr6+vt7e3v7+/x8fHz8/P09PT29vb39/f5+fn6+vr7+/v9/f2ZmZmoqKipqamqqqqrq6usrKytra2urq6vr6+wsLCxsbGysrKzs7O0tLS1tbW2tra3t7e4uLi5ubm6urq7u7u8vLy9vb2+vr6/v7/AwMDBwcHCwsLDw8PExMTFxcXGxsbHx8fIyMjJycnKysrLy8vMzMzNzc3Ozs7Pz8/Q0NDR0dHS0tLT09PU1NTV1dXW1tbX19fY2NjZ2dna2trb29vc3Nzd3d3e3t7f39/g4ODh4eHi4uLj4+Pk5OTl5eXm5ubn5+fo6Ojp6enq6urr6+vs7Ozt7e3u7u7v7+/w8PDx8fHy8vLz8/P09PT19fX29vb39/f4+Pj5+fn6+vr7+/v8/Pz9/f3+/v7///9VzvWeAAAAhnRSTlMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQECAgICAgICAgICAgICAgIEBQYMDQ4PEBESFBgbJSYoMDEzNjk6PT4+Q0VHR0dHSUtUVFRUVFRUVFRUVVhcXFxcXFxcXFxcYWhoeZGSkqH+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/q32P5YAABYKSURBVHja7d1rkxvVmQfw/3O6NSPLw5hFy2RCPJudrWzCLZCqrs3H2G+QNdnKZuW7xxjjcYwZzGCTweXx3UpIiuLdfpJ9pyouNhjHWQFjiDzQlMsBoVGfy77QXWpJ3ZKmu9U6/YZxS31O//Sc0+f07cFcwKiXjbZ/Lwy3ucfl7A1v3zMxYYsGa7AGa7AGa7AGa3C8wJ5niws6wjEDLz6KB/mYg5tbrTn/OJLIT0yEzflnl3EOwYrNkL1YDlhshuwNXGyG7Q1abA46ZA45fDa8AYvNsOMbtLg72EqhmBvgM//eQMVdwVY6i4yVc22uc+ksMtbmwH2g3Ruk2OzhRTZj5bp4kc1gc0TxBYDlI6VQI2ylswCQrcWxwzuE2M0b9rBU9bqq5np8Nrj33FcPQgTXvS6quR6fDeG9WQjxoNXk7VDN9fjM0/lRyF43cIu3TTXX8dnGeHldwG3eFvFc52dWbqy8LuBUtn1NXdzhBbJ7xsvrbWpZFbt4x6w9u4KLmay72NWbKY6X1wWcs9zFcPXaufHyujVpd/ES1t28m2Pmde3DrmIX7jh63Q9aruLt8fJozKU9iX148ejjy1DtK8/fCt7bbVjKWZkbSnXuY3UhEO217/upSEEp1VqGQtcKgh+Hc9bea0q6kwnEsM8u+KjmQfLcCdn6CxIdXVOFclTAyFn7r0gpVaeYiDE6YH/pp5o88OZxpZqDTMSOr6EQGTBy1sFLSoq2hggiMogO2l/4qycPrL3U8gMSMfbSWwHfd+g5tcxZh9eF4q1BJmIm2GHb96WsPLB2DErKWrMmMCZfPI8I3VvKWUvnoYSQTe2QGQS2ZH/uv6Y8cP4omoJMxJh59EKU7i3lrGNrXAleFxMzGZnH7E8HqSoPXFiSokUs5NJ6lO4t5azj5ypiVW3OBksct/9vsLrywIUjQkjREBtCHL4YpXtLOWt5lTuSC6VAZJhkTi3bdwetLA9cPCSg6p2EGOfi0OUw7y11ik+dccrSEQpkEJnJU/adwWvLA5cOCtEsNoU4cCVK95ZuP3n6VeFACBgGm06dtm8PU10euLJfcCVF5WBN4A4X+69F4d5SbUr48VOvvcK5o0Bmcudr9sfD1ZcHru0V3BHVQxcRc7jYdz38e0u1ReLWM6//TkrCVOqR1+1bw1ZoA9czgvOGmAtJBy+HfW+padKPm8++8TvawvTsG/bNoStUXwPZ3wrOawdrYgLG1KFXS5GJMPDBc2+slJBcsT8YvkKFr4A//JcUNTExZTbPbSIQYeD951dexYr9PkYBxibw9m8Ed2RlsDPBDPPy1w8iAubV0enEcLfAW37A+8Cf/lMKIYQCmSwxnbp+pxCVg1ZtPB5VhRIA/gb8+ddCcCXB2FRq5u2/FCIzLI16qXTWL4F3XhBClpGYTs2+85dCfB9qqR6dvgDe2aPAMD2z6527Id5bWggIjHvAu3uMEpKPvHu3MAkPpuEe8O5vS0j+8W4h1o8eNgbcDeCPGWTvFuL9cGnTDONz4BzsQswfHxYtZxKl+D8g3n7uFPSi33nQ4BEsCzrCGqzBGqzBGhwV8IaOsAZrsAZrsAZrsAZrsAZrsAZr8GSCt+Mq5YaOsAYPDo5S/isd4W0GD5XxauADzUJo4MX5x5EE34ajZTQjvFjJeDWaF8isVHNlvJiLHnixlvFqCHG9dba/fuyWIiSAFmT29Q4r7uIdJtXLNoEXmzNeDS1ODZc+IADwYmvGq0HFc9We+0TnR//UWTkvhtakF9szXg0kXnz8H7rnbn/dZd3eX36VDwW82JnxahDxo/MX/W1w44gTSoQX3TJeDSCmGb9bzFAo4Ecf78x4NYhYfet3i29VSH24cxlE/CDxguFrA1F6EAr4QfLc8ijE+bzfaXFIR+k80EUc17OlrmJ/z0cuPp702aR/GNKwNCKx72EJIQ1LoxKPzbA0wlY9RufDsRT3HIfjKO498YihuM9MK37iflPL2In7v11aiJe4/8kDL9BbxzrGV+/Zgv2d/VDoYAVAydbdJh+7JZUPMkUBPDX/9NGWBEQEIvamx2zBSrllqOoKJqbCBk/NP3O8Ja0WEYHevOX1DTr3nFxdvaH34cX5Z17i7Wmw2JpnL5QQPsBG2E16cf7pFx3RmgQLtPaRd68U3lM4EEPITXpx/umjZd6SEAqMzn/k441QKbjwDDZghBrhxfmnl8r1LDIAESNmXPDjVUJw7hmsSIQZ4cX5pw6XHN6c/oox48LHvt74lZxz6fG7DGSGGOHF+acOfV/mTamgDDDzoj+vksLxDlZMhhfhxfknDxTLDm94iYzEpds+3+iWgjveI2zK0CK8OP/k/u+2yqKe+MogMqau+PUqwR1HePyyATO0Prw4/+S+b0tbvJH2ihLm9LXbvt/Yl4J7BksSYUV4cf5nB/9eLDmi7mVGInn9k4Lts3wluVP2HGHiYfXhR//x0FapVKrWT2QYxtSO7CeFr31XILmPCBs8vD6spODVIxaRYZrJ1B/uFL7yXb4SgnOv92cUF2H14QfJy/sMBsmr6R3N5M637xQGeSZDCu54Bpuh9eE8cP035TKHUCDTmErN/OlO4f4gFUju+ACH16TzwNvNGa/+/JfC3wYpX0kpPDdpCBnexCPfnvHqy8EqYESMfHw3vKllvjXj1RcDVpCYmpZeT4HM6alEiHPpfHPGq3sDlq+mZpTpeRzeMTMV5tlSvpHxamCvo2amtzyDpxPKCfMZj3wt49XAzyE8SCyPxzMeDfE52IXPBy4+H7mr9X3vLQWf8SpUMGKF9QIealmYNPDYRHhh0sDQYA3W4IkGb+gIa7AGa7AGa7AGa7AGa7AGa7DXZdirJhs6whqswRqswRqswbEHDzjeL4xw/rCgIxwcuDUFVmUZJhHWqMsbLdhKmbPrLutbE2Ft+NG6lrc0G6TZ7L57j627f5L9VfWPuWRp0we3W3nrwFIqMHI3sJXOdtskU33Nci7tIwdYj/IArCNj5UIF9/LamzUvshmPTbq3F0A2KLE5jNfzfvb1Bic2h/J63E8P3sDE5nBeT/vpyRuU2A2c8uFtOmh3XVJZb/sSSFZAF7D1WH2EfNg+R+j01g/a3QPctbzqUh+dHwsgxC7g1Ho9njnXmW2r1+63k73L2wCsTLW89T2hRLi2aqkLxae3b3nIWUvrgc3sO6uwZqt/PByNt195AHK1r8xuf5s2u7dAePH2n2n1Ka91xrUnhAh3rplLobg5qNdfMzXD6MNuMa1Nmv17x+8Sz1w6W08VPP7e/uCqMZvBZhy8fcH1aWE2A8TA2xfcmBZml7A+/l4/h8V1xMDbF1zMZHucRMQEXHk3jKrTvky2/V0xqp80ebuo1VzeMN/ZLrBUUI3MVveRuaEaObEIRBm78ibxD9I3XvDw4lxrecrDdwIGK6lUI9OTKmDvdVUlE4hor13JyDufvq5MD+C28jx8J3CwVKi/9KvwN+y7Wk0DRsRon115c/qH6WvKUwK49vL6fyfoJi2kBFONHfwSB66gEgKDDtiVN6efSF8VRF7AHeX1/U7QYMklWC1JjALwBQ5eIqkARgftypvTP0pfchQZnsAd5fX7TuAR5gJGS5+7h8MXlQRjh+3Km8S70xfLAga8RbijvD7fCboPCy6gyGjewQ0cuSRgHLYr190X0utbjiTFPPVhl/I6wJwLKGaGFGHBlWLV5lX9z2c4vI7D9me1k/ryliMNUpBeIuxSXmeEOUGE06QhhQMYbX3uU2RQ/LS2lShvOVCGt5yVruV1gkEBeF3AnCCFUoZo28GWN4mdrbLDGMhD9rdu5bUsgjuCJIiHAC6+ckIKIWr9yf1X39raEoaJV4r9g+KpvHK5LA2JV4ohgHOzDJITMyuXEN0i8pPZrXJZEdjDu/1r8FCeNVsuO4rAHoZyIZ6bDFIqenHVyrnu4L+mX/y2xBmY6SmfYd/yrEZ5oRy0imdeMiAk1PLFWddtZo/8vVRWzJg6U/RymPFTXijgXCpZKpe54OX/TpjMZch0HpQdaZjTyW9ue6nCR3kh3T0snlwpO7xcLpkmY26zQC5gJKZTJ4vesqp4Ly+kCwA5a+WU4MLZIqKOVNJKKaVYIrFjZsX+yFsdnssL64Y4ctbq75SSgkvVPrUgEDHDmJ6ZXbVvea3EY3nhPfKAnPXGKWJU5lyqlmTJRMQMcyo1s2vVvum9Fk/lhflQC3LW6srUVGnLEbL1QMyYkZhOzjyyYn/opxoP5YX72BJy1suPHSuWtpzWpG3EWGI6mTr/TfEDf/X0LS/sB9OQg3XSnD1W5m07aE6df8iL7/uuqHd5EXj0EMgB1skRPgw66vJGDq7s40iXcP6HtD7AMVwmHjzq5+8XdIQ1WIM1WIM1WIM1WINHvWzoCGuwBmuwBmuwBmuwBmuwBmuwBmuwBmuwBocEjlz+Kx3hbQVHIP9VgOBo5L8KDByV/FdBgSOT/yogcHTyXwUDjlD+q0DAUcp/FQQ4UvmvggBHKv9VAOBo5b8KAByt/FcBgJvyX7lMLX/Ci4Hmv9p+cFP+K/ejV8YKMv/V9oOb8l+5H72ajlVj2KZ75tMy+25jxqEPT/L5sAZrsAZrsAZHD9yU28rtBWFq+87Yg5tyW8nORB1NH1BMwE25rapZpVrAjQ8CyX8VCFgqVCxStoup8cFw+a/OevvajY0AmnQlt1XtzzZw44Ph8l/diFAfruS2ouqf7eD6B8HkvwoCXMltRdU/28CND4bLf7URoT5cyX/Fqq62V9gVYwgy/1UgEa7nv1JStoEVSYUg818FMfGo5L8SADrzblTXiMDyX20/uJb/ygQ4M2Xb5MIwTcaDzH+1/eBa/isDKL74VqLtwGSY7MUi4ASW/2r7wbX8V8aslbMOuD4BEGT+qwD6cDX/FZbOWjmgPSPUQ8BKL30XWP6rAMDV/FcKL1/ukv/q0HffO0HlvwoAXMt/Jcq/TTDWkSxISudhgPmvghiWIpX/KghwpPJfBXKJJ0r5rwIBRyn/VTDgCOW/CggcnfxXQYEjk/8qMHBU8l8FCEYk8l8FC4YGxw68oCOswRqswRqswRqswRqswRqswRqswRq8fcvZGxsTFuEvdJPWYA3WYA3WYA3W4EkEe5/0LegIjynY5V34Mb8R3gecerdz3Z4Ff819rMBmbFu/7sM9l7lkaWOiwKl39/7yq/wEgU3cOE3i80nqw+rMUYnPJwlMF45inMUDHKXHWzzIsDTW4oHG4QsHJgyMq/v/7f7nkwTGtYPj2qoHnVpeOWoY+UkA119yufDmexMA5k3vmp74jwlo0sU9idqfjLYmALzZaNMGRNzBUz9q+acznicRPsA/E82v5ZF4L+4RPtL2719P1DgMKJow8P/EbGqpEM+lG9glk1bbjEvFC+ySSasVzOIG7i2m4SO86ulbQeTTqjTpjkxa7QEeEnwjahEWojfYiFmTllKIXmCDhgRvRA0sRK/kUQwUtwgLznuBVfzATm9w7IYlIXqBDRIxbNI9zvAlzPiBnV7gOEa4J5jFDsw575EeTBnjmPGwX4R7grmaLLAZwwj3atLEZQyHJafXdiJ+Jw89IyxEDGdaEwUm1is/eO9PxxI8NZWURvfNEslpM15gc0b1yktq7thpxArM1c7pUo+ppTlt/vv/xglcPNG3xfJinMAxTJXWpw9rcKzBCzrCGqzBGqzBGqzBGqzBGqzBGqzBI18WdIQ1WIM1WIM1OMLgAR+rXNAR1uBogA3hv6E2ttmYjAiLkCI83M+7oPvwoMs/fzph4F0BRthvu9zoiIaIeZPehbFa9DiswRo8ueC5FIqb/rdKlja9r44SeC6dRcb35Gwunc1g0+vqKIHn0lkgm7E6H1C8B2B3l62sdBYutDn31VECz6WzAJDNfONnKyudBTppc+6rowSueoHsPivn09tBm3NfHSVw3Qtcz3gWW/WtWmhzzaujeT7c5AWy7eLd9/p5W8RzLautXATBLV7PYqtlq7p4rm31NovN4b0exVbbVlXxXMfq7RWbI/AC2V+1rXAZlVLtW2Uz2HQpLLsnYhF28SJTah+Kd3soKZsBXAqLWB929dq5zqlH+1LMdDaMJax3FlaMFHhgL3JWp7iT21lYuGCv3t0exYF7/WYQd/Hu87yLHsTb7vUHdo3vN953sa84Y4c5tew43XVvz9xHbX3EAXh7gCunu5t9++/zGJU4CG93cPV0tyF29/rdxR7iQLxdwfXT3Zp4NF5gE13EwXi7gRunu1WxL+/uAcQBeTvBCgB+kL5RyYlHuLEX95tW1BYC9tr36xt4XxTuJ39/vH0jWvvufvtOBAieT1+XSkGBQHR9HwqVFY3dICLaZxcGqVBhfucx0ZZvjejY/h8UEFaTnk9fE6riIyK6eiC582ptRWX3gF7e3icO8+mrQnWA6eoBFEIBSzyRviqElJV2RcTo4qXDTlNOQCLGjP32l4M1v/n0FS5lB5ixKwfxZThNOnlFyXpGPAIj2ucoVf0BQGAM7KD9xWA7Z6UvO/Vfs+mIwJi8fKj+P3ANFlw6eFkKUetmRCBAof5PRmCH7HuDVWelL24J0ZlBkogZ4uIR3Au+SSts4NA6SVkXA6RqPzqRQWQcsTcGO6Ja6QtbjmgcshrZMYkMQ144Wr1oqQLtw/gMS+dJSZc8j8QMRsZR+7PBhhArff57h9d7C4Gamg4zOD9/rDLqBz0sfYpja5KrDjExgpE4Zn86aHte+36L17L4EGMEKCXr/za5XDse+GVaBQB5HH+Tc9Xa2ajiPW7nOzfw5v19seRwWR3vGBhjkEKK2hrH5OL3L1u5wJs0gL/ixFnBFW8SE7EEmdMn7L9iILCVfuu7YsmpexNkJtZw3BGq8RskJN56ycoF3qQB3MXJVcHROMAQGYwlkiftuwPWlForl77fqjToamGnbbx2RopaLcSEYom1g0FPPCrLnZ+eOiO4UztYExmGMbXjlH2nyy/Uf5FSCO5IVSssddq+g5+ePiNrtRCDKaQM4aAFAPjkZ6dXBHckVwogMg1zOnXa/gSDgosnzjFIwZVqLqypFiLTADNPFEMC4/aTK6dF5dBFzKBEcueKfXvwmnLW8kq57CihqLmwei2KDDKndywHfZm2KdXdR0+fOVX59ck0EztmztgfuZ7+eBavnOLcUZJRc2HVWiqrd67YubCaNIBbz6yeFJxDEZtKPbJq38IwYOSs1ZNCKGFMtxR265nm1TmECMbNZ88uK0XCSD6y66x9c9jKctbZZRjcTLUWdvNZ19VhgPHhz88tkymMnbvO2R92O6P3Iz53apqbO1dbC/vw522rQ4sw8MFz515JcnPn6/YHo6guZ62uACvthX3wnOvqMMB4//nXXwVes9/vfs3Gn3jlVZfC3n++ZXWIEQbe+8WJqXJxZP/rnfd+cbz0nufVwVzTat+XH6F+KWIUYl+rtx+82zW53497FPEvAMRnGJOlAzz8nhtirMDbs/zYmDBwo930k4taLxlvcL9l971wIhznZHjbF+FBjln3hi8iqk1a+Ovyce3DsTtKa3CswQs6whqswdu2/D85IzI9LXdOHAAAAABJRU5ErkJggg==") -40px -40px no-repeat;background-size:120px 240px}.jstree-default-dark-responsive>.jstree-container-ul>.jstree-node{margin-left:0;margin-right:0}}.jstree-default-dark{background:#333}.jstree-default-dark .jstree-anchor{color:#999;text-shadow:1px 1px 0 rgba(0,0,0,0.5)}.jstree-default-dark .jstree-clicked,.jstree-default-dark .jstree-checked{color:white}.jstree-default-dark .jstree-hovered{color:white}#jstree-marker.jstree-default-dark{border-left-color:#999;background:transparent}.jstree-default-dark .jstree-anchor>.jstree-icon{opacity:.75}.jstree-default-dark .jstree-clicked>.jstree-icon,.jstree-default-dark .jstree-hovered>.jstree-icon,.jstree-default-dark .jstree-checked>.jstree-icon{opacity:1}.jstree-default-dark.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAACAQMAAAB49I5GAAAABlBMVEUAAACZmZl+9SADAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjAAMOBgAAGAAJMwQHdQAAAABJRU5ErkJggg==")}.jstree-default-dark.jstree-rtl .jstree-last{background-image:none}.jstree-default-dark-small.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABIAAAACAQMAAABv1h6PAAAABlBMVEUAAACZmZl+9SADAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjAAMHBgAAiABBI4gz9AAAAABJRU5ErkJggg==")}.jstree-default-dark-small.jstree-rtl .jstree-last{background-image:none}.jstree-default-dark-large.jstree-rtl .jstree-node{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAACAQMAAAAD0EyKAAAABlBMVEUAAACZmZl+9SADAAAAAXRSTlMAQObYZgAAAAxJREFUCNdjgIIGBgABCgCBvVLXcAAAAABJRU5ErkJggg==")}.jstree-default-dark-large.jstree-rtl .jstree-last{background-image:none} +/*! + * Bootstrap v4.6.1 (https://getbootstrap.com/) + * Copyright 2011-2021 The Bootstrap Authors + * Copyright 2011-2021 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) + */:root{--blue:#007bff;--indigo:#6610f2;--purple:#6f42c1;--pink:#e83e8c;--red:#dc3545;--orange:#fd7e14;--yellow:#ffc107;--green:#28a745;--teal:#20c997;--cyan:#17a2b8;--white:#fff;--gray:#6c757d;--gray-dark:#343a40;--primary:#007bff;--secondary:#6c757d;--success:#28a745;--info:#17a2b8;--warning:#ffc107;--danger:#dc3545;--light:#f8f9fa;--dark:#343a40;--breakpoint-xs:0;--breakpoint-sm:576px;--breakpoint-md:768px;--breakpoint-lg:992px;--breakpoint-xl:1200px;--font-family-sans-serif:-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";--font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace}*,::after,::before{box-sizing:border-box}html{font-family:sans-serif;line-height:1.15;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}article,aside,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}body{margin:0;font-family:-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;text-align:left;background-color:#fff}[tabindex="-1"]:focus:not(:focus-visible){outline:0!important}hr{box-sizing:content-box;height:0;overflow:visible}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem}p{margin-top:0;margin-bottom:1rem}abbr[data-original-title],abbr[title]{text-decoration:underline;-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;border-bottom:0;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:80%}sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#007bff;text-decoration:none;background-color:transparent}a:hover{color:#0056b3;text-decoration:underline}a:not([href]):not([class]){color:inherit;text-decoration:none}a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em}pre{margin-top:0;margin-bottom:1rem;overflow:auto;-ms-overflow-style:scrollbar}figure{margin:0 0 1rem}img{vertical-align:middle;border-style:none}svg{overflow:hidden;vertical-align:middle}table{border-collapse:collapse}caption{padding-top:.75rem;padding-bottom:.75rem;color:#6c757d;text-align:left;caption-side:bottom}th{text-align:inherit;text-align:-webkit-match-parent}label{display:inline-block;margin-bottom:.5rem}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,input{overflow:visible}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{padding:0;border-style:none}input[type=checkbox],input[type=radio]{box-sizing:border-box;padding:0}textarea{overflow:auto;resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{display:block;width:100%;max-width:100%;padding:0;margin-bottom:.5rem;font-size:1.5rem;line-height:inherit;color:inherit;white-space:normal}progress{vertical-align:baseline}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:none}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}summary{display:list-item;cursor:pointer}template{display:none}[hidden]{display:none!important}.h1,.h2,.h3,.h4,.h5,.h6,h1,h2,h3,h4,h5,h6{margin-bottom:.5rem;font-weight:500;line-height:1.2}.h1,h1{font-size:2.5rem}.h2,h2{font-size:2rem}.h3,h3{font-size:1.75rem}.h4,h4{font-size:1.5rem}.h5,h5{font-size:1.25rem}.h6,h6{font-size:1rem}.lead{font-size:1.25rem;font-weight:300}.display-1{font-size:6rem;font-weight:300;line-height:1.2}.display-2{font-size:5.5rem;font-weight:300;line-height:1.2}.display-3{font-size:4.5rem;font-weight:300;line-height:1.2}.display-4{font-size:3.5rem;font-weight:300;line-height:1.2}hr{margin-top:1rem;margin-bottom:1rem;border:0;border-top:1px solid rgba(0,0,0,.1)}.small,small{font-size:80%;font-weight:400}.mark,mark{padding:.2em;background-color:#fcf8e3}.list-unstyled{padding-left:0;list-style:none}.list-inline{padding-left:0;list-style:none}.list-inline-item{display:inline-block}.list-inline-item:not(:last-child){margin-right:.5rem}.initialism{font-size:90%;text-transform:uppercase}.blockquote{margin-bottom:1rem;font-size:1.25rem}.blockquote-footer{display:block;font-size:80%;color:#6c757d}.blockquote-footer::before{content:"\2014\00A0"}.img-fluid{max-width:100%;height:auto}.img-thumbnail{padding:.25rem;background-color:#fff;border:1px solid #dee2e6;border-radius:.25rem;max-width:100%;height:auto}.figure{display:inline-block}.figure-img{margin-bottom:.5rem;line-height:1}.figure-caption{font-size:90%;color:#6c757d}code{font-size:87.5%;color:#e83e8c;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:87.5%;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:100%;font-weight:700}pre{display:block;font-size:87.5%;color:#212529}pre code{font-size:inherit;color:inherit;word-break:normal}.pre-scrollable{max-height:340px;overflow-y:scroll}.container,.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{width:100%;padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}@media (min-width:576px){.container,.container-sm{max-width:540px}}@media (min-width:768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width:992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width:1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-right:-15px;margin-left:-15px}.no-gutters{margin-right:0;margin-left:0}.no-gutters>.col,.no-gutters>[class*=col-]{padding-right:0;padding-left:0}.col,.col-1,.col-10,.col-11,.col-12,.col-2,.col-3,.col-4,.col-5,.col-6,.col-7,.col-8,.col-9,.col-auto,.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{position:relative;width:100%;padding-right:15px;padding-left:15px}.col{-ms-flex-preferred-size:0;flex-basis:0;-ms-flex-positive:1;flex-grow:1;max-width:100%}.row-cols-1>*{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.row-cols-2>*{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.row-cols-3>*{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.row-cols-4>*{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.row-cols-5>*{-ms-flex:0 0 20%;flex:0 0 20%;max-width:20%}.row-cols-6>*{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-auto{-ms-flex:0 0 auto;flex:0 0 auto;width:auto;max-width:100%}.col-1{-ms-flex:0 0 8.333333%;flex:0 0 8.333333%;max-width:8.333333%}.col-2{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-4{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.col-5{-ms-flex:0 0 41.666667%;flex:0 0 41.666667%;max-width:41.666667%}.col-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-7{-ms-flex:0 0 58.333333%;flex:0 0 58.333333%;max-width:58.333333%}.col-8{-ms-flex:0 0 66.666667%;flex:0 0 66.666667%;max-width:66.666667%}.col-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-10{-ms-flex:0 0 83.333333%;flex:0 0 83.333333%;max-width:83.333333%}.col-11{-ms-flex:0 0 91.666667%;flex:0 0 91.666667%;max-width:91.666667%}.col-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.order-first{-ms-flex-order:-1;order:-1}.order-last{-ms-flex-order:13;order:13}.order-0{-ms-flex-order:0;order:0}.order-1{-ms-flex-order:1;order:1}.order-2{-ms-flex-order:2;order:2}.order-3{-ms-flex-order:3;order:3}.order-4{-ms-flex-order:4;order:4}.order-5{-ms-flex-order:5;order:5}.order-6{-ms-flex-order:6;order:6}.order-7{-ms-flex-order:7;order:7}.order-8{-ms-flex-order:8;order:8}.order-9{-ms-flex-order:9;order:9}.order-10{-ms-flex-order:10;order:10}.order-11{-ms-flex-order:11;order:11}.order-12{-ms-flex-order:12;order:12}.offset-1{margin-left:8.333333%}.offset-2{margin-left:16.666667%}.offset-3{margin-left:25%}.offset-4{margin-left:33.333333%}.offset-5{margin-left:41.666667%}.offset-6{margin-left:50%}.offset-7{margin-left:58.333333%}.offset-8{margin-left:66.666667%}.offset-9{margin-left:75%}.offset-10{margin-left:83.333333%}.offset-11{margin-left:91.666667%}@media (min-width:576px){.col-sm{-ms-flex-preferred-size:0;flex-basis:0;-ms-flex-positive:1;flex-grow:1;max-width:100%}.row-cols-sm-1>*{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.row-cols-sm-2>*{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.row-cols-sm-3>*{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.row-cols-sm-4>*{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.row-cols-sm-5>*{-ms-flex:0 0 20%;flex:0 0 20%;max-width:20%}.row-cols-sm-6>*{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;width:auto;max-width:100%}.col-sm-1{-ms-flex:0 0 8.333333%;flex:0 0 8.333333%;max-width:8.333333%}.col-sm-2{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.col-sm-5{-ms-flex:0 0 41.666667%;flex:0 0 41.666667%;max-width:41.666667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.333333%;flex:0 0 58.333333%;max-width:58.333333%}.col-sm-8{-ms-flex:0 0 66.666667%;flex:0 0 66.666667%;max-width:66.666667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.333333%;flex:0 0 83.333333%;max-width:83.333333%}.col-sm-11{-ms-flex:0 0 91.666667%;flex:0 0 91.666667%;max-width:91.666667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.order-sm-first{-ms-flex-order:-1;order:-1}.order-sm-last{-ms-flex-order:13;order:13}.order-sm-0{-ms-flex-order:0;order:0}.order-sm-1{-ms-flex-order:1;order:1}.order-sm-2{-ms-flex-order:2;order:2}.order-sm-3{-ms-flex-order:3;order:3}.order-sm-4{-ms-flex-order:4;order:4}.order-sm-5{-ms-flex-order:5;order:5}.order-sm-6{-ms-flex-order:6;order:6}.order-sm-7{-ms-flex-order:7;order:7}.order-sm-8{-ms-flex-order:8;order:8}.order-sm-9{-ms-flex-order:9;order:9}.order-sm-10{-ms-flex-order:10;order:10}.order-sm-11{-ms-flex-order:11;order:11}.order-sm-12{-ms-flex-order:12;order:12}.offset-sm-0{margin-left:0}.offset-sm-1{margin-left:8.333333%}.offset-sm-2{margin-left:16.666667%}.offset-sm-3{margin-left:25%}.offset-sm-4{margin-left:33.333333%}.offset-sm-5{margin-left:41.666667%}.offset-sm-6{margin-left:50%}.offset-sm-7{margin-left:58.333333%}.offset-sm-8{margin-left:66.666667%}.offset-sm-9{margin-left:75%}.offset-sm-10{margin-left:83.333333%}.offset-sm-11{margin-left:91.666667%}}@media (min-width:768px){.col-md{-ms-flex-preferred-size:0;flex-basis:0;-ms-flex-positive:1;flex-grow:1;max-width:100%}.row-cols-md-1>*{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.row-cols-md-2>*{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.row-cols-md-3>*{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.row-cols-md-4>*{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.row-cols-md-5>*{-ms-flex:0 0 20%;flex:0 0 20%;max-width:20%}.row-cols-md-6>*{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;width:auto;max-width:100%}.col-md-1{-ms-flex:0 0 8.333333%;flex:0 0 8.333333%;max-width:8.333333%}.col-md-2{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.col-md-5{-ms-flex:0 0 41.666667%;flex:0 0 41.666667%;max-width:41.666667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.333333%;flex:0 0 58.333333%;max-width:58.333333%}.col-md-8{-ms-flex:0 0 66.666667%;flex:0 0 66.666667%;max-width:66.666667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.333333%;flex:0 0 83.333333%;max-width:83.333333%}.col-md-11{-ms-flex:0 0 91.666667%;flex:0 0 91.666667%;max-width:91.666667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.order-md-first{-ms-flex-order:-1;order:-1}.order-md-last{-ms-flex-order:13;order:13}.order-md-0{-ms-flex-order:0;order:0}.order-md-1{-ms-flex-order:1;order:1}.order-md-2{-ms-flex-order:2;order:2}.order-md-3{-ms-flex-order:3;order:3}.order-md-4{-ms-flex-order:4;order:4}.order-md-5{-ms-flex-order:5;order:5}.order-md-6{-ms-flex-order:6;order:6}.order-md-7{-ms-flex-order:7;order:7}.order-md-8{-ms-flex-order:8;order:8}.order-md-9{-ms-flex-order:9;order:9}.order-md-10{-ms-flex-order:10;order:10}.order-md-11{-ms-flex-order:11;order:11}.order-md-12{-ms-flex-order:12;order:12}.offset-md-0{margin-left:0}.offset-md-1{margin-left:8.333333%}.offset-md-2{margin-left:16.666667%}.offset-md-3{margin-left:25%}.offset-md-4{margin-left:33.333333%}.offset-md-5{margin-left:41.666667%}.offset-md-6{margin-left:50%}.offset-md-7{margin-left:58.333333%}.offset-md-8{margin-left:66.666667%}.offset-md-9{margin-left:75%}.offset-md-10{margin-left:83.333333%}.offset-md-11{margin-left:91.666667%}}@media (min-width:992px){.col-lg{-ms-flex-preferred-size:0;flex-basis:0;-ms-flex-positive:1;flex-grow:1;max-width:100%}.row-cols-lg-1>*{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.row-cols-lg-2>*{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.row-cols-lg-3>*{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.row-cols-lg-4>*{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.row-cols-lg-5>*{-ms-flex:0 0 20%;flex:0 0 20%;max-width:20%}.row-cols-lg-6>*{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;width:auto;max-width:100%}.col-lg-1{-ms-flex:0 0 8.333333%;flex:0 0 8.333333%;max-width:8.333333%}.col-lg-2{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.col-lg-5{-ms-flex:0 0 41.666667%;flex:0 0 41.666667%;max-width:41.666667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.333333%;flex:0 0 58.333333%;max-width:58.333333%}.col-lg-8{-ms-flex:0 0 66.666667%;flex:0 0 66.666667%;max-width:66.666667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.333333%;flex:0 0 83.333333%;max-width:83.333333%}.col-lg-11{-ms-flex:0 0 91.666667%;flex:0 0 91.666667%;max-width:91.666667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.order-lg-first{-ms-flex-order:-1;order:-1}.order-lg-last{-ms-flex-order:13;order:13}.order-lg-0{-ms-flex-order:0;order:0}.order-lg-1{-ms-flex-order:1;order:1}.order-lg-2{-ms-flex-order:2;order:2}.order-lg-3{-ms-flex-order:3;order:3}.order-lg-4{-ms-flex-order:4;order:4}.order-lg-5{-ms-flex-order:5;order:5}.order-lg-6{-ms-flex-order:6;order:6}.order-lg-7{-ms-flex-order:7;order:7}.order-lg-8{-ms-flex-order:8;order:8}.order-lg-9{-ms-flex-order:9;order:9}.order-lg-10{-ms-flex-order:10;order:10}.order-lg-11{-ms-flex-order:11;order:11}.order-lg-12{-ms-flex-order:12;order:12}.offset-lg-0{margin-left:0}.offset-lg-1{margin-left:8.333333%}.offset-lg-2{margin-left:16.666667%}.offset-lg-3{margin-left:25%}.offset-lg-4{margin-left:33.333333%}.offset-lg-5{margin-left:41.666667%}.offset-lg-6{margin-left:50%}.offset-lg-7{margin-left:58.333333%}.offset-lg-8{margin-left:66.666667%}.offset-lg-9{margin-left:75%}.offset-lg-10{margin-left:83.333333%}.offset-lg-11{margin-left:91.666667%}}@media (min-width:1200px){.col-xl{-ms-flex-preferred-size:0;flex-basis:0;-ms-flex-positive:1;flex-grow:1;max-width:100%}.row-cols-xl-1>*{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.row-cols-xl-2>*{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.row-cols-xl-3>*{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.row-cols-xl-4>*{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.row-cols-xl-5>*{-ms-flex:0 0 20%;flex:0 0 20%;max-width:20%}.row-cols-xl-6>*{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;width:auto;max-width:100%}.col-xl-1{-ms-flex:0 0 8.333333%;flex:0 0 8.333333%;max-width:8.333333%}.col-xl-2{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.col-xl-5{-ms-flex:0 0 41.666667%;flex:0 0 41.666667%;max-width:41.666667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.333333%;flex:0 0 58.333333%;max-width:58.333333%}.col-xl-8{-ms-flex:0 0 66.666667%;flex:0 0 66.666667%;max-width:66.666667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.333333%;flex:0 0 83.333333%;max-width:83.333333%}.col-xl-11{-ms-flex:0 0 91.666667%;flex:0 0 91.666667%;max-width:91.666667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.order-xl-first{-ms-flex-order:-1;order:-1}.order-xl-last{-ms-flex-order:13;order:13}.order-xl-0{-ms-flex-order:0;order:0}.order-xl-1{-ms-flex-order:1;order:1}.order-xl-2{-ms-flex-order:2;order:2}.order-xl-3{-ms-flex-order:3;order:3}.order-xl-4{-ms-flex-order:4;order:4}.order-xl-5{-ms-flex-order:5;order:5}.order-xl-6{-ms-flex-order:6;order:6}.order-xl-7{-ms-flex-order:7;order:7}.order-xl-8{-ms-flex-order:8;order:8}.order-xl-9{-ms-flex-order:9;order:9}.order-xl-10{-ms-flex-order:10;order:10}.order-xl-11{-ms-flex-order:11;order:11}.order-xl-12{-ms-flex-order:12;order:12}.offset-xl-0{margin-left:0}.offset-xl-1{margin-left:8.333333%}.offset-xl-2{margin-left:16.666667%}.offset-xl-3{margin-left:25%}.offset-xl-4{margin-left:33.333333%}.offset-xl-5{margin-left:41.666667%}.offset-xl-6{margin-left:50%}.offset-xl-7{margin-left:58.333333%}.offset-xl-8{margin-left:66.666667%}.offset-xl-9{margin-left:75%}.offset-xl-10{margin-left:83.333333%}.offset-xl-11{margin-left:91.666667%}}.table{width:100%;margin-bottom:1rem;color:#212529}.table td,.table th{padding:.75rem;vertical-align:top;border-top:1px solid #dee2e6}.table thead th{vertical-align:bottom;border-bottom:2px solid #dee2e6}.table tbody+tbody{border-top:2px solid #dee2e6}.table-sm td,.table-sm th{padding:.3rem}.table-bordered{border:1px solid #dee2e6}.table-bordered td,.table-bordered th{border:1px solid #dee2e6}.table-bordered thead td,.table-bordered thead th{border-bottom-width:2px}.table-borderless tbody+tbody,.table-borderless td,.table-borderless th,.table-borderless thead th{border:0}.table-striped tbody tr:nth-of-type(odd){background-color:rgba(0,0,0,.05)}.table-hover tbody tr:hover{color:#212529;background-color:rgba(0,0,0,.075)}.table-primary,.table-primary>td,.table-primary>th{background-color:#b8daff}.table-primary tbody+tbody,.table-primary td,.table-primary th,.table-primary thead th{border-color:#7abaff}.table-hover .table-primary:hover{background-color:#9fcdff}.table-hover .table-primary:hover>td,.table-hover .table-primary:hover>th{background-color:#9fcdff}.table-secondary,.table-secondary>td,.table-secondary>th{background-color:#d6d8db}.table-secondary tbody+tbody,.table-secondary td,.table-secondary th,.table-secondary thead th{border-color:#b3b7bb}.table-hover .table-secondary:hover{background-color:#c8cbcf}.table-hover .table-secondary:hover>td,.table-hover .table-secondary:hover>th{background-color:#c8cbcf}.table-success,.table-success>td,.table-success>th{background-color:#c3e6cb}.table-success tbody+tbody,.table-success td,.table-success th,.table-success thead th{border-color:#8fd19e}.table-hover .table-success:hover{background-color:#b1dfbb}.table-hover .table-success:hover>td,.table-hover .table-success:hover>th{background-color:#b1dfbb}.table-info,.table-info>td,.table-info>th{background-color:#bee5eb}.table-info tbody+tbody,.table-info td,.table-info th,.table-info thead th{border-color:#86cfda}.table-hover .table-info:hover{background-color:#abdde5}.table-hover .table-info:hover>td,.table-hover .table-info:hover>th{background-color:#abdde5}.table-warning,.table-warning>td,.table-warning>th{background-color:#ffeeba}.table-warning tbody+tbody,.table-warning td,.table-warning th,.table-warning thead th{border-color:#ffdf7e}.table-hover .table-warning:hover{background-color:#ffe8a1}.table-hover .table-warning:hover>td,.table-hover .table-warning:hover>th{background-color:#ffe8a1}.table-danger,.table-danger>td,.table-danger>th{background-color:#f5c6cb}.table-danger tbody+tbody,.table-danger td,.table-danger th,.table-danger thead th{border-color:#ed969e}.table-hover .table-danger:hover{background-color:#f1b0b7}.table-hover .table-danger:hover>td,.table-hover .table-danger:hover>th{background-color:#f1b0b7}.table-light,.table-light>td,.table-light>th{background-color:#fdfdfe}.table-light tbody+tbody,.table-light td,.table-light th,.table-light thead th{border-color:#fbfcfc}.table-hover .table-light:hover{background-color:#ececf6}.table-hover .table-light:hover>td,.table-hover .table-light:hover>th{background-color:#ececf6}.table-dark,.table-dark>td,.table-dark>th{background-color:#c6c8ca}.table-dark tbody+tbody,.table-dark td,.table-dark th,.table-dark thead th{border-color:#95999c}.table-hover .table-dark:hover{background-color:#b9bbbe}.table-hover .table-dark:hover>td,.table-hover .table-dark:hover>th{background-color:#b9bbbe}.table-active,.table-active>td,.table-active>th{background-color:rgba(0,0,0,.075)}.table-hover .table-active:hover{background-color:rgba(0,0,0,.075)}.table-hover .table-active:hover>td,.table-hover .table-active:hover>th{background-color:rgba(0,0,0,.075)}.table .thead-dark th{color:#fff;background-color:#343a40;border-color:#454d55}.table .thead-light th{color:#495057;background-color:#e9ecef;border-color:#dee2e6}.table-dark{color:#fff;background-color:#343a40}.table-dark td,.table-dark th,.table-dark thead th{border-color:#454d55}.table-dark.table-bordered{border:0}.table-dark.table-striped tbody tr:nth-of-type(odd){background-color:rgba(255,255,255,.05)}.table-dark.table-hover tbody tr:hover{color:#fff;background-color:rgba(255,255,255,.075)}@media (max-width:575.98px){.table-responsive-sm{display:block;width:100%;overflow-x:auto;-webkit-overflow-scrolling:touch}.table-responsive-sm>.table-bordered{border:0}}@media (max-width:767.98px){.table-responsive-md{display:block;width:100%;overflow-x:auto;-webkit-overflow-scrolling:touch}.table-responsive-md>.table-bordered{border:0}}@media (max-width:991.98px){.table-responsive-lg{display:block;width:100%;overflow-x:auto;-webkit-overflow-scrolling:touch}.table-responsive-lg>.table-bordered{border:0}}@media (max-width:1199.98px){.table-responsive-xl{display:block;width:100%;overflow-x:auto;-webkit-overflow-scrolling:touch}.table-responsive-xl>.table-bordered{border:0}}.table-responsive{display:block;width:100%;overflow-x:auto;-webkit-overflow-scrolling:touch}.table-responsive>.table-bordered{border:0}.form-control{display:block;width:100%;height:calc(1.5em + .75rem + 2px);padding:.375rem .75rem;font-size:1rem;font-weight:400;line-height:1.5;color:#495057;background-color:#fff;background-clip:padding-box;border:1px solid #ced4da;border-radius:.25rem;transition:border-color .15s ease-in-out,box-shadow .15s ease-in-out}@media (prefers-reduced-motion:reduce){.form-control{transition:none}}.form-control::-ms-expand{background-color:transparent;border:0}.form-control:focus{color:#495057;background-color:#fff;border-color:#80bdff;outline:0;box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.form-control::-webkit-input-placeholder{color:#6c757d;opacity:1}.form-control::-moz-placeholder{color:#6c757d;opacity:1}.form-control:-ms-input-placeholder{color:#6c757d;opacity:1}.form-control::-ms-input-placeholder{color:#6c757d;opacity:1}.form-control::placeholder{color:#6c757d;opacity:1}.form-control:disabled,.form-control[readonly]{background-color:#e9ecef;opacity:1}input[type=date].form-control,input[type=datetime-local].form-control,input[type=month].form-control,input[type=time].form-control{-webkit-appearance:none;-moz-appearance:none;appearance:none}select.form-control:-moz-focusring{color:transparent;text-shadow:0 0 0 #495057}select.form-control:focus::-ms-value{color:#495057;background-color:#fff}.form-control-file,.form-control-range{display:block;width:100%}.col-form-label{padding-top:calc(.375rem + 1px);padding-bottom:calc(.375rem + 1px);margin-bottom:0;font-size:inherit;line-height:1.5}.col-form-label-lg{padding-top:calc(.5rem + 1px);padding-bottom:calc(.5rem + 1px);font-size:1.25rem;line-height:1.5}.col-form-label-sm{padding-top:calc(.25rem + 1px);padding-bottom:calc(.25rem + 1px);font-size:.875rem;line-height:1.5}.form-control-plaintext{display:block;width:100%;padding:.375rem 0;margin-bottom:0;font-size:1rem;line-height:1.5;color:#212529;background-color:transparent;border:solid transparent;border-width:1px 0}.form-control-plaintext.form-control-lg,.form-control-plaintext.form-control-sm{padding-right:0;padding-left:0}.form-control-sm{height:calc(1.5em + .5rem + 2px);padding:.25rem .5rem;font-size:.875rem;line-height:1.5;border-radius:.2rem}.form-control-lg{height:calc(1.5em + 1rem + 2px);padding:.5rem 1rem;font-size:1.25rem;line-height:1.5;border-radius:.3rem}select.form-control[multiple],select.form-control[size]{height:auto}textarea.form-control{height:auto}.form-group{margin-bottom:1rem}.form-text{display:block;margin-top:.25rem}.form-row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-right:-5px;margin-left:-5px}.form-row>.col,.form-row>[class*=col-]{padding-right:5px;padding-left:5px}.form-check{position:relative;display:block;padding-left:1.25rem}.form-check-input{position:absolute;margin-top:.3rem;margin-left:-1.25rem}.form-check-input:disabled~.form-check-label,.form-check-input[disabled]~.form-check-label{color:#6c757d}.form-check-label{margin-bottom:0}.form-check-inline{display:-ms-inline-flexbox;display:inline-flex;-ms-flex-align:center;align-items:center;padding-left:0;margin-right:.75rem}.form-check-inline .form-check-input{position:static;margin-top:0;margin-right:.3125rem;margin-left:0}.valid-feedback{display:none;width:100%;margin-top:.25rem;font-size:80%;color:#28a745}.valid-tooltip{position:absolute;top:100%;left:0;z-index:5;display:none;max-width:100%;padding:.25rem .5rem;margin-top:.1rem;font-size:.875rem;line-height:1.5;color:#fff;background-color:rgba(40,167,69,.9);border-radius:.25rem}.form-row>.col>.valid-tooltip,.form-row>[class*=col-]>.valid-tooltip{left:5px}.is-valid~.valid-feedback,.is-valid~.valid-tooltip,.was-validated :valid~.valid-feedback,.was-validated :valid~.valid-tooltip{display:block}.form-control.is-valid,.was-validated .form-control:valid{border-color:#28a745;padding-right:calc(1.5em + .75rem)!important;background-image:url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='8' height='8' viewBox='0 0 8 8'%3e%3cpath fill='%2328a745' d='M2.3 6.73L.6 4.53c-.4-1.04.46-1.4 1.1-.8l1.1 1.4 3.4-3.8c.6-.63 1.6-.27 1.2.7l-4 4.6c-.43.5-.8.4-1.1.1z'/%3e%3c/svg%3e");background-repeat:no-repeat;background-position:right calc(.375em + .1875rem) center;background-size:calc(.75em + .375rem) calc(.75em + .375rem)}.form-control.is-valid:focus,.was-validated .form-control:valid:focus{border-color:#28a745;box-shadow:0 0 0 .2rem rgba(40,167,69,.25)}.was-validated select.form-control:valid,select.form-control.is-valid{padding-right:3rem!important;background-position:right 1.5rem center}.was-validated textarea.form-control:valid,textarea.form-control.is-valid{padding-right:calc(1.5em + .75rem);background-position:top calc(.375em + .1875rem) right calc(.375em + .1875rem)}.custom-select.is-valid,.was-validated .custom-select:valid{border-color:#28a745;padding-right:calc(.75em + 2.3125rem)!important;background:url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='4' height='5' viewBox='0 0 4 5'%3e%3cpath fill='%23343a40' d='M2 0L0 2h4zm0 5L0 3h4z'/%3e%3c/svg%3e") right .75rem center/8px 10px no-repeat,#fff url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='8' height='8' viewBox='0 0 8 8'%3e%3cpath fill='%2328a745' d='M2.3 6.73L.6 4.53c-.4-1.04.46-1.4 1.1-.8l1.1 1.4 3.4-3.8c.6-.63 1.6-.27 1.2.7l-4 4.6c-.43.5-.8.4-1.1.1z'/%3e%3c/svg%3e") center right 1.75rem/calc(.75em + .375rem) calc(.75em + .375rem) no-repeat}.custom-select.is-valid:focus,.was-validated .custom-select:valid:focus{border-color:#28a745;box-shadow:0 0 0 .2rem rgba(40,167,69,.25)}.form-check-input.is-valid~.form-check-label,.was-validated .form-check-input:valid~.form-check-label{color:#28a745}.form-check-input.is-valid~.valid-feedback,.form-check-input.is-valid~.valid-tooltip,.was-validated .form-check-input:valid~.valid-feedback,.was-validated .form-check-input:valid~.valid-tooltip{display:block}.custom-control-input.is-valid~.custom-control-label,.was-validated .custom-control-input:valid~.custom-control-label{color:#28a745}.custom-control-input.is-valid~.custom-control-label::before,.was-validated .custom-control-input:valid~.custom-control-label::before{border-color:#28a745}.custom-control-input.is-valid:checked~.custom-control-label::before,.was-validated .custom-control-input:valid:checked~.custom-control-label::before{border-color:#34ce57;background-color:#34ce57}.custom-control-input.is-valid:focus~.custom-control-label::before,.was-validated .custom-control-input:valid:focus~.custom-control-label::before{box-shadow:0 0 0 .2rem rgba(40,167,69,.25)}.custom-control-input.is-valid:focus:not(:checked)~.custom-control-label::before,.was-validated .custom-control-input:valid:focus:not(:checked)~.custom-control-label::before{border-color:#28a745}.custom-file-input.is-valid~.custom-file-label,.was-validated .custom-file-input:valid~.custom-file-label{border-color:#28a745}.custom-file-input.is-valid:focus~.custom-file-label,.was-validated .custom-file-input:valid:focus~.custom-file-label{border-color:#28a745;box-shadow:0 0 0 .2rem rgba(40,167,69,.25)}.invalid-feedback{display:none;width:100%;margin-top:.25rem;font-size:80%;color:#dc3545}.invalid-tooltip{position:absolute;top:100%;left:0;z-index:5;display:none;max-width:100%;padding:.25rem .5rem;margin-top:.1rem;font-size:.875rem;line-height:1.5;color:#fff;background-color:rgba(220,53,69,.9);border-radius:.25rem}.form-row>.col>.invalid-tooltip,.form-row>[class*=col-]>.invalid-tooltip{left:5px}.is-invalid~.invalid-feedback,.is-invalid~.invalid-tooltip,.was-validated :invalid~.invalid-feedback,.was-validated :invalid~.invalid-tooltip{display:block}.form-control.is-invalid,.was-validated .form-control:invalid{border-color:#dc3545;padding-right:calc(1.5em + .75rem)!important;background-image:url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' fill='none' stroke='%23dc3545' viewBox='0 0 12 12'%3e%3ccircle cx='6' cy='6' r='4.5'/%3e%3cpath stroke-linejoin='round' d='M5.8 3.6h.4L6 6.5z'/%3e%3ccircle cx='6' cy='8.2' r='.6' fill='%23dc3545' stroke='none'/%3e%3c/svg%3e");background-repeat:no-repeat;background-position:right calc(.375em + .1875rem) center;background-size:calc(.75em + .375rem) calc(.75em + .375rem)}.form-control.is-invalid:focus,.was-validated .form-control:invalid:focus{border-color:#dc3545;box-shadow:0 0 0 .2rem rgba(220,53,69,.25)}.was-validated select.form-control:invalid,select.form-control.is-invalid{padding-right:3rem!important;background-position:right 1.5rem center}.was-validated textarea.form-control:invalid,textarea.form-control.is-invalid{padding-right:calc(1.5em + .75rem);background-position:top calc(.375em + .1875rem) right calc(.375em + .1875rem)}.custom-select.is-invalid,.was-validated .custom-select:invalid{border-color:#dc3545;padding-right:calc(.75em + 2.3125rem)!important;background:url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='4' height='5' viewBox='0 0 4 5'%3e%3cpath fill='%23343a40' d='M2 0L0 2h4zm0 5L0 3h4z'/%3e%3c/svg%3e") right .75rem center/8px 10px no-repeat,#fff url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' fill='none' stroke='%23dc3545' viewBox='0 0 12 12'%3e%3ccircle cx='6' cy='6' r='4.5'/%3e%3cpath stroke-linejoin='round' d='M5.8 3.6h.4L6 6.5z'/%3e%3ccircle cx='6' cy='8.2' r='.6' fill='%23dc3545' stroke='none'/%3e%3c/svg%3e") center right 1.75rem/calc(.75em + .375rem) calc(.75em + .375rem) no-repeat}.custom-select.is-invalid:focus,.was-validated .custom-select:invalid:focus{border-color:#dc3545;box-shadow:0 0 0 .2rem rgba(220,53,69,.25)}.form-check-input.is-invalid~.form-check-label,.was-validated .form-check-input:invalid~.form-check-label{color:#dc3545}.form-check-input.is-invalid~.invalid-feedback,.form-check-input.is-invalid~.invalid-tooltip,.was-validated .form-check-input:invalid~.invalid-feedback,.was-validated .form-check-input:invalid~.invalid-tooltip{display:block}.custom-control-input.is-invalid~.custom-control-label,.was-validated .custom-control-input:invalid~.custom-control-label{color:#dc3545}.custom-control-input.is-invalid~.custom-control-label::before,.was-validated .custom-control-input:invalid~.custom-control-label::before{border-color:#dc3545}.custom-control-input.is-invalid:checked~.custom-control-label::before,.was-validated .custom-control-input:invalid:checked~.custom-control-label::before{border-color:#e4606d;background-color:#e4606d}.custom-control-input.is-invalid:focus~.custom-control-label::before,.was-validated .custom-control-input:invalid:focus~.custom-control-label::before{box-shadow:0 0 0 .2rem rgba(220,53,69,.25)}.custom-control-input.is-invalid:focus:not(:checked)~.custom-control-label::before,.was-validated .custom-control-input:invalid:focus:not(:checked)~.custom-control-label::before{border-color:#dc3545}.custom-file-input.is-invalid~.custom-file-label,.was-validated .custom-file-input:invalid~.custom-file-label{border-color:#dc3545}.custom-file-input.is-invalid:focus~.custom-file-label,.was-validated .custom-file-input:invalid:focus~.custom-file-label{border-color:#dc3545;box-shadow:0 0 0 .2rem rgba(220,53,69,.25)}.form-inline{display:-ms-flexbox;display:flex;-ms-flex-flow:row wrap;flex-flow:row wrap;-ms-flex-align:center;align-items:center}.form-inline .form-check{width:100%}@media (min-width:576px){.form-inline label{display:-ms-flexbox;display:flex;-ms-flex-align:center;align-items:center;-ms-flex-pack:center;justify-content:center;margin-bottom:0}.form-inline .form-group{display:-ms-flexbox;display:flex;-ms-flex:0 0 auto;flex:0 0 auto;-ms-flex-flow:row wrap;flex-flow:row wrap;-ms-flex-align:center;align-items:center;margin-bottom:0}.form-inline .form-control{display:inline-block;width:auto;vertical-align:middle}.form-inline .form-control-plaintext{display:inline-block}.form-inline .custom-select,.form-inline .input-group{width:auto}.form-inline .form-check{display:-ms-flexbox;display:flex;-ms-flex-align:center;align-items:center;-ms-flex-pack:center;justify-content:center;width:auto;padding-left:0}.form-inline .form-check-input{position:relative;-ms-flex-negative:0;flex-shrink:0;margin-top:0;margin-right:.25rem;margin-left:0}.form-inline .custom-control{-ms-flex-align:center;align-items:center;-ms-flex-pack:center;justify-content:center}.form-inline .custom-control-label{margin-bottom:0}}.btn{display:inline-block;font-weight:400;color:#212529;text-align:center;vertical-align:middle;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;background-color:transparent;border:1px solid transparent;padding:.375rem .75rem;font-size:1rem;line-height:1.5;border-radius:.25rem;transition:color .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out}@media (prefers-reduced-motion:reduce){.btn{transition:none}}.btn:hover{color:#212529;text-decoration:none}.btn.focus,.btn:focus{outline:0;box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.btn.disabled,.btn:disabled{opacity:.65}.btn:not(:disabled):not(.disabled){cursor:pointer}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{color:#fff;background-color:#007bff;border-color:#007bff}.btn-primary:hover{color:#fff;background-color:#0069d9;border-color:#0062cc}.btn-primary.focus,.btn-primary:focus{color:#fff;background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(38,143,255,.5)}.btn-primary.disabled,.btn-primary:disabled{color:#fff;background-color:#007bff;border-color:#007bff}.btn-primary:not(:disabled):not(.disabled).active,.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{color:#fff;background-color:#0062cc;border-color:#005cbf}.btn-primary:not(:disabled):not(.disabled).active:focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(38,143,255,.5)}.btn-secondary{color:#fff;background-color:#6c757d;border-color:#6c757d}.btn-secondary:hover{color:#fff;background-color:#5a6268;border-color:#545b62}.btn-secondary.focus,.btn-secondary:focus{color:#fff;background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(130,138,145,.5)}.btn-secondary.disabled,.btn-secondary:disabled{color:#fff;background-color:#6c757d;border-color:#6c757d}.btn-secondary:not(:disabled):not(.disabled).active,.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{color:#fff;background-color:#545b62;border-color:#4e555b}.btn-secondary:not(:disabled):not(.disabled).active:focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(130,138,145,.5)}.btn-success{color:#fff;background-color:#28a745;border-color:#28a745}.btn-success:hover{color:#fff;background-color:#218838;border-color:#1e7e34}.btn-success.focus,.btn-success:focus{color:#fff;background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(72,180,97,.5)}.btn-success.disabled,.btn-success:disabled{color:#fff;background-color:#28a745;border-color:#28a745}.btn-success:not(:disabled):not(.disabled).active,.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{color:#fff;background-color:#1e7e34;border-color:#1c7430}.btn-success:not(:disabled):not(.disabled).active:focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(72,180,97,.5)}.btn-info{color:#fff;background-color:#17a2b8;border-color:#17a2b8}.btn-info:hover{color:#fff;background-color:#138496;border-color:#117a8b}.btn-info.focus,.btn-info:focus{color:#fff;background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(58,176,195,.5)}.btn-info.disabled,.btn-info:disabled{color:#fff;background-color:#17a2b8;border-color:#17a2b8}.btn-info:not(:disabled):not(.disabled).active,.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{color:#fff;background-color:#117a8b;border-color:#10707f}.btn-info:not(:disabled):not(.disabled).active:focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(58,176,195,.5)}.btn-warning{color:#212529;background-color:#ffc107;border-color:#ffc107}.btn-warning:hover{color:#212529;background-color:#e0a800;border-color:#d39e00}.btn-warning.focus,.btn-warning:focus{color:#212529;background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(222,170,12,.5)}.btn-warning.disabled,.btn-warning:disabled{color:#212529;background-color:#ffc107;border-color:#ffc107}.btn-warning:not(:disabled):not(.disabled).active,.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{color:#212529;background-color:#d39e00;border-color:#c69500}.btn-warning:not(:disabled):not(.disabled).active:focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(222,170,12,.5)}.btn-danger{color:#fff;background-color:#dc3545;border-color:#dc3545}.btn-danger:hover{color:#fff;background-color:#c82333;border-color:#bd2130}.btn-danger.focus,.btn-danger:focus{color:#fff;background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(225,83,97,.5)}.btn-danger.disabled,.btn-danger:disabled{color:#fff;background-color:#dc3545;border-color:#dc3545}.btn-danger:not(:disabled):not(.disabled).active,.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{color:#fff;background-color:#bd2130;border-color:#b21f2d}.btn-danger:not(:disabled):not(.disabled).active:focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(225,83,97,.5)}.btn-light{color:#212529;background-color:#f8f9fa;border-color:#f8f9fa}.btn-light:hover{color:#212529;background-color:#e2e6ea;border-color:#dae0e5}.btn-light.focus,.btn-light:focus{color:#212529;background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(216,217,219,.5)}.btn-light.disabled,.btn-light:disabled{color:#212529;background-color:#f8f9fa;border-color:#f8f9fa}.btn-light:not(:disabled):not(.disabled).active,.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{color:#212529;background-color:#dae0e5;border-color:#d3d9df}.btn-light:not(:disabled):not(.disabled).active:focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(216,217,219,.5)}.btn-dark{color:#fff;background-color:#343a40;border-color:#343a40}.btn-dark:hover{color:#fff;background-color:#23272b;border-color:#1d2124}.btn-dark.focus,.btn-dark:focus{color:#fff;background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(82,88,93,.5)}.btn-dark.disabled,.btn-dark:disabled{color:#fff;background-color:#343a40;border-color:#343a40}.btn-dark:not(:disabled):not(.disabled).active,.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{color:#fff;background-color:#1d2124;border-color:#171a1d}.btn-dark:not(:disabled):not(.disabled).active:focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(82,88,93,.5)}.btn-outline-primary{color:#007bff;border-color:#007bff}.btn-outline-primary:hover{color:#fff;background-color:#007bff;border-color:#007bff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{color:#007bff;background-color:transparent}.btn-outline-primary:not(:disabled):not(.disabled).active,.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{color:#fff;background-color:#007bff;border-color:#007bff}.btn-outline-primary:not(:disabled):not(.disabled).active:focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,.5)}.btn-outline-secondary{color:#6c757d;border-color:#6c757d}.btn-outline-secondary:hover{color:#fff;background-color:#6c757d;border-color:#6c757d}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{color:#6c757d;background-color:transparent}.btn-outline-secondary:not(:disabled):not(.disabled).active,.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{color:#fff;background-color:#6c757d;border-color:#6c757d}.btn-outline-secondary:not(:disabled):not(.disabled).active:focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,.5)}.btn-outline-success{color:#28a745;border-color:#28a745}.btn-outline-success:hover{color:#fff;background-color:#28a745;border-color:#28a745}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{color:#28a745;background-color:transparent}.btn-outline-success:not(:disabled):not(.disabled).active,.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{color:#fff;background-color:#28a745;border-color:#28a745}.btn-outline-success:not(:disabled):not(.disabled).active:focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,.5)}.btn-outline-info{color:#17a2b8;border-color:#17a2b8}.btn-outline-info:hover{color:#fff;background-color:#17a2b8;border-color:#17a2b8}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{color:#17a2b8;background-color:transparent}.btn-outline-info:not(:disabled):not(.disabled).active,.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{color:#fff;background-color:#17a2b8;border-color:#17a2b8}.btn-outline-info:not(:disabled):not(.disabled).active:focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,.5)}.btn-outline-warning{color:#ffc107;border-color:#ffc107}.btn-outline-warning:hover{color:#212529;background-color:#ffc107;border-color:#ffc107}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{color:#ffc107;background-color:transparent}.btn-outline-warning:not(:disabled):not(.disabled).active,.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{color:#212529;background-color:#ffc107;border-color:#ffc107}.btn-outline-warning:not(:disabled):not(.disabled).active:focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,.5)}.btn-outline-danger{color:#dc3545;border-color:#dc3545}.btn-outline-danger:hover{color:#fff;background-color:#dc3545;border-color:#dc3545}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{color:#dc3545;background-color:transparent}.btn-outline-danger:not(:disabled):not(.disabled).active,.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{color:#fff;background-color:#dc3545;border-color:#dc3545}.btn-outline-danger:not(:disabled):not(.disabled).active:focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,.5)}.btn-outline-light{color:#f8f9fa;border-color:#f8f9fa}.btn-outline-light:hover{color:#212529;background-color:#f8f9fa;border-color:#f8f9fa}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{color:#f8f9fa;background-color:transparent}.btn-outline-light:not(:disabled):not(.disabled).active,.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{color:#212529;background-color:#f8f9fa;border-color:#f8f9fa}.btn-outline-light:not(:disabled):not(.disabled).active:focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,.5)}.btn-outline-dark{color:#343a40;border-color:#343a40}.btn-outline-dark:hover{color:#fff;background-color:#343a40;border-color:#343a40}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{color:#343a40;background-color:transparent}.btn-outline-dark:not(:disabled):not(.disabled).active,.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{color:#fff;background-color:#343a40;border-color:#343a40}.btn-outline-dark:not(:disabled):not(.disabled).active:focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,.5)}.btn-link{font-weight:400;color:#007bff;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{padding:.5rem 1rem;font-size:1.25rem;line-height:1.5;border-radius:.3rem}.btn-group-sm>.btn,.btn-sm{padding:.25rem .5rem;font-size:.875rem;line-height:1.5;border-radius:.2rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input[type=button].btn-block,input[type=reset].btn-block,input[type=submit].btn-block{width:100%}.fade{transition:opacity .15s linear}@media (prefers-reduced-motion:reduce){.fade{transition:none}}.fade:not(.show){opacity:0}.collapse:not(.show){display:none}.collapsing{position:relative;height:0;overflow:hidden;transition:height .35s ease}@media (prefers-reduced-motion:reduce){.collapsing{transition:none}}.dropdown,.dropleft,.dropright,.dropup{position:relative}.dropdown-toggle{white-space:nowrap}.dropdown-toggle::after{display:inline-block;margin-left:.255em;vertical-align:.255em;content:"";border-top:.3em solid;border-right:.3em solid transparent;border-bottom:0;border-left:.3em solid transparent}.dropdown-toggle:empty::after{margin-left:0}.dropdown-menu{position:absolute;top:100%;left:0;z-index:1000;display:none;float:left;min-width:10rem;padding:.5rem 0;margin:.125rem 0 0;font-size:1rem;color:#212529;text-align:left;list-style:none;background-color:#fff;background-clip:padding-box;border:1px solid rgba(0,0,0,.15);border-radius:.25rem}.dropdown-menu-left{right:auto;left:0}.dropdown-menu-right{right:0;left:auto}@media (min-width:576px){.dropdown-menu-sm-left{right:auto;left:0}.dropdown-menu-sm-right{right:0;left:auto}}@media (min-width:768px){.dropdown-menu-md-left{right:auto;left:0}.dropdown-menu-md-right{right:0;left:auto}}@media (min-width:992px){.dropdown-menu-lg-left{right:auto;left:0}.dropdown-menu-lg-right{right:0;left:auto}}@media (min-width:1200px){.dropdown-menu-xl-left{right:auto;left:0}.dropdown-menu-xl-right{right:0;left:auto}}.dropup .dropdown-menu{top:auto;bottom:100%;margin-top:0;margin-bottom:.125rem}.dropup .dropdown-toggle::after{display:inline-block;margin-left:.255em;vertical-align:.255em;content:"";border-top:0;border-right:.3em solid transparent;border-bottom:.3em solid;border-left:.3em solid transparent}.dropup .dropdown-toggle:empty::after{margin-left:0}.dropright .dropdown-menu{top:0;right:auto;left:100%;margin-top:0;margin-left:.125rem}.dropright .dropdown-toggle::after{display:inline-block;margin-left:.255em;vertical-align:.255em;content:"";border-top:.3em solid transparent;border-right:0;border-bottom:.3em solid transparent;border-left:.3em solid}.dropright .dropdown-toggle:empty::after{margin-left:0}.dropright .dropdown-toggle::after{vertical-align:0}.dropleft .dropdown-menu{top:0;right:100%;left:auto;margin-top:0;margin-right:.125rem}.dropleft .dropdown-toggle::after{display:inline-block;margin-left:.255em;vertical-align:.255em;content:""}.dropleft .dropdown-toggle::after{display:none}.dropleft .dropdown-toggle::before{display:inline-block;margin-right:.255em;vertical-align:.255em;content:"";border-top:.3em solid transparent;border-right:.3em solid;border-bottom:.3em solid transparent}.dropleft .dropdown-toggle:empty::after{margin-left:0}.dropleft .dropdown-toggle::before{vertical-align:0}.dropdown-menu[x-placement^=bottom],.dropdown-menu[x-placement^=left],.dropdown-menu[x-placement^=right],.dropdown-menu[x-placement^=top]{right:auto;bottom:auto}.dropdown-divider{height:0;margin:.5rem 0;overflow:hidden;border-top:1px solid #e9ecef}.dropdown-item{display:block;width:100%;padding:.25rem 1.5rem;clear:both;font-weight:400;color:#212529;text-align:inherit;white-space:nowrap;background-color:transparent;border:0}.dropdown-item:focus,.dropdown-item:hover{color:#16181b;text-decoration:none;background-color:#e9ecef}.dropdown-item.active,.dropdown-item:active{color:#fff;text-decoration:none;background-color:#007bff}.dropdown-item.disabled,.dropdown-item:disabled{color:#adb5bd;pointer-events:none;background-color:transparent}.dropdown-menu.show{display:block}.dropdown-header{display:block;padding:.5rem 1.5rem;margin-bottom:0;font-size:.875rem;color:#6c757d;white-space:nowrap}.dropdown-item-text{display:block;padding:.25rem 1.5rem;color:#212529}.btn-group,.btn-group-vertical{position:relative;display:-ms-inline-flexbox;display:inline-flex;vertical-align:middle}.btn-group-vertical>.btn,.btn-group>.btn{position:relative;-ms-flex:1 1 auto;flex:1 1 auto}.btn-group-vertical>.btn:hover,.btn-group>.btn:hover{z-index:1}.btn-group-vertical>.btn.active,.btn-group-vertical>.btn:active,.btn-group-vertical>.btn:focus,.btn-group>.btn.active,.btn-group>.btn:active,.btn-group>.btn:focus{z-index:1}.btn-toolbar{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;-ms-flex-pack:start;justify-content:flex-start}.btn-toolbar .input-group{width:auto}.btn-group>.btn-group:not(:first-child),.btn-group>.btn:not(:first-child){margin-left:-1px}.btn-group>.btn-group:not(:last-child)>.btn,.btn-group>.btn:not(:last-child):not(.dropdown-toggle){border-top-right-radius:0;border-bottom-right-radius:0}.btn-group>.btn-group:not(:first-child)>.btn,.btn-group>.btn:not(:first-child){border-top-left-radius:0;border-bottom-left-radius:0}.dropdown-toggle-split{padding-right:.5625rem;padding-left:.5625rem}.dropdown-toggle-split::after,.dropright .dropdown-toggle-split::after,.dropup .dropdown-toggle-split::after{margin-left:0}.dropleft .dropdown-toggle-split::before{margin-right:0}.btn-group-sm>.btn+.dropdown-toggle-split,.btn-sm+.dropdown-toggle-split{padding-right:.375rem;padding-left:.375rem}.btn-group-lg>.btn+.dropdown-toggle-split,.btn-lg+.dropdown-toggle-split{padding-right:.75rem;padding-left:.75rem}.btn-group-vertical{-ms-flex-direction:column;flex-direction:column;-ms-flex-align:start;align-items:flex-start;-ms-flex-pack:center;justify-content:center}.btn-group-vertical>.btn,.btn-group-vertical>.btn-group{width:100%}.btn-group-vertical>.btn-group:not(:first-child),.btn-group-vertical>.btn:not(:first-child){margin-top:-1px}.btn-group-vertical>.btn-group:not(:last-child)>.btn,.btn-group-vertical>.btn:not(:last-child):not(.dropdown-toggle){border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn-group:not(:first-child)>.btn,.btn-group-vertical>.btn:not(:first-child){border-top-left-radius:0;border-top-right-radius:0}.btn-group-toggle>.btn,.btn-group-toggle>.btn-group>.btn{margin-bottom:0}.btn-group-toggle>.btn input[type=checkbox],.btn-group-toggle>.btn input[type=radio],.btn-group-toggle>.btn-group>.btn input[type=checkbox],.btn-group-toggle>.btn-group>.btn input[type=radio]{position:absolute;clip:rect(0,0,0,0);pointer-events:none}.input-group{position:relative;display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;-ms-flex-align:stretch;align-items:stretch;width:100%}.input-group>.custom-file,.input-group>.custom-select,.input-group>.form-control,.input-group>.form-control-plaintext{position:relative;-ms-flex:1 1 auto;flex:1 1 auto;width:1%;min-width:0;margin-bottom:0}.input-group>.custom-file+.custom-file,.input-group>.custom-file+.custom-select,.input-group>.custom-file+.form-control,.input-group>.custom-select+.custom-file,.input-group>.custom-select+.custom-select,.input-group>.custom-select+.form-control,.input-group>.form-control+.custom-file,.input-group>.form-control+.custom-select,.input-group>.form-control+.form-control,.input-group>.form-control-plaintext+.custom-file,.input-group>.form-control-plaintext+.custom-select,.input-group>.form-control-plaintext+.form-control{margin-left:-1px}.input-group>.custom-file .custom-file-input:focus~.custom-file-label,.input-group>.custom-select:focus,.input-group>.form-control:focus{z-index:3}.input-group>.custom-file .custom-file-input:focus{z-index:4}.input-group>.custom-select:not(:first-child),.input-group>.form-control:not(:first-child){border-top-left-radius:0;border-bottom-left-radius:0}.input-group>.custom-file{display:-ms-flexbox;display:flex;-ms-flex-align:center;align-items:center}.input-group>.custom-file:not(:last-child) .custom-file-label,.input-group>.custom-file:not(:last-child) .custom-file-label::after{border-top-right-radius:0;border-bottom-right-radius:0}.input-group>.custom-file:not(:first-child) .custom-file-label{border-top-left-radius:0;border-bottom-left-radius:0}.input-group:not(.has-validation)>.custom-file:not(:last-child) .custom-file-label,.input-group:not(.has-validation)>.custom-file:not(:last-child) .custom-file-label::after,.input-group:not(.has-validation)>.custom-select:not(:last-child),.input-group:not(.has-validation)>.form-control:not(:last-child){border-top-right-radius:0;border-bottom-right-radius:0}.input-group.has-validation>.custom-file:nth-last-child(n+3) .custom-file-label,.input-group.has-validation>.custom-file:nth-last-child(n+3) .custom-file-label::after,.input-group.has-validation>.custom-select:nth-last-child(n+3),.input-group.has-validation>.form-control:nth-last-child(n+3){border-top-right-radius:0;border-bottom-right-radius:0}.input-group-append,.input-group-prepend{display:-ms-flexbox;display:flex}.input-group-append .btn,.input-group-prepend .btn{position:relative;z-index:2}.input-group-append .btn:focus,.input-group-prepend .btn:focus{z-index:3}.input-group-append .btn+.btn,.input-group-append .btn+.input-group-text,.input-group-append .input-group-text+.btn,.input-group-append .input-group-text+.input-group-text,.input-group-prepend .btn+.btn,.input-group-prepend .btn+.input-group-text,.input-group-prepend .input-group-text+.btn,.input-group-prepend .input-group-text+.input-group-text{margin-left:-1px}.input-group-prepend{margin-right:-1px}.input-group-append{margin-left:-1px}.input-group-text{display:-ms-flexbox;display:flex;-ms-flex-align:center;align-items:center;padding:.375rem .75rem;margin-bottom:0;font-size:1rem;font-weight:400;line-height:1.5;color:#495057;text-align:center;white-space:nowrap;background-color:#e9ecef;border:1px solid #ced4da;border-radius:.25rem}.input-group-text input[type=checkbox],.input-group-text input[type=radio]{margin-top:0}.input-group-lg>.custom-select,.input-group-lg>.form-control:not(textarea){height:calc(1.5em + 1rem + 2px)}.input-group-lg>.custom-select,.input-group-lg>.form-control,.input-group-lg>.input-group-append>.btn,.input-group-lg>.input-group-append>.input-group-text,.input-group-lg>.input-group-prepend>.btn,.input-group-lg>.input-group-prepend>.input-group-text{padding:.5rem 1rem;font-size:1.25rem;line-height:1.5;border-radius:.3rem}.input-group-sm>.custom-select,.input-group-sm>.form-control:not(textarea){height:calc(1.5em + .5rem + 2px)}.input-group-sm>.custom-select,.input-group-sm>.form-control,.input-group-sm>.input-group-append>.btn,.input-group-sm>.input-group-append>.input-group-text,.input-group-sm>.input-group-prepend>.btn,.input-group-sm>.input-group-prepend>.input-group-text{padding:.25rem .5rem;font-size:.875rem;line-height:1.5;border-radius:.2rem}.input-group-lg>.custom-select,.input-group-sm>.custom-select{padding-right:1.75rem}.input-group.has-validation>.input-group-append:nth-last-child(n+3)>.btn,.input-group.has-validation>.input-group-append:nth-last-child(n+3)>.input-group-text,.input-group:not(.has-validation)>.input-group-append:not(:last-child)>.btn,.input-group:not(.has-validation)>.input-group-append:not(:last-child)>.input-group-text,.input-group>.input-group-append:last-child>.btn:not(:last-child):not(.dropdown-toggle),.input-group>.input-group-append:last-child>.input-group-text:not(:last-child),.input-group>.input-group-prepend>.btn,.input-group>.input-group-prepend>.input-group-text{border-top-right-radius:0;border-bottom-right-radius:0}.input-group>.input-group-append>.btn,.input-group>.input-group-append>.input-group-text,.input-group>.input-group-prepend:first-child>.btn:not(:first-child),.input-group>.input-group-prepend:first-child>.input-group-text:not(:first-child),.input-group>.input-group-prepend:not(:first-child)>.btn,.input-group>.input-group-prepend:not(:first-child)>.input-group-text{border-top-left-radius:0;border-bottom-left-radius:0}.custom-control{position:relative;z-index:1;display:block;min-height:1.5rem;padding-left:1.5rem;-webkit-print-color-adjust:exact;color-adjust:exact}.custom-control-inline{display:-ms-inline-flexbox;display:inline-flex;margin-right:1rem}.custom-control-input{position:absolute;left:0;z-index:-1;width:1rem;height:1.25rem;opacity:0}.custom-control-input:checked~.custom-control-label::before{color:#fff;border-color:#007bff;background-color:#007bff}.custom-control-input:focus~.custom-control-label::before{box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.custom-control-input:focus:not(:checked)~.custom-control-label::before{border-color:#80bdff}.custom-control-input:not(:disabled):active~.custom-control-label::before{color:#fff;background-color:#b3d7ff;border-color:#b3d7ff}.custom-control-input:disabled~.custom-control-label,.custom-control-input[disabled]~.custom-control-label{color:#6c757d}.custom-control-input:disabled~.custom-control-label::before,.custom-control-input[disabled]~.custom-control-label::before{background-color:#e9ecef}.custom-control-label{position:relative;margin-bottom:0;vertical-align:top}.custom-control-label::before{position:absolute;top:.25rem;left:-1.5rem;display:block;width:1rem;height:1rem;pointer-events:none;content:"";background-color:#fff;border:#adb5bd solid 1px}.custom-control-label::after{position:absolute;top:.25rem;left:-1.5rem;display:block;width:1rem;height:1rem;content:"";background:50%/50% 50% no-repeat}.custom-checkbox .custom-control-label::before{border-radius:.25rem}.custom-checkbox .custom-control-input:checked~.custom-control-label::after{background-image:url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='8' height='8' viewBox='0 0 8 8'%3e%3cpath fill='%23fff' d='M6.564.75l-3.59 3.612-1.538-1.55L0 4.26l2.974 2.99L8 2.193z'/%3e%3c/svg%3e")}.custom-checkbox .custom-control-input:indeterminate~.custom-control-label::before{border-color:#007bff;background-color:#007bff}.custom-checkbox .custom-control-input:indeterminate~.custom-control-label::after{background-image:url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='4' height='4' viewBox='0 0 4 4'%3e%3cpath stroke='%23fff' d='M0 2h4'/%3e%3c/svg%3e")}.custom-checkbox .custom-control-input:disabled:checked~.custom-control-label::before{background-color:rgba(0,123,255,.5)}.custom-checkbox .custom-control-input:disabled:indeterminate~.custom-control-label::before{background-color:rgba(0,123,255,.5)}.custom-radio .custom-control-label::before{border-radius:50%}.custom-radio .custom-control-input:checked~.custom-control-label::after{background-image:url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' viewBox='-4 -4 8 8'%3e%3ccircle r='3' fill='%23fff'/%3e%3c/svg%3e")}.custom-radio .custom-control-input:disabled:checked~.custom-control-label::before{background-color:rgba(0,123,255,.5)}.custom-switch{padding-left:2.25rem}.custom-switch .custom-control-label::before{left:-2.25rem;width:1.75rem;pointer-events:all;border-radius:.5rem}.custom-switch .custom-control-label::after{top:calc(.25rem + 2px);left:calc(-2.25rem + 2px);width:calc(1rem - 4px);height:calc(1rem - 4px);background-color:#adb5bd;border-radius:.5rem;transition:background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out,-webkit-transform .15s ease-in-out;transition:transform .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out;transition:transform .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out,-webkit-transform .15s ease-in-out}@media (prefers-reduced-motion:reduce){.custom-switch .custom-control-label::after{transition:none}}.custom-switch .custom-control-input:checked~.custom-control-label::after{background-color:#fff;-webkit-transform:translateX(.75rem);transform:translateX(.75rem)}.custom-switch .custom-control-input:disabled:checked~.custom-control-label::before{background-color:rgba(0,123,255,.5)}.custom-select{display:inline-block;width:100%;height:calc(1.5em + .75rem + 2px);padding:.375rem 1.75rem .375rem .75rem;font-size:1rem;font-weight:400;line-height:1.5;color:#495057;vertical-align:middle;background:#fff url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='4' height='5' viewBox='0 0 4 5'%3e%3cpath fill='%23343a40' d='M2 0L0 2h4zm0 5L0 3h4z'/%3e%3c/svg%3e") right .75rem center/8px 10px no-repeat;border:1px solid #ced4da;border-radius:.25rem;-webkit-appearance:none;-moz-appearance:none;appearance:none}.custom-select:focus{border-color:#80bdff;outline:0;box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.custom-select:focus::-ms-value{color:#495057;background-color:#fff}.custom-select[multiple],.custom-select[size]:not([size="1"]){height:auto;padding-right:.75rem;background-image:none}.custom-select:disabled{color:#6c757d;background-color:#e9ecef}.custom-select::-ms-expand{display:none}.custom-select:-moz-focusring{color:transparent;text-shadow:0 0 0 #495057}.custom-select-sm{height:calc(1.5em + .5rem + 2px);padding-top:.25rem;padding-bottom:.25rem;padding-left:.5rem;font-size:.875rem}.custom-select-lg{height:calc(1.5em + 1rem + 2px);padding-top:.5rem;padding-bottom:.5rem;padding-left:1rem;font-size:1.25rem}.custom-file{position:relative;display:inline-block;width:100%;height:calc(1.5em + .75rem + 2px);margin-bottom:0}.custom-file-input{position:relative;z-index:2;width:100%;height:calc(1.5em + .75rem + 2px);margin:0;overflow:hidden;opacity:0}.custom-file-input:focus~.custom-file-label{border-color:#80bdff;box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.custom-file-input:disabled~.custom-file-label,.custom-file-input[disabled]~.custom-file-label{background-color:#e9ecef}.custom-file-input:lang(en)~.custom-file-label::after{content:"Browse"}.custom-file-input~.custom-file-label[data-browse]::after{content:attr(data-browse)}.custom-file-label{position:absolute;top:0;right:0;left:0;z-index:1;height:calc(1.5em + .75rem + 2px);padding:.375rem .75rem;overflow:hidden;font-weight:400;line-height:1.5;color:#495057;background-color:#fff;border:1px solid #ced4da;border-radius:.25rem}.custom-file-label::after{position:absolute;top:0;right:0;bottom:0;z-index:3;display:block;height:calc(1.5em + .75rem);padding:.375rem .75rem;line-height:1.5;color:#495057;content:"Browse";background-color:#e9ecef;border-left:inherit;border-radius:0 .25rem .25rem 0}.custom-range{width:100%;height:1.4rem;padding:0;background-color:transparent;-webkit-appearance:none;-moz-appearance:none;appearance:none}.custom-range:focus{outline:0}.custom-range:focus::-webkit-slider-thumb{box-shadow:0 0 0 1px #fff,0 0 0 .2rem rgba(0,123,255,.25)}.custom-range:focus::-moz-range-thumb{box-shadow:0 0 0 1px #fff,0 0 0 .2rem rgba(0,123,255,.25)}.custom-range:focus::-ms-thumb{box-shadow:0 0 0 1px #fff,0 0 0 .2rem rgba(0,123,255,.25)}.custom-range::-moz-focus-outer{border:0}.custom-range::-webkit-slider-thumb{width:1rem;height:1rem;margin-top:-.25rem;background-color:#007bff;border:0;border-radius:1rem;-webkit-transition:background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out;transition:background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out;-webkit-appearance:none;appearance:none}@media (prefers-reduced-motion:reduce){.custom-range::-webkit-slider-thumb{-webkit-transition:none;transition:none}}.custom-range::-webkit-slider-thumb:active{background-color:#b3d7ff}.custom-range::-webkit-slider-runnable-track{width:100%;height:.5rem;color:transparent;cursor:pointer;background-color:#dee2e6;border-color:transparent;border-radius:1rem}.custom-range::-moz-range-thumb{width:1rem;height:1rem;background-color:#007bff;border:0;border-radius:1rem;-moz-transition:background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out;transition:background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out;-moz-appearance:none;appearance:none}@media (prefers-reduced-motion:reduce){.custom-range::-moz-range-thumb{-moz-transition:none;transition:none}}.custom-range::-moz-range-thumb:active{background-color:#b3d7ff}.custom-range::-moz-range-track{width:100%;height:.5rem;color:transparent;cursor:pointer;background-color:#dee2e6;border-color:transparent;border-radius:1rem}.custom-range::-ms-thumb{width:1rem;height:1rem;margin-top:0;margin-right:.2rem;margin-left:.2rem;background-color:#007bff;border:0;border-radius:1rem;-ms-transition:background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out;transition:background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out;appearance:none}@media (prefers-reduced-motion:reduce){.custom-range::-ms-thumb{-ms-transition:none;transition:none}}.custom-range::-ms-thumb:active{background-color:#b3d7ff}.custom-range::-ms-track{width:100%;height:.5rem;color:transparent;cursor:pointer;background-color:transparent;border-color:transparent;border-width:.5rem}.custom-range::-ms-fill-lower{background-color:#dee2e6;border-radius:1rem}.custom-range::-ms-fill-upper{margin-right:15px;background-color:#dee2e6;border-radius:1rem}.custom-range:disabled::-webkit-slider-thumb{background-color:#adb5bd}.custom-range:disabled::-webkit-slider-runnable-track{cursor:default}.custom-range:disabled::-moz-range-thumb{background-color:#adb5bd}.custom-range:disabled::-moz-range-track{cursor:default}.custom-range:disabled::-ms-thumb{background-color:#adb5bd}.custom-control-label::before,.custom-file-label,.custom-select{transition:background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out}@media (prefers-reduced-motion:reduce){.custom-control-label::before,.custom-file-label,.custom-select{transition:none}}.nav{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;padding-left:0;margin-bottom:0;list-style:none}.nav-link{display:block;padding:.5rem 1rem}.nav-link:focus,.nav-link:hover{text-decoration:none}.nav-link.disabled{color:#6c757d;pointer-events:none;cursor:default}.nav-tabs{border-bottom:1px solid #dee2e6}.nav-tabs .nav-link{margin-bottom:-1px;border:1px solid transparent;border-top-left-radius:.25rem;border-top-right-radius:.25rem}.nav-tabs .nav-link:focus,.nav-tabs .nav-link:hover{border-color:#e9ecef #e9ecef #dee2e6}.nav-tabs .nav-link.disabled{color:#6c757d;background-color:transparent;border-color:transparent}.nav-tabs .nav-item.show .nav-link,.nav-tabs .nav-link.active{color:#495057;background-color:#fff;border-color:#dee2e6 #dee2e6 #fff}.nav-tabs .dropdown-menu{margin-top:-1px;border-top-left-radius:0;border-top-right-radius:0}.nav-pills .nav-link{border-radius:.25rem}.nav-pills .nav-link.active,.nav-pills .show>.nav-link{color:#fff;background-color:#007bff}.nav-fill .nav-item,.nav-fill>.nav-link{-ms-flex:1 1 auto;flex:1 1 auto;text-align:center}.nav-justified .nav-item,.nav-justified>.nav-link{-ms-flex-preferred-size:0;flex-basis:0;-ms-flex-positive:1;flex-grow:1;text-align:center}.tab-content>.tab-pane{display:none}.tab-content>.active{display:block}.navbar{position:relative;display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;-ms-flex-align:center;align-items:center;-ms-flex-pack:justify;justify-content:space-between;padding:.5rem 1rem}.navbar .container,.navbar .container-fluid,.navbar .container-lg,.navbar .container-md,.navbar .container-sm,.navbar .container-xl{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;-ms-flex-align:center;align-items:center;-ms-flex-pack:justify;justify-content:space-between}.navbar-brand{display:inline-block;padding-top:.3125rem;padding-bottom:.3125rem;margin-right:1rem;font-size:1.25rem;line-height:inherit;white-space:nowrap}.navbar-brand:focus,.navbar-brand:hover{text-decoration:none}.navbar-nav{display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;padding-left:0;margin-bottom:0;list-style:none}.navbar-nav .nav-link{padding-right:0;padding-left:0}.navbar-nav .dropdown-menu{position:static;float:none}.navbar-text{display:inline-block;padding-top:.5rem;padding-bottom:.5rem}.navbar-collapse{-ms-flex-preferred-size:100%;flex-basis:100%;-ms-flex-positive:1;flex-grow:1;-ms-flex-align:center;align-items:center}.navbar-toggler{padding:.25rem .75rem;font-size:1.25rem;line-height:1;background-color:transparent;border:1px solid transparent;border-radius:.25rem}.navbar-toggler:focus,.navbar-toggler:hover{text-decoration:none}.navbar-toggler-icon{display:inline-block;width:1.5em;height:1.5em;vertical-align:middle;content:"";background:50%/100% 100% no-repeat}.navbar-nav-scroll{max-height:75vh;overflow-y:auto}@media (max-width:575.98px){.navbar-expand-sm>.container,.navbar-expand-sm>.container-fluid,.navbar-expand-sm>.container-lg,.navbar-expand-sm>.container-md,.navbar-expand-sm>.container-sm,.navbar-expand-sm>.container-xl{padding-right:0;padding-left:0}}@media (min-width:576px){.navbar-expand-sm{-ms-flex-flow:row nowrap;flex-flow:row nowrap;-ms-flex-pack:start;justify-content:flex-start}.navbar-expand-sm .navbar-nav{-ms-flex-direction:row;flex-direction:row}.navbar-expand-sm .navbar-nav .dropdown-menu{position:absolute}.navbar-expand-sm .navbar-nav .nav-link{padding-right:.5rem;padding-left:.5rem}.navbar-expand-sm>.container,.navbar-expand-sm>.container-fluid,.navbar-expand-sm>.container-lg,.navbar-expand-sm>.container-md,.navbar-expand-sm>.container-sm,.navbar-expand-sm>.container-xl{-ms-flex-wrap:nowrap;flex-wrap:nowrap}.navbar-expand-sm .navbar-nav-scroll{overflow:visible}.navbar-expand-sm .navbar-collapse{display:-ms-flexbox!important;display:flex!important;-ms-flex-preferred-size:auto;flex-basis:auto}.navbar-expand-sm .navbar-toggler{display:none}}@media (max-width:767.98px){.navbar-expand-md>.container,.navbar-expand-md>.container-fluid,.navbar-expand-md>.container-lg,.navbar-expand-md>.container-md,.navbar-expand-md>.container-sm,.navbar-expand-md>.container-xl{padding-right:0;padding-left:0}}@media (min-width:768px){.navbar-expand-md{-ms-flex-flow:row nowrap;flex-flow:row nowrap;-ms-flex-pack:start;justify-content:flex-start}.navbar-expand-md .navbar-nav{-ms-flex-direction:row;flex-direction:row}.navbar-expand-md .navbar-nav .dropdown-menu{position:absolute}.navbar-expand-md .navbar-nav .nav-link{padding-right:.5rem;padding-left:.5rem}.navbar-expand-md>.container,.navbar-expand-md>.container-fluid,.navbar-expand-md>.container-lg,.navbar-expand-md>.container-md,.navbar-expand-md>.container-sm,.navbar-expand-md>.container-xl{-ms-flex-wrap:nowrap;flex-wrap:nowrap}.navbar-expand-md .navbar-nav-scroll{overflow:visible}.navbar-expand-md .navbar-collapse{display:-ms-flexbox!important;display:flex!important;-ms-flex-preferred-size:auto;flex-basis:auto}.navbar-expand-md .navbar-toggler{display:none}}@media (max-width:991.98px){.navbar-expand-lg>.container,.navbar-expand-lg>.container-fluid,.navbar-expand-lg>.container-lg,.navbar-expand-lg>.container-md,.navbar-expand-lg>.container-sm,.navbar-expand-lg>.container-xl{padding-right:0;padding-left:0}}@media (min-width:992px){.navbar-expand-lg{-ms-flex-flow:row nowrap;flex-flow:row nowrap;-ms-flex-pack:start;justify-content:flex-start}.navbar-expand-lg .navbar-nav{-ms-flex-direction:row;flex-direction:row}.navbar-expand-lg .navbar-nav .dropdown-menu{position:absolute}.navbar-expand-lg .navbar-nav .nav-link{padding-right:.5rem;padding-left:.5rem}.navbar-expand-lg>.container,.navbar-expand-lg>.container-fluid,.navbar-expand-lg>.container-lg,.navbar-expand-lg>.container-md,.navbar-expand-lg>.container-sm,.navbar-expand-lg>.container-xl{-ms-flex-wrap:nowrap;flex-wrap:nowrap}.navbar-expand-lg .navbar-nav-scroll{overflow:visible}.navbar-expand-lg .navbar-collapse{display:-ms-flexbox!important;display:flex!important;-ms-flex-preferred-size:auto;flex-basis:auto}.navbar-expand-lg .navbar-toggler{display:none}}@media (max-width:1199.98px){.navbar-expand-xl>.container,.navbar-expand-xl>.container-fluid,.navbar-expand-xl>.container-lg,.navbar-expand-xl>.container-md,.navbar-expand-xl>.container-sm,.navbar-expand-xl>.container-xl{padding-right:0;padding-left:0}}@media (min-width:1200px){.navbar-expand-xl{-ms-flex-flow:row nowrap;flex-flow:row nowrap;-ms-flex-pack:start;justify-content:flex-start}.navbar-expand-xl .navbar-nav{-ms-flex-direction:row;flex-direction:row}.navbar-expand-xl .navbar-nav .dropdown-menu{position:absolute}.navbar-expand-xl .navbar-nav .nav-link{padding-right:.5rem;padding-left:.5rem}.navbar-expand-xl>.container,.navbar-expand-xl>.container-fluid,.navbar-expand-xl>.container-lg,.navbar-expand-xl>.container-md,.navbar-expand-xl>.container-sm,.navbar-expand-xl>.container-xl{-ms-flex-wrap:nowrap;flex-wrap:nowrap}.navbar-expand-xl .navbar-nav-scroll{overflow:visible}.navbar-expand-xl .navbar-collapse{display:-ms-flexbox!important;display:flex!important;-ms-flex-preferred-size:auto;flex-basis:auto}.navbar-expand-xl .navbar-toggler{display:none}}.navbar-expand{-ms-flex-flow:row nowrap;flex-flow:row nowrap;-ms-flex-pack:start;justify-content:flex-start}.navbar-expand>.container,.navbar-expand>.container-fluid,.navbar-expand>.container-lg,.navbar-expand>.container-md,.navbar-expand>.container-sm,.navbar-expand>.container-xl{padding-right:0;padding-left:0}.navbar-expand .navbar-nav{-ms-flex-direction:row;flex-direction:row}.navbar-expand .navbar-nav .dropdown-menu{position:absolute}.navbar-expand .navbar-nav .nav-link{padding-right:.5rem;padding-left:.5rem}.navbar-expand>.container,.navbar-expand>.container-fluid,.navbar-expand>.container-lg,.navbar-expand>.container-md,.navbar-expand>.container-sm,.navbar-expand>.container-xl{-ms-flex-wrap:nowrap;flex-wrap:nowrap}.navbar-expand .navbar-nav-scroll{overflow:visible}.navbar-expand .navbar-collapse{display:-ms-flexbox!important;display:flex!important;-ms-flex-preferred-size:auto;flex-basis:auto}.navbar-expand .navbar-toggler{display:none}.navbar-light .navbar-brand{color:rgba(0,0,0,.9)}.navbar-light .navbar-brand:focus,.navbar-light .navbar-brand:hover{color:rgba(0,0,0,.9)}.navbar-light .navbar-nav .nav-link{color:rgba(0,0,0,.5)}.navbar-light .navbar-nav .nav-link:focus,.navbar-light .navbar-nav .nav-link:hover{color:rgba(0,0,0,.7)}.navbar-light .navbar-nav .nav-link.disabled{color:rgba(0,0,0,.3)}.navbar-light .navbar-nav .active>.nav-link,.navbar-light .navbar-nav .nav-link.active,.navbar-light .navbar-nav .nav-link.show,.navbar-light .navbar-nav .show>.nav-link{color:rgba(0,0,0,.9)}.navbar-light .navbar-toggler{color:rgba(0,0,0,.5);border-color:rgba(0,0,0,.1)}.navbar-light .navbar-toggler-icon{background-image:url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='30' height='30' viewBox='0 0 30 30'%3e%3cpath stroke='rgba%280, 0, 0, 0.5%29' stroke-linecap='round' stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/%3e%3c/svg%3e")}.navbar-light .navbar-text{color:rgba(0,0,0,.5)}.navbar-light .navbar-text a{color:rgba(0,0,0,.9)}.navbar-light .navbar-text a:focus,.navbar-light .navbar-text a:hover{color:rgba(0,0,0,.9)}.navbar-dark .navbar-brand{color:#fff}.navbar-dark .navbar-brand:focus,.navbar-dark .navbar-brand:hover{color:#fff}.navbar-dark .navbar-nav .nav-link{color:rgba(255,255,255,.5)}.navbar-dark .navbar-nav .nav-link:focus,.navbar-dark .navbar-nav .nav-link:hover{color:rgba(255,255,255,.75)}.navbar-dark .navbar-nav .nav-link.disabled{color:rgba(255,255,255,.25)}.navbar-dark .navbar-nav .active>.nav-link,.navbar-dark .navbar-nav .nav-link.active,.navbar-dark .navbar-nav .nav-link.show,.navbar-dark .navbar-nav .show>.nav-link{color:#fff}.navbar-dark .navbar-toggler{color:rgba(255,255,255,.5);border-color:rgba(255,255,255,.1)}.navbar-dark .navbar-toggler-icon{background-image:url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='30' height='30' viewBox='0 0 30 30'%3e%3cpath stroke='rgba%28255, 255, 255, 0.5%29' stroke-linecap='round' stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/%3e%3c/svg%3e")}.navbar-dark .navbar-text{color:rgba(255,255,255,.5)}.navbar-dark .navbar-text a{color:#fff}.navbar-dark .navbar-text a:focus,.navbar-dark .navbar-text a:hover{color:#fff}.card{position:relative;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;word-wrap:break-word;background-color:#fff;background-clip:border-box;border:1px solid rgba(0,0,0,.125);border-radius:.25rem}.card>hr{margin-right:0;margin-left:0}.card>.list-group{border-top:inherit;border-bottom:inherit}.card>.list-group:first-child{border-top-width:0;border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card>.list-group:last-child{border-bottom-width:0;border-bottom-right-radius:calc(.25rem - 1px);border-bottom-left-radius:calc(.25rem - 1px)}.card>.card-header+.list-group,.card>.list-group+.card-footer{border-top:0}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-top:-.375rem;margin-bottom:0}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{padding:.75rem 1.25rem;margin-bottom:0;background-color:rgba(0,0,0,.03);border-bottom:1px solid rgba(0,0,0,.125)}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-footer{padding:.75rem 1.25rem;background-color:rgba(0,0,0,.03);border-top:1px solid rgba(0,0,0,.125)}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{margin-right:-.625rem;margin-bottom:-.75rem;margin-left:-.625rem;border-bottom:0}.card-header-pills{margin-right:-.625rem;margin-left:-.625rem}.card-img-overlay{position:absolute;top:0;right:0;bottom:0;left:0;padding:1.25rem;border-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-right-radius:calc(.25rem - 1px);border-bottom-left-radius:calc(.25rem - 1px)}.card-deck .card{margin-bottom:15px}@media (min-width:576px){.card-deck{display:-ms-flexbox;display:flex;-ms-flex-flow:row wrap;flex-flow:row wrap;margin-right:-15px;margin-left:-15px}.card-deck .card{-ms-flex:1 0 0%;flex:1 0 0%;margin-right:15px;margin-bottom:0;margin-left:15px}}.card-group>.card{margin-bottom:15px}@media (min-width:576px){.card-group{display:-ms-flexbox;display:flex;-ms-flex-flow:row wrap;flex-flow:row wrap}.card-group>.card{-ms-flex:1 0 0%;flex:1 0 0%;margin-bottom:0}.card-group>.card+.card{margin-left:0;border-left:0}.card-group>.card:not(:last-child){border-top-right-radius:0;border-bottom-right-radius:0}.card-group>.card:not(:last-child) .card-header,.card-group>.card:not(:last-child) .card-img-top{border-top-right-radius:0}.card-group>.card:not(:last-child) .card-footer,.card-group>.card:not(:last-child) .card-img-bottom{border-bottom-right-radius:0}.card-group>.card:not(:first-child){border-top-left-radius:0;border-bottom-left-radius:0}.card-group>.card:not(:first-child) .card-header,.card-group>.card:not(:first-child) .card-img-top{border-top-left-radius:0}.card-group>.card:not(:first-child) .card-footer,.card-group>.card:not(:first-child) .card-img-bottom{border-bottom-left-radius:0}}.card-columns .card{margin-bottom:.75rem}@media (min-width:576px){.card-columns{-webkit-column-count:3;-moz-column-count:3;column-count:3;-webkit-column-gap:1.25rem;-moz-column-gap:1.25rem;column-gap:1.25rem;orphans:1;widows:1}.card-columns .card{display:inline-block;width:100%}}.accordion{overflow-anchor:none}.accordion>.card{overflow:hidden}.accordion>.card:not(:last-of-type){border-bottom:0;border-bottom-right-radius:0;border-bottom-left-radius:0}.accordion>.card:not(:first-of-type){border-top-left-radius:0;border-top-right-radius:0}.accordion>.card>.card-header{border-radius:0;margin-bottom:-1px}.breadcrumb{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;padding:.75rem 1rem;margin-bottom:1rem;list-style:none;background-color:#e9ecef;border-radius:.25rem}.breadcrumb-item+.breadcrumb-item{padding-left:.5rem}.breadcrumb-item+.breadcrumb-item::before{float:left;padding-right:.5rem;color:#6c757d;content:"/"}.breadcrumb-item+.breadcrumb-item:hover::before{text-decoration:underline}.breadcrumb-item+.breadcrumb-item:hover::before{text-decoration:none}.breadcrumb-item.active{color:#6c757d}.pagination{display:-ms-flexbox;display:flex;padding-left:0;list-style:none;border-radius:.25rem}.page-link{position:relative;display:block;padding:.5rem .75rem;margin-left:-1px;line-height:1.25;color:#007bff;background-color:#fff;border:1px solid #dee2e6}.page-link:hover{z-index:2;color:#0056b3;text-decoration:none;background-color:#e9ecef;border-color:#dee2e6}.page-link:focus{z-index:3;outline:0;box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.page-item:first-child .page-link{margin-left:0;border-top-left-radius:.25rem;border-bottom-left-radius:.25rem}.page-item:last-child .page-link{border-top-right-radius:.25rem;border-bottom-right-radius:.25rem}.page-item.active .page-link{z-index:3;color:#fff;background-color:#007bff;border-color:#007bff}.page-item.disabled .page-link{color:#6c757d;pointer-events:none;cursor:auto;background-color:#fff;border-color:#dee2e6}.pagination-lg .page-link{padding:.75rem 1.5rem;font-size:1.25rem;line-height:1.5}.pagination-lg .page-item:first-child .page-link{border-top-left-radius:.3rem;border-bottom-left-radius:.3rem}.pagination-lg .page-item:last-child .page-link{border-top-right-radius:.3rem;border-bottom-right-radius:.3rem}.pagination-sm .page-link{padding:.25rem .5rem;font-size:.875rem;line-height:1.5}.pagination-sm .page-item:first-child .page-link{border-top-left-radius:.2rem;border-bottom-left-radius:.2rem}.pagination-sm .page-item:last-child .page-link{border-top-right-radius:.2rem;border-bottom-right-radius:.2rem}.badge{display:inline-block;padding:.25em .4em;font-size:75%;font-weight:700;line-height:1;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25rem;transition:color .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out}@media (prefers-reduced-motion:reduce){.badge{transition:none}}a.badge:focus,a.badge:hover{text-decoration:none}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{padding-right:.6em;padding-left:.6em;border-radius:10rem}.badge-primary{color:#fff;background-color:#007bff}a.badge-primary:focus,a.badge-primary:hover{color:#fff;background-color:#0062cc}a.badge-primary.focus,a.badge-primary:focus{outline:0;box-shadow:0 0 0 .2rem rgba(0,123,255,.5)}.badge-secondary{color:#fff;background-color:#6c757d}a.badge-secondary:focus,a.badge-secondary:hover{color:#fff;background-color:#545b62}a.badge-secondary.focus,a.badge-secondary:focus{outline:0;box-shadow:0 0 0 .2rem rgba(108,117,125,.5)}.badge-success{color:#fff;background-color:#28a745}a.badge-success:focus,a.badge-success:hover{color:#fff;background-color:#1e7e34}a.badge-success.focus,a.badge-success:focus{outline:0;box-shadow:0 0 0 .2rem rgba(40,167,69,.5)}.badge-info{color:#fff;background-color:#17a2b8}a.badge-info:focus,a.badge-info:hover{color:#fff;background-color:#117a8b}a.badge-info.focus,a.badge-info:focus{outline:0;box-shadow:0 0 0 .2rem rgba(23,162,184,.5)}.badge-warning{color:#212529;background-color:#ffc107}a.badge-warning:focus,a.badge-warning:hover{color:#212529;background-color:#d39e00}a.badge-warning.focus,a.badge-warning:focus{outline:0;box-shadow:0 0 0 .2rem rgba(255,193,7,.5)}.badge-danger{color:#fff;background-color:#dc3545}a.badge-danger:focus,a.badge-danger:hover{color:#fff;background-color:#bd2130}a.badge-danger.focus,a.badge-danger:focus{outline:0;box-shadow:0 0 0 .2rem rgba(220,53,69,.5)}.badge-light{color:#212529;background-color:#f8f9fa}a.badge-light:focus,a.badge-light:hover{color:#212529;background-color:#dae0e5}a.badge-light.focus,a.badge-light:focus{outline:0;box-shadow:0 0 0 .2rem rgba(248,249,250,.5)}.badge-dark{color:#fff;background-color:#343a40}a.badge-dark:focus,a.badge-dark:hover{color:#fff;background-color:#1d2124}a.badge-dark.focus,a.badge-dark:focus{outline:0;box-shadow:0 0 0 .2rem rgba(52,58,64,.5)}.jumbotron{padding:2rem 1rem;margin-bottom:2rem;background-color:#e9ecef;border-radius:.3rem}@media (min-width:576px){.jumbotron{padding:4rem 2rem}}.jumbotron-fluid{padding-right:0;padding-left:0;border-radius:0}.alert{position:relative;padding:.75rem 1.25rem;margin-bottom:1rem;border:1px solid transparent;border-radius:.25rem}.alert-heading{color:inherit}.alert-link{font-weight:700}.alert-dismissible{padding-right:4rem}.alert-dismissible .close{position:absolute;top:0;right:0;z-index:2;padding:.75rem 1.25rem;color:inherit}.alert-primary{color:#004085;background-color:#cce5ff;border-color:#b8daff}.alert-primary hr{border-top-color:#9fcdff}.alert-primary .alert-link{color:#002752}.alert-secondary{color:#383d41;background-color:#e2e3e5;border-color:#d6d8db}.alert-secondary hr{border-top-color:#c8cbcf}.alert-secondary .alert-link{color:#202326}.alert-success{color:#155724;background-color:#d4edda;border-color:#c3e6cb}.alert-success hr{border-top-color:#b1dfbb}.alert-success .alert-link{color:#0b2e13}.alert-info{color:#0c5460;background-color:#d1ecf1;border-color:#bee5eb}.alert-info hr{border-top-color:#abdde5}.alert-info .alert-link{color:#062c33}.alert-warning{color:#856404;background-color:#fff3cd;border-color:#ffeeba}.alert-warning hr{border-top-color:#ffe8a1}.alert-warning .alert-link{color:#533f03}.alert-danger{color:#721c24;background-color:#f8d7da;border-color:#f5c6cb}.alert-danger hr{border-top-color:#f1b0b7}.alert-danger .alert-link{color:#491217}.alert-light{color:#818182;background-color:#fefefe;border-color:#fdfdfe}.alert-light hr{border-top-color:#ececf6}.alert-light .alert-link{color:#686868}.alert-dark{color:#1b1e21;background-color:#d6d8d9;border-color:#c6c8ca}.alert-dark hr{border-top-color:#b9bbbe}.alert-dark .alert-link{color:#040505}@-webkit-keyframes progress-bar-stripes{from{background-position:1rem 0}to{background-position:0 0}}@keyframes progress-bar-stripes{from{background-position:1rem 0}to{background-position:0 0}}.progress{display:-ms-flexbox;display:flex;height:1rem;overflow:hidden;line-height:0;font-size:.75rem;background-color:#e9ecef;border-radius:.25rem}.progress-bar{display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;-ms-flex-pack:center;justify-content:center;overflow:hidden;color:#fff;text-align:center;white-space:nowrap;background-color:#007bff;transition:width .6s ease}@media (prefers-reduced-motion:reduce){.progress-bar{transition:none}}.progress-bar-striped{background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-size:1rem 1rem}.progress-bar-animated{-webkit-animation:1s linear infinite progress-bar-stripes;animation:1s linear infinite progress-bar-stripes}@media (prefers-reduced-motion:reduce){.progress-bar-animated{-webkit-animation:none;animation:none}}.media{display:-ms-flexbox;display:flex;-ms-flex-align:start;align-items:flex-start}.media-body{-ms-flex:1;flex:1}.list-group{display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;padding-left:0;margin-bottom:0;border-radius:.25rem}.list-group-item-action{width:100%;color:#495057;text-align:inherit}.list-group-item-action:focus,.list-group-item-action:hover{z-index:1;color:#495057;text-decoration:none;background-color:#f8f9fa}.list-group-item-action:active{color:#212529;background-color:#e9ecef}.list-group-item{position:relative;display:block;padding:.75rem 1.25rem;background-color:#fff;border:1px solid rgba(0,0,0,.125)}.list-group-item:first-child{border-top-left-radius:inherit;border-top-right-radius:inherit}.list-group-item:last-child{border-bottom-right-radius:inherit;border-bottom-left-radius:inherit}.list-group-item.disabled,.list-group-item:disabled{color:#6c757d;pointer-events:none;background-color:#fff}.list-group-item.active{z-index:2;color:#fff;background-color:#007bff;border-color:#007bff}.list-group-item+.list-group-item{border-top-width:0}.list-group-item+.list-group-item.active{margin-top:-1px;border-top-width:1px}.list-group-horizontal{-ms-flex-direction:row;flex-direction:row}.list-group-horizontal>.list-group-item:first-child{border-bottom-left-radius:.25rem;border-top-right-radius:0}.list-group-horizontal>.list-group-item:last-child{border-top-right-radius:.25rem;border-bottom-left-radius:0}.list-group-horizontal>.list-group-item.active{margin-top:0}.list-group-horizontal>.list-group-item+.list-group-item{border-top-width:1px;border-left-width:0}.list-group-horizontal>.list-group-item+.list-group-item.active{margin-left:-1px;border-left-width:1px}@media (min-width:576px){.list-group-horizontal-sm{-ms-flex-direction:row;flex-direction:row}.list-group-horizontal-sm>.list-group-item:first-child{border-bottom-left-radius:.25rem;border-top-right-radius:0}.list-group-horizontal-sm>.list-group-item:last-child{border-top-right-radius:.25rem;border-bottom-left-radius:0}.list-group-horizontal-sm>.list-group-item.active{margin-top:0}.list-group-horizontal-sm>.list-group-item+.list-group-item{border-top-width:1px;border-left-width:0}.list-group-horizontal-sm>.list-group-item+.list-group-item.active{margin-left:-1px;border-left-width:1px}}@media (min-width:768px){.list-group-horizontal-md{-ms-flex-direction:row;flex-direction:row}.list-group-horizontal-md>.list-group-item:first-child{border-bottom-left-radius:.25rem;border-top-right-radius:0}.list-group-horizontal-md>.list-group-item:last-child{border-top-right-radius:.25rem;border-bottom-left-radius:0}.list-group-horizontal-md>.list-group-item.active{margin-top:0}.list-group-horizontal-md>.list-group-item+.list-group-item{border-top-width:1px;border-left-width:0}.list-group-horizontal-md>.list-group-item+.list-group-item.active{margin-left:-1px;border-left-width:1px}}@media (min-width:992px){.list-group-horizontal-lg{-ms-flex-direction:row;flex-direction:row}.list-group-horizontal-lg>.list-group-item:first-child{border-bottom-left-radius:.25rem;border-top-right-radius:0}.list-group-horizontal-lg>.list-group-item:last-child{border-top-right-radius:.25rem;border-bottom-left-radius:0}.list-group-horizontal-lg>.list-group-item.active{margin-top:0}.list-group-horizontal-lg>.list-group-item+.list-group-item{border-top-width:1px;border-left-width:0}.list-group-horizontal-lg>.list-group-item+.list-group-item.active{margin-left:-1px;border-left-width:1px}}@media (min-width:1200px){.list-group-horizontal-xl{-ms-flex-direction:row;flex-direction:row}.list-group-horizontal-xl>.list-group-item:first-child{border-bottom-left-radius:.25rem;border-top-right-radius:0}.list-group-horizontal-xl>.list-group-item:last-child{border-top-right-radius:.25rem;border-bottom-left-radius:0}.list-group-horizontal-xl>.list-group-item.active{margin-top:0}.list-group-horizontal-xl>.list-group-item+.list-group-item{border-top-width:1px;border-left-width:0}.list-group-horizontal-xl>.list-group-item+.list-group-item.active{margin-left:-1px;border-left-width:1px}}.list-group-flush{border-radius:0}.list-group-flush>.list-group-item{border-width:0 0 1px}.list-group-flush>.list-group-item:last-child{border-bottom-width:0}.list-group-item-primary{color:#004085;background-color:#b8daff}.list-group-item-primary.list-group-item-action:focus,.list-group-item-primary.list-group-item-action:hover{color:#004085;background-color:#9fcdff}.list-group-item-primary.list-group-item-action.active{color:#fff;background-color:#004085;border-color:#004085}.list-group-item-secondary{color:#383d41;background-color:#d6d8db}.list-group-item-secondary.list-group-item-action:focus,.list-group-item-secondary.list-group-item-action:hover{color:#383d41;background-color:#c8cbcf}.list-group-item-secondary.list-group-item-action.active{color:#fff;background-color:#383d41;border-color:#383d41}.list-group-item-success{color:#155724;background-color:#c3e6cb}.list-group-item-success.list-group-item-action:focus,.list-group-item-success.list-group-item-action:hover{color:#155724;background-color:#b1dfbb}.list-group-item-success.list-group-item-action.active{color:#fff;background-color:#155724;border-color:#155724}.list-group-item-info{color:#0c5460;background-color:#bee5eb}.list-group-item-info.list-group-item-action:focus,.list-group-item-info.list-group-item-action:hover{color:#0c5460;background-color:#abdde5}.list-group-item-info.list-group-item-action.active{color:#fff;background-color:#0c5460;border-color:#0c5460}.list-group-item-warning{color:#856404;background-color:#ffeeba}.list-group-item-warning.list-group-item-action:focus,.list-group-item-warning.list-group-item-action:hover{color:#856404;background-color:#ffe8a1}.list-group-item-warning.list-group-item-action.active{color:#fff;background-color:#856404;border-color:#856404}.list-group-item-danger{color:#721c24;background-color:#f5c6cb}.list-group-item-danger.list-group-item-action:focus,.list-group-item-danger.list-group-item-action:hover{color:#721c24;background-color:#f1b0b7}.list-group-item-danger.list-group-item-action.active{color:#fff;background-color:#721c24;border-color:#721c24}.list-group-item-light{color:#818182;background-color:#fdfdfe}.list-group-item-light.list-group-item-action:focus,.list-group-item-light.list-group-item-action:hover{color:#818182;background-color:#ececf6}.list-group-item-light.list-group-item-action.active{color:#fff;background-color:#818182;border-color:#818182}.list-group-item-dark{color:#1b1e21;background-color:#c6c8ca}.list-group-item-dark.list-group-item-action:focus,.list-group-item-dark.list-group-item-action:hover{color:#1b1e21;background-color:#b9bbbe}.list-group-item-dark.list-group-item-action.active{color:#fff;background-color:#1b1e21;border-color:#1b1e21}.close{float:right;font-size:1.5rem;font-weight:700;line-height:1;color:#000;text-shadow:0 1px 0 #fff;opacity:.5}.close:hover{color:#000;text-decoration:none}.close:not(:disabled):not(.disabled):focus,.close:not(:disabled):not(.disabled):hover{opacity:.75}button.close{padding:0;background-color:transparent;border:0}a.close.disabled{pointer-events:none}.toast{-ms-flex-preferred-size:350px;flex-basis:350px;max-width:350px;font-size:.875rem;background-color:rgba(255,255,255,.85);background-clip:padding-box;border:1px solid rgba(0,0,0,.1);box-shadow:0 .25rem .75rem rgba(0,0,0,.1);opacity:0;border-radius:.25rem}.toast:not(:last-child){margin-bottom:.75rem}.toast.showing{opacity:1}.toast.show{display:block;opacity:1}.toast.hide{display:none}.toast-header{display:-ms-flexbox;display:flex;-ms-flex-align:center;align-items:center;padding:.25rem .75rem;color:#6c757d;background-color:rgba(255,255,255,.85);background-clip:padding-box;border-bottom:1px solid rgba(0,0,0,.05);border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.toast-body{padding:.75rem}.modal-open{overflow:hidden}.modal-open .modal{overflow-x:hidden;overflow-y:auto}.modal{position:fixed;top:0;left:0;z-index:1050;display:none;width:100%;height:100%;overflow:hidden;outline:0}.modal-dialog{position:relative;width:auto;margin:.5rem;pointer-events:none}.modal.fade .modal-dialog{transition:-webkit-transform .3s ease-out;transition:transform .3s ease-out;transition:transform .3s ease-out,-webkit-transform .3s ease-out;-webkit-transform:translate(0,-50px);transform:translate(0,-50px)}@media (prefers-reduced-motion:reduce){.modal.fade .modal-dialog{transition:none}}.modal.show .modal-dialog{-webkit-transform:none;transform:none}.modal.modal-static .modal-dialog{-webkit-transform:scale(1.02);transform:scale(1.02)}.modal-dialog-scrollable{display:-ms-flexbox;display:flex;max-height:calc(100% - 1rem)}.modal-dialog-scrollable .modal-content{max-height:calc(100vh - 1rem);overflow:hidden}.modal-dialog-scrollable .modal-footer,.modal-dialog-scrollable .modal-header{-ms-flex-negative:0;flex-shrink:0}.modal-dialog-scrollable .modal-body{overflow-y:auto}.modal-dialog-centered{display:-ms-flexbox;display:flex;-ms-flex-align:center;align-items:center;min-height:calc(100% - 1rem)}.modal-dialog-centered::before{display:block;height:calc(100vh - 1rem);height:-webkit-min-content;height:-moz-min-content;height:min-content;content:""}.modal-dialog-centered.modal-dialog-scrollable{-ms-flex-direction:column;flex-direction:column;-ms-flex-pack:center;justify-content:center;height:100%}.modal-dialog-centered.modal-dialog-scrollable .modal-content{max-height:none}.modal-dialog-centered.modal-dialog-scrollable::before{content:none}.modal-content{position:relative;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;width:100%;pointer-events:auto;background-color:#fff;background-clip:padding-box;border:1px solid rgba(0,0,0,.2);border-radius:.3rem;outline:0}.modal-backdrop{position:fixed;top:0;left:0;z-index:1040;width:100vw;height:100vh;background-color:#000}.modal-backdrop.fade{opacity:0}.modal-backdrop.show{opacity:.5}.modal-header{display:-ms-flexbox;display:flex;-ms-flex-align:start;align-items:flex-start;-ms-flex-pack:justify;justify-content:space-between;padding:1rem 1rem;border-bottom:1px solid #dee2e6;border-top-left-radius:calc(.3rem - 1px);border-top-right-radius:calc(.3rem - 1px)}.modal-header .close{padding:1rem 1rem;margin:-1rem -1rem -1rem auto}.modal-title{margin-bottom:0;line-height:1.5}.modal-body{position:relative;-ms-flex:1 1 auto;flex:1 1 auto;padding:1rem}.modal-footer{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;-ms-flex-align:center;align-items:center;-ms-flex-pack:end;justify-content:flex-end;padding:.75rem;border-top:1px solid #dee2e6;border-bottom-right-radius:calc(.3rem - 1px);border-bottom-left-radius:calc(.3rem - 1px)}.modal-footer>*{margin:.25rem}.modal-scrollbar-measure{position:absolute;top:-9999px;width:50px;height:50px;overflow:scroll}@media (min-width:576px){.modal-dialog{max-width:500px;margin:1.75rem auto}.modal-dialog-scrollable{max-height:calc(100% - 3.5rem)}.modal-dialog-scrollable .modal-content{max-height:calc(100vh - 3.5rem)}.modal-dialog-centered{min-height:calc(100% - 3.5rem)}.modal-dialog-centered::before{height:calc(100vh - 3.5rem);height:-webkit-min-content;height:-moz-min-content;height:min-content}.modal-sm{max-width:300px}}@media (min-width:992px){.modal-lg,.modal-xl{max-width:800px}}@media (min-width:1200px){.modal-xl{max-width:1140px}}.tooltip{position:absolute;z-index:1070;display:block;margin:0;font-family:-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-style:normal;font-weight:400;line-height:1.5;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;letter-spacing:normal;word-break:normal;word-spacing:normal;white-space:normal;line-break:auto;font-size:.875rem;word-wrap:break-word;opacity:0}.tooltip.show{opacity:.9}.tooltip .arrow{position:absolute;display:block;width:.8rem;height:.4rem}.tooltip .arrow::before{position:absolute;content:"";border-color:transparent;border-style:solid}.bs-tooltip-auto[x-placement^=top],.bs-tooltip-top{padding:.4rem 0}.bs-tooltip-auto[x-placement^=top] .arrow,.bs-tooltip-top .arrow{bottom:0}.bs-tooltip-auto[x-placement^=top] .arrow::before,.bs-tooltip-top .arrow::before{top:0;border-width:.4rem .4rem 0;border-top-color:#000}.bs-tooltip-auto[x-placement^=right],.bs-tooltip-right{padding:0 .4rem}.bs-tooltip-auto[x-placement^=right] .arrow,.bs-tooltip-right .arrow{left:0;width:.4rem;height:.8rem}.bs-tooltip-auto[x-placement^=right] .arrow::before,.bs-tooltip-right .arrow::before{right:0;border-width:.4rem .4rem .4rem 0;border-right-color:#000}.bs-tooltip-auto[x-placement^=bottom],.bs-tooltip-bottom{padding:.4rem 0}.bs-tooltip-auto[x-placement^=bottom] .arrow,.bs-tooltip-bottom .arrow{top:0}.bs-tooltip-auto[x-placement^=bottom] .arrow::before,.bs-tooltip-bottom .arrow::before{bottom:0;border-width:0 .4rem .4rem;border-bottom-color:#000}.bs-tooltip-auto[x-placement^=left],.bs-tooltip-left{padding:0 .4rem}.bs-tooltip-auto[x-placement^=left] .arrow,.bs-tooltip-left .arrow{right:0;width:.4rem;height:.8rem}.bs-tooltip-auto[x-placement^=left] .arrow::before,.bs-tooltip-left .arrow::before{left:0;border-width:.4rem 0 .4rem .4rem;border-left-color:#000}.tooltip-inner{max-width:200px;padding:.25rem .5rem;color:#fff;text-align:center;background-color:#000;border-radius:.25rem}.popover{position:absolute;top:0;left:0;z-index:1060;display:block;max-width:276px;font-family:-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-style:normal;font-weight:400;line-height:1.5;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;letter-spacing:normal;word-break:normal;word-spacing:normal;white-space:normal;line-break:auto;font-size:.875rem;word-wrap:break-word;background-color:#fff;background-clip:padding-box;border:1px solid rgba(0,0,0,.2);border-radius:.3rem}.popover .arrow{position:absolute;display:block;width:1rem;height:.5rem;margin:0 .3rem}.popover .arrow::after,.popover .arrow::before{position:absolute;display:block;content:"";border-color:transparent;border-style:solid}.bs-popover-auto[x-placement^=top],.bs-popover-top{margin-bottom:.5rem}.bs-popover-auto[x-placement^=top]>.arrow,.bs-popover-top>.arrow{bottom:calc(-.5rem - 1px)}.bs-popover-auto[x-placement^=top]>.arrow::before,.bs-popover-top>.arrow::before{bottom:0;border-width:.5rem .5rem 0;border-top-color:rgba(0,0,0,.25)}.bs-popover-auto[x-placement^=top]>.arrow::after,.bs-popover-top>.arrow::after{bottom:1px;border-width:.5rem .5rem 0;border-top-color:#fff}.bs-popover-auto[x-placement^=right],.bs-popover-right{margin-left:.5rem}.bs-popover-auto[x-placement^=right]>.arrow,.bs-popover-right>.arrow{left:calc(-.5rem - 1px);width:.5rem;height:1rem;margin:.3rem 0}.bs-popover-auto[x-placement^=right]>.arrow::before,.bs-popover-right>.arrow::before{left:0;border-width:.5rem .5rem .5rem 0;border-right-color:rgba(0,0,0,.25)}.bs-popover-auto[x-placement^=right]>.arrow::after,.bs-popover-right>.arrow::after{left:1px;border-width:.5rem .5rem .5rem 0;border-right-color:#fff}.bs-popover-auto[x-placement^=bottom],.bs-popover-bottom{margin-top:.5rem}.bs-popover-auto[x-placement^=bottom]>.arrow,.bs-popover-bottom>.arrow{top:calc(-.5rem - 1px)}.bs-popover-auto[x-placement^=bottom]>.arrow::before,.bs-popover-bottom>.arrow::before{top:0;border-width:0 .5rem .5rem .5rem;border-bottom-color:rgba(0,0,0,.25)}.bs-popover-auto[x-placement^=bottom]>.arrow::after,.bs-popover-bottom>.arrow::after{top:1px;border-width:0 .5rem .5rem .5rem;border-bottom-color:#fff}.bs-popover-auto[x-placement^=bottom] .popover-header::before,.bs-popover-bottom .popover-header::before{position:absolute;top:0;left:50%;display:block;width:1rem;margin-left:-.5rem;content:"";border-bottom:1px solid #f7f7f7}.bs-popover-auto[x-placement^=left],.bs-popover-left{margin-right:.5rem}.bs-popover-auto[x-placement^=left]>.arrow,.bs-popover-left>.arrow{right:calc(-.5rem - 1px);width:.5rem;height:1rem;margin:.3rem 0}.bs-popover-auto[x-placement^=left]>.arrow::before,.bs-popover-left>.arrow::before{right:0;border-width:.5rem 0 .5rem .5rem;border-left-color:rgba(0,0,0,.25)}.bs-popover-auto[x-placement^=left]>.arrow::after,.bs-popover-left>.arrow::after{right:1px;border-width:.5rem 0 .5rem .5rem;border-left-color:#fff}.popover-header{padding:.5rem .75rem;margin-bottom:0;font-size:1rem;background-color:#f7f7f7;border-bottom:1px solid #ebebeb;border-top-left-radius:calc(.3rem - 1px);border-top-right-radius:calc(.3rem - 1px)}.popover-header:empty{display:none}.popover-body{padding:.5rem .75rem;color:#212529}.carousel{position:relative}.carousel.pointer-event{-ms-touch-action:pan-y;touch-action:pan-y}.carousel-inner{position:relative;width:100%;overflow:hidden}.carousel-inner::after{display:block;clear:both;content:""}.carousel-item{position:relative;display:none;float:left;width:100%;margin-right:-100%;-webkit-backface-visibility:hidden;backface-visibility:hidden;transition:-webkit-transform .6s ease-in-out;transition:transform .6s ease-in-out;transition:transform .6s ease-in-out,-webkit-transform .6s ease-in-out}@media (prefers-reduced-motion:reduce){.carousel-item{transition:none}}.carousel-item-next,.carousel-item-prev,.carousel-item.active{display:block}.active.carousel-item-right,.carousel-item-next:not(.carousel-item-left){-webkit-transform:translateX(100%);transform:translateX(100%)}.active.carousel-item-left,.carousel-item-prev:not(.carousel-item-right){-webkit-transform:translateX(-100%);transform:translateX(-100%)}.carousel-fade .carousel-item{opacity:0;transition-property:opacity;-webkit-transform:none;transform:none}.carousel-fade .carousel-item-next.carousel-item-left,.carousel-fade .carousel-item-prev.carousel-item-right,.carousel-fade .carousel-item.active{z-index:1;opacity:1}.carousel-fade .active.carousel-item-left,.carousel-fade .active.carousel-item-right{z-index:0;opacity:0;transition:opacity 0s .6s}@media (prefers-reduced-motion:reduce){.carousel-fade .active.carousel-item-left,.carousel-fade .active.carousel-item-right{transition:none}}.carousel-control-next,.carousel-control-prev{position:absolute;top:0;bottom:0;z-index:1;display:-ms-flexbox;display:flex;-ms-flex-align:center;align-items:center;-ms-flex-pack:center;justify-content:center;width:15%;padding:0;color:#fff;text-align:center;background:0 0;border:0;opacity:.5;transition:opacity .15s ease}@media (prefers-reduced-motion:reduce){.carousel-control-next,.carousel-control-prev{transition:none}}.carousel-control-next:focus,.carousel-control-next:hover,.carousel-control-prev:focus,.carousel-control-prev:hover{color:#fff;text-decoration:none;outline:0;opacity:.9}.carousel-control-prev{left:0}.carousel-control-next{right:0}.carousel-control-next-icon,.carousel-control-prev-icon{display:inline-block;width:20px;height:20px;background:50%/100% 100% no-repeat}.carousel-control-prev-icon{background-image:url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='%23fff' width='8' height='8' viewBox='0 0 8 8'%3e%3cpath d='M5.25 0l-4 4 4 4 1.5-1.5L4.25 4l2.5-2.5L5.25 0z'/%3e%3c/svg%3e")}.carousel-control-next-icon{background-image:url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='%23fff' width='8' height='8' viewBox='0 0 8 8'%3e%3cpath d='M2.75 0l-1.5 1.5L3.75 4l-2.5 2.5L2.75 8l4-4-4-4z'/%3e%3c/svg%3e")}.carousel-indicators{position:absolute;right:0;bottom:0;left:0;z-index:15;display:-ms-flexbox;display:flex;-ms-flex-pack:center;justify-content:center;padding-left:0;margin-right:15%;margin-left:15%;list-style:none}.carousel-indicators li{box-sizing:content-box;-ms-flex:0 1 auto;flex:0 1 auto;width:30px;height:3px;margin-right:3px;margin-left:3px;text-indent:-999px;cursor:pointer;background-color:#fff;background-clip:padding-box;border-top:10px solid transparent;border-bottom:10px solid transparent;opacity:.5;transition:opacity .6s ease}@media (prefers-reduced-motion:reduce){.carousel-indicators li{transition:none}}.carousel-indicators .active{opacity:1}.carousel-caption{position:absolute;right:15%;bottom:20px;left:15%;z-index:10;padding-top:20px;padding-bottom:20px;color:#fff;text-align:center}@-webkit-keyframes spinner-border{to{-webkit-transform:rotate(360deg);transform:rotate(360deg)}}@keyframes spinner-border{to{-webkit-transform:rotate(360deg);transform:rotate(360deg)}}.spinner-border{display:inline-block;width:2rem;height:2rem;vertical-align:-.125em;border:.25em solid currentColor;border-right-color:transparent;border-radius:50%;-webkit-animation:.75s linear infinite spinner-border;animation:.75s linear infinite spinner-border}.spinner-border-sm{width:1rem;height:1rem;border-width:.2em}@-webkit-keyframes spinner-grow{0%{-webkit-transform:scale(0);transform:scale(0)}50%{opacity:1;-webkit-transform:none;transform:none}}@keyframes spinner-grow{0%{-webkit-transform:scale(0);transform:scale(0)}50%{opacity:1;-webkit-transform:none;transform:none}}.spinner-grow{display:inline-block;width:2rem;height:2rem;vertical-align:-.125em;background-color:currentColor;border-radius:50%;opacity:0;-webkit-animation:.75s linear infinite spinner-grow;animation:.75s linear infinite spinner-grow}.spinner-grow-sm{width:1rem;height:1rem}@media (prefers-reduced-motion:reduce){.spinner-border,.spinner-grow{-webkit-animation-duration:1.5s;animation-duration:1.5s}}.align-baseline{vertical-align:baseline!important}.align-top{vertical-align:top!important}.align-middle{vertical-align:middle!important}.align-bottom{vertical-align:bottom!important}.align-text-bottom{vertical-align:text-bottom!important}.align-text-top{vertical-align:text-top!important}.bg-primary{background-color:#007bff!important}a.bg-primary:focus,a.bg-primary:hover,button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc!important}.bg-secondary{background-color:#6c757d!important}a.bg-secondary:focus,a.bg-secondary:hover,button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62!important}.bg-success{background-color:#28a745!important}a.bg-success:focus,a.bg-success:hover,button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34!important}.bg-info{background-color:#17a2b8!important}a.bg-info:focus,a.bg-info:hover,button.bg-info:focus,button.bg-info:hover{background-color:#117a8b!important}.bg-warning{background-color:#ffc107!important}a.bg-warning:focus,a.bg-warning:hover,button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00!important}.bg-danger{background-color:#dc3545!important}a.bg-danger:focus,a.bg-danger:hover,button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130!important}.bg-light{background-color:#f8f9fa!important}a.bg-light:focus,a.bg-light:hover,button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5!important}.bg-dark{background-color:#343a40!important}a.bg-dark:focus,a.bg-dark:hover,button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124!important}.bg-white{background-color:#fff!important}.bg-transparent{background-color:transparent!important}.border{border:1px solid #dee2e6!important}.border-top{border-top:1px solid #dee2e6!important}.border-right{border-right:1px solid #dee2e6!important}.border-bottom{border-bottom:1px solid #dee2e6!important}.border-left{border-left:1px solid #dee2e6!important}.border-0{border:0!important}.border-top-0{border-top:0!important}.border-right-0{border-right:0!important}.border-bottom-0{border-bottom:0!important}.border-left-0{border-left:0!important}.border-primary{border-color:#007bff!important}.border-secondary{border-color:#6c757d!important}.border-success{border-color:#28a745!important}.border-info{border-color:#17a2b8!important}.border-warning{border-color:#ffc107!important}.border-danger{border-color:#dc3545!important}.border-light{border-color:#f8f9fa!important}.border-dark{border-color:#343a40!important}.border-white{border-color:#fff!important}.rounded-sm{border-radius:.2rem!important}.rounded{border-radius:.25rem!important}.rounded-top{border-top-left-radius:.25rem!important;border-top-right-radius:.25rem!important}.rounded-right{border-top-right-radius:.25rem!important;border-bottom-right-radius:.25rem!important}.rounded-bottom{border-bottom-right-radius:.25rem!important;border-bottom-left-radius:.25rem!important}.rounded-left{border-top-left-radius:.25rem!important;border-bottom-left-radius:.25rem!important}.rounded-lg{border-radius:.3rem!important}.rounded-circle{border-radius:50%!important}.rounded-pill{border-radius:50rem!important}.rounded-0{border-radius:0!important}.clearfix::after{display:block;clear:both;content:""}.d-none{display:none!important}.d-inline{display:inline!important}.d-inline-block{display:inline-block!important}.d-block{display:block!important}.d-table{display:table!important}.d-table-row{display:table-row!important}.d-table-cell{display:table-cell!important}.d-flex{display:-ms-flexbox!important;display:flex!important}.d-inline-flex{display:-ms-inline-flexbox!important;display:inline-flex!important}@media (min-width:576px){.d-sm-none{display:none!important}.d-sm-inline{display:inline!important}.d-sm-inline-block{display:inline-block!important}.d-sm-block{display:block!important}.d-sm-table{display:table!important}.d-sm-table-row{display:table-row!important}.d-sm-table-cell{display:table-cell!important}.d-sm-flex{display:-ms-flexbox!important;display:flex!important}.d-sm-inline-flex{display:-ms-inline-flexbox!important;display:inline-flex!important}}@media (min-width:768px){.d-md-none{display:none!important}.d-md-inline{display:inline!important}.d-md-inline-block{display:inline-block!important}.d-md-block{display:block!important}.d-md-table{display:table!important}.d-md-table-row{display:table-row!important}.d-md-table-cell{display:table-cell!important}.d-md-flex{display:-ms-flexbox!important;display:flex!important}.d-md-inline-flex{display:-ms-inline-flexbox!important;display:inline-flex!important}}@media (min-width:992px){.d-lg-none{display:none!important}.d-lg-inline{display:inline!important}.d-lg-inline-block{display:inline-block!important}.d-lg-block{display:block!important}.d-lg-table{display:table!important}.d-lg-table-row{display:table-row!important}.d-lg-table-cell{display:table-cell!important}.d-lg-flex{display:-ms-flexbox!important;display:flex!important}.d-lg-inline-flex{display:-ms-inline-flexbox!important;display:inline-flex!important}}@media (min-width:1200px){.d-xl-none{display:none!important}.d-xl-inline{display:inline!important}.d-xl-inline-block{display:inline-block!important}.d-xl-block{display:block!important}.d-xl-table{display:table!important}.d-xl-table-row{display:table-row!important}.d-xl-table-cell{display:table-cell!important}.d-xl-flex{display:-ms-flexbox!important;display:flex!important}.d-xl-inline-flex{display:-ms-inline-flexbox!important;display:inline-flex!important}}@media print{.d-print-none{display:none!important}.d-print-inline{display:inline!important}.d-print-inline-block{display:inline-block!important}.d-print-block{display:block!important}.d-print-table{display:table!important}.d-print-table-row{display:table-row!important}.d-print-table-cell{display:table-cell!important}.d-print-flex{display:-ms-flexbox!important;display:flex!important}.d-print-inline-flex{display:-ms-inline-flexbox!important;display:inline-flex!important}}.embed-responsive{position:relative;display:block;width:100%;padding:0;overflow:hidden}.embed-responsive::before{display:block;content:""}.embed-responsive .embed-responsive-item,.embed-responsive embed,.embed-responsive iframe,.embed-responsive object,.embed-responsive video{position:absolute;top:0;bottom:0;left:0;width:100%;height:100%;border:0}.embed-responsive-21by9::before{padding-top:42.857143%}.embed-responsive-16by9::before{padding-top:56.25%}.embed-responsive-4by3::before{padding-top:75%}.embed-responsive-1by1::before{padding-top:100%}.flex-row{-ms-flex-direction:row!important;flex-direction:row!important}.flex-column{-ms-flex-direction:column!important;flex-direction:column!important}.flex-row-reverse{-ms-flex-direction:row-reverse!important;flex-direction:row-reverse!important}.flex-column-reverse{-ms-flex-direction:column-reverse!important;flex-direction:column-reverse!important}.flex-wrap{-ms-flex-wrap:wrap!important;flex-wrap:wrap!important}.flex-nowrap{-ms-flex-wrap:nowrap!important;flex-wrap:nowrap!important}.flex-wrap-reverse{-ms-flex-wrap:wrap-reverse!important;flex-wrap:wrap-reverse!important}.flex-fill{-ms-flex:1 1 auto!important;flex:1 1 auto!important}.flex-grow-0{-ms-flex-positive:0!important;flex-grow:0!important}.flex-grow-1{-ms-flex-positive:1!important;flex-grow:1!important}.flex-shrink-0{-ms-flex-negative:0!important;flex-shrink:0!important}.flex-shrink-1{-ms-flex-negative:1!important;flex-shrink:1!important}.justify-content-start{-ms-flex-pack:start!important;justify-content:flex-start!important}.justify-content-end{-ms-flex-pack:end!important;justify-content:flex-end!important}.justify-content-center{-ms-flex-pack:center!important;justify-content:center!important}.justify-content-between{-ms-flex-pack:justify!important;justify-content:space-between!important}.justify-content-around{-ms-flex-pack:distribute!important;justify-content:space-around!important}.align-items-start{-ms-flex-align:start!important;align-items:flex-start!important}.align-items-end{-ms-flex-align:end!important;align-items:flex-end!important}.align-items-center{-ms-flex-align:center!important;align-items:center!important}.align-items-baseline{-ms-flex-align:baseline!important;align-items:baseline!important}.align-items-stretch{-ms-flex-align:stretch!important;align-items:stretch!important}.align-content-start{-ms-flex-line-pack:start!important;align-content:flex-start!important}.align-content-end{-ms-flex-line-pack:end!important;align-content:flex-end!important}.align-content-center{-ms-flex-line-pack:center!important;align-content:center!important}.align-content-between{-ms-flex-line-pack:justify!important;align-content:space-between!important}.align-content-around{-ms-flex-line-pack:distribute!important;align-content:space-around!important}.align-content-stretch{-ms-flex-line-pack:stretch!important;align-content:stretch!important}.align-self-auto{-ms-flex-item-align:auto!important;align-self:auto!important}.align-self-start{-ms-flex-item-align:start!important;align-self:flex-start!important}.align-self-end{-ms-flex-item-align:end!important;align-self:flex-end!important}.align-self-center{-ms-flex-item-align:center!important;align-self:center!important}.align-self-baseline{-ms-flex-item-align:baseline!important;align-self:baseline!important}.align-self-stretch{-ms-flex-item-align:stretch!important;align-self:stretch!important}@media (min-width:576px){.flex-sm-row{-ms-flex-direction:row!important;flex-direction:row!important}.flex-sm-column{-ms-flex-direction:column!important;flex-direction:column!important}.flex-sm-row-reverse{-ms-flex-direction:row-reverse!important;flex-direction:row-reverse!important}.flex-sm-column-reverse{-ms-flex-direction:column-reverse!important;flex-direction:column-reverse!important}.flex-sm-wrap{-ms-flex-wrap:wrap!important;flex-wrap:wrap!important}.flex-sm-nowrap{-ms-flex-wrap:nowrap!important;flex-wrap:nowrap!important}.flex-sm-wrap-reverse{-ms-flex-wrap:wrap-reverse!important;flex-wrap:wrap-reverse!important}.flex-sm-fill{-ms-flex:1 1 auto!important;flex:1 1 auto!important}.flex-sm-grow-0{-ms-flex-positive:0!important;flex-grow:0!important}.flex-sm-grow-1{-ms-flex-positive:1!important;flex-grow:1!important}.flex-sm-shrink-0{-ms-flex-negative:0!important;flex-shrink:0!important}.flex-sm-shrink-1{-ms-flex-negative:1!important;flex-shrink:1!important}.justify-content-sm-start{-ms-flex-pack:start!important;justify-content:flex-start!important}.justify-content-sm-end{-ms-flex-pack:end!important;justify-content:flex-end!important}.justify-content-sm-center{-ms-flex-pack:center!important;justify-content:center!important}.justify-content-sm-between{-ms-flex-pack:justify!important;justify-content:space-between!important}.justify-content-sm-around{-ms-flex-pack:distribute!important;justify-content:space-around!important}.align-items-sm-start{-ms-flex-align:start!important;align-items:flex-start!important}.align-items-sm-end{-ms-flex-align:end!important;align-items:flex-end!important}.align-items-sm-center{-ms-flex-align:center!important;align-items:center!important}.align-items-sm-baseline{-ms-flex-align:baseline!important;align-items:baseline!important}.align-items-sm-stretch{-ms-flex-align:stretch!important;align-items:stretch!important}.align-content-sm-start{-ms-flex-line-pack:start!important;align-content:flex-start!important}.align-content-sm-end{-ms-flex-line-pack:end!important;align-content:flex-end!important}.align-content-sm-center{-ms-flex-line-pack:center!important;align-content:center!important}.align-content-sm-between{-ms-flex-line-pack:justify!important;align-content:space-between!important}.align-content-sm-around{-ms-flex-line-pack:distribute!important;align-content:space-around!important}.align-content-sm-stretch{-ms-flex-line-pack:stretch!important;align-content:stretch!important}.align-self-sm-auto{-ms-flex-item-align:auto!important;align-self:auto!important}.align-self-sm-start{-ms-flex-item-align:start!important;align-self:flex-start!important}.align-self-sm-end{-ms-flex-item-align:end!important;align-self:flex-end!important}.align-self-sm-center{-ms-flex-item-align:center!important;align-self:center!important}.align-self-sm-baseline{-ms-flex-item-align:baseline!important;align-self:baseline!important}.align-self-sm-stretch{-ms-flex-item-align:stretch!important;align-self:stretch!important}}@media (min-width:768px){.flex-md-row{-ms-flex-direction:row!important;flex-direction:row!important}.flex-md-column{-ms-flex-direction:column!important;flex-direction:column!important}.flex-md-row-reverse{-ms-flex-direction:row-reverse!important;flex-direction:row-reverse!important}.flex-md-column-reverse{-ms-flex-direction:column-reverse!important;flex-direction:column-reverse!important}.flex-md-wrap{-ms-flex-wrap:wrap!important;flex-wrap:wrap!important}.flex-md-nowrap{-ms-flex-wrap:nowrap!important;flex-wrap:nowrap!important}.flex-md-wrap-reverse{-ms-flex-wrap:wrap-reverse!important;flex-wrap:wrap-reverse!important}.flex-md-fill{-ms-flex:1 1 auto!important;flex:1 1 auto!important}.flex-md-grow-0{-ms-flex-positive:0!important;flex-grow:0!important}.flex-md-grow-1{-ms-flex-positive:1!important;flex-grow:1!important}.flex-md-shrink-0{-ms-flex-negative:0!important;flex-shrink:0!important}.flex-md-shrink-1{-ms-flex-negative:1!important;flex-shrink:1!important}.justify-content-md-start{-ms-flex-pack:start!important;justify-content:flex-start!important}.justify-content-md-end{-ms-flex-pack:end!important;justify-content:flex-end!important}.justify-content-md-center{-ms-flex-pack:center!important;justify-content:center!important}.justify-content-md-between{-ms-flex-pack:justify!important;justify-content:space-between!important}.justify-content-md-around{-ms-flex-pack:distribute!important;justify-content:space-around!important}.align-items-md-start{-ms-flex-align:start!important;align-items:flex-start!important}.align-items-md-end{-ms-flex-align:end!important;align-items:flex-end!important}.align-items-md-center{-ms-flex-align:center!important;align-items:center!important}.align-items-md-baseline{-ms-flex-align:baseline!important;align-items:baseline!important}.align-items-md-stretch{-ms-flex-align:stretch!important;align-items:stretch!important}.align-content-md-start{-ms-flex-line-pack:start!important;align-content:flex-start!important}.align-content-md-end{-ms-flex-line-pack:end!important;align-content:flex-end!important}.align-content-md-center{-ms-flex-line-pack:center!important;align-content:center!important}.align-content-md-between{-ms-flex-line-pack:justify!important;align-content:space-between!important}.align-content-md-around{-ms-flex-line-pack:distribute!important;align-content:space-around!important}.align-content-md-stretch{-ms-flex-line-pack:stretch!important;align-content:stretch!important}.align-self-md-auto{-ms-flex-item-align:auto!important;align-self:auto!important}.align-self-md-start{-ms-flex-item-align:start!important;align-self:flex-start!important}.align-self-md-end{-ms-flex-item-align:end!important;align-self:flex-end!important}.align-self-md-center{-ms-flex-item-align:center!important;align-self:center!important}.align-self-md-baseline{-ms-flex-item-align:baseline!important;align-self:baseline!important}.align-self-md-stretch{-ms-flex-item-align:stretch!important;align-self:stretch!important}}@media (min-width:992px){.flex-lg-row{-ms-flex-direction:row!important;flex-direction:row!important}.flex-lg-column{-ms-flex-direction:column!important;flex-direction:column!important}.flex-lg-row-reverse{-ms-flex-direction:row-reverse!important;flex-direction:row-reverse!important}.flex-lg-column-reverse{-ms-flex-direction:column-reverse!important;flex-direction:column-reverse!important}.flex-lg-wrap{-ms-flex-wrap:wrap!important;flex-wrap:wrap!important}.flex-lg-nowrap{-ms-flex-wrap:nowrap!important;flex-wrap:nowrap!important}.flex-lg-wrap-reverse{-ms-flex-wrap:wrap-reverse!important;flex-wrap:wrap-reverse!important}.flex-lg-fill{-ms-flex:1 1 auto!important;flex:1 1 auto!important}.flex-lg-grow-0{-ms-flex-positive:0!important;flex-grow:0!important}.flex-lg-grow-1{-ms-flex-positive:1!important;flex-grow:1!important}.flex-lg-shrink-0{-ms-flex-negative:0!important;flex-shrink:0!important}.flex-lg-shrink-1{-ms-flex-negative:1!important;flex-shrink:1!important}.justify-content-lg-start{-ms-flex-pack:start!important;justify-content:flex-start!important}.justify-content-lg-end{-ms-flex-pack:end!important;justify-content:flex-end!important}.justify-content-lg-center{-ms-flex-pack:center!important;justify-content:center!important}.justify-content-lg-between{-ms-flex-pack:justify!important;justify-content:space-between!important}.justify-content-lg-around{-ms-flex-pack:distribute!important;justify-content:space-around!important}.align-items-lg-start{-ms-flex-align:start!important;align-items:flex-start!important}.align-items-lg-end{-ms-flex-align:end!important;align-items:flex-end!important}.align-items-lg-center{-ms-flex-align:center!important;align-items:center!important}.align-items-lg-baseline{-ms-flex-align:baseline!important;align-items:baseline!important}.align-items-lg-stretch{-ms-flex-align:stretch!important;align-items:stretch!important}.align-content-lg-start{-ms-flex-line-pack:start!important;align-content:flex-start!important}.align-content-lg-end{-ms-flex-line-pack:end!important;align-content:flex-end!important}.align-content-lg-center{-ms-flex-line-pack:center!important;align-content:center!important}.align-content-lg-between{-ms-flex-line-pack:justify!important;align-content:space-between!important}.align-content-lg-around{-ms-flex-line-pack:distribute!important;align-content:space-around!important}.align-content-lg-stretch{-ms-flex-line-pack:stretch!important;align-content:stretch!important}.align-self-lg-auto{-ms-flex-item-align:auto!important;align-self:auto!important}.align-self-lg-start{-ms-flex-item-align:start!important;align-self:flex-start!important}.align-self-lg-end{-ms-flex-item-align:end!important;align-self:flex-end!important}.align-self-lg-center{-ms-flex-item-align:center!important;align-self:center!important}.align-self-lg-baseline{-ms-flex-item-align:baseline!important;align-self:baseline!important}.align-self-lg-stretch{-ms-flex-item-align:stretch!important;align-self:stretch!important}}@media (min-width:1200px){.flex-xl-row{-ms-flex-direction:row!important;flex-direction:row!important}.flex-xl-column{-ms-flex-direction:column!important;flex-direction:column!important}.flex-xl-row-reverse{-ms-flex-direction:row-reverse!important;flex-direction:row-reverse!important}.flex-xl-column-reverse{-ms-flex-direction:column-reverse!important;flex-direction:column-reverse!important}.flex-xl-wrap{-ms-flex-wrap:wrap!important;flex-wrap:wrap!important}.flex-xl-nowrap{-ms-flex-wrap:nowrap!important;flex-wrap:nowrap!important}.flex-xl-wrap-reverse{-ms-flex-wrap:wrap-reverse!important;flex-wrap:wrap-reverse!important}.flex-xl-fill{-ms-flex:1 1 auto!important;flex:1 1 auto!important}.flex-xl-grow-0{-ms-flex-positive:0!important;flex-grow:0!important}.flex-xl-grow-1{-ms-flex-positive:1!important;flex-grow:1!important}.flex-xl-shrink-0{-ms-flex-negative:0!important;flex-shrink:0!important}.flex-xl-shrink-1{-ms-flex-negative:1!important;flex-shrink:1!important}.justify-content-xl-start{-ms-flex-pack:start!important;justify-content:flex-start!important}.justify-content-xl-end{-ms-flex-pack:end!important;justify-content:flex-end!important}.justify-content-xl-center{-ms-flex-pack:center!important;justify-content:center!important}.justify-content-xl-between{-ms-flex-pack:justify!important;justify-content:space-between!important}.justify-content-xl-around{-ms-flex-pack:distribute!important;justify-content:space-around!important}.align-items-xl-start{-ms-flex-align:start!important;align-items:flex-start!important}.align-items-xl-end{-ms-flex-align:end!important;align-items:flex-end!important}.align-items-xl-center{-ms-flex-align:center!important;align-items:center!important}.align-items-xl-baseline{-ms-flex-align:baseline!important;align-items:baseline!important}.align-items-xl-stretch{-ms-flex-align:stretch!important;align-items:stretch!important}.align-content-xl-start{-ms-flex-line-pack:start!important;align-content:flex-start!important}.align-content-xl-end{-ms-flex-line-pack:end!important;align-content:flex-end!important}.align-content-xl-center{-ms-flex-line-pack:center!important;align-content:center!important}.align-content-xl-between{-ms-flex-line-pack:justify!important;align-content:space-between!important}.align-content-xl-around{-ms-flex-line-pack:distribute!important;align-content:space-around!important}.align-content-xl-stretch{-ms-flex-line-pack:stretch!important;align-content:stretch!important}.align-self-xl-auto{-ms-flex-item-align:auto!important;align-self:auto!important}.align-self-xl-start{-ms-flex-item-align:start!important;align-self:flex-start!important}.align-self-xl-end{-ms-flex-item-align:end!important;align-self:flex-end!important}.align-self-xl-center{-ms-flex-item-align:center!important;align-self:center!important}.align-self-xl-baseline{-ms-flex-item-align:baseline!important;align-self:baseline!important}.align-self-xl-stretch{-ms-flex-item-align:stretch!important;align-self:stretch!important}}.float-left{float:left!important}.float-right{float:right!important}.float-none{float:none!important}@media (min-width:576px){.float-sm-left{float:left!important}.float-sm-right{float:right!important}.float-sm-none{float:none!important}}@media (min-width:768px){.float-md-left{float:left!important}.float-md-right{float:right!important}.float-md-none{float:none!important}}@media (min-width:992px){.float-lg-left{float:left!important}.float-lg-right{float:right!important}.float-lg-none{float:none!important}}@media (min-width:1200px){.float-xl-left{float:left!important}.float-xl-right{float:right!important}.float-xl-none{float:none!important}}.user-select-all{-webkit-user-select:all!important;-moz-user-select:all!important;user-select:all!important}.user-select-auto{-webkit-user-select:auto!important;-moz-user-select:auto!important;-ms-user-select:auto!important;user-select:auto!important}.user-select-none{-webkit-user-select:none!important;-moz-user-select:none!important;-ms-user-select:none!important;user-select:none!important}.overflow-auto{overflow:auto!important}.overflow-hidden{overflow:hidden!important}.position-static{position:static!important}.position-relative{position:relative!important}.position-absolute{position:absolute!important}.position-fixed{position:fixed!important}.position-sticky{position:-webkit-sticky!important;position:sticky!important}.fixed-top{position:fixed;top:0;right:0;left:0;z-index:1030}.fixed-bottom{position:fixed;right:0;bottom:0;left:0;z-index:1030}@supports ((position:-webkit-sticky) or (position:sticky)){.sticky-top{position:-webkit-sticky;position:sticky;top:0;z-index:1020}}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;overflow:visible;clip:auto;white-space:normal}.shadow-sm{box-shadow:0 .125rem .25rem rgba(0,0,0,.075)!important}.shadow{box-shadow:0 .5rem 1rem rgba(0,0,0,.15)!important}.shadow-lg{box-shadow:0 1rem 3rem rgba(0,0,0,.175)!important}.shadow-none{box-shadow:none!important}.w-25{width:25%!important}.w-50{width:50%!important}.w-75{width:75%!important}.w-100{width:100%!important}.w-auto{width:auto!important}.h-25{height:25%!important}.h-50{height:50%!important}.h-75{height:75%!important}.h-100{height:100%!important}.h-auto{height:auto!important}.mw-100{max-width:100%!important}.mh-100{max-height:100%!important}.min-vw-100{min-width:100vw!important}.min-vh-100{min-height:100vh!important}.vw-100{width:100vw!important}.vh-100{height:100vh!important}.m-0{margin:0!important}.mt-0,.my-0{margin-top:0!important}.mr-0,.mx-0{margin-right:0!important}.mb-0,.my-0{margin-bottom:0!important}.ml-0,.mx-0{margin-left:0!important}.m-1{margin:.25rem!important}.mt-1,.my-1{margin-top:.25rem!important}.mr-1,.mx-1{margin-right:.25rem!important}.mb-1,.my-1{margin-bottom:.25rem!important}.ml-1,.mx-1{margin-left:.25rem!important}.m-2{margin:.5rem!important}.mt-2,.my-2{margin-top:.5rem!important}.mr-2,.mx-2{margin-right:.5rem!important}.mb-2,.my-2{margin-bottom:.5rem!important}.ml-2,.mx-2{margin-left:.5rem!important}.m-3{margin:1rem!important}.mt-3,.my-3{margin-top:1rem!important}.mr-3,.mx-3{margin-right:1rem!important}.mb-3,.my-3{margin-bottom:1rem!important}.ml-3,.mx-3{margin-left:1rem!important}.m-4{margin:1.5rem!important}.mt-4,.my-4{margin-top:1.5rem!important}.mr-4,.mx-4{margin-right:1.5rem!important}.mb-4,.my-4{margin-bottom:1.5rem!important}.ml-4,.mx-4{margin-left:1.5rem!important}.m-5{margin:3rem!important}.mt-5,.my-5{margin-top:3rem!important}.mr-5,.mx-5{margin-right:3rem!important}.mb-5,.my-5{margin-bottom:3rem!important}.ml-5,.mx-5{margin-left:3rem!important}.p-0{padding:0!important}.pt-0,.py-0{padding-top:0!important}.pr-0,.px-0{padding-right:0!important}.pb-0,.py-0{padding-bottom:0!important}.pl-0,.px-0{padding-left:0!important}.p-1{padding:.25rem!important}.pt-1,.py-1{padding-top:.25rem!important}.pr-1,.px-1{padding-right:.25rem!important}.pb-1,.py-1{padding-bottom:.25rem!important}.pl-1,.px-1{padding-left:.25rem!important}.p-2{padding:.5rem!important}.pt-2,.py-2{padding-top:.5rem!important}.pr-2,.px-2{padding-right:.5rem!important}.pb-2,.py-2{padding-bottom:.5rem!important}.pl-2,.px-2{padding-left:.5rem!important}.p-3{padding:1rem!important}.pt-3,.py-3{padding-top:1rem!important}.pr-3,.px-3{padding-right:1rem!important}.pb-3,.py-3{padding-bottom:1rem!important}.pl-3,.px-3{padding-left:1rem!important}.p-4{padding:1.5rem!important}.pt-4,.py-4{padding-top:1.5rem!important}.pr-4,.px-4{padding-right:1.5rem!important}.pb-4,.py-4{padding-bottom:1.5rem!important}.pl-4,.px-4{padding-left:1.5rem!important}.p-5{padding:3rem!important}.pt-5,.py-5{padding-top:3rem!important}.pr-5,.px-5{padding-right:3rem!important}.pb-5,.py-5{padding-bottom:3rem!important}.pl-5,.px-5{padding-left:3rem!important}.m-n1{margin:-.25rem!important}.mt-n1,.my-n1{margin-top:-.25rem!important}.mr-n1,.mx-n1{margin-right:-.25rem!important}.mb-n1,.my-n1{margin-bottom:-.25rem!important}.ml-n1,.mx-n1{margin-left:-.25rem!important}.m-n2{margin:-.5rem!important}.mt-n2,.my-n2{margin-top:-.5rem!important}.mr-n2,.mx-n2{margin-right:-.5rem!important}.mb-n2,.my-n2{margin-bottom:-.5rem!important}.ml-n2,.mx-n2{margin-left:-.5rem!important}.m-n3{margin:-1rem!important}.mt-n3,.my-n3{margin-top:-1rem!important}.mr-n3,.mx-n3{margin-right:-1rem!important}.mb-n3,.my-n3{margin-bottom:-1rem!important}.ml-n3,.mx-n3{margin-left:-1rem!important}.m-n4{margin:-1.5rem!important}.mt-n4,.my-n4{margin-top:-1.5rem!important}.mr-n4,.mx-n4{margin-right:-1.5rem!important}.mb-n4,.my-n4{margin-bottom:-1.5rem!important}.ml-n4,.mx-n4{margin-left:-1.5rem!important}.m-n5{margin:-3rem!important}.mt-n5,.my-n5{margin-top:-3rem!important}.mr-n5,.mx-n5{margin-right:-3rem!important}.mb-n5,.my-n5{margin-bottom:-3rem!important}.ml-n5,.mx-n5{margin-left:-3rem!important}.m-auto{margin:auto!important}.mt-auto,.my-auto{margin-top:auto!important}.mr-auto,.mx-auto{margin-right:auto!important}.mb-auto,.my-auto{margin-bottom:auto!important}.ml-auto,.mx-auto{margin-left:auto!important}@media (min-width:576px){.m-sm-0{margin:0!important}.mt-sm-0,.my-sm-0{margin-top:0!important}.mr-sm-0,.mx-sm-0{margin-right:0!important}.mb-sm-0,.my-sm-0{margin-bottom:0!important}.ml-sm-0,.mx-sm-0{margin-left:0!important}.m-sm-1{margin:.25rem!important}.mt-sm-1,.my-sm-1{margin-top:.25rem!important}.mr-sm-1,.mx-sm-1{margin-right:.25rem!important}.mb-sm-1,.my-sm-1{margin-bottom:.25rem!important}.ml-sm-1,.mx-sm-1{margin-left:.25rem!important}.m-sm-2{margin:.5rem!important}.mt-sm-2,.my-sm-2{margin-top:.5rem!important}.mr-sm-2,.mx-sm-2{margin-right:.5rem!important}.mb-sm-2,.my-sm-2{margin-bottom:.5rem!important}.ml-sm-2,.mx-sm-2{margin-left:.5rem!important}.m-sm-3{margin:1rem!important}.mt-sm-3,.my-sm-3{margin-top:1rem!important}.mr-sm-3,.mx-sm-3{margin-right:1rem!important}.mb-sm-3,.my-sm-3{margin-bottom:1rem!important}.ml-sm-3,.mx-sm-3{margin-left:1rem!important}.m-sm-4{margin:1.5rem!important}.mt-sm-4,.my-sm-4{margin-top:1.5rem!important}.mr-sm-4,.mx-sm-4{margin-right:1.5rem!important}.mb-sm-4,.my-sm-4{margin-bottom:1.5rem!important}.ml-sm-4,.mx-sm-4{margin-left:1.5rem!important}.m-sm-5{margin:3rem!important}.mt-sm-5,.my-sm-5{margin-top:3rem!important}.mr-sm-5,.mx-sm-5{margin-right:3rem!important}.mb-sm-5,.my-sm-5{margin-bottom:3rem!important}.ml-sm-5,.mx-sm-5{margin-left:3rem!important}.p-sm-0{padding:0!important}.pt-sm-0,.py-sm-0{padding-top:0!important}.pr-sm-0,.px-sm-0{padding-right:0!important}.pb-sm-0,.py-sm-0{padding-bottom:0!important}.pl-sm-0,.px-sm-0{padding-left:0!important}.p-sm-1{padding:.25rem!important}.pt-sm-1,.py-sm-1{padding-top:.25rem!important}.pr-sm-1,.px-sm-1{padding-right:.25rem!important}.pb-sm-1,.py-sm-1{padding-bottom:.25rem!important}.pl-sm-1,.px-sm-1{padding-left:.25rem!important}.p-sm-2{padding:.5rem!important}.pt-sm-2,.py-sm-2{padding-top:.5rem!important}.pr-sm-2,.px-sm-2{padding-right:.5rem!important}.pb-sm-2,.py-sm-2{padding-bottom:.5rem!important}.pl-sm-2,.px-sm-2{padding-left:.5rem!important}.p-sm-3{padding:1rem!important}.pt-sm-3,.py-sm-3{padding-top:1rem!important}.pr-sm-3,.px-sm-3{padding-right:1rem!important}.pb-sm-3,.py-sm-3{padding-bottom:1rem!important}.pl-sm-3,.px-sm-3{padding-left:1rem!important}.p-sm-4{padding:1.5rem!important}.pt-sm-4,.py-sm-4{padding-top:1.5rem!important}.pr-sm-4,.px-sm-4{padding-right:1.5rem!important}.pb-sm-4,.py-sm-4{padding-bottom:1.5rem!important}.pl-sm-4,.px-sm-4{padding-left:1.5rem!important}.p-sm-5{padding:3rem!important}.pt-sm-5,.py-sm-5{padding-top:3rem!important}.pr-sm-5,.px-sm-5{padding-right:3rem!important}.pb-sm-5,.py-sm-5{padding-bottom:3rem!important}.pl-sm-5,.px-sm-5{padding-left:3rem!important}.m-sm-n1{margin:-.25rem!important}.mt-sm-n1,.my-sm-n1{margin-top:-.25rem!important}.mr-sm-n1,.mx-sm-n1{margin-right:-.25rem!important}.mb-sm-n1,.my-sm-n1{margin-bottom:-.25rem!important}.ml-sm-n1,.mx-sm-n1{margin-left:-.25rem!important}.m-sm-n2{margin:-.5rem!important}.mt-sm-n2,.my-sm-n2{margin-top:-.5rem!important}.mr-sm-n2,.mx-sm-n2{margin-right:-.5rem!important}.mb-sm-n2,.my-sm-n2{margin-bottom:-.5rem!important}.ml-sm-n2,.mx-sm-n2{margin-left:-.5rem!important}.m-sm-n3{margin:-1rem!important}.mt-sm-n3,.my-sm-n3{margin-top:-1rem!important}.mr-sm-n3,.mx-sm-n3{margin-right:-1rem!important}.mb-sm-n3,.my-sm-n3{margin-bottom:-1rem!important}.ml-sm-n3,.mx-sm-n3{margin-left:-1rem!important}.m-sm-n4{margin:-1.5rem!important}.mt-sm-n4,.my-sm-n4{margin-top:-1.5rem!important}.mr-sm-n4,.mx-sm-n4{margin-right:-1.5rem!important}.mb-sm-n4,.my-sm-n4{margin-bottom:-1.5rem!important}.ml-sm-n4,.mx-sm-n4{margin-left:-1.5rem!important}.m-sm-n5{margin:-3rem!important}.mt-sm-n5,.my-sm-n5{margin-top:-3rem!important}.mr-sm-n5,.mx-sm-n5{margin-right:-3rem!important}.mb-sm-n5,.my-sm-n5{margin-bottom:-3rem!important}.ml-sm-n5,.mx-sm-n5{margin-left:-3rem!important}.m-sm-auto{margin:auto!important}.mt-sm-auto,.my-sm-auto{margin-top:auto!important}.mr-sm-auto,.mx-sm-auto{margin-right:auto!important}.mb-sm-auto,.my-sm-auto{margin-bottom:auto!important}.ml-sm-auto,.mx-sm-auto{margin-left:auto!important}}@media (min-width:768px){.m-md-0{margin:0!important}.mt-md-0,.my-md-0{margin-top:0!important}.mr-md-0,.mx-md-0{margin-right:0!important}.mb-md-0,.my-md-0{margin-bottom:0!important}.ml-md-0,.mx-md-0{margin-left:0!important}.m-md-1{margin:.25rem!important}.mt-md-1,.my-md-1{margin-top:.25rem!important}.mr-md-1,.mx-md-1{margin-right:.25rem!important}.mb-md-1,.my-md-1{margin-bottom:.25rem!important}.ml-md-1,.mx-md-1{margin-left:.25rem!important}.m-md-2{margin:.5rem!important}.mt-md-2,.my-md-2{margin-top:.5rem!important}.mr-md-2,.mx-md-2{margin-right:.5rem!important}.mb-md-2,.my-md-2{margin-bottom:.5rem!important}.ml-md-2,.mx-md-2{margin-left:.5rem!important}.m-md-3{margin:1rem!important}.mt-md-3,.my-md-3{margin-top:1rem!important}.mr-md-3,.mx-md-3{margin-right:1rem!important}.mb-md-3,.my-md-3{margin-bottom:1rem!important}.ml-md-3,.mx-md-3{margin-left:1rem!important}.m-md-4{margin:1.5rem!important}.mt-md-4,.my-md-4{margin-top:1.5rem!important}.mr-md-4,.mx-md-4{margin-right:1.5rem!important}.mb-md-4,.my-md-4{margin-bottom:1.5rem!important}.ml-md-4,.mx-md-4{margin-left:1.5rem!important}.m-md-5{margin:3rem!important}.mt-md-5,.my-md-5{margin-top:3rem!important}.mr-md-5,.mx-md-5{margin-right:3rem!important}.mb-md-5,.my-md-5{margin-bottom:3rem!important}.ml-md-5,.mx-md-5{margin-left:3rem!important}.p-md-0{padding:0!important}.pt-md-0,.py-md-0{padding-top:0!important}.pr-md-0,.px-md-0{padding-right:0!important}.pb-md-0,.py-md-0{padding-bottom:0!important}.pl-md-0,.px-md-0{padding-left:0!important}.p-md-1{padding:.25rem!important}.pt-md-1,.py-md-1{padding-top:.25rem!important}.pr-md-1,.px-md-1{padding-right:.25rem!important}.pb-md-1,.py-md-1{padding-bottom:.25rem!important}.pl-md-1,.px-md-1{padding-left:.25rem!important}.p-md-2{padding:.5rem!important}.pt-md-2,.py-md-2{padding-top:.5rem!important}.pr-md-2,.px-md-2{padding-right:.5rem!important}.pb-md-2,.py-md-2{padding-bottom:.5rem!important}.pl-md-2,.px-md-2{padding-left:.5rem!important}.p-md-3{padding:1rem!important}.pt-md-3,.py-md-3{padding-top:1rem!important}.pr-md-3,.px-md-3{padding-right:1rem!important}.pb-md-3,.py-md-3{padding-bottom:1rem!important}.pl-md-3,.px-md-3{padding-left:1rem!important}.p-md-4{padding:1.5rem!important}.pt-md-4,.py-md-4{padding-top:1.5rem!important}.pr-md-4,.px-md-4{padding-right:1.5rem!important}.pb-md-4,.py-md-4{padding-bottom:1.5rem!important}.pl-md-4,.px-md-4{padding-left:1.5rem!important}.p-md-5{padding:3rem!important}.pt-md-5,.py-md-5{padding-top:3rem!important}.pr-md-5,.px-md-5{padding-right:3rem!important}.pb-md-5,.py-md-5{padding-bottom:3rem!important}.pl-md-5,.px-md-5{padding-left:3rem!important}.m-md-n1{margin:-.25rem!important}.mt-md-n1,.my-md-n1{margin-top:-.25rem!important}.mr-md-n1,.mx-md-n1{margin-right:-.25rem!important}.mb-md-n1,.my-md-n1{margin-bottom:-.25rem!important}.ml-md-n1,.mx-md-n1{margin-left:-.25rem!important}.m-md-n2{margin:-.5rem!important}.mt-md-n2,.my-md-n2{margin-top:-.5rem!important}.mr-md-n2,.mx-md-n2{margin-right:-.5rem!important}.mb-md-n2,.my-md-n2{margin-bottom:-.5rem!important}.ml-md-n2,.mx-md-n2{margin-left:-.5rem!important}.m-md-n3{margin:-1rem!important}.mt-md-n3,.my-md-n3{margin-top:-1rem!important}.mr-md-n3,.mx-md-n3{margin-right:-1rem!important}.mb-md-n3,.my-md-n3{margin-bottom:-1rem!important}.ml-md-n3,.mx-md-n3{margin-left:-1rem!important}.m-md-n4{margin:-1.5rem!important}.mt-md-n4,.my-md-n4{margin-top:-1.5rem!important}.mr-md-n4,.mx-md-n4{margin-right:-1.5rem!important}.mb-md-n4,.my-md-n4{margin-bottom:-1.5rem!important}.ml-md-n4,.mx-md-n4{margin-left:-1.5rem!important}.m-md-n5{margin:-3rem!important}.mt-md-n5,.my-md-n5{margin-top:-3rem!important}.mr-md-n5,.mx-md-n5{margin-right:-3rem!important}.mb-md-n5,.my-md-n5{margin-bottom:-3rem!important}.ml-md-n5,.mx-md-n5{margin-left:-3rem!important}.m-md-auto{margin:auto!important}.mt-md-auto,.my-md-auto{margin-top:auto!important}.mr-md-auto,.mx-md-auto{margin-right:auto!important}.mb-md-auto,.my-md-auto{margin-bottom:auto!important}.ml-md-auto,.mx-md-auto{margin-left:auto!important}}@media (min-width:992px){.m-lg-0{margin:0!important}.mt-lg-0,.my-lg-0{margin-top:0!important}.mr-lg-0,.mx-lg-0{margin-right:0!important}.mb-lg-0,.my-lg-0{margin-bottom:0!important}.ml-lg-0,.mx-lg-0{margin-left:0!important}.m-lg-1{margin:.25rem!important}.mt-lg-1,.my-lg-1{margin-top:.25rem!important}.mr-lg-1,.mx-lg-1{margin-right:.25rem!important}.mb-lg-1,.my-lg-1{margin-bottom:.25rem!important}.ml-lg-1,.mx-lg-1{margin-left:.25rem!important}.m-lg-2{margin:.5rem!important}.mt-lg-2,.my-lg-2{margin-top:.5rem!important}.mr-lg-2,.mx-lg-2{margin-right:.5rem!important}.mb-lg-2,.my-lg-2{margin-bottom:.5rem!important}.ml-lg-2,.mx-lg-2{margin-left:.5rem!important}.m-lg-3{margin:1rem!important}.mt-lg-3,.my-lg-3{margin-top:1rem!important}.mr-lg-3,.mx-lg-3{margin-right:1rem!important}.mb-lg-3,.my-lg-3{margin-bottom:1rem!important}.ml-lg-3,.mx-lg-3{margin-left:1rem!important}.m-lg-4{margin:1.5rem!important}.mt-lg-4,.my-lg-4{margin-top:1.5rem!important}.mr-lg-4,.mx-lg-4{margin-right:1.5rem!important}.mb-lg-4,.my-lg-4{margin-bottom:1.5rem!important}.ml-lg-4,.mx-lg-4{margin-left:1.5rem!important}.m-lg-5{margin:3rem!important}.mt-lg-5,.my-lg-5{margin-top:3rem!important}.mr-lg-5,.mx-lg-5{margin-right:3rem!important}.mb-lg-5,.my-lg-5{margin-bottom:3rem!important}.ml-lg-5,.mx-lg-5{margin-left:3rem!important}.p-lg-0{padding:0!important}.pt-lg-0,.py-lg-0{padding-top:0!important}.pr-lg-0,.px-lg-0{padding-right:0!important}.pb-lg-0,.py-lg-0{padding-bottom:0!important}.pl-lg-0,.px-lg-0{padding-left:0!important}.p-lg-1{padding:.25rem!important}.pt-lg-1,.py-lg-1{padding-top:.25rem!important}.pr-lg-1,.px-lg-1{padding-right:.25rem!important}.pb-lg-1,.py-lg-1{padding-bottom:.25rem!important}.pl-lg-1,.px-lg-1{padding-left:.25rem!important}.p-lg-2{padding:.5rem!important}.pt-lg-2,.py-lg-2{padding-top:.5rem!important}.pr-lg-2,.px-lg-2{padding-right:.5rem!important}.pb-lg-2,.py-lg-2{padding-bottom:.5rem!important}.pl-lg-2,.px-lg-2{padding-left:.5rem!important}.p-lg-3{padding:1rem!important}.pt-lg-3,.py-lg-3{padding-top:1rem!important}.pr-lg-3,.px-lg-3{padding-right:1rem!important}.pb-lg-3,.py-lg-3{padding-bottom:1rem!important}.pl-lg-3,.px-lg-3{padding-left:1rem!important}.p-lg-4{padding:1.5rem!important}.pt-lg-4,.py-lg-4{padding-top:1.5rem!important}.pr-lg-4,.px-lg-4{padding-right:1.5rem!important}.pb-lg-4,.py-lg-4{padding-bottom:1.5rem!important}.pl-lg-4,.px-lg-4{padding-left:1.5rem!important}.p-lg-5{padding:3rem!important}.pt-lg-5,.py-lg-5{padding-top:3rem!important}.pr-lg-5,.px-lg-5{padding-right:3rem!important}.pb-lg-5,.py-lg-5{padding-bottom:3rem!important}.pl-lg-5,.px-lg-5{padding-left:3rem!important}.m-lg-n1{margin:-.25rem!important}.mt-lg-n1,.my-lg-n1{margin-top:-.25rem!important}.mr-lg-n1,.mx-lg-n1{margin-right:-.25rem!important}.mb-lg-n1,.my-lg-n1{margin-bottom:-.25rem!important}.ml-lg-n1,.mx-lg-n1{margin-left:-.25rem!important}.m-lg-n2{margin:-.5rem!important}.mt-lg-n2,.my-lg-n2{margin-top:-.5rem!important}.mr-lg-n2,.mx-lg-n2{margin-right:-.5rem!important}.mb-lg-n2,.my-lg-n2{margin-bottom:-.5rem!important}.ml-lg-n2,.mx-lg-n2{margin-left:-.5rem!important}.m-lg-n3{margin:-1rem!important}.mt-lg-n3,.my-lg-n3{margin-top:-1rem!important}.mr-lg-n3,.mx-lg-n3{margin-right:-1rem!important}.mb-lg-n3,.my-lg-n3{margin-bottom:-1rem!important}.ml-lg-n3,.mx-lg-n3{margin-left:-1rem!important}.m-lg-n4{margin:-1.5rem!important}.mt-lg-n4,.my-lg-n4{margin-top:-1.5rem!important}.mr-lg-n4,.mx-lg-n4{margin-right:-1.5rem!important}.mb-lg-n4,.my-lg-n4{margin-bottom:-1.5rem!important}.ml-lg-n4,.mx-lg-n4{margin-left:-1.5rem!important}.m-lg-n5{margin:-3rem!important}.mt-lg-n5,.my-lg-n5{margin-top:-3rem!important}.mr-lg-n5,.mx-lg-n5{margin-right:-3rem!important}.mb-lg-n5,.my-lg-n5{margin-bottom:-3rem!important}.ml-lg-n5,.mx-lg-n5{margin-left:-3rem!important}.m-lg-auto{margin:auto!important}.mt-lg-auto,.my-lg-auto{margin-top:auto!important}.mr-lg-auto,.mx-lg-auto{margin-right:auto!important}.mb-lg-auto,.my-lg-auto{margin-bottom:auto!important}.ml-lg-auto,.mx-lg-auto{margin-left:auto!important}}@media (min-width:1200px){.m-xl-0{margin:0!important}.mt-xl-0,.my-xl-0{margin-top:0!important}.mr-xl-0,.mx-xl-0{margin-right:0!important}.mb-xl-0,.my-xl-0{margin-bottom:0!important}.ml-xl-0,.mx-xl-0{margin-left:0!important}.m-xl-1{margin:.25rem!important}.mt-xl-1,.my-xl-1{margin-top:.25rem!important}.mr-xl-1,.mx-xl-1{margin-right:.25rem!important}.mb-xl-1,.my-xl-1{margin-bottom:.25rem!important}.ml-xl-1,.mx-xl-1{margin-left:.25rem!important}.m-xl-2{margin:.5rem!important}.mt-xl-2,.my-xl-2{margin-top:.5rem!important}.mr-xl-2,.mx-xl-2{margin-right:.5rem!important}.mb-xl-2,.my-xl-2{margin-bottom:.5rem!important}.ml-xl-2,.mx-xl-2{margin-left:.5rem!important}.m-xl-3{margin:1rem!important}.mt-xl-3,.my-xl-3{margin-top:1rem!important}.mr-xl-3,.mx-xl-3{margin-right:1rem!important}.mb-xl-3,.my-xl-3{margin-bottom:1rem!important}.ml-xl-3,.mx-xl-3{margin-left:1rem!important}.m-xl-4{margin:1.5rem!important}.mt-xl-4,.my-xl-4{margin-top:1.5rem!important}.mr-xl-4,.mx-xl-4{margin-right:1.5rem!important}.mb-xl-4,.my-xl-4{margin-bottom:1.5rem!important}.ml-xl-4,.mx-xl-4{margin-left:1.5rem!important}.m-xl-5{margin:3rem!important}.mt-xl-5,.my-xl-5{margin-top:3rem!important}.mr-xl-5,.mx-xl-5{margin-right:3rem!important}.mb-xl-5,.my-xl-5{margin-bottom:3rem!important}.ml-xl-5,.mx-xl-5{margin-left:3rem!important}.p-xl-0{padding:0!important}.pt-xl-0,.py-xl-0{padding-top:0!important}.pr-xl-0,.px-xl-0{padding-right:0!important}.pb-xl-0,.py-xl-0{padding-bottom:0!important}.pl-xl-0,.px-xl-0{padding-left:0!important}.p-xl-1{padding:.25rem!important}.pt-xl-1,.py-xl-1{padding-top:.25rem!important}.pr-xl-1,.px-xl-1{padding-right:.25rem!important}.pb-xl-1,.py-xl-1{padding-bottom:.25rem!important}.pl-xl-1,.px-xl-1{padding-left:.25rem!important}.p-xl-2{padding:.5rem!important}.pt-xl-2,.py-xl-2{padding-top:.5rem!important}.pr-xl-2,.px-xl-2{padding-right:.5rem!important}.pb-xl-2,.py-xl-2{padding-bottom:.5rem!important}.pl-xl-2,.px-xl-2{padding-left:.5rem!important}.p-xl-3{padding:1rem!important}.pt-xl-3,.py-xl-3{padding-top:1rem!important}.pr-xl-3,.px-xl-3{padding-right:1rem!important}.pb-xl-3,.py-xl-3{padding-bottom:1rem!important}.pl-xl-3,.px-xl-3{padding-left:1rem!important}.p-xl-4{padding:1.5rem!important}.pt-xl-4,.py-xl-4{padding-top:1.5rem!important}.pr-xl-4,.px-xl-4{padding-right:1.5rem!important}.pb-xl-4,.py-xl-4{padding-bottom:1.5rem!important}.pl-xl-4,.px-xl-4{padding-left:1.5rem!important}.p-xl-5{padding:3rem!important}.pt-xl-5,.py-xl-5{padding-top:3rem!important}.pr-xl-5,.px-xl-5{padding-right:3rem!important}.pb-xl-5,.py-xl-5{padding-bottom:3rem!important}.pl-xl-5,.px-xl-5{padding-left:3rem!important}.m-xl-n1{margin:-.25rem!important}.mt-xl-n1,.my-xl-n1{margin-top:-.25rem!important}.mr-xl-n1,.mx-xl-n1{margin-right:-.25rem!important}.mb-xl-n1,.my-xl-n1{margin-bottom:-.25rem!important}.ml-xl-n1,.mx-xl-n1{margin-left:-.25rem!important}.m-xl-n2{margin:-.5rem!important}.mt-xl-n2,.my-xl-n2{margin-top:-.5rem!important}.mr-xl-n2,.mx-xl-n2{margin-right:-.5rem!important}.mb-xl-n2,.my-xl-n2{margin-bottom:-.5rem!important}.ml-xl-n2,.mx-xl-n2{margin-left:-.5rem!important}.m-xl-n3{margin:-1rem!important}.mt-xl-n3,.my-xl-n3{margin-top:-1rem!important}.mr-xl-n3,.mx-xl-n3{margin-right:-1rem!important}.mb-xl-n3,.my-xl-n3{margin-bottom:-1rem!important}.ml-xl-n3,.mx-xl-n3{margin-left:-1rem!important}.m-xl-n4{margin:-1.5rem!important}.mt-xl-n4,.my-xl-n4{margin-top:-1.5rem!important}.mr-xl-n4,.mx-xl-n4{margin-right:-1.5rem!important}.mb-xl-n4,.my-xl-n4{margin-bottom:-1.5rem!important}.ml-xl-n4,.mx-xl-n4{margin-left:-1.5rem!important}.m-xl-n5{margin:-3rem!important}.mt-xl-n5,.my-xl-n5{margin-top:-3rem!important}.mr-xl-n5,.mx-xl-n5{margin-right:-3rem!important}.mb-xl-n5,.my-xl-n5{margin-bottom:-3rem!important}.ml-xl-n5,.mx-xl-n5{margin-left:-3rem!important}.m-xl-auto{margin:auto!important}.mt-xl-auto,.my-xl-auto{margin-top:auto!important}.mr-xl-auto,.mx-xl-auto{margin-right:auto!important}.mb-xl-auto,.my-xl-auto{margin-bottom:auto!important}.ml-xl-auto,.mx-xl-auto{margin-left:auto!important}}.stretched-link::after{position:absolute;top:0;right:0;bottom:0;left:0;z-index:1;pointer-events:auto;content:"";background-color:rgba(0,0,0,0)}.text-monospace{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace!important}.text-justify{text-align:justify!important}.text-wrap{white-space:normal!important}.text-nowrap{white-space:nowrap!important}.text-truncate{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.text-left{text-align:left!important}.text-right{text-align:right!important}.text-center{text-align:center!important}@media (min-width:576px){.text-sm-left{text-align:left!important}.text-sm-right{text-align:right!important}.text-sm-center{text-align:center!important}}@media (min-width:768px){.text-md-left{text-align:left!important}.text-md-right{text-align:right!important}.text-md-center{text-align:center!important}}@media (min-width:992px){.text-lg-left{text-align:left!important}.text-lg-right{text-align:right!important}.text-lg-center{text-align:center!important}}@media (min-width:1200px){.text-xl-left{text-align:left!important}.text-xl-right{text-align:right!important}.text-xl-center{text-align:center!important}}.text-lowercase{text-transform:lowercase!important}.text-uppercase{text-transform:uppercase!important}.text-capitalize{text-transform:capitalize!important}.font-weight-light{font-weight:300!important}.font-weight-lighter{font-weight:lighter!important}.font-weight-normal{font-weight:400!important}.font-weight-bold{font-weight:700!important}.font-weight-bolder{font-weight:bolder!important}.font-italic{font-style:italic!important}.text-white{color:#fff!important}.text-primary{color:#007bff!important}a.text-primary:focus,a.text-primary:hover{color:#0056b3!important}.text-secondary{color:#6c757d!important}a.text-secondary:focus,a.text-secondary:hover{color:#494f54!important}.text-success{color:#28a745!important}a.text-success:focus,a.text-success:hover{color:#19692c!important}.text-info{color:#17a2b8!important}a.text-info:focus,a.text-info:hover{color:#0f6674!important}.text-warning{color:#ffc107!important}a.text-warning:focus,a.text-warning:hover{color:#ba8b00!important}.text-danger{color:#dc3545!important}a.text-danger:focus,a.text-danger:hover{color:#a71d2a!important}.text-light{color:#f8f9fa!important}a.text-light:focus,a.text-light:hover{color:#cbd3da!important}.text-dark{color:#343a40!important}a.text-dark:focus,a.text-dark:hover{color:#121416!important}.text-body{color:#212529!important}.text-muted{color:#6c757d!important}.text-black-50{color:rgba(0,0,0,.5)!important}.text-white-50{color:rgba(255,255,255,.5)!important}.text-hide{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.text-decoration-none{text-decoration:none!important}.text-break{word-break:break-word!important;word-wrap:break-word!important}.text-reset{color:inherit!important}.visible{visibility:visible!important}.invisible{visibility:hidden!important}@media print{*,::after,::before{text-shadow:none!important;box-shadow:none!important}a:not(.btn){text-decoration:underline}abbr[title]::after{content:" (" attr(title) ")"}pre{white-space:pre-wrap!important}blockquote,pre{border:1px solid #adb5bd;page-break-inside:avoid}img,tr{page-break-inside:avoid}h2,h3,p{orphans:3;widows:3}h2,h3{page-break-after:avoid}@page{size:a3}body{min-width:992px!important}.container{min-width:992px!important}.navbar{display:none}.badge{border:1px solid #000}.table{border-collapse:collapse!important}.table td,.table th{background-color:#fff!important}.table-bordered td,.table-bordered th{border:1px solid #dee2e6!important}.table-dark{color:inherit}.table-dark tbody+tbody,.table-dark td,.table-dark th,.table-dark thead th{border-color:#dee2e6}.table .thead-dark th{color:inherit;border-color:#dee2e6}} +/*# sourceMappingURL=bootstrap.min.css.map */ \ No newline at end of file diff --git a/static/v2.15.x/web_help/css/docs.css b/static/v2.15.x/web_help/css/docs.css new file mode 100644 index 0000000000..b400b1e4ca --- /dev/null +++ b/static/v2.15.x/web_help/css/docs.css @@ -0,0 +1,66 @@ +/* +* 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. +* +*/ + +.markdown-body { + box-sizing: border-box; + font-family: 'Roboto', sans-serif; + margin: 0 auto; + max-width: 980px; + min-width: 200px; + padding: 45px; +} + +@media (max-width: 767px) { + .markdown-body { + padding: 15px; + } +} + +#btn-print { + background: none; + border: none; + display: none; + float: right; + font-size: large; + padding: 5px 5px 0; +} + +.btn-copy { + font-size: small; +} + +.print-only { + display: none; +} + +@media print { + .no-print { + display: none; + } + + .page-break { + page-break-before: always; + } + + .print-only { + display: block; + } +} + +[aria-label] { + cursor: default; +} + +@media (prefers-color-scheme: dark) { + body { + background-color: #0d1117; + } +} diff --git a/static/v2.15.x/web_help/css/main.css b/static/v2.15.x/web_help/css/main.css new file mode 100644 index 0000000000..b16ff87db1 --- /dev/null +++ b/static/v2.15.x/web_help/css/main.css @@ -0,0 +1,129 @@ +/* +* 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. +* +*/ + +html, body { + height: 100%; +} + +body { + font-family: 'Roboto', sans-serif; +} + +#cmd-tree { + flex: 1; + height: 100%; + margin: 0 5px; + overflow: auto; +} + +#docs-page { + border: none; + display: block; + height: 100%; + margin: 0; + padding: 0; + width: 100%; +} + +#footer { + flex: none; + font-size: small; + margin: 10px 0; + text-align: center; +} + +#header { + flex: none; +} + +#header-image { + height: 64px; + margin: 0 0 10px 5px; +} + +#header-text { + color: black; + display: inline-block; + min-height: 64px; + padding-top: 20px; + text-decoration: none; +} + +#panel-container { + display: flex; + flex-direction: row; + height: 100%; + overflow: hidden; +} + +#panel-left { + background-color: #edf2fa; + display: flex; + flex-direction: column; + flex: 0 0 auto; + max-width: calc(100% - 220px); + min-width: 220px; + width: 300px; +} + +#panel-right { + flex: 1 1 auto; + width: 100%; +} + +#tree-search { + border-radius: 20px; + margin: 0 5px 7px 5px; + width: calc(100% - 10px); +} + +#tree-tabs { + margin: 0 5px 5px 5px; + width: calc(100% - 10px); +} + +.gutter { + background-color: #dddee0; + background-position: 50%; + background-repeat: no-repeat; +} + +.gutter.gutter-horizontal { + background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAB4AAAAFAQMAAABo7865AAAABlBMVEVHcEzMzMzyAv2sAAAAAXRSTlMAQObYZgAAABBJREFUeF5jOAMEEAIEEFwAn3kMwcB6I2AAAAAASUVORK5CYII='); + cursor: col-resize; +} + +@media (prefers-color-scheme: dark) { + #header-text { + color: #c9d1d9; + } + + #panel-left { + background-color: #161b22; + } + + #panel-right { + background-color: #0d1117; + } + + #tree-search { + background-color: #0d1117; + color: #8b949e; + } + + .gutter { + background-color: #30363d; + } + + .jstree-default-dark { + background-color: #161b22; + } +} diff --git a/static/v2.15.x/web_help/docs/all.html b/static/v2.15.x/web_help/docs/all.html new file mode 100644 index 0000000000..eb61ac8429 --- /dev/null +++ b/static/v2.15.x/web_help/docs/all.html @@ -0,0 +1,123359 @@ + + + + +zowe + + +
+

zowe

+

Welcome to Zowe CLI!

+

Zowe CLI is a command line interface (CLI) that provides a simple and streamlined way to interact with IBM z/OS.

+

For additional Zowe CLI documentation, visit https://docs.zowe.org

+

For Zowe CLI support, visit https://www.zowe.org

+ + +

Options

+
    +
  • +

    --version | -V (boolean)

    +
      +
    • Display the current version of Zowe CLI
    • +
    +
  • +
  • +

    --available-commands | --ac (boolean)

    +
      +
    • Displays a list of available commands
    • +
    +
  • +
+

Global Options

+
    +
  • +

    --response-format-json | --rfj (boolean)

    +
      +
    • Produce JSON formatted data from a command
    • +
    +
  • +
  • +

    --help | -h (boolean)

    +
      +
    • Display help text
    • +
    +
  • +
  • +

    --help-web | --hw (boolean)

    +
      +
    • Display HTML help in browser
    • +
    +
  • +
+ +
+

zoweauth

+

Connect to Zowe API Mediation Layer authentication service and obtain a token, or disconnect from the authentication service and revoke the token.

+

The token provides authentication to services that support the API ML SSO (Single Sign-On) capability. When you log in, the token is stored in your default base profile until it expires. Base profiles store connection information shared by multiple services (e.g., z/OSMF), and are used if you do not supply connection information in a service profile. To take advantage of the API ML SSO capability, you should omit username and password in service profiles so that the token in the base profile is used.

+

zoweauthlogin

+

Log in to an authentication service.

+

zoweauthloginapiml

+

Log in to Zowe API Mediation Layer authentication service and obtain or update a token.

+

The token provides authentication to services that support the API ML SSO (Single Sign-On) capability. When you log in, the token is stored in your default base profile until it expires. Base profiles store connection information shared by multiple services (e.g., z/OSMF), and are used if you do not supply connection information in a service profile. To take advantage of the API ML SSO capability, you should omit username and password in service profiles so that the token in the base profile is used.

+

Usage

+

zowe auth login apiml [options]

+

Options

+
    +
  • +

    --show-token | --st (boolean)

    +
      +
    • Show the token when login is successful. If specified, does not save the token to a profile.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Log in to an API ML instance to obtain or update the token stored in your base profile:

    +
      +
    • zowe auth login apiml
    • +
    +
  • +
  • +

    Log in to an API ML instance to obtain a token without storing it in a profile:

    +
      +
    • zowe auth login apiml --show-token
    • +
    +
  • +
+

zoweauthlogout

+

Log out of an authentication service.

+

zoweauthlogoutapiml

+

Log out of the Zowe API Mediation Layer authentication service and revoke the token so it can no longer authenticate. Also remove the token from the default base profile, if it is stored on disk.

+

Usage

+

zowe auth logout apiml [options]

+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • +

      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'.

      +

      Allowed values: ^apimlAuthenticationToken.*, jwtToken, LtpaToken2

      +
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Log out of an API ML instance to revoke the token that was in use and remove it from your base profile:

    +
      +
    • zowe auth logout apiml
    • +
    +
  • +
  • +

    Log out of an API ML instance to revoke a token that was not stored in a profile:

    +
      +
    • zowe auth logout apiml --token-value <token>
    • +
    +
  • +
+
+

zoweca7

+

Welcome to the CA 7 Zowe CLI!

+

zoweca7commands

+

All the available commands are listed in the COMMANDS section.

+

zoweca7commandsaddrq

+

Manually adds temporary, one-time, preexecution user or predecessor job requirements

+

Usage

+

zowe ca7 commands addrq [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the job to which you want to add the job requirement.
      +The job must be in the request queue.
      +Defines the CA 7 job number to which you want to add the requirement for this run of the job.
      +Limits: 1 to 4 numeric characters

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --depjob (string)

    +
      +
    • +

      example: PAYJOB

      +

      Defines a temporary one-time job dependency requirement.
      +The DEPJOB value specifies the job name that must complete execution
      +or must be manually posted complete before the job identified by JOB is eligible for submission.

      +

      DEPJOB is required unless USR is used, in which case, omit DEPJOB.
      +This requirement is satisfied automatically when the predecessor job completes.
      +Only in unusual situations would this requirement must be satisfied manually.
      +That is, any time that a normal completion did not occur.

      +

      Required: Yes, unless USR is used.

      +

      Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --usr (string)

    +
      +
    • +

      example: USER WILL CALL TO RELEASE

      +

      Defines the description of a temporary, one-time user requirement.
      +This requirement must be manually satisfied before the job identified by JOB is eligible for submission.
      +If any commas are included as part of the text, enclose the entire requirements text in parentheses.
      +This requirement is satisfied automatically when the predecessor job completes.
      +Only in unusual situations would this requirement must be satisfied manually.
      +That is, any time that a normal completion did not occur.
      +Required: USR is required unless DEPJOB is used, in which case, omit USR.

      +

      Limits: 1 to 36 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --rmtjob (string)

    +
      +
    • +

      example: RMT_JOB

      +

      Names the job in the remote scheduler that is required by the job specified in the JOB field.
      +Limits: RMTJOB should accept up to 64 characters
      +valid characters are a-z, A-Z, 0-9, period (.), underscore (_), hyphen (-),
      +colon (:), and pound (#); do not include embedded spaces or tabs.

      +
    • +
    +
  • +
  • +

    --rmtschd (string)

    +
      +
    • +

      example: AP1

      +

      Names the remote scheduler where the predecessor job runs.
      +Before adding this requirement, the remote scheduler must be defined.
      +The remote scheduler defined as type LOCAL cannot be specified.
      +Limits: 1 to 3 alphanumeric characters; generic specification not supported.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Adds the job requirement ca7 number, 0016 from CA 7:

    +
      +
    • zowe ca7 commands addrq --ca7num 0016
    • +
    +
  • +
+

zoweca7commandscancel

+

For CPU jobs, the CANCEL command only removes the job from the queues.
+For XPJOB jobs, the CANCEL command removes the job from the queues.
+For agent definition jobs (AGJOBs), the CANCEL command sends a request to the agent and removes the job from the queues.

+

Usage

+

zowe ca7 commands cancel [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the unique CA 7 job number (leading zeros are not required) for the job to cancel.
      +Limits: 1 to 4 numeric characters

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (string)

    +
      +
    • Specifies to force the cancellation of the job.
      +Use of this option can potentially cause CA WA CA 7 Edition to abend; therefore, only use it as a last resort.
    • +
    +
  • +
  • +

    --reason (string)

    +
      +
    • +

      Defines the reason for the job cancellation.

      +

      Limits: 1 to 40 alphanumeric characters
      +Required: No (depending on initialization options)

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Cancel ca7 number, 0016:

    +
      +
    • zowe ca7 commands cancel --ca7num 0016
    • +
    +
  • +
+

zoweca7commandsdemand

+

The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
+JOB and JOBL are mutually exclusive.

+

Usage

+

zowe ca7 commands demand [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      job=PAYROLL

      +

      The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
      +1-8 alphanumeric (mutually exclusive w/ jobl

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --jobl (string)

    +
      +
    • +

      jobl=payrollSW123

      +

      Defines the long name of the job being demanded.
      +The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.

      +
    • +
    +
  • +
  • +

    --arfset | --as (string)

    +
      +
    • +

      arfset={arfsetname|**NONE**}

      +

      Defines the ARF set name that is used for this run of the job.
      +If you specify **NONE**, no ARF processing is performed for this run of the job.

      +

      Limits: 1 to 8 alphanumeric characters or **NONE**

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      cc=1234

      +

      Defines, with RO (relational operator), the job-level condition codes that are used to determine whether a job executes successfully.

      +

      If specified, this value overrides the RO defined for the job in the CA WA CA 7 Edition database. RO is required when CC is specified.

      +

      Default: The job definition panel COND-CODE value when the job is defined to CA WA CA 7 Edition; otherwise 0.
      +Limits: 1 to 4 numeric characters from 0 to 4095. Invalid with agent jobs.

      +
    • +
    +
  • +
  • +

    --class (string)

    +
      +
    • +

      class=n

      +

      Defines the workload balancing class for resource checking.

      +

      Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --count (string)

    +
      +
    • +

      count=nnnn

      +

      Defines the maximum number of times to repeat the job. COUNT is ignored if INTERVAL is not specified.

      +

      Default: None. The job continues repeating until the STOP time is reached.
      +Limits: 1 to 4 numeric characters from 0 to 1439. The leading zeros can be discarded.

      +
    • +
    +
  • +
  • +

    --date (string)

    +
      +
    • +

      date={+nn|yyddd}

      +

      Defines due-out and submit dates.
      +Limits: If used, specify DOTM or TIME.
      ++nn

      +

      Defines the number of days after the current date.
      +Limits: 1 to 2 numeric characters from 1 to 99
      +yyddd

      +

      Defines the Julian date to run the job.

      +
    • +
    +
  • +
  • +

    --depjob | --dj (string)

    +
      +
    • +

      depjob=jobname2

      +

      Defines a single predecessor job that must complete while the demanded job is waiting.
      +Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --dotm (string)

    +
      +
    • +

      dotm=hhmm

      +

      Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
      +If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.

      +

      If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.

      +

      Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59

      +

      Required: No (unless DATE is used, if so, DOTM or TIME must be specified)

      +
    • +
    +
  • +
  • +

    --exec | -e (string)

    +
      +
    • +

      exec={NO|YES}

      +

      Specifies whether to execute the job (YES/NO).
      +If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.

      +

      Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.

      +
    • +
    +
  • +
  • +

    --interval | -i (string)

    +
      +
    • +

      interval=hhmm

      +

      Identifies that the job is repeated (executed more than once) and defines the amount of time between each iteration.

      +

      If INTERVAL is specified, the TIME and TYPE keywords are required. If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.

      +

      Limits: hh=2 numeric characters from 0 to 23
      +mm=2 numeric characters from 00 to 59

      +
    • +
    +
  • +
  • +

    --jclid | --ji (string)

    +
      +
    • +

      jclid=10

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.

      +
    • +
    +
  • +
  • +

    --jcllib | --jl (string)

    +
      +
    • +

      jcllib=&SPECIAL

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)

      +
    • +
    +
  • +
  • +

    --late (string)

    +
      +
    • +

      late={NO|YES}

      +

      Specifies whether a notification occurs when the job becomes late.
      +Specify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.

      +
    • +
    +
  • +
  • +

    --leadtm | --lt (string)

    +
      +
    • +

      leadtm={0100|hhmm}

      +

      Specifies the lead (processing) time that is required for the job to run.
      +If omitted, 1 hour is usedFormat: hhmm
      +Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59You can omit leading zeros.

      +
    • +
    +
  • +
  • +

    --mainid | --mi (string)

    +
      +
    • +

      mainid={ALL|SYn|/SYn|-SYn}

      +

      Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
      +The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:

      +

      ALL
      +Specifies all CPUs are acceptable for executing the job.

      +

      SYn
      +n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.

      +

      /SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      -SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --prty (string)

    +
      +
    • +

      prty=nnn
      +Defines the initial workload balancing priority

      +

      Limits: 1-3 numeric (1-255).

      +
    • +
    +
  • +
  • +

    --rms (string)

    +
      +
    • +

      rms={NO|YES}

      +

      Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.

      +

      Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.

      +

      The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
      +Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
      +Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --ro (string)

    +
      +
    • +

      ro={EQ|LT|GT|GE|LE|NE|#S|IG|0}

      +

      Specifies the relational operator of the condition code (CC) or if the step level #SCC statements are being used in the JCL of the job.

      +

      EQ
      +Equal to

      +

      LT
      +Less than

      +

      GT
      +Greater than

      +

      GE
      +Greater than or equal to

      +

      LE
      +Less than or equal to

      +

      NE
      +Not equal to

      +

      #S
      +Step condition code tests to be made based on a #SCC statement.

      +

      IG
      +No evaluation of the job is done. CA WA CA 7 Edition always assumes that the job completes successfully, regardless of condition codes, abend codes, or run-time JCL errors.

      +

      Limits: Invalid with agent jobs.

      +
    • +
    +
  • +
  • +

    --schid | --si (string)

    +
      +
    • +

      schid={1|nnn}

      +

      Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.

      +

      Default: 1
      +Limits: 1 to 3 numeric characters from 1 to 999 (See Note)

      +

      No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)

      +
    • +
    +
  • +
  • +

    --set (string)

    +
      +
    • +

      set={NDB|NTR|SKP}

      +

      Specifies skip the next scheduled cycle for the job (SKP), disable triggering (NTR), or bypass the database updating at the job completion.

      +

      SKP
      +Specifies this run of the job takes the place of the next scheduled run. This value has the same effect as entering NXTCYC,SET=SKP. It is reflected on output from LJOB and LLOCK commands as if NXTCYC,SET=SKP was used. This parameter is invalid if the job has no schedule. SET=SKP has no impact on repeating jobs that are already in the queues.

      +

      NTR
      +Specifies normal triggering is disabled only for this run of the job.

      +

      NDB
      +Allows a job to bypass all load processing at the job completion, but allows other processing to proceed typically.

      +
    • +
    +
  • +
  • +

    --stop (string)

    +
      +
    • +

      stop=hhmm

      +

      Defines the clock time after which the job is not repeated. STOP is ignored if INTERVAL is not specified.

      +

      Default: 1439 minutes (24 hours minus 1 minute) after the submit time
      +Limits: hh=1 through 2 numeric characters from 0 to 23
      +mm=2 numeric characters from 00 to 59

      +
    • +
    +
  • +
  • +

    --time (string)

    +
      +
    • +

      time={hhmm|+hhmm}

      +

      Establishes a submit time-of-day requirement for the job.

      +

      Format: hhmm
      +Defines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).
      +Leading zeros are not required

      +
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • +

      type={CLOCK|END|RES|START}

      +

      Indicates that the job is being scheduled for rerun.
      +The value must be specified as shown.

      +

      TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Demand job, PAYROLL to CA 7:

    +
      +
    • zowe ca7 commands demand --job PAYROLL
    • +
    +
  • +
+

zoweca7commandsdemandh

+

The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.

+

Usage

+

zowe ca7 commands demandh [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      job=PAYROLL

      +

      Defines the name of the job being demanded.
      +The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --jobl (string)

    +
      +
    • +

      jobl=payrollSW123

      +

      Defines the long name of the job being demanded.
      +The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.

      +
    • +
    +
  • +
  • +

    --arfset | --as (string)

    +
      +
    • +

      arfset={arfsetname|**NONE**}

      +

      Defines the ARF set name that is used for this run of the job.
      +If you specify **NONE**, no ARF processing is performed for this run of the job.

      +

      Limits: 1 to 8 alphanumeric characters or **NONE**

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      cc=1234

      +

      Defines, with RO (relational operator), the job-level condition codes that are used to determine whether a job executes successfully.

      +

      If specified, this value overrides the RO defined for the job in the CA WA CA 7 Edition database. RO is required when CC is specified.

      +

      Default: The job definition panel COND-CODE value when the job is defined to CA WA CA 7 Edition; otherwise 0.
      +Limits: 1 to 4 numeric characters from 0 to 4095. Invalid with agent jobs.

      +
    • +
    +
  • +
  • +

    --class (string)

    +
      +
    • +

      class=n

      +

      Defines the workload balancing class for resource checking.

      +

      Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --count (string)

    +
      +
    • +

      count=nnnn

      +

      Defines the maximum number of times to repeat the job. COUNT is ignored if INTERVAL is not specified.

      +

      Default: None. The job continues repeating until the STOP time is reached.
      +Limits: 1 to 4 numeric characters from 0 to 1439. The leading zeros can be discarded.

      +
    • +
    +
  • +
  • +

    --date (string)

    +
      +
    • +

      date={+nn|yyddd}

      +

      Defines due-out and submit dates.
      +Limits: If used, specify DOTM or TIME.
      ++nn

      +

      Defines the number of days after the current date.
      +Limits: 1 to 2 numeric characters from 1 to 99
      +yyddd

      +

      Defines the Julian date to run the job.

      +
    • +
    +
  • +
  • +

    --depjob | --dj (string)

    +
      +
    • +

      depjob=jobname2

      +

      Defines a single predecessor job that must complete while the demanded job is waiting.
      +Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --dotm (string)

    +
      +
    • +

      dotm=hhmm

      +

      Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
      +If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.

      +

      If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.

      +

      Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59

      +

      Required: No (unless DATE is used, if so, DOTM or TIME must be specified)

      +
    • +
    +
  • +
  • +

    --exec | -e (string)

    +
      +
    • +

      exec={NO|YES}

      +

      Specifies whether to execute the job (YES/NO).
      +If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.

      +

      Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.

      +
    • +
    +
  • +
  • +

    --interval | -i (string)

    +
      +
    • +

      interval=hhmm

      +

      Identifies that the job is repeated (executed more than once) and defines the amount of time between each iteration.

      +

      If INTERVAL is specified, the TIME and TYPE keywords are required. If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.

      +

      Limits: hh=2 numeric characters from 0 to 23
      +mm=2 numeric characters from 00 to 59

      +
    • +
    +
  • +
  • +

    --jclid | --ji (string)

    +
      +
    • +

      jclid=10

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.

      +
    • +
    +
  • +
  • +

    --jcllib | --jl (string)

    +
      +
    • +

      jcllib=&SPECIAL

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)

      +
    • +
    +
  • +
  • +

    --late (string)

    +
      +
    • +

      late={NO|YES}

      +

      Specifies whether a notification occurs when the job becomes late.
      +Specify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.

      +
    • +
    +
  • +
  • +

    --leadtm | --lt (string)

    +
      +
    • +

      leadtm={0100|hhmm}

      +

      Specifies the lead (processing) time that is required for the job to run.
      +If omitted, 1 hour is usedFormat: hhmm
      +Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59You can omit leading zeros.

      +
    • +
    +
  • +
  • +

    --mainid | --mi (string)

    +
      +
    • +

      mainid={ALL|SYn|/SYn|-SYn}

      +

      Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
      +The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:

      +

      ALL
      +Specifies all CPUs are acceptable for executing the job.

      +

      SYn
      +n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.

      +

      /SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      -SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --prty (string)

    +
      +
    • +

      prty=nnn
      +Defines the initial workload balancing priority

      +

      Limits: 1-3 numeric (1-255).

      +
    • +
    +
  • +
  • +

    --rms (string)

    +
      +
    • +

      rms={NO|YES}

      +

      Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.

      +

      Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.

      +

      The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
      +Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
      +Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --ro (string)

    +
      +
    • +

      ro={EQ|LT|GT|GE|LE|NE|#S|IG|0}

      +

      Specifies the relational operator of the condition code (CC) or if the step level #SCC statements are being used in the JCL of the job.

      +

      EQ
      +Equal to

      +

      LT
      +Less than

      +

      GT
      +Greater than

      +

      GE
      +Greater than or equal to

      +

      LE
      +Less than or equal to

      +

      NE
      +Not equal to

      +

      #S
      +Step condition code tests to be made based on a #SCC statement.

      +

      IG
      +No evaluation of the job is done. CA WA CA 7 Edition always assumes that the job completes successfully, regardless of condition codes, abend codes, or run-time JCL errors.

      +

      Limits: Invalid with agent jobs.

      +
    • +
    +
  • +
  • +

    --schid | --si (string)

    +
      +
    • +

      schid={1|nnn}

      +

      Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.

      +

      Default: 1
      +Limits: 1 to 3 numeric characters from 1 to 999 (See Note)

      +

      No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)

      +
    • +
    +
  • +
  • +

    --set (string)

    +
      +
    • +

      set={NDB|NTR|SKP}

      +

      Specifies skip the next scheduled cycle for the job (SKP), disable triggering (NTR), or bypass the database updating at the job completion.

      +

      SKP
      +Specifies this run of the job takes the place of the next scheduled run. This value has the same effect as entering NXTCYC,SET=SKP. It is reflected on output from LJOB and LLOCK commands as if NXTCYC,SET=SKP was used. This parameter is invalid if the job has no schedule. SET=SKP has no impact on repeating jobs that are already in the queues.

      +

      NTR
      +Specifies normal triggering is disabled only for this run of the job.

      +

      NDB
      +Allows a job to bypass all load processing at the job completion, but allows other processing to proceed typically.

      +
    • +
    +
  • +
  • +

    --stop (string)

    +
      +
    • +

      stop=hhmm

      +

      Defines the clock time after which the job is not repeated. STOP is ignored if INTERVAL is not specified.

      +

      Default: 1439 minutes (24 hours minus 1 minute) after the submit time
      +Limits: hh=1 through 2 numeric characters from 0 to 23
      +mm=2 numeric characters from 00 to 59

      +
    • +
    +
  • +
  • +

    --time (string)

    +
      +
    • +

      time={hhmm|+hhmm}

      +

      Establishes a submit time-of-day requirement for the job.

      +

      Format: hhmm
      +Defines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).
      +Leading zeros are not required

      +
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • +

      type={CLOCK|END|RES|START}

      +

      Indicates that the job is being scheduled for rerun.
      +The value must be specified as shown.

      +

      TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Demand and hold job, PAYROLL:

    +
      +
    • zowe ca7 commands demandh --job PAYROLL
    • +
    +
  • +
+

zoweca7commandshold

+

This function is available on the QM.1 panel with a FILL value of H.
+Depending on the timing and whether you have any other
+predecessor situations, the QM.3 panel can sometimes accomplish this process.
+For more information on HOLD command, see the techdocs folder in this project.

+

Usage

+

zowe ca7 commands hold [options]

+

Options

+
    +
  • +

    -q (string)

    +
      +
    • example: RDY
      +Specifies to hold the contents of an entire queue.
      +Possible values:
      +REQ
      +Specifies to hold all jobs currently in the request queue.
      +RDY
      +Specifies to hold all jobs currently in the ready queue.
      +Required: Yes, unless job number is used.
    • +
    +
  • +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the individual job number to hold. Omit if Q is specified.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Holds the entire RDYQ:

    +
      +
    • zowe ca7 commands hold --q RDY
    • +
    +
  • +
+

zoweca7commandsjclovrd

+

The JCLOVRD command establishes or satisfies JCL override requirements.

+

Usage

+

zowe ca7 commands jclovrd [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the CA 7 job number of the job in the request queue for which to establish or
      +remove the override requirement.
      +Limits: 1 to 4 numeric characters

      +
    • +
    +
  • +
  • +

    --set (string)

    +
      +
    • +

      example: ON
      +Specifies to establish or satisfy JCL override requirements.
      +When a job fails with a JCL error, the JCL override requirement is automatically
      +set to ON when the job returns to the request queue.

      +

      ON
      +Establishes a JCL override requirement for the specified job.
      +The SET=ON option is used for jobs in the request queue to indicate that
      +an override is needed before execution is to occur.
      +OFF
      +Satisfies a JCL override requirement for the specified job. The SET=OFF option indicates that a previously defined
      +need (requirement) for overrides has been satisfied and execution can be safely attempted.
      +When a JCL override requirement is set to OFF,
      +that requirement no longer appears on a requirements list for the job
      +When a REPL is done from the QM.5 panel, the JCL override requirement is automatically set to OFF.
      +WLM
      +Sets job to allow the insertion of SCHENV= keyword on the JOB
      +statement at submission time when these conditions are true:
      +The scheduling environment insertion feature is activated.
      +A scheduling Environment VRM definition is attached to the job (or SCHENV global default).
      +NOWLM
      +Sets job to suppress the insertion of a SCHENV= keyword on the JOB statement at submission
      +time even when one is typically associated with the job.
      +This option can be used when the validation of an associated IBM WLM scheduling environment
      +has failed causing the job to be requeued (see Browse message SSM0-42).
      +FSetting the NOWLM option lets you submit the job without SCHENV= keyword insertion.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Satisfies JCL override ca7 number 0016:

    +
      +
    • zowe ca7 commands jclovrd --ca7num 0016 --set ON
    • +
    +
  • +
+

zoweca7commandspost

+

The POST command indicates to the CA Workload Automation CA 7 Editionsystem that a preexecution requirement for a job in the request queue is satisfied

+

Usage

+

zowe ca7 commands post [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Indicates the job number in up to four digits, for which requirements are posted.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --usr (string)

    +
      +
    • +

      example: USER WILL CALL TO RELEASE
      +(Optional) Identifies a user-defined description of a requirement to post as satisfied.
      +Mutually exclusive with DEPJOB and DSN.
      +When used, must match the text that is used to define the requirement on the DB.6 panel or with the ADDRQ command.

      +

      Limits: 1 to 36 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --depjob (string)

    +
      +
    • +

      example: PAYJOB
      +(Optional) Identifies a predecessor job dependency requirement to post as satisfied.
      +Value must be a specific job name.
      +Mutually exclusive with DSN and USR.

      +

      In normal situations, CA WA CA 7 Edition automatically posts this type of requirement when the predecessor job completes its execution successfully.
      +A manual posting is only necessary if a job defined as a requirement was not to be run,
      +or ran unsuccessfully and a successor job is to be run.The DEPJOB must be posted if it is not currently defined to CA WA CA 7 Edition
      +(an external job).
      +Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --dsn (string)

    +
      +
    • +

      example: CA7.DSN1
      +(Optional) Identifies a data set requirement to post as satisfied.
      +Value can be a specific data set name or a CA WA CA 7 Edition data set number.
      +If you are using a number, only the number can be specified without the DS prefix.

      +

      Mutually exclusive with DEPJOB and USR.
      +dsname
      +Indicates a specific data set name.
      +Limits: 1 to 44 alphanumeric characters
      +dsnumber
      +Indicates a specific data set number.
      +Limits: 1 to 8 numeric characters

      +
    • +
    +
  • +
  • +

    --internal (string)

    +
      +
    • example: YES
      +(Optional) Valid only with DSN to indicate that the data set being posted is internal to the CA WA CA 7 Edition workload.
      +YES is the only acceptable value.
      +Mutually exclusive with USR, DEPJOB, and PREQ.
      +In normal situations, CA WA CA 7 Edition automatically posts requirements for internal data sets.
      +Limits: YES is the only acceptable value.
    • +
    +
  • +
  • +

    --preq (string)

    +
      +
    • example: (17,19,20,32)
      +(Optional) Valid only with DSN to identify up to 11 numeric values to include
      +with other CA WA CA 7 Edition log data logged as a result of the POST command being issued.
      +Mutually exclusive with USR, DEPJOB, and INTERNAL.
      +Code values in sublist form, within parentheses.
      +You can code up to 11 values that are separated by commas between the parentheses.
      +Each value cannot exceed 4 numeric digits.
      +This optional field can be useful for logging any meaningful numbers, such as batch numbers, which can later be reviewed in the log data set.
    • +
    +
  • +
  • +

    --rmtjob (string)

    +
      +
    • +

      example: RMT_JOB

      +

      Names the job in the remote scheduler that is required by the job specified in the JOB field.
      +Limits: RMTJOB should accept up to 64 characters
      +valid characters are a-z, A-Z, 0-9, period (.), underscore (_), hyphen (-),
      +colon (:), and pound (#); do not include embedded spaces or tabs.

      +
    • +
    +
  • +
  • +

    --rmtschd (string)

    +
      +
    • +

      example: AP1

      +

      Names the remote scheduler where the predecessor job runs.
      +Before adding this requirement, the remote scheduler must be defined.
      +The remote scheduler defined as type LOCAL cannot be specified.
      +Limits: 1 to 3 alphanumeric characters; generic specification not supported.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    The requirement for ca7 number 0016 in the request queue is satisfied:

    +
      +
    • zowe ca7 commands post --ca7num 0016
    • +
    +
  • +
+

zoweca7commandsprscf

+

The PRSCF command frees a shared, exclusive, or RCT resource that is connected to a job

+

Usage

+

zowe ca7 commands prscf [options]

+

Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      example: 1234

      +

      Specifies the CA Workload Automation CA 7 Edition job name or number to which the resource is attached.
      +jobnumber
      +Indicates a specific CA 7 job number.
      +Limits: 1 to 4 numeric characters

      +
    • +
    +
  • +
  • +

    --rsrc (string)

    +
      +
    • +

      example: RESOURCE.TYPE2.EXEC

      +

      Specifies the fully qualified resource name to free.
      +You can optionally specify * to indicate to free all resources that are connected to the job.
      +Limits: 1 to 44 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --force (string)

    +
      +
    • +

      example: YES

      +

      (Optional) FORCE=YES indicates that CA WA CA 7 Edition is not to evaluate

      +

      the availability of the named resources for this run of the job only.
      +This run of the job does not use the named resources.
      +This keyword can be used on an exception basis to let a job in a
      +W-RSRC status bypass VRM checking for one or more resources defined for it on the RM.1 panel.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Frees a shared resource name, ZOWECRM1 that attached to the job 1234:

    +
      +
    • zowe ca7 commands prscf --job 1234 --rsrc ZOWECRM1
    • +
    +
  • +
+

zoweca7commandsprsqa

+

The PRSQA command activates a corequisite resource

+

Usage

+

zowe ca7 commands prsqa [options]

+

Options

+
    +
  • +

    --rsrc (string)

    +
      +
    • +

      example: CICSREG8

      +

      Specifies a fully qualified corequisite resource name.
      +Limits: 1 to 44 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --internal (string)

    +
      +
    • +

      example: YES

      +

      (Optional) If YES or Y is specified, the command is not forwarded to other CA 7 instances

      +

      even if VRM Corequisite Propagation is enabled and the resource name matches the selection criteria.

      +

      Default: NO

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Activates a corequisite resource name CICSREG8:

    +
      +
    • zowe ca7 commands prsqa --rsrc CICSREG8
    • +
    +
  • +
+

zoweca7commandsrelease

+

Release a single job to CA 7.

+

Usage

+

zowe ca7 commands release [options]

+

Options

+
    +
  • +

    -q (string)

    +
      +
    • +

      Q={REQ|RDY}

      +

      Indicates to release the contents of an entire queue. Omit Q when JOB or JOBL is specified.

      +

      REQ
      +Release the contents of the request queue.

      +

      RDY
      +Release the contents of the ready queue.

      +
    • +
    +
  • +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the name of the job number to release.
      +Indicates the individual job to release. JOB is required to release a specific job. Omit JOB when JOBL or Q is specified.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Release ca7 number 0016 from CA 7:

    +
      +
    • zowe ca7 commands release --ca7num 0016
    • +
    +
  • +
+

zoweca7commandsrequeue

+

Re-queues jobs from the ready or active queues back to the request queue.

+

Usage

+

zowe ca7 commands requeue [options]

+

Options

+
    +
  • +

    --agent (string)

    +
      +
    • +

      example: UXAGENT
      +(Optional) Indicates the agent name or mask that an agent name must match for an agent job

      +

      before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
      +AGENT cannot be used with CPU, MAINID, or NODE.
      +For any agent job that is requeued, a cancel request is sent to the agent running the job.
      +The status of the agent or the computer on which the agent is running determines whether the request is honored.
      +Limits: 1 to 16 alphanumeric charactersDefault: * (all agent names)

      +
    • +
    +
  • +
  • +

    --cpu (string)

    +
      +
    • example: 34
      +(Optional) Used with JOB to specify the CPU ID of active queue jobs that are to be requeued.
      +The value identifies the CPU and corresponds to the CPU field displayed on the LQ command (the SMF identifier).
      +CPU cannot be used with MAINID, NODE, or AGENT.
      +The CPU parameter is ignored if used with a JOB parameter that references a specific job name or job number, but not if a job mask is specified.
      +Limits:
      +1 to 4 numeric characters
    • +
    +
  • +
  • +

    --force (string)

    +
      +
    • example: CMP
      +(Optional) Resumes job completion for stranded jobs.
      +When a job finishes executing, it must move to the request queue so that CA WA CA 7 Edition
      +can process the database and queue updates that are required for job completion.
      +But, if a job cannot be moved because of an I/O error or an out-of-space condition on the request queue,
      +the job may be stranded in the ready or active queue, unable to complete
      +Once the request queue error is corrected, you can use REQUEUE with FORCE=CMP to resume job completion for these jobs.
      +Limits: CMP is the only value
    • +
    +
  • +
  • +

    --ca7num (string)

    +
      +
    • example: 0029
      +(Optional) Indicates the job number
      +must match before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
      +If JOB is used alone, both the active and ready queues are searched for the specified job number.
      +If JOB is used with Q, the search is restricted to the indicated queue. jobname,jobnumber and longjobname are mutually exclusive
      +Default:
      +* (all jobs)Limits:
      +1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --jobname | --jn (string)

    +
      +
    • example: PAYROLL
      +(Optional) Indicates the job name, or mask that a job name
      +must match before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
      +If JOB is used alone, both the active and ready queues are searched for the specified job.
      +If JOB is used with Q, the search is restricted to the indicated queue. jobname,jobnumber and longjobname are mutually exclusive.
      +Default:
      +* (all jobs)Limits:
      +1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --longjobname | --ljn (string)

    +
      +
    • example: ALONGJOBNAME
      +(Optional) Indicates the long job name or mask that a long job name must match before
      +it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
      +If JOBL is used alone, both the active and ready queues are searched for the specified long job name.
      +If JOBL is used with Q, the search is restricted to the indicated queue.jobname,jobnumber and longjobname are mutually exclusive
      +Limits: 1 to 64 alphanumeric characters
    • +
    +
  • +
  • +

    --mainid (string)

    +
      +
    • example: ALL|SY2|/SY3
      +(Optional) Used with JOB to indicate that only those jobs in the ready queue with this MAINID are to be requeued.
      +Value must be specified as a single MAINID name.
      +MAINID cannot be used with CPU, NODE, or AGENT.
      +The MAINID parameter is ignored if used with a JOB parameter that references a specific job name or job number, but not if a job mask is specifie_
      +The name must be one of the following values:
      +ALL Indicates that all MAINIDs are considered.
      +SYn Where n indicates a CPU assigned number as defined in the initialization file CPU statement.
      +The value of n can range from 1 to 7.
      +/SYn
      +Where n indicates a CPU assigned number. The / indicates “not this MAINID.
      +The value of n can range from 1 to 7.
      +Limits: 1 to 4 alphanumeric characters
    • +
    +
  • +
  • +

    --node (string)

    +
      +
    • example: NODEXP
      +(Optional) Indicates the node name or mask that a node name must match for an XPJOB job,
      +before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
      +NODE cannot be used with CPU, MAINID, or AGENT.
      +For any XPJOB that is requeued, a cancel request is sent to the node where the job is running
      +(assuming the initialization file XPDEF statement parameter XPKILL=NO is not set).
      +The status of the node or the computer that the node points to, determines whether the request is honored.
      +Limits:
      +1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    -q (string)

    +
      +
    • +

      q=RDY

      +

      Used with JOB to indicate in which queue the job search is to occur
      +ACT The active queue. RDY The ready queue.

      +
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • (Optional) Flags the job after it returns to the request queue with a status of JCLERR instead of REQUE.
      +If not coded, the status reflects REQUE.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Requeues jobs in the ready queue back to the request queue:

    +
      +
    • zowe ca7 commands requeue --q RDY
    • +
    +
  • +
+

zoweca7commandsresolv

+

Work that is scheduled by a trigger or on-request work that is DEMANDed or RUN has no direct relationship to a base calendar and therefore does not require the use of this function.

+

Usage

+

zowe ca7 commands resolv [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      example: AJOB*

      +

      Limits selection for resolution to the jobs specified. If omitted, all job schedules are candidates for resolution. Value can be a specific job name or a generic name that identifies multiple jobs beginning with the specified characters.
      +An asterisk (*) must be used to delimit the generic job name. The asterisk can appear in any of the eight positions but must immediately follow the last significant character of the job name requested.
      +For example:
      +AB* causes all jobs beginning with AB to be selected for resolution.
      +* causes all job schedules to be selected for resolution.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --duplicateDate | --ddate (string)

    +
      +
    • +

      example: NO

      +

      Indicates whether to produce specific duplicate day messages (SRC1-137) each time that two or more schedule IDs for the same job schedule a given day.
      +The default is NO unless the extended resolve message option is set in the user profile by the /PROF command.

      +
    • +
    +
  • +
  • +

    --oldYear | --oyr (string)

    +
      +
    • +

      example: 22

      +

      Specifies the year that is defined in the schedule member data (the value that is supplied by YEAR in the previous resolution that updated the schedule member).
      +Only those candidate schedule members whose year data matches the OLDYR value are selected for resolution.
      +If used, use one of the following values:
      +empty: It is default, if omitted, only those schedule members that have not previously been resolved or whose schedules have expired are selected.
      +yy: Indicates a specific year.
      +*: Indicates all years and all schedules.

      +
    • +
    +
  • +
  • +

    --print (string)

    +
      +
    • +

      example: YES

      +

      Specifies whether to display a month-by-month schedule day calendar after resolution of the defined member is complete.
      +If used, value must be YES or NO (default).

      +
    • +
    +
  • +
  • +

    --scal (string)

    +
      +
    • +

      example: 22

      +

      Value is the xx portion of the base calendar name, SCALyyxx.
      +The SCAL value must also match the base calendar identifier (SCAL) specified in any SCHID of the schedule definition for the individual jobs.
      +This value is used during the selection process of resolution to determine which schedule members to resolve.
      +Required: No (unless JOB is omitted)
      +*: Indicates all SCALs.
      +xx: Indicates a specific SCAL.

      +
    • +
    +
  • +
  • +

    --test (string)

    +
      +
    • +

      example: NO

      +

      Indicates whether schedule members are updated because of the resolution process. YES and NO are the only allowable values.
      +YES: Normal resolution occurs and all messages are printed, but no updating of the database occurs.This option can be used at a year-end or whenever a base calendar is changed to see the results of the resolution activity, without actually changing the schedule mask or affecting the current schedule process. YES is the default.
      +NO: Normal resolution occurs and all messages are printed, and updating of the database occurs.

      +
    • +
    +
  • +
  • +

    --year (string)

    +
      +
    • +

      example: 20

      +

      Identifies the year of the base calendars against which the schedule is resolved. The value is the number that is the yy portion of the base calendar name, SCALyyxx.
      +When a schedule is successfully updated, the YEAR value becomes part of the schedule data (see OLDYR). If the YEAR parameter is not specified, the current year is assumed to be the year from the system internal date and time.
      +Also, if YEAR is not coded on the RESOLV, a determination is made to see whether the RESOLV is made within the period January 1 through June 30 as determined from system date and time.
      +If so, the schedule is resolved against January through December of the current year. If a RESOLV is done within the period July 1 through December 31, the schedule is resolved against July 1 through December 31 of the current year and January 1 through June 30 of the next year.
      +This behavior requires the existence of base calendars for calendar years involved. If a required base calendar is not available, an error message is issued. The schedule member is unresolved, unless a perpetual calendar is defined for this SCALyyXX. In that case, the calendar is generated from the PCALYYXX member in the perpetual calendar data set. YEAR is optional. If YEAR is specified, the resolution is made against January through December of the year specified.
      +Default: Current year
      +Limits: 2 numeric characters

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates or modifies processing schedules for jobs, AJOB from CA 7:

    +
      +
    • zowe ca7 commands resolv --job AJOB
    • +
    +
  • +
+

zoweca7commandsrestart

+

Restart a single job to CA 7.

+

Usage

+

zowe ca7 commands restart [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the name of the job to Restart.
      +Indicates the individual job to Restart, and the value must be a CA 7 job number.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --bypgdg | --bp (string)

    +
      +
    • +

      bypgdg={NO|YES|VER|CAT}

      +

      Indicates whether CA Workload Automation Restart Option for z/OS Schedulers bypasses GDG logic on a restart/rerun.
      +Value can be NO, YES, VER, or CAT.

      +

      Default: CA Workload Automation Restart Option for z/OS Schedulers default value

      +
    • +
    +
  • +
  • +

    --condcd | --cc (string)

    +
      +
    • +

      condcd=nnnn

      +

      Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers condition code
      +that the CA Workload Automation Restart Option for z/OS Schedulers step sets when the rerun is executed.

      +

      This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use
      +and CA Workload Automation CA 7® Edition is inserting the RMS step.
      +See the INSERT-RMS field on the DB.1 panel.

      +

      Limits: 1 to 4 numeric characters from 0 to 4095

      +
    • +
    +
  • +
  • +

    --forcecomp | --fc (string)

    +
      +
    • +

      forcecomp={NO|YES}

      +

      Indicates whether to flag the job as a normal completion.
      +If FORCECOMP=YES, the previous abnormal status of the job is ignored.

      +

      Normal job completion processing is performed instead of a restart.
      +Value can be NO or YES. NO is the default.

      +
    • +
    +
  • +
  • +

    --lcc (string)

    +
      +
    • +

      lc=nnnn

      +

      Indicates an optional condition code value that replaces the last
      +condition code value for the step that the LSTP references and, optionally, LPSTP keywords.

      +

      This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.

      +

      Default: 0
      +Limits: 1 to 4 numeric characters from 0 to 4095

      +
    • +
    +
  • +
  • +

    --lstp (string)

    +
      +
    • +

      lstp=JS050

      +

      Indicates an optional step name that has its last condition code value reset in the
      +CA Workload Automation Restart Option for z/OS Schedulers CMT.

      +

      Code LSTP and LCC when LPSTP is specified.
      +LSTP requires that an STPSTRT value is specified and that the LSTP step name occurs in the JCL of the job before the STPSTRT step name.

      +

      This option is honored only when CA Workload Automation Restart Option for z/OS Schedulers is in use.

      +

      Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --lpstp (string)

    +
      +
    • +

      lpstp=COPY010

      +

      Indicates an optional step name referencing a procedure that has its last condition code value reset
      +in the CA Workload Automation Restart Option for z/OS Schedulers CMT.

      +

      If LPSTP is used, also code LSTP and LCC.
      +This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.

      +

      Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --procstrt | --ps (string)

    +
      +
    • +

      procstrt=procname

      +

      Indicates an optional step name referencing a procedure where processing is to start.
      +If PROCESS=R and PROCSTRT are used, also code STPSTRT.

      +

      This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.

      +

      Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --procend | --pe (string)

    +
      +
    • +

      procend=procname

      +

      Indicates an optional step name referencing a procedure where processing is to end.

      +

      If PROCESS=R and PROCEND are used, code STPEND.
      +This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.

      +

      Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --process (string)

    +
      +
    • +

      process=code

      +

      Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers processing function code character to use in the restart/rerun.

      +

      This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use
      +and CA WA CA 7 Edition is inserting the RMS step.

      +

      See the INSERT-RMS field on the DB.1 panel. Value can be F, P, S, N, O, or R.

      +

      Default: P
      +Limits: 1 alphabetic character

      +
    • +
    +
  • +
  • +

    --reason | -r (string)

    +
      +
    • +

      reason=text

      +

      Specifies a reason for the restart.
      +If the CA Workload Automation Restart Option for z/OS Schedulers Reason-for-Rerun module is available,
      +a code of up to four characters can be input and it is expanded.

      +

      Any reason input or expanded is copied to the run log.

      +

      This field is optional unless CA Workload Automation Restart Option for z/OS Schedulers requires a reason or
      +REASON=YES was specified in the RESTART statement in the initialization file.

      +

      Limits: 1 to 40 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --stpend | --se (string)

    +
      +
    • +

      stpend=stepname

      +

      Indicates an optional step name or number at which processing is to end.
      +If not specified, the last step of the job is assumed to be the ending step.

      +

      Code STPEND when PROCEND is specified.
      +This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.

      +

      Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --stpstrt | --ss (string)

    +
      +
    • +

      stpstrt={stepname|*CMT*|*RERUN*|*RESUBP*}

      +

      Indicates an optional step name or number at which processing is to start.
      +If STPSTRT is not coded, the first step of the job is assigned to be the starting step.

      +

      Code STPSTRT when PROCSTRT is specified. This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
      +It can be one of

      +

      stepname
      +Specifies the step name or number at which processing is to start.

      +

      *CMT*
      +Indicates that the job is to restart with the step values currently on the CMT record.

      +

      *RERUN*
      +Indicates to rerun t the total job. If there are no restartable steps, specify RERUN.

      +

      *RESUBP*
      +Indicates that the CMT record of the job is set to production, and then the job is submitted.

      +
    • +
    +
  • +
  • +

    --sup11stp | --su (string)

    +
      +
    • +

      sup11stp={NO|YES}

      +

      Indicates whether to suppress the insertion of the CA Workload Automation Restart Option for z/OS Schedulers RMS step.

      +

      If the job is resubmitted with SUP11STP=YES, the CA Workload Automation Restart Option for z/OS Schedulers step is not inserted.

      +

      Only valid if CA WA CA 7 Edition is inserting the CA Workload Automation Restart Option for z/OS Schedulers step.

      +

      See the INSERT-RMS field on the DB.1 panel.
      +Value can be NO or YES. NO is the default.

      +
    • +
    +
  • +
  • +

    --usage (string)

    +
      +
    • +

      usage=code

      +

      Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers
      +usage code of the character to use in the restart/rerun.

      +

      For the values, see the CA Workload Automation Restart Option for z/OS Schedulers documentation.

      +

      This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use and
      +CA WA CA 7 Edition is inserting the RMS step.

      +

      See the INSERT-RMS field on the DB.1 panel.
      +Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --ca11rstp | -c (string)

    +
      +
    • +

      ca11rstp={Y|YES}

      +

      Displays the CA11 restart step. Value can be Y or YES.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Restart ca7 number, 0016 from CA 7:

    +
      +
    • zowe ca7 commands restart --ca7num 0016
    • +
    +
  • +
+

zoweca7commandsrmtsub

+

The RMTSUB command is used by a scheduling product that has a remote job dependency on a CA 7 job.

+

Usage

+

zowe ca7 commands rmtsub [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      job=0123

      +

      Specifies the CA Workload Automation CA 7 Edition job name or number to which the resource is attached.
      +1-4 numeric characters, specifies the CA7 job number

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --rmtschd (string)

    +
      +
    • +

      example: AP1

      +

      Names the remote scheduler where the predecessor job runs.
      +Before adding this requirement, the remote scheduler must be defined.
      +The remote scheduler defined as type LOCAL cannot be specified.
      +Limits: 1 to 3 alphanumeric characters; generic specification not supported.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Rmtsub job, 0123 to CA 7:

    +
      +
    • zowe ca7 commands rmtsub --job 0123
    • +
    +
  • +
+

zoweca7commandsrmttrk

+

The RMTTRK defines a dependency on a job in a remote CA 7 workload.

+

Usage

+

zowe ca7 commands rmttrk [options]

+

Required Options

+
    +
  • +

    --remote-sched | --rs (string)

    +
      +
    • +

      remote-sched=AS1

      +

      The name of publishing scheduler that issues this RMTTRK command.
      +Must be defined to receiving CA7ONL using XN.7.
      +This name is provided to the remote scheduler at subscription time.
      +Limists: 1-4 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --job-name | --jn (string)

    +
      +
    • +

      job-name=PAYJOB

      +

      The name of job running in the publishing scheduler that invokes this command.
      +Limits: Autosys job names can be up to 64 characters.Valid characters are a-z, A-Z, 0-9, period (.),underscore (_), hyphen (-), colon (:), and pound (#).Do not include embedded spaces or tabs.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --status (string)

    +
      +
    • +

      status=FAILURE

      +

      The status of job named on job-name.
      +The analogue of this service in AutoSys is change-status-job which supports these values:
      +FAILURE, INACTIVE, RUNNING, STARTING, SUCCESS, TERMINATED

      +
    • +
    +
  • +
  • +

    --date-time-status-changed | --dtsc (string)

    +
      +
    • +

      date-time-status-changed=2021-08-12T10:12:13.680000-04:00

      +

      Date/time remote scheduler detected status change reported by the STATUS keyword.
      +Limits: ISO8601 character format.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Rmttrk job name JOB123 to CA 7:

    +
      +
    • zowe ca7 commands rmttrk --jn JOB123
    • +
    +
  • +
+

zoweca7commandsrun

+

Run a single job to CA 7.

+

Usage

+

zowe ca7 commands run [options]

+

Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      job=PAYROLL

      +

      Defines the long name of the job to run.
      +The ran jobs are placed in the request queue and assigned a unique CA 7 job number.

      +
    • +
    +
  • +
  • +

    --jobl (string)

    +
      +
    • +

      job=payrollSW123

      +

      Identifies the job to submit.
      +The value must be a long job name.
      +If the job has not been defined in the database, use JOB instead.
      +See also JCLID. JOB and JOBL are mutually exclusive.
      +Limits:
      +1 to 64 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --arfset | --as (string)

    +
      +
    • +

      arfset={arfsetname|**NONE**}

      +

      Defines the ARF set name that is used for this run of the job.
      +If you specify **NONE**, no ARF processing is performed for this run of the job.

      +

      Limits: 1 to 8 alphanumeric characters or **NONE**

      +
    • +
    +
  • +
  • +

    --class (string)

    +
      +
    • +

      class=n

      +

      Defines the workload balancing class for resource checking.

      +

      Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --dotm (string)

    +
      +
    • +

      dotm=hhmm

      +

      Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
      +If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.

      +

      If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.

      +

      Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59

      +

      Required: No (unless DATE is used, if so, DOTM or TIME must be specified)

      +
    • +
    +
  • +
  • +

    --exec | -e (string)

    +
      +
    • +

      exec={NO|YES}

      +

      Specifies whether to execute the job (YES/NO).
      +If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.

      +

      Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.

      +
    • +
    +
  • +
  • +

    --jclid | --ji (string)

    +
      +
    • +

      jclid=10

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.

      +
    • +
    +
  • +
  • +

    --jcllib | --jl (string)

    +
      +
    • +

      jcllib=&SPECIAL

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)

      +
    • +
    +
  • +
  • +

    --late (string)

    +
      +
    • +

      late={NO|YES}

      +

      Specifies whether a notification occurs when the job becomes late.
      +Specify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.

      +
    • +
    +
  • +
  • +

    --leadtm | --lt (string)

    +
      +
    • +

      leadtm={0100|hhmm}

      +

      Specifies the lead (processing) time that is required for the job to run.
      +If omitted, 1 hour is usedFormat: hhmm
      +Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59You can omit leading zeros.

      +
    • +
    +
  • +
  • +

    --mainid | --mi (string)

    +
      +
    • +

      mainid={ALL|SYn|/SYn|-SYn}

      +

      Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
      +The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:

      +

      ALL
      +Specifies all CPUs are acceptable for executing the job.

      +

      SYn
      +n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.

      +

      /SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      -SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --rms (string)

    +
      +
    • +

      rms={NO|YES}

      +

      Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.

      +

      Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.

      +

      The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
      +Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
      +Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --schid | --si (string)

    +
      +
    • +

      schid={1|nnn}

      +

      Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.

      +

      Default: 1
      +Limits: 1 to 3 numeric characters from 1 to 999 (See Note)

      +

      No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)

      +
    • +
    +
  • +
  • +

    --time (string)

    +
      +
    • +

      time={hhmm|+hhmm}

      +

      Establishes a submit time-of-day requirement for the job.

      +

      Format: hhmm
      +Defines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).
      +Leading zeros are not required

      +
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • +

      type={CLOCK|END|RES|START}

      +

      Indicates that the job is being scheduled for rerun.
      +The value must be specified as shown.

      +

      TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Run a job, PAYROLL to CA 7:

    +
      +
    • zowe ca7 commands run --job PAYROLL
    • +
    +
  • +
+

zoweca7commandsrunh

+

Run and hold a single job to CA 7.

+

Usage

+

zowe ca7 commands runh [options]

+

Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      job=PAYROLL

      +

      Defines the long name of the job to run.
      +The ran jobs are placed in the request queue and assigned a unique CA 7 job number.

      +
    • +
    +
  • +
  • +

    --jobl (string)

    +
      +
    • +

      job=payrollSW123

      +

      Identifies the job to submit.
      +The value must be a long job name.
      +If the job has not been defined in the database, use JOB instead.
      +See also JCLID. JOB and JOBL are mutually exclusive.
      +Limits:
      +1 to 64 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --arfset | --as (string)

    +
      +
    • +

      arfset={arfsetname|**NONE**}

      +

      Defines the ARF set name that is used for this run of the job.
      +If you specify **NONE**, no ARF processing is performed for this run of the job.

      +

      Limits: 1 to 8 alphanumeric characters or **NONE**

      +
    • +
    +
  • +
  • +

    --class (string)

    +
      +
    • +

      class=n

      +

      Defines the workload balancing class for resource checking.

      +

      Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --dotm (string)

    +
      +
    • +

      dotm=hhmm

      +

      Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
      +If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.

      +

      If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.

      +

      Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59

      +

      Required: No (unless DATE is used, if so, DOTM or TIME must be specified)

      +
    • +
    +
  • +
  • +

    --exec | -e (string)

    +
      +
    • +

      exec={NO|YES}

      +

      Specifies whether to execute the job (YES/NO).
      +If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.

      +

      Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.

      +
    • +
    +
  • +
  • +

    --jclid | --ji (string)

    +
      +
    • +

      jclid=10

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.

      +
    • +
    +
  • +
  • +

    --jcllib | --jl (string)

    +
      +
    • +

      jcllib=&SPECIAL

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)

      +
    • +
    +
  • +
  • +

    --late (string)

    +
      +
    • +

      late={NO|YES}

      +

      Specifies whether a notification occurs when the job becomes late.
      +Specify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.

      +
    • +
    +
  • +
  • +

    --leadtm | --lt (string)

    +
      +
    • +

      leadtm={0100|hhmm}

      +

      Specifies the lead (processing) time that is required for the job to run.
      +If omitted, 1 hour is usedFormat: hhmm
      +Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59You can omit leading zeros.

      +
    • +
    +
  • +
  • +

    --mainid | --mi (string)

    +
      +
    • +

      mainid={ALL|SYn|/SYn|-SYn}

      +

      Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
      +The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:

      +

      ALL
      +Specifies all CPUs are acceptable for executing the job.

      +

      SYn
      +n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.

      +

      /SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      -SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --rms (string)

    +
      +
    • +

      rms={NO|YES}

      +

      Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.

      +

      Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.

      +

      The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
      +Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
      +Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --schid | --si (string)

    +
      +
    • +

      schid={1|nnn}

      +

      Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.

      +

      Default: 1
      +Limits: 1 to 3 numeric characters from 1 to 999 (See Note)

      +

      No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)

      +
    • +
    +
  • +
  • +

    --time (string)

    +
      +
    • +

      time={hhmm|+hhmm}

      +

      Establishes a submit time-of-day requirement for the job.

      +

      Format: hhmm
      +Defines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).
      +Leading zeros are not required

      +
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • +

      type={CLOCK|END|RES|START}

      +

      Indicates that the job is being scheduled for rerun.
      +The value must be specified as shown.

      +

      TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Run and holds a job, PAYROLL to CA 7:

    +
      +
    • zowe ca7 commands runh --job PAYROLL
    • +
    +
  • +
+

zoweca7commandssubmit

+

The SUBMIT top line command modifies and expedites the process of job submission for jobs already residing in the queues

+

Usage

+

zowe ca7 commands submit [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the name of the job to Submit.
      +Indicates the individual job to Submit, and the value must be a CA 7 job number.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --express | --ex (string)

    +
      +
    • +

      example: YES

      +

      (Optional) Indicates to place the job ahead of all other jobs (those jobs without EXPRESS=YES) for submission.

      +

      The value must be coded as shown. Not valid if workload balancing is being used.

      +

      Use of EXPRESS=YES does not establish an increased execution priority for a job.

      +

      Rather, it ensures that nonexpress jobs are not submitted ahead of a job that is flagged as an express job.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit ca7 number, 0016 to CA 7:

    +
      +
    • zowe ca7 commands submit --ca7num 0016
    • +
    +
  • +
+

zoweca7commandssubtm

+

SUBTM modifies the required submit time-of-day for a job in the request queue

+

Usage

+

zowe ca7 commands subtm [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Specifies the CA 7 job number of the job or which you want to add, modify, or remove a submit time-of-day requirement.

      +

      Limits: 1 to 4 alphanumeric characters

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --time | --tm (string)

    +
      +
    • +

      example: 1830

      +

      (Optional) Specifies the new submit time-of-day in hours and minutes.

      +

      TIME is required to add a submit time-of-day requirement when none exists or to change an existing requirement.

      +

      If TIME is omitted, an existing submit time-of-day restriction is removed. Format:hhmm

      +

      Defines the time-of-day where hh is hours (0 through 24) and

      +

      mm is minutes (00 through 59). Maximum is 2400.

      +

      If the value given is less than the current time (when the command is processed), the submit day is incremented by one.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Modifies the required submit time for a ca7 number, 0016:

    +
      +
    • zowe ca7 commands subtm --ca7num 0016
    • +
    +
  • +
+

zoweca7commandsverify

+

The VERIFY command establishes or satisfies a manual verification requirement for a currently scheduled run of the job in the request queue before its execution.

+

Usage

+

zowe ca7 commands verify [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Specifies the CA 7 job number of the job or which you want to add, modify, or remove a submit time-of-day requirement.

      +

      Limits: 1 to 4 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --set (string)

    +
      +
    • +

      example: ON

      +

      Sets the verification requirement.

      +

      ON

      +

      Establishes a manual verification requirement that did not previously exist.

      +

      OFF

      +

      Indicates that a previously established manual verification requirement is satisfied and can be

      +

      removed. A verification requirement no longer appears on the requirements list in the request queue.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Specifies a verification requirement for ca7 number, 0016:

    +
      +
    • zowe ca7 commands verify --ca7num 0016
    • +
    +
  • +
+

zoweca7create-job-definition

+

All the available commands are listed in the COMMANDS section.

+

zoweca7create-job-definitionreq-predecessor

+

Creates predecessor requirement for a job.

+

Usage

+

zowe ca7 create-job-definition req-predecessor [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job that requires the predecessor
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • The schedule id of requiring job
    • +
    +
  • +
  • +

    --predtype (string)

    +
      +
    • The predecessor type
    • +
    +
  • +
  • +

    --nextrun (string)

    +
      +
    • The status of predecessor for next run of job
      +[ YES, ONLY, SKIP ]
    • +
    +
  • +
  • +

    --predobject (string)

    +
      +
    • The predecessor. Values vary with predtype.
      +The predecessor. Values vary with predtype.
      +When “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.
      +When “predtype”:”USER” then “predobject” is 1-44 character user requirement text.
    • +
    +
  • +
+

Options

+
    +
  • +

    --leadtime (string)

    +
      +
    • The satisfaction lead time in hours.
      +This may be honored when “predtype” is “job or “DSN”
    • +
    +
  • +
  • +

    --permanent (string)

    +
      +
    • Indicates that this predecessor is permanent, that is always considered satisfied.
      +This parameter only applies when “predtype” is “DSN”
      +[ Y, N ]
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create requirement predecessor for job TESJOB1 with the parameters:

    +
      +
    • zowe ca7 create-job-definition req-predecessor --job TESJOB1 --schid 0009 --predtype USER --nextrun ONLY --predobject CA7USER
    • +
    +
  • +
+

zoweca7create-job-definitionschedule

+

Create schedule parameters

+

Usage

+

zowe ca7 create-job-definition schedule [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • Specifies the numeric schedule ID on which the user wants to perform the specified action.
      +Limits: 1 to 3 numeric characters from 1 through 999
    • +
    +
  • +
+

Options

+
    +
  • +

    --scal (string)

    +
      +
    • Specifies the override of the default SCAL for this SCHID. Specify scal if you want to override the default scal.
      +Limits: 2 alphanumeric characters
    • +
    +
  • +
  • +

    --default-scal | --dscal (string)

    +
      +
    • Specifies the default SCAL for this job. If this is not specified, an LJOB will be issued to fetch the SCAL
      +Limits: 2 alphanumeric characters
    • +
    +
  • +
  • +

    --due-out-time | --dot (string)

    +
      +
    • Specifies the due-out time of day for this schedule ID.
      +Limits: 4 numeric characters that are specified as hhmm
      +where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
    • +
    +
  • +
  • +

    --lead-time | --lt (string)

    +
      +
    • Specifies the due-out time of day for this schedule ID.
      +Limits: 4 numeric characters that are specified as hhmm
      +where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
    • +
    +
  • +
  • +

    --submit-time | --st (string)

    +
      +
    • Specifies the submit time of day for this schedule ID.
      +If specified, the job is not submitted before this time.
      +If the submit time is before deadline start time,
      +the submit time requirement is automatically satisfied when the job enters the queue.
      +A submit time of zeros is the same as not specifying it, and no submit time is set up.
      +Note:If the submit time is after the due-out time, the submit day value is set to the previous day.
      +Limits: 4 numeric characters that are specified as hhmm
      +where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
    • +
    +
  • +
  • +

    --daily (string)

    +
      +
    • Specifies that the user wants to define a daily schedule.
      +Daily means every available processing day as defined by the Base Calendar.
      +If DAILY is used, the ROLL has no effect.
      +Limits: One of Y or N
    • +
    +
  • +
  • +

    --roll (string)

    +
      +
    • Specifies the action to take when a schedule day falls on a base calendar non available processing day.
      +This value is not used if the DAILY option is used
      +If DAILY is used, the ROLL has no effect.
      +If used, the value must be one of the following values:
      +B: Roll the schedule back to the previous available processing day in the Base Calendar.
      +F: Roll forward the schedule to the next available processing day.
      +N: Do not roll. Schedule day must stand.
      +D: Do not roll and do not schedule.
      +Default:D
    • +
    +
  • +
  • +

    --index (string)

    +
      +
    • Specifies an adjustment to schedule days.
      +After you exercise the ROLL option, the schedule is adjusted,
      +forward for plus or backward for minus, by the number of working days entered.
      +Limits:4 numeric characters that are specified as Innn where I can be plus (unsigned) or minus (-) and nnn can be 0 to 365 daysUsage:
      +Use this field with the RDAY field to schedule a job to run three workdays before the 15th of the month:
      +specify -3 in the INDEX field, X in the MONTHLY field, and 15 in the RDAY field.
    • +
    +
  • +
  • +

    --interval (string)

    +
      +
    • Specifies that the job should be repeated (executed more than once) and
      +specifies the amount of time between each iteration.
      +If INTERVAL is specified, the SBTM (submit time requirement) and TYPE fields are required.
      +If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.
      +Limits:4 numeric characters in hhmm format where hh can be from 0 to 23 and mm can be from 00 to 59
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • Determines how the submit time requirement is calculated for repeating jobs.
      +A TYPE of CLOCK indicates that the INTERVAL is added to the previous iteration's
      +submit time requirement to determine the new submit time requirement.
      +A TYPE of START and END indicates that the INTERVAL is added to the previous iteration's
      +last (most recent) start and end times,respectively, to determine the new submit time requirement.
      +TYPE is required if INTERVAL is specified.
      +TYPE is discarded if INTERVAL is not specifiedLimits:CLOCK, START, or END
    • +
    +
  • +
  • +

    --count (string)

    +
      +
    • Specifies the maximum number of times to repeat the job.
      +COUNT is discarded if INTERVAL is not specified.
      +If both COUNT and STOP are specified, the job stops repeating when the COUNT reaches zero or the STOP time is reached, whichever comes first.
      +If COUNT is not specified, the job repeats until the STOP time is reached.TYPE is required if INTERVAL is specified. TYPE is discarded if INTERVAL is not specifiedLimits:1 to 4 numeric characters from 0 to 1439. Leading zeros can be discarded.
    • +
    +
  • +
  • +

    --weekly (string)

    +
      +
    • Specifies that the user wants to define a weekly schedule.
      +If WEEKLY is used, the run days of the week must be specified using DAYS field
      +Limits:Y or N
    • +
    +
  • +
  • +

    --days (string)

    +
      +
    • Defines specific days of the week on which to run the job.
      +as comma separated list of day name abbreviations.
      +Limits: A comma separated list of Sun,Mon,Tue,Wed,Thu,Fri,Sat
    • +
    +
  • +
  • +

    --monthly (string)

    +
      +
    • Specifies that the user wants to define a monthly schedule.
      +If this field is used, the user can optionally specify on which particular months the job is to run.
      +If specific months are not specified in the months property, all months are assumed.Limits: Y or N
    • +
    +
  • +
  • +

    --months (string)

    +
      +
    • Defines specific months on which to run the job.
      +as comma separated list of month name abbreviations.
      +Limits: A comma separated list of Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec
    • +
    +
  • +
  • +

    --weeks-of-month | --wom (string)

    +
      +
    • Specifies the weeks of the month to run the job.
      +The values that are specified can be positive (unsigned), negative (-) or slash (/).
      +Positive values 1, 2, 3, 4, or 5 are used to indicate the week relative to the beginning of the month.
      +Negative values -0, -1, and -2 are used to indicate occurrence of week relative to the end of the month.
      +Slashes indicate the job will not run the following value.
      +Limits: 1 to 14 numeric characters and required if MONTHLY and DAY-OF-WEEK are used.
      +The values are separated by comma
    • +
    +
  • +
  • +

    --day-of-week | --dow (string)

    +
      +
    • Specifies which days of the week to run the job.
      +If used, each day must be the first three letters of the wanted run days.
      +If you want to specify multiple days, use a comma separated list for example MON,TUE,FRI.
      +Limits: A comma separated list of SUN, MON, TUE, WED, THU, FRI, SAT, case insensitive
    • +
    +
  • +
  • +

    --relative-day | --rd (string)

    +
      +
    • Specifies relative days of the month on which the job is to run. Used with MONTHLY.
      +A day relative to the beginning or end of the month is specified.
      +If a positive (unsigned) value is used, the job runs that day relative to the first of the month.
      +Also, if you have days of the month when this job is not to run,a slash (/) can be used with the unsigned or negative values.
      +Valid positive values range from 1 to 31.
      +Valid negative values range from -0 to -30.
      +Limits:1 to 60 numeric characters, separated by comma.
      +Note:relative-day(s) represents calendar days, unless the base calendar was generated with OPTIONS=SCHDYONLY,
      +in which case relative-day(s) represents processing days.
    • +
    +
  • +
  • +

    --annual (string)

    +
      +
    • Defines an annual schedule.
      +Limits: If annual is used, day is required. One of Y, N
    • +
    +
  • +
  • +

    --day-of-year | --doy (string)

    +
      +
    • Specifies on which days of the annual schedule the user wants to run the job.
      +Days are entered as 1 through 366 and are prefixed by positive (unsigned) or slash (/) values.
      +Slash indicates the job will not run this day.
      +For example, if a job is to run on days 121, 132, 240, and 241, but is not to run on days 122, 242, and 1,the user would specify: /1,121,/122,132,240,241,/242
      +Limits: 1 to 55 numeric characters and required if annual is used.
      +The numbers will be separated by comma
    • +
    +
  • +
  • +

    --symmetric (string)

    +
      +
    • Used with the START and SPAN fields, defines a symmetric schedule.
      +With this option, schedules are defined as beginning on the date specified with
      +the START field and recurring every nnn days as specified with the SPAN field.
      +Limits: One of Y, N
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • This field is required when the SYMETRIC option is taken.
      +Value must be specified as the Julian day of the year on which the symmetric schedule is to begin.
      +This value should be evaluated yearly before schedule resolution and may need to be changed each year.
      +If the schedule will be resolved on a July-June basis, the start date must be within
      +the first of the two years in which the schedule overlaps.
      +For January-December schedules, it is simply relative to January 1 of the year specified on a RESOLV command.
      +If the calendar against which this SCHID will be resolved does not have the OPTIONS=SCHDYONLY,
      +the START day is adjusted each year to maintain the job's symmetric schedule from the job's original specified START day.
      +If the calendar against which the SCHID will be resolved was generated with overall available processing days only (OPTIONS=SCHDYONLY)
      +the start date must specify the first day on which the job would actually run.
      +This requires manually setting (verifying) the START value each year before the RESOLV.
      +If a nonprocessing day is specified, the start day is the next processing day found in the calendar.
      +For example, if January 1 is a nonprocessing day and the calendar was generated with OPTIONS=SCHDYONLY,
      +and 1 is specified as the START day, January 2 is the actual START day (provided it is an available processing day).
      +SPAN is based from January 2 in this example rather than January 1.
      +For other types of calendars, the start date is determined at RESOLV time based on the ROLL and INDEX options taken.
      +Limits: 3 numeric characters specified as Julian day of the year from 1 to 365
    • +
    +
  • +
  • +

    --span (string)

    +
      +
    • Used with SYMETRIC and START, defines symmetric schedules.
      +This field is required if the SYMETRIC option is taken.
      +When used, specifies the number of days between scheduled processing cycles.
      +If the calendar against which the SCHID will be resolved was generated with processing days
      +only (OPTIONS=SCHDYONLY), the SPAN value is specified as the number of available processing days
      +between and including the next processing date as opposed to the actual number of days.
      +With this type of calendar, the ROLL and INDEX options serve no practical purpose.
      +For other calendar types, the SPAN value is specified as the number of calendar days
      +between processing cycles and the ROLL and INDEX options can be used as necessary.
      +Limits: 1 to 3 numeric characters from 1 to 255
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create schedule for job TESTJOB1 with the parameters:

    +
      +
    • zowe ca7 create-job-definition schedule --job TESTJOB1 --schid 01 --dscal 03
    • +
    +
  • +
+

zoweca7create-resource-definition

+

All the available commands are listed in the COMMANDS section.

+

zoweca7create-resource-definitionresource-count-resource

+

Create Resource Count Resource parameters

+

Usage

+

zowe ca7 create-resource-definition resource-count-resource [options]

+

Required Options

+
    +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the name of the Resource Count Resource to add.
      +Limits: 1 to 39 alphanumeric characters and periods
    • +
    +
  • +
  • +

    --total-count | --tc (string)

    +
      +
    • Specifies the total number of available occurrences for this Resource Count Resource.
      +Limits: 1 to 4 numeric characters in the range 0-9999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Add Resource named PAYROLL.RCT to count 125:

    +
      +
    • zowe ca7 create-resource-definition resource-count-resource --rn PAYROLL.RCT --tc 125
    • +
    +
  • +
+

zoweca7dataset

+

All the available commands listed in the Dataset section.

+

zoweca7datasetcreate-dataset

+

Create Dataset

+

Usage

+

zowe ca7 dataset create-dataset [options]

+

Required Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • Specifies the data set and must be the fully qualified data set name.
      +Limits: 1 to 44 alphanumeric characters
      +Note: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.
    • +
    +
  • +
+

Options

+
    +
  • +

    --type (string)

    +
      +
    • (Optional) Specifies the data set type.
      +Valid values are:
      +NORM = Internal means both the creating-job and using-jobs for this data set are known to CA 7.
      +External means the creating-job, using-jobs, or both for this data set are not known to CA 7.PERM = Specifies this data set is always available for inputDefault: NORM
      +Note: When a data set is marked PERM, no SMF records are captured. PERM means no data set triggering can occur with this type of data set
    • +
    +
  • +
  • +

    --gdg (string)

    +
      +
    • (Optional) Specifies whether this data set is a generation data group.
      +Valid values are:
      +Y = The data set is a generation data groupN = The data set is not a generation data groupDefault: N
      +Note: The specific GDG creations cannot be used for posting requirements or for triggering jobs. Posting and triggering are done based on the creation/updating (SMF 15 record) of any generation of the GDG.
    • +
    +
  • +
  • +

    --smf-feedback-required | --sfr (string)

    +
      +
    • (Optional) Specifies whether the interface to System Management Facility (SMF) inserts the values for DSORG, RECFM, LRECL, and BLKSIZE when this data set is next used. Unless the value is reset, this insertion is only done once.
      +Valid values are:
      +Y = SMF inserts the values when the data set is next usedN = SMF does not insert the values when the data set is next usedDefault: Y
      +Note: After the first time the job that creates this data set runs under CA 7, this field is reset to N. If the data set attributes change, this field must be reset to Y. The changed attribute field (that is, DSORG, RECFM) must be zeroed (if numeric) or blanked out. This process causes CA 7 to record the new values when the job is run again.
    • +
    +
  • +
  • +

    --post-at-close-time | --pact (string)

    +
      +
    • (Optional) Specifies when to post the creation or update of a data set to the database and queues. This process does not ensure successful step or job termination.
      +Valid values are:
      +Y = The action takes place when the SMF data set creation record is received (when the data set is closed)N = Causes triggering or posting action to take place at the job terminationDefault: N
    • +
    +
  • +
  • +

    --device (string)

    +
      +
    • (Optional) Specifies a device type.
      +Valid values are:
      +TAPEDASD
    • +
    +
  • +
  • +

    --dsorg (string)

    +
      +
    • (Optional) Specifies the data set organization. This value is the same as the DSORG specified in the DCB subparameter in the JCL.
      +Limits: 1 to 3 alphanumeric characters
    • +
    +
  • +
  • +

    --recfm (string)

    +
      +
    • (Optional) Specifies the record format of the data set. This value is the same as the RECFM specified in the DCB subparameter in the JCL.
      +Limits: 1 to 5 alphanumeric characters
    • +
    +
  • +
  • +

    --lrecl (string)

    +
      +
    • (Optional) Specifies the logical record length of the data set. This value is the same as the LRECL specified in the DCB subparameter in the JCL.
      +Limits: 1 to 5 numeric characters
    • +
    +
  • +
  • +

    --blksize (string)

    +
      +
    • (Optional) Specifies the block size of the data set. This value is the same as the BLKSIZE specified in the DCB subparameter in the JCL.
      +Limits: 1 to 5 numeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a new dataset named DATASET.NAME.TEST of type NORM and data set is not a generation data group:

    +
      +
    • zowe ca7 dataset create-dataset --dname DATASET.NAME.TEST --type NORM --gdg N
    • +
    +
  • +
+

zoweca7datasetcreate-dataset-trigger

+

Create Dataset Trigger

+

Usage

+

zowe ca7 dataset create-dataset-trigger [options]

+

Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • (Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job.
      +Note: For VSAM files, specify the cluster name.
      +Limits: 1 to 44 alphanumeric characters
    • +
    +
  • +
  • +

    --dataset-number | --dnum (string)

    +
      +
    • (Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set.
      +Limits: 1 to 8 numeric characters
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled.
      +Note: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work
      +Default: 0 (all schedule IDs)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --triggered-job-schid | --tjs (string)

    +
      +
    • (Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.
      +Default: 0 (no replacement)
      +Limits: 1 to 3 numeric characters from 0 through 999
      +Note: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.
    • +
    +
  • +
  • +

    --triggered-job-due-out-time | --tjdot (string)

    +
      +
    • (Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-queue-time must be omitted.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.
      +Note: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.
    • +
    +
  • +
  • +

    --triggered-job-queue-time | --tjqt (string)

    +
      +
    • (Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.
      +Deadline time is calculated as current date/time plus queue time.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-lead-time | --tjlt (string)

    +
      +
    • (Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.
      +Default: 0000
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-submit-time | --tjst (string)

    +
      +
    • +

      (Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.
      +The triggered-job-submit-time is always rounded down to 15-minute increments.
      +Default: 0 (no specific submit time requirement)
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.
      +Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.

      +

      If triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --triggered-job | --tj (string)

    +
      +
    • Specifies the job name that the completion of the triggering dataset triggers.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a Dataset Trigger definition DATA.SET.NAME with schid 42 for Triggered job JOBA:

    +
      +
    • zowe ca7 dataset create-dataset-trigger --dname DATA.SET.NAME --schid 42 --tj JOBA --tjdot 0830
    • +
    +
  • +
+

zoweca7datasetdelete-dataset

+

Delete Dataset

+

Usage

+

zowe ca7 dataset delete-dataset [options]

+

Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • (Required if dataset-number is omitted) Specifies the data set and must be the fully qualified data set name.
      +Limits: 1 to 44 alphanumeric characters
      +Note: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.
    • +
    +
  • +
  • +

    --dataset-number | --dnum (string)

    +
      +
    • (Required if dataset-name is omitted) Specifies the data set to use. The value must be the numeric value that CA 7 already assigned.
      +Limits: 1 to 8 numeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the definition of a dataset named DATA.SET.NAME:

    +
      +
    • zowe ca7 dataset delete-dataset --dname DATA.SET.NAME
    • +
    +
  • +
+

zoweca7datasetdelete-dataset-trigger

+

Delete Dataset Trigger

+

Usage

+

zowe ca7 dataset delete-dataset-trigger [options]

+

Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • (Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job.
      +Note: For VSAM files, specify the cluster name.
      +Limits: 1 to 44 alphanumeric characters
    • +
    +
  • +
  • +

    --dataset-number | --dnum (string)

    +
      +
    • (Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set.
      +Limits: 1 to 8 numeric characters
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled.
      +Note: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work
      +Default: 0 (all schedule IDs)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --triggered-job | --tj (string)

    +
      +
    • Specifies the job name that the completion of the triggering dataset triggers.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a Dataset Trigger definition DATA.SET.NAME with schid 42 for Triggered job JOBA:

    +
      +
    • zowe ca7 dataset delete-dataset-trigger --dname DATA.SET.NAME --schid 42 --tj JOBA
    • +
    +
  • +
+

zoweca7datasetrename-dataset

+

Rename a existing Dataset

+

Usage

+

zowe ca7 dataset rename-dataset [options]

+

Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • (Required if dataset-number is omitted) Specifies the data set and must be the fully qualified data set name.
      +Limits: 1 to 44 alphanumeric characters
      +Note: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.
    • +
    +
  • +
  • +

    --dataset-number | --dnum (string)

    +
      +
    • (Required if dataset-name is omitted) Specifies the data set to use. The value must be the numeric value that CA 7 already assigned.
      +Limits: 1 to 8 numeric characters
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --new-dataset-name | --ndname (string)

    +
      +
    • Specifies the new, fully qualified data set name.
      +Limits: 1 to 44 alphanumeric characters
      +Note: new-dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Renames Dataset with name DATASET.NAME.TEST to NEW.DATASET.NAME.TEST:

    +
      +
    • zowe ca7 dataset rename-dataset --dname DATASET.NAME.TEST --ndname NEW.DATASET.NAME.TEST
    • +
    +
  • +
+

zoweca7datasetupdate-dataset

+

Modify Dataset

+

Usage

+

zowe ca7 dataset update-dataset [options]

+

Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • (Required if dataset-number is omitted) Specifies the data set and must be the fully qualified data set name.
      +Limits: 1 to 44 alphanumeric characters
      +Note: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.
    • +
    +
  • +
  • +

    --dataset-number | --dnum (string)

    +
      +
    • (Required if dataset-name is omitted) Specifies the data set to use. The value must be the numeric value that CA 7 already assigned.
      +Limits: 1 to 8 numeric characters
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • (Optional) Specifies the data set type.
      +Valid values are:
      +NORM = Internal means both the creating-job and using-jobs for this data set are known to CA 7.
      +External means the creating-job, using-jobs, or both for this data set are not known to CA 7.PERM = Specifies this data set is always available for inputDefault: NORM
      +Note: When a data set is marked PERM, no SMF records are captured. PERM means no data set triggering can occur with this type of data set
    • +
    +
  • +
  • +

    --gdg (string)

    +
      +
    • (Optional) Specifies whether this data set is a generation data group.
      +Valid values are:
      +Y = The data set is a generation data groupN = The data set is not a generation data groupDefault: N
      +Note: The specific GDG creations cannot be used for posting requirements or for triggering jobs. Posting and triggering are done based on the creation/updating (SMF 15 record) of any generation of the GDG.
    • +
    +
  • +
  • +

    --smf-feedback-required | --sfr (string)

    +
      +
    • (Optional) Specifies whether the interface to System Management Facility (SMF) inserts the values for DSORG, RECFM, LRECL, and BLKSIZE when this data set is next used. Unless the value is reset, this insertion is only done once.
      +Valid values are:
      +Y = SMF inserts the values when the data set is next usedN = SMF does not insert the values when the data set is next usedDefault: Y
      +Note: After the first time the job that creates this data set runs under CA 7, this field is reset to N. If the data set attributes change, this field must be reset to Y. The changed attribute field (that is, DSORG, RECFM) must be zeroed (if numeric) or blanked out. This process causes CA 7 to record the new values when the job is run again.
    • +
    +
  • +
  • +

    --post-at-close-time | --pact (string)

    +
      +
    • (Optional) Specifies when to post the creation or update of a data set to the database and queues. This process does not ensure successful step or job termination.
      +Valid values are:
      +Y = The action takes place when the SMF data set creation record is received (when the data set is closed)N = Causes triggering or posting action to take place at the job terminationDefault: N
    • +
    +
  • +
  • +

    --device (string)

    +
      +
    • (Optional) Specifies a device type.
      +Valid values are:
      +TAPEDASD
    • +
    +
  • +
  • +

    --dsorg (string)

    +
      +
    • (Optional) Specifies the data set organization. This value is the same as the DSORG specified in the DCB subparameter in the JCL.
      +Limits: 1 to 3 alphanumeric characters
    • +
    +
  • +
  • +

    --recfm (string)

    +
      +
    • (Optional) Specifies the record format of the data set. This value is the same as the RECFM specified in the DCB subparameter in the JCL.
      +Limits: 1 to 5 alphanumeric characters
    • +
    +
  • +
  • +

    --lrecl (string)

    +
      +
    • (Optional) Specifies the logical record length of the data set. This value is the same as the LRECL specified in the DCB subparameter in the JCL.
      +Limits: 1 to 5 numeric characters
    • +
    +
  • +
  • +

    --blksize (string)

    +
      +
    • (Optional) Specifies the block size of the data set. This value is the same as the BLKSIZE specified in the DCB subparameter in the JCL.
      +Limits: 1 to 5 numeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates the dataset with specified information:

    +
      +
    • zowe ca7 dataset update-dataset --dname DATASET.NAME.TEST --type NORM --gdg N --sfr Y --pact N --blksize 11111
    • +
    +
  • +
+

zoweca7datasetupdate-dataset-trigger

+

Modify Dataset Trigger

+

Usage

+

zowe ca7 dataset update-dataset-trigger [options]

+

Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • (Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job.
      +Note: For VSAM files, specify the cluster name.
      +Limits: 1 to 44 alphanumeric characters
    • +
    +
  • +
  • +

    --dataset-number | --dnum (string)

    +
      +
    • (Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set.
      +Limits: 1 to 8 numeric characters
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled.
      +Note: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work
      +Default: 0 (all schedule IDs)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --triggered-job-schid | --tjs (string)

    +
      +
    • (Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.
      +Default: 0 (no replacement)
      +Limits: 1 to 3 numeric characters from 0 through 999
      +Note: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.
    • +
    +
  • +
  • +

    --triggered-job-due-out-time | --tjdot (string)

    +
      +
    • (Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-queue-time must be omitted.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.
      +Note: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.
    • +
    +
  • +
  • +

    --triggered-job-queue-time | --tjqt (string)

    +
      +
    • (Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.
      +Deadline time is calculated as current date/time plus queue time.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-lead-time | --tjlt (string)

    +
      +
    • (Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.
      +Default: 0000
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-submit-time | --tjst (string)

    +
      +
    • +

      (Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.
      +The triggered-job-submit-time is always rounded down to 15-minute increments.
      +Default: 0 (no specific submit time requirement)
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.
      +Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.

      +

      If triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --triggered-job | --tj (string)

    +
      +
    • Specifies the job name that the completion of the triggering dataset triggers.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a Dataset Trigger definition DATA.SET.NAME with schid 42 for Triggered job JOBA:

    +
      +
    • zowe ca7 dataset update-dataset-trigger --dname DATA.SET.NAME --schid 42 --tj JOBA --tjdot 0830 --tjlt 0030 --tjst 1030
    • +
    +
  • +
+

zoweca7delete-job-definition

+

All the available commands are listed in the COMMANDS section.

+

zoweca7delete-job-definitionreq-predecessor

+

Delete predecessor requirement for a job.

+

Usage

+

zowe ca7 delete-job-definition req-predecessor [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job that requires the predecessor
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • The schedule id of requiring job
    • +
    +
  • +
  • +

    --predtype (string)

    +
      +
    • The predecessor type
    • +
    +
  • +
  • +

    --nextrun (string)

    +
      +
    • The status of predecessor for next run of job
      +[ YES, ONLY, SKIP ]
    • +
    +
  • +
  • +

    --predobject (string)

    +
      +
    • The predecessor. Values vary with predtype.
      +The predecessor. Values vary with predtype.
      +When “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.
      +When “predtype”:”USER” then “predobject” is 1-44 character user requirement text.
    • +
    +
  • +
+

Options

+
    +
  • +

    --leadtime (string)

    +
      +
    • The satisfaction lead time in hours.
      +This may be honored when “predtype” is “job or “DSN”
    • +
    +
  • +
  • +

    --permanent (string)

    +
      +
    • Indicates that this predecessor is permanent, that is always considered satisfied.
      +This parameter only applies when “predtype” is “DSN”
      +[ Y, N ]
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a job requirement predecessor of a CA 7 job using the options:

    +
      +
    • zowe ca7 delete-job-definition req-predecessor --job ZOWECRM1 --schid 0004 --predtype USER --nextrun ONLY --predobject USER101
    • +
    +
  • +
+

zoweca7delete-job-definitionschedule

+

Delete an existing date/time schedule

+

Usage

+

zowe ca7 delete-job-definition schedule [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • Specifies the numeric schedule ID on which the user wants to perform the specified action.
      +Limits:
      +1 to 3 numeric characters from 1 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete an existing date/time schedule (remove a schedule ID) for a CA7 job:

    +
      +
    • zowe ca7 delete-job-definition schedule --job ZOWECRM1 --schid 0004
    • +
    +
  • +
+

zoweca7delete-resource-definition

+

All the available commands are listed in the COMMANDS section.

+

zoweca7delete-resource-definitionresource-count-resource

+

Delete a Resource Count resource

+

Usage

+

zowe ca7 delete-resource-definition resource-count-resource [options]

+

Required Options

+
    +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the name of the Resource Count Resource to delete.
      +Limits: 1 to 39 alphanumeric characters and periods
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete Resource Count Resource parameters:

    +
      +
    • zowe ca7 delete-resource-definition resource-count-resource --rn PAYROLL.RCT
    • +
    +
  • +
+

zoweca7event-manager-requests

+

All the available commands are listed in the COMMANDS section.

+

zoweca7event-manager-requestsjob-status

+

Available request is listed below.

+

Usage

+

zowe ca7 event-manager-requests job-status [options]

+

Required Options

+
    +
  • +

    --jobnumber | --jnum (string)

    +
      +
    • +

      jnum=0016

      +

      Defines the name of the job to retrieve.
      +Indicates the individual job to retrieve, and the value must be a CA 7 job number.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Gets the status of jobnumber 0016 from CA 7:

    +
      +
    • zowe ca7 event-manager-requests job-status --jnum 0016
    • +
    +
  • +
+

zoweca7job-definition

+

All the available commands listed in the Job Definition section.

+

zoweca7job-definitioncreate-address-space-resource

+

Add Address Space Resource

+

Usage

+

zowe ca7 job-definition create-address-space-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --ready-when | --rw (string)

    +
      +
    • (Optional) Determines how VRM manages resource availability at job submission and job/step completion.
      +Default: A
      +Valid values are:
      +A = Specifies the job is submitted only if the resource is active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the systemI = Specifies the job is submitted only if the resource is not active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the system
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBAA with resource name SCHENV.VARNAME, schedule id 23 and job is submitted only if the resource is not active:

    +
      +
    • zowe ca7 job-definition create-address-space-resource --job JOBAA --schid 23 --rn SCHENV.VARNAME --rw I
    • +
    +
  • +
+

zoweca7job-definitioncreate-corequisite-resource

+

Add Corequisite Resource

+

Usage

+

zowe ca7 job-definition create-corequisite-resource [options]

+

Required Options

+
    +
  • +

    --job-name | --jn (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be nonblank, and no embedded blanks
      +Exception: If the resource connection is made to a resource count resource,
      +the resource name can be from 1 to 39 characters followed by a / (slash) and
      +a 1 through 4 numeric value indicating the number of occurrences for the resource that the job uses.
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied.
      +A zero default cannot be specified for one connection and a nonzero schedule ID used for
      +a subsequent connection to the same job with the same user requirement description.
      +An attempt to make such a connection results in an error message that is issued.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --ready-when | --rw (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Default: A
      +Valid values are:
      +A
      +Specifies the job is submitted only if the resource is active (as established by the PRSQA command).I
      +Specifies the job is submitted only if the resource is not active.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBAA with resource name SCHENV.VARNAME, schedule id 23 and job is submitted only if the resource is not active:

    +
      +
    • zowe ca7 job-definition create-corequisite-resource --jn JOBAA --schid 23 --rn SCHENV.VARNAME --rw I
    • +
    +
  • +
+

zoweca7job-definitioncreate-exclusive-resource

+

Add Exclusive Resource

+

Usage

+

zowe ca7 job-definition create-exclusive-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
  • +

    --free (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Valid values are:
      +A = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfullyN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resourceY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --step-name | --sn (string)

    +
      +
    • (Optional) Specifies the resource is freed at the conclusion of the named job step.
      +Limits: 1 to 8 alphanumeric characters
      +Notes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBAA with resource name SCHENV.VARNAME of free type F, step name JS010 and schedule id 23:

    +
      +
    • zowe ca7 job-definition create-exclusive-resource --job JOBAA --schid 23 --rn SCHENV.VARNAME --free F --sn JS010
    • +
    +
  • +
+

zoweca7job-definitioncreate-job

+

Create Job Definition

+

Usage

+

zowe ca7 job-definition create-job [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job
    • +
    +
  • +
  • +

    --job-type | --jt (string)

    +
      +
    • The type of job.
      +Valid values are:
      +CPU = A CPU jobXPJOB = A cross-platform jobAGENT = An Agent job
    • +
    +
  • +
+

Options

+
    +
  • +

    --long-name | --ln (string)

    +
      +
    • (Optional) Defines the long job name.
      +Limits: 1 to 64 alphanumeric characters, case sensitive
    • +
    +
  • +
  • +

    --system (string)

    +
      +
    • (Optional) Specifies the user-defined application system name of which this job is a part.
      +Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma
    • +
    +
  • +
  • +

    --uid (string)

    +
      +
    • (Optional) Specifies the CA 7 user security identification.
      +Default: 0 (no internal security protection)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --jobnet (string)

    +
      +
    • (Optional) Specifies the name of a CPU job network of which this job is a part.
      +Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma
    • +
    +
  • +
  • +

    --owner (string)

    +
      +
    • (Optional) Specifies the ID identifying ownership of this job. Depending on the startup options taken, the external security product being used and contents of the JCL, this value can be offered to the external security package by CA 7 at job submission time as the authority for this job to be executed.
      +Limits: 1 to 8 alphanumeric characters. Although this field supports up to 8 characters, some external security packages only accept up to 7 characters. This field must not exceed any such limit that exists
    • +
    +
  • +
  • +

    --jcl-member | --jm (string)

    +
      +
    • (Optional) Specifies the JCL library member name and required when the member name and job name are different.
      +Valid when: job-type is CPU
      +Default: Job name
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --id (string)

    +
      +
    • (Optional) Specifies a numeric index value that is associated with a JCL library where the JCL member is located. NOTE: the id and lib properties are mutually exclusive.
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0-253 or 256-999
    • +
    +
  • +
  • +

    --lib (string)

    +
      +
    • (Optional) Specifies a JCL library identification consisting of a symbolic INDEX assigned to a JCL statement. NOTE: the id and lib properties are mutually exclusive.
      +Valid when: job-type is CPU
      +Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)
    • +
    +
  • +
  • +

    --reload (string)

    +
      +
    • (Optional) Specifies whether to reload the JCL of this job. When a job comes into the request queue, it is either flagged for load processing or it is not flagged.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = The job is flagged for load processing. The reload flag is automatically reset to N once the load completes successfullyN = The job is not flagged for load processing unless it is the first time it has run in CA 7X = The job is only flagged for load processing when the LOAD command is used and is never automatically changed even if the LOAD command is used
    • +
    +
  • +
  • +

    --execute (string)

    +
      +
    • (Optional) Indicates whether to execute this job.
      +Default: Y
      +Valid values are:
      +Y = The job will be executedN = The job does not run but shows a normal completion as if it did run. JCL is not required for non-executable jobs
    • +
    +
  • +
  • +

    --retain (string)

    +
      +
    • (Optional) Specifies whether to retain the execution JCL in the trailer queue after a successful run.
      +Valid when: job-type is CPU or XPJOB
      +Default: N
      +Valid values are:
      +Y = Retain the JCL in the trailer queue after a successful run.N = Do not retain the JCL in the trailer queue after a successful run
    • +
    +
  • +
  • +

    --hold (string)

    +
      +
    • (Optional) Specifies whether to place this job in a hold status when it enters the request queue.
      +Default: N
      +Valid values are:
      +Y = The job will be heldN = The job will not be held
    • +
    +
  • +
  • +

    --jcl-override | --jo (string)

    +
      +
    • (Optional) Specifies whether this job needs manual JCL overrides before it can be submitted. Similar to the JCLOVRD command.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = The job needs manual JCL overrides before it can be submittedN = The job does not need manual JCL overrides before it can be submitted
    • +
    +
  • +
  • +

    --use-jcl-override-library | --ujol (string)

    +
      +
    • (Optional) Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only. This field is automatically set back to N the next time the job comes into the request queue.
      +Default: N
      +Valid values are:
      +Y = The JCL is retrieved from the JCL Override library for the next runN = The JCL is not retrieved from the JCL Override library for the next run
    • +
    +
  • +
  • +

    --verify (string)

    +
      +
    • (Optional) Specifies whether this job requires any pre-submission manual verification. Similar to VERIFY command.
      +Default: N
      +Valid values are:
      +Y = The job requires any pre-submission manual verificationN = The job does not require any pre-submission manual verification
    • +
    +
  • +
  • +

    --maintenance | --maint (string)

    +
      +
    • (Optional) Specifies whether this job is a maintenance job (for example, a system utility) with no production data set requirements. If Y is specified, all input data set requirements are ignored. None of the output data sets created by this job is posted back to CA 7.
      +Marking a job as maintenance enables job triggering but not data set triggering.
      +Also, if the LOADDSNS keyword is used on the DBASE statement in the initialization file, the LOAD process does not build any DD or data set information for jobs that are marked as maintenance. This means that there are not any data set connections for these jobs unless added manually.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = The job is a maintenance jobN = The job is not a maintenance job
    • +
    +
  • +
  • +

    --job-requirement-lead-time | --jrlt (string)

    +
      +
    • (Optional) Specifies the number of hours to be considered when satisfying job-dependent requirements.
      +Default: 0
      +Valid values are:
      +0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each predecessor job must complete typically while this job is in the request queuenn = Since the last run of this job, specifies that each predecessor job must have run within the last nn hours. Values for nn can be from 1 to 98
    • +
    +
  • +
  • +

    --dataset-requirement-lead-time | --drlt (string)

    +
      +
    • (Optional) Specifies the number of hours to be considered when satisfying data set requirements.
      +Valid when: job-type is CPU
      +Default: 0
      +Valid values are:
      +0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each data set requirement must be satisfied typically while this job is in the request queuenn = Since the last run of this job, specifies that each data set requirement must be satisfied within the last nn hours. Values for nn can be from 1 to 98
    • +
    +
  • +
  • +

    --arfset (string)

    +
      +
    • (Optional) Names the collection of ARF definitions that apply to this job. Remember that ARF recovery is not invoked for non-executable jobs.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --mainid (string)

    +
      +
    • (Optional) Specifies on which CPU the job can or cannot be scheduled. If the job requirements impose CPU restrictions, specify SYn or /SYn where n is the system number and / indicates not this system. System numbers must be consistent with the initialization file CPU statement MAINIDS parameters.
      +Valid when: job-type is CPU
      +Default: ALL (lets the job run on any CPU)
      +Limits: 1 to 4 alphanumeric characters
    • +
    +
  • +
  • +

    --insert-ca11-rms | --icr (string)

    +
      +
    • (Optional) Specifies whether to insert the WA Restart Option RMS step automatically at execution time by CA 7.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = Inserts the step with the WA Restart Option processing code of PN = Does not insert the RMS step
    • +
    +
  • +
  • +

    --condition-code | --cc (string)

    +
      +
    • (Optional) Used with relational-operator property to define the job-level condition codes used to determine whether a job executes successfully.
      +Valid when: job-type is CPU or XPJOB
      +Note: All condition codes that are returned from an XPJOB job are treated as positive values. Any negative value returned is converted to an absolute (positive) value
      +Default: 0
      +Limits: For job-type = CPU: 1 to 4 numeric characters in the range 0-4095
      +For job-type = "XPJOB": 1 to 4 numeric characters in the range 0-9999
    • +
    +
  • +
  • +

    --relational-operator | --ro (string)

    +
      +
    • (Optional) Specifies the relational operator of the condition-code property or if the step level #SCC statements are being used in the job's JCL.
      +Valid when: job-type is CPU or XPJOB
      +Default: 0
      +Valid values are:
      +EQ = Equal toLT = Less thanGT = Greater thanGE = Greater than or equal toLE = Less than or equal toNE = Not equal to#S = Make step condition code tests based on #SCC statements in the JCLIG = Make no evaluation of the job. CA 7 always assumes the job completes successfully, regardless of condition codes, abend codes, or runtime JCL errors. When this is used, the insert-ca11-rms property should be N0 = No condition test will be madeNOTE: If 0 is used, no test is made on the job's condition code. The highest condition code that this job generates is tested by this pair of parameters. For example, if condition-code is set at 8 and RO is set at LT, the job is marked as completing abnormally if 8 is less than the job's highest condition code
    • +
    +
  • +
  • +

    --do-not-schedule-before-date | --dnsbd (string)

    +
      +
    • (Optional) Specifies not to schedule this job before this date (in YYDDD format, or 00000)
    • +
    +
  • +
  • +

    --do-not-schedule-before-time | --dnsbt (string)

    +
      +
    • (Optional) Specifies not to schedule this job before this time (in HHMM format)
    • +
    +
  • +
  • +

    --do-not-schedule-after-date | --dnsad (string)

    +
      +
    • (Optional) Specifies not to schedule this job after this date (in YYDDD format, or 99999)
    • +
    +
  • +
  • +

    --do-not-schedule-after-time | --dnsat (string)

    +
      +
    • (Optional) Specifies not to schedule this job after this time (in HHMM format)
    • +
    +
  • +
  • +

    --lterm (string)

    +
      +
    • (Optional) Routes the messages about this job to this logical terminal name.
      +Default: If not entered, the LTERM associated with the JCL library in the initialization file JCL statement is used. If LTERM is not specified on the JCL statement, the default is MASTER
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --list-requirements | --lr (string)

    +
      +
    • (Optional) Specifies whether to list pre-execution requirements for this job when it enters the request queue.
      +Default: Y
      +Valid values are:
      +Y = The pre-execution requirements will be listedN = The pre-execution requirements will not be listed
    • +
    +
  • +
  • +

    --prompts (string)

    +
      +
    • (Optional) Specifies whether to issue prompt messages when this job is late.
      +Default: Y
      +Valid values are:
      +Y = Prompt messages will be issued when the job is lateN = Prompt messages will not be issued when the job is late
    • +
    +
  • +
  • +

    --requirements-not-used | --rnu (string)

    +
      +
    • (Optional) Specifies whether to issue error messages for job requirements not used.
      +Default: Y
      +Valid values are:
      +Y = Messages will be issued if requirements are not usedN = Messages will not be issued if requirements are not used
    • +
    +
  • +
  • +

    --dsn-not-found | --dnf (string)

    +
      +
    • (Optional) Specifies whether to list error messages for data sets used at execution time but not found in the CA 7 database.
      +Valid when: job-type is CPU
      +Default: Y
      +Valid values are:
      +Y = Messages will be issued if data sets used are not found in the CA 7 databaseN = Messages will not be issued if data sets used are not found in the CA 7 database
    • +
    +
  • +
  • +

    --job-region | --jr (string)

    +
      +
    • (Optional) Specifies the region size that is required by this job (information only).
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 4 numeric characters
    • +
    +
  • +
  • +

    --elapsed-time | --et (string)

    +
      +
    • (Optional) CA 7 maintains certain SMF feedback data in its database, including a weighted average elapsed runtime. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.
      +Default: 0000
      +Limits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59
    • +
    +
  • +
  • +

    --average-cpu-time | --act (string)

    +
      +
    • (Optional) CA 7 maintains weighted average CPU time usage values for each job in its database. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.
      +Valid when: job-type is CPU
      +Default: 0000
      +Limits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59
    • +
    +
  • +
  • +

    --wlb-job-class | --wjc (string)

    +
      +
    • +

      (Optional) Specifies the CA 7 WLB job class. If not specified, a WLB class of A is automatically assigned. This value does not have to match the JOB statement CLASS value.

      +

      NOTE: The value specified here does not apply when the job enters the queue as a result of a RUN(H) command. Class 9 is assigned by default. To override class 9, use the RUNCLASS keyword on the OPTIONS statement in the initialization file.

      +

      NOTE: The value specified here does not apply when the job enters the queue as a result of a LOAD(H) command. Class 8 is assigned by default. To override class 8, use the LOADCLASS keyword on the OPTIONS statement in the initialization file
      +Default: A space
      +Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --wlb-priority | --wp (string)

    +
      +
    • (Optional) Specifies the CA 7 WLB job priority. A value of 255 indicates an express priority used to bypass WLB priority scheduling criteria. If using WLB, any job without a specified priority is automatically assigned a priority of 100 unless the default is changed
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0 - 255
    • +
    +
  • +
  • +

    --message-class | --mc (string)

    +
      +
    • (Optional) Specifies the job's message class. This field is informational only. Even though this field can be changed, it does not cause the JCL to be changed. Also, no validity checking is done on this field.
      +Valid when: job-type is CPU
      +Default: A space
      +Limits: 1 alphanumeric character
    • +
    +
  • +
  • +

    --drclass | --dc (string)

    +
      +
    • (Optional) Specifies the job's disaster recovery class. This field has no impact on processing during normal execution. When running in disaster recovery mode, the disaster recovery class is used to determine whether the job should execute.
      +Limits: 1 to 8 alphanumeric characters. Disaster recovery class values must start with a letter, #, or $ (not @) and can include letters, #, $, @, and numbers. Disaster recovery classes cannot contain embedded blanks
    • +
    +
  • +
  • +

    --number-1-tape-man | --n1tm (string)

    +
      +
    • (Optional) Specifies a manual override value for the number of TYPE1 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE1 tape drives.
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0 - 255
    • +
    +
  • +
  • +

    --number-2-tape-man | --n2tm (string)

    +
      +
    • (Optional) Specifies a manual override value for the number of TYPE2 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE2 tape drives.
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0 - 255
    • +
    +
  • +
  • +

    --xp-node | --xn (string)

    +
      +
    • (Required when job-type is XPJOB) Defines the CAICCI node to which the execution of this job is targeted. This field should state the primary node. If this node is unavailable and the node definition has alternate nodes defined, the execution of this job can be directed to an alternate node.
      +Valid when: job-type is XPJOB
      +Limits: 1 to 44 alphanumeric characters, although current z/OS CAICCI restricts this name to eight characters
    • +
    +
  • +
  • +

    --xp-exec | --xe (string)

    +
      +
    • (Required when job-type is XPJOB) Defines the executable (file, command) to execute at the targeted cross-platform node. If the targeted platform is a mainframe scheduling system such as CA 7, this value indicates the job name to execute on that platform. If the targeted platform is Workload Automation AE system, this value indicates a job that is defined in the Workload Automation AE system. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. Otherwise, the field is passed to the target system as-is and in its entirety. This value includes any embedded blanks and quotation marks.
      +Valid when: job-type is XPJOB
      +Limits: Up to 244 alphanumeric characters, and file delimiters of forward slash (/) and backward slash (\) signs. Note: Each backward slash character must be escaped by specifying (\\)
    • +
    +
  • +
  • +

    --xp-parm | --xp (string)

    +
      +
    • (Optional) Defines up to 128 bytes of parameter data to pass to the file or command being executed on the alternate platform. This data is supplied as PARM1 to the data being transmitted to the alternate platform. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. This value may be overridden if the PARMLIB/MEMBER field PARM1 is coded.
      +Valid when: job-type is XPJOB
      +Limits: Up to 128 EBCDIC characters
    • +
    +
  • +
  • +

    --parmlib | --pl (string)

    +
      +
    • (Optional) Defines extra, optional indexed, or symbolic (PDS) library from where execution data to be associated with this job can be found. This information is typically PARM1 through PARM64 keywords but can vary based on CA 7 system configuration options. If the PARM1 field is found within this file, it overrides the data that is specified in the XP PARM field that is listed on the panel.
      +Valid when: job-type is XPJOB or AGENT
      +Limits: 1 to 16 alphanumeric characters. If this field starts with a numeric value, the value is treated as a JCL Index value (0 - 253 or 256 - 999), and the associated numbered JCL library, as defined in the initialization file JCL statement, is used. If the first character is not numeric, the field must start with an ampersand (&) and must denote the library variable as defined using a /JCL command.
      +Note: Specifying data in the PARMLIB/MEMBER fields is in addition to anything specified in the XPPARM field. If XPPARM is coded, and if the PARMLIB/Member contains a PARM1 statement, the PARMLIB specification overrides the XP PARM field. Thus, if both XPPARM and PARMLIB PARM1 fields contain data, the data that is obtained from the PARMLIB/MEMBER is used in the data that is transmitted to the target node
    • +
    +
  • +
  • +

    --member (string)

    +
      +
    • (Optional) Indicates the PDS member name in the parmlib library where the parameters for this job reside.
      +Valid when: job-type is XPJOB or AGENT
      +Default: Same as the job property
      +Limits: 1 to 8 alphanumeric characters, beginning with an alphabetic character
    • +
    +
  • +
  • +

    --sutype (string)

    +
      +
    • (Optional) Specifies the type of "switch user" command to execute at the UNIX target node.
      +Valid when: job-type is XPJOB
      +Default: Y
      +Valid values are:
      +Y = Executes an "SU -" causing the environment setup to include execution of the ".PROFILE" for the target userN = Executes an "SU" command without the profile option
    • +
    +
  • +
  • +

    --xp-trace | --xt (string)

    +
      +
    • (Optional) Indicates whether to trace the activity that is associated with this job as it moves through the queues.
      +Valid when: job-type is XPJOB
      +Default: N
      +Valid values are:
      +Y = Issue WTOs as the job enters into the submission process. Retain up to 256 characters of the data that is sent for inclusion in a log recordN = Do not activate tracing for this job
    • +
    +
  • +
  • +

    --agent-job-type | --ajt (string)

    +
      +
    • (Required when job-type is AGENT) Defines the type of agent job. For more information about the Agent job types see:
      +[CA 7 Documentation](https://techdocs.broadcom.com/us/en/ca-mainframe-software/automation/ca-workload-automation-ca-7-edition/12-1/configuring/interfaces/cross-platform-scheduling/ca-workload-automation-agents/ca-7-agent-job-types.html/)
      +Valid when: job-type is AGENT
      +Default: There is no default value
      +Valid values are:
      +UNIX_JOB - Generic UNIXNT_JOB - Microsoft WindowsFILE_TRIGGER - File TriggerFTP_JOB - FTPSCP_JOB - Secure CopySFTP_JOB - Secure File TransferBDC_JOB - SAP Batch Input SessionBWIP_JOB - SAP Business Warehouse InfoPackageBWPC_JOB - SAP Business Warehouse Process ChainSAP_JOB - SAP GenericSAPA_JOB - SAP ArchiveSAPE_JOB - SAP Event MonitorSAPM_JOB - SAP Process MonitorPS_JOB - PeopleSoftOA_JOB - Oracle RequestOAC_JOB - Oracle CopyCPU_MON - CPU MonitorDISK_MON - Disk MonitorIP_MON - IP MonitorPROCESS_MON - Process MonitorTEXT_MON - Text File MonitorEVENTLOG_MON - Event Log MonitorSERVICE_MON - Service MonitorSQL_JOB - Database SQLDBSP_JOB - Database Stored ProcedureDB_MON - Database MonitorDB_TRIG - Database TriggerAS400_JOB - AS400/OS400JMSP_JOB - J2EE JMS PublishJMSS_JOB - J2EE JMS SubscribeEJBE_JOB - J2EE Entity BeanHTTP_JOB - J2EE HTTP/ServletPOJO_JOB - J2EE POJORMI_JOB - J2EE RMIEJB_JOB - J2EE Session BeanJMXB_JOB - JMX-Mbean Attribute GetJMXA_JOB - JMX-Mbean Attribute SetJMXO_JOB - JMX-Mbean OperationJMXS_JOB - JMX-Mbean SubscribeJMXN_JOB - JMX-Mbean Create InstanceJMXR_JOB - JMX-Mbean Remove InstanceSNPG_JOB - SNMP Get AttributeSNPS_JOB - SNMP Set AttributeSNPC_JOB - SNMP SubscribeSNPE_JOB - SNMP TrapSendWEB_SERV - Web ServicesWOL_JOB - Wake-On-LANPROXY_JOB - Remote ExecutionNONSTOP_JOB - HP Integrity NonStop
    • +
    +
  • +
  • +

    --agent (string)

    +
      +
    • (Required when job-type is AGENT) Identifies the explicit distributed platform where the job is to run.
      +Valid when: job-type is AGENT
      +Limits: 1 to 16 alphanumeric characters. The value must be defined to CA 7 using the IASAGENT DD statement
    • +
    +
  • +
  • +

    --agent-user | --au (string)

    +
      +
    • (Optional) Defines the user ID that is passed to the distributed platform where the job is to run.
      +Valid when: job-type is AGENT
      +Limits: 1 to 128 alphanumeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    creates a job named JOBA:

    +
      +
    • zowe ca7 job-definition create-job --job JOBA --job-type CPU --execute Y --use-jcl-override-library Y --do-not-schedule-before-date 11032 --do-not-schedule-before-time 1100 --do-not-schedule-after-date 11365 --do-not-schedule-after-time 1359
    • +
    +
  • +
+

zoweca7job-definitioncreate-job-trigger-successor

+

Add Job Trigger

+

Usage

+

zowe ca7 job-definition create-job-trigger-successor [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name whose successful completion causes triggering.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --triggered-job | --tj (string)

    +
      +
    • Specifies the job name that the completion of the triggering job triggers.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.
      +Default: 0 (all schedule IDs)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --triggered-job-schid | --tjs (string)

    +
      +
    • (Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.
      +Default: 0 (no replacement)
      +Limits: 1 to 3 numeric characters from 0 through 999
      +Note: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.
    • +
    +
  • +
  • +

    --triggered-job-due-out-time | --tjdot (string)

    +
      +
    • (Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-queue-time must be omitted.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.
      +Note: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.
    • +
    +
  • +
  • +

    --triggered-job-queue-time | --tjqt (string)

    +
      +
    • (Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.
      +Deadline time is calculated as current date/time plus queue time.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-lead-time | --tjlt (string)

    +
      +
    • (Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.
      +Default: 0000
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-submit-time | --tjst (string)

    +
      +
    • +

      (Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.
      +The triggered-job-submit-time is always rounded down to 15-minute increments.
      +Default: 0 (no specific submit time requirement)
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.

      +

      If triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates the Job JOBA having Triggered JOBB with triggered-job-due-out-time:

    +
      +
    • zowe ca7 job-definition create-job-trigger-successor --job JOBA --tj JOBB --tjdot 0830
    • +
    +
  • +
+

zoweca7job-definitioncreate-resource-count-resource

+

Add Resource Count Resource

+

Usage

+

zowe ca7 job-definition create-resource-count-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 39 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
  • +

    --resource-count | --rc (string)

    +
      +
    • Specifies the number of occurrences of the resource that the job uses.
      +Limits: 1 to 4 numeric characters from 0 through 9999
    • +
    +
  • +
  • +

    --free (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Valid values are:
      +A = Specifies the resource count is only decremented when the job abendsF = Specifies the resource count is decremented when the job completes, either successfully or unsuccessfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes, either successfully or unsuccessfullyN = Specifies the resource count is not decremented when the job completes. The PRSCF command can be used to decrement the resource count. A cancel of the job also decrements the resource countY = Specifies the resource count is decremented when the job or step ends successfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes successfully (does not abend)
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --step-name | --sn (string)

    +
      +
    • (Optional) Specifies the resource is freed at the conclusion of the named job step.
      +Limits: 1 to 8 alphanumeric characters
      +Notes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBA with resource name RESOURCE.NAME of free type F, step name JS010 and schedule id 23:

    +
      +
    • zowe ca7 job-definition create-resource-count-resource --job JOBA --schid 23 --rn RESOURCE.NAME --free F --sn JS010
    • +
    +
  • +
+

zoweca7job-definitioncreate-shared-resource

+

Post Shared Resource

+

Usage

+

zowe ca7 job-definition create-shared-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
  • +

    --free (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Valid values are:
      +A = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfullyN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resourceY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --step-name | --sn (string)

    +
      +
    • (Optional) Specifies the resource is freed at the conclusion of the named job step.
      +Limits: 1 to 8 alphanumeric characters
      +Notes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBAA with resource name SCHENV.VARNAME:

    +
      +
    • zowe ca7 job-definition create-shared-resource --job JOBAA --rn SCHENV.VARNAME --free A
    • +
    +
  • +
+

zoweca7job-definitioncreate-variable-resource

+

Add Variable Resource

+

Usage

+

zowe ca7 job-definition create-variable-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: "SCHENV." followed by 1 to 16 alphanumeric and @, #, $, _ characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBAA with resource name SCHENV.VARNAME and schedule id 23:

    +
      +
    • zowe ca7 job-definition create-variable-resource --job JOBAA --schid 23 --rn SCHENV.VARNAME
    • +
    +
  • +
+

zoweca7job-definitiondelete-address-space-resource

+

Delete Address Space Resource

+

Usage

+

zowe ca7 job-definition delete-address-space-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deletes a job named JOBA with resource name RESOURCE.NAME:

    +
      +
    • zowe ca7 job-definition delete-address-space-resource --job JOBA --rn RESOURCE.NAME --schid 42
    • +
    +
  • +
+

zoweca7job-definitiondelete-corequisite-resource

+

Delete Corequisite Resource

+

Usage

+

zowe ca7 job-definition delete-corequisite-resource [options]

+

Required Options

+
    +
  • +

    --job-name | --jn (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be nonblank, and no embedded blanks
      +Exception: If the resource connection is made to a resource count resource,
      +the resource name can be from 1 to 39 characters followed by a / (slash) and
      +a 1 through 4 numeric value indicating the number of occurrences for the resource that the job uses.
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied.
      +A zero default cannot be specified for one connection and a nonzero schedule ID used for
      +a subsequent connection to the same job with the same user requirement description.
      +An attempt to make such a connection results in an error message that is issued.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deletes a job named JOBA with resource name RESOURCE.NAME and schid 42:

    +
      +
    • zowe ca7 job-definition delete-corequisite-resource --jn JOBA --rn RESOURCE.NAME --schid 42
    • +
    +
  • +
+

zoweca7job-definitiondelete-exclusive-resource

+

Delete Exclusive Resource

+

Usage

+

zowe ca7 job-definition delete-exclusive-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deletes a job named JOBA with resource name RESOURCE.NAME:

    +
      +
    • zowe ca7 job-definition delete-exclusive-resource --job JOBA --rn RESOURCE.NAME --schid 42
    • +
    +
  • +
+

zoweca7job-definitiondelete-job

+

Delete Job Definition

+

Usage

+

zowe ca7 job-definition delete-job [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • The type of deletion.
      +Valid values are:
      +DELETE
      +Deletes a job and its associated data from the database (documentation, schedules, and so forth).DD
      +Same as DELETE, but deletes any data sets that this job references if the data sets have no users and
      +no documentation, and do not cause job triggering.
      +This includes all virtual resources that are connected to the job.PURGE
      +Same as DD, but also deletes job trigger definitions that trigger the job being deleted,
      +job requirement definitions that require the job being deleted;
      +and, if the WA Restart Option interface is active, deletes the WA Restart Option
      +CMT member for the job being deleted.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete Job named JOBA:

    +
      +
    • zowe ca7 job-definition delete-job --job JOBA --type DELETE
    • +
    +
  • +
+

zoweca7job-definitiondelete-job-trigger-successor

+

Delete Job Trigger

+

Usage

+

zowe ca7 job-definition delete-job-trigger-successor [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name whose successful completion causes triggering.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --triggered-job | --tj (string)

    +
      +
    • Specifies the job name that the completion of the triggering job triggers.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.
      +Default: 0 (all schedule IDs)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a Job Trigger JOBB from the definition of JOBA:

    +
      +
    • zowe ca7 job-definition delete-job-trigger-successor --job JOBA --tj JOBB
    • +
    +
  • +
+

zoweca7job-definitiondelete-resource-count-resource

+

Delete Resource Count Resource

+

Usage

+

zowe ca7 job-definition delete-resource-count-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 39 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deletes a job named JOBA with resource name RESOURCE.NAME:

    +
      +
    • zowe ca7 job-definition delete-resource-count-resource --job JOBA --rn RESOURCE.NAME --schid 42
    • +
    +
  • +
+

zoweca7job-definitiondelete-shared-resource

+

Delete Shared Resource

+

Usage

+

zowe ca7 job-definition delete-shared-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deletes a job named JOBAA with resource name SCHENV.VARNAME:

    +
      +
    • zowe ca7 job-definition delete-shared-resource --job JOBAA --schid 23 --rn SCHENV.VARNAME
    • +
    +
  • +
+

zoweca7job-definitiondelete-variable-resource

+

Delete Variable Resource

+

Usage

+

zowe ca7 job-definition delete-variable-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: "SCHENV." followed by 1 to 16 alphanumeric and @, #, $, _ characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deletes a job named JOBAA with resource name SCHENV.VARNAME:

    +
      +
    • zowe ca7 job-definition delete-variable-resource --job JOBAA --schid 23 --rn SCHENV.VARNAME
    • +
    +
  • +
+

zoweca7job-definitionlist-job

+

List Job Definiton

+

Usage

+

zowe ca7 job-definition list-job [options]

+

Required Options

+
    +
  • +

    --jobname | --jn (string)

    +
      +
    • The CA 7 job name
    • +
    +
  • +
  • +

    --all (boolean)

    +
      +
    • Fetch all the available properties
    • +
    +
  • +
+

Options

+
    +
  • +

    --databasename | --db (string)

    +
      +
    • The CA 7 database name
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Lists details of job named JOBA:

    +
      +
    • zowe ca7 job-definition list-job --jobname JOBA --all true
    • +
    +
  • +
+

zoweca7job-definitionlist-job-trigger-successor

+

Get Job Trigger Successor

+

Usage

+

zowe ca7 job-definition list-job-trigger-successor [options]

+

Required Options

+
    +
  • +

    --jobname | --job (string)

    +
      +
    • The CA 7 job name
    • +
    +
  • +
+

Options

+
    +
  • +

    --databasename | --db (string)

    +
      +
    • The CA 7 database name
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get a list of the triggered jobs for JOBA:

    +
      +
    • zowe ca7 job-definition list-job-trigger-successor --job JOBA
    • +
    +
  • +
+

zoweca7job-definitionupdate-address-space-resource

+

Modify Address Space Resource

+

Usage

+

zowe ca7 job-definition update-address-space-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --ready-when | --rw (string)

    +
      +
    • (Optional) Determines how VRM manages resource availability at job submission and job/step completion.
      +Default: A
      +Valid values are:
      +A = Specifies the job is submitted only if the resource is active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the systemI = Specifies the job is submitted only if the resource is not active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the system
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates a job named JOBA with resource name RESOURCE.NAME, schedule id 42 and job is submitted only if the resource is not active:

    +
      +
    • zowe ca7 job-definition update-address-space-resource --job JOBA --rn RESOURCE.NAME --rw I--schid 42
    • +
    +
  • +
+

zoweca7job-definitionupdate-corequisite-resource

+

Modify Corequisite Resource

+

Usage

+

zowe ca7 job-definition update-corequisite-resource [options]

+

Required Options

+
    +
  • +

    --job-name | --jn (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be nonblank, and no embedded blanks
      +Exception: If the resource connection is made to a resource count resource,
      +the resource name can be from 1 to 39 characters followed by a / (slash) and
      +a 1 through 4 numeric value indicating the number of occurrences for the resource that the job uses.
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied.
      +A zero default cannot be specified for one connection and a nonzero schedule ID used for
      +a subsequent connection to the same job with the same user requirement description.
      +An attempt to make such a connection results in an error message that is issued.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --ready-when | --rw (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Default: A
      +Valid values are:
      +A
      +Specifies the job is submitted only if the resource is active (as established by the PRSQA command).I
      +Specifies the job is submitted only if the resource is not active.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates a job named JOBA with resource name RESOURCE.NAME, schedule id 42 and job is submitted only if the resource is not active:

    +
      +
    • zowe ca7 job-definition update-corequisite-resource --jn JOBA --rn RESOURCE.NAME --schid 42 --rw I
    • +
    +
  • +
+

zoweca7job-definitionupdate-exclusive-resource

+

ExclusiveResource

+

Usage

+

zowe ca7 job-definition update-exclusive-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
  • +

    --free (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Valid values are:
      +A = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfullyN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resourceY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --step-name | --sn (string)

    +
      +
    • (Optional) Specifies the resource is freed at the conclusion of the named job step.
      +Limits: 1 to 8 alphanumeric characters
      +Notes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates a job named JOBA with resource name RESOURCE.NAME, of free type F, and schedule id 42 to job with step name JS011:

    +
      +
    • zowe ca7 job-definition update-exclusive-resource --job JOBA --rn RESOURCE.NAME --free F --sn JS011 --schid 42
    • +
    +
  • +
+

zoweca7job-definitionupdate-job

+

JobDefinition

+

Usage

+

zowe ca7 job-definition update-job [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job
    • +
    +
  • +
  • +

    --job-type | --jt (string)

    +
      +
    • The type of job.
      +Valid values are:
      +CPU = A CPU jobXPJOB = A cross-platform jobAGENT = An Agent job
    • +
    +
  • +
+

Options

+
    +
  • +

    --long-name | --ln (string)

    +
      +
    • (Optional) Defines the long job name.
      +Limits: 1 to 64 alphanumeric characters, case sensitive
    • +
    +
  • +
  • +

    --system (string)

    +
      +
    • (Optional) Specifies the user-defined application system name of which this job is a part.
      +Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma
    • +
    +
  • +
  • +

    --uid (string)

    +
      +
    • (Optional) Specifies the CA 7 user security identification.
      +Default: 0 (no internal security protection)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --jobnet (string)

    +
      +
    • (Optional) Specifies the name of a CPU job network of which this job is a part.
      +Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma
    • +
    +
  • +
  • +

    --owner (string)

    +
      +
    • (Optional) Specifies the ID identifying ownership of this job. Depending on the startup options taken, the external security product being used and contents of the JCL, this value can be offered to the external security package by CA 7 at job submission time as the authority for this job to be executed.
      +Limits: 1 to 8 alphanumeric characters. Although this field supports up to 8 characters, some external security packages only accept up to 7 characters. This field must not exceed any such limit that exists
    • +
    +
  • +
  • +

    --jcl-member | --jm (string)

    +
      +
    • (Optional) Specifies the JCL library member name and required when the member name and job name are different.
      +Valid when: job-type is CPU
      +Default: Job name
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --id (string)

    +
      +
    • (Optional) Specifies a numeric index value that is associated with a JCL library where the JCL member is located. NOTE: the id and lib properties are mutually exclusive.
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0-253 or 256-999
    • +
    +
  • +
  • +

    --lib (string)

    +
      +
    • (Optional) Specifies a JCL library identification consisting of a symbolic INDEX assigned to a JCL statement. NOTE: the id and lib properties are mutually exclusive.
      +Valid when: job-type is CPU
      +Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)
    • +
    +
  • +
  • +

    --reload (string)

    +
      +
    • (Optional) Specifies whether to reload the JCL of this job. When a job comes into the request queue, it is either flagged for load processing or it is not flagged.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = The job is flagged for load processing. The reload flag is automatically reset to N once the load completes successfullyN = The job is not flagged for load processing unless it is the first time it has run in CA 7X = The job is only flagged for load processing when the LOAD command is used and is never automatically changed even if the LOAD command is used
    • +
    +
  • +
  • +

    --execute (string)

    +
      +
    • (Optional) Indicates whether to execute this job.
      +Default: Y
      +Valid values are:
      +Y = The job will be executedN = The job does not run but shows a normal completion as if it did run. JCL is not required for non-executable jobs
    • +
    +
  • +
  • +

    --retain (string)

    +
      +
    • (Optional) Specifies whether to retain the execution JCL in the trailer queue after a successful run.
      +Valid when: job-type is CPU or XPJOB
      +Default: N
      +Valid values are:
      +Y = Retain the JCL in the trailer queue after a successful run.N = Do not retain the JCL in the trailer queue after a successful run
    • +
    +
  • +
  • +

    --hold (string)

    +
      +
    • (Optional) Specifies whether to place this job in a hold status when it enters the request queue.
      +Default: N
      +Valid values are:
      +Y = The job will be heldN = The job will not be held
    • +
    +
  • +
  • +

    --jcl-override | --jo (string)

    +
      +
    • (Optional) Specifies whether this job needs manual JCL overrides before it can be submitted. Similar to the JCLOVRD command.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = The job needs manual JCL overrides before it can be submittedN = The job does not need manual JCL overrides before it can be submitted
    • +
    +
  • +
  • +

    --use-jcl-override-library | --ujol (string)

    +
      +
    • (Optional) Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only. This field is automatically set back to N the next time the job comes into the request queue.
      +Default: N
      +Valid values are:
      +Y = The JCL is retrieved from the JCL Override library for the next runN = The JCL is not retrieved from the JCL Override library for the next run
    • +
    +
  • +
  • +

    --verify (string)

    +
      +
    • (Optional) Specifies whether this job requires any pre-submission manual verification. Similar to VERIFY command.
      +Default: N
      +Valid values are:
      +Y = The job requires any pre-submission manual verificationN = The job does not require any pre-submission manual verification
    • +
    +
  • +
  • +

    --maintenance | --maint (string)

    +
      +
    • (Optional) Specifies whether this job is a maintenance job (for example, a system utility) with no production data set requirements. If Y is specified, all input data set requirements are ignored. None of the output data sets created by this job is posted back to CA 7.
      +Marking a job as maintenance enables job triggering but not data set triggering.
      +Also, if the LOADDSNS keyword is used on the DBASE statement in the initialization file, the LOAD process does not build any DD or data set information for jobs that are marked as maintenance. This means that there are not any data set connections for these jobs unless added manually.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = The job is a maintenance jobN = The job is not a maintenance job
    • +
    +
  • +
  • +

    --job-requirement-lead-time | --jrlt (string)

    +
      +
    • (Optional) Specifies the number of hours to be considered when satisfying job-dependent requirements.
      +Default: 0
      +Valid values are:
      +0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each predecessor job must complete typically while this job is in the request queuenn = Since the last run of this job, specifies that each predecessor job must have run within the last nn hours. Values for nn can be from 1 to 98
    • +
    +
  • +
  • +

    --dataset-requirement-lead-time | --drlt (string)

    +
      +
    • (Optional) Specifies the number of hours to be considered when satisfying data set requirements.
      +Valid when: job-type is CPU
      +Default: 0
      +Valid values are:
      +0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each data set requirement must be satisfied typically while this job is in the request queuenn = Since the last run of this job, specifies that each data set requirement must be satisfied within the last nn hours. Values for nn can be from 1 to 98
    • +
    +
  • +
  • +

    --arfset (string)

    +
      +
    • (Optional) Names the collection of ARF definitions that apply to this job. Remember that ARF recovery is not invoked for non-executable jobs.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --mainid (string)

    +
      +
    • (Optional) Specifies on which CPU the job can or cannot be scheduled. If the job requirements impose CPU restrictions, specify SYn or /SYn where n is the system number and / indicates not this system. System numbers must be consistent with the initialization file CPU statement MAINIDS parameters.
      +Valid when: job-type is CPU
      +Default: ALL (lets the job run on any CPU)
      +Limits: 1 to 4 alphanumeric characters
    • +
    +
  • +
  • +

    --insert-ca11-rms | --icr (string)

    +
      +
    • (Optional) Specifies whether to insert the WA Restart Option RMS step automatically at execution time by CA 7.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = Inserts the step with the WA Restart Option processing code of PN = Does not insert the RMS step
    • +
    +
  • +
  • +

    --condition-code | --cc (string)

    +
      +
    • (Optional) Used with relational-operator property to define the job-level condition codes used to determine whether a job executes successfully.
      +Valid when: job-type is CPU or XPJOB
      +Note: All condition codes that are returned from an XPJOB job are treated as positive values. Any negative value returned is converted to an absolute (positive) value
      +Default: 0
      +Limits: For job-type = CPU: 1 to 4 numeric characters in the range 0-4095
      +For job-type = "XPJOB": 1 to 4 numeric characters in the range 0-9999
    • +
    +
  • +
  • +

    --relational-operator | --ro (string)

    +
      +
    • (Optional) Specifies the relational operator of the condition-code property or if the step level #SCC statements are being used in the job's JCL.
      +Valid when: job-type is CPU or XPJOB
      +Default: 0
      +Valid values are:
      +EQ = Equal toLT = Less thanGT = Greater thanGE = Greater than or equal toLE = Less than or equal toNE = Not equal to#S = Make step condition code tests based on #SCC statements in the JCLIG = Make no evaluation of the job. CA 7 always assumes the job completes successfully, regardless of condition codes, abend codes, or runtime JCL errors. When this is used, the insert-ca11-rms property should be N0 = No condition test will be madeNOTE: If 0 is used, no test is made on the job's condition code. The highest condition code that this job generates is tested by this pair of parameters. For example, if condition-code is set at 8 and RO is set at LT, the job is marked as completing abnormally if 8 is less than the job's highest condition code
    • +
    +
  • +
  • +

    --do-not-schedule-before-date | --dnsbd (string)

    +
      +
    • (Optional) Specifies not to schedule this job before this date (in YYDDD format, or 00000)
    • +
    +
  • +
  • +

    --do-not-schedule-before-time | --dnsbt (string)

    +
      +
    • (Optional) Specifies not to schedule this job before this time (in HHMM format)
    • +
    +
  • +
  • +

    --do-not-schedule-after-date | --dnsad (string)

    +
      +
    • (Optional) Specifies not to schedule this job after this date (in YYDDD format, or 99999)
    • +
    +
  • +
  • +

    --do-not-schedule-after-time | --dnsat (string)

    +
      +
    • (Optional) Specifies not to schedule this job after this time (in HHMM format)
    • +
    +
  • +
  • +

    --lterm (string)

    +
      +
    • (Optional) Routes the messages about this job to this logical terminal name.
      +Default: If not entered, the LTERM associated with the JCL library in the initialization file JCL statement is used. If LTERM is not specified on the JCL statement, the default is MASTER
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --list-requirements | --lr (string)

    +
      +
    • (Optional) Specifies whether to list pre-execution requirements for this job when it enters the request queue.
      +Default: Y
      +Valid values are:
      +Y = The pre-execution requirements will be listedN = The pre-execution requirements will not be listed
    • +
    +
  • +
  • +

    --prompts (string)

    +
      +
    • (Optional) Specifies whether to issue prompt messages when this job is late.
      +Default: Y
      +Valid values are:
      +Y = Prompt messages will be issued when the job is lateN = Prompt messages will not be issued when the job is late
    • +
    +
  • +
  • +

    --requirements-not-used | --rnu (string)

    +
      +
    • (Optional) Specifies whether to issue error messages for job requirements not used.
      +Default: Y
      +Valid values are:
      +Y = Messages will be issued if requirements are not usedN = Messages will not be issued if requirements are not used
    • +
    +
  • +
  • +

    --dsn-not-found | --dnf (string)

    +
      +
    • (Optional) Specifies whether to list error messages for data sets used at execution time but not found in the CA 7 database.
      +Valid when: job-type is CPU
      +Default: Y
      +Valid values are:
      +Y = Messages will be issued if data sets used are not found in the CA 7 databaseN = Messages will not be issued if data sets used are not found in the CA 7 database
    • +
    +
  • +
  • +

    --job-region | --jr (string)

    +
      +
    • (Optional) Specifies the region size that is required by this job (information only).
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 4 numeric characters
    • +
    +
  • +
  • +

    --elapsed-time | --et (string)

    +
      +
    • (Optional) CA 7 maintains certain SMF feedback data in its database, including a weighted average elapsed runtime. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.
      +Default: 0000
      +Limits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59
    • +
    +
  • +
  • +

    --average-cpu-time | --act (string)

    +
      +
    • (Optional) CA 7 maintains weighted average CPU time usage values for each job in its database. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.
      +Valid when: job-type is CPU
      +Default: 0000
      +Limits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59
    • +
    +
  • +
  • +

    --wlb-job-class | --wjc (string)

    +
      +
    • +

      (Optional) Specifies the CA 7 WLB job class. If not specified, a WLB class of A is automatically assigned. This value does not have to match the JOB statement CLASS value.

      +

      NOTE: The value specified here does not apply when the job enters the queue as a result of a RUN(H) command. Class 9 is assigned by default. To override class 9, use the RUNCLASS keyword on the OPTIONS statement in the initialization file.

      +

      NOTE: The value specified here does not apply when the job enters the queue as a result of a LOAD(H) command. Class 8 is assigned by default. To override class 8, use the LOADCLASS keyword on the OPTIONS statement in the initialization file
      +Default: A space
      +Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --wlb-priority | --wp (string)

    +
      +
    • (Optional) Specifies the CA 7 WLB job priority. A value of 255 indicates an express priority used to bypass WLB priority scheduling criteria. If using WLB, any job without a specified priority is automatically assigned a priority of 100 unless the default is changed
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0 - 255
    • +
    +
  • +
  • +

    --message-class | --mc (string)

    +
      +
    • (Optional) Specifies the job's message class. This field is informational only. Even though this field can be changed, it does not cause the JCL to be changed. Also, no validity checking is done on this field.
      +Valid when: job-type is CPU
      +Default: A space
      +Limits: 1 alphanumeric character
    • +
    +
  • +
  • +

    --drclass | --dc (string)

    +
      +
    • (Optional) Specifies the job's disaster recovery class. This field has no impact on processing during normal execution. When running in disaster recovery mode, the disaster recovery class is used to determine whether the job should execute.
      +Limits: 1 to 8 alphanumeric characters. Disaster recovery class values must start with a letter, #, or $ (not @) and can include letters, #, $, @, and numbers. Disaster recovery classes cannot contain embedded blanks
    • +
    +
  • +
  • +

    --number-1-tape-man | --n1tm (string)

    +
      +
    • (Optional) Specifies a manual override value for the number of TYPE1 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE1 tape drives.
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0 - 255
    • +
    +
  • +
  • +

    --number-2-tape-man | --n2tm (string)

    +
      +
    • (Optional) Specifies a manual override value for the number of TYPE2 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE2 tape drives.
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0 - 255
    • +
    +
  • +
  • +

    --xp-node | --xn (string)

    +
      +
    • (Required when job-type is XPJOB) Defines the CAICCI node to which the execution of this job is targeted. This field should state the primary node. If this node is unavailable and the node definition has alternate nodes defined, the execution of this job can be directed to an alternate node.
      +Valid when: job-type is XPJOB
      +Limits: 1 to 44 alphanumeric characters, although current z/OS CAICCI restricts this name to eight characters
    • +
    +
  • +
  • +

    --xp-exec | --xe (string)

    +
      +
    • (Required when job-type is XPJOB) Defines the executable (file, command) to execute at the targeted cross-platform node. If the targeted platform is a mainframe scheduling system such as CA 7, this value indicates the job name to execute on that platform. If the targeted platform is Workload Automation AE system, this value indicates a job that is defined in the Workload Automation AE system. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. Otherwise, the field is passed to the target system as-is and in its entirety. This value includes any embedded blanks and quotation marks.
      +Valid when: job-type is XPJOB
      +Limits: Up to 244 alphanumeric characters, and file delimiters of forward slash (/) and backward slash (\) signs. Note: Each backward slash character must be escaped by specifying (\\)
    • +
    +
  • +
  • +

    --xp-parm | --xp (string)

    +
      +
    • (Optional) Defines up to 128 bytes of parameter data to pass to the file or command being executed on the alternate platform. This data is supplied as PARM1 to the data being transmitted to the alternate platform. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. This value may be overridden if the PARMLIB/MEMBER field PARM1 is coded.
      +Valid when: job-type is XPJOB
      +Limits: Up to 128 EBCDIC characters
    • +
    +
  • +
  • +

    --parmlib | --pl (string)

    +
      +
    • (Optional) Defines extra, optional indexed, or symbolic (PDS) library from where execution data to be associated with this job can be found. This information is typically PARM1 through PARM64 keywords but can vary based on CA 7 system configuration options. If the PARM1 field is found within this file, it overrides the data that is specified in the XP PARM field that is listed on the panel.
      +Valid when: job-type is XPJOB or AGENT
      +Limits: 1 to 16 alphanumeric characters. If this field starts with a numeric value, the value is treated as a JCL Index value (0 - 253 or 256 - 999), and the associated numbered JCL library, as defined in the initialization file JCL statement, is used. If the first character is not numeric, the field must start with an ampersand (&) and must denote the library variable as defined using a /JCL command.
      +Note: Specifying data in the PARMLIB/MEMBER fields is in addition to anything specified in the XPPARM field. If XPPARM is coded, and if the PARMLIB/Member contains a PARM1 statement, the PARMLIB specification overrides the XP PARM field. Thus, if both XPPARM and PARMLIB PARM1 fields contain data, the data that is obtained from the PARMLIB/MEMBER is used in the data that is transmitted to the target node
    • +
    +
  • +
  • +

    --member (string)

    +
      +
    • (Optional) Indicates the PDS member name in the parmlib library where the parameters for this job reside.
      +Valid when: job-type is XPJOB or AGENT
      +Default: Same as the job property
      +Limits: 1 to 8 alphanumeric characters, beginning with an alphabetic character
    • +
    +
  • +
  • +

    --sutype (string)

    +
      +
    • (Optional) Specifies the type of "switch user" command to execute at the UNIX target node.
      +Valid when: job-type is XPJOB
      +Default: Y
      +Valid values are:
      +Y = Executes an "SU -" causing the environment setup to include execution of the ".PROFILE" for the target userN = Executes an "SU" command without the profile option
    • +
    +
  • +
  • +

    --xp-trace | --xt (string)

    +
      +
    • (Optional) Indicates whether to trace the activity that is associated with this job as it moves through the queues.
      +Valid when: job-type is XPJOB
      +Default: N
      +Valid values are:
      +Y = Issue WTOs as the job enters into the submission process. Retain up to 256 characters of the data that is sent for inclusion in a log recordN = Do not activate tracing for this job
    • +
    +
  • +
  • +

    --agent-job-type | --ajt (string)

    +
      +
    • (Required when job-type is AGENT) Defines the type of agent job. For more information about the Agent job types see:
      +[CA 7 Documentation](https://techdocs.broadcom.com/us/en/ca-mainframe-software/automation/ca-workload-automation-ca-7-edition/12-1/configuring/interfaces/cross-platform-scheduling/ca-workload-automation-agents/ca-7-agent-job-types.html/)
      +Valid when: job-type is AGENT
      +Default: There is no default value
      +Valid values are:
      +UNIX_JOB - Generic UNIXNT_JOB - Microsoft WindowsFILE_TRIGGER - File TriggerFTP_JOB - FTPSCP_JOB - Secure CopySFTP_JOB - Secure File TransferBDC_JOB - SAP Batch Input SessionBWIP_JOB - SAP Business Warehouse InfoPackageBWPC_JOB - SAP Business Warehouse Process ChainSAP_JOB - SAP GenericSAPA_JOB - SAP ArchiveSAPE_JOB - SAP Event MonitorSAPM_JOB - SAP Process MonitorPS_JOB - PeopleSoftOA_JOB - Oracle RequestOAC_JOB - Oracle CopyCPU_MON - CPU MonitorDISK_MON - Disk MonitorIP_MON - IP MonitorPROCESS_MON - Process MonitorTEXT_MON - Text File MonitorEVENTLOG_MON - Event Log MonitorSERVICE_MON - Service MonitorSQL_JOB - Database SQLDBSP_JOB - Database Stored ProcedureDB_MON - Database MonitorDB_TRIG - Database TriggerAS400_JOB - AS400/OS400JMSP_JOB - J2EE JMS PublishJMSS_JOB - J2EE JMS SubscribeEJBE_JOB - J2EE Entity BeanHTTP_JOB - J2EE HTTP/ServletPOJO_JOB - J2EE POJORMI_JOB - J2EE RMIEJB_JOB - J2EE Session BeanJMXB_JOB - JMX-Mbean Attribute GetJMXA_JOB - JMX-Mbean Attribute SetJMXO_JOB - JMX-Mbean OperationJMXS_JOB - JMX-Mbean SubscribeJMXN_JOB - JMX-Mbean Create InstanceJMXR_JOB - JMX-Mbean Remove InstanceSNPG_JOB - SNMP Get AttributeSNPS_JOB - SNMP Set AttributeSNPC_JOB - SNMP SubscribeSNPE_JOB - SNMP TrapSendWEB_SERV - Web ServicesWOL_JOB - Wake-On-LANPROXY_JOB - Remote ExecutionNONSTOP_JOB - HP Integrity NonStop
    • +
    +
  • +
  • +

    --agent (string)

    +
      +
    • (Required when job-type is AGENT) Identifies the explicit distributed platform where the job is to run.
      +Valid when: job-type is AGENT
      +Limits: 1 to 16 alphanumeric characters. The value must be defined to CA 7 using the IASAGENT DD statement
    • +
    +
  • +
  • +

    --agent-user | --au (string)

    +
      +
    • (Optional) Defines the user ID that is passed to the distributed platform where the job is to run.
      +Valid when: job-type is AGENT
      +Limits: 1 to 128 alphanumeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    updates long name of a job named JOBA to NewJob:

    +
      +
    • zowe ca7 job-definition update-job --job JOBAB --long-name NewJob --job-type CPU
    • +
    +
  • +
+

zoweca7job-definitionupdate-job-trigger-successor

+

Modify Job Trigger Successor

+

Usage

+

zowe ca7 job-definition update-job-trigger-successor [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name whose successful completion causes triggering.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --triggered-job | --tj (string)

    +
      +
    • Specifies the job name that the completion of the triggering job triggers.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.
      +Default: 0 (all schedule IDs)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --triggered-job-schid | --tjs (string)

    +
      +
    • (Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.
      +Default: 0 (no replacement)
      +Limits: 1 to 3 numeric characters from 0 through 999
      +Note: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.
    • +
    +
  • +
  • +

    --triggered-job-due-out-time | --tjdot (string)

    +
      +
    • (Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-queue-time must be omitted.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.
      +Note: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.
    • +
    +
  • +
  • +

    --triggered-job-queue-time | --tjqt (string)

    +
      +
    • (Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.
      +Deadline time is calculated as current date/time plus queue time.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-lead-time | --tjlt (string)

    +
      +
    • (Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.
      +Default: 0000
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-submit-time | --tjst (string)

    +
      +
    • +

      (Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.
      +The triggered-job-submit-time is always rounded down to 15-minute increments.
      +Default: 0 (no specific submit time requirement)
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.

      +

      If triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates the Job JOBA having Triggered JOBB with triggered-job-due-out-time with addition of triggered-job-lead-time to 0030 and triggered-job-submit-time to 1030:

    +
      +
    • zowe ca7 job-definition update-job-trigger-successor --job JOBA --tj JOBB --tjdot 0830 --tjlt 0030 --tjst 1030
    • +
    +
  • +
+

zoweca7job-definitionupdate-resource-count-resource

+

Modify Resource Count Resource

+

Usage

+

zowe ca7 job-definition update-resource-count-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 39 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
  • +

    --free (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Valid values are:
      +A = Specifies the resource count is only decremented when the job abendsF = Specifies the resource count is decremented when the job completes, either successfully or unsuccessfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes, either successfully or unsuccessfullyN = Specifies the resource count is not decremented when the job completes. The PRSCF command can be used to decrement the resource count. A cancel of the job also decrements the resource countY = Specifies the resource count is decremented when the job or step ends successfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes successfully (does not abend)
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --step-name | --sn (string)

    +
      +
    • (Optional) Specifies the resource is freed at the conclusion of the named job step.
      +Limits: 1 to 8 alphanumeric characters
      +Notes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates a job named JOBA with resource name RESOURCE.NAME, of free type F, and schedule id 42 to job with step name JS011:

    +
      +
    • zowe ca7 job-definition update-resource-count-resource --job JOBA --rn RESOURCE.NAME --free F --sn JS011 --schid 42
    • +
    +
  • +
+

zoweca7job-definitionupdate-shared-resource

+

Modify Shared Resource

+

Usage

+

zowe ca7 job-definition update-shared-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
  • +

    --free (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Valid values are:
      +A = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfullyN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resourceY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --step-name | --sn (string)

    +
      +
    • (Optional) Specifies the resource is freed at the conclusion of the named job step.
      +Limits: 1 to 8 alphanumeric characters
      +Notes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBAA with resource name SCHENV.VARNAME:

    +
      +
    • zowe ca7 job-definition update-shared-resource --job JOBAA --rn SCHENV.VARNAME --free A
    • +
    +
  • +
+

zoweca7job-instance

+

All the available commands listed in the Job Instance section.

+

zoweca7job-instancelist-waiting-resource

+

List waiting Resource

+

Usage

+

zowe ca7 job-instance list-waiting-resource [options]

+

Options

+
    +
  • +

    --job (string)

    +
      +
    • (Optional) Specifies a fully qualified or generic job name.
      +* - Specifies all jobs.
      +job - Specifies a fully qualified job name
      +Limits:: 1 to 8 alphanumeric characters
      +job - Specifies multiple jobs that a generic job name specifies.
      +Limits:: 1 to 7 alphanumeric characters that are terminated with an asterisk.
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • (Optional) A SCHID value of 0 applies to connections for all schedules and
      +therefore is listed with connections for any schedule ID requested. Default:: Null (causes connections for all schedule IDs to appear)Limits:: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    TODO:

    +
      +
    • zowe ca7 job-instance list-waiting-resource TODO
    • +
    +
  • +
+

zoweca7list-job-definition

+

All the available commands are listed in the COMMANDS section.

+

zoweca7list-job-definitionjob

+

Get a list of the job definitions for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition job [options]

+

Required Options

+
    +
  • +

    --all (string)

    +
      +
    • +

      all=false

      +

      Fetch all the available properties

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the job defintion information of a job, CA7DB which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition job --all true --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+

zoweca7list-job-definitionprose

+

Get a list of the prose information for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition prose [options]

+

Required Options

+
    +
  • +

    --jobname | -j (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      Defines the name of the jobname for the prose command

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --database | --db (string)

    +
      +
    • +

      db=CA7DB01

      +

      Defines the name of the database for the prose command

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List of the prose information for jobname, TESTJOB01 and database, TESTDB01:

    +
      +
    • zowe ca7 list-job-definition prose --jobname TESTJOB --database TESTDB
    • +
    +
  • +
+

zoweca7list-job-definitionrequirement-predecessor

+

Get a list of the predecessors for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition requirement-predecessor [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the predecessor of a job, TESTJOBwhich defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition requirement-predecessor --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+

zoweca7list-job-definitionrequirement-successor

+

Get a list of the successor jobs for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition requirement-successor [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the successor of a job, which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition requirement-successor --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+

zoweca7list-job-definitionresource

+

Get a list of the job resources for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition resource [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the resources of a job, TESTJOB which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition resource --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+

zoweca7list-job-definitionschedule

+

Get a list of the job schedules for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition schedule [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the schedule information of a job, TSETJOB which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition schedule --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+

zoweca7list-job-definitionstep-dd

+

Get a list of the job STEP and DD information for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition step-dd [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the SETP and DD statments of a job, TESTJOB which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition step-dd --db CA7TDB --jobname TESTJOB
    • +
    +
  • +
+

zoweca7list-job-definitiontrigger-predecessor

+

Get a list of the trigger objects for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition trigger-predecessor [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the trigger predecessor of a job, TESTJOB which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition trigger-predecessor --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+

zoweca7list-job-definitiontrigger-successor

+

Get a list of the triggered jobs for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition trigger-successor [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the trigger successor of a job, TESTJOB which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition trigger-successor --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+

zoweca7list-job-history

+

All the available commands are listed in the COMMANDS section.

+

zoweca7list-job-historyprior-run

+

Get a list one or more jobs from the prior-run queue.

+

Usage

+

zowe ca7 list-job-history prior-run [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Retrieve any job(s) from the prior-runqueue based on these two parameters:

    +
      +
    • zowe ca7 list-job-history prior-run --db CA7DB --jobname TEST%
    • +
    +
  • +
+

zoweca7list-job-instance

+

All the available commands are listed in the COMMANDS section.

+

zoweca7list-job-instanceactive-resource

+

Display active resources by job.

+

Usage

+

zowe ca7 list-job-instance active-resource [options]

+

Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies a fully qualified or generic job name.1. Specifies all jobs.
      +2. Specifies a fully qualified job name. Limits:: 1 to 8 alphanumeric characters
      +3. Specifies multiple jobs that a generic job name specifies. Limits:: 1 to 7 alphanumeric characters that are terminated with an asterisk.
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies a fully qualified or generic resource name. An asterisk indicates a generic request.1. Specifies all resources.
      +2. Specifies a fully qualified resource name. Limits::1 to 44 alphanumeric characters
      +3. Specifies multiple resources that a generic resource name specifies. Limits:: 1 to 43 alphanumeric characters that are terminated with an asterisk
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Display active resources by job RMTESTA1 along with other parameters:

    +
      +
    • zowe ca7 list-job-instance active-resource --job RMTESTA1 --rn A
    • +
    +
  • +
+

zoweca7list-job-instancejcl

+

Displays JCL for a job in the active workload.

+

Usage

+

zowe ca7 list-job-instance jcl [options]

+

Required Options

+
    +
  • +

    --ca7no (string)

    +
      +
    • +

      ca7no=0231

      +

      The CA 7 job number

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
  • +

    --showNo (boolean)

    +
      +
    • +

      showNo=true

      +

      Show line numbers in JCL

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Retreives JCL of a CA7 job, CA75TEST (7777) which resided in CA7DB database:

    +
      +
    • zowe ca7 list-job-instance jcl --ca7no 7777 --db CA7DB --showNo true
    • +
    +
  • +
+

zoweca7list-job-instancelist

+

Displays information about jobs in the active workload.

+

Usage

+

zowe ca7 list-job-instance list [options]

+

Options

+
    +
  • +

    --all (boolean)

    +
      +
    • +

      all=False

      +

      Fetch all the available properties
      +If the job number is provided, all the properties will be returned

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --ca7no (string)

    +
      +
    • +

      ca7no=0231

      +

      The CA 7 job number

      +
    • +
    +
  • +
  • +

    --databasename | --db (string)

    +
      +
    • +

      databasename=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=CA7TEST

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List a CA 7 job (7777) information which resided in CA7DB database :

    +
      +
    • zowe ca7 list-job-instance list --all false --ca7no 7777 --db CA7DB --jobname TESTCA7
    • +
    +
  • +
+

zoweca7list-job-instancelistCustom

+

Displays information about jobs in the active workload.

+

Usage

+

zowe ca7 list-job-instance listCustom [options]

+

Options

+
    +
  • +

    --ca7no (number)

    +
      +
    • +

      ca7no=0231

      +

      The CA 7 job number

      +
    • +
    +
  • +
  • +

    --databasename | --db (string)

    +
      +
    • +

      databasename=TESTDB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=CA7TEST

      +

      The CA 7 job name

      +
    • +
    +
  • +
  • +

    --job (boolean)

    +
      +
    • +

      job=true/false

      +

      The job name for this job in the active workload

      +
    • +
    +
  • +
  • +

    --queueName (boolean)

    +
      +
    • +

      queueName=true/false

      +

      The name of the queue in which this job is currently located.

      +
    • +
    +
  • +
  • +

    --ca7Num (boolean)

    +
      +
    • +

      ca7Num=true/false

      +

      The job number for this job in the active workload

      +
    • +
    +
  • +
  • +

    --status (boolean)

    +
      +
    • +

      status=true/false

      +

      The job status

      +
    • +
    +
  • +
  • +

    --entryMode (boolean)

    +
      +
    • +

      entryMode=true/false

      +

      Identifies how the job was brought into the queue.

      +
    • +
    +
  • +
  • +

    --abended (boolean)

    +
      +
    • +

      abended=true/false

      +

      Y if job abended, N if not

      +
    • +
    +
  • +
  • +

    --agentIntervention (boolean)

    +
      +
    • +

      agentIntervention=true/false

      +

      Y if INTERVENTION REQUIRED condition exists for this agent job, N if not

      +
    • +
    +
  • +
  • +

    --agentJobNumber (boolean)

    +
      +
    • +

      agentJobNumber=true/false

      +

      The job number/PID for this agent job

      +
    • +
    +
  • +
  • +

    --agentName (boolean)

    +
      +
    • +

      agentName=true/false

      +

      The name of the agent where this job will execute

      +
    • +
    +
  • +
  • +

    --agentStatus (boolean)

    +
      +
    • +

      agentStatus=true/false

      +

      The status for this agent job

      +
    • +
    +
  • +
  • +

    --agentStatusData (boolean)

    +
      +
    • +

      agentStatusData=true/false

      +

      Y if status data is available for this agent job,N if not

      +
    • +
    +
  • +
  • +

    --agentSubmitted (boolean)

    +
      +
    • +

      agentSubmitted=true/false

      +

      Y if agent job has been submitted to the agent, N if not

      +
    • +
    +
  • +
  • +

    --agentType (boolean)

    +
      +
    • +

      agentType=true/false

      +

      Agent job type, zero if this is not an agent job

      +
    • +
    +
  • +
  • +

    --agentUser (boolean)

    +
      +
    • +

      agentUser=true/false

      +

      The userid with which this agent job will execute

      +
    • +
    +
  • +
  • +

    --ajbBuildError (boolean)

    +
      +
    • +

      ajbBuildError=true/false

      +

      Y if an error occurred while building an XPJOB job AJB or an agent job AFM, N if not

      +
    • +
    +
  • +
  • +

    --arf (boolean)

    +
      +
    • +

      arf=true/false

      +

      Y if this job is monitored by ARF, N if not

      +
    • +
    +
  • +
  • +

    --arfAttachErr (boolean)

    +
      +
    • +

      arfAttachErr=true/false

      +

      Y if this job had an ARF attach error, N if not

      +
    • +
    +
  • +
  • +

    --arfCompMatched (boolean)

    +
      +
    • +

      arfCompMatched=true/false

      +

      Set to Y if an ARF JOB completion rule matched for this job

      +
    • +
    +
  • +
  • +

    --arfDate (boolean)

    +
      +
    • +

      arfDate=true/false

      +

      Y if the job uses ARF

      +
    • +
    +
  • +
  • +

    --arfErrorCond (boolean)

    +
      +
    • +

      arfErrorCond=true/false

      +

      Set to Y if there was an error during ARF condition detection, N if not

      +
    • +
    +
  • +
  • +

    --arfjJob (boolean)

    +
      +
    • +

      arfjJob=true/false

      +

      Y if job is an ARF recovery job, N if not

      +
    • +
    +
  • +
  • +

    --arfJobComplete (boolean)

    +
      +
    • +

      arfJobComplete=true/false

      +

      Set to Y if this job's completion has been posted to ARF, N if not

      +
    • +
    +
  • +
  • +

    --arfRecovery (boolean)

    +
      +
    • +

      arfRecovery=true/false

      +

      Y if job is in ARF recovery, N if not

      +
    • +
    +
  • +
  • +

    --arfRecoveryErr (boolean)

    +
      +
    • +

      arfRecoveryErr=true/false

      +

      Y if this job had an error in ARF recovery, N if not

      +
    • +
    +
  • +
  • +

    --arfset (boolean)

    +
      +
    • +

      arfset=true/false

      +

      The collection of ARF definitions that apply to this job

      +
    • +
    +
  • +
  • +

    --arfTime (boolean)

    +
      +
    • +

      arfTime=true/false

      +

      The date and time that the ARFSET was attached to this job

      +
    • +
    +
  • +
  • +

    --autofDone (boolean)

    +
      +
    • +

      autofDone=true/false

      +

      Y if job performed AUTO F, N if not

      +
    • +
    +
  • +
  • +

    --ca11JesNode (boolean)

    +
      +
    • +

      ca11JesNode=true/false

      +

      The JES node where this job executes

      +
    • +
    +
  • +
  • +

    --ca11RestartStep (boolean)

    +
      +
    • +

      ca11RestartStep=true/false

      +

      The relative CA 11 restart step number

      +
    • +
    +
  • +
  • +

    --ca11RmsCc (boolean)

    +
      +
    • +

      ca11RmsCc=true/false

      +

      The CA 11 U11RMS step condition code

      +
    • +
    +
  • +
  • +

    --ca11Subsystem (boolean)

    +
      +
    • +

      ca11Subsystem=true/false

      +

      The CA 11 subsystem name

      +
    • +
    +
  • +
  • +

    --ca7System (boolean)

    +
      +
    • +

      ca7System=true/false

      +

      The user-defined application system associated with this job

      +
    • +
    +
  • +
  • +

    --compCode (boolean)

    +
      +
    • +

      compCode=true/false

      +

      The job completion code in number format

      +
    • +
    +
  • +
  • +

    --cpmJfm (boolean)

    +
      +
    • +

      cpmJfm=true/false

      +

      Y if JFM is used to track CPM, N if not

      +
    • +
    +
  • +
  • +

    --cpuTableIndex (boolean)

    +
      +
    • +

      cpuTableIndex=true/false

      +

      Index to the CPU Table entry

      +
    • +
    +
  • +
  • +

    --cputime (boolean)

    +
      +
    • +

      cputime=true/false

      +

      This Job's average CPU time

      +
    • +
    +
  • +
  • +

    --currStepNum (boolean)

    +
      +
    • +

      currStepNum=true/false

      +

      The number of the step that is currently executing

      +
    • +
    +
  • +
  • +

    --defNotFound (boolean)

    +
      +
    • +

      defNotFound=true/false

      +

      Y if job defintion not found on database, N if not found

      +
    • +
    +
  • +
  • +

    --doNotPrompt (boolean)

    +
      +
    • +

      doNotPrompt=true/false

      +

      Y if prompts are bypassed for the job, N if not

      +
    • +
    +
  • +
  • +

    --drclass (boolean)

    +
      +
    • +

      drclass=true/false

      +

      The job's disaster recovery class

      +
    • +
    +
  • +
  • +

    --drmode (boolean)

    +
      +
    • +

      drmode=true/false

      +

      Y if this job entered the queues when disaster recovery mode was active, N if not

      +
    • +
    +
  • +
  • +

    --dueOutExists (boolean)

    +
      +
    • +

      dueOutExists=true/false

      +

      Determines if a zero value in DUE_OUT_TIME indicates midnight (Y) or no due out time (N)

      +
    • +
    +
  • +
  • +

    --dueOutTime (boolean)

    +
      +
    • +

      dueOutTime=true/false

      +

      The date and time this job is expected to complete

      +
    • +
    +
  • +
  • +

    --dupJob (boolean)

    +
      +
    • +

      dupJob=true/false

      +

      Y if a job with the same name is waiting on this job to complete, N if not

      +
    • +
    +
  • +
  • +

    --dupJobWait (boolean)

    +
      +
    • +

      dupJobWait=true/false

      +

      Y if this job is waiting on a job with the same name to complete, N if not

      +
    • +
    +
  • +
  • +

    --elapsedTime (boolean)

    +
      +
    • +

      elapsedTime=true/false

      +

      This Job's average elapsed time

      +
    • +
    +
  • +
  • +

    --endTime (boolean)

    +
      +
    • +

      endTime=true/false

      +

      The date and time this job ended

      +
    • +
    +
  • +
  • +

    --executable (boolean)

    +
      +
    • +

      executable=true/false

      +

      Y if job is executable, N if not

      +
    • +
    +
  • +
  • +

    --express (boolean)

    +
      +
    • +

      express=true/false

      +

      Y if submission of this job has been expedited by use of the SUBMIT,EXPRESS=YES command, N if not

      +
    • +
    +
  • +
  • +

    --externalInput (boolean)

    +
      +
    • +

      externalInput=true/false

      +

      Y if we job has external input, N if not

      +
    • +
    +
  • +
  • +

    --externalJob (boolean)

    +
      +
    • +

      externalJob=true/false

      +

      Y if this is an externally tracked job, N if not

      +
    • +
    +
  • +
  • +

    --externalSatisfied (boolean)

    +
      +
    • +

      externalSatisfied=true/false

      +

      The number of satisfied external requirements for this job

      +
    • +
    +
  • +
  • +

    --externalTotal (boolean)

    +
      +
    • +

      externalTotal=true/false

      +

      The total number of external requirements for this job

      +
    • +
    +
  • +
  • +

    --forcedComplete (boolean)

    +
      +
    • +

      forcedComplete=true/false

      +

      Y if job was force completed, N if not

      +
    • +
    +
  • +
  • +

    --forcedSubmit (boolean)

    +
      +
    • +

      forcedSubmit=true/false

      +

      Y if all input requirements have been marked as satisfied by use of the SUBMIT command, N if not

      +
    • +
    +
  • +
  • +

    --fromXpRequest (boolean)

    +
      +
    • +

      fromXpRequest=true/false

      +

      Y if scheduling request for this job came from an XPS client, N if not

      +
    • +
    +
  • +
  • +

    --hasCa11 (boolean)

    +
      +
    • +

      hasCa11=true/false

      +

      Y if job has a CA11 segment, N if not

      +
    • +
    +
  • +
  • +

    --hasCpuTime (boolean)

    +
      +
    • +

      hasCpuTime=true/false

      +

      Y if we have non-zero CPU time for this job, N if not

      +
    • +
    +
  • +
  • +

    --hasJo (boolean)

    +
      +
    • +

      hasJo=true/false

      +

      Y if the JCL or PARM DATA contains a #JO card, N if not

      +
    • +
    +
  • +
  • +

    --hasStepTime (boolean)

    +
      +
    • +

      hasStepTime=true/false

      +

      Y if job has non-zero step CPU time, N if not

      +
    • +
    +
  • +
  • +

    --held (boolean)

    +
      +
    • +

      held=true/false

      +

      Y if job is held, N if not

      +
    • +
    +
  • +
  • +

    --heldByJob (boolean)

    +
      +
    • +

      heldByJob=true/false

      +

      Y if job was held on entry to the queues, N if not

      +
    • +
    +
  • +
  • +

    --heldSkeleton (boolean)

    +
      +
    • +

      heldSkeleton=true/false

      +

      Y if job is held and in skeleton status, N if not

      +
    • +
    +
  • +
  • +

    --skeleton (boolean)

    +
      +
    • +

      skeleton=true/false

      +

      Y if job is in skeleton status, N if not

      +
    • +
    +
  • +
  • +

    --holdOnEntry (boolean)

    +
      +
    • +

      holdOnEntry=true/false

      +

      Y if job marked HOLD=YES, N if not

      +
    • +
    +
  • +
  • +

    --hostName (boolean)

    +
      +
    • +

      hostName=true/false

      +

      The SMF Id of the system where this is executing

      +
    • +
    +
  • +
  • +

    --inCpmFlow (boolean)

    +
      +
    • +

      inCpmFlow=true/false

      +

      Y if job is part of a CPM flow, N if not

      +
    • +
    +
  • +
  • +

    --insertRms (boolean)

    +
      +
    • +

      insertRms=true/false

      +

      Y if an RMS step will be inserted into this job's JCL, N if not

      +
    • +
    +
  • +
  • +

    --jclAllocErr (boolean)

    +
      +
    • +

      jclAllocErr=true/false

      +

      Y if JCL or PARM DATA library could not be allocated, N if not

      +
    • +
    +
  • +
  • +

    --jclCount (boolean)

    +
      +
    • +

      jclCount=true/false

      +

      The number of non-# records in the JCL or PARM DATA members associated with this job

      +
    • +
    +
  • +
  • +

    --jclError (boolean)

    +
      +
    • +

      jclError=true/false

      +

      Y if job marked with JCL error, N if not

      +
    • +
    +
  • +
  • +

    --jclFromAltlib (boolean)

    +
      +
    • +

      jclFromAltlib=true/false

      +

      Y if JCL or PARM DATA was retrieved from an alternate library, N if not

      +
    • +
    +
  • +
  • +

    --jclLibrary (boolean)

    +
      +
    • +

      jclLibrary=true/false

      +

      Contains either a 3 digit JCL index value or a JCL variable beginning with an ampersand

      +
    • +
    +
  • +
  • +

    --jesHi (boolean)

    +
      +
    • +

      jesHi=true/false

      +

      JES supports ID > 99999

      +
    • +
    +
  • +
  • +

    --loadOnly (boolean)

    +
      +
    • +

      loadOnly=true/false

      +

      Y if this is a LOAD only job, N if not

      +
    • +
    +
  • +
  • +

    --loadStepDone (boolean)

    +
      +
    • +

      loadStepDone=true/false

      +

      Y if LOAD step ran OK for this job, N if not

      +
    • +
    +
  • +
  • +

    --locked (boolean)

    +
      +
    • +

      locked=true/false

      +

      Y if job is locked, N if not

      +
    • +
    +
  • +
  • +

    --longName (boolean)

    +
      +
    • +

      longName=true/false

      +

      An alias name for this job. This name may be used by scheduling engines on other platforms, such as AutoSys

      +
    • +
    +
  • +
  • +

    --lterm (boolean)

    +
      +
    • +

      lterm=true/false

      +

      Logical terminal name from job definition

      +
    • +
    +
  • +
  • +

    --mainid (boolean)

    +
      +
    • +

      mainid=true/false

      +

      If positive, the CPU number on which the job may execute. If negative, the CPU number on which the job may not execute

      +
    • +
    +
  • +
  • +

    --maint (boolean)

    +
      +
    • +

      maint=true/false

      +

      Y if job ignores requirements, N if not

      +
    • +
    +
  • +
  • +

    --manualRequeue (boolean)

    +
      +
    • +

      manualRequeue=true/false

      +

      Y if job has been re-queued to REQUEST queue, N if not

      +
    • +
    +
  • +
  • +

    --memberName (boolean)

    +
      +
    • +

      memberName=true/false

      +

      The JCL or PARM DATA library member name

      +
    • +
    +
  • +
  • +

    --mustStartExists (boolean)

    +
      +
    • +

      mustStartExists=true/false

      +

      Determines if a zero value in MUST_START_TIME indicates midnight (Y) or no deadline time (N)

      +
    • +
    +
  • +
  • +

    --needsAutof (boolean)

    +
      +
    • +

      needsAutof=true/false

      +

      Y if a job changed and requires 'F' in CA11, N if not

      +
    • +
    +
  • +
  • +

    --nextRunReq (boolean)

    +
      +
    • +

      nextRunReq=true/false

      +

      Y if job has temporary requirements for the next execution, N if not

      +
    • +
    +
  • +
  • +

    --nodeFailed (boolean)

    +
      +
    • +

      nodeFailed=true/false

      +

      Y if this is an XPJOB job and at the time of it last submit its node was down, N if not

      +
    • +
    +
  • +
  • +

    --nodeOffline (boolean)

    +
      +
    • +

      nodeOffline=true/false

      +

      Y if this is an XPJOB job and at the time of its last submit its node was offline, N if not

      +
    • +
    +
  • +
  • +

    --nodeStopped (boolean)

    +
      +
    • +

      nodeStopped=true/false

      +

      Y if this is an XPJOB job and at the time of it last submit its node was stopped, N if not

      +
    • +
    +
  • +
  • +

    --noUserId (boolean)

    +
      +
    • +

      noUserId=true/false

      +

      Y if there is not a valid security id for this job, N if there is

      +
    • +
    +
  • +
  • +

    --noXpsiParmlib (boolean)

    +
      +
    • +

      noXpsiParmlib=true/false

      +

      Y if this is an XPJOB job and has no PARMLIB, N if not

      +
    • +
    +
  • +
  • +

    --noXpsiXpsparm (boolean)

    +
      +
    • +

      noXpsiXpsparm=true/false

      +

      Y if this is an XPJOB job and has no PARM, N if not

      +
    • +
    +
  • +
  • +

    --override (boolean)

    +
      +
    • +

      override=true/false

      +

      Y if JCL/PARM DATA override is required, N if not

      +
    • +
    +
  • +
  • +

    --overrideApplied (boolean)

    +
      +
    • +

      overrideApplied=true/false

      +

      Y if JCL overrides have been applied for this job, N if not

      +
    • +
    +
  • +
  • +

    --prompt (boolean)

    +
      +
    • +

      prompt=true/false

      +

      Y if job should have LATE PROMPTS, N if not

      +
    • +
    +
  • +
  • +

    --promptAck (boolean)

    +
      +
    • +

      promptAck=true/false

      +

      Y if user has acknowledged the prompt, N if not

      +
    • +
    +
  • +
  • +

    --prompted (boolean)

    +
      +
    • +

      prompted=true/false

      +

      Y if user has been prompted, N if not

      +
    • +
    +
  • +
  • +

    --qjclUpdated (boolean)

    +
      +
    • +

      qjclUpdated=true/false

      +

      Y if JCL or PARM DATA updated through QJCL, N if not

      +
    • +
    +
  • +
  • +

    --queueJcl (boolean)

    +
      +
    • +

      queueJcl=true/false

      +

      Y if a QJCL command is in progress for this job N if not

      +
    • +
    +
  • +
  • +

    --repeatCount (boolean)

    +
      +
    • +

      repeatCount=true/false

      +

      The number of times to repeat this job

      +
    • +
    +
  • +
  • +

    --repeatDiff (boolean)

    +
      +
    • repeatDiff=true/false
    • +
    +
  • +
  • +

    --ca7No (boolean)

    +
      +
    • +

      ca7No=true/false

      +

      The difference between the original dueout time and the original submit time, used by repeating jobs

      +
    • +
    +
  • +
  • +

    --repeatInterval (boolean)

    +
      +
    • +

      repeatInterval=true/false

      +

      The interval between repetitions of the job

      +
    • +
    +
  • +
  • +

    --repeatLeadTime (boolean)

    +
      +
    • +

      repeatLeadTime=true/false

      +

      The lead time for this repeat job. This is the amount of time to ensure it completes before it due out time

      +
    • +
    +
  • +
  • +

    --repeatStopExists (boolean)

    +
      +
    • +

      repeatStopExists=true/false

      +

      Determines if a zero value in REPEAT_STOP_TIME indicates midnight (Y) or no repeat stop time (N)

      +
    • +
    +
  • +
  • +

    --repeatStopTime (boolean)

    +
      +
    • +

      repeatStopTime=true/false

      +

      The date and time on or after which a repeating job will not be repeated

      +
    • +
    +
  • +
  • +

    --repeatType (boolean)

    +
      +
    • +

      repeatType=true/false

      +

      The type of repeat job. This field determines how the submit time requierement is calculated for repeating jobs

      +
    • +
    +
  • +
  • +

    --restartStep (boolean)

    +
      +
    • +

      restartStep=true/false

      +

      The step name in which the job was restarted

      +
    • +
    +
  • +
  • +

    --retainJcl (boolean)

    +
      +
    • +

      retainJcl=true/false

      +

      Y if JCL or XPJOB information will be retained in the prior run queue, N if not

      +
    • +
    +
  • +
  • +

    --rqmtCount (boolean)

    +
      +
    • +

      rqmtCount=true/false

      +

      The master requirement count for this job. The number includes unsatisfied requirements, submit time, and other reasons preventing the job from being submitted

      +
    • +
    +
  • +
  • +

    --schdAdjusted (boolean)

    +
      +
    • +

      schdAdjusted=true/false

      +

      Y if job's schedule has been adjusted, N if not

      +
    • +
    +
  • +
  • +

    --nosecurity (boolean)

    +
      +
    • +

      nosecurity=true/false

      +

      Y if there was an error retrieving security data,N if no

      +
    • +
    +
  • +
  • +

    --setNdb (boolean)

    +
      +
    • +

      setNdb=true/false

      +

      Y if job will bypass LOAD processing at completion and not update the database, N if not

      +
    • +
    +
  • +
  • +

    --smfNeeded (boolean)

    +
      +
    • +

      smfNeeded=true/false

      +

      Y if SMF feedback is needed for this job, N if not

      +
    • +
    +
  • +
  • +

    --startTime (boolean)

    +
      +
    • +

      startTime=true/false

      +

      The date and time this job started executing on its most recent submission

      +
    • +
    +
  • +
  • +

    --submitted (boolean)

    +
      +
    • +

      submitted=true/false

      +

      Y if this job has been submitted to the host, N if not

      +
    • +
    +
  • +
  • +

    --submitTime (boolean)

    +
      +
    • +

      submitTime=true/false

      +

      The date and time this job was submitted

      +
    • +
    +
  • +
  • +

    --triggered (boolean)

    +
      +
    • +

      triggered=true/false

      +

      Y if job triggered by another job, N if not

      +
    • +
    +
  • +
  • +

    --uid (boolean)

    +
      +
    • +

      uid=true/false

      +

      The CA 7 internal user security designation

      +
    • +
    +
  • +
  • +

    --verify (boolean)

    +
      +
    • +

      verify=true/false

      +

      Y if job has a manual verification requirement, N if not

      +
    • +
    +
  • +
  • +

    --waitSubmitTime (boolean)

    +
      +
    • +

      waitSubmitTime=true/false

      +

      Y if this job has a submit time requirement, N if not

      +
    • +
    +
  • +
  • +

    --xpAltNode (boolean)

    +
      +
    • +

      xpAltNode=true/false

      +

      The alternate node where this XPJOB job was routed

      +
    • +
    +
  • +
  • +

    --xpPrimaryNode (boolean)

    +
      +
    • +

      xpPrimaryNode=true/false

      +

      The primary node associated with this XPJOB job

      +
    • +
    +
  • +
  • +

    --xpsJob (boolean)

    +
      +
    • +

      xpsJob=true/false

      +

      Y if this is an XPJOB job, N if not

      +
    • +
    +
  • +
  • +

    --xpStatus (boolean)

    +
      +
    • +

      xpStatus=true/false

      +

      The status of the node associated with this XPJOB job. A: Active F: Failed CCI send O: Offline S:Stopped

      +
    • +
    +
  • +
  • +

    --xtrackerInact (boolean)

    +
      +
    • +

      xtrackerInact=true/false

      +

      Y if at time of submission, the XTRACKER task is not active for an XPJOB job or IAS is not active for an agent job, N if not

      +
    • +
    +
  • +
  • +

    --xplatNode (boolean)

    +
      +
    • +

      xplatNode=true/false

      +

      Cross platform long node name

      +
    • +
    +
  • +
  • +

    --responseError (boolean)

    +
      +
    • responseError=true/false
    • +
    +
  • +
  • +

    --ca11FailingStepNum (boolean)

    +
      +
    • +

      ca11FailingStepNum=true/false

      +

      CA 11 Failing Step Number

      +
    • +
    +
  • +
  • +

    --completeOk (boolean)

    +
      +
    • +

      completeOk=true/false

      +

      Y if job completed normally, N if not

      +
    • +
    +
  • +
  • +

    --jesNum (boolean)

    +
      +
    • +

      jesNum=true/false

      +

      The JES job number for this job. A value of -1 indicates NA

      +
    • +
    +
  • +
  • +

    --needsLoad (boolean)

    +
      +
    • +

      needsLoad=true/false

      +

      Y if LOAD processing will be done for this job, Nif not

      +
    • +
    +
  • +
  • +

    --deadline (boolean)

    +
      +
    • +

      deadline=true/false

      +

      The date and time a job must be started by in order to meet its due out time

      +
    • +
    +
  • +
  • +

    --jclfrom254 (boolean)

    +
      +
    • +

      jclfrom254=true/false

      +

      Y if JCL or XPJOB information will be retained in the prior run queue, N if not

      +
    • +
    +
  • +
  • +

    --proseNum (boolean)

    +
      +
    • +

      proseNum=true/false

      +

      Number of the prose text associated with this job, or zero

      +
    • +
    +
  • +
  • +

    --scheduleId (boolean)

    +
      +
    • +

      scheduleId=true/false

      +

      The schedule id for this execution

      +
    • +
    +
  • +
  • +

    --triggeringJobNum (boolean)

    +
      +
    • +

      triggeringJobNum=true/false

      +

      The CA 7 internal job number of the job that triggered this job or job that created the data set that triggered this job

      +
    • +
    +
  • +
  • +

    --triggers (boolean)

    +
      +
    • +

      triggers=true/false

      +

      Y if job can trigger other jobs, N if not

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List a CA 7 job (7777) information which resided in CA7DB database :

    +
      +
    • zowe ca7 list-job-instance listCustom --ca7no 7777 --db CA7DB --jobname TESTCA7
    • +
    +
  • +
+

zoweca7list-job-instancerequirements

+

Displays information about requirements for jobs in the active workload.

+

Usage

+

zowe ca7 list-job-instance requirements [options]

+

Required Options

+
    +
  • +

    --ca7no (string)

    +
      +
    • +

      ca7no=0231

      +

      The CA 7 job number

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --databasename | --db (string)

    +
      +
    • +

      databasename=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Retrieves the job requirements of a CA 7 job (7777) which resided in CA7DB database:

    +
      +
    • zowe ca7 list-job-instance requirements --ca7no 7777 --db CA7DB
    • +
    +
  • +
+

zoweca7list-resource-definition

+

All the available commands are listed in the COMMANDS section.

+

zoweca7list-resource-definitionresource-count-resource

+

Retrieves a Resource Count Resource Information

+

Usage

+

zowe ca7 list-resource-definition resource-count-resource [options]

+

Required Options

+
    +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the name of the Resource Count Resource to delete.
      +Limits: 1 to 39 alphanumeric characters and periods
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Retrieves a Resource Count Resource:

    +
      +
    • zowe ca7 list-resource-definition resource-count-resource --rn PAYROLL.RCT
    • +
    +
  • +
+

zoweca7update-job-definition

+

All the available commands are listed in the COMMANDS section.

+

zoweca7update-job-definitionjob

+

Update requirement definition for a job

+

Usage

+

zowe ca7 update-job-definition job [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job to update
    • +
    +
  • +
  • +

    --job-type | --jt (string)

    +
      +
    • The type of job. Valid values are: CPU|XPJOB|AGENT
    • +
    +
  • +
+

Options

+
    +
  • +

    --execute (string)

    +
      +
    • Indicates whether to execute this job.
      +Valid values are: Y/N
    • +
    +
  • +
  • +

    --use-jcl-override-library | --ujol (string)

    +
      +
    • Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only (Y or N).
      +This field is automatically set back to N the next time the job comes into the request queue
    • +
    +
  • +
  • +

    --do-not-schedule-before-date | --dnsbd (string)

    +
      +
    • Specifies not to schedule this job before this date (in YYDDD format, or 00000)
    • +
    +
  • +
  • +

    --do-not-schedule-before-time | --dnsbt (string)

    +
      +
    • Specifies not to schedule this job before this time (in HHMM format)
    • +
    +
  • +
  • +

    --do-not-schedule-after-date | --dnsad (string)

    +
      +
    • Specifies not to schedule this job after this date (in YYDDD format, or 99999)
    • +
    +
  • +
  • +

    --do-not-schedule-after-time | --dnsat (string)

    +
      +
    • Specifies not to schedule this job after this time (in HHMM format)
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a CPU type job, TESTJOB1 to be executable:

    +
      +
    • zowe ca7 update-job-definition job --job TESTJOB1 --job-type CPU --execute Y
    • +
    +
  • +
+

zoweca7update-job-definitionrequirement-predecessor

+

Update requirement definition for a job

+

Usage

+

zowe ca7 update-job-definition requirement-predecessor [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job that requires the predecessor
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • The schedule id of requiring job
    • +
    +
  • +
  • +

    --predtype (string)

    +
      +
    • The predecessor type
    • +
    +
  • +
  • +

    --nextrun (string)

    +
      +
    • The status of predecessor for next run of job
      +[ YES, ONLY, SKIP ]
    • +
    +
  • +
  • +

    --predobject (string)

    +
      +
    • The predecessor. Values vary with predtype.
      +The predecessor. Values vary with predtype.
      +When “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.
      +When “predtype”:”USER” then “predobject” is 1-44 character user requirement text.
    • +
    +
  • +
+

Options

+
    +
  • +

    --leadtime (string)

    +
      +
    • The satisfaction lead time in hours.
      +This may be honored when “predtype” is “job or “DSN”
    • +
    +
  • +
  • +

    --permanent (string)

    +
      +
    • Indicates that this predecessor is permanent, that is always considered satisfied.
      +This parameter only applies when “predtype” is “DSN”
      +[ Y, N ]
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    post TESJOB1 0009 USER ONLY "APCDAL.TESTDB01.TEST":

    +
      +
    • zowe ca7 update-job-definition requirement-predecessor TESJOB1 0009 USER ONLY "APCDAL.TESTDB01.TEST"
    • +
    +
  • +
+

zoweca7update-job-definitionschedule

+

Modify schedule parameters

+

Usage

+

zowe ca7 update-job-definition schedule [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • Specifies the numeric schedule ID on which the user wants to perform the specified action.
      +Limits: 1 to 3 numeric characters from 1 through 999
    • +
    +
  • +
+

Options

+
    +
  • +

    --scal (string)

    +
      +
    • Specifies the override of the default SCAL for this SCHID. Specify scal if you want to override the default scal.
      +Limits: 2 alphanumeric characters
    • +
    +
  • +
  • +

    --default-scal | --dscal (string)

    +
      +
    • Specifies the default SCAL for this job. If this is not specified, an LJOB will be issued to fetch the SCAL
      +Limits: 2 alphanumeric characters
    • +
    +
  • +
  • +

    --due-out-time | --dot (string)

    +
      +
    • Specifies the due-out time of day for this schedule ID.
      +Limits: 4 numeric characters that are specified as hhmm
      +where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
    • +
    +
  • +
  • +

    --lead-time | --lt (string)

    +
      +
    • Specifies the due-out time of day for this schedule ID.
      +Limits: 4 numeric characters that are specified as hhmm
      +where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
    • +
    +
  • +
  • +

    --submit-time | --st (string)

    +
      +
    • Specifies the submit time of day for this schedule ID.
      +If specified, the job is not submitted before this time.
      +If the submit time is before deadline start time,
      +the submit time requirement is automatically satisfied when the job enters the queue.
      +A submit time of zeros is the same as not specifying it, and no submit time is set up.
      +Note:If the submit time is after the due-out time, the submit day value is set to the previous day.
      +Limits: 4 numeric characters that are specified as hhmm
      +where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
    • +
    +
  • +
  • +

    --daily (string)

    +
      +
    • Specifies that the user wants to define a daily schedule.
      +Daily means every available processing day as defined by the Base Calendar.
      +If DAILY is used, the ROLL has no effect.
      +Limits: One of Y or N
    • +
    +
  • +
  • +

    --roll (string)

    +
      +
    • Specifies the action to take when a schedule day falls on a base calendar non available processing day.
      +This value is not used if the DAILY option is used
      +If DAILY is used, the ROLL has no effect.
      +If used, the value must be one of the following values:
      +B: Roll the schedule back to the previous available processing day in the Base Calendar.
      +F: Roll forward the schedule to the next available processing day.
      +N: Do not roll. Schedule day must stand.
      +D: Do not roll and do not schedule.
      +Default:D
    • +
    +
  • +
  • +

    --index (string)

    +
      +
    • Specifies an adjustment to schedule days.
      +After you exercise the ROLL option, the schedule is adjusted,
      +forward for plus or backward for minus, by the number of working days entered.
      +Limits:4 numeric characters that are specified as Innn where I can be plus (unsigned) or minus (-) and nnn can be 0 to 365 daysUsage:
      +Use this field with the RDAY field to schedule a job to run three workdays before the 15th of the month:
      +specify -3 in the INDEX field, X in the MONTHLY field, and 15 in the RDAY field.
    • +
    +
  • +
  • +

    --interval (string)

    +
      +
    • Specifies that the job should be repeated (executed more than once) and
      +specifies the amount of time between each iteration.
      +If INTERVAL is specified, the SBTM (submit time requirement) and TYPE fields are required.
      +If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.
      +Limits:4 numeric characters in hhmm format where hh can be from 0 to 23 and mm can be from 00 to 59
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • Determines how the submit time requirement is calculated for repeating jobs.
      +A TYPE of CLOCK indicates that the INTERVAL is added to the previous iteration's
      +submit time requirement to determine the new submit time requirement.
      +A TYPE of START and END indicates that the INTERVAL is added to the previous iteration's
      +last (most recent) start and end times,respectively, to determine the new submit time requirement.
      +TYPE is required if INTERVAL is specified.
      +TYPE is discarded if INTERVAL is not specifiedLimits:CLOCK, START, or END
    • +
    +
  • +
  • +

    --count (string)

    +
      +
    • Specifies the maximum number of times to repeat the job.
      +COUNT is discarded if INTERVAL is not specified.
      +If both COUNT and STOP are specified, the job stops repeating when the COUNT reaches zero or the STOP time is reached, whichever comes first.
      +If COUNT is not specified, the job repeats until the STOP time is reached.TYPE is required if INTERVAL is specified. TYPE is discarded if INTERVAL is not specifiedLimits:1 to 4 numeric characters from 0 to 1439. Leading zeros can be discarded.
    • +
    +
  • +
  • +

    --weekly (string)

    +
      +
    • Specifies that the user wants to define a weekly schedule.
      +If WEEKLY is used, the run days of the week must be specified using DAYS field
      +Limits:Y or N
    • +
    +
  • +
  • +

    --days (string)

    +
      +
    • Defines specific days of the week on which to run the job.
      +as comma separated list of day name abbreviations.
      +Limits: A comma separated list of Sun,Mon,Tue,Wed,Thu,Fri,Sat
    • +
    +
  • +
  • +

    --monthly (string)

    +
      +
    • Specifies that the user wants to define a monthly schedule.
      +If this field is used, the user can optionally specify on which particular months the job is to run.
      +If specific months are not specified in the months property, all months are assumed.Limits: Y or N
    • +
    +
  • +
  • +

    --months (string)

    +
      +
    • Defines specific months on which to run the job.
      +as comma separated list of month name abbreviations.
      +Limits: A comma separated list of Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec
    • +
    +
  • +
  • +

    --weeks-of-month | --wom (string)

    +
      +
    • Specifies the weeks of the month to run the job.
      +The values that are specified can be positive (unsigned), negative (-) or slash (/).
      +Positive values 1, 2, 3, 4, or 5 are used to indicate the week relative to the beginning of the month.
      +Negative values -0, -1, and -2 are used to indicate occurrence of week relative to the end of the month.
      +Slashes indicate the job will not run the following value.
      +Limits: 1 to 14 numeric characters and required if MONTHLY and DAY-OF-WEEK are used.
      +The values are separated by comma
    • +
    +
  • +
  • +

    --day-of-week | --dow (string)

    +
      +
    • Specifies which days of the week to run the job.
      +If used, each day must be the first three letters of the wanted run days.
      +If you want to specify multiple days, use a comma separated list for example MON,TUE,FRI.
      +Limits: A comma separated list of SUN, MON, TUE, WED, THU, FRI, SAT, case insensitive
    • +
    +
  • +
  • +

    --relative-day | --rd (string)

    +
      +
    • Specifies relative days of the month on which the job is to run. Used with MONTHLY.
      +A day relative to the beginning or end of the month is specified.
      +If a positive (unsigned) value is used, the job runs that day relative to the first of the month.
      +Also, if you have days of the month when this job is not to run,a slash (/) can be used with the unsigned or negative values.
      +Valid positive values range from 1 to 31.
      +Valid negative values range from -0 to -30.
      +Limits:1 to 60 numeric characters, separated by comma.
      +Note:relative-day(s) represents calendar days, unless the base calendar was generated with OPTIONS=SCHDYONLY,
      +in which case relative-day(s) represents processing days.
    • +
    +
  • +
  • +

    --annual (string)

    +
      +
    • Defines an annual schedule.
      +Limits: If annual is used, day is required. One of Y, N
    • +
    +
  • +
  • +

    --day-of-year | --doy (string)

    +
      +
    • Specifies on which days of the annual schedule the user wants to run the job.
      +Days are entered as 1 through 366 and are prefixed by positive (unsigned) or slash (/) values.
      +Slash indicates the job will not run this day.
      +For example, if a job is to run on days 121, 132, 240, and 241, but is not to run on days 122, 242, and 1,the user would specify: /1,121,/122,132,240,241,/242
      +Limits: 1 to 55 numeric characters and required if annual is used.
      +The numbers will be separated by comma
    • +
    +
  • +
  • +

    --symmetric (string)

    +
      +
    • Used with the START and SPAN fields, defines a symmetric schedule.
      +With this option, schedules are defined as beginning on the date specified with
      +the START field and recurring every nnn days as specified with the SPAN field.
      +Limits: One of Y, N
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • This field is required when the SYMETRIC option is taken.
      +Value must be specified as the Julian day of the year on which the symmetric schedule is to begin.
      +This value should be evaluated yearly before schedule resolution and may need to be changed each year.
      +If the schedule will be resolved on a July-June basis, the start date must be within
      +the first of the two years in which the schedule overlaps.
      +For January-December schedules, it is simply relative to January 1 of the year specified on a RESOLV command.
      +If the calendar against which this SCHID will be resolved does not have the OPTIONS=SCHDYONLY,
      +the START day is adjusted each year to maintain the job's symmetric schedule from the job's original specified START day.
      +If the calendar against which the SCHID will be resolved was generated with overall available processing days only (OPTIONS=SCHDYONLY)
      +the start date must specify the first day on which the job would actually run.
      +This requires manually setting (verifying) the START value each year before the RESOLV.
      +If a nonprocessing day is specified, the start day is the next processing day found in the calendar.
      +For example, if January 1 is a nonprocessing day and the calendar was generated with OPTIONS=SCHDYONLY,
      +and 1 is specified as the START day, January 2 is the actual START day (provided it is an available processing day).
      +SPAN is based from January 2 in this example rather than January 1.
      +For other types of calendars, the start date is determined at RESOLV time based on the ROLL and INDEX options taken.
      +Limits: 3 numeric characters specified as Julian day of the year from 1 to 365
    • +
    +
  • +
  • +

    --span (string)

    +
      +
    • Used with SYMETRIC and START, defines symmetric schedules.
      +This field is required if the SYMETRIC option is taken.
      +When used, specifies the number of days between scheduled processing cycles.
      +If the calendar against which the SCHID will be resolved was generated with processing days
      +only (OPTIONS=SCHDYONLY), the SPAN value is specified as the number of available processing days
      +between and including the next processing date as opposed to the actual number of days.
      +With this type of calendar, the ROLL and INDEX options serve no practical purpose.
      +For other calendar types, the SPAN value is specified as the number of calendar days
      +between processing cycles and the ROLL and INDEX options can be used as necessary.
      +Limits: 1 to 3 numeric characters from 1 to 255
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Modify a schedule for job TESTJOB1 with the parameters:

    +
      +
    • zowe ca7 update-job-definition schedule --job TESTJOB1 --schid 01 --dscal 03
    • +
    +
  • +
+

zoweca7update-job-instance

+

All the available commands are listed in the COMMANDS section.

+

zoweca7update-job-instancejcl

+

Update JCL for a job

+

Usage

+

zowe ca7 update-job-instance jcl [options]

+

Required Options

+
    +
  • +

    --ca7no (string)

    +
      +
    • The CA 7 job number
    • +
    +
  • +
  • +

    --sourcedataset (string)

    +
      +
    • The source data set name containing the new JCL
    • +
    +
  • +
  • +

    --sourcemember (string)

    +
      +
    • The source data set member name containing the new JCL
    • +
    +
  • +
  • +

    --sourcetype (string)

    +
      +
    • +

      The source type containing the new JCL

      +

      currently: dataset is by the default and the only option

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --postjclovrd (string)

    +
      +
    • Indicates whether to post the JCL override requirement when the JCL is updated
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update JCL for a job TESJOB1 along with other parameters:

    +
      +
    • zowe ca7 update-job-instance jcl TESJOB1 0009 USER ONLY "APCDAL.TESTDB01.TEST"
    • +
    +
  • +
+

zoweca7update-resource-definition

+

All the available commands are listed in the COMMANDS section.

+

zoweca7update-resource-definitionresource-count-resource

+

Modify Resource Count Resource parameters

+

Usage

+

zowe ca7 update-resource-definition resource-count-resource [options]

+

Required Options

+
    +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the name of the Resource Count Resource to update.
      +Limits: 1 to 39 alphanumeric characters and periods
    • +
    +
  • +
  • +

    --total-count | --tc (string)

    +
      +
    • Specifies the total number of available occurrences for this Resource Count Resource.
      +Limits: 1 to 4 numeric characters in the range 0-9999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Modify Resource named PAYROLL.RCT to count 125:

    +
      +
    • zowe ca7 update-resource-definition resource-count-resource --rn PAYROLL.RCT --tc 125
    • +
    +
  • +
+
+

zowecaview

+

Access View data and perform related tasks.

+

zowecaviewdownload

+

Download View report data to local folder.

+

zowecaviewdownloadreport

+

Download report data.
+Optionally convert text report to PDF.

+

Usage

+

zowe caview download report <repositoryId> <reportHandle> [fileTarget] [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    reportHandle (string)

    +
      +
    • Report handle.
    • +
    +
  • +
  • +

    fileTarget (string)

    +
      +
    • Local file path.
      +If the path represents a directory location, the report will be downloaded into that directory using a default file name.
      +If the path does not represent a directory location, the report will be downloaded into the specified path.
      +If the path is not specified, the file will be saved to the current working directory using the default file name.
      +Any missing directories will be created. If the target file already exists, the file will be overwritten.
    • +
    +
  • +
+

Options

+
    +
  • +

    --convert-to-pdf | --to-pdf (boolean)

    +
      +
    • +

      Converts text report to PDF.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --page-orientation | --orientation (string)

    +
      +
    • +

      Page orientation for converted PDF.

      +

      Default value: PORTRAIT
      +Allowed values: ^PORTRAIT$, ^LANDSCAPE$

      +
    • +
    +
  • +
  • +

    --font-size | --font (number)

    +
      +
    • +

      Font size for converted PDF.

      +

      Default value: 12

      +
    • +
    +
  • +
  • +

    --green-bar (boolean)

    +
      +
    • +

      Include green-bar background in converted PDF.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --pages (string)

    +
      +
    • +

      Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas.
      +Separate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are downloaded.

      +

      Allowed values: ^(\d+(-\d+)?)(,(\d+(-\d+)?))*$

      +
    • +
    +
  • +
  • +

    --content-filter | --filter (string)

    +
      +
    • Filter text report content using a permanent filter definition.
      +If the product instance does not support this feature, this option is ignored.
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewexport

+

Export View text report file to local folder.

+

zowecaviewexportreport

+

Export text report to spreadsheet using a predefined export rule.

+

Usage

+

zowe caview export report <repositoryId> <reportHandle> <ruleId> [fileTarget] [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    reportHandle (string)

    +
      +
    • Report handle.
    • +
    +
  • +
  • +

    ruleId (number)

    +
      +
    • Export rule identifier.
    • +
    +
  • +
  • +

    fileTarget (string)

    +
      +
    • Local file path.
      +If the path represents a directory location, the report will be exported into that directory using a default file name.
      +If the path does not represent a directory location, the report will be exported into the specified path.
      +If the path is not specified, the file will be saved to the current working directory using the default file name.
      +Any missing directories will be created. If the target file already exists, the file will be overwritten.
    • +
    +
  • +
+

Options

+
    +
  • +

    --pages (string)

    +
      +
    • +

      Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas.
      +Separate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are exported.

      +

      Allowed values: ^(\d+(-\d+)?)(,(\d+(-\d+)?))*$

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewget

+

Get information from View repository.

+

zowecaviewgetuser

+

Get user information from repository.

+

zowecaviewgetusersettings

+

Get current user settings from repository.

+

Usage

+

zowe caview get user settings <repositoryId> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Mode,DistId,ModeAccess,DistMask,Banner,Language,MasterAuthority,Printer,UserId

      +

      Default value: Mode,DistId,ModeAccess,DistMask

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewlist

+

List View repository, report, and user information.

+

zowecaviewlistexport-rules

+

List export rules defined for a report.
+Use the returned 'Identifier' in the 'export report' command to reference that rule.

+

Usage

+

zowe caview list export-rules <reportId> [options]

+

Positional Arguments

+
    +
  • +

    reportId (string)

    +
      +
    • Report ID (Name).
    • +
    +
  • +
+

Options

+
    +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Identifier,Name,Description,Owner,Public

      +

      Default value: Identifier,Name,Description

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewlistreport

+

List information about a specific report.

+

zowecaviewlistreportindex-names

+

List indexes for a a specific report.
+Use the returned 'IndexNameHandle' to reference a report index.
+Use the returned 'IndexNameHandle' in the 'list report index-values' command to retrieve the list of associated index values for that index.

+

Usage

+

zowe caview list report index-names <repositoryId> <reportHandle> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    reportHandle (string)

    +
      +
    • Report handle.
    • +
    +
  • +
+

Options

+
    +
  • +

    --filter-names | --names (string)

    +
      +
    • +

      Filter (include) based on index name. Separate multiple index names with commas. Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *,*,*,*,*,*,*,*

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Index,SubIndexNames,IndexNameHandle

      +

      Default value: Index,SubIndexNames,IndexNameHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewlistreportindex-values

+

List index values for a report index.
+Use the returned 'ReportHandle' to reference an index value in other commands.
+For example, use 'ReportHandle' in the 'download report' command to download that corresponding view of the report.

+

Usage

+

zowe caview list report index-values <repositoryId> <reportHandle> <indexNameHandle> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    reportHandle (string)

    +
      +
    • Report handle.
    • +
    +
  • +
  • +

    indexNameHandle (string)

    +
      +
    • Index name handle.
    • +
    +
  • +
+

Options

+
    +
  • +

    --filter-values | --values (string)

    +
      +
    • +

      Filter (include) based on index values. Separate index values with commas. Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *,*,*,*,*,*,*,*

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Value,SubValues,ReportHandle

      +

      Default value: Value,SubValues,ReportHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewlistreportlogical-views

+

List logical views available for a specific report.
+Use the returned 'ReportHandle' to reference a logical view in other commands.
+For example, use 'ReportHandle' in the 'download report' command to download the logical view of that report.
+Use the returned 'IndexNameHandle' in the 'list report index-values' command to retrieve the list of associated index values (if defined) for that index.

+

Usage

+

zowe caview list report logical-views <repositoryId> <reportHandle> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    reportHandle (string)

    +
      +
    • Report handle.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Description,Index,SubIndexNames,ReportHandle,IndexNameHandle,Number,ViewId,Default

      +

      Default value: Description,Index,SubIndexNames,ReportHandle,IndexNameHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewlistreports

+

List reports in a repository.
+Use the returned 'ReportHandle' to reference a report in other commands.
+For example, use the 'ReportHandle' in the 'download report' command to download that report.

+

Usage

+

zowe caview list reports <repositoryId> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
+

Options

+
    +
  • +

    --filter-name | -n (string)

    +
      +
    • +

      Filter (include) based on report name. Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --limit | -l (number)

    +
      +
    • +

      Limit (maximum number) of retrieved records.

      +

      Default value: 1000

      +
    • +
    +
  • +
  • +

    --latest-versions | --latest-version | --lv (number)

    +
      +
    • +

      Number of latest versions (of reports) to include. If not specified, all versions of reports are included.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --archival-since | --since | --archival-from | --from (string)

    +
      +
    • Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --archival-until | --until | --archival-to | --to (string)

    +
      +
    • Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle,TotalPages,OriginalType,Destination,JobName,Origin,Generation,SequenceNumber,SysoutClass,Status,JobID,Forms,XCode,UserID,ReadDate,PrintDate,OnDisk,OnTape,OnOptical,IndexOnDisk,Location,TapeSequence,TapePosition,TapeCount,ExtendedRetentionOptionID,RemainingDays,RemainingGenerations,RemainingCopy,RemainingDiskDays,RemainingDiskGeneration,RemainingDiskCopy,RemainingDisk2days

      +

      Default value: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewlistrepositories

+

List repositories.
+Use the returned 'Identifier' to reference a repository in other commands.
+For example, use the 'Identifier' in the list reports' command to list reports in that repository.

+

Usage

+

zowe caview list repositories [options]

+

Options

+
    +
  • +

    --filter-name | -n (string)

    +
      +
    • Filter (include) based on repository name. Use the percent sign (%) as a wildcard to represent a single character. Use the asterisk (*) as a wildcard to represent any number of characters.
    • +
    +
  • +
  • +

    --filter-path | -p (string)

    +
      +
    • +

      Filter (include) based on repository path. Use the percent sign (%) as a wildcard to represent a single character. Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Identifier,Name,Description,Path,CharacterSet,ReportAccess,CreatedBy,DateCreated,ModifiedBy,ModifiedDate

      +

      Default value: Identifier,Name,Description,Path,CharacterSet

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewsearch

+

Search data in a View repository.

+

zowecaviewsearchindex

+

Search cross-report index data in a repository.

+

zowecaviewsearchindexnames

+

Search cross-report index names in a repository.
+Use the returned 'IndexNameHandle' to reference a cross-report index name.
+For example, use the 'IndexNameHandle' in the 'search index values' command to retrieve the list of index values for that cross-report index.

+

Usage

+

zowe caview search index names <repositoryId> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
+

Options

+
    +
  • +

    --filter-reports | --reports (string)

    +
      +
    • +

      Filter (include) based on report names (IDs). Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --filter-names | --names (string)

    +
      +
    • +

      Filter (include) based on index name. Separate multiple index names with commas. Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *,*,*,*,*,*,*,*

      +
    • +
    +
  • +
  • +

    --latest-versions | --latest-version | --lv (number)

    +
      +
    • +

      Number of latest versions (of reports) to include. If not specified, all versions of reports are included.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --archival-since | --since | --archival-from | --from (string)

    +
      +
    • Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --archival-until | --until | --archival-to | --to (string)

    +
      +
    • Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --online-only | --online (boolean)

    +
      +
    • +

      Include only those reports that are available online.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Index,SubIndexNames,IndexNameHandle

      +

      Default value: Index,SubIndexNames,IndexNameHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewsearchindexreports

+

Search reports containing a cross-report index value in a repository.
+Use the returned 'ReportHandle' to reference a view of the report.
+For example, use the 'ReportHandle' in the 'download report' command to download that view of the report.

+

Usage

+

zowe caview search index reports <repositoryId> <indexNameHandle> <valueHandle> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    indexNameHandle (string)

    +
      +
    • Index name handle.
    • +
    +
  • +
  • +

    valueHandle (string)

    +
      +
    • Index value handle.
    • +
    +
  • +
+

Options

+
    +
  • +

    --filter-reports | --reports (string)

    +
      +
    • +

      Filter (include) based on report names (IDs). Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --latest-versions | --latest-version | --lv (number)

    +
      +
    • +

      Number of latest versions (of reports) to include. If not specified, all versions of reports are included.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --archival-since | --since | --archival-from | --from (string)

    +
      +
    • Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --archival-until | --until | --archival-to | --to (string)

    +
      +
    • Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --online-only | --online (boolean)

    +
      +
    • +

      Include only those reports that are available online.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle,TotalPages,OriginalType,Destination,JobName,Origin,Generation,SequenceNumber,SysoutClass,Status,JobID,Forms,XCode,UserID,ReadDate,PrintDate,OnDisk,OnTape,OnOptical,IndexOnDisk,Location,TapeSequence,TapePosition,TapeCount,ExtendedRetentionOptionID,RemainingDays,RemainingGenerations,RemainingCopy,RemainingDiskDays,RemainingDiskGeneration,RemainingDiskCopy,RemainingDisk2days

      +

      Default value: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewsearchindexvalues

+

Search cross-report index values in a repository.
+Use the returned 'IndexValueHandle' in the 'search index reports' command to retrieve the list of reports containing that index value.

+

Usage

+

zowe caview search index values <repositoryId> <indexNameHandle> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    indexNameHandle (string)

    +
      +
    • Index name handle.
    • +
    +
  • +
+

Options

+
    +
  • +

    --filter-reports | --reports (string)

    +
      +
    • +

      Filter (include) based on report names (IDs). Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --filter-values | --values (string)

    +
      +
    • +

      Filter (include) based on index values. Separate index values with commas. Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *,*,*,*,*,*,*,*

      +
    • +
    +
  • +
  • +

    --latest-versions | --latest-version | --lv (number)

    +
      +
    • +

      Number of latest versions (of reports) to include. If not specified, all versions of reports are included.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --archival-since | --since | --archival-from | --from (string)

    +
      +
    • Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --archival-until | --until | --archival-to | --to (string)

    +
      +
    • Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --online-only | --online (boolean)

    +
      +
    • +

      Include only those reports that are available online.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Value,SubValues,IndexValueHandle

      +

      Default value: Value,SubValues,IndexValueHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewset

+

Set information in View repository.

+

zowecaviewsetuser

+

Set configuration for current user in repository.

+

zowecaviewsetuserdistribution

+

Set distribution id for current user in repository.

+

Usage

+

zowe caview set user distribution <repositoryId> <distributionId> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    distributionId (string)

    +
      +
    • Distribution ID.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Mode,DistId,ModeAccess,DistMask,Banner,Language,MasterAuthority,Printer,UserId

      +

      Default value: Mode,DistId,ModeAccess,DistMask

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

zowecaviewsetusermode

+

Set mode for current user in repository.

+

Usage

+

zowe caview set user mode <repositoryId> <mode> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    mode (string)

    +
      +
    • User mode.
      +Must match regular expression: ^(ALL|SAR|SARO|EXP|EXPO)$
    • +
    +
  • +
+

Options

+
    +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Mode,DistId,ModeAccess,DistMask,Banner,Language,MasterAuthority,Printer,UserId

      +

      Default value: Mode,DistId,ModeAccess,DistMask

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+

zowecics

+

Interact with IBM CICS programs and transactions.

+

zowecicsadd-to-list

+

Add new resources (for example, CSD Groups to CSD Lists) to CICS through IBM CMCI.

+

zowecicsadd-to-listcsdGroup

+

Add a CSD Group to a CICS CSD List.

+

Usage

+

zowe cics add-to-list csdGroup <name> <csdList> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • The name of the CSD Group to add. The maximum length of the CSD Group name is eight characters
    • +
    +
  • +
  • +

    csdList (string)

    +
      +
    • The name of the CSD List to add the group to. The maximum length of the CSD List name is eight characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to add the CSD Group to the CSD List
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to add the CSD Group to the CSD List
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Add the CSD Group MYGRP to the CSD List MYLIST in the region named MYREG:

    +
      +
    • zowe cics add-to-list csdGroup MYGRP MYLIST --region-name MYREG
    • +
    +
  • +
+

zowecicsdefine

+

Define new resources (for example, programs) to CICS through IBM CMCI.

+

zowecicsdefineprogram

+

Define a new program to CICS.

+

Usage

+

zowe cics define program <programName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    programName (string)

    +
      +
    • The name of the new program to define. The maximum length of the program name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the new program that you want to define. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to define the new program
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to define the new program
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Define a program named PGM123 to the region name MYREGION in the CSD group MYGRP:

    +
      +
    • zowe cics define program PGM123 MYGRP --region-name MYREGION
    • +
    +
  • +
+

zowecicsdefinetransaction

+

Define a new transaction to CICS.

+

Usage

+

zowe cics define transaction <transactionName> <programName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    transactionName (string)

    +
      +
    • The name of the new transaction to define. The maximum length of the transaction name is four characters.
    • +
    +
  • +
  • +

    programName (string)

    +
      +
    • The name of the program that the transaction uses. The maximum length of the program name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the new transaction that you want to define. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to define the new transaction
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to define the new transaction
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Define a transaction named TRN1 for the program named PGM123 to the region named MYREGION in the CSD group MYGRP:

    +
      +
    • zowe cics define transaction TRN1 PGM123 MYGRP --region-name MYREGION
    • +
    +
  • +
+

zowecicsdefineurimap-client

+

Define a new URIMAP of type client to CICS. This acts as an HTTP(S) client

+

Usage

+

zowe cics define urimap-client <urimapName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the URIMAP to create. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the new urimap that you want to define. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --urimap-path | --up (string)

    +
      +
    • The path component of the URI.
    • +
    +
  • +
  • +

    --urimap-host | --uh (string)

    +
      +
    • The host component of the URI.
    • +
    +
  • +
+

Options

+
    +
  • +

    --urimap-scheme | --us (string)

    +
      +
    • +

      The scheme component to be used with the request (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --authenticate | --auth (string)

    +
      +
    • +

      The authentication and identification scheme to be used for client URIMAPs.

      +

      Allowed values: NO, BASIC

      +
    • +
    +
  • +
  • +

    --certificate | --cert (string)

    +
      +
    • The label of a certificate in the keyring that is to be used as the client certificate in SSL handshakes
    • +
    +
  • +
  • +

    --description | --desc (string)

    +
      +
    • Description of the URIMAP resource being defined.
    • +
    +
  • +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to define the new URIMAP.
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to define the new URIMAP.
    • +
    +
  • +
  • +

    --enable (boolean)

    +
      +
    • +

      Whether or not the URIMAP is to be enabled on install by default.

      +

      Default value: true

      +
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Define a URIMAP named URIMAPA to the region named MYREGION in the CSD group MYGRP where the host is www.example.com and the path is /example/index.html:

    +
      +
    • zowe cics define urimap-client URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --region-name MYREGION
    • +
    +
  • +
+

zowecicsdefineurimap-pipeline

+

Define a new URIMAP of type pipeline to CICS. This processes incoming HTTP(S) requests

+

Usage

+

zowe cics define urimap-pipeline <urimapName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the URIMAP to create. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the new urimap that you want to define. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --urimap-path | --up (string)

    +
      +
    • The path component of the URI.
    • +
    +
  • +
  • +

    --urimap-host | --uh (string)

    +
      +
    • The host component of the URI.
    • +
    +
  • +
  • +

    --pipeline-name | --pn (string)

    +
      +
    • The name of the PIPELINE resource definition for the URIMAP. The maximum length of the pipeline name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --urimap-scheme | --us (string)

    +
      +
    • +

      The scheme component to be used with the request (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --description | --desc (string)

    +
      +
    • Description of the URIMAP resource being defined.
    • +
    +
  • +
  • +

    --transaction-name | --tn (string)

    +
      +
    • The name of the TRANSACTION resource definition for the URIMAP. The maximum length of the transaction name is four characters.
    • +
    +
  • +
  • +

    --webservice-name | --wn (string)

    +
      +
    • The name of the WEBSERVICE resource definition for the URIMAP. The maximum length of the transaction name is 32 characters.
    • +
    +
  • +
  • +

    --tcpipservice | --tcpip (string)

    +
      +
    • The TCPIPSERVICE to which the URIMAP definition applies.
    • +
    +
  • +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to define the new URIMAP.
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to define the new URIMAP.
    • +
    +
  • +
  • +

    --enable (boolean)

    +
      +
    • +

      Whether or not the URIMAP is to be enabled on install by default.

      +

      Default value: true

      +
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Define a URIMAP named URIMAPA for the pipeline named PIPE123 to the region named MYREGION in the CSD group MYGRP where the host is www.example.com and the path is /example/index.html:

    +
      +
    • zowe cics define urimap-pipeline URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --pipeline-name PIPE123 --region-name MYREGION
    • +
    +
  • +
+

zowecicsdefineurimap-server

+

Define a new URIMAP of type server to CICS. This acts as an HTTP(S) server

+

Usage

+

zowe cics define urimap-server <urimapName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the URIMAP to create. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the new urimap that you want to define. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --urimap-path | --up (string)

    +
      +
    • The path component of the URI.
    • +
    +
  • +
  • +

    --urimap-host | --uh (string)

    +
      +
    • The host component of the URI.
    • +
    +
  • +
  • +

    --program-name | --pn (string)

    +
      +
    • The application program that makes or handles the requests.
    • +
    +
  • +
+

Options

+
    +
  • +

    --urimap-scheme | --us (string)

    +
      +
    • +

      The scheme component to be used with the request (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --description | --desc (string)

    +
      +
    • Description of the URIMAP resource being defined.
    • +
    +
  • +
  • +

    --tcpipservice | --tcpip (string)

    +
      +
    • The TCPIPSERVICE to which the URIMAP definition applies.
    • +
    +
  • +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to define the new URIMAP.
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to define the new URIMAP.
    • +
    +
  • +
  • +

    --enable (boolean)

    +
      +
    • +

      Whether or not the URIMAP is to be enabled on install by default.

      +

      Default value: true

      +
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Define a URIMAP named URIMAPA for the program named PGM123 to the region named MYREGION in the CSD group MYGRP where the host is www.example.com and the path is /example/index.html:

    +
      +
    • zowe cics define urimap-server URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --program-name PGM123 --region-name MYREGION
    • +
    +
  • +
+

zowecicsdefinewebservice

+

Define a new web service to CICS.

+

Usage

+

zowe cics define webservice <webserviceName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    webserviceName (string)

    +
      +
    • The name of the WEBSERVICE to create. The maximum length of the web service name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the new web service that you want to define. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --pipeline-name | --pn (string)

    +
      +
    • The name of the PIPELINE resource definition for the web service. The maximum length of the pipeline name is eight characters
    • +
    +
  • +
  • +

    --wsbind (string)

    +
      +
    • The file name of the web service binding file on HFS.
    • +
    +
  • +
+

Options

+
    +
  • +

    --description | --desc (string)

    +
      +
    • Description of the web service resource being defined.
    • +
    +
  • +
  • +

    --validation (boolean)

    +
      +
    • +

      Specifies whether full validation of SOAP messages against the corresponding schema in the web service description should be performed at run time.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --wsdlfile | --wsdl (string)

    +
      +
    • The file name of the web service description (WSDL) file on HFS.
    • +
    +
  • +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to define the new web service.
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to define the new web service.
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Define a webservice named WEBSVCA for the pipeline named PIPE123 to the region named MYREGION in the CSD group MYGRP where the binding file is /u/exampleapp/wsbind/example.log:

    +
      +
    • zowe cics define webservice WEBSVCA MYGRP --pipeline-name PIPELINE --wsbind /u/exampleapp/wsbind/example.log --region-name MYREGION
    • +
    +
  • +
+

zowecicsdelete

+

Delete resources (for example, programs) from CICS through IBM CMCI.

+

zowecicsdeleteprogram

+

Delete a program from CICS.

+

Usage

+

zowe cics delete program <programName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    programName (string)

    +
      +
    • The name of the program to delete. The maximum length of the program name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the program that you want to delete. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to delete the program
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex from which to delete the program
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a program named PGM123 from the region named MYREGION:

    +
      +
    • zowe cics delete program PGM123 --region-name MYREGION
    • +
    +
  • +
+

zowecicsdeletetransaction

+

Delete a transaction from CICS.

+

Usage

+

zowe cics delete transaction <transactionName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    transactionName (string)

    +
      +
    • The name of the transaction to delete. The maximum length of the transaction name is four characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the transaction that you want to delete. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to delete the transaction
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex from which to delete the transaction
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a transaction named TRN1 from the region named MYREGION:

    +
      +
    • zowe cics delete transaction TRN1 MYGRP --region-name MYREGION
    • +
    +
  • +
+

zowecicsdeleteurimap

+

Delete a urimap from CICS.

+

Usage

+

zowe cics delete urimap <urimapName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the urimap to delete. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the urimap that you want to delete. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to delete the urimap
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a urimap named URIMAPA from the region named MYREGION belonging to the csdgroup MYGRP:

    +
      +
    • zowe cics delete urimap URIMAPA MYGRP --region-name MYREGION
    • +
    +
  • +
+

zowecicsdeletewebservice

+

Delete a web service from CICS.

+

Usage

+

zowe cics delete webservice <webserviceName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    webserviceName (string)

    +
      +
    • The name of the web service to delete. The maximum length of the web service name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the web service that you want to delete. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to delete the web service
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a web service named WEBSVCA from the region named MYREGION belonging to the csdgroup MYGRP:

    +
      +
    • zowe cics delete webservice WEBSVCA MYGRP --region-name MYREGION
    • +
    +
  • +
+

zowecicsdisable

+

Disable resources (for example, urimaps) from CICS through IBM CMCI.

+

zowecicsdisableurimap

+

Disable a urimap from CICS.

+

Usage

+

zowe cics disable urimap <urimapName> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the urimap to disable. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name in which to disable the urimap
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Disable a urimap named URIMAPA from the region named MYREGION:

    +
      +
    • zowe cics disable urimap URIMAPA --region-name MYREGION
    • +
    +
  • +
+

zowecicsdiscard

+

Discard resources (for example, programs) from CICS through IBM CMCI.

+

zowecicsdiscardprogram

+

Discard a program from CICS.

+

Usage

+

zowe cics discard program <programName> [options]

+

Positional Arguments

+
    +
  • +

    programName (string)

    +
      +
    • The name of the program to discard. The maximum length of the program name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to discard the program
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex from which to discard the program
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Discard a program named PGM123 from the region named MYREGION:

    +
      +
    • zowe cics discard program PGM123 --region-name MYREGION
    • +
    +
  • +
+

zowecicsdiscardtransaction

+

Discard a transaction from CICS.

+

Usage

+

zowe cics discard transaction <transactionName> [options]

+

Positional Arguments

+
    +
  • +

    transactionName (string)

    +
      +
    • The name of the transaction to discard. The maximum length of the transaction name is four characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to discard the transaction
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex from which to discard the transaction
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Discard a transaction named TRN1 from the region named MYREGION:

    +
      +
    • zowe cics discard transaction TRN1 --region-name MYREGION
    • +
    +
  • +
+

zowecicsdiscardurimap

+

Discard a urimap from CICS.

+

Usage

+

zowe cics discard urimap <urimapName> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the urimap to discard. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to discard the urimap
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Discard a urimap named URIMAPA from the region named MYREGION:

    +
      +
    • zowe cics discard urimap URIMAPA --region-name MYREGION
    • +
    +
  • +
+

zowecicsenable

+

Enable resources (for example, urimaps) from CICS through IBM CMCI.

+

zowecicsenableurimap

+

Enable a urimap from CICS.

+

Usage

+

zowe cics enable urimap <urimapName> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the urimap to enable. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name in which to enable the urimap
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Enable a urimap named URIMAPA from the region named MYREGION:

    +
      +
    • zowe cics enable urimap URIMAPA --region-name MYREGION
    • +
    +
  • +
+

zowecicsget

+

Get resources (for example, programs or transactions) from CICS through IBM CMCI.

+

zowecicsgetresource

+

Get resources (for example, programs or transactions) from CICS.

+

Usage

+

zowe cics get resource <resourceName> [options]

+

Positional Arguments

+
    +
  • +

    resourceName (string)

    +
      +
    • The name of the resource to get.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name | --rn (string)

    +
      +
    • The CICS region name from which to get the resources
    • +
    +
  • +
  • +

    --cics-plex | --cp (string)

    +
      +
    • The name of the CICSPlex from which to get the resources
    • +
    +
  • +
  • +

    --criteria | -c (string)

    +
      +
    • The criteria by which to filter the resource
    • +
    +
  • +
  • +

    --parameter | -p (string)

    +
      +
    • The parameter by which to refine the resource
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get program resources from the region named MYREGION:

    +
      +
    • zowe cics get resource CICSProgram --region-name MYREGION
    • +
    +
  • +
  • +

    Get local transaction resources from the region named MYREGION:

    +
      +
    • zowe cics get resource CICSLocalTransaction --region-name MYREGION
    • +
    +
  • +
  • +

    Get local file resources from the region named MYREGION:

    +
      +
    • zowe cics get resource CICSLocalFile --region-name MYREGION
    • +
    +
  • +
  • +

    Get program definition resources from the CSD group named GRP1 and the region named MYREGION:

    +
      +
    • zowe cics get resource CICSDefinitionProgram --region-name MYREGION --parameter "CSDGROUP(GRP1)"
    • +
    +
  • +
  • +

    Get transaction definition resources from the CSD group named GRP1 and the region named MYREGION:

    +
      +
    • zowe cics get resource CICSDefinitionTransaction --region-name MYREGION --parameter "CSDGROUP(GRP1)"
    • +
    +
  • +
  • +

    Get URIMap definition resources from the CSD group named GRP1 and the region named MYREGION:

    +
      +
    • zowe cics get resource CICSDefinitionURIMap --region-name MYREGION --parameter "CSDGROUP(GRP1)"
    • +
    +
  • +
  • +

    Get program resources that start with the name PRG from the region named MYREGION:

    +
      +
    • zowe cics get resource CICSProgram --region-name MYREGION --criteria "PROGRAM=PRG*"
    • +
    +
  • +
  • +

    Get a local transaction resource named TRAN from the region named MYREGION:

    +
      +
    • zowe cics get resource CICSLocalTransaction --region-name MYREGION --criteria "TRANID=TRAN"
    • +
    +
  • +
  • +

    Get program resources that start with the name MYPRG from the region named MYREGION and display various fields as a table:

    +
      +
    • zowe cics get resource CICSProgram --region-name MYREGION --criteria "PROGRAM=MYPRG*" --rft table --rfh --rff program length status
    • +
    +
  • +
+

zowecicsinstall

+

Install resources (for example, programs) to CICS through IBM CMCI.

+

zowecicsinstallprogram

+

Install a program to CICS.

+

Usage

+

zowe cics install program <programName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    programName (string)

    +
      +
    • The name of the program to install. The maximum length of the program name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the program that you want to install. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to install the program
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to install the program
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Install a program named PGM123 to the region named MYREGION in the CSD group MYGRP:

    +
      +
    • zowe cics install program PGM123 MYGRP --region-name MYREGION
    • +
    +
  • +
+

zowecicsinstalltransaction

+

Install a transaction to CICS.

+

Usage

+

zowe cics install transaction <transactionName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    transactionName (string)

    +
      +
    • The name of the transaction to install. The maximum length of the transaction name is four characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the transaction that you want to install. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to install the transaction
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to install the transaction
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Install a transaction named TRN1 to the region named MYREGION in the CSD group MYGRP:

    +
      +
    • zowe cics install transaction TRN1 MYGRP --region-name MYREGION
    • +
    +
  • +
+

zowecicsinstallurimap

+

Install a urimap to CICS.

+

Usage

+

zowe cics install urimap <urimapName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the urimap to install. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the urimap that you want to install. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to install the urimap
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Install a urimap named URIMAPA to the region named MYREGION belonging to the csdgroup MYGRP:

    +
      +
    • zowe cics install urimap URIMAPA CSDGROUP --region-name MYREGION
    • +
    +
  • +
+

zowecicsrefresh

+

Refresh a program on CICS through IBM CMCI.

+

zowecicsrefreshprogram

+

Refresh a program on CICS.

+

Usage

+

zowe cics refresh program <programName> [options]

+

Positional Arguments

+
    +
  • +

    programName (string)

    +
      +
    • The name of the program to refresh. The maximum length of the program name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name on which you want to refresh the program
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex on which to refresh the program
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Refresh a program named PGM123 from the region named MYREGION:

    +
      +
    • zowe cics refresh program PGM123 --region-name MYREGION
    • +
    +
  • +
+

zowecicsremove-from-list

+

Remove resources (for example, CSD Groups in CSD Lists) from CICS through IBM CMCI.

+

zowecicsremove-from-listcsdGroup

+

Remove a CSD Group from a CICS CSD List.

+

Usage

+

zowe cics remove-from-list csdGroup <name> <csdList> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • The name of the CSD Group to remove. The maximum length of the CSD Group name is eight characters
    • +
    +
  • +
  • +

    csdList (string)

    +
      +
    • The name of the CSD List to remove the group from. The maximum length of the CSD List name is eight characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to remove the CSD Group from the CSD List
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to remove the CSD Group from the CSD List
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Remove the CSD Group MYGRP from the CSD List MYLIST in the region named MYREG:

    +
      +
    • zowe cics remove-from-list csdGroup MYGRP MYLIST --region-name MYREG
    • +
    +
  • +
+
+

zoweconfig

+

Manage JSON project and global configuration

+

zoweconfigauto-init

+

Automatically generate a config from APIML

+

Usage

+

zowe config auto-init [options]

+

Automatic Config Initialization Options

+
    +
  • +

    --user-config | --uc (boolean)

    +
      +
    • +

      Save config in the user layer

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --global-config | --gc (boolean)

    +
      +
    • +

      Save config in the global layer

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --dry-run | --dr | --dry (boolean)

    +
      +
    • Display the outcome of the initialization without saving
    • +
    +
  • +
  • +

    --edit | -e (boolean)

    +
      +
    • Open in editor after initializing the configuration
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • +

      Replaces an existing configuration with a new configuration

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --for-sure | -f (boolean)

    +
      +
    • +

      Confirms the overwrite option

      +

      Default value: false

      +
    • +
    +
  • +
+

APIML Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the mainframe running the API Mediation Layer.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of API Mediation Layer on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to the API Mediation Layer on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to the API Mediation Layer on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • The type of token to get and use for the API Mediation Layer. Omit this option to use the default token type, which is provided by 'zowe auth login'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API Mediation Layer.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use to authenticate to the API Mediation Layer
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use to authenticate to the API Mediation Layer
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

zoweconfigconvert-profiles

+

Convert v1 profiles to a global zowe.config.json file.

+

Usage

+

zowe config convert-profiles [options]

+

Options

+
    +
  • +

    --prompt (boolean)

    +
      +
    • +

      Prompt for confirmation. Use --no-prompt to disable prompting.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --delete (boolean)

    +
      +
    • Delete the existing profiles on disk and any securely stored secrets.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Convert profiles to team config without prompting:

    +
      +
    • zowe config convert-profiles --no-prompt
    • +
    +
  • +
  • +

    Convert profiles to team config and delete the old profiles:

    +
      +
    • zowe config convert-profiles --delete
    • +
    +
  • +
+

zoweconfigedit

+

Edit an existing config file in your system's default text editor.

+

In a graphical environment, the application associated with JSON files will be launched. In a command-line environment, vi will be launched. To override the command-line editor used, specify it in the ZOWE_EDITOR environment variable.

+

Usage

+

zowe config edit [options]

+

Options

+
    +
  • +

    --global-config | --gc (boolean)

    +
      +
    • +

      Target the global config files.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --user-config | --uc (boolean)

    +
      +
    • +

      Target the user config files.

      +

      Default value: false

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Edit global config file:

    +
      +
    • zowe config edit --global-config
    • +
    +
  • +
+

zoweconfigimport

+

Import config files from another location on disk or from an Internet URL.

+

If the config `$schema` property points to a relative path, the schema will also be imported.

+

Usage

+

zowe config import <location> [options]

+

Positional Arguments

+
    +
  • +

    location (string)

    +
      +
    • File path or URL to import from.
    • +
    +
  • +
+

Options

+
    +
  • +

    --global-config | --gc (boolean)

    +
      +
    • +

      Target the global config files.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --user-config | --uc (boolean)

    +
      +
    • +

      Target the user config files.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • +

      Overwrite config file if one already exists.

      +

      Default value: false

      +
    • +
    +
  • +
+

Connection Options

+
    +
  • +

    --user | -u (string)

    +
      +
    • User name if authentication is required to download the config from a URL.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password if authentication is required to download the config from a URL.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates if config is downloaded from an HTTPS URL.

      +

      Default value: true

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Import config from local file on disk:

    +
      +
    • zowe config import ~/Downloads/zowe.config.json
    • +
    +
  • +
  • +

    Import global config from Internet URL:

    +
      +
    • zowe config import https://example.com/zowe.config.json --global-config
    • +
    +
  • +
+

zoweconfiginit

+

Initialize config files. Defaults to initializing "zowe.config.json" in the current working directory unless otherwise specified.

+

Use "--user-config" to init "zowe.config.user.json". Use "--global-config" to initialize the configuration files in your home "~/.zowe" directory.

+

Use "--no-prompt" to skip prompting for values in a CI environment.

+

Usage

+

zowe config init [options]

+

Options

+
    +
  • +

    --global-config | --gc (boolean)

    +
      +
    • +

      Target the global config files.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --user-config | --uc (boolean)

    +
      +
    • +

      Target the user config files.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --prompt (boolean)

    +
      +
    • +

      Prompt for missing values in the base profile. Useful for disabling prompting in CI environments.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Replace existing config files instead of merging the new changes.
    • +
    +
  • +
  • +

    --for-sure | --fs (boolean)

    +
      +
    • +

      Confirms the overwrite option.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --dry-run | --dr | --dry (boolean)

    +
      +
    • Display the outcome of the initialization without saving it.
    • +
    +
  • +
  • +

    --edit | -e (boolean)

    +
      +
    • Open in editor after initializing the configuration
    • +
    +
  • +
+

Examples

+
    +
  • +

    Initialize configuration files in your home "~/.zowe" directory:

    +
      +
    • zowe config init --global-config
    • +
    +
  • +
  • +

    Do a dry run of initializing configuration files in your home "~/.zowe" directory:

    +
      +
    • zowe config init --global-config --dry-run
    • +
    +
  • +
  • +

    Initialize the user config files:

    +
      +
    • zowe config init --user-config
    • +
    +
  • +
  • +

    Initialize the user config files and do not prompt for secure values:

    +
      +
    • zowe config init --user-config --prompt false
    • +
    +
  • +
  • +

    Do a dry run of initializing the user config files and do not prompt for secure values:

    +
      +
    • zowe config init --user-config --prompt false --dry-run
    • +
    +
  • +
  • +

    Overwrite any existing global config files:

    +
      +
    • zowe config init --global-config --overwrite --for-sure
    • +
    +
  • +
  • +

    Overwrite any existing user config files:

    +
      +
    • zowe config init --user-config --overwrite --for-sure
    • +
    +
  • +
+

zoweconfiglist

+

List config properties

+

Usage

+

zowe config list [property] [options]

+

Positional Arguments

+
    +
  • +

    property (string)

    +
      +
    • The config property to list. Blank to list all properties.
    • +
    +
  • +
+

Options

+
    +
  • +

    --locations (boolean)

    +
      +
    • Separate the config properties into their respective config file locations. Helpful to determine where configuration value is specified.
    • +
    +
  • +
  • +

    --root (boolean)

    +
      +
    • List only the root level property names. For example, specify in addition to '--locations' to get a list of config file paths only.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List property names for a specified config property:

    +
      +
    • zowe config list "defaults"
    • +
    +
  • +
  • +

    List only root level property names for a specified config property:

    +
      +
    • zowe config list "defaults" --root
    • +
    +
  • +
  • +

    List config properties by separating them by their respective config file locations:

    +
      +
    • zowe config list --locations
    • +
    +
  • +
  • +

    List only the root level configuration property names:

    +
      +
    • zowe config list --root
    • +
    +
  • +
  • +

    List only the root level configuration properties by separating them by their respective config file locations:

    +
      +
    • zowe config list --locations --root
    • +
    +
  • +
+

zoweconfigprofiles

+

Displays profile paths.

+

Usage

+

zowe config profiles [options]

+

Examples

+
    +
  • +

    Display profile paths:

    +
      +
    • zowe config profiles
    • +
    +
  • +
+

zoweconfigreport-env

+

Reports key items from your environment and identifies problem conditions

+

Usage

+

zowe config report-env [options]

+

Examples

+
    +
  • +

    Report information and issues about your working environment:

    +
      +
    • zowe config report-env
    • +
    +
  • +
  • +

    Save the report about your working environment to a file:

    +
      +
    • zowe config report-env > report.log
    • +
    +
  • +
+

zoweconfigschema

+

Dumps the JSON schema for the config. The schema is dynamically created based on your available plugins. Direct the output of this command to a file and include in your config with '$schema' property to get editor completion.

+

Usage

+

zowe config schema [options]

+

Examples

+
    +
  • +

    Display the JSON schema for the config:

    +
      +
    • zowe config schema
    • +
    +
  • +
+

zoweconfigsecure

+

prompt for secure configuration properties

+

Usage

+

zowe config secure [options]

+

Options

+
    +
  • +

    --global-config | --gc (boolean)

    +
      +
    • +

      Secure properties in global config.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --user-config | --uc (boolean)

    +
      +
    • +

      Secure properties in user config.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --prune | -p (boolean)

    +
      +
    • +

      Delete properties stored in the vault for team config files that do not exist.

      +

      Default value: false

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Secure the properties in global config:

    +
      +
    • zowe config secure --global-config
    • +
    +
  • +
  • +

    Secure the properties in user config:

    +
      +
    • zowe config secure --user-config
    • +
    +
  • +
+

zoweconfigset

+

create or update a configuration property

+

Usage

+

zowe config set <property> [value] [options]

+

Positional Arguments

+
    +
  • +

    property (string)

    +
      +
    • The property to set. You may specify a path using dot notation (e.g. profiles.host1.profiles.service1.properties.setting)
    • +
    +
  • +
  • +

    value (string)

    +
      +
    • The property value to set. The value may be JSON. Use '--json' to indicate.
    • +
    +
  • +
+

Options

+
    +
  • +

    --global-config | --gc (boolean)

    +
      +
    • +

      Set the property in global config.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --user-config | --uc (boolean)

    +
      +
    • +

      Set the property in user config.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --json (boolean)

    +
      +
    • +

      The property value is JSON.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --secure (boolean)

    +
      +
    • Store the property value securely. If omitted, any property named in the secure array of the config file will be saved securely.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the property in global config:

    +
      +
    • zowe config set "profiles.host1.profiles.service1.properties.setting" "value" --global-config
    • +
    +
  • +
  • +

    Set the property in user config:

    +
      +
    • zowe config set "profiles.host1.profiles.service2.properties.setting" "value" --user-config
    • +
    +
  • +
  • +

    Set property value to JSON:

    +
      +
    • zowe config set "profiles.host1.profiles.service3.properties.setting" "{"property":"value"}" --json
    • +
    +
  • +
  • +

    Store the property value:

    +
      +
    • zowe config set "profiles.host1.profiles.service1.properties.setting" "value" --secure
    • +
    +
  • +
  • +

    Set a default zosmf profile:

    +
      +
    • zowe config set "defaults.zosmf" "zosmfProfileName"
    • +
    +
  • +
  • +

    Set a default tso profile:

    +
      +
    • zowe config set "defaults.tso" "tsoProfileName"
    • +
    +
  • +
+

zoweconfigupdate-schemas

+

Update schema files by looking up the directory structure.

+

Schema files up in higher level directories will always be updated. To also update schema files down in lower level directories, specify the `--depth` flag.

+

Usage

+

zowe config update-schemas [options]

+

Options

+
    +
  • +

    --depth (number)

    +
      +
    • +

      Specifies how many levels down the directory structure should the schemas be updated.

      +

      Default value: 0

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update all schema files found in higher level directories:

    +
      +
    • zowe config update-schemas
    • +
    +
  • +
  • +

    Update all schema files found in higher level directories and 2 levels down the directory structure:

    +
      +
    • zowe config update-schemas --depth 2
    • +
    +
  • +
+
+

zowedaemon

+

Perform operations that control the daemon-mode functionality of the Zowe CLI. Daemon-mode runs the CLI command processor as a daemon to improve performance.

+

zowedaemondisable

+

Disables daemon-mode operation of the Zowe CLI.

+

Usage

+

zowe daemon disable [options]

+

Examples

+
    +
  • +

    Disable daemon-mode:

    +
      +
    • zowe daemon disable
    • +
    +
  • +
+

zowedaemonenable

+

Enables daemon-mode operation of the Zowe CLI. You only need to run the enable command once after each new installation of the Zowe CLI. Afterwards, any zowe command will automatically start a daemon as needed.

+

Usage

+

zowe daemon enable [options]

+

Examples

+
    +
  • +

    Enable daemon-mode:

    +
      +
    • zowe daemon enable
    • +
    +
  • +
+

zowedaemonrestart

+

Restart the Zowe CLI daemon.

+

Usage

+

zowe daemon restart [options]

+

Examples

+
    +
  • +

    Restart daemon:

    +
      +
    • zowe daemon restart
    • +
    +
  • +
+
+

zowedb2

+

Interact with IBM Db2 for z/OS

+

zowedb2call

+

Call a Db2 stored procedure

+

zowedb2callprocedure

+

Call a Db2 stored procedure. Specify the stored procedure name and optionally provide values.

+

Usage

+

zowe db2 call procedure <routine> [options]

+

Positional Arguments

+
    +
  • +

    routine (string)

    +
      +
    • The name of a Db2 stored procedure
    • +
    +
  • +
+

Options

+
    +
  • +

    --parameters | -p (array)

    +
      +
    • Values to bind to the stored procedure parameters
    • +
    +
  • +
+

DB2 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The Db2 server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Db2 server port number
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The Db2 user ID (may be the same as the TSO login)
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The Db2 password (may be the same as the TSO password)
    • +
    +
  • +
  • +

    --database | --db (string)

    +
      +
    • The name of the database
    • +
    +
  • +
  • +

    --sslFile | --ssl (string)

    +
      +
    • Path to an SSL Certificate file
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --db2-profile | --db2-p (string)

    +
      +
    • The name of a (db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Call stored procedure DEMO.SP1:

    +
      +
    • zowe db2 call procedure "DEMO.SP1"
    • +
    +
  • +
  • +

    Call a stored procedure and pass values for parameter indicators:

    +
      +
    • zowe db2 call procedure "DEMO.SP2(?, ?)" --parameters "Hello" "world!"
    • +
    +
  • +
  • +

    Call a stored procedure and pass values for two output parameters. The first output requires a 2-character buffer. The second output is a message that will be truncated to the length of the placeholder.:

    +
      +
    • zowe db2 call procedure "DEMO.SP3(NULL, ?, ?)" --parameters "00" "message_placeholder_message_placeholder"
    • +
    +
  • +
+

zowedb2execute

+

Execute SQL queries against a Db2 region and retrieve the response. Enclose the query in quotes and escape any symbols that have a special meaning to the shell.

+

zowedb2executesql

+

Execute one or multiple SQL statements separated by a semicolon from a command line or from a file.

+

Usage

+

zowe db2 execute sql [options]

+

Options

+
    +
  • +

    --query | -q (string)

    +
      +
    • The SQL statement verbatim to execute
    • +
    +
  • +
  • +

    --file | -f (string)

    +
      +
    • A local file containing the SQL statements to execute
    • +
    +
  • +
+

DB2 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The Db2 server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Db2 server port number
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The Db2 user ID (may be the same as the TSO login)
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The Db2 password (may be the same as the TSO password)
    • +
    +
  • +
  • +

    --database | --db (string)

    +
      +
    • The name of the database
    • +
    +
  • +
  • +

    --sslFile | --ssl (string)

    +
      +
    • Path to an SSL Certificate file
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --db2-profile | --db2-p (string)

    +
      +
    • The name of a (db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Execute a dummy SQL query:

    +
      +
    • zowe db2 execute sql --query "SELECT 'Hello World' FROM SYSIBM.SYSDUMMY1"
    • +
    +
  • +
  • +

    Retrieve the employees table and total number of rows:

    +
      +
    • zowe db2 execute sql -q "SELECT * FROM SAMPLE.EMP; SELECT COUNT(*) AS TOTAL FROM SAMPLE.EMP"
    • +
    +
  • +
  • +

    Execute a file with SQL statements:

    +
      +
    • zowe db2 execute sql --file backup_sample_database.sql
    • +
    +
  • +
+

zowedb2export

+

Export data from a Db2 table

+

zowedb2exporttable

+

Export a Db2 table to the stdout or a file.

+

Usage

+

zowe db2 export table <table> [options]

+

Positional Arguments

+
    +
  • +

    table (string)

    +
      +
    • The name of the table to export
    • +
    +
  • +
+

Options

+
    +
  • +

    --outfile | -o (string)

    +
      +
    • The path to the output file
    • +
    +
  • +
  • +

    --separator | --sep (string)

    +
      +
    • Specify whether to add a separator between statements when exporting a table
    • +
    +
  • +
+

DB2 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The Db2 server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Db2 server port number
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The Db2 user ID (may be the same as the TSO login)
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The Db2 password (may be the same as the TSO password)
    • +
    +
  • +
  • +

    --database | --db (string)

    +
      +
    • The name of the database
    • +
    +
  • +
  • +

    --sslFile | --ssl (string)

    +
      +
    • Path to an SSL Certificate file
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --db2-profile | --db2-p (string)

    +
      +
    • The name of a (db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Export employees data from the table SAMPLE.EMP and save it to the file 'employees.sql':

    +
      +
    • zowe db2 export table SAMPLE.EMP --outfile employees.sql
    • +
    +
  • +
+
+

zowedbm-db2

+

DBM-Db2 plug-in to interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

zowedbm-db2check

+

Perform DDL syntax checking.

+

zowedbm-db2checkddl

+

Validate the syntax of input DDL and optionally verify Db2 object dependencies. Use this command to ensure that the syntax of the input DDL is valid. You can also optionally verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL. You can generate input DDL using the 'zowe dbm generate ddl' command.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 check ddl <local-input-ddl-filename> [options]

+

Positional Arguments

+
    +
  • +

    local-input-ddl-filename (string)

    +
      +
    • Specifies the local input file that contains the DDL statements for the Db2 objects that you want to validate on a target subsystem. Typically, this file is created by a 'zowe dbm generate ddl' command or retrieved from an archive. You can edit this file.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to use a command.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --verify | -v (string)

    +
      +
    • +

      Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.

      +

      Default value: no

      +

      Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Validate DDL statement syntax of the DDL statements in the sample.sql file on the 'TEST' Db2 subsystem:

    +
      +
    • zowe dbm-db2 check ddl sample.sql --target-db2 TEST
    • +
    +
  • +
  • +

    Validate DDL statement syntax and verify object dependencies:

    +
      +
    • zowe dbm-db2 check ddl sample.sql --target-db2 TEST --verify yes
    • +
    +
  • +
+

zowedbm-db2compare

+

Compare DDL with a Db2 subsystem and produce an update script to implement changes.

+

zowedbm-db2compareddl

+

Compare objects that are defined in a DDL file to objects that are defined on a Db2 subsystem and generate an update script to implement the necessary object changes. This command also generates a high-level change summary report and a parseable impact analysis report. You can execute the script that is generated from this command using the 'zowe dbm execute compare-script' command.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 compare ddl <local-input-ddl-filename> [options]

+

Positional Arguments

+
    +
  • +

    local-input-ddl-filename (string)

    +
      +
    • Specifies the local input file that contains DDL statements for the Db2 objects that you want to compare to Db2 objects on a target subsystem. Typically, this file is created by a 'zowe dbm generate ddl' command or retrieved from an archive. You can edit this file.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to use a command.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --match-set | --ms (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <match-set-creator.match-set-name>

      +

      For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --match-set-file | --msf (string)

    +
      +
    • +

      Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <object-type> <source-name-mask> <target-name-mask>;

      +

      STOGROUP <name> <name>
      +DATABASE <name> <name>
      +TABLESPACE <database.name> <database.name>
      +TABLE <schema.name> <schema.name>
      +INDEX <schema.name> <schema.name>
      +VIEW <schema.name> <schema.name>
      +SYNONYM <schema.name> <schema.name>
      +ALIAS <schema.name> <schema.name>
      +TRIGGER <schema.name> <schema.name>
      +SEQUENCE <schema.name> <schema.name>
      +FUNCTION <schema.name[.version]> <schema.name[.version]>
      +PROCEDURE <schema.name[.version]> <schema.name[.version]>

      +

      Note:
      +- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
      +- <schema> must be between 1 and 128 characters.
      +- <version> must be between 1 and 64 characters.

      +

      A mask specification can include the following wildcard characters:

      +

      Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.

      +

      Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.

      +

      Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.

      +

      Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.

      +

      Example:

      +

      The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:

      +

      TABLE MY%.%TABLE YOUR%.%TABLE;
      +TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
      +TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
      +TABLE *.MYTABLE *.YOURTABLE;

      +

      For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note:
      +- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.
      +- The matchSetValues options-profile option has the same behavior as the match-set-file command option.

      +
    • +
    +
  • +
  • +

    --change-set | --cs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.

      +

      Format:

      +

      <change-set-creator.change-set-name>

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --change-set-file | --csf (string)

    +
      +
    • +

      Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.

      +

      Format:

      +

      <object-attribute> <from-value> <to-value>

      +

      The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

      +

      Example:

      +

      The following example demonstrates changes to the table schema (creator) and tablespace names:

      +

      TBCR TEST% PROD%
      +TBTS TESTTS% PRODTS%

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note:
      +- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
      +- The changeSetValues options-profile option has the same behavior as the change-set-file command option.

      +
    • +
    +
  • +
  • +

    --rule-set | --rs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.

      +

      Format:

      +

      <rule-set-creator.rule-set-name>

      +

      For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +
    • +
    +
  • +
  • +

    --id (string)

    +
      +
    • +

      Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.

      +

      Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @.

      +
    • +
    +
  • +
  • +

    --description | -d (string)

    +
      +
    • Specifies a 1- to 25-character description for the RC/Migrator compare strategy.
    • +
    +
  • +
  • +

    --output-compare-script | --ocs (string)

    +
      +
    • +

      Specifies the name of the local output file that contains the update script to make changes to objects that reside on the Db2 subsystem.

      +

      Default value: compare.txt

      +
    • +
    +
  • +
  • +

    --output-summary-file | --osf (string)

    +
      +
    • +

      Specifies the name of the local output file that contains the change summary report in text format. This report tracks changes to Db2 objects on the target Db2 subsystem, but it does not describe how changes are made.

      +

      Default value: summary.txt

      +
    • +
    +
  • +
  • +

    --output-impact-file | --oif (string)

    +
      +
    • +

      Specifies the name of the local output file that contains the parseable impact analysis report in JSON or YAML format. This report identifies the significant DDL operations that are performed on Db2 objects. The report provides the total number and type of DDL operations that are performed on each object type, the list of DDL operations performed on each object instance, and the state of any pending changes.

      +

      To determine the report format, supply one of the following extensions in the file name:
      +- .json for JSON
      +- .yaml or .yml for YAML
      +If no extension is provided, the format is set to JSON.

      +

      Default value: impact.json

      +

      For more information about the impact analysis report, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Generate a script to update objects on the 'TEST' Db2 subsystem with DDL definitions in myddl.sql file:

    +
      +
    • zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST
    • +
    +
  • +
  • +

    Generate a script to update objects and apply a rule set for the matched objects:

    +
      +
    • zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET
    • +
    +
  • +
  • +

    Generate a script to update objects and apply a rule set for the objects matched as determined by the local mask specifications in the pair.txt file:

    +
      +
    • zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt
    • +
    +
  • +
+

zowedbm-db2deploy

+

Deploy DDL statements to a Db2 subsystem.

+

zowedbm-db2deployddl

+

Deploy Db2 object changes on the target Db2 subsystem using an input file that contains the DDL. For example, an application developer has made changes to DDL in a local file and is ready to test the DDL changes. Use this command to deploy the changes to the test environment.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 deploy ddl <local-input-ddl-filename> [options]

+

Positional Arguments

+
    +
  • +

    local-input-ddl-filename (string)

    +
      +
    • Specifies the local input file that contains DDL statements for the Db2 objects that you want to deploy on a target subsystem. Typically, this file is created by a 'zowe dbm generate ddl' command or retrieved from an archive. You can edit this file.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to use a command.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --match-set | --ms (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <match-set-creator.match-set-name>

      +

      For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --match-set-file | --msf (string)

    +
      +
    • +

      Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <object-type> <source-name-mask> <target-name-mask>;

      +

      STOGROUP <name> <name>
      +DATABASE <name> <name>
      +TABLESPACE <database.name> <database.name>
      +TABLE <schema.name> <schema.name>
      +INDEX <schema.name> <schema.name>
      +VIEW <schema.name> <schema.name>
      +SYNONYM <schema.name> <schema.name>
      +ALIAS <schema.name> <schema.name>
      +TRIGGER <schema.name> <schema.name>
      +SEQUENCE <schema.name> <schema.name>
      +FUNCTION <schema.name[.version]> <schema.name[.version]>
      +PROCEDURE <schema.name[.version]> <schema.name[.version]>

      +

      Note:
      +- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
      +- <schema> must be between 1 and 128 characters.
      +- <version> must be between 1 and 64 characters.

      +

      A mask specification can include the following wildcard characters:

      +

      Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.

      +

      Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.

      +

      Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.

      +

      Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.

      +

      Example:

      +

      The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:

      +

      TABLE MY%.%TABLE YOUR%.%TABLE;
      +TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
      +TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
      +TABLE *.MYTABLE *.YOURTABLE;

      +

      For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note:
      +- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.
      +- The matchSetValues options-profile option has the same behavior as the match-set-file command option.

      +
    • +
    +
  • +
  • +

    --change-set | --cs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.

      +

      Format:

      +

      <change-set-creator.change-set-name>

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --change-set-file | --csf (string)

    +
      +
    • +

      Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.

      +

      Format:

      +

      <object-attribute> <from-value> <to-value>

      +

      The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

      +

      Example:

      +

      The following example demonstrates changes to the table schema (creator) and tablespace names:

      +

      TBCR TEST% PROD%
      +TBTS TESTTS% PRODTS%

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note:
      +- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
      +- The changeSetValues options-profile option has the same behavior as the change-set-file command option.

      +
    • +
    +
  • +
  • +

    --rule-set | --rs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.

      +

      Format:

      +

      <rule-set-creator.rule-set-name>

      +

      For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update Db2 objects on a target Db2 subsystem according to DDL definitions in myddl.sql file:

    +
      +
    • zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST
    • +
    +
  • +
  • +

    Update Db2 objects according to the input DDL definitions and applied rule set for the matched objects:

    +
      +
    • zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET
    • +
    +
  • +
  • +

    Update Db2 objects according to the input DDL definitions and applied rule set for the objects matched as determined by the local mask specifications in the pair.txt file:

    +
      +
    • zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt
    • +
    +
  • +
+

zowedbm-db2execute

+

Execute a script to implement Db2 object changes.

+

zowedbm-db2executecompare-script

+

Execute the compare script that was generated with the 'zowe dbm compare ddl' command to implement the Db2 object changes on the Db2 subsystem specified within the script. This command also generates a recovery script to undo compare script changes.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 execute compare-script <local-input-compare-script-filename> [options]

+

Positional Arguments

+
    +
  • +

    local-input-compare-script-filename (string)

    +
      +
    • Specifies the local input compare-script file that contains the update script that was generated with the 'zowe dbm compare ddl' command.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output-recovery-script | --ors | --output-recovery-file | --orf (string)

    +
      +
    • +

      Specifies the local output file name that contains the recovery script that is generated during execution of this command. Executing the recovery script using the 'zowe dbm execute script' command undoes the changes that were made by execution of the compare-script.

      +

      Default value: recovery.txt

      +
    • +
    +
  • +
  • +

    --restart | -r (string)

    +
      +
    • +

      Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.

      +

      The following restart options are valid:

      +

      new - Restart execution of the script at the first statement.

      +

      token - Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure.

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Execute a compare script:

    +
      +
    • zowe dbm-db2 execute compare-script compare.txt
    • +
    +
  • +
  • +

    Restart execution of a compare script at the first statement in the script:

    +
      +
    • zowe dbm-db2 execute compare-script compare.txt --restart new
    • +
    +
  • +
  • +

    Restart execution of a compare script at the location in the token:

    +
      +
    • zowe dbm-db2 execute compare-script compare.txt --restart 78A724GOBLEDYGOOK6FD140F6780D6FA
    • +
    +
  • +
+

zowedbm-db2executemigration-script

+

Execute the migration script that was generated with the 'zowe dbm prepare migration' command to migrate Db2 objects (DDL) and table data from a source subsystem to a target subsystem. The source and target subsystem IDs are specified within the script.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 execute migration-script <local-input-migrate-script-filename> [options]

+

Positional Arguments

+
    +
  • +

    local-input-migrate-script-filename (string)

    +
      +
    • Specifies the local input migration-script file that was generated with the 'zowe dbm prepare migration' command.
    • +
    +
  • +
+

Options

+
    +
  • +

    --restart | -r (string)

    +
      +
    • +

      Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.

      +

      The following restart options are valid:

      +

      new - Restart execution of the script at the first statement.

      +

      name, token - Restart execution of the script at the location in the restart section that is recorded in the specified token and that was returned from a prior execution failure.

      +

      A section is a '.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL. 'source' is an alias for UNLOADS. 'target' is an alias for SQLDDL.

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Execute a migration script:

    +
      +
    • zowe dbm-db2 execute migration-script migration.txt
    • +
    +
  • +
  • +

    Restart execution of a migration script at the first statement in the script:

    +
      +
    • zowe dbm-db2 execute migration-script migration.txt --restart new
    • +
    +
  • +
  • +

    Restart execution of a migration script at the location in the token. Execution begins at the last successful sync point that is recorded in the restart token up to the end of the restart token section:

    +
      +
    • zowe dbm-db2 execute migration-script migration.txt --restart target,78A724GOBLEDYGOOK6FD140F6780D6FA
    • +
    +
  • +
+

zowedbm-db2executescript

+

Execute a Batch Processor script on a target subsystem. For example, use this command to execute a Batch Processor script or specifically to execute a recovery script to undo changes that were made by the 'zowe dbm execute compare-script' command. If execution of the script fails, you can execute it again using the 'script-section' or 'restart' options. You can edit the script and make changes before you execute or restart it.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 execute script <local-input-bp-script-filename> [options]

+

Positional Arguments

+
    +
  • +

    local-input-bp-script-filename (string)

    +
      +
    • Specifies the local input file that contains the Batch Processor statements such as the recovery script that was created by executing the 'zowe dbm execute compare-script' command.
    • +
    +
  • +
+

Options

+
    +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to execute the script. If this option is not specified, the target subsystem is identified by the first .CONNECT statement in the script.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +

      The target-db2 option takes precedence over any other value that is specified for the Db2 subsystem or data sharing group.

      +
    • +
    +
  • +
  • +

    --script-section | --ss (string)

    +
      +
    • +

      Identifies the location in the script where you want to begin execution.

      +

      The following options are valid:

      +

      name - Begin execution of the specific section and process all subsequent statements up to the next section.

      +

      A section is a '.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL. 'source' is an alias for UNLOADS. 'target' is an alias for SQLDDL.

      +

      number - Begin execution after the specific sync point (.SYNC <number> statement) and process all statements up to the end of the script.

      +

      name, number - Begin execution of the specific script section beginning from the sync point (.SYNC <number> statement) within the section and process all subsequent statements up to the next section.

      +
    • +
    +
  • +
  • +

    --restart | -r (string)

    +
      +
    • +

      Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.

      +

      The following restart options are valid:

      +

      new - Restart execution of the script at the first statement.

      +

      token - Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure.

      +

      name, token - Restart execution of the script at the location in the restart section that is recorded in the specified token and that was returned from a prior execution failure.

      +

      A section is a Batch Processor '.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL. 'source' is an alias for UNLOADS. 'target' is an alias for SQLDDL.

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Execute a recovery script:

    +
      +
    • zowe dbm-db2 execute script recovery.txt
    • +
    +
  • +
  • +

    Execute a script on the 'TEST' Db2 subsystem:

    +
      +
    • zowe dbm-db2 execute script script001.txt --target-db2 TEST
    • +
    +
  • +
  • +

    Execute only the SQLDDL section of a script. The first .CONNECT statement in the script identifies the target subsystem where the script is executed. Execution begins at the .SYSTEM SQLDDL statement and ends at the next .SYSTEM statement in the script:

    +
      +
    • zowe dbm-db2 execute script script001.txt --script-section SQLDDL
    • +
    +
  • +
  • +

    Execute a script beginning from the sync point 10 (.SYNC 10 statement) to the end of the script:

    +
      +
    • zowe dbm-db2 execute script script001.txt --script-section 10
    • +
    +
  • +
  • +

    Execute only the target (SQLDDL) section of the script starting at sync point 20:

    +
      +
    • zowe dbm-db2 execute script script001.txt --script-section target,20
    • +
    +
  • +
  • +

    Restart execution of a script from the beginning:

    +
      +
    • zowe dbm-db2 execute script script001.txt --restart new
    • +
    +
  • +
  • +

    Restart execution of a script at the location specified in the token. The restart token is returned by a previous 'zowe dbm execute command' failure as part of the terminal output and in the error file:

    +
      +
    • zowe dbm-db2 execute script script001.txt --restart 78A724A48DA5185D06FD140F6780D6FA
    • +
    +
  • +
  • +

    Restart execution at the last successful sync point recorded in the restart token up to the end of the target (SQLDDL) section:

    +
      +
    • zowe dbm-db2 execute script script001.txt --restart target,78A724A48DA5185D06FD140F6780D6FA
    • +
    +
  • +
+

zowedbm-db2generate

+

Generate DDL statements for Db2 objects.

+

zowedbm-db2generateddl

+

Generate CREATE or DROP DDL statements for specified Db2 objects into an output DDL file. For example, use this command to generate CREATE TABLE definitions that you can then edit and use to update the table definition on a Db2 subsystem with the 'zowe dbm compare ddl' command.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 generate ddl [options]

+

Required Options

+
    +
  • +

    --object | -o (string)

    +
      +
    • +

      Specifies the Db2 objects to be generated in DDL. Use the optional include clause to include related Db2 objects.

      +
       Format: see the object\-file description
      +
      +Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
      +
      +
    • +
    +
  • +
  • +

    --object-file | --of (string)

    +
      +
    • +

      Specifies the name of the local input file that contains a list of Db2 objects to be generated in DDL. Use a semicolon to separate objects. Use the optional include clause to include related Db2 objects.

      +

      Format:

      +

      <object-type> <object-name> [include(<related-object-type>,...)];

      +

      The required clause <object-type> <object-name> identifies the specific Db2 (base) object:

      +

      STOGROUP <name>
      +DATABASE <name>
      +TABLESPACE <dbname.name>
      +TABLE <schema.name>
      +INDEX <schema.name>
      +VIEW <schema.name>
      +ALIAS <schema.name>
      +SYNONYM <schema.name>
      +MQT <schema.name>
      +SEQUENCE <schema.name>
      +TRIGGER <schema.name>
      +FUNCTION <schema.name[.version]>
      +PROCEDURE <schema.name[.version]>

      +

      The optional include clause (<related-object-type>,...) identifies one or more related Db2 object types to include in the object list.

      +

      You can specify the following object types: STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL.

      +

      Example:

      +

      table sysibm.systables include (tablespace, database, index);
      +database db1 include(children);

      +

      Note: The --object and --object-file options are mutually exclusive.

      +
    • +
    +
  • +
  • +

    --source-db2 | --sd (string)

    +
      +
    • +

      Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --change-set | --cs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.

      +

      Format:

      +

      <change-set-creator.change-set-name>

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --change-set-file | --csf (string)

    +
      +
    • +

      Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects.

      +

      Format:

      +

      <object-attribute> <from-value> <to-value>

      +

      The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

      +

      For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Example:

      +

      The following example demonstrates changes to the table schema (creator) and tablespace names:

      +

      TBCR TEST% PROD%
      +TBTS TESTTS% PRODTS%

      +

      Note:
      +- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
      +- The changeSetValues options-profile option has the same behavior as the change-set-file command option.

      +
    • +
    +
  • +
  • +

    --type | -t (string)

    +
      +
    • +

      Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.

      +

      Default value: create
      +Allowed values: drop, create

      +
    • +
    +
  • +
  • +

    --output-ddl-file | --odf (string)

    +
      +
    • +

      Specifies the local output file name that contains the generated DDL for the objects that are identified by the --object-file or --object option.

      +

      Default value: output.sql

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Generate CREATE DDL statements for a tablespace and its child table:

    +
      +
    • zowe dbm-db2 generate ddl --object "tablespace my.tbsp include(table)" --source-db2 SRC --output-ddl-file objects.sql
    • +
    +
  • +
  • +

    Generate CREATE DDL statements for a database and its children and apply changes as defined in the change set:

    +
      +
    • zowe dbm-db2 generate ddl --object "database my.db include(children)" --source-db2 SRC --change-set USER1.CHANGSET --output-ddl-file objects.sql
    • +
    +
  • +
  • +

    Generate DROP DDL statements only for the input object list:

    +
      +
    • zowe dbm-db2 generate ddl --object-file objects.txt --source-db2 SRC --type drop --output-ddl-file output.sql
    • +
    +
  • +
+

zowedbm-db2prepare

+

Prepare DDL statements and a script to migrate Db2 objects.

+

zowedbm-db2preparemigration

+

Generate a script to migrate Db2 object definitions (DDL) and data from a source subsystem to a target subsystem. You can specify which objects to include and apply changes to the objects as part of the migration. To execute the script, use the 'zowe dbm execute migration-script' command.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 prepare migration [options]

+

Required Options

+
    +
  • +

    --object | -o (string)

    +
      +
    • +

      Specifies the Db2 objects to be migrated. Use the optional include clause to include related Db2 objects.

      +

      Format: see the object-file description

      +

      Note: The --object and --object-file options are mutually exclusive.

      +
    • +
    +
  • +
  • +

    --object-file | --of (string)

    +
      +
    • +

      Specifies the name of the local input file that contains a list of Db2 objects to be migrated. Use a semicolon to separate objects. Use the optional include clause to include related Db2 objects.

      +

      Format:

      +

      <object-type> <object-name> [include(<related-object-type>,...)];

      +

      The required clause <object-type> <object-name> identifies the specific Db2 (base) object:

      +

      STOGROUP <name>
      +DATABASE <name>
      +TABLESPACE <dbname.name>
      +TABLE <schema.name>
      +INDEX <schema.name>
      +VIEW <schema.name>
      +ALIAS <schema.name>
      +SYNONYM <schema.name>
      +MQT <schema.name>
      +SEQUENCE <schema.name>
      +TRIGGER <schema.name>
      +FUNCTION <schema.name[.version]>
      +PROCEDURE <schema.name[.version]>

      +

      The optional include clause (<related-object-type>,...) identifies one or more related Db2 object types to include in the object list.

      +

      You can specify the following object types: STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL.

      +

      Example:

      +

      table sysibm.systables include (tablespace, database, index);
      +database db1 include(children);

      +

      Note: The --object and --object-file options are mutually exclusive.

      +
    • +
    +
  • +
  • +

    --source-db2 | --sd (string)

    +
      +
    • +

      Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to use a command.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --change-set | --cs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.

      +

      Format:

      +

      <change-set-creator.change-set-name>

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --change-set-file | --csf (string)

    +
      +
    • +

      Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects.

      +

      Format:

      +

      <object-attribute> <from-value> <to-value>

      +

      The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

      +

      For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Example:

      +

      The following example demonstrates changes to the table schema (creator) and tablespace names:

      +

      TBCR TEST% PROD%
      +TBTS TESTTS% PRODTS%

      +

      Note:
      +- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
      +- The changeSetValues options-profile option has the same behavior as the change-set-file command option.

      +
    • +
    +
  • +
  • +

    --output-migrate-script | --oms (string)

    +
      +
    • +

      Specifies the name of the local output file that contains the script to make changes to objects that reside on the Db2 subsystem.

      +

      Default value: migration.txt

      +
    • +
    +
  • +
  • +

    --output-ddl-file | --odf (string)

    +
      +
    • +

      Specifies the name of the local output file that contains the generated DDL for objects that are identified by the --object-file or --object option.

      +

      Default value: output.sql

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Generate a migration script for a tablespace and its child table:

    +
      +
    • zowe dbm-db2 prepare migration --object "tablespace my.tbsp include(table)" --source-db2 SRC --target-db2 TRG --output-migrate-script migrate.txt
    • +
    +
  • +
  • +

    Generate a migration script and apply global changes:

    +
      +
    • zowe dbm-db2 prepare migration --object "database my.db include(children)" --source-db2 SRC --target-db2 TRG --change-set USER1.CHANGSET --output-migrate-script migrate.txt --output-ddl-file objects.sql
    • +
    +
  • +
+
+

zoweejes

+

Welcome to the EJES RESTapi Manager

+

This plug-in allows you to interact with EJES on the host to emulate EJES Batch under TSO and to query the EJES monitoredspool and host libraries to retreive tabular and report information

+

zoweejesapi

+

Make requests with the (E)JES REST API to the (E)JES API using options that correspond to object models in the (E)JES REST API swagger documentation. You should refer to that document, refer to chapter 10 of the (E)JES Reference, and issue "zowe ejes api init --helpApp" further details.

+

All responses are returned in JSON format by using the --rfj (--response-format-json) option.

+

The tools necessary manage the spool with (E)JES are provided. You will be able to download sysout, email it as PDF, and submit jobs from MVS and the local workstation. All downloads are saved to a file in the current working directory, or to the path specified on the EJES_DOWNLOAD_PATH environment variable.

+

The CLI generates exit codes. 0 indicates the transaction completed, but you should check the output for (E)JES errors. A non-zero exit code below 100 indicates a problem coding an options or a download file filesystem issue. An exit code above 100 is a response code from the host through the API. If use the host host "return" command in the --command option, you will receive a 500 exit code. Use a stateless init request or issue a term request to avoid this result.

+

This CLI was developed to provide an easy scripting option to avoid coding directly to the REST API. However, it can be used to experiment with the REST API. The --debug option will return the host requests and responses as objects and properties in JSON.

+

zoweejesapicancel-download

+

Cancels a streaming download of PDF or Text data. A download is initiated via the -d option on an Exec request. Refer to the (E)JES REST API swagger documentation for details on mapped options.

+

For a command group overview, issue: zowe ejes api -h

+

Usage

+

zowe ejes api cancel-download [options]

+

Query Item Options

+
    +
  • +

    --cookie (string)

    +
      +
    • +

      Supply the cookie output by a stateful request. This option supports optional syntax to enable automatic management of the cookie without scraping from stdout.

      +

      --cookie [<cookie-value>|read[<pin>]|write[<pin>]

      +

      The CLI can manage a stateful cookie transaction proactively. On the init, specify --cookie write or --cookie write-pin where pin can be any alphanumeric string. On the exec, cancel-download, and term specify --cookie read or --cookie read-pin. The cookie generated by the host is managed in the user's work directory. A pin is required only when there are multiple simultaneous sessions.

      +
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Cancel a long running job. Show the status in returned JSON.

    +

    Example:

    +
      +
    • zowe ejes api cancel-download --rfj --cookie "EJESWEB_54761=DB856A...;path=/EjesWeb;Secure;HttpOnly"
    • +
    +
  • +
+

zoweejesapiexec

+

Executes an API command in an existing (stateful) or new transient (stateless) session.

+

Returns items as requested by the query parameters. An existing session is used when a valid cookie is used as an argument on the --cookie option. This is the preferred scenario when multiple transactions are expected since it provides significant performance benefits. It requires server affinity for sessions in a clustered server environment.

+

A new transient session will be created if a --authorization or --user option is provided and a --cookie option is not. A transient session exists only for the current transaction and meets the goal of statelessness as defined by ROA and REST. However, it is much less efficient than using an existing session across multiple transactions, and does not preserve the state of the underlying (E)JES API. Nevertheless, it is the prefered scenario where a single transaction and statelessness suffice.

+

See the (E)JES REST API swagger documentation for details on the mapped options. Enclose all option arguments in double quotes if they include spaces, semicolons, or symbols that are reserved in your terminal shell or if they might otherwise be ambiguous to the shell. Options flagged with "initParms model" are valid only for stateless transactions on the exec command.

+

For a command group overview, issue: zowe ejes api -h

+

Usage

+

zowe ejes api exec [options]

+

Query Item Options

+
    +
  • +

    --authorization (string)

    +
      +
    • If you do not specify the --cookie option, you must include --user and --password or this option. The base64 encoded authentication string can be of the form userid:password or userid:group:password. If supplied, it overrides the profile user and password settings and starts a new session.
    • +
    +
  • +
  • +

    --cookie (string)

    +
      +
    • +

      Supply the cookie output by a stateful request. This option supports optional syntax to enable automatic managment of the cookie without scraping from stdout.

      +

      --cookie [<cookie-value>|read[<pin>]|write[<pin>]

      +

      The CLI can manage a stateful cookie transaction proactively. On the init, specify --cookie write or --cookie write-pin where pin can be any alphanumeric string. On the exec, cancel-download, and term specify --cookie read or --cookie read-pin. The cookie generated by the host is managed in the user's work directory. A pin is required only when there are multiple simultaneous sessions.

      +
    • +
    +
  • +
  • +

    -c (string)

    +
      +
    • +

      A list of comma separated, case-insensitive names of columns to include in the response. If omitted, all columns for the current tabular display are included.

      +

      This parameter only applies to enumerated data containing columns, specifically, the columns and rows items of the q parameter.

      +

      Limiting the included columns to only those you need can dramatically improve the resonse time of the request and significantly reduce system resources.

      +
    • +
    +
  • +
  • +

    -q (string)

    +
      +
    • +

      A list of comma separated, case-insensitive items to include in the response. If omitted, no items are included.

      +

      Limiting the included items to only those you need can improve response time.

      +

      The following items are supported: columns, environment, execParms, find, function, initParms, jobs, keys, lines, loginfo, rows, lineCommands, message, notice, platformEncoding, position, screen, submittedJobs, userLog, and version. These represent the response properties as described in the models section of this help. The value all can be used to include all of the above items, but generally you should only request the items you need.

      +
    • +
    +
  • +
  • +

    -d (string)

    +
      +
    • +

      A download type, either pdf or text.

      +

      When specified, all other query parameters are ignored. The Content-Type response header will report either application/pdf or text/plain (charset utf-8) if no error occurred, and application/json if an error occurred. If no error occurred, a Content-Disposition response header will supply a suggested filename.

      +

      A pdf or text property may be included in the POST data to override default pdf and text formatting options.

      +

      This parameter provides pdf or text data in the output stream and does not require enumeration.

      +

      The API must be positioned on a browser type display to download data. Afterwards, the positioning may have changed depending on the amount specified.

      +

      You can use CancelDownload to cancel a long running download.

      +
    • +
    +
  • +
  • +

    -m (string)

    +
      +
    • +

      A mail attachment type, either pdf or text.

      +

      At a minimum, a mail property is required in the POST data to specify one or more recipients. A pdf or text property may also be included to override default pdf and text formatting options.

      +

      The API must be positioned on a browser type display to send a mail attachment. Afterwards, the positioning may have changed depending on the amount specified.

      +

      Note that you cannot use CancelDownload to cancel a long running mail attachement request because the response
      +containing the needed Cookie is not sent until after mail has been sent.

      +
    • +
    +
  • +
+

Init Request Options

+
    +
  • +

    --casKey (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --columns (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --extractdd (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --ipaddress (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --luName (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --patterndd (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --rows (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • +

      See the initParms model in the Swagger documentation.

      +

      Allowed values: jes2, jes3

      +
    • +
    +
  • +
  • +

    --useragent (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
+

Exec Request Options

+
    +
  • +

    --command (string)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --commanddata (string)

    +
      +
    • See the execParms model in the Swagger documentation. Insert "\n" in the string to indicate line breaks.
    • +
    +
  • +
  • +

    --commanddatafile (string)

    +
      +
    • The contents of this file (usually JCL on the local workstation file system) must be escaped properly for --commanddata. See the execParms model in the Swagger documentation. Uses EJES_SUBMIT_PATH for the path if it exists in the environment.
    • +
    +
  • +
  • +

    --enumtime (number)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --enumvalue (number)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --showhiddencolumns (boolean)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --translatescreen (boolean)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --waitforresponse (boolean)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
+

PDF and TEXT Common Options

+
    +
  • +

    --amount (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
  • +

    --blockid (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • See the pdf or text model in the Swagger documentation. (Carriage-control)
    • +
    +
  • +
  • +

    --count (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
  • +

    --recordid (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
  • +

    --start (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
  • +

    --todend (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
  • +

    --todstart (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
+

PDF Download Options

+
    +
  • +

    --decorate (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --font (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --orientation (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --overflow (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --pagesize (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
+

PDF Security Property Options

+
    +
  • +

    --allowassembly (boolean)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --allowcopying (boolean)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --allowmodification (boolean)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --allowprinting (boolean)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --masterpassword (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --openpassword (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
+

Mail Options

+
    +
  • +

    --bcc (string)

    +
      +
    • See the mail model in the Swagger documentation.
    • +
    +
  • +
  • +

    --body (string)

    +
      +
    • See the mail model in the Swagger documentation. Insert "\n" in the string to indicate line breaks.
    • +
    +
  • +
  • +

    --bodyfile (string)

    +
      +
    • See the mail model in the Swagger documentation. The contents of the file are read and escaped properly for --body. Uses EJES_SUBMIT_PATH for the path if it exists in the environment.
    • +
    +
  • +
  • +

    --carboncopy (string)

    +
      +
    • See the cc property the mail model in the Swagger documentation.
    • +
    +
  • +
  • +

    --from (string)

    +
      +
    • See the mail model in the Swagger documentation.
    • +
    +
  • +
  • +

    --html (string)

    +
      +
    • See the mail model in the Swagger documentation.
    • +
    +
  • +
  • +

    --subject (string)

    +
      +
    • See the mail model in the Swagger documentation.
    • +
    +
  • +
  • +

    --to (string)

    +
      +
    • See the mail model in the Swagger documentation.
    • +
    +
  • +
+

Platform-encoding Options

+
    +
  • +

    --platformencoding (number)

    +
      +
    • See the platformEncoding model in the Swagger documentation. Defaults to 1047 if not specified.
    • +
    +
  • +
+

Debug Visualization Options

+
    +
  • +

    --debug (number)

    +
      +
    • +

      An additive flag for tech support use.

      +

      1 - Commands discovered and compiled-options object

      +

      2 - Request object

      +

      4 - Response headers

      +
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • Perform a stateless transaction that submits a job using the --command option. It shows the status of jobs with the same name, sorting so the most recent is shown first. The --enumvalue option is requesting the top 5 lines. The query parameter -q is requesting the message array that will contain the submit result, lines of output, and the array of jobs submitted in this session. The --commanddata option supplies the JCL to submit referred to by the "api-array". The "\n" are line separators an editor would supply.
  • +
+

Example:

+
  * `$  zowe ejes api exec --command "submit api-array;st iefbr14;sort time d;upd" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddata "//IEFBR14  JOB IEFBR14,'IEFBR14',CLASS=A,MSGCLASS=H\n//EXEC     EXEC PGM=IEFBR14\n//"`
+
+
    +
  • Perform the same stateless transaction above but use the --commanddatafile option to read a file from the workstation. If EJES_SUBMIT_PATH is defined in the environment, that will be used as the file path, otherwise the same directory the CLI is run in will be used if a full path is not supplied.
  • +
+

Example:

+
  * `$  zowe ejes api exec --command "submit api-array;st iefbr14;sort time d;upd" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddatafile "iefbr14.jcl"`
+
+
    +
  • Perform a stateful request. In this case, a previous request positioned the (E)JES api in a job browser. This example downloads the file as PDF using the -d option. It causes the carriage control symbols to be interpretted with the --cc option. Then specifies stateful session with the cookie it generated specified on the --cookie option. The sysout is download to a file with the name consistent with the browsed data set or browser. If EJES_DOWNLOAD_PATH exists in the environment, the path is used for the download. Otherwise, the file is created in the current working directory. (For managed cookie stateful request examples, issue: Zowe ejes api -h)
  • +
+

Example:

+
  * `$  zowe ejes api exec -d text --cc interpret --cookie "EJESWEB_54761=B6910D...;path=/EjesWeb;Secure;HttpOnly"`
+
+

zoweejesapiinit

+

Creates an API session and optionally issues an API command. Returns items as requested by the -q and -c options. A Set-Cookie header is included in the response. The value of the returned cookie identifies the session and should be supplied as an argument on the --cookie option on subsequent API data, exec, and term requests. Cookies can be managed for you. See the --cookie option for details. Close the session with an API term request when it is no longer needed to free up system resources. Sessions that are idle for more than two minutes will be automatically closed. See the (E)JES REST API swagger documentation for details on the mapped options. Enclose all option arguments in double quotes if they include spaces, semicolons, or symbols that are reserved in your terminal shell or if they might otherwise be ambiguous to the shell.

+

For a command group overview, issue: zowe ejes api -h

+

Usage

+

zowe ejes api init [options]

+

Query Item Options

+
    +
  • +

    --authorization (string)

    +
      +
    • If you do not specify the --cookie option, you must include --user and --password or this option. The base64 encoded authentication string can be of the form userid:password or userid:group:password. If supplied, it overrides the profile user and password settings and starts a new session.
    • +
    +
  • +
  • +

    --cookie (string)

    +
      +
    • +

      Supply the cookie output by a stateful request. This option supports optional syntax to enable automatic management of the cookie without scraping from stdout.

      +

      --cookie [<cookie-value>|read[<pin>]|write[<pin>]

      +

      The CLI can manage a stateful cookie transaction proactively. On the init, specify --cookie write or --cookie write-pin where pin can be any alphanumeric string. On the exec, cancel-download, and term specify --cookie read or --cookie read-pin. The cookie generated by the host is managed in the user's work directory. A pin is required only when there are multiple simultaneous sessions.

      +
    • +
    +
  • +
  • +

    -c (string)

    +
      +
    • +

      A list of comma separated, case-insensitive names of columns to include in the response. If omitted, all columns for the current tabular display are included.

      +

      This parameter only applies to enumerated data containing columns, specifically, the columns and rows items of the q parameter.

      +

      Limiting the included columns to only those you need can dramatically improve the resonse time of the request and significantly reduce system resources.

      +
    • +
    +
  • +
  • +

    -q (string)

    +
      +
    • +

      A list of comma separated, case-insensitive items to include in the response. If omitted, no items are included.

      +

      Limiting the included items to only those you need can improve response time.

      +

      The following items are supported: columns, environment, execParms, find, function, initParms, jobs, keys, lines, loginfo, rows, lineCommands, message, notice, platformEncoding, position, screen, submittedJobs, userLog, and version. These represent the response properties as described in the models section of this help. The value all can be used to include all of the above items, but generally you should only request the items you need.

      +
    • +
    +
  • +
+

Init Request Options

+
    +
  • +

    --casKey (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --columns (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --extractdd (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --ipaddress (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --luName (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --patterndd (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --rows (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • +

      See the initParms model in the Swagger documentation.

      +

      Allowed values: jes2, jes3

      +
    • +
    +
  • +
  • +

    --useragent (string)

    +
      +
    • See the initParms model in the Swagger documentation. Shows on the (E)JES Session panel and is a best practise to use.
    • +
    +
  • +
+

Exec Request Options

+
    +
  • +

    --command (string)

    +
      +
    • See the execParms model in the Swagger documentation. The argument is a (E)JES command stack. Refer to chapter 5 of the (E)JES Reference.
    • +
    +
  • +
  • +

    --commanddata (string)

    +
      +
    • See the execParms model in the Swagger documentation. Insert "\n" in the string to indicate line breaks.
    • +
    +
  • +
  • +

    --commanddatafile (string)

    +
      +
    • See the execParms model in the Swagger documentation. The contents of the file are read and escaped properly for --commanddata. Uses EJES_SUBMIT_PATH for the path if it exists in the environment.
    • +
    +
  • +
  • +

    --enumtime (number)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --enumvalue (number)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --showhiddencolumns (boolean)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --translatescreen (boolean)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --waitforresponse (boolean)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
+

Platform-encoding Options

+
    +
  • +

    --platformencoding (number)

    +
      +
    • See the platformEncoding model in the Swagger documentation. Defaults to 1047 if not specified.
    • +
    +
  • +
+

Debug Visualization Options

+
    +
  • +

    --debug (number)

    +
      +
    • +

      An additive flag for tech support use.

      +

      1 - Commands discovered and compiled-options object

      +

      2 - Request object

      +

      4 - Response headers

      +
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Initalize a session by using --command to display the status screen, then output the JCL of the first job. Use --enumValue to request 10 lines. The option -q requests the message array, lines of output, and the function array. Though browsed output is requested, if the first job does not have JCL, the status screen will be returned to show that the job that did not meet the criteria. The --rfj option visualizes the output as JSON. Without it, the CLI returns only the cookie.

    +

    Example:

    +
      +
    • zowe ejes api init --command "status;1 j" --enumvalue 10 -q message,lines,function --rfj
    • +
    +
  • +
+

zoweejesapiterm

+

Terminates the API session.

+

For a command group overview, issue: zowe ejes api -h

+

Usage

+

zowe ejes api term [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • Terminate an existing session by specifying the session on the --cookie option. No output is returned if the transaction completes without error.
  • +
+

Example:

+
  * `$  zowe ejes api term --cookie "EJESWEB_54761=0F6E5A...;path=/EjesWeb;Secure;HttpOnly"`
+
+

zoweejesbatch

+

The (E)JES batch interface provides much of the power of the on-line environment to automated programs or scripts.

+

Using the batch interface, procedures may be created that issue commands or alter other resources based upon the condition of jobs in the JESplex and the contents of spool information (e.g., reports, condition codes, JES messages) produced by those jobs. System housekeeping functions containing (E)JES batch procedures may be submitted at scheduled times, on demand, or when certain system conditions are met. Practically any function that requires access to spool or other (E)JES-provided information can be automated.

+

zoweejesbatchactivity

+

Display jobs in all active address spaces for the JESplex or sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch activity [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchapfds

+

Display APF-authorized libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch apfds [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchclass

+

Display job classes defined for the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch class [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchcmdstack

+

Issues a starting command stack. It connects to the host and allows you to use an enhanced set of EJES BATCH commands.

+

Usage

+

zowe ejes batch cmdstack <parameter-list> [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • A required command stack enclosed in double-quotes. The command stack may contain meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For information about (E)JES host primary commands and their parameters, read Chapter 5 (E)JES Commands in the (E)JES Reference.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (string)

    +
      +
    • Display blank lines to stderr (starts with blanks on)
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --resume | -r (array)

    +
      +
    • For use with the pause meta command. Use "off" to prevent resuming an auto pin session.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchcommand

+

Display the long command processor, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch command [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchdjc

+

Display a table of Dependent Job Control networks in the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch djc [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchdynexit

+

Display a table of MVS dynamic exits defined within the current sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch dynexit [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchenclave

+

Display a table of WLM enclaves defined within the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch enclave [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain an invocation system selection override and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchenq

+

Display a table of information about ENQs and RESERVEs in the sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch enq [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchenqc

+

Display a table of information about ENQ contention in the sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch enqc [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchenqd

+

Display a table of information about ENQ SYSDSN resources in the sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch enqd [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchentry

+

Display the (E)JES entry panel, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch entry [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchfss

+

Display a table of Functional Subsystems defined for the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch fss [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchgroup

+

Display a table of Generalized Main Scheduler parameters for job class groups in the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch group [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchhcheck

+

Display a table of the about checks registered with IBM Health Checker for z/OS, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch hcheck [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchhold

+

Display a table of the sysout in the Hold queue, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch hold [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchinit

+

Display a table of JES2-managed batch initiators defined for the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch init [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchinput

+

Display a table of all jobs in the JESplex that are in pre-execution and execution status, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch input [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchjesplex

+

Display a table of JES images in your z/OS JESplex, then enter the EJES Batch Shell. A JES2 JESplex is also known as a Multi-Access SPOOL configuration or MAS. A JES3 JESplex is also known as a JES3 complex.

+

Usage

+

zowe ejes batch jesplex [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchjgroup

+

Display a table of the active job groups in the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch jgroup [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchline

+

Display a table of the lines that connect NJE nodes to your JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch line [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchlnklst

+

Display a table of data sets in the link list concatenation of the link list libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch lnklst [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchlog

+

Display the log, then enter the EJES Batch Shell. You may optionally specify operlog or syslog, or command stack 'logattr on' to see the operlog display in MCS Console colors.

+

Usage

+

zowe ejes batch log [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchlpalst

+

Display a table of data sets in the LPA concatenation of the link pack libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch lpalst [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchmds

+

Display a table of jobs in the JESplex that are currently delayed in one of the Main Device Scheduler queues, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch mds [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchmemusage

+

Display a table of real and virtual memory requirements of jobs and other tasks running within your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch memusage [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchmenu

+

Display or control the (E)JES menu, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch menu [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchmounts

+

Display a table of mounted file systems within the sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch mounts [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchnetconn

+

Display a table of NJE (Network Job Entry) connection, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch netconn [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchnetserv

+

Display a table of NJE network servers, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch netserv [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain an invocation system selection override and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchnje

+

Display a table of sysout in the Bulk Data Transfer and TCP/IP NJE queues, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch nje [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchnode

+

Display a table of the NJE nodes defined to the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch node [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchnop

+

Start or resume a session with no operation. Most useful in conjunction with --resume.

+

Usage

+

zowe ejes batch nop [options]

+

Options

+
    +
  • +

    --blanks | -b (string)

    +
      +
    • Display blank lines to stderr (starts with blanks on)
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --resume | -r (array)

    +
      +
    • For use with the pause meta command. Use "off" to prevent resuming an auto pin session. Most useful in conjunction with --resume.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchoffload

+

Display a table of the JES2 spool offload devices in your JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch offload [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchOutput

+

Display a table of sysout in the JES2 Output queue, then enter the EJES Batch Shell. The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.

+

Usage

+

zowe ejes batch Output [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchpageds

+

Display a table of paging resources defined to the systems in your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch pageds [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchparmlib

+

Display a table of information about system parameter libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch parmlib [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchprinter

+

Display a table of JES writers which drive local, FSS, and signed-on/logged-on remote printer and punch devices attached to the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch printer [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchproclib

+

Display a table of information about your JES proclib concatenations, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch proclib [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchpstatus

+

Display a table of z/OS UNIX processes running in the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch pstatus [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchquery

+

Display displays or primary commands your credentials authorize, then enter the EJES Batch Shell. The positional operand is required and may be 'auth' or 'auth display'.

+

Usage

+

zowe ejes batch query <parameter-list> [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchresmon

+

Display a table of JES resources for the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch resmon [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchresource

+

Display a table of the WLM Resources defined for the current sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch resource [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchschenv

+

Display a table of the WLM Scheduling Environments defined for the current sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch schenv [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchsession

+

Display a table of all active (E)JES sessions, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch session [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchshell

+

Starts the EJES Batch Shell without logging on. It allows you to connect to the host and use an enhanced set of EJES BATCH commands.

+

Usage

+

zowe ejes batch shell [options]

+

Options

+
    +
  • +

    --blanks | -b (string)

    +
      +
    • Display blank lines to stderr (starts with blanks on)
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --resume | -r (array)

    +
      +
    • For use with the pause meta command. Use "off" to prevent resuming an auto pin session.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchspart

+

Display a table of the SPOOL partition configuration of your JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch spart [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchspvol

+

Display a table of the SPOOL volume extent configuration of your JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch spvol [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchstatus

+

Display jobs in the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch status [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchsubsys

+

Display a table of all the MVS subsystems defined to the systems in your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch subsys [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchsymbol

+

Display a table of z/OS system symbols as well as JES and JCL symbols defined for the current address space, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch symbol [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchsyscls

+

Display a table of the sysout class configuration for your JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch syscls [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchsysplex

+

Display a table of the connected system images in your z/OS sysplex, then enter the EJES Batch Shell. In a monoplex, you manage the current system only (i.e., the image on which your (E)JES session is executing).

+

Usage

+

zowe ejes batch sysplex [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain an invocation system selection override and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchsysreq

+

Display a table of outstanding replies and messages retained by the MVS Action Message Retention Facility (AMRF), then enter the EJES Batch Shell. Outstanding replies and action messages for the entire sysplex are shown.

+

Usage

+

zowe ejes batch sysreq [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchulog

+

Display the user log console browser, then enter the EJES Batch Shell. The optional parameter allows you to specify a console name other than that which would normally be chosen automatically. Please refer to the CONSOLE command documentation for considerations when specifying a console name.

+

Usage

+

zowe ejes batch ulog [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchwriter

+

Display a table of sysout in the JES3 Writer queue, then enter the EJES Batch Shell. The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.

+

Usage

+

zowe ejes batch writer [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesbatchzero

+

Display a table of sysout data sets created by JES3 internal facilities, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch zero [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesissue

+

Issue a system command by sending the positional parameters to the host. (E)JES will respond with output sent to your user log.

+

zoweejesissuesubmit

+

Submit a job from the local host with the local: prefix, or a MVS data set or z/OS UNIX path. Responds with submission messages and a table providing a description of a successful submission.

+

Usage

+

zowe ejes issue submit <command> [options]

+

Positional Arguments

+
    +
  • +

    command (string)

    +
      +
    • Any of MVS data set name, z/OS UNIX path name, or a workstation file prefixed by 'local:'. The environment variable EJES_SUBMIT_PATH is used to provide a path for a local workstation file if only a file name is provided. When not present, the current working directory is used instead. While the use of the command line options below is recommended, you may instead append to the command string arguments for the submit command listed in the (E)JES Reference.
    • +
    +
  • +
+

Options

+
    +
  • +

    --debug | --dbg | --dv (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --lrecl (number)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --recfm (string)

    +
      +
    • +

      Record format of fixed or variable length.

      +

      Allowed values: f, v, list, help

      +
    • +
    +
  • +
  • +

    --subsys (string)

    +
      +
    • +

      Subsystem name where the job should be sent. If not specified defaults to the subsystem under which the current (E)JES session is running. For JES3plus, use jes3.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
  • +

    --unit (string)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (string)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit a local workstation file:

    +
      +
    • zowe ejes issue submit "local:iefbr14.jcl" --lrecl 132 --subsys jes3
    • +
    +
  • +
  • +

    Submit a local workstation file using arguments:

    +
      +
    • zowe ejes issue submit "local:iefbr14.jcl lrecl(132) subsys(jes3)"
    • +
    +
  • +
  • +

    Submit a clist member:

    +
      +
    • zowe ejes issue submit "a.cntl(iefbr14)"
    • +
    +
  • +
+

zoweejesissuesyscmd

+

Issue a system command and receive console output as a report in text format.

+

Usage

+

zowe ejes issue syscmd <command> [options]

+

Positional Arguments

+
    +
  • +

    command (string)

    +
      +
    • System console command enclosed in double-quotes. If you wish to issue multiple commands, follow each command with a semicolon and a slash(;/)
    • +
    +
  • +
+

Options

+
    +
  • +

    --debug | --dbg (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • Run under dry-run protocols.
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • Maximum lines in a table or report. [1000 | tty-default | number | all]
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • Maximum characters per line or row. [tty-default | number | all]
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Display the time:

    +
      +
    • zowe ejes issue syscmd "d t"
    • +
    +
  • +
  • +

    Display time and ppt:

    +
      +
    • zowe ejes issue syscmd "d t;/d ppt"
    • +
    +
  • +
+

zoweejeslog

+

Output the tail end of the host log to stdout, optionally streaming new records. Positioning, searching, and limiting options are supported, including specifying which log type and what system.

+

zoweejeslogstream

+

Outputs the operations log or system log to stdout. Behaves like a Linux tail function with support for standard tail options --follow (-f), --lines (-n), -q, -v, and --version.

+
  Set the position in the log to begin output using \-\-find, \-\-line, \-\-time, and \-\-offset\.  
+
+  Use OPERLOG Message Filtering Options to create a windowed log by filtering for and outputting only lines that fit criteria, e\.g\., fetch only lines associated with an IAT6xxxx message by specifying: \-\-msgId "IAT6\*"\.  After filtering the log, output is positioned at the bottom\.  Use position options to change that\.
+
+  Turn on highlighting for \-\-find using \-\-hilite\.  Perform regex text matching with highlighting using \-\-match\.  Enable MCS console color emulation with \-\-mcs\.  To prevent ANSI escape characters from being output and to instead use accessibility\-friendly text\-only indicators, specify: \-\-nocolor "on"\.
+
+  The order of host commands issued during initialization are fixed in this program in this order:
+
+

1. All OPERLOG message filtering options, e.g., --msgId and --msgTxt

+

2. --line

+

3. --time

+

4. --find

+

5. --offset

+
  Conceptually and depending on specified options, the program can create a window into the log data using message filtering options, then can point to a line in the data such as the first line, then can position at a time, then find arbitrary text, then offset the view up and down by seconds to days or a number of lines\.
+
+  The program outputs trailer diagnostic lines at the end of the run to stderr\.  Use this information to make your queries more efficient\.  The trailer and header lines can be muted using the \-\-quiet (\-q) option or setting the EJES\_LOG\_CLI\_QUIET environment variable\.  The program outputs a bottom\-of\-data line to stdout that is considered an output line by \-\-lines with a line\-count argument\.  To disable it, set the EJES\_LOG\_CLI\_NO\_BOTTOM environment variable\.
+
+

Usage

+

zowe ejes log stream [log-type] [options]

+

Positional Arguments

+
    +
  • +

    log-type (string)

    +
      +
    • Optional. If not specified, the Operations Log is output if the Operations Log is active for the current MVS system. Otherwise, the System Log is output. Must match regular expression: operlog|oper|o|syslog|sys|s
    • +
    +
  • +
+

Options

+
    +
  • +

    --follow | -f | --nonstop | --ns (boolean)

    +
      +
    • Follow the log stream. Displays last page of log then waits for more data. Ignored for --response-format-json. The actual maximum duration is controlled by your host refresh command settings.
    • +
    +
  • +
  • +

    --lines | -n (array)

    +
      +
    • +

      Limit output to a number of lines or a time span. 10 lines is used if the option is not specified.

      +
        Specify a maximum number of lines up to 999,999 lines (supports multipliers), or specify a time span of 0\.01 to 999 seconds, minutes, hours, or days by specifying a number followed by "s", "m", "h", or "d"\.  Specify  "all" for unlimited output\.
      +
      +  When \-\-request\-format\-json (\-\-rfj) is specified, the number of lines up to 5,000 specified on this option (or the default of 10) determines the number of lines fetched from the host and stored in the output json data array\.  With \-\-rfj, this option overrides \-\-enumValue\.
      +
      +  Supports Linux positioning syntax of \+ followed by a line number\.  This is the same as specifying \-\-line n \-\-lines all\.  When the intent is to fetch middle lines from the log, use \-\-line to position and \-\-lines to limit the count\.
      +
      +  Note: When there are no positioning requests, the program attempts to get the bottom n lines\.  However, the log is a dynamic data set and the actual log type may be different than assumed\.  The bottom\-of\-data line will output only if the number of lines is not exceeded when bottom is found\.
      +
      +

      Allowed values: all, ^(?:[1-9]|\d\.)\d{0,2}[smhd]$, ^[1-9]\d{0,5}$, ^\+[1-9]\d*$, ^[1-9]\d{0,2}(b|kB|K|MB|M|GB|G|KiB|MiB|GiB)$

      +
    • +
    +
  • +
  • +

    --bytes | -c (string)

    +
      +
    • +

      Byte level output counts supported only for syntax checking. Use --lines or filter with a TAIL terminal command instead.

      +

      Allowed values: ^\+[1-9]\d*$

      +
    • +
    +
  • +
  • +

    --quiet | -q | --silent (boolean)

    +
      +
    • Do not display header or trailer lines. Set the environment variable EJES_LOG_CLI_QUIET to make this the default. Set EJES_LOG_CLI_NO_BOTTOM to prevent displaying the bottom of data line.
    • +
    +
  • +
  • +

    --verbose | -v (boolean)

    +
      +
    • Display header lines or trailer. This is the default unless the environment variable EJES_LOG_CLI_QUIET is set. Set EJES_LOG_CLI_NO_BOTTOM to prevent displaying the bottom of data line.
    • +
    +
  • +
  • +

    --version (boolean)

    +
      +
    • Display version header and quit.
    • +
    +
  • +
  • +

    --requests (number)

    +
      +
    • Limit the number of normally unlimited host requests. Only host requests for data, additional data, or find next data count as a request.
    • +
    +
  • +
+

ANSI Color Options

+
    +
  • +

    --mcs | --mcsConsoleColor | --mcs-console-color (boolean)

    +
      +
    • Use ANSI escape characters to emulate the color and extended highlighting attributes in OPERLOG output to resemble the formatting on an MCS operator console. If --no-color on is specified, textual attributes will be prefixed instead. The MVS "DISPLAY MPF" command displays the message assignments color attributes in use on your host system.
    • +
    +
  • +
  • +

    --match | --matchText | --match-text | --mt | -m (string)

    +
      +
    • +

      Specify case-independent text to match and highlight using ANSI escape characters.

      +
        Specify a string, a Javascript regex pattern without the enclosing slashes (e\.g\., "login|logoff|force"), or a Javascript regex pattern string with slashes and regex option flags (e\.g\., "/\[Ll\]ogo\.{1,2}|Signoff/g")\.  If the first or second type is used, the flags default to ig (ignore\-case and global match)\.
      +
      +  Matching does not position for output the way \-\-find does; it can be used in conjuction with a \-\-find\.  Matching is done on each output line separately\.  All matches in a line will be highlighted\.  If \-\-no\-color on is specified, the line will be prefixed with ">"\.  If the built\-in highlight attribute isn't visible on your terminal, either change the foreground color or set the environment variable EJES\_LOG\_CLI\_ANSIMATCHATTR\.  0 to 256 are valid as defined on this Wikipedia page:
      +
      +  <https://en\.wikipedia\.org/wiki/ANSI\_escape\_code\#8\-bit>
      +
      +
    • +
    +
  • +
+

Find String and Position Options

+
    +
  • +

    --find (string)

    +
      +
    • +

      Position start of output using (E)JES host FIND command syntax (below). Find positioning is done after --line and --time, but before --offset. Limit lines to found lines with --only. Limit excessive enumeration and provide context with --context.

      +
        NOTE: To search for specific message IDs or find text in messages on the OPERLOG, use \-\-msgId or \-\-msgText instead\.  OPERLOG message filtering Options show entire messages and may be more efficient\.  Since these options position at the bottom of the log, specify \-\-line to position at the first message or specify \-\-find to find further refine your search\.  Refer to OPERLOG Message Filtering Options for further alternatives to FIND\.
      +
      +  (E)JES Host FIND Command Syntax:  Only the find\-string is required\.  It should be enclosed in single quotes if it contains spaces or special characters\.  Case\-independent search is the default\.  Case dependent is specified using c'find\-string'\. Searching for double\-quotes is not supported\.  (The search\-type arguments "next" and "prev" carry over  3270 display behavior\.  In this program, "prev" means find the last occurrence above the last 53 lines of the log; the default "next" searches forward starting 53 lines before the bottom\.)  Refer to the (E)JES Reference for the FIND command for detailed find syntax and option documention\.
      +
      +  \['|c'|p'|x'\]find\-string\['\] \[NEXT|prev|first|last\] \[CHARS|prefix|pre|suffix|suf|word\] \[startcol\[ endcol\]\]
      +
      +

      Allowed values: ^((?:c|p|x|)'.+'(?:c|p|x|)|[^'\s]+)(?:(?:\s+(first|last|next|prev|all)){0,1}(?:(?:\s+(chars|pre|prefix|suf|suffix|word)){0,1}(?:\s+(\d*\s+\d*|\d*)){0,2}){0,1}){0,1}$

      +
    • +
    +
  • +
  • +

    --hilite | --highlight-find-text | --highlight | --ht (array)

    +
      +
    • +

      Use in conjunction with --find to highlight found strings using ANSI escape characters. If --no-color on is specified, the line will be prefixed with "=".

      +
        If the built\-in highlight attribute isn't visible on your terminal, either change the foreground color or set the environment variable EJES\_LOG\_CLI\_ANSIFINDATTR to 8, 6, or 3\.  0 to 256 are valid as defined on this Wikipedia page:
      +
      +  <https://en\.wikipedia\.org/wiki/ANSI\_escape\_code\#8\-bit>
      +
      +
    • +
    +
  • +
  • +

    --only | -o (boolean)

    +
      +
    • Output only lines marked by the host as found using the --find option. The --context option modifies this option by also outputing context lines following the found lines. Some OPERLOG message filtering options (e.g., --msgId and --msgTxt) may provide better results and will be more efficient and faster.
    • +
    +
  • +
  • +

    --context | --cx (array)

    +
      +
    • +

      Specify 2 to 49 lines of context after the found line when --only is specified. 5 is used if an argument is not specified. To display only found lines, do not specify --context.

      +

      Allowed values: s, sep, separator, ^[1-4]\d*$|^[2-9]$

      +
    • +
    +
  • +
+

Positioning Options

+
    +
  • +

    --line (array)

    +
      +
    • +

      Position at a specific line in the log. With no argument, it positions to top of the displayable log (like the TOP command). Positioning done before --time, --find, and --offset.

      +

      Allowed values: first, last, ^[1-9]\d*$

      +
    • +
    +
  • +
  • +

    --head (boolean)

    +
      +
    • Position at top of log same as --line without an argument. Positioning done before --time, --find, and --offset.
    • +
    +
  • +
  • +

    --time (array)

    +
      +
    • +

      Positions a time on the current day or to a time and date. With no argument, positions to the beginning of the day. Positioning done before --find and --offset, but after --line.

      +
        The argument is hh:mm:ss:th\-date, where ss or ss:th and the date are optional\.
      +
      +

      The date, if specified, is specified as yyyy.ddd, yyyy-ddd, yyyy/mm/dd, yyyy/dd/mm, mm/dd/yyyy, dd/mm/yyyy, yyyy-mm-dd, yyyy-dd-mm, mm-dd-yyyy, or dd-mm-yyyy. The Julian date form is always valid.

      +
        The Gregorian date form depends upon your current date format setting, though both slash (/) and dash (\-) are accepted as separator characters\.  Specify "?" to return the Gregorian date format and quit, i\.e\., \-\-time "?"
      +
      +  Two copy\-paste date\-time formats are supported\.  A date\-time may copied from the log and pasted, enclosed in quotes, after the \-\-time option\.  Operlog: "yyyydddd hh:mm:ss\.th"\.  Syslog: "yyyyddd hhmmsst"\.
      +
      +

      Allowed values: (?:^(20\d{5}) (\d{7})$)|(?:^(20\d{5}) ((\d\d:\d\d:\d\d.\d\d))$)|(?:^(\d\d\:\d\d(?:\:\d\d){0,2}(?:-(?:(?:\d{4}[.-]\d{3}$)|(?:^\d{4}(?:[\/|-]\d{2}){2}$)|(?:^(?:\d{2}[\/|-]){2}\d{4})))*){0,1}$|^\?$)

      +
    • +
    +
  • +
+

Positioning Offset Options

+
    +
  • +

    --offset | --off (array)

    +
      +
    • +

      Offset positioning by time or line count after the final position arrived at by message filtering, --line, --time, and --find. Optional directional indicators are next or + (later in log) or prev (earlier). If the directional indicator is omitted, earlier in the log is assumed. Valid trailing time indicators are s, m, h, or d. A number without a time indicator assumes h on OPERLOG, but on SYSLOG positions by adding to the current data set number (if 0, it positions at the top of the current data set). The l indicator is a line count indicator. Specify this to offset by n lines. Without an argument, prev4l is assumed, which is helpful when specifying --find to provide context even when -n 10 (the default) is specified.

      +

      Allowed values: ^(\+|next|prev)*(\d+[smhdl]{0,1})$

      +
    • +
    +
  • +
+

OPERLOG Message Filtering Options

+
    +
  • +

    --system-name | --systemName | --sysname | --sn (array)

    +
      +
    • Filter for up to 4 provided system name(s). Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time of the OPERLOG browser can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
    • +
    +
  • +
  • +

    --job-name | --jobName | --jname | -j (array)

    +
      +
    • Filter OPERLOG for up to 4 provided job names. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
    • +
    +
  • +
  • +

    --job-id | --jobId | --jid (array)

    +
      +
    • Filter OPERLOG for up to 4 provided job ids, e.g, J0632369. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
    • +
    +
  • +
  • +

    --console | --con (array)

    +
      +
    • Filter OPERLOG for up to 4 provided consoles. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
    • +
    +
  • +
  • +

    --message-id | --messageId | --msgId | --mi (array)

    +
      +
    • Filter OPERLOG for up to 3 provided message ids of up to 12 characters. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
    • +
    +
  • +
  • +

    --message-text | --messageText | --msgText | --msgTxt | --mtxt | --mx (array)

    +
      +
    • Filter OPERLOG for message text of up to 34 characters. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. To filter for strings inside a message's text, use generic characters, e.g., "*logon*". Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
    • +
    +
  • +
  • +

    --routing-codes | --routingCodes | --routing | -r (array)

    +
      +
    • +

      Filter OPERLOG for routing codes. Up to 34 characters that may be ALL, NONE, or a list of decimal routing codes or ranges. For example: 1,3,6-9,100-128. Multiline messages are output in their entirety. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.

      +

      Default value: ALL

      +
    • +
    +
  • +
  • +

    --descriptor-codes | --descriptorCodes | --descriptor | --dc (array)

    +
      +
    • +

      Filter OPERLOG for descriptor codes. Up to 34 characters that may be ALL, NONE, or a list of decimal descriptor codes or ranges. For example: 1,3,6-9. Multiline messages are output in their entirety. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.

      +

      Default value: ALL

      +
    • +
    +
  • +
  • +

    --window-bottom | --windowBottom | --winBot | --wb | --bot | --high-time-date | --htd (array)

    +
      +
    • +

      Filter OPERLOG by setting the time and optionally the date of the bottom of the log to use. Up to 23 characters.

      +
        The boundary specifications may be either fixed time\-date values, e\.g\."16:00:12:90\-2021/02/12" (see “Time\-Date Values” in the (E)JES Reference) or calculated relative to the time stamp associated with the record shown at 57 lines from the bottom of the log at start\-up\.
      +
      +  A relative value is indicated by the presence of a next (\+) or previous preceding the boundary specification, e\.g\., prev1h\. After the next or previous you may specify either a number of seconds, minutes, hours, or days as indicated by using a 's', 'm', 'h', or 'd' suffix\. Assumes 'h' if omitted\.
      +
      +  Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display\.
      +
      +

      Allowed values: ^(\+|next|prev)*(\d+[smhd]{0,1})$|(?:^(20\d{5}) ((\d\d:\d\d:\d\d.\d\d))$)|^(?:(\d\d\:\d\d(?:\:\d\d){0,2}(?:-(?:(?:\d{4}[.-]\d{3})|(?:\d{4}(?:[\/|-]\d{2}){2})|(?:(?:\d{2}[\/|-]){2}\d{4})))*){0,1}|\?)$

      +
    • +
    +
  • +
  • +

    --window-top | --windowTop | --winTop | --wt | --top | --low-time-date | --ltd (array)

    +
      +
    • +

      Filter OPERLOG by setting the time and optionally the date of the top of the log to use. Up to 23 characters.

      +
        The boundary specifications may be either fixed time\-date values, e\.g\."16:00:12:90\-2021/02/12" (see “Time\-Date Values” in the (E)JES Reference) or calculated relative to the time stamp associated with the record shown at 57 lines from the bottom of the log at start\-up\.
      +
      +  A relative value is indicated by the presence of a next (\+) or previous preceding the boundary specification, e\.g\., prev1h\. After the next or previous you may specify either a number of seconds, minutes, hours, or days as indicated by using a 's', 'm', 'h', or 'd' suffix\. Assumes 'h' if omitted\.
      +
      +  Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display\.
      +
      +

      Allowed values: ^(\+|next|prev)*(\d+[smhd]{0,1})$|(?:^(20\d{5}) ((\d\d:\d\d:\d\d.\d\d))$)|^(?:(\d\d\:\d\d(?:\:\d\d){0,2}(?:-(?:(?:\d{4}[.-]\d{3})|(?:\d{4}(?:[\/|-]\d{2}){2})|(?:(?:\d{2}[\/|-]){2}\d{4})))*){0,1}|\?)$

      +
    • +
    +
  • +
  • +

    --mpf-exit-flags | --mpfExitFlags | --mpf (array)

    +
      +
    • +

      Filter OPERLOG for MPF/Exit flags with a "value mask" of eight hexadecimal characters, e.g., 00000291. Use in conjunction with the "result directive" (see --result-directive).

      +
        The filtering is performed by ANDing the hexadecimal value mask against a message’s MPF/Exit Flags value and then displaying the message based upon the result directive (zero or non\-zero)\.  For example, a mask and result directive of 00000001 and NZ will display messages that were suppressed by MPF\. Specifying 00000001 and Z displays messages that were not suppressed\.
      +
      +  Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display\.  Multiline messages are output in their entirety\.  
      +
      +

      Default value: FFFFFFFF
      +Allowed values: ^[0-9A-F]{8}$, ^[0-9a-f]{8}$

      +
    • +
    +
  • +
  • +

    --result-directive | --resultDirective | --rd (array)

    +
      +
    • +

      Provide the result directive for the --mpf-exit-flags option (see the option for more information). A mask and result directive of 00000001 and NZ will display messages that were suppressed by MPF. A mask and result directive of 00000001 and Z displays messages that were not suppressed. Multiline messages are output in their entirety. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.

      +

      Default value: NZ
      +Allowed values: NZ, Z, EQ, NE

      +
    • +
    +
  • +
+

Log Options

+
    +
  • +

    --logsys | -l (string)

    +
      +
    • Specify a syslog to display by specifying the MVS name of a system in a JES2 environment. The current system is browsed if --logsys is not specified.
    • +
    +
  • +
  • +

    --syslog | --sys (boolean)

    +
      +
    • +

      Display the SYSLOG instead of the default log. Deprecated. Use the positional parameter instead.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --operlog | --oper (boolean)

    +
      +
    • +

      Display the OPERLOG instead of the default log. Deprecated. Use the positional parameter instead.

      +

      Default value: false

      +
    • +
    +
  • +
+

JES-type Options

+
    +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • +

      Use the JES2 spooler instead of the default spooler.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • +

      Use the JES3 or JES3plus spooler instead of the default spooler.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Specify the JES spooler system to use instead of the default spooler.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -U (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

EJES CLI Runtime Options

+
    +
  • +

    --enum-value | --enumval | --ev (number)

    +
      +
    • +

      Number of lines to retreieve per (E)JES API call. Overridden by the combination of --rfj and --line (-n). See --line.

      +

      Default value: 200

      +
    • +
    +
  • +
  • +

    --refresh-interval | --refreshInterval | --refresh | --ri | --sleep-interval | --sleep | -s (number)

    +
      +
    • +

      Number of seconds between (E)JES API calls in log stream command. The actual minimum and maximum interval is controlled by your host refresh command settings.

      +

      Default value: 5

      +
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | -d (number)

    +
      +
    • +

      Invoke debugging code with additive flags. 1=request, 2=minimum response, 4=full response, 8=housekeeping, 16=show record info, 32=show fetch metadata.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --detailed-json | --detailedjson | --detail | --dj (boolean)

    +
      +
    • +

      Include metadata objects and arrays in --rfj output, not just an array of lines.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Output 10 lines at the tail of the log:

    +
      +
    • zowe ejes log stream
    • +
    +
  • +
  • +

    Output 40 lines at head of the log with no header or trailer lines. The -n option is an alias for --lines and -q is an alias for --quiet:

    +
      +
    • zowe ejes log stream --head -n 40 -q
    • +
    +
  • +
  • +

    Stream the tail of the default log defined for your credentials until you press CTRL+C. The -f option is an alias for --follow:

    +
      +
    • zowe ejes log stream --follow
    • +
    +
  • +
  • +

    Stream the tail of the syslog:

    +
      +
    • zowe ejes log stream syslog --follow
    • +
    +
  • +
  • +

    Stream the tail of the operlog:

    +
      +
    • zowe ejes log stream operlog --follow
    • +
    +
  • +
  • +

    Match and highlight user logons in output lines. (NOTE: This does not position to the string; it *only* highlights them *if* they are in the output.) Match can also work with a simple string, or a regex string with no forward slash characters, implying the "ig" flags (ignore-case and global-match):

    +
      +
    • zowe ejes log stream --match "/[Ll]ogo.{1,2}|force|Signoff/g"
    • +
    +
  • +
  • +

    Match and mark user logons without ANSI color escape sequences. The --nc option is an alias for --no-color:

    +
      +
    • zowe ejes log stream --match "/[Ll]ogo.{1,2}|force|Signoff/g" --nc on
    • +
    +
  • +
  • +

    Find your logon Id in the log:

    +
      +
    • zowe ejes log stream --find yourLogonId
    • +
    +
  • +
  • +

    Find your logon Id in the log and highlight the found text:

    +
      +
    • zowe ejes log stream --hilite --find yourLogonId
    • +
    +
  • +
  • +

    Find your logon id in the log with a few lines above it for context. The --offset option is down 4 lines (prev4l) if the argument is not specified:

    +
      +
    • zowe ejes log stream --find yourLogonId --offset
    • +
    +
  • +
  • +

    Find your TSO logons and logoffs for today by specifying you logon id followed by "- log" in the log. Note that if the find string includes spaces or special characters, you need to enclose it in single-quotes. Find without a find without a search type uses NEXT, searching forward from a position. Using the --time option without an argument positions to the start of the current day before finding. Without the --time option, the default position is 53 lines from the bottom. (NOTE: The space after the trailing apostrophe and before the double quote is a work-around for a zowe parsing issue.):

    +
      +
    • zowe ejes log stream --find "'yourLogonId - log' " --time
    • +
    +
  • +
  • +

    Find your unix home directory in the log. Note that if find string is case sensitive, you need to enclose it in single-quotes prefixed with the letter c, e.g., c'String':

    +
      +
    • zowe ejes log stream --find "c'DSN=/u/userName' last"
    • +
    +
  • +
  • +

    Find beginning of speed boost with highlighting:

    +
      +
    • zowe ejes log stream --find "'speed boost is active' first" --hilite
    • +
    +
  • +
  • +

    Find beginning of speed boost but mark found lines without ANSI color escape sequences. The --ht option is an alias for --hilite and --nc is an alias for --no-color:

    +
      +
    • zowe ejes log stream --find "'speed boost is active' first" --ht --nc on
    • +
    +
  • +
  • +

    Find all speed boost messages with highlighting and only output found lines:

    +
      +
    • zowe ejes log stream --find "'speed boost is active' first" --ht --only -n all
    • +
    +
  • +
  • +

    Find all speed boost messages with highlighting and output five lines of context (the default):

    +
      +
    • zowe ejes log stream --find "'speed boost is active' first" --ht --only --context -n all
    • +
    +
  • +
  • +

    Filter for IPL and boost informational messages that appear in the IEA681I message. The message can include generic characters to specify classes or subclasses of messages. The entire multiline message is output if the message is multiline. Other OPERLOG filtering options can be found under Message Filters Options:

    +
      +
    • zowe ejes log stream --msgId "IEA681I"
    • +
    +
  • +
  • +

    Filter for all informational IEA messages. The % character is a placeholder that matches any character. The entire multiline message is output if the message is multiline. Other OPERLOG filtering options can be found under Message Filters Options:

    +
      +
    • zowe ejes log stream --msgId "IEA%%%I"
    • +
    +
  • +
  • +

    Filter for "boost" in the text of any message. Note the use of the generic character * that matches any number of characters before or after the string. These are necessary for this type of search. The entire multiline message is output if the message is multiline. Other OPERLOG filtering options can be found under Message Filters Options:

    +
      +
    • zowe ejes log stream --msgTxt "*boost*"
    • +
    +
  • +
  • +

    Filter using descriptor codes for audible alarm errors and warning messages with MCS console color emulation on. The program will beep.The option --dc is an alias for --descriptorCodes. OPERLOG filtering options can be found under Message Filt ers Options:

    +
      +
    • zowe ejes log stream --descriptorCodes "1,2,11" --mcs
    • +
    +
  • +
  • +

    Find all system messages that required action for the hour after midnight. Specifying --only shows just found lines. Specifying --lines with "1h" tells the program to output lines up to one hour from the first line output. The --top option here specifies a time without a date, which means the current day. This logically sets the top of the log, windowing it, to midnight today (with no lines above it). Specifying --find with the first verb tells to search from the top. The character in the find string has a special meaning indicating that a message requires action. The special characters "|", "-", "@", " * ", and "+" can be indexed from column 54 and " * " is a column 4 character, thus 58 below.

    +

    https://www\.ibm\.com/docs/en/zos/2\.4\.0?topic=consoles\-special\-screen\-characters:

    +
      +
    • zowe ejes log stream --find "'*' first 58 58" --only --top "00:00" --lines 1h
    • +
    +
  • +
  • +

    Same result as previous example but with different options and colorized to emulate an MCS color console. Specifying --time without an argument positions at the beginning of the current day. The difference from above is that --top sets the first line of the log the program sees and positions at the bottom. The --time option positions before --find runs. No directional argument is specified on the --find option so it runs starting as positioned by the --time option.:

    +
      +
    • zowe ejes log stream --find "'*' 58 58" --only --time --lines 1h --mcs
    • +
    +
  • +
  • +

    Stream the tail of the log until you press CTRL+C. The -f option is an alias for --follow:

    +
      +
    • zowe ejes log stream --follow
    • +
    +
  • +
+

zoweejesquery

+

Query the host using (E)JES. Return host spool, dataset, and library tables. Return browsable data as reports. Query commands specify which primary table to query. Each primary table may also have child tables or child reports you can query using the --table and/or --report options. You can access only those primary tables you are authorized to use. Issue these commands as an introduction: (1) "zowe ejes query list" to show available tables.(2) "zowe ejes query status --owner help" to demonstrate how to find how it all works. (3) "zowe ejes query status --owner list" to demonstrate how to find appropriate arguments. (4) "zowe ejes query status --owner myuserid --sort time d" to view a sorted table of your jobs.(5) "zowe ejes query status --owner myuserid --sort time d --report " to view the first job in report form (truncated to your screen).

+

zoweejesqueryactivity

+

Select a table of all the jobs in all active address spaces for the JESplex or sysplex.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query activity [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • AC. List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query activity --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query activity --metafilter help`
+
+

zoweejesqueryapfds

+

Select a table of APF-authorized libraries defined to the systems in your sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query apfds [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query apfds --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query apfds --metafilter help`
+
+

zoweejesqueryclass

+

Select table of job classes defined for the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query class [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query class --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query class --metafilter help`
+
+

zoweejesquerydjc

+

Select a table of Dependent Job Control networks in the JESplex.

+

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query djc [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query djc --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query djc --metafilter help`
+
+

zoweejesquerydynexit

+

Select a table of MVS dynamic exits defined within the current sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query dynexit [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query dynexit --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query dynexit --metafilter help`
+
+

zoweejesqueryenclave

+

Select a table of WLM enclaves defined within the JESplex.

+

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query enclave [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query enclave --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query enclave --metafilter help`
+
+

zoweejesqueryenq

+

Select a table of information about ENQs and RESERVEs in the sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query enq [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query enq --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query enq --metafilter help`
+
+

zoweejesqueryenqc

+

Select a table of information about ENQ contention in the sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query enqc [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query enqc --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query enqc --metafilter help`
+
+

zoweejesqueryenqd

+

Select a table of information about ENQ SYSDSN resources in the sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query enqd [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query enqd --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query enqd --metafilter help`
+
+

zoweejesqueryfss

+

Select a table of Functional Subsystems defined for the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query fss [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query fss --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query fss --metafilter help`
+
+

zoweejesquerygroup

+

Select a table of Generalized Main Scheduler parameters for job class groups in the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query group [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query group --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query group --metafilter help`
+
+

zoweejesqueryhcheck

+

Select a table of the about checks registered with IBM Health Checker for z/OS.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query hcheck [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesqueryhold

+

Select a table of the sysout in the Hold queue.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query hold [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query hold --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query hold --metafilter help`
+
+

zoweejesqueryinit

+

Select a table of JES2-managed batch initiators defined for the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query init [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query init --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query init --metafilter help`
+
+

zoweejesqueryinput

+

Select a table of all jobs in the JESplex that are in pre-execution and execution status.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query input [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query input --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query input --metafilter help`
+
+

zoweejesqueryjesplex

+

Select a table of JES images in your z/OS JESplex.

+

A JES2 JESplex is also known as a Multi-Access SPOOL configuration or MAS. A JES3 JESplex is also known as a JES3 complex. Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query jesplex [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query jesplex --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query jesplex --metafilter help`
+
+

zoweejesqueryjgroup

+

Select a table of the active job groups in the JESplex.

+

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query jgroup [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query jgroup --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query jgroup --metafilter help`
+
+

zoweejesqueryline

+

Select a table of the lines that connect NJE nodes to your JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query line [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query line --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query line --metafilter help`
+
+

zoweejesquerylist

+

Display a list of all the primary display tables you are authorized to query on the host.

+

Usage

+

zowe ejes query list [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

zoweejesquerylnklst

+

Select a table of data sets in the link list concatenation of the link list libraries defined to the systems in your sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query lnklst [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query lnklst --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query lnklst --metafilter help`
+
+

zoweejesquerylpalst

+

Select a table of data sets in the LPA concatenation of the link pack libraries defined to the systems in your sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query lpalst [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query lpalst --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query lpalst --metafilter help`
+
+

zoweejesquerymds

+

Select a table of jobs in the JESplex that are currently delayed in one of the Main Device Scheduler queues.

+

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query mds [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query mds --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query mds --metafilter help`
+
+

zoweejesquerymemusage

+

Select a table of real and virtual memory requirements of jobs and other tasks running within your sysplex.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query memusage [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query memusage --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query memusage --metafilter help`
+
+

zoweejesquerymounts

+

Select a table of mounted file systems within the sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query mounts [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query mounts --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query mounts --metafilter help`
+
+

zoweejesquerynetconn

+

Select a table of NJE (Network Job Entry) connections.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query netconn [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query netconn --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query netconn --metafilter help`
+
+

zoweejesquerynetserv

+

Select a table of NJE network servers.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query netserv [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query netserv --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query netserv --metafilter help`
+
+

zoweejesquerynje

+

Select a table of sysout in the Bulk Data Transfer and TCP/IP NJE queues.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query nje [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query nje --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query nje --metafilter help`
+
+

zoweejesquerynode

+

Select a table of the NJE nodes defined to the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query node [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query node --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query node --metafilter help`
+
+

zoweejesqueryoffload

+

Select a table of the JES2 spool offload devices in your JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query offload [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query offload --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query offload --metafilter help`
+
+

zoweejesquerypageds

+

Select a table of paging resources defined to the systems in your sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query pageds [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query pageds --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query pageds --metafilter help`
+
+

zoweejesqueryparmlib

+

Select a table of information about system parameter libraries defined to the systems in your sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query parmlib [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query parmlib --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query parmlib --metafilter help`
+
+

zoweejesqueryprinter

+

Select a table of JES writers which drive local, FSS, and signed-on/logged-on remote printer and punch devices attached to the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query printer [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query printer --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query printer --metafilter help`
+
+

zoweejesqueryproclib

+

Select a table of information about your JES proclib concatenations.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query proclib [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query proclib --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query proclib --metafilter help`
+
+

zoweejesquerypstatus

+

Select a table of z/OS UNIX processes running in the JESplex.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query pstatus [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query pstatus --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query pstatus --metafilter help`
+
+

zoweejesqueryresmon

+

Select a table of JES resources for the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query resmon [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query resmon --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query resmon --metafilter help`
+
+

zoweejesqueryresource

+

Select a table of the WLM Resources defined for the current sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query resource [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query resource --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query resource --metafilter help`
+
+

zoweejesqueryschenv

+

Select a table of the WLM Scheduling Environments defined for the current sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query schenv [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query schenv --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query schenv --metafilter help`
+
+

zoweejesquerysession

+

Select a table of all active (E)JES sessions.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query session [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query session --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query session --metafilter help`
+
+

zoweejesqueryspart

+

Select a table of the SPOOL partition configuration of your JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query spart [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query spart --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query spart --metafilter help`
+
+

zoweejesqueryspvol

+

Select a table of the SPOOL volume extent configuration of your JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query spvol [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query spvol --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query spvol --metafilter help`
+
+

zoweejesquerystatus

+

Select a table of all jobs in the JESplex.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query status [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query status --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query status --metafilter help`
+
+

zoweejesquerysubsys

+

Select a table of all the MVS subsystems defined to the systems in your sysplex.

+

Use Primary Selection options to modify which rows are included in a table (for example, --sysnames sys* includes only systems starting with "sys"). Use General Use options to narrow your selected rows further. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query subsys [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the selection columns available for this table.
  • +
+

The "list" argument may be used on any option. A descriptive table for that option will be displayed and any other work will stop. The table may display available columns or positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query subsys --select list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query subsys --metafilter help`
+
+

zoweejesquerysymbol

+

Select a table of z/OS system symbols as well as JES and JCL symbols defined for the current address space.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query symbol [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query symbol --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query symbol --metafilter help`
+
+

zoweejesquerysyscls

+

Select a table of the sysout class configuration for your JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query syscls [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query syscls --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query syscls --metafilter help`
+
+

zoweejesquerysysplex

+

Select a table of the connected system images in your z/OS sysplex. In a monoplex, you manage the current system only (i.e., the image on which your (E)JES session is executing).

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query sysplex [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query sysplex --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query sysplex --metafilter help`
+
+

zoweejesquerysysreq

+

Select a table of outstanding replies and messages retained by the MVS Action Message Retention Facility (AMRF). Outstanding replies and action messages for the entire sysplex are shown.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query sysreq [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other wor`k will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query sysreq --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query sysreq --metafilter help`
+
+

zoweejesquerywriter

+

Select a table of sysout in the Output queue (JES2) or Writer queue (JES3). The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query writer [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query writer --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query writer --metafilter help`
+
+

zoweejesqueryzero

+

Select a table of sysout data sets created by JES3 internal facilities.

+

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query zero [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query zero --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query zero --metafilter help`
+
+
+

zoweendevor

+

Endevor plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.

+

zoweendevoradd

+

Add an Element into Endevor.

+

zoweendevoraddelement

+

The add element command lets you add an Element to an Environment entry Stage in Endevor.

+

Usage

+

zowe endevor add element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-file | --ff (string)

    +
      +
    • Use this input to provide source file.
    • +
    +
  • +
  • +

    --from-dataset | --fd (string)

    +
      +
    • Use this input to provide source data set name.
    • +
    +
  • +
  • +

    --from-member | --fm (string)

    +
      +
    • Use this input to provide source member name in the data set.
    • +
    +
  • +
  • +

    --from-path | --fp (string)

    +
      +
    • Use this input to provide the path of source USS file. It must be used with from-uss-file.
    • +
    +
  • +
  • +

    --from-uss-file | --fuf (string)

    +
      +
    • Use this input to provide source USS file name. It must be used with from-path
    • +
    +
  • +
+

options

+
    +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --new-version | --nv (number)

    +
      +
    • Assign a different version number to the Element.
    • +
    +
  • +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --generate | -g (boolean)

    +
      +
    • Specifies if you want to Generate Element after Add/Update action.
    • +
    +
  • +
  • +

    --get-fingerprint | --gfg (boolean)

    +
      +
    • +

      Return fingerprint of a retrieved, added or updated element as the first line of the response.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --fingerprint | --fg (string)

    +
      +
    • Specifies the fingerprint of the element to Add or Update. Use value 'NEW' when adding a new element that shouldn't exist in the map yet.
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Add element from local file with endevor profile set up:

    +
      +
    • zowe endevor add element elementName --env ENV --sys SYS --sub SUB --typ TYPE --ff localfile.txt -i ENDEVOR --ccid CCID --comment 'adding element'
    • +
    +
  • +
+

zoweendevorapprove

+

Approve a Package in Endevor.

+

zoweendevorapprovepackage

+

The approve package command approves Package in Endevor for execution.

+

Usage

+

zowe endevor approve package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --notes | -n (string)

    +
      +
    • Notes for package.
    • +
    +
  • +
  • +

    --notes-from-file | --nff (string)

    +
      +
    • Local file of notes for package.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Approve package with endevor profile set up, specifying approval notes:

    +
      +
    • zowe endevor approve package packageName -n "notes" -i ENDEVOR
    • +
    +
  • +
+

zoweendevorbackin

+

Backin a Package in Endevor.

+

zoweendevorbackinpackage

+

The backin package command reverses the backout action and returns the Package to a status of Executed.

+

Usage

+

zowe endevor backin package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --statement | --stmn (number)

    +
      +
    • Specify the SCL statement number for the Element action that you want to back in or back out.
    • +
    +
  • +
  • +

    --element | --elm (string)

    +
      +
    • Specify the Element name for the Element action that you want to back in or back out.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Backin package with endevor profile set up:

    +
      +
    • zowe endevor backin package packageName -i ENDEVOR
    • +
    +
  • +
+

zoweendevorbackout

+

Backout a Package in Endevor.

+

zoweendevorbackoutpackage

+

The backout package command restores the executable and output modules of the Package to the status they were in before execution.

+

Usage

+

zowe endevor backout package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --statement | --stmn (number)

    +
      +
    • Specify the SCL statement number for the Element action that you want to back in or back out.
    • +
    +
  • +
  • +

    --element | --elm (string)

    +
      +
    • Specify the Element name for the Element action that you want to back in or back out.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Backout package with endevor profile set up:

    +
      +
    • zowe endevor backout package packageName -i ENDEVOR
    • +
    +
  • +
+

zoweendevorcast

+

Cast a Package in Endevor.

+

zoweendevorcastpackage

+

The cast package command prepares the Package for review and subsequent execution. Casting a Package freezes the contents of the Package and prevents further changes to the Package.

+

Usage

+

zowe endevor cast package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --from-date-time | --fdt (string)

    +
      +
    • Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --to-date-time | --tdt (string)

    +
      +
    • Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --validate-components | --vc (string)

    +
      +
    • +

      Specify "yes" to enable component validation within the package, "no" to disable, and "warn" to generate a warning if component validation fails.

      +

      Allowed values: yes, no, warn

      +
    • +
    +
  • +
  • +

    --backout (boolean)

    +
      +
    • +

      Set this option to false (or specify --no-backout) if you don't want to have the backout facility available for this package. By default backout is enabled.

      +

      Default value: true

      +
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Cast package with endevor profile set up, changing the execution window of the Package:

    +
      +
    • zowe endevor cast package packageName --fdt 2018-01-01T00:00 --tdt 2018-12-31T12:00 -i ENDEVOR
    • +
    +
  • +
+

zoweendevorcheck

+

Endevor Web Services Health Check.

+

zoweendevorcheckinstance

+

The check instance command triggers the web services health check for a given instance.

+

Usage

+

zowe endevor check instance [instance] [options]

+

Positional Arguments

+
    +
  • +

    instance (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Perform health check of Endevor Web Services instance ENDEVOR:

    +
      +
    • zowe endevor check instance ENDEVOR
    • +
    +
  • +
+

zoweendevorcommit

+

Commit a Package in Endevor.

+

zoweendevorcommitpackage

+

The commit package command commits a Package, which removes all backout/backin data while retaining Package event information.

+

Usage

+

zowe endevor commit package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --older-than | --ot (number)

    +
      +
    • Specify the minimum age of the package.
    • +
    +
  • +
  • +

    --delete-promotion-history | --dph (boolean)

    +
      +
    • Specifies whether you want to delete all promotion history associated with previous versions of the Package
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Commit package with endevor profile set up, specifying deletion of all promotion history:

    +
      +
    • zowe endevor commit package packageName --delete-promotion-history -i ENDEVOR
    • +
    +
  • +
+

zoweendevorconfirm

+

Confirm a manual conflict resolution inside an Endevor workspace file is complete.

+

zoweendevorconfirmresolution

+

Confirm a manual conflict resolution inside an Endevor workspace file is complete.

+

Usage

+

zowe endevor confirm resolution [workspace-file] [options]

+

Positional Arguments

+
    +
  • +

    workspace-file (string)

    +
      +
    • An Endevor workspace file (full or relative path).
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Confirm a manual conflict resolution has been finished for file 'filename':

    +
      +
    • zowe endevor confirm resolution filename
    • +
    +
  • +
+

zoweendevorcreate

+

Create a Package in Endevor.

+

zoweendevorcreatepackage

+

The create package command lets you create a package in Endevor.

+

Usage

+

zowe endevor create package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-file | --ff (string)

    +
      +
    • Use this input to provide source file.
    • +
    +
  • +
  • +

    --from-dataset | --fd (string)

    +
      +
    • Use this input to provide source data set name.
    • +
    +
  • +
  • +

    --from-member | --fm (string)

    +
      +
    • Use this input to provide source member name in the data set.
    • +
    +
  • +
  • +

    --from-package | --fp (string)

    +
      +
    • Directs the Create/Update action to copy the SCL from the package you specify into the package you are creating or updating.
    • +
    +
  • +
  • +

    --from-text | --ft (string)

    +
      +
    • Provides a string to use as input SCL.
    • +
    +
  • +
+

options

+
    +
  • +

    --description | -d (string)

    +
      +
    • Allows you to associate a 50-character description when creating or updating package.
    • +
    +
  • +
  • +

    --from-date-time | --fdt (string)

    +
      +
    • Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --to-date-time | --tdt (string)

    +
      +
    • Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --backout (boolean)

    +
      +
    • +

      Set this option to false (or specify --no-backout) if you don't want to have the backout facility available for this package. By default backout is enabled.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --notes | -n (string)

    +
      +
    • Notes for package.
    • +
    +
  • +
  • +

    --notes-from-file | --nff (string)

    +
      +
    • Local file of notes for package.
    • +
    +
  • +
  • +

    --emergency-package | --ep (boolean)

    +
      +
    • Specify if the package should be an emergency package. When not specified, the package is a standard package.
    • +
    +
  • +
  • +

    --sharable | --sh (boolean)

    +
      +
    • Specify this option if the package can be edited by more than one person when in In-edit status.
    • +
    +
  • +
  • +

    --promotion | --pr (boolean)

    +
      +
    • Specify this option to define the package as a promotion package.
    • +
    +
  • +
  • +

    --validate-scl | --vs (boolean)

    +
      +
    • +

      Set this option to false (or specify --no-validate-scl) to skip validion of the package components while creating a package. By default the SCL is validated

      +

      Default value: true

      +
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create package from local file with endevor profile set up:

    +
      +
    • zowe endevor create package packageName -d "package description" --ff localfile.txt -i ENDEVOR
    • +
    +
  • +
+

zoweendevordelete

+

Delete an Element or a Package in Endevor.

+

zoweendevordeleteelement

+

The delete element command deletes an Element from the specified inventory location in Endevor.

+

Usage

+

zowe endevor delete element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --only-components | --oc (boolean)

    +
      +
    • Applicable for Endevor ACM users only. Indicates whether you want to delete both the Element component list and the Element, or the Element component list only. "No" is the default option
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete element with endevor profile set up:

    +
      +
    • zowe endevor delete element elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR
    • +
    +
  • +
+

zoweendevordeletepackage

+

The delete package command lets you delete Packages of any status type in Endevor.

+

Usage

+

zowe endevor delete package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --status | --st (string)

    +
      +
    • +

      Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
      +It is possible to specify multiple status separated by "," during list and delete package.

      +

      Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED

      +
    • +
    +
  • +
  • +

    --older-than | --ot (number)

    +
      +
    • Specify the minimum age of the package.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete package with endevor profile set up:

    +
      +
    • zowe endevor delete package packageName -i ENDEVOR
    • +
    +
  • +
+

zoweendevordeny

+

Deny a Package in Endevor.

+

zoweendevordenypackage

+

The deny package command changes the status of a Package to Denied.

+

Usage

+

zowe endevor deny package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --notes | -n (string)

    +
      +
    • Notes for package.
    • +
    +
  • +
  • +

    --notes-from-file | --nff (string)

    +
      +
    • Local file of notes for package.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deny package with endevor profile set up, specifying denial notes:

    +
      +
    • zowe endevor deny package packageName -n "notes" -i ENDEVOR
    • +
    +
  • +
+

zoweendevorexecute

+

Execute a Package in Endevor.

+

zoweendevorexecutepackage

+

The execute package command executes a Package that have a status of Approved or Execfailed.

+

Usage

+

zowe endevor execute package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --from-date-time | --fdt (string)

    +
      +
    • Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --to-date-time | --tdt (string)

    +
      +
    • Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --status | --st (string)

    +
      +
    • +

      Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
      +It is possible to specify multiple status separated by "," during list and delete package.

      +

      Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED

      +
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Execute package with endevor profile set up, specifying the time frame within which to execute the Package:

    +
      +
    • zowe endevor execute package packageName --fdt 2018-01-01T00:00 --tdt 2018-12-31T12:00 -i ENDEVOR
    • +
    +
  • +
+

zoweendevorgenerate

+

Generate an Element in Endevor.

+

zoweendevorgenerateelement

+

The generate element command executes the generate Processor for the current level of the Element.

+

Usage

+

zowe endevor generate element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --copy-back | --cb (boolean)

    +
      +
    • Specify if you want to copy the current level of the Element back to the FROM Stage, then perform this action. Do not use with --nosource option.
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --nosource | --ns (boolean)

    +
      +
    • Specify if you want to have source-less Element. Do not use with --copy-back option.
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Generate an element with endevor profile set up, specifying option Copyback:

    +
      +
    • zowe endevor generate element elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE --cb -i ENDEVOR
    • +
    +
  • +
+

zoweendevorinitialize

+

Initialize a directory as an Endevor workspace.

+

zoweendevorinitializeworkspace

+

Initialize current directory as an Endevor workspace.

+

Usage

+

zowe endevor initialize workspace [workspace-dir] [options]

+

Positional Arguments

+
    +
  • +

    workspace-dir (string)

    +
      +
    • The Endevor workspace directory, if different from current working directory.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    initialize current directory as an Endevor workspace:

    +
      +
    • zowe endevor initialize workspace
    • +
    +
  • +
  • +

    initialize 'myWorkspace' directory as an Endevor workspace:

    +
      +
    • zowe endevor initialize workspace 'myWorkspace'
    • +
    +
  • +
+

zoweendevorlist

+

List instances, elements, types, packages and inventory locations in Endevor.

+

zoweendevorlistcode-page-config

+

The list code-page-config command lists the EBCDIC code page mapping rules used by Endevor Web Services

+

Usage

+

zowe endevor list code-page-config [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List codepage-config with session specified:

    +
      +
    • zowe endevor list code-page-config --host hostName --port 8080
    • +
    +
  • +
+

zoweendevorlistdefaults

+

List the contents of the main Endevor configuration table (C1DEFLTS)

+

Usage

+

zowe endevor list defaults [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the contents of the main Endevor configuration table (C1DEFLTS):

    +
      +
    • zowe endevor list defaults
    • +
    +
  • +
+

zoweendevorlistdialog

+

List the contents of the Endevor ISPF dialog defaults table (ENDIECFG)

+

Usage

+

zowe endevor list dialog [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the contents of the Endevor ISPF dialog defaults table (ENDIECFG):

    +
      +
    • zowe endevor list dialog
    • +
    +
  • +
+

zoweendevorlistelements

+

The list elements command lists element information in Endevor

+

Usage

+

zowe endevor list elements [element] [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --data | --dat (string)

    +
      +
    • +

      Allows to select the type of summary data returned in the element list:
      +ALL - Full element information
      +BAS - Basic element information
      +ELE - Element change level summary
      +COMP - Component change level summary

      +

      When data=ALL --fo (full-output) always takes place unless there is a --rff (response-format-filter).
      +In all other cases default set of columns will be shown.

      +

      Allowed values: all, bas, ele, comp

      +
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-generate | --wcg (string)

    +
      +
    • Instructs Endevor to search using the generate CCID associated with an Element.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-lastact | --wcla (string)

    +
      +
    • Instructs Endevor to search using the last action CCID associated with an Element.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-lastlvl | --wcll (string)

    +
      +
    • Instructs Endevor to search using the last level CCID associated with an Element.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-change | --wcchg (string)

    +
      +
    • This option is only valid when the data option is ele or comp. Instructs Endevor to filter the results of the list data summary function that is based on the specified ccids.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-type | --wpt (string)

    +
      +
    • +

      Lets you select Elements according to a specified Processor type.

      +

      Allowed values: GEN, GENERATE, MOV, MOVE, DEL, DELETE

      +
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
+

endevor search text options

+
    +
  • +

    --search-text | --stext (string)

    +
      +
    • Search string(s) separated with AND or OR. E.g.: string_1 AND string_2 AND string_3 OR string_4.
      +For complex search strings with quotation marks use search-text-file parameter.
    • +
    +
  • +
  • +

    --search-text-file | --stf (string)

    +
      +
    • File which contains search string(s) separated with AND or OR. Recommended for complex search strings with quotation marks.
    • +
    +
  • +
  • +

    --search-in | --si (string)

    +
      +
    • +

      2 letters describing where search should be performed:
      +es - Element Source
      +eh - Element History
      +ec - Element Changes
      +eu - Element Summary
      +cs - Components Source
      +ch - Components History
      +cc - Components Changes
      +cu - Components Summary.

      +

      Allowed values: es, eh, ec, eu, cs, ch, cc, cu

      +
    • +
    +
  • +
  • +

    --search-from | --sf (number)

    +
      +
    • Beginning interval of the column range for the search-text.
    • +
    +
  • +
  • +

    --search-to | --st (number)

    +
      +
    • Ending interval of the column range for the search-text.
    • +
    +
  • +
  • +

    --search-ignore-case | --ic (boolean)

    +
      +
    • Ignore search case.
    • +
    +
  • +
  • +

    --search-in-binary | --bin (boolean)

    +
      +
    • Should the text search be performed in binary elements.
    • +
    +
  • +
  • +

    --search-limit | --sl (number)

    +
      +
    • Maximum search limit where 0 is NOLIMIT.
    • +
    +
  • +
+

scl generation options

+
    +
  • +

    --to-package | --tp (string)

    +
      +
    • Specifies the package to which the SCL has to be appended. This option requires scl-action
    • +
    +
  • +
  • +

    --scl-action | --sa (string)

    +
      +
    • +

      Specifies the action for the SCL that has to be built.

      +

      Allowed values: GENERATE, MOVE

      +
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List elements in Endevor from the specified inventory location with the endevor profile set up:

    +
      +
    • zowe endevor list elements -i ENDEVOR --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ TYPENAME
    • +
    +
  • +
  • +

    List elements in Endevor using search text string:

    +
      +
    • zowe endevor list elements --stext "first or second and third"
    • +
    +
  • +
+

zoweendevorlistenvironments

+

The list environments command lists environments in Endevor

+

Usage

+

zowe endevor list environments [environment] [options]

+

Positional Arguments

+
    +
  • +

    environment (string)

    +
      +
    • Name of the Endevor environment.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all environments in Endevor with endevor profile set up:

    +
      +
    • zowe endevor list environments -i ENDEVOR
    • +
    +
  • +
+

zoweendevorlistfeatures

+

List the contents of the Endevor optional features table (ENCOPTBL)

+

Usage

+

zowe endevor list features [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the contents of the Endevor optional features table (ENCOPTBL):

    +
      +
    • zowe endevor list features
    • +
    +
  • +
+

zoweendevorlistinstances

+

The list instances command lists instances used by Endevor Web Services

+

Usage

+

zowe endevor list instances [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List instances with session specified:

    +
      +
    • zowe endevor list instances --host hostName --port 8080
    • +
    +
  • +
+

zoweendevorlistpackages

+

The list packages command lists package information in Endevor

+

Usage

+

zowe endevor list packages [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --status | --st (string)

    +
      +
    • +

      Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
      +It is possible to specify multiple status separated by "," during list and delete package.

      +

      Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED

      +
    • +
    +
  • +
  • +

    --emergency-package | --ep (boolean)

    +
      +
    • Specify if the package should be an emergency package. When not specified, the package is a standard package.
    • +
    +
  • +
  • +

    --enterprise | --ent (string)

    +
      +
    • +

      Specify to filter the list by enterprise Package parameter. A - All, E - Enterprise, X - eXclude.

      +

      Allowed values: A, E, X

      +
    • +
    +
  • +
  • +

    --promotion-status | --ps (string)

    +
      +
    • +

      Specify to filter the list by promotion Package parameter. A - All, P - Promotion, X - eXclude.

      +

      Allowed values: A, P, X

      +
    • +
    +
  • +
  • +

    --prom-target-env | --pte (string)

    +
      +
    • Promotion target environment. Specifies the promotion package target environment. This field only applies to promotion packages and can only be specified when the promotion package type is A or P.
    • +
    +
  • +
  • +

    --prom-target-stgID | --pts (string)

    +
      +
    • Promotion target stage ID. Specifies the promotion package target stage ID. This field only applies to promotion packages and can only be specified when the promotion package type is A or P.
    • +
    +
  • +
  • +

    --approver | --apr (string)

    +
      +
    • Specifies a one to eight character approver ID. Only one approver ID can be specified and name masking is not supported.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all packages in Endevor with endevor profile set up:

    +
      +
    • zowe endevor list packages -i ENDEVOR
    • +
    +
  • +
+

zoweendevorlistprocessor-groups

+

The list processor-groups command lists processor group information in Endevor

+

Usage

+

zowe endevor list processor-groups [proc-group] [options]

+

Positional Arguments

+
    +
  • +

    proc-group (string)

    +
      +
    • Name of the Endevor processor group
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List processor groups for type TYPENAME with endevor profile set up:

    +
      +
    • zowe endevor list processor-groups --type TYPENAME --env ENVNAME --sn 1 --sys SYSNAME -i ENDEVOR
    • +
    +
  • +
+

zoweendevorlistprocessor-symbols

+

The list processor-symbols command lists processor group symbol overrides information in Endevor

+

Usage

+

zowe endevor list processor-symbols [proc-group] [options]

+

Positional Arguments

+
    +
  • +

    proc-group (string)

    +
      +
    • Name of the Endevor processor group
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all processor symbols for group PROCGROUP with endevor profile set up:

    +
      +
    • zowe endevor list processor-symbols PROCGROUP --env ENVNAME --sn 1 --sys SYSNAME --typ TYPENAME -i ENDEVOR
    • +
    +
  • +
+

zoweendevorliststages

+

The list stages command lists stages in Endevor

+

Usage

+

zowe endevor list stages [stage] [options]

+

Positional Arguments

+
    +
  • +

    stage (string)

    +
      +
    • Name of the Endevor stage
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all stages in Endevor with endevor profile set up:

    +
      +
    • zowe endevor list stages -i ENDEVOR
    • +
    +
  • +
+

zoweendevorlistsubsystems

+

The list subsystems command lists subsystem information in Endevor

+

Usage

+

zowe endevor list subsystems [subsystem] [options]

+

Positional Arguments

+
    +
  • +

    subsystem (string)

    +
      +
    • Name of the Endevor subsystem
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all subsystems in Endevor with endevor profile set up:

    +
      +
    • zowe endevor list subsystems -i ENDEVOR
    • +
    +
  • +
+

zoweendevorlistsymbols

+

List the Endevor site symbols

+

Usage

+

zowe endevor list symbols [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the Endevor site symbols:

    +
      +
    • zowe endevor list symbols
    • +
    +
  • +
+

zoweendevorlistsystems

+

The list systems command lists system information in Endevor

+

Usage

+

zowe endevor list systems [system] [options]

+

Positional Arguments

+
    +
  • +

    system (string)

    +
      +
    • Name of the Endevor system
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all systems in Endevor with endevor profile set up:

    +
      +
    • zowe endevor list systems -i ENDEVOR
    • +
    +
  • +
+

zoweendevorlisttasks

+

List asynchronous tasks submitted by this user

+

Usage

+

zowe endevor list tasks [task-id] [options]

+

Positional Arguments

+
    +
  • +

    task-id (string)

    +
      +
    • The id of an asynchronous Endevor web service task.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --task-status (string)

    +
      +
    • +

      Filter tasks by status: in-progress, finished or all.

      +

      Default value: all
      +Allowed values: inp, fin, all

      +
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all finished tasks:

    +
      +
    • zowe endevor list tasks --task-status fin
    • +
    +
  • +
  • +

    List a specific task to verify its completion status:

    +
      +
    • zowe endevor list tasks 2789102296850204364
    • +
    +
  • +
+

zoweendevorlisttype-sequence

+

List the contents of the Endevor type sequence

+

Usage

+

zowe endevor list type-sequence [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the contents of the Endevor type sequence:

    +
      +
    • zowe endevor list type-sequence
    • +
    +
  • +
+

zoweendevorlisttypes

+

The list types command lists type information in Endevor

+

Usage

+

zowe endevor list types [type] [options]

+

Positional Arguments

+
    +
  • +

    type (string)

    +
      +
    • Name of the Endevor type
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all types in Endevor with endevor profile set up:

    +
      +
    • zowe endevor list types -i ENDEVOR
    • +
    +
  • +
+

zoweendevormerge

+

Merge Endevor elements from one Endevor location into another

+

zoweendevormergeelement

+

Merge Endevor elements from one Endevor location into another. Requires an initialized Endevor workspace to perform conflict resolution. Use "synchronize workspace" command afterwards to push the result back into Endevor.

+

Usage

+

zowe endevor merge element [element] [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

merge-location definition options

+
    +
  • +

    --merge-environment | --menv (string)

    +
      +
    • Merge elements from this environment to the target environment (specified by 'environment'). Defaults to the same environment as the target.
    • +
    +
  • +
  • +

    --merge-stage-number | --msn (string)

    +
      +
    • Merge elements from this stage number into the target stage number (specified by 'stage-number'). Defaults to the same stage number as the target.
    • +
    +
  • +
  • +

    --merge-system | --msys (string)

    +
      +
    • Merge elements from this system into the target system (specified by 'system'). Defaults to the same system as the target.
    • +
    +
  • +
  • +

    --merge-subsystem | --msub (string)

    +
      +
    • Merge elements from this subsystem into the target subsystem (specified by 'subsystem'). Defaults to the same subsystem as the target.
    • +
    +
  • +
  • +

    --merge-out-of-sync | --moos (boolean)

    +
      +
    • Merge out-of-sync elements at the target location with their next version in the map, and attempt to resolve the out-of-sync during the next synchronization with Endevor.
    • +
    +
  • +
+

workspace options

+
    +
  • +

    --workspace-dir | --wsp (string)

    +
      +
    • +

      The Endevor workspace directory, if different from current working directory.

      +

      Default value: .

      +
    • +
    +
  • +
  • +

    --dry-run | --dr (boolean)

    +
      +
    • List all actions the synchronization would perform, without executing them.
    • +
    +
  • +
  • +

    --limit | --lim (number)

    +
      +
    • +

      If the synchronization would need to perform more than 'limit' Endevor actions, do not perform the actions now, only report them. 0 means no limit.

      +

      Default value: 0

      +
    • +
    +
  • +
+

options

+
    +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of any Endevor elements affected by this action.
    • +
    +
  • +
  • +

    --signout (boolean)

    +
      +
    • Specify if you want to perform the action with signing out any retrieved elements.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Merge element ELEMENT1 of type COBPGM from subsystem SUBFROM into the same element found in subsystem SUBTO (system, stage and env taken from current location profile):

    +
      +
    • zowe endevor merge element ELEMENT1 --type COBPGM --subsystem SUBTO --merge-subsystem SUBFROM
    • +
    +
  • +
  • +

    Merge any elements that are currently out of sync with their next element version up the map (map location determined by current profile):

    +
      +
    • zowe endevor merge element * --merge-out-of-sync
    • +
    +
  • +
  • +

    Report which elements are currently out of sync with their next element version up the map, but do not merge them yet (map location determined by current profile):

    +
      +
    • zowe endevor merge element * --merge-out-of-sync --dry-run
    • +
    +
  • +
  • +

    Merge all elements from system SYSFROM, subsystem SUBFROM into matching elements in system SYSTO subsystem SUBTO (system, stage and env taken from current location profile):

    +
      +
    • zowe endevor merge element * --system SYSTO --subsystem SUBTO --merge-system SYSFROM --merge-subsystem SUBFROM
    • +
    +
  • +
  • +

    Merge element ELEMENT1 of type COBPGM from subsystem SUBFROM into SUBTO, retrieving both elements using the provided ccid & comment, with signout, and overriding signout if necessary:

    +
      +
    • zowe endevor merge element ELEMENT1 --type COBPGM --subsystem SUBTO --merge-subsystem SUBFROM --ccid MYCCID --comment 'my comment' --signout --overrride-signout
    • +
    +
  • +
+

zoweendevormove

+

Move an Element in Endevor.

+

zoweendevormoveelement

+

The move element command moves Elements between inventory locations along a map.

+

Usage

+

zowe endevor move element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --sync | -s (boolean)

    +
      +
    • Specify if you want to synchronize source and current level of the Elements while performing this action.
    • +
    +
  • +
  • +

    --with-history | --wh (boolean)

    +
      +
    • Specify if you want to preserve the change history of the Elements while performing this action.
    • +
    +
  • +
  • +

    --bypass-element-delete | --bed (boolean)

    +
      +
    • Specify if you want to retain the Elements in the source Stage after successfully completing this action.
    • +
    +
  • +
  • +

    --retain-signout | --rs (boolean)

    +
      +
    • Specify if you want to retain the source location signouts for all Elements at the target location while performing this action.
    • +
    +
  • +
  • +

    --signout-to | --st (string)

    +
      +
    • Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.
    • +
    +
  • +
  • +

    --jump | -j (boolean)

    +
      +
    • Specify if you want to move Elements across Environments even if those Elements exist at an intermediate Stage that is not on the map, while performing this action.
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Move element from specified inventory location with endevor profile set up:

    +
      +
    • zowe endevor move element elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR
    • +
    +
  • +
+

zoweendevorprint

+

Print an Element or a Component in Endevor.

+

zoweendevorprintcomponents

+

The print component command prints selected component information about Element in Endevor.

+

Usage

+

zowe endevor print components <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --level | --lev (number)

    +
      +
    • Indicates the level number of the element (use along with the version option).
    • +
    +
  • +
  • +

    --element-version | --ev (number)

    +
      +
    • Indicates the version number of the element (use along with the level option).
    • +
    +
  • +
  • +

    --print-comp | --pc (string)

    +
      +
    • +

      Specify the type of data to print out for print component command

      +

      Default value: browse
      +Allowed values: browse, changes, history, summary

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --headings (boolean)

    +
      +
    • Specify it if you want to print a header on each page.
    • +
    +
  • +
  • +

    --explode | --exp | --ex (boolean)

    +
      +
    • Specify to print component info from ACMQ.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --to-file | --tf (string)

    +
      +
    • The file name in which the data from the command output is stored
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Print selected component information about Element with endevor profile set up:

    +
      +
    • zowe endevor print components elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR
    • +
    +
  • +
+

zoweendevorprintelement

+

The print element command prints selected information about Element in Endevor.

+

Usage

+

zowe endevor print element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --level | --lev (number)

    +
      +
    • Indicates the level number of the element (use along with the version option).
    • +
    +
  • +
  • +

    --element-version | --ev (number)

    +
      +
    • Indicates the version number of the element (use along with the level option).
    • +
    +
  • +
  • +

    --print (string)

    +
      +
    • +

      Specify the type of data to print out for print element command

      +

      Default value: browse
      +Allowed values: browse, changes, history, summary, master, listing

      +
    • +
    +
  • +
  • +

    --list-string | --ls (string)

    +
      +
    • Specifies the one to eight character text-string used to identify the listing data set to print.
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --headings (boolean)

    +
      +
    • Specify it if you want to print a header on each page.
    • +
    +
  • +
  • +

    --explode | --exp | --ex (boolean)

    +
      +
    • Specify to print component info from ACMQ.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --to-file | --tf (string)

    +
      +
    • The file name in which the data from the command output is stored
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Print element from specified inventory location with endevor profile set up:

    +
      +
    • zowe endevor print element elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR
    • +
    +
  • +
+

zoweendevorprintmember

+

The print member command prints a member from a specified dataset.

+

Usage

+

zowe endevor print member <member> [options]

+

Positional Arguments

+
    +
  • +

    member (string)

    +
      +
    • Name of the member.
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-dataset | --fd (string)

    +
      +
    • Use this input to provide source data set name.
    • +
    +
  • +
+

options

+
    +
  • +

    --headings (boolean)

    +
      +
    • Specify it if you want to print a header on each page.
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --to-file | --tf (string)

    +
      +
    • The file name in which the data from the command output is stored
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Print a member from specified dataset:

    +
      +
    • zowe endevor print member memName --fd DSNAME -i ENDEVOR
    • +
    +
  • +
+

zoweendevorqueryacm

+

Query Elements and information about their components in Endevor.

+

zoweendevorqueryacmcomponents

+

Query components used by a specified Element with the Endevor ACM Query facility.

+

Usage

+

zowe endevor queryacm components <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --excCirculars | --exc (boolean)

    +
      +
    • Filters the result to exclude components that have a circular relationship to the subject of your search.
    • +
    +
  • +
  • +

    --excIndirect | --exi (boolean)

    +
      +
    • Filters the result to exclude indirectly related components.
    • +
    +
  • +
  • +

    --excRelated | --exr (boolean)

    +
      +
    • Filters the result to exclude related components.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    query all the components used by element "elementName" from the specified inventory location with the endevor profile set up:

    +
      +
    • zowe endevor queryacm components elementName --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ TYPENAME -i ENDEVOR
    • +
    +
  • +
+

zoweendevorreset

+

Reset a Package in Endevor.

+

zoweendevorresetpackage

+

The reset package command lets you set the status of a Package back to In-edit so you can modify it.

+

Usage

+

zowe endevor reset package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Reset package with endevor profile set up:

    +
      +
    • zowe endevor reset package packageName -i ENDEVOR
    • +
    +
  • +
+

zoweendevorretrieve

+

Retrieve an Element in Endevor.

+

zoweendevorretrieveelement

+

The retrieve element command retrieves an existing element in Endevor.

+

Usage

+

zowe endevor retrieve element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --element-version | --ev (number)

    +
      +
    • Indicates the version number of the element (use along with the level option).
    • +
    +
  • +
  • +

    --level | --lev (number)

    +
      +
    • Indicates the level number of the element (use along with the version option).
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --signout (boolean)

    +
      +
    • Specify if you want to perform the action with signing the element out.
    • +
    +
  • +
  • +

    --replace-member | --replace | --rm (boolean)

    +
      +
    • Specify if you want to replace the member currently in the library with the new element contents
    • +
    +
  • +
  • +

    --expand-includes | --expand | --ei (boolean)

    +
      +
    • Indicates that INCLUDE statements should be expanded in the course of the action.
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --get-fingerprint | --gfg (boolean)

    +
      +
    • +

      Return fingerprint of a retrieved, added or updated element as the first line of the response.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
+

output location options

+
    +
  • +

    --to-path | --tp (string)

    +
      +
    • Provide a USS path to a destination location.
    • +
    +
  • +
  • +

    --to-uss-file | --tuf (string)

    +
      +
    • Provide a USS file as a destination file.
    • +
    +
  • +
  • +

    --to-dataset | --td (string)

    +
      +
    • Provide a destination data set name.
    • +
    +
  • +
  • +

    --to-member | --tm (string)

    +
      +
    • Provide a destination member name inside the data set.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --to-file | --tf (string)

    +
      +
    • The file name in which the data from the command output is stored
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

bulk action options

+
    +
  • +

    --to-dir | --tdir (string)

    +
      +
    • Directory name in which the command output will be stored.
    • +
    +
  • +
  • +

    --flat (boolean)

    +
      +
    • Store the output of the bulk action within one folder. When you use this option, ensure that the results do not contain duplicate names. (Duplicate names occur when two or more Elements have the same name and type.)
    • +
    +
  • +
  • +

    --with-dependencies | --wd (boolean)

    +
      +
    • Retrieve Elements, including their Endevor-managed input components.
    • +
    +
  • +
  • +

    --where-ccid-generate | --wcg (string)

    +
      +
    • Instructs Endevor to search using the generate CCID associated with an Element.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-lastact | --wcla (string)

    +
      +
    • Instructs Endevor to search using the last action CCID associated with an Element.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-lastlvl | --wcll (string)

    +
      +
    • Instructs Endevor to search using the last level CCID associated with an Element.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-change | --wcchg (string)

    +
      +
    • This option is only valid when the data option is ele or comp. Instructs Endevor to filter the results of the list data summary function that is based on the specified ccids.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --file-extension | --ext (string)

    +
      +
    • +

      The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:

      +
        none: File name is equal to element name, no extension is added\.
      +
      +  file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added\.
      +
      +  type\-name: The type name is used as the file extension\.
      +
      +  mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead\.
      +
      +

      Default value: mixed
      +Allowed values: none, file-ext, type-name, mixed

      +
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Retrieve element from specified inventory location to local file with endevor profile set up:

    +
      +
    • zowe endevor retrieve element elementName --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ TYPENAME --tf localfile.txt -i ENDEVOR
    • +
    +
  • +
  • +

    Bulk Retrieve elements with wildcarded element name and type, to local directory with endevor profile set up:

    +
      +
    • zowe endevor retrieve element "*" --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ "*" --to-dir /user/localdir -i ENDEVOR
    • +
    +
  • +
+

zoweendevorretrieveresult

+

Retrieve the result of an asynchronous task

+

Usage

+

zowe endevor retrieve result [task-id] [options]

+

Positional Arguments

+
    +
  • +

    task-id (string)

    +
      +
    • The id of an asynchronous Endevor web service task.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Retrieve the result of task 2789102296850204364:

    +
      +
    • zowe endevor retrieve result 2789102296850204364
    • +
    +
  • +
+

zoweendevorsignin

+

Signin an Element in Endevor.

+

zoweendevorsigninelement

+

The signin element command signs in an existing element in Endevor.

+

Usage

+

zowe endevor signin element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --signout-to | --st (string)

    +
      +
    • Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Signin element with endevor profile set up:

    +
      +
    • zowe endevor signin element elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR
    • +
    +
  • +
+

zoweendevorsubmit

+

Submit a Package or a SCL file in Endevor.

+

zoweendevorsubmitpackage

+

The submit package command submits a JCL job stream to execute one or more Packages.

+

Usage

+

zowe endevor submit package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-file | --ff (string)

    +
      +
    • Use this input to provide source file.
    • +
    +
  • +
  • +

    --from-dataset | --fd (string)

    +
      +
    • Use this input to provide source data set name.
    • +
    +
  • +
  • +

    --from-member | --fm (string)

    +
      +
    • Use this input to provide source member name in the data set.
    • +
    +
  • +
+

output location options

+
    +
  • +

    --to-CA7 | --t7 (boolean)

    +
      +
    • Specify to send the submission of the package to CA 7 scheduler.
    • +
    +
  • +
  • +

    --to-ddname | --tdd (string)

    +
      +
    • Send the submission of the package to be processed according to a DDName specified in the starter task (STC).
    • +
    +
  • +
+

options

+
    +
  • +

    --status | --st (string)

    +
      +
    • +

      Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
      +It is possible to specify multiple status separated by "," during list and delete package.

      +

      Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED

      +
    • +
    +
  • +
  • +

    --multiple-streams | --ms (boolean)

    +
      +
    • Specify to submit a separate, unique job for each package. If you do not specify this, a single job with a unique job step for each package is submitted.
    • +
    +
  • +
  • +

    --increment-jobname | --ij (boolean)

    +
      +
    • Specify to increases the last character in the jobcard you provide.
    • +
    +
  • +
  • +

    --jcl-procedure | --jp (string)

    +
      +
    • This option lets you to identify the name of the JCL procedure that you want to invoke. ENDEVOR is used by default if any processor is specified.
    • +
    +
  • +
  • +

    --CA7-dependent-job | --7dj (string)

    +
      +
    • Specifies a single predecessor job which must complete while demanded job is waiting in the CA 7 scheduler.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit package using jobcard from local file, with endevor profile set up:

    +
      +
    • zowe endevor submit package packageName --ff jobcardfile.txt -i ENDEVOR
    • +
    +
  • +
+

zoweendevorsubmitscl

+

The submit scl commands submits a SCL file to be executed.

+

Usage

+

zowe endevor submit scl [options]

+

options

+
    +
  • +

    --scl-file | --sf | --sclf (string)

    +
      +
    • The file which contains the Endevor SCL you would like to submit.
    • +
    +
  • +
  • +

    --scl-type | --sclt (string)

    +
      +
    • +

      The category of Endevor SCL.

      +

      Allowed values: list, element, package, admin, ship, addUpdRtv

      +
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-file | --ff (string)

    +
      +
    • Use this input to provide source file.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit a SCL of type element, with endevor profile set up:

    +
      +
    • zowe endevor submit scl --sf sclfile.txt --sclt element -i ENDEVOR
    • +
    +
  • +
+

zoweendevorsynchronize

+

Synchronize remote Endevor inventory with the local Endevor workspace.

+

zoweendevorsynchronizeworkspace

+

Synchronize a selected subset of remote Endevor inventory with a local Endevor workspace

+

Usage

+

zowe endevor synchronize workspace [workspace-dir] [options]

+

Positional Arguments

+
    +
  • +

    workspace-dir (string)

    +
      +
    • The Endevor workspace directory, if different from current working directory.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of any Endevor elements affected by this action.
    • +
    +
  • +
  • +

    --signout (boolean)

    +
      +
    • Specify if you want to perform the action with signing out any retrieved elements.
    • +
    +
  • +
+

workspace options

+
    +
  • +

    --element | --ele | --elem (string)

    +
      +
    • +

      Name filter to synchronize only specific Endevor element(s).

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --dry-run | --dr (boolean)

    +
      +
    • List all actions the synchronization would perform, without executing them.
    • +
    +
  • +
  • +

    --reset | --rst (boolean)

    +
      +
    • Revert any local changes, resetting the local workspace to match the current state of the remote Endevor inventory.
    • +
    +
  • +
  • +

    --limit | --lim (number)

    +
      +
    • +

      If the synchronization would need to perform more than 'limit' Endevor actions, do not perform the actions now, only report them. 0 means no limit.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --one-way (boolean)

    +
      +
    • Do not update Endevor elements with local changes, only retrieve remote changes from Endevor and resolve any conflicts.
    • +
    +
  • +
  • +

    --allow-deletes | --del (boolean)

    +
      +
    • Allow workspace synchronization to delete unchanged Endevor elements when it detects the corresponding local files have been deleted. Default is off to maintain backward compatibility.
    • +
    +
  • +
  • +

    --file-extension | --ext (string)

    +
      +
    • +

      The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:

      +
        none: File name is equal to element name, no extension is added\.
      +
      +  file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added\.
      +
      +  type\-name: The type name is used as the file extension\.
      +
      +  mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead\.
      +
      +

      Default value: mixed
      +Allowed values: none, file-ext, type-name, mixed

      +
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Synchronize all elements in the map location defined by the currently active endevor-location profile with current directory:

    +
      +
    • zowe endevor synchronize workspace
    • +
    +
  • +
  • +

    Synchronize all elements in the map location defined by the currently active endevor-location profile with workspace directory 'C:/projects/myWorkspace':

    +
      +
    • zowe endevor synchronize workspace 'C:/projects/myWorkspace'
    • +
    +
  • +
  • +

    Synchronize all elements in system SYSTEM1 subsystem SUBSYS1 from environment DEV stage 1, whose type begins with 'ASM', with current directory:

    +
      +
    • zowe endevor synchronize workspace --environment DEV --stage_number 1 --system SYSTEM1 --subsystem SUBSYS1 --type ASM* --ccid myccid --comment 'my changes'
    • +
    +
  • +
  • +

    Synchronize all elements in the map location defined by the currently active endevor-location profile, whose name is 'PRFX' followed by any 2 characters and ending with '11', with workspace directory 'C:/projects/myWorkspace':

    +
      +
    • zowe endevor synchronize workspace 'C:/projects/myWorkspace' --ccid myccid --comment 'my changes' --element PRFX%%11
    • +
    +
  • +
  • +

    Display all actions needed to synchronize all elements in the map location defined by endevor-location profile 'mysandbox' with current directory, without performing them:

    +
      +
    • zowe endevor synchronize workspace --dry-run --endevor-location-profile mysandbox
    • +
    +
  • +
  • +

    Revert all local changes in the map location defined by the currently active endevor-location profile, resetting your workspace to match Endevor:

    +
      +
    • zowe endevor synchronize workspace --reset
    • +
    +
  • +
+

zoweendevortransfer

+

Transfer an Element in Endevor.

+

zoweendevortransferelement

+

The Transfer element command transfers Elements from one Endevor location to another.

+

Usage

+

zowe endevor transfer element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output location options

+
    +
  • +

    --to-environment | --toenv (string)

    +
      +
    • The target Endevor environment.
    • +
    +
  • +
  • +

    --to-system | --tosys (string)

    +
      +
    • The target Endevor system.
    • +
    +
  • +
  • +

    --to-subsystem | --tosub (string)

    +
      +
    • The target Endevor subsystem.
    • +
    +
  • +
  • +

    --to-element | --toele (string)

    +
      +
    • The target Endevor element name.
    • +
    +
  • +
  • +

    --to-type | --totyp (string)

    +
      +
    • The target Endevor element type.
    • +
    +
  • +
  • +

    --to-stage-number | --tosn (string)

    +
      +
    • The target Endevor stage Id/number.
    • +
    +
  • +
+

options

+
    +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --element-version | --ev (number)

    +
      +
    • Indicates the version number of the element (use along with the level option).
    • +
    +
  • +
  • +

    --level | --lev (number)

    +
      +
    • Indicates the level number of the element (use along with the version option).
    • +
    +
  • +
  • +

    --new-version | --nv (number)

    +
      +
    • Assign a different version number to the Element.
    • +
    +
  • +
  • +

    --sync | -s (boolean)

    +
      +
    • Specify if you want to synchronize source and current level of the Elements while performing this action.
    • +
    +
  • +
  • +

    --with-history | --wh (boolean)

    +
      +
    • Specify if you want to preserve the change history of the Elements while performing this action.
    • +
    +
  • +
  • +

    --ignore-generate-failed | --igf (boolean)

    +
      +
    • Process the transfer request regardless of whether the FAILED flag is set for the element or if the element was generated or moved successfully.
    • +
    +
  • +
  • +

    --bypass-element-delete | --bed (boolean)

    +
      +
    • Specify if you want to retain the Elements in the source Stage after successfully completing this action.
    • +
    +
  • +
  • +

    --bypass-delete-proc | --bdp (boolean)

    +
      +
    • Specity to bypasses the execution of the delete processor.
    • +
    +
  • +
  • +

    --bypass-generate-proc | --bgp (boolean)

    +
      +
    • Specify to bypasses the execution of the generate or move processor (whichever may be chosen) upon element transfer.
    • +
    +
  • +
  • +

    --retain-signout | --rs (boolean)

    +
      +
    • Specify if you want to retain the source location signouts for all Elements at the target location while performing this action.
    • +
    +
  • +
  • +

    --signout-to | --st (string)

    +
      +
    • Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Transfer element from specified inventory location to 1 stage higher in map, with endevor profile set up:

    +
      +
    • zowe endevor transfer element elementName --env ENV --sn 1 --tosn 2 --sys SYS --sub SUB --typ TYPE -i ENDEVOR
    • +
    +
  • +
+

zoweendevorunsynchronize

+

Remove a synchronized Endevor inventory from a local Endevor workspace and delete any related metadata.

+

zoweendevorunsynchronizeworkspace

+

Remove a selected subset of remote Endevor inventory from a local Endevor workspace

+

Usage

+

zowe endevor unsynchronize workspace [workspace-dir] [options]

+

Positional Arguments

+
    +
  • +

    workspace-dir (string)

    +
      +
    • The Endevor workspace directory, if different from current working directory.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

workspace options

+
    +
  • +

    --element | --ele | --elem (string)

    +
      +
    • +

      Name filter to synchronize only specific Endevor element(s).

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --force | -f (boolean)

    +
      +
    • Force unsynchronization of local workspace regardless of any local changes not yet saved into Endevor.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Remove all elements in the map location defined by the currently active endevor-location profile from current directory:

    +
      +
    • zowe endevor unsynchronize workspace
    • +
    +
  • +
  • +

    Remove all elements in the map location defined by the currently active endevor-location profile from current directory, throwing away any local changes not saved in Endevor:

    +
      +
    • zowe endevor unsynchronize workspace --force
    • +
    +
  • +
  • +

    Remove all elements in the map location defined by the currently active endevor-location profile from workspace directory 'C:/projects/myWorkspace':

    +
      +
    • zowe endevor unsynchronize workspace 'C:/projects/myWorkspace'
    • +
    +
  • +
  • +

    Remove all elements in system SYSTEM1 subsystem SUBSYS1 environment DEV stage 1, whose type begins with 'ASM', from current directory:

    +
      +
    • zowe endevor unsynchronize workspace --environment DEV --stage_number 1 --system SYSTEM1 --subsystem SUBSYS1 --type ASM* --ccid myccid --comment 'my changes'
    • +
    +
  • +
+

zoweendevorupdate

+

Update an Element or a Package in Endevor.

+

zoweendevorupdateelement

+

The update element command updates an Element in the entry Stage, thereby creating a new level for the Element in the entry Stage.

+

Usage

+

zowe endevor update element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-file | --ff (string)

    +
      +
    • Use this input to provide source file.
    • +
    +
  • +
  • +

    --from-dataset | --fd (string)

    +
      +
    • Use this input to provide source data set name.
    • +
    +
  • +
  • +

    --from-member | --fm (string)

    +
      +
    • Use this input to provide source member name in the data set.
    • +
    +
  • +
  • +

    --from-path | --fp (string)

    +
      +
    • Use this input to provide the path of source USS file. It must be used with from-uss-file.
    • +
    +
  • +
  • +

    --from-uss-file | --fuf (string)

    +
      +
    • Use this input to provide source USS file name. It must be used with from-path
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --generate | -g (boolean)

    +
      +
    • Specifies if you want to Generate Element after Add/Update action.
    • +
    +
  • +
  • +

    --get-fingerprint | --gfg (boolean)

    +
      +
    • +

      Return fingerprint of a retrieved, added or updated element as the first line of the response.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --fingerprint | --fg (string)

    +
      +
    • Specifies the fingerprint of the element to Add or Update. Use value 'NEW' when adding a new element that shouldn't exist in the map yet.
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --sync | -s (boolean)

    +
      +
    • Specify if you want to synchronize source and current level of the Elements while performing this action.
    • +
    +
  • +
  • +

    --sync-with-history | --swh (boolean)

    +
      +
    • Specify if you want to preserve the change history of the Elements while performing the synchronization during element update.
    • +
    +
  • +
  • +

    --sync-fingerprint | --sfg (string)

    +
      +
    • Specifies the fingerprint of the element directly up the map that the updated element should be synchronized with. Prevents the sync if the element up the map doesn't match the fingerprint.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update element from local file with endevor profile set up:

    +
      +
    • zowe endevor update element elementName --env ENV --sys SYS --sub SUB --typ TYPE --ff localfile.txt -i ENDEVOR --ccid CCID --comment 'updating element'
    • +
    +
  • +
+

zoweendevorupdatepackage

+

The update package command lets you update a package in Endevor.

+

Usage

+

zowe endevor update package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-file | --ff (string)

    +
      +
    • Use this input to provide source file.
    • +
    +
  • +
  • +

    --from-dataset | --fd (string)

    +
      +
    • Use this input to provide source data set name.
    • +
    +
  • +
  • +

    --from-member | --fm (string)

    +
      +
    • Use this input to provide source member name in the data set.
    • +
    +
  • +
  • +

    --from-package | --fp (string)

    +
      +
    • Directs the Create/Update action to copy the SCL from the package you specify into the package you are creating or updating.
    • +
    +
  • +
  • +

    --from-text | --ft (string)

    +
      +
    • Provides a string to use as input SCL.
    • +
    +
  • +
+

options

+
    +
  • +

    --description | -d (string)

    +
      +
    • Allows you to associate a 50-character description when creating or updating package.
    • +
    +
  • +
  • +

    --from-date-time | --fdt (string)

    +
      +
    • Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --to-date-time | --tdt (string)

    +
      +
    • Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --backout (boolean)

    +
      +
    • +

      Set this option to false (or specify --no-backout) if you don't want to have the backout facility available for this package. By default backout is enabled.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --notes | -n (string)

    +
      +
    • Notes for package.
    • +
    +
  • +
  • +

    --notes-from-file | --nff (string)

    +
      +
    • Local file of notes for package.
    • +
    +
  • +
  • +

    --emergency-package | --ep (boolean)

    +
      +
    • Specify if the package should be an emergency package. When not specified, the package is a standard package.
    • +
    +
  • +
  • +

    --sharable | --sh (boolean)

    +
      +
    • Specify this option if the package can be edited by more than one person when in In-edit status.
    • +
    +
  • +
  • +

    --promotion | --pr (boolean)

    +
      +
    • Specify this option to define the package as a promotion package.
    • +
    +
  • +
  • +

    --validate-scl | --vs (boolean)

    +
      +
    • +

      Set this option to false (or specify --no-validate-scl) to skip validion of the package components while creating a package. By default the SCL is validated

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --append | -a (boolean)

    +
      +
    • Specify this option to append the SCL you are adding to the existing package SCL. Otherwise it would be replaced.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update package from local file with endevor profile set up:

    +
      +
    • zowe endevor update package packageName --ff localfile.txt -i ENDEVOR
    • +
    +
  • +
+

zoweendevorview

+

View an Element or a Package SCL in Endevor.

+

zoweendevorviewelement

+

The view element command views an existing element in Endevor.

+

Usage

+

zowe endevor view element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --element-version | --ev (number)

    +
      +
    • Indicates the version number of the element (use along with the level option).
    • +
    +
  • +
  • +

    --level | --lev (number)

    +
      +
    • Indicates the level number of the element (use along with the version option).
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --to-file | --tf (string)

    +
      +
    • The file name in which the data from the command output is stored
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    View element from specified inventory location to local file with endevor profile set up:

    +
      +
    • zowe endevor view element elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE --tf localfile.txt -i ENDEVOR
    • +
    +
  • +
+

zoweendevorviewpkgscl

+

The view pkgscl command views the SCL of an existing package in Endevor.

+

Usage

+

zowe endevor view pkgscl [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --to-file | --tf (string)

    +
      +
    • The file name in which the data from the command output is stored
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    View SCL of package "packageName" in the console with endevor profile set up:

    +
      +
    • zowe endevor view pkgscl packageName -i ENDEVOR
    • +
    +
  • +
+
+

zoweendevor-bridge-for-git

+

Use the Endevor Bridge for Git plug-in to manage your Git-Endevor mappings and build your local Git changes before synchronizing them to Endevor.

+

zoweendevor-bridge-for-gitbranch

+

Manage the branches of your Git-Endevor mapping.

+

zoweendevor-bridge-for-gitbranchadd

+

Add a branch to an existing mapping

+

Usage

+

zowe endevor-bridge-for-git branch add <context> <mapping> <branch> [options]

+

Positional Arguments

+
    +
  • +

    context (string)

    +
      +
    • Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
    • +
    +
  • +
  • +

    mapping (string)

    +
      +
    • Git-Endevor mapping name (ID of the Git repository).
    • +
    +
  • +
  • +

    branch (string)

    +
      +
    • Name of the branch that will be added/removed.
    • +
    +
  • +
+

Options

+
    +
  • +

    --endevor-system | --endevorsys | --system (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub | --sub | --subsystem (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --system-alias (string)

    +
      +
    • The alias of Endevor system.
    • +
    +
  • +
  • +

    --subsystem-alias (string)

    +
      +
    • The alias of Endevor subsystem.
    • +
    +
  • +
  • +

    --endevor-environment | --endevorenv | --env | --environment (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --read-only (boolean)

    +
      +
    • If specified, it is necessary to use the option --endevor-stage-number. The synchronized elements will be read-only.
    • +
    +
  • +
  • +

    --endevor-stage-number | --endevorsn (string)

    +
      +
    • The Endevor stage where your project resides (only for read only mappings).
    • +
    +
  • +
  • +

    --only-work-environment (boolean)

    +
      +
    • If specified, only elements from the Endevor work environment will be synchronized.
    • +
    +
  • +
  • +

    --mapping-mode (string)

    +
      +
    • +

      Mapping mode of the mapping ('FULL', 'WORK_ENV_ONLY' or 'MIRROR')

      +

      Allowed values: FULL, WORK_ENV_ONLY, MIRROR

      +
    • +
    +
  • +
  • +

    --like (string)

    +
      +
    • Add branch using parameters from another branch in the same repository
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git branch add MY-CONTEXT MY-MAPPING MY-BRANCH --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME
    • +
    +
  • +
  • +

    Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile by using another branch as a template with different environment:

    +
      +
    • zowe endevor-bridge-for-git branch add MY-CONTEXT MY-MAPPING MY-BRANCH --like TEMPLATE_BRANCH --endevor-environment DIFFERENT_ENVIRONMENT
    • +
    +
  • +
  • +

    Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile by using another branch as a template with different system/subsystem:

    +
      +
    • zowe endevor-bridge-for-git branch add MY-CONTEXT MY-MAPPING MY-BRANCH --like TEMPLATE_BRANCH --endevor-system DIFFERENT_SYSTEM --endevor-subsystem DIFFERENT_SUBSYSTEM
    • +
    +
  • +
+

zoweendevor-bridge-for-gitbranchdelete

+

Remove a branch from an existing mapping

+

Usage

+

zowe endevor-bridge-for-git branch delete <context> <mapping> [branch] [options]

+

Positional Arguments

+
    +
  • +

    context (string)

    +
      +
    • Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
    • +
    +
  • +
  • +

    mapping (string)

    +
      +
    • Git-Endevor mapping name (ID of the Git repository).
    • +
    +
  • +
  • +

    branch (string)

    +
      +
    • Name of the synchronized branch in the Git repository.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Remove a branch from my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git branch delete MY-CONTEXT MY-MAPPING MY-BRANCH
    • +
    +
  • +
+

zoweendevor-bridge-for-gitbranchlist

+

List the branches of an existing mapping

+

Usage

+

zowe endevor-bridge-for-git branch list <context> <mapping> [options]

+

Positional Arguments

+
    +
  • +

    context (string)

    +
      +
    • Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
    • +
    +
  • +
  • +

    mapping (string)

    +
      +
    • Git-Endevor mapping name (ID of the Git repository).
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all branch of my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git branch list MY-CONTEXT MY-MAPPING
    • +
    +
  • +
+

zoweendevor-bridge-for-gitbuild

+

Build changes from git local repository in Endevor

+

zoweendevor-bridge-for-gitbuildexecute

+

Build changes against remote git repository's Endevor Bridge for Git synchronized branch, using work area or build subsystem.It does not support autogen for building dependencies.

+

Usage

+

zowe endevor-bridge-for-git build execute [options]

+

Required Options

+
    +
  • +

    --endevor-instance | --endevori (string)

    +
      +
    • The Endevor Web Services Endevor configuration name.
    • +
    +
  • +
+

Endevor work area options

+
    +
  • +

    --work-area-id | --waid (string)

    +
      +
    • Endevor work area ID. Name-masking is not allowed.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub (string)

    +
      +
    • The Endevor SCM build subsystem. Note: The build subsystem can be cleared without prior permission.
    • +
    +
  • +
  • +

    --endevor-environment | --endevorenv (string)

    +
      +
    • The Endevor SCM environment where your build subsystem resides.
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys (string)

    +
      +
    • The Endevor SCM system where your build subsystem resides.
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping that you are building.

      +

      Default value: ./

      +
    • +
    +
  • +
  • +

    --listing-dir (string)

    +
      +
    • +

      Specify the directory where you would like to have your build outputs downloaded

      +

      Default value: .endevor/listings

      +
    • +
    +
  • +
  • +

    --listing-rc (number)

    +
      +
    • +

      All the elements that have a generate result equal to or greater than "listing-rc" will have their build outputs downloaded into "listing-dir"

      +

      Default value: 4

      +
    • +
    +
  • +
  • +

    --force-cleanup | --fc (boolean)

    +
      +
    • +

      Starts the build process after cleaning the build subsystem.

      +

      Default value: false

      +
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compile the changed elements in the current Git working directory using the work area "WORKAREA1" and an existing Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git build execute --endevor-instance INSTANCE --work-area-id WORKAREA1
    • +
    +
  • +
  • +

    Compile the changed elements in the current Git working directory using the build subsystem "SUBNAME" and an existing Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git build execute --endevor-instance INSTANCE --endevor-subsystem SUBNAME --endevor-environment ENVNAME --endevor-system SYSNAME
    • +
    +
  • +
+

zoweendevor-bridge-for-gitbuildjob-report

+

Get the report after executing 'build job-submit' command. This this command must be issued to finalize processing.

+

Usage

+

zowe endevor-bridge-for-git build job-report [options]

+

Required Options

+
    +
  • +

    --endevor-instance | --endevori (string)

    +
      +
    • The Endevor Web Services Endevor configuration name.
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping that you are building.

      +

      Default value: ./

      +
    • +
    +
  • +
  • +

    --listing-dir (string)

    +
      +
    • +

      Specify the directory where you would like to have your build outputs downloaded

      +

      Default value: .endevor/listings

      +
    • +
    +
  • +
  • +

    --listing-rc (number)

    +
      +
    • +

      All the elements that have a generate result equal to or greater than "listing-rc" will have their build outputs downloaded into "listing-dir"

      +

      Default value: 4

      +
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

z/OSMF connection options (alternatively use a 'zosmf' profile)

+
    +
  • +

    --zosmf-host | --zosmfh (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --zosmf-port | --zosmfp (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --zosmf-user | --zosmfu (string)

    +
      +
    • Mainframe (z/OSMF) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --zosmf-password | --zosmfpass | --zosmfpw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --zosmf-reject-unauthorized | --zosmfru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --zosmf-base-path | --zosmfbp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option toprepend the base path to all z/OSMF resources when making REST requests. Do notspecify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the reports from the build job submitted by 'build job-submit' command from git working directory "/endevor/ebg/repository" using existing Endevor and z/OSMF profiles:

    +
      +
    • zowe endevor-bridge-for-git build job-report --wd "C:\endevor\ebg\dir"
    • +
    +
  • +
+

zoweendevor-bridge-for-gitbuildjob-submit

+

Build changes from git local repository in Endevor by submitting a job. It supports autogen for building dependencies using with the option of selecting autogen span. After submitting, the command 'build job-report' must be issued to finalize processing.

+

Usage

+

zowe endevor-bridge-for-git build job-submit [options]

+

Required Options

+ +

Endevor work area options

+
    +
  • +

    --work-area-id | --waid (string)

    +
      +
    • Endevor work area ID. Name-masking is not allowed.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub (string)

    +
      +
    • The Endevor SCM build subsystem. Note: The build subsystem can be cleared without prior permission.
    • +
    +
  • +
  • +

    --endevor-environment | --endevorenv (string)

    +
      +
    • The Endevor SCM environment where your build subsystem resides.
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys (string)

    +
      +
    • The Endevor SCM system where your build subsystem resides.
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping that you are building.

      +

      Default value: ./

      +
    • +
    +
  • +
  • +

    --force-cleanup | --fc (boolean)

    +
      +
    • +

      Starts the build process after cleaning the build subsystem.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --autogen-span | --ags (string)

    +
      +
    • +

      Specifies the autogen action option to automatically generate using elements.
      +The allowed values which have the following meaning:
      +NONE - Generates all elements that use the component being acted upon.
      +ALL - Generates using elements that are found in any System and Subsystem combinations within the Environment and Stage of the component's logical map.
      +SYSTEMS - Generates using elements that are found in any System, provided the element's Subsystem name matches the name of the Subsystem of the target component.
      +SUBSYSTEMS - Generates using elements from all Subsystems with the same-named System of the component specified.

      +

      Default value: NONE
      +Allowed values: NONE, ALL, SYSTEMS, SUBSYSTEMS

      +
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

z/OSMF connection options (alternatively use a 'zosmf' profile)

+
    +
  • +

    --zosmf-host | --zosmfh (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --zosmf-port | --zosmfp (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --zosmf-user | --zosmfu (string)

    +
      +
    • Mainframe (z/OSMF) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --zosmf-password | --zosmfpass | --zosmfpw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --zosmf-reject-unauthorized | --zosmfru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --zosmf-base-path | --zosmfbp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option toprepend the base path to all z/OSMF resources when making REST requests. Do notspecify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compile the changed elements at "/endevor/ebg/repository" using work area with ID "WORKAREA1", jcl skeleton at "/endevor/jcl/jcl.txt" and existing Endevor and z/OSMF profiles:

    +
      +
    • zowe endevor-bridge-for-git build job-submit --skeleton-jcl /endevor/jcl/jcl.txt --work-area-id WORKAREA1 --work-dir /endevor/ebg/repository
    • +
    +
  • +
  • +

    Compile the changed elements at "/endevor/ebg/repository" using build subsystem "SUBNAME", jcl skeleton at "/endevor/jcl/jcl.txt" and existing Endevor and z/OSMF profiles:

    +
      +
    • zowe endevor-bridge-for-git build job-submit --skeleton-jcl /endevor/jcl/jcl.txt --endevor-subsystem SUBNAME --endevor-environment ENVNAME --endevor-system SYSNAME --work-dir /endevor/ebg/repository
    • +
    +
  • +
+

zoweendevor-bridge-for-gitendevor-connection

+

Manage connections to Endevor Web Services used by Endevor Bridge for Git.

+

zoweendevor-bridge-for-gitendevor-connectioncreate

+

Create new Endevor connection for Endevor Bridge for Git.

+

Usage

+

zowe endevor-bridge-for-git endevor-connection create <connection> [options]

+

Positional Arguments

+
    +
  • +

    connection (string)

    +
      +
    • Endevor connection name.
    • +
    +
  • +
+

Options

+
    +
  • +

    --endevor-instance | --endevori (string)

    +
      +
    • The Endevor Web Services Endevor configuration name.
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create the Endevor connection 'MY-CONNECTION' using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --endevor-instance INSTANCE
    • +
    +
  • +
  • +

    Create the Endevor connection 'MY-CONNECTION' using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --endevor-protocol http --endevor-host endevor-host --endevor-port 12345 --endevor-instance INSTANCE
    • +
    +
  • +
  • +

    Create the Endevor connection 'MY-CONNECTION' using the default Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --protocol http --host bridge-host --port 8080 --endevor-instance INSTANCE
    • +
    +
  • +
+

zoweendevor-bridge-for-gitendevor-connectiondelete

+

Delete existing Endevor connection defined to Endevor Bridge for Git.

+

Usage

+

zowe endevor-bridge-for-git endevor-connection delete <connection> [options]

+

Positional Arguments

+
    +
  • +

    connection (string)

    +
      +
    • Endevor connection name.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the Endevor connection using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection delete MY-CONNECTION
    • +
    +
  • +
  • +

    Delete the Endevor connection without an EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection delete MY-CONNECTION --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890
    • +
    +
  • +
+

zoweendevor-bridge-for-gitendevor-connectionlist

+

List Endevor connections used by Endevor Bridge for Git.

+

Usage

+

zowe endevor-bridge-for-git endevor-connection list [options]

+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all the Endevor connections using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection list
    • +
    +
  • +
  • +

    List all the Endevor connections without an EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection list --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890
    • +
    +
  • +
+

zoweendevor-bridge-for-gitendevor-connectionrename

+

Rename existing Endevor connection defined to Endevor Bridge for Git.

+

Usage

+

zowe endevor-bridge-for-git endevor-connection rename <connection> <new-connection> [options]

+

Positional Arguments

+
    +
  • +

    connection (string)

    +
      +
    • Endevor connection name.
    • +
    +
  • +
  • +

    new-connection (string)

    +
      +
    • New Endevor connection name.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Rename the Endevor connection using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection rename MY-CONNECTION NEW-NAME
    • +
    +
  • +
  • +

    Rename the Endevor connection without an EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection rename MY-CONNECTION NEW-NAME --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890
    • +
    +
  • +
+

zoweendevor-bridge-for-gitendevor-connectionupdate-credentials

+

Update your Endevor credentials for the Endevor connection.

+

Usage

+

zowe endevor-bridge-for-git endevor-connection update-credentials <connection> [options]

+

Positional Arguments

+
    +
  • +

    connection (string)

    +
      +
    • Endevor connection name.
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update the Endevor credentials for the Endevor connection MY-CONNECTION using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection update-credentials MY-CONNECTION
    • +
    +
  • +
  • +

    Update the Endevor credentials for the Endevor connection MY-CONNECTION using the default EBG profile but not using an Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection update-credentials MY-CONNECTION --endevor-user my-user --endevor-password my-password
    • +
    +
  • +
+

zoweendevor-bridge-for-gitendevor-credentials

+

Manage your Endevor credentials stored in Endevor Bridge for Git. [Deprecated]

+

zoweendevor-bridge-for-gitendevor-credentialsupdate

+

Update your Endevor credentials for a Git-Endevor mapping.

+

Usage

+

zowe endevor-bridge-for-git endevor-credentials update <context> <mapping> [options]

+

Positional Arguments

+
    +
  • +

    context (string)

    +
      +
    • Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
    • +
    +
  • +
  • +

    mapping (string)

    +
      +
    • Git-Endevor mapping name (ID of the Git repository).
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update the Endevor credentials for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-credentials update MY-CONTEXT MY-MAPPING
    • +
    +
  • +
  • +

    Update the Endevor credentials for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile but not using an Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-credentials update MY-CONTEXT MY-MAPPING --endevor-user my-user --endevor-password my-password
    • +
    +
  • +
+

zoweendevor-bridge-for-gitlocal-hook-token

+

Manage the token you use for secure communication with BridgeForGit when using the local hook validation.

+

zoweendevor-bridge-for-gitlocal-hook-tokengenerate

+

Generate a new local hook token for Endevor Bridge for Git.

+

Usage

+

zowe endevor-bridge-for-git local-hook-token generate [options]

+

Options

+
    +
  • +

    --overwrite (boolean)

    +
      +
    • +

      If specified, your previous token will be overwritten.

      +

      Default value: false

      +
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Generate a token using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git local-hook-token generate
    • +
    +
  • +
+

zoweendevor-bridge-for-gitlocal-hook-tokenlist

+

List your local hook token.

+

Usage

+

zowe endevor-bridge-for-git local-hook-token list [options]

+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List your token using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git local-hook-token list
    • +
    +
  • +
+

zoweendevor-bridge-for-gitlocal-hook-tokenrevoke

+

Revoke your local hook token.

+

Usage

+

zowe endevor-bridge-for-git local-hook-token revoke [options]

+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Revoke your token using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git local-hook-token revoke
    • +
    +
  • +
+

zoweendevor-bridge-for-gitmapping

+

Manage the Git-Endevor mappings.

+

zoweendevor-bridge-for-gitmappingadd-element

+

Add an element from up the map in your Endevor to your Git repository.

+

Usage

+

zowe endevor-bridge-for-git mapping add-element <context> <mapping> [options]

+

Positional Arguments

+
    +
  • +

    context (string)

    +
      +
    • Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
    • +
    +
  • +
  • +

    mapping (string)

    +
      +
    • Git-Endevor mapping name (ID of the Git repository).
    • +
    +
  • +
+

Options

+
    +
  • +

    --element-name | --name (string)

    +
      +
    • The name of the Endevor element you want to add.
    • +
    +
  • +
  • +

    --element-type | --type (string)

    +
      +
    • The type of the Endevor element you want to add
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys | --system (string)

    +
      +
    • The Endevor system where your element resides.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub | --sub | --subsystem (string)

    +
      +
    • The Endevor subsystem where your element resides.
    • +
    +
  • +
  • +

    --withDependencies (boolean)

    +
      +
    • +

      If specified, the requested element will be added with dependencies (eg. COBOL copybooks).

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --force-get-dependencies | --force (boolean)

    +
      +
    • +

      If specified, the maximum number of dependencies will be bypassed. This only applies to the repository administrator.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --validate (boolean)

    +
      +
    • +

      If specified, the requested elements will be validated against Endevor.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --branchId (string)

    +
      +
    • If specified, the requested elements will be added to the selected branch.
    • +
    +
  • +
  • +

    --all-branches (boolean)

    +
      +
    • +

      If specified, the requested elements will be added to all synchronized branches in your repository.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --file | --fn (local file path)

    +
      +
    • If specified, the elements to add will be read from file. Make sure that the file is in the correct format as specified in the documentation.
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Add an element 'MY-ELEMENT-TYPE / MY-ELEMENT-NAME' for your mapping 'MY-CONTEXT / MY-MAPPING':

    +
      +
    • zowe endevor-bridge-for-git mapping add-element MY-CONTEXT MY-MAPPING --name MY-ELEMENT-NAME --type MY-ELEMENT-TYPE
    • +
    +
  • +
  • +

    Add multiple elements for your mapping 'MY-CONTEXT / MY-MAPPING' from file:

    +
      +
    • zowe endevor-bridge-for-git mapping add-element MY-CONTEXT MY-MAPPING --fileName MY-FILEPATH.json
    • +
    +
  • +
+

zoweendevor-bridge-for-gitmappingcreate

+

Create a Git-Endevor mapping

+

Usage

+

zowe endevor-bridge-for-git mapping create [options]

+

Options

+
    +
  • +

    --remote-url | --url (string)

    +
      +
    • Git repository remote URL
    • +
    +
  • +
  • +

    --connection (string)

    +
      +
    • Endevor connection name.
    • +
    +
  • +
  • +

    --endevor-instance | --endevori (string)

    +
      +
    • The Endevor Web Services Endevor configuration name.
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys | --system (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub | --sub | --subsystem (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --system-alias (string)

    +
      +
    • The alias of Endevor system.
    • +
    +
  • +
  • +

    --subsystem-alias (string)

    +
      +
    • The alias of Endevor subsystem.
    • +
    +
  • +
  • +

    --endevor-environment | --endevorenv | --env | --environment (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --branch | -b (string)

    +
      +
    • +

      Name of the synchronized branch in the Git repository.

      +

      Default value: master

      +
    • +
    +
  • +
  • +

    --only-work-environment (boolean)

    +
      +
    • If specified, only elements from the Endevor work environment will be synchronized.
    • +
    +
  • +
  • +

    --read-only (boolean)

    +
      +
    • If specified, it is necessary to use the option --endevor-stage-number. The synchronized elements will be read-only.
    • +
    +
  • +
  • +

    --endevor-stage-number | --endevorsn (string)

    +
      +
    • The Endevor stage where your project resides (only for read only mappings).
    • +
    +
  • +
  • +

    --type-filter (string)

    +
      +
    • Type filter
    • +
    +
  • +
  • +

    --mapping-mode (string)

    +
      +
    • +

      Mapping mode of the mapping ('FULL', 'WORK_ENV_ONLY' or 'MIRROR')

      +

      Allowed values: FULL, WORK_ENV_ONLY, MIRROR

      +
    • +
    +
  • +
  • +

    --json-file | --json (local file path)

    +
      +
    • Mapping JSON file to import
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git mapping create --remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME
    • +
    +
  • +
  • +

    Create the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git mapping create --remote-url https://git-server-enterprise.com/my-context/my-mapping.git --connection endevor-connection-name --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME
    • +
    +
  • +
  • +

    Create the read-only Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git mapping create --remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME --read-only --endevor-stage-number 2
    • +
    +
  • +
  • +

    Create the Git-Endevor mapping with importing a mapping file:

    +
      +
    • zowe endevor-bridge-for-git mapping create --json-file my-mapping.json
    • +
    +
  • +
+

zoweendevor-bridge-for-gitmappingdelete

+

Delete a Git-Endevor mapping

+

Usage

+

zowe endevor-bridge-for-git mapping delete <context> <mapping> [options]

+

Positional Arguments

+
    +
  • +

    context (string)

    +
      +
    • Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
    • +
    +
  • +
  • +

    mapping (string)

    +
      +
    • Git-Endevor mapping name (ID of the Git repository).
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git mapping delete MY-CONTEXT MY-MAPPING
    • +
    +
  • +
+

zoweendevor-bridge-for-gitmappinglist

+

List Git-Endevor mappings. If the mapping contains multiple systems and/or subsystems, the field 'system' and 'subsystem' will contain the value 'multi'.

+

Usage

+

zowe endevor-bridge-for-git mapping list [options]

+

Options

+
    +
  • +

    --view | -v (string)

    +
      +
    • +

      Type of detail to be displayed.

      +

      Default value: default
      +Allowed values: default, endevor, all

      +
    • +
    +
  • +
  • +

    --export (boolean)

    +
      +
    • +

      Export list of mapping to a json file.

      +

      Default value: false

      +
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all the Git-Endevor mappings using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git mapping list
    • +
    +
  • +
  • +

    List all the Git-Endevor mappings and show their Endevor details using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git mapping list --view endevor
    • +
    +
  • +
  • +

    List all the Git-Endevor mappings and show all their details using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git mapping list --view all
    • +
    +
  • +
  • +

    List all the Git-Endevor mappings without an EBG profile:

    +
      +
    • zowe endevor-bridge-for-git mapping list --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890
    • +
    +
  • +
+

zoweendevor-bridge-for-gitprocessor-group

+

Manage the processor groups of your mapping

+

zoweendevor-bridge-for-gitprocessor-grouplist

+

List processor groups used by a type in your mapping

+

Usage

+

zowe endevor-bridge-for-git processor-group list [options]

+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping.

      +

      Default value: ./

      +
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys (string)

    +
      +
    • The Endevor system or alias of the system where your project resides.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub (string)

    +
      +
    • The Endevor subsystem or alias of the subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --type (string)

    +
      +
    • The type of the Endevor element
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all the processor groups used by a type in your mapping for a single system/subsystem mapping.:

    +
      +
    • zowe endevor-bridge-for-git processor-group list --type TYPE
    • +
    +
  • +
  • +

    List all the processor groups used by a type in your mapping for a multi system/subsystem mapping.:

    +
      +
    • zowe endevor-bridge-for-git processor-group list --endevorsys SYSTEM --endevorsub SUBSYSTEM --type TYPE
    • +
    +
  • +
+

zoweendevor-bridge-for-gitprocessor-groupupdate

+

Update the processor group of a specific element in your local repository

+

Usage

+

zowe endevor-bridge-for-git processor-group update <element> <processor-group> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • The name of the Endevor element that its processor group will be modified
    • +
    +
  • +
  • +

    processor-group (string)

    +
      +
    • The name of the processor group you want to use
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping.

      +

      Default value: ./

      +
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys (string)

    +
      +
    • The Endevor system or alias of the system where your project resides.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub (string)

    +
      +
    • The Endevor subsystem or alias of the subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --type (string)

    +
      +
    • The type of the Endevor element
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

zoweendevor-bridge-for-gitprocessor-groupupdate-all

+

Update the processor group of all changed elements of a specific type

+

Usage

+

zowe endevor-bridge-for-git processor-group update-all <processor-group> [options]

+

Positional Arguments

+
    +
  • +

    processor-group (string)

    +
      +
    • The name of the processor group you want to use
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping.

      +

      Default value: ./

      +
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys (string)

    +
      +
    • The Endevor system or alias of the system where your project resides.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub (string)

    +
      +
    • The Endevor subsystem or alias of the subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --type (string)

    +
      +
    • The type of the Endevor element
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

zoweendevor-bridge-for-gitwork-area

+

Use an Endevor work area from the list defined by your administrator.

+

zoweendevor-bridge-for-gitwork-arealist

+

List Endevor work areas.

+

Usage

+

zowe endevor-bridge-for-git work-area list [work-area-id] [options]

+

Positional Arguments

+
    +
  • +

    work-area-id (string)

    +
      +
    • Specify to list only one Endevor work area ID. Name-masking is not allowed.
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping that you are building.

      +

      Default value: ./

      +
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show the details of all the work areas in the current working directory:

    +
      +
    • zowe endevor-bridge-for-git work-area list
    • +
    +
  • +
  • +

    Show the details of work area with ID "WORKAREA1":

    +
      +
    • zowe endevor-bridge-for-git work-area list WORKAREA1
    • +
    +
  • +
+

zoweendevor-bridge-for-gitwork-areareserve

+

Reserve the first found available Endevor work area. When success, returns the reserved work area id

+

Usage

+

zowe endevor-bridge-for-git work-area reserve [work-area-id] [options]

+

Positional Arguments

+
    +
  • +

    work-area-id (string)

    +
      +
    • Reserve the Endevor work area with the ID specified. Name-masking is not allowed.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --endevor-instance | --endevori (string)

    +
      +
    • The Endevor Web Services Endevor configuration name.
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping that you are building.

      +

      Default value: ./

      +
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Reserve the first found available Endevor work area using an existing Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git work-area reserve --endevor-instance ENDEVOR
    • +
    +
  • +
  • +

    Reserve the work area with ID "WORKAREA1", if available, using an existing Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git work-area reserve WORKAREA1 --endevor-instance ENDEVOR
    • +
    +
  • +
+

zoweendevor-bridge-for-gitwork-areaunreserve

+

Unreserve an Endevor work area.

+

Usage

+

zowe endevor-bridge-for-git work-area unreserve <work-area-id> [options]

+

Positional Arguments

+
    +
  • +

    work-area-id (string)

    +
      +
    • Endevor work area ID. Name-masking is not allowed.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --endevor-instance | --endevori (string)

    +
      +
    • The Endevor Web Services Endevor configuration name.
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping that you are building.

      +

      Default value: ./

      +
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Unreserve work area with id "WORKAREA1" using an existing Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git work-area unreserve WORKAREA1 --endevor-instance ENDEVOR
    • +
    +
  • +
+
+

zowefile-master-plus

+

File Master Plus command line interface is a file management and data manipulation tool.
+It speeds up file creation and manipulates virtual storage access method (VSAM), sequential and partitioned data sets.
+It also supports symbolic access to data via layouts and data manipulation like selection of records in data sets.

+

zowefile-master-pluscopy

+

Copy data from a data set and optionally filter or modify the copied data by using selection criteria.

+

zowefile-master-pluscopydata-set

+

Copy from a data set to another data set.
+If the <to> data set does not exist, File Master Plus automatically creates a new data set using the attributes of <from> data set.
+It supports all data set types that are supported by File Master Plus.

+

Usage

+

zowe file-master-plus copy data-set <from> <to> [options]

+

Positional Arguments

+
    +
  • +

    from (string)

    +
      +
    • Specifies the name of the data set to copy from.
    • +
    +
  • +
  • +

    to (string)

    +
      +
    • Specifies the name of the data set to copy to.
    • +
    +
  • +
+

Options

+
    +
  • +

    --members | -m (array)

    +
      +
    • Specifies the members that you want to copy from the data set. To rename the member, specify a new member name after the delimiter ','.If this parameter is not specified all the members are copied.
      +Note: This parameter only applies to a PDS or PDSE.
      +Example: --mem mem1,newmem1 mem2. Here 'mem2' is copied as it is, and 'mem1' is renamed as 'newmem1'.
    • +
    +
  • +
  • +

    --generation | -g (string)

    +
      +
    • Specifies the PDSE V2 generation number that you want to copy from the data set from.
      +Note: This parameter should only be specified if data set from is PDSEV2. If not specified and data set from is a PDSE V2 then current generation, i.e. generation 0, is copied. If generation is negative specifies Relative generation, positive specifies Absolute generation, * specifies all generations and 0 specifies current generation.
      +Example1: --generation *. All generations of member(s) is copied.
      +Example2: --generation -1. Relative generation -1 of member(s) is copied.
      +Example3: --generation 4. Absolute generation 4 of member(s) is copied.
      +Allowed values: '*','range from -2000000000 to 2000000000'
    • +
    +
  • +
  • +

    --replace | -r (string)

    +
      +
    • +

      Replace resource-specific items in the target data set. Note: Used only if the target data set is a PDS or a VSAM KSDS.
      +Example: -r n.

      +

      Default value: y
      +Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --static-selection-criteria | --ssc (string)

    +
      +
    • Specifies the name of pre-defined File Master Plus selection criteria. The name refers to a member in the defaultselection criteria data set as defined in the FMM_CLIST parameter in File Master Plus server.
      +Example: --ssc testcri
    • +
    +
  • +
  • +

    --dynamic-selection-criteria | --dsc (string)

    +
      +
    • Specifies path of the .txt file where the dynamic selection criteria exist. Ensure the format of the file is identical to the static selection criteria created by File Master Plus. If the selection criteria refer to field names in a Cobol or PL/I copybook, use the --layout-member and --layout-data-set parameters to name the copybook location.
      +Example: --dsc ../selcri/testcri.txt
    • +
    +
  • +
  • +

    --layout-member | --lm (string)

    +
      +
    • Specifies name of the Cobol or PL/I copybook.
      +Example: -lm testlay.
    • +
    +
  • +
  • +

    --layout-data-set | --lds (string)

    +
      +
    • Specifies name of the data set that contains the layout member.
      +Example: -lds fmmvs.layout.dataset.
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Copying a data set:

    +
      +
    • zowe file-master-plus copy data-set fmmvs.pds1 fmmvs.pds2
    • +
    +
  • +
  • +

    Copying a data set with dynamic selection criteria:

    +
      +
    • zowe file-master-plus copy data-set fmmvs.from.ps fmmvs.to.ps --lds fmmvs.layout.dataset --lm testlay --dsc ./fmmvs/selcri/testcri
    • +
    +
  • +
  • +

    Copying a PDSE V2 data set with all generations:

    +
      +
    • zowe file-master-plus copy data-set fmmvs.from.psdsev2 fmmvs.to.psdsev2 --generation *
    • +
    +
  • +
+

zowefile-master-pluscreate

+

Create a data set.

+

zowefile-master-pluscreatelarge-format-sequential

+

Create a large format sequential data set.

+

Usage

+

zowe file-master-plus create large-format-sequential <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model large format sequential data set name for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --logical-record-length | --lrecl | --lrl (number)

    +
      +
    • Specifies the length of the logical record.
      +Allowed values: 1-32760
      +Default value: 80
      +Example: --lrecl 80
    • +
    +
  • +
  • +

    --block-size | --blksize | --bs (number)

    +
      +
    • Specifies the size of the block of records.
      +Allowed values: 1-32760
      +Default value: 6160
      +Example: --blksize 6160
    • +
    +
  • +
  • +

    --record-format | --recfm | --rf (string)

    +
      +
    • +

      Specifies the record format.
      +The allowed values which have the following meaning:
      +F - Fixed-length records
      +V - Variable-length records
      +U - Undefined-length records
      +B - Records are blocked
      +A - Records contain ASCII printer control characters
      +M - Records contain machine code control characters
      +S - For variable-length records, records may span blocks
      +T - Records may be written into overflow tracks
      +Default value: FB
      +Example: --recfm FB

      +

      Allowed values: F, FA, FM, FB, FBA, FBM, FS, FSA, FSM, FT, FTA, FTM, FBS, FBT, U, UA, UM, UT, UTA, UTM, V, VA, VM, VB, VBA, VBM, VS, VSA, VSM, VT, VTA, VTM, VBS, VBT

      +
    • +
    +
  • +
  • +

    --space-units | --su (string)

    +
      +
    • +

      Specifies the space allocation unit.
      +The allowed values which have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +BLK - Blocksize
      +Default value: CYL
      +Example: --su blk

      +

      Allowed values: TRK, CYL, BLK

      +
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • Specifies primary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ps 3
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • Specifies secondary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ss 5
    • +
    +
  • +
  • +

    --volume | -v (array)

    +
      +
    • Specifies a disk volume or specific tapes.
      +Example: -v vol002
    • +
    +
  • +
  • +

    --unit-type | --ut (string)

    +
      +
    • Specifies the DASD unit name.
      +Example: --ut sysda
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a large format sequential data set with default option values:

    +
      +
    • zowe file-master-plus create large-format-sequential fmmvs.test.dsname
    • +
    +
  • +
  • +

    Creating a large format sequential data set with options:

    +
      +
    • zowe file-master-plus create large-format-sequential fmmvs.test.dsname --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 -v vol005 --su trk --ed 2025-09-27
    • +
    +
  • +
  • +

    Creating a large format sequential data set like a model large format sequential data set:

    +
      +
    • zowe file-master-plus create large-format-sequential fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a large format sequential data set like a model large format sequential data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create large-format-sequential fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm VB --ps 5 --ss 5 --ed p
    • +
    +
  • +
+

zowefile-master-pluscreatelike-model

+

Create a data set by allocating parameters from a model data set.

+

Usage

+

zowe file-master-plus create like-model <name> <model> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
  • +

    model (string)

    +
      +
    • Specifies the name of the model data set.
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a data set like a model data set:

    +
      +
    • zowe file-master-plus create like-model fmmvs.create.dsname fmmvs.model.dsname
    • +
    +
  • +
+

zowefile-master-pluscreatepartitioned-data-set

+

Create a partitioned data set.

+

Usage

+

zowe file-master-plus create partitioned-data-set <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model partitioned data set for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --logical-record-length | --lrecl | --lrl (number)

    +
      +
    • Specifies the length of the logical record.
      +Allowed values: 1-32760
      +Default value: 80
      +Example: --lrecl 80
    • +
    +
  • +
  • +

    --block-size | --blksize | --bs (number)

    +
      +
    • Specifies the size of the block of records.
      +Allowed values: 1-32760
      +Default value: 6160
      +Example: --blksize 6160
    • +
    +
  • +
  • +

    --record-format | --recfm | --rf (string)

    +
      +
    • +

      Specifies the record format.
      +The allowed values have the following meaning:
      +F - Fixed-length records
      +V - Variable-length records
      +U - Undefined-length records
      +B - Records are blocked
      +A - Records contain ASCII printer control characters
      +M - Records contain machine code control characters
      +S - For variable-length records, records may span blocks
      +T - Records may be written into overflow tracks
      +Default value: FB
      +Example: --recfm FB

      +

      Allowed values: F, FA, FM, FB, FBA, FBM, FS, FSA, FSM, FT, FTA, FTM, FBS, FBT, U, UA, UM, UT, UTA, UTM, V, VA, VM, VB, VBA, VBM, VS, VSA, VSM, VT, VTA, VTM, VBS, VBT

      +
    • +
    +
  • +
  • +

    --space-units | --su (string)

    +
      +
    • +

      Specifies the space allocation unit.
      +The allowed values which have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +BLK - Blocksize
      +Default value: CYL
      +Example: --su blk

      +

      Allowed values: TRK, CYL, BLK

      +
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • Specifies the primary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ps 3
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • Specifies the secondary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ss 5
    • +
    +
  • +
  • +

    --directory-blocks | --db (number)

    +
      +
    • Specifies number of directory blocks.
      +Allowed values: 1-16777215
      +Default value: 5
      +Example: --db 5
    • +
    +
  • +
  • +

    --volume | -v (string)

    +
      +
    • Specifies a disk volume or specific tapes.
      +Example: -v vol002
    • +
    +
  • +
  • +

    --unit-type | --ut (string)

    +
      +
    • Specifies the DASD unit name.
      +Example: --ut sysda
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a PDS with default option values:

    +
      +
    • zowe file-master-plus create partitioned-data-set fmmvs.test.dsname
    • +
    +
  • +
  • +

    Creating a PDS with options:

    +
      +
    • zowe file-master-plus create partitioned-data-set fmmvs.test.dsname --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 --db 5 -v vol005 --su trk --ed p
    • +
    +
  • +
  • +

    Creating a PDS like a model PDS:

    +
      +
    • zowe file-master-plus create partitioned-data-set fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a PDS like a model PDS and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create partitioned-data-set fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm vb --ps 5 --ss 5 --db 5 -v vol005 --ed 2025-09-27
    • +
    +
  • +
+

zowefile-master-pluscreatepartitioned-data-set-extended

+

Create an extended partitioned data set.

+

Usage

+

zowe file-master-plus create partitioned-data-set-extended <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model extentded partitioned data set name for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --data-set-version | --dsv | --ver (number)

    +
      +
    • +

      Specifies the data set version.
      +Default value depends on the system settings.
      +Example: --ver 2

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --generations | -g (number)

    +
      +
    • Specifies the number of generations.
      +Applicable when data set version is '2'.
      +Default value: 0
      +Example: -g 10
    • +
    +
  • +
  • +

    --logical-record-length | --lrecl | --lrl (number)

    +
      +
    • Specifies the length of the logical record.
      +Allowed values: 1-32760
      +Default value: 80
      +Example: --lrecl 80
    • +
    +
  • +
  • +

    --block-size | --blksize | --bs (number)

    +
      +
    • Specifies the size of the block of records.
      +Allowed values: 1-32760
      +Default value: 6160
      +Example: --blksize 6160
    • +
    +
  • +
  • +

    --record-format | --recfm | --rf (string)

    +
      +
    • +

      Specifies the record format.
      +The allowed values which have the following meaning:
      +F - Fixed-length records
      +V - Variable-length records
      +U - Undefined-length records
      +B - Records are blocked
      +A - Records contain ASCII printer control characters
      +M - Records contain machine code control characters
      +S - For variable-length records, records may span blocks
      +T - Records may be written into overflow tracks
      +Default value: FB
      +Example: --recfm FB

      +

      Allowed values: F, FA, FM, FB, FBA, FBM, FS, FSA, FSM, FT, FTA, FTM, FBS, FBT, U, UA, UM, UT, UTA, UTM, V, VA, VM, VB, VBA, VBM, VS, VSA, VSM, VT, VTA, VTM, VBS, VBT

      +
    • +
    +
  • +
  • +

    --space-units | --su (string)

    +
      +
    • +

      Specifies the space allocation unit.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +BLK - Blocksize
      +Default value: CYL
      +Example: --su blk

      +

      Allowed values: TRK, CYL, BLK

      +
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • Specifies primary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ps 3
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • Specifies secondary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ss 5
    • +
    +
  • +
  • +

    --volume | -v (string)

    +
      +
    • Specifies a disk volume or specific tapes.
      +Example: -v vol002
    • +
    +
  • +
  • +

    --unit-type | --ut (string)

    +
      +
    • Specifies the DASD unit name.
      +Example: --ut sysda
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a PDSE with default option values:

    +
      +
    • zowe file-master-plus create partitioned-data-set-extended fmmvs.test.dsname
    • +
    +
  • +
  • +

    Creating a PDSE version 2 with options:

    +
      +
    • zowe file-master-plus create partitioned-data-set-extended fmmvs.test.dsname --ver 2 -g 10 --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 -v vol005 --su trk --ed 2025-09-27
    • +
    +
  • +
  • +

    Creating a PDSE data set like a model PDSE:

    +
      +
    • zowe file-master-plus create partitioned-data-set-extended fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a PDSE like a model PDSE and the parameters with options:

    +
      +
    • zowe file-master-plus create partitioned-data-set-extended fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm vb --ps 5 --ss 5 --db 5 -v vol005 --ed p
    • +
    +
  • +
+

zowefile-master-pluscreatephysical-sequential

+

Create a physical sequential data set.

+

Usage

+

zowe file-master-plus create physical-sequential <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model physical sequential data set name for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --logical-record-length | --lrecl | --lrl (number)

    +
      +
    • Specifies the length of the logical record.
      +Allowed values: 1-32760
      +Default value: 80
      +Example: --lrecl 80
    • +
    +
  • +
  • +

    --block-size | --blksize | --bs (number)

    +
      +
    • Specifies the size of the block of records.
      +Allowed values: 1-32760
      +Default value: 6160
      +Example: --blksize 6160
    • +
    +
  • +
  • +

    --record-format | --recfm | --rf (string)

    +
      +
    • +

      Specifies the record format.
      +The allowed values which have the following meaning:
      +F - Fixed-length records
      +V - Variable-length records
      +U - Undefined-length records
      +B - Records are blocked
      +A - Records contain ASCII printer control characters
      +M - Records contain machine code control characters
      +S - For variable-length records, records may span blocks
      +T - Records may be written into overflow tracks
      +Default value: FB
      +Example: --recfm FB

      +

      Allowed values: F, FA, FM, FB, FBA, FBM, FS, FSA, FSM, FT, FTA, FTM, FBS, FBT, U, UA, UM, UT, UTA, UTM, V, VA, VM, VB, VBA, VBM, VS, VSA, VSM, VT, VTA, VTM, VBS, VBT

      +
    • +
    +
  • +
  • +

    --space-units | --su (string)

    +
      +
    • +

      Specifies the space allocation unit.
      +The allowed values which have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +BLK - Blocksize
      +Default value: CYL
      +Example: --su blk

      +

      Allowed values: TRK, CYL, BLK

      +
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • Specifies primary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ps 3
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • Specifies secondary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ss 5
    • +
    +
  • +
  • +

    --volume | -v (array)

    +
      +
    • Specifies a disk volume or specific tapes.
      +Example: -v vol002
    • +
    +
  • +
  • +

    --unit-type | --ut (string)

    +
      +
    • Specifies the DASD unit name.
      +Example: --ut sysda
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a physical sequential data set with default option values:

    +
      +
    • zowe file-master-plus create physical-sequential fmmvs.test.dsname
    • +
    +
  • +
  • +

    Creating a physical sequential data set with options:

    +
      +
    • zowe file-master-plus create physical-sequential fmmvs.test.dsname --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 -v vol005 --su trk --ed 2025-09-27
    • +
    +
  • +
  • +

    Creating a physical sequential data set like a model physical sequential data set:

    +
      +
    • zowe file-master-plus create physical-sequential fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a physical sequential data set like a model physical sequential data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create physical-sequential fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm VB --ps 5 --ss 5 --ed p
    • +
    +
  • +
+

zowefile-master-pluscreatevsam-esds

+

Create an entry-sequenced Virtual Storage Access Method (VSAM) data set (ESDS).

+

Usage

+

zowe file-master-plus create vsam-esds <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a ESDS (entry-sequenced VSAM data set) for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --maximum-record-size | --mrs (number)

    +
      +
    • Specifies the maximum length of data records.
      +This parameter is mandatory unless a model data set is specified.
      +Example: --mrs 180
    • +
    +
  • +
  • +

    --average-record-size | --ars (number)

    +
      +
    • Specifies the average length of data records.
      +If this parameter is not specified then it is set to the same as the maximum-record-size option.
      +Example: --ars 110
    • +
    +
  • +
  • +

    --data-dsname | --ddsn (string)

    +
      +
    • Specifies the data set name of the data VSAM component.
      +If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
      +Example: --ddsn fmmvs.vsam.esds.data
    • +
    +
  • +
  • +

    --data-control-interval-size | --dcis (number)

    +
      +
    • Specifies the size of the Control Interval for the data VSAM component.
      +Default value: 20480
      +Example: --dcis 3584
    • +
    +
  • +
  • +

    --data-space-units | --dsu (string)

    +
      +
    • +

      Specifies the space allocation unit for data vsam component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --dsu rec

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --data-primary-space | --dps (number)

    +
      +
    • Specifies the primary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 18
      +Example: --dps 3
    • +
    +
  • +
  • +

    --data-secondary-space | --dss (number)

    +
      +
    • Specifies the secondary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 3
      +Example: --dss 5
    • +
    +
  • +
  • +

    --data-volume | --dv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the data VSAM component.
      +Example: -dv vol002
    • +
    +
  • +
  • +

    --buffer-space | --bs (number)

    +
      +
    • Specifies the minimum buffer space to allocate when this VSAM file is accessed.
      +Example: --bs 37376
    • +
    +
  • +
  • +

    --erase | -e (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
      +Default value: n
      +Example: -e y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --load-restartable | --lr (string)

    +
      +
    • +

      Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
      +Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
      +Default value: n
      +Example: -lr y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --reuse | -r (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.
      +Default value: n
      +Example: -r y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --spanned | -s (string)

    +
      +
    • +

      Indicates whether VSAM file was allocated with the SPANNED parameter indicating that data records larger than a control interval can span multiple control intervals.
      +Default value: n
      +Example: -s y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --write-check | --wc (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.
      +Default value: n
      +Example: --wc y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --control-interval-freespace-percentage | --cifp (number)

    +
      +
    • Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
      +Example: --cifp 10
    • +
    +
  • +
  • +

    --control-area-freespace-percentage | --cafp (number)

    +
      +
    • Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
      +Example: --cafp 10
    • +
    +
  • +
  • +

    --cross-region-share-option | --crso (number)

    +
      +
    • +

      Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
      +The allowed values have the following meaning:
      +1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
      +2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 1
      +Example: --crso 2

      +

      Allowed values: 1, 2, 3, 4

      +
    • +
    +
  • +
  • +

    --cross-system-share-option | --csso (number)

    +
      +
    • +

      Specifies how the file can be shared among systems.
      +The allowed values have the following meaning:
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 3
      +Example: --csso 4

      +

      Allowed values: 3, 4

      +
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
  • +

    --log | -l (string)

    +
      +
    • +

      When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
      +Example: --log ALL

      +

      Allowed values: NONE, UNDO, ALL

      +
    • +
    +
  • +
  • +

    --frlog | --fr (string)

    +
      +
    • +

      Specifies the type of VSAM batch logging to perform for this VSAM data set.
      +The allowed values have the following meaning:
      +NONE - Disables VSAM batch logging.
      +REDO - Enables VSAM batch logging.
      +UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
      +ALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.
      +Example: --frlog ALL

      +

      Allowed values: NONE, UNDO, ALL, REDO

      +
    • +
    +
  • +
  • +

    --log-replicate | --lrp (string)

    +
      +
    • +

      Specify 'Y' to enable VSAM replication for this data set.
      +Example: --lrp y

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
  • +

    --log-stream-id | --lsi (string)

    +
      +
    • Specifies the 1- to 26-character name of the forward recovery log stream.
      +Example: --lsi LOGSTRA
    • +
    +
  • +
  • +

    --rls-enable | --rls | --re (string)

    +
      +
    • +

      Specify 'N' to disable VSAM record-level sharing.
      +Default value: y
      +Example: --rls n

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a ESDS with default option values and mandatory options:

    +
      +
    • zowe file-master-plus create vsam-esds fmmvs.test.dsname --mrs 160
    • +
    +
  • +
  • +

    Creating a ESDS with options:

    +
      +
    • zowe file-master-plus create vsam-esds fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed 2025-09-27
    • +
    +
  • +
  • +

    Creating a RLS enabled ESDS with logging options:

    +
      +
    • zowe file-master-plus create vsam-esds fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --rls y -l all --lsi loga --lrp y --fr ALL
    • +
    +
  • +
  • +

    Creating a ESDS data set like a model ESDS data set:

    +
      +
    • zowe file-master-plus create vsam-esds fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a ESDS like a model ESDS data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create vsam-esds fmmvs.test.dsname --model fmmvs.model.dsname --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed p
    • +
    +
  • +
+

zowefile-master-pluscreatevsam-ksds

+

Create a key-sequenced data set (KSDS) Virtual Storage Access Method (VSAM) data set.

+

Usage

+

zowe file-master-plus create vsam-ksds <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model KSDS (key-sequenced VSAM data set) for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --keys-position | --kp (number)

    +
      +
    • Specifies the position of the key within the base cluster.
      +This parameter is mandatory unless a model data set is specified.
      +Example: --kp 1
    • +
    +
  • +
  • +

    --keys-length | --kl (number)

    +
      +
    • Specifies the length of the key within the base cluster.
      +This parameter is mandatory unless a model data set is specified.
      +Example: --kl 7
    • +
    +
  • +
  • +

    --maximum-record-size | --mrs (number)

    +
      +
    • Specifies the maximum length of data records.
      +This parameter is mandatory unless a model data set is specified.
      +Example: --mrs 180
    • +
    +
  • +
  • +

    --average-record-size | --ars (number)

    +
      +
    • Specifies the average length of data records.
      +If this parameter is not specified then it is set to the same as the maximum-record-size option.
      +Example: --ars 110
    • +
    +
  • +
  • +

    --data-dsname | --ddsn (string)

    +
      +
    • Specifies the data set name of the data VSAM component.
      +If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
      +Example: --ddsn fmmvs.vsam.ksds.data
    • +
    +
  • +
  • +

    --data-control-interval-size | --dcis (number)

    +
      +
    • Specifies the size of the Control Interval for the data VSAM component.
      +Default value: 20480
      +Example: --dcis 3584
    • +
    +
  • +
  • +

    --data-space-units | --dsu (string)

    +
      +
    • +

      Specifies the space allocation unit for data vsam component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --dsu rec

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --data-primary-space | --dps (number)

    +
      +
    • Specifies the primary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 18
      +Example: --dps 3
    • +
    +
  • +
  • +

    --data-secondary-space | --dss (number)

    +
      +
    • Specifies the secondary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 3
      +Example: --dss 5
    • +
    +
  • +
  • +

    --data-volume | --dv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the data VSAM component.
      +Example: -dv vol002
    • +
    +
  • +
  • +

    --index-dsname | --idsn (string)

    +
      +
    • Specifies the data set name of the index VSAM component.
      +If this parameter is not specified then it is set to the cluster name with ‘.INDEX’ appended.
      +Example: --ddsn fmmvs.vsam.ksds.index
    • +
    +
  • +
  • +

    --index-control-interval-size | --icis (number)

    +
      +
    • Specifies the size of Control Interval for index VSAM component.
      +Default value: 512
      +Example: --icis 3584
    • +
    +
  • +
  • +

    --index-space-units | --isu (string)

    +
      +
    • +

      Specifies the space allocation unit for index VSAM component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --isu cyl

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --index-primary-space | --ips (number)

    +
      +
    • Specifies primary space allocation unit for index VSAM component.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ips 3
    • +
    +
  • +
  • +

    --index-secondary-space | --iss (number)

    +
      +
    • Specifies secondary space allocation unit for index VSAM component.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --iss 5
    • +
    +
  • +
  • +

    --index-volume | --iv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the index VSAM component.
      +Example: -iv vol002
    • +
    +
  • +
  • +

    --buffer-space | --bs (number)

    +
      +
    • Specifies the minimum buffer space to allocate when this VSAM file is accessed.
      +Example: --bs 37376
    • +
    +
  • +
  • +

    --erase | -e (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
      +Default value: n
      +Example: -e y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --load-restartable | --lr (string)

    +
      +
    • +

      Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
      +Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
      +Default value: n
      +Example: -lr y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --reuse | -r (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.
      +Default value: n
      +Example: -r y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --spanned | -s (string)

    +
      +
    • +

      Indicates whether VSAM file was allocated with the SPANNED parameter indicating that data records larger than a control interval can span multiple control intervals.
      +Default value: n
      +Example: -s y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --write-check | --wc (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.
      +Default value: n
      +Example: --wc y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --control-interval-freespace-percentage | --cifp (number)

    +
      +
    • Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
      +Example: --cifp 10
    • +
    +
  • +
  • +

    --control-area-freespace-percentage | --cafp (number)

    +
      +
    • Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
      +Example: --cafp 10
    • +
    +
  • +
  • +

    --cross-region-share-option | --crso (number)

    +
      +
    • +

      Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
      +The allowed values have the following meaning:
      +1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
      +2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 1
      +Example: --crso 2

      +

      Allowed values: 1, 2, 3, 4

      +
    • +
    +
  • +
  • +

    --cross-system-share-option | --csso (number)

    +
      +
    • +

      Specifies how the file can be shared among systems.
      +The allowed values have the following meaning:
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 3
      +Example: --csso 4

      +

      Allowed values: 3, 4

      +
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
  • +

    --log | -l (string)

    +
      +
    • +

      When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
      +Example: --log ALL

      +

      Allowed values: NONE, UNDO, ALL

      +
    • +
    +
  • +
  • +

    --frlog | --fr (string)

    +
      +
    • +

      Specifies the type of VSAM batch logging to perform for this VSAM data set.
      +The allowed values have the following meaning:
      +NONE - Disables VSAM batch logging.
      +REDO - Enables VSAM batch logging.
      +UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
      +ALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.
      +Example: --frlog ALL

      +

      Allowed values: NONE, UNDO, ALL, REDO

      +
    • +
    +
  • +
  • +

    --log-replicate | --lrp (string)

    +
      +
    • +

      Specify 'Y' to enable VSAM replication for this data set.
      +Example: --lrp y

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
  • +

    --log-stream-id | --lsi (string)

    +
      +
    • Specifies the 1- to 26-character name of the forward recovery log stream.
      +Example: --lsi LOGSTRA
    • +
    +
  • +
  • +

    --rls-enable | --rls | --re (string)

    +
      +
    • +

      Specify 'N' to disable VSAM record-level sharing.
      +Default value: y
      +Example: --rls n

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a KSDS with default option values and mandatory options:

    +
      +
    • zowe file-master-plus create vsam-ksds fmmvs.test.dsname --kp 1 --kl 7 --mrs 160
    • +
    +
  • +
  • +

    Creating a KSDS with options:

    +
      +
    • zowe file-master-plus create vsam-ksds fmmvs.test.dsname --kp 1 --kl 7 --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y -s n --ed 2025-09-27
    • +
    +
  • +
  • +

    Creating a RLS enabled KSDS with logging options:

    +
      +
    • zowe file-master-plus create vsam-ksds fmmvs.test.dsname --kp 1 --kl 7 --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y -s n --rls y -l all --lsi loga --lrp y --fr ALL
    • +
    +
  • +
  • +

    Creating a KSDS data set like a model KSDS data set:

    +
      +
    • zowe file-master-plus create vsam-ksds fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a KSDS like a model KSDS data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create vsam-ksds fmmvs.test.dsname --model fmmvs.model.dsname --kp 1 --kl 7 --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed p
    • +
    +
  • +
+

zowefile-master-pluscreatevsam-lds

+

Create linear data set (LDS) Virtual Storage Access Method (VSAM) data set.

+

Usage

+

zowe file-master-plus create vsam-lds <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model LDS (Linear VSAM data set) for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --data-dsname | --ddsn (string)

    +
      +
    • Specifies the data set name of the data VSAM component.
      +If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
      +Example: --ddsn fmmvs.vsam.esds.data
    • +
    +
  • +
  • +

    --data-control-interval-size | --dcis (number)

    +
      +
    • Specifies the size of the Control Interval for the data VSAM component.
      +Default value: 4096
      +Example: --dcis 3584
    • +
    +
  • +
  • +

    --data-space-units | --dsu (string)

    +
      +
    • +

      Specifies the space allocation unit for data vsam component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --dsu rec

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --data-primary-space | --dps (number)

    +
      +
    • Specifies the primary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 18
      +Example: --dps 3
    • +
    +
  • +
  • +

    --data-secondary-space | --dss (number)

    +
      +
    • Specifies the secondary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 3
      +Example: --dss 5
    • +
    +
  • +
  • +

    --data-volume | --dv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the data VSAM component.
      +Example: -dv vol002
    • +
    +
  • +
  • +

    --buffer-space | --bs (number)

    +
      +
    • Specifies the minimum buffer space to allocate when this VSAM file is accessed.
      +Example: --bs 37376
    • +
    +
  • +
  • +

    --erase | -e (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
      +Default value: n
      +Example: -e y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --load-restartable | --lr (string)

    +
      +
    • +

      Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
      +Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
      +Default value: n
      +Example: -lr y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --reuse | -r (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.
      +Default value: n
      +Example: -r y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --write-check | --wc (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.
      +Default value: n
      +Example: --wc y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --control-interval-freespace-percentage | --cifp (number)

    +
      +
    • Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
      +Example: --cifp 10
    • +
    +
  • +
  • +

    --control-area-freespace-percentage | --cafp (number)

    +
      +
    • Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
      +Example: --cafp 10
    • +
    +
  • +
  • +

    --cross-region-share-option | --crso (number)

    +
      +
    • +

      Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
      +The alloweThe allowed values have the following meaning:
      +1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
      +2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 1
      +Example: --crso 2

      +

      Allowed values: 1, 2, 3, 4

      +
    • +
    +
  • +
  • +

    --cross-system-share-option | --csso (number)

    +
      +
    • +

      Specifies how the file can be shared among systems.
      +The allowed values have the following meaning:
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 3
      +Example: --csso 4

      +

      Allowed values: 3, 4

      +
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a LDS with default option values:

    +
      +
    • zowe file-master-plus create vsam-lds fmmvs.test.dsname
    • +
    +
  • +
  • +

    Creating a LDS with options:

    +
      +
    • zowe file-master-plus create vsam-lds fmmvs.test.dsname --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed p
    • +
    +
  • +
  • +

    Creating a LDS data set like a model LDS data set:

    +
      +
    • zowe file-master-plus create vsam-lds fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a LDS like a model LDS data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create vsam-lds fmmvs.test.dsname --model fmmvs.model.dsname --wc y --bs 37376 --crso 3 --csso 4 --ed 2025-09-27
    • +
    +
  • +
+

zowefile-master-pluscreatevsam-rrds

+

Create a relative-record data set (RRDS) Virtual Storage Access Method (VSAM) data set.

+

Usage

+

zowe file-master-plus create vsam-rrds <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model RRDS (relative-record VSAM data set) for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --maximum-record-size | --mrs (number)

    +
      +
    • Specifies the maximum length of data records.
      +This parameter is mandatory unless a model data set is specified.
      +Example: --mrs 180
    • +
    +
  • +
  • +

    --data-dsname | --ddsn (string)

    +
      +
    • Specifies the data set name of the data VSAM component.
      +If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
      +Example: --ddsn fmmvs.vsam.rrds.data
    • +
    +
  • +
  • +

    --data-control-interval-size | --dcis (number)

    +
      +
    • Specifies the size of the Control Interval for the data VSAM component.
      +Default value: 20480
      +Example: --dcis 3584
    • +
    +
  • +
  • +

    --data-space-units | --dsu (string)

    +
      +
    • +

      Specifies the space allocation unit for data vsam component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --dsu rec

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --data-primary-space | --dps (number)

    +
      +
    • Specifies the primary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 18
      +Example: --dps 3
    • +
    +
  • +
  • +

    --data-secondary-space | --dss (number)

    +
      +
    • Specifies the secondary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 3
      +Example: --dss 5
    • +
    +
  • +
  • +

    --data-volume | --dv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the data VSAM component.
      +Example: -dv vol002
    • +
    +
  • +
  • +

    --buffer-space | --bs (number)

    +
      +
    • Specifies the minimum buffer space to allocate when this VSAM file is accessed.
      +Example: --bs 37376
    • +
    +
  • +
  • +

    --erase | -e (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
      +Default value: n
      +Example: -e y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --load-restartable | --lr (string)

    +
      +
    • +

      Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
      +Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
      +Default value: n
      +Example: -lr y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --reuse | -r (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.
      +Default value: n
      +Example: -r y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --write-check | --wc (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.
      +Default value: n
      +Example: --wc y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --control-interval-freespace-percentage | --cifp (number)

    +
      +
    • Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
      +Example: --cifp 10
    • +
    +
  • +
  • +

    --control-area-freespace-percentage | --cafp (number)

    +
      +
    • Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
      +Example: --cafp 10
    • +
    +
  • +
  • +

    --cross-region-share-option | --crso (number)

    +
      +
    • +

      Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
      +The allowed values have the following meaning:
      +1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
      +2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 1
      +Example: --crso 2

      +

      Allowed values: 1, 2, 3, 4

      +
    • +
    +
  • +
  • +

    --cross-system-share-option | --csso (number)

    +
      +
    • +

      Specifies how the file can be shared among systems.
      +The allowed values have the following meaning:
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 3
      +Example: --csso 4

      +

      Allowed values: 3, 4

      +
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
  • +

    --log | -l (string)

    +
      +
    • +

      When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
      +Example: --log ALL

      +

      Allowed values: NONE, UNDO, ALL

      +
    • +
    +
  • +
  • +

    --frlog | --fr (string)

    +
      +
    • +

      Specifies the type of VSAM batch logging to perform for this VSAM data set.
      +The allowed values have the following meaning:
      +NONE - Disables VSAM batch logging.
      +REDO - Enables VSAM batch logging.
      +UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
      +ALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.
      +Example: --frlog ALL

      +

      Allowed values: NONE, UNDO, ALL, REDO

      +
    • +
    +
  • +
  • +

    --log-replicate | --lrp (string)

    +
      +
    • +

      Specify 'Y' to enable VSAM replication for this data set.
      +Example: --lrp y

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
  • +

    --log-stream-id | --lsi (string)

    +
      +
    • Specifies the 1- to 26-character name of the forward recovery log stream.
      +Example: --lsi LOGSTRA
    • +
    +
  • +
  • +

    --rls-enable | --rls | --re (string)

    +
      +
    • +

      Specify 'N' to disable VSAM record-level sharing.
      +Default value: y
      +Example: --rls n

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a RRDS with default option values and mandatory options:

    +
      +
    • zowe file-master-plus create vsam-rrds fmmvs.test.dsname --mrs 160
    • +
    +
  • +
  • +

    Creating a RRDS with options:

    +
      +
    • zowe file-master-plus create vsam-rrds fmmvs.test.dsname --mrs 160 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed p
    • +
    +
  • +
  • +

    Creating a RLS enabled RRDS with logging options:

    +
      +
    • zowe file-master-plus create vsam-rrds fmmvs.test.dsname --mrs 160 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed p --rls y -l all --lsi loga --lrp y --fr ALL
    • +
    +
  • +
  • +

    Creating a RRDS data set like a model RRDS data set:

    +
      +
    • zowe file-master-plus create vsam-rrds fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a RRDS like a model RRDS data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create vsam-rrds fmmvs.test.dsname --model fmmvs.model.dsname --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed 2025-09-27
    • +
    +
  • +
+

zowefile-master-pluscreatevsam-vrrds

+

Create a variable-length relative-record data set (VRRDS) Virtual Storage Access Method (VSAM) data set.

+

Usage

+

zowe file-master-plus create vsam-vrrds <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model VRRDS (variable-length relative-record VSAM data set) for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --maximum-record-size | --mrs (number)

    +
      +
    • Specifies the maximum length of data records.
      +This parameter is mandatory unless a model data set is specified and it should be greater than the average record size.
      +Example: --mrs 180
    • +
    +
  • +
  • +

    --average-record-size | --ars (number)

    +
      +
    • Specifies the average length of data records.
      +This parameter is mandatory unless a model data set is specified and it should be less than the maximum record size.
      +Example: --ars 110
    • +
    +
  • +
  • +

    --data-dsname | --ddsn (string)

    +
      +
    • Specifies the data set name of the data VSAM component.
      +If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
      +Example: --ddsn fmmvs.vsam.ksds.data
    • +
    +
  • +
  • +

    --data-control-interval-size | --dcis (number)

    +
      +
    • Specifies the size of the Control Interval for the data VSAM component.
      +Default value: 20480
      +Example: --dcis 3584
    • +
    +
  • +
  • +

    --data-space-units | --dsu (string)

    +
      +
    • +

      Specifies the space allocation unit for data vsam component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --dsu rec

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --data-primary-space | --dps (number)

    +
      +
    • Specifies the primary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 18
      +Example: --dps 3
    • +
    +
  • +
  • +

    --data-secondary-space | --dss (number)

    +
      +
    • Specifies the secondary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 3
      +Example: --dss 5
    • +
    +
  • +
  • +

    --data-volume | --dv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the data VSAM component.
      +Example: -dv vol002
    • +
    +
  • +
  • +

    --index-dsname | --idsn (string)

    +
      +
    • Specifies the data set name of the index VSAM component.
      +If this parameter is not specified then it is set to the cluster name with ‘.INDEX’ appended.
      +Example: --ddsn fmmvs.vsam.ksds.index
    • +
    +
  • +
  • +

    --index-control-interval-size | --icis (number)

    +
      +
    • Specifies the size of Control Interval for index VSAM component.
      +Default value: 512
      +Example: --icis 3584
    • +
    +
  • +
  • +

    --index-space-units | --isu (string)

    +
      +
    • +

      Specifies the space allocation unit for index VSAM component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --isu cyl

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --index-primary-space | --ips (number)

    +
      +
    • Specifies primary space allocation unit for index VSAM component.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ips 3
    • +
    +
  • +
  • +

    --index-secondary-space | --iss (number)

    +
      +
    • Specifies secondary space allocation unit for index VSAM component.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --iss 5
    • +
    +
  • +
  • +

    --index-volume | --iv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the data VSAM component.
      +Example: -iv vol002
    • +
    +
  • +
  • +

    --buffer-space | --bs (number)

    +
      +
    • Specifies the minimum buffer space to allocate when this VSAM file is accessed.
      +Example: --bs 37376
    • +
    +
  • +
  • +

    --erase | -e (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
      +Default value: n
      +Example: -e y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --load-restartable | --lr (string)

    +
      +
    • +

      Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
      +Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
      +Default value: n
      +Example: -lr y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --reuse | -r (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.
      +Default value: n
      +Example: -r y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --write-check | --wc (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.
      +Default value: n
      +Example: --wc y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --control-interval-freespace-percentage | --cifp (number)

    +
      +
    • Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
      +Example: --cifp 10
    • +
    +
  • +
  • +

    --control-area-freespace-percentage | --cafp (number)

    +
      +
    • Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
      +Example: --cafp 10
    • +
    +
  • +
  • +

    --cross-region-share-option | --crso (number)

    +
      +
    • +

      Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
      +The allowed values have the following meaning:
      +1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
      +2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 1
      +Example: --crso 2

      +

      Allowed values: 1, 2, 3, 4

      +
    • +
    +
  • +
  • +

    --cross-system-share-option | --csso (number)

    +
      +
    • +

      Specifies how the file can be shared among systems.
      +The allowed values have the following meaning:
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 3
      +Example: --csso 4

      +

      Allowed values: 3, 4

      +
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
  • +

    --log | -l (string)

    +
      +
    • +

      When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
      +Example: --log ALL

      +

      Allowed values: NONE, UNDO, ALL

      +
    • +
    +
  • +
  • +

    --frlog | --fr (string)

    +
      +
    • +

      Specifies the type of VSAM batch logging to perform for this VSAM data set.
      +The allowed values have the following meaning:
      +NONE - Disables VSAM batch logging.
      +REDO - Enables VSAM batch logging.
      +UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
      +ALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.
      +Example: --frlog ALL

      +

      Allowed values: NONE, UNDO, ALL, REDO

      +
    • +
    +
  • +
  • +

    --log-replicate | --lrp (string)

    +
      +
    • +

      Specify 'Y' to enable VSAM replication for this data set.
      +Example: --lrp y

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
  • +

    --log-stream-id | --lsi (string)

    +
      +
    • Specifies the 1- to 26-character name of the forward recovery log stream.
      +Example: --lsi LOGSTRA
    • +
    +
  • +
  • +

    --rls-enable | --rls | --re (string)

    +
      +
    • +

      Specify 'N' to disable VSAM record-level sharing.
      +Default value: y
      +Example: --rls n

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a VRRDS with default option values and mandatory options:

    +
      +
    • zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --mrs 160
    • +
    +
  • +
  • +

    Creating a VRRDS with options:

    +
      +
    • zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y --ed 2025-09-27
    • +
    +
  • +
  • +

    Creating a RLS enabled VRRDS with logging options:

    +
      +
    • zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y --rls y -l all --lsi loga --lrp y --fr ALL
    • +
    +
  • +
  • +

    Creating a VRRDS data set like a model VRRDS data set:

    +
      +
    • zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a VRRDS like a model VRRDS data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --model fmmvs.model.dsname --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed p
    • +
    +
  • +
+

zowefile-master-plusdelete

+

Permanently deletes a data set.

+

zowefile-master-plusdeletedata-set

+

Permanently deletes a data set.
+It supports all data set types that are supported by File Master Plus.

+

Usage

+

zowe file-master-plus delete data-set <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set that you want to delete.
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deleting a data set:

    +
      +
    • zowe file-master-plus delete data-set fmmvs.dsname
    • +
    +
  • +
+

zowefile-master-pluspopulate

+

Populate the specified data set with records.
+It supports all data set types that are supported by File Master Plus.

+

zowefile-master-pluspopulatedata-set

+

Populate a specific data set with records.
+The layout of the records to add are described by a Cobol or PL/I copybook.

+

Usage

+

zowe file-master-plus populate data-set <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to populate.
    • +
    +
  • +
+

Options

+
    +
  • +

    --member | -m (string)

    +
      +
    • Specifies name of the member.
      +Note: Used only if the specified data set is a PDS or PDSE.
      +Example: -m member1.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --layout-member | --lm (string)

    +
      +
    • Specifies the name of the Cobol or PL/I copybook.
      +Example: --lm testlay.
    • +
    +
  • +
  • +

    --layout-data-set | --lds (string)

    +
      +
    • Specifies the name of the data set that contains the layout member.
      +Example: --lds fmmvs.layout.dataset.
    • +
    +
  • +
  • +

    --data | -d (string)

    +
      +
    • Specifies path of the .txt/.json file of the data stream. Ensure the data stream is an array in JSON format represented by a layout data set and its member.
      +Example: -d ../instream/data1.txt
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Populating a data set:

    +
      +
    • zowe file-master-plus populate data-set fmmvs.dsname --lds fmmvs.layout.dataset --lm testlay --data ../instream/data1.txt
    • +
    +
  • +
+

zowefile-master-plusrename

+

Rename the specified data set.

+

zowefile-master-plusrenamedata-set

+

Rename a data set.
+It supports all data set types that are supported by File Master Plus.

+

Usage

+

zowe file-master-plus rename data-set <old> <new> [options]

+

Positional Arguments

+
    +
  • +

    old (string)

    +
      +
    • Specifies the name of the data set that you want to rename.
    • +
    +
  • +
  • +

    new (string)

    +
      +
    • Specifies the new name of the data set.
    • +
    +
  • +
+

Options

+
    +
  • +

    --vsam-component | --vsamc (string)

    +
      +
    • +

      Rename the data and index components of a VSAM cluster if they share the cluster name.
      +Note: Used only if the target data set is a VSAM cluster.
      +Example: --vsamc y.

      +

      Default value: n
      +Allowed values: y, n

      +
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Renaming a data set:

    +
      +
    • zowe file-master-plus rename data-set fmmvs.old.dsname fmmvs.new.dsname
    • +
    +
  • +
  • +

    Renaming a VSAM data set along with its components:

    +
      +
    • zowe file-master-plus rename data-set fmmvs.oldvsam.dsname fmmvs.newvsam.dsname --vsamc y
    • +
    +
  • +
+
+

zoweidms

+

IDMS plug-in for listing real-time monitor statistics and information, viewing DC log messages, and issuing DCMT and DCUF commands

+

zoweidmsissue

+

Issues IDMS DCMT and DCUF commands

+

zoweidmsissuedcmt-display

+

Execute a DCMT DISPLAY command

+

Usage

+

zowe idms issue dcmt-display [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT DISPLAY command arguments
    • +
    +
  • +
+

Options

+
    +
  • +

    --broadcast | -b (string)

    +
      +
    • Broadcast parameters used if the system is part of a data sharing group
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcmt display task send' command to display information associated with the SEND task:

    +
      +
    • zowe idms issue dcmt-display --args "task send"
    • +
    +
  • +
  • +

    Issues a 'dcmt display active programs' command with an IDMS profile and data source to override the default:

    +
      +
    • zowe idms issue dcmt-display --args "active programs" --idms-profile myprofile2 --datasource sysdemo
    • +
    +
  • +
+

zoweidmsissuedcmt-help

+

Execute a DCMT HELP command

+

Usage

+

zowe idms issue dcmt-help [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT HELP command arguments
    • +
    +
  • +
  • +

    --broadcast | -b (string)

    +
      +
    • Broadcast parameters used if the system is part of a data sharing group
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcmt help' command to display a summary of the syntax for DCMT commands:

    +
      +
    • zowe idms issue dcmt-help
    • +
    +
  • +
  • +

    Issues a 'dcmt help task' command with a data source to override the default:

    +
      +
    • zowe idms issue dcmt-help --args "task" --datasource sysdemo
    • +
    +
  • +
+

zoweidmsissuedcmt-quiesce

+

Execute a DCMT QUIESCE command

+

Usage

+

zowe idms issue dcmt-quiesce [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT QUIESCE command arguments. Specifies the DCMT QUIESCE target area, segment, or DBNAME
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues the command 'dcmt quiesce dbname empdemo id 1' which quiesces all areas associated with segments included in the EMPDEMO database and assigns the operation to dcmt-id 1:

    +
      +
    • zowe idms issue dcmt-quiesce --args "dbname empdemo id 1"
    • +
    +
  • +
  • +

    Issues the command 'dcmt quiesce area emp* id 2' which quiesces all areas whose segment name begins with EMP and assigns the operation to dcmt-id 2:

    +
      +
    • zowe idms issue dcmt-quiesce --args "area emp* id 2"
    • +
    +
  • +
+

zoweidmsissuedcmt-shutdown

+

Execute a DCMT SHUTDOWN command

+

Usage

+

zowe idms issue dcmt-shutdown [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT SHUTDOWN command arguments. NOPROMPT must be specified. IMMEDIATE is optional
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcmt shutdown noprompt' command to shut down the DC/UCF system while allowing all active tasks and external run units to terminate normally first:

    +
      +
    • zowe idms issue dcmt-shutdown --args "noprompt"
    • +
    +
  • +
  • +

    Issues a 'dcmt shutdown noprompt immediate' command to immediately shut down the DC/UCF system, abending all active tasks and external run units with code SHUT:

    +
      +
    • zowe idms issue dcmt-shutdown --args "noprompt immediate"
    • +
    +
  • +
+

zoweidmsissuedcmt-statistics

+

Execute a DCMT STATISTICS command

+

Usage

+

zowe idms issue dcmt-statistics [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT STATISTICS command arguments. Can specify ROLL to reset statistics to zero after writing them
    • +
    +
  • +
  • +

    --broadcast | -b (string)

    +
      +
    • Broadcast parameters used if the system is part of a data sharing group
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcmt write statistics roll' command to write the current system and line statistics and histograms to the log file and then reset their values to zero:

    +
      +
    • zowe idms issue dcmt-statistics --args "roll"
    • +
    +
  • +
+

zoweidmsissuedcmt-test

+

Execute a DCMT TEST command. Obtains diagnostic information for Broadcom technical support personnel.

+

The DCMT TEST command is used for debugging and diagnostic purposes only. Use it only when told to do so by IDMS technical support personnel. It is enabled only if certain CSA test flags are turned on

+

Usage

+

zowe idms issue dcmt-test [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT TEST command arguments. Specifies which debugging options to use
    • +
    +
  • +
+

Options

+
    +
  • +

    --broadcast | -b (string)

    +
      +
    • Broadcast parameters used if the system is part of a data sharing group
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcmt test debug options' command, with 'debug options' being the options provided by IDMS technical support:

    +
      +
    • zowe idms issue dcmt-test --args "debug options"
    • +
    +
  • +
+

zoweidmsissuedcmt-vary

+

Execute a DCMT VARY command

+

Usage

+

zowe idms issue dcmt-vary [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT VARY command arguments
    • +
    +
  • +
+

Options

+
    +
  • +

    --broadcast | -b (string)

    +
      +
    • Broadcast parameters used if the system is part of a data sharing group
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcmt vary task signon enabled' command to enable the SIGNON task:

    +
      +
    • zowe idms issue dcmt-vary --args "task signon enabled"
    • +
    +
  • +
  • +

    Issues a 'dcmt vary journal swap' command with an IDMS profile and data source to override the default:

    +
      +
    • zowe idms issue dcmt-vary --args "journal swap" --idms-profile myprofile2 --datasource sysdemo
    • +
    +
  • +
+

zoweidmsissuedcuf-help

+

Execute a DCUF HELP command

+

Usage

+

zowe idms issue dcuf-help [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcuf help' command to display a list of DCUF commands and parameters. Note: Only SHOW commands are supported by the CLI:

    +
      +
    • zowe idms issue dcuf-help
    • +
    +
  • +
+

zoweidmsissuedcuf-show

+

Execute a DCUF SHOW command

+

Usage

+

zowe idms issue dcuf-show [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --args (string)

    +
      +
    • DCUF SHOW command arguments
    • +
    +
  • +
+

Options

+
    +
  • +

    --broadcast | -b (string)

    +
      +
    • Broadcast parameters used if the system is part of a data sharing group
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcuf show tables' command to display a list of the available tables:

    +
      +
    • zowe idms issue dcuf-show --args "tables"
    • +
    +
  • +
  • +

    Issues a 'dcuf show user <username>' command to display information about a specific user:

    +
      +
    • zowe idms issue dcuf-show --args "user username"
    • +
    +
  • +
+

zoweidmslist

+

Lists available datasources, real-time monitor statistics information, log messages, active user tasks, and transaction details

+

zoweidmslistdatasources

+

Lists data sources defined to the IDMS REST API

+

Usage

+

zowe idms list datasources [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Options

+
    +
  • +

    --datasourcename | --dsn (string)

    +
      +
    • Specifies a specific datasource to view the definition of
    • +
    +
  • +
  • +

    --all | -a (boolean)

    +
      +
    • Lists each datasource defined to the IDMS REST API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Lists all data sources defined to the IDMS Rest API:

    +
      +
    • zowe idms list datasources --all
    • +
    +
  • +
  • +

    Lists a single IDMS data source identified by the data source name:

    +
      +
    • zowe idms list datasources --dsn SYSDEMO
    • +
    +
  • +
+

zoweidmslistlog

+

Lists log messages based on the search options provided

+

Usage

+

zowe idms list log [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --start-time | --st (string)

    +
      +
    • +

      Start time of the first log message

      +

      Format: 'YYYY-MM-DD HH:mm:ss[.SSSSSS]'

      +
    • +
    +
  • +
  • +

    --end-time | --et (string)

    +
      +
    • +

      End time of the last log message

      +

      Format: 'YYYY-MM-DD HH:mm:ss[.SSSSSS]'

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --record-type | --rt (string)

    +
      +
    • +

      Type of log records:

      +

      1 - #WTL text line

      +

      2 - User trace text or physical I/O trace text

      +

      3 - User binary trace entries

      +

      4 - Snap or dump text

      +

      5 - Snap or dump binary entries

      +

      Examples: '1,2', '1,4,5', '2'

      +
    • +
    +
  • +
  • +

    --record-identifier | --ri (string)

    +
      +
    • +

      Identifier contained in log messages

      +

      Examples: 'LTE0001,LTVTM011', 'DCSYSTEM', 'SYSTE160'

      +
    • +
    +
  • +
  • +

    --search-text | --stext (string)

    +
      +
    • +

      Text contained in log messages

      +

      Examples: 'DB001108', 'any_text_that_might_exist_in_the_message'

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Lists all the log messages where the time stamps satisfy the start and end time criteria:

    +
      +
    • zowe idms list log --start-time "2020-08-05 09:20:00" --end-time "2020-08-05 10:20:00"
    • +
    +
  • +
  • +

    Lists all the #WTL log messages where 'DB001108' is contained in the log message and where the time stamps satisfy the start and end time criteria:

    +
      +
    • zowe idms list log --start-time "2020-08-05 09:20:00" --end-time "2020-08-05 10:20:00" --record-type 1 --search-text DB001108
    • +
    +
  • +
  • +

    Lists all log messages with the DCSYSTEM record identifier where the time stamps satisfy the start and end time criteria:

    +
      +
    • zowe idms list log --start-time "2020-08-05 08:00:00.001234" --end-time "2020-08-05 13:43:33.26" --record-identifier DCSYSTEM
    • +
    +
  • +
+

zoweidmslistsystems

+

Lists either all active IDMS systems on an LPAR or lists information about a specific system if a jobname is provided

+

Usage

+

zowe idms list systems [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Options

+
    +
  • +

    --jobname | -j (string)

    +
      +
    • The job name of the active IDMS system
    • +
    +
  • +
  • +

    --all | -a (boolean)

    +
      +
    • Lists all active systems. This is the default behavior if no job name is provided
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Lists all active IDMS systems on the LPAR where the IDMS REST API service is running:

    +
      +
    • zowe idms list systems --all
    • +
    +
  • +
  • +

    Lists a single active IDMS system identified by the IDMS system job name:

    +
      +
    • zowe idms list systems --jobname SYSDEMO
    • +
    +
  • +
+

zoweidmslisttransactions

+

Lists transaction details on a specific IDMS system

+

Usage

+

zowe idms list transactions [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname | -j (string)

    +
      +
    • The job name of the active IDMS system
    • +
    +
  • +
  • +

    --datasourcename | --dsn (string)

    +
      +
    • The data source name of the specified IDMS system
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Lists the transaction details of the IDMS system identified by the IDMS system job name:

    +
      +
    • zowe idms list transactions --jobname SYSDEMO
    • +
    +
  • +
  • +

    Lists the transaction details of the IDMS system identified by the IDMS system job name as JSON formatted data:

    +
      +
    • zowe idms list transactions --jobname SYSDEMO --rfj
    • +
    +
  • +
+

zoweidmslistuser-tasks

+

Lists all active user tasks on a specific IDMS system

+

Usage

+

zowe idms list user-tasks [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname | -j (string)

    +
      +
    • The job name of the active IDMS system
    • +
    +
  • +
  • +

    --datasourcename | --dsn (string)

    +
      +
    • The data source name of the specified IDMS system
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Lists the active user tasks of the IDMS system identified by the IDMS system job name:

    +
      +
    • zowe idms list user-tasks --jobname SYSDEMO
    • +
    +
  • +
  • +

    Lists the active user tasks of the IDMS system identified by the IDMS system job name as JSON formatted data:

    +
      +
    • zowe idms list user-tasks --jobname SYSDEMO --rfj
    • +
    +
  • +
+
+

zoweims

+

Interact with IBM IMS programs and transactions.

+

zoweimsquery

+

Query application programs, regions or transactions across an IMSplex. The query returns information about application programs, regions and transactions. This command submits a 'QUERY PGM', 'DIS ACT' or 'QUERY TRAN' IMS command and returns the output.

+

zoweimsqueryprogram

+

Query an IMS application program.

+

Usage

+

zowe ims query program [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • Specifies the name of the program(s) to query.
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --att (array)

    +
      +
    • +

      Specifies the application program output fields to return.

      +

      Default value: ALL
      +Allowed values: ALL, BMPTYPE, DEFN, DEFNTYPE, DOPT, FP, GLOBAL, IMSID, GPSB, LANG, LOCAL, MODEL, RESIDENT, SCHDTYPE, STATUS, TIMESTAMP, TRANSTAT, EXPORTNEEDED, DB, RTC, TRAN, WORK

      +
    • +
    +
  • +
  • +

    --status | --st (array)

    +
      +
    • +

      Selects programs for display that possess at least one of the specified program statuses.

      +

      Allowed values: DB-NOTAVL, IOPREV, LOCK, NOTINIT, STOSCHD, TRACE

      +
    • +
    +
  • +
  • +

    --route | --rt (array)

    +
      +
    • Specifies the routes to return.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Query information for an application program named PGM123:

    +
      +
    • zowe ims query program "PGM123"
    • +
    +
  • +
  • +

    Query information for application programs named ABC and XYZ:

    +
      +
    • zowe ims query program "ABC XYZ"
    • +
    +
  • +
  • +

    Query information for application programs starting with PROG using the wild card character '*':

    +
      +
    • zowe ims query program "PROG*"
    • +
    +
  • +
  • +

    Query information for all application programs (default is all):

    +
      +
    • zowe ims query program
    • +
    +
  • +
  • +

    Query information for all application programs specifying optional parameters:

    +
      +
    • zowe ims query program --attributes "BMPTYPE TIMESTAMP" --status "NOTINIT" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Query information for all application programs specifying optional connection parameters:

    +
      +
    • zowe ims query program --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+

zoweimsqueryregion

+

Query an IMS region.

+

Usage

+

zowe ims query region [options]

+

Options

+
    +
  • +

    --dc (boolean)

    +
      +
    • +

      Displays only the DC subset of the output

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --region (boolean)

    +
      +
    • +

      Displays only the REGION subset of the output. The display consists of active regions

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --route | --rt (array)

    +
      +
    • Specifies the routes to return.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Query information for regions on route IMS1:

    +
      +
    • zowe ims query region "IMS1"
    • +
    +
  • +
  • +

    Query information for regions on routes IMS1 and IMS2:

    +
      +
    • zowe ims query region "IMS1 IMS2"
    • +
    +
  • +
  • +

    Query DC and region information for regions on routes IMS1 and IMS2:

    +
      +
    • zowe ims query region "IMS1 IMS2" --dc true --region true
    • +
    +
  • +
  • +

    Query information for regions specifying optional connection parameters:

    +
      +
    • zowe ims query region --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+

zoweimsquerytransaction

+

Query an IMS transaction.

+

Usage

+

zowe ims query transaction [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • Specifies the name of transaction(s) to query. You can use an * character as a wildcard to select multiple transactions.
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --att (array)

    +
      +
    • +

      Specifies the transaction output fields to return.

      +

      Allowed values: ALL, BMPTYPE, DEFN, DEFNTYPE, DOPT, FP, GLOBAL, IMSID, GPSB, LANG, LOCAL, MODEL, RESIDENT, SCHDTYPE, STATUS, TIMESTAMP, TRANSTAT, EXPORTNEEDED, DB, RTC, TRAN, WORK

      +
    • +
    +
  • +
  • +

    --status | --st (array)

    +
      +
    • +

      Selects transactions that possess at least one of the specified transaction statuses.

      +

      Allowed values: AFFIN, BAL, CONV, CPIC, DYN, IOPREV, LCK, NOTINIT, QERR, QSTP, SUSPEND, STOQ, STOSCHD, TRACE, USTO

      +
    • +
    +
  • +
  • +

    --route | --rt (array)

    +
      +
    • Specifies the routes to return.
    • +
    +
  • +
  • +

    --class | --cl (array)

    +
      +
    • Selects transactions by the classes you specify.
    • +
    +
  • +
  • +

    --queue-count-operator | --qco (array)

    +
      +
    • The compare operator used to select transactions based on queue count. Valid values: LT, LE, GT, GE, EQ or NE.
    • +
    +
  • +
  • +

    --queue-count-value | --qcv (number)

    +
      +
    • The numeric value used with 'queue_count_operator' to select transactions based on queue count.
    • +
    +
  • +
  • +

    --conversation-attributes | --ca (string)

    +
      +
    • Selects transactions by the conversational attributes you specify.
    • +
    +
  • +
  • +

    --fast-path-options | --fpo (string)

    +
      +
    • Selects transactions by the Fast Path options you specify.
    • +
    +
  • +
  • +

    --remote-option-specified | --ros (string)

    +
      +
    • Selects transactions by the remote option you specify.
    • +
    +
  • +
  • +

    --response-mode-option-specified | --rmos (string)

    +
      +
    • Selects transactions by the response mode option you specify.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Query transaction information for transaction named TRN12:

    +
      +
    • zowe ims query transaction "TRN12"
    • +
    +
  • +
  • +

    Query transaction information for transactions named TRAN1 and TRAN2:

    +
      +
    • zowe ims query transaction "TRAN1 TRAN2"
    • +
    +
  • +
  • +

    Query transaction information for transactions starting with TRAN using the wild card character '*':

    +
      +
    • zowe ims query transaction "TRAN*"
    • +
    +
  • +
  • +

    Query transaction information for all transactions (default is all):

    +
      +
    • zowe ims query transaction
    • +
    +
  • +
  • +

    Query transaction information for all transactions specifying optional parameters:

    +
      +
    • zowe ims query transaction --attributes "AFFIN TIMESTAMP" --status "NOTINIT" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Query transaction information for all transactions specifying optional connection parameters:

    +
      +
    • zowe ims query transaction --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+

zoweimsstart

+

Starts a region, application program, or transaction and makes IMS resources available for reference and use. This command submits a '/START REGION', 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.

+

zoweimsstartprogram

+

Start an IMS application program.

+

Usage

+

zowe ims start program [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • The name of the application program(s) to start. The maximum length of a program name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --att (array)

    +
      +
    • +

      The attributes that are to be started

      +

      Default value: SCHD
      +Allowed values: SCHD, TRACE, REFRESH

      +
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • The region(s) to route the command to
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Start an application program named PGM123:

    +
      +
    • zowe ims start program "PGM123"
    • +
    +
  • +
  • +

    Start all application programs beginning with ACC*:

    +
      +
    • zowe ims start program "ACC*"
    • +
    +
  • +
  • +

    Start an application program named PGM234 and start tracing:

    +
      +
    • zowe ims start program "PGM234" --attributes "SCHD TRACE"
    • +
    +
  • +
  • +

    Start an application program named PGM890 routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims start program "PGM890" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Start an application programs named XYZ1 specifying optional connection parameters:

    +
      +
    • zowe ims start program "XYZ1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+

zoweimsstartregion

+

Start an IMS region.

+

Usage

+

zowe ims start region [memberName] [options]

+

Positional Arguments

+
    +
  • +

    memberName (string)

    +
      +
    • The name of the member that contains JCL for the region to start. The maximum length of the member name is eight characters. If no member name is specified, the default member name is used
    • +
    +
  • +
+

Options

+
    +
  • +

    --route | --rte (array)

    +
      +
    • The region(s) to route the command to
    • +
    +
  • +
  • +

    --local | -l (boolean)

    +
      +
    • If you specify the --local option, IMS overrides the symbolic IMSID parameter in the JCL of the default or specified member. --local is the default if you specify the --job-name option.
    • +
    +
  • +
  • +

    --job-name | --jn (string)

    +
      +
    • Use this option to override the job name on the JOB statement of the default or specified JCL member for a dependent region.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Start a region stored in a member named MEM1:

    +
      +
    • zowe ims start region "MEM1"
    • +
    +
  • +
  • +

    Start a region stored in a member named MEM2 specifying the region to route the command:

    +
      +
    • zowe ims start region "MEM2" --route "IMS1"
    • +
    +
  • +
  • +

    Start a region stored in a member named MEM3 and override the job name:

    +
      +
    • zowe ims start region "MEM3" --job-name "JOB9"
    • +
    +
  • +
  • +

    Start a region stored in a member named MEM4 routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims start region "MEM4" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Start a region stored in a member named MEM5 specifying optional connection parameters:

    +
      +
    • zowe ims start region "MEM5" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+

zoweimsstarttransaction

+

Start an IMS transaction.

+

Usage

+

zowe ims start transaction [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • The name of the transaction(s) to start. The maximum length of a transaction name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --att (array)

    +
      +
    • +

      The attributes that are to be started

      +

      Default value: SCHD
      +Allowed values: Q, SCHD, SUSPEND, TRACE

      +
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • The region(s) to route the command to
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Start a transaction named TRN1:

    +
      +
    • zowe ims start transaction "TRN1"
    • +
    +
  • +
  • +

    Start all transactions beginning with TRN*:

    +
      +
    • zowe ims start transaction "TRN*"
    • +
    +
  • +
  • +

    Start a transaction named TRN2 and start tracing:

    +
      +
    • zowe ims start transaction "TRN2" --attributes "SCHD TRACE"
    • +
    +
  • +
  • +

    Start a transaction named TRN3 routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims start transaction "TRN3" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Start a transaction named TRN4 specifying optional connection parameters:

    +
      +
    • zowe ims start transaction "TRN4" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+

zoweimsstop

+

Stops a running region, application program or transaction. This command submits a '/STOP REGION', 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.",

+

zoweimsstopprogram

+

Stop an IMS application program.

+

Usage

+

zowe ims stop program [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • The name( of the program(s) to stop. The maximum length of a program name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --att (array)

    +
      +
    • +

      The attributes that are to be stopped

      +

      Default value: SCHD
      +Allowed values: SCHD, TRACE

      +
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • The region(s) to route the command
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Stop an application program named PGM123:

    +
      +
    • zowe ims stop program "PGM123"
    • +
    +
  • +
  • +

    Stop all application programs beginning with ACC*:

    +
      +
    • zowe ims stop program "ACC*"
    • +
    +
  • +
  • +

    Stop tracing an application program named PGM234:

    +
      +
    • zowe ims stop program "PGM234" --attributes "TRACE"
    • +
    +
  • +
  • +

    Stop an application program named PGM890 routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims stop program "PGM890" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Stop an application programs named XYZ1 specifying optional connection parameters:

    +
      +
    • zowe ims stop program "XYZ1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+

zoweimsstopregion

+

Stop an IMS region.

+

Usage

+

zowe ims stop region [options]

+

Options

+
    +
  • +

    --region-ids | --ri (array)

    +
      +
    • Region identifier numbers for the regions you want to stop. You must specify either this option or --job-name.
    • +
    +
  • +
  • +

    --job-name | --jn (string)

    +
      +
    • The name of the job for the IMS region you want to stop. You must specify either this option or --region-ids.
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • The region(s) to route the command to
    • +
    +
  • +
  • +

    --abdump (string)

    +
      +
    • Specify this option to cause abnormal termination (ABEND) of an application program. If the transaction indicated by this argument is currently running in the specified region, an error message is received at the master terminal, indicating an application program ABEND. The region will remain active, but the transaction will be stopped. The command is ignored if the transaction is not currently scheduled in the region.
    • +
    +
  • +
  • +

    --cancel (boolean)

    +
      +
    • Use this option if the region cannot be stopped with a stop region --abdump command. To use this option, you must have already submitted a stop region command using the --abdump option.
    • +
    +
  • +
  • +

    --transaction (string)

    +
      +
    • Specify a transaction in wait-for-input mode to stop its message processing within the specified region.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Stop a region with job name JOBNM1:

    +
      +
    • zowe ims stop region --job-name "JOBNM1"
    • +
    +
  • +
  • +

    Stop multiple regions with region identifiers:

    +
      +
    • zowe ims stop region --region-ids 4 5
    • +
    +
  • +
  • +

    Stop a region with region identifier and cause the abnormal termination (ABEND) of the application program:

    +
      +
    • zowe ims stop region --region-ids 4 --abdump "TRAN1"
    • +
    +
  • +
  • +

    Stop a region with region identifier and specify 'cancel' because the 'abdump' option failed to stop the region:

    +
      +
    • zowe ims stop region --region-ids 4 --cancel true
    • +
    +
  • +
  • +

    Stop a region with job name JOBNM4 specifying optional connection parameters:

    +
      +
    • zowe ims stop region --job-name "JOBNM4" --user "username" --pass "pass1234" --host "localhost" --port 8080--ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+

zoweimsstoptransaction

+

Stop an IMS transaction.

+

Usage

+

zowe ims stop transaction <name...> [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • The name of the transaction(s) to stop. The maximum length of a transaction name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --att (array)

    +
      +
    • +

      The attributes that are to be stopped

      +

      Default value: SCHD
      +Allowed values: Q, SCHD, TRACE

      +
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • The region(s) to route the command
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Stop a transaction named TRN1:

    +
      +
    • zowe ims stop transaction "TRN1"
    • +
    +
  • +
  • +

    Stop all transactions beginning with TRN*:

    +
      +
    • zowe ims stop transaction "TRN*"
    • +
    +
  • +
  • +

    Stop tracing a transaction named TRN2:

    +
      +
    • zowe ims stop transaction "TRN2" --attributes "TRACE"
    • +
    +
  • +
  • +

    Stop a transaction named TRN3 routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims stop transaction "TRN3" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Stop a transaction named TRN4 specifying optional connection parameters:

    +
      +
    • zowe ims stop transaction "TRN4" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+

zoweimsupdate

+

Updates the setting(s) for application program or transaction. This command submits a 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.

+

zoweimsupdateprogram

+

Update an IMS application program.

+

Usage

+

zowe ims update program [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • The name of the application program(s) to update. The maximum length of a program name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --bmp-type | --bmptype (string)

    +
      +
    • +

      Specifies whether the program runs in a BMP type region or not. (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --dynamic | --dopt (string)

    +
      +
    • +

      Specifies the dynamic option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --fast-path | --fp (string)

    +
      +
    • +

      Specifies the Fast Path option (E or N).

      +

      Allowed values: E, N

      +
    • +
    +
  • +
  • +

    --generated-psb | --gpsb (string)

    +
      +
    • +

      Specifies the generated PSB option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --language | --lang (string)

    +
      +
    • +

      Specifies the language interface of the program or a GPSB or defined a DOPT(Y) program as using the JAVA language (ASSEM, COBOL, JAVA, PASCAL, PLI).

      +

      Allowed values: ASSEM, COBOL, JAVA, PASCAL, PLI

      +
    • +
    +
  • +
  • +

    --lock | -l (string)

    +
      +
    • +

      Specifies the LOCK status is to be set (ON or OFF).

      +

      Allowed values: ON, OFF

      +
    • +
    +
  • +
  • +

    --option | -o (string)

    +
      +
    • +

      Specifies to return response lines for all resources that are processed. It is only valid with --name * (ALLRSP).

      +

      Allowed values: ALLRSP

      +
    • +
    +
  • +
  • +

    --resident | -r (string)

    +
      +
    • +

      Specifies the resident option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • Specifies the region(s) to route the command.
    • +
    +
  • +
  • +

    --schedule-type | --schdtype (string)

    +
      +
    • +

      Specifies whether this application program can be scheduled into more than one message region or batch message region simultaneously (PARALLEL or SERIAL).

      +

      Allowed values: PARALLEL, SERIAL

      +
    • +
    +
  • +
  • +

    --transaction-level-stat | --transtat (string)

    +
      +
    • +

      Specifies whether transaction level statistics should be logged (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update an application program named PGM123 to execute exclusively as Fast Path:

    +
      +
    • zowe ims update program "PGM123" --fp "E"
    • +
    +
  • +
  • +

    Update all application programs beginning with ACC* to not run in a BMP type region:

    +
      +
    • zowe ims update program "ACC*" --bmptype "N"
    • +
    +
  • +
  • +

    Unlock all programs beginning with PGM* to allow scheduling:

    +
      +
    • zowe ims update program "PGM*" --lock "OFF"
    • +
    +
  • +
  • +

    Update an application program named PGM890 to execute as Fast Path routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims update program "PGM890" --fp "E" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Unlock an application programs named XYZ1 to allow scheduling specifying optional connection parameters:

    +
      +
    • zowe ims update program "XYZ1" --lock "OFF" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+

zoweimsupdatetransaction

+

Update an IMS transaction.

+

Usage

+

zowe ims update transaction [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • The name of the transaction(s) to update. The maximum length of a transaction name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --aoi-cmd | --aocmd (string)

    +
      +
    • +

      Specifies the AOI option that you want to change (N, CMD, TRAN, Y).

      +

      Allowed values: N, CMD, TRAN, Y

      +
    • +
    +
  • +
  • +

    --class | -c (array)

    +
      +
    • Selects the transactions associated with the specified class or classes to be updated.
    • +
    +
  • +
  • +

    --commit-mode | --cmtmode (string)

    +
      +
    • +

      Specifies when database updates and non-express output messages are committed (SNGL, MULT).

      +

      Allowed values: SINGLE, MODE

      +
    • +
    +
  • +
  • +

    --conversation | --conv (string)

    +
      +
    • +

      Specifies the conversation option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --current-priority | --cpri (number)

    +
      +
    • Specifies a new value for the current priority of a transaction.
    • +
    +
  • +
  • +

    --directed-routing | --dirroute (string)

    +
      +
    • +

      Specifies the MSC directed routing option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --edit-routine | --editrtn (string)

    +
      +
    • Specifies the 1- to 8-character name of your transaction input edit routine that edits messages before the program receives the message.
    • +
    +
  • +
  • +

    --edit-uppercase | --edituc (string)

    +
      +
    • +

      Specifies the edit to uppercase option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --emh-buffer-size | --emhbsz (number)

    +
      +
    • Specifies the EMH buffer size required to run the Fast Path transaction.
    • +
    +
  • +
  • +

    --expiration-time | --exprtime (number)

    +
      +
    • Specifies the elapsed time in seconds that IMS can use to cancel the input transaction.
    • +
    +
  • +
  • +

    --fast-path | --fp (string)

    +
      +
    • +

      Specifies the Fast Path option (E, N, P).

      +

      Allowed values: E, N, P

      +
    • +
    +
  • +
  • +

    --inquiry | --inq (string)

    +
      +
    • +

      Specifies the inquiry option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --limit-count | --lct (number)

    +
      +
    • Specifies the limit count.
    • +
    +
  • +
  • +

    --limit-priority | --lpri (number)

    +
      +
    • Specifies the limit priority.
    • +
    +
  • +
  • +

    --lock | -l (string)

    +
      +
    • +

      Specifies that the LOCK status is to be set on or off. Cannot be specified with any other SET attribute(ON or OFF).

      +

      Allowed values: ON, OFF

      +
    • +
    +
  • +
  • +

    --log-write-ahead | --dclwa (string)

    +
      +
    • +

      Specifies the log write-ahead option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --maximum-regions | --maxrgn (number)

    +
      +
    • Specifies a new value for the maximum number of regions that can be simultaneously scheduled for a given transaction.
    • +
    +
  • +
  • +

    --message-type | --msgtype (string)

    +
      +
    • +

      Specifies the message type (single segment or multiple segment) (MULTSEG or SNGLSEG).

      +

      Allowed values: MULTSEG, SNGLSEG

      +
    • +
    +
  • +
  • +

    --msname | --mn (string)

    +
      +
    • Specifies the one- to eight-character name of the logical link path in a multiple IMS system configuration (MSC).
    • +
    +
  • +
  • +

    --normal-scheduling-priority | --npri (number)

    +
      +
    • Specifies the normal scheduling priority.
    • +
    +
  • +
  • +

    --option | -o (string)

    +
      +
    • +

      Specifies functions to be performed along with the command (AFFIN or ALLRSP).

      +

      Allowed values: ALLRSP

      +
    • +
    +
  • +
  • +

    --parallel-processing-limit | --parlim (number)

    +
      +
    • Specifies the parallel processing limit count.
    • +
    +
  • +
  • +

    --program | --pgm (string)

    +
      +
    • Specifies the name of the application program associated with the transaction.
    • +
    +
  • +
  • +

    --processing-limit-count | --plct (number)

    +
      +
    • Specifies the processing limit count.
    • +
    +
  • +
  • +

    --processing-limit-count-time | --plcttime (number)

    +
      +
    • Specifies the processing limit count time.
    • +
    +
  • +
  • +

    --recover | -r (string)

    +
      +
    • +

      Specifies the recovery option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --remote | --re (string)

    +
      +
    • +

      Specifies the remote option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --response-mode | --resp (string)

    +
      +
    • +

      Specifies the response mode option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • Specifies the region(s) to route the command.
    • +
    +
  • +
  • +

    --segment-number | --segno (number)

    +
      +
    • Specifies the segment number.
    • +
    +
  • +
  • +

    --segment-size | --segsz (number)

    +
      +
    • Specifies the segment size.
    • +
    +
  • +
  • +

    --serial | --sr (string)

    +
      +
    • +

      Specifies the serial option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --set-class | --sc (number)

    +
      +
    • Specifies the transaction class, which is an attribute used to select a transaction for scheduling.
    • +
    +
  • +
  • +

    --system-identification-local | --sidl (number)

    +
      +
    • Specifies the system identification (SYSID) of the local system in a multiple-IMS system (MSC) configuration.
    • +
    +
  • +
  • +

    --system-identification-remote | --sidr (number)

    +
      +
    • Specifies the system identification (SYSID) of the remote system in a multiple-IMS system (MSC) configuration.
    • +
    +
  • +
  • +

    --scratchpad-area-size | --spasz (number)

    +
      +
    • Specifies the scratchpad area (SPA) size, in bytes, for a conversational transaction. The value can be a number from 16 and 32767.
    • +
    +
  • +
  • +

    --scratchpad-area-truncation | --spatrunc (string)

    +
      +
    • +

      Specifies the scratchpad area (SPA) truncation option of a conversational transaction (S or R).

      +

      Allowed values: S, R

      +
    • +
    +
  • +
  • +

    --transaction-level-stat | --transtat (string)

    +
      +
    • +

      Specifies whether transaction level statistics should be logged for message driven programs (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --wait-for-input | --wfi (string)

    +
      +
    • +

      Specifies the wait-for input option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a transaction named TRN1 to process exclusively as Fast Path:

    +
      +
    • zowe ims update transaction "TRN1" --fp "E"
    • +
    +
  • +
  • +

    Unlock to allow scheduling all transactions beginning with TRN* and associated with class CLASSA:

    +
      +
    • zowe ims update transaction "TRN*" --class "CLASSA" --lock "OFF"
    • +
    +
  • +
  • +

    Set response mode on for transaction named TRN2 and associated with classes CLASS1 and CLASS2:

    +
      +
    • zowe ims update transaction "TRN2" --class "CLASS1 CLASS2" --resp "Y"
    • +
    +
  • +
  • +

    Update a transaction named TRN3 to process exclusively as Fast Path routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims update transaction "TRN3" -fp "E" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Associate PGM1 with transaction named TRN4 specifying optional connection parameters:

    +
      +
    • zowe ims update transaction "TRN4" --pgm "PGM1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+
+

zowejclcheck

+

Validates the accuracy of job control language (JCL) and also helps identify execution-time errors, such as security violations and missing data sets that could cause jobs to fail.

+

zowejclcheckcheck

+

Perform a check on JCL that is contained in an MVS data set or a local file.

+

zowejclcheckcheckdata-set

+

Reads the specified input data set and invokes the JCLCheck service with the data set contents.

+

Usage

+

zowe jclcheck check data-set <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    dataSet (string)

    +
      +
    • The MVS data set containing the JCL contents. The data set can be a physical sequential (PS) or partitioned data set (PDS) member. The data set attributes must be recfm fixed-block (FB) and lrecl 80. The data set must be catalogued.
    • +
    +
  • +
+

Options

+
    +
  • +

    --max-return-code | --mrc (number)

    +
      +
    • Specifies the maximum acceptable return code from the JCLCheck service. If the JCLCheck overall return code exceeds the value specified on this option, the command will exit with a failure status code of 1.
    • +
    +
  • +
  • +

    --raw-output | --ro (boolean)

    +
      +
    • +

      Causes the command to print the unformatted JCLCheck report (raw report) instead of the formatted error table. Use this option if you intend to change the format of the JCLCheck report via runtime options. Changing the format may affect the ability to produce a structured API response.

      +

      Default value: false

      +
    • +
    +
  • +
+

JCLCheck Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Port for the JCLCheck API service that is running on the mainframe system.

      +

      Default value: 12697

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: cajclcheck/api/v1

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for JCLCheck connection (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --jclcheck-options | --jo (string)

    +
      +
    • The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --jclcheck-profile | --jclcheck-p (string)

    +
      +
    • The name of a (jclcheck) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Check the JCL contained in "MY.DATASET(JCL)" and print a table of statements in error:

    +
      +
    • zowe jclcheck check data-set "MY.DATASET(JCL)" --host hostname --port 1234 --jclcheck-options "NOAS NOAU NOHCD NOJCL NORES NOSIGN"
    • +
    +
  • +
  • +

    Check the JCL contained in "MY.DATASET(JCL)" and print the raw JCLCheck report:

    +
      +
    • zowe jclcheck check data-set "MY.DATASET(JCL)" --host hostname --port 1234 --jclcheck-options "NOAS NOAU NOHCD NOJCL NORES NOSIGN" --raw-output
    • +
    +
  • +
+

zowejclcheckchecklocal-file

+

Reads the contents of the local file specified and invokes the JCLCheck service with the JCL contents.

+

Usage

+

zowe jclcheck check local-file <localFile> [options]

+

Positional Arguments

+
    +
  • +

    localFile (string)

    +
      +
    • The local file containing the JCL to check. The local JCL file can contain a single job or multiple jobs (specified one after another without blank lines or line breaks). The JCL lines in the file must not exceed 80 characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --max-return-code | --mrc (number)

    +
      +
    • Specifies the maximum acceptable return code from the JCLCheck service. If the JCLCheck overall return code exceeds the value specified on this option, the command will exit with a failure status code of 1.
    • +
    +
  • +
  • +

    --raw-output | --ro (boolean)

    +
      +
    • +

      Causes the command to print the unformatted JCLCheck report (raw report) instead of the formatted error table. Use this option if you intend to change the format of the JCLCheck report via runtime options. Changing the format may affect the ability to produce a structured API response.

      +

      Default value: false

      +
    • +
    +
  • +
+

JCLCheck Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Port for the JCLCheck API service that is running on the mainframe system.

      +

      Default value: 12697

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: cajclcheck/api/v1

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for JCLCheck connection (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --jclcheck-options | --jo (string)

    +
      +
    • The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --jclcheck-profile | --jclcheck-p (string)

    +
      +
    • The name of a (jclcheck) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Check the JCL contained in the file "jcl.txt" and print a table of statements in error:

    +
      +
    • zowe jclcheck check local-file jcl.txt --host hostname --port 1234 --jclcheck-options "NOAS NOAU NOHCD NOJCL NORES NOSIGN"
    • +
    +
  • +
  • +

    Check the JCL contained in the file "jcl.txt" and print the raw JCLCheck report:

    +
      +
    • zowe jclcheck check local-file jcl.txt --host hostname --port 1234 --jclcheck-options "NOAS NOAU NOHCD NOJCL NORES NOSIGN" --raw-output
    • +
    +
  • +
+
+

zowemat

+

The MAT Analyze plug-in for ZOWE CLI enables you to manage monitor profiles and get the measurement analysis data using Mainframe Application Tuner (MAT)

+

zowematmonitor

+

Get monitor history and measurement analysis data from MAT.

+

zowematmonitorcodeview

+

Get the CodeView measurement details.

+

zowematmonitorcodeviewcallerid

+

Get the CodeView CallerID details for the specific CSECT and module.

+

Usage

+

zowe mat monitor codeview callerid [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
  • +

    --module (string)

    +
      +
    • Specifies the module name that you request the CallerID details for. You get the module value from the 'codeview csect' command response. The module name can be empty (e.g., --module "IGZCPAC" or --module '""').
    • +
    +
  • +
  • +

    --csect (string)

    +
      +
    • Specifies the CSECT name that you request the CallerID details for. You get the csect value from the 'codeview csect' command response. The CSECT name can be empty (e.g., --csect "TUNCOB01" or --csect '""').
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the CallerID details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB:

    +
      +
    • zowe mat monitor codeview callerid --mon_num 5 --csect "TUNCOB01" --module "RUNCOB"
    • +
    +
  • +
  • +

    Get the CallerID details for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01 and empty module name:

    +
      +
    • zowe mat monitor codeview callerid --profile TESTPROF --csect "TUNCOB01" --module '""'
    • +
    +
  • +
  • +

    Get the CallerID details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor codeview callerid --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+

zowematmonitorcodeviewcsect

+

Get the CodeView measurement details in Csect mode.

+

Usage

+

zowe mat monitor codeview csect [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the CodeView measurement details in Csect mode for monitor number 5:

    +
      +
    • zowe mat monitor codeview csect --mon_num 5
    • +
    +
  • +
  • +

    Get the CodeView measurement details in Csect mode for the latest monitor in the TESTPROF profile:

    +
      +
    • zowe mat monitor codeview csect --profile TESTPROF
    • +
    +
  • +
  • +

    Get the CodeView measurement details in Csect mode for monitor number 5, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor codeview csect --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+

zowematmonitorcodeviewhistogram

+

Get the Histogram details for the measurement.

+

Usage

+

zowe mat monitor codeview histogram [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
  • +

    --module (string)

    +
      +
    • Specifies the module name that you request the Histogram data for. You get the module value from the 'codeview csect' command response. The module name can be empty (e.g., --module "IGZCPAC" or --module '""').
    • +
    +
  • +
  • +

    --csect (string)

    +
      +
    • Specifies the CSECT name that you request the Histogram data for. You get the csect value from the 'codeview csect' command response. The CSECT name can be empty (e.g., --csect "TUNCOB01" or --csect '""').
    • +
    +
  • +
  • +

    --group (string)

    +
      +
    • Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.
    • +
    +
  • +
  • +

    --top (number)

    +
      +
    • Specifies the maximum number of the top consuming CSECT activity locations that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all CSECT activity locations that MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.
    • +
    +
  • +
  • +

    --listing (boolean)

    +
      +
    • Enables you to retrieve program listing details that pertain to the specific CSECT and statement. To use the listing retrieval option, you must install and configure the Endevor® Web Services and have the program listing for the specific measurement registered with MAT. The source code listing is retrieved through Endevor® footprints for Cobol, C/C++, and Assembler programs. The program listing file is downloaded to your local directory that you specified with the 'listingDir' parameter in your MAT configuration profile. When you request the histogram details with the '--listing' option, the 'histogram' command returns the additional 'listing' column that contains a reference to the program listing with the specific CSECT name, program type, line and column number that pertain to the requested CSECT and statement, for example, c:listingsSA420LE.asm:382:51. If you use Visual Studio Code (VS Code) IDE, you can click on the reference in the command responce in your VS Code terminal to navigate directly to the indicated source program location.The --listing parameter is optional.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB:

    +
      +
    • zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB"
    • +
    +
  • +
  • +

    Get the Histogram details for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01, empty module name, limiting the group size to 32 bytes and the number of returned records to 5 top consumers:

    +
      +
    • zowe mat monitor codeview histogram --profile TESTPROF --csect "TUNCOB01" --module '""' --top 5 --group 32
    • +
    +
  • +
  • +

    Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, limit the number of returned records to 5 top consumers, and request the listing details:

    +
      +
    • zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --top 5 --listing
    • +
    +
  • +
  • +

    Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+

zowematmonitorcodeviewmodule

+

Get the CodeView measurement details in Module mode.

+

Usage

+

zowe mat monitor codeview module [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the CodeView measurement details in Module mode for monitor number 5:

    +
      +
    • zowe mat monitor codeview module --mon_num 5
    • +
    +
  • +
  • +

    Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile:

    +
      +
    • zowe mat monitor codeview module --profile TESTPROF
    • +
    +
  • +
  • +

    Get the CodeView measurement details in Module mode for monitor number 5, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor codeview module --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+

zowematmonitordb2

+

Get the DB2 measurement details.

+

zowematmonitordb2db2view

+

Get the DB2View details for the measurement.

+

Usage

+

zowe mat monitor db2 db2view [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
  • +

    --top (number)

    +
      +
    • Specifies the maximum number of the top consuming DB2 statements that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all DB2 statements that MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the DB2View details for monitor number 5:

    +
      +
    • zowe mat monitor db2 db2view --mon_num 5
    • +
    +
  • +
  • +

    Get the DB2View details for the latest monitor in the TESTPROF profile, with the top consumer limitation set to 5 top consumers:

    +
      +
    • zowe mat monitor db2 db2view --profile TESTPROF --top 5
    • +
    +
  • +
  • +

    Get the DB2View details for monitor number 5, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor db2 db2view --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+

zowematmonitordb2sqlstmt

+

Get SQL details for the DB2 statement.

+

Usage

+

zowe mat monitor db2 sqlstmt [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
  • +

    --dbrm (string)

    +
      +
    • Specifies the DBRM/Package name that the requested DB2 statement belongs to (e.g., --dbrm CUPBTSDY). You get the dbrm value from the 'db2 db2view ' command response.
    • +
    +
  • +
  • +

    --stmtnum (number)

    +
      +
    • Specifies the statement number that you request the SQL details for (e.g., --stmtnum 464). You get the stmtnum value from the 'db2 db2view ' command response.
    • +
    +
  • +
  • +

    --totalsamps (number)

    +
      +
    • Specifies the total number of samples taken for the requested statement (e.g., --totalsamps 1). You get the totalsamps value from the 'db2 db2view ' command response.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1:

    +
      +
    • zowe mat monitor db2 sqlstmt --mon_num 5 --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1
    • +
    +
  • +
  • +

    Get the DB2 SQL statement details for the latest monitor in the TESTPROF profile, for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1:

    +
      +
    • zowe mat monitor db2 sqlstmt --profile TESTPROF --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1
    • +
    +
  • +
  • +

    Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1, and with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor db2 sqlstmt --mon_num 5 --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+

zowematmonitordelayview

+

Get the DelayView measurement details.

+

zowematmonitordelayviewaddress

+

Get the delay address details for the measurement.

+

Usage

+

zowe mat monitor delayview address [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
  • +

    --majorcategory (string)

    +
      +
    • Specifies the major delay category name identified for the analysis item (e.g., --majorcategory "PC routine delay"). You get the majorcategory value from the 'delayview delay' command response.
    • +
    +
  • +
  • +

    --minorcategory (string)

    +
      +
    • Specifies the minor delay category name identified for the analysis item (e.g., --minorcategory "PC CALL"). You get the minorcategory value from the 'delayview delay' command response.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for monitor number 5:

    +
      +
    • zowe mat monitor delayview address --mon_num 5 –-majorcategory "PC routine delay" –-minorcategory "PC CALL"
    • +
    +
  • +
  • +

    Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for the latest monitor in the TESTPROF profile:

    +
      +
    • zowe mat monitor delayview address --profile TESTPROF –-majorcategory "PC routine delay" –-minorcategory "PC CALL"
    • +
    +
  • +
  • +

    Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for monitor number 5, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor delayview address --mon_num 5 –-majorcategory "PC routine delay" –-minorcategory "PC CALL" --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+

zowematmonitordelayviewdelay

+

Get the delay details for the measurement.

+

Usage

+

zowe mat monitor delayview delay [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the DelayView measurement details for monitor number 5:

    +
      +
    • zowe mat monitor delayview delay --mon_num 5
    • +
    +
  • +
  • +

    Get the DelayView measurement details for the latest monitor in the TESTPROF profile:

    +
      +
    • zowe mat monitor delayview delay --profile TESTPROF
    • +
    +
  • +
  • +

    Get the DelayView measurement details for monitor number 5, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor delayview delay --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+

zowematmonitorhistory

+

Get list of all available measurements that are stored in the history of the specific monitor profile.

+

Usage

+

zowe mat monitor history [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the list of all available measurements that are stored in the history of the monitor profile TESTPROF:

    +
      +
    • zowe mat monitor history --profile TESTPROF
    • +
    +
  • +
  • +

    Get the list of all available measurements that are stored in the history of the monitor profile TESTPROF, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor history --profile TESTPROF --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+

zowematmonitoroverview

+

Get the overview details of the measurement.

+

Usage

+

zowe mat monitor overview [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the overview details of the measurement for monitor number 5:

    +
      +
    • zowe mat monitor overview --mon_num 5
    • +
    +
  • +
  • +

    Get the overview details of the measurement for the latest monitor in the TESTPROF profile:

    +
      +
    • zowe mat monitor overview --profile TESTPROF
    • +
    +
  • +
  • +

    Get the measurement overview details for monitor number 5, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor overview --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+

zowematprofile

+

Create, invoke, and list MAT monitor profiles.

+

zowematprofilecreate

+

Create a MAT monitor profile.

+

Usage

+

zowe mat profile create [options]

+

Required Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you create in MAT (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.
    • +
    +
  • +
  • +

    --jobname (string)

    +
      +
    • Specifies the name of the job that you want to measure (e.g. JOB1). Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
    • +
    +
  • +
  • +

    --targsys (string)

    +
      +
    • Specifies the target system in SYSPLEX. Values: a comma separated list of up to 4 values is allowed, 1-8 characters each, a combination of alphanumeric (A-Z and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or a national (@, #, $), e.g. AA31,AA32).
    • +
    +
  • +
+

Options

+
    +
  • +

    --batchreports (string)

    +
      +
    • +

      Specifies the setting for the Batch report option upon monitor completion.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --description (string)

    +
      +
    • Provide the monitor description (maximum 24 characters).
    • +
    +
  • +
  • +

    --mondsn (string)

    +
      +
    • Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.
    • +
    +
  • +
  • +

    --stepname (string)

    +
      +
    • Specifies the name of the job step to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
    • +
    +
  • +
  • +

    --mstep (string)

    +
      +
    • +

      Indicates whether the multi-step monitoring option is enabled.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --procstep (string)

    +
      +
    • Specifies the name of the procedure step. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
    • +
    +
  • +
  • +

    --program (string)

    +
      +
    • Specifies the name of the program to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
    • +
    +
  • +
  • +

    --elapstime (string)

    +
      +
    • +

      Specifies the required monitor duration followed by s (seconds) or m (minutes) (e.g. 60s). Values: maximum 6 characters total, number must be > 0.

      +

      Default value: 60s

      +
    • +
    +
  • +
  • +

    --smon (string)

    +
      +
    • +

      Specifies whether to monitor the entire step.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --tasklib (string)

    +
      +
    • Specifies an additional DD name for load modules. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
    • +
    +
  • +
  • +

    --samplecnt (string)

    +
      +
    • +

      Specifies the number of observations requested. Values: maximum 6 characters, numbers between 10 and 999999.

      +

      Default value: 6000

      +
    • +
    +
  • +
  • +

    --succnt (string)

    +
      +
    • +

      Specifies the maximum number of monitors to run per job execution. Values: maximum 4 characters, numbers between 1 and 9999.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --reccnt (string)

    +
      +
    • +

      Specifies the number of times this job step will be monitored. Values: maximum 4 characters, numbers between 1 and 9999.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --sampdelay (string)

    +
      +
    • +

      Specifies the delay monitoring time in seconds after the step start. Values: maximum 4 characters, numbers between 0 and 9999.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --userexit1 (string)

    +
      +
    • Specifies the name for the call user written Data Base. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. DBEXIT1).
    • +
    +
  • +
  • +

    --userexit2 (string)

    +
      +
    • Specifies the name 1 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT1).
    • +
    +
  • +
  • +

    --userexit3 (string)

    +
      +
    • Specifies the name 2 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT2).
    • +
    +
  • +
  • +

    --inctask (string)

    +
      +
    • Specifies the task name to define the tasks that you want to sample in a multitasking environment and restrict monitoring to the specific subtask within the address space. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. INC31,INC32).
    • +
    +
  • +
  • +

    --exctask (string)

    +
      +
    • Specifies the task name to omit from sampling in a multitasking environment Values: a comma separated list of up to 4 values is allowed, max. 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. EXC31,EXC32).
    • +
    +
  • +
  • +

    --tran (string)

    +
      +
    • Specifies the CICS transaction code name to monitor .Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TRAN1,TRAN2).
    • +
    +
  • +
  • +

    --term (string)

    +
      +
    • Specifies the CICS terminal IDs to monitor. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TERM1,TERM2).
    • +
    +
  • +
  • +

    --userid (string)

    +
      +
    • Specifies the CICS user IDs to monitor. Values: Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. USER1,USER2).
    • +
    +
  • +
  • +

    --db2expl (string)

    +
      +
    • +

      Indicates whether the Explain SQL option is enabled for DB2 SQL statements.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --db2ctsql (string)

    +
      +
    • +

      Indicates whether the Collect SQL from Catalog option is enabled for DB2 SQL statements.If you specify db2expl=yes, then db2ctsql must be also set to yes.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --db2hvloc (string)

    +
      +
    • +

      Indicates whether the Requestor Location option is enabled for DB2 measurements.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --db2hvcor (string)

    +
      +
    • +

      Indicates whether the Correlation ID option for SQL statements is enabled for DB2 measurements.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --db2hviid (string)

    +
      +
    • +

      Indicates whether the Operator ID option for SQL statements is enabled for DB2 measurements.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --db2hvthd (string)

    +
      +
    • +

      Indicates whether the Thread Address option for SQL statements is enabled for DB2 measurements.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --wasexprt (string)

    +
      +
    • +

      Indicates whether the Expert Mode is enabled for Java measurement.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --urlfilt (string)

    +
      +
    • A filtering string to restrict monitoring to the specific application URL, transaction, or stored procedure for Java measurements. Values: a comma separated list of up to 4 values is allowed, max. 64 characters (e.g. mypage1.html,mypage2.html).
    • +
    +
  • +
  • +

    --sysfilt (string)

    +
      +
    • A filtering string to include the specified system class for Java measurements. If you specify a value for sysfilt, the measurement includes only the classes that match the filtering string pattern. Values: a comma separated list of up to 3 values is allowed, max. 64 characters (e.g. user1.class,user2.class).
    • +
    +
  • +
  • +

    --schedule (string)

    +
      +
    • Specifies the name of the schedule that you want to apply to the monitor profile (maximum 8 characters).
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system:

    +
      +
    • zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31
    • +
    +
  • +
  • +

    Create the PROFILE1 monitor profile to measure for 90 seconds job JOB1 that runs on the AA31 and AA32 systems:

    +
      +
    • zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31,AA32 --elapstime 90s
    • +
    +
  • +
  • +

    Create the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system, with the specific MAT profile details defined:

    +
      +
    • zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+

zowematprofileinvoke

+

Invoke a MAT monitor profile to start measurement.

+

Usage

+

zowe mat profile invoke [options]

+

Required Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile in MAT that you invoke (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.
    • +
    +
  • +
  • +

    --jobname (string)

    +
      +
    • Specifies the name of the job to be measured (e.g. JOB1). Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
    • +
    +
  • +
  • +

    --targsys (string)

    +
      +
    • Specifies the target system in SYSPLEX. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, a combination of alphanumeric (A-Z and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or a national (@, #, $) (e.g. AA31,AA32).
    • +
    +
  • +
+

Options

+
    +
  • +

    --mondsn (string)

    +
      +
    • Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.
    • +
    +
  • +
  • +

    --moiuuid (string)

    +
      +
    • Specifies the MOI UUID. Values: maximum 61 characters, alphanumeric (A-Z and 0-9). If you use this parameter for command execution, the value cannot be blank.
    • +
    +
  • +
  • +

    --moitimestamp (string)

    +
      +
    • Specifies the MOI timestamp. Values: maximum 12 characters, numbers only (0-9). If you use this parameter for command execution, the value cannot be blank.
    • +
    +
  • +
  • +

    --listing (boolean)

    +
      +
    • Activates automated registration of Cobol, C/C++, and Assembler program listings through Endevor® footprints. After completion of the measurement that you invoke with the --listing parameter, the MAT Analyze plug-in for Zowe CLI automatically retrieves the program listing that is associated with the monitored job and registers the listing with MAT. A registered program listing enhances the analysis possibilities of the 'codeview histogram' command the 'codeview histogram' command and enables you to inspect the source code statements that are associated with specific modules and CSECTs.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system :

    +
      +
    • zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31
    • +
    +
  • +
  • +

    Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and save the measurement result in the DEMO.MAT.MONITOR.PROFILE1 data set:

    +
      +
    • zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --mondsn DEMO.MAT.MONITOR.PROFILE1
    • +
    +
  • +
  • +

    Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and register the program listing:

    +
      +
    • zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --listing
    • +
    +
  • +
  • +

    Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system with the specific MAT profile details defined:

    +
      +
    • zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+

zowematprofilelist

+

Get the list of available monitor profiles.

+

Usage

+

zowe mat profile list [options]

+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+

zowemat-pma-util

+

The MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of Mainframe Application Tuner.

+

zowemat-pma-utilget

+

Get performance information using PMA utilities. You can get the current performance data of your jobs and check for the daily performance alerts.

+

zowemat-pma-utilgetalert

+

Check for alerts created in PMA and detect whether any of your jobs exceeds the average daily performance. If the threshold is exceeded, a PMA alert is triggered. We recommend that you include this command in your end-of-day build to trace all jobs that might cause performance degradation by code changes during the day.

+

Usage

+

zowe mat-pma-util get alert [options]

+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Check whether any of your jobs exceeds the average daily performance using the default profile:

    +
      +
    • zowe mat-pma-util get alert
    • +
    +
  • +
  • +

    Check whether any of your jobs exceeds the average daily performance using specific PMA profile details:

    +
      +
    • zowe mat-pma-util get alert --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+

zowemat-pma-utilgetalert-by-job

+

Check whether the specified job exceeds the average daily performance. No record returned indicates that no performance degradation was detected for this job.

+

Usage

+

zowe mat-pma-util get alert-by-job <jobname> [options]

+

Positional Arguments

+
    +
  • +

    jobname (string)

    +
      +
    • Specifies the name of the job that is being tested (e.g. TESTPMA8).
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Check whether your job TESTPMA8 exceeds the average daily performance using the default profile:

    +
      +
    • zowe mat-pma-util get alert-by-job TESTPMA8
    • +
    +
  • +
  • +

    Check whether your job TESTPMA8 exceeds the average daily performance using specific PMA profile details:

    +
      +
    • zowe mat-pma-util get alert-by-job TESTPMA8 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+

zowemat-pma-utilgetperf

+

Get the current performance data of a specific job using PMA. If the current measurement results for any of the measured parameters are higher than average values, an alert message is displayed.

+

Usage

+

zowe mat-pma-util get perf <jobname> [options]

+

Positional Arguments

+
    +
  • +

    jobname (string)

    +
      +
    • Specifies the name of the job that is being tested (e.g. TESTPMA8).
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the current performance data of the TESTPMA8 job using the default profile:

    +
      +
    • zowe mat-pma-util get perf TESTPMA8
    • +
    +
  • +
  • +

    Get the current performance data of the TESTPMA8 job using specific PMA profile details:

    +
      +
    • zowe mat-pma-util get perf TESTPMA8 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+

zowemat-pma-utilscope

+

Get and define the PMA scope information. You can create and update the list of jobs that you want to include, or the list of programs to be excluded from the PMA scope of work.

+

zowemat-pma-utilscopedel-job

+

Delete a job from the list of inclusions in the PMA scope.

+

Usage

+

zowe mat-pma-util scope del-job <jobname> [options]

+

Positional Arguments

+
    +
  • +

    jobname (string)

    +
      +
    • Specifies the name of the job that you want to delete from the list of inclusions in the PMA scope (e.g. TESTPMA8).
    • +
    +
  • +
+

Options

+
    +
  • +

    --stepname | --st (string)

    +
      +
    • Specifies the name of the job step that you want to delete from the list of inclusions in the PMA scope.
    • +
    +
  • +
  • +

    --procstep | --ps (string)

    +
      +
    • Specifies the procname of the job that you want to delete from the list of inclusions in the PMA scope.
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the TESTPMA8 job from the list of inclusions in the PMA scope:

    +
      +
    • zowe mat-pma-util scope del-job TESTPMA8
    • +
    +
  • +
  • +

    Delete the specific procname and step name of the TESTPMA8 job from the list of inclusions in the PMA scope:

    +
      +
    • zowe mat-pma-util scope del-job TESTPMA8 --ps TESTCALL --st TESTDO
    • +
    +
  • +
  • +

    Delete the specific procname and step name of the TESTPMA8 job from the list of inclusions in the PMA scope using specific PMA profile details:

    +
      +
    • zowe mat-pma-util scope del-job TESTPMA8 --ps TESTCALL --st TESTDO --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+

zowemat-pma-utilscopedel-pgm

+

Delete a program from the list of exclusions from the PMA scope.

+

Usage

+

zowe mat-pma-util scope del-pgm <pgmname> [options]

+

Positional Arguments

+
    +
  • +

    pgmname (string)

    +
      +
    • Specifies the name of the program that you want to delete from the list of exclusions from the PMA scope (e.g. TESTPMA8).
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the TESTPMA8 program from the exclusions list from the PMA scope:

    +
      +
    • zowe mat-pma-util scope del-pgm TESTPMA8
    • +
    +
  • +
  • +

    Delete the TESTPMA8 program from the exclusions list from the PMA scope using specific PMA profile details:

    +
      +
    • zowe mat-pma-util scope del-pgm TESTPMA8 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+

zowemat-pma-utilscopeexl-pgm

+

Exclude a program from the PMA scope of work.

+

Usage

+

zowe mat-pma-util scope exl-pgm <pgmname> [options]

+

Positional Arguments

+
    +
  • +

    pgmname (string)

    +
      +
    • Specifies the name of the program that you want to add to the list of exclusions from the PMA scope (e.g. TESTPMA8).
    • +
    +
  • +
+

Options

+
    +
  • +

    --description | --dc (string)

    +
      +
    • Specifies the description of the program that you want to exclude from the PMA scope.
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Exclude the TESTPMA8 program from the PMA scope:

    +
      +
    • zowe mat-pma-util scope exl-pgm TESTPMA8
    • +
    +
  • +
  • +

    Exclude the TESTPMA8 program from the PMA scope and add a description to the excluded program:

    +
      +
    • zowe mat-pma-util scope exl-pgm TESTPMA8 --dc "EXCLUDE FROM THE CURRENT SCOPE"
    • +
    +
  • +
  • +

    Exclude the TESTPMA8 program from the PMA scope and add a description to the excluded program using specific PMA profile details:

    +
      +
    • zowe mat-pma-util scope exl-pgm TESTPMA8 --dc "EXCLUDE FROM THE CURRENT SCOPE" --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+

zowemat-pma-utilscopeget-listj

+

Get the list of jobs included in the PMA scope.

+

Usage

+

zowe mat-pma-util scope get-listj [options]

+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the list of jobs included in the PMA scope:

    +
      +
    • zowe mat-pma-util scope get-listj
    • +
    +
  • +
  • +

    Get the list of jobs included in the PMA scope using specific PMA profile details:

    +
      +
    • zowe mat-pma-util scope get-listj --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+

zowemat-pma-utilscopeget-listp

+

Get the list of programs excluded from the PMA scope.

+

Usage

+

zowe mat-pma-util scope get-listp [options]

+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the list of programs excluded from the PMA scope:

    +
      +
    • zowe mat-pma-util scope get-listp
    • +
    +
  • +
  • +

    Get the list of programs excluded from the PMA scope using specific PMA profile details:

    +
      +
    • zowe mat-pma-util scope get-listp --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+

zowemat-pma-utilscopeinc-job

+

Include a job in the PMA scope of work.

+

Usage

+

zowe mat-pma-util scope inc-job <jobname> [options]

+

Positional Arguments

+
    +
  • +

    jobname (string)

    +
      +
    • Specifies the name of the job that you want to add to the list of inclusions in the PMA scope (e.g. TESTPMA8).
    • +
    +
  • +
+

Options

+
    +
  • +

    --stepname | --st (string)

    +
      +
    • Specifies the name of the job step that you want to include in the PMA scope.
    • +
    +
  • +
  • +

    --procstep | --ps (string)

    +
      +
    • Specifies the procname of the job that you want to include in the PMA scope.
    • +
    +
  • +
  • +

    --description | --dc (string)

    +
      +
    • Specifies the description of the job that you want to include in the PMA scope.
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Include the TESTPMA8 job in the PMA scope:

    +
      +
    • zowe mat-pma-util scope inc-job TESTPMA8
    • +
    +
  • +
  • +

    Include the specific procname and step name of the TESTPMA8 job in the PMA scope and add a description to the included job:

    +
      +
    • zowe mat-pma-util scope inc-job TESTPMA8 --ps TESTCALL --st TESTDO --dc "INCLUDE IN THE CURRENT SCOPE"
    • +
    +
  • +
  • +

    Include the specific procname and step name of the TESTPMA8 job in the PMA scope and add a description to the included job using specific PMA profile details:

    +
      +
    • zowe mat-pma-util scope inc-job TESTPMA8 --ps TESTCALL --st TESTDO --dc "INCLUDE IN THE CURRENT SCOPE" --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+
+

zowemq

+

Interact with IBM MQ for z/OS.

+

zowemqrun

+

MQ Utilities

+

zowemqrunmqsc

+

MQ Utilities

+

Usage

+

zowe mq run mqsc <qmgr> <cmd> [options]

+

Positional Arguments

+
    +
  • +

    qmgr (string)

    +
      +
    • The queue manager to apply the command to
    • +
    +
  • +
  • +

    cmd (string)

    +
      +
    • The MQSC command
    • +
    +
  • +
+

MQ Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The host name used to access the IBM MQ REST API. This might be the host name of the IBM MQ mqweb server, or the Zowe API Mediation Layer..
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number used to access the IBM MQ REST API. This might be the port number of the IBM MQ mqweb server, or the Zowe API Mediation Layer.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The mainframe (MQ) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The mainframe (MQ) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the MQ protocol (http or https).

      +

      Default value: http
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mq-profile | --mq-p (string)

    +
      +
    • The name of a (mq) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    The following sequence shows how to query a server-connection channel that is called NEWSVRCONN on an MQ queue manager - our example queue manager is called MQ99:

    +
      +
    • zowe mq run mqsc MQ99 "DISPLAY CHANNEL(NEWSVRCONN)"
    • +
    +
  • +
+
+

zoweomspool

+

Interact with Spool™

+

zoweomspoolissue

+

Issue Spool commands.

+

zoweomspoolissuecommand

+

Issue commands to work with Spool.

+

Usage

+

zowe omspool issue command <command-text> [options]

+

Positional Arguments

+
    +
  • +

    command-text (string)

    +
      +
    • The Spool command to issue.
    • +
    +
  • +
+

SPOOL OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --spoolhlq | --hlq (string)

    +
      +
    • High level qualifier of Spool installation.
    • +
    +
  • +
  • +

    --subsys | --sub (string)

    +
      +
    • +

      Spool subsystem name.

      +

      Default value: ESF

      +
    • +
    +
  • +
  • +

    --outds | --out (string)

    +
      +
    • The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.
    • +
    +
  • +
  • +

    --clist | --cl (string)

    +
      +
    • The data set containing ESFZOWE REXX exec.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --omspool-profile | --omspool-p (string)

    +
      +
    • The name of a (omspool) profile to load for this command execution.
    • +
    +
  • +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issue the Spool command 'DS' to display the status of the ESF system:

    +
      +
    • zowe omspool issue command "DS"
    • +
    +
  • +
+
+

zoweops

+

Interact with OPS/MVS® for automation administration and resource management.

+

zoweopsdisable

+

Disable OPS/MVS rules.

+

zoweopsdisablerule

+

Disable the specified rule.

+

Usage

+

zowe ops disable rule <ruleset> <rule> [options]

+

Positional Arguments

+
    +
  • +

    ruleset (string)

    +
      +
    • The rule set containing the rule.
    • +
    +
  • +
  • +

    rule (string)

    +
      +
    • The name of the rule.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ops-profile | --ops-p (string)

    +
      +
    • The name of a (ops) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Disable MYRULE on ruleset OPSRULES on subsystem OPSS.:

    +
      +
    • zowe ops disable rule OPSRULES MYRULE --subsystem OPSS
    • +
    +
  • +
+

zoweopsenable

+

Enables OPS/MVS rules.This will cause SSM to take the necessary action to enable that rule.

+

zoweopsenablerule

+

Enable the specified rule.

+

Usage

+

zowe ops enable rule <ruleset> <rule> [options]

+

Positional Arguments

+
    +
  • +

    ruleset (string)

    +
      +
    • The rule set containing the rule.
    • +
    +
  • +
  • +

    rule (string)

    +
      +
    • The name of the rule.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ops-profile | --ops-p (string)

    +
      +
    • The name of a (ops) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Enable MYRULE on ruleset OPSRULES on subsystem OPSS.:

    +
      +
    • zowe ops enable rule OPSRULES MYRULE --subsystem OPSS
    • +
    +
  • +
+

zoweopsshow

+

Display data associated with OPS/MVS automation elements (for example, rules or SSM resources).

+

zoweopsshowresource

+

Display data associated with the specified SSM resource. Currently, only resource state is displayed.

+

Usage

+

zowe ops show resource <resourcename> [options]

+

Positional Arguments

+
    +
  • +

    resourcename (string)

    +
      +
    • The name of the resource.
    • +
    +
  • +
+

Options

+
    +
  • +

    --tablename | --table (string)

    +
      +
    • The name of the table that contains the resource. If not specified, the command will search the SSM tables to find the resource. If the resource exists in multiple tables, the desired state of the resource will be set to the appropriate DOWN state in all the tables where the resource exists.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ops-profile | --ops-p (string)

    +
      +
    • The name of a (ops) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show current and desired state of RESOURCE1 on table MYTABLE on subsystem OPSS.:

    +
      +
    • zowe ops show resource RESOURCE1 --tablename MYTABLE --subsystem OPSS
    • +
    +
  • +
+

zoweopsshowrule

+

Display data associated with the specified rule. Currently, only rule status is displayed.

+

Usage

+

zowe ops show rule <ruleset> <rule> [options]

+

Positional Arguments

+
    +
  • +

    ruleset (string)

    +
      +
    • The rule set containing the rule.
    • +
    +
  • +
  • +

    rule (string)

    +
      +
    • The name of the rule.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ops-profile | --ops-p (string)

    +
      +
    • The name of a (ops) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show the status of MYRULE on ruleset OPSRULES on subsystem OPSS:

    +
      +
    • zowe ops show rule OPSRULES MYRULE --subsystem OPSS
    • +
    +
  • +
+

zoweopsstart

+

Start OPS/MVS resources.

+

zoweopsstartresource

+

Start the specified resource. The desired state of the resource willbe set to the appropriate UP state and SSM will take actions to start the resource.

+

Usage

+

zowe ops start resource <resourcename> [options]

+

Positional Arguments

+
    +
  • +

    resourcename (string)

    +
      +
    • The name of the resource.
    • +
    +
  • +
+

Options

+
    +
  • +

    --tablename | --table (string)

    +
      +
    • The name of the table that contains the resource. If not specified, the command will search the SSM tables to find the resource. If the resource exists in multiple tables, the desired state of the resource will be set to the appropriate DOWN state in all the tables where the resource exists.
    • +
    +
  • +
  • +

    --wait | -w (number)

    +
      +
    • Wait for the specified number of seconds for the current state of the SSM resource to match the new desired state. If more than the specified number of seconds elapses and the current and desired state still do not match, the command will fail with a timeout error.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ops-profile | --ops-p (string)

    +
      +
    • The name of a (ops) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Start RESOURCE1 on table MYTABLE on subsystem OPSS.:

    +
      +
    • zowe ops start resource RESOURCE1 --tablename MYTABLE --subsystem OPSS
    • +
    +
  • +
  • +

    Start RESOURCE1 on table MYTABLE on subsystem OPSS and wait for up to 2 minutes for RESOURCE1 to have a current state of UP.:

    +
      +
    • zowe ops start resource RESOURCE1 --tablename MYTABLE --subsystem OPSS -w 120
    • +
    +
  • +
+

zoweopsstop

+

Stop OPS/MVS resources.

+

zoweopsstopresource

+

Stop the specified resource. The desired state of the resource willbe set to the appropriate DOWN state and SSM will take actions to start the resource.

+

Usage

+

zowe ops stop resource <resourcename> [options]

+

Positional Arguments

+
    +
  • +

    resourcename (string)

    +
      +
    • The name of the resource.
    • +
    +
  • +
+

Options

+
    +
  • +

    --tablename | --table (string)

    +
      +
    • The name of the table that contains the resource. If not specified, the command will search the SSM tables to find the resource. If the resource exists in multiple tables, the desired state of the resource will be set to the appropriate DOWN state in all the tables where the resource exists.
    • +
    +
  • +
  • +

    --wait | -w (number)

    +
      +
    • Wait for the specified number of seconds for the current state of the SSM resource to match the new desired state. If more than the specified number of seconds elapses and the current and desired state still do not match, the command will fail with a timeout error.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ops-profile | --ops-p (string)

    +
      +
    • The name of a (ops) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Stop RESOURCE1 on table MYTABLE on subsystem OPSS.:

    +
      +
    • zowe ops stop resource RESOURCE1 --tablename MYTABLE --subsystem OPSS
    • +
    +
  • +
  • +

    Start RESOURCE1 on table MYTABLE on subsystem OPSS and wait for up to 2 minutes for RESOURCE1 to have a current state of DOWN.:

    +
      +
    • zowe ops stop resource RESOURCE1 --tablename MYTABLE --subsystem OPSS -w 120
    • +
    +
  • +
+
+

zoweplugins

+

Install and manage plug-ins.

+

zowepluginsinstall

+

Install plug-ins to an application.

+

Usage

+

zowe plugins install [plugin...] [options]

+

Positional Arguments

+
    +
  • +

    plugin... (string)

    +
      +
    • +

      A space-separated list of plug-ins to install. A plug-in can be any format that is accepted by the `npm install` command (local directory, TAR file, git URL, public package, private package, etc...).

      +

      To use a relative local directory, at least one '/' or '\' must exist in the plug-in path. For example, you have a local plug-in in a folder called 'test-plugin' that you want to install. Specify the relative local directory by issuing the following command:

      +

      zowe plugins install ./test-plugin

      +

      If you omit the './', then the install command looks for 'test-plugin' in an npm registry.

      +

      If the plugin argument is omitted, the plugins.json file will determine which plug-ins are installed. For more information on the plugins.json file, see the --file option.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --file (local file path)

    +
      +
    • +

      Specifies the location of a plugins.json file that contains the plug-ins you want to install.

      +

      All plug-ins specified in plugins.json will be installed to the base CLI and the contents will be placed into /home/<user>/.zowe/plugins/plugins.json.

      +

      If you do not specify a plugins.json file and do not specify a plug-in, the default plugin.json file (/home/<user>/.zowe/plugins/plugins.json) will be used. This provides a way to install plug-ins that were lost or corrupted after reinstalling or updating Zowe CLI.

      +
    • +
    +
  • +
  • +

    --registry (string)

    +
      +
    • +

      The npm registry that is used when installing remote packages. When this value is omitted, the value returned by `npm config get registry` is used.

      +

      For more information about npm registries, see: https://docs.npmjs.com/misc/registry

      +
    • +
    +
  • +
  • +

    --login (boolean)

    +
      +
    • +

      The flag to add a registry user account to install from secure registry. It saves credentials to the .npmrc file using `npm login`. When this value is omitted, credentials from .npmrc file is used. If you used this flag once for specific registry, you don't have to use it again, it uses credentials from .npmrc file.

      +

      For more information about npm registries, see:
      +https://docs.npmjs.com/cli/login for NPM >= 9
      +https://docs.npmjs.com/cli/adduser for NPM < 9

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Install plug-ins saved in /home/<user>/.zowe/plugins/plugins.json:

    +
      +
    • zowe plugins install
    • +
    +
  • +
  • +

    Install plug-ins saved in a properly formatted config file:

    +
      +
    • zowe plugins install --file /some/file/path/file_name.json
    • +
    +
  • +
  • +

    Install a remote plug-in:

    +
      +
    • zowe plugins install my-plugin
    • +
    +
  • +
  • +

    Install a remote plug-in using semver:

    +
      +
    • zowe plugins install my-plugin@"^1.2.3"
    • +
    +
  • +
  • +

    Install a remote plug-in from the specified registry:

    +
      +
    • zowe plugins install my-plugin --registry https://registry.npmjs.org/
    • +
    +
  • +
  • +

    Install a local folder, local TAR file, and a git URL:

    +
      +
    • zowe plugins install ./local-file /root/tar/some-tar.tgz git://github.com/project/repository.git#v1.0.0
    • +
    +
  • +
  • +

    Install a remote plug-in from the registry which requires authorization(don't need to use this flag if you have already logged in before):

    +
      +
    • zowe plugins install my-plugin --registry https://registry.npmjs.org/ --login
    • +
    +
  • +
+

zowepluginslist

+

List all plug-ins installed.

+

Usage

+

zowe plugins list [options]

+

Options

+
    +
  • +

    --short | -s (boolean)

    +
      +
    • Show output in abbreviated format
    • +
    +
  • +
+

zowepluginsshow-first-steps

+

Show first steps required to set up plugin for use.

+

Usage

+

zowe plugins show-first-steps [plugin] [options]

+

Positional Arguments

+
    +
  • +

    plugin (string)

    +
      +
    • +

      The name of the installed plug-in to show first steps for.

      +

      If the plug-in argument is omitted, no action is taken.

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show first steps for a plugin called 'my-plugin':

    +
      +
    • zowe plugins show-first-steps my-plugin
    • +
    +
  • +
+

zowepluginsuninstall

+

Uninstall plug-ins.

+

Usage

+

zowe plugins uninstall [plugin...] [options]

+

Positional Arguments

+
    +
  • +

    plugin... (string)

    +
      +
    • +

      The name of the plug-in to uninstall.

      +

      If the plug-in argument is omitted, no action is taken.

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Uninstall a plug-in:

    +
      +
    • zowe plugins uninstall my-plugin
    • +
    +
  • +
+

zowepluginsupdate

+

Update plug-ins.

+

Usage

+

zowe plugins update [plugin...] [options]

+

Positional Arguments

+
    +
  • +

    plugin... (string)

    +
      +
    • +

      The name of the plug-in to update.

      +

      If the plug-in argument is omitted, no action is taken.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --registry (string)

    +
      +
    • +

      The npm registry that is used when installing remote packages. When this value is omitted, the value returned by `npm config get registry` is used.

      +

      For more information about npm registries, see: https://docs.npmjs.com/misc/registry

      +
    • +
    +
  • +
  • +

    --login (boolean)

    +
      +
    • +

      The flag to add a registry user account to install from secure registry. It saves credentials to the .npmrc file using `npm login`. When this value is omitted, credentials from .npmrc file is used. If you used this flag once for specific registry, you don't have to use it again, it uses credentials from .npmrc file.

      +

      For more information about npm registries, see:
      +https://docs.npmjs.com/cli/login for NPM >= 9
      +https://docs.npmjs.com/cli/adduser for NPM < 9

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a plug-in:

    +
      +
    • zowe plugins update my-plugin
    • +
    +
  • +
  • +

    Update a remote plug-in from the registry which requires authorization(don't need to use this flag if you have already logged in before):

    +
      +
    • zowe plugins update my-plugin --registry https://registry.npmjs.org/ --login
    • +
    +
  • +
+

zowepluginsvalidate

+

Validate a plug-in that has been installed.

+

Usage

+

zowe plugins validate [plugin] [options]

+

Positional Arguments

+
    +
  • +

    plugin (string)

    +
      +
    • +

      The name of the plug-in to validate.
      +Validation issues identified for this plug-in are displayed.

      +

      If the plug-in argument is omitted, all installed plug-ins are validated.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --fail-on-error | --foe (boolean)

    +
      +
    • +

      Enables throwing an error and setting an error code if plugin validation detects an error

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --fail-on-warning | --fow (boolean)

    +
      +
    • +

      Treat validation warnings as errors. Requires fail-on-error.

      +

      Default value: false

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Validate a plug-in named my-plugin:

    +
      +
    • zowe plugins validate my-plugin
    • +
    +
  • +
  • +

    Validate all installed plug-ins:

    +
      +
    • zowe plugins validate
    • +
    +
  • +
  • +

    Validate a plug-in named my-plugin, and treat warnings as errors:

    +
      +
    • zowe plugins validate my-plugin --fail-on-warning
    • +
    +
  • +
+
+

zoweprofiles

+

Create and manage configuration profiles.

+

Warning: This group has been deprecated.
+Recommended replacement: The 'config init' command

+

zoweprofilescreate

+

Create new configuration profiles.

+

Warning: This group has been deprecated.
+Recommended replacement: The 'config init' command

+

zoweprofilescreatebase-profile

+

Base profile that stores values shared by multiple service profiles

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create base-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new base profile. You can load this profile by using the name on commands that support the "--base-profile" option.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the base profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a profile called 'base1' to connect to host example.com and port 443:

    +
      +
    • zowe profiles create base-profile base1 --host example.com --port 443 --user admin --password 123456
    • +
    +
  • +
  • +

    Create a profile called 'base2' to connect to host example.com (default port - 443) and allow self-signed certificates:

    +
      +
    • zowe profiles create base-profile base2 --host example.com --user admin --password 123456 --reject-unauthorized false
    • +
    +
  • +
  • +

    Create a profile called 'base3' to connect to host example.com and port 1443, not specifying a username or password so they are not stored on disk; these will need to be specified on every command:

    +
      +
    • zowe profiles create base-profile base3 --host example.com --port 1443
    • +
    +
  • +
  • +

    Create a zosmf profile called 'base4' to connect to default port 443 and allow self-signed certificates, not specifying a username, password, or host so they are not stored on disk; these will need to be specified on every command:

    +
      +
    • zowe profiles create base-profile base4 --reject-unauthorized false
    • +
    +
  • +
+

zoweprofilescreateca7-profile

+

A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create ca7-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ca7 profile. You can load this profile by using the name on commands that support the "--ca7-profile" option.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the ca7 profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

zoweprofilescreatecaview-profile

+

Configuration profile for View

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create caview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new caview profile. You can load this profile by using the name on commands that support the "--caview-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the caview profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a profile for View™ Plug-in for Zowe CLI named 'myProfile' to connect to 'mf.company.org' over HTTP on port 80 using the 'johndoe' account.:

    +
      +
    • zowe profiles create caview-profile myProfile --hostname mf.company.org --protocol http --port 80 --username johndoe --password secret
    • +
    +
  • +
+

zoweprofilescreatecics-profile

+

A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create cics-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new cics profile. You can load this profile by using the name on commands that support the "--cics-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CMCI server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CMCI server port

      +

      Default value: 1490

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your username to connect to CICS
    • +
    +
  • +
  • +

    --password | -p (string)

    +
      +
    • Your password to connect to CICS
    • +
    +
  • +
  • +

    --region-name (string)

    +
      +
    • The name of the CICS region name to interact with
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to interact with
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the cics profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a cics profile named 'cics123' to connect to CICS at host zos123 and port 1490:

    +
      +
    • zowe profiles create cics-profile cics123 --host zos123 --port 1490 --user ibmuser --password myp4ss
    • +
    +
  • +
+

zoweprofilescreatedb2-profile

+

A profile for interaction with Db2 for the z/OS region

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new db2 profile. You can load this profile by using the name on commands that support the "--db2-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The Db2 server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Db2 server port number
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The Db2 user ID (may be the same as the TSO login)
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The Db2 password (may be the same as the TSO password)
    • +
    +
  • +
  • +

    --database | -d (string)

    +
      +
    • The name of the database
    • +
    +
  • +
  • +

    --ssl-file | -s (string)

    +
      +
    • Path to an SSL Certificate file
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the db2 profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

zoweprofilescreatedbm-db2-options-profile

+

The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create dbm-db2-options-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new dbm-db2-options profile. You can load this profile by using the name on commands that support the "--dbm-db2-options-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --change-set | --cs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.

      +

      Format:

      +

      <change-set-creator.change-set-name>

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --change-set-values | --csv (array)

    +
      +
    • +

      Specifies the global change specifications that modify Db2 object attributes during a command execution.

      +

      Format:

      +

      <object-attribute> <from-value> <to-value>

      +

      The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

      +

      For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Example:

      +

      The following example demonstrates changes to the table schema (creator) and tablespace names:

      +

      TBCR TEST% PROD%
      +TBTS TESTTS% PRODTS%

      +

      Note:
      +- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
      +- The changeSetValues options-profile option has the same behavior as the change-set-file command option.

      +
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --description | -d (string)

    +
      +
    • Specifies a 1- to 25-character description for the RC/Migrator compare strategy.
    • +
    +
  • +
  • +

    --id (string)

    +
      +
    • +

      Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.

      +

      Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @.

      +
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --match-set | --ms (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <match-set-creator.match-set-name>

      +

      For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --match-set-values | --msv (array)

    +
      +
    • +

      Specifies the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <object-type> <source-name-mask> <target-name-mask>;

      +

      STOGROUP <name> <name>
      +DATABASE <name> <name>
      +TABLESPACE <database.name> <database.name>
      +TABLE <schema.name> <schema.name>
      +INDEX <schema.name> <schema.name>
      +VIEW <schema.name> <schema.name>
      +SYNONYM <schema.name> <schema.name>
      +ALIAS <schema.name> <schema.name>
      +TRIGGER <schema.name> <schema.name>
      +SEQUENCE <schema.name> <schema.name>
      +FUNCTION <schema.name[.version]> <schema.name[.version]>
      +PROCEDURE <schema.name[.version]> <schema.name[.version]>

      +

      Note:
      +- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
      +- <schema> must be between 1 and 128 characters.
      +- <version> must be between 1 and 64 characters.

      +

      A mask specification can include the following wildcard characters:

      +

      Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.

      +

      Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.

      +

      Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.

      +

      Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.

      +

      Example:

      +

      The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:

      +

      TABLE MY%.%TABLE YOUR%.%TABLE;
      +TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
      +TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
      +TABLE *.MYTABLE *.YOURTABLE;

      +

      For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note:
      +- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.
      +- The matchSetValues options-profile option has the same behavior as the match-set-file command option.

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --rule-set | --rs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.

      +

      Format:

      +

      <rule-set-creator.rule-set-name>

      +

      For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --source-db2 | --sd (string)

    +
      +
    • +

      Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to use a command.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
  • +

    --type | -t (string)

    +
      +
    • +

      Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.

      +

      Allowed values: drop, create

      +
    • +
    +
  • +
  • +

    --verify | -v (string)

    +
      +
    • +

      Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.

      +

      Default value: no

      +

      Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the dbm-db2-options profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

zoweprofilescreatedbm-db2-profile

+

The DBM-Db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create dbm-db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new dbm-db2 profile. You can load this profile by using the name on commands that support the "--dbm-db2-profile" option.
    • +
    +
  • +
+

DBM-Db2 Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies the DBM Data Service REST API server host name or TCP/IP address to use.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies the DBM Data Service REST API server TCP/IP port number.

      +

      Default value: 7300

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies the mainframe user name that you want to use to connect to the mainframe systems during execution of the Zowe CLI commands. This user name can be the same as your TSO login ID.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • +

      Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt

      +

      Default value: [object Object]

      +
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • +

      Specifies a string array of z/OS JCL JOB statements.

      +

      Default value: //DB2DVOPS JOB CLASS=A,,// MSGCLASS=X

      +
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • +

      Specifies the prefix (high-level qualifier) in z/OS work data set names.

      +

      Default value: ${user}.dbmdb2

      +
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • +

      Specifies whether to delete work data sets on a mainframe after the request is fulfilled.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • +

      Specifies whether to overwrite output files if they exist.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • +

      Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.

      +

      Default value: ${user}

      +
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • +

      Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.

      +

      Default value: ${user}

      +
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • +

      Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.

      +

      Default value: ;

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the dbm-db2 profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a DBM-Db2 profile named profile_name1 and default values for all the options:

    +
      +
    • zowe profiles create dbm-db2-profile profile_name1
    • +
    +
  • +
  • +

    Create a DBM-Db2 profile named dbm123 that connects to the DBM Data Service at host dbm123 and port 1443 as user db2user and password myp4ss:

    +
      +
    • zowe profiles create dbm-db2-profile dbm123 --host dbm123 --port 1443 --user db2user --password myp4ss
    • +
    +
  • +
  • +

    Create a DBM-Db2 profile named dbm124 that connects to the DBM Data Service at host dbm124 and the default port as user db2user and password myp4ss, and allow self-signed certificates:

    +
      +
    • zowe profiles create dbm-db2-profile dbm124 --host dbm124 --user db2user --password myp4ss --reject-unauthorized false
    • +
    +
  • +
  • +

    Create a DBM-Db2 profile named dbm125 that connects to the DBM Data Service at host dbm125 and port 1443 and requires a user and password to be specified on every dbm-db2 command. DBM Data Service access to Db2 subsystems SUBA and SUBB uses prod@host1.com:322 and test@host2.com:522, respectively:

    +
      +
    • zowe profiles create dbm-db2-profile dbm125 --host dbm125 --port 1443 --environment-list "SUBA:prod@host1.com:322,SUBB:test@host2.net:522"
    • +
    +
  • +
  • +

    Create a DBM-Db2 profile named dbm126 that uses specified job cards for every mainframe job:

    +
      +
    • zowe profiles create dbm-db2-profile dbm126 --job-cards "//DB2DVOPS JOB (123456789),'DB2 PROVISIONING',NOTIFY=&SYSUID," "// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1)," "// REGION=0M,TIME=NOLIMIT"
    • +
    +
  • +
+

zoweprofilescreateebg-profile

+

An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the Endevor Bridge for Git server of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create ebg-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ebg profile. You can load this profile by using the name on commands that support the "--ebg-profile" option.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the ebg profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

zoweprofilescreateendevor-location-profile

+

The Endevor element location, where you specify your working environment, system and subsystem

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create endevor-location-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new endevor-location profile. You can load this profile by using the name on commands that support the "--endevor-location-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • +

      The STC/datasource of the session

      +

      Default value: ENDEVOR

      +
    • +
    +
  • +
  • +

    --environment | --env (string)

    +
      +
    • +

      The Endevor environment where your project resides

      +

      Default value: DEV

      +
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where the element resides
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your element resides
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage where your project resides

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The Endevor comment you want to use when performing an action
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The Endevor CCID you want to use when performing an action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The return code of Endevor that defines a failed action

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • +

      Always override element signout, without having to specify the override signout option on each command

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --file-extension | --ext (string)

    +
      +
    • +

      The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:

      +
              none: File name is equal to element name, no extension is added\.
      +
      +        file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added\.
      +
      +        type\-name: The type name is used as the file extension\.
      +
      +        mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead\.
      +
      +

      Default value: mixed
      +Allowed values: none, type-name, file-ext, mixed

      +
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the endevor-location profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a location profile called 'ndvrLoc' to work at Endevor location ENV/1/SYS/SUBSYS, with elements of type COBOL, using Endevor web services configuration ENDEVOR:

    +
      +
    • zowe profiles create endevor-location-profile ndvrLoc --env ENV --sys SYS --sub SUBSYS --typ COBOL --sn 1 -i ENDEVOR
    • +
    +
  • +
  • +

    Create a location profile called 'ndvrLoc2' to work at Endevor location ENV/1/SYS/SUBSYS, using CCID 'CCID' and comment 'sample comment':

    +
      +
    • zowe profiles create endevor-location-profile ndvrLoc2 --env ENV --sys SYS --sub SUBSYS --sn 1 --com 'sample comment' --cci 'CCID'
    • +
    +
  • +
+

zoweprofilescreateendevor-profile

+

The endevor profile schema, where you specify your endevor session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create endevor-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new endevor profile. You can load this profile by using the name on commands that support the "--endevor-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • The hostname of the endevor session
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number of the endevor session
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • The username of the endevor session
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The password of the user
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path used for connecting to Endevor Rest API

      +

      Default value: EndevorService/api/v2

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --report-dir | --rd (string)

    +
      +
    • +

      The default path where any reports will be written to, either absolute or relative to current directory

      +

      Default value: .

      +
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the endevor profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an endevor profile called 'ndvrSample' to connect to Endevor web services at host ndvr123 and port 8080,using http protocol, with / EndevorService/api/v2 base path, allowing self-signed certificates:

    +
      +
    • zowe profiles create endevor-profile ndvrSample --host ndvr123 --port 8080 --user ibmuser --password myp4ss --prot http --base-path EndevorService/api/v2 --reject-unauthorized false
    • +
    +
  • +
+

zoweprofilescreatefmp-profile

+

File Master Plus profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create fmp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new fmp profile. You can load this profile by using the name on commands that support the "--fmp-profile" option.
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the fmp profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a fmp profile with http protocol:

    +
      +
    • zowe profiles create fmp-profile fmp123 --host fmphost --port 19853 --user mfuser --password m4pass --protocol http
    • +
    +
  • +
  • +

    Create a fmp profile with https protocol and allow self-signed certificates:

    +
      +
    • zowe profiles create fmp-profile fmp234 --host fmphost --port 19854 --user mfuser --password m4pass --protocol https --reject-unauthorized false
    • +
    +
  • +
  • +

    Create a fmp profile with API Mediation layer:

    +
      +
    • zowe profiles create fmp-profile fmpAPIML --host fmpAPIML --port 2020 --user mfuser --pass mfp4ss --protocol https --reject-unauthorized false --base-path /api/v1/serviceID
    • +
    +
  • +
+

zoweprofilescreateidms-profile

+

An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create idms-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new idms profile. You can load this profile by using the name on commands that support the "--idms-profile" option.
    • +
    +
  • +
+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the idms profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an IDMS profile called 'idms11' to connect to IDMS API services at host zos123 and port 1234, with base path api/v1/caidms and allow self-signed certificates:

    +
      +
    • zowe profiles create idms-profile idms11 --host zos123 --port 1234 --user myuid --password mypass --base-path api/v1/caidms --reject-unauthorized false
    • +
    +
  • +
  • +

    Create an IDMS profile called 'idms99' to connect to IDMS API services at host zos123 and port 1234, specify a default data source SYS195 to be used by JDBC to identify a target system and allow self-signed certificates:

    +
      +
    • zowe profiles create idms-profile idms99 --host zos123 --port 1234 --user myuid --password mypass --datasource SYS195 --reject-unauthorized false
    • +
    +
  • +
+

zoweprofilescreateims-profile

+

An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create ims-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ims profile. You can load this profile by using the name on commands that support the "--ims-profile" option.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the ims profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a ims profile named 'ims123' to connect to IMS APIs at host zos123 and port 1490. The name of the IMS plex in this example is 'PLEX1' and the IMS region we want to communicate with has a host of zos124 and a port of 1491:

    +
      +
    • zowe profiles create ims-profile ims123 --host zos123 --port 1490 --user ibmuser --pass myp4ss --plex PLEX1 --ich zos124 --icp 1491
    • +
    +
  • +
+

zoweprofilescreatejclcheck-profile

+

A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create jclcheck-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new jclcheck profile. You can load this profile by using the name on commands that support the "--jclcheck-profile" option.
    • +
    +
  • +
+

JCLCheck Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Port for the JCLCheck API service that is running on the mainframe system.

      +

      Default value: 12697

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: cajclcheck/api/v1

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for JCLCheck connection (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --jclcheck-options | --jo (string)

    +
      +
    • The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the jclcheck profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a JCLCheck profile named 'jcl123' to run JCLCheck at host zos123 and port 1234:

    +
      +
    • zowe profiles create jclcheck-profile jcl123 --host zos123 --port 1234 --user ibmuser --pass myp4ss
    • +
    +
  • +
  • +

    Create a JCLCheck profile with default set of JCLCheck runtime options specified:

    +
      +
    • zowe profiles create jclcheck-profile jcl123 --host zos123 --port 1234 --user ibmuser --pass myp4ss --jo "NOAS NOAU NOHCD NOJCL NORES NOSIGN"
    • +
    +
  • +
+

zoweprofilescreatejclx-profile

+

Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create jclx-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new jclx profile. You can load this profile by using the name on commands that support the "--jclx-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --remote-home-dir (string)

    +
      +
    • The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
    • +
    +
  • +
  • +

    --remote-temp-dir (string)

    +
      +
    • The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
    • +
    +
  • +
  • +

    --language (string)

    +
      +
    • +

      The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.

      +

      Default value: ENG
      +Allowed values: ENG, JPN

      +
    • +
    +
  • +
  • +

    --response-encoding (string)

    +
      +
    • +

      The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.

      +

      Default value: utf-8

      +
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the jclx profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

zoweprofilescreatemat-profile

+

MAT Analyze CLI profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create mat-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new mat profile. You can load this profile by using the name on commands that support the "--mat-profile" option.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the mat profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a MAT profile called 'matprofile' using your MAT configuration and REST API details, with the MAT REST API server integrated with the Zowe API Mediation Layer:

    +
      +
    • zowe profiles create mat-profile matprofile --o http --H localhost --P 1234 --u user --pw pass --base-path 'API\MAT'
    • +
    +
  • +
  • +

    Create a MAT profile called 'matprofile' using your MAT configuration and the details of the MAT REST API server without integration with the Zowe API Mediation Layer,and define the 'c:\listings' directory to store program listings for instant analysis from your VS Code IDE:

    +
      +
    • zowe profiles create mat-profile matprofile --o http --H localhost --P 1234 --u user --pw pass --listingDir 'c:\listings'
    • +
    +
  • +
+

zoweprofilescreatemq-profile

+

An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create mq-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new mq profile. You can load this profile by using the name on commands that support the "--mq-profile" option.
    • +
    +
  • +
+

MQ Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The host name used to access the IBM MQ REST API. This might be the host name of the IBM MQ mqweb server, or the Zowe API Mediation Layer..
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number used to access the IBM MQ REST API. This might be the port number of the IBM MQ mqweb server, or the Zowe API Mediation Layer.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The mainframe (MQ) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The mainframe (MQ) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the MQ protocol (http or https).

      +

      Default value: http
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the mq profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an MQ profile named 'mqprofile' to connect to MQ at host zos123 and port 1234:

    +
      +
    • zowe profiles create mq-profile mq --host mq123 --port 1234 --user ibmuser --password myp4ss
    • +
    +
  • +
+

zoweprofilescreateomspool-profile

+

Configuration profile for Spool, where you specify information about your Spool instance

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create omspool-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new omspool profile. You can load this profile by using the name on commands that support the "--omspool-profile" option.
    • +
    +
  • +
+

SPOOL OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --spoolhlq | --hlq (string)

    +
      +
    • High level qualifier of Spool installation.
    • +
    +
  • +
  • +

    --subsys | --sub (string)

    +
      +
    • +

      Spool subsystem name.

      +

      Default value: ESF

      +
    • +
    +
  • +
  • +

    --outds | --out (string)

    +
      +
    • The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.
    • +
    +
  • +
  • +

    --clist | --cl (string)

    +
      +
    • The data set containing ESFZOWE REXX exec.
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the omspool profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a profile for Spool named 'myProfile' with TSO account information '1234567890', Spool installation high level qualifier of 'SPOOL.HLQ', subsystem name 'ESF1', output response data set 'OUTPUT.RESPONSE.DS', and data set 'USER.CLIST', containing ESFZOWE REXX exec:

    +
      +
    • zowe profiles create omspool-profile myProfile --account 1234567890 --spoolhlq SPOOL.HLQ --subsys ESF1 --outds OUTPUT.RESPONSE.DS --clist USER.CLIST
    • +
    +
  • +
+

zoweprofilescreateops-profile

+

The OPS Web Services session profile schema, where you specify your session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create ops-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ops profile. You can load this profile by using the name on commands that support the "--ops-profile" option.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the ops profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an OPS profile called 'myLPAR' to connect to OPS Web Services at host lpar123 and port 8080, using http protocol, allowing self-signed certificates:

    +
      +
    • zowe profiles create ops-profile myLPAR --host lpar123 --port 8080 --user ibmuser --password !@#$^ --prot http --reject-unauthorized false
    • +
    +
  • +
+

zoweprofilescreatepma-profile

+

MAT Detect CLI profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create pma-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new pma profile. You can load this profile by using the name on commands that support the "--pma-profile" option.
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the pma profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a PMA profile called pma123 using your valid jobcard and PMA configuration details:

    +
      +
    • zowe profiles create pma-profile pma123 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+

zoweprofilescreatessh-profile

+

z/OS SSH Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create ssh-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ssh profile. You can load this profile by using the name on commands that support the "--ssh-profile" option.
    • +
    +
  • +
+

z/OS Ssh Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OS SSH server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OS SSH server port.

      +

      Default value: 22

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --privateKey | --key | --pk (string)

    +
      +
    • Path to a file containing your private key, that must match a public key stored in the server for authentication
    • +
    +
  • +
  • +

    --keyPassphrase | --passphrase | --kp (string)

    +
      +
    • Private key passphrase, which unlocks the private key.
    • +
    +
  • +
  • +

    --handshakeTimeout | --timeout | --to (number)

    +
      +
    • How long in milliseconds to wait for the SSH handshake to complete.
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the ssh profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a ssh profile called 'ssh111' to connect to z/OS SSH server at host 'zos123' and default port 22:

    +
      +
    • zowe profiles create ssh-profile ssh111 --host sshhost --user ibmuser --password myp4ss
    • +
    +
  • +
  • +

    Create a ssh profile called 'ssh222' to connect to z/OS SSH server at host 'zos123' and port 13022:

    +
      +
    • zowe profiles create ssh-profile ssh222 --host sshhost --port 13022 --user ibmuser --password myp4ss
    • +
    +
  • +
  • +

    Create a ssh profile called 'ssh333' to connect to z/OS SSH server at host 'zos123' using a privatekey '/path/to/privatekey' and its decryption passphrase 'privateKeyPassphrase' for privatekey authentication:

    +
      +
    • zowe profiles create ssh-profile ssh333 --host sshhost --user ibmuser --privateKey /path/to/privatekey --keyPassphrase privateKeyPassphrase
    • +
    +
  • +
  • +

    Create a ssh profile called 'ssh444' to connect to z/OS SSH server on default port 22, without specifying username, host, or password, preventing those values from being stored on disk:

    +
      +
    • zowe profiles create ssh-profile ssh444 --privateKey /path/to/privatekey
    • +
    +
  • +
+

zoweprofilescreatesysview-format-profile

+

The SYSVIEW format profile schema, where you specify display settings

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create sysview-format-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new sysview-format profile. You can load this profile by using the name on commands that support the "--sysview-format-profile" option.
    • +
    +
  • +
+

display options

+
    +
  • +

    --context-fields | --cf (array)

    +
      +
    • Context fields to display. Defaults to hiding all context
    • +
    +
  • +
  • +

    --overview | -o (boolean)

    +
      +
    • Display the overview section
    • +
    +
  • +
  • +

    --info | -i (boolean)

    +
      +
    • Display the information area, if any
    • +
    +
  • +
  • +

    --pretty | -p (boolean)

    +
      +
    • Display formatted data
    • +
    +
  • +
  • +

    --blank-if-zero | --biz | -b (boolean)

    +
      +
    • Show a blank space instead of '0' values
    • +
    +
  • +
  • +

    --truncate | --tr (boolean)

    +
      +
    • +

      Truncate displays that are too wide for the console

      +

      Default value: false

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the sysview-format profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a SYSVIEW format profile to display the context fields 'commandName' and 'screenTitle', the information area, and not the overview area for all requests. Data will be formatted, and '0's will be blanked:

    +
      +
    • zowe profiles create sysview-format-profile myFormat --cf commandName screenTitle --overview false --info true --pretty true --biz true
    • +
    +
  • +
+

zoweprofilescreatesysview-profile

+

The SYSVIEW session profile schema, where you specify your session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create sysview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new sysview profile. You can load this profile by using the name on commands that support the "--sysview-profile" option.
    • +
    +
  • +
+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • +

      SSID of the SYSVIEW instance. Default value: GSVX

      +

      Default value: GSVX

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: /api/v1

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the sysview profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a SYSVIEW profile called 'myLPAR' to connect to the SYSVIEW REST API at host lpar123, port 8080, and ssid ABCD:

    +
      +
    • zowe profiles create sysview-profile myLPAR --host lpar123 --port 8080 --user ibmuser --password !@#$^ --ssid ABCD
    • +
    +
  • +
  • +

    You already have a base profile with username and password. Create a SYSVIEW profile to specify host lpar123 and port 8080, using the default ssid of GSVX:

    +
      +
    • zowe profiles create sysview-profile myLPAR2 --host lpar123 --port 8080
    • +
    +
  • +
  • +

    You already have a base profile to connect to an API Mediation Layer and use SSO tokens. Create a SYSVIEW profile to point to the SYSVIEW REST API by specifying the base path /my-sysview-instance/api/v1:

    +
      +
    • zowe profiles create sysview-profile myLPAR3 --base-path /my-sysview-instance/api/v1
    • +
    +
  • +
+

zoweprofilescreatetso-profile

+

z/OS TSO/E User Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create tso-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new tso profile. You can load this profile by using the name on commands that support the "--tso-profile" option.
    • +
    +
  • +
+

TSO ADDRESS SPACE OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • Your z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --character-set | --cs (string)

    +
      +
    • +

      Character set for address space to convert messages and responses from UTF-8 to EBCDIC.

      +

      Default value: 697

      +
    • +
    +
  • +
  • +

    --code-page | --cp (string)

    +
      +
    • +

      Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC.

      +

      Default value: 1047

      +
    • +
    +
  • +
  • +

    --columns | --cols (number)

    +
      +
    • +

      The number of columns on a screen.

      +

      Default value: 80

      +
    • +
    +
  • +
  • +

    --logon-procedure | -l (string)

    +
      +
    • +

      The logon procedure to use when creating TSO procedures on your behalf.

      +

      Default value: IZUFPROC

      +
    • +
    +
  • +
  • +

    --region-size | --rs (number)

    +
      +
    • +

      Region size for the TSO/E address space.

      +

      Default value: 4096

      +
    • +
    +
  • +
  • +

    --rows (number)

    +
      +
    • +

      The number of rows on a screen.

      +

      Default value: 24

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the tso profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a tso profile called 'myprof' with default settings and JES accounting information of 'IZUACCT':

    +
      +
    • zowe profiles create tso-profile myprof -a IZUACCT
    • +
    +
  • +
  • +

    Create a tso profile called 'largeregion' with a region size of 8192, a logon procedure of MYPROC, and JES accounting information of '1234':

    +
      +
    • zowe profiles create tso-profile largeregion -a 1234 --rs 8192
    • +
    +
  • +
  • +

    Create a tso profile called 'myprof2' with default settings and region size of 8192, without storing the user account on disk:

    +
      +
    • zowe profiles create tso-profile myprof2 --rs 8192
    • +
    +
  • +
+

zoweprofilescreatezftp-profile

+

Configuration profile for z/OS FTP

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create zftp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new zftp profile. You can load this profile by using the name on commands that support the "--zftp-profile" option.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set.
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the zftp profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a zftp profile called 'myprofile' with default settings (port, timeout, etc.) to connect with the host system 123.:

    +
      +
    • zowe profiles create zftp-profile myprofile -u ibmuser -p ibmp4ss -H sys123
    • +
    +
  • +
+

zoweprofilescreatezosmf-profile

+

z/OSMF Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create zosmf-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new zosmf profile. You can load this profile by using the name on commands that support the "--zosmf-profile" option.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set and USS files. The default encoding if not specified is IBM-1047.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the zosmf profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a zosmf profile called 'zos123' to connect to z/OSMF at host zos123 and port 1443:

    +
      +
    • zowe profiles create zosmf-profile zos123 --host zos123 --port 1443 --user ibmuser --password myp4ss
    • +
    +
  • +
  • +

    Create a zosmf profile called 'zos124' to connect to z/OSMF at the host zos124 (default port - 443) and allow self-signed certificates:

    +
      +
    • zowe profiles create zosmf-profile zos124 --host zos124 --user ibmuser --password myp4ss --reject-unauthorized false
    • +
    +
  • +
  • +

    Create a zosmf profile called 'zos125' to connect to z/OSMF at the host zos125 and port 1443, not specifying a username or password so they are not stored on disk; these will need to be specified on every command:

    +
      +
    • zowe profiles create zosmf-profile zos125 --host zos125 --port 1443
    • +
    +
  • +
  • +

    Create a zosmf profile called 'zos126' to connect to z/OSMF on the default port 443 and allow self-signed certificates, not specifying a username, password, or host so they are not stored on disk; these will need to be specified on every command:

    +
      +
    • zowe profiles create zosmf-profile zos126 --reject-unauthorized false
    • +
    +
  • +
  • +

    Create a zosmf profile called 'zosAPIML' to connect to z/OSMF via the Zowe API Mediation Layer running at host 'zosAPIML', port '7554', and allow for self-signed certificates. To reduce duplication, you could elect to store the 'host', 'port', 'reject-unauthorized', 'user', and 'password' values for the API Mediation Layer in a base profile and only store the 'base-path' of the service in the zosmf profile:

    +
      +
    • zowe profiles create zosmf-profile zosAPIML --host zosAPIML --port 7554 --user ibmuser --password myp4ss --reject-unauthorized false --base-path ibmzosmf/api/v1
    • +
    +
  • +
+

zoweprofilesdelete

+

Delete existing profiles.

+

Warning: This group has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

zoweprofilesdeletebase-profile

+

Delete a base profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete base-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the base profile to be deleted. You can also load this profile by using the name on commands that support the "--base-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a base profile named profilename:

    +
      +
    • zowe profiles delete base-profile profilename
    • +
    +
  • +
+

zoweprofilesdeleteca7-profile

+

Delete a ca7 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete ca7-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the ca7 profile to be deleted. You can also load this profile by using the name on commands that support the "--ca7-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a ca7 profile named profilename:

    +
      +
    • zowe profiles delete ca7-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletecaview-profile

+

Delete a caview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete caview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the caview profile to be deleted. You can also load this profile by using the name on commands that support the "--caview-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a caview profile named profilename:

    +
      +
    • zowe profiles delete caview-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletecics-profile

+

Delete a cics profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete cics-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the cics profile to be deleted. You can also load this profile by using the name on commands that support the "--cics-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a cics profile named profilename:

    +
      +
    • zowe profiles delete cics-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletedb2-profile

+

Delete a db2 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the db2 profile to be deleted. You can also load this profile by using the name on commands that support the "--db2-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a db2 profile named profilename:

    +
      +
    • zowe profiles delete db2-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletedbm-db2-options-profile

+

Delete a dbm-db2-options profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete dbm-db2-options-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the dbm-db2-options profile to be deleted. You can also load this profile by using the name on commands that support the "--dbm-db2-options-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a dbm-db2-options profile named profilename:

    +
      +
    • zowe profiles delete dbm-db2-options-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletedbm-db2-profile

+

Delete a dbm-db2 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete dbm-db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the dbm-db2 profile to be deleted. You can also load this profile by using the name on commands that support the "--dbm-db2-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a dbm-db2 profile named profilename:

    +
      +
    • zowe profiles delete dbm-db2-profile profilename
    • +
    +
  • +
+

zoweprofilesdeleteebg-profile

+

Delete a ebg profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete ebg-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the ebg profile to be deleted. You can also load this profile by using the name on commands that support the "--ebg-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a ebg profile named profilename:

    +
      +
    • zowe profiles delete ebg-profile profilename
    • +
    +
  • +
+

zoweprofilesdeleteendevor-location-profile

+

Delete a endevor-location profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete endevor-location-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the endevor-location profile to be deleted. You can also load this profile by using the name on commands that support the "--endevor-location-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a endevor-location profile named profilename:

    +
      +
    • zowe profiles delete endevor-location-profile profilename
    • +
    +
  • +
+

zoweprofilesdeleteendevor-profile

+

Delete a endevor profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete endevor-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the endevor profile to be deleted. You can also load this profile by using the name on commands that support the "--endevor-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a endevor profile named profilename:

    +
      +
    • zowe profiles delete endevor-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletefmp-profile

+

Delete a fmp profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete fmp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the fmp profile to be deleted. You can also load this profile by using the name on commands that support the "--fmp-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a fmp profile named profilename:

    +
      +
    • zowe profiles delete fmp-profile profilename
    • +
    +
  • +
+

zoweprofilesdeleteidms-profile

+

Delete a idms profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete idms-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the idms profile to be deleted. You can also load this profile by using the name on commands that support the "--idms-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a idms profile named profilename:

    +
      +
    • zowe profiles delete idms-profile profilename
    • +
    +
  • +
+

zoweprofilesdeleteims-profile

+

Delete a ims profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete ims-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the ims profile to be deleted. You can also load this profile by using the name on commands that support the "--ims-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a ims profile named profilename:

    +
      +
    • zowe profiles delete ims-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletejclcheck-profile

+

Delete a jclcheck profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete jclcheck-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the jclcheck profile to be deleted. You can also load this profile by using the name on commands that support the "--jclcheck-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a jclcheck profile named profilename:

    +
      +
    • zowe profiles delete jclcheck-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletejclx-profile

+

Delete a jclx profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete jclx-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the jclx profile to be deleted. You can also load this profile by using the name on commands that support the "--jclx-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a jclx profile named profilename:

    +
      +
    • zowe profiles delete jclx-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletemat-profile

+

Delete a mat profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete mat-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the mat profile to be deleted. You can also load this profile by using the name on commands that support the "--mat-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a mat profile named profilename:

    +
      +
    • zowe profiles delete mat-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletemq-profile

+

Delete a mq profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete mq-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the mq profile to be deleted. You can also load this profile by using the name on commands that support the "--mq-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a mq profile named profilename:

    +
      +
    • zowe profiles delete mq-profile profilename
    • +
    +
  • +
+

zoweprofilesdeleteomspool-profile

+

Delete a omspool profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete omspool-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the omspool profile to be deleted. You can also load this profile by using the name on commands that support the "--omspool-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a omspool profile named profilename:

    +
      +
    • zowe profiles delete omspool-profile profilename
    • +
    +
  • +
+

zoweprofilesdeleteops-profile

+

Delete a ops profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete ops-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the ops profile to be deleted. You can also load this profile by using the name on commands that support the "--ops-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a ops profile named profilename:

    +
      +
    • zowe profiles delete ops-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletepma-profile

+

Delete a pma profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete pma-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the pma profile to be deleted. You can also load this profile by using the name on commands that support the "--pma-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a pma profile named profilename:

    +
      +
    • zowe profiles delete pma-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletessh-profile

+

Delete a ssh profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete ssh-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the ssh profile to be deleted. You can also load this profile by using the name on commands that support the "--ssh-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a ssh profile named profilename:

    +
      +
    • zowe profiles delete ssh-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletesysview-format-profile

+

Delete a sysview-format profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete sysview-format-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the sysview-format profile to be deleted. You can also load this profile by using the name on commands that support the "--sysview-format-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a sysview-format profile named profilename:

    +
      +
    • zowe profiles delete sysview-format-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletesysview-profile

+

Delete a sysview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete sysview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the sysview profile to be deleted. You can also load this profile by using the name on commands that support the "--sysview-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a sysview profile named profilename:

    +
      +
    • zowe profiles delete sysview-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletetso-profile

+

Delete a tso profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete tso-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the tso profile to be deleted. You can also load this profile by using the name on commands that support the "--tso-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a tso profile named profilename:

    +
      +
    • zowe profiles delete tso-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletezftp-profile

+

Delete a zftp profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete zftp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the zftp profile to be deleted. You can also load this profile by using the name on commands that support the "--zftp-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a zftp profile named profilename:

    +
      +
    • zowe profiles delete zftp-profile profilename
    • +
    +
  • +
+

zoweprofilesdeletezosmf-profile

+

Delete a zosmf profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete zosmf-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the zosmf profile to be deleted. You can also load this profile by using the name on commands that support the "--zosmf-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a zosmf profile named profilename:

    +
      +
    • zowe profiles delete zosmf-profile profilename
    • +
    +
  • +
+

zoweprofileslist

+

List profiles of the type {{type}}.

+

Warning: This group has been deprecated.
+Recommended replacement: The 'config list' command

+

zoweprofileslistbase-profiles

+

Base profile that stores values shared by multiple service profiles

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list base-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List base profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type base:

    +
      +
    • zowe profiles list base-profiles
    • +
    +
  • +
  • +

    List profiles of type base and display their contents:

    +
      +
    • zowe profiles list base-profiles --sc
    • +
    +
  • +
+

zoweprofileslistca7-profiles

+

A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list ca7-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List ca7 profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type ca7:

    +
      +
    • zowe profiles list ca7-profiles
    • +
    +
  • +
  • +

    List profiles of type ca7 and display their contents:

    +
      +
    • zowe profiles list ca7-profiles --sc
    • +
    +
  • +
+

zoweprofileslistcaview-profiles

+

Configuration profile for View

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list caview-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List caview profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type caview:

    +
      +
    • zowe profiles list caview-profiles
    • +
    +
  • +
  • +

    List profiles of type caview and display their contents:

    +
      +
    • zowe profiles list caview-profiles --sc
    • +
    +
  • +
+

zoweprofileslistcics-profiles

+

A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list cics-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List cics profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type cics:

    +
      +
    • zowe profiles list cics-profiles
    • +
    +
  • +
  • +

    List profiles of type cics and display their contents:

    +
      +
    • zowe profiles list cics-profiles --sc
    • +
    +
  • +
+

zoweprofileslistdb2-profiles

+

A profile for interaction with Db2 for the z/OS region

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list db2-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List db2 profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type db2:

    +
      +
    • zowe profiles list db2-profiles
    • +
    +
  • +
  • +

    List profiles of type db2 and display their contents:

    +
      +
    • zowe profiles list db2-profiles --sc
    • +
    +
  • +
+

zoweprofileslistdbm-db2-options-profiles

+

The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list dbm-db2-options-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List dbm-db2-options profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type dbm-db2-options:

    +
      +
    • zowe profiles list dbm-db2-options-profiles
    • +
    +
  • +
  • +

    List profiles of type dbm-db2-options and display their contents:

    +
      +
    • zowe profiles list dbm-db2-options-profiles --sc
    • +
    +
  • +
+

zoweprofileslistdbm-db2-profiles

+

The DBM-Db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list dbm-db2-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List dbm-db2 profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type dbm-db2:

    +
      +
    • zowe profiles list dbm-db2-profiles
    • +
    +
  • +
  • +

    List profiles of type dbm-db2 and display their contents:

    +
      +
    • zowe profiles list dbm-db2-profiles --sc
    • +
    +
  • +
+

zoweprofileslistebg-profiles

+

An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the Endevor Bridge for Git server of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list ebg-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List ebg profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type ebg:

    +
      +
    • zowe profiles list ebg-profiles
    • +
    +
  • +
  • +

    List profiles of type ebg and display their contents:

    +
      +
    • zowe profiles list ebg-profiles --sc
    • +
    +
  • +
+

zoweprofileslistendevor-location-profiles

+

The Endevor element location, where you specify your working environment, system and subsystem

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list endevor-location-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List endevor-location profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type endevor-location:

    +
      +
    • zowe profiles list endevor-location-profiles
    • +
    +
  • +
  • +

    List profiles of type endevor-location and display their contents:

    +
      +
    • zowe profiles list endevor-location-profiles --sc
    • +
    +
  • +
+

zoweprofileslistendevor-profiles

+

The endevor profile schema, where you specify your endevor session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list endevor-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List endevor profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type endevor:

    +
      +
    • zowe profiles list endevor-profiles
    • +
    +
  • +
  • +

    List profiles of type endevor and display their contents:

    +
      +
    • zowe profiles list endevor-profiles --sc
    • +
    +
  • +
+

zoweprofileslistfmp-profiles

+

File Master Plus profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list fmp-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List fmp profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type fmp:

    +
      +
    • zowe profiles list fmp-profiles
    • +
    +
  • +
  • +

    List profiles of type fmp and display their contents:

    +
      +
    • zowe profiles list fmp-profiles --sc
    • +
    +
  • +
+

zoweprofileslistidms-profiles

+

An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list idms-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List idms profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type idms:

    +
      +
    • zowe profiles list idms-profiles
    • +
    +
  • +
  • +

    List profiles of type idms and display their contents:

    +
      +
    • zowe profiles list idms-profiles --sc
    • +
    +
  • +
+

zoweprofileslistims-profiles

+

An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list ims-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List ims profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type ims:

    +
      +
    • zowe profiles list ims-profiles
    • +
    +
  • +
  • +

    List profiles of type ims and display their contents:

    +
      +
    • zowe profiles list ims-profiles --sc
    • +
    +
  • +
+

zoweprofileslistjclcheck-profiles

+

A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list jclcheck-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List jclcheck profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type jclcheck:

    +
      +
    • zowe profiles list jclcheck-profiles
    • +
    +
  • +
  • +

    List profiles of type jclcheck and display their contents:

    +
      +
    • zowe profiles list jclcheck-profiles --sc
    • +
    +
  • +
+

zoweprofileslistjclx-profiles

+

Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list jclx-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List jclx profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type jclx:

    +
      +
    • zowe profiles list jclx-profiles
    • +
    +
  • +
  • +

    List profiles of type jclx and display their contents:

    +
      +
    • zowe profiles list jclx-profiles --sc
    • +
    +
  • +
+

zoweprofileslistmat-profiles

+

MAT Analyze CLI profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list mat-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List mat profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type mat:

    +
      +
    • zowe profiles list mat-profiles
    • +
    +
  • +
  • +

    List profiles of type mat and display their contents:

    +
      +
    • zowe profiles list mat-profiles --sc
    • +
    +
  • +
+

zoweprofileslistmq-profiles

+

An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list mq-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List mq profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type mq:

    +
      +
    • zowe profiles list mq-profiles
    • +
    +
  • +
  • +

    List profiles of type mq and display their contents:

    +
      +
    • zowe profiles list mq-profiles --sc
    • +
    +
  • +
+

zoweprofileslistomspool-profiles

+

Configuration profile for Spool, where you specify information about your Spool instance

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list omspool-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List omspool profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type omspool:

    +
      +
    • zowe profiles list omspool-profiles
    • +
    +
  • +
  • +

    List profiles of type omspool and display their contents:

    +
      +
    • zowe profiles list omspool-profiles --sc
    • +
    +
  • +
+

zoweprofileslistops-profiles

+

The OPS Web Services session profile schema, where you specify your session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list ops-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List ops profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type ops:

    +
      +
    • zowe profiles list ops-profiles
    • +
    +
  • +
  • +

    List profiles of type ops and display their contents:

    +
      +
    • zowe profiles list ops-profiles --sc
    • +
    +
  • +
+

zoweprofileslistpma-profiles

+

MAT Detect CLI profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list pma-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List pma profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type pma:

    +
      +
    • zowe profiles list pma-profiles
    • +
    +
  • +
  • +

    List profiles of type pma and display their contents:

    +
      +
    • zowe profiles list pma-profiles --sc
    • +
    +
  • +
+

zoweprofileslistssh-profiles

+

z/OS SSH Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list ssh-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List ssh profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type ssh:

    +
      +
    • zowe profiles list ssh-profiles
    • +
    +
  • +
  • +

    List profiles of type ssh and display their contents:

    +
      +
    • zowe profiles list ssh-profiles --sc
    • +
    +
  • +
+

zoweprofileslistsysview-format-profiles

+

The SYSVIEW format profile schema, where you specify display settings

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list sysview-format-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List sysview-format profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type sysview-format:

    +
      +
    • zowe profiles list sysview-format-profiles
    • +
    +
  • +
  • +

    List profiles of type sysview-format and display their contents:

    +
      +
    • zowe profiles list sysview-format-profiles --sc
    • +
    +
  • +
+

zoweprofileslistsysview-profiles

+

The SYSVIEW session profile schema, where you specify your session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list sysview-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List sysview profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type sysview:

    +
      +
    • zowe profiles list sysview-profiles
    • +
    +
  • +
  • +

    List profiles of type sysview and display their contents:

    +
      +
    • zowe profiles list sysview-profiles --sc
    • +
    +
  • +
+

zoweprofileslisttso-profiles

+

z/OS TSO/E User Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list tso-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List tso profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type tso:

    +
      +
    • zowe profiles list tso-profiles
    • +
    +
  • +
  • +

    List profiles of type tso and display their contents:

    +
      +
    • zowe profiles list tso-profiles --sc
    • +
    +
  • +
+

zoweprofileslistzftp-profiles

+

Configuration profile for z/OS FTP

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list zftp-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List zftp profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type zftp:

    +
      +
    • zowe profiles list zftp-profiles
    • +
    +
  • +
  • +

    List profiles of type zftp and display their contents:

    +
      +
    • zowe profiles list zftp-profiles --sc
    • +
    +
  • +
+

zoweprofileslistzosmf-profiles

+

z/OSMF Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list zosmf-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List zosmf profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type zosmf:

    +
      +
    • zowe profiles list zosmf-profiles
    • +
    +
  • +
  • +

    List profiles of type zosmf and display their contents:

    +
      +
    • zowe profiles list zosmf-profiles --sc
    • +
    +
  • +
+

zoweprofilesset-default

+

Set which profiles are loaded by default.

+

Warning: This group has been deprecated.
+Recommended replacement: The 'config set' command

+

zoweprofilesset-defaultbase-profile

+

The base set default-profiles command allows you to set the default profiles for this command group. When a base command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default base-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the base group. When you issue commands within the base group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type base to the profile named 'profilename':

    +
      +
    • zowe profiles set-default base-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultca7-profile

+

The ca7 set default-profiles command allows you to set the default profiles for this command group. When a ca7 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default ca7-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the ca7 group. When you issue commands within the ca7 group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type ca7 to the profile named 'profilename':

    +
      +
    • zowe profiles set-default ca7-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultcaview-profile

+

The caview set default-profiles command allows you to set the default profiles for this command group. When a caview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default caview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the caview group. When you issue commands within the caview group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type caview to the profile named 'profilename':

    +
      +
    • zowe profiles set-default caview-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultcics-profile

+

The cics set default-profiles command allows you to set the default profiles for this command group. When a cics command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default cics-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the cics group. When you issue commands within the cics group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type cics to the profile named 'profilename':

    +
      +
    • zowe profiles set-default cics-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultdb2-profile

+

The db2 set default-profiles command allows you to set the default profiles for this command group. When a db2 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the db2 group. When you issue commands within the db2 group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type db2 to the profile named 'profilename':

    +
      +
    • zowe profiles set-default db2-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultdbm-db2-options-profile

+

The dbm-db2-options set default-profiles command allows you to set the default profiles for this command group. When a dbm-db2-options command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default dbm-db2-options-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the dbm-db2-options group. When you issue commands within the dbm-db2-options group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type dbm-db2-options to the profile named 'profilename':

    +
      +
    • zowe profiles set-default dbm-db2-options-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultdbm-db2-profile

+

The dbm-db2 set default-profiles command allows you to set the default profiles for this command group. When a dbm-db2 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default dbm-db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the dbm-db2 group. When you issue commands within the dbm-db2 group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type dbm-db2 to the profile named 'profilename':

    +
      +
    • zowe profiles set-default dbm-db2-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultebg-profile

+

The ebg set default-profiles command allows you to set the default profiles for this command group. When a ebg command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default ebg-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the ebg group. When you issue commands within the ebg group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type ebg to the profile named 'profilename':

    +
      +
    • zowe profiles set-default ebg-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultendevor-location-profile

+

The endevor-location set default-profiles command allows you to set the default profiles for this command group. When a endevor-location command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default endevor-location-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the endevor-location group. When you issue commands within the endevor-location group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type endevor-location to the profile named 'profilename':

    +
      +
    • zowe profiles set-default endevor-location-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultendevor-profile

+

The endevor set default-profiles command allows you to set the default profiles for this command group. When a endevor command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default endevor-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the endevor group. When you issue commands within the endevor group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type endevor to the profile named 'profilename':

    +
      +
    • zowe profiles set-default endevor-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultfmp-profile

+

The fmp set default-profiles command allows you to set the default profiles for this command group. When a fmp command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default fmp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the fmp group. When you issue commands within the fmp group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type fmp to the profile named 'profilename':

    +
      +
    • zowe profiles set-default fmp-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultidms-profile

+

The idms set default-profiles command allows you to set the default profiles for this command group. When a idms command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default idms-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the idms group. When you issue commands within the idms group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type idms to the profile named 'profilename':

    +
      +
    • zowe profiles set-default idms-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultims-profile

+

The ims set default-profiles command allows you to set the default profiles for this command group. When a ims command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default ims-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the ims group. When you issue commands within the ims group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type ims to the profile named 'profilename':

    +
      +
    • zowe profiles set-default ims-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultjclcheck-profile

+

The jclcheck set default-profiles command allows you to set the default profiles for this command group. When a jclcheck command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default jclcheck-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the jclcheck group. When you issue commands within the jclcheck group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type jclcheck to the profile named 'profilename':

    +
      +
    • zowe profiles set-default jclcheck-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultjclx-profile

+

The jclx set default-profiles command allows you to set the default profiles for this command group. When a jclx command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default jclx-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the jclx group. When you issue commands within the jclx group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type jclx to the profile named 'profilename':

    +
      +
    • zowe profiles set-default jclx-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultmat-profile

+

The mat set default-profiles command allows you to set the default profiles for this command group. When a mat command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default mat-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the mat group. When you issue commands within the mat group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type mat to the profile named 'profilename':

    +
      +
    • zowe profiles set-default mat-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultmq-profile

+

The mq set default-profiles command allows you to set the default profiles for this command group. When a mq command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default mq-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the mq group. When you issue commands within the mq group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type mq to the profile named 'profilename':

    +
      +
    • zowe profiles set-default mq-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultomspool-profile

+

The omspool set default-profiles command allows you to set the default profiles for this command group. When a omspool command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default omspool-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the omspool group. When you issue commands within the omspool group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type omspool to the profile named 'profilename':

    +
      +
    • zowe profiles set-default omspool-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultops-profile

+

The ops set default-profiles command allows you to set the default profiles for this command group. When a ops command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default ops-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the ops group. When you issue commands within the ops group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type ops to the profile named 'profilename':

    +
      +
    • zowe profiles set-default ops-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultpma-profile

+

The pma set default-profiles command allows you to set the default profiles for this command group. When a pma command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default pma-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the pma group. When you issue commands within the pma group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type pma to the profile named 'profilename':

    +
      +
    • zowe profiles set-default pma-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultssh-profile

+

The ssh set default-profiles command allows you to set the default profiles for this command group. When a ssh command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default ssh-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the ssh group. When you issue commands within the ssh group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type ssh to the profile named 'profilename':

    +
      +
    • zowe profiles set-default ssh-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultsysview-format-profile

+

The sysview-format set default-profiles command allows you to set the default profiles for this command group. When a sysview-format command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default sysview-format-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the sysview-format group. When you issue commands within the sysview-format group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type sysview-format to the profile named 'profilename':

    +
      +
    • zowe profiles set-default sysview-format-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultsysview-profile

+

The sysview set default-profiles command allows you to set the default profiles for this command group. When a sysview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default sysview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the sysview group. When you issue commands within the sysview group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type sysview to the profile named 'profilename':

    +
      +
    • zowe profiles set-default sysview-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaulttso-profile

+

The tso set default-profiles command allows you to set the default profiles for this command group. When a tso command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default tso-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the tso group. When you issue commands within the tso group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type tso to the profile named 'profilename':

    +
      +
    • zowe profiles set-default tso-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultzftp-profile

+

The zftp set default-profiles command allows you to set the default profiles for this command group. When a zftp command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default zftp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the zftp group. When you issue commands within the zftp group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type zftp to the profile named 'profilename':

    +
      +
    • zowe profiles set-default zftp-profile profilename
    • +
    +
  • +
+

zoweprofilesset-defaultzosmf-profile

+

The zosmf set default-profiles command allows you to set the default profiles for this command group. When a zosmf command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default zosmf-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the zosmf group. When you issue commands within the zosmf group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type zosmf to the profile named 'profilename':

    +
      +
    • zowe profiles set-default zosmf-profile profilename
    • +
    +
  • +
+

zoweprofilesupdate

+

Update a {{type}} profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.

+

Warning: This group has been deprecated.
+Recommended replacement: The 'config set' command

+

zoweprofilesupdatebase-profile

+

Base profile that stores values shared by multiple service profiles

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update base-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new base profile. You can load this profile by using the name on commands that support the "--base-profile" option.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a base profile named 'base1' with a new username and password:

    +
      +
    • zowe profiles update base-profile base1 --user newuser --password newp4ss
    • +
    +
  • +
+

zoweprofilesupdateca7-profile

+

A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update ca7-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ca7 profile. You can load this profile by using the name on commands that support the "--ca7-profile" option.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
+

zoweprofilesupdatecaview-profile

+

Configuration profile for View

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update caview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new caview profile. You can load this profile by using the name on commands that support the "--caview-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • Port of the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • Context name of the target View REST API instance.
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
+

zoweprofilesupdatecics-profile

+

A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update cics-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new cics profile. You can load this profile by using the name on commands that support the "--cics-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CMCI server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The CMCI server port
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your username to connect to CICS
    • +
    +
  • +
  • +

    --password | -p (string)

    +
      +
    • Your password to connect to CICS
    • +
    +
  • +
  • +

    --region-name (string)

    +
      +
    • The name of the CICS region name to interact with
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to interact with
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

zoweprofilesupdatedb2-profile

+

A profile for interaction with Db2 for the z/OS region

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new db2 profile. You can load this profile by using the name on commands that support the "--db2-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The Db2 server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Db2 server port number
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The Db2 user ID (may be the same as the TSO login)
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The Db2 password (may be the same as the TSO password)
    • +
    +
  • +
  • +

    --database | -d (string)

    +
      +
    • The name of the database
    • +
    +
  • +
  • +

    --ssl-file | -s (string)

    +
      +
    • Path to an SSL Certificate file
    • +
    +
  • +
+

zoweprofilesupdatedbm-db2-options-profile

+

The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update dbm-db2-options-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new dbm-db2-options profile. You can load this profile by using the name on commands that support the "--dbm-db2-options-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --change-set | --cs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.

      +

      Format:

      +

      <change-set-creator.change-set-name>

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --change-set-values | --csv (array)

    +
      +
    • +

      Specifies the global change specifications that modify Db2 object attributes during a command execution.

      +

      Format:

      +

      <object-attribute> <from-value> <to-value>

      +

      The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

      +

      For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Example:

      +

      The following example demonstrates changes to the table schema (creator) and tablespace names:

      +

      TBCR TEST% PROD%
      +TBTS TESTTS% PRODTS%

      +

      Note:
      +- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
      +- The changeSetValues options-profile option has the same behavior as the change-set-file command option.

      +
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --description | -d (string)

    +
      +
    • Specifies a 1- to 25-character description for the RC/Migrator compare strategy.
    • +
    +
  • +
  • +

    --id (string)

    +
      +
    • +

      Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.

      +

      Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @.

      +
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --match-set | --ms (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <match-set-creator.match-set-name>

      +

      For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --match-set-values | --msv (array)

    +
      +
    • +

      Specifies the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <object-type> <source-name-mask> <target-name-mask>;

      +

      STOGROUP <name> <name>
      +DATABASE <name> <name>
      +TABLESPACE <database.name> <database.name>
      +TABLE <schema.name> <schema.name>
      +INDEX <schema.name> <schema.name>
      +VIEW <schema.name> <schema.name>
      +SYNONYM <schema.name> <schema.name>
      +ALIAS <schema.name> <schema.name>
      +TRIGGER <schema.name> <schema.name>
      +SEQUENCE <schema.name> <schema.name>
      +FUNCTION <schema.name[.version]> <schema.name[.version]>
      +PROCEDURE <schema.name[.version]> <schema.name[.version]>

      +

      Note:
      +- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
      +- <schema> must be between 1 and 128 characters.
      +- <version> must be between 1 and 64 characters.

      +

      A mask specification can include the following wildcard characters:

      +

      Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.

      +

      Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.

      +

      Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.

      +

      Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.

      +

      Example:

      +

      The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:

      +

      TABLE MY%.%TABLE YOUR%.%TABLE;
      +TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
      +TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
      +TABLE *.MYTABLE *.YOURTABLE;

      +

      For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note:
      +- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.
      +- The matchSetValues options-profile option has the same behavior as the match-set-file command option.

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --rule-set | --rs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.

      +

      Format:

      +

      <rule-set-creator.rule-set-name>

      +

      For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --source-db2 | --sd (string)

    +
      +
    • +

      Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to use a command.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
  • +

    --type | -t (string)

    +
      +
    • +

      Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.

      +

      Allowed values: drop, create

      +
    • +
    +
  • +
  • +

    --verify | -v (string)

    +
      +
    • +

      Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.

      +

      Default value: no

      +

      Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
+

zoweprofilesupdatedbm-db2-profile

+

The DBM-Db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update dbm-db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new dbm-db2 profile. You can load this profile by using the name on commands that support the "--dbm-db2-profile" option.
    • +
    +
  • +
+

DBM-Db2 Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies the DBM Data Service REST API server host name or TCP/IP address to use.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the DBM Data Service REST API server TCP/IP port number.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies the mainframe user name that you want to use to connect to the mainframe systems during execution of the Zowe CLI commands. This user name can be the same as your TSO login ID.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a DBM-Db2 profile named profile_name1 with a new work data set prefix:

    +
      +
    • zowe profiles update dbm-db2-profile profile_name1 --work-dataset-prefix NEWPREFX.DDL
    • +
    +
  • +
  • +

    Update a DBM-Db2 profile named dbm123 with a new username and password:

    +
      +
    • zowe profiles update dbm-db2-profile dbm123 --user newuser --password newp4ss
    • +
    +
  • +
  • +

    Update a DBM-Db2 profile named dbm124 with a new environment list. Existing subsystem SUBA will be updated with a new hostname "host4" and subsystem SUBC will be added to the list:

    +
      +
    • zowe profiles update dbm-db2-profile dbm124 --environment-list "SUBA:prod@host4.com:322,SUBC:stage@host3.net:722"
    • +
    +
  • +
  • +

    Update a DBM-Db2 profile named dbm125 with new job cards:

    +
      +
    • zowe profiles update dbm-db2-profile dbm125 --job-cards "//NEWJOBNM JOB (123456789)," "// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),"
    • +
    +
  • +
+

zoweprofilesupdateebg-profile

+

An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the Endevor Bridge for Git server of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update ebg-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ebg profile. You can load this profile by using the name on commands that support the "--ebg-profile" option.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

zoweprofilesupdateendevor-location-profile

+

The Endevor element location, where you specify your working environment, system and subsystem

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update endevor-location-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new endevor-location profile. You can load this profile by using the name on commands that support the "--endevor-location-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • The STC/datasource of the session
    • +
    +
  • +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where the element resides
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your element resides
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage where your project resides

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The Endevor comment you want to use when performing an action
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The Endevor CCID you want to use when performing an action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • The return code of Endevor that defines a failed action
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Always override element signout, without having to specify the override signout option on each command
    • +
    +
  • +
  • +

    --file-extension | --ext (string)

    +
      +
    • +

      The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:

      +
              none: File name is equal to element name, no extension is added\.
      +
      +        file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added\.
      +
      +        type\-name: The type name is used as the file extension\.
      +
      +        mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead\.
      +
      +

      Allowed values: none, type-name, file-ext, mixed

      +
    • +
    +
  • +
+

zoweprofilesupdateendevor-profile

+

The endevor profile schema, where you specify your endevor session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update endevor-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new endevor profile. You can load this profile by using the name on commands that support the "--endevor-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • The hostname of the endevor session
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number of the endevor session
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • The username of the endevor session
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The password of the user
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to Endevor Rest API

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --report-dir | --rd (string)

    +
      +
    • The default path where any reports will be written to, either absolute or relative to current directory
    • +
    +
  • +
+

zoweprofilesupdatefmp-profile

+

File Master Plus profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update fmp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new fmp profile. You can load this profile by using the name on commands that support the "--fmp-profile" option.
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies File Master Plus server port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

zoweprofilesupdateidms-profile

+

An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update idms-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new idms profile. You can load this profile by using the name on commands that support the "--idms-profile" option.
    • +
    +
  • +
+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update an IDMS profile called 'idms99' with a new default data source SYS100:

    +
      +
    • zowe profiles update idms-profile idms99 --datasource SYS100
    • +
    +
  • +
+

zoweprofilesupdateims-profile

+

An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update ims-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ims profile. You can load this profile by using the name on commands that support the "--ims-profile" option.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
+

zoweprofilesupdatejclcheck-profile

+

A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update jclcheck-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new jclcheck profile. You can load this profile by using the name on commands that support the "--jclcheck-profile" option.
    • +
    +
  • +
+

JCLCheck Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for JCLCheck connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --jclcheck-options | --jo (string)

    +
      +
    • The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
    • +
    +
  • +
+

zoweprofilesupdatejclx-profile

+

Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update jclx-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new jclx profile. You can load this profile by using the name on commands that support the "--jclx-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --remote-home-dir (string)

    +
      +
    • The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
    • +
    +
  • +
  • +

    --remote-temp-dir (string)

    +
      +
    • The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
    • +
    +
  • +
  • +

    --language (string)

    +
      +
    • +

      The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.

      +

      Allowed values: ENG, JPN

      +
    • +
    +
  • +
  • +

    --response-encoding (string)

    +
      +
    • The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.
    • +
    +
  • +
+

zoweprofilesupdatemat-profile

+

MAT Analyze CLI profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update mat-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new mat profile. You can load this profile by using the name on commands that support the "--mat-profile" option.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

zoweprofilesupdatemq-profile

+

An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update mq-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new mq profile. You can load this profile by using the name on commands that support the "--mq-profile" option.
    • +
    +
  • +
+

MQ Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The host name used to access the IBM MQ REST API. This might be the host name of the IBM MQ mqweb server, or the Zowe API Mediation Layer..
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number used to access the IBM MQ REST API. This might be the port number of the IBM MQ mqweb server, or the Zowe API Mediation Layer.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The mainframe (MQ) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The mainframe (MQ) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the MQ protocol (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

zoweprofilesupdateomspool-profile

+

Configuration profile for Spool, where you specify information about your Spool instance

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update omspool-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new omspool profile. You can load this profile by using the name on commands that support the "--omspool-profile" option.
    • +
    +
  • +
+

SPOOL OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --spoolhlq | --hlq (string)

    +
      +
    • High level qualifier of Spool installation.
    • +
    +
  • +
  • +

    --subsys | --sub (string)

    +
      +
    • Spool subsystem name.
    • +
    +
  • +
  • +

    --outds | --out (string)

    +
      +
    • The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.
    • +
    +
  • +
  • +

    --clist | --cl (string)

    +
      +
    • The data set containing ESFZOWE REXX exec.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update the TSO account information to '3213213210' for Spool profile named 'myProfile':

    +
      +
    • zowe profiles update omspool-profile myProfile --account 3213213210
    • +
    +
  • +
  • +

    Update high level qualifier of the Spool installation to 'SPOOL.HLQ' for Spool profile named 'myProfile':

    +
      +
    • zowe profiles update omspool-profile myProfile --spoolhlq SPOOL.HLQ
    • +
    +
  • +
  • +

    Update the Spool subsystem name to 'ESF2' for Spool profile named 'myProfile':

    +
      +
    • zowe profiles update omspool-profile myProfile --subsys ESF2
    • +
    +
  • +
  • +

    Update the output response data set to 'OUTPUT.RESPONSE.DS.NEW' for Spool profile named 'myProfile':

    +
      +
    • zowe profiles update omspool-profile myProfile --outds OUTPUT.RESPONSE.DS.NEW
    • +
    +
  • +
  • +

    Update the data set containing ESFZOWE REXX exec to 'USER.CLIST' for Spool profile named 'myProfile':

    +
      +
    • zowe profiles update omspool-profile myProfile --clist USER.CLIST
    • +
    +
  • +
+

zoweprofilesupdateops-profile

+

The OPS Web Services session profile schema, where you specify your session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update ops-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ops profile. You can load this profile by using the name on commands that support the "--ops-profile" option.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update an OPS profile called 'myLPAR' to connect to OPS Web Services at host lpar456:

    +
      +
    • zowe profiles update ops-profile myLPAR --host lpar456
    • +
    +
  • +
  • +

    Update an OPS profile called 'myLPAR' to have username user101 with password Km5sv78:

    +
      +
    • zowe profiles update ops-profile myLPAR --user user101 --password Km5sv78
    • +
    +
  • +
+

zoweprofilesupdatepma-profile

+

MAT Detect CLI profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update pma-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new pma profile. You can load this profile by using the name on commands that support the "--pma-profile" option.
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

zoweprofilesupdatessh-profile

+

z/OS SSH Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update ssh-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ssh profile. You can load this profile by using the name on commands that support the "--ssh-profile" option.
    • +
    +
  • +
+

z/OS Ssh Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OS SSH server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The z/OS SSH server port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --privateKey | --key | --pk (string)

    +
      +
    • Path to a file containing your private key, that must match a public key stored in the server for authentication
    • +
    +
  • +
  • +

    --keyPassphrase | --passphrase | --kp (string)

    +
      +
    • Private key passphrase, which unlocks the private key.
    • +
    +
  • +
  • +

    --handshakeTimeout | --timeout | --to (number)

    +
      +
    • How long in milliseconds to wait for the SSH handshake to complete.
    • +
    +
  • +
+

zoweprofilesupdatesysview-format-profile

+

The SYSVIEW format profile schema, where you specify display settings

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update sysview-format-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new sysview-format profile. You can load this profile by using the name on commands that support the "--sysview-format-profile" option.
    • +
    +
  • +
+

display options

+
    +
  • +

    --context-fields | --cf (array)

    +
      +
    • Context fields to display. Defaults to hiding all context
    • +
    +
  • +
  • +

    --overview | -o (boolean)

    +
      +
    • Display the overview section
    • +
    +
  • +
  • +

    --info | -i (boolean)

    +
      +
    • Display the information area, if any
    • +
    +
  • +
  • +

    --pretty | -p (boolean)

    +
      +
    • Display formatted data
    • +
    +
  • +
  • +

    --blank-if-zero | --biz | -b (boolean)

    +
      +
    • Show a blank space instead of '0' values
    • +
    +
  • +
  • +

    --truncate | --tr (boolean)

    +
      +
    • Truncate displays that are too wide for the console
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a SYSVIEW format profile called 'myFormat' to not display the information area.:

    +
      +
    • zowe profiles update sysview-format-profile myFormat --info false
    • +
    +
  • +
  • +

    Update a SYSVIEW format profile called 'myFormat' to format data but not blank out '0's.:

    +
      +
    • zowe profiles update sysview-format-profile myFormat -p --biz false
    • +
    +
  • +
+

zoweprofilesupdatesysview-profile

+

The SYSVIEW session profile schema, where you specify your session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update sysview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new sysview profile. You can load this profile by using the name on commands that support the "--sysview-profile" option.
    • +
    +
  • +
+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • SSID of the SYSVIEW instance. Default value: GSVX
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a SYSVIEW profile called 'myLPAR' to connect to SYSVIEW REST API at host lpar456:

    +
      +
    • zowe profiles update sysview-profile myLPAR --host lpar456
    • +
    +
  • +
  • +

    Update a SYSVIEW profile called 'myLPAR' to have username user101 with password Km5sv78:

    +
      +
    • zowe profiles update sysview-profile myLPAR --user user101 --password Km5sv78
    • +
    +
  • +
+

zoweprofilesupdatetso-profile

+

z/OS TSO/E User Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update tso-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new tso profile. You can load this profile by using the name on commands that support the "--tso-profile" option.
    • +
    +
  • +
+

TSO ADDRESS SPACE OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • Your z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --character-set | --cs (string)

    +
      +
    • Character set for address space to convert messages and responses from UTF-8 to EBCDIC.
    • +
    +
  • +
  • +

    --code-page | --cp (string)

    +
      +
    • Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC.
    • +
    +
  • +
  • +

    --columns | --cols (number)

    +
      +
    • The number of columns on a screen.
    • +
    +
  • +
  • +

    --logon-procedure | -l (string)

    +
      +
    • The logon procedure to use when creating TSO procedures on your behalf.
    • +
    +
  • +
  • +

    --region-size | --rs (number)

    +
      +
    • Region size for the TSO/E address space.
    • +
    +
  • +
  • +

    --rows (number)

    +
      +
    • The number of rows on a screen.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a tso profile called myprof with new JES accounting information:

    +
      +
    • zowe profiles update tso-profile myprof -a NEWACCT
    • +
    +
  • +
+

zoweprofilesupdatezftp-profile

+

Configuration profile for z/OS FTP

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update zftp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new zftp profile. You can load this profile by using the name on commands that support the "--zftp-profile" option.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port of the z/OS FTP server.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • How long (in milliseconds) to wait for the control connection to be established.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set.
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

zoweprofilesupdatezosmf-profile

+

z/OSMF Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update zosmf-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new zosmf profile. You can load this profile by using the name on commands that support the "--zosmf-profile" option.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The z/OSMF server port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set and USS files. The default encoding if not specified is IBM-1047.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a zosmf profile named 'zos123' with a new username and password:

    +
      +
    • zowe profiles update zosmf-profile zos123 --user newuser --password newp4ss
    • +
    +
  • +
+
+

zoweprovisioning

+

Perform z/OSMF provisioning tasks on Published Templates in the Service Catalog and Provisioned Instances in the Service Registry.

+

zoweprovisioningdelete

+

Deletes instance previously provisioned with z/OSMF cloud provisioning services.

+

zoweprovisioningdeleteinstance

+

Deletes selected deprovisioned instance.

+

Usage

+

zowe provisioning delete instance <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Deprovisioned Instance name.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete deprovisioned instance "instance1":

    +
      +
    • zowe provisioning delete instance instance1
    • +
    +
  • +
+

zoweprovisioninglist

+

Lists z/OSMF provisioning information such as the provisioned instances from the registry, the provisioned instance details, the available provisioning templates and provisioning template details.

+

zoweprovisioninglistcatalog-templates

+

Lists the z/OSMF service catalog published templates.

+

Usage

+

zowe provisioning list catalog-templates [options]

+

Options

+
    +
  • +

    --all-info | --ai (boolean)

    +
      +
    • Display information about published z/OSMF service catalog templates (summary information is printed by default).
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all published templates in the z/OSMF service catalog (with full detail):

    +
      +
    • zowe provisioning list catalog-templates --all-info
    • +
    +
  • +
+

zoweprovisioninglistinstance-info

+

List details about an instance provisioned with z/OSMF.

+

Usage

+

zowe provisioning list instance-info <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Provisioned Instance Name
    • +
    +
  • +
+

Options

+
    +
  • +

    --display (string)

    +
      +
    • +

      Level of information to display for the provisioned instance. Possible values:

      +

      summary - summary information, no actions or variables
      +actions - (default) summary with actions, no variables
      +vars - summary information with variables, no actions
      +extended - extended information with actions
      +full - all available information

      +

      Allowed values: extended, summary, vars, actions, full

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List summary information with a list of actions for an instance with the name "instance1":

    +
      +
    • zowe provisioning list instance-info instance1
    • +
    +
  • +
  • +

    Show extended general information with actions for a provisioned instance with the name "instance1":

    +
      +
    • zowe provisioning list instance-info instance1 --display extended
    • +
    +
  • +
+

zoweprovisioninglistinstance-variables

+

List a set of variables and their values for a given name.

+

Usage

+

zowe provisioning list instance-variables <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Provisioned Instance Name
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List instance variables of "instance1":

    +
      +
    • zowe provisioning list instance-variables instance1
    • +
    +
  • +
+

zoweprovisioninglistregistry-instances

+

List the provisioned instances from the z/OSMF software registry.

+

Usage

+

zowe provisioning list registry-instances [options]

+

Options

+
    +
  • +

    --all-info | --ai (boolean)

    +
      +
    • Display all available information about provisioned instances (summary by default).
    • +
    +
  • +
  • +

    --filter-by-type | --fbt (string)

    +
      +
    • Filter the list of provisioned instances by type (e.g. DB2 or CICS).
    • +
    +
  • +
  • +

    --filter-by-external-name | --fben (string)

    +
      +
    • Filter the list of provisioned instances by External Name.
    • +
    +
  • +
  • +

    --types | -t (boolean)

    +
      +
    • Display a list of all types for provisioned instances (e.g. DB2 or CICS).
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all provisioned instances (with full detail):

    +
      +
    • zowe provisioning list registry-instances --all-info
    • +
    +
  • +
+

zoweprovisioninglisttemplate-info

+

List details about a template published with z/OSMF Cloud Provisioning.

+

Usage

+

zowe provisioning list template-info <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • The name of a z/OSMF cloud provisioning template.
    • +
    +
  • +
+

Options

+
    +
  • +

    --all-info | --ai (boolean)

    +
      +
    • Display detailed information about published z/OSMF service catalog template (summary information is printed by default).
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List summary information for template "template1":

    +
      +
    • zowe provisioning list template-info template1
    • +
    +
  • +
+

zoweprovisioningperform

+

Perform actions against instances provisioned with z/OSMF.

+

zoweprovisioningperformaction

+

Perform actions on instances previously provisioned with z/OSMF cloud
+provisioning services. To view the list of provisioned instances, use the
+"zowe provisioning list registry-instances" command. Once you have
+obtained an instance name you can use the "zowe provisioning list
+instance-info <name>" command to view the available instance actions.

+

Usage

+

zowe provisioning perform action <name> <actionname> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Provisioned Instance name.
    • +
    +
  • +
  • +

    actionname (string)

    +
      +
    • The action name. Use the "zowe provisioning list instance-info <name>"
      +command to view available instance actions.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Perform the "start" action on the provisioned instance "instance1":

    +
      +
    • zowe provisioning perform action instance1 start
    • +
    +
  • +
+

zoweprovisioningprovision

+

Using z/OSMF cloud provisioning services provision available templates.

+

zoweprovisioningprovisiontemplate

+

Using z/OSMF cloud provisioning services, provision available templates.
+You can view available templates using the zowe provisioning list catalog-templates command.

+

Usage

+

zowe provisioning provision template <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • The name of a z/OSMF cloud provisioning template.
    • +
    +
  • +
+

Options

+
    +
  • +

    --properties | -p (string)

    +
      +
    • A sequence of string enclosed "name=value" pairs of prompt variables.
      +e.g: "CSQ_MQ_SSID=ZCT1,CSQ_CMD_PFX=!ZCT1".
    • +
    +
  • +
  • +

    --properties-file | --pf (string)

    +
      +
    • Path to .yml file containing properties.
    • +
    +
  • +
  • +

    --domain-name | --dn (string)

    +
      +
    • Required if the user has consumer authorization to more than one domain with this template name.
    • +
    +
  • +
  • +

    --tenant-name | --tn (string)

    +
      +
    • Required if the user has consumer authorization to more than one tenant in the same domain that contains this template name.
    • +
    +
  • +
  • +

    --user-data-id | --udi (string)

    +
      +
    • ID for the user data specified with user-data. Passed into the software services registry.
    • +
    +
  • +
  • +

    --user-data | --ud (string)

    +
      +
    • User data that is passed into the software services registry. Can be specified only if user-data-id is provided.
    • +
    +
  • +
  • +

    --account-info | --ai (string)

    +
      +
    • Account information to use in the JCL JOB statement. The default is the account information that is associated with the resource pool for the tenant.
    • +
    +
  • +
  • +

    --system-nick-names | --snn (string)

    +
      +
    • Each string is the nickname of the system upon which to provision the software service defined by the template. The field is required if the resource pool associated with the tenant used for this operation is not set up to automatically select a system. Only one nickname is allowed.If the field is provided it is validated.
      +e.g: "SYSNAME1,SYSNAME2".
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Provision a published software service template.:

    +
      +
    • zowe provisioning provision template template1
    • +
    +
  • +
+
+

zowesysview

+

Zowe CLI plugin for SYSVIEW

+

zowesysviewcapture

+

Display output from a primary command stored in a SYSVIEW capture data set

+

Usage

+

zowe sysview capture <capture-dsn> <capture-command> [options]

+

Positional Arguments

+
    +
  • +

    capture-dsn (string)

    +
      +
    • Capture data set name from which to retrieve captured commands
    • +
    +
  • +
  • +

    capture-command (string)

    +
      +
    • Captured command to retrieve
    • +
    +
  • +
+

data options

+
    +
  • +

    --capture-row | --cr (number)

    +
      +
    • Row number of command within capture data set
    • +
    +
  • +
  • +

    --capture-screen | --cs (string)

    +
      +
    • Screen name, for commands which have multiple screens
    • +
    +
  • +
  • +

    --capture-title | --ct (string)

    +
      +
    • The captured command screen title or a user supplied title specified on the CAPIMMED command
    • +
    +
  • +
  • +

    --fields | -f (array)

    +
      +
    • Fields to be returned (by name). For example: "jobname" "cpu"
    • +
    +
  • +
  • +

    --all-rows | --ar (boolean)

    +
      +
    • Return all rows of data, no matter how many. Overrides --row-start and --row-end
    • +
    +
  • +
  • +

    --row-start | --rs (number)

    +
      +
    • +

      The first row of the response data to display

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --row-end | --re (number)

    +
      +
    • +

      The last row of the response data to display

      +

      Default value: 100

      +
    • +
    +
  • +
  • +

    --timeout | --to (number)

    +
      +
    • +

      The number of seconds to wait before timing out

      +

      Default value: 30

      +
    • +
    +
  • +
+

display options

+
    +
  • +

    --context-fields | --cf (array)

    +
      +
    • Context fields to display. Defaults to hiding all context
    • +
    +
  • +
  • +

    --overview | -o (boolean)

    +
      +
    • Display the overview section
    • +
    +
  • +
  • +

    --info | -i (boolean)

    +
      +
    • Display the information area, if any
    • +
    +
  • +
  • +

    --pretty | -p (boolean)

    +
      +
    • Display formatted data
    • +
    +
  • +
  • +

    --blank-if-zero | --biz | -b (boolean)

    +
      +
    • Show a blank space instead of '0' values
    • +
    +
  • +
  • +

    --truncate | --tr (boolean)

    +
      +
    • +

      Truncate displays that are too wide for the console

      +

      Default value: false

      +
    • +
    +
  • +
+

response format options

+
    +
  • +

    --response-format-csv | --csv (boolean)

    +
      +
    • Format data as a set of Comma Seperated Values
    • +
    +
  • +
+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • +

      SSID of the SYSVIEW instance. Default value: GSVX

      +

      Default value: GSVX

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: /api/v1

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --sysview-profile | --sysview-p (string)

    +
      +
    • The name of a (sysview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --sysview-format-profile | --sysview-format-p (string)

    +
      +
    • The name of a (sysview-format) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Display the captured ACTIVITY command from MY.CAPTURE.DATASET.:

    +
      +
    • zowe sysview capture "MY.CAPTURE.DATASET" ACTIVITY
    • +
    +
  • +
  • +

    Display the Jobname, Jobid, and Status columns of the captured ACTIVITY command on row 3 from MY.CAPTURE.DATASET.:

    +
      +
    • zowe sysview capture "MY.CAPTURE.DATASET" ACTIVITY --capture-row 3 --fields Jobname Jobid Status
    • +
    +
  • +
+

zowesysviewcapture-immediate

+

Submit a capture request2

+

Usage

+

zowe sysview capture-immediate <capture-file> [options]

+

Positional Arguments

+
    +
  • +

    capture-file (string)

    +
      +
    • The list of SYSVIEW commands to be executed as an Event Capture.This takes the same form as a CAPLIB member.
    • +
    +
  • +
+

display options

+
    +
  • +

    --context-fields | --cf (array)

    +
      +
    • Context fields to display. Defaults to hiding all context
    • +
    +
  • +
+

data options

+
    +
  • +

    --capture-description | --cd (string)

    +
      +
    • The description of the capture
    • +
    +
  • +
+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • +

      SSID of the SYSVIEW instance. Default value: GSVX

      +

      Default value: GSVX

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: /api/v1

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --sysview-profile | --sysview-p (string)

    +
      +
    • The name of a (sysview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a Capture containing the commands in capture file 'my-capture.txt' with the description 'Top CPU Users':

    +
      +
    • zowe sysview capture-immediate "./my-capture.txt" --description "Top CPU Users"
    • +
    +
  • +
+

zowesysviewcheck

+

Confirm that the SYSVIEW REST server is running on a specified system.

+

zowesysviewcheckstatus

+

Confirm that the SYSVIEW REST server is running on a system specified. The command outputs properties of the z/OS system and the SYSVIEW REST server.

+

Usage

+

zowe sysview check status [options]

+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • +

      SSID of the SYSVIEW instance. Default value: GSVX

      +

      Default value: GSVX

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: /api/v1

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --sysview-profile | --sysview-p (string)

    +
      +
    • The name of a (sysview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Report the status of the SYSVIEW REST server that you specified in your default SYSVIEW REST profile:

    +
      +
    • zowe sysview check status
    • +
    +
  • +
  • +

    Report the status of the SYSVIEW REST server that you specified in a supplied SYSVIEW REST profile:

    +
      +
    • zowe sysview check status --sysview-profile SomeSysviewProfileName
    • +
    +
  • +
  • +

    Report the status of the SYSVIEW REST server that you specified manually via command line:

    +
      +
    • zowe sysview check status --host myhost --port 443 --user myuser --password mypass
    • +
    +
  • +
+

zowesysviewdisplay

+

Issue a SYSVIEW primary command and display output, including any messages

+

Usage

+

zowe sysview display <command-string> [options]

+

Positional Arguments

+
    +
  • +

    command-string (string)

    +
      +
    • Command(s) to be issued
      +(If more than one command, separated by a semi-colon)
      +Example: "ACTIVITY;SORT CPU% D"
    • +
    +
  • +
+

data options

+
    +
  • +

    --fields | -f (array)

    +
      +
    • Fields to be returned (by name). For example: "jobname" "cpu"
    • +
    +
  • +
  • +

    --all-rows | --ar (boolean)

    +
      +
    • Return all rows of data, no matter how many. Overrides --row-start and --row-end
    • +
    +
  • +
  • +

    --row-start | --rs (number)

    +
      +
    • +

      The first row of the response data to display

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --row-end | --re (number)

    +
      +
    • +

      The last row of the response data to display

      +

      Default value: 100

      +
    • +
    +
  • +
  • +

    --timeout | --to (number)

    +
      +
    • +

      The number of seconds to wait before timing out

      +

      Default value: 30

      +
    • +
    +
  • +
+

display options

+
    +
  • +

    --context-fields | --cf (array)

    +
      +
    • Context fields to display. Defaults to hiding all context
    • +
    +
  • +
  • +

    --overview | -o (boolean)

    +
      +
    • Display the overview section
    • +
    +
  • +
  • +

    --info | -i (boolean)

    +
      +
    • Display the information area, if any
    • +
    +
  • +
  • +

    --pretty | -p (boolean)

    +
      +
    • Display formatted data
    • +
    +
  • +
  • +

    --blank-if-zero | --biz | -b (boolean)

    +
      +
    • Show a blank space instead of '0' values
    • +
    +
  • +
  • +

    --truncate | --tr (boolean)

    +
      +
    • +

      Truncate displays that are too wide for the console

      +

      Default value: false

      +
    • +
    +
  • +
+

response format options

+
    +
  • +

    --response-format-csv | --csv (boolean)

    +
      +
    • Format data as a set of Comma Seperated Values
    • +
    +
  • +
+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • +

      SSID of the SYSVIEW instance. Default value: GSVX

      +

      Default value: GSVX

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: /api/v1

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --sysview-profile | --sysview-p (string)

    +
      +
    • The name of a (sysview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --sysview-format-profile | --sysview-format-p (string)

    +
      +
    • The name of a (sysview-format) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issue the CSMSTAT command and show the 'message' field from the context area of the response:

    +
      +
    • zowe sysview display "CSMSTAT" --cf message
    • +
    +
  • +
  • +

    Issue the JOBSUM command to list jobs starting with "CS" showing only the fields Jobname, Jobid, and Status:

    +
      +
    • zowe sysview display "jobs CS&VLMC" --fields Jobname Jobid Status
    • +
    +
  • +
+

zowesysviewexecute

+

Issue a SYSVIEW function command and display any messages

+

Usage

+

zowe sysview execute <command-string> [options]

+

Positional Arguments

+
    +
  • +

    command-string (string)

    +
      +
    • Command(s) to be issued
      +(If more than one command, separated by a semi-colon)
      +Example: "ACTIVITY;SORT CPU% D"
    • +
    +
  • +
+

display options

+
    +
  • +

    --context-fields | --cf (array)

    +
      +
    • Context fields to display. Defaults to hiding all context
    • +
    +
  • +
+

data options

+
    +
  • +

    --timeout | --to (number)

    +
      +
    • +

      The number of seconds to wait before timing out

      +

      Default value: 30

      +
    • +
    +
  • +
+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • +

      SSID of the SYSVIEW instance. Default value: GSVX

      +

      Default value: GSVX

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: /api/v1

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --sysview-profile | --sysview-p (string)

    +
      +
    • The name of a (sysview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issue the APFTEST command and display any messages returned from SYSVIEW.:

    +
      +
    • zowe sysview execute "APFTEST SYS1.LINKLIB SYS001"
    • +
    +
  • +
+
+

zowezjcl-expert

+

IBM Z JCL Expert Plug-in for Zowe CLI

+

zowezjcl-expertlocal

+

Wraps an SSH call to JCLX on the remote system to validate the specified local file containing JCL.

+

Usage

+

zowe zjcl-expert local <filePath> [options]

+

Positional Arguments

+
    +
  • +

    filePath (local file path)

    +
      +
    • The relative file path of the local file to be analysed on the remote system.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output | -o (string)

    +
      +
    • +

      The output format provided upon completion.

      +

      Default value: json
      +Allowed values: json, text

      +
    • +
    +
  • +
  • +

    --alias | -a (string)

    +
      +
    • An alias to give the file name during analysis.
    • +
    +
  • +
  • +

    --dsn-check | -c (string)

    +
      +
    • +

      Turn on or off DSN and USS file existence checking during analysis.

      +

      Default value: ON
      +Allowed values: ON, OFF

      +
    • +
    +
  • +
  • +

    --rules | -r (string)

    +
      +
    • The absolute path of the remote rules file used to define user site rules during analysis.
    • +
    +
  • +
  • +

    --local-rules | -e (local file path)

    +
      +
    • The relative path to a local rules file that will be uploaded as a temporary file and used to define user site rules during analysis.
    • +
    +
  • +
  • +

    --job-class | -j (string)

    +
      +
    • The default job class to use during JCL analysis if none is provided.
    • +
    +
  • +
  • +

    --log-level | -l (string)

    +
      +
    • +

      The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.

      +

      Default value: FATAL
      +Allowed values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

      +
    • +
    +
  • +
  • +

    --log-file | -d (string)

    +
      +
    • The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.
    • +
    +
  • +
  • +

    --remote-home-dir (string)

    +
      +
    • The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
    • +
    +
  • +
  • +

    --remote-temp-dir (string)

    +
      +
    • The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
    • +
    +
  • +
  • +

    --language (string)

    +
      +
    • +

      The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.

      +

      Default value: ENG
      +Allowed values: ENG, JPN

      +
    • +
    +
  • +
  • +

    --response-encoding (string)

    +
      +
    • +

      The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.

      +

      Default value: utf-8

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

z/OS Ssh Connection Options

+
    +
  • +

    --ssh-port | -S (number)

    +
      +
    • +

      The z/OS SSH server port.

      +

      Default value: 22

      +
    • +
    +
  • +
  • +

    --privateKey | --key | --pk (string)

    +
      +
    • Path to a file containing your private key, that must match a public key stored in the server for authentication
    • +
    +
  • +
  • +

    --keyPassphrase | --passphrase | --kp (string)

    +
      +
    • Private key passphrase, which unlocks the private key.
    • +
    +
  • +
  • +

    --handshakeTimeout | --timeout | --to (number)

    +
      +
    • How long in milliseconds to wait for the SSH handshake to complete.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --jclx-profile | --jclx-p (string)

    +
      +
    • The name of a (jclx) profile to load for this command execution.
    • +
    +
  • +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --ssh-profile | --ssh-p (string)

    +
      +
    • The name of a (ssh) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

zowezjcl-expertremote-ds

+

Wraps an SSH call to JCLX on the remote system to validate the specified remote data set.

+

Usage

+

zowe zjcl-expert remote-ds <dsn> [options]

+

Positional Arguments

+
    +
  • +

    dsn (string)

    +
      +
    • The name of the data set to be analysed on the remote system.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output | -o (string)

    +
      +
    • +

      The output format provided upon completion.

      +

      Default value: json
      +Allowed values: json, text

      +
    • +
    +
  • +
  • +

    --alias | -a (string)

    +
      +
    • An alias to give the file name during analysis.
    • +
    +
  • +
  • +

    --dsn-check | -c (string)

    +
      +
    • +

      Turn on or off DSN and USS file existence checking during analysis.

      +

      Default value: ON
      +Allowed values: ON, OFF

      +
    • +
    +
  • +
  • +

    --rules | -r (string)

    +
      +
    • The absolute path of the remote rules file used to define user site rules during analysis.
    • +
    +
  • +
  • +

    --job-class | -j (string)

    +
      +
    • The default job class to use during JCL analysis if none is provided.
    • +
    +
  • +
  • +

    --log-level | -l (string)

    +
      +
    • +

      The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.

      +

      Default value: FATAL
      +Allowed values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

      +
    • +
    +
  • +
  • +

    --log-file | -d (string)

    +
      +
    • The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.
    • +
    +
  • +
  • +

    --remote-home-dir (string)

    +
      +
    • The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
    • +
    +
  • +
  • +

    --remote-temp-dir (string)

    +
      +
    • The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
    • +
    +
  • +
  • +

    --language (string)

    +
      +
    • +

      The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.

      +

      Default value: ENG
      +Allowed values: ENG, JPN

      +
    • +
    +
  • +
  • +

    --response-encoding (string)

    +
      +
    • +

      The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.

      +

      Default value: utf-8

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

z/OS Ssh Connection Options

+
    +
  • +

    --ssh-port | -S (number)

    +
      +
    • +

      The z/OS SSH server port.

      +

      Default value: 22

      +
    • +
    +
  • +
  • +

    --privateKey | --key | --pk (string)

    +
      +
    • Path to a file containing your private key, that must match a public key stored in the server for authentication
    • +
    +
  • +
  • +

    --keyPassphrase | --passphrase | --kp (string)

    +
      +
    • Private key passphrase, which unlocks the private key.
    • +
    +
  • +
  • +

    --handshakeTimeout | --timeout | --to (number)

    +
      +
    • How long in milliseconds to wait for the SSH handshake to complete.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --jclx-profile | --jclx-p (string)

    +
      +
    • The name of a (jclx) profile to load for this command execution.
    • +
    +
  • +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --ssh-profile | --ssh-p (string)

    +
      +
    • The name of a (ssh) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

zowezjcl-expertremote-fs

+

Wraps an SSH call to JCLX on the remote system to validate the specified remote zFS file.

+

Usage

+

zowe zjcl-expert remote-fs <filePath> [options]

+

Positional Arguments

+
    +
  • +

    filePath (string)

    +
      +
    • The absolute file path of the USS file to be analysed on the remote system.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output | -o (string)

    +
      +
    • +

      The output format provided upon completion.

      +

      Default value: json
      +Allowed values: json, text

      +
    • +
    +
  • +
  • +

    --alias | -a (string)

    +
      +
    • An alias to give the file name during analysis.
    • +
    +
  • +
  • +

    --dsn-check | -c (string)

    +
      +
    • +

      Turn on or off DSN and USS file existence checking during analysis.

      +

      Default value: ON
      +Allowed values: ON, OFF

      +
    • +
    +
  • +
  • +

    --rules | -r (string)

    +
      +
    • The absolute path of the remote rules file used to define user site rules during analysis.
    • +
    +
  • +
  • +

    --job-class | -j (string)

    +
      +
    • The default job class to use during JCL analysis if none is provided.
    • +
    +
  • +
  • +

    --log-level | -l (string)

    +
      +
    • +

      The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.

      +

      Default value: FATAL
      +Allowed values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

      +
    • +
    +
  • +
  • +

    --log-file | -d (string)

    +
      +
    • The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.
    • +
    +
  • +
  • +

    --remote-home-dir (string)

    +
      +
    • The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
    • +
    +
  • +
  • +

    --remote-temp-dir (string)

    +
      +
    • The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
    • +
    +
  • +
  • +

    --language (string)

    +
      +
    • +

      The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.

      +

      Default value: ENG
      +Allowed values: ENG, JPN

      +
    • +
    +
  • +
  • +

    --response-encoding (string)

    +
      +
    • +

      The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.

      +

      Default value: utf-8

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

z/OS Ssh Connection Options

+
    +
  • +

    --ssh-port | -S (number)

    +
      +
    • +

      The z/OS SSH server port.

      +

      Default value: 22

      +
    • +
    +
  • +
  • +

    --privateKey | --key | --pk (string)

    +
      +
    • Path to a file containing your private key, that must match a public key stored in the server for authentication
    • +
    +
  • +
  • +

    --keyPassphrase | --passphrase | --kp (string)

    +
      +
    • Private key passphrase, which unlocks the private key.
    • +
    +
  • +
  • +

    --handshakeTimeout | --timeout | --to (number)

    +
      +
    • How long in milliseconds to wait for the SSH handshake to complete.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --jclx-profile | --jclx-p (string)

    +
      +
    • The name of a (jclx) profile to load for this command execution.
    • +
    +
  • +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --ssh-profile | --ssh-p (string)

    +
      +
    • The name of a (ssh) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+
+

zowezos-console

+

Interact with z/OSMF console services. Issue z/OS console commands and collect responses. z/OS console services establishes extended MCS (EMCS) consoles on behalf of the user, which are used to issue the commands and collect responses.

+

Important! Before you use commands in the zos-console command group, ensure that you understand the implications of issuing z/OS console commands in your environment.

+

zowezos-consolecollect

+

z/OSMF console services provides a command response key upon successful issue of a console command. You can use this key to collect additional console message responses.

+

zowezos-consolecollectsync-responses

+

The z/OSMF console REST APIs return a "solicited response key" after successfully issuing a synchronous console command that produces solicited responses. You can use the "solicited response key"on the "sync-responses" command to collect any additional outstanding solicited responses from the console the command was issued.

+

In general, when issuing a z/OS console command, z/OS applications route responses to the originating console. The command response messages are referred to as "solicited command responses" (i.e. direct responses to the command issued). When issuing a z/OS console command using Zowe CLI, collection of all solicited command responses is attempted by default. However, there is no z/OS mechanism that indicates the total number of response messages that may be produced from a given command. Therefore, the Zowe CLI console APIs return a "solicited response key" that can be used to "follow-up" and collect any additional solicited command responses.

+

Usage

+

zowe zos-console collect sync-responses <responsekey> [options]

+

Positional Arguments

+
    +
  • +

    responsekey (string)

    +
      +
    • The "solicited response key" provided in response to a previously issued console command. Used by the z/OSMF console API to collect any additional outstanding solicited responses from a previously issued console command. Must match regular expression: ^\[a\-zA\-Z0\-9\]\+$
    • +
    +
  • +
+

Options

+
    +
  • +

    --console-name | --cn | -c (string)

    +
      +
    • +

      The name of the z/OS extended MCS console to direct the command. You must have the required authority to access the console specified. You may also specify an arbitrary name, if your installation allows dynamic creation of consoles with arbitrary names.

      +

      Allowed values: ^[a-zA-Z0-9]+$

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Collect any outstanding additional solicited response messages:

    +
      +
    • zowe zos-console collect sync-responses C4866969
    • +
    +
  • +
+

zowezos-consoleissue

+

Issue z/OS console commands and optionally collect responses.

+

zowezos-consoleissuecommand

+

Issue a z/OS console command and print command responses (known as "solicited command responses").

+

In general, when issuing a z/OS console command, z/OS applications route responses to the originating console. The command response messages are referred to as "solicited command responses" (i.e. direct responses to the command issued). When issuing a z/OS console command using Zowe CLI, collection of all solicited command responses is attempted by default. However, there is no z/OS mechanism that indicates the total number of response messages that may be produced from a given command. Therefore, the Zowe CLI console APIs return a "solicited response key" that can be used to "follow-up" and collect any additional solicited command responses.

+

Zowe CLI will issue "follow-up" API requests by default to collect any additional outstanding solicited command responses until a request returns no additional responses. At that time, Zowe CLI will attempt a final collection attempt. If no messages are present, the command is complete. If additional messages are present, the process is repeated. However, this does not guarantee that all messages produced in direct response (i.e. solicited) have been collected. The z/OS application may produce additional messages in direct response to your command at some point in the future. You can manually collect additional responses using the "command response key" OR specify additional processing options to, for example, delay collection attempts by a specified interval.

+

Usage

+

zowe zos-console issue command <commandtext> [options]

+

Positional Arguments

+
    +
  • +

    commandtext (string)

    +
      +
    • The z/OS console command to issue.
    • +
    +
  • +
+

Options

+
    +
  • +

    --console-name | --cn | -c (string)

    +
      +
    • +

      The name of the z/OS extended MCS console to direct the command. You must have the required authority to access the console specified. You may also specify an arbitrary name, if your installation allows dynamic creation of consoles with arbitrary names.

      +

      Allowed values: ^[a-zA-Z0-9]+$

      +
    • +
    +
  • +
  • +

    --include-details | --id | -i (boolean)

    +
      +
    • Include additional details at the end of the Zowe CLI command response, such as the "command response key" and the z/OSMF command response URL.
    • +
    +
  • +
  • +

    --key-only | --ko | -k (boolean)

    +
      +
    • Displays only the "command response key" returned from the z/OSMF console API. You can collect additional messages using the command key with 'zowe zos-console collect sync-responses <key>'. Note that when using this option, you will not be presented with the "first set" of command response messages (if present in the API response). However, you can view them by using the --response-format-json option.
    • +
    +
  • +
  • +

    --return-first | --rf | -r (boolean)

    +
      +
    • Indicates that Zowe CLI should return immediately with the response message set returned in the first z/OSMF API request (even if no responses are present). Using this option may result in partial or no response, but quicker Zowe CLI command response time. The z/OSMF console API has an implicit wait when collecting the first set of console command responses, i.e you will normally receive at least one set of response messages.
    • +
    +
  • +
  • +

    --solicited-keyword | --sk | -s (string)

    +
      +
    • For solicited responses (direct command responses) the response is considered complete if the keyword specified is present. If the keyword is detected, the command will immediately return, meaning the full command response may not be provided. The key only applies to the first request issued, follow up requests do not support searching for the keyword.
    • +
    +
  • +
  • +

    --sysplex-system | --ss | --sys (string)

    +
      +
    • Specifies the z/OS system (LPAR) in the current SYSPLEX (where your target z/OSMF resides) to route the z/OS console command.
    • +
    +
  • +
  • +

    --wait-to-collect | --wtc | -w (number)

    +
      +
    • Indicates that Zowe CLI wait at least the specified number of seconds before attempting to collect additional solicited response messages. If additional messages are collected on "follow-up" requests, the timer is reset until an attempt is made that results in no additional response messages.
    • +
    +
  • +
  • +

    --follow-up-attempts | --fua | -a (number)

    +
      +
    • +

      Number of request attempts if no response returned.

      +

      Default value: 1

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issue a z/OS console command to display the IPL information for the system:

    +
      +
    • zowe zos-console issue command "D IPLINFO"
    • +
    +
  • +
  • +

    Issue a z/OS console command to display the local and coordinated universal time and date:

    +
      +
    • zowe zos-console issue command "D T"
    • +
    +
  • +
  • +

    Issue a Db2 command to display information about the status and configuration of DDF:

    +
      +
    • zowe zos-console issue command "\-DB1G DISPLAY DDF"
    • +
    +
  • +
+
+

zowezos-files

+

Manage z/OS data sets, create data sets, and more.

+

zowezos-filescompare

+

Compare the contents of a two data set members on your terminal (stdout).

+

zowezos-filescomparedata-set

+

Compare content of two z/OS data sets on your terminal (stdout).

+

Usage

+

zowe zos-files compare data-set <dataSetName1> <dataSetName2> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName1 (string)

    +
      +
    • The name of the first data set you want to compare.
    • +
    +
  • +
  • +

    dataSetName2 (string)

    +
      +
    • The name of the second data set you want to compare.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.
    • +
    +
  • +
  • +

    --binary2 | --b2 (boolean)

    +
      +
    • Transfer the content of the second data set in binary mode.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
    • +
    +
  • +
  • +

    --encoding2 | --ec2 (string)

    +
      +
    • Transfer the content of the second data set with encoding mode.
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Transfer the content for the first data set in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode. This option conflicts with binary mode.
    • +
    +
  • +
  • +

    --record2 | --r2 (boolean)

    +
      +
    • Transfer the content for the second data set in record mode. Conflicts with binary2.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the first data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --volume-serial2 | --vs2 (string)

    +
      +
    • The volume serial (VOLSER) where the second data set resides.
    • +
    +
  • +
  • +

    --seqnum | --sn (boolean)

    +
      +
    • +

      If you are comparing two files that contain sequence numbers, this option controls if the sequences numbers are removed from the end of each string. The default is to keep the sequence numbers. Use the --no-seqnum option to not include them.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --context-lines | --cl (number)

    +
      +
    • The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
    • +
    +
  • +
  • +

    --browser-view | --bv (boolean)

    +
      +
    • Opens the diffs between two given files in browser
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compare the contents of the data set members "sys1.samplib(antptso)" and "sys1.samplib(antxtso)":

    +
      +
    • zowe zos-files compare data-set "sys1.samplib(antptso)" "sys1.samplib(antxtso)"
    • +
    +
  • +
  • +

    Compare the contents of the data set members "sys1.samplib(antptso)" and "sys1.samplib(antxtso)" without sequence numbers:

    +
      +
    • zowe zos-files compare data-set "sys1.samplib(antptso)" "sys1.samplib(antxtso)" --no-seqnum
    • +
    +
  • +
+

zowezos-filescomparelocal-file-data-set

+

Compare content of a local file and a z/os dataset on your terminal (stdout).

+

Usage

+

zowe zos-files compare local-file-data-set <localFilePath> <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    localFilePath (string)

    +
      +
    • The path of the local file you want to compare.
    • +
    +
  • +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set you want to compare.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Transfer the content for the first data set in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode. This option conflicts with binary mode.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the first data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --seqnum | --sn (boolean)

    +
      +
    • +

      If you are comparing two files that contain sequence numbers, this option controls if the sequences numbers are removed from the end of each string. The default is to keep the sequence numbers. Use the --no-seqnum option to not include them.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --context-lines | --cl (number)

    +
      +
    • The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
    • +
    +
  • +
  • +

    --browser-view | --bv (boolean)

    +
      +
    • Opens the diffs between two given files in browser
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compare the contents of the local file and the data set member "./a.txt" and "sys1.samplib(antxtso)":

    +
      +
    • zowe zos-files compare local-file-data-set "./a.txt" "sys1.samplib(antxtso)"
    • +
    +
  • +
  • +

    Compare the contents of the local file and the data set member "./a.txt" and "sys1.samplib(antxtso)"without sequence numbers:

    +
      +
    • zowe zos-files compare local-file-data-set "./a.txt" "sys1.samplib(antxtso)" --no-seqnum
    • +
    +
  • +
+

zowezos-filescomparelocal-file-spool-dd

+

Compare content of a local-file and a spool-dd on your terminal (stdout).

+

Usage

+

zowe zos-files compare local-file-spool-dd <localFilePath> <spoolDescription> [options]

+

Positional Arguments

+
    +
  • +

    localFilePath (string)

    +
      +
    • The path of the local file you want to compare.
    • +
    +
  • +
  • +

    spoolDescription (string)

    +
      +
    • The name of the job with the id of spool dd
    • +
    +
  • +
+

Options

+
    +
  • +

    --seqnum | --sn (boolean)

    +
      +
    • +

      If you are comparing two files that contain sequence numbers, this option controls if the sequences numbers are removed from the end of each string. The default is to keep the sequence numbers. Use the --no-seqnum option to not include them.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --context-lines | --cl (number)

    +
      +
    • The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
    • +
    +
  • +
  • +

    --browser-view | --bv (boolean)

    +
      +
    • Opens the diffs between two given files in browser
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compare the contents of a local-file and a spool dd "./a.txt" "jobName:jobId:spoolId":

    +
      +
    • zowe zos-files compare local-file-spool-dd "./a.txt" "jobName:jobId:spoolId"
    • +
    +
  • +
  • +

    Compare the contents of a local-file and a spool dd "./a.txt" "jobName:jobId:spoolId"without sequence numbers:

    +
      +
    • zowe zos-files compare local-file-spool-dd "./a.txt" "jobName:jobId:spoolId" --no-seqnum
    • +
    +
  • +
+

zowezos-filescomparelocal-file-uss-file

+

Compare content of a local file and a z/os uss file on your terminal (stdout).

+

Usage

+

zowe zos-files compare local-file-uss-file <localFilePath> <ussFilePath> [options]

+

Positional Arguments

+
    +
  • +

    localFilePath (string)

    +
      +
    • The path of the local file you want to compare.
    • +
    +
  • +
  • +

    ussFilePath (string)

    +
      +
    • The path of the uss file set you want to compare.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
    • +
    +
  • +
  • +

    --seqnum | --sn (boolean)

    +
      +
    • +

      If you are comparing two files that contain sequence numbers, this option controls if the sequences numbers are removed from the end of each string. The default is to keep the sequence numbers. Use the --no-seqnum option to not include them.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --context-lines | --cl (number)

    +
      +
    • The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
    • +
    +
  • +
  • +

    --browser-view | --bv (boolean)

    +
      +
    • Opens the diffs between two given files in browser
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compare the contents of the local file and the uss file "./a.txt" and "/u/user/test.txt":

    +
      +
    • zowe zos-files compare local-file-uss-file "./a.txt" "/u/user/test.txt"
    • +
    +
  • +
  • +

    Compare the contents of the local file and the uss file "./a.txt" and "/u/user/test.txt"without sequence numbers:

    +
      +
    • zowe zos-files compare local-file-uss-file "./a.txt" "/u/user/test.txt" --no-seqnum
    • +
    +
  • +
+

zowezos-filescomparespool-dd

+

Compare content of two spool dds on your terminal (stdout).

+

Usage

+

zowe zos-files compare spool-dd <spoolDescription1> <spoolDescription2> [options]

+

Positional Arguments

+
    +
  • +

    spoolDescription1 (string)

    +
      +
    • The name of the first job with the id of spool dd
    • +
    +
  • +
  • +

    spoolDescription2 (string)

    +
      +
    • The name of the second job with the id of spool dd
    • +
    +
  • +
+

Options

+
    +
  • +

    --context-lines | --cl (number)

    +
      +
    • The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
    • +
    +
  • +
  • +

    --browser-view | --bv (boolean)

    +
      +
    • Opens the diffs between two given files in browser
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compare the contents of the two spool dds "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2":

    +
      +
    • zowe zos-files compare spool-dd "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2"
    • +
    +
  • +
  • +

    Compare the contents of the two spool dds "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2"without sequence numbers:

    +
      +
    • zowe zos-files compare spool-dd "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2" --no-seqnum
    • +
    +
  • +
+

zowezos-filescompareuss-files

+

Compare the contents of two uss files on your terminal (stdout). browser.

+

Usage

+

zowe zos-files compare uss-files <ussFilePath1> <ussFilePath2> [options]

+

Positional Arguments

+
    +
  • +

    ussFilePath1 (string)

    +
      +
    • The path of the first uss file you want to compare.
    • +
    +
  • +
  • +

    ussFilePath2 (string)

    +
      +
    • The path of the second uss file you want to compare.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.
    • +
    +
  • +
  • +

    --binary2 | --b2 (boolean)

    +
      +
    • Transfer the content of the second data set in binary mode.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
    • +
    +
  • +
  • +

    --encoding2 | --ec2 (string)

    +
      +
    • Transfer the content of the second data set with encoding mode.
    • +
    +
  • +
  • +

    --seqnum | --sn (boolean)

    +
      +
    • +

      If you are comparing two files that contain sequence numbers, this option controls if the sequences numbers are removed from the end of each string. The default is to keep the sequence numbers. Use the --no-seqnum option to not include them.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --context-lines | --cl (number)

    +
      +
    • The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
    • +
    +
  • +
  • +

    --browser-view | --bv (boolean)

    +
      +
    • Opens the diffs between two given files in browser
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compare the contents of the uss file "/u/user/test.txt" and "/u/user/test.txt":

    +
      +
    • zowe zos-files compare uss-files "/u/user/test.txt" "/u/user/test.txt"
    • +
    +
  • +
  • +

    Compare the contents of the uss file "/u/user/test.txt" and "/u/user/test.txt" without sequence numbers:

    +
      +
    • zowe zos-files compare uss-files "/u/user/test.txt" "/u/user/test.txt" --no-seqnum
    • +
    +
  • +
+

zowezos-filescopy

+

Copy a data set.

+

zowezos-filescopydata-set

+

Copy a data set to another data set

+

Usage

+

zowe zos-files copy data-set <fromDataSetName> <toDataSetName> [options]

+

Positional Arguments

+
    +
  • +

    fromDataSetName (string)

    +
      +
    • The name of the data set that you want to copy from
    • +
    +
  • +
  • +

    toDataSetName (string)

    +
      +
    • The name of the data set that you want to copy to (data set must be preallocated)
    • +
    +
  • +
+

Options

+
    +
  • +

    --replace | --rep (boolean)

    +
      +
    • Specify this option as true if you wish to replace like-named members in the target dataset
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET':

    +
      +
    • zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET"
    • +
    +
  • +
  • +

    Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set member named 'USER.TO.SET(MEM2)':

    +
      +
    • zowe zos-files copy data-set "USER.FROM.SET(mem1)" "USER.TO.SET(mem2)"
    • +
    +
  • +
  • +

    Copy the data set named 'USER.FROM.SET' to the data set member named 'USER.TO.SET(MEM2)':

    +
      +
    • zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET(mem2)"
    • +
    +
  • +
  • +

    Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set named 'USER.TO.SET':

    +
      +
    • zowe zos-files copy data-set "USER.FROM.SET(mem1)" "USER.TO.SET"
    • +
    +
  • +
  • +

    Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET' and replace like-named members:

    +
      +
    • zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET" --replace
    • +
    +
  • +
+

zowezos-filescopydata-set-cross-lpar

+

Copy a data set to another data set on a specified LPAR

+

Usage

+

zowe zos-files copy data-set-cross-lpar <fromDataSetName> <toDataSetName> [options]

+

Positional Arguments

+
    +
  • +

    fromDataSetName (string)

    +
      +
    • The name of the data set that you want to copy from
    • +
    +
  • +
  • +

    toDataSetName (string)

    +
      +
    • The name of the data set that you want to copy to. If the dataset does not exist it will be allocated automatically
    • +
    +
  • +
+

Options

+
    +
  • +

    --replace | --rep (boolean)

    +
      +
    • Specify this option as true if you wish to replace the target dataset if it already exists
    • +
    +
  • +
  • +

    --target-data-class | --tdc (string)

    +
      +
    • The SMS data class to use for the allocation of the target data set.
    • +
    +
  • +
  • +

    --target-host | --th (string)

    +
      +
    • The target z/OSMF server host name.
    • +
    +
  • +
  • +

    --target-management-class | --tmc (string)

    +
      +
    • The SMS management class to use for the allocation of the target data set.
    • +
    +
  • +
  • +

    --target-password | --tpw (string)

    +
      +
    • The target z/OSMF password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --target-port | --tp (number)

    +
      +
    • The target z/OSMF server port.
    • +
    +
  • +
  • +

    --target-storage-class | --tsc (string)

    +
      +
    • The SMS storage class to use for the allocation of the target data set.
    • +
    +
  • +
  • +

    --target-token-type | --ttt (string)

    +
      +
    • The value of the token to pass to the API for the target system.
    • +
    +
  • +
  • +

    --target-token-value | --ttv (string)

    +
      +
    • The type of token to get and use for the API for the target system.
    • +
    +
  • +
  • +

    --target-user | --tu (string)

    +
      +
    • The target z/OSMF user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --target-volume-serial | --tvs | --target-volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the target data set to be placed.
    • +
    +
  • +
  • +

    --target-zosmf-profile | --t-zosmf-p | --target-zosmf-p (string)

    +
      +
    • The name of a z/OSMF profile to load for the target host.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET' using the --target-zosmf-p option to specify the target host using a zosmf profile:

    +
      +
    • zowe zos-files copy data-set-cross-lpar "USER.FROM.SET" "USER.TO.SET" --target-zosmf-p SYS1
    • +
    +
  • +
  • +

    Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set member named 'USER.TO.SET(MEM2)':

    +
      +
    • zowe zos-files copy data-set-cross-lpar "USER.FROM.SET(mem1)" "USER.TO.SET(mem2)" --target-zosmf-p SYS1
    • +
    +
  • +
  • +

    Copy the data set named 'USER.FROM.SET' to the data set member named 'USER.TO.SET(MEM2)':

    +
      +
    • zowe zos-files copy data-set-cross-lpar "USER.FROM.SET" "USER.TO.SET(mem2)" --target-zosmf-p SYS1
    • +
    +
  • +
  • +

    Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set named 'USER.TO.SET' using the --target-host, --target-user, and --target-password options:

    +
      +
    • zowe zos-files copy data-set-cross-lpar "USER.FROM.SET(mem1)" "USER.TO.SET" --target-host sys1.com --target-user user1 --target-password pass1
    • +
    +
  • +
+

zowezos-filescreate

+

Create data sets.

+

zowezos-filescreatedata-set

+

Create data sets based on the properties of an existing data set

+

Usage

+

zowe zos-files create data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to create
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --block-size | --bs | --blksize (number)

    +
      +
    • The block size for the data set (for example, 6160)
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --data-set-type | --dst | --dsntype (string)

    +
      +
    • The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
    • +
    +
  • +
  • +

    --device-type | --dt | --unit (string)

    +
      +
    • The device type, also known as 'unit'
    • +
    +
  • +
  • +

    --directory-blocks | --db | --dirblks (number)

    +
      +
    • The number of directory blocks (for example, 25)
    • +
    +
  • +
  • +

    --like | --lk (string)

    +
      +
    • Name of an existing data set to base your new data set's properties on
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • The primary space allocation (for example, 5)
    • +
    +
  • +
  • +

    --record-format | --rf | --recfm (string)

    +
      +
    • The record format for the data set (for example, FB for "Fixed Block")
    • +
    +
  • +
  • +

    --record-length | --rl | --lrecl (number)

    +
      +
    • The logical record length. Analogous to the length of a line (for example, 80)
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The secondary space allocation (for example, 1)
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volume-serial | --vs | --volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a data set with default parameters and like flag:

    +
      +
    • zowe zos-files create data-set NEW.DATASET --like EXISTING.DATASET
    • +
    +
  • +
  • +

    Create a data set with default parameters and like flag and lrecl flag:

    +
      +
    • zowe zos-files create data-set NEW.DATASET --like EXISTING.DATASET --lrecl 1024
    • +
    +
  • +
  • +

    Create a data set with type LIBRARY:

    +
      +
    • zowe zos-files create data-set NEW.DATASET --data-set-type LIBRARY
    • +
    +
  • +
+

zowezos-filescreatedata-set-binary

+

Create executable data sets

+

Usage

+

zowe zos-files create data-set-binary <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to create
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --block-size | --bs | --blksize (number)

    +
      +
    • +

      The block size for the data set (for example, 6160)

      +

      Default value: 27998

      +
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --data-set-type | --dst | --dsntype (string)

    +
      +
    • The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
    • +
    +
  • +
  • +

    --device-type | --dt | --unit (string)

    +
      +
    • The device type, also known as 'unit'
    • +
    +
  • +
  • +

    --directory-blocks | --db | --dirblks (number)

    +
      +
    • +

      The number of directory blocks (for example, 25)

      +

      Default value: 25

      +
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • +

      The primary space allocation (for example, 5)

      +

      Default value: 10

      +
    • +
    +
  • +
  • +

    --record-format | --rf | --recfm (string)

    +
      +
    • +

      The record format for the data set (for example, FB for "Fixed Block")

      +

      Default value: U

      +
    • +
    +
  • +
  • +

    --record-length | --rl | --lrecl (number)

    +
      +
    • +

      The logical record length. Analogous to the length of a line (for example, 80)

      +

      Default value: 27998

      +
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The secondary space allocation (for example, 1)
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volume-serial | --vs | --volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an empty binary partitioned data set (PDS) with default parameters:

    +
      +
    • zowe zos-files create data-set-binary NEW.BINARY.DATASET
    • +
    +
  • +
  • +

    Create an empty binary PDSE using data set type LIBRARY:

    +
      +
    • zowe zos-files create data-set-binary NEW.BINARY.DATASET --data-set-type LIBRARY
    • +
    +
  • +
+

zowezos-filescreatedata-set-c

+

Create data sets for C code programming

+

Usage

+

zowe zos-files create data-set-c <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to create
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --block-size | --bs | --blksize (number)

    +
      +
    • +

      The block size for the data set (for example, 6160)

      +

      Default value: 32760

      +
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --data-set-type | --dst | --dsntype (string)

    +
      +
    • The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
    • +
    +
  • +
  • +

    --device-type | --dt | --unit (string)

    +
      +
    • The device type, also known as 'unit'
    • +
    +
  • +
  • +

    --directory-blocks | --db | --dirblks (number)

    +
      +
    • +

      The number of directory blocks (for example, 25)

      +

      Default value: 25

      +
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • +

      The primary space allocation (for example, 5)

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --record-format | --rf | --recfm (string)

    +
      +
    • +

      The record format for the data set (for example, FB for "Fixed Block")

      +

      Default value: VB

      +
    • +
    +
  • +
  • +

    --record-length | --rl | --lrecl (number)

    +
      +
    • +

      The logical record length. Analogous to the length of a line (for example, 80)

      +

      Default value: 260

      +
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The secondary space allocation (for example, 1)
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volume-serial | --vs | --volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an empty C code PDS with default parameters:

    +
      +
    • zowe zos-files create data-set-c NEW.CCODE.DATASET
    • +
    +
  • +
  • +

    Create an empty C code PDSE using data set type LIBRARY:

    +
      +
    • zowe zos-files create data-set-c NEW.CCODE.DATASET --data-set-type LIBRARY
    • +
    +
  • +
+

zowezos-filescreatedata-set-classic

+

Create classic data sets (JCL, HLASM, CBL, etc...)

+

Usage

+

zowe zos-files create data-set-classic <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to create
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --block-size | --bs | --blksize (number)

    +
      +
    • +

      The block size for the data set (for example, 6160)

      +

      Default value: 6160

      +
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --data-set-type | --dst | --dsntype (string)

    +
      +
    • The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
    • +
    +
  • +
  • +

    --device-type | --dt | --unit (string)

    +
      +
    • The device type, also known as 'unit'
    • +
    +
  • +
  • +

    --directory-blocks | --db | --dirblks (number)

    +
      +
    • +

      The number of directory blocks (for example, 25)

      +

      Default value: 25

      +
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • +

      The primary space allocation (for example, 5)

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --record-format | --rf | --recfm (string)

    +
      +
    • +

      The record format for the data set (for example, FB for "Fixed Block")

      +

      Default value: FB

      +
    • +
    +
  • +
  • +

    --record-length | --rl | --lrecl (number)

    +
      +
    • +

      The logical record length. Analogous to the length of a line (for example, 80)

      +

      Default value: 80

      +
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The secondary space allocation (for example, 1)
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volume-serial | --vs | --volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an empty z/OS 'classic' PDS with default parameters:

    +
      +
    • zowe zos-files create data-set-classic NEW.CLASSIC.DATASET
    • +
    +
  • +
  • +

    Create an empty z/OS 'classic' PDSE using data set type LIBRARY:

    +
      +
    • zowe zos-files create data-set-classic NEW.CLASSIC.DATASET --data-set-type LIBRARY
    • +
    +
  • +
+

zowezos-filescreatedata-set-partitioned

+

Create partitioned data sets (PDS)

+

Usage

+

zowe zos-files create data-set-partitioned <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to create
    • +
    +
  • +
+

Options

+
    +
  • +

    --allocation-space-unit | --asu (string)

    +
      +
    • +

      The allocation unit (for example, CYL for Cylinders)

      +

      Default value: CYL

      +
    • +
    +
  • +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --block-size | --bs | --blksize (number)

    +
      +
    • +

      The block size for the data set (for example, 6160)

      +

      Default value: 6160

      +
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --data-set-type | --dst | --dsntype (string)

    +
      +
    • The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
    • +
    +
  • +
  • +

    --device-type | --dt | --unit (string)

    +
      +
    • The device type, also known as 'unit'
    • +
    +
  • +
  • +

    --directory-blocks | --db | --dirblks (number)

    +
      +
    • +

      The number of directory blocks (for example, 25)

      +

      Default value: 5

      +
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • +

      The primary space allocation (for example, 5)

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --record-format | --rf | --recfm (string)

    +
      +
    • +

      The record format for the data set (for example, FB for "Fixed Block")

      +

      Default value: FB

      +
    • +
    +
  • +
  • +

    --record-length | --rl | --lrecl (number)

    +
      +
    • +

      The logical record length. Analogous to the length of a line (for example, 80)

      +

      Default value: 80

      +
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The secondary space allocation (for example, 1)
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volume-serial | --vs | --volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an empty PDS with default parameters:

    +
      +
    • zowe zos-files create data-set-partitioned NEW.PDS.DATASET
    • +
    +
  • +
  • +

    Create an empty PDSE using data set type LIBRARY:

    +
      +
    • zowe zos-files create data-set-partitioned NEW.PDSE.DATASET --data-set-type LIBRARY
    • +
    +
  • +
+

zowezos-filescreatedata-set-sequential

+

Create physical sequential data sets (PS)

+

Usage

+

zowe zos-files create data-set-sequential <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to create
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --block-size | --bs | --blksize (number)

    +
      +
    • +

      The block size for the data set (for example, 6160)

      +

      Default value: 6160

      +
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --device-type | --dt | --unit (string)

    +
      +
    • The device type, also known as 'unit'
    • +
    +
  • +
  • +

    --directory-blocks | --db | --dirblks (number)

    +
      +
    • The number of directory blocks (for example, 25)
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • +

      The primary space allocation (for example, 5)

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --record-format | --rf | --recfm (string)

    +
      +
    • +

      The record format for the data set (for example, FB for "Fixed Block")

      +

      Default value: FB

      +
    • +
    +
  • +
  • +

    --record-length | --rl | --lrecl (number)

    +
      +
    • +

      The logical record length. Analogous to the length of a line (for example, 80)

      +

      Default value: 80

      +
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The secondary space allocation (for example, 1)
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volume-serial | --vs | --volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an empty physical sequential data set with default parameters:

    +
      +
    • zowe zos-files create data-set-sequential NEW.PS.DATASET
    • +
    +
  • +
+

zowezos-filescreatedata-set-vsam

+

Create a VSAM cluster

+

Usage

+

zowe zos-files create data-set-vsam <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the dataset in which to create a VSAM cluster
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --data-set-organization | --dso | --dsorg (string)

    +
      +
    • +

      The data set organization.

      +

      Default value: INDEXED
      +Allowed values: INDEXED, IXD, LINEAR, LIN, NONINDEXED, NIXD, NUMBERED, NUMD, ZFS

      +
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --retain-for | --rf (number)

    +
      +
    • The number of days that the VSAM cluster will be retained on the system. You can delete the cluster at any time when neither retain-for nor retain-to is specified.
    • +
    +
  • +
  • +

    --retain-to | --rt (string)

    +
      +
    • The earliest date that a command without the PURGE parameter can delete an entry. Specify the expiration date in the form yyyyddd, where yyyy is a four-digit year (maximum value: 2155) and ddd is the three-digit day of the year from 001 through 365 (for non-leap years) or 366 (for leap years). You can delete the cluster at any time when neither retain-for nor retain-to is used. You cannot specify both the 'retain-to' and 'retain-for' options.
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The number of items for the secondary space allocation (for example, 840). The type of item allocated is the same as the type used for the '--size' option. If you do not specify a secondary allocation, a value of ~10% of the primary allocation is used.
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • +

      The primary size to allocate for the VSAM cluster. Specify size as the number of items to allocate (nItems). You specify the type of item by keyword.

      +

      Default value: 840KB

      +
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volumes | -v (string)

    +
      +
    • The storage volumes on which to allocate a VSAM cluster. Specify a single volume by its volume serial (VOLSER). To specify more than one volume, enclose the option in double-quotes and separate each VOLSER with a space. You must specify the volumes option when your cluster is not SMS-managed.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a VSAM data set named "SOME.DATA.SET.NAME" using default values of INDEXED, 840 KB primary storage and 84 KB secondary storage:

    +
      +
    • zowe zos-files create data-set-vsam SOME.DATA.SET.NAME
    • +
    +
  • +
  • +

    Create a 5 MB LINEAR VSAM data set named "SOME.DATA.SET.NAME" with 1 MB of secondary space. Show the properties of the data set when it is created:

    +
      +
    • zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --data-set-organization LINEAR --size 5MB --secondary-space 1 --attributes
    • +
    +
  • +
  • +

    Create a VSAM data set named "SOME.DATA.SET.NAME", which is retained for 100 days:

    +
      +
    • zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --retain-for 100
    • +
    +
  • +
+

zowezos-filescreateuss-directory

+

Create a UNIX directory.

+

Usage

+

zowe zos-files create uss-directory <ussPath> [options]

+

Positional Arguments

+
    +
  • +

    ussPath (string)

    +
      +
    • The name of the directory that you want to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --mode | -m (string)

    +
      +
    • Specifies the file permission bits to use when creating the directory.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a USS directory named "testDir" :

    +
      +
    • zowe zos-files create uss-directory testDir
    • +
    +
  • +
  • +

    Create a USS directory named "testDir" with mode "rwxrwxrwx" :

    +
      +
    • zowe zos-files create uss-directory testDir -m rwxrwxrwx
    • +
    +
  • +
+

zowezos-filescreateuss-file

+

Create a UNIX file.

+

Usage

+

zowe zos-files create uss-file <ussPath> [options]

+

Positional Arguments

+
    +
  • +

    ussPath (string)

    +
      +
    • The name of the file that you want to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --mode | -m (string)

    +
      +
    • Specifies the file permission bits to use when creating the file.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a USS file named "test.ext" :

    +
      +
    • zowe zos-files create uss-file text.txt
    • +
    +
  • +
  • +

    Create a USS file named "text.txt" with mode "rwxrwxrwx" :

    +
      +
    • zowe zos-files create uss-file text.txt -m rwxrwxrwx
    • +
    +
  • +
+

zowezos-filescreatezos-file-system

+

Create a z/OS file system.

+

Usage

+

zowe zos-files create zos-file-system <fileSystemName> [options]

+

Positional Arguments

+
    +
  • +

    fileSystemName (string)

    +
      +
    • The name of the file system to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --cyls-pri | --cp (number)

    +
      +
    • +

      The number of primary cylinders to allocate for the ZFS.

      +

      Default value: 10

      +
    • +
    +
  • +
  • +

    --cyls-sec | --cs (number)

    +
      +
    • +

      The number of secondary cylinders to allocate for the ZFS.

      +

      Default value: 2

      +
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --group | -g (string)

    +
      +
    • The z/OS group ID or GID for the group of the ZFS root directory.
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • The z/OS user ID or UID for the owner of the ZFS root directory.
    • +
    +
  • +
  • +

    --perms | -p (number)

    +
      +
    • +

      The permissions code for the ZFS root directory.

      +

      Default value: 755

      +
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --timeout | -t (number)

    +
      +
    • +

      The number of seconds to wait for the underlying "zfsadm format" command to complete. If this command times out, the ZFS may have been created but not formatted correctly.

      +

      Default value: 20

      +
    • +
    +
  • +
  • +

    --volumes | -v (array)

    +
      +
    • The storage volumes on which to allocate the z/OS file system. Specify a single volume by its volume serial (VOLSER). To specify more than one volume, separate each VOLSER with a space. You must specify the volumes option when your cluster is not SMS-managed.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a ZFS named "HLQ.MYNEW.ZFS" using default values of 755 permissions, 10 primary and 2 secondary cylinders allocated, and a timeout of 20 seconds:

    +
      +
    • zowe zos-files create zos-file-system HLQ.MYNEW.ZFS
    • +
    +
  • +
  • +

    Create a ZFS with 100 primary and 10 secondary cylinders allocated:

    +
      +
    • zowe zos-files create zos-file-system HLQ.MYNEW.ZFS --cp 100 --cs 10
    • +
    +
  • +
  • +

    Create a ZFS specifying the volumes that should be used:

    +
      +
    • zowe zos-files create zos-file-system HLQ.MYNEW.ZFS -v ZFS001 ZFS002
    • +
    +
  • +
+

zowezos-filesdelete

+

Delete a data set or Unix System Services file.

+

zowezos-filesdeletedata-set

+

Delete a data set or data set member permanently

+

Usage

+

zowe zos-files delete data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to delete
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --for-sure | -f (boolean)

    +
      +
    • Specify this option to confirm that you want to delete the data set permanently.
    • +
    +
  • +
+

Options

+
    +
  • +

    --volume | --vol (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. The option is required only when the data set is not catalogued on the system.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the data set named 'ibmuser.cntl':

    +
      +
    • zowe zos-files delete data-set "ibmuser.cntl" -f
    • +
    +
  • +
  • +

    Delete the data set member named 'ibmuser.cntl(mem)':

    +
      +
    • zowe zos-files delete data-set "ibmuser.cntl(mem)" -f
    • +
    +
  • +
+

zowezos-filesdeletedata-set-vsam

+

Delete a VSAM cluster permanently

+

Usage

+

zowe zos-files delete data-set-vsam <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the VSAM cluster that you want to delete
    • +
    +
  • +
+

Options

+
    +
  • +

    --erase | -e (boolean)

    +
      +
    • +

      Specify this option to overwrite the data component for the cluster with binary zeros. This option is ignored if the NOERASE attribute was specified when the cluster was defined or altered.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --purge | -p (boolean)

    +
      +
    • +

      Specify this option to delete the VSAM cluster regardless of its retention period or date.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --for-sure | -f (boolean)

    +
      +
    • Specify this option to confirm that you want to delete the VSAM cluster permanently.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the VSAM data set named 'ibmuser.cntl.vsam':

    +
      +
    • zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f
    • +
    +
  • +
  • +

    Delete all expired VSAM data sets that match 'ibmuser.AAA.**.FFF':

    +
      +
    • zowe zos-files delete data-set-vsam "ibmuser.AAA.**.FFF" -f
    • +
    +
  • +
  • +

    Delete a non-expired VSAM data set named 'ibmuser.cntl.vsam':

    +
      +
    • zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f --purge
    • +
    +
  • +
  • +

    Delete an expired VSAM data set named 'ibmuser.cntl.vsam' by overwriting the components with zeros:

    +
      +
    • zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f --erase
    • +
    +
  • +
+

zowezos-filesdeletemigrated-data-set

+

Delete migrated data sets.

+

Usage

+

zowe zos-files delete migrated-data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the migrated data set you want to delete.
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait | -w (boolean)

    +
      +
    • +

      If true then the function waits for completion of the request. If false (default) the request is queued.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --purge | -p (boolean)

    +
      +
    • +

      If true then the function uses the PURGE=YES on ARCHDEL request. If false (default) the function uses the PURGE=NO on ARCHDEL request.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a migrated data set using default options:

    +
      +
    • zowe zos-files delete migrated-data-set "USER.DATA.SET"
    • +
    +
  • +
+

zowezos-filesdeleteuss-file

+

Delete a Unix Systems Services (USS) File or directory permanently

+

Usage

+

zowe zos-files delete uss-file <fileName> [options]

+

Positional Arguments

+
    +
  • +

    fileName (string)

    +
      +
    • The name of the file or directory that you want to delete
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --for-sure | -f (boolean)

    +
      +
    • Specify this option to confirm that you want to delete the file or directory permanently.
    • +
    +
  • +
+

Options

+
    +
  • +

    --recursive | -r (boolean)

    +
      +
    • Delete directories recursively.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the empty directory '/u/ibmuser/testcases':

    +
      +
    • zowe zos-files delete uss-file "/a/ibmuser/testcases" -f
    • +
    +
  • +
  • +

    Delete the file named '/a/ibmuser/my_text.txt':

    +
      +
    • zowe zos-files delete uss-file "/a/ibmuser/testcases/my_text.txt" -f
    • +
    +
  • +
  • +

    Recursively delete the directory named '/u/ibmuser/testcases':

    +
      +
    • zowe zos-files delete uss-file "/a/ibmuser/testcases" -rf
    • +
    +
  • +
+

zowezos-filesdeletezos-file-system

+

Delete a z/OS file system permanently.

+

Usage

+

zowe zos-files delete zos-file-system <fileSystemName> [options]

+

Positional Arguments

+
    +
  • +

    fileSystemName (string)

    +
      +
    • The name of the z/OS file system that you want to delete.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --for-sure | -f (boolean)

    +
      +
    • Specify this option to confirm that you want to delete the ZFS permanently.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the z/OS file system 'HLQ.MYNEW.ZFS':

    +
      +
    • zowe zos-files delete zos-file-system "HLQ.MYNEW.ZFS" -f
    • +
    +
  • +
+

zowezos-filesdownload

+

Download content from z/OS data sets and USS files to your PC.

+

zowezos-filesdownloadall-members

+

Download all members from a partitioned data set to a local folder

+

Usage

+

zowe zos-files download all-members <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set from which you want to download members
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The directory to where you want to save the members. The command creates the directory for you when it does not already exist. By default, the command creates a folder structure based on the data set qualifiers. For example, the data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
    • +
    +
  • +
  • +

    --fail-fast | --ff (boolean)

    +
      +
    • +

      Set this option to false to continue downloading dataset members if one or more fail.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --max-concurrent-requests | --mcr (number)

    +
      +
    • +

      Specifies the maximum number of concurrent z/OSMF REST API requests to download members. Increasing the value results in faster downloads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the download process encounters an error, the following message displays:
      +The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to download all members at once without a maximum number of concurrent requests.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --preserve-original-letter-case | --po (boolean)

    +
      +
    • +

      Specifies if the automatically generated directories and files use the original letter case

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Download the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download the members of the data set "ibmuser.loadlib" in binary mode to the directory "loadlib/":

    +
      +
    • zowe zos-files download all-members "ibmuser.loadlib" -b -d loadlib
    • +
    +
  • +
  • +

    Download the members of the data set "ibmuser.cntl" in text mode to the directory "jcl/":

    +
      +
    • zowe zos-files download all-members "ibmuser.cntl" -d jcl
    • +
    +
  • +
+

zowezos-filesdownloaddata-set

+

Download content from a z/OS data set to a local file

+

Usage

+

zowe zos-files download data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to download
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
    • +
    +
  • +
  • +

    --file | -f (string)

    +
      +
    • The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
    • +
    +
  • +
  • +

    --preserve-original-letter-case | --po (boolean)

    +
      +
    • +

      Specifies if the automatically generated directories and files use the original letter case

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Download the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download the data set "ibmuser.loadlib(main)" in binary mode to the local file "main.obj":

    +
      +
    • zowe zos-files download data-set "ibmuser.loadlib(main)" -b -f main.obj
    • +
    +
  • +
+

zowezos-filesdownloaddata-sets-matching

+

Download all data sets that match a DSLEVEL pattern (see help below). You can use several options to qualify which data sets will be skipped and how the downloaded files will be structured. Data sets that are neither physical sequential nor partitioned data sets (with members) will be excluded.

+

Usage

+

zowe zos-files download data-sets-matching <pattern> [options]

+

Positional Arguments

+
    +
  • +

    pattern (string)

    +
      +
    • The pattern or patterns to match data sets against. Also known as 'DSLEVEL'. The following special sequences can be used in the pattern:
      +%: matches any single character
      +*: matches any number of characters within a data set name qualifier (e.g. "ibmuser.j*.old" matches "ibmuser.jcl.old" but not "ibmuser.jcl.very.old")
      +**: matches any number of characters within any number of data set name qualifiers (e.g. "ibmuser.**.old" matches both "ibmuser.jcl.old" and "ibmuser.jcl.very.old")
      +However, the pattern cannot begin with any of these sequences.You can specify multiple patterns separated by commas, for example "ibmuser.**.cntl,ibmuser.**.jcl"
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The directory to where you want to save the members. The command creates the directory for you when it does not already exist. By default, the command creates a folder structure based on the data set qualifiers. For example, the data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --exclude-patterns | --ep (string)

    +
      +
    • Exclude data sets that match these DSLEVEL patterns. Any data sets that match this pattern will not be downloaded.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
    • +
    +
  • +
  • +

    --extension-map | --em (string)

    +
      +
    • Use this option to map data set names that match your pattern to the desired extension. A comma delimited key value pairing (e.g. "cntl=.jcl,cpgm=.c" to map the last segment of each data set (also known as the "low level qualifier" to the desired local file extension).
    • +
    +
  • +
  • +

    --fail-fast | --ff (boolean)

    +
      +
    • +

      Set this option to false to continue downloading dataset members if one or more fail.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --max-concurrent-requests | --mcr (number)

    +
      +
    • +

      Specifies the maximum number of concurrent z/OSMF REST API requests to download members. Increasing the value results in faster downloads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the download process encounters an error, the following message displays:
      +The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to download all members at once without a maximum number of concurrent requests.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --preserve-original-letter-case | --po (boolean)

    +
      +
    • +

      Specifies if the automatically generated directories and files use the original letter case

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Download the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download all data sets beginning with "ibmuser" and ending with ".cntl" or ".jcl" to the local directory "jcl" to files with the extension ".jcl":

    +
      +
    • zowe zos-files download data-sets-matching "ibmuser.**.cntl, ibmuser.**.jcl" --directory jcl --extension .jcl
    • +
    +
  • +
  • +

    Download all data sets that begin with "ibmuser.public.project" or "ibmuser.project.private", excluding those that end in "lib" to the local directory "project", providing a custom mapping of data set low level qualifier to local file extension:

    +
      +
    • zowe zos-files download data-sets-matching "ibmuser.public.project.*, ibmuser.project.private.*" --exclude-patterns "ibmuser.public.**.*lib" --directory project --extension-map cpgm=c,asmpgm=asm,java=java,chdr=c,jcl=jcl,cntl=jcl
    • +
    +
  • +
+

zowezos-filesdownloaduss-directory

+

Download content from a USS directory to a local directory on your PC

+

Usage

+

zowe zos-files download uss-directory <ussDirName> [options]

+

Positional Arguments

+
    +
  • +

    ussDirName (string)

    +
      +
    • The name of the USS directory you want to download
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --attrs (local file path)

    +
      +
    • Path of an attributes file to control how files are downloaded
    • +
    +
  • +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --depth (number)

    +
      +
    • Filters content in USS based on the number of directories to traverse down.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The directory to where you want to save the files. The command creates the directory for you when it does not already exist. By default, the command downloads the files to the current directory.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --fail-fast | --ff (boolean)

    +
      +
    • +

      Set this option to false to continue downloading USS files if one or more fail.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --filesys (boolean)

    +
      +
    • Filters content in USS based on the filesystem the data is on. true - all filesystems, false - same filesystem as search directory.
    • +
    +
  • +
  • +

    --group (string)

    +
      +
    • Filters content in USS based on the owning group name or ID.
    • +
    +
  • +
  • +

    --include-hidden | --ih (boolean)

    +
      +
    • Include hidden files and folders that have names beginning with a dot
    • +
    +
  • +
  • +

    --max-concurrent-requests | --mcr (number)

    +
      +
    • +

      Specifies the maximum number of concurrent z/OSMF REST API requests to download files. Increasing the value results in faster downloads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the download process encounters an error, the following message displays:
      +The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to download all files at once without a maximum number of concurrent requests.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --max-length | --max (number)

    +
      +
    • The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
    • +
    +
  • +
  • +

    --mtime (string)

    +
      +
    • Filters content in USS based on the last modification time. N - specify an exact number of days, +N - older than N days, -N - newer than N days
    • +
    +
  • +
  • +

    --name (string)

    +
      +
    • Filters files in USS based on the name of the file or directory.
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite files that already exist in your local environment
    • +
    +
  • +
  • +

    --owner (string)

    +
      +
    • Filters content in USS based on the owning user name or ID.
    • +
    +
  • +
  • +

    --perm (string)

    +
      +
    • Filters content in USS based on the octal permissions string.
    • +
    +
  • +
  • +

    --size (string)

    +
      +
    • Filters content in USS based on the size. Default units are bytes. Add a suffix of K for kilobytes, M for megabytes, or G for gigabytes. N - specify an exact file size, +N - larger than N size, -N - smaller than N size
    • +
    +
  • +
  • +

    --symlinks (boolean)

    +
      +
    • Filters content in USS based on whether or not to follow symbolic links. true - report symlinks, false - follow symlinks
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • +

      Filters content in USS based on the type of content. f - regular file, d - directory, l - symbolic link, p - FIFO named pipe, s - socket

      +

      Allowed values: f, d, l, p, s

      +
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download the directory "/a/ibmuser" to "./" in binary mode:

    +
      +
    • zowe zos-files download uss-directory /a/ibmuser --binary
    • +
    +
  • +
  • +

    Download the directory "/a/ibmuser" to "./localDir":

    +
      +
    • zowe zos-files download uss-directory /a/ibmuser --directory localDir
    • +
    +
  • +
  • +

    Download files from the directory "/a/ibmuser" that match the name "*.log" and were modified within the last day:

    +
      +
    • zowe zos-files download uss-directory /a/ibmuser --name "*.log" --mtime -1
    • +
    +
  • +
+

zowezos-filesdownloaduss-file

+

Download content from a USS file to a local file on your PC

+

Usage

+

zowe zos-files download uss-file <ussFileName> [options]

+

Positional Arguments

+
    +
  • +

    ussFileName (string)

    +
      +
    • The name of the USS file you want to download
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --file | -f (string)

    +
      +
    • The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download the file "/a/ibmuser/my_text.txt" to ./my_text.txt:

    +
      +
    • zowe zos-files download uss-file "/a/ibmuser/my_text.txt" -f ./my_text.txt
    • +
    +
  • +
  • +

    Download the file "/a/ibmuser/MyJava.class" to "java/MyJava.class" in binary mode:

    +
      +
    • zowe zos-files download uss-file "/a/ibmuser/MyJava.class" -b -f "java/MyJava.class"
    • +
    +
  • +
+

zowezos-filesedit

+

Edit the contents of a data set or USS file with your terminal and default editor.

+

zowezos-fileseditdata-set

+

Edit content from a z/OS data set with your terminal and default editor.

+

Usage

+

zowe zos-files edit data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set you want to edit.
    • +
    +
  • +
+

Options

+
    +
  • +

    --editor | --ed (string)

    +
      +
    • Editor that overrides the default editor for this file type. Set the option to the editor's executable file location or the program's name: ie "--editor notepad"
    • +
    +
  • +
  • +

    --extension | --ext (string)

    +
      +
    • Set the file extension of the file for editing to leverage an editor's file-type-specific formatting: ie "--extension jcl"
    • +
    +
  • +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the file content in binary mode (no EBCDIC to ASCII conversion).
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Edit the contents of the data set member "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-files edit data-set ibmuser.cntl(iefbr14) --editor notepad
    • +
    +
  • +
  • +

    Edit the contents of the data set member "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-files edit data-set ibmuser.cntl(iefbr14) --editor C:\Windows\System32\Notepad.exe
    • +
    +
  • +
  • +

    Edit the contents of the data set member "ibmuser.jcl(iefbr14)" and set extension as "jcl":

    +
      +
    • zowe zos-files edit data-set ibmuser.jcl(iefbr14) --binary
    • +
    +
  • +
+

zowezos-filesedituss-file

+

Edit content from a Unix System Services (USS) file with your terminal and default editor.

+

Usage

+

zowe zos-files edit uss-file <ussFilePath> [options]

+

Positional Arguments

+
    +
  • +

    ussFilePath (string)

    +
      +
    • The path of the USS file you want to edit.
    • +
    +
  • +
+

Options

+
    +
  • +

    --editor | --ed (string)

    +
      +
    • Editor that overrides the default editor for this file type. Set the option to the editor's executable file location or the program's name: ie "--editor notepad"
    • +
    +
  • +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the file content in binary mode (no EBCDIC to ASCII conversion).
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Edit the contents of the USS file "/a/ibmuser/my_text.txt" in notepad:

    +
      +
    • zowe zos-files edit uss-file /a/ibmuser/my_text.txt --editor notepad
    • +
    +
  • +
  • +

    Edit the contents of the USS file "/a/ibmuser/my_text.txt" in notepad:

    +
      +
    • zowe zos-files edit uss-file /a/ibmuser/my_text.txt --editor C:\Windows\System32\Notepad.exe
    • +
    +
  • +
  • +

    Edit the contents of the USS file "/a/ibmuser/my_jcl.jcl" with binary flag set:

    +
      +
    • zowe zos-files edit uss-file /a/ibmuser/my_text.txt --binary
    • +
    +
  • +
+

zowezos-filesinvoke

+

Invoke z/OS utilities such as Access Method Services (AMS).

+

zowezos-filesinvokeams-file

+

Submit control statements for execution by Access Method Services (IDCAMS). You can use IDCAMS to create VSAM data sets (CSI, ZFS, etc...), delete data sets, and more. You must format the control statements exactly as the IDCAMS utility expects. For more information about control statements, see the IBM publication 'z/OS DFSMS Access Method Services Commands'.

+

Usage

+

zowe zos-files invoke ams-file <controlStatementsFile> [options]

+

Positional Arguments

+
    +
  • +

    controlStatementsFile (string)

    +
      +
    • The path to a file that contains IDCAMS control statements. Ensure that your file does not contain statements that are longer than 255 characters (maximum allowed length).
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Reads the specified file and submits the controls statements:

    +
      +
    • zowe zos-files invoke ams-file "./path/to/file/MyControlStatements.idcams"
    • +
    +
  • +
+

zowezos-filesinvokeams-statements

+

Submit control statements for execution by Access Method Services (IDCAMS). You can use IDCAMS to create VSAM data sets (CSI, ZFS, etc...), delete data sets, and more. You must format the control statements exactly as the IDCAMS utility expects. For more information about control statements, see the IBM publication 'z/OS DFSMS Access Method Services Commands'.

+

Usage

+

zowe zos-files invoke ams-statements <controlStatements> [options]

+

Positional Arguments

+
    +
  • +

    controlStatements (string)

    +
      +
    • The IDCAMS control statement that you want to submit. Zowe CLI attempts to split the inline control statement at 255 characters.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Defines a cluster named 'DUMMY.VSAM.CLUSTER':

    +
      +
    • zowe zos-files invoke ams-statements "DEFINE CLUSTER ( NAME (DUMMY.VSAM.CLUSTER) CYL(1 1))"
    • +
    +
  • +
  • +

    Deletes a cluster named 'DUMMY.VSAM.CLUSTER':

    +
      +
    • zowe zos-files invoke ams-statements "DELETE DUMMY.VSAM.CLUSTER CLUSTER"
    • +
    +
  • +
+

zowezos-fileslist

+

List data sets and data set members. Optionally, you can list their details and attributes.

+

zowezos-fileslistall-members

+

List all members of a partitioned data set. To view additional information about each member, use the --attributes option under the Options section of this help text.

+

Usage

+

zowe zos-files list all-members <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set for which you want to list the members
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Display more information about each member. Data sets with an undefined record format display information related to executable modules. Variable and fixed block data sets display information about when the members were created and modified.
    • +
    +
  • +
  • +

    --max-length | --max (number)

    +
      +
    • The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
    • +
    +
  • +
  • +

    --pattern (string)

    +
      +
    • The option --pattern specifies the match pattern used when listing members in a data set. The default is to match against all members, e.g. "*".
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show members of the data set "ibmuser.asm":

    +
      +
    • zowe zos-files list all-members "ibmuser.asm"
    • +
    +
  • +
  • +

    Show attributes of members of the data set "ibmuser.cntl":

    +
      +
    • zowe zos-files list all-members "ibmuser.cntl" -a
    • +
    +
  • +
  • +

    Show the first 5 members of the data set "ibmuser.cntl":

    +
      +
    • zowe zos-files list all-members "ibmuser.cntl" --max 5
    • +
    +
  • +
  • +

    Show the first 4 members of the data set "ibmuser.cntl" matching an input pattern":

    +
      +
    • zowe zos-files list all-members "sys1.maclib" --pattern IJK* --max 4
    • +
    +
  • +
+

zowezos-fileslistdata-set

+

List data sets that match a pattern in the data set name

+

Usage

+

zowe zos-files list data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name or pattern of the data set that you want to list
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Display more information about each member. Data sets with an undefined record format display information related to executable modules. Variable and fixed block data sets display information about when the members were created and modified.
    • +
    +
  • +
  • +

    --max-length | --max (number)

    +
      +
    • The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --start | -s (string)

    +
      +
    • An optional search parameter that specifies the first data set name to return in the response document.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show the data set "ibmuser.asm":

    +
      +
    • zowe zos-files list data-set "ibmuser.asm"
    • +
    +
  • +
  • +

    Show attributes of the data set "ibmuser.cntl":

    +
      +
    • zowe zos-files list data-set "ibmuser.cntl" -a
    • +
    +
  • +
  • +

    Show all data sets of the user "ibmuser":

    +
      +
    • zowe zos-files list data-set "ibmuser.*"
    • +
    +
  • +
  • +

    Show attributes of all data sets of the user "ibmuser":

    +
      +
    • zowe zos-files list data-set "ibmuser.*" -a
    • +
    +
  • +
  • +

    Show the first 5 data sets of the user "ibmuser":

    +
      +
    • zowe zos-files list data-set "ibmuser.cntl" --max 5
    • +
    +
  • +
+

zowezos-fileslistfile-system

+

List all mounted filesystems, or the specific filesystem mounted at a given path, or the filesystem with a given filesystem name.

+

Usage

+

zowe zos-files list file-system [options]

+

Options

+
    +
  • +

    --max-length | --max (number)

    +
      +
    • The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
    • +
    +
  • +
  • +

    --fsname | -f (string)

    +
      +
    • Specifies the name of the mounted file system. This option and --path are mutually exclusive.
    • +
    +
  • +
  • +

    --path | -p (string)

    +
      +
    • Specifies the path where the file system is mounted. This option and --fsname are mutually exclusive.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To list all mounted filesystems:

    +
      +
    • zowe zos-files list file-system
    • +
    +
  • +
  • +

    To list filesystems mounted to a specific path:

    +
      +
    • zowe zos-files list file-system -p /a/ibmuser
    • +
    +
  • +
  • +

    To list filesystems mounted with a specific name:

    +
      +
    • zowe zos-files list file-system -f MY.ZFS
    • +
    +
  • +
+

zowezos-fileslistuss-files

+

List USS files and directories in a UNIX file path

+

Usage

+

zowe zos-files list uss-files <path> [options]

+

Positional Arguments

+
    +
  • +

    path (string)

    +
      +
    • The directory containing the files and directories to be listed
    • +
    +
  • +
+

Options

+
    +
  • +

    --max-length | --max (number)

    +
      +
    • The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show the files and directories in path '/u/ibmuser':

    +
      +
    • zowe zos-files list uss-files "/u/ibmuser"
    • +
    +
  • +
  • +

    Show the files and directories in path '/u/ibmuser displaying only the file or directory name:

    +
      +
    • zowe zos-files list uss-files "/u/ibmuser" --rff name
    • +
    +
  • +
  • +

    Show the files and directories in path '/u/ibmuser' displaying the headers associated with the file detail:

    +
      +
    • zowe zos-files list uss-files "/u/ibmuser" --rfh
    • +
    +
  • +
+

zowezos-filesmigrate

+

Migrate data sets.

+

zowezos-filesmigratedata-set

+

Migrate a data set.

+

Usage

+

zowe zos-files migrate data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set you want to migrate.
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait | -w (boolean)

    +
      +
    • +

      If true then the function waits for completion of the request. If false (default) the request is queued.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Migrate a data set using default options:

    +
      +
    • zowe zos-files migrate data-set "USER.DATA.SET"
    • +
    +
  • +
+

zowezos-filesmount

+

Mount z/OS UNIX file systems, such as HFS, ZFS, and more. This connects you to USS file systems.

+

zowezos-filesmountfile-system

+

Mount a UNIX file system on a specified directory.

+

Usage

+

zowe zos-files mount file-system <fileSystemName> <mountPoint> [options]

+

Positional Arguments

+
    +
  • +

    fileSystemName (string)

    +
      +
    • The name of the file system to mount.
    • +
    +
  • +
  • +

    mountPoint (string)

    +
      +
    • The directory to use as a mount point.
    • +
    +
  • +
+

Options

+
    +
  • +

    --fs-type | --ft (string)

    +
      +
    • +

      Specify the file system type that you are going to mount. The name must match the TYPE operand on a FILESYSTYPE statement in the BPXPRMxx parmlib member for the file system.

      +

      Default value: ZFS

      +
    • +
    +
  • +
  • +

    --mode | -m (string)

    +
      +
    • +

      Specify the mode for mounting the file system (rdonly - read-only, rdwr - read/write).

      +

      Default value: rdonly
      +Allowed values: rdonly, rdwr

      +
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Mount a z/OS file system using default options:

    +
      +
    • zowe zos-files mount file-system MY.ZFS /a/ibmuser/mountdir
    • +
    +
  • +
  • +

    Mount a hierarchical file system with write access:

    +
      +
    • zowe zos-files mount file-system MY.HFS /a/ibmuser/mountdir --ft HFS -m rdwr
    • +
    +
  • +
+

zowezos-filesrecall

+

Recall migrated data sets.

+

zowezos-filesrecalldata-set

+

Recall a migrated data set.

+

Usage

+

zowe zos-files recall data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set you want to recall.
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait | -w (boolean)

    +
      +
    • +

      If true then the function waits for completion of the request. If false (default) the request is queued.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Recall a data set using default options:

    +
      +
    • zowe zos-files recall data-set "USER.DATA.SET"
    • +
    +
  • +
+

zowezos-filesrename

+

Rename a data set or member.

+

zowezos-filesrenamedata-set

+

Rename a data set.

+

Usage

+

zowe zos-files rename data-set <beforeDataSetName> <afterDataSetName> [options]

+

Positional Arguments

+
    +
  • +

    beforeDataSetName (string)

    +
      +
    • The name of the data set that you want to rename.
    • +
    +
  • +
  • +

    afterDataSetName (string)

    +
      +
    • The name you want to rename the data set to.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Rename the data set named 'USER.BEFORE.SET' to 'USER.AFTER.SET.':

    +
      +
    • zowe zos-files rename data-set "USER.BEFORE.SET" "USER.AFTER.SET"
    • +
    +
  • +
+

zowezos-filesrenamedata-set-member

+

Rename a data set member.

+

Usage

+

zowe zos-files rename data-set-member <dataSetName> <beforeMemberName> <afterMemberName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set the member belongs to.
    • +
    +
  • +
  • +

    beforeMemberName (string)

    +
      +
    • The name of the data set member that you want to rename.
    • +
    +
  • +
  • +

    afterMemberName (string)

    +
      +
    • The name you want to rename the data set member to.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    In the data set 'USER.DATA.SET', rename the member named 'MEM1' to 'MEM2'.:

    +
      +
    • zowe zos-files rename data-set-member "USER.DATA.SET" "MEM1" "MEM2
    • +
    +
  • +
+

zowezos-filesunmount

+

Unmount file systems, such as HFS, ZFS, and more. This disconnects you from USS file systems.

+

zowezos-filesunmountfile-system

+

Unmount a UNIX file system.

+

Usage

+

zowe zos-files unmount file-system <fileSystemName> [options]

+

Positional Arguments

+
    +
  • +

    fileSystemName (string)

    +
      +
    • The name of the file system to unmount.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Unmount a mounted file system:

    +
      +
    • zowe zos-files unmount file-system MY.FS
    • +
    +
  • +
+

zowezos-filesupload

+

Upload the contents of a file to data sets.

+

zowezos-filesuploaddir-to-pds

+

Upload files from a local directory to a partitioned data set (PDS)

+

Usage

+

zowe zos-files upload dir-to-pds <inputdir> <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    inputdir (string)

    +
      +
    • The path for a local directory that you want to upload to a PDS
    • +
    +
  • +
  • +

    dataSetName (string)

    +
      +
    • The name of the partitioned data set to which you want to upload the files
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Data content in encoding mode, which means that data conversion is performed according to the encoding specified.
    • +
    +
  • +
  • +

    --migrated-recall | --mr (string)

    +
      +
    • +

      The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error

      +

      Default value: nowait

      +
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Data content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload a directory named "src" to a PDS named "ibmuser.src":

    +
      +
    • zowe zos-files upload dir-to-pds "src" "ibmuser.src"
    • +
    +
  • +
  • +

    Upload a directory named "src" to a migrated PDS named "ibmuser.src" and wait for it to be recalled:

    +
      +
    • zowe zos-files upload dir-to-pds "src" "ibmuser.src" --mr wait
    • +
    +
  • +
+

zowezos-filesuploaddir-to-uss

+

Upload a local directory to a USS directory.

+

An optional .zosattributes file in the source directory can be used to control file conversion and tagging.

+

An example .zosattributes file:
+# pattern local-encoding remote-encoding
+# Don't upload the node_modules directory
+node_modules -
+# Don't upload files that start with periods
+.* -
+# Upload jpg images in binary
+*.jpg binary binary
+# Convert CICS Node.js profiles to EBCDIC
+*.profile ISO8859-1 EBCDIC

+

Lines starting with the ‘#’ character are comments. Each line can specify up to three positional attributes:

+
    +
  • A pattern to match a set of files. Pattern-matching syntax follows the same rules as those that apply in .gitignore files (note that negated patterns that begin with ‘!’ are not supported). See https://git-scm.com/docs/gitignore#_pattern_format.
  • +
  • A local-encoding to identify a file’s encoding on the local workstation. If '-' is specified for local-encoding,files that match the pattern are not transferred.
  • +
  • A remote-encoding to specify the file’s desired character set on USS. This attribute must either match the local encoding or be set to EBCDIC. If set to EBCDIC, files are transferred in text mode and converted, otherwise they are transferred in binary mode. Remote files are tagged either with the remote encoding or as binary.
  • +
+

A .zosattributes file can either be placed in the top-level directory you want to upload, or its location can be specified by using the --attributes parameter. .zosattributes files that are placed in nested directories are ignored.

+

Usage

+

zowe zos-files upload dir-to-uss <inputDir> <USSDir> [options]

+

Positional Arguments

+
    +
  • +

    inputDir (string)

    +
      +
    • The local directory path that you want to upload to a USS directory
    • +
    +
  • +
  • +

    USSDir (string)

    +
      +
    • The name of the USS directory to which you want to upload the local directory
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --recursive | -r (boolean)

    +
      +
    • Upload all directories recursively.
    • +
    +
  • +
  • +

    --binary-files | --bf (string)

    +
      +
    • Comma separated list of file names to be uploaded in binary mode. Use this option when you upload a directory in default ASCII mode, but you want to specify certain files to be uploaded in binary mode. All files matching specified file names will be uploaded in binary mode. If a .zosattributes file (or equivalent file specified via --attributes) is present, --binary-files will be ignored.
    • +
    +
  • +
  • +

    --ascii-files | --af (string)

    +
      +
    • Comma separated list of file names to be uploaded in ASCII mode. Use this option when you upload a directory with --binary/-b flag, but you want to specify certain files to be uploaded in ASCII mode. All files matching specified file names will be uploaded in ASCII mode. If a .zosattributes file (or equivalent file specified via --attributes) is present, --ascii-files will be ignored.
    • +
    +
  • +
  • +

    --attributes | --attrs (string)

    +
      +
    • Path of an attributes file to control how files are uploaded
    • +
    +
  • +
  • +

    --max-concurrent-requests | --mcr (number)

    +
      +
    • +

      Specifies the maximum number of concurrent z/OSMF REST API requests to upload files. Increasing the value results in faster uploads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the upload process encounters an error, the following message displays:
      +The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to upload all members at once without a maximum number of concurrent requests.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --include-hidden | --ih (boolean)

    +
      +
    • Include hidden files and folders that have names beginning with a dot
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory:

    +
      +
    • zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir"
    • +
    +
  • +
  • +

    Upload all files from the "local_dir" directory and all its sub-directories, to the "/a/ibmuser/my_dir" USS directory:

    +
      +
    • zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --recursive
    • +
    +
  • +
  • +

    Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory in default ASCII mode, while specifying a list of file names (without path) to be uploaded in binary mode:

    +
      +
    • zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --binary-files "myFile1.exe,myFile2.exe,myFile3.exe"
    • +
    +
  • +
  • +

    Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory in binary mode, while specifying a list of file names (without path) to be uploaded in ASCII mode:

    +
      +
    • zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --binary --ascii-files "myFile1.txt,myFile2.txt,myFile3.txt"
    • +
    +
  • +
  • +

    Recursively upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory, specifying files to ignore and file encodings in the local file my_global_attributes:

    +
      +
    • zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --recursive --attributes my_global_attributes
    • +
    +
  • +
+

zowezos-filesuploadfile-to-data-set

+

Upload the contents of a file to a z/OS data set

+

Usage

+

zowe zos-files upload file-to-data-set <inputfile> <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    inputfile (string)

    +
      +
    • The local file that you want to upload to a data set
    • +
    +
  • +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set to which you want to upload the file
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Data content in encoding mode, which means that data conversion is performed according to the encoding specified.
    • +
    +
  • +
  • +

    --migrated-recall | --mr (string)

    +
      +
    • +

      The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error

      +

      Default value: nowait

      +
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Data content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload file contents to a sequential data set named "ibmuser.ps":

    +
      +
    • zowe zos-files upload file-to-data-set "file.txt" "ibmuser.ps"
    • +
    +
  • +
  • +

    Upload file contents to a PDS member named "ibmuser.pds(mem)":

    +
      +
    • zowe zos-files upload file-to-data-set "file.txt" "ibmuser.pds(mem)"
    • +
    +
  • +
  • +

    Upload file contents to a migrated data set and wait for it to be recalled:

    +
      +
    • zowe zos-files upload file-to-data-set "file.txt" "ibmuser.ps" --mr wait
    • +
    +
  • +
+

zowezos-filesuploadfile-to-uss

+

Upload content to a USS file from local file

+

Usage

+

zowe zos-files upload file-to-uss <inputfile> <USSFileName> [options]

+

Positional Arguments

+
    +
  • +

    inputfile (string)

    +
      +
    • The local file that you want to upload to a USS file
    • +
    +
  • +
  • +

    USSFileName (string)

    +
      +
    • The name of the USS file to which you want to upload the file
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Data content in encoding mode, which means that data conversion is performed according to the encoding specified.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload to the USS file "/a/ibmuser/my_text.txt" from the file "file.txt":

    +
      +
    • zowe zos-files upload file-to-uss "file.txt" "/a/ibmuser/my_text.txt"
    • +
    +
  • +
+

zowezos-filesuploadstdin-to-data-set

+

Upload the content of a stdin to a z/OS data set

+

Usage

+

zowe zos-files upload stdin-to-data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set to which you want to upload data
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --migrated-recall | --mr (string)

    +
      +
    • +

      The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error

      +

      Default value: nowait

      +
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Data content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Stream content from stdin to a sequential data set named "ibmuser.ps" from a Windows console:

    +
      +
    • echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.ps"
    • +
    +
  • +
  • +

    Stream content from stdin to a partition data set member named "ibmuser.pds(mem)" from a Windows console:

    +
      +
    • echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.pds(mem)"
    • +
    +
  • +
  • +

    Stream content from stdin to a migrated data set and wait for it to be recalled from a Windows console:

    +
      +
    • echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.ps" --mr wait
    • +
    +
  • +
+

zowezos-filesview

+

View the contents of a data set or USS file on your terminal (stdout).

+

zowezos-filesviewdata-set

+

View content from a z/OS data set on your terminal (stdout).

+

Usage

+

zowe zos-files view data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set you want to display.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the file content in binary mode (no EBCDIC to ASCII conversion).
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Transfer the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --range | -R (string)

    +
      +
    • The range of records to return in either `SSS-EEE` or `SSS,NNN` format. SSS identifies the start record, EEE identifies the end record, and NNN identifies the number of retrieved records.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the contents of the data set member "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-files view data-set "ibmuser.cntl(iefbr14)"
    • +
    +
  • +
  • +

    View the contents of the data set member "ibmuser.test.loadlib(main)" in binary mode:

    +
      +
    • zowe zos-files view data-set "ibmuser.test.loadlib(main)" --binary
    • +
    +
  • +
  • +

    View only the first two lines of content for data set member "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-files view data-set "ibmuser.cntl(iefbr14)" --range 0,2
    • +
    +
  • +
  • +

    View only lines six through eight (zero-based) in the contents of the data set member "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-files view data-set "ibmuser.cntl(iefbr14)" --range 5-7
    • +
    +
  • +
+

zowezos-filesviewuss-file

+

View content from a Unix System Services (USS) file on your terminal (stdout).

+

Usage

+

zowe zos-files view uss-file <file> [options]

+

Positional Arguments

+
    +
  • +

    file (string)

    +
      +
    • The name of the USS file you want to display.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the file content in binary mode (no EBCDIC to ASCII conversion).
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --range | -R (string)

    +
      +
    • The range of records to return in either `SSS-EEE` or `SSS,NNN` format. SSS identifies the start record, EEE identifies the end record, and NNN identifies the number of retrieved records.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the contents of the USS file "/a/ibmuser/my_text.txt":

    +
      +
    • zowe zos-files view uss-file "/a/ibmuser/my_text.txt"
    • +
    +
  • +
  • +

    View the contents of the USS file "/a/ibmuser/MyJavaClass.class" in binary mode:

    +
      +
    • zowe zos-files view uss-file "/a/ibmuser/MyJavaClass.class" --binary
    • +
    +
  • +
+
+

zowezos-ftp

+

Data set and job functionality via FTP. This functionality uses the open source zos-node-accessor package from IBM. Commands under this group require you to create a zftp profile before using them.
+If you find this functionality useful, please consider setting up z/OSMF on your system to get improved stability and speed and more features (for example, issuing TSO and console commands) by using core Zowe CLI.

+

zowezos-ftpallocate

+

Allocate a sequential or partitioned dataset

+

zowezos-ftpallocatedata-set

+

Allocate a sequential dataset or partitioned dataset with '--dcb "PDSTYPE=PDS"'

+

Usage

+

zowe zos-ftp allocate data-set <datasetName> [options]

+

Positional Arguments

+
    +
  • +

    datasetName (string)

    +
      +
    • The dataset name you'd like to allocate.
    • +
    +
  • +
+

Options

+ +

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Allocate a sequential dataset "IBMUSER.DATASET":

    +
      +
    • zowe zos-ftp allocate data-set "IBMUSER.DATASET"
    • +
    +
  • +
  • +

    Allocate a partitioned dataset "IBMUSER.DATASET":

    +
      +
    • zowe zos-ftp allocate data-set "IBMUSER.DATASET" --dcb "PDSTYPE=PDS"
    • +
    +
  • +
+

zowezos-ftpdelete

+

Delete data sets, jobs, and USS files

+

zowezos-ftpdeletedata-set

+

Delete a data set

+

Usage

+

zowe zos-ftp delete data-set <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    dataSet (string)

    +
      +
    • The data set (PDS member or physical sequential data set) which you would like to delete.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --for-sure | -f (boolean)

    +
      +
    • Specify this option to confirm that you want to delete the data set permanently.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the data set "ibmuser.cntl":

    +
      +
    • zowe zos-ftp delete data-set "ibmuser.cntl" -f
    • +
    +
  • +
+

zowezos-ftpdeletejob

+

Cancel a job and purge its output. Note: this command will not work to delete TSU or STC type jobs.

+

Usage

+

zowe zos-ftp delete job <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The ID of the job that you would like to delete
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Cancel the job "JOB00123" and purge its output, optionally abbreviating the job ID:

    +
      +
    • zowe zos-ftp delete job j123
    • +
    +
  • +
+

zowezos-ftpdeleteuss-file

+

Delete a USS file

+

Usage

+

zowe zos-ftp delete uss-file <ussFile> [options]

+

Positional Arguments

+
    +
  • +

    ussFile (string)

    +
      +
    • The absolute path to a USS file you would like to delete.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --for-sure | -f (boolean)

    +
      +
    • Specify this option to confirm that you want to delete the data set permanently.
    • +
    +
  • +
+

Options

+
    +
  • +

    --recursive (boolean)

    +
      +
    • Delete the directory and all files/directories under it.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the USS file "/u/ibmuser/myfile.txt":

    +
      +
    • zowe zos-ftp delete uss-file "/u/ibmuser/myfile.txt" -f
    • +
    +
  • +
+

zowezos-ftpdownload

+

Download data set, job spool, and USS file content

+

zowezos-ftpdownloadall-spool-by-jobid

+

Download all spool content for a job to files in a local directory by providing the job id

+

Usage

+

zowe zos-ftp download all-spool-by-jobid <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The ID of the job for which you would like to list spool files
    • +
    +
  • +
+

Options

+
    +
  • +

    --directory | -d (string)

    +
      +
    • The local directory to save the spool content to. By default, it will be saved to "./output".
    • +
    +
  • +
  • +

    --omit-jobid-directory | --ojd (boolean)

    +
      +
    • If you specify this, the job output will be saved directly to the specified (or default) directory. For example, if you omit this, the output would be saved to ./output/JOB00123. If you specify --ojd, the JOB00123 directory would not be included in the output path and the content would be saved to ./output.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download all spool for the job with the ID JOB00123 to the default subdirectory in the current directory:

    +
      +
    • zowe zos-ftp download all-spool-by-jobid j123
    • +
    +
  • +
  • +

    Download all spool for the job with the ID JOB00123 to the directory build/job_output:

    +
      +
    • zowe zos-ftp download all-spool-by-jobid j123 -d build/job_output/
    • +
    +
  • +
+

zowezos-ftpdownloaddata-set

+

Download the contents of a z/OS data set to a local file

+

Usage

+

zowe zos-ftp download data-set <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    dataSet (string)

    +
      +
    • The data set (PDS member or physical sequential data set) which you would like to download to a local file.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --file | -f (string)

    +
      +
    • The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
    • +
    +
  • +
  • +

    --record | -r | --rdw (boolean)

    +
      +
    • Download the variable-length data set with RECFM of V, VB, VBS, etc in rdw mode, in which the 4-byte RDW (Record Descriptor Word) is inserted at the begining of each record.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download the data set "ibmuser.loadlib(main)" in binary mode to the local file "main.obj":

    +
      +
    • zowe zos-ftp download data-set "ibmuser.loadlib(main)" -b -f main.obj
    • +
    +
  • +
+

zowezos-ftpdownloaduss-file

+

Download the contents of a USS file to a local file

+

Usage

+

zowe zos-ftp download uss-file <ussFile> [options]

+

Positional Arguments

+
    +
  • +

    ussFile (string)

    +
      +
    • The path to the USS file you would like to download.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --file | -f (string)

    +
      +
    • The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download the USS file "/u/users/ibmuser/main.obj" in binary mode to the local file "main.obj":

    +
      +
    • zowe zos-ftp download uss-file "/u/users/ibmuser/main.obj" -b -f main.obj
    • +
    +
  • +
+

zowezos-ftplist

+

List data sets, data set members, uss files, jobs, spool files

+

zowezos-ftplistdata-set

+

List all data sets that match a DSLEVEL pattern (see help below).
+The following values can be used with the --response-format-filter (--rff) argument to display more data from the data sets:volume, unit, referred, ext, used, recfm, lrecl, blksz, dsorg, and dsname.

+

Usage

+

zowe zos-ftp list data-set <pattern> [options]

+

Positional Arguments

+
    +
  • +

    pattern (string)

    +
      +
    • The pattern or patterns to match data sets against. Also known as 'DSLEVEL', it is somewhat similar to the concept of a 'glob' (but not identical). The following special sequences can be used in the pattern:
      +%: Matches any single character
      +*: Matches any number of characters within a data set name qualifier (e.g. "ibmuser.j*.old" matches "ibmuser.jcl.old" but not "ibmuser.jcl.very.old")
      +**: Matches any number of characters within any number of data set name qualifiers (e.g. "ibmuser.**.old" matches both "ibmuser.jcl.old" and "ibmuser.jcl.very.old")
      +However, the pattern cannot begin with any of these sequences.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all data sets beginning with "ibmuser" and ending in "cntl":

    +
      +
    • zowe zos-ftp list data-set "ibmuser.**.cntl"
    • +
    +
  • +
+

zowezos-ftplistdata-set-members

+

List all members of the specified PDS or PDSE data set.

+

Usage

+

zowe zos-ftp list data-set-members <dsname> [options]

+

Positional Arguments

+
    +
  • +

    dsname (string)

    +
      +
    • The PDS or PDSE data set name.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all members in data set "ibmuser.test.cntl":

    +
      +
    • zowe zos-ftp list data-set-members "ibmuser.test.cntl"
    • +
    +
  • +
+

zowezos-ftplistjobs

+

List all data sets that match a DSLEVEL pattern (see help below).

+

Usage

+

zowe zos-ftp list jobs [options]

+

Options

+
    +
  • +

    --prefix (string)

    +
      +
    • Specify the job name prefix of the jobs you own and want to list. You can specify a wildcard, which is usually in the form "JOB*".
      +If you don't specify this option all jobs under this owner will be listed by default.
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • Specify the owner user ID of the jobs you want to list. The owner is the individual/user who submitted the job OR the user ID assigned to the job.
    • +
    +
  • +
  • +

    --status | -s (string)

    +
      +
    • Specify the status of the jobs you want to list. The status is one of the following: INPUT, ACTIVE and OUTPUT.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all jobs with names beginning beginning with "ibmu":

    +
      +
    • zowe zos-ftp list jobs --prefix "ibmu*"
    • +
    +
  • +
  • +

    List Alice's jobs with names beginning beginning with "ibmu":

    +
      +
    • zowe zos-ftp list jobs --prefix "ibmu*" --owner "alice"
    • +
    +
  • +
+

zowezos-ftplistspool-files-by-jobid

+

Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the JES/spool queues. The command does not pre-validate the JOBID.

+

Usage

+

zowe zos-ftp list spool-files-by-jobid <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job with the spool files you want to list. No pre-validation of the JOBID is performed.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the spool files of the job with JOBID JOB00123:

    +
      +
    • zowe zos-ftp list spool-files-by-jobid job00123
    • +
    +
  • +
+

zowezos-ftplistuss-files

+

List USS files and subdirectories in a directory. Optional file name pattern like "prefix*", "*suffix", or "prefix*suffix" can be specified at the end of directory. See EXAMPLES section.

+

The following values can be used with the --response-format-filter (--rff) argument to display more data from the data sets: name, size, owner, group, and permissions.

+

Usage

+

zowe zos-ftp list uss-files <directory> [options]

+

Positional Arguments

+
    +
  • +

    directory (string)

    +
      +
    • The USS directory to list files in, or the directory with file name pattern
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List USS files in the directory "/u/users/ibmuser/":

    +
      +
    • zowe zos-ftp list uss-files "/u/users/ibmuser"
    • +
    +
  • +
  • +

    List USS files with suffix of ".txt" in the directory "/u/users/ibmuser/":

    +
      +
    • zowe zos-ftp list uss-files "/u/users/ibmuser/*.txt"
    • +
    +
  • +
  • +

    List USS files in the directory "/u/users/ibmuser/" and show only the file name:

    +
      +
    • zowe zos-ftp list uss-files "/u/users/ibmuser/" --rff name
    • +
    +
  • +
+

zowezos-ftpmake

+

Make a USS directory

+

zowezos-ftpmakeuss-directory

+

Make a Unix System Services Directory

+

Usage

+

zowe zos-ftp make uss-directory <ussDirectory> [options]

+

Positional Arguments

+
    +
  • +

    ussDirectory (string)

    +
      +
    • The USS directory you'd like to make.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Make a USS directory "/u/users/ibmuser/mydir":

    +
      +
    • zowe zos-ftp make uss-directory "/u/users/ibmuser/mydir"
    • +
    +
  • +
+

zowezos-ftprename

+

Rename data sets and USS files or directories

+

zowezos-ftprenamedata-set

+

Rename a cataloged data set

+

Usage

+

zowe zos-ftp rename data-set <oldDataSet> <newDataSet> [options]

+

Positional Arguments

+
    +
  • +

    oldDataSet (string)

    +
      +
    • The current name of the data set you want to rename.
    • +
    +
  • +
  • +

    newDataSet (string)

    +
      +
    • The new name for the data set.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Rename the data set ibmuser.jcl to ibmuser.cntl:

    +
      +
    • zowe zos-ftp rename data-set ibmuser.jcl ibmuser.cntl
    • +
    +
  • +
  • +

    Rename the data set member "ibmuser.cntl(alloc)" to "ibmuser.cntl(alloc2)". Note: you can only rename members within the same partitioned data set. You cannot move a member to another data set with this command.:

    +
      +
    • zowe zos-ftp rename data-set "ibmuser.cntl(alloc)" "ibmuser.cntl(alloc2)"
    • +
    +
  • +
+

zowezos-ftprenameuss-file

+

Rename a USS file or directory

+

Usage

+

zowe zos-ftp rename uss-file <olduss> <newuss> [options]

+

Positional Arguments

+
    +
  • +

    olduss (string)

    +
      +
    • The current name of the USS file you want to rename.
    • +
    +
  • +
  • +

    newuss (string)

    +
      +
    • The new name for the USS file.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Rename the file /u/users/ibmuser/hello.txt to /u/users/ibmuser/hello2.txt:

    +
      +
    • zowe zos-ftp rename uss-file "/u/users/ibmuser/hello.txt" "/u/users/ibmuser/hello2.txt"
    • +
    +
  • +
+

zowezos-ftpsubmit

+

Submit jobs from local files and data sets

+

zowezos-ftpsubmitdata-set

+

Submit a job from a cataloged data set containing JCL. The JCL will be downloaded via FTP and then submitted.

+

Usage

+

zowe zos-ftp submit data-set <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    dataSet (string)

    +
      +
    • The data set containing JCL that you would like to submit
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait | -w (string)

    +
      +
    • Specify job query interval and max times of querying job status. The format of this option is comma-separated numeric values. For example, '5,12' means queries job status every 5 seconds for 12 times at most.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit a job residing in the data set "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)"
    • +
    +
  • +
  • +

    Submit a job from the data set "ibmuser.cntl(iefbr14)" and print only the job ID:

    +
      +
    • zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)" --rff jobid --rft string
    • +
    +
  • +
  • +

    Submit a job from the data set "ibmuser.cntl(iefbr14)" and wait for job complete.:

    +
      +
    • zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)" --wait 5,12
    • +
    +
  • +
+

zowezos-ftpsubmitlocal-file

+

Submit a job from a local file containing JCL

+

Usage

+

zowe zos-ftp submit local-file <file> [options]

+

Positional Arguments

+
    +
  • +

    file (local file path)

    +
      +
    • The file you would like to submit as jcl
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait | -w (string)

    +
      +
    • Specify job query interval and max times of querying job status. The format of this option is comma-separated numeric values. For example, '5,12' means queries job status every 5 seconds for 12 times at most.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit a job from the local file "my_build_jcl.txt":

    +
      +
    • zowe zos-ftp submit local-file "my_build_jcl.txt"
    • +
    +
  • +
  • +

    Submit a job from the local file "my_build_jcl.txt" and print only the job ID:

    +
      +
    • zowe zos-ftp submit local-file "my_build_jcl.txt" --rff jobid --rft string
    • +
    +
  • +
  • +

    Submit a job from the local file "my_build_jcl.txt" and wait for job complete.:

    +
      +
    • zowe zos-ftp submit local-file "my_build_jcl.txt" --wait 5,12
    • +
    +
  • +
+

zowezos-ftpsubmitstdin

+

Submit a job from JCL written to the standard input (stdin) of this process.

+

Usage

+

zowe zos-ftp submit stdin [options]

+

Options

+
    +
  • +

    --wait | -w (string)

    +
      +
    • Specify job query interval and max times of querying job status. The format of this option is comma-separated numeric values. For example, '5,12' means queries job status every 5 seconds for 12 times at most.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit a job from stdin, redirecting the contents of my_jcl.txt in.:

    +
      +
    • zowe zos-ftp submit stdin < my_jcl.txt
    • +
    +
  • +
  • +

    Submit a job from the local file "my_build_jcl.txt" and wait for job complete.:

    +
      +
    • zowe zos-ftp submit stdin "my_build_jcl.txt" --wait 5,12
    • +
    +
  • +
+

zowezos-ftpupload

+

Upload data set and USS content

+

zowezos-ftpuploadfile-to-data-set

+

Upload contents of a local file to a z/OS data set

+

Usage

+

zowe zos-ftp upload file-to-data-set <file> <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    file (local file path)

    +
      +
    • Upload the contents of this file to the data set
    • +
    +
  • +
  • +

    dataSet (string)

    +
      +
    • The data set (PDS member or physical sequential data set) to which you would like to upload content.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Upload content in binary mode.
    • +
    +
  • +
  • +

    --dcb (string)

    +
      +
    • DCB parameters for sequential dataset (PS dataset) allocation if not existing. It is space separated like RECFM=FB LRECL=326 BLKSIZE=23472
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload to "ibmuser.cntl(iefbr14)" from the file iefbr14.txt:

    +
      +
    • zowe zos-ftp upload file-to-data-set iefbr14.txt "ibmuser.cntl(iefbr14)"
    • +
    +
  • +
  • +

    Upload to "ibmuser.dataset" from the file dataset.txt with the DCB parameters:

    +
      +
    • zowe zos-ftp upload file-to-data-set dataset.txt "ibmuser.dataset" --dcb "RECFM=FB LRECL=326 BLKSIZE=23472"
    • +
    +
  • +
+

zowezos-ftpuploadfile-to-uss-file

+

Upload contents of a local to a Unix System Services file.

+

Usage

+

zowe zos-ftp upload file-to-uss-file <file> <ussFile> [options]

+

Positional Arguments

+
    +
  • +

    file (local file path)

    +
      +
    • Upload the contents of this local file to a data set.
    • +
    +
  • +
  • +

    ussFile (string)

    +
      +
    • The USS file to which you would like to upload content.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Upload content in binary mode.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload to "/u/users/ibmuser/iefbr14.txt" from the file iefbr14.txt:

    +
      +
    • zowe zos-ftp upload file-to-uss-file iefbr14.txt "/u/users/ibmuser/iefbr14.txt"
    • +
    +
  • +
+

zowezos-ftpuploadstdin-to-data-set

+

Upload contents piped to stdin to a z/OS data set

+

Usage

+

zowe zos-ftp upload stdin-to-data-set <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    dataSet (string)

    +
      +
    • The data set (PDS member or physical sequential data set) to which you would like to upload content.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Upload content in binary mode.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload to "ibmuser.cntl(iefbr14)" from standard input (you can pipe into this command):

    +
      +
    • zowe zos-ftp upload stdin-to-data-set "ibmuser.cntl(iefbr14)"
    • +
    +
  • +
+

zowezos-ftpuploadstdin-to-uss-file

+

Upload from stdin to a Unix System Services File

+

Usage

+

zowe zos-ftp upload stdin-to-uss-file <ussFile> [options]

+

Positional Arguments

+
    +
  • +

    ussFile (string)

    +
      +
    • The USS file to which you would like to upload content.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Upload content in binary mode.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload to "/u/users/ibmuser/iefbr14.txt" from standard input (you can pipe into this command):

    +
      +
    • zowe zos-ftp upload stdin-to-uss-file "/u/users/ibmuser/iefbr14.txt"
    • +
    +
  • +
+

zowezos-ftpview

+

View data sets, job output, and USS content

+

zowezos-ftpviewall-spool-by-jobid

+

View all spool content for a job by providing the job id

+

Usage

+

zowe zos-ftp view all-spool-by-jobid <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The ID of the job for which you would like to list spool files
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    View all spool content for the job with ID JOB00123 (optionally abbreviating the job ID):

    +
      +
    • zowe zos-ftp view all-spool-by-jobid j123
    • +
    +
  • +
+

zowezos-ftpviewdata-set

+

View the contents of a z/OS data set

+

Usage

+

zowe zos-ftp view data-set <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    dataSet (string)

    +
      +
    • The data set (PDS member or physical sequential data set) which you would like to view the contents of.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • View content in binary form without converting to ASCII text
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the content of the data set "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-ftp view data-set "ibmuser.cntl(iefbr14)"
    • +
    +
  • +
  • +

    View the content of the data set "ibmuser.loadlib(main)" and pipe it into the hex viewer program xxd:

    +
      +
    • zowe zos-ftp view data-set "ibmuser.loadlib(main)" -b | xxd
    • +
    +
  • +
+

zowezos-ftpviewjob-status-by-jobid

+

View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID.

+

Usage

+

zowe zos-ftp view job-status-by-jobid <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The ID of the jobfor which you would like to list spool files
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the status for the job with ID "JOB00123" (optionally abbreviating the ID):

    +
      +
    • zowe zos-ftp view job-status-by-jobid j123
    • +
    +
  • +
+

zowezos-ftpviewspool-file-by-id

+

View the contents of a spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID or spool ID.

+

Usage

+

zowe zos-ftp view spool-file-by-id <jobid> <spoolfileid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job containing the spool file you want to view. No pre-validation of the JOBID is performed.
    • +
    +
  • +
  • +

    spoolfileid (number)

    +
      +
    • The spool file ID number for the spool file to view. No pre-validation of the ID is performed.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the spool file with ID 4 for the job with job ID JOB00123:

    +
      +
    • zowe zos-ftp view spool-file-by-id JOB00123 4
    • +
    +
  • +
+

zowezos-ftpviewuss-file

+

View the contents of a Unix System Services File

+

Usage

+

zowe zos-ftp view uss-file <ussFile> [options]

+

Positional Arguments

+
    +
  • +

    ussFile (string)

    +
      +
    • The USS file you'd like to view the contents of.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • View content in binary form without converting to ASCII text
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the content of the USS file "/u/users/ibmuser/myfile.txt":

    +
      +
    • zowe zos-ftp view uss-file "/u/users/ibmuser/myfile.txt"
    • +
    +
  • +
  • +

    View the content of the USS file "/u/users/ibmuser/myjava.jar" in binary mode and pipe it into the hex viewer command xxd:

    +
      +
    • zowe zos-ftp view uss-file "/u/users/ibmuser/myjava.jar" -b | xxd
    • +
    +
  • +
+
+

zowezos-jobs

+

Manage z/OS jobs.

+

zowezos-jobscancel

+

Cancel a single job by job ID. This cancels the job if it is running or on input.

+

zowezos-jobscanceljob

+

Cancel a single job by job ID

+

Usage

+

zowe zos-jobs cancel job <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
    • +
    +
  • +
+

Options

+
    +
  • +

    --modify-version (string)

    +
      +
    • +

      Using this option to set X-IBM-Job-Modify-Version to "1.0" will make the delete job API aynchronous. Otherwise, it will be synchronous by default.

      +

      Default value: 2.0

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Cancel job with job ID JOB03456:

    +
      +
    • zowe zos-jobs cancel job JOB03456
    • +
    +
  • +
  • +

    Cancel job with job ID JOB03456 synchronously:

    +
      +
    • zowe zos-jobs cancel job JOB03456 --modify-version "2.0"
    • +
    +
  • +
+

zowezos-jobsdelete

+

Delete a single job by job ID or delete multiple jobs in OUTPUT status.

+

zowezos-jobsdeletejob

+

Delete a single job by job ID

+

Usage

+

zowe zos-jobs delete job <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
    • +
    +
  • +
+

Options

+
    +
  • +

    --modify-version (string)

    +
      +
    • +

      Using this option to set X-IBM-Job-Modify-Version to "1.0" will make the delete job API aynchronous. Otherwise, it will be synchronous by default.

      +

      Default value: 2.0

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete job with job ID JOB03456:

    +
      +
    • zowe zos-jobs delete job JOB03456
    • +
    +
  • +
  • +

    Delete job with job ID JOB03456 synchronously:

    +
      +
    • zowe zos-jobs delete job JOB03456 --modify-version "2.0"
    • +
    +
  • +
+

zowezos-jobsdeleteold-jobs

+

Delete (purge) jobs in OUTPUT status. Defaults to deleting all jobs owned by your user ID that are in output status.

+

Usage

+

zowe zos-jobs delete old-jobs [options]

+

Options

+
    +
  • +

    --prefix | -p (string)

    +
      +
    • Only delete jobs with job names that match this prefix. Defaults to deleting all jobs owned by your user ID that are in output status.
    • +
    +
  • +
  • +

    --max-concurrent-requests | --mcr (number)

    +
      +
    • +

      Specifies the maximum number of concurrent z/OSMF REST API requests to delete jobs. Increasing the value makes the command run faster. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. When you specify 0, Zowe CLI attempts to delete all jobs at once without a maximum number of concurrent requests.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --modify-version (string)

    +
      +
    • +

      Using this option to set X-IBM-Job-Modify-Version to "1.0" will make the delete job API aynchronous. Otherwise, it will be synchronous by default.

      +

      Default value: 2.0

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete all of your jobs in output status with a job name starting with "ibmuser":

    +
      +
    • zowe zos-jobs delete old-jobs -p "ibmuser*"
    • +
    +
  • +
+

zowezos-jobsdownload

+

Download the output of a job as separate files.

+

zowezos-jobsdownloadoutput

+

Download all job output to a local directory. Each spool DD will be downloaded to its own file in the directory.

+

Usage

+

zowe zos-jobs download output <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.
    • +
    +
  • +
+

Options

+
    +
  • +

    --directory | -d | --dir (string)

    +
      +
    • The local directory you would like to download the output for the job to.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • A file extension to save the job output with. Defaults to '.txt'.
    • +
    +
  • +
  • +

    --omit-jobid-directory | --ojd (boolean)

    +
      +
    • If specified, job output will be saved directly to the specified directory rather than creating a subdirectory named after the ID of the job.
    • +
    +
  • +
  • +

    --binary | -b (boolean)

    +
      +
    • If specified, job output will be downloaded in binary format instead of performing text conversion. Conflicts with record.
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • If specified, job output will be downloaded in record format instead of performing text conversion. Conflicts with binary.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download all the output of the job with job ID JOB00234 to an automatically generated directory.:

    +
      +
    • zowe zos-jobs download output JOB00234
    • +
    +
  • +
+

zowezos-jobslist

+

List z/OS jobs and list the spool files (DDs) for a z/OS job on the JES/spool queues.

+

zowezos-jobslistjobs

+

List jobs on JES spool/queues. By default, the command lists jobs owned (owner) by the user specified in your z/OSMF profile. The default for prefix is "*". The command does not prevalidate your user ID. The command surfaces errors verbatim from the z/OSMF Jobs REST endpoints.

+

Usage

+

zowe zos-jobs list jobs [options]

+

Options

+
    +
  • +

    --owner | -o (string)

    +
      +
    • Specify the owner of the jobs you want to list. The owner is the individual/user who submitted the job OR the user ID assigned to the job. The command does not prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs REST endpoint documentation, which is usually in the form "USER*".
    • +
    +
  • +
  • +

    --prefix | -p (string)

    +
      +
    • Specify the job name prefix of the jobs you want to list. The command does not prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs REST endpoint documentation, which is usually in the form "JOB*".
    • +
    +
  • +
  • +

    --exec-data | --ed (boolean)

    +
      +
    • Use this option to retrieve execution data for jobs via the z/OSMF REST API.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all jobs with default settings. The command returns jobs owned by your user ID with any job name:

    +
      +
    • zowe zos-jobs list jobs
    • +
    +
  • +
  • +

    List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo':

    +
      +
    • zowe zos-jobs list jobs -o "ibmu*" -p "myjo*"
    • +
    +
  • +
  • +

    List all jobs with default owner and prefix settings, displaying only the job ID of each job:

    +
      +
    • zowe zos-jobs list jobs --rff jobid --rft table
    • +
    +
  • +
  • +

    List all jobs and return job execution data along with the default information:

    +
      +
    • zowe zos-jobs list jobs --exec-data
    • +
    +
  • +
  • +

    List all jobs owned by user IDs starting with 'ibmu' and return job execution data along with the default information:

    +
      +
    • zowe zos-jobs list jobs -o "ibmu*" --exec-data
    • +
    +
  • +
  • +

    List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo' and return job execution data along with the default information:

    +
      +
    • zowe zos-jobs list jobs -o "ibmu*" -p "myjo*" --exec-data
    • +
    +
  • +
+

zowezos-jobslistspool-files-by-jobid

+

Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the JES/spool queues. The command does not pre-validate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.

+

Usage

+

zowe zos-jobs list spool-files-by-jobid <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job with the spool files you want to list. No pre-validation of the JOBID is performed.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the spool files of the job with JOBID JOB00123:

    +
      +
    • zowe zos-jobs list spool-files-by-jobid job00123
    • +
    +
  • +
+

zowezos-jobsmodify

+

Modify the job class or the hold status of a job.

+

zowezos-jobsmodifyjob

+

Modify the job class or the hold status of a job.

+

Usage

+

zowe zos-jobs modify job <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
    • +
    +
  • +
+

Options

+
    +
  • +

    --jobclass (string)

    +
      +
    • The job class (e.g. 'A', 'B', ...) assigned to the job.
    • +
    +
  • +
  • +

    --hold (boolean)

    +
      +
    • Setting this flag will prevent a job from executing until entering a second command with the '--release' flag
    • +
    +
  • +
  • +

    --release (boolean)

    +
      +
    • Flag that releases a held a job for execution
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Modify class of job with job ID JOB0000:

    +
      +
    • zowe zos-jobs modify job JOB0000 --jobclass A
    • +
    +
  • +
  • +

    Hold job with job ID JOB0000:

    +
      +
    • zowe zos-jobs modify job JOB0000 --hold
    • +
    +
  • +
  • +

    Release job with job ID JOB0000:

    +
      +
    • zowe zos-jobs modify job JOB0000 --release
    • +
    +
  • +
+

zowezos-jobssubmit

+

Submit a job (JCL).

+

zowezos-jobssubmitdata-set

+

Submit a job (JCL) contained in a data set. The data set may be of type physical sequential or a PDS member. The command does not pre-validate the data set name. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.

+

Usage

+

zowe zos-jobs submit data-set <dataset> [options]

+

Positional Arguments

+
    +
  • +

    dataset (string)

    +
      +
    • The z/OS data set containing the JCL to submit. You can specify a physical sequential data set (for example, "DATA.SET") or a partitioned data set qualified by a member (for example, "DATA.SET(MEMBER)").
    • +
    +
  • +
+

Options

+
    +
  • +

    --volume | --vol (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. The option is required only when the data set is not catalogued on the system.
    • +
    +
  • +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --view-all-spool-content | --vasc (boolean)

    +
      +
    • Print all spool output. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • A file extension to save the job output with. Default is '.txt'.
    • +
    +
  • +
  • +

    --jcl-symbols | --js (string)

    +
      +
    • A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit the JCL in the data set "ibmuser.cntl(deploy)":

    +
      +
    • zowe zos-jobs submit data-set "ibmuser.cntl(deploy)"
    • +
    +
  • +
  • +

    Submit the JCL in the data set "ibmuser.cntl(deploy)", wait for the job to complete and print all output from the job:

    +
      +
    • zowe zos-jobs submit data-set "ibmuser.cntl(deploy)" --vasc
    • +
    +
  • +
+

zowezos-jobssubmitlocal-file

+

Submit a job (JCL) contained in a local file. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.

+

Usage

+

zowe zos-jobs submit local-file <localFile> [options]

+

Positional Arguments

+
    +
  • +

    localFile (string)

    +
      +
    • The local file containing the JCL to submit.
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --view-all-spool-content | --vasc (boolean)

    +
      +
    • Print all spool output. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • A file extension to save the job output with. Default is '.txt'.
    • +
    +
  • +
  • +

    --jcl-symbols | --js (string)

    +
      +
    • A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit the JCL in the file "iefbr14.txt":

    +
      +
    • zowe zos-jobs submit local-file "iefbr14.txt"
    • +
    +
  • +
+

zowezos-jobssubmitstdin

+

Submit a job (JCL) passed to the command via the stdin stream. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.

+

Usage

+

zowe zos-jobs submit stdin [options]

+

Options

+
    +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --view-all-spool-content | --vasc (boolean)

    +
      +
    • Print all spool output. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • A file extension to save the job output with. Default is '.txt'.
    • +
    +
  • +
  • +

    --jcl-symbols | --js (string)

    +
      +
    • A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit the JCL in the file "iefbr14.txt" via standard in:

    +
      +
    • zowe zos-jobs submit stdin < iefbr14.txt
    • +
    +
  • +
  • +

    Submit the JCL in the file "iefbr14.txt" via standard in from the output of another command:

    +
      +
    • cat iefbr14.txt | zowe zos-jobs submit stdin
    • +
    +
  • +
+

zowezos-jobssubmituss-file

+

Submit a job (JCL) contained in a USS file. The command does not pre-validate the USS file path. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.

+

Usage

+

zowe zos-jobs submit uss-file <file> [options]

+

Positional Arguments

+
    +
  • +

    file (string)

    +
      +
    • Path to the USS file that contains the JCL to submit.
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --view-all-spool-content | --vasc (boolean)

    +
      +
    • Print all spool output. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • A file extension to save the job output with. Default is '.txt'.
    • +
    +
  • +
  • +

    --jcl-symbols | --js (string)

    +
      +
    • A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit the JCL in the USS file "/a/ibmuser/compile.jcl":

    +
      +
    • zowe zos-jobs submit uss-file "/a/ibmuser/compile.jcl"
    • +
    +
  • +
  • +

    Submit the JCL in the USS file "/a/ibmuser/compile.jcl", wait for the job to complete and print all output from the job:

    +
      +
    • zowe zos-jobs submit uss-file "/a/ibmuser/compile.jcl" --vasc
    • +
    +
  • +
+

zowezos-jobsview

+

View details of z/OS jobs on spool/JES queues.

+

zowezos-jobsviewall-spool-content

+

View the contents of each spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.

+

Usage

+

zowe zos-jobs view all-spool-content <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    View all spool files for the job with job ID JOB00234:

    +
      +
    • zowe zos-jobs view all-spool-content JOB00234
    • +
    +
  • +
+

zowezos-jobsviewjob-status-by-jobid

+

View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints (expect for "no jobs found").

+

Usage

+

zowe zos-jobs view job-status-by-jobid <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job you want to view. No prevalidation of the JOBID is performed.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    View status and other details of the job with the job ID JOB00123:

    +
      +
    • zowe zos-jobs view job-status-by-jobid j123
    • +
    +
  • +
  • +

    Print only the status (for example, "OUTPUT" or "ACTIVE") of the job with the job ID JOB00123:

    +
      +
    • zowe zos-jobs view job-status-by-jobid j123 --rff status --rft string
    • +
    +
  • +
+

zowezos-jobsviewspool-file-by-id

+

View the contents of a spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID or spool ID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.

+

Usage

+

zowe zos-jobs view spool-file-by-id <jobid> <spoolfileid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job containing the spool file you want to view. No pre-validation of the JOBID is performed.
    • +
    +
  • +
  • +

    spoolfileid (number)

    +
      +
    • The spool file ID number for the spool file to view. Use the "zowe zos-jobs list spool-files-by-jobid" command to obtain spool ID numbers.No pre-validation of the ID is performed.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the spool file with ID 4 for the job with job ID JOB00123:

    +
      +
    • zowe zos-jobs view spool-file-by-id JOB00123 4
    • +
    +
  • +
+
+

zowezos-logs

+

Interact with z/OS logs.

+

zowezos-logslist

+

List z/OS logs by invoking z/OSMF REST API.

+

zowezos-logslistlogs

+

List z/OS operlog within a time range.

+

Use this operation to get the z/OS operations logs. It invokes z/OSMF REST API to retrieve logs.

+

Executing 'zowe zos-logs list logs' will by default return logs from current time and backwards to 10 minutes before.

+

Note: OPERLOG needs to be configured on z/OS server.

+

Usage

+

zowe zos-logs list logs [options]

+

Options

+
    +
  • +

    --start-time | --st (string)

    +
      +
    • Specify the time in ISO-8601 time format from when z/OSMF will start to retrieve the logs. For example, '2021-01-26T03:33:18.065Z', '2021-01-26T11:33:18.065+08:00'. Default is the current time.
    • +
    +
  • +
  • +

    --direction | -d (string)

    +
      +
    • +

      Specify the direction when retrieving the message log. Either 'forward' or 'backward' is valid, case insensitive.

      +

      Default value: backward
      +Allowed values: forward, backward

      +
    • +
    +
  • +
  • +

    --range | -r (string)

    +
      +
    • +

      Specify a time range in which the logs will be retrieved. The format is like nnnu, nnn is 1-999, u is one of 's', 'm', 'h', for example, '999s', '20m', '3h'.

      +

      Default value: 10m

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List logs starting from '2021-07-26T03:38:37.098Z' and forwards to 5 minutes later:

    +
      +
    • zowe zos-logs list logs --start-time 2021-07-26T03:38:37.098Z --range 5m --direction forward
    • +
    +
  • +
  • +

    List logs starting from '2021-07-26T03:38:37.098Z' and forwards to 5 minutes later. Alias version of the above command:

    +
      +
    • zowe zos-logs list logs --st 2021-07-26T03:38:37.098Z -r 5m -d forward
    • +
    +
  • +
  • +

    List logs starting from '2021-07-26T03:38:37.098Z' and backwards to 5 minutes before:

    +
      +
    • zowe zos-logs list logs --start-time 2021-07-26T03:38:37.098Z --range 5m
    • +
    +
  • +
+
+

zowezos-ssh

+

Issue z/OS USS commands remotely using an SSH session. Output from the commands is displayed on the local terminal.

+

zowezos-sshissue

+

Issue a z/OS USS command.

+

zowezos-sshissuecommand

+

Issue a z/OS USS command

+

Note: The common CLI 'Base Connection Options' of token-type and token-value are not applicable to the ssh command, since the ssh service is not accessible through APIML.

+

Usage

+

zowe zos-ssh issue command <command> [options]

+

Positional Arguments

+
    +
  • +

    command (string)

    +
      +
    • z/OS USS command to issue
    • +
    +
  • +
+

Options

+
    +
  • +

    --cwd (string)

    +
      +
    • Working directory in which to execute the command
    • +
    +
  • +
+

z/OS Ssh Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OS SSH server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OS SSH server port.

      +

      Default value: 22

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --privateKey | --key | --pk (string)

    +
      +
    • Path to a file containing your private key, that must match a public key stored in the server for authentication
    • +
    +
  • +
  • +

    --keyPassphrase | --passphrase | --kp (string)

    +
      +
    • Private key passphrase, which unlocks the private key.
    • +
    +
  • +
  • +

    --handshakeTimeout | --timeout | --to (number)

    +
      +
    • How long in milliseconds to wait for the SSH handshake to complete.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ssh-profile | --ssh-p (string)

    +
      +
    • The name of a (ssh) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issue a simple command, giving the working directory:

    +
      +
    • zowe zos-ssh issue command "npm install express" --cwd /u/cicprov/mnt/CICPY01I/bundles/myapp 
    • +
    +
  • +
+
+

zowezos-tso

+

Issue TSO commands and interact with TSO address spaces.

+

zowezos-tsoissue

+

Issue TSO commands.

+

zowezos-tsoissuecommand

+

Creates a TSO address space, issues a TSO command through the newly created address space, waits for the READY prompt to print the response, and terminates the TSO address space. All response data are returned to the user up to (but not including) the TSO 'READY' prompt.

+

Usage

+

zowe zos-tso issue command <commandText> [options]

+

Positional Arguments

+
    +
  • +

    commandText (string)

    +
      +
    • The TSO command to issue.
    • +
    +
  • +
+

Options

+
    +
  • +

    --suppress-startup-messages | --ssm (boolean)

    +
      +
    • Suppress console messages from start of address space.
    • +
    +
  • +
+

TSO ADDRESS SPACE OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • Your z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --character-set | --cs (string)

    +
      +
    • +

      Character set for address space to convert messages and responses from UTF-8 to EBCDIC.

      +

      Default value: 697

      +
    • +
    +
  • +
  • +

    --code-page | --cp (string)

    +
      +
    • +

      Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC.

      +

      Default value: 1047

      +
    • +
    +
  • +
  • +

    --columns | --cols (number)

    +
      +
    • +

      The number of columns on a screen.

      +

      Default value: 80

      +
    • +
    +
  • +
  • +

    --logon-procedure | -l (string)

    +
      +
    • +

      The logon procedure to use when creating TSO procedures on your behalf.

      +

      Default value: IZUFPROC

      +
    • +
    +
  • +
  • +

    --region-size | --rs (number)

    +
      +
    • +

      Region size for the TSO/E address space.

      +

      Default value: 4096

      +
    • +
    +
  • +
  • +

    --rows (number)

    +
      +
    • +

      The number of rows on a screen.

      +

      Default value: 24

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --tso-profile | --tso-p (string)

    +
      +
    • The name of a (tso) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issue the TSO command "status" to display information about jobs for your user ID.:

    +
      +
    • zowe zos-tso issue command "status"
    • +
    +
  • +
+

zowezos-tsoping

+

Ping a TSO address space, from which you previously started and received a token (a.k.a 'servelet-key').

+

zowezos-tsopingaddress-space

+

Ping a TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').

+

Usage

+

zowe zos-tso ping address-space <servletKey> [options]

+

Positional Arguments

+
    +
  • +

    servletKey (string)

    +
      +
    • The servlet key from a previously started TSO address space.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Ping the TSO address space identified by IBMUSER-329-aafkaaoc:

    +
      +
    • zowe zos-tso ping address-space IBMUSER-329-aafkaaoc
    • +
    +
  • +
+

zowezos-tsosend

+

Send data to TSO and collect responses until the prompt is reached.

+

zowezos-tsosendaddress-space

+

Send data to the TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').

+

Usage

+

zowe zos-tso send address-space <servletKey> [options]

+

Positional Arguments

+
    +
  • +

    servletKey (string)

    +
      +
    • The servlet key from a previously started TSO address space.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --data (string)

    +
      +
    • The data to which we want to send to the TSO address space represented by the servlet key.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    "Send the TIME TSO command to the TSO address space identified by IBMUSER-329-aafkaaoc":

    +
      +
    • zowe zos-tso send address-space IBMUSER-329-aafkaaoc --data "TIME"
    • +
    +
  • +
+

zowezos-tsostart

+

Start TSO/E address space.

+

zowezos-tsostartaddress-space

+

Start a TSO address space, from which you will receive a token (a.k.a 'servlet-key') for further address space interaction (e.g. termination).

+

Usage

+

zowe zos-tso start address-space [options]

+

TSO ADDRESS SPACE OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • Your z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --character-set | --cs (string)

    +
      +
    • +

      Character set for address space to convert messages and responses from UTF-8 to EBCDIC.

      +

      Default value: 697

      +
    • +
    +
  • +
  • +

    --code-page | --cp (string)

    +
      +
    • +

      Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC.

      +

      Default value: 1047

      +
    • +
    +
  • +
  • +

    --columns | --cols (number)

    +
      +
    • +

      The number of columns on a screen.

      +

      Default value: 80

      +
    • +
    +
  • +
  • +

    --logon-procedure | -l (string)

    +
      +
    • +

      The logon procedure to use when creating TSO procedures on your behalf.

      +

      Default value: IZUFPROC

      +
    • +
    +
  • +
  • +

    --region-size | --rs (number)

    +
      +
    • +

      Region size for the TSO/E address space.

      +

      Default value: 4096

      +
    • +
    +
  • +
  • +

    --rows (number)

    +
      +
    • +

      The number of rows on a screen.

      +

      Default value: 24

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --servlet-key-only | --sko (boolean)

    +
      +
    • Specify this option to print only the servlet key
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --tso-profile | --tso-p (string)

    +
      +
    • The name of a (tso) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Start TSO/E address space:

    +
      +
    • zowe zos-tso start address-space
    • +
    +
  • +
  • +

    Start TSO/E address space, and receive response in JSON format:

    +
      +
    • zowe zos-tso start address-space --rfj
    • +
    +
  • +
  • +

    Start TSO/E address space, and print only the servlet key:

    +
      +
    • zowe zos-tso start address-space --sko
    • +
    +
  • +
+

zowezos-tsostop

+

Stop TSO/E address space.

+

zowezos-tsostopaddress-space

+

Stop a TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').

+

Usage

+

zowe zos-tso stop address-space <servletkey> [options]

+

Positional Arguments

+
    +
  • +

    servletkey (string)

    +
      +
    • The servlet key from a previously started TSO address space.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Stop the TSO address space identified by IBMUSER-329-aafkaaoc:

    +
      +
    • zowe zos-tso stop address-space IBMUSER-329-aafkaaoc
    • +
    +
  • +
+
+

zowezos-workflows

+

Create and manage z/OSMF workflows on a z/OS system.

+

zowezos-workflowsarchive

+

Archive workflow instance in z/OSMF.

+

zowezos-workflowsarchiveactive-workflow

+

Archive an active workflow instance in z/OSMF.

+

Usage

+

zowe zos-workflows archive active-workflow [options]

+

Options

+
    +
  • +

    --workflow-name | --wn (string)

    +
      +
    • The name of the workflow to be archived.
    • +
    +
  • +
  • +

    --workflow-key | --wk (string)

    +
      +
    • The workflow key of the workflow to be archived.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Archive a workflow with workflow name "testworkflow":

    +
      +
    • zowe zos-workflows archive active-workflow --wn "testworkflow"
    • +
    +
  • +
  • +

    Archive multiple workflows with workflow names starting with "test":

    +
      +
    • zowe zos-workflows archive active-workflow --wn "test.*"
    • +
    +
  • +
  • +

    Archive a workflow with workflow key "123-456-abv-xyz":

    +
      +
    • zowe zos-workflows archive active-workflow --wk "123-456-abv-xyz"
    • +
    +
  • +
+

zowezos-workflowscreate

+

Create a z/OSMF workflow on a z/OS system.

+

zowezos-workflowscreateworkflow-from-data-set

+

Create a z/OSMF workflow on a z/OS system using a Data set

+

Usage

+

zowe zos-workflows create workflow-from-data-set <workflowName> [options]

+

Positional Arguments

+
    +
  • +

    workflowName (string)

    +
      +
    • Name of the workflow
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --data-set | --ds (string)

    +
      +
    • Data set that contains a workflow definition.
    • +
    +
  • +
  • +

    --system-name | --sn (string)

    +
      +
    • z/OS system to execute the workflow.
    • +
    +
  • +
  • +

    --owner | --ow (string)

    +
      +
    • User ID of the workflow owner. This user can perform the workflow steps or delegate the steps to other users.
    • +
    +
  • +
+

Options

+
    +
  • +

    --variables-input-file | --vif (string)

    +
      +
    • Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that are defined in the workflow definition file.
    • +
    +
  • +
  • +

    --variables | --vs (string)

    +
      +
    • Includes a list of variables for the workflow. The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. Make sure the value meets all regular expression requirements set for the corresponding variable.
    • +
    +
  • +
  • +

    --assign-to-owner | --ato (boolean)

    +
      +
    • Indicates whether the workflow steps are assigned to the workflow owner.
    • +
    +
  • +
  • +

    --access-type | --at (string)

    +
      +
    • +

      Specifies the access type for the workflow. Public, Restricted or Private.

      +

      Allowed values: Public, Restricted, Private

      +
    • +
    +
  • +
  • +

    --delete-completed | --dc (boolean)

    +
      +
    • Whether the successfully completed jobs to be deleted from the JES spool.
    • +
    +
  • +
  • +

    --overwrite | --ov (boolean)

    +
      +
    • Replaces an existing workflow with a new workflow.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a workflow with name "testworkflow" using the data set "TESTID.WKFLOW" that contains the workflow definition xml on the system "TESTM1" with owner "OTHERID" and delete workflow with the same name if it already exists in z/OSMF:

    +
      +
    • zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "OTHERID" --overwrite
    • +
    +
  • +
  • +

    Create a workflow with name "testworkflow" using data set "TESTID.WKFLOW" containing workflow definition xml, on system "TESTM1" with owner "MYSYSID" and delete successfully completed jobs:

    +
      +
    • zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "MYSYSID" --delete-completed
    • +
    +
  • +
  • +

    Create a workflow with name "testworkflow" using data set "TESTID.WKFLOW" containing workflow definition xml, on system "TESTM1" with owner "MYSYSID" and with variable values in the member PROPERTIES of data set TESTID.DATA:

    +
      +
    • zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "MYSYSID" --variables-input-file TESTID.DATA(PROPERTIES)
    • +
    +
  • +
  • +

    Create a workflow with name "testworkflow" using the data set "TESTID.WKFLOW" that contains a workflow definition xml, on a system "TESTM1" with owner "MYSYSID" and with the variable name DUMMYVAR and the value DUMMYVAL. Assign it to the owner:

    +
      +
    • zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "MYSYSID" --variables DUMMYVAR=DUMMYVAL --assign-to-owner
    • +
    +
  • +
+

zowezos-workflowscreateworkflow-from-local-file

+

Create a z/OSMF workflow on a z/OS system using a Local file

+

Usage

+

zowe zos-workflows create workflow-from-local-file <workflowName> [options]

+

Positional Arguments

+
    +
  • +

    workflowName (string)

    +
      +
    • Name of the workflow
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --local-file | --lf (string)

    +
      +
    • Local file that contains workflow definition.
    • +
    +
  • +
  • +

    --system-name | --sn (string)

    +
      +
    • z/OS system to execute the workflow.
    • +
    +
  • +
  • +

    --owner | --ow (string)

    +
      +
    • User ID of the workflow owner. This user can perform the workflow steps or delegate the steps to other users.
    • +
    +
  • +
+

Options

+
    +
  • +

    --variables-input-file | --vif (string)

    +
      +
    • Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that are defined in the workflow definition file.
    • +
    +
  • +
  • +

    --variables | --vs (string)

    +
      +
    • Includes a list of variables for the workflow. The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. Make sure the value meets all regular expression requirements set for the corresponding variable.
    • +
    +
  • +
  • +

    --assign-to-owner | --ato (boolean)

    +
      +
    • Indicates whether the workflow steps are assigned to the workflow owner.
    • +
    +
  • +
  • +

    --access-type | --at (string)

    +
      +
    • +

      Specifies the access type for the workflow. Public, Restricted or Private.

      +

      Allowed values: Public, Restricted, Private

      +
    • +
    +
  • +
  • +

    --delete-completed | --dc (boolean)

    +
      +
    • Whether the successfully completed jobs to be deleted from the JES spool.
    • +
    +
  • +
  • +

    --overwrite | --ov (boolean)

    +
      +
    • Replaces an existing workflow with a new workflow.
    • +
    +
  • +
  • +

    --remote-directory | --rd (string)

    +
      +
    • The remote uss directory where the files are to be uploaded. The directory has to exist
    • +
    +
  • +
  • +

    --keep-files | --kf (boolean)

    +
      +
    • +

      Avoid deletion the uploaded files in /tmp or another specified directory after successful execution.

      +

      Default value: false

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a workflow with name "testworkflow" using the local file "TESTID_WKFLOW.xml" that contains the workflow definition xml on the system "TESTM1" with owner "OTHERID" and delete workflow with the same name if it already exists in z/OSMF:

    +
      +
    • zowe zos-workflows create workflow-from-local-file "testworkflow" --local-file "TESTID_WKFLOW.xml" --system-name "TESTM1" --owner "OTHERID" --overwrite
    • +
    +
  • +
+

zowezos-workflowscreateworkflow-from-uss-file

+

Create a workflow instance in z/OSMF using a USS file

+

Usage

+

zowe zos-workflows create workflow-from-uss-file <workflowName> [options]

+

Positional Arguments

+
    +
  • +

    workflowName (string)

    +
      +
    • Name of the workflow instance to create
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --uss-file | --uf (string)

    +
      +
    • Uss file that contains workflow definition.
    • +
    +
  • +
  • +

    --system-name | --sn (string)

    +
      +
    • z/OS system to execute the workflow.
    • +
    +
  • +
  • +

    --owner | --ow (string)

    +
      +
    • User ID of the workflow owner. This user can perform the workflow steps or delegate the steps to other users.
    • +
    +
  • +
+

Options

+
    +
  • +

    --variables-input-file | --vif (string)

    +
      +
    • Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that are defined in the workflow definition file.
    • +
    +
  • +
  • +

    --variables | --vs (string)

    +
      +
    • Includes a list of variables for the workflow. The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. Make sure the value meets all regular expression requirements set for the corresponding variable.
    • +
    +
  • +
  • +

    --assign-to-owner | --ato (boolean)

    +
      +
    • Indicates whether the workflow steps are assigned to the workflow owner.
    • +
    +
  • +
  • +

    --access-type | --at (string)

    +
      +
    • +

      Specifies the access type for the workflow. Public, Restricted or Private.

      +

      Allowed values: Public, Restricted, Private

      +
    • +
    +
  • +
  • +

    --delete-completed | --dc (boolean)

    +
      +
    • Whether the successfully completed jobs to be deleted from the JES spool.
    • +
    +
  • +
  • +

    --overwrite | --ov (boolean)

    +
      +
    • Replaces an existing workflow with a new workflow.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "OTHERID" and delete workflow with the same name if it already exists in z/OSMF:

    +
      +
    • zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "OTHERID" --overwrite
    • +
    +
  • +
  • +

    Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "MYSYSID" and delete successfully completed jobs:

    +
      +
    • zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "MYSYSID" --delete-completed
    • +
    +
  • +
  • +

    Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "MYSYSID" and with variable values in the member PROPERTIES of data set TESTID.DATA:

    +
      +
    • zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "MYSYSID" --variables-input-file TESTID.DATA(PROPERTIES)
    • +
    +
  • +
  • +

    Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "MYSYSID" and with variables VAR1 and VAR2 with values DUMMYVAL1 and DUMMYVAL2, and assign it to the owner:

    +
      +
    • zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1"--variables VAR1=DUMMYVAL1,VAR2=DUMMYVAL2 --owner "MYSYSID" --assign-to-owner
    • +
    +
  • +
+

zowezos-workflowsdelete

+

Delete an active workflow or an archived workflow from z/OSMF.

+

zowezos-workflowsdeleteactive-workflow

+

Delete an active workflow instance in z/OSMF

+

Usage

+

zowe zos-workflows delete active-workflow [options]

+

Options

+
    +
  • +

    --workflow-key | --wk (string)

    +
      +
    • Delete active workflow by specified workflow key
    • +
    +
  • +
  • +

    --workflow-name | --wn (string)

    +
      +
    • Delete active workflow by specified workflow name
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To delete a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":

    +
      +
    • zowe zos-workflows delete active-workflow --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
    • +
    +
  • +
  • +

    To delete a workflow instance in z/OSMF with workflow name "testWorkflow":

    +
      +
    • zowe zos-workflows delete active-workflow --workflow-name "testWorkflow"
    • +
    +
  • +
  • +

    To delete multiple workflow instances in z/OSMF with names starting with "test":

    +
      +
    • zowe zos-workflows delete active-workflow --workflow-name "test.*"
    • +
    +
  • +
+

zowezos-workflowsdeletearchived-workflow

+

Delete an archived workflow from z/OSMF

+

Usage

+

zowe zos-workflows delete archived-workflow [options]

+

Options

+
    +
  • +

    --workflow-key | --wk (string)

    +
      +
    • Delete an archived workflow by specified workflow key
    • +
    +
  • +
  • +

    --workflow-name | --wn (string)

    +
      +
    • Delete an archived workflow by specified workflow name
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To delete an archived workflow from z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":

    +
      +
    • zowe zos-workflows delete archived-workflow --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
    • +
    +
  • +
  • +

    To delete an archived workflow from z/OSMF with workflow name "testWorkflow":

    +
      +
    • zowe zos-workflows delete archived-workflow --workflow-name "testWorkflow"
    • +
    +
  • +
  • +

    To delete multiple archived workflows from z/OSMF with names beginnig with "test":

    +
      +
    • zowe zos-workflows delete archived-workflow --workflow-name "test.*"
    • +
    +
  • +
+

zowezos-workflowslist

+

List the z/OSMF workflows for a system or a sysplex with filter options.

+

zowezos-workflowslistactive-workflow-details

+

Get the details of an active z/OSMF workflow

+

Usage

+

zowe zos-workflows list active-workflow-details [options]

+

Options

+
    +
  • +

    --workflow-name | --wn (string)

    +
      +
    • List active workflow details by specified workflow name.
    • +
    +
  • +
  • +

    --workflow-key | --wk (string)

    +
      +
    • List active workflow details by specified workflow key.
    • +
    +
  • +
  • +

    --list-steps | --ls (boolean)

    +
      +
    • Optional parameter for listing steps and their properties.
    • +
    +
  • +
  • +

    --steps-summary-only | --sso (boolean)

    +
      +
    • Optional parameter that lists steps summary only.
    • +
    +
  • +
  • +

    --list-variables | --lv (boolean)

    +
      +
    • Optional parameter for listing variables and their properties.
    • +
    +
  • +
  • +

    --skip-workflow-summary | --sws (boolean)

    +
      +
    • Optional parameter that skips the default workflow summary.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To list the details of an active workflow with key "7c62c790-0340-86b2-61ce618d8f8c" including its steps and variables:

    +
      +
    • zowe zos-workflows list active-workflow-details --workflow-key "7c62c790-0340-86b2-61ce618d8f8c" --list-steps --list-variables
    • +
    +
  • +
  • +

    To list the details of an active workflow with name "testWorkflow" including its steps and variables:

    +
      +
    • zowe zos-workflows list active-workflow-details --workflow-name "testWorkflow" --list-steps --list-variables
    • +
    +
  • +
+

zowezos-workflowslistactive-workflows

+

List active workflow instance(s) in z/OSMF.
+Multiple filters can be used together.
+Omitting all options will list all workflows on the sysplex

+

Usage

+

zowe zos-workflows list active-workflows [options]

+

Options

+
    +
  • +

    --workflow-name | --wn (string)

    +
      +
    • Filter by workflow name. For wildcard use .*
    • +
    +
  • +
  • +

    --category | --cat (string)

    +
      +
    • Filter by the category of the workflows, which is either general or configuration.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • Filter by the nickname of the system on which the workflows is/are active.
    • +
    +
  • +
  • +

    --owner | --ow (string)

    +
      +
    • Filter by owner of the workflow(s) (a valid z/OS user ID).
    • +
    +
  • +
  • +

    --vendor | --vd (string)

    +
      +
    • Filter by the name of the vendor that provided the workflow(s) definition file.
    • +
    +
  • +
  • +

    --status-name | --sn (string)

    +
      +
    • +

      Filter by the status of the workflow(s).

      +

      Allowed values: in-progress, complete, automation-in-progress, canceled

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the workflow with name "testworkflow":

    +
      +
    • zowe zos-workflows list active-workflows --wn "testworkflow"
    • +
    +
  • +
  • +

    List multiple active workflows on the entire syspex with names containing"workflow":

    +
      +
    • zowe zos-workflows list active-workflows --wn ".*workflow.*"
    • +
    +
  • +
  • +

    List multiple active workflows on system "IBMSYS" with names beginnig with "testW" that are in status "complete":

    +
      +
    • zowe zos-workflows list active-workflows --wn "test.*" --sys "IBMSYS" --sn "complete"
    • +
    +
  • +
+

zowezos-workflowslistarchived-workflows

+

List the archived z/OSMF workflows for a system or sysplex.

+

Usage

+

zowe zos-workflows list archived-workflows [options]

+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

zowezos-workflowslistdefinition-file-details

+

Retrieve the contents of a z/OSMF workflow definition from a z/OS system.

+

Usage

+

zowe zos-workflows list definition-file-details <definitionFilePath> [options]

+

Positional Arguments

+
    +
  • +

    definitionFilePath (string)

    +
      +
    • Specifies the location of the workflow definition file, which is either a UNIX path name or a fully qualified z/OS data set name.
    • +
    +
  • +
+

Options

+
    +
  • +

    --list-steps | --ls (boolean)

    +
      +
    • Optional parameter for listing steps and their properties.
    • +
    +
  • +
  • +

    --list-variables | --lv (boolean)

    +
      +
    • Optional parameter for listing variables and their properties.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To list the contents of a workflow definition stored in the UNIX file "/user/dir/workflow.xml" including its steps and variables:

    +
      +
    • zowe zos-workflows list definition-file-details "/user/dir/workflow.xml" --list-steps --list-variables
    • +
    +
  • +
  • +

    To list the contents of a workflow definition stored in the z/OS data set "USER.DATA.SET.XML" including its steps and variables:

    +
      +
    • zowe zos-workflows list definition-file-details "USER.DATA.SET.XML" --list-steps --list-variables
    • +
    +
  • +
+

zowezos-workflowsstart

+

Start a z/OSMF workflow on a z/OS system.

+

zowezos-workflowsstartworkflow-full

+

Will run workflow from the beginning to the end or to the first manual step.

+

Usage

+

zowe zos-workflows start workflow-full [options]

+

Options

+
    +
  • +

    --workflow-key | --wk (string)

    +
      +
    • Workflow key of workflow instance to be started
    • +
    +
  • +
  • +

    --workflow-name | --wn (string)

    +
      +
    • Workflow name of workflow instance to be started
    • +
    +
  • +
  • +

    --resolve-conflict-by | --rcb (string)

    +
      +
    • +

      How variable conflicts should be handled.
      +Options:
      +outputFileValue: Allow the output file values to override the existing values.
      +existingValue: Use the existing variables values instead of the output file values.
      +leaveConflict: Automation is stopped. The user must resolve the conflict manually.

      +

      Default value: outputFileValue
      +Allowed values: outputFileValue, existingValue, leaveConflict

      +
    • +
    +
  • +
  • +

    --wait | -w (boolean)

    +
      +
    • Identifies whether to wait for workflow instance to finish.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To start a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":

    +
      +
    • zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
    • +
    +
  • +
  • +

    To start a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" and wait forit to be finished:

    +
      +
    • zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --wait
    • +
    +
  • +
  • +

    To start a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"and if there is a conflict in variable's value use the value that is in output file:

    +
      +
    • zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --resolve-conflict-by "outputFileValue"
    • +
    +
  • +
  • +

    To start a workflow instance in z/OSMF with workflow name "testWorkflow":

    +
      +
    • zowe zos-workflows start workflow-full --workflow-name "testWorkflow"
    • +
    +
  • +
+

zowezos-workflowsstartworkflow-step

+

Will run given step of workflow instance plus following steps if specified by --perform-following-steps option.

+

Usage

+

zowe zos-workflows start workflow-step <stepName> [options]

+

Positional Arguments

+
    +
  • +

    stepName (string)

    +
      +
    • Specifies the step name that will be run.
    • +
    +
  • +
+

Options

+
    +
  • +

    --workflow-key | --wk (string)

    +
      +
    • Workflow key of workflow instance to be started
    • +
    +
  • +
  • +

    --workflow-name | --wn (string)

    +
      +
    • Workflow name of workflow instance to be started
    • +
    +
  • +
  • +

    --resolve-conflict-by | --rcb (string)

    +
      +
    • +

      How variable conflicts should be handled.
      +Options:
      +outputFileValue: Allow the output file values to override the existing values.
      +existingValue: Use the existing variables values instead of the output file values.
      +leaveConflict: Automation is stopped. The user must resolve the conflict manually.

      +

      Default value: outputFileValue
      +Allowed values: outputFileValue, existingValue, leaveConflict

      +
    • +
    +
  • +
  • +

    --perform-following-steps | --pfs (boolean)

    +
      +
    • +

      Identifies whether to perform also following steps in the workflow instance.

      +

      Default value: false

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To start step "Step1" only in a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":

    +
      +
    • zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
    • +
    +
  • +
  • +

    To start a workflow instance in z/OSMF from step "Step1" with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":

    +
      +
    • zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --perform-following-steps
    • +
    +
  • +
  • +

    To start step "Step1" only in a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"and if there is a conflict in variable's value use the value that is in output file:

    +
      +
    • zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --resolve-conflict-by "outputFileValue"
    • +
    +
  • +
  • +

    To start step "Step1" only in a workflow instance in z/OSMF with workflow name "testWorkflow":

    +
      +
    • zowe zos-workflows start workflow-step "Step1" --workflow-name "testWorkflow"
    • +
    +
  • +
+
+

zowezosmf

+

Retrieve and show the properties of a z/OSMF web server.

+

zowezosmfcheck

+

Confirm that z/OSMF is running on a specified system and gather information about the z/OSMF server for diagnostic purposes.

+

zowezosmfcheckstatus

+

Confirm that z/OSMF is running on a system specified in your profile and gather information about the z/OSMF server for diagnostic purposes. The command outputs properties of the z/OSMF server such as version, hostname, and installed plug-ins.

+

Usage

+

zowe zosmf check status [options]

+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Report the status of the z/OSMF server that you specified in your default z/OSMF profile:

    +
      +
    • zowe zosmf check status
    • +
    +
  • +
  • +

    Report the status of the z/OSMF server that you specified in a supplied z/OSMF profile:

    +
      +
    • zowe zosmf check status --zosmf-profile SomeZosmfProfileName
    • +
    +
  • +
  • +

    Report the status of the z/OSMF server that you specified manually via command line:

    +
      +
    • zowe zosmf check status --host myhost --port 443 --user myuser --password mypass
    • +
    +
  • +
+

zowezosmflist

+

Obtain a list of systems that are defined to a z/OSMF instance.

+

zowezosmflistsystems

+

Obtain a list of systems that are defined to a z/OSMF instance.

+

Usage

+

zowe zosmf list systems [options]

+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Obtain a list of systems defined to a z/OSMF instance with your default z/OSMF profile:

    +
      +
    • zowe zosmf list systems
    • +
    +
  • +
  • +

    Obtain a list of systems defined to a z/OSMF instance for the specified z/OSMF profile:

    +
      +
    • zowe zosmf list systems --zosmf-profile SomeZosmfProfileName
    • +
    +
  • +
  • +

    Obtain a list of the systems defined to a z/OSMF instance that you specified in the command line:

    +
      +
    • zowe zosmf list systems --host myhost --port 443 --user myuser --password mypass
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe.html b/static/v2.15.x/web_help/docs/zowe.html new file mode 100644 index 0000000000..d1bb236747 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe.html @@ -0,0 +1,90 @@ + + + + +zowe + + +
+

zowe

+

Welcome to Zowe CLI!

+

Zowe CLI is a command line interface (CLI) that provides a simple and streamlined way to interact with IBM z/OS.

+

For additional Zowe CLI documentation, visit https://docs.zowe.org

+

For Zowe CLI support, visit https://www.zowe.org

+ +

Groups

+
    +
  • auth - Connect to Zowe API ML authentication service
  • +
  • ca7 | 7 - CA7 Plugin for ZOWE CLI
  • +
  • caview | cv - Access View data and perform related tasks.
  • +
  • cics - Interact with IBM CICS programs and transactions.
  • +
  • config - Manage JSON project and global configuration
  • +
  • daemon - Daemon operations
  • +
  • db2 - Interact with IBM Db2 for z/OS
  • +
  • dbm-db2 | dbm - Interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.
  • +
  • ejes | ejes - Zowe CLI EJES RESTapi Manager plug-in
  • +
  • endevor - Endevor plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.
  • +
  • endevor-bridge-for-git | ebg - Interact with a Endevor Bridge for Git server
  • +
  • file-master-plus | fmp - Advanced file management and data manipulation
  • +
  • idms - Interact with IDMS
  • +
  • ims - Interact with IBM IMS programs and transactions.
  • +
  • jclcheck | jck - JCLCheck plugin
  • +
  • mat | mat - Manage monitor profiles and analyze the measurement data using MAT
  • +
  • mat-pma-util | pma - The MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of Mainframe Application Tuner.
  • +
  • mq - Interact with IBM MQ for z/OS.
  • +
  • omspool | esf - Spool™ Plug-in for Zowe™ CLI
  • +
  • ops - Zowe CLI Plug-in for OPS/MVS®
  • +
  • plugins - Install and manage plug-ins.
  • +
  • profiles - Create and manage configuration profiles. (deprecated)
  • +
  • provisioning | pv - Perform z/OSMF provisioning tasks
  • +
  • sysview | sv - Integration with SYSVIEW
  • +
  • zjcl-expert | jclx - IBM Z JCL Expert Plug-in for Zowe CLI
  • +
  • zos-console | console - Issue z/OS console commands and collect responses
  • +
  • zos-files | files - Manage z/OS data sets
  • +
  • zos-ftp | zftp - z/OS Files and jobs via FTP
  • +
  • zos-jobs | jobs - Manage z/OS jobs
  • +
  • zos-logs | logs - Interact with z/OS logs
  • +
  • zos-ssh | ssh | zos-uss | uss - Issue z/OS USS commands and receive responses
  • +
  • zos-tso | tso - Interact with TSO
  • +
  • zos-workflows | wf - Create and manage z/OSMF workflows
  • +
  • zosmf - Interact with z/OSMF
  • +
+

Options

+
    +
  • +

    --version | -V (boolean)

    +
      +
    • Display the current version of Zowe CLI
    • +
    +
  • +
  • +

    --available-commands | --ac (boolean)

    +
      +
    • Displays a list of available commands
    • +
    +
  • +
+

Global Options

+
    +
  • +

    --response-format-json | --rfj (boolean)

    +
      +
    • Produce JSON formatted data from a command
    • +
    +
  • +
  • +

    --help | -h (boolean)

    +
      +
    • Display help text
    • +
    +
  • +
  • +

    --help-web | --hw (boolean)

    +
      +
    • Display HTML help in browser
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_auth.html b/static/v2.15.x/web_help/docs/zowe_auth.html new file mode 100644 index 0000000000..970f627e1d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_auth.html @@ -0,0 +1,22 @@ + + + + +auth + + +
+

zoweauth

+

Connect to Zowe API Mediation Layer authentication service and obtain a token, or disconnect from the authentication service and revoke the token.

+

The token provides authentication to services that support the API ML SSO (Single Sign-On) capability. When you log in, the token is stored in your default base profile until it expires. Base profiles store connection information shared by multiple services (e.g., z/OSMF), and are used if you do not supply connection information in a service profile. To take advantage of the API ML SSO capability, you should omit username and password in service profiles so that the token in the base profile is used.

+

Usage

+

zowe auth <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_auth_login.html b/static/v2.15.x/web_help/docs/zowe_auth_login.html new file mode 100644 index 0000000000..23edb4212f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_auth_login.html @@ -0,0 +1,20 @@ + + + + +auth login + + +
+

zoweauthlogin

+

Log in to an authentication service.

+

Usage

+

zowe auth login <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • apiml - Log in to API ML authentication service
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_auth_login_apiml.html b/static/v2.15.x/web_help/docs/zowe_auth_login_apiml.html new file mode 100644 index 0000000000..68f459b292 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_auth_login_apiml.html @@ -0,0 +1,100 @@ + + + + +auth login apiml + + +
+

zoweauthloginapiml

+

Log in to Zowe API Mediation Layer authentication service and obtain or update a token.

+

The token provides authentication to services that support the API ML SSO (Single Sign-On) capability. When you log in, the token is stored in your default base profile until it expires. Base profiles store connection information shared by multiple services (e.g., z/OSMF), and are used if you do not supply connection information in a service profile. To take advantage of the API ML SSO capability, you should omit username and password in service profiles so that the token in the base profile is used.

+

Usage

+

zowe auth login apiml [options]

+

Options

+
    +
  • +

    --show-token | --st (boolean)

    +
      +
    • Show the token when login is successful. If specified, does not save the token to a profile.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Log in to an API ML instance to obtain or update the token stored in your base profile:

    +
      +
    • zowe auth login apiml
    • +
    +
  • +
  • +

    Log in to an API ML instance to obtain a token without storing it in a profile:

    +
      +
    • zowe auth login apiml --show-token
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_auth_logout.html b/static/v2.15.x/web_help/docs/zowe_auth_logout.html new file mode 100644 index 0000000000..9fadababee --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_auth_logout.html @@ -0,0 +1,20 @@ + + + + +auth logout + + +
+

zoweauthlogout

+

Log out of an authentication service.

+

Usage

+

zowe auth logout <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • apiml - Log out of API ML authentication service
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_auth_logout_apiml.html b/static/v2.15.x/web_help/docs/zowe_auth_logout_apiml.html new file mode 100644 index 0000000000..d4eabf6c63 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_auth_logout_apiml.html @@ -0,0 +1,78 @@ + + + + +auth logout apiml + + +
+

zoweauthlogoutapiml

+

Log out of the Zowe API Mediation Layer authentication service and revoke the token so it can no longer authenticate. Also remove the token from the default base profile, if it is stored on disk.

+

Usage

+

zowe auth logout apiml [options]

+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • +

      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'.

      +

      Allowed values: ^apimlAuthenticationToken.*, jwtToken, LtpaToken2

      +
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Log out of an API ML instance to revoke the token that was in use and remove it from your base profile:

    +
      +
    • zowe auth logout apiml
    • +
    +
  • +
  • +

    Log out of an API ML instance to revoke a token that was not stored in a profile:

    +
      +
    • zowe auth logout apiml --token-value <token>
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7.html b/static/v2.15.x/web_help/docs/zowe_ca7.html new file mode 100644 index 0000000000..8276d816f8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7.html @@ -0,0 +1,35 @@ + + + + +ca7 + + +
+

zoweca7

+

Welcome to the CA 7 Zowe CLI!

+

Usage

+

zowe ca7 <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands.html new file mode 100644 index 0000000000..954238b688 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands.html @@ -0,0 +1,39 @@ + + + + +ca7 commands + + +
+

zoweca7commands

+

All the available commands are listed in the COMMANDS section.

+

Usage

+

zowe ca7 commands <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • addrq | ar - Adds temporary user or predecessor job requirements
  • +
  • cancel | c - Cancels a job request to CA 7
  • +
  • demand | d - Demand a CA 7 job
  • +
  • demandh | dh - Defines the name of the job being demanded and hold
  • +
  • hold | h - Holds a job from moving forward to the next queue
  • +
  • jclovrd | jo - Adds a permanent JCL override requirement for a CPU job
  • +
  • post | po - Posts the requirement for a job
  • +
  • prscf | pc - Frees a shared resource that belongs to a job
  • +
  • prsqa | pq - Activates a co-requisite resource
  • +
  • release | rl - Release or resumed for jobs or queues on hold
  • +
  • requeue | rq - Re-queues CA 7 jobs
  • +
  • resolv | rslv - The RESOLV command creates or modifies processing schedules for jobs that are to be scheduled on a date/time basis.
  • +
  • restart | rs - Restart a job awaiting in the request queue
  • +
  • rmtsub | rsub - Remote Subscribe to a CA 7 job
  • +
  • rmttrk | rtrk - Defines a dependency on a remote CA 7 job.
  • +
  • run | r - Run a CA 7 job
  • +
  • runh | rh - Run a CA 7 job and place the job in hold status
  • +
  • submit | sm - Modifies and expedites the jobs already residing in the queues
  • +
  • subtm | st - Modifies the required submit time-of-day for a job in the request queue
  • +
  • verify | v - Set the manual verification requirement for a job in the request queue
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_addrq.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_addrq.html new file mode 100644 index 0000000000..09d24bc501 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_addrq.html @@ -0,0 +1,192 @@ + + + + +ca7 commands addrq + + +
+

zoweca7commandsaddrq

+

Manually adds temporary, one-time, preexecution user or predecessor job requirements

+

Usage

+

zowe ca7 commands addrq [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the job to which you want to add the job requirement.
      +The job must be in the request queue.
      +Defines the CA 7 job number to which you want to add the requirement for this run of the job.
      +Limits: 1 to 4 numeric characters

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --depjob (string)

    +
      +
    • +

      example: PAYJOB

      +

      Defines a temporary one-time job dependency requirement.
      +The DEPJOB value specifies the job name that must complete execution
      +or must be manually posted complete before the job identified by JOB is eligible for submission.

      +

      DEPJOB is required unless USR is used, in which case, omit DEPJOB.
      +This requirement is satisfied automatically when the predecessor job completes.
      +Only in unusual situations would this requirement must be satisfied manually.
      +That is, any time that a normal completion did not occur.

      +

      Required: Yes, unless USR is used.

      +

      Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --usr (string)

    +
      +
    • +

      example: USER WILL CALL TO RELEASE

      +

      Defines the description of a temporary, one-time user requirement.
      +This requirement must be manually satisfied before the job identified by JOB is eligible for submission.
      +If any commas are included as part of the text, enclose the entire requirements text in parentheses.
      +This requirement is satisfied automatically when the predecessor job completes.
      +Only in unusual situations would this requirement must be satisfied manually.
      +That is, any time that a normal completion did not occur.
      +Required: USR is required unless DEPJOB is used, in which case, omit USR.

      +

      Limits: 1 to 36 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --rmtjob (string)

    +
      +
    • +

      example: RMT_JOB

      +

      Names the job in the remote scheduler that is required by the job specified in the JOB field.
      +Limits: RMTJOB should accept up to 64 characters
      +valid characters are a-z, A-Z, 0-9, period (.), underscore (_), hyphen (-),
      +colon (:), and pound (#); do not include embedded spaces or tabs.

      +
    • +
    +
  • +
  • +

    --rmtschd (string)

    +
      +
    • +

      example: AP1

      +

      Names the remote scheduler where the predecessor job runs.
      +Before adding this requirement, the remote scheduler must be defined.
      +The remote scheduler defined as type LOCAL cannot be specified.
      +Limits: 1 to 3 alphanumeric characters; generic specification not supported.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Adds the job requirement ca7 number, 0016 from CA 7:

    +
      +
    • zowe ca7 commands addrq --ca7num 0016
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_cancel.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_cancel.html new file mode 100644 index 0000000000..7e1e318caa --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_cancel.html @@ -0,0 +1,152 @@ + + + + +ca7 commands cancel + + +
+

zoweca7commandscancel

+

For CPU jobs, the CANCEL command only removes the job from the queues.
+For XPJOB jobs, the CANCEL command removes the job from the queues.
+For agent definition jobs (AGJOBs), the CANCEL command sends a request to the agent and removes the job from the queues.

+

Usage

+

zowe ca7 commands cancel [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the unique CA 7 job number (leading zeros are not required) for the job to cancel.
      +Limits: 1 to 4 numeric characters

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (string)

    +
      +
    • Specifies to force the cancellation of the job.
      +Use of this option can potentially cause CA WA CA 7 Edition to abend; therefore, only use it as a last resort.
    • +
    +
  • +
  • +

    --reason (string)

    +
      +
    • +

      Defines the reason for the job cancellation.

      +

      Limits: 1 to 40 alphanumeric characters
      +Required: No (depending on initialization options)

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Cancel ca7 number, 0016:

    +
      +
    • zowe ca7 commands cancel --ca7num 0016
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_demand.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_demand.html new file mode 100644 index 0000000000..107320376a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_demand.html @@ -0,0 +1,424 @@ + + + + +ca7 commands demand + + +
+

zoweca7commandsdemand

+

The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
+JOB and JOBL are mutually exclusive.

+

Usage

+

zowe ca7 commands demand [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      job=PAYROLL

      +

      The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
      +1-8 alphanumeric (mutually exclusive w/ jobl

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --jobl (string)

    +
      +
    • +

      jobl=payrollSW123

      +

      Defines the long name of the job being demanded.
      +The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.

      +
    • +
    +
  • +
  • +

    --arfset | --as (string)

    +
      +
    • +

      arfset={arfsetname|**NONE**}

      +

      Defines the ARF set name that is used for this run of the job.
      +If you specify **NONE**, no ARF processing is performed for this run of the job.

      +

      Limits: 1 to 8 alphanumeric characters or **NONE**

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      cc=1234

      +

      Defines, with RO (relational operator), the job-level condition codes that are used to determine whether a job executes successfully.

      +

      If specified, this value overrides the RO defined for the job in the CA WA CA 7 Edition database. RO is required when CC is specified.

      +

      Default: The job definition panel COND-CODE value when the job is defined to CA WA CA 7 Edition; otherwise 0.
      +Limits: 1 to 4 numeric characters from 0 to 4095. Invalid with agent jobs.

      +
    • +
    +
  • +
  • +

    --class (string)

    +
      +
    • +

      class=n

      +

      Defines the workload balancing class for resource checking.

      +

      Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --count (string)

    +
      +
    • +

      count=nnnn

      +

      Defines the maximum number of times to repeat the job. COUNT is ignored if INTERVAL is not specified.

      +

      Default: None. The job continues repeating until the STOP time is reached.
      +Limits: 1 to 4 numeric characters from 0 to 1439. The leading zeros can be discarded.

      +
    • +
    +
  • +
  • +

    --date (string)

    +
      +
    • +

      date={+nn|yyddd}

      +

      Defines due-out and submit dates.
      +Limits: If used, specify DOTM or TIME.
      ++nn

      +

      Defines the number of days after the current date.
      +Limits: 1 to 2 numeric characters from 1 to 99
      +yyddd

      +

      Defines the Julian date to run the job.

      +
    • +
    +
  • +
  • +

    --depjob | --dj (string)

    +
      +
    • +

      depjob=jobname2

      +

      Defines a single predecessor job that must complete while the demanded job is waiting.
      +Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --dotm (string)

    +
      +
    • +

      dotm=hhmm

      +

      Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
      +If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.

      +

      If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.

      +

      Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59

      +

      Required: No (unless DATE is used, if so, DOTM or TIME must be specified)

      +
    • +
    +
  • +
  • +

    --exec | -e (string)

    +
      +
    • +

      exec={NO|YES}

      +

      Specifies whether to execute the job (YES/NO).
      +If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.

      +

      Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.

      +
    • +
    +
  • +
  • +

    --interval | -i (string)

    +
      +
    • +

      interval=hhmm

      +

      Identifies that the job is repeated (executed more than once) and defines the amount of time between each iteration.

      +

      If INTERVAL is specified, the TIME and TYPE keywords are required. If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.

      +

      Limits: hh=2 numeric characters from 0 to 23
      +mm=2 numeric characters from 00 to 59

      +
    • +
    +
  • +
  • +

    --jclid | --ji (string)

    +
      +
    • +

      jclid=10

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.

      +
    • +
    +
  • +
  • +

    --jcllib | --jl (string)

    +
      +
    • +

      jcllib=&SPECIAL

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)

      +
    • +
    +
  • +
  • +

    --late (string)

    +
      +
    • +

      late={NO|YES}

      +

      Specifies whether a notification occurs when the job becomes late.
      +Specify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.

      +
    • +
    +
  • +
  • +

    --leadtm | --lt (string)

    +
      +
    • +

      leadtm={0100|hhmm}

      +

      Specifies the lead (processing) time that is required for the job to run.
      +If omitted, 1 hour is usedFormat: hhmm
      +Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59You can omit leading zeros.

      +
    • +
    +
  • +
  • +

    --mainid | --mi (string)

    +
      +
    • +

      mainid={ALL|SYn|/SYn|-SYn}

      +

      Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
      +The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:

      +

      ALL
      +Specifies all CPUs are acceptable for executing the job.

      +

      SYn
      +n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.

      +

      /SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      -SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --prty (string)

    +
      +
    • +

      prty=nnn
      +Defines the initial workload balancing priority

      +

      Limits: 1-3 numeric (1-255).

      +
    • +
    +
  • +
  • +

    --rms (string)

    +
      +
    • +

      rms={NO|YES}

      +

      Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.

      +

      Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.

      +

      The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
      +Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
      +Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --ro (string)

    +
      +
    • +

      ro={EQ|LT|GT|GE|LE|NE|#S|IG|0}

      +

      Specifies the relational operator of the condition code (CC) or if the step level #SCC statements are being used in the JCL of the job.

      +

      EQ
      +Equal to

      +

      LT
      +Less than

      +

      GT
      +Greater than

      +

      GE
      +Greater than or equal to

      +

      LE
      +Less than or equal to

      +

      NE
      +Not equal to

      +

      #S
      +Step condition code tests to be made based on a #SCC statement.

      +

      IG
      +No evaluation of the job is done. CA WA CA 7 Edition always assumes that the job completes successfully, regardless of condition codes, abend codes, or run-time JCL errors.

      +

      Limits: Invalid with agent jobs.

      +
    • +
    +
  • +
  • +

    --schid | --si (string)

    +
      +
    • +

      schid={1|nnn}

      +

      Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.

      +

      Default: 1
      +Limits: 1 to 3 numeric characters from 1 to 999 (See Note)

      +

      No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)

      +
    • +
    +
  • +
  • +

    --set (string)

    +
      +
    • +

      set={NDB|NTR|SKP}

      +

      Specifies skip the next scheduled cycle for the job (SKP), disable triggering (NTR), or bypass the database updating at the job completion.

      +

      SKP
      +Specifies this run of the job takes the place of the next scheduled run. This value has the same effect as entering NXTCYC,SET=SKP. It is reflected on output from LJOB and LLOCK commands as if NXTCYC,SET=SKP was used. This parameter is invalid if the job has no schedule. SET=SKP has no impact on repeating jobs that are already in the queues.

      +

      NTR
      +Specifies normal triggering is disabled only for this run of the job.

      +

      NDB
      +Allows a job to bypass all load processing at the job completion, but allows other processing to proceed typically.

      +
    • +
    +
  • +
  • +

    --stop (string)

    +
      +
    • +

      stop=hhmm

      +

      Defines the clock time after which the job is not repeated. STOP is ignored if INTERVAL is not specified.

      +

      Default: 1439 minutes (24 hours minus 1 minute) after the submit time
      +Limits: hh=1 through 2 numeric characters from 0 to 23
      +mm=2 numeric characters from 00 to 59

      +
    • +
    +
  • +
  • +

    --time (string)

    +
      +
    • +

      time={hhmm|+hhmm}

      +

      Establishes a submit time-of-day requirement for the job.

      +

      Format: hhmm
      +Defines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).
      +Leading zeros are not required

      +
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • +

      type={CLOCK|END|RES|START}

      +

      Indicates that the job is being scheduled for rerun.
      +The value must be specified as shown.

      +

      TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Demand job, PAYROLL to CA 7:

    +
      +
    • zowe ca7 commands demand --job PAYROLL
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_demandh.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_demandh.html new file mode 100644 index 0000000000..f726abd303 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_demandh.html @@ -0,0 +1,423 @@ + + + + +ca7 commands demandh + + +
+

zoweca7commandsdemandh

+

The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.

+

Usage

+

zowe ca7 commands demandh [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      job=PAYROLL

      +

      Defines the name of the job being demanded.
      +The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --jobl (string)

    +
      +
    • +

      jobl=payrollSW123

      +

      Defines the long name of the job being demanded.
      +The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.

      +
    • +
    +
  • +
  • +

    --arfset | --as (string)

    +
      +
    • +

      arfset={arfsetname|**NONE**}

      +

      Defines the ARF set name that is used for this run of the job.
      +If you specify **NONE**, no ARF processing is performed for this run of the job.

      +

      Limits: 1 to 8 alphanumeric characters or **NONE**

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      cc=1234

      +

      Defines, with RO (relational operator), the job-level condition codes that are used to determine whether a job executes successfully.

      +

      If specified, this value overrides the RO defined for the job in the CA WA CA 7 Edition database. RO is required when CC is specified.

      +

      Default: The job definition panel COND-CODE value when the job is defined to CA WA CA 7 Edition; otherwise 0.
      +Limits: 1 to 4 numeric characters from 0 to 4095. Invalid with agent jobs.

      +
    • +
    +
  • +
  • +

    --class (string)

    +
      +
    • +

      class=n

      +

      Defines the workload balancing class for resource checking.

      +

      Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --count (string)

    +
      +
    • +

      count=nnnn

      +

      Defines the maximum number of times to repeat the job. COUNT is ignored if INTERVAL is not specified.

      +

      Default: None. The job continues repeating until the STOP time is reached.
      +Limits: 1 to 4 numeric characters from 0 to 1439. The leading zeros can be discarded.

      +
    • +
    +
  • +
  • +

    --date (string)

    +
      +
    • +

      date={+nn|yyddd}

      +

      Defines due-out and submit dates.
      +Limits: If used, specify DOTM or TIME.
      ++nn

      +

      Defines the number of days after the current date.
      +Limits: 1 to 2 numeric characters from 1 to 99
      +yyddd

      +

      Defines the Julian date to run the job.

      +
    • +
    +
  • +
  • +

    --depjob | --dj (string)

    +
      +
    • +

      depjob=jobname2

      +

      Defines a single predecessor job that must complete while the demanded job is waiting.
      +Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --dotm (string)

    +
      +
    • +

      dotm=hhmm

      +

      Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
      +If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.

      +

      If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.

      +

      Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59

      +

      Required: No (unless DATE is used, if so, DOTM or TIME must be specified)

      +
    • +
    +
  • +
  • +

    --exec | -e (string)

    +
      +
    • +

      exec={NO|YES}

      +

      Specifies whether to execute the job (YES/NO).
      +If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.

      +

      Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.

      +
    • +
    +
  • +
  • +

    --interval | -i (string)

    +
      +
    • +

      interval=hhmm

      +

      Identifies that the job is repeated (executed more than once) and defines the amount of time between each iteration.

      +

      If INTERVAL is specified, the TIME and TYPE keywords are required. If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.

      +

      Limits: hh=2 numeric characters from 0 to 23
      +mm=2 numeric characters from 00 to 59

      +
    • +
    +
  • +
  • +

    --jclid | --ji (string)

    +
      +
    • +

      jclid=10

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.

      +
    • +
    +
  • +
  • +

    --jcllib | --jl (string)

    +
      +
    • +

      jcllib=&SPECIAL

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)

      +
    • +
    +
  • +
  • +

    --late (string)

    +
      +
    • +

      late={NO|YES}

      +

      Specifies whether a notification occurs when the job becomes late.
      +Specify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.

      +
    • +
    +
  • +
  • +

    --leadtm | --lt (string)

    +
      +
    • +

      leadtm={0100|hhmm}

      +

      Specifies the lead (processing) time that is required for the job to run.
      +If omitted, 1 hour is usedFormat: hhmm
      +Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59You can omit leading zeros.

      +
    • +
    +
  • +
  • +

    --mainid | --mi (string)

    +
      +
    • +

      mainid={ALL|SYn|/SYn|-SYn}

      +

      Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
      +The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:

      +

      ALL
      +Specifies all CPUs are acceptable for executing the job.

      +

      SYn
      +n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.

      +

      /SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      -SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --prty (string)

    +
      +
    • +

      prty=nnn
      +Defines the initial workload balancing priority

      +

      Limits: 1-3 numeric (1-255).

      +
    • +
    +
  • +
  • +

    --rms (string)

    +
      +
    • +

      rms={NO|YES}

      +

      Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.

      +

      Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.

      +

      The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
      +Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
      +Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --ro (string)

    +
      +
    • +

      ro={EQ|LT|GT|GE|LE|NE|#S|IG|0}

      +

      Specifies the relational operator of the condition code (CC) or if the step level #SCC statements are being used in the JCL of the job.

      +

      EQ
      +Equal to

      +

      LT
      +Less than

      +

      GT
      +Greater than

      +

      GE
      +Greater than or equal to

      +

      LE
      +Less than or equal to

      +

      NE
      +Not equal to

      +

      #S
      +Step condition code tests to be made based on a #SCC statement.

      +

      IG
      +No evaluation of the job is done. CA WA CA 7 Edition always assumes that the job completes successfully, regardless of condition codes, abend codes, or run-time JCL errors.

      +

      Limits: Invalid with agent jobs.

      +
    • +
    +
  • +
  • +

    --schid | --si (string)

    +
      +
    • +

      schid={1|nnn}

      +

      Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.

      +

      Default: 1
      +Limits: 1 to 3 numeric characters from 1 to 999 (See Note)

      +

      No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)

      +
    • +
    +
  • +
  • +

    --set (string)

    +
      +
    • +

      set={NDB|NTR|SKP}

      +

      Specifies skip the next scheduled cycle for the job (SKP), disable triggering (NTR), or bypass the database updating at the job completion.

      +

      SKP
      +Specifies this run of the job takes the place of the next scheduled run. This value has the same effect as entering NXTCYC,SET=SKP. It is reflected on output from LJOB and LLOCK commands as if NXTCYC,SET=SKP was used. This parameter is invalid if the job has no schedule. SET=SKP has no impact on repeating jobs that are already in the queues.

      +

      NTR
      +Specifies normal triggering is disabled only for this run of the job.

      +

      NDB
      +Allows a job to bypass all load processing at the job completion, but allows other processing to proceed typically.

      +
    • +
    +
  • +
  • +

    --stop (string)

    +
      +
    • +

      stop=hhmm

      +

      Defines the clock time after which the job is not repeated. STOP is ignored if INTERVAL is not specified.

      +

      Default: 1439 minutes (24 hours minus 1 minute) after the submit time
      +Limits: hh=1 through 2 numeric characters from 0 to 23
      +mm=2 numeric characters from 00 to 59

      +
    • +
    +
  • +
  • +

    --time (string)

    +
      +
    • +

      time={hhmm|+hhmm}

      +

      Establishes a submit time-of-day requirement for the job.

      +

      Format: hhmm
      +Defines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).
      +Leading zeros are not required

      +
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • +

      type={CLOCK|END|RES|START}

      +

      Indicates that the job is being scheduled for rerun.
      +The value must be specified as shown.

      +

      TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Demand and hold job, PAYROLL:

    +
      +
    • zowe ca7 commands demandh --job PAYROLL
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_hold.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_hold.html new file mode 100644 index 0000000000..5a60b17de3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_hold.html @@ -0,0 +1,145 @@ + + + + +ca7 commands hold + + +
+

zoweca7commandshold

+

This function is available on the QM.1 panel with a FILL value of H.
+Depending on the timing and whether you have any other
+predecessor situations, the QM.3 panel can sometimes accomplish this process.
+For more information on HOLD command, see the techdocs folder in this project.

+

Usage

+

zowe ca7 commands hold [options]

+

Options

+
    +
  • +

    -q (string)

    +
      +
    • example: RDY
      +Specifies to hold the contents of an entire queue.
      +Possible values:
      +REQ
      +Specifies to hold all jobs currently in the request queue.
      +RDY
      +Specifies to hold all jobs currently in the ready queue.
      +Required: Yes, unless job number is used.
    • +
    +
  • +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the individual job number to hold. Omit if Q is specified.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Holds the entire RDYQ:

    +
      +
    • zowe ca7 commands hold --q RDY
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_jclovrd.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_jclovrd.html new file mode 100644 index 0000000000..f5da8a426f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_jclovrd.html @@ -0,0 +1,163 @@ + + + + +ca7 commands jclovrd + + +
+

zoweca7commandsjclovrd

+

The JCLOVRD command establishes or satisfies JCL override requirements.

+

Usage

+

zowe ca7 commands jclovrd [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the CA 7 job number of the job in the request queue for which to establish or
      +remove the override requirement.
      +Limits: 1 to 4 numeric characters

      +
    • +
    +
  • +
  • +

    --set (string)

    +
      +
    • +

      example: ON
      +Specifies to establish or satisfy JCL override requirements.
      +When a job fails with a JCL error, the JCL override requirement is automatically
      +set to ON when the job returns to the request queue.

      +

      ON
      +Establishes a JCL override requirement for the specified job.
      +The SET=ON option is used for jobs in the request queue to indicate that
      +an override is needed before execution is to occur.
      +OFF
      +Satisfies a JCL override requirement for the specified job. The SET=OFF option indicates that a previously defined
      +need (requirement) for overrides has been satisfied and execution can be safely attempted.
      +When a JCL override requirement is set to OFF,
      +that requirement no longer appears on a requirements list for the job
      +When a REPL is done from the QM.5 panel, the JCL override requirement is automatically set to OFF.
      +WLM
      +Sets job to allow the insertion of SCHENV= keyword on the JOB
      +statement at submission time when these conditions are true:
      +The scheduling environment insertion feature is activated.
      +A scheduling Environment VRM definition is attached to the job (or SCHENV global default).
      +NOWLM
      +Sets job to suppress the insertion of a SCHENV= keyword on the JOB statement at submission
      +time even when one is typically associated with the job.
      +This option can be used when the validation of an associated IBM WLM scheduling environment
      +has failed causing the job to be requeued (see Browse message SSM0-42).
      +FSetting the NOWLM option lets you submit the job without SCHENV= keyword insertion.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Satisfies JCL override ca7 number 0016:

    +
      +
    • zowe ca7 commands jclovrd --ca7num 0016 --set ON
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_post.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_post.html new file mode 100644 index 0000000000..74289aa236 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_post.html @@ -0,0 +1,226 @@ + + + + +ca7 commands post + + +
+

zoweca7commandspost

+

The POST command indicates to the CA Workload Automation CA 7 Editionsystem that a preexecution requirement for a job in the request queue is satisfied

+

Usage

+

zowe ca7 commands post [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Indicates the job number in up to four digits, for which requirements are posted.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --usr (string)

    +
      +
    • +

      example: USER WILL CALL TO RELEASE
      +(Optional) Identifies a user-defined description of a requirement to post as satisfied.
      +Mutually exclusive with DEPJOB and DSN.
      +When used, must match the text that is used to define the requirement on the DB.6 panel or with the ADDRQ command.

      +

      Limits: 1 to 36 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --depjob (string)

    +
      +
    • +

      example: PAYJOB
      +(Optional) Identifies a predecessor job dependency requirement to post as satisfied.
      +Value must be a specific job name.
      +Mutually exclusive with DSN and USR.

      +

      In normal situations, CA WA CA 7 Edition automatically posts this type of requirement when the predecessor job completes its execution successfully.
      +A manual posting is only necessary if a job defined as a requirement was not to be run,
      +or ran unsuccessfully and a successor job is to be run.The DEPJOB must be posted if it is not currently defined to CA WA CA 7 Edition
      +(an external job).
      +Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --dsn (string)

    +
      +
    • +

      example: CA7.DSN1
      +(Optional) Identifies a data set requirement to post as satisfied.
      +Value can be a specific data set name or a CA WA CA 7 Edition data set number.
      +If you are using a number, only the number can be specified without the DS prefix.

      +

      Mutually exclusive with DEPJOB and USR.
      +dsname
      +Indicates a specific data set name.
      +Limits: 1 to 44 alphanumeric characters
      +dsnumber
      +Indicates a specific data set number.
      +Limits: 1 to 8 numeric characters

      +
    • +
    +
  • +
  • +

    --internal (string)

    +
      +
    • example: YES
      +(Optional) Valid only with DSN to indicate that the data set being posted is internal to the CA WA CA 7 Edition workload.
      +YES is the only acceptable value.
      +Mutually exclusive with USR, DEPJOB, and PREQ.
      +In normal situations, CA WA CA 7 Edition automatically posts requirements for internal data sets.
      +Limits: YES is the only acceptable value.
    • +
    +
  • +
  • +

    --preq (string)

    +
      +
    • example: (17,19,20,32)
      +(Optional) Valid only with DSN to identify up to 11 numeric values to include
      +with other CA WA CA 7 Edition log data logged as a result of the POST command being issued.
      +Mutually exclusive with USR, DEPJOB, and INTERNAL.
      +Code values in sublist form, within parentheses.
      +You can code up to 11 values that are separated by commas between the parentheses.
      +Each value cannot exceed 4 numeric digits.
      +This optional field can be useful for logging any meaningful numbers, such as batch numbers, which can later be reviewed in the log data set.
    • +
    +
  • +
  • +

    --rmtjob (string)

    +
      +
    • +

      example: RMT_JOB

      +

      Names the job in the remote scheduler that is required by the job specified in the JOB field.
      +Limits: RMTJOB should accept up to 64 characters
      +valid characters are a-z, A-Z, 0-9, period (.), underscore (_), hyphen (-),
      +colon (:), and pound (#); do not include embedded spaces or tabs.

      +
    • +
    +
  • +
  • +

    --rmtschd (string)

    +
      +
    • +

      example: AP1

      +

      Names the remote scheduler where the predecessor job runs.
      +Before adding this requirement, the remote scheduler must be defined.
      +The remote scheduler defined as type LOCAL cannot be specified.
      +Limits: 1 to 3 alphanumeric characters; generic specification not supported.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    The requirement for ca7 number 0016 in the request queue is satisfied:

    +
      +
    • zowe ca7 commands post --ca7num 0016
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_prscf.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_prscf.html new file mode 100644 index 0000000000..aeda8d7658 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_prscf.html @@ -0,0 +1,156 @@ + + + + +ca7 commands prscf + + +
+

zoweca7commandsprscf

+

The PRSCF command frees a shared, exclusive, or RCT resource that is connected to a job

+

Usage

+

zowe ca7 commands prscf [options]

+

Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      example: 1234

      +

      Specifies the CA Workload Automation CA 7 Edition job name or number to which the resource is attached.
      +jobnumber
      +Indicates a specific CA 7 job number.
      +Limits: 1 to 4 numeric characters

      +
    • +
    +
  • +
  • +

    --rsrc (string)

    +
      +
    • +

      example: RESOURCE.TYPE2.EXEC

      +

      Specifies the fully qualified resource name to free.
      +You can optionally specify * to indicate to free all resources that are connected to the job.
      +Limits: 1 to 44 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --force (string)

    +
      +
    • +

      example: YES

      +

      (Optional) FORCE=YES indicates that CA WA CA 7 Edition is not to evaluate

      +

      the availability of the named resources for this run of the job only.
      +This run of the job does not use the named resources.
      +This keyword can be used on an exception basis to let a job in a
      +W-RSRC status bypass VRM checking for one or more resources defined for it on the RM.1 panel.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Frees a shared resource name, ZOWECRM1 that attached to the job 1234:

    +
      +
    • zowe ca7 commands prscf --job 1234 --rsrc ZOWECRM1
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_prsqa.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_prsqa.html new file mode 100644 index 0000000000..8de46111ee --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_prsqa.html @@ -0,0 +1,141 @@ + + + + +ca7 commands prsqa + + +
+

zoweca7commandsprsqa

+

The PRSQA command activates a corequisite resource

+

Usage

+

zowe ca7 commands prsqa [options]

+

Options

+
    +
  • +

    --rsrc (string)

    +
      +
    • +

      example: CICSREG8

      +

      Specifies a fully qualified corequisite resource name.
      +Limits: 1 to 44 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --internal (string)

    +
      +
    • +

      example: YES

      +

      (Optional) If YES or Y is specified, the command is not forwarded to other CA 7 instances

      +

      even if VRM Corequisite Propagation is enabled and the resource name matches the selection criteria.

      +

      Default: NO

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Activates a corequisite resource name CICSREG8:

    +
      +
    • zowe ca7 commands prsqa --rsrc CICSREG8
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_release.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_release.html new file mode 100644 index 0000000000..50a76af984 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_release.html @@ -0,0 +1,143 @@ + + + + +ca7 commands release + + +
+

zoweca7commandsrelease

+

Release a single job to CA 7.

+

Usage

+

zowe ca7 commands release [options]

+

Options

+
    +
  • +

    -q (string)

    +
      +
    • +

      Q={REQ|RDY}

      +

      Indicates to release the contents of an entire queue. Omit Q when JOB or JOBL is specified.

      +

      REQ
      +Release the contents of the request queue.

      +

      RDY
      +Release the contents of the ready queue.

      +
    • +
    +
  • +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the name of the job number to release.
      +Indicates the individual job to release. JOB is required to release a specific job. Omit JOB when JOBL or Q is specified.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Release ca7 number 0016 from CA 7:

    +
      +
    • zowe ca7 commands release --ca7num 0016
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_requeue.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_requeue.html new file mode 100644 index 0000000000..b9136129e8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_requeue.html @@ -0,0 +1,245 @@ + + + + +ca7 commands requeue + + +
+

zoweca7commandsrequeue

+

Re-queues jobs from the ready or active queues back to the request queue.

+

Usage

+

zowe ca7 commands requeue [options]

+

Options

+
    +
  • +

    --agent (string)

    +
      +
    • +

      example: UXAGENT
      +(Optional) Indicates the agent name or mask that an agent name must match for an agent job

      +

      before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
      +AGENT cannot be used with CPU, MAINID, or NODE.
      +For any agent job that is requeued, a cancel request is sent to the agent running the job.
      +The status of the agent or the computer on which the agent is running determines whether the request is honored.
      +Limits: 1 to 16 alphanumeric charactersDefault: * (all agent names)

      +
    • +
    +
  • +
  • +

    --cpu (string)

    +
      +
    • example: 34
      +(Optional) Used with JOB to specify the CPU ID of active queue jobs that are to be requeued.
      +The value identifies the CPU and corresponds to the CPU field displayed on the LQ command (the SMF identifier).
      +CPU cannot be used with MAINID, NODE, or AGENT.
      +The CPU parameter is ignored if used with a JOB parameter that references a specific job name or job number, but not if a job mask is specified.
      +Limits:
      +1 to 4 numeric characters
    • +
    +
  • +
  • +

    --force (string)

    +
      +
    • example: CMP
      +(Optional) Resumes job completion for stranded jobs.
      +When a job finishes executing, it must move to the request queue so that CA WA CA 7 Edition
      +can process the database and queue updates that are required for job completion.
      +But, if a job cannot be moved because of an I/O error or an out-of-space condition on the request queue,
      +the job may be stranded in the ready or active queue, unable to complete
      +Once the request queue error is corrected, you can use REQUEUE with FORCE=CMP to resume job completion for these jobs.
      +Limits: CMP is the only value
    • +
    +
  • +
  • +

    --ca7num (string)

    +
      +
    • example: 0029
      +(Optional) Indicates the job number
      +must match before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
      +If JOB is used alone, both the active and ready queues are searched for the specified job number.
      +If JOB is used with Q, the search is restricted to the indicated queue. jobname,jobnumber and longjobname are mutually exclusive
      +Default:
      +* (all jobs)Limits:
      +1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --jobname | --jn (string)

    +
      +
    • example: PAYROLL
      +(Optional) Indicates the job name, or mask that a job name
      +must match before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
      +If JOB is used alone, both the active and ready queues are searched for the specified job.
      +If JOB is used with Q, the search is restricted to the indicated queue. jobname,jobnumber and longjobname are mutually exclusive.
      +Default:
      +* (all jobs)Limits:
      +1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --longjobname | --ljn (string)

    +
      +
    • example: ALONGJOBNAME
      +(Optional) Indicates the long job name or mask that a long job name must match before
      +it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
      +If JOBL is used alone, both the active and ready queues are searched for the specified long job name.
      +If JOBL is used with Q, the search is restricted to the indicated queue.jobname,jobnumber and longjobname are mutually exclusive
      +Limits: 1 to 64 alphanumeric characters
    • +
    +
  • +
  • +

    --mainid (string)

    +
      +
    • example: ALL|SY2|/SY3
      +(Optional) Used with JOB to indicate that only those jobs in the ready queue with this MAINID are to be requeued.
      +Value must be specified as a single MAINID name.
      +MAINID cannot be used with CPU, NODE, or AGENT.
      +The MAINID parameter is ignored if used with a JOB parameter that references a specific job name or job number, but not if a job mask is specifie_
      +The name must be one of the following values:
      +ALL Indicates that all MAINIDs are considered.
      +SYn Where n indicates a CPU assigned number as defined in the initialization file CPU statement.
      +The value of n can range from 1 to 7.
      +/SYn
      +Where n indicates a CPU assigned number. The / indicates “not this MAINID.
      +The value of n can range from 1 to 7.
      +Limits: 1 to 4 alphanumeric characters
    • +
    +
  • +
  • +

    --node (string)

    +
      +
    • example: NODEXP
      +(Optional) Indicates the node name or mask that a node name must match for an XPJOB job,
      +before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
      +NODE cannot be used with CPU, MAINID, or AGENT.
      +For any XPJOB that is requeued, a cancel request is sent to the node where the job is running
      +(assuming the initialization file XPDEF statement parameter XPKILL=NO is not set).
      +The status of the node or the computer that the node points to, determines whether the request is honored.
      +Limits:
      +1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    -q (string)

    +
      +
    • +

      q=RDY

      +

      Used with JOB to indicate in which queue the job search is to occur
      +ACT The active queue. RDY The ready queue.

      +
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • (Optional) Flags the job after it returns to the request queue with a status of JCLERR instead of REQUE.
      +If not coded, the status reflects REQUE.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Requeues jobs in the ready queue back to the request queue:

    +
      +
    • zowe ca7 commands requeue --q RDY
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_resolv.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_resolv.html new file mode 100644 index 0000000000..166e3f2898 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_resolv.html @@ -0,0 +1,210 @@ + + + + +ca7 commands resolv + + +
+

zoweca7commandsresolv

+

Work that is scheduled by a trigger or on-request work that is DEMANDed or RUN has no direct relationship to a base calendar and therefore does not require the use of this function.

+

Usage

+

zowe ca7 commands resolv [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      example: AJOB*

      +

      Limits selection for resolution to the jobs specified. If omitted, all job schedules are candidates for resolution. Value can be a specific job name or a generic name that identifies multiple jobs beginning with the specified characters.
      +An asterisk (*) must be used to delimit the generic job name. The asterisk can appear in any of the eight positions but must immediately follow the last significant character of the job name requested.
      +For example:
      +AB* causes all jobs beginning with AB to be selected for resolution.
      +* causes all job schedules to be selected for resolution.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --duplicateDate | --ddate (string)

    +
      +
    • +

      example: NO

      +

      Indicates whether to produce specific duplicate day messages (SRC1-137) each time that two or more schedule IDs for the same job schedule a given day.
      +The default is NO unless the extended resolve message option is set in the user profile by the /PROF command.

      +
    • +
    +
  • +
  • +

    --oldYear | --oyr (string)

    +
      +
    • +

      example: 22

      +

      Specifies the year that is defined in the schedule member data (the value that is supplied by YEAR in the previous resolution that updated the schedule member).
      +Only those candidate schedule members whose year data matches the OLDYR value are selected for resolution.
      +If used, use one of the following values:
      +empty: It is default, if omitted, only those schedule members that have not previously been resolved or whose schedules have expired are selected.
      +yy: Indicates a specific year.
      +*: Indicates all years and all schedules.

      +
    • +
    +
  • +
  • +

    --print (string)

    +
      +
    • +

      example: YES

      +

      Specifies whether to display a month-by-month schedule day calendar after resolution of the defined member is complete.
      +If used, value must be YES or NO (default).

      +
    • +
    +
  • +
  • +

    --scal (string)

    +
      +
    • +

      example: 22

      +

      Value is the xx portion of the base calendar name, SCALyyxx.
      +The SCAL value must also match the base calendar identifier (SCAL) specified in any SCHID of the schedule definition for the individual jobs.
      +This value is used during the selection process of resolution to determine which schedule members to resolve.
      +Required: No (unless JOB is omitted)
      +*: Indicates all SCALs.
      +xx: Indicates a specific SCAL.

      +
    • +
    +
  • +
  • +

    --test (string)

    +
      +
    • +

      example: NO

      +

      Indicates whether schedule members are updated because of the resolution process. YES and NO are the only allowable values.
      +YES: Normal resolution occurs and all messages are printed, but no updating of the database occurs.This option can be used at a year-end or whenever a base calendar is changed to see the results of the resolution activity, without actually changing the schedule mask or affecting the current schedule process. YES is the default.
      +NO: Normal resolution occurs and all messages are printed, and updating of the database occurs.

      +
    • +
    +
  • +
  • +

    --year (string)

    +
      +
    • +

      example: 20

      +

      Identifies the year of the base calendars against which the schedule is resolved. The value is the number that is the yy portion of the base calendar name, SCALyyxx.
      +When a schedule is successfully updated, the YEAR value becomes part of the schedule data (see OLDYR). If the YEAR parameter is not specified, the current year is assumed to be the year from the system internal date and time.
      +Also, if YEAR is not coded on the RESOLV, a determination is made to see whether the RESOLV is made within the period January 1 through June 30 as determined from system date and time.
      +If so, the schedule is resolved against January through December of the current year. If a RESOLV is done within the period July 1 through December 31, the schedule is resolved against July 1 through December 31 of the current year and January 1 through June 30 of the next year.
      +This behavior requires the existence of base calendars for calendar years involved. If a required base calendar is not available, an error message is issued. The schedule member is unresolved, unless a perpetual calendar is defined for this SCALyyXX. In that case, the calendar is generated from the PCALYYXX member in the perpetual calendar data set. YEAR is optional. If YEAR is specified, the resolution is made against January through December of the year specified.
      +Default: Current year
      +Limits: 2 numeric characters

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates or modifies processing schedules for jobs, AJOB from CA 7:

    +
      +
    • zowe ca7 commands resolv --job AJOB
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_restart.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_restart.html new file mode 100644 index 0000000000..bc8bff223c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_restart.html @@ -0,0 +1,333 @@ + + + + +ca7 commands restart + + +
+

zoweca7commandsrestart

+

Restart a single job to CA 7.

+

Usage

+

zowe ca7 commands restart [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the name of the job to Restart.
      +Indicates the individual job to Restart, and the value must be a CA 7 job number.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --bypgdg | --bp (string)

    +
      +
    • +

      bypgdg={NO|YES|VER|CAT}

      +

      Indicates whether CA Workload Automation Restart Option for z/OS Schedulers bypasses GDG logic on a restart/rerun.
      +Value can be NO, YES, VER, or CAT.

      +

      Default: CA Workload Automation Restart Option for z/OS Schedulers default value

      +
    • +
    +
  • +
  • +

    --condcd | --cc (string)

    +
      +
    • +

      condcd=nnnn

      +

      Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers condition code
      +that the CA Workload Automation Restart Option for z/OS Schedulers step sets when the rerun is executed.

      +

      This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use
      +and CA Workload Automation CA 7® Edition is inserting the RMS step.
      +See the INSERT-RMS field on the DB.1 panel.

      +

      Limits: 1 to 4 numeric characters from 0 to 4095

      +
    • +
    +
  • +
  • +

    --forcecomp | --fc (string)

    +
      +
    • +

      forcecomp={NO|YES}

      +

      Indicates whether to flag the job as a normal completion.
      +If FORCECOMP=YES, the previous abnormal status of the job is ignored.

      +

      Normal job completion processing is performed instead of a restart.
      +Value can be NO or YES. NO is the default.

      +
    • +
    +
  • +
  • +

    --lcc (string)

    +
      +
    • +

      lc=nnnn

      +

      Indicates an optional condition code value that replaces the last
      +condition code value for the step that the LSTP references and, optionally, LPSTP keywords.

      +

      This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.

      +

      Default: 0
      +Limits: 1 to 4 numeric characters from 0 to 4095

      +
    • +
    +
  • +
  • +

    --lstp (string)

    +
      +
    • +

      lstp=JS050

      +

      Indicates an optional step name that has its last condition code value reset in the
      +CA Workload Automation Restart Option for z/OS Schedulers CMT.

      +

      Code LSTP and LCC when LPSTP is specified.
      +LSTP requires that an STPSTRT value is specified and that the LSTP step name occurs in the JCL of the job before the STPSTRT step name.

      +

      This option is honored only when CA Workload Automation Restart Option for z/OS Schedulers is in use.

      +

      Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --lpstp (string)

    +
      +
    • +

      lpstp=COPY010

      +

      Indicates an optional step name referencing a procedure that has its last condition code value reset
      +in the CA Workload Automation Restart Option for z/OS Schedulers CMT.

      +

      If LPSTP is used, also code LSTP and LCC.
      +This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.

      +

      Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --procstrt | --ps (string)

    +
      +
    • +

      procstrt=procname

      +

      Indicates an optional step name referencing a procedure where processing is to start.
      +If PROCESS=R and PROCSTRT are used, also code STPSTRT.

      +

      This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.

      +

      Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --procend | --pe (string)

    +
      +
    • +

      procend=procname

      +

      Indicates an optional step name referencing a procedure where processing is to end.

      +

      If PROCESS=R and PROCEND are used, code STPEND.
      +This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.

      +

      Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --process (string)

    +
      +
    • +

      process=code

      +

      Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers processing function code character to use in the restart/rerun.

      +

      This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use
      +and CA WA CA 7 Edition is inserting the RMS step.

      +

      See the INSERT-RMS field on the DB.1 panel. Value can be F, P, S, N, O, or R.

      +

      Default: P
      +Limits: 1 alphabetic character

      +
    • +
    +
  • +
  • +

    --reason | -r (string)

    +
      +
    • +

      reason=text

      +

      Specifies a reason for the restart.
      +If the CA Workload Automation Restart Option for z/OS Schedulers Reason-for-Rerun module is available,
      +a code of up to four characters can be input and it is expanded.

      +

      Any reason input or expanded is copied to the run log.

      +

      This field is optional unless CA Workload Automation Restart Option for z/OS Schedulers requires a reason or
      +REASON=YES was specified in the RESTART statement in the initialization file.

      +

      Limits: 1 to 40 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --stpend | --se (string)

    +
      +
    • +

      stpend=stepname

      +

      Indicates an optional step name or number at which processing is to end.
      +If not specified, the last step of the job is assumed to be the ending step.

      +

      Code STPEND when PROCEND is specified.
      +This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.

      +

      Limits: 1 to 8 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --stpstrt | --ss (string)

    +
      +
    • +

      stpstrt={stepname|*CMT*|*RERUN*|*RESUBP*}

      +

      Indicates an optional step name or number at which processing is to start.
      +If STPSTRT is not coded, the first step of the job is assigned to be the starting step.

      +

      Code STPSTRT when PROCSTRT is specified. This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
      +It can be one of

      +

      stepname
      +Specifies the step name or number at which processing is to start.

      +

      *CMT*
      +Indicates that the job is to restart with the step values currently on the CMT record.

      +

      *RERUN*
      +Indicates to rerun t the total job. If there are no restartable steps, specify RERUN.

      +

      *RESUBP*
      +Indicates that the CMT record of the job is set to production, and then the job is submitted.

      +
    • +
    +
  • +
  • +

    --sup11stp | --su (string)

    +
      +
    • +

      sup11stp={NO|YES}

      +

      Indicates whether to suppress the insertion of the CA Workload Automation Restart Option for z/OS Schedulers RMS step.

      +

      If the job is resubmitted with SUP11STP=YES, the CA Workload Automation Restart Option for z/OS Schedulers step is not inserted.

      +

      Only valid if CA WA CA 7 Edition is inserting the CA Workload Automation Restart Option for z/OS Schedulers step.

      +

      See the INSERT-RMS field on the DB.1 panel.
      +Value can be NO or YES. NO is the default.

      +
    • +
    +
  • +
  • +

    --usage (string)

    +
      +
    • +

      usage=code

      +

      Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers
      +usage code of the character to use in the restart/rerun.

      +

      For the values, see the CA Workload Automation Restart Option for z/OS Schedulers documentation.

      +

      This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use and
      +CA WA CA 7 Edition is inserting the RMS step.

      +

      See the INSERT-RMS field on the DB.1 panel.
      +Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --ca11rstp | -c (string)

    +
      +
    • +

      ca11rstp={Y|YES}

      +

      Displays the CA11 restart step. Value can be Y or YES.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Restart ca7 number, 0016 from CA 7:

    +
      +
    • zowe ca7 commands restart --ca7num 0016
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_rmtsub.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_rmtsub.html new file mode 100644 index 0000000000..444dad4a29 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_rmtsub.html @@ -0,0 +1,145 @@ + + + + +ca7 commands rmtsub + + +
+

zoweca7commandsrmtsub

+

The RMTSUB command is used by a scheduling product that has a remote job dependency on a CA 7 job.

+

Usage

+

zowe ca7 commands rmtsub [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      job=0123

      +

      Specifies the CA Workload Automation CA 7 Edition job name or number to which the resource is attached.
      +1-4 numeric characters, specifies the CA7 job number

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --rmtschd (string)

    +
      +
    • +

      example: AP1

      +

      Names the remote scheduler where the predecessor job runs.
      +Before adding this requirement, the remote scheduler must be defined.
      +The remote scheduler defined as type LOCAL cannot be specified.
      +Limits: 1 to 3 alphanumeric characters; generic specification not supported.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Rmtsub job, 0123 to CA 7:

    +
      +
    • zowe ca7 commands rmtsub --job 0123
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_rmttrk.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_rmttrk.html new file mode 100644 index 0000000000..22a1692175 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_rmttrk.html @@ -0,0 +1,166 @@ + + + + +ca7 commands rmttrk + + +
+

zoweca7commandsrmttrk

+

The RMTTRK defines a dependency on a job in a remote CA 7 workload.

+

Usage

+

zowe ca7 commands rmttrk [options]

+

Required Options

+
    +
  • +

    --remote-sched | --rs (string)

    +
      +
    • +

      remote-sched=AS1

      +

      The name of publishing scheduler that issues this RMTTRK command.
      +Must be defined to receiving CA7ONL using XN.7.
      +This name is provided to the remote scheduler at subscription time.
      +Limists: 1-4 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --job-name | --jn (string)

    +
      +
    • +

      job-name=PAYJOB

      +

      The name of job running in the publishing scheduler that invokes this command.
      +Limits: Autosys job names can be up to 64 characters.Valid characters are a-z, A-Z, 0-9, period (.),underscore (_), hyphen (-), colon (:), and pound (#).Do not include embedded spaces or tabs.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --status (string)

    +
      +
    • +

      status=FAILURE

      +

      The status of job named on job-name.
      +The analogue of this service in AutoSys is change-status-job which supports these values:
      +FAILURE, INACTIVE, RUNNING, STARTING, SUCCESS, TERMINATED

      +
    • +
    +
  • +
  • +

    --date-time-status-changed | --dtsc (string)

    +
      +
    • +

      date-time-status-changed=2021-08-12T10:12:13.680000-04:00

      +

      Date/time remote scheduler detected status change reported by the STATUS keyword.
      +Limits: ISO8601 character format.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Rmttrk job name JOB123 to CA 7:

    +
      +
    • zowe ca7 commands rmttrk --jn JOB123
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_run.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_run.html new file mode 100644 index 0000000000..9c0a5cf0ed --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_run.html @@ -0,0 +1,301 @@ + + + + +ca7 commands run + + +
+

zoweca7commandsrun

+

Run a single job to CA 7.

+

Usage

+

zowe ca7 commands run [options]

+

Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      job=PAYROLL

      +

      Defines the long name of the job to run.
      +The ran jobs are placed in the request queue and assigned a unique CA 7 job number.

      +
    • +
    +
  • +
  • +

    --jobl (string)

    +
      +
    • +

      job=payrollSW123

      +

      Identifies the job to submit.
      +The value must be a long job name.
      +If the job has not been defined in the database, use JOB instead.
      +See also JCLID. JOB and JOBL are mutually exclusive.
      +Limits:
      +1 to 64 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --arfset | --as (string)

    +
      +
    • +

      arfset={arfsetname|**NONE**}

      +

      Defines the ARF set name that is used for this run of the job.
      +If you specify **NONE**, no ARF processing is performed for this run of the job.

      +

      Limits: 1 to 8 alphanumeric characters or **NONE**

      +
    • +
    +
  • +
  • +

    --class (string)

    +
      +
    • +

      class=n

      +

      Defines the workload balancing class for resource checking.

      +

      Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --dotm (string)

    +
      +
    • +

      dotm=hhmm

      +

      Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
      +If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.

      +

      If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.

      +

      Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59

      +

      Required: No (unless DATE is used, if so, DOTM or TIME must be specified)

      +
    • +
    +
  • +
  • +

    --exec | -e (string)

    +
      +
    • +

      exec={NO|YES}

      +

      Specifies whether to execute the job (YES/NO).
      +If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.

      +

      Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.

      +
    • +
    +
  • +
  • +

    --jclid | --ji (string)

    +
      +
    • +

      jclid=10

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.

      +
    • +
    +
  • +
  • +

    --jcllib | --jl (string)

    +
      +
    • +

      jcllib=&SPECIAL

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)

      +
    • +
    +
  • +
  • +

    --late (string)

    +
      +
    • +

      late={NO|YES}

      +

      Specifies whether a notification occurs when the job becomes late.
      +Specify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.

      +
    • +
    +
  • +
  • +

    --leadtm | --lt (string)

    +
      +
    • +

      leadtm={0100|hhmm}

      +

      Specifies the lead (processing) time that is required for the job to run.
      +If omitted, 1 hour is usedFormat: hhmm
      +Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59You can omit leading zeros.

      +
    • +
    +
  • +
  • +

    --mainid | --mi (string)

    +
      +
    • +

      mainid={ALL|SYn|/SYn|-SYn}

      +

      Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
      +The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:

      +

      ALL
      +Specifies all CPUs are acceptable for executing the job.

      +

      SYn
      +n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.

      +

      /SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      -SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --rms (string)

    +
      +
    • +

      rms={NO|YES}

      +

      Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.

      +

      Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.

      +

      The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
      +Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
      +Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --schid | --si (string)

    +
      +
    • +

      schid={1|nnn}

      +

      Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.

      +

      Default: 1
      +Limits: 1 to 3 numeric characters from 1 to 999 (See Note)

      +

      No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)

      +
    • +
    +
  • +
  • +

    --time (string)

    +
      +
    • +

      time={hhmm|+hhmm}

      +

      Establishes a submit time-of-day requirement for the job.

      +

      Format: hhmm
      +Defines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).
      +Leading zeros are not required

      +
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • +

      type={CLOCK|END|RES|START}

      +

      Indicates that the job is being scheduled for rerun.
      +The value must be specified as shown.

      +

      TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Run a job, PAYROLL to CA 7:

    +
      +
    • zowe ca7 commands run --job PAYROLL
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_runh.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_runh.html new file mode 100644 index 0000000000..48a2032d66 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_runh.html @@ -0,0 +1,301 @@ + + + + +ca7 commands runh + + +
+

zoweca7commandsrunh

+

Run and hold a single job to CA 7.

+

Usage

+

zowe ca7 commands runh [options]

+

Options

+
    +
  • +

    --job (string)

    +
      +
    • +

      job=PAYROLL

      +

      Defines the long name of the job to run.
      +The ran jobs are placed in the request queue and assigned a unique CA 7 job number.

      +
    • +
    +
  • +
  • +

    --jobl (string)

    +
      +
    • +

      job=payrollSW123

      +

      Identifies the job to submit.
      +The value must be a long job name.
      +If the job has not been defined in the database, use JOB instead.
      +See also JCLID. JOB and JOBL are mutually exclusive.
      +Limits:
      +1 to 64 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --arfset | --as (string)

    +
      +
    • +

      arfset={arfsetname|**NONE**}

      +

      Defines the ARF set name that is used for this run of the job.
      +If you specify **NONE**, no ARF processing is performed for this run of the job.

      +

      Limits: 1 to 8 alphanumeric characters or **NONE**

      +
    • +
    +
  • +
  • +

    --class (string)

    +
      +
    • +

      class=n

      +

      Defines the workload balancing class for resource checking.

      +

      Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --dotm (string)

    +
      +
    • +

      dotm=hhmm

      +

      Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
      +If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.

      +

      If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.

      +

      Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59

      +

      Required: No (unless DATE is used, if so, DOTM or TIME must be specified)

      +
    • +
    +
  • +
  • +

    --exec | -e (string)

    +
      +
    • +

      exec={NO|YES}

      +

      Specifies whether to execute the job (YES/NO).
      +If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.

      +

      Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.

      +
    • +
    +
  • +
  • +

    --jclid | --ji (string)

    +
      +
    • +

      jclid=10

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.

      +
    • +
    +
  • +
  • +

    --jcllib | --jl (string)

    +
      +
    • +

      jcllib=&SPECIAL

      +

      Defines the JCL data set that contains the execution JCL to be submitted.

      +

      If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).

      +

      If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)

      +
    • +
    +
  • +
  • +

    --late (string)

    +
      +
    • +

      late={NO|YES}

      +

      Specifies whether a notification occurs when the job becomes late.
      +Specify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.

      +
    • +
    +
  • +
  • +

    --leadtm | --lt (string)

    +
      +
    • +

      leadtm={0100|hhmm}

      +

      Specifies the lead (processing) time that is required for the job to run.
      +If omitted, 1 hour is usedFormat: hhmm
      +Limits: hh= 2 numeric characters from 0 to 24
      +mm= 2 numeric characters from 00 to 59You can omit leading zeros.

      +
    • +
    +
  • +
  • +

    --mainid | --mi (string)

    +
      +
    • +

      mainid={ALL|SYn|/SYn|-SYn}

      +

      Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
      +The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:

      +

      ALL
      +Specifies all CPUs are acceptable for executing the job.

      +

      SYn
      +n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.

      +

      /SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      -SYn
      +n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

      +

      Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --rms (string)

    +
      +
    • +

      rms={NO|YES}

      +

      Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.

      +

      Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.

      +

      The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
      +Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
      +Limits: Invalid for internal cross-platform jobs.

      +
    • +
    +
  • +
  • +

    --schid | --si (string)

    +
      +
    • +

      schid={1|nnn}

      +

      Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.

      +

      Default: 1
      +Limits: 1 to 3 numeric characters from 1 to 999 (See Note)

      +

      No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)

      +
    • +
    +
  • +
  • +

    --time (string)

    +
      +
    • +

      time={hhmm|+hhmm}

      +

      Establishes a submit time-of-day requirement for the job.

      +

      Format: hhmm
      +Defines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).
      +Leading zeros are not required

      +
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • +

      type={CLOCK|END|RES|START}

      +

      Indicates that the job is being scheduled for rerun.
      +The value must be specified as shown.

      +

      TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Run and holds a job, PAYROLL to CA 7:

    +
      +
    • zowe ca7 commands runh --job PAYROLL
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_submit.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_submit.html new file mode 100644 index 0000000000..fc07a4a7ad --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_submit.html @@ -0,0 +1,145 @@ + + + + +ca7 commands submit + + +
+

zoweca7commandssubmit

+

The SUBMIT top line command modifies and expedites the process of job submission for jobs already residing in the queues

+

Usage

+

zowe ca7 commands submit [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Defines the name of the job to Submit.
      +Indicates the individual job to Submit, and the value must be a CA 7 job number.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --express | --ex (string)

    +
      +
    • +

      example: YES

      +

      (Optional) Indicates to place the job ahead of all other jobs (those jobs without EXPRESS=YES) for submission.

      +

      The value must be coded as shown. Not valid if workload balancing is being used.

      +

      Use of EXPRESS=YES does not establish an increased execution priority for a job.

      +

      Rather, it ensures that nonexpress jobs are not submitted ahead of a job that is flagged as an express job.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit ca7 number, 0016 to CA 7:

    +
      +
    • zowe ca7 commands submit --ca7num 0016
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_subtm.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_subtm.html new file mode 100644 index 0000000000..be4dd487c0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_subtm.html @@ -0,0 +1,147 @@ + + + + +ca7 commands subtm + + +
+

zoweca7commandssubtm

+

SUBTM modifies the required submit time-of-day for a job in the request queue

+

Usage

+

zowe ca7 commands subtm [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Specifies the CA 7 job number of the job or which you want to add, modify, or remove a submit time-of-day requirement.

      +

      Limits: 1 to 4 alphanumeric characters

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --time | --tm (string)

    +
      +
    • +

      example: 1830

      +

      (Optional) Specifies the new submit time-of-day in hours and minutes.

      +

      TIME is required to add a submit time-of-day requirement when none exists or to change an existing requirement.

      +

      If TIME is omitted, an existing submit time-of-day restriction is removed. Format:hhmm

      +

      Defines the time-of-day where hh is hours (0 through 24) and

      +

      mm is minutes (00 through 59). Maximum is 2400.

      +

      If the value given is less than the current time (when the command is processed), the submit day is incremented by one.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Modifies the required submit time for a ca7 number, 0016:

    +
      +
    • zowe ca7 commands subtm --ca7num 0016
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_commands_verify.html b/static/v2.15.x/web_help/docs/zowe_ca7_commands_verify.html new file mode 100644 index 0000000000..f3801e84ae --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_commands_verify.html @@ -0,0 +1,144 @@ + + + + +ca7 commands verify + + +
+

zoweca7commandsverify

+

The VERIFY command establishes or satisfies a manual verification requirement for a currently scheduled run of the job in the request queue before its execution.

+

Usage

+

zowe ca7 commands verify [options]

+

Required Options

+
    +
  • +

    --ca7num (string)

    +
      +
    • +

      ca7num=0016

      +

      Specifies the CA 7 job number of the job or which you want to add, modify, or remove a submit time-of-day requirement.

      +

      Limits: 1 to 4 alphanumeric characters

      +
    • +
    +
  • +
  • +

    --set (string)

    +
      +
    • +

      example: ON

      +

      Sets the verification requirement.

      +

      ON

      +

      Establishes a manual verification requirement that did not previously exist.

      +

      OFF

      +

      Indicates that a previously established manual verification requirement is satisfied and can be

      +

      removed. A verification requirement no longer appears on the requirements list in the request queue.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Specifies a verification requirement for ca7 number, 0016:

    +
      +
    • zowe ca7 commands verify --ca7num 0016
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_create-job-definition.html b/static/v2.15.x/web_help/docs/zowe_ca7_create-job-definition.html new file mode 100644 index 0000000000..cdddb5ded5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_create-job-definition.html @@ -0,0 +1,21 @@ + + + + +ca7 create-job-definition + + +
+

zoweca7create-job-definition

+

All the available commands are listed in the COMMANDS section.

+

Usage

+

zowe ca7 create-job-definition <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_create-job-definition_req-predecessor.html b/static/v2.15.x/web_help/docs/zowe_ca7_create-job-definition_req-predecessor.html new file mode 100644 index 0000000000..32fcb5934c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_create-job-definition_req-predecessor.html @@ -0,0 +1,172 @@ + + + + +ca7 create-job-definition req-predecessor + + +
+

zoweca7create-job-definitionreq-predecessor

+

Creates predecessor requirement for a job.

+

Usage

+

zowe ca7 create-job-definition req-predecessor [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job that requires the predecessor
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • The schedule id of requiring job
    • +
    +
  • +
  • +

    --predtype (string)

    +
      +
    • The predecessor type
    • +
    +
  • +
  • +

    --nextrun (string)

    +
      +
    • The status of predecessor for next run of job
      +[ YES, ONLY, SKIP ]
    • +
    +
  • +
  • +

    --predobject (string)

    +
      +
    • The predecessor. Values vary with predtype.
      +The predecessor. Values vary with predtype.
      +When “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.
      +When “predtype”:”USER” then “predobject” is 1-44 character user requirement text.
    • +
    +
  • +
+

Options

+
    +
  • +

    --leadtime (string)

    +
      +
    • The satisfaction lead time in hours.
      +This may be honored when “predtype” is “job or “DSN”
    • +
    +
  • +
  • +

    --permanent (string)

    +
      +
    • Indicates that this predecessor is permanent, that is always considered satisfied.
      +This parameter only applies when “predtype” is “DSN”
      +[ Y, N ]
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create requirement predecessor for job TESJOB1 with the parameters:

    +
      +
    • zowe ca7 create-job-definition req-predecessor --job TESJOB1 --schid 0009 --predtype USER --nextrun ONLY --predobject CA7USER
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_create-job-definition_schedule.html b/static/v2.15.x/web_help/docs/zowe_ca7_create-job-definition_schedule.html new file mode 100644 index 0000000000..091bdd4c9c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_create-job-definition_schedule.html @@ -0,0 +1,375 @@ + + + + +ca7 create-job-definition schedule + + +
+

zoweca7create-job-definitionschedule

+

Create schedule parameters

+

Usage

+

zowe ca7 create-job-definition schedule [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • Specifies the numeric schedule ID on which the user wants to perform the specified action.
      +Limits: 1 to 3 numeric characters from 1 through 999
    • +
    +
  • +
+

Options

+
    +
  • +

    --scal (string)

    +
      +
    • Specifies the override of the default SCAL for this SCHID. Specify scal if you want to override the default scal.
      +Limits: 2 alphanumeric characters
    • +
    +
  • +
  • +

    --default-scal | --dscal (string)

    +
      +
    • Specifies the default SCAL for this job. If this is not specified, an LJOB will be issued to fetch the SCAL
      +Limits: 2 alphanumeric characters
    • +
    +
  • +
  • +

    --due-out-time | --dot (string)

    +
      +
    • Specifies the due-out time of day for this schedule ID.
      +Limits: 4 numeric characters that are specified as hhmm
      +where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
    • +
    +
  • +
  • +

    --lead-time | --lt (string)

    +
      +
    • Specifies the due-out time of day for this schedule ID.
      +Limits: 4 numeric characters that are specified as hhmm
      +where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
    • +
    +
  • +
  • +

    --submit-time | --st (string)

    +
      +
    • Specifies the submit time of day for this schedule ID.
      +If specified, the job is not submitted before this time.
      +If the submit time is before deadline start time,
      +the submit time requirement is automatically satisfied when the job enters the queue.
      +A submit time of zeros is the same as not specifying it, and no submit time is set up.
      +Note:If the submit time is after the due-out time, the submit day value is set to the previous day.
      +Limits: 4 numeric characters that are specified as hhmm
      +where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
    • +
    +
  • +
  • +

    --daily (string)

    +
      +
    • Specifies that the user wants to define a daily schedule.
      +Daily means every available processing day as defined by the Base Calendar.
      +If DAILY is used, the ROLL has no effect.
      +Limits: One of Y or N
    • +
    +
  • +
  • +

    --roll (string)

    +
      +
    • Specifies the action to take when a schedule day falls on a base calendar non available processing day.
      +This value is not used if the DAILY option is used
      +If DAILY is used, the ROLL has no effect.
      +If used, the value must be one of the following values:
      +B: Roll the schedule back to the previous available processing day in the Base Calendar.
      +F: Roll forward the schedule to the next available processing day.
      +N: Do not roll. Schedule day must stand.
      +D: Do not roll and do not schedule.
      +Default:D
    • +
    +
  • +
  • +

    --index (string)

    +
      +
    • Specifies an adjustment to schedule days.
      +After you exercise the ROLL option, the schedule is adjusted,
      +forward for plus or backward for minus, by the number of working days entered.
      +Limits:4 numeric characters that are specified as Innn where I can be plus (unsigned) or minus (-) and nnn can be 0 to 365 daysUsage:
      +Use this field with the RDAY field to schedule a job to run three workdays before the 15th of the month:
      +specify -3 in the INDEX field, X in the MONTHLY field, and 15 in the RDAY field.
    • +
    +
  • +
  • +

    --interval (string)

    +
      +
    • Specifies that the job should be repeated (executed more than once) and
      +specifies the amount of time between each iteration.
      +If INTERVAL is specified, the SBTM (submit time requirement) and TYPE fields are required.
      +If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.
      +Limits:4 numeric characters in hhmm format where hh can be from 0 to 23 and mm can be from 00 to 59
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • Determines how the submit time requirement is calculated for repeating jobs.
      +A TYPE of CLOCK indicates that the INTERVAL is added to the previous iteration's
      +submit time requirement to determine the new submit time requirement.
      +A TYPE of START and END indicates that the INTERVAL is added to the previous iteration's
      +last (most recent) start and end times,respectively, to determine the new submit time requirement.
      +TYPE is required if INTERVAL is specified.
      +TYPE is discarded if INTERVAL is not specifiedLimits:CLOCK, START, or END
    • +
    +
  • +
  • +

    --count (string)

    +
      +
    • Specifies the maximum number of times to repeat the job.
      +COUNT is discarded if INTERVAL is not specified.
      +If both COUNT and STOP are specified, the job stops repeating when the COUNT reaches zero or the STOP time is reached, whichever comes first.
      +If COUNT is not specified, the job repeats until the STOP time is reached.TYPE is required if INTERVAL is specified. TYPE is discarded if INTERVAL is not specifiedLimits:1 to 4 numeric characters from 0 to 1439. Leading zeros can be discarded.
    • +
    +
  • +
  • +

    --weekly (string)

    +
      +
    • Specifies that the user wants to define a weekly schedule.
      +If WEEKLY is used, the run days of the week must be specified using DAYS field
      +Limits:Y or N
    • +
    +
  • +
  • +

    --days (string)

    +
      +
    • Defines specific days of the week on which to run the job.
      +as comma separated list of day name abbreviations.
      +Limits: A comma separated list of Sun,Mon,Tue,Wed,Thu,Fri,Sat
    • +
    +
  • +
  • +

    --monthly (string)

    +
      +
    • Specifies that the user wants to define a monthly schedule.
      +If this field is used, the user can optionally specify on which particular months the job is to run.
      +If specific months are not specified in the months property, all months are assumed.Limits: Y or N
    • +
    +
  • +
  • +

    --months (string)

    +
      +
    • Defines specific months on which to run the job.
      +as comma separated list of month name abbreviations.
      +Limits: A comma separated list of Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec
    • +
    +
  • +
  • +

    --weeks-of-month | --wom (string)

    +
      +
    • Specifies the weeks of the month to run the job.
      +The values that are specified can be positive (unsigned), negative (-) or slash (/).
      +Positive values 1, 2, 3, 4, or 5 are used to indicate the week relative to the beginning of the month.
      +Negative values -0, -1, and -2 are used to indicate occurrence of week relative to the end of the month.
      +Slashes indicate the job will not run the following value.
      +Limits: 1 to 14 numeric characters and required if MONTHLY and DAY-OF-WEEK are used.
      +The values are separated by comma
    • +
    +
  • +
  • +

    --day-of-week | --dow (string)

    +
      +
    • Specifies which days of the week to run the job.
      +If used, each day must be the first three letters of the wanted run days.
      +If you want to specify multiple days, use a comma separated list for example MON,TUE,FRI.
      +Limits: A comma separated list of SUN, MON, TUE, WED, THU, FRI, SAT, case insensitive
    • +
    +
  • +
  • +

    --relative-day | --rd (string)

    +
      +
    • Specifies relative days of the month on which the job is to run. Used with MONTHLY.
      +A day relative to the beginning or end of the month is specified.
      +If a positive (unsigned) value is used, the job runs that day relative to the first of the month.
      +Also, if you have days of the month when this job is not to run,a slash (/) can be used with the unsigned or negative values.
      +Valid positive values range from 1 to 31.
      +Valid negative values range from -0 to -30.
      +Limits:1 to 60 numeric characters, separated by comma.
      +Note:relative-day(s) represents calendar days, unless the base calendar was generated with OPTIONS=SCHDYONLY,
      +in which case relative-day(s) represents processing days.
    • +
    +
  • +
  • +

    --annual (string)

    +
      +
    • Defines an annual schedule.
      +Limits: If annual is used, day is required. One of Y, N
    • +
    +
  • +
  • +

    --day-of-year | --doy (string)

    +
      +
    • Specifies on which days of the annual schedule the user wants to run the job.
      +Days are entered as 1 through 366 and are prefixed by positive (unsigned) or slash (/) values.
      +Slash indicates the job will not run this day.
      +For example, if a job is to run on days 121, 132, 240, and 241, but is not to run on days 122, 242, and 1,the user would specify: /1,121,/122,132,240,241,/242
      +Limits: 1 to 55 numeric characters and required if annual is used.
      +The numbers will be separated by comma
    • +
    +
  • +
  • +

    --symmetric (string)

    +
      +
    • Used with the START and SPAN fields, defines a symmetric schedule.
      +With this option, schedules are defined as beginning on the date specified with
      +the START field and recurring every nnn days as specified with the SPAN field.
      +Limits: One of Y, N
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • This field is required when the SYMETRIC option is taken.
      +Value must be specified as the Julian day of the year on which the symmetric schedule is to begin.
      +This value should be evaluated yearly before schedule resolution and may need to be changed each year.
      +If the schedule will be resolved on a July-June basis, the start date must be within
      +the first of the two years in which the schedule overlaps.
      +For January-December schedules, it is simply relative to January 1 of the year specified on a RESOLV command.
      +If the calendar against which this SCHID will be resolved does not have the OPTIONS=SCHDYONLY,
      +the START day is adjusted each year to maintain the job's symmetric schedule from the job's original specified START day.
      +If the calendar against which the SCHID will be resolved was generated with overall available processing days only (OPTIONS=SCHDYONLY)
      +the start date must specify the first day on which the job would actually run.
      +This requires manually setting (verifying) the START value each year before the RESOLV.
      +If a nonprocessing day is specified, the start day is the next processing day found in the calendar.
      +For example, if January 1 is a nonprocessing day and the calendar was generated with OPTIONS=SCHDYONLY,
      +and 1 is specified as the START day, January 2 is the actual START day (provided it is an available processing day).
      +SPAN is based from January 2 in this example rather than January 1.
      +For other types of calendars, the start date is determined at RESOLV time based on the ROLL and INDEX options taken.
      +Limits: 3 numeric characters specified as Julian day of the year from 1 to 365
    • +
    +
  • +
  • +

    --span (string)

    +
      +
    • Used with SYMETRIC and START, defines symmetric schedules.
      +This field is required if the SYMETRIC option is taken.
      +When used, specifies the number of days between scheduled processing cycles.
      +If the calendar against which the SCHID will be resolved was generated with processing days
      +only (OPTIONS=SCHDYONLY), the SPAN value is specified as the number of available processing days
      +between and including the next processing date as opposed to the actual number of days.
      +With this type of calendar, the ROLL and INDEX options serve no practical purpose.
      +For other calendar types, the SPAN value is specified as the number of calendar days
      +between processing cycles and the ROLL and INDEX options can be used as necessary.
      +Limits: 1 to 3 numeric characters from 1 to 255
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create schedule for job TESTJOB1 with the parameters:

    +
      +
    • zowe ca7 create-job-definition schedule --job TESTJOB1 --schid 01 --dscal 03
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_create-resource-definition.html b/static/v2.15.x/web_help/docs/zowe_ca7_create-resource-definition.html new file mode 100644 index 0000000000..f26a04432a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_create-resource-definition.html @@ -0,0 +1,20 @@ + + + + +ca7 create-resource-definition + + + + + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_create-resource-definition_resource-count-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_create-resource-definition_resource-count-resource.html new file mode 100644 index 0000000000..438c3ba063 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_create-resource-definition_resource-count-resource.html @@ -0,0 +1,134 @@ + + + + +ca7 create-resource-definition resource-count-resource + + +
+

zoweca7create-resource-definitionresource-count-resource

+

Create Resource Count Resource parameters

+

Usage

+

zowe ca7 create-resource-definition resource-count-resource [options]

+

Required Options

+
    +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the name of the Resource Count Resource to add.
      +Limits: 1 to 39 alphanumeric characters and periods
    • +
    +
  • +
  • +

    --total-count | --tc (string)

    +
      +
    • Specifies the total number of available occurrences for this Resource Count Resource.
      +Limits: 1 to 4 numeric characters in the range 0-9999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Add Resource named PAYROLL.RCT to count 125:

    +
      +
    • zowe ca7 create-resource-definition resource-count-resource --rn PAYROLL.RCT --tc 125
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_dataset.html b/static/v2.15.x/web_help/docs/zowe_ca7_dataset.html new file mode 100644 index 0000000000..908f1d886a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_dataset.html @@ -0,0 +1,26 @@ + + + + +ca7 dataset + + +
+

zoweca7dataset

+

All the available commands listed in the Dataset section.

+

Usage

+

zowe ca7 dataset <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_dataset_create-dataset-trigger.html b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_create-dataset-trigger.html new file mode 100644 index 0000000000..f04015c031 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_create-dataset-trigger.html @@ -0,0 +1,204 @@ + + + + +ca7 dataset create-dataset-trigger + + +
+

zoweca7datasetcreate-dataset-trigger

+

Create Dataset Trigger

+

Usage

+

zowe ca7 dataset create-dataset-trigger [options]

+

Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • (Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job.
      +Note: For VSAM files, specify the cluster name.
      +Limits: 1 to 44 alphanumeric characters
    • +
    +
  • +
  • +

    --dataset-number | --dnum (string)

    +
      +
    • (Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set.
      +Limits: 1 to 8 numeric characters
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled.
      +Note: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work
      +Default: 0 (all schedule IDs)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --triggered-job-schid | --tjs (string)

    +
      +
    • (Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.
      +Default: 0 (no replacement)
      +Limits: 1 to 3 numeric characters from 0 through 999
      +Note: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.
    • +
    +
  • +
  • +

    --triggered-job-due-out-time | --tjdot (string)

    +
      +
    • (Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-queue-time must be omitted.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.
      +Note: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.
    • +
    +
  • +
  • +

    --triggered-job-queue-time | --tjqt (string)

    +
      +
    • (Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.
      +Deadline time is calculated as current date/time plus queue time.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-lead-time | --tjlt (string)

    +
      +
    • (Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.
      +Default: 0000
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-submit-time | --tjst (string)

    +
      +
    • +

      (Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.
      +The triggered-job-submit-time is always rounded down to 15-minute increments.
      +Default: 0 (no specific submit time requirement)
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.
      +Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.

      +

      If triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --triggered-job | --tj (string)

    +
      +
    • Specifies the job name that the completion of the triggering dataset triggers.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a Dataset Trigger definition DATA.SET.NAME with schid 42 for Triggered job JOBA:

    +
      +
    • zowe ca7 dataset create-dataset-trigger --dname DATA.SET.NAME --schid 42 --tj JOBA --tjdot 0830
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_dataset_create-dataset.html b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_create-dataset.html new file mode 100644 index 0000000000..75a27a489f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_create-dataset.html @@ -0,0 +1,203 @@ + + + + +ca7 dataset create-dataset + + +
+

zoweca7datasetcreate-dataset

+

Create Dataset

+

Usage

+

zowe ca7 dataset create-dataset [options]

+

Required Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • Specifies the data set and must be the fully qualified data set name.
      +Limits: 1 to 44 alphanumeric characters
      +Note: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.
    • +
    +
  • +
+

Options

+
    +
  • +

    --type (string)

    +
      +
    • (Optional) Specifies the data set type.
      +Valid values are:
      +NORM = Internal means both the creating-job and using-jobs for this data set are known to CA 7.
      +External means the creating-job, using-jobs, or both for this data set are not known to CA 7.PERM = Specifies this data set is always available for inputDefault: NORM
      +Note: When a data set is marked PERM, no SMF records are captured. PERM means no data set triggering can occur with this type of data set
    • +
    +
  • +
  • +

    --gdg (string)

    +
      +
    • (Optional) Specifies whether this data set is a generation data group.
      +Valid values are:
      +Y = The data set is a generation data groupN = The data set is not a generation data groupDefault: N
      +Note: The specific GDG creations cannot be used for posting requirements or for triggering jobs. Posting and triggering are done based on the creation/updating (SMF 15 record) of any generation of the GDG.
    • +
    +
  • +
  • +

    --smf-feedback-required | --sfr (string)

    +
      +
    • (Optional) Specifies whether the interface to System Management Facility (SMF) inserts the values for DSORG, RECFM, LRECL, and BLKSIZE when this data set is next used. Unless the value is reset, this insertion is only done once.
      +Valid values are:
      +Y = SMF inserts the values when the data set is next usedN = SMF does not insert the values when the data set is next usedDefault: Y
      +Note: After the first time the job that creates this data set runs under CA 7, this field is reset to N. If the data set attributes change, this field must be reset to Y. The changed attribute field (that is, DSORG, RECFM) must be zeroed (if numeric) or blanked out. This process causes CA 7 to record the new values when the job is run again.
    • +
    +
  • +
  • +

    --post-at-close-time | --pact (string)

    +
      +
    • (Optional) Specifies when to post the creation or update of a data set to the database and queues. This process does not ensure successful step or job termination.
      +Valid values are:
      +Y = The action takes place when the SMF data set creation record is received (when the data set is closed)N = Causes triggering or posting action to take place at the job terminationDefault: N
    • +
    +
  • +
  • +

    --device (string)

    +
      +
    • (Optional) Specifies a device type.
      +Valid values are:
      +TAPEDASD
    • +
    +
  • +
  • +

    --dsorg (string)

    +
      +
    • (Optional) Specifies the data set organization. This value is the same as the DSORG specified in the DCB subparameter in the JCL.
      +Limits: 1 to 3 alphanumeric characters
    • +
    +
  • +
  • +

    --recfm (string)

    +
      +
    • (Optional) Specifies the record format of the data set. This value is the same as the RECFM specified in the DCB subparameter in the JCL.
      +Limits: 1 to 5 alphanumeric characters
    • +
    +
  • +
  • +

    --lrecl (string)

    +
      +
    • (Optional) Specifies the logical record length of the data set. This value is the same as the LRECL specified in the DCB subparameter in the JCL.
      +Limits: 1 to 5 numeric characters
    • +
    +
  • +
  • +

    --blksize (string)

    +
      +
    • (Optional) Specifies the block size of the data set. This value is the same as the BLKSIZE specified in the DCB subparameter in the JCL.
      +Limits: 1 to 5 numeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a new dataset named DATASET.NAME.TEST of type NORM and data set is not a generation data group:

    +
      +
    • zowe ca7 dataset create-dataset --dname DATASET.NAME.TEST --type NORM --gdg N
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_dataset_delete-dataset-trigger.html b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_delete-dataset-trigger.html new file mode 100644 index 0000000000..e63e780c33 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_delete-dataset-trigger.html @@ -0,0 +1,154 @@ + + + + +ca7 dataset delete-dataset-trigger + + +
+

zoweca7datasetdelete-dataset-trigger

+

Delete Dataset Trigger

+

Usage

+

zowe ca7 dataset delete-dataset-trigger [options]

+

Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • (Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job.
      +Note: For VSAM files, specify the cluster name.
      +Limits: 1 to 44 alphanumeric characters
    • +
    +
  • +
  • +

    --dataset-number | --dnum (string)

    +
      +
    • (Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set.
      +Limits: 1 to 8 numeric characters
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled.
      +Note: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work
      +Default: 0 (all schedule IDs)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --triggered-job | --tj (string)

    +
      +
    • Specifies the job name that the completion of the triggering dataset triggers.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a Dataset Trigger definition DATA.SET.NAME with schid 42 for Triggered job JOBA:

    +
      +
    • zowe ca7 dataset delete-dataset-trigger --dname DATA.SET.NAME --schid 42 --tj JOBA
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_dataset_delete-dataset.html b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_delete-dataset.html new file mode 100644 index 0000000000..200bb6ff76 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_delete-dataset.html @@ -0,0 +1,135 @@ + + + + +ca7 dataset delete-dataset + + +
+

zoweca7datasetdelete-dataset

+

Delete Dataset

+

Usage

+

zowe ca7 dataset delete-dataset [options]

+

Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • (Required if dataset-number is omitted) Specifies the data set and must be the fully qualified data set name.
      +Limits: 1 to 44 alphanumeric characters
      +Note: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.
    • +
    +
  • +
  • +

    --dataset-number | --dnum (string)

    +
      +
    • (Required if dataset-name is omitted) Specifies the data set to use. The value must be the numeric value that CA 7 already assigned.
      +Limits: 1 to 8 numeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the definition of a dataset named DATA.SET.NAME:

    +
      +
    • zowe ca7 dataset delete-dataset --dname DATA.SET.NAME
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_dataset_rename-dataset.html b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_rename-dataset.html new file mode 100644 index 0000000000..827008e64e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_rename-dataset.html @@ -0,0 +1,146 @@ + + + + +ca7 dataset rename-dataset + + +
+

zoweca7datasetrename-dataset

+

Rename a existing Dataset

+

Usage

+

zowe ca7 dataset rename-dataset [options]

+

Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • (Required if dataset-number is omitted) Specifies the data set and must be the fully qualified data set name.
      +Limits: 1 to 44 alphanumeric characters
      +Note: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.
    • +
    +
  • +
  • +

    --dataset-number | --dnum (string)

    +
      +
    • (Required if dataset-name is omitted) Specifies the data set to use. The value must be the numeric value that CA 7 already assigned.
      +Limits: 1 to 8 numeric characters
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --new-dataset-name | --ndname (string)

    +
      +
    • Specifies the new, fully qualified data set name.
      +Limits: 1 to 44 alphanumeric characters
      +Note: new-dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Renames Dataset with name DATASET.NAME.TEST to NEW.DATASET.NAME.TEST:

    +
      +
    • zowe ca7 dataset rename-dataset --dname DATASET.NAME.TEST --ndname NEW.DATASET.NAME.TEST
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_dataset_update-dataset-trigger.html b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_update-dataset-trigger.html new file mode 100644 index 0000000000..e911d8ecb7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_update-dataset-trigger.html @@ -0,0 +1,204 @@ + + + + +ca7 dataset update-dataset-trigger + + +
+

zoweca7datasetupdate-dataset-trigger

+

Modify Dataset Trigger

+

Usage

+

zowe ca7 dataset update-dataset-trigger [options]

+

Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • (Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job.
      +Note: For VSAM files, specify the cluster name.
      +Limits: 1 to 44 alphanumeric characters
    • +
    +
  • +
  • +

    --dataset-number | --dnum (string)

    +
      +
    • (Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set.
      +Limits: 1 to 8 numeric characters
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled.
      +Note: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work
      +Default: 0 (all schedule IDs)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --triggered-job-schid | --tjs (string)

    +
      +
    • (Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.
      +Default: 0 (no replacement)
      +Limits: 1 to 3 numeric characters from 0 through 999
      +Note: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.
    • +
    +
  • +
  • +

    --triggered-job-due-out-time | --tjdot (string)

    +
      +
    • (Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-queue-time must be omitted.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.
      +Note: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.
    • +
    +
  • +
  • +

    --triggered-job-queue-time | --tjqt (string)

    +
      +
    • (Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.
      +Deadline time is calculated as current date/time plus queue time.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-lead-time | --tjlt (string)

    +
      +
    • (Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.
      +Default: 0000
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-submit-time | --tjst (string)

    +
      +
    • +

      (Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.
      +The triggered-job-submit-time is always rounded down to 15-minute increments.
      +Default: 0 (no specific submit time requirement)
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.
      +Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.

      +

      If triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --triggered-job | --tj (string)

    +
      +
    • Specifies the job name that the completion of the triggering dataset triggers.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a Dataset Trigger definition DATA.SET.NAME with schid 42 for Triggered job JOBA:

    +
      +
    • zowe ca7 dataset update-dataset-trigger --dname DATA.SET.NAME --schid 42 --tj JOBA --tjdot 0830 --tjlt 0030 --tjst 1030
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_dataset_update-dataset.html b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_update-dataset.html new file mode 100644 index 0000000000..7e86d5d657 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_dataset_update-dataset.html @@ -0,0 +1,207 @@ + + + + +ca7 dataset update-dataset + + +
+

zoweca7datasetupdate-dataset

+

Modify Dataset

+

Usage

+

zowe ca7 dataset update-dataset [options]

+

Options

+
    +
  • +

    --dataset-name | --dname (string)

    +
      +
    • (Required if dataset-number is omitted) Specifies the data set and must be the fully qualified data set name.
      +Limits: 1 to 44 alphanumeric characters
      +Note: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.
    • +
    +
  • +
  • +

    --dataset-number | --dnum (string)

    +
      +
    • (Required if dataset-name is omitted) Specifies the data set to use. The value must be the numeric value that CA 7 already assigned.
      +Limits: 1 to 8 numeric characters
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • (Optional) Specifies the data set type.
      +Valid values are:
      +NORM = Internal means both the creating-job and using-jobs for this data set are known to CA 7.
      +External means the creating-job, using-jobs, or both for this data set are not known to CA 7.PERM = Specifies this data set is always available for inputDefault: NORM
      +Note: When a data set is marked PERM, no SMF records are captured. PERM means no data set triggering can occur with this type of data set
    • +
    +
  • +
  • +

    --gdg (string)

    +
      +
    • (Optional) Specifies whether this data set is a generation data group.
      +Valid values are:
      +Y = The data set is a generation data groupN = The data set is not a generation data groupDefault: N
      +Note: The specific GDG creations cannot be used for posting requirements or for triggering jobs. Posting and triggering are done based on the creation/updating (SMF 15 record) of any generation of the GDG.
    • +
    +
  • +
  • +

    --smf-feedback-required | --sfr (string)

    +
      +
    • (Optional) Specifies whether the interface to System Management Facility (SMF) inserts the values for DSORG, RECFM, LRECL, and BLKSIZE when this data set is next used. Unless the value is reset, this insertion is only done once.
      +Valid values are:
      +Y = SMF inserts the values when the data set is next usedN = SMF does not insert the values when the data set is next usedDefault: Y
      +Note: After the first time the job that creates this data set runs under CA 7, this field is reset to N. If the data set attributes change, this field must be reset to Y. The changed attribute field (that is, DSORG, RECFM) must be zeroed (if numeric) or blanked out. This process causes CA 7 to record the new values when the job is run again.
    • +
    +
  • +
  • +

    --post-at-close-time | --pact (string)

    +
      +
    • (Optional) Specifies when to post the creation or update of a data set to the database and queues. This process does not ensure successful step or job termination.
      +Valid values are:
      +Y = The action takes place when the SMF data set creation record is received (when the data set is closed)N = Causes triggering or posting action to take place at the job terminationDefault: N
    • +
    +
  • +
  • +

    --device (string)

    +
      +
    • (Optional) Specifies a device type.
      +Valid values are:
      +TAPEDASD
    • +
    +
  • +
  • +

    --dsorg (string)

    +
      +
    • (Optional) Specifies the data set organization. This value is the same as the DSORG specified in the DCB subparameter in the JCL.
      +Limits: 1 to 3 alphanumeric characters
    • +
    +
  • +
  • +

    --recfm (string)

    +
      +
    • (Optional) Specifies the record format of the data set. This value is the same as the RECFM specified in the DCB subparameter in the JCL.
      +Limits: 1 to 5 alphanumeric characters
    • +
    +
  • +
  • +

    --lrecl (string)

    +
      +
    • (Optional) Specifies the logical record length of the data set. This value is the same as the LRECL specified in the DCB subparameter in the JCL.
      +Limits: 1 to 5 numeric characters
    • +
    +
  • +
  • +

    --blksize (string)

    +
      +
    • (Optional) Specifies the block size of the data set. This value is the same as the BLKSIZE specified in the DCB subparameter in the JCL.
      +Limits: 1 to 5 numeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates the dataset with specified information:

    +
      +
    • zowe ca7 dataset update-dataset --dname DATASET.NAME.TEST --type NORM --gdg N --sfr Y --pact N --blksize 11111
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_delete-job-definition.html b/static/v2.15.x/web_help/docs/zowe_ca7_delete-job-definition.html new file mode 100644 index 0000000000..cc3fbdcef6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_delete-job-definition.html @@ -0,0 +1,21 @@ + + + + +ca7 delete-job-definition + + +
+

zoweca7delete-job-definition

+

All the available commands are listed in the COMMANDS section.

+

Usage

+

zowe ca7 delete-job-definition <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_delete-job-definition_req-predecessor.html b/static/v2.15.x/web_help/docs/zowe_ca7_delete-job-definition_req-predecessor.html new file mode 100644 index 0000000000..de4e2bb051 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_delete-job-definition_req-predecessor.html @@ -0,0 +1,172 @@ + + + + +ca7 delete-job-definition req-predecessor + + +
+

zoweca7delete-job-definitionreq-predecessor

+

Delete predecessor requirement for a job.

+

Usage

+

zowe ca7 delete-job-definition req-predecessor [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job that requires the predecessor
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • The schedule id of requiring job
    • +
    +
  • +
  • +

    --predtype (string)

    +
      +
    • The predecessor type
    • +
    +
  • +
  • +

    --nextrun (string)

    +
      +
    • The status of predecessor for next run of job
      +[ YES, ONLY, SKIP ]
    • +
    +
  • +
  • +

    --predobject (string)

    +
      +
    • The predecessor. Values vary with predtype.
      +The predecessor. Values vary with predtype.
      +When “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.
      +When “predtype”:”USER” then “predobject” is 1-44 character user requirement text.
    • +
    +
  • +
+

Options

+
    +
  • +

    --leadtime (string)

    +
      +
    • The satisfaction lead time in hours.
      +This may be honored when “predtype” is “job or “DSN”
    • +
    +
  • +
  • +

    --permanent (string)

    +
      +
    • Indicates that this predecessor is permanent, that is always considered satisfied.
      +This parameter only applies when “predtype” is “DSN”
      +[ Y, N ]
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a job requirement predecessor of a CA 7 job using the options:

    +
      +
    • zowe ca7 delete-job-definition req-predecessor --job ZOWECRM1 --schid 0004 --predtype USER --nextrun ONLY --predobject USER101
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_delete-job-definition_schedule.html b/static/v2.15.x/web_help/docs/zowe_ca7_delete-job-definition_schedule.html new file mode 100644 index 0000000000..811eaf58a8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_delete-job-definition_schedule.html @@ -0,0 +1,134 @@ + + + + +ca7 delete-job-definition schedule + + +
+

zoweca7delete-job-definitionschedule

+

Delete an existing date/time schedule

+

Usage

+

zowe ca7 delete-job-definition schedule [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • Specifies the numeric schedule ID on which the user wants to perform the specified action.
      +Limits:
      +1 to 3 numeric characters from 1 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete an existing date/time schedule (remove a schedule ID) for a CA7 job:

    +
      +
    • zowe ca7 delete-job-definition schedule --job ZOWECRM1 --schid 0004
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_delete-resource-definition.html b/static/v2.15.x/web_help/docs/zowe_ca7_delete-resource-definition.html new file mode 100644 index 0000000000..c9a4654dee --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_delete-resource-definition.html @@ -0,0 +1,20 @@ + + + + +ca7 delete-resource-definition + + + + + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_delete-resource-definition_resource-count-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_delete-resource-definition_resource-count-resource.html new file mode 100644 index 0000000000..3c785deda9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_delete-resource-definition_resource-count-resource.html @@ -0,0 +1,127 @@ + + + + +ca7 delete-resource-definition resource-count-resource + + +
+

zoweca7delete-resource-definitionresource-count-resource

+

Delete a Resource Count resource

+

Usage

+

zowe ca7 delete-resource-definition resource-count-resource [options]

+

Required Options

+
    +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the name of the Resource Count Resource to delete.
      +Limits: 1 to 39 alphanumeric characters and periods
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete Resource Count Resource parameters:

    +
      +
    • zowe ca7 delete-resource-definition resource-count-resource --rn PAYROLL.RCT
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_event-manager-requests.html b/static/v2.15.x/web_help/docs/zowe_ca7_event-manager-requests.html new file mode 100644 index 0000000000..533bff929c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_event-manager-requests.html @@ -0,0 +1,20 @@ + + + + +ca7 event-manager-requests + + +
+

zoweca7event-manager-requests

+

All the available commands are listed in the COMMANDS section.

+

Usage

+

zowe ca7 event-manager-requests <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_event-manager-requests_job-status.html b/static/v2.15.x/web_help/docs/zowe_ca7_event-manager-requests_job-status.html new file mode 100644 index 0000000000..fa6d707d69 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_event-manager-requests_job-status.html @@ -0,0 +1,130 @@ + + + + +ca7 event-manager-requests job-status + + +
+

zoweca7event-manager-requestsjob-status

+

Available request is listed below.

+

Usage

+

zowe ca7 event-manager-requests job-status [options]

+

Required Options

+
    +
  • +

    --jobnumber | --jnum (string)

    +
      +
    • +

      jnum=0016

      +

      Defines the name of the job to retrieve.
      +Indicates the individual job to retrieve, and the value must be a CA 7 job number.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Gets the status of jobnumber 0016 from CA 7:

    +
      +
    • zowe ca7 event-manager-requests job-status --jnum 0016
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition.html new file mode 100644 index 0000000000..26ae6513b7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition.html @@ -0,0 +1,44 @@ + + + + +ca7 job-definition + + +
+

zoweca7job-definition

+

All the available commands listed in the Job Definition section.

+

Usage

+

zowe ca7 job-definition <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-address-space-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-address-space-resource.html new file mode 100644 index 0000000000..5024db215c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-address-space-resource.html @@ -0,0 +1,154 @@ + + + + +ca7 job-definition create-address-space-resource + + +
+

zoweca7job-definitioncreate-address-space-resource

+

Add Address Space Resource

+

Usage

+

zowe ca7 job-definition create-address-space-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --ready-when | --rw (string)

    +
      +
    • (Optional) Determines how VRM manages resource availability at job submission and job/step completion.
      +Default: A
      +Valid values are:
      +A = Specifies the job is submitted only if the resource is active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the systemI = Specifies the job is submitted only if the resource is not active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the system
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBAA with resource name SCHENV.VARNAME, schedule id 23 and job is submitted only if the resource is not active:

    +
      +
    • zowe ca7 job-definition create-address-space-resource --job JOBAA --schid 23 --rn SCHENV.VARNAME --rw I
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-corequisite-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-corequisite-resource.html new file mode 100644 index 0000000000..e43b541175 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-corequisite-resource.html @@ -0,0 +1,162 @@ + + + + +ca7 job-definition create-corequisite-resource + + +
+

zoweca7job-definitioncreate-corequisite-resource

+

Add Corequisite Resource

+

Usage

+

zowe ca7 job-definition create-corequisite-resource [options]

+

Required Options

+
    +
  • +

    --job-name | --jn (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be nonblank, and no embedded blanks
      +Exception: If the resource connection is made to a resource count resource,
      +the resource name can be from 1 to 39 characters followed by a / (slash) and
      +a 1 through 4 numeric value indicating the number of occurrences for the resource that the job uses.
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied.
      +A zero default cannot be specified for one connection and a nonzero schedule ID used for
      +a subsequent connection to the same job with the same user requirement description.
      +An attempt to make such a connection results in an error message that is issued.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --ready-when | --rw (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Default: A
      +Valid values are:
      +A
      +Specifies the job is submitted only if the resource is active (as established by the PRSQA command).I
      +Specifies the job is submitted only if the resource is not active.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBAA with resource name SCHENV.VARNAME, schedule id 23 and job is submitted only if the resource is not active:

    +
      +
    • zowe ca7 job-definition create-corequisite-resource --jn JOBAA --schid 23 --rn SCHENV.VARNAME --rw I
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-exclusive-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-exclusive-resource.html new file mode 100644 index 0000000000..2a005359ee --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-exclusive-resource.html @@ -0,0 +1,161 @@ + + + + +ca7 job-definition create-exclusive-resource + + +
+

zoweca7job-definitioncreate-exclusive-resource

+

Add Exclusive Resource

+

Usage

+

zowe ca7 job-definition create-exclusive-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
  • +

    --free (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Valid values are:
      +A = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfullyN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resourceY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --step-name | --sn (string)

    +
      +
    • (Optional) Specifies the resource is freed at the conclusion of the named job step.
      +Limits: 1 to 8 alphanumeric characters
      +Notes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBAA with resource name SCHENV.VARNAME of free type F, step name JS010 and schedule id 23:

    +
      +
    • zowe ca7 job-definition create-exclusive-resource --job JOBAA --schid 23 --rn SCHENV.VARNAME --free F --sn JS010
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-job-trigger-successor.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-job-trigger-successor.html new file mode 100644 index 0000000000..849780b39c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-job-trigger-successor.html @@ -0,0 +1,194 @@ + + + + +ca7 job-definition create-job-trigger-successor + + +
+

zoweca7job-definitioncreate-job-trigger-successor

+

Add Job Trigger

+

Usage

+

zowe ca7 job-definition create-job-trigger-successor [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name whose successful completion causes triggering.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --triggered-job | --tj (string)

    +
      +
    • Specifies the job name that the completion of the triggering job triggers.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.
      +Default: 0 (all schedule IDs)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --triggered-job-schid | --tjs (string)

    +
      +
    • (Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.
      +Default: 0 (no replacement)
      +Limits: 1 to 3 numeric characters from 0 through 999
      +Note: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.
    • +
    +
  • +
  • +

    --triggered-job-due-out-time | --tjdot (string)

    +
      +
    • (Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-queue-time must be omitted.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.
      +Note: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.
    • +
    +
  • +
  • +

    --triggered-job-queue-time | --tjqt (string)

    +
      +
    • (Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.
      +Deadline time is calculated as current date/time plus queue time.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-lead-time | --tjlt (string)

    +
      +
    • (Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.
      +Default: 0000
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-submit-time | --tjst (string)

    +
      +
    • +

      (Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.
      +The triggered-job-submit-time is always rounded down to 15-minute increments.
      +Default: 0 (no specific submit time requirement)
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.

      +

      If triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates the Job JOBA having Triggered JOBB with triggered-job-due-out-time:

    +
      +
    • zowe ca7 job-definition create-job-trigger-successor --job JOBA --tj JOBB --tjdot 0830
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-job.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-job.html new file mode 100644 index 0000000000..0b49fc1ef6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-job.html @@ -0,0 +1,581 @@ + + + + +ca7 job-definition create-job + + +
+

zoweca7job-definitioncreate-job

+

Create Job Definition

+

Usage

+

zowe ca7 job-definition create-job [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job
    • +
    +
  • +
  • +

    --job-type | --jt (string)

    +
      +
    • The type of job.
      +Valid values are:
      +CPU = A CPU jobXPJOB = A cross-platform jobAGENT = An Agent job
    • +
    +
  • +
+

Options

+
    +
  • +

    --long-name | --ln (string)

    +
      +
    • (Optional) Defines the long job name.
      +Limits: 1 to 64 alphanumeric characters, case sensitive
    • +
    +
  • +
  • +

    --system (string)

    +
      +
    • (Optional) Specifies the user-defined application system name of which this job is a part.
      +Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma
    • +
    +
  • +
  • +

    --uid (string)

    +
      +
    • (Optional) Specifies the CA 7 user security identification.
      +Default: 0 (no internal security protection)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --jobnet (string)

    +
      +
    • (Optional) Specifies the name of a CPU job network of which this job is a part.
      +Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma
    • +
    +
  • +
  • +

    --owner (string)

    +
      +
    • (Optional) Specifies the ID identifying ownership of this job. Depending on the startup options taken, the external security product being used and contents of the JCL, this value can be offered to the external security package by CA 7 at job submission time as the authority for this job to be executed.
      +Limits: 1 to 8 alphanumeric characters. Although this field supports up to 8 characters, some external security packages only accept up to 7 characters. This field must not exceed any such limit that exists
    • +
    +
  • +
  • +

    --jcl-member | --jm (string)

    +
      +
    • (Optional) Specifies the JCL library member name and required when the member name and job name are different.
      +Valid when: job-type is CPU
      +Default: Job name
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --id (string)

    +
      +
    • (Optional) Specifies a numeric index value that is associated with a JCL library where the JCL member is located. NOTE: the id and lib properties are mutually exclusive.
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0-253 or 256-999
    • +
    +
  • +
  • +

    --lib (string)

    +
      +
    • (Optional) Specifies a JCL library identification consisting of a symbolic INDEX assigned to a JCL statement. NOTE: the id and lib properties are mutually exclusive.
      +Valid when: job-type is CPU
      +Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)
    • +
    +
  • +
  • +

    --reload (string)

    +
      +
    • (Optional) Specifies whether to reload the JCL of this job. When a job comes into the request queue, it is either flagged for load processing or it is not flagged.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = The job is flagged for load processing. The reload flag is automatically reset to N once the load completes successfullyN = The job is not flagged for load processing unless it is the first time it has run in CA 7X = The job is only flagged for load processing when the LOAD command is used and is never automatically changed even if the LOAD command is used
    • +
    +
  • +
  • +

    --execute (string)

    +
      +
    • (Optional) Indicates whether to execute this job.
      +Default: Y
      +Valid values are:
      +Y = The job will be executedN = The job does not run but shows a normal completion as if it did run. JCL is not required for non-executable jobs
    • +
    +
  • +
  • +

    --retain (string)

    +
      +
    • (Optional) Specifies whether to retain the execution JCL in the trailer queue after a successful run.
      +Valid when: job-type is CPU or XPJOB
      +Default: N
      +Valid values are:
      +Y = Retain the JCL in the trailer queue after a successful run.N = Do not retain the JCL in the trailer queue after a successful run
    • +
    +
  • +
  • +

    --hold (string)

    +
      +
    • (Optional) Specifies whether to place this job in a hold status when it enters the request queue.
      +Default: N
      +Valid values are:
      +Y = The job will be heldN = The job will not be held
    • +
    +
  • +
  • +

    --jcl-override | --jo (string)

    +
      +
    • (Optional) Specifies whether this job needs manual JCL overrides before it can be submitted. Similar to the JCLOVRD command.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = The job needs manual JCL overrides before it can be submittedN = The job does not need manual JCL overrides before it can be submitted
    • +
    +
  • +
  • +

    --use-jcl-override-library | --ujol (string)

    +
      +
    • (Optional) Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only. This field is automatically set back to N the next time the job comes into the request queue.
      +Default: N
      +Valid values are:
      +Y = The JCL is retrieved from the JCL Override library for the next runN = The JCL is not retrieved from the JCL Override library for the next run
    • +
    +
  • +
  • +

    --verify (string)

    +
      +
    • (Optional) Specifies whether this job requires any pre-submission manual verification. Similar to VERIFY command.
      +Default: N
      +Valid values are:
      +Y = The job requires any pre-submission manual verificationN = The job does not require any pre-submission manual verification
    • +
    +
  • +
  • +

    --maintenance | --maint (string)

    +
      +
    • (Optional) Specifies whether this job is a maintenance job (for example, a system utility) with no production data set requirements. If Y is specified, all input data set requirements are ignored. None of the output data sets created by this job is posted back to CA 7.
      +Marking a job as maintenance enables job triggering but not data set triggering.
      +Also, if the LOADDSNS keyword is used on the DBASE statement in the initialization file, the LOAD process does not build any DD or data set information for jobs that are marked as maintenance. This means that there are not any data set connections for these jobs unless added manually.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = The job is a maintenance jobN = The job is not a maintenance job
    • +
    +
  • +
  • +

    --job-requirement-lead-time | --jrlt (string)

    +
      +
    • (Optional) Specifies the number of hours to be considered when satisfying job-dependent requirements.
      +Default: 0
      +Valid values are:
      +0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each predecessor job must complete typically while this job is in the request queuenn = Since the last run of this job, specifies that each predecessor job must have run within the last nn hours. Values for nn can be from 1 to 98
    • +
    +
  • +
  • +

    --dataset-requirement-lead-time | --drlt (string)

    +
      +
    • (Optional) Specifies the number of hours to be considered when satisfying data set requirements.
      +Valid when: job-type is CPU
      +Default: 0
      +Valid values are:
      +0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each data set requirement must be satisfied typically while this job is in the request queuenn = Since the last run of this job, specifies that each data set requirement must be satisfied within the last nn hours. Values for nn can be from 1 to 98
    • +
    +
  • +
  • +

    --arfset (string)

    +
      +
    • (Optional) Names the collection of ARF definitions that apply to this job. Remember that ARF recovery is not invoked for non-executable jobs.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --mainid (string)

    +
      +
    • (Optional) Specifies on which CPU the job can or cannot be scheduled. If the job requirements impose CPU restrictions, specify SYn or /SYn where n is the system number and / indicates not this system. System numbers must be consistent with the initialization file CPU statement MAINIDS parameters.
      +Valid when: job-type is CPU
      +Default: ALL (lets the job run on any CPU)
      +Limits: 1 to 4 alphanumeric characters
    • +
    +
  • +
  • +

    --insert-ca11-rms | --icr (string)

    +
      +
    • (Optional) Specifies whether to insert the WA Restart Option RMS step automatically at execution time by CA 7.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = Inserts the step with the WA Restart Option processing code of PN = Does not insert the RMS step
    • +
    +
  • +
  • +

    --condition-code | --cc (string)

    +
      +
    • (Optional) Used with relational-operator property to define the job-level condition codes used to determine whether a job executes successfully.
      +Valid when: job-type is CPU or XPJOB
      +Note: All condition codes that are returned from an XPJOB job are treated as positive values. Any negative value returned is converted to an absolute (positive) value
      +Default: 0
      +Limits: For job-type = CPU: 1 to 4 numeric characters in the range 0-4095
      +For job-type = "XPJOB": 1 to 4 numeric characters in the range 0-9999
    • +
    +
  • +
  • +

    --relational-operator | --ro (string)

    +
      +
    • (Optional) Specifies the relational operator of the condition-code property or if the step level #SCC statements are being used in the job's JCL.
      +Valid when: job-type is CPU or XPJOB
      +Default: 0
      +Valid values are:
      +EQ = Equal toLT = Less thanGT = Greater thanGE = Greater than or equal toLE = Less than or equal toNE = Not equal to#S = Make step condition code tests based on #SCC statements in the JCLIG = Make no evaluation of the job. CA 7 always assumes the job completes successfully, regardless of condition codes, abend codes, or runtime JCL errors. When this is used, the insert-ca11-rms property should be N0 = No condition test will be madeNOTE: If 0 is used, no test is made on the job's condition code. The highest condition code that this job generates is tested by this pair of parameters. For example, if condition-code is set at 8 and RO is set at LT, the job is marked as completing abnormally if 8 is less than the job's highest condition code
    • +
    +
  • +
  • +

    --do-not-schedule-before-date | --dnsbd (string)

    +
      +
    • (Optional) Specifies not to schedule this job before this date (in YYDDD format, or 00000)
    • +
    +
  • +
  • +

    --do-not-schedule-before-time | --dnsbt (string)

    +
      +
    • (Optional) Specifies not to schedule this job before this time (in HHMM format)
    • +
    +
  • +
  • +

    --do-not-schedule-after-date | --dnsad (string)

    +
      +
    • (Optional) Specifies not to schedule this job after this date (in YYDDD format, or 99999)
    • +
    +
  • +
  • +

    --do-not-schedule-after-time | --dnsat (string)

    +
      +
    • (Optional) Specifies not to schedule this job after this time (in HHMM format)
    • +
    +
  • +
  • +

    --lterm (string)

    +
      +
    • (Optional) Routes the messages about this job to this logical terminal name.
      +Default: If not entered, the LTERM associated with the JCL library in the initialization file JCL statement is used. If LTERM is not specified on the JCL statement, the default is MASTER
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --list-requirements | --lr (string)

    +
      +
    • (Optional) Specifies whether to list pre-execution requirements for this job when it enters the request queue.
      +Default: Y
      +Valid values are:
      +Y = The pre-execution requirements will be listedN = The pre-execution requirements will not be listed
    • +
    +
  • +
  • +

    --prompts (string)

    +
      +
    • (Optional) Specifies whether to issue prompt messages when this job is late.
      +Default: Y
      +Valid values are:
      +Y = Prompt messages will be issued when the job is lateN = Prompt messages will not be issued when the job is late
    • +
    +
  • +
  • +

    --requirements-not-used | --rnu (string)

    +
      +
    • (Optional) Specifies whether to issue error messages for job requirements not used.
      +Default: Y
      +Valid values are:
      +Y = Messages will be issued if requirements are not usedN = Messages will not be issued if requirements are not used
    • +
    +
  • +
  • +

    --dsn-not-found | --dnf (string)

    +
      +
    • (Optional) Specifies whether to list error messages for data sets used at execution time but not found in the CA 7 database.
      +Valid when: job-type is CPU
      +Default: Y
      +Valid values are:
      +Y = Messages will be issued if data sets used are not found in the CA 7 databaseN = Messages will not be issued if data sets used are not found in the CA 7 database
    • +
    +
  • +
  • +

    --job-region | --jr (string)

    +
      +
    • (Optional) Specifies the region size that is required by this job (information only).
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 4 numeric characters
    • +
    +
  • +
  • +

    --elapsed-time | --et (string)

    +
      +
    • (Optional) CA 7 maintains certain SMF feedback data in its database, including a weighted average elapsed runtime. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.
      +Default: 0000
      +Limits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59
    • +
    +
  • +
  • +

    --average-cpu-time | --act (string)

    +
      +
    • (Optional) CA 7 maintains weighted average CPU time usage values for each job in its database. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.
      +Valid when: job-type is CPU
      +Default: 0000
      +Limits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59
    • +
    +
  • +
  • +

    --wlb-job-class | --wjc (string)

    +
      +
    • +

      (Optional) Specifies the CA 7 WLB job class. If not specified, a WLB class of A is automatically assigned. This value does not have to match the JOB statement CLASS value.

      +

      NOTE: The value specified here does not apply when the job enters the queue as a result of a RUN(H) command. Class 9 is assigned by default. To override class 9, use the RUNCLASS keyword on the OPTIONS statement in the initialization file.

      +

      NOTE: The value specified here does not apply when the job enters the queue as a result of a LOAD(H) command. Class 8 is assigned by default. To override class 8, use the LOADCLASS keyword on the OPTIONS statement in the initialization file
      +Default: A space
      +Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --wlb-priority | --wp (string)

    +
      +
    • (Optional) Specifies the CA 7 WLB job priority. A value of 255 indicates an express priority used to bypass WLB priority scheduling criteria. If using WLB, any job without a specified priority is automatically assigned a priority of 100 unless the default is changed
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0 - 255
    • +
    +
  • +
  • +

    --message-class | --mc (string)

    +
      +
    • (Optional) Specifies the job's message class. This field is informational only. Even though this field can be changed, it does not cause the JCL to be changed. Also, no validity checking is done on this field.
      +Valid when: job-type is CPU
      +Default: A space
      +Limits: 1 alphanumeric character
    • +
    +
  • +
  • +

    --drclass | --dc (string)

    +
      +
    • (Optional) Specifies the job's disaster recovery class. This field has no impact on processing during normal execution. When running in disaster recovery mode, the disaster recovery class is used to determine whether the job should execute.
      +Limits: 1 to 8 alphanumeric characters. Disaster recovery class values must start with a letter, #, or $ (not @) and can include letters, #, $, @, and numbers. Disaster recovery classes cannot contain embedded blanks
    • +
    +
  • +
  • +

    --number-1-tape-man | --n1tm (string)

    +
      +
    • (Optional) Specifies a manual override value for the number of TYPE1 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE1 tape drives.
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0 - 255
    • +
    +
  • +
  • +

    --number-2-tape-man | --n2tm (string)

    +
      +
    • (Optional) Specifies a manual override value for the number of TYPE2 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE2 tape drives.
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0 - 255
    • +
    +
  • +
  • +

    --xp-node | --xn (string)

    +
      +
    • (Required when job-type is XPJOB) Defines the CAICCI node to which the execution of this job is targeted. This field should state the primary node. If this node is unavailable and the node definition has alternate nodes defined, the execution of this job can be directed to an alternate node.
      +Valid when: job-type is XPJOB
      +Limits: 1 to 44 alphanumeric characters, although current z/OS CAICCI restricts this name to eight characters
    • +
    +
  • +
  • +

    --xp-exec | --xe (string)

    +
      +
    • (Required when job-type is XPJOB) Defines the executable (file, command) to execute at the targeted cross-platform node. If the targeted platform is a mainframe scheduling system such as CA 7, this value indicates the job name to execute on that platform. If the targeted platform is Workload Automation AE system, this value indicates a job that is defined in the Workload Automation AE system. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. Otherwise, the field is passed to the target system as-is and in its entirety. This value includes any embedded blanks and quotation marks.
      +Valid when: job-type is XPJOB
      +Limits: Up to 244 alphanumeric characters, and file delimiters of forward slash (/) and backward slash (\) signs. Note: Each backward slash character must be escaped by specifying (\\)
    • +
    +
  • +
  • +

    --xp-parm | --xp (string)

    +
      +
    • (Optional) Defines up to 128 bytes of parameter data to pass to the file or command being executed on the alternate platform. This data is supplied as PARM1 to the data being transmitted to the alternate platform. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. This value may be overridden if the PARMLIB/MEMBER field PARM1 is coded.
      +Valid when: job-type is XPJOB
      +Limits: Up to 128 EBCDIC characters
    • +
    +
  • +
  • +

    --parmlib | --pl (string)

    +
      +
    • (Optional) Defines extra, optional indexed, or symbolic (PDS) library from where execution data to be associated with this job can be found. This information is typically PARM1 through PARM64 keywords but can vary based on CA 7 system configuration options. If the PARM1 field is found within this file, it overrides the data that is specified in the XP PARM field that is listed on the panel.
      +Valid when: job-type is XPJOB or AGENT
      +Limits: 1 to 16 alphanumeric characters. If this field starts with a numeric value, the value is treated as a JCL Index value (0 - 253 or 256 - 999), and the associated numbered JCL library, as defined in the initialization file JCL statement, is used. If the first character is not numeric, the field must start with an ampersand (&) and must denote the library variable as defined using a /JCL command.
      +Note: Specifying data in the PARMLIB/MEMBER fields is in addition to anything specified in the XPPARM field. If XPPARM is coded, and if the PARMLIB/Member contains a PARM1 statement, the PARMLIB specification overrides the XP PARM field. Thus, if both XPPARM and PARMLIB PARM1 fields contain data, the data that is obtained from the PARMLIB/MEMBER is used in the data that is transmitted to the target node
    • +
    +
  • +
  • +

    --member (string)

    +
      +
    • (Optional) Indicates the PDS member name in the parmlib library where the parameters for this job reside.
      +Valid when: job-type is XPJOB or AGENT
      +Default: Same as the job property
      +Limits: 1 to 8 alphanumeric characters, beginning with an alphabetic character
    • +
    +
  • +
  • +

    --sutype (string)

    +
      +
    • (Optional) Specifies the type of "switch user" command to execute at the UNIX target node.
      +Valid when: job-type is XPJOB
      +Default: Y
      +Valid values are:
      +Y = Executes an "SU -" causing the environment setup to include execution of the ".PROFILE" for the target userN = Executes an "SU" command without the profile option
    • +
    +
  • +
  • +

    --xp-trace | --xt (string)

    +
      +
    • (Optional) Indicates whether to trace the activity that is associated with this job as it moves through the queues.
      +Valid when: job-type is XPJOB
      +Default: N
      +Valid values are:
      +Y = Issue WTOs as the job enters into the submission process. Retain up to 256 characters of the data that is sent for inclusion in a log recordN = Do not activate tracing for this job
    • +
    +
  • +
  • +

    --agent-job-type | --ajt (string)

    +
      +
    • (Required when job-type is AGENT) Defines the type of agent job. For more information about the Agent job types see:
      +[CA 7 Documentation](https://techdocs.broadcom.com/us/en/ca-mainframe-software/automation/ca-workload-automation-ca-7-edition/12-1/configuring/interfaces/cross-platform-scheduling/ca-workload-automation-agents/ca-7-agent-job-types.html/)
      +Valid when: job-type is AGENT
      +Default: There is no default value
      +Valid values are:
      +UNIX_JOB - Generic UNIXNT_JOB - Microsoft WindowsFILE_TRIGGER - File TriggerFTP_JOB - FTPSCP_JOB - Secure CopySFTP_JOB - Secure File TransferBDC_JOB - SAP Batch Input SessionBWIP_JOB - SAP Business Warehouse InfoPackageBWPC_JOB - SAP Business Warehouse Process ChainSAP_JOB - SAP GenericSAPA_JOB - SAP ArchiveSAPE_JOB - SAP Event MonitorSAPM_JOB - SAP Process MonitorPS_JOB - PeopleSoftOA_JOB - Oracle RequestOAC_JOB - Oracle CopyCPU_MON - CPU MonitorDISK_MON - Disk MonitorIP_MON - IP MonitorPROCESS_MON - Process MonitorTEXT_MON - Text File MonitorEVENTLOG_MON - Event Log MonitorSERVICE_MON - Service MonitorSQL_JOB - Database SQLDBSP_JOB - Database Stored ProcedureDB_MON - Database MonitorDB_TRIG - Database TriggerAS400_JOB - AS400/OS400JMSP_JOB - J2EE JMS PublishJMSS_JOB - J2EE JMS SubscribeEJBE_JOB - J2EE Entity BeanHTTP_JOB - J2EE HTTP/ServletPOJO_JOB - J2EE POJORMI_JOB - J2EE RMIEJB_JOB - J2EE Session BeanJMXB_JOB - JMX-Mbean Attribute GetJMXA_JOB - JMX-Mbean Attribute SetJMXO_JOB - JMX-Mbean OperationJMXS_JOB - JMX-Mbean SubscribeJMXN_JOB - JMX-Mbean Create InstanceJMXR_JOB - JMX-Mbean Remove InstanceSNPG_JOB - SNMP Get AttributeSNPS_JOB - SNMP Set AttributeSNPC_JOB - SNMP SubscribeSNPE_JOB - SNMP TrapSendWEB_SERV - Web ServicesWOL_JOB - Wake-On-LANPROXY_JOB - Remote ExecutionNONSTOP_JOB - HP Integrity NonStop
    • +
    +
  • +
  • +

    --agent (string)

    +
      +
    • (Required when job-type is AGENT) Identifies the explicit distributed platform where the job is to run.
      +Valid when: job-type is AGENT
      +Limits: 1 to 16 alphanumeric characters. The value must be defined to CA 7 using the IASAGENT DD statement
    • +
    +
  • +
  • +

    --agent-user | --au (string)

    +
      +
    • (Optional) Defines the user ID that is passed to the distributed platform where the job is to run.
      +Valid when: job-type is AGENT
      +Limits: 1 to 128 alphanumeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    creates a job named JOBA:

    +
      +
    • zowe ca7 job-definition create-job --job JOBA --job-type CPU --execute Y --use-jcl-override-library Y --do-not-schedule-before-date 11032 --do-not-schedule-before-time 1100 --do-not-schedule-after-date 11365 --do-not-schedule-after-time 1359
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-resource-count-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-resource-count-resource.html new file mode 100644 index 0000000000..e7cf43f986 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-resource-count-resource.html @@ -0,0 +1,168 @@ + + + + +ca7 job-definition create-resource-count-resource + + +
+

zoweca7job-definitioncreate-resource-count-resource

+

Add Resource Count Resource

+

Usage

+

zowe ca7 job-definition create-resource-count-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 39 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
  • +

    --resource-count | --rc (string)

    +
      +
    • Specifies the number of occurrences of the resource that the job uses.
      +Limits: 1 to 4 numeric characters from 0 through 9999
    • +
    +
  • +
  • +

    --free (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Valid values are:
      +A = Specifies the resource count is only decremented when the job abendsF = Specifies the resource count is decremented when the job completes, either successfully or unsuccessfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes, either successfully or unsuccessfullyN = Specifies the resource count is not decremented when the job completes. The PRSCF command can be used to decrement the resource count. A cancel of the job also decrements the resource countY = Specifies the resource count is decremented when the job or step ends successfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes successfully (does not abend)
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --step-name | --sn (string)

    +
      +
    • (Optional) Specifies the resource is freed at the conclusion of the named job step.
      +Limits: 1 to 8 alphanumeric characters
      +Notes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBA with resource name RESOURCE.NAME of free type F, step name JS010 and schedule id 23:

    +
      +
    • zowe ca7 job-definition create-resource-count-resource --job JOBA --schid 23 --rn RESOURCE.NAME --free F --sn JS010
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-shared-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-shared-resource.html new file mode 100644 index 0000000000..0ba9207505 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-shared-resource.html @@ -0,0 +1,161 @@ + + + + +ca7 job-definition create-shared-resource + + +
+

zoweca7job-definitioncreate-shared-resource

+

Post Shared Resource

+

Usage

+

zowe ca7 job-definition create-shared-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
  • +

    --free (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Valid values are:
      +A = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfullyN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resourceY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --step-name | --sn (string)

    +
      +
    • (Optional) Specifies the resource is freed at the conclusion of the named job step.
      +Limits: 1 to 8 alphanumeric characters
      +Notes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBAA with resource name SCHENV.VARNAME:

    +
      +
    • zowe ca7 job-definition create-shared-resource --job JOBAA --rn SCHENV.VARNAME --free A
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-variable-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-variable-resource.html new file mode 100644 index 0000000000..6807f108cb --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_create-variable-resource.html @@ -0,0 +1,145 @@ + + + + +ca7 job-definition create-variable-resource + + +
+

zoweca7job-definitioncreate-variable-resource

+

Add Variable Resource

+

Usage

+

zowe ca7 job-definition create-variable-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: "SCHENV." followed by 1 to 16 alphanumeric and @, #, $, _ characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBAA with resource name SCHENV.VARNAME and schedule id 23:

    +
      +
    • zowe ca7 job-definition create-variable-resource --job JOBAA --schid 23 --rn SCHENV.VARNAME
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-address-space-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-address-space-resource.html new file mode 100644 index 0000000000..34049b8fe9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-address-space-resource.html @@ -0,0 +1,145 @@ + + + + +ca7 job-definition delete-address-space-resource + + +
+

zoweca7job-definitiondelete-address-space-resource

+

Delete Address Space Resource

+

Usage

+

zowe ca7 job-definition delete-address-space-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deletes a job named JOBA with resource name RESOURCE.NAME:

    +
      +
    • zowe ca7 job-definition delete-address-space-resource --job JOBA --rn RESOURCE.NAME --schid 42
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-corequisite-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-corequisite-resource.html new file mode 100644 index 0000000000..37a334f492 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-corequisite-resource.html @@ -0,0 +1,151 @@ + + + + +ca7 job-definition delete-corequisite-resource + + +
+

zoweca7job-definitiondelete-corequisite-resource

+

Delete Corequisite Resource

+

Usage

+

zowe ca7 job-definition delete-corequisite-resource [options]

+

Required Options

+
    +
  • +

    --job-name | --jn (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be nonblank, and no embedded blanks
      +Exception: If the resource connection is made to a resource count resource,
      +the resource name can be from 1 to 39 characters followed by a / (slash) and
      +a 1 through 4 numeric value indicating the number of occurrences for the resource that the job uses.
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied.
      +A zero default cannot be specified for one connection and a nonzero schedule ID used for
      +a subsequent connection to the same job with the same user requirement description.
      +An attempt to make such a connection results in an error message that is issued.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deletes a job named JOBA with resource name RESOURCE.NAME and schid 42:

    +
      +
    • zowe ca7 job-definition delete-corequisite-resource --jn JOBA --rn RESOURCE.NAME --schid 42
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-exclusive-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-exclusive-resource.html new file mode 100644 index 0000000000..69597c6e80 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-exclusive-resource.html @@ -0,0 +1,145 @@ + + + + +ca7 job-definition delete-exclusive-resource + + +
+

zoweca7job-definitiondelete-exclusive-resource

+

Delete Exclusive Resource

+

Usage

+

zowe ca7 job-definition delete-exclusive-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deletes a job named JOBA with resource name RESOURCE.NAME:

    +
      +
    • zowe ca7 job-definition delete-exclusive-resource --job JOBA --rn RESOURCE.NAME --schid 42
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-job-trigger-successor.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-job-trigger-successor.html new file mode 100644 index 0000000000..22611cbd4a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-job-trigger-successor.html @@ -0,0 +1,145 @@ + + + + +ca7 job-definition delete-job-trigger-successor + + +
+

zoweca7job-definitiondelete-job-trigger-successor

+

Delete Job Trigger

+

Usage

+

zowe ca7 job-definition delete-job-trigger-successor [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name whose successful completion causes triggering.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --triggered-job | --tj (string)

    +
      +
    • Specifies the job name that the completion of the triggering job triggers.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.
      +Default: 0 (all schedule IDs)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a Job Trigger JOBB from the definition of JOBA:

    +
      +
    • zowe ca7 job-definition delete-job-trigger-successor --job JOBA --tj JOBB
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-job.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-job.html new file mode 100644 index 0000000000..bb27038643 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-job.html @@ -0,0 +1,142 @@ + + + + +ca7 job-definition delete-job + + +
+

zoweca7job-definitiondelete-job

+

Delete Job Definition

+

Usage

+

zowe ca7 job-definition delete-job [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • The type of deletion.
      +Valid values are:
      +DELETE
      +Deletes a job and its associated data from the database (documentation, schedules, and so forth).DD
      +Same as DELETE, but deletes any data sets that this job references if the data sets have no users and
      +no documentation, and do not cause job triggering.
      +This includes all virtual resources that are connected to the job.PURGE
      +Same as DD, but also deletes job trigger definitions that trigger the job being deleted,
      +job requirement definitions that require the job being deleted;
      +and, if the WA Restart Option interface is active, deletes the WA Restart Option
      +CMT member for the job being deleted.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete Job named JOBA:

    +
      +
    • zowe ca7 job-definition delete-job --job JOBA --type DELETE
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-resource-count-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-resource-count-resource.html new file mode 100644 index 0000000000..c3797181bf --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-resource-count-resource.html @@ -0,0 +1,145 @@ + + + + +ca7 job-definition delete-resource-count-resource + + +
+

zoweca7job-definitiondelete-resource-count-resource

+

Delete Resource Count Resource

+

Usage

+

zowe ca7 job-definition delete-resource-count-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 39 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deletes a job named JOBA with resource name RESOURCE.NAME:

    +
      +
    • zowe ca7 job-definition delete-resource-count-resource --job JOBA --rn RESOURCE.NAME --schid 42
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-shared-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-shared-resource.html new file mode 100644 index 0000000000..ca18d6651b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-shared-resource.html @@ -0,0 +1,145 @@ + + + + +ca7 job-definition delete-shared-resource + + +
+

zoweca7job-definitiondelete-shared-resource

+

Delete Shared Resource

+

Usage

+

zowe ca7 job-definition delete-shared-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deletes a job named JOBAA with resource name SCHENV.VARNAME:

    +
      +
    • zowe ca7 job-definition delete-shared-resource --job JOBAA --schid 23 --rn SCHENV.VARNAME
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-variable-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-variable-resource.html new file mode 100644 index 0000000000..f551f1a4c7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_delete-variable-resource.html @@ -0,0 +1,145 @@ + + + + +ca7 job-definition delete-variable-resource + + +
+

zoweca7job-definitiondelete-variable-resource

+

Delete Variable Resource

+

Usage

+

zowe ca7 job-definition delete-variable-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: "SCHENV." followed by 1 to 16 alphanumeric and @, #, $, _ characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deletes a job named JOBAA with resource name SCHENV.VARNAME:

    +
      +
    • zowe ca7 job-definition delete-variable-resource --job JOBAA --schid 23 --rn SCHENV.VARNAME
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_list-job-trigger-successor.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_list-job-trigger-successor.html new file mode 100644 index 0000000000..250fd51452 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_list-job-trigger-successor.html @@ -0,0 +1,135 @@ + + + + +ca7 job-definition list-job-trigger-successor + + +
+

zoweca7job-definitionlist-job-trigger-successor

+

Get Job Trigger Successor

+

Usage

+

zowe ca7 job-definition list-job-trigger-successor [options]

+

Required Options

+
    +
  • +

    --jobname | --job (string)

    +
      +
    • The CA 7 job name
    • +
    +
  • +
+

Options

+
    +
  • +

    --databasename | --db (string)

    +
      +
    • The CA 7 database name
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get a list of the triggered jobs for JOBA:

    +
      +
    • zowe ca7 job-definition list-job-trigger-successor --job JOBA
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_list-job.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_list-job.html new file mode 100644 index 0000000000..37e40809f9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_list-job.html @@ -0,0 +1,141 @@ + + + + +ca7 job-definition list-job + + +
+

zoweca7job-definitionlist-job

+

List Job Definiton

+

Usage

+

zowe ca7 job-definition list-job [options]

+

Required Options

+
    +
  • +

    --jobname | --jn (string)

    +
      +
    • The CA 7 job name
    • +
    +
  • +
  • +

    --all (boolean)

    +
      +
    • Fetch all the available properties
    • +
    +
  • +
+

Options

+
    +
  • +

    --databasename | --db (string)

    +
      +
    • The CA 7 database name
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Lists details of job named JOBA:

    +
      +
    • zowe ca7 job-definition list-job --jobname JOBA --all true
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-address-space-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-address-space-resource.html new file mode 100644 index 0000000000..f7ec7684cc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-address-space-resource.html @@ -0,0 +1,154 @@ + + + + +ca7 job-definition update-address-space-resource + + +
+

zoweca7job-definitionupdate-address-space-resource

+

Modify Address Space Resource

+

Usage

+

zowe ca7 job-definition update-address-space-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --ready-when | --rw (string)

    +
      +
    • (Optional) Determines how VRM manages resource availability at job submission and job/step completion.
      +Default: A
      +Valid values are:
      +A = Specifies the job is submitted only if the resource is active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the systemI = Specifies the job is submitted only if the resource is not active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the system
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates a job named JOBA with resource name RESOURCE.NAME, schedule id 42 and job is submitted only if the resource is not active:

    +
      +
    • zowe ca7 job-definition update-address-space-resource --job JOBA --rn RESOURCE.NAME --rw I--schid 42
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-corequisite-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-corequisite-resource.html new file mode 100644 index 0000000000..a0b45b9ddc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-corequisite-resource.html @@ -0,0 +1,162 @@ + + + + +ca7 job-definition update-corequisite-resource + + +
+

zoweca7job-definitionupdate-corequisite-resource

+

Modify Corequisite Resource

+

Usage

+

zowe ca7 job-definition update-corequisite-resource [options]

+

Required Options

+
    +
  • +

    --job-name | --jn (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be nonblank, and no embedded blanks
      +Exception: If the resource connection is made to a resource count resource,
      +the resource name can be from 1 to 39 characters followed by a / (slash) and
      +a 1 through 4 numeric value indicating the number of occurrences for the resource that the job uses.
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied.
      +A zero default cannot be specified for one connection and a nonzero schedule ID used for
      +a subsequent connection to the same job with the same user requirement description.
      +An attempt to make such a connection results in an error message that is issued.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --ready-when | --rw (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Default: A
      +Valid values are:
      +A
      +Specifies the job is submitted only if the resource is active (as established by the PRSQA command).I
      +Specifies the job is submitted only if the resource is not active.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates a job named JOBA with resource name RESOURCE.NAME, schedule id 42 and job is submitted only if the resource is not active:

    +
      +
    • zowe ca7 job-definition update-corequisite-resource --jn JOBA --rn RESOURCE.NAME --schid 42 --rw I
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-exclusive-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-exclusive-resource.html new file mode 100644 index 0000000000..04c0d1a9f2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-exclusive-resource.html @@ -0,0 +1,161 @@ + + + + +ca7 job-definition update-exclusive-resource + + +
+

zoweca7job-definitionupdate-exclusive-resource

+

ExclusiveResource

+

Usage

+

zowe ca7 job-definition update-exclusive-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
  • +

    --free (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Valid values are:
      +A = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfullyN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resourceY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --step-name | --sn (string)

    +
      +
    • (Optional) Specifies the resource is freed at the conclusion of the named job step.
      +Limits: 1 to 8 alphanumeric characters
      +Notes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates a job named JOBA with resource name RESOURCE.NAME, of free type F, and schedule id 42 to job with step name JS011:

    +
      +
    • zowe ca7 job-definition update-exclusive-resource --job JOBA --rn RESOURCE.NAME --free F --sn JS011 --schid 42
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-job-trigger-successor.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-job-trigger-successor.html new file mode 100644 index 0000000000..ad736e0344 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-job-trigger-successor.html @@ -0,0 +1,194 @@ + + + + +ca7 job-definition update-job-trigger-successor + + +
+

zoweca7job-definitionupdate-job-trigger-successor

+

Modify Job Trigger Successor

+

Usage

+

zowe ca7 job-definition update-job-trigger-successor [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name whose successful completion causes triggering.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --triggered-job | --tj (string)

    +
      +
    • Specifies the job name that the completion of the triggering job triggers.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.
      +Default: 0 (all schedule IDs)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --triggered-job-schid | --tjs (string)

    +
      +
    • (Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.
      +Default: 0 (no replacement)
      +Limits: 1 to 3 numeric characters from 0 through 999
      +Note: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.
    • +
    +
  • +
  • +

    --triggered-job-due-out-time | --tjdot (string)

    +
      +
    • (Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-queue-time must be omitted.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.
      +Note: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.
    • +
    +
  • +
  • +

    --triggered-job-queue-time | --tjqt (string)

    +
      +
    • (Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.
      +If this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.
      +Deadline time is calculated as current date/time plus queue time.
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-lead-time | --tjlt (string)

    +
      +
    • (Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.
      +Default: 0000
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
      +The mm can be 00 through 59, the highest value being 2400.
    • +
    +
  • +
  • +

    --triggered-job-submit-time | --tjst (string)

    +
      +
    • +

      (Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.
      +The triggered-job-submit-time is always rounded down to 15-minute increments.
      +Default: 0 (no specific submit time requirement)
      +Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.

      +

      If triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates the Job JOBA having Triggered JOBB with triggered-job-due-out-time with addition of triggered-job-lead-time to 0030 and triggered-job-submit-time to 1030:

    +
      +
    • zowe ca7 job-definition update-job-trigger-successor --job JOBA --tj JOBB --tjdot 0830 --tjlt 0030 --tjst 1030
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-job.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-job.html new file mode 100644 index 0000000000..5d4a8d6705 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-job.html @@ -0,0 +1,581 @@ + + + + +ca7 job-definition update-job + + +
+

zoweca7job-definitionupdate-job

+

JobDefinition

+

Usage

+

zowe ca7 job-definition update-job [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job
    • +
    +
  • +
  • +

    --job-type | --jt (string)

    +
      +
    • The type of job.
      +Valid values are:
      +CPU = A CPU jobXPJOB = A cross-platform jobAGENT = An Agent job
    • +
    +
  • +
+

Options

+
    +
  • +

    --long-name | --ln (string)

    +
      +
    • (Optional) Defines the long job name.
      +Limits: 1 to 64 alphanumeric characters, case sensitive
    • +
    +
  • +
  • +

    --system (string)

    +
      +
    • (Optional) Specifies the user-defined application system name of which this job is a part.
      +Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma
    • +
    +
  • +
  • +

    --uid (string)

    +
      +
    • (Optional) Specifies the CA 7 user security identification.
      +Default: 0 (no internal security protection)
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --jobnet (string)

    +
      +
    • (Optional) Specifies the name of a CPU job network of which this job is a part.
      +Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma
    • +
    +
  • +
  • +

    --owner (string)

    +
      +
    • (Optional) Specifies the ID identifying ownership of this job. Depending on the startup options taken, the external security product being used and contents of the JCL, this value can be offered to the external security package by CA 7 at job submission time as the authority for this job to be executed.
      +Limits: 1 to 8 alphanumeric characters. Although this field supports up to 8 characters, some external security packages only accept up to 7 characters. This field must not exceed any such limit that exists
    • +
    +
  • +
  • +

    --jcl-member | --jm (string)

    +
      +
    • (Optional) Specifies the JCL library member name and required when the member name and job name are different.
      +Valid when: job-type is CPU
      +Default: Job name
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --id (string)

    +
      +
    • (Optional) Specifies a numeric index value that is associated with a JCL library where the JCL member is located. NOTE: the id and lib properties are mutually exclusive.
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0-253 or 256-999
    • +
    +
  • +
  • +

    --lib (string)

    +
      +
    • (Optional) Specifies a JCL library identification consisting of a symbolic INDEX assigned to a JCL statement. NOTE: the id and lib properties are mutually exclusive.
      +Valid when: job-type is CPU
      +Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)
    • +
    +
  • +
  • +

    --reload (string)

    +
      +
    • (Optional) Specifies whether to reload the JCL of this job. When a job comes into the request queue, it is either flagged for load processing or it is not flagged.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = The job is flagged for load processing. The reload flag is automatically reset to N once the load completes successfullyN = The job is not flagged for load processing unless it is the first time it has run in CA 7X = The job is only flagged for load processing when the LOAD command is used and is never automatically changed even if the LOAD command is used
    • +
    +
  • +
  • +

    --execute (string)

    +
      +
    • (Optional) Indicates whether to execute this job.
      +Default: Y
      +Valid values are:
      +Y = The job will be executedN = The job does not run but shows a normal completion as if it did run. JCL is not required for non-executable jobs
    • +
    +
  • +
  • +

    --retain (string)

    +
      +
    • (Optional) Specifies whether to retain the execution JCL in the trailer queue after a successful run.
      +Valid when: job-type is CPU or XPJOB
      +Default: N
      +Valid values are:
      +Y = Retain the JCL in the trailer queue after a successful run.N = Do not retain the JCL in the trailer queue after a successful run
    • +
    +
  • +
  • +

    --hold (string)

    +
      +
    • (Optional) Specifies whether to place this job in a hold status when it enters the request queue.
      +Default: N
      +Valid values are:
      +Y = The job will be heldN = The job will not be held
    • +
    +
  • +
  • +

    --jcl-override | --jo (string)

    +
      +
    • (Optional) Specifies whether this job needs manual JCL overrides before it can be submitted. Similar to the JCLOVRD command.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = The job needs manual JCL overrides before it can be submittedN = The job does not need manual JCL overrides before it can be submitted
    • +
    +
  • +
  • +

    --use-jcl-override-library | --ujol (string)

    +
      +
    • (Optional) Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only. This field is automatically set back to N the next time the job comes into the request queue.
      +Default: N
      +Valid values are:
      +Y = The JCL is retrieved from the JCL Override library for the next runN = The JCL is not retrieved from the JCL Override library for the next run
    • +
    +
  • +
  • +

    --verify (string)

    +
      +
    • (Optional) Specifies whether this job requires any pre-submission manual verification. Similar to VERIFY command.
      +Default: N
      +Valid values are:
      +Y = The job requires any pre-submission manual verificationN = The job does not require any pre-submission manual verification
    • +
    +
  • +
  • +

    --maintenance | --maint (string)

    +
      +
    • (Optional) Specifies whether this job is a maintenance job (for example, a system utility) with no production data set requirements. If Y is specified, all input data set requirements are ignored. None of the output data sets created by this job is posted back to CA 7.
      +Marking a job as maintenance enables job triggering but not data set triggering.
      +Also, if the LOADDSNS keyword is used on the DBASE statement in the initialization file, the LOAD process does not build any DD or data set information for jobs that are marked as maintenance. This means that there are not any data set connections for these jobs unless added manually.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = The job is a maintenance jobN = The job is not a maintenance job
    • +
    +
  • +
  • +

    --job-requirement-lead-time | --jrlt (string)

    +
      +
    • (Optional) Specifies the number of hours to be considered when satisfying job-dependent requirements.
      +Default: 0
      +Valid values are:
      +0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each predecessor job must complete typically while this job is in the request queuenn = Since the last run of this job, specifies that each predecessor job must have run within the last nn hours. Values for nn can be from 1 to 98
    • +
    +
  • +
  • +

    --dataset-requirement-lead-time | --drlt (string)

    +
      +
    • (Optional) Specifies the number of hours to be considered when satisfying data set requirements.
      +Valid when: job-type is CPU
      +Default: 0
      +Valid values are:
      +0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each data set requirement must be satisfied typically while this job is in the request queuenn = Since the last run of this job, specifies that each data set requirement must be satisfied within the last nn hours. Values for nn can be from 1 to 98
    • +
    +
  • +
  • +

    --arfset (string)

    +
      +
    • (Optional) Names the collection of ARF definitions that apply to this job. Remember that ARF recovery is not invoked for non-executable jobs.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --mainid (string)

    +
      +
    • (Optional) Specifies on which CPU the job can or cannot be scheduled. If the job requirements impose CPU restrictions, specify SYn or /SYn where n is the system number and / indicates not this system. System numbers must be consistent with the initialization file CPU statement MAINIDS parameters.
      +Valid when: job-type is CPU
      +Default: ALL (lets the job run on any CPU)
      +Limits: 1 to 4 alphanumeric characters
    • +
    +
  • +
  • +

    --insert-ca11-rms | --icr (string)

    +
      +
    • (Optional) Specifies whether to insert the WA Restart Option RMS step automatically at execution time by CA 7.
      +Valid when: job-type is CPU
      +Default: N
      +Valid values are:
      +Y = Inserts the step with the WA Restart Option processing code of PN = Does not insert the RMS step
    • +
    +
  • +
  • +

    --condition-code | --cc (string)

    +
      +
    • (Optional) Used with relational-operator property to define the job-level condition codes used to determine whether a job executes successfully.
      +Valid when: job-type is CPU or XPJOB
      +Note: All condition codes that are returned from an XPJOB job are treated as positive values. Any negative value returned is converted to an absolute (positive) value
      +Default: 0
      +Limits: For job-type = CPU: 1 to 4 numeric characters in the range 0-4095
      +For job-type = "XPJOB": 1 to 4 numeric characters in the range 0-9999
    • +
    +
  • +
  • +

    --relational-operator | --ro (string)

    +
      +
    • (Optional) Specifies the relational operator of the condition-code property or if the step level #SCC statements are being used in the job's JCL.
      +Valid when: job-type is CPU or XPJOB
      +Default: 0
      +Valid values are:
      +EQ = Equal toLT = Less thanGT = Greater thanGE = Greater than or equal toLE = Less than or equal toNE = Not equal to#S = Make step condition code tests based on #SCC statements in the JCLIG = Make no evaluation of the job. CA 7 always assumes the job completes successfully, regardless of condition codes, abend codes, or runtime JCL errors. When this is used, the insert-ca11-rms property should be N0 = No condition test will be madeNOTE: If 0 is used, no test is made on the job's condition code. The highest condition code that this job generates is tested by this pair of parameters. For example, if condition-code is set at 8 and RO is set at LT, the job is marked as completing abnormally if 8 is less than the job's highest condition code
    • +
    +
  • +
  • +

    --do-not-schedule-before-date | --dnsbd (string)

    +
      +
    • (Optional) Specifies not to schedule this job before this date (in YYDDD format, or 00000)
    • +
    +
  • +
  • +

    --do-not-schedule-before-time | --dnsbt (string)

    +
      +
    • (Optional) Specifies not to schedule this job before this time (in HHMM format)
    • +
    +
  • +
  • +

    --do-not-schedule-after-date | --dnsad (string)

    +
      +
    • (Optional) Specifies not to schedule this job after this date (in YYDDD format, or 99999)
    • +
    +
  • +
  • +

    --do-not-schedule-after-time | --dnsat (string)

    +
      +
    • (Optional) Specifies not to schedule this job after this time (in HHMM format)
    • +
    +
  • +
  • +

    --lterm (string)

    +
      +
    • (Optional) Routes the messages about this job to this logical terminal name.
      +Default: If not entered, the LTERM associated with the JCL library in the initialization file JCL statement is used. If LTERM is not specified on the JCL statement, the default is MASTER
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --list-requirements | --lr (string)

    +
      +
    • (Optional) Specifies whether to list pre-execution requirements for this job when it enters the request queue.
      +Default: Y
      +Valid values are:
      +Y = The pre-execution requirements will be listedN = The pre-execution requirements will not be listed
    • +
    +
  • +
  • +

    --prompts (string)

    +
      +
    • (Optional) Specifies whether to issue prompt messages when this job is late.
      +Default: Y
      +Valid values are:
      +Y = Prompt messages will be issued when the job is lateN = Prompt messages will not be issued when the job is late
    • +
    +
  • +
  • +

    --requirements-not-used | --rnu (string)

    +
      +
    • (Optional) Specifies whether to issue error messages for job requirements not used.
      +Default: Y
      +Valid values are:
      +Y = Messages will be issued if requirements are not usedN = Messages will not be issued if requirements are not used
    • +
    +
  • +
  • +

    --dsn-not-found | --dnf (string)

    +
      +
    • (Optional) Specifies whether to list error messages for data sets used at execution time but not found in the CA 7 database.
      +Valid when: job-type is CPU
      +Default: Y
      +Valid values are:
      +Y = Messages will be issued if data sets used are not found in the CA 7 databaseN = Messages will not be issued if data sets used are not found in the CA 7 database
    • +
    +
  • +
  • +

    --job-region | --jr (string)

    +
      +
    • (Optional) Specifies the region size that is required by this job (information only).
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 4 numeric characters
    • +
    +
  • +
  • +

    --elapsed-time | --et (string)

    +
      +
    • (Optional) CA 7 maintains certain SMF feedback data in its database, including a weighted average elapsed runtime. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.
      +Default: 0000
      +Limits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59
    • +
    +
  • +
  • +

    --average-cpu-time | --act (string)

    +
      +
    • (Optional) CA 7 maintains weighted average CPU time usage values for each job in its database. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.
      +Valid when: job-type is CPU
      +Default: 0000
      +Limits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59
    • +
    +
  • +
  • +

    --wlb-job-class | --wjc (string)

    +
      +
    • +

      (Optional) Specifies the CA 7 WLB job class. If not specified, a WLB class of A is automatically assigned. This value does not have to match the JOB statement CLASS value.

      +

      NOTE: The value specified here does not apply when the job enters the queue as a result of a RUN(H) command. Class 9 is assigned by default. To override class 9, use the RUNCLASS keyword on the OPTIONS statement in the initialization file.

      +

      NOTE: The value specified here does not apply when the job enters the queue as a result of a LOAD(H) command. Class 8 is assigned by default. To override class 8, use the LOADCLASS keyword on the OPTIONS statement in the initialization file
      +Default: A space
      +Limits: 1 alphanumeric character

      +
    • +
    +
  • +
  • +

    --wlb-priority | --wp (string)

    +
      +
    • (Optional) Specifies the CA 7 WLB job priority. A value of 255 indicates an express priority used to bypass WLB priority scheduling criteria. If using WLB, any job without a specified priority is automatically assigned a priority of 100 unless the default is changed
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0 - 255
    • +
    +
  • +
  • +

    --message-class | --mc (string)

    +
      +
    • (Optional) Specifies the job's message class. This field is informational only. Even though this field can be changed, it does not cause the JCL to be changed. Also, no validity checking is done on this field.
      +Valid when: job-type is CPU
      +Default: A space
      +Limits: 1 alphanumeric character
    • +
    +
  • +
  • +

    --drclass | --dc (string)

    +
      +
    • (Optional) Specifies the job's disaster recovery class. This field has no impact on processing during normal execution. When running in disaster recovery mode, the disaster recovery class is used to determine whether the job should execute.
      +Limits: 1 to 8 alphanumeric characters. Disaster recovery class values must start with a letter, #, or $ (not @) and can include letters, #, $, @, and numbers. Disaster recovery classes cannot contain embedded blanks
    • +
    +
  • +
  • +

    --number-1-tape-man | --n1tm (string)

    +
      +
    • (Optional) Specifies a manual override value for the number of TYPE1 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE1 tape drives.
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0 - 255
    • +
    +
  • +
  • +

    --number-2-tape-man | --n2tm (string)

    +
      +
    • (Optional) Specifies a manual override value for the number of TYPE2 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE2 tape drives.
      +Valid when: job-type is CPU
      +Default: 0
      +Limits: 1 to 3 numeric characters in the range 0 - 255
    • +
    +
  • +
  • +

    --xp-node | --xn (string)

    +
      +
    • (Required when job-type is XPJOB) Defines the CAICCI node to which the execution of this job is targeted. This field should state the primary node. If this node is unavailable and the node definition has alternate nodes defined, the execution of this job can be directed to an alternate node.
      +Valid when: job-type is XPJOB
      +Limits: 1 to 44 alphanumeric characters, although current z/OS CAICCI restricts this name to eight characters
    • +
    +
  • +
  • +

    --xp-exec | --xe (string)

    +
      +
    • (Required when job-type is XPJOB) Defines the executable (file, command) to execute at the targeted cross-platform node. If the targeted platform is a mainframe scheduling system such as CA 7, this value indicates the job name to execute on that platform. If the targeted platform is Workload Automation AE system, this value indicates a job that is defined in the Workload Automation AE system. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. Otherwise, the field is passed to the target system as-is and in its entirety. This value includes any embedded blanks and quotation marks.
      +Valid when: job-type is XPJOB
      +Limits: Up to 244 alphanumeric characters, and file delimiters of forward slash (/) and backward slash (\) signs. Note: Each backward slash character must be escaped by specifying (\\)
    • +
    +
  • +
  • +

    --xp-parm | --xp (string)

    +
      +
    • (Optional) Defines up to 128 bytes of parameter data to pass to the file or command being executed on the alternate platform. This data is supplied as PARM1 to the data being transmitted to the alternate platform. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. This value may be overridden if the PARMLIB/MEMBER field PARM1 is coded.
      +Valid when: job-type is XPJOB
      +Limits: Up to 128 EBCDIC characters
    • +
    +
  • +
  • +

    --parmlib | --pl (string)

    +
      +
    • (Optional) Defines extra, optional indexed, or symbolic (PDS) library from where execution data to be associated with this job can be found. This information is typically PARM1 through PARM64 keywords but can vary based on CA 7 system configuration options. If the PARM1 field is found within this file, it overrides the data that is specified in the XP PARM field that is listed on the panel.
      +Valid when: job-type is XPJOB or AGENT
      +Limits: 1 to 16 alphanumeric characters. If this field starts with a numeric value, the value is treated as a JCL Index value (0 - 253 or 256 - 999), and the associated numbered JCL library, as defined in the initialization file JCL statement, is used. If the first character is not numeric, the field must start with an ampersand (&) and must denote the library variable as defined using a /JCL command.
      +Note: Specifying data in the PARMLIB/MEMBER fields is in addition to anything specified in the XPPARM field. If XPPARM is coded, and if the PARMLIB/Member contains a PARM1 statement, the PARMLIB specification overrides the XP PARM field. Thus, if both XPPARM and PARMLIB PARM1 fields contain data, the data that is obtained from the PARMLIB/MEMBER is used in the data that is transmitted to the target node
    • +
    +
  • +
  • +

    --member (string)

    +
      +
    • (Optional) Indicates the PDS member name in the parmlib library where the parameters for this job reside.
      +Valid when: job-type is XPJOB or AGENT
      +Default: Same as the job property
      +Limits: 1 to 8 alphanumeric characters, beginning with an alphabetic character
    • +
    +
  • +
  • +

    --sutype (string)

    +
      +
    • (Optional) Specifies the type of "switch user" command to execute at the UNIX target node.
      +Valid when: job-type is XPJOB
      +Default: Y
      +Valid values are:
      +Y = Executes an "SU -" causing the environment setup to include execution of the ".PROFILE" for the target userN = Executes an "SU" command without the profile option
    • +
    +
  • +
  • +

    --xp-trace | --xt (string)

    +
      +
    • (Optional) Indicates whether to trace the activity that is associated with this job as it moves through the queues.
      +Valid when: job-type is XPJOB
      +Default: N
      +Valid values are:
      +Y = Issue WTOs as the job enters into the submission process. Retain up to 256 characters of the data that is sent for inclusion in a log recordN = Do not activate tracing for this job
    • +
    +
  • +
  • +

    --agent-job-type | --ajt (string)

    +
      +
    • (Required when job-type is AGENT) Defines the type of agent job. For more information about the Agent job types see:
      +[CA 7 Documentation](https://techdocs.broadcom.com/us/en/ca-mainframe-software/automation/ca-workload-automation-ca-7-edition/12-1/configuring/interfaces/cross-platform-scheduling/ca-workload-automation-agents/ca-7-agent-job-types.html/)
      +Valid when: job-type is AGENT
      +Default: There is no default value
      +Valid values are:
      +UNIX_JOB - Generic UNIXNT_JOB - Microsoft WindowsFILE_TRIGGER - File TriggerFTP_JOB - FTPSCP_JOB - Secure CopySFTP_JOB - Secure File TransferBDC_JOB - SAP Batch Input SessionBWIP_JOB - SAP Business Warehouse InfoPackageBWPC_JOB - SAP Business Warehouse Process ChainSAP_JOB - SAP GenericSAPA_JOB - SAP ArchiveSAPE_JOB - SAP Event MonitorSAPM_JOB - SAP Process MonitorPS_JOB - PeopleSoftOA_JOB - Oracle RequestOAC_JOB - Oracle CopyCPU_MON - CPU MonitorDISK_MON - Disk MonitorIP_MON - IP MonitorPROCESS_MON - Process MonitorTEXT_MON - Text File MonitorEVENTLOG_MON - Event Log MonitorSERVICE_MON - Service MonitorSQL_JOB - Database SQLDBSP_JOB - Database Stored ProcedureDB_MON - Database MonitorDB_TRIG - Database TriggerAS400_JOB - AS400/OS400JMSP_JOB - J2EE JMS PublishJMSS_JOB - J2EE JMS SubscribeEJBE_JOB - J2EE Entity BeanHTTP_JOB - J2EE HTTP/ServletPOJO_JOB - J2EE POJORMI_JOB - J2EE RMIEJB_JOB - J2EE Session BeanJMXB_JOB - JMX-Mbean Attribute GetJMXA_JOB - JMX-Mbean Attribute SetJMXO_JOB - JMX-Mbean OperationJMXS_JOB - JMX-Mbean SubscribeJMXN_JOB - JMX-Mbean Create InstanceJMXR_JOB - JMX-Mbean Remove InstanceSNPG_JOB - SNMP Get AttributeSNPS_JOB - SNMP Set AttributeSNPC_JOB - SNMP SubscribeSNPE_JOB - SNMP TrapSendWEB_SERV - Web ServicesWOL_JOB - Wake-On-LANPROXY_JOB - Remote ExecutionNONSTOP_JOB - HP Integrity NonStop
    • +
    +
  • +
  • +

    --agent (string)

    +
      +
    • (Required when job-type is AGENT) Identifies the explicit distributed platform where the job is to run.
      +Valid when: job-type is AGENT
      +Limits: 1 to 16 alphanumeric characters. The value must be defined to CA 7 using the IASAGENT DD statement
    • +
    +
  • +
  • +

    --agent-user | --au (string)

    +
      +
    • (Optional) Defines the user ID that is passed to the distributed platform where the job is to run.
      +Valid when: job-type is AGENT
      +Limits: 1 to 128 alphanumeric characters
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    updates long name of a job named JOBA to NewJob:

    +
      +
    • zowe ca7 job-definition update-job --job JOBAB --long-name NewJob --job-type CPU
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-resource-count-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-resource-count-resource.html new file mode 100644 index 0000000000..49a0ca1a4d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-resource-count-resource.html @@ -0,0 +1,161 @@ + + + + +ca7 job-definition update-resource-count-resource + + +
+

zoweca7job-definitionupdate-resource-count-resource

+

Modify Resource Count Resource

+

Usage

+

zowe ca7 job-definition update-resource-count-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 39 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
  • +

    --free (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Valid values are:
      +A = Specifies the resource count is only decremented when the job abendsF = Specifies the resource count is decremented when the job completes, either successfully or unsuccessfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes, either successfully or unsuccessfullyN = Specifies the resource count is not decremented when the job completes. The PRSCF command can be used to decrement the resource count. A cancel of the job also decrements the resource countY = Specifies the resource count is decremented when the job or step ends successfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes successfully (does not abend)
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --step-name | --sn (string)

    +
      +
    • (Optional) Specifies the resource is freed at the conclusion of the named job step.
      +Limits: 1 to 8 alphanumeric characters
      +Notes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Updates a job named JOBA with resource name RESOURCE.NAME, of free type F, and schedule id 42 to job with step name JS011:

    +
      +
    • zowe ca7 job-definition update-resource-count-resource --job JOBA --rn RESOURCE.NAME --free F --sn JS011 --schid 42
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-shared-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-shared-resource.html new file mode 100644 index 0000000000..9fea5b8bf7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-definition_update-shared-resource.html @@ -0,0 +1,161 @@ + + + + +ca7 job-definition update-shared-resource + + +
+

zoweca7job-definitionupdate-shared-resource

+

Modify Shared Resource

+

Usage

+

zowe ca7 job-definition update-shared-resource [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies the job name on which the indicated function is performed.
      +Limits: 1 to 8 alphanumeric characters
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the resource name being connected to the job.
      +Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks
    • +
    +
  • +
  • +

    --free (string)

    +
      +
    • Determines how VRM manages resource availability at job submission and job/step completion.
      +Valid values are:
      +A = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfullyN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resourceY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)
    • +
    +
  • +
+

Options

+
    +
  • +

    --schid (string)

    +
      +
    • (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
      +Default: 0, which indicates that the requirement holds for all schedule IDs
      +Limits: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
  • +

    --step-name | --sn (string)

    +
      +
    • (Optional) Specifies the resource is freed at the conclusion of the named job step.
      +Limits: 1 to 8 alphanumeric characters
      +Notes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creates a job named JOBAA with resource name SCHENV.VARNAME:

    +
      +
    • zowe ca7 job-definition update-shared-resource --job JOBAA --rn SCHENV.VARNAME --free A
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-instance.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-instance.html new file mode 100644 index 0000000000..74c9c3084a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-instance.html @@ -0,0 +1,20 @@ + + + + +ca7 job-instance + + +
+

zoweca7job-instance

+

All the available commands listed in the Job Instance section.

+

Usage

+

zowe ca7 job-instance <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_job-instance_list-waiting-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_job-instance_list-waiting-resource.html new file mode 100644 index 0000000000..2d60b91fb9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_job-instance_list-waiting-resource.html @@ -0,0 +1,138 @@ + + + + +ca7 job-instance list-waiting-resource + + +
+

zoweca7job-instancelist-waiting-resource

+

List waiting Resource

+

Usage

+

zowe ca7 job-instance list-waiting-resource [options]

+

Options

+
    +
  • +

    --job (string)

    +
      +
    • (Optional) Specifies a fully qualified or generic job name.
      +* - Specifies all jobs.
      +job - Specifies a fully qualified job name
      +Limits:: 1 to 8 alphanumeric characters
      +job - Specifies multiple jobs that a generic job name specifies.
      +Limits:: 1 to 7 alphanumeric characters that are terminated with an asterisk.
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • (Optional) A SCHID value of 0 applies to connections for all schedules and
      +therefore is listed with connections for any schedule ID requested. Default:: Null (causes connections for all schedule IDs to appear)Limits:: 1 to 3 numeric characters from 0 through 999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    TODO:

    +
      +
    • zowe ca7 job-instance list-waiting-resource TODO
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition.html new file mode 100644 index 0000000000..01af0b01ce --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition.html @@ -0,0 +1,28 @@ + + + + +ca7 list-job-definition + + +
+

zoweca7list-job-definition

+

All the available commands are listed in the COMMANDS section.

+

Usage

+

zowe ca7 list-job-definition <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_job.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_job.html new file mode 100644 index 0000000000..517b35f60e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_job.html @@ -0,0 +1,151 @@ + + + + +ca7 list-job-definition job + + +
+

zoweca7list-job-definitionjob

+

Get a list of the job definitions for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition job [options]

+

Required Options

+
    +
  • +

    --all (string)

    +
      +
    • +

      all=false

      +

      Fetch all the available properties

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the job defintion information of a job, CA7DB which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition job --all true --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_prose.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_prose.html new file mode 100644 index 0000000000..0867d99d8d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_prose.html @@ -0,0 +1,141 @@ + + + + +ca7 list-job-definition prose + + +
+

zoweca7list-job-definitionprose

+

Get a list of the prose information for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition prose [options]

+

Required Options

+
    +
  • +

    --jobname | -j (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      Defines the name of the jobname for the prose command

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --database | --db (string)

    +
      +
    • +

      db=CA7DB01

      +

      Defines the name of the database for the prose command

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List of the prose information for jobname, TESTJOB01 and database, TESTDB01:

    +
      +
    • zowe ca7 list-job-definition prose --jobname TESTJOB --database TESTDB
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_requirement-predecessor.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_requirement-predecessor.html new file mode 100644 index 0000000000..8faba2a65f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_requirement-predecessor.html @@ -0,0 +1,141 @@ + + + + +ca7 list-job-definition requirement-predecessor + + +
+

zoweca7list-job-definitionrequirement-predecessor

+

Get a list of the predecessors for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition requirement-predecessor [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the predecessor of a job, TESTJOBwhich defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition requirement-predecessor --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_requirement-successor.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_requirement-successor.html new file mode 100644 index 0000000000..8b53293161 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_requirement-successor.html @@ -0,0 +1,141 @@ + + + + +ca7 list-job-definition requirement-successor + + +
+

zoweca7list-job-definitionrequirement-successor

+

Get a list of the successor jobs for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition requirement-successor [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the successor of a job, which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition requirement-successor --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_resource.html new file mode 100644 index 0000000000..3a190b8e39 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_resource.html @@ -0,0 +1,141 @@ + + + + +ca7 list-job-definition resource + + +
+

zoweca7list-job-definitionresource

+

Get a list of the job resources for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition resource [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the resources of a job, TESTJOB which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition resource --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_schedule.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_schedule.html new file mode 100644 index 0000000000..07fe2728f9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_schedule.html @@ -0,0 +1,141 @@ + + + + +ca7 list-job-definition schedule + + +
+

zoweca7list-job-definitionschedule

+

Get a list of the job schedules for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition schedule [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the schedule information of a job, TSETJOB which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition schedule --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_step-dd.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_step-dd.html new file mode 100644 index 0000000000..e63300625b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_step-dd.html @@ -0,0 +1,141 @@ + + + + +ca7 list-job-definition step-dd + + +
+

zoweca7list-job-definitionstep-dd

+

Get a list of the job STEP and DD information for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition step-dd [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the SETP and DD statments of a job, TESTJOB which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition step-dd --db CA7TDB --jobname TESTJOB
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_trigger-predecessor.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_trigger-predecessor.html new file mode 100644 index 0000000000..7563baba94 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_trigger-predecessor.html @@ -0,0 +1,141 @@ + + + + +ca7 list-job-definition trigger-predecessor + + +
+

zoweca7list-job-definitiontrigger-predecessor

+

Get a list of the trigger objects for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition trigger-predecessor [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the trigger predecessor of a job, TESTJOB which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition trigger-predecessor --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_trigger-successor.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_trigger-successor.html new file mode 100644 index 0000000000..7db0925cec --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-definition_trigger-successor.html @@ -0,0 +1,141 @@ + + + + +ca7 list-job-definition trigger-successor + + +
+

zoweca7list-job-definitiontrigger-successor

+

Get a list of the triggered jobs for one or more jobs.

+

Usage

+

zowe ca7 list-job-definition trigger-successor [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the trigger successor of a job, TESTJOB which defined in the CA7DB database:

    +
      +
    • zowe ca7 list-job-definition trigger-successor --db CA7DB --jobname TESTJOB
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-history.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-history.html new file mode 100644 index 0000000000..f8ac1419b9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-history.html @@ -0,0 +1,20 @@ + + + + +ca7 list-job-history + + +
+

zoweca7list-job-history

+

All the available commands are listed in the COMMANDS section.

+

Usage

+

zowe ca7 list-job-history <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • prior-run | pr - Retrieves job information from the prior-run queue
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-history_prior-run.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-history_prior-run.html new file mode 100644 index 0000000000..e92bcc1774 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-history_prior-run.html @@ -0,0 +1,141 @@ + + + + +ca7 list-job-history prior-run + + +
+

zoweca7list-job-historyprior-run

+

Get a list one or more jobs from the prior-run queue.

+

Usage

+

zowe ca7 list-job-history prior-run [options]

+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=TESTJOB01

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Retrieve any job(s) from the prior-runqueue based on these two parameters:

    +
      +
    • zowe ca7 list-job-history prior-run --db CA7DB --jobname TEST%
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance.html new file mode 100644 index 0000000000..30d0650bd3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance.html @@ -0,0 +1,24 @@ + + + + +ca7 list-job-instance + + +
+

zoweca7list-job-instance

+

All the available commands are listed in the COMMANDS section.

+

Usage

+

zowe ca7 list-job-instance <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • active-resource | ar - Display active resources by job. The jobs can be listed generically or with fully qualified job names.
  • +
  • jcl | jcl - Retrieves JCL for a job in the active workload
  • +
  • list | l - Retrieves information about jobs in the active workload
  • +
  • listCustom | lc - Retrieves custom information about jobs in the active workload
  • +
  • requirements | r - Retrieves information about requirements for jobs in the active workload
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_active-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_active-resource.html new file mode 100644 index 0000000000..4e63951680 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_active-resource.html @@ -0,0 +1,136 @@ + + + + +ca7 list-job-instance active-resource + + +
+

zoweca7list-job-instanceactive-resource

+

Display active resources by job.

+

Usage

+

zowe ca7 list-job-instance active-resource [options]

+

Options

+
    +
  • +

    --job (string)

    +
      +
    • Specifies a fully qualified or generic job name.1. Specifies all jobs.
      +2. Specifies a fully qualified job name. Limits:: 1 to 8 alphanumeric characters
      +3. Specifies multiple jobs that a generic job name specifies. Limits:: 1 to 7 alphanumeric characters that are terminated with an asterisk.
    • +
    +
  • +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies a fully qualified or generic resource name. An asterisk indicates a generic request.1. Specifies all resources.
      +2. Specifies a fully qualified resource name. Limits::1 to 44 alphanumeric characters
      +3. Specifies multiple resources that a generic resource name specifies. Limits:: 1 to 43 alphanumeric characters that are terminated with an asterisk
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Display active resources by job RMTESTA1 along with other parameters:

    +
      +
    • zowe ca7 list-job-instance active-resource --job RMTESTA1 --rn A
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_jcl.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_jcl.html new file mode 100644 index 0000000000..ed38407d74 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_jcl.html @@ -0,0 +1,150 @@ + + + + +ca7 list-job-instance jcl + + +
+

zoweca7list-job-instancejcl

+

Displays JCL for a job in the active workload.

+

Usage

+

zowe ca7 list-job-instance jcl [options]

+

Required Options

+
    +
  • +

    --ca7no (string)

    +
      +
    • +

      ca7no=0231

      +

      The CA 7 job number

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --db (string)

    +
      +
    • +

      db=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
  • +

    --showNo (boolean)

    +
      +
    • +

      showNo=true

      +

      Show line numbers in JCL

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Retreives JCL of a CA7 job, CA75TEST (7777) which resided in CA7DB database:

    +
      +
    • zowe ca7 list-job-instance jcl --ca7no 7777 --db CA7DB --showNo true
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_list.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_list.html new file mode 100644 index 0000000000..854a821b87 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_list.html @@ -0,0 +1,158 @@ + + + + +ca7 list-job-instance list + + +
+

zoweca7list-job-instancelist

+

Displays information about jobs in the active workload.

+

Usage

+

zowe ca7 list-job-instance list [options]

+

Options

+
    +
  • +

    --all (boolean)

    +
      +
    • +

      all=False

      +

      Fetch all the available properties
      +If the job number is provided, all the properties will be returned

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --ca7no (string)

    +
      +
    • +

      ca7no=0231

      +

      The CA 7 job number

      +
    • +
    +
  • +
  • +

    --databasename | --db (string)

    +
      +
    • +

      databasename=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=CA7TEST

      +

      The CA 7 job name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List a CA 7 job (7777) information which resided in CA7DB database :

    +
      +
    • zowe ca7 list-job-instance list --all false --ca7no 7777 --db CA7DB --jobname TESTCA7
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_listCustom.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_listCustom.html new file mode 100644 index 0000000000..3a5ea66ed6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_listCustom.html @@ -0,0 +1,1383 @@ + + + + +ca7 list-job-instance listCustom + + +
+

zoweca7list-job-instancelistCustom

+

Displays information about jobs in the active workload.

+

Usage

+

zowe ca7 list-job-instance listCustom [options]

+

Options

+
    +
  • +

    --ca7no (number)

    +
      +
    • +

      ca7no=0231

      +

      The CA 7 job number

      +
    • +
    +
  • +
  • +

    --databasename | --db (string)

    +
      +
    • +

      databasename=TESTDB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
  • +

    --jobname (string)

    +
      +
    • +

      jobname=CA7TEST

      +

      The CA 7 job name

      +
    • +
    +
  • +
  • +

    --job (boolean)

    +
      +
    • +

      job=true/false

      +

      The job name for this job in the active workload

      +
    • +
    +
  • +
  • +

    --queueName (boolean)

    +
      +
    • +

      queueName=true/false

      +

      The name of the queue in which this job is currently located.

      +
    • +
    +
  • +
  • +

    --ca7Num (boolean)

    +
      +
    • +

      ca7Num=true/false

      +

      The job number for this job in the active workload

      +
    • +
    +
  • +
  • +

    --status (boolean)

    +
      +
    • +

      status=true/false

      +

      The job status

      +
    • +
    +
  • +
  • +

    --entryMode (boolean)

    +
      +
    • +

      entryMode=true/false

      +

      Identifies how the job was brought into the queue.

      +
    • +
    +
  • +
  • +

    --abended (boolean)

    +
      +
    • +

      abended=true/false

      +

      Y if job abended, N if not

      +
    • +
    +
  • +
  • +

    --agentIntervention (boolean)

    +
      +
    • +

      agentIntervention=true/false

      +

      Y if INTERVENTION REQUIRED condition exists for this agent job, N if not

      +
    • +
    +
  • +
  • +

    --agentJobNumber (boolean)

    +
      +
    • +

      agentJobNumber=true/false

      +

      The job number/PID for this agent job

      +
    • +
    +
  • +
  • +

    --agentName (boolean)

    +
      +
    • +

      agentName=true/false

      +

      The name of the agent where this job will execute

      +
    • +
    +
  • +
  • +

    --agentStatus (boolean)

    +
      +
    • +

      agentStatus=true/false

      +

      The status for this agent job

      +
    • +
    +
  • +
  • +

    --agentStatusData (boolean)

    +
      +
    • +

      agentStatusData=true/false

      +

      Y if status data is available for this agent job,N if not

      +
    • +
    +
  • +
  • +

    --agentSubmitted (boolean)

    +
      +
    • +

      agentSubmitted=true/false

      +

      Y if agent job has been submitted to the agent, N if not

      +
    • +
    +
  • +
  • +

    --agentType (boolean)

    +
      +
    • +

      agentType=true/false

      +

      Agent job type, zero if this is not an agent job

      +
    • +
    +
  • +
  • +

    --agentUser (boolean)

    +
      +
    • +

      agentUser=true/false

      +

      The userid with which this agent job will execute

      +
    • +
    +
  • +
  • +

    --ajbBuildError (boolean)

    +
      +
    • +

      ajbBuildError=true/false

      +

      Y if an error occurred while building an XPJOB job AJB or an agent job AFM, N if not

      +
    • +
    +
  • +
  • +

    --arf (boolean)

    +
      +
    • +

      arf=true/false

      +

      Y if this job is monitored by ARF, N if not

      +
    • +
    +
  • +
  • +

    --arfAttachErr (boolean)

    +
      +
    • +

      arfAttachErr=true/false

      +

      Y if this job had an ARF attach error, N if not

      +
    • +
    +
  • +
  • +

    --arfCompMatched (boolean)

    +
      +
    • +

      arfCompMatched=true/false

      +

      Set to Y if an ARF JOB completion rule matched for this job

      +
    • +
    +
  • +
  • +

    --arfDate (boolean)

    +
      +
    • +

      arfDate=true/false

      +

      Y if the job uses ARF

      +
    • +
    +
  • +
  • +

    --arfErrorCond (boolean)

    +
      +
    • +

      arfErrorCond=true/false

      +

      Set to Y if there was an error during ARF condition detection, N if not

      +
    • +
    +
  • +
  • +

    --arfjJob (boolean)

    +
      +
    • +

      arfjJob=true/false

      +

      Y if job is an ARF recovery job, N if not

      +
    • +
    +
  • +
  • +

    --arfJobComplete (boolean)

    +
      +
    • +

      arfJobComplete=true/false

      +

      Set to Y if this job's completion has been posted to ARF, N if not

      +
    • +
    +
  • +
  • +

    --arfRecovery (boolean)

    +
      +
    • +

      arfRecovery=true/false

      +

      Y if job is in ARF recovery, N if not

      +
    • +
    +
  • +
  • +

    --arfRecoveryErr (boolean)

    +
      +
    • +

      arfRecoveryErr=true/false

      +

      Y if this job had an error in ARF recovery, N if not

      +
    • +
    +
  • +
  • +

    --arfset (boolean)

    +
      +
    • +

      arfset=true/false

      +

      The collection of ARF definitions that apply to this job

      +
    • +
    +
  • +
  • +

    --arfTime (boolean)

    +
      +
    • +

      arfTime=true/false

      +

      The date and time that the ARFSET was attached to this job

      +
    • +
    +
  • +
  • +

    --autofDone (boolean)

    +
      +
    • +

      autofDone=true/false

      +

      Y if job performed AUTO F, N if not

      +
    • +
    +
  • +
  • +

    --ca11JesNode (boolean)

    +
      +
    • +

      ca11JesNode=true/false

      +

      The JES node where this job executes

      +
    • +
    +
  • +
  • +

    --ca11RestartStep (boolean)

    +
      +
    • +

      ca11RestartStep=true/false

      +

      The relative CA 11 restart step number

      +
    • +
    +
  • +
  • +

    --ca11RmsCc (boolean)

    +
      +
    • +

      ca11RmsCc=true/false

      +

      The CA 11 U11RMS step condition code

      +
    • +
    +
  • +
  • +

    --ca11Subsystem (boolean)

    +
      +
    • +

      ca11Subsystem=true/false

      +

      The CA 11 subsystem name

      +
    • +
    +
  • +
  • +

    --ca7System (boolean)

    +
      +
    • +

      ca7System=true/false

      +

      The user-defined application system associated with this job

      +
    • +
    +
  • +
  • +

    --compCode (boolean)

    +
      +
    • +

      compCode=true/false

      +

      The job completion code in number format

      +
    • +
    +
  • +
  • +

    --cpmJfm (boolean)

    +
      +
    • +

      cpmJfm=true/false

      +

      Y if JFM is used to track CPM, N if not

      +
    • +
    +
  • +
  • +

    --cpuTableIndex (boolean)

    +
      +
    • +

      cpuTableIndex=true/false

      +

      Index to the CPU Table entry

      +
    • +
    +
  • +
  • +

    --cputime (boolean)

    +
      +
    • +

      cputime=true/false

      +

      This Job's average CPU time

      +
    • +
    +
  • +
  • +

    --currStepNum (boolean)

    +
      +
    • +

      currStepNum=true/false

      +

      The number of the step that is currently executing

      +
    • +
    +
  • +
  • +

    --defNotFound (boolean)

    +
      +
    • +

      defNotFound=true/false

      +

      Y if job defintion not found on database, N if not found

      +
    • +
    +
  • +
  • +

    --doNotPrompt (boolean)

    +
      +
    • +

      doNotPrompt=true/false

      +

      Y if prompts are bypassed for the job, N if not

      +
    • +
    +
  • +
  • +

    --drclass (boolean)

    +
      +
    • +

      drclass=true/false

      +

      The job's disaster recovery class

      +
    • +
    +
  • +
  • +

    --drmode (boolean)

    +
      +
    • +

      drmode=true/false

      +

      Y if this job entered the queues when disaster recovery mode was active, N if not

      +
    • +
    +
  • +
  • +

    --dueOutExists (boolean)

    +
      +
    • +

      dueOutExists=true/false

      +

      Determines if a zero value in DUE_OUT_TIME indicates midnight (Y) or no due out time (N)

      +
    • +
    +
  • +
  • +

    --dueOutTime (boolean)

    +
      +
    • +

      dueOutTime=true/false

      +

      The date and time this job is expected to complete

      +
    • +
    +
  • +
  • +

    --dupJob (boolean)

    +
      +
    • +

      dupJob=true/false

      +

      Y if a job with the same name is waiting on this job to complete, N if not

      +
    • +
    +
  • +
  • +

    --dupJobWait (boolean)

    +
      +
    • +

      dupJobWait=true/false

      +

      Y if this job is waiting on a job with the same name to complete, N if not

      +
    • +
    +
  • +
  • +

    --elapsedTime (boolean)

    +
      +
    • +

      elapsedTime=true/false

      +

      This Job's average elapsed time

      +
    • +
    +
  • +
  • +

    --endTime (boolean)

    +
      +
    • +

      endTime=true/false

      +

      The date and time this job ended

      +
    • +
    +
  • +
  • +

    --executable (boolean)

    +
      +
    • +

      executable=true/false

      +

      Y if job is executable, N if not

      +
    • +
    +
  • +
  • +

    --express (boolean)

    +
      +
    • +

      express=true/false

      +

      Y if submission of this job has been expedited by use of the SUBMIT,EXPRESS=YES command, N if not

      +
    • +
    +
  • +
  • +

    --externalInput (boolean)

    +
      +
    • +

      externalInput=true/false

      +

      Y if we job has external input, N if not

      +
    • +
    +
  • +
  • +

    --externalJob (boolean)

    +
      +
    • +

      externalJob=true/false

      +

      Y if this is an externally tracked job, N if not

      +
    • +
    +
  • +
  • +

    --externalSatisfied (boolean)

    +
      +
    • +

      externalSatisfied=true/false

      +

      The number of satisfied external requirements for this job

      +
    • +
    +
  • +
  • +

    --externalTotal (boolean)

    +
      +
    • +

      externalTotal=true/false

      +

      The total number of external requirements for this job

      +
    • +
    +
  • +
  • +

    --forcedComplete (boolean)

    +
      +
    • +

      forcedComplete=true/false

      +

      Y if job was force completed, N if not

      +
    • +
    +
  • +
  • +

    --forcedSubmit (boolean)

    +
      +
    • +

      forcedSubmit=true/false

      +

      Y if all input requirements have been marked as satisfied by use of the SUBMIT command, N if not

      +
    • +
    +
  • +
  • +

    --fromXpRequest (boolean)

    +
      +
    • +

      fromXpRequest=true/false

      +

      Y if scheduling request for this job came from an XPS client, N if not

      +
    • +
    +
  • +
  • +

    --hasCa11 (boolean)

    +
      +
    • +

      hasCa11=true/false

      +

      Y if job has a CA11 segment, N if not

      +
    • +
    +
  • +
  • +

    --hasCpuTime (boolean)

    +
      +
    • +

      hasCpuTime=true/false

      +

      Y if we have non-zero CPU time for this job, N if not

      +
    • +
    +
  • +
  • +

    --hasJo (boolean)

    +
      +
    • +

      hasJo=true/false

      +

      Y if the JCL or PARM DATA contains a #JO card, N if not

      +
    • +
    +
  • +
  • +

    --hasStepTime (boolean)

    +
      +
    • +

      hasStepTime=true/false

      +

      Y if job has non-zero step CPU time, N if not

      +
    • +
    +
  • +
  • +

    --held (boolean)

    +
      +
    • +

      held=true/false

      +

      Y if job is held, N if not

      +
    • +
    +
  • +
  • +

    --heldByJob (boolean)

    +
      +
    • +

      heldByJob=true/false

      +

      Y if job was held on entry to the queues, N if not

      +
    • +
    +
  • +
  • +

    --heldSkeleton (boolean)

    +
      +
    • +

      heldSkeleton=true/false

      +

      Y if job is held and in skeleton status, N if not

      +
    • +
    +
  • +
  • +

    --skeleton (boolean)

    +
      +
    • +

      skeleton=true/false

      +

      Y if job is in skeleton status, N if not

      +
    • +
    +
  • +
  • +

    --holdOnEntry (boolean)

    +
      +
    • +

      holdOnEntry=true/false

      +

      Y if job marked HOLD=YES, N if not

      +
    • +
    +
  • +
  • +

    --hostName (boolean)

    +
      +
    • +

      hostName=true/false

      +

      The SMF Id of the system where this is executing

      +
    • +
    +
  • +
  • +

    --inCpmFlow (boolean)

    +
      +
    • +

      inCpmFlow=true/false

      +

      Y if job is part of a CPM flow, N if not

      +
    • +
    +
  • +
  • +

    --insertRms (boolean)

    +
      +
    • +

      insertRms=true/false

      +

      Y if an RMS step will be inserted into this job's JCL, N if not

      +
    • +
    +
  • +
  • +

    --jclAllocErr (boolean)

    +
      +
    • +

      jclAllocErr=true/false

      +

      Y if JCL or PARM DATA library could not be allocated, N if not

      +
    • +
    +
  • +
  • +

    --jclCount (boolean)

    +
      +
    • +

      jclCount=true/false

      +

      The number of non-# records in the JCL or PARM DATA members associated with this job

      +
    • +
    +
  • +
  • +

    --jclError (boolean)

    +
      +
    • +

      jclError=true/false

      +

      Y if job marked with JCL error, N if not

      +
    • +
    +
  • +
  • +

    --jclFromAltlib (boolean)

    +
      +
    • +

      jclFromAltlib=true/false

      +

      Y if JCL or PARM DATA was retrieved from an alternate library, N if not

      +
    • +
    +
  • +
  • +

    --jclLibrary (boolean)

    +
      +
    • +

      jclLibrary=true/false

      +

      Contains either a 3 digit JCL index value or a JCL variable beginning with an ampersand

      +
    • +
    +
  • +
  • +

    --jesHi (boolean)

    +
      +
    • +

      jesHi=true/false

      +

      JES supports ID > 99999

      +
    • +
    +
  • +
  • +

    --loadOnly (boolean)

    +
      +
    • +

      loadOnly=true/false

      +

      Y if this is a LOAD only job, N if not

      +
    • +
    +
  • +
  • +

    --loadStepDone (boolean)

    +
      +
    • +

      loadStepDone=true/false

      +

      Y if LOAD step ran OK for this job, N if not

      +
    • +
    +
  • +
  • +

    --locked (boolean)

    +
      +
    • +

      locked=true/false

      +

      Y if job is locked, N if not

      +
    • +
    +
  • +
  • +

    --longName (boolean)

    +
      +
    • +

      longName=true/false

      +

      An alias name for this job. This name may be used by scheduling engines on other platforms, such as AutoSys

      +
    • +
    +
  • +
  • +

    --lterm (boolean)

    +
      +
    • +

      lterm=true/false

      +

      Logical terminal name from job definition

      +
    • +
    +
  • +
  • +

    --mainid (boolean)

    +
      +
    • +

      mainid=true/false

      +

      If positive, the CPU number on which the job may execute. If negative, the CPU number on which the job may not execute

      +
    • +
    +
  • +
  • +

    --maint (boolean)

    +
      +
    • +

      maint=true/false

      +

      Y if job ignores requirements, N if not

      +
    • +
    +
  • +
  • +

    --manualRequeue (boolean)

    +
      +
    • +

      manualRequeue=true/false

      +

      Y if job has been re-queued to REQUEST queue, N if not

      +
    • +
    +
  • +
  • +

    --memberName (boolean)

    +
      +
    • +

      memberName=true/false

      +

      The JCL or PARM DATA library member name

      +
    • +
    +
  • +
  • +

    --mustStartExists (boolean)

    +
      +
    • +

      mustStartExists=true/false

      +

      Determines if a zero value in MUST_START_TIME indicates midnight (Y) or no deadline time (N)

      +
    • +
    +
  • +
  • +

    --needsAutof (boolean)

    +
      +
    • +

      needsAutof=true/false

      +

      Y if a job changed and requires 'F' in CA11, N if not

      +
    • +
    +
  • +
  • +

    --nextRunReq (boolean)

    +
      +
    • +

      nextRunReq=true/false

      +

      Y if job has temporary requirements for the next execution, N if not

      +
    • +
    +
  • +
  • +

    --nodeFailed (boolean)

    +
      +
    • +

      nodeFailed=true/false

      +

      Y if this is an XPJOB job and at the time of it last submit its node was down, N if not

      +
    • +
    +
  • +
  • +

    --nodeOffline (boolean)

    +
      +
    • +

      nodeOffline=true/false

      +

      Y if this is an XPJOB job and at the time of its last submit its node was offline, N if not

      +
    • +
    +
  • +
  • +

    --nodeStopped (boolean)

    +
      +
    • +

      nodeStopped=true/false

      +

      Y if this is an XPJOB job and at the time of it last submit its node was stopped, N if not

      +
    • +
    +
  • +
  • +

    --noUserId (boolean)

    +
      +
    • +

      noUserId=true/false

      +

      Y if there is not a valid security id for this job, N if there is

      +
    • +
    +
  • +
  • +

    --noXpsiParmlib (boolean)

    +
      +
    • +

      noXpsiParmlib=true/false

      +

      Y if this is an XPJOB job and has no PARMLIB, N if not

      +
    • +
    +
  • +
  • +

    --noXpsiXpsparm (boolean)

    +
      +
    • +

      noXpsiXpsparm=true/false

      +

      Y if this is an XPJOB job and has no PARM, N if not

      +
    • +
    +
  • +
  • +

    --override (boolean)

    +
      +
    • +

      override=true/false

      +

      Y if JCL/PARM DATA override is required, N if not

      +
    • +
    +
  • +
  • +

    --overrideApplied (boolean)

    +
      +
    • +

      overrideApplied=true/false

      +

      Y if JCL overrides have been applied for this job, N if not

      +
    • +
    +
  • +
  • +

    --prompt (boolean)

    +
      +
    • +

      prompt=true/false

      +

      Y if job should have LATE PROMPTS, N if not

      +
    • +
    +
  • +
  • +

    --promptAck (boolean)

    +
      +
    • +

      promptAck=true/false

      +

      Y if user has acknowledged the prompt, N if not

      +
    • +
    +
  • +
  • +

    --prompted (boolean)

    +
      +
    • +

      prompted=true/false

      +

      Y if user has been prompted, N if not

      +
    • +
    +
  • +
  • +

    --qjclUpdated (boolean)

    +
      +
    • +

      qjclUpdated=true/false

      +

      Y if JCL or PARM DATA updated through QJCL, N if not

      +
    • +
    +
  • +
  • +

    --queueJcl (boolean)

    +
      +
    • +

      queueJcl=true/false

      +

      Y if a QJCL command is in progress for this job N if not

      +
    • +
    +
  • +
  • +

    --repeatCount (boolean)

    +
      +
    • +

      repeatCount=true/false

      +

      The number of times to repeat this job

      +
    • +
    +
  • +
  • +

    --repeatDiff (boolean)

    +
      +
    • repeatDiff=true/false
    • +
    +
  • +
  • +

    --ca7No (boolean)

    +
      +
    • +

      ca7No=true/false

      +

      The difference between the original dueout time and the original submit time, used by repeating jobs

      +
    • +
    +
  • +
  • +

    --repeatInterval (boolean)

    +
      +
    • +

      repeatInterval=true/false

      +

      The interval between repetitions of the job

      +
    • +
    +
  • +
  • +

    --repeatLeadTime (boolean)

    +
      +
    • +

      repeatLeadTime=true/false

      +

      The lead time for this repeat job. This is the amount of time to ensure it completes before it due out time

      +
    • +
    +
  • +
  • +

    --repeatStopExists (boolean)

    +
      +
    • +

      repeatStopExists=true/false

      +

      Determines if a zero value in REPEAT_STOP_TIME indicates midnight (Y) or no repeat stop time (N)

      +
    • +
    +
  • +
  • +

    --repeatStopTime (boolean)

    +
      +
    • +

      repeatStopTime=true/false

      +

      The date and time on or after which a repeating job will not be repeated

      +
    • +
    +
  • +
  • +

    --repeatType (boolean)

    +
      +
    • +

      repeatType=true/false

      +

      The type of repeat job. This field determines how the submit time requierement is calculated for repeating jobs

      +
    • +
    +
  • +
  • +

    --restartStep (boolean)

    +
      +
    • +

      restartStep=true/false

      +

      The step name in which the job was restarted

      +
    • +
    +
  • +
  • +

    --retainJcl (boolean)

    +
      +
    • +

      retainJcl=true/false

      +

      Y if JCL or XPJOB information will be retained in the prior run queue, N if not

      +
    • +
    +
  • +
  • +

    --rqmtCount (boolean)

    +
      +
    • +

      rqmtCount=true/false

      +

      The master requirement count for this job. The number includes unsatisfied requirements, submit time, and other reasons preventing the job from being submitted

      +
    • +
    +
  • +
  • +

    --schdAdjusted (boolean)

    +
      +
    • +

      schdAdjusted=true/false

      +

      Y if job's schedule has been adjusted, N if not

      +
    • +
    +
  • +
  • +

    --nosecurity (boolean)

    +
      +
    • +

      nosecurity=true/false

      +

      Y if there was an error retrieving security data,N if no

      +
    • +
    +
  • +
  • +

    --setNdb (boolean)

    +
      +
    • +

      setNdb=true/false

      +

      Y if job will bypass LOAD processing at completion and not update the database, N if not

      +
    • +
    +
  • +
  • +

    --smfNeeded (boolean)

    +
      +
    • +

      smfNeeded=true/false

      +

      Y if SMF feedback is needed for this job, N if not

      +
    • +
    +
  • +
  • +

    --startTime (boolean)

    +
      +
    • +

      startTime=true/false

      +

      The date and time this job started executing on its most recent submission

      +
    • +
    +
  • +
  • +

    --submitted (boolean)

    +
      +
    • +

      submitted=true/false

      +

      Y if this job has been submitted to the host, N if not

      +
    • +
    +
  • +
  • +

    --submitTime (boolean)

    +
      +
    • +

      submitTime=true/false

      +

      The date and time this job was submitted

      +
    • +
    +
  • +
  • +

    --triggered (boolean)

    +
      +
    • +

      triggered=true/false

      +

      Y if job triggered by another job, N if not

      +
    • +
    +
  • +
  • +

    --uid (boolean)

    +
      +
    • +

      uid=true/false

      +

      The CA 7 internal user security designation

      +
    • +
    +
  • +
  • +

    --verify (boolean)

    +
      +
    • +

      verify=true/false

      +

      Y if job has a manual verification requirement, N if not

      +
    • +
    +
  • +
  • +

    --waitSubmitTime (boolean)

    +
      +
    • +

      waitSubmitTime=true/false

      +

      Y if this job has a submit time requirement, N if not

      +
    • +
    +
  • +
  • +

    --xpAltNode (boolean)

    +
      +
    • +

      xpAltNode=true/false

      +

      The alternate node where this XPJOB job was routed

      +
    • +
    +
  • +
  • +

    --xpPrimaryNode (boolean)

    +
      +
    • +

      xpPrimaryNode=true/false

      +

      The primary node associated with this XPJOB job

      +
    • +
    +
  • +
  • +

    --xpsJob (boolean)

    +
      +
    • +

      xpsJob=true/false

      +

      Y if this is an XPJOB job, N if not

      +
    • +
    +
  • +
  • +

    --xpStatus (boolean)

    +
      +
    • +

      xpStatus=true/false

      +

      The status of the node associated with this XPJOB job. A: Active F: Failed CCI send O: Offline S:Stopped

      +
    • +
    +
  • +
  • +

    --xtrackerInact (boolean)

    +
      +
    • +

      xtrackerInact=true/false

      +

      Y if at time of submission, the XTRACKER task is not active for an XPJOB job or IAS is not active for an agent job, N if not

      +
    • +
    +
  • +
  • +

    --xplatNode (boolean)

    +
      +
    • +

      xplatNode=true/false

      +

      Cross platform long node name

      +
    • +
    +
  • +
  • +

    --responseError (boolean)

    +
      +
    • responseError=true/false
    • +
    +
  • +
  • +

    --ca11FailingStepNum (boolean)

    +
      +
    • +

      ca11FailingStepNum=true/false

      +

      CA 11 Failing Step Number

      +
    • +
    +
  • +
  • +

    --completeOk (boolean)

    +
      +
    • +

      completeOk=true/false

      +

      Y if job completed normally, N if not

      +
    • +
    +
  • +
  • +

    --jesNum (boolean)

    +
      +
    • +

      jesNum=true/false

      +

      The JES job number for this job. A value of -1 indicates NA

      +
    • +
    +
  • +
  • +

    --needsLoad (boolean)

    +
      +
    • +

      needsLoad=true/false

      +

      Y if LOAD processing will be done for this job, Nif not

      +
    • +
    +
  • +
  • +

    --deadline (boolean)

    +
      +
    • +

      deadline=true/false

      +

      The date and time a job must be started by in order to meet its due out time

      +
    • +
    +
  • +
  • +

    --jclfrom254 (boolean)

    +
      +
    • +

      jclfrom254=true/false

      +

      Y if JCL or XPJOB information will be retained in the prior run queue, N if not

      +
    • +
    +
  • +
  • +

    --proseNum (boolean)

    +
      +
    • +

      proseNum=true/false

      +

      Number of the prose text associated with this job, or zero

      +
    • +
    +
  • +
  • +

    --scheduleId (boolean)

    +
      +
    • +

      scheduleId=true/false

      +

      The schedule id for this execution

      +
    • +
    +
  • +
  • +

    --triggeringJobNum (boolean)

    +
      +
    • +

      triggeringJobNum=true/false

      +

      The CA 7 internal job number of the job that triggered this job or job that created the data set that triggered this job

      +
    • +
    +
  • +
  • +

    --triggers (boolean)

    +
      +
    • +

      triggers=true/false

      +

      Y if job can trigger other jobs, N if not

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List a CA 7 job (7777) information which resided in CA7DB database :

    +
      +
    • zowe ca7 list-job-instance listCustom --ca7no 7777 --db CA7DB --jobname TESTCA7
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_requirements.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_requirements.html new file mode 100644 index 0000000000..edffdd340f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-job-instance_requirements.html @@ -0,0 +1,141 @@ + + + + +ca7 list-job-instance requirements + + +
+

zoweca7list-job-instancerequirements

+

Displays information about requirements for jobs in the active workload.

+

Usage

+

zowe ca7 list-job-instance requirements [options]

+

Required Options

+
    +
  • +

    --ca7no (string)

    +
      +
    • +

      ca7no=0231

      +

      The CA 7 job number

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --databasename | --db (string)

    +
      +
    • +

      databasename=TESTJOB01

      +

      The CA 7 database name

      +
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Retrieves the job requirements of a CA 7 job (7777) which resided in CA7DB database:

    +
      +
    • zowe ca7 list-job-instance requirements --ca7no 7777 --db CA7DB
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-resource-definition.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-resource-definition.html new file mode 100644 index 0000000000..e4a90fa4b5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-resource-definition.html @@ -0,0 +1,20 @@ + + + + +ca7 list-resource-definition + + +
+

zoweca7list-resource-definition

+

All the available commands are listed in the COMMANDS section.

+

Usage

+

zowe ca7 list-resource-definition <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_list-resource-definition_resource-count-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_list-resource-definition_resource-count-resource.html new file mode 100644 index 0000000000..40eb8434a3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_list-resource-definition_resource-count-resource.html @@ -0,0 +1,127 @@ + + + + +ca7 list-resource-definition resource-count-resource + + +
+

zoweca7list-resource-definitionresource-count-resource

+

Retrieves a Resource Count Resource Information

+

Usage

+

zowe ca7 list-resource-definition resource-count-resource [options]

+

Required Options

+
    +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the name of the Resource Count Resource to delete.
      +Limits: 1 to 39 alphanumeric characters and periods
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Retrieves a Resource Count Resource:

    +
      +
    • zowe ca7 list-resource-definition resource-count-resource --rn PAYROLL.RCT
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_update-job-definition.html b/static/v2.15.x/web_help/docs/zowe_ca7_update-job-definition.html new file mode 100644 index 0000000000..72f1779e08 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_update-job-definition.html @@ -0,0 +1,22 @@ + + + + +ca7 update-job-definition + + +
+

zoweca7update-job-definition

+

All the available commands are listed in the COMMANDS section.

+

Usage

+

zowe ca7 update-job-definition <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_update-job-definition_job.html b/static/v2.15.x/web_help/docs/zowe_ca7_update-job-definition_job.html new file mode 100644 index 0000000000..23597684e5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_update-job-definition_job.html @@ -0,0 +1,173 @@ + + + + +ca7 update-job-definition job + + +
+

zoweca7update-job-definitionjob

+

Update requirement definition for a job

+

Usage

+

zowe ca7 update-job-definition job [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job to update
    • +
    +
  • +
  • +

    --job-type | --jt (string)

    +
      +
    • The type of job. Valid values are: CPU|XPJOB|AGENT
    • +
    +
  • +
+

Options

+
    +
  • +

    --execute (string)

    +
      +
    • Indicates whether to execute this job.
      +Valid values are: Y/N
    • +
    +
  • +
  • +

    --use-jcl-override-library | --ujol (string)

    +
      +
    • Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only (Y or N).
      +This field is automatically set back to N the next time the job comes into the request queue
    • +
    +
  • +
  • +

    --do-not-schedule-before-date | --dnsbd (string)

    +
      +
    • Specifies not to schedule this job before this date (in YYDDD format, or 00000)
    • +
    +
  • +
  • +

    --do-not-schedule-before-time | --dnsbt (string)

    +
      +
    • Specifies not to schedule this job before this time (in HHMM format)
    • +
    +
  • +
  • +

    --do-not-schedule-after-date | --dnsad (string)

    +
      +
    • Specifies not to schedule this job after this date (in YYDDD format, or 99999)
    • +
    +
  • +
  • +

    --do-not-schedule-after-time | --dnsat (string)

    +
      +
    • Specifies not to schedule this job after this time (in HHMM format)
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a CPU type job, TESTJOB1 to be executable:

    +
      +
    • zowe ca7 update-job-definition job --job TESTJOB1 --job-type CPU --execute Y
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_update-job-definition_requirement-predecessor.html b/static/v2.15.x/web_help/docs/zowe_ca7_update-job-definition_requirement-predecessor.html new file mode 100644 index 0000000000..fca65718b6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_update-job-definition_requirement-predecessor.html @@ -0,0 +1,172 @@ + + + + +ca7 update-job-definition requirement-predecessor + + +
+

zoweca7update-job-definitionrequirement-predecessor

+

Update requirement definition for a job

+

Usage

+

zowe ca7 update-job-definition requirement-predecessor [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job that requires the predecessor
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • The schedule id of requiring job
    • +
    +
  • +
  • +

    --predtype (string)

    +
      +
    • The predecessor type
    • +
    +
  • +
  • +

    --nextrun (string)

    +
      +
    • The status of predecessor for next run of job
      +[ YES, ONLY, SKIP ]
    • +
    +
  • +
  • +

    --predobject (string)

    +
      +
    • The predecessor. Values vary with predtype.
      +The predecessor. Values vary with predtype.
      +When “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.
      +When “predtype”:”USER” then “predobject” is 1-44 character user requirement text.
    • +
    +
  • +
+

Options

+
    +
  • +

    --leadtime (string)

    +
      +
    • The satisfaction lead time in hours.
      +This may be honored when “predtype” is “job or “DSN”
    • +
    +
  • +
  • +

    --permanent (string)

    +
      +
    • Indicates that this predecessor is permanent, that is always considered satisfied.
      +This parameter only applies when “predtype” is “DSN”
      +[ Y, N ]
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    post TESJOB1 0009 USER ONLY "APCDAL.TESTDB01.TEST":

    +
      +
    • zowe ca7 update-job-definition requirement-predecessor TESJOB1 0009 USER ONLY "APCDAL.TESTDB01.TEST"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_update-job-definition_schedule.html b/static/v2.15.x/web_help/docs/zowe_ca7_update-job-definition_schedule.html new file mode 100644 index 0000000000..29e066bd4f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_update-job-definition_schedule.html @@ -0,0 +1,375 @@ + + + + +ca7 update-job-definition schedule + + +
+

zoweca7update-job-definitionschedule

+

Modify schedule parameters

+

Usage

+

zowe ca7 update-job-definition schedule [options]

+

Required Options

+
    +
  • +

    --job (string)

    +
      +
    • The name of the job
    • +
    +
  • +
  • +

    --schid (string)

    +
      +
    • Specifies the numeric schedule ID on which the user wants to perform the specified action.
      +Limits: 1 to 3 numeric characters from 1 through 999
    • +
    +
  • +
+

Options

+
    +
  • +

    --scal (string)

    +
      +
    • Specifies the override of the default SCAL for this SCHID. Specify scal if you want to override the default scal.
      +Limits: 2 alphanumeric characters
    • +
    +
  • +
  • +

    --default-scal | --dscal (string)

    +
      +
    • Specifies the default SCAL for this job. If this is not specified, an LJOB will be issued to fetch the SCAL
      +Limits: 2 alphanumeric characters
    • +
    +
  • +
  • +

    --due-out-time | --dot (string)

    +
      +
    • Specifies the due-out time of day for this schedule ID.
      +Limits: 4 numeric characters that are specified as hhmm
      +where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
    • +
    +
  • +
  • +

    --lead-time | --lt (string)

    +
      +
    • Specifies the due-out time of day for this schedule ID.
      +Limits: 4 numeric characters that are specified as hhmm
      +where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
    • +
    +
  • +
  • +

    --submit-time | --st (string)

    +
      +
    • Specifies the submit time of day for this schedule ID.
      +If specified, the job is not submitted before this time.
      +If the submit time is before deadline start time,
      +the submit time requirement is automatically satisfied when the job enters the queue.
      +A submit time of zeros is the same as not specifying it, and no submit time is set up.
      +Note:If the submit time is after the due-out time, the submit day value is set to the previous day.
      +Limits: 4 numeric characters that are specified as hhmm
      +where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
    • +
    +
  • +
  • +

    --daily (string)

    +
      +
    • Specifies that the user wants to define a daily schedule.
      +Daily means every available processing day as defined by the Base Calendar.
      +If DAILY is used, the ROLL has no effect.
      +Limits: One of Y or N
    • +
    +
  • +
  • +

    --roll (string)

    +
      +
    • Specifies the action to take when a schedule day falls on a base calendar non available processing day.
      +This value is not used if the DAILY option is used
      +If DAILY is used, the ROLL has no effect.
      +If used, the value must be one of the following values:
      +B: Roll the schedule back to the previous available processing day in the Base Calendar.
      +F: Roll forward the schedule to the next available processing day.
      +N: Do not roll. Schedule day must stand.
      +D: Do not roll and do not schedule.
      +Default:D
    • +
    +
  • +
  • +

    --index (string)

    +
      +
    • Specifies an adjustment to schedule days.
      +After you exercise the ROLL option, the schedule is adjusted,
      +forward for plus or backward for minus, by the number of working days entered.
      +Limits:4 numeric characters that are specified as Innn where I can be plus (unsigned) or minus (-) and nnn can be 0 to 365 daysUsage:
      +Use this field with the RDAY field to schedule a job to run three workdays before the 15th of the month:
      +specify -3 in the INDEX field, X in the MONTHLY field, and 15 in the RDAY field.
    • +
    +
  • +
  • +

    --interval (string)

    +
      +
    • Specifies that the job should be repeated (executed more than once) and
      +specifies the amount of time between each iteration.
      +If INTERVAL is specified, the SBTM (submit time requirement) and TYPE fields are required.
      +If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.
      +Limits:4 numeric characters in hhmm format where hh can be from 0 to 23 and mm can be from 00 to 59
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • Determines how the submit time requirement is calculated for repeating jobs.
      +A TYPE of CLOCK indicates that the INTERVAL is added to the previous iteration's
      +submit time requirement to determine the new submit time requirement.
      +A TYPE of START and END indicates that the INTERVAL is added to the previous iteration's
      +last (most recent) start and end times,respectively, to determine the new submit time requirement.
      +TYPE is required if INTERVAL is specified.
      +TYPE is discarded if INTERVAL is not specifiedLimits:CLOCK, START, or END
    • +
    +
  • +
  • +

    --count (string)

    +
      +
    • Specifies the maximum number of times to repeat the job.
      +COUNT is discarded if INTERVAL is not specified.
      +If both COUNT and STOP are specified, the job stops repeating when the COUNT reaches zero or the STOP time is reached, whichever comes first.
      +If COUNT is not specified, the job repeats until the STOP time is reached.TYPE is required if INTERVAL is specified. TYPE is discarded if INTERVAL is not specifiedLimits:1 to 4 numeric characters from 0 to 1439. Leading zeros can be discarded.
    • +
    +
  • +
  • +

    --weekly (string)

    +
      +
    • Specifies that the user wants to define a weekly schedule.
      +If WEEKLY is used, the run days of the week must be specified using DAYS field
      +Limits:Y or N
    • +
    +
  • +
  • +

    --days (string)

    +
      +
    • Defines specific days of the week on which to run the job.
      +as comma separated list of day name abbreviations.
      +Limits: A comma separated list of Sun,Mon,Tue,Wed,Thu,Fri,Sat
    • +
    +
  • +
  • +

    --monthly (string)

    +
      +
    • Specifies that the user wants to define a monthly schedule.
      +If this field is used, the user can optionally specify on which particular months the job is to run.
      +If specific months are not specified in the months property, all months are assumed.Limits: Y or N
    • +
    +
  • +
  • +

    --months (string)

    +
      +
    • Defines specific months on which to run the job.
      +as comma separated list of month name abbreviations.
      +Limits: A comma separated list of Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec
    • +
    +
  • +
  • +

    --weeks-of-month | --wom (string)

    +
      +
    • Specifies the weeks of the month to run the job.
      +The values that are specified can be positive (unsigned), negative (-) or slash (/).
      +Positive values 1, 2, 3, 4, or 5 are used to indicate the week relative to the beginning of the month.
      +Negative values -0, -1, and -2 are used to indicate occurrence of week relative to the end of the month.
      +Slashes indicate the job will not run the following value.
      +Limits: 1 to 14 numeric characters and required if MONTHLY and DAY-OF-WEEK are used.
      +The values are separated by comma
    • +
    +
  • +
  • +

    --day-of-week | --dow (string)

    +
      +
    • Specifies which days of the week to run the job.
      +If used, each day must be the first three letters of the wanted run days.
      +If you want to specify multiple days, use a comma separated list for example MON,TUE,FRI.
      +Limits: A comma separated list of SUN, MON, TUE, WED, THU, FRI, SAT, case insensitive
    • +
    +
  • +
  • +

    --relative-day | --rd (string)

    +
      +
    • Specifies relative days of the month on which the job is to run. Used with MONTHLY.
      +A day relative to the beginning or end of the month is specified.
      +If a positive (unsigned) value is used, the job runs that day relative to the first of the month.
      +Also, if you have days of the month when this job is not to run,a slash (/) can be used with the unsigned or negative values.
      +Valid positive values range from 1 to 31.
      +Valid negative values range from -0 to -30.
      +Limits:1 to 60 numeric characters, separated by comma.
      +Note:relative-day(s) represents calendar days, unless the base calendar was generated with OPTIONS=SCHDYONLY,
      +in which case relative-day(s) represents processing days.
    • +
    +
  • +
  • +

    --annual (string)

    +
      +
    • Defines an annual schedule.
      +Limits: If annual is used, day is required. One of Y, N
    • +
    +
  • +
  • +

    --day-of-year | --doy (string)

    +
      +
    • Specifies on which days of the annual schedule the user wants to run the job.
      +Days are entered as 1 through 366 and are prefixed by positive (unsigned) or slash (/) values.
      +Slash indicates the job will not run this day.
      +For example, if a job is to run on days 121, 132, 240, and 241, but is not to run on days 122, 242, and 1,the user would specify: /1,121,/122,132,240,241,/242
      +Limits: 1 to 55 numeric characters and required if annual is used.
      +The numbers will be separated by comma
    • +
    +
  • +
  • +

    --symmetric (string)

    +
      +
    • Used with the START and SPAN fields, defines a symmetric schedule.
      +With this option, schedules are defined as beginning on the date specified with
      +the START field and recurring every nnn days as specified with the SPAN field.
      +Limits: One of Y, N
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • This field is required when the SYMETRIC option is taken.
      +Value must be specified as the Julian day of the year on which the symmetric schedule is to begin.
      +This value should be evaluated yearly before schedule resolution and may need to be changed each year.
      +If the schedule will be resolved on a July-June basis, the start date must be within
      +the first of the two years in which the schedule overlaps.
      +For January-December schedules, it is simply relative to January 1 of the year specified on a RESOLV command.
      +If the calendar against which this SCHID will be resolved does not have the OPTIONS=SCHDYONLY,
      +the START day is adjusted each year to maintain the job's symmetric schedule from the job's original specified START day.
      +If the calendar against which the SCHID will be resolved was generated with overall available processing days only (OPTIONS=SCHDYONLY)
      +the start date must specify the first day on which the job would actually run.
      +This requires manually setting (verifying) the START value each year before the RESOLV.
      +If a nonprocessing day is specified, the start day is the next processing day found in the calendar.
      +For example, if January 1 is a nonprocessing day and the calendar was generated with OPTIONS=SCHDYONLY,
      +and 1 is specified as the START day, January 2 is the actual START day (provided it is an available processing day).
      +SPAN is based from January 2 in this example rather than January 1.
      +For other types of calendars, the start date is determined at RESOLV time based on the ROLL and INDEX options taken.
      +Limits: 3 numeric characters specified as Julian day of the year from 1 to 365
    • +
    +
  • +
  • +

    --span (string)

    +
      +
    • Used with SYMETRIC and START, defines symmetric schedules.
      +This field is required if the SYMETRIC option is taken.
      +When used, specifies the number of days between scheduled processing cycles.
      +If the calendar against which the SCHID will be resolved was generated with processing days
      +only (OPTIONS=SCHDYONLY), the SPAN value is specified as the number of available processing days
      +between and including the next processing date as opposed to the actual number of days.
      +With this type of calendar, the ROLL and INDEX options serve no practical purpose.
      +For other calendar types, the SPAN value is specified as the number of calendar days
      +between processing cycles and the ROLL and INDEX options can be used as necessary.
      +Limits: 1 to 3 numeric characters from 1 to 255
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Modify a schedule for job TESTJOB1 with the parameters:

    +
      +
    • zowe ca7 update-job-definition schedule --job TESTJOB1 --schid 01 --dscal 03
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_update-job-instance.html b/static/v2.15.x/web_help/docs/zowe_ca7_update-job-instance.html new file mode 100644 index 0000000000..87266037c8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_update-job-instance.html @@ -0,0 +1,20 @@ + + + + +ca7 update-job-instance + + +
+

zoweca7update-job-instance

+

All the available commands are listed in the COMMANDS section.

+

Usage

+

zowe ca7 update-job-instance <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • jcl - Use the following two required parameters
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_update-job-instance_jcl.html b/static/v2.15.x/web_help/docs/zowe_ca7_update-job-instance_jcl.html new file mode 100644 index 0000000000..6979fd0447 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_update-job-instance_jcl.html @@ -0,0 +1,156 @@ + + + + +ca7 update-job-instance jcl + + +
+

zoweca7update-job-instancejcl

+

Update JCL for a job

+

Usage

+

zowe ca7 update-job-instance jcl [options]

+

Required Options

+
    +
  • +

    --ca7no (string)

    +
      +
    • The CA 7 job number
    • +
    +
  • +
  • +

    --sourcedataset (string)

    +
      +
    • The source data set name containing the new JCL
    • +
    +
  • +
  • +

    --sourcemember (string)

    +
      +
    • The source data set member name containing the new JCL
    • +
    +
  • +
  • +

    --sourcetype (string)

    +
      +
    • +

      The source type containing the new JCL

      +

      currently: dataset is by the default and the only option

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --postjclovrd (string)

    +
      +
    • Indicates whether to post the JCL override requirement when the JCL is updated
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update JCL for a job TESJOB1 along with other parameters:

    +
      +
    • zowe ca7 update-job-instance jcl TESJOB1 0009 USER ONLY "APCDAL.TESTDB01.TEST"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_update-resource-definition.html b/static/v2.15.x/web_help/docs/zowe_ca7_update-resource-definition.html new file mode 100644 index 0000000000..ac74777ba2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_update-resource-definition.html @@ -0,0 +1,20 @@ + + + + +ca7 update-resource-definition + + + + + diff --git a/static/v2.15.x/web_help/docs/zowe_ca7_update-resource-definition_resource-count-resource.html b/static/v2.15.x/web_help/docs/zowe_ca7_update-resource-definition_resource-count-resource.html new file mode 100644 index 0000000000..fc9bc6d56c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ca7_update-resource-definition_resource-count-resource.html @@ -0,0 +1,134 @@ + + + + +ca7 update-resource-definition resource-count-resource + + +
+

zoweca7update-resource-definitionresource-count-resource

+

Modify Resource Count Resource parameters

+

Usage

+

zowe ca7 update-resource-definition resource-count-resource [options]

+

Required Options

+
    +
  • +

    --resource-name | --rn (string)

    +
      +
    • Specifies the name of the Resource Count Resource to update.
      +Limits: 1 to 39 alphanumeric characters and periods
    • +
    +
  • +
  • +

    --total-count | --tc (string)

    +
      +
    • Specifies the total number of available occurrences for this Resource Count Resource.
      +Limits: 1 to 4 numeric characters in the range 0-9999
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ca7-profile | --ca7-p (string)

    +
      +
    • The name of a (ca7) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Modify Resource named PAYROLL.RCT to count 125:

    +
      +
    • zowe ca7 update-resource-definition resource-count-resource --rn PAYROLL.RCT --tc 125
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview.html b/static/v2.15.x/web_help/docs/zowe_caview.html new file mode 100644 index 0000000000..9ef4b53833 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview.html @@ -0,0 +1,25 @@ + + + + +caview + + +
+

zowecaview

+

Access View data and perform related tasks.

+

Usage

+

zowe caview <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • download | dl - Download View report data to local folder.
  • +
  • export | exp - Export View text report file to local folder.
  • +
  • get - Get information from View repository.
  • +
  • list | ls - List View repository, report, and user information.
  • +
  • search | find - Search data in a View repository.
  • +
  • set - Set information in View repository.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_download.html b/static/v2.15.x/web_help/docs/zowe_caview_download.html new file mode 100644 index 0000000000..d804c06507 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_download.html @@ -0,0 +1,20 @@ + + + + +caview download + + +
+

zowecaviewdownload

+

Download View report data to local folder.

+

Usage

+

zowe caview download <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_download_report.html b/static/v2.15.x/web_help/docs/zowe_caview_download_report.html new file mode 100644 index 0000000000..c46094b533 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_download_report.html @@ -0,0 +1,198 @@ + + + + +caview download report + + +
+

zowecaviewdownloadreport

+

Download report data.
+Optionally convert text report to PDF.

+

Usage

+

zowe caview download report <repositoryId> <reportHandle> [fileTarget] [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    reportHandle (string)

    +
      +
    • Report handle.
    • +
    +
  • +
  • +

    fileTarget (string)

    +
      +
    • Local file path.
      +If the path represents a directory location, the report will be downloaded into that directory using a default file name.
      +If the path does not represent a directory location, the report will be downloaded into the specified path.
      +If the path is not specified, the file will be saved to the current working directory using the default file name.
      +Any missing directories will be created. If the target file already exists, the file will be overwritten.
    • +
    +
  • +
+

Options

+
    +
  • +

    --convert-to-pdf | --to-pdf (boolean)

    +
      +
    • +

      Converts text report to PDF.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --page-orientation | --orientation (string)

    +
      +
    • +

      Page orientation for converted PDF.

      +

      Default value: PORTRAIT
      +Allowed values: ^PORTRAIT$, ^LANDSCAPE$

      +
    • +
    +
  • +
  • +

    --font-size | --font (number)

    +
      +
    • +

      Font size for converted PDF.

      +

      Default value: 12

      +
    • +
    +
  • +
  • +

    --green-bar (boolean)

    +
      +
    • +

      Include green-bar background in converted PDF.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --pages (string)

    +
      +
    • +

      Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas.
      +Separate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are downloaded.

      +

      Allowed values: ^(\d+(-\d+)?)(,(\d+(-\d+)?))*$

      +
    • +
    +
  • +
  • +

    --content-filter | --filter (string)

    +
      +
    • Filter text report content using a permanent filter definition.
      +If the product instance does not support this feature, this option is ignored.
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_export.html b/static/v2.15.x/web_help/docs/zowe_caview_export.html new file mode 100644 index 0000000000..b9b010660f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_export.html @@ -0,0 +1,20 @@ + + + + +caview export + + +
+

zowecaviewexport

+

Export View text report file to local folder.

+

Usage

+

zowe caview export <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • report | r - Export text report to spreadsheet.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_export_report.html b/static/v2.15.x/web_help/docs/zowe_caview_export_report.html new file mode 100644 index 0000000000..e745861f7a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_export_report.html @@ -0,0 +1,159 @@ + + + + +caview export report + + +
+

zowecaviewexportreport

+

Export text report to spreadsheet using a predefined export rule.

+

Usage

+

zowe caview export report <repositoryId> <reportHandle> <ruleId> [fileTarget] [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    reportHandle (string)

    +
      +
    • Report handle.
    • +
    +
  • +
  • +

    ruleId (number)

    +
      +
    • Export rule identifier.
    • +
    +
  • +
  • +

    fileTarget (string)

    +
      +
    • Local file path.
      +If the path represents a directory location, the report will be exported into that directory using a default file name.
      +If the path does not represent a directory location, the report will be exported into the specified path.
      +If the path is not specified, the file will be saved to the current working directory using the default file name.
      +Any missing directories will be created. If the target file already exists, the file will be overwritten.
    • +
    +
  • +
+

Options

+
    +
  • +

    --pages (string)

    +
      +
    • +

      Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas.
      +Separate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are exported.

      +

      Allowed values: ^(\d+(-\d+)?)(,(\d+(-\d+)?))*$

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_get.html b/static/v2.15.x/web_help/docs/zowe_caview_get.html new file mode 100644 index 0000000000..83e4acc92c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_get.html @@ -0,0 +1,20 @@ + + + + +caview get + + +
+

zowecaviewget

+

Get information from View repository.

+

Usage

+

zowe caview get <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • user - Get user information from repository.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_get_user.html b/static/v2.15.x/web_help/docs/zowe_caview_get_user.html new file mode 100644 index 0000000000..be7cc3b89e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_get_user.html @@ -0,0 +1,20 @@ + + + + +caview get user + + +
+

zowecaviewgetuser

+

Get user information from repository.

+

Usage

+

zowe caview get user <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • settings - Get current user settings from repository.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_get_user_settings.html b/static/v2.15.x/web_help/docs/zowe_caview_get_user_settings.html new file mode 100644 index 0000000000..bf63519ca9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_get_user_settings.html @@ -0,0 +1,158 @@ + + + + +caview get user settings + + +
+

zowecaviewgetusersettings

+

Get current user settings from repository.

+

Usage

+

zowe caview get user settings <repositoryId> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Mode,DistId,ModeAccess,DistMask,Banner,Language,MasterAuthority,Printer,UserId

      +

      Default value: Mode,DistId,ModeAccess,DistMask

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_list.html b/static/v2.15.x/web_help/docs/zowe_caview_list.html new file mode 100644 index 0000000000..daefcec8fe --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_list.html @@ -0,0 +1,26 @@ + + + + +caview list + + +
+

zowecaviewlist

+

List View repository, report, and user information.

+

Usage

+

zowe caview list <command|group>

+

Where <command|group> is one of the following:

+

Commands

+ +

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_list_export-rules.html b/static/v2.15.x/web_help/docs/zowe_caview_list_export-rules.html new file mode 100644 index 0000000000..427cc57dba --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_list_export-rules.html @@ -0,0 +1,159 @@ + + + + +caview list export-rules + + +
+

zowecaviewlistexport-rules

+

List export rules defined for a report.
+Use the returned 'Identifier' in the 'export report' command to reference that rule.

+

Usage

+

zowe caview list export-rules <reportId> [options]

+

Positional Arguments

+
    +
  • +

    reportId (string)

    +
      +
    • Report ID (Name).
    • +
    +
  • +
+

Options

+
    +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Identifier,Name,Description,Owner,Public

      +

      Default value: Identifier,Name,Description

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_list_report.html b/static/v2.15.x/web_help/docs/zowe_caview_list_report.html new file mode 100644 index 0000000000..17c01a583a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_list_report.html @@ -0,0 +1,22 @@ + + + + +caview list report + + +
+

zowecaviewlistreport

+

List information about a specific report.

+

Usage

+

zowe caview list report <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_list_report_index-names.html b/static/v2.15.x/web_help/docs/zowe_caview_list_report_index-names.html new file mode 100644 index 0000000000..98e593d6fd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_list_report_index-names.html @@ -0,0 +1,175 @@ + + + + +caview list report index-names + + +
+

zowecaviewlistreportindex-names

+

List indexes for a a specific report.
+Use the returned 'IndexNameHandle' to reference a report index.
+Use the returned 'IndexNameHandle' in the 'list report index-values' command to retrieve the list of associated index values for that index.

+

Usage

+

zowe caview list report index-names <repositoryId> <reportHandle> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    reportHandle (string)

    +
      +
    • Report handle.
    • +
    +
  • +
+

Options

+
    +
  • +

    --filter-names | --names (string)

    +
      +
    • +

      Filter (include) based on index name. Separate multiple index names with commas. Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *,*,*,*,*,*,*,*

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Index,SubIndexNames,IndexNameHandle

      +

      Default value: Index,SubIndexNames,IndexNameHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_list_report_index-values.html b/static/v2.15.x/web_help/docs/zowe_caview_list_report_index-values.html new file mode 100644 index 0000000000..7982244cb8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_list_report_index-values.html @@ -0,0 +1,181 @@ + + + + +caview list report index-values + + +
+

zowecaviewlistreportindex-values

+

List index values for a report index.
+Use the returned 'ReportHandle' to reference an index value in other commands.
+For example, use 'ReportHandle' in the 'download report' command to download that corresponding view of the report.

+

Usage

+

zowe caview list report index-values <repositoryId> <reportHandle> <indexNameHandle> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    reportHandle (string)

    +
      +
    • Report handle.
    • +
    +
  • +
  • +

    indexNameHandle (string)

    +
      +
    • Index name handle.
    • +
    +
  • +
+

Options

+
    +
  • +

    --filter-values | --values (string)

    +
      +
    • +

      Filter (include) based on index values. Separate index values with commas. Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *,*,*,*,*,*,*,*

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Value,SubValues,ReportHandle

      +

      Default value: Value,SubValues,ReportHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_list_report_logical-views.html b/static/v2.15.x/web_help/docs/zowe_caview_list_report_logical-views.html new file mode 100644 index 0000000000..0305de8a19 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_list_report_logical-views.html @@ -0,0 +1,167 @@ + + + + +caview list report logical-views + + +
+

zowecaviewlistreportlogical-views

+

List logical views available for a specific report.
+Use the returned 'ReportHandle' to reference a logical view in other commands.
+For example, use 'ReportHandle' in the 'download report' command to download the logical view of that report.
+Use the returned 'IndexNameHandle' in the 'list report index-values' command to retrieve the list of associated index values (if defined) for that index.

+

Usage

+

zowe caview list report logical-views <repositoryId> <reportHandle> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    reportHandle (string)

    +
      +
    • Report handle.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Description,Index,SubIndexNames,ReportHandle,IndexNameHandle,Number,ViewId,Default

      +

      Default value: Description,Index,SubIndexNames,ReportHandle,IndexNameHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_list_reports.html b/static/v2.15.x/web_help/docs/zowe_caview_list_reports.html new file mode 100644 index 0000000000..00fe6f8d58 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_list_reports.html @@ -0,0 +1,199 @@ + + + + +caview list reports + + +
+

zowecaviewlistreports

+

List reports in a repository.
+Use the returned 'ReportHandle' to reference a report in other commands.
+For example, use the 'ReportHandle' in the 'download report' command to download that report.

+

Usage

+

zowe caview list reports <repositoryId> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
+

Options

+
    +
  • +

    --filter-name | -n (string)

    +
      +
    • +

      Filter (include) based on report name. Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --limit | -l (number)

    +
      +
    • +

      Limit (maximum number) of retrieved records.

      +

      Default value: 1000

      +
    • +
    +
  • +
  • +

    --latest-versions | --latest-version | --lv (number)

    +
      +
    • +

      Number of latest versions (of reports) to include. If not specified, all versions of reports are included.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --archival-since | --since | --archival-from | --from (string)

    +
      +
    • Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --archival-until | --until | --archival-to | --to (string)

    +
      +
    • Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle,TotalPages,OriginalType,Destination,JobName,Origin,Generation,SequenceNumber,SysoutClass,Status,JobID,Forms,XCode,UserID,ReadDate,PrintDate,OnDisk,OnTape,OnOptical,IndexOnDisk,Location,TapeSequence,TapePosition,TapeCount,ExtendedRetentionOptionID,RemainingDays,RemainingGenerations,RemainingCopy,RemainingDiskDays,RemainingDiskGeneration,RemainingDiskCopy,RemainingDisk2days

      +

      Default value: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_list_repositories.html b/static/v2.15.x/web_help/docs/zowe_caview_list_repositories.html new file mode 100644 index 0000000000..6e99af1ea9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_list_repositories.html @@ -0,0 +1,166 @@ + + + + +caview list repositories + + +
+

zowecaviewlistrepositories

+

List repositories.
+Use the returned 'Identifier' to reference a repository in other commands.
+For example, use the 'Identifier' in the list reports' command to list reports in that repository.

+

Usage

+

zowe caview list repositories [options]

+

Options

+
    +
  • +

    --filter-name | -n (string)

    +
      +
    • Filter (include) based on repository name. Use the percent sign (%) as a wildcard to represent a single character. Use the asterisk (*) as a wildcard to represent any number of characters.
    • +
    +
  • +
  • +

    --filter-path | -p (string)

    +
      +
    • +

      Filter (include) based on repository path. Use the percent sign (%) as a wildcard to represent a single character. Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Identifier,Name,Description,Path,CharacterSet,ReportAccess,CreatedBy,DateCreated,ModifiedBy,ModifiedDate

      +

      Default value: Identifier,Name,Description,Path,CharacterSet

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_search.html b/static/v2.15.x/web_help/docs/zowe_caview_search.html new file mode 100644 index 0000000000..776b5f2c24 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_search.html @@ -0,0 +1,20 @@ + + + + +caview search + + +
+

zowecaviewsearch

+

Search data in a View repository.

+

Usage

+

zowe caview search <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • index - Search cross-report index data in a repository.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_search_index.html b/static/v2.15.x/web_help/docs/zowe_caview_search_index.html new file mode 100644 index 0000000000..90f35aa166 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_search_index.html @@ -0,0 +1,22 @@ + + + + +caview search index + + +
+

zowecaviewsearchindex

+

Search cross-report index data in a repository.

+

Usage

+

zowe caview search index <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • names - Search cross-report index names in a repository.
  • +
  • reports - Search reports containing a cross-report index value in a repository.
  • +
  • values - Search cross-report index values in a repository.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_search_index_names.html b/static/v2.15.x/web_help/docs/zowe_caview_search_index_names.html new file mode 100644 index 0000000000..d292877dd0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_search_index_names.html @@ -0,0 +1,208 @@ + + + + +caview search index names + + +
+

zowecaviewsearchindexnames

+

Search cross-report index names in a repository.
+Use the returned 'IndexNameHandle' to reference a cross-report index name.
+For example, use the 'IndexNameHandle' in the 'search index values' command to retrieve the list of index values for that cross-report index.

+

Usage

+

zowe caview search index names <repositoryId> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
+

Options

+
    +
  • +

    --filter-reports | --reports (string)

    +
      +
    • +

      Filter (include) based on report names (IDs). Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --filter-names | --names (string)

    +
      +
    • +

      Filter (include) based on index name. Separate multiple index names with commas. Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *,*,*,*,*,*,*,*

      +
    • +
    +
  • +
  • +

    --latest-versions | --latest-version | --lv (number)

    +
      +
    • +

      Number of latest versions (of reports) to include. If not specified, all versions of reports are included.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --archival-since | --since | --archival-from | --from (string)

    +
      +
    • Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --archival-until | --until | --archival-to | --to (string)

    +
      +
    • Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --online-only | --online (boolean)

    +
      +
    • +

      Include only those reports that are available online.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Index,SubIndexNames,IndexNameHandle

      +

      Default value: Index,SubIndexNames,IndexNameHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_search_index_reports.html b/static/v2.15.x/web_help/docs/zowe_caview_search_index_reports.html new file mode 100644 index 0000000000..33006aa149 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_search_index_reports.html @@ -0,0 +1,211 @@ + + + + +caview search index reports + + +
+

zowecaviewsearchindexreports

+

Search reports containing a cross-report index value in a repository.
+Use the returned 'ReportHandle' to reference a view of the report.
+For example, use the 'ReportHandle' in the 'download report' command to download that view of the report.

+

Usage

+

zowe caview search index reports <repositoryId> <indexNameHandle> <valueHandle> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    indexNameHandle (string)

    +
      +
    • Index name handle.
    • +
    +
  • +
  • +

    valueHandle (string)

    +
      +
    • Index value handle.
    • +
    +
  • +
+

Options

+
    +
  • +

    --filter-reports | --reports (string)

    +
      +
    • +

      Filter (include) based on report names (IDs). Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --latest-versions | --latest-version | --lv (number)

    +
      +
    • +

      Number of latest versions (of reports) to include. If not specified, all versions of reports are included.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --archival-since | --since | --archival-from | --from (string)

    +
      +
    • Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --archival-until | --until | --archival-to | --to (string)

    +
      +
    • Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --online-only | --online (boolean)

    +
      +
    • +

      Include only those reports that are available online.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle,TotalPages,OriginalType,Destination,JobName,Origin,Generation,SequenceNumber,SysoutClass,Status,JobID,Forms,XCode,UserID,ReadDate,PrintDate,OnDisk,OnTape,OnOptical,IndexOnDisk,Location,TapeSequence,TapePosition,TapeCount,ExtendedRetentionOptionID,RemainingDays,RemainingGenerations,RemainingCopy,RemainingDiskDays,RemainingDiskGeneration,RemainingDiskCopy,RemainingDisk2days

      +

      Default value: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_search_index_values.html b/static/v2.15.x/web_help/docs/zowe_caview_search_index_values.html new file mode 100644 index 0000000000..752b274b1b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_search_index_values.html @@ -0,0 +1,213 @@ + + + + +caview search index values + + +
+

zowecaviewsearchindexvalues

+

Search cross-report index values in a repository.
+Use the returned 'IndexValueHandle' in the 'search index reports' command to retrieve the list of reports containing that index value.

+

Usage

+

zowe caview search index values <repositoryId> <indexNameHandle> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    indexNameHandle (string)

    +
      +
    • Index name handle.
    • +
    +
  • +
+

Options

+
    +
  • +

    --filter-reports | --reports (string)

    +
      +
    • +

      Filter (include) based on report names (IDs). Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --filter-values | --values (string)

    +
      +
    • +

      Filter (include) based on index values. Separate index values with commas. Use the asterisk (*) as a wildcard to represent any number of characters.

      +

      Default value: *,*,*,*,*,*,*,*

      +
    • +
    +
  • +
  • +

    --latest-versions | --latest-version | --lv (number)

    +
      +
    • +

      Number of latest versions (of reports) to include. If not specified, all versions of reports are included.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --archival-since | --since | --archival-from | --from (string)

    +
      +
    • Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --archival-until | --until | --archival-to | --to (string)

    +
      +
    • Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
    • +
    +
  • +
  • +

    --online-only | --online (boolean)

    +
      +
    • +

      Include only those reports that are available online.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Value,SubValues,IndexValueHandle

      +

      Default value: Value,SubValues,IndexValueHandle

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_set.html b/static/v2.15.x/web_help/docs/zowe_caview_set.html new file mode 100644 index 0000000000..e24c09a175 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_set.html @@ -0,0 +1,20 @@ + + + + +caview set + + +
+

zowecaviewset

+

Set information in View repository.

+

Usage

+

zowe caview set <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • user - Set configuration for current user in repository.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_set_user.html b/static/v2.15.x/web_help/docs/zowe_caview_set_user.html new file mode 100644 index 0000000000..7e4b294483 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_set_user.html @@ -0,0 +1,21 @@ + + + + +caview set user + + +
+

zowecaviewsetuser

+

Set configuration for current user in repository.

+

Usage

+

zowe caview set user <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • distribution - Set distribution id for current user in repository.
  • +
  • mode - Set mode for current user in repository.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_set_user_distribution.html b/static/v2.15.x/web_help/docs/zowe_caview_set_user_distribution.html new file mode 100644 index 0000000000..72f01b8e31 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_set_user_distribution.html @@ -0,0 +1,164 @@ + + + + +caview set user distribution + + +
+

zowecaviewsetuserdistribution

+

Set distribution id for current user in repository.

+

Usage

+

zowe caview set user distribution <repositoryId> <distributionId> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    distributionId (string)

    +
      +
    • Distribution ID.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Mode,DistId,ModeAccess,DistMask,Banner,Language,MasterAuthority,Printer,UserId

      +

      Default value: Mode,DistId,ModeAccess,DistMask

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_caview_set_user_mode.html b/static/v2.15.x/web_help/docs/zowe_caview_set_user_mode.html new file mode 100644 index 0000000000..ad3b89ba1a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_caview_set_user_mode.html @@ -0,0 +1,165 @@ + + + + +caview set user mode + + +
+

zowecaviewsetusermode

+

Set mode for current user in repository.

+

Usage

+

zowe caview set user mode <repositoryId> <mode> [options]

+

Positional Arguments

+
    +
  • +

    repositoryId (number)

    +
      +
    • Repository identifier.
    • +
    +
  • +
  • +

    mode (string)

    +
      +
    • User mode.
      +Must match regular expression: ^(ALL|SAR|SARO|EXP|EXPO)$
    • +
    +
  • +
+

Options

+
    +
  • +

    --output-format | --output (string)

    +
      +
    • +

      Output format. This option is ignored if '--response-format-json' is specified.

      +

      Default value: tabular
      +Allowed values: ^tabular$, ^csv$, ^json$, ^xml$

      +
    • +
    +
  • +
  • +

    --output-header | --header (boolean)

    +
      +
    • +

      Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
      +This option is ignored when you specify any other output format.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --output-field | -f (array)

    +
      +
    • +

      Field to include in the output. Multiple fields can be specified.
      +Fields appear in the order you specify.

      +

      Allowed values: Mode,DistId,ModeAccess,DistMask,Banner,Language,MasterAuthority,Printer,UserId

      +

      Default value: Mode,DistId,ModeAccess,DistMask

      +
    • +
    +
  • +
+

View Connection Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --caview-profile | --caview-p (string)

    +
      +
    • The name of a (caview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics.html b/static/v2.15.x/web_help/docs/zowe_cics.html new file mode 100644 index 0000000000..f3888dddf9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics.html @@ -0,0 +1,29 @@ + + + + +cics + + +
+

zowecics

+

Interact with IBM CICS programs and transactions.

+

Usage

+

zowe cics <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_add-to-list.html b/static/v2.15.x/web_help/docs/zowe_cics_add-to-list.html new file mode 100644 index 0000000000..256303d3df --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_add-to-list.html @@ -0,0 +1,20 @@ + + + + +cics add-to-list + + +
+

zowecicsadd-to-list

+

Add new resources (for example, CSD Groups to CSD Lists) to CICS through IBM CMCI.

+

Usage

+

zowe cics add-to-list <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_add-to-list_csdGroup.html b/static/v2.15.x/web_help/docs/zowe_cics_add-to-list_csdGroup.html new file mode 100644 index 0000000000..25bbb89f90 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_add-to-list_csdGroup.html @@ -0,0 +1,148 @@ + + + + +cics add-to-list csdGroup + + +
+

zowecicsadd-to-listcsdGroup

+

Add a CSD Group to a CICS CSD List.

+

Usage

+

zowe cics add-to-list csdGroup <name> <csdList> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • The name of the CSD Group to add. The maximum length of the CSD Group name is eight characters
    • +
    +
  • +
  • +

    csdList (string)

    +
      +
    • The name of the CSD List to add the group to. The maximum length of the CSD List name is eight characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to add the CSD Group to the CSD List
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to add the CSD Group to the CSD List
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Add the CSD Group MYGRP to the CSD List MYLIST in the region named MYREG:

    +
      +
    • zowe cics add-to-list csdGroup MYGRP MYLIST --region-name MYREG
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_define.html b/static/v2.15.x/web_help/docs/zowe_cics_define.html new file mode 100644 index 0000000000..16e9977ff2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_define.html @@ -0,0 +1,25 @@ + + + + +cics define + + +
+

zowecicsdefine

+

Define new resources (for example, programs) to CICS through IBM CMCI.

+

Usage

+

zowe cics define <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_define_program.html b/static/v2.15.x/web_help/docs/zowe_cics_define_program.html new file mode 100644 index 0000000000..13727c591a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_define_program.html @@ -0,0 +1,148 @@ + + + + +cics define program + + +
+

zowecicsdefineprogram

+

Define a new program to CICS.

+

Usage

+

zowe cics define program <programName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    programName (string)

    +
      +
    • The name of the new program to define. The maximum length of the program name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the new program that you want to define. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to define the new program
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to define the new program
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Define a program named PGM123 to the region name MYREGION in the CSD group MYGRP:

    +
      +
    • zowe cics define program PGM123 MYGRP --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_define_transaction.html b/static/v2.15.x/web_help/docs/zowe_cics_define_transaction.html new file mode 100644 index 0000000000..09df32b045 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_define_transaction.html @@ -0,0 +1,154 @@ + + + + +cics define transaction + + +
+

zowecicsdefinetransaction

+

Define a new transaction to CICS.

+

Usage

+

zowe cics define transaction <transactionName> <programName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    transactionName (string)

    +
      +
    • The name of the new transaction to define. The maximum length of the transaction name is four characters.
    • +
    +
  • +
  • +

    programName (string)

    +
      +
    • The name of the program that the transaction uses. The maximum length of the program name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the new transaction that you want to define. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to define the new transaction
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to define the new transaction
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Define a transaction named TRN1 for the program named PGM123 to the region named MYREGION in the CSD group MYGRP:

    +
      +
    • zowe cics define transaction TRN1 PGM123 MYGRP --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_define_urimap-client.html b/static/v2.15.x/web_help/docs/zowe_cics_define_urimap-client.html new file mode 100644 index 0000000000..3a33d106e8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_define_urimap-client.html @@ -0,0 +1,203 @@ + + + + +cics define urimap-client + + +
+

zowecicsdefineurimap-client

+

Define a new URIMAP of type client to CICS. This acts as an HTTP(S) client

+

Usage

+

zowe cics define urimap-client <urimapName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the URIMAP to create. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the new urimap that you want to define. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --urimap-path | --up (string)

    +
      +
    • The path component of the URI.
    • +
    +
  • +
  • +

    --urimap-host | --uh (string)

    +
      +
    • The host component of the URI.
    • +
    +
  • +
+

Options

+
    +
  • +

    --urimap-scheme | --us (string)

    +
      +
    • +

      The scheme component to be used with the request (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --authenticate | --auth (string)

    +
      +
    • +

      The authentication and identification scheme to be used for client URIMAPs.

      +

      Allowed values: NO, BASIC

      +
    • +
    +
  • +
  • +

    --certificate | --cert (string)

    +
      +
    • The label of a certificate in the keyring that is to be used as the client certificate in SSL handshakes
    • +
    +
  • +
  • +

    --description | --desc (string)

    +
      +
    • Description of the URIMAP resource being defined.
    • +
    +
  • +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to define the new URIMAP.
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to define the new URIMAP.
    • +
    +
  • +
  • +

    --enable (boolean)

    +
      +
    • +

      Whether or not the URIMAP is to be enabled on install by default.

      +

      Default value: true

      +
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Define a URIMAP named URIMAPA to the region named MYREGION in the CSD group MYGRP where the host is www.example.com and the path is /example/index.html:

    +
      +
    • zowe cics define urimap-client URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_define_urimap-pipeline.html b/static/v2.15.x/web_help/docs/zowe_cics_define_urimap-pipeline.html new file mode 100644 index 0000000000..277a9423d3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_define_urimap-pipeline.html @@ -0,0 +1,212 @@ + + + + +cics define urimap-pipeline + + +
+

zowecicsdefineurimap-pipeline

+

Define a new URIMAP of type pipeline to CICS. This processes incoming HTTP(S) requests

+

Usage

+

zowe cics define urimap-pipeline <urimapName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the URIMAP to create. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the new urimap that you want to define. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --urimap-path | --up (string)

    +
      +
    • The path component of the URI.
    • +
    +
  • +
  • +

    --urimap-host | --uh (string)

    +
      +
    • The host component of the URI.
    • +
    +
  • +
  • +

    --pipeline-name | --pn (string)

    +
      +
    • The name of the PIPELINE resource definition for the URIMAP. The maximum length of the pipeline name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --urimap-scheme | --us (string)

    +
      +
    • +

      The scheme component to be used with the request (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --description | --desc (string)

    +
      +
    • Description of the URIMAP resource being defined.
    • +
    +
  • +
  • +

    --transaction-name | --tn (string)

    +
      +
    • The name of the TRANSACTION resource definition for the URIMAP. The maximum length of the transaction name is four characters.
    • +
    +
  • +
  • +

    --webservice-name | --wn (string)

    +
      +
    • The name of the WEBSERVICE resource definition for the URIMAP. The maximum length of the transaction name is 32 characters.
    • +
    +
  • +
  • +

    --tcpipservice | --tcpip (string)

    +
      +
    • The TCPIPSERVICE to which the URIMAP definition applies.
    • +
    +
  • +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to define the new URIMAP.
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to define the new URIMAP.
    • +
    +
  • +
  • +

    --enable (boolean)

    +
      +
    • +

      Whether or not the URIMAP is to be enabled on install by default.

      +

      Default value: true

      +
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Define a URIMAP named URIMAPA for the pipeline named PIPE123 to the region named MYREGION in the CSD group MYGRP where the host is www.example.com and the path is /example/index.html:

    +
      +
    • zowe cics define urimap-pipeline URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --pipeline-name PIPE123 --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_define_urimap-server.html b/static/v2.15.x/web_help/docs/zowe_cics_define_urimap-server.html new file mode 100644 index 0000000000..a365a1c99f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_define_urimap-server.html @@ -0,0 +1,200 @@ + + + + +cics define urimap-server + + +
+

zowecicsdefineurimap-server

+

Define a new URIMAP of type server to CICS. This acts as an HTTP(S) server

+

Usage

+

zowe cics define urimap-server <urimapName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the URIMAP to create. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the new urimap that you want to define. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --urimap-path | --up (string)

    +
      +
    • The path component of the URI.
    • +
    +
  • +
  • +

    --urimap-host | --uh (string)

    +
      +
    • The host component of the URI.
    • +
    +
  • +
  • +

    --program-name | --pn (string)

    +
      +
    • The application program that makes or handles the requests.
    • +
    +
  • +
+

Options

+
    +
  • +

    --urimap-scheme | --us (string)

    +
      +
    • +

      The scheme component to be used with the request (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --description | --desc (string)

    +
      +
    • Description of the URIMAP resource being defined.
    • +
    +
  • +
  • +

    --tcpipservice | --tcpip (string)

    +
      +
    • The TCPIPSERVICE to which the URIMAP definition applies.
    • +
    +
  • +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to define the new URIMAP.
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to define the new URIMAP.
    • +
    +
  • +
  • +

    --enable (boolean)

    +
      +
    • +

      Whether or not the URIMAP is to be enabled on install by default.

      +

      Default value: true

      +
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Define a URIMAP named URIMAPA for the program named PGM123 to the region named MYREGION in the CSD group MYGRP where the host is www.example.com and the path is /example/index.html:

    +
      +
    • zowe cics define urimap-server URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --program-name PGM123 --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_define_webservice.html b/static/v2.15.x/web_help/docs/zowe_cics_define_webservice.html new file mode 100644 index 0000000000..226dd4052e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_define_webservice.html @@ -0,0 +1,184 @@ + + + + +cics define webservice + + +
+

zowecicsdefinewebservice

+

Define a new web service to CICS.

+

Usage

+

zowe cics define webservice <webserviceName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    webserviceName (string)

    +
      +
    • The name of the WEBSERVICE to create. The maximum length of the web service name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the new web service that you want to define. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --pipeline-name | --pn (string)

    +
      +
    • The name of the PIPELINE resource definition for the web service. The maximum length of the pipeline name is eight characters
    • +
    +
  • +
  • +

    --wsbind (string)

    +
      +
    • The file name of the web service binding file on HFS.
    • +
    +
  • +
+

Options

+
    +
  • +

    --description | --desc (string)

    +
      +
    • Description of the web service resource being defined.
    • +
    +
  • +
  • +

    --validation (boolean)

    +
      +
    • +

      Specifies whether full validation of SOAP messages against the corresponding schema in the web service description should be performed at run time.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --wsdlfile | --wsdl (string)

    +
      +
    • The file name of the web service description (WSDL) file on HFS.
    • +
    +
  • +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to define the new web service.
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to define the new web service.
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Define a webservice named WEBSVCA for the pipeline named PIPE123 to the region named MYREGION in the CSD group MYGRP where the binding file is /u/exampleapp/wsbind/example.log:

    +
      +
    • zowe cics define webservice WEBSVCA MYGRP --pipeline-name PIPELINE --wsbind /u/exampleapp/wsbind/example.log --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_delete.html b/static/v2.15.x/web_help/docs/zowe_cics_delete.html new file mode 100644 index 0000000000..a0bf271f23 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_delete.html @@ -0,0 +1,23 @@ + + + + +cics delete + + +
+

zowecicsdelete

+

Delete resources (for example, programs) from CICS through IBM CMCI.

+

Usage

+

zowe cics delete <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_delete_program.html b/static/v2.15.x/web_help/docs/zowe_cics_delete_program.html new file mode 100644 index 0000000000..0521ba737d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_delete_program.html @@ -0,0 +1,148 @@ + + + + +cics delete program + + +
+

zowecicsdeleteprogram

+

Delete a program from CICS.

+

Usage

+

zowe cics delete program <programName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    programName (string)

    +
      +
    • The name of the program to delete. The maximum length of the program name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the program that you want to delete. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to delete the program
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex from which to delete the program
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a program named PGM123 from the region named MYREGION:

    +
      +
    • zowe cics delete program PGM123 --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_delete_transaction.html b/static/v2.15.x/web_help/docs/zowe_cics_delete_transaction.html new file mode 100644 index 0000000000..ce5c567407 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_delete_transaction.html @@ -0,0 +1,148 @@ + + + + +cics delete transaction + + +
+

zowecicsdeletetransaction

+

Delete a transaction from CICS.

+

Usage

+

zowe cics delete transaction <transactionName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    transactionName (string)

    +
      +
    • The name of the transaction to delete. The maximum length of the transaction name is four characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the transaction that you want to delete. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to delete the transaction
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex from which to delete the transaction
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a transaction named TRN1 from the region named MYREGION:

    +
      +
    • zowe cics delete transaction TRN1 MYGRP --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_delete_urimap.html b/static/v2.15.x/web_help/docs/zowe_cics_delete_urimap.html new file mode 100644 index 0000000000..a02b270053 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_delete_urimap.html @@ -0,0 +1,142 @@ + + + + +cics delete urimap + + +
+

zowecicsdeleteurimap

+

Delete a urimap from CICS.

+

Usage

+

zowe cics delete urimap <urimapName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the urimap to delete. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the urimap that you want to delete. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to delete the urimap
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a urimap named URIMAPA from the region named MYREGION belonging to the csdgroup MYGRP:

    +
      +
    • zowe cics delete urimap URIMAPA MYGRP --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_delete_webservice.html b/static/v2.15.x/web_help/docs/zowe_cics_delete_webservice.html new file mode 100644 index 0000000000..81d12cc466 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_delete_webservice.html @@ -0,0 +1,142 @@ + + + + +cics delete webservice + + +
+

zowecicsdeletewebservice

+

Delete a web service from CICS.

+

Usage

+

zowe cics delete webservice <webserviceName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    webserviceName (string)

    +
      +
    • The name of the web service to delete. The maximum length of the web service name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the web service that you want to delete. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to delete the web service
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a web service named WEBSVCA from the region named MYREGION belonging to the csdgroup MYGRP:

    +
      +
    • zowe cics delete webservice WEBSVCA MYGRP --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_disable.html b/static/v2.15.x/web_help/docs/zowe_cics_disable.html new file mode 100644 index 0000000000..1973ccb0af --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_disable.html @@ -0,0 +1,20 @@ + + + + +cics disable + + +
+

zowecicsdisable

+

Disable resources (for example, urimaps) from CICS through IBM CMCI.

+

Usage

+

zowe cics disable <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • urimap - Disable a urimap from CICS.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_disable_urimap.html b/static/v2.15.x/web_help/docs/zowe_cics_disable_urimap.html new file mode 100644 index 0000000000..5114e52f54 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_disable_urimap.html @@ -0,0 +1,136 @@ + + + + +cics disable urimap + + +
+

zowecicsdisableurimap

+

Disable a urimap from CICS.

+

Usage

+

zowe cics disable urimap <urimapName> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the urimap to disable. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name in which to disable the urimap
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Disable a urimap named URIMAPA from the region named MYREGION:

    +
      +
    • zowe cics disable urimap URIMAPA --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_discard.html b/static/v2.15.x/web_help/docs/zowe_cics_discard.html new file mode 100644 index 0000000000..328a35036a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_discard.html @@ -0,0 +1,22 @@ + + + + +cics discard + + +
+

zowecicsdiscard

+

Discard resources (for example, programs) from CICS through IBM CMCI.

+

Usage

+

zowe cics discard <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_discard_program.html b/static/v2.15.x/web_help/docs/zowe_cics_discard_program.html new file mode 100644 index 0000000000..72b23f6b97 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_discard_program.html @@ -0,0 +1,142 @@ + + + + +cics discard program + + +
+

zowecicsdiscardprogram

+

Discard a program from CICS.

+

Usage

+

zowe cics discard program <programName> [options]

+

Positional Arguments

+
    +
  • +

    programName (string)

    +
      +
    • The name of the program to discard. The maximum length of the program name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to discard the program
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex from which to discard the program
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Discard a program named PGM123 from the region named MYREGION:

    +
      +
    • zowe cics discard program PGM123 --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_discard_transaction.html b/static/v2.15.x/web_help/docs/zowe_cics_discard_transaction.html new file mode 100644 index 0000000000..94071abd38 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_discard_transaction.html @@ -0,0 +1,142 @@ + + + + +cics discard transaction + + +
+

zowecicsdiscardtransaction

+

Discard a transaction from CICS.

+

Usage

+

zowe cics discard transaction <transactionName> [options]

+

Positional Arguments

+
    +
  • +

    transactionName (string)

    +
      +
    • The name of the transaction to discard. The maximum length of the transaction name is four characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to discard the transaction
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex from which to discard the transaction
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Discard a transaction named TRN1 from the region named MYREGION:

    +
      +
    • zowe cics discard transaction TRN1 --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_discard_urimap.html b/static/v2.15.x/web_help/docs/zowe_cics_discard_urimap.html new file mode 100644 index 0000000000..8e9bf1d61e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_discard_urimap.html @@ -0,0 +1,136 @@ + + + + +cics discard urimap + + +
+

zowecicsdiscardurimap

+

Discard a urimap from CICS.

+

Usage

+

zowe cics discard urimap <urimapName> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the urimap to discard. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name from which to discard the urimap
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Discard a urimap named URIMAPA from the region named MYREGION:

    +
      +
    • zowe cics discard urimap URIMAPA --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_enable.html b/static/v2.15.x/web_help/docs/zowe_cics_enable.html new file mode 100644 index 0000000000..204dc35cd8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_enable.html @@ -0,0 +1,20 @@ + + + + +cics enable + + +
+

zowecicsenable

+

Enable resources (for example, urimaps) from CICS through IBM CMCI.

+

Usage

+

zowe cics enable <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • urimap - Enable a urimap from CICS.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_enable_urimap.html b/static/v2.15.x/web_help/docs/zowe_cics_enable_urimap.html new file mode 100644 index 0000000000..e9af2dd13f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_enable_urimap.html @@ -0,0 +1,136 @@ + + + + +cics enable urimap + + +
+

zowecicsenableurimap

+

Enable a urimap from CICS.

+

Usage

+

zowe cics enable urimap <urimapName> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the urimap to enable. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name in which to enable the urimap
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Enable a urimap named URIMAPA from the region named MYREGION:

    +
      +
    • zowe cics enable urimap URIMAPA --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_get.html b/static/v2.15.x/web_help/docs/zowe_cics_get.html new file mode 100644 index 0000000000..8fe3c4954c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_get.html @@ -0,0 +1,20 @@ + + + + +cics get + + +
+

zowecicsget

+

Get resources (for example, programs or transactions) from CICS through IBM CMCI.

+

Usage

+

zowe cics get <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • resource | res - Get resources (for example, programs or transactions) from CICS.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_get_resource.html b/static/v2.15.x/web_help/docs/zowe_cics_get_resource.html new file mode 100644 index 0000000000..3d75bcbaa1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_get_resource.html @@ -0,0 +1,230 @@ + + + + +cics get resource + + +
+

zowecicsgetresource

+

Get resources (for example, programs or transactions) from CICS.

+

Usage

+

zowe cics get resource <resourceName> [options]

+

Positional Arguments

+
    +
  • +

    resourceName (string)

    +
      +
    • The name of the resource to get.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name | --rn (string)

    +
      +
    • The CICS region name from which to get the resources
    • +
    +
  • +
  • +

    --cics-plex | --cp (string)

    +
      +
    • The name of the CICSPlex from which to get the resources
    • +
    +
  • +
  • +

    --criteria | -c (string)

    +
      +
    • The criteria by which to filter the resource
    • +
    +
  • +
  • +

    --parameter | -p (string)

    +
      +
    • The parameter by which to refine the resource
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get program resources from the region named MYREGION:

    +
      +
    • zowe cics get resource CICSProgram --region-name MYREGION
    • +
    +
  • +
  • +

    Get local transaction resources from the region named MYREGION:

    +
      +
    • zowe cics get resource CICSLocalTransaction --region-name MYREGION
    • +
    +
  • +
  • +

    Get local file resources from the region named MYREGION:

    +
      +
    • zowe cics get resource CICSLocalFile --region-name MYREGION
    • +
    +
  • +
  • +

    Get program definition resources from the CSD group named GRP1 and the region named MYREGION:

    +
      +
    • zowe cics get resource CICSDefinitionProgram --region-name MYREGION --parameter "CSDGROUP(GRP1)"
    • +
    +
  • +
  • +

    Get transaction definition resources from the CSD group named GRP1 and the region named MYREGION:

    +
      +
    • zowe cics get resource CICSDefinitionTransaction --region-name MYREGION --parameter "CSDGROUP(GRP1)"
    • +
    +
  • +
  • +

    Get URIMap definition resources from the CSD group named GRP1 and the region named MYREGION:

    +
      +
    • zowe cics get resource CICSDefinitionURIMap --region-name MYREGION --parameter "CSDGROUP(GRP1)"
    • +
    +
  • +
  • +

    Get program resources that start with the name PRG from the region named MYREGION:

    +
      +
    • zowe cics get resource CICSProgram --region-name MYREGION --criteria "PROGRAM=PRG*"
    • +
    +
  • +
  • +

    Get a local transaction resource named TRAN from the region named MYREGION:

    +
      +
    • zowe cics get resource CICSLocalTransaction --region-name MYREGION --criteria "TRANID=TRAN"
    • +
    +
  • +
  • +

    Get program resources that start with the name MYPRG from the region named MYREGION and display various fields as a table:

    +
      +
    • zowe cics get resource CICSProgram --region-name MYREGION --criteria "PROGRAM=MYPRG*" --rft table --rfh --rff program length status
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_install.html b/static/v2.15.x/web_help/docs/zowe_cics_install.html new file mode 100644 index 0000000000..404fcf4db5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_install.html @@ -0,0 +1,22 @@ + + + + +cics install + + +
+

zowecicsinstall

+

Install resources (for example, programs) to CICS through IBM CMCI.

+

Usage

+

zowe cics install <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_install_program.html b/static/v2.15.x/web_help/docs/zowe_cics_install_program.html new file mode 100644 index 0000000000..0df02160d0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_install_program.html @@ -0,0 +1,148 @@ + + + + +cics install program + + +
+

zowecicsinstallprogram

+

Install a program to CICS.

+

Usage

+

zowe cics install program <programName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    programName (string)

    +
      +
    • The name of the program to install. The maximum length of the program name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the program that you want to install. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to install the program
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to install the program
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Install a program named PGM123 to the region named MYREGION in the CSD group MYGRP:

    +
      +
    • zowe cics install program PGM123 MYGRP --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_install_transaction.html b/static/v2.15.x/web_help/docs/zowe_cics_install_transaction.html new file mode 100644 index 0000000000..73faa18a02 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_install_transaction.html @@ -0,0 +1,148 @@ + + + + +cics install transaction + + +
+

zowecicsinstalltransaction

+

Install a transaction to CICS.

+

Usage

+

zowe cics install transaction <transactionName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    transactionName (string)

    +
      +
    • The name of the transaction to install. The maximum length of the transaction name is four characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the transaction that you want to install. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to install the transaction
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to install the transaction
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Install a transaction named TRN1 to the region named MYREGION in the CSD group MYGRP:

    +
      +
    • zowe cics install transaction TRN1 MYGRP --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_install_urimap.html b/static/v2.15.x/web_help/docs/zowe_cics_install_urimap.html new file mode 100644 index 0000000000..42c257187a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_install_urimap.html @@ -0,0 +1,142 @@ + + + + +cics install urimap + + +
+

zowecicsinstallurimap

+

Install a urimap to CICS.

+

Usage

+

zowe cics install urimap <urimapName> <csdGroup> [options]

+

Positional Arguments

+
    +
  • +

    urimapName (string)

    +
      +
    • The name of the urimap to install. The maximum length of the urimap name is eight characters.
    • +
    +
  • +
  • +

    csdGroup (string)

    +
      +
    • The CICS system definition (CSD) Group for the urimap that you want to install. The maximum length of the group name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to install the urimap
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Install a urimap named URIMAPA to the region named MYREGION belonging to the csdgroup MYGRP:

    +
      +
    • zowe cics install urimap URIMAPA CSDGROUP --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_refresh.html b/static/v2.15.x/web_help/docs/zowe_cics_refresh.html new file mode 100644 index 0000000000..1628506847 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_refresh.html @@ -0,0 +1,20 @@ + + + + +cics refresh + + +
+

zowecicsrefresh

+

Refresh a program on CICS through IBM CMCI.

+

Usage

+

zowe cics refresh <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_refresh_program.html b/static/v2.15.x/web_help/docs/zowe_cics_refresh_program.html new file mode 100644 index 0000000000..86d5643bf7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_refresh_program.html @@ -0,0 +1,142 @@ + + + + +cics refresh program + + +
+

zowecicsrefreshprogram

+

Refresh a program on CICS.

+

Usage

+

zowe cics refresh program <programName> [options]

+

Positional Arguments

+
    +
  • +

    programName (string)

    +
      +
    • The name of the program to refresh. The maximum length of the program name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name on which you want to refresh the program
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex on which to refresh the program
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Refresh a program named PGM123 from the region named MYREGION:

    +
      +
    • zowe cics refresh program PGM123 --region-name MYREGION
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_remove-from-list.html b/static/v2.15.x/web_help/docs/zowe_cics_remove-from-list.html new file mode 100644 index 0000000000..8a869303f1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_remove-from-list.html @@ -0,0 +1,20 @@ + + + + +cics remove-from-list + + +
+

zowecicsremove-from-list

+

Remove resources (for example, CSD Groups in CSD Lists) from CICS through IBM CMCI.

+

Usage

+

zowe cics remove-from-list <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_cics_remove-from-list_csdGroup.html b/static/v2.15.x/web_help/docs/zowe_cics_remove-from-list_csdGroup.html new file mode 100644 index 0000000000..b7032da8d4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_cics_remove-from-list_csdGroup.html @@ -0,0 +1,148 @@ + + + + +cics remove-from-list csdGroup + + +
+

zowecicsremove-from-listcsdGroup

+

Remove a CSD Group from a CICS CSD List.

+

Usage

+

zowe cics remove-from-list csdGroup <name> <csdList> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • The name of the CSD Group to remove. The maximum length of the CSD Group name is eight characters
    • +
    +
  • +
  • +

    csdList (string)

    +
      +
    • The name of the CSD List to remove the group from. The maximum length of the CSD List name is eight characters
    • +
    +
  • +
+

Options

+
    +
  • +

    --region-name (string)

    +
      +
    • The CICS region name to which to remove the CSD Group from the CSD List
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to which to remove the CSD Group from the CSD List
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CICS server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CICS server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (CICS) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Mainframe (CICS) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --cics-profile | --cics-p (string)

    +
      +
    • The name of a (cics) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Remove the CSD Group MYGRP from the CSD List MYLIST in the region named MYREG:

    +
      +
    • zowe cics remove-from-list csdGroup MYGRP MYLIST --region-name MYREG
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config.html b/static/v2.15.x/web_help/docs/zowe_config.html new file mode 100644 index 0000000000..1662fe4355 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config.html @@ -0,0 +1,31 @@ + + + + +config + + +
+

zoweconfig

+

Manage JSON project and global configuration

+

Usage

+

zowe config <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config_auto-init.html b/static/v2.15.x/web_help/docs/zowe_config_auto-init.html new file mode 100644 index 0000000000..763902330e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config_auto-init.html @@ -0,0 +1,135 @@ + + + + +config auto-init + + +
+

zoweconfigauto-init

+

Automatically generate a config from APIML

+

Usage

+

zowe config auto-init [options]

+

Automatic Config Initialization Options

+
    +
  • +

    --user-config | --uc (boolean)

    +
      +
    • +

      Save config in the user layer

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --global-config | --gc (boolean)

    +
      +
    • +

      Save config in the global layer

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --dry-run | --dr | --dry (boolean)

    +
      +
    • Display the outcome of the initialization without saving
    • +
    +
  • +
  • +

    --edit | -e (boolean)

    +
      +
    • Open in editor after initializing the configuration
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • +

      Replaces an existing configuration with a new configuration

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --for-sure | -f (boolean)

    +
      +
    • +

      Confirms the overwrite option

      +

      Default value: false

      +
    • +
    +
  • +
+

APIML Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the mainframe running the API Mediation Layer.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of API Mediation Layer on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to the API Mediation Layer on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to the API Mediation Layer on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • The type of token to get and use for the API Mediation Layer. Omit this option to use the default token type, which is provided by 'zowe auth login'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API Mediation Layer.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use to authenticate to the API Mediation Layer
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use to authenticate to the API Mediation Layer
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config_convert-profiles.html b/static/v2.15.x/web_help/docs/zowe_config_convert-profiles.html new file mode 100644 index 0000000000..c147ab3f42 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config_convert-profiles.html @@ -0,0 +1,48 @@ + + + + +config convert-profiles + + +
+

zoweconfigconvert-profiles

+

Convert v1 profiles to a global zowe.config.json file.

+

Usage

+

zowe config convert-profiles [options]

+

Options

+
    +
  • +

    --prompt (boolean)

    +
      +
    • +

      Prompt for confirmation. Use --no-prompt to disable prompting.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --delete (boolean)

    +
      +
    • Delete the existing profiles on disk and any securely stored secrets.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Convert profiles to team config without prompting:

    +
      +
    • zowe config convert-profiles --no-prompt
    • +
    +
  • +
  • +

    Convert profiles to team config and delete the old profiles:

    +
      +
    • zowe config convert-profiles --delete
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config_edit.html b/static/v2.15.x/web_help/docs/zowe_config_edit.html new file mode 100644 index 0000000000..a623a331b5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config_edit.html @@ -0,0 +1,46 @@ + + + + +config edit + + +
+

zoweconfigedit

+

Edit an existing config file in your system's default text editor.

+

In a graphical environment, the application associated with JSON files will be launched. In a command-line environment, vi will be launched. To override the command-line editor used, specify it in the ZOWE_EDITOR environment variable.

+

Usage

+

zowe config edit [options]

+

Options

+
    +
  • +

    --global-config | --gc (boolean)

    +
      +
    • +

      Target the global config files.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --user-config | --uc (boolean)

    +
      +
    • +

      Target the user config files.

      +

      Default value: false

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Edit global config file:

    +
      +
    • zowe config edit --global-config
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config_import.html b/static/v2.15.x/web_help/docs/zowe_config_import.html new file mode 100644 index 0000000000..d10e1930fc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config_import.html @@ -0,0 +1,94 @@ + + + + +config import + + +
+

zoweconfigimport

+

Import config files from another location on disk or from an Internet URL.

+

If the config `$schema` property points to a relative path, the schema will also be imported.

+

Usage

+

zowe config import <location> [options]

+

Positional Arguments

+
    +
  • +

    location (string)

    +
      +
    • File path or URL to import from.
    • +
    +
  • +
+

Options

+
    +
  • +

    --global-config | --gc (boolean)

    +
      +
    • +

      Target the global config files.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --user-config | --uc (boolean)

    +
      +
    • +

      Target the user config files.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • +

      Overwrite config file if one already exists.

      +

      Default value: false

      +
    • +
    +
  • +
+

Connection Options

+
    +
  • +

    --user | -u (string)

    +
      +
    • User name if authentication is required to download the config from a URL.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password if authentication is required to download the config from a URL.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates if config is downloaded from an HTTPS URL.

      +

      Default value: true

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Import config from local file on disk:

    +
      +
    • zowe config import ~/Downloads/zowe.config.json
    • +
    +
  • +
  • +

    Import global config from Internet URL:

    +
      +
    • zowe config import https://example.com/zowe.config.json --global-config
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config_init.html b/static/v2.15.x/web_help/docs/zowe_config_init.html new file mode 100644 index 0000000000..041d30342a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config_init.html @@ -0,0 +1,119 @@ + + + + +config init + + +
+

zoweconfiginit

+

Initialize config files. Defaults to initializing "zowe.config.json" in the current working directory unless otherwise specified.

+

Use "--user-config" to init "zowe.config.user.json". Use "--global-config" to initialize the configuration files in your home "~/.zowe" directory.

+

Use "--no-prompt" to skip prompting for values in a CI environment.

+

Usage

+

zowe config init [options]

+

Options

+
    +
  • +

    --global-config | --gc (boolean)

    +
      +
    • +

      Target the global config files.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --user-config | --uc (boolean)

    +
      +
    • +

      Target the user config files.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --prompt (boolean)

    +
      +
    • +

      Prompt for missing values in the base profile. Useful for disabling prompting in CI environments.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Replace existing config files instead of merging the new changes.
    • +
    +
  • +
  • +

    --for-sure | --fs (boolean)

    +
      +
    • +

      Confirms the overwrite option.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --dry-run | --dr | --dry (boolean)

    +
      +
    • Display the outcome of the initialization without saving it.
    • +
    +
  • +
  • +

    --edit | -e (boolean)

    +
      +
    • Open in editor after initializing the configuration
    • +
    +
  • +
+

Examples

+
    +
  • +

    Initialize configuration files in your home "~/.zowe" directory:

    +
      +
    • zowe config init --global-config
    • +
    +
  • +
  • +

    Do a dry run of initializing configuration files in your home "~/.zowe" directory:

    +
      +
    • zowe config init --global-config --dry-run
    • +
    +
  • +
  • +

    Initialize the user config files:

    +
      +
    • zowe config init --user-config
    • +
    +
  • +
  • +

    Initialize the user config files and do not prompt for secure values:

    +
      +
    • zowe config init --user-config --prompt false
    • +
    +
  • +
  • +

    Do a dry run of initializing the user config files and do not prompt for secure values:

    +
      +
    • zowe config init --user-config --prompt false --dry-run
    • +
    +
  • +
  • +

    Overwrite any existing global config files:

    +
      +
    • zowe config init --global-config --overwrite --for-sure
    • +
    +
  • +
  • +

    Overwrite any existing user config files:

    +
      +
    • zowe config init --user-config --overwrite --for-sure
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config_list.html b/static/v2.15.x/web_help/docs/zowe_config_list.html new file mode 100644 index 0000000000..64acd31e4e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config_list.html @@ -0,0 +1,72 @@ + + + + +config list + + +
+

zoweconfiglist

+

List config properties

+

Usage

+

zowe config list [property] [options]

+

Positional Arguments

+
    +
  • +

    property (string)

    +
      +
    • The config property to list. Blank to list all properties.
    • +
    +
  • +
+

Options

+
    +
  • +

    --locations (boolean)

    +
      +
    • Separate the config properties into their respective config file locations. Helpful to determine where configuration value is specified.
    • +
    +
  • +
  • +

    --root (boolean)

    +
      +
    • List only the root level property names. For example, specify in addition to '--locations' to get a list of config file paths only.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List property names for a specified config property:

    +
      +
    • zowe config list "defaults"
    • +
    +
  • +
  • +

    List only root level property names for a specified config property:

    +
      +
    • zowe config list "defaults" --root
    • +
    +
  • +
  • +

    List config properties by separating them by their respective config file locations:

    +
      +
    • zowe config list --locations
    • +
    +
  • +
  • +

    List only the root level configuration property names:

    +
      +
    • zowe config list --root
    • +
    +
  • +
  • +

    List only the root level configuration properties by separating them by their respective config file locations:

    +
      +
    • zowe config list --locations --root
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config_profiles.html b/static/v2.15.x/web_help/docs/zowe_config_profiles.html new file mode 100644 index 0000000000..2a0779ee07 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config_profiles.html @@ -0,0 +1,24 @@ + + + + +config profiles + + +
+

zoweconfigprofiles

+

Displays profile paths.

+

Usage

+

zowe config profiles [options]

+

Examples

+
    +
  • +

    Display profile paths:

    +
      +
    • zowe config profiles
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config_report-env.html b/static/v2.15.x/web_help/docs/zowe_config_report-env.html new file mode 100644 index 0000000000..e5544f119c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config_report-env.html @@ -0,0 +1,30 @@ + + + + +config report-env + + +
+

zoweconfigreport-env

+

Reports key items from your environment and identifies problem conditions

+

Usage

+

zowe config report-env [options]

+

Examples

+
    +
  • +

    Report information and issues about your working environment:

    +
      +
    • zowe config report-env
    • +
    +
  • +
  • +

    Save the report about your working environment to a file:

    +
      +
    • zowe config report-env > report.log
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config_schema.html b/static/v2.15.x/web_help/docs/zowe_config_schema.html new file mode 100644 index 0000000000..03e1c81279 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config_schema.html @@ -0,0 +1,24 @@ + + + + +config schema + + +
+

zoweconfigschema

+

Dumps the JSON schema for the config. The schema is dynamically created based on your available plugins. Direct the output of this command to a file and include in your config with '$schema' property to get editor completion.

+

Usage

+

zowe config schema [options]

+

Examples

+
    +
  • +

    Display the JSON schema for the config:

    +
      +
    • zowe config schema
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config_secure.html b/static/v2.15.x/web_help/docs/zowe_config_secure.html new file mode 100644 index 0000000000..647e5a0454 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config_secure.html @@ -0,0 +1,60 @@ + + + + +config secure + + +
+

zoweconfigsecure

+

prompt for secure configuration properties

+

Usage

+

zowe config secure [options]

+

Options

+
    +
  • +

    --global-config | --gc (boolean)

    +
      +
    • +

      Secure properties in global config.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --user-config | --uc (boolean)

    +
      +
    • +

      Secure properties in user config.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --prune | -p (boolean)

    +
      +
    • +

      Delete properties stored in the vault for team config files that do not exist.

      +

      Default value: false

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Secure the properties in global config:

    +
      +
    • zowe config secure --global-config
    • +
    +
  • +
  • +

    Secure the properties in user config:

    +
      +
    • zowe config secure --user-config
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config_set.html b/static/v2.15.x/web_help/docs/zowe_config_set.html new file mode 100644 index 0000000000..e150a349a6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config_set.html @@ -0,0 +1,105 @@ + + + + +config set + + +
+

zoweconfigset

+

create or update a configuration property

+

Usage

+

zowe config set <property> [value] [options]

+

Positional Arguments

+
    +
  • +

    property (string)

    +
      +
    • The property to set. You may specify a path using dot notation (e.g. profiles.host1.profiles.service1.properties.setting)
    • +
    +
  • +
  • +

    value (string)

    +
      +
    • The property value to set. The value may be JSON. Use '--json' to indicate.
    • +
    +
  • +
+

Options

+
    +
  • +

    --global-config | --gc (boolean)

    +
      +
    • +

      Set the property in global config.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --user-config | --uc (boolean)

    +
      +
    • +

      Set the property in user config.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --json (boolean)

    +
      +
    • +

      The property value is JSON.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --secure (boolean)

    +
      +
    • Store the property value securely. If omitted, any property named in the secure array of the config file will be saved securely.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the property in global config:

    +
      +
    • zowe config set "profiles.host1.profiles.service1.properties.setting" "value" --global-config
    • +
    +
  • +
  • +

    Set the property in user config:

    +
      +
    • zowe config set "profiles.host1.profiles.service2.properties.setting" "value" --user-config
    • +
    +
  • +
  • +

    Set property value to JSON:

    +
      +
    • zowe config set "profiles.host1.profiles.service3.properties.setting" "{"property":"value"}" --json
    • +
    +
  • +
  • +

    Store the property value:

    +
      +
    • zowe config set "profiles.host1.profiles.service1.properties.setting" "value" --secure
    • +
    +
  • +
  • +

    Set a default zosmf profile:

    +
      +
    • zowe config set "defaults.zosmf" "zosmfProfileName"
    • +
    +
  • +
  • +

    Set a default tso profile:

    +
      +
    • zowe config set "defaults.tso" "tsoProfileName"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_config_update-schemas.html b/static/v2.15.x/web_help/docs/zowe_config_update-schemas.html new file mode 100644 index 0000000000..2c19716c00 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_config_update-schemas.html @@ -0,0 +1,43 @@ + + + + +config update-schemas + + +
+

zoweconfigupdate-schemas

+

Update schema files by looking up the directory structure.

+

Schema files up in higher level directories will always be updated. To also update schema files down in lower level directories, specify the `--depth` flag.

+

Usage

+

zowe config update-schemas [options]

+

Options

+
    +
  • +

    --depth (number)

    +
      +
    • +

      Specifies how many levels down the directory structure should the schemas be updated.

      +

      Default value: 0

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update all schema files found in higher level directories:

    +
      +
    • zowe config update-schemas
    • +
    +
  • +
  • +

    Update all schema files found in higher level directories and 2 levels down the directory structure:

    +
      +
    • zowe config update-schemas --depth 2
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_daemon.html b/static/v2.15.x/web_help/docs/zowe_daemon.html new file mode 100644 index 0000000000..a848e1b3c5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_daemon.html @@ -0,0 +1,22 @@ + + + + +daemon + + +
+

zowedaemon

+

Perform operations that control the daemon-mode functionality of the Zowe CLI. Daemon-mode runs the CLI command processor as a daemon to improve performance.

+

Usage

+

zowe daemon <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • disable - Disables daemon-mode operation of the Zowe CLI.
  • +
  • enable - Enables daemon-mode operation of the Zowe CLI. You only need to run the enable command once after each new installation of the Zowe CLI. Afterwards, any zowe command will automatically start a daemon as needed.
  • +
  • restart - Restart the Zowe CLI daemon.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_daemon_disable.html b/static/v2.15.x/web_help/docs/zowe_daemon_disable.html new file mode 100644 index 0000000000..a772fac979 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_daemon_disable.html @@ -0,0 +1,24 @@ + + + + +daemon disable + + +
+

zowedaemondisable

+

Disables daemon-mode operation of the Zowe CLI.

+

Usage

+

zowe daemon disable [options]

+

Examples

+
    +
  • +

    Disable daemon-mode:

    +
      +
    • zowe daemon disable
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_daemon_enable.html b/static/v2.15.x/web_help/docs/zowe_daemon_enable.html new file mode 100644 index 0000000000..bfde540b3d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_daemon_enable.html @@ -0,0 +1,24 @@ + + + + +daemon enable + + +
+

zowedaemonenable

+

Enables daemon-mode operation of the Zowe CLI. You only need to run the enable command once after each new installation of the Zowe CLI. Afterwards, any zowe command will automatically start a daemon as needed.

+

Usage

+

zowe daemon enable [options]

+

Examples

+
    +
  • +

    Enable daemon-mode:

    +
      +
    • zowe daemon enable
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_daemon_restart.html b/static/v2.15.x/web_help/docs/zowe_daemon_restart.html new file mode 100644 index 0000000000..d4f19766c7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_daemon_restart.html @@ -0,0 +1,24 @@ + + + + +daemon restart + + +
+

zowedaemonrestart

+

Restart the Zowe CLI daemon.

+

Usage

+

zowe daemon restart [options]

+

Examples

+
    +
  • +

    Restart daemon:

    +
      +
    • zowe daemon restart
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_db2.html b/static/v2.15.x/web_help/docs/zowe_db2.html new file mode 100644 index 0000000000..6c66cc0d45 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_db2.html @@ -0,0 +1,22 @@ + + + + +db2 + + +
+

zowedb2

+

Interact with IBM Db2 for z/OS

+

Usage

+

zowe db2 <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • call - Call a stored procedure
  • +
  • execute - Execute a SQL query
  • +
  • export - Export a table
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_db2_call.html b/static/v2.15.x/web_help/docs/zowe_db2_call.html new file mode 100644 index 0000000000..2cafb93c2a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_db2_call.html @@ -0,0 +1,20 @@ + + + + +db2 call + + +
+

zowedb2call

+

Call a Db2 stored procedure

+

Usage

+

zowe db2 call <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_db2_call_procedure.html b/static/v2.15.x/web_help/docs/zowe_db2_call_procedure.html new file mode 100644 index 0000000000..dbfe11aaf1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_db2_call_procedure.html @@ -0,0 +1,147 @@ + + + + +db2 call procedure + + +
+

zowedb2callprocedure

+

Call a Db2 stored procedure. Specify the stored procedure name and optionally provide values.

+

Usage

+

zowe db2 call procedure <routine> [options]

+

Positional Arguments

+
    +
  • +

    routine (string)

    +
      +
    • The name of a Db2 stored procedure
    • +
    +
  • +
+

Options

+
    +
  • +

    --parameters | -p (array)

    +
      +
    • Values to bind to the stored procedure parameters
    • +
    +
  • +
+

DB2 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The Db2 server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Db2 server port number
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The Db2 user ID (may be the same as the TSO login)
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The Db2 password (may be the same as the TSO password)
    • +
    +
  • +
  • +

    --database | --db (string)

    +
      +
    • The name of the database
    • +
    +
  • +
  • +

    --sslFile | --ssl (string)

    +
      +
    • Path to an SSL Certificate file
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --db2-profile | --db2-p (string)

    +
      +
    • The name of a (db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Call stored procedure DEMO.SP1:

    +
      +
    • zowe db2 call procedure "DEMO.SP1"
    • +
    +
  • +
  • +

    Call a stored procedure and pass values for parameter indicators:

    +
      +
    • zowe db2 call procedure "DEMO.SP2(?, ?)" --parameters "Hello" "world!"
    • +
    +
  • +
  • +

    Call a stored procedure and pass values for two output parameters. The first output requires a 2-character buffer. The second output is a message that will be truncated to the length of the placeholder.:

    +
      +
    • zowe db2 call procedure "DEMO.SP3(NULL, ?, ?)" --parameters "00" "message_placeholder_message_placeholder"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_db2_execute.html b/static/v2.15.x/web_help/docs/zowe_db2_execute.html new file mode 100644 index 0000000000..d5976b9670 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_db2_execute.html @@ -0,0 +1,20 @@ + + + + +db2 execute + + +
+

zowedb2execute

+

Execute SQL queries against a Db2 region and retrieve the response. Enclose the query in quotes and escape any symbols that have a special meaning to the shell.

+

Usage

+

zowe db2 execute <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • sql - Execute SQL statement
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_db2_execute_sql.html b/static/v2.15.x/web_help/docs/zowe_db2_execute_sql.html new file mode 100644 index 0000000000..ac8e77d19c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_db2_execute_sql.html @@ -0,0 +1,144 @@ + + + + +db2 execute sql + + +
+

zowedb2executesql

+

Execute one or multiple SQL statements separated by a semicolon from a command line or from a file.

+

Usage

+

zowe db2 execute sql [options]

+

Options

+
    +
  • +

    --query | -q (string)

    +
      +
    • The SQL statement verbatim to execute
    • +
    +
  • +
  • +

    --file | -f (string)

    +
      +
    • A local file containing the SQL statements to execute
    • +
    +
  • +
+

DB2 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The Db2 server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Db2 server port number
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The Db2 user ID (may be the same as the TSO login)
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The Db2 password (may be the same as the TSO password)
    • +
    +
  • +
  • +

    --database | --db (string)

    +
      +
    • The name of the database
    • +
    +
  • +
  • +

    --sslFile | --ssl (string)

    +
      +
    • Path to an SSL Certificate file
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --db2-profile | --db2-p (string)

    +
      +
    • The name of a (db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Execute a dummy SQL query:

    +
      +
    • zowe db2 execute sql --query "SELECT 'Hello World' FROM SYSIBM.SYSDUMMY1"
    • +
    +
  • +
  • +

    Retrieve the employees table and total number of rows:

    +
      +
    • zowe db2 execute sql -q "SELECT * FROM SAMPLE.EMP; SELECT COUNT(*) AS TOTAL FROM SAMPLE.EMP"
    • +
    +
  • +
  • +

    Execute a file with SQL statements:

    +
      +
    • zowe db2 execute sql --file backup_sample_database.sql
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_db2_export.html b/static/v2.15.x/web_help/docs/zowe_db2_export.html new file mode 100644 index 0000000000..f803fba269 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_db2_export.html @@ -0,0 +1,20 @@ + + + + +db2 export + + +
+

zowedb2export

+

Export data from a Db2 table

+

Usage

+

zowe db2 export <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • table - Export data from a Db2 table in SQL format
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_db2_export_table.html b/static/v2.15.x/web_help/docs/zowe_db2_export_table.html new file mode 100644 index 0000000000..6cc34f8a0c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_db2_export_table.html @@ -0,0 +1,141 @@ + + + + +db2 export table + + +
+

zowedb2exporttable

+

Export a Db2 table to the stdout or a file.

+

Usage

+

zowe db2 export table <table> [options]

+

Positional Arguments

+
    +
  • +

    table (string)

    +
      +
    • The name of the table to export
    • +
    +
  • +
+

Options

+
    +
  • +

    --outfile | -o (string)

    +
      +
    • The path to the output file
    • +
    +
  • +
  • +

    --separator | --sep (string)

    +
      +
    • Specify whether to add a separator between statements when exporting a table
    • +
    +
  • +
+

DB2 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The Db2 server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Db2 server port number
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The Db2 user ID (may be the same as the TSO login)
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The Db2 password (may be the same as the TSO password)
    • +
    +
  • +
  • +

    --database | --db (string)

    +
      +
    • The name of the database
    • +
    +
  • +
  • +

    --sslFile | --ssl (string)

    +
      +
    • Path to an SSL Certificate file
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --db2-profile | --db2-p (string)

    +
      +
    • The name of a (db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Export employees data from the table SAMPLE.EMP and save it to the file 'employees.sql':

    +
      +
    • zowe db2 export table SAMPLE.EMP --outfile employees.sql
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2.html new file mode 100644 index 0000000000..88cef91d6d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2.html @@ -0,0 +1,26 @@ + + + + +dbm-db2 + + +
+

zowedbm-db2

+

DBM-Db2 plug-in to interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • check - Perform DDL syntax checking.
  • +
  • compare - Compare DDL with a Db2 subsystem and produce an update script to implement changes.
  • +
  • deploy - Deploy DDL statements to a Db2 subsystem.
  • +
  • execute - Execute a script to implement Db2 object changes.
  • +
  • generate - Generate DDL statements for Db2 objects.
  • +
  • prepare - Prepare DDL statements and a script to migrate Db2 objects.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_check.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_check.html new file mode 100644 index 0000000000..1b016ab4b0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_check.html @@ -0,0 +1,20 @@ + + + + +dbm-db2 check + + +
+

zowedbm-db2check

+

Perform DDL syntax checking.

+

Usage

+

zowe dbm-db2 check <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • ddl - Validate the syntax of input DDL and optionally verify Db2 object dependencies. Use this command to ensure that the syntax of the input DDL is valid. You can also optionally verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL. You can generate input DDL using the 'zowe dbm generate ddl' command. For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_check_ddl.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_check_ddl.html new file mode 100644 index 0000000000..2b67e5d7e3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_check_ddl.html @@ -0,0 +1,218 @@ + + + + +dbm-db2 check ddl + + +
+

zowedbm-db2checkddl

+

Validate the syntax of input DDL and optionally verify Db2 object dependencies. Use this command to ensure that the syntax of the input DDL is valid. You can also optionally verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL. You can generate input DDL using the 'zowe dbm generate ddl' command.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 check ddl <local-input-ddl-filename> [options]

+

Positional Arguments

+
    +
  • +

    local-input-ddl-filename (string)

    +
      +
    • Specifies the local input file that contains the DDL statements for the Db2 objects that you want to validate on a target subsystem. Typically, this file is created by a 'zowe dbm generate ddl' command or retrieved from an archive. You can edit this file.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to use a command.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --verify | -v (string)

    +
      +
    • +

      Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.

      +

      Default value: no

      +

      Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Validate DDL statement syntax of the DDL statements in the sample.sql file on the 'TEST' Db2 subsystem:

    +
      +
    • zowe dbm-db2 check ddl sample.sql --target-db2 TEST
    • +
    +
  • +
  • +

    Validate DDL statement syntax and verify object dependencies:

    +
      +
    • zowe dbm-db2 check ddl sample.sql --target-db2 TEST --verify yes
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_compare.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_compare.html new file mode 100644 index 0000000000..0221ef1b68 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_compare.html @@ -0,0 +1,20 @@ + + + + +dbm-db2 compare + + +
+

zowedbm-db2compare

+

Compare DDL with a Db2 subsystem and produce an update script to implement changes.

+

Usage

+

zowe dbm-db2 compare <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • ddl - Compare objects that are defined in a DDL file to objects that are defined on a Db2 subsystem and generate an update script to implement the necessary object changes. This command also generates a high-level change summary report and a parseable impact analysis report. You can execute the script that is generated from this command using the 'zowe dbm execute compare-script' command. For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_compare_ddl.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_compare_ddl.html new file mode 100644 index 0000000000..00818e112f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_compare_ddl.html @@ -0,0 +1,362 @@ + + + + +dbm-db2 compare ddl + + +
+

zowedbm-db2compareddl

+

Compare objects that are defined in a DDL file to objects that are defined on a Db2 subsystem and generate an update script to implement the necessary object changes. This command also generates a high-level change summary report and a parseable impact analysis report. You can execute the script that is generated from this command using the 'zowe dbm execute compare-script' command.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 compare ddl <local-input-ddl-filename> [options]

+

Positional Arguments

+
    +
  • +

    local-input-ddl-filename (string)

    +
      +
    • Specifies the local input file that contains DDL statements for the Db2 objects that you want to compare to Db2 objects on a target subsystem. Typically, this file is created by a 'zowe dbm generate ddl' command or retrieved from an archive. You can edit this file.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to use a command.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --match-set | --ms (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <match-set-creator.match-set-name>

      +

      For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --match-set-file | --msf (string)

    +
      +
    • +

      Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <object-type> <source-name-mask> <target-name-mask>;

      +

      STOGROUP <name> <name>
      +DATABASE <name> <name>
      +TABLESPACE <database.name> <database.name>
      +TABLE <schema.name> <schema.name>
      +INDEX <schema.name> <schema.name>
      +VIEW <schema.name> <schema.name>
      +SYNONYM <schema.name> <schema.name>
      +ALIAS <schema.name> <schema.name>
      +TRIGGER <schema.name> <schema.name>
      +SEQUENCE <schema.name> <schema.name>
      +FUNCTION <schema.name[.version]> <schema.name[.version]>
      +PROCEDURE <schema.name[.version]> <schema.name[.version]>

      +

      Note:
      +- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
      +- <schema> must be between 1 and 128 characters.
      +- <version> must be between 1 and 64 characters.

      +

      A mask specification can include the following wildcard characters:

      +

      Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.

      +

      Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.

      +

      Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.

      +

      Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.

      +

      Example:

      +

      The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:

      +

      TABLE MY%.%TABLE YOUR%.%TABLE;
      +TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
      +TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
      +TABLE *.MYTABLE *.YOURTABLE;

      +

      For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note:
      +- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.
      +- The matchSetValues options-profile option has the same behavior as the match-set-file command option.

      +
    • +
    +
  • +
  • +

    --change-set | --cs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.

      +

      Format:

      +

      <change-set-creator.change-set-name>

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --change-set-file | --csf (string)

    +
      +
    • +

      Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.

      +

      Format:

      +

      <object-attribute> <from-value> <to-value>

      +

      The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

      +

      Example:

      +

      The following example demonstrates changes to the table schema (creator) and tablespace names:

      +

      TBCR TEST% PROD%
      +TBTS TESTTS% PRODTS%

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note:
      +- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
      +- The changeSetValues options-profile option has the same behavior as the change-set-file command option.

      +
    • +
    +
  • +
  • +

    --rule-set | --rs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.

      +

      Format:

      +

      <rule-set-creator.rule-set-name>

      +

      For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +
    • +
    +
  • +
  • +

    --id (string)

    +
      +
    • +

      Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.

      +

      Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @.

      +
    • +
    +
  • +
  • +

    --description | -d (string)

    +
      +
    • Specifies a 1- to 25-character description for the RC/Migrator compare strategy.
    • +
    +
  • +
  • +

    --output-compare-script | --ocs (string)

    +
      +
    • +

      Specifies the name of the local output file that contains the update script to make changes to objects that reside on the Db2 subsystem.

      +

      Default value: compare.txt

      +
    • +
    +
  • +
  • +

    --output-summary-file | --osf (string)

    +
      +
    • +

      Specifies the name of the local output file that contains the change summary report in text format. This report tracks changes to Db2 objects on the target Db2 subsystem, but it does not describe how changes are made.

      +

      Default value: summary.txt

      +
    • +
    +
  • +
  • +

    --output-impact-file | --oif (string)

    +
      +
    • +

      Specifies the name of the local output file that contains the parseable impact analysis report in JSON or YAML format. This report identifies the significant DDL operations that are performed on Db2 objects. The report provides the total number and type of DDL operations that are performed on each object type, the list of DDL operations performed on each object instance, and the state of any pending changes.

      +

      To determine the report format, supply one of the following extensions in the file name:
      +- .json for JSON
      +- .yaml or .yml for YAML
      +If no extension is provided, the format is set to JSON.

      +

      Default value: impact.json

      +

      For more information about the impact analysis report, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Generate a script to update objects on the 'TEST' Db2 subsystem with DDL definitions in myddl.sql file:

    +
      +
    • zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST
    • +
    +
  • +
  • +

    Generate a script to update objects and apply a rule set for the matched objects:

    +
      +
    • zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET
    • +
    +
  • +
  • +

    Generate a script to update objects and apply a rule set for the objects matched as determined by the local mask specifications in the pair.txt file:

    +
      +
    • zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_deploy.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_deploy.html new file mode 100644 index 0000000000..bac4ae7897 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_deploy.html @@ -0,0 +1,20 @@ + + + + +dbm-db2 deploy + + +
+

zowedbm-db2deploy

+

Deploy DDL statements to a Db2 subsystem.

+

Usage

+

zowe dbm-db2 deploy <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • ddl - Deploy Db2 object changes on the target Db2 subsystem using an input file that contains the DDL. For example, an application developer has made changes to DDL in a local file and is ready to test the DDL changes. Use this command to deploy the changes to the test environment. For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_deploy_ddl.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_deploy_ddl.html new file mode 100644 index 0000000000..ac26bfb779 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_deploy_ddl.html @@ -0,0 +1,315 @@ + + + + +dbm-db2 deploy ddl + + +
+

zowedbm-db2deployddl

+

Deploy Db2 object changes on the target Db2 subsystem using an input file that contains the DDL. For example, an application developer has made changes to DDL in a local file and is ready to test the DDL changes. Use this command to deploy the changes to the test environment.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 deploy ddl <local-input-ddl-filename> [options]

+

Positional Arguments

+
    +
  • +

    local-input-ddl-filename (string)

    +
      +
    • Specifies the local input file that contains DDL statements for the Db2 objects that you want to deploy on a target subsystem. Typically, this file is created by a 'zowe dbm generate ddl' command or retrieved from an archive. You can edit this file.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to use a command.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --match-set | --ms (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <match-set-creator.match-set-name>

      +

      For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --match-set-file | --msf (string)

    +
      +
    • +

      Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <object-type> <source-name-mask> <target-name-mask>;

      +

      STOGROUP <name> <name>
      +DATABASE <name> <name>
      +TABLESPACE <database.name> <database.name>
      +TABLE <schema.name> <schema.name>
      +INDEX <schema.name> <schema.name>
      +VIEW <schema.name> <schema.name>
      +SYNONYM <schema.name> <schema.name>
      +ALIAS <schema.name> <schema.name>
      +TRIGGER <schema.name> <schema.name>
      +SEQUENCE <schema.name> <schema.name>
      +FUNCTION <schema.name[.version]> <schema.name[.version]>
      +PROCEDURE <schema.name[.version]> <schema.name[.version]>

      +

      Note:
      +- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
      +- <schema> must be between 1 and 128 characters.
      +- <version> must be between 1 and 64 characters.

      +

      A mask specification can include the following wildcard characters:

      +

      Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.

      +

      Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.

      +

      Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.

      +

      Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.

      +

      Example:

      +

      The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:

      +

      TABLE MY%.%TABLE YOUR%.%TABLE;
      +TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
      +TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
      +TABLE *.MYTABLE *.YOURTABLE;

      +

      For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note:
      +- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.
      +- The matchSetValues options-profile option has the same behavior as the match-set-file command option.

      +
    • +
    +
  • +
  • +

    --change-set | --cs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.

      +

      Format:

      +

      <change-set-creator.change-set-name>

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --change-set-file | --csf (string)

    +
      +
    • +

      Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.

      +

      Format:

      +

      <object-attribute> <from-value> <to-value>

      +

      The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

      +

      Example:

      +

      The following example demonstrates changes to the table schema (creator) and tablespace names:

      +

      TBCR TEST% PROD%
      +TBTS TESTTS% PRODTS%

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note:
      +- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
      +- The changeSetValues options-profile option has the same behavior as the change-set-file command option.

      +
    • +
    +
  • +
  • +

    --rule-set | --rs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.

      +

      Format:

      +

      <rule-set-creator.rule-set-name>

      +

      For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update Db2 objects on a target Db2 subsystem according to DDL definitions in myddl.sql file:

    +
      +
    • zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST
    • +
    +
  • +
  • +

    Update Db2 objects according to the input DDL definitions and applied rule set for the matched objects:

    +
      +
    • zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET
    • +
    +
  • +
  • +

    Update Db2 objects according to the input DDL definitions and applied rule set for the objects matched as determined by the local mask specifications in the pair.txt file:

    +
      +
    • zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_execute.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_execute.html new file mode 100644 index 0000000000..66177a090d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_execute.html @@ -0,0 +1,22 @@ + + + + +dbm-db2 execute + + +
+

zowedbm-db2execute

+

Execute a script to implement Db2 object changes.

+

Usage

+

zowe dbm-db2 execute <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • compare-script - Execute the compare script that was generated with the 'zowe dbm compare ddl' command to implement the Db2 object changes on the Db2 subsystem specified within the script. This command also generates a recovery script to undo compare script changes. For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli
  • +
  • migration-script - Execute the migration script that was generated with the 'zowe dbm prepare migration' command to migrate Db2 objects (DDL) and table data from a source subsystem to a target subsystem. The source and target subsystem IDs are specified within the script. For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli
  • +
  • script - Execute a Batch Processor script on a target subsystem. For example, use this command to execute a Batch Processor script or specifically to execute a recovery script to undo changes that were made by the 'zowe dbm execute compare-script' command. If execution of the script fails, you can execute it again using the 'script-section' or 'restart' options. You can edit the script and make changes before you execute or restart it. For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_execute_compare-script.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_execute_compare-script.html new file mode 100644 index 0000000000..04afe47cea --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_execute_compare-script.html @@ -0,0 +1,210 @@ + + + + +dbm-db2 execute compare-script + + +
+

zowedbm-db2executecompare-script

+

Execute the compare script that was generated with the 'zowe dbm compare ddl' command to implement the Db2 object changes on the Db2 subsystem specified within the script. This command also generates a recovery script to undo compare script changes.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 execute compare-script <local-input-compare-script-filename> [options]

+

Positional Arguments

+
    +
  • +

    local-input-compare-script-filename (string)

    +
      +
    • Specifies the local input compare-script file that contains the update script that was generated with the 'zowe dbm compare ddl' command.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output-recovery-script | --ors | --output-recovery-file | --orf (string)

    +
      +
    • +

      Specifies the local output file name that contains the recovery script that is generated during execution of this command. Executing the recovery script using the 'zowe dbm execute script' command undoes the changes that were made by execution of the compare-script.

      +

      Default value: recovery.txt

      +
    • +
    +
  • +
  • +

    --restart | -r (string)

    +
      +
    • +

      Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.

      +

      The following restart options are valid:

      +

      new - Restart execution of the script at the first statement.

      +

      token - Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure.

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Execute a compare script:

    +
      +
    • zowe dbm-db2 execute compare-script compare.txt
    • +
    +
  • +
  • +

    Restart execution of a compare script at the first statement in the script:

    +
      +
    • zowe dbm-db2 execute compare-script compare.txt --restart new
    • +
    +
  • +
  • +

    Restart execution of a compare script at the location in the token:

    +
      +
    • zowe dbm-db2 execute compare-script compare.txt --restart 78A724GOBLEDYGOOK6FD140F6780D6FA
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_execute_migration-script.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_execute_migration-script.html new file mode 100644 index 0000000000..db9e3206bc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_execute_migration-script.html @@ -0,0 +1,202 @@ + + + + +dbm-db2 execute migration-script + + +
+

zowedbm-db2executemigration-script

+

Execute the migration script that was generated with the 'zowe dbm prepare migration' command to migrate Db2 objects (DDL) and table data from a source subsystem to a target subsystem. The source and target subsystem IDs are specified within the script.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 execute migration-script <local-input-migrate-script-filename> [options]

+

Positional Arguments

+
    +
  • +

    local-input-migrate-script-filename (string)

    +
      +
    • Specifies the local input migration-script file that was generated with the 'zowe dbm prepare migration' command.
    • +
    +
  • +
+

Options

+
    +
  • +

    --restart | -r (string)

    +
      +
    • +

      Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.

      +

      The following restart options are valid:

      +

      new - Restart execution of the script at the first statement.

      +

      name, token - Restart execution of the script at the location in the restart section that is recorded in the specified token and that was returned from a prior execution failure.

      +

      A section is a '.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL. 'source' is an alias for UNLOADS. 'target' is an alias for SQLDDL.

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Execute a migration script:

    +
      +
    • zowe dbm-db2 execute migration-script migration.txt
    • +
    +
  • +
  • +

    Restart execution of a migration script at the first statement in the script:

    +
      +
    • zowe dbm-db2 execute migration-script migration.txt --restart new
    • +
    +
  • +
  • +

    Restart execution of a migration script at the location in the token. Execution begins at the last successful sync point that is recorded in the restart token up to the end of the restart token section:

    +
      +
    • zowe dbm-db2 execute migration-script migration.txt --restart target,78A724GOBLEDYGOOK6FD140F6780D6FA
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_execute_script.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_execute_script.html new file mode 100644 index 0000000000..e37ba392f6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_execute_script.html @@ -0,0 +1,256 @@ + + + + +dbm-db2 execute script + + +
+

zowedbm-db2executescript

+

Execute a Batch Processor script on a target subsystem. For example, use this command to execute a Batch Processor script or specifically to execute a recovery script to undo changes that were made by the 'zowe dbm execute compare-script' command. If execution of the script fails, you can execute it again using the 'script-section' or 'restart' options. You can edit the script and make changes before you execute or restart it.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 execute script <local-input-bp-script-filename> [options]

+

Positional Arguments

+
    +
  • +

    local-input-bp-script-filename (string)

    +
      +
    • Specifies the local input file that contains the Batch Processor statements such as the recovery script that was created by executing the 'zowe dbm execute compare-script' command.
    • +
    +
  • +
+

Options

+
    +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to execute the script. If this option is not specified, the target subsystem is identified by the first .CONNECT statement in the script.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +

      The target-db2 option takes precedence over any other value that is specified for the Db2 subsystem or data sharing group.

      +
    • +
    +
  • +
  • +

    --script-section | --ss (string)

    +
      +
    • +

      Identifies the location in the script where you want to begin execution.

      +

      The following options are valid:

      +

      name - Begin execution of the specific section and process all subsequent statements up to the next section.

      +

      A section is a '.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL. 'source' is an alias for UNLOADS. 'target' is an alias for SQLDDL.

      +

      number - Begin execution after the specific sync point (.SYNC <number> statement) and process all statements up to the end of the script.

      +

      name, number - Begin execution of the specific script section beginning from the sync point (.SYNC <number> statement) within the section and process all subsequent statements up to the next section.

      +
    • +
    +
  • +
  • +

    --restart | -r (string)

    +
      +
    • +

      Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.

      +

      The following restart options are valid:

      +

      new - Restart execution of the script at the first statement.

      +

      token - Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure.

      +

      name, token - Restart execution of the script at the location in the restart section that is recorded in the specified token and that was returned from a prior execution failure.

      +

      A section is a Batch Processor '.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL. 'source' is an alias for UNLOADS. 'target' is an alias for SQLDDL.

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Execute a recovery script:

    +
      +
    • zowe dbm-db2 execute script recovery.txt
    • +
    +
  • +
  • +

    Execute a script on the 'TEST' Db2 subsystem:

    +
      +
    • zowe dbm-db2 execute script script001.txt --target-db2 TEST
    • +
    +
  • +
  • +

    Execute only the SQLDDL section of a script. The first .CONNECT statement in the script identifies the target subsystem where the script is executed. Execution begins at the .SYSTEM SQLDDL statement and ends at the next .SYSTEM statement in the script:

    +
      +
    • zowe dbm-db2 execute script script001.txt --script-section SQLDDL
    • +
    +
  • +
  • +

    Execute a script beginning from the sync point 10 (.SYNC 10 statement) to the end of the script:

    +
      +
    • zowe dbm-db2 execute script script001.txt --script-section 10
    • +
    +
  • +
  • +

    Execute only the target (SQLDDL) section of the script starting at sync point 20:

    +
      +
    • zowe dbm-db2 execute script script001.txt --script-section target,20
    • +
    +
  • +
  • +

    Restart execution of a script from the beginning:

    +
      +
    • zowe dbm-db2 execute script script001.txt --restart new
    • +
    +
  • +
  • +

    Restart execution of a script at the location specified in the token. The restart token is returned by a previous 'zowe dbm execute command' failure as part of the terminal output and in the error file:

    +
      +
    • zowe dbm-db2 execute script script001.txt --restart 78A724A48DA5185D06FD140F6780D6FA
    • +
    +
  • +
  • +

    Restart execution at the last successful sync point recorded in the restart token up to the end of the target (SQLDDL) section:

    +
      +
    • zowe dbm-db2 execute script script001.txt --restart target,78A724A48DA5185D06FD140F6780D6FA
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_generate.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_generate.html new file mode 100644 index 0000000000..dca8929849 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_generate.html @@ -0,0 +1,20 @@ + + + + +dbm-db2 generate + + +
+

zowedbm-db2generate

+

Generate DDL statements for Db2 objects.

+

Usage

+

zowe dbm-db2 generate <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • ddl - Generate CREATE or DROP DDL statements for specified Db2 objects into an output DDL file. For example, use this command to generate CREATE TABLE definitions that you can then edit and use to update the table definition on a Db2 subsystem with the 'zowe dbm compare ddl' command. For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_generate_ddl.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_generate_ddl.html new file mode 100644 index 0000000000..fb0295d8b3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_generate_ddl.html @@ -0,0 +1,303 @@ + + + + +dbm-db2 generate ddl + + +
+

zowedbm-db2generateddl

+

Generate CREATE or DROP DDL statements for specified Db2 objects into an output DDL file. For example, use this command to generate CREATE TABLE definitions that you can then edit and use to update the table definition on a Db2 subsystem with the 'zowe dbm compare ddl' command.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 generate ddl [options]

+

Required Options

+
    +
  • +

    --object | -o (string)

    +
      +
    • +

      Specifies the Db2 objects to be generated in DDL. Use the optional include clause to include related Db2 objects.

      +
       Format: see the object\-file description
      +
      +Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
      +
      +
    • +
    +
  • +
  • +

    --object-file | --of (string)

    +
      +
    • +

      Specifies the name of the local input file that contains a list of Db2 objects to be generated in DDL. Use a semicolon to separate objects. Use the optional include clause to include related Db2 objects.

      +

      Format:

      +

      <object-type> <object-name> [include(<related-object-type>,...)];

      +

      The required clause <object-type> <object-name> identifies the specific Db2 (base) object:

      +

      STOGROUP <name>
      +DATABASE <name>
      +TABLESPACE <dbname.name>
      +TABLE <schema.name>
      +INDEX <schema.name>
      +VIEW <schema.name>
      +ALIAS <schema.name>
      +SYNONYM <schema.name>
      +MQT <schema.name>
      +SEQUENCE <schema.name>
      +TRIGGER <schema.name>
      +FUNCTION <schema.name[.version]>
      +PROCEDURE <schema.name[.version]>

      +

      The optional include clause (<related-object-type>,...) identifies one or more related Db2 object types to include in the object list.

      +

      You can specify the following object types: STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL.

      +

      Example:

      +

      table sysibm.systables include (tablespace, database, index);
      +database db1 include(children);

      +

      Note: The --object and --object-file options are mutually exclusive.

      +
    • +
    +
  • +
  • +

    --source-db2 | --sd (string)

    +
      +
    • +

      Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --change-set | --cs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.

      +

      Format:

      +

      <change-set-creator.change-set-name>

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --change-set-file | --csf (string)

    +
      +
    • +

      Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects.

      +

      Format:

      +

      <object-attribute> <from-value> <to-value>

      +

      The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

      +

      For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Example:

      +

      The following example demonstrates changes to the table schema (creator) and tablespace names:

      +

      TBCR TEST% PROD%
      +TBTS TESTTS% PRODTS%

      +

      Note:
      +- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
      +- The changeSetValues options-profile option has the same behavior as the change-set-file command option.

      +
    • +
    +
  • +
  • +

    --type | -t (string)

    +
      +
    • +

      Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.

      +

      Default value: create
      +Allowed values: drop, create

      +
    • +
    +
  • +
  • +

    --output-ddl-file | --odf (string)

    +
      +
    • +

      Specifies the local output file name that contains the generated DDL for the objects that are identified by the --object-file or --object option.

      +

      Default value: output.sql

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Generate CREATE DDL statements for a tablespace and its child table:

    +
      +
    • zowe dbm-db2 generate ddl --object "tablespace my.tbsp include(table)" --source-db2 SRC --output-ddl-file objects.sql
    • +
    +
  • +
  • +

    Generate CREATE DDL statements for a database and its children and apply changes as defined in the change set:

    +
      +
    • zowe dbm-db2 generate ddl --object "database my.db include(children)" --source-db2 SRC --change-set USER1.CHANGSET --output-ddl-file objects.sql
    • +
    +
  • +
  • +

    Generate DROP DDL statements only for the input object list:

    +
      +
    • zowe dbm-db2 generate ddl --object-file objects.txt --source-db2 SRC --type drop --output-ddl-file output.sql
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_prepare.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_prepare.html new file mode 100644 index 0000000000..36e4046cc1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_prepare.html @@ -0,0 +1,20 @@ + + + + +dbm-db2 prepare + + +
+

zowedbm-db2prepare

+

Prepare DDL statements and a script to migrate Db2 objects.

+

Usage

+

zowe dbm-db2 prepare <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • migration - Generate a script to migrate Db2 object definitions (DDL) and data from a source subsystem to a target subsystem. You can specify which objects to include and apply changes to the objects as part of the migration. To execute the script, use the 'zowe dbm execute migration-script' command. For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_dbm-db2_prepare_migration.html b/static/v2.15.x/web_help/docs/zowe_dbm-db2_prepare_migration.html new file mode 100644 index 0000000000..826224d7dd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_dbm-db2_prepare_migration.html @@ -0,0 +1,303 @@ + + + + +dbm-db2 prepare migration + + +
+

zowedbm-db2preparemigration

+

Generate a script to migrate Db2 object definitions (DDL) and data from a source subsystem to a target subsystem. You can specify which objects to include and apply changes to the objects as part of the migration. To execute the script, use the 'zowe dbm execute migration-script' command.

+

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli

+

Usage

+

zowe dbm-db2 prepare migration [options]

+

Required Options

+
    +
  • +

    --object | -o (string)

    +
      +
    • +

      Specifies the Db2 objects to be migrated. Use the optional include clause to include related Db2 objects.

      +

      Format: see the object-file description

      +

      Note: The --object and --object-file options are mutually exclusive.

      +
    • +
    +
  • +
  • +

    --object-file | --of (string)

    +
      +
    • +

      Specifies the name of the local input file that contains a list of Db2 objects to be migrated. Use a semicolon to separate objects. Use the optional include clause to include related Db2 objects.

      +

      Format:

      +

      <object-type> <object-name> [include(<related-object-type>,...)];

      +

      The required clause <object-type> <object-name> identifies the specific Db2 (base) object:

      +

      STOGROUP <name>
      +DATABASE <name>
      +TABLESPACE <dbname.name>
      +TABLE <schema.name>
      +INDEX <schema.name>
      +VIEW <schema.name>
      +ALIAS <schema.name>
      +SYNONYM <schema.name>
      +MQT <schema.name>
      +SEQUENCE <schema.name>
      +TRIGGER <schema.name>
      +FUNCTION <schema.name[.version]>
      +PROCEDURE <schema.name[.version]>

      +

      The optional include clause (<related-object-type>,...) identifies one or more related Db2 object types to include in the object list.

      +

      You can specify the following object types: STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL.

      +

      Example:

      +

      table sysibm.systables include (tablespace, database, index);
      +database db1 include(children);

      +

      Note: The --object and --object-file options are mutually exclusive.

      +
    • +
    +
  • +
  • +

    --source-db2 | --sd (string)

    +
      +
    • +

      Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to use a command.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --change-set | --cs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.

      +

      Format:

      +

      <change-set-creator.change-set-name>

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --change-set-file | --csf (string)

    +
      +
    • +

      Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects.

      +

      Format:

      +

      <object-attribute> <from-value> <to-value>

      +

      The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

      +

      For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Example:

      +

      The following example demonstrates changes to the table schema (creator) and tablespace names:

      +

      TBCR TEST% PROD%
      +TBTS TESTTS% PRODTS%

      +

      Note:
      +- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
      +- The changeSetValues options-profile option has the same behavior as the change-set-file command option.

      +
    • +
    +
  • +
  • +

    --output-migrate-script | --oms (string)

    +
      +
    • +

      Specifies the name of the local output file that contains the script to make changes to objects that reside on the Db2 subsystem.

      +

      Default value: migration.txt

      +
    • +
    +
  • +
  • +

    --output-ddl-file | --odf (string)

    +
      +
    • +

      Specifies the name of the local output file that contains the generated DDL for objects that are identified by the --object-file or --object option.

      +

      Default value: output.sql

      +
    • +
    +
  • +
  • +

    --error-file | --ef (string)

    +
      +
    • +

      Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.

      +

      Default value: error.log

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --dbm-db2-options-profile | --dbm-db2-options-p (string)

    +
      +
    • The name of a (dbm-db2-options) profile to load for this command execution.
    • +
    +
  • +
  • +

    --dbm-db2-profile | --dbm-db2-p (string)

    +
      +
    • The name of a (dbm-db2) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

DBM-Db2 Connection Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Generate a migration script for a tablespace and its child table:

    +
      +
    • zowe dbm-db2 prepare migration --object "tablespace my.tbsp include(table)" --source-db2 SRC --target-db2 TRG --output-migrate-script migrate.txt
    • +
    +
  • +
  • +

    Generate a migration script and apply global changes:

    +
      +
    • zowe dbm-db2 prepare migration --object "database my.db include(children)" --source-db2 SRC --target-db2 TRG --change-set USER1.CHANGSET --output-migrate-script migrate.txt --output-ddl-file objects.sql
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes.html b/static/v2.15.x/web_help/docs/zowe_ejes.html new file mode 100644 index 0000000000..c3a53e46a1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes.html @@ -0,0 +1,25 @@ + + + + +ejes + + +
+

zoweejes

+

Welcome to the EJES RESTapi Manager

+

This plug-in allows you to interact with EJES on the host to emulate EJES Batch under TSO and to query the EJES monitoredspool and host libraries to retreive tabular and report information

+

Usage

+

zowe ejes <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • api | a - - Make requests with the (E)JES REST API
  • +
  • batch | b | bat - - A shell environment that emulates using (E)JES on the host.
  • +
  • issue | i - - Issue a system command on the host, if authorized.
  • +
  • log - - Output syslog/operlog to stdout.
  • +
  • query | q - - Query the host using (E)JES
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_api.html b/static/v2.15.x/web_help/docs/zowe_ejes_api.html new file mode 100644 index 0000000000..1bc3fc5f9c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_api.html @@ -0,0 +1,79 @@ + + + + +ejes api + + +
+

zoweejesapi

+

Make requests with the (E)JES REST API to the (E)JES API using options that correspond to object models in the (E)JES REST API swagger documentation. You should refer to that document, refer to chapter 10 of the (E)JES Reference, and issue "zowe ejes api init --helpApp" further details.

+

All responses are returned in JSON format by using the --rfj (--response-format-json) option.

+

The tools necessary manage the spool with (E)JES are provided. You will be able to download sysout, email it as PDF, and submit jobs from MVS and the local workstation. All downloads are saved to a file in the current working directory, or to the path specified on the EJES_DOWNLOAD_PATH environment variable.

+

The CLI generates exit codes. 0 indicates the transaction completed, but you should check the output for (E)JES errors. A non-zero exit code below 100 indicates a problem coding an options or a download file filesystem issue. An exit code above 100 is a response code from the host through the API. If use the host host "return" command in the --command option, you will receive a 500 exit code. Use a stateless init request or issue a term request to avoid this result.

+

This CLI was developed to provide an easy scripting option to avoid coding directly to the REST API. However, it can be used to experiment with the REST API. The --debug option will return the host requests and responses as objects and properties in JSON.

+

Usage

+

zowe ejes api <command>

+

Where <command> is one of the following:

+

Examples

+
    +
  • This is an example of a init request to position sysout (to download with a subsequent stateful request) using cookie management. Note the --cookie write option. Most of your stateful transaction scripts will be written this way. The --command option contains (E)JES host commands. Refer to the (E)JES Reference for details of the argument for that option.
  • +
+

Example:

+
  * `$  zowe ejes api init --cookie write --command "status hrlyjba;1 b"`
+
+
    +
  • This downloads the above sysout as a pdf using cookie management The -rfj (--request-format-json) output json includes the PDF file name of the sysout.
  • +
+

Example:

+
  * `$  zowe ejes api exec -d pdf --cc interpret --rfj --cookie read`
+
+
    +
  • This example uses the same cookie-managed session as above to download another sysout. The --command option argument string runs first, then the download. The order of options does not matter.
  • +
+

Example:

+
  * `$  zowe ejes api exec -d pdf --cc interpret --command "status hrlyjbb;1b" --rfj --cookie read`
+
+
    +
  • This terminates the session and deletes the cookie.
  • +
+

Example:

+
  * `$  zowe ejes api term --cookie read`
+
+
    +
  • Cancel a long running download. If you had needed to cancel the above download, with cookie management, you would have done it this way. The status is in returned JSON.
  • +
+

Example:

+
  * `$  zowe ejes api cancel-download --rfj --cookie read`
+
+
    +
  • +

    Initalize a session by using --command to display the status screen, then output the JCL of the first job. Use --enumValue to request 10 lines. The option -q requests the message array, lines of output, and the function array. Though browsed output is requested, if the first job does not have JCL, the status screen will be returned to show that the job that did not meet the criteria. The --rfj option visualizes the output as JSON. Without it, the CLI returns only the cookie.

    +

    Example:

    +
      +
    • zowe ejes api init --command "status;1 j" --enumvalue 10 -q message,lines,function --rfj
    • +
    +
  • +
  • +

    Perform a stateless transaction that submits a job using the --command option. It shows the status of jobs with the same name, sorting so the most recent is shown first. The --enumvalue option is requesting the top 5 lines. The query parameter -q is requesting the message array that will contain the submit result, lines of output, and the array of jobs submitted in this session. The --commanddata option supplies the JCL to submit referred to by the "api-array". The "\n" are line separators an editor would supply.

    +
  • +
+

Example:

+
  * `$  zowe ejes api exec --command "submit api-array;st iefbr14;sort time d;upd" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddata "//IEFBR14  JOB IEFBR14,'IEFBR14',CLASS=A,MSGCLASS=H\n//EXEC     EXEC PGM=IEFBR14\n//"`
+
+
    +
  • Perform the same stateless transaction above but use the --commanddatafile option to use a file on the workstation. If EJES_SUBMIT_PATH is defined in the environment, that will be used as the file path, otherwise the same directory the CLI is run in will be used if a full path is not supplied.
  • +
+

Example:

+
  * `$  zowe ejes api exec --command "submit api-array;st iefbr14;sort time d;upd" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddatafile "iefbr14.jcl"`
+
+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_api_cancel-download.html b/static/v2.15.x/web_help/docs/zowe_ejes_api_cancel-download.html new file mode 100644 index 0000000000..2247956c20 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_api_cancel-download.html @@ -0,0 +1,119 @@ + + + + +ejes api cancel-download + + +
+

zoweejesapicancel-download

+

Cancels a streaming download of PDF or Text data. A download is initiated via the -d option on an Exec request. Refer to the (E)JES REST API swagger documentation for details on mapped options.

+

For a command group overview, issue: zowe ejes api -h

+

Usage

+

zowe ejes api cancel-download [options]

+

Query Item Options

+
    +
  • +

    --cookie (string)

    +
      +
    • +

      Supply the cookie output by a stateful request. This option supports optional syntax to enable automatic management of the cookie without scraping from stdout.

      +

      --cookie [<cookie-value>|read[<pin>]|write[<pin>]

      +

      The CLI can manage a stateful cookie transaction proactively. On the init, specify --cookie write or --cookie write-pin where pin can be any alphanumeric string. On the exec, cancel-download, and term specify --cookie read or --cookie read-pin. The cookie generated by the host is managed in the user's work directory. A pin is required only when there are multiple simultaneous sessions.

      +
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Cancel a long running job. Show the status in returned JSON.

    +

    Example:

    +
      +
    • zowe ejes api cancel-download --rfj --cookie "EJESWEB_54761=DB856A...;path=/EjesWeb;Secure;HttpOnly"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_api_exec.html b/static/v2.15.x/web_help/docs/zowe_ejes_api_exec.html new file mode 100644 index 0000000000..522644acce --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_api_exec.html @@ -0,0 +1,490 @@ + + + + +ejes api exec + + +
+

zoweejesapiexec

+

Executes an API command in an existing (stateful) or new transient (stateless) session.

+

Returns items as requested by the query parameters. An existing session is used when a valid cookie is used as an argument on the --cookie option. This is the preferred scenario when multiple transactions are expected since it provides significant performance benefits. It requires server affinity for sessions in a clustered server environment.

+

A new transient session will be created if a --authorization or --user option is provided and a --cookie option is not. A transient session exists only for the current transaction and meets the goal of statelessness as defined by ROA and REST. However, it is much less efficient than using an existing session across multiple transactions, and does not preserve the state of the underlying (E)JES API. Nevertheless, it is the prefered scenario where a single transaction and statelessness suffice.

+

See the (E)JES REST API swagger documentation for details on the mapped options. Enclose all option arguments in double quotes if they include spaces, semicolons, or symbols that are reserved in your terminal shell or if they might otherwise be ambiguous to the shell. Options flagged with "initParms model" are valid only for stateless transactions on the exec command.

+

For a command group overview, issue: zowe ejes api -h

+

Usage

+

zowe ejes api exec [options]

+

Query Item Options

+
    +
  • +

    --authorization (string)

    +
      +
    • If you do not specify the --cookie option, you must include --user and --password or this option. The base64 encoded authentication string can be of the form userid:password or userid:group:password. If supplied, it overrides the profile user and password settings and starts a new session.
    • +
    +
  • +
  • +

    --cookie (string)

    +
      +
    • +

      Supply the cookie output by a stateful request. This option supports optional syntax to enable automatic managment of the cookie without scraping from stdout.

      +

      --cookie [<cookie-value>|read[<pin>]|write[<pin>]

      +

      The CLI can manage a stateful cookie transaction proactively. On the init, specify --cookie write or --cookie write-pin where pin can be any alphanumeric string. On the exec, cancel-download, and term specify --cookie read or --cookie read-pin. The cookie generated by the host is managed in the user's work directory. A pin is required only when there are multiple simultaneous sessions.

      +
    • +
    +
  • +
  • +

    -c (string)

    +
      +
    • +

      A list of comma separated, case-insensitive names of columns to include in the response. If omitted, all columns for the current tabular display are included.

      +

      This parameter only applies to enumerated data containing columns, specifically, the columns and rows items of the q parameter.

      +

      Limiting the included columns to only those you need can dramatically improve the resonse time of the request and significantly reduce system resources.

      +
    • +
    +
  • +
  • +

    -q (string)

    +
      +
    • +

      A list of comma separated, case-insensitive items to include in the response. If omitted, no items are included.

      +

      Limiting the included items to only those you need can improve response time.

      +

      The following items are supported: columns, environment, execParms, find, function, initParms, jobs, keys, lines, loginfo, rows, lineCommands, message, notice, platformEncoding, position, screen, submittedJobs, userLog, and version. These represent the response properties as described in the models section of this help. The value all can be used to include all of the above items, but generally you should only request the items you need.

      +
    • +
    +
  • +
  • +

    -d (string)

    +
      +
    • +

      A download type, either pdf or text.

      +

      When specified, all other query parameters are ignored. The Content-Type response header will report either application/pdf or text/plain (charset utf-8) if no error occurred, and application/json if an error occurred. If no error occurred, a Content-Disposition response header will supply a suggested filename.

      +

      A pdf or text property may be included in the POST data to override default pdf and text formatting options.

      +

      This parameter provides pdf or text data in the output stream and does not require enumeration.

      +

      The API must be positioned on a browser type display to download data. Afterwards, the positioning may have changed depending on the amount specified.

      +

      You can use CancelDownload to cancel a long running download.

      +
    • +
    +
  • +
  • +

    -m (string)

    +
      +
    • +

      A mail attachment type, either pdf or text.

      +

      At a minimum, a mail property is required in the POST data to specify one or more recipients. A pdf or text property may also be included to override default pdf and text formatting options.

      +

      The API must be positioned on a browser type display to send a mail attachment. Afterwards, the positioning may have changed depending on the amount specified.

      +

      Note that you cannot use CancelDownload to cancel a long running mail attachement request because the response
      +containing the needed Cookie is not sent until after mail has been sent.

      +
    • +
    +
  • +
+

Init Request Options

+
    +
  • +

    --casKey (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --columns (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --extractdd (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --ipaddress (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --luName (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --patterndd (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --rows (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • +

      See the initParms model in the Swagger documentation.

      +

      Allowed values: jes2, jes3

      +
    • +
    +
  • +
  • +

    --useragent (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
+

Exec Request Options

+
    +
  • +

    --command (string)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --commanddata (string)

    +
      +
    • See the execParms model in the Swagger documentation. Insert "\n" in the string to indicate line breaks.
    • +
    +
  • +
  • +

    --commanddatafile (string)

    +
      +
    • The contents of this file (usually JCL on the local workstation file system) must be escaped properly for --commanddata. See the execParms model in the Swagger documentation. Uses EJES_SUBMIT_PATH for the path if it exists in the environment.
    • +
    +
  • +
  • +

    --enumtime (number)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --enumvalue (number)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --showhiddencolumns (boolean)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --translatescreen (boolean)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --waitforresponse (boolean)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
+

PDF and TEXT Common Options

+
    +
  • +

    --amount (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
  • +

    --blockid (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • See the pdf or text model in the Swagger documentation. (Carriage-control)
    • +
    +
  • +
  • +

    --count (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
  • +

    --recordid (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
  • +

    --start (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
  • +

    --todend (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
  • +

    --todstart (number)

    +
      +
    • See the pdf or text model in the Swagger documentation.
    • +
    +
  • +
+

PDF Download Options

+
    +
  • +

    --decorate (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --font (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --orientation (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --overflow (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --pagesize (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
+

PDF Security Property Options

+
    +
  • +

    --allowassembly (boolean)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --allowcopying (boolean)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --allowmodification (boolean)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --allowprinting (boolean)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --masterpassword (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
  • +

    --openpassword (string)

    +
      +
    • See the pdf model in the Swagger documentation.
    • +
    +
  • +
+

Mail Options

+
    +
  • +

    --bcc (string)

    +
      +
    • See the mail model in the Swagger documentation.
    • +
    +
  • +
  • +

    --body (string)

    +
      +
    • See the mail model in the Swagger documentation. Insert "\n" in the string to indicate line breaks.
    • +
    +
  • +
  • +

    --bodyfile (string)

    +
      +
    • See the mail model in the Swagger documentation. The contents of the file are read and escaped properly for --body. Uses EJES_SUBMIT_PATH for the path if it exists in the environment.
    • +
    +
  • +
  • +

    --carboncopy (string)

    +
      +
    • See the cc property the mail model in the Swagger documentation.
    • +
    +
  • +
  • +

    --from (string)

    +
      +
    • See the mail model in the Swagger documentation.
    • +
    +
  • +
  • +

    --html (string)

    +
      +
    • See the mail model in the Swagger documentation.
    • +
    +
  • +
  • +

    --subject (string)

    +
      +
    • See the mail model in the Swagger documentation.
    • +
    +
  • +
  • +

    --to (string)

    +
      +
    • See the mail model in the Swagger documentation.
    • +
    +
  • +
+

Platform-encoding Options

+
    +
  • +

    --platformencoding (number)

    +
      +
    • See the platformEncoding model in the Swagger documentation. Defaults to 1047 if not specified.
    • +
    +
  • +
+

Debug Visualization Options

+
    +
  • +

    --debug (number)

    +
      +
    • +

      An additive flag for tech support use.

      +

      1 - Commands discovered and compiled-options object

      +

      2 - Request object

      +

      4 - Response headers

      +
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • Perform a stateless transaction that submits a job using the --command option. It shows the status of jobs with the same name, sorting so the most recent is shown first. The --enumvalue option is requesting the top 5 lines. The query parameter -q is requesting the message array that will contain the submit result, lines of output, and the array of jobs submitted in this session. The --commanddata option supplies the JCL to submit referred to by the "api-array". The "\n" are line separators an editor would supply.
  • +
+

Example:

+
  * `$  zowe ejes api exec --command "submit api-array;st iefbr14;sort time d;upd" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddata "//IEFBR14  JOB IEFBR14,'IEFBR14',CLASS=A,MSGCLASS=H\n//EXEC     EXEC PGM=IEFBR14\n//"`
+
+
    +
  • Perform the same stateless transaction above but use the --commanddatafile option to read a file from the workstation. If EJES_SUBMIT_PATH is defined in the environment, that will be used as the file path, otherwise the same directory the CLI is run in will be used if a full path is not supplied.
  • +
+

Example:

+
  * `$  zowe ejes api exec --command "submit api-array;st iefbr14;sort time d;upd" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddatafile "iefbr14.jcl"`
+
+
    +
  • Perform a stateful request. In this case, a previous request positioned the (E)JES api in a job browser. This example downloads the file as PDF using the -d option. It causes the carriage control symbols to be interpretted with the --cc option. Then specifies stateful session with the cookie it generated specified on the --cookie option. The sysout is download to a file with the name consistent with the browsed data set or browser. If EJES_DOWNLOAD_PATH exists in the environment, the path is used for the download. Otherwise, the file is created in the current working directory. (For managed cookie stateful request examples, issue: Zowe ejes api -h)
  • +
+

Example:

+
  * `$  zowe ejes api exec -d text --cc interpret --cookie "EJESWEB_54761=B6910D...;path=/EjesWeb;Secure;HttpOnly"`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_api_init.html b/static/v2.15.x/web_help/docs/zowe_ejes_api_init.html new file mode 100644 index 0000000000..9e4c1e629c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_api_init.html @@ -0,0 +1,279 @@ + + + + +ejes api init + + +
+

zoweejesapiinit

+

Creates an API session and optionally issues an API command. Returns items as requested by the -q and -c options. A Set-Cookie header is included in the response. The value of the returned cookie identifies the session and should be supplied as an argument on the --cookie option on subsequent API data, exec, and term requests. Cookies can be managed for you. See the --cookie option for details. Close the session with an API term request when it is no longer needed to free up system resources. Sessions that are idle for more than two minutes will be automatically closed. See the (E)JES REST API swagger documentation for details on the mapped options. Enclose all option arguments in double quotes if they include spaces, semicolons, or symbols that are reserved in your terminal shell or if they might otherwise be ambiguous to the shell.

+

For a command group overview, issue: zowe ejes api -h

+

Usage

+

zowe ejes api init [options]

+

Query Item Options

+
    +
  • +

    --authorization (string)

    +
      +
    • If you do not specify the --cookie option, you must include --user and --password or this option. The base64 encoded authentication string can be of the form userid:password or userid:group:password. If supplied, it overrides the profile user and password settings and starts a new session.
    • +
    +
  • +
  • +

    --cookie (string)

    +
      +
    • +

      Supply the cookie output by a stateful request. This option supports optional syntax to enable automatic management of the cookie without scraping from stdout.

      +

      --cookie [<cookie-value>|read[<pin>]|write[<pin>]

      +

      The CLI can manage a stateful cookie transaction proactively. On the init, specify --cookie write or --cookie write-pin where pin can be any alphanumeric string. On the exec, cancel-download, and term specify --cookie read or --cookie read-pin. The cookie generated by the host is managed in the user's work directory. A pin is required only when there are multiple simultaneous sessions.

      +
    • +
    +
  • +
  • +

    -c (string)

    +
      +
    • +

      A list of comma separated, case-insensitive names of columns to include in the response. If omitted, all columns for the current tabular display are included.

      +

      This parameter only applies to enumerated data containing columns, specifically, the columns and rows items of the q parameter.

      +

      Limiting the included columns to only those you need can dramatically improve the resonse time of the request and significantly reduce system resources.

      +
    • +
    +
  • +
  • +

    -q (string)

    +
      +
    • +

      A list of comma separated, case-insensitive items to include in the response. If omitted, no items are included.

      +

      Limiting the included items to only those you need can improve response time.

      +

      The following items are supported: columns, environment, execParms, find, function, initParms, jobs, keys, lines, loginfo, rows, lineCommands, message, notice, platformEncoding, position, screen, submittedJobs, userLog, and version. These represent the response properties as described in the models section of this help. The value all can be used to include all of the above items, but generally you should only request the items you need.

      +
    • +
    +
  • +
+

Init Request Options

+
    +
  • +

    --casKey (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --columns (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --extractdd (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --ipaddress (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --luName (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --patterndd (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --rows (string)

    +
      +
    • See the initParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • +

      See the initParms model in the Swagger documentation.

      +

      Allowed values: jes2, jes3

      +
    • +
    +
  • +
  • +

    --useragent (string)

    +
      +
    • See the initParms model in the Swagger documentation. Shows on the (E)JES Session panel and is a best practise to use.
    • +
    +
  • +
+

Exec Request Options

+
    +
  • +

    --command (string)

    +
      +
    • See the execParms model in the Swagger documentation. The argument is a (E)JES command stack. Refer to chapter 5 of the (E)JES Reference.
    • +
    +
  • +
  • +

    --commanddata (string)

    +
      +
    • See the execParms model in the Swagger documentation. Insert "\n" in the string to indicate line breaks.
    • +
    +
  • +
  • +

    --commanddatafile (string)

    +
      +
    • See the execParms model in the Swagger documentation. The contents of the file are read and escaped properly for --commanddata. Uses EJES_SUBMIT_PATH for the path if it exists in the environment.
    • +
    +
  • +
  • +

    --enumtime (number)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --enumvalue (number)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --showhiddencolumns (boolean)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --translatescreen (boolean)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
  • +

    --waitforresponse (boolean)

    +
      +
    • See the execParms model in the Swagger documentation.
    • +
    +
  • +
+

Platform-encoding Options

+
    +
  • +

    --platformencoding (number)

    +
      +
    • See the platformEncoding model in the Swagger documentation. Defaults to 1047 if not specified.
    • +
    +
  • +
+

Debug Visualization Options

+
    +
  • +

    --debug (number)

    +
      +
    • +

      An additive flag for tech support use.

      +

      1 - Commands discovered and compiled-options object

      +

      2 - Request object

      +

      4 - Response headers

      +
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Initalize a session by using --command to display the status screen, then output the JCL of the first job. Use --enumValue to request 10 lines. The option -q requests the message array, lines of output, and the function array. Though browsed output is requested, if the first job does not have JCL, the status screen will be returned to show that the job that did not meet the criteria. The --rfj option visualizes the output as JSON. Without it, the CLI returns only the cookie.

    +

    Example:

    +
      +
    • zowe ejes api init --command "status;1 j" --enumvalue 10 -q message,lines,function --rfj
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_api_term.html b/static/v2.15.x/web_help/docs/zowe_ejes_api_term.html new file mode 100644 index 0000000000..f5aef8fe4c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_api_term.html @@ -0,0 +1,103 @@ + + + + +ejes api term + + +
+

zoweejesapiterm

+

Terminates the API session.

+

For a command group overview, issue: zowe ejes api -h

+

Usage

+

zowe ejes api term [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • Terminate an existing session by specifying the session on the --cookie option. No output is returned if the transaction completes without error.
  • +
+

Example:

+
  * `$  zowe ejes api term --cookie "EJESWEB_54761=0F6E5A...;path=/EjesWeb;Secure;HttpOnly"`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch.html new file mode 100644 index 0000000000..0d0e4f1eb5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch.html @@ -0,0 +1,77 @@ + + + + +ejes batch + + +
+

zoweejesbatch

+

The (E)JES batch interface provides much of the power of the on-line environment to automated programs or scripts.

+

Using the batch interface, procedures may be created that issue commands or alter other resources based upon the condition of jobs in the JESplex and the contents of spool information (e.g., reports, condition codes, JES messages) produced by those jobs. System housekeeping functions containing (E)JES batch procedures may be submitted at scheduled times, on demand, or when certain system conditions are met. Practically any function that requires access to spool or other (E)JES-provided information can be automated.

+

Usage

+

zowe ejes batch <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_Output.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_Output.html new file mode 100644 index 0000000000..d0ae46020a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_Output.html @@ -0,0 +1,179 @@ + + + + +ejes batch Output + + +
+

zoweejesbatchOutput

+

Display a table of sysout in the JES2 Output queue, then enter the EJES Batch Shell. The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.

+

Usage

+

zowe ejes batch Output [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_activity.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_activity.html new file mode 100644 index 0000000000..fe726dfa53 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_activity.html @@ -0,0 +1,179 @@ + + + + +ejes batch activity + + +
+

zoweejesbatchactivity

+

Display jobs in all active address spaces for the JESplex or sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch activity [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_apfds.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_apfds.html new file mode 100644 index 0000000000..67a2cc6e21 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_apfds.html @@ -0,0 +1,179 @@ + + + + +ejes batch apfds + + +
+

zoweejesbatchapfds

+

Display APF-authorized libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch apfds [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_class.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_class.html new file mode 100644 index 0000000000..126f93ad71 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_class.html @@ -0,0 +1,179 @@ + + + + +ejes batch class + + +
+

zoweejesbatchclass

+

Display job classes defined for the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch class [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_cmdstack.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_cmdstack.html new file mode 100644 index 0000000000..50b11d0286 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_cmdstack.html @@ -0,0 +1,167 @@ + + + + +ejes batch cmdstack + + +
+

zoweejesbatchcmdstack

+

Issues a starting command stack. It connects to the host and allows you to use an enhanced set of EJES BATCH commands.

+

Usage

+

zowe ejes batch cmdstack <parameter-list> [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • A required command stack enclosed in double-quotes. The command stack may contain meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For information about (E)JES host primary commands and their parameters, read Chapter 5 (E)JES Commands in the (E)JES Reference.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (string)

    +
      +
    • Display blank lines to stderr (starts with blanks on)
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --resume | -r (array)

    +
      +
    • For use with the pause meta command. Use "off" to prevent resuming an auto pin session.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_command.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_command.html new file mode 100644 index 0000000000..bf01001688 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_command.html @@ -0,0 +1,179 @@ + + + + +ejes batch command + + +
+

zoweejesbatchcommand

+

Display the long command processor, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch command [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_djc.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_djc.html new file mode 100644 index 0000000000..33d498253f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_djc.html @@ -0,0 +1,179 @@ + + + + +ejes batch djc + + +
+

zoweejesbatchdjc

+

Display a table of Dependent Job Control networks in the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch djc [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_dynexit.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_dynexit.html new file mode 100644 index 0000000000..ba9502fab0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_dynexit.html @@ -0,0 +1,179 @@ + + + + +ejes batch dynexit + + +
+

zoweejesbatchdynexit

+

Display a table of MVS dynamic exits defined within the current sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch dynexit [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_enclave.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_enclave.html new file mode 100644 index 0000000000..0256af34b7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_enclave.html @@ -0,0 +1,179 @@ + + + + +ejes batch enclave + + +
+

zoweejesbatchenclave

+

Display a table of WLM enclaves defined within the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch enclave [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain an invocation system selection override and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_enq.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_enq.html new file mode 100644 index 0000000000..45fc7be26e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_enq.html @@ -0,0 +1,179 @@ + + + + +ejes batch enq + + +
+

zoweejesbatchenq

+

Display a table of information about ENQs and RESERVEs in the sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch enq [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_enqc.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_enqc.html new file mode 100644 index 0000000000..3022872da3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_enqc.html @@ -0,0 +1,179 @@ + + + + +ejes batch enqc + + +
+

zoweejesbatchenqc

+

Display a table of information about ENQ contention in the sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch enqc [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_enqd.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_enqd.html new file mode 100644 index 0000000000..3c164bed80 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_enqd.html @@ -0,0 +1,179 @@ + + + + +ejes batch enqd + + +
+

zoweejesbatchenqd

+

Display a table of information about ENQ SYSDSN resources in the sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch enqd [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_entry.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_entry.html new file mode 100644 index 0000000000..a24a42a34c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_entry.html @@ -0,0 +1,179 @@ + + + + +ejes batch entry + + +
+

zoweejesbatchentry

+

Display the (E)JES entry panel, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch entry [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_fss.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_fss.html new file mode 100644 index 0000000000..5916ba39ea --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_fss.html @@ -0,0 +1,179 @@ + + + + +ejes batch fss + + +
+

zoweejesbatchfss

+

Display a table of Functional Subsystems defined for the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch fss [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_group.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_group.html new file mode 100644 index 0000000000..9cab8f5018 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_group.html @@ -0,0 +1,179 @@ + + + + +ejes batch group + + +
+

zoweejesbatchgroup

+

Display a table of Generalized Main Scheduler parameters for job class groups in the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch group [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_hcheck.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_hcheck.html new file mode 100644 index 0000000000..be0dc4b4e3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_hcheck.html @@ -0,0 +1,179 @@ + + + + +ejes batch hcheck + + +
+

zoweejesbatchhcheck

+

Display a table of the about checks registered with IBM Health Checker for z/OS, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch hcheck [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_hold.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_hold.html new file mode 100644 index 0000000000..559a083015 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_hold.html @@ -0,0 +1,179 @@ + + + + +ejes batch hold + + +
+

zoweejesbatchhold

+

Display a table of the sysout in the Hold queue, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch hold [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_init.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_init.html new file mode 100644 index 0000000000..ec7eb90c46 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_init.html @@ -0,0 +1,179 @@ + + + + +ejes batch init + + +
+

zoweejesbatchinit

+

Display a table of JES2-managed batch initiators defined for the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch init [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_input.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_input.html new file mode 100644 index 0000000000..2eb41964d4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_input.html @@ -0,0 +1,179 @@ + + + + +ejes batch input + + +
+

zoweejesbatchinput

+

Display a table of all jobs in the JESplex that are in pre-execution and execution status, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch input [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_jesplex.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_jesplex.html new file mode 100644 index 0000000000..cc27bd3c8b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_jesplex.html @@ -0,0 +1,179 @@ + + + + +ejes batch jesplex + + +
+

zoweejesbatchjesplex

+

Display a table of JES images in your z/OS JESplex, then enter the EJES Batch Shell. A JES2 JESplex is also known as a Multi-Access SPOOL configuration or MAS. A JES3 JESplex is also known as a JES3 complex.

+

Usage

+

zowe ejes batch jesplex [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_jgroup.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_jgroup.html new file mode 100644 index 0000000000..6aa28336ec --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_jgroup.html @@ -0,0 +1,179 @@ + + + + +ejes batch jgroup + + +
+

zoweejesbatchjgroup

+

Display a table of the active job groups in the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch jgroup [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_line.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_line.html new file mode 100644 index 0000000000..e7ffbd78df --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_line.html @@ -0,0 +1,179 @@ + + + + +ejes batch line + + +
+

zoweejesbatchline

+

Display a table of the lines that connect NJE nodes to your JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch line [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_lnklst.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_lnklst.html new file mode 100644 index 0000000000..ee1579ad0d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_lnklst.html @@ -0,0 +1,179 @@ + + + + +ejes batch lnklst + + +
+

zoweejesbatchlnklst

+

Display a table of data sets in the link list concatenation of the link list libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch lnklst [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_log.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_log.html new file mode 100644 index 0000000000..17f50b741d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_log.html @@ -0,0 +1,179 @@ + + + + +ejes batch log + + +
+

zoweejesbatchlog

+

Display the log, then enter the EJES Batch Shell. You may optionally specify operlog or syslog, or command stack 'logattr on' to see the operlog display in MCS Console colors.

+

Usage

+

zowe ejes batch log [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_lpalst.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_lpalst.html new file mode 100644 index 0000000000..b5ea0a993d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_lpalst.html @@ -0,0 +1,179 @@ + + + + +ejes batch lpalst + + +
+

zoweejesbatchlpalst

+

Display a table of data sets in the LPA concatenation of the link pack libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch lpalst [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_mds.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_mds.html new file mode 100644 index 0000000000..4d6ea7e064 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_mds.html @@ -0,0 +1,179 @@ + + + + +ejes batch mds + + +
+

zoweejesbatchmds

+

Display a table of jobs in the JESplex that are currently delayed in one of the Main Device Scheduler queues, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch mds [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_memusage.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_memusage.html new file mode 100644 index 0000000000..d749acf23c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_memusage.html @@ -0,0 +1,179 @@ + + + + +ejes batch memusage + + +
+

zoweejesbatchmemusage

+

Display a table of real and virtual memory requirements of jobs and other tasks running within your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch memusage [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_menu.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_menu.html new file mode 100644 index 0000000000..3dd4cc34de --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_menu.html @@ -0,0 +1,179 @@ + + + + +ejes batch menu + + +
+

zoweejesbatchmenu

+

Display or control the (E)JES menu, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch menu [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_mounts.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_mounts.html new file mode 100644 index 0000000000..e135df28e6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_mounts.html @@ -0,0 +1,179 @@ + + + + +ejes batch mounts + + +
+

zoweejesbatchmounts

+

Display a table of mounted file systems within the sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch mounts [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_netconn.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_netconn.html new file mode 100644 index 0000000000..95cfe95fac --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_netconn.html @@ -0,0 +1,179 @@ + + + + +ejes batch netconn + + +
+

zoweejesbatchnetconn

+

Display a table of NJE (Network Job Entry) connection, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch netconn [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_netserv.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_netserv.html new file mode 100644 index 0000000000..81cb99746c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_netserv.html @@ -0,0 +1,179 @@ + + + + +ejes batch netserv + + +
+

zoweejesbatchnetserv

+

Display a table of NJE network servers, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch netserv [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain an invocation system selection override and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_nje.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_nje.html new file mode 100644 index 0000000000..53e2d2637e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_nje.html @@ -0,0 +1,179 @@ + + + + +ejes batch nje + + +
+

zoweejesbatchnje

+

Display a table of sysout in the Bulk Data Transfer and TCP/IP NJE queues, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch nje [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_node.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_node.html new file mode 100644 index 0000000000..b0fc1571bd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_node.html @@ -0,0 +1,179 @@ + + + + +ejes batch node + + +
+

zoweejesbatchnode

+

Display a table of the NJE nodes defined to the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch node [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_nop.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_nop.html new file mode 100644 index 0000000000..10478f81ec --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_nop.html @@ -0,0 +1,158 @@ + + + + +ejes batch nop + + +
+

zoweejesbatchnop

+

Start or resume a session with no operation. Most useful in conjunction with --resume.

+

Usage

+

zowe ejes batch nop [options]

+

Options

+
    +
  • +

    --blanks | -b (string)

    +
      +
    • Display blank lines to stderr (starts with blanks on)
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --resume | -r (array)

    +
      +
    • For use with the pause meta command. Use "off" to prevent resuming an auto pin session. Most useful in conjunction with --resume.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_offload.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_offload.html new file mode 100644 index 0000000000..e5e9a199ce --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_offload.html @@ -0,0 +1,179 @@ + + + + +ejes batch offload + + +
+

zoweejesbatchoffload

+

Display a table of the JES2 spool offload devices in your JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch offload [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_pageds.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_pageds.html new file mode 100644 index 0000000000..28d2f86901 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_pageds.html @@ -0,0 +1,179 @@ + + + + +ejes batch pageds + + +
+

zoweejesbatchpageds

+

Display a table of paging resources defined to the systems in your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch pageds [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_parmlib.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_parmlib.html new file mode 100644 index 0000000000..501f8092b4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_parmlib.html @@ -0,0 +1,179 @@ + + + + +ejes batch parmlib + + +
+

zoweejesbatchparmlib

+

Display a table of information about system parameter libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch parmlib [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_printer.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_printer.html new file mode 100644 index 0000000000..4dd5c695f8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_printer.html @@ -0,0 +1,179 @@ + + + + +ejes batch printer + + +
+

zoweejesbatchprinter

+

Display a table of JES writers which drive local, FSS, and signed-on/logged-on remote printer and punch devices attached to the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch printer [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_proclib.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_proclib.html new file mode 100644 index 0000000000..44d9b6abd6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_proclib.html @@ -0,0 +1,179 @@ + + + + +ejes batch proclib + + +
+

zoweejesbatchproclib

+

Display a table of information about your JES proclib concatenations, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch proclib [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_pstatus.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_pstatus.html new file mode 100644 index 0000000000..8508db2ccb --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_pstatus.html @@ -0,0 +1,179 @@ + + + + +ejes batch pstatus + + +
+

zoweejesbatchpstatus

+

Display a table of z/OS UNIX processes running in the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch pstatus [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_query.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_query.html new file mode 100644 index 0000000000..c654c79ae4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_query.html @@ -0,0 +1,179 @@ + + + + +ejes batch query + + +
+

zoweejesbatchquery

+

Display displays or primary commands your credentials authorize, then enter the EJES Batch Shell. The positional operand is required and may be 'auth' or 'auth display'.

+

Usage

+

zowe ejes batch query <parameter-list> [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_resmon.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_resmon.html new file mode 100644 index 0000000000..4847d2528e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_resmon.html @@ -0,0 +1,179 @@ + + + + +ejes batch resmon + + +
+

zoweejesbatchresmon

+

Display a table of JES resources for the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch resmon [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_resource.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_resource.html new file mode 100644 index 0000000000..71b817b9db --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_resource.html @@ -0,0 +1,179 @@ + + + + +ejes batch resource + + +
+

zoweejesbatchresource

+

Display a table of the WLM Resources defined for the current sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch resource [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_schenv.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_schenv.html new file mode 100644 index 0000000000..29f262ec94 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_schenv.html @@ -0,0 +1,179 @@ + + + + +ejes batch schenv + + +
+

zoweejesbatchschenv

+

Display a table of the WLM Scheduling Environments defined for the current sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch schenv [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_session.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_session.html new file mode 100644 index 0000000000..3299843985 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_session.html @@ -0,0 +1,179 @@ + + + + +ejes batch session + + +
+

zoweejesbatchsession

+

Display a table of all active (E)JES sessions, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch session [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_shell.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_shell.html new file mode 100644 index 0000000000..5041b2ee87 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_shell.html @@ -0,0 +1,158 @@ + + + + +ejes batch shell + + +
+

zoweejesbatchshell

+

Starts the EJES Batch Shell without logging on. It allows you to connect to the host and use an enhanced set of EJES BATCH commands.

+

Usage

+

zowe ejes batch shell [options]

+

Options

+
    +
  • +

    --blanks | -b (string)

    +
      +
    • Display blank lines to stderr (starts with blanks on)
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --resume | -r (array)

    +
      +
    • For use with the pause meta command. Use "off" to prevent resuming an auto pin session.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_spart.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_spart.html new file mode 100644 index 0000000000..d8ba91c349 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_spart.html @@ -0,0 +1,179 @@ + + + + +ejes batch spart + + +
+

zoweejesbatchspart

+

Display a table of the SPOOL partition configuration of your JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch spart [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_spvol.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_spvol.html new file mode 100644 index 0000000000..370fcac574 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_spvol.html @@ -0,0 +1,179 @@ + + + + +ejes batch spvol + + +
+

zoweejesbatchspvol

+

Display a table of the SPOOL volume extent configuration of your JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch spvol [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_status.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_status.html new file mode 100644 index 0000000000..7cfb6dca4b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_status.html @@ -0,0 +1,179 @@ + + + + +ejes batch status + + +
+

zoweejesbatchstatus

+

Display jobs in the JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch status [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_subsys.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_subsys.html new file mode 100644 index 0000000000..3611df3dd2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_subsys.html @@ -0,0 +1,179 @@ + + + + +ejes batch subsys + + +
+

zoweejesbatchsubsys

+

Display a table of all the MVS subsystems defined to the systems in your sysplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch subsys [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_symbol.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_symbol.html new file mode 100644 index 0000000000..bdbbe1fdb6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_symbol.html @@ -0,0 +1,179 @@ + + + + +ejes batch symbol + + +
+

zoweejesbatchsymbol

+

Display a table of z/OS system symbols as well as JES and JCL symbols defined for the current address space, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch symbol [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_syscls.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_syscls.html new file mode 100644 index 0000000000..416acde5d9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_syscls.html @@ -0,0 +1,179 @@ + + + + +ejes batch syscls + + +
+

zoweejesbatchsyscls

+

Display a table of the sysout class configuration for your JESplex, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch syscls [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_sysplex.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_sysplex.html new file mode 100644 index 0000000000..26d0d45214 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_sysplex.html @@ -0,0 +1,179 @@ + + + + +ejes batch sysplex + + +
+

zoweejesbatchsysplex

+

Display a table of the connected system images in your z/OS sysplex, then enter the EJES Batch Shell. In a monoplex, you manage the current system only (i.e., the image on which your (E)JES session is executing).

+

Usage

+

zowe ejes batch sysplex [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain an invocation system selection override and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_sysreq.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_sysreq.html new file mode 100644 index 0000000000..ac45f9fb29 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_sysreq.html @@ -0,0 +1,179 @@ + + + + +ejes batch sysreq + + +
+

zoweejesbatchsysreq

+

Display a table of outstanding replies and messages retained by the MVS Action Message Retention Facility (AMRF), then enter the EJES Batch Shell. Outstanding replies and action messages for the entire sysplex are shown.

+

Usage

+

zowe ejes batch sysreq [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_ulog.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_ulog.html new file mode 100644 index 0000000000..a230f84fdf --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_ulog.html @@ -0,0 +1,179 @@ + + + + +ejes batch ulog + + +
+

zoweejesbatchulog

+

Display the user log console browser, then enter the EJES Batch Shell. The optional parameter allows you to specify a console name other than that which would normally be chosen automatically. Please refer to the CONSOLE command documentation for considerations when specifying a console name.

+

Usage

+

zowe ejes batch ulog [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_writer.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_writer.html new file mode 100644 index 0000000000..0fce73b9c2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_writer.html @@ -0,0 +1,179 @@ + + + + +ejes batch writer + + +
+

zoweejesbatchwriter

+

Display a table of sysout in the JES3 Writer queue, then enter the EJES Batch Shell. The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.

+

Usage

+

zowe ejes batch writer [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_batch_zero.html b/static/v2.15.x/web_help/docs/zowe_ejes_batch_zero.html new file mode 100644 index 0000000000..afc0d85fd5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_batch_zero.html @@ -0,0 +1,179 @@ + + + + +ejes batch zero + + +
+

zoweejesbatchzero

+

Display a table of sysout data sets created by JES3 internal facilities, then enter the EJES Batch Shell.

+

Usage

+

zowe ejes batch zero [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

Options

+
    +
  • +

    --blanks | -b (array)

    +
      +
    • Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --cmdstack | -c (string)

    +
      +
    • Start with a host command stack, separated by semicolons and enclosed in quotes.
    • +
    +
  • +
  • +

    --autoupdate | -a | --aup (array)

    +
      +
    • Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | --debug-value (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --echo | -e (array)

    +
      +
    • Display host screen output to stdout. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --inactivity | -i (number)

    +
      +
    • Specify host activity timeout in minutes (starts set to 2).
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --screen | -s (array)

    +
      +
    • Display host screen output to stderr. Off by default. Specify with no argument to turn on.
    • +
    +
  • +
  • +

    --terminal | -t (string)

    +
      +
    • Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
    • +
    +
  • +
  • +

    --quiet | -q (array)

    +
      +
    • Prevent output of interactive details, including version title on start and exit code on exit.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_issue.html b/static/v2.15.x/web_help/docs/zowe_ejes_issue.html new file mode 100644 index 0000000000..ebe771212d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_issue.html @@ -0,0 +1,21 @@ + + + + +ejes issue + + +
+

zoweejesissue

+

Issue a system command by sending the positional parameters to the host. (E)JES will respond with output sent to your user log.

+

Usage

+

zowe ejes issue <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_issue_submit.html b/static/v2.15.x/web_help/docs/zowe_ejes_issue_submit.html new file mode 100644 index 0000000000..9e9c804ab3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_issue_submit.html @@ -0,0 +1,188 @@ + + + + +ejes issue submit + + +
+

zoweejesissuesubmit

+

Submit a job from the local host with the local: prefix, or a MVS data set or z/OS UNIX path. Responds with submission messages and a table providing a description of a successful submission.

+

Usage

+

zowe ejes issue submit <command> [options]

+

Positional Arguments

+
    +
  • +

    command (string)

    +
      +
    • Any of MVS data set name, z/OS UNIX path name, or a workstation file prefixed by 'local:'. The environment variable EJES_SUBMIT_PATH is used to provide a path for a local workstation file if only a file name is provided. When not present, the current working directory is used instead. While the use of the command line options below is recommended, you may instead append to the command string arguments for the submit command listed in the (E)JES Reference.
    • +
    +
  • +
+

Options

+
    +
  • +

    --debug | --dbg | --dv (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --lrecl (number)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --recfm (string)

    +
      +
    • +

      Record format of fixed or variable length.

      +

      Allowed values: f, v, list, help

      +
    • +
    +
  • +
  • +

    --subsys (string)

    +
      +
    • +

      Subsystem name where the job should be sent. If not specified defaults to the subsystem under which the current (E)JES session is running. For JES3plus, use jes3.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
  • +

    --unit (string)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (string)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit a local workstation file:

    +
      +
    • zowe ejes issue submit "local:iefbr14.jcl" --lrecl 132 --subsys jes3
    • +
    +
  • +
  • +

    Submit a local workstation file using arguments:

    +
      +
    • zowe ejes issue submit "local:iefbr14.jcl lrecl(132) subsys(jes3)"
    • +
    +
  • +
  • +

    Submit a clist member:

    +
      +
    • zowe ejes issue submit "a.cntl(iefbr14)"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_issue_syscmd.html b/static/v2.15.x/web_help/docs/zowe_ejes_issue_syscmd.html new file mode 100644 index 0000000000..29813c916e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_issue_syscmd.html @@ -0,0 +1,164 @@ + + + + +ejes issue syscmd + + +
+

zoweejesissuesyscmd

+

Issue a system command and receive console output as a report in text format.

+

Usage

+

zowe ejes issue syscmd <command> [options]

+

Positional Arguments

+
    +
  • +

    command (string)

    +
      +
    • System console command enclosed in double-quotes. If you wish to issue multiple commands, follow each command with a semicolon and a slash(;/)
    • +
    +
  • +
+

Options

+
    +
  • +

    --debug | --dbg (number)

    +
      +
    • Specify a numeric debugging mode.
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • Run under dry-run protocols.
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • Maximum lines in a table or report. [1000 | tty-default | number | all]
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • Maximum characters per line or row. [tty-default | number | all]
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Display the time:

    +
      +
    • zowe ejes issue syscmd "d t"
    • +
    +
  • +
  • +

    Display time and ppt:

    +
      +
    • zowe ejes issue syscmd "d t;/d ppt"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_log.html b/static/v2.15.x/web_help/docs/zowe_ejes_log.html new file mode 100644 index 0000000000..ad279dfc64 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_log.html @@ -0,0 +1,20 @@ + + + + +ejes log + + +
+

zoweejeslog

+

Output the tail end of the host log to stdout, optionally streaming new records. Positioning, searching, and limiting options are supported, including specifying which log type and what system.

+

Usage

+

zowe ejes log <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • stream - - Tail or stream operlog or syslog to stdout.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_log_stream.html b/static/v2.15.x/web_help/docs/zowe_ejes_log_stream.html new file mode 100644 index 0000000000..7a9824ff15 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_log_stream.html @@ -0,0 +1,640 @@ + + + + +ejes log stream + + +
+

zoweejeslogstream

+

Outputs the operations log or system log to stdout. Behaves like a Linux tail function with support for standard tail options --follow (-f), --lines (-n), -q, -v, and --version.

+
  Set the position in the log to begin output using \-\-find, \-\-line, \-\-time, and \-\-offset\.  
+
+  Use OPERLOG Message Filtering Options to create a windowed log by filtering for and outputting only lines that fit criteria, e\.g\., fetch only lines associated with an IAT6xxxx message by specifying: \-\-msgId "IAT6\*"\.  After filtering the log, output is positioned at the bottom\.  Use position options to change that\.
+
+  Turn on highlighting for \-\-find using \-\-hilite\.  Perform regex text matching with highlighting using \-\-match\.  Enable MCS console color emulation with \-\-mcs\.  To prevent ANSI escape characters from being output and to instead use accessibility\-friendly text\-only indicators, specify: \-\-nocolor "on"\.
+
+  The order of host commands issued during initialization are fixed in this program in this order:
+
+

1. All OPERLOG message filtering options, e.g., --msgId and --msgTxt

+

2. --line

+

3. --time

+

4. --find

+

5. --offset

+
  Conceptually and depending on specified options, the program can create a window into the log data using message filtering options, then can point to a line in the data such as the first line, then can position at a time, then find arbitrary text, then offset the view up and down by seconds to days or a number of lines\.
+
+  The program outputs trailer diagnostic lines at the end of the run to stderr\.  Use this information to make your queries more efficient\.  The trailer and header lines can be muted using the \-\-quiet (\-q) option or setting the EJES\_LOG\_CLI\_QUIET environment variable\.  The program outputs a bottom\-of\-data line to stdout that is considered an output line by \-\-lines with a line\-count argument\.  To disable it, set the EJES\_LOG\_CLI\_NO\_BOTTOM environment variable\.
+
+

Usage

+

zowe ejes log stream [log-type] [options]

+

Positional Arguments

+
    +
  • +

    log-type (string)

    +
      +
    • Optional. If not specified, the Operations Log is output if the Operations Log is active for the current MVS system. Otherwise, the System Log is output. Must match regular expression: operlog|oper|o|syslog|sys|s
    • +
    +
  • +
+

Options

+
    +
  • +

    --follow | -f | --nonstop | --ns (boolean)

    +
      +
    • Follow the log stream. Displays last page of log then waits for more data. Ignored for --response-format-json. The actual maximum duration is controlled by your host refresh command settings.
    • +
    +
  • +
  • +

    --lines | -n (array)

    +
      +
    • +

      Limit output to a number of lines or a time span. 10 lines is used if the option is not specified.

      +
        Specify a maximum number of lines up to 999,999 lines (supports multipliers), or specify a time span of 0\.01 to 999 seconds, minutes, hours, or days by specifying a number followed by "s", "m", "h", or "d"\.  Specify  "all" for unlimited output\.
      +
      +  When \-\-request\-format\-json (\-\-rfj) is specified, the number of lines up to 5,000 specified on this option (or the default of 10) determines the number of lines fetched from the host and stored in the output json data array\.  With \-\-rfj, this option overrides \-\-enumValue\.
      +
      +  Supports Linux positioning syntax of \+ followed by a line number\.  This is the same as specifying \-\-line n \-\-lines all\.  When the intent is to fetch middle lines from the log, use \-\-line to position and \-\-lines to limit the count\.
      +
      +  Note: When there are no positioning requests, the program attempts to get the bottom n lines\.  However, the log is a dynamic data set and the actual log type may be different than assumed\.  The bottom\-of\-data line will output only if the number of lines is not exceeded when bottom is found\.
      +
      +

      Allowed values: all, ^(?:[1-9]|\d\.)\d{0,2}[smhd]$, ^[1-9]\d{0,5}$, ^\+[1-9]\d*$, ^[1-9]\d{0,2}(b|kB|K|MB|M|GB|G|KiB|MiB|GiB)$

      +
    • +
    +
  • +
  • +

    --bytes | -c (string)

    +
      +
    • +

      Byte level output counts supported only for syntax checking. Use --lines or filter with a TAIL terminal command instead.

      +

      Allowed values: ^\+[1-9]\d*$

      +
    • +
    +
  • +
  • +

    --quiet | -q | --silent (boolean)

    +
      +
    • Do not display header or trailer lines. Set the environment variable EJES_LOG_CLI_QUIET to make this the default. Set EJES_LOG_CLI_NO_BOTTOM to prevent displaying the bottom of data line.
    • +
    +
  • +
  • +

    --verbose | -v (boolean)

    +
      +
    • Display header lines or trailer. This is the default unless the environment variable EJES_LOG_CLI_QUIET is set. Set EJES_LOG_CLI_NO_BOTTOM to prevent displaying the bottom of data line.
    • +
    +
  • +
  • +

    --version (boolean)

    +
      +
    • Display version header and quit.
    • +
    +
  • +
  • +

    --requests (number)

    +
      +
    • Limit the number of normally unlimited host requests. Only host requests for data, additional data, or find next data count as a request.
    • +
    +
  • +
+

ANSI Color Options

+
    +
  • +

    --mcs | --mcsConsoleColor | --mcs-console-color (boolean)

    +
      +
    • Use ANSI escape characters to emulate the color and extended highlighting attributes in OPERLOG output to resemble the formatting on an MCS operator console. If --no-color on is specified, textual attributes will be prefixed instead. The MVS "DISPLAY MPF" command displays the message assignments color attributes in use on your host system.
    • +
    +
  • +
  • +

    --match | --matchText | --match-text | --mt | -m (string)

    +
      +
    • +

      Specify case-independent text to match and highlight using ANSI escape characters.

      +
        Specify a string, a Javascript regex pattern without the enclosing slashes (e\.g\., "login|logoff|force"), or a Javascript regex pattern string with slashes and regex option flags (e\.g\., "/\[Ll\]ogo\.{1,2}|Signoff/g")\.  If the first or second type is used, the flags default to ig (ignore\-case and global match)\.
      +
      +  Matching does not position for output the way \-\-find does; it can be used in conjuction with a \-\-find\.  Matching is done on each output line separately\.  All matches in a line will be highlighted\.  If \-\-no\-color on is specified, the line will be prefixed with ">"\.  If the built\-in highlight attribute isn't visible on your terminal, either change the foreground color or set the environment variable EJES\_LOG\_CLI\_ANSIMATCHATTR\.  0 to 256 are valid as defined on this Wikipedia page:
      +
      +  <https://en\.wikipedia\.org/wiki/ANSI\_escape\_code\#8\-bit>
      +
      +
    • +
    +
  • +
+

Find String and Position Options

+
    +
  • +

    --find (string)

    +
      +
    • +

      Position start of output using (E)JES host FIND command syntax (below). Find positioning is done after --line and --time, but before --offset. Limit lines to found lines with --only. Limit excessive enumeration and provide context with --context.

      +
        NOTE: To search for specific message IDs or find text in messages on the OPERLOG, use \-\-msgId or \-\-msgText instead\.  OPERLOG message filtering Options show entire messages and may be more efficient\.  Since these options position at the bottom of the log, specify \-\-line to position at the first message or specify \-\-find to find further refine your search\.  Refer to OPERLOG Message Filtering Options for further alternatives to FIND\.
      +
      +  (E)JES Host FIND Command Syntax:  Only the find\-string is required\.  It should be enclosed in single quotes if it contains spaces or special characters\.  Case\-independent search is the default\.  Case dependent is specified using c'find\-string'\. Searching for double\-quotes is not supported\.  (The search\-type arguments "next" and "prev" carry over  3270 display behavior\.  In this program, "prev" means find the last occurrence above the last 53 lines of the log; the default "next" searches forward starting 53 lines before the bottom\.)  Refer to the (E)JES Reference for the FIND command for detailed find syntax and option documention\.
      +
      +  \['|c'|p'|x'\]find\-string\['\] \[NEXT|prev|first|last\] \[CHARS|prefix|pre|suffix|suf|word\] \[startcol\[ endcol\]\]
      +
      +

      Allowed values: ^((?:c|p|x|)'.+'(?:c|p|x|)|[^'\s]+)(?:(?:\s+(first|last|next|prev|all)){0,1}(?:(?:\s+(chars|pre|prefix|suf|suffix|word)){0,1}(?:\s+(\d*\s+\d*|\d*)){0,2}){0,1}){0,1}$

      +
    • +
    +
  • +
  • +

    --hilite | --highlight-find-text | --highlight | --ht (array)

    +
      +
    • +

      Use in conjunction with --find to highlight found strings using ANSI escape characters. If --no-color on is specified, the line will be prefixed with "=".

      +
        If the built\-in highlight attribute isn't visible on your terminal, either change the foreground color or set the environment variable EJES\_LOG\_CLI\_ANSIFINDATTR to 8, 6, or 3\.  0 to 256 are valid as defined on this Wikipedia page:
      +
      +  <https://en\.wikipedia\.org/wiki/ANSI\_escape\_code\#8\-bit>
      +
      +
    • +
    +
  • +
  • +

    --only | -o (boolean)

    +
      +
    • Output only lines marked by the host as found using the --find option. The --context option modifies this option by also outputing context lines following the found lines. Some OPERLOG message filtering options (e.g., --msgId and --msgTxt) may provide better results and will be more efficient and faster.
    • +
    +
  • +
  • +

    --context | --cx (array)

    +
      +
    • +

      Specify 2 to 49 lines of context after the found line when --only is specified. 5 is used if an argument is not specified. To display only found lines, do not specify --context.

      +

      Allowed values: s, sep, separator, ^[1-4]\d*$|^[2-9]$

      +
    • +
    +
  • +
+

Positioning Options

+
    +
  • +

    --line (array)

    +
      +
    • +

      Position at a specific line in the log. With no argument, it positions to top of the displayable log (like the TOP command). Positioning done before --time, --find, and --offset.

      +

      Allowed values: first, last, ^[1-9]\d*$

      +
    • +
    +
  • +
  • +

    --head (boolean)

    +
      +
    • Position at top of log same as --line without an argument. Positioning done before --time, --find, and --offset.
    • +
    +
  • +
  • +

    --time (array)

    +
      +
    • +

      Positions a time on the current day or to a time and date. With no argument, positions to the beginning of the day. Positioning done before --find and --offset, but after --line.

      +
        The argument is hh:mm:ss:th\-date, where ss or ss:th and the date are optional\.
      +
      +

      The date, if specified, is specified as yyyy.ddd, yyyy-ddd, yyyy/mm/dd, yyyy/dd/mm, mm/dd/yyyy, dd/mm/yyyy, yyyy-mm-dd, yyyy-dd-mm, mm-dd-yyyy, or dd-mm-yyyy. The Julian date form is always valid.

      +
        The Gregorian date form depends upon your current date format setting, though both slash (/) and dash (\-) are accepted as separator characters\.  Specify "?" to return the Gregorian date format and quit, i\.e\., \-\-time "?"
      +
      +  Two copy\-paste date\-time formats are supported\.  A date\-time may copied from the log and pasted, enclosed in quotes, after the \-\-time option\.  Operlog: "yyyydddd hh:mm:ss\.th"\.  Syslog: "yyyyddd hhmmsst"\.
      +
      +

      Allowed values: (?:^(20\d{5}) (\d{7})$)|(?:^(20\d{5}) ((\d\d:\d\d:\d\d.\d\d))$)|(?:^(\d\d\:\d\d(?:\:\d\d){0,2}(?:-(?:(?:\d{4}[.-]\d{3}$)|(?:^\d{4}(?:[\/|-]\d{2}){2}$)|(?:^(?:\d{2}[\/|-]){2}\d{4})))*){0,1}$|^\?$)

      +
    • +
    +
  • +
+

Positioning Offset Options

+
    +
  • +

    --offset | --off (array)

    +
      +
    • +

      Offset positioning by time or line count after the final position arrived at by message filtering, --line, --time, and --find. Optional directional indicators are next or + (later in log) or prev (earlier). If the directional indicator is omitted, earlier in the log is assumed. Valid trailing time indicators are s, m, h, or d. A number without a time indicator assumes h on OPERLOG, but on SYSLOG positions by adding to the current data set number (if 0, it positions at the top of the current data set). The l indicator is a line count indicator. Specify this to offset by n lines. Without an argument, prev4l is assumed, which is helpful when specifying --find to provide context even when -n 10 (the default) is specified.

      +

      Allowed values: ^(\+|next|prev)*(\d+[smhdl]{0,1})$

      +
    • +
    +
  • +
+

OPERLOG Message Filtering Options

+
    +
  • +

    --system-name | --systemName | --sysname | --sn (array)

    +
      +
    • Filter for up to 4 provided system name(s). Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time of the OPERLOG browser can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
    • +
    +
  • +
  • +

    --job-name | --jobName | --jname | -j (array)

    +
      +
    • Filter OPERLOG for up to 4 provided job names. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
    • +
    +
  • +
  • +

    --job-id | --jobId | --jid (array)

    +
      +
    • Filter OPERLOG for up to 4 provided job ids, e.g, J0632369. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
    • +
    +
  • +
  • +

    --console | --con (array)

    +
      +
    • Filter OPERLOG for up to 4 provided consoles. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
    • +
    +
  • +
  • +

    --message-id | --messageId | --msgId | --mi (array)

    +
      +
    • Filter OPERLOG for up to 3 provided message ids of up to 12 characters. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
    • +
    +
  • +
  • +

    --message-text | --messageText | --msgText | --msgTxt | --mtxt | --mx (array)

    +
      +
    • Filter OPERLOG for message text of up to 34 characters. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. To filter for strings inside a message's text, use generic characters, e.g., "*logon*". Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
    • +
    +
  • +
  • +

    --routing-codes | --routingCodes | --routing | -r (array)

    +
      +
    • +

      Filter OPERLOG for routing codes. Up to 34 characters that may be ALL, NONE, or a list of decimal routing codes or ranges. For example: 1,3,6-9,100-128. Multiline messages are output in their entirety. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.

      +

      Default value: ALL

      +
    • +
    +
  • +
  • +

    --descriptor-codes | --descriptorCodes | --descriptor | --dc (array)

    +
      +
    • +

      Filter OPERLOG for descriptor codes. Up to 34 characters that may be ALL, NONE, or a list of decimal descriptor codes or ranges. For example: 1,3,6-9. Multiline messages are output in their entirety. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.

      +

      Default value: ALL

      +
    • +
    +
  • +
  • +

    --window-bottom | --windowBottom | --winBot | --wb | --bot | --high-time-date | --htd (array)

    +
      +
    • +

      Filter OPERLOG by setting the time and optionally the date of the bottom of the log to use. Up to 23 characters.

      +
        The boundary specifications may be either fixed time\-date values, e\.g\."16:00:12:90\-2021/02/12" (see “Time\-Date Values” in the (E)JES Reference) or calculated relative to the time stamp associated with the record shown at 57 lines from the bottom of the log at start\-up\.
      +
      +  A relative value is indicated by the presence of a next (\+) or previous preceding the boundary specification, e\.g\., prev1h\. After the next or previous you may specify either a number of seconds, minutes, hours, or days as indicated by using a 's', 'm', 'h', or 'd' suffix\. Assumes 'h' if omitted\.
      +
      +  Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display\.
      +
      +

      Allowed values: ^(\+|next|prev)*(\d+[smhd]{0,1})$|(?:^(20\d{5}) ((\d\d:\d\d:\d\d.\d\d))$)|^(?:(\d\d\:\d\d(?:\:\d\d){0,2}(?:-(?:(?:\d{4}[.-]\d{3})|(?:\d{4}(?:[\/|-]\d{2}){2})|(?:(?:\d{2}[\/|-]){2}\d{4})))*){0,1}|\?)$

      +
    • +
    +
  • +
  • +

    --window-top | --windowTop | --winTop | --wt | --top | --low-time-date | --ltd (array)

    +
      +
    • +

      Filter OPERLOG by setting the time and optionally the date of the top of the log to use. Up to 23 characters.

      +
        The boundary specifications may be either fixed time\-date values, e\.g\."16:00:12:90\-2021/02/12" (see “Time\-Date Values” in the (E)JES Reference) or calculated relative to the time stamp associated with the record shown at 57 lines from the bottom of the log at start\-up\.
      +
      +  A relative value is indicated by the presence of a next (\+) or previous preceding the boundary specification, e\.g\., prev1h\. After the next or previous you may specify either a number of seconds, minutes, hours, or days as indicated by using a 's', 'm', 'h', or 'd' suffix\. Assumes 'h' if omitted\.
      +
      +  Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display\.
      +
      +

      Allowed values: ^(\+|next|prev)*(\d+[smhd]{0,1})$|(?:^(20\d{5}) ((\d\d:\d\d:\d\d.\d\d))$)|^(?:(\d\d\:\d\d(?:\:\d\d){0,2}(?:-(?:(?:\d{4}[.-]\d{3})|(?:\d{4}(?:[\/|-]\d{2}){2})|(?:(?:\d{2}[\/|-]){2}\d{4})))*){0,1}|\?)$

      +
    • +
    +
  • +
  • +

    --mpf-exit-flags | --mpfExitFlags | --mpf (array)

    +
      +
    • +

      Filter OPERLOG for MPF/Exit flags with a "value mask" of eight hexadecimal characters, e.g., 00000291. Use in conjunction with the "result directive" (see --result-directive).

      +
        The filtering is performed by ANDing the hexadecimal value mask against a message’s MPF/Exit Flags value and then displaying the message based upon the result directive (zero or non\-zero)\.  For example, a mask and result directive of 00000001 and NZ will display messages that were suppressed by MPF\. Specifying 00000001 and Z displays messages that were not suppressed\.
      +
      +  Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display\.  Multiline messages are output in their entirety\.  
      +
      +

      Default value: FFFFFFFF
      +Allowed values: ^[0-9A-F]{8}$, ^[0-9a-f]{8}$

      +
    • +
    +
  • +
  • +

    --result-directive | --resultDirective | --rd (array)

    +
      +
    • +

      Provide the result directive for the --mpf-exit-flags option (see the option for more information). A mask and result directive of 00000001 and NZ will display messages that were suppressed by MPF. A mask and result directive of 00000001 and Z displays messages that were not suppressed. Multiline messages are output in their entirety. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.

      +

      Default value: NZ
      +Allowed values: NZ, Z, EQ, NE

      +
    • +
    +
  • +
+

Log Options

+
    +
  • +

    --logsys | -l (string)

    +
      +
    • Specify a syslog to display by specifying the MVS name of a system in a JES2 environment. The current system is browsed if --logsys is not specified.
    • +
    +
  • +
  • +

    --syslog | --sys (boolean)

    +
      +
    • +

      Display the SYSLOG instead of the default log. Deprecated. Use the positional parameter instead.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --operlog | --oper (boolean)

    +
      +
    • +

      Display the OPERLOG instead of the default log. Deprecated. Use the positional parameter instead.

      +

      Default value: false

      +
    • +
    +
  • +
+

JES-type Options

+
    +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • +

      Use the JES2 spooler instead of the default spooler.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • +

      Use the JES3 or JES3plus spooler instead of the default spooler.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --subsystem (string)

    +
      +
    • Specify the JES spooler system to use instead of the default spooler.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -U (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

EJES CLI Runtime Options

+
    +
  • +

    --enum-value | --enumval | --ev (number)

    +
      +
    • +

      Number of lines to retreieve per (E)JES API call. Overridden by the combination of --rfj and --line (-n). See --line.

      +

      Default value: 200

      +
    • +
    +
  • +
  • +

    --refresh-interval | --refreshInterval | --refresh | --ri | --sleep-interval | --sleep | -s (number)

    +
      +
    • +

      Number of seconds between (E)JES API calls in log stream command. The actual minimum and maximum interval is controlled by your host refresh command settings.

      +

      Default value: 5

      +
    • +
    +
  • +
  • +

    --debug | --dbg | --dv | -d (number)

    +
      +
    • +

      Invoke debugging code with additive flags. 1=request, 2=minimum response, 4=full response, 8=housekeeping, 16=show record info, 32=show fetch metadata.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --detailed-json | --detailedjson | --detail | --dj (boolean)

    +
      +
    • +

      Include metadata objects and arrays in --rfj output, not just an array of lines.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Output 10 lines at the tail of the log:

    +
      +
    • zowe ejes log stream
    • +
    +
  • +
  • +

    Output 40 lines at head of the log with no header or trailer lines. The -n option is an alias for --lines and -q is an alias for --quiet:

    +
      +
    • zowe ejes log stream --head -n 40 -q
    • +
    +
  • +
  • +

    Stream the tail of the default log defined for your credentials until you press CTRL+C. The -f option is an alias for --follow:

    +
      +
    • zowe ejes log stream --follow
    • +
    +
  • +
  • +

    Stream the tail of the syslog:

    +
      +
    • zowe ejes log stream syslog --follow
    • +
    +
  • +
  • +

    Stream the tail of the operlog:

    +
      +
    • zowe ejes log stream operlog --follow
    • +
    +
  • +
  • +

    Match and highlight user logons in output lines. (NOTE: This does not position to the string; it *only* highlights them *if* they are in the output.) Match can also work with a simple string, or a regex string with no forward slash characters, implying the "ig" flags (ignore-case and global-match):

    +
      +
    • zowe ejes log stream --match "/[Ll]ogo.{1,2}|force|Signoff/g"
    • +
    +
  • +
  • +

    Match and mark user logons without ANSI color escape sequences. The --nc option is an alias for --no-color:

    +
      +
    • zowe ejes log stream --match "/[Ll]ogo.{1,2}|force|Signoff/g" --nc on
    • +
    +
  • +
  • +

    Find your logon Id in the log:

    +
      +
    • zowe ejes log stream --find yourLogonId
    • +
    +
  • +
  • +

    Find your logon Id in the log and highlight the found text:

    +
      +
    • zowe ejes log stream --hilite --find yourLogonId
    • +
    +
  • +
  • +

    Find your logon id in the log with a few lines above it for context. The --offset option is down 4 lines (prev4l) if the argument is not specified:

    +
      +
    • zowe ejes log stream --find yourLogonId --offset
    • +
    +
  • +
  • +

    Find your TSO logons and logoffs for today by specifying you logon id followed by "- log" in the log. Note that if the find string includes spaces or special characters, you need to enclose it in single-quotes. Find without a find without a search type uses NEXT, searching forward from a position. Using the --time option without an argument positions to the start of the current day before finding. Without the --time option, the default position is 53 lines from the bottom. (NOTE: The space after the trailing apostrophe and before the double quote is a work-around for a zowe parsing issue.):

    +
      +
    • zowe ejes log stream --find "'yourLogonId - log' " --time
    • +
    +
  • +
  • +

    Find your unix home directory in the log. Note that if find string is case sensitive, you need to enclose it in single-quotes prefixed with the letter c, e.g., c'String':

    +
      +
    • zowe ejes log stream --find "c'DSN=/u/userName' last"
    • +
    +
  • +
  • +

    Find beginning of speed boost with highlighting:

    +
      +
    • zowe ejes log stream --find "'speed boost is active' first" --hilite
    • +
    +
  • +
  • +

    Find beginning of speed boost but mark found lines without ANSI color escape sequences. The --ht option is an alias for --hilite and --nc is an alias for --no-color:

    +
      +
    • zowe ejes log stream --find "'speed boost is active' first" --ht --nc on
    • +
    +
  • +
  • +

    Find all speed boost messages with highlighting and only output found lines:

    +
      +
    • zowe ejes log stream --find "'speed boost is active' first" --ht --only -n all
    • +
    +
  • +
  • +

    Find all speed boost messages with highlighting and output five lines of context (the default):

    +
      +
    • zowe ejes log stream --find "'speed boost is active' first" --ht --only --context -n all
    • +
    +
  • +
  • +

    Filter for IPL and boost informational messages that appear in the IEA681I message. The message can include generic characters to specify classes or subclasses of messages. The entire multiline message is output if the message is multiline. Other OPERLOG filtering options can be found under Message Filters Options:

    +
      +
    • zowe ejes log stream --msgId "IEA681I"
    • +
    +
  • +
  • +

    Filter for all informational IEA messages. The % character is a placeholder that matches any character. The entire multiline message is output if the message is multiline. Other OPERLOG filtering options can be found under Message Filters Options:

    +
      +
    • zowe ejes log stream --msgId "IEA%%%I"
    • +
    +
  • +
  • +

    Filter for "boost" in the text of any message. Note the use of the generic character * that matches any number of characters before or after the string. These are necessary for this type of search. The entire multiline message is output if the message is multiline. Other OPERLOG filtering options can be found under Message Filters Options:

    +
      +
    • zowe ejes log stream --msgTxt "*boost*"
    • +
    +
  • +
  • +

    Filter using descriptor codes for audible alarm errors and warning messages with MCS console color emulation on. The program will beep.The option --dc is an alias for --descriptorCodes. OPERLOG filtering options can be found under Message Filt ers Options:

    +
      +
    • zowe ejes log stream --descriptorCodes "1,2,11" --mcs
    • +
    +
  • +
  • +

    Find all system messages that required action for the hour after midnight. Specifying --only shows just found lines. Specifying --lines with "1h" tells the program to output lines up to one hour from the first line output. The --top option here specifies a time without a date, which means the current day. This logically sets the top of the log, windowing it, to midnight today (with no lines above it). Specifying --find with the first verb tells to search from the top. The character in the find string has a special meaning indicating that a message requires action. The special characters "|", "-", "@", " * ", and "+" can be indexed from column 54 and " * " is a column 4 character, thus 58 below.

    +

    https://www\.ibm\.com/docs/en/zos/2\.4\.0?topic=consoles\-special\-screen\-characters:

    +
      +
    • zowe ejes log stream --find "'*' first 58 58" --only --top "00:00" --lines 1h
    • +
    +
  • +
  • +

    Same result as previous example but with different options and colorized to emulate an MCS color console. Specifying --time without an argument positions at the beginning of the current day. The difference from above is that --top sets the first line of the log the program sees and positions at the bottom. The --time option positions before --find runs. No directional argument is specified on the --find option so it runs starting as positioned by the --time option.:

    +
      +
    • zowe ejes log stream --find "'*' 58 58" --only --time --lines 1h --mcs
    • +
    +
  • +
  • +

    Stream the tail of the log until you press CTRL+C. The -f option is an alias for --follow:

    +
      +
    • zowe ejes log stream --follow
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query.html b/static/v2.15.x/web_help/docs/zowe_ejes_query.html new file mode 100644 index 0000000000..c96efa1e13 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query.html @@ -0,0 +1,97 @@ + + + + +ejes query + + +
+

zoweejesquery

+

Query the host using (E)JES. Return host spool, dataset, and library tables. Return browsable data as reports. Query commands specify which primary table to query. Each primary table may also have child tables or child reports you can query using the --table and/or --report options. You can access only those primary tables you are authorized to use. Issue these commands as an introduction: (1) "zowe ejes query list" to show available tables.(2) "zowe ejes query status --owner help" to demonstrate how to find how it all works. (3) "zowe ejes query status --owner list" to demonstrate how to find appropriate arguments. (4) "zowe ejes query status --owner myuserid --sort time d" to view a sorted table of your jobs.(5) "zowe ejes query status --owner myuserid --sort time d --report " to view the first job in report form (truncated to your screen).

+

Usage

+

zowe ejes query <command>

+

Where <command> is one of the following:

+

Examples

+
    +
  • Customize status table output.
  • +
+

(1) Limit to owners beginning with "rb". If not specified, the owner will be the same as your logon id. To specify all, use an asterisk(*). (2) Filter rows to display only abends. (3) Show only relevant columns and arrange in the order desired. (4) Limit the number of lines, including headers, to 10. (5) Remove header lines.

+

Example:

+
  * `$  zowe ejes query st --owner rb* --metafilter "maxcomp eq ab*" 
+     --showcols "jobname maxcomp status jobid rec" --lines 10 --header off`
+
+
    +
  • Display a table of data sets for a specific job on the spool by job id.
  • +
+

(1) Select job 0437107. The asterisk causes the positional job name to be ignored. (2) Display a child table by table type. Data sets status is "s" on the status table.

+

Example:

+
  * `$  zowe ejes query st --select "* j0437107" --table s`
+
+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query st --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query hchk --metafilter help`
+
+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_activity.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_activity.html new file mode 100644 index 0000000000..18808eab98 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_activity.html @@ -0,0 +1,593 @@ + + + + +ejes query activity + + +
+

zoweejesqueryactivity

+

Select a table of all the jobs in all active address spaces for the JESplex or sysplex.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query activity [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • AC. List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query activity --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query activity --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_apfds.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_apfds.html new file mode 100644 index 0000000000..9be753401d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_apfds.html @@ -0,0 +1,593 @@ + + + + +ejes query apfds + + +
+

zoweejesqueryapfds

+

Select a table of APF-authorized libraries defined to the systems in your sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query apfds [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query apfds --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query apfds --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_class.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_class.html new file mode 100644 index 0000000000..0bcd4ddb59 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_class.html @@ -0,0 +1,584 @@ + + + + +ejes query class + + +
+

zoweejesqueryclass

+

Select table of job classes defined for the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query class [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query class --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query class --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_djc.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_djc.html new file mode 100644 index 0000000000..15b4d1c1b2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_djc.html @@ -0,0 +1,584 @@ + + + + +ejes query djc + + +
+

zoweejesquerydjc

+

Select a table of Dependent Job Control networks in the JESplex.

+

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query djc [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query djc --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query djc --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_dynexit.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_dynexit.html new file mode 100644 index 0000000000..00463c1a63 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_dynexit.html @@ -0,0 +1,593 @@ + + + + +ejes query dynexit + + +
+

zoweejesquerydynexit

+

Select a table of MVS dynamic exits defined within the current sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query dynexit [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query dynexit --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query dynexit --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_enclave.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_enclave.html new file mode 100644 index 0000000000..fe3fe01811 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_enclave.html @@ -0,0 +1,593 @@ + + + + +ejes query enclave + + +
+

zoweejesqueryenclave

+

Select a table of WLM enclaves defined within the JESplex.

+

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query enclave [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query enclave --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query enclave --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_enq.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_enq.html new file mode 100644 index 0000000000..ba212cf363 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_enq.html @@ -0,0 +1,593 @@ + + + + +ejes query enq + + +
+

zoweejesqueryenq

+

Select a table of information about ENQs and RESERVEs in the sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query enq [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query enq --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query enq --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_enqc.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_enqc.html new file mode 100644 index 0000000000..bec9f49c7c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_enqc.html @@ -0,0 +1,593 @@ + + + + +ejes query enqc + + +
+

zoweejesqueryenqc

+

Select a table of information about ENQ contention in the sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query enqc [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query enqc --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query enqc --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_enqd.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_enqd.html new file mode 100644 index 0000000000..9eb3b5c485 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_enqd.html @@ -0,0 +1,593 @@ + + + + +ejes query enqd + + +
+

zoweejesqueryenqd

+

Select a table of information about ENQ SYSDSN resources in the sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query enqd [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters and/or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query enqd --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query enqd --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_fss.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_fss.html new file mode 100644 index 0000000000..e3f5c713ce --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_fss.html @@ -0,0 +1,584 @@ + + + + +ejes query fss + + +
+

zoweejesqueryfss

+

Select a table of Functional Subsystems defined for the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query fss [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query fss --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query fss --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_group.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_group.html new file mode 100644 index 0000000000..a7a920f37b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_group.html @@ -0,0 +1,584 @@ + + + + +ejes query group + + +
+

zoweejesquerygroup

+

Select a table of Generalized Main Scheduler parameters for job class groups in the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query group [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query group --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query group --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_hcheck.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_hcheck.html new file mode 100644 index 0000000000..16d18717d0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_hcheck.html @@ -0,0 +1,578 @@ + + + + +ejes query hcheck + + +
+

zoweejesqueryhcheck

+

Select a table of the about checks registered with IBM Health Checker for z/OS.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query hcheck [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_hold.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_hold.html new file mode 100644 index 0000000000..339642e8ea --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_hold.html @@ -0,0 +1,593 @@ + + + + +ejes query hold + + +
+

zoweejesqueryhold

+

Select a table of the sysout in the Hold queue.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query hold [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query hold --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query hold --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_init.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_init.html new file mode 100644 index 0000000000..17fd7737a0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_init.html @@ -0,0 +1,593 @@ + + + + +ejes query init + + +
+

zoweejesqueryinit

+

Select a table of JES2-managed batch initiators defined for the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query init [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query init --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query init --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_input.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_input.html new file mode 100644 index 0000000000..42071906ef --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_input.html @@ -0,0 +1,593 @@ + + + + +ejes query input + + +
+

zoweejesqueryinput

+

Select a table of all jobs in the JESplex that are in pre-execution and execution status.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query input [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query input --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query input --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_jesplex.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_jesplex.html new file mode 100644 index 0000000000..45002bf339 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_jesplex.html @@ -0,0 +1,584 @@ + + + + +ejes query jesplex + + +
+

zoweejesqueryjesplex

+

Select a table of JES images in your z/OS JESplex.

+

A JES2 JESplex is also known as a Multi-Access SPOOL configuration or MAS. A JES3 JESplex is also known as a JES3 complex. Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query jesplex [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query jesplex --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query jesplex --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_jgroup.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_jgroup.html new file mode 100644 index 0000000000..42ddb1cd98 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_jgroup.html @@ -0,0 +1,584 @@ + + + + +ejes query jgroup + + +
+

zoweejesqueryjgroup

+

Select a table of the active job groups in the JESplex.

+

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query jgroup [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query jgroup --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query jgroup --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_line.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_line.html new file mode 100644 index 0000000000..544115669e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_line.html @@ -0,0 +1,593 @@ + + + + +ejes query line + + +
+

zoweejesqueryline

+

Select a table of the lines that connect NJE nodes to your JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query line [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query line --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query line --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_list.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_list.html new file mode 100644 index 0000000000..14c6832d7c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_list.html @@ -0,0 +1,568 @@ + + + + +ejes query list + + +
+

zoweejesquerylist

+

Display a list of all the primary display tables you are authorized to query on the host.

+

Usage

+

zowe ejes query list [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_lnklst.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_lnklst.html new file mode 100644 index 0000000000..93f5de5b0a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_lnklst.html @@ -0,0 +1,593 @@ + + + + +ejes query lnklst + + +
+

zoweejesquerylnklst

+

Select a table of data sets in the link list concatenation of the link list libraries defined to the systems in your sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query lnklst [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query lnklst --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query lnklst --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_lpalst.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_lpalst.html new file mode 100644 index 0000000000..a83629acc6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_lpalst.html @@ -0,0 +1,593 @@ + + + + +ejes query lpalst + + +
+

zoweejesquerylpalst

+

Select a table of data sets in the LPA concatenation of the link pack libraries defined to the systems in your sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query lpalst [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query lpalst --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query lpalst --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_mds.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_mds.html new file mode 100644 index 0000000000..0507c3506e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_mds.html @@ -0,0 +1,593 @@ + + + + +ejes query mds + + +
+

zoweejesquerymds

+

Select a table of jobs in the JESplex that are currently delayed in one of the Main Device Scheduler queues.

+

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query mds [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query mds --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query mds --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_memusage.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_memusage.html new file mode 100644 index 0000000000..ab94f6085f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_memusage.html @@ -0,0 +1,593 @@ + + + + +ejes query memusage + + +
+

zoweejesquerymemusage

+

Select a table of real and virtual memory requirements of jobs and other tasks running within your sysplex.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query memusage [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query memusage --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query memusage --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_mounts.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_mounts.html new file mode 100644 index 0000000000..e3f5da460c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_mounts.html @@ -0,0 +1,593 @@ + + + + +ejes query mounts + + +
+

zoweejesquerymounts

+

Select a table of mounted file systems within the sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query mounts [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query mounts --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query mounts --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_netconn.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_netconn.html new file mode 100644 index 0000000000..b78bbd185d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_netconn.html @@ -0,0 +1,593 @@ + + + + +ejes query netconn + + +
+

zoweejesquerynetconn

+

Select a table of NJE (Network Job Entry) connections.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query netconn [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query netconn --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query netconn --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_netserv.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_netserv.html new file mode 100644 index 0000000000..218e5bd749 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_netserv.html @@ -0,0 +1,593 @@ + + + + +ejes query netserv + + +
+

zoweejesquerynetserv

+

Select a table of NJE network servers.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query netserv [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query netserv --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query netserv --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_nje.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_nje.html new file mode 100644 index 0000000000..a7ddcf9a46 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_nje.html @@ -0,0 +1,593 @@ + + + + +ejes query nje + + +
+

zoweejesquerynje

+

Select a table of sysout in the Bulk Data Transfer and TCP/IP NJE queues.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query nje [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query nje --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query nje --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_node.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_node.html new file mode 100644 index 0000000000..0489e9b6c4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_node.html @@ -0,0 +1,593 @@ + + + + +ejes query node + + +
+

zoweejesquerynode

+

Select a table of the NJE nodes defined to the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query node [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query node --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query node --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_offload.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_offload.html new file mode 100644 index 0000000000..cc60a170af --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_offload.html @@ -0,0 +1,584 @@ + + + + +ejes query offload + + +
+

zoweejesqueryoffload

+

Select a table of the JES2 spool offload devices in your JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query offload [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query offload --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query offload --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_pageds.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_pageds.html new file mode 100644 index 0000000000..5ba261c6ec --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_pageds.html @@ -0,0 +1,593 @@ + + + + +ejes query pageds + + +
+

zoweejesquerypageds

+

Select a table of paging resources defined to the systems in your sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query pageds [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query pageds --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query pageds --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_parmlib.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_parmlib.html new file mode 100644 index 0000000000..ac55b48b79 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_parmlib.html @@ -0,0 +1,584 @@ + + + + +ejes query parmlib + + +
+

zoweejesqueryparmlib

+

Select a table of information about system parameter libraries defined to the systems in your sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query parmlib [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query parmlib --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query parmlib --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_printer.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_printer.html new file mode 100644 index 0000000000..0b78e6c57d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_printer.html @@ -0,0 +1,593 @@ + + + + +ejes query printer + + +
+

zoweejesqueryprinter

+

Select a table of JES writers which drive local, FSS, and signed-on/logged-on remote printer and punch devices attached to the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query printer [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query printer --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query printer --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_proclib.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_proclib.html new file mode 100644 index 0000000000..0e6ab70fa4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_proclib.html @@ -0,0 +1,584 @@ + + + + +ejes query proclib + + +
+

zoweejesqueryproclib

+

Select a table of information about your JES proclib concatenations.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query proclib [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query proclib --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query proclib --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_pstatus.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_pstatus.html new file mode 100644 index 0000000000..64645aefea --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_pstatus.html @@ -0,0 +1,593 @@ + + + + +ejes query pstatus + + +
+

zoweejesquerypstatus

+

Select a table of z/OS UNIX processes running in the JESplex.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query pstatus [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query pstatus --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query pstatus --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_resmon.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_resmon.html new file mode 100644 index 0000000000..cded6289a2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_resmon.html @@ -0,0 +1,593 @@ + + + + +ejes query resmon + + +
+

zoweejesqueryresmon

+

Select a table of JES resources for the JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query resmon [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query resmon --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query resmon --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_resource.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_resource.html new file mode 100644 index 0000000000..7e3e1b24df --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_resource.html @@ -0,0 +1,593 @@ + + + + +ejes query resource + + +
+

zoweejesqueryresource

+

Select a table of the WLM Resources defined for the current sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query resource [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query resource --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query resource --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_schenv.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_schenv.html new file mode 100644 index 0000000000..69177f2dfc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_schenv.html @@ -0,0 +1,593 @@ + + + + +ejes query schenv + + +
+

zoweejesqueryschenv

+

Select a table of the WLM Scheduling Environments defined for the current sysplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query schenv [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query schenv --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query schenv --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_session.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_session.html new file mode 100644 index 0000000000..1442d6922d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_session.html @@ -0,0 +1,593 @@ + + + + +ejes query session + + +
+

zoweejesquerysession

+

Select a table of all active (E)JES sessions.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query session [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query session --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query session --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_spart.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_spart.html new file mode 100644 index 0000000000..95fcff6248 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_spart.html @@ -0,0 +1,593 @@ + + + + +ejes query spart + + +
+

zoweejesqueryspart

+

Select a table of the SPOOL partition configuration of your JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query spart [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query spart --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query spart --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_spvol.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_spvol.html new file mode 100644 index 0000000000..c3bc1cac30 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_spvol.html @@ -0,0 +1,584 @@ + + + + +ejes query spvol + + +
+

zoweejesqueryspvol

+

Select a table of the SPOOL volume extent configuration of your JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query spvol [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query spvol --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query spvol --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_status.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_status.html new file mode 100644 index 0000000000..44bf490f9e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_status.html @@ -0,0 +1,593 @@ + + + + +ejes query status + + +
+

zoweejesquerystatus

+

Select a table of all jobs in the JESplex.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query status [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query status --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query status --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_subsys.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_subsys.html new file mode 100644 index 0000000000..4a2e9cfe94 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_subsys.html @@ -0,0 +1,593 @@ + + + + +ejes query subsys + + +
+

zoweejesquerysubsys

+

Select a table of all the MVS subsystems defined to the systems in your sysplex.

+

Use Primary Selection options to modify which rows are included in a table (for example, --sysnames sys* includes only systems starting with "sys"). Use General Use options to narrow your selected rows further. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query subsys [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the selection columns available for this table.
  • +
+

The "list" argument may be used on any option. A descriptive table for that option will be displayed and any other work will stop. The table may display available columns or positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query subsys --select list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query subsys --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_symbol.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_symbol.html new file mode 100644 index 0000000000..cf29413e57 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_symbol.html @@ -0,0 +1,593 @@ + + + + +ejes query symbol + + +
+

zoweejesquerysymbol

+

Select a table of z/OS system symbols as well as JES and JCL symbols defined for the current address space.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query symbol [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query symbol --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query symbol --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_syscls.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_syscls.html new file mode 100644 index 0000000000..49f166390f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_syscls.html @@ -0,0 +1,584 @@ + + + + +ejes query syscls + + +
+

zoweejesquerysyscls

+

Select a table of the sysout class configuration for your JESplex.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query syscls [options]

+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query syscls --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query syscls --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_sysplex.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_sysplex.html new file mode 100644 index 0000000000..b6d41d4ecd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_sysplex.html @@ -0,0 +1,593 @@ + + + + +ejes query sysplex + + +
+

zoweejesquerysysplex

+

Select a table of the connected system images in your z/OS sysplex. In a monoplex, you manage the current system only (i.e., the image on which your (E)JES session is executing).

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query sysplex [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query sysplex --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query sysplex --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_sysreq.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_sysreq.html new file mode 100644 index 0000000000..da72b7cb18 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_sysreq.html @@ -0,0 +1,593 @@ + + + + +ejes query sysreq + + +
+

zoweejesquerysysreq

+

Select a table of outstanding replies and messages retained by the MVS Action Message Retention Facility (AMRF). Outstanding replies and action messages for the entire sysplex are shown.

+

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query sysreq [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other wor`k will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query sysreq --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query sysreq --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_writer.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_writer.html new file mode 100644 index 0000000000..1ffa1fe503 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_writer.html @@ -0,0 +1,593 @@ + + + + +ejes query writer + + +
+

zoweejesquerywriter

+

Select a table of sysout in the Output queue (JES2) or Writer queue (JES3). The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.

+

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query writer [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query writer --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query writer --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ejes_query_zero.html b/static/v2.15.x/web_help/docs/zowe_ejes_query_zero.html new file mode 100644 index 0000000000..6d41e5b420 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ejes_query_zero.html @@ -0,0 +1,593 @@ + + + + +ejes query zero + + +
+

zoweejesqueryzero

+

Select a table of sysout data sets created by JES3 internal facilities.

+

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

+

Usage

+

zowe ejes query zero [parameter-list] [options]

+

Positional Arguments

+
    +
  • +

    parameter-list (string)

    +
      +
    • Optional list enclosed in double-quotes. May contain optional parameters or invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
    • +
    +
  • +
+

EJES Connection Options

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Protocol used to access (E)JES server.

      +

      Default value: https
      +Allowed values: http, https, list, help

      +
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The (E)JES server host name.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      The (E)JES server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Mainframe (E)JES user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (E)JES password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --rejectunauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --basepath | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
    • +
    +
  • +
  • +

    --color-scheme | --scheme | --cs (string)

    +
      +
    • +

      Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.

      +

      Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help

      +

      Default value: dark

      +
    • +
    +
  • +
  • +

    --no-color | --nocolor | --nc (string)

    +
      +
    • Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
    • +
    +
  • +
+

General Use Options

+
    +
  • +

    --metafilter | -m (array)

    +
      +
    • +

      Specify row filtering in a table. Use "-m help" for detailed information. Use "-m list" to show available columns.

      +

      Allowed value: off, metafilter_construct, list, help

      +
    • +
    +
  • +
  • +

    --report | -r (array)

    +
      +
    • +

      Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use "-r list" to show available reports.

      +

      Default value: &nbspb
      +Allowed values: browse-linecommand, list, help

      +
    • +
    +
  • +
  • +

    --select | -s (array)

    +
      +
    • +

      Specify column selections (TSELECT). Use "-s help" for detailed information. Use "-s list" to show available arguments for the table.

      +

      Allowed values: off, select_construct, list, help

      +
    • +
    +
  • +
  • +

    --showcols | -w (string)

    +
      +
    • +

      Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use "-w list" to show available columns.

      +

      Allowed values: column-key..., list, help

      +
    • +
    +
  • +
  • +

    --sort | -z (array)

    +
      +
    • +

      Specify column sorting. Use "-z list" to show available columns.

      +

      Allowed values: off, sort_construct, list, help

      +
    • +
    +
  • +
  • +

    --table | -t (array)

    +
      +
    • +

      Specify a child table. Use "-t list" to show available tables.

      +

      Default value: &nbsps
      +Allowed values: tabular-linecommand, list, help

      +
    • +
    +
  • +
+

General Primary Selection Options

+
    +
  • +

    --dest (string)

    +
      +
    • +

      Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.

      +

      Allowed values: off, destination-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobclass (string)

    +
      +
    • +

      Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, jobclass-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --jobname | -j (string)

    +
      +
    • +

      Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.

      +

      Allowed values: off, jobname-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --origin (string)

    +
      +
    • +

      Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, origin-mask(s), list, help

      +
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • +

      Specify up to 8 owner masks.

      +

      Allowed values: off, name-mask(s), list, help

      +
    • +
    +
  • +
+

Query options

+
    +
  • +

    --header (string)

    +
      +
    • +

      Specify whether to include headers for tables.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --cc (string)

    +
      +
    • +

      Establish carriage control handling for downloaded reports.

      +

      Allowed values: discard, interpret, keep, list, help

      +
    • +
    +
  • +
  • +

    --countOnly | --count (string)

    +
      +
    • +

      When a table or report is selected for output, only output the "Rows available" line.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --hidecols (string)

    +
      +
    • +

      Specify columns to hide in a table. Use "--hidecols list" to show available columns.

      +

      Allowed values: column-key..., list, help]

      +
    • +
    +
  • +
  • +

    --lines | -y (string)

    +
      +
    • +

      Specify lines in a table or report.

      +

      Default value: &nbspTable: Terminal rows - 6, Report: 1000
      +Allowed values: 1000, number, all, list, help

      +
    • +
    +
  • +
  • +

    --pdf (array)

    +
      +
    • Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --text | --txt (array)

    +
      +
    • Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.
    • +
    +
  • +
  • +

    --start (string)

    +
      +
    • +

      Specify the beginning line number for a report.

      +

      Allowed values: number, 1, list, help

      +
    • +
    +
  • +
  • +

    --width | -x (string)

    +
      +
    • +

      Specify maximum characters per line or row.

      +

      Default value: &nbsptty default character width
      +Allowed values: number, all, list, help

      +
    • +
    +
  • +
+

Command Processing Options

+
    +
  • +

    --actpurge (string)

    +
      +
    • +

      Enable cancel/purge commands for executing jobs on job-oriented tables.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --command | -c (string)

    +
      +
    • +

      Specify a line command. Use "-c list" to show available commands.

      +

      Allowed values: command[ argument], list, help

      +
    • +
    +
  • +
  • +

    --confirm (string)

    +
      +
    • +

      Confirm previously queued commands. Use "--confirm help" for detailed information.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --immediate | -i (string)

    +
      +
    • +

      Run line commands without confirmation.

      +

      Allowed values: fast, slow, list, help

      +
    • +
    +
  • +
+

Job Submission Options

+
    +
  • +

    --submit | --submit | --sub (string)

    +
      +
    • +

      Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.

      +

      Allowed values: local:path, MVS data set, z/OS UNIX path

      +
    • +
    +
  • +
  • +

    --recfm (array)

    +
      +
    • Record format.
    • +
    +
  • +
  • +

    --lrecl (array)

    +
      +
    • Logical record length.
    • +
    +
  • +
  • +

    --unit (array)

    +
      +
    • Generic or esoteric unit name where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --volume (array)

    +
      +
    • Volume serial where an uncataloged MVS data set resides.
    • +
    +
  • +
  • +

    --subsys (array)

    +
      +
    • +

      Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.

      +

      Allowed values: jes2, jes3, list, help

      +
    • +
    +
  • +
+

Debug and Test Options

+
    +
  • +

    --debug | --dbg | --debug-value | --dv (string)

    +
      +
    • +

      Specify a numeric debugging mode.

      +

      Allowed values: number, list, help

      +

      Allowed values: \d+, list, help

      +
    • +
    +
  • +
  • +

    --dry-run | -n (array)

    +
      +
    • +

      Run under dry-run protocols.

      +

      Allowed values: syntax, check, all, list, help

      +
    • +
    +
  • +
+

Advanced Use Primary Selection Options

+
    +
  • +

    --atx (string)

    +
      +
    • +

      Disable selecting APPC/MVS transaction jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --job (string)

    +
      +
    • +

      Disable selecting batch jobs for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --stc (string)

    +
      +
    • +

      Disable selecting started tasks for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --sysclass (string)

    +
      +
    • +

      Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.

      +

      Allowed values: off, sysclass(es), list, help

      +
    • +
    +
  • +
  • +

    --tsu (string)

    +
      +
    • +

      Disable selecting TSO user output for applicable tables by specifying "no".

      +

      Allowed values: yes, no, off, list, help

      +
    • +
    +
  • +
  • +

    --usr | --userid (string)

    +
      +
    • +

      Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.

      +

      Allowed values: off, user-mask(s), list, help

      +
    • +
    +
  • +
+

Advanced Use Options

+
    +
  • +

    --acplex (string)

    +
      +
    • +

      Set the data gathering scope for the Activity display.

      +

      Allowed values: jes, sys, list, help

      +
    • +
    +
  • +
  • +

    --codepage | ----cp (string)

    +
      +
    • +

      Change the code page set for your installation for output as UTF-8.

      +

      Allowed values: list, help, 0, 273, 277, 280, 284, 297, 297, 424, 833, 870, 875, 1026, 1047, 1122, 1141, 1143, 1145, 1147, 1149, 1159, 37, 275, 278, 281, 285, 420, 500, 836, 871, 1025, 1027, 1112, 1140, 1140, 1142, 1144, 1146, 1148, 1153

      +
    • +
    +
  • +
  • +

    --curstep (string)

    +
      +
    • +

      Enable extra columns on JES2 Input and Job Status.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --datefmt (string)

    +
      +
    • +

      Customize date formatting.

      +

      Allowed values: yyyyddd ., yyyyddd -, yyyyddd, YYYYMMDD /, YYYYMMDD -, YYYYMMDD, YYYYDDMM /, YYYYDDMM -, YYYYDDMM, MMDDYYYY /, MMDDYYYY -, MMDDYYYY, DDMMYYYY /, DDMMYYYY -, DDMMYYYY

      +
    • +
    +
  • +
  • +

    --deltxt (string)

    +
      +
    • +

      Possibly show canceled or printed data sets in the JES spool.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --inptxt (string)

    +
      +
    • +

      Show in-stream SYSIN data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --jes2 | -2 (boolean)

    +
      +
    • Use the JES2 spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --jes3 | -3 (boolean)

    +
      +
    • Use the JES3 or JES3plus spooler instead of the default spooler.
    • +
    +
  • +
  • +

    --max (string)

    +
      +
    • +

      Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.

      +

      Allowed values: on, list, help

      +
    • +
    +
  • +
  • +

    --numchar (string)

    +
      +
    • +

      Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.

      +

      Allowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.

      +
    • +
    +
  • +
  • +

    --setup (string)

    +
      +
    • +

      On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
  • +

    --sysname (string)

    +
      +
    • +

      Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.

      +

      Allowed values: system-mask, '', *, list, help

      +
    • +
    +
  • +
  • +

    --systxt (string)

    +
      +
    • +

      Show internal JES data sets.

      +

      Allowed values: on, off, list, help

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --subsystem (string)

    +
      +
    • Name of the spooler to use instead of the default spooler.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ejes-profile | --ejes-p (string)

    +
      +
    • The name of a (ejes) profile to load for this command execution.
    • +
    +
  • +
+

Examples

+
    +
  • List the available table types for the child table.
  • +
+

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

+

Example:

+
  * `$  zowe ejes query zero --table list`
+
+
    +
  • Provide detailed help for the metafilter option.
  • +
+

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

+

Example:

+
  * `$  zowe ejes query zero --metafilter help`
+
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git.html new file mode 100644 index 0000000000..6ae637b7f2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git.html @@ -0,0 +1,27 @@ + + + + +endevor-bridge-for-git + + +
+

zoweendevor-bridge-for-git

+

Use the Endevor Bridge for Git plug-in to manage your Git-Endevor mappings and build your local Git changes before synchronizing them to Endevor.

+

Usage

+

zowe endevor-bridge-for-git <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_branch.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_branch.html new file mode 100644 index 0000000000..7764c95081 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_branch.html @@ -0,0 +1,22 @@ + + + + +endevor-bridge-for-git branch + + +
+

zoweendevor-bridge-for-gitbranch

+

Manage the branches of your Git-Endevor mapping.

+

Usage

+

zowe endevor-bridge-for-git branch <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • add | a - Add a branch to an existing mapping
  • +
  • delete | d - Remove a branch from an existing mapping
  • +
  • list | ls - List the branches of an existing mapping
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_branch_add.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_branch_add.html new file mode 100644 index 0000000000..cd6745ebc8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_branch_add.html @@ -0,0 +1,279 @@ + + + + +endevor-bridge-for-git branch add + + +
+

zoweendevor-bridge-for-gitbranchadd

+

Add a branch to an existing mapping

+

Usage

+

zowe endevor-bridge-for-git branch add <context> <mapping> <branch> [options]

+

Positional Arguments

+
    +
  • +

    context (string)

    +
      +
    • Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
    • +
    +
  • +
  • +

    mapping (string)

    +
      +
    • Git-Endevor mapping name (ID of the Git repository).
    • +
    +
  • +
  • +

    branch (string)

    +
      +
    • Name of the branch that will be added/removed.
    • +
    +
  • +
+

Options

+
    +
  • +

    --endevor-system | --endevorsys | --system (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub | --sub | --subsystem (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --system-alias (string)

    +
      +
    • The alias of Endevor system.
    • +
    +
  • +
  • +

    --subsystem-alias (string)

    +
      +
    • The alias of Endevor subsystem.
    • +
    +
  • +
  • +

    --endevor-environment | --endevorenv | --env | --environment (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --read-only (boolean)

    +
      +
    • If specified, it is necessary to use the option --endevor-stage-number. The synchronized elements will be read-only.
    • +
    +
  • +
  • +

    --endevor-stage-number | --endevorsn (string)

    +
      +
    • The Endevor stage where your project resides (only for read only mappings).
    • +
    +
  • +
  • +

    --only-work-environment (boolean)

    +
      +
    • If specified, only elements from the Endevor work environment will be synchronized.
    • +
    +
  • +
  • +

    --mapping-mode (string)

    +
      +
    • +

      Mapping mode of the mapping ('FULL', 'WORK_ENV_ONLY' or 'MIRROR')

      +

      Allowed values: FULL, WORK_ENV_ONLY, MIRROR

      +
    • +
    +
  • +
  • +

    --like (string)

    +
      +
    • Add branch using parameters from another branch in the same repository
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git branch add MY-CONTEXT MY-MAPPING MY-BRANCH --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME
    • +
    +
  • +
  • +

    Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile by using another branch as a template with different environment:

    +
      +
    • zowe endevor-bridge-for-git branch add MY-CONTEXT MY-MAPPING MY-BRANCH --like TEMPLATE_BRANCH --endevor-environment DIFFERENT_ENVIRONMENT
    • +
    +
  • +
  • +

    Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile by using another branch as a template with different system/subsystem:

    +
      +
    • zowe endevor-bridge-for-git branch add MY-CONTEXT MY-MAPPING MY-BRANCH --like TEMPLATE_BRANCH --endevor-system DIFFERENT_SYSTEM --endevor-subsystem DIFFERENT_SUBSYSTEM
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_branch_delete.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_branch_delete.html new file mode 100644 index 0000000000..54e59a9005 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_branch_delete.html @@ -0,0 +1,140 @@ + + + + +endevor-bridge-for-git branch delete + + +
+

zoweendevor-bridge-for-gitbranchdelete

+

Remove a branch from an existing mapping

+

Usage

+

zowe endevor-bridge-for-git branch delete <context> <mapping> [branch] [options]

+

Positional Arguments

+
    +
  • +

    context (string)

    +
      +
    • Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
    • +
    +
  • +
  • +

    mapping (string)

    +
      +
    • Git-Endevor mapping name (ID of the Git repository).
    • +
    +
  • +
  • +

    branch (string)

    +
      +
    • Name of the synchronized branch in the Git repository.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Remove a branch from my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git branch delete MY-CONTEXT MY-MAPPING MY-BRANCH
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_branch_list.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_branch_list.html new file mode 100644 index 0000000000..1cfc1f2f97 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_branch_list.html @@ -0,0 +1,134 @@ + + + + +endevor-bridge-for-git branch list + + +
+

zoweendevor-bridge-for-gitbranchlist

+

List the branches of an existing mapping

+

Usage

+

zowe endevor-bridge-for-git branch list <context> <mapping> [options]

+

Positional Arguments

+
    +
  • +

    context (string)

    +
      +
    • Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
    • +
    +
  • +
  • +

    mapping (string)

    +
      +
    • Git-Endevor mapping name (ID of the Git repository).
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all branch of my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git branch list MY-CONTEXT MY-MAPPING
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_build.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_build.html new file mode 100644 index 0000000000..dee7603566 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_build.html @@ -0,0 +1,22 @@ + + + + +endevor-bridge-for-git build + + +
+

zoweendevor-bridge-for-gitbuild

+

Build changes from git local repository in Endevor

+

Usage

+

zowe endevor-bridge-for-git build <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_build_execute.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_build_execute.html new file mode 100644 index 0000000000..f1b5a5c39b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_build_execute.html @@ -0,0 +1,263 @@ + + + + +endevor-bridge-for-git build execute + + +
+

zoweendevor-bridge-for-gitbuildexecute

+

Build changes against remote git repository's Endevor Bridge for Git synchronized branch, using work area or build subsystem.It does not support autogen for building dependencies.

+

Usage

+

zowe endevor-bridge-for-git build execute [options]

+

Required Options

+
    +
  • +

    --endevor-instance | --endevori (string)

    +
      +
    • The Endevor Web Services Endevor configuration name.
    • +
    +
  • +
+

Endevor work area options

+
    +
  • +

    --work-area-id | --waid (string)

    +
      +
    • Endevor work area ID. Name-masking is not allowed.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub (string)

    +
      +
    • The Endevor SCM build subsystem. Note: The build subsystem can be cleared without prior permission.
    • +
    +
  • +
  • +

    --endevor-environment | --endevorenv (string)

    +
      +
    • The Endevor SCM environment where your build subsystem resides.
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys (string)

    +
      +
    • The Endevor SCM system where your build subsystem resides.
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping that you are building.

      +

      Default value: ./

      +
    • +
    +
  • +
  • +

    --listing-dir (string)

    +
      +
    • +

      Specify the directory where you would like to have your build outputs downloaded

      +

      Default value: .endevor/listings

      +
    • +
    +
  • +
  • +

    --listing-rc (number)

    +
      +
    • +

      All the elements that have a generate result equal to or greater than "listing-rc" will have their build outputs downloaded into "listing-dir"

      +

      Default value: 4

      +
    • +
    +
  • +
  • +

    --force-cleanup | --fc (boolean)

    +
      +
    • +

      Starts the build process after cleaning the build subsystem.

      +

      Default value: false

      +
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compile the changed elements in the current Git working directory using the work area "WORKAREA1" and an existing Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git build execute --endevor-instance INSTANCE --work-area-id WORKAREA1
    • +
    +
  • +
  • +

    Compile the changed elements in the current Git working directory using the build subsystem "SUBNAME" and an existing Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git build execute --endevor-instance INSTANCE --endevor-subsystem SUBNAME --endevor-environment ENVNAME --endevor-system SYSNAME
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_build_job-report.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_build_job-report.html new file mode 100644 index 0000000000..ba0f575deb --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_build_job-report.html @@ -0,0 +1,272 @@ + + + + +endevor-bridge-for-git build job-report + + +
+

zoweendevor-bridge-for-gitbuildjob-report

+

Get the report after executing 'build job-submit' command. This this command must be issued to finalize processing.

+

Usage

+

zowe endevor-bridge-for-git build job-report [options]

+

Required Options

+
    +
  • +

    --endevor-instance | --endevori (string)

    +
      +
    • The Endevor Web Services Endevor configuration name.
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping that you are building.

      +

      Default value: ./

      +
    • +
    +
  • +
  • +

    --listing-dir (string)

    +
      +
    • +

      Specify the directory where you would like to have your build outputs downloaded

      +

      Default value: .endevor/listings

      +
    • +
    +
  • +
  • +

    --listing-rc (number)

    +
      +
    • +

      All the elements that have a generate result equal to or greater than "listing-rc" will have their build outputs downloaded into "listing-dir"

      +

      Default value: 4

      +
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

z/OSMF connection options (alternatively use a 'zosmf' profile)

+
    +
  • +

    --zosmf-host | --zosmfh (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --zosmf-port | --zosmfp (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --zosmf-user | --zosmfu (string)

    +
      +
    • Mainframe (z/OSMF) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --zosmf-password | --zosmfpass | --zosmfpw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --zosmf-reject-unauthorized | --zosmfru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --zosmf-base-path | --zosmfbp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option toprepend the base path to all z/OSMF resources when making REST requests. Do notspecify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the reports from the build job submitted by 'build job-submit' command from git working directory "/endevor/ebg/repository" using existing Endevor and z/OSMF profiles:

    +
      +
    • zowe endevor-bridge-for-git build job-report --wd "C:\endevor\ebg\dir"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_build_job-submit.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_build_job-submit.html new file mode 100644 index 0000000000..51166bbe0b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_build_job-submit.html @@ -0,0 +1,317 @@ + + + + +endevor-bridge-for-git build job-submit + + +
+

zoweendevor-bridge-for-gitbuildjob-submit

+

Build changes from git local repository in Endevor by submitting a job. It supports autogen for building dependencies using with the option of selecting autogen span. After submitting, the command 'build job-report' must be issued to finalize processing.

+

Usage

+

zowe endevor-bridge-for-git build job-submit [options]

+

Required Options

+ +

Endevor work area options

+
    +
  • +

    --work-area-id | --waid (string)

    +
      +
    • Endevor work area ID. Name-masking is not allowed.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub (string)

    +
      +
    • The Endevor SCM build subsystem. Note: The build subsystem can be cleared without prior permission.
    • +
    +
  • +
  • +

    --endevor-environment | --endevorenv (string)

    +
      +
    • The Endevor SCM environment where your build subsystem resides.
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys (string)

    +
      +
    • The Endevor SCM system where your build subsystem resides.
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping that you are building.

      +

      Default value: ./

      +
    • +
    +
  • +
  • +

    --force-cleanup | --fc (boolean)

    +
      +
    • +

      Starts the build process after cleaning the build subsystem.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --autogen-span | --ags (string)

    +
      +
    • +

      Specifies the autogen action option to automatically generate using elements.
      +The allowed values which have the following meaning:
      +NONE - Generates all elements that use the component being acted upon.
      +ALL - Generates using elements that are found in any System and Subsystem combinations within the Environment and Stage of the component's logical map.
      +SYSTEMS - Generates using elements that are found in any System, provided the element's Subsystem name matches the name of the Subsystem of the target component.
      +SUBSYSTEMS - Generates using elements from all Subsystems with the same-named System of the component specified.

      +

      Default value: NONE
      +Allowed values: NONE, ALL, SYSTEMS, SUBSYSTEMS

      +
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

z/OSMF connection options (alternatively use a 'zosmf' profile)

+
    +
  • +

    --zosmf-host | --zosmfh (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --zosmf-port | --zosmfp (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --zosmf-user | --zosmfu (string)

    +
      +
    • Mainframe (z/OSMF) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --zosmf-password | --zosmfpass | --zosmfpw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --zosmf-reject-unauthorized | --zosmfru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --zosmf-base-path | --zosmfbp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option toprepend the base path to all z/OSMF resources when making REST requests. Do notspecify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compile the changed elements at "/endevor/ebg/repository" using work area with ID "WORKAREA1", jcl skeleton at "/endevor/jcl/jcl.txt" and existing Endevor and z/OSMF profiles:

    +
      +
    • zowe endevor-bridge-for-git build job-submit --skeleton-jcl /endevor/jcl/jcl.txt --work-area-id WORKAREA1 --work-dir /endevor/ebg/repository
    • +
    +
  • +
  • +

    Compile the changed elements at "/endevor/ebg/repository" using build subsystem "SUBNAME", jcl skeleton at "/endevor/jcl/jcl.txt" and existing Endevor and z/OSMF profiles:

    +
      +
    • zowe endevor-bridge-for-git build job-submit --skeleton-jcl /endevor/jcl/jcl.txt --endevor-subsystem SUBNAME --endevor-environment ENVNAME --endevor-system SYSNAME --work-dir /endevor/ebg/repository
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection.html new file mode 100644 index 0000000000..da1c29d09d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection.html @@ -0,0 +1,24 @@ + + + + +endevor-bridge-for-git endevor-connection + + +
+

zoweendevor-bridge-for-gitendevor-connection

+

Manage connections to Endevor Web Services used by Endevor Bridge for Git.

+

Usage

+

zowe endevor-bridge-for-git endevor-connection <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_create.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_create.html new file mode 100644 index 0000000000..d4fc1c8ee2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_create.html @@ -0,0 +1,210 @@ + + + + +endevor-bridge-for-git endevor-connection create + + +
+

zoweendevor-bridge-for-gitendevor-connectioncreate

+

Create new Endevor connection for Endevor Bridge for Git.

+

Usage

+

zowe endevor-bridge-for-git endevor-connection create <connection> [options]

+

Positional Arguments

+
    +
  • +

    connection (string)

    +
      +
    • Endevor connection name.
    • +
    +
  • +
+

Options

+
    +
  • +

    --endevor-instance | --endevori (string)

    +
      +
    • The Endevor Web Services Endevor configuration name.
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create the Endevor connection 'MY-CONNECTION' using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --endevor-instance INSTANCE
    • +
    +
  • +
  • +

    Create the Endevor connection 'MY-CONNECTION' using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --endevor-protocol http --endevor-host endevor-host --endevor-port 12345 --endevor-instance INSTANCE
    • +
    +
  • +
  • +

    Create the Endevor connection 'MY-CONNECTION' using the default Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --protocol http --host bridge-host --port 8080 --endevor-instance INSTANCE
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_delete.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_delete.html new file mode 100644 index 0000000000..dffc7754d5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_delete.html @@ -0,0 +1,134 @@ + + + + +endevor-bridge-for-git endevor-connection delete + + +
+

zoweendevor-bridge-for-gitendevor-connectiondelete

+

Delete existing Endevor connection defined to Endevor Bridge for Git.

+

Usage

+

zowe endevor-bridge-for-git endevor-connection delete <connection> [options]

+

Positional Arguments

+
    +
  • +

    connection (string)

    +
      +
    • Endevor connection name.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the Endevor connection using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection delete MY-CONNECTION
    • +
    +
  • +
  • +

    Delete the Endevor connection without an EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection delete MY-CONNECTION --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_list.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_list.html new file mode 100644 index 0000000000..bf45296ccf --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_list.html @@ -0,0 +1,153 @@ + + + + +endevor-bridge-for-git endevor-connection list + + +
+

zoweendevor-bridge-for-gitendevor-connectionlist

+

List Endevor connections used by Endevor Bridge for Git.

+

Usage

+

zowe endevor-bridge-for-git endevor-connection list [options]

+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all the Endevor connections using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection list
    • +
    +
  • +
  • +

    List all the Endevor connections without an EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection list --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_rename.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_rename.html new file mode 100644 index 0000000000..fb729bd6ec --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_rename.html @@ -0,0 +1,140 @@ + + + + +endevor-bridge-for-git endevor-connection rename + + +
+

zoweendevor-bridge-for-gitendevor-connectionrename

+

Rename existing Endevor connection defined to Endevor Bridge for Git.

+

Usage

+

zowe endevor-bridge-for-git endevor-connection rename <connection> <new-connection> [options]

+

Positional Arguments

+
    +
  • +

    connection (string)

    +
      +
    • Endevor connection name.
    • +
    +
  • +
  • +

    new-connection (string)

    +
      +
    • New Endevor connection name.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Rename the Endevor connection using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection rename MY-CONNECTION NEW-NAME
    • +
    +
  • +
  • +

    Rename the Endevor connection without an EBG profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection rename MY-CONNECTION NEW-NAME --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_update-credentials.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_update-credentials.html new file mode 100644 index 0000000000..d429b57ce6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-connection_update-credentials.html @@ -0,0 +1,155 @@ + + + + +endevor-bridge-for-git endevor-connection update-credentials + + +
+

zoweendevor-bridge-for-gitendevor-connectionupdate-credentials

+

Update your Endevor credentials for the Endevor connection.

+

Usage

+

zowe endevor-bridge-for-git endevor-connection update-credentials <connection> [options]

+

Positional Arguments

+
    +
  • +

    connection (string)

    +
      +
    • Endevor connection name.
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update the Endevor credentials for the Endevor connection MY-CONNECTION using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection update-credentials MY-CONNECTION
    • +
    +
  • +
  • +

    Update the Endevor credentials for the Endevor connection MY-CONNECTION using the default EBG profile but not using an Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-connection update-credentials MY-CONNECTION --endevor-user my-user --endevor-password my-password
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-credentials.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-credentials.html new file mode 100644 index 0000000000..fd8e704aa9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-credentials.html @@ -0,0 +1,20 @@ + + + + +endevor-bridge-for-git endevor-credentials + + +
+

zoweendevor-bridge-for-gitendevor-credentials

+

Manage your Endevor credentials stored in Endevor Bridge for Git. [Deprecated]

+

Usage

+

zowe endevor-bridge-for-git endevor-credentials <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • update | u - Update your Endevor credentials for a Git-Endevor mapping.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-credentials_update.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-credentials_update.html new file mode 100644 index 0000000000..1cb24eaaf4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_endevor-credentials_update.html @@ -0,0 +1,161 @@ + + + + +endevor-bridge-for-git endevor-credentials update + + +
+

zoweendevor-bridge-for-gitendevor-credentialsupdate

+

Update your Endevor credentials for a Git-Endevor mapping.

+

Usage

+

zowe endevor-bridge-for-git endevor-credentials update <context> <mapping> [options]

+

Positional Arguments

+
    +
  • +

    context (string)

    +
      +
    • Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
    • +
    +
  • +
  • +

    mapping (string)

    +
      +
    • Git-Endevor mapping name (ID of the Git repository).
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update the Endevor credentials for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-credentials update MY-CONTEXT MY-MAPPING
    • +
    +
  • +
  • +

    Update the Endevor credentials for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile but not using an Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git endevor-credentials update MY-CONTEXT MY-MAPPING --endevor-user my-user --endevor-password my-password
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_local-hook-token.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_local-hook-token.html new file mode 100644 index 0000000000..d1d9b9967d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_local-hook-token.html @@ -0,0 +1,22 @@ + + + + +endevor-bridge-for-git local-hook-token + + +
+

zoweendevor-bridge-for-gitlocal-hook-token

+

Manage the token you use for secure communication with BridgeForGit when using the local hook validation.

+

Usage

+

zowe endevor-bridge-for-git local-hook-token <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_local-hook-token_generate.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_local-hook-token_generate.html new file mode 100644 index 0000000000..23f3df7c3c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_local-hook-token_generate.html @@ -0,0 +1,131 @@ + + + + +endevor-bridge-for-git local-hook-token generate + + +
+

zoweendevor-bridge-for-gitlocal-hook-tokengenerate

+

Generate a new local hook token for Endevor Bridge for Git.

+

Usage

+

zowe endevor-bridge-for-git local-hook-token generate [options]

+

Options

+
    +
  • +

    --overwrite (boolean)

    +
      +
    • +

      If specified, your previous token will be overwritten.

      +

      Default value: false

      +
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Generate a token using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git local-hook-token generate
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_local-hook-token_list.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_local-hook-token_list.html new file mode 100644 index 0000000000..f693a24d74 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_local-hook-token_list.html @@ -0,0 +1,119 @@ + + + + +endevor-bridge-for-git local-hook-token list + + +
+

zoweendevor-bridge-for-gitlocal-hook-tokenlist

+

List your local hook token.

+

Usage

+

zowe endevor-bridge-for-git local-hook-token list [options]

+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    List your token using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git local-hook-token list
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_local-hook-token_revoke.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_local-hook-token_revoke.html new file mode 100644 index 0000000000..566c56a7ec --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_local-hook-token_revoke.html @@ -0,0 +1,119 @@ + + + + +endevor-bridge-for-git local-hook-token revoke + + +
+

zoweendevor-bridge-for-gitlocal-hook-tokenrevoke

+

Revoke your local hook token.

+

Usage

+

zowe endevor-bridge-for-git local-hook-token revoke [options]

+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Revoke your token using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git local-hook-token revoke
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping.html new file mode 100644 index 0000000000..fda7391187 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping.html @@ -0,0 +1,23 @@ + + + + +endevor-bridge-for-git mapping + + +
+

zoweendevor-bridge-for-gitmapping

+

Manage the Git-Endevor mappings.

+

Usage

+

zowe endevor-bridge-for-git mapping <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_add-element.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_add-element.html new file mode 100644 index 0000000000..ee7d6dbcf6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_add-element.html @@ -0,0 +1,276 @@ + + + + +endevor-bridge-for-git mapping add-element + + +
+

zoweendevor-bridge-for-gitmappingadd-element

+

Add an element from up the map in your Endevor to your Git repository.

+

Usage

+

zowe endevor-bridge-for-git mapping add-element <context> <mapping> [options]

+

Positional Arguments

+
    +
  • +

    context (string)

    +
      +
    • Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
    • +
    +
  • +
  • +

    mapping (string)

    +
      +
    • Git-Endevor mapping name (ID of the Git repository).
    • +
    +
  • +
+

Options

+
    +
  • +

    --element-name | --name (string)

    +
      +
    • The name of the Endevor element you want to add.
    • +
    +
  • +
  • +

    --element-type | --type (string)

    +
      +
    • The type of the Endevor element you want to add
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys | --system (string)

    +
      +
    • The Endevor system where your element resides.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub | --sub | --subsystem (string)

    +
      +
    • The Endevor subsystem where your element resides.
    • +
    +
  • +
  • +

    --withDependencies (boolean)

    +
      +
    • +

      If specified, the requested element will be added with dependencies (eg. COBOL copybooks).

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --force-get-dependencies | --force (boolean)

    +
      +
    • +

      If specified, the maximum number of dependencies will be bypassed. This only applies to the repository administrator.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --validate (boolean)

    +
      +
    • +

      If specified, the requested elements will be validated against Endevor.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --branchId (string)

    +
      +
    • If specified, the requested elements will be added to the selected branch.
    • +
    +
  • +
  • +

    --all-branches (boolean)

    +
      +
    • +

      If specified, the requested elements will be added to all synchronized branches in your repository.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --file | --fn (local file path)

    +
      +
    • If specified, the elements to add will be read from file. Make sure that the file is in the correct format as specified in the documentation.
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Add an element 'MY-ELEMENT-TYPE / MY-ELEMENT-NAME' for your mapping 'MY-CONTEXT / MY-MAPPING':

    +
      +
    • zowe endevor-bridge-for-git mapping add-element MY-CONTEXT MY-MAPPING --name MY-ELEMENT-NAME --type MY-ELEMENT-TYPE
    • +
    +
  • +
  • +

    Add multiple elements for your mapping 'MY-CONTEXT / MY-MAPPING' from file:

    +
      +
    • zowe endevor-bridge-for-git mapping add-element MY-CONTEXT MY-MAPPING --fileName MY-FILEPATH.json
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_create.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_create.html new file mode 100644 index 0000000000..6c3f3dedc9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_create.html @@ -0,0 +1,297 @@ + + + + +endevor-bridge-for-git mapping create + + +
+

zoweendevor-bridge-for-gitmappingcreate

+

Create a Git-Endevor mapping

+

Usage

+

zowe endevor-bridge-for-git mapping create [options]

+

Options

+
    +
  • +

    --remote-url | --url (string)

    +
      +
    • Git repository remote URL
    • +
    +
  • +
  • +

    --connection (string)

    +
      +
    • Endevor connection name.
    • +
    +
  • +
  • +

    --endevor-instance | --endevori (string)

    +
      +
    • The Endevor Web Services Endevor configuration name.
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys | --system (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub | --sub | --subsystem (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --system-alias (string)

    +
      +
    • The alias of Endevor system.
    • +
    +
  • +
  • +

    --subsystem-alias (string)

    +
      +
    • The alias of Endevor subsystem.
    • +
    +
  • +
  • +

    --endevor-environment | --endevorenv | --env | --environment (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --branch | -b (string)

    +
      +
    • +

      Name of the synchronized branch in the Git repository.

      +

      Default value: master

      +
    • +
    +
  • +
  • +

    --only-work-environment (boolean)

    +
      +
    • If specified, only elements from the Endevor work environment will be synchronized.
    • +
    +
  • +
  • +

    --read-only (boolean)

    +
      +
    • If specified, it is necessary to use the option --endevor-stage-number. The synchronized elements will be read-only.
    • +
    +
  • +
  • +

    --endevor-stage-number | --endevorsn (string)

    +
      +
    • The Endevor stage where your project resides (only for read only mappings).
    • +
    +
  • +
  • +

    --type-filter (string)

    +
      +
    • Type filter
    • +
    +
  • +
  • +

    --mapping-mode (string)

    +
      +
    • +

      Mapping mode of the mapping ('FULL', 'WORK_ENV_ONLY' or 'MIRROR')

      +

      Allowed values: FULL, WORK_ENV_ONLY, MIRROR

      +
    • +
    +
  • +
  • +

    --json-file | --json (local file path)

    +
      +
    • Mapping JSON file to import
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git mapping create --remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME
    • +
    +
  • +
  • +

    Create the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git mapping create --remote-url https://git-server-enterprise.com/my-context/my-mapping.git --connection endevor-connection-name --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME
    • +
    +
  • +
  • +

    Create the read-only Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git mapping create --remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME --read-only --endevor-stage-number 2
    • +
    +
  • +
  • +

    Create the Git-Endevor mapping with importing a mapping file:

    +
      +
    • zowe endevor-bridge-for-git mapping create --json-file my-mapping.json
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_delete.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_delete.html new file mode 100644 index 0000000000..22db701d2b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_delete.html @@ -0,0 +1,134 @@ + + + + +endevor-bridge-for-git mapping delete + + +
+

zoweendevor-bridge-for-gitmappingdelete

+

Delete a Git-Endevor mapping

+

Usage

+

zowe endevor-bridge-for-git mapping delete <context> <mapping> [options]

+

Positional Arguments

+
    +
  • +

    context (string)

    +
      +
    • Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
    • +
    +
  • +
  • +

    mapping (string)

    +
      +
    • Git-Endevor mapping name (ID of the Git repository).
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git mapping delete MY-CONTEXT MY-MAPPING
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_list.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_list.html new file mode 100644 index 0000000000..8766a59ef1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_list.html @@ -0,0 +1,187 @@ + + + + +endevor-bridge-for-git mapping list + + +
+

zoweendevor-bridge-for-gitmappinglist

+

List Git-Endevor mappings. If the mapping contains multiple systems and/or subsystems, the field 'system' and 'subsystem' will contain the value 'multi'.

+

Usage

+

zowe endevor-bridge-for-git mapping list [options]

+

Options

+
    +
  • +

    --view | -v (string)

    +
      +
    • +

      Type of detail to be displayed.

      +

      Default value: default
      +Allowed values: default, endevor, all

      +
    • +
    +
  • +
  • +

    --export (boolean)

    +
      +
    • +

      Export list of mapping to a json file.

      +

      Default value: false

      +
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ebg-profile | --ebg-p (string)

    +
      +
    • The name of a (ebg) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all the Git-Endevor mappings using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git mapping list
    • +
    +
  • +
  • +

    List all the Git-Endevor mappings and show their Endevor details using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git mapping list --view endevor
    • +
    +
  • +
  • +

    List all the Git-Endevor mappings and show all their details using the default EBG profile:

    +
      +
    • zowe endevor-bridge-for-git mapping list --view all
    • +
    +
  • +
  • +

    List all the Git-Endevor mappings without an EBG profile:

    +
      +
    • zowe endevor-bridge-for-git mapping list --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_processor-group.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_processor-group.html new file mode 100644 index 0000000000..70cac874fb --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_processor-group.html @@ -0,0 +1,22 @@ + + + + +endevor-bridge-for-git processor-group + + +
+

zoweendevor-bridge-for-gitprocessor-group

+

Manage the processor groups of your mapping

+

Usage

+

zowe endevor-bridge-for-git processor-group <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_processor-group_list.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_processor-group_list.html new file mode 100644 index 0000000000..eb8bbf17d5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_processor-group_list.html @@ -0,0 +1,88 @@ + + + + +endevor-bridge-for-git processor-group list + + +
+

zoweendevor-bridge-for-gitprocessor-grouplist

+

List processor groups used by a type in your mapping

+

Usage

+

zowe endevor-bridge-for-git processor-group list [options]

+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping.

      +

      Default value: ./

      +
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys (string)

    +
      +
    • The Endevor system or alias of the system where your project resides.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub (string)

    +
      +
    • The Endevor subsystem or alias of the subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --type (string)

    +
      +
    • The type of the Endevor element
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all the processor groups used by a type in your mapping for a single system/subsystem mapping.:

    +
      +
    • zowe endevor-bridge-for-git processor-group list --type TYPE
    • +
    +
  • +
  • +

    List all the processor groups used by a type in your mapping for a multi system/subsystem mapping.:

    +
      +
    • zowe endevor-bridge-for-git processor-group list --endevorsys SYSTEM --endevorsub SUBSYSTEM --type TYPE
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_processor-group_update-all.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_processor-group_update-all.html new file mode 100644 index 0000000000..a46c4b61fb --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_processor-group_update-all.html @@ -0,0 +1,82 @@ + + + + +endevor-bridge-for-git processor-group update-all + + +
+

zoweendevor-bridge-for-gitprocessor-groupupdate-all

+

Update the processor group of all changed elements of a specific type

+

Usage

+

zowe endevor-bridge-for-git processor-group update-all <processor-group> [options]

+

Positional Arguments

+
    +
  • +

    processor-group (string)

    +
      +
    • The name of the processor group you want to use
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping.

      +

      Default value: ./

      +
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys (string)

    +
      +
    • The Endevor system or alias of the system where your project resides.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub (string)

    +
      +
    • The Endevor subsystem or alias of the subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --type (string)

    +
      +
    • The type of the Endevor element
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_processor-group_update.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_processor-group_update.html new file mode 100644 index 0000000000..0ac5cbeb40 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_processor-group_update.html @@ -0,0 +1,88 @@ + + + + +endevor-bridge-for-git processor-group update + + +
+

zoweendevor-bridge-for-gitprocessor-groupupdate

+

Update the processor group of a specific element in your local repository

+

Usage

+

zowe endevor-bridge-for-git processor-group update <element> <processor-group> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • The name of the Endevor element that its processor group will be modified
    • +
    +
  • +
  • +

    processor-group (string)

    +
      +
    • The name of the processor group you want to use
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping.

      +

      Default value: ./

      +
    • +
    +
  • +
  • +

    --endevor-system | --endevorsys (string)

    +
      +
    • The Endevor system or alias of the system where your project resides.
    • +
    +
  • +
  • +

    --endevor-subsystem | --endevorsub (string)

    +
      +
    • The Endevor subsystem or alias of the subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --type (string)

    +
      +
    • The type of the Endevor element
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_work-area.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_work-area.html new file mode 100644 index 0000000000..583250d3a1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_work-area.html @@ -0,0 +1,22 @@ + + + + +endevor-bridge-for-git work-area + + +
+

zoweendevor-bridge-for-gitwork-area

+

Use an Endevor work area from the list defined by your administrator.

+

Usage

+

zowe endevor-bridge-for-git work-area <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_work-area_list.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_work-area_list.html new file mode 100644 index 0000000000..a855dfa40f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_work-area_list.html @@ -0,0 +1,79 @@ + + + + +endevor-bridge-for-git work-area list + + +
+

zoweendevor-bridge-for-gitwork-arealist

+

List Endevor work areas.

+

Usage

+

zowe endevor-bridge-for-git work-area list [work-area-id] [options]

+

Positional Arguments

+
    +
  • +

    work-area-id (string)

    +
      +
    • Specify to list only one Endevor work area ID. Name-masking is not allowed.
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping that you are building.

      +

      Default value: ./

      +
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show the details of all the work areas in the current working directory:

    +
      +
    • zowe endevor-bridge-for-git work-area list
    • +
    +
  • +
  • +

    Show the details of work area with ID "WORKAREA1":

    +
      +
    • zowe endevor-bridge-for-git work-area list WORKAREA1
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_work-area_reserve.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_work-area_reserve.html new file mode 100644 index 0000000000..abcd2a5caf --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_work-area_reserve.html @@ -0,0 +1,190 @@ + + + + +endevor-bridge-for-git work-area reserve + + +
+

zoweendevor-bridge-for-gitwork-areareserve

+

Reserve the first found available Endevor work area. When success, returns the reserved work area id

+

Usage

+

zowe endevor-bridge-for-git work-area reserve [work-area-id] [options]

+

Positional Arguments

+
    +
  • +

    work-area-id (string)

    +
      +
    • Reserve the Endevor work area with the ID specified. Name-masking is not allowed.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --endevor-instance | --endevori (string)

    +
      +
    • The Endevor Web Services Endevor configuration name.
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping that you are building.

      +

      Default value: ./

      +
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Reserve the first found available Endevor work area using an existing Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git work-area reserve --endevor-instance ENDEVOR
    • +
    +
  • +
  • +

    Reserve the work area with ID "WORKAREA1", if available, using an existing Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git work-area reserve WORKAREA1 --endevor-instance ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_work-area_unreserve.html b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_work-area_unreserve.html new file mode 100644 index 0000000000..b60dc57ef6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor-bridge-for-git_work-area_unreserve.html @@ -0,0 +1,184 @@ + + + + +endevor-bridge-for-git work-area unreserve + + +
+

zoweendevor-bridge-for-gitwork-areaunreserve

+

Unreserve an Endevor work area.

+

Usage

+

zowe endevor-bridge-for-git work-area unreserve <work-area-id> [options]

+

Positional Arguments

+
    +
  • +

    work-area-id (string)

    +
      +
    • Endevor work area ID. Name-masking is not allowed.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --endevor-instance | --endevori (string)

    +
      +
    • The Endevor Web Services Endevor configuration name.
    • +
    +
  • +
+

Options

+
    +
  • +

    --work-dir | --wd (string)

    +
      +
    • +

      The local working directory of your Git-Endevor mapping that you are building.

      +

      Default value: ./

      +
    • +
    +
  • +
+

Endevor options (alternatively use an 'endevor' profile)

+
    +
  • +

    --endevor-protocol | --endevorprot (string)

    +
      +
    • +

      The Endevor SCM Rest API protocol.

      +

      Default value: http

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --endevor-host | --endevorh (string)

    +
      +
    • The Endevor Rest API hostname.
    • +
    +
  • +
  • +

    --endevor-port | --endevorp (number)

    +
      +
    • The Endevor Rest API port.
    • +
    +
  • +
  • +

    --endevor-user | --endevoru (string)

    +
      +
    • Mainframe (Endevor) username, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --endevor-password | --endevorpass | --endevorpw (string)

    +
      +
    • Mainframe (Endevor) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --endevor-reject-unauthorized | --endevorru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --endevor-base-path | --endevorbp (string)

    +
      +
    • +

      The Endevor SCM Rest API base path.

      +

      Default value: EndevorService/rest

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Unreserve work area with id "WORKAREA1" using an existing Endevor profile:

    +
      +
    • zowe endevor-bridge-for-git work-area unreserve WORKAREA1 --endevor-instance ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor.html b/static/v2.15.x/web_help/docs/zowe_endevor.html new file mode 100644 index 0000000000..e5c69dc16d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor.html @@ -0,0 +1,47 @@ + + + + +endevor + + +
+

zoweendevor

+

Endevor plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.

+

Usage

+

zowe endevor <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • add - Add an Element into Endevor.
  • +
  • approve | aprv - Approve a Package in Endevor.
  • +
  • backin - Backin a Package in Endevor.
  • +
  • backout - Backout a Package in Endevor.
  • +
  • cast - Cast a Package in Endevor.
  • +
  • check - Endevor Web Services Health Check.
  • +
  • commit - Commit a Package in Endevor.
  • +
  • confirm | conf - Confirm a manual conflict resolution inside an Endevor workspace file is complete.
  • +
  • create - Create a Package in Endevor.
  • +
  • delete | del - Delete an Element or a Package in Endevor.
  • +
  • deny - Deny a Package in Endevor.
  • +
  • execute - Execute a Package in Endevor.
  • +
  • generate | gen - Generate an Element in Endevor.
  • +
  • initialize | init - Initialize a directory as an Endevor workspace.
  • +
  • list - List instances, elements, types, packages and inventory locations in Endevor.
  • +
  • merge | mrg - Merge Endevor elements from one Endevor location into another
  • +
  • move | mv - Move an Element in Endevor.
  • +
  • print | p - Print an Element or a Component in Endevor.
  • +
  • queryacm - Query Elements and information about their components in Endevor.
  • +
  • reset - Reset a Package in Endevor.
  • +
  • retrieve | ret - Retrieve an Element in Endevor.
  • +
  • signin | si - Signin an Element in Endevor.
  • +
  • submit - Submit a Package or a SCL file in Endevor.
  • +
  • synchronize | sync - Synchronize remote Endevor inventory with the local Endevor workspace.
  • +
  • transfer | tr - Transfer an Element in Endevor.
  • +
  • unsynchronize | unsync - Remove a synchronized Endevor inventory from a local Endevor workspace and delete any related metadata.
  • +
  • update - Update an Element or a Package in Endevor.
  • +
  • view - View an Element or a Package SCL in Endevor.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_add.html b/static/v2.15.x/web_help/docs/zowe_endevor_add.html new file mode 100644 index 0000000000..22bad5f0dd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_add.html @@ -0,0 +1,20 @@ + + + + +endevor add + + +
+

zoweendevoradd

+

Add an Element into Endevor.

+

Usage

+

zowe endevor add <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • element | elem | ele - The add element command lets you add an Element to an Environment entry Stage in Endevor.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_add_element.html b/static/v2.15.x/web_help/docs/zowe_endevor_add_element.html new file mode 100644 index 0000000000..d1f4909c1d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_add_element.html @@ -0,0 +1,295 @@ + + + + +endevor add element + + +
+

zoweendevoraddelement

+

The add element command lets you add an Element to an Environment entry Stage in Endevor.

+

Usage

+

zowe endevor add element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-file | --ff (string)

    +
      +
    • Use this input to provide source file.
    • +
    +
  • +
  • +

    --from-dataset | --fd (string)

    +
      +
    • Use this input to provide source data set name.
    • +
    +
  • +
  • +

    --from-member | --fm (string)

    +
      +
    • Use this input to provide source member name in the data set.
    • +
    +
  • +
  • +

    --from-path | --fp (string)

    +
      +
    • Use this input to provide the path of source USS file. It must be used with from-uss-file.
    • +
    +
  • +
  • +

    --from-uss-file | --fuf (string)

    +
      +
    • Use this input to provide source USS file name. It must be used with from-path
    • +
    +
  • +
+

options

+
    +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --new-version | --nv (number)

    +
      +
    • Assign a different version number to the Element.
    • +
    +
  • +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --generate | -g (boolean)

    +
      +
    • Specifies if you want to Generate Element after Add/Update action.
    • +
    +
  • +
  • +

    --get-fingerprint | --gfg (boolean)

    +
      +
    • +

      Return fingerprint of a retrieved, added or updated element as the first line of the response.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --fingerprint | --fg (string)

    +
      +
    • Specifies the fingerprint of the element to Add or Update. Use value 'NEW' when adding a new element that shouldn't exist in the map yet.
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Add element from local file with endevor profile set up:

    +
      +
    • zowe endevor add element elementName --env ENV --sys SYS --sub SUB --typ TYPE --ff localfile.txt -i ENDEVOR --ccid CCID --comment 'adding element'
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_approve.html b/static/v2.15.x/web_help/docs/zowe_endevor_approve.html new file mode 100644 index 0000000000..f26fda84b5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_approve.html @@ -0,0 +1,20 @@ + + + + +endevor approve + + +
+

zoweendevorapprove

+

Approve a Package in Endevor.

+

Usage

+

zowe endevor approve <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • package | pkg - The approve package command approves Package in Endevor for execution.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_approve_package.html b/static/v2.15.x/web_help/docs/zowe_endevor_approve_package.html new file mode 100644 index 0000000000..81b45f7542 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_approve_package.html @@ -0,0 +1,199 @@ + + + + +endevor approve package + + +
+

zoweendevorapprovepackage

+

The approve package command approves Package in Endevor for execution.

+

Usage

+

zowe endevor approve package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --notes | -n (string)

    +
      +
    • Notes for package.
    • +
    +
  • +
  • +

    --notes-from-file | --nff (string)

    +
      +
    • Local file of notes for package.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Approve package with endevor profile set up, specifying approval notes:

    +
      +
    • zowe endevor approve package packageName -n "notes" -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_backin.html b/static/v2.15.x/web_help/docs/zowe_endevor_backin.html new file mode 100644 index 0000000000..9b8fca7c67 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_backin.html @@ -0,0 +1,20 @@ + + + + +endevor backin + + +
+

zoweendevorbackin

+

Backin a Package in Endevor.

+

Usage

+

zowe endevor backin <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • package | pkg - The backin package command reverses the backout action and returns the Package to a status of Executed.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_backin_package.html b/static/v2.15.x/web_help/docs/zowe_endevor_backin_package.html new file mode 100644 index 0000000000..421eaa40ff --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_backin_package.html @@ -0,0 +1,199 @@ + + + + +endevor backin package + + +
+

zoweendevorbackinpackage

+

The backin package command reverses the backout action and returns the Package to a status of Executed.

+

Usage

+

zowe endevor backin package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --statement | --stmn (number)

    +
      +
    • Specify the SCL statement number for the Element action that you want to back in or back out.
    • +
    +
  • +
  • +

    --element | --elm (string)

    +
      +
    • Specify the Element name for the Element action that you want to back in or back out.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Backin package with endevor profile set up:

    +
      +
    • zowe endevor backin package packageName -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_backout.html b/static/v2.15.x/web_help/docs/zowe_endevor_backout.html new file mode 100644 index 0000000000..e6709f172f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_backout.html @@ -0,0 +1,20 @@ + + + + +endevor backout + + +
+

zoweendevorbackout

+

Backout a Package in Endevor.

+

Usage

+

zowe endevor backout <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • package | pkg - The backout package command restores the executable and output modules of the Package to the status they were in before execution.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_backout_package.html b/static/v2.15.x/web_help/docs/zowe_endevor_backout_package.html new file mode 100644 index 0000000000..56181a10e2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_backout_package.html @@ -0,0 +1,199 @@ + + + + +endevor backout package + + +
+

zoweendevorbackoutpackage

+

The backout package command restores the executable and output modules of the Package to the status they were in before execution.

+

Usage

+

zowe endevor backout package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --statement | --stmn (number)

    +
      +
    • Specify the SCL statement number for the Element action that you want to back in or back out.
    • +
    +
  • +
  • +

    --element | --elm (string)

    +
      +
    • Specify the Element name for the Element action that you want to back in or back out.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Backout package with endevor profile set up:

    +
      +
    • zowe endevor backout package packageName -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_cast.html b/static/v2.15.x/web_help/docs/zowe_endevor_cast.html new file mode 100644 index 0000000000..d16a2d39d3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_cast.html @@ -0,0 +1,20 @@ + + + + +endevor cast + + +
+

zoweendevorcast

+

Cast a Package in Endevor.

+

Usage

+

zowe endevor cast <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • package | pkg - The cast package command prepares the Package for review and subsequent execution. Casting a Package freezes the contents of the Package and prevents further changes to the Package.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_cast_package.html b/static/v2.15.x/web_help/docs/zowe_endevor_cast_package.html new file mode 100644 index 0000000000..a7ddaaf11b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_cast_package.html @@ -0,0 +1,217 @@ + + + + +endevor cast package + + +
+

zoweendevorcastpackage

+

The cast package command prepares the Package for review and subsequent execution. Casting a Package freezes the contents of the Package and prevents further changes to the Package.

+

Usage

+

zowe endevor cast package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --from-date-time | --fdt (string)

    +
      +
    • Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --to-date-time | --tdt (string)

    +
      +
    • Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --validate-components | --vc (string)

    +
      +
    • +

      Specify "yes" to enable component validation within the package, "no" to disable, and "warn" to generate a warning if component validation fails.

      +

      Allowed values: yes, no, warn

      +
    • +
    +
  • +
  • +

    --backout (boolean)

    +
      +
    • +

      Set this option to false (or specify --no-backout) if you don't want to have the backout facility available for this package. By default backout is enabled.

      +

      Default value: true

      +
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Cast package with endevor profile set up, changing the execution window of the Package:

    +
      +
    • zowe endevor cast package packageName --fdt 2018-01-01T00:00 --tdt 2018-12-31T12:00 -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_check.html b/static/v2.15.x/web_help/docs/zowe_endevor_check.html new file mode 100644 index 0000000000..497cf13695 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_check.html @@ -0,0 +1,20 @@ + + + + +endevor check + + +
+

zoweendevorcheck

+

Endevor Web Services Health Check.

+

Usage

+

zowe endevor check <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • instance - The check instance command triggers the web services health check for a given instance.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_check_instance.html b/static/v2.15.x/web_help/docs/zowe_endevor_check_instance.html new file mode 100644 index 0000000000..8e1690c94e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_check_instance.html @@ -0,0 +1,166 @@ + + + + +endevor check instance + + +
+

zoweendevorcheckinstance

+

The check instance command triggers the web services health check for a given instance.

+

Usage

+

zowe endevor check instance [instance] [options]

+

Positional Arguments

+
    +
  • +

    instance (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Perform health check of Endevor Web Services instance ENDEVOR:

    +
      +
    • zowe endevor check instance ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_commit.html b/static/v2.15.x/web_help/docs/zowe_endevor_commit.html new file mode 100644 index 0000000000..065b66b056 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_commit.html @@ -0,0 +1,20 @@ + + + + +endevor commit + + +
+

zoweendevorcommit

+

Commit a Package in Endevor.

+

Usage

+

zowe endevor commit <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • package | pkg - The commit package command commits a Package, which removes all backout/backin data while retaining Package event information.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_commit_package.html b/static/v2.15.x/web_help/docs/zowe_endevor_commit_package.html new file mode 100644 index 0000000000..28b242cb9d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_commit_package.html @@ -0,0 +1,199 @@ + + + + +endevor commit package + + +
+

zoweendevorcommitpackage

+

The commit package command commits a Package, which removes all backout/backin data while retaining Package event information.

+

Usage

+

zowe endevor commit package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --older-than | --ot (number)

    +
      +
    • Specify the minimum age of the package.
    • +
    +
  • +
  • +

    --delete-promotion-history | --dph (boolean)

    +
      +
    • Specifies whether you want to delete all promotion history associated with previous versions of the Package
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Commit package with endevor profile set up, specifying deletion of all promotion history:

    +
      +
    • zowe endevor commit package packageName --delete-promotion-history -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_confirm.html b/static/v2.15.x/web_help/docs/zowe_endevor_confirm.html new file mode 100644 index 0000000000..45642794ef --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_confirm.html @@ -0,0 +1,20 @@ + + + + +endevor confirm + + +
+

zoweendevorconfirm

+

Confirm a manual conflict resolution inside an Endevor workspace file is complete.

+

Usage

+

zowe endevor confirm <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • resolution | res - Confirm a manual conflict resolution inside an Endevor workspace file is complete.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_confirm_resolution.html b/static/v2.15.x/web_help/docs/zowe_endevor_confirm_resolution.html new file mode 100644 index 0000000000..a9a2622dfa --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_confirm_resolution.html @@ -0,0 +1,114 @@ + + + + +endevor confirm resolution + + +
+

zoweendevorconfirmresolution

+

Confirm a manual conflict resolution inside an Endevor workspace file is complete.

+

Usage

+

zowe endevor confirm resolution [workspace-file] [options]

+

Positional Arguments

+
    +
  • +

    workspace-file (string)

    +
      +
    • An Endevor workspace file (full or relative path).
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Confirm a manual conflict resolution has been finished for file 'filename':

    +
      +
    • zowe endevor confirm resolution filename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_create.html b/static/v2.15.x/web_help/docs/zowe_endevor_create.html new file mode 100644 index 0000000000..e6e0450056 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_create.html @@ -0,0 +1,20 @@ + + + + +endevor create + + +
+

zoweendevorcreate

+

Create a Package in Endevor.

+

Usage

+

zowe endevor create <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • package | pkg - The create package command lets you create a package in Endevor.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_create_package.html b/static/v2.15.x/web_help/docs/zowe_endevor_create_package.html new file mode 100644 index 0000000000..e1959b591a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_create_package.html @@ -0,0 +1,277 @@ + + + + +endevor create package + + +
+

zoweendevorcreatepackage

+

The create package command lets you create a package in Endevor.

+

Usage

+

zowe endevor create package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-file | --ff (string)

    +
      +
    • Use this input to provide source file.
    • +
    +
  • +
  • +

    --from-dataset | --fd (string)

    +
      +
    • Use this input to provide source data set name.
    • +
    +
  • +
  • +

    --from-member | --fm (string)

    +
      +
    • Use this input to provide source member name in the data set.
    • +
    +
  • +
  • +

    --from-package | --fp (string)

    +
      +
    • Directs the Create/Update action to copy the SCL from the package you specify into the package you are creating or updating.
    • +
    +
  • +
  • +

    --from-text | --ft (string)

    +
      +
    • Provides a string to use as input SCL.
    • +
    +
  • +
+

options

+
    +
  • +

    --description | -d (string)

    +
      +
    • Allows you to associate a 50-character description when creating or updating package.
    • +
    +
  • +
  • +

    --from-date-time | --fdt (string)

    +
      +
    • Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --to-date-time | --tdt (string)

    +
      +
    • Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --backout (boolean)

    +
      +
    • +

      Set this option to false (or specify --no-backout) if you don't want to have the backout facility available for this package. By default backout is enabled.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --notes | -n (string)

    +
      +
    • Notes for package.
    • +
    +
  • +
  • +

    --notes-from-file | --nff (string)

    +
      +
    • Local file of notes for package.
    • +
    +
  • +
  • +

    --emergency-package | --ep (boolean)

    +
      +
    • Specify if the package should be an emergency package. When not specified, the package is a standard package.
    • +
    +
  • +
  • +

    --sharable | --sh (boolean)

    +
      +
    • Specify this option if the package can be edited by more than one person when in In-edit status.
    • +
    +
  • +
  • +

    --promotion | --pr (boolean)

    +
      +
    • Specify this option to define the package as a promotion package.
    • +
    +
  • +
  • +

    --validate-scl | --vs (boolean)

    +
      +
    • +

      Set this option to false (or specify --no-validate-scl) to skip validion of the package components while creating a package. By default the SCL is validated

      +

      Default value: true

      +
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create package from local file with endevor profile set up:

    +
      +
    • zowe endevor create package packageName -d "package description" --ff localfile.txt -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_delete.html b/static/v2.15.x/web_help/docs/zowe_endevor_delete.html new file mode 100644 index 0000000000..1d6c05c328 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_delete.html @@ -0,0 +1,21 @@ + + + + +endevor delete + + +
+

zoweendevordelete

+

Delete an Element or a Package in Endevor.

+

Usage

+

zowe endevor delete <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • element | elem | ele - The delete element command deletes an Element from the specified inventory location in Endevor.
  • +
  • package | pkg - The delete package command lets you delete Packages of any status type in Endevor.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_delete_element.html b/static/v2.15.x/web_help/docs/zowe_endevor_delete_element.html new file mode 100644 index 0000000000..867478965b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_delete_element.html @@ -0,0 +1,278 @@ + + + + +endevor delete element + + +
+

zoweendevordeleteelement

+

The delete element command deletes an Element from the specified inventory location in Endevor.

+

Usage

+

zowe endevor delete element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --only-components | --oc (boolean)

    +
      +
    • Applicable for Endevor ACM users only. Indicates whether you want to delete both the Element component list and the Element, or the Element component list only. "No" is the default option
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete element with endevor profile set up:

    +
      +
    • zowe endevor delete element elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_delete_package.html b/static/v2.15.x/web_help/docs/zowe_endevor_delete_package.html new file mode 100644 index 0000000000..5d87ed636c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_delete_package.html @@ -0,0 +1,203 @@ + + + + +endevor delete package + + +
+

zoweendevordeletepackage

+

The delete package command lets you delete Packages of any status type in Endevor.

+

Usage

+

zowe endevor delete package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --status | --st (string)

    +
      +
    • +

      Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
      +It is possible to specify multiple status separated by "," during list and delete package.

      +

      Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED

      +
    • +
    +
  • +
  • +

    --older-than | --ot (number)

    +
      +
    • Specify the minimum age of the package.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete package with endevor profile set up:

    +
      +
    • zowe endevor delete package packageName -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_deny.html b/static/v2.15.x/web_help/docs/zowe_endevor_deny.html new file mode 100644 index 0000000000..74fbc596cc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_deny.html @@ -0,0 +1,20 @@ + + + + +endevor deny + + +
+

zoweendevordeny

+

Deny a Package in Endevor.

+

Usage

+

zowe endevor deny <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • package | pkg - The deny package command changes the status of a Package to Denied.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_deny_package.html b/static/v2.15.x/web_help/docs/zowe_endevor_deny_package.html new file mode 100644 index 0000000000..63ac4e0ef2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_deny_package.html @@ -0,0 +1,199 @@ + + + + +endevor deny package + + +
+

zoweendevordenypackage

+

The deny package command changes the status of a Package to Denied.

+

Usage

+

zowe endevor deny package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --notes | -n (string)

    +
      +
    • Notes for package.
    • +
    +
  • +
  • +

    --notes-from-file | --nff (string)

    +
      +
    • Local file of notes for package.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deny package with endevor profile set up, specifying denial notes:

    +
      +
    • zowe endevor deny package packageName -n "notes" -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_execute.html b/static/v2.15.x/web_help/docs/zowe_endevor_execute.html new file mode 100644 index 0000000000..7b5aeff50e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_execute.html @@ -0,0 +1,20 @@ + + + + +endevor execute + + +
+

zoweendevorexecute

+

Execute a Package in Endevor.

+

Usage

+

zowe endevor execute <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • package | pkg - The execute package command executes a Package that have a status of Approved or Execfailed.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_execute_package.html b/static/v2.15.x/web_help/docs/zowe_endevor_execute_package.html new file mode 100644 index 0000000000..7e971fedd9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_execute_package.html @@ -0,0 +1,209 @@ + + + + +endevor execute package + + +
+

zoweendevorexecutepackage

+

The execute package command executes a Package that have a status of Approved or Execfailed.

+

Usage

+

zowe endevor execute package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --from-date-time | --fdt (string)

    +
      +
    • Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --to-date-time | --tdt (string)

    +
      +
    • Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --status | --st (string)

    +
      +
    • +

      Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
      +It is possible to specify multiple status separated by "," during list and delete package.

      +

      Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED

      +
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Execute package with endevor profile set up, specifying the time frame within which to execute the Package:

    +
      +
    • zowe endevor execute package packageName --fdt 2018-01-01T00:00 --tdt 2018-12-31T12:00 -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_generate.html b/static/v2.15.x/web_help/docs/zowe_endevor_generate.html new file mode 100644 index 0000000000..a0678e5008 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_generate.html @@ -0,0 +1,20 @@ + + + + +endevor generate + + +
+

zoweendevorgenerate

+

Generate an Element in Endevor.

+

Usage

+

zowe endevor generate <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • element | elem | ele - The generate element command executes the generate Processor for the current level of the Element.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_generate_element.html b/static/v2.15.x/web_help/docs/zowe_endevor_generate_element.html new file mode 100644 index 0000000000..5104604427 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_generate_element.html @@ -0,0 +1,290 @@ + + + + +endevor generate element + + +
+

zoweendevorgenerateelement

+

The generate element command executes the generate Processor for the current level of the Element.

+

Usage

+

zowe endevor generate element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --copy-back | --cb (boolean)

    +
      +
    • Specify if you want to copy the current level of the Element back to the FROM Stage, then perform this action. Do not use with --nosource option.
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --nosource | --ns (boolean)

    +
      +
    • Specify if you want to have source-less Element. Do not use with --copy-back option.
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Generate an element with endevor profile set up, specifying option Copyback:

    +
      +
    • zowe endevor generate element elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE --cb -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_initialize.html b/static/v2.15.x/web_help/docs/zowe_endevor_initialize.html new file mode 100644 index 0000000000..805d07c2ce --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_initialize.html @@ -0,0 +1,20 @@ + + + + +endevor initialize + + +
+

zoweendevorinitialize

+

Initialize a directory as an Endevor workspace.

+

Usage

+

zowe endevor initialize <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • workspace | wsp - Initialize current directory as an Endevor workspace.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_initialize_workspace.html b/static/v2.15.x/web_help/docs/zowe_endevor_initialize_workspace.html new file mode 100644 index 0000000000..43858eca36 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_initialize_workspace.html @@ -0,0 +1,120 @@ + + + + +endevor initialize workspace + + +
+

zoweendevorinitializeworkspace

+

Initialize current directory as an Endevor workspace.

+

Usage

+

zowe endevor initialize workspace [workspace-dir] [options]

+

Positional Arguments

+
    +
  • +

    workspace-dir (string)

    +
      +
    • The Endevor workspace directory, if different from current working directory.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    initialize current directory as an Endevor workspace:

    +
      +
    • zowe endevor initialize workspace
    • +
    +
  • +
  • +

    initialize 'myWorkspace' directory as an Endevor workspace:

    +
      +
    • zowe endevor initialize workspace 'myWorkspace'
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list.html b/static/v2.15.x/web_help/docs/zowe_endevor_list.html new file mode 100644 index 0000000000..01dcb6585b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list.html @@ -0,0 +1,38 @@ + + + + +endevor list + + +
+

zoweendevorlist

+

List instances, elements, types, packages and inventory locations in Endevor.

+

Usage

+

zowe endevor list <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_code-page-config.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_code-page-config.html new file mode 100644 index 0000000000..e0e2786738 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_code-page-config.html @@ -0,0 +1,234 @@ + + + + +endevor list code-page-config + + +
+

zoweendevorlistcode-page-config

+

The list code-page-config command lists the EBCDIC code page mapping rules used by Endevor Web Services

+

Usage

+

zowe endevor list code-page-config [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List codepage-config with session specified:

    +
      +
    • zowe endevor list code-page-config --host hostName --port 8080
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_defaults.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_defaults.html new file mode 100644 index 0000000000..401e46b1f9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_defaults.html @@ -0,0 +1,234 @@ + + + + +endevor list defaults + + +
+

zoweendevorlistdefaults

+

List the contents of the main Endevor configuration table (C1DEFLTS)

+

Usage

+

zowe endevor list defaults [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the contents of the main Endevor configuration table (C1DEFLTS):

    +
      +
    • zowe endevor list defaults
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_dialog.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_dialog.html new file mode 100644 index 0000000000..198558b90d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_dialog.html @@ -0,0 +1,234 @@ + + + + +endevor list dialog + + +
+

zoweendevorlistdialog

+

List the contents of the Endevor ISPF dialog defaults table (ENDIECFG)

+

Usage

+

zowe endevor list dialog [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the contents of the Endevor ISPF dialog defaults table (ENDIECFG):

    +
      +
    • zowe endevor list dialog
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_elements.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_elements.html new file mode 100644 index 0000000000..645ec02eee --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_elements.html @@ -0,0 +1,438 @@ + + + + +endevor list elements + + +
+

zoweendevorlistelements

+

The list elements command lists element information in Endevor

+

Usage

+

zowe endevor list elements [element] [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --data | --dat (string)

    +
      +
    • +

      Allows to select the type of summary data returned in the element list:
      +ALL - Full element information
      +BAS - Basic element information
      +ELE - Element change level summary
      +COMP - Component change level summary

      +

      When data=ALL --fo (full-output) always takes place unless there is a --rff (response-format-filter).
      +In all other cases default set of columns will be shown.

      +

      Allowed values: all, bas, ele, comp

      +
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-generate | --wcg (string)

    +
      +
    • Instructs Endevor to search using the generate CCID associated with an Element.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-lastact | --wcla (string)

    +
      +
    • Instructs Endevor to search using the last action CCID associated with an Element.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-lastlvl | --wcll (string)

    +
      +
    • Instructs Endevor to search using the last level CCID associated with an Element.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-change | --wcchg (string)

    +
      +
    • This option is only valid when the data option is ele or comp. Instructs Endevor to filter the results of the list data summary function that is based on the specified ccids.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-type | --wpt (string)

    +
      +
    • +

      Lets you select Elements according to a specified Processor type.

      +

      Allowed values: GEN, GENERATE, MOV, MOVE, DEL, DELETE

      +
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
+

endevor search text options

+
    +
  • +

    --search-text | --stext (string)

    +
      +
    • Search string(s) separated with AND or OR. E.g.: string_1 AND string_2 AND string_3 OR string_4.
      +For complex search strings with quotation marks use search-text-file parameter.
    • +
    +
  • +
  • +

    --search-text-file | --stf (string)

    +
      +
    • File which contains search string(s) separated with AND or OR. Recommended for complex search strings with quotation marks.
    • +
    +
  • +
  • +

    --search-in | --si (string)

    +
      +
    • +

      2 letters describing where search should be performed:
      +es - Element Source
      +eh - Element History
      +ec - Element Changes
      +eu - Element Summary
      +cs - Components Source
      +ch - Components History
      +cc - Components Changes
      +cu - Components Summary.

      +

      Allowed values: es, eh, ec, eu, cs, ch, cc, cu

      +
    • +
    +
  • +
  • +

    --search-from | --sf (number)

    +
      +
    • Beginning interval of the column range for the search-text.
    • +
    +
  • +
  • +

    --search-to | --st (number)

    +
      +
    • Ending interval of the column range for the search-text.
    • +
    +
  • +
  • +

    --search-ignore-case | --ic (boolean)

    +
      +
    • Ignore search case.
    • +
    +
  • +
  • +

    --search-in-binary | --bin (boolean)

    +
      +
    • Should the text search be performed in binary elements.
    • +
    +
  • +
  • +

    --search-limit | --sl (number)

    +
      +
    • Maximum search limit where 0 is NOLIMIT.
    • +
    +
  • +
+

scl generation options

+
    +
  • +

    --to-package | --tp (string)

    +
      +
    • Specifies the package to which the SCL has to be appended. This option requires scl-action
    • +
    +
  • +
  • +

    --scl-action | --sa (string)

    +
      +
    • +

      Specifies the action for the SCL that has to be built.

      +

      Allowed values: GENERATE, MOVE

      +
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List elements in Endevor from the specified inventory location with the endevor profile set up:

    +
      +
    • zowe endevor list elements -i ENDEVOR --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ TYPENAME
    • +
    +
  • +
  • +

    List elements in Endevor using search text string:

    +
      +
    • zowe endevor list elements --stext "first or second and third"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_environments.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_environments.html new file mode 100644 index 0000000000..f4ae1c2728 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_environments.html @@ -0,0 +1,245 @@ + + + + +endevor list environments + + +
+

zoweendevorlistenvironments

+

The list environments command lists environments in Endevor

+

Usage

+

zowe endevor list environments [environment] [options]

+

Positional Arguments

+
    +
  • +

    environment (string)

    +
      +
    • Name of the Endevor environment.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all environments in Endevor with endevor profile set up:

    +
      +
    • zowe endevor list environments -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_features.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_features.html new file mode 100644 index 0000000000..912b853e6d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_features.html @@ -0,0 +1,234 @@ + + + + +endevor list features + + +
+

zoweendevorlistfeatures

+

List the contents of the Endevor optional features table (ENCOPTBL)

+

Usage

+

zowe endevor list features [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the contents of the Endevor optional features table (ENCOPTBL):

    +
      +
    • zowe endevor list features
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_instances.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_instances.html new file mode 100644 index 0000000000..6a3cb308e4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_instances.html @@ -0,0 +1,158 @@ + + + + +endevor list instances + + +
+

zoweendevorlistinstances

+

The list instances command lists instances used by Endevor Web Services

+

Usage

+

zowe endevor list instances [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List instances with session specified:

    +
      +
    • zowe endevor list instances --host hostName --port 8080
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_packages.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_packages.html new file mode 100644 index 0000000000..60dab5e2a4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_packages.html @@ -0,0 +1,273 @@ + + + + +endevor list packages + + +
+

zoweendevorlistpackages

+

The list packages command lists package information in Endevor

+

Usage

+

zowe endevor list packages [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

options

+
    +
  • +

    --status | --st (string)

    +
      +
    • +

      Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
      +It is possible to specify multiple status separated by "," during list and delete package.

      +

      Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED

      +
    • +
    +
  • +
  • +

    --emergency-package | --ep (boolean)

    +
      +
    • Specify if the package should be an emergency package. When not specified, the package is a standard package.
    • +
    +
  • +
  • +

    --enterprise | --ent (string)

    +
      +
    • +

      Specify to filter the list by enterprise Package parameter. A - All, E - Enterprise, X - eXclude.

      +

      Allowed values: A, E, X

      +
    • +
    +
  • +
  • +

    --promotion-status | --ps (string)

    +
      +
    • +

      Specify to filter the list by promotion Package parameter. A - All, P - Promotion, X - eXclude.

      +

      Allowed values: A, P, X

      +
    • +
    +
  • +
  • +

    --prom-target-env | --pte (string)

    +
      +
    • Promotion target environment. Specifies the promotion package target environment. This field only applies to promotion packages and can only be specified when the promotion package type is A or P.
    • +
    +
  • +
  • +

    --prom-target-stgID | --pts (string)

    +
      +
    • Promotion target stage ID. Specifies the promotion package target stage ID. This field only applies to promotion packages and can only be specified when the promotion package type is A or P.
    • +
    +
  • +
  • +

    --approver | --apr (string)

    +
      +
    • Specifies a one to eight character approver ID. Only one approver ID can be specified and name masking is not supported.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all packages in Endevor with endevor profile set up:

    +
      +
    • zowe endevor list packages -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_processor-groups.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_processor-groups.html new file mode 100644 index 0000000000..331977c0bd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_processor-groups.html @@ -0,0 +1,272 @@ + + + + +endevor list processor-groups + + +
+

zoweendevorlistprocessor-groups

+

The list processor-groups command lists processor group information in Endevor

+

Usage

+

zowe endevor list processor-groups [proc-group] [options]

+

Positional Arguments

+
    +
  • +

    proc-group (string)

    +
      +
    • Name of the Endevor processor group
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List processor groups for type TYPENAME with endevor profile set up:

    +
      +
    • zowe endevor list processor-groups --type TYPENAME --env ENVNAME --sn 1 --sys SYSNAME -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_processor-symbols.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_processor-symbols.html new file mode 100644 index 0000000000..94d335c17b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_processor-symbols.html @@ -0,0 +1,272 @@ + + + + +endevor list processor-symbols + + +
+

zoweendevorlistprocessor-symbols

+

The list processor-symbols command lists processor group symbol overrides information in Endevor

+

Usage

+

zowe endevor list processor-symbols [proc-group] [options]

+

Positional Arguments

+
    +
  • +

    proc-group (string)

    +
      +
    • Name of the Endevor processor group
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all processor symbols for group PROCGROUP with endevor profile set up:

    +
      +
    • zowe endevor list processor-symbols PROCGROUP --env ENVNAME --sn 1 --sys SYSNAME --typ TYPENAME -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_stages.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_stages.html new file mode 100644 index 0000000000..231dc58d01 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_stages.html @@ -0,0 +1,251 @@ + + + + +endevor list stages + + +
+

zoweendevorliststages

+

The list stages command lists stages in Endevor

+

Usage

+

zowe endevor list stages [stage] [options]

+

Positional Arguments

+
    +
  • +

    stage (string)

    +
      +
    • Name of the Endevor stage
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all stages in Endevor with endevor profile set up:

    +
      +
    • zowe endevor list stages -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_subsystems.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_subsystems.html new file mode 100644 index 0000000000..95e76a20f7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_subsystems.html @@ -0,0 +1,266 @@ + + + + +endevor list subsystems + + +
+

zoweendevorlistsubsystems

+

The list subsystems command lists subsystem information in Endevor

+

Usage

+

zowe endevor list subsystems [subsystem] [options]

+

Positional Arguments

+
    +
  • +

    subsystem (string)

    +
      +
    • Name of the Endevor subsystem
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all subsystems in Endevor with endevor profile set up:

    +
      +
    • zowe endevor list subsystems -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_symbols.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_symbols.html new file mode 100644 index 0000000000..669c09c0fd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_symbols.html @@ -0,0 +1,234 @@ + + + + +endevor list symbols + + +
+

zoweendevorlistsymbols

+

List the Endevor site symbols

+

Usage

+

zowe endevor list symbols [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the Endevor site symbols:

    +
      +
    • zowe endevor list symbols
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_systems.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_systems.html new file mode 100644 index 0000000000..c8b04855df --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_systems.html @@ -0,0 +1,260 @@ + + + + +endevor list systems + + +
+

zoweendevorlistsystems

+

The list systems command lists system information in Endevor

+

Usage

+

zowe endevor list systems [system] [options]

+

Positional Arguments

+
    +
  • +

    system (string)

    +
      +
    • Name of the Endevor system
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all systems in Endevor with endevor profile set up:

    +
      +
    • zowe endevor list systems -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_tasks.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_tasks.html new file mode 100644 index 0000000000..8295fa978a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_tasks.html @@ -0,0 +1,219 @@ + + + + +endevor list tasks + + +
+

zoweendevorlisttasks

+

List asynchronous tasks submitted by this user

+

Usage

+

zowe endevor list tasks [task-id] [options]

+

Positional Arguments

+
    +
  • +

    task-id (string)

    +
      +
    • The id of an asynchronous Endevor web service task.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --task-status (string)

    +
      +
    • +

      Filter tasks by status: in-progress, finished or all.

      +

      Default value: all
      +Allowed values: inp, fin, all

      +
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all finished tasks:

    +
      +
    • zowe endevor list tasks --task-status fin
    • +
    +
  • +
  • +

    List a specific task to verify its completion status:

    +
      +
    • zowe endevor list tasks 2789102296850204364
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_type-sequence.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_type-sequence.html new file mode 100644 index 0000000000..32d4374c46 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_type-sequence.html @@ -0,0 +1,234 @@ + + + + +endevor list type-sequence + + +
+

zoweendevorlisttype-sequence

+

List the contents of the Endevor type sequence

+

Usage

+

zowe endevor list type-sequence [options]

+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the contents of the Endevor type sequence:

    +
      +
    • zowe endevor list type-sequence
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_list_types.html b/static/v2.15.x/web_help/docs/zowe_endevor_list_types.html new file mode 100644 index 0000000000..783a58c70a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_list_types.html @@ -0,0 +1,266 @@ + + + + +endevor list types + + +
+

zoweendevorlisttypes

+

The list types command lists type information in Endevor

+

Usage

+

zowe endevor list types [type] [options]

+

Positional Arguments

+
    +
  • +

    type (string)

    +
      +
    • Name of the Endevor type
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --path | --pa (string)

    +
      +
    • +

      Specifies a PHYsical or LOGical path.

      +

      Allowed values: log, phy

      +
    • +
    +
  • +
  • +

    --return | --ret (string)

    +
      +
    • +

      Sets mapping options for returned results: return FIRst match or ALL matching results.

      +

      Allowed values: fir, all

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all types in Endevor with endevor profile set up:

    +
      +
    • zowe endevor list types -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_merge.html b/static/v2.15.x/web_help/docs/zowe_endevor_merge.html new file mode 100644 index 0000000000..262de54ec2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_merge.html @@ -0,0 +1,20 @@ + + + + +endevor merge + + +
+

zoweendevormerge

+

Merge Endevor elements from one Endevor location into another

+

Usage

+

zowe endevor merge <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • element | ele - Merge Endevor elements from one Endevor location into another. Requires an initialized Endevor workspace to perform conflict resolution. Use "synchronize workspace" command afterwards to push the result back into Endevor.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_merge_element.html b/static/v2.15.x/web_help/docs/zowe_endevor_merge_element.html new file mode 100644 index 0000000000..8845a7e260 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_merge_element.html @@ -0,0 +1,283 @@ + + + + +endevor merge element + + +
+

zoweendevormergeelement

+

Merge Endevor elements from one Endevor location into another. Requires an initialized Endevor workspace to perform conflict resolution. Use "synchronize workspace" command afterwards to push the result back into Endevor.

+

Usage

+

zowe endevor merge element [element] [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

merge-location definition options

+
    +
  • +

    --merge-environment | --menv (string)

    +
      +
    • Merge elements from this environment to the target environment (specified by 'environment'). Defaults to the same environment as the target.
    • +
    +
  • +
  • +

    --merge-stage-number | --msn (string)

    +
      +
    • Merge elements from this stage number into the target stage number (specified by 'stage-number'). Defaults to the same stage number as the target.
    • +
    +
  • +
  • +

    --merge-system | --msys (string)

    +
      +
    • Merge elements from this system into the target system (specified by 'system'). Defaults to the same system as the target.
    • +
    +
  • +
  • +

    --merge-subsystem | --msub (string)

    +
      +
    • Merge elements from this subsystem into the target subsystem (specified by 'subsystem'). Defaults to the same subsystem as the target.
    • +
    +
  • +
  • +

    --merge-out-of-sync | --moos (boolean)

    +
      +
    • Merge out-of-sync elements at the target location with their next version in the map, and attempt to resolve the out-of-sync during the next synchronization with Endevor.
    • +
    +
  • +
+

workspace options

+
    +
  • +

    --workspace-dir | --wsp (string)

    +
      +
    • +

      The Endevor workspace directory, if different from current working directory.

      +

      Default value: .

      +
    • +
    +
  • +
  • +

    --dry-run | --dr (boolean)

    +
      +
    • List all actions the synchronization would perform, without executing them.
    • +
    +
  • +
  • +

    --limit | --lim (number)

    +
      +
    • +

      If the synchronization would need to perform more than 'limit' Endevor actions, do not perform the actions now, only report them. 0 means no limit.

      +

      Default value: 0

      +
    • +
    +
  • +
+

options

+
    +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of any Endevor elements affected by this action.
    • +
    +
  • +
  • +

    --signout (boolean)

    +
      +
    • Specify if you want to perform the action with signing out any retrieved elements.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Merge element ELEMENT1 of type COBPGM from subsystem SUBFROM into the same element found in subsystem SUBTO (system, stage and env taken from current location profile):

    +
      +
    • zowe endevor merge element ELEMENT1 --type COBPGM --subsystem SUBTO --merge-subsystem SUBFROM
    • +
    +
  • +
  • +

    Merge any elements that are currently out of sync with their next element version up the map (map location determined by current profile):

    +
      +
    • zowe endevor merge element * --merge-out-of-sync
    • +
    +
  • +
  • +

    Report which elements are currently out of sync with their next element version up the map, but do not merge them yet (map location determined by current profile):

    +
      +
    • zowe endevor merge element * --merge-out-of-sync --dry-run
    • +
    +
  • +
  • +

    Merge all elements from system SYSFROM, subsystem SUBFROM into matching elements in system SYSTO subsystem SUBTO (system, stage and env taken from current location profile):

    +
      +
    • zowe endevor merge element * --system SYSTO --subsystem SUBTO --merge-system SYSFROM --merge-subsystem SUBFROM
    • +
    +
  • +
  • +

    Merge element ELEMENT1 of type COBPGM from subsystem SUBFROM into SUBTO, retrieving both elements using the provided ccid & comment, with signout, and overriding signout if necessary:

    +
      +
    • zowe endevor merge element ELEMENT1 --type COBPGM --subsystem SUBTO --merge-subsystem SUBFROM --ccid MYCCID --comment 'my comment' --signout --overrride-signout
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_move.html b/static/v2.15.x/web_help/docs/zowe_endevor_move.html new file mode 100644 index 0000000000..74cb689007 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_move.html @@ -0,0 +1,20 @@ + + + + +endevor move + + +
+

zoweendevormove

+

Move an Element in Endevor.

+

Usage

+

zowe endevor move <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • element | elem | ele - The move element command moves Elements between inventory locations along a map.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_move_element.html b/static/v2.15.x/web_help/docs/zowe_endevor_move_element.html new file mode 100644 index 0000000000..98dda50efa --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_move_element.html @@ -0,0 +1,302 @@ + + + + +endevor move element + + +
+

zoweendevormoveelement

+

The move element command moves Elements between inventory locations along a map.

+

Usage

+

zowe endevor move element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --sync | -s (boolean)

    +
      +
    • Specify if you want to synchronize source and current level of the Elements while performing this action.
    • +
    +
  • +
  • +

    --with-history | --wh (boolean)

    +
      +
    • Specify if you want to preserve the change history of the Elements while performing this action.
    • +
    +
  • +
  • +

    --bypass-element-delete | --bed (boolean)

    +
      +
    • Specify if you want to retain the Elements in the source Stage after successfully completing this action.
    • +
    +
  • +
  • +

    --retain-signout | --rs (boolean)

    +
      +
    • Specify if you want to retain the source location signouts for all Elements at the target location while performing this action.
    • +
    +
  • +
  • +

    --signout-to | --st (string)

    +
      +
    • Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.
    • +
    +
  • +
  • +

    --jump | -j (boolean)

    +
      +
    • Specify if you want to move Elements across Environments even if those Elements exist at an intermediate Stage that is not on the map, while performing this action.
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Move element from specified inventory location with endevor profile set up:

    +
      +
    • zowe endevor move element elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_print.html b/static/v2.15.x/web_help/docs/zowe_endevor_print.html new file mode 100644 index 0000000000..9befc3a8ec --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_print.html @@ -0,0 +1,22 @@ + + + + +endevor print + + +
+

zoweendevorprint

+

Print an Element or a Component in Endevor.

+

Usage

+

zowe endevor print <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • components | comp - The print component command prints selected component information about Element in Endevor.
  • +
  • element | elem | ele - The print element command prints selected information about Element in Endevor.
  • +
  • member | mem - The print member command prints a member from a specified dataset.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_print_components.html b/static/v2.15.x/web_help/docs/zowe_endevor_print_components.html new file mode 100644 index 0000000000..2c1586847c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_print_components.html @@ -0,0 +1,294 @@ + + + + +endevor print components + + +
+

zoweendevorprintcomponents

+

The print component command prints selected component information about Element in Endevor.

+

Usage

+

zowe endevor print components <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --level | --lev (number)

    +
      +
    • Indicates the level number of the element (use along with the version option).
    • +
    +
  • +
  • +

    --element-version | --ev (number)

    +
      +
    • Indicates the version number of the element (use along with the level option).
    • +
    +
  • +
  • +

    --print-comp | --pc (string)

    +
      +
    • +

      Specify the type of data to print out for print component command

      +

      Default value: browse
      +Allowed values: browse, changes, history, summary

      +
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --headings (boolean)

    +
      +
    • Specify it if you want to print a header on each page.
    • +
    +
  • +
  • +

    --explode | --exp | --ex (boolean)

    +
      +
    • Specify to print component info from ACMQ.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --to-file | --tf (string)

    +
      +
    • The file name in which the data from the command output is stored
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Print selected component information about Element with endevor profile set up:

    +
      +
    • zowe endevor print components elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_print_element.html b/static/v2.15.x/web_help/docs/zowe_endevor_print_element.html new file mode 100644 index 0000000000..bd269f9ec8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_print_element.html @@ -0,0 +1,309 @@ + + + + +endevor print element + + +
+

zoweendevorprintelement

+

The print element command prints selected information about Element in Endevor.

+

Usage

+

zowe endevor print element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --level | --lev (number)

    +
      +
    • Indicates the level number of the element (use along with the version option).
    • +
    +
  • +
  • +

    --element-version | --ev (number)

    +
      +
    • Indicates the version number of the element (use along with the level option).
    • +
    +
  • +
  • +

    --print (string)

    +
      +
    • +

      Specify the type of data to print out for print element command

      +

      Default value: browse
      +Allowed values: browse, changes, history, summary, master, listing

      +
    • +
    +
  • +
  • +

    --list-string | --ls (string)

    +
      +
    • Specifies the one to eight character text-string used to identify the listing data set to print.
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --headings (boolean)

    +
      +
    • Specify it if you want to print a header on each page.
    • +
    +
  • +
  • +

    --explode | --exp | --ex (boolean)

    +
      +
    • Specify to print component info from ACMQ.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --to-file | --tf (string)

    +
      +
    • The file name in which the data from the command output is stored
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Print element from specified inventory location with endevor profile set up:

    +
      +
    • zowe endevor print element elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_print_member.html b/static/v2.15.x/web_help/docs/zowe_endevor_print_member.html new file mode 100644 index 0000000000..2962b0de4f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_print_member.html @@ -0,0 +1,208 @@ + + + + +endevor print member + + +
+

zoweendevorprintmember

+

The print member command prints a member from a specified dataset.

+

Usage

+

zowe endevor print member <member> [options]

+

Positional Arguments

+
    +
  • +

    member (string)

    +
      +
    • Name of the member.
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-dataset | --fd (string)

    +
      +
    • Use this input to provide source data set name.
    • +
    +
  • +
+

options

+
    +
  • +

    --headings (boolean)

    +
      +
    • Specify it if you want to print a header on each page.
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --to-file | --tf (string)

    +
      +
    • The file name in which the data from the command output is stored
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Print a member from specified dataset:

    +
      +
    • zowe endevor print member memName --fd DSNAME -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_queryacm.html b/static/v2.15.x/web_help/docs/zowe_endevor_queryacm.html new file mode 100644 index 0000000000..cd554034b2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_queryacm.html @@ -0,0 +1,20 @@ + + + + +endevor queryacm + + +
+

zoweendevorqueryacm

+

Query Elements and information about their components in Endevor.

+

Usage

+

zowe endevor queryacm <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • components | comp - Query components used by a specified Element with the Endevor ACM Query facility.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_queryacm_components.html b/static/v2.15.x/web_help/docs/zowe_endevor_queryacm_components.html new file mode 100644 index 0000000000..0e86bc7f2d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_queryacm_components.html @@ -0,0 +1,272 @@ + + + + +endevor queryacm components + + +
+

zoweendevorqueryacmcomponents

+

Query components used by a specified Element with the Endevor ACM Query facility.

+

Usage

+

zowe endevor queryacm components <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --excCirculars | --exc (boolean)

    +
      +
    • Filters the result to exclude components that have a circular relationship to the subject of your search.
    • +
    +
  • +
  • +

    --excIndirect | --exi (boolean)

    +
      +
    • Filters the result to exclude indirectly related components.
    • +
    +
  • +
  • +

    --excRelated | --exr (boolean)

    +
      +
    • Filters the result to exclude related components.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --full-output | --fo (boolean)

    +
      +
    • Specify this option if you want a full output of list action.
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    query all the components used by element "elementName" from the specified inventory location with the endevor profile set up:

    +
      +
    • zowe endevor queryacm components elementName --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ TYPENAME -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_reset.html b/static/v2.15.x/web_help/docs/zowe_endevor_reset.html new file mode 100644 index 0000000000..2a451ef782 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_reset.html @@ -0,0 +1,20 @@ + + + + +endevor reset + + +
+

zoweendevorreset

+

Reset a Package in Endevor.

+

Usage

+

zowe endevor reset <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • package | pkg - The reset package command lets you set the status of a Package back to In-edit so you can modify it.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_reset_package.html b/static/v2.15.x/web_help/docs/zowe_endevor_reset_package.html new file mode 100644 index 0000000000..20b325ee7e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_reset_package.html @@ -0,0 +1,184 @@ + + + + +endevor reset package + + +
+

zoweendevorresetpackage

+

The reset package command lets you set the status of a Package back to In-edit so you can modify it.

+

Usage

+

zowe endevor reset package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Reset package with endevor profile set up:

    +
      +
    • zowe endevor reset package packageName -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_retrieve.html b/static/v2.15.x/web_help/docs/zowe_endevor_retrieve.html new file mode 100644 index 0000000000..251f7cdb26 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_retrieve.html @@ -0,0 +1,21 @@ + + + + +endevor retrieve + + +
+

zoweendevorretrieve

+

Retrieve an Element in Endevor.

+

Usage

+

zowe endevor retrieve <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_retrieve_element.html b/static/v2.15.x/web_help/docs/zowe_endevor_retrieve_element.html new file mode 100644 index 0000000000..1d9ad11217 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_retrieve_element.html @@ -0,0 +1,445 @@ + + + + +endevor retrieve element + + +
+

zoweendevorretrieveelement

+

The retrieve element command retrieves an existing element in Endevor.

+

Usage

+

zowe endevor retrieve element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --element-version | --ev (number)

    +
      +
    • Indicates the version number of the element (use along with the level option).
    • +
    +
  • +
  • +

    --level | --lev (number)

    +
      +
    • Indicates the level number of the element (use along with the version option).
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --signout (boolean)

    +
      +
    • Specify if you want to perform the action with signing the element out.
    • +
    +
  • +
  • +

    --replace-member | --replace | --rm (boolean)

    +
      +
    • Specify if you want to replace the member currently in the library with the new element contents
    • +
    +
  • +
  • +

    --expand-includes | --expand | --ei (boolean)

    +
      +
    • Indicates that INCLUDE statements should be expanded in the course of the action.
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --get-fingerprint | --gfg (boolean)

    +
      +
    • +

      Return fingerprint of a retrieved, added or updated element as the first line of the response.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
+

output location options

+
    +
  • +

    --to-path | --tp (string)

    +
      +
    • Provide a USS path to a destination location.
    • +
    +
  • +
  • +

    --to-uss-file | --tuf (string)

    +
      +
    • Provide a USS file as a destination file.
    • +
    +
  • +
  • +

    --to-dataset | --td (string)

    +
      +
    • Provide a destination data set name.
    • +
    +
  • +
  • +

    --to-member | --tm (string)

    +
      +
    • Provide a destination member name inside the data set.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --to-file | --tf (string)

    +
      +
    • The file name in which the data from the command output is stored
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

bulk action options

+
    +
  • +

    --to-dir | --tdir (string)

    +
      +
    • Directory name in which the command output will be stored.
    • +
    +
  • +
  • +

    --flat (boolean)

    +
      +
    • Store the output of the bulk action within one folder. When you use this option, ensure that the results do not contain duplicate names. (Duplicate names occur when two or more Elements have the same name and type.)
    • +
    +
  • +
  • +

    --with-dependencies | --wd (boolean)

    +
      +
    • Retrieve Elements, including their Endevor-managed input components.
    • +
    +
  • +
  • +

    --where-ccid-generate | --wcg (string)

    +
      +
    • Instructs Endevor to search using the generate CCID associated with an Element.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-lastact | --wcla (string)

    +
      +
    • Instructs Endevor to search using the last action CCID associated with an Element.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-lastlvl | --wcll (string)

    +
      +
    • Instructs Endevor to search using the last level CCID associated with an Element.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-change | --wcchg (string)

    +
      +
    • This option is only valid when the data option is ele or comp. Instructs Endevor to filter the results of the list data summary function that is based on the specified ccids.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --file-extension | --ext (string)

    +
      +
    • +

      The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:

      +
        none: File name is equal to element name, no extension is added\.
      +
      +  file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added\.
      +
      +  type\-name: The type name is used as the file extension\.
      +
      +  mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead\.
      +
      +

      Default value: mixed
      +Allowed values: none, file-ext, type-name, mixed

      +
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Retrieve element from specified inventory location to local file with endevor profile set up:

    +
      +
    • zowe endevor retrieve element elementName --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ TYPENAME --tf localfile.txt -i ENDEVOR
    • +
    +
  • +
  • +

    Bulk Retrieve elements with wildcarded element name and type, to local directory with endevor profile set up:

    +
      +
    • zowe endevor retrieve element "*" --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ "*" --to-dir /user/localdir -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_retrieve_result.html b/static/v2.15.x/web_help/docs/zowe_endevor_retrieve_result.html new file mode 100644 index 0000000000..f1b97b92e5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_retrieve_result.html @@ -0,0 +1,194 @@ + + + + +endevor retrieve result + + +
+

zoweendevorretrieveresult

+

Retrieve the result of an asynchronous task

+

Usage

+

zowe endevor retrieve result [task-id] [options]

+

Positional Arguments

+
    +
  • +

    task-id (string)

    +
      +
    • The id of an asynchronous Endevor web service task.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Retrieve the result of task 2789102296850204364:

    +
      +
    • zowe endevor retrieve result 2789102296850204364
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_signin.html b/static/v2.15.x/web_help/docs/zowe_endevor_signin.html new file mode 100644 index 0000000000..ea6bae24e5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_signin.html @@ -0,0 +1,20 @@ + + + + +endevor signin + + +
+

zoweendevorsignin

+

Signin an Element in Endevor.

+

Usage

+

zowe endevor signin <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_signin_element.html b/static/v2.15.x/web_help/docs/zowe_endevor_signin_element.html new file mode 100644 index 0000000000..7a3ce36cc8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_signin_element.html @@ -0,0 +1,284 @@ + + + + +endevor signin element + + +
+

zoweendevorsigninelement

+

The signin element command signs in an existing element in Endevor.

+

Usage

+

zowe endevor signin element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --signout-to | --st (string)

    +
      +
    • Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Signin element with endevor profile set up:

    +
      +
    • zowe endevor signin element elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_submit.html b/static/v2.15.x/web_help/docs/zowe_endevor_submit.html new file mode 100644 index 0000000000..fea9de1e0b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_submit.html @@ -0,0 +1,21 @@ + + + + +endevor submit + + +
+

zoweendevorsubmit

+

Submit a Package or a SCL file in Endevor.

+

Usage

+

zowe endevor submit <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • package | pkg - The submit package command submits a JCL job stream to execute one or more Packages.
  • +
  • scl - The submit scl commands submits a SCL file to be executed.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_submit_package.html b/static/v2.15.x/web_help/docs/zowe_endevor_submit_package.html new file mode 100644 index 0000000000..5a8dd829ac --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_submit_package.html @@ -0,0 +1,257 @@ + + + + +endevor submit package + + +
+

zoweendevorsubmitpackage

+

The submit package command submits a JCL job stream to execute one or more Packages.

+

Usage

+

zowe endevor submit package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-file | --ff (string)

    +
      +
    • Use this input to provide source file.
    • +
    +
  • +
  • +

    --from-dataset | --fd (string)

    +
      +
    • Use this input to provide source data set name.
    • +
    +
  • +
  • +

    --from-member | --fm (string)

    +
      +
    • Use this input to provide source member name in the data set.
    • +
    +
  • +
+

output location options

+
    +
  • +

    --to-CA7 | --t7 (boolean)

    +
      +
    • Specify to send the submission of the package to CA 7 scheduler.
    • +
    +
  • +
  • +

    --to-ddname | --tdd (string)

    +
      +
    • Send the submission of the package to be processed according to a DDName specified in the starter task (STC).
    • +
    +
  • +
+

options

+
    +
  • +

    --status | --st (string)

    +
      +
    • +

      Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
      +It is possible to specify multiple status separated by "," during list and delete package.

      +

      Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED

      +
    • +
    +
  • +
  • +

    --multiple-streams | --ms (boolean)

    +
      +
    • Specify to submit a separate, unique job for each package. If you do not specify this, a single job with a unique job step for each package is submitted.
    • +
    +
  • +
  • +

    --increment-jobname | --ij (boolean)

    +
      +
    • Specify to increases the last character in the jobcard you provide.
    • +
    +
  • +
  • +

    --jcl-procedure | --jp (string)

    +
      +
    • This option lets you to identify the name of the JCL procedure that you want to invoke. ENDEVOR is used by default if any processor is specified.
    • +
    +
  • +
  • +

    --CA7-dependent-job | --7dj (string)

    +
      +
    • Specifies a single predecessor job which must complete while demanded job is waiting in the CA 7 scheduler.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit package using jobcard from local file, with endevor profile set up:

    +
      +
    • zowe endevor submit package packageName --ff jobcardfile.txt -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_submit_scl.html b/static/v2.15.x/web_help/docs/zowe_endevor_submit_scl.html new file mode 100644 index 0000000000..3bd1b548b1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_submit_scl.html @@ -0,0 +1,202 @@ + + + + +endevor submit scl + + +
+

zoweendevorsubmitscl

+

The submit scl commands submits a SCL file to be executed.

+

Usage

+

zowe endevor submit scl [options]

+

options

+
    +
  • +

    --scl-file | --sf | --sclf (string)

    +
      +
    • The file which contains the Endevor SCL you would like to submit.
    • +
    +
  • +
  • +

    --scl-type | --sclt (string)

    +
      +
    • +

      The category of Endevor SCL.

      +

      Allowed values: list, element, package, admin, ship, addUpdRtv

      +
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-file | --ff (string)

    +
      +
    • Use this input to provide source file.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit a SCL of type element, with endevor profile set up:

    +
      +
    • zowe endevor submit scl --sf sclfile.txt --sclt element -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_synchronize.html b/static/v2.15.x/web_help/docs/zowe_endevor_synchronize.html new file mode 100644 index 0000000000..e1fb963264 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_synchronize.html @@ -0,0 +1,20 @@ + + + + +endevor synchronize + + +
+

zoweendevorsynchronize

+

Synchronize remote Endevor inventory with the local Endevor workspace.

+

Usage

+

zowe endevor synchronize <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • workspace | wsp - Synchronize a selected subset of remote Endevor inventory with a local Endevor workspace
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_synchronize_workspace.html b/static/v2.15.x/web_help/docs/zowe_endevor_synchronize_workspace.html new file mode 100644 index 0000000000..44ba8dd3fc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_synchronize_workspace.html @@ -0,0 +1,292 @@ + + + + +endevor synchronize workspace + + +
+

zoweendevorsynchronizeworkspace

+

Synchronize a selected subset of remote Endevor inventory with a local Endevor workspace

+

Usage

+

zowe endevor synchronize workspace [workspace-dir] [options]

+

Positional Arguments

+
    +
  • +

    workspace-dir (string)

    +
      +
    • The Endevor workspace directory, if different from current working directory.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of any Endevor elements affected by this action.
    • +
    +
  • +
  • +

    --signout (boolean)

    +
      +
    • Specify if you want to perform the action with signing out any retrieved elements.
    • +
    +
  • +
+

workspace options

+
    +
  • +

    --element | --ele | --elem (string)

    +
      +
    • +

      Name filter to synchronize only specific Endevor element(s).

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --dry-run | --dr (boolean)

    +
      +
    • List all actions the synchronization would perform, without executing them.
    • +
    +
  • +
  • +

    --reset | --rst (boolean)

    +
      +
    • Revert any local changes, resetting the local workspace to match the current state of the remote Endevor inventory.
    • +
    +
  • +
  • +

    --limit | --lim (number)

    +
      +
    • +

      If the synchronization would need to perform more than 'limit' Endevor actions, do not perform the actions now, only report them. 0 means no limit.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --one-way (boolean)

    +
      +
    • Do not update Endevor elements with local changes, only retrieve remote changes from Endevor and resolve any conflicts.
    • +
    +
  • +
  • +

    --allow-deletes | --del (boolean)

    +
      +
    • Allow workspace synchronization to delete unchanged Endevor elements when it detects the corresponding local files have been deleted. Default is off to maintain backward compatibility.
    • +
    +
  • +
  • +

    --file-extension | --ext (string)

    +
      +
    • +

      The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:

      +
        none: File name is equal to element name, no extension is added\.
      +
      +  file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added\.
      +
      +  type\-name: The type name is used as the file extension\.
      +
      +  mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead\.
      +
      +

      Default value: mixed
      +Allowed values: none, file-ext, type-name, mixed

      +
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Synchronize all elements in the map location defined by the currently active endevor-location profile with current directory:

    +
      +
    • zowe endevor synchronize workspace
    • +
    +
  • +
  • +

    Synchronize all elements in the map location defined by the currently active endevor-location profile with workspace directory 'C:/projects/myWorkspace':

    +
      +
    • zowe endevor synchronize workspace 'C:/projects/myWorkspace'
    • +
    +
  • +
  • +

    Synchronize all elements in system SYSTEM1 subsystem SUBSYS1 from environment DEV stage 1, whose type begins with 'ASM', with current directory:

    +
      +
    • zowe endevor synchronize workspace --environment DEV --stage_number 1 --system SYSTEM1 --subsystem SUBSYS1 --type ASM* --ccid myccid --comment 'my changes'
    • +
    +
  • +
  • +

    Synchronize all elements in the map location defined by the currently active endevor-location profile, whose name is 'PRFX' followed by any 2 characters and ending with '11', with workspace directory 'C:/projects/myWorkspace':

    +
      +
    • zowe endevor synchronize workspace 'C:/projects/myWorkspace' --ccid myccid --comment 'my changes' --element PRFX%%11
    • +
    +
  • +
  • +

    Display all actions needed to synchronize all elements in the map location defined by endevor-location profile 'mysandbox' with current directory, without performing them:

    +
      +
    • zowe endevor synchronize workspace --dry-run --endevor-location-profile mysandbox
    • +
    +
  • +
  • +

    Revert all local changes in the map location defined by the currently active endevor-location profile, resetting your workspace to match Endevor:

    +
      +
    • zowe endevor synchronize workspace --reset
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_transfer.html b/static/v2.15.x/web_help/docs/zowe_endevor_transfer.html new file mode 100644 index 0000000000..fbdb78dbf6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_transfer.html @@ -0,0 +1,20 @@ + + + + +endevor transfer + + +
+

zoweendevortransfer

+

Transfer an Element in Endevor.

+

Usage

+

zowe endevor transfer <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • element | elem | ele - The Transfer element command transfers Elements from one Endevor location to another.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_transfer_element.html b/static/v2.15.x/web_help/docs/zowe_endevor_transfer_element.html new file mode 100644 index 0000000000..a6652a73d4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_transfer_element.html @@ -0,0 +1,377 @@ + + + + +endevor transfer element + + +
+

zoweendevortransferelement

+

The Transfer element command transfers Elements from one Endevor location to another.

+

Usage

+

zowe endevor transfer element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output location options

+
    +
  • +

    --to-environment | --toenv (string)

    +
      +
    • The target Endevor environment.
    • +
    +
  • +
  • +

    --to-system | --tosys (string)

    +
      +
    • The target Endevor system.
    • +
    +
  • +
  • +

    --to-subsystem | --tosub (string)

    +
      +
    • The target Endevor subsystem.
    • +
    +
  • +
  • +

    --to-element | --toele (string)

    +
      +
    • The target Endevor element name.
    • +
    +
  • +
  • +

    --to-type | --totyp (string)

    +
      +
    • The target Endevor element type.
    • +
    +
  • +
  • +

    --to-stage-number | --tosn (string)

    +
      +
    • The target Endevor stage Id/number.
    • +
    +
  • +
+

options

+
    +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --element-version | --ev (number)

    +
      +
    • Indicates the version number of the element (use along with the level option).
    • +
    +
  • +
  • +

    --level | --lev (number)

    +
      +
    • Indicates the level number of the element (use along with the version option).
    • +
    +
  • +
  • +

    --new-version | --nv (number)

    +
      +
    • Assign a different version number to the Element.
    • +
    +
  • +
  • +

    --sync | -s (boolean)

    +
      +
    • Specify if you want to synchronize source and current level of the Elements while performing this action.
    • +
    +
  • +
  • +

    --with-history | --wh (boolean)

    +
      +
    • Specify if you want to preserve the change history of the Elements while performing this action.
    • +
    +
  • +
  • +

    --ignore-generate-failed | --igf (boolean)

    +
      +
    • Process the transfer request regardless of whether the FAILED flag is set for the element or if the element was generated or moved successfully.
    • +
    +
  • +
  • +

    --bypass-element-delete | --bed (boolean)

    +
      +
    • Specify if you want to retain the Elements in the source Stage after successfully completing this action.
    • +
    +
  • +
  • +

    --bypass-delete-proc | --bdp (boolean)

    +
      +
    • Specity to bypasses the execution of the delete processor.
    • +
    +
  • +
  • +

    --bypass-generate-proc | --bgp (boolean)

    +
      +
    • Specify to bypasses the execution of the generate or move processor (whichever may be chosen) upon element transfer.
    • +
    +
  • +
  • +

    --retain-signout | --rs (boolean)

    +
      +
    • Specify if you want to retain the source location signouts for all Elements at the target location while performing this action.
    • +
    +
  • +
  • +

    --signout-to | --st (string)

    +
      +
    • Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Transfer element from specified inventory location to 1 stage higher in map, with endevor profile set up:

    +
      +
    • zowe endevor transfer element elementName --env ENV --sn 1 --tosn 2 --sys SYS --sub SUB --typ TYPE -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_unsynchronize.html b/static/v2.15.x/web_help/docs/zowe_endevor_unsynchronize.html new file mode 100644 index 0000000000..3302e6d932 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_unsynchronize.html @@ -0,0 +1,20 @@ + + + + +endevor unsynchronize + + +
+

zoweendevorunsynchronize

+

Remove a synchronized Endevor inventory from a local Endevor workspace and delete any related metadata.

+

Usage

+

zowe endevor unsynchronize <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • workspace | wsp - Remove a selected subset of remote Endevor inventory from a local Endevor workspace
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_unsynchronize_workspace.html b/static/v2.15.x/web_help/docs/zowe_endevor_unsynchronize_workspace.html new file mode 100644 index 0000000000..2a8448877e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_unsynchronize_workspace.html @@ -0,0 +1,208 @@ + + + + +endevor unsynchronize workspace + + +
+

zoweendevorunsynchronizeworkspace

+

Remove a selected subset of remote Endevor inventory from a local Endevor workspace

+

Usage

+

zowe endevor unsynchronize workspace [workspace-dir] [options]

+

Positional Arguments

+
    +
  • +

    workspace-dir (string)

    +
      +
    • The Endevor workspace directory, if different from current working directory.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: \*, \%, 1, 2

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

workspace options

+
    +
  • +

    --element | --ele | --elem (string)

    +
      +
    • +

      Name filter to synchronize only specific Endevor element(s).

      +

      Default value: *

      +
    • +
    +
  • +
  • +

    --force | -f (boolean)

    +
      +
    • Force unsynchronization of local workspace regardless of any local changes not yet saved into Endevor.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Remove all elements in the map location defined by the currently active endevor-location profile from current directory:

    +
      +
    • zowe endevor unsynchronize workspace
    • +
    +
  • +
  • +

    Remove all elements in the map location defined by the currently active endevor-location profile from current directory, throwing away any local changes not saved in Endevor:

    +
      +
    • zowe endevor unsynchronize workspace --force
    • +
    +
  • +
  • +

    Remove all elements in the map location defined by the currently active endevor-location profile from workspace directory 'C:/projects/myWorkspace':

    +
      +
    • zowe endevor unsynchronize workspace 'C:/projects/myWorkspace'
    • +
    +
  • +
  • +

    Remove all elements in system SYSTEM1 subsystem SUBSYS1 environment DEV stage 1, whose type begins with 'ASM', from current directory:

    +
      +
    • zowe endevor unsynchronize workspace --environment DEV --stage_number 1 --system SYSTEM1 --subsystem SUBSYS1 --type ASM* --ccid myccid --comment 'my changes'
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_update.html b/static/v2.15.x/web_help/docs/zowe_endevor_update.html new file mode 100644 index 0000000000..e7bcca0218 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_update.html @@ -0,0 +1,21 @@ + + + + +endevor update + + +
+

zoweendevorupdate

+

Update an Element or a Package in Endevor.

+

Usage

+

zowe endevor update <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • element | elem | ele - The update element command updates an Element in the entry Stage, thereby creating a new level for the Element in the entry Stage.
  • +
  • package | pkg - The update package command lets you update a package in Endevor.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_update_element.html b/static/v2.15.x/web_help/docs/zowe_endevor_update_element.html new file mode 100644 index 0000000000..8edeef5c04 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_update_element.html @@ -0,0 +1,307 @@ + + + + +endevor update element + + +
+

zoweendevorupdateelement

+

The update element command updates an Element in the entry Stage, thereby creating a new level for the Element in the entry Stage.

+

Usage

+

zowe endevor update element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-file | --ff (string)

    +
      +
    • Use this input to provide source file.
    • +
    +
  • +
  • +

    --from-dataset | --fd (string)

    +
      +
    • Use this input to provide source data set name.
    • +
    +
  • +
  • +

    --from-member | --fm (string)

    +
      +
    • Use this input to provide source member name in the data set.
    • +
    +
  • +
  • +

    --from-path | --fp (string)

    +
      +
    • Use this input to provide the path of source USS file. It must be used with from-uss-file.
    • +
    +
  • +
  • +

    --from-uss-file | --fuf (string)

    +
      +
    • Use this input to provide source USS file name. It must be used with from-path
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Specify if you want to override the Signout of an Endevor element while performing this action.
    • +
    +
  • +
  • +

    --proc-group | --pg (string)

    +
      +
    • The Endevor processor group you would like to use.
    • +
    +
  • +
  • +

    --generate | -g (boolean)

    +
      +
    • Specifies if you want to Generate Element after Add/Update action.
    • +
    +
  • +
  • +

    --get-fingerprint | --gfg (boolean)

    +
      +
    • +

      Return fingerprint of a retrieved, added or updated element as the first line of the response.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --fingerprint | --fg (string)

    +
      +
    • Specifies the fingerprint of the element to Add or Update. Use value 'NEW' when adding a new element that shouldn't exist in the map yet.
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --sync | -s (boolean)

    +
      +
    • Specify if you want to synchronize source and current level of the Elements while performing this action.
    • +
    +
  • +
  • +

    --sync-with-history | --swh (boolean)

    +
      +
    • Specify if you want to preserve the change history of the Elements while performing the synchronization during element update.
    • +
    +
  • +
  • +

    --sync-fingerprint | --sfg (string)

    +
      +
    • Specifies the fingerprint of the element directly up the map that the updated element should be synchronized with. Prevents the sync if the element up the map doesn't match the fingerprint.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update element from local file with endevor profile set up:

    +
      +
    • zowe endevor update element elementName --env ENV --sys SYS --sub SUB --typ TYPE --ff localfile.txt -i ENDEVOR --ccid CCID --comment 'updating element'
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_update_package.html b/static/v2.15.x/web_help/docs/zowe_endevor_update_package.html new file mode 100644 index 0000000000..4f5bbeb43f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_update_package.html @@ -0,0 +1,283 @@ + + + + +endevor update package + + +
+

zoweendevorupdatepackage

+

The update package command lets you update a package in Endevor.

+

Usage

+

zowe endevor update package [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

input sources options

+
    +
  • +

    --from-file | --ff (string)

    +
      +
    • Use this input to provide source file.
    • +
    +
  • +
  • +

    --from-dataset | --fd (string)

    +
      +
    • Use this input to provide source data set name.
    • +
    +
  • +
  • +

    --from-member | --fm (string)

    +
      +
    • Use this input to provide source member name in the data set.
    • +
    +
  • +
  • +

    --from-package | --fp (string)

    +
      +
    • Directs the Create/Update action to copy the SCL from the package you specify into the package you are creating or updating.
    • +
    +
  • +
  • +

    --from-text | --ft (string)

    +
      +
    • Provides a string to use as input SCL.
    • +
    +
  • +
+

options

+
    +
  • +

    --description | -d (string)

    +
      +
    • Allows you to associate a 50-character description when creating or updating package.
    • +
    +
  • +
  • +

    --from-date-time | --fdt (string)

    +
      +
    • Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --to-date-time | --tdt (string)

    +
      +
    • Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
    • +
    +
  • +
  • +

    --backout (boolean)

    +
      +
    • +

      Set this option to false (or specify --no-backout) if you don't want to have the backout facility available for this package. By default backout is enabled.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --notes | -n (string)

    +
      +
    • Notes for package.
    • +
    +
  • +
  • +

    --notes-from-file | --nff (string)

    +
      +
    • Local file of notes for package.
    • +
    +
  • +
  • +

    --emergency-package | --ep (boolean)

    +
      +
    • Specify if the package should be an emergency package. When not specified, the package is a standard package.
    • +
    +
  • +
  • +

    --sharable | --sh (boolean)

    +
      +
    • Specify this option if the package can be edited by more than one person when in In-edit status.
    • +
    +
  • +
  • +

    --promotion | --pr (boolean)

    +
      +
    • Specify this option to define the package as a promotion package.
    • +
    +
  • +
  • +

    --validate-scl | --vs (boolean)

    +
      +
    • +

      Set this option to false (or specify --no-validate-scl) to skip validion of the package components while creating a package. By default the SCL is validated

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --append | -a (boolean)

    +
      +
    • Specify this option to append the SCL you are adding to the existing package SCL. Otherwise it would be replaced.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update package from local file with endevor profile set up:

    +
      +
    • zowe endevor update package packageName --ff localfile.txt -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_view.html b/static/v2.15.x/web_help/docs/zowe_endevor_view.html new file mode 100644 index 0000000000..daf7ef6924 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_view.html @@ -0,0 +1,21 @@ + + + + +endevor view + + +
+

zoweendevorview

+

View an Element or a Package SCL in Endevor.

+

Usage

+

zowe endevor view <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_view_element.html b/static/v2.15.x/web_help/docs/zowe_endevor_view_element.html new file mode 100644 index 0000000000..8f64c1662f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_view_element.html @@ -0,0 +1,293 @@ + + + + +endevor view element + + +
+

zoweendevorviewelement

+

The view element command views an existing element in Endevor.

+

Usage

+

zowe endevor view element <element> [options]

+

Positional Arguments

+
    +
  • +

    element (string)

    +
      +
    • Name of the Endevor element.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where your project resides.
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your project resides.
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type.
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage number where your project resides.

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The CCID you want to use when performing an Element action.
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The comment you want to have when performing an Element action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

options

+
    +
  • +

    --element-version | --ev (number)

    +
      +
    • Indicates the version number of the element (use along with the level option).
    • +
    +
  • +
  • +

    --level | --lev (number)

    +
      +
    • Indicates the level number of the element (use along with the version option).
    • +
    +
  • +
  • +

    --search | --sea (boolean)

    +
      +
    • Enables the search through the Endevor map.
    • +
    +
  • +
  • +

    --where-ccid-all | --wca (string)

    +
      +
    • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-current | --wcc (string)

    +
      +
    • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
      +Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-ccid-retrieve | --wcr (string)

    +
      +
    • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
      +Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
    • +
    +
  • +
  • +

    --where-proc-group | --wpg (string)

    +
      +
    • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
      +Accepts up to 8 Processor group names separated by ", ".
    • +
    +
  • +
  • +

    --charset | --char (string)

    +
      +
    • +

      Specifies the clients preferred character set when retrieving, printing or updating elements.

      +

      Default value: false

      +
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --to-file | --tf (string)

    +
      +
    • The file name in which the data from the command output is stored
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

asynchronous task options

+
    +
  • +

    --asynchronous | --async (boolean)

    +
      +
    • Submit this command as an asynchronous Endevor Web Services task
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    View element from specified inventory location to local file with endevor profile set up:

    +
      +
    • zowe endevor view element elementName --env ENV --sn 1 --sys SYS --sub SUB --typ TYPE --tf localfile.txt -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_endevor_view_pkgscl.html b/static/v2.15.x/web_help/docs/zowe_endevor_view_pkgscl.html new file mode 100644 index 0000000000..4d82b4962a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_endevor_view_pkgscl.html @@ -0,0 +1,181 @@ + + + + +endevor view pkgscl + + +
+

zoweendevorviewpkgscl

+

The view pkgscl command views the SCL of an existing package in Endevor.

+

Usage

+

zowe endevor view pkgscl [package] [options]

+

Positional Arguments

+
    +
  • +

    package (string)

    +
      +
    • Name of the Endevor package.
    • +
    +
  • +
+

endevor-location definition options

+
    +
  • +

    --maxrc (number)

    +
      +
    • +

      The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --instance | -i (string)

    +
      +
    • Specifies Endevor Web Services dataSource name.
    • +
    +
  • +
+

output customization options

+
    +
  • +

    --to-file | --tf (string)

    +
      +
    • The file name in which the data from the command output is stored
    • +
    +
  • +
  • +

    --suppress-messages | --sm (boolean)

    +
      +
    • Suppress all [INFO]/[WARN] messages from terminal output.
    • +
    +
  • +
  • +

    --report-file | --file-name (string)

    +
      +
    • File name for saving reports from Endevor SCM locally.
    • +
    +
  • +
  • +

    --report-dir (string)

    +
      +
    • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
    • +
    +
  • +
  • +

    --write-report (boolean)

    +
      +
    • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
    • +
    +
  • +
+

endevor session definition options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • Specifies the base host name.
    • +
    +
  • +
  • +

    --port | -p (string)

    +
      +
    • Specifies the port number.
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      Specifies the protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • Specifies the user name.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Specifies the user's password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Specify this option to have the server certificate verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • Specifies the base path used for connecting to Endevor Rest API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --endevor-profile | --endevor-p (string)

    +
      +
    • The name of a (endevor) profile to load for this command execution.
    • +
    +
  • +
  • +

    --endevor-location-profile | --endevor-location-p (string)

    +
      +
    • The name of a (endevor-location) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    View SCL of package "packageName" in the console with endevor profile set up:

    +
      +
    • zowe endevor view pkgscl packageName -i ENDEVOR
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus.html new file mode 100644 index 0000000000..005392a127 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus.html @@ -0,0 +1,26 @@ + + + + +file-master-plus + + +
+

zowefile-master-plus

+

File Master Plus command line interface is a file management and data manipulation tool.
+It speeds up file creation and manipulates virtual storage access method (VSAM), sequential and partitioned data sets.
+It also supports symbolic access to data via layouts and data manipulation like selection of records in data sets.

+

Usage

+

zowe file-master-plus <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_copy.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_copy.html new file mode 100644 index 0000000000..026ca471c8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_copy.html @@ -0,0 +1,20 @@ + + + + +file-master-plus copy + + +
+

zowefile-master-pluscopy

+

Copy data from a data set and optionally filter or modify the copied data by using selection criteria.

+

Usage

+

zowe file-master-plus copy <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_copy_data-set.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_copy_data-set.html new file mode 100644 index 0000000000..a19f52c2ab --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_copy_data-set.html @@ -0,0 +1,211 @@ + + + + +file-master-plus copy data-set + + +
+

zowefile-master-pluscopydata-set

+

Copy from a data set to another data set.
+If the <to> data set does not exist, File Master Plus automatically creates a new data set using the attributes of <from> data set.
+It supports all data set types that are supported by File Master Plus.

+

Usage

+

zowe file-master-plus copy data-set <from> <to> [options]

+

Positional Arguments

+
    +
  • +

    from (string)

    +
      +
    • Specifies the name of the data set to copy from.
    • +
    +
  • +
  • +

    to (string)

    +
      +
    • Specifies the name of the data set to copy to.
    • +
    +
  • +
+

Options

+
    +
  • +

    --members | -m (array)

    +
      +
    • Specifies the members that you want to copy from the data set. To rename the member, specify a new member name after the delimiter ','.If this parameter is not specified all the members are copied.
      +Note: This parameter only applies to a PDS or PDSE.
      +Example: --mem mem1,newmem1 mem2. Here 'mem2' is copied as it is, and 'mem1' is renamed as 'newmem1'.
    • +
    +
  • +
  • +

    --generation | -g (string)

    +
      +
    • Specifies the PDSE V2 generation number that you want to copy from the data set from.
      +Note: This parameter should only be specified if data set from is PDSEV2. If not specified and data set from is a PDSE V2 then current generation, i.e. generation 0, is copied. If generation is negative specifies Relative generation, positive specifies Absolute generation, * specifies all generations and 0 specifies current generation.
      +Example1: --generation *. All generations of member(s) is copied.
      +Example2: --generation -1. Relative generation -1 of member(s) is copied.
      +Example3: --generation 4. Absolute generation 4 of member(s) is copied.
      +Allowed values: '*','range from -2000000000 to 2000000000'
    • +
    +
  • +
  • +

    --replace | -r (string)

    +
      +
    • +

      Replace resource-specific items in the target data set. Note: Used only if the target data set is a PDS or a VSAM KSDS.
      +Example: -r n.

      +

      Default value: y
      +Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --static-selection-criteria | --ssc (string)

    +
      +
    • Specifies the name of pre-defined File Master Plus selection criteria. The name refers to a member in the defaultselection criteria data set as defined in the FMM_CLIST parameter in File Master Plus server.
      +Example: --ssc testcri
    • +
    +
  • +
  • +

    --dynamic-selection-criteria | --dsc (string)

    +
      +
    • Specifies path of the .txt file where the dynamic selection criteria exist. Ensure the format of the file is identical to the static selection criteria created by File Master Plus. If the selection criteria refer to field names in a Cobol or PL/I copybook, use the --layout-member and --layout-data-set parameters to name the copybook location.
      +Example: --dsc ../selcri/testcri.txt
    • +
    +
  • +
  • +

    --layout-member | --lm (string)

    +
      +
    • Specifies name of the Cobol or PL/I copybook.
      +Example: -lm testlay.
    • +
    +
  • +
  • +

    --layout-data-set | --lds (string)

    +
      +
    • Specifies name of the data set that contains the layout member.
      +Example: -lds fmmvs.layout.dataset.
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Copying a data set:

    +
      +
    • zowe file-master-plus copy data-set fmmvs.pds1 fmmvs.pds2
    • +
    +
  • +
  • +

    Copying a data set with dynamic selection criteria:

    +
      +
    • zowe file-master-plus copy data-set fmmvs.from.ps fmmvs.to.ps --lds fmmvs.layout.dataset --lm testlay --dsc ./fmmvs/selcri/testcri
    • +
    +
  • +
  • +

    Copying a PDSE V2 data set with all generations:

    +
      +
    • zowe file-master-plus copy data-set fmmvs.from.psdsev2 fmmvs.to.psdsev2 --generation *
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_create.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create.html new file mode 100644 index 0000000000..d63bb6c35d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create.html @@ -0,0 +1,29 @@ + + + + +file-master-plus create + + +
+

zowefile-master-pluscreate

+

Create a data set.

+

Usage

+

zowe file-master-plus create <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_large-format-sequential.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_large-format-sequential.html new file mode 100644 index 0000000000..2138d51238 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_large-format-sequential.html @@ -0,0 +1,273 @@ + + + + +file-master-plus create large-format-sequential + + +
+

zowefile-master-pluscreatelarge-format-sequential

+

Create a large format sequential data set.

+

Usage

+

zowe file-master-plus create large-format-sequential <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model large format sequential data set name for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --logical-record-length | --lrecl | --lrl (number)

    +
      +
    • Specifies the length of the logical record.
      +Allowed values: 1-32760
      +Default value: 80
      +Example: --lrecl 80
    • +
    +
  • +
  • +

    --block-size | --blksize | --bs (number)

    +
      +
    • Specifies the size of the block of records.
      +Allowed values: 1-32760
      +Default value: 6160
      +Example: --blksize 6160
    • +
    +
  • +
  • +

    --record-format | --recfm | --rf (string)

    +
      +
    • +

      Specifies the record format.
      +The allowed values which have the following meaning:
      +F - Fixed-length records
      +V - Variable-length records
      +U - Undefined-length records
      +B - Records are blocked
      +A - Records contain ASCII printer control characters
      +M - Records contain machine code control characters
      +S - For variable-length records, records may span blocks
      +T - Records may be written into overflow tracks
      +Default value: FB
      +Example: --recfm FB

      +

      Allowed values: F, FA, FM, FB, FBA, FBM, FS, FSA, FSM, FT, FTA, FTM, FBS, FBT, U, UA, UM, UT, UTA, UTM, V, VA, VM, VB, VBA, VBM, VS, VSA, VSM, VT, VTA, VTM, VBS, VBT

      +
    • +
    +
  • +
  • +

    --space-units | --su (string)

    +
      +
    • +

      Specifies the space allocation unit.
      +The allowed values which have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +BLK - Blocksize
      +Default value: CYL
      +Example: --su blk

      +

      Allowed values: TRK, CYL, BLK

      +
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • Specifies primary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ps 3
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • Specifies secondary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ss 5
    • +
    +
  • +
  • +

    --volume | -v (array)

    +
      +
    • Specifies a disk volume or specific tapes.
      +Example: -v vol002
    • +
    +
  • +
  • +

    --unit-type | --ut (string)

    +
      +
    • Specifies the DASD unit name.
      +Example: --ut sysda
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a large format sequential data set with default option values:

    +
      +
    • zowe file-master-plus create large-format-sequential fmmvs.test.dsname
    • +
    +
  • +
  • +

    Creating a large format sequential data set with options:

    +
      +
    • zowe file-master-plus create large-format-sequential fmmvs.test.dsname --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 -v vol005 --su trk --ed 2025-09-27
    • +
    +
  • +
  • +

    Creating a large format sequential data set like a model large format sequential data set:

    +
      +
    • zowe file-master-plus create large-format-sequential fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a large format sequential data set like a model large format sequential data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create large-format-sequential fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm VB --ps 5 --ss 5 --ed p
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_like-model.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_like-model.html new file mode 100644 index 0000000000..015fd74dbf --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_like-model.html @@ -0,0 +1,136 @@ + + + + +file-master-plus create like-model + + +
+

zowefile-master-pluscreatelike-model

+

Create a data set by allocating parameters from a model data set.

+

Usage

+

zowe file-master-plus create like-model <name> <model> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
  • +

    model (string)

    +
      +
    • Specifies the name of the model data set.
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a data set like a model data set:

    +
      +
    • zowe file-master-plus create like-model fmmvs.create.dsname fmmvs.model.dsname
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_partitioned-data-set-extended.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_partitioned-data-set-extended.html new file mode 100644 index 0000000000..d2b26f809a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_partitioned-data-set-extended.html @@ -0,0 +1,293 @@ + + + + +file-master-plus create partitioned-data-set-extended + + +
+

zowefile-master-pluscreatepartitioned-data-set-extended

+

Create an extended partitioned data set.

+

Usage

+

zowe file-master-plus create partitioned-data-set-extended <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model extentded partitioned data set name for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --data-set-version | --dsv | --ver (number)

    +
      +
    • +

      Specifies the data set version.
      +Default value depends on the system settings.
      +Example: --ver 2

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --generations | -g (number)

    +
      +
    • Specifies the number of generations.
      +Applicable when data set version is '2'.
      +Default value: 0
      +Example: -g 10
    • +
    +
  • +
  • +

    --logical-record-length | --lrecl | --lrl (number)

    +
      +
    • Specifies the length of the logical record.
      +Allowed values: 1-32760
      +Default value: 80
      +Example: --lrecl 80
    • +
    +
  • +
  • +

    --block-size | --blksize | --bs (number)

    +
      +
    • Specifies the size of the block of records.
      +Allowed values: 1-32760
      +Default value: 6160
      +Example: --blksize 6160
    • +
    +
  • +
  • +

    --record-format | --recfm | --rf (string)

    +
      +
    • +

      Specifies the record format.
      +The allowed values which have the following meaning:
      +F - Fixed-length records
      +V - Variable-length records
      +U - Undefined-length records
      +B - Records are blocked
      +A - Records contain ASCII printer control characters
      +M - Records contain machine code control characters
      +S - For variable-length records, records may span blocks
      +T - Records may be written into overflow tracks
      +Default value: FB
      +Example: --recfm FB

      +

      Allowed values: F, FA, FM, FB, FBA, FBM, FS, FSA, FSM, FT, FTA, FTM, FBS, FBT, U, UA, UM, UT, UTA, UTM, V, VA, VM, VB, VBA, VBM, VS, VSA, VSM, VT, VTA, VTM, VBS, VBT

      +
    • +
    +
  • +
  • +

    --space-units | --su (string)

    +
      +
    • +

      Specifies the space allocation unit.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +BLK - Blocksize
      +Default value: CYL
      +Example: --su blk

      +

      Allowed values: TRK, CYL, BLK

      +
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • Specifies primary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ps 3
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • Specifies secondary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ss 5
    • +
    +
  • +
  • +

    --volume | -v (string)

    +
      +
    • Specifies a disk volume or specific tapes.
      +Example: -v vol002
    • +
    +
  • +
  • +

    --unit-type | --ut (string)

    +
      +
    • Specifies the DASD unit name.
      +Example: --ut sysda
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a PDSE with default option values:

    +
      +
    • zowe file-master-plus create partitioned-data-set-extended fmmvs.test.dsname
    • +
    +
  • +
  • +

    Creating a PDSE version 2 with options:

    +
      +
    • zowe file-master-plus create partitioned-data-set-extended fmmvs.test.dsname --ver 2 -g 10 --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 -v vol005 --su trk --ed 2025-09-27
    • +
    +
  • +
  • +

    Creating a PDSE data set like a model PDSE:

    +
      +
    • zowe file-master-plus create partitioned-data-set-extended fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a PDSE like a model PDSE and the parameters with options:

    +
      +
    • zowe file-master-plus create partitioned-data-set-extended fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm vb --ps 5 --ss 5 --db 5 -v vol005 --ed p
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_partitioned-data-set.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_partitioned-data-set.html new file mode 100644 index 0000000000..a982e02463 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_partitioned-data-set.html @@ -0,0 +1,282 @@ + + + + +file-master-plus create partitioned-data-set + + +
+

zowefile-master-pluscreatepartitioned-data-set

+

Create a partitioned data set.

+

Usage

+

zowe file-master-plus create partitioned-data-set <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model partitioned data set for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --logical-record-length | --lrecl | --lrl (number)

    +
      +
    • Specifies the length of the logical record.
      +Allowed values: 1-32760
      +Default value: 80
      +Example: --lrecl 80
    • +
    +
  • +
  • +

    --block-size | --blksize | --bs (number)

    +
      +
    • Specifies the size of the block of records.
      +Allowed values: 1-32760
      +Default value: 6160
      +Example: --blksize 6160
    • +
    +
  • +
  • +

    --record-format | --recfm | --rf (string)

    +
      +
    • +

      Specifies the record format.
      +The allowed values have the following meaning:
      +F - Fixed-length records
      +V - Variable-length records
      +U - Undefined-length records
      +B - Records are blocked
      +A - Records contain ASCII printer control characters
      +M - Records contain machine code control characters
      +S - For variable-length records, records may span blocks
      +T - Records may be written into overflow tracks
      +Default value: FB
      +Example: --recfm FB

      +

      Allowed values: F, FA, FM, FB, FBA, FBM, FS, FSA, FSM, FT, FTA, FTM, FBS, FBT, U, UA, UM, UT, UTA, UTM, V, VA, VM, VB, VBA, VBM, VS, VSA, VSM, VT, VTA, VTM, VBS, VBT

      +
    • +
    +
  • +
  • +

    --space-units | --su (string)

    +
      +
    • +

      Specifies the space allocation unit.
      +The allowed values which have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +BLK - Blocksize
      +Default value: CYL
      +Example: --su blk

      +

      Allowed values: TRK, CYL, BLK

      +
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • Specifies the primary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ps 3
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • Specifies the secondary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ss 5
    • +
    +
  • +
  • +

    --directory-blocks | --db (number)

    +
      +
    • Specifies number of directory blocks.
      +Allowed values: 1-16777215
      +Default value: 5
      +Example: --db 5
    • +
    +
  • +
  • +

    --volume | -v (string)

    +
      +
    • Specifies a disk volume or specific tapes.
      +Example: -v vol002
    • +
    +
  • +
  • +

    --unit-type | --ut (string)

    +
      +
    • Specifies the DASD unit name.
      +Example: --ut sysda
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a PDS with default option values:

    +
      +
    • zowe file-master-plus create partitioned-data-set fmmvs.test.dsname
    • +
    +
  • +
  • +

    Creating a PDS with options:

    +
      +
    • zowe file-master-plus create partitioned-data-set fmmvs.test.dsname --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 --db 5 -v vol005 --su trk --ed p
    • +
    +
  • +
  • +

    Creating a PDS like a model PDS:

    +
      +
    • zowe file-master-plus create partitioned-data-set fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a PDS like a model PDS and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create partitioned-data-set fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm vb --ps 5 --ss 5 --db 5 -v vol005 --ed 2025-09-27
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_physical-sequential.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_physical-sequential.html new file mode 100644 index 0000000000..82943a0972 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_physical-sequential.html @@ -0,0 +1,273 @@ + + + + +file-master-plus create physical-sequential + + +
+

zowefile-master-pluscreatephysical-sequential

+

Create a physical sequential data set.

+

Usage

+

zowe file-master-plus create physical-sequential <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model physical sequential data set name for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --logical-record-length | --lrecl | --lrl (number)

    +
      +
    • Specifies the length of the logical record.
      +Allowed values: 1-32760
      +Default value: 80
      +Example: --lrecl 80
    • +
    +
  • +
  • +

    --block-size | --blksize | --bs (number)

    +
      +
    • Specifies the size of the block of records.
      +Allowed values: 1-32760
      +Default value: 6160
      +Example: --blksize 6160
    • +
    +
  • +
  • +

    --record-format | --recfm | --rf (string)

    +
      +
    • +

      Specifies the record format.
      +The allowed values which have the following meaning:
      +F - Fixed-length records
      +V - Variable-length records
      +U - Undefined-length records
      +B - Records are blocked
      +A - Records contain ASCII printer control characters
      +M - Records contain machine code control characters
      +S - For variable-length records, records may span blocks
      +T - Records may be written into overflow tracks
      +Default value: FB
      +Example: --recfm FB

      +

      Allowed values: F, FA, FM, FB, FBA, FBM, FS, FSA, FSM, FT, FTA, FTM, FBS, FBT, U, UA, UM, UT, UTA, UTM, V, VA, VM, VB, VBA, VBM, VS, VSA, VSM, VT, VTA, VTM, VBS, VBT

      +
    • +
    +
  • +
  • +

    --space-units | --su (string)

    +
      +
    • +

      Specifies the space allocation unit.
      +The allowed values which have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +BLK - Blocksize
      +Default value: CYL
      +Example: --su blk

      +

      Allowed values: TRK, CYL, BLK

      +
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • Specifies primary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ps 3
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • Specifies secondary space allocation unit.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ss 5
    • +
    +
  • +
  • +

    --volume | -v (array)

    +
      +
    • Specifies a disk volume or specific tapes.
      +Example: -v vol002
    • +
    +
  • +
  • +

    --unit-type | --ut (string)

    +
      +
    • Specifies the DASD unit name.
      +Example: --ut sysda
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a physical sequential data set with default option values:

    +
      +
    • zowe file-master-plus create physical-sequential fmmvs.test.dsname
    • +
    +
  • +
  • +

    Creating a physical sequential data set with options:

    +
      +
    • zowe file-master-plus create physical-sequential fmmvs.test.dsname --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 -v vol005 --su trk --ed 2025-09-27
    • +
    +
  • +
  • +

    Creating a physical sequential data set like a model physical sequential data set:

    +
      +
    • zowe file-master-plus create physical-sequential fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a physical sequential data set like a model physical sequential data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create physical-sequential fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm VB --ps 5 --ss 5 --ed p
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-esds.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-esds.html new file mode 100644 index 0000000000..99cebf6829 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-esds.html @@ -0,0 +1,428 @@ + + + + +file-master-plus create vsam-esds + + +
+

zowefile-master-pluscreatevsam-esds

+

Create an entry-sequenced Virtual Storage Access Method (VSAM) data set (ESDS).

+

Usage

+

zowe file-master-plus create vsam-esds <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a ESDS (entry-sequenced VSAM data set) for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --maximum-record-size | --mrs (number)

    +
      +
    • Specifies the maximum length of data records.
      +This parameter is mandatory unless a model data set is specified.
      +Example: --mrs 180
    • +
    +
  • +
  • +

    --average-record-size | --ars (number)

    +
      +
    • Specifies the average length of data records.
      +If this parameter is not specified then it is set to the same as the maximum-record-size option.
      +Example: --ars 110
    • +
    +
  • +
  • +

    --data-dsname | --ddsn (string)

    +
      +
    • Specifies the data set name of the data VSAM component.
      +If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
      +Example: --ddsn fmmvs.vsam.esds.data
    • +
    +
  • +
  • +

    --data-control-interval-size | --dcis (number)

    +
      +
    • Specifies the size of the Control Interval for the data VSAM component.
      +Default value: 20480
      +Example: --dcis 3584
    • +
    +
  • +
  • +

    --data-space-units | --dsu (string)

    +
      +
    • +

      Specifies the space allocation unit for data vsam component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --dsu rec

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --data-primary-space | --dps (number)

    +
      +
    • Specifies the primary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 18
      +Example: --dps 3
    • +
    +
  • +
  • +

    --data-secondary-space | --dss (number)

    +
      +
    • Specifies the secondary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 3
      +Example: --dss 5
    • +
    +
  • +
  • +

    --data-volume | --dv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the data VSAM component.
      +Example: -dv vol002
    • +
    +
  • +
  • +

    --buffer-space | --bs (number)

    +
      +
    • Specifies the minimum buffer space to allocate when this VSAM file is accessed.
      +Example: --bs 37376
    • +
    +
  • +
  • +

    --erase | -e (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
      +Default value: n
      +Example: -e y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --load-restartable | --lr (string)

    +
      +
    • +

      Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
      +Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
      +Default value: n
      +Example: -lr y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --reuse | -r (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.
      +Default value: n
      +Example: -r y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --spanned | -s (string)

    +
      +
    • +

      Indicates whether VSAM file was allocated with the SPANNED parameter indicating that data records larger than a control interval can span multiple control intervals.
      +Default value: n
      +Example: -s y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --write-check | --wc (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.
      +Default value: n
      +Example: --wc y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --control-interval-freespace-percentage | --cifp (number)

    +
      +
    • Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
      +Example: --cifp 10
    • +
    +
  • +
  • +

    --control-area-freespace-percentage | --cafp (number)

    +
      +
    • Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
      +Example: --cafp 10
    • +
    +
  • +
  • +

    --cross-region-share-option | --crso (number)

    +
      +
    • +

      Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
      +The allowed values have the following meaning:
      +1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
      +2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 1
      +Example: --crso 2

      +

      Allowed values: 1, 2, 3, 4

      +
    • +
    +
  • +
  • +

    --cross-system-share-option | --csso (number)

    +
      +
    • +

      Specifies how the file can be shared among systems.
      +The allowed values have the following meaning:
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 3
      +Example: --csso 4

      +

      Allowed values: 3, 4

      +
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
  • +

    --log | -l (string)

    +
      +
    • +

      When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
      +Example: --log ALL

      +

      Allowed values: NONE, UNDO, ALL

      +
    • +
    +
  • +
  • +

    --frlog | --fr (string)

    +
      +
    • +

      Specifies the type of VSAM batch logging to perform for this VSAM data set.
      +The allowed values have the following meaning:
      +NONE - Disables VSAM batch logging.
      +REDO - Enables VSAM batch logging.
      +UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
      +ALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.
      +Example: --frlog ALL

      +

      Allowed values: NONE, UNDO, ALL, REDO

      +
    • +
    +
  • +
  • +

    --log-replicate | --lrp (string)

    +
      +
    • +

      Specify 'Y' to enable VSAM replication for this data set.
      +Example: --lrp y

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
  • +

    --log-stream-id | --lsi (string)

    +
      +
    • Specifies the 1- to 26-character name of the forward recovery log stream.
      +Example: --lsi LOGSTRA
    • +
    +
  • +
  • +

    --rls-enable | --rls | --re (string)

    +
      +
    • +

      Specify 'N' to disable VSAM record-level sharing.
      +Default value: y
      +Example: --rls n

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a ESDS with default option values and mandatory options:

    +
      +
    • zowe file-master-plus create vsam-esds fmmvs.test.dsname --mrs 160
    • +
    +
  • +
  • +

    Creating a ESDS with options:

    +
      +
    • zowe file-master-plus create vsam-esds fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed 2025-09-27
    • +
    +
  • +
  • +

    Creating a RLS enabled ESDS with logging options:

    +
      +
    • zowe file-master-plus create vsam-esds fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --rls y -l all --lsi loga --lrp y --fr ALL
    • +
    +
  • +
  • +

    Creating a ESDS data set like a model ESDS data set:

    +
      +
    • zowe file-master-plus create vsam-esds fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a ESDS like a model ESDS data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create vsam-esds fmmvs.test.dsname --model fmmvs.model.dsname --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed p
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-ksds.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-ksds.html new file mode 100644 index 0000000000..cc0b2bff04 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-ksds.html @@ -0,0 +1,502 @@ + + + + +file-master-plus create vsam-ksds + + +
+

zowefile-master-pluscreatevsam-ksds

+

Create a key-sequenced data set (KSDS) Virtual Storage Access Method (VSAM) data set.

+

Usage

+

zowe file-master-plus create vsam-ksds <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model KSDS (key-sequenced VSAM data set) for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --keys-position | --kp (number)

    +
      +
    • Specifies the position of the key within the base cluster.
      +This parameter is mandatory unless a model data set is specified.
      +Example: --kp 1
    • +
    +
  • +
  • +

    --keys-length | --kl (number)

    +
      +
    • Specifies the length of the key within the base cluster.
      +This parameter is mandatory unless a model data set is specified.
      +Example: --kl 7
    • +
    +
  • +
  • +

    --maximum-record-size | --mrs (number)

    +
      +
    • Specifies the maximum length of data records.
      +This parameter is mandatory unless a model data set is specified.
      +Example: --mrs 180
    • +
    +
  • +
  • +

    --average-record-size | --ars (number)

    +
      +
    • Specifies the average length of data records.
      +If this parameter is not specified then it is set to the same as the maximum-record-size option.
      +Example: --ars 110
    • +
    +
  • +
  • +

    --data-dsname | --ddsn (string)

    +
      +
    • Specifies the data set name of the data VSAM component.
      +If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
      +Example: --ddsn fmmvs.vsam.ksds.data
    • +
    +
  • +
  • +

    --data-control-interval-size | --dcis (number)

    +
      +
    • Specifies the size of the Control Interval for the data VSAM component.
      +Default value: 20480
      +Example: --dcis 3584
    • +
    +
  • +
  • +

    --data-space-units | --dsu (string)

    +
      +
    • +

      Specifies the space allocation unit for data vsam component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --dsu rec

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --data-primary-space | --dps (number)

    +
      +
    • Specifies the primary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 18
      +Example: --dps 3
    • +
    +
  • +
  • +

    --data-secondary-space | --dss (number)

    +
      +
    • Specifies the secondary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 3
      +Example: --dss 5
    • +
    +
  • +
  • +

    --data-volume | --dv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the data VSAM component.
      +Example: -dv vol002
    • +
    +
  • +
  • +

    --index-dsname | --idsn (string)

    +
      +
    • Specifies the data set name of the index VSAM component.
      +If this parameter is not specified then it is set to the cluster name with ‘.INDEX’ appended.
      +Example: --ddsn fmmvs.vsam.ksds.index
    • +
    +
  • +
  • +

    --index-control-interval-size | --icis (number)

    +
      +
    • Specifies the size of Control Interval for index VSAM component.
      +Default value: 512
      +Example: --icis 3584
    • +
    +
  • +
  • +

    --index-space-units | --isu (string)

    +
      +
    • +

      Specifies the space allocation unit for index VSAM component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --isu cyl

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --index-primary-space | --ips (number)

    +
      +
    • Specifies primary space allocation unit for index VSAM component.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ips 3
    • +
    +
  • +
  • +

    --index-secondary-space | --iss (number)

    +
      +
    • Specifies secondary space allocation unit for index VSAM component.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --iss 5
    • +
    +
  • +
  • +

    --index-volume | --iv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the index VSAM component.
      +Example: -iv vol002
    • +
    +
  • +
  • +

    --buffer-space | --bs (number)

    +
      +
    • Specifies the minimum buffer space to allocate when this VSAM file is accessed.
      +Example: --bs 37376
    • +
    +
  • +
  • +

    --erase | -e (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
      +Default value: n
      +Example: -e y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --load-restartable | --lr (string)

    +
      +
    • +

      Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
      +Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
      +Default value: n
      +Example: -lr y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --reuse | -r (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.
      +Default value: n
      +Example: -r y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --spanned | -s (string)

    +
      +
    • +

      Indicates whether VSAM file was allocated with the SPANNED parameter indicating that data records larger than a control interval can span multiple control intervals.
      +Default value: n
      +Example: -s y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --write-check | --wc (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.
      +Default value: n
      +Example: --wc y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --control-interval-freespace-percentage | --cifp (number)

    +
      +
    • Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
      +Example: --cifp 10
    • +
    +
  • +
  • +

    --control-area-freespace-percentage | --cafp (number)

    +
      +
    • Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
      +Example: --cafp 10
    • +
    +
  • +
  • +

    --cross-region-share-option | --crso (number)

    +
      +
    • +

      Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
      +The allowed values have the following meaning:
      +1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
      +2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 1
      +Example: --crso 2

      +

      Allowed values: 1, 2, 3, 4

      +
    • +
    +
  • +
  • +

    --cross-system-share-option | --csso (number)

    +
      +
    • +

      Specifies how the file can be shared among systems.
      +The allowed values have the following meaning:
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 3
      +Example: --csso 4

      +

      Allowed values: 3, 4

      +
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
  • +

    --log | -l (string)

    +
      +
    • +

      When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
      +Example: --log ALL

      +

      Allowed values: NONE, UNDO, ALL

      +
    • +
    +
  • +
  • +

    --frlog | --fr (string)

    +
      +
    • +

      Specifies the type of VSAM batch logging to perform for this VSAM data set.
      +The allowed values have the following meaning:
      +NONE - Disables VSAM batch logging.
      +REDO - Enables VSAM batch logging.
      +UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
      +ALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.
      +Example: --frlog ALL

      +

      Allowed values: NONE, UNDO, ALL, REDO

      +
    • +
    +
  • +
  • +

    --log-replicate | --lrp (string)

    +
      +
    • +

      Specify 'Y' to enable VSAM replication for this data set.
      +Example: --lrp y

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
  • +

    --log-stream-id | --lsi (string)

    +
      +
    • Specifies the 1- to 26-character name of the forward recovery log stream.
      +Example: --lsi LOGSTRA
    • +
    +
  • +
  • +

    --rls-enable | --rls | --re (string)

    +
      +
    • +

      Specify 'N' to disable VSAM record-level sharing.
      +Default value: y
      +Example: --rls n

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a KSDS with default option values and mandatory options:

    +
      +
    • zowe file-master-plus create vsam-ksds fmmvs.test.dsname --kp 1 --kl 7 --mrs 160
    • +
    +
  • +
  • +

    Creating a KSDS with options:

    +
      +
    • zowe file-master-plus create vsam-ksds fmmvs.test.dsname --kp 1 --kl 7 --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y -s n --ed 2025-09-27
    • +
    +
  • +
  • +

    Creating a RLS enabled KSDS with logging options:

    +
      +
    • zowe file-master-plus create vsam-ksds fmmvs.test.dsname --kp 1 --kl 7 --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y -s n --rls y -l all --lsi loga --lrp y --fr ALL
    • +
    +
  • +
  • +

    Creating a KSDS data set like a model KSDS data set:

    +
      +
    • zowe file-master-plus create vsam-ksds fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a KSDS like a model KSDS data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create vsam-ksds fmmvs.test.dsname --model fmmvs.model.dsname --kp 1 --kl 7 --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed p
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-lds.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-lds.html new file mode 100644 index 0000000000..f7a93c3f88 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-lds.html @@ -0,0 +1,342 @@ + + + + +file-master-plus create vsam-lds + + +
+

zowefile-master-pluscreatevsam-lds

+

Create linear data set (LDS) Virtual Storage Access Method (VSAM) data set.

+

Usage

+

zowe file-master-plus create vsam-lds <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model LDS (Linear VSAM data set) for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --data-dsname | --ddsn (string)

    +
      +
    • Specifies the data set name of the data VSAM component.
      +If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
      +Example: --ddsn fmmvs.vsam.esds.data
    • +
    +
  • +
  • +

    --data-control-interval-size | --dcis (number)

    +
      +
    • Specifies the size of the Control Interval for the data VSAM component.
      +Default value: 4096
      +Example: --dcis 3584
    • +
    +
  • +
  • +

    --data-space-units | --dsu (string)

    +
      +
    • +

      Specifies the space allocation unit for data vsam component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --dsu rec

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --data-primary-space | --dps (number)

    +
      +
    • Specifies the primary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 18
      +Example: --dps 3
    • +
    +
  • +
  • +

    --data-secondary-space | --dss (number)

    +
      +
    • Specifies the secondary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 3
      +Example: --dss 5
    • +
    +
  • +
  • +

    --data-volume | --dv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the data VSAM component.
      +Example: -dv vol002
    • +
    +
  • +
  • +

    --buffer-space | --bs (number)

    +
      +
    • Specifies the minimum buffer space to allocate when this VSAM file is accessed.
      +Example: --bs 37376
    • +
    +
  • +
  • +

    --erase | -e (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
      +Default value: n
      +Example: -e y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --load-restartable | --lr (string)

    +
      +
    • +

      Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
      +Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
      +Default value: n
      +Example: -lr y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --reuse | -r (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.
      +Default value: n
      +Example: -r y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --write-check | --wc (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.
      +Default value: n
      +Example: --wc y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --control-interval-freespace-percentage | --cifp (number)

    +
      +
    • Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
      +Example: --cifp 10
    • +
    +
  • +
  • +

    --control-area-freespace-percentage | --cafp (number)

    +
      +
    • Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
      +Example: --cafp 10
    • +
    +
  • +
  • +

    --cross-region-share-option | --crso (number)

    +
      +
    • +

      Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
      +The alloweThe allowed values have the following meaning:
      +1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
      +2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 1
      +Example: --crso 2

      +

      Allowed values: 1, 2, 3, 4

      +
    • +
    +
  • +
  • +

    --cross-system-share-option | --csso (number)

    +
      +
    • +

      Specifies how the file can be shared among systems.
      +The allowed values have the following meaning:
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 3
      +Example: --csso 4

      +

      Allowed values: 3, 4

      +
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a LDS with default option values:

    +
      +
    • zowe file-master-plus create vsam-lds fmmvs.test.dsname
    • +
    +
  • +
  • +

    Creating a LDS with options:

    +
      +
    • zowe file-master-plus create vsam-lds fmmvs.test.dsname --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed p
    • +
    +
  • +
  • +

    Creating a LDS data set like a model LDS data set:

    +
      +
    • zowe file-master-plus create vsam-lds fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a LDS like a model LDS data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create vsam-lds fmmvs.test.dsname --model fmmvs.model.dsname --wc y --bs 37376 --crso 3 --csso 4 --ed 2025-09-27
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-rrds.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-rrds.html new file mode 100644 index 0000000000..5b69a584c9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-rrds.html @@ -0,0 +1,409 @@ + + + + +file-master-plus create vsam-rrds + + +
+

zowefile-master-pluscreatevsam-rrds

+

Create a relative-record data set (RRDS) Virtual Storage Access Method (VSAM) data set.

+

Usage

+

zowe file-master-plus create vsam-rrds <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model RRDS (relative-record VSAM data set) for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --maximum-record-size | --mrs (number)

    +
      +
    • Specifies the maximum length of data records.
      +This parameter is mandatory unless a model data set is specified.
      +Example: --mrs 180
    • +
    +
  • +
  • +

    --data-dsname | --ddsn (string)

    +
      +
    • Specifies the data set name of the data VSAM component.
      +If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
      +Example: --ddsn fmmvs.vsam.rrds.data
    • +
    +
  • +
  • +

    --data-control-interval-size | --dcis (number)

    +
      +
    • Specifies the size of the Control Interval for the data VSAM component.
      +Default value: 20480
      +Example: --dcis 3584
    • +
    +
  • +
  • +

    --data-space-units | --dsu (string)

    +
      +
    • +

      Specifies the space allocation unit for data vsam component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --dsu rec

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --data-primary-space | --dps (number)

    +
      +
    • Specifies the primary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 18
      +Example: --dps 3
    • +
    +
  • +
  • +

    --data-secondary-space | --dss (number)

    +
      +
    • Specifies the secondary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 3
      +Example: --dss 5
    • +
    +
  • +
  • +

    --data-volume | --dv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the data VSAM component.
      +Example: -dv vol002
    • +
    +
  • +
  • +

    --buffer-space | --bs (number)

    +
      +
    • Specifies the minimum buffer space to allocate when this VSAM file is accessed.
      +Example: --bs 37376
    • +
    +
  • +
  • +

    --erase | -e (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
      +Default value: n
      +Example: -e y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --load-restartable | --lr (string)

    +
      +
    • +

      Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
      +Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
      +Default value: n
      +Example: -lr y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --reuse | -r (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.
      +Default value: n
      +Example: -r y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --write-check | --wc (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.
      +Default value: n
      +Example: --wc y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --control-interval-freespace-percentage | --cifp (number)

    +
      +
    • Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
      +Example: --cifp 10
    • +
    +
  • +
  • +

    --control-area-freespace-percentage | --cafp (number)

    +
      +
    • Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
      +Example: --cafp 10
    • +
    +
  • +
  • +

    --cross-region-share-option | --crso (number)

    +
      +
    • +

      Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
      +The allowed values have the following meaning:
      +1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
      +2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 1
      +Example: --crso 2

      +

      Allowed values: 1, 2, 3, 4

      +
    • +
    +
  • +
  • +

    --cross-system-share-option | --csso (number)

    +
      +
    • +

      Specifies how the file can be shared among systems.
      +The allowed values have the following meaning:
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 3
      +Example: --csso 4

      +

      Allowed values: 3, 4

      +
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
  • +

    --log | -l (string)

    +
      +
    • +

      When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
      +Example: --log ALL

      +

      Allowed values: NONE, UNDO, ALL

      +
    • +
    +
  • +
  • +

    --frlog | --fr (string)

    +
      +
    • +

      Specifies the type of VSAM batch logging to perform for this VSAM data set.
      +The allowed values have the following meaning:
      +NONE - Disables VSAM batch logging.
      +REDO - Enables VSAM batch logging.
      +UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
      +ALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.
      +Example: --frlog ALL

      +

      Allowed values: NONE, UNDO, ALL, REDO

      +
    • +
    +
  • +
  • +

    --log-replicate | --lrp (string)

    +
      +
    • +

      Specify 'Y' to enable VSAM replication for this data set.
      +Example: --lrp y

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
  • +

    --log-stream-id | --lsi (string)

    +
      +
    • Specifies the 1- to 26-character name of the forward recovery log stream.
      +Example: --lsi LOGSTRA
    • +
    +
  • +
  • +

    --rls-enable | --rls | --re (string)

    +
      +
    • +

      Specify 'N' to disable VSAM record-level sharing.
      +Default value: y
      +Example: --rls n

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a RRDS with default option values and mandatory options:

    +
      +
    • zowe file-master-plus create vsam-rrds fmmvs.test.dsname --mrs 160
    • +
    +
  • +
  • +

    Creating a RRDS with options:

    +
      +
    • zowe file-master-plus create vsam-rrds fmmvs.test.dsname --mrs 160 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed p
    • +
    +
  • +
  • +

    Creating a RLS enabled RRDS with logging options:

    +
      +
    • zowe file-master-plus create vsam-rrds fmmvs.test.dsname --mrs 160 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed p --rls y -l all --lsi loga --lrp y --fr ALL
    • +
    +
  • +
  • +

    Creating a RRDS data set like a model RRDS data set:

    +
      +
    • zowe file-master-plus create vsam-rrds fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a RRDS like a model RRDS data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create vsam-rrds fmmvs.test.dsname --model fmmvs.model.dsname --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed 2025-09-27
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-vrrds.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-vrrds.html new file mode 100644 index 0000000000..3394be22ef --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_create_vsam-vrrds.html @@ -0,0 +1,475 @@ + + + + +file-master-plus create vsam-vrrds + + +
+

zowefile-master-pluscreatevsam-vrrds

+

Create a variable-length relative-record data set (VRRDS) Virtual Storage Access Method (VSAM) data set.

+

Usage

+

zowe file-master-plus create vsam-vrrds <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --model | -m (string)

    +
      +
    • Specifies the name of a model VRRDS (variable-length relative-record VSAM data set) for allocating parameters.
      +The parameters of the model data set override all defaults.
      +Example: -m fmmvs.model.dsname
    • +
    +
  • +
  • +

    --maximum-record-size | --mrs (number)

    +
      +
    • Specifies the maximum length of data records.
      +This parameter is mandatory unless a model data set is specified and it should be greater than the average record size.
      +Example: --mrs 180
    • +
    +
  • +
  • +

    --average-record-size | --ars (number)

    +
      +
    • Specifies the average length of data records.
      +This parameter is mandatory unless a model data set is specified and it should be less than the maximum record size.
      +Example: --ars 110
    • +
    +
  • +
  • +

    --data-dsname | --ddsn (string)

    +
      +
    • Specifies the data set name of the data VSAM component.
      +If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
      +Example: --ddsn fmmvs.vsam.ksds.data
    • +
    +
  • +
  • +

    --data-control-interval-size | --dcis (number)

    +
      +
    • Specifies the size of the Control Interval for the data VSAM component.
      +Default value: 20480
      +Example: --dcis 3584
    • +
    +
  • +
  • +

    --data-space-units | --dsu (string)

    +
      +
    • +

      Specifies the space allocation unit for data vsam component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --dsu rec

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --data-primary-space | --dps (number)

    +
      +
    • Specifies the primary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 18
      +Example: --dps 3
    • +
    +
  • +
  • +

    --data-secondary-space | --dss (number)

    +
      +
    • Specifies the secondary space allocation unit for the data VSAM component.
      +Allowed values: 1-16777215
      +Default value: 3
      +Example: --dss 5
    • +
    +
  • +
  • +

    --data-volume | --dv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the data VSAM component.
      +Example: -dv vol002
    • +
    +
  • +
  • +

    --index-dsname | --idsn (string)

    +
      +
    • Specifies the data set name of the index VSAM component.
      +If this parameter is not specified then it is set to the cluster name with ‘.INDEX’ appended.
      +Example: --ddsn fmmvs.vsam.ksds.index
    • +
    +
  • +
  • +

    --index-control-interval-size | --icis (number)

    +
      +
    • Specifies the size of Control Interval for index VSAM component.
      +Default value: 512
      +Example: --icis 3584
    • +
    +
  • +
  • +

    --index-space-units | --isu (string)

    +
      +
    • +

      Specifies the space allocation unit for index VSAM component.
      +The allowed values have the following meaning:
      +TRK - Tracks
      +CYL - Cylinders
      +REC - Records
      +K - Kilobytes
      +M - Megabytes
      +Default value: TRK
      +Example: --isu cyl

      +

      Allowed values: TRK, CYL, REC, K, M

      +
    • +
    +
  • +
  • +

    --index-primary-space | --ips (number)

    +
      +
    • Specifies primary space allocation unit for index VSAM component.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --ips 3
    • +
    +
  • +
  • +

    --index-secondary-space | --iss (number)

    +
      +
    • Specifies secondary space allocation unit for index VSAM component.
      +Allowed values: 1-16777215
      +Default value: 1
      +Example: --iss 5
    • +
    +
  • +
  • +

    --index-volume | --iv (array)

    +
      +
    • Specifies a disk volume or specific tapes for the data VSAM component.
      +Example: -iv vol002
    • +
    +
  • +
  • +

    --buffer-space | --bs (number)

    +
      +
    • Specifies the minimum buffer space to allocate when this VSAM file is accessed.
      +Example: --bs 37376
    • +
    +
  • +
  • +

    --erase | -e (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
      +Default value: n
      +Example: -e y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --load-restartable | --lr (string)

    +
      +
    • +

      Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
      +Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
      +Default value: n
      +Example: -lr y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --reuse | -r (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.
      +Default value: n
      +Example: -r y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --write-check | --wc (string)

    +
      +
    • +

      Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.
      +Default value: n
      +Example: --wc y

      +

      Allowed values: y, n

      +
    • +
    +
  • +
  • +

    --control-interval-freespace-percentage | --cifp (number)

    +
      +
    • Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
      +Example: --cifp 10
    • +
    +
  • +
  • +

    --control-area-freespace-percentage | --cafp (number)

    +
      +
    • Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
      +Example: --cafp 10
    • +
    +
  • +
  • +

    --cross-region-share-option | --crso (number)

    +
      +
    • +

      Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
      +The allowed values have the following meaning:
      +1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
      +2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 1
      +Example: --crso 2

      +

      Allowed values: 1, 2, 3, 4

      +
    • +
    +
  • +
  • +

    --cross-system-share-option | --csso (number)

    +
      +
    • +

      Specifies how the file can be shared among systems.
      +The allowed values have the following meaning:
      +3 - The data set can be fully shared by any number of users.
      +4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
      +Default value: 3
      +Example: --csso 4

      +

      Allowed values: 3, 4

      +
    • +
    +
  • +
  • +

    --expiration-date | --ed (string)

    +
      +
    • Specifies the expiration date after which the data set can be deleted.
      +Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
      +Example: --ed 2032-07-31
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • Specifies the storage class.
      +Example: --sc scl002
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • Specifies the management class.
      +Example: --mc mcl002
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • Specifies the data class.
      +Example: --dc dcl002
    • +
    +
  • +
  • +

    --log | -l (string)

    +
      +
    • +

      When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
      +Example: --log ALL

      +

      Allowed values: NONE, UNDO, ALL

      +
    • +
    +
  • +
  • +

    --frlog | --fr (string)

    +
      +
    • +

      Specifies the type of VSAM batch logging to perform for this VSAM data set.
      +The allowed values have the following meaning:
      +NONE - Disables VSAM batch logging.
      +REDO - Enables VSAM batch logging.
      +UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
      +ALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.
      +Example: --frlog ALL

      +

      Allowed values: NONE, UNDO, ALL, REDO

      +
    • +
    +
  • +
  • +

    --log-replicate | --lrp (string)

    +
      +
    • +

      Specify 'Y' to enable VSAM replication for this data set.
      +Example: --lrp y

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
  • +

    --log-stream-id | --lsi (string)

    +
      +
    • Specifies the 1- to 26-character name of the forward recovery log stream.
      +Example: --lsi LOGSTRA
    • +
    +
  • +
  • +

    --rls-enable | --rls | --re (string)

    +
      +
    • +

      Specify 'N' to disable VSAM record-level sharing.
      +Default value: y
      +Example: --rls n

      +

      Allowed values: Y, N

      +
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Creating a VRRDS with default option values and mandatory options:

    +
      +
    • zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --mrs 160
    • +
    +
  • +
  • +

    Creating a VRRDS with options:

    +
      +
    • zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y --ed 2025-09-27
    • +
    +
  • +
  • +

    Creating a RLS enabled VRRDS with logging options:

    +
      +
    • zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y --rls y -l all --lsi loga --lrp y --fr ALL
    • +
    +
  • +
  • +

    Creating a VRRDS data set like a model VRRDS data set:

    +
      +
    • zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --model fmmvs.model.dsname
    • +
    +
  • +
  • +

    Creating a VRRDS like a model VRRDS data set and overriding the parameters with options:

    +
      +
    • zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --model fmmvs.model.dsname --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed p
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_delete.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_delete.html new file mode 100644 index 0000000000..420932b4a5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_delete.html @@ -0,0 +1,20 @@ + + + + +file-master-plus delete + + +
+

zowefile-master-plusdelete

+

Permanently deletes a data set.

+

Usage

+

zowe file-master-plus delete <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_delete_data-set.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_delete_data-set.html new file mode 100644 index 0000000000..fdbb615826 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_delete_data-set.html @@ -0,0 +1,131 @@ + + + + +file-master-plus delete data-set + + +
+

zowefile-master-plusdeletedata-set

+

Permanently deletes a data set.
+It supports all data set types that are supported by File Master Plus.

+

Usage

+

zowe file-master-plus delete data-set <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set that you want to delete.
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Deleting a data set:

    +
      +
    • zowe file-master-plus delete data-set fmmvs.dsname
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_populate.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_populate.html new file mode 100644 index 0000000000..03d6befa2e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_populate.html @@ -0,0 +1,21 @@ + + + + +file-master-plus populate + + +
+

zowefile-master-pluspopulate

+

Populate the specified data set with records.
+It supports all data set types that are supported by File Master Plus.

+

Usage

+

zowe file-master-plus populate <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_populate_data-set.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_populate_data-set.html new file mode 100644 index 0000000000..9a1b1ceb01 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_populate_data-set.html @@ -0,0 +1,166 @@ + + + + +file-master-plus populate data-set + + +
+

zowefile-master-pluspopulatedata-set

+

Populate a specific data set with records.
+The layout of the records to add are described by a Cobol or PL/I copybook.

+

Usage

+

zowe file-master-plus populate data-set <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Specifies the name of the data set to populate.
    • +
    +
  • +
+

Options

+
    +
  • +

    --member | -m (string)

    +
      +
    • Specifies name of the member.
      +Note: Used only if the specified data set is a PDS or PDSE.
      +Example: -m member1.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --layout-member | --lm (string)

    +
      +
    • Specifies the name of the Cobol or PL/I copybook.
      +Example: --lm testlay.
    • +
    +
  • +
  • +

    --layout-data-set | --lds (string)

    +
      +
    • Specifies the name of the data set that contains the layout member.
      +Example: --lds fmmvs.layout.dataset.
    • +
    +
  • +
  • +

    --data | -d (string)

    +
      +
    • Specifies path of the .txt/.json file of the data stream. Ensure the data stream is an array in JSON format represented by a layout data set and its member.
      +Example: -d ../instream/data1.txt
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Populating a data set:

    +
      +
    • zowe file-master-plus populate data-set fmmvs.dsname --lds fmmvs.layout.dataset --lm testlay --data ../instream/data1.txt
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_rename.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_rename.html new file mode 100644 index 0000000000..8928174d32 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_rename.html @@ -0,0 +1,20 @@ + + + + +file-master-plus rename + + +
+

zowefile-master-plusrename

+

Rename the specified data set.

+

Usage

+

zowe file-master-plus rename <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_file-master-plus_rename_data-set.html b/static/v2.15.x/web_help/docs/zowe_file-master-plus_rename_data-set.html new file mode 100644 index 0000000000..fe06eec0d7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_file-master-plus_rename_data-set.html @@ -0,0 +1,158 @@ + + + + +file-master-plus rename data-set + + +
+

zowefile-master-plusrenamedata-set

+

Rename a data set.
+It supports all data set types that are supported by File Master Plus.

+

Usage

+

zowe file-master-plus rename data-set <old> <new> [options]

+

Positional Arguments

+
    +
  • +

    old (string)

    +
      +
    • Specifies the name of the data set that you want to rename.
    • +
    +
  • +
  • +

    new (string)

    +
      +
    • Specifies the new name of the data set.
    • +
    +
  • +
+

Options

+
    +
  • +

    --vsam-component | --vsamc (string)

    +
      +
    • +

      Rename the data and index components of a VSAM cluster if they share the cluster name.
      +Note: Used only if the target data set is a VSAM cluster.
      +Example: --vsamc y.

      +

      Default value: n
      +Allowed values: y, n

      +
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --fmp-profile | --fmp-p (string)

    +
      +
    • The name of a (fmp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Renaming a data set:

    +
      +
    • zowe file-master-plus rename data-set fmmvs.old.dsname fmmvs.new.dsname
    • +
    +
  • +
  • +

    Renaming a VSAM data set along with its components:

    +
      +
    • zowe file-master-plus rename data-set fmmvs.oldvsam.dsname fmmvs.newvsam.dsname --vsamc y
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms.html b/static/v2.15.x/web_help/docs/zowe_idms.html new file mode 100644 index 0000000000..7d510bb722 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms.html @@ -0,0 +1,21 @@ + + + + +idms + + +
+

zoweidms

+

IDMS plug-in for listing real-time monitor statistics and information, viewing DC log messages, and issuing DCMT and DCUF commands

+

Usage

+

zowe idms <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • issue | iss - Issue IDMS DCMT and DCUF commands
  • +
  • list | ls - List available datasources, active IDMS systems, log messages, user tasks, and transaction details
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_issue.html b/static/v2.15.x/web_help/docs/zowe_idms_issue.html new file mode 100644 index 0000000000..76bf01cdfa --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_issue.html @@ -0,0 +1,28 @@ + + + + +idms issue + + +
+

zoweidmsissue

+

Issues IDMS DCMT and DCUF commands

+

Usage

+

zowe idms issue <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-display.html b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-display.html new file mode 100644 index 0000000000..7e1c8ab8c5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-display.html @@ -0,0 +1,172 @@ + + + + +idms issue dcmt-display + + +
+

zoweidmsissuedcmt-display

+

Execute a DCMT DISPLAY command

+

Usage

+

zowe idms issue dcmt-display [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT DISPLAY command arguments
    • +
    +
  • +
+

Options

+
    +
  • +

    --broadcast | -b (string)

    +
      +
    • Broadcast parameters used if the system is part of a data sharing group
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcmt display task send' command to display information associated with the SEND task:

    +
      +
    • zowe idms issue dcmt-display --args "task send"
    • +
    +
  • +
  • +

    Issues a 'dcmt display active programs' command with an IDMS profile and data source to override the default:

    +
      +
    • zowe idms issue dcmt-display --args "active programs" --idms-profile myprofile2 --datasource sysdemo
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-help.html b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-help.html new file mode 100644 index 0000000000..5274678fbc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-help.html @@ -0,0 +1,169 @@ + + + + +idms issue dcmt-help + + +
+

zoweidmsissuedcmt-help

+

Execute a DCMT HELP command

+

Usage

+

zowe idms issue dcmt-help [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT HELP command arguments
    • +
    +
  • +
  • +

    --broadcast | -b (string)

    +
      +
    • Broadcast parameters used if the system is part of a data sharing group
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcmt help' command to display a summary of the syntax for DCMT commands:

    +
      +
    • zowe idms issue dcmt-help
    • +
    +
  • +
  • +

    Issues a 'dcmt help task' command with a data source to override the default:

    +
      +
    • zowe idms issue dcmt-help --args "task" --datasource sysdemo
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-quiesce.html b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-quiesce.html new file mode 100644 index 0000000000..8d94328b42 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-quiesce.html @@ -0,0 +1,163 @@ + + + + +idms issue dcmt-quiesce + + +
+

zoweidmsissuedcmt-quiesce

+

Execute a DCMT QUIESCE command

+

Usage

+

zowe idms issue dcmt-quiesce [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT QUIESCE command arguments. Specifies the DCMT QUIESCE target area, segment, or DBNAME
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues the command 'dcmt quiesce dbname empdemo id 1' which quiesces all areas associated with segments included in the EMPDEMO database and assigns the operation to dcmt-id 1:

    +
      +
    • zowe idms issue dcmt-quiesce --args "dbname empdemo id 1"
    • +
    +
  • +
  • +

    Issues the command 'dcmt quiesce area emp* id 2' which quiesces all areas whose segment name begins with EMP and assigns the operation to dcmt-id 2:

    +
      +
    • zowe idms issue dcmt-quiesce --args "area emp* id 2"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-shutdown.html b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-shutdown.html new file mode 100644 index 0000000000..0791c1d70f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-shutdown.html @@ -0,0 +1,163 @@ + + + + +idms issue dcmt-shutdown + + +
+

zoweidmsissuedcmt-shutdown

+

Execute a DCMT SHUTDOWN command

+

Usage

+

zowe idms issue dcmt-shutdown [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT SHUTDOWN command arguments. NOPROMPT must be specified. IMMEDIATE is optional
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcmt shutdown noprompt' command to shut down the DC/UCF system while allowing all active tasks and external run units to terminate normally first:

    +
      +
    • zowe idms issue dcmt-shutdown --args "noprompt"
    • +
    +
  • +
  • +

    Issues a 'dcmt shutdown noprompt immediate' command to immediately shut down the DC/UCF system, abending all active tasks and external run units with code SHUT:

    +
      +
    • zowe idms issue dcmt-shutdown --args "noprompt immediate"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-statistics.html b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-statistics.html new file mode 100644 index 0000000000..40fc44850b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-statistics.html @@ -0,0 +1,163 @@ + + + + +idms issue dcmt-statistics + + +
+

zoweidmsissuedcmt-statistics

+

Execute a DCMT STATISTICS command

+

Usage

+

zowe idms issue dcmt-statistics [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT STATISTICS command arguments. Can specify ROLL to reset statistics to zero after writing them
    • +
    +
  • +
  • +

    --broadcast | -b (string)

    +
      +
    • Broadcast parameters used if the system is part of a data sharing group
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcmt write statistics roll' command to write the current system and line statistics and histograms to the log file and then reset their values to zero:

    +
      +
    • zowe idms issue dcmt-statistics --args "roll"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-test.html b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-test.html new file mode 100644 index 0000000000..de7f336cf6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-test.html @@ -0,0 +1,167 @@ + + + + +idms issue dcmt-test + + +
+

zoweidmsissuedcmt-test

+

Execute a DCMT TEST command. Obtains diagnostic information for Broadcom technical support personnel.

+

The DCMT TEST command is used for debugging and diagnostic purposes only. Use it only when told to do so by IDMS technical support personnel. It is enabled only if certain CSA test flags are turned on

+

Usage

+

zowe idms issue dcmt-test [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT TEST command arguments. Specifies which debugging options to use
    • +
    +
  • +
+

Options

+
    +
  • +

    --broadcast | -b (string)

    +
      +
    • Broadcast parameters used if the system is part of a data sharing group
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcmt test debug options' command, with 'debug options' being the options provided by IDMS technical support:

    +
      +
    • zowe idms issue dcmt-test --args "debug options"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-vary.html b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-vary.html new file mode 100644 index 0000000000..cf3f2665d9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcmt-vary.html @@ -0,0 +1,172 @@ + + + + +idms issue dcmt-vary + + +
+

zoweidmsissuedcmt-vary

+

Execute a DCMT VARY command

+

Usage

+

zowe idms issue dcmt-vary [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --args (string)

    +
      +
    • DCMT VARY command arguments
    • +
    +
  • +
+

Options

+
    +
  • +

    --broadcast | -b (string)

    +
      +
    • Broadcast parameters used if the system is part of a data sharing group
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcmt vary task signon enabled' command to enable the SIGNON task:

    +
      +
    • zowe idms issue dcmt-vary --args "task signon enabled"
    • +
    +
  • +
  • +

    Issues a 'dcmt vary journal swap' command with an IDMS profile and data source to override the default:

    +
      +
    • zowe idms issue dcmt-vary --args "journal swap" --idms-profile myprofile2 --datasource sysdemo
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_issue_dcuf-help.html b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcuf-help.html new file mode 100644 index 0000000000..e29e71d8c0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcuf-help.html @@ -0,0 +1,148 @@ + + + + +idms issue dcuf-help + + +
+

zoweidmsissuedcuf-help

+

Execute a DCUF HELP command

+

Usage

+

zowe idms issue dcuf-help [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcuf help' command to display a list of DCUF commands and parameters. Note: Only SHOW commands are supported by the CLI:

    +
      +
    • zowe idms issue dcuf-help
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_issue_dcuf-show.html b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcuf-show.html new file mode 100644 index 0000000000..26a732d4df --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_issue_dcuf-show.html @@ -0,0 +1,172 @@ + + + + +idms issue dcuf-show + + +
+

zoweidmsissuedcuf-show

+

Execute a DCUF SHOW command

+

Usage

+

zowe idms issue dcuf-show [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --args (string)

    +
      +
    • DCUF SHOW command arguments
    • +
    +
  • +
+

Options

+
    +
  • +

    --broadcast | -b (string)

    +
      +
    • Broadcast parameters used if the system is part of a data sharing group
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a 'dcuf show tables' command to display a list of the available tables:

    +
      +
    • zowe idms issue dcuf-show --args "tables"
    • +
    +
  • +
  • +

    Issues a 'dcuf show user <username>' command to display information about a specific user:

    +
      +
    • zowe idms issue dcuf-show --args "user username"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_list.html b/static/v2.15.x/web_help/docs/zowe_idms_list.html new file mode 100644 index 0000000000..8a446fe8e1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_list.html @@ -0,0 +1,24 @@ + + + + +idms list + + +
+

zoweidmslist

+

Lists available datasources, real-time monitor statistics information, log messages, active user tasks, and transaction details

+

Usage

+

zowe idms list <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_list_datasources.html b/static/v2.15.x/web_help/docs/zowe_idms_list_datasources.html new file mode 100644 index 0000000000..35a9792802 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_list_datasources.html @@ -0,0 +1,163 @@ + + + + +idms list datasources + + +
+

zoweidmslistdatasources

+

Lists data sources defined to the IDMS REST API

+

Usage

+

zowe idms list datasources [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Options

+
    +
  • +

    --datasourcename | --dsn (string)

    +
      +
    • Specifies a specific datasource to view the definition of
    • +
    +
  • +
  • +

    --all | -a (boolean)

    +
      +
    • Lists each datasource defined to the IDMS REST API
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Lists all data sources defined to the IDMS Rest API:

    +
      +
    • zowe idms list datasources --all
    • +
    +
  • +
  • +

    Lists a single IDMS data source identified by the data source name:

    +
      +
    • zowe idms list datasources --dsn SYSDEMO
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_list_log.html b/static/v2.15.x/web_help/docs/zowe_idms_list_log.html new file mode 100644 index 0000000000..1fa910308c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_list_log.html @@ -0,0 +1,216 @@ + + + + +idms list log + + +
+

zoweidmslistlog

+

Lists log messages based on the search options provided

+

Usage

+

zowe idms list log [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --start-time | --st (string)

    +
      +
    • +

      Start time of the first log message

      +

      Format: 'YYYY-MM-DD HH:mm:ss[.SSSSSS]'

      +
    • +
    +
  • +
  • +

    --end-time | --et (string)

    +
      +
    • +

      End time of the last log message

      +

      Format: 'YYYY-MM-DD HH:mm:ss[.SSSSSS]'

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --record-type | --rt (string)

    +
      +
    • +

      Type of log records:

      +

      1 - #WTL text line

      +

      2 - User trace text or physical I/O trace text

      +

      3 - User binary trace entries

      +

      4 - Snap or dump text

      +

      5 - Snap or dump binary entries

      +

      Examples: '1,2', '1,4,5', '2'

      +
    • +
    +
  • +
  • +

    --record-identifier | --ri (string)

    +
      +
    • +

      Identifier contained in log messages

      +

      Examples: 'LTE0001,LTVTM011', 'DCSYSTEM', 'SYSTE160'

      +
    • +
    +
  • +
  • +

    --search-text | --stext (string)

    +
      +
    • +

      Text contained in log messages

      +

      Examples: 'DB001108', 'any_text_that_might_exist_in_the_message'

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Lists all the log messages where the time stamps satisfy the start and end time criteria:

    +
      +
    • zowe idms list log --start-time "2020-08-05 09:20:00" --end-time "2020-08-05 10:20:00"
    • +
    +
  • +
  • +

    Lists all the #WTL log messages where 'DB001108' is contained in the log message and where the time stamps satisfy the start and end time criteria:

    +
      +
    • zowe idms list log --start-time "2020-08-05 09:20:00" --end-time "2020-08-05 10:20:00" --record-type 1 --search-text DB001108
    • +
    +
  • +
  • +

    Lists all log messages with the DCSYSTEM record identifier where the time stamps satisfy the start and end time criteria:

    +
      +
    • zowe idms list log --start-time "2020-08-05 08:00:00.001234" --end-time "2020-08-05 13:43:33.26" --record-identifier DCSYSTEM
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_list_systems.html b/static/v2.15.x/web_help/docs/zowe_idms_list_systems.html new file mode 100644 index 0000000000..cef82e6a99 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_list_systems.html @@ -0,0 +1,163 @@ + + + + +idms list systems + + +
+

zoweidmslistsystems

+

Lists either all active IDMS systems on an LPAR or lists information about a specific system if a jobname is provided

+

Usage

+

zowe idms list systems [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Options

+
    +
  • +

    --jobname | -j (string)

    +
      +
    • The job name of the active IDMS system
    • +
    +
  • +
  • +

    --all | -a (boolean)

    +
      +
    • Lists all active systems. This is the default behavior if no job name is provided
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Lists all active IDMS systems on the LPAR where the IDMS REST API service is running:

    +
      +
    • zowe idms list systems --all
    • +
    +
  • +
  • +

    Lists a single active IDMS system identified by the IDMS system job name:

    +
      +
    • zowe idms list systems --jobname SYSDEMO
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_list_transactions.html b/static/v2.15.x/web_help/docs/zowe_idms_list_transactions.html new file mode 100644 index 0000000000..6cc76030d3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_list_transactions.html @@ -0,0 +1,163 @@ + + + + +idms list transactions + + +
+

zoweidmslisttransactions

+

Lists transaction details on a specific IDMS system

+

Usage

+

zowe idms list transactions [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname | -j (string)

    +
      +
    • The job name of the active IDMS system
    • +
    +
  • +
  • +

    --datasourcename | --dsn (string)

    +
      +
    • The data source name of the specified IDMS system
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Lists the transaction details of the IDMS system identified by the IDMS system job name:

    +
      +
    • zowe idms list transactions --jobname SYSDEMO
    • +
    +
  • +
  • +

    Lists the transaction details of the IDMS system identified by the IDMS system job name as JSON formatted data:

    +
      +
    • zowe idms list transactions --jobname SYSDEMO --rfj
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_idms_list_user-tasks.html b/static/v2.15.x/web_help/docs/zowe_idms_list_user-tasks.html new file mode 100644 index 0000000000..a28211af4e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_idms_list_user-tasks.html @@ -0,0 +1,163 @@ + + + + +idms list user-tasks + + +
+

zoweidmslistuser-tasks

+

Lists all active user tasks on a specific IDMS system

+

Usage

+

zowe idms list user-tasks [options]

+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --jobname | -j (string)

    +
      +
    • The job name of the active IDMS system
    • +
    +
  • +
  • +

    --datasourcename | --dsn (string)

    +
      +
    • The data source name of the specified IDMS system
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --idms-profile | --idms-p (string)

    +
      +
    • The name of a (idms) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Lists the active user tasks of the IDMS system identified by the IDMS system job name:

    +
      +
    • zowe idms list user-tasks --jobname SYSDEMO
    • +
    +
  • +
  • +

    Lists the active user tasks of the IDMS system identified by the IDMS system job name as JSON formatted data:

    +
      +
    • zowe idms list user-tasks --jobname SYSDEMO --rfj
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims.html b/static/v2.15.x/web_help/docs/zowe_ims.html new file mode 100644 index 0000000000..bbb716c0a4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims.html @@ -0,0 +1,23 @@ + + + + +ims + + +
+

zoweims

+

Interact with IBM IMS programs and transactions.

+

Usage

+

zowe ims <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_query.html b/static/v2.15.x/web_help/docs/zowe_ims_query.html new file mode 100644 index 0000000000..6689be484d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_query.html @@ -0,0 +1,22 @@ + + + + +ims query + + +
+

zoweimsquery

+

Query application programs, regions or transactions across an IMSplex. The query returns information about application programs, regions and transactions. This command submits a 'QUERY PGM', 'DIS ACT' or 'QUERY TRAN' IMS command and returns the output.

+

Usage

+

zowe ims query <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_query_program.html b/static/v2.15.x/web_help/docs/zowe_ims_query_program.html new file mode 100644 index 0000000000..4a6279e803 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_query_program.html @@ -0,0 +1,234 @@ + + + + +ims query program + + +
+

zoweimsqueryprogram

+

Query an IMS application program.

+

Usage

+

zowe ims query program [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • Specifies the name of the program(s) to query.
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --att (array)

    +
      +
    • +

      Specifies the application program output fields to return.

      +

      Default value: ALL
      +Allowed values: ALL, BMPTYPE, DEFN, DEFNTYPE, DOPT, FP, GLOBAL, IMSID, GPSB, LANG, LOCAL, MODEL, RESIDENT, SCHDTYPE, STATUS, TIMESTAMP, TRANSTAT, EXPORTNEEDED, DB, RTC, TRAN, WORK

      +
    • +
    +
  • +
  • +

    --status | --st (array)

    +
      +
    • +

      Selects programs for display that possess at least one of the specified program statuses.

      +

      Allowed values: DB-NOTAVL, IOPREV, LOCK, NOTINIT, STOSCHD, TRACE

      +
    • +
    +
  • +
  • +

    --route | --rt (array)

    +
      +
    • Specifies the routes to return.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Query information for an application program named PGM123:

    +
      +
    • zowe ims query program "PGM123"
    • +
    +
  • +
  • +

    Query information for application programs named ABC and XYZ:

    +
      +
    • zowe ims query program "ABC XYZ"
    • +
    +
  • +
  • +

    Query information for application programs starting with PROG using the wild card character '*':

    +
      +
    • zowe ims query program "PROG*"
    • +
    +
  • +
  • +

    Query information for all application programs (default is all):

    +
      +
    • zowe ims query program
    • +
    +
  • +
  • +

    Query information for all application programs specifying optional parameters:

    +
      +
    • zowe ims query program --attributes "BMPTYPE TIMESTAMP" --status "NOTINIT" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Query information for all application programs specifying optional connection parameters:

    +
      +
    • zowe ims query program --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_query_region.html b/static/v2.15.x/web_help/docs/zowe_ims_query_region.html new file mode 100644 index 0000000000..47bf222a8e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_query_region.html @@ -0,0 +1,212 @@ + + + + +ims query region + + +
+

zoweimsqueryregion

+

Query an IMS region.

+

Usage

+

zowe ims query region [options]

+

Options

+
    +
  • +

    --dc (boolean)

    +
      +
    • +

      Displays only the DC subset of the output

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --region (boolean)

    +
      +
    • +

      Displays only the REGION subset of the output. The display consists of active regions

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --route | --rt (array)

    +
      +
    • Specifies the routes to return.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Query information for regions on route IMS1:

    +
      +
    • zowe ims query region "IMS1"
    • +
    +
  • +
  • +

    Query information for regions on routes IMS1 and IMS2:

    +
      +
    • zowe ims query region "IMS1 IMS2"
    • +
    +
  • +
  • +

    Query DC and region information for regions on routes IMS1 and IMS2:

    +
      +
    • zowe ims query region "IMS1 IMS2" --dc true --region true
    • +
    +
  • +
  • +

    Query information for regions specifying optional connection parameters:

    +
      +
    • zowe ims query region --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_query_transaction.html b/static/v2.15.x/web_help/docs/zowe_ims_query_transaction.html new file mode 100644 index 0000000000..748e4970a6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_query_transaction.html @@ -0,0 +1,275 @@ + + + + +ims query transaction + + +
+

zoweimsquerytransaction

+

Query an IMS transaction.

+

Usage

+

zowe ims query transaction [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • Specifies the name of transaction(s) to query. You can use an * character as a wildcard to select multiple transactions.
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --att (array)

    +
      +
    • +

      Specifies the transaction output fields to return.

      +

      Allowed values: ALL, BMPTYPE, DEFN, DEFNTYPE, DOPT, FP, GLOBAL, IMSID, GPSB, LANG, LOCAL, MODEL, RESIDENT, SCHDTYPE, STATUS, TIMESTAMP, TRANSTAT, EXPORTNEEDED, DB, RTC, TRAN, WORK

      +
    • +
    +
  • +
  • +

    --status | --st (array)

    +
      +
    • +

      Selects transactions that possess at least one of the specified transaction statuses.

      +

      Allowed values: AFFIN, BAL, CONV, CPIC, DYN, IOPREV, LCK, NOTINIT, QERR, QSTP, SUSPEND, STOQ, STOSCHD, TRACE, USTO

      +
    • +
    +
  • +
  • +

    --route | --rt (array)

    +
      +
    • Specifies the routes to return.
    • +
    +
  • +
  • +

    --class | --cl (array)

    +
      +
    • Selects transactions by the classes you specify.
    • +
    +
  • +
  • +

    --queue-count-operator | --qco (array)

    +
      +
    • The compare operator used to select transactions based on queue count. Valid values: LT, LE, GT, GE, EQ or NE.
    • +
    +
  • +
  • +

    --queue-count-value | --qcv (number)

    +
      +
    • The numeric value used with 'queue_count_operator' to select transactions based on queue count.
    • +
    +
  • +
  • +

    --conversation-attributes | --ca (string)

    +
      +
    • Selects transactions by the conversational attributes you specify.
    • +
    +
  • +
  • +

    --fast-path-options | --fpo (string)

    +
      +
    • Selects transactions by the Fast Path options you specify.
    • +
    +
  • +
  • +

    --remote-option-specified | --ros (string)

    +
      +
    • Selects transactions by the remote option you specify.
    • +
    +
  • +
  • +

    --response-mode-option-specified | --rmos (string)

    +
      +
    • Selects transactions by the response mode option you specify.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Query transaction information for transaction named TRN12:

    +
      +
    • zowe ims query transaction "TRN12"
    • +
    +
  • +
  • +

    Query transaction information for transactions named TRAN1 and TRAN2:

    +
      +
    • zowe ims query transaction "TRAN1 TRAN2"
    • +
    +
  • +
  • +

    Query transaction information for transactions starting with TRAN using the wild card character '*':

    +
      +
    • zowe ims query transaction "TRAN*"
    • +
    +
  • +
  • +

    Query transaction information for all transactions (default is all):

    +
      +
    • zowe ims query transaction
    • +
    +
  • +
  • +

    Query transaction information for all transactions specifying optional parameters:

    +
      +
    • zowe ims query transaction --attributes "AFFIN TIMESTAMP" --status "NOTINIT" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Query transaction information for all transactions specifying optional connection parameters:

    +
      +
    • zowe ims query transaction --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_start.html b/static/v2.15.x/web_help/docs/zowe_ims_start.html new file mode 100644 index 0000000000..5c3e31ecee --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_start.html @@ -0,0 +1,22 @@ + + + + +ims start + + +
+

zoweimsstart

+

Starts a region, application program, or transaction and makes IMS resources available for reference and use. This command submits a '/START REGION', 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.

+

Usage

+

zowe ims start <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_start_program.html b/static/v2.15.x/web_help/docs/zowe_ims_start_program.html new file mode 100644 index 0000000000..1fd3b8e4f1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_start_program.html @@ -0,0 +1,219 @@ + + + + +ims start program + + +
+

zoweimsstartprogram

+

Start an IMS application program.

+

Usage

+

zowe ims start program [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • The name of the application program(s) to start. The maximum length of a program name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --att (array)

    +
      +
    • +

      The attributes that are to be started

      +

      Default value: SCHD
      +Allowed values: SCHD, TRACE, REFRESH

      +
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • The region(s) to route the command to
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Start an application program named PGM123:

    +
      +
    • zowe ims start program "PGM123"
    • +
    +
  • +
  • +

    Start all application programs beginning with ACC*:

    +
      +
    • zowe ims start program "ACC*"
    • +
    +
  • +
  • +

    Start an application program named PGM234 and start tracing:

    +
      +
    • zowe ims start program "PGM234" --attributes "SCHD TRACE"
    • +
    +
  • +
  • +

    Start an application program named PGM890 routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims start program "PGM890" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Start an application programs named XYZ1 specifying optional connection parameters:

    +
      +
    • zowe ims start program "XYZ1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_start_region.html b/static/v2.15.x/web_help/docs/zowe_ims_start_region.html new file mode 100644 index 0000000000..64dd10c3c2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_start_region.html @@ -0,0 +1,221 @@ + + + + +ims start region + + +
+

zoweimsstartregion

+

Start an IMS region.

+

Usage

+

zowe ims start region [memberName] [options]

+

Positional Arguments

+
    +
  • +

    memberName (string)

    +
      +
    • The name of the member that contains JCL for the region to start. The maximum length of the member name is eight characters. If no member name is specified, the default member name is used
    • +
    +
  • +
+

Options

+
    +
  • +

    --route | --rte (array)

    +
      +
    • The region(s) to route the command to
    • +
    +
  • +
  • +

    --local | -l (boolean)

    +
      +
    • If you specify the --local option, IMS overrides the symbolic IMSID parameter in the JCL of the default or specified member. --local is the default if you specify the --job-name option.
    • +
    +
  • +
  • +

    --job-name | --jn (string)

    +
      +
    • Use this option to override the job name on the JOB statement of the default or specified JCL member for a dependent region.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Start a region stored in a member named MEM1:

    +
      +
    • zowe ims start region "MEM1"
    • +
    +
  • +
  • +

    Start a region stored in a member named MEM2 specifying the region to route the command:

    +
      +
    • zowe ims start region "MEM2" --route "IMS1"
    • +
    +
  • +
  • +

    Start a region stored in a member named MEM3 and override the job name:

    +
      +
    • zowe ims start region "MEM3" --job-name "JOB9"
    • +
    +
  • +
  • +

    Start a region stored in a member named MEM4 routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims start region "MEM4" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Start a region stored in a member named MEM5 specifying optional connection parameters:

    +
      +
    • zowe ims start region "MEM5" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_start_transaction.html b/static/v2.15.x/web_help/docs/zowe_ims_start_transaction.html new file mode 100644 index 0000000000..98079dec0a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_start_transaction.html @@ -0,0 +1,219 @@ + + + + +ims start transaction + + +
+

zoweimsstarttransaction

+

Start an IMS transaction.

+

Usage

+

zowe ims start transaction [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • The name of the transaction(s) to start. The maximum length of a transaction name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --att (array)

    +
      +
    • +

      The attributes that are to be started

      +

      Default value: SCHD
      +Allowed values: Q, SCHD, SUSPEND, TRACE

      +
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • The region(s) to route the command to
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Start a transaction named TRN1:

    +
      +
    • zowe ims start transaction "TRN1"
    • +
    +
  • +
  • +

    Start all transactions beginning with TRN*:

    +
      +
    • zowe ims start transaction "TRN*"
    • +
    +
  • +
  • +

    Start a transaction named TRN2 and start tracing:

    +
      +
    • zowe ims start transaction "TRN2" --attributes "SCHD TRACE"
    • +
    +
  • +
  • +

    Start a transaction named TRN3 routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims start transaction "TRN3" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Start a transaction named TRN4 specifying optional connection parameters:

    +
      +
    • zowe ims start transaction "TRN4" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_stop.html b/static/v2.15.x/web_help/docs/zowe_ims_stop.html new file mode 100644 index 0000000000..c96abbfeba --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_stop.html @@ -0,0 +1,22 @@ + + + + +ims stop + + +
+

zoweimsstop

+

Stops a running region, application program or transaction. This command submits a '/STOP REGION', 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.",

+

Usage

+

zowe ims stop <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_stop_program.html b/static/v2.15.x/web_help/docs/zowe_ims_stop_program.html new file mode 100644 index 0000000000..08c9a784f0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_stop_program.html @@ -0,0 +1,219 @@ + + + + +ims stop program + + +
+

zoweimsstopprogram

+

Stop an IMS application program.

+

Usage

+

zowe ims stop program [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • The name( of the program(s) to stop. The maximum length of a program name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --att (array)

    +
      +
    • +

      The attributes that are to be stopped

      +

      Default value: SCHD
      +Allowed values: SCHD, TRACE

      +
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • The region(s) to route the command
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Stop an application program named PGM123:

    +
      +
    • zowe ims stop program "PGM123"
    • +
    +
  • +
  • +

    Stop all application programs beginning with ACC*:

    +
      +
    • zowe ims stop program "ACC*"
    • +
    +
  • +
  • +

    Stop tracing an application program named PGM234:

    +
      +
    • zowe ims stop program "PGM234" --attributes "TRACE"
    • +
    +
  • +
  • +

    Stop an application program named PGM890 routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims stop program "PGM890" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Stop an application programs named XYZ1 specifying optional connection parameters:

    +
      +
    • zowe ims stop program "XYZ1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_stop_region.html b/static/v2.15.x/web_help/docs/zowe_ims_stop_region.html new file mode 100644 index 0000000000..4e0b98099d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_stop_region.html @@ -0,0 +1,230 @@ + + + + +ims stop region + + +
+

zoweimsstopregion

+

Stop an IMS region.

+

Usage

+

zowe ims stop region [options]

+

Options

+
    +
  • +

    --region-ids | --ri (array)

    +
      +
    • Region identifier numbers for the regions you want to stop. You must specify either this option or --job-name.
    • +
    +
  • +
  • +

    --job-name | --jn (string)

    +
      +
    • The name of the job for the IMS region you want to stop. You must specify either this option or --region-ids.
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • The region(s) to route the command to
    • +
    +
  • +
  • +

    --abdump (string)

    +
      +
    • Specify this option to cause abnormal termination (ABEND) of an application program. If the transaction indicated by this argument is currently running in the specified region, an error message is received at the master terminal, indicating an application program ABEND. The region will remain active, but the transaction will be stopped. The command is ignored if the transaction is not currently scheduled in the region.
    • +
    +
  • +
  • +

    --cancel (boolean)

    +
      +
    • Use this option if the region cannot be stopped with a stop region --abdump command. To use this option, you must have already submitted a stop region command using the --abdump option.
    • +
    +
  • +
  • +

    --transaction (string)

    +
      +
    • Specify a transaction in wait-for-input mode to stop its message processing within the specified region.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Stop a region with job name JOBNM1:

    +
      +
    • zowe ims stop region --job-name "JOBNM1"
    • +
    +
  • +
  • +

    Stop multiple regions with region identifiers:

    +
      +
    • zowe ims stop region --region-ids 4 5
    • +
    +
  • +
  • +

    Stop a region with region identifier and cause the abnormal termination (ABEND) of the application program:

    +
      +
    • zowe ims stop region --region-ids 4 --abdump "TRAN1"
    • +
    +
  • +
  • +

    Stop a region with region identifier and specify 'cancel' because the 'abdump' option failed to stop the region:

    +
      +
    • zowe ims stop region --region-ids 4 --cancel true
    • +
    +
  • +
  • +

    Stop a region with job name JOBNM4 specifying optional connection parameters:

    +
      +
    • zowe ims stop region --job-name "JOBNM4" --user "username" --pass "pass1234" --host "localhost" --port 8080--ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_stop_transaction.html b/static/v2.15.x/web_help/docs/zowe_ims_stop_transaction.html new file mode 100644 index 0000000000..8ab8c27d5a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_stop_transaction.html @@ -0,0 +1,219 @@ + + + + +ims stop transaction + + +
+

zoweimsstoptransaction

+

Stop an IMS transaction.

+

Usage

+

zowe ims stop transaction <name...> [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • The name of the transaction(s) to stop. The maximum length of a transaction name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --att (array)

    +
      +
    • +

      The attributes that are to be stopped

      +

      Default value: SCHD
      +Allowed values: Q, SCHD, TRACE

      +
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • The region(s) to route the command
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Stop a transaction named TRN1:

    +
      +
    • zowe ims stop transaction "TRN1"
    • +
    +
  • +
  • +

    Stop all transactions beginning with TRN*:

    +
      +
    • zowe ims stop transaction "TRN*"
    • +
    +
  • +
  • +

    Stop tracing a transaction named TRN2:

    +
      +
    • zowe ims stop transaction "TRN2" --attributes "TRACE"
    • +
    +
  • +
  • +

    Stop a transaction named TRN3 routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims stop transaction "TRN3" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Stop a transaction named TRN4 specifying optional connection parameters:

    +
      +
    • zowe ims stop transaction "TRN4" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_update.html b/static/v2.15.x/web_help/docs/zowe_ims_update.html new file mode 100644 index 0000000000..15086e4cbf --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_update.html @@ -0,0 +1,21 @@ + + + + +ims update + + +
+

zoweimsupdate

+

Updates the setting(s) for application program or transaction. This command submits a 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.

+

Usage

+

zowe ims update <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_update_program.html b/static/v2.15.x/web_help/docs/zowe_ims_update_program.html new file mode 100644 index 0000000000..406a33eba5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_update_program.html @@ -0,0 +1,299 @@ + + + + +ims update program + + +
+

zoweimsupdateprogram

+

Update an IMS application program.

+

Usage

+

zowe ims update program [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • The name of the application program(s) to update. The maximum length of a program name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --bmp-type | --bmptype (string)

    +
      +
    • +

      Specifies whether the program runs in a BMP type region or not. (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --dynamic | --dopt (string)

    +
      +
    • +

      Specifies the dynamic option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --fast-path | --fp (string)

    +
      +
    • +

      Specifies the Fast Path option (E or N).

      +

      Allowed values: E, N

      +
    • +
    +
  • +
  • +

    --generated-psb | --gpsb (string)

    +
      +
    • +

      Specifies the generated PSB option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --language | --lang (string)

    +
      +
    • +

      Specifies the language interface of the program or a GPSB or defined a DOPT(Y) program as using the JAVA language (ASSEM, COBOL, JAVA, PASCAL, PLI).

      +

      Allowed values: ASSEM, COBOL, JAVA, PASCAL, PLI

      +
    • +
    +
  • +
  • +

    --lock | -l (string)

    +
      +
    • +

      Specifies the LOCK status is to be set (ON or OFF).

      +

      Allowed values: ON, OFF

      +
    • +
    +
  • +
  • +

    --option | -o (string)

    +
      +
    • +

      Specifies to return response lines for all resources that are processed. It is only valid with --name * (ALLRSP).

      +

      Allowed values: ALLRSP

      +
    • +
    +
  • +
  • +

    --resident | -r (string)

    +
      +
    • +

      Specifies the resident option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • Specifies the region(s) to route the command.
    • +
    +
  • +
  • +

    --schedule-type | --schdtype (string)

    +
      +
    • +

      Specifies whether this application program can be scheduled into more than one message region or batch message region simultaneously (PARALLEL or SERIAL).

      +

      Allowed values: PARALLEL, SERIAL

      +
    • +
    +
  • +
  • +

    --transaction-level-stat | --transtat (string)

    +
      +
    • +

      Specifies whether transaction level statistics should be logged (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update an application program named PGM123 to execute exclusively as Fast Path:

    +
      +
    • zowe ims update program "PGM123" --fp "E"
    • +
    +
  • +
  • +

    Update all application programs beginning with ACC* to not run in a BMP type region:

    +
      +
    • zowe ims update program "ACC*" --bmptype "N"
    • +
    +
  • +
  • +

    Unlock all programs beginning with PGM* to allow scheduling:

    +
      +
    • zowe ims update program "PGM*" --lock "OFF"
    • +
    +
  • +
  • +

    Update an application program named PGM890 to execute as Fast Path routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims update program "PGM890" --fp "E" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Unlock an application programs named XYZ1 to allow scheduling specifying optional connection parameters:

    +
      +
    • zowe ims update program "XYZ1" --lock "OFF" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ims_update_transaction.html b/static/v2.15.x/web_help/docs/zowe_ims_update_transaction.html new file mode 100644 index 0000000000..d86d19a0b9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ims_update_transaction.html @@ -0,0 +1,491 @@ + + + + +ims update transaction + + +
+

zoweimsupdatetransaction

+

Update an IMS transaction.

+

Usage

+

zowe ims update transaction [name...] [options]

+

Positional Arguments

+
    +
  • +

    name... (string)

    +
      +
    • The name of the transaction(s) to update. The maximum length of a transaction name is eight characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --aoi-cmd | --aocmd (string)

    +
      +
    • +

      Specifies the AOI option that you want to change (N, CMD, TRAN, Y).

      +

      Allowed values: N, CMD, TRAN, Y

      +
    • +
    +
  • +
  • +

    --class | -c (array)

    +
      +
    • Selects the transactions associated with the specified class or classes to be updated.
    • +
    +
  • +
  • +

    --commit-mode | --cmtmode (string)

    +
      +
    • +

      Specifies when database updates and non-express output messages are committed (SNGL, MULT).

      +

      Allowed values: SINGLE, MODE

      +
    • +
    +
  • +
  • +

    --conversation | --conv (string)

    +
      +
    • +

      Specifies the conversation option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --current-priority | --cpri (number)

    +
      +
    • Specifies a new value for the current priority of a transaction.
    • +
    +
  • +
  • +

    --directed-routing | --dirroute (string)

    +
      +
    • +

      Specifies the MSC directed routing option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --edit-routine | --editrtn (string)

    +
      +
    • Specifies the 1- to 8-character name of your transaction input edit routine that edits messages before the program receives the message.
    • +
    +
  • +
  • +

    --edit-uppercase | --edituc (string)

    +
      +
    • +

      Specifies the edit to uppercase option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --emh-buffer-size | --emhbsz (number)

    +
      +
    • Specifies the EMH buffer size required to run the Fast Path transaction.
    • +
    +
  • +
  • +

    --expiration-time | --exprtime (number)

    +
      +
    • Specifies the elapsed time in seconds that IMS can use to cancel the input transaction.
    • +
    +
  • +
  • +

    --fast-path | --fp (string)

    +
      +
    • +

      Specifies the Fast Path option (E, N, P).

      +

      Allowed values: E, N, P

      +
    • +
    +
  • +
  • +

    --inquiry | --inq (string)

    +
      +
    • +

      Specifies the inquiry option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --limit-count | --lct (number)

    +
      +
    • Specifies the limit count.
    • +
    +
  • +
  • +

    --limit-priority | --lpri (number)

    +
      +
    • Specifies the limit priority.
    • +
    +
  • +
  • +

    --lock | -l (string)

    +
      +
    • +

      Specifies that the LOCK status is to be set on or off. Cannot be specified with any other SET attribute(ON or OFF).

      +

      Allowed values: ON, OFF

      +
    • +
    +
  • +
  • +

    --log-write-ahead | --dclwa (string)

    +
      +
    • +

      Specifies the log write-ahead option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --maximum-regions | --maxrgn (number)

    +
      +
    • Specifies a new value for the maximum number of regions that can be simultaneously scheduled for a given transaction.
    • +
    +
  • +
  • +

    --message-type | --msgtype (string)

    +
      +
    • +

      Specifies the message type (single segment or multiple segment) (MULTSEG or SNGLSEG).

      +

      Allowed values: MULTSEG, SNGLSEG

      +
    • +
    +
  • +
  • +

    --msname | --mn (string)

    +
      +
    • Specifies the one- to eight-character name of the logical link path in a multiple IMS system configuration (MSC).
    • +
    +
  • +
  • +

    --normal-scheduling-priority | --npri (number)

    +
      +
    • Specifies the normal scheduling priority.
    • +
    +
  • +
  • +

    --option | -o (string)

    +
      +
    • +

      Specifies functions to be performed along with the command (AFFIN or ALLRSP).

      +

      Allowed values: ALLRSP

      +
    • +
    +
  • +
  • +

    --parallel-processing-limit | --parlim (number)

    +
      +
    • Specifies the parallel processing limit count.
    • +
    +
  • +
  • +

    --program | --pgm (string)

    +
      +
    • Specifies the name of the application program associated with the transaction.
    • +
    +
  • +
  • +

    --processing-limit-count | --plct (number)

    +
      +
    • Specifies the processing limit count.
    • +
    +
  • +
  • +

    --processing-limit-count-time | --plcttime (number)

    +
      +
    • Specifies the processing limit count time.
    • +
    +
  • +
  • +

    --recover | -r (string)

    +
      +
    • +

      Specifies the recovery option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --remote | --re (string)

    +
      +
    • +

      Specifies the remote option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --response-mode | --resp (string)

    +
      +
    • +

      Specifies the response mode option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --route | --rte (array)

    +
      +
    • Specifies the region(s) to route the command.
    • +
    +
  • +
  • +

    --segment-number | --segno (number)

    +
      +
    • Specifies the segment number.
    • +
    +
  • +
  • +

    --segment-size | --segsz (number)

    +
      +
    • Specifies the segment size.
    • +
    +
  • +
  • +

    --serial | --sr (string)

    +
      +
    • +

      Specifies the serial option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --set-class | --sc (number)

    +
      +
    • Specifies the transaction class, which is an attribute used to select a transaction for scheduling.
    • +
    +
  • +
  • +

    --system-identification-local | --sidl (number)

    +
      +
    • Specifies the system identification (SYSID) of the local system in a multiple-IMS system (MSC) configuration.
    • +
    +
  • +
  • +

    --system-identification-remote | --sidr (number)

    +
      +
    • Specifies the system identification (SYSID) of the remote system in a multiple-IMS system (MSC) configuration.
    • +
    +
  • +
  • +

    --scratchpad-area-size | --spasz (number)

    +
      +
    • Specifies the scratchpad area (SPA) size, in bytes, for a conversational transaction. The value can be a number from 16 and 32767.
    • +
    +
  • +
  • +

    --scratchpad-area-truncation | --spatrunc (string)

    +
      +
    • +

      Specifies the scratchpad area (SPA) truncation option of a conversational transaction (S or R).

      +

      Allowed values: S, R

      +
    • +
    +
  • +
  • +

    --transaction-level-stat | --transtat (string)

    +
      +
    • +

      Specifies whether transaction level statistics should be logged for message driven programs (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
  • +

    --wait-for-input | --wfi (string)

    +
      +
    • +

      Specifies the wait-for input option (N or Y).

      +

      Allowed values: N, Y

      +
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ims-profile | --ims-p (string)

    +
      +
    • The name of a (ims) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a transaction named TRN1 to process exclusively as Fast Path:

    +
      +
    • zowe ims update transaction "TRN1" --fp "E"
    • +
    +
  • +
  • +

    Unlock to allow scheduling all transactions beginning with TRN* and associated with class CLASSA:

    +
      +
    • zowe ims update transaction "TRN*" --class "CLASSA" --lock "OFF"
    • +
    +
  • +
  • +

    Set response mode on for transaction named TRN2 and associated with classes CLASS1 and CLASS2:

    +
      +
    • zowe ims update transaction "TRN2" --class "CLASS1 CLASS2" --resp "Y"
    • +
    +
  • +
  • +

    Update a transaction named TRN3 to process exclusively as Fast Path routing to control regions IMS1 and IMS2:

    +
      +
    • zowe ims update transaction "TRN3" -fp "E" --route "IMS1 IMS2"
    • +
    +
  • +
  • +

    Associate PGM1 with transaction named TRN4 specifying optional connection parameters:

    +
      +
    • zowe ims update transaction "TRN4" --pgm "PGM1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_jclcheck.html b/static/v2.15.x/web_help/docs/zowe_jclcheck.html new file mode 100644 index 0000000000..f91ae37602 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_jclcheck.html @@ -0,0 +1,20 @@ + + + + +jclcheck + + +
+

zowejclcheck

+

Validates the accuracy of job control language (JCL) and also helps identify execution-time errors, such as security violations and missing data sets that could cause jobs to fail.

+

Usage

+

zowe jclcheck <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • check | ck - Perform a check on JCL that is contained in an MVS data set or a local file
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_jclcheck_check.html b/static/v2.15.x/web_help/docs/zowe_jclcheck_check.html new file mode 100644 index 0000000000..9a9640a72f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_jclcheck_check.html @@ -0,0 +1,21 @@ + + + + +jclcheck check + + +
+

zowejclcheckcheck

+

Perform a check on JCL that is contained in an MVS data set or a local file.

+

Usage

+

zowe jclcheck check <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_jclcheck_check_data-set.html b/static/v2.15.x/web_help/docs/zowe_jclcheck_check_data-set.html new file mode 100644 index 0000000000..2db412c767 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_jclcheck_check_data-set.html @@ -0,0 +1,163 @@ + + + + +jclcheck check data-set + + +
+

zowejclcheckcheckdata-set

+

Reads the specified input data set and invokes the JCLCheck service with the data set contents.

+

Usage

+

zowe jclcheck check data-set <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    dataSet (string)

    +
      +
    • The MVS data set containing the JCL contents. The data set can be a physical sequential (PS) or partitioned data set (PDS) member. The data set attributes must be recfm fixed-block (FB) and lrecl 80. The data set must be catalogued.
    • +
    +
  • +
+

Options

+
    +
  • +

    --max-return-code | --mrc (number)

    +
      +
    • Specifies the maximum acceptable return code from the JCLCheck service. If the JCLCheck overall return code exceeds the value specified on this option, the command will exit with a failure status code of 1.
    • +
    +
  • +
  • +

    --raw-output | --ro (boolean)

    +
      +
    • +

      Causes the command to print the unformatted JCLCheck report (raw report) instead of the formatted error table. Use this option if you intend to change the format of the JCLCheck report via runtime options. Changing the format may affect the ability to produce a structured API response.

      +

      Default value: false

      +
    • +
    +
  • +
+

JCLCheck Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Port for the JCLCheck API service that is running on the mainframe system.

      +

      Default value: 12697

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: cajclcheck/api/v1

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for JCLCheck connection (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --jclcheck-options | --jo (string)

    +
      +
    • The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --jclcheck-profile | --jclcheck-p (string)

    +
      +
    • The name of a (jclcheck) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Check the JCL contained in "MY.DATASET(JCL)" and print a table of statements in error:

    +
      +
    • zowe jclcheck check data-set "MY.DATASET(JCL)" --host hostname --port 1234 --jclcheck-options "NOAS NOAU NOHCD NOJCL NORES NOSIGN"
    • +
    +
  • +
  • +

    Check the JCL contained in "MY.DATASET(JCL)" and print the raw JCLCheck report:

    +
      +
    • zowe jclcheck check data-set "MY.DATASET(JCL)" --host hostname --port 1234 --jclcheck-options "NOAS NOAU NOHCD NOJCL NORES NOSIGN" --raw-output
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_jclcheck_check_local-file.html b/static/v2.15.x/web_help/docs/zowe_jclcheck_check_local-file.html new file mode 100644 index 0000000000..c87388d4f1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_jclcheck_check_local-file.html @@ -0,0 +1,163 @@ + + + + +jclcheck check local-file + + +
+

zowejclcheckchecklocal-file

+

Reads the contents of the local file specified and invokes the JCLCheck service with the JCL contents.

+

Usage

+

zowe jclcheck check local-file <localFile> [options]

+

Positional Arguments

+
    +
  • +

    localFile (string)

    +
      +
    • The local file containing the JCL to check. The local JCL file can contain a single job or multiple jobs (specified one after another without blank lines or line breaks). The JCL lines in the file must not exceed 80 characters.
    • +
    +
  • +
+

Options

+
    +
  • +

    --max-return-code | --mrc (number)

    +
      +
    • Specifies the maximum acceptable return code from the JCLCheck service. If the JCLCheck overall return code exceeds the value specified on this option, the command will exit with a failure status code of 1.
    • +
    +
  • +
  • +

    --raw-output | --ro (boolean)

    +
      +
    • +

      Causes the command to print the unformatted JCLCheck report (raw report) instead of the formatted error table. Use this option if you intend to change the format of the JCLCheck report via runtime options. Changing the format may affect the ability to produce a structured API response.

      +

      Default value: false

      +
    • +
    +
  • +
+

JCLCheck Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Port for the JCLCheck API service that is running on the mainframe system.

      +

      Default value: 12697

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: cajclcheck/api/v1

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for JCLCheck connection (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --jclcheck-options | --jo (string)

    +
      +
    • The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --jclcheck-profile | --jclcheck-p (string)

    +
      +
    • The name of a (jclcheck) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Check the JCL contained in the file "jcl.txt" and print a table of statements in error:

    +
      +
    • zowe jclcheck check local-file jcl.txt --host hostname --port 1234 --jclcheck-options "NOAS NOAU NOHCD NOJCL NORES NOSIGN"
    • +
    +
  • +
  • +

    Check the JCL contained in the file "jcl.txt" and print the raw JCLCheck report:

    +
      +
    • zowe jclcheck check local-file jcl.txt --host hostname --port 1234 --jclcheck-options "NOAS NOAU NOHCD NOJCL NORES NOSIGN" --raw-output
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat-pma-util.html b/static/v2.15.x/web_help/docs/zowe_mat-pma-util.html new file mode 100644 index 0000000000..6fda310137 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat-pma-util.html @@ -0,0 +1,21 @@ + + + + +mat-pma-util + + +
+

zowemat-pma-util

+

The MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of Mainframe Application Tuner.

+

Usage

+

zowe mat-pma-util <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • get | gt - Get performance information using PMA utilities.
  • +
  • scope | scp - Get and define the PMA scope information.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat-pma-util_get.html b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_get.html new file mode 100644 index 0000000000..37d7ed9aa8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_get.html @@ -0,0 +1,22 @@ + + + + +mat-pma-util get + + +
+

zowemat-pma-utilget

+

Get performance information using PMA utilities. You can get the current performance data of your jobs and check for the daily performance alerts.

+

Usage

+

zowe mat-pma-util get <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • alert | at - Get daily performance alert information.
  • +
  • alert-by-job | abyj - Get daily performance status of a specific job.
  • +
  • perf | pf - Get the performance test result for a specific job
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat-pma-util_get_alert-by-job.html b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_get_alert-by-job.html new file mode 100644 index 0000000000..78c0fe014b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_get_alert-by-job.html @@ -0,0 +1,156 @@ + + + + +mat-pma-util get alert-by-job + + +
+

zowemat-pma-utilgetalert-by-job

+

Check whether the specified job exceeds the average daily performance. No record returned indicates that no performance degradation was detected for this job.

+

Usage

+

zowe mat-pma-util get alert-by-job <jobname> [options]

+

Positional Arguments

+
    +
  • +

    jobname (string)

    +
      +
    • Specifies the name of the job that is being tested (e.g. TESTPMA8).
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Check whether your job TESTPMA8 exceeds the average daily performance using the default profile:

    +
      +
    • zowe mat-pma-util get alert-by-job TESTPMA8
    • +
    +
  • +
  • +

    Check whether your job TESTPMA8 exceeds the average daily performance using specific PMA profile details:

    +
      +
    • zowe mat-pma-util get alert-by-job TESTPMA8 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat-pma-util_get_alert.html b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_get_alert.html new file mode 100644 index 0000000000..f02996e4de --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_get_alert.html @@ -0,0 +1,147 @@ + + + + +mat-pma-util get alert + + +
+

zowemat-pma-utilgetalert

+

Check for alerts created in PMA and detect whether any of your jobs exceeds the average daily performance. If the threshold is exceeded, a PMA alert is triggered. We recommend that you include this command in your end-of-day build to trace all jobs that might cause performance degradation by code changes during the day.

+

Usage

+

zowe mat-pma-util get alert [options]

+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Check whether any of your jobs exceeds the average daily performance using the default profile:

    +
      +
    • zowe mat-pma-util get alert
    • +
    +
  • +
  • +

    Check whether any of your jobs exceeds the average daily performance using specific PMA profile details:

    +
      +
    • zowe mat-pma-util get alert --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat-pma-util_get_perf.html b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_get_perf.html new file mode 100644 index 0000000000..1cafe98f0a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_get_perf.html @@ -0,0 +1,156 @@ + + + + +mat-pma-util get perf + + +
+

zowemat-pma-utilgetperf

+

Get the current performance data of a specific job using PMA. If the current measurement results for any of the measured parameters are higher than average values, an alert message is displayed.

+

Usage

+

zowe mat-pma-util get perf <jobname> [options]

+

Positional Arguments

+
    +
  • +

    jobname (string)

    +
      +
    • Specifies the name of the job that is being tested (e.g. TESTPMA8).
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the current performance data of the TESTPMA8 job using the default profile:

    +
      +
    • zowe mat-pma-util get perf TESTPMA8
    • +
    +
  • +
  • +

    Get the current performance data of the TESTPMA8 job using specific PMA profile details:

    +
      +
    • zowe mat-pma-util get perf TESTPMA8 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope.html b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope.html new file mode 100644 index 0000000000..cf083578c4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope.html @@ -0,0 +1,25 @@ + + + + +mat-pma-util scope + + +
+

zowemat-pma-utilscope

+

Get and define the PMA scope information. You can create and update the list of jobs that you want to include, or the list of programs to be excluded from the PMA scope of work.

+

Usage

+

zowe mat-pma-util scope <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_del-job.html b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_del-job.html new file mode 100644 index 0000000000..202c9c72b1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_del-job.html @@ -0,0 +1,177 @@ + + + + +mat-pma-util scope del-job + + +
+

zowemat-pma-utilscopedel-job

+

Delete a job from the list of inclusions in the PMA scope.

+

Usage

+

zowe mat-pma-util scope del-job <jobname> [options]

+

Positional Arguments

+
    +
  • +

    jobname (string)

    +
      +
    • Specifies the name of the job that you want to delete from the list of inclusions in the PMA scope (e.g. TESTPMA8).
    • +
    +
  • +
+

Options

+
    +
  • +

    --stepname | --st (string)

    +
      +
    • Specifies the name of the job step that you want to delete from the list of inclusions in the PMA scope.
    • +
    +
  • +
  • +

    --procstep | --ps (string)

    +
      +
    • Specifies the procname of the job that you want to delete from the list of inclusions in the PMA scope.
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the TESTPMA8 job from the list of inclusions in the PMA scope:

    +
      +
    • zowe mat-pma-util scope del-job TESTPMA8
    • +
    +
  • +
  • +

    Delete the specific procname and step name of the TESTPMA8 job from the list of inclusions in the PMA scope:

    +
      +
    • zowe mat-pma-util scope del-job TESTPMA8 --ps TESTCALL --st TESTDO
    • +
    +
  • +
  • +

    Delete the specific procname and step name of the TESTPMA8 job from the list of inclusions in the PMA scope using specific PMA profile details:

    +
      +
    • zowe mat-pma-util scope del-job TESTPMA8 --ps TESTCALL --st TESTDO --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_del-pgm.html b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_del-pgm.html new file mode 100644 index 0000000000..56703417b0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_del-pgm.html @@ -0,0 +1,156 @@ + + + + +mat-pma-util scope del-pgm + + +
+

zowemat-pma-utilscopedel-pgm

+

Delete a program from the list of exclusions from the PMA scope.

+

Usage

+

zowe mat-pma-util scope del-pgm <pgmname> [options]

+

Positional Arguments

+
    +
  • +

    pgmname (string)

    +
      +
    • Specifies the name of the program that you want to delete from the list of exclusions from the PMA scope (e.g. TESTPMA8).
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the TESTPMA8 program from the exclusions list from the PMA scope:

    +
      +
    • zowe mat-pma-util scope del-pgm TESTPMA8
    • +
    +
  • +
  • +

    Delete the TESTPMA8 program from the exclusions list from the PMA scope using specific PMA profile details:

    +
      +
    • zowe mat-pma-util scope del-pgm TESTPMA8 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_exl-pgm.html b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_exl-pgm.html new file mode 100644 index 0000000000..1376af441e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_exl-pgm.html @@ -0,0 +1,171 @@ + + + + +mat-pma-util scope exl-pgm + + +
+

zowemat-pma-utilscopeexl-pgm

+

Exclude a program from the PMA scope of work.

+

Usage

+

zowe mat-pma-util scope exl-pgm <pgmname> [options]

+

Positional Arguments

+
    +
  • +

    pgmname (string)

    +
      +
    • Specifies the name of the program that you want to add to the list of exclusions from the PMA scope (e.g. TESTPMA8).
    • +
    +
  • +
+

Options

+
    +
  • +

    --description | --dc (string)

    +
      +
    • Specifies the description of the program that you want to exclude from the PMA scope.
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Exclude the TESTPMA8 program from the PMA scope:

    +
      +
    • zowe mat-pma-util scope exl-pgm TESTPMA8
    • +
    +
  • +
  • +

    Exclude the TESTPMA8 program from the PMA scope and add a description to the excluded program:

    +
      +
    • zowe mat-pma-util scope exl-pgm TESTPMA8 --dc "EXCLUDE FROM THE CURRENT SCOPE"
    • +
    +
  • +
  • +

    Exclude the TESTPMA8 program from the PMA scope and add a description to the excluded program using specific PMA profile details:

    +
      +
    • zowe mat-pma-util scope exl-pgm TESTPMA8 --dc "EXCLUDE FROM THE CURRENT SCOPE" --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_get-listj.html b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_get-listj.html new file mode 100644 index 0000000000..748189cb14 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_get-listj.html @@ -0,0 +1,147 @@ + + + + +mat-pma-util scope get-listj + + +
+

zowemat-pma-utilscopeget-listj

+

Get the list of jobs included in the PMA scope.

+

Usage

+

zowe mat-pma-util scope get-listj [options]

+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the list of jobs included in the PMA scope:

    +
      +
    • zowe mat-pma-util scope get-listj
    • +
    +
  • +
  • +

    Get the list of jobs included in the PMA scope using specific PMA profile details:

    +
      +
    • zowe mat-pma-util scope get-listj --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_get-listp.html b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_get-listp.html new file mode 100644 index 0000000000..5b165d9a1c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_get-listp.html @@ -0,0 +1,147 @@ + + + + +mat-pma-util scope get-listp + + +
+

zowemat-pma-utilscopeget-listp

+

Get the list of programs excluded from the PMA scope.

+

Usage

+

zowe mat-pma-util scope get-listp [options]

+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the list of programs excluded from the PMA scope:

    +
      +
    • zowe mat-pma-util scope get-listp
    • +
    +
  • +
  • +

    Get the list of programs excluded from the PMA scope using specific PMA profile details:

    +
      +
    • zowe mat-pma-util scope get-listp --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_inc-job.html b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_inc-job.html new file mode 100644 index 0000000000..a7ffe5acfa --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat-pma-util_scope_inc-job.html @@ -0,0 +1,183 @@ + + + + +mat-pma-util scope inc-job + + +
+

zowemat-pma-utilscopeinc-job

+

Include a job in the PMA scope of work.

+

Usage

+

zowe mat-pma-util scope inc-job <jobname> [options]

+

Positional Arguments

+
    +
  • +

    jobname (string)

    +
      +
    • Specifies the name of the job that you want to add to the list of inclusions in the PMA scope (e.g. TESTPMA8).
    • +
    +
  • +
+

Options

+
    +
  • +

    --stepname | --st (string)

    +
      +
    • Specifies the name of the job step that you want to include in the PMA scope.
    • +
    +
  • +
  • +

    --procstep | --ps (string)

    +
      +
    • Specifies the procname of the job that you want to include in the PMA scope.
    • +
    +
  • +
  • +

    --description | --dc (string)

    +
      +
    • Specifies the description of the job that you want to include in the PMA scope.
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --pma-profile | --pma-p (string)

    +
      +
    • The name of a (pma) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Include the TESTPMA8 job in the PMA scope:

    +
      +
    • zowe mat-pma-util scope inc-job TESTPMA8
    • +
    +
  • +
  • +

    Include the specific procname and step name of the TESTPMA8 job in the PMA scope and add a description to the included job:

    +
      +
    • zowe mat-pma-util scope inc-job TESTPMA8 --ps TESTCALL --st TESTDO --dc "INCLUDE IN THE CURRENT SCOPE"
    • +
    +
  • +
  • +

    Include the specific procname and step name of the TESTPMA8 job in the PMA scope and add a description to the included job using specific PMA profile details:

    +
      +
    • zowe mat-pma-util scope inc-job TESTPMA8 --ps TESTCALL --st TESTDO --dc "INCLUDE IN THE CURRENT SCOPE" --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat.html b/static/v2.15.x/web_help/docs/zowe_mat.html new file mode 100644 index 0000000000..a70c076cbc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat.html @@ -0,0 +1,21 @@ + + + + +mat + + +
+

zowemat

+

The MAT Analyze plug-in for ZOWE CLI enables you to manage monitor profiles and get the measurement analysis data using Mainframe Application Tuner (MAT)

+

Usage

+

zowe mat <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor.html new file mode 100644 index 0000000000..c889ae9fc3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor.html @@ -0,0 +1,27 @@ + + + + +mat monitor + + +
+

zowematmonitor

+

Get monitor history and measurement analysis data from MAT.

+

Usage

+

zowe mat monitor <command|group>

+

Where <command|group> is one of the following:

+

Groups

+ +

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview.html new file mode 100644 index 0000000000..f284a75445 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview.html @@ -0,0 +1,23 @@ + + + + +mat monitor codeview + + +
+

zowematmonitorcodeview

+

Get the CodeView measurement details.

+

Usage

+

zowe mat monitor codeview <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview_callerid.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview_callerid.html new file mode 100644 index 0000000000..45eeabada9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview_callerid.html @@ -0,0 +1,163 @@ + + + + +mat monitor codeview callerid + + +
+

zowematmonitorcodeviewcallerid

+

Get the CodeView CallerID details for the specific CSECT and module.

+

Usage

+

zowe mat monitor codeview callerid [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
  • +

    --module (string)

    +
      +
    • Specifies the module name that you request the CallerID details for. You get the module value from the 'codeview csect' command response. The module name can be empty (e.g., --module "IGZCPAC" or --module '""').
    • +
    +
  • +
  • +

    --csect (string)

    +
      +
    • Specifies the CSECT name that you request the CallerID details for. You get the csect value from the 'codeview csect' command response. The CSECT name can be empty (e.g., --csect "TUNCOB01" or --csect '""').
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the CallerID details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB:

    +
      +
    • zowe mat monitor codeview callerid --mon_num 5 --csect "TUNCOB01" --module "RUNCOB"
    • +
    +
  • +
  • +

    Get the CallerID details for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01 and empty module name:

    +
      +
    • zowe mat monitor codeview callerid --profile TESTPROF --csect "TUNCOB01" --module '""'
    • +
    +
  • +
  • +

    Get the CallerID details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor codeview callerid --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview_csect.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview_csect.html new file mode 100644 index 0000000000..81d9e6c707 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview_csect.html @@ -0,0 +1,151 @@ + + + + +mat monitor codeview csect + + +
+

zowematmonitorcodeviewcsect

+

Get the CodeView measurement details in Csect mode.

+

Usage

+

zowe mat monitor codeview csect [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the CodeView measurement details in Csect mode for monitor number 5:

    +
      +
    • zowe mat monitor codeview csect --mon_num 5
    • +
    +
  • +
  • +

    Get the CodeView measurement details in Csect mode for the latest monitor in the TESTPROF profile:

    +
      +
    • zowe mat monitor codeview csect --profile TESTPROF
    • +
    +
  • +
  • +

    Get the CodeView measurement details in Csect mode for monitor number 5, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor codeview csect --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview_histogram.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview_histogram.html new file mode 100644 index 0000000000..7eeb992475 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview_histogram.html @@ -0,0 +1,187 @@ + + + + +mat monitor codeview histogram + + +
+

zowematmonitorcodeviewhistogram

+

Get the Histogram details for the measurement.

+

Usage

+

zowe mat monitor codeview histogram [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
  • +

    --module (string)

    +
      +
    • Specifies the module name that you request the Histogram data for. You get the module value from the 'codeview csect' command response. The module name can be empty (e.g., --module "IGZCPAC" or --module '""').
    • +
    +
  • +
  • +

    --csect (string)

    +
      +
    • Specifies the CSECT name that you request the Histogram data for. You get the csect value from the 'codeview csect' command response. The CSECT name can be empty (e.g., --csect "TUNCOB01" or --csect '""').
    • +
    +
  • +
  • +

    --group (string)

    +
      +
    • Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.
    • +
    +
  • +
  • +

    --top (number)

    +
      +
    • Specifies the maximum number of the top consuming CSECT activity locations that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all CSECT activity locations that MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.
    • +
    +
  • +
  • +

    --listing (boolean)

    +
      +
    • Enables you to retrieve program listing details that pertain to the specific CSECT and statement. To use the listing retrieval option, you must install and configure the Endevor® Web Services and have the program listing for the specific measurement registered with MAT. The source code listing is retrieved through Endevor® footprints for Cobol, C/C++, and Assembler programs. The program listing file is downloaded to your local directory that you specified with the 'listingDir' parameter in your MAT configuration profile. When you request the histogram details with the '--listing' option, the 'histogram' command returns the additional 'listing' column that contains a reference to the program listing with the specific CSECT name, program type, line and column number that pertain to the requested CSECT and statement, for example, c:listingsSA420LE.asm:382:51. If you use Visual Studio Code (VS Code) IDE, you can click on the reference in the command responce in your VS Code terminal to navigate directly to the indicated source program location.The --listing parameter is optional.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB:

    +
      +
    • zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB"
    • +
    +
  • +
  • +

    Get the Histogram details for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01, empty module name, limiting the group size to 32 bytes and the number of returned records to 5 top consumers:

    +
      +
    • zowe mat monitor codeview histogram --profile TESTPROF --csect "TUNCOB01" --module '""' --top 5 --group 32
    • +
    +
  • +
  • +

    Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, limit the number of returned records to 5 top consumers, and request the listing details:

    +
      +
    • zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --top 5 --listing
    • +
    +
  • +
  • +

    Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview_module.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview_module.html new file mode 100644 index 0000000000..638e86d113 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_codeview_module.html @@ -0,0 +1,151 @@ + + + + +mat monitor codeview module + + +
+

zowematmonitorcodeviewmodule

+

Get the CodeView measurement details in Module mode.

+

Usage

+

zowe mat monitor codeview module [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the CodeView measurement details in Module mode for monitor number 5:

    +
      +
    • zowe mat monitor codeview module --mon_num 5
    • +
    +
  • +
  • +

    Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile:

    +
      +
    • zowe mat monitor codeview module --profile TESTPROF
    • +
    +
  • +
  • +

    Get the CodeView measurement details in Module mode for monitor number 5, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor codeview module --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_db2.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_db2.html new file mode 100644 index 0000000000..72c1b37dd8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_db2.html @@ -0,0 +1,21 @@ + + + + +mat monitor db2 + + +
+

zowematmonitordb2

+

Get the DB2 measurement details.

+

Usage

+

zowe mat monitor db2 <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_db2_db2view.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_db2_db2view.html new file mode 100644 index 0000000000..6344fe3ddc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_db2_db2view.html @@ -0,0 +1,157 @@ + + + + +mat monitor db2 db2view + + +
+

zowematmonitordb2db2view

+

Get the DB2View details for the measurement.

+

Usage

+

zowe mat monitor db2 db2view [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
  • +

    --top (number)

    +
      +
    • Specifies the maximum number of the top consuming DB2 statements that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all DB2 statements that MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the DB2View details for monitor number 5:

    +
      +
    • zowe mat monitor db2 db2view --mon_num 5
    • +
    +
  • +
  • +

    Get the DB2View details for the latest monitor in the TESTPROF profile, with the top consumer limitation set to 5 top consumers:

    +
      +
    • zowe mat monitor db2 db2view --profile TESTPROF --top 5
    • +
    +
  • +
  • +

    Get the DB2View details for monitor number 5, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor db2 db2view --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_db2_sqlstmt.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_db2_sqlstmt.html new file mode 100644 index 0000000000..3eaf7946c9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_db2_sqlstmt.html @@ -0,0 +1,169 @@ + + + + +mat monitor db2 sqlstmt + + +
+

zowematmonitordb2sqlstmt

+

Get SQL details for the DB2 statement.

+

Usage

+

zowe mat monitor db2 sqlstmt [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
  • +

    --dbrm (string)

    +
      +
    • Specifies the DBRM/Package name that the requested DB2 statement belongs to (e.g., --dbrm CUPBTSDY). You get the dbrm value from the 'db2 db2view ' command response.
    • +
    +
  • +
  • +

    --stmtnum (number)

    +
      +
    • Specifies the statement number that you request the SQL details for (e.g., --stmtnum 464). You get the stmtnum value from the 'db2 db2view ' command response.
    • +
    +
  • +
  • +

    --totalsamps (number)

    +
      +
    • Specifies the total number of samples taken for the requested statement (e.g., --totalsamps 1). You get the totalsamps value from the 'db2 db2view ' command response.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1:

    +
      +
    • zowe mat monitor db2 sqlstmt --mon_num 5 --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1
    • +
    +
  • +
  • +

    Get the DB2 SQL statement details for the latest monitor in the TESTPROF profile, for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1:

    +
      +
    • zowe mat monitor db2 sqlstmt --profile TESTPROF --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1
    • +
    +
  • +
  • +

    Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1, and with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor db2 sqlstmt --mon_num 5 --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_delayview.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_delayview.html new file mode 100644 index 0000000000..c34ea540a5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_delayview.html @@ -0,0 +1,21 @@ + + + + +mat monitor delayview + + +
+

zowematmonitordelayview

+

Get the DelayView measurement details.

+

Usage

+

zowe mat monitor delayview <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_delayview_address.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_delayview_address.html new file mode 100644 index 0000000000..2a8d2a0d5b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_delayview_address.html @@ -0,0 +1,163 @@ + + + + +mat monitor delayview address + + +
+

zowematmonitordelayviewaddress

+

Get the delay address details for the measurement.

+

Usage

+

zowe mat monitor delayview address [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
  • +

    --majorcategory (string)

    +
      +
    • Specifies the major delay category name identified for the analysis item (e.g., --majorcategory "PC routine delay"). You get the majorcategory value from the 'delayview delay' command response.
    • +
    +
  • +
  • +

    --minorcategory (string)

    +
      +
    • Specifies the minor delay category name identified for the analysis item (e.g., --minorcategory "PC CALL"). You get the minorcategory value from the 'delayview delay' command response.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for monitor number 5:

    +
      +
    • zowe mat monitor delayview address --mon_num 5 –-majorcategory "PC routine delay" –-minorcategory "PC CALL"
    • +
    +
  • +
  • +

    Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for the latest monitor in the TESTPROF profile:

    +
      +
    • zowe mat monitor delayview address --profile TESTPROF –-majorcategory "PC routine delay" –-minorcategory "PC CALL"
    • +
    +
  • +
  • +

    Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for monitor number 5, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor delayview address --mon_num 5 –-majorcategory "PC routine delay" –-minorcategory "PC CALL" --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_delayview_delay.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_delayview_delay.html new file mode 100644 index 0000000000..5a4a65ddad --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_delayview_delay.html @@ -0,0 +1,151 @@ + + + + +mat monitor delayview delay + + +
+

zowematmonitordelayviewdelay

+

Get the delay details for the measurement.

+

Usage

+

zowe mat monitor delayview delay [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the DelayView measurement details for monitor number 5:

    +
      +
    • zowe mat monitor delayview delay --mon_num 5
    • +
    +
  • +
  • +

    Get the DelayView measurement details for the latest monitor in the TESTPROF profile:

    +
      +
    • zowe mat monitor delayview delay --profile TESTPROF
    • +
    +
  • +
  • +

    Get the DelayView measurement details for monitor number 5, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor delayview delay --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_history.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_history.html new file mode 100644 index 0000000000..21df080f97 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_history.html @@ -0,0 +1,139 @@ + + + + +mat monitor history + + +
+

zowematmonitorhistory

+

Get list of all available measurements that are stored in the history of the specific monitor profile.

+

Usage

+

zowe mat monitor history [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the list of all available measurements that are stored in the history of the monitor profile TESTPROF:

    +
      +
    • zowe mat monitor history --profile TESTPROF
    • +
    +
  • +
  • +

    Get the list of all available measurements that are stored in the history of the monitor profile TESTPROF, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor history --profile TESTPROF --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_monitor_overview.html b/static/v2.15.x/web_help/docs/zowe_mat_monitor_overview.html new file mode 100644 index 0000000000..c4b1b12b64 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_monitor_overview.html @@ -0,0 +1,151 @@ + + + + +mat monitor overview + + +
+

zowematmonitoroverview

+

Get the overview details of the measurement.

+

Usage

+

zowe mat monitor overview [options]

+

Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
    • +
    +
  • +
  • +

    --mon_num (number)

    +
      +
    • Specifies the unique monitor number of the measurement.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Get the overview details of the measurement for monitor number 5:

    +
      +
    • zowe mat monitor overview --mon_num 5
    • +
    +
  • +
  • +

    Get the overview details of the measurement for the latest monitor in the TESTPROF profile:

    +
      +
    • zowe mat monitor overview --profile TESTPROF
    • +
    +
  • +
  • +

    Get the measurement overview details for monitor number 5, with the specific MAT profile details defined:

    +
      +
    • zowe mat monitor overview --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_profile.html b/static/v2.15.x/web_help/docs/zowe_mat_profile.html new file mode 100644 index 0000000000..97b883b1b7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_profile.html @@ -0,0 +1,22 @@ + + + + +mat profile + + +
+

zowematprofile

+

Create, invoke, and list MAT monitor profiles.

+

Usage

+

zowe mat profile <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_profile_create.html b/static/v2.15.x/web_help/docs/zowe_mat_profile_create.html new file mode 100644 index 0000000000..69b6f0ebc6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_profile_create.html @@ -0,0 +1,407 @@ + + + + +mat profile create + + +
+

zowematprofilecreate

+

Create a MAT monitor profile.

+

Usage

+

zowe mat profile create [options]

+

Required Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile that you create in MAT (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.
    • +
    +
  • +
  • +

    --jobname (string)

    +
      +
    • Specifies the name of the job that you want to measure (e.g. JOB1). Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
    • +
    +
  • +
  • +

    --targsys (string)

    +
      +
    • Specifies the target system in SYSPLEX. Values: a comma separated list of up to 4 values is allowed, 1-8 characters each, a combination of alphanumeric (A-Z and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or a national (@, #, $), e.g. AA31,AA32).
    • +
    +
  • +
+

Options

+
    +
  • +

    --batchreports (string)

    +
      +
    • +

      Specifies the setting for the Batch report option upon monitor completion.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --description (string)

    +
      +
    • Provide the monitor description (maximum 24 characters).
    • +
    +
  • +
  • +

    --mondsn (string)

    +
      +
    • Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.
    • +
    +
  • +
  • +

    --stepname (string)

    +
      +
    • Specifies the name of the job step to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
    • +
    +
  • +
  • +

    --mstep (string)

    +
      +
    • +

      Indicates whether the multi-step monitoring option is enabled.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --procstep (string)

    +
      +
    • Specifies the name of the procedure step. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
    • +
    +
  • +
  • +

    --program (string)

    +
      +
    • Specifies the name of the program to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
    • +
    +
  • +
  • +

    --elapstime (string)

    +
      +
    • +

      Specifies the required monitor duration followed by s (seconds) or m (minutes) (e.g. 60s). Values: maximum 6 characters total, number must be > 0.

      +

      Default value: 60s

      +
    • +
    +
  • +
  • +

    --smon (string)

    +
      +
    • +

      Specifies whether to monitor the entire step.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --tasklib (string)

    +
      +
    • Specifies an additional DD name for load modules. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
    • +
    +
  • +
  • +

    --samplecnt (string)

    +
      +
    • +

      Specifies the number of observations requested. Values: maximum 6 characters, numbers between 10 and 999999.

      +

      Default value: 6000

      +
    • +
    +
  • +
  • +

    --succnt (string)

    +
      +
    • +

      Specifies the maximum number of monitors to run per job execution. Values: maximum 4 characters, numbers between 1 and 9999.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --reccnt (string)

    +
      +
    • +

      Specifies the number of times this job step will be monitored. Values: maximum 4 characters, numbers between 1 and 9999.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --sampdelay (string)

    +
      +
    • +

      Specifies the delay monitoring time in seconds after the step start. Values: maximum 4 characters, numbers between 0 and 9999.

      +

      Default value: 0

      +
    • +
    +
  • +
  • +

    --userexit1 (string)

    +
      +
    • Specifies the name for the call user written Data Base. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. DBEXIT1).
    • +
    +
  • +
  • +

    --userexit2 (string)

    +
      +
    • Specifies the name 1 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT1).
    • +
    +
  • +
  • +

    --userexit3 (string)

    +
      +
    • Specifies the name 2 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT2).
    • +
    +
  • +
  • +

    --inctask (string)

    +
      +
    • Specifies the task name to define the tasks that you want to sample in a multitasking environment and restrict monitoring to the specific subtask within the address space. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. INC31,INC32).
    • +
    +
  • +
  • +

    --exctask (string)

    +
      +
    • Specifies the task name to omit from sampling in a multitasking environment Values: a comma separated list of up to 4 values is allowed, max. 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. EXC31,EXC32).
    • +
    +
  • +
  • +

    --tran (string)

    +
      +
    • Specifies the CICS transaction code name to monitor .Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TRAN1,TRAN2).
    • +
    +
  • +
  • +

    --term (string)

    +
      +
    • Specifies the CICS terminal IDs to monitor. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TERM1,TERM2).
    • +
    +
  • +
  • +

    --userid (string)

    +
      +
    • Specifies the CICS user IDs to monitor. Values: Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. USER1,USER2).
    • +
    +
  • +
  • +

    --db2expl (string)

    +
      +
    • +

      Indicates whether the Explain SQL option is enabled for DB2 SQL statements.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --db2ctsql (string)

    +
      +
    • +

      Indicates whether the Collect SQL from Catalog option is enabled for DB2 SQL statements.If you specify db2expl=yes, then db2ctsql must be also set to yes.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --db2hvloc (string)

    +
      +
    • +

      Indicates whether the Requestor Location option is enabled for DB2 measurements.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --db2hvcor (string)

    +
      +
    • +

      Indicates whether the Correlation ID option for SQL statements is enabled for DB2 measurements.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --db2hviid (string)

    +
      +
    • +

      Indicates whether the Operator ID option for SQL statements is enabled for DB2 measurements.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --db2hvthd (string)

    +
      +
    • +

      Indicates whether the Thread Address option for SQL statements is enabled for DB2 measurements.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --wasexprt (string)

    +
      +
    • +

      Indicates whether the Expert Mode is enabled for Java measurement.

      +

      Default value: no
      +Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --urlfilt (string)

    +
      +
    • A filtering string to restrict monitoring to the specific application URL, transaction, or stored procedure for Java measurements. Values: a comma separated list of up to 4 values is allowed, max. 64 characters (e.g. mypage1.html,mypage2.html).
    • +
    +
  • +
  • +

    --sysfilt (string)

    +
      +
    • A filtering string to include the specified system class for Java measurements. If you specify a value for sysfilt, the measurement includes only the classes that match the filtering string pattern. Values: a comma separated list of up to 3 values is allowed, max. 64 characters (e.g. user1.class,user2.class).
    • +
    +
  • +
  • +

    --schedule (string)

    +
      +
    • Specifies the name of the schedule that you want to apply to the monitor profile (maximum 8 characters).
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system:

    +
      +
    • zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31
    • +
    +
  • +
  • +

    Create the PROFILE1 monitor profile to measure for 90 seconds job JOB1 that runs on the AA31 and AA32 systems:

    +
      +
    • zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31,AA32 --elapstime 90s
    • +
    +
  • +
  • +

    Create the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system, with the specific MAT profile details defined:

    +
      +
    • zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_profile_invoke.html b/static/v2.15.x/web_help/docs/zowe_mat_profile_invoke.html new file mode 100644 index 0000000000..d6c1035111 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_profile_invoke.html @@ -0,0 +1,190 @@ + + + + +mat profile invoke + + +
+

zowematprofileinvoke

+

Invoke a MAT monitor profile to start measurement.

+

Usage

+

zowe mat profile invoke [options]

+

Required Options

+
    +
  • +

    --profile (string)

    +
      +
    • Specifies the name of the profile in MAT that you invoke (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.
    • +
    +
  • +
  • +

    --jobname (string)

    +
      +
    • Specifies the name of the job to be measured (e.g. JOB1). Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
    • +
    +
  • +
  • +

    --targsys (string)

    +
      +
    • Specifies the target system in SYSPLEX. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, a combination of alphanumeric (A-Z and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or a national (@, #, $) (e.g. AA31,AA32).
    • +
    +
  • +
+

Options

+
    +
  • +

    --mondsn (string)

    +
      +
    • Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.
    • +
    +
  • +
  • +

    --moiuuid (string)

    +
      +
    • Specifies the MOI UUID. Values: maximum 61 characters, alphanumeric (A-Z and 0-9). If you use this parameter for command execution, the value cannot be blank.
    • +
    +
  • +
  • +

    --moitimestamp (string)

    +
      +
    • Specifies the MOI timestamp. Values: maximum 12 characters, numbers only (0-9). If you use this parameter for command execution, the value cannot be blank.
    • +
    +
  • +
  • +

    --listing (boolean)

    +
      +
    • Activates automated registration of Cobol, C/C++, and Assembler program listings through Endevor® footprints. After completion of the measurement that you invoke with the --listing parameter, the MAT Analyze plug-in for Zowe CLI automatically retrieves the program listing that is associated with the monitored job and registers the listing with MAT. A registered program listing enhances the analysis possibilities of the 'codeview histogram' command the 'codeview histogram' command and enables you to inspect the source code statements that are associated with specific modules and CSECTs.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system :

    +
      +
    • zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31
    • +
    +
  • +
  • +

    Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and save the measurement result in the DEMO.MAT.MONITOR.PROFILE1 data set:

    +
      +
    • zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --mondsn DEMO.MAT.MONITOR.PROFILE1
    • +
    +
  • +
  • +

    Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and register the program listing:

    +
      +
    • zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --listing
    • +
    +
  • +
  • +

    Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system with the specific MAT profile details defined:

    +
      +
    • zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --host "example.com" --port 12345 --user johndoe --password qwerty
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mat_profile_list.html b/static/v2.15.x/web_help/docs/zowe_mat_profile_list.html new file mode 100644 index 0000000000..a26225ae5b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mat_profile_list.html @@ -0,0 +1,115 @@ + + + + +mat profile list + + +
+

zowematprofilelist

+

Get the list of available monitor profiles.

+

Usage

+

zowe mat profile list [options]

+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mat-profile | --mat-p (string)

    +
      +
    • The name of a (mat) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mq.html b/static/v2.15.x/web_help/docs/zowe_mq.html new file mode 100644 index 0000000000..ecd7458b8f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mq.html @@ -0,0 +1,20 @@ + + + + +mq + + +
+

zowemq

+

Interact with IBM MQ for z/OS.

+

Usage

+

zowe mq <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • run - Run an IBM MQ script command for queue manager configuration
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mq_run.html b/static/v2.15.x/web_help/docs/zowe_mq_run.html new file mode 100644 index 0000000000..47d7d28cf9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mq_run.html @@ -0,0 +1,20 @@ + + + + +mq run + + +
+

zowemqrun

+

MQ Utilities

+

Usage

+

zowe mq run <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • mqsc - Run an IBM MQ script command for queue manager configuration
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_mq_run_mqsc.html b/static/v2.15.x/web_help/docs/zowe_mq_run_mqsc.html new file mode 100644 index 0000000000..f50ea05ea4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_mq_run_mqsc.html @@ -0,0 +1,130 @@ + + + + +mq run mqsc + + +
+

zowemqrunmqsc

+

MQ Utilities

+

Usage

+

zowe mq run mqsc <qmgr> <cmd> [options]

+

Positional Arguments

+
    +
  • +

    qmgr (string)

    +
      +
    • The queue manager to apply the command to
    • +
    +
  • +
  • +

    cmd (string)

    +
      +
    • The MQSC command
    • +
    +
  • +
+

MQ Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The host name used to access the IBM MQ REST API. This might be the host name of the IBM MQ mqweb server, or the Zowe API Mediation Layer..
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number used to access the IBM MQ REST API. This might be the port number of the IBM MQ mqweb server, or the Zowe API Mediation Layer.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The mainframe (MQ) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The mainframe (MQ) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the MQ protocol (http or https).

      +

      Default value: http
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --mq-profile | --mq-p (string)

    +
      +
    • The name of a (mq) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    The following sequence shows how to query a server-connection channel that is called NEWSVRCONN on an MQ queue manager - our example queue manager is called MQ99:

    +
      +
    • zowe mq run mqsc MQ99 "DISPLAY CHANNEL(NEWSVRCONN)"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_omspool.html b/static/v2.15.x/web_help/docs/zowe_omspool.html new file mode 100644 index 0000000000..63e8862d67 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_omspool.html @@ -0,0 +1,20 @@ + + + + +omspool + + +
+

zoweomspool

+

Interact with Spool™

+

Usage

+

zowe omspool <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_omspool_issue.html b/static/v2.15.x/web_help/docs/zowe_omspool_issue.html new file mode 100644 index 0000000000..1ab8cc8535 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_omspool_issue.html @@ -0,0 +1,20 @@ + + + + +omspool issue + + +
+

zoweomspoolissue

+

Issue Spool commands.

+

Usage

+

zowe omspool issue <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_omspool_issue_command.html b/static/v2.15.x/web_help/docs/zowe_omspool_issue_command.html new file mode 100644 index 0000000000..cc9d2df41d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_omspool_issue_command.html @@ -0,0 +1,172 @@ + + + + +omspool issue command + + +
+

zoweomspoolissuecommand

+

Issue commands to work with Spool.

+

Usage

+

zowe omspool issue command <command-text> [options]

+

Positional Arguments

+
    +
  • +

    command-text (string)

    +
      +
    • The Spool command to issue.
    • +
    +
  • +
+

SPOOL OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --spoolhlq | --hlq (string)

    +
      +
    • High level qualifier of Spool installation.
    • +
    +
  • +
  • +

    --subsys | --sub (string)

    +
      +
    • +

      Spool subsystem name.

      +

      Default value: ESF

      +
    • +
    +
  • +
  • +

    --outds | --out (string)

    +
      +
    • The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.
    • +
    +
  • +
  • +

    --clist | --cl (string)

    +
      +
    • The data set containing ESFZOWE REXX exec.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --omspool-profile | --omspool-p (string)

    +
      +
    • The name of a (omspool) profile to load for this command execution.
    • +
    +
  • +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issue the Spool command 'DS' to display the status of the ESF system:

    +
      +
    • zowe omspool issue command "DS"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ops.html b/static/v2.15.x/web_help/docs/zowe_ops.html new file mode 100644 index 0000000000..65c04267db --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ops.html @@ -0,0 +1,24 @@ + + + + +ops + + +
+

zoweops

+

Interact with OPS/MVS® for automation administration and resource management.

+

Usage

+

zowe ops <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • disable - Disable OPS/MVS rules.
  • +
  • enable - Enables OPS/MVS rules.
  • +
  • show - Display data associated with OPS/MVS automation elements (for example, rules or SSM resources).
  • +
  • start - Starts an ssm resource in OPS/MVS
  • +
  • stop - Stop OPS/MVS resources.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ops_disable.html b/static/v2.15.x/web_help/docs/zowe_ops_disable.html new file mode 100644 index 0000000000..4a996f96a7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ops_disable.html @@ -0,0 +1,20 @@ + + + + +ops disable + + +
+

zoweopsdisable

+

Disable OPS/MVS rules.

+

Usage

+

zowe ops disable <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • rule - Disable the specified rule.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ops_disable_rule.html b/static/v2.15.x/web_help/docs/zowe_ops_disable_rule.html new file mode 100644 index 0000000000..8f2d50d024 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ops_disable_rule.html @@ -0,0 +1,133 @@ + + + + +ops disable rule + + +
+

zoweopsdisablerule

+

Disable the specified rule.

+

Usage

+

zowe ops disable rule <ruleset> <rule> [options]

+

Positional Arguments

+
    +
  • +

    ruleset (string)

    +
      +
    • The rule set containing the rule.
    • +
    +
  • +
  • +

    rule (string)

    +
      +
    • The name of the rule.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ops-profile | --ops-p (string)

    +
      +
    • The name of a (ops) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Disable MYRULE on ruleset OPSRULES on subsystem OPSS.:

    +
      +
    • zowe ops disable rule OPSRULES MYRULE --subsystem OPSS
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ops_enable.html b/static/v2.15.x/web_help/docs/zowe_ops_enable.html new file mode 100644 index 0000000000..f38c95a19e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ops_enable.html @@ -0,0 +1,20 @@ + + + + +ops enable + + +
+

zoweopsenable

+

Enables OPS/MVS rules.This will cause SSM to take the necessary action to enable that rule.

+

Usage

+

zowe ops enable <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • rule - Enable the specified rule.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ops_enable_rule.html b/static/v2.15.x/web_help/docs/zowe_ops_enable_rule.html new file mode 100644 index 0000000000..1ec60a742c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ops_enable_rule.html @@ -0,0 +1,133 @@ + + + + +ops enable rule + + +
+

zoweopsenablerule

+

Enable the specified rule.

+

Usage

+

zowe ops enable rule <ruleset> <rule> [options]

+

Positional Arguments

+
    +
  • +

    ruleset (string)

    +
      +
    • The rule set containing the rule.
    • +
    +
  • +
  • +

    rule (string)

    +
      +
    • The name of the rule.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ops-profile | --ops-p (string)

    +
      +
    • The name of a (ops) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Enable MYRULE on ruleset OPSRULES on subsystem OPSS.:

    +
      +
    • zowe ops enable rule OPSRULES MYRULE --subsystem OPSS
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ops_show.html b/static/v2.15.x/web_help/docs/zowe_ops_show.html new file mode 100644 index 0000000000..6f1ba0a61d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ops_show.html @@ -0,0 +1,21 @@ + + + + +ops show + + +
+

zoweopsshow

+

Display data associated with OPS/MVS automation elements (for example, rules or SSM resources).

+

Usage

+

zowe ops show <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • resource - Display data associated with the specified SSM resource.
  • +
  • rule - Display data associated with the specified rule.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ops_show_resource.html b/static/v2.15.x/web_help/docs/zowe_ops_show_resource.html new file mode 100644 index 0000000000..fb1227c137 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ops_show_resource.html @@ -0,0 +1,136 @@ + + + + +ops show resource + + +
+

zoweopsshowresource

+

Display data associated with the specified SSM resource. Currently, only resource state is displayed.

+

Usage

+

zowe ops show resource <resourcename> [options]

+

Positional Arguments

+
    +
  • +

    resourcename (string)

    +
      +
    • The name of the resource.
    • +
    +
  • +
+

Options

+
    +
  • +

    --tablename | --table (string)

    +
      +
    • The name of the table that contains the resource. If not specified, the command will search the SSM tables to find the resource. If the resource exists in multiple tables, the desired state of the resource will be set to the appropriate DOWN state in all the tables where the resource exists.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ops-profile | --ops-p (string)

    +
      +
    • The name of a (ops) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show current and desired state of RESOURCE1 on table MYTABLE on subsystem OPSS.:

    +
      +
    • zowe ops show resource RESOURCE1 --tablename MYTABLE --subsystem OPSS
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ops_show_rule.html b/static/v2.15.x/web_help/docs/zowe_ops_show_rule.html new file mode 100644 index 0000000000..ec8eedad4e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ops_show_rule.html @@ -0,0 +1,133 @@ + + + + +ops show rule + + +
+

zoweopsshowrule

+

Display data associated with the specified rule. Currently, only rule status is displayed.

+

Usage

+

zowe ops show rule <ruleset> <rule> [options]

+

Positional Arguments

+
    +
  • +

    ruleset (string)

    +
      +
    • The rule set containing the rule.
    • +
    +
  • +
  • +

    rule (string)

    +
      +
    • The name of the rule.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ops-profile | --ops-p (string)

    +
      +
    • The name of a (ops) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show the status of MYRULE on ruleset OPSRULES on subsystem OPSS:

    +
      +
    • zowe ops show rule OPSRULES MYRULE --subsystem OPSS
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ops_start.html b/static/v2.15.x/web_help/docs/zowe_ops_start.html new file mode 100644 index 0000000000..8b388fc0a7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ops_start.html @@ -0,0 +1,20 @@ + + + + +ops start + + +
+

zoweopsstart

+

Start OPS/MVS resources.

+

Usage

+

zowe ops start <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • resource - Start the specified resource.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ops_start_resource.html b/static/v2.15.x/web_help/docs/zowe_ops_start_resource.html new file mode 100644 index 0000000000..38b4c3d518 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ops_start_resource.html @@ -0,0 +1,148 @@ + + + + +ops start resource + + +
+

zoweopsstartresource

+

Start the specified resource. The desired state of the resource willbe set to the appropriate UP state and SSM will take actions to start the resource.

+

Usage

+

zowe ops start resource <resourcename> [options]

+

Positional Arguments

+
    +
  • +

    resourcename (string)

    +
      +
    • The name of the resource.
    • +
    +
  • +
+

Options

+
    +
  • +

    --tablename | --table (string)

    +
      +
    • The name of the table that contains the resource. If not specified, the command will search the SSM tables to find the resource. If the resource exists in multiple tables, the desired state of the resource will be set to the appropriate DOWN state in all the tables where the resource exists.
    • +
    +
  • +
  • +

    --wait | -w (number)

    +
      +
    • Wait for the specified number of seconds for the current state of the SSM resource to match the new desired state. If more than the specified number of seconds elapses and the current and desired state still do not match, the command will fail with a timeout error.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ops-profile | --ops-p (string)

    +
      +
    • The name of a (ops) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Start RESOURCE1 on table MYTABLE on subsystem OPSS.:

    +
      +
    • zowe ops start resource RESOURCE1 --tablename MYTABLE --subsystem OPSS
    • +
    +
  • +
  • +

    Start RESOURCE1 on table MYTABLE on subsystem OPSS and wait for up to 2 minutes for RESOURCE1 to have a current state of UP.:

    +
      +
    • zowe ops start resource RESOURCE1 --tablename MYTABLE --subsystem OPSS -w 120
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ops_stop.html b/static/v2.15.x/web_help/docs/zowe_ops_stop.html new file mode 100644 index 0000000000..b01bde56ad --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ops_stop.html @@ -0,0 +1,20 @@ + + + + +ops stop + + +
+

zoweopsstop

+

Stop OPS/MVS resources.

+

Usage

+

zowe ops stop <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • resource - Stop the specified resource.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_ops_stop_resource.html b/static/v2.15.x/web_help/docs/zowe_ops_stop_resource.html new file mode 100644 index 0000000000..9208cb4283 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_ops_stop_resource.html @@ -0,0 +1,148 @@ + + + + +ops stop resource + + +
+

zoweopsstopresource

+

Stop the specified resource. The desired state of the resource willbe set to the appropriate DOWN state and SSM will take actions to start the resource.

+

Usage

+

zowe ops stop resource <resourcename> [options]

+

Positional Arguments

+
    +
  • +

    resourcename (string)

    +
      +
    • The name of the resource.
    • +
    +
  • +
+

Options

+
    +
  • +

    --tablename | --table (string)

    +
      +
    • The name of the table that contains the resource. If not specified, the command will search the SSM tables to find the resource. If the resource exists in multiple tables, the desired state of the resource will be set to the appropriate DOWN state in all the tables where the resource exists.
    • +
    +
  • +
  • +

    --wait | -w (number)

    +
      +
    • Wait for the specified number of seconds for the current state of the SSM resource to match the new desired state. If more than the specified number of seconds elapses and the current and desired state still do not match, the command will fail with a timeout error.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ops-profile | --ops-p (string)

    +
      +
    • The name of a (ops) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Stop RESOURCE1 on table MYTABLE on subsystem OPSS.:

    +
      +
    • zowe ops stop resource RESOURCE1 --tablename MYTABLE --subsystem OPSS
    • +
    +
  • +
  • +

    Start RESOURCE1 on table MYTABLE on subsystem OPSS and wait for up to 2 minutes for RESOURCE1 to have a current state of DOWN.:

    +
      +
    • zowe ops stop resource RESOURCE1 --tablename MYTABLE --subsystem OPSS -w 120
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_plugins.html b/static/v2.15.x/web_help/docs/zowe_plugins.html new file mode 100644 index 0000000000..b6a06db261 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_plugins.html @@ -0,0 +1,25 @@ + + + + +plugins + + +
+

zoweplugins

+

Install and manage plug-ins.

+

Usage

+

zowe plugins <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_plugins_install.html b/static/v2.15.x/web_help/docs/zowe_plugins_install.html new file mode 100644 index 0000000000..f7fd17a698 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_plugins_install.html @@ -0,0 +1,108 @@ + + + + +plugins install + + +
+

zowepluginsinstall

+

Install plug-ins to an application.

+

Usage

+

zowe plugins install [plugin...] [options]

+

Positional Arguments

+
    +
  • +

    plugin... (string)

    +
      +
    • +

      A space-separated list of plug-ins to install. A plug-in can be any format that is accepted by the `npm install` command (local directory, TAR file, git URL, public package, private package, etc...).

      +

      To use a relative local directory, at least one '/' or '\' must exist in the plug-in path. For example, you have a local plug-in in a folder called 'test-plugin' that you want to install. Specify the relative local directory by issuing the following command:

      +

      zowe plugins install ./test-plugin

      +

      If you omit the './', then the install command looks for 'test-plugin' in an npm registry.

      +

      If the plugin argument is omitted, the plugins.json file will determine which plug-ins are installed. For more information on the plugins.json file, see the --file option.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --file (local file path)

    +
      +
    • +

      Specifies the location of a plugins.json file that contains the plug-ins you want to install.

      +

      All plug-ins specified in plugins.json will be installed to the base CLI and the contents will be placed into /home/<user>/.zowe/plugins/plugins.json.

      +

      If you do not specify a plugins.json file and do not specify a plug-in, the default plugin.json file (/home/<user>/.zowe/plugins/plugins.json) will be used. This provides a way to install plug-ins that were lost or corrupted after reinstalling or updating Zowe CLI.

      +
    • +
    +
  • +
  • +

    --registry (string)

    +
      +
    • +

      The npm registry that is used when installing remote packages. When this value is omitted, the value returned by `npm config get registry` is used.

      +

      For more information about npm registries, see: https://docs.npmjs.com/misc/registry

      +
    • +
    +
  • +
  • +

    --login (boolean)

    +
      +
    • +

      The flag to add a registry user account to install from secure registry. It saves credentials to the .npmrc file using `npm login`. When this value is omitted, credentials from .npmrc file is used. If you used this flag once for specific registry, you don't have to use it again, it uses credentials from .npmrc file.

      +

      For more information about npm registries, see:
      +https://docs.npmjs.com/cli/login for NPM >= 9
      +https://docs.npmjs.com/cli/adduser for NPM < 9

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Install plug-ins saved in /home/<user>/.zowe/plugins/plugins.json:

    +
      +
    • zowe plugins install
    • +
    +
  • +
  • +

    Install plug-ins saved in a properly formatted config file:

    +
      +
    • zowe plugins install --file /some/file/path/file_name.json
    • +
    +
  • +
  • +

    Install a remote plug-in:

    +
      +
    • zowe plugins install my-plugin
    • +
    +
  • +
  • +

    Install a remote plug-in using semver:

    +
      +
    • zowe plugins install my-plugin@"^1.2.3"
    • +
    +
  • +
  • +

    Install a remote plug-in from the specified registry:

    +
      +
    • zowe plugins install my-plugin --registry https://registry.npmjs.org/
    • +
    +
  • +
  • +

    Install a local folder, local TAR file, and a git URL:

    +
      +
    • zowe plugins install ./local-file /root/tar/some-tar.tgz git://github.com/project/repository.git#v1.0.0
    • +
    +
  • +
  • +

    Install a remote plug-in from the registry which requires authorization(don't need to use this flag if you have already logged in before):

    +
      +
    • zowe plugins install my-plugin --registry https://registry.npmjs.org/ --login
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_plugins_list.html b/static/v2.15.x/web_help/docs/zowe_plugins_list.html new file mode 100644 index 0000000000..6c6bab6e5c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_plugins_list.html @@ -0,0 +1,24 @@ + + + + +plugins list + + +
+

zowepluginslist

+

List all plug-ins installed.

+

Usage

+

zowe plugins list [options]

+

Options

+
    +
  • +

    --short | -s (boolean)

    +
      +
    • Show output in abbreviated format
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_plugins_show-first-steps.html b/static/v2.15.x/web_help/docs/zowe_plugins_show-first-steps.html new file mode 100644 index 0000000000..76b2f170fa --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_plugins_show-first-steps.html @@ -0,0 +1,36 @@ + + + + +plugins show-first-steps + + +
+

zowepluginsshow-first-steps

+

Show first steps required to set up plugin for use.

+

Usage

+

zowe plugins show-first-steps [plugin] [options]

+

Positional Arguments

+
    +
  • +

    plugin (string)

    +
      +
    • +

      The name of the installed plug-in to show first steps for.

      +

      If the plug-in argument is omitted, no action is taken.

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show first steps for a plugin called 'my-plugin':

    +
      +
    • zowe plugins show-first-steps my-plugin
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_plugins_uninstall.html b/static/v2.15.x/web_help/docs/zowe_plugins_uninstall.html new file mode 100644 index 0000000000..1edde32f62 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_plugins_uninstall.html @@ -0,0 +1,36 @@ + + + + +plugins uninstall + + +
+

zowepluginsuninstall

+

Uninstall plug-ins.

+

Usage

+

zowe plugins uninstall [plugin...] [options]

+

Positional Arguments

+
    +
  • +

    plugin... (string)

    +
      +
    • +

      The name of the plug-in to uninstall.

      +

      If the plug-in argument is omitted, no action is taken.

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Uninstall a plug-in:

    +
      +
    • zowe plugins uninstall my-plugin
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_plugins_update.html b/static/v2.15.x/web_help/docs/zowe_plugins_update.html new file mode 100644 index 0000000000..21ca6f2b9d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_plugins_update.html @@ -0,0 +1,65 @@ + + + + +plugins update + + +
+

zowepluginsupdate

+

Update plug-ins.

+

Usage

+

zowe plugins update [plugin...] [options]

+

Positional Arguments

+
    +
  • +

    plugin... (string)

    +
      +
    • +

      The name of the plug-in to update.

      +

      If the plug-in argument is omitted, no action is taken.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --registry (string)

    +
      +
    • +

      The npm registry that is used when installing remote packages. When this value is omitted, the value returned by `npm config get registry` is used.

      +

      For more information about npm registries, see: https://docs.npmjs.com/misc/registry

      +
    • +
    +
  • +
  • +

    --login (boolean)

    +
      +
    • +

      The flag to add a registry user account to install from secure registry. It saves credentials to the .npmrc file using `npm login`. When this value is omitted, credentials from .npmrc file is used. If you used this flag once for specific registry, you don't have to use it again, it uses credentials from .npmrc file.

      +

      For more information about npm registries, see:
      +https://docs.npmjs.com/cli/login for NPM >= 9
      +https://docs.npmjs.com/cli/adduser for NPM < 9

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a plug-in:

    +
      +
    • zowe plugins update my-plugin
    • +
    +
  • +
  • +

    Update a remote plug-in from the registry which requires authorization(don't need to use this flag if you have already logged in before):

    +
      +
    • zowe plugins update my-plugin --registry https://registry.npmjs.org/ --login
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_plugins_validate.html b/static/v2.15.x/web_help/docs/zowe_plugins_validate.html new file mode 100644 index 0000000000..838c1468da --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_plugins_validate.html @@ -0,0 +1,70 @@ + + + + +plugins validate + + +
+

zowepluginsvalidate

+

Validate a plug-in that has been installed.

+

Usage

+

zowe plugins validate [plugin] [options]

+

Positional Arguments

+
    +
  • +

    plugin (string)

    +
      +
    • +

      The name of the plug-in to validate.
      +Validation issues identified for this plug-in are displayed.

      +

      If the plug-in argument is omitted, all installed plug-ins are validated.

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --fail-on-error | --foe (boolean)

    +
      +
    • +

      Enables throwing an error and setting an error code if plugin validation detects an error

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --fail-on-warning | --fow (boolean)

    +
      +
    • +

      Treat validation warnings as errors. Requires fail-on-error.

      +

      Default value: false

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Validate a plug-in named my-plugin:

    +
      +
    • zowe plugins validate my-plugin
    • +
    +
  • +
  • +

    Validate all installed plug-ins:

    +
      +
    • zowe plugins validate
    • +
    +
  • +
  • +

    Validate a plug-in named my-plugin, and treat warnings as errors:

    +
      +
    • zowe plugins validate my-plugin --fail-on-warning
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles.html new file mode 100644 index 0000000000..7ac3b9236a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles.html @@ -0,0 +1,26 @@ + + + + +profiles + + +
+

zoweprofiles

+

Create and manage configuration profiles.

+

Warning: This group has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create.html b/static/v2.15.x/web_help/docs/zowe_profiles_create.html new file mode 100644 index 0000000000..561e42eb18 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create.html @@ -0,0 +1,49 @@ + + + + +profiles create + + +
+

zoweprofilescreate

+

Create new configuration profiles.

+

Warning: This group has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_base-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_base-profile.html new file mode 100644 index 0000000000..4ab9710b41 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_base-profile.html @@ -0,0 +1,131 @@ + + + + +profiles create base-profile + + +
+

zoweprofilescreatebase-profile

+

Base profile that stores values shared by multiple service profiles

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create base-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new base profile. You can load this profile by using the name on commands that support the "--base-profile" option.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the base profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a profile called 'base1' to connect to host example.com and port 443:

    +
      +
    • zowe profiles create base-profile base1 --host example.com --port 443 --user admin --password 123456
    • +
    +
  • +
  • +

    Create a profile called 'base2' to connect to host example.com (default port - 443) and allow self-signed certificates:

    +
      +
    • zowe profiles create base-profile base2 --host example.com --user admin --password 123456 --reject-unauthorized false
    • +
    +
  • +
  • +

    Create a profile called 'base3' to connect to host example.com and port 1443, not specifying a username or password so they are not stored on disk; these will need to be specified on every command:

    +
      +
    • zowe profiles create base-profile base3 --host example.com --port 1443
    • +
    +
  • +
  • +

    Create a zosmf profile called 'base4' to connect to default port 443 and allow self-signed certificates, not specifying a username, password, or host so they are not stored on disk; these will need to be specified on every command:

    +
      +
    • zowe profiles create base-profile base4 --reject-unauthorized false
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_ca7-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_ca7-profile.html new file mode 100644 index 0000000000..37aef57676 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_ca7-profile.html @@ -0,0 +1,92 @@ + + + + +profiles create ca7-profile + + +
+

zoweprofilescreateca7-profile

+

A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create ca7-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ca7 profile. You can load this profile by using the name on commands that support the "--ca7-profile" option.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the ca7 profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_caview-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_caview-profile.html new file mode 100644 index 0000000000..3415b8874c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_caview-profile.html @@ -0,0 +1,96 @@ + + + + +profiles create caview-profile + + +
+

zoweprofilescreatecaview-profile

+

Configuration profile for View

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create caview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new caview profile. You can load this profile by using the name on commands that support the "--caview-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • +

      Port of the target View REST API instance.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • +

      Context name of the target View REST API instance.

      +

      Default value: web-viewer

      +
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the caview profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a profile for View™ Plug-in for Zowe CLI named 'myProfile' to connect to 'mf.company.org' over HTTP on port 80 using the 'johndoe' account.:

    +
      +
    • zowe profiles create caview-profile myProfile --hostname mf.company.org --protocol http --port 80 --username johndoe --password secret
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_cics-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_cics-profile.html new file mode 100644 index 0000000000..abd7d797c1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_cics-profile.html @@ -0,0 +1,111 @@ + + + + +profiles create cics-profile + + +
+

zoweprofilescreatecics-profile

+

A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create cics-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new cics profile. You can load this profile by using the name on commands that support the "--cics-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CMCI server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The CMCI server port

      +

      Default value: 1490

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your username to connect to CICS
    • +
    +
  • +
  • +

    --password | -p (string)

    +
      +
    • Your password to connect to CICS
    • +
    +
  • +
  • +

    --region-name (string)

    +
      +
    • The name of the CICS region name to interact with
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to interact with
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the cics profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a cics profile named 'cics123' to connect to CICS at host zos123 and port 1490:

    +
      +
    • zowe profiles create cics-profile cics123 --host zos123 --port 1490 --user ibmuser --password myp4ss
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_db2-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_db2-profile.html new file mode 100644 index 0000000000..7f1e9b192d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_db2-profile.html @@ -0,0 +1,77 @@ + + + + +profiles create db2-profile + + +
+

zoweprofilescreatedb2-profile

+

A profile for interaction with Db2 for the z/OS region

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new db2 profile. You can load this profile by using the name on commands that support the "--db2-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The Db2 server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Db2 server port number
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The Db2 user ID (may be the same as the TSO login)
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The Db2 password (may be the same as the TSO password)
    • +
    +
  • +
  • +

    --database | -d (string)

    +
      +
    • The name of the database
    • +
    +
  • +
  • +

    --ssl-file | -s (string)

    +
      +
    • Path to an SSL Certificate file
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the db2 profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_dbm-db2-options-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_dbm-db2-options-profile.html new file mode 100644 index 0000000000..2c9212610d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_dbm-db2-options-profile.html @@ -0,0 +1,239 @@ + + + + +profiles create dbm-db2-options-profile + + +
+

zoweprofilescreatedbm-db2-options-profile

+

The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create dbm-db2-options-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new dbm-db2-options profile. You can load this profile by using the name on commands that support the "--dbm-db2-options-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --change-set | --cs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.

      +

      Format:

      +

      <change-set-creator.change-set-name>

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --change-set-values | --csv (array)

    +
      +
    • +

      Specifies the global change specifications that modify Db2 object attributes during a command execution.

      +

      Format:

      +

      <object-attribute> <from-value> <to-value>

      +

      The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

      +

      For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Example:

      +

      The following example demonstrates changes to the table schema (creator) and tablespace names:

      +

      TBCR TEST% PROD%
      +TBTS TESTTS% PRODTS%

      +

      Note:
      +- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
      +- The changeSetValues options-profile option has the same behavior as the change-set-file command option.

      +
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --description | -d (string)

    +
      +
    • Specifies a 1- to 25-character description for the RC/Migrator compare strategy.
    • +
    +
  • +
  • +

    --id (string)

    +
      +
    • +

      Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.

      +

      Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @.

      +
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --match-set | --ms (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <match-set-creator.match-set-name>

      +

      For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --match-set-values | --msv (array)

    +
      +
    • +

      Specifies the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <object-type> <source-name-mask> <target-name-mask>;

      +

      STOGROUP <name> <name>
      +DATABASE <name> <name>
      +TABLESPACE <database.name> <database.name>
      +TABLE <schema.name> <schema.name>
      +INDEX <schema.name> <schema.name>
      +VIEW <schema.name> <schema.name>
      +SYNONYM <schema.name> <schema.name>
      +ALIAS <schema.name> <schema.name>
      +TRIGGER <schema.name> <schema.name>
      +SEQUENCE <schema.name> <schema.name>
      +FUNCTION <schema.name[.version]> <schema.name[.version]>
      +PROCEDURE <schema.name[.version]> <schema.name[.version]>

      +

      Note:
      +- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
      +- <schema> must be between 1 and 128 characters.
      +- <version> must be between 1 and 64 characters.

      +

      A mask specification can include the following wildcard characters:

      +

      Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.

      +

      Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.

      +

      Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.

      +

      Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.

      +

      Example:

      +

      The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:

      +

      TABLE MY%.%TABLE YOUR%.%TABLE;
      +TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
      +TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
      +TABLE *.MYTABLE *.YOURTABLE;

      +

      For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note:
      +- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.
      +- The matchSetValues options-profile option has the same behavior as the match-set-file command option.

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --rule-set | --rs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.

      +

      Format:

      +

      <rule-set-creator.rule-set-name>

      +

      For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --source-db2 | --sd (string)

    +
      +
    • +

      Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to use a command.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
  • +

    --type | -t (string)

    +
      +
    • +

      Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.

      +

      Allowed values: drop, create

      +
    • +
    +
  • +
  • +

    --verify | -v (string)

    +
      +
    • +

      Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.

      +

      Default value: no

      +

      Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the dbm-db2-options profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_dbm-db2-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_dbm-db2-profile.html new file mode 100644 index 0000000000..3ca5f72925 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_dbm-db2-profile.html @@ -0,0 +1,195 @@ + + + + +profiles create dbm-db2-profile + + +
+

zoweprofilescreatedbm-db2-profile

+

The DBM-Db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create dbm-db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new dbm-db2 profile. You can load this profile by using the name on commands that support the "--dbm-db2-profile" option.
    • +
    +
  • +
+

DBM-Db2 Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies the DBM Data Service REST API server host name or TCP/IP address to use.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies the DBM Data Service REST API server TCP/IP port number.

      +

      Default value: 7300

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies the mainframe user name that you want to use to connect to the mainframe systems during execution of the Zowe CLI commands. This user name can be the same as your TSO login ID.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • +

      Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt

      +

      Default value: [object Object]

      +
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • +

      Specifies a string array of z/OS JCL JOB statements.

      +

      Default value: //DB2DVOPS JOB CLASS=A,,// MSGCLASS=X

      +
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • +

      Specifies the prefix (high-level qualifier) in z/OS work data set names.

      +

      Default value: ${user}.dbmdb2

      +
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • +

      Specifies whether to delete work data sets on a mainframe after the request is fulfilled.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • +

      Specifies whether to overwrite output files if they exist.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • +

      Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.

      +

      Default value: ${user}

      +
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • +

      Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.

      +

      Default value: ${user}

      +
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • +

      Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.

      +

      Default value: ;

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the dbm-db2 profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a DBM-Db2 profile named profile_name1 and default values for all the options:

    +
      +
    • zowe profiles create dbm-db2-profile profile_name1
    • +
    +
  • +
  • +

    Create a DBM-Db2 profile named dbm123 that connects to the DBM Data Service at host dbm123 and port 1443 as user db2user and password myp4ss:

    +
      +
    • zowe profiles create dbm-db2-profile dbm123 --host dbm123 --port 1443 --user db2user --password myp4ss
    • +
    +
  • +
  • +

    Create a DBM-Db2 profile named dbm124 that connects to the DBM Data Service at host dbm124 and the default port as user db2user and password myp4ss, and allow self-signed certificates:

    +
      +
    • zowe profiles create dbm-db2-profile dbm124 --host dbm124 --user db2user --password myp4ss --reject-unauthorized false
    • +
    +
  • +
  • +

    Create a DBM-Db2 profile named dbm125 that connects to the DBM Data Service at host dbm125 and port 1443 and requires a user and password to be specified on every dbm-db2 command. DBM Data Service access to Db2 subsystems SUBA and SUBB uses prod@host1.com:322 and test@host2.com:522, respectively:

    +
      +
    • zowe profiles create dbm-db2-profile dbm125 --host dbm125 --port 1443 --environment-list "SUBA:prod@host1.com:322,SUBB:test@host2.net:522"
    • +
    +
  • +
  • +

    Create a DBM-Db2 profile named dbm126 that uses specified job cards for every mainframe job:

    +
      +
    • zowe profiles create dbm-db2-profile dbm126 --job-cards "//DB2DVOPS JOB (123456789),'DB2 PROVISIONING',NOTIFY=&SYSUID," "// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1)," "// REGION=0M,TIME=NOLIMIT"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_ebg-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_ebg-profile.html new file mode 100644 index 0000000000..7d0a5919c2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_ebg-profile.html @@ -0,0 +1,88 @@ + + + + +profiles create ebg-profile + + +
+

zoweprofilescreateebg-profile

+

An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the Endevor Bridge for Git server of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create ebg-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ebg profile. You can load this profile by using the name on commands that support the "--ebg-profile" option.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the ebg profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_endevor-location-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_endevor-location-profile.html new file mode 100644 index 0000000000..46811ef6df --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_endevor-location-profile.html @@ -0,0 +1,149 @@ + + + + +profiles create endevor-location-profile + + +
+

zoweprofilescreateendevor-location-profile

+

The Endevor element location, where you specify your working environment, system and subsystem

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create endevor-location-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new endevor-location profile. You can load this profile by using the name on commands that support the "--endevor-location-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • +

      The STC/datasource of the session

      +

      Default value: ENDEVOR

      +
    • +
    +
  • +
  • +

    --environment | --env (string)

    +
      +
    • +

      The Endevor environment where your project resides

      +

      Default value: DEV

      +
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where the element resides
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your element resides
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage where your project resides

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The Endevor comment you want to use when performing an action
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The Endevor CCID you want to use when performing an action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • +

      The return code of Endevor that defines a failed action

      +

      Default value: 8

      +
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • +

      Always override element signout, without having to specify the override signout option on each command

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --file-extension | --ext (string)

    +
      +
    • +

      The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:

      +
              none: File name is equal to element name, no extension is added\.
      +
      +        file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added\.
      +
      +        type\-name: The type name is used as the file extension\.
      +
      +        mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead\.
      +
      +

      Default value: mixed
      +Allowed values: none, type-name, file-ext, mixed

      +
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the endevor-location profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a location profile called 'ndvrLoc' to work at Endevor location ENV/1/SYS/SUBSYS, with elements of type COBOL, using Endevor web services configuration ENDEVOR:

    +
      +
    • zowe profiles create endevor-location-profile ndvrLoc --env ENV --sys SYS --sub SUBSYS --typ COBOL --sn 1 -i ENDEVOR
    • +
    +
  • +
  • +

    Create a location profile called 'ndvrLoc2' to work at Endevor location ENV/1/SYS/SUBSYS, using CCID 'CCID' and comment 'sample comment':

    +
      +
    • zowe profiles create endevor-location-profile ndvrLoc2 --env ENV --sys SYS --sub SUBSYS --sn 1 --com 'sample comment' --cci 'CCID'
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_endevor-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_endevor-profile.html new file mode 100644 index 0000000000..51ed699f04 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_endevor-profile.html @@ -0,0 +1,108 @@ + + + + +profiles create endevor-profile + + +
+

zoweprofilescreateendevor-profile

+

The endevor profile schema, where you specify your endevor session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create endevor-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new endevor profile. You can load this profile by using the name on commands that support the "--endevor-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • The hostname of the endevor session
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number of the endevor session
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • The username of the endevor session
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The password of the user
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to Endevor Rest API

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path used for connecting to Endevor Rest API

      +

      Default value: EndevorService/api/v2

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --report-dir | --rd (string)

    +
      +
    • +

      The default path where any reports will be written to, either absolute or relative to current directory

      +

      Default value: .

      +
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the endevor profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an endevor profile called 'ndvrSample' to connect to Endevor web services at host ndvr123 and port 8080,using http protocol, with / EndevorService/api/v2 base path, allowing self-signed certificates:

    +
      +
    • zowe profiles create endevor-profile ndvrSample --host ndvr123 --port 8080 --user ibmuser --password myp4ss --prot http --base-path EndevorService/api/v2 --reject-unauthorized false
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_fmp-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_fmp-profile.html new file mode 100644 index 0000000000..cf2e9ba686 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_fmp-profile.html @@ -0,0 +1,117 @@ + + + + +profiles create fmp-profile + + +
+

zoweprofilescreatefmp-profile

+

File Master Plus profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create fmp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new fmp profile. You can load this profile by using the name on commands that support the "--fmp-profile" option.
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Specifies File Master Plus server port.

      +

      Default value: 51914

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the fmp profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a fmp profile with http protocol:

    +
      +
    • zowe profiles create fmp-profile fmp123 --host fmphost --port 19853 --user mfuser --password m4pass --protocol http
    • +
    +
  • +
  • +

    Create a fmp profile with https protocol and allow self-signed certificates:

    +
      +
    • zowe profiles create fmp-profile fmp234 --host fmphost --port 19854 --user mfuser --password m4pass --protocol https --reject-unauthorized false
    • +
    +
  • +
  • +

    Create a fmp profile with API Mediation layer:

    +
      +
    • zowe profiles create fmp-profile fmpAPIML --host fmpAPIML --port 2020 --user mfuser --pass mfp4ss --protocol https --reject-unauthorized false --base-path /api/v1/serviceID
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_idms-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_idms-profile.html new file mode 100644 index 0000000000..d319835be4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_idms-profile.html @@ -0,0 +1,104 @@ + + + + +profiles create idms-profile + + +
+

zoweprofilescreateidms-profile

+

An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create idms-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new idms profile. You can load this profile by using the name on commands that support the "--idms-profile" option.
    • +
    +
  • +
+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates

      +

      Default value: true

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the idms profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an IDMS profile called 'idms11' to connect to IDMS API services at host zos123 and port 1234, with base path api/v1/caidms and allow self-signed certificates:

    +
      +
    • zowe profiles create idms-profile idms11 --host zos123 --port 1234 --user myuid --password mypass --base-path api/v1/caidms --reject-unauthorized false
    • +
    +
  • +
  • +

    Create an IDMS profile called 'idms99' to connect to IDMS API services at host zos123 and port 1234, specify a default data source SYS195 to be used by JDBC to identify a target system and allow self-signed certificates:

    +
      +
    • zowe profiles create idms-profile idms99 --host zos123 --port 1234 --user myuid --password mypass --datasource SYS195 --reject-unauthorized false
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_ims-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_ims-profile.html new file mode 100644 index 0000000000..e1330072ca --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_ims-profile.html @@ -0,0 +1,120 @@ + + + + +profiles create ims-profile + + +
+

zoweprofilescreateims-profile

+

An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create ims-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ims profile. You can load this profile by using the name on commands that support the "--ims-profile" option.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the ims profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a ims profile named 'ims123' to connect to IMS APIs at host zos123 and port 1490. The name of the IMS plex in this example is 'PLEX1' and the IMS region we want to communicate with has a host of zos124 and a port of 1491:

    +
      +
    • zowe profiles create ims-profile ims123 --host zos123 --port 1490 --user ibmuser --pass myp4ss --plex PLEX1 --ich zos124 --icp 1491
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_jclcheck-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_jclcheck-profile.html new file mode 100644 index 0000000000..d998a8c8be --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_jclcheck-profile.html @@ -0,0 +1,120 @@ + + + + +profiles create jclcheck-profile + + +
+

zoweprofilescreatejclcheck-profile

+

A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create jclcheck-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new jclcheck profile. You can load this profile by using the name on commands that support the "--jclcheck-profile" option.
    • +
    +
  • +
+

JCLCheck Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      Port for the JCLCheck API service that is running on the mainframe system.

      +

      Default value: 12697

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: cajclcheck/api/v1

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for JCLCheck connection (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --jclcheck-options | --jo (string)

    +
      +
    • The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the jclcheck profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a JCLCheck profile named 'jcl123' to run JCLCheck at host zos123 and port 1234:

    +
      +
    • zowe profiles create jclcheck-profile jcl123 --host zos123 --port 1234 --user ibmuser --pass myp4ss
    • +
    +
  • +
  • +

    Create a JCLCheck profile with default set of JCLCheck runtime options specified:

    +
      +
    • zowe profiles create jclcheck-profile jcl123 --host zos123 --port 1234 --user ibmuser --pass myp4ss --jo "NOAS NOAU NOHCD NOJCL NORES NOSIGN"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_jclx-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_jclx-profile.html new file mode 100644 index 0000000000..08eb64a0df --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_jclx-profile.html @@ -0,0 +1,72 @@ + + + + +profiles create jclx-profile + + +
+

zoweprofilescreatejclx-profile

+

Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create jclx-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new jclx profile. You can load this profile by using the name on commands that support the "--jclx-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --remote-home-dir (string)

    +
      +
    • The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
    • +
    +
  • +
  • +

    --remote-temp-dir (string)

    +
      +
    • The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
    • +
    +
  • +
  • +

    --language (string)

    +
      +
    • +

      The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.

      +

      Default value: ENG
      +Allowed values: ENG, JPN

      +
    • +
    +
  • +
  • +

    --response-encoding (string)

    +
      +
    • +

      The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.

      +

      Default value: utf-8

      +
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the jclx profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_mat-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_mat-profile.html new file mode 100644 index 0000000000..9e9dc5c73b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_mat-profile.html @@ -0,0 +1,114 @@ + + + + +profiles create mat-profile + + +
+

zoweprofilescreatemat-profile

+

MAT Analyze CLI profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create mat-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new mat profile. You can load this profile by using the name on commands that support the "--mat-profile" option.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the mat profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a MAT profile called 'matprofile' using your MAT configuration and REST API details, with the MAT REST API server integrated with the Zowe API Mediation Layer:

    +
      +
    • zowe profiles create mat-profile matprofile --o http --H localhost --P 1234 --u user --pw pass --base-path 'API\MAT'
    • +
    +
  • +
  • +

    Create a MAT profile called 'matprofile' using your MAT configuration and the details of the MAT REST API server without integration with the Zowe API Mediation Layer,and define the 'c:\listings' directory to store program listings for instant analysis from your VS Code IDE:

    +
      +
    • zowe profiles create mat-profile matprofile --o http --H localhost --P 1234 --u user --pw pass --listingDir 'c:\listings'
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_mq-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_mq-profile.html new file mode 100644 index 0000000000..5246bbecb4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_mq-profile.html @@ -0,0 +1,96 @@ + + + + +profiles create mq-profile + + +
+

zoweprofilescreatemq-profile

+

An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create mq-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new mq profile. You can load this profile by using the name on commands that support the "--mq-profile" option.
    • +
    +
  • +
+

MQ Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The host name used to access the IBM MQ REST API. This might be the host name of the IBM MQ mqweb server, or the Zowe API Mediation Layer..
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number used to access the IBM MQ REST API. This might be the port number of the IBM MQ mqweb server, or the Zowe API Mediation Layer.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The mainframe (MQ) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The mainframe (MQ) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the MQ protocol (http or https).

      +

      Default value: http
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the mq profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an MQ profile named 'mqprofile' to connect to MQ at host zos123 and port 1234:

    +
      +
    • zowe profiles create mq-profile mq --host mq123 --port 1234 --user ibmuser --password myp4ss
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_omspool-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_omspool-profile.html new file mode 100644 index 0000000000..cab907d4de --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_omspool-profile.html @@ -0,0 +1,86 @@ + + + + +profiles create omspool-profile + + +
+

zoweprofilescreateomspool-profile

+

Configuration profile for Spool, where you specify information about your Spool instance

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create omspool-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new omspool profile. You can load this profile by using the name on commands that support the "--omspool-profile" option.
    • +
    +
  • +
+

SPOOL OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --spoolhlq | --hlq (string)

    +
      +
    • High level qualifier of Spool installation.
    • +
    +
  • +
  • +

    --subsys | --sub (string)

    +
      +
    • +

      Spool subsystem name.

      +

      Default value: ESF

      +
    • +
    +
  • +
  • +

    --outds | --out (string)

    +
      +
    • The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.
    • +
    +
  • +
  • +

    --clist | --cl (string)

    +
      +
    • The data set containing ESFZOWE REXX exec.
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the omspool profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a profile for Spool named 'myProfile' with TSO account information '1234567890', Spool installation high level qualifier of 'SPOOL.HLQ', subsystem name 'ESF1', output response data set 'OUTPUT.RESPONSE.DS', and data set 'USER.CLIST', containing ESFZOWE REXX exec:

    +
      +
    • zowe profiles create omspool-profile myProfile --account 1234567890 --spoolhlq SPOOL.HLQ --subsys ESF1 --outds OUTPUT.RESPONSE.DS --clist USER.CLIST
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_ops-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_ops-profile.html new file mode 100644 index 0000000000..6cdb3ab1c0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_ops-profile.html @@ -0,0 +1,102 @@ + + + + +profiles create ops-profile + + +
+

zoweprofilescreateops-profile

+

The OPS Web Services session profile schema, where you specify your session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create ops-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ops profile. You can load this profile by using the name on commands that support the "--ops-profile" option.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the ops profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an OPS profile called 'myLPAR' to connect to OPS Web Services at host lpar123 and port 8080, using http protocol, allowing self-signed certificates:

    +
      +
    • zowe profiles create ops-profile myLPAR --host lpar123 --port 8080 --user ibmuser --password !@#$^ --prot http --reject-unauthorized false
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_pma-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_pma-profile.html new file mode 100644 index 0000000000..6523722b99 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_pma-profile.html @@ -0,0 +1,86 @@ + + + + +profiles create pma-profile + + +
+

zoweprofilescreatepma-profile

+

MAT Detect CLI profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create pma-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new pma profile. You can load this profile by using the name on commands that support the "--pma-profile" option.
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • +

      Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)

      +

      Default value: A

      +
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the pma profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a PMA profile called pma123 using your valid jobcard and PMA configuration details:

    +
      +
    • zowe profiles create pma-profile pma123 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_ssh-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_ssh-profile.html new file mode 100644 index 0000000000..9cd8ebde54 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_ssh-profile.html @@ -0,0 +1,116 @@ + + + + +profiles create ssh-profile + + +
+

zoweprofilescreatessh-profile

+

z/OS SSH Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create ssh-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ssh profile. You can load this profile by using the name on commands that support the "--ssh-profile" option.
    • +
    +
  • +
+

z/OS Ssh Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OS SSH server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OS SSH server port.

      +

      Default value: 22

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --privateKey | --key | --pk (string)

    +
      +
    • Path to a file containing your private key, that must match a public key stored in the server for authentication
    • +
    +
  • +
  • +

    --keyPassphrase | --passphrase | --kp (string)

    +
      +
    • Private key passphrase, which unlocks the private key.
    • +
    +
  • +
  • +

    --handshakeTimeout | --timeout | --to (number)

    +
      +
    • How long in milliseconds to wait for the SSH handshake to complete.
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the ssh profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a ssh profile called 'ssh111' to connect to z/OS SSH server at host 'zos123' and default port 22:

    +
      +
    • zowe profiles create ssh-profile ssh111 --host sshhost --user ibmuser --password myp4ss
    • +
    +
  • +
  • +

    Create a ssh profile called 'ssh222' to connect to z/OS SSH server at host 'zos123' and port 13022:

    +
      +
    • zowe profiles create ssh-profile ssh222 --host sshhost --port 13022 --user ibmuser --password myp4ss
    • +
    +
  • +
  • +

    Create a ssh profile called 'ssh333' to connect to z/OS SSH server at host 'zos123' using a privatekey '/path/to/privatekey' and its decryption passphrase 'privateKeyPassphrase' for privatekey authentication:

    +
      +
    • zowe profiles create ssh-profile ssh333 --host sshhost --user ibmuser --privateKey /path/to/privatekey --keyPassphrase privateKeyPassphrase
    • +
    +
  • +
  • +

    Create a ssh profile called 'ssh444' to connect to z/OS SSH server on default port 22, without specifying username, host, or password, preventing those values from being stored on disk:

    +
      +
    • zowe profiles create ssh-profile ssh444 --privateKey /path/to/privatekey
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_sysview-format-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_sysview-format-profile.html new file mode 100644 index 0000000000..8437d56ec4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_sysview-format-profile.html @@ -0,0 +1,92 @@ + + + + +profiles create sysview-format-profile + + +
+

zoweprofilescreatesysview-format-profile

+

The SYSVIEW format profile schema, where you specify display settings

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create sysview-format-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new sysview-format profile. You can load this profile by using the name on commands that support the "--sysview-format-profile" option.
    • +
    +
  • +
+

display options

+
    +
  • +

    --context-fields | --cf (array)

    +
      +
    • Context fields to display. Defaults to hiding all context
    • +
    +
  • +
  • +

    --overview | -o (boolean)

    +
      +
    • Display the overview section
    • +
    +
  • +
  • +

    --info | -i (boolean)

    +
      +
    • Display the information area, if any
    • +
    +
  • +
  • +

    --pretty | -p (boolean)

    +
      +
    • Display formatted data
    • +
    +
  • +
  • +

    --blank-if-zero | --biz | -b (boolean)

    +
      +
    • Show a blank space instead of '0' values
    • +
    +
  • +
  • +

    --truncate | --tr (boolean)

    +
      +
    • +

      Truncate displays that are too wide for the console

      +

      Default value: false

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the sysview-format profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a SYSVIEW format profile to display the context fields 'commandName' and 'screenTitle', the information area, and not the overview area for all requests. Data will be formatted, and '0's will be blanked:

    +
      +
    • zowe profiles create sysview-format-profile myFormat --cf commandName screenTitle --overview false --info true --pretty true --biz true
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_sysview-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_sysview-profile.html new file mode 100644 index 0000000000..73cdb3700a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_sysview-profile.html @@ -0,0 +1,113 @@ + + + + +profiles create sysview-profile + + +
+

zoweprofilescreatesysview-profile

+

The SYSVIEW session profile schema, where you specify your session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create sysview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new sysview profile. You can load this profile by using the name on commands that support the "--sysview-profile" option.
    • +
    +
  • +
+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • +

      SSID of the SYSVIEW instance. Default value: GSVX

      +

      Default value: GSVX

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: /api/v1

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the sysview profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a SYSVIEW profile called 'myLPAR' to connect to the SYSVIEW REST API at host lpar123, port 8080, and ssid ABCD:

    +
      +
    • zowe profiles create sysview-profile myLPAR --host lpar123 --port 8080 --user ibmuser --password !@#$^ --ssid ABCD
    • +
    +
  • +
  • +

    You already have a base profile with username and password. Create a SYSVIEW profile to specify host lpar123 and port 8080, using the default ssid of GSVX:

    +
      +
    • zowe profiles create sysview-profile myLPAR2 --host lpar123 --port 8080
    • +
    +
  • +
  • +

    You already have a base profile to connect to an API Mediation Layer and use SSO tokens. Create a SYSVIEW profile to point to the SYSVIEW REST API by specifying the base path /my-sysview-instance/api/v1:

    +
      +
    • zowe profiles create sysview-profile myLPAR3 --base-path /my-sysview-instance/api/v1
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_tso-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_tso-profile.html new file mode 100644 index 0000000000..5c0aa25900 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_tso-profile.html @@ -0,0 +1,125 @@ + + + + +profiles create tso-profile + + +
+

zoweprofilescreatetso-profile

+

z/OS TSO/E User Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create tso-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new tso profile. You can load this profile by using the name on commands that support the "--tso-profile" option.
    • +
    +
  • +
+

TSO ADDRESS SPACE OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • Your z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --character-set | --cs (string)

    +
      +
    • +

      Character set for address space to convert messages and responses from UTF-8 to EBCDIC.

      +

      Default value: 697

      +
    • +
    +
  • +
  • +

    --code-page | --cp (string)

    +
      +
    • +

      Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC.

      +

      Default value: 1047

      +
    • +
    +
  • +
  • +

    --columns | --cols (number)

    +
      +
    • +

      The number of columns on a screen.

      +

      Default value: 80

      +
    • +
    +
  • +
  • +

    --logon-procedure | -l (string)

    +
      +
    • +

      The logon procedure to use when creating TSO procedures on your behalf.

      +

      Default value: IZUFPROC

      +
    • +
    +
  • +
  • +

    --region-size | --rs (number)

    +
      +
    • +

      Region size for the TSO/E address space.

      +

      Default value: 4096

      +
    • +
    +
  • +
  • +

    --rows (number)

    +
      +
    • +

      The number of rows on a screen.

      +

      Default value: 24

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the tso profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a tso profile called 'myprof' with default settings and JES accounting information of 'IZUACCT':

    +
      +
    • zowe profiles create tso-profile myprof -a IZUACCT
    • +
    +
  • +
  • +

    Create a tso profile called 'largeregion' with a region size of 8192, a logon procedure of MYPROC, and JES accounting information of '1234':

    +
      +
    • zowe profiles create tso-profile largeregion -a 1234 --rs 8192
    • +
    +
  • +
  • +

    Create a tso profile called 'myprof2' with default settings and region size of 8192, without storing the user account on disk:

    +
      +
    • zowe profiles create tso-profile myprof2 --rs 8192
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_zftp-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_zftp-profile.html new file mode 100644 index 0000000000..5504913733 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_zftp-profile.html @@ -0,0 +1,119 @@ + + + + +profiles create zftp-profile + + +
+

zoweprofilescreatezftp-profile

+

Configuration profile for z/OS FTP

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create zftp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new zftp profile. You can load this profile by using the name on commands that support the "--zftp-profile" option.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set.
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Options

+
    +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the zftp profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a zftp profile called 'myprofile' with default settings (port, timeout, etc.) to connect with the host system 123.:

    +
      +
    • zowe profiles create zftp-profile myprofile -u ibmuser -p ibmp4ss -H sys123
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_create_zosmf-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_create_zosmf-profile.html new file mode 100644 index 0000000000..8ac38dacee --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_create_zosmf-profile.html @@ -0,0 +1,153 @@ + + + + +profiles create zosmf-profile + + +
+

zoweprofilescreatezosmf-profile

+

z/OSMF Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config init' command

+

Usage

+

zowe profiles create zosmf-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new zosmf profile. You can load this profile by using the name on commands that support the "--zosmf-profile" option.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set and USS files. The default encoding if not specified is IBM-1047.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite the zosmf profile when a profile of the same name exists.
    • +
    +
  • +
  • +

    --disable-defaults | --dd (boolean)

    +
      +
    • Disable populating profile values of undefined properties with default values.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a zosmf profile called 'zos123' to connect to z/OSMF at host zos123 and port 1443:

    +
      +
    • zowe profiles create zosmf-profile zos123 --host zos123 --port 1443 --user ibmuser --password myp4ss
    • +
    +
  • +
  • +

    Create a zosmf profile called 'zos124' to connect to z/OSMF at the host zos124 (default port - 443) and allow self-signed certificates:

    +
      +
    • zowe profiles create zosmf-profile zos124 --host zos124 --user ibmuser --password myp4ss --reject-unauthorized false
    • +
    +
  • +
  • +

    Create a zosmf profile called 'zos125' to connect to z/OSMF at the host zos125 and port 1443, not specifying a username or password so they are not stored on disk; these will need to be specified on every command:

    +
      +
    • zowe profiles create zosmf-profile zos125 --host zos125 --port 1443
    • +
    +
  • +
  • +

    Create a zosmf profile called 'zos126' to connect to z/OSMF on the default port 443 and allow self-signed certificates, not specifying a username, password, or host so they are not stored on disk; these will need to be specified on every command:

    +
      +
    • zowe profiles create zosmf-profile zos126 --reject-unauthorized false
    • +
    +
  • +
  • +

    Create a zosmf profile called 'zosAPIML' to connect to z/OSMF via the Zowe API Mediation Layer running at host 'zosAPIML', port '7554', and allow for self-signed certificates. To reduce duplication, you could elect to store the 'host', 'port', 'reject-unauthorized', 'user', and 'password' values for the API Mediation Layer in a base profile and only store the 'base-path' of the service in the zosmf profile:

    +
      +
    • zowe profiles create zosmf-profile zosAPIML --host zosAPIML --port 7554 --user ibmuser --password myp4ss --reject-unauthorized false --base-path ibmzosmf/api/v1
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete.html new file mode 100644 index 0000000000..0130fed92a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete.html @@ -0,0 +1,49 @@ + + + + +profiles delete + + +
+

zoweprofilesdelete

+

Delete existing profiles.

+

Warning: This group has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_base-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_base-profile.html new file mode 100644 index 0000000000..99e4644e82 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_base-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete base-profile + + +
+

zoweprofilesdeletebase-profile

+

Delete a base profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete base-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the base profile to be deleted. You can also load this profile by using the name on commands that support the "--base-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a base profile named profilename:

    +
      +
    • zowe profiles delete base-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_ca7-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_ca7-profile.html new file mode 100644 index 0000000000..4590c0bc69 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_ca7-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete ca7-profile + + +
+

zoweprofilesdeleteca7-profile

+

Delete a ca7 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete ca7-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the ca7 profile to be deleted. You can also load this profile by using the name on commands that support the "--ca7-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a ca7 profile named profilename:

    +
      +
    • zowe profiles delete ca7-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_caview-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_caview-profile.html new file mode 100644 index 0000000000..2c05c6805a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_caview-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete caview-profile + + +
+

zoweprofilesdeletecaview-profile

+

Delete a caview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete caview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the caview profile to be deleted. You can also load this profile by using the name on commands that support the "--caview-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a caview profile named profilename:

    +
      +
    • zowe profiles delete caview-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_cics-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_cics-profile.html new file mode 100644 index 0000000000..38658d406d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_cics-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete cics-profile + + +
+

zoweprofilesdeletecics-profile

+

Delete a cics profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete cics-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the cics profile to be deleted. You can also load this profile by using the name on commands that support the "--cics-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a cics profile named profilename:

    +
      +
    • zowe profiles delete cics-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_db2-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_db2-profile.html new file mode 100644 index 0000000000..d7136c3cd0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_db2-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete db2-profile + + +
+

zoweprofilesdeletedb2-profile

+

Delete a db2 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the db2 profile to be deleted. You can also load this profile by using the name on commands that support the "--db2-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a db2 profile named profilename:

    +
      +
    • zowe profiles delete db2-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_dbm-db2-options-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_dbm-db2-options-profile.html new file mode 100644 index 0000000000..21a8628d9c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_dbm-db2-options-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete dbm-db2-options-profile + + +
+

zoweprofilesdeletedbm-db2-options-profile

+

Delete a dbm-db2-options profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete dbm-db2-options-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the dbm-db2-options profile to be deleted. You can also load this profile by using the name on commands that support the "--dbm-db2-options-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a dbm-db2-options profile named profilename:

    +
      +
    • zowe profiles delete dbm-db2-options-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_dbm-db2-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_dbm-db2-profile.html new file mode 100644 index 0000000000..b0e12f079b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_dbm-db2-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete dbm-db2-profile + + +
+

zoweprofilesdeletedbm-db2-profile

+

Delete a dbm-db2 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete dbm-db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the dbm-db2 profile to be deleted. You can also load this profile by using the name on commands that support the "--dbm-db2-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a dbm-db2 profile named profilename:

    +
      +
    • zowe profiles delete dbm-db2-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_ebg-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_ebg-profile.html new file mode 100644 index 0000000000..bc1123e7cd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_ebg-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete ebg-profile + + +
+

zoweprofilesdeleteebg-profile

+

Delete a ebg profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete ebg-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the ebg profile to be deleted. You can also load this profile by using the name on commands that support the "--ebg-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a ebg profile named profilename:

    +
      +
    • zowe profiles delete ebg-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_endevor-location-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_endevor-location-profile.html new file mode 100644 index 0000000000..001fcde1eb --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_endevor-location-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete endevor-location-profile + + +
+

zoweprofilesdeleteendevor-location-profile

+

Delete a endevor-location profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete endevor-location-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the endevor-location profile to be deleted. You can also load this profile by using the name on commands that support the "--endevor-location-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a endevor-location profile named profilename:

    +
      +
    • zowe profiles delete endevor-location-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_endevor-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_endevor-profile.html new file mode 100644 index 0000000000..d4019d5446 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_endevor-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete endevor-profile + + +
+

zoweprofilesdeleteendevor-profile

+

Delete a endevor profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete endevor-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the endevor profile to be deleted. You can also load this profile by using the name on commands that support the "--endevor-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a endevor profile named profilename:

    +
      +
    • zowe profiles delete endevor-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_fmp-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_fmp-profile.html new file mode 100644 index 0000000000..c74c99951b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_fmp-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete fmp-profile + + +
+

zoweprofilesdeletefmp-profile

+

Delete a fmp profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete fmp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the fmp profile to be deleted. You can also load this profile by using the name on commands that support the "--fmp-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a fmp profile named profilename:

    +
      +
    • zowe profiles delete fmp-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_idms-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_idms-profile.html new file mode 100644 index 0000000000..ffde23d593 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_idms-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete idms-profile + + +
+

zoweprofilesdeleteidms-profile

+

Delete a idms profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete idms-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the idms profile to be deleted. You can also load this profile by using the name on commands that support the "--idms-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a idms profile named profilename:

    +
      +
    • zowe profiles delete idms-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_ims-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_ims-profile.html new file mode 100644 index 0000000000..681d8f1fd4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_ims-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete ims-profile + + +
+

zoweprofilesdeleteims-profile

+

Delete a ims profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete ims-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the ims profile to be deleted. You can also load this profile by using the name on commands that support the "--ims-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a ims profile named profilename:

    +
      +
    • zowe profiles delete ims-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_jclcheck-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_jclcheck-profile.html new file mode 100644 index 0000000000..9e18e08f74 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_jclcheck-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete jclcheck-profile + + +
+

zoweprofilesdeletejclcheck-profile

+

Delete a jclcheck profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete jclcheck-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the jclcheck profile to be deleted. You can also load this profile by using the name on commands that support the "--jclcheck-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a jclcheck profile named profilename:

    +
      +
    • zowe profiles delete jclcheck-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_jclx-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_jclx-profile.html new file mode 100644 index 0000000000..9b7dbe211f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_jclx-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete jclx-profile + + +
+

zoweprofilesdeletejclx-profile

+

Delete a jclx profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete jclx-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the jclx profile to be deleted. You can also load this profile by using the name on commands that support the "--jclx-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a jclx profile named profilename:

    +
      +
    • zowe profiles delete jclx-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_mat-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_mat-profile.html new file mode 100644 index 0000000000..650368adf4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_mat-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete mat-profile + + +
+

zoweprofilesdeletemat-profile

+

Delete a mat profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete mat-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the mat profile to be deleted. You can also load this profile by using the name on commands that support the "--mat-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a mat profile named profilename:

    +
      +
    • zowe profiles delete mat-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_mq-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_mq-profile.html new file mode 100644 index 0000000000..be51f47a1f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_mq-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete mq-profile + + +
+

zoweprofilesdeletemq-profile

+

Delete a mq profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete mq-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the mq profile to be deleted. You can also load this profile by using the name on commands that support the "--mq-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a mq profile named profilename:

    +
      +
    • zowe profiles delete mq-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_omspool-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_omspool-profile.html new file mode 100644 index 0000000000..77aa4d6cf7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_omspool-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete omspool-profile + + +
+

zoweprofilesdeleteomspool-profile

+

Delete a omspool profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete omspool-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the omspool profile to be deleted. You can also load this profile by using the name on commands that support the "--omspool-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a omspool profile named profilename:

    +
      +
    • zowe profiles delete omspool-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_ops-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_ops-profile.html new file mode 100644 index 0000000000..ea9863610a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_ops-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete ops-profile + + +
+

zoweprofilesdeleteops-profile

+

Delete a ops profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete ops-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the ops profile to be deleted. You can also load this profile by using the name on commands that support the "--ops-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a ops profile named profilename:

    +
      +
    • zowe profiles delete ops-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_pma-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_pma-profile.html new file mode 100644 index 0000000000..066b0e20cf --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_pma-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete pma-profile + + +
+

zoweprofilesdeletepma-profile

+

Delete a pma profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete pma-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the pma profile to be deleted. You can also load this profile by using the name on commands that support the "--pma-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a pma profile named profilename:

    +
      +
    • zowe profiles delete pma-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_ssh-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_ssh-profile.html new file mode 100644 index 0000000000..ccb64ce6fe --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_ssh-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete ssh-profile + + +
+

zoweprofilesdeletessh-profile

+

Delete a ssh profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete ssh-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the ssh profile to be deleted. You can also load this profile by using the name on commands that support the "--ssh-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a ssh profile named profilename:

    +
      +
    • zowe profiles delete ssh-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_sysview-format-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_sysview-format-profile.html new file mode 100644 index 0000000000..df39cdac51 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_sysview-format-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete sysview-format-profile + + +
+

zoweprofilesdeletesysview-format-profile

+

Delete a sysview-format profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete sysview-format-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the sysview-format profile to be deleted. You can also load this profile by using the name on commands that support the "--sysview-format-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a sysview-format profile named profilename:

    +
      +
    • zowe profiles delete sysview-format-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_sysview-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_sysview-profile.html new file mode 100644 index 0000000000..54521d5031 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_sysview-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete sysview-profile + + +
+

zoweprofilesdeletesysview-profile

+

Delete a sysview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete sysview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the sysview profile to be deleted. You can also load this profile by using the name on commands that support the "--sysview-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a sysview profile named profilename:

    +
      +
    • zowe profiles delete sysview-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_tso-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_tso-profile.html new file mode 100644 index 0000000000..3661c9bba6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_tso-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete tso-profile + + +
+

zoweprofilesdeletetso-profile

+

Delete a tso profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete tso-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the tso profile to be deleted. You can also load this profile by using the name on commands that support the "--tso-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a tso profile named profilename:

    +
      +
    • zowe profiles delete tso-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_zftp-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_zftp-profile.html new file mode 100644 index 0000000000..c6bbd4b13e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_zftp-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete zftp-profile + + +
+

zoweprofilesdeletezftp-profile

+

Delete a zftp profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete zftp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the zftp profile to be deleted. You can also load this profile by using the name on commands that support the "--zftp-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a zftp profile named profilename:

    +
      +
    • zowe profiles delete zftp-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_delete_zosmf-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_delete_zosmf-profile.html new file mode 100644 index 0000000000..caa2922c8c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_delete_zosmf-profile.html @@ -0,0 +1,44 @@ + + + + +profiles delete zosmf-profile + + +
+

zoweprofilesdeletezosmf-profile

+

Delete a zosmf profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

+

Warning: This command has been deprecated.
+Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

+

Usage

+

zowe profiles delete zosmf-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the zosmf profile to be deleted. You can also load this profile by using the name on commands that support the "--zosmf-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --force (boolean)

    +
      +
    • Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a zosmf profile named profilename:

    +
      +
    • zowe profiles delete zosmf-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list.html b/static/v2.15.x/web_help/docs/zowe_profiles_list.html new file mode 100644 index 0000000000..9151364ea3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list.html @@ -0,0 +1,49 @@ + + + + +profiles list + + +
+

zoweprofileslist

+

List profiles of the type {{type}}.

+

Warning: This group has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_base-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_base-profiles.html new file mode 100644 index 0000000000..0c7df99380 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_base-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list base-profiles + + +
+

zoweprofileslistbase-profiles

+

Base profile that stores values shared by multiple service profiles

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list base-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List base profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type base:

    +
      +
    • zowe profiles list base-profiles
    • +
    +
  • +
  • +

    List profiles of type base and display their contents:

    +
      +
    • zowe profiles list base-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_ca7-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_ca7-profiles.html new file mode 100644 index 0000000000..db5d7afc0d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_ca7-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list ca7-profiles + + +
+

zoweprofileslistca7-profiles

+

A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list ca7-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List ca7 profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type ca7:

    +
      +
    • zowe profiles list ca7-profiles
    • +
    +
  • +
  • +

    List profiles of type ca7 and display their contents:

    +
      +
    • zowe profiles list ca7-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_caview-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_caview-profiles.html new file mode 100644 index 0000000000..182d91457a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_caview-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list caview-profiles + + +
+

zoweprofileslistcaview-profiles

+

Configuration profile for View

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list caview-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List caview profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type caview:

    +
      +
    • zowe profiles list caview-profiles
    • +
    +
  • +
  • +

    List profiles of type caview and display their contents:

    +
      +
    • zowe profiles list caview-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_cics-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_cics-profiles.html new file mode 100644 index 0000000000..b089fae8a9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_cics-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list cics-profiles + + +
+

zoweprofileslistcics-profiles

+

A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list cics-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List cics profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type cics:

    +
      +
    • zowe profiles list cics-profiles
    • +
    +
  • +
  • +

    List profiles of type cics and display their contents:

    +
      +
    • zowe profiles list cics-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_db2-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_db2-profiles.html new file mode 100644 index 0000000000..ae978b6fc3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_db2-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list db2-profiles + + +
+

zoweprofileslistdb2-profiles

+

A profile for interaction with Db2 for the z/OS region

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list db2-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List db2 profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type db2:

    +
      +
    • zowe profiles list db2-profiles
    • +
    +
  • +
  • +

    List profiles of type db2 and display their contents:

    +
      +
    • zowe profiles list db2-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_dbm-db2-options-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_dbm-db2-options-profiles.html new file mode 100644 index 0000000000..bf64d561b8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_dbm-db2-options-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list dbm-db2-options-profiles + + +
+

zoweprofileslistdbm-db2-options-profiles

+

The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list dbm-db2-options-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List dbm-db2-options profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type dbm-db2-options:

    +
      +
    • zowe profiles list dbm-db2-options-profiles
    • +
    +
  • +
  • +

    List profiles of type dbm-db2-options and display their contents:

    +
      +
    • zowe profiles list dbm-db2-options-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_dbm-db2-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_dbm-db2-profiles.html new file mode 100644 index 0000000000..7ee2a4d8e7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_dbm-db2-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list dbm-db2-profiles + + +
+

zoweprofileslistdbm-db2-profiles

+

The DBM-Db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list dbm-db2-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List dbm-db2 profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type dbm-db2:

    +
      +
    • zowe profiles list dbm-db2-profiles
    • +
    +
  • +
  • +

    List profiles of type dbm-db2 and display their contents:

    +
      +
    • zowe profiles list dbm-db2-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_ebg-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_ebg-profiles.html new file mode 100644 index 0000000000..36d0b5b6e0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_ebg-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list ebg-profiles + + +
+

zoweprofileslistebg-profiles

+

An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the Endevor Bridge for Git server of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list ebg-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List ebg profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type ebg:

    +
      +
    • zowe profiles list ebg-profiles
    • +
    +
  • +
  • +

    List profiles of type ebg and display their contents:

    +
      +
    • zowe profiles list ebg-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_endevor-location-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_endevor-location-profiles.html new file mode 100644 index 0000000000..76b8bc24a8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_endevor-location-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list endevor-location-profiles + + +
+

zoweprofileslistendevor-location-profiles

+

The Endevor element location, where you specify your working environment, system and subsystem

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list endevor-location-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List endevor-location profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type endevor-location:

    +
      +
    • zowe profiles list endevor-location-profiles
    • +
    +
  • +
  • +

    List profiles of type endevor-location and display their contents:

    +
      +
    • zowe profiles list endevor-location-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_endevor-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_endevor-profiles.html new file mode 100644 index 0000000000..1a63258936 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_endevor-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list endevor-profiles + + +
+

zoweprofileslistendevor-profiles

+

The endevor profile schema, where you specify your endevor session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list endevor-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List endevor profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type endevor:

    +
      +
    • zowe profiles list endevor-profiles
    • +
    +
  • +
  • +

    List profiles of type endevor and display their contents:

    +
      +
    • zowe profiles list endevor-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_fmp-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_fmp-profiles.html new file mode 100644 index 0000000000..da03100099 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_fmp-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list fmp-profiles + + +
+

zoweprofileslistfmp-profiles

+

File Master Plus profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list fmp-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List fmp profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type fmp:

    +
      +
    • zowe profiles list fmp-profiles
    • +
    +
  • +
  • +

    List profiles of type fmp and display their contents:

    +
      +
    • zowe profiles list fmp-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_idms-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_idms-profiles.html new file mode 100644 index 0000000000..ebc0d01385 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_idms-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list idms-profiles + + +
+

zoweprofileslistidms-profiles

+

An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list idms-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List idms profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type idms:

    +
      +
    • zowe profiles list idms-profiles
    • +
    +
  • +
  • +

    List profiles of type idms and display their contents:

    +
      +
    • zowe profiles list idms-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_ims-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_ims-profiles.html new file mode 100644 index 0000000000..2d8baec791 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_ims-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list ims-profiles + + +
+

zoweprofileslistims-profiles

+

An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list ims-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List ims profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type ims:

    +
      +
    • zowe profiles list ims-profiles
    • +
    +
  • +
  • +

    List profiles of type ims and display their contents:

    +
      +
    • zowe profiles list ims-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_jclcheck-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_jclcheck-profiles.html new file mode 100644 index 0000000000..d829c257aa --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_jclcheck-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list jclcheck-profiles + + +
+

zoweprofileslistjclcheck-profiles

+

A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list jclcheck-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List jclcheck profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type jclcheck:

    +
      +
    • zowe profiles list jclcheck-profiles
    • +
    +
  • +
  • +

    List profiles of type jclcheck and display their contents:

    +
      +
    • zowe profiles list jclcheck-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_jclx-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_jclx-profiles.html new file mode 100644 index 0000000000..a202a40601 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_jclx-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list jclx-profiles + + +
+

zoweprofileslistjclx-profiles

+

Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list jclx-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List jclx profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type jclx:

    +
      +
    • zowe profiles list jclx-profiles
    • +
    +
  • +
  • +

    List profiles of type jclx and display their contents:

    +
      +
    • zowe profiles list jclx-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_mat-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_mat-profiles.html new file mode 100644 index 0000000000..4fd368e13f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_mat-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list mat-profiles + + +
+

zoweprofileslistmat-profiles

+

MAT Analyze CLI profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list mat-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List mat profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type mat:

    +
      +
    • zowe profiles list mat-profiles
    • +
    +
  • +
  • +

    List profiles of type mat and display their contents:

    +
      +
    • zowe profiles list mat-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_mq-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_mq-profiles.html new file mode 100644 index 0000000000..7cd98a1bc9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_mq-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list mq-profiles + + +
+

zoweprofileslistmq-profiles

+

An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list mq-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List mq profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type mq:

    +
      +
    • zowe profiles list mq-profiles
    • +
    +
  • +
  • +

    List profiles of type mq and display their contents:

    +
      +
    • zowe profiles list mq-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_omspool-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_omspool-profiles.html new file mode 100644 index 0000000000..810a27a997 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_omspool-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list omspool-profiles + + +
+

zoweprofileslistomspool-profiles

+

Configuration profile for Spool, where you specify information about your Spool instance

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list omspool-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List omspool profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type omspool:

    +
      +
    • zowe profiles list omspool-profiles
    • +
    +
  • +
  • +

    List profiles of type omspool and display their contents:

    +
      +
    • zowe profiles list omspool-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_ops-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_ops-profiles.html new file mode 100644 index 0000000000..310d321dda --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_ops-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list ops-profiles + + +
+

zoweprofileslistops-profiles

+

The OPS Web Services session profile schema, where you specify your session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list ops-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List ops profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type ops:

    +
      +
    • zowe profiles list ops-profiles
    • +
    +
  • +
  • +

    List profiles of type ops and display their contents:

    +
      +
    • zowe profiles list ops-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_pma-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_pma-profiles.html new file mode 100644 index 0000000000..d9e7d8f159 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_pma-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list pma-profiles + + +
+

zoweprofileslistpma-profiles

+

MAT Detect CLI profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list pma-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List pma profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type pma:

    +
      +
    • zowe profiles list pma-profiles
    • +
    +
  • +
  • +

    List profiles of type pma and display their contents:

    +
      +
    • zowe profiles list pma-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_ssh-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_ssh-profiles.html new file mode 100644 index 0000000000..5dd19b2ab0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_ssh-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list ssh-profiles + + +
+

zoweprofileslistssh-profiles

+

z/OS SSH Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list ssh-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List ssh profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type ssh:

    +
      +
    • zowe profiles list ssh-profiles
    • +
    +
  • +
  • +

    List profiles of type ssh and display their contents:

    +
      +
    • zowe profiles list ssh-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_sysview-format-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_sysview-format-profiles.html new file mode 100644 index 0000000000..7877bd9d56 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_sysview-format-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list sysview-format-profiles + + +
+

zoweprofileslistsysview-format-profiles

+

The SYSVIEW format profile schema, where you specify display settings

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list sysview-format-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List sysview-format profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type sysview-format:

    +
      +
    • zowe profiles list sysview-format-profiles
    • +
    +
  • +
  • +

    List profiles of type sysview-format and display their contents:

    +
      +
    • zowe profiles list sysview-format-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_sysview-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_sysview-profiles.html new file mode 100644 index 0000000000..be3b83934d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_sysview-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list sysview-profiles + + +
+

zoweprofileslistsysview-profiles

+

The SYSVIEW session profile schema, where you specify your session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list sysview-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List sysview profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type sysview:

    +
      +
    • zowe profiles list sysview-profiles
    • +
    +
  • +
  • +

    List profiles of type sysview and display their contents:

    +
      +
    • zowe profiles list sysview-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_tso-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_tso-profiles.html new file mode 100644 index 0000000000..be83b02b41 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_tso-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list tso-profiles + + +
+

zoweprofileslisttso-profiles

+

z/OS TSO/E User Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list tso-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List tso profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type tso:

    +
      +
    • zowe profiles list tso-profiles
    • +
    +
  • +
  • +

    List profiles of type tso and display their contents:

    +
      +
    • zowe profiles list tso-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_zftp-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_zftp-profiles.html new file mode 100644 index 0000000000..6ab03abdb5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_zftp-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list zftp-profiles + + +
+

zoweprofileslistzftp-profiles

+

Configuration profile for z/OS FTP

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list zftp-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List zftp profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type zftp:

    +
      +
    • zowe profiles list zftp-profiles
    • +
    +
  • +
  • +

    List profiles of type zftp and display their contents:

    +
      +
    • zowe profiles list zftp-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_list_zosmf-profiles.html b/static/v2.15.x/web_help/docs/zowe_profiles_list_zosmf-profiles.html new file mode 100644 index 0000000000..6390a39ffa --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_list_zosmf-profiles.html @@ -0,0 +1,41 @@ + + + + +profiles list zosmf-profiles + + +
+

zoweprofileslistzosmf-profiles

+

z/OSMF Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config list' command

+

Usage

+

zowe profiles list zosmf-profiles [options]

+

Options

+
    +
  • +

    --show-contents | --sc (boolean)

    +
      +
    • List zosmf profiles and their contents. All profile details will be printed as part of command output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List profiles of type zosmf:

    +
      +
    • zowe profiles list zosmf-profiles
    • +
    +
  • +
  • +

    List profiles of type zosmf and display their contents:

    +
      +
    • zowe profiles list zosmf-profiles --sc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default.html new file mode 100644 index 0000000000..90a118edb1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default.html @@ -0,0 +1,49 @@ + + + + +profiles set-default + + +
+

zoweprofilesset-default

+

Set which profiles are loaded by default.

+

Warning: This group has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_base-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_base-profile.html new file mode 100644 index 0000000000..7334a3c445 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_base-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default base-profile + + +
+

zoweprofilesset-defaultbase-profile

+

The base set default-profiles command allows you to set the default profiles for this command group. When a base command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default base-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the base group. When you issue commands within the base group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type base to the profile named 'profilename':

    +
      +
    • zowe profiles set-default base-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ca7-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ca7-profile.html new file mode 100644 index 0000000000..8ca5ccf6ec --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ca7-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default ca7-profile + + +
+

zoweprofilesset-defaultca7-profile

+

The ca7 set default-profiles command allows you to set the default profiles for this command group. When a ca7 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default ca7-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the ca7 group. When you issue commands within the ca7 group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type ca7 to the profile named 'profilename':

    +
      +
    • zowe profiles set-default ca7-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_caview-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_caview-profile.html new file mode 100644 index 0000000000..14e90c9df9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_caview-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default caview-profile + + +
+

zoweprofilesset-defaultcaview-profile

+

The caview set default-profiles command allows you to set the default profiles for this command group. When a caview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default caview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the caview group. When you issue commands within the caview group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type caview to the profile named 'profilename':

    +
      +
    • zowe profiles set-default caview-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_cics-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_cics-profile.html new file mode 100644 index 0000000000..b42c3ea31b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_cics-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default cics-profile + + +
+

zoweprofilesset-defaultcics-profile

+

The cics set default-profiles command allows you to set the default profiles for this command group. When a cics command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default cics-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the cics group. When you issue commands within the cics group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type cics to the profile named 'profilename':

    +
      +
    • zowe profiles set-default cics-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_db2-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_db2-profile.html new file mode 100644 index 0000000000..792e0f8025 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_db2-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default db2-profile + + +
+

zoweprofilesset-defaultdb2-profile

+

The db2 set default-profiles command allows you to set the default profiles for this command group. When a db2 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the db2 group. When you issue commands within the db2 group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type db2 to the profile named 'profilename':

    +
      +
    • zowe profiles set-default db2-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_dbm-db2-options-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_dbm-db2-options-profile.html new file mode 100644 index 0000000000..b1e66e3f5e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_dbm-db2-options-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default dbm-db2-options-profile + + +
+

zoweprofilesset-defaultdbm-db2-options-profile

+

The dbm-db2-options set default-profiles command allows you to set the default profiles for this command group. When a dbm-db2-options command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default dbm-db2-options-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the dbm-db2-options group. When you issue commands within the dbm-db2-options group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type dbm-db2-options to the profile named 'profilename':

    +
      +
    • zowe profiles set-default dbm-db2-options-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_dbm-db2-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_dbm-db2-profile.html new file mode 100644 index 0000000000..5b7fce4096 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_dbm-db2-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default dbm-db2-profile + + +
+

zoweprofilesset-defaultdbm-db2-profile

+

The dbm-db2 set default-profiles command allows you to set the default profiles for this command group. When a dbm-db2 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default dbm-db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the dbm-db2 group. When you issue commands within the dbm-db2 group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type dbm-db2 to the profile named 'profilename':

    +
      +
    • zowe profiles set-default dbm-db2-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ebg-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ebg-profile.html new file mode 100644 index 0000000000..f2b7dfce92 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ebg-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default ebg-profile + + +
+

zoweprofilesset-defaultebg-profile

+

The ebg set default-profiles command allows you to set the default profiles for this command group. When a ebg command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default ebg-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the ebg group. When you issue commands within the ebg group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type ebg to the profile named 'profilename':

    +
      +
    • zowe profiles set-default ebg-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_endevor-location-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_endevor-location-profile.html new file mode 100644 index 0000000000..2e7c94c2ed --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_endevor-location-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default endevor-location-profile + + +
+

zoweprofilesset-defaultendevor-location-profile

+

The endevor-location set default-profiles command allows you to set the default profiles for this command group. When a endevor-location command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default endevor-location-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the endevor-location group. When you issue commands within the endevor-location group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type endevor-location to the profile named 'profilename':

    +
      +
    • zowe profiles set-default endevor-location-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_endevor-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_endevor-profile.html new file mode 100644 index 0000000000..8b6d2f2b86 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_endevor-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default endevor-profile + + +
+

zoweprofilesset-defaultendevor-profile

+

The endevor set default-profiles command allows you to set the default profiles for this command group. When a endevor command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default endevor-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the endevor group. When you issue commands within the endevor group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type endevor to the profile named 'profilename':

    +
      +
    • zowe profiles set-default endevor-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_fmp-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_fmp-profile.html new file mode 100644 index 0000000000..1791538141 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_fmp-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default fmp-profile + + +
+

zoweprofilesset-defaultfmp-profile

+

The fmp set default-profiles command allows you to set the default profiles for this command group. When a fmp command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default fmp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the fmp group. When you issue commands within the fmp group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type fmp to the profile named 'profilename':

    +
      +
    • zowe profiles set-default fmp-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_idms-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_idms-profile.html new file mode 100644 index 0000000000..5f22b18e6e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_idms-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default idms-profile + + +
+

zoweprofilesset-defaultidms-profile

+

The idms set default-profiles command allows you to set the default profiles for this command group. When a idms command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default idms-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the idms group. When you issue commands within the idms group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type idms to the profile named 'profilename':

    +
      +
    • zowe profiles set-default idms-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ims-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ims-profile.html new file mode 100644 index 0000000000..afc31f9014 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ims-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default ims-profile + + +
+

zoweprofilesset-defaultims-profile

+

The ims set default-profiles command allows you to set the default profiles for this command group. When a ims command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default ims-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the ims group. When you issue commands within the ims group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type ims to the profile named 'profilename':

    +
      +
    • zowe profiles set-default ims-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_jclcheck-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_jclcheck-profile.html new file mode 100644 index 0000000000..f939da1b16 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_jclcheck-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default jclcheck-profile + + +
+

zoweprofilesset-defaultjclcheck-profile

+

The jclcheck set default-profiles command allows you to set the default profiles for this command group. When a jclcheck command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default jclcheck-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the jclcheck group. When you issue commands within the jclcheck group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type jclcheck to the profile named 'profilename':

    +
      +
    • zowe profiles set-default jclcheck-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_jclx-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_jclx-profile.html new file mode 100644 index 0000000000..4f53b9ac57 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_jclx-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default jclx-profile + + +
+

zoweprofilesset-defaultjclx-profile

+

The jclx set default-profiles command allows you to set the default profiles for this command group. When a jclx command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default jclx-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the jclx group. When you issue commands within the jclx group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type jclx to the profile named 'profilename':

    +
      +
    • zowe profiles set-default jclx-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_mat-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_mat-profile.html new file mode 100644 index 0000000000..1e920e2b8d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_mat-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default mat-profile + + +
+

zoweprofilesset-defaultmat-profile

+

The mat set default-profiles command allows you to set the default profiles for this command group. When a mat command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default mat-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the mat group. When you issue commands within the mat group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type mat to the profile named 'profilename':

    +
      +
    • zowe profiles set-default mat-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_mq-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_mq-profile.html new file mode 100644 index 0000000000..f0c266af5d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_mq-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default mq-profile + + +
+

zoweprofilesset-defaultmq-profile

+

The mq set default-profiles command allows you to set the default profiles for this command group. When a mq command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default mq-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the mq group. When you issue commands within the mq group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type mq to the profile named 'profilename':

    +
      +
    • zowe profiles set-default mq-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_omspool-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_omspool-profile.html new file mode 100644 index 0000000000..91caa77016 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_omspool-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default omspool-profile + + +
+

zoweprofilesset-defaultomspool-profile

+

The omspool set default-profiles command allows you to set the default profiles for this command group. When a omspool command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default omspool-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the omspool group. When you issue commands within the omspool group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type omspool to the profile named 'profilename':

    +
      +
    • zowe profiles set-default omspool-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ops-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ops-profile.html new file mode 100644 index 0000000000..acae349491 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ops-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default ops-profile + + +
+

zoweprofilesset-defaultops-profile

+

The ops set default-profiles command allows you to set the default profiles for this command group. When a ops command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default ops-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the ops group. When you issue commands within the ops group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type ops to the profile named 'profilename':

    +
      +
    • zowe profiles set-default ops-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_pma-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_pma-profile.html new file mode 100644 index 0000000000..24f78db4ff --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_pma-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default pma-profile + + +
+

zoweprofilesset-defaultpma-profile

+

The pma set default-profiles command allows you to set the default profiles for this command group. When a pma command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default pma-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the pma group. When you issue commands within the pma group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type pma to the profile named 'profilename':

    +
      +
    • zowe profiles set-default pma-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ssh-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ssh-profile.html new file mode 100644 index 0000000000..a5ba276a21 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_ssh-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default ssh-profile + + +
+

zoweprofilesset-defaultssh-profile

+

The ssh set default-profiles command allows you to set the default profiles for this command group. When a ssh command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default ssh-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the ssh group. When you issue commands within the ssh group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type ssh to the profile named 'profilename':

    +
      +
    • zowe profiles set-default ssh-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_sysview-format-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_sysview-format-profile.html new file mode 100644 index 0000000000..27f9d1bd1c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_sysview-format-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default sysview-format-profile + + +
+

zoweprofilesset-defaultsysview-format-profile

+

The sysview-format set default-profiles command allows you to set the default profiles for this command group. When a sysview-format command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default sysview-format-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the sysview-format group. When you issue commands within the sysview-format group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type sysview-format to the profile named 'profilename':

    +
      +
    • zowe profiles set-default sysview-format-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_sysview-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_sysview-profile.html new file mode 100644 index 0000000000..e5d92c23b7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_sysview-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default sysview-profile + + +
+

zoweprofilesset-defaultsysview-profile

+

The sysview set default-profiles command allows you to set the default profiles for this command group. When a sysview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default sysview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the sysview group. When you issue commands within the sysview group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type sysview to the profile named 'profilename':

    +
      +
    • zowe profiles set-default sysview-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_tso-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_tso-profile.html new file mode 100644 index 0000000000..bb507f389b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_tso-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default tso-profile + + +
+

zoweprofilesset-defaulttso-profile

+

The tso set default-profiles command allows you to set the default profiles for this command group. When a tso command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default tso-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the tso group. When you issue commands within the tso group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type tso to the profile named 'profilename':

    +
      +
    • zowe profiles set-default tso-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_zftp-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_zftp-profile.html new file mode 100644 index 0000000000..b7703b32ba --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_zftp-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default zftp-profile + + +
+

zoweprofilesset-defaultzftp-profile

+

The zftp set default-profiles command allows you to set the default profiles for this command group. When a zftp command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default zftp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the zftp group. When you issue commands within the zftp group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type zftp to the profile named 'profilename':

    +
      +
    • zowe profiles set-default zftp-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_set-default_zosmf-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_zosmf-profile.html new file mode 100644 index 0000000000..d120658b53 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_set-default_zosmf-profile.html @@ -0,0 +1,36 @@ + + + + +profiles set-default zosmf-profile + + +
+

zoweprofilesset-defaultzosmf-profile

+

The zosmf set default-profiles command allows you to set the default profiles for this command group. When a zosmf command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles set-default zosmf-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specify a
      +profile for default usage within the zosmf group. When you issue commands within the zosmf group without a profile specified as part of the command, the default will be loaded instead.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Set the default profile for type zosmf to the profile named 'profilename':

    +
      +
    • zowe profiles set-default zosmf-profile profilename
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update.html b/static/v2.15.x/web_help/docs/zowe_profiles_update.html new file mode 100644 index 0000000000..2d3b73a73e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update.html @@ -0,0 +1,49 @@ + + + + +profiles update + + +
+

zoweprofilesupdate

+

Update a {{type}} profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.

+

Warning: This group has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • base-profile | base - Update a base profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • ca7-profile | ca7 - Update a ca7 profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • caview-profile | caview - Update a caview profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • cics-profile | cics - Update a cics profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • db2-profile | db2 - Update a db2 profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • dbm-db2-options-profile - | Update a dbm-db2-options profile. You
  • +
  • dbm-db2-options - can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • dbm-db2-profile | dbm-db2 - Update a dbm-db2 profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • ebg-profile | ebg - Update a ebg profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • endevor-location-profile - | Update a endevor-location profile. You
  • +
  • endevor-location - can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • endevor-profile | endevor - Update a endevor profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • fmp-profile | fmp - Update a fmp profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • idms-profile | idms - Update a idms profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • ims-profile | ims - Update a ims profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • jclcheck-profile | jclcheck - Update a jclcheck profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • jclx-profile | jclx - Update a jclx profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • mat-profile | mat - Update a mat profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • mq-profile | mq - Update a mq profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • omspool-profile | omspool - Update a omspool profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • ops-profile | ops - Update a ops profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • pma-profile | pma - Update a pma profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • ssh-profile | ssh - Update a ssh profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • sysview-format-profile | sysview-format - Update a sysview-format profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • sysview-profile | sysview - Update a sysview profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • tso-profile | tso - Update a tso profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • zftp-profile | zftp - Update a zftp profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
  • zosmf-profile | zosmf - Update a zosmf profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. (deprecated)
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_base-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_base-profile.html new file mode 100644 index 0000000000..97f0629314 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_base-profile.html @@ -0,0 +1,95 @@ + + + + +profiles update base-profile + + +
+

zoweprofilesupdatebase-profile

+

Base profile that stores values shared by multiple service profiles

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update base-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new base profile. You can load this profile by using the name on commands that support the "--base-profile" option.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port number of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a base profile named 'base1' with a new username and password:

    +
      +
    • zowe profiles update base-profile base1 --user newuser --password newp4ss
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_ca7-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_ca7-profile.html new file mode 100644 index 0000000000..a28d4665e6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_ca7-profile.html @@ -0,0 +1,74 @@ + + + + +profiles update ca7-profile + + +
+

zoweprofilesupdateca7-profile

+

A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update ca7-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ca7 profile. You can load this profile by using the name on commands that support the "--ca7-profile" option.
    • +
    +
  • +
+

CA7 Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the CA7 API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for CA7 connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_caview-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_caview-profile.html new file mode 100644 index 0000000000..3f7dc25e77 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_caview-profile.html @@ -0,0 +1,68 @@ + + + + +profiles update caview-profile + + +
+

zoweprofilesupdatecaview-profile

+

Configuration profile for View

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update caview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new caview profile. You can load this profile by using the name on commands that support the "--caview-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --protocol (string)

    +
      +
    • +

      Protocol of the target View REST API instance.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | --hostname (string)

    +
      +
    • Hostname or ip address of the target View REST API instance.
    • +
    +
  • +
  • +

    --port (number)

    +
      +
    • Port of the target View REST API instance.
    • +
    +
  • +
  • +

    --base-path (string)

    +
      +
    • Context name of the target View REST API instance.
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • User name used to authenticate against the target View REST API instance.
    • +
    +
  • +
  • +

    --password (string)

    +
      +
    • Password used to authenticate against the target View REST API instance.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_cics-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_cics-profile.html new file mode 100644 index 0000000000..08a347edbc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_cics-profile.html @@ -0,0 +1,83 @@ + + + + +profiles update cics-profile + + +
+

zoweprofilesupdatecics-profile

+

A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update cics-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new cics profile. You can load this profile by using the name on commands that support the "--cics-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The CMCI server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The CMCI server port
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your username to connect to CICS
    • +
    +
  • +
  • +

    --password | -p (string)

    +
      +
    • Your password to connect to CICS
    • +
    +
  • +
  • +

    --region-name (string)

    +
      +
    • The name of the CICS region name to interact with
    • +
    +
  • +
  • +

    --cics-plex (string)

    +
      +
    • The name of the CICSPlex to interact with
    • +
    +
  • +
+

Cics Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies CMCI protocol (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_db2-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_db2-profile.html new file mode 100644 index 0000000000..86fc25e96b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_db2-profile.html @@ -0,0 +1,65 @@ + + + + +profiles update db2-profile + + +
+

zoweprofilesupdatedb2-profile

+

A profile for interaction with Db2 for the z/OS region

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new db2 profile. You can load this profile by using the name on commands that support the "--db2-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The Db2 server host name
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Db2 server port number
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The Db2 user ID (may be the same as the TSO login)
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The Db2 password (may be the same as the TSO password)
    • +
    +
  • +
  • +

    --database | -d (string)

    +
      +
    • The name of the database
    • +
    +
  • +
  • +

    --ssl-file | -s (string)

    +
      +
    • Path to an SSL Certificate file
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_dbm-db2-options-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_dbm-db2-options-profile.html new file mode 100644 index 0000000000..d7cb255f06 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_dbm-db2-options-profile.html @@ -0,0 +1,227 @@ + + + + +profiles update dbm-db2-options-profile + + +
+

zoweprofilesupdatedbm-db2-options-profile

+

The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update dbm-db2-options-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new dbm-db2-options profile. You can load this profile by using the name on commands that support the "--dbm-db2-options-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --change-set | --cs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.

      +

      Format:

      +

      <change-set-creator.change-set-name>

      +

      For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --change-set-values | --csv (array)

    +
      +
    • +

      Specifies the global change specifications that modify Db2 object attributes during a command execution.

      +

      Format:

      +

      <object-attribute> <from-value> <to-value>

      +

      The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the <from-value> and <to-value>. The first occurrence in multiple specifications for the same <object-attribute> has the highest precedence.

      +

      For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Example:

      +

      The following example demonstrates changes to the table schema (creator) and tablespace names:

      +

      TBCR TEST% PROD%
      +TBTS TESTTS% PRODTS%

      +

      Note:
      +- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
      +- The changeSetValues options-profile option has the same behavior as the change-set-file command option.

      +
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --description | -d (string)

    +
      +
    • Specifies a 1- to 25-character description for the RC/Migrator compare strategy.
    • +
    +
  • +
  • +

    --id (string)

    +
      +
    • +

      Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.

      +

      Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @.

      +
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --match-set | --ms (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <match-set-creator.match-set-name>

      +

      For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.

      +
    • +
    +
  • +
  • +

    --match-set-values | --msv (array)

    +
      +
    • +

      Specifies the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.

      +

      Format:

      +

      <object-type> <source-name-mask> <target-name-mask>;

      +

      STOGROUP <name> <name>
      +DATABASE <name> <name>
      +TABLESPACE <database.name> <database.name>
      +TABLE <schema.name> <schema.name>
      +INDEX <schema.name> <schema.name>
      +VIEW <schema.name> <schema.name>
      +SYNONYM <schema.name> <schema.name>
      +ALIAS <schema.name> <schema.name>
      +TRIGGER <schema.name> <schema.name>
      +SEQUENCE <schema.name> <schema.name>
      +FUNCTION <schema.name[.version]> <schema.name[.version]>
      +PROCEDURE <schema.name[.version]> <schema.name[.version]>

      +

      Note:
      +- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
      +- <schema> must be between 1 and 128 characters.
      +- <version> must be between 1 and 64 characters.

      +

      A mask specification can include the following wildcard characters:

      +

      Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.

      +

      Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.

      +

      Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.

      +

      Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.

      +

      Example:

      +

      The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:

      +

      TABLE MY%.%TABLE YOUR%.%TABLE;
      +TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
      +TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
      +TABLE *.MYTABLE *.YOURTABLE;

      +

      For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +

      Note:
      +- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.
      +- The matchSetValues options-profile option has the same behavior as the match-set-file command option.

      +
    • +
    +
  • +
  • +

    --modification | -m (string)

    +
      +
    • +

      Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.

      +

      For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt

      +
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --rule-set | --rs (string)

    +
      +
    • +

      Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.

      +

      Format:

      +

      <rule-set-creator.rule-set-name>

      +

      For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig

      +
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --source-db2 | --sd (string)

    +
      +
    • +

      Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
  • +

    --target-db2 | --td (string)

    +
      +
    • +

      Specifies the target Db2 subsystem or data sharing group where you want to use a command.

      +

      Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.

      +
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
  • +

    --type | -t (string)

    +
      +
    • +

      Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.

      +

      Allowed values: drop, create

      +
    • +
    +
  • +
  • +

    --verify | -v (string)

    +
      +
    • +

      Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.

      +

      Default value: no

      +

      Allowed values: yes, no

      +
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_dbm-db2-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_dbm-db2-profile.html new file mode 100644 index 0000000000..eaf2678c1c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_dbm-db2-profile.html @@ -0,0 +1,143 @@ + + + + +profiles update dbm-db2-profile + + +
+

zoweprofilesupdatedbm-db2-profile

+

The DBM-Db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update dbm-db2-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new dbm-db2 profile. You can load this profile by using the name on commands that support the "--dbm-db2-profile" option.
    • +
    +
  • +
+

DBM-Db2 Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies the DBM Data Service REST API server host name or TCP/IP address to use.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the DBM Data Service REST API server TCP/IP port number.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies the mainframe user name that you want to use to connect to the mainframe systems during execution of the Zowe CLI commands. This user name can be the same as your TSO login ID.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.
    • +
    +
  • +
  • +

    --environment-list | --el (string)

    +
      +
    • Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
    • +
    +
  • +
  • +

    --job-cards | --jc (array)

    +
      +
    • Specifies a string array of z/OS JCL JOB statements.
    • +
    +
  • +
  • +

    --work-dataset-prefix | --wdp (string)

    +
      +
    • Specifies the prefix (high-level qualifier) in z/OS work data set names.
    • +
    +
  • +
  • +

    --delete-work-datasets | --dwd (boolean)

    +
      +
    • Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
    • +
    +
  • +
  • +

    --overwrite-output-files | --oof (boolean)

    +
      +
    • Specifies whether to overwrite output files if they exist.
    • +
    +
  • +
  • +

    --authid | -a (string)

    +
      +
    • Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
    • +
    +
  • +
  • +

    --sqlid | -s (string)

    +
      +
    • Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
    • +
    +
  • +
  • +

    --termination-character | --tc (string)

    +
      +
    • Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a DBM-Db2 profile named profile_name1 with a new work data set prefix:

    +
      +
    • zowe profiles update dbm-db2-profile profile_name1 --work-dataset-prefix NEWPREFX.DDL
    • +
    +
  • +
  • +

    Update a DBM-Db2 profile named dbm123 with a new username and password:

    +
      +
    • zowe profiles update dbm-db2-profile dbm123 --user newuser --password newp4ss
    • +
    +
  • +
  • +

    Update a DBM-Db2 profile named dbm124 with a new environment list. Existing subsystem SUBA will be updated with a new hostname "host4" and subsystem SUBC will be added to the list:

    +
      +
    • zowe profiles update dbm-db2-profile dbm124 --environment-list "SUBA:prod@host4.com:322,SUBC:stage@host3.net:722"
    • +
    +
  • +
  • +

    Update a DBM-Db2 profile named dbm125 with new job cards:

    +
      +
    • zowe profiles update dbm-db2-profile dbm125 --job-cards "//NEWJOBNM JOB (123456789)," "// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_ebg-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_ebg-profile.html new file mode 100644 index 0000000000..8c125defb2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_ebg-profile.html @@ -0,0 +1,72 @@ + + + + +profiles update ebg-profile + + +
+

zoweprofilesupdateebg-profile

+

An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the Endevor Bridge for Git server of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update ebg-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ebg profile. You can load this profile by using the name on commands that support the "--ebg-profile" option.
    • +
    +
  • +
+

Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

+
    +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The Endevor Bridge for Git SCM protocol.

      +

      Default value: https

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • The Endevor Bridge for Git hostname.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The Endevor Bridge for Git port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Endevor Bridge for Git username (your git username).
    • +
    +
  • +
  • +

    --token | -t (string)

    +
      +
    • Git personal access token (it can be obtained from your Git Enterprise Server).
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: false

      +
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_endevor-location-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_endevor-location-profile.html new file mode 100644 index 0000000000..acd44c294f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_endevor-location-profile.html @@ -0,0 +1,109 @@ + + + + +profiles update endevor-location-profile + + +
+

zoweprofilesupdateendevor-location-profile

+

The Endevor element location, where you specify your working environment, system and subsystem

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update endevor-location-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new endevor-location profile. You can load this profile by using the name on commands that support the "--endevor-location-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --instance | -i (string)

    +
      +
    • The STC/datasource of the session
    • +
    +
  • +
  • +

    --environment | --env (string)

    +
      +
    • The Endevor environment where your project resides
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • The Endevor system where the element resides
    • +
    +
  • +
  • +

    --subsystem | --sub (string)

    +
      +
    • The Endevor subsystem where your element resides
    • +
    +
  • +
  • +

    --type | --typ (string)

    +
      +
    • Name of the Endevor element's type
    • +
    +
  • +
  • +

    --stage-number | --sn (string)

    +
      +
    • +

      The Endevor stage where your project resides

      +

      Allowed values: 1, 2

      +
    • +
    +
  • +
  • +

    --comment | --com (string)

    +
      +
    • The Endevor comment you want to use when performing an action
    • +
    +
  • +
  • +

    --ccid | --cci (string)

    +
      +
    • The Endevor CCID you want to use when performing an action
    • +
    +
  • +
  • +

    --maxrc (number)

    +
      +
    • The return code of Endevor that defines a failed action
    • +
    +
  • +
  • +

    --override-signout | --os (boolean)

    +
      +
    • Always override element signout, without having to specify the override signout option on each command
    • +
    +
  • +
  • +

    --file-extension | --ext (string)

    +
      +
    • +

      The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:

      +
              none: File name is equal to element name, no extension is added\.
      +
      +        file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added\.
      +
      +        type\-name: The type name is used as the file extension\.
      +
      +        mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead\.
      +
      +

      Allowed values: none, type-name, file-ext, mixed

      +
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_endevor-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_endevor-profile.html new file mode 100644 index 0000000000..1bb0b579c6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_endevor-profile.html @@ -0,0 +1,80 @@ + + + + +profiles update endevor-profile + + +
+

zoweprofilesupdateendevor-profile

+

The endevor profile schema, where you specify your endevor session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update endevor-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new endevor profile. You can load this profile by using the name on commands that support the "--endevor-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --host | --hostname (string)

    +
      +
    • The hostname of the endevor session
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number of the endevor session
    • +
    +
  • +
  • +

    --user | --username (string)

    +
      +
    • The username of the endevor session
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The password of the user
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to Endevor Rest API

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path used for connecting to Endevor Rest API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --report-dir | --rd (string)

    +
      +
    • The default path where any reports will be written to, either absolute or relative to current directory
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_fmp-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_fmp-profile.html new file mode 100644 index 0000000000..e870c441a0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_fmp-profile.html @@ -0,0 +1,74 @@ + + + + +profiles update fmp-profile + + +
+

zoweprofilesupdatefmp-profile

+

File Master Plus profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update fmp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new fmp profile. You can load this profile by using the name on commands that support the "--fmp-profile" option.
    • +
    +
  • +
+

FMP Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Specifies File Master Plus server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies File Master Plus server port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Specifies Mainframe user name. May be the same as TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Specifies Mainframe password. May be the same as TSO password.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies File Master Plus REST API protocol.

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_idms-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_idms-profile.html new file mode 100644 index 0000000000..826f45b1d3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_idms-profile.html @@ -0,0 +1,80 @@ + + + + +profiles update idms-profile + + +
+

zoweprofilesupdateidms-profile

+

An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update idms-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new idms profile. You can load this profile by using the name on commands that support the "--idms-profile" option.
    • +
    +
  • +
+

IDMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the IDMS REST API service
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the IDMS REST API service
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login ID
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password
    • +
    +
  • +
  • +

    --datasource | -d (string)

    +
      +
    • Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update an IDMS profile called 'idms99' with a new default data source SYS100:

    +
      +
    • zowe profiles update idms-profile idms99 --datasource SYS100
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_ims-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_ims-profile.html new file mode 100644 index 0000000000..26b4321f6c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_ims-profile.html @@ -0,0 +1,92 @@ + + + + +profiles update ims-profile + + +
+

zoweprofilesupdateims-profile

+

An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update ims-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ims profile. You can load this profile by using the name on commands that support the "--ims-profile" option.
    • +
    +
  • +
+

IMS Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The IMS Operations API server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The IMS Operations API server port.
    • +
    +
  • +
  • +

    --ims-connect-host | --ich (string)

    +
      +
    • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
    • +
    +
  • +
  • +

    --ims-connect-port | --icp (number)

    +
      +
    • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
    • +
    +
  • +
  • +

    --plex | -x (string)

    +
      +
    • The name of the IMS plex.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The web server user name where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • The web server user password where the IMS Operations API resides.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies protocol (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_jclcheck-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_jclcheck-profile.html new file mode 100644 index 0000000000..e7c582c871 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_jclcheck-profile.html @@ -0,0 +1,80 @@ + + + + +profiles update jclcheck-profile + + +
+

zoweprofilesupdatejclcheck-profile

+

A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update jclcheck-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new jclcheck profile. You can load this profile by using the name on commands that support the "--jclcheck-profile" option.
    • +
    +
  • +
+

JCLCheck Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Port for the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies protocol to use for JCLCheck connection (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --jclcheck-options | --jo (string)

    +
      +
    • The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_jclx-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_jclx-profile.html new file mode 100644 index 0000000000..3b60459bc1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_jclx-profile.html @@ -0,0 +1,56 @@ + + + + +profiles update jclx-profile + + +
+

zoweprofilesupdatejclx-profile

+

Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update jclx-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new jclx profile. You can load this profile by using the name on commands that support the "--jclx-profile" option.
    • +
    +
  • +
+

Options

+
    +
  • +

    --remote-home-dir (string)

    +
      +
    • The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
    • +
    +
  • +
  • +

    --remote-temp-dir (string)

    +
      +
    • The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
    • +
    +
  • +
  • +

    --language (string)

    +
      +
    • +

      The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.

      +

      Allowed values: ENG, JPN

      +
    • +
    +
  • +
  • +

    --response-encoding (string)

    +
      +
    • The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_mat-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_mat-profile.html new file mode 100644 index 0000000000..434aaf7c12 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_mat-profile.html @@ -0,0 +1,80 @@ + + + + +profiles update mat-profile + + +
+

zoweprofilesupdatemat-profile

+

MAT Analyze CLI profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update mat-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new mat profile. You can load this profile by using the name on commands that support the "--mat-profile" option.
    • +
    +
  • +
+

MAT Profile Options

+
    +
  • +

    --protocol | -o (string)

    +
      +
    • +

      Specifies the protocol defined for the MAT REST API server (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --host | -H (string)

    +
      +
    • Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • Specifies the server port (e.g. 8080).
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your mainframe username.
    • +
    +
  • +
  • +

    --password | --pw (string)

    +
      +
    • Your mainframe password.
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --listingDir | --ldir (string)

    +
      +
    • Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_mq-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_mq-profile.html new file mode 100644 index 0000000000..bc02337576 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_mq-profile.html @@ -0,0 +1,68 @@ + + + + +profiles update mq-profile + + +
+

zoweprofilesupdatemq-profile

+

An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update mq-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new mq profile. You can load this profile by using the name on commands that support the "--mq-profile" option.
    • +
    +
  • +
+

MQ Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The host name used to access the IBM MQ REST API. This might be the host name of the IBM MQ mqweb server, or the Zowe API Mediation Layer..
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number used to access the IBM MQ REST API. This might be the port number of the IBM MQ mqweb server, or the Zowe API Mediation Layer.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • The mainframe (MQ) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • The mainframe (MQ) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      Specifies the MQ protocol (http or https).

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_omspool-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_omspool-profile.html new file mode 100644 index 0000000000..05eddb6e38 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_omspool-profile.html @@ -0,0 +1,92 @@ + + + + +profiles update omspool-profile + + +
+

zoweprofilesupdateomspool-profile

+

Configuration profile for Spool, where you specify information about your Spool instance

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update omspool-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new omspool profile. You can load this profile by using the name on commands that support the "--omspool-profile" option.
    • +
    +
  • +
+

SPOOL OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --spoolhlq | --hlq (string)

    +
      +
    • High level qualifier of Spool installation.
    • +
    +
  • +
  • +

    --subsys | --sub (string)

    +
      +
    • Spool subsystem name.
    • +
    +
  • +
  • +

    --outds | --out (string)

    +
      +
    • The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.
    • +
    +
  • +
  • +

    --clist | --cl (string)

    +
      +
    • The data set containing ESFZOWE REXX exec.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update the TSO account information to '3213213210' for Spool profile named 'myProfile':

    +
      +
    • zowe profiles update omspool-profile myProfile --account 3213213210
    • +
    +
  • +
  • +

    Update high level qualifier of the Spool installation to 'SPOOL.HLQ' for Spool profile named 'myProfile':

    +
      +
    • zowe profiles update omspool-profile myProfile --spoolhlq SPOOL.HLQ
    • +
    +
  • +
  • +

    Update the Spool subsystem name to 'ESF2' for Spool profile named 'myProfile':

    +
      +
    • zowe profiles update omspool-profile myProfile --subsys ESF2
    • +
    +
  • +
  • +

    Update the output response data set to 'OUTPUT.RESPONSE.DS.NEW' for Spool profile named 'myProfile':

    +
      +
    • zowe profiles update omspool-profile myProfile --outds OUTPUT.RESPONSE.DS.NEW
    • +
    +
  • +
  • +

    Update the data set containing ESFZOWE REXX exec to 'USER.CLIST' for Spool profile named 'myProfile':

    +
      +
    • zowe profiles update omspool-profile myProfile --clist USER.CLIST
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_ops-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_ops-profile.html new file mode 100644 index 0000000000..f4340f1ad0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_ops-profile.html @@ -0,0 +1,89 @@ + + + + +profiles update ops-profile + + +
+

zoweprofilesupdateops-profile

+

The OPS Web Services session profile schema, where you specify your session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update ops-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ops profile. You can load this profile by using the name on commands that support the "--ops-profile" option.
    • +
    +
  • +
+

OPS WEB SERVICES CONNECTION OPTIONS

+
    +
  • +

    --host (string)

    +
      +
    • The hostname of the server where OPS Web Services is running.
    • +
    +
  • +
  • +

    --port | -p (number)

    +
      +
    • The port number for OPS Web Services.
    • +
    +
  • +
  • +

    --user (string)

    +
      +
    • Your z/OS user name used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --password | --pass (string)

    +
      +
    • Your z/OS password used to authenticate to OPS Web Services
    • +
    +
  • +
  • +

    --protocol | --prot (string)

    +
      +
    • +

      The protocol used for connecting to OPS Web Services

      +

      Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.
    • +
    +
  • +
  • +

    --subsystem | --subs (string)

    +
      +
    • Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update an OPS profile called 'myLPAR' to connect to OPS Web Services at host lpar456:

    +
      +
    • zowe profiles update ops-profile myLPAR --host lpar456
    • +
    +
  • +
  • +

    Update an OPS profile called 'myLPAR' to have username user101 with password Km5sv78:

    +
      +
    • zowe profiles update ops-profile myLPAR --user user101 --password Km5sv78
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_pma-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_pma-profile.html new file mode 100644 index 0000000000..62ab0aac18 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_pma-profile.html @@ -0,0 +1,59 @@ + + + + +profiles update pma-profile + + +
+

zoweprofilesupdatepma-profile

+

MAT Detect CLI profile schema.

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update pma-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new pma profile. You can load this profile by using the name on commands that support the "--pma-profile" option.
    • +
    +
  • +
+

PMA Connection Options

+
    +
  • +

    --job_acct | --ja (string)

    +
      +
    • Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
    • +
    +
  • +
  • +

    --job_class | --jc (string)

    +
      +
    • Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_mclass | --jmc (string)

    +
      +
    • Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
    • +
    +
  • +
  • +

    --job_load | --jl (string)

    +
      +
    • Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
    • +
    +
  • +
  • +

    --job_pmahlq | --jph (string)

    +
      +
    • Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_ssh-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_ssh-profile.html new file mode 100644 index 0000000000..a591775129 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_ssh-profile.html @@ -0,0 +1,71 @@ + + + + +profiles update ssh-profile + + +
+

zoweprofilesupdatessh-profile

+

z/OS SSH Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update ssh-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new ssh profile. You can load this profile by using the name on commands that support the "--ssh-profile" option.
    • +
    +
  • +
+

z/OS Ssh Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OS SSH server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The z/OS SSH server port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --privateKey | --key | --pk (string)

    +
      +
    • Path to a file containing your private key, that must match a public key stored in the server for authentication
    • +
    +
  • +
  • +

    --keyPassphrase | --passphrase | --kp (string)

    +
      +
    • Private key passphrase, which unlocks the private key.
    • +
    +
  • +
  • +

    --handshakeTimeout | --timeout | --to (number)

    +
      +
    • How long in milliseconds to wait for the SSH handshake to complete.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_sysview-format-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_sysview-format-profile.html new file mode 100644 index 0000000000..93b2cdd3d7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_sysview-format-profile.html @@ -0,0 +1,80 @@ + + + + +profiles update sysview-format-profile + + +
+

zoweprofilesupdatesysview-format-profile

+

The SYSVIEW format profile schema, where you specify display settings

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update sysview-format-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new sysview-format profile. You can load this profile by using the name on commands that support the "--sysview-format-profile" option.
    • +
    +
  • +
+

display options

+
    +
  • +

    --context-fields | --cf (array)

    +
      +
    • Context fields to display. Defaults to hiding all context
    • +
    +
  • +
  • +

    --overview | -o (boolean)

    +
      +
    • Display the overview section
    • +
    +
  • +
  • +

    --info | -i (boolean)

    +
      +
    • Display the information area, if any
    • +
    +
  • +
  • +

    --pretty | -p (boolean)

    +
      +
    • Display formatted data
    • +
    +
  • +
  • +

    --blank-if-zero | --biz | -b (boolean)

    +
      +
    • Show a blank space instead of '0' values
    • +
    +
  • +
  • +

    --truncate | --tr (boolean)

    +
      +
    • Truncate displays that are too wide for the console
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a SYSVIEW format profile called 'myFormat' to not display the information area.:

    +
      +
    • zowe profiles update sysview-format-profile myFormat --info false
    • +
    +
  • +
  • +

    Update a SYSVIEW format profile called 'myFormat' to format data but not blank out '0's.:

    +
      +
    • zowe profiles update sysview-format-profile myFormat -p --biz false
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_sysview-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_sysview-profile.html new file mode 100644 index 0000000000..f1507e9df7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_sysview-profile.html @@ -0,0 +1,86 @@ + + + + +profiles update sysview-profile + + +
+

zoweprofilesupdatesysview-profile

+

The SYSVIEW session profile schema, where you specify your session information and credentials

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update sysview-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new sysview profile. You can load this profile by using the name on commands that support the "--sysview-profile" option.
    • +
    +
  • +
+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • SSID of the SYSVIEW instance. Default value: GSVX
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a SYSVIEW profile called 'myLPAR' to connect to SYSVIEW REST API at host lpar456:

    +
      +
    • zowe profiles update sysview-profile myLPAR --host lpar456
    • +
    +
  • +
  • +

    Update a SYSVIEW profile called 'myLPAR' to have username user101 with password Km5sv78:

    +
      +
    • zowe profiles update sysview-profile myLPAR --user user101 --password Km5sv78
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_tso-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_tso-profile.html new file mode 100644 index 0000000000..5f8fd1b012 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_tso-profile.html @@ -0,0 +1,80 @@ + + + + +profiles update tso-profile + + +
+

zoweprofilesupdatetso-profile

+

z/OS TSO/E User Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update tso-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new tso profile. You can load this profile by using the name on commands that support the "--tso-profile" option.
    • +
    +
  • +
+

TSO ADDRESS SPACE OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • Your z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --character-set | --cs (string)

    +
      +
    • Character set for address space to convert messages and responses from UTF-8 to EBCDIC.
    • +
    +
  • +
  • +

    --code-page | --cp (string)

    +
      +
    • Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC.
    • +
    +
  • +
  • +

    --columns | --cols (number)

    +
      +
    • The number of columns on a screen.
    • +
    +
  • +
  • +

    --logon-procedure | -l (string)

    +
      +
    • The logon procedure to use when creating TSO procedures on your behalf.
    • +
    +
  • +
  • +

    --region-size | --rs (number)

    +
      +
    • Region size for the TSO/E address space.
    • +
    +
  • +
  • +

    --rows (number)

    +
      +
    • The number of rows on a screen.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a tso profile called myprof with new JES accounting information:

    +
      +
    • zowe profiles update tso-profile myprof -a NEWACCT
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_zftp-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_zftp-profile.html new file mode 100644 index 0000000000..75b04ea6c3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_zftp-profile.html @@ -0,0 +1,86 @@ + + + + +profiles update zftp-profile + + +
+

zoweprofilesupdatezftp-profile

+

Configuration profile for z/OS FTP

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update zftp-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new zftp profile. You can load this profile by using the name on commands that support the "--zftp-profile" option.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port of the z/OS FTP server.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • How long (in milliseconds) to wait for the control connection to be established.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set.
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_profiles_update_zosmf-profile.html b/static/v2.15.x/web_help/docs/zowe_profiles_update_zosmf-profile.html new file mode 100644 index 0000000000..09ba8709dc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_profiles_update_zosmf-profile.html @@ -0,0 +1,110 @@ + + + + +profiles update zosmf-profile + + +
+

zoweprofilesupdatezosmf-profile

+

z/OSMF Profile

+

Warning: This command has been deprecated.
+Recommended replacement: The 'config set' command

+

Usage

+

zowe profiles update zosmf-profile <profileName> [options]

+

Positional Arguments

+
    +
  • +

    profileName (string)

    +
      +
    • Specifies the name of the new zosmf profile. You can load this profile by using the name on commands that support the "--zosmf-profile" option.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The z/OSMF server port.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Allowed values: http, https

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set and USS files. The default encoding if not specified is IBM-1047.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Examples

+
    +
  • +

    Update a zosmf profile named 'zos123' with a new username and password:

    +
      +
    • zowe profiles update zosmf-profile zos123 --user newuser --password newp4ss
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning.html b/static/v2.15.x/web_help/docs/zowe_provisioning.html new file mode 100644 index 0000000000..eba8d8860f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning.html @@ -0,0 +1,23 @@ + + + + +provisioning + + +
+

zoweprovisioning

+

Perform z/OSMF provisioning tasks on Published Templates in the Service Catalog and Provisioned Instances in the Service Registry.

+

Usage

+

zowe provisioning <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning_delete.html b/static/v2.15.x/web_help/docs/zowe_provisioning_delete.html new file mode 100644 index 0000000000..d4806bfc48 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning_delete.html @@ -0,0 +1,20 @@ + + + + +provisioning delete + + +
+

zoweprovisioningdelete

+

Deletes instance previously provisioned with z/OSMF cloud provisioning services.

+

Usage

+

zowe provisioning delete <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning_delete_instance.html b/static/v2.15.x/web_help/docs/zowe_provisioning_delete_instance.html new file mode 100644 index 0000000000..aac7d56e2f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning_delete_instance.html @@ -0,0 +1,130 @@ + + + + +provisioning delete instance + + +
+

zoweprovisioningdeleteinstance

+

Deletes selected deprovisioned instance.

+

Usage

+

zowe provisioning delete instance <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Deprovisioned Instance name.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete deprovisioned instance "instance1":

    +
      +
    • zowe provisioning delete instance instance1
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning_list.html b/static/v2.15.x/web_help/docs/zowe_provisioning_list.html new file mode 100644 index 0000000000..b2bfccc48c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning_list.html @@ -0,0 +1,24 @@ + + + + +provisioning list + + +
+

zoweprovisioninglist

+

Lists z/OSMF provisioning information such as the provisioned instances from the registry, the provisioned instance details, the available provisioning templates and provisioning template details.

+

Usage

+

zowe provisioning list <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning_list_catalog-templates.html b/static/v2.15.x/web_help/docs/zowe_provisioning_list_catalog-templates.html new file mode 100644 index 0000000000..de11888f9e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning_list_catalog-templates.html @@ -0,0 +1,130 @@ + + + + +provisioning list catalog-templates + + +
+

zoweprovisioninglistcatalog-templates

+

Lists the z/OSMF service catalog published templates.

+

Usage

+

zowe provisioning list catalog-templates [options]

+

Options

+
    +
  • +

    --all-info | --ai (boolean)

    +
      +
    • Display information about published z/OSMF service catalog templates (summary information is printed by default).
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all published templates in the z/OSMF service catalog (with full detail):

    +
      +
    • zowe provisioning list catalog-templates --all-info
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning_list_instance-info.html b/static/v2.15.x/web_help/docs/zowe_provisioning_list_instance-info.html new file mode 100644 index 0000000000..389051d911 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning_list_instance-info.html @@ -0,0 +1,153 @@ + + + + +provisioning list instance-info + + +
+

zoweprovisioninglistinstance-info

+

List details about an instance provisioned with z/OSMF.

+

Usage

+

zowe provisioning list instance-info <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Provisioned Instance Name
    • +
    +
  • +
+

Options

+
    +
  • +

    --display (string)

    +
      +
    • +

      Level of information to display for the provisioned instance. Possible values:

      +

      summary - summary information, no actions or variables
      +actions - (default) summary with actions, no variables
      +vars - summary information with variables, no actions
      +extended - extended information with actions
      +full - all available information

      +

      Allowed values: extended, summary, vars, actions, full

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List summary information with a list of actions for an instance with the name "instance1":

    +
      +
    • zowe provisioning list instance-info instance1
    • +
    +
  • +
  • +

    Show extended general information with actions for a provisioned instance with the name "instance1":

    +
      +
    • zowe provisioning list instance-info instance1 --display extended
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning_list_instance-variables.html b/static/v2.15.x/web_help/docs/zowe_provisioning_list_instance-variables.html new file mode 100644 index 0000000000..e29afacfe5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning_list_instance-variables.html @@ -0,0 +1,158 @@ + + + + +provisioning list instance-variables + + +
+

zoweprovisioninglistinstance-variables

+

List a set of variables and their values for a given name.

+

Usage

+

zowe provisioning list instance-variables <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Provisioned Instance Name
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List instance variables of "instance1":

    +
      +
    • zowe provisioning list instance-variables instance1
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning_list_registry-instances.html b/static/v2.15.x/web_help/docs/zowe_provisioning_list_registry-instances.html new file mode 100644 index 0000000000..74371d79f6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning_list_registry-instances.html @@ -0,0 +1,148 @@ + + + + +provisioning list registry-instances + + +
+

zoweprovisioninglistregistry-instances

+

List the provisioned instances from the z/OSMF software registry.

+

Usage

+

zowe provisioning list registry-instances [options]

+

Options

+
    +
  • +

    --all-info | --ai (boolean)

    +
      +
    • Display all available information about provisioned instances (summary by default).
    • +
    +
  • +
  • +

    --filter-by-type | --fbt (string)

    +
      +
    • Filter the list of provisioned instances by type (e.g. DB2 or CICS).
    • +
    +
  • +
  • +

    --filter-by-external-name | --fben (string)

    +
      +
    • Filter the list of provisioned instances by External Name.
    • +
    +
  • +
  • +

    --types | -t (boolean)

    +
      +
    • Display a list of all types for provisioned instances (e.g. DB2 or CICS).
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all provisioned instances (with full detail):

    +
      +
    • zowe provisioning list registry-instances --all-info
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning_list_template-info.html b/static/v2.15.x/web_help/docs/zowe_provisioning_list_template-info.html new file mode 100644 index 0000000000..ca3b20fb05 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning_list_template-info.html @@ -0,0 +1,139 @@ + + + + +provisioning list template-info + + +
+

zoweprovisioninglisttemplate-info

+

List details about a template published with z/OSMF Cloud Provisioning.

+

Usage

+

zowe provisioning list template-info <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • The name of a z/OSMF cloud provisioning template.
    • +
    +
  • +
+

Options

+
    +
  • +

    --all-info | --ai (boolean)

    +
      +
    • Display detailed information about published z/OSMF service catalog template (summary information is printed by default).
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List summary information for template "template1":

    +
      +
    • zowe provisioning list template-info template1
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning_perform.html b/static/v2.15.x/web_help/docs/zowe_provisioning_perform.html new file mode 100644 index 0000000000..5ab3c432a9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning_perform.html @@ -0,0 +1,20 @@ + + + + +provisioning perform + + +
+

zoweprovisioningperform

+

Perform actions against instances provisioned with z/OSMF.

+

Usage

+

zowe provisioning perform <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning_perform_action.html b/static/v2.15.x/web_help/docs/zowe_provisioning_perform_action.html new file mode 100644 index 0000000000..b28f95a336 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning_perform_action.html @@ -0,0 +1,141 @@ + + + + +provisioning perform action + + +
+

zoweprovisioningperformaction

+

Perform actions on instances previously provisioned with z/OSMF cloud
+provisioning services. To view the list of provisioned instances, use the
+"zowe provisioning list registry-instances" command. Once you have
+obtained an instance name you can use the "zowe provisioning list
+instance-info <name>" command to view the available instance actions.

+

Usage

+

zowe provisioning perform action <name> <actionname> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • Provisioned Instance name.
    • +
    +
  • +
  • +

    actionname (string)

    +
      +
    • The action name. Use the "zowe provisioning list instance-info <name>"
      +command to view available instance actions.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Perform the "start" action on the provisioned instance "instance1":

    +
      +
    • zowe provisioning perform action instance1 start
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning_provision.html b/static/v2.15.x/web_help/docs/zowe_provisioning_provision.html new file mode 100644 index 0000000000..865c8232c9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning_provision.html @@ -0,0 +1,20 @@ + + + + +provisioning provision + + +
+

zoweprovisioningprovision

+

Using z/OSMF cloud provisioning services provision available templates.

+

Usage

+

zowe provisioning provision <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_provisioning_provision_template.html b/static/v2.15.x/web_help/docs/zowe_provisioning_provision_template.html new file mode 100644 index 0000000000..cbc55801f7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_provisioning_provision_template.html @@ -0,0 +1,184 @@ + + + + +provisioning provision template + + +
+

zoweprovisioningprovisiontemplate

+

Using z/OSMF cloud provisioning services, provision available templates.
+You can view available templates using the zowe provisioning list catalog-templates command.

+

Usage

+

zowe provisioning provision template <name> [options]

+

Positional Arguments

+
    +
  • +

    name (string)

    +
      +
    • The name of a z/OSMF cloud provisioning template.
    • +
    +
  • +
+

Options

+
    +
  • +

    --properties | -p (string)

    +
      +
    • A sequence of string enclosed "name=value" pairs of prompt variables.
      +e.g: "CSQ_MQ_SSID=ZCT1,CSQ_CMD_PFX=!ZCT1".
    • +
    +
  • +
  • +

    --properties-file | --pf (string)

    +
      +
    • Path to .yml file containing properties.
    • +
    +
  • +
  • +

    --domain-name | --dn (string)

    +
      +
    • Required if the user has consumer authorization to more than one domain with this template name.
    • +
    +
  • +
  • +

    --tenant-name | --tn (string)

    +
      +
    • Required if the user has consumer authorization to more than one tenant in the same domain that contains this template name.
    • +
    +
  • +
  • +

    --user-data-id | --udi (string)

    +
      +
    • ID for the user data specified with user-data. Passed into the software services registry.
    • +
    +
  • +
  • +

    --user-data | --ud (string)

    +
      +
    • User data that is passed into the software services registry. Can be specified only if user-data-id is provided.
    • +
    +
  • +
  • +

    --account-info | --ai (string)

    +
      +
    • Account information to use in the JCL JOB statement. The default is the account information that is associated with the resource pool for the tenant.
    • +
    +
  • +
  • +

    --system-nick-names | --snn (string)

    +
      +
    • Each string is the nickname of the system upon which to provision the software service defined by the template. The field is required if the resource pool associated with the tenant used for this operation is not set up to automatically select a system. Only one nickname is allowed.If the field is provided it is validated.
      +e.g: "SYSNAME1,SYSNAME2".
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Provision a published software service template.:

    +
      +
    • zowe provisioning provision template template1
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_sysview.html b/static/v2.15.x/web_help/docs/zowe_sysview.html new file mode 100644 index 0000000000..d2852f7b34 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_sysview.html @@ -0,0 +1,27 @@ + + + + +sysview + + +
+

zowesysview

+

Zowe CLI plugin for SYSVIEW

+

Usage

+

zowe sysview <command|group>

+

Where <command|group> is one of the following:

+

Commands

+ +

Groups

+
    +
  • check - Confirm that the SYSVIEW REST server is running on a specified system.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_sysview_capture-immediate.html b/static/v2.15.x/web_help/docs/zowe_sysview_capture-immediate.html new file mode 100644 index 0000000000..87dcac7315 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_sysview_capture-immediate.html @@ -0,0 +1,144 @@ + + + + +sysview capture-immediate + + +
+

zowesysviewcapture-immediate

+

Submit a capture request2

+

Usage

+

zowe sysview capture-immediate <capture-file> [options]

+

Positional Arguments

+
    +
  • +

    capture-file (string)

    +
      +
    • The list of SYSVIEW commands to be executed as an Event Capture.This takes the same form as a CAPLIB member.
    • +
    +
  • +
+

display options

+
    +
  • +

    --context-fields | --cf (array)

    +
      +
    • Context fields to display. Defaults to hiding all context
    • +
    +
  • +
+

data options

+
    +
  • +

    --capture-description | --cd (string)

    +
      +
    • The description of the capture
    • +
    +
  • +
+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • +

      SSID of the SYSVIEW instance. Default value: GSVX

      +

      Default value: GSVX

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: /api/v1

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --sysview-profile | --sysview-p (string)

    +
      +
    • The name of a (sysview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issues a Capture containing the commands in capture file 'my-capture.txt' with the description 'Top CPU Users':

    +
      +
    • zowe sysview capture-immediate "./my-capture.txt" --description "Top CPU Users"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_sysview_capture.html b/static/v2.15.x/web_help/docs/zowe_sysview_capture.html new file mode 100644 index 0000000000..f250b7ee30 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_sysview_capture.html @@ -0,0 +1,255 @@ + + + + +sysview capture + + +
+

zowesysviewcapture

+

Display output from a primary command stored in a SYSVIEW capture data set

+

Usage

+

zowe sysview capture <capture-dsn> <capture-command> [options]

+

Positional Arguments

+
    +
  • +

    capture-dsn (string)

    +
      +
    • Capture data set name from which to retrieve captured commands
    • +
    +
  • +
  • +

    capture-command (string)

    +
      +
    • Captured command to retrieve
    • +
    +
  • +
+

data options

+
    +
  • +

    --capture-row | --cr (number)

    +
      +
    • Row number of command within capture data set
    • +
    +
  • +
  • +

    --capture-screen | --cs (string)

    +
      +
    • Screen name, for commands which have multiple screens
    • +
    +
  • +
  • +

    --capture-title | --ct (string)

    +
      +
    • The captured command screen title or a user supplied title specified on the CAPIMMED command
    • +
    +
  • +
  • +

    --fields | -f (array)

    +
      +
    • Fields to be returned (by name). For example: "jobname" "cpu"
    • +
    +
  • +
  • +

    --all-rows | --ar (boolean)

    +
      +
    • Return all rows of data, no matter how many. Overrides --row-start and --row-end
    • +
    +
  • +
  • +

    --row-start | --rs (number)

    +
      +
    • +

      The first row of the response data to display

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --row-end | --re (number)

    +
      +
    • +

      The last row of the response data to display

      +

      Default value: 100

      +
    • +
    +
  • +
  • +

    --timeout | --to (number)

    +
      +
    • +

      The number of seconds to wait before timing out

      +

      Default value: 30

      +
    • +
    +
  • +
+

display options

+
    +
  • +

    --context-fields | --cf (array)

    +
      +
    • Context fields to display. Defaults to hiding all context
    • +
    +
  • +
  • +

    --overview | -o (boolean)

    +
      +
    • Display the overview section
    • +
    +
  • +
  • +

    --info | -i (boolean)

    +
      +
    • Display the information area, if any
    • +
    +
  • +
  • +

    --pretty | -p (boolean)

    +
      +
    • Display formatted data
    • +
    +
  • +
  • +

    --blank-if-zero | --biz | -b (boolean)

    +
      +
    • Show a blank space instead of '0' values
    • +
    +
  • +
  • +

    --truncate | --tr (boolean)

    +
      +
    • +

      Truncate displays that are too wide for the console

      +

      Default value: false

      +
    • +
    +
  • +
+

response format options

+
    +
  • +

    --response-format-csv | --csv (boolean)

    +
      +
    • Format data as a set of Comma Seperated Values
    • +
    +
  • +
+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • +

      SSID of the SYSVIEW instance. Default value: GSVX

      +

      Default value: GSVX

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: /api/v1

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --sysview-profile | --sysview-p (string)

    +
      +
    • The name of a (sysview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --sysview-format-profile | --sysview-format-p (string)

    +
      +
    • The name of a (sysview-format) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Display the captured ACTIVITY command from MY.CAPTURE.DATASET.:

    +
      +
    • zowe sysview capture "MY.CAPTURE.DATASET" ACTIVITY
    • +
    +
  • +
  • +

    Display the Jobname, Jobid, and Status columns of the captured ACTIVITY command on row 3 from MY.CAPTURE.DATASET.:

    +
      +
    • zowe sysview capture "MY.CAPTURE.DATASET" ACTIVITY --capture-row 3 --fields Jobname Jobid Status
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_sysview_check.html b/static/v2.15.x/web_help/docs/zowe_sysview_check.html new file mode 100644 index 0000000000..67836699b5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_sysview_check.html @@ -0,0 +1,20 @@ + + + + +sysview check + + +
+

zowesysviewcheck

+

Confirm that the SYSVIEW REST server is running on a specified system.

+

Usage

+

zowe sysview check <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • status - Confirm that the SYSVIEW REST server is running on a system specified. The command outputs properties of the z/OS system and the SYSVIEW REST server.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_sysview_check_status.html b/static/v2.15.x/web_help/docs/zowe_sysview_check_status.html new file mode 100644 index 0000000000..7e224330d7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_sysview_check_status.html @@ -0,0 +1,129 @@ + + + + +sysview check status + + +
+

zowesysviewcheckstatus

+

Confirm that the SYSVIEW REST server is running on a system specified. The command outputs properties of the z/OS system and the SYSVIEW REST server.

+

Usage

+

zowe sysview check status [options]

+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • +

      SSID of the SYSVIEW instance. Default value: GSVX

      +

      Default value: GSVX

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: /api/v1

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --sysview-profile | --sysview-p (string)

    +
      +
    • The name of a (sysview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Report the status of the SYSVIEW REST server that you specified in your default SYSVIEW REST profile:

    +
      +
    • zowe sysview check status
    • +
    +
  • +
  • +

    Report the status of the SYSVIEW REST server that you specified in a supplied SYSVIEW REST profile:

    +
      +
    • zowe sysview check status --sysview-profile SomeSysviewProfileName
    • +
    +
  • +
  • +

    Report the status of the SYSVIEW REST server that you specified manually via command line:

    +
      +
    • zowe sysview check status --host myhost --port 443 --user myuser --password mypass
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_sysview_display.html b/static/v2.15.x/web_help/docs/zowe_sysview_display.html new file mode 100644 index 0000000000..ea13a3acbe --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_sysview_display.html @@ -0,0 +1,233 @@ + + + + +sysview display + + +
+

zowesysviewdisplay

+

Issue a SYSVIEW primary command and display output, including any messages

+

Usage

+

zowe sysview display <command-string> [options]

+

Positional Arguments

+
    +
  • +

    command-string (string)

    +
      +
    • Command(s) to be issued
      +(If more than one command, separated by a semi-colon)
      +Example: "ACTIVITY;SORT CPU% D"
    • +
    +
  • +
+

data options

+
    +
  • +

    --fields | -f (array)

    +
      +
    • Fields to be returned (by name). For example: "jobname" "cpu"
    • +
    +
  • +
  • +

    --all-rows | --ar (boolean)

    +
      +
    • Return all rows of data, no matter how many. Overrides --row-start and --row-end
    • +
    +
  • +
  • +

    --row-start | --rs (number)

    +
      +
    • +

      The first row of the response data to display

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --row-end | --re (number)

    +
      +
    • +

      The last row of the response data to display

      +

      Default value: 100

      +
    • +
    +
  • +
  • +

    --timeout | --to (number)

    +
      +
    • +

      The number of seconds to wait before timing out

      +

      Default value: 30

      +
    • +
    +
  • +
+

display options

+
    +
  • +

    --context-fields | --cf (array)

    +
      +
    • Context fields to display. Defaults to hiding all context
    • +
    +
  • +
  • +

    --overview | -o (boolean)

    +
      +
    • Display the overview section
    • +
    +
  • +
  • +

    --info | -i (boolean)

    +
      +
    • Display the information area, if any
    • +
    +
  • +
  • +

    --pretty | -p (boolean)

    +
      +
    • Display formatted data
    • +
    +
  • +
  • +

    --blank-if-zero | --biz | -b (boolean)

    +
      +
    • Show a blank space instead of '0' values
    • +
    +
  • +
  • +

    --truncate | --tr (boolean)

    +
      +
    • +

      Truncate displays that are too wide for the console

      +

      Default value: false

      +
    • +
    +
  • +
+

response format options

+
    +
  • +

    --response-format-csv | --csv (boolean)

    +
      +
    • Format data as a set of Comma Seperated Values
    • +
    +
  • +
+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • +

      SSID of the SYSVIEW instance. Default value: GSVX

      +

      Default value: GSVX

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: /api/v1

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --sysview-profile | --sysview-p (string)

    +
      +
    • The name of a (sysview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --sysview-format-profile | --sysview-format-p (string)

    +
      +
    • The name of a (sysview-format) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issue the CSMSTAT command and show the 'message' field from the context area of the response:

    +
      +
    • zowe sysview display "CSMSTAT" --cf message
    • +
    +
  • +
  • +

    Issue the JOBSUM command to list jobs starting with "CS" showing only the fields Jobname, Jobid, and Status:

    +
      +
    • zowe sysview display "jobs CS&VLMC" --fields Jobname Jobid Status
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_sysview_execute.html b/static/v2.15.x/web_help/docs/zowe_sysview_execute.html new file mode 100644 index 0000000000..30aac0107e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_sysview_execute.html @@ -0,0 +1,149 @@ + + + + +sysview execute + + +
+

zowesysviewexecute

+

Issue a SYSVIEW function command and display any messages

+

Usage

+

zowe sysview execute <command-string> [options]

+

Positional Arguments

+
    +
  • +

    command-string (string)

    +
      +
    • Command(s) to be issued
      +(If more than one command, separated by a semi-colon)
      +Example: "ACTIVITY;SORT CPU% D"
    • +
    +
  • +
+

display options

+
    +
  • +

    --context-fields | --cf (array)

    +
      +
    • Context fields to display. Defaults to hiding all context
    • +
    +
  • +
+

data options

+
    +
  • +

    --timeout | --to (number)

    +
      +
    • +

      The number of seconds to wait before timing out

      +

      Default value: 30

      +
    • +
    +
  • +
+

sysview connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • The port number of the SYSVIEW REST API
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Your z/OS username used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Your z/OS password used to authenticate to the SYSVIEW REST API
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • If set, the server certificate is verified against the list of supplied CAs
    • +
    +
  • +
  • +

    --ssid (string)

    +
      +
    • +

      SSID of the SYSVIEW instance. Default value: GSVX

      +

      Default value: GSVX

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • +

      The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.

      +

      Default value: /api/v1

      +
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --sysview-profile | --sysview-p (string)

    +
      +
    • The name of a (sysview) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issue the APFTEST command and display any messages returned from SYSVIEW.:

    +
      +
    • zowe sysview execute "APFTEST SYS1.LINKLIB SYS001"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zjcl-expert.html b/static/v2.15.x/web_help/docs/zowe_zjcl-expert.html new file mode 100644 index 0000000000..9667b5feac --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zjcl-expert.html @@ -0,0 +1,22 @@ + + + + +zjcl-expert + + +
+

zowezjcl-expert

+

IBM Z JCL Expert Plug-in for Zowe CLI

+

Usage

+

zowe zjcl-expert <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zjcl-expert_local.html b/static/v2.15.x/web_help/docs/zowe_zjcl-expert_local.html new file mode 100644 index 0000000000..cdf7c76297 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zjcl-expert_local.html @@ -0,0 +1,257 @@ + + + + +zjcl-expert local + + +
+

zowezjcl-expertlocal

+

Wraps an SSH call to JCLX on the remote system to validate the specified local file containing JCL.

+

Usage

+

zowe zjcl-expert local <filePath> [options]

+

Positional Arguments

+
    +
  • +

    filePath (local file path)

    +
      +
    • The relative file path of the local file to be analysed on the remote system.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output | -o (string)

    +
      +
    • +

      The output format provided upon completion.

      +

      Default value: json
      +Allowed values: json, text

      +
    • +
    +
  • +
  • +

    --alias | -a (string)

    +
      +
    • An alias to give the file name during analysis.
    • +
    +
  • +
  • +

    --dsn-check | -c (string)

    +
      +
    • +

      Turn on or off DSN and USS file existence checking during analysis.

      +

      Default value: ON
      +Allowed values: ON, OFF

      +
    • +
    +
  • +
  • +

    --rules | -r (string)

    +
      +
    • The absolute path of the remote rules file used to define user site rules during analysis.
    • +
    +
  • +
  • +

    --local-rules | -e (local file path)

    +
      +
    • The relative path to a local rules file that will be uploaded as a temporary file and used to define user site rules during analysis.
    • +
    +
  • +
  • +

    --job-class | -j (string)

    +
      +
    • The default job class to use during JCL analysis if none is provided.
    • +
    +
  • +
  • +

    --log-level | -l (string)

    +
      +
    • +

      The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.

      +

      Default value: FATAL
      +Allowed values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

      +
    • +
    +
  • +
  • +

    --log-file | -d (string)

    +
      +
    • The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.
    • +
    +
  • +
  • +

    --remote-home-dir (string)

    +
      +
    • The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
    • +
    +
  • +
  • +

    --remote-temp-dir (string)

    +
      +
    • The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
    • +
    +
  • +
  • +

    --language (string)

    +
      +
    • +

      The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.

      +

      Default value: ENG
      +Allowed values: ENG, JPN

      +
    • +
    +
  • +
  • +

    --response-encoding (string)

    +
      +
    • +

      The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.

      +

      Default value: utf-8

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

z/OS Ssh Connection Options

+
    +
  • +

    --ssh-port | -S (number)

    +
      +
    • +

      The z/OS SSH server port.

      +

      Default value: 22

      +
    • +
    +
  • +
  • +

    --privateKey | --key | --pk (string)

    +
      +
    • Path to a file containing your private key, that must match a public key stored in the server for authentication
    • +
    +
  • +
  • +

    --keyPassphrase | --passphrase | --kp (string)

    +
      +
    • Private key passphrase, which unlocks the private key.
    • +
    +
  • +
  • +

    --handshakeTimeout | --timeout | --to (number)

    +
      +
    • How long in milliseconds to wait for the SSH handshake to complete.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --jclx-profile | --jclx-p (string)

    +
      +
    • The name of a (jclx) profile to load for this command execution.
    • +
    +
  • +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --ssh-profile | --ssh-p (string)

    +
      +
    • The name of a (ssh) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zjcl-expert_remote-ds.html b/static/v2.15.x/web_help/docs/zowe_zjcl-expert_remote-ds.html new file mode 100644 index 0000000000..cf1f1c3c5f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zjcl-expert_remote-ds.html @@ -0,0 +1,251 @@ + + + + +zjcl-expert remote-ds + + +
+

zowezjcl-expertremote-ds

+

Wraps an SSH call to JCLX on the remote system to validate the specified remote data set.

+

Usage

+

zowe zjcl-expert remote-ds <dsn> [options]

+

Positional Arguments

+
    +
  • +

    dsn (string)

    +
      +
    • The name of the data set to be analysed on the remote system.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output | -o (string)

    +
      +
    • +

      The output format provided upon completion.

      +

      Default value: json
      +Allowed values: json, text

      +
    • +
    +
  • +
  • +

    --alias | -a (string)

    +
      +
    • An alias to give the file name during analysis.
    • +
    +
  • +
  • +

    --dsn-check | -c (string)

    +
      +
    • +

      Turn on or off DSN and USS file existence checking during analysis.

      +

      Default value: ON
      +Allowed values: ON, OFF

      +
    • +
    +
  • +
  • +

    --rules | -r (string)

    +
      +
    • The absolute path of the remote rules file used to define user site rules during analysis.
    • +
    +
  • +
  • +

    --job-class | -j (string)

    +
      +
    • The default job class to use during JCL analysis if none is provided.
    • +
    +
  • +
  • +

    --log-level | -l (string)

    +
      +
    • +

      The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.

      +

      Default value: FATAL
      +Allowed values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

      +
    • +
    +
  • +
  • +

    --log-file | -d (string)

    +
      +
    • The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.
    • +
    +
  • +
  • +

    --remote-home-dir (string)

    +
      +
    • The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
    • +
    +
  • +
  • +

    --remote-temp-dir (string)

    +
      +
    • The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
    • +
    +
  • +
  • +

    --language (string)

    +
      +
    • +

      The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.

      +

      Default value: ENG
      +Allowed values: ENG, JPN

      +
    • +
    +
  • +
  • +

    --response-encoding (string)

    +
      +
    • +

      The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.

      +

      Default value: utf-8

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

z/OS Ssh Connection Options

+
    +
  • +

    --ssh-port | -S (number)

    +
      +
    • +

      The z/OS SSH server port.

      +

      Default value: 22

      +
    • +
    +
  • +
  • +

    --privateKey | --key | --pk (string)

    +
      +
    • Path to a file containing your private key, that must match a public key stored in the server for authentication
    • +
    +
  • +
  • +

    --keyPassphrase | --passphrase | --kp (string)

    +
      +
    • Private key passphrase, which unlocks the private key.
    • +
    +
  • +
  • +

    --handshakeTimeout | --timeout | --to (number)

    +
      +
    • How long in milliseconds to wait for the SSH handshake to complete.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --jclx-profile | --jclx-p (string)

    +
      +
    • The name of a (jclx) profile to load for this command execution.
    • +
    +
  • +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --ssh-profile | --ssh-p (string)

    +
      +
    • The name of a (ssh) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zjcl-expert_remote-fs.html b/static/v2.15.x/web_help/docs/zowe_zjcl-expert_remote-fs.html new file mode 100644 index 0000000000..28c2f59482 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zjcl-expert_remote-fs.html @@ -0,0 +1,251 @@ + + + + +zjcl-expert remote-fs + + +
+

zowezjcl-expertremote-fs

+

Wraps an SSH call to JCLX on the remote system to validate the specified remote zFS file.

+

Usage

+

zowe zjcl-expert remote-fs <filePath> [options]

+

Positional Arguments

+
    +
  • +

    filePath (string)

    +
      +
    • The absolute file path of the USS file to be analysed on the remote system.
    • +
    +
  • +
+

Options

+
    +
  • +

    --output | -o (string)

    +
      +
    • +

      The output format provided upon completion.

      +

      Default value: json
      +Allowed values: json, text

      +
    • +
    +
  • +
  • +

    --alias | -a (string)

    +
      +
    • An alias to give the file name during analysis.
    • +
    +
  • +
  • +

    --dsn-check | -c (string)

    +
      +
    • +

      Turn on or off DSN and USS file existence checking during analysis.

      +

      Default value: ON
      +Allowed values: ON, OFF

      +
    • +
    +
  • +
  • +

    --rules | -r (string)

    +
      +
    • The absolute path of the remote rules file used to define user site rules during analysis.
    • +
    +
  • +
  • +

    --job-class | -j (string)

    +
      +
    • The default job class to use during JCL analysis if none is provided.
    • +
    +
  • +
  • +

    --log-level | -l (string)

    +
      +
    • +

      The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.

      +

      Default value: FATAL
      +Allowed values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

      +
    • +
    +
  • +
  • +

    --log-file | -d (string)

    +
      +
    • The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.
    • +
    +
  • +
  • +

    --remote-home-dir (string)

    +
      +
    • The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
    • +
    +
  • +
  • +

    --remote-temp-dir (string)

    +
      +
    • The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
    • +
    +
  • +
  • +

    --language (string)

    +
      +
    • +

      The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.

      +

      Default value: ENG
      +Allowed values: ENG, JPN

      +
    • +
    +
  • +
  • +

    --response-encoding (string)

    +
      +
    • +

      The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.

      +

      Default value: utf-8

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

z/OS Ssh Connection Options

+
    +
  • +

    --ssh-port | -S (number)

    +
      +
    • +

      The z/OS SSH server port.

      +

      Default value: 22

      +
    • +
    +
  • +
  • +

    --privateKey | --key | --pk (string)

    +
      +
    • Path to a file containing your private key, that must match a public key stored in the server for authentication
    • +
    +
  • +
  • +

    --keyPassphrase | --passphrase | --kp (string)

    +
      +
    • Private key passphrase, which unlocks the private key.
    • +
    +
  • +
  • +

    --handshakeTimeout | --timeout | --to (number)

    +
      +
    • How long in milliseconds to wait for the SSH handshake to complete.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --jclx-profile | --jclx-p (string)

    +
      +
    • The name of a (jclx) profile to load for this command execution.
    • +
    +
  • +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --ssh-profile | --ssh-p (string)

    +
      +
    • The name of a (ssh) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • Host name of service on the mainframe.
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • User name to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Password to authenticate to service on the mainframe.
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-console.html b/static/v2.15.x/web_help/docs/zowe_zos-console.html new file mode 100644 index 0000000000..8fa0016714 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-console.html @@ -0,0 +1,22 @@ + + + + +zos-console + + +
+

zowezos-console

+

Interact with z/OSMF console services. Issue z/OS console commands and collect responses. z/OS console services establishes extended MCS (EMCS) consoles on behalf of the user, which are used to issue the commands and collect responses.

+

Important! Before you use commands in the zos-console command group, ensure that you understand the implications of issuing z/OS console commands in your environment.

+

Usage

+

zowe zos-console <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • collect - Collect z/OS console command responses
  • +
  • issue - Issue z/OS console commands
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-console_collect.html b/static/v2.15.x/web_help/docs/zowe_zos-console_collect.html new file mode 100644 index 0000000000..160939f0de --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-console_collect.html @@ -0,0 +1,20 @@ + + + + +zos-console collect + + +
+

zowezos-consolecollect

+

z/OSMF console services provides a command response key upon successful issue of a console command. You can use this key to collect additional console message responses.

+

Usage

+

zowe zos-console collect <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-console_collect_sync-responses.html b/static/v2.15.x/web_help/docs/zowe_zos-console_collect_sync-responses.html new file mode 100644 index 0000000000..29e77ae4ca --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-console_collect_sync-responses.html @@ -0,0 +1,143 @@ + + + + +zos-console collect sync-responses + + +
+

zowezos-consolecollectsync-responses

+

The z/OSMF console REST APIs return a "solicited response key" after successfully issuing a synchronous console command that produces solicited responses. You can use the "solicited response key"on the "sync-responses" command to collect any additional outstanding solicited responses from the console the command was issued.

+

In general, when issuing a z/OS console command, z/OS applications route responses to the originating console. The command response messages are referred to as "solicited command responses" (i.e. direct responses to the command issued). When issuing a z/OS console command using Zowe CLI, collection of all solicited command responses is attempted by default. However, there is no z/OS mechanism that indicates the total number of response messages that may be produced from a given command. Therefore, the Zowe CLI console APIs return a "solicited response key" that can be used to "follow-up" and collect any additional solicited command responses.

+

Usage

+

zowe zos-console collect sync-responses <responsekey> [options]

+

Positional Arguments

+
    +
  • +

    responsekey (string)

    +
      +
    • The "solicited response key" provided in response to a previously issued console command. Used by the z/OSMF console API to collect any additional outstanding solicited responses from a previously issued console command. Must match regular expression: ^\[a\-zA\-Z0\-9\]\+$
    • +
    +
  • +
+

Options

+
    +
  • +

    --console-name | --cn | -c (string)

    +
      +
    • +

      The name of the z/OS extended MCS console to direct the command. You must have the required authority to access the console specified. You may also specify an arbitrary name, if your installation allows dynamic creation of consoles with arbitrary names.

      +

      Allowed values: ^[a-zA-Z0-9]+$

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Collect any outstanding additional solicited response messages:

    +
      +
    • zowe zos-console collect sync-responses C4866969
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-console_issue.html b/static/v2.15.x/web_help/docs/zowe_zos-console_issue.html new file mode 100644 index 0000000000..010454d03f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-console_issue.html @@ -0,0 +1,20 @@ + + + + +zos-console issue + + +
+

zowezos-consoleissue

+

Issue z/OS console commands and optionally collect responses.

+

Usage

+

zowe zos-console issue <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • command | cmd - Issue a z/OS console command and print the response
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-console_issue_command.html b/static/v2.15.x/web_help/docs/zowe_zos-console_issue_command.html new file mode 100644 index 0000000000..4efd02e32d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-console_issue_command.html @@ -0,0 +1,201 @@ + + + + +zos-console issue command + + +
+

zowezos-consoleissuecommand

+

Issue a z/OS console command and print command responses (known as "solicited command responses").

+

In general, when issuing a z/OS console command, z/OS applications route responses to the originating console. The command response messages are referred to as "solicited command responses" (i.e. direct responses to the command issued). When issuing a z/OS console command using Zowe CLI, collection of all solicited command responses is attempted by default. However, there is no z/OS mechanism that indicates the total number of response messages that may be produced from a given command. Therefore, the Zowe CLI console APIs return a "solicited response key" that can be used to "follow-up" and collect any additional solicited command responses.

+

Zowe CLI will issue "follow-up" API requests by default to collect any additional outstanding solicited command responses until a request returns no additional responses. At that time, Zowe CLI will attempt a final collection attempt. If no messages are present, the command is complete. If additional messages are present, the process is repeated. However, this does not guarantee that all messages produced in direct response (i.e. solicited) have been collected. The z/OS application may produce additional messages in direct response to your command at some point in the future. You can manually collect additional responses using the "command response key" OR specify additional processing options to, for example, delay collection attempts by a specified interval.

+

Usage

+

zowe zos-console issue command <commandtext> [options]

+

Positional Arguments

+
    +
  • +

    commandtext (string)

    +
      +
    • The z/OS console command to issue.
    • +
    +
  • +
+

Options

+
    +
  • +

    --console-name | --cn | -c (string)

    +
      +
    • +

      The name of the z/OS extended MCS console to direct the command. You must have the required authority to access the console specified. You may also specify an arbitrary name, if your installation allows dynamic creation of consoles with arbitrary names.

      +

      Allowed values: ^[a-zA-Z0-9]+$

      +
    • +
    +
  • +
  • +

    --include-details | --id | -i (boolean)

    +
      +
    • Include additional details at the end of the Zowe CLI command response, such as the "command response key" and the z/OSMF command response URL.
    • +
    +
  • +
  • +

    --key-only | --ko | -k (boolean)

    +
      +
    • Displays only the "command response key" returned from the z/OSMF console API. You can collect additional messages using the command key with 'zowe zos-console collect sync-responses <key>'. Note that when using this option, you will not be presented with the "first set" of command response messages (if present in the API response). However, you can view them by using the --response-format-json option.
    • +
    +
  • +
  • +

    --return-first | --rf | -r (boolean)

    +
      +
    • Indicates that Zowe CLI should return immediately with the response message set returned in the first z/OSMF API request (even if no responses are present). Using this option may result in partial or no response, but quicker Zowe CLI command response time. The z/OSMF console API has an implicit wait when collecting the first set of console command responses, i.e you will normally receive at least one set of response messages.
    • +
    +
  • +
  • +

    --solicited-keyword | --sk | -s (string)

    +
      +
    • For solicited responses (direct command responses) the response is considered complete if the keyword specified is present. If the keyword is detected, the command will immediately return, meaning the full command response may not be provided. The key only applies to the first request issued, follow up requests do not support searching for the keyword.
    • +
    +
  • +
  • +

    --sysplex-system | --ss | --sys (string)

    +
      +
    • Specifies the z/OS system (LPAR) in the current SYSPLEX (where your target z/OSMF resides) to route the z/OS console command.
    • +
    +
  • +
  • +

    --wait-to-collect | --wtc | -w (number)

    +
      +
    • Indicates that Zowe CLI wait at least the specified number of seconds before attempting to collect additional solicited response messages. If additional messages are collected on "follow-up" requests, the timer is reset until an attempt is made that results in no additional response messages.
    • +
    +
  • +
  • +

    --follow-up-attempts | --fua | -a (number)

    +
      +
    • +

      Number of request attempts if no response returned.

      +

      Default value: 1

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issue a z/OS console command to display the IPL information for the system:

    +
      +
    • zowe zos-console issue command "D IPLINFO"
    • +
    +
  • +
  • +

    Issue a z/OS console command to display the local and coordinated universal time and date:

    +
      +
    • zowe zos-console issue command "D T"
    • +
    +
  • +
  • +

    Issue a Db2 command to display information about the status and configuration of DDF:

    +
      +
    • zowe zos-console issue command "\-DB1G DISPLAY DDF"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files.html b/static/v2.15.x/web_help/docs/zowe_zos-files.html new file mode 100644 index 0000000000..e616777ce0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files.html @@ -0,0 +1,34 @@ + + + + +zos-files + + +
+

zowezos-files

+

Manage z/OS data sets, create data sets, and more.

+

Usage

+

zowe zos-files <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_compare.html b/static/v2.15.x/web_help/docs/zowe_zos-files_compare.html new file mode 100644 index 0000000000..19c7ae26d4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_compare.html @@ -0,0 +1,25 @@ + + + + +zos-files compare + + +
+

zowezos-filescompare

+

Compare the contents of a two data set members on your terminal (stdout).

+

Usage

+

zowe zos-files compare <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_compare_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_compare_data-set.html new file mode 100644 index 0000000000..08ab8a15de --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_compare_data-set.html @@ -0,0 +1,220 @@ + + + + +zos-files compare data-set + + +
+

zowezos-filescomparedata-set

+

Compare content of two z/OS data sets on your terminal (stdout).

+

Usage

+

zowe zos-files compare data-set <dataSetName1> <dataSetName2> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName1 (string)

    +
      +
    • The name of the first data set you want to compare.
    • +
    +
  • +
  • +

    dataSetName2 (string)

    +
      +
    • The name of the second data set you want to compare.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.
    • +
    +
  • +
  • +

    --binary2 | --b2 (boolean)

    +
      +
    • Transfer the content of the second data set in binary mode.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
    • +
    +
  • +
  • +

    --encoding2 | --ec2 (string)

    +
      +
    • Transfer the content of the second data set with encoding mode.
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Transfer the content for the first data set in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode. This option conflicts with binary mode.
    • +
    +
  • +
  • +

    --record2 | --r2 (boolean)

    +
      +
    • Transfer the content for the second data set in record mode. Conflicts with binary2.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the first data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --volume-serial2 | --vs2 (string)

    +
      +
    • The volume serial (VOLSER) where the second data set resides.
    • +
    +
  • +
  • +

    --seqnum | --sn (boolean)

    +
      +
    • +

      If you are comparing two files that contain sequence numbers, this option controls if the sequences numbers are removed from the end of each string. The default is to keep the sequence numbers. Use the --no-seqnum option to not include them.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --context-lines | --cl (number)

    +
      +
    • The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
    • +
    +
  • +
  • +

    --browser-view | --bv (boolean)

    +
      +
    • Opens the diffs between two given files in browser
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compare the contents of the data set members "sys1.samplib(antptso)" and "sys1.samplib(antxtso)":

    +
      +
    • zowe zos-files compare data-set "sys1.samplib(antptso)" "sys1.samplib(antxtso)"
    • +
    +
  • +
  • +

    Compare the contents of the data set members "sys1.samplib(antptso)" and "sys1.samplib(antxtso)" without sequence numbers:

    +
      +
    • zowe zos-files compare data-set "sys1.samplib(antptso)" "sys1.samplib(antxtso)" --no-seqnum
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_compare_local-file-data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_compare_local-file-data-set.html new file mode 100644 index 0000000000..ac56732d98 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_compare_local-file-data-set.html @@ -0,0 +1,196 @@ + + + + +zos-files compare local-file-data-set + + +
+

zowezos-filescomparelocal-file-data-set

+

Compare content of a local file and a z/os dataset on your terminal (stdout).

+

Usage

+

zowe zos-files compare local-file-data-set <localFilePath> <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    localFilePath (string)

    +
      +
    • The path of the local file you want to compare.
    • +
    +
  • +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set you want to compare.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Transfer the content for the first data set in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode. This option conflicts with binary mode.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the first data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --seqnum | --sn (boolean)

    +
      +
    • +

      If you are comparing two files that contain sequence numbers, this option controls if the sequences numbers are removed from the end of each string. The default is to keep the sequence numbers. Use the --no-seqnum option to not include them.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --context-lines | --cl (number)

    +
      +
    • The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
    • +
    +
  • +
  • +

    --browser-view | --bv (boolean)

    +
      +
    • Opens the diffs between two given files in browser
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compare the contents of the local file and the data set member "./a.txt" and "sys1.samplib(antxtso)":

    +
      +
    • zowe zos-files compare local-file-data-set "./a.txt" "sys1.samplib(antxtso)"
    • +
    +
  • +
  • +

    Compare the contents of the local file and the data set member "./a.txt" and "sys1.samplib(antxtso)"without sequence numbers:

    +
      +
    • zowe zos-files compare local-file-data-set "./a.txt" "sys1.samplib(antxtso)" --no-seqnum
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_compare_local-file-spool-dd.html b/static/v2.15.x/web_help/docs/zowe_zos-files_compare_local-file-spool-dd.html new file mode 100644 index 0000000000..785ff679d1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_compare_local-file-spool-dd.html @@ -0,0 +1,172 @@ + + + + +zos-files compare local-file-spool-dd + + +
+

zowezos-filescomparelocal-file-spool-dd

+

Compare content of a local-file and a spool-dd on your terminal (stdout).

+

Usage

+

zowe zos-files compare local-file-spool-dd <localFilePath> <spoolDescription> [options]

+

Positional Arguments

+
    +
  • +

    localFilePath (string)

    +
      +
    • The path of the local file you want to compare.
    • +
    +
  • +
  • +

    spoolDescription (string)

    +
      +
    • The name of the job with the id of spool dd
    • +
    +
  • +
+

Options

+
    +
  • +

    --seqnum | --sn (boolean)

    +
      +
    • +

      If you are comparing two files that contain sequence numbers, this option controls if the sequences numbers are removed from the end of each string. The default is to keep the sequence numbers. Use the --no-seqnum option to not include them.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --context-lines | --cl (number)

    +
      +
    • The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
    • +
    +
  • +
  • +

    --browser-view | --bv (boolean)

    +
      +
    • Opens the diffs between two given files in browser
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compare the contents of a local-file and a spool dd "./a.txt" "jobName:jobId:spoolId":

    +
      +
    • zowe zos-files compare local-file-spool-dd "./a.txt" "jobName:jobId:spoolId"
    • +
    +
  • +
  • +

    Compare the contents of a local-file and a spool dd "./a.txt" "jobName:jobId:spoolId"without sequence numbers:

    +
      +
    • zowe zos-files compare local-file-spool-dd "./a.txt" "jobName:jobId:spoolId" --no-seqnum
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_compare_local-file-uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-files_compare_local-file-uss-file.html new file mode 100644 index 0000000000..2575d2e8d8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_compare_local-file-uss-file.html @@ -0,0 +1,184 @@ + + + + +zos-files compare local-file-uss-file + + +
+

zowezos-filescomparelocal-file-uss-file

+

Compare content of a local file and a z/os uss file on your terminal (stdout).

+

Usage

+

zowe zos-files compare local-file-uss-file <localFilePath> <ussFilePath> [options]

+

Positional Arguments

+
    +
  • +

    localFilePath (string)

    +
      +
    • The path of the local file you want to compare.
    • +
    +
  • +
  • +

    ussFilePath (string)

    +
      +
    • The path of the uss file set you want to compare.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
    • +
    +
  • +
  • +

    --seqnum | --sn (boolean)

    +
      +
    • +

      If you are comparing two files that contain sequence numbers, this option controls if the sequences numbers are removed from the end of each string. The default is to keep the sequence numbers. Use the --no-seqnum option to not include them.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --context-lines | --cl (number)

    +
      +
    • The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
    • +
    +
  • +
  • +

    --browser-view | --bv (boolean)

    +
      +
    • Opens the diffs between two given files in browser
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compare the contents of the local file and the uss file "./a.txt" and "/u/user/test.txt":

    +
      +
    • zowe zos-files compare local-file-uss-file "./a.txt" "/u/user/test.txt"
    • +
    +
  • +
  • +

    Compare the contents of the local file and the uss file "./a.txt" and "/u/user/test.txt"without sequence numbers:

    +
      +
    • zowe zos-files compare local-file-uss-file "./a.txt" "/u/user/test.txt" --no-seqnum
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_compare_spool-dd.html b/static/v2.15.x/web_help/docs/zowe_zos-files_compare_spool-dd.html new file mode 100644 index 0000000000..ba915c2719 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_compare_spool-dd.html @@ -0,0 +1,163 @@ + + + + +zos-files compare spool-dd + + +
+

zowezos-filescomparespool-dd

+

Compare content of two spool dds on your terminal (stdout).

+

Usage

+

zowe zos-files compare spool-dd <spoolDescription1> <spoolDescription2> [options]

+

Positional Arguments

+
    +
  • +

    spoolDescription1 (string)

    +
      +
    • The name of the first job with the id of spool dd
    • +
    +
  • +
  • +

    spoolDescription2 (string)

    +
      +
    • The name of the second job with the id of spool dd
    • +
    +
  • +
+

Options

+
    +
  • +

    --context-lines | --cl (number)

    +
      +
    • The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
    • +
    +
  • +
  • +

    --browser-view | --bv (boolean)

    +
      +
    • Opens the diffs between two given files in browser
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compare the contents of the two spool dds "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2":

    +
      +
    • zowe zos-files compare spool-dd "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2"
    • +
    +
  • +
  • +

    Compare the contents of the two spool dds "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2"without sequence numbers:

    +
      +
    • zowe zos-files compare spool-dd "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2" --no-seqnum
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_compare_uss-files.html b/static/v2.15.x/web_help/docs/zowe_zos-files_compare_uss-files.html new file mode 100644 index 0000000000..c44eb81c9c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_compare_uss-files.html @@ -0,0 +1,196 @@ + + + + +zos-files compare uss-files + + +
+

zowezos-filescompareuss-files

+

Compare the contents of two uss files on your terminal (stdout). browser.

+

Usage

+

zowe zos-files compare uss-files <ussFilePath1> <ussFilePath2> [options]

+

Positional Arguments

+
    +
  • +

    ussFilePath1 (string)

    +
      +
    • The path of the first uss file you want to compare.
    • +
    +
  • +
  • +

    ussFilePath2 (string)

    +
      +
    • The path of the second uss file you want to compare.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.
    • +
    +
  • +
  • +

    --binary2 | --b2 (boolean)

    +
      +
    • Transfer the content of the second data set in binary mode.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
    • +
    +
  • +
  • +

    --encoding2 | --ec2 (string)

    +
      +
    • Transfer the content of the second data set with encoding mode.
    • +
    +
  • +
  • +

    --seqnum | --sn (boolean)

    +
      +
    • +

      If you are comparing two files that contain sequence numbers, this option controls if the sequences numbers are removed from the end of each string. The default is to keep the sequence numbers. Use the --no-seqnum option to not include them.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --context-lines | --cl (number)

    +
      +
    • The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
    • +
    +
  • +
  • +

    --browser-view | --bv (boolean)

    +
      +
    • Opens the diffs between two given files in browser
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Compare the contents of the uss file "/u/user/test.txt" and "/u/user/test.txt":

    +
      +
    • zowe zos-files compare uss-files "/u/user/test.txt" "/u/user/test.txt"
    • +
    +
  • +
  • +

    Compare the contents of the uss file "/u/user/test.txt" and "/u/user/test.txt" without sequence numbers:

    +
      +
    • zowe zos-files compare uss-files "/u/user/test.txt" "/u/user/test.txt" --no-seqnum
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_copy.html b/static/v2.15.x/web_help/docs/zowe_zos-files_copy.html new file mode 100644 index 0000000000..ab77c01869 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_copy.html @@ -0,0 +1,21 @@ + + + + +zos-files copy + + +
+

zowezos-filescopy

+

Copy a data set.

+

Usage

+

zowe zos-files copy <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_copy_data-set-cross-lpar.html b/static/v2.15.x/web_help/docs/zowe_zos-files_copy_data-set-cross-lpar.html new file mode 100644 index 0000000000..57a3efbc3e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_copy_data-set-cross-lpar.html @@ -0,0 +1,235 @@ + + + + +zos-files copy data-set-cross-lpar + + +
+

zowezos-filescopydata-set-cross-lpar

+

Copy a data set to another data set on a specified LPAR

+

Usage

+

zowe zos-files copy data-set-cross-lpar <fromDataSetName> <toDataSetName> [options]

+

Positional Arguments

+
    +
  • +

    fromDataSetName (string)

    +
      +
    • The name of the data set that you want to copy from
    • +
    +
  • +
  • +

    toDataSetName (string)

    +
      +
    • The name of the data set that you want to copy to. If the dataset does not exist it will be allocated automatically
    • +
    +
  • +
+

Options

+
    +
  • +

    --replace | --rep (boolean)

    +
      +
    • Specify this option as true if you wish to replace the target dataset if it already exists
    • +
    +
  • +
  • +

    --target-data-class | --tdc (string)

    +
      +
    • The SMS data class to use for the allocation of the target data set.
    • +
    +
  • +
  • +

    --target-host | --th (string)

    +
      +
    • The target z/OSMF server host name.
    • +
    +
  • +
  • +

    --target-management-class | --tmc (string)

    +
      +
    • The SMS management class to use for the allocation of the target data set.
    • +
    +
  • +
  • +

    --target-password | --tpw (string)

    +
      +
    • The target z/OSMF password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --target-port | --tp (number)

    +
      +
    • The target z/OSMF server port.
    • +
    +
  • +
  • +

    --target-storage-class | --tsc (string)

    +
      +
    • The SMS storage class to use for the allocation of the target data set.
    • +
    +
  • +
  • +

    --target-token-type | --ttt (string)

    +
      +
    • The value of the token to pass to the API for the target system.
    • +
    +
  • +
  • +

    --target-token-value | --ttv (string)

    +
      +
    • The type of token to get and use for the API for the target system.
    • +
    +
  • +
  • +

    --target-user | --tu (string)

    +
      +
    • The target z/OSMF user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --target-volume-serial | --tvs | --target-volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the target data set to be placed.
    • +
    +
  • +
  • +

    --target-zosmf-profile | --t-zosmf-p | --target-zosmf-p (string)

    +
      +
    • The name of a z/OSMF profile to load for the target host.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET' using the --target-zosmf-p option to specify the target host using a zosmf profile:

    +
      +
    • zowe zos-files copy data-set-cross-lpar "USER.FROM.SET" "USER.TO.SET" --target-zosmf-p SYS1
    • +
    +
  • +
  • +

    Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set member named 'USER.TO.SET(MEM2)':

    +
      +
    • zowe zos-files copy data-set-cross-lpar "USER.FROM.SET(mem1)" "USER.TO.SET(mem2)" --target-zosmf-p SYS1
    • +
    +
  • +
  • +

    Copy the data set named 'USER.FROM.SET' to the data set member named 'USER.TO.SET(MEM2)':

    +
      +
    • zowe zos-files copy data-set-cross-lpar "USER.FROM.SET" "USER.TO.SET(mem2)" --target-zosmf-p SYS1
    • +
    +
  • +
  • +

    Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set named 'USER.TO.SET' using the --target-host, --target-user, and --target-password options:

    +
      +
    • zowe zos-files copy data-set-cross-lpar "USER.FROM.SET(mem1)" "USER.TO.SET" --target-host sys1.com --target-user user1 --target-password pass1
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_copy_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_copy_data-set.html new file mode 100644 index 0000000000..cf09b64504 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_copy_data-set.html @@ -0,0 +1,175 @@ + + + + +zos-files copy data-set + + +
+

zowezos-filescopydata-set

+

Copy a data set to another data set

+

Usage

+

zowe zos-files copy data-set <fromDataSetName> <toDataSetName> [options]

+

Positional Arguments

+
    +
  • +

    fromDataSetName (string)

    +
      +
    • The name of the data set that you want to copy from
    • +
    +
  • +
  • +

    toDataSetName (string)

    +
      +
    • The name of the data set that you want to copy to (data set must be preallocated)
    • +
    +
  • +
+

Options

+
    +
  • +

    --replace | --rep (boolean)

    +
      +
    • Specify this option as true if you wish to replace like-named members in the target dataset
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET':

    +
      +
    • zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET"
    • +
    +
  • +
  • +

    Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set member named 'USER.TO.SET(MEM2)':

    +
      +
    • zowe zos-files copy data-set "USER.FROM.SET(mem1)" "USER.TO.SET(mem2)"
    • +
    +
  • +
  • +

    Copy the data set named 'USER.FROM.SET' to the data set member named 'USER.TO.SET(MEM2)':

    +
      +
    • zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET(mem2)"
    • +
    +
  • +
  • +

    Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set named 'USER.TO.SET':

    +
      +
    • zowe zos-files copy data-set "USER.FROM.SET(mem1)" "USER.TO.SET"
    • +
    +
  • +
  • +

    Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET' and replace like-named members:

    +
      +
    • zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET" --replace
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_create.html b/static/v2.15.x/web_help/docs/zowe_zos-files_create.html new file mode 100644 index 0000000000..5157398f24 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_create.html @@ -0,0 +1,29 @@ + + + + +zos-files create + + +
+

zowezos-filescreate

+

Create data sets.

+

Usage

+

zowe zos-files create <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-binary.html b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-binary.html new file mode 100644 index 0000000000..ebc6c15a09 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-binary.html @@ -0,0 +1,244 @@ + + + + +zos-files create data-set-binary + + +
+

zowezos-filescreatedata-set-binary

+

Create executable data sets

+

Usage

+

zowe zos-files create data-set-binary <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to create
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --block-size | --bs | --blksize (number)

    +
      +
    • +

      The block size for the data set (for example, 6160)

      +

      Default value: 27998

      +
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --data-set-type | --dst | --dsntype (string)

    +
      +
    • The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
    • +
    +
  • +
  • +

    --device-type | --dt | --unit (string)

    +
      +
    • The device type, also known as 'unit'
    • +
    +
  • +
  • +

    --directory-blocks | --db | --dirblks (number)

    +
      +
    • +

      The number of directory blocks (for example, 25)

      +

      Default value: 25

      +
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • +

      The primary space allocation (for example, 5)

      +

      Default value: 10

      +
    • +
    +
  • +
  • +

    --record-format | --rf | --recfm (string)

    +
      +
    • +

      The record format for the data set (for example, FB for "Fixed Block")

      +

      Default value: U

      +
    • +
    +
  • +
  • +

    --record-length | --rl | --lrecl (number)

    +
      +
    • +

      The logical record length. Analogous to the length of a line (for example, 80)

      +

      Default value: 27998

      +
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The secondary space allocation (for example, 1)
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volume-serial | --vs | --volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an empty binary partitioned data set (PDS) with default parameters:

    +
      +
    • zowe zos-files create data-set-binary NEW.BINARY.DATASET
    • +
    +
  • +
  • +

    Create an empty binary PDSE using data set type LIBRARY:

    +
      +
    • zowe zos-files create data-set-binary NEW.BINARY.DATASET --data-set-type LIBRARY
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-c.html b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-c.html new file mode 100644 index 0000000000..6a54b105d6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-c.html @@ -0,0 +1,244 @@ + + + + +zos-files create data-set-c + + +
+

zowezos-filescreatedata-set-c

+

Create data sets for C code programming

+

Usage

+

zowe zos-files create data-set-c <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to create
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --block-size | --bs | --blksize (number)

    +
      +
    • +

      The block size for the data set (for example, 6160)

      +

      Default value: 32760

      +
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --data-set-type | --dst | --dsntype (string)

    +
      +
    • The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
    • +
    +
  • +
  • +

    --device-type | --dt | --unit (string)

    +
      +
    • The device type, also known as 'unit'
    • +
    +
  • +
  • +

    --directory-blocks | --db | --dirblks (number)

    +
      +
    • +

      The number of directory blocks (for example, 25)

      +

      Default value: 25

      +
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • +

      The primary space allocation (for example, 5)

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --record-format | --rf | --recfm (string)

    +
      +
    • +

      The record format for the data set (for example, FB for "Fixed Block")

      +

      Default value: VB

      +
    • +
    +
  • +
  • +

    --record-length | --rl | --lrecl (number)

    +
      +
    • +

      The logical record length. Analogous to the length of a line (for example, 80)

      +

      Default value: 260

      +
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The secondary space allocation (for example, 1)
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volume-serial | --vs | --volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an empty C code PDS with default parameters:

    +
      +
    • zowe zos-files create data-set-c NEW.CCODE.DATASET
    • +
    +
  • +
  • +

    Create an empty C code PDSE using data set type LIBRARY:

    +
      +
    • zowe zos-files create data-set-c NEW.CCODE.DATASET --data-set-type LIBRARY
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-classic.html b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-classic.html new file mode 100644 index 0000000000..f15d8178bf --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-classic.html @@ -0,0 +1,244 @@ + + + + +zos-files create data-set-classic + + +
+

zowezos-filescreatedata-set-classic

+

Create classic data sets (JCL, HLASM, CBL, etc...)

+

Usage

+

zowe zos-files create data-set-classic <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to create
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --block-size | --bs | --blksize (number)

    +
      +
    • +

      The block size for the data set (for example, 6160)

      +

      Default value: 6160

      +
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --data-set-type | --dst | --dsntype (string)

    +
      +
    • The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
    • +
    +
  • +
  • +

    --device-type | --dt | --unit (string)

    +
      +
    • The device type, also known as 'unit'
    • +
    +
  • +
  • +

    --directory-blocks | --db | --dirblks (number)

    +
      +
    • +

      The number of directory blocks (for example, 25)

      +

      Default value: 25

      +
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • +

      The primary space allocation (for example, 5)

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --record-format | --rf | --recfm (string)

    +
      +
    • +

      The record format for the data set (for example, FB for "Fixed Block")

      +

      Default value: FB

      +
    • +
    +
  • +
  • +

    --record-length | --rl | --lrecl (number)

    +
      +
    • +

      The logical record length. Analogous to the length of a line (for example, 80)

      +

      Default value: 80

      +
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The secondary space allocation (for example, 1)
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volume-serial | --vs | --volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an empty z/OS 'classic' PDS with default parameters:

    +
      +
    • zowe zos-files create data-set-classic NEW.CLASSIC.DATASET
    • +
    +
  • +
  • +

    Create an empty z/OS 'classic' PDSE using data set type LIBRARY:

    +
      +
    • zowe zos-files create data-set-classic NEW.CLASSIC.DATASET --data-set-type LIBRARY
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-partitioned.html b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-partitioned.html new file mode 100644 index 0000000000..961f4b6cce --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-partitioned.html @@ -0,0 +1,253 @@ + + + + +zos-files create data-set-partitioned + + +
+

zowezos-filescreatedata-set-partitioned

+

Create partitioned data sets (PDS)

+

Usage

+

zowe zos-files create data-set-partitioned <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to create
    • +
    +
  • +
+

Options

+
    +
  • +

    --allocation-space-unit | --asu (string)

    +
      +
    • +

      The allocation unit (for example, CYL for Cylinders)

      +

      Default value: CYL

      +
    • +
    +
  • +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --block-size | --bs | --blksize (number)

    +
      +
    • +

      The block size for the data set (for example, 6160)

      +

      Default value: 6160

      +
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --data-set-type | --dst | --dsntype (string)

    +
      +
    • The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
    • +
    +
  • +
  • +

    --device-type | --dt | --unit (string)

    +
      +
    • The device type, also known as 'unit'
    • +
    +
  • +
  • +

    --directory-blocks | --db | --dirblks (number)

    +
      +
    • +

      The number of directory blocks (for example, 25)

      +

      Default value: 5

      +
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • +

      The primary space allocation (for example, 5)

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --record-format | --rf | --recfm (string)

    +
      +
    • +

      The record format for the data set (for example, FB for "Fixed Block")

      +

      Default value: FB

      +
    • +
    +
  • +
  • +

    --record-length | --rl | --lrecl (number)

    +
      +
    • +

      The logical record length. Analogous to the length of a line (for example, 80)

      +

      Default value: 80

      +
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The secondary space allocation (for example, 1)
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volume-serial | --vs | --volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an empty PDS with default parameters:

    +
      +
    • zowe zos-files create data-set-partitioned NEW.PDS.DATASET
    • +
    +
  • +
  • +

    Create an empty PDSE using data set type LIBRARY:

    +
      +
    • zowe zos-files create data-set-partitioned NEW.PDSE.DATASET --data-set-type LIBRARY
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-sequential.html b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-sequential.html new file mode 100644 index 0000000000..f4b70b9b97 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-sequential.html @@ -0,0 +1,229 @@ + + + + +zos-files create data-set-sequential + + +
+

zowezos-filescreatedata-set-sequential

+

Create physical sequential data sets (PS)

+

Usage

+

zowe zos-files create data-set-sequential <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to create
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --block-size | --bs | --blksize (number)

    +
      +
    • +

      The block size for the data set (for example, 6160)

      +

      Default value: 6160

      +
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --device-type | --dt | --unit (string)

    +
      +
    • The device type, also known as 'unit'
    • +
    +
  • +
  • +

    --directory-blocks | --db | --dirblks (number)

    +
      +
    • The number of directory blocks (for example, 25)
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • +

      The primary space allocation (for example, 5)

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --record-format | --rf | --recfm (string)

    +
      +
    • +

      The record format for the data set (for example, FB for "Fixed Block")

      +

      Default value: FB

      +
    • +
    +
  • +
  • +

    --record-length | --rl | --lrecl (number)

    +
      +
    • +

      The logical record length. Analogous to the length of a line (for example, 80)

      +

      Default value: 80

      +
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The secondary space allocation (for example, 1)
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volume-serial | --vs | --volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create an empty physical sequential data set with default parameters:

    +
      +
    • zowe zos-files create data-set-sequential NEW.PS.DATASET
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-vsam.html b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-vsam.html new file mode 100644 index 0000000000..f84ddc341b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set-vsam.html @@ -0,0 +1,218 @@ + + + + +zos-files create data-set-vsam + + +
+

zowezos-filescreatedata-set-vsam

+

Create a VSAM cluster

+

Usage

+

zowe zos-files create data-set-vsam <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the dataset in which to create a VSAM cluster
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --data-set-organization | --dso | --dsorg (string)

    +
      +
    • +

      The data set organization.

      +

      Default value: INDEXED
      +Allowed values: INDEXED, IXD, LINEAR, LIN, NONINDEXED, NIXD, NUMBERED, NUMD, ZFS

      +
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --retain-for | --rf (number)

    +
      +
    • The number of days that the VSAM cluster will be retained on the system. You can delete the cluster at any time when neither retain-for nor retain-to is specified.
    • +
    +
  • +
  • +

    --retain-to | --rt (string)

    +
      +
    • The earliest date that a command without the PURGE parameter can delete an entry. Specify the expiration date in the form yyyyddd, where yyyy is a four-digit year (maximum value: 2155) and ddd is the three-digit day of the year from 001 through 365 (for non-leap years) or 366 (for leap years). You can delete the cluster at any time when neither retain-for nor retain-to is used. You cannot specify both the 'retain-to' and 'retain-for' options.
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The number of items for the secondary space allocation (for example, 840). The type of item allocated is the same as the type used for the '--size' option. If you do not specify a secondary allocation, a value of ~10% of the primary allocation is used.
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • +

      The primary size to allocate for the VSAM cluster. Specify size as the number of items to allocate (nItems). You specify the type of item by keyword.

      +

      Default value: 840KB

      +
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volumes | -v (string)

    +
      +
    • The storage volumes on which to allocate a VSAM cluster. Specify a single volume by its volume serial (VOLSER). To specify more than one volume, enclose the option in double-quotes and separate each VOLSER with a space. You must specify the volumes option when your cluster is not SMS-managed.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a VSAM data set named "SOME.DATA.SET.NAME" using default values of INDEXED, 840 KB primary storage and 84 KB secondary storage:

    +
      +
    • zowe zos-files create data-set-vsam SOME.DATA.SET.NAME
    • +
    +
  • +
  • +

    Create a 5 MB LINEAR VSAM data set named "SOME.DATA.SET.NAME" with 1 MB of secondary space. Show the properties of the data set when it is created:

    +
      +
    • zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --data-set-organization LINEAR --size 5MB --secondary-space 1 --attributes
    • +
    +
  • +
  • +

    Create a VSAM data set named "SOME.DATA.SET.NAME", which is retained for 100 days:

    +
      +
    • zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --retain-for 100
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set.html new file mode 100644 index 0000000000..893f951b98 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_create_data-set.html @@ -0,0 +1,241 @@ + + + + +zos-files create data-set + + +
+

zowezos-filescreatedata-set

+

Create data sets based on the properties of an existing data set

+

Usage

+

zowe zos-files create data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to create
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Show the full allocation attributes
    • +
    +
  • +
  • +

    --block-size | --bs | --blksize (number)

    +
      +
    • The block size for the data set (for example, 6160)
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --data-set-type | --dst | --dsntype (string)

    +
      +
    • The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
    • +
    +
  • +
  • +

    --device-type | --dt | --unit (string)

    +
      +
    • The device type, also known as 'unit'
    • +
    +
  • +
  • +

    --directory-blocks | --db | --dirblks (number)

    +
      +
    • The number of directory blocks (for example, 25)
    • +
    +
  • +
  • +

    --like | --lk (string)

    +
      +
    • Name of an existing data set to base your new data set's properties on
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --primary-space | --ps (number)

    +
      +
    • The primary space allocation (for example, 5)
    • +
    +
  • +
  • +

    --record-format | --rf | --recfm (string)

    +
      +
    • The record format for the data set (for example, FB for "Fixed Block")
    • +
    +
  • +
  • +

    --record-length | --rl | --lrecl (number)

    +
      +
    • The logical record length. Analogous to the length of a line (for example, 80)
    • +
    +
  • +
  • +

    --secondary-space | --ss (number)

    +
      +
    • The secondary space allocation (for example, 1)
    • +
    +
  • +
  • +

    --size | --sz (string)

    +
      +
    • The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --volume-serial | --vs | --volser (string)

    +
      +
    • The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a data set with default parameters and like flag:

    +
      +
    • zowe zos-files create data-set NEW.DATASET --like EXISTING.DATASET
    • +
    +
  • +
  • +

    Create a data set with default parameters and like flag and lrecl flag:

    +
      +
    • zowe zos-files create data-set NEW.DATASET --like EXISTING.DATASET --lrecl 1024
    • +
    +
  • +
  • +

    Create a data set with type LIBRARY:

    +
      +
    • zowe zos-files create data-set NEW.DATASET --data-set-type LIBRARY
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_create_uss-directory.html b/static/v2.15.x/web_help/docs/zowe_zos-files_create_uss-directory.html new file mode 100644 index 0000000000..8ff062881e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_create_uss-directory.html @@ -0,0 +1,151 @@ + + + + +zos-files create uss-directory + + +
+

zowezos-filescreateuss-directory

+

Create a UNIX directory.

+

Usage

+

zowe zos-files create uss-directory <ussPath> [options]

+

Positional Arguments

+
    +
  • +

    ussPath (string)

    +
      +
    • The name of the directory that you want to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --mode | -m (string)

    +
      +
    • Specifies the file permission bits to use when creating the directory.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a USS directory named "testDir" :

    +
      +
    • zowe zos-files create uss-directory testDir
    • +
    +
  • +
  • +

    Create a USS directory named "testDir" with mode "rwxrwxrwx" :

    +
      +
    • zowe zos-files create uss-directory testDir -m rwxrwxrwx
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_create_uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-files_create_uss-file.html new file mode 100644 index 0000000000..58d5909691 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_create_uss-file.html @@ -0,0 +1,151 @@ + + + + +zos-files create uss-file + + +
+

zowezos-filescreateuss-file

+

Create a UNIX file.

+

Usage

+

zowe zos-files create uss-file <ussPath> [options]

+

Positional Arguments

+
    +
  • +

    ussPath (string)

    +
      +
    • The name of the file that you want to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --mode | -m (string)

    +
      +
    • Specifies the file permission bits to use when creating the file.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a USS file named "test.ext" :

    +
      +
    • zowe zos-files create uss-file text.txt
    • +
    +
  • +
  • +

    Create a USS file named "text.txt" with mode "rwxrwxrwx" :

    +
      +
    • zowe zos-files create uss-file text.txt -m rwxrwxrwx
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_create_zos-file-system.html b/static/v2.15.x/web_help/docs/zowe_zos-files_create_zos-file-system.html new file mode 100644 index 0000000000..e8cc71f5b4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_create_zos-file-system.html @@ -0,0 +1,223 @@ + + + + +zos-files create zos-file-system + + +
+

zowezos-filescreatezos-file-system

+

Create a z/OS file system.

+

Usage

+

zowe zos-files create zos-file-system <fileSystemName> [options]

+

Positional Arguments

+
    +
  • +

    fileSystemName (string)

    +
      +
    • The name of the file system to create.
    • +
    +
  • +
+

Options

+
    +
  • +

    --cyls-pri | --cp (number)

    +
      +
    • +

      The number of primary cylinders to allocate for the ZFS.

      +

      Default value: 10

      +
    • +
    +
  • +
  • +

    --cyls-sec | --cs (number)

    +
      +
    • +

      The number of secondary cylinders to allocate for the ZFS.

      +

      Default value: 2

      +
    • +
    +
  • +
  • +

    --data-class | --dc (string)

    +
      +
    • The SMS data class to use for the allocation
    • +
    +
  • +
  • +

    --group | -g (string)

    +
      +
    • The z/OS group ID or GID for the group of the ZFS root directory.
    • +
    +
  • +
  • +

    --management-class | --mc (string)

    +
      +
    • The SMS management class to use for the allocation
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • The z/OS user ID or UID for the owner of the ZFS root directory.
    • +
    +
  • +
  • +

    --perms | -p (number)

    +
      +
    • +

      The permissions code for the ZFS root directory.

      +

      Default value: 755

      +
    • +
    +
  • +
  • +

    --storage-class | --sc (string)

    +
      +
    • The SMS storage class to use for the allocation
    • +
    +
  • +
  • +

    --timeout | -t (number)

    +
      +
    • +

      The number of seconds to wait for the underlying "zfsadm format" command to complete. If this command times out, the ZFS may have been created but not formatted correctly.

      +

      Default value: 20

      +
    • +
    +
  • +
  • +

    --volumes | -v (array)

    +
      +
    • The storage volumes on which to allocate the z/OS file system. Specify a single volume by its volume serial (VOLSER). To specify more than one volume, separate each VOLSER with a space. You must specify the volumes option when your cluster is not SMS-managed.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a ZFS named "HLQ.MYNEW.ZFS" using default values of 755 permissions, 10 primary and 2 secondary cylinders allocated, and a timeout of 20 seconds:

    +
      +
    • zowe zos-files create zos-file-system HLQ.MYNEW.ZFS
    • +
    +
  • +
  • +

    Create a ZFS with 100 primary and 10 secondary cylinders allocated:

    +
      +
    • zowe zos-files create zos-file-system HLQ.MYNEW.ZFS --cp 100 --cs 10
    • +
    +
  • +
  • +

    Create a ZFS specifying the volumes that should be used:

    +
      +
    • zowe zos-files create zos-file-system HLQ.MYNEW.ZFS -v ZFS001 ZFS002
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_delete.html b/static/v2.15.x/web_help/docs/zowe_zos-files_delete.html new file mode 100644 index 0000000000..b2e2b7f7cc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_delete.html @@ -0,0 +1,24 @@ + + + + +zos-files delete + + +
+

zowezos-filesdelete

+

Delete a data set or Unix System Services file.

+

Usage

+

zowe zos-files delete <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_delete_data-set-vsam.html b/static/v2.15.x/web_help/docs/zowe_zos-files_delete_data-set-vsam.html new file mode 100644 index 0000000000..23d7ea1f26 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_delete_data-set-vsam.html @@ -0,0 +1,184 @@ + + + + +zos-files delete data-set-vsam + + +
+

zowezos-filesdeletedata-set-vsam

+

Delete a VSAM cluster permanently

+

Usage

+

zowe zos-files delete data-set-vsam <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the VSAM cluster that you want to delete
    • +
    +
  • +
+

Options

+
    +
  • +

    --erase | -e (boolean)

    +
      +
    • +

      Specify this option to overwrite the data component for the cluster with binary zeros. This option is ignored if the NOERASE attribute was specified when the cluster was defined or altered.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --purge | -p (boolean)

    +
      +
    • +

      Specify this option to delete the VSAM cluster regardless of its retention period or date.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --for-sure | -f (boolean)

    +
      +
    • Specify this option to confirm that you want to delete the VSAM cluster permanently.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the VSAM data set named 'ibmuser.cntl.vsam':

    +
      +
    • zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f
    • +
    +
  • +
  • +

    Delete all expired VSAM data sets that match 'ibmuser.AAA.**.FFF':

    +
      +
    • zowe zos-files delete data-set-vsam "ibmuser.AAA.**.FFF" -f
    • +
    +
  • +
  • +

    Delete a non-expired VSAM data set named 'ibmuser.cntl.vsam':

    +
      +
    • zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f --purge
    • +
    +
  • +
  • +

    Delete an expired VSAM data set named 'ibmuser.cntl.vsam' by overwriting the components with zeros:

    +
      +
    • zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f --erase
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_delete_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_delete_data-set.html new file mode 100644 index 0000000000..a699d07d81 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_delete_data-set.html @@ -0,0 +1,160 @@ + + + + +zos-files delete data-set + + +
+

zowezos-filesdeletedata-set

+

Delete a data set or data set member permanently

+

Usage

+

zowe zos-files delete data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to delete
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --for-sure | -f (boolean)

    +
      +
    • Specify this option to confirm that you want to delete the data set permanently.
    • +
    +
  • +
+

Options

+
    +
  • +

    --volume | --vol (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. The option is required only when the data set is not catalogued on the system.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the data set named 'ibmuser.cntl':

    +
      +
    • zowe zos-files delete data-set "ibmuser.cntl" -f
    • +
    +
  • +
  • +

    Delete the data set member named 'ibmuser.cntl(mem)':

    +
      +
    • zowe zos-files delete data-set "ibmuser.cntl(mem)" -f
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_delete_migrated-data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_delete_migrated-data-set.html new file mode 100644 index 0000000000..8a67096326 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_delete_migrated-data-set.html @@ -0,0 +1,157 @@ + + + + +zos-files delete migrated-data-set + + +
+

zowezos-filesdeletemigrated-data-set

+

Delete migrated data sets.

+

Usage

+

zowe zos-files delete migrated-data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the migrated data set you want to delete.
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait | -w (boolean)

    +
      +
    • +

      If true then the function waits for completion of the request. If false (default) the request is queued.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --purge | -p (boolean)

    +
      +
    • +

      If true then the function uses the PURGE=YES on ARCHDEL request. If false (default) the function uses the PURGE=NO on ARCHDEL request.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete a migrated data set using default options:

    +
      +
    • zowe zos-files delete migrated-data-set "USER.DATA.SET"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_delete_uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-files_delete_uss-file.html new file mode 100644 index 0000000000..5a5d514a53 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_delete_uss-file.html @@ -0,0 +1,166 @@ + + + + +zos-files delete uss-file + + +
+

zowezos-filesdeleteuss-file

+

Delete a Unix Systems Services (USS) File or directory permanently

+

Usage

+

zowe zos-files delete uss-file <fileName> [options]

+

Positional Arguments

+
    +
  • +

    fileName (string)

    +
      +
    • The name of the file or directory that you want to delete
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --for-sure | -f (boolean)

    +
      +
    • Specify this option to confirm that you want to delete the file or directory permanently.
    • +
    +
  • +
+

Options

+
    +
  • +

    --recursive | -r (boolean)

    +
      +
    • Delete directories recursively.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the empty directory '/u/ibmuser/testcases':

    +
      +
    • zowe zos-files delete uss-file "/a/ibmuser/testcases" -f
    • +
    +
  • +
  • +

    Delete the file named '/a/ibmuser/my_text.txt':

    +
      +
    • zowe zos-files delete uss-file "/a/ibmuser/testcases/my_text.txt" -f
    • +
    +
  • +
  • +

    Recursively delete the directory named '/u/ibmuser/testcases':

    +
      +
    • zowe zos-files delete uss-file "/a/ibmuser/testcases" -rf
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_delete_zos-file-system.html b/static/v2.15.x/web_help/docs/zowe_zos-files_delete_zos-file-system.html new file mode 100644 index 0000000000..db7bbab3a2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_delete_zos-file-system.html @@ -0,0 +1,148 @@ + + + + +zos-files delete zos-file-system + + +
+

zowezos-filesdeletezos-file-system

+

Delete a z/OS file system permanently.

+

Usage

+

zowe zos-files delete zos-file-system <fileSystemName> [options]

+

Positional Arguments

+
    +
  • +

    fileSystemName (string)

    +
      +
    • The name of the z/OS file system that you want to delete.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --for-sure | -f (boolean)

    +
      +
    • Specify this option to confirm that you want to delete the ZFS permanently.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the z/OS file system 'HLQ.MYNEW.ZFS':

    +
      +
    • zowe zos-files delete zos-file-system "HLQ.MYNEW.ZFS" -f
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_download.html b/static/v2.15.x/web_help/docs/zowe_zos-files_download.html new file mode 100644 index 0000000000..dc38794ce6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_download.html @@ -0,0 +1,24 @@ + + + + +zos-files download + + +
+

zowezos-filesdownload

+

Download content from z/OS data sets and USS files to your PC.

+

Usage

+

zowe zos-files download <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_download_all-members.html b/static/v2.15.x/web_help/docs/zowe_zos-files_download_all-members.html new file mode 100644 index 0000000000..ce2e9c54d8 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_download_all-members.html @@ -0,0 +1,209 @@ + + + + +zos-files download all-members + + +
+

zowezos-filesdownloadall-members

+

Download all members from a partitioned data set to a local folder

+

Usage

+

zowe zos-files download all-members <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set from which you want to download members
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The directory to where you want to save the members. The command creates the directory for you when it does not already exist. By default, the command creates a folder structure based on the data set qualifiers. For example, the data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
    • +
    +
  • +
  • +

    --fail-fast | --ff (boolean)

    +
      +
    • +

      Set this option to false to continue downloading dataset members if one or more fail.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --max-concurrent-requests | --mcr (number)

    +
      +
    • +

      Specifies the maximum number of concurrent z/OSMF REST API requests to download members. Increasing the value results in faster downloads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the download process encounters an error, the following message displays:
      +The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to download all members at once without a maximum number of concurrent requests.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --preserve-original-letter-case | --po (boolean)

    +
      +
    • +

      Specifies if the automatically generated directories and files use the original letter case

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Download the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download the members of the data set "ibmuser.loadlib" in binary mode to the directory "loadlib/":

    +
      +
    • zowe zos-files download all-members "ibmuser.loadlib" -b -d loadlib
    • +
    +
  • +
  • +

    Download the members of the data set "ibmuser.cntl" in text mode to the directory "jcl/":

    +
      +
    • zowe zos-files download all-members "ibmuser.cntl" -d jcl
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_download_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_download_data-set.html new file mode 100644 index 0000000000..5cc683e7d6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_download_data-set.html @@ -0,0 +1,184 @@ + + + + +zos-files download data-set + + +
+

zowezos-filesdownloaddata-set

+

Download content from a z/OS data set to a local file

+

Usage

+

zowe zos-files download data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set that you want to download
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
    • +
    +
  • +
  • +

    --file | -f (string)

    +
      +
    • The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
    • +
    +
  • +
  • +

    --preserve-original-letter-case | --po (boolean)

    +
      +
    • +

      Specifies if the automatically generated directories and files use the original letter case

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Download the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download the data set "ibmuser.loadlib(main)" in binary mode to the local file "main.obj":

    +
      +
    • zowe zos-files download data-set "ibmuser.loadlib(main)" -b -f main.obj
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_download_data-sets-matching.html b/static/v2.15.x/web_help/docs/zowe_zos-files_download_data-sets-matching.html new file mode 100644 index 0000000000..56980cbf6a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_download_data-sets-matching.html @@ -0,0 +1,225 @@ + + + + +zos-files download data-sets-matching + + +
+

zowezos-filesdownloaddata-sets-matching

+

Download all data sets that match a DSLEVEL pattern (see help below). You can use several options to qualify which data sets will be skipped and how the downloaded files will be structured. Data sets that are neither physical sequential nor partitioned data sets (with members) will be excluded.

+

Usage

+

zowe zos-files download data-sets-matching <pattern> [options]

+

Positional Arguments

+
    +
  • +

    pattern (string)

    +
      +
    • The pattern or patterns to match data sets against. Also known as 'DSLEVEL'. The following special sequences can be used in the pattern:
      +%: matches any single character
      +*: matches any number of characters within a data set name qualifier (e.g. "ibmuser.j*.old" matches "ibmuser.jcl.old" but not "ibmuser.jcl.very.old")
      +**: matches any number of characters within any number of data set name qualifiers (e.g. "ibmuser.**.old" matches both "ibmuser.jcl.old" and "ibmuser.jcl.very.old")
      +However, the pattern cannot begin with any of these sequences.You can specify multiple patterns separated by commas, for example "ibmuser.**.cntl,ibmuser.**.jcl"
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The directory to where you want to save the members. The command creates the directory for you when it does not already exist. By default, the command creates a folder structure based on the data set qualifiers. For example, the data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --exclude-patterns | --ep (string)

    +
      +
    • Exclude data sets that match these DSLEVEL patterns. Any data sets that match this pattern will not be downloaded.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
    • +
    +
  • +
  • +

    --extension-map | --em (string)

    +
      +
    • Use this option to map data set names that match your pattern to the desired extension. A comma delimited key value pairing (e.g. "cntl=.jcl,cpgm=.c" to map the last segment of each data set (also known as the "low level qualifier" to the desired local file extension).
    • +
    +
  • +
  • +

    --fail-fast | --ff (boolean)

    +
      +
    • +

      Set this option to false to continue downloading dataset members if one or more fail.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --max-concurrent-requests | --mcr (number)

    +
      +
    • +

      Specifies the maximum number of concurrent z/OSMF REST API requests to download members. Increasing the value results in faster downloads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the download process encounters an error, the following message displays:
      +The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to download all members at once without a maximum number of concurrent requests.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --preserve-original-letter-case | --po (boolean)

    +
      +
    • +

      Specifies if the automatically generated directories and files use the original letter case

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Download the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download all data sets beginning with "ibmuser" and ending with ".cntl" or ".jcl" to the local directory "jcl" to files with the extension ".jcl":

    +
      +
    • zowe zos-files download data-sets-matching "ibmuser.**.cntl, ibmuser.**.jcl" --directory jcl --extension .jcl
    • +
    +
  • +
  • +

    Download all data sets that begin with "ibmuser.public.project" or "ibmuser.project.private", excluding those that end in "lib" to the local directory "project", providing a custom mapping of data set low level qualifier to local file extension:

    +
      +
    • zowe zos-files download data-sets-matching "ibmuser.public.project.*, ibmuser.project.private.*" --exclude-patterns "ibmuser.public.**.*lib" --directory project --extension-map cpgm=c,asmpgm=asm,java=java,chdr=c,jcl=jcl,cntl=jcl
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_download_uss-directory.html b/static/v2.15.x/web_help/docs/zowe_zos-files_download_uss-directory.html new file mode 100644 index 0000000000..603aef103e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_download_uss-directory.html @@ -0,0 +1,275 @@ + + + + +zos-files download uss-directory + + +
+

zowezos-filesdownloaduss-directory

+

Download content from a USS directory to a local directory on your PC

+

Usage

+

zowe zos-files download uss-directory <ussDirName> [options]

+

Positional Arguments

+
    +
  • +

    ussDirName (string)

    +
      +
    • The name of the USS directory you want to download
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | --attrs (local file path)

    +
      +
    • Path of an attributes file to control how files are downloaded
    • +
    +
  • +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --depth (number)

    +
      +
    • Filters content in USS based on the number of directories to traverse down.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The directory to where you want to save the files. The command creates the directory for you when it does not already exist. By default, the command downloads the files to the current directory.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --fail-fast | --ff (boolean)

    +
      +
    • +

      Set this option to false to continue downloading USS files if one or more fail.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --filesys (boolean)

    +
      +
    • Filters content in USS based on the filesystem the data is on. true - all filesystems, false - same filesystem as search directory.
    • +
    +
  • +
  • +

    --group (string)

    +
      +
    • Filters content in USS based on the owning group name or ID.
    • +
    +
  • +
  • +

    --include-hidden | --ih (boolean)

    +
      +
    • Include hidden files and folders that have names beginning with a dot
    • +
    +
  • +
  • +

    --max-concurrent-requests | --mcr (number)

    +
      +
    • +

      Specifies the maximum number of concurrent z/OSMF REST API requests to download files. Increasing the value results in faster downloads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the download process encounters an error, the following message displays:
      +The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to download all files at once without a maximum number of concurrent requests.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --max-length | --max (number)

    +
      +
    • The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
    • +
    +
  • +
  • +

    --mtime (string)

    +
      +
    • Filters content in USS based on the last modification time. N - specify an exact number of days, +N - older than N days, -N - newer than N days
    • +
    +
  • +
  • +

    --name (string)

    +
      +
    • Filters files in USS based on the name of the file or directory.
    • +
    +
  • +
  • +

    --overwrite | --ow (boolean)

    +
      +
    • Overwrite files that already exist in your local environment
    • +
    +
  • +
  • +

    --owner (string)

    +
      +
    • Filters content in USS based on the owning user name or ID.
    • +
    +
  • +
  • +

    --perm (string)

    +
      +
    • Filters content in USS based on the octal permissions string.
    • +
    +
  • +
  • +

    --size (string)

    +
      +
    • Filters content in USS based on the size. Default units are bytes. Add a suffix of K for kilobytes, M for megabytes, or G for gigabytes. N - specify an exact file size, +N - larger than N size, -N - smaller than N size
    • +
    +
  • +
  • +

    --symlinks (boolean)

    +
      +
    • Filters content in USS based on whether or not to follow symbolic links. true - report symlinks, false - follow symlinks
    • +
    +
  • +
  • +

    --type (string)

    +
      +
    • +

      Filters content in USS based on the type of content. f - regular file, d - directory, l - symbolic link, p - FIFO named pipe, s - socket

      +

      Allowed values: f, d, l, p, s

      +
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download the directory "/a/ibmuser" to "./" in binary mode:

    +
      +
    • zowe zos-files download uss-directory /a/ibmuser --binary
    • +
    +
  • +
  • +

    Download the directory "/a/ibmuser" to "./localDir":

    +
      +
    • zowe zos-files download uss-directory /a/ibmuser --directory localDir
    • +
    +
  • +
  • +

    Download files from the directory "/a/ibmuser" that match the name "*.log" and were modified within the last day:

    +
      +
    • zowe zos-files download uss-directory /a/ibmuser --name "*.log" --mtime -1
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_download_uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-files_download_uss-file.html new file mode 100644 index 0000000000..e9b77be8b6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_download_uss-file.html @@ -0,0 +1,163 @@ + + + + +zos-files download uss-file + + +
+

zowezos-filesdownloaduss-file

+

Download content from a USS file to a local file on your PC

+

Usage

+

zowe zos-files download uss-file <ussFileName> [options]

+

Positional Arguments

+
    +
  • +

    ussFileName (string)

    +
      +
    • The name of the USS file you want to download
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --file | -f (string)

    +
      +
    • The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download the file "/a/ibmuser/my_text.txt" to ./my_text.txt:

    +
      +
    • zowe zos-files download uss-file "/a/ibmuser/my_text.txt" -f ./my_text.txt
    • +
    +
  • +
  • +

    Download the file "/a/ibmuser/MyJava.class" to "java/MyJava.class" in binary mode:

    +
      +
    • zowe zos-files download uss-file "/a/ibmuser/MyJava.class" -b -f "java/MyJava.class"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_edit.html b/static/v2.15.x/web_help/docs/zowe_zos-files_edit.html new file mode 100644 index 0000000000..b1342d4085 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_edit.html @@ -0,0 +1,21 @@ + + + + +zos-files edit + + +
+

zowezos-filesedit

+

Edit the contents of a data set or USS file with your terminal and default editor.

+

Usage

+

zowe zos-files edit <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_edit_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_edit_data-set.html new file mode 100644 index 0000000000..9736869954 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_edit_data-set.html @@ -0,0 +1,175 @@ + + + + +zos-files edit data-set + + +
+

zowezos-fileseditdata-set

+

Edit content from a z/OS data set with your terminal and default editor.

+

Usage

+

zowe zos-files edit data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set you want to edit.
    • +
    +
  • +
+

Options

+
    +
  • +

    --editor | --ed (string)

    +
      +
    • Editor that overrides the default editor for this file type. Set the option to the editor's executable file location or the program's name: ie "--editor notepad"
    • +
    +
  • +
  • +

    --extension | --ext (string)

    +
      +
    • Set the file extension of the file for editing to leverage an editor's file-type-specific formatting: ie "--extension jcl"
    • +
    +
  • +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the file content in binary mode (no EBCDIC to ASCII conversion).
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Edit the contents of the data set member "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-files edit data-set ibmuser.cntl(iefbr14) --editor notepad
    • +
    +
  • +
  • +

    Edit the contents of the data set member "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-files edit data-set ibmuser.cntl(iefbr14) --editor C:\Windows\System32\Notepad.exe
    • +
    +
  • +
  • +

    Edit the contents of the data set member "ibmuser.jcl(iefbr14)" and set extension as "jcl":

    +
      +
    • zowe zos-files edit data-set ibmuser.jcl(iefbr14) --binary
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_edit_uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-files_edit_uss-file.html new file mode 100644 index 0000000000..b09f18fd91 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_edit_uss-file.html @@ -0,0 +1,169 @@ + + + + +zos-files edit uss-file + + +
+

zowezos-filesedituss-file

+

Edit content from a Unix System Services (USS) file with your terminal and default editor.

+

Usage

+

zowe zos-files edit uss-file <ussFilePath> [options]

+

Positional Arguments

+
    +
  • +

    ussFilePath (string)

    +
      +
    • The path of the USS file you want to edit.
    • +
    +
  • +
+

Options

+
    +
  • +

    --editor | --ed (string)

    +
      +
    • Editor that overrides the default editor for this file type. Set the option to the editor's executable file location or the program's name: ie "--editor notepad"
    • +
    +
  • +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the file content in binary mode (no EBCDIC to ASCII conversion).
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Edit the contents of the USS file "/a/ibmuser/my_text.txt" in notepad:

    +
      +
    • zowe zos-files edit uss-file /a/ibmuser/my_text.txt --editor notepad
    • +
    +
  • +
  • +

    Edit the contents of the USS file "/a/ibmuser/my_text.txt" in notepad:

    +
      +
    • zowe zos-files edit uss-file /a/ibmuser/my_text.txt --editor C:\Windows\System32\Notepad.exe
    • +
    +
  • +
  • +

    Edit the contents of the USS file "/a/ibmuser/my_jcl.jcl" with binary flag set:

    +
      +
    • zowe zos-files edit uss-file /a/ibmuser/my_text.txt --binary
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_invoke.html b/static/v2.15.x/web_help/docs/zowe_zos-files_invoke.html new file mode 100644 index 0000000000..3bb9cb21f6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_invoke.html @@ -0,0 +1,21 @@ + + + + +zos-files invoke + + +
+

zowezos-filesinvoke

+

Invoke z/OS utilities such as Access Method Services (AMS).

+

Usage

+

zowe zos-files invoke <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_invoke_ams-file.html b/static/v2.15.x/web_help/docs/zowe_zos-files_invoke_ams-file.html new file mode 100644 index 0000000000..1459d2064e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_invoke_ams-file.html @@ -0,0 +1,139 @@ + + + + +zos-files invoke ams-file + + +
+

zowezos-filesinvokeams-file

+

Submit control statements for execution by Access Method Services (IDCAMS). You can use IDCAMS to create VSAM data sets (CSI, ZFS, etc...), delete data sets, and more. You must format the control statements exactly as the IDCAMS utility expects. For more information about control statements, see the IBM publication 'z/OS DFSMS Access Method Services Commands'.

+

Usage

+

zowe zos-files invoke ams-file <controlStatementsFile> [options]

+

Positional Arguments

+
    +
  • +

    controlStatementsFile (string)

    +
      +
    • The path to a file that contains IDCAMS control statements. Ensure that your file does not contain statements that are longer than 255 characters (maximum allowed length).
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Reads the specified file and submits the controls statements:

    +
      +
    • zowe zos-files invoke ams-file "./path/to/file/MyControlStatements.idcams"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_invoke_ams-statements.html b/static/v2.15.x/web_help/docs/zowe_zos-files_invoke_ams-statements.html new file mode 100644 index 0000000000..6f6507ddf4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_invoke_ams-statements.html @@ -0,0 +1,145 @@ + + + + +zos-files invoke ams-statements + + +
+

zowezos-filesinvokeams-statements

+

Submit control statements for execution by Access Method Services (IDCAMS). You can use IDCAMS to create VSAM data sets (CSI, ZFS, etc...), delete data sets, and more. You must format the control statements exactly as the IDCAMS utility expects. For more information about control statements, see the IBM publication 'z/OS DFSMS Access Method Services Commands'.

+

Usage

+

zowe zos-files invoke ams-statements <controlStatements> [options]

+

Positional Arguments

+
    +
  • +

    controlStatements (string)

    +
      +
    • The IDCAMS control statement that you want to submit. Zowe CLI attempts to split the inline control statement at 255 characters.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Defines a cluster named 'DUMMY.VSAM.CLUSTER':

    +
      +
    • zowe zos-files invoke ams-statements "DEFINE CLUSTER ( NAME (DUMMY.VSAM.CLUSTER) CYL(1 1))"
    • +
    +
  • +
  • +

    Deletes a cluster named 'DUMMY.VSAM.CLUSTER':

    +
      +
    • zowe zos-files invoke ams-statements "DELETE DUMMY.VSAM.CLUSTER CLUSTER"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_list.html b/static/v2.15.x/web_help/docs/zowe_zos-files_list.html new file mode 100644 index 0000000000..42b3a6970c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_list.html @@ -0,0 +1,23 @@ + + + + +zos-files list + + + + + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_list_all-members.html b/static/v2.15.x/web_help/docs/zowe_zos-files_list_all-members.html new file mode 100644 index 0000000000..1359188e14 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_list_all-members.html @@ -0,0 +1,175 @@ + + + + +zos-files list all-members + + +
+

zowezos-fileslistall-members

+

List all members of a partitioned data set. To view additional information about each member, use the --attributes option under the Options section of this help text.

+

Usage

+

zowe zos-files list all-members <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set for which you want to list the members
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Display more information about each member. Data sets with an undefined record format display information related to executable modules. Variable and fixed block data sets display information about when the members were created and modified.
    • +
    +
  • +
  • +

    --max-length | --max (number)

    +
      +
    • The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
    • +
    +
  • +
  • +

    --pattern (string)

    +
      +
    • The option --pattern specifies the match pattern used when listing members in a data set. The default is to match against all members, e.g. "*".
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show members of the data set "ibmuser.asm":

    +
      +
    • zowe zos-files list all-members "ibmuser.asm"
    • +
    +
  • +
  • +

    Show attributes of members of the data set "ibmuser.cntl":

    +
      +
    • zowe zos-files list all-members "ibmuser.cntl" -a
    • +
    +
  • +
  • +

    Show the first 5 members of the data set "ibmuser.cntl":

    +
      +
    • zowe zos-files list all-members "ibmuser.cntl" --max 5
    • +
    +
  • +
  • +

    Show the first 4 members of the data set "ibmuser.cntl" matching an input pattern":

    +
      +
    • zowe zos-files list all-members "sys1.maclib" --pattern IJK* --max 4
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_list_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_list_data-set.html new file mode 100644 index 0000000000..3348537b5b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_list_data-set.html @@ -0,0 +1,187 @@ + + + + +zos-files list data-set + + +
+

zowezos-fileslistdata-set

+

List data sets that match a pattern in the data set name

+

Usage

+

zowe zos-files list data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name or pattern of the data set that you want to list
    • +
    +
  • +
+

Options

+
    +
  • +

    --attributes | -a (boolean)

    +
      +
    • Display more information about each member. Data sets with an undefined record format display information related to executable modules. Variable and fixed block data sets display information about when the members were created and modified.
    • +
    +
  • +
  • +

    --max-length | --max (number)

    +
      +
    • The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --start | -s (string)

    +
      +
    • An optional search parameter that specifies the first data set name to return in the response document.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show the data set "ibmuser.asm":

    +
      +
    • zowe zos-files list data-set "ibmuser.asm"
    • +
    +
  • +
  • +

    Show attributes of the data set "ibmuser.cntl":

    +
      +
    • zowe zos-files list data-set "ibmuser.cntl" -a
    • +
    +
  • +
  • +

    Show all data sets of the user "ibmuser":

    +
      +
    • zowe zos-files list data-set "ibmuser.*"
    • +
    +
  • +
  • +

    Show attributes of all data sets of the user "ibmuser":

    +
      +
    • zowe zos-files list data-set "ibmuser.*" -a
    • +
    +
  • +
  • +

    Show the first 5 data sets of the user "ibmuser":

    +
      +
    • zowe zos-files list data-set "ibmuser.cntl" --max 5
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_list_file-system.html b/static/v2.15.x/web_help/docs/zowe_zos-files_list_file-system.html new file mode 100644 index 0000000000..8a954c08ea --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_list_file-system.html @@ -0,0 +1,188 @@ + + + + +zos-files list file-system + + +
+

zowezos-fileslistfile-system

+

List all mounted filesystems, or the specific filesystem mounted at a given path, or the filesystem with a given filesystem name.

+

Usage

+

zowe zos-files list file-system [options]

+

Options

+
    +
  • +

    --max-length | --max (number)

    +
      +
    • The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
    • +
    +
  • +
  • +

    --fsname | -f (string)

    +
      +
    • Specifies the name of the mounted file system. This option and --path are mutually exclusive.
    • +
    +
  • +
  • +

    --path | -p (string)

    +
      +
    • Specifies the path where the file system is mounted. This option and --fsname are mutually exclusive.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To list all mounted filesystems:

    +
      +
    • zowe zos-files list file-system
    • +
    +
  • +
  • +

    To list filesystems mounted to a specific path:

    +
      +
    • zowe zos-files list file-system -p /a/ibmuser
    • +
    +
  • +
  • +

    To list filesystems mounted with a specific name:

    +
      +
    • zowe zos-files list file-system -f MY.ZFS
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_list_uss-files.html b/static/v2.15.x/web_help/docs/zowe_zos-files_list_uss-files.html new file mode 100644 index 0000000000..ccc57ba1fb --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_list_uss-files.html @@ -0,0 +1,185 @@ + + + + +zos-files list uss-files + + +
+

zowezos-fileslistuss-files

+

List USS files and directories in a UNIX file path

+

Usage

+

zowe zos-files list uss-files <path> [options]

+

Positional Arguments

+
    +
  • +

    path (string)

    +
      +
    • The directory containing the files and directories to be listed
    • +
    +
  • +
+

Options

+
    +
  • +

    --max-length | --max (number)

    +
      +
    • The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Show the files and directories in path '/u/ibmuser':

    +
      +
    • zowe zos-files list uss-files "/u/ibmuser"
    • +
    +
  • +
  • +

    Show the files and directories in path '/u/ibmuser displaying only the file or directory name:

    +
      +
    • zowe zos-files list uss-files "/u/ibmuser" --rff name
    • +
    +
  • +
  • +

    Show the files and directories in path '/u/ibmuser' displaying the headers associated with the file detail:

    +
      +
    • zowe zos-files list uss-files "/u/ibmuser" --rfh
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_migrate.html b/static/v2.15.x/web_help/docs/zowe_zos-files_migrate.html new file mode 100644 index 0000000000..d3639d37d4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_migrate.html @@ -0,0 +1,20 @@ + + + + +zos-files migrate + + +
+

zowezos-filesmigrate

+

Migrate data sets.

+

Usage

+

zowe zos-files migrate <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_migrate_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_migrate_data-set.html new file mode 100644 index 0000000000..78a8e75cbc --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_migrate_data-set.html @@ -0,0 +1,148 @@ + + + + +zos-files migrate data-set + + +
+

zowezos-filesmigratedata-set

+

Migrate a data set.

+

Usage

+

zowe zos-files migrate data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set you want to migrate.
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait | -w (boolean)

    +
      +
    • +

      If true then the function waits for completion of the request. If false (default) the request is queued.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Migrate a data set using default options:

    +
      +
    • zowe zos-files migrate data-set "USER.DATA.SET"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_mount.html b/static/v2.15.x/web_help/docs/zowe_zos-files_mount.html new file mode 100644 index 0000000000..bdfd2271eb --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_mount.html @@ -0,0 +1,20 @@ + + + + +zos-files mount + + +
+

zowezos-filesmount

+

Mount z/OS UNIX file systems, such as HFS, ZFS, and more. This connects you to USS file systems.

+

Usage

+

zowe zos-files mount <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_mount_file-system.html b/static/v2.15.x/web_help/docs/zowe_zos-files_mount_file-system.html new file mode 100644 index 0000000000..ede9a8d410 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_mount_file-system.html @@ -0,0 +1,170 @@ + + + + +zos-files mount file-system + + +
+

zowezos-filesmountfile-system

+

Mount a UNIX file system on a specified directory.

+

Usage

+

zowe zos-files mount file-system <fileSystemName> <mountPoint> [options]

+

Positional Arguments

+
    +
  • +

    fileSystemName (string)

    +
      +
    • The name of the file system to mount.
    • +
    +
  • +
  • +

    mountPoint (string)

    +
      +
    • The directory to use as a mount point.
    • +
    +
  • +
+

Options

+
    +
  • +

    --fs-type | --ft (string)

    +
      +
    • +

      Specify the file system type that you are going to mount. The name must match the TYPE operand on a FILESYSTYPE statement in the BPXPRMxx parmlib member for the file system.

      +

      Default value: ZFS

      +
    • +
    +
  • +
  • +

    --mode | -m (string)

    +
      +
    • +

      Specify the mode for mounting the file system (rdonly - read-only, rdwr - read/write).

      +

      Default value: rdonly
      +Allowed values: rdonly, rdwr

      +
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Mount a z/OS file system using default options:

    +
      +
    • zowe zos-files mount file-system MY.ZFS /a/ibmuser/mountdir
    • +
    +
  • +
  • +

    Mount a hierarchical file system with write access:

    +
      +
    • zowe zos-files mount file-system MY.HFS /a/ibmuser/mountdir --ft HFS -m rdwr
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_recall.html b/static/v2.15.x/web_help/docs/zowe_zos-files_recall.html new file mode 100644 index 0000000000..36d1400fd1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_recall.html @@ -0,0 +1,20 @@ + + + + +zos-files recall + + +
+

zowezos-filesrecall

+

Recall migrated data sets.

+

Usage

+

zowe zos-files recall <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_recall_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_recall_data-set.html new file mode 100644 index 0000000000..06ffb4eb66 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_recall_data-set.html @@ -0,0 +1,148 @@ + + + + +zos-files recall data-set + + +
+

zowezos-filesrecalldata-set

+

Recall a migrated data set.

+

Usage

+

zowe zos-files recall data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set you want to recall.
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait | -w (boolean)

    +
      +
    • +

      If true then the function waits for completion of the request. If false (default) the request is queued.

      +

      Default value: false

      +
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Recall a data set using default options:

    +
      +
    • zowe zos-files recall data-set "USER.DATA.SET"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_rename.html b/static/v2.15.x/web_help/docs/zowe_zos-files_rename.html new file mode 100644 index 0000000000..58674e1ef5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_rename.html @@ -0,0 +1,21 @@ + + + + +zos-files rename + + + + + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_rename_data-set-member.html b/static/v2.15.x/web_help/docs/zowe_zos-files_rename_data-set-member.html new file mode 100644 index 0000000000..dd44f386c3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_rename_data-set-member.html @@ -0,0 +1,151 @@ + + + + +zos-files rename data-set-member + + +
+

zowezos-filesrenamedata-set-member

+

Rename a data set member.

+

Usage

+

zowe zos-files rename data-set-member <dataSetName> <beforeMemberName> <afterMemberName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set the member belongs to.
    • +
    +
  • +
  • +

    beforeMemberName (string)

    +
      +
    • The name of the data set member that you want to rename.
    • +
    +
  • +
  • +

    afterMemberName (string)

    +
      +
    • The name you want to rename the data set member to.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    In the data set 'USER.DATA.SET', rename the member named 'MEM1' to 'MEM2'.:

    +
      +
    • zowe zos-files rename data-set-member "USER.DATA.SET" "MEM1" "MEM2
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_rename_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_rename_data-set.html new file mode 100644 index 0000000000..93344c0e8c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_rename_data-set.html @@ -0,0 +1,145 @@ + + + + +zos-files rename data-set + + +
+

zowezos-filesrenamedata-set

+

Rename a data set.

+

Usage

+

zowe zos-files rename data-set <beforeDataSetName> <afterDataSetName> [options]

+

Positional Arguments

+
    +
  • +

    beforeDataSetName (string)

    +
      +
    • The name of the data set that you want to rename.
    • +
    +
  • +
  • +

    afterDataSetName (string)

    +
      +
    • The name you want to rename the data set to.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Rename the data set named 'USER.BEFORE.SET' to 'USER.AFTER.SET.':

    +
      +
    • zowe zos-files rename data-set "USER.BEFORE.SET" "USER.AFTER.SET"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_unmount.html b/static/v2.15.x/web_help/docs/zowe_zos-files_unmount.html new file mode 100644 index 0000000000..4a0b747a3b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_unmount.html @@ -0,0 +1,20 @@ + + + + +zos-files unmount + + +
+

zowezos-filesunmount

+

Unmount file systems, such as HFS, ZFS, and more. This disconnects you from USS file systems.

+

Usage

+

zowe zos-files unmount <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_unmount_file-system.html b/static/v2.15.x/web_help/docs/zowe_zos-files_unmount_file-system.html new file mode 100644 index 0000000000..f4744c0d7d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_unmount_file-system.html @@ -0,0 +1,139 @@ + + + + +zos-files unmount file-system + + +
+

zowezos-filesunmountfile-system

+

Unmount a UNIX file system.

+

Usage

+

zowe zos-files unmount file-system <fileSystemName> [options]

+

Positional Arguments

+
    +
  • +

    fileSystemName (string)

    +
      +
    • The name of the file system to unmount.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Options

+
    +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Unmount a mounted file system:

    +
      +
    • zowe zos-files unmount file-system MY.FS
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_upload.html b/static/v2.15.x/web_help/docs/zowe_zos-files_upload.html new file mode 100644 index 0000000000..e8aed53d6d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_upload.html @@ -0,0 +1,24 @@ + + + + +zos-files upload + + +
+

zowezos-filesupload

+

Upload the contents of a file to data sets.

+

Usage

+

zowe zos-files upload <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_upload_dir-to-pds.html b/static/v2.15.x/web_help/docs/zowe_zos-files_upload_dir-to-pds.html new file mode 100644 index 0000000000..938393ecbd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_upload_dir-to-pds.html @@ -0,0 +1,184 @@ + + + + +zos-files upload dir-to-pds + + +
+

zowezos-filesuploaddir-to-pds

+

Upload files from a local directory to a partitioned data set (PDS)

+

Usage

+

zowe zos-files upload dir-to-pds <inputdir> <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    inputdir (string)

    +
      +
    • The path for a local directory that you want to upload to a PDS
    • +
    +
  • +
  • +

    dataSetName (string)

    +
      +
    • The name of the partitioned data set to which you want to upload the files
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Data content in encoding mode, which means that data conversion is performed according to the encoding specified.
    • +
    +
  • +
  • +

    --migrated-recall | --mr (string)

    +
      +
    • +

      The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error

      +

      Default value: nowait

      +
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Data content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload a directory named "src" to a PDS named "ibmuser.src":

    +
      +
    • zowe zos-files upload dir-to-pds "src" "ibmuser.src"
    • +
    +
  • +
  • +

    Upload a directory named "src" to a migrated PDS named "ibmuser.src" and wait for it to be recalled:

    +
      +
    • zowe zos-files upload dir-to-pds "src" "ibmuser.src" --mr wait
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_upload_dir-to-uss.html b/static/v2.15.x/web_help/docs/zowe_zos-files_upload_dir-to-uss.html new file mode 100644 index 0000000000..a58afba225 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_upload_dir-to-uss.html @@ -0,0 +1,233 @@ + + + + +zos-files upload dir-to-uss + + +
+

zowezos-filesuploaddir-to-uss

+

Upload a local directory to a USS directory.

+

An optional .zosattributes file in the source directory can be used to control file conversion and tagging.

+

An example .zosattributes file:
+# pattern local-encoding remote-encoding
+# Don't upload the node_modules directory
+node_modules -
+# Don't upload files that start with periods
+.* -
+# Upload jpg images in binary
+*.jpg binary binary
+# Convert CICS Node.js profiles to EBCDIC
+*.profile ISO8859-1 EBCDIC

+

Lines starting with the ‘#’ character are comments. Each line can specify up to three positional attributes:

+
    +
  • A pattern to match a set of files. Pattern-matching syntax follows the same rules as those that apply in .gitignore files (note that negated patterns that begin with ‘!’ are not supported). See https://git-scm.com/docs/gitignore#_pattern_format.
  • +
  • A local-encoding to identify a file’s encoding on the local workstation. If '-' is specified for local-encoding,files that match the pattern are not transferred.
  • +
  • A remote-encoding to specify the file’s desired character set on USS. This attribute must either match the local encoding or be set to EBCDIC. If set to EBCDIC, files are transferred in text mode and converted, otherwise they are transferred in binary mode. Remote files are tagged either with the remote encoding or as binary.
  • +
+

A .zosattributes file can either be placed in the top-level directory you want to upload, or its location can be specified by using the --attributes parameter. .zosattributes files that are placed in nested directories are ignored.

+

Usage

+

zowe zos-files upload dir-to-uss <inputDir> <USSDir> [options]

+

Positional Arguments

+
    +
  • +

    inputDir (string)

    +
      +
    • The local directory path that you want to upload to a USS directory
    • +
    +
  • +
  • +

    USSDir (string)

    +
      +
    • The name of the USS directory to which you want to upload the local directory
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --recursive | -r (boolean)

    +
      +
    • Upload all directories recursively.
    • +
    +
  • +
  • +

    --binary-files | --bf (string)

    +
      +
    • Comma separated list of file names to be uploaded in binary mode. Use this option when you upload a directory in default ASCII mode, but you want to specify certain files to be uploaded in binary mode. All files matching specified file names will be uploaded in binary mode. If a .zosattributes file (or equivalent file specified via --attributes) is present, --binary-files will be ignored.
    • +
    +
  • +
  • +

    --ascii-files | --af (string)

    +
      +
    • Comma separated list of file names to be uploaded in ASCII mode. Use this option when you upload a directory with --binary/-b flag, but you want to specify certain files to be uploaded in ASCII mode. All files matching specified file names will be uploaded in ASCII mode. If a .zosattributes file (or equivalent file specified via --attributes) is present, --ascii-files will be ignored.
    • +
    +
  • +
  • +

    --attributes | --attrs (string)

    +
      +
    • Path of an attributes file to control how files are uploaded
    • +
    +
  • +
  • +

    --max-concurrent-requests | --mcr (number)

    +
      +
    • +

      Specifies the maximum number of concurrent z/OSMF REST API requests to upload files. Increasing the value results in faster uploads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the upload process encounters an error, the following message displays:
      +The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to upload all members at once without a maximum number of concurrent requests.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --include-hidden | --ih (boolean)

    +
      +
    • Include hidden files and folders that have names beginning with a dot
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory:

    +
      +
    • zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir"
    • +
    +
  • +
  • +

    Upload all files from the "local_dir" directory and all its sub-directories, to the "/a/ibmuser/my_dir" USS directory:

    +
      +
    • zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --recursive
    • +
    +
  • +
  • +

    Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory in default ASCII mode, while specifying a list of file names (without path) to be uploaded in binary mode:

    +
      +
    • zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --binary-files "myFile1.exe,myFile2.exe,myFile3.exe"
    • +
    +
  • +
  • +

    Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory in binary mode, while specifying a list of file names (without path) to be uploaded in ASCII mode:

    +
      +
    • zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --binary --ascii-files "myFile1.txt,myFile2.txt,myFile3.txt"
    • +
    +
  • +
  • +

    Recursively upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory, specifying files to ignore and file encodings in the local file my_global_attributes:

    +
      +
    • zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --recursive --attributes my_global_attributes
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_upload_file-to-data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_upload_file-to-data-set.html new file mode 100644 index 0000000000..54341cbe4c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_upload_file-to-data-set.html @@ -0,0 +1,190 @@ + + + + +zos-files upload file-to-data-set + + +
+

zowezos-filesuploadfile-to-data-set

+

Upload the contents of a file to a z/OS data set

+

Usage

+

zowe zos-files upload file-to-data-set <inputfile> <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    inputfile (string)

    +
      +
    • The local file that you want to upload to a data set
    • +
    +
  • +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set to which you want to upload the file
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Data content in encoding mode, which means that data conversion is performed according to the encoding specified.
    • +
    +
  • +
  • +

    --migrated-recall | --mr (string)

    +
      +
    • +

      The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error

      +

      Default value: nowait

      +
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Data content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload file contents to a sequential data set named "ibmuser.ps":

    +
      +
    • zowe zos-files upload file-to-data-set "file.txt" "ibmuser.ps"
    • +
    +
  • +
  • +

    Upload file contents to a PDS member named "ibmuser.pds(mem)":

    +
      +
    • zowe zos-files upload file-to-data-set "file.txt" "ibmuser.pds(mem)"
    • +
    +
  • +
  • +

    Upload file contents to a migrated data set and wait for it to be recalled:

    +
      +
    • zowe zos-files upload file-to-data-set "file.txt" "ibmuser.ps" --mr wait
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_upload_file-to-uss.html b/static/v2.15.x/web_help/docs/zowe_zos-files_upload_file-to-uss.html new file mode 100644 index 0000000000..90d6de2200 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_upload_file-to-uss.html @@ -0,0 +1,157 @@ + + + + +zos-files upload file-to-uss + + +
+

zowezos-filesuploadfile-to-uss

+

Upload content to a USS file from local file

+

Usage

+

zowe zos-files upload file-to-uss <inputfile> <USSFileName> [options]

+

Positional Arguments

+
    +
  • +

    inputfile (string)

    +
      +
    • The local file that you want to upload to a USS file
    • +
    +
  • +
  • +

    USSFileName (string)

    +
      +
    • The name of the USS file to which you want to upload the file
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Data content in encoding mode, which means that data conversion is performed according to the encoding specified.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload to the USS file "/a/ibmuser/my_text.txt" from the file "file.txt":

    +
      +
    • zowe zos-files upload file-to-uss "file.txt" "/a/ibmuser/my_text.txt"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_upload_stdin-to-data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_upload_stdin-to-data-set.html new file mode 100644 index 0000000000..35237ad96a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_upload_stdin-to-data-set.html @@ -0,0 +1,178 @@ + + + + +zos-files upload stdin-to-data-set + + +
+

zowezos-filesuploadstdin-to-data-set

+

Upload the content of a stdin to a z/OS data set

+

Usage

+

zowe zos-files upload stdin-to-data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set to which you want to upload data
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --migrated-recall | --mr (string)

    +
      +
    • +

      The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error

      +

      Default value: nowait

      +
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Data content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Stream content from stdin to a sequential data set named "ibmuser.ps" from a Windows console:

    +
      +
    • echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.ps"
    • +
    +
  • +
  • +

    Stream content from stdin to a partition data set member named "ibmuser.pds(mem)" from a Windows console:

    +
      +
    • echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.pds(mem)"
    • +
    +
  • +
  • +

    Stream content from stdin to a migrated data set and wait for it to be recalled from a Windows console:

    +
      +
    • echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.ps" --mr wait
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_view.html b/static/v2.15.x/web_help/docs/zowe_zos-files_view.html new file mode 100644 index 0000000000..9187413a87 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_view.html @@ -0,0 +1,21 @@ + + + + +zos-files view + + +
+

zowezos-filesview

+

View the contents of a data set or USS file on your terminal (stdout).

+

Usage

+

zowe zos-files view <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_view_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-files_view_data-set.html new file mode 100644 index 0000000000..0b60385748 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_view_data-set.html @@ -0,0 +1,187 @@ + + + + +zos-files view data-set + + +
+

zowezos-filesviewdata-set

+

View content from a z/OS data set on your terminal (stdout).

+

Usage

+

zowe zos-files view data-set <dataSetName> [options]

+

Positional Arguments

+
    +
  • +

    dataSetName (string)

    +
      +
    • The name of the data set you want to display.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the file content in binary mode (no EBCDIC to ASCII conversion).
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • Transfer the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
    • +
    +
  • +
  • +

    --volume-serial | --vs (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
    • +
    +
  • +
  • +

    --range | -R (string)

    +
      +
    • The range of records to return in either `SSS-EEE` or `SSS,NNN` format. SSS identifies the start record, EEE identifies the end record, and NNN identifies the number of retrieved records.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the contents of the data set member "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-files view data-set "ibmuser.cntl(iefbr14)"
    • +
    +
  • +
  • +

    View the contents of the data set member "ibmuser.test.loadlib(main)" in binary mode:

    +
      +
    • zowe zos-files view data-set "ibmuser.test.loadlib(main)" --binary
    • +
    +
  • +
  • +

    View only the first two lines of content for data set member "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-files view data-set "ibmuser.cntl(iefbr14)" --range 0,2
    • +
    +
  • +
  • +

    View only lines six through eight (zero-based) in the contents of the data set member "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-files view data-set "ibmuser.cntl(iefbr14)" --range 5-7
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-files_view_uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-files_view_uss-file.html new file mode 100644 index 0000000000..a6ef49a272 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-files_view_uss-file.html @@ -0,0 +1,163 @@ + + + + +zos-files view uss-file + + +
+

zowezos-filesviewuss-file

+

View content from a Unix System Services (USS) file on your terminal (stdout).

+

Usage

+

zowe zos-files view uss-file <file> [options]

+

Positional Arguments

+
    +
  • +

    file (string)

    +
      +
    • The name of the USS file you want to display.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Transfer the file content in binary mode (no EBCDIC to ASCII conversion).
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • Transfer the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
    • +
    +
  • +
  • +

    --range | -R (string)

    +
      +
    • The range of records to return in either `SSS-EEE` or `SSS,NNN` format. SSS identifies the start record, EEE identifies the end record, and NNN identifies the number of retrieved records.
    • +
    +
  • +
  • +

    --response-timeout | --rto (number)

    +
      +
    • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the contents of the USS file "/a/ibmuser/my_text.txt":

    +
      +
    • zowe zos-files view uss-file "/a/ibmuser/my_text.txt"
    • +
    +
  • +
  • +

    View the contents of the USS file "/a/ibmuser/MyJavaClass.class" in binary mode:

    +
      +
    • zowe zos-files view uss-file "/a/ibmuser/MyJavaClass.class" --binary
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp.html new file mode 100644 index 0000000000..d366653405 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp.html @@ -0,0 +1,29 @@ + + + + +zos-ftp + + +
+

zowezos-ftp

+

Data set and job functionality via FTP. This functionality uses the open source zos-node-accessor package from IBM. Commands under this group require you to create a zftp profile before using them.
+If you find this functionality useful, please consider setting up z/OSMF on your system to get improved stability and speed and more features (for example, issuing TSO and console commands) by using core Zowe CLI.

+

Usage

+

zowe zos-ftp <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • allocate | alloc - Allocate a sequential dataset or partitioned dataset with '--dcb "PDSTYPE=PDS"'
  • +
  • delete | del - Delete data sets, jobs, and USS files
  • +
  • download | dl - Download data set, job spool, and USS file content
  • +
  • list | ls - List data sets, data set members, uss files, jobs, spool files
  • +
  • make | mk - Make a USS directory
  • +
  • rename | mv - Rename data sets and USS files or directories
  • +
  • submit | sub - Submit jobs from local files and data sets
  • +
  • upload | ul - Upload data set and USS content
  • +
  • view | vw - View data set, job output, and USS content
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_allocate.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_allocate.html new file mode 100644 index 0000000000..58c1f1ff13 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_allocate.html @@ -0,0 +1,20 @@ + + + + +zos-ftp allocate + + +
+

zowezos-ftpallocate

+

Allocate a sequential or partitioned dataset

+

Usage

+

zowe zos-ftp allocate <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_allocate_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_allocate_data-set.html new file mode 100644 index 0000000000..a366042da0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_allocate_data-set.html @@ -0,0 +1,156 @@ + + + + +zos-ftp allocate data-set + + +
+

zowezos-ftpallocatedata-set

+

Allocate a sequential dataset or partitioned dataset with '--dcb "PDSTYPE=PDS"'

+

Usage

+

zowe zos-ftp allocate data-set <datasetName> [options]

+

Positional Arguments

+
    +
  • +

    datasetName (string)

    +
      +
    • The dataset name you'd like to allocate.
    • +
    +
  • +
+

Options

+ +

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Allocate a sequential dataset "IBMUSER.DATASET":

    +
      +
    • zowe zos-ftp allocate data-set "IBMUSER.DATASET"
    • +
    +
  • +
  • +

    Allocate a partitioned dataset "IBMUSER.DATASET":

    +
      +
    • zowe zos-ftp allocate data-set "IBMUSER.DATASET" --dcb "PDSTYPE=PDS"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_delete.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_delete.html new file mode 100644 index 0000000000..01184eb7f4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_delete.html @@ -0,0 +1,22 @@ + + + + +zos-ftp delete + + +
+

zowezos-ftpdelete

+

Delete data sets, jobs, and USS files

+

Usage

+

zowe zos-ftp delete <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_delete_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_delete_data-set.html new file mode 100644 index 0000000000..11b4a2acdd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_delete_data-set.html @@ -0,0 +1,150 @@ + + + + +zos-ftp delete data-set + + +
+

zowezos-ftpdeletedata-set

+

Delete a data set

+

Usage

+

zowe zos-ftp delete data-set <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    dataSet (string)

    +
      +
    • The data set (PDS member or physical sequential data set) which you would like to delete.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --for-sure | -f (boolean)

    +
      +
    • Specify this option to confirm that you want to delete the data set permanently.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the data set "ibmuser.cntl":

    +
      +
    • zowe zos-ftp delete data-set "ibmuser.cntl" -f
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_delete_job.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_delete_job.html new file mode 100644 index 0000000000..1768a36544 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_delete_job.html @@ -0,0 +1,141 @@ + + + + +zos-ftp delete job + + +
+

zowezos-ftpdeletejob

+

Cancel a job and purge its output. Note: this command will not work to delete TSU or STC type jobs.

+

Usage

+

zowe zos-ftp delete job <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The ID of the job that you would like to delete
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Cancel the job "JOB00123" and purge its output, optionally abbreviating the job ID:

    +
      +
    • zowe zos-ftp delete job j123
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_delete_uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_delete_uss-file.html new file mode 100644 index 0000000000..f75eb17fe3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_delete_uss-file.html @@ -0,0 +1,159 @@ + + + + +zos-ftp delete uss-file + + +
+

zowezos-ftpdeleteuss-file

+

Delete a USS file

+

Usage

+

zowe zos-ftp delete uss-file <ussFile> [options]

+

Positional Arguments

+
    +
  • +

    ussFile (string)

    +
      +
    • The absolute path to a USS file you would like to delete.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --for-sure | -f (boolean)

    +
      +
    • Specify this option to confirm that you want to delete the data set permanently.
    • +
    +
  • +
+

Options

+
    +
  • +

    --recursive (boolean)

    +
      +
    • Delete the directory and all files/directories under it.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete the USS file "/u/ibmuser/myfile.txt":

    +
      +
    • zowe zos-ftp delete uss-file "/u/ibmuser/myfile.txt" -f
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_download.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_download.html new file mode 100644 index 0000000000..a30741182c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_download.html @@ -0,0 +1,22 @@ + + + + +zos-ftp download + + + + + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_download_all-spool-by-jobid.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_download_all-spool-by-jobid.html new file mode 100644 index 0000000000..42eb2e8051 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_download_all-spool-by-jobid.html @@ -0,0 +1,162 @@ + + + + +zos-ftp download all-spool-by-jobid + + +
+

zowezos-ftpdownloadall-spool-by-jobid

+

Download all spool content for a job to files in a local directory by providing the job id

+

Usage

+

zowe zos-ftp download all-spool-by-jobid <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The ID of the job for which you would like to list spool files
    • +
    +
  • +
+

Options

+
    +
  • +

    --directory | -d (string)

    +
      +
    • The local directory to save the spool content to. By default, it will be saved to "./output".
    • +
    +
  • +
  • +

    --omit-jobid-directory | --ojd (boolean)

    +
      +
    • If you specify this, the job output will be saved directly to the specified (or default) directory. For example, if you omit this, the output would be saved to ./output/JOB00123. If you specify --ojd, the JOB00123 directory would not be included in the output path and the content would be saved to ./output.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download all spool for the job with the ID JOB00123 to the default subdirectory in the current directory:

    +
      +
    • zowe zos-ftp download all-spool-by-jobid j123
    • +
    +
  • +
  • +

    Download all spool for the job with the ID JOB00123 to the directory build/job_output:

    +
      +
    • zowe zos-ftp download all-spool-by-jobid j123 -d build/job_output/
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_download_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_download_data-set.html new file mode 100644 index 0000000000..c2455d7798 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_download_data-set.html @@ -0,0 +1,168 @@ + + + + +zos-ftp download data-set + + +
+

zowezos-ftpdownloaddata-set

+

Download the contents of a z/OS data set to a local file

+

Usage

+

zowe zos-ftp download data-set <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    dataSet (string)

    +
      +
    • The data set (PDS member or physical sequential data set) which you would like to download to a local file.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --file | -f (string)

    +
      +
    • The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
    • +
    +
  • +
  • +

    --record | -r | --rdw (boolean)

    +
      +
    • Download the variable-length data set with RECFM of V, VB, VBS, etc in rdw mode, in which the 4-byte RDW (Record Descriptor Word) is inserted at the begining of each record.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download the data set "ibmuser.loadlib(main)" in binary mode to the local file "main.obj":

    +
      +
    • zowe zos-ftp download data-set "ibmuser.loadlib(main)" -b -f main.obj
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_download_uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_download_uss-file.html new file mode 100644 index 0000000000..f791e00d29 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_download_uss-file.html @@ -0,0 +1,156 @@ + + + + +zos-ftp download uss-file + + +
+

zowezos-ftpdownloaduss-file

+

Download the contents of a USS file to a local file

+

Usage

+

zowe zos-ftp download uss-file <ussFile> [options]

+

Positional Arguments

+
    +
  • +

    ussFile (string)

    +
      +
    • The path to the USS file you would like to download.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
    • +
    +
  • +
  • +

    --file | -f (string)

    +
      +
    • The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download the USS file "/u/users/ibmuser/main.obj" in binary mode to the local file "main.obj":

    +
      +
    • zowe zos-ftp download uss-file "/u/users/ibmuser/main.obj" -b -f main.obj
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_list.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_list.html new file mode 100644 index 0000000000..7f9121dc31 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_list.html @@ -0,0 +1,24 @@ + + + + +zos-ftp list + + + + + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_data-set-members.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_data-set-members.html new file mode 100644 index 0000000000..4fa85878ba --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_data-set-members.html @@ -0,0 +1,169 @@ + + + + +zos-ftp list data-set-members + + +
+

zowezos-ftplistdata-set-members

+

List all members of the specified PDS or PDSE data set.

+

Usage

+

zowe zos-ftp list data-set-members <dsname> [options]

+

Positional Arguments

+
    +
  • +

    dsname (string)

    +
      +
    • The PDS or PDSE data set name.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all members in data set "ibmuser.test.cntl":

    +
      +
    • zowe zos-ftp list data-set-members "ibmuser.test.cntl"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_data-set.html new file mode 100644 index 0000000000..98d1bc5759 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_data-set.html @@ -0,0 +1,174 @@ + + + + +zos-ftp list data-set + + +
+

zowezos-ftplistdata-set

+

List all data sets that match a DSLEVEL pattern (see help below).
+The following values can be used with the --response-format-filter (--rff) argument to display more data from the data sets:volume, unit, referred, ext, used, recfm, lrecl, blksz, dsorg, and dsname.

+

Usage

+

zowe zos-ftp list data-set <pattern> [options]

+

Positional Arguments

+
    +
  • +

    pattern (string)

    +
      +
    • The pattern or patterns to match data sets against. Also known as 'DSLEVEL', it is somewhat similar to the concept of a 'glob' (but not identical). The following special sequences can be used in the pattern:
      +%: Matches any single character
      +*: Matches any number of characters within a data set name qualifier (e.g. "ibmuser.j*.old" matches "ibmuser.jcl.old" but not "ibmuser.jcl.very.old")
      +**: Matches any number of characters within any number of data set name qualifiers (e.g. "ibmuser.**.old" matches both "ibmuser.jcl.old" and "ibmuser.jcl.very.old")
      +However, the pattern cannot begin with any of these sequences.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all data sets beginning with "ibmuser" and ending in "cntl":

    +
      +
    • zowe zos-ftp list data-set "ibmuser.**.cntl"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_jobs.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_jobs.html new file mode 100644 index 0000000000..08d5f4175a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_jobs.html @@ -0,0 +1,188 @@ + + + + +zos-ftp list jobs + + +
+

zowezos-ftplistjobs

+

List all data sets that match a DSLEVEL pattern (see help below).

+

Usage

+

zowe zos-ftp list jobs [options]

+

Options

+
    +
  • +

    --prefix (string)

    +
      +
    • Specify the job name prefix of the jobs you own and want to list. You can specify a wildcard, which is usually in the form "JOB*".
      +If you don't specify this option all jobs under this owner will be listed by default.
    • +
    +
  • +
  • +

    --owner | -o (string)

    +
      +
    • Specify the owner user ID of the jobs you want to list. The owner is the individual/user who submitted the job OR the user ID assigned to the job.
    • +
    +
  • +
  • +

    --status | -s (string)

    +
      +
    • Specify the status of the jobs you want to list. The status is one of the following: INPUT, ACTIVE and OUTPUT.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all jobs with names beginning beginning with "ibmu":

    +
      +
    • zowe zos-ftp list jobs --prefix "ibmu*"
    • +
    +
  • +
  • +

    List Alice's jobs with names beginning beginning with "ibmu":

    +
      +
    • zowe zos-ftp list jobs --prefix "ibmu*" --owner "alice"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_spool-files-by-jobid.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_spool-files-by-jobid.html new file mode 100644 index 0000000000..2c3da2bc94 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_spool-files-by-jobid.html @@ -0,0 +1,169 @@ + + + + +zos-ftp list spool-files-by-jobid + + +
+

zowezos-ftplistspool-files-by-jobid

+

Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the JES/spool queues. The command does not pre-validate the JOBID.

+

Usage

+

zowe zos-ftp list spool-files-by-jobid <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job with the spool files you want to list. No pre-validation of the JOBID is performed.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the spool files of the job with JOBID JOB00123:

    +
      +
    • zowe zos-ftp list spool-files-by-jobid job00123
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_uss-files.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_uss-files.html new file mode 100644 index 0000000000..750b8be19c --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_list_uss-files.html @@ -0,0 +1,182 @@ + + + + +zos-ftp list uss-files + + +
+

zowezos-ftplistuss-files

+

List USS files and subdirectories in a directory. Optional file name pattern like "prefix*", "*suffix", or "prefix*suffix" can be specified at the end of directory. See EXAMPLES section.

+

The following values can be used with the --response-format-filter (--rff) argument to display more data from the data sets: name, size, owner, group, and permissions.

+

Usage

+

zowe zos-ftp list uss-files <directory> [options]

+

Positional Arguments

+
    +
  • +

    directory (string)

    +
      +
    • The USS directory to list files in, or the directory with file name pattern
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List USS files in the directory "/u/users/ibmuser/":

    +
      +
    • zowe zos-ftp list uss-files "/u/users/ibmuser"
    • +
    +
  • +
  • +

    List USS files with suffix of ".txt" in the directory "/u/users/ibmuser/":

    +
      +
    • zowe zos-ftp list uss-files "/u/users/ibmuser/*.txt"
    • +
    +
  • +
  • +

    List USS files in the directory "/u/users/ibmuser/" and show only the file name:

    +
      +
    • zowe zos-ftp list uss-files "/u/users/ibmuser/" --rff name
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_make.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_make.html new file mode 100644 index 0000000000..0822846006 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_make.html @@ -0,0 +1,20 @@ + + + + +zos-ftp make + + +
+

zowezos-ftpmake

+

Make a USS directory

+

Usage

+

zowe zos-ftp make <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_make_uss-directory.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_make_uss-directory.html new file mode 100644 index 0000000000..484d031979 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_make_uss-directory.html @@ -0,0 +1,141 @@ + + + + +zos-ftp make uss-directory + + +
+

zowezos-ftpmakeuss-directory

+

Make a Unix System Services Directory

+

Usage

+

zowe zos-ftp make uss-directory <ussDirectory> [options]

+

Positional Arguments

+
    +
  • +

    ussDirectory (string)

    +
      +
    • The USS directory you'd like to make.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Make a USS directory "/u/users/ibmuser/mydir":

    +
      +
    • zowe zos-ftp make uss-directory "/u/users/ibmuser/mydir"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_rename.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_rename.html new file mode 100644 index 0000000000..047ad01ccb --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_rename.html @@ -0,0 +1,21 @@ + + + + +zos-ftp rename + + +
+

zowezos-ftprename

+

Rename data sets and USS files or directories

+

Usage

+

zowe zos-ftp rename <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_rename_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_rename_data-set.html new file mode 100644 index 0000000000..71d8688df0 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_rename_data-set.html @@ -0,0 +1,153 @@ + + + + +zos-ftp rename data-set + + +
+

zowezos-ftprenamedata-set

+

Rename a cataloged data set

+

Usage

+

zowe zos-ftp rename data-set <oldDataSet> <newDataSet> [options]

+

Positional Arguments

+
    +
  • +

    oldDataSet (string)

    +
      +
    • The current name of the data set you want to rename.
    • +
    +
  • +
  • +

    newDataSet (string)

    +
      +
    • The new name for the data set.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Rename the data set ibmuser.jcl to ibmuser.cntl:

    +
      +
    • zowe zos-ftp rename data-set ibmuser.jcl ibmuser.cntl
    • +
    +
  • +
  • +

    Rename the data set member "ibmuser.cntl(alloc)" to "ibmuser.cntl(alloc2)". Note: you can only rename members within the same partitioned data set. You cannot move a member to another data set with this command.:

    +
      +
    • zowe zos-ftp rename data-set "ibmuser.cntl(alloc)" "ibmuser.cntl(alloc2)"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_rename_uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_rename_uss-file.html new file mode 100644 index 0000000000..2c477b507e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_rename_uss-file.html @@ -0,0 +1,147 @@ + + + + +zos-ftp rename uss-file + + +
+

zowezos-ftprenameuss-file

+

Rename a USS file or directory

+

Usage

+

zowe zos-ftp rename uss-file <olduss> <newuss> [options]

+

Positional Arguments

+
    +
  • +

    olduss (string)

    +
      +
    • The current name of the USS file you want to rename.
    • +
    +
  • +
  • +

    newuss (string)

    +
      +
    • The new name for the USS file.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Rename the file /u/users/ibmuser/hello.txt to /u/users/ibmuser/hello2.txt:

    +
      +
    • zowe zos-ftp rename uss-file "/u/users/ibmuser/hello.txt" "/u/users/ibmuser/hello2.txt"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_submit.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_submit.html new file mode 100644 index 0000000000..5ab7947b3f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_submit.html @@ -0,0 +1,22 @@ + + + + +zos-ftp submit + + +
+

zowezos-ftpsubmit

+

Submit jobs from local files and data sets

+

Usage

+

zowe zos-ftp submit <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_submit_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_submit_data-set.html new file mode 100644 index 0000000000..2bc9798801 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_submit_data-set.html @@ -0,0 +1,202 @@ + + + + +zos-ftp submit data-set + + +
+

zowezos-ftpsubmitdata-set

+

Submit a job from a cataloged data set containing JCL. The JCL will be downloaded via FTP and then submitted.

+

Usage

+

zowe zos-ftp submit data-set <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    dataSet (string)

    +
      +
    • The data set containing JCL that you would like to submit
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait | -w (string)

    +
      +
    • Specify job query interval and max times of querying job status. The format of this option is comma-separated numeric values. For example, '5,12' means queries job status every 5 seconds for 12 times at most.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit a job residing in the data set "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)"
    • +
    +
  • +
  • +

    Submit a job from the data set "ibmuser.cntl(iefbr14)" and print only the job ID:

    +
      +
    • zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)" --rff jobid --rft string
    • +
    +
  • +
  • +

    Submit a job from the data set "ibmuser.cntl(iefbr14)" and wait for job complete.:

    +
      +
    • zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)" --wait 5,12
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_submit_local-file.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_submit_local-file.html new file mode 100644 index 0000000000..079ac7503b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_submit_local-file.html @@ -0,0 +1,202 @@ + + + + +zos-ftp submit local-file + + +
+

zowezos-ftpsubmitlocal-file

+

Submit a job from a local file containing JCL

+

Usage

+

zowe zos-ftp submit local-file <file> [options]

+

Positional Arguments

+
    +
  • +

    file (local file path)

    +
      +
    • The file you would like to submit as jcl
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait | -w (string)

    +
      +
    • Specify job query interval and max times of querying job status. The format of this option is comma-separated numeric values. For example, '5,12' means queries job status every 5 seconds for 12 times at most.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit a job from the local file "my_build_jcl.txt":

    +
      +
    • zowe zos-ftp submit local-file "my_build_jcl.txt"
    • +
    +
  • +
  • +

    Submit a job from the local file "my_build_jcl.txt" and print only the job ID:

    +
      +
    • zowe zos-ftp submit local-file "my_build_jcl.txt" --rff jobid --rft string
    • +
    +
  • +
  • +

    Submit a job from the local file "my_build_jcl.txt" and wait for job complete.:

    +
      +
    • zowe zos-ftp submit local-file "my_build_jcl.txt" --wait 5,12
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_submit_stdin.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_submit_stdin.html new file mode 100644 index 0000000000..898152c7a4 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_submit_stdin.html @@ -0,0 +1,187 @@ + + + + +zos-ftp submit stdin + + +
+

zowezos-ftpsubmitstdin

+

Submit a job from JCL written to the standard input (stdin) of this process.

+

Usage

+

zowe zos-ftp submit stdin [options]

+

Options

+
    +
  • +

    --wait | -w (string)

    +
      +
    • Specify job query interval and max times of querying job status. The format of this option is comma-separated numeric values. For example, '5,12' means queries job status every 5 seconds for 12 times at most.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit a job from stdin, redirecting the contents of my_jcl.txt in.:

    +
      +
    • zowe zos-ftp submit stdin < my_jcl.txt
    • +
    +
  • +
  • +

    Submit a job from the local file "my_build_jcl.txt" and wait for job complete.:

    +
      +
    • zowe zos-ftp submit stdin "my_build_jcl.txt" --wait 5,12
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload.html new file mode 100644 index 0000000000..086f64fbe1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload.html @@ -0,0 +1,23 @@ + + + + +zos-ftp upload + + + + + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload_file-to-data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload_file-to-data-set.html new file mode 100644 index 0000000000..92fcd0ad18 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload_file-to-data-set.html @@ -0,0 +1,174 @@ + + + + +zos-ftp upload file-to-data-set + + +
+

zowezos-ftpuploadfile-to-data-set

+

Upload contents of a local file to a z/OS data set

+

Usage

+

zowe zos-ftp upload file-to-data-set <file> <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    file (local file path)

    +
      +
    • Upload the contents of this file to the data set
    • +
    +
  • +
  • +

    dataSet (string)

    +
      +
    • The data set (PDS member or physical sequential data set) to which you would like to upload content.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Upload content in binary mode.
    • +
    +
  • +
  • +

    --dcb (string)

    +
      +
    • DCB parameters for sequential dataset (PS dataset) allocation if not existing. It is space separated like RECFM=FB LRECL=326 BLKSIZE=23472
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload to "ibmuser.cntl(iefbr14)" from the file iefbr14.txt:

    +
      +
    • zowe zos-ftp upload file-to-data-set iefbr14.txt "ibmuser.cntl(iefbr14)"
    • +
    +
  • +
  • +

    Upload to "ibmuser.dataset" from the file dataset.txt with the DCB parameters:

    +
      +
    • zowe zos-ftp upload file-to-data-set dataset.txt "ibmuser.dataset" --dcb "RECFM=FB LRECL=326 BLKSIZE=23472"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload_file-to-uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload_file-to-uss-file.html new file mode 100644 index 0000000000..0d2e7fde47 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload_file-to-uss-file.html @@ -0,0 +1,156 @@ + + + + +zos-ftp upload file-to-uss-file + + +
+

zowezos-ftpuploadfile-to-uss-file

+

Upload contents of a local to a Unix System Services file.

+

Usage

+

zowe zos-ftp upload file-to-uss-file <file> <ussFile> [options]

+

Positional Arguments

+
    +
  • +

    file (local file path)

    +
      +
    • Upload the contents of this local file to a data set.
    • +
    +
  • +
  • +

    ussFile (string)

    +
      +
    • The USS file to which you would like to upload content.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Upload content in binary mode.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload to "/u/users/ibmuser/iefbr14.txt" from the file iefbr14.txt:

    +
      +
    • zowe zos-ftp upload file-to-uss-file iefbr14.txt "/u/users/ibmuser/iefbr14.txt"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload_stdin-to-data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload_stdin-to-data-set.html new file mode 100644 index 0000000000..da2636a323 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload_stdin-to-data-set.html @@ -0,0 +1,156 @@ + + + + +zos-ftp upload stdin-to-data-set + + +
+

zowezos-ftpuploadstdin-to-data-set

+

Upload contents piped to stdin to a z/OS data set

+

Usage

+

zowe zos-ftp upload stdin-to-data-set <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    dataSet (string)

    +
      +
    • The data set (PDS member or physical sequential data set) to which you would like to upload content.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Upload content in binary mode.
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload to "ibmuser.cntl(iefbr14)" from standard input (you can pipe into this command):

    +
      +
    • zowe zos-ftp upload stdin-to-data-set "ibmuser.cntl(iefbr14)"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload_stdin-to-uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload_stdin-to-uss-file.html new file mode 100644 index 0000000000..877e7ea862 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_upload_stdin-to-uss-file.html @@ -0,0 +1,150 @@ + + + + +zos-ftp upload stdin-to-uss-file + + +
+

zowezos-ftpuploadstdin-to-uss-file

+

Upload from stdin to a Unix System Services File

+

Usage

+

zowe zos-ftp upload stdin-to-uss-file <ussFile> [options]

+

Positional Arguments

+
    +
  • +

    ussFile (string)

    +
      +
    • The USS file to which you would like to upload content.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • Upload content in binary mode.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Upload to "/u/users/ibmuser/iefbr14.txt" from standard input (you can pipe into this command):

    +
      +
    • zowe zos-ftp upload stdin-to-uss-file "/u/users/ibmuser/iefbr14.txt"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_view.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_view.html new file mode 100644 index 0000000000..2fa0eb9556 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_view.html @@ -0,0 +1,24 @@ + + + + +zos-ftp view + + + + + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_all-spool-by-jobid.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_all-spool-by-jobid.html new file mode 100644 index 0000000000..c306eb0d01 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_all-spool-by-jobid.html @@ -0,0 +1,141 @@ + + + + +zos-ftp view all-spool-by-jobid + + +
+

zowezos-ftpviewall-spool-by-jobid

+

View all spool content for a job by providing the job id

+

Usage

+

zowe zos-ftp view all-spool-by-jobid <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The ID of the job for which you would like to list spool files
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    View all spool content for the job with ID JOB00123 (optionally abbreviating the job ID):

    +
      +
    • zowe zos-ftp view all-spool-by-jobid j123
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_data-set.html new file mode 100644 index 0000000000..72ca7f33b1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_data-set.html @@ -0,0 +1,162 @@ + + + + +zos-ftp view data-set + + +
+

zowezos-ftpviewdata-set

+

View the contents of a z/OS data set

+

Usage

+

zowe zos-ftp view data-set <dataSet> [options]

+

Positional Arguments

+
    +
  • +

    dataSet (string)

    +
      +
    • The data set (PDS member or physical sequential data set) which you would like to view the contents of.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • View content in binary form without converting to ASCII text
    • +
    +
  • +
  • +

    --encoding | --ec (string)

    +
      +
    • The encoding for download and upload of z/OS data set.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the content of the data set "ibmuser.cntl(iefbr14)":

    +
      +
    • zowe zos-ftp view data-set "ibmuser.cntl(iefbr14)"
    • +
    +
  • +
  • +

    View the content of the data set "ibmuser.loadlib(main)" and pipe it into the hex viewer program xxd:

    +
      +
    • zowe zos-ftp view data-set "ibmuser.loadlib(main)" -b | xxd
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_job-status-by-jobid.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_job-status-by-jobid.html new file mode 100644 index 0000000000..7b444b4f0e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_job-status-by-jobid.html @@ -0,0 +1,169 @@ + + + + +zos-ftp view job-status-by-jobid + + +
+

zowezos-ftpviewjob-status-by-jobid

+

View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID.

+

Usage

+

zowe zos-ftp view job-status-by-jobid <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The ID of the jobfor which you would like to list spool files
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the status for the job with ID "JOB00123" (optionally abbreviating the ID):

    +
      +
    • zowe zos-ftp view job-status-by-jobid j123
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_spool-file-by-id.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_spool-file-by-id.html new file mode 100644 index 0000000000..e790d25ccb --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_spool-file-by-id.html @@ -0,0 +1,147 @@ + + + + +zos-ftp view spool-file-by-id + + +
+

zowezos-ftpviewspool-file-by-id

+

View the contents of a spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID or spool ID.

+

Usage

+

zowe zos-ftp view spool-file-by-id <jobid> <spoolfileid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job containing the spool file you want to view. No pre-validation of the JOBID is performed.
    • +
    +
  • +
  • +

    spoolfileid (number)

    +
      +
    • The spool file ID number for the spool file to view. No pre-validation of the ID is performed.
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the spool file with ID 4 for the job with job ID JOB00123:

    +
      +
    • zowe zos-ftp view spool-file-by-id JOB00123 4
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_uss-file.html new file mode 100644 index 0000000000..3cf1b5b6ce --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ftp_view_uss-file.html @@ -0,0 +1,156 @@ + + + + +zos-ftp view uss-file + + +
+

zowezos-ftpviewuss-file

+

View the contents of a Unix System Services File

+

Usage

+

zowe zos-ftp view uss-file <ussFile> [options]

+

Positional Arguments

+
    +
  • +

    ussFile (string)

    +
      +
    • The USS file you'd like to view the contents of.
    • +
    +
  • +
+

Options

+
    +
  • +

    --binary | -b (boolean)

    +
      +
    • View content in binary form without converting to ASCII text
    • +
    +
  • +
+

FTP Connection options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The hostname or IP address of the z/OS server to connect to.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The port of the z/OS FTP server.

      +

      Default value: 21

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Username for authentication on z/OS
    • +
    +
  • +
  • +

    --password | -p | --pass | --pw (string)

    +
      +
    • Password to authenticate to FTP.
    • +
    +
  • +
  • +

    --secure-ftp (boolean)

    +
      +
    • +

      Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --connection-timeout | --ct (number)

    +
      +
    • +

      How long (in milliseconds) to wait for the control connection to be established.

      +

      Default value: 10000

      +
    • +
    +
  • +
+

TLS / Secure Connection options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.
    • +
    +
  • +
  • +

    --server-name | --sn (string)

    +
      +
    • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zftp-profile | --zftp-p (string)

    +
      +
    • The name of a (zftp) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the content of the USS file "/u/users/ibmuser/myfile.txt":

    +
      +
    • zowe zos-ftp view uss-file "/u/users/ibmuser/myfile.txt"
    • +
    +
  • +
  • +

    View the content of the USS file "/u/users/ibmuser/myjava.jar" in binary mode and pipe it into the hex viewer command xxd:

    +
      +
    • zowe zos-ftp view uss-file "/u/users/ibmuser/myjava.jar" -b | xxd
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs.html new file mode 100644 index 0000000000..a3f45713d3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs.html @@ -0,0 +1,26 @@ + + + + +zos-jobs + + + + + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_cancel.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_cancel.html new file mode 100644 index 0000000000..52f7785077 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_cancel.html @@ -0,0 +1,20 @@ + + + + +zos-jobs cancel + + +
+

zowezos-jobscancel

+

Cancel a single job by job ID. This cancels the job if it is running or on input.

+

Usage

+

zowe zos-jobs cancel <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • job - Cancel a single job by job ID
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_cancel_job.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_cancel_job.html new file mode 100644 index 0000000000..c271eb47ef --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_cancel_job.html @@ -0,0 +1,148 @@ + + + + +zos-jobs cancel job + + +
+

zowezos-jobscanceljob

+

Cancel a single job by job ID

+

Usage

+

zowe zos-jobs cancel job <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
    • +
    +
  • +
+

Options

+
    +
  • +

    --modify-version (string)

    +
      +
    • +

      Using this option to set X-IBM-Job-Modify-Version to "1.0" will make the delete job API aynchronous. Otherwise, it will be synchronous by default.

      +

      Default value: 2.0

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Cancel job with job ID JOB03456:

    +
      +
    • zowe zos-jobs cancel job JOB03456
    • +
    +
  • +
  • +

    Cancel job with job ID JOB03456 synchronously:

    +
      +
    • zowe zos-jobs cancel job JOB03456 --modify-version "2.0"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_delete.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_delete.html new file mode 100644 index 0000000000..20f5d5ff02 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_delete.html @@ -0,0 +1,21 @@ + + + + +zos-jobs delete + + +
+

zowezos-jobsdelete

+

Delete a single job by job ID or delete multiple jobs in OUTPUT status.

+

Usage

+

zowe zos-jobs delete <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • job - Delete a single job by job ID
  • +
  • old-jobs | oj - Delete multiple jobs in OUTPUT status
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_delete_job.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_delete_job.html new file mode 100644 index 0000000000..829ca19824 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_delete_job.html @@ -0,0 +1,148 @@ + + + + +zos-jobs delete job + + +
+

zowezos-jobsdeletejob

+

Delete a single job by job ID

+

Usage

+

zowe zos-jobs delete job <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
    • +
    +
  • +
+

Options

+
    +
  • +

    --modify-version (string)

    +
      +
    • +

      Using this option to set X-IBM-Job-Modify-Version to "1.0" will make the delete job API aynchronous. Otherwise, it will be synchronous by default.

      +

      Default value: 2.0

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete job with job ID JOB03456:

    +
      +
    • zowe zos-jobs delete job JOB03456
    • +
    +
  • +
  • +

    Delete job with job ID JOB03456 synchronously:

    +
      +
    • zowe zos-jobs delete job JOB03456 --modify-version "2.0"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_delete_old-jobs.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_delete_old-jobs.html new file mode 100644 index 0000000000..9616260356 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_delete_old-jobs.html @@ -0,0 +1,148 @@ + + + + +zos-jobs delete old-jobs + + +
+

zowezos-jobsdeleteold-jobs

+

Delete (purge) jobs in OUTPUT status. Defaults to deleting all jobs owned by your user ID that are in output status.

+

Usage

+

zowe zos-jobs delete old-jobs [options]

+

Options

+
    +
  • +

    --prefix | -p (string)

    +
      +
    • Only delete jobs with job names that match this prefix. Defaults to deleting all jobs owned by your user ID that are in output status.
    • +
    +
  • +
  • +

    --max-concurrent-requests | --mcr (number)

    +
      +
    • +

      Specifies the maximum number of concurrent z/OSMF REST API requests to delete jobs. Increasing the value makes the command run faster. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. When you specify 0, Zowe CLI attempts to delete all jobs at once without a maximum number of concurrent requests.

      +

      Default value: 1

      +
    • +
    +
  • +
  • +

    --modify-version (string)

    +
      +
    • +

      Using this option to set X-IBM-Job-Modify-Version to "1.0" will make the delete job API aynchronous. Otherwise, it will be synchronous by default.

      +

      Default value: 2.0

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Delete all of your jobs in output status with a job name starting with "ibmuser":

    +
      +
    • zowe zos-jobs delete old-jobs -p "ibmuser*"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_download.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_download.html new file mode 100644 index 0000000000..4d09087195 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_download.html @@ -0,0 +1,20 @@ + + + + +zos-jobs download + + +
+

zowezos-jobsdownload

+

Download the output of a job as separate files.

+

Usage

+

zowe zos-jobs download <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • output | o - Download all job output to a directory
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_download_output.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_download_output.html new file mode 100644 index 0000000000..5d9e8a354a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_download_output.html @@ -0,0 +1,163 @@ + + + + +zos-jobs download output + + +
+

zowezos-jobsdownloadoutput

+

Download all job output to a local directory. Each spool DD will be downloaded to its own file in the directory.

+

Usage

+

zowe zos-jobs download output <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.
    • +
    +
  • +
+

Options

+
    +
  • +

    --directory | -d | --dir (string)

    +
      +
    • The local directory you would like to download the output for the job to.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • A file extension to save the job output with. Defaults to '.txt'.
    • +
    +
  • +
  • +

    --omit-jobid-directory | --ojd (boolean)

    +
      +
    • If specified, job output will be saved directly to the specified directory rather than creating a subdirectory named after the ID of the job.
    • +
    +
  • +
  • +

    --binary | -b (boolean)

    +
      +
    • If specified, job output will be downloaded in binary format instead of performing text conversion. Conflicts with record.
    • +
    +
  • +
  • +

    --record | -r (boolean)

    +
      +
    • If specified, job output will be downloaded in record format instead of performing text conversion. Conflicts with binary.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Download all the output of the job with job ID JOB00234 to an automatically generated directory.:

    +
      +
    • zowe zos-jobs download output JOB00234
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_list.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_list.html new file mode 100644 index 0000000000..f8f3c26fbd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_list.html @@ -0,0 +1,21 @@ + + + + +zos-jobs list + + +
+

zowezos-jobslist

+

List z/OS jobs and list the spool files (DDs) for a z/OS job on the JES/spool queues.

+

Usage

+

zowe zos-jobs list <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_list_jobs.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_list_jobs.html new file mode 100644 index 0000000000..eb5edb3abf --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_list_jobs.html @@ -0,0 +1,200 @@ + + + + +zos-jobs list jobs + + +
+

zowezos-jobslistjobs

+

List jobs on JES spool/queues. By default, the command lists jobs owned (owner) by the user specified in your z/OSMF profile. The default for prefix is "*". The command does not prevalidate your user ID. The command surfaces errors verbatim from the z/OSMF Jobs REST endpoints.

+

Usage

+

zowe zos-jobs list jobs [options]

+

Options

+
    +
  • +

    --owner | -o (string)

    +
      +
    • Specify the owner of the jobs you want to list. The owner is the individual/user who submitted the job OR the user ID assigned to the job. The command does not prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs REST endpoint documentation, which is usually in the form "USER*".
    • +
    +
  • +
  • +

    --prefix | -p (string)

    +
      +
    • Specify the job name prefix of the jobs you want to list. The command does not prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs REST endpoint documentation, which is usually in the form "JOB*".
    • +
    +
  • +
  • +

    --exec-data | --ed (boolean)

    +
      +
    • Use this option to retrieve execution data for jobs via the z/OSMF REST API.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List all jobs with default settings. The command returns jobs owned by your user ID with any job name:

    +
      +
    • zowe zos-jobs list jobs
    • +
    +
  • +
  • +

    List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo':

    +
      +
    • zowe zos-jobs list jobs -o "ibmu*" -p "myjo*"
    • +
    +
  • +
  • +

    List all jobs with default owner and prefix settings, displaying only the job ID of each job:

    +
      +
    • zowe zos-jobs list jobs --rff jobid --rft table
    • +
    +
  • +
  • +

    List all jobs and return job execution data along with the default information:

    +
      +
    • zowe zos-jobs list jobs --exec-data
    • +
    +
  • +
  • +

    List all jobs owned by user IDs starting with 'ibmu' and return job execution data along with the default information:

    +
      +
    • zowe zos-jobs list jobs -o "ibmu*" --exec-data
    • +
    +
  • +
  • +

    List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo' and return job execution data along with the default information:

    +
      +
    • zowe zos-jobs list jobs -o "ibmu*" -p "myjo*" --exec-data
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_list_spool-files-by-jobid.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_list_spool-files-by-jobid.html new file mode 100644 index 0000000000..7529717628 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_list_spool-files-by-jobid.html @@ -0,0 +1,158 @@ + + + + +zos-jobs list spool-files-by-jobid + + +
+

zowezos-jobslistspool-files-by-jobid

+

Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the JES/spool queues. The command does not pre-validate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.

+

Usage

+

zowe zos-jobs list spool-files-by-jobid <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job with the spool files you want to list. No pre-validation of the JOBID is performed.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the spool files of the job with JOBID JOB00123:

    +
      +
    • zowe zos-jobs list spool-files-by-jobid job00123
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_modify.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_modify.html new file mode 100644 index 0000000000..ea970b369a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_modify.html @@ -0,0 +1,20 @@ + + + + +zos-jobs modify + + +
+

zowezos-jobsmodify

+

Modify the job class or the hold status of a job.

+

Usage

+

zowe zos-jobs modify <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • job - Modify the job class or the hold status of a job
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_modify_job.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_modify_job.html new file mode 100644 index 0000000000..7edd57b04d --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_modify_job.html @@ -0,0 +1,163 @@ + + + + +zos-jobs modify job + + +
+

zowezos-jobsmodifyjob

+

Modify the job class or the hold status of a job.

+

Usage

+

zowe zos-jobs modify job <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
    • +
    +
  • +
+

Options

+
    +
  • +

    --jobclass (string)

    +
      +
    • The job class (e.g. 'A', 'B', ...) assigned to the job.
    • +
    +
  • +
  • +

    --hold (boolean)

    +
      +
    • Setting this flag will prevent a job from executing until entering a second command with the '--release' flag
    • +
    +
  • +
  • +

    --release (boolean)

    +
      +
    • Flag that releases a held a job for execution
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Modify class of job with job ID JOB0000:

    +
      +
    • zowe zos-jobs modify job JOB0000 --jobclass A
    • +
    +
  • +
  • +

    Hold job with job ID JOB0000:

    +
      +
    • zowe zos-jobs modify job JOB0000 --hold
    • +
    +
  • +
  • +

    Release job with job ID JOB0000:

    +
      +
    • zowe zos-jobs modify job JOB0000 --release
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit.html new file mode 100644 index 0000000000..874483f750 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit.html @@ -0,0 +1,23 @@ + + + + +zos-jobs submit + + +
+

zowezos-jobssubmit

+

Submit a job (JCL).

+

Usage

+

zowe zos-jobs submit <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit_data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit_data-set.html new file mode 100644 index 0000000000..f3c2d011a7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit_data-set.html @@ -0,0 +1,209 @@ + + + + +zos-jobs submit data-set + + +
+

zowezos-jobssubmitdata-set

+

Submit a job (JCL) contained in a data set. The data set may be of type physical sequential or a PDS member. The command does not pre-validate the data set name. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.

+

Usage

+

zowe zos-jobs submit data-set <dataset> [options]

+

Positional Arguments

+
    +
  • +

    dataset (string)

    +
      +
    • The z/OS data set containing the JCL to submit. You can specify a physical sequential data set (for example, "DATA.SET") or a partitioned data set qualified by a member (for example, "DATA.SET(MEMBER)").
    • +
    +
  • +
+

Options

+
    +
  • +

    --volume | --vol (string)

    +
      +
    • The volume serial (VOLSER) where the data set resides. The option is required only when the data set is not catalogued on the system.
    • +
    +
  • +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --view-all-spool-content | --vasc (boolean)

    +
      +
    • Print all spool output. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • A file extension to save the job output with. Default is '.txt'.
    • +
    +
  • +
  • +

    --jcl-symbols | --js (string)

    +
      +
    • A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit the JCL in the data set "ibmuser.cntl(deploy)":

    +
      +
    • zowe zos-jobs submit data-set "ibmuser.cntl(deploy)"
    • +
    +
  • +
  • +

    Submit the JCL in the data set "ibmuser.cntl(deploy)", wait for the job to complete and print all output from the job:

    +
      +
    • zowe zos-jobs submit data-set "ibmuser.cntl(deploy)" --vasc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit_local-file.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit_local-file.html new file mode 100644 index 0000000000..3100a9f9c1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit_local-file.html @@ -0,0 +1,197 @@ + + + + +zos-jobs submit local-file + + +
+

zowezos-jobssubmitlocal-file

+

Submit a job (JCL) contained in a local file. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.

+

Usage

+

zowe zos-jobs submit local-file <localFile> [options]

+

Positional Arguments

+
    +
  • +

    localFile (string)

    +
      +
    • The local file containing the JCL to submit.
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --view-all-spool-content | --vasc (boolean)

    +
      +
    • Print all spool output. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • A file extension to save the job output with. Default is '.txt'.
    • +
    +
  • +
  • +

    --jcl-symbols | --js (string)

    +
      +
    • A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit the JCL in the file "iefbr14.txt":

    +
      +
    • zowe zos-jobs submit local-file "iefbr14.txt"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit_stdin.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit_stdin.html new file mode 100644 index 0000000000..df74aa2235 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit_stdin.html @@ -0,0 +1,194 @@ + + + + +zos-jobs submit stdin + + +
+

zowezos-jobssubmitstdin

+

Submit a job (JCL) passed to the command via the stdin stream. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.

+

Usage

+

zowe zos-jobs submit stdin [options]

+

Options

+
    +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --view-all-spool-content | --vasc (boolean)

    +
      +
    • Print all spool output. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • A file extension to save the job output with. Default is '.txt'.
    • +
    +
  • +
  • +

    --jcl-symbols | --js (string)

    +
      +
    • A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit the JCL in the file "iefbr14.txt" via standard in:

    +
      +
    • zowe zos-jobs submit stdin < iefbr14.txt
    • +
    +
  • +
  • +

    Submit the JCL in the file "iefbr14.txt" via standard in from the output of another command:

    +
      +
    • cat iefbr14.txt | zowe zos-jobs submit stdin
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit_uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit_uss-file.html new file mode 100644 index 0000000000..2d53c2a597 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_submit_uss-file.html @@ -0,0 +1,203 @@ + + + + +zos-jobs submit uss-file + + +
+

zowezos-jobssubmituss-file

+

Submit a job (JCL) contained in a USS file. The command does not pre-validate the USS file path. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.

+

Usage

+

zowe zos-jobs submit uss-file <file> [options]

+

Positional Arguments

+
    +
  • +

    file (string)

    +
      +
    • Path to the USS file that contains the JCL to submit.
    • +
    +
  • +
+

Options

+
    +
  • +

    --wait-for-active | --wfa (boolean)

    +
      +
    • Wait for the job to enter ACTIVE status before completing the command.
    • +
    +
  • +
  • +

    --wait-for-output | --wfo (boolean)

    +
      +
    • Wait for the job to enter OUTPUT status before completing the command.
    • +
    +
  • +
  • +

    --view-all-spool-content | --vasc (boolean)

    +
      +
    • Print all spool output. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --directory | -d (string)

    +
      +
    • The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
    • +
    +
  • +
  • +

    --extension | -e (string)

    +
      +
    • A file extension to save the job output with. Default is '.txt'.
    • +
    +
  • +
  • +

    --jcl-symbols | --js (string)

    +
      +
    • A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Submit the JCL in the USS file "/a/ibmuser/compile.jcl":

    +
      +
    • zowe zos-jobs submit uss-file "/a/ibmuser/compile.jcl"
    • +
    +
  • +
  • +

    Submit the JCL in the USS file "/a/ibmuser/compile.jcl", wait for the job to complete and print all output from the job:

    +
      +
    • zowe zos-jobs submit uss-file "/a/ibmuser/compile.jcl" --vasc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_view.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_view.html new file mode 100644 index 0000000000..25159b906e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_view.html @@ -0,0 +1,22 @@ + + + + +zos-jobs view + + + + + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_view_all-spool-content.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_view_all-spool-content.html new file mode 100644 index 0000000000..57cb8d4b04 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_view_all-spool-content.html @@ -0,0 +1,130 @@ + + + + +zos-jobs view all-spool-content + + +
+

zowezos-jobsviewall-spool-content

+

View the contents of each spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.

+

Usage

+

zowe zos-jobs view all-spool-content <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    View all spool files for the job with job ID JOB00234:

    +
      +
    • zowe zos-jobs view all-spool-content JOB00234
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_view_job-status-by-jobid.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_view_job-status-by-jobid.html new file mode 100644 index 0000000000..16529d3083 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_view_job-status-by-jobid.html @@ -0,0 +1,164 @@ + + + + +zos-jobs view job-status-by-jobid + + +
+

zowezos-jobsviewjob-status-by-jobid

+

View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints (expect for "no jobs found").

+

Usage

+

zowe zos-jobs view job-status-by-jobid <jobid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job you want to view. No prevalidation of the JOBID is performed.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    View status and other details of the job with the job ID JOB00123:

    +
      +
    • zowe zos-jobs view job-status-by-jobid j123
    • +
    +
  • +
  • +

    Print only the status (for example, "OUTPUT" or "ACTIVE") of the job with the job ID JOB00123:

    +
      +
    • zowe zos-jobs view job-status-by-jobid j123 --rff status --rft string
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-jobs_view_spool-file-by-id.html b/static/v2.15.x/web_help/docs/zowe_zos-jobs_view_spool-file-by-id.html new file mode 100644 index 0000000000..75f933f890 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-jobs_view_spool-file-by-id.html @@ -0,0 +1,136 @@ + + + + +zos-jobs view spool-file-by-id + + +
+

zowezos-jobsviewspool-file-by-id

+

View the contents of a spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID or spool ID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.

+

Usage

+

zowe zos-jobs view spool-file-by-id <jobid> <spoolfileid> [options]

+

Positional Arguments

+
    +
  • +

    jobid (string)

    +
      +
    • The z/OS JOBID of the job containing the spool file you want to view. No pre-validation of the JOBID is performed.
    • +
    +
  • +
  • +

    spoolfileid (number)

    +
      +
    • The spool file ID number for the spool file to view. Use the "zowe zos-jobs list spool-files-by-jobid" command to obtain spool ID numbers.No pre-validation of the ID is performed.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    View the spool file with ID 4 for the job with job ID JOB00123:

    +
      +
    • zowe zos-jobs view spool-file-by-id JOB00123 4
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-logs.html b/static/v2.15.x/web_help/docs/zowe_zos-logs.html new file mode 100644 index 0000000000..2281a0f1f9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-logs.html @@ -0,0 +1,20 @@ + + + + +zos-logs + + +
+

zowezos-logs

+

Interact with z/OS logs.

+

Usage

+

zowe zos-logs <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-logs_list.html b/static/v2.15.x/web_help/docs/zowe_zos-logs_list.html new file mode 100644 index 0000000000..ecaca15998 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-logs_list.html @@ -0,0 +1,20 @@ + + + + +zos-logs list + + +
+

zowezos-logslist

+

List z/OS logs by invoking z/OSMF REST API.

+

Usage

+

zowe zos-logs list <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • logs - List z/OS operlog or syslog within a time range
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-logs_list_logs.html b/static/v2.15.x/web_help/docs/zowe_zos-logs_list_logs.html new file mode 100644 index 0000000000..466ab3de50 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-logs_list_logs.html @@ -0,0 +1,164 @@ + + + + +zos-logs list logs + + +
+

zowezos-logslistlogs

+

List z/OS operlog within a time range.

+

Use this operation to get the z/OS operations logs. It invokes z/OSMF REST API to retrieve logs.

+

Executing 'zowe zos-logs list logs' will by default return logs from current time and backwards to 10 minutes before.

+

Note: OPERLOG needs to be configured on z/OS server.

+

Usage

+

zowe zos-logs list logs [options]

+

Options

+
    +
  • +

    --start-time | --st (string)

    +
      +
    • Specify the time in ISO-8601 time format from when z/OSMF will start to retrieve the logs. For example, '2021-01-26T03:33:18.065Z', '2021-01-26T11:33:18.065+08:00'. Default is the current time.
    • +
    +
  • +
  • +

    --direction | -d (string)

    +
      +
    • +

      Specify the direction when retrieving the message log. Either 'forward' or 'backward' is valid, case insensitive.

      +

      Default value: backward
      +Allowed values: forward, backward

      +
    • +
    +
  • +
  • +

    --range | -r (string)

    +
      +
    • +

      Specify a time range in which the logs will be retrieved. The format is like nnnu, nnn is 1-999, u is one of 's', 'm', 'h', for example, '999s', '20m', '3h'.

      +

      Default value: 10m

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List logs starting from '2021-07-26T03:38:37.098Z' and forwards to 5 minutes later:

    +
      +
    • zowe zos-logs list logs --start-time 2021-07-26T03:38:37.098Z --range 5m --direction forward
    • +
    +
  • +
  • +

    List logs starting from '2021-07-26T03:38:37.098Z' and forwards to 5 minutes later. Alias version of the above command:

    +
      +
    • zowe zos-logs list logs --st 2021-07-26T03:38:37.098Z -r 5m -d forward
    • +
    +
  • +
  • +

    List logs starting from '2021-07-26T03:38:37.098Z' and backwards to 5 minutes before:

    +
      +
    • zowe zos-logs list logs --start-time 2021-07-26T03:38:37.098Z --range 5m
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ssh.html b/static/v2.15.x/web_help/docs/zowe_zos-ssh.html new file mode 100644 index 0000000000..859bbfc426 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ssh.html @@ -0,0 +1,20 @@ + + + + +zos-ssh + + +
+

zowezos-ssh

+

Issue z/OS USS commands remotely using an SSH session. Output from the commands is displayed on the local terminal.

+

Usage

+

zowe zos-ssh <group>

+

Where <group> is one of the following:

+

Groups

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ssh_issue.html b/static/v2.15.x/web_help/docs/zowe_zos-ssh_issue.html new file mode 100644 index 0000000000..68df547381 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ssh_issue.html @@ -0,0 +1,20 @@ + + + + +zos-ssh issue + + +
+

zowezos-sshissue

+

Issue a z/OS USS command.

+

Usage

+

zowe zos-ssh issue <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • command | cmd | ssh - Issue a z/OS USS command Note: The common CLI 'Base Connection Options' of token-type and token-value are not applicable to the ssh command, since the ssh service is not accessible through APIML.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-ssh_issue_command.html b/static/v2.15.x/web_help/docs/zowe_zos-ssh_issue_command.html new file mode 100644 index 0000000000..6a82b23df3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-ssh_issue_command.html @@ -0,0 +1,145 @@ + + + + +zos-ssh issue command + + +
+

zowezos-sshissuecommand

+

Issue a z/OS USS command

+

Note: The common CLI 'Base Connection Options' of token-type and token-value are not applicable to the ssh command, since the ssh service is not accessible through APIML.

+

Usage

+

zowe zos-ssh issue command <command> [options]

+

Positional Arguments

+
    +
  • +

    command (string)

    +
      +
    • z/OS USS command to issue
    • +
    +
  • +
+

Options

+
    +
  • +

    --cwd (string)

    +
      +
    • Working directory in which to execute the command
    • +
    +
  • +
+

z/OS Ssh Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OS SSH server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OS SSH server port.

      +

      Default value: 22

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --privateKey | --key | --pk (string)

    +
      +
    • Path to a file containing your private key, that must match a public key stored in the server for authentication
    • +
    +
  • +
  • +

    --keyPassphrase | --passphrase | --kp (string)

    +
      +
    • Private key passphrase, which unlocks the private key.
    • +
    +
  • +
  • +

    --handshakeTimeout | --timeout | --to (number)

    +
      +
    • How long in milliseconds to wait for the SSH handshake to complete.
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --ssh-profile | --ssh-p (string)

    +
      +
    • The name of a (ssh) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • +

      The file path to a certificate file to use for authentication.

      +

      Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

      +
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issue a simple command, giving the working directory:

    +
      +
    • zowe zos-ssh issue command "npm install express" --cwd /u/cicprov/mnt/CICPY01I/bundles/myapp 
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-tso.html b/static/v2.15.x/web_help/docs/zowe_zos-tso.html new file mode 100644 index 0000000000..79a09b68bd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-tso.html @@ -0,0 +1,24 @@ + + + + +zos-tso + + +
+

zowezos-tso

+

Issue TSO commands and interact with TSO address spaces.

+

Usage

+

zowe zos-tso <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • issue - Issue TSO commands
  • +
  • ping - Ping a TSO address space
  • +
  • send - Send data to TSO
  • +
  • start | st - Start TSO/E address space
  • +
  • stop | sp - Stop TSO/E address space
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-tso_issue.html b/static/v2.15.x/web_help/docs/zowe_zos-tso_issue.html new file mode 100644 index 0000000000..0f51046cf1 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-tso_issue.html @@ -0,0 +1,20 @@ + + + + +zos-tso issue + + +
+

zowezos-tsoissue

+

Issue TSO commands.

+

Usage

+

zowe zos-tso issue <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-tso_issue_command.html b/static/v2.15.x/web_help/docs/zowe_zos-tso_issue_command.html new file mode 100644 index 0000000000..0621cdb32b --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-tso_issue_command.html @@ -0,0 +1,208 @@ + + + + +zos-tso issue command + + +
+

zowezos-tsoissuecommand

+

Creates a TSO address space, issues a TSO command through the newly created address space, waits for the READY prompt to print the response, and terminates the TSO address space. All response data are returned to the user up to (but not including) the TSO 'READY' prompt.

+

Usage

+

zowe zos-tso issue command <commandText> [options]

+

Positional Arguments

+
    +
  • +

    commandText (string)

    +
      +
    • The TSO command to issue.
    • +
    +
  • +
+

Options

+
    +
  • +

    --suppress-startup-messages | --ssm (boolean)

    +
      +
    • Suppress console messages from start of address space.
    • +
    +
  • +
+

TSO ADDRESS SPACE OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • Your z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --character-set | --cs (string)

    +
      +
    • +

      Character set for address space to convert messages and responses from UTF-8 to EBCDIC.

      +

      Default value: 697

      +
    • +
    +
  • +
  • +

    --code-page | --cp (string)

    +
      +
    • +

      Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC.

      +

      Default value: 1047

      +
    • +
    +
  • +
  • +

    --columns | --cols (number)

    +
      +
    • +

      The number of columns on a screen.

      +

      Default value: 80

      +
    • +
    +
  • +
  • +

    --logon-procedure | -l (string)

    +
      +
    • +

      The logon procedure to use when creating TSO procedures on your behalf.

      +

      Default value: IZUFPROC

      +
    • +
    +
  • +
  • +

    --region-size | --rs (number)

    +
      +
    • +

      Region size for the TSO/E address space.

      +

      Default value: 4096

      +
    • +
    +
  • +
  • +

    --rows (number)

    +
      +
    • +

      The number of rows on a screen.

      +

      Default value: 24

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --tso-profile | --tso-p (string)

    +
      +
    • The name of a (tso) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Issue the TSO command "status" to display information about jobs for your user ID.:

    +
      +
    • zowe zos-tso issue command "status"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-tso_ping.html b/static/v2.15.x/web_help/docs/zowe_zos-tso_ping.html new file mode 100644 index 0000000000..d85a86c324 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-tso_ping.html @@ -0,0 +1,20 @@ + + + + +zos-tso ping + + +
+

zowezos-tsoping

+

Ping a TSO address space, from which you previously started and received a token (a.k.a 'servelet-key').

+

Usage

+

zowe zos-tso ping <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-tso_ping_address-space.html b/static/v2.15.x/web_help/docs/zowe_zos-tso_ping_address-space.html new file mode 100644 index 0000000000..f8549ea6f6 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-tso_ping_address-space.html @@ -0,0 +1,130 @@ + + + + +zos-tso ping address-space + + +
+

zowezos-tsopingaddress-space

+

Ping a TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').

+

Usage

+

zowe zos-tso ping address-space <servletKey> [options]

+

Positional Arguments

+
    +
  • +

    servletKey (string)

    +
      +
    • The servlet key from a previously started TSO address space.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Ping the TSO address space identified by IBMUSER-329-aafkaaoc:

    +
      +
    • zowe zos-tso ping address-space IBMUSER-329-aafkaaoc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-tso_send.html b/static/v2.15.x/web_help/docs/zowe_zos-tso_send.html new file mode 100644 index 0000000000..59e01c4ea3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-tso_send.html @@ -0,0 +1,20 @@ + + + + +zos-tso send + + +
+

zowezos-tsosend

+

Send data to TSO and collect responses until the prompt is reached.

+

Usage

+

zowe zos-tso send <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-tso_send_address-space.html b/static/v2.15.x/web_help/docs/zowe_zos-tso_send_address-space.html new file mode 100644 index 0000000000..cc84456e25 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-tso_send_address-space.html @@ -0,0 +1,139 @@ + + + + +zos-tso send address-space + + +
+

zowezos-tsosendaddress-space

+

Send data to the TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').

+

Usage

+

zowe zos-tso send address-space <servletKey> [options]

+

Positional Arguments

+
    +
  • +

    servletKey (string)

    +
      +
    • The servlet key from a previously started TSO address space.
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --data (string)

    +
      +
    • The data to which we want to send to the TSO address space represented by the servlet key.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    "Send the TIME TSO command to the TSO address space identified by IBMUSER-329-aafkaaoc":

    +
      +
    • zowe zos-tso send address-space IBMUSER-329-aafkaaoc --data "TIME"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-tso_start.html b/static/v2.15.x/web_help/docs/zowe_zos-tso_start.html new file mode 100644 index 0000000000..8ddc1caae5 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-tso_start.html @@ -0,0 +1,20 @@ + + + + +zos-tso start + + +
+

zowezos-tsostart

+

Start TSO/E address space.

+

Usage

+

zowe zos-tso start <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • address-space | as - Start a TSO address space, from which you will receive a token (a.k.a 'servlet-key') for further address space interaction (e.g. termination).
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-tso_start_address-space.html b/static/v2.15.x/web_help/docs/zowe_zos-tso_start_address-space.html new file mode 100644 index 0000000000..5b28ad7bdb --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-tso_start_address-space.html @@ -0,0 +1,211 @@ + + + + +zos-tso start address-space + + +
+

zowezos-tsostartaddress-space

+

Start a TSO address space, from which you will receive a token (a.k.a 'servlet-key') for further address space interaction (e.g. termination).

+

Usage

+

zowe zos-tso start address-space [options]

+

TSO ADDRESS SPACE OPTIONS

+
    +
  • +

    --account | -a (string)

    +
      +
    • Your z/OS TSO/E accounting information.
    • +
    +
  • +
  • +

    --character-set | --cs (string)

    +
      +
    • +

      Character set for address space to convert messages and responses from UTF-8 to EBCDIC.

      +

      Default value: 697

      +
    • +
    +
  • +
  • +

    --code-page | --cp (string)

    +
      +
    • +

      Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC.

      +

      Default value: 1047

      +
    • +
    +
  • +
  • +

    --columns | --cols (number)

    +
      +
    • +

      The number of columns on a screen.

      +

      Default value: 80

      +
    • +
    +
  • +
  • +

    --logon-procedure | -l (string)

    +
      +
    • +

      The logon procedure to use when creating TSO procedures on your behalf.

      +

      Default value: IZUFPROC

      +
    • +
    +
  • +
  • +

    --region-size | --rs (number)

    +
      +
    • +

      Region size for the TSO/E address space.

      +

      Default value: 4096

      +
    • +
    +
  • +
  • +

    --rows (number)

    +
      +
    • +

      The number of rows on a screen.

      +

      Default value: 24

      +
    • +
    +
  • +
+

Options

+
    +
  • +

    --servlet-key-only | --sko (boolean)

    +
      +
    • Specify this option to print only the servlet key
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --tso-profile | --tso-p (string)

    +
      +
    • The name of a (tso) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Start TSO/E address space:

    +
      +
    • zowe zos-tso start address-space
    • +
    +
  • +
  • +

    Start TSO/E address space, and receive response in JSON format:

    +
      +
    • zowe zos-tso start address-space --rfj
    • +
    +
  • +
  • +

    Start TSO/E address space, and print only the servlet key:

    +
      +
    • zowe zos-tso start address-space --sko
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-tso_stop.html b/static/v2.15.x/web_help/docs/zowe_zos-tso_stop.html new file mode 100644 index 0000000000..afb8aeb5dd --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-tso_stop.html @@ -0,0 +1,20 @@ + + + + +zos-tso stop + + +
+

zowezos-tsostop

+

Stop TSO/E address space.

+

Usage

+

zowe zos-tso stop <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • address-space | as - Stop a TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-tso_stop_address-space.html b/static/v2.15.x/web_help/docs/zowe_zos-tso_stop_address-space.html new file mode 100644 index 0000000000..c62b5ddfd9 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-tso_stop_address-space.html @@ -0,0 +1,130 @@ + + + + +zos-tso stop address-space + + +
+

zowezos-tsostopaddress-space

+

Stop a TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').

+

Usage

+

zowe zos-tso stop address-space <servletkey> [options]

+

Positional Arguments

+
    +
  • +

    servletkey (string)

    +
      +
    • The servlet key from a previously started TSO address space.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Stop the TSO address space identified by IBMUSER-329-aafkaaoc:

    +
      +
    • zowe zos-tso stop address-space IBMUSER-329-aafkaaoc
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows.html new file mode 100644 index 0000000000..d6fd359729 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows.html @@ -0,0 +1,24 @@ + + + + +zos-workflows + + +
+

zowezos-workflows

+

Create and manage z/OSMF workflows on a z/OS system.

+

Usage

+

zowe zos-workflows <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • archive - Archive workflow instance in z/OSMF.
  • +
  • create | cre - Create a z/OSMF workflow on a z/OS system.
  • +
  • delete | del - Delete an active workflow or an archived workflow from z/OSMF.
  • +
  • list | ls - List the z/OSMF workflows for a system or a sysplex with filter options.
  • +
  • start | sta - Start a z/OSMF workflow on a z/OS system.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_archive.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_archive.html new file mode 100644 index 0000000000..f53f212610 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_archive.html @@ -0,0 +1,20 @@ + + + + +zos-workflows archive + + +
+

zowezos-workflowsarchive

+

Archive workflow instance in z/OSMF.

+

Usage

+

zowe zos-workflows archive <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_archive_active-workflow.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_archive_active-workflow.html new file mode 100644 index 0000000000..da8d8c5f33 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_archive_active-workflow.html @@ -0,0 +1,176 @@ + + + + +zos-workflows archive active-workflow + + +
+

zowezos-workflowsarchiveactive-workflow

+

Archive an active workflow instance in z/OSMF.

+

Usage

+

zowe zos-workflows archive active-workflow [options]

+

Options

+
    +
  • +

    --workflow-name | --wn (string)

    +
      +
    • The name of the workflow to be archived.
    • +
    +
  • +
  • +

    --workflow-key | --wk (string)

    +
      +
    • The workflow key of the workflow to be archived.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Archive a workflow with workflow name "testworkflow":

    +
      +
    • zowe zos-workflows archive active-workflow --wn "testworkflow"
    • +
    +
  • +
  • +

    Archive multiple workflows with workflow names starting with "test":

    +
      +
    • zowe zos-workflows archive active-workflow --wn "test.*"
    • +
    +
  • +
  • +

    Archive a workflow with workflow key "123-456-abv-xyz":

    +
      +
    • zowe zos-workflows archive active-workflow --wk "123-456-abv-xyz"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_create.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_create.html new file mode 100644 index 0000000000..561cf3bd8f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_create.html @@ -0,0 +1,22 @@ + + + + +zos-workflows create + + + + + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_create_workflow-from-data-set.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_create_workflow-from-data-set.html new file mode 100644 index 0000000000..5d73d2e877 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_create_workflow-from-data-set.html @@ -0,0 +1,239 @@ + + + + +zos-workflows create workflow-from-data-set + + +
+

zowezos-workflowscreateworkflow-from-data-set

+

Create a z/OSMF workflow on a z/OS system using a Data set

+

Usage

+

zowe zos-workflows create workflow-from-data-set <workflowName> [options]

+

Positional Arguments

+
    +
  • +

    workflowName (string)

    +
      +
    • Name of the workflow
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --data-set | --ds (string)

    +
      +
    • Data set that contains a workflow definition.
    • +
    +
  • +
  • +

    --system-name | --sn (string)

    +
      +
    • z/OS system to execute the workflow.
    • +
    +
  • +
  • +

    --owner | --ow (string)

    +
      +
    • User ID of the workflow owner. This user can perform the workflow steps or delegate the steps to other users.
    • +
    +
  • +
+

Options

+
    +
  • +

    --variables-input-file | --vif (string)

    +
      +
    • Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that are defined in the workflow definition file.
    • +
    +
  • +
  • +

    --variables | --vs (string)

    +
      +
    • Includes a list of variables for the workflow. The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. Make sure the value meets all regular expression requirements set for the corresponding variable.
    • +
    +
  • +
  • +

    --assign-to-owner | --ato (boolean)

    +
      +
    • Indicates whether the workflow steps are assigned to the workflow owner.
    • +
    +
  • +
  • +

    --access-type | --at (string)

    +
      +
    • +

      Specifies the access type for the workflow. Public, Restricted or Private.

      +

      Allowed values: Public, Restricted, Private

      +
    • +
    +
  • +
  • +

    --delete-completed | --dc (boolean)

    +
      +
    • Whether the successfully completed jobs to be deleted from the JES spool.
    • +
    +
  • +
  • +

    --overwrite | --ov (boolean)

    +
      +
    • Replaces an existing workflow with a new workflow.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a workflow with name "testworkflow" using the data set "TESTID.WKFLOW" that contains the workflow definition xml on the system "TESTM1" with owner "OTHERID" and delete workflow with the same name if it already exists in z/OSMF:

    +
      +
    • zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "OTHERID" --overwrite
    • +
    +
  • +
  • +

    Create a workflow with name "testworkflow" using data set "TESTID.WKFLOW" containing workflow definition xml, on system "TESTM1" with owner "MYSYSID" and delete successfully completed jobs:

    +
      +
    • zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "MYSYSID" --delete-completed
    • +
    +
  • +
  • +

    Create a workflow with name "testworkflow" using data set "TESTID.WKFLOW" containing workflow definition xml, on system "TESTM1" with owner "MYSYSID" and with variable values in the member PROPERTIES of data set TESTID.DATA:

    +
      +
    • zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "MYSYSID" --variables-input-file TESTID.DATA(PROPERTIES)
    • +
    +
  • +
  • +

    Create a workflow with name "testworkflow" using the data set "TESTID.WKFLOW" that contains a workflow definition xml, on a system "TESTM1" with owner "MYSYSID" and with the variable name DUMMYVAR and the value DUMMYVAL. Assign it to the owner:

    +
      +
    • zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "MYSYSID" --variables DUMMYVAR=DUMMYVAL --assign-to-owner
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_create_workflow-from-local-file.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_create_workflow-from-local-file.html new file mode 100644 index 0000000000..7d42af9aa2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_create_workflow-from-local-file.html @@ -0,0 +1,236 @@ + + + + +zos-workflows create workflow-from-local-file + + +
+

zowezos-workflowscreateworkflow-from-local-file

+

Create a z/OSMF workflow on a z/OS system using a Local file

+

Usage

+

zowe zos-workflows create workflow-from-local-file <workflowName> [options]

+

Positional Arguments

+
    +
  • +

    workflowName (string)

    +
      +
    • Name of the workflow
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --local-file | --lf (string)

    +
      +
    • Local file that contains workflow definition.
    • +
    +
  • +
  • +

    --system-name | --sn (string)

    +
      +
    • z/OS system to execute the workflow.
    • +
    +
  • +
  • +

    --owner | --ow (string)

    +
      +
    • User ID of the workflow owner. This user can perform the workflow steps or delegate the steps to other users.
    • +
    +
  • +
+

Options

+
    +
  • +

    --variables-input-file | --vif (string)

    +
      +
    • Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that are defined in the workflow definition file.
    • +
    +
  • +
  • +

    --variables | --vs (string)

    +
      +
    • Includes a list of variables for the workflow. The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. Make sure the value meets all regular expression requirements set for the corresponding variable.
    • +
    +
  • +
  • +

    --assign-to-owner | --ato (boolean)

    +
      +
    • Indicates whether the workflow steps are assigned to the workflow owner.
    • +
    +
  • +
  • +

    --access-type | --at (string)

    +
      +
    • +

      Specifies the access type for the workflow. Public, Restricted or Private.

      +

      Allowed values: Public, Restricted, Private

      +
    • +
    +
  • +
  • +

    --delete-completed | --dc (boolean)

    +
      +
    • Whether the successfully completed jobs to be deleted from the JES spool.
    • +
    +
  • +
  • +

    --overwrite | --ov (boolean)

    +
      +
    • Replaces an existing workflow with a new workflow.
    • +
    +
  • +
  • +

    --remote-directory | --rd (string)

    +
      +
    • The remote uss directory where the files are to be uploaded. The directory has to exist
    • +
    +
  • +
  • +

    --keep-files | --kf (boolean)

    +
      +
    • +

      Avoid deletion the uploaded files in /tmp or another specified directory after successful execution.

      +

      Default value: false

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a workflow with name "testworkflow" using the local file "TESTID_WKFLOW.xml" that contains the workflow definition xml on the system "TESTM1" with owner "OTHERID" and delete workflow with the same name if it already exists in z/OSMF:

    +
      +
    • zowe zos-workflows create workflow-from-local-file "testworkflow" --local-file "TESTID_WKFLOW.xml" --system-name "TESTM1" --owner "OTHERID" --overwrite
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_create_workflow-from-uss-file.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_create_workflow-from-uss-file.html new file mode 100644 index 0000000000..60920e0785 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_create_workflow-from-uss-file.html @@ -0,0 +1,239 @@ + + + + +zos-workflows create workflow-from-uss-file + + +
+

zowezos-workflowscreateworkflow-from-uss-file

+

Create a workflow instance in z/OSMF using a USS file

+

Usage

+

zowe zos-workflows create workflow-from-uss-file <workflowName> [options]

+

Positional Arguments

+
    +
  • +

    workflowName (string)

    +
      +
    • Name of the workflow instance to create
    • +
    +
  • +
+

Required Options

+
    +
  • +

    --uss-file | --uf (string)

    +
      +
    • Uss file that contains workflow definition.
    • +
    +
  • +
  • +

    --system-name | --sn (string)

    +
      +
    • z/OS system to execute the workflow.
    • +
    +
  • +
  • +

    --owner | --ow (string)

    +
      +
    • User ID of the workflow owner. This user can perform the workflow steps or delegate the steps to other users.
    • +
    +
  • +
+

Options

+
    +
  • +

    --variables-input-file | --vif (string)

    +
      +
    • Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that are defined in the workflow definition file.
    • +
    +
  • +
  • +

    --variables | --vs (string)

    +
      +
    • Includes a list of variables for the workflow. The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. Make sure the value meets all regular expression requirements set for the corresponding variable.
    • +
    +
  • +
  • +

    --assign-to-owner | --ato (boolean)

    +
      +
    • Indicates whether the workflow steps are assigned to the workflow owner.
    • +
    +
  • +
  • +

    --access-type | --at (string)

    +
      +
    • +

      Specifies the access type for the workflow. Public, Restricted or Private.

      +

      Allowed values: Public, Restricted, Private

      +
    • +
    +
  • +
  • +

    --delete-completed | --dc (boolean)

    +
      +
    • Whether the successfully completed jobs to be deleted from the JES spool.
    • +
    +
  • +
  • +

    --overwrite | --ov (boolean)

    +
      +
    • Replaces an existing workflow with a new workflow.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "OTHERID" and delete workflow with the same name if it already exists in z/OSMF:

    +
      +
    • zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "OTHERID" --overwrite
    • +
    +
  • +
  • +

    Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "MYSYSID" and delete successfully completed jobs:

    +
      +
    • zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "MYSYSID" --delete-completed
    • +
    +
  • +
  • +

    Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "MYSYSID" and with variable values in the member PROPERTIES of data set TESTID.DATA:

    +
      +
    • zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "MYSYSID" --variables-input-file TESTID.DATA(PROPERTIES)
    • +
    +
  • +
  • +

    Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "MYSYSID" and with variables VAR1 and VAR2 with values DUMMYVAL1 and DUMMYVAL2, and assign it to the owner:

    +
      +
    • zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1"--variables VAR1=DUMMYVAL1,VAR2=DUMMYVAL2 --owner "MYSYSID" --assign-to-owner
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_delete.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_delete.html new file mode 100644 index 0000000000..77564fb023 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_delete.html @@ -0,0 +1,21 @@ + + + + +zos-workflows delete + + +
+

zowezos-workflowsdelete

+

Delete an active workflow or an archived workflow from z/OSMF.

+

Usage

+

zowe zos-workflows delete <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_delete_active-workflow.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_delete_active-workflow.html new file mode 100644 index 0000000000..e49af74bc3 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_delete_active-workflow.html @@ -0,0 +1,148 @@ + + + + +zos-workflows delete active-workflow + + +
+

zowezos-workflowsdeleteactive-workflow

+

Delete an active workflow instance in z/OSMF

+

Usage

+

zowe zos-workflows delete active-workflow [options]

+

Options

+
    +
  • +

    --workflow-key | --wk (string)

    +
      +
    • Delete active workflow by specified workflow key
    • +
    +
  • +
  • +

    --workflow-name | --wn (string)

    +
      +
    • Delete active workflow by specified workflow name
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To delete a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":

    +
      +
    • zowe zos-workflows delete active-workflow --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
    • +
    +
  • +
  • +

    To delete a workflow instance in z/OSMF with workflow name "testWorkflow":

    +
      +
    • zowe zos-workflows delete active-workflow --workflow-name "testWorkflow"
    • +
    +
  • +
  • +

    To delete multiple workflow instances in z/OSMF with names starting with "test":

    +
      +
    • zowe zos-workflows delete active-workflow --workflow-name "test.*"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_delete_archived-workflow.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_delete_archived-workflow.html new file mode 100644 index 0000000000..4912b5148f --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_delete_archived-workflow.html @@ -0,0 +1,148 @@ + + + + +zos-workflows delete archived-workflow + + +
+

zowezos-workflowsdeletearchived-workflow

+

Delete an archived workflow from z/OSMF

+

Usage

+

zowe zos-workflows delete archived-workflow [options]

+

Options

+
    +
  • +

    --workflow-key | --wk (string)

    +
      +
    • Delete an archived workflow by specified workflow key
    • +
    +
  • +
  • +

    --workflow-name | --wn (string)

    +
      +
    • Delete an archived workflow by specified workflow name
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To delete an archived workflow from z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":

    +
      +
    • zowe zos-workflows delete archived-workflow --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
    • +
    +
  • +
  • +

    To delete an archived workflow from z/OSMF with workflow name "testWorkflow":

    +
      +
    • zowe zos-workflows delete archived-workflow --workflow-name "testWorkflow"
    • +
    +
  • +
  • +

    To delete multiple archived workflows from z/OSMF with names beginnig with "test":

    +
      +
    • zowe zos-workflows delete archived-workflow --workflow-name "test.*"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_list.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_list.html new file mode 100644 index 0000000000..f36ea6211e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_list.html @@ -0,0 +1,23 @@ + + + + +zos-workflows list + + +
+

zowezos-workflowslist

+

List the z/OSMF workflows for a system or a sysplex with filter options.

+

Usage

+

zowe zos-workflows list <command>

+

Where <command> is one of the following:

+

Commands

+ +
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_list_active-workflow-details.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_list_active-workflow-details.html new file mode 100644 index 0000000000..87d778f157 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_list_active-workflow-details.html @@ -0,0 +1,166 @@ + + + + +zos-workflows list active-workflow-details + + +
+

zowezos-workflowslistactive-workflow-details

+

Get the details of an active z/OSMF workflow

+

Usage

+

zowe zos-workflows list active-workflow-details [options]

+

Options

+
    +
  • +

    --workflow-name | --wn (string)

    +
      +
    • List active workflow details by specified workflow name.
    • +
    +
  • +
  • +

    --workflow-key | --wk (string)

    +
      +
    • List active workflow details by specified workflow key.
    • +
    +
  • +
  • +

    --list-steps | --ls (boolean)

    +
      +
    • Optional parameter for listing steps and their properties.
    • +
    +
  • +
  • +

    --steps-summary-only | --sso (boolean)

    +
      +
    • Optional parameter that lists steps summary only.
    • +
    +
  • +
  • +

    --list-variables | --lv (boolean)

    +
      +
    • Optional parameter for listing variables and their properties.
    • +
    +
  • +
  • +

    --skip-workflow-summary | --sws (boolean)

    +
      +
    • Optional parameter that skips the default workflow summary.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To list the details of an active workflow with key "7c62c790-0340-86b2-61ce618d8f8c" including its steps and variables:

    +
      +
    • zowe zos-workflows list active-workflow-details --workflow-key "7c62c790-0340-86b2-61ce618d8f8c" --list-steps --list-variables
    • +
    +
  • +
  • +

    To list the details of an active workflow with name "testWorkflow" including its steps and variables:

    +
      +
    • zowe zos-workflows list active-workflow-details --workflow-name "testWorkflow" --list-steps --list-variables
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_list_active-workflows.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_list_active-workflows.html new file mode 100644 index 0000000000..feab4b2846 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_list_active-workflows.html @@ -0,0 +1,205 @@ + + + + +zos-workflows list active-workflows + + +
+

zowezos-workflowslistactive-workflows

+

List active workflow instance(s) in z/OSMF.
+Multiple filters can be used together.
+Omitting all options will list all workflows on the sysplex

+

Usage

+

zowe zos-workflows list active-workflows [options]

+

Options

+
    +
  • +

    --workflow-name | --wn (string)

    +
      +
    • Filter by workflow name. For wildcard use .*
    • +
    +
  • +
  • +

    --category | --cat (string)

    +
      +
    • Filter by the category of the workflows, which is either general or configuration.
    • +
    +
  • +
  • +

    --system | --sys (string)

    +
      +
    • Filter by the nickname of the system on which the workflows is/are active.
    • +
    +
  • +
  • +

    --owner | --ow (string)

    +
      +
    • Filter by owner of the workflow(s) (a valid z/OS user ID).
    • +
    +
  • +
  • +

    --vendor | --vd (string)

    +
      +
    • Filter by the name of the vendor that provided the workflow(s) definition file.
    • +
    +
  • +
  • +

    --status-name | --sn (string)

    +
      +
    • +

      Filter by the status of the workflow(s).

      +

      Allowed values: in-progress, complete, automation-in-progress, canceled

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+

Examples

+
    +
  • +

    List the workflow with name "testworkflow":

    +
      +
    • zowe zos-workflows list active-workflows --wn "testworkflow"
    • +
    +
  • +
  • +

    List multiple active workflows on the entire syspex with names containing"workflow":

    +
      +
    • zowe zos-workflows list active-workflows --wn ".*workflow.*"
    • +
    +
  • +
  • +

    List multiple active workflows on system "IBMSYS" with names beginnig with "testW" that are in status "complete":

    +
      +
    • zowe zos-workflows list active-workflows --wn "test.*" --sys "IBMSYS" --sn "complete"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_list_archived-workflows.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_list_archived-workflows.html new file mode 100644 index 0000000000..5e27e5cc0e --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_list_archived-workflows.html @@ -0,0 +1,140 @@ + + + + +zos-workflows list archived-workflows + + +
+

zowezos-workflowslistarchived-workflows

+

List the archived z/OSMF workflows for a system or sysplex.

+

Usage

+

zowe zos-workflows list archived-workflows [options]

+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Response Format Options

+
    +
  • +

    --response-format-filter | --rff (array)

    +
      +
    • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
    • +
    +
  • +
  • +

    --response-format-type | --rft (string)

    +
      +
    • +

      The command response output format type. Must be one of the following:

      +

      table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

      +

      list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

      +

      object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

      +

      string: Formats output data as a string. JSON objects/arrays are stringified.

      +

      Allowed values: table, list, object, string

      +
    • +
    +
  • +
  • +

    --response-format-header | --rfh (boolean)

    +
      +
    • If "--response-format-type table" is specified, include the column headers in the output.
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_list_definition-file-details.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_list_definition-file-details.html new file mode 100644 index 0000000000..84033109b7 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_list_definition-file-details.html @@ -0,0 +1,151 @@ + + + + +zos-workflows list definition-file-details + + +
+

zowezos-workflowslistdefinition-file-details

+

Retrieve the contents of a z/OSMF workflow definition from a z/OS system.

+

Usage

+

zowe zos-workflows list definition-file-details <definitionFilePath> [options]

+

Positional Arguments

+
    +
  • +

    definitionFilePath (string)

    +
      +
    • Specifies the location of the workflow definition file, which is either a UNIX path name or a fully qualified z/OS data set name.
    • +
    +
  • +
+

Options

+
    +
  • +

    --list-steps | --ls (boolean)

    +
      +
    • Optional parameter for listing steps and their properties.
    • +
    +
  • +
  • +

    --list-variables | --lv (boolean)

    +
      +
    • Optional parameter for listing variables and their properties.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To list the contents of a workflow definition stored in the UNIX file "/user/dir/workflow.xml" including its steps and variables:

    +
      +
    • zowe zos-workflows list definition-file-details "/user/dir/workflow.xml" --list-steps --list-variables
    • +
    +
  • +
  • +

    To list the contents of a workflow definition stored in the z/OS data set "USER.DATA.SET.XML" including its steps and variables:

    +
      +
    • zowe zos-workflows list definition-file-details "USER.DATA.SET.XML" --list-steps --list-variables
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_start.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_start.html new file mode 100644 index 0000000000..55935d0b47 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_start.html @@ -0,0 +1,21 @@ + + + + +zos-workflows start + + +
+

zowezos-workflowsstart

+

Start a z/OSMF workflow on a z/OS system.

+

Usage

+

zowe zos-workflows start <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • workflow-full | wf - Will run workflow from the beginning to the end or to the first manual step.
  • +
  • workflow-step | ws - Will run given step of workflow instance plus following steps if specified by --perform-following-steps option.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_start_workflow-full.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_start_workflow-full.html new file mode 100644 index 0000000000..4a0deaf383 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_start_workflow-full.html @@ -0,0 +1,174 @@ + + + + +zos-workflows start workflow-full + + +
+

zowezos-workflowsstartworkflow-full

+

Will run workflow from the beginning to the end or to the first manual step.

+

Usage

+

zowe zos-workflows start workflow-full [options]

+

Options

+
    +
  • +

    --workflow-key | --wk (string)

    +
      +
    • Workflow key of workflow instance to be started
    • +
    +
  • +
  • +

    --workflow-name | --wn (string)

    +
      +
    • Workflow name of workflow instance to be started
    • +
    +
  • +
  • +

    --resolve-conflict-by | --rcb (string)

    +
      +
    • +

      How variable conflicts should be handled.
      +Options:
      +outputFileValue: Allow the output file values to override the existing values.
      +existingValue: Use the existing variables values instead of the output file values.
      +leaveConflict: Automation is stopped. The user must resolve the conflict manually.

      +

      Default value: outputFileValue
      +Allowed values: outputFileValue, existingValue, leaveConflict

      +
    • +
    +
  • +
  • +

    --wait | -w (boolean)

    +
      +
    • Identifies whether to wait for workflow instance to finish.
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To start a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":

    +
      +
    • zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
    • +
    +
  • +
  • +

    To start a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" and wait forit to be finished:

    +
      +
    • zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --wait
    • +
    +
  • +
  • +

    To start a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"and if there is a conflict in variable's value use the value that is in output file:

    +
      +
    • zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --resolve-conflict-by "outputFileValue"
    • +
    +
  • +
  • +

    To start a workflow instance in z/OSMF with workflow name "testWorkflow":

    +
      +
    • zowe zos-workflows start workflow-full --workflow-name "testWorkflow"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zos-workflows_start_workflow-step.html b/static/v2.15.x/web_help/docs/zowe_zos-workflows_start_workflow-step.html new file mode 100644 index 0000000000..e030a8f4ad --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zos-workflows_start_workflow-step.html @@ -0,0 +1,186 @@ + + + + +zos-workflows start workflow-step + + +
+

zowezos-workflowsstartworkflow-step

+

Will run given step of workflow instance plus following steps if specified by --perform-following-steps option.

+

Usage

+

zowe zos-workflows start workflow-step <stepName> [options]

+

Positional Arguments

+
    +
  • +

    stepName (string)

    +
      +
    • Specifies the step name that will be run.
    • +
    +
  • +
+

Options

+
    +
  • +

    --workflow-key | --wk (string)

    +
      +
    • Workflow key of workflow instance to be started
    • +
    +
  • +
  • +

    --workflow-name | --wn (string)

    +
      +
    • Workflow name of workflow instance to be started
    • +
    +
  • +
  • +

    --resolve-conflict-by | --rcb (string)

    +
      +
    • +

      How variable conflicts should be handled.
      +Options:
      +outputFileValue: Allow the output file values to override the existing values.
      +existingValue: Use the existing variables values instead of the output file values.
      +leaveConflict: Automation is stopped. The user must resolve the conflict manually.

      +

      Default value: outputFileValue
      +Allowed values: outputFileValue, existingValue, leaveConflict

      +
    • +
    +
  • +
  • +

    --perform-following-steps | --pfs (boolean)

    +
      +
    • +

      Identifies whether to perform also following steps in the workflow instance.

      +

      Default value: false

      +
    • +
    +
  • +
+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    To start step "Step1" only in a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":

    +
      +
    • zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
    • +
    +
  • +
  • +

    To start a workflow instance in z/OSMF from step "Step1" with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":

    +
      +
    • zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --perform-following-steps
    • +
    +
  • +
  • +

    To start step "Step1" only in a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"and if there is a conflict in variable's value use the value that is in output file:

    +
      +
    • zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --resolve-conflict-by "outputFileValue"
    • +
    +
  • +
  • +

    To start step "Step1" only in a workflow instance in z/OSMF with workflow name "testWorkflow":

    +
      +
    • zowe zos-workflows start workflow-step "Step1" --workflow-name "testWorkflow"
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zosmf.html b/static/v2.15.x/web_help/docs/zowe_zosmf.html new file mode 100644 index 0000000000..40790b8cf2 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zosmf.html @@ -0,0 +1,21 @@ + + + + +zosmf + + +
+

zowezosmf

+

Retrieve and show the properties of a z/OSMF web server.

+

Usage

+

zowe zosmf <group>

+

Where <group> is one of the following:

+

Groups

+
    +
  • check - Confirm that z/OSMF is running on a specified system and gather information about the z/OSMF server for diagnostic purposes.
  • +
  • list - Obtain a list of systems that are defined to a z/OSMF instance.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zosmf_check.html b/static/v2.15.x/web_help/docs/zowe_zosmf_check.html new file mode 100644 index 0000000000..46ebe2b42a --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zosmf_check.html @@ -0,0 +1,20 @@ + + + + +zosmf check + + +
+

zowezosmfcheck

+

Confirm that z/OSMF is running on a specified system and gather information about the z/OSMF server for diagnostic purposes.

+

Usage

+

zowe zosmf check <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • status - Confirm that z/OSMF is running on a system specified in your profile and gather information about the z/OSMF server for diagnostic purposes. The command outputs properties of the z/OSMF server such as version, hostname, and installed plug-ins.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zosmf_check_status.html b/static/v2.15.x/web_help/docs/zowe_zosmf_check_status.html new file mode 100644 index 0000000000..a0a2595a84 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zosmf_check_status.html @@ -0,0 +1,133 @@ + + + + +zosmf check status + + +
+

zowezosmfcheckstatus

+

Confirm that z/OSMF is running on a system specified in your profile and gather information about the z/OSMF server for diagnostic purposes. The command outputs properties of the z/OSMF server such as version, hostname, and installed plug-ins.

+

Usage

+

zowe zosmf check status [options]

+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Report the status of the z/OSMF server that you specified in your default z/OSMF profile:

    +
      +
    • zowe zosmf check status
    • +
    +
  • +
  • +

    Report the status of the z/OSMF server that you specified in a supplied z/OSMF profile:

    +
      +
    • zowe zosmf check status --zosmf-profile SomeZosmfProfileName
    • +
    +
  • +
  • +

    Report the status of the z/OSMF server that you specified manually via command line:

    +
      +
    • zowe zosmf check status --host myhost --port 443 --user myuser --password mypass
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zosmf_list.html b/static/v2.15.x/web_help/docs/zowe_zosmf_list.html new file mode 100644 index 0000000000..eb0092ef16 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zosmf_list.html @@ -0,0 +1,20 @@ + + + + +zosmf list + + +
+

zowezosmflist

+

Obtain a list of systems that are defined to a z/OSMF instance.

+

Usage

+

zowe zosmf list <command>

+

Where <command> is one of the following:

+

Commands

+
    +
  • systems - Obtain a list of systems that are defined to a z/OSMF instance.
  • +
+
+ + diff --git a/static/v2.15.x/web_help/docs/zowe_zosmf_list_systems.html b/static/v2.15.x/web_help/docs/zowe_zosmf_list_systems.html new file mode 100644 index 0000000000..02e4f22c31 --- /dev/null +++ b/static/v2.15.x/web_help/docs/zowe_zosmf_list_systems.html @@ -0,0 +1,133 @@ + + + + +zosmf list systems + + +
+

zowezosmflistsystems

+

Obtain a list of systems that are defined to a z/OSMF instance.

+

Usage

+

zowe zosmf list systems [options]

+

Zosmf Connection Options

+
    +
  • +

    --host | -H (string)

    +
      +
    • The z/OSMF server host name.
    • +
    +
  • +
  • +

    --port | -P (number)

    +
      +
    • +

      The z/OSMF server port.

      +

      Default value: 443

      +
    • +
    +
  • +
  • +

    --user | -u (string)

    +
      +
    • Mainframe (z/OSMF) user name, which can be the same as your TSO login.
    • +
    +
  • +
  • +

    --password | --pass | --pw (string)

    +
      +
    • Mainframe (z/OSMF) password, which can be the same as your TSO password.
    • +
    +
  • +
  • +

    --reject-unauthorized | --ru (boolean)

    +
      +
    • +

      Reject self-signed certificates.

      +

      Default value: true

      +
    • +
    +
  • +
  • +

    --base-path | --bp (string)

    +
      +
    • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
    • +
    +
  • +
  • +

    --protocol (string)

    +
      +
    • +

      The protocol used (HTTP or HTTPS)

      +

      Default value: https
      +Allowed values: http, https

      +
    • +
    +
  • +
  • +

    --cert-file (local file path)

    +
      +
    • The file path to a certificate file to use for authentication
    • +
    +
  • +
  • +

    --cert-key-file (local file path)

    +
      +
    • The file path to a certificate key file to use for authentication
    • +
    +
  • +
+

Profile Options

+
    +
  • +

    --zosmf-profile | --zosmf-p (string)

    +
      +
    • The name of a (zosmf) profile to load for this command execution.
    • +
    +
  • +
  • +

    --base-profile | --base-p (string)

    +
      +
    • The name of a (base) profile to load for this command execution.
    • +
    +
  • +
+

Base Connection Options

+
    +
  • +

    --token-type | --tt (string)

    +
      +
    • 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'.
    • +
    +
  • +
  • +

    --token-value | --tv (string)

    +
      +
    • The value of the token to pass to the API.
    • +
    +
  • +
+

Examples

+
    +
  • +

    Obtain a list of systems defined to a z/OSMF instance with your default z/OSMF profile:

    +
      +
    • zowe zosmf list systems
    • +
    +
  • +
  • +

    Obtain a list of systems defined to a z/OSMF instance for the specified z/OSMF profile:

    +
      +
    • zowe zosmf list systems --zosmf-profile SomeZosmfProfileName
    • +
    +
  • +
  • +

    Obtain a list of the systems defined to a z/OSMF instance that you specified in the command line:

    +
      +
    • zowe zosmf list systems --host myhost --port 443 --user myuser --password mypass
    • +
    +
  • +
+
+ + diff --git a/static/v2.15.x/web_help/header-image.png b/static/v2.15.x/web_help/header-image.png new file mode 100644 index 0000000000..5b979db31d Binary files /dev/null and b/static/v2.15.x/web_help/header-image.png differ diff --git a/static/v2.15.x/web_help/index.html b/static/v2.15.x/web_help/index.html new file mode 100644 index 0000000000..12fbabc016 --- /dev/null +++ b/static/v2.15.x/web_help/index.html @@ -0,0 +1,65 @@ + + + + + + + + + Docs + + + + + + + +
+
+ + +
+ + +
+ +
+ +
+
+ + + diff --git a/static/v2.15.x/web_help/js/bundle-docs.js b/static/v2.15.x/web_help/js/bundle-docs.js new file mode 100644 index 0000000000..1103f811ed --- /dev/null +++ b/static/v2.15.x/web_help/js/bundle-docs.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return b}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),r=n.n(e);function c(t){try{return document.execCommand(t)}catch(t){return}}var a=function(t){t=r()(t);return c("cut"),t};function o(t,e){var n,o,t=(n=t,o="rtl"===document.documentElement.getAttribute("dir"),(t=document.createElement("textarea")).style.fontSize="12pt",t.style.border="0",t.style.padding="0",t.style.margin="0",t.style.position="absolute",t.style[o?"right":"left"]="-9999px",o=window.pageYOffset||document.documentElement.scrollTop,t.style.top="".concat(o,"px"),t.setAttribute("readonly",""),t.value=n,t);return e.container.appendChild(t),e=r()(t),c("copy"),t.remove(),e}var f=function(t){var e=1+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0=4)throw new Error("Bootstrap's JavaScript requires at least jQuery v1.9.1 but less than v4.0.0")}};d.jQueryDetection(),o.default.fn.emulateTransitionEnd=function(t){var e=this,n=!1;return o.default(this).one(d.TRANSITION_END,(function(){n=!0})),setTimeout((function(){n||d.triggerTransitionEnd(e)}),t),this},o.default.event.special[d.TRANSITION_END]={bindType:f,delegateType:f,handle:function(t){if(o.default(t.target).is(this))return t.handleObj.handler.apply(this,arguments)}};var c="bs.alert",h=o.default.fn.alert,g=function(){function t(t){this._element=t}var e=t.prototype;return e.close=function(t){var e=this._element;t&&(e=this._getRootElement(t)),this._triggerCloseEvent(e).isDefaultPrevented()||this._removeElement(e)},e.dispose=function(){o.default.removeData(this._element,c),this._element=null},e._getRootElement=function(t){var e=d.getSelectorFromElement(t),n=!1;return e&&(n=document.querySelector(e)),n||(n=o.default(t).closest(".alert")[0]),n},e._triggerCloseEvent=function(t){var e=o.default.Event("close.bs.alert");return o.default(t).trigger(e),e},e._removeElement=function(t){var e=this;if(o.default(t).removeClass("show"),o.default(t).hasClass("fade")){var n=d.getTransitionDurationFromElement(t);o.default(t).one(d.TRANSITION_END,(function(n){return e._destroyElement(t,n)})).emulateTransitionEnd(n)}else this._destroyElement(t)},e._destroyElement=function(t){o.default(t).detach().trigger("closed.bs.alert").remove()},t._jQueryInterface=function(e){return this.each((function(){var n=o.default(this),i=n.data(c);i||(i=new t(this),n.data(c,i)),"close"===e&&i[e](this)}))},t._handleDismiss=function(t){return function(e){e&&e.preventDefault(),t.close(this)}},l(t,null,[{key:"VERSION",get:function(){return"4.6.1"}}]),t}();o.default(document).on("click.bs.alert.data-api",'[data-dismiss="alert"]',g._handleDismiss(new g)),o.default.fn.alert=g._jQueryInterface,o.default.fn.alert.Constructor=g,o.default.fn.alert.noConflict=function(){return o.default.fn.alert=h,g._jQueryInterface};var m="bs.button",p=o.default.fn.button,_="active",v='[data-toggle^="button"]',y='input:not([type="hidden"])',b=".btn",E=function(){function t(t){this._element=t,this.shouldAvoidTriggerChange=!1}var e=t.prototype;return e.toggle=function(){var t=!0,e=!0,n=o.default(this._element).closest('[data-toggle="buttons"]')[0];if(n){var i=this._element.querySelector(y);if(i){if("radio"===i.type)if(i.checked&&this._element.classList.contains(_))t=!1;else{var a=n.querySelector(".active");a&&o.default(a).removeClass(_)}t&&("checkbox"!==i.type&&"radio"!==i.type||(i.checked=!this._element.classList.contains(_)),this.shouldAvoidTriggerChange||o.default(i).trigger("change")),i.focus(),e=!1}}this._element.hasAttribute("disabled")||this._element.classList.contains("disabled")||(e&&this._element.setAttribute("aria-pressed",!this._element.classList.contains(_)),t&&o.default(this._element).toggleClass(_))},e.dispose=function(){o.default.removeData(this._element,m),this._element=null},t._jQueryInterface=function(e,n){return this.each((function(){var i=o.default(this),a=i.data(m);a||(a=new t(this),i.data(m,a)),a.shouldAvoidTriggerChange=n,"toggle"===e&&a[e]()}))},l(t,null,[{key:"VERSION",get:function(){return"4.6.1"}}]),t}();o.default(document).on("click.bs.button.data-api",v,(function(t){var e=t.target,n=e;if(o.default(e).hasClass("btn")||(e=o.default(e).closest(b)[0]),!e||e.hasAttribute("disabled")||e.classList.contains("disabled"))t.preventDefault();else{var i=e.querySelector(y);if(i&&(i.hasAttribute("disabled")||i.classList.contains("disabled")))return void t.preventDefault();"INPUT"!==n.tagName&&"LABEL"===e.tagName||E._jQueryInterface.call(o.default(e),"toggle","INPUT"===n.tagName)}})).on("focus.bs.button.data-api blur.bs.button.data-api",v,(function(t){var e=o.default(t.target).closest(b)[0];o.default(e).toggleClass("focus",/^focus(in)?$/.test(t.type))})),o.default(window).on("load.bs.button.data-api",(function(){for(var t=[].slice.call(document.querySelectorAll('[data-toggle="buttons"] .btn')),e=0,n=t.length;e0,this._pointerEvent=Boolean(window.PointerEvent||window.MSPointerEvent),this._addEventListeners()}var e=t.prototype;return e.next=function(){this._isSliding||this._slide(N)},e.nextWhenVisible=function(){var t=o.default(this._element);!document.hidden&&t.is(":visible")&&"hidden"!==t.css("visibility")&&this.next()},e.prev=function(){this._isSliding||this._slide(D)},e.pause=function(t){t||(this._isPaused=!0),this._element.querySelector(".carousel-item-next, .carousel-item-prev")&&(d.triggerTransitionEnd(this._element),this.cycle(!0)),clearInterval(this._interval),this._interval=null},e.cycle=function(t){t||(this._isPaused=!1),this._interval&&(clearInterval(this._interval),this._interval=null),this._config.interval&&!this._isPaused&&(this._updateInterval(),this._interval=setInterval((document.visibilityState?this.nextWhenVisible:this.next).bind(this),this._config.interval))},e.to=function(t){var e=this;this._activeElement=this._element.querySelector(I);var n=this._getItemIndex(this._activeElement);if(!(t>this._items.length-1||t<0))if(this._isSliding)o.default(this._element).one(A,(function(){return e.to(t)}));else{if(n===t)return this.pause(),void this.cycle();var i=t>n?N:D;this._slide(i,this._items[t])}},e.dispose=function(){o.default(this._element).off(".bs.carousel"),o.default.removeData(this._element,w),this._items=null,this._config=null,this._element=null,this._interval=null,this._isPaused=null,this._isSliding=null,this._activeElement=null,this._indicatorsElement=null},e._getConfig=function(t){return t=r({},k,t),d.typeCheckConfig(T,t,O),t},e._handleSwipe=function(){var t=Math.abs(this.touchDeltaX);if(!(t<=40)){var e=t/this.touchDeltaX;this.touchDeltaX=0,e>0&&this.prev(),e<0&&this.next()}},e._addEventListeners=function(){var t=this;this._config.keyboard&&o.default(this._element).on("keydown.bs.carousel",(function(e){return t._keydown(e)})),"hover"===this._config.pause&&o.default(this._element).on("mouseenter.bs.carousel",(function(e){return t.pause(e)})).on("mouseleave.bs.carousel",(function(e){return t.cycle(e)})),this._config.touch&&this._addTouchEventListeners()},e._addTouchEventListeners=function(){var t=this;if(this._touchSupported){var e=function(e){t._pointerEvent&&j[e.originalEvent.pointerType.toUpperCase()]?t.touchStartX=e.originalEvent.clientX:t._pointerEvent||(t.touchStartX=e.originalEvent.touches[0].clientX)},n=function(e){t._pointerEvent&&j[e.originalEvent.pointerType.toUpperCase()]&&(t.touchDeltaX=e.originalEvent.clientX-t.touchStartX),t._handleSwipe(),"hover"===t._config.pause&&(t.pause(),t.touchTimeout&&clearTimeout(t.touchTimeout),t.touchTimeout=setTimeout((function(e){return t.cycle(e)}),500+t._config.interval))};o.default(this._element.querySelectorAll(".carousel-item img")).on("dragstart.bs.carousel",(function(t){return t.preventDefault()})),this._pointerEvent?(o.default(this._element).on("pointerdown.bs.carousel",(function(t){return e(t)})),o.default(this._element).on("pointerup.bs.carousel",(function(t){return n(t)})),this._element.classList.add("pointer-event")):(o.default(this._element).on("touchstart.bs.carousel",(function(t){return e(t)})),o.default(this._element).on("touchmove.bs.carousel",(function(e){return function(e){t.touchDeltaX=e.originalEvent.touches&&e.originalEvent.touches.length>1?0:e.originalEvent.touches[0].clientX-t.touchStartX}(e)})),o.default(this._element).on("touchend.bs.carousel",(function(t){return n(t)})))}},e._keydown=function(t){if(!/input|textarea/i.test(t.target.tagName))switch(t.which){case 37:t.preventDefault(),this.prev();break;case 39:t.preventDefault(),this.next()}},e._getItemIndex=function(t){return this._items=t&&t.parentNode?[].slice.call(t.parentNode.querySelectorAll(".carousel-item")):[],this._items.indexOf(t)},e._getItemByDirection=function(t,e){var n=t===N,i=t===D,o=this._getItemIndex(e),a=this._items.length-1;if((i&&0===o||n&&o===a)&&!this._config.wrap)return e;var s=(o+(t===D?-1:1))%this._items.length;return-1===s?this._items[this._items.length-1]:this._items[s]},e._triggerSlideEvent=function(t,e){var n=this._getItemIndex(t),i=this._getItemIndex(this._element.querySelector(I)),a=o.default.Event("slide.bs.carousel",{relatedTarget:t,direction:e,from:i,to:n});return o.default(this._element).trigger(a),a},e._setActiveIndicatorElement=function(t){if(this._indicatorsElement){var e=[].slice.call(this._indicatorsElement.querySelectorAll(".active"));o.default(e).removeClass(S);var n=this._indicatorsElement.children[this._getItemIndex(t)];n&&o.default(n).addClass(S)}},e._updateInterval=function(){var t=this._activeElement||this._element.querySelector(I);if(t){var e=parseInt(t.getAttribute("data-interval"),10);e?(this._config.defaultInterval=this._config.defaultInterval||this._config.interval,this._config.interval=e):this._config.interval=this._config.defaultInterval||this._config.interval}},e._slide=function(t,e){var n,i,a,s=this,l=this._element.querySelector(I),r=this._getItemIndex(l),u=e||l&&this._getItemByDirection(t,l),f=this._getItemIndex(u),c=Boolean(this._interval);if(t===N?(n="carousel-item-left",i="carousel-item-next",a="left"):(n="carousel-item-right",i="carousel-item-prev",a="right"),u&&o.default(u).hasClass(S))this._isSliding=!1;else if(!this._triggerSlideEvent(u,a).isDefaultPrevented()&&l&&u){this._isSliding=!0,c&&this.pause(),this._setActiveIndicatorElement(u),this._activeElement=u;var h=o.default.Event(A,{relatedTarget:u,direction:a,from:r,to:f});if(o.default(this._element).hasClass("slide")){o.default(u).addClass(i),d.reflow(u),o.default(l).addClass(n),o.default(u).addClass(n);var g=d.getTransitionDurationFromElement(l);o.default(l).one(d.TRANSITION_END,(function(){o.default(u).removeClass(n+" "+i).addClass(S),o.default(l).removeClass("active "+i+" "+n),s._isSliding=!1,setTimeout((function(){return o.default(s._element).trigger(h)}),0)})).emulateTransitionEnd(g)}else o.default(l).removeClass(S),o.default(u).addClass(S),this._isSliding=!1,o.default(this._element).trigger(h);c&&this.cycle()}},t._jQueryInterface=function(e){return this.each((function(){var n=o.default(this).data(w),i=r({},k,o.default(this).data());"object"==typeof e&&(i=r({},i,e));var a="string"==typeof e?e:i.slide;if(n||(n=new t(this,i),o.default(this).data(w,n)),"number"==typeof e)n.to(e);else if("string"==typeof a){if("undefined"==typeof n[a])throw new TypeError('No method named "'+a+'"');n[a]()}else i.interval&&i.ride&&(n.pause(),n.cycle())}))},t._dataApiClickHandler=function(e){var n=d.getSelectorFromElement(this);if(n){var i=o.default(n)[0];if(i&&o.default(i).hasClass("carousel")){var a=r({},o.default(i).data(),o.default(this).data()),s=this.getAttribute("data-slide-to");s&&(a.interval=!1),t._jQueryInterface.call(o.default(i),a),s&&o.default(i).data(w).to(s),e.preventDefault()}}},l(t,null,[{key:"VERSION",get:function(){return"4.6.1"}},{key:"Default",get:function(){return k}}]),t}();o.default(document).on("click.bs.carousel.data-api","[data-slide], [data-slide-to]",P._dataApiClickHandler),o.default(window).on("load.bs.carousel.data-api",(function(){for(var t=[].slice.call(document.querySelectorAll('[data-ride="carousel"]')),e=0,n=t.length;e0&&(this._selector=s,this._triggerArray.push(a))}this._parent=this._config.parent?this._getParent():null,this._config.parent||this._addAriaAndCollapsedClass(this._element,this._triggerArray),this._config.toggle&&this.toggle()}var e=t.prototype;return e.toggle=function(){o.default(this._element).hasClass(q)?this.hide():this.show()},e.show=function(){var e,n,i=this;if(!(this._isTransitioning||o.default(this._element).hasClass(q)||(this._parent&&0===(e=[].slice.call(this._parent.querySelectorAll(".show, .collapsing")).filter((function(t){return"string"==typeof i._config.parent?t.getAttribute("data-parent")===i._config.parent:t.classList.contains(F)}))).length&&(e=null),e&&(n=o.default(e).not(this._selector).data(R))&&n._isTransitioning))){var a=o.default.Event("show.bs.collapse");if(o.default(this._element).trigger(a),!a.isDefaultPrevented()){e&&(t._jQueryInterface.call(o.default(e).not(this._selector),"hide"),n||o.default(e).data(R,null));var s=this._getDimension();o.default(this._element).removeClass(F).addClass(Q),this._element.style[s]=0,this._triggerArray.length&&o.default(this._triggerArray).removeClass(B).attr("aria-expanded",!0),this.setTransitioning(!0);var l="scroll"+(s[0].toUpperCase()+s.slice(1)),r=d.getTransitionDurationFromElement(this._element);o.default(this._element).one(d.TRANSITION_END,(function(){o.default(i._element).removeClass(Q).addClass("collapse show"),i._element.style[s]="",i.setTransitioning(!1),o.default(i._element).trigger("shown.bs.collapse")})).emulateTransitionEnd(r),this._element.style[s]=this._element[l]+"px"}}},e.hide=function(){var t=this;if(!this._isTransitioning&&o.default(this._element).hasClass(q)){var e=o.default.Event("hide.bs.collapse");if(o.default(this._element).trigger(e),!e.isDefaultPrevented()){var n=this._getDimension();this._element.style[n]=this._element.getBoundingClientRect()[n]+"px",d.reflow(this._element),o.default(this._element).addClass(Q).removeClass("collapse show");var i=this._triggerArray.length;if(i>0)for(var a=0;a0},e._getOffset=function(){var t=this,e={};return"function"==typeof this._config.offset?e.fn=function(e){return e.offsets=r({},e.offsets,t._config.offset(e.offsets,t._element)),e}:e.offset=this._config.offset,e},e._getPopperConfig=function(){var t={placement:this._getPlacement(),modifiers:{offset:this._getOffset(),flip:{enabled:this._config.flip},preventOverflow:{boundariesElement:this._config.boundary}}};return"static"===this._config.display&&(t.modifiers.applyStyle={enabled:!1}),r({},t,this._config.popperConfig)},t._jQueryInterface=function(e){return this.each((function(){var n=o.default(this).data(K);if(n||(n=new t(this,"object"==typeof e?e:null),o.default(this).data(K,n)),"string"==typeof e){if("undefined"==typeof n[e])throw new TypeError('No method named "'+e+'"');n[e]()}}))},t._clearMenus=function(e){if(!e||3!==e.which&&("keyup"!==e.type||9===e.which))for(var n=[].slice.call(document.querySelectorAll(it)),i=0,a=n.length;i0&&s--,40===e.which&&sdocument.documentElement.clientHeight;n||(this._element.style.overflowY="hidden"),this._element.classList.add(ht);var i=d.getTransitionDurationFromElement(this._dialog);o.default(this._element).off(d.TRANSITION_END),o.default(this._element).one(d.TRANSITION_END,(function(){t._element.classList.remove(ht),n||o.default(t._element).one(d.TRANSITION_END,(function(){t._element.style.overflowY=""})).emulateTransitionEnd(t._element,i)})).emulateTransitionEnd(i),this._element.focus()}},e._showElement=function(t){var e=this,n=o.default(this._element).hasClass(dt),i=this._dialog?this._dialog.querySelector(".modal-body"):null;this._element.parentNode&&this._element.parentNode.nodeType===Node.ELEMENT_NODE||document.body.appendChild(this._element),this._element.style.display="block",this._element.removeAttribute("aria-hidden"),this._element.setAttribute("aria-modal",!0),this._element.setAttribute("role","dialog"),o.default(this._dialog).hasClass("modal-dialog-scrollable")&&i?i.scrollTop=0:this._element.scrollTop=0,n&&d.reflow(this._element),o.default(this._element).addClass(ct),this._config.focus&&this._enforceFocus();var a=o.default.Event("shown.bs.modal",{relatedTarget:t}),s=function(){e._config.focus&&e._element.focus(),e._isTransitioning=!1,o.default(e._element).trigger(a)};if(n){var l=d.getTransitionDurationFromElement(this._dialog);o.default(this._dialog).one(d.TRANSITION_END,s).emulateTransitionEnd(l)}else s()},e._enforceFocus=function(){var t=this;o.default(document).off(pt).on(pt,(function(e){document!==e.target&&t._element!==e.target&&0===o.default(t._element).has(e.target).length&&t._element.focus()}))},e._setEscapeEvent=function(){var t=this;this._isShown?o.default(this._element).on(yt,(function(e){t._config.keyboard&&27===e.which?(e.preventDefault(),t.hide()):t._config.keyboard||27!==e.which||t._triggerBackdropTransition()})):this._isShown||o.default(this._element).off(yt)},e._setResizeEvent=function(){var t=this;this._isShown?o.default(window).on(_t,(function(e){return t.handleUpdate(e)})):o.default(window).off(_t)},e._hideModal=function(){var t=this;this._element.style.display="none",this._element.setAttribute("aria-hidden",!0),this._element.removeAttribute("aria-modal"),this._element.removeAttribute("role"),this._isTransitioning=!1,this._showBackdrop((function(){o.default(document.body).removeClass(ft),t._resetAdjustments(),t._resetScrollbar(),o.default(t._element).trigger(gt)}))},e._removeBackdrop=function(){this._backdrop&&(o.default(this._backdrop).remove(),this._backdrop=null)},e._showBackdrop=function(t){var e=this,n=o.default(this._element).hasClass(dt)?dt:"";if(this._isShown&&this._config.backdrop){if(this._backdrop=document.createElement("div"),this._backdrop.className="modal-backdrop",n&&this._backdrop.classList.add(n),o.default(this._backdrop).appendTo(document.body),o.default(this._element).on(vt,(function(t){e._ignoreBackdropClick?e._ignoreBackdropClick=!1:t.target===t.currentTarget&&("static"===e._config.backdrop?e._triggerBackdropTransition():e.hide())})),n&&d.reflow(this._backdrop),o.default(this._backdrop).addClass(ct),!t)return;if(!n)return void t();var i=d.getTransitionDurationFromElement(this._backdrop);o.default(this._backdrop).one(d.TRANSITION_END,t).emulateTransitionEnd(i)}else if(!this._isShown&&this._backdrop){o.default(this._backdrop).removeClass(ct);var a=function(){e._removeBackdrop(),t&&t()};if(o.default(this._element).hasClass(dt)){var s=d.getTransitionDurationFromElement(this._backdrop);o.default(this._backdrop).one(d.TRANSITION_END,a).emulateTransitionEnd(s)}else a()}else t&&t()},e._adjustDialog=function(){var t=this._element.scrollHeight>document.documentElement.clientHeight;!this._isBodyOverflowing&&t&&(this._element.style.paddingLeft=this._scrollbarWidth+"px"),this._isBodyOverflowing&&!t&&(this._element.style.paddingRight=this._scrollbarWidth+"px")},e._resetAdjustments=function(){this._element.style.paddingLeft="",this._element.style.paddingRight=""},e._checkScrollbar=function(){var t=document.body.getBoundingClientRect();this._isBodyOverflowing=Math.round(t.left+t.right)
',trigger:"hover focus",title:"",delay:0,html:!1,selector:!1,placement:"top",offset:0,container:!1,fallbackPlacement:"flip",boundary:"scrollParent",customClass:"",sanitize:!0,sanitizeFn:null,whiteList:{"*":["class","dir","id","lang","role",/^aria-[\w-]*$/i],a:["target","href","title","rel"],area:[],b:[],br:[],col:[],code:[],div:[],em:[],hr:[],h1:[],h2:[],h3:[],h4:[],h5:[],h6:[],i:[],img:["src","srcset","alt","title","width","height"],li:[],ol:[],p:[],pre:[],s:[],small:[],span:[],sub:[],sup:[],strong:[],u:[],ul:[]},popperConfig:null},Ut={animation:"boolean",template:"string",title:"(string|element|function)",trigger:"string",delay:"(number|object)",html:"boolean",selector:"(string|boolean)",placement:"(string|function)",offset:"(number|string|function)",container:"(string|element|boolean)",fallbackPlacement:"(string|array)",boundary:"(string|element)",customClass:"(string|function)",sanitize:"boolean",sanitizeFn:"(null|function)",whiteList:"object",popperConfig:"(null|object)"},Mt={HIDE:"hide.bs.tooltip",HIDDEN:"hidden.bs.tooltip",SHOW:"show.bs.tooltip",SHOWN:"shown.bs.tooltip",INSERTED:"inserted.bs.tooltip",CLICK:"click.bs.tooltip",FOCUSIN:"focusin.bs.tooltip",FOCUSOUT:"focusout.bs.tooltip",MOUSEENTER:"mouseenter.bs.tooltip",MOUSELEAVE:"mouseleave.bs.tooltip"},Wt=function(){function t(t,e){if("undefined"==typeof a.default)throw new TypeError("Bootstrap's tooltips require Popper (https://popper.js.org)");this._isEnabled=!0,this._timeout=0,this._hoverState="",this._activeTrigger={},this._popper=null,this.element=t,this.config=this._getConfig(e),this.tip=null,this._setListeners()}var e=t.prototype;return e.enable=function(){this._isEnabled=!0},e.disable=function(){this._isEnabled=!1},e.toggleEnabled=function(){this._isEnabled=!this._isEnabled},e.toggle=function(t){if(this._isEnabled)if(t){var e=this.constructor.DATA_KEY,n=o.default(t.currentTarget).data(e);n||(n=new this.constructor(t.currentTarget,this._getDelegateConfig()),o.default(t.currentTarget).data(e,n)),n._activeTrigger.click=!n._activeTrigger.click,n._isWithActiveTrigger()?n._enter(null,n):n._leave(null,n)}else{if(o.default(this.getTipElement()).hasClass(Rt))return void this._leave(null,this);this._enter(null,this)}},e.dispose=function(){clearTimeout(this._timeout),o.default.removeData(this.element,this.constructor.DATA_KEY),o.default(this.element).off(this.constructor.EVENT_KEY),o.default(this.element).closest(".modal").off("hide.bs.modal",this._hideModalHandler),this.tip&&o.default(this.tip).remove(),this._isEnabled=null,this._timeout=null,this._hoverState=null,this._activeTrigger=null,this._popper&&this._popper.destroy(),this._popper=null,this.element=null,this.config=null,this.tip=null},e.show=function(){var t=this;if("none"===o.default(this.element).css("display"))throw new Error("Please use show on visible elements");var e=o.default.Event(this.constructor.Event.SHOW);if(this.isWithContent()&&this._isEnabled){o.default(this.element).trigger(e);var n=d.findShadowRoot(this.element),i=o.default.contains(null!==n?n:this.element.ownerDocument.documentElement,this.element);if(e.isDefaultPrevented()||!i)return;var s=this.getTipElement(),l=d.getUID(this.constructor.NAME);s.setAttribute("id",l),this.element.setAttribute("aria-describedby",l),this.setContent(),this.config.animation&&o.default(s).addClass(Lt);var r="function"==typeof this.config.placement?this.config.placement.call(this,s,this.element):this.config.placement,u=this._getAttachment(r);this.addAttachmentClass(u);var f=this._getContainer();o.default(s).data(this.constructor.DATA_KEY,this),o.default.contains(this.element.ownerDocument.documentElement,this.tip)||o.default(s).appendTo(f),o.default(this.element).trigger(this.constructor.Event.INSERTED),this._popper=new a.default(this.element,s,this._getPopperConfig(u)),o.default(s).addClass(Rt),o.default(s).addClass(this.config.customClass),"ontouchstart"in document.documentElement&&o.default(document.body).children().on("mouseover",null,o.default.noop);var c=function(){t.config.animation&&t._fixTransition();var e=t._hoverState;t._hoverState=null,o.default(t.element).trigger(t.constructor.Event.SHOWN),e===qt&&t._leave(null,t)};if(o.default(this.tip).hasClass(Lt)){var h=d.getTransitionDurationFromElement(this.tip);o.default(this.tip).one(d.TRANSITION_END,c).emulateTransitionEnd(h)}else c()}},e.hide=function(t){var e=this,n=this.getTipElement(),i=o.default.Event(this.constructor.Event.HIDE),a=function(){e._hoverState!==xt&&n.parentNode&&n.parentNode.removeChild(n),e._cleanTipClass(),e.element.removeAttribute("aria-describedby"),o.default(e.element).trigger(e.constructor.Event.HIDDEN),null!==e._popper&&e._popper.destroy(),t&&t()};if(o.default(this.element).trigger(i),!i.isDefaultPrevented()){if(o.default(n).removeClass(Rt),"ontouchstart"in document.documentElement&&o.default(document.body).children().off("mouseover",null,o.default.noop),this._activeTrigger.click=!1,this._activeTrigger.focus=!1,this._activeTrigger.hover=!1,o.default(this.tip).hasClass(Lt)){var s=d.getTransitionDurationFromElement(n);o.default(n).one(d.TRANSITION_END,a).emulateTransitionEnd(s)}else a();this._hoverState=""}},e.update=function(){null!==this._popper&&this._popper.scheduleUpdate()},e.isWithContent=function(){return Boolean(this.getTitle())},e.addAttachmentClass=function(t){o.default(this.getTipElement()).addClass("bs-tooltip-"+t)},e.getTipElement=function(){return this.tip=this.tip||o.default(this.config.template)[0],this.tip},e.setContent=function(){var t=this.getTipElement();this.setElementContent(o.default(t.querySelectorAll(".tooltip-inner")),this.getTitle()),o.default(t).removeClass("fade show")},e.setElementContent=function(t,e){"object"!=typeof e||!e.nodeType&&!e.jquery?this.config.html?(this.config.sanitize&&(e=At(e,this.config.whiteList,this.config.sanitizeFn)),t.html(e)):t.text(e):this.config.html?o.default(e).parent().is(t)||t.empty().append(e):t.text(o.default(e).text())},e.getTitle=function(){var t=this.element.getAttribute("data-original-title");return t||(t="function"==typeof this.config.title?this.config.title.call(this.element):this.config.title),t},e._getPopperConfig=function(t){var e=this;return r({},{placement:t,modifiers:{offset:this._getOffset(),flip:{behavior:this.config.fallbackPlacement},arrow:{element:".arrow"},preventOverflow:{boundariesElement:this.config.boundary}},onCreate:function(t){t.originalPlacement!==t.placement&&e._handlePopperPlacementChange(t)},onUpdate:function(t){return e._handlePopperPlacementChange(t)}},this.config.popperConfig)},e._getOffset=function(){var t=this,e={};return"function"==typeof this.config.offset?e.fn=function(e){return e.offsets=r({},e.offsets,t.config.offset(e.offsets,t.element)),e}:e.offset=this.config.offset,e},e._getContainer=function(){return!1===this.config.container?document.body:d.isElement(this.config.container)?o.default(this.config.container):o.default(document).find(this.config.container)},e._getAttachment=function(t){return Bt[t.toUpperCase()]},e._setListeners=function(){var t=this;this.config.trigger.split(" ").forEach((function(e){if("click"===e)o.default(t.element).on(t.constructor.Event.CLICK,t.config.selector,(function(e){return t.toggle(e)}));else if("manual"!==e){var n=e===Ft?t.constructor.Event.MOUSEENTER:t.constructor.Event.FOCUSIN,i=e===Ft?t.constructor.Event.MOUSELEAVE:t.constructor.Event.FOCUSOUT;o.default(t.element).on(n,t.config.selector,(function(e){return t._enter(e)})).on(i,t.config.selector,(function(e){return t._leave(e)}))}})),this._hideModalHandler=function(){t.element&&t.hide()},o.default(this.element).closest(".modal").on("hide.bs.modal",this._hideModalHandler),this.config.selector?this.config=r({},this.config,{trigger:"manual",selector:""}):this._fixTitle()},e._fixTitle=function(){var t=typeof this.element.getAttribute("data-original-title");(this.element.getAttribute("title")||"string"!==t)&&(this.element.setAttribute("data-original-title",this.element.getAttribute("title")||""),this.element.setAttribute("title",""))},e._enter=function(t,e){var n=this.constructor.DATA_KEY;(e=e||o.default(t.currentTarget).data(n))||(e=new this.constructor(t.currentTarget,this._getDelegateConfig()),o.default(t.currentTarget).data(n,e)),t&&(e._activeTrigger["focusin"===t.type?Qt:Ft]=!0),o.default(e.getTipElement()).hasClass(Rt)||e._hoverState===xt?e._hoverState=xt:(clearTimeout(e._timeout),e._hoverState=xt,e.config.delay&&e.config.delay.show?e._timeout=setTimeout((function(){e._hoverState===xt&&e.show()}),e.config.delay.show):e.show())},e._leave=function(t,e){var n=this.constructor.DATA_KEY;(e=e||o.default(t.currentTarget).data(n))||(e=new this.constructor(t.currentTarget,this._getDelegateConfig()),o.default(t.currentTarget).data(n,e)),t&&(e._activeTrigger["focusout"===t.type?Qt:Ft]=!1),e._isWithActiveTrigger()||(clearTimeout(e._timeout),e._hoverState=qt,e.config.delay&&e.config.delay.hide?e._timeout=setTimeout((function(){e._hoverState===qt&&e.hide()}),e.config.delay.hide):e.hide())},e._isWithActiveTrigger=function(){for(var t in this._activeTrigger)if(this._activeTrigger[t])return!0;return!1},e._getConfig=function(t){var e=o.default(this.element).data();return Object.keys(e).forEach((function(t){-1!==Pt.indexOf(t)&&delete e[t]})),"number"==typeof(t=r({},this.constructor.Default,e,"object"==typeof t&&t?t:{})).delay&&(t.delay={show:t.delay,hide:t.delay}),"number"==typeof t.title&&(t.title=t.title.toString()),"number"==typeof t.content&&(t.content=t.content.toString()),d.typeCheckConfig(It,t,this.constructor.DefaultType),t.sanitize&&(t.template=At(t.template,t.whiteList,t.sanitizeFn)),t},e._getDelegateConfig=function(){var t={};if(this.config)for(var e in this.config)this.constructor.Default[e]!==this.config[e]&&(t[e]=this.config[e]);return t},e._cleanTipClass=function(){var t=o.default(this.getTipElement()),e=t.attr("class").match(jt);null!==e&&e.length&&t.removeClass(e.join(""))},e._handlePopperPlacementChange=function(t){this.tip=t.instance.popper,this._cleanTipClass(),this.addAttachmentClass(this._getAttachment(t.placement))},e._fixTransition=function(){var t=this.getTipElement(),e=this.config.animation;null===t.getAttribute("x-placement")&&(o.default(t).removeClass(Lt),this.config.animation=!1,this.hide(),this.show(),this.config.animation=e)},t._jQueryInterface=function(e){return this.each((function(){var n=o.default(this),i=n.data(kt),a="object"==typeof e&&e;if((i||!/dispose|hide/.test(e))&&(i||(i=new t(this,a),n.data(kt,i)),"string"==typeof e)){if("undefined"==typeof i[e])throw new TypeError('No method named "'+e+'"');i[e]()}}))},l(t,null,[{key:"VERSION",get:function(){return"4.6.1"}},{key:"Default",get:function(){return Ht}},{key:"NAME",get:function(){return It}},{key:"DATA_KEY",get:function(){return kt}},{key:"Event",get:function(){return Mt}},{key:"EVENT_KEY",get:function(){return".bs.tooltip"}},{key:"DefaultType",get:function(){return Ut}}]),t}();o.default.fn.tooltip=Wt._jQueryInterface,o.default.fn.tooltip.Constructor=Wt,o.default.fn.tooltip.noConflict=function(){return o.default.fn.tooltip=Ot,Wt._jQueryInterface};var Vt="bs.popover",zt=o.default.fn.popover,Kt=new RegExp("(^|\\s)bs-popover\\S+","g"),Xt=r({},Wt.Default,{placement:"right",trigger:"click",content:"",template:''}),Yt=r({},Wt.DefaultType,{content:"(string|element|function)"}),$t={HIDE:"hide.bs.popover",HIDDEN:"hidden.bs.popover",SHOW:"show.bs.popover",SHOWN:"shown.bs.popover",INSERTED:"inserted.bs.popover",CLICK:"click.bs.popover",FOCUSIN:"focusin.bs.popover",FOCUSOUT:"focusout.bs.popover",MOUSEENTER:"mouseenter.bs.popover",MOUSELEAVE:"mouseleave.bs.popover"},Jt=function(t){var e,n;function i(){return t.apply(this,arguments)||this}n=t,(e=i).prototype=Object.create(n.prototype),e.prototype.constructor=e,u(e,n);var a=i.prototype;return a.isWithContent=function(){return this.getTitle()||this._getContent()},a.addAttachmentClass=function(t){o.default(this.getTipElement()).addClass("bs-popover-"+t)},a.getTipElement=function(){return this.tip=this.tip||o.default(this.config.template)[0],this.tip},a.setContent=function(){var t=o.default(this.getTipElement());this.setElementContent(t.find(".popover-header"),this.getTitle());var e=this._getContent();"function"==typeof e&&(e=e.call(this.element)),this.setElementContent(t.find(".popover-body"),e),t.removeClass("fade show")},a._getContent=function(){return this.element.getAttribute("data-content")||this.config.content},a._cleanTipClass=function(){var t=o.default(this.getTipElement()),e=t.attr("class").match(Kt);null!==e&&e.length>0&&t.removeClass(e.join(""))},i._jQueryInterface=function(t){return this.each((function(){var e=o.default(this).data(Vt),n="object"==typeof t?t:null;if((e||!/dispose|hide/.test(t))&&(e||(e=new i(this,n),o.default(this).data(Vt,e)),"string"==typeof t)){if("undefined"==typeof e[t])throw new TypeError('No method named "'+t+'"');e[t]()}}))},l(i,null,[{key:"VERSION",get:function(){return"4.6.1"}},{key:"Default",get:function(){return Xt}},{key:"NAME",get:function(){return"popover"}},{key:"DATA_KEY",get:function(){return Vt}},{key:"Event",get:function(){return $t}},{key:"EVENT_KEY",get:function(){return".bs.popover"}},{key:"DefaultType",get:function(){return Yt}}]),i}(Wt);o.default.fn.popover=Jt._jQueryInterface,o.default.fn.popover.Constructor=Jt,o.default.fn.popover.noConflict=function(){return o.default.fn.popover=zt,Jt._jQueryInterface};var Gt="scrollspy",Zt="bs.scrollspy",te=o.default.fn[Gt],ee="active",ne="position",ie=".nav, .list-group",oe={offset:10,method:"auto",target:""},ae={offset:"number",method:"string",target:"(string|element)"},se=function(){function t(t,e){var n=this;this._element=t,this._scrollElement="BODY"===t.tagName?window:t,this._config=this._getConfig(e),this._selector=this._config.target+" .nav-link,"+this._config.target+" .list-group-item,"+this._config.target+" .dropdown-item",this._offsets=[],this._targets=[],this._activeTarget=null,this._scrollHeight=0,o.default(this._scrollElement).on("scroll.bs.scrollspy",(function(t){return n._process(t)})),this.refresh(),this._process()}var e=t.prototype;return e.refresh=function(){var t=this,e=this._scrollElement===this._scrollElement.window?"offset":ne,n="auto"===this._config.method?e:this._config.method,i=n===ne?this._getScrollTop():0;this._offsets=[],this._targets=[],this._scrollHeight=this._getScrollHeight(),[].slice.call(document.querySelectorAll(this._selector)).map((function(t){var e,a=d.getSelectorFromElement(t);if(a&&(e=document.querySelector(a)),e){var s=e.getBoundingClientRect();if(s.width||s.height)return[o.default(e)[n]().top+i,a]}return null})).filter((function(t){return t})).sort((function(t,e){return t[0]-e[0]})).forEach((function(e){t._offsets.push(e[0]),t._targets.push(e[1])}))},e.dispose=function(){o.default.removeData(this._element,Zt),o.default(this._scrollElement).off(".bs.scrollspy"),this._element=null,this._scrollElement=null,this._config=null,this._selector=null,this._offsets=null,this._targets=null,this._activeTarget=null,this._scrollHeight=null},e._getConfig=function(t){if("string"!=typeof(t=r({},oe,"object"==typeof t&&t?t:{})).target&&d.isElement(t.target)){var e=o.default(t.target).attr("id");e||(e=d.getUID(Gt),o.default(t.target).attr("id",e)),t.target="#"+e}return d.typeCheckConfig(Gt,t,ae),t},e._getScrollTop=function(){return this._scrollElement===window?this._scrollElement.pageYOffset:this._scrollElement.scrollTop},e._getScrollHeight=function(){return this._scrollElement.scrollHeight||Math.max(document.body.scrollHeight,document.documentElement.scrollHeight)},e._getOffsetHeight=function(){return this._scrollElement===window?window.innerHeight:this._scrollElement.getBoundingClientRect().height},e._process=function(){var t=this._getScrollTop()+this._config.offset,e=this._getScrollHeight(),n=this._config.offset+e-this._getOffsetHeight();if(this._scrollHeight!==e&&this.refresh(),t>=n){var i=this._targets[this._targets.length-1];this._activeTarget!==i&&this._activate(i)}else{if(this._activeTarget&&t0)return this._activeTarget=null,void this._clear();for(var o=this._offsets.length;o--;)this._activeTarget!==this._targets[o]&&t>=this._offsets[o]&&("undefined"==typeof this._offsets[o+1]||t li > .active",ge=function(){function t(t){this._element=t}var e=t.prototype;return e.show=function(){var t=this;if(!(this._element.parentNode&&this._element.parentNode.nodeType===Node.ELEMENT_NODE&&o.default(this._element).hasClass(ue)||o.default(this._element).hasClass("disabled"))){var e,n,i=o.default(this._element).closest(".nav, .list-group")[0],a=d.getSelectorFromElement(this._element);if(i){var s="UL"===i.nodeName||"OL"===i.nodeName?he:ce;n=(n=o.default.makeArray(o.default(i).find(s)))[n.length-1]}var l=o.default.Event("hide.bs.tab",{relatedTarget:this._element}),r=o.default.Event("show.bs.tab",{relatedTarget:n});if(n&&o.default(n).trigger(l),o.default(this._element).trigger(r),!r.isDefaultPrevented()&&!l.isDefaultPrevented()){a&&(e=document.querySelector(a)),this._activate(this._element,i);var u=function(){var e=o.default.Event("hidden.bs.tab",{relatedTarget:t._element}),i=o.default.Event("shown.bs.tab",{relatedTarget:n});o.default(n).trigger(e),o.default(t._element).trigger(i)};e?this._activate(e,e.parentNode,u):u()}}},e.dispose=function(){o.default.removeData(this._element,le),this._element=null},e._activate=function(t,e,n){var i=this,a=(!e||"UL"!==e.nodeName&&"OL"!==e.nodeName?o.default(e).children(ce):o.default(e).find(he))[0],s=n&&a&&o.default(a).hasClass(fe),l=function(){return i._transitionComplete(t,a,n)};if(a&&s){var r=d.getTransitionDurationFromElement(a);o.default(a).removeClass(de).one(d.TRANSITION_END,l).emulateTransitionEnd(r)}else l()},e._transitionComplete=function(t,e,n){if(e){o.default(e).removeClass(ue);var i=o.default(e.parentNode).find("> .dropdown-menu .active")[0];i&&o.default(i).removeClass(ue),"tab"===e.getAttribute("role")&&e.setAttribute("aria-selected",!1)}o.default(t).addClass(ue),"tab"===t.getAttribute("role")&&t.setAttribute("aria-selected",!0),d.reflow(t),t.classList.contains(fe)&&t.classList.add(de);var a=t.parentNode;if(a&&"LI"===a.nodeName&&(a=a.parentNode),a&&o.default(a).hasClass("dropdown-menu")){var s=o.default(t).closest(".dropdown")[0];if(s){var l=[].slice.call(s.querySelectorAll(".dropdown-toggle"));o.default(l).addClass(ue)}t.setAttribute("aria-expanded",!0)}n&&n()},t._jQueryInterface=function(e){return this.each((function(){var n=o.default(this),i=n.data(le);if(i||(i=new t(this),n.data(le,i)),"string"==typeof e){if("undefined"==typeof i[e])throw new TypeError('No method named "'+e+'"');i[e]()}}))},l(t,null,[{key:"VERSION",get:function(){return"4.6.1"}}]),t}();o.default(document).on("click.bs.tab.data-api",'[data-toggle="tab"], [data-toggle="pill"], [data-toggle="list"]',(function(t){t.preventDefault(),ge._jQueryInterface.call(o.default(this),"show")})),o.default.fn.tab=ge._jQueryInterface,o.default.fn.tab.Constructor=ge,o.default.fn.tab.noConflict=function(){return o.default.fn.tab=re,ge._jQueryInterface};var me="bs.toast",pe=o.default.fn.toast,_e="hide",ve="show",ye="showing",be="click.dismiss.bs.toast",Ee={animation:!0,autohide:!0,delay:500},Te={animation:"boolean",autohide:"boolean",delay:"number"},we=function(){function t(t,e){this._element=t,this._config=this._getConfig(e),this._timeout=null,this._setListeners()}var e=t.prototype;return e.show=function(){var t=this,e=o.default.Event("show.bs.toast");if(o.default(this._element).trigger(e),!e.isDefaultPrevented()){this._clearTimeout(),this._config.animation&&this._element.classList.add("fade");var n=function(){t._element.classList.remove(ye),t._element.classList.add(ve),o.default(t._element).trigger("shown.bs.toast"),t._config.autohide&&(t._timeout=setTimeout((function(){t.hide()}),t._config.delay))};if(this._element.classList.remove(_e),d.reflow(this._element),this._element.classList.add(ye),this._config.animation){var i=d.getTransitionDurationFromElement(this._element);o.default(this._element).one(d.TRANSITION_END,n).emulateTransitionEnd(i)}else n()}},e.hide=function(){if(this._element.classList.contains(ve)){var t=o.default.Event("hide.bs.toast");o.default(this._element).trigger(t),t.isDefaultPrevented()||this._close()}},e.dispose=function(){this._clearTimeout(),this._element.classList.contains(ve)&&this._element.classList.remove(ve),o.default(this._element).off(be),o.default.removeData(this._element,me),this._element=null,this._config=null},e._getConfig=function(t){return t=r({},Ee,o.default(this._element).data(),"object"==typeof t&&t?t:{}),d.typeCheckConfig("toast",t,this.constructor.DefaultType),t},e._setListeners=function(){var t=this;o.default(this._element).on(be,'[data-dismiss="toast"]',(function(){return t.hide()}))},e._close=function(){var t=this,e=function(){t._element.classList.add(_e),o.default(t._element).trigger("hidden.bs.toast")};if(this._element.classList.remove(ve),this._config.animation){var n=d.getTransitionDurationFromElement(this._element);o.default(this._element).one(d.TRANSITION_END,e).emulateTransitionEnd(n)}else e()},e._clearTimeout=function(){clearTimeout(this._timeout),this._timeout=null},t._jQueryInterface=function(e){return this.each((function(){var n=o.default(this),i=n.data(me);if(i||(i=new t(this,"object"==typeof e&&e),n.data(me,i)),"string"==typeof e){if("undefined"==typeof i[e])throw new TypeError('No method named "'+e+'"');i[e](this)}}))},l(t,null,[{key:"VERSION",get:function(){return"4.6.1"}},{key:"DefaultType",get:function(){return Te}},{key:"Default",get:function(){return Ee}}]),t}();o.default.fn.toast=we._jQueryInterface,o.default.fn.toast.Constructor=we,o.default.fn.toast.noConflict=function(){return o.default.fn.toast=pe,we._jQueryInterface},t.Alert=g,t.Button=E,t.Carousel=P,t.Collapse=V,t.Dropdown=lt,t.Modal=Ct,t.Popover=Jt,t.Scrollspy=se,t.Tab=ge,t.Toast=we,t.Tooltip=Wt,t.Util=d,Object.defineProperty(t,"__esModule",{value:!0})})); +//# sourceMappingURL=bootstrap.min.js.map +/*! jsTree - v3.3.16 - 2023-09-19 - (MIT) */ + +!function(e){"use strict";"function"==typeof define&&define.amd?define(["jquery"],e):"undefined"!=typeof module&&module.exports?module.exports=e(require("jquery")):e(jQuery)}(function(E,P){"use strict";if(!E.jstree){var s=0,a=!1,n=!1,o=!1,r=[],e=E("script:last").attr("src"),b=window.document,c=window.setImmediate,i=window.Promise;!c&&i&&(c=function(e,t){i.resolve(t).then(e)}),E.jstree={version:"3.3.16",defaults:{plugins:[]},plugins:{},path:e&&-1!==e.indexOf("/")?e.replace(/\/[^\/]+$/,""):"",idregex:/[\\:&!^|()\[\]<>@*'+~#";.,=\- \/${}%?`]/g,root:"#"},E.jstree.create=function(e,i){var r=new E.jstree.core(++s),t=i;return i=E.extend(!0,{},E.jstree.defaults,i),t&&t.plugins&&(i.plugins=t.plugins),E.each(i.plugins,function(e,t){"core"!==e&&(r=r.plugin(t,i[t]))}),E(e).data("jstree",r),r.init(e,i),r},E.jstree.destroy=function(){E(".jstree:jstree").jstree("destroy"),E(b).off(".jstree")},E.jstree.core=function(e){this._id=e,this._cnt=0,this._wrk=null,this._data={core:{themes:{name:!1,dots:!1,icons:!1,ellipsis:!1},selected:[],last_error:{},working:!1,worker_queue:[],focused:null}}},E.jstree.reference=function(t){var i=null,e=null;if(!t||!t.id||t.tagName&&t.nodeType||(t=t.id),!e||!e.length)try{e=E(t)}catch(e){}if(!e||!e.length)try{e=E("#"+t.replace(E.jstree.idregex,"\\$&"))}catch(e){}return e&&e.length&&(e=e.closest(".jstree")).length&&(e=e.data("jstree"))?i=e:E(".jstree").each(function(){var e=E(this).data("jstree");if(e&&e._model.data[t])return i=e,!1}),i},E.fn.jstree=function(i){var r="string"==typeof i,s=Array.prototype.slice.call(arguments,1),a=null;return!(!0===i&&!this.length)&&(this.each(function(){var e=E.jstree.reference(this),t=r&&e?e[i]:null;if(a=r&&t?t.apply(e,s):null,e||r||i!==P&&!E.isPlainObject(i)||E.jstree.create(this,i),null!==(a=e&&!r||!0===i?e||!1:a)&&a!==P)return!1}),null!==a&&a!==P?a:this)},E.expr.pseudos.jstree=E.expr.createPseudo(function(e){return function(e){return E(e).hasClass("jstree")&&E(e).data("jstree")!==P}}),E.jstree.defaults.core={data:!1,strings:!1,check_callback:!1,error:E.noop,animation:200,multiple:!0,themes:{name:!1,url:!1,dir:!1,dots:!0,icons:!0,ellipsis:!1,stripes:!1,variant:!1,responsive:!1},expand_selected_onload:!0,worker:!0,force_text:!1,dblclick_toggle:!0,loaded_state:!1,restore_focus:!0,compute_elements_positions:!1,keyboard:{"ctrl-space":function(e){e.type="click",E(e.currentTarget).trigger(e)},enter:function(e){e.type="click",E(e.currentTarget).trigger(e)},left:function(e){var e;e.preventDefault(),this.is_open(e.currentTarget)?this.close_node(e.currentTarget):(e=this.get_parent(e.currentTarget))&&e.id!==E.jstree.root&&this.get_node(e,!0).children(".jstree-anchor").trigger("focus")},up:function(e){e.preventDefault();var e=this.get_prev_dom(e.currentTarget);e&&e.length&&e.children(".jstree-anchor").trigger("focus")},right:function(e){var e;e.preventDefault(),this.is_closed(e.currentTarget)?this.open_node(e.currentTarget,function(e){this.get_node(e,!0).children(".jstree-anchor").trigger("focus")}):!this.is_open(e.currentTarget)||(e=this.get_node(e.currentTarget,!0).children(".jstree-children")[0])&&E(this._firstChild(e)).children(".jstree-anchor").trigger("focus")},down:function(e){e.preventDefault();var e=this.get_next_dom(e.currentTarget);e&&e.length&&e.children(".jstree-anchor").trigger("focus")},"*":function(e){this.open_all()},home:function(e){e.preventDefault();var e=this._firstChild(this.get_container_ul()[0]);e&&E(e).children(".jstree-anchor").filter(":visible").trigger("focus")},end:function(e){e.preventDefault(),this.element.find(".jstree-anchor").filter(":visible").last().trigger("focus")},f2:function(e){e.preventDefault(),this.edit(e.currentTarget)}},allow_reselect:!1},E.jstree.core.prototype={plugin:function(e,t){var i=E.jstree.plugins[e];return i?(this._data[e]={},i.prototype=this,new i(t,this)):this},init:function(e,t){this._model={data:{},changed:[],force_full_redraw:!1,redraw_timeout:!1,default_state:{loaded:!0,opened:!1,selected:!1,disabled:!1}},this._model.data[E.jstree.root]={id:E.jstree.root,parent:null,parents:[],children:[],children_d:[],state:{loaded:!1}},this.element=E(e).addClass("jstree jstree-"+this._id),this.settings=t,this._data.core.ready=!1,this._data.core.loaded=!1,this._data.core.rtl="rtl"===this.element.css("direction"),this.element[this._data.core.rtl?"addClass":"removeClass"]("jstree-rtl"),this.element.attr("role","tree"),this.settings.core.multiple&&this.element.attr("aria-multiselectable",!0),this.element.attr("tabindex")||this.element.attr("tabindex","0"),this.bind(),this.trigger("init"),this._data.core.original_container_html=this.element.find(" > ul > li").clone(!0),this._data.core.original_container_html.find("li").addBack().contents().filter(function(){return 3===this.nodeType&&(!this.nodeValue||/^\s+$/.test(this.nodeValue))}).remove(),this.element.html(""),this.element.attr("aria-activedescendant","j"+this._id+"_loading"),this._data.core.li_height=this.get_container_ul().children("li").first().outerHeight()||24,this._data.core.node=this._create_prototype_node(),this.trigger("loading"),this.load_node(E.jstree.root)},destroy:function(e){if(this.trigger("destroy"),this._wrk)try{window.URL.revokeObjectURL(this._wrk),this._wrk=null}catch(e){}e||this.element.empty(),this.teardown()},_create_prototype_node:function(){var e=b.createElement("LI"),t,i;return e.setAttribute("role","none"),(t=b.createElement("I")).className="jstree-icon jstree-ocl",t.setAttribute("role","presentation"),e.appendChild(t),(t=b.createElement("A")).className="jstree-anchor",t.setAttribute("href","#"),t.setAttribute("tabindex","-1"),t.setAttribute("role","treeitem"),(i=b.createElement("I")).className="jstree-icon jstree-themeicon",i.setAttribute("role","presentation"),t.appendChild(i),e.appendChild(t),t=i=null,e},_kbevent_to_func:function(e){var t={8:"Backspace",9:"Tab",13:"Enter",19:"Pause",27:"Esc",32:"Space",33:"PageUp",34:"PageDown",35:"End",36:"Home",37:"Left",38:"Up",39:"Right",40:"Down",44:"Print",45:"Insert",46:"Delete",96:"Numpad0",97:"Numpad1",98:"Numpad2",99:"Numpad3",100:"Numpad4",101:"Numpad5",102:"Numpad6",103:"Numpad7",104:"Numpad8",105:"Numpad9","-13":"NumpadEnter",112:"F1",113:"F2",114:"F3",115:"F4",116:"F5",117:"F6",118:"F7",119:"F8",120:"F9",121:"F10",122:"F11",123:"F12",144:"Numlock",145:"Scrolllock",16:"Shift",17:"Ctrl",18:"Alt",48:"0",49:"1",50:"2",51:"3",52:"4",53:"5",54:"6",55:"7",56:"8",57:"9",59:";",61:"=",65:"a",66:"b",67:"c",68:"d",69:"e",70:"f",71:"g",72:"h",73:"i",74:"j",75:"k",76:"l",77:"m",78:"n",79:"o",80:"p",81:"q",82:"r",83:"s",84:"t",85:"u",86:"v",87:"w",88:"x",89:"y",90:"z",107:"+",109:"-",110:".",186:";",187:"=",188:",",189:"-",190:".",191:"/",192:"`",219:"[",220:"\\",221:"]",222:"'",111:"/",106:"*",173:"-"},i=[];if(e.ctrlKey&&i.push("ctrl"),e.altKey&&i.push("alt"),e.shiftKey&&i.push("shift"),i.push(t[e.which]?t[e.which].toLowerCase():e.which),"shift-shift"===(i=i.sort().join("-").toLowerCase())||"ctrl-ctrl"===i||"alt-alt"===i)return null;var r=this.settings.core.keyboard,s,a;for(s in r)if(r.hasOwnProperty(s)&&(a="-"!==(a=s)&&"+"!==a?(a=a.replace("--","-MINUS").replace("+-","-MINUS").replace("++","-PLUS").replace("-+","-PLUS")).split(/-|\+/).sort().join("-").replace("MINUS","-").replace("PLUS","+").toLowerCase():a)===i)return r[s];return null},teardown:function(){this.unbind(),this.element.removeClass("jstree").removeData("jstree").find("[class^='jstree']").addBack().attr("class",function(){return this.className.replace(/jstree[^ ]*|$/gi,"")}),this.element=null},bind:function(){var s="",a=null,t=0;this.element.on("dblclick.jstree",function(e){if(e.target.tagName&&"input"===e.target.tagName.toLowerCase())return!0;if(b.selection&&b.selection.empty)b.selection.empty();else if(window.getSelection){var e=window.getSelection();try{e.removeAllRanges(),e.collapse()}catch(e){}}}).on("mousedown.jstree",function(e){e.target===this.element[0]&&(e.preventDefault(),t=+new Date)}.bind(this)).on("mousedown.jstree",".jstree-ocl",function(e){e.preventDefault()}).on("click.jstree",".jstree-ocl",function(e){this.toggle_node(e.target)}.bind(this)).on("dblclick.jstree",".jstree-anchor",function(e){if(e.target.tagName&&"input"===e.target.tagName.toLowerCase())return!0;this.settings.core.dblclick_toggle&&this.toggle_node(e.target)}.bind(this)).on("click.jstree",".jstree-anchor",function(e){e.preventDefault(),e.currentTarget!==b.activeElement&&E(e.currentTarget).trigger("focus"),this.activate_node(e.currentTarget,e)}.bind(this)).on("keydown.jstree",".jstree-anchor",function(e){if(e.target.tagName&&"input"===e.target.tagName.toLowerCase())return!0;this._data.core.rtl&&(37===e.which?e.which=39:39===e.which&&(e.which=37));var t=this._kbevent_to_func(e);if(t){var e=t.call(this,e);if(!1===e||!0===e)return e}}.bind(this)).on("load_node.jstree",function(e,t){t.status&&(t.node.id!==E.jstree.root||this._data.core.loaded||(this._data.core.loaded=!0,this._firstChild(this.get_container_ul()[0])&&this.element.attr("aria-activedescendant",this._firstChild(this.get_container_ul()[0]).id),this.trigger("loaded")),this._data.core.ready||setTimeout(function(){if(this.element&&!this.get_container_ul().find(".jstree-loading").length){if(this._data.core.ready=!0,this._data.core.selected.length){if(this.settings.core.expand_selected_onload){for(var e=[],t,i,t=0,i=this._data.core.selected.length;t .jstree-anchor").trigger("focus"))}.bind(this)).on("mouseenter.jstree",".jstree-anchor",function(e){this.hover_node(e.currentTarget)}.bind(this)).on("mouseleave.jstree",".jstree-anchor",function(e){this.dehover_node(e.currentTarget)}.bind(this))},unbind:function(){this.element.off(".jstree"),E(b).off(".jstree-"+this._id)},trigger:function(e,t){((t=t||{}).instance=this).element.triggerHandler(e.replace(".jstree","")+".jstree",t)},get_container:function(){return this.element},get_container_ul:function(){return this.element.children(".jstree-children").first()},get_string:function(e){var t=this.settings.core.strings;return E.vakata.is_function(t)?t.call(this,e):t&&t[e]?t[e]:e},_firstChild:function(e){e=e?e.firstChild:null;while(null!==e&&1!==e.nodeType)e=e.nextSibling;return e},_nextSibling:function(e){e=e?e.nextSibling:null;while(null!==e&&1!==e.nodeType)e=e.nextSibling;return e},_previousSibling:function(e){e=e?e.previousSibling:null;while(null!==e&&1!==e.nodeType)e=e.previousSibling;return e},get_node:function(e,t){var i;(e=e&&(e.id||0===e.id)?e.id:e)instanceof E&&e.length&&e[0].id&&(e=e[0].id);try{if(this._model.data[e])e=this._model.data[e];else if("string"==typeof e&&this._model.data[e.replace(/^#/,"")])e=this._model.data[e.replace(/^#/,"")];else if("string"==typeof e&&(i=E("#"+e.replace(E.jstree.idregex,"\\$&"),this.element)).length&&this._model.data[i.closest(".jstree-node").attr("id")])e=this._model.data[i.closest(".jstree-node").attr("id")];else if((i=this.element.find(e)).length&&this._model.data[i.closest(".jstree-node").attr("id")])e=this._model.data[i.closest(".jstree-node").attr("id")];else{if(!(i=this.element.find(e)).length||!i.hasClass("jstree"))return!1;e=this._model.data[E.jstree.root]}return e=t?e.id===E.jstree.root?this.element:E("#"+e.id.replace(E.jstree.idregex,"\\$&"),this.element):e}catch(e){return!1}},get_path:function(e,t,i){if(!(e=e.parents?e:this.get_node(e))||e.id===E.jstree.root||!e.parents)return!1;var r,s,a=[];for(a.push(i?e.id:e.text),r=0,s=e.parents.length;r").html(t),n.text=this.settings.core.force_text?t.text():t.html(),t=e.data(),n.data=t?E.extend(!0,{},t):null,n.state.opened=e.hasClass("jstree-open"),n.state.selected=e.children("a").hasClass("jstree-clicked"),n.state.disabled=e.children("a").hasClass("jstree-disabled"),n.data&&n.data.jstree)for(o in n.data.jstree)n.data.jstree.hasOwnProperty(o)&&(n.state[o]=n.data.jstree[o]);(t=e.children("a").children(".jstree-themeicon")).length&&(n.icon=!t.hasClass("jstree-themeicon-hidden")&&t.attr("rel")),n.state.icon!==P&&(n.icon=n.state.icon),n.icon!==P&&null!==n.icon&&""!==n.icon||(n.icon=!0),t=e.children("ul").children("li");do{d="j"+this._id+"_"+ ++this._cnt}while(a[d]);return n.id=n.li_attr.id?n.li_attr.id.toString():d,t.length?(t.each(function(e,t){r=this._parse_model_from_html(E(t),n.id,i),s=this._model.data[r],n.children.push(r),s.children_d.length&&(n.children_d=n.children_d.concat(s.children_d))}.bind(this)),n.children_d=n.children_d.concat(n.children)):e.hasClass("jstree-closed")&&(n.state.loaded=!1),n.li_attr.class&&(n.li_attr.class=n.li_attr.class.replace("jstree-closed","").replace("jstree-open","")),n.a_attr.class&&(n.a_attr.class=n.a_attr.class.replace("jstree-clicked","").replace("jstree-disabled","")),(a[n.id]=n).state.selected&&this._data.core.selected.push(n.id),n.id},_parse_model_from_flat_json:function(e,t,i){i=i?i.concat():[],t&&i.unshift(t);var r=e.id.toString(),s=this._model.data,a=this._model.default_state,n,o,d,c,l={id:r,text:e.text||"",icon:e.icon===P||e.icon,parent:t,parents:i,children:e.children||[],children_d:e.children_d||[],data:e.data,state:{},li_attr:{id:!1},a_attr:{href:"#"},original:!1};for(n in a)a.hasOwnProperty(n)&&(l.state[n]=a[n]);if(e&&e.data&&e.data.jstree&&e.data.jstree.icon&&(l.icon=e.data.jstree.icon),l.icon!==P&&null!==l.icon&&""!==l.icon||(l.icon=!0),e&&e.data&&(l.data=e.data,e.data.jstree))for(n in e.data.jstree)e.data.jstree.hasOwnProperty(n)&&(l.state[n]=e.data.jstree[n]);if(e&&"object"==typeof e.state)for(n in e.state)e.state.hasOwnProperty(n)&&(l.state[n]=e.state[n]);if(e&&"object"==typeof e.li_attr)for(n in e.li_attr)e.li_attr.hasOwnProperty(n)&&(l.li_attr[n]=e.li_attr[n]);if(l.li_attr.id||(l.li_attr.id=r),e&&"object"==typeof e.a_attr)for(n in e.a_attr)e.a_attr.hasOwnProperty(n)&&(l.a_attr[n]=e.a_attr[n]);for(e&&e.children&&!0===e.children&&(l.state.loaded=!1,l.children=[],l.children_d=[]),n=0,o=(s[l.id]=l).children.length;n
  • "+this.get_string("Loading ...")+"
  • "),this.element.attr("aria-activedescendant","j"+this._id+"_loading")),this.load_node(E.jstree.root,function(e,t){t&&(this.get_container_ul()[0].className=i,this._firstChild(this.get_container_ul()[0])&&this.element.attr("aria-activedescendant",this._firstChild(this.get_container_ul()[0]).id),this.set_state(E.extend(!0,{},this._data.core.state),function(){this.trigger("refresh")})),this._data.core.state=null})},refresh_node:function(t){if(!(t=this.get_node(t))||t.id===E.jstree.root)return!1;var i=[],e=[],r=this._data.core.selected.concat([]);e.push(t.id),!0===t.state.opened&&i.push(t.id),this.get_node(t,!0).find(".jstree-open").each(function(){e.push(this.id),i.push(this.id)}),this._load_nodes(e,function(e){this.open_node(i,!1,0),this.select_node(r),this.trigger("refresh_node",{node:t,nodes:e})}.bind(this),!1,!0)},set_id:function(e,t){if(!(e=this.get_node(e))||e.id===E.jstree.root)return!1;var i,r,s=this._model.data,a=e.id;for(t=t.toString(),s[e.parent].children[E.inArray(e.id,s[e.parent].children)]=t,i=0,r=e.parents.length;ie.children.length&&(i=e.children.length),t.id===P&&(t.id=!0),!this.check("create_node",t,e,i))return this.settings.core.error.call(this,this._data.core.last_error),!1;if(!0===t.id&&delete t.id,!(t=this._parse_model_from_json(t,e.id,e.parents.concat())))return!1;for(a=this.get_node(t),(n=[]).push(t),n=n.concat(a.children_d),this.trigger("model",{nodes:n,parent:e.id}),e.children_d=e.children_d.concat(n),o=0,d=e.parents.length;oh.children.length&&(i=h.children.length),!this.check("move_node",e,h,i,{core:!0,origin:n,is_multi:_&&_._id&&_._id!==this._id,is_foreign:!_||!_._id}))return this.settings.core.error.call(this,this._data.core.last_error),!1;if(e.parent===h.id){for(u=h.children.concat(),-1!==(f=E.inArray(e.id,u))&&(u=E.vakata.array_remove(u,f),ff.children.length&&(i=f.children.length),!this.check("copy_node",e,f,i,{core:!0,origin:n,is_multi:p&&p._id&&p._id!==this._id,is_foreign:!p||!p._id}))return this.settings.core.error.call(this,this._data.core.last_error),!1;if(!(g=p?p.get_json(e,{no_id:!0,no_data:!0,no_state:!0}):e))return!1;if(!0===g.id&&delete g.id,!(g=this._parse_model_from_json(g,f.id,f.parents.concat())))return!1;for(l=this.get_node(g),e&&e.state&&!1===e.state.loaded&&(l.state.loaded=!1),(c=[]).push(g),c=c.concat(l.children_d),this.trigger("model",{nodes:c,parent:f.id}),h=0,_=f.parents.length;h<_;h++)this._model.data[f.parents[h]].children_d=this._model.data[f.parents[h]].children_d.concat(c);for(c=[],h=0,_=f.children.length;h<_;h++)c[i<=h?h+1:h]=f.children[h];return c[i]=l.id,f.children=c,f.children_d.push(l.id),f.children_d=f.children_d.concat(l.children_d),f.id===E.jstree.root&&(this._model.force_full_redraw=!0),this._model.force_full_redraw||this._node_changed(f.id),a||this.redraw(f.id===E.jstree.root),r&&r.call(this,l,f,i),this.trigger("copy_node",{node:l,original:e,parent:f.id,position:i,old_parent:u,old_position:p&&p._id&&u&&p._model.data[u]&&p._model.data[u].children?E.inArray(e.id,p._model.data[u].children):-1,is_multi:p&&p._id&&p._id!==this._id,is_foreign:!p||!p._id,old_instance:p,new_instance:this}),l.id},cut:function(e){if(e=e||this._data.core.selected.concat(),!(e=!E.vakata.is_array(e)?[e]:e).length)return!1;for(var t=[],i,r,s,r=0,s=e.length;r"),o=e,d=E("
    ",{css:{position:"absolute",top:"-200px",left:t?"0px":"-1000px",visibility:"hidden"}}).appendTo(b.body),c=E("",{value:o,class:"jstree-rename-input",css:{padding:"0",border:"1px solid silver","box-sizing":"border-box",display:"inline-block",height:this._data.core.li_height+"px",lineHeight:this._data.core.li_height+"px",width:"150px"},blur:function(e){e.stopImmediatePropagation(),e.preventDefault();var t,i=n.children(".jstree-rename-input").val(),e=this.settings.core.force_text,e;""===i&&(i=o),d.remove(),n.replaceWith(a),n.remove(),o=e?o:E("
    ").append(E.parseHTML(o)).html(),r=this.get_node(r),this.set_text(r,o),(e=!!this.rename_node(r,e?E("
    ").text(i).text():E("
    ").append(E.parseHTML(i)).html()))||this.set_text(r,o),this._data.core.focused=l.id,setTimeout(function(){var e=this.get_node(l.id,!0);e.length&&(this._data.core.focused=l.id,e.children(".jstree-anchor").trigger("focus"))}.bind(this),0),s&&s.call(this,l,e,h,i),c=null}.bind(this),keydown:function(e){var t=e.which;27===t&&(h=!0,this.value=o),27!==t&&13!==t&&37!==t&&38!==t&&39!==t&&40!==t&&32!==t||e.stopImmediatePropagation(),27!==t&&13!==t||(e.preventDefault(),this.blur())},click:function(e){e.stopImmediatePropagation()},mousedown:function(e){e.stopImmediatePropagation()},keyup:function(e){c.width(Math.min(d.text("pW"+this.value).width(),i))},keypress:function(e){if(13===e.which)return!1}}),t={fontFamily:a.css("fontFamily")||"",fontSize:a.css("fontSize")||"",fontWeight:a.css("fontWeight")||"",fontStyle:a.css("fontStyle")||"",fontStretch:a.css("fontStretch")||"",fontVariant:a.css("fontVariant")||"",letterSpacing:a.css("letterSpacing")||"",wordSpacing:a.css("wordSpacing")||""},n.attr("class",a.attr("class")).append(a.contents().clone()).append(c),a.replaceWith(n),d.css(t),c.css(t).width(Math.min(d.text("pW"+c[0].value).width(),i))[0].select(),void E(b).one("mousedown.jstree touchstart.jstree dnd_start.vakata",function(e){c&&e.target!==c&&E(c).trigger("blur")})):(this.settings.core.error.call(this,this._data.core.last_error),!1))},set_theme:function(e,t){if(!e)return!1;var i,i;(t=!0===t?(i=(i=this.settings.core.themes.dir)||E.jstree.path+"/themes")+"/"+e+"/style.css":t)&&-1===E.inArray(t,r)&&(E("head").append(''),r.push(t)),this._data.core.themes.name&&this.element.removeClass("jstree-"+this._data.core.themes.name),this._data.core.themes.name=e,this.element.addClass("jstree-"+e),this.element[this.settings.core.themes.responsive?"addClass":"removeClass"]("jstree-"+e+"-responsive"),this.trigger("set_theme",{theme:e})},get_theme:function(){return this._data.core.themes.name},set_theme_variant:function(e){this._data.core.themes.variant&&this.element.removeClass("jstree-"+this._data.core.themes.name+"-"+this._data.core.themes.variant),(this._data.core.themes.variant=e)&&this.element.addClass("jstree-"+this._data.core.themes.name+"-"+this._data.core.themes.variant)},get_theme_variant:function(){return this._data.core.themes.variant},show_stripes:function(){this._data.core.themes.stripes=!0,this.get_container_ul().addClass("jstree-striped"),this.trigger("show_stripes")},hide_stripes:function(){this._data.core.themes.stripes=!1,this.get_container_ul().removeClass("jstree-striped"),this.trigger("hide_stripes")},toggle_stripes:function(){this._data.core.themes.stripes?this.hide_stripes():this.show_stripes()},show_dots:function(){this._data.core.themes.dots=!0,this.get_container_ul().removeClass("jstree-no-dots"),this.trigger("show_dots")},hide_dots:function(){this._data.core.themes.dots=!1,this.get_container_ul().addClass("jstree-no-dots"),this.trigger("hide_dots")},toggle_dots:function(){this._data.core.themes.dots?this.hide_dots():this.show_dots()},show_icons:function(){this._data.core.themes.icons=!0,this.get_container_ul().removeClass("jstree-no-icons"),this.trigger("show_icons")},hide_icons:function(){this._data.core.themes.icons=!1,this.get_container_ul().addClass("jstree-no-icons"),this.trigger("hide_icons")},toggle_icons:function(){this._data.core.themes.icons?this.hide_icons():this.show_icons()},show_ellipsis:function(){this._data.core.themes.ellipsis=!0,this.get_container_ul().addClass("jstree-ellipsis"),this.trigger("show_ellipsis")},hide_ellipsis:function(){this._data.core.themes.ellipsis=!1,this.get_container_ul().removeClass("jstree-ellipsis"),this.trigger("hide_ellipsis")},toggle_ellipsis:function(){this._data.core.themes.ellipsis?this.hide_ellipsis():this.show_ellipsis()},set_icon:function(e,t){var i,r,s,a;if(E.vakata.is_array(e)){for(i=0,r=(e=e.slice()).length;i "),r=!1,i+="
  • ",i+="",h.vakata.context.settings.icons&&(i+="'+(t.shortcut_label||"")+"":"")+"",t.submenu&&(s=h.vakata.context._parse(t.submenu,!0))&&(i+=s),i+="
  • ",void(t.separator_after&&(i+="
  •  
  • ",r=!0)))}),i=i.replace(/
  • <\/li\>$/,""),t&&(i+=""),t||(g.html=i,h.vakata.context._trigger("parse")),10"),g.element.on("mouseenter","li",function(e){e.stopImmediatePropagation(),h.contains(this,e.relatedTarget)||(i&&clearTimeout(i),g.element.find(".vakata-context-hover").removeClass("vakata-context-hover").end(),h(this).siblings().find("ul").hide().end().end().parentsUntil(".vakata-context","li").addBack().addClass("vakata-context-hover"),h.vakata.context._show_submenu(this))}).on("mouseleave","li",function(e){h.contains(this,e.relatedTarget)||h(this).find(".vakata-context-hover").addBack().removeClass("vakata-context-hover")}).on("mouseleave",function(e){var t;h(this).find(".vakata-context-hover").removeClass("vakata-context-hover"),h.vakata.context.settings.hide_onmouseleave&&(i=setTimeout((t=this,function(){h.vakata.context.hide()}),h.vakata.context.settings.hide_onmouseleave))}).on("click","a",function(e){e.preventDefault(),h(this).trigger("blur").parent().hasClass("vakata-context-disabled")||!1===h.vakata.context._execute(h(this).attr("rel"))||h.vakata.context.hide()}).on("keydown","a",function(e){var t=null;switch(e.which){case 13:case 32:e.type="click",e.preventDefault(),h(e.currentTarget).trigger(e);break;case 37:g.is_visible&&(g.element.find(".vakata-context-hover").last().closest("li").first().find("ul").hide().find(".vakata-context-hover").removeClass("vakata-context-hover").end().end().children("a").trigger("focus"),e.stopImmediatePropagation(),e.preventDefault());break;case 38:g.is_visible&&((t=!(t=g.element.find("ul:visible").addBack().last().children(".vakata-context-hover").removeClass("vakata-context-hover").prevAll("li:not(.vakata-context-separator)").first()).length?g.element.find("ul:visible").addBack().last().children("li:not(.vakata-context-separator)").last():t).addClass("vakata-context-hover").children("a").trigger("focus"),e.stopImmediatePropagation(),e.preventDefault());break;case 39:g.is_visible&&(g.element.find(".vakata-context-hover").last().children("ul").show().children("li:not(.vakata-context-separator)").removeClass("vakata-context-hover").first().addClass("vakata-context-hover").children("a").trigger("focus"),e.stopImmediatePropagation(),e.preventDefault());break;case 40:g.is_visible&&((t=!(t=g.element.find("ul:visible").addBack().last().children(".vakata-context-hover").removeClass("vakata-context-hover").nextAll("li:not(.vakata-context-separator)").first()).length?g.element.find("ul:visible").addBack().last().children("li:not(.vakata-context-separator)").first():t).addClass("vakata-context-hover").children("a").trigger("focus"),e.stopImmediatePropagation(),e.preventDefault());break;case 27:h.vakata.context.hide(),e.preventDefault()}}).on("keydown",function(e){e.preventDefault();var e=g.element.find(".vakata-contextmenu-shortcut-"+e.which).parent();e.parent().not(".vakata-context-disabled")&&e.trigger("click")}),h(b).on("mousedown.vakata.jstree",function(e){g.is_visible&&g.element[0]!==e.target&&!h.contains(g.element[0],e.target)&&h.vakata.context.hide()}).on("context_show.vakata.jstree",function(e,t){g.element.find("li:has(ul)").children("a").addClass("vakata-context-parent"),_&&g.element.addClass("vakata-context-rtl").css("direction","rtl"),g.element.find("ul").hide().end()})}),E.jstree.defaults.dnd={copy:!0,open_timeout:500,is_draggable:!0,check_while_dragging:!0,always_copy:!1,inside_pos:0,drag_selection:!0,touch:!0,large_drop_target:!1,large_drag_target:!1,use_html5:!1,blank_space_drop:!1},E.jstree.plugins.dnd=function(e,o){this.init=function(e,t){o.init.call(this,e,t),this.settings.dnd.use_html5=this.settings.dnd.use_html5&&"draggable"in b.createElement("span")},this.bind=function(){o.bind.call(this),this.element.on(this.settings.dnd.use_html5?"dragstart.jstree":"mousedown.jstree touchstart.jstree",this.settings.dnd.large_drag_target?".jstree-node":".jstree-anchor",function(e){if(this.settings.dnd.large_drag_target&&E(e.target).closest(".jstree-node")[0]!==e.currentTarget)return!0;if("touchstart"===e.type&&(!this.settings.dnd.touch||"selected"===this.settings.dnd.touch&&!E(e.currentTarget).closest(".jstree-node").children(".jstree-anchor").hasClass("jstree-clicked")))return!0;var t=this.get_node(e.target),i=this.is_selected(t)&&this.settings.dnd.drag_selection?this.get_top_selected().length:1,r=1'+r+'+');E.vakata.dnd._trigger("start",e,{helper:E(),element:u,data:d})}}.bind(this)),this.settings.dnd.use_html5&&this.element.on("dragover.jstree",function(e){return e.preventDefault(),E.vakata.dnd._trigger("move",e,{helper:E(),element:u,data:d}),!1}).on("drop.jstree",function(e){return e.preventDefault(),E.vakata.dnd._trigger("stop",e,{helper:E(),element:u,data:d}),!1}.bind(this))},this.redraw_node=function(e,t,i,r){if((e=o.redraw_node.apply(this,arguments))&&this.settings.dnd.use_html5)if(this.settings.dnd.large_drag_target)e.setAttribute("draggable",!0);else{for(var s,a,n=null,s=0,a=e.childNodes.length;s ').hide();E(b).on("dragover.vakata.jstree",function(e){u&&E.vakata.dnd._trigger("move",e,{helper:E(),element:u,data:d})}).on("drop.vakata.jstree",function(e){u&&(E.vakata.dnd._trigger("stop",e,{helper:E(),element:u,data:d}),d=u=null)}).on("dnd_start.vakata.jstree",function(e,t){O=N=!1,t&&t.data&&t.data.jstree&&S.appendTo(b.body)}).on("dnd_move.vakata.jstree",function(e,s){var a=s.event.target!==O.target;if(A&&(s.event&&"dragover"===s.event.type&&!a||clearTimeout(A)),s&&s.data&&s.data.jstree&&(!s.event.target.id||"jstree-marker"!==s.event.target.id)){O=s.event;var n=E.jstree.reference(s.event.target),o=!1,d=!1,t=!1,i,c,l,h,_,g,u,f,p,m,v,j,k,b,y,x,w,C;if(n&&n._data&&n._data.dnd)if(S.attr("class","jstree-"+n.get_theme()+(n.settings.core.themes.responsive?" jstree-dnd-responsive":"")),x=s.data.origin&&(s.data.origin.settings.dnd.always_copy||s.data.origin.settings.dnd.copy&&(s.event.metaKey||s.event.ctrlKey)),s.helper.children().attr("class","jstree-"+n.get_theme()+" jstree-"+n.get_theme()+"-"+n.get_theme_variant()+" "+(n.settings.core.themes.responsive?" jstree-dnd-responsive":"")).find(".jstree-copy").first()[x?"show":"hide"](),s.event.target!==n.element[0]&&s.event.target!==n.get_container_ul()[0]||0!==n.get_container_ul().children().length&&!n.settings.dnd.blank_space_drop){if((o=n.settings.dnd.large_drop_target?E(s.event.target).closest(".jstree-node").children(".jstree-anchor"):E(s.event.target).closest(".jstree-anchor"))&&o.length&&o.parent().is(".jstree-closed, .jstree-open, .jstree-leaf")&&(d=o.offset(),t=(s.event.pageY!==P?s.event:s.event.originalEvent).pageY-d.top,h=o.outerHeight(),u=tE.inArray(s.data.nodes[p],k.children)&&--j),!(f=f&&(n&&n.settings&&n.settings.dnd&&!1===n.settings.dnd.check_while_dragging||n.check(v,s.data.origin&&s.data.origin!==n?s.data.origin.get_node(s.data.nodes[p]):s.data.nodes[p],_,j,{dnd:!0,ref:n.get_node(o.parent()),pos:t,origin:s.data.origin,is_multi:s.data.origin&&s.data.origin!==n,is_foreign:!s.data.origin})))){n&&n.last_error&&(T=n.last_error());break}var i,r;if("i"===t&&o.parent().is(".jstree-closed")&&n.settings.dnd.open_timeout&&(s.event&&"dragover"===s.event.type&&!a||(A&&clearTimeout(A),A=setTimeout((r=o,function(){i.open_node(r)}),(i=n).settings.dnd.open_timeout))),f)return(w=n.get_node(_,!0)).hasClass(".jstree-dnd-parent")||(E(".jstree-dnd-parent").removeClass("jstree-dnd-parent"),w.addClass("jstree-dnd-parent")),N={ins:n,par:_,pos:"i"!==t||"last"!==b||0!==g||n.is_loaded(y)?g:"last"},S.css({left:c+"px",top:l+"px"}).show(),S.removeClass("jstree-above jstree-inside jstree-below").addClass(C),s.helper.find(".jstree-icon").first().removeClass("jstree-er").addClass("jstree-ok"),s.event.originalEvent&&s.event.originalEvent.dataTransfer&&(s.event.originalEvent.dataTransfer.dropEffect=x?"copy":"move"),T={},!(u=!0)}),!0===u))return}else{for(f=!0,p=0,m=s.data.nodes.length;p"),escape:function(e){return f.vakata.html.div.text(e).html()},strip:function(e){return f.vakata.html.div.empty().append(f.parseHTML(e)).text()}}),target:!1,is_down:!1,is_drag:!1,helper:!1,helper_w:0,data:!1,init_x:0,init_y:0,scroll_l:0,scroll_t:0,scroll_e:!1,scroll_i:!1,is_touch:!1},f.vakata.dnd={settings:{scroll_speed:10,scroll_proximity:20,helper_left:5,helper_top:10,threshold:5,threshold_touch:10},_trigger:function(e,t,i){(i=i===P?f.vakata.dnd._get():i).event=t,f(b).triggerHandler("dnd_"+e+".vakata",i)},_get:function(){return{data:p.data,element:p.element,helper:p.helper}},_clean:function(){p.helper&&p.helper.remove(),p.scroll_i&&(clearInterval(p.scroll_i),p.scroll_i=!1),p={element:!1,target:!1,is_down:!1,is_drag:!1,helper:!1,helper_w:0,data:!1,init_x:0,init_y:0,scroll_l:0,scroll_t:0,scroll_e:!1,scroll_i:!1,is_touch:!1},u=null,f(b).off("mousemove.vakata.jstree touchmove.vakata.jstree",f.vakata.dnd.drag),f(b).off("mouseup.vakata.jstree touchend.vakata.jstree",f.vakata.dnd.stop)},_scroll:function(e){if(!p.scroll_e||!p.scroll_l&&!p.scroll_t)return p.scroll_i&&(clearInterval(p.scroll_i),p.scroll_i=!1),!1;if(!p.scroll_i)return p.scroll_i=setInterval(f.vakata.dnd._scroll,100),!1;if(!0===e)return!1;var t=p.scroll_e.scrollTop(),e=p.scroll_e.scrollLeft();p.scroll_e.scrollTop(t+p.scroll_t*f.vakata.dnd.settings.scroll_speed),p.scroll_e.scrollLeft(e+p.scroll_l*f.vakata.dnd.settings.scroll_speed),t===p.scroll_e.scrollTop()&&e===p.scroll_e.scrollLeft()||f.vakata.dnd._trigger("scroll",p.scroll_e)},start:function(e,t,i){"touchstart"===e.type&&e.originalEvent&&e.originalEvent.changedTouches&&e.originalEvent.changedTouches[0]&&(e.pageX=e.originalEvent.changedTouches[0].pageX,e.pageY=e.originalEvent.changedTouches[0].pageY,e.target=b.elementFromPoint(e.originalEvent.changedTouches[0].pageX-window.pageXOffset,e.originalEvent.changedTouches[0].pageY-window.pageYOffset)),p.is_drag&&f.vakata.dnd.stop({});try{e.currentTarget.unselectable="on",e.currentTarget.onselectstart=function(){return!1},e.currentTarget.style&&(e.currentTarget.style.touchAction="none",e.currentTarget.style.msTouchAction="none",e.currentTarget.style.MozUserSelect="none")}catch(e){}return p.init_x=e.pageX,p.init_y=e.pageY,p.data=t,p.is_down=!0,p.element=e.currentTarget,p.target=e.target,p.is_touch="touchstart"===e.type,!1!==i&&(p.helper=f("
    ").html(i).css({display:"block",margin:"0",padding:"0",position:"absolute",top:"-2000px",lineHeight:"16px",zIndex:"10000"})),f(b).on("mousemove.vakata.jstree touchmove.vakata.jstree",f.vakata.dnd.drag),f(b).on("mouseup.vakata.jstree touchend.vakata.jstree",f.vakata.dnd.stop),!1},drag:function(i){if("touchmove"===i.type&&i.originalEvent&&i.originalEvent.changedTouches&&i.originalEvent.changedTouches[0]&&(i.pageX=i.originalEvent.changedTouches[0].pageX,i.pageY=i.originalEvent.changedTouches[0].pageY,i.target=b.elementFromPoint(i.originalEvent.changedTouches[0].pageX-window.pageXOffset,i.originalEvent.changedTouches[0].pageY-window.pageYOffset)),p.is_down){if(!p.is_drag){if(!(Math.abs(i.pageX-p.init_x)>(p.is_touch?f.vakata.dnd.settings.threshold_touch:f.vakata.dnd.settings.threshold)||Math.abs(i.pageY-p.init_y)>(p.is_touch?f.vakata.dnd.settings.threshold_touch:f.vakata.dnd.settings.threshold)))return;p.helper&&(p.helper.appendTo(b.body),p.helper_w=p.helper.outerWidth()),p.is_drag=!0,f(p.target).one("click.vakata",!1),f.vakata.dnd._trigger("start",i)}var e=!1,t=!1,r=!1,s=!1,a=!1,n=!1,o=!1,d=!1,c=!1,l=!1;return p.scroll_t=0,p.scroll_l=0,p.scroll_e=!1,f(f(i.target).parentsUntil("body").addBack().get().reverse()).filter(function(){return this.ownerDocument&&/^auto|scroll$/.test(f(this).css("overflow"))&&(this.scrollHeight>this.offsetHeight||this.scrollWidth>this.offsetWidth)}).each(function(){var e=f(this),t=e.offset();if(this.scrollHeight>this.offsetHeight&&(t.top+e.height()-i.pageYthis.offsetWidth&&(t.left+e.width()-i.pageXa&&(l=a-(p.helper_w+2)),p.helper.css({left:l+"px",top:(c=r&&rs)break;c=_}return{isMatch:0<=a,score:u}},!0===e?{search:t}:t(e)},w.vakata.search.defaults={location:0,distance:100,threshold:.6,fuzzy:!1,caseSensitive:!1},E.jstree.defaults.sort=function(e,t){return this.get_text(e)>this.get_text(t)?1:-1};var m=!(E.jstree.plugins.sort=function(e,t){this.bind=function(){t.bind.call(this),this.element.on("model.jstree",function(e,t){this.sort(t.parent,!0)}.bind(this)).on("rename_node.jstree create_node.jstree",function(e,t){this.sort(t.parent||t.node.parent,!1),this.redraw_node(t.parent||t.node.parent,!0)}.bind(this)).on("move_node.jstree copy_node.jstree",function(e,t){this.sort(t.parent,!1),this.redraw_node(t.parent,!0)}.bind(this))},this.sort=function(e,t){var i,r;if((e=this.get_node(e))&&e.children&&e.children.length&&(e.children.sort(this.settings.sort.bind(this)),t))for(i=0,r=e.children_d.length;ii.ttl)&&(!!(i=(i=i&&i.state?i.state:i)&&E.vakata.is_function(this.settings.state.filter)?this.settings.state.filter.call(this,i):i)&&(this.settings.state.preserve_loaded||delete i.core.loaded,this.element.one("set_state.jstree",function(e,t){t.instance.trigger("restore_state",{state:E.extend(!0,{},i)})}),this.set_state(i),!0))},this.clear_state=function(){return E.vakata.storage.del(this.settings.state.key)}},E.vakata.storage={set:function(e,t){return window.localStorage.setItem(e,t)},get:function(e){return window.localStorage.getItem(e)},del:function(e){return window.localStorage.removeItem(e)}},E.jstree.defaults.types={default:{}},E.jstree.defaults.types[E.jstree.root]={},E.jstree.plugins.types=function(e,l){this.init=function(e,t){var i,r;if(t&&t.types&&t.types.default)for(i in t.types)if("default"!==i&&i!==E.jstree.root&&t.types.hasOwnProperty(i))for(r in t.types.default)t.types.default.hasOwnProperty(r)&&t.types[i][r]===P&&(t.types[i][r]=t.types.default[r]);l.init.call(this,e,t),this._model.data[E.jstree.root].type=E.jstree.root},this.refresh=function(e,t){l.refresh.call(this,e,t),this._model.data[E.jstree.root].type=E.jstree.root},this.bind=function(){this.element.on("model.jstree",function(e,t){for(var i=this._model.data,r=t.nodes,s=this.settings.types,a,n,o="default",d,a=0,n=r.length;a .jstree-ocl",function(e){e.stopImmediatePropagation();var t=E.Event("click",{metaKey:e.metaKey,ctrlKey:e.ctrlKey,altKey:e.altKey,shiftKey:e.shiftKey});E(e.currentTarget).closest(".jstree-node").children(".jstree-anchor").first().trigger(t).trigger("focus")}.bind(this)).on("mouseover.jstree",".jstree-wholerow, .jstree-icon",function(e){return e.stopImmediatePropagation(),this.is_disabled(e.currentTarget)||this.hover_node(e.currentTarget),!1}.bind(this)).on("mouseleave.jstree",".jstree-node",function(e){this.dehover_node(e.currentTarget)}.bind(this))},this.teardown=function(){this.settings.wholerow&&this.element.find(".jstree-wholerow").remove(),a.teardown.call(this)},this.redraw_node=function(e,t,i,r){var s;return(e=a.redraw_node.apply(this,arguments))&&(s=j.cloneNode(!0),-1!==E.inArray(e.id,this._data.core.selected)&&(s.className+=" jstree-wholerow-clicked"),this._data.core.focused&&this._data.core.focused===e.id&&(s.className+=" jstree-wholerow-hovered"),e.insertBefore(s,e.childNodes[0])),e}},window.customElements&&Object&&Object.create){var e=Object.create(HTMLElement.prototype);e.createdCallback=function(){var e={core:{},plugins:[]},t;for(t in E.jstree.plugins)E.jstree.plugins.hasOwnProperty(t)&&this.attributes[t]&&(e.plugins.push(t),this.getAttribute(t)&&JSON.parse(this.getAttribute(t))&&(e[t]=JSON.parse(this.getAttribute(t))));for(t in E.jstree.defaults.core)E.jstree.defaults.core.hasOwnProperty(t)&&this.attributes[t]&&(e.core[t]=JSON.parse(this.getAttribute(t))||this.getAttribute(t));E(this).jstree(e)};try{window.customElements.define("vakata-jstree",function(){},{prototype:e})}catch(e){}}}}); +!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e=e||self).scrollIntoView=t()}(this,function(){"use strict";function e(e){return null!=e&&"object"==typeof e&&1===e.nodeType}function t(e,t){return(!t||"hidden"!==e)&&("visible"!==e&&"clip"!==e)}function n(e,n){if(e.clientHeightt||i>e&&l=t&&c>=n?i-e-o:l>t&&cn?l-t+r:0}var r=function(t,r){var i=r.scrollMode,l=r.block,c=r.inline,d=r.boundary,u=r.skipOverflowHiddenElements,f="function"==typeof d?d:function(e){return e!==d};if(!e(t))throw new TypeError("Invalid target");for(var a=document.scrollingElement||document.documentElement,s=[],h=t;e(h)&&f(h);){if((h=h.parentNode)===a){s.push(h);break}h===document.body&&n(h)&&!n(document.documentElement)||n(h,u)&&s.push(h)}for(var p=window.visualViewport?visualViewport.width:innerWidth,m=window.visualViewport?visualViewport.height:innerHeight,v=window.scrollX||pageXOffset,g=window.scrollY||pageYOffset,w=t.getBoundingClientRect(),b=w.height,y=w.width,W=w.top,H=w.right,E=w.bottom,M=w.left,V="start"===l||"nearest"===l?W:"end"===l?E:W+b/2,k="center"===c?M+y/2:"end"===c?H:M,x=[],I=0;I=0&&M>=0&&E<=m&&H<=p&&W>=C&&E<=L&&M>=R&&H<=D)return x;var X=getComputedStyle(O),Y=parseInt(X.borderLeftWidth,10),S=parseInt(X.borderTopWidth,10),N=parseInt(X.borderRightWidth,10),q=parseInt(X.borderBottomWidth,10),z=0,A=0,F="offsetWidth"in O?O.offsetWidth-O.clientWidth-Y-N:0,G="offsetHeight"in O?O.offsetHeight-O.clientHeight-S-q:0;if(a===O)z="start"===l?V:"end"===l?V-m:"nearest"===l?o(g,g+m,m,S,q,g+V,g+V+b,b):V-m/2,A="start"===c?k:"center"===c?k-p/2:"end"===c?k-p:o(v,v+p,p,Y,N,v+k,v+k+y,y),z=Math.max(0,z+g),A=Math.max(0,A+v);else{z="start"===l?V-C-S:"end"===l?V-L+q+G:"nearest"===l?o(C,L,j,S,q+G,V,V+b,b):V-(C+j/2)+G/2,A="start"===c?k-R-Y:"center"===c?k-(R+B/2)+F/2:"end"===c?k-D+N+F:o(R,D,B,Y,N+F,k,k+y,y);var J=O.scrollLeft,K=O.scrollTop;V+=K-(z=Math.max(0,Math.min(K+z,O.scrollHeight-j+G))),k+=J-(A=Math.max(0,Math.min(J+A,O.scrollWidth-B+F)))}x.push({el:O,top:z,left:A})}return x};function i(e){return e===Object(e)&&0!==Object.keys(e).length}return function(e,t){var n=!e.ownerDocument.documentElement.contains(e);if(i(t)&&"function"==typeof t.behavior)return t.behavior(n?[]:r(e,t));if(!n){var o=function(e){return!1===e?{block:"end",inline:"nearest"}:i(e)?e:{block:"start",inline:"nearest"}}(t);return function(e,t){void 0===t&&(t="auto");var n="scrollBehavior"in document.body.style;e.forEach(function(e){var o=e.el,r=e.top,i=e.left;o.scroll&&n?o.scroll({top:r,left:i,behavior:t}):(o.scrollTop=r,o.scrollLeft=i)})}(r(e,o),o.behavior)}}}); + +/*! Split.js - v1.6.5 */ +!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).Split=t()}(this,(function(){"use strict";var e="undefined"!=typeof window?window:null,t=null===e,n=t?void 0:e.document,i=function(){return!1},r=t?"calc":["","-webkit-","-moz-","-o-"].filter((function(e){var t=n.createElement("div");return t.style.cssText="width:"+e+"calc(9px)",!!t.style.length})).shift()+"calc",s=function(e){return"string"==typeof e||e instanceof String},o=function(e){if(s(e)){var t=n.querySelector(e);if(!t)throw new Error("Selector "+e+" did not match a DOM element");return t}return e},a=function(e,t,n){var i=e[t];return void 0!==i?i:n},u=function(e,t,n,i){if(t){if("end"===i)return 0;if("center"===i)return e/2}else if(n){if("start"===i)return 0;if("center"===i)return e/2}return e},l=function(e,t){var i=n.createElement("div");return i.className="gutter gutter-"+t,i},c=function(e,t,n){var i={};return s(t)?i[e]=t:i[e]=r+"("+t+"% - "+n+"px)",i},h=function(e,t){var n;return(n={})[e]=t+"px",n};return function(r,s){if(void 0===s&&(s={}),t)return{};var f,d,v,m,g,p,y=r;Array.from&&(y=Array.from(y));var z=o(y[0]).parentNode,S=getComputedStyle?getComputedStyle(z):null,b=S?S.flexDirection:null,E=a(s,"sizes")||y.map((function(){return 100/y.length})),_=a(s,"minSize",100),L=Array.isArray(_)?_:y.map((function(){return _})),w=a(s,"maxSize",1/0),x=Array.isArray(w)?w:y.map((function(){return w})),O=a(s,"expandToMin",!1),A=a(s,"gutterSize",10),k=a(s,"gutterAlign","center"),C=a(s,"snapOffset",30),M=Array.isArray(C)?C:y.map((function(){return C})),U=a(s,"dragInterval",1),D=a(s,"direction","horizontal"),B=a(s,"cursor","horizontal"===D?"col-resize":"row-resize"),T=a(s,"gutter",l),j=a(s,"elementStyle",c),F=a(s,"gutterStyle",h);function R(e,t,n,i){var r=j(f,t,n,i);Object.keys(r).forEach((function(t){e.style[t]=r[t]}))}function N(){return p.map((function(e){return e.size}))}function q(e){return"touches"in e?e.touches[0][d]:e[d]}function H(e){var t=p[this.a],n=p[this.b],i=t.size+n.size;t.size=e/this.size*i,n.size=i-e/this.size*i,R(t.element,t.size,this._b,t.i),R(n.element,n.size,this._c,n.i)}function I(e){var t,n=p[this.a],r=p[this.b];this.dragging&&(t=q(e)-this.start+(this._b-this.dragOffset),U>1&&(t=Math.round(t/U)*U),t<=n.minSize+n.snapOffset+this._b?t=n.minSize+this._b:t>=this.size-(r.minSize+r.snapOffset+this._c)&&(t=this.size-(r.minSize+this._c)),t>=n.maxSize-n.snapOffset+this._b?t=n.maxSize+this._b:t<=this.size-(r.maxSize-r.snapOffset+this._c)&&(t=this.size-(r.maxSize+this._c)),H.call(this,t),a(s,"onDrag",i)(N()))}function W(){var e=p[this.a].element,t=p[this.b].element,n=e.getBoundingClientRect(),i=t.getBoundingClientRect();this.size=n[f]+i[f]+this._b+this._c,this.start=n[v],this.end=n[m]}function X(e){var t=function(e){if(!getComputedStyle)return null;var t=getComputedStyle(e);if(!t)return null;var n=e[g];return 0===n?null:n-="horizontal"===D?parseFloat(t.paddingLeft)+parseFloat(t.paddingRight):parseFloat(t.paddingTop)+parseFloat(t.paddingBottom)}(z);if(null===t)return e;if(L.reduce((function(e,t){return e+t}),0)>t)return e;var n=0,i=[],r=e.map((function(r,s){var o=t*r/100,a=u(A,0===s,s===e.length-1,k),l=L[s]+a;return o0&&i[r]-n>0){var o=Math.min(n,i[r]-n);n-=o,s=e-o}return s/t*100}))}function Y(){var t=p[this.a].element,r=p[this.b].element;this.dragging&&a(s,"onDragEnd",i)(N()),this.dragging=!1,e.removeEventListener("mouseup",this.stop),e.removeEventListener("touchend",this.stop),e.removeEventListener("touchcancel",this.stop),e.removeEventListener("mousemove",this.move),e.removeEventListener("touchmove",this.move),this.stop=null,this.move=null,t.removeEventListener("selectstart",i),t.removeEventListener("dragstart",i),r.removeEventListener("selectstart",i),r.removeEventListener("dragstart",i),t.style.userSelect="",t.style.webkitUserSelect="",t.style.MozUserSelect="",t.style.pointerEvents="",r.style.userSelect="",r.style.webkitUserSelect="",r.style.MozUserSelect="",r.style.pointerEvents="",this.gutter.style.cursor="",this.parent.style.cursor="",n.body.style.cursor=""}function G(t){if(!("button"in t)||0===t.button){var r=p[this.a].element,o=p[this.b].element;this.dragging||a(s,"onDragStart",i)(N()),t.preventDefault(),this.dragging=!0,this.move=I.bind(this),this.stop=Y.bind(this),e.addEventListener("mouseup",this.stop),e.addEventListener("touchend",this.stop),e.addEventListener("touchcancel",this.stop),e.addEventListener("mousemove",this.move),e.addEventListener("touchmove",this.move),r.addEventListener("selectstart",i),r.addEventListener("dragstart",i),o.addEventListener("selectstart",i),o.addEventListener("dragstart",i),r.style.userSelect="none",r.style.webkitUserSelect="none",r.style.MozUserSelect="none",r.style.pointerEvents="none",o.style.userSelect="none",o.style.webkitUserSelect="none",o.style.MozUserSelect="none",o.style.pointerEvents="none",this.gutter.style.cursor=B,this.parent.style.cursor=B,n.body.style.cursor=B,W.call(this),this.dragOffset=q(t)-this.end}}"horizontal"===D?(f="width",d="clientX",v="left",m="right",g="clientWidth"):"vertical"===D&&(f="height",d="clientY",v="top",m="bottom",g="clientHeight"),E=X(E);var J=[];function K(e){var t=e.i===J.length,n=t?J[e.i-1]:J[e.i];W.call(n);var i=t?n.size-e.minSize-n._c:e.minSize+n._b;H.call(n,i)}return(p=y.map((function(e,t){var n,i={element:o(e),size:E[t],minSize:L[t],maxSize:x[t],snapOffset:M[t],i:t};if(t>0&&((n={a:t-1,b:t,dragging:!1,direction:D,parent:z})._b=u(A,t-1==0,!1,k),n._c=u(A,!1,t===y.length-1,k),"row-reverse"===b||"column-reverse"===b)){var r=n.a;n.a=n.b,n.b=r}if(t>0){var s=T(t,D,i.element);!function(e,t,n){var i=F(f,t,n);Object.keys(i).forEach((function(t){e.style[t]=i[t]}))}(s,A,t),n._a=G.bind(n),s.addEventListener("mousedown",n._a),s.addEventListener("touchstart",n._a),z.insertBefore(s,i.element),n.gutter=s}return R(i.element,i.size,u(A,0===t,t===y.length-1,k),t),t>0&&J.push(n),i}))).forEach((function(e){var t=e.element.getBoundingClientRect()[f];t0){var i=J[n-1],r=p[i.a],s=p[i.b];r.size=t[n-1],s.size=e,R(r.element,r.size,i._b,r.i),R(s.element,s.size,i._c,s.i)}}))},getSizes:N,collapse:function(e){K(p[e])},destroy:function(e,t){J.forEach((function(n){if(!0!==t?n.parent.removeChild(n.gutter):(n.gutter.removeEventListener("mousedown",n._a),n.gutter.removeEventListener("touchstart",n._a)),!0!==e){var i=j(f,n.a.size,n._b);Object.keys(i).forEach((function(e){p[n.a].element.style[e]="",p[n.b].element.style[e]=""}))}}))},parent:z,pairs:J}}})); +//# sourceMappingURL=split.min.js.map + +/**! + * url-search-params-polyfill + * + * @author Jerry Bendy (https://github.com/jerrybendy) + * @licence MIT + */ +(function(self) { + 'use strict'; + + var nativeURLSearchParams = (function() { + // #41 Fix issue in RN + try { + if (self.URLSearchParams && (new self.URLSearchParams('foo=bar')).get('foo') === 'bar') { + return self.URLSearchParams; + } + } catch (e) {} + return null; + })(), + isSupportObjectConstructor = nativeURLSearchParams && (new nativeURLSearchParams({a: 1})).toString() === 'a=1', + // There is a bug in safari 10.1 (and earlier) that incorrectly decodes `%2B` as an empty space and not a plus. + decodesPlusesCorrectly = nativeURLSearchParams && (new nativeURLSearchParams('s=%2B').get('s') === '+'), + isSupportSize = nativeURLSearchParams && 'size' in nativeURLSearchParams.prototype, + __URLSearchParams__ = "__URLSearchParams__", + // Fix bug in Edge which cannot encode ' &' correctly + encodesAmpersandsCorrectly = nativeURLSearchParams ? (function() { + var ampersandTest = new nativeURLSearchParams(); + ampersandTest.append('s', ' &'); + return ampersandTest.toString() === 's=+%26'; + })() : true, + prototype = URLSearchParamsPolyfill.prototype, + iterable = !!(self.Symbol && self.Symbol.iterator); + + if (nativeURLSearchParams && isSupportObjectConstructor && decodesPlusesCorrectly && encodesAmpersandsCorrectly && isSupportSize) { + return; + } + + + /** + * Make a URLSearchParams instance + * + * @param {object|string|URLSearchParams} search + * @constructor + */ + function URLSearchParamsPolyfill(search) { + search = search || ""; + + // support construct object with another URLSearchParams instance + if (search instanceof URLSearchParams || search instanceof URLSearchParamsPolyfill) { + search = search.toString(); + } + this [__URLSearchParams__] = parseToDict(search); + } + + + /** + * Appends a specified key/value pair as a new search parameter. + * + * @param {string} name + * @param {string} value + */ + prototype.append = function(name, value) { + appendTo(this [__URLSearchParams__], name, value); + }; + + /** + * Deletes the given search parameter, and its associated value, + * from the list of all search parameters. + * + * @param {string} name + */ + prototype['delete'] = function(name) { + delete this [__URLSearchParams__] [name]; + }; + + /** + * Returns the first value associated to the given search parameter. + * + * @param {string} name + * @returns {string|null} + */ + prototype.get = function(name) { + var dict = this [__URLSearchParams__]; + return this.has(name) ? dict[name][0] : null; + }; + + /** + * Returns all the values association with a given search parameter. + * + * @param {string} name + * @returns {Array} + */ + prototype.getAll = function(name) { + var dict = this [__URLSearchParams__]; + return this.has(name) ? dict [name].slice(0) : []; + }; + + /** + * Returns a Boolean indicating if such a search parameter exists. + * + * @param {string} name + * @returns {boolean} + */ + prototype.has = function(name) { + return hasOwnProperty(this [__URLSearchParams__], name); + }; + + /** + * Sets the value associated to a given search parameter to + * the given value. If there were several values, delete the + * others. + * + * @param {string} name + * @param {string} value + */ + prototype.set = function set(name, value) { + this [__URLSearchParams__][name] = ['' + value]; + }; + + /** + * Returns a string containg a query string suitable for use in a URL. + * + * @returns {string} + */ + prototype.toString = function() { + var dict = this[__URLSearchParams__], query = [], i, key, name, value; + for (key in dict) { + name = encode(key); + for (i = 0, value = dict[key]; i < value.length; i++) { + query.push(name + '=' + encode(value[i])); + } + } + return query.join('&'); + }; + + // There is a bug in Safari 10.1 and `Proxy`ing it is not enough. + var useProxy = self.Proxy && nativeURLSearchParams && (!decodesPlusesCorrectly || !encodesAmpersandsCorrectly || !isSupportObjectConstructor || !isSupportSize); + var propValue; + if (useProxy) { + // Safari 10.0 doesn't support Proxy, so it won't extend URLSearchParams on safari 10.0 + propValue = new Proxy(nativeURLSearchParams, { + construct: function (target, args) { + return new target((new URLSearchParamsPolyfill(args[0]).toString())); + } + }) + // Chrome <=60 .toString() on a function proxy got error "Function.prototype.toString is not generic" + propValue.toString = Function.prototype.toString.bind(URLSearchParamsPolyfill); + } else { + propValue = URLSearchParamsPolyfill; + } + + /* + * Apply polyfill to global object and append other prototype into it + */ + Object.defineProperty(self, 'URLSearchParams', { + value: propValue + }); + + var USPProto = self.URLSearchParams.prototype; + + USPProto.polyfill = true; + + // Fix #54, `toString.call(new URLSearchParams)` will return correct value when Proxy not used + if (!useProxy && self.Symbol) { + USPProto[self.Symbol.toStringTag] = 'URLSearchParams'; + } + + /** + * + * @param {function} callback + * @param {object} thisArg + */ + if (!('forEach' in USPProto)) { + USPProto.forEach = function(callback, thisArg) { + var dict = parseToDict(this.toString()); + Object.getOwnPropertyNames(dict).forEach(function(name) { + dict[name].forEach(function(value) { + callback.call(thisArg, value, name, this); + }, this); + }, this); + }; + } + + /** + * Sort all name-value pairs + */ + if (!('sort' in USPProto)) { + USPProto.sort = function() { + var dict = parseToDict(this.toString()), keys = [], k, i, j; + for (k in dict) { + keys.push(k); + } + keys.sort(); + + for (i = 0; i < keys.length; i++) { + this['delete'](keys[i]); + } + for (i = 0; i < keys.length; i++) { + var key = keys[i], values = dict[key]; + for (j = 0; j < values.length; j++) { + this.append(key, values[j]); + } + } + }; + } + + /** + * Returns an iterator allowing to go through all keys of + * the key/value pairs contained in this object. + * + * @returns {function} + */ + if (!('keys' in USPProto)) { + USPProto.keys = function() { + var items = []; + this.forEach(function(item, name) { + items.push(name); + }); + return makeIterator(items); + }; + } + + /** + * Returns an iterator allowing to go through all values of + * the key/value pairs contained in this object. + * + * @returns {function} + */ + if (!('values' in USPProto)) { + USPProto.values = function() { + var items = []; + this.forEach(function(item) { + items.push(item); + }); + return makeIterator(items); + }; + } + + /** + * Returns an iterator allowing to go through all key/value + * pairs contained in this object. + * + * @returns {function} + */ + if (!('entries' in USPProto)) { + USPProto.entries = function() { + var items = []; + this.forEach(function(item, name) { + items.push([name, item]); + }); + return makeIterator(items); + }; + } + + if (iterable) { + USPProto[self.Symbol.iterator] = USPProto[self.Symbol.iterator] || USPProto.entries; + } + + if (!('size' in USPProto)) { + Object.defineProperty(USPProto, 'size', { + get: function () { + var dict = parseToDict(this.toString()) + if (USPProto === this) { + throw new TypeError('Illegal invocation at URLSearchParams.invokeGetter') + } + return Object.keys(dict).reduce(function (prev, cur) { + return prev + dict[cur].length; + }, 0); + } + }); + } + + function encode(str) { + var replace = { + '!': '%21', + "'": '%27', + '(': '%28', + ')': '%29', + '~': '%7E', + '%20': '+', + '%00': '\x00' + }; + return encodeURIComponent(str).replace(/[!'\(\)~]|%20|%00/g, function(match) { + return replace[match]; + }); + } + + function decode(str) { + return str + .replace(/[ +]/g, '%20') + .replace(/(%[a-f0-9]{2})+/ig, function(match) { + return decodeURIComponent(match); + }); + } + + function makeIterator(arr) { + var iterator = { + next: function() { + var value = arr.shift(); + return {done: value === undefined, value: value}; + } + }; + + if (iterable) { + iterator[self.Symbol.iterator] = function() { + return iterator; + }; + } + + return iterator; + } + + function parseToDict(search) { + var dict = {}; + + if (typeof search === "object") { + // if `search` is an array, treat it as a sequence + if (isArray(search)) { + for (var i = 0; i < search.length; i++) { + var item = search[i]; + if (isArray(item) && item.length === 2) { + appendTo(dict, item[0], item[1]); + } else { + throw new TypeError("Failed to construct 'URLSearchParams': Sequence initializer must only contain pair elements"); + } + } + + } else { + for (var key in search) { + if (search.hasOwnProperty(key)) { + appendTo(dict, key, search[key]); + } + } + } + + } else { + // remove first '?' + if (search.indexOf("?") === 0) { + search = search.slice(1); + } + + var pairs = search.split("&"); + for (var j = 0; j < pairs.length; j++) { + var value = pairs [j], + index = value.indexOf('='); + + if (-1 < index) { + appendTo(dict, decode(value.slice(0, index)), decode(value.slice(index + 1))); + + } else { + if (value) { + appendTo(dict, decode(value), ''); + } + } + } + } + + return dict; + } + + function appendTo(dict, name, value) { + var val = typeof value === 'string' ? value : ( + value !== null && value !== undefined && typeof value.toString === 'function' ? value.toString() : JSON.stringify(value) + ); + + // #47 Prevent using `hasOwnProperty` as a property name + if (hasOwnProperty(dict, name)) { + dict[name].push(val); + } else { + dict[name] = [val]; + } + } + + function isArray(val) { + return !!val && '[object Array]' === Object.prototype.toString.call(val); + } + + function hasOwnProperty(obj, prop) { + return Object.prototype.hasOwnProperty.call(obj, prop); + } + +})(typeof global !== 'undefined' ? global : (typeof window !== 'undefined' ? window : this)); diff --git a/static/v2.15.x/web_help/js/docs.js b/static/v2.15.x/web_help/js/docs.js new file mode 100644 index 0000000000..71b361df66 --- /dev/null +++ b/static/v2.15.x/web_help/js/docs.js @@ -0,0 +1,92 @@ +"use strict"; +/* +* 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. +* +*/ +// Array.from polyfill for IE11 support +function arrayFrom(items) { + if (typeof Array.from === "function") { + return Array.from(items); + } + var tempArray = []; + for (var i = 0; i < items.length; i++) { + tempArray.push(items[i]); + } + return tempArray; +} +var isInIframe = window.location !== window.parent.location; +var links = arrayFrom(document.getElementsByTagName("a")); +// Process all tags on page +links.forEach(function (link) { + var url = link.getAttribute("href"); + if (!url) { + // Ignore links with no href + } + else if (url.indexOf("://") > 0 || url.indexOf("//") === 0) { + // If link is absolute, assume it points to external site and open it in new tab + link.setAttribute("target", "_blank"); + } + else if (isInIframe) { + // If link is relative and page is inside an iframe, then send signal to command tree when link is clicked to make it update selected node + link.setAttribute("onclick", "window.parent.postMessage(this.href, '*'); return true;"); + } +}); +// Show Print button if inside iframe +if (isInIframe) { + var printBtn = document.getElementById("btn-print"); + if (printBtn) { + printBtn.style.display = "block"; + } +} +/** + * Show tooltip next to copy button that times out after 1 sec + * @param btn - Button element the tooltip will show next to + * @param message - Message to show in the tooltip + */ +function setTooltip(btn, message) { + var oneSecAsMillis = 1000; + btn.setAttribute("aria-label", message); + btn.setAttribute("data-balloon-visible", ""); + setTimeout(function () { + btn.removeAttribute("aria-label"); + btn.removeAttribute("data-balloon-visible"); + }, oneSecAsMillis); +} +// Enable clipboard access for copy buttons +var clipboard = new ClipboardJS(".btn-copy"); +clipboard.on("success", function (e) { return setTooltip(e.trigger, "Copied!"); }); +clipboard.on("error", function (e) { return setTooltip(e.trigger, "Failed!"); }); +/** + * Find the currently scrolled to command anchor in iframe + * @returns Element with tag + */ +function findCurrentCmdAnchor() { + var anchors = arrayFrom(document.getElementsByClassName("cmd-anchor")); + var lastAnchor; + for (var _i = 0, anchors_1 = anchors; _i < anchors_1.length; _i++) { + var anchor = anchors_1[_i]; + var headerBounds = anchor.nextElementSibling.getBoundingClientRect(); + if (headerBounds.top > window.innerHeight) { + break; + } + lastAnchor = anchor; + } + return lastAnchor; +} +// If in flat view, select currently scrolled to command in tree +if (isInIframe && window.location.href.indexOf("/all.html") !== -1) { + var currentCmdName_1; + window.onscroll = function (_) { + var cmdName = findCurrentCmdAnchor().getAttribute("name"); + if (cmdName != null && cmdName !== currentCmdName_1) { + window.parent.postMessage(cmdName + ".html", window.location.origin); + currentCmdName_1 = cmdName; + } + }; +} diff --git a/static/v2.15.x/web_help/js/tree.js b/static/v2.15.x/web_help/js/tree.js new file mode 100644 index 0000000000..a49085f348 --- /dev/null +++ b/static/v2.15.x/web_help/js/tree.js @@ -0,0 +1,324 @@ +"use strict"; +/* +* 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. +* +*/ +var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) { + if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) { + if (ar || !(i in from)) { + if (!ar) ar = Array.prototype.slice.call(from, 0, i); + ar[i] = from[i]; + } + } + return to.concat(ar || Array.prototype.slice.call(from)); +}; +// Define global variables +var urlParams = new URLSearchParams(window.location.search); +var currentNodeId; +var currentView = +(urlParams.get("v") === "1"); +var searchTimeout = 0; +/** + * Generate flattened list of tree nodes + * @param nestedNodes - Node list for command tree + * @returns Flattened node list + */ +function flattenNodes(nestedNodes) { + var flattenedNodes = []; + nestedNodes.forEach(function (node) { + if (node.children && node.children.length > 0) { + flattenedNodes.push.apply(flattenedNodes, flattenNodes(node.children)); + } + else { + var fiveFromEnd = -5; + flattenedNodes.push({ + id: node.id, + text: node.id.slice(0, fiveFromEnd).replace(/_/g, " ") + }); + } + }); + return flattenedNodes; +} +/** + * Get the preferred theme name for JSTree (light or dark). + * @returns Theme name + */ +function getJstreeThemeName() { + if (window.matchMedia && window.matchMedia("(prefers-color-scheme: dark)").matches) { + return "default-dark"; + } + return "default"; +} +/** + * Find all possible combinations of a search string that exist with different aliases + * @param searchStr - Search string input by user + * @returns NUL-delimited list of search strings with all combinations of aliases + */ +function permuteSearchStr(searchStr) { + var searchWords = searchStr.split(" "); + var searchWordsList = [searchWords]; + var _loop_1 = function (i) { + var word = searchWords[i]; + if (aliasList[word] !== undefined) { + var newSearchWordsList_1 = []; + searchWordsList.forEach(function (oldSearchWords) { + aliasList[word].forEach(function (alias) { + newSearchWordsList_1.push(__spreadArray(__spreadArray(__spreadArray([], oldSearchWords.slice(0, i), true), [alias], false), oldSearchWords.slice(i + 1), true)); + }); + }); + searchWordsList.push.apply(searchWordsList, newSearchWordsList_1); + } + }; + for (var i = 0; i < searchWords.length; i++) { + _loop_1(i); + } + return searchWordsList.map(function (words) { return words.join(" "); }).join("\0"); +} +/** + * Update node that docs are displayed for + * @param newNodeId - Node ID to select + * @param goto - Whether to load docs page for node + * @param expand - Whether to expand tree node + * @param force - Whether to update node even if already selected + */ +function updateCurrentNode(newNodeId, goto, expand, force) { + if (force === void 0) { force = false; } + if (!force) { + if (newNodeId === currentNodeId || !$("#cmd-tree").jstree(true).get_node(newNodeId)) { + // Ignore if node already selected or does not exist + return; + } + } + currentNodeId = newNodeId; + var fiveFromEnd = -5; + var nodeIdWithoutExt = currentNodeId.slice(0, fiveFromEnd); + if (goto) { + // Load docs page for node in iframe + if (currentView === 0) { + $("#docs-page").attr("src", "./docs/".concat(currentNodeId)); + } + else { + $("#docs-page").attr("src", "./docs/all.html#".concat(nodeIdWithoutExt)); + } + } + // Update page title + document.title = "".concat(nodeIdWithoutExt.replace(/_/g, " "), " | ").concat(headerStr, " Docs"); + // Select node in command tree + $("#cmd-tree").jstree(true).deselect_all(); + $("#cmd-tree").jstree(true).select_node(currentNodeId); + if (expand) { + // Expand node in command tree + $("#cmd-tree").jstree(true).open_node(currentNodeId); + } + // Scroll node into view if needed + setTimeout(function () { + var nodeElem = document.getElementById(currentNodeId); + if (nodeElem) { + scrollIntoView(nodeElem, { scrollMode: "if-needed", block: "nearest", inline: "nearest" }); + } + }, 0); + // Update URL in address bar to contain node ID + var baseUrl = window.location.href.replace(window.location.search, ""); + var queryString = ""; + if (currentNodeId !== treeNodes[0].id) { + queryString = "?p=" + nodeIdWithoutExt; + } + if (currentView === 1) { + queryString = (queryString.length > 0) ? (queryString + "&v=1") : "?v=1"; + } + window.history.replaceState(null, "", baseUrl + queryString); +} +/** + * Generate list of context menu items for a node + * @param node - Node that was right clicked + * @return List of context menu items containing labels and actions + */ +function onTreeContextMenu(node) { + if (node.id !== treeNodes[0].id) { + return {}; + } + return { + expandAll: { + label: "Expand All", + action: function () { + $("#cmd-tree").jstree("open_all"); + } + }, + collapseAll: { + label: "Collapse All", + action: function () { + $("#cmd-tree").jstree("close_all"); + $("#cmd-tree").jstree(true).toggle_node(treeNodes[0].id); + } + } + }; +} +/** + * Check if node is matched by a search string + * @param permutedSearchStr - NUL-delimited list of search strings + * @param node + * @returns True if the node matches + */ +function onTreeSearch(permutedSearchStr, node) { + if (node.parent === "#" && currentView === 0) { + return false; // Don't match root node + } + // Strip off ".html" to get full command name + var fiveFromEnd = -5; + var fullCmd = node.id.slice(0, fiveFromEnd).replace(/_/g, " "); + var searchStrList = permutedSearchStr.split("\0"); + // Do fuzzy search that allows space or no char to be substituted for hyphen + for (var _i = 0, _a = [fullCmd, fullCmd.replace(/-/g, " "), fullCmd.replace(/-/g, "")]; _i < _a.length; _i++) { + var haystack = _a[_i]; + for (var _b = 0, searchStrList_1 = searchStrList; _b < searchStrList_1.length; _b++) { + var needle = searchStrList_1[_b]; + var matchIndex = haystack.lastIndexOf(needle); + if (matchIndex !== -1) { // A search string was matched + if (currentView === 1 || haystack.indexOf(" ", matchIndex + needle.length) === -1) { + // Don't match node if text that matches is only in label of parent node + return true; + } + } + } + } + return false; +} +/** + * Update current node and search bar after command tree (re)loaded + */ +function onTreeLoaded() { + var tempNodeId = currentNodeId; + if (!tempNodeId) { + var cmdToLoad = urlParams.get("p"); + tempNodeId = (cmdToLoad != null) ? "".concat(cmdToLoad, ".html") : treeNodes[0].id; + } + updateCurrentNode(tempNodeId, true, true, true); + if ($("#tree-search").val()) { + onSearchTextChanged(true); + } +} +/** + * Update current node after new node selected in tree + * @param _ + * @param data - jsTree event data + */ +function onTreeSelectionChanged(_, data) { + // Change src attribute of iframe when item selected + if (data.selected.length > 0) { + updateCurrentNode(data.selected[0], true, true); + } +} +/** + * Search command tree after text in search box has changed + * @param noDelay - If true, searches instantly rather than delaying 250 ms + */ +function onSearchTextChanged(noDelay) { + if (noDelay === void 0) { noDelay = false; } + if (searchTimeout) { + clearTimeout(searchTimeout); + } + var defaultDelay250 = 250; + searchTimeout = window.setTimeout(function () { + var searchStr = ($("#tree-search").val() || "").toString().trim(); + $("#cmd-tree").jstree(true).search(permuteSearchStr(searchStr)); + if (!searchStr) { + updateCurrentNode(currentNodeId, false, false, true); + } + }, noDelay ? 0 : defaultDelay250); +} +/** + * Update selected node in command tree after new page loaded in iframe + * @param e - Event object sent by postMessage + */ +function onDocsPageChanged(e) { + if (e.origin !== window.location.origin || typeof e.data !== "string") + return; + var tempNodeId = e.data.slice(e.data.lastIndexOf("/") + 1); + updateCurrentNode(tempNodeId, false, false); +} +/** + * Load command tree components + */ +/* eslint-disable unused-imports/no-unused-vars */ +function loadTree() { + /* eslint-enable */ + // Set header and footer strings + $("#header-text").text(headerStr); + $("#footer").text(footerStr); + // Change active tab if not loading default view + if (currentView === 1) { + $("#tree-view-link").toggleClass("active"); + $("#flat-view-link").toggleClass("active"); + } + // Load jsTree + $("#cmd-tree").jstree({ + core: { + animation: 0, + multiple: false, + themes: { name: getJstreeThemeName(), icons: false }, + data: (currentView === 0) ? treeNodes : flattenNodes(treeNodes) + }, + plugins: ["contextmenu", "search", "wholerow"], + contextmenu: { + items: onTreeContextMenu + }, + search: { + show_only_matches: true, + show_only_matches_children: true, + search_callback: onTreeSearch + } + }) + .on("ready.jstree refresh.jstree", onTreeLoaded) + .on("changed.jstree", onTreeSelectionChanged); + // Connect events to search box and iframe + $("#tree-search").on("change keyup mouseup paste", function () { return onSearchTextChanged(); }); + window.addEventListener("message", onDocsPageChanged, false); + if (window.matchMedia) { + window.matchMedia("(prefers-color-scheme: dark)") + .addEventListener("change", function () { return $("#cmd-tree").jstree(true).set_theme(getJstreeThemeName()); }); + } +} +/** + * Toggle visibility of command tree + * @param splitter - Split.js object + */ +/* eslint-disable unused-imports/no-unused-vars */ +function toggleTree(splitter) { + /* eslint-enable */ + if ($("#panel-left").is(":visible")) { + $("#panel-left").children().hide(); + $("#panel-left").hide(); + var splitterWidth = 0; + var splitterHeight = 100; + splitter.setSizes([splitterWidth, splitterHeight]); + } + else { + var splitterWidth = 20; + var splitterHeight = 80; + splitter.setSizes([splitterWidth, splitterHeight]); + $("#panel-left").show(); + $("#panel-left").children().show(); + } +} +/** + * Change display mode of page + * @param newMode - 0 = Tree View, 1 = Flat View + */ +/* eslint-disable unused-imports/no-unused-vars */ +function changeView(newMode) { + /* eslint-enable */ + if (newMode === currentView) { + return; + } + currentView = newMode; + $("#tree-view-link").toggleClass("active"); + $("#flat-view-link").toggleClass("active"); + var newNodes = (currentView === 0) ? treeNodes : flattenNodes(treeNodes); + $("#cmd-tree").jstree(true).settings.core.data = newNodes; + $("#cmd-tree").jstree(true).refresh(false, true); +} diff --git a/static/v2.15.x/web_help/tree-data.js b/static/v2.15.x/web_help/tree-data.js new file mode 100644 index 0000000000..b15c1c34d9 --- /dev/null +++ b/static/v2.15.x/web_help/tree-data.js @@ -0,0 +1,5 @@ +/* This file is automatically generated, do not edit manually! */ +const headerStr = "Zowe CLI"; +const footerStr = "Release: Zowe v2.15.0"; +const treeNodes = [{"id":"zowe.html","text":"zowe","children":[{"id":"zowe_auth.html","text":"auth","children":[{"id":"zowe_auth_login.html","text":"login | li","children":[{"id":"zowe_auth_login_apiml.html","text":"apiml"}]},{"id":"zowe_auth_logout.html","text":"logout | lo","children":[{"id":"zowe_auth_logout_apiml.html","text":"apiml"}]}]},{"id":"zowe_ca7.html","text":"ca7 | 7","children":[{"id":"zowe_ca7_commands.html","text":"commands | cmds","children":[{"id":"zowe_ca7_commands_addrq.html","text":"addrq | ar"},{"id":"zowe_ca7_commands_cancel.html","text":"cancel | c"},{"id":"zowe_ca7_commands_demand.html","text":"demand | d"},{"id":"zowe_ca7_commands_demandh.html","text":"demandh | dh"},{"id":"zowe_ca7_commands_hold.html","text":"hold | h"},{"id":"zowe_ca7_commands_jclovrd.html","text":"jclovrd | jo"},{"id":"zowe_ca7_commands_post.html","text":"post | po"},{"id":"zowe_ca7_commands_prscf.html","text":"prscf | pc"},{"id":"zowe_ca7_commands_prsqa.html","text":"prsqa | pq"},{"id":"zowe_ca7_commands_release.html","text":"release | rl"},{"id":"zowe_ca7_commands_requeue.html","text":"requeue | rq"},{"id":"zowe_ca7_commands_resolv.html","text":"resolv | rslv"},{"id":"zowe_ca7_commands_restart.html","text":"restart | rs"},{"id":"zowe_ca7_commands_rmtsub.html","text":"rmtsub | rsub"},{"id":"zowe_ca7_commands_rmttrk.html","text":"rmttrk | rtrk"},{"id":"zowe_ca7_commands_run.html","text":"run | r"},{"id":"zowe_ca7_commands_runh.html","text":"runh | rh"},{"id":"zowe_ca7_commands_submit.html","text":"submit | sm"},{"id":"zowe_ca7_commands_subtm.html","text":"subtm | st"},{"id":"zowe_ca7_commands_verify.html","text":"verify | v"}]},{"id":"zowe_ca7_create-job-definition.html","text":"create-job-definition | cjd","children":[{"id":"zowe_ca7_create-job-definition_req-predecessor.html","text":"req-predecessor | rp"},{"id":"zowe_ca7_create-job-definition_schedule.html","text":"schedule | s"}]},{"id":"zowe_ca7_create-resource-definition.html","text":"create-resource-definition | crd","children":[{"id":"zowe_ca7_create-resource-definition_resource-count-resource.html","text":"resource-count-resource | rcr"}]},{"id":"zowe_ca7_dataset.html","text":"dataset | ds","children":[{"id":"zowe_ca7_dataset_create-dataset.html","text":"create-dataset | cds"},{"id":"zowe_ca7_dataset_create-dataset-trigger.html","text":"create-dataset-trigger | cdt"},{"id":"zowe_ca7_dataset_delete-dataset.html","text":"delete-dataset | dds"},{"id":"zowe_ca7_dataset_delete-dataset-trigger.html","text":"delete-dataset-trigger | ddt"},{"id":"zowe_ca7_dataset_rename-dataset.html","text":"rename-dataset | rds"},{"id":"zowe_ca7_dataset_update-dataset.html","text":"update-dataset | uds"},{"id":"zowe_ca7_dataset_update-dataset-trigger.html","text":"update-dataset-trigger | udt"}]},{"id":"zowe_ca7_delete-job-definition.html","text":"delete-job-definition | djd","children":[{"id":"zowe_ca7_delete-job-definition_req-predecessor.html","text":"req-predecessor | rp"},{"id":"zowe_ca7_delete-job-definition_schedule.html","text":"schedule | s"}]},{"id":"zowe_ca7_delete-resource-definition.html","text":"delete-resource-definition | drd","children":[{"id":"zowe_ca7_delete-resource-definition_resource-count-resource.html","text":"resource-count-resource | rcr"}]},{"id":"zowe_ca7_event-manager-requests.html","text":"event-manager-requests | emr","children":[{"id":"zowe_ca7_event-manager-requests_job-status.html","text":"job-status | js"}]},{"id":"zowe_ca7_job-definition.html","text":"job-definition | jd","children":[{"id":"zowe_ca7_job-definition_create-address-space-resource.html","text":"create-address-space-resource | casr"},{"id":"zowe_ca7_job-definition_create-corequisite-resource.html","text":"create-corequisite-resource | ccr"},{"id":"zowe_ca7_job-definition_create-exclusive-resource.html","text":"create-exclusive-resource | cer"},{"id":"zowe_ca7_job-definition_create-job.html","text":"create-job | cj"},{"id":"zowe_ca7_job-definition_create-job-trigger-successor.html","text":"create-job-trigger-successor | cjts"},{"id":"zowe_ca7_job-definition_create-resource-count-resource.html","text":"create-resource-count-resource | crcr"},{"id":"zowe_ca7_job-definition_create-shared-resource.html","text":"create-shared-resource | csr"},{"id":"zowe_ca7_job-definition_create-variable-resource.html","text":"create-variable-resource | cvr"},{"id":"zowe_ca7_job-definition_delete-address-space-resource.html","text":"delete-address-space-resource | dasr"},{"id":"zowe_ca7_job-definition_delete-corequisite-resource.html","text":"delete-corequisite-resource | dcr"},{"id":"zowe_ca7_job-definition_delete-exclusive-resource.html","text":"delete-exclusive-resource | der"},{"id":"zowe_ca7_job-definition_delete-job.html","text":"delete-job | dj"},{"id":"zowe_ca7_job-definition_delete-job-trigger-successor.html","text":"delete-job-trigger-successor | djts"},{"id":"zowe_ca7_job-definition_delete-resource-count-resource.html","text":"delete-resource-count-resource | drcr"},{"id":"zowe_ca7_job-definition_delete-shared-resource.html","text":"delete-shared-resource | dsr"},{"id":"zowe_ca7_job-definition_delete-variable-resource.html","text":"delete-variable-resource | dvr"},{"id":"zowe_ca7_job-definition_list-job.html","text":"list-job | lj"},{"id":"zowe_ca7_job-definition_list-job-trigger-successor.html","text":"list-job-trigger-successor | ljts"},{"id":"zowe_ca7_job-definition_update-address-space-resource.html","text":"update-address-space-resource | uasr"},{"id":"zowe_ca7_job-definition_update-corequisite-resource.html","text":"update-corequisite-resource | ucr"},{"id":"zowe_ca7_job-definition_update-exclusive-resource.html","text":"update-exclusive-resource | uer"},{"id":"zowe_ca7_job-definition_update-job.html","text":"update-job | uj"},{"id":"zowe_ca7_job-definition_update-job-trigger-successor.html","text":"update-job-trigger-successor | ujts"},{"id":"zowe_ca7_job-definition_update-resource-count-resource.html","text":"update-resource-count-resource | urcr"},{"id":"zowe_ca7_job-definition_update-shared-resource.html","text":"update-shared-resource | usr"}]},{"id":"zowe_ca7_job-instance.html","text":"job-instance | ji","children":[{"id":"zowe_ca7_job-instance_list-waiting-resource.html","text":"list-waiting-resource | lwr"}]},{"id":"zowe_ca7_list-job-definition.html","text":"list-job-definition | ljd","children":[{"id":"zowe_ca7_list-job-definition_job.html","text":"job | j"},{"id":"zowe_ca7_list-job-definition_prose.html","text":"prose | p"},{"id":"zowe_ca7_list-job-definition_requirement-predecessor.html","text":"requirement-predecessor | rp"},{"id":"zowe_ca7_list-job-definition_requirement-successor.html","text":"requirement-successor | rs"},{"id":"zowe_ca7_list-job-definition_resource.html","text":"resource | r"},{"id":"zowe_ca7_list-job-definition_schedule.html","text":"schedule | s"},{"id":"zowe_ca7_list-job-definition_step-dd.html","text":"step-dd | sd"},{"id":"zowe_ca7_list-job-definition_trigger-predecessor.html","text":"trigger-predecessor | tp"},{"id":"zowe_ca7_list-job-definition_trigger-successor.html","text":"trigger-successor | ts"}]},{"id":"zowe_ca7_list-job-history.html","text":"list-job-history | ljh","children":[{"id":"zowe_ca7_list-job-history_prior-run.html","text":"prior-run | pr"}]},{"id":"zowe_ca7_list-job-instance.html","text":"list-job-instance | lji","children":[{"id":"zowe_ca7_list-job-instance_active-resource.html","text":"active-resource | ar"},{"id":"zowe_ca7_list-job-instance_jcl.html","text":"jcl | jcl"},{"id":"zowe_ca7_list-job-instance_list.html","text":"list | l"},{"id":"zowe_ca7_list-job-instance_listCustom.html","text":"listCustom | lc"},{"id":"zowe_ca7_list-job-instance_requirements.html","text":"requirements | r"}]},{"id":"zowe_ca7_list-resource-definition.html","text":"list-resource-definition | lrd","children":[{"id":"zowe_ca7_list-resource-definition_resource-count-resource.html","text":"resource-count-resource | rcr"}]},{"id":"zowe_ca7_update-job-definition.html","text":"update-job-definition | ujd","children":[{"id":"zowe_ca7_update-job-definition_job.html","text":"job"},{"id":"zowe_ca7_update-job-definition_requirement-predecessor.html","text":"requirement-predecessor | rp"},{"id":"zowe_ca7_update-job-definition_schedule.html","text":"schedule | s"}]},{"id":"zowe_ca7_update-job-instance.html","text":"update-job-instance | uji","children":[{"id":"zowe_ca7_update-job-instance_jcl.html","text":"jcl"}]},{"id":"zowe_ca7_update-resource-definition.html","text":"update-resource-definition | urd","children":[{"id":"zowe_ca7_update-resource-definition_resource-count-resource.html","text":"resource-count-resource | rcr"}]}]},{"id":"zowe_caview.html","text":"caview | cv","children":[{"id":"zowe_caview_download.html","text":"download | dl","children":[{"id":"zowe_caview_download_report.html","text":"report | r"}]},{"id":"zowe_caview_export.html","text":"export | exp","children":[{"id":"zowe_caview_export_report.html","text":"report | r"}]},{"id":"zowe_caview_get.html","text":"get","children":[{"id":"zowe_caview_get_user.html","text":"user","children":[{"id":"zowe_caview_get_user_settings.html","text":"settings"}]}]},{"id":"zowe_caview_list.html","text":"list | ls","children":[{"id":"zowe_caview_list_export-rules.html","text":"export-rules | rules"},{"id":"zowe_caview_list_report.html","text":"report | repo","children":[{"id":"zowe_caview_list_report_index-names.html","text":"index-names | indexes"},{"id":"zowe_caview_list_report_index-values.html","text":"index-values"},{"id":"zowe_caview_list_report_logical-views.html","text":"logical-views | views"}]},{"id":"zowe_caview_list_reports.html","text":"reports"},{"id":"zowe_caview_list_repositories.html","text":"repositories | repos"}]},{"id":"zowe_caview_search.html","text":"search | find","children":[{"id":"zowe_caview_search_index.html","text":"index","children":[{"id":"zowe_caview_search_index_names.html","text":"names"},{"id":"zowe_caview_search_index_reports.html","text":"reports"},{"id":"zowe_caview_search_index_values.html","text":"values"}]}]},{"id":"zowe_caview_set.html","text":"set","children":[{"id":"zowe_caview_set_user.html","text":"user","children":[{"id":"zowe_caview_set_user_distribution.html","text":"distribution"},{"id":"zowe_caview_set_user_mode.html","text":"mode"}]}]}]},{"id":"zowe_cics.html","text":"cics","children":[{"id":"zowe_cics_add-to-list.html","text":"add-to-list | atl","children":[{"id":"zowe_cics_add-to-list_csdGroup.html","text":"csdGroup | csdg"}]},{"id":"zowe_cics_define.html","text":"define | def","children":[{"id":"zowe_cics_define_program.html","text":"program | prog"},{"id":"zowe_cics_define_transaction.html","text":"transaction | tran"},{"id":"zowe_cics_define_urimap-client.html","text":"urimap-client | uc"},{"id":"zowe_cics_define_urimap-pipeline.html","text":"urimap-pipeline | up"},{"id":"zowe_cics_define_urimap-server.html","text":"urimap-server | us"},{"id":"zowe_cics_define_webservice.html","text":"webservice | web"}]},{"id":"zowe_cics_delete.html","text":"delete | del","children":[{"id":"zowe_cics_delete_program.html","text":"program | prog"},{"id":"zowe_cics_delete_transaction.html","text":"transaction | tran"},{"id":"zowe_cics_delete_urimap.html","text":"urimap"},{"id":"zowe_cics_delete_webservice.html","text":"webservice | web"}]},{"id":"zowe_cics_disable.html","text":"disable","children":[{"id":"zowe_cics_disable_urimap.html","text":"urimap"}]},{"id":"zowe_cics_discard.html","text":"discard | dis","children":[{"id":"zowe_cics_discard_program.html","text":"program | prog"},{"id":"zowe_cics_discard_transaction.html","text":"transaction | tran"},{"id":"zowe_cics_discard_urimap.html","text":"urimap"}]},{"id":"zowe_cics_enable.html","text":"enable | en","children":[{"id":"zowe_cics_enable_urimap.html","text":"urimap"}]},{"id":"zowe_cics_get.html","text":"get","children":[{"id":"zowe_cics_get_resource.html","text":"resource | res"}]},{"id":"zowe_cics_install.html","text":"install | ins","children":[{"id":"zowe_cics_install_program.html","text":"program | prog"},{"id":"zowe_cics_install_transaction.html","text":"transaction | tran"},{"id":"zowe_cics_install_urimap.html","text":"urimap"}]},{"id":"zowe_cics_refresh.html","text":"refresh | ref","children":[{"id":"zowe_cics_refresh_program.html","text":"program | prog"}]},{"id":"zowe_cics_remove-from-list.html","text":"remove-from-list | rfl","children":[{"id":"zowe_cics_remove-from-list_csdGroup.html","text":"csdGroup | csdg"}]}]},{"id":"zowe_config.html","text":"config","children":[{"id":"zowe_config_auto-init.html","text":"auto-init"},{"id":"zowe_config_convert-profiles.html","text":"convert-profiles | convert"},{"id":"zowe_config_edit.html","text":"edit"},{"id":"zowe_config_import.html","text":"import"},{"id":"zowe_config_init.html","text":"init"},{"id":"zowe_config_list.html","text":"list | ls"},{"id":"zowe_config_profiles.html","text":"profiles"},{"id":"zowe_config_report-env.html","text":"report-env | re"},{"id":"zowe_config_schema.html","text":"schema"},{"id":"zowe_config_secure.html","text":"secure"},{"id":"zowe_config_set.html","text":"set"},{"id":"zowe_config_update-schemas.html","text":"update-schemas | us"}]},{"id":"zowe_daemon.html","text":"daemon","children":[{"id":"zowe_daemon_disable.html","text":"disable"},{"id":"zowe_daemon_enable.html","text":"enable"},{"id":"zowe_daemon_restart.html","text":"restart"}]},{"id":"zowe_db2.html","text":"db2","children":[{"id":"zowe_db2_call.html","text":"call","children":[{"id":"zowe_db2_call_procedure.html","text":"procedure | proc | sp"}]},{"id":"zowe_db2_execute.html","text":"execute","children":[{"id":"zowe_db2_execute_sql.html","text":"sql"}]},{"id":"zowe_db2_export.html","text":"export","children":[{"id":"zowe_db2_export_table.html","text":"table"}]}]},{"id":"zowe_dbm-db2.html","text":"dbm-db2 | dbm","children":[{"id":"zowe_dbm-db2_check.html","text":"check","children":[{"id":"zowe_dbm-db2_check_ddl.html","text":"ddl"}]},{"id":"zowe_dbm-db2_compare.html","text":"compare","children":[{"id":"zowe_dbm-db2_compare_ddl.html","text":"ddl"}]},{"id":"zowe_dbm-db2_deploy.html","text":"deploy","children":[{"id":"zowe_dbm-db2_deploy_ddl.html","text":"ddl"}]},{"id":"zowe_dbm-db2_execute.html","text":"execute","children":[{"id":"zowe_dbm-db2_execute_compare-script.html","text":"compare-script"},{"id":"zowe_dbm-db2_execute_migration-script.html","text":"migration-script"},{"id":"zowe_dbm-db2_execute_script.html","text":"script"}]},{"id":"zowe_dbm-db2_generate.html","text":"generate","children":[{"id":"zowe_dbm-db2_generate_ddl.html","text":"ddl"}]},{"id":"zowe_dbm-db2_prepare.html","text":"prepare","children":[{"id":"zowe_dbm-db2_prepare_migration.html","text":"migration"}]}]},{"id":"zowe_ejes.html","text":"ejes | ejes","children":[{"id":"zowe_ejes_api.html","text":"api | a","children":[{"id":"zowe_ejes_api_cancel-download.html","text":"cancel-download | c"},{"id":"zowe_ejes_api_exec.html","text":"exec | e"},{"id":"zowe_ejes_api_init.html","text":"init | i"},{"id":"zowe_ejes_api_term.html","text":"term | t"}]},{"id":"zowe_ejes_batch.html","text":"batch | b | bat","children":[{"id":"zowe_ejes_batch_activity.html","text":"activity | ac"},{"id":"zowe_ejes_batch_apfds.html","text":"apfds | apf"},{"id":"zowe_ejes_batch_class.html","text":"class | cl"},{"id":"zowe_ejes_batch_cmdstack.html","text":"cmdstack | cmd | stack | stk"},{"id":"zowe_ejes_batch_command.html","text":"command"},{"id":"zowe_ejes_batch_djc.html","text":"djc | dj"},{"id":"zowe_ejes_batch_dynexit.html","text":"dynexit | dynex | dynx"},{"id":"zowe_ejes_batch_enclave.html","text":"enclave | enc"},{"id":"zowe_ejes_batch_enq.html","text":"enq"},{"id":"zowe_ejes_batch_enqc.html","text":"enqc"},{"id":"zowe_ejes_batch_enqd.html","text":"enqd"},{"id":"zowe_ejes_batch_entry.html","text":"entry | ent"},{"id":"zowe_ejes_batch_fss.html","text":"fss"},{"id":"zowe_ejes_batch_group.html","text":"group | gr"},{"id":"zowe_ejes_batch_hcheck.html","text":"hcheck | hchk | hc"},{"id":"zowe_ejes_batch_hold.html","text":"hold | h"},{"id":"zowe_ejes_batch_init.html","text":"init"},{"id":"zowe_ejes_batch_input.html","text":"input | i"},{"id":"zowe_ejes_batch_jesplex.html","text":"jesplex | jesp"},{"id":"zowe_ejes_batch_jgroup.html","text":"jgroup | jg"},{"id":"zowe_ejes_batch_line.html","text":"line | li"},{"id":"zowe_ejes_batch_lnklst.html","text":"lnklst | lnkl | lnk"},{"id":"zowe_ejes_batch_log.html","text":"log"},{"id":"zowe_ejes_batch_lpalst.html","text":"lpalst | lpal | lpa"},{"id":"zowe_ejes_batch_mds.html","text":"mds | md"},{"id":"zowe_ejes_batch_memusage.html","text":"memusage | memuse | memu"},{"id":"zowe_ejes_batch_menu.html","text":"menu"},{"id":"zowe_ejes_batch_mounts.html","text":"mounts | mount | mo"},{"id":"zowe_ejes_batch_netconn.html","text":"netconn | netc | nc"},{"id":"zowe_ejes_batch_netserv.html","text":"netserv | nets"},{"id":"zowe_ejes_batch_nje.html","text":"nje"},{"id":"zowe_ejes_batch_node.html","text":"node | ph"},{"id":"zowe_ejes_batch_nop.html","text":"nop"},{"id":"zowe_ejes_batch_offload.html","text":"offload | off"},{"id":"zowe_ejes_batch_Output.html","text":"Output | o"},{"id":"zowe_ejes_batch_pageds.html","text":"pageds | pag | page | paged"},{"id":"zowe_ejes_batch_parmlib.html","text":"parmlib | parml | parm"},{"id":"zowe_ejes_batch_printer.html","text":"printer | pr"},{"id":"zowe_ejes_batch_proclib.html","text":"proclib | procl | proc"},{"id":"zowe_ejes_batch_pstatus.html","text":"pstatus | pstat | ps"},{"id":"zowe_ejes_batch_query.html","text":"query"},{"id":"zowe_ejes_batch_resmon.html","text":"resmon | resm | rmon | rm"},{"id":"zowe_ejes_batch_resource.html","text":"resource | reso"},{"id":"zowe_ejes_batch_schenv.html","text":"schenv | sch"},{"id":"zowe_ejes_batch_session.html","text":"session | sess"},{"id":"zowe_ejes_batch_shell.html","text":"shell | sh | prompt"},{"id":"zowe_ejes_batch_spart.html","text":"spart | spa"},{"id":"zowe_ejes_batch_spvol.html","text":"spvol | spv"},{"id":"zowe_ejes_batch_status.html","text":"status | st"},{"id":"zowe_ejes_batch_subsys.html","text":"subsys | subsy | subs"},{"id":"zowe_ejes_batch_symbol.html","text":"symbol | sym"},{"id":"zowe_ejes_batch_syscls.html","text":"syscls | sysc"},{"id":"zowe_ejes_batch_sysplex.html","text":"sysplex | sysp | sys"},{"id":"zowe_ejes_batch_sysreq.html","text":"sysreq | sysr | sr"},{"id":"zowe_ejes_batch_ulog.html","text":"ulog | ph"},{"id":"zowe_ejes_batch_writer.html","text":"writer | w"},{"id":"zowe_ejes_batch_zero.html","text":"zero | z"}]},{"id":"zowe_ejes_issue.html","text":"issue | i","children":[{"id":"zowe_ejes_issue_submit.html","text":"submit | sub"},{"id":"zowe_ejes_issue_syscmd.html","text":"syscmd | s"}]},{"id":"zowe_ejes_log.html","text":"log","children":[{"id":"zowe_ejes_log_stream.html","text":"stream"}]},{"id":"zowe_ejes_query.html","text":"query | q","children":[{"id":"zowe_ejes_query_activity.html","text":"activity | ac"},{"id":"zowe_ejes_query_apfds.html","text":"apfds | apf"},{"id":"zowe_ejes_query_class.html","text":"class | cl"},{"id":"zowe_ejes_query_djc.html","text":"djc | dj"},{"id":"zowe_ejes_query_dynexit.html","text":"dynexit | dynex | dynx"},{"id":"zowe_ejes_query_enclave.html","text":"enclave | enc"},{"id":"zowe_ejes_query_enq.html","text":"enq"},{"id":"zowe_ejes_query_enqc.html","text":"enqc"},{"id":"zowe_ejes_query_enqd.html","text":"enqd"},{"id":"zowe_ejes_query_fss.html","text":"fss"},{"id":"zowe_ejes_query_group.html","text":"group | gr"},{"id":"zowe_ejes_query_hcheck.html","text":"hcheck | hchk | hc"},{"id":"zowe_ejes_query_hold.html","text":"hold | h"},{"id":"zowe_ejes_query_init.html","text":"init"},{"id":"zowe_ejes_query_input.html","text":"input | i"},{"id":"zowe_ejes_query_jesplex.html","text":"jesplex | jesp"},{"id":"zowe_ejes_query_jgroup.html","text":"jgroup | jg"},{"id":"zowe_ejes_query_line.html","text":"line | li"},{"id":"zowe_ejes_query_list.html","text":"list"},{"id":"zowe_ejes_query_lnklst.html","text":"lnklst | lnkl | lnk"},{"id":"zowe_ejes_query_lpalst.html","text":"lpalst | lpal | lpa"},{"id":"zowe_ejes_query_mds.html","text":"mds | md"},{"id":"zowe_ejes_query_memusage.html","text":"memusage | memuse | memu"},{"id":"zowe_ejes_query_mounts.html","text":"mounts | mount | mo"},{"id":"zowe_ejes_query_netconn.html","text":"netconn | netc | nc"},{"id":"zowe_ejes_query_netserv.html","text":"netserv | nets"},{"id":"zowe_ejes_query_nje.html","text":"nje"},{"id":"zowe_ejes_query_node.html","text":"node | node | no"},{"id":"zowe_ejes_query_offload.html","text":"offload | off"},{"id":"zowe_ejes_query_pageds.html","text":"pageds | pag | page | paged"},{"id":"zowe_ejes_query_parmlib.html","text":"parmlib | parml | parm"},{"id":"zowe_ejes_query_printer.html","text":"printer | pr"},{"id":"zowe_ejes_query_proclib.html","text":"proclib | procl | proc"},{"id":"zowe_ejes_query_pstatus.html","text":"pstatus | pstat | ps"},{"id":"zowe_ejes_query_resmon.html","text":"resmon | resm | rmon | rm"},{"id":"zowe_ejes_query_resource.html","text":"resource | reso"},{"id":"zowe_ejes_query_schenv.html","text":"schenv | sch"},{"id":"zowe_ejes_query_session.html","text":"session | ses"},{"id":"zowe_ejes_query_spart.html","text":"spart | spa"},{"id":"zowe_ejes_query_spvol.html","text":"spvol | spv"},{"id":"zowe_ejes_query_status.html","text":"status | st"},{"id":"zowe_ejes_query_subsys.html","text":"subsys | subsy | subs"},{"id":"zowe_ejes_query_symbol.html","text":"symbol | sym"},{"id":"zowe_ejes_query_syscls.html","text":"syscls | sysc"},{"id":"zowe_ejes_query_sysplex.html","text":"sysplex | sysp | sys"},{"id":"zowe_ejes_query_sysreq.html","text":"sysreq | sysr | sr"},{"id":"zowe_ejes_query_writer.html","text":"writer | w | output | o"},{"id":"zowe_ejes_query_zero.html","text":"zero | z"}]}]},{"id":"zowe_endevor.html","text":"endevor","children":[{"id":"zowe_endevor_add.html","text":"add","children":[{"id":"zowe_endevor_add_element.html","text":"element | elem | ele"}]},{"id":"zowe_endevor_approve.html","text":"approve | aprv","children":[{"id":"zowe_endevor_approve_package.html","text":"package | pkg"}]},{"id":"zowe_endevor_backin.html","text":"backin","children":[{"id":"zowe_endevor_backin_package.html","text":"package | pkg"}]},{"id":"zowe_endevor_backout.html","text":"backout","children":[{"id":"zowe_endevor_backout_package.html","text":"package | pkg"}]},{"id":"zowe_endevor_cast.html","text":"cast","children":[{"id":"zowe_endevor_cast_package.html","text":"package | pkg"}]},{"id":"zowe_endevor_check.html","text":"check","children":[{"id":"zowe_endevor_check_instance.html","text":"instance"}]},{"id":"zowe_endevor_commit.html","text":"commit","children":[{"id":"zowe_endevor_commit_package.html","text":"package | pkg"}]},{"id":"zowe_endevor_confirm.html","text":"confirm | conf","children":[{"id":"zowe_endevor_confirm_resolution.html","text":"resolution | res"}]},{"id":"zowe_endevor_create.html","text":"create","children":[{"id":"zowe_endevor_create_package.html","text":"package | pkg"}]},{"id":"zowe_endevor_delete.html","text":"delete | del","children":[{"id":"zowe_endevor_delete_element.html","text":"element | elem | ele"},{"id":"zowe_endevor_delete_package.html","text":"package | pkg"}]},{"id":"zowe_endevor_deny.html","text":"deny","children":[{"id":"zowe_endevor_deny_package.html","text":"package | pkg"}]},{"id":"zowe_endevor_execute.html","text":"execute","children":[{"id":"zowe_endevor_execute_package.html","text":"package | pkg"}]},{"id":"zowe_endevor_generate.html","text":"generate | gen","children":[{"id":"zowe_endevor_generate_element.html","text":"element | elem | ele"}]},{"id":"zowe_endevor_initialize.html","text":"initialize | init","children":[{"id":"zowe_endevor_initialize_workspace.html","text":"workspace | wsp"}]},{"id":"zowe_endevor_list.html","text":"list","children":[{"id":"zowe_endevor_list_code-page-config.html","text":"code-page-config | codepages | cdpg"},{"id":"zowe_endevor_list_defaults.html","text":"defaults"},{"id":"zowe_endevor_list_dialog.html","text":"dialog"},{"id":"zowe_endevor_list_elements.html","text":"elements | elem | ele"},{"id":"zowe_endevor_list_environments.html","text":"environments | environment | env"},{"id":"zowe_endevor_list_features.html","text":"features"},{"id":"zowe_endevor_list_instances.html","text":"instances | instance | inst | i"},{"id":"zowe_endevor_list_packages.html","text":"packages | package | pkg | p"},{"id":"zowe_endevor_list_processor-groups.html","text":"processor-groups | processor-group | pgrp"},{"id":"zowe_endevor_list_processor-symbols.html","text":"processor-symbols | processor-symbol | psym"},{"id":"zowe_endevor_list_stages.html","text":"stages | stage | stg"},{"id":"zowe_endevor_list_subsystems.html","text":"subsystems | subsystem | subsys | sbs"},{"id":"zowe_endevor_list_symbols.html","text":"symbols"},{"id":"zowe_endevor_list_systems.html","text":"systems | system | sys | s"},{"id":"zowe_endevor_list_tasks.html","text":"tasks"},{"id":"zowe_endevor_list_type-sequence.html","text":"type-sequence | typeseq"},{"id":"zowe_endevor_list_types.html","text":"types | type | t"}]},{"id":"zowe_endevor_merge.html","text":"merge | mrg","children":[{"id":"zowe_endevor_merge_element.html","text":"element | ele"}]},{"id":"zowe_endevor_move.html","text":"move | mv","children":[{"id":"zowe_endevor_move_element.html","text":"element | elem | ele"}]},{"id":"zowe_endevor_print.html","text":"print | p","children":[{"id":"zowe_endevor_print_components.html","text":"components | comp"},{"id":"zowe_endevor_print_element.html","text":"element | elem | ele"},{"id":"zowe_endevor_print_member.html","text":"member | mem"}]},{"id":"zowe_endevor_queryacm.html","text":"queryacm","children":[{"id":"zowe_endevor_queryacm_components.html","text":"components | comp"}]},{"id":"zowe_endevor_reset.html","text":"reset","children":[{"id":"zowe_endevor_reset_package.html","text":"package | pkg"}]},{"id":"zowe_endevor_retrieve.html","text":"retrieve | ret","children":[{"id":"zowe_endevor_retrieve_element.html","text":"element | elem | ele"},{"id":"zowe_endevor_retrieve_result.html","text":"result | res"}]},{"id":"zowe_endevor_signin.html","text":"signin | si","children":[{"id":"zowe_endevor_signin_element.html","text":"element | elem | ele"}]},{"id":"zowe_endevor_submit.html","text":"submit","children":[{"id":"zowe_endevor_submit_package.html","text":"package | pkg"},{"id":"zowe_endevor_submit_scl.html","text":"scl"}]},{"id":"zowe_endevor_synchronize.html","text":"synchronize | sync","children":[{"id":"zowe_endevor_synchronize_workspace.html","text":"workspace | wsp"}]},{"id":"zowe_endevor_transfer.html","text":"transfer | tr","children":[{"id":"zowe_endevor_transfer_element.html","text":"element | elem | ele"}]},{"id":"zowe_endevor_unsynchronize.html","text":"unsynchronize | unsync","children":[{"id":"zowe_endevor_unsynchronize_workspace.html","text":"workspace | wsp"}]},{"id":"zowe_endevor_update.html","text":"update","children":[{"id":"zowe_endevor_update_element.html","text":"element | elem | ele"},{"id":"zowe_endevor_update_package.html","text":"package | pkg"}]},{"id":"zowe_endevor_view.html","text":"view","children":[{"id":"zowe_endevor_view_element.html","text":"element | elem | ele"},{"id":"zowe_endevor_view_pkgscl.html","text":"pkgscl | packagescl"}]}]},{"id":"zowe_endevor-bridge-for-git.html","text":"endevor-bridge-for-git | ebg","children":[{"id":"zowe_endevor-bridge-for-git_branch.html","text":"branch | br","children":[{"id":"zowe_endevor-bridge-for-git_branch_add.html","text":"add | a"},{"id":"zowe_endevor-bridge-for-git_branch_delete.html","text":"delete | d"},{"id":"zowe_endevor-bridge-for-git_branch_list.html","text":"list | ls"}]},{"id":"zowe_endevor-bridge-for-git_build.html","text":"build | b","children":[{"id":"zowe_endevor-bridge-for-git_build_execute.html","text":"execute | exec"},{"id":"zowe_endevor-bridge-for-git_build_job-report.html","text":"job-report | jr"},{"id":"zowe_endevor-bridge-for-git_build_job-submit.html","text":"job-submit | js"}]},{"id":"zowe_endevor-bridge-for-git_endevor-connection.html","text":"endevor-connection | co","children":[{"id":"zowe_endevor-bridge-for-git_endevor-connection_create.html","text":"create | c"},{"id":"zowe_endevor-bridge-for-git_endevor-connection_delete.html","text":"delete | del"},{"id":"zowe_endevor-bridge-for-git_endevor-connection_list.html","text":"list | ls"},{"id":"zowe_endevor-bridge-for-git_endevor-connection_rename.html","text":"rename | ren"},{"id":"zowe_endevor-bridge-for-git_endevor-connection_update-credentials.html","text":"update-credentials | uc"}]},{"id":"zowe_endevor-bridge-for-git_endevor-credentials.html","text":"endevor-credentials | ec","children":[{"id":"zowe_endevor-bridge-for-git_endevor-credentials_update.html","text":"update | u"}]},{"id":"zowe_endevor-bridge-for-git_local-hook-token.html","text":"local-hook-token | token","children":[{"id":"zowe_endevor-bridge-for-git_local-hook-token_generate.html","text":"generate | g"},{"id":"zowe_endevor-bridge-for-git_local-hook-token_list.html","text":"list | ls"},{"id":"zowe_endevor-bridge-for-git_local-hook-token_revoke.html","text":"revoke | r"}]},{"id":"zowe_endevor-bridge-for-git_mapping.html","text":"mapping | m","children":[{"id":"zowe_endevor-bridge-for-git_mapping_add-element.html","text":"add-element | add"},{"id":"zowe_endevor-bridge-for-git_mapping_create.html","text":"create | c"},{"id":"zowe_endevor-bridge-for-git_mapping_delete.html","text":"delete | del"},{"id":"zowe_endevor-bridge-for-git_mapping_list.html","text":"list | ls"}]},{"id":"zowe_endevor-bridge-for-git_processor-group.html","text":"processor-group | proc-group | pg","children":[{"id":"zowe_endevor-bridge-for-git_processor-group_list.html","text":"list | ls"},{"id":"zowe_endevor-bridge-for-git_processor-group_update.html","text":"update | u"},{"id":"zowe_endevor-bridge-for-git_processor-group_update-all.html","text":"update-all | ua"}]},{"id":"zowe_endevor-bridge-for-git_work-area.html","text":"work-area | wa","children":[{"id":"zowe_endevor-bridge-for-git_work-area_list.html","text":"list | ls"},{"id":"zowe_endevor-bridge-for-git_work-area_reserve.html","text":"reserve | r"},{"id":"zowe_endevor-bridge-for-git_work-area_unreserve.html","text":"unreserve | unr"}]}]},{"id":"zowe_file-master-plus.html","text":"file-master-plus | fmp","children":[{"id":"zowe_file-master-plus_copy.html","text":"copy | c","children":[{"id":"zowe_file-master-plus_copy_data-set.html","text":"data-set | ds"}]},{"id":"zowe_file-master-plus_create.html","text":"create | cre","children":[{"id":"zowe_file-master-plus_create_large-format-sequential.html","text":"large-format-sequential | large"},{"id":"zowe_file-master-plus_create_like-model.html","text":"like-model | model | lm"},{"id":"zowe_file-master-plus_create_partitioned-data-set.html","text":"partitioned-data-set | pds"},{"id":"zowe_file-master-plus_create_partitioned-data-set-extended.html","text":"partitioned-data-set-extended | pdse"},{"id":"zowe_file-master-plus_create_physical-sequential.html","text":"physical-sequential | ps"},{"id":"zowe_file-master-plus_create_vsam-esds.html","text":"vsam-esds | esds"},{"id":"zowe_file-master-plus_create_vsam-ksds.html","text":"vsam-ksds | ksds"},{"id":"zowe_file-master-plus_create_vsam-lds.html","text":"vsam-lds | lds"},{"id":"zowe_file-master-plus_create_vsam-rrds.html","text":"vsam-rrds | rrds"},{"id":"zowe_file-master-plus_create_vsam-vrrds.html","text":"vsam-vrrds | vrrds"}]},{"id":"zowe_file-master-plus_delete.html","text":"delete | del","children":[{"id":"zowe_file-master-plus_delete_data-set.html","text":"data-set | ds"}]},{"id":"zowe_file-master-plus_populate.html","text":"populate | pop","children":[{"id":"zowe_file-master-plus_populate_data-set.html","text":"data-set | ds"}]},{"id":"zowe_file-master-plus_rename.html","text":"rename | ren","children":[{"id":"zowe_file-master-plus_rename_data-set.html","text":"data-set | ds"}]}]},{"id":"zowe_idms.html","text":"idms","children":[{"id":"zowe_idms_issue.html","text":"issue | iss","children":[{"id":"zowe_idms_issue_dcmt-display.html","text":"dcmt-display | dd"},{"id":"zowe_idms_issue_dcmt-help.html","text":"dcmt-help | dh"},{"id":"zowe_idms_issue_dcmt-quiesce.html","text":"dcmt-quiesce | dq"},{"id":"zowe_idms_issue_dcmt-shutdown.html","text":"dcmt-shutdown | shutdown"},{"id":"zowe_idms_issue_dcmt-statistics.html","text":"dcmt-statistics | ds"},{"id":"zowe_idms_issue_dcmt-test.html","text":"dcmt-test | dt"},{"id":"zowe_idms_issue_dcmt-vary.html","text":"dcmt-vary | dv"},{"id":"zowe_idms_issue_dcuf-help.html","text":"dcuf-help | dfh"},{"id":"zowe_idms_issue_dcuf-show.html","text":"dcuf-show | dfs"}]},{"id":"zowe_idms_list.html","text":"list | ls","children":[{"id":"zowe_idms_list_datasources.html","text":"datasources | ds"},{"id":"zowe_idms_list_log.html","text":"log"},{"id":"zowe_idms_list_systems.html","text":"systems | sys"},{"id":"zowe_idms_list_transactions.html","text":"transactions | ts"},{"id":"zowe_idms_list_user-tasks.html","text":"user-tasks | ut"}]}]},{"id":"zowe_ims.html","text":"ims","children":[{"id":"zowe_ims_query.html","text":"query | qry","children":[{"id":"zowe_ims_query_program.html","text":"program | pgm"},{"id":"zowe_ims_query_region.html","text":"region | reg"},{"id":"zowe_ims_query_transaction.html","text":"transaction | tran"}]},{"id":"zowe_ims_start.html","text":"start | sta","children":[{"id":"zowe_ims_start_program.html","text":"program | pgm"},{"id":"zowe_ims_start_region.html","text":"region | reg"},{"id":"zowe_ims_start_transaction.html","text":"transaction | tran"}]},{"id":"zowe_ims_stop.html","text":"stop | sto","children":[{"id":"zowe_ims_stop_program.html","text":"program | pgm"},{"id":"zowe_ims_stop_region.html","text":"region | reg"},{"id":"zowe_ims_stop_transaction.html","text":"transaction | tran"}]},{"id":"zowe_ims_update.html","text":"update | upd","children":[{"id":"zowe_ims_update_program.html","text":"program | pgm"},{"id":"zowe_ims_update_transaction.html","text":"transaction | tran"}]}]},{"id":"zowe_jclcheck.html","text":"jclcheck | jck","children":[{"id":"zowe_jclcheck_check.html","text":"check | ck","children":[{"id":"zowe_jclcheck_check_data-set.html","text":"data-set | ds"},{"id":"zowe_jclcheck_check_local-file.html","text":"local-file | lf"}]}]},{"id":"zowe_mat.html","text":"mat | mat","children":[{"id":"zowe_mat_monitor.html","text":"monitor","children":[{"id":"zowe_mat_monitor_codeview.html","text":"codeview","children":[{"id":"zowe_mat_monitor_codeview_callerid.html","text":"callerid | cil"},{"id":"zowe_mat_monitor_codeview_csect.html","text":"csect | cs"},{"id":"zowe_mat_monitor_codeview_histogram.html","text":"histogram | hsg"},{"id":"zowe_mat_monitor_codeview_module.html","text":"module | cm"}]},{"id":"zowe_mat_monitor_db2.html","text":"db2","children":[{"id":"zowe_mat_monitor_db2_db2view.html","text":"db2view | db2v"},{"id":"zowe_mat_monitor_db2_sqlstmt.html","text":"sqlstmt | sql"}]},{"id":"zowe_mat_monitor_delayview.html","text":"delayview","children":[{"id":"zowe_mat_monitor_delayview_address.html","text":"address | ad"},{"id":"zowe_mat_monitor_delayview_delay.html","text":"delay | de"}]},{"id":"zowe_mat_monitor_history.html","text":"history | hs"},{"id":"zowe_mat_monitor_overview.html","text":"overview | ov"}]},{"id":"zowe_mat_profile.html","text":"profile","children":[{"id":"zowe_mat_profile_create.html","text":"create | cr"},{"id":"zowe_mat_profile_invoke.html","text":"invoke | ivk"},{"id":"zowe_mat_profile_list.html","text":"list | lip"}]}]},{"id":"zowe_mat-pma-util.html","text":"mat-pma-util | pma","children":[{"id":"zowe_mat-pma-util_get.html","text":"get | gt","children":[{"id":"zowe_mat-pma-util_get_alert.html","text":"alert | at"},{"id":"zowe_mat-pma-util_get_alert-by-job.html","text":"alert-by-job | abyj"},{"id":"zowe_mat-pma-util_get_perf.html","text":"perf | pf"}]},{"id":"zowe_mat-pma-util_scope.html","text":"scope | scp","children":[{"id":"zowe_mat-pma-util_scope_del-job.html","text":"del-job | delj"},{"id":"zowe_mat-pma-util_scope_del-pgm.html","text":"del-pgm | delp"},{"id":"zowe_mat-pma-util_scope_exl-pgm.html","text":"exl-pgm | exlp"},{"id":"zowe_mat-pma-util_scope_get-listj.html","text":"get-listj | getlj"},{"id":"zowe_mat-pma-util_scope_get-listp.html","text":"get-listp | getlp"},{"id":"zowe_mat-pma-util_scope_inc-job.html","text":"inc-job | incj"}]}]},{"id":"zowe_mq.html","text":"mq","children":[{"id":"zowe_mq_run.html","text":"run","children":[{"id":"zowe_mq_run_mqsc.html","text":"mqsc"}]}]},{"id":"zowe_omspool.html","text":"omspool | esf","children":[{"id":"zowe_omspool_issue.html","text":"issue | is","children":[{"id":"zowe_omspool_issue_command.html","text":"command | cmd"}]}]},{"id":"zowe_ops.html","text":"ops","children":[{"id":"zowe_ops_disable.html","text":"disable","children":[{"id":"zowe_ops_disable_rule.html","text":"rule"}]},{"id":"zowe_ops_enable.html","text":"enable","children":[{"id":"zowe_ops_enable_rule.html","text":"rule"}]},{"id":"zowe_ops_show.html","text":"show","children":[{"id":"zowe_ops_show_resource.html","text":"resource"},{"id":"zowe_ops_show_rule.html","text":"rule"}]},{"id":"zowe_ops_start.html","text":"start","children":[{"id":"zowe_ops_start_resource.html","text":"resource"}]},{"id":"zowe_ops_stop.html","text":"stop","children":[{"id":"zowe_ops_stop_resource.html","text":"resource"}]}]},{"id":"zowe_plugins.html","text":"plugins","children":[{"id":"zowe_plugins_install.html","text":"install"},{"id":"zowe_plugins_list.html","text":"list"},{"id":"zowe_plugins_show-first-steps.html","text":"show-first-steps | fs"},{"id":"zowe_plugins_uninstall.html","text":"uninstall"},{"id":"zowe_plugins_update.html","text":"update"},{"id":"zowe_plugins_validate.html","text":"validate"}]},{"id":"zowe_profiles.html","text":"profiles","children":[{"id":"zowe_profiles_create.html","text":"create | cre","children":[{"id":"zowe_profiles_create_base-profile.html","text":"base-profile | base"},{"id":"zowe_profiles_create_ca7-profile.html","text":"ca7-profile | ca7"},{"id":"zowe_profiles_create_caview-profile.html","text":"caview-profile | caview"},{"id":"zowe_profiles_create_cics-profile.html","text":"cics-profile | cics"},{"id":"zowe_profiles_create_db2-profile.html","text":"db2-profile | db2"},{"id":"zowe_profiles_create_dbm-db2-options-profile.html","text":"dbm-db2-options-profile | dbm-db2-options"},{"id":"zowe_profiles_create_dbm-db2-profile.html","text":"dbm-db2-profile | dbm-db2"},{"id":"zowe_profiles_create_ebg-profile.html","text":"ebg-profile | ebg"},{"id":"zowe_profiles_create_endevor-location-profile.html","text":"endevor-location-profile | endevor-location"},{"id":"zowe_profiles_create_endevor-profile.html","text":"endevor-profile | endevor"},{"id":"zowe_profiles_create_fmp-profile.html","text":"fmp-profile | fmp"},{"id":"zowe_profiles_create_idms-profile.html","text":"idms-profile | idms"},{"id":"zowe_profiles_create_ims-profile.html","text":"ims-profile | ims"},{"id":"zowe_profiles_create_jclcheck-profile.html","text":"jclcheck-profile | jclcheck"},{"id":"zowe_profiles_create_jclx-profile.html","text":"jclx-profile | jclx"},{"id":"zowe_profiles_create_mat-profile.html","text":"mat-profile | mat"},{"id":"zowe_profiles_create_mq-profile.html","text":"mq-profile | mq"},{"id":"zowe_profiles_create_omspool-profile.html","text":"omspool-profile | omspool"},{"id":"zowe_profiles_create_ops-profile.html","text":"ops-profile | ops"},{"id":"zowe_profiles_create_pma-profile.html","text":"pma-profile | pma"},{"id":"zowe_profiles_create_ssh-profile.html","text":"ssh-profile | ssh"},{"id":"zowe_profiles_create_sysview-format-profile.html","text":"sysview-format-profile | sysview-format"},{"id":"zowe_profiles_create_sysview-profile.html","text":"sysview-profile | sysview"},{"id":"zowe_profiles_create_tso-profile.html","text":"tso-profile | tso"},{"id":"zowe_profiles_create_zftp-profile.html","text":"zftp-profile | zftp"},{"id":"zowe_profiles_create_zosmf-profile.html","text":"zosmf-profile | zosmf"}]},{"id":"zowe_profiles_delete.html","text":"delete | rm","children":[{"id":"zowe_profiles_delete_base-profile.html","text":"base-profile | base"},{"id":"zowe_profiles_delete_ca7-profile.html","text":"ca7-profile | ca7"},{"id":"zowe_profiles_delete_caview-profile.html","text":"caview-profile | caview"},{"id":"zowe_profiles_delete_cics-profile.html","text":"cics-profile | cics"},{"id":"zowe_profiles_delete_db2-profile.html","text":"db2-profile | db2"},{"id":"zowe_profiles_delete_dbm-db2-options-profile.html","text":"dbm-db2-options-profile | dbm-db2-options"},{"id":"zowe_profiles_delete_dbm-db2-profile.html","text":"dbm-db2-profile | dbm-db2"},{"id":"zowe_profiles_delete_ebg-profile.html","text":"ebg-profile | ebg"},{"id":"zowe_profiles_delete_endevor-location-profile.html","text":"endevor-location-profile | endevor-location"},{"id":"zowe_profiles_delete_endevor-profile.html","text":"endevor-profile | endevor"},{"id":"zowe_profiles_delete_fmp-profile.html","text":"fmp-profile | fmp"},{"id":"zowe_profiles_delete_idms-profile.html","text":"idms-profile | idms"},{"id":"zowe_profiles_delete_ims-profile.html","text":"ims-profile | ims"},{"id":"zowe_profiles_delete_jclcheck-profile.html","text":"jclcheck-profile | jclcheck"},{"id":"zowe_profiles_delete_jclx-profile.html","text":"jclx-profile | jclx"},{"id":"zowe_profiles_delete_mat-profile.html","text":"mat-profile | mat"},{"id":"zowe_profiles_delete_mq-profile.html","text":"mq-profile | mq"},{"id":"zowe_profiles_delete_omspool-profile.html","text":"omspool-profile | omspool"},{"id":"zowe_profiles_delete_ops-profile.html","text":"ops-profile | ops"},{"id":"zowe_profiles_delete_pma-profile.html","text":"pma-profile | pma"},{"id":"zowe_profiles_delete_ssh-profile.html","text":"ssh-profile | ssh"},{"id":"zowe_profiles_delete_sysview-format-profile.html","text":"sysview-format-profile | sysview-format"},{"id":"zowe_profiles_delete_sysview-profile.html","text":"sysview-profile | sysview"},{"id":"zowe_profiles_delete_tso-profile.html","text":"tso-profile | tso"},{"id":"zowe_profiles_delete_zftp-profile.html","text":"zftp-profile | zftp"},{"id":"zowe_profiles_delete_zosmf-profile.html","text":"zosmf-profile | zosmf"}]},{"id":"zowe_profiles_list.html","text":"list | ls","children":[{"id":"zowe_profiles_list_base-profiles.html","text":"base-profiles | base"},{"id":"zowe_profiles_list_ca7-profiles.html","text":"ca7-profiles | ca7"},{"id":"zowe_profiles_list_caview-profiles.html","text":"caview-profiles | caview"},{"id":"zowe_profiles_list_cics-profiles.html","text":"cics-profiles | cics"},{"id":"zowe_profiles_list_db2-profiles.html","text":"db2-profiles | db2"},{"id":"zowe_profiles_list_dbm-db2-options-profiles.html","text":"dbm-db2-options-profiles | dbm-db2-options"},{"id":"zowe_profiles_list_dbm-db2-profiles.html","text":"dbm-db2-profiles | dbm-db2"},{"id":"zowe_profiles_list_ebg-profiles.html","text":"ebg-profiles | ebg"},{"id":"zowe_profiles_list_endevor-location-profiles.html","text":"endevor-location-profiles | endevor-location"},{"id":"zowe_profiles_list_endevor-profiles.html","text":"endevor-profiles | endevor"},{"id":"zowe_profiles_list_fmp-profiles.html","text":"fmp-profiles | fmp"},{"id":"zowe_profiles_list_idms-profiles.html","text":"idms-profiles | idms"},{"id":"zowe_profiles_list_ims-profiles.html","text":"ims-profiles | ims"},{"id":"zowe_profiles_list_jclcheck-profiles.html","text":"jclcheck-profiles | jclcheck"},{"id":"zowe_profiles_list_jclx-profiles.html","text":"jclx-profiles | jclx"},{"id":"zowe_profiles_list_mat-profiles.html","text":"mat-profiles | mat"},{"id":"zowe_profiles_list_mq-profiles.html","text":"mq-profiles | mq"},{"id":"zowe_profiles_list_omspool-profiles.html","text":"omspool-profiles | omspool"},{"id":"zowe_profiles_list_ops-profiles.html","text":"ops-profiles | ops"},{"id":"zowe_profiles_list_pma-profiles.html","text":"pma-profiles | pma"},{"id":"zowe_profiles_list_ssh-profiles.html","text":"ssh-profiles | ssh"},{"id":"zowe_profiles_list_sysview-format-profiles.html","text":"sysview-format-profiles | sysview-format"},{"id":"zowe_profiles_list_sysview-profiles.html","text":"sysview-profiles | sysview"},{"id":"zowe_profiles_list_tso-profiles.html","text":"tso-profiles | tso"},{"id":"zowe_profiles_list_zftp-profiles.html","text":"zftp-profiles | zftp"},{"id":"zowe_profiles_list_zosmf-profiles.html","text":"zosmf-profiles | zosmf"}]},{"id":"zowe_profiles_set-default.html","text":"set-default | set","children":[{"id":"zowe_profiles_set-default_base-profile.html","text":"base-profile | base"},{"id":"zowe_profiles_set-default_ca7-profile.html","text":"ca7-profile | ca7"},{"id":"zowe_profiles_set-default_caview-profile.html","text":"caview-profile | caview"},{"id":"zowe_profiles_set-default_cics-profile.html","text":"cics-profile | cics"},{"id":"zowe_profiles_set-default_db2-profile.html","text":"db2-profile | db2"},{"id":"zowe_profiles_set-default_dbm-db2-options-profile.html","text":"dbm-db2-options-profile | dbm-db2-options"},{"id":"zowe_profiles_set-default_dbm-db2-profile.html","text":"dbm-db2-profile | dbm-db2"},{"id":"zowe_profiles_set-default_ebg-profile.html","text":"ebg-profile | ebg"},{"id":"zowe_profiles_set-default_endevor-location-profile.html","text":"endevor-location-profile | endevor-location"},{"id":"zowe_profiles_set-default_endevor-profile.html","text":"endevor-profile | endevor"},{"id":"zowe_profiles_set-default_fmp-profile.html","text":"fmp-profile | fmp"},{"id":"zowe_profiles_set-default_idms-profile.html","text":"idms-profile | idms"},{"id":"zowe_profiles_set-default_ims-profile.html","text":"ims-profile | ims"},{"id":"zowe_profiles_set-default_jclcheck-profile.html","text":"jclcheck-profile | jclcheck"},{"id":"zowe_profiles_set-default_jclx-profile.html","text":"jclx-profile | jclx"},{"id":"zowe_profiles_set-default_mat-profile.html","text":"mat-profile | mat"},{"id":"zowe_profiles_set-default_mq-profile.html","text":"mq-profile | mq"},{"id":"zowe_profiles_set-default_omspool-profile.html","text":"omspool-profile | omspool"},{"id":"zowe_profiles_set-default_ops-profile.html","text":"ops-profile | ops"},{"id":"zowe_profiles_set-default_pma-profile.html","text":"pma-profile | pma"},{"id":"zowe_profiles_set-default_ssh-profile.html","text":"ssh-profile | ssh"},{"id":"zowe_profiles_set-default_sysview-format-profile.html","text":"sysview-format-profile | sysview-format"},{"id":"zowe_profiles_set-default_sysview-profile.html","text":"sysview-profile | sysview"},{"id":"zowe_profiles_set-default_tso-profile.html","text":"tso-profile | tso"},{"id":"zowe_profiles_set-default_zftp-profile.html","text":"zftp-profile | zftp"},{"id":"zowe_profiles_set-default_zosmf-profile.html","text":"zosmf-profile | zosmf"}]},{"id":"zowe_profiles_update.html","text":"update | upd","children":[{"id":"zowe_profiles_update_base-profile.html","text":"base-profile | base"},{"id":"zowe_profiles_update_ca7-profile.html","text":"ca7-profile | ca7"},{"id":"zowe_profiles_update_caview-profile.html","text":"caview-profile | caview"},{"id":"zowe_profiles_update_cics-profile.html","text":"cics-profile | cics"},{"id":"zowe_profiles_update_db2-profile.html","text":"db2-profile | db2"},{"id":"zowe_profiles_update_dbm-db2-options-profile.html","text":"dbm-db2-options-profile | dbm-db2-options"},{"id":"zowe_profiles_update_dbm-db2-profile.html","text":"dbm-db2-profile | dbm-db2"},{"id":"zowe_profiles_update_ebg-profile.html","text":"ebg-profile | ebg"},{"id":"zowe_profiles_update_endevor-location-profile.html","text":"endevor-location-profile | endevor-location"},{"id":"zowe_profiles_update_endevor-profile.html","text":"endevor-profile | endevor"},{"id":"zowe_profiles_update_fmp-profile.html","text":"fmp-profile | fmp"},{"id":"zowe_profiles_update_idms-profile.html","text":"idms-profile | idms"},{"id":"zowe_profiles_update_ims-profile.html","text":"ims-profile | ims"},{"id":"zowe_profiles_update_jclcheck-profile.html","text":"jclcheck-profile | jclcheck"},{"id":"zowe_profiles_update_jclx-profile.html","text":"jclx-profile | jclx"},{"id":"zowe_profiles_update_mat-profile.html","text":"mat-profile | mat"},{"id":"zowe_profiles_update_mq-profile.html","text":"mq-profile | mq"},{"id":"zowe_profiles_update_omspool-profile.html","text":"omspool-profile | omspool"},{"id":"zowe_profiles_update_ops-profile.html","text":"ops-profile | ops"},{"id":"zowe_profiles_update_pma-profile.html","text":"pma-profile | pma"},{"id":"zowe_profiles_update_ssh-profile.html","text":"ssh-profile | ssh"},{"id":"zowe_profiles_update_sysview-format-profile.html","text":"sysview-format-profile | sysview-format"},{"id":"zowe_profiles_update_sysview-profile.html","text":"sysview-profile | sysview"},{"id":"zowe_profiles_update_tso-profile.html","text":"tso-profile | tso"},{"id":"zowe_profiles_update_zftp-profile.html","text":"zftp-profile | zftp"},{"id":"zowe_profiles_update_zosmf-profile.html","text":"zosmf-profile | zosmf"}]}]},{"id":"zowe_provisioning.html","text":"provisioning | pv","children":[{"id":"zowe_provisioning_delete.html","text":"delete | del","children":[{"id":"zowe_provisioning_delete_instance.html","text":"instance | i"}]},{"id":"zowe_provisioning_list.html","text":"list | ls","children":[{"id":"zowe_provisioning_list_catalog-templates.html","text":"catalog-templates | ct"},{"id":"zowe_provisioning_list_instance-info.html","text":"instance-info | ii"},{"id":"zowe_provisioning_list_instance-variables.html","text":"instance-variables | iv"},{"id":"zowe_provisioning_list_registry-instances.html","text":"registry-instances | ri"},{"id":"zowe_provisioning_list_template-info.html","text":"template-info | ti"}]},{"id":"zowe_provisioning_perform.html","text":"perform | perf","children":[{"id":"zowe_provisioning_perform_action.html","text":"action | act"}]},{"id":"zowe_provisioning_provision.html","text":"provision | prov","children":[{"id":"zowe_provisioning_provision_template.html","text":"template | tem"}]}]},{"id":"zowe_sysview.html","text":"sysview | sv","children":[{"id":"zowe_sysview_capture.html","text":"capture | cap"},{"id":"zowe_sysview_capture-immediate.html","text":"capture-immediate | cap-imm"},{"id":"zowe_sysview_check.html","text":"check","children":[{"id":"zowe_sysview_check_status.html","text":"status"}]},{"id":"zowe_sysview_display.html","text":"display | dsp"},{"id":"zowe_sysview_execute.html","text":"execute | exe"}]},{"id":"zowe_zjcl-expert.html","text":"zjcl-expert | jclx","children":[{"id":"zowe_zjcl-expert_local.html","text":"local | l"},{"id":"zowe_zjcl-expert_remote-ds.html","text":"remote-ds | ds"},{"id":"zowe_zjcl-expert_remote-fs.html","text":"remote-fs | fs"}]},{"id":"zowe_zos-console.html","text":"zos-console | console","children":[{"id":"zowe_zos-console_collect.html","text":"collect","children":[{"id":"zowe_zos-console_collect_sync-responses.html","text":"sync-responses | sr"}]},{"id":"zowe_zos-console_issue.html","text":"issue","children":[{"id":"zowe_zos-console_issue_command.html","text":"command | cmd"}]}]},{"id":"zowe_zos-files.html","text":"zos-files | files","children":[{"id":"zowe_zos-files_compare.html","text":"compare | cmp","children":[{"id":"zowe_zos-files_compare_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-files_compare_local-file-data-set.html","text":"local-file-data-set | lf-ds"},{"id":"zowe_zos-files_compare_local-file-spool-dd.html","text":"local-file-spool-dd | lf-sdd"},{"id":"zowe_zos-files_compare_local-file-uss-file.html","text":"local-file-uss-file | lf-uss"},{"id":"zowe_zos-files_compare_spool-dd.html","text":"spool-dd | sdd"},{"id":"zowe_zos-files_compare_uss-files.html","text":"uss-files | uss | uf"}]},{"id":"zowe_zos-files_copy.html","text":"copy | cp","children":[{"id":"zowe_zos-files_copy_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-files_copy_data-set-cross-lpar.html","text":"data-set-cross-lpar | dsclp"}]},{"id":"zowe_zos-files_create.html","text":"create | cre","children":[{"id":"zowe_zos-files_create_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-files_create_data-set-binary.html","text":"data-set-binary | bin"},{"id":"zowe_zos-files_create_data-set-c.html","text":"data-set-c | dsc"},{"id":"zowe_zos-files_create_data-set-classic.html","text":"data-set-classic | classic"},{"id":"zowe_zos-files_create_data-set-partitioned.html","text":"data-set-partitioned | pds"},{"id":"zowe_zos-files_create_data-set-sequential.html","text":"data-set-sequential | ps"},{"id":"zowe_zos-files_create_data-set-vsam.html","text":"data-set-vsam | vsam"},{"id":"zowe_zos-files_create_uss-directory.html","text":"uss-directory | dir"},{"id":"zowe_zos-files_create_uss-file.html","text":"uss-file | file"},{"id":"zowe_zos-files_create_zos-file-system.html","text":"zos-file-system | zfs"}]},{"id":"zowe_zos-files_delete.html","text":"delete | del","children":[{"id":"zowe_zos-files_delete_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-files_delete_data-set-vsam.html","text":"data-set-vsam | vsam"},{"id":"zowe_zos-files_delete_migrated-data-set.html","text":"migrated-data-set | mds"},{"id":"zowe_zos-files_delete_uss-file.html","text":"uss-file | uf | uss"},{"id":"zowe_zos-files_delete_zos-file-system.html","text":"zos-file-system | zfs"}]},{"id":"zowe_zos-files_download.html","text":"download | dl","children":[{"id":"zowe_zos-files_download_all-members.html","text":"all-members | am"},{"id":"zowe_zos-files_download_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-files_download_data-sets-matching.html","text":"data-sets-matching | dsm | data-set-matching"},{"id":"zowe_zos-files_download_uss-directory.html","text":"uss-directory | uss-dir"},{"id":"zowe_zos-files_download_uss-file.html","text":"uss-file | uf | uss"}]},{"id":"zowe_zos-files_edit.html","text":"edit | ed","children":[{"id":"zowe_zos-files_edit_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-files_edit_uss-file.html","text":"uss-file | uss | uf"}]},{"id":"zowe_zos-files_invoke.html","text":"invoke | call","children":[{"id":"zowe_zos-files_invoke_ams-file.html","text":"ams-file | af"},{"id":"zowe_zos-files_invoke_ams-statements.html","text":"ams-statements | as"}]},{"id":"zowe_zos-files_list.html","text":"list | ls","children":[{"id":"zowe_zos-files_list_all-members.html","text":"all-members | am"},{"id":"zowe_zos-files_list_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-files_list_file-system.html","text":"file-system | fs"},{"id":"zowe_zos-files_list_uss-files.html","text":"uss-files | uf | uss"}]},{"id":"zowe_zos-files_migrate.html","text":"migrate | hmigr | hMigrate","children":[{"id":"zowe_zos-files_migrate_data-set.html","text":"data-set | ds"}]},{"id":"zowe_zos-files_mount.html","text":"mount","children":[{"id":"zowe_zos-files_mount_file-system.html","text":"file-system | fs"}]},{"id":"zowe_zos-files_recall.html","text":"recall | hrec | hRecall","children":[{"id":"zowe_zos-files_recall_data-set.html","text":"data-set | ds"}]},{"id":"zowe_zos-files_rename.html","text":"rename","children":[{"id":"zowe_zos-files_rename_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-files_rename_data-set-member.html","text":"data-set-member | dsm"}]},{"id":"zowe_zos-files_unmount.html","text":"unmount | umount","children":[{"id":"zowe_zos-files_unmount_file-system.html","text":"file-system | fs"}]},{"id":"zowe_zos-files_upload.html","text":"upload | ul","children":[{"id":"zowe_zos-files_upload_dir-to-pds.html","text":"dir-to-pds | dtp"},{"id":"zowe_zos-files_upload_dir-to-uss.html","text":"dir-to-uss | dtu"},{"id":"zowe_zos-files_upload_file-to-data-set.html","text":"file-to-data-set | ftds"},{"id":"zowe_zos-files_upload_file-to-uss.html","text":"file-to-uss | ftu"},{"id":"zowe_zos-files_upload_stdin-to-data-set.html","text":"stdin-to-data-set | stds"}]},{"id":"zowe_zos-files_view.html","text":"view | vw","children":[{"id":"zowe_zos-files_view_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-files_view_uss-file.html","text":"uss-file | uf"}]}]},{"id":"zowe_zos-ftp.html","text":"zos-ftp | zftp","children":[{"id":"zowe_zos-ftp_allocate.html","text":"allocate | alloc","children":[{"id":"zowe_zos-ftp_allocate_data-set.html","text":"data-set | ds"}]},{"id":"zowe_zos-ftp_delete.html","text":"delete | del","children":[{"id":"zowe_zos-ftp_delete_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-ftp_delete_job.html","text":"job | j"},{"id":"zowe_zos-ftp_delete_uss-file.html","text":"uss-file | uss | uf"}]},{"id":"zowe_zos-ftp_download.html","text":"download | dl","children":[{"id":"zowe_zos-ftp_download_all-spool-by-jobid.html","text":"all-spool-by-jobid | asbj"},{"id":"zowe_zos-ftp_download_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-ftp_download_uss-file.html","text":"uss-file | uss | uf"}]},{"id":"zowe_zos-ftp_list.html","text":"list | ls","children":[{"id":"zowe_zos-ftp_list_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-ftp_list_data-set-members.html","text":"data-set-members | members"},{"id":"zowe_zos-ftp_list_jobs.html","text":"jobs | j | js"},{"id":"zowe_zos-ftp_list_spool-files-by-jobid.html","text":"spool-files-by-jobid | sfbj"},{"id":"zowe_zos-ftp_list_uss-files.html","text":"uss-files | uss | uf"}]},{"id":"zowe_zos-ftp_make.html","text":"make | mk","children":[{"id":"zowe_zos-ftp_make_uss-directory.html","text":"uss-directory | dir"}]},{"id":"zowe_zos-ftp_rename.html","text":"rename | mv","children":[{"id":"zowe_zos-ftp_rename_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-ftp_rename_uss-file.html","text":"uss-file | uss | uf"}]},{"id":"zowe_zos-ftp_submit.html","text":"submit | sub","children":[{"id":"zowe_zos-ftp_submit_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-ftp_submit_local-file.html","text":"local-file | lf"},{"id":"zowe_zos-ftp_submit_stdin.html","text":"stdin | si | in"}]},{"id":"zowe_zos-ftp_upload.html","text":"upload | ul","children":[{"id":"zowe_zos-ftp_upload_file-to-data-set.html","text":"file-to-data-set | ftds"},{"id":"zowe_zos-ftp_upload_file-to-uss-file.html","text":"file-to-uss-file | ftuf | ftu"},{"id":"zowe_zos-ftp_upload_stdin-to-data-set.html","text":"stdin-to-data-set | stds"},{"id":"zowe_zos-ftp_upload_stdin-to-uss-file.html","text":"stdin-to-uss-file | stuf | stu"}]},{"id":"zowe_zos-ftp_view.html","text":"view | vw","children":[{"id":"zowe_zos-ftp_view_all-spool-by-jobid.html","text":"all-spool-by-jobid | asbj"},{"id":"zowe_zos-ftp_view_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-ftp_view_job-status-by-jobid.html","text":"job-status-by-jobid | jsbj"},{"id":"zowe_zos-ftp_view_spool-file-by-id.html","text":"spool-file-by-id | sfbi"},{"id":"zowe_zos-ftp_view_uss-file.html","text":"uss-file | uss | uf"}]}]},{"id":"zowe_zos-jobs.html","text":"zos-jobs | jobs","children":[{"id":"zowe_zos-jobs_cancel.html","text":"cancel | can","children":[{"id":"zowe_zos-jobs_cancel_job.html","text":"job"}]},{"id":"zowe_zos-jobs_delete.html","text":"delete | del","children":[{"id":"zowe_zos-jobs_delete_job.html","text":"job"},{"id":"zowe_zos-jobs_delete_old-jobs.html","text":"old-jobs | oj"}]},{"id":"zowe_zos-jobs_download.html","text":"download | dl","children":[{"id":"zowe_zos-jobs_download_output.html","text":"output | o"}]},{"id":"zowe_zos-jobs_list.html","text":"list | ls","children":[{"id":"zowe_zos-jobs_list_jobs.html","text":"jobs | js"},{"id":"zowe_zos-jobs_list_spool-files-by-jobid.html","text":"spool-files-by-jobid | sfbj"}]},{"id":"zowe_zos-jobs_modify.html","text":"modify | mod","children":[{"id":"zowe_zos-jobs_modify_job.html","text":"job"}]},{"id":"zowe_zos-jobs_submit.html","text":"submit | sub","children":[{"id":"zowe_zos-jobs_submit_data-set.html","text":"data-set | ds"},{"id":"zowe_zos-jobs_submit_local-file.html","text":"local-file | lf"},{"id":"zowe_zos-jobs_submit_stdin.html","text":"stdin | in"},{"id":"zowe_zos-jobs_submit_uss-file.html","text":"uss-file | uf | uss"}]},{"id":"zowe_zos-jobs_view.html","text":"view | vw","children":[{"id":"zowe_zos-jobs_view_all-spool-content.html","text":"all-spool-content | asc"},{"id":"zowe_zos-jobs_view_job-status-by-jobid.html","text":"job-status-by-jobid | jsbj"},{"id":"zowe_zos-jobs_view_spool-file-by-id.html","text":"spool-file-by-id | sfbi"}]}]},{"id":"zowe_zos-logs.html","text":"zos-logs | logs","children":[{"id":"zowe_zos-logs_list.html","text":"list | ls","children":[{"id":"zowe_zos-logs_list_logs.html","text":"logs"}]}]},{"id":"zowe_zos-ssh.html","text":"zos-ssh | ssh | zos-uss | uss","children":[{"id":"zowe_zos-ssh_issue.html","text":"issue | iss","children":[{"id":"zowe_zos-ssh_issue_command.html","text":"command | cmd | ssh"}]}]},{"id":"zowe_zos-tso.html","text":"zos-tso | tso","children":[{"id":"zowe_zos-tso_issue.html","text":"issue","children":[{"id":"zowe_zos-tso_issue_command.html","text":"command | cmd"}]},{"id":"zowe_zos-tso_ping.html","text":"ping","children":[{"id":"zowe_zos-tso_ping_address-space.html","text":"address-space | as"}]},{"id":"zowe_zos-tso_send.html","text":"send","children":[{"id":"zowe_zos-tso_send_address-space.html","text":"address-space | as"}]},{"id":"zowe_zos-tso_start.html","text":"start | st","children":[{"id":"zowe_zos-tso_start_address-space.html","text":"address-space | as"}]},{"id":"zowe_zos-tso_stop.html","text":"stop | sp","children":[{"id":"zowe_zos-tso_stop_address-space.html","text":"address-space | as"}]}]},{"id":"zowe_zos-workflows.html","text":"zos-workflows | wf","children":[{"id":"zowe_zos-workflows_archive.html","text":"archive","children":[{"id":"zowe_zos-workflows_archive_active-workflow.html","text":"active-workflow | aw"}]},{"id":"zowe_zos-workflows_create.html","text":"create | cre","children":[{"id":"zowe_zos-workflows_create_workflow-from-data-set.html","text":"workflow-from-data-set | wfds"},{"id":"zowe_zos-workflows_create_workflow-from-local-file.html","text":"workflow-from-local-file | wflf"},{"id":"zowe_zos-workflows_create_workflow-from-uss-file.html","text":"workflow-from-uss-file | wfuf"}]},{"id":"zowe_zos-workflows_delete.html","text":"delete | del","children":[{"id":"zowe_zos-workflows_delete_active-workflow.html","text":"active-workflow | aw"},{"id":"zowe_zos-workflows_delete_archived-workflow.html","text":"archived-workflow | arw"}]},{"id":"zowe_zos-workflows_list.html","text":"list | ls","children":[{"id":"zowe_zos-workflows_list_active-workflow-details.html","text":"active-workflow-details | awd"},{"id":"zowe_zos-workflows_list_active-workflows.html","text":"active-workflows | aw"},{"id":"zowe_zos-workflows_list_archived-workflows.html","text":"archived-workflows | arw"},{"id":"zowe_zos-workflows_list_definition-file-details.html","text":"definition-file-details | dfd"}]},{"id":"zowe_zos-workflows_start.html","text":"start | sta","children":[{"id":"zowe_zos-workflows_start_workflow-full.html","text":"workflow-full | wf"},{"id":"zowe_zos-workflows_start_workflow-step.html","text":"workflow-step | ws"}]}]},{"id":"zowe_zosmf.html","text":"zosmf","children":[{"id":"zowe_zosmf_check.html","text":"check","children":[{"id":"zowe_zosmf_check_status.html","text":"status"}]},{"id":"zowe_zosmf_list.html","text":"list","children":[{"id":"zowe_zosmf_list_systems.html","text":"systems"}]}]}]}]; +const aliasList = {"7":["ca7"],"li":["login","line"],"lo":["logout"],"cmds":["commands"],"ar":["addrq","active-resource"],"c":["cancel","cancel-download","create","copy"],"d":["demand","delete"],"dh":["demandh","dcmt-help"],"h":["hold"],"jo":["jclovrd"],"po":["post"],"pc":["prscf"],"pq":["prsqa"],"rl":["release"],"rq":["requeue"],"rslv":["resolv"],"rs":["restart","requirement-successor"],"rsub":["rmtsub"],"rtrk":["rmttrk"],"r":["run","resource","requirements","report","revoke","reserve"],"rh":["runh"],"sm":["submit"],"st":["subtm","status","start"],"v":["verify"],"cjd":["create-job-definition"],"rp":["req-predecessor","requirement-predecessor"],"s":["schedule","syscmd","systems"],"crd":["create-resource-definition"],"rcr":["resource-count-resource"],"ds":["dataset","data-set","dcmt-statistics","datasources","remote-ds"],"cds":["create-dataset"],"cdt":["create-dataset-trigger"],"dds":["delete-dataset"],"ddt":["delete-dataset-trigger"],"rds":["rename-dataset"],"uds":["update-dataset"],"udt":["update-dataset-trigger"],"djd":["delete-job-definition"],"drd":["delete-resource-definition"],"emr":["event-manager-requests"],"js":["job-status","job-submit","jobs"],"jd":["job-definition"],"casr":["create-address-space-resource"],"ccr":["create-corequisite-resource"],"cer":["create-exclusive-resource"],"cj":["create-job"],"cjts":["create-job-trigger-successor"],"crcr":["create-resource-count-resource"],"csr":["create-shared-resource"],"cvr":["create-variable-resource"],"dasr":["delete-address-space-resource"],"dcr":["delete-corequisite-resource"],"der":["delete-exclusive-resource"],"dj":["delete-job","djc"],"djts":["delete-job-trigger-successor"],"drcr":["delete-resource-count-resource"],"dsr":["delete-shared-resource"],"dvr":["delete-variable-resource"],"lj":["list-job"],"ljts":["list-job-trigger-successor"],"uasr":["update-address-space-resource"],"ucr":["update-corequisite-resource"],"uer":["update-exclusive-resource"],"uj":["update-job"],"ujts":["update-job-trigger-successor"],"urcr":["update-resource-count-resource"],"usr":["update-shared-resource"],"ji":["job-instance"],"lwr":["list-waiting-resource"],"ljd":["list-job-definition"],"j":["job","jobs"],"p":["prose","packages","print"],"sd":["step-dd"],"tp":["trigger-predecessor"],"ts":["trigger-successor","transactions"],"ljh":["list-job-history"],"pr":["prior-run","printer"],"lji":["list-job-instance"],"l":["list","local"],"lc":["listCustom"],"lrd":["list-resource-definition"],"ujd":["update-job-definition"],"uji":["update-job-instance"],"urd":["update-resource-definition"],"cv":["caview"],"dl":["download"],"exp":["export"],"ls":["list"],"rules":["export-rules"],"repo":["report"],"indexes":["index-names"],"views":["logical-views"],"repos":["repositories"],"find":["search"],"atl":["add-to-list"],"csdg":["csdGroup"],"def":["define"],"prog":["program"],"tran":["transaction"],"uc":["urimap-client","update-credentials"],"up":["urimap-pipeline"],"us":["urimap-server","update-schemas"],"web":["webservice"],"del":["delete"],"dis":["discard"],"en":["enable"],"res":["resource","resolution","result"],"ins":["install"],"ref":["refresh"],"rfl":["remove-from-list"],"convert":["convert-profiles"],"re":["report-env"],"proc":["procedure","proclib"],"sp":["procedure","stop"],"dbm":["dbm-db2"],"a":["api","add"],"e":["exec"],"i":["init","input","issue","instances","instance"],"t":["term","types"],"b":["batch","build"],"bat":["batch"],"ac":["activity"],"apf":["apfds"],"cl":["class"],"cmd":["cmdstack","command"],"stack":["cmdstack"],"stk":["cmdstack"],"dynex":["dynexit"],"dynx":["dynexit"],"enc":["enclave"],"ent":["entry"],"gr":["group"],"hchk":["hcheck"],"hc":["hcheck"],"jesp":["jesplex"],"jg":["jgroup"],"lnkl":["lnklst"],"lnk":["lnklst"],"lpal":["lpalst"],"lpa":["lpalst"],"md":["mds"],"memuse":["memusage"],"memu":["memusage"],"mount":["mounts"],"mo":["mounts"],"netc":["netconn"],"nc":["netconn"],"nets":["netserv"],"ph":["node","ulog"],"off":["offload"],"o":["Output","writer","output"],"pag":["pageds"],"page":["pageds"],"paged":["pageds"],"parml":["parmlib"],"parm":["parmlib"],"procl":["proclib"],"pstat":["pstatus"],"ps":["pstatus","physical-sequential","data-set-sequential"],"resm":["resmon"],"rmon":["resmon"],"rm":["resmon","delete"],"reso":["resource"],"sch":["schenv"],"sess":["session"],"sh":["shell"],"prompt":["shell"],"spa":["spart"],"spv":["spvol"],"subsy":["subsys"],"subs":["subsys"],"sym":["symbol"],"sysc":["syscls"],"sysp":["sysplex"],"sys":["sysplex","systems"],"sysr":["sysreq"],"sr":["sysreq","sync-responses"],"w":["writer"],"z":["zero"],"sub":["submit"],"q":["query"],"no":["node"],"ses":["session"],"output":["writer"],"elem":["element","elements"],"ele":["element","elements"],"aprv":["approve"],"pkg":["package","packages"],"conf":["confirm"],"gen":["generate"],"init":["initialize"],"wsp":["workspace"],"codepages":["code-page-config"],"cdpg":["code-page-config"],"environment":["environments"],"env":["environments"],"instance":["instances"],"inst":["instances"],"package":["packages"],"processor-group":["processor-groups"],"pgrp":["processor-groups"],"processor-symbol":["processor-symbols"],"psym":["processor-symbols"],"stage":["stages"],"stg":["stages"],"subsystem":["subsystems"],"subsys":["subsystems"],"sbs":["subsystems"],"system":["systems"],"typeseq":["type-sequence"],"type":["types"],"mrg":["merge"],"mv":["move","rename"],"comp":["components"],"mem":["member"],"ret":["retrieve"],"si":["signin","stdin"],"sync":["synchronize"],"tr":["transfer"],"unsync":["unsynchronize"],"packagescl":["pkgscl"],"ebg":["endevor-bridge-for-git","ebg-profile","ebg-profiles"],"br":["branch"],"exec":["execute"],"jr":["job-report"],"co":["endevor-connection"],"ren":["rename"],"ec":["endevor-credentials"],"u":["update"],"token":["local-hook-token"],"g":["generate"],"m":["mapping"],"add":["add-element"],"proc-group":["processor-group"],"pg":["processor-group"],"ua":["update-all"],"wa":["work-area"],"unr":["unreserve"],"fmp":["file-master-plus","fmp-profile","fmp-profiles"],"cre":["create"],"large":["large-format-sequential"],"model":["like-model"],"lm":["like-model"],"pds":["partitioned-data-set","data-set-partitioned"],"pdse":["partitioned-data-set-extended"],"esds":["vsam-esds"],"ksds":["vsam-ksds"],"lds":["vsam-lds"],"rrds":["vsam-rrds"],"vrrds":["vsam-vrrds"],"pop":["populate"],"iss":["issue"],"dd":["dcmt-display"],"dq":["dcmt-quiesce"],"shutdown":["dcmt-shutdown"],"dt":["dcmt-test"],"dv":["dcmt-vary"],"dfh":["dcuf-help"],"dfs":["dcuf-show"],"ut":["user-tasks"],"qry":["query"],"pgm":["program"],"reg":["region"],"sta":["start"],"sto":["stop"],"upd":["update"],"jck":["jclcheck"],"ck":["check"],"lf":["local-file"],"cil":["callerid"],"cs":["csect"],"hsg":["histogram"],"cm":["module"],"db2v":["db2view"],"sql":["sqlstmt"],"ad":["address"],"de":["delay"],"hs":["history"],"ov":["overview"],"cr":["create"],"ivk":["invoke"],"lip":["list"],"pma":["mat-pma-util","pma-profile","pma-profiles"],"gt":["get"],"at":["alert"],"abyj":["alert-by-job"],"pf":["perf"],"scp":["scope"],"delj":["del-job"],"delp":["del-pgm"],"exlp":["exl-pgm"],"getlj":["get-listj"],"getlp":["get-listp"],"incj":["inc-job"],"esf":["omspool"],"is":["issue"],"fs":["show-first-steps","remote-fs","file-system"],"base":["base-profile","base-profiles"],"ca7":["ca7-profile","ca7-profiles"],"caview":["caview-profile","caview-profiles"],"cics":["cics-profile","cics-profiles"],"db2":["db2-profile","db2-profiles"],"dbm-db2-options":["dbm-db2-options-profile","dbm-db2-options-profiles"],"dbm-db2":["dbm-db2-profile","dbm-db2-profiles"],"endevor-location":["endevor-location-profile","endevor-location-profiles"],"endevor":["endevor-profile","endevor-profiles"],"idms":["idms-profile","idms-profiles"],"ims":["ims-profile","ims-profiles"],"jclcheck":["jclcheck-profile","jclcheck-profiles"],"jclx":["jclx-profile","jclx-profiles","zjcl-expert"],"mat":["mat-profile","mat-profiles"],"mq":["mq-profile","mq-profiles"],"omspool":["omspool-profile","omspool-profiles"],"ops":["ops-profile","ops-profiles"],"ssh":["ssh-profile","ssh-profiles","zos-ssh","command"],"sysview-format":["sysview-format-profile","sysview-format-profiles"],"sysview":["sysview-profile","sysview-profiles"],"tso":["tso-profile","tso-profiles","zos-tso"],"zftp":["zftp-profile","zftp-profiles","zos-ftp"],"zosmf":["zosmf-profile","zosmf-profiles"],"set":["set-default"],"pv":["provisioning"],"ct":["catalog-templates"],"ii":["instance-info"],"iv":["instance-variables"],"ri":["registry-instances"],"ti":["template-info"],"perf":["perform"],"act":["action"],"prov":["provision"],"tem":["template"],"sv":["sysview"],"cap":["capture"],"cap-imm":["capture-immediate"],"dsp":["display"],"exe":["execute"],"console":["zos-console"],"files":["zos-files"],"cmp":["compare"],"lf-ds":["local-file-data-set"],"lf-sdd":["local-file-spool-dd"],"lf-uss":["local-file-uss-file"],"sdd":["spool-dd"],"uss":["uss-files","uss-file","zos-ssh"],"uf":["uss-files","uss-file"],"cp":["copy"],"dsclp":["data-set-cross-lpar"],"bin":["data-set-binary"],"dsc":["data-set-c"],"classic":["data-set-classic"],"vsam":["data-set-vsam"],"dir":["uss-directory"],"file":["uss-file"],"zfs":["zos-file-system"],"mds":["migrated-data-set"],"am":["all-members"],"dsm":["data-sets-matching","data-set-member"],"data-set-matching":["data-sets-matching"],"uss-dir":["uss-directory"],"ed":["edit"],"call":["invoke"],"af":["ams-file"],"as":["ams-statements","address-space"],"hmigr":["migrate"],"hMigrate":["migrate"],"hrec":["recall"],"hRecall":["recall"],"umount":["unmount"],"ul":["upload"],"dtp":["dir-to-pds"],"dtu":["dir-to-uss"],"ftds":["file-to-data-set"],"ftu":["file-to-uss","file-to-uss-file"],"stds":["stdin-to-data-set"],"vw":["view"],"alloc":["allocate"],"asbj":["all-spool-by-jobid"],"members":["data-set-members"],"sfbj":["spool-files-by-jobid"],"mk":["make"],"in":["stdin"],"ftuf":["file-to-uss-file"],"stuf":["stdin-to-uss-file"],"stu":["stdin-to-uss-file"],"jsbj":["job-status-by-jobid"],"sfbi":["spool-file-by-id"],"jobs":["zos-jobs"],"can":["cancel"],"oj":["old-jobs"],"mod":["modify"],"asc":["all-spool-content"],"logs":["zos-logs"],"zos-uss":["zos-ssh"],"wf":["zos-workflows","workflow-full"],"aw":["active-workflow","active-workflows"],"wfds":["workflow-from-data-set"],"wflf":["workflow-from-local-file"],"wfuf":["workflow-from-uss-file"],"arw":["archived-workflow","archived-workflows"],"awd":["active-workflow-details"],"dfd":["definition-file-details"],"ws":["workflow-step"]}; \ No newline at end of file diff --git a/static/v2.15.x/zosmf_lite_samples.zip b/static/v2.15.x/zosmf_lite_samples.zip new file mode 100644 index 0000000000..b0b403b4de Binary files /dev/null and b/static/v2.15.x/zosmf_lite_samples.zip differ diff --git a/static/v2.15.x/zowe-nodejs-sdk-typedoc.zip b/static/v2.15.x/zowe-nodejs-sdk-typedoc.zip new file mode 100644 index 0000000000..e2bf7947ce Binary files /dev/null and b/static/v2.15.x/zowe-nodejs-sdk-typedoc.zip differ diff --git a/static/v2.15.x/zowe_apiml_tpsrs.zip b/static/v2.15.x/zowe_apiml_tpsrs.zip new file mode 100644 index 0000000000..dbab34fe60 Binary files /dev/null and b/static/v2.15.x/zowe_apiml_tpsrs.zip differ diff --git a/static/v2.15.x/zowe_cli_tpsrs.zip b/static/v2.15.x/zowe_cli_tpsrs.zip new file mode 100644 index 0000000000..59aa63b6ef Binary files /dev/null and b/static/v2.15.x/zowe_cli_tpsrs.zip differ diff --git a/static/v2.15.x/zowe_web_help.zip b/static/v2.15.x/zowe_web_help.zip new file mode 100644 index 0000000000..6813f3d67c Binary files /dev/null and b/static/v2.15.x/zowe_web_help.zip differ diff --git a/versioned_docs/version-v2.15.x/appendix/bill-of-materials.md b/versioned_docs/version-v2.15.x/appendix/bill-of-materials.md new file mode 100644 index 0000000000..f7eb82a837 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/bill-of-materials.md @@ -0,0 +1,12 @@ +# Bill of Materials + +Zowe™ uses the SPDX SBOM format to represent its bill of materials. To read more about why SBOMs and SPDX are used, see [this blog](https://www.linuxfoundation.org/blog/spdx-its-already-in-use-for-global-software-bill-of-materials-sbom-and-supply-chain-security/). The hash codes can be used to validate your download is authentic using a command like `openssl dgst -sha1 `. Zowe SBOMs are as follows: + +| Type | Component | SBOM Link | SHA-1 Hash | +| --- | --- | --- | --- | +| Artifact SBOM | Zowe z/OS Components (PAX, SMP/E, PSWI) | [SBOM Link](https://zowe.jfrog.io/zowe/list/libs-release-local/org/zowe/sbom/2.0.0/zowe_pax_sbom.zip) | 3ed80afaadfdabe1112c7063fe297d5f | +| Artifact SBOM | Zowe CLI Standalone Package | [SBOM Link](https://zowe.jfrog.io/zowe/list/libs-release-local/org/zowe/sbom/2.0.0/zowe_cli_standalone_sbom.zip) | 98b75ca32cc08664574da1886d28c625463cceba | +| Artifact SBOM | Zowe CLI Standalone Plugins Package | [SBOM Link](https://zowe.jfrog.io/zowe/list/libs-release-local/org/zowe/sbom/2.0.0/zowe_cli_standalone_plugins_sbom.zip) | 7d1e06e579b4dcc69c44405a47dfebc386426b0f | +| Artifact SBOM | Zowe Client NodeJS SDK | [SBOM Link](https://zowe.jfrog.io/zowe/list/libs-release-local/org/zowe/sbom/2.0.0/zowe_client_node_sdk_sbom.zip) | c61bd6b9f78ba2aa67a0f4e53874a097992d8155 | +| Artifact SBOM | Zowe Client Python SDK | [SBOM Link](https://zowe.jfrog.io/zowe/list/libs-release-local/org/zowe/sbom/2.0.0/zowe_client_python_sdk_sbom.zip) | 637c5f90f94a88cb534bead7755fac112b509217 | +| Source Code SBOM | All Zowe's Source Repositories used in final artifacts | [SBOM Link](https://zowe.jfrog.io/zowe/list/libs-release-local/org/zowe/sbom/2.0.0/zowe_sources_sbom.zip) | 19d2b81b0fa2955d165123871c72c2c77ddf73b7 | diff --git a/versioned_docs/version-v2.15.x/appendix/server-component-manifest.md b/versioned_docs/version-v2.15.x/appendix/server-component-manifest.md new file mode 100644 index 0000000000..775704e577 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/server-component-manifest.md @@ -0,0 +1,194 @@ +# Server component manifest file reference + +Zowe server component manifest file defines the name and purpose of the component. It also provides information about how this component should be installed, configured, and started. It can be named as `manifest.yaml`, `manifest.yml`, or `manifest.json` and should be located in the root directory of the component. Currently, only `YAML` or `JSON` format are supported. + +The manifest file contains the following properties: + +- **`name`** + + (Required) Defines a short, computer-readable name of the component. This component name is used as directory name after it is installed. The allowed characters in the name are alphabets, numbers, hyphen (`-`) and underscore (`_`). For example, `explorer-jes` is a valid extension name. + +- **`id`** + + (Optional) Defines a long, computer-readable identifier of the component. If the component is hosted as one of the projects in [Open Mainframe Project](https://www.openmainframeproject.org/), the identifier also matches the component path in the Zowe Artifactory. For example, `org.zowe.explorer-jes` is a valid identifier. You can locate the component's official releases by looking into the `libs-release-local/org/zowe/explorer-jes/` directory in the [Zowe Artifactory](https://zowe.jfrog.io/ui/repos/tree/General/libs-release-local%2Forg%2Fzowe%2Fexplorer-jes). + +- **`version`**: + + (Optional but recommended) This is the current version of the component without the prefix of `v`. For example, `2.0.0` is a valid `version` value. + +- **`title`** + + (Optional) Defines a short human-readable name for this component. This value will also be used as the default title for API Catalog tile, or App Framework plug-in title. For example, `JES Explorer` is a valid `title` for the `explorer-jes` component. + +- **`description`** + + (Optional) Defines a long human-readable description of this component. There is no restriction on what you can put in the field. + +- **`license`** + + (Optional but recommended) Defines the license code of the component. For example, Zowe core components have `EPL-2.0` value in this field. + +- **`schemas`** + + (Required) Defines the location of json schema files that are compatible with certain portions of Zowe as denoted by each child property. + + * **`configs`** + + (Required) Defines the location of the json schema file which extends the Zowe Component base schema. + +- **`build`** + + (Optional but strongly recommended) Defines the build information of the current package, including git commit hash, and so on. When Zowe core components define manifest file, these fields are left as template variables. The template will be updated when a publishable package is created. It supports the following subfields: + + * **`branch`** + + It indicates which branch this package is built from. + + * **`number`** + + You may create multiple packages in the same branch. This is the sequential number of the current package. + + * **`commitHash`** + + This is the commit hash of the package that can be used to match the exact source code in the repository. Zowe core components usually use `git rev-parse --verify HEAD` to retrieve the commit hash. + + * **`timestamp`** + + This is the UNIX timestamp when the package is created. + +- **`commands`** + + This defines actions that should be taken when the component is installed, configured, started, or tested. You must issue this command with one or more subfields as listed below. For example, `commands.install`. All subfields are optional and usually should point to a USS command or script. + + * **`install`** + + This defines extra steps when installing this component. It will be automatically executed if you install your component with the `zwe components install` server command. + + * **`validate`** + + This defines extra validations that the component requires other than global validations. It is for runtime purpose, and will be automatically executed each time Zowe is started. + + * **`configure`** + + This defines extra configuration steps before starting the component. It is for runtime purpose, and will be automatically executed each time Zowe is started. + + * **`start`** + + This tells the Zowe launch script how to start the component. It is for runtime purpose, and will be automatically executed each time Zowe is started. + +- **`apimlServices`** + + This section defines how the component will be registered to the API Mediation Layer Discovery Service. All subfields are optional. + + * **`dynamic`** + + Array of objects. This information will tell Zowe and users what services you will register under the Discovery service. + + - **`serviceId`** + + This defines the service ID registered to the Discovery service. + + * **`static`** + + Array of objects. When the component is statically registered under the Discovery service, this tells Zowe where to find these static definitions. This information is for the Zowe runtime. When Zowe is starting, the launch script will check this field and put the parse static definition file into the directory defined as `ZWE_STATIC_DEFINITIONS_DIR` in the Zowe instance. + + - **`file`** + + Defines the path to the static definition file. This file is supposed to be a template. + + * **`basePackage`** + + Defines the base package name of the extension. It is used to notify the extended service of the location for component scan. + +- **`appfwPlugins`** + + Array of objects. This section defines how the component will be registered to the App Framework plug-in. All subfields are optional. + + * **`path`** + + This points to the directory where App Framework `pluginDefinition.json` file is located. When Zowe is starting, the launch script will check this field and register the plug-in to Zowe App Framework Server. + +- **`gatewaySharedLibs`**: Array of objects. This section defines the API ML extension(s) attributes which will get installed and used by API ML. + + * **`path`** + + This points to the directory where the JAR files are housed for an extension and later on copied into the API ML extensions workspace directory. If there is more than 1 extension to a single manifest (say for a product family of multiple extensions), then multiple path variables can be contained within the manifest denoted by individual folders, for example `path/to/yourextension1/`. + Alternatively, `path` can be the JAR file path rather than a directory path. + +- **`zisPlugins`** + + List of ZIS plugin objects. This section defines the ZIS plugin(s) attributes necessary for ZIS plugin installation and automation. + + * **`id`** + + This is the unique plugin ID of the ZIS plugin. + + * **`path`** + + This points to the directory where the load modules are housed for a plugin, for example `zisServer`. If there is more than 1 plugin to a single manifest (say for a product family of multiple plugins), then multiple path variables can be contained within the manifest denoted by individual folders, for example `yourplugin1/zisServer`. The parameters for the Zowe parmlib are assumed to be in `/samplib`. The names of the plugin executables are assumed to be in `/loadlib`. + + For example, + + ```yaml + zisPlugins: + - + id: yourplugin1 + path: yourplugin-1/zisServer + - + id: yourplugin2 + path: yourplugin2/zisServer + ``` + +- **`configs`** + + Component can define it's own configuration in this section in desired hierarchy. This is the brief guidance for component user to learn what are the configurations and what are the default values. Any configurations defined here can be placed into `zowe.yaml` `components.` section for customization. + + For example, if the component has this defined in component manifest, + + ```yaml + name: myextension + configs: + port: 4567 + another: + config: value + ``` + + You can choose to put those configurations into `components.myextension` or `haInstance..components.myextension` of `zowe.yaml` like this: + + ```yaml + zowe: + extensionDirectory: /path/to/all/extensions + components: + myextension: + enabled: true + port: 14567 + another: + config: my-value + haInstances: + lpar1: + lpar2: + components: + myextension: + enabled: true + port: 24567 + another: + config: my-value2 + ``` + + Component can use auto-generate environment variables in lifecycle scripts to learn how the component is configured for current HA instance. In the preceding use case, + + * For HA instance `lpar1`, `ZWE_configs_port` value is `14567`, `ZWE_configs_another_config` value is `my-value`, which are default values. + * For HA instance `lpar2`, `ZWE_configs_port` value is `24567`, `ZWE_configs_another_config` value is `my-value2`. + + From another component, you can find `myextension` configurations like this, + + * For HA instance `lpar1`, `ZWE_components_myextension_port` value is `14567`, `ZWE_components_myextension_another_config` value is `my-value`, which are default values. + * For HA instance `lpar2`, `ZWE_components_myextension_port` value is `24567`, `ZWE_components_myextension_another_config` value is `my-value2`. + +- **`dependencies`**: (Optional) This section defines the component's dependencies. + * **`zos`**: Array of objects. This subfield defines components or services from z/OS. + - **`apiml`**: true or false. Indicates whether the dependency is registered/searchable with the Discovery service + - **`version`**: This defines the version range of the dependency. Acceptable formats: `version`, `>version`, `>=version`, ` [command](command-article)** + +Interact with z/OS command related services, including z/OSMF Console services, etc. + +## Usage + +`zos command issue console [commandString] --console-name | --cn --system-name | --sn ` + +## Action + +- [`issue`](./issue/issue-article) + +## Positional Arguments + +- [zos command issue console](./issue/zos-command-issue-console#positional-arguments) + + - `commandString` + +## Options + +- [zos command issue console](./issue/zos-command-issue-console#options) + + | Full name | Alias| Type | + | :---- | :---- | :---- | + | --console-name |--cn| string | + | --system-name |--sn|string | + +## Examples + +``` +@bot zos command issue console “d a,l” +``` +- Issue a simple command. + +``` +@bot zos command issue console "d a,l" --console-name test +``` +- Issue a z/OS console command with a console name. diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/command/issue/issue-article.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/command/issue/issue-article.md new file mode 100644 index 0000000000..f1d7e1376d --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/command/issue/issue-article.md @@ -0,0 +1,13 @@ +# `zos command issue` + +**[zos](../../zos-article) > [command](../command-article)** + +Issue z/OS commands. + +## Usage + +`zos command issue console [commandString] --console-name | --cn --system-name | --sn ` + +## Object + +- [console](zos-command-issue-console) \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/command/issue/zos-command-issue-console.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/command/issue/zos-command-issue-console.md new file mode 100644 index 0000000000..d9bb47da46 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/command/issue/zos-command-issue-console.md @@ -0,0 +1,35 @@ +# zos command issue console + +**[zos](../../zos-article) > [command](../command-article) > [issue](./issue-article) > [console](zos-command-issue-console)** + +Issue a z/OS console command and print the response. In general, when issuing a z/OS console command, z/OS applications route responses to the originating console. Zowe Chat attempts to get the solicited messages immediately after the command is issued. If there is no message available within a certain time interval, approximately 3 seconds if your system workload is not high, Zowe Chat returns null. Usually it means that there is no command response. However, it is possible that the command response arrives after 3 seconds. In this case, you can click the command response URL in the response to retrieve the command response. + +## Usage + +`zos command issue console [commandString] --console-name | --cn --system-name | --sn ` + +## Positional Arguments + +- `commandString` + + - The z/OS console command to issue. + +## Options + +- `--console-name` *(null|string)* + - The name of the z/OS extended MCS console to direct the command. The name must be between 2 and 8 characters long and cannot start with a digit. Characters are alphanumeric and can also include symbols like #, $, and @. + +- `--system-name` *(null|string)* + - Specify the z/OS system name in the current SYSPLEX (where your target z/OSMF resides) to route the z/OS console command. Default is the local system. + +## Examples + +``` +@bot zos command issue console “d a,l” +``` +- Issue a simple command. + +``` +@bot zos command issue console "d a,l" --console-name test +``` +- Issue a z/OS console command with a console name. diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/dataset/dataset-article.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/dataset/dataset-article.md new file mode 100644 index 0000000000..cd85c1ff25 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/dataset/dataset-article.md @@ -0,0 +1,66 @@ +# zos dataset + +**[zos](.././zos-article) > [dataset](dataset-article)** + +Manages z/OS data sets. + +## Usage + +```zos dataset list status [datasetName*] --dsname-level | --dl --volume-serial | --vs --start | -s --limit ``` + +```zos dataset list member [datasetMemberName*] --dataset-name | --dn --limit ``` + +## Action + +- [`list`](./list/list-article) + +## Positional Arguments + +- [zos dataset list status](./list/zos-dataset-list-status#positional-arguments) + + - `datasetName*` + +- [zos dataset list member](./list/zos-dataset-list-member#positional-arguments) + + - `datasetMemberName*` + +## Options + +- [zos dataset list status](./list/zos-dataset-list-status#options) + + | Full name | Alias | Type | + | :---- | :---- | :---- | + | --dsname-level | --dl | string | + | --volume-serial| --vs | string | + | --start | -s | string | + | --limit | | number | + +- [zos dataset list member](./list/zos-dataset-list-member#options) + + | Full name | Alias | Type | + | :---- | :---- | :---- | + | --dataset-name | --dn | string | + | --limit | | number | + +## Examples + +``` +@bot zos dataset --dl user.asm +``` +``` +@bot zos dataset list --dl user.asm +``` +``` +@bot zos dataset list status --dl user.asm +``` +- Show the data set "user.asm". + +``` +@bot zos dataset list status user.* +``` +- Show all data sets of the user "user". + +``` +@bot dataset list member --dn user.asm +``` +- Show members of the data set "user.asm". diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/dataset/list/list-article.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/dataset/list/list-article.md new file mode 100644 index 0000000000..ec475a4b41 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/dataset/list/list-article.md @@ -0,0 +1,17 @@ +# `zos dataset list` + +**[zos](../../zos-article) > [dataset](../dataset-article) > [list](list-article)** + +Show status of data sets. + +## Usage + +- ```zos dataset list status [datasetName*] --dsname-level | --dl --volume-serial | --vs --start | -s --limit ``` + +- ```zos dataset list member [datasetMemberName*] --dataset-name | --dn --limit ``` + +## Object + +- [status](zos-dataset-list-status) + +- [member](zos-dataset-list-member) \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/dataset/list/zos-dataset-list-member.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/dataset/list/zos-dataset-list-member.md new file mode 100644 index 0000000000..f57a6ed4ec --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/dataset/list/zos-dataset-list-member.md @@ -0,0 +1,35 @@ +# `zos dataset list member` + +**[zos](../../zos-article) > [dataset](../dataset-article) > [list](./list-article) > [member](zos-dataset-list-member)** + +Show all members of a partitioned data set. + +## Usage + +```zos dataset list member [datasetMemberName*] --dataset-name | --dn --limit ``` + +## Positional Arguments + +- `datasetMemberName*` + + - Specify the member name to narrow down the results. Wildcard character is supported, please refer to the z/OSMF Dataset REST endpoint documentation. + +## Options + +- `--dataset-name` *(string)* + - Specify the name of the data set of which you want to list the members. Wildcard character is supported, please refer to the z/OSMF Dataset REST endpoint documentation. + +- `--limit` *(number)* + - Specify the number of the data set members to display. + +## Examples + +``` +@bot zos dataset list member +``` +- List all data set members with default settings. The command returns data set members owned by your HLQ name. + +``` +@bot dataset list member --dn user.asm +``` +- Show members of the data set "user.asm". \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/dataset/list/zos-dataset-list-status.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/dataset/list/zos-dataset-list-status.md new file mode 100644 index 0000000000..991d64927b --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/dataset/list/zos-dataset-list-status.md @@ -0,0 +1,47 @@ +# zos dataset list status + +**[zos](../../zos-article) > [dataset](../dataset-article) > [list](list-article) > [status](zos-dataset-list-status)** + +Show status or details of data sets. + +## Usage + +`zos dataset list status [datasetName*] --dsname-level | --dl --volume-serial | --vs --start | -s --limit ` + +## Positional Arguments + +- `datasetName*` + + - Specify the data set name to narrow down the results. Wildcard is supported, please refer to the z/OSMF Dataset REST endpoint documentation + +## Options + +- `--dsname-level` *(string)* + - Specify the name or pattern of the data set. Wildcard is supported, please refer to the z/OSMF Dataset REST endpoint documentation. + +- `--volume-serial` *(string)* + - Specify the volume serial (VOLSER) where the data set resides. + +- `--start` *(string)* + - Specify the first data set name to return. + +- `--limit` *(number)* + - Specify the number of the data sets to display. + +## Examples + +``` +@bot zos dataset --dl user.asm +``` +``` +@bot zos dataset list --dl user.asm +``` +``` +@bot zos dataset list status --dl user.asm +``` +- Show the data set "user.asm". + +``` +@bot zos dataset list status user.* +``` +- Show all data sets of the user "user". \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/file/file-article.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/file/file-article.md new file mode 100644 index 0000000000..649ca142b4 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/file/file-article.md @@ -0,0 +1,73 @@ +# `zos file` + +**[zos](.././zos-article) > [file](file-article)** + +Manage USS files in a z/OS system. + +## Usage + +```zos file list status [fileName*] --path | -p --limit ``` + +```zos file list mounts [fileSystemName*] --mount-point | --mp --limit ``` + +## Action + +- [`list`](./list/list-article) + +## Positional Argument + +- [zos file list status](./list/zos-file-list-status#positional-arguments) + + - `fileName*` + +- [zos file list mounts](./list/zos-file-list-mounts#positional-arguments) + + - `fileSystemName*` +## Option + +- [zos file list status](./list/zos-file-list-status#options) + + | Full name | Alias | Type | + | :---- | :---- | :---- | + | --path | -p | string | + | --limit | | number | + +- [zos file list mounts](./list/zos-file-list-mounts#options) + + | Full name | Alias | Type | + | :---- | :---- | :---- | + | --mount-point | --mp | string | + | --limit | | number | + +## Examples + +``` +@bot zos file -p '/u/user' +``` +``` +@bot zos file list -p '/u/user' +``` +``` +@bot zos file list status -p '/u/user' +``` +- Show the files and directories in path '/u/user'. + +``` +@bot zos file list status clean* -p '/u/user' +``` +- Show the files and directories whose names start with clean in path '/u/user'. + +``` +@bot zos file list mounts +``` +- Show all mounted filesystems. + +``` +@bot zos file list mounts --mp '/a/ibmuser' +``` +- Show filesystems which are mounted to a specific path. + +``` +@bot zos file list mounts sac* +``` +- Show mounted filesystems with name starting with 'sac'. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/file/list/list-article.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/file/list/list-article.md new file mode 100644 index 0000000000..392e8be052 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/file/list/list-article.md @@ -0,0 +1,15 @@ +# zos file list + +**[zos](../../zos-article) > [file](../file-article) > [list](list-article)** + +## Usage + +`zos file list status [fileName*] --path | -p --limit ` + +```zos file list mounts [fileSystemName*] --mount-point | --mp --limit ``` + +## Objects + +- [status](zos-file-list-status) + +- [mounts](zos-file-list-mounts) \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/file/list/zos-file-list-mounts.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/file/list/zos-file-list-mounts.md new file mode 100644 index 0000000000..72a2a97069 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/file/list/zos-file-list-mounts.md @@ -0,0 +1,40 @@ +# zos file list mounts + +**[zos](../../zos-article) > [file](../file-article) > [list](./list-article) > [mounts](zos-file-list-mounts)** + +Show status or details of mounted z/OS file systems. + +## Usage + +`zos file list mounts [fileSystemName*] --mount-point | --mp --limit ` + +## Positional Arguments + +- `fileSystemName*` + + - Specify the file system name to narrow down the results. Wildcard character * and ? is supported. + +## Options + +- `--mount-point` *(string)* + - Specify the path that the file system is mounted. + +- `--limit` *(number)* + - Specify the number of the file systems to display. + +## Examples + +``` +@bot zos file list mounts +``` +- Show all mounted filesystems. + +``` +@bot zos file list mounts --mp '/a/ibmuser' +``` +- Show filesystems which are mounted to a specific path. + +``` +@bot zos file list mounts sac* +``` +- Show mounted filesystems with name starting with 'sac'. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/file/list/zos-file-list-status.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/file/list/zos-file-list-status.md new file mode 100644 index 0000000000..37fc719bc8 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/file/list/zos-file-list-status.md @@ -0,0 +1,41 @@ +# zos file list status + +**[zos](../../zos-article) > [file](../file-article) > [list](./list-article) > [status](zos-file-list-status)** + +Show status or details of USS files. + +## Usage + +`zos file list status [fileName*] --path | -p --limit ` + +## Positional Arguments + +- `fileName*` + + - Specify the file name to narrow down the results. Wildcard character * and ? is supported. + +## Options + +- `--path` *(string)* + - Specify the directory that contains the files and directories to be listed. + +- `--limit` *(number)* + - Specify the number of the files to display. + +## Examples + +``` +@bot zos file -p '/u/user' +``` +``` +@bot zos file list -p '/u/user' +``` +``` +@bot zos file list status -p '/u/user' +``` +- Show the files and directories in path '/u/user'. + +``` +@bot zos file list status clean* -p '/u/user' +``` +- Show the files and directories whose names start with clean in path '/u/user'. diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/help/help-article.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/help/help-article.md new file mode 100644 index 0000000000..a5aceec174 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/help/help-article.md @@ -0,0 +1,39 @@ +# `zos help` + +**[zos](.././zos-article) > [help](help-article)** + +Show help information of commands. + +## Usage + +`zos help` + +`zos help list command [resourceName]` + +## Action + +- [`list`](./list/list-article) + +## Positional Arguments + +- [zos help list command](./list/zos-help-list-command#positional-arguments) + + - `fileName` + +## Examples + +``` +@bot zos help +``` +``` +@bot zos help list +``` +``` +@bot zos help list command +``` +- All three commands can list all supported Zowe Chat commands. + +``` +@bot zos help list command job +``` +- Show usage and examples of job commands. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/help/list/list-article.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/help/list/list-article.md new file mode 100644 index 0000000000..c7b7ca80af --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/help/list/list-article.md @@ -0,0 +1,13 @@ +# zos help list + +**[zos](../../zos-article) > [help](../help-article) > [list](list-article)** + +List help information of the command. + +## Usage + +`zos help list command [resourceName]` + +## Object + +- [`command`](zos-help-list-command) diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/help/list/zos-help-list-command.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/help/list/zos-help-list-command.md new file mode 100644 index 0000000000..6dfd5aa7de --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/help/list/zos-help-list-command.md @@ -0,0 +1,33 @@ +# zos help list command + +**[zos](../../zos-article) > [help](../help-article) > [list](./list-article) > [command](zos-help-list-command)** + +List help information of the command. + +## Usage + +`zos help list command [resourceName]` + +## Positional Arguments + +- `fileName` + + - Specify the command resource to narrow down the results. + +## Examples + +``` +@bot zos help +``` +``` +@bot zos help list +``` +``` +@bot zos help list command +``` +- All three commands can list all supported Zowe Chat commands. + +``` +@bot zos help list command job +``` +- Show usage and examples of job commands. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/job/job-article.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/job/job-article.md new file mode 100644 index 0000000000..29b8f71e43 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/job/job-article.md @@ -0,0 +1,57 @@ +# zos job + +**[zos](../zos-article) > [job](job-article)** + +Manage z/OS jobs. + +## Usage + +`zos job list status [jobID] --owner | -o --prefix | -p --limit ` + +## Action + +- [`list`](./list/list-article) + +## Positional Arguments + +- [zos job list status](./list/zos-job-list-status#positional-arguments) + + - `jobID` + +## Options + +- [zos job list status](./list/zos-job-list-status#options) + + | Full name | Alias | Type | + | :---- | :---- | :---- | + | --owner | -o | string | + | --prefix | -p | string | + | --limit | | number | + +## Examples +``` +@bot zos job +``` +``` +@bot zos job list +``` +``` +@bot zos job list status +``` + +- All three commands can list all jobs with default settings. The command returns jobs owned by your user ID with any job name. + +``` +@bot zos job -o zow* -p myjo* +``` +``` +@bot zos job list status -o zow* -p myjo* +``` + +- Both the two commands can list all jobs owned by the users who have IDs starting with 'zow' and job names starting with 'myjo'. + +``` +@bot zos job list status TSU15026 +``` + + - Show the job with job ID "TSU15026". diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/job/list/list-article.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/job/list/list-article.md new file mode 100644 index 0000000000..19482bca42 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/job/list/list-article.md @@ -0,0 +1,13 @@ +# `zos job list` + +**[zos](../../zos-article) > [job](../job-article) > [list](list-article)** + +List job status. + +## Usage + +```zos job list status [jobID] --owner | -o --prefix | -p --limit ``` + +## Object + +- [status](zos-job-list-status) diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/job/list/zos-job-list-status.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/job/list/zos-job-list-status.md new file mode 100644 index 0000000000..c273041268 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/job/list/zos-job-list-status.md @@ -0,0 +1,52 @@ +# zos job list status + +**[zos](../../zos-article) > [job](../job-article) > [list](./list-article) > [status](zos-job-list-status)** + +Show status or detail of jobs. + +## Usage + +```zos job list status [jobID] --owner | -o --prefix | -p --limit ``` + +## Positional Arguments + +- `jobID` + + - Specify the job ID to narrow down the results. + +## Options + +- `owner | o` *(string)* + - Specify the owner of the jobs you want to list. The owner is the individual/user who submitted the job OR the user ID assigned to the job. The command does not prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs REST endpoint documentation, which is usually in the form "USER*" + +- `prefix | p` *(string)* + - Specify the job name prefix of the jobs you want to list. The command does not prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs REST endpoint documentation, which is usually in the form "JOB*". + +- `--limit` *(number)* + - Specify the number of the jobs to display. + +## Examples + +``` +@bot zos job +``` +``` +@bot zos job list +``` +``` +@bot zos job list status +``` +- All three commands can list all jobs with default settings. The command returns jobs owned by your user ID with any job name. + +``` +@bot zos job -o zow* -p myjo* +``` +``` +@bot zos job list status -o zow* -p myjo* +``` +- Both the two commands can list all jobs owned by the users who have IDs starting with 'zow' and job names starting with 'myjo'. + +``` +@bot zos job list status TSU15026 +``` +- Show the job with job ID "TSU15026". \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/zos-article.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/zos-article.md new file mode 100644 index 0000000000..1f86fb9a91 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/zos-article.md @@ -0,0 +1,15 @@ +# zos commands + +Manages z/OS resources including jobs, data sets, USS files, and mounted filesystems. + +## Resources + +- [job](./job/job-article) - Manage z/OS jobs + +- [dataset](./dataset/dataset-article) - Manage z/OS data sets + +- [file](./file/file-article) - Manage z/OS USS files + +- [command](./command/command-article) - Perform z/OS console commands + +- [help](./help/help-article) - Request help for z/OS commands diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/zowe-chat-command-reference.md b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/zowe-chat-command-reference.md new file mode 100644 index 0000000000..53b602a78c --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-chat-command-reference/zos/zowe-chat-command-reference.md @@ -0,0 +1,9 @@ +# Zowe Chat command reference overview + +Welcome to Zowe Chat! + +Zowe Chat currently supports users to perform interactions with Zowe Chat bot. + +Check out the commands that Zowe Chat supports. + +- [z/OS commands](zos-article) diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-cli-command-reference.md b/versioned_docs/version-v2.15.x/appendix/zowe-cli-command-reference.md new file mode 100644 index 0000000000..3d4a1c136e --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-cli-command-reference.md @@ -0,0 +1,10 @@ +# Zowe CLI command reference guide + +View detailed documentation on commands, actions, and options in Zowe CLI. You can read an interactive online version, download a PDF document, or download a ZIP file containing the HTML for the online version. + +Currently, this reference documentation only contains the web help for +the Zowe CLI core component and CLI plug-ins maintained by Zowe. As third-party plug-ins are approved under the Zowe V2 LTS Conformance Program and contribute their web help to Zowe, we will update the documentation accordingly. To view the web help for V1 conformant plug-ins, click the version drop-menu on the top right corner of this page and click the link to any previous v1.xx.x version of this page. + +- Browse online +- Download CLI reference in PDF format +- Download CLI reference in ZIP format diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-glossary.md b/versioned_docs/version-v2.15.x/appendix/zowe-glossary.md new file mode 100644 index 0000000000..942dfbacf4 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-glossary.md @@ -0,0 +1,371 @@ +# Glossary of Zowe terminology + +This glossary is part of a growing list of terms and concepts used in the Zowe ecosystem of projects. + +This reference includes both technical as well as organizational terms that are specific to Zowe, the award-winning open source initiative part of the Linux Foundation's Open Mainframe Project (OMP). + +Not finding something you are looking for? Send a message to the Zowe Docs squad in the [#zowe-doc](https://openmainframeproject.slack.com/archives/CC961JYMQ) Slack channel to discuss updating this glossary. + +:::note +Security is central to a wide range of functionalities in Zowe. As such, a separate glossary of Zowe Security terminology is available in the _Overview_ section under _Zowe security_. For more information, see the [**Glossary of Zowe Security teminology**](./zowe-security-glossary). + +For an overview of security in Zowe, see [the Zowe Security policy](https://www.zowe.org/security) on zowe.org. +::: + +## Core Zowe Projects + +### Zowe API Mediation Layer (API ML) + +Provides a reverse proxy and enables REST APIs by providing a single point of access for mainframe service REST APIs like MVS Data Sets, JES, as well as working with z/OSMF. API ML has dynamic discovery capability for these services and Gateway is also responsible for generating the authentication token used to provide single sign-on (SSO) functionality. + +
    + +Click here for descriptions of the various components that form the API Mediation Layer. + + +#### API Catalog +Displays API services that have been discovered by the [API Mediation Layer](#api-mediation-layer-api-ml). + +#### API Discovery Service +As the central repository of active services in the [API Mediation Layer](#api-mediation-layer-api-ml) ecosystem, the API Discovery Service continuously collects and aggregates service information to provide status updates. This enables the discoverability of services. + +#### API Gateway   +A proxy server that routes requests from clients on its northbound edge (such as web browsers or [Zowe CLI](#zowe-cli)) to servers on its southbound edge that are able to provide data to serve the request. + +Also responsible for generating the authentication token used to provide single sign-on (SSO) functionality. + +#### Caching Service +Designed for Zowe components in a high availability (HA) configuration. The caching service supports the HA of all components within Zowe, allowing components to be stateless by providing a mechanism to offload their state to a location accessible by all instances of the service, including those which just started. + +
    + +### Zowe Application Framework + +Modernizes and simplifies working on the mainframe via a web visual interface. Functionality is provided through apps and a desktop user experience called the [Zowe Desktop](#zowe-desktop). Base functionality includes apps to work with JES, MVS Data Sets, Unix System Services, as well as a [3270 Terminal](#3270-terminal), [Virtual Terminal](#virtual-vt-terminal), and an [Editor](#zowe-editor). + +### Zowe CLI + +Provides a command-line interface that lets you interact with the mainframe remotely and use common tools such as Integrated Development Environments (IDEs), shell commands, bash scripts, and build tools for mainframe development. The core set of commands includes working with data sets, USS, JES, as well as issuing TSO and console commands. The Zowe CLI is incredibly popular in modern mainframe education. + +### Zowe client projects + +Includes all the Zowe projects that are installed on the user's PC. Also known as *Zowe client-side projects*. + +### Zowe Client SDKs + +Allow extenders to build applications on top of existing programmatic APIs such as z/OSMF. Currently supported client SDKs include Node.js (core), Kotlin/z/OSMF, Python, Swift, and Java. + +### Zowe Explorer + +A Visual Studio Code extension that modernizes the way developers and system administrators interact with z/OS mainframes. Zowe Explorer lets you interact with data sets, USS files, and jobs that are stored on z/OS. Zowe Explorer is incredibly popular in modern mainframe education. + +### Zowe server components + +Includes all the Zowe components that are installed on z/OS. Also known as *Zowe z/OS components* or *Zowe server-side components*. + +#### Zowe Systems Services Server (ZSS) + +Working closely with ZIS, ZSS serves as one of the primary, authenticated back-ends that communicates with z/OS and provides Zowe with a number of APIs: z/OS Unix files and data sets, control of the plug-ins and services lifecycle, security management, etc. The [Zowe Desktop](#zowe-desktop) especially delegates a number of its services to ZSS which it accesses through the default http port `7557`. + +ZSS is written in C and uses native calls to z/OS to provide its services. + +## Architecture and other components + +#### Configuration Manager + +Works closely with the [Zowe Launcher](#zowe-launcher) to manage the configuration of Zowe across its lifecycle. Interacted with primarily via `zwe` command + +#### Core component + +The definition of a core component is governed by the Technical Steering Committee (TSC), but typically, it is a packaged, foundational piece that is part of base Zowe. + +From the perspective of a conformant support provider, providing support for Zowe refers to providing support for each core component of Zowe (although a provider may place their own limitations on what they support). + +A core component is usually actively maintained by one or more squads. A component has a [component manifest file](https://docs.zowe.org/stable/appendix/server-component-manifest/) that helps identify it with the rest of Zowe. + +#### Explorer + +When used by itself, it often refers to the core Zowe component for Visual Studio Code,[ Zowe Explorer](#zowe-explorer). However, the term *Explorer* is a part of multiple titles across Zowe. + +#### Extension + +Generally used to describe additional, non-default Zowe plug-ins or components. See [plug-in](#plug-in) for additional context. + +#### Imperative CLI Framework + +Also known as Imperative, the code framework that is used to build plug-ins for [Zowe CLI](#zowe-cli). + +#### Plug-in + +A more general term used to describe a modular piece of some component. Depending on component or squad context, a plug-in is sometimes referred to as an *app*, *extension*, *plug-in*, etc. + +A component may have multiple plug-ins, sometimes working together to form a single purpose or user experience, but an individual plug-in belongs to a single component. See [extension](#extension) for additional context. + +#### Secure credential store + +Secret storage functionality embedded in core Zowe CLI and Zowe Explorer starting from Zowe V2. + +Securely stores configured private credentials in the secure vault available on your client operating system. Examples of such vaults include Windows Credential Manager on Microsoft Windows, and Passwords and Keys on Ubuntu Linux. + +A separate plug-in of the same name used in Zowe V1 CLI. + +#### Service + +A service provides one or more APIs, and is identified by a service ID. Note that sometimes the term *service name* can be used to mean *service ID*. + +The default service ID is provided by the service developer in the service configuration file. A system administrator can replace the service ID with a deployment environment specific name using additional configuration that is external to the service deployment unit. Most often, this is configured in a JAR or WAR file. + +Services are deployed using one or more service instances, which share the same service ID and implementation. + +#### Team configuration + +A method of storing and managing Zowe CLI and Zowe Explorer *team* and *user* profiles introduced in Zowe Version 2. + +This method saves team-specific profiles in the `zowe.config.json` configuration file and user-specific profiles in the `zowe.config.user.json` configuration file. The location of the configuration file determines whether its profiles are applied *globally* or *per project*. + +#### Web Explorers + +A suite of web apps on the [Zowe Desktop](#zowe-desktop) that are part of the [Zowe Application Framework](#zowe-application-framework) and the core Zowe server installation. They include the [JES](#jes-explorer), [MVS](#mvs-multiple-virtual-storage-explorer), [USS](#uss-explorer), and IP Explorers. Not related to [ Zowe Explorer](#zowe-explorer). + +#### ZIS (Zowe Interprocess Services) + +An APF-authorized server application that provides privileged services to Zowe in a secure manner. For security reasons, it is not an HTTP server. Instead, this server has a trust relationship with ZSS. + +Other Zowe components can work through ZSS in order to handle z/OS data that would otherwise be unavailable or insecure to access from higher-level languages and software. + +#### zLUX (V1 only)  + +This is an older, no-longer-used name for the [Zowe Application Framework](#zowe-application-framework). Note that unreasonable-to-change references still exist (such as GitHub repository names). Other synonyms/similar names include *MVD* (Mainframe Virtual Desktop) and *zlux*. + +#### Zowe App Server + +Refers to the Node.js-powered Application Server and is part of the [Zowe Application Framework](#zowe-application-framework) core project. It hosts the web content of the Application Framework, and provides the [Zowe Desktop](#zowe-desktop), which is accessible through a web browser. + +#### Zowe Chat + +An incubator focused on working with the mainframe from popular chat clients such as Mattermost®, Microsoft Teams®, and Slack®. + +#### Zowe Component + +Zowe is a collection of both *client* and *server* code. You can install only some of Zowe, or all of it, depending on your needs. Zowe splits the major sections of the code into *components*, with each serving an important purpose. + +Server components are packaged in a standardized way to include all services and plug-ins in one deliverable. Extensions to Zowe can also be delivered as third-party server components. For more information about how these extensions can use a manifest file, see [Zowe component manifest](https://docs.Zowe.org/stable/extend/packaging-zos-extensions/#zowe-component-manifest). + +#### Zowe Desktop + +Refers to the desktop UI that is part of the [Zowe Application Framework](#zowe-application-framework) core component. The Zowe Desktop includes a number of apps that run inside the App Framework, such as [JES](#jes-explorer), [MVS](#mvs-multiple-virtual-storage-explorer), and [USS](#uss-explorer) Explorers, as well as a [3270 Terminal](#3270-terminal), [Virtual Terminal](#virtual-vt-terminal), and an [Editor](#zowe-editor). + +#### Zowe Embedded Browser for RMF/SMF and APIs (ZEBRA) + +Provides re-usable and industry-compliant JSON-formatted RMF/SMF data records so that other ISV SW and users can exploit them using open-source SW for many ways. For more information, see the [ZEBRA documentation](https://github.com/zowe/zebra/tree/main/Documentation) or visit [Real ZEBRA Use Cases in Large Production Systems](https://openmainframeproject.org/blog/real-zebra-use-cases-in-large-production-systems-video/) in the Open Mainframe Project website. + +#### Zowe install packaging  + +The set of programs (for example, `zwe` command) and utilities (for example, JCL, scripts) which manage the Zowe server configuration and components. The infrastructure standardizes the packaging of components and controls how they are started, stopped, and how configuration is provided to them. + +#### Zowe IntelliJ Plug-in + +Uses the IntelliJ IDE to provide the ability to work with z/OS data sets and USS files, and to explore and manage JES jobs. + +#### Zowe Launcher + +A server-side program necessary for high availability/fault tolerance (HA/FT). It starts the Zowe server components and monitors their processes so that if a component fails to start or crashes, the launcher restarts it. The restarting of a component has limits to prevent loops in case of a component that has uncorrectable problems. + +## Community + +#### Open Mainframe Project (OMP) + +An organization which hosts and promotes development of open source software for the benefit of the IBM z mainframe community, including but not limited to z/OS. Zowe(.org) is one of several programs in this project. See the [Open Mainframe Project website](https://www.openmainframeproject.org/) for more information. + +#### Squad + +A group of people contributing and participating in the Zowe project. Such a group owns one or more projects. + +Every squad is required to have a representative on the [Technical Steering Committee](#technical-steering-committee-tsc) (TSC), and participate in relevant working groups. For more information about active Zowe squads, see [Current squads](https://github.com/Zowe/community/blob/master/Technical-Steering-Committee/squads.md#current-squads). + +#### Technical Steering Committee (TSC) + +The governing body that is responsible for the overall planning, development, and technical feedback assessment of Zowe. The TSC meets every Thursday to go over squad updates and discuss issues regarding the Zowe initiative. To get notified of upcoming meetings and agendas, join the [TSC Slack channel](https://openmainframeproject.slack.com/archives/C01H6CY0ZD1). + +#### Zowe Conformance Program + +The Zowe Support Provider Conformance Program gives vendors the ability to showcase their Zowe support competencies via well defined criteria. It is administered by the Linux Foundation and Open Mainframe Project. + +## Installation and configuration + +#### Base profile + +A type of team configuration profile that stores connection information for use with one or more services. Your service profiles can pull information from base profiles as needed, to specify a common username and password only once. + +The base profile can optionally store tokens to connect to Zowe API Mediation Layer, which improves security by enabling Multi-Factor Authentication (MFA) and Single Sign-on (SSO). + +#### Convenience build + + The Zowe installation file for Zowe z/OS components that is distributed as a PAX file in z/OS Unix and contains the runtimes and scripts to install and launch the z/OS runtime. It is the most common method to install Zowe. + +#### Extension directory + +The standard z/OS Unix directory where Zowe extensions, or additional components, plug-ins, etc., outside the default install are stored. It is specified in the Zowe configuration file via `zowe.extensionDirectory`. + +#### Instance.env (V1 only) + +The Zowe instance directory contains a `instance.env` file that stores the Zowe configuration data. The data is read each time Zowe is started. You can modify `instance.env` to configure the [Zowe runtime](#zowe-runtime). For more information about updating this configuration data, see [Updating the instance.env configuration file](https://docs.Zowe.org/V1.28.x/user-guide/configure-instance-directory#updating-the-instanceenv-configuration-file). + +#### Log directory + +The standard z/OS Unix directory where Zowe logs are stored. It is specified in the Zowe configuration file via `zowe.logDirectory`. + +#### OMVS + +Use of z/OS UNIX services requires a z/OS UNIX security context, referred to as an OMVS segment, for the user ID associated with any unit of work requesting these services. To learn more consult [IBM Documentation](https://www.ibm.com/docs/en/zos/2.5.0?topic=profiles-omvs-segment-in-user). + +#### Runtime directory + +The z/OS Unix directory for the [Zowe runtime](#zowe-runtime), specified in the Zowe configuration file via `zowe.runtimeDirectory`. Also the parent directory of the `zwe` command. + +#### Service profile + +A type of team configuration profile that stores connection information for a specific mainframe service, such as IBM z/OSMF. Plug-ins can introduce other service profile types, such as the CICS profile to connect to IBM CICS. + +#### SMP/E + +The Zowe installation for Zowe z/OS components that is distributed as an SMP/E package, identified by FMID, and contains the runtimes and the scripts to install and launch the z/OS runtime. The initial package is installed, and then a PTF is applied. It is the second most common method to install Zowe. + +#### SMP/E with z/OSMF workflow + +A similar process as [SMP/E](zowe-glossary.md#smp/e), except done through the z/OSMF web interface as a Zowe SMP/E workflow. It is the third most common way to install Zowe. + +#### Started task (STC) + +A type of runnable/running program on z/OS and is the primary way of running Zowe. For more information about when to use started tasks, see [Determining whether to use a started task](https://www.ibm.com/docs/en/zos/2.1.0?topic=tasks-determining-whether-use-started-task). + +Zowe V2 has two started tasks: +- ZWESLSTC: The primary Zowe STC. In Zowe V1, it was just the HA/FT primary STC. +- ZWESISTC: The STC for the Zowe cross memory server (referred to as ZIS, formally XMEM) +- ZWESVSTC (outdated): V1 only + +#### Workspace directory + +The standard z/OS Unix directory where Zowe server component and extension configuration is stored. In V1, this was located within the instance directory. In V2 it is specified in the Zowe configuration file via `zowe.workspaceDirectory`. + +#### Zowe configuration file + + The Zowe V2 replacement for `instance.env` in V1. The Zowe configuration file is a YAML file that is required to configure the [Zowe runtime](#zowe-runtime). It is used across every step in Zowe, from configuration to install to start. + + Sometimes referred to as the *Zowe.yaml file*. For more information on various attributes, see [Zowe YAML configuration file reference](https://docs.Zowe.org/stable/appendix/Zowe-yaml-configuration/). + +#### Zowe instance directory (V1 only) + +Also known as ``. Contains information that is specific to a launch of Zowe. It contains configuration settings that determine how an instance of the Zowe server is started, such as ports that are used or paths to dependent Java and Node.js runtimes. + +The instance directory also contains a log directory where different microservices write trace data for diagnosis, as well as a workspace and shell scripts to start and stop Zowe. + +#### Zowe runtime + +Refers to the full, unarchived set of binaries, executable files, scripts, and other elements that are run when Zowe is started. + + +#### Sample library + +The cross memory server runtime artifacts, the JCL for the started tasks, the parmlib, and members containing sample configuration commands are found in the SZWESAMP PDS sample library. For more information, see [PDS sample library and PDSE load library](https://docs.zowe.org/stable/user-guide/configure-xmem-server/#pds-sample-library-and-pdse-load-library). + +#### ZWEADMIN + +A user group on the system that [ZWESVUSR](#zwesiusr) and [ZWESIUSR](#zwesvusr) should belong to. It must have a valid [OMVS](#omvs) segment. + +#### ZWESIUSR + +A started task ID used to run the PROCLIB ZWESISTC that launches the cross memory server (also known as ZIS). It must have a valid [OMVS](#omvs) segment. For more information, see [ZWESIUSR requirements](../user-guide/systemrequirements-zos.md/#zwesiusr). + +#### ZWESVUSR + +A started task ID used to run the PROCLIB ZWESLSTC. The task starts a USS environment using BPXBATSL that executes server components such as the Application Framework, the API ML, and ZSS. To work with USS, the user ID ZWESVUSR must have a valid OMVS segment. For more information, see [ZWESVUSR requirements](../user-guide/systemrequirements-zos.md#zwesvusr). + +## Plug-ins and extensions + +### API Mediation Layer + +#### API Catalog + +Displays API services that have been discovered by the [API Mediation Layer](#api-mediation-layer-api-ml). + +### Zowe Application Framework + +#### 3270 Terminal + +An applicationin the [Zowe Desktop](#zowe-desktop) that provides a user interface that emulates the basic functions of IBM 3270 family terminals. + +#### File Tree + +Formally known as the *File Explorer*, the FT refers to a re-usable widget existing in multiple apps across the [Zowe Desktop](#zowe-desktop) to display z/OS Unix files and data sets. + +#### IP Explorer + +An application in the [Zowe Desktop](#zowe-desktop) you can use to monitor the TCP/IP stacks, and view active connections and reserved ports. + +#### JES Explorer + +An application in the [Zowe Desktop](#zowe-desktop) to interact with z/OS UNIX files. + +#### MVS (Multiple Virtual Storage) Explorer + +An application in the [Zowe Desktop](#zowe-desktop) to interact with z/OS data sets. Though still supported, active development has been moved to the [Zowe Editor](#zowe-editor). + +#### USS Explorer + +An application in the [Zowe Desktop](#zowe-desktop) to interact with z/OS UNIX files. Though still supported, active development has been moved to the [Zowe Editor](#zowe-editor). + +#### Virtual (VT) Terminal + +An application in the [Zowe Desktop](#zowe-desktop) that provides a user interface that emulates the basic functions of DEC VT family terminals. + +#### Zowe Editor + +An application in the [Zowe Desktop](#zowe-desktop) to interact with z/OS data sets and Unix files. It uses the [File Tree](#file-tree). + +### Zowe CLI Extensions + +#### IBM® CICS® Plug-in for Zowe CLI + +Extends the Zowe CLI to interact with CICS programs and transactions. + +#### IBM® Db2® Plug-in for Zowe CLI + +Enables interaction with Db2 for z/OS to perform tasks through Zowe CLI and integrate with modern development tools. +     +## Use and development + +### API Mediation Layer + +#### Micronaut Enabler + +A guide which helps to simplify the process of onboarding a REST service with the API ML, using [Micronaut](https://micronaut.io/) and [Gradle](https://gradle.org/). + +#### Node.js Enabler + +An NPM package which helps to simplify the process of onboarding a REST service written in Node.js with the API ML. + +#### Plain Java Enabler (PJE) + +A library which helps to simplify the process of onboarding a REST service with the API ML, serving the needs of Java developers who are not using either Spring Boot, Spring Framework, or Spring Cloud Netflix. + +#### Sprint Boot Enablers + +A collection of enablers which help to simplify the process of onboarding a REST service with the API ML using various versions of Spring framework. + +### Zowe Application Framework + +#### Accessing the Desktop + +The [Zowe Desktop](#zowe-desktop) is accessed through the [API ML](#api-mediation-layer-api-ml). The Desktop URL uses the following format: +``` +https://${zowe.externalDomains[0]}:{zowe.externalPort}/zlux/ui/v1 +``` + +#### App2App + +A feature of the Zowe environment where one application plug-in can communicate with another. The [Zowe Application Framework](#zowe-application-framework) provides constructs that facilitate this ability. For more information, see [Application-to-application communication](../extend/extend-desktop/mvd-apptoappcommunication). + +#### Config Service + +A part of the Application Framework which allows plug-ins and the framework itself to store user configuration as JSON or binary formats. The configuration is stored in a hierarchy in which company-wide and system-wide defaults can exist for all users, and users may override the defaults if policy allows it. What can be stored and what can be overridden depends on plug-in definition and administrative configuration. diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-security-glossary.md b/versioned_docs/version-v2.15.x/appendix/zowe-security-glossary.md new file mode 100644 index 0000000000..d7335d8ce3 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-security-glossary.md @@ -0,0 +1,116 @@ +# Glossary of Zowe Security terminology + +Zowe implements a number of modern cyber-security concepts. Before getting started with configuring certificates, it is useful to familiarize yourself with the basic terminology. +Read the following definitions for explanation of the security terms related to the core security technologies applied by Zowe: + +- [Certificate concepts](#certificate-concepts) +- [Certificate verification](#certificate-verification) +- [Zowe certificate requirements](#zowe-certificate-requirements) +- [Certificate setup types](#certificate-setup-types) + +## Certificate concepts + +* [Keystore](#keystore) +* [Truststore](#truststore) +* [PKCS12](#pkcs12) +* [z/OS Key Ring](#zos-key-ring) +* [Server certificate](#server-certificate) +* [Client certificate](#client-certificate) +* [Self-signed certificates](#self-signed-certificates) + +### Keystore +The keystore is the location where Zowe stores certificates that Zowe servers present to clients and other servers. In the simplest case, the keystore contains one private key and a certificate pair, which can then be used by each Zowe server. + +When using a key ring, a single key ring can serve both as a keystore and as a truststore if desired. + +### Truststore +The truststore is used by Zowe to verify the authenticity of the certificates it encounters, whether communicating with another server, with one of Zowe own servers, or with a client that presents a certificate. A truststore is composed of Certificate Authority (CA) certificates which are compared against the CAs that an incoming certificate claims to be signed by. To ensure a certificate is authentic, Zowe must verify that the certificate's claims are correct. Certificate claims include that the certificate was sent by the host that the certificate was issued to, and that the cryptographic signature of the authorities the certificate claims to have been signed by match those signatures found within the truststore. This process helps to ensure that Zowe only communicates with hosts that are trusted and have been verified as authentic. + +When using a key ring, a single key ring can be both a keystore and a truststore if desired. + +### PKCS12 +PKCS12 is a file format that allows a Zowe user to hold many cryptographic objects in one encrypted, password-protected file. This file format is well-supported across platforms but because it is just a file, you may prefer to use z/OS key rings instead of PKCS12 certificates for ease of administration and maintenance. + +### z/OS Key Ring +z/OS provides an interface to manage cryptographic objects in "key rings". As opposed to PKCS12 files, using z/OS key rings allows the crypto objects of many different products to be managed in a uniform manner. z/OS key rings are still encrypted, but do not use passwords for access. Instead, SAF privileges are used to manage access. Java's key ring API requires that the password field for key ring access be set to "password", so despite not needing a password, you may see this keyword. + +Use of a z/OS keystore is the recommended option for storing certificates if system programmers are already familiar with the certificate operation and usage. +Creating a key ring and connecting the certificate key pair requires elevated permissions. When the TSO user ID does not have the authority to manipulate key rings and users want to create a Zowe sandbox environment or for testing purposes, the USS keystore is a good alternative. + +### Server certificate +Servers need a certificate to identify themselves to clients. Every time you go to an HTTPS website for example, your browser checks the server certificate and its CA chain to verify that the server you reached is authentic. + +### Client certificate +Clients do not always need certificates when communicating with servers, but sometimes client certificates can be used wherein the server verifies authenticity of the client similar to how the client verifies authenticity for the server. When client certificates are unique to a client, this can be used as a form of authentication to provide convenient yet secure login. + +### Self-signed certificates +A self-signed certificate is one that is not signed by a CA at all – neither private nor public. In this case, the certificate is signed with its own private key, instead of requesting verification from a public or a private CA. This arrangement, however, means there is no chain of trust to guarantee that the host with this certificate is the one you wanted to communicate with. Note that these certificates are not secure against other hosts masquerading as the one you want to access. As such, it is highly recommended that certificates be verified against the truststore for production environments. + +## Certificate verification +When you configure Zowe, it is necessary to decide whether Zowe will perform verification of certificates against its truststore. +In the Zowe configuration YAML, the property `zowe.verifyCertificates` controls the verification behavior. It can be `DISABLED`, `NONSTRICT`, or `STRICT`. + +You can set this property either before or after certificate setup, but **it is recommended to set `zowe.verifyCertificates` before certificate setup** because it affects the automation that Zowe can perform during certificate setup. + +- [DISABLED verification](#disabled-verification) +- [NON-STRICT verification](#non-strict-verification) +- [STRICT verification](#strict-verification) + +### DISABLED verification +If you set `zowe.verifyCertificates` to `DISABLED`, certificate verification is not performed. This is not recommended for security reasons, but may be used for proof of concept or when certificates within your environment are self-signed. + +If you set `DISABLED` before certificate setup, Zowe will not automate putting z/OSMF trust objects into the Zowe truststore. This can result in failure to communicate with z/OSMF if at a later time you enable verification. As such, it is recommended to either set verification on by default, or to re-initialize the keystore if you choose to turn verification on at a later point. + +### NON-STRICT verification +If you set `zowe.verifyCertificates` to `NONSTRICT`, certificate verification will be performed except for hostname validation. Using this setting, the certificate Common Name or Subject Alternate Name (SAN) is not checked. Skipping hostname validation facilitates deployment to environments where certificates are valid but do not contain a valid hostname. This configuration is for development purposes only and should not be used for production. + +### STRICT verification +`STRICT` is the recommended setting for `zowe.verifyCertificates`. This setting performs maximum verification on all certificates Zowe sees and uses a Zowe truststore. + + +## Zowe certificate requirements +If you do not yet have certificates, Zowe can create self-signed certificates for you. This is not recommended for production. Note that the certificates must be valid for use with Zowe. + +- [Extended key usage](#extended-key-usage) +- [Hostname validity](#hostname-validity) +- [z/OSMF access](#zosmf-access) +### Extended key usage +Zowe server certificates must either not have the `Extended Key Usage` (EKU) attribute, or have both the `TLS Web Server Authentication (1.3.6.1.5.5.7.3.1)` and `TLS Web Client Authentication (1.3.6.1.5.5.7.3.2)` values present within. + +Some Zowe components act as a server, some as a client, and some as both - client and server. The component certificate usage for each of these cases is controlled by the Extended Key Usage (EKU) certificate attribute. Zowe components use a single certificate/the same certificate for client and server authentication. As such, it is necessary that this certificate is valid for the intended usage/s of the component - client, server, or both. The EKU certificate extension attribute is not required. If, however, the EKU certificate extension attribute is specified, it must be defined with the intended usage/s. Otherwise, connection requests will be rejected by the other party. + + +### Hostname validity +The host communicating with a certificate should have its hostname match one of the values of the certificate's Common Name or Subject Alternate Name (SAN). If this condition is not true for at least one of the certificates seen by Zowe, then you may wish to set [NON-STRICT verification](#non-strict-verification) within Zowe configuration. + +### z/OSMF access +The z/OSMF certificate is verified according to Zowe [Certificate verification setting](#certificate-verification), as is the case with any certificate seen by Zowe. However, Zowe will also set up a trust relationship with z/OSMF within the Zowe truststore during certificate setup automation if the certificate setting is set to any value other than [DISABLED](#disabled-verification). + + +## Certificate setup types +Whether importing or letting Zowe generate certificates, the setup for Zowe certificate automation and the configuration to use an existing keystore and truststore depends upon the content format: file-based (`PKCS12`) or z/OS key ring-based. + +- [File-based (PKCS12) certificate setup](#file-based-pkcs12-certificate-setup) +- [z/OS key ring-based certificate setup](#zos-key-ring-based-certificate-setup) +### File-based (PKCS12) certificate setup + +Zowe is able to use PKCS12 certificates that are stored in USS. Zowe uses a `keystore` directory to contain its certificates primarily in PKCS12 (`.p12`, `.pfx`) file format, but also in PEM (`.pem`) format. The truststore is in the `truststore` directory that holds the public keys and CA chain of servers which Zowe communicates with (for example z/OSMF). + +### z/OS key ring-based certificate setup + +Zowe is able to work with certificates held in a **z/OS Key ring**. + +The JCL member `.SZWESAMP(ZWEKRING)` contains security commands to create a SAF keyring. By default, this key ring is named `ZoweKeyring`. You can use the security commands in this JCL member to generate a Zowe certificate authority (CA) and sign the server certificate with this CA. The JCL contains commands for all three z/OS security managers: RACF, TopSecret, and ACF2. + +There are two ways to configure and submit `ZWEKRING`: + +- Copy the JCL `ZWEKRING` member and customize its values. +- Customize the `zowe.setup.certificate` section in `zowe.yaml` and use the `zwe init certificate` command. + + You can also use the `zwe init certificate` command to prepare a customized JCL member using `ZWEKRING` as a template. + +A number of key ring scenarios are supported: + +- Creation of a local certificate authority (CA) which is used to sign a locally generated certificate. Both the CA and the certificate are placed in the `ZoweKeyring`. +- Import of an existing certificate already held in z/OS to the `ZoweKeyring` for use by Zowe. +- Creation of a locally generated certificate and signed by an existing certificate authority. The certificate is placed in the key ring. diff --git a/versioned_docs/version-v2.15.x/appendix/zowe-yaml-configuration.md b/versioned_docs/version-v2.15.x/appendix/zowe-yaml-configuration.md new file mode 100644 index 0000000000..e4d055e3d7 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zowe-yaml-configuration.md @@ -0,0 +1,625 @@ +# Zowe YAML server configuration file reference + +Zowe v2 uses a YAML configuration file for server installation, configuration, and runtime. This file is usually referred to as the Zowe configuration YAML file or the `zowe.yaml` file. YAML is a human-friendly data serialization language for all programming languages. To learn more about YAML specifications, see [https://yaml.org/](https://yaml.org/). For a free, offline YAML validator to help validate your syntax, download the [Red Hat's VS Code YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml). + +Content within the YAML file is documented by and validated against schema files which are shipped within Zowe and extended by Zowe extensions. +For details on the schema technology and where to find the schema files within our source code, see [Using the Configuration Manager](../user-guide/configmgr-using.md#json-schema-validation). + +:::note + +In the following sections, we refer to configuration keys by using the concatenation of key names and dots. For example, if you want to update the configuration key `zowe.certificate.keystore.type` with value `PKCS12`, you should set value for this entry in the `zowe.yaml`: + +```yaml +zowe: + certificate: + keystore: + type: PKCS12 +``` + +::: + +**Table of Contents** + +- [High-level overview of YAML configuration file](#high-level-overview-of-yaml-configuration-file) +- [Extract sharable configuration out of zowe.yaml](#extract-sharable-configuration-out-of-zoweyaml) +- [Configuration override](#configuration-override) +- [YAML configurations - certificate](#yaml-configurations---certificate) +- [YAML configurations - zowe](#yaml-configurations---zowe) +- [YAML configurations - java](#yaml-configurations---java) +- [YAML configurations - node](#yaml-configurations---node) +- [YAML configurations - zOSMF](#yaml-configurations---zosmf) +- [YAML configurations - components](#yaml-configurations---components) + - [Configure component gateway](#configure-component-gateway) + - [Configure component discovery](#configure-component-discovery) + - [Configure component api-catalog](#configure-component-api-catalog) + - [Configure component caching-service](#configure-component-caching-service) + - [Configure component app-server](#configure-component-app-server) + - [Configure component zss](#configure-component-zss) + - [Configure component jobs-api](#configure-component-jobs-api) + - [Configure component files-api](#configure-component-files-api) + - [Configure component explorer-jes](#configure-component-explorer-jes) + - [Configure component explorer-mvs](#configure-component-explorer-mvs) + - [Configure component explorer-uss](#configure-component-explorer-uss) + - [Configure external extension](#configure-external-extension) +- [YAML configurations - haInstances](#yaml-configurations---hainstances) +- [Auto-generated environment variables](#auto-generated-environment-variables) +- [Troubleshooting your YAML with the Red Hat VSCode extension](#troubleshooting-your-yaml-with-the-red-hat-vs-code-extension) + +### High-level overview of YAML configuration file + +The YAML configuration file has few high-level sections: + +- **`zowe`** + Defines global configurations specific to Zowe, including default values. +- **`java`** + Defines Java configurations used by Zowe components. +- **`node`** + Defines node.js configurations used by Zowe components. +- **`zOSMF`** + Tells Zowe your z/OSMF configurations. +- **`components`** + Defines detailed configurations for each Zowe component or extension. Each component or extension may have a key entry under this section. For example, `components.gateway` is configuration for the API Mediation Layer Gateway service. +- **`haInstances`** + Defines customized configurations for each High Availability (HA) instance. You should predefine all Zowe HA instances you want to start within your Sysplex. + +### Extract sharable configuration out of zowe.yaml + +The Zowe YAML configuration file supports splitting into several files or PARMLIB members when "zowe.useConfigmgr" is set to true. This can help simplify grouping configuration changes by type or owner. +More details can be found [in the configmgr documentation.](../user-guide/configmgr-using.md#splitting-configuration-into-multiple-storage-types) + + +### Creating portable references + +The Zowe YAML configuration file has template logic for relating one value to another, a system environment variable or symbol, or even to add conditional behavior. +This feature is available when "zowe.useConfigmgr" is set to true, and it can help to make your configuration portable between systems that need slightly different behavior while retaining the same configuration file. +More details can be found [in the configmgr documentation.](../user-guide/configmgr-using.md#configuration-templates) + +### Configuration override + +Inside `zowe.yaml`, you can define default values and they may be overridden in more granular level configurations. This can happen in several ways: + +- The component can override the default certificate configuration. For the specific entry of certification configuration, if it's not overridden, it falls back to default configurations. + +**Example:** + + ```yaml + zowe: + certificate: + keystore: + type: PKCS12 + file: /global/zowe/keystore/localhost/localhost.keystore.p12 + password: password + alias: localhost + truststore: + type: PKCS12 + file: /global/zowe/keystore/localhost/localhost.truststore.p12 + password: password + pem: + key: /global/zowe/keystore/localhost/localhost.key + certificate: /global/zowe/keystore/localhost/localhost.cer + certificateAuthorities: /global/zowe/keystore/local_ca/local_ca.cer + components: + app-server: + certificate: + keystore: + alias: app-server + pem: + key: /global/zowe/keystore/localhost/app-server.key + certificate: /global/zowe/keystore/localhost/app-server.cer + ``` + + App Server will use the certificate alias `app-server` instead of `localhost` from the same keystore defined in `zowe.certificate.keystore.file`. And it will use the exact same truststore defined in `zowe.certificate.truststore.file`. + +- Zowe high availability (HA) instance component configuration `haInstances..components.` can override global level component configurations `components.`. Any configuration you can find in `components.` level can be overridden in `haInstances..components.` level. For example, in this configuration: + + ```yaml + components: + app-server: + enabled: true + port: 8544 + haInstances: + lpar2a: + components: + app-server: + enabled: false + lpar2b: + components: + app-server: + port: 28544 + ``` + + App Server on `lpar2a` HA instance will not be started. On `lpar2b` HA instance, it will be started but on port 28544. + +### YAML configurations - certificate + +In Zowe YAML configuration, certificate definition shares the same format and this format can be used in several configuration entries. For example, `zowe.certificate`, `components..certificate`, and `haInstances..components..certificate`. The certificate definition may include the following entries: + +- **`keystore.type`** + Defines the type of the keystore. If you are using keystore, this value usually should be `PKCS12`. If you are using keyring, this value should be `JCERACFKS`. +- **`keystore.file`** + Defines the path of the keystore file. If you are using keyring, this should look like `safkeyring:///`. For example, `safkeyring://ZWESVUSR/ZoweKeyring`. +- **`keystore.password`** + Defines the password of the keystore. +- **`keystore.alias`** + Represents the alias name of the certificate stored in keystore. If you are using keyring, this is the certificate label connected to the keyring. +- **`truststore.type`** + Defines the type of the truststore file. If you are using keystore, this value usually should be `PKCS12`. If you are using keyring, this value should be `JCERACFKS`. +- **`truststore.file`** + Defines the path to the truststore file. If you are using keyring, this should look like `safkeyring:///`, usually will be the same value of `keystore.file`. +- **`truststore.password`** + Defines the password of the truststore. +- **`pem.key`** + Defines the private key file in PEM format. This can be used by applications that do not support either PKCS12 keystore format or z/OS keyring. +- **`pem.certificate`** + Defines the public key file in PEM format. This can be used by applications that do not support either PKCS12 keystore format or z/OS keyring. +- **`pem.certificateAuthorities`** + Defines certificate authorities in PEM format. This can be used by applications that do not support either PKCS12 keystore format or z/OS keyring. + +### YAML configurations - zowe + +The high-level configuration `zowe` supports these definitions: + +#### Directories + +- **`zowe.runtimeDirectory`** + Tells Zowe the runtime directory where it's installed. +- **`zowe.logDirectory`** + Some Zowe components write logs to file system. This tells Zowe which directory should be used to store log files. +- **`zowe.workspaceDirectory`** + Tells Zowe components where they can write temporary runtime files. +- **`zowe.extensionDirectory`** + Tells Zowe where you put the runtime of all your extensions. + + #### Zowe Job + +- **`zowe.job.name`** + Defines the Zowe job name for the ZWESLSTC started task. +- **`zowe.job.prefix`** + Defines the Zowe address space prefix for Zowe components. + +#### Domain and port to access Zowe + +- **`zowe.externalDomains`** + Defines a list of external domains that will be used by the Zowe instance. This configuration is an array of domain name strings. + In Sysplex deployment, this is the DVIPA domain name defined in Sysplex Distributor. For example, + + ```yaml + zowe: + externalDomains: + - external.my-company.com + - additional-dvipa-domain.my-company.com + ``` + In Kubernetes deployment, this is the domain name you will use to access your Zowe running in Kubernetes cluster. +- **`zowe.externalPort`** + Defines the port that will be exposed to external Zowe users. By default, this value is set based on Zowe APIML Gateway port. + In Sysplex deployment, this is the DVIPA port defined in Sysplex Distributor. See [Configure Sysplex Distributor](../user-guide/configure-sysplex.md#configuring-sysplex-distributor) for more information. + In Kubernetes deployment, this is the gateway Service port will be exposed to external. + +#### Extra environment variables + +- **`zowe.environments`** + Defines extra environment variables to customize the Zowe runtime. This configuration is a list of key / value pairs. + **Example:** + + ```yaml + zowe: + environments: + MY_NEW_ENV: value-of-my-env + ``` + Please be aware that variables defined here are global to all Zowe components, on all HA instances. + + An example use case is to override system-wide environment variables for the Zowe runtime, such as the directory to use for temporary files. + +#### Certificate + +- **`zowe.certificate`** + Defines the northbound certificate facing Zowe users. +- **`zowe.verifyCertificates`** + Defines how Zowe should validate the certificates used by components or external service(s) like z/OSMF. It can be a value of: + * `STRICT`: This is the default value. Zowe will validate if the certificate is trusted in our trust store and if the certificate Command Name and Subject Alternative Name (SAN)is validated. This is recommended for the best security. + * `NONSTRICT`: Zowe will validate if the certificate is trusted in our trust store. In this mode, Zowe does not validate certificate Common Name and Subject Alternative Name (SAN). This option does not have the best security but allows you to try out Zowe when you don't have permission to fix certificate used by external services like z/OSMF. + * `DISABLED`: This will disable certificate validation completely. This is **NOT** recommended for security purpose. + +#### Launcher and launch scripts + +Launcher is the program behind `ZWESLSTC` started task. + +- **`zowe.launcher`** + The launcher section defines defaults about how the Zowe launcher should act upon components. +- **`zowe.launcher.restartIntervals`** + An array of positive integers that defines how many times a component should be tried to be restarted if it fails, and how much time to wait in seconds for that restart to succeed before retrying. +- **`zowe.launcher.minUptime`** + The minimum amount of time a zowe component should be running in order to be declared as started successfully. +- **`zowe.launcher.shareAs`** + Whether or not the launcher should start components in the same address space as it. See documentation for [_BPX_SHAREAS](https://www.ibm.com/docs/en/zos/2.4.0?topic=shell-setting-bpx-shareas-bpx-spawn-script) for details. +- **`zowe.launchScript.logLevel`** + You can set it to `debug` or `trace` to enable different level of debug messages from Zowe launch scripts. This may help to troubleshoot issues during Zowe start. + +#### Setup + +Zowe YAML configuration uses `zowe.setup` section to instruct how Zowe should be installed and configured. This section is optional for Zowe runtime but only be used for `zwe install` and `zwe init` commands. + +```yaml +zowe: + setup: + dataset: + prefix: IBMUSER.ZWE + parmlib: IBMUSER.ZWE.CUST.PARMLIB + jcllib: IBMUSER.ZWE.CUST.JCLLIB + authLoadlib: IBMUSER.ZWE.CUST.ZWESALL + authPluginLib: IBMUSER.ZWE.CUST.ZWESAPL + security: + product: RACF + groups: + admin: ZWEADMIN + stc: ZWEADMIN + sysProg: ZWEADMIN + users: + zowe: ZWESVUSR + zis: ZWESIUSR + stcs: + zowe: ZWESLSTC + zis: ZWESISTC + aux: ZWESASTC + certificate: + type: PKCS12 + dname: + caCommonName: + commonName: + orgUnit: + org: + locality: + state: + country: + validity: 3650 + pkcs12: + directory: /global/zowe/keystore + lock: true + name: localhost + password: password + caAlias: local_ca + caPassword: local_ca_password + import: + keystore: + password: + alias: + keyring: + owner: + name: ZoweKeyring + label: localhost + caLabel: localca + import: + dsName: + password: + connect: + user: + label: + zOSMF: + ca: + user: IZUSVR + san: + - zos.my-company.com + - internal-lpar1.zos.my-company.com + - internal-lpar2.zos.my-company.com + - internal-lpar3.zos.my-company.com + importCertificateAuthorities: + - + vsam: + mode: NONRLS + volume: VOL123 + storageClass: +``` + +- `zowe.setup.dataset.prefix` shows where the `SZWEAUTH` data set is installed. +- `zowe.setup.dataset.parmlib` is the user custom parameter library. Zowe server command may generate sample PARMLIB members and stores here. +- `zowe.setup.dataset.jcllib` is the custom JCL library. Zowe server command may generate sample JCLs and put into this data set. +- `zowe.setup.dataset.authLoadlib` is the user custom APF LOADLIB. This field is optional. If this is defined, members of `SZWEAUTH` will be copied over to this data set and it will be APF authorized. If it is not defined, `SZWEAUTH` from `zowe.setup.dataset.prefix` will be APF authorized. +- `zowe.setup.dataset.authPluginLib` is the user custom APF PLUGINLIB. You can install Zowe ZIS plug-ins into this load library. This loadlib requires APF authorize. + +- `zowe.setup.security.product` is the security product. Can be `RACF`, `ACF2`, or `TSS`. This configuration is optional. The default value is `RACF`. +- `zowe.setup.security.groups.admin` is the group for Zowe administrators. This configuration is optional. The default value is `ZWEADMIN`. +- `zowe.setup.security.groups.stc` is the group for Zowe started tasks. This configuration is optional. The default value is `ZWEADMIN`. +- `zowe.setup.security.groups.sysProg` is system programmer user ID/group. This configuration is optional. The default value is `ZWEADMIN`. +- `zowe.setup.security.users.zowe` is the userid for Zowe started task. This configuration is optional. The default value is `ZWESVUSR`. +- `zowe.setup.security.users.zis` is userid for ZIS started task. This configuration is optional. Th default value is `ZWESIUSR`. +- `zowe.setup.security.stcs.zowe` is Zowe started task name. This configuration is optional. The default value is `ZWESLSTC`. +- `zowe.setup.security.stcs.zis` is ZIS started task name. This configuration is optional. The default value is `ZWESISTC`. +- `zowe.setup.security.stcs.aux` is ZIS AUX started task name. This configuration is optional. The default value is `ZWESASTC`. + +- `zowe.setup.certificate.type` is the type of certificate. Valid values are `PKCS1` (USS keystore) or `JCERACFKS` (z/OS keyring). +- `zowe.setup.certificate.dname` is the distinguished name of the certificate. You can define `caCommonName`, `commonName`, `orgUnit`, `org`, `locality`, `state`, and / or `country`. These configurations are optional. +- `zowe.setup.certificate.validity` is the validity days of the certificate. This is optional. +- `zowe.setup.certificate.san` is the `Subject Alternative Name`(s) of the certificate if they are different from `zowe.externalDomains`. Note that for `JCERACFKS` type, with limitation of RACDCERT command, this should contain exact one hostname (domain) and one IP address. +- `zowe.setup.certificate.importCertificateAuthorities` is the list of certificate authorities will be imported to Zowe `PKCS12` keystore or `JCERACFKS` keyring. Please note, for JCERACFKS type, only maximum 2 CAs is supported. If you are using `PKCS12` certificate, this should be USS files in PEM format. If you are using `JCERACFKS` certificate, this should be certificate labels on the z/OS system. + +**For `PKCS12` certificate users,** + +- `zowe.setup.certificate.pkcs12.directory` is the directory where you plan to store the PKCS12 keystore and truststore. This is required if `zowe.setup.certificate.type` is `PKCS12`. +- `zowe.setup.certificate.pkcs12.lock` is a boolean configuration to tell if we should lock the PKCS12 keystore directory only for Zowe runtime user and group. The default value is true. +- You can also define `name`, `password`, `caAlias` and `caPassword` under `zowe.setup.certificate.pkcs12` to customized keystore and truststore. These configurations are optional, but it is recommended to update them from default values. +- Define `zowe.setup.certificate.pkcs12.import.keystore` if you already acquired certificate from other CA, stored them in PKCS12 format, and want to import into Zowe PKCS12 keystore. +- `zowe.setup.certificate.pkcs12.import.password` is the password for keystore defined in `zowe.setup.certificate.pkcs12.import.keystore`. +- `zowe.setup.certificate.pkcs12.import.alias` is the original certificate alias defined in `zowe.setup.certificate.pkcs12.import.keystore`. After imported, the certificate will be saved as alias specified in `zowe.setup.certificate.pkcs12.name`. + +**For `JCERACFKS` certificate (z/OS keyring) users,** + +- `zowe.setup.certificate.keyring.owner` is the keyring owner. It's optional and default value is `zowe.setup.security.users.zowe`. If it's also not defined, the default value is `ZWESVUSR`. +- `zowe.setup.certificate.keyring.name` is the keyring name will be created on z/OS. This is required if `zowe.setup.certificate.type` is `JCERACFKS`. +- If you want to let Zowe to generate a new certificate: + * You can also customize `label` and `caLabel` under `zowe.setup.certificate.keyring` if you want to generate new certificate. The default value of `label` is `localhost` and default value of `caLabel` is `localca`. +- If you want to import a certificate stored in MVS data set into Zowe keyring: + * `zowe.setup.certificate.keyring.connect.dsName` is required in this case. It tells Zowe the data set where the certificate stored. + * `zowe.setup.certificate.keyring.connect.password` is the password when importing the certificate. + * The certificate will be imported with the label defined in `zowe.setup.certificate.keyring.label`. +- If you want to connect an existing certificate into a Zowe keyring: + * `zowe.setup.certificate.keyring.connect.user` is required and tells Zowe the owner of existing certificate. This field can have value of `SITE`. + * `zowe.setup.certificate.keyring.connect.label` is also required and tells Zowe the label of existing certificate. +- If `zowe.verifyCertificates` is not `DISABLED`, and z/OSMF host (`zOSMF.host`) is provided, Zowe will try to trust the z/OSMF certificate. + * If you are using `RACF` security manager, Zowe will try to automatically detect the z/OSMF CA based on certificate owner specified by + `zowe.setup.certificate.keyring.zOSMF.user`. Default value of this field is `IZUSVR`. If the automatic detection failed, you will need to define `zowe.setup.certificate.keyring.zOSMF.ca` indicates what is the label of the z/OSMF root certificate authority. + * If you are using `ACF2` or `TSS` (Top Secret) security manager, `zowe.setup.certificate.keyring.zOSMF.ca` is required to indicates what is the label of the z/OSMF root certificate authority. + +- `zowe.setup.vsam.mode` indicates whether the VSAM will utilize Record Level Sharing (RLS) services or not. Valid values are `RLS` or `NONRLS`. +- `zowe.setup.vsam.volume` indicates the name of volume. This field is required if VSAM mode is `NONRLS`. +- `zowe.setup.vsam.storageClass` indicates the name of RLS storage class. This field is required if VSAM mode is `RLS`. + +### YAML configurations - java + +The high-level configuration `java` supports these definitions: + +- **`home`** + Defines the path to the Java runtime directory. + +### YAML configurations - node + +The high-level configuration `node` supports these definitions: + +- **`home`** + Defines the path to the Node.js runtime directory. + +### YAML configurations - zOSMF + +The high-level configuration `zOSMF` supports these definitions: + +- **`zOSMF.host`** + Defines the hostname of your z/OSMF instance. +- **`zOSMF.port`** + Defines the port of your z/OSMF instance. +- **`zOSMF.applId`** + Defines the application ID of your z/OSMF instance. + +### YAML configurations - components + +All Zowe components and extensions can have a dedicated section under the `components` high-level configuration. + +In this section, `` represents any Zowe components or extensions. For all components and extensions, these are the common definitions. + +- **`components..enabled`** + Defines if you want to start this component in this Zowe instance. This allows you to control each component instead of a group. +- **`components..certificate`** + You can customize a component to use different certificate from default values. This section follows same format defined in [YAML configurations - certificate](#yaml-configurations-certificate). If this is not customized, the component will use certificates defined in `zowe.certificate`. +- **`components..launcher`** + Any component can have a launcher section which overrides the overall Zowe Launcher default defined in `zowe.launcher`. + +#### Configure component gateway + +These configurations can be used under the `components.gateway` section: + +- **`port`** + Defines the port which the gateway should be started on. This must be a valid port number. +- **`debug`** + Defines whether to enable debug mode for the Gateway. +- **`apiml.service.allowEncodedSlashes`** + When this parameter is set to `true`, the Gateway allows encoded characters to be part of URL requests redirected through the Gateway. +- **`apiml.service.corsEnabled`** + When this parameter is set to `true`, CORS are enabled in the API Gateway for Gateway routes `gateway/api/v1/**`. +- **`apiml.service.preferIpAddress`** + Set this parameter to `true` to advertise a service IP address instead of its hostname. + + :::note + + This configuration is deprecated. Zowe start script will ignore this value and always set it to `false`. + + ::: +- **`apiml.gateway.timeoutMillis`** + Specifies the timeout for connection to the services in milliseconds. +- **`apiml.security.x509.enabled`** + Set this parameter to `true` to enable the client certificate authentication functionality through ZSS. +- **`apiml.security.x509.externalMapperUrl`** + Defines the URL where Gateway can query the mapping of client certificates. +- **`apiml.security.auth.provider`** + Defines the authentication provider used by the API Gateway. +- **`apiml.security.authorization.endpoint.url`** + Defines the URL to the authorization endpoint. This endpoint tells Gateway if a user has a particular permission on SAF profile. For example, permission to the `APIML.SERVICES` profile of `ZOWE` class. +- **`apiml.security.ssl.verifySslCertificatesOfServices`** + Defines whether APIML should verify certificates of services in strict mode. Setting to `true` will enable the `strict` mode where APIML will validate if the certificate is trusted in turststore, and also if the certificate Common Name or Subject Alternate Name (SAN) matches the service hostname. +- **`apiml.security.ssl.nonStrictVerifySslCertificatesOfServices`** + Defines whether APIML should verify certificates of services in non-strict mode. Setting the value to `true` will enable the `non-strict` mode where APIML will validate if the certificate is trusted in turststore, but ignore the certificate Common Name or Subject Alternate Name (SAN) check. Zowe will ignore this configuration when strict mode is enabled with `apiml.security.ssl.verifySslCertificatesOfServices`. +- **`apiml.server.maxConnectionsPerRoute`** + Specifies the maximum connections for each service. +- **`apiml.server.maxTotalConnections`** + Specifies the total connections for all services registered under API Mediation Layer. + +#### Configure component discovery + +These configurations can be used under the `components.discovery` section: + +- **`port`** + Defines the port which discovery should be started on. This may be defined as a valid port number or as an offset from the Gateway component's port. To define an offset enter `"+{offset}"` or `"-{offset}"` as a string. The offset must start with `+` or `-`. +- **`debug`** + Defines whether to enable debug mode for the Discovery Service. +- **`apiml.service.preferIpAddress`** + Set this parameter to `true` to advertise a service IP address instead of its hostname. + + :::note + + This configuration is deprecated. The Zowe start script will ignore this value and always set it to `false`. + + ::: +- **`apiml.security.ssl.verifySslCertificatesOfServices`** + Defines whether APIML should verify certificates of services in strict mode. Setting to `true` will enable the `strict` mode where APIML will validate both if the certificate is trusted in turststore, and also if the certificate Common Name or Subject Alternate Name (SAN) matches the service hostname. +- **`apiml.security.ssl.nonStrictVerifySslCertificatesOfServices`** + Defines whether APIML should verify certificates of services in non-strict mode. Setting to `true` will enable the `non-strict` mode where APIML will validate if the certificate is trusted in turststore, but ignore the certificate Common Name or Subject Alternate Name (SAN) check. Zowe will ignore this configuration if strict mode is enabled with `apiml.security.ssl.verifySslCertificatesOfServices`. +- **`alternativeStaticApiDefinitionsDirectories`** + Specifies the alternative directories of static definitions. +- **`apiml.server.maxTotalConnections`** + Specifies the total connections for all services registered under API Mediation Layer. +- **`apiml.discovery.serviceIdPrefixReplacer`** + Modifies the service ID of a service instance before it registers to API Mediation Layer. + Using this parameter ensures compatibility of services that use a non-conformant organization prefix with v2, based on Zowe v2 conformance. + + +#### Configure component api-catalog + +These configurations can be used under the `components.api-catalog` section: + +- **`port`** + Defines the port which API Catalog should be started on. +- **`debug`** + Defines if we want to enable debug mode for the API Catalog. This is equivalent to the `APIML_DEBUG_MODE_ENABLED` variable but with better granular level. +- **`environment.preferIpAddress`** + Set this parameter to `true` to advertise a service IP address instead of its hostname. + + :::note + + This configuration is deprecated. Zowe start script will ignore this value and always set it to `false`. + + ::: + +#### Configure component caching-service + +These configurations can be used under the `components.caching-service` section: + +- **`port`** + Defines the port which Caching Service should be started on. This may be defined as a valid port number or as an offset from the Gateway component's port. To define an offset enter `"+{offset}"` or `"-{offset}"` as a string. The offset must start with `+` or `-`. +- **`debug`** + Defines if we want to enable debug mode for the Caching Service. +- **`storage.mode`** + Sets the storage type used to persist data in the Caching Service. +- **`storage.size`** + Specifies amount of records before eviction strategies start evicting. +- **`storage.evictionStrategy`** + Specifies eviction strategy to be used when the storage size is achieved. +- **`storage.vsam.name`** + Specifies the data set name of the caching service VSAM data set. +- **`storage.redis.masterNodeUri`** + Specifies the URI used to connect to the Redis master instance in the form `username:password@host:port`. +- **`storage.redis.timeout`** + Specifies the timeout second to Redis. Defaults to 60 seconds. +- `storage.redis.sentinel.masterInstance`: Specifies the Redis master instance ID used by the Redis Sentinel instances. +- **`storage.redis.sentinel.nodes`** + Specifies the array of URIs used to connect to a Redis Sentinel instances in the form `username:password@host:port`. +- **`storage.redis.ssl.enabled`** + Specifies the boolean flag indicating if Redis is being used with SSL/TLS support. Defaults to `true`. +- **`storage.redis.ssl.keystore`** + Specifies the keystore file used to store the private key. +- **`storage.redis.ssl.keystorePassword`** + Specifies the password used to unlock the keystore. +- **`storage.redis.ssl.truststore`** + Specifies the truststore file used to keep other parties public keys and certificates. +- **`storage.redis.ssl.truststorePassword`** + Specifies the password used to unlock the truststore. +- **`environment.preferIpAddress`** + Set this parameter to `true` to advertise a service IP address instead of its hostname. + + :::note + + This configuration is deprecated. Zowe start script will ignore this value and always set it to `false`. + + ::: + +- **`apiml.security.ssl.verifySslCertificatesOfServices`** + Specifies whether APIML should verify certificates of services in strict mode. Set to `true` will enable `strict` mode that APIML will validate both if the certificate is trusted in turststore, and also if the certificate Common Name or Subject Alternate Name (SAN) match the service hostname. +- **`apiml.security.ssl.nonStrictVerifySslCertificatesOfServices`** + Defines whether APIML should verify certificates of services in non-strict mode. Setting to `true` will enable `non-strict` mode where APIML will validate if the certificate is trusted in turststore, but ignore the certificate Common Name or Subject Alternate Name (SAN) check. Zowe will ignore this configuration if strict mode is enabled with `apiml.security.ssl.verifySslCertificatesOfServices`. + +#### Configure component app-server + +These configurations can be used under the `components.app-server` section: + +- **`port`** + Defines the port which App Server should be started on. This may be defined as a valid port number or as an offset from the Gateway component's port. To define an offset enter `"+{offset}"` or `"-{offset}"` as a string. The offset must start with `+` or `-`. + +#### Configure component zss + +These configurations can be used under the `components.zss` section: + +- **`port`** + Defines the port which ZSS should be started on. This may be defined as a valid port number or as an offset from the Gateway component's port. To define an offset enter `"+{offset}"` or `"-{offset}"` as a string. The offset must start with `+` or `-`. + +#### Configure component jobs-api + +These configurations can be used under the `components.jobs-api` section: + +- **`port`** + Defines the port which Jobs API should be started on. This may be defined as a valid port number or as an offset from the Gateway component's port. To define an offset enter `"+{offset}"` or `"-{offset}"` as a string. The offset must start with `+` or `-`. + + - **`debug`** + Defines whether to enable debug logging for the Jobs API. + +#### Configure component files-api + +These configurations can be used under the `components.files-api` section: + +- **`port`** + Defines the port which Files API should be started on. This may be defined as a valid port number or as an offset from the Gateway component's port. To define an offset enter `"+{offset}"` or `"-{offset}"` as a string. The offset must start with `+` or `-`. + + - **`debug`** + Defines whether to enable debug logging for the Files API. + +#### Configure external extension + +You can define a `components.` section and use common component configuration entries. + +For example, enable `my-extension`: + +```yaml +components: + # for extensions, you can add your definition like this + my-extension: + enabled: true +``` + +### YAML configurations - haInstances + +All Zowe high availability instances should have a dedicated section under the `haInstances` high-level configuration. + +In this section, `` represents any Zowe high availability instance ID. + +For all high availability instances, these are the common definitions. + +- **`haInstances..hostname`** + Defines the host name where you want to start this instance. This could be the host name of one LPAR in your Sysplex. +- **`haInstances..sysname`** + Defines the system name of the LPAR where the instance is running. Zowe will use `ROUTE` command to send JES2 start or stop command to this HA instance. +- **`haInstances..components.`** + Optional settings you can override component configurations for this high availability instance. See [Configuration override](#configuration-override) for more details. + +### Auto-generated environment variables + +Each line of Zowe YAML configuration will have a matching environment variable during runtime. This is converted based on pre-defined pattern: + +- All configurations under `zowe`, `components`, `haInstances` will be converted to a variable with name: + * prefixed with `ZWE_`, + * any non-alphabetic-numeric characters will be converted to underscore `_`, + * and no double underscores like `__`. +- Calculated configurations of `haInstance`, which is portion of `haInstances.` will be converted same way. +- Calculated configurations of `configs`, which is portion of `haInstances..components.` will be converted same way. +- All other configuration entries will be converted to a variable with name: + * all upper cases, + * any non-alphabetic-numeric characters will be converted to underscore `_`, + * and no double underscores like `__`. + +For examples: + +- `ZWE_zowe_runtimeDirectory`, parent directory of where `zwe` server command is located. +- `ZWE_zowe_workspaceDirectory` is the path of user customized workspace directory. +- `ZWE_zowe_setup_dataset_prefix` is the high-level qualifier where Zowe MVS data sets are installed. +- `ZWE_zowe_setup_dataset_parmlib` is the data set configured to store customized version of parameter library members. +- `ZWE_zowe_setup_dataset_authPluginLib` is the data set configured to store APF authorized ZIS plug-ins load library. +- `ZWE_zowe_setup_security_users_zowe` is the name of Zowe runtime user. +- `ZWE_configs_port` is your component port number you can use in your start script. It points to the value of `haInstances..components..port`, or fall back to `components..port`, or fall back to `configs.port` defined in your component manifest. + +### Troubleshooting your YAML with the Red Hat VS Code extension + +After you download the Red Hat VSCode extension for YAML, YAML validation for your files is turned on by default. Syntax mistakes are highlighted in red. To parse sensitive information, we would highly recommend leaving the data gathering option disabled. To customize your settings, click on the "Extensions" category in VS Code left-hand side workspace, scroll down to YAML Language Support by Red Hat, and click on the gear icon and select "Extension Settings". diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-clean.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-clean.md new file mode 100644 index 0000000000..f22e48623a --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-clean.md @@ -0,0 +1,98 @@ +# zwe certificate keyring-jcl clean + +[zwe](./../.././zwe) > [certificate](./.././zwe-certificate) > [keyring-jcl](././zwe-certificate-keyring-jcl) > [clean](./zwe-certificate-keyring-jcl-clean) + + zwe certificate keyring-jcl clean [parameter [parameter]...] + +## Description + +Remove Zowe keyring. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate keyring-jcl clean --dataset-prefix my-dataset-prefix --jcllib my-jcllib --security-dry-run --keyring-owner my-keyring-owner --keyring-name my-keyring-name -a certificate-alias -ca ca-alias + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--dataset-prefix,--ds-prefix||string|yes|Dataset prefix where Zowe is installed. +--jcllib||string|yes|JCLLIB data set name where the JCL will be placed. +--security-dry-run||boolean|no|Whether to dry run security related setup. +--security-product||string|no|Security product. Can be a value of RACF, ACF2 or TSS. +--keyring-owner||string|yes|Owner of the keyring. +--keyring-name||string|yes|Name of the keyring. +--alias|-a|string|yes|Certificate alias name. +--ca-alias|-ca|string|yes|Certificate authority alias name. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0176E|176|Failed to clean up Zowe keyring "%s". + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-connect.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-connect.md new file mode 100644 index 0000000000..2161d0c3bc --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-connect.md @@ -0,0 +1,102 @@ +# zwe certificate keyring-jcl connect + +[zwe](./../.././zwe) > [certificate](./.././zwe-certificate) > [keyring-jcl](././zwe-certificate-keyring-jcl) > [connect](./zwe-certificate-keyring-jcl-connect) + + zwe certificate keyring-jcl connect [parameter [parameter]...] + +## Description + +Connect existing certificate to Zowe keyring. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate keyring-jcl connect --dataset-prefix my-dataset-prefix --jcllib my-jcllib --security-dry-run --keyring-owner my-keyring-owner --keyring-name my-keyring-name --connect-user cert-owner --connect-label cert-label + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--dataset-prefix,--ds-prefix||string|yes|Dataset prefix where Zowe is installed. +--jcllib||string|yes|JCLLIB data set name where the JCL will be placed. +--security-dry-run||boolean|no|Whether to dry run security related setup. +--security-product||string|no|Security product. Can be a value of RACF, ACF2 or TSS. +--keyring-owner||string|yes|Owner of the keyring. +--keyring-name||string|yes|Name of the keyring. +--trust-cas||string|no|Labels of extra certificate authorities should be trusted, separated by comma (Maximum 2). +--connect-user||string|yes|Certificate owner. Can be `SITE` or a user ID. +--connect-label||string|yes|Certificate label to connect. +--trust-zosmf||boolean|no|Whether to trust z/OSMF CA. +--zosmf-ca||string|no|Labels of z/OSMF root certificate authorities. Specify `_auto_` to let Zowe to detect automatically. This works for RACF and TSS. +--zosmf-user||string|no|z/OSMF user name. This is used to automatically detect z/OSMF root certificate authorities. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0175E|175|Failed to connect existing certificate to Zowe keyring "%s". + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-generate.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-generate.md new file mode 100644 index 0000000000..fdb9ff8adc --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-generate.md @@ -0,0 +1,110 @@ +# zwe certificate keyring-jcl generate + +[zwe](./../.././zwe) > [certificate](./.././zwe-certificate) > [keyring-jcl](././zwe-certificate-keyring-jcl) > [generate](./zwe-certificate-keyring-jcl-generate) + + zwe certificate keyring-jcl generate [parameter [parameter]...] + +## Description + +Generate new set of certificate in Zowe keyring. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate keyring-jcl generate --dataset-prefix my-dataset-prefix --jcllib my-jcllib --security-dry-run --keyring-owner my-keyring-owner --keyring-name my-keyring-name -d my-domain -a certificate-alias -ca ca-alias + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--dataset-prefix,--ds-prefix||string|yes|Dataset prefix where Zowe is installed. +--jcllib||string|yes|JCLLIB data set name where the JCL will be placed. +--security-dry-run||boolean|no|Whether to dry run security related setup. +--security-product||string|no|Security product. Can be a value of RACF, ACF2 or TSS. +--keyring-owner||string|yes|Owner of the keyring. +--keyring-name||string|yes|Name of the keyring. +--domains|-d|string|yes|Domain and IP for the certificate separated by comma. (Please note RACDCERT is limited to only have one domain and one IP.) +--alias|-a|string|yes|Certificate alias name. +--ca-alias|-ca|string|yes|Certificate authority alias name. +--common-name|-cn|string|no|Common name of certificate and certificate authority. +--org-unit||string|no|Organization unit of certificate and certificate authority. +--org||string|no|Organization of certificate and certificate authority. +--locality||string|no|Locality of certificate and certificate authority. +--state||string|no|State of certificate and certificate authority. +--country||string|no|Country of certificate and certificate authority. +--validity||string|no|Validity days of certificate. +--trust-cas||string|no|Labels of extra certificate authorities should be trusted, separated by comma (Maximum 2). +--trust-zosmf||boolean|no|Whether to trust z/OSMF CA. +--zosmf-ca||string|no|Labels of z/OSMF root certificate authorities. Specify `_auto_` to let Zowe to detect automatically. This works for RACF and TSS. +--zosmf-user||string|no|z/OSMF user name. This is used to automatically detect z/OSMF root certificate authorities. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0174E|174|Failed to generate certificate in Zowe keyring "%s". + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-import-ds.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-import-ds.md new file mode 100644 index 0000000000..6a59bc1d99 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-import-ds.md @@ -0,0 +1,103 @@ +# zwe certificate keyring-jcl import-ds + +[zwe](./../.././zwe) > [certificate](./.././zwe-certificate) > [keyring-jcl](././zwe-certificate-keyring-jcl) > [import-ds](./zwe-certificate-keyring-jcl-import-ds) + + zwe certificate keyring-jcl import-ds [parameter [parameter]...] + +## Description + +Import certificate stored in MVS data set into Zowe keyring. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate keyring-jcl import-ds --dataset-prefix my-dataset-prefix --jcllib my-jcllib --security-dry-run --keyring-owner my-keyring-owner --keyring-name my-keyring-name -a certificate-alias --import-ds-name my-ds-name --import-ds-password my-ds-password + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--dataset-prefix,--ds-prefix||string|yes|Dataset prefix where Zowe is installed. +--jcllib||string|yes|JCLLIB data set name where the JCL will be placed. +--security-dry-run||boolean|no|Whether to dry run security related setup. +--security-product||string|no|Security product. Can be a value of RACF, ACF2 or TSS. +--keyring-owner||string|yes|Owner of the keyring. +--keyring-name||string|yes|Name of the keyring. +--alias|-a|string|yes|Certificate alias name. +--trust-cas||string|no|Labels of extra certificate authorities should be trusted, separated by comma (Maximum 2). +--trust-zosmf||boolean|no|Whether to trust z/OSMF CA. +--zosmf-ca||string|no|Labels of z/OSMF root certificate authorities. Specify `_auto_` to let Zowe to detect automatically. This works for RACF and TSS. +--zosmf-user||string|no|z/OSMF user name. This is used to automatically detect z/OSMF root certificate authorities. +--import-ds-name||string|yes|Name of the data set holds certificate to import into keyring. +--import-ds-password||string|yes|Password of the data set holds certificate to import. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0173E|173|Failed to import certificate to Zowe keyring "%s". + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl.md new file mode 100644 index 0000000000..720ee07441 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl.md @@ -0,0 +1,93 @@ +# zwe certificate keyring-jcl + +[zwe](../.././zwe) > [certificate](.././zwe-certificate) > [keyring-jcl](./zwe-certificate-keyring-jcl) + + zwe certificate keyring-jcl [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [clean](./zwe-certificate-keyring-jcl-clean.md) +* [connect](./zwe-certificate-keyring-jcl-connect.md) +* [generate](./zwe-certificate-keyring-jcl-generate.md) +* [import-ds](./zwe-certificate-keyring-jcl-import-ds.md) + +## Description + +Manage z/OS Keyring with JCL. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate keyring-jcl clean --dataset-prefix my-dataset-prefix --jcllib my-jcllib --security-dry-run --keyring-owner my-keyring-owner --keyring-name my-keyring-name -a certificate-alias -ca ca-alias + +zwe certificate keyring-jcl connect --dataset-prefix my-dataset-prefix --jcllib my-jcllib --security-dry-run --keyring-owner my-keyring-owner --keyring-name my-keyring-name --connect-user cert-owner --connect-label cert-label + +``` + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-ca.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-ca.md new file mode 100644 index 0000000000..b61d09a0f6 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-ca.md @@ -0,0 +1,102 @@ +# zwe certificate pkcs12 create ca + +[zwe](./../../.././zwe) > [certificate](./../.././zwe-certificate) > [pkcs12](./.././zwe-certificate-pkcs12) > [create](././zwe-certificate-pkcs12-create) > [ca](./zwe-certificate-pkcs12-create-ca) + + zwe certificate pkcs12 create ca [parameter [parameter]...] + +## Description + +Create a new PKCS12 format certificate authority. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate pkcs12 create ca -d /path/to/my/keystore/dir -a ca-alias -p ca-keystore-password + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. +--alias|-a|string|yes|Certificate authority alias name. +--password|-p|string|yes|Password of the certificate authority keystore. +--common-name|-cn|string|no|Common name of certificate authority. +--org-unit||string|no|Organization unit of certificate authority. +--org||string|no|Organization of certificate authority. +--locality||string|no|Locality of certificate authority. +--state||string|no|State of certificate authority. +--country||string|no|Country of certificate authority. +--validity||string|no|Validity days of certificate authority. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--keystore-dir|-d|string|yes|Keystore directory. +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0300W||%s already exists. This %s will be overwritten during configuration. +ZWEL0158E|158|%s already exists. +ZWEL0168E|168|Failed to create certificate authority %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-cert.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-cert.md new file mode 100644 index 0000000000..9a3619d3d6 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-cert.md @@ -0,0 +1,108 @@ +# zwe certificate pkcs12 create cert + +[zwe](./../../.././zwe) > [certificate](./../.././zwe-certificate) > [pkcs12](./.././zwe-certificate-pkcs12) > [create](././zwe-certificate-pkcs12-create) > [cert](./zwe-certificate-pkcs12-create-cert) + + zwe certificate pkcs12 create cert [parameter [parameter]...] + +## Description + +Create a new PKCS12 format certificate. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate pkcs12 create cert -d /path/to/my/keystore/dir -a cert-alias -p cert-keystore-password -k keystore-name --ca-alias ca-alias --ca-password ca-keystore-password + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. +--keystore|-k|string|yes|PKCS12 keystore name. +--alias|-a|string|yes|Certificate alias name. +--password|-p|string|yes|Password of the certificate keystore. +--common-name|-cn|string|no|Common name of certificate. +--domains|-d|string|no|Domain list of certificate Subject Alternative Name (SAN). +--ca-alias||string|yes|Alias name of the certificate authority which is used to sign CSR. +--ca-password||string|yes|Password of the certificate authority keystore which is used to sign CSR. +--org-unit||string|no|Organization unit of certificate. +--org||string|no|Organization of certificate. +--locality||string|no|Locality of certificate. +--state||string|no|State of certificate. +--country||string|no|Country of certificate. +--validity||string|no|Validity days of certificate. +--key-usage||string|no|Key usage of certificate. +--extended-key-usage||string|no|Extended key usage of certificate. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--keystore-dir|-d|string|yes|Keystore directory. +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0300W||%s already exists. This %s will be overwritten during configuration. +ZWEL0158E|158|%s already exists. +ZWEL0169E|169|Failed to create certificate "%s". + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create.md new file mode 100644 index 0000000000..72082ec264 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create.md @@ -0,0 +1,89 @@ +# zwe certificate pkcs12 create + +[zwe](../../.././zwe) > [certificate](../.././zwe-certificate) > [pkcs12](.././zwe-certificate-pkcs12) > [create](./zwe-certificate-pkcs12-create) + + zwe certificate pkcs12 create [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [ca](./zwe-certificate-pkcs12-create-ca.md) +* [cert](./zwe-certificate-pkcs12-create-cert.md) + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate pkcs12 create cert -d /path/to/my/keystore/dir -a cert-alias -p cert-keystore-password -k keystore-name --ca-alias ca-alias --ca-password ca-keystore-password + +zwe certificate pkcs12 create ca -d /path/to/my/keystore/dir -a ca-alias -p ca-keystore-password + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--keystore-dir|-d|string|yes|Keystore directory. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-export.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-export.md new file mode 100644 index 0000000000..c7116da49a --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-export.md @@ -0,0 +1,92 @@ +# zwe certificate pkcs12 export + +[zwe](./../.././zwe) > [certificate](./.././zwe-certificate) > [pkcs12](././zwe-certificate-pkcs12) > [export](./zwe-certificate-pkcs12-export) + + zwe certificate pkcs12 export [parameter [parameter]...] + +## Description + +Export PKCS12 keystore as PEM files. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate pkcs12 export -f /path/to/my/keystore/file -p keystore-cert-password + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--keystore|-f|string|yes|PKCS12 keystore file name. +--password|-p|string|yes|Password of the certificate keystore. +--private-keys||string|no|Private keys should also be exported. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0178E|178|Failed to export PKCS12 keystore %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-import.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-import.md new file mode 100644 index 0000000000..09ae8461ce --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-import.md @@ -0,0 +1,96 @@ +# zwe certificate pkcs12 import + +[zwe](./../.././zwe) > [certificate](./.././zwe-certificate) > [pkcs12](././zwe-certificate-pkcs12) > [import](./zwe-certificate-pkcs12-import) + + zwe certificate pkcs12 import [parameter [parameter]...] + +## Description + +Import certificate and/or certificate authorities into PKCS12 keystore. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate pkcs12 import -f /path/to/my/keystore/file -p keystore-cert-password + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--keystore|-f|string|yes|Destination PKCS12 keystore file name. +--password|-p|string|yes|Password of the destination PKCS12 keystore. +--alias|-a|string|no|Alias in the destination PKCS12 keystore after imported.\nRequired if --source-alias is specified. +--source-keystore|-sf|string|no|Source PKCS12 keystore file name. +--source-password|-sp|string|no|Password of the source PKCS12 keystore. +--source-alias|-sa|string|no|Private keys should also be exported. +--trust-cas||string|no|PEM files of extra certificate authorities should be trusted, separated by comma. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0179E|179|Failed to import certificate (authorities) into keystore %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-lock.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-lock.md new file mode 100644 index 0000000000..beca115498 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-lock.md @@ -0,0 +1,92 @@ +# zwe certificate pkcs12 lock + +[zwe](./../.././zwe) > [certificate](./.././zwe-certificate) > [pkcs12](././zwe-certificate-pkcs12) > [lock](./zwe-certificate-pkcs12-lock) + + zwe certificate pkcs12 lock [parameter [parameter]...] + +## Description + +This command will lock the keystore directory to only be accessible by specified +user group. + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate pkcs12 lock -d /path/to/my/keystore/dir --user keystore-user --group keystore-group + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--keystore-dir|-d|string|yes|Keystore directory. +--user||string|yes|Owner of the keystore directory. +--group||string|yes|Group of the keystore directory. +--group-permission||string|no|Group permission. Can be `` for no permission, or `read`, `write`. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0177E|177|Failed to lock keystore directory %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-trust-service.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-trust-service.md new file mode 100644 index 0000000000..217d54fd2e --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-trust-service.md @@ -0,0 +1,100 @@ +# zwe certificate pkcs12 trust-service + +[zwe](./../.././zwe) > [certificate](./.././zwe-certificate) > [pkcs12](././zwe-certificate-pkcs12) > [trust-service](./zwe-certificate-pkcs12-trust-service) + + zwe certificate pkcs12 trust-service [parameter [parameter]...] + +## Description + +This command can detect and trust any service by importing the certificate +into truststore. + +NOTE: the service must be online and accessible. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate pkcs12 trust-service -s service-name -d /path/to/my/keystore/dir -k keystore-name -p keystore-cert-password --host service-hostname --port service-port -a cert-alias + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--service-name|-n|string|yes|Service name. +--keystore-dir|-d|string|yes|Keystore directory. +--keystore|-k|string|yes|PKCS12 keystore name. +--password|-p|string|yes|Password of the certificate keystore. +--host||string|yes|Host name of the service. +--port||string|yes|Port of the service. +--alias|-a|string|yes|Certificate alias name for the imported the certificate. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0300W||%s already exists. This %s will be overwritten during configuration. +ZWEL0170E|170|Failed to trust service "%s". + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12.md new file mode 100644 index 0000000000..fa1bca4995 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12.md @@ -0,0 +1,94 @@ +# zwe certificate pkcs12 + +[zwe](../.././zwe) > [certificate](.././zwe-certificate) > [pkcs12](./zwe-certificate-pkcs12) + + zwe certificate pkcs12 [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [create](./create/zwe-certificate-pkcs12-create.md) +* [export](./zwe-certificate-pkcs12-export.md) +* [import](./zwe-certificate-pkcs12-import.md) +* [lock](./zwe-certificate-pkcs12-lock.md) +* [trust-service](./zwe-certificate-pkcs12-trust-service.md) + +## Description + +Manage PKCS12 format keystore and truststore. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate pkcs12 trust-service -s service-name -d /path/to/my/keystore/dir -k keystore-name -p keystore-cert-password --host service-hostname --port service-port -a cert-alias + +zwe certificate pkcs12 export -f /path/to/my/keystore/file -p keystore-cert-password + +``` + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate-verify-service.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate-verify-service.md new file mode 100644 index 0000000000..6d429e9447 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate-verify-service.md @@ -0,0 +1,94 @@ +# zwe certificate verify-service + +[zwe](./.././zwe) > [certificate](././zwe-certificate) > [verify-service](./zwe-certificate-verify-service) + + zwe certificate verify-service [parameter [parameter]...] + +## Description + +This command can verify if the service certificate is valid by checking the +certificate Common Name (CN) and Subject Alternate Name (SAN). + +NOTE: the service must be online and accessible. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate verify-service --host service-hostname --port service-port + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--host||string|yes|Host name of the service. +--port||string|yes|Port of the service. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0171E|171|Failed to verify certificate (CN and SAN) of service "%s". + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate.md new file mode 100644 index 0000000000..59846c2a65 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate.md @@ -0,0 +1,88 @@ +# zwe certificate + +[zwe](.././zwe) > [certificate](./zwe-certificate) + + zwe certificate [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [keyring-jcl](./keyring-jcl/zwe-certificate-keyring-jcl.md) +* [pkcs12](./pkcs12/zwe-certificate-pkcs12.md) +* [verify-service](./zwe-certificate-verify-service.md) + +## Description + +Set of commands to help you manage certificates. + + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe certificate keyring-jcl clean --dataset-prefix my-dataset-prefix --jcllib my-jcllib --security-dry-run --keyring-owner my-keyring-owner --keyring-name my-keyring-name -a certificate-alias -ca ca-alias + +zwe certificate verify-service --host service-hostname --port service-port + +``` + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-extract.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-extract.md new file mode 100644 index 0000000000..659af6a4fc --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-extract.md @@ -0,0 +1,99 @@ +# zwe components install extract + +[zwe](./../.././zwe) > [components](./.././zwe-components) > [install](././zwe-components-install) > [extract](./zwe-components-install-extract) + + zwe components install extract [parameter [parameter]...] + +## Description + +Extract module package and lay down to target directory. + +NOTE: this sub-command will be automatically executed by `zwe components install`, + so usually you don't need to execute this manually. + + +## Examples + +``` +zwe components install extract -c /path/to/zowe.yaml -o /path/to/component/package + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--component-file,--component|-o|string|yes|Path to the component package or directory. +--auto-encoding|-e|string|no|If we want to automatically tagging the module files. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0139E|139|Failed to create directory %s. +ZWEL0153E|153|Cannot install Zowe component to system root directory. +ZWEL0154E|154|Temporary directory is empty. +ZWEL0155E|155|Component %s already exists in %s. If you meant to upgrade this component, run the command 'zwe components upgrade' instead. +ZWEL0167E|167|Cannot find component name from %s package manifest. +ZWEL0204E|204|Symlink creation failure, error=%s +ZWEL0313E|313|Cannot file component file %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +ZWEL0156E|156|Component name is not initialized after extract step. +ZWEL0180E|180|Zowe extension directory (zowe.extensionDirectory) is not defined in Zowe YAML configuration file. +ZWEL0304E|304|Handler install failure, cannot continue. +ZWEL0305E|305|Could not find one of the components' directories. +ZWEL0314E|314|Cannot install with component=all. This option only exists for upgrade. +ZWEL0315E|315|Handler (-handler or zowe.extensionRegistry.defaultHandler) required but not specified.||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-process-hook.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-process-hook.md new file mode 100644 index 0000000000..f6583656ed --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-process-hook.md @@ -0,0 +1,89 @@ +# zwe components install process-hook + +[zwe](./../.././zwe) > [components](./.././zwe-components) > [install](././zwe-components-install) > [process-hook](./zwe-components-install-process-hook) + + zwe components install process-hook [parameter [parameter]...] + +## Description + +Process module install hook if exists. + +NOTE: this sub-command will be automatically executed by `zwe components install`, + so usually you don't need to execute this manually. + + +## Examples + +``` +zwe components install process-hook -c /path/to/zowe.yaml -n component-name + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--component-name|-n|string|yes|Component name. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +ZWEL0156E|156|Component name is not initialized after extract step. +ZWEL0180E|180|Zowe extension directory (zowe.extensionDirectory) is not defined in Zowe YAML configuration file. +ZWEL0304E|304|Handler install failure, cannot continue. +ZWEL0305E|305|Could not find one of the components' directories. +ZWEL0314E|314|Cannot install with component=all. This option only exists for upgrade. +ZWEL0315E|315|Handler (-handler or zowe.extensionRegistry.defaultHandler) required but not specified.||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install.md new file mode 100644 index 0000000000..ba1186d4c2 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install.md @@ -0,0 +1,114 @@ +# zwe components install + +[zwe](../.././zwe) > [components](.././zwe-components) > [install](./zwe-components-install) + + zwe components install [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [extract](./zwe-components-install-extract.md) +* [process-hook](./zwe-components-install-process-hook.md) + +## Description + +Install a Zowe component, given a component archive, component directory, or component name. +When a component name is given instead of a path, the installation will be performed against a Zowe package registry if one is configured. +Archives can be in the .tar, .zip, or pax format where a component is at the root of the archive. + +Components are the packaging standard of Zowe. +Zowe has core Components, but extensions are also delivered as Components. +You can read more about them here: +https://docs.zowe.org/stable/extend/packaging-zos-extensions/ + +**IMPORTANT NOTES**, by default, this command will enable the component globally + by modifying your YAML configuration. You can pass + `--skip-enable` to disable this behavior. + + +## Examples + +``` +zwe components install -c /path/to/zowe.yaml -o /path/to/component/package + +zwe components install extract -c /path/to/zowe.yaml -o /path/to/component/package + +``` + +## Parameters only for this command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--component-file,--component|-o|string|yes|Either a path or component name. The path must be to a component package or directory. If a name is specified instead, install checks the zowe package registry. +--auto-encoding|-e|string|no|If we want to automatically tagging the module files. +--skip-enable||boolean|no|Install component without enabling it for use. +--registry|-r|string|no|Specifies the registry to searh within instead of the default. The registry must be compatible with the manager used. +--handler||string|no|Specifies the registry handler name used with the package registry, instead of the default. The handler must be compatible with the registry used. + + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0156E|156|Component name is not initialized after extract step. +ZWEL0180E|180|Zowe extension directory (zowe.extensionDirectory) is not defined in Zowe YAML configuration file. +ZWEL0304E|304|Handler install failure, cannot continue. +ZWEL0305E|305|Could not find one of the components' directories. +ZWEL0314E|314|Cannot install with component=all. This option only exists for upgrade. +ZWEL0315E|315|Handler (-handler or zowe.extensionRegistry.defaultHandler) required but not specified. + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md new file mode 100644 index 0000000000..82b4cc0983 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md @@ -0,0 +1,89 @@ +# zwe components disable + +[zwe](./.././zwe) > [components](././zwe-components) > [disable](./zwe-components-disable) + + zwe components disable [parameter [parameter]...] + +## Description + +Disable a Zowe component. + +**IMPORTANT NOTES**, this command will modify your YAML configuration. + + +## Examples + +``` +zwe components disable --component-name gateway + +zwe components disable --component-name gateway --ha-instance lpar1 + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--component-name,--component|-o|string|yes|Component name to be disabled. +--ha-instance|-i|string|no|Zowe high availability instance ID from zowe.yaml. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0152E|152|Cannot find component %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md new file mode 100644 index 0000000000..e46d91e55a --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md @@ -0,0 +1,89 @@ +# zwe components enable + +[zwe](./.././zwe) > [components](././zwe-components) > [enable](./zwe-components-enable) + + zwe components enable [parameter [parameter]...] + +## Description + +Enable a Zowe component. + +**IMPORTANT NOTES**, this command will modify your YAML configuration. + + +## Examples + +``` + zwe components enable --component-name gateway + + zwe components enable --component-name gateway --ha-instance lpar1 + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--component-name,--component|-o|string|yes|Component name to be enabled. +--ha-instance|-i|string|no|Zowe high availability instance ID from zowe.yaml. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0152E|152|Cannot find component %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-search.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-search.md new file mode 100644 index 0000000000..64d6c96b69 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-search.md @@ -0,0 +1,97 @@ +# zwe components search + +[zwe](./.././zwe) > [components](././zwe-components) > [search](./zwe-components-search) + + zwe components search [parameter [parameter]...] + +## Description + +Search for a Zowe component within a Zowe package registry. + +This command requires you have a registry manager set up for zowe's use already, such as npm or conda. + + +## Examples + +``` + zwe components search --component-name angular-sample + + zwe components search --component-id org.zowe.zlux.sample.angular + + zwe components search --component-id org.zowe.zlux.sample.angular --registry https://myregistry/url + + zwe components search --component-id org.zowe.zlux.sample.angular --registry https://myregistry/url --handler npm + + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--component-name,--component|-o|string|no|Component name to search for. +--component-id,--id|-d|string|no|Component id to search for. +--registry|-r|string|no|Specifies the registry to search within instead of the default. The registry must be compatible with the manager used. +--handler||string|no|Specifies the registry handler name used with the package registry, instead of the default. The handler must be compatible with the registry used. + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0310E|310|Component name (-name|-n) or id (-id,-d) required but not specified. +ZWEL0311E|311|Handler (-handler,-h or zowe.extensionRegistry.defaultHandler) required but not specified. + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-uninstall.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-uninstall.md new file mode 100644 index 0000000000..d4e90c89cc --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-uninstall.md @@ -0,0 +1,92 @@ +# zwe components uninstall + +[zwe](./.././zwe) > [components](././zwe-components) > [uninstall](./zwe-components-uninstall) + + zwe components uninstall [parameter [parameter]...] + +## Description + +Uninstall a Zowe component, given its name. + + +## Examples + +``` +zwe components uninstall -c /path/to/zowe.yaml -o /path/to/component/package + +zwe components uninstall -c /path/to/zowe.yaml -o package-name + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--component-name,--component|-o|string|yes|The name of an installed component. +--registry|-r|string|no|Specifies the registry to search within instead of the default. The registry must be compatible with the manager used. +--handler||string|no|Specifies the registry handler name used with the package registry, instead of the default. The handler must be compatible with the registry used. +--dry-run|-d|boolean|no|Whether or not to perform the upgrade versus just checking if an upgrade is available + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0306W|306|Component %s cannot be uninstalled, because it is not currently installed. +ZWEL0307E|307|Component %s cannot be uninstalled, because it is a core component. If you do not want to use it, disable it instead. +ZWEL0308W|308|Component directory %s could not be removed, rc=%s. +ZWEL0309W|309|Skipping removal of component %s because it is a core component. +ZWEL0312W|312|Component %s marked for removal but is not installed. +ZWEL????E|???|Command requires zowe.useConfigmgr=true to use. + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-upgrade.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-upgrade.md new file mode 100644 index 0000000000..0439ba806d --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components-upgrade.md @@ -0,0 +1,92 @@ +# zwe components upgrade + +[zwe](./.././zwe) > [components](././zwe-components) > [upgrade](./zwe-components-upgrade) + + zwe components upgrade [parameter [parameter]...] + +## Description + +Upgrade a Zowe component from a Zowe package registry when given a component name or "all" to upgrade all components. +The upgrade will only be performed if a Zowe package registry is configured. + + +## Examples + +``` +zwe components install -c /path/to/zowe.yaml -o /path/to/component/package + +zwe components install extract -c /path/to/zowe.yaml -o /path/to/component/package + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--component-file,--component|-o|string|yes|Either a path or component name. The path must be to a component package or directory. If a name is specified instead, install checks the zowe package registry. +--registry|-r|string|no|Specifies the registry to search within instead of the default. The registry must be compatible with the manager used. +--handler||string|no|Specifies the registry handler name used with the package registry, instead of the default. The handler must be compatible with the registry used. +--dry-run|-d|boolean|no|Whether or not to perform the upgrade versus just checking if an upgrade is available + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0156E|156|Component name is not initialized after extract step. +ZWEL0180E|180|Zowe extension directory (zowe.extensionDirectory) is not defined in Zowe YAML configuration file. +ZWEL0304E|304|Handler install failure, cannot continue. +ZWEL0305E|305|Could not find one of the components' directories. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components.md new file mode 100644 index 0000000000..f851142179 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/components/zwe-components.md @@ -0,0 +1,82 @@ +# zwe components + +[zwe](.././zwe) > [components](./zwe-components) + + zwe components [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [disable](./zwe-components-disable.md) +* [enable](./zwe-components-enable.md) +* [install](./install/zwe-components-install.md) +* [search](./zwe-components-search.md) +* [uninstall](./zwe-components-uninstall.md) +* [upgrade](./zwe-components-upgrade.md) + +## Examples + +``` +zwe components install -c /path/to/zowe.yaml -o /path/to/component/package + +``` + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/config/zwe-config-get.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/config/zwe-config-get.md new file mode 100644 index 0000000000..bfaece746d --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/config/zwe-config-get.md @@ -0,0 +1,88 @@ +# zwe config get + +[zwe](./.././zwe) > [config](././zwe-config) > [get](./zwe-config-get) + + zwe config get [parameter [parameter]...] + +## Description + +Return value of a configuration defined in YAML configuration. +This command requires zowe.useConfigmgr=true or --configmgr to be used. + + +## Examples + +``` +zwe config get -p path-of-configuration -c /path/to/zowe.yaml +zwe config get -p .zowe.certificate -c /path/to/zowe.yaml +zwe config get -p .zowe.components[] -c /path/to/zowe.yaml +zwe config get -p .zowe.components.gateway -c /path/to/zowe.yaml +zwe config get -p .zowe.components.gateway.enabled -c /path/to/zowe.yaml +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--ha-instance|-i|string|no|Zowe high availability instance ID. +--path|-p|string|yes|Path of the configuration. For example, `components.gateway.port`. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0303E|303|Invalid config path syntax for %s. Get only supports single period delimiters between values. + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/config/zwe-config-validate.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/config/zwe-config-validate.md new file mode 100644 index 0000000000..d987212930 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/config/zwe-config-validate.md @@ -0,0 +1,86 @@ +# zwe config validate + +[zwe](./.././zwe) > [config](././zwe-config) > [validate](./zwe-config-validate) + + zwe config validate [parameter [parameter]...] + +## Description + +Runs schema validation upon given zowe yaml configuration files. +This command can be used to prove that the zowe configuration is good before starting zowe. +It requires that zowe.useConfigmgr=true or --configmgr are set. +This command can optionally validate enabled components or all components, but otherwise would only validate the zowe core configuration. + + +## Examples + +``` +zwe config validate -c /path/to/zowe.yaml +zwe config validate -c FILE(/customizations/zowe.yaml):FILE(/defaults/zowe.yaml) --all +zwe config validate -c 'FILE(/path/to/zowe.yaml):PARMLIB(ZOWE.PARMLIB(YAML))' + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--components||boolean|no|Turns on validation for enabled components. +--all||boolean|no|Turns on validation for all components, even disabled ones. + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/config/zwe-config.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/config/zwe-config.md new file mode 100644 index 0000000000..1a9803fdef --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/config/zwe-config.md @@ -0,0 +1,71 @@ +# zwe config + +[zwe](.././zwe) > [config](./zwe-config) + + zwe config [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [get](./zwe-config-get.md) +* [validate](./zwe-config-validate.md) + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-apfauth.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-apfauth.md new file mode 100644 index 0000000000..8fd082e854 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-apfauth.md @@ -0,0 +1,110 @@ +# zwe init apfauth + +[zwe](./.././zwe) > [init](././zwe-init) > [apfauth](./zwe-init-apfauth) + + zwe init apfauth [parameter [parameter]...] + +## Description + +This command will APF authorize load library for you. + +NOTE: You require proper permission to run APF authorize command. + +These Zowe YAML configurations showing with sample values are used: + +``` +zowe: + setup: + dataset: + prefix: IBMUSER.ZWE + authLoadlib: IBMUSER.ZWE.CUST.ZWESALL + authPluginLib: IBMUSER.ZWE.CUST.ZWESAPL +``` + +- `zowe.setup.dataset.prefix` shows where the `SZWEAUTH` data set is installed. +- `zowe.setup.dataset.authLoadlib` is the user custom APF LOADLIB. This field is + optional. If it's not defined, `SZWEAUTH` from `zowe.setup.dataset.prefix` data + set will be APF authorized. +- `zowe.setup.dataset.authPluginLib` is the user custom APF PLUGINLIB. + You can install Zowe ZIS plugins into this load library. + + +## Examples + +``` +zwe init apfauth --security-dry-run -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--security-dry-run||boolean|no|Whether to dry run security related setup. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. +--skip-security-setup||boolean|no|Whether should skip security related setup. +--security-dry-run||boolean|no|Whether to dry run security related setup. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. +--update-config||boolean|no|Whether to update YAML configuration file with initialization result. +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0157E|157|%s (%s) is not defined in Zowe YAML configuration file. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-certificate.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-certificate.md new file mode 100644 index 0000000000..8676c7ce6a --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-certificate.md @@ -0,0 +1,250 @@ +# zwe init certificate + +[zwe](./.././zwe) > [init](././zwe-init) > [certificate](./zwe-init-certificate) + + zwe init certificate [parameter [parameter]...] + +## Description + +This command will generate certificate used by Zowe services. + +If you specify `--update-config` with this command, these configurations could +be written back to your Zowe YAML configuration file: + +- `zowe.certificate` based on your `zowe.setup.certificate` configuration. + +These Zowe YAML configurations showing with sample values are used: + +``` +zowe: + setup: + dataset: + prefix: IBMUSER.ZWE + jcllib: IBMUSER.ZWE.CUST.JCLLIB + security: + product: RACF + groups: + admin: ZWEADMIN + users: + zowe: ZWESVUSR + certificate: + type: PKCS12 + dname: + caCommonName: + commonName: + orgUnit: + org: + locality: + state: + country: + validity: 3650 + pkcs12: + directory: /global/zowe/keystore + lock: true + name: localhost + password: password + caAlias: local_ca + caPassword: local_ca_password + import: + keystore: + password: + alias: + keyring: + owner: + name: ZoweKeyring + label: localhost + caLabel: localca + import: + dsName: + password: + connect: + user: + label: + zOSMF: + ca: + user: IZUSVR + san: + - zos.my-company.com + - internal-lpar1.zos.my-company.com + - internal-lpar2.zos.my-company.com + - internal-lpar3.zos.my-company.com + importCertificateAuthorities: + - + externalDomains: + - zos.my-company.com + verifyCertificates: STRICT +zOSMF: + host: zosmf.my-company.com + port: 443 +``` + +- `zowe.setup.certificate.type` is the type of certificate. Valid values are + "PKCS12" (USS keystore) or "JCEKS", "JCECCAKS", "JCERACFKS", "JCECCARACFKS", + and "JCEHYBRIDRACFKS (z/OS keyring). +- `zowe.setup.certificate.dname` is the distinguished name of the certificate. + You can define `caCommonName`, `commonName`, `orgUnit`, `org`, `locality`, + `state`, and / or `country`. These configurations are optional. +- `zowe.setup.certificate.validity` is the validity days of the certificate. + This is optional. +- `zowe.setup.certificate.san` is the `Subject Alternative Name`(s) of the + certificate if they are different from `zowe.externalDomains`. Please note, + for `JCEKS`, `JCECCAKS`, `JCERACFKS`, `JCECCARACFKS`, and `JCEHYBRIDRACFKS` + type, with limitation of RACDCERT command, this should contain exact one + hostname (domain) and one IP address. +- `zowe.setup.certificate.importCertificateAuthorities` is the list of + certificate authorities will be imported to Zowe PKCS12 keystore or + keyring. Please note, for keyring type, only maximum 2 CAs is supported. + If you are using `PKCS12` certificate, this should be USS files in PEM format. + If you are using `JCEKS`, `JCECCAKS`, `JCERACFKS`, `JCECCARACFKS`, or + `JCEHYBRIDRACFKS` certificate, this should be certificate labels + on the z/OS system. +- `zOSMF.host` and `zOSMF.port` is the z/OSMF service information. This is + required if you are using z/OSMF as authentication service. +- `zowe.verifyCertificates` indicates how Zowe should validate the certificate + of services registered under Zowe APIML. Valid values are "STRICT", + "NONSTRICT" or "DISABLED". If this is "STRICT", this command will try to + validate the z/OSMF service certificate if z/OSMF is defined. + +**For `PKCS12` certificate users,** + +- `zowe.setup.certificate.pkcs12.directory` is the directory where you plan to + store the PKCS12 keystore and truststore. This is required if + `zowe.setup.certificate.type` is `PKCS12`. +- `zowe.setup.certificate.pkcs12.lock` is a boolean configuration to tell if we + should lock the PKCS12 keystore directory only for Zowe runtime user and group. + Default value is true. +- `zowe.setup.security.groups.admin` and `zowe.setup.security.users.zowe` will + be the default owner of keystore directory. +- You can also define `name`, `password`, `caAlias` and `caPassword` under + `zowe.setup.certificate.pkcs12` to customized keystore and truststore. These + configurations are optional, but it is recommended to update them from + default values. +- Define `zowe.setup.certificate.pkcs12.import.keystore` if you already acquired + certificate from other CA, stored them in PKCS12 format, and want to import + into Zowe PKCS12 keystore. +- `zowe.setup.certificate.pkcs12.import.password` is the password for keystore + defined in `zowe.setup.certificate.pkcs12.import.keystore`. +- `zowe.setup.certificate.pkcs12.import.alias` is the original certificate alias + defined in `zowe.setup.certificate.pkcs12.import.keystore`. After imported, + the certificate will be saved as alias specified in + `zowe.setup.certificate.pkcs12.name`. + +**For keyring certificate users,** + +- `zowe.setup.certificate.keyring.owner` is the keyring owner. It's optional and + default value is `zowe.setup.security.users.zowe`. If it's also not defined, + the default value is `ZWESVUSR`. +- `zowe.setup.certificate.keyring.name` is the keyring name will be created + on z/OS. This is required if `zowe.setup.certificate.type` is one of `JCEKS`, + `JCECCAKS`, `JCERACFKS`, `JCECCARACFKS`, or `JCEHYBRIDRACFKS`. +- If you want to let Zowe to generate new certificate, + * You can also customize `label` and `caLabel` under + `zowe.setup.certificate.keyring` if you want to generate new certificate. + Default value of `label` is `localhost` and default value of `caLabel` is + `localca`. +- If you want to import certificate stored in MVS data set into Zowe keyring, + * `zowe.setup.certificate.keyring.connect.dsName` is required in this case. It + tells Zowe the data set where the certificate stored. + * `zowe.setup.certificate.keyring.connect.password` is the password when + importing the certificate. + * The certificate will be imported with label defined in + `zowe.setup.certificate.keyring.label`. +- If you want to connect existing certificate into Zowe keyring, + * `zowe.setup.certificate.keyring.connect.user` is required and tells Zowe + the owner of existing certificate. This field can have value of `SITE`. + * `zowe.setup.certificate.keyring.connect.label` is also required and tells + Zowe the label of existing certificate. +- If `zowe.verifyCertificates` is not `DISABLED`, and z/OSMF host (`zOSMF.host`) + is provided, Zowe will try to trust z/OSMF certificate. + * If you are using `RACF` security manager, Zowe will try to automatically + detect the z/OSMF CA based on certificate owner specified by + `zowe.setup.certificate.keyring.zOSMF.user`. Default value of this field is + `IZUSVR`. If the automatic detection failed, you will need to define + `zowe.setup.certificate.keyring.zOSMF.ca` indicates what is the label of + z/OSMF root certificate authority. + * If you are using `ACF2` or `TSS` (Top Secret) security manager, + `zowe.setup.certificate.keyring.zOSMF.ca` is required to indicates what is + the label of z/OSMF root certificate authority. + + +## Examples + +``` +zwe init certificate -v -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. +--update-config||boolean|no|Whether to update YAML configuration file with initialization result. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. +--skip-security-setup||boolean|no|Whether should skip security related setup. +--security-dry-run||boolean|no|Whether to dry run security related setup. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. +--update-config||boolean|no|Whether to update YAML configuration file with initialization result. +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0157E|157|%s (%s) is not defined in Zowe YAML configuration file. +ZWEL0164E|164|Value of %s (%s) defined in Zowe YAML configuration file is invalid. Valid values are %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-mvs.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-mvs.md new file mode 100644 index 0000000000..367383f0b5 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-mvs.md @@ -0,0 +1,125 @@ +# zwe init mvs + +[zwe](./.././zwe) > [init](././zwe-init) > [mvs](./zwe-init-mvs) + + zwe init mvs [parameter [parameter]...] + +## Description + +This command will prepare Zowe custom data sets. + +These Zowe YAML configurations showing with sample values are used: + +``` +zowe: + setup: + dataset: + prefix: IBMUSER.ZWE + parmlib: IBMUSER.ZWE.CUST.PARMLIB + jcllib: IBMUSER.ZWE.CUST.JCLLIB + authLoadlib: IBMUSER.ZWE.CUST.ZWESALL + authPluginLib: IBMUSER.ZWE.CUST.ZWESAPL +``` + +`zowe.setup.dataset.prefix` shows where the `SZWESAMP` and `SZWEAUTH` data sets are +installed. + +Below data sets will be initialized by this command: + +- `zowe.setup.dataset.parmlib` is the user custom parameter library. Zowe server + command may generate sample PARMLIB members and stores here. +- `zowe.setup.dataset.jcllib` is the custom JCL library. Zowe server command may + generate sample JCLs and put into this data set. +- `zowe.setup.dataset.authLoadlib` is the user custom APF LOADLIB. This field is + optional. If this is defined, members of `SZWEAUTH` will be copied over to + this data set. + This loadlib requires APF authorize. +- `zowe.setup.dataset.authPluginLib` is the user custom APF PLUGINLIB. + You can install Zowe ZIS plugins into this load library. + This loadlib requires APF authorize. + +NOTE: Existing members in custom data sets will not be overwritten by default. + You can pass `--allow-overwrite` parameters to force update. + + +## Examples + +``` +zwe init mvs -v -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. +--skip-security-setup||boolean|no|Whether should skip security related setup. +--security-dry-run||boolean|no|Whether to dry run security related setup. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. +--update-config||boolean|no|Whether to update YAML configuration file with initialization result. +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0157E|157|%s (%s) is not defined in Zowe YAML configuration file. +ZWEL0300W||%s already exists. This data set member will be overwritten during configuration. +ZWEL0301W||%s already exists and will not be overwritten. For upgrades, you must use --allow-overwrite. +ZWEL0158E|158|%s already exists. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-security.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-security.md new file mode 100644 index 0000000000..ed3909e7d4 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-security.md @@ -0,0 +1,145 @@ +# zwe init security + +[zwe](./.././zwe) > [init](././zwe-init) > [security](./zwe-init-security) + + zwe init security [parameter [parameter]...] + +## Description + +This command will run ZWESECUR jcl. + +NOTE: You require proper permission to run security configuration. + +These Zowe YAML configurations showing with sample values are used: + +``` +zowe: + setup: + dataset: + prefix: IBMUSER.ZWE + jcllib: IBMUSER.ZWE.CUST.JCLLIB + security: + product: RACF + groups: + admin: ZWEADMIN + stc: ZWEADMIN + sysProg: ZWEADMIN + users: + zowe: ZWESVUSR + zis: ZWESIUSR + stcs: + zowe: ZWESLSTC + zis: ZWESISTC + aux: ZWESASTC +``` + +- `zowe.setup.dataset.prefix` shows where the `SZWESAMP` data set is installed, +- `zowe.setup.dataset.jcllib` is the custom JCL library. Zowe will create customized + ZWESECUR JCL here before applying it. +- `zowe.setup.security.product` is security product. Can be `RACF`, `ACF2`, or + `TSS`. This configuration is optional. Default value is `RACF`. +- `zowe.setup.security.groups.admin` is the group for Zowe administrators. + This configuration is optional. Default value is `ZWEADMIN`. +- `zowe.setup.security.groups.stc` is the group for Zowe started tasks. + This configuration is optional. Default value is `ZWEADMIN`. +- `zowe.setup.security.groups.sysProg` is system programmer user ID/group. + This configuration is optional. Default value is `ZWEADMIN`. +- `zowe.setup.security.users.zowe` is the userid for Zowe started task. + This configuration is optional. Default value is `ZWESVUSR`. +- `zowe.setup.security.users.zis` is userid for ZIS started task. + This configuration is optional. Default value is `ZWESIUSR`. +- `zowe.setup.security.stcs.zowe` is Zowe started task name. + This configuration is optional. Default value is `ZWESLSTC`. +- `zowe.setup.security.stcs.zis` is ZIS started task name. + This configuration is optional. Default value is `ZWESISTC`. +- `zowe.setup.security.stcs.aux` is ZIS auxiliary started task name. + This configuration is optional. Default value is `ZWESASTC`. + + +## Examples + +``` +zwe init security -v -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--security-dry-run||boolean|no|Whether to dry run security related setup. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. +--skip-security-setup||boolean|no|Whether should skip security related setup. +--security-dry-run||boolean|no|Whether to dry run security related setup. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. +--update-config||boolean|no|Whether to update YAML configuration file with initialization result. +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0157E|157|%s (%s) is not defined in Zowe YAML configuration file. +ZWEL0159E|159|Failed to modify %s. +ZWEL0160E|160|Failed to write to %s. Please check if target data set is opened by others. +ZWEL0161E|161|Failed to run JCL %s. +ZWEL0161W||Failed to run JCL %s. +ZWEL0162E|162|Failed to find job %s result. +ZWEL0162W||Failed to find job %s result. +ZWEL0163E|163|Job %s ends with code %s. +ZWEL0163W||Job %s ends with code %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-stc.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-stc.md new file mode 100644 index 0000000000..bff1cb7289 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-stc.md @@ -0,0 +1,132 @@ +# zwe init stc + +[zwe](./.././zwe) > [init](././zwe-init) > [stc](./zwe-init-stc) + + zwe init stc [parameter [parameter]...] + +## Description + +This command will copy Zowe started tasks `ZWESLSTC`, `ZWESISTC`, `ZWESASTC` to +your target procedure library. + +NOTE: You require proper permission to write to target procedure library. + +These Zowe YAML configurations showing with sample values are used: + +``` +zowe: + setup: + dataset: + prefix: IBMUSER.ZWE + proclib: USER.PROCLIB + parmlib: IBMUSER.ZWE.CUST.PARMLIB + jcllib: IBMUSER.ZWE.CUST.JCLLIB + authLoadlib: IBMUSER.ZWE.CUST.ZWESALL + security: + stcs: + zowe: ZWESLSTC + zis: ZWESISTC + aux: ZWESASTC +``` + +- `zowe.setup.dataset.prefix` shows where the `SZWESAMP` data set is installed, +- `zowe.setup.dataset.proclib` shows what is the target procedure library. +- `zowe.setup.dataset.parmlib` is the user custom parameter library. Zowe server + command may generate sample PARMLIB members and stores here. +- `zowe.setup.dataset.jcllib` is the custom JCL library. Zowe will create temporary + started tasks here before putting into target procedure library. +- `zowe.setup.dataset.authLoadlib` is the user custom APF LOADLIB. This field is + optional. If this is not defined, `SZWEAUTH` from `zowe.setup.dataset.prefix` + data set will be used as STEPLIB in STCs. +- `zowe.setup.security.stcs.zowe` is Zowe started task name. + This configuration is optional. Default value is `ZWESLSTC`. +- `zowe.setup.security.stcs.zis` is ZIS started task name. + This configuration is optional. Default value is `ZWESISTC`. +- `zowe.setup.security.stcs.aux` is ZIS auxiliary started task name. + This configuration is optional. Default value is `ZWESASTC`. + + +## Examples + +``` +zwe init stc -v -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. +--skip-security-setup||boolean|no|Whether should skip security related setup. +--security-dry-run||boolean|no|Whether to dry run security related setup. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. +--update-config||boolean|no|Whether to update YAML configuration file with initialization result. +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0157E|157|%s (%s) is not defined in Zowe YAML configuration file. +ZWEL0300W||%s already exists. This data set member will be overwritten during configuration. +ZWEL0301W||%s already exists and will not be overwritten. For upgrades, you must use --allow-overwrite. +ZWEL0143E|143|Cannot find data set member %s. You may need to re-run `zwe install`. +ZWEL0158E|158|%s already exists. +ZWEL0159E|159|Failed to modify %s. +ZWEL0160E|160|Failed to write to %s. Please check if target data set is opened by others. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-vsam.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-vsam.md new file mode 100644 index 0000000000..962609cca5 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init-vsam.md @@ -0,0 +1,133 @@ +# zwe init vsam + +[zwe](./.././zwe) > [init](././zwe-init) > [vsam](./zwe-init-vsam) + + zwe init vsam [parameter [parameter]...] + +## Description + +This command will run ZWECSVSM jcl to create VSAM data set for Zowe APIML +Caching Service. + +These Zowe YAML configurations showing with sample values are used: + +``` +zowe: + setup: + dataset: + prefix: IBMUSER.ZWE + jcllib: IBMUSER.ZWE.CUST.JCLLIB + vsam: + mode: NONRLS + volume: VOL123 + storageClass: +components: + caching-service: + storage: + mode: VSAM + vsam: + name: IBMUSER.ZWE.CUST.CACHE2 +``` + +- `zowe.setup.dataset.prefix` shows where the `SZWESAMP` data set is installed, +- `zowe.setup.dataset.jcllib` is the custom JCL library. Zowe will create customized + ZWESECUR JCL here before applying it. +- `zowe.setup.vsam.mode` indicates whether the VSAM will utilize Record Level + Sharing (RLS) services or not. Valid value is `RLS` or `NONRLS`. +- `zowe.setup.vsam.volume` indicates the name of volume. + This field is required if VSAM mode is `NONRLS`. +- `zowe.setup.vsam.storageClass` indicates the name of RLS storage class. + This field is required if VSAM mode is `RLS`. +- `components.caching-service.storage.mode` indicates what storage Zowe Caching + Service will use. Only if this value is `VSAM`, this command will try to + create VSAM data set. +- `components.caching-service.storage.vsam.name` defines the VSAM data set name. + + +## Examples + +``` +zwe init vsam -v -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. +--skip-security-setup||boolean|no|Whether should skip security related setup. +--security-dry-run||boolean|no|Whether to dry run security related setup. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. +--update-config||boolean|no|Whether to update YAML configuration file with initialization result. +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0157E|157|%s (%s) is not defined in Zowe YAML configuration file. +ZWEL0300W||%s already exists. This data set member will be overwritten during configuration. +ZWEL0301W||%s already exists and will not be overwritten. For upgrades, you must use --allow-overwrite. +ZWEL0158E|158|%s already exists. +ZWEL0159E|159|Failed to modify %s. +ZWEL0160E|160|Failed to write to %s. Please check if target data set is opened by others. +ZWEL0161E|161|Failed to run JCL %s. +ZWEL0162E|162|Failed to find job %s result. +ZWEL0163E|163|Job %s ends with code %s. +ZWEL0301W|0|Zowe Caching Service is not configured to use VSAM. Command skipped. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init.md new file mode 100644 index 0000000000..a254041f68 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/init/zwe-init.md @@ -0,0 +1,341 @@ +# zwe init + +[zwe](.././zwe) > [init](./zwe-init) + + zwe init [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [apfauth](./zwe-init-apfauth.md) +* [certificate](./zwe-init-certificate.md) +* [mvs](./zwe-init-mvs.md) +* [security](./zwe-init-security.md) +* [stc](./zwe-init-stc.md) +* [vsam](./zwe-init-vsam.md) + +## Description + +Init Zowe instance based on zowe.yaml configuration. + +You can find an example zowe.yaml in Zowe runtime directory folder. + +This command will run these sub-commands in sequence: + +- `zwe init mvs` +- `zwe init vsam` +- `zwe init apfauth` +- `zwe init security` +- `zwe init certificate` +- `zwe init stc` + +If you pass `--skip-security-setup` with this command, `zwe init apfauth` and +`zwe init security` steps will be skipped. + +If you pass `--update-config` with this command, these configurations could +be written back to your Zowe YAML configuration file: + +- `zowe.runtimeDirectory` based on where your `zwe` command is located, and if it + is not defined, +- `zowe.certificate` based on your `zowe.setup.certificate` configuration, +- `java.home` based on your current JAVA_HOME or automatic detection, +- `node.home` based on your current NODE_HOME or automatic detection. + +**IMPORTANT**, if you modify any of the values below, it's suggested to re-run +relevant `zwe init` command to make them taking effect. + +These Zowe YAML configurations showing with sample values are used: + +```yaml +zowe: + setup: + dataset: + prefix: IBMUSER.ZWE + parmlib: IBMUSER.ZWE.CUST.PARMLIB + jcllib: IBMUSER.ZWE.CUST.JCLLIB + authLoadlib: IBMUSER.ZWE.CUST.ZWESALL + authPluginLib: IBMUSER.ZWE.CUST.ZWESAPL + security: + product: RACF + groups: + admin: ZWEADMIN + stc: ZWEADMIN + sysProg: ZWEADMIN + users: + zowe: ZWESVUSR + zis: ZWESIUSR + stcs: + zowe: ZWESLSTC + zis: ZWESISTC + aux: ZWESASTC + certificate: + type: PKCS12 + dname: + caCommonName: + commonName: + orgUnit: + org: + locality: + state: + country: + validity: 3650 + pkcs12: + directory: /global/zowe/keystore + lock: true + name: localhost + password: password + caAlias: local_ca + caPassword: local_ca_password + import: + keystore: + password: + alias: + keyring: + owner: + name: ZoweKeyring + label: localhost + caLabel: localca + import: + dsName: + password: + connect: + user: + label: + zOSMF: + ca: + user: IZUSVR + san: + - zos.my-company.com + - internal-lpar1.zos.my-company.com + - internal-lpar2.zos.my-company.com + - internal-lpar3.zos.my-company.com + importCertificateAuthorities: + - + vsam: + mode: NONRLS + volume: VOL123 + storageClass: + externalDomains: + - zos.my-company.com + verifyCertificates: STRICT +zOSMF: + host: zosmf.my-company.com + port: 443 +components: + caching-service: + storage: + mode: VSAM + vsam: + name: IBMUSER.ZWE.CUST.CACHE2 +``` + +- `zowe.setup.dataset.prefix` shows where the `SZWEAUTH` data set is installed. +- `zowe.setup.dataset.parmlib` is the user custom parameter library. Zowe server + command may generate sample PARMLIB members and stores here. +- `zowe.setup.dataset.jcllib` is the custom JCL library. Zowe server command may + generate sample JCLs and put into this data set. +- `zowe.setup.dataset.authLoadlib` is the user custom APF LOADLIB. This field is + optional. If this is defined, members of `SZWEAUTH` will be copied over to + this data set and it will be APF authorized. If it's not defined, `SZWEAUTH` + from `zowe.setup.dataset.prefix` data set will be APF authorized. +- `zowe.setup.dataset.authPluginLib` is the user custom APF PLUGINLIB. + You can install Zowe ZIS plugins into this load library. + This loadlib requires APF authorize. + +- `zowe.setup.security.product` is security product. Can be `RACF`, `ACF2`, or + `TSS`. This configuration is optional. Default value is `RACF`. +- `zowe.setup.security.groups.admin` is the group for Zowe administrators. + This configuration is optional. Default value is `ZWEADMIN`. +- `zowe.setup.security.groups.stc` is the group for Zowe started tasks. + This configuration is optional. Default value is `ZWEADMIN`. +- `zowe.setup.security.groups.sysProg` is system programmer user ID/group. + This configuration is optional. Default value is `ZWEADMIN`. +- `zowe.setup.security.users.zowe` is the userid for Zowe started task. + This configuration is optional. Default value is `ZWESVUSR`. +- `zowe.setup.security.users.zis` is userid for ZIS started task. + This configuration is optional. Default value is `ZWESIUSR`. +- `zowe.setup.security.stcs.zowe` is Zowe started task name. + This configuration is optional. Default value is `ZWESLSTC`. +- `zowe.setup.security.stcs.zis` is ZIS started task name. + This configuration is optional. Default value is `ZWESISTC`. +- `zowe.setup.security.stcs.aux` is ZIS auxiliary started task name. + This configuration is optional. Default value is `ZWESASTC`. + +- `zowe.setup.certificate.type` is the type of certificate. Valid values are + "PKCS12" (USS keystore) or "JCEKS", "JCECCAKS", "JCERACFKS", "JCECCARACFKS", + and "JCEHYBRIDRACFKS (z/OS keyring). +- `zowe.setup.certificate.dname` is the distinguished name of the certificate. + You can define `caCommonName`, `commonName`, `orgUnit`, `org`, `locality`, + `state`, and / or `country`. These configurations are optional. +- `zowe.setup.certificate.validity` is the validity days of the certificate. + This is optional. +- `zowe.setup.certificate.san` is the `Subject Alternative Name`(s) of the + certificate if they are different from `zowe.externalDomains`. Please note, + for `JCEKS`, `JCECCAKS`, `JCERACFKS`, `JCECCARACFKS`, and `JCEHYBRIDRACFKS` + type, with limitation of RACDCERT command, this should contain exact one + hostname (domain) and one IP address. +- `zowe.setup.certificate.importCertificateAuthorities` is the list of + certificate authorities will be imported to Zowe PKCS12 keystore or + keyring. Please note, for keyring type, only maximum 2 CAs is supported. + If you are using `PKCS12` certificate, this should be USS files in PEM format. + If you are using `JCEKS`, `JCECCAKS`, `JCERACFKS`, `JCECCARACFKS`, or + `JCEHYBRIDRACFKS` certificate, this should be certificate labels + on the z/OS system. + +**For `PKCS12` certificate users,** + +- `zowe.setup.certificate.pkcs12.directory` is the directory where you plan to + store the PKCS12 keystore and truststore. This is required if + `zowe.setup.certificate.type` is `PKCS12`. +- `zowe.setup.certificate.pkcs12.lock` is a boolean configuration to tell if we + should lock the PKCS12 keystore directory only for Zowe runtime user and group. + Default value is true. +- You can also define `name`, `password`, `caAlias` and `caPassword` under + `zowe.setup.certificate.pkcs12` to customized keystore and truststore. These + configurations are optional, but it is recommended to update them from + default values. +- Define `zowe.setup.certificate.pkcs12.import.keystore` if you already acquired + certificate from other CA, stored them in PKCS12 format, and want to import + into Zowe PKCS12 keystore. +- `zowe.setup.certificate.pkcs12.import.password` is the password for keystore + defined in `zowe.setup.certificate.pkcs12.import.keystore`. +- `zowe.setup.certificate.pkcs12.import.alias` is the original certificate alias + defined in `zowe.setup.certificate.pkcs12.import.keystore`. After imported, + the certificate will be saved as alias specified in + `zowe.setup.certificate.pkcs12.name`. + +**For keyring certificate users,** + +- `zowe.setup.certificate.keyring.owner` is the keyring owner. It's optional and + default value is `zowe.setup.security.users.zowe`. If it's also not defined, + the default value is `ZWESVUSR`. +- `zowe.setup.certificate.keyring.name` is the keyring name will be created + on z/OS. This is required if `zowe.setup.certificate.type` is one of `JCEKS`, + `JCECCAKS`, `JCERACFKS`, `JCECCARACFKS`, or `JCEHYBRIDRACFKS`. +- If you want to let Zowe to generate new certificate, + * You can also customize `label` and `caLabel` under + `zowe.setup.certificate.keyring` if you want to generate new certificate. + Default value of `label` is `localhost` and default value of `caLabel` is + `localca`. +- If you want to import certificate stored in MVS data set into Zowe keyring, + * `zowe.setup.certificate.keyring.connect.dsName` is required in this case. It + tells Zowe the data set where the certificate stored. + * `zowe.setup.certificate.keyring.connect.password` is the password when + importing the certificate. + * The certificate will be imported with label defined in + `zowe.setup.certificate.keyring.label`. +- If you want to connect existing certificate into Zowe keyring, + * `zowe.setup.certificate.keyring.connect.user` is required and tells Zowe + the owner of existing certificate. This field can have value of `SITE`. + * `zowe.setup.certificate.keyring.connect.label` is also required and tells + Zowe the label of existing certificate. +- If `zowe.verifyCertificates` is not `DISABLED`, and z/OSMF host (`zOSMF.host`) + is provided, Zowe will try to trust z/OSMF certificate. + * If you are using `RACF` security manager, Zowe will try to automatically + detect the z/OSMF CA based on certificate owner specified by + `zowe.setup.certificate.keyring.zOSMF.user`. Default value of this field is + `IZUSVR`. If the automatic detection failed, you will need to define + `zowe.setup.certificate.keyring.zOSMF.ca` indicates what is the label of + z/OSMF root certificate authority. + * If you are using `ACF2` or `TSS` (Top Secret) security manager, + `zowe.setup.certificate.keyring.zOSMF.ca` is required to indicates what is + the label of z/OSMF root certificate authority. + +- `zowe.setup.vsam.mode` indicates whether the VSAM will utilize Record Level + Sharing (RLS) services or not. Valid value is `RLS` or `NONRLS`. +- `zowe.setup.vsam.volume` indicates the name of volume. + This field is required if VSAM mode is `NONRLS`. +- `zowe.setup.vsam.storageClass` indicates the name of RLS storage class. + This field is required if VSAM mode is `RLS`. + +- `zowe.verifyCertificates` indicates how Zowe should validate the certificate + of services registered under Zowe APIML. Valid values are "STRICT", + "NONSTRICT" or "DISABLED". If this is "STRICT", this command will try to + validate the z/OSMF service certificate if z/OSMF is defined. + +- `zOSMF.host` and `zOSMF.port` is the z/OSMF service information. This is + required if you are using z/OSMF as authentication service. + +- `components.caching-service.storage.mode` indicates what storage Zowe Caching + Service will use. Only if this value is `VSAM`, this command will try to + create VSAM data set. +- `components.caching-service.storage.vsam.name` defines the VSAM data set name. + + +## Examples + +``` +zwe init --allow-overwrite -c /path/to/zowe.yaml + +zwe init apfauth -v -c /path/to/zowe.yaml + +zwe init certificate -v -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. +--skip-security-setup||boolean|no|Whether should skip security related setup. +--security-dry-run||boolean|no|Whether to dry run security related setup. +--ignore-security-failures||boolean|no|Whether to ignore security setup job failures. +--update-config||boolean|no|Whether to update YAML configuration file with initialization result. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-get.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-get.md new file mode 100644 index 0000000000..7ac493f073 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-get.md @@ -0,0 +1,90 @@ +# zwe internal config get + +[zwe](./../.././zwe) > [internal](./.././zwe-internal) > [config](././zwe-internal-config) > [get](./zwe-internal-config-get) + + zwe internal config get [parameter [parameter]...] + +## Description + +Return value of a configuration defined in YAML configuration. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe internal config get -p path-of-configuration -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--ha-instance|-i|string|no|Zowe high availability instance ID. +--path|-p|string|yes|Path of the configuration. For example, `components.gateway.port`. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0303E|303|Invalid config path syntax for %s. Get only supports single period delimiters between values. + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-set.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-set.md new file mode 100644 index 0000000000..64251457a3 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-set.md @@ -0,0 +1,89 @@ +# zwe internal config set + +[zwe](./../.././zwe) > [internal](./.././zwe-internal) > [config](././zwe-internal-config) > [set](./zwe-internal-config-set) + + zwe internal config set [parameter [parameter]...] + +## Description + +Set value of a configuration and write back to the YAML configuration. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe internal config set -p path-of-configuration -e new-value-of-configuration -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--ha-instance|-i|string|no|Zowe high availability instance ID. +--path|-p|string|yes|Path of the configuration. For example, `components.gateway.port`. +--value|-e|string|no|New value of the configuration. +--string||boolean|no|When specified, the value is treated as a string even if it looks like a number or boolean + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config.md new file mode 100644 index 0000000000..5757653aa2 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config.md @@ -0,0 +1,86 @@ +# zwe internal config + +[zwe](../.././zwe) > [internal](.././zwe-internal) > [config](./zwe-internal-config) + + zwe internal config [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [get](./zwe-internal-config-get.md) +* [set](./zwe-internal-config-set.md) + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe internal config get -p path-of-configuration -c /path/to/zowe.yaml + +zwe internal config set -p path-of-configuration -e new-value-of-configuration -c /path/to/zowe.yaml + +``` + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-cleanup.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-cleanup.md new file mode 100644 index 0000000000..0321b162ff --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-cleanup.md @@ -0,0 +1,79 @@ +# zwe internal container cleanup + +[zwe](./../.././zwe) > [internal](./.././zwe-internal) > [container](././zwe-internal-container) > [cleanup](./zwe-internal-container-cleanup) + + zwe internal container cleanup [parameter [parameter]...] + +## Description + +Clean up Kubernetes runtime. + +Currently this command will remove all outdated static definitions. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-init.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-init.md new file mode 100644 index 0000000000..ae11cfe39c --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-init.md @@ -0,0 +1,77 @@ +# zwe internal container init + +[zwe](./../.././zwe) > [internal](./.././zwe-internal) > [container](././zwe-internal-container) > [init](./zwe-internal-container-init) + + zwe internal container init [parameter [parameter]...] + +## Description + +Initialize special runtime environment required by Zowe containerization. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-prestop.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-prestop.md new file mode 100644 index 0000000000..4904f70d3b --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-prestop.md @@ -0,0 +1,80 @@ +# zwe internal container prestop + +[zwe](./../.././zwe) > [internal](./.././zwe-internal) > [container](././zwe-internal-container) > [prestop](./zwe-internal-container-prestop) + + zwe internal container prestop [parameter [parameter]...] + +## Description + +Actions will be executed before a service is stopped. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--ha-instance|-i|string|no|Zowe high availability instance ID. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container.md new file mode 100644 index 0000000000..29d56da4fa --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container.md @@ -0,0 +1,85 @@ +# zwe internal container + +[zwe](../.././zwe) > [internal](.././zwe-internal) > [container](./zwe-internal-container) + + zwe internal container [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [cleanup](./zwe-internal-container-cleanup.md) +* [init](./zwe-internal-container-init.md) +* [prestop](./zwe-internal-container-prestop.md) + +## Description + +Internal commands to help manager workloads in Zowe containers. + +NOTE: these internal commands are only used by Zowe Containerization use scenario. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-component.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-component.md new file mode 100644 index 0000000000..0c42441af3 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-component.md @@ -0,0 +1,84 @@ +# zwe internal start component + +[zwe](./../.././zwe) > [internal](./.././zwe-internal) > [start](././zwe-internal-start) > [component](./zwe-internal-start-component) + + zwe internal start component [parameter [parameter]...] + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe internal start component -o component-name -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--component|-o|string|yes|Component to start. +--run-in-background||boolean|no|Whether to start this component in background. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--ha-instance|-i|string|no|Zowe high availability instance ID. +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-prepare.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-prepare.md new file mode 100644 index 0000000000..79fb314808 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-prepare.md @@ -0,0 +1,84 @@ +# zwe internal start prepare + +[zwe](./../.././zwe) > [internal](./.././zwe-internal) > [start](././zwe-internal-start) > [prepare](./zwe-internal-start-prepare) + + zwe internal start prepare [parameter [parameter]...] + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe internal start prepare -c /path/to/zowe.yaml + +``` + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--ha-instance|-i|string|no|Zowe high availability instance ID. +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0141E|141|User %s does not have write permission on %s. +ZWEL0302W||You are running the Zowe process under user id IZUSVR. This is not recommended and may impact your z/OS MF server negatively. +ZWEL0317E||Component %s commands.configure ended with rc=%s. + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start.md new file mode 100644 index 0000000000..3b5af45437 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start.md @@ -0,0 +1,89 @@ +# zwe internal start + +[zwe](../.././zwe) > [internal](.././zwe-internal) > [start](./zwe-internal-start) + + zwe internal start [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [component](./zwe-internal-start-component.md) +* [prepare](./zwe-internal-start-prepare.md) + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe internal start prepare -c /path/to/zowe.yaml + +zwe internal start component -o component-name -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--ha-instance|-i|string|no|Zowe high availability instance ID. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/zwe-internal-get-launch-components.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/zwe-internal-get-launch-components.md new file mode 100644 index 0000000000..d3eba16331 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/zwe-internal-get-launch-components.md @@ -0,0 +1,89 @@ +# zwe internal get-launch-components + +[zwe](./.././zwe) > [internal](././zwe-internal) > [get-launch-components](./zwe-internal-get-launch-components) + + zwe internal get-launch-components [parameter [parameter]...] + +## Description + +Return component list should be started in specified HA instance. + +NOTE: This command only returns a list of enabled components with start command. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe internal get-launch-components -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--ha-instance|-i|string|no|Zowe high availability instance ID. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/zwe-internal.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/zwe-internal.md new file mode 100644 index 0000000000..764fd3f56c --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/internal/zwe-internal.md @@ -0,0 +1,89 @@ +# zwe internal + +[zwe](.././zwe) > [internal](./zwe-internal) + + zwe internal [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [config](./config/zwe-internal-config.md) +* [container](./container/zwe-internal-container.md) +* [get-launch-components](./zwe-internal-get-launch-components.md) +* [start](./start/zwe-internal-start.md) + +## Description + +Commands will be executed internally by other Zowe commands. + + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe internal start -c /path/to/zowe.yaml + +zwe internal config set -p path-of-configuration -e new-value-of-configuration -c /path/to/zowe.yaml + +``` + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for-kubernetes.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for-kubernetes.md new file mode 100644 index 0000000000..edcecd35cf --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for-kubernetes.md @@ -0,0 +1,129 @@ +# zwe migrate for kubernetes + +[zwe](./../.././zwe) > [migrate](./.././zwe-migrate) > [for](././zwe-migrate-for) > [kubernetes](./zwe-migrate-for-kubernetes) + + zwe migrate for kubernetes [parameter [parameter]...] + +## Description + +Migrate your YAML configuration on z/OS for Kubernetes. + +This script will create `zowe-config` `ConfigMap` and `zowe-certificates-secret` `Secret` +for Kubernetes deployment. + +To manually create `zowe-config` `ConfigMap`, the `data` section should contain +a key `zowe.yaml` with string value of your `zowe.yaml` used on z/OS. + +To manually create `zowe-certificates-secret` `Secret`, you need 2 entries under +`data` section: + +- `keystore.p12`: which is base64 encoded PKCS#12 keystore, +- `truststore.p12`: which is base64 encoded PKCS#12 truststore. + +And 3 entries under `stringData` section: + +- `keystore.key`: is the PEM format of certificate private key, +- `keystore.cer`: is the PEM format of the certificate, +- `ca.cer`: is the PEM format of the certificate authority. + +In order to make certificates working in Kubernetes, the certificate you are using should +have these domains defined in certificate Subject Alt Name (SAN): + +- your external domains to access Zowe APIML Gateway Service running in Kubernetes cluster, +- `*.[k8s-namespace].svc.[k8s-cluster-name]` +- `*.discovery-service.[k8s-namespace].svc.[k8s-cluster-name]` +- `*.gateway-service.[k8s-namespace].svc.[k8s-cluster-name]` +- `*.[k8s-namespace].pod.[k8s-cluster-name]` + +`[k8s-namespace]` is the Kubernetes Namespace you installed Zowe into. And +`[k8s-cluster-name]` is the Kubernetes cluster name, which usually should be +`cluster.local`. + +Without the additional domains in SAN, you may see warnings/errors related to certificate +validation. + +If you cannot add those domains into certificate Subject Alt Name (SAN), you can change +`zowe.verifyCertificates` to `NONSTRICT` mode. Zowe components will not validate domain +names but will continue to validate certificate chain, validity and whether it's trusted +in Zowe truststore. + +**IMPORTANT**: It's not recommended to disable `zowe.verifyCertificates`. + +**NOTES**: With below conditions, this migration script will re-generate a new +set of certificate for you with proper domain names listed above. + +- you use `zwe init` command to initialize Zowe, +- use `PKCS#12` format keystore by defining `zowe.setup.certificate.type: PKCS12` +- did not define `zowe.setup.certificate.pkcs12.import.keystore` and let `zwe` command + to generate PKCS12 keystore for you +- enabled `STRICT` mode `zowe.verifyCertificates`. + + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--domains|-d|string|no|Domain list of certificate Subject Alternative Name (SAN). +--external-port||string|no|Port number to access APIML Gateway running in Kubernetes. +--k8s-namespace||string|no|Kubernetes namespace. +--k8s-cluster-name||string|no|Kubernetes cluster name. +--alias|-a|string|no|Certificate alias name. +--password|-p|string|no|Password of the certificate keystore. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for.md new file mode 100644 index 0000000000..964737fbef --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for.md @@ -0,0 +1,70 @@ +# zwe migrate for + +[zwe](../.././zwe) > [migrate](.././zwe-migrate) > [for](./zwe-migrate-for) + + zwe migrate for [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [kubernetes](./zwe-migrate-for-kubernetes.md) + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/migrate/zwe-migrate.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/migrate/zwe-migrate.md new file mode 100644 index 0000000000..abb17e6b09 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/migrate/zwe-migrate.md @@ -0,0 +1,70 @@ +# zwe migrate + +[zwe](.././zwe) > [migrate](./zwe-migrate) + + zwe migrate [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [for](./for/zwe-migrate-for.md) + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-deep.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-deep.md new file mode 100644 index 0000000000..0ba5a1ed21 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-deep.md @@ -0,0 +1,94 @@ +# zwe sample sub deep + +[zwe](./../.././zwe) > [sample](./.././zwe-sample) > [sub](././zwe-sample-sub) > [deep](./zwe-sample-sub-deep) + + zwe sample sub deep [parameter [parameter]...] + +## Description + +Sample of deep embedded sub-command. + +Also inherit parameters from upper level. + +NOTE: This command is to demonstrate how `zwe` command works. There are no real + meaningful functionalities defined in this command and sub-commands. + + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe sample sub deep -d required-parameter + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--another-parameter|-p|boolean|no|Every command level can have their own parameters. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--target-dir,--target|-d|string|yes|This parameter is required. +--auto-encoding|-e|string|no|This parameter has default value.\nThis help message has multiple lines.\n - another line +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-second.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-second.md new file mode 100644 index 0000000000..bc1251f7bc --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-second.md @@ -0,0 +1,89 @@ +# zwe sample sub second + +[zwe](./../.././zwe) > [sample](./.././zwe-sample) > [sub](././zwe-sample-sub) > [second](./zwe-sample-sub-second) + + zwe sample sub second [parameter [parameter]...] + +## Description + +Sample of second sub-command. + +NOTE: This command is to demonstrate how `zwe` command works. There are no real + meaningful functionalities defined in this command and sub-commands. + + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe sample sub second -d required-parameter + +``` + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--target-dir,--target|-d|string|yes|This parameter is required. +--auto-encoding|-e|string|no|This parameter has default value.\nThis help message has multiple lines.\n - another line +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub.md new file mode 100644 index 0000000000..3220310d4a --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub.md @@ -0,0 +1,96 @@ +# zwe sample sub + +[zwe](../.././zwe) > [sample](.././zwe-sample) > [sub](./zwe-sample-sub) + + zwe sample sub [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [deep](./zwe-sample-sub-deep.md) +* [second](./zwe-sample-sub-second.md) + +## Description + +A sample sub-command. + +NOTE: This command is to demonstrate how `zwe` command works. There are no real + meaningful functionalities defined in this command and sub-commands. + + + + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe sample sub second -d required-parameter + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--target-dir,--target|-d|string|yes|This parameter is required. +--auto-encoding|-e|string|no|This parameter has default value.\nThis help message has multiple lines.\n - another line + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/zwe-sample-test.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/zwe-sample-test.md new file mode 100644 index 0000000000..c97da07591 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/zwe-sample-test.md @@ -0,0 +1,87 @@ +# zwe sample test + +[zwe](./.././zwe) > [sample](././zwe-sample) > [test](./zwe-sample-test) + + zwe sample test [parameter [parameter]...] + +## Description + +A sample command. + +NOTE: This command is to demonstrate how `zwe` command works. There are no real + meaningful functionalities defined in this command and sub-commands. + + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +### Inherited from parent command + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe sample test + +``` + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/zwe-sample.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/zwe-sample.md new file mode 100644 index 0000000000..4b38f4b7a6 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/sample/zwe-sample.md @@ -0,0 +1,88 @@ +# zwe sample + +[zwe](.././zwe) > [sample](./zwe-sample) + + zwe sample [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [sub](./sub/zwe-sample-sub.md) +* [test](./zwe-sample-test.md) + +## Description + +This is a sample command. + +NOTE: This command is to demonstrate how `zwe` command works. There are no real + meaningful functionalities defined in this command and sub-commands. + + +WARNING: This command is for experimental purposes and could be changed in the future releases. + +## Examples + +``` +zwe sample sub second -d required-parameter + +``` + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/support/zwe-support-verify-fingerprints.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/support/zwe-support-verify-fingerprints.md new file mode 100644 index 0000000000..a663ffbf4c --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/support/zwe-support-verify-fingerprints.md @@ -0,0 +1,73 @@ +# zwe support verify-fingerprints + +[zwe](./.././zwe) > [support](././zwe-support) > [verify-fingerprints](./zwe-support-verify-fingerprints) + + zwe support verify-fingerprints [parameter [parameter]...] + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--target-dir||string|no|Target directory where the support package will be created.\nIf it is not specified, system temporary directory will be used. +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0113E|113|Failed to find Zowe version. Please validate your Zowe directory. +ZWEL0150E|150|Failed to find file %s. Zowe runtimeDirectory is invalid. +ZWEL0151E|151|Failed to create temporary file %s. Please check permission or volume free space. +ZWEL0181E|181|Failed to verify Zowe file fingerprints. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/support/zwe-support.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/support/zwe-support.md new file mode 100644 index 0000000000..a4bc1decf3 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/support/zwe-support.md @@ -0,0 +1,96 @@ +# zwe support + +[zwe](.././zwe) > [support](./zwe-support) + + zwe support [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [verify-fingerprints](./zwe-support-verify-fingerprints.md) + +## Description + +Collect and package Zowe runtime information for support purpose. + +This command will collect these information: + +- Environment + * z/OS version + * Java version + * Node.js version +- Zowe configurations + * Zowe manifest.json + * Zowe configuration file + * Zowe installation logs + * Zowe PKCS#12 keystore if used + * Zowe temporary configuration files under "`zowe.workspaceDirectory`/.env" + * Zowe APIML static registration files under "`zowe.workspaceDirectory`/api-mediation/api-defs" +- Zowe runtime + * Active running Zowe processes + * Zowe job log +- Zowe fingerprints and validation result + + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--target-dir||string|no|Target directory where the support package will be created.\nIf it is not specified, system temporary directory will be used. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-diagnose.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-diagnose.md new file mode 100644 index 0000000000..611229d47d --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-diagnose.md @@ -0,0 +1,84 @@ +# zwe diagnose + +[zwe](././zwe) > [diagnose](./zwe-diagnose) + + zwe diagnose [parameter [parameter]...] + +## Description + +Display the message corresponding to the error code. + + +## Examples + +``` +zwe diagnose -e ZWES0014I + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--error-code|-e|string|yes|Error Code. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0102E|102|Invalid parameter %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-install.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-install.md new file mode 100644 index 0000000000..960110073e --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-install.md @@ -0,0 +1,107 @@ +# zwe install + +[zwe](././zwe) > [install](./zwe-install) + + zwe install [parameter [parameter]...] + +## Description + +After you extract Zowe convenience build, you can run this command to install +MVS data sets. + +If you are using SMPE build, you can skip this command since MVS data sets are +already prepared during SMPE install. + +These Zowe YAML configurations showing with sample values are used: + +``` +zowe: + setup: + dataset: + prefix: IBMUSER.ZWE +``` + +Expected outputs: + +- Will create these data sets under `zowe.setup.dataset.prefix` definition: + * `SZWEAUTH` contains few Zowe load modules (++PROGRAM). + * `SZWESAMP` contains several sample configurations. + * `SZWEEXEC` contains few utilities used by Zowe. + + +## Examples + +``` +zwe install -v -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. +--dataset-prefix,--ds-prefix||string|no|Install Zowe to this dataset prefix. If you specify this value, `--config` is not required. + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0157E|157|%s (%s) is not defined in Zowe YAML configuration file. +ZWEL0300W||%s already exists. Members in this data set will be overwritten. +ZWEL0301W||%s already exists and will not be overwritten. For upgrades, you must use --allow-overwrite. +ZWEL0158E|158|%s already exists. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-start.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-start.md new file mode 100644 index 0000000000..1ee5a7f063 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-start.md @@ -0,0 +1,106 @@ +# zwe start + +[zwe](././zwe) > [start](./zwe-start) + + zwe start [parameter [parameter]...] + +## Description + +Start Zowe with main started task. + +These Zowe YAML configurations showing with sample values are used: + +``` +zowe: + setup: + security: + stcs: + zowe: ZWESLSTC + jobname: ZWE1SV +haInstances: + [ha-instance]: + sysname: ZLP1 +``` + +- `zowe.setup.security.stcs.zowe` is Zowe started task name. + This configuration is optional. Default value is `ZWESLSTC`. +- `zowe.job.name` is the optional customized job name to start Zowe. If it's + empty, the start command will not pass `JOBNAME=` option to `S` command. +- `haInstances.[ha-instance].sysname` is the SYSNAME of the target HA instance. + If you pass `--ha-instance` parameter, this is the SYSNAME the start command + will be routed to. + + +## Examples + +``` +zwe start -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--ha-instance|-i|string|no|Zowe high availability instance ID. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0165E|165|Failed to start job %s: %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-stop.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-stop.md new file mode 100644 index 0000000000..da080e7c03 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-stop.md @@ -0,0 +1,107 @@ +# zwe stop + +[zwe](././zwe) > [stop](./zwe-stop) + + zwe stop [parameter [parameter]...] + +## Description + +Stop Zowe main job. + +These Zowe YAML configurations showing with sample values are used: + +``` +zowe: + setup: + security: + stcs: + zowe: ZWESLSTC + jobname: ZWE1SV +haInstances: + [ha-instance]: + sysname: ZLP1 +``` + +- `zowe.setup.security.stcs.zowe` is Zowe started task name. + This configuration is optional. Default value is `ZWESLSTC`. +- `zowe.job.name` is the optional customized job name to start Zowe. If it's + empty, the stop command will try to use value of + `zowe.setup.security.stcs.zowe` as job name to stop. +- `haInstances.[ha-instance].sysname` is the SYSNAME of the target HA instance. + If you pass `--ha-instance` parameter, this is the SYSNAME the start command + will be routed to. + + +## Examples + +``` +zwe stop -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--ha-instance|-i|string|no|Zowe high availability instance ID. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0166E|166|Failed to stop job %s: %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-version.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-version.md new file mode 100644 index 0000000000..fa1d67130a --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe-version.md @@ -0,0 +1,81 @@ +# zwe version + +[zwe](././zwe) > [version](./zwe-version) + + zwe version [parameter [parameter]...] + +## Description + +Display Zowe version. + + +## Examples + +``` +zwe version + +``` + +## Parameters + + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0150E|150|Failed to find file %s. Zowe runtimeDirectory is invalid. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe.md new file mode 100644 index 0000000000..01aff48505 --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference/zwe/zwe.md @@ -0,0 +1,92 @@ +# zwe + +[zwe](./zwe) + + zwe [sub-command [sub-command]...] [parameter [parameter]...] + +## Sub-commands + +* [certificate](./certificate/zwe-certificate.md) +* [components](./components/zwe-components.md) +* [config](./config/zwe-config.md) +* [diagnose](./zwe-diagnose.md) +* [init](./init/zwe-init.md) +* [install](./zwe-install.md) +* [internal](./internal/zwe-internal.md) +* [migrate](./migrate/zwe-migrate.md) +* [sample](./sample/zwe-sample.md) +* [start](./zwe-start.md) +* [stop](./zwe-stop.md) +* [support](./support/zwe-support.md) +* [version](./zwe-version.md) + +## Description + +A command line utility helps you managing Zowe instance. + +You can issue --help or -h to find information for all commands it supports. + + +## Examples + +``` +zwe install -h + +zwe init --allow-overwrite --config /path/to/zowe.yaml + +zwe start -c /path/to/zowe.yaml + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference_overview.md b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference_overview.md new file mode 100644 index 0000000000..afc0d631eb --- /dev/null +++ b/versioned_docs/version-v2.15.x/appendix/zwe_server_command_reference_overview.md @@ -0,0 +1,40 @@ +# ZWE Server Command Reference + +`zwe` is the management utility for Zowe server components. + +It is a Unix command that is installed via a download of the Zowe server components. + +When installed, you can find it within the zowe runtime directory's "bin" subdirectory. + +This command can be accessed directly from that location, or you can save that location to your Unix PATH environment variable so that it's accessible at all times just by typing `zwe`. + +`zwe` has several useful features, and more are added often. + +## Using the `zwe` command + +With the `zwe` command you can: + +- Install/initialize a Zowe instance +- Install/upgrade Zowe extensions +- Validate the configuration against a schema +- Diagnose a message +- Collect support information + +## Accessing `zwe` help + +Every `zwe` subcommand, and the `zwe` command itself, has built-in help that is accessible by adding `--help` to the command. + +To access the help content: + +``` +zwe --help +``` + +The built-in help goes over the following topics: + +- What the current command does +- What subcommands exist +- What parameters exist +- Example uses of the current command + +This `zwe` command reference includes the same content as the built-in help. In the sections that follow, you can find all `zwe` help information. diff --git a/versioned_docs/version-v2.15.x/contribute/contributing.md b/versioned_docs/version-v2.15.x/contribute/contributing.md new file mode 100644 index 0000000000..1ced6a027f --- /dev/null +++ b/versioned_docs/version-v2.15.x/contribute/contributing.md @@ -0,0 +1,442 @@ +# Contributing to Zowe Documentation + +You are welcome to contribute to the Zowe™ documentation repository. Anyone can open an issue about documentation, or contribute a change with a pull request (PR) to the [zowe/docs-site GitHub repository](https://github.com/zowe/docs-site/). + +## Before You Get Started + +Before contributing a documentation change to the repository, you should be familiar with: + +* Git and GitHub: To learn about git and GitHub, refer to the [Github Guides](https://guides.github.com/). +* Slack: The Zowe Documentation team communicates using the Slack application. To learn about Slack, refer to the [Slack Help Center](https://slack.com/help). The Zowe team is part of the [Open Mainframe Project](https://openmainframeproject.slack.com) channel. +* Markdown Language: The Zowe documentation is written in Markdown language. To learn about Markdown, refer to [The Markdown Guide](https://www.markdownguide.org/). + +In addition to being familiar with the Zowe community and how we work together, you will need to sign the CNCF Contributor License Agreement. The Contributor License Agreement defines the terms under which you contribute to Zowe documentation. Contributions to Zowe documentation are reviewed before being committed to the repository. Committing changes to the Zowe repository requires additional access rights. See https://github.com/zowe/community/blob/master/COMMITTERS.md. Also see Participating in Zowe Documentation for more details about roles and permissions. + +## Getting started checklist + +If you are ready to get started contributing to the Zowe Documentation repository: + +* Verify that you are familiar with the concepts in [Before You Get Started](#before-you-get-started). +* Familiarize yourself with the [Zowe documentation repository](#the-zowe-documentation-repository). +* Verify that you can open a [pull request and review changes](#sending-a-github-pull-request). +* [Open an issue for Zowe documentation](#opening-an-issue-for-zowe-documentation) if you find a problem. +* Read the [documentation style guide](#documentation-style-guide). + +## The Zowe documentation repository + +The Zowe documentation is managed in a [GitHub repository](https://github.com/zowe/docs-site). + +* Review the site's overall organization and structure +* Review the help files related to your planned changes or addition + +## Sending a GitHub Pull Request + +You can provide suggested edits to any documentation page by using the **Edit this page** link on top of each page. After you make the changes, you submit updates in a pull request for the Zowe documentation team to review and merge. + +Follow these steps: + +1. Click **Edit this page** on the page that you want to update. +3. Make the changes to the file. +4. Scroll to the end of the page and enter a brief description about your change. +5. Optional: Enter an extended description. +6. Select **Propose file change**. +7. Select **Create pull request**. + +## Opening an issue for Zowe documentation + +You can request the documentation to be improved or clarified, report an error, or submit suggestions and ideas by opening an issue in GitHub for the Zowe documentation team to address. The team tracks the issues and works to address your feedback. + +Follow these steps: + +1. Click the **Open doc issue** link at the top of the page. +1. Enter the details of the issue. +1. Click **Submit new issue**. + +## Documentation style guide + +This section gives writing style guidelines for the Zowe documentation. + +### Headings and titles + +#### Use sentence-style capitalization for headings + +Capitalize only the initial letter of the first word in the text and other words that require capitalization, such as proper nouns. Examples of proper nouns include the names of specific people, places, companies, languages, protocols, and products. + +Example: Verifying that your system meets the software requirements. + +#### For tasks and procedures, use gerunds for headings + +Example: + +- Building an API response +- Setting the active build configuration + +#### For conceptual and reference information, use noun phrases for headings + +Example: + +- Query language +- Platform and application integration + +#### Use headline-style capitalization for only these items + +Titles of books, CDs, videos, and stand-alone information units. + +Example: + +- Installation and User's Guide +- Quick Start Guides or discrete sets of product documentation + +### Technical elements + +#### Variables + +Style: + +- Italic when used outside of code examples, + + Example: _myHost_ + +- If wrap using angle brackets `<>` within code examples, italic font is not supported. + + Example: + - put <pax-file-name>.pax + + - Where _pax-file-name_ is a variable that indicates the full name of the PAX file you download. For example, zoe-0.8.1.pax. + +#### Message text and prompts to the user + +Style: Put messages in quotation marks. + +Example: "The file does not exist." + +#### Code and code examples + +Style: Monospace + +Example: `java -version` + +#### Command names, and names of macros, programs, and utilities that you can type as commands + +Style: Monospace + +Example: Use the `BROWSE` command. + +#### Interface controls + +Categories: check boxes, containers, fields, folders, icons, items inside list boxes, labels (such as **Note:**), links, list boxes, menu choices, menu names, multicolumn lists, property sheets, push buttons, radio buttons, spin buttons, and Tabs + +Style: Bold + +Example: From the **Language** menu, click the language that you want to use. The default selection is **English**. + +#### Directory names + +Style: Monospace + +Example: Move the `install.exe` file into the `newuser` directory. + +#### File names, file extensions, and script names + +Style: Monospace + +Example: + +- Run the `install.exe` file. +- Extract all the data from the `.zip` file. + +#### Search or query terms + +Style: Monospace + +Example: In the Search field, enter `Zowe`. + +#### Citations that are not links + +Categories: Chapter titles and section titles, entries within a blog, references to industry standards, and topic titles in IBM Knowledge Center + +Style: Double quotation marks + +Example: +- See the "Measuring the true performance of a cloud" entry in the blog. +- For installation information, see "Installing the product". + +### Tone + +#### Use simple present tense rather than future or past tense, as much as possible + +Example: + +:heavy_check_mark: The API returns a promise. + +:x: The API will return a promise. + +#### Use simple past tense if past tense is needed + +Example: + +:heavy_check_mark: The limit was exceeded. + +:x: The limit has been exceeded. + +#### Use active voice as much as possible + +Example: + +:heavy_check_mark: In the Limits window, specify the minimum and maximum values. + +:x: The Limits window is used to specify the minimum and maximum values. + +Exceptions: Passive voice is acceptable when any of these conditions are true: + +- The system performs the action. +- It is more appropriate to focus on the receiver of the action. +- You want to avoid blaming the user for an error, such as in an error message. +- The information is clearer in passive voice. + + Example: + + :heavy_check_mark: The file was deleted. + + :x: You deleted the file. + +#### Using second person such as "you" instead of first person such as "we" and "our" + +In most cases, use second person ("you") to speak directly to the reader. + +#### End sentences with prepositions selectively + +Use a preposition at the end of a sentence to avoid an awkward or stilted construction. + +Example: + +:heavy_check_mark: Click the item that you want to search for. + +:x: Click the item for which you want to search. + +#### Avoid anthropomorphism + +Focus technical information on users and their actions, not on a product and its actions. + +Example: + +:heavy_check_mark: User focus: On the Replicator page, you can synchronize your local database with replica databases. + +:x: Product focus: The Replicator page lets you synchronize your local database with replica databases. + +#### Avoid complex sentences that overuse punctuation such as commas and semicolons. + +### Release notes + +Release notes should be written in a consistent style that is easy to read and provides relevant information to users. + +To help ensure these best practices are followed, see [CHANGELOG and release notes formatting](https://github.com/zowe/docs-site/blob/master/release-handbook/release_notes_guide.md#changelog-and-release-notes-formatting) and [Writing style for release notes entries](https://github.com/zowe/docs-site/blob/master/release-handbook/release_notes_guide.md#writing-style-for-release-notes-entries). + +### Word usage and punctuation + +#### Note headings such as Note, Important, and Tip should be formatted using the lower case and bold format + +Examples: +- **Note:** +- **Important!** +- **Tip:** + +#### Use of "following" + +For whatever list or steps we are introducing, the word "following" should precede a noun. + +Examples: +- Before a procedure, use "Follow these steps:" +- The `` supports the following use cases: +- Before you install Zowe, review the following prerequisite installation tasks: + +Avoid ending the sentence with "following". + +Examples: + +:heavy_check_mark: Complete the following tasks. + +:x: Complete the following. + +#### Use a consistent style for referring to version numbers + +When talking about a specific version, capitalize the first letter of Version. + +Examples: + +:heavy_check_mark: Java Version 8.1 or Java V8.1 + +:x: Java version 8.1, Java 8.1, or Java v8.1 + + +When just talking about version, use "version" in lower case. + +Example: Use the latest version of Java. + +#### Avoid "may" + +Use "can" to indicate ability, or use "might" to indicate possibility. + +Examples: + +- Indicating ability: + + :heavy_check_mark: You can use the command line interface to update your application." + + :x: "You may use the command line interface to update your application." + +- Indicating possibility: + + :heavy_check_mark: "You might need more advanced features when you are integrating with another application. " + + :x: "You may need more advanced features when you are integrating with another application." + +#### Use "issue" when you want to say "run"/"enter" a command + +Example: At a command prompt, issue the following command: + +#### Use of slashes + +Avoid spaces when using a slash in between words. + +Examples: + +- Indicating or (on/off), and or (document/file), per (millions of instructions/second): + + :heavy_check_mark: Save the document/file in your desktop folder. + + :x: Save the document / file in your desktop folder. + +#### Punctuation in lists + +Use punctuation (periods, commas) in bulleted and numbered lists when appropriate. Do not use conjunctions (and, or) to separate list items. + +##### Use periods for list items when the items are complete sentences, or the introductory text is a sentence fragment and each item completes the sentence + +|Examples:| +|:---| + +:heavy_check_mark: You can obtain IBM SDK for Node.js - z/OS for free in one of the following ways: + +- Order the SMP/E edition through your IBM representative if that is your standard way to order IBM software. +- Order the SMP/E edition through IBM Shopz with optional paid support available. +- Download PAX file format at ibm.com/products/sdk-nodejs-compiler-zos. IBM defect Support is not available for this format. + +:x: Through customization, you can change attributes such as: + +- Enabling or disabling components so you only run what you need +- Changing the network ports Zowe runs on to suit your environment +- Customizing the behavior of a component, such as turning on optional features or logging +
    + +##### Use periods for list items when the items are complete sentences, or the introductory text is a sentence fragment and each item completes the sentence + +|Examples:| +|:---| + +:heavy_check_mark: You can obtain IBM SDK for Node.js - z/OS for free in one of the following ways: + +- Order the SMP/E edition through your IBM representative if that is your standard way to order IBM software. +- Order the SMP/E edition through IBM Shopz with optional paid support available. +- Download PAX file format at ibm.com/products/sdk-nodejs-compiler-zos. IBM defect Support is not available for this format. + +:x: Through customization, you can change attributes such as: + +- Enabling or disabling components so you only run what you need +- Changing the network ports Zowe runs on to suit your environment +- Customizing the behavior of a component, such as turning on optional features or logging + +##### Do not use punctuation or conjunctions (and, or) in bullet lists when the list items are not complete sentences, when the bullet item has three or fewer words, or when the bullet items are UI labels, headings, strings, or similar + +|Examples:| +|:---| + +:heavy_check_mark: The z/OSMF configuration process occurs in three stages, and in the following order: + +- Security setup +- Configuration +- Server initialization + +:x: The Zowe runtime, which consists of a number of components including: + +- Zowe Application Framework. +- Zowe API Mediation Layer. +- Z Secure Services (ZSS). + +##### Do not use conjuctions (and, or) in bullet lists + +|Examples:| +|:---| + +:heavy_check_mark: Integrated development environments: +- VS Code 1.53.2+ +- Eclipse Che +- Red Hat CodeReady Workspaces +- Theia 1.18+ + +:x: Before continuing with the installation, you should be familiar with the following topics: + +- Zowe's hardware and software requirements, and +- The `zwe` utility used for installing, configuring, and managing Zowe, and +- The configuration file used for Zowe, `zowe.yaml`. + +#### Punctuation in numbered lists + +### Abbreviations + +#### Do not use an abbreviation as a noun unless the sentence makes sense when you substitute the spelled-out form of the term + +Examples: + +:heavy_check_mark: The tutorials are available as PDF files. + +:x: The tutorials are available as PDFs. [portable document formats] + +#### Do not use abbreviations as verbs + +Examples: + +:heavy_check_mark: You can use the FTP command to send the files to the server. + +:x: You can FTP the files to the server. + +#### Do not use Latin abbreviations + +Use their English equivalents instead. Latin abbreviations are sometimes misunderstood. + +Latin | English equivalent +---|--- +e.g. | for example +etc. | and so on.
    When you list a clear sequence of elements such as "1, 2, 3, and so on" and "Monday, Tuesday, Wednesday, and so on." Otherwise, rewrite the sentence to replace "etc." with something more descriptive such as "and other output." +i.e. | that is + +#### Spell out the full name and its abbreviation when the word appears for the first time. Use abbreviations in the texts that follow + +Example: Mainframe Virtual Desktop (MVD) + +### Structure and format + +Add "More information" to link to useful resources or related topics at the end of topics where necessary. + +### Word usage + +The following table alphabetically lists the common used words and their usage guidelines. + +Do | Don't +---|--- +application | app +Capitalize "Server" when it's part of the product name | +file name | filename (unless it's a property written as one word) +Java | java +keyboard shortcut | hotkey +IBM z/OS Management Facility (z/OSMF)
    z/OSMF | zosmf (unless used in syntax) +ID| id +PAX| pax +personal computer
    PC
    server| machine +later | higher
    Do not use to describe versions of software or fix packs. +macOS| MacOS +Node.js | node.js
    Nodejs +plug-in| plugin +REXX | Rexx +UNIX System Services
    z/OS UNIX System Services | USS +zLUX | ZLUX
    zLux diff --git a/versioned_docs/version-v2.15.x/contribute/guidelines-code/categories.md b/versioned_docs/version-v2.15.x/contribute/guidelines-code/categories.md new file mode 100644 index 0000000000..30a534e380 --- /dev/null +++ b/versioned_docs/version-v2.15.x/contribute/guidelines-code/categories.md @@ -0,0 +1,28 @@ +# Code categories + +The Zowe™ codebase consists of a few key areas, with both unique and shared guidelines that define how to write new code. A few such areas are: + +- Server Core +- Server Security +- Microservices +- Zowe Desktop Applications +- Zowe Application Framework +- Zowe CLI and CLI Plug-ins +- Imperative CLI Framework + +## Programming languages + +For each area of the codebase, there are established and favored programming languages. Each repository in Github identifies the primary language used. Some of the basic skills needed to contribute to the project include: + +- **CLI** - Node.js, TypeScript +- **Desktop UI** - Node.js, JavaScript +- **APIs** - C, Assembler, Java, Spring +- **API Mediation Layer** - Java, Spring + +**Note:** JavaScript is not recommended and should be avoided in favor of Typescript to utilize typing. + +## Component-specific guidelines and tutorials + +This "Code Guidelines" section provides high-level best practices. Each component may have more specific contribution guidelines. Look for a CONTRIBUTING.md file in the component's GitHub repository for specific details. + +To learn more about how to develop Zowe applications and plug-ins or extending Zowe with APIs, see [Extending](../../extend/extend-apiml/onboard-overview.md). diff --git a/versioned_docs/version-v2.15.x/contribute/guidelines-code/code-and-patches.md b/versioned_docs/version-v2.15.x/contribute/guidelines-code/code-and-patches.md new file mode 100644 index 0000000000..b48863d31a --- /dev/null +++ b/versioned_docs/version-v2.15.x/contribute/guidelines-code/code-and-patches.md @@ -0,0 +1,11 @@ +# Pull requests guidelines + +The Zowe™ source code is stored in GitHub repositories under the [Zowe GitHub project](https://github.com/zowe). You contribute to the project through Pull Requests in GitHub. + +Each pull request is made against a repository that has assigned "maintainers". Pull requests cannot be merged without the approval of at least one maintainer, who will review Pull Requests to ensure that they meet the following criteria: + +- The code in the pull request must adhere to the [General Code Style Guidelines](general.md). +- The code must compile/transpile (where applicable) and pass a smoke-test such that the code is not known to break the current state of Zowe. +- The pull request must describe the purpose and implementation to the extent that the maintainer understands what is being accomplished. Some pull requests need less details than others. +- The pull request must state how to test this change, if applicable, such that the maintainer or a QA team can check correctness. The explanation may simply be to run included test code. +- If a pull request depends upon a pull request from the same/another repository that is pending, this must be stated such that maintainers know in which order to merge open pull requests. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/contribute/guidelines-code/documentation.md b/versioned_docs/version-v2.15.x/contribute/guidelines-code/documentation.md new file mode 100644 index 0000000000..28019fcae9 --- /dev/null +++ b/versioned_docs/version-v2.15.x/contribute/guidelines-code/documentation.md @@ -0,0 +1,62 @@ +# Documentation Guidelines + +Documentation of Zowe™ comes in various forms depending on the subject being detailed. In general, consider how you can help end users and contributors through external documentation, in-product help, error messages, etc... and open an issue in [zowe/docs-site](https://github.com/zowe/docs-site) if you need assistance. + +## Contributing to external documentation +The external documentation for the Zowe project, [Zowe Docs](https://docs.zowe.org/), is completely open-source. See [How to contribute](../contributing.md) for more information about contributing to the documentation. + +Consider: Release Notes, Install/Config/User Guides, Developer Tutorials, etc... + +## Component Categories + +Provide the following documentation depending on the component that you contribute to: + +### Server Core + +Principles of operation and end-user guides (configuration, troubleshooting) should be documented on Zowe Docs site. Code documentation follows language-specific formats. + +### Server Security + +Principles of operation and end-user guides (configuration, troubleshooting) should be documented on Zowe Docs site. Code documentation follows language-specific formats. + +### Microservices + +Microservices implement a web API, and therefore must be documented for understanding and testing. These web APIs must be accompanied with documentation in the Swagger (https://swagger.io/) format. These documents must be Swagger 2.0, `.yaml` extension files. Zowe Application Framework plug-ins that implement microservices should store these files within the `/doc/swagger` folder. + +### Zowe Desktop Applications + +Zowe Desktop applications should include documentation that explains how to use them, such that this documentation can integrate with a Zowe Desktop documentation reader. This is not strictly API documentation, but rather user guides that can display within the Desktop GUI. The preferred documentation format is a `.md` extension file that exists in the `/doc/guide` folder of an App. + +### Web Framework + +Principles of operation and end-user guides (configuration, troubleshooting) should be documented on Zowe Docs site. Code documentation follows language-specific formats. + +### CLI Plugins + +Provide a readme.md file for developers (overview, build, test) as well as end-user documentation for your plug-in on Zowe Docs site. + +For more information, see the CLI [documentation contribution guidelines](https://github.com/zowe/zowe-cli/blob/master/CONTRIBUTING.md#documentation-guidelines). + +### Core CLI Imperative CLI Framework + +Contributions that affect end users of the CLI should be documented on Zowe Docs site. + +Contributions that affect the underlying Imperative CLI Framework should be documented in [the GitHub Wiki](https://github.com/zowe/imperative/wiki) for future developers using the framework. + +Code documentation follows language-specific formats. + +## Programming Languages + +Each of the common languages in Zowe have code-documentation-generation tools, each with their own in-code comment style requirements to adhere to in order to generate readable API references. Objects and functions of interest should be commented in accordance to the language-specific tools to result in output that serves as the first point of documentation for APIs. + +### Typescript + +When writing TypeScript code, comment objects and functions in compliance with [JSDoc](https://jsdoc.app/). If you are writing in an area of the codebase that does not yet have a definition file for JSDoc, define a configuration file that can be used for future documentation of that code. + +### Java + +When writing TypeScript code, comment objects and functions in the Javadoc format. + +### C + +When writing C code, comment functions and structures in compliance with Doxygen. diff --git a/versioned_docs/version-v2.15.x/contribute/guidelines-code/general.md b/versioned_docs/version-v2.15.x/contribute/guidelines-code/general.md new file mode 100644 index 0000000000..e9066593fc --- /dev/null +++ b/versioned_docs/version-v2.15.x/contribute/guidelines-code/general.md @@ -0,0 +1,25 @@ +# General code style guidelines + +All code written in the languages described in [Code categories](categories.md) should adhere to the following guidelines to facilitate collaboration and understanding. + +**Note:** Uncertainties, unimplemented but known future action-items, and odd/specific constants should all be accompanied with a short comment to make others aware of the reasoning that went into the code. + +## Whitespaces + +Do not use tabs for whitespace. Use 2 spaces per tab instead. + +## Naming Conventions + +Self-documenting code reduces the need for extended code comments. It is encouraged to use names as long as necessary to describe what is occurring. + +### Functions and methods + +Methods should be named as verbs (for example, `get` or `set`), while Objects/Classes should be nouns. + +Objects and functions should be CamelCase. Methods on Objects should be dromedaryCase. + +### Variables + +Constants should be CAPITALIZED_AND_UNDERSCORED for clarity, while variables can remain dromedaryCase. + +Avoid non-descriptive variable names such as single letters (except for iteration in loops such as i or j) and variable names that have been arbitrarily shortened (Don't strip vowels; long variable names are OK). diff --git a/versioned_docs/version-v2.15.x/contribute/guidelines-ui/appicon.md b/versioned_docs/version-v2.15.x/contribute/guidelines-ui/appicon.md new file mode 100644 index 0000000000..a98aa5da64 --- /dev/null +++ b/versioned_docs/version-v2.15.x/contribute/guidelines-ui/appicon.md @@ -0,0 +1,54 @@ +# Application icon + +## General rules + +**Embrace simplicity.** Use a simple, unique shape or element that represents the essence of the application. Avoid excessive details and redundant shading. + +**Use the Zowe™ color palette.** Avoid using a monochromatic palette for your icons. Use the Zowe color palette to ensure that the icons have a consistent look. + +**Use unique shapes and design elements.** Avoid using single commonly used design elements, such as the gear, document, or folder. These elements can reduce recognizability. Do not use photos and screenshots. Keep icons simple and abstract. + +**Avoid labels and text.** Short, commonly used abbreviations are acceptable, if necessary. Remember that all icons have center-aligned labels beneath them. + +**Use brand identity.** If your Zowe application has a brand identity element such as a logo, you can use it. Remember to include the copyright symbol. + +## Shape, size, and composition + +**Use a flat design style.** Flat design focuses on open space, bright colors, and flat graphics or illustrations. Our minimalistic design approach puts the emphasis on usability. + +![icon sample](../../images/extender/icon_sample1.png) + +A flat icon has clean, crisp edges and a flat dimensional layout. + +**Use solid fill shapes.** Most Zowe App icons have solid fill shapes, which are more readable on dark backgrounds. + +Use the circle shape for the background application icons. +Set the outer corners to 100% opacity. Create an image file that is 87x87 pixels, and save the file in PNG format. + +**Maintain consistent visual proportions.** + +![icon sample2](../../images/extender/icon_sample2-1024x283.png) + +## Colors and shades + +### Verify the contrast + +Verify that the background color of the icon provides enough contrast against the desktop. + +![icon sample3](../../images/extender/icon_sample3.png) + +### Use the Zowe palette +To ensure that your app icons are clear and consistent, use the [Zowe color palette](colors.md#color-palette). +If you need to use well-established brand identity elements, you can use the colors that are associated with the brand. + +### Layer Shadows +Use smooth shadows to represent that some elements are on different layers and should be visually separated. Avoid using too many layers because they can overcomplicate the icon. + +![icon sample4](../../images/extender/icon_sample4.png) + +### Use the long shadow for consistency. +Although the long shadow effect does not have any semantic meaning, it adds focus to the main icon shape and identifies the central,most meaningful element. + +Use the gradient shadow settings shown in the following image, or use a flat non-gradient shadow with 20% opacity and #000000 color. + +![icon sample5](../../images/extender/icon_sample5.png) diff --git a/versioned_docs/version-v2.15.x/contribute/guidelines-ui/colors.md b/versioned_docs/version-v2.15.x/contribute/guidelines-ui/colors.md new file mode 100644 index 0000000000..b7593445bc --- /dev/null +++ b/versioned_docs/version-v2.15.x/contribute/guidelines-ui/colors.md @@ -0,0 +1,31 @@ +# Colors + +Color brings a design to life. Color is versatile; it's used to express emotion and tone, as well as place emphasis and create associations. Color should always be used in meaningful and intentional ways to create patterns and visual cues. + +## Color palette + +The Zowe™ color palette is designed and implemented in a theme-able manner. The universal color variables are determined by common roles and usage; it is not based singularly on a color value (i.e. unique hex code). The same color value might be assigned to multiple variables in a theme's palette when the values have distinctly different roles. + +A universal variable can also have multiple associated roles when the color is consistently used across those roles. This allows for uniform color application across themes, while giving each theme the freedom to express its own individuality at a more detailed level. + + ![color palette](../../images/extender/full_palette.png) + +### Light theme +![default light theme colors](../../images/extender/light_palette.png) + +### Dark theme +![default dark theme colors](../../images/extender/dark_palette.png) + +## Color contrast | WCAG AA standards + +- Type colors + + All type color combinations on Zowe must pass WCAG AA standards of 4.5:1 for normal text and 3:1 for large text. For larger text, if the font weight is light (300) or normal (400) the text should be no smaller than 24px. If the font weight is Semi-Bold (600) then the large text should be no smaller than 19px. + +- Body Text (4.5:1) + +- Large Text (3:1): at least 24px / 19px semi-bold + +WCAG guidelines: [https://www.w3.org/WAI/standards-guidelines/wcag/](https://www.w3.org/WAI/standards-guidelines/wcag/) + +Contrast Checker Tool: [https://webaim.org/resources/contrastchecker/](https://webaim.org/resources/contrastchecker/) diff --git a/versioned_docs/version-v2.15.x/contribute/guidelines-ui/grid.md b/versioned_docs/version-v2.15.x/contribute/guidelines-ui/grid.md new file mode 100644 index 0000000000..ca793090c5 --- /dev/null +++ b/versioned_docs/version-v2.15.x/contribute/guidelines-ui/grid.md @@ -0,0 +1,50 @@ +# Grid + +Grid systems are used for creating page layouts through a series of rows and columns that house your content. Zowe™ uses a responsive, mobile-first, fluid grid system that appropriately scales up to 12 columns as the device or view port size increases. + +## 12 column grid + +A 12 column grid is recommended. 12 is a well-distributed division that provides a good range of widths to assign to content. It is dividable by 2, 3, 4 and 6, which allows flexibility. Many frameworks, such as Bootstrap and Pure, use a 12 column grid by default. Other grid systems like a 5 column grid can reduce flexibility, balance, and consistency. + +## Gutters + +Columns create gutters (gaps between column content) through padding. For devices with a screen width greater than 768px, the column padding is 20px. For devices with a screen width less than 768px, the column padding is 10px. + +Screen width ≥ 768px = 20px gutters + +Screen width 768px = 10px gutters + + +## Columns + +Zowe designs should be limited to 12 columns. If designers feel that they need fewer columns in their grid, they can specify the number of 12 available columns they wish to span. + +This can translate to percentages of the twelve columns. Using this method, a designer can create a folded, less granular grid. For example, if your component spans three equal columns, that is equal to 25% of twelve columns. + +Column count: 12 + + +## Margins + +The 12 column grid does not have a maximum width. It has a width of 100%, with built in margins that create padding between column count and the edges of the viewport. + +In devices with a screen width greater than 768px, the margins are **5%** on the left, and **5%** on the right. + +In devices with a screen width less than 768px, the margins are **3%** on the left, and **3%** on the right. + +**Example: Screen Width > 768px** + + 5% left = 38px (rounded to nearest whole pixel) + 5% right = 38px (rounded to nearest whole pixel) + 12 columns + gutters = 768px - 38px - 38px = 692px (rounded to nearest whole pixel) + +![grid desktop](../../images/extender/grid_desktop-1024x780.png) + + +**Example: Screen Width 320px** + + 3% left = 10px (rounded to nearest whole pixel) + 3% right = 10px (rounded to nearest whole pixel) + 12 columns + gutters = 320px - 10px - 10px = 300px (rounded to nearest whole pixel) + +![grid mobile](../../images/extender/grid_mobile-1024x709.png) diff --git a/versioned_docs/version-v2.15.x/contribute/guidelines-ui/icon.md b/versioned_docs/version-v2.15.x/contribute/guidelines-ui/icon.md new file mode 100644 index 0000000000..9550643b3a --- /dev/null +++ b/versioned_docs/version-v2.15.x/contribute/guidelines-ui/icon.md @@ -0,0 +1,20 @@ +# Iconography + +Icons are key component for a successful UI design because they are a visual way to help add meaning to elements. + +[Font Awesome](https://fontawesome.com/) is a robust icon library that allows for an easy addition to any web project. Scalable vector icons that can instantly be customized — size, color, drop shadow, and anything that can be done with the power of CSS. + +![icons sample](../../images/extender/icons_sample-1024x753.png) + + +- **One Font, Hundreds of Icons** – In a single collection, Font Awesome is a pictographic language of web-related actions. +- **No JavaScript Required** – Fewer compatibility concerns because Font Awesome doesn’t require JavaScript. +- **Infinite Scalability** – Scalable vector graphics means every icon looks awesome at any size. +- **Free, as in Speech** – Font Awesome is completely free for commercial use. Check out the license. +- **CSS Control** – Easily style icon color, size, shadow, and anything that’s possible with CSS. +- **Perfect on Retina Displays** – Font Awesome icons are vectors, which mean they’re gorgeous on high-resolution displays. +- **Plays Well with Others** – Originally designed for Bootstrap, Font Awesome works great with all frameworks. +- **Desktop Friendly** – To use on the desktop or for a complete set of vectors, check out the cheatsheet. +- **Accessibility-minded** – Font Awesome loves screen readers and helps make your icons accessible on the web. + +To learn more or download the library go to www.fontawesome.com diff --git a/versioned_docs/version-v2.15.x/contribute/guidelines-ui/typography.md b/versioned_docs/version-v2.15.x/contribute/guidelines-ui/typography.md new file mode 100644 index 0000000000..a919c3099e --- /dev/null +++ b/versioned_docs/version-v2.15.x/contribute/guidelines-ui/typography.md @@ -0,0 +1,78 @@ +# Typography + +Typography is used to create clear hierarchies, useful organizations, and purposeful alignments that guide users through the product and experience. It is the core structure of any well designed interface. + +## Typeface + +Title typeface: Roboto Condensed + +Body typeface: Roboto + +Sample: + +![type sample](../../images/extender/type_sample.png) + + +## Font weight + +Font weight is an important typographic style that can add emphasis and is used to differentiate content hierarchy. Font weight and size pairings must be carefully balanced. A bold weight will always have more emphasis than a lighter weight font of the same size. However, a lighter weight font can rank hierarchically higher than a bold font if the lighter weight type size is significantly larger than the bold. + +Roboto font family provides a wide range of weights. However, only SemiBold, Regular, Light should be used for product design. + +- Font-weight: 300 / Light + + ![type light sample](../../images/extender/type_light_sample.png) + + Should only be used at sizes greater than or equal to 18px / 1.125rem + +- Font-weight: 400 / Normal + + ![type regular sample](../../images/extender/type_regular_sample.png) + +- Font-weight: 500 / Semi-bold + + ![type bold sample](../../images/extender/type_bold_sample.png) + +## Body copy + +We recommended that you use two sizes for body copy. The first size is UI specific. To maximize screen real estate we chose a smaller 14px / 0.875rem body copy size for the standard UI console. However, for areas that have prolonged reading, such as Documentation, we use a larger body copy size of 16px / 1rem to enhance readability. + +## Line scale + +- 1.333 Perfect Fourth-type scale - desktop + + ![type desktop sample](../../images/extender/type_scale_desktop-1024x533.png) + +- 1.2 Minor Third type-scale - mobile + + ![type mobile sample](../../images/extender/type_scale_mobile-1024x461.png) + + +## Line-height + +Line-height, traditionally known as leading, is one of several factors that directly contribute to readability and pacing of copy. Line-heights are based on the size of the font itself. Ideal line-heights for standard copy have a ratio of 1:1.5 (typesize : line-height). For example, a type at 16px / 1rem would have a line-height of 1.5rem / 24px (16 x 1.5). The exception to this rule are headings, which need less spacing and therefore have a line-height ratio of 1:1.25. + +## Embed font + +To embed your selected fonts into a web page, copy the following code into the `` of your HTML document: + +``` + +``` + +## Import font + +``` + +``` + +## Specify in CSS + +Use the following CSS rules to specify these families: + +``` +font-family: 'Roboto', sans-serif; +font-family: 'Roboto Condensed', sans-serif; +``` diff --git a/versioned_docs/version-v2.15.x/contribute/guidelines-ui/ui.md b/versioned_docs/version-v2.15.x/contribute/guidelines-ui/ui.md new file mode 100644 index 0000000000..84dcc078bb --- /dev/null +++ b/versioned_docs/version-v2.15.x/contribute/guidelines-ui/ui.md @@ -0,0 +1,13 @@ +# UI Guidelines +## Introduction + +This style guide is the visual language that represents Zowe™. It is a living document that will be updated based on the needs of our users and software requirements. + +## Clear +Our users rely on our software to help them be efficient in their work. The interfaces and experiences that we design should be clear so that there is never confusion about where to click or how to take the next step. Users should always feel confident in their actions. + +## Consistent +Users should be able to look at Zowe software products and know that they are in a family. Each software product is different, but should use similar patterns, icons, and interactions. If a user switches to a new product within Zowe, it should feel familiar. + +## Smart +Our users are intelligent, and they need smart software. Zowe design patterns should always compliment the user’s intelligence and reflect the user’s complex work environment. Designs should align with the Zowe design language by putting the human needs of the user first. diff --git a/versioned_docs/version-v2.15.x/contribute/roadmap-contribute.md b/versioned_docs/version-v2.15.x/contribute/roadmap-contribute.md new file mode 100644 index 0000000000..fdce094b8b --- /dev/null +++ b/versioned_docs/version-v2.15.x/contribute/roadmap-contribute.md @@ -0,0 +1,67 @@ +# Contributing to Zowe + +You are welcome to contribute to Zowe in many forms and help make this project better! We want to make it as easy as possible for you to become a Zowe contributor. This topic outlines the different ways that you can get involved and provides some of the resources that are available to help you get started. All feedback is welcome. + +- [Report bugs and enhancements](#report-bugs-and-enhancements) +- [Fix issues](#fix-issues) +- [Send a Pull Request](#send-a-pull-request) +- [Report security issues](#report-security-issues) +- [Contribution guidelines](#contribution-guidelines) +- [Promote Zowe](#promote-zowe) +- [Helpful resources](#helpful-resources) + +## Report bugs and enhancements + +- Report bugs: Download and try one of the latest Zowe builds. Report any bugs you find by [creating a Zowe bug report in GitHub](https://github.com/zowe/community/issues/new?assignees=&labels=bug&template=bug_report.md&title=). +- Report enhancements: Got an idea for a feature? Or something you're already using could be improved? [Post an enhancement request in GitHub](https://github.com/zowe/community/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)! +- Upvote enhancements and bugs: You can show us that an issue matters to you by applying the thumbs-up emoji for a specific issue. See [this link](https://github.com/zowe/api-layer/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) to view the list of issues sorted by the most upvotes. This information is taken into account when planning the upcoming PI. + +If you have an issue that is specific to a sub-project or community team, feel free to submit an issue against a specific repo. + +## Fix issues + +- There are many issues and bugs with the label `Good first issue` in the [Zowe GitHub repositories](https://github.com/zowe/) to help you get familiar with the contribution process. Check out the following list of GitHub repos to make your contribution! + - [Zowe sub-projects repositories](https://github.com/zowe/community/blob/master/README.md#zowe-sub-projects) + - [Zowe operations squads repositories](https://github.com/zowe/community/blob/master/README.md#zowe-operations-squads) + + When you decide to work on an issue, check the comments on that issue to ensure that it's not taken by anyone. If nobody is working on it, comment on that issue to let others know that you want to work on it to avoid duplicate work. The squad can assign that issue to you and provide guidance as well. + +- You can also reach out to the [Zowe squads on Slack](https://github.com/zowe/community/blob/master/README.md#slack) to check with the squads if there is any good starter issue that you can work on. + +## Send a Pull Request + +All code in Zowe aligns with the established [licensing and copyright notice guidelines](https://github.com/zowe/zlc/blob/master/process/LicenseAndCopyrightGuidance.md). + +Before submitting a Pull Request, review the general Zowe [Pull Request Guidelines](https://github.com/zowe/community#pull-request-guidelines) and make sure that you provide the information that is required in the Pull Request template in that specific repo. + +All Zowe commits need to be signed by using the [Developer’s Certificate of Origin 1.1 (DCO)](https://developercertificate.org/), which is the same mechanism that the Linux® Kernel and many other communities use to manage code contributions. You need to add a `Signed-off-by` line as a part of the commit message. Here is an example `Signed-off-by` line, which indicates that the submitter accepts the DCO: + +```Signed-off-by: John Doe ``` + +You can find more information about DCO signoff in the [zac repo](https://github.com/zowe/zac/blob/master/CONTRIBUTING.md). + +## Report security issues + +Please direct all security issues to `zowe-security@lists.openmainframeproject.org`. A member of the security team will reply to acknowledge receipt of the vulnerability and coordinate remediation with the affected project. + +## Contribution guidelines + +Check out the contribution guidelines for different components and squads to learn how to participate. + - [Zowe CLI](https://github.com/zowe/zowe-cli/blob/master/CONTRIBUTING.md) + - [Zowe API Mediation Layer](https://github.com/zowe/api-layer/blob/master/CONTRIBUTING.md) + - [Zowe Application Framework](https://github.com/zowe/zlux) + - [Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode/blob/master/CONTRIBUTING.md) + - [Zowe Client SDKs](https://github.com/zowe/zowe-cli/blob/master/docs/SDKGuidelines.md) + - [Zowe IntelliJ plug-in](https://github.com/zowe/zowe-explorer-intellij/blob/main/CONTRIBUTING.md) + - [Zowe Docs](./contributing) + +## Promote Zowe + +- Contribute a blog about Zowe. Read the [Zowe blog guidelines](https://github.com/zowe/community/blob/master/blogging/blog_guidelines.md) to get started. +- Present Zowe on conferences and social channels + +## Helpful resources + +- [General code guidelines](./guidelines-code/categories) +- [UI guidelines](./guidelines-ui/ui) +- [Zowe learning resources](../getting-started/zowe-resources) diff --git a/versioned_docs/version-v2.15.x/diagrams/apiml-oidc-auth-seq.puml b/versioned_docs/version-v2.15.x/diagrams/apiml-oidc-auth-seq.puml new file mode 100644 index 0000000000..4b553ada1e --- /dev/null +++ b/versioned_docs/version-v2.15.x/diagrams/apiml-oidc-auth-seq.puml @@ -0,0 +1,35 @@ +@startuml +'https://plantuml.com/sequence-diagram + +autonumber +actor User +actor "User Agent" as Agent +actor "Client App" as Client +actor OIDC as OIDC +actor "API ML GW" as GW + +User -> Agent: Do stuff +Agent -> Client: Open Client App +Client -> OIDC: Initiate OIDC flow [client_id, client_secret] +loop [MFA] +OIDC -> Agent: Request user credentials +User <-> Agent: Provide credentials +Agent -> OIDC: Validate credentials +end +OIDC --> Client: Return Auth Code / JWTs[access,refresh,identity] +Client -> GW: Request resources [JWT AT] +group validate +GW -> GW: Validate AT +GW -> OIDC: Validate AT +end +alt Validation success +GW -> GW: Cache AT validity +GW -> SAF: Map distributed ID to mainframe ID +GW -> GW: Create Zowe JWT +GW -> Service: call API service +Service --> GW: return Response +end +GW --> Client: Response +Client --> Agent: Response + +@enduml \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/diagrams/certificates-config-scenarios.drawio b/versioned_docs/version-v2.15.x/diagrams/certificates-config-scenarios.drawio new file mode 100644 index 0000000000..ff48594bde --- /dev/null +++ b/versioned_docs/version-v2.15.x/diagrams/certificates-config-scenarios.drawio @@ -0,0 +1,189 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/versioned_docs/version-v2.15.x/extend/component-registries.md b/versioned_docs/version-v2.15.x/extend/component-registries.md new file mode 100644 index 0000000000..f4957b2c9b --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/component-registries.md @@ -0,0 +1,240 @@ +# Component package registries + +Component package registries are on-premisis or remote storage which contains Zowe components (usually, extensions) and allows Zowe administrators to download an extension and its dependent extensions from that storage. +A component package registry makes Zowe component and extension management easier by reducing the need for manually uploading and installing an extension and its dependencies into Zowe. + +Zowe server content can manage components and extensions via the [`zwe components` commands](../user-guide/install-configure-zos-extensions.md). +These commands have optional parameters for performing operations using a registry instead of only using content local to the Zowe host. +Note: Using `zwe` with component package registries requires that `zowe.useConfigmgr=true` is set in your Zowe server configuration. [See using the configuration manager for more info](../user-guide/configmgr-using.md) + +Registries can be any technology that can be used to satisfy the Zowe component registry handler API. For example, npm, conda, artifactory, rpm and more could potentially be used as registries. +Currently Zowe server installs ship with a registry "Handler" for using an NPM server as a Zowe component package registry. Support for alternatives can be added, please refer to the [making your own handler section.](#making-your-own-handler) + +## Registry examples + +Consider the following examples where use of a registry is compared to managing extensions without a registry. + +### Installing an extension + +A Zowe server extension can be installed with a local archive such as in +`zwe components install -o my-zowe-extension-1.0.0.pax --config zowe.yaml` + +This has two shortcomings: +* In order to run that command, the extension must first have been uploaded to the Zowe host. +* Does that extension work after installation, or does it have a dependency that must also be installed? It's not known without reading documentation. + +Both issues can be resolved by using a registry, such as in +`zwe components install -o my-zowe-extension --config zowe.yaml` + +In this example, because `zwe` was not given the name of a file, it takes the parameter "my-zowe-extension" and searches for an extension package with that exact name within the component package registry configured for Zowe. +If the package is found in the registry, that extension and all of its dependencies will be downloaded and then installed. +**Note: This means you must trust the registry that you use. On-premisis registries are a great way to curate a list of trusted extensions and make it easy to install them. On the other hand, it would not be recommended to use a registry found on a public network, because you do not want to install extensions that you have not vetted.** + +The above example omits the registry configuration information, so the values default to what is containted within the zowe.yaml +If they were explicitly provided instead, the command may look like +`zwe components install -o my-zowe-extension --config zowe.yaml --handler npm --registry https://my-on-prem-registry.company.com/npm` + +### Upgrading an extension + +If a new version of an extension comes out, you can upgrade your extension from a local archive with +`zwe components install -o my-zowe-extension-2.0.0.pax --config zowe.yaml` + +This will replace the old extension with the new one. +This has three shortcomings: +* You must somehow be alerted that there is a new version available. +* In order to run that command, the extension must first have been uploaded to the Zowe host. +* Does that extension work after installation, or does it have a dependency that must also be installed? It's not known without reading documentation. + +If you use a registry, you can be alerted that a new version is available by running the command +`zwe components upgrade -o all --config zowe.yaml --dry-run` + +This command reports on **all** of the components that have upgrades available. The `--dry-run` parameter skips doing the actual upgrade, so you could upgrade every available extension at once by running this without `--dry-run` too. + +Once learning that an upgrade is available, you can perform it with +`zwe components upgrade -o my-zowe-extension --config zowe.yaml` + +This command is similar to `install`, it will upgrade your extension and also any dependencies. + +### Uninstalling extensions + +When running `zwe components uninstall -o my-zowe-extension`, the extension will be removed regardless of if you are using a registry or not. But if you are using a registry, the registry handler will also ensure any information it kept about the extension is cleaned up at that time. + +### Searching for extensions + +`zwe components search` requires a registry to function, because it searches that registry to try to find an extension that includes whatever you searched for. +You can search for any pattern, which may include fuzzy matches such as + +`zwe components search -o database* --config zowe.yaml` +This would return a list of extensions that can be installed that start with the word "database". Note that each registry and handler can have different search capabilities. Not all will support partial matches. + + +## Configuring zwe to use a registry + +Each `zwe components` command can take the parameter `--registry` to specify the location (such as HTTPS URL) of a registry, and the parameter `--handler` to specify which handler to use with that registry. `--handler` determines which registry type you are using, such as npm. + +When these parameters are not specified, then the default values are found within the zowe YAML configuration. +Within a zowe YAML configuration, the section `zowe.extensionRegistry` controls how `zwe` uses a registry. [The schema for this section can be found in the zowe YAML schema](https://github.com/zowe/zowe-install-packaging/blob/v2.x/master/schemas/zowe-yaml-schema.json) + +An example of configuring zwe for use with Zowe's own npm registry and npm handler would look like: + +``` +zowe: + extensionRegistry: + defaultHandler: npm + handlers: + npm: + registry: https://zowe.jfrog.io/zowe/npm + path: ${{ zowe.runtimeDirectory }}/bin/commands/components/npm.js +``` + +The above example states that the default registry type will be "npm", and that the npm type is handled by the handler located at the path `${{ zowe.runtimeDirectory }}/bin/commands/components/npm.js`. This handler will by default use the registry located at `https://zowe.jfrog.io/zowe/api/npm/npm-local-release/`. + +## Using multiple registries + +It is anticipated that extensions from different companies will be located on different registries, so it is possible to use multiple registries with Zowe. +Please note that registry types or handlers may not be able to resolve dependencies across different registries, so in this case extensions should only declare a dependency on other extensions that can be found within the same registry. +To switch between registries for accessing extensions in different registries, you can just use the `--registry` option on a `zwe components` command. +For example, instead of searching for "database" extensions within the default registry as in + +`zwe components search -o database* --config zowe.yaml` + +You may instead specify a registry, + +`zwe components search -o database* --config zowe.yaml --registry first-registry.foo` + +And if the extension you want isn't found there, you can try another registry, + +`zwe components search -o database* --config zowe.yaml --registry second-registry.foo` + +Then you'd be able to install the extension from that specific registry such as, + +`zwe components install -o database-product --config zowe.yaml --registry second-registry.foo` + +Note that Zowe does not currently track which registry an extension originated from, so when performing `zwe component upgrade`, you will need to specify the registry if the extension did not come from the default registry. + + +## Setting up a registry + +Although you can use a registry set up by an organization you trust, you can also set up your own registry. +This can be very useful for curating a list of Zowe extensions that are approved for use in your organization. +Many package managers, whether language-specific, z/OS native or otherwise, could be used to manage Zowe extension packages via whichever registry or repository technology they use. +Therefore Zowe cannot give guidance on every possible registry, but below are some suggestions that may be useful to you. + +### npm + +npm is the nodejs package manager. Typically npm registries store javascript code intended for use in a web browser or nodejs, but it's also possible to just store Zowe extensions instead. +npm registries are webservers that have an API which associates uploaded packages to users which own them, and such user accounts may also determine what you are permitted to download. +What webserver you use, and how user credentials are managed isn't standardized by npm, any webserver could be an npm server as long as it fulfills the npm API. + +As an example, https://verdaccio.org/ is such a webserver that you can set up to create your own on-premisis npm package registry. +You can find out more about verdaccio and [how to set up a verdaccio-based npm registry on their website](https://verdaccio.org/docs/what-is-verdaccio/) + +Another example is jfrog artifactory. Artifactory can store packages to serve through an npm registry, a docker registry, and much more. +You can find out more about artifactory and [how to set up an artifactory-based npm registry on their website](https://www.jfrog.com/confluence/display/JFROG/npm+Registry) + +## Making your own handler + +Handlers connect `zwe` with a component package registry. For each `zwe components` command, `zwe` will call one hanndler with a set of parameters and expect certain output from the handler in return before completing the `zwe` command processing. + +Handlers are at minimum an EECMAScript2020-compatible JavaScript module file that implements the Handler API. +This file is **not** nodejs, but rather is run within a [quickjs](https://bellard.org/quickjs/quickjs.html) environment. This file can in turn call other commands, but must return output for `zwe` to continue with. + +This handler JavaScript file can be located at any unix path on the host where Zowe is, and the location is [specified within the zowe YAML](#configuring-zwe-to-use-a-registry) + +When a `zwe components` command needs to use a handler, the handler is given input in the form of environment variables. If output is expected, the handler API requires each output attribute to be a key=value pair on a new line. + +The following table details the input and output expected for each handler action. + +| Attribute | Type | Input or Output | Actions | Description | +|-----------|------|-----------------|---------|-------------| +| `ZWE_CLI_REGISTRY_COMMAND` | string | Input | All | Values of 'install', 'upgrade', 'uninstall', 'search' inform handler which action to take and what additional input & output to expect | +| `ZWE_CLI_PARAMETER_REGISTRY` | string | Input | Install, Upgrade, Uninstall, Search | Used to inform handler which registry to use. Can be any format the handler understands. | +| `ZWE_CLI_REGISTRY_DRY_RUN` | boolean | Input | Install, Upgrade, Uninstall | If true, handler should show as much as possible about what would happen during this command, without committing changes that would alter which components are installed. | +| `ZWE_CLI_PARAMETER_COMPONENT_NAME` | string | Input | Install, Upgrade, Uninstall, Search | Value varies by command. For 'install' and 'uninstall', this value is the exact name of a component. For upgrade, it may also be 'all' to perform an upgrade for all components possible. For 'search', it may be any string to perform searching for exact or partial matching component names. | +| `ZWE_CLI_PARAMETER_COMPONENT_FILE` | string | Output | Install, Upgrade, Uninstall | A comma-separated list of components that have been added or removed. During 'install' or 'upgrade', the list must be full unix paths to component folders or archives that were added. For 'uninstall', the list must instead be just the names of the components that were removed. If the handler failed during its operation or there were no changes, the output should instead just be the string 'null'. | + +An example of running `zwe components install -o exact-component-name --handler npm --registry "https://zowe.jfrog.io/zowe/api/npm/npm-local-release/"` would have the handler being given the following environment variables: + +``` +ZWE_CLI_REGISTRY_COMMAND=install +ZWE_CLI_PARAMETER_REGISTRY=https://zowe +ZWE_CLI_REGISTRY_DRY_RUN=false +ZWE_CLI_PARAMETER_COMPONENT_NAME=exact-component-name +``` + +And after the command completes, the handler can print anything in STDOUT and STDERR as long as STDOUT includes a line specifying the location of the components installed, via `ZWE_CLI_PARAMETER_COMPONENT_FILE`. The output could look like: + +``` +2 packages installed +Operation successful +return code=0 +ZWE_CLI_PARAMETER_COMPONENT_FILE=/my/components/exact-component-name/archive.pax,/my/components/dependency1 +``` + +Where `archive.pax` is an archive of `exact-component-name`, while 'dependency1' is a folder containing the un-archived contents of `dependency1`. + + +### Handler code + +The Handler API interface is [located within Zowe's code here](https://github.com/zowe/zowe-install-packaging/blob/2751a194048f0050fc7ebcaeaac8c96a36106991/bin/commands/components/handlerutils.ts) + +And Zowe delivers a handler written for use with [npm, located here](https://github.com/zowe/zowe-install-packaging/blob/2751a194048f0050fc7ebcaeaac8c96a36106991/bin/commands/components/npm.ts) + + +## Component Packaging Requirements + +Zowe extensions can be written in a variety of languages and may have network-level dependencies. These attributes of extensions may seem like an odd fit for some existing package managers such as those that are language specific. However, all Zowe requires out of a package manager is that the manager can deliver an archive of a extension or folder containing an extension. The Zowe community has found that delivering a Zowe extension as an archive can avoid the complexities of some package managers and make it simple to deliver an extension via one or more package manager with minimal work. Below are some patterns that can work for certain package managers. + +### npm + +The npm handler that is delivered by Zowe expects that each npm package either contains an archive of a Zowe extension or that the entire package folder is itself the Zowe extension. +You should become familiar with the [attributes of a package.json file](https://docs.npmjs.com/files/package.json/) as some are referenced below. + +The Zowe component registry handler determines which is true by reading the `package.json` of the npm package and looking for the `main` attribute. If `main` exists, its value must be a path to the archive of the extension, relative to the package root folder. +For example, the `angular-sample` extension npm package has this folder structure: +``` +/angular-sample + /package.json + /angular-sample.pax +``` + +The handler determines that `angular-sample.pax` is the archive of the extension when it sees the `main` property within the package.json below: + +``` +{ + "name": "angular-sample", + "version": "2.6.0", + "description": "Sample App Showcasing Angular Adapter", + "main": "angular-sample.pax", + "homepage": "https://zowe.org", + "keywords": [ + "zlux", + "appfw", + "app", + "angular", + "sample" + ], + "license": "EPL-2.0", + "repository": { + "type": "git", + "url": "https://github.com/zowe/sample-angular-app.git" + } + } +``` + +If `main` were not defined, then Zowe would instead expect that this folder was an extension, which for example would have a `manifest.yaml` at the root of the folder. + +npm requires that each package contain a `package.json` file, and there are certain fields that are required within it. Several fields have overlap in meaning with Zowe's extension manifest files, so Zowe delivers a utility to help you automate the creation of a `package.json` file using a `manifest.yaml` file as input. [This Zowe npm module will copy the properties from one file to the other for you](https://github.com/zowe/zowe-install-packaging/tree/v2.x/master/bin/utils/manifest-to-npmpackage) + +The simplest and most robust way to deliver a Zowe extension via npm is to build your extension, then archive the entire folder of the extension as a `.pax` file, and put that into a folder with a single `package.json` file for npm which has the `main` attribute set to the name of your pax archive, and use the `dependencies` section of the package.json to list if your extension depends on any other Zowe extensions. +Once you have your npm package, you can upload it to the registry of your choice using standard npm commands, such as: + +``` +npm login +cd /your/extension/package/folder +npm publish +``` + +## Additional resources + +While this document is the authoritative source on Zowe's component package regpistry technology, older additional information may be found in [the presentation](https://github.com/zowe/zowe-install-packaging/files/9292283/appstore2.pdf) and [the recording](https://zoom.us/rec/share/y6zsW5U9QWE1s1r4M3nFnSO9Kkv3yeT5boyZFqWH1BxW3Tju_jcAGP7jO1DsLuZq.rhlqHx6DgPxmXBhW?startTime=1660053548000) used during the initial technology prototype. diff --git a/versioned_docs/version-v2.15.x/extend/dynamic-static-registration-overview.md b/versioned_docs/version-v2.15.x/extend/dynamic-static-registration-overview.md new file mode 100644 index 0000000000..272a5f6fa1 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/dynamic-static-registration-overview.md @@ -0,0 +1,21 @@ +# Dynamic and static registrtion overview + +Zowe API Mediation Layer extenders can build and onboard additional API services to the API ML microservices ecosystem. REST APIs can register with the API Mediation Layer, which makes them available in the API Catalog and for routing through the API Gateway. + +To register a z/OS service with the API Mediation Layer, there are two approaches: +- [Dynamic API registration](#dynamic-api-registration) +- [Static API registration](#static-api-registration) + +For information about how to onboard REST APIs, see the [Onboarding Overview](extend-apiml/onboard-overview.md). + +To streamline the process of onboarding new REST API services to the API Mediation Layer, see [Onboarding a REST API service with the YAML Wizard](../user-guide/onboard-wizard.md). + +### Dynamic API registration + +Registration of a REST API service to the API ML is performed through a call to the Discovery Service by sending registration data and metadata for the service being registered. Registration requires that the z/OS service must know the web address of the API ML Discovery Service. When Dynamic registration is performed, the service that performs the registration must periodically send heartbeat requests to the Discovery Service for each registered service instance. These heartbeat requests serve to renew the corresponding service instance registration with API ML. These requests enable the Discovery Service to monitor the availability of registered service instances. Services that are registered dynamically display the status of the service in the API Catalog after initial service registration. + +For more information about how to build a service which is able to register, see the [Onboarding Overview](extend-apiml/onboard-overview.md). + +### Static API registration + +For services that cannot be modified to be dynamically discoverable, it is possible onboard them to the API ML by providing the API ML a static definition file with API service details. This registration method does not require modifications to the existing API service code. For more information, see [Onboard a REST API without code changes required](extend-apiml/onboard-static-definition.md). Unlike services that use Dynamic API registration, the status of services onboarded through Static API registration is not displayed in the API Catalog. diff --git a/versioned_docs/version-v2.15.x/extend/extend-api/ReactJSUI.md b/versioned_docs/version-v2.15.x/extend/extend-api/ReactJSUI.md new file mode 100644 index 0000000000..cc66b211b4 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-api/ReactJSUI.md @@ -0,0 +1,192 @@ +# Creating a Zowe integrated ReactJS UI + +One of the great things about working with Zowe is that you can include any UI's that you have already developed in your Zowe Virtual Desktop. In this blog we look at how we do this and also show how to take advantage of a Restful API created on a JEE server within the Zowe environment. + +![](../../images/samples/reactjs/overview.png) + +Take a look at the [Creating a RestAPI with Swagger documentation using Liberty](./libertyAPI) tutorial for the background to the Restful API with Swagger documentation we will be using. + +## Prerequisite skills + +Knowledge of the following development technologies is beneficial: + +- React +- Redux +- Consuming Rest API's + +## Examining the App Structure + +First download the sample app found [here](https://github.com/zowe/webui-scenarios/tree/master/basic-react). We will not be examining the entire sample, but it is included as an example and boilerplate that can be built off of. + +Looking at the sample app their are 2 main sections that are important to us: + +- Constants.js +- actions/actions.js. + +### Constants.js + +Lets first examine Constants.js. + +```javascript +let host = ':' +if (typeof location !== 'undefined') { + const hostname = location.hostname + if (hostname !== 'localhost') { + host = location.host + } +} + +export const BASE_SERVER_URL = host +export const BASE_URL = `https://${host}` +export const BASE_WS_URL = `wss://${host}` +``` + +Notice that here we are setting our 'host' for the app. We are connecting to hypothetical server and the default port for the MVD 7445. This host then gets wrapped in a 'BASE_URL' constant that we can use in other sections of our app. Change this line to connect to your own server and port. + +### Actions.js + +Next lets look at calling our API created in the [creating a RestAPI with Swagger documentation using Liberty](./libertyAPI) tutorial. Following Redux structure, this call will be in our action.js file. We won't be looking at the entire file, but instead the relevant fetch request. + +```javascript +function fetchPosts(subreddit) { + return dispatch => { + dispatch(requestPosts(subreddit)) + let header = new Headers({ + 'Access-Control-Allow-Origin': '*', + 'Content-Type': 'multipart/form-data' + }) + return fetch(`${BASE_URL}/jzos/environmentVariable`, { + header: header, + credentials: 'include' + }) + .then(response => response.json()) + .then(json => dispatch(receivePosts(subreddit, json))) + .catch(error => console.log(error)) + } +} +``` + +Note that we are using the [fetch api](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) to the grab the `environmentVariable` from the host that we defined before. We then make the rest of our app aware of the response using Redux's 'dispatch' method. + +## Adding your App to the MVD + +While the zlux environment comes with predefined "apps" and explorers, you also have the ability to extend the system and add your own apps. + +### Building your App for the MVD. + +Before we can place our app on the MVD, we need to first 'build' a production version of it and place it in a folder where Zowe can read it. +Zowe looks in a folder called 'web' when looking for an entry point to new apps. + +In order to build and prepare your app: + +1. Run the `build` script in `package.json` using: + + - `npm run build` + +2. Create a folder for your project and a new `web` folder inside it. + + - EX: `/Desktop/` and `Desktop//web` + +3. Copy built project into `Desktop//web` + - If using the sample, copy `app.min.js` , `index.html` , `icon.png` and `css` into to `/Desktop//web/` + +### Configuring your app for Zowe + +In order for Zowe to be aware of an app, a pluginDefintion.json file must be included in the root of the project. This file lets Zowe know information about the framework used, reference files, and basic configuration for the app. Lets take a look at our pluginDefinition: + +```json +{ + "identifier": "com.rs.basic-react", + "apiVersion": "1.0", + "pluginVersion": "1.0", + "pluginType": "application", + "webContent": { + "framework": "iframe", + "launchDefinition": { + "pluginShortNameKey": "basic-react", + "pluginShortNameDefault": "IFrame", + "imageSrc": "icon.png" + }, + "descriptionKey": "Sample App Showcasing IFrame Adapter", + "descriptionDefault": "Sample App Showcasing IFrame Adapter", + "startingPage": "index.html", + "isSingleWindowApp": true, + "defaultWindowStyle": { + "width": 800, + "height": 420, + "x": 200, + "y": 50 + } + }, + "dataServices": [] +} +``` + +Next add this pluginDefinition to the root of your project: + +- EX: `Desktop//` + +### Explaining the Plugin file system + +To add new apps, files must be added in two locations. + +- Zowe root (`/zaas1/zowe/`) +- Plugins Folder (`/zaas1/zowe//zlux-example-server/plugins`) + +Inside the 'Plugins Folder' we will add our identifier named `com.basic-react.json`. Inside this json file the **plugin location** and the **identifier name** are specified. Our identifier will look like this: + +```json +{ + "identifier": "com.rs.basic-react", + "pluginLocation": "../../" +} +``` + +To add our app to the file system: + +1. Copy project from `/Desktop` to `/` on your server + + - Use `scp @ /Users/path/to/files /` + - Alternatively this can be done using SFTP or the ZOS Explorer in binary mode. + +2. Create our identifier within the plugins folder (`/zlux-example-server/plugins`): + + - `touch com.basic-react.json` + +3. Edit file with vi to read: + +```json +{ + "identifier": "com.", + "pluginLocation": "../../" +} +``` + +### Deploying your App + +In order to deploy our newly added app, + +1. Run `./deploy.sh` found in `/zaas1/zowe//zlux-build` +2. Run `./zowe-stop.sh` found in `/zaas1/zowe//scripts` +3. Run `./zowe-start.sh` found in `/zaas1/zowe//scripts` + +## Setting up the server for Development + +:::warning +This next section should only be changed for development purposes. +::: + +While not necessary depending on your system configuration, often will need to allow our server to accept incoming connections and avoid CORS errors. + +In order to update the server to accept all connections: + +- Navigate to `/explorer-server/wlp/usr/servers/Atlas/server.xml` +- Open the file with vi and paste the following code in. + +```javascript + + + +``` + +After adding this section, navigate to `https://:/ZLUX/plugins/com.rs.mvd/web/` and you should see your new app added to the MVD! diff --git a/versioned_docs/version-v2.15.x/extend/extend-api/api-intro.md b/versioned_docs/version-v2.15.x/extend/extend-api/api-intro.md new file mode 100644 index 0000000000..a8cf14ddf8 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-api/api-intro.md @@ -0,0 +1,3 @@ +# API Extension Samples + +These samples show users how to create their own API's using a Node or Liberty Server. diff --git a/versioned_docs/version-v2.15.x/extend/extend-api/existingAPI.md b/versioned_docs/version-v2.15.x/extend/extend-api/existingAPI.md new file mode 100644 index 0000000000..9507e3a311 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-api/existingAPI.md @@ -0,0 +1,128 @@ +# Onboarding existing Rest API Script + +(WORK IN PROGRESS) + +In this tutorial we consider how an organization with a product or tool with an existing Rest API can be rapidly Onboarded to Zowe™ by getting that product or tool registered with the API Gateway. This would then allow the product to be available from a central location and benefit from other Zowe API Mediation layer functionality. To do this we need a method for defining the service to the gateway + +As the example product we are using a simple Spring Boot sample app that can be downloaded here: [spring-boot-jzos-sample](https://github.com/zowe/spring-boot-jzos-sample). If you have your own example skip the "Get your app running" section we can adapt your script for that. + +## Overview +Apart from accessing your API's centrally through the Gateway, the Gateway provides manifest information about all accessible API's in it's catalog. For our static definition this information is retrieved from api definitions stored in yaml files. Although these files are simple in structure they would add more complexity for your customers when it comes to installing your product. Therefore we have developed a script that you can include with your product to simplify the process. + +### The Api definition file + +Key to registering your product to the gateway is the following file structure which is installed in the API mediation layer. It's not critical to understand everything here but provided for anyone who wishes to grasp every detail. + +```yaml +services: + - serviceId: jzos # internal id for the service + title: IBM z/OS jzos # Title as used in the Catalog information tiles + description: IBM z/OS jzos REST API service # Title as used in the Catalog information tiles + catalogUiTileId: jzos # internal id Catalog information tiles + instanceBaseUrls: + - https://host.my.com:2956/ # location of service + homePageRelativeUrl: # home page, leave blank if instanceBaseUrls is the same + routedServices: + - gatewayUrl: api/v1 # [api/ui/ws]/v{majorVersion} convention + serviceRelativeUrl: jzos # added to location + apiInfo: + - apiId: com.ibm.jzos # internal id + gatewayUrl: api/v1 # main reference + version: 1.0.0 # version of API on Gateway + documentationUrl: https://host.my.com:2956/swagger-ui.html # Applies if no swagger ui + swaggerUrl: https://host.my.com:2956/v2/api-docs # provides a link and generates swagger info + +catalogUiTiles: + jzos: # as per serviceId - internal id for the service + title: z/OS jzos services # tile label + description: IBM z/OS jzos REST services # tile description +``` + +This information together creates the catalog tile information +![](../../images/extender/tile.png) + + +By clicking on the tile the following information is presented. Note the swagger is generated from the swaggerUrl link which needs to be v2 swagger +![](../../images/extender/service.png) + +Although the most critical information, the redirection of the urls is under routed services along with the service id. +``` +routedServices.gatewayUrl+serviceId will point at instanceBaseUrls+serviceRelativeUrl +/jzos/api/v1 ==> https://host.my.com:2956/jzos +``` +## Getting the sample app running + +If you are using the sample follow the instructions in the readme to get it up and running on your z/OS machine. If using your own go to section 2. The sample generates swagger 2 documentation. + +## Modifying the Gateway script + +As described earlier we are registering our application with the API Catalog by way of a file that is read by the Gateway when it's started. We think of this as a static definition as the details of the service won't change whilst the gateway is running. To achieve a more dynamic relationship between the application and registry, one that can respond to changes in one or the other e.g. for load balancing purposes we need to construct the product differently. See [Onboarding from scratch](./existingApp). + +The information contained in the yaml definitions file abover requires input from both the onboarding organization (you) and the end user. Therefore the intent is to provide as much of the onboarder information into the script template so the end user has fewer choices to make. Therefore the script should be updated. + +[Onboard-to-gateway](https://github.com/zowe/Onboarding-scripts) + +The following fields need to be set + +````properties +################################################################################ +# The following fields to be filled in by implementing extenders team +################################################################################ +defaultServiceId="xtdrsvcid" # lowercase only +defaultTitle="Product name" +defaultDescription="Product description" +defaultCatalogUiTileId="xtdrCatalogUiTileId" +defaultHomePageRelativeUrl="" # Usually home page is the same as the base URL + +defaultGatewayUrl1="api/v1" +defaultServiceUrl1="api/v1/xtdrServiceId" +defaultGatewayUrl2="ui/v1" +defaultServiceUrl2="ui/v1/xtdrServiceId" +# Additional gateway and services will require further changes to script later + +defaultApiId="no.id.ea" +defaultGatewayUrl=$defaultGatewayUrl1 +defaultApiVersion="1.0.0" + +defaultCatalogTileTitle="My Product in catalog" +defaultCatalogTileDescription="My Product description in catalog" +```` + +##### defaultServiceId +This field is an internal identifier that needs to be unique across product instances. Therefore if you install multiple instances of your product this will also need to be incremented. Note it must be lowercase and is also used as part of the gateway uri +##### defaultTitle + +##### defaultDescription + +##### defaultCatalogUiTileId +This is the name that appears on the tab of the opened service + +##### defaultHomePageRelativeUrl +If the home page is not same as the base url add it in here + +##### defaultGatewayUrl(n) +This is the the gateway url that you want your redirect to work from. +You can create several defaultGatewayUrl/defaultServiceUrl pairings. Normally this would cater for api, web socket (ws) and ui. + +##### defaultServiceUrl(n) +The target url of the service + +##### defaultApiId +An internally used id. Suggest using com.co.yourprod etc. + +##### defaultGatewayUrl +Main url redirection for documentation + +##### defaultApiVersion +Version number of API if you wish to use it + +##### defaultCatalogTileTitle +The title that is displayed in the catalog pages + +##### defaultCatalogTileDescription +The description that is displayed in the catalog pages + +## How the Script works +Your updated shell script can now be run. This is how the process will appear to the end user. + + diff --git a/versioned_docs/version-v2.15.x/extend/extend-api/existingApp.md b/versioned_docs/version-v2.15.x/extend/extend-api/existingApp.md new file mode 100644 index 0000000000..986062f158 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-api/existingApp.md @@ -0,0 +1,7 @@ +# Onboarding from scratch + +In this tutorial we consider how an organization with a product existing or under development with no pre-existing Rest API can be Onboarded to Zowe™. This would then allow the product to be available from a central location and benefit from other Zowe API Mediation layer functionality. + +At this stage of your development you have more options and can design with Zowe in mind. + +As the example product we are using a simple Spring Boot sample app that can be downloaded here: [spring-boot-jzos-sample](https://github.com/zowe/spring-boot-jzos-sample) \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/extend/extend-api/liberty-api-sample.md b/versioned_docs/version-v2.15.x/extend/extend-api/liberty-api-sample.md new file mode 100644 index 0000000000..72c6fc520a --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-api/liberty-api-sample.md @@ -0,0 +1,44 @@ +# Provide Liberty API Sample + +:::tip Github Sample Repo: +[rest-api-jzos sample](https://github.com/zowe/spring-boot-jzos-sample) +::: + +This sample is a boilerplate for creating Rest API's using a liberty. For more information, visit [Creating a RestAPI with Swagger documentation using Liberty](./libertyAPI). + +## To Install + +After creating or obtaining the REST API war file: + +1. Stop the Zowe server. + + - Navigate to `/scripts/` + - Run `./zowe-stop.sh` + +2. Push the war file up to the dropins folder using SCP, SFTP, or on Windows with Putty SCP (PSCP). + - _EX_: + `scp /path/to/warfile @:/explorer-server/wlp/usr/servers/Atlas/dropins/` + +:::tip +Use the USS, IDZ, or IBM Explorer for z/OS to confirm that your files have transferred. +::: + +3. Restart the Zowe server. + + - Navigate to `/scripts/` + - Run `./zowe-start.sh` + +## Verify Install + +1. Check the Browser to see if the REST APIs have been added. + - _EX_: `:/ibm/api/explorer/#/` + +view + +:::tip +Make sure to set file transfer mode to binary before the transfer. +After transferring the WAR file, check the permission on the file by running +ls -la +If the read permission is not set, turn on the read permission by running, +chmod +r javazos-sample.war +::: diff --git a/versioned_docs/version-v2.15.x/extend/extend-api/libertyAPI.md b/versioned_docs/version-v2.15.x/extend/extend-api/libertyAPI.md new file mode 100644 index 0000000000..0837ca9525 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-api/libertyAPI.md @@ -0,0 +1,127 @@ +# Creating a RestAPI with Swagger documentation using Liberty + +This tutorial will show you how to develop your own Zowe API's with Swagger notation. Although the resulting War file is "dropped into" a Liberty server, the same principles can be applied for other JEE servers. + +The source repo for the project can be found at the [rest-api-jzos sample](https://github.com/zowe/spring-boot-jzos-sample). +This document describes how we can add new function and UI's to run alongside Zowe. + +So for example, as a team with an established z/OS application we may want to provide wider access to that functionality so that it can be exploited by different applications and organizations. This can include making functionality available to company DevOps processes or for inclusion in UI's. + +## Prerequisite skills + +Developers should be familiar with the following technologies: + +- Java +- Git and GitHub +- Maven + +Knowledge of the following development technologies is beneficial: + +- J2E +- Liberty or WebSphere Application Server +- Eclipse/z/OS Explorer +- RestAPI's +- zSystems development + +## Zowe API Architecture Overview + +Much of the Zowe infrastructure builds upon functionality provided by different applications and systems in z/OS some of which are microservices deployed on a Liberty server running on the Z system. As an example Zowe can access z/OSMF services that are aggregated with other functionality that provides new or more comprehensive functionality that allows new services to be created that also benefit from single-sign using **Lightweight Third Party** Authentication (LTPA) keys and centralized logging functions. + +The API for Zowe is written in Java utilizing JAX-RS: Java API for RESTful Web Services (JAX-RS). JAX-RS uses Java annotations to simplify the development and deployment of web service clients and endpoints and ultimately become rendered into swagger interfaces. + +## Building your own Microservice + +There are many publications and blogs regarding Microservice design +available and it's beyond our scope to attempt to cover here. Fundamentally, however you have most likely already performed an analysis of your product and have identified several notional business +areas or components that you are most interested in. One of the recommendations in developing Microservices is not to have one massive service but several services that represent component areas. One reason +would be Microservices that are not used or function is considered restricted can be excluded without affecting other function. + +Once you have identified areas of the functionality Microservices for the API's can be designed. Once again there are an +enormous amount of guidelines, Best practices, strict rules and design guides out there and I won't be prescriptive how you do this except to +say that you will spend a lot of time teasing out your API object names and considering how the REST functions (GET, PUT, POST and DELETE) apply +to these objects. Once ready or as long as we have the most basic Get Object API defined we can make a start at coding. + +An example below is intended to show how we apply the definitions of +the Rest API as Java Annotations around a Java method. + +```java + @PUT + @Path(value = "{attribute}") + @Produces(MediaType.APPLICATION_JSON) + @ApiOperation(value = "Updates the value of an existing environment variable", + notes = "This API uses JZOS to perform the process.") + @ApiResponses({ + @ApiResponse(code = 200, message = "Updated the environment variable")}) + public Response update( + @ApiParam(value = "Environment variable name", required = true) @PathParam("attribute") String attribute, + @ApiParam(value = "Value of an environmental variable") ValueParameter parameter) + { + jzosService.updateProperty(attribute, parameter) ; + return Response.status(Status.OK).build(); + } +``` + +Within the Liberty server we have configured a function "APIDiscovery" which at run time converts this into swagger format. + +![](../../images/guides/libertyAPI/swag.png) + +## Anatomy of a project + +Using [rest-api-jzos sample](https://github.com/zowe/spring-boot-jzos-sample) as a guide. Create a Dynamic web project (don't specify it as part of an EAR if using the wizard), or if using a +Maven archetype choose one containing a simplified sample J2EE application. + +_Alternatively, use the project as a template. Download the code, rename it and use as the basis of your new project._ + +The image below indicates the type of structure you should be seeing although this contains more files and folders than you will have +initially it should give you the general idea. Don't worry about git or target at this stage they will appear later as you develop your project. + +![](../../images/guides/libertyAPI/struct1.png) + +Your project should be developed as a standalone war file and deployed either to a local server if you have no z dependencies (Hint: good to +start with). If using Eclipse and not yet using z/OS specific functionality consider setting up a test server within Eclipse and +automatically deploying your war to it. Fantastic for debugging. + +The alternative is to drop the war into the Dropins folder of an existing Zowe installation. + +It is possible to debug remotely using Eclipse but personally I have found this can lead to issues such as corrupt process locks in z/OS +requiring SysProg intervention. If you have quick access to SysProg rights you may be comfortable with this but often good old sysout is the +best debug support + +The example project uses Maven for its build process which will run locally or as part of a Jenkins build process. + +Further examples of implementations can be found looking at the code for the Zowe microservice. + +### Eclipse hint.. + +Using Maven to build in an Eclipse environment can leave your files full of red x's. Generally this is caused because the Eclipse compiler +mechanism has no visibility of dependencies described in the pom.xml file. There is a magic function to help with this. Right click on your +project and select the Maven Update option. This will allow the Eclipse project to be updated and get rid of many of the x's. + +![](../../images/guides/libertyAPI/menu1.png) + +### Generic jar files + +It is likely that the Zowe team will provide utility jar files that will either be present on the server or require specific inclusion as +described in 'Additional Jars'. Currently generic jar files such as Zowe utilities should be included in your war file. This may be revised +later based upon future requirements. + +## Unit Testing + +Aim for 100% coverage. In many cases it may be impossible or impractical to achieve either because code is auto-generated or covered in other +tests. Use Jacoco to highlight where there are gaps. + +Note the references to Jacoco in the atlas-jzos-sample pom.xml file. Remember it operates in two phases, initializing before the unit tests +are run and reporting afterwards. + +Examples of unit testing, the use of Mockito and PowerMock are in the src/test/java folder for the jzos sample. + +### FV testing + +For the purpose of testing applications in a live fully configured environment scenario it is necessary to create another testing specific +project. You will notice that only the src/main/tests folder is populated. When running a Maven build the tests contained here are +exercised. + +- Using the maven-archetype-quickstart as your Maven template or by creating a new Java project and adding the pom.xml file in Eclipse, + create a project to contain FV and/or Integration tests. + +- Alternatively, you can always download the code, rename it and use as the basis of your new project. diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-medation-sso-integration-extenders.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-medation-sso-integration-extenders.md new file mode 100644 index 0000000000..48d42e3b16 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-medation-sso-integration-extenders.md @@ -0,0 +1,133 @@ +# Single Sign On Integration for Extenders + +:::info Role: +infrastructure application developer +::: + +As an infrastructure application developer, review the ways a service can integrate with API Mediation Layer (API ML) and participate in the Single Sign On for REST APIs on the z/OS platform. This article does not cover the client methods to call API ML and authenticate. For more information about API ML authentication, see the [Single Sign On Overview](../../user-guide/api-mediation-sso.md) in the User Guide. + +To integrate with API Mediation Layer and leverage Single Sign On, choose from the following three possible methods: + +- Accepting JWT token +- Accepting SAF IDT token +- Accepting Passticket + +Two additional possibilities can potentially be leveraged to enable Single Sign On but are not properly integrated with the standard API ML: + +- Bypassing the authentication for the service +- Asking for details about the x509 certificate used for authentication + **Note:** Asking for details about the x509 certificate does not properly participate in SSO as this method cannot accept all authentication methods that are supported upstream of API Mediation Layer. + +Service configuration is generally provided in the yaml file when using one of the enablers outlined in this section. Key to general configuration is the `authentication` object. The `scheme` property under the `authentication` object states what type of authentication the service expects and is shared across all types of authentication. + +**Example:** + +```yaml +authentication: + scheme: httpBasicPassTicket + applid: ZOWEAPPL +``` + +* **authentication.scheme** +Specifies a service authentication scheme. The following schemes participate in single sign on are supported by the API Gateway: `zoweJwt`, `safIdt`, `httpBasicPassTicket`. Two additional schemes that do not properly participate but may be relevant are `bypass`, and `x509`. + +In the event that there is an issue with authentication, API Mediation Layer sets `X-Zowe-Auth-Failure` error headers which are passed to downstream services. In addition, any `X-Zowe-Auth-Failure` error headers coming from an upstream service are also be passed to the downstream services without setting the valid headers. The `X-Zowe-Auth-Failure` error header contains details about the error and suggests potential actions. + +## Accepting JWT + +Accepting JWT is the preferred method for integrating. No configuration is needed on the user's side. + +```yaml +authentication: + scheme: zoweJwt +``` + +* When a Zowe JWT is provided, this scheme value specifies that the service accepts the Zowe JWT. No additional processing is done by the API Gateway. +* When a client certificate is provided, the certificate is transformed into a Zowe JWT, and the downstream service performs the authentication. +* If the downstream service needs to consume the JWT token from a custom HTTP request header to participate in the Zowe SSO, it is possible to provide a header in the Gateway configuration. +The HTTP header is then added to each request towards the downstream service and contains the Zowe JWT to be consumed by the service. For more information, see [Enabling single sign on for extending services via JWT token configuration](../../user-guide/api-mediation/configuration-extender-jwt.md). + +## Accepting SAF IDT + +Using the scheme value `safIdt` specifies that the service accepts SAF IDT, and expects that the token produced by the SAF IDT provider implementation is in the `X-SAF-Token` header. It is necessary to provide a service APPLID in the `authentication.applid` parameter. + +```yaml +authentication: + scheme: safIdt + applid: +``` + +- `` +Specifies the `APPLID` value that is used by the API service for PassTicket support (e.g. `OMVSAPPL`). + +For more information, see [Implement a SAF IDT provider](implement-new-saf-provider.md). + +## Accepting Passtickets + +Using the scheme value `httpBasicPassTicket` specifies that a service accepts PassTickets in the Authorization header of the HTTP requests using the basic authentication scheme. +It is necessary to provide a service APPLID in the `authentication.applid` parameter to prevent passticket generation errors and to make sure API Mediation Layer can generate passtickets with the given APPLID. + +* When a JWT is provided, the service validates the Zowe JWT to use for passticket generation. +* When a client certificate is provided, the service validates the certificate by mapping it to a mainframe user to use for passticket generation. +* If the downstream service needs to consume the user ID and the passticket from custom HTTP request headers (i.e. to participate in the Zowe SSO), it is possible to provide the headers in the Gateway configuration. +* The HTTP headers are then added to each request towards the downstream service. The headers contain the user ID and the passticket to be consumed by the service. For more information about the custom HTTP request headers, see [Adding a custom HTTP Auth header to store Zowe JWT token](../../user-guide/api-mediation/configuration-extender-jwt.md#adding-a-custom-http-auth-header-to-store-zowe-jwt-token). + +```yaml +authentication: + scheme: httpBasicPassTicket + appliId: +``` + +- `` +Specifies the `APPLID` value that is used by the API service for PassTicket support (e.g. `OMVSAPPL`). + +## Bypassing authentication + +Using the scheme value `bypass` specifies that the token is passed unchanged to the service. + +:::note +This is the default scheme when no authentication parameters are specified. +::: + +```yaml +authentication: + scheme: bypass +``` + +## Custom way to accept client certificates + +While it is possible to integrate with client certificates by setting the scheme with the value `x509`, this approach is not recommended. We recommned that you use any of the previously described methods, whereby API ML will validate the certificate for you and ideally provide a Zowe JWT. + +The `x509` scheme value specifies that a service accepts client certificates forwarded in the HTTP header only. The Gateway service extracts information from a valid client certificate. For validation, the certificate needs to be trusted by API Mediation Layer. Extended Key Usage must either be empty or needs to contain a Client Authentication (1.3.6.1.5.5.7.3.2) entry. To use this scheme, it is also necessary to specify which headers to include. Specify these parameters in `headers`. This scheme does not relate to the certificate used in the TLS handshake between API ML and the downstream service, but rather the certificate that is forwarded in the header that authenticates the user. + +```yaml +authentication: + scheme: x509 + headers: X-Certificate-Public +``` + +* **authentication.headers** + When the `x509` scheme is specified, use the `headers` parameter to select which values to send to a service. Use one of the following values: + + * `X-Certificate-Public` + The public part of client certificate base64 encoded + + * `X-Certificate-DistinguishedName` + The distinguished name from client certificate + + * `X-Certificate-CommonName` + The common name from the client certificate + +## Accepting z/OSMF LTPA token + +Using the scheme value `zosmf` specifies that a service accepts z/OSMF LTPA (Lightweight Third-Party Authentication). +This scheme should only be used for a z/OSMF service used by the API Gateway Authentication Service, and other z/OSMF services that are using the same LTPA key. + +```yaml +authentication: + scheme: zosmf +``` + +:::tip +For more information about z/OSMF Single Sign-on, see [Establishing a single sign-on environment](https://www.ibm.com/support/knowledgecenter/SSLTBW_2.4.0/com.ibm.zosmfcore.multisysplex.help.doc/izuG00hpManageSecurityCredentials.html). +::: \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-components-of-URL.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-components-of-URL.md new file mode 100644 index 0000000000..e4f3d9c7d1 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-components-of-URL.md @@ -0,0 +1,100 @@ +# Components of a URL + +This page provides definitions and a diagram to make sure everyone is using the same terms. To maintain consistency of the structure of URLs, Zowe seeks to establish standards around URLs and the elements that make up a URL. This article presents the standard terminology used in Swagger documentation. + +## Definitions + +REST APIs have a _baseUrl_ to which the endpoint paths are appended. The base URL is defined by _scheme_, _host_, _port_ and _basePath_ + +where: + +- **`baseUrl`** +Specifies an absolute URL prefix that is different for each instance of the service, or when the service is accessed via the API Gateway. + +The endpoint paths are relative paths that follow the documentation of the REST API. + +- **`scheme`** +Specifies the transfer protocols used by the API. API ML supports the `http`, `https`, and WebSocket schemes - `ws` and `wss`. + +- **`host`** +Specifies the domain name or IP address (IPv4) of the host that serves the API. It may include the port number if it is different from the scheme's default port (80 for HTTP and 443 for HTTPS). Note that this must be the host only, without a scheme or sub-paths. + +- **`basePath`** +Specifies the URL prefix for all API paths, relative to the host root. It must start with a leading slash `/`. If basePath is not specified then all endpoint paths start at the host root. + +When a service is accessed without the API Gateway then the format the `basePath` depends on the service. It can be empty or have several parts (e.g. `/fileMasterPlus/api/v1`). + +When a service is accessed via the API Gateway, the format of the URL is standardized in one of the following formats: + +- Using `serviceId`, service type (`t`) and major version (`v`) +- Using `serviceId` and service type (`t`) + +where: + +- **`serviceId`** +Specifies a unique name of the service that is set during the installation of the service. + +- **`t`** +Specifies the type of the service. It can be `api`, `ui`, or `ws` + +- **`v`** +Specifies the major version the REST API. + + **Example:** `v1`, `v2`. It is optional since some existing services can have versioning in the endpoint path. + +The fundamental principle is that by changing the base URL you can access different services with the same API because the structure after the base URL is the same. + +The base URL is the parameter the can be set in Zowe CLI in order to access the service. The endpoint path is prepared by the Zowe CLI plug-in but the base URL needs to be provided by the user based on installation of the REST API service. + +## Examples + +### URL to a service endpoint without API gateway + +```markup +http://ca11.ca.com:19876/fileMasterPlus/api/v1/mvs/dataSets/test/ping +\_____/\_______________/\____________________/\_____________________/ +scheme host basePath endpointPath +\____________________________________________/ + baseUrl +``` + +### URL with empty basePath + +```markup +https://ca32.ca.com:1443/zosmf/info +\_____/\_______________/\_________/ +scheme host endpointPath +\______________________/ + baseUrl +``` + +### URL to a service endpoint via API gateway + +```markup +https://ca3x.ca.com:10310/cafilemasterplus/api/v1/mvs/dataSets/test/ping +\______/\_______________/\______________________/\_____________________/ +scheme host basePath endpointPath + \______________/\__/\/ + serviceId t v + +\_______________________________________________/ + baseUrl + +``` + +### URL to a service endpoint via API gateway without version + +```markup +https://ca3x.ca.com:10310/zosmfca32/api/zosmf/info +\_____/\________________/\____________/\_________/ +scheme host basePath endpointPath + \________/\_/ + serviceId t + +\______________________/ + baseUrl +``` + +### Resources + +- For more information, see the documentation for [swagger specifications](https://swagger.io/docs/specification/2-0/api-host-and-base-path/) in the Swagger product documentation. diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-identity-federation.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-identity-federation.md new file mode 100644 index 0000000000..118e859fb1 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-identity-federation.md @@ -0,0 +1,12 @@ +# Zowe API Mediation Layer - Identity Federation + +Zowe API ML is able to authenticate users when presented with an access token issued by another (external/distributed) Identity Access Management (IAM) system. +After the user is authenticated by API ML, the identity of the user encoded with the external access token is federated with the mainframe identity of the user if one exists. +The mainframe services then receive the mainframe user identity in the API requests as expected according to the configuration of each request. + +The Identity federation is based on the [SAF Identity Propagation mechanism](https://www.redbooks.ibm.com/redbooks/pdfs/sg247850.pdf). +The Identity Federation at the API ML level allows for complex deployments made of multiple mainframe systems representing individual security domains, each domain with dedicated API ML installations. +The mainframe domains can be also independent and detached. + +A prerequisite for the Identity Federation to work is that both external and mainframe user identities be mapped in SAF, and that the distributed identity provider must be trusted by the mainframe security manager. +See the configuration prerequisites in the [API ML OIDC Authentication](./api-mediation-oidc-authentication.md) article. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-infinispan.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-infinispan.md new file mode 100644 index 0000000000..15b69b37af --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-infinispan.md @@ -0,0 +1,72 @@ +# Using Infinispan as a storage solution through the Caching service + +As an API developer, you can configure Infinispan as a storage solution through the Caching service. This article describes how to configure your storage solution for Infinispan. +You can configure Infinispan for high availability as well as to replicate data to provide data durability and availability. + +- [Using Infinispan as a storage solution through the Caching service](#using-infinispan-as-a-storage-solution-through-the-caching-service) + - [Understanding Infinispan](#understanding-infinispan) + - [Infinispan replica instances](#infinispan-replica-instances) + - [Infinispan configuration](#infinispan-configuration) + +## Understanding Infinispan + +Infinispan is a storage solution that stores data structures in key-value pairs. The API Caching service uses hash sets, where each +service storing data via the Caching service has its own hash, and each data entry is a key-value entry within that service's Infinispan hash set. + +For more information on Infinispan, see the [official Infinispan documentation](https://infinispan.org/documentation/). + +### Infinispan replica instances + +Infinispan can be used with both a standalone instance and high availability mode. When using multiple Caching Service instances, +it is necessary to specify all of the cluster nodes (members). Each Infinispan node is bound to a specific Caching Service instance and runs on a different port and host, which can be configured. For more information about configuring multiple Infinispan modes, see the [Infinispan configuration](#infinispan-configuration). + +For more information on Infinispan replication and how to configure a replica instance, see the [Infinispan Cross-site Replication](https://infinispan.org/docs/stable/titles/xsite/xsite.html) documentation. + +## Infinispan configuration + +Configure Infinispan as a storage solution through the Caching service by setting the following configuration parameters in the `zowe.yaml`. + +* **`zowe.components.caching-service.storage.infinispan.initialHosts`** + + This property specifies the list of cluster nodes (members). In case of multiple instances, the value for each Caching Service instance can be + either a list of all the members, separated by a comma, or just the replica. The format is `${haInstance.hostname}[${zowe.components.caching-service.storage.infinispan.jgroups.port}]`. + +* **`zowe.components.caching-service.storage.infinispan.persistence.dataLocation`** + + The path where the Soft-Index store keeps its data files for the Infinispan Soft-Index Cache Store. + The default value is `data`. If you run the Caching Service in HA and the instances use the same filesystem, you have to specify a different value of the `CACHING_STORAGE_INFINISPAN_PERSISTENCE_DATALOCATION` property for each instance. For more information, see the [Soft-Index File Store](https://infinispan.org/blog/2014/10/31/soft-index-file-store). + + +* **`zowe.components.caching-service.storage.infinispan.jgroups.port`** + + The port number used by Infinispan to synchronise data among cahing-service instances. + + + **Example of Caching service HA configuration using Infinispan:** + + ```yaml + zowe + haInstances: + lpar1: + components: + caching-service: + storage: + mode: infinispan + infinispan: + initialHosts: lpar2[7099] + jgroups: + port: 7098 + persistence: + dataLocation: /global/zowe/workspace/caching-service/data01 + lpar2: + components: + caching-service: + storage: + mode: infinispan + infinispan: + initialHosts: lpar1[7098] + jgroups: + port: 7099 + persistence: + dataLocation: /global/zowe/workspace/caching-service/data02 + ``` \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-layer-development-setup.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-layer-development-setup.md new file mode 100644 index 0000000000..d20657e13f --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-layer-development-setup.md @@ -0,0 +1,14 @@ +# Deploy API Mediation Layer locally + +## General information + +For development purposes, it is possible to deploy API ML locally. For more information, follow the instruction in the file [Run API Mediation Layer locally](https://github.com/zowe/api-layer/?tab=readme-ov-file#run-api-mediation-layer-locally). + +## Dummy Authentication Provider + +The `Dummy Authentication Provider` implements simple authentication for development purposes using dummy credentials (username: `user`, password `user`). The `Dummy Authentication Provider` makes it possible for the API Gateway to run without authenticating with the z/OSMF service. + +Use the following property of the API Gateway to enable the `Dummy Authentication Provider`: +``` +components.gateway.security.auth.provider: dummy +``` diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-message-service.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-message-service.md new file mode 100644 index 0000000000..bd9d58b83f --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-message-service.md @@ -0,0 +1,175 @@ +# Using API Mediation Layer Message Service + +The API ML Message Service component unifies and stores REST API error messages and log messages in a single file. The Message Service component enables users to mitigate the problem of message definition redundancy which helps to optimize the development process. + + - [Message Definition](#message-definition) + - [Creating a message](#creating-a-message) + - [Mapping a message](#mapping-a-message) + - [API ML Logger](#api-ml-logger) + +## Message Definition + +API ML uses a customizable infrastructure to format both REST API error messages and log messages. `yaml` files make it possible to centralize both API error messages and log messages. Messages have the following definitions: + +- Message `key` - a unique ID in the form of a dot-delimited string that describes the reason for the message. The `key` enables the UI or the console to show a meaningful and localized message. + + :::tip Tips: + - We recommend using the format `org.zowe.sample.apiservice.{TYPE}.greeting.empty` to define the message key. `{TYPE}` can be the api or log keyword. + - Use the message `key` and not the message `number`. The message `number` makes the code less readable, and increases the possibility of errors when renumbering values inside the `number`. + ::: +- Message `number` - a typical mainframe message ID (excluding the severity code) + +- Message `type` - There are two Massage types: + - REST API error messages: `ERROR` + - Log messages: `ERROR`, `WARNING`, `INFO`, `DEBUG`, or `TRACE` + +- Message `text` - a description of the issue +- Message `reason` - A reason for why this issue occured +- Message `action` - What should I as a user do to correct the problem + +The following example shows the message definition. + +**Example:** + +```yaml +messages: + - key: org.zowe.sample.apiservice.{TYPE}.greeting.empty + number: ZWEASA001 + type: ERROR + text: "The provided '%s' name is empty." + reason: "There is no value in the name" + action: "Please fill the name with value" +``` + +## Creating a message + +Use the following classes when you create a message: + +- `org.zowe.apiml.message.core.MessageService` - lets you create a message from a file. +- `org.zowe.apiml.message.yaml.YamlMessageService` - implements `org.zowe.apiml.message.core.MessageService` so that `org.zowe.apiml.message.yaml.YamlMessageService` can read message information from a `yaml` file, and create a message with message parameters. + +Use the following process to create a message. + +**Follow these steps:** + +1. Load messages from the `yaml` file. + + **Example:** + + ```java + MessageService messageService = new YamlMessageService(); + messageService.loadMessages("/api-messages.yml"); + messageService.loadMessages("/log-messages.yml"); + ``` + +2. Use the `Message createMessage(String key, Object... parameters);` method to create a message. + + **Example:** + + ```java + Message message = messageService.createMessage("org.zowe.sample.apiservice.{TYPE}.greeting.empty", "test"); + ``` + +## Mapping a message + +You can map the `Message` either to a REST API response or to a log message. + +When you map a REST API response, use the following methods: + +- `mapToView` - returns a UI model as a list of API Message, and can be used for Rest API error messages +- `mapToApiMessage` - returns a UI model as a single API Message + +The following example is a result of using the `mapToView` method. + +**Example:** + +```JSON +{ +"messages": [ + { + "messageKey": "org.zowe.sample.apiservice.{TYPE}.greeting.empty", + "messageType": "ERROR", + "messageNumber": "ZWEASA001", + "messageContent": "The provided 'test' name is empty.", + "messageReason": "There is no value in the name", + "messageAction": "Please fill the name with value" + } + ] +} +``` +The following example is the result of using the `mapToApiMessage` method. + +**Example:** + +```JSON +{ + "messageKey": "org.zowe.sample.apiservice.{TYPE}.greeting.empty", + "messageType": "ERROR", + "messageNumber": "ZWEASA001", + "messageContent": "The provided 'test' name is empty.", + "messageReason": "There is no value in the name", + "messageAction": "Please fill the name with value" +} +``` + +### API ML Logger + +The `org.zowe.apiml.message.log.ApimLogger` component controls messages through the Message Service component. + +The following example uses the `log` message definition in a `yaml` file. + +**Example:** + +```yaml +messages: + - key: org.zowe.sample.apiservice.log.greeting.empty + number: ZWEASA001 + type: DEBUG + text: "The provided '%s' name is empty." + reason: "There is no value in the name" + action: "Please fill the name with value" +``` + +When you map a log message, use `mapToLogMessage` to return a log message as text. +The following example is the output of the `mapToLogMessage`. + +**Example:** + +``` +ZWEASA001D The provided ‘test’ name is empty. {43abb594-3415-4ed5-a0b5-23e306a91124} +``` + +Use the `ApimlLogger` to log messages which are defined in the yaml file. + +**Example:** + +```java +package org.zowe.apiml.client.configuration; + +import org.zowe.apiml.message.core.MessageService; +import org.zowe.apiml.message.core.MessageType; +import org.zowe.apiml.message.log.ApimlLogger; + +public class SampleClass { + + private final ApimlLogger logger; + + public SampleClass(MessageService messageService) { + logger = ApimlLogger.of(SampleClass.class, messageService); + } + + public void process() { + logger.log(“org.zowe.sample.apiservice.log.greeting.empty”, “test”); + + } + +} +``` + +The following example shows the output of a successful `ApimlLogger` usage. + +**Example:** + +```shell +DEBUG (c.c.m.c.c.SampleClass) ZWEASA001D The provided 'test' name is empty. {43abb594-3415-4ed5-a0b5-23e306a91124} +``` diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-oidc-authentication.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-oidc-authentication.md new file mode 100644 index 0000000000..8b086e4fe0 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-oidc-authentication.md @@ -0,0 +1,188 @@ +# Authenticating with OIDC + +:::info Required roles: system administrator, security administrator +::: + +The OpenID/Connect ([OIDC](https://openid.net/specs/openid-connect-core-1_0.html)) protocol adds an authentication layer on top of the [OAuth2](https://www.rfc-editor.org/rfc/rfc6749) Authorization protocol. + +OIDC authentication, together with the z/OS [Identity Propagation](https://www.redbooks.ibm.com/redbooks/pdfs/sg247850.pdf) mechanism, is the foundation of the API ML Identity Federation. +In this article, OIDC is often referred to as the provider, while the token-related functionality is actually provided by the OAuth2 component of the OIDC implementation. + +You can configure Zowe API ML to authenticate users by accepting Access Tokens issued by an external OIDC/OAuth2 provider. +This configuration is useful in advanced deployments of Zowe where client applications need to access mainframe as well as enterprise/distributed systems while simultaneously offering single sign-on (SSO) across system boundaries. + +This article details the API ML OIDC authentication functionality, and how to configure the OIDC Authentication feature. + +:::note +The OIDC feature is currently unavailable on ACF2 systems. +::: + +- [Usage](#usage) +- [Authentication flow](#authentication-flow) +- [Prerequisites](#prerequisites) + - [OIDC provider](#oidc-provider) + - [ESM configuration](#esm-configuration) +- [API ML configuration](#api-ml-oidc-configuration) +- [Troubleshooting](#troubleshooting) + +## Usage + +The OIDC protocol is used by API ML client applications to verify the identity of a user with a distributed OIDC provider trusted by the mainframe security manager. +After successful user login, the OIDC provider grants the client application a JWT Access Token along with an (JWT) Identity Token. +The client application can pass this Access Token with subsequent requests to mainframe services routed through the API ML Gateway. +The API ML Gateway then validates the OIDC Access Token. If the token is valid, the user identity from that token is mapped to the mainframe identity of the user. +The API ML Gateway can then create mainframe user credentials (JWT or a PassTicket) according to the service's authentication schema configuration. +The request is routed to the target API services with correct mainframe user credentials. + +## Authentication Flow + +The following diagram illustrates the interactions between the participants of the OIDC/OAuth2 based API ML authentication process. + +![APIML OIDC Workflow](../../images/api-mediation/apiml-oidc-auth-seq.png) + +- When a user wants to access mainframe resources or services using the client application without valid authentication or an access token, the client redirects the user agent to the login end-point of the distributed OIDC provider. +- The user is asked to provide valid credentials (authentication factors). +- After successful validation of all authentication factors, the OIDC provider grants the client an Access Token. +- The client can then request from API ML Gateway the needed mainframe resources presenting the access token in the request. +- The Gateway validates the access token by comparing the key id of the token against the key ids obtained from the authorization server's JWK keys endpoint. +- The URL to the specific authorization server's JWK keys endpoint should be set using the property `jwks_uri`. If the access token is validated, the outcome is cached for a short time (20 sec by default). +- The JWK Keys obtained from the authorization server's endpoint are cached for a while to prevent repeated calls to the endpoint. The interval can be set using the property `jwks.refreshInternalHours` (The default value is one hour). +- In subsequent calls with the same token, the Gateway reuses the cached validation outcome. As such, round trips to the OIDC authorization server for JWK keys and JWT Token validation are not required between short intervals when the client needs to access multiple resources in a row to complete a unit of work. +- The caching interval is configurable with a default value of 20 seconds, which is typically a sufficient amount of time to allow most client operations requiring multiple API requests to complete, while also providing adequate protection against unauthorized access. +- The API ML Gateway fetches the distributed user identity from the distributed access token and maps this user identity to the user mainframe identity using SAF. +- The API ML Gateway calls the requested mainframe service/s with mainframe user credentials (Zowe, SAF JWT, or PassTicket) which are expected by the target mainframe service. + +## Prerequisites + +Ensure that the following prerequisites are met: + +- Users who require access to mainframe resources using OIDC authentication have a mainframe identity managed by SAF/ESM. +- Client application users have their distributed identity managed by the OIDC provider. For details, see the section [OIDC provider](#oidc-provider) in this topic. +- SAF/ESM is configured with mapping between the mainframe and distributed user identities. For details, see the section [ESM configuration](#esm-configuration) in this topic. +- ZSS must be enabled and properly configured in the Zowe installation. + +### OIDC provider + +- Client Application configuration in the OIDC provider. + + Depending on the OIDC provider and client application capabilities, configuration of the OIDC provider varies. +For example, web applications with a secure server side component can use `code grant authorization flow` and can be granted a Refresh Token, whereas a Single Page Application running entirely in the User Agent (browser) is more limited regarding its security capabilities. + + :::tip + Consult your OIDC provider documentation for options and requirements available for your type of client application. + ::: + +- Users have been assigned to the Client Application. + + To access mainframe resources, users with a distributed authentication must either be directly assigned by the OIDC provider to the client application, or must be part of group which is allowed to work with the client application. + +### ESM configuration + +The user identity mapping is defined as a distributed user identity filter, which is maintained by the System Authorization Facility (SAF) / External Security Manager (ESM). +A distributed identity consists of two parts: +- A distributed identity name +- A trusted registry which governs that identity + +API ML provides a Zowe CLI plugin to help administrators generate a JCL for creating the mapping filter specific for the ESM installed on the target mainframe system. + + See the [Identity Federation cli plugin](../../user-guide/cli-idfplugin.md) documentation for details about how to use the plugin tool to set up the mapping in the ESM of your z/OS system. + +Alternatively, administrators can use the installed ESM functionality to create, delete, list, and query a distributed identity filter/s: + +- For RACF, consult the [RACMAP command](https://www.ibm.com/docs/en/zos/2.3.0?topic=rcs-racmap-create-delete-list-query-distributed-identity-filter). +- For CA Top Secret, use the [IDMAP Keyword - Implement z/OS Identity Propagation Mapping](https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-top-secret-for-z-os/16-0/administrating/issuing-commands-to-communicate-administrative-requirements/keywords/idmap-keyword-implement-z-os-identity-propagation-mapping.html). +- For CA ACF2, use [IDMAP User Profile Data Records](https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-acf2-for-z-os/16-0/administrating/administer-records/user-profile-records/idmap-user-profile-records.html). + +## API ML OIDC configuration + +Use the following procedure to enable the feature to use an OIDC Access Token as the method of authentication for the API Mediation Layer Gateway. + +:::tip +You can leverage the Zowe CLI Identity Federation (IDF) Plug-in for Zowe CLI to extend Zowe CLI to make it easier to map mainframe users with an identity provided by an external identity provider. +The Plug-in is designed to work with the ESMs: IBM RACF, Broadcom ACF2, and Broadcom Top Secret. + +For more information about the Zowe CLI Identity Federation Plug-in, see the [README file in the api-layer repo](https://github.com/zowe/api-layer/edit/v3.x.x/zowe-cli-id-federation-plugin/README.md). +::: + + In the zowe.yaml file, configure the following properties: + +- **`components.gateway.apiml.security.oidc.enabled`** + Specifies the global feature toggle. Set the value to `true` to enable OIDC authentication functionality. + +- **`components.gateway.apiml.security.oidc.registry`** + Specifies the SAF registry used to group the identities recognized as having a OIDC identity mapping. The registry name is the string used during the creation of the mapping between the dustributed and mainframe user identities. For more information, see the [ESM configuration](#esm-configuration). + +- **`components.gateway.apiml.security.oidc.jwks.uri`** + Specifies the URI obtained from the authorization server's metadata where the Gateway will query for the JWK used to sign and verify the access tokens. + +- **`components.gateway.apiml.security.oidc.jwks.refreshInternalHours`** + Specifies the frequency in hours to refresh the JWK keys from the OIDC provider. Defaults to one hour. + +- **`components.gateway.apiml.security.oidc.identityMapperUser`** + (Optional) If the userId is different from the default Zowe runtime userId (`ZWESVUSR`), specify the `identityMapperUser` userId to configure API ML access to the external user identity mapper. + + **Note:** User authorization is required to use the `IRR.RUSERMAP` resource within the `FACILITY` class. The default value is `ZWESVUSR`. Permissions are set up during installation with the `ZWESECUR` JCL or workflow. To authenticate to the mapping API, a JWT is sent with the request. The token represents the user that is configured with this property. + +- **`apiml.security.oidc.identityMapperUrl`** + Defines the URL where the Gateway can query the mapping of the distributed user ID to the mainframe user ID. + This property informs the Gateway about the location of this API. ZSS is the default API provider in Zowe. You can provide your own API to perform the mapping. In this case, it is necessary to customize this value. + + The following URL is the default value for Zowe and ZSS: + + ``` + https://${ZWE_haInstance_hostname}:${GATEWAY_PORT}/zss/api/v1/certificate/dn + ``` + +## Troubleshooting + +### API ML fails to validate the OIDC access token with the Distributed Identity Provider + +**Symptom** +The Gateway log contains the following ERROR message: +`Failed to validate the OIDC access token. Unexpected response: XXX.` + +- **_XXX_** +is the HTTP status code returned by the Identity Provider. + +**Explanation** +The HTTP code is one of the 40X variants that provides the reason for the failure. + +**Solution** + +Correct the Gateway configuration according to the code returned by the OIDC Identity Provider. + +### The access token validation fails with HTTP error + +**Symptom** + +The OIDC provider returns an HTTP 40x error code. + +**Explanation** + +The client application is not properly configured in the API ML Gateway. + +**Solution** +Check that the URL `jwks_uri` contains the key for OIDC token validation. + + +:::tip +API ML Gateway exposes a validate token operation which is suitable during the OIDC setup. The call to the endpoint `/gateway/api/v1/auth/oidc-token/validate` verifies if the OIDC token is trusted by API ML. Note that the Gateway service does not perform the mapping request to the ESM when the `/gateway/api/v1/auth/oidc-token/validate` endpoint is called. + +Use the following curl command to make a REST request with the OIDC token to the validate token endpoint: +```shell +curl --location 'https://"$HOSTNAME:$PORT"/gateway/api/v1/auth/oidc-token/validate --data '{"token": "$OIDC_TOKEN","serviceId": "$SERVICE_ID"}' +``` +An HTTP `200` code is returned if the validation passes. Failure to validate returns an HTTP `40x` error. +::: + +:::note Azure Entra ID OIDC notes: +API ML uses the `sub` claim of the ID Token to identify the user, and to map to the mainframe account. Note that the structure of the `sub` claim varies between the Azure token and the OKTA ID token: +* The Azure token `sub` is an alphanumeric value. +For more information, see the topic _Use claims to reliably identify a user_ in the Microsoft Learn documentation. +* The OKTA ID token has an email in the `sub` claim. + +For more information about Entra ID token format see _ID token claims reference_ in the Microsoft documentation. +::: + + + diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-passtickets.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-passtickets.md new file mode 100644 index 0000000000..bf06738235 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-passtickets.md @@ -0,0 +1,7 @@ +# This article was changed and moved + +The information that used to be in the article **Configuring Zowe to use PassTickets** has been reorganized and is available in following articles: + +- For detailed information about configuring Zowe to use PassTickets, and to enable Zowe to use PassTickets to authenticate towards specific extending services, see [Enabling single sign on for extending services via PassTicket configuration](https://docs.zowe.org/stable/user-guide/api-mediation/configuration-extender-passtickets). + +- For detailed information about authentication parameters to enable a service to accept a Zowe JWT or client certificate, see [Authentication for API ML services](https://docs.zowe.org/stable/extend/extend-apiml/authentication-for-apiml-services#authentication-parameters). diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-redis.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-redis.md new file mode 100644 index 0000000000..2bf851af6e --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-redis.md @@ -0,0 +1,94 @@ +# Using Redis as a storage solution through the Caching service + +As an API developer, you can configure Redis as a storage solution through the Caching service. This article describes how to configure your storage solution for Redis. +You can configure Redis for high availability as well as to replicate data to provide data durability and availability. + +- [Understanding Redis](#understanding-redis) +- [Redis configuration](#redis-configuration) + +## Understanding Redis + +Redis is an off-Z storage solution that stores data structures in key-value pairs. The API Caching service uses hash sets, where each +service storing data via the Caching service has its own hash, and each data entry is a key-value entry within that service's Redis hash set. + +For more information on Redis, see the [official Redis documentation](https://redis.io/documentation). + +### Redis replica instances + +Redis can be used with one standalone instance. For data durability, however, a master/replica configuration is recommended. +Redis replicas automatically connect, and re-connect when necessary, to the master Redis instance and attempt to be an exact copy of the master. + +For more information on Redis replication and how to configure a replica instance, see the [official Redis Replication documentation](https://redis.io/topics/replication). + +### Redis Sentinel + +Redis Sentinel is a configuration that provides high availability for Redis master/replica instances. +Sentinel instances are used to monitor the master instance and use a quorum to automatically determine if a failover procedure needs to occur from a master instance to one of its replicas. + +For more information on Redis Sentinel and how to configure Sentinel instances with master/replica instances, see the [official Redis Sentinel documentation](https://redis.io/topics/replication). + +### Redis SSL/TLS + +Redis supports SSL/TLS starting in version 6. For information on enabled SSL/TLS with Redis, see the [official Redis TLS Support documentation](https://redis.io/topics/replication). + +### Redis and Lettuce + +The [Lettuce](https://lettuce.io/) library is used to connect to Redis. Lettuce uses Master or Sentinel node registration information to automatically discover other instances. +The IP address used to register between nodes is therefore what Lettuce uses to connect to downstream replica instances. This means the IP address of replica instances, +or the IP address of both master and replica instances in the case of Sentinel topology, must be accessible to the Caching service. For example, in a master/replica topology running +in separate Docker containers, the replica container's IP address needs to be accessible to the Caching service, rather than only exposing a port. + +## Redis configuration + +Configure Redis as a storage solution through the Caching service by setting the following environment variables. Environment variables can be set by adding them to the `zowe.components.caching-service` section of the `zowe.yaml` configuration file. + +* **`storage.redis.masterNodeUri`** + + The URI used to connect to the Redis master instance in the form `username:password@host:port`. + + * The host section of the URI is mandatory + * The port section is optional and if not included defaults to `6379`. + * The username section is optional and if not included defaults to the Redis default username `default`. + * The password section is optional, but must be included if a username is included. If the password is not set a username cannot be set. + +* **`storage.redis.timeout`** + + The timeout duration in seconds for the Caching service when first connecting to Redis. Defaults to 60 seconds. + +* **`storage.redis.sentinel.enabled`** + + A flag indicating if Redis is being used with Redis Sentinel instances. Defaults to `false`. + +* **`storage.redis.sentinel.masterInstance`** + + The Redis master instance ID used by the Redis Sentinel instances. Required if Redis Sentinel is being used. + +* **`storage.redix.sentinel.nodes`** + + The URI used to connect to a Redis Sentinel instance in the form `username:password@host:port`. + + * The host section of the URI is mandatory + * The port section is optional and if not included defaults to `6379`. + * The password section is optional and defaults to no password. + + To supply multiple Redis Sentinel URIs, concatenate the URIs with a comma `,`. + +* **`storage.redix.ssl.enabled`** + + A flag indicating if Redis is being used with SSL/TLS support. Defaults to `true`. + +* **`storage.redis.ssl.keystore`** + + The keystore file used to store the private key. Defaults to the Caching Service's keystore. + +* **`storage.redis.ssl.keystorePassword`** + + The password used to unlock the keystore. Defaults to the Caching Service's keystore password. + +* **`storage.redis.ssl.truststore`** + + The truststore file used to keep other parties public keys and certificates. Defaults to the Caching Service's truststore. + +* **`storage.redix.ssl.truststorePassword`** + + The password used to unlock the truststore. Defaults to the Caching Service's truststore password. diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-routing.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-routing.md new file mode 100644 index 0000000000..bd7d41362a --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-routing.md @@ -0,0 +1,110 @@ +# API Mediation Layer routing + +As an application developer, you can route your service through the Gateway using the API Mediation Layer to consume a specific resource. + +There are two ways to route your service to the API Mediation Layer: + +* Basic Routing (using Service ID and version) +* Basic Routing (using only the service ID) + +## Terminology + +* **Service** + + A service provides one or more APIs, and is identified by a service ID. Note that sometimes the term "service name" is used to mean service ID. + + The default service ID is provided by the service developer in the service configuration file. + + A system administrator can replace the service ID with a deployment environment specific name using additional configuration that is external to the service deployment unit. Most often, this is configured in a JAR or WAR file. + + Services are deployed using one or more service instances, which share the same service ID and implementation. + +* **URI (Uniform Resource Identifier)** + + A string of characters used to identify a resource. Each URI must point to a single corresponding resource that does not require any additional information, such as HTTP headers. + +## APIML Basic Routing (using Service ID and version) + +This method of basic routing is based on the service ID that identifies the service. The specific instance is selected by the API Gateway. All instances require an identical response. Eureka and Zuul expect this type of routing. + +The URI identifies the resource, but does not identify the instance of the service as unique when multiple instances of the same service are provided. For example, when a service is running in high-availability (HA) mode. + +Services of the same product that provide different resources, such as SYSVIEW on one system and SYSVIEW in a different sysplex, cannot have the same service ID (the same URI cannot have two different meanings). + +In addition to the basic Zuul routing, the Zowe API Gateway supports versioning in which you can specify a major version. The Gateway routes a request only to an instance that provides the specified major version of the API. + +The `/api/` prefix is used for REST APIs. The prefix `/ui/` applies to web UIs and the prefix `/ws/` applies to [WebSockets](websocket.md). + +You can implement additional routing using a Zuul pre-filter. For more information about how to implement a Zuul filter, see [Router and Filter: Zuul](https://cloud.spring.io/spring-cloud-netflix/multi/multi__router_and_filter_zuul.html) + +The URL format expected by the API Gateway is: + +`https://{gatewayHost}:{port}/{serviceId}/api/v{majorVersion}/{resource}` + +**Example:** + +The following address shows the original URL of a resource exposed by a service: + +``` +http://service:10015/enablerv1sampleapp/api/v1/samples +``` + +The following address shows the API Gateway URL of the resource: + +``` +https://gateway:10010/enablerv1sampleapp/api/v1/samples +``` + +The following diagram illustrates how basic routing works: + +Zowe API Mediation basic routing + +### Implementation Details + +Service instances provide information about routing to the API Gateway via Eureka metadata. + +**Example:** + + metadata-map: + apiml: + routes: + ui_v1: + gatewayUrl: "ui/v1" + serviceUrl: "/helloworld" + api_v1: + gatewayUrl: "api/v1" + serviceUrl: "/helloworld/v1" + api_v2: + gatewayUrl: "api/v2" + serviceUrl: "/helloworld/v2" + +In this example, the service has a service ID of `helloworldservice` that exposes the following endpoints: + +* **UI** - `https://gateway/helloworldservice/ui/v1` routed to `https://hwServiceHost:port/helloworld/` +* **API major version 1** - `https://gateway/helloworldservice/api/v1` routed to `https://hwServiceHost:port/helloworld/v1` +* **API major version 2** - `https://gateway/helloworldservice/api/v2` routed to `https://hwServiceHost:port/helloworld/v2` + +where: + +* The gatewayUrl is matched against the prefix of the URL path used at the Gateway `https://gateway/urlPath`, where `urlPath` is `serviceId/prefix/resourcePath`. +* The service ID is used to find the service host and port. +* The `serviceUrl` is used to prefix the `resourcePath` at the service host. + +**Note:** The service ID is not included in the routing metadata, but the service ID is in the basic Eureka metadata. + +## Basic Routing (using only the service ID) + +This method of routing is similar to the previous method, but does not use the version part of the URL. This approach is useful for services that handle versioning themselves with different granularity. + +One example that only uses a service ID is z/OSMF. + +**Example:** + +z/OSMF URL through the Gateway: `https://gateway:10010/zosmf/api/restjobs/jobs/...` + +where: + +* `zosmf` is the service ID. +* `/restjobs/1.0/...` is the rest of the endpoint segment. + +Note that no version is specified in this URL. diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-versioning.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-versioning.md new file mode 100644 index 0000000000..dab593e30a --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-versioning.md @@ -0,0 +1,134 @@ +# API Versioning + + The _API Catalog_ is the catalog of published API services and their associated documentation that have been + discovered or might get available if provisioned from the service catalog. + + _Application program interface (API)_ is a set of functions and procedures that allow the creation + of applications which access the features or data of other applications, service, or systems. + + Our API Catalog contains APIs of services provided by implementations of mainframe products. Service can + be implemented by one or more service instances (that provide exactly the same service for + high-availability or scalability). + + ### Versioning + + APIs are versioned. Users of the API specify the major version (`v1`, `v2`). Backward incompatible + changes can be introduced only with changing major version. The service can provide multiple + versions of the API (it should provide `v{n}` and previous `v{n-1}` versions). + + ### REST + + In our case, we are speaking about REST APIs, which is a way how to access and manipulate textual + representations of Web resources using uniform and a predefined set of stateless operations. + Usually via HTTP(S) protocol and using JSON format. Resources are identified by their Uniform + Resource Identifier (URIs). The services are accessed via APIML gateway. Example of a URI: + `https://host:10010/endevormfno/api/v1/ENWSQA01/packages/PACKAGETST + (https://{gatewayHost}:{port}/{serviceName}/api/v{majorVersion}/{resource}`) + See [Components of URL](../extend-apiml/api-mediation-components-of-URL.md) for more information about the URL components of REST APIs. + + ## Data Model + + The following data model describes the model behind data about APIs and API services in the API Catalog. + The most of the data are provided during service registration. In case of the dynamic registration they are + provided by the service. Some of them are determined by the service developer (API-related), system + administrator (service-related), and some of them can be altered by user (catalog tiles - in + future). + + ![API Class Diagram](../../images/api-mediation/API-Class-Diagram.png) + + _(this a [UML class diagram](https://en.wikipedia.org/wiki/Class_diagram))_ + + * **Catalog Tile** + The API Catalog UI groups API services into tiles. An API service can be in multiple tiles. The + purpose of titles is to organize API services on the dashboard of the API Catalog. Default catalog tiles + are constructed from the definitions provided by the services. In future, it will be possible for + the user to modify the tiles. + + * **API** + An _Api_ object represents a collection of specific versions of the same API which share the + same _apiId_. + + * **API Version** + Specifies the version of the API. This version can be documented by an + external documentation or by a Swagger document. This information is set by the developer of the API. + + * **Swagger** + The Swagger specification instance for a specific API version. See + https://swagger.io/docs/specification/ for more details. + + * **API Association** + Information how a specific API version is provided by a specific + service. Different services can use different basePath. The full path to access endpoints is: + `scheme://host:port/basePath/endpointPath`. This information is set by the service developer. + + * **Service** + Represents a collection of all service instances. The description and title are taken + from the service with highest version, in case if this is not clear then the latest registered + wins. API clients are using a service and the API gateway chooses what service instance will be + accessed. The same API version can be implemented by multiple services. Such services are not + interchangeable because they contain or access different data. + + * **Service instance** + The implementation of a service. It contains the information about where + service is running. The information are provided by the system programmer. The default title and + description is provided by service developer. Instances are interchangeable and they are used to + achieve high availability. + + * **Route** + Specifies how service URLs are mapped to the gateway. The Gateway translates + a URL based on the start of the base path on the gateway, and translates it to a base path that is + used in the URL to access the service. The purpose is to make possible to access services via the + gateway with a consistent URL format no matter what is the format at the service. + + * **Version** + Type follows semantic versioning (http://semver.org/) and is used on multiple places. + + ### Service and instance + + _Service_ and _instance_ are overloaded words that have a different meaning in different contexts. + This document uses similar meaning as in (Netflix) Eureka discovery service. Service (or + application) is a logical entity that is comprised of functionality to access and manipulate + specific resources. Instances are real processes (servers) that provide that functionality to + clients. Eureka is used in distributed software world where a service is implemented by many + instances. But z/OSMF software services registry defines software service instance and software + service templates in the context of the provisioning where "instances" are provisioned from + "templates". z/OSMF service instance does not need to correspond exactly to Eureka service. z/OSMF + service instance does need to provide REST API. z/OSMF service instance can be anything that can be + provisioned (e.g. multiple services that provide REST API, one API service, additional instance for + a service, just a container for other services, a database server, a database, a table...). + + ## API Versioning + + Service instances provide one or more different API versions (we take only one assumption: one + service instance will not provide two versions with the same major version, no other assumptions + which versions will be provided and how - e.g. an instance can provide only one version and another + version will be provided by different instance, other services can have instances that provide + multiple versions). + + The API user specifies only the major version in the URI. The API catalog needs to differentiate + between different _full versions_ internally and able to return a specific full version or return + documentation for the highest version of the specified major version that is supported by all + running services. + + **Guidelines:** + +- The version of the API, not dependent on the product release + +- Two last versions are supported + + - Major version - specified by the user of the API in the URI - increased only when backward + incompatible change is introduced (it is rare because the REST APIs should be designed to allow + extensibility) + + - Minor version - not specified in the URI but the user should know what is it, important to + display the correct level of documentation. Increased when the API is extended with a new feature + (if you use a new resource available in v1.2, the service has to provide at least v1.2, the request + fails on v1.1). If there are multiple instances of the services that have different minor versions, + the service together will say that has the lowest minor version (e.g instance A provide v1.3 and + v2.2, instance B was not yet upgraded and provides v1.2 and v2.1, then the service provides v1.2 + and v2.1) + + - Patch version - not specified in the URI, no difference in the API, used only when the API + documentation is patched or a bug was fixed, there is no change in the API + + ![API Versioning](../../images/api-mediation/API-Versioning.png) diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-vsam.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-vsam.md new file mode 100644 index 0000000000..837de1e7ab --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-vsam.md @@ -0,0 +1,68 @@ +# Using VSAM as a storage solution through the Caching service + +As an API developer, you can configure VSAM as a storage solution through the Caching service. The procedure in this article +describes how to configure your storage solution for VSAM. Configuring VSAM ensures that you do not lose data if you need to restart. Configuring VSAM also makes it possible to leverage multiple caching services concurrently, whereby clients can retreive data through VSAM. + +- [Understanding VSAM](#understanding-vsam) +- [VSAM configuration](#vsam-configuration) +- [VSAM performance](#vsam-performance) +## Understanding VSAM + +`Virtual Storage Access Method (VSAM)` is both a data set type, and a method for accessing various user data types. +Using VSAM as an access method makes it possible to maintain disk records in a unique format that is not understandable by other access methods. +VSAM is used primarily for applications, and is not used for source programs, JCL, or executable modules. ISPF cannot be used to display or edit VSAM files. VSAM can be used to organize records into four types of data sets: key-sequenced, entry-sequenced, linear, or relative record. The +API Caching service supports VSAM as a storage method to cache APIs, and uses the `Key Sequence Data Set (KSDS)` dataset. Each record has one or more key fields, and a record can be retrieved (or inserted) by the key value, thereby providing random access to data. Records are of variable length. IMS™ uses KDSDs. + +For more information about VSAM, see the [IBM documentation](https://www.ibm.com/support/knowledgecenter/zosbasics/com.ibm.zos.zconcepts/zconcepts_169.htm). + +### VSAM configuration + +Configure VSAM as a storage solution through the Caching service by modifying the following configuration parameters in `zowe.components.caching-service` in `zowe.yaml`. + +* **`storage.vsam.name`** + + The ZFile filename. The ZFile is a wrapper around a z/OS file based on the supplied name and options. This method calls the fopen() and fldata() C-library routines. The ZFile filename should follow the specific naming convention `//'DATASET.NAME'`. + +* **`storage.vsam.keyLength`** + + The VsamKey length. The default value is 128 bytes. + +* **`storage.vsam.recordLength`** + + The record length. The default value is 4096 bytes. + +* **`storage.vsam.encoding`** + + The character encoding. The default value is IBM-1047. + +### VSAM performance + +Accessing VSAM via java results in a performance limitation. The VSAM solution has been tested in a few scenarios. + +The following sequence describes the test process: +1. Load 1000 records into the cache concurrently (5 threads). +2. Update all records for 120 seconds with increasing the thread count, up to `` amount of threads. +3. Read all records for 120 seconds with increasing the thread count, up to `` amount of threads. +4. Read and update all records for 120 seconds with increasing the thread count, up to `` amount of threads. +5. Delete all loaded records from the cache concurrently (5 threads). + +Tests were run with 3 scenarios: +- Low load: 5 threads +- Medium load: 15 threads +- High load: 50 threads + +Test subjects: +- Single Caching Service with VSAM storage +- Two Caching Services with shared VSAM storage + +Results: +- The most important operation is `READ`. +- Two Caching Services achieve better `READ` performance than a single Caching Service. +- Based on data from the testing results, the `READ` performance appears to be acceptable, ranging from 300 ms to 1000 ms. +- With two Caching Services and a high load, `READ` performance significantly increased. +- Response times of other operations are also acceptable, yet error rates increase with higher concurrency. +- Two Caching Services produce higher load on shared resource (VSAM) and have higher error rate. +- VSAM implemetation appears to be sufficient for user-based workloads. For light automation workloads VSAM implementation appears to be acceptable as well. For heavy workloads this implementatin may not be sufficient. +- VSAM does not scale well beyond 1000 RPM on a node. + + diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-websockets.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-websockets.md new file mode 100644 index 0000000000..31992e184c --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/api-mediation-websockets.md @@ -0,0 +1,32 @@ +# Routing Websocket based APIs + +It is possible to route WebSocket APIs through the API Mediation Layer. For details about Websocket routing from the client side, see [Routing with websockets](../../user-guide/routing-with-websockets.md). + +To accept Websockets, it is necessary that the API Mediation Layer know that a Websocket connection is required. This is done when the issuer of the call adds the `(/ws/...)` prefix in the URL of the called API. + +**Example:** +The following is an example of a valid URL for a Websocket API. + +`https://gatewayUrl/exampleService/ws/v1/communicate` + +## Configuring the service for Websockets + +The configuration relevant for Websockets is contained within the routes section in the configuration. A complete example using a WebSocket that is statically onboarded is available in the [API ML repo](https://github.com/zowe/api-layer/blob/567c261bbe3e8702b62cdbc73afcdf0afa847a8b/config/docker/api-defs/staticclient.yml#L66). + +**Example:** +``` +services: + - serviceId: staticclient2 + routes: + - gatewayUrl: ws/v1 + serviceRelativeUrl: /ws +``` + +The `ws` in the beginning of the Gateway URL provides the notification that it is a WebSocket connection, and will be treated as such. + +:::note +The `serviceRelativeUrl` is customizable and does not have to contain `ws`. + +**Example:** +It is possible to access via the URL `https://gatewayUrl/exampleService/ws/v1/communicate` on the actual server that would appear as the URL `https://serverUrl/exampleService/ui/communicate`. +::: \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/authentication-for-apiml-services.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/authentication-for-apiml-services.md new file mode 100644 index 0000000000..fa3b6d81ef --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/authentication-for-apiml-services.md @@ -0,0 +1,159 @@ +# Authentication for API ML services + +Review how services of the API Mediation Layer address authentication. + +- [Services of API Mediation Layer](#services-of-api-mediation-layer) +- [Authentication endpoints](#authentication-endpoints) +- [Supported authentication methods](#supported-authentication-methods) +- [Discovery Service authentication](#discovery-service-authentication) + + +:::tip +For information about authentication providers that handle authentication for the API Gateway, see [Authentication providers for API Mediation Layer](../../user-guide/authentication-providers-for-apiml.md). +::: + +## Services of API Mediation Layer + +- **API Gateway** + + - The API Gateway handles authentication + - There are two authentication endpoints that allow authentication of the resource by providers + - Diagnostic endpoints `https://{gatewayUrl}:{gatewayPort}/application/**` in API Gateway are protected by basic authentication, Zowe JWT token, or a client certificate + +- **API Catalog** + + - API Catalog is accessed by users and requires a login + - Protected access is performed by the Authentication and Authorization Service + +- **Discovery Service** + + - Discovery Service is accessed by API Services + - This access (reading information and registration) requires protection by means of a client certificate + - (Optional) Access can be granted to users (administrators) + - Diagnostic endpoints `https://{gatewayUrl}:{gatewayPort}/application/**` in Discovery Service are protected by basic authentication, Zowe JWT token, or a client certificate + +- **API Services** + + - Authentication is service-dependent + - It is recommended to use the Authentication and Authorization Service for authentication + +- **z/OSMF** + + - z/OSMF is not itself part of the API Mediation Layer but z/OSMF is the default authentication provider. + + +## Authentication endpoints + +The API Gateway contains the following REST API authentication endpoints: + +- **`auth/login`** +The full path of the `auth/login` endpoint appears as `https://{gatewayUrl} :{gatewayPort}/gateway/api/v1/auth/login`. + + The `auth/login` endpoint authenticates mainframe user credentials and returns an authentication token. The login request requires user credentials though one of the following methods: + * Basic access authentication + * JSON with user credentials + * Client certificate + + When authentication is successful, the response to the request is an empty body and a token is contained in a secure `HttpOnly` cookie named `apimlAuthenticationToken`. When authentication fails, the user receives a 401 status code. + +* **`auth/query`** +The full path of the `auth/query` endpoint appear as `https://{gatewayUrl}: {gatewayPort}/gateway/api/v1/auth/query`. + + The `auth/query` endpoint validates the token and retrieves the information associated with the token. + The query request requires the token through one of the following methods: + * A cookie named `apimlAuthenticationToken` + * Bearer authentication + + When authentication is successful, the response to the request is a JSON object which contains information associated with the token. When authentication fails, the user receives a 401 status code. + +- **`auth/ticket`** +The `auth/ticket` endpoint generates a PassTicket for the user associated with a token. The full path of the `auth/ticket` endpoint appears as `https://{gatewayUrl}:{gatewayPort}/gateway/api/v1/auth/ticket`. + + This endpoint is protected by a client certificate. + The ticket request requires the token in one of the following formats: + + - Cookie named `apimlAuthenticationToken`. + - Bearer authentication + + The request takes the `applicationName` parameter, which is the name of the application for which the PassTicket should be generated. Supply this parameter. + + The response is a JSON object, which contains information associated with the ticket. + +- **`auth/refresh`** + The `auth/refresh` endpoint generates a new token for the user based on valid jwt token. The full path of the `auth/refresh` endpoint appears as `https://{gatewayUrl}:{gatewayPort}/gateway/api/v1/auth/refresh`. The new token overwrites the old cookie with a `Set-Cookie` header. As part of the process, the old token gets invalidated and is no longer usable. + + **Notes:** + + - The endpoint is disabled by default. For more information, see [Enable JWT token endpoint](../../user-guide/api-mediation/configuration-jwt.md#enabling-a-jwt-token-refresh-endpoint). + - The endpoint is protected by a client certificate. + + The refresh request requires the token in one of the following formats: + + - Cookie named `apimlAuthenticationToken`. + - Bearer authentication + + For more information, see the OpenAPI documentation of the API Mediation Layer in the API Catalog. + +## Supported authentication methods + +The API Mediation Layer provides multiple methods which clients can use to authenticate. When the API ML is run as part +of Zowe, all of the following methods are enabled and supported. All methods are supported at least to some extent with each authentication provider. + +Zowe supports three authentication methods with single-sign-on. Use the following links to the documentation about using the following supported authentication methods: + +* [Authenticating with a JWT token](../../user-guide/authenticating-with-jwt-token.md) + +* [Authenticating with client certificates](../../user-guide/authenticating-with-client-certificates.md). + +* [Authenticating with personal access tokens](../../user-guide/api-mediation/authenticating-with-personal-access-token.md) + + +### Authenticate with Username/Password + +The client can authenticate via Username and password. There are multiple methods which can be used to deliver +credentials. For more details, see the ZAAS Client documentation. + +## Authentication parameters + +If you are looking for information about the authentication parameters and how your service can integrate with the API Mediation Layer consult [Single Sign On Integration for Extenders](./api-medation-sso-integration-extenders.md) + +## Discovery Service authentication + +There are several authentication mechanisms, depending on the desired endpoint, as described by the following matrix: + +| Endpoint | Authentication method | Note | +|----|-----|------| +| UI (eureka homepage) | basic auth(MF), token | see note about mainframe authentication | +| application/** | basic auth(MF), token | see note about mainframe authentication | +| application/health, application/info | none | | +| eureka/** | client certificate | Allows for the other services to register without mainframe credentials or token. API ML's certificate can be used. It is stored in the `keystore/localhost/localhost.keystore.p12` keystore or in the SAF keyring. It is exported to .pem format for convenience. Any other certificate which is valid and trusted by Discovery service can be used. | +| discovery/** | certificate, basic auth(MF), token | see note about mainframe authentication | + +**Note:** Some endpoints are protected by mainframe authentication. The authentication function is provided by the API Gateway. This functionality is not available until the Gateway registers itself to the Discovery Service. + +Since the Discovery Service uses HTTPS, your client also requires verification of the validity of its certificate. Verification is performed by validating the client certificate against certificates stored in the truststore or SAF keyring. + + Some utilities including HTTPie require the certificate to be in PEM format. The exported certificate in .pem format is located here: `keystore/localhost/localhost.pem`. + + The following example shows the HTTPie command to access the Discovery Service endpoint for listing registered services and provides the client certificate: + + ``` + http --cert=keystore/localhost/localhost.pem --verify=false -j GET https://localhost:10011/eureka/apps/ + ``` + + ## zOSMF Authentication + +The zOSMF service is onboarded statically under the `ibmzosmf` service id. The specific definition is created during the Zowe configuration based on the values provided in the `zowe.yaml` file. + +The `authentication.scheme` value for z/OSMF is: + + * **zosmf** + This value specifies that a service accepts z/OSMF LTPA (Lightweight Third-Party Authentication). + This scheme should only be used only for a z/OSMF service used by the API Gateway Authentication Service and other z/OSMF services that use the same LTPA key. + + * When a JWT is provided, the token extracts the LTPA and forwards it to the service. + * When a client certificate is provided, the certificate translates into a z/OSMF token, and also extracts the LTPA for the service to use. + + For more information about z/OSMF Single Sign On, see [Establishing a single sign on environment](https://www.ibm.com/support/knowledgecenter/SSLTBW_2.4.0/com.ibm.zosmfcore.multisysplex.help.doc/izuG00hpManageSecurityCredentials.html) + +This method should not be used for any other service. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/certificate-management-in-zowe-apiml.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/certificate-management-in-zowe-apiml.md new file mode 100644 index 0000000000..f1cde061ff --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/certificate-management-in-zowe-apiml.md @@ -0,0 +1,270 @@ +# Certificate management in Zowe API Mediation Layer + +Review details of certificate management in Zowe API Mediation Layer (API ML). This article decribes both how to manage certificates when running on localhost, as well as certificate management using Zowe runtime on z/OS. Additional information is provided about about the API ML truststore and keystore, and API ML SAF Keyring. + + - [Running on localhost](#running-on-localhost) + - [How to start API ML on localhost with full HTTPS](#how-to-start-api-ml-on-localhost-with-full-https) + - [Certificate management guide](#certificate-management-guide) + - [Generate a certificate for a new service on localhost](#generate-a-certificate-for-a-new-service-on-localhost) + - [Add a service with an existing certificate to API ML on localhost](#add-a-service-with-an-existing-certificate-to-api-ml-on-localhost) + - [Service registration to Discovery Service on localhost](#service-registration-to-discovery-service-on-localhost) + - [Zowe runtime on z/OS](#zowe-runtime-on-zos) + - [Import the local CA certificate to your browser](#import-the-local-ca-certificate-to-your-browser) + - [Generate a keystore and truststore for a new service on z/OS](#generate-a-keystore-and-truststore-for-a-new-service-on-zos) + - [Add a service with an existing certificate to API ML on z/OS](#add-a-service-with-an-existing-certificate-to-api-ml-on-zos) + - [Procedure if the service is not trusted](#procedure-if-the-service-is-not-trusted) + - [API ML truststore and keystore](#api-ml-truststore-and-keystore) + - [API ML SAF Keyring](#api-ml-saf-keyring) + +## Running on localhost + +### How to start API ML on localhost with full HTTPS + +The [api-layer repository](https://github.com/zowe/api-layer) contains pre-generated certificates that can be used to start API ML with HTTPS on your computer. The certificates are not trusted by your browser so you can either ignore the security warning or generate your own certificates and add them to the truststore of your browser or system. + +For more information about certificates, see [TLS Certificates for localhost](https://github.com/zowe/api-layer/blob/master/keystore/README.md). + +:::note +When running on localhost, only the combination of using a keystore and truststore is supported. +::: + + +### Certificate management guide + +Zowe API Mediation Layer provides a guide that can be used to generate a keystore and truststore using the Zowe local certificate authority on Windows, Mac, Linux, and z/OS. + +This guide is maintained in the `zowe/api-layer` repository [keystore/README.md](https://github.com/zowe/api-layer/blob/v2.x.x/keystore/README.md), and uses a combination of openssl and java keytool. + + +### Generate a certificate for a new service on localhost + +To generate a certificate for a new service on localhost, see [Generating certificate for a new service on localhost](https://github.com/zowe/api-layer/blob/master/keystore/README.md#generating-certificate-for-a-new-service-on-localhost). + + +### Add a service with an existing certificate to API ML on localhost + +For information about adding a service with an existing certificate to API ML on localhost, see [Trust certificates of other services](https://github.com/zowe/api-layer/blob/master/keystore/README.md#trust-certificates-of-other-services). + + +### Service registration to Discovery Service on localhost + +To register a new service to the Discovery Service using HTTPS, provide a valid client certificate that is trusted by the Discovery Service. + + +## Zowe runtime on z/OS + +Certificates for the API ML local CA and API ML service are managed by installing the Zowe runtime on z/OS. For more information see [Installing the Zowe runtime on z/OS](../../user-guide/install-zos.md). + +There are two ways to set up certificates on a z/OS machine: + +- Certificates in SAF keyring +- Certificates in UNIX files (keystore and truststore) + +For detailed instructions about how to set up certificates during installation, see the following articles: +* [Use PKCS12 certificates](../../user-guide/use-certificates.md#use-pkcs12-certificates) +* [Use JCERACFS certificates](../../user-guide/use-certificates.md#use-jceracfks-certificates) in a keyring + +Follow the procedure in the applicable section described in this article during installation. + +### Import the local CA certificate to your browser + +Trust in the API ML server is a necessary precondition for secure communication between a browser or API Client application. Ensure this trust through the installation of a Certificate Authority (CA) public certificate. By default, API ML creates a local CA. Import the CA public certificate to the truststore for REST API clients and to your browser. You can also import the certificate to your root certificate store. + +:::note Notes +- If a SAF keyring is being used and set up with `ZWEKRING` JCL, the procedure to obtain the certificate does not apply. It is recommended that you work with your security system administrator to obtain the certificate. Start the procedure at step 2. + +- The public certificate in the [PEM format](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) is stored at `/local_ca/localca.cer`, where `` is defined in a customized `zowe.yaml` file during the installation step that generates Zowe certificates. The certificate is stored in UTF-8 encoding so you need to transfer it as a binary file. Since this is the certificate to be trusted by your browser, it is recommended to use a secure connection for transfer. + +- Windows currently does not recognize the PEM format. For Windows, use the P12 version of the `local_cer`. +::: + +**Follow these steps:** + +1. Download the local CA certificate to your computer. Use one of the following methods to download the local CA certificate to your computer: + + - **Use [Zowe CLI](https://github.com/zowe/zowe-cli#zowe-cli--) (Recommended)** +Issue the following command: + + ``` + zowe zos-files download uss-file --binary $KEYSTORE_DIRECTORY/local_ca/localca.cer + ``` + + - **Use `sftp`** +Issue the following command: + + ``` + sftp + get $KEYSTORE_DIRECTORY/local_ca/localca.cer + ``` + + To verify that the file has been transferred correctly, open the file. The following heading and closing should appear: + + ``` + -----BEGIN CERTIFICATE----- + ... + -----END CERTIFICATE----- + ``` + +2. Import the certificate to your root certificate store and trust it. + + - **For Windows**, run the following command: + + ``` + certutil -enterprise -f -v -AddStore "Root" localca.cer + ``` + + **Note:** Ensure that you open the terminal as **administrator**. This will install the certificate to the Trusted Root Certification Authorities. + + - **For macOS**, run the following command: + + ``` + $ sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain localca.cer + ``` + + - **For Firefox**, manually import your root certificate via the Firefox settings, or force Firefox to use the Windows truststore. + + **Note:** Firefox uses its own certificate truststore. + + Create a new Javascript file firefox-windows-truststore.js at `C:\Program Files (x86)\Mozilla Firefox\defaults\pref` with the following content: + + ``` + /* Enable experimental Windows truststore support */ + pref("security.enterprise_roots.enabled", true); + ``` + +### Generate a keystore and truststore for a new service on z/OS + +You can generate a keystore and truststore for a new service using the local CA in the keystore directory. + +:::note +This procedure applies to a UNIX file keystore and truststore only. For the SAF keyring option, it is recommended that you perform the actions manually using your security system commands. +::: + +Use the `zwe` command available in the zowe distribution package and execute following example. + +**Example:** +``` +zwe certificate pkcs12 create cert -d -a -p -k --ca-alias --ca-password + ``` + +* **cert-alias** +Specifies a unique string to identify the key entry. All keystore entries (key and trusted certificate entries) are accessed via unique aliases. Since the keystore has only one certificate, you can omit this parameter and use the default value `localhost`. + +* **service-keystore-directory** + Specifies the repository of security certificates plus the corresponding private keys. The `` is the path excluding the extension to the keystore that is generated. It can be an absolute path or a path relative to the current working directory. The key store is generated in PKCS12 format with the `.p12` extension. Ensure that the path is in an existing directory where your service expects the keystore. + + **Example:** `/opt/myservice/keystore/`. + +* **service-name** +Specifies the name of the service for which you want to generate keystore. A keystore will be created in the directory with the same name. + **Example:** `my-new-service`. + +* **keystore-password** + Specifies the keystore password. + +* **ca-keystore-password** +Specifies the local certificate authority keystore password. + +* **ca-alias** +Specifies the local certificate authority alias in the keystore. Zowe CA is stored under the `local_ca` alias. + +### Add a service with an existing certificate to API ML on z/OS + +API Mediation Layer requires validation of the certificate of each service that it accessed by API Mediation Layer. API Mediation Layer requires validation of the full certificate chain. + +:::note +This procedure applies only to UNIX file keystore/truststore. For the SAF keyring option, we recommend you perform the actions manually using your security system commands. +::: + +Import the public certificate of the CA that has signed the certificate of the service to the API ML truststore. + +:::note +Validation fails if a service does not provide intermediate CA certificates to the API ML. This can be circumvented by importing the intermediate CA certificates to the API ML truststore. +::: + +#### Procedure if the service is not trusted + +If your service is not trusted, you may receive a response with the HTTP status code [502 Bad Gateway](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) and a JSON response in the standardized format for error messages. The following request is an example of when this error response may occur. + +**Example:** + +``` +http --verify=$KEYSTORE_DIRECTORY/local_ca/localca.cer GET https://://api/v1/greeting +``` + +In this example, you receive a similar response: + +``` + HTTP/1.1 502 + Content-Type: application/json;charset=UTF-8 + + { + "messages": [ + { + "messageContent": "The certificate of the service accessed by HTTPS using URI '//api/v1/greeting' is not trusted by the API Gateway: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target", + "messageKey": "apiml.common.tlsError", + "messageNumber": "AML0105", + "messageType": "ERROR" + } + ] + } +``` + +The message has the key `apiml.common.tlsError`, and message number `AML0105`. The content explains details about the message. + +If you receive this message, import the certificate of your service or the CA that signed it to the truststore of the API Mediation Layer as described previously. + +## API ML truststore and keystore + +A _keystore_ is a repository of security certificates consisting of either authorization certificates or public key certificates with corresponding private keys (PK), used in TLS encryption. A _keystore_ can be stored in Java specific format (JKS) or use the standard format (PKCS12). The Zowe API ML uses PKCS12 to enable the keystores to be used +by other technologies in Zowe (Node.js). +## API ML SAF Keyring + +As an alternative to using a keystore and truststore, API ML can read certificates from a _SAF keyring_. The user running the API ML must have rights to access the keyring. From the java perspective, the keyring behaves as the `JCERACFKS` keystore. The path to the keyring is specified as `safkeyring://user_id/key_ring_id`. The content of the SAF keyring is equivalent to the combined contents of the keystore and the truststore. + +:::note +When using JCEFACFKS as the keystore type, ensure that you define the class to handle the RACF keyring. Use the `-D` options to specify the `java.protocol.handler.pkgs property`: + + -Djava.protocol.handler.pkgs=com.ibm.crypto.provider +::: + +Review the characterisitics of following elements of the API ML SAF Keyring: + +**The API ML local certificate authority (CA)** + +- The API ML local CA contains a local CA certificate and a private key that needs to be securely stored. +- The API ML local certificate authority is used to sign certificates of services. +- The API ML local CA certificate is trusted by API services and clients. + +**The API ML keystore or API ML SAF Keyring** + +- The server certificate of the Gateway (with PK)can be signed by the local CA or an external CA. +- The server certificate of the Discovery Service (with PK) can be signed by the local CA. +- The server certificate of the Catalog (with PK) can be signed by the local CA. +- The API ML keystore is used by API ML services. + +**The API ML truststore or API ML SAF Keyring** + +- Local CA public certificate +- External CA public certificate (optional) +- Can contain self-signed certificates of API Services that are not signed by the local or external CA +- Used by API ML services + +**Zowe core services** + +- Services can use the same keystore and truststore or the same keyring as API ML for simpler installation and management. +- When using a keystore and truststore, services have to have rights to access and read them on the filesystem. +- When using a keyring, the user of the service must have authorization to read the keyring from the security system. +- Alternatively, services can have individual stores for higher security. + +**API service keystore or SAF keyring** (for each service) + +- The API service keystore contains a server and client certificate signed by the local CA. + +**API service truststore or SAF keyring** (for each service) + +- (Optional) The API service truststore contains a local CA and external CA certificates. + +**Client certificates** + +- A client certificate is a certificate that is used for validation of the HTTPS client. The client certificate of a Discovery Service client can be the same certificate as the server certificate of the services which the Discovery Service client uses. diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/create-apiml-extension.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/create-apiml-extension.md new file mode 100644 index 0000000000..31aea152e7 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/create-apiml-extension.md @@ -0,0 +1,66 @@ +# Creating an Extension for API ML + +Zowe allows extenders to define their own extension for API ML. Follow the steps in this article to create your extension and add it to the +API Gateway classpath. + +:::note +The `api-sample-extension-package` contains a sample `manifest.yml` and the `apiml-sample-extension` JAR that contains the extension. +::: + +**Follow these steps:** + +1. Create a JAR file from your extension. See the [API ML sample extension](https://github.com/zowe/api-layer/blob/master/apiml-sample-extension) to model the format of the JAR. +2. Create a `manifest.yml` with the following structure. See the sample [`manifest.yml`](https://github.com/zowe/api-layer/blob/master/apiml-sample-extension-package/src/main/resources/manifest.yaml) to model the format of the yaml file. + +For more information, see [Packaging z/OS extensions](../packaging-zos-extensions.md). + + **Example:** + ```yaml + --- + name: apiml-extension + # Component identifier. This identifier matches artifact path in Zowe Artifactory https://zowe.jfrog.io/. + id: org.zowe.apiml.sdk.apiml-extension-package + # Component version is defined in gradle.properties for Gradle project + # Human readable component name + title: Your extension for API ML + # Human readable component description + description: JAR that contains the API ML extension. + license: EPL-2.0 + repository: + type: git + url: https://github.com/zowe/api-layer.git + build: + branch: "{{build.branch}}" + number: "{{build.number}}" + commitHash: "{{build.commitHash}}" + timestamp: "{{build.timestamp}}" + # The following block contains all the extensions directory path + # (or file path) that will be included in the API ML + gatewaySharedLibs: + - path/to/my/lib1/ + - path/to/my/lib2/ + ``` + +The extension directory `/workspace/gateway/sharedLibs/` is then added to the API Gateway class path as part of the Zowe instance preparation. + +:::note +The paths defined under `gatewaySharedLibs` can either be a path to the directory where the extensions JARs are located, or a path to the files. +::: + +**Example:** + ```yaml + gatewaySharedLibs: + - path/to/my/lib1/extension1.jar + - path/to/my/lib2/extension2.jar + ``` + +After the JAR file and `manifest.yml` are customized according to your application, the extension is extracted, scanned and added to the extension directory during the Zowe instance preparation. When the API Gateway starts, the the API Gateway consumes the sample extension. + +The extension should now be correctly added to the API Gateway classpath. + +## Call the REST endpoint for validation + +Follow these steps to validate that you can call the REST endpoint defined in the controller via the API Gateway: + +1. Call the `https://:/api/v1/greeting` endpoint though Gateway. +2. Verify that you receive the message, `Hello, I'm a sample extension!` as the response. diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/custom-metadata.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/custom-metadata.md new file mode 100644 index 0000000000..018c4bc235 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/custom-metadata.md @@ -0,0 +1,142 @@ +# Customizing Metadata (optional) + +Additional metadata can be added to the instance information that is registered in the Discovery Service in the `customMetadata` section. This information is propagated from the Discovery Service to the onboarded services (clients). In general, additional metadata do not change the behavior of the client. Some specific metadata can configure the functionality of the API Mediation Layer. Such metadata are generally prefixed with the `apiml.` qualifier. We recommend you define your own qualifier, and group all metadata you wish to publish under this qualifier. If you use the Spring enabler, ensure that you include the prefix `apiml.service` before the parameter name. + +* **customMetadata.apiml.enableUrlEncodedCharacters** +When this parameter is set to `true`, the Gateway allows encoded characters to be part of URL requests redirected through the Gateway. The default setting of `false` is the recommended setting. Change this setting to `true` only if you expect certain encoded characters in your application's requests. + + :::info Important + When the expected encoded character is an encoded slash or backslash (`%2F`, `%5C`), make sure the Gateway is also configured to allow encoded slashes. For more information, see [Zowe runtime](../../user-guide/install-zos.md#zowe-runtime) in Zowe server-side installation overview. + ::: + + :::note + If you use the Spring enabler, use the following parameter name: + `apiml.service.customMetadata.apiml.enableUrlEncodedCharacters` + ::: + +* **customMetadata.apiml.connectTimeout** +The value in milliseconds that specifies a period in which API ML should establish a single, non-managed connection with this service. If omitted, the default value specified in the API ML Gateway service configuration is used. + + :::note + If you use the Spring enabler, use the following parameter name: + `apiml.service.customMetadata.apiml.connectTimeout` + ::: + +* **customMetadata.apiml.readTimeout** +The value in milliseconds that specifies the time of inactivity between two packets in response from this service to API ML. If omitted, the default value specified in the API MLGateway service configuration is used. + + :::note + If you use the Spring enabler, use the following parameter name: + `apiml.service.customMetadata.apiml.readTimeout` + ::: + +* **customMetadata.apiml.connectionManagerTimeout** +HttpClient employs a special entity to manage access to HTTP connections called by the HTTP connection manager. The purpose of an HTTP connection manager is to serve as a factory for new HTTP connections, to manage the life cycle of persistent connections, and to synchronize access to persistent connections. Internally, it works with managed connections which serve as proxies for real connections. `connectionManagerTimeout` specifies a period in which managed connections with API ML should be established. The value is in milliseconds. If omitted, the default value specified in the API ML Gateway service configuration is used. + + :::note + If you use the Spring enabler, use the following parameter name: + `apiml.service.customMetadata.apiml.connectionManagerTimeout` + ::: +* **customMetadata.apiml.okToRetryOnAllOperations** +Specifies whether all operations can be retried for this service. The default value is `false`. The `false` value allows retries for only `GET` requests if a response code of `503` is returned. Setting this value to `true` enables retry requests for all methods, which return a `503` response code. Enabling retry can impact server resources resulting from buffering of the request body. + + :::note + If you use the Spring enabler, use the following parameter name: + `apiml.service.customMetadata.apiml.okToRetryOnAllOperations` + ::: + +* **customMetadata.apiml.corsEnabled** +When this parameter is set to `true`, CORS handling by the Gateway is enabled on the service level for all service routes. + +For more information, refer to enabling CORS with Custom Metadata on the Gateway: [Customizing Cross-Origin Resource Sharing (CORS)](../../user-guide/api-mediation/configuration-cors.md). +Additional information can be found in this article about [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS). + + :::note + If you use the Spring enabler, use the following parameter name: + `apiml.service.customMetadata.apiml.corsEnabled` + ::: + +* **customMetadata.apiml.gatewayAuthEndpoint** +Specifies the Gateway authentication endpoint used by the ZAAS Client configuration. The default value is `/api/v1/gateway/auth`. For more information about ZAAS Client, see [ZAAS Client](zaas-client.md). + + :::note + If you use the Spring enabler, use the following parameter name: + `apiml.service.customMetadata.apiml.gatewayAuthEndpoint` + ::: + +* **customMetadata.apiml.gatewayPort** +Specifies the Gateway port used by the ZAAS Client configuration. The default value is `10010`. For more information about ZAAS Client, see [ZAAS Client](zaas-client.md). + + :::note + If you use the Spring enabler, use the following parameter name: + `apiml.service.customMetadata.apiml.gatewayPort` + ::: + +* **customMetadata.apiml.corsAllowedOrigins** +Optionally, service can specify which origins will be accepted by Gateway during the CORS handling. When this parameter is not set, the accepted origins are `*` by default. You can provide a coma separated list of values to explicitly limit the accepted origins. + + :::note + If you use the Spring enabler, use the following parameter name: + `apiml.service.customMetadata.apiml.corsAllowedOrigins` + ::: + + For more information, refer to enabling CORS with Custom Metadata on the Gateway: [Customizing Cross-Origin Resource Sharing (CORS)](../../user-guide/api-mediation/configuration-cors.md). + + * **customMetadata.apiml.lb.type** + This parameter is part of the load balancing configuration for the Deterministic Routing capability. Through this parameter, the service can specify which load balancing schema the service requires. If this parameter is not specified, the service is routed using the basic round robin schema. This parameter can be set to the following values: + + * **`headerRequest`** + This value applies the Header Request load balancing schema. Clients can call the API Gateway and provide a special header with the value of the requested instanceId. The Gateway understands this as a request from the client for routing to a specific instance. Clients have several possibilities for understanding the topology of service instances, such as via the `/eureka/apps` endpoint on the Discovery service, or the `/gateway/services` endpoint on the Gateway. In either case, the information is provided. The client can then request a specific instance by using the special header described below. + + The header name is `X-InstanceId`, and the sample value is `discoverable-client:discoverableclient:10012`. This is identical to `instanceId` property in the registration of the Discovery service. + + In combination with enabling [Routed instance header](../../user-guide/api-mediation/configuration-access-specific-instance-of-service), the client can achieve sticky session functionality. (The term, 'sticky session' refers to the feature of many load balancing solutions to route the requests for a particular session to the same physical machine that serviced the first request for that session). The benefit of this approach is that there is no session on the Gateway, and the client ultimately decides whether or not to go to a specific instance. This method uses the following sequence: + + 1. The client calls API Gateway and gets routed to a service. + 2. The client reads the `X-InstanceId` header value from the response to understand the service was routed to. + 3. For all subsequent requests, the client provides the `X-InstanceId` header with previously read value to get routed to the same instance of the service. + + + * **`authentication`** + This value applies the Authentication load balancing schema. This is a sticky session functionality based on the ID of the user. The user ID is understood from the Zowe SSO token on the client's request. Requests without the token are routed in a round robin fashion. The user is first routed in a round robin fashion, and then the routed instance Id is cached. The instance information is used for subsequent requests to route the client to the cached target service instance. This session's default expiration time is 8 hours. After the session expires, the process initiates again. + + In default configuration, this cache is stored on each Gateway instance. You can choose to distribute this cache between the Gateway's instances. To do so, follow the steps described in [Distributing the load balancer cache](../../user-guide/api-mediation/configuration-distributed-load-balancer-cache). + +* **customMetadata.apiml.lb.cacheRecordExpirationTimeInHours** +When the property `customMetadata.apiml.lb.type` is set to `authentication`, the user can also define the expiration time for the selected instance information that is cached. This property aims to prevent any discrepancy which might occur if the required target server is no longer available. The default value is 8 hours. + +* **customMetadata.apiml.response.compress** +When this parameter is set to `true`, API ML compresses content for all responses from this services using GZIP. API ML also adds the `Content-Encoding` header with value `gzip` to responses. + +* **customMetadata.apiml.response.compressRoutes** +When the `customMetadata.apiml.response.compress` parameter is set to `true`, this parameter allows services to further limit the compressed routes. The parameter accepts [ant style](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/util/AntPathMatcher.html) routes deliminated by `,` . The expectation is to provide the absolute paths. + +If relative paths are provided, the starting `/` is added. If the beginning of the pattern does not need to be specifically defined, use `**/{pathYouAreInterestedIn}` + + **Examples:** + + * `/service/**` + Compresses all paths starting with /service/ + + * `/service/api/v1/compress,/service/api/v1/custom-compress` + Compresses the specific two routes + + * `/\*\*/compress/\*\*` + Compresses all paths that contain `compress` as a specific path + +* **customMetadata.apiml.response.headers** +(Optional) A service can specify headers that are added to the response by the Gateway. When this parameter is not set or is empty, no headers are added. Header names and header values are separated by `:`. Multiple headers can be added, delimited by `,`. If a header with the same name already exists in the response, the Gateway overwrites the value of the header. + + **Examples:** + + * `Strict-Transport-Security:max-age=1234; includeSubDomains` + Sets a header with name `Strict-Transport-Security` and value `max-age=1234; includeSubDomains`. + + * `Strict-Transport-Security:max-age=1234; includeSubDomains, X-Frame-Options:SAMEORIGIN` + Sets two headers: + + 1) Header with name `Strict-Transport-Security` and value `max-age=1234; includeSubDomains`. + 2) Header with name `X-Frame-Options` and value `SAMEORIGIN. + +* **customMetadata.apiml.headersToIgnore** +(Optional) A service can specify headers that are removed from the request to the southbound service by the Gateway. When this parameter is not set or is empty, no headers are removed. Multiple headers can be removed, delimited by `,`. diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/implement-new-saf-provider.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/implement-new-saf-provider.md new file mode 100644 index 0000000000..05e14b890b --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/implement-new-saf-provider.md @@ -0,0 +1,113 @@ +# Implementing a new SAF IDT provider + +As a Zowe API ML user, you can use the API Gateway to apply your own SAF Identity Token (IDT) provider by implementing +an existing interface. + +- [How to create a SAF IDT provider](#how-to-create-a-saf-idt-provider) +- [How to integrate your extension with API ML](#how-to-integrate-your-extension-with-api-ml) +- [How to use an existing SAF IDT provider](#how-to-use-an-existing-saf-idt-provider) +- [How to use the SAF IDT provider](#how-to-use-the-saf-idt-provider) + +To configure SAF IDT on z/OS, see [Configure signed SAF Identity tokens (IDT)](../../user-guide/configure-zos-system.md#configure-signed-saf-identity-tokens-idt). + +## How to create a SAF IDT provider + +To create your own implementation of the SAF IDT provider, follow these steps: + +1. Implement the existing `org.zowe.apiml.gateway.security.service.saf.SafIdtProvider` interface. + +```java +public interface SafIdtProvider { + /** + * If the current user has the proper rights generate the SAF token on its behalf and return it back. + * + * @param username userId + * @param password or passticket. + * @param applId of service requesting the token. + * @return Either empty answer meaning the user is either unauthenticated or doesn't have the proper rights. + */ + String generate(String username, char[] password, String applId); + + /** + * Verify that the provided saf token is valid. + * + * @param safToken Token to validate. + * @param applid of service validating the token. + * @return true if the token is valid, false if it is invalid + */ + boolean verify(String safToken, String applid); +} +``` + +The `SafIdtProvider` interface contains the `generate` and `verify` methods. The `generate` method can be overridden by your SAF IDT implementation to generate the SAF token on behalf of the specified user. The `verify` method can be overridden to verify that the provided SAF token is valid. + +2. Register a bean in order to use the implemented SAF IDT provider. + +**Example:** + +```java +/* + * 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. + */ +package org.zowe.apiml.gateway.security.service.saf; + +import lombok.RequiredArgsConstructor; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.web.client.RestTemplate; +import org.zowe.apiml.gateway.security.service.AuthenticationService; +import org.zowe.apiml.passticket.PassTicketService; + +@Configuration +@RequiredArgsConstructor +public class SafProviderBeansConfig { + @Bean + @ConditionalOnProperty(name = "apiml.security.saf.provider", havingValue = "rest") + public SafIdtProvider restSafProvider( + RestTemplate restTemplate, + AuthenticationService authenticationService, + PassTicketService passTicketService + ) { + return new SafRestAuthenticationService(restTemplate, authenticationService, passTicketService); + } +} +``` + +You created a SAF IDT provider. +## How to integrate your extension with API ML + +To use your SAF IDT provider as an extension of API ML, see [Create an extension for API ML](create-apiml-extension.md). + +## How to use the SAF IDT provider + +To use the newly created SAF IDT provider, it is necessary to set the parameter `apiml.authentication.scheme` to `safIdt` in your service configuration. +Your application then properly recognizes the SAF IDT scheme and fills the `X-SAF-Token` header with the token produced by your SAF IDT provider. + +## How to use an existing SAF IDT provider + +You can generate and verify an existing SAF token by using an implementation of the SAF IDT provider that utilizes a ZSS solution. + +[SafRestAuthenticationService](https://github.com/zowe/api-layer/blob/master/gateway-service/src/main/java/org/zowe/apiml/gateway/security/service/saf/SafRestAuthenticationService.java) is an example of the SAF IDT provider implementation which uses REST as a method of communication. + +To use `SafRestAuthenticationService` ensure that `ZWE_configs_apiml_security_saf_provider` is set to `rest`. (This is the default value) +Set the following environment parameters in `zowe.yaml`: + +* `ZWE_configs_apiml_security_saf_urls_authenticate=https://${ZWE_haInstance_hostname}:${GATEWAY_PORT}/zss/api/v1/saf/authenticate` +* `ZWE_configs_apiml_security_saf_urls_verify=https://${ZWE_haInstance_hostname}:${GATEWAY_PORT}/zss/api/v1/saf/verify` + +These ZSS endpoints are used by the `SafRestAuthenticationService` to generate and validate the SAF token. + +SAF IDT providers + +The following diagram illustrates how communication using the SAF IDT provider works: + +SAF IDT diagram + + diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/implementing-routing-to-the-api-gateway.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/implementing-routing-to-the-api-gateway.md new file mode 100644 index 0000000000..84f3757f4f --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/implementing-routing-to-the-api-gateway.md @@ -0,0 +1,51 @@ +# Implementing routing to the API Gateway + +Service instances provide information about routing to the API Gateway via Eureka metadata. + +**Example:** + + routes: + - gatewayUrl: "ui/v1" + serviceUrl: "/helloworld" + - gatewayUrl: "api/v1" + serviceUrl: "/helloworld/v1" + - gatewayUrl: "api/v2" + serviceUrl: "/helloworld/v2" + +In this example, the service has a service ID of `helloworldservice` that exposes the following endpoints: + +* **UI** - `https://gateway/helloworldservice/ui/v1` routed to `https://hwServiceHost:port/helloworld/` +* **API major version 1** - `https://gateway/helloworldservice/api/v1` routed to `https://hwServiceHost:port/helloworld/v1` +* **API major version 2** - `https://gateway/helloworldservice/api/v2` routed to `https://hwServiceHost:port/helloworld/v2` + +where: + +* The gatewayUrl is matched against the prefix of the URL path used at the Gateway `https://gateway/urlPath`, where `urlPath` is `serviceId/prefix/resourcePath`. +* The service ID is used to find the service host and port. +* The `serviceUrl` is used to prefix the `resourcePath` at the service host. + +:::note +The service ID is not included in the routing metadata, but the service ID is in the basic Eureka metadata. +::: + +### Basic Routing using only the service ID + +This method of routing is similar to the previous method, but does not use the version part of the URL. This approach is useful for services that handle versioning themselves with different granularity. + +One example that only uses a service ID is z/OSMF. + +**Example:** + +z/OSMF URL through the Gateway has the following format: + + `https://gateway:10010/ibmzosmf/api/restjobs/jobs/...` + +where: + +* **`ibmzosmf`** +Specifies the service ID. + +* **`/restjobs/1.0/...`** +Specifies the rest of the endpoint segment. + +Note that no version is specified in this URL. diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-direct-eureka-call.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-direct-eureka-call.md new file mode 100644 index 0000000000..89183d49de --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-direct-eureka-call.md @@ -0,0 +1,371 @@ +# Onboarding a service with the Zowe API Mediation Layer without an onboarding enabler + +This article is part of a series of guides to onboard a REST service with the Zowe API Mediation Layer (API ML). Onboarding with API ML makes services accessible through the API Gateway and visible in the API Catalog. Once a service is successfully onboarded, users can see if the service is currently available and accepting requests. + +This guide describes how a REST service can be onboarded with the Zowe API ML independent of the language used to write the service. As such, this guide does not describe how to onboard a service with a specific enabler. Similarly, various Eureka client implementations are not used in this onboarding method. + +**Tip:** If possible, we recommend that you onboard your service using the API ML enabler libraries. The approach described in this article should only be used if other methods to onboard your service are not suitable. + +For more information about how to onboard a REST service, see the following links: + +- [API ML onboarding overview](onboard-overview.md) +- [python-eureka-client](https://pypi.org/project/py-eureka-client/) +- [eureka-js-client](https://www.npmjs.com/package/eureka-js-client) +- [Rest API developed based on Java](onboard-overview.md#sample-rest-api-service) + +This article outlines a process to make an API service available in the API Mediation Layer by making a direct call to the Eureka Discovery Service. + +* [Introduction](#introduction) +* [Registering with the Discovery Service](#registering-with-the-discovery-service) + * [API Mediation Layer Service onboarding metadata](#api-mediation-layer-service-onboarding-metadata) + * [Catalog parameters](#catalog-parameters) + * [Service parameters](#service-parameters) + * [Routing parameters](#routing-parameters) + * [API Info Parameters](#api-info-parameters) +* [Sending a heartbeat to API Mediation Layer Discovery Service](#sending-a-heartbeat-to-api-mediation-layer-discovery-service) +* [Validating successful onboarding with the API Mediation Layer](#validating-successful-onboarding-with-the-api-mediation-layer) +* [External Resources](#external-resources) + +## Introduction + +The API ML Discovery Service uses [Netflix/Eureka](https://github.com/Netflix/eureka) as a REST services registry. Eureka is a REST-based service that is primarily used to locate services. + +Eureka [endpoints](https://github.com/Netflix/eureka/wiki/Eureka-REST-operations) are used to register a service with the API ML Discovery Service. Endpoints are also used to send a periodic heartbeat to the Discovery Service to indicate that the onboarded service is available. + +**Note:** Required parameters should be defined and sent at registration time. + +## Registering with the Discovery Service + +Begin the onboarding process by registering your service with the API ML Discovery Service. + +Use the `POST` Http call to the Eureka server together with the registration configuration in the following format: + +``` +https://{eureka_hostname}:{eureka_port}/eureka/apps/{serviceId} +``` + +The following code block shows the format of the parameters in your `POST` call, which are sent to the Eureka registry at the time of registration. + +```xml + + + {serviceId} + {ipAddress} + {port} + {port} + {hostname} + {serviceId} + {serviceId} + {instanceId} + + MyOwn + + + ... + + +``` + +where: + + * **app** + uniquely identifies one or more instances of a microservice in the API ML. + + The API ML Gateway uses the `serviceId` for routing to the API service instances. + As such, the `serviceId` is part of the service URL path in the API ML Gateway address space. + + **Important!** Ensure that the service ID is set properly with the following considerations: + + * The service ID value contains only lowercase alphanumeric characters. + * The service ID does not contain more than 40 characters. + * The same service ID is only set for multiple API service instances to support API scalability. When two API services use the same service ID, the API Gateway considers the services as clones of each other. An incoming API request can be routed to either instance through load balancing. + + **Example:** + * If the `serviceId` is `sampleservice`, the service URL in the API ML Gateway address space appears as: + + ``` + https://gateway-host:gateway-port/sampleservice/api/v1/... + ``` + + * **ipAddr** + specifies the IP address of this specific service instance. + + * **port** + specifies the port of the instance when you use Http. For Http, set `enabled` to `true`. + +* **securePort** +specifies the port of the instance for when you use Https. For Https, set `enabled` to `true`. + + * **hostname** + specifies the hostname of the instance. + + * **vipAddress** + specifies the `serviceId` when you use Http. +**Important!** Ensure that the value of `vipAddress` is the same as the value of `app`. In addition, be sure not to omit `vipAddress`, even if you provided `secureVipAddress`. Due to +a current limitation in Spring Cloud Netflix, routes are created only for instances in which `vipAddress` is defined. + + * **secureVipAddress** + specifies the `serviceId` when you use Https. + **Important!** Ensure that the value of `secureVipAddress` is the same as the value of `app`. + + * **instanceId** + specifies a unique id for the instance. Define a unique value for the `instanceId` in the following format: + + ```{hostname}:{serviceId}:{port}``` + * **metadata** + specifies the set of parameters described in the following section addressing API ML service metadata. + +### API Mediation Layer Service onboarding metadata + +At registration time, provide metadata in the following format. Metadata parameters contained in this code block are described in the following section. + +```xml + + + samples + Sample API Mediation Layer Applications + Applications which demonstrate how to make a service integrated to the API Mediation Layer ecosystem + 1.0.1 + Sample Service + Sample API service showing how to onboard the service + false + api/v1 + /sampleclient/api/v1 + /sampleclient + ui/v1 + ws/v1 + /sampleclient/ws + httpBasicPassTicket + ZOWEAPPL + zowe.apiml.sampleclient + https://hostname/sampleclient/api-doc + api/v1 + https://www.zowe.org + + +``` + +Metadata parameters are broken down into the following categories: + +* [Catalog parameters](#catalog-parameters) +* [Service parameters](#service-parameters) +* [Routing parameters](#routing-parameters) +* [Authentication parameters](#authentication-parameters) +* [API Info parameters](#api-info-parameters) + +#### Catalog parameters +Catalog parameters are grouped under the prefix: `apiml.catalog.tile`. + +The API ML Catalog displays information about services registered with the API ML Discovery Service. +Information displayed in the Catalog is defined in the metadata provided by your service during registration. +The Catalog groups correlated services in the same tile when these services are configured with the same `catalog.tile.id` metadata parameter. + +The following parameters are used to populate the API Catalog: + +* **apiml.catalog.tile.id** +This parameter specifies the specific identifier for the product family of API services. This is a value used by the API ML to group multiple API services into a single tile.Each identifier represents a single API dashboard tile in the Catalog. +**Important!** Specify a value that does not interfere with API services from other products. We recommend that you use your company and product name as part of the ID. + +* **apiml.catalog.tile.title** +This parameter specifies the title of the API services product family. This value is displayed in the API Catalog dashboard as the tile title. + +* **apiml.catalog.tile.description** +This parameter is the detailed description of the API services product family. This value is displayed in the API Catalog UI dashboard as the tile description. + +* **apiml.catalog.tile.version** +This parameter specifies the semantic version of this API Catalog tile. +**Note:** Ensure that you increase the version number when you introduce changes to the API service product family details. + +#### Service parameters +Service parameters are grouped under the prefix: `apiml.service` + +The following parameters define service information for the API Catalog: + +* **apiml.service.title** +This parameter specifies the human-readable name of the API service instance. This value is displayed in the API Catalog when a specific API service instance is selected. + +* **apiml.service.description** +This parameter specifies a short description of the API service. +This value is displayed in the API Catalog when a specific API service instance is selected. + +* **apiml.enableUrlEncodedCharacters** +When this parameter is set to `true`, the Gateway allows encoded characters to be part of URL requests redirected through the Gateway. The default setting of `false` is the recommended setting. Change this setting to `true` only if you expect certain encoded characters in your application's requests. +**Important!** When the expected encoded character is an encoded slash or backslash (`%2F`, `%5C`), make sure the Gateway is also configured to allow encoded slashes. For more info see [Installing the Zowe runtime on z/OS](../../user-guide/install-zos.md). + +* **apiml.connectTimeout** +The value in milliseconds that specifies a period in which API ML should establish a single, non-managed connection with this service. If omitted, the default value specified in the API ML Gateway service configuration is used. + +* **apiml.readTimeout** +The value in milliseconds that specifies maximum time of inactivity between two packets in response from this service to API ML. If omitted, the default value specified in the API ML Gateway service configuration is used. + +* **apiml.connectionManagerTimeout** +HttpClient employs a special entity to manage access to HTTP connections called by HTTP connection manager. The purpose of an HTTP connection manager is to serve as a factory for new HTTP connections, to manage the life cycle of persistent connections, and to synchronize access to persistent connections. Internally, an HTTP connection manager works with managed connections, which serve as proxies for real connections. `ConnectionManagerTimeout` specifies a period in which managed connections with API ML should be established. The value is in milliseconds. If omitted, the default value specified in the API ML Gateway service configuration is used. + +* **apiml.okToRetryOnAllOperations** +Specifies whether all operations can be retried for this service. The default value is `false`. The `false` value allows retries for only GET requests if a response code of `503` is returned. Setting this value to `true` enables retry requests for all methods, which return a `503` response code. Enabling retry can impact server resources resulting from buffering of the request body. + +* **apiml.service.corsEnabled** +When this parameter is set to `true`, CORS is enabled on the service level for all service routes. The same parameter can also be set on the service level, by providing the parameter as `customMetadata` as shown in the [Custom Metadata](./custom-metadata.md). + +* **apiml.response.compress** +When this parameter is set to `true`, API ML compresses content for all responses from these services using GZIP. API ML also adds the `Content-Encoding` header with the value `gzip` to responses. + +* **customMetadata.apiml.response.compressRoutes** +When the `customMetadata.apiml.response.compress` parameter is set to `true`, this parameter allows the services to further limit the compressed routes. The parameter accepts [ant style](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/util/AntPathMatcher.html) routes deliminated by `,` . The expectation is to provide the absolute paths. If relative paths are provided, the starting `/` is added. If the beginning of the pattern does not require specification, use `**/{pathYouAreInterestedIn}` + + **Examples:** + + * `/service/**` + Compresses all paths starting with `/service/` + + * `/service/api/v1/compress,/service/api/v1/custom-compress` + Compresses the specific two routes + + * `/\*\*/compress/\*\*` + Compresses all paths that contain `compress` as a specific path + + +#### Routing parameters +Routing parameters are grouped under the prefix: `apiml.routes` + +The API routing group provides necessary routing information used by the API ML Gateway when routing incoming requests to the corresponding service. +A single route can be used to make direct REST calls to multiple resources or API endpoints. The route definition provides rules used by the API ML Gateway to rewrite the URL +in the Gateway address space. + +Routing information consists of two parameters per route: + + * `gatewayUrl` + * `serviceUrl` + +These two parameters together specify a rule of how the API service endpoints are mapped to the API Gateway endpoints. + +The following snippet is an example of the API routing information properties. + +**Example:** + +``` +api/v1 +/sampleclient/api/v1 +``` +where: + +* **apiml.routes.\{route-prefix\}.gatewayUrl** +The `gatewayUrl` parameter specifies the portion of the gateway URL which is replaced by the `serviceUrl` path. + +* **apiml.routes.\{route-prefix\}.serviceUrl** +The `serviceUrl` parameter provides a portion of the service instance URL path which replaces the `gatewayUrl` part. +**Note:** The routes configuration used for a direct REST call to register a service must also contain a prefix before the `gatewayUrl` and `serviceUrl`. +This prefix is used to differentiate the routes. This prefix must be provided manually when _XML_ configuration is used. + +#### Authentication parameters +Authentication parameters are grouped under the prefix: `apiml.authentication`. When unspecified, the default values are used. + +This parameter enables a service to accept the Zowe JWT token. The API Gateway translates the token to an authentication method supported by a service. + +The following parameters define the service authentication method: + +* **apiml.authentication.scheme** +This parameter specifies a service authentication scheme. The following schemes are supported by the API Gateway: + + * **bypass** + This value specifies that the token is passed unchanged to the service. + **Note:** This is the default scheme when no authentication parameters are specified. + + * **zoweJwt** + This value specifies that a service accepts the Zowe JWT token. No additional processing is done by the API Gateway. + + * **httpBasicPassTicket** + This value specifies that a service accepts PassTickets in the Authorization header of the HTTP requests using the basic authentication scheme. It is necessary to provide a service APPLID in the `apiml.authentication.applid` parameter. + **Tip:** For more information, see [Enabling PassTicket creation for API Services that Accept PassTickets](authentication-for-apiml-services.md#authentication-with-passtickets). + + * **zosmf** + This value specifies that a service accepts z/OSMF LTPA (Lightweight Third-Party Authentication). This scheme should only be used for a z/OSMF service used by the API Gateway Authentication Service, and other z/OSMF services that are using the same LTPA key. + **Tip:** For more information about z/OSMF Single Sign-on, see [Establishing a single sign-on environment](https://www.ibm.com/support/knowledgecenter/SSLTBW_2.4.0/com.ibm.zosmfcore.multisysplex.help.doc/izuG00hpManageSecurityCredentials.html). + + * **safIdt** + This value specifies that the application recognizes the SAF IDT scheme and fills the `X-SAF-Token` header with the token produced by the Saf IDT provider implementation. For more information, see [Implement a New SAF IDT provider](./implement-new-saf-provider.md) + + * **x509** + This value specifies that a service accepts client certificates forwarded in the HTTP header only. The Gateway service extracts information from a valid client certificate. For validation, the certificate needs to be trusted by API Mediation Layer. Extended Key Usage must either be empty or needs to contain a Client Authentication (1.3.6.1.5.5.7.3.2) entry. To use this scheme, it is also necessary to specify which headers to include. Specify these parameters in `headers`. This scheme does not relate to the certificate used in the TLS handshake between API ML and the southbound service, but rather the certificate that is forwarded in the header that authenticates the user. + + +* **authentication.headers** + + When the `x509` scheme is specified, use the `headers` parameter to select which values to send to a service. Use one of the following values: + + * `X-Certificate-Public` + The public part of the client certificate base64 encoded + + * `X-Certificate-DistinguishedName` + The distinguished name the from client certificate + + * `X-Certificate-CommonName` + The common name from the client certificate + +* **apiml.authentication.applid** +This parameter specifies a service APPLID. This parameter is valid only for the `httpBasicPassTicket` authentication scheme. + +#### API Info parameters +API Info parameters are grouped under the prefix: `apiml.apiInfo`. + +REST services can provide multiple APIs. Add API info parameters for each API that your service wants to expose on the API ML. These parameters provide information for API (Swagger) documentation that is displayed in the API Catalog. + +The following parameters provide the information properties of a single API: + +* **apiml.apiInfo.\{api-index\}.apiId** +The API ID uniquely identifies the API in the API ML. +Multiple services can provide the same API. The API ID can be used +to locate the same APIs that are provided by different services. +The creator of the API defines this ID. +The API ID needs to be a string of up to 64 characters +that uses lowercase alphanumeric characters and a dot: `.`. +**Tip:** We recommend that you use your organization as the prefix. + +* **apiml.apiInfo.\{api-index\}.version** +This parameter specifies the API version. This parameter is used to correctly retrieve the API documentation according to the requested version of the API. + +* **apiml.apiInfo.\{api-index\}.gatewayUrl** +This parameter specifies the base path at the API Gateway where the API is available. Ensure that this value is the same path as the `gatewayUrl` value in the `routes` sections for the routes, which belong to this API. + +* **apiml.apiInfo.\{api-index\}.swaggerUrl** +(Optional) This parameter specifies the Http or Https address where the Swagger JSON document is available. + +* **apiml.apiInfo.\{api-index\}.documentationUrl** +(Optional) This parameter specifies the link to the external documentation. A link to the external documentation can be included along with the Swagger documentation. + +* **apiml.apiInfo.\{api-index\}.defaultApi** +(Optional) This parameter specifies if the API is the default one shown in the API Catalog. If no API has this parameter set to `true`, or multiple APIs have it set to `true`, then the default API becomes the API with the highest major version seen in `apiml.apiInfo.{api-index}.version`. +**Note:** The `{api-index}` is used to differentiate the service APIs. This index must be provided manually when _XML_ configuration is used. In the following example, `0` represents the `api-index`. + +``` +zowe.apiml.sampleclient +https://hostname/sampleclient/api-doc +api/v1 +https://www.zowe.org +``` + +## Sending a heartbeat to API Mediation Layer Discovery Service + +After registration, a service must send a heartbeat periodically to the Discovery Service to indicate that the service is available. When the Discovery Service does not receive a heartbeat, the service instance is deleted from the Discovery Service. + +If the server does not receive a renewal in 90 seconds, it removes the instance from its registry. + +**Note:** We recommend that the interval for the heartbeat is no more than 30 seconds. + + Use the Http `PUT` method in the following format to tell the Discovery Service that your service is available: + +```https://{eureka_hostname}:{eureka_port}/eureka/apps/{serviceId}/{instanceId}``` + +## Validating successful onboarding with the API Mediation Layer +Ensure that you successfully onboarded a service with the API Mediation Layer. + +**Follow these steps:** + 1. [Validate successful onboarding](./onboard-overview.md#verify-successful-onboarding-to-the-api-ml) + + 2. Check that you can access your API service endpoints through the Gateway. + + 3. (Optional) Check that you can access your API service endpoints directly outside of the Gateway. + +## External Resources + + - https://github.com/Netflix/eureka/wiki/Eureka-REST-operations diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-micronaut-enabler.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-micronaut-enabler.md new file mode 100644 index 0000000000..1641488c1e --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-micronaut-enabler.md @@ -0,0 +1,275 @@ +# Onboarding a Micronaut based REST API service + +As an API developer, you can onboard a REST service to the Zowe API Mediation Layer using the Micronaut framework. While using the Spring framework to develop a JVM-based service to register to the API ML is the recommended method, you can use the procedure described in this article to onboard a service using the Micronaut framework. + +:::note +For more information about onboarding API services with the API ML, see the [Onboarding Overview](./onboard-overview.md). +::: + +For Micronaut-related documentation, see the [Micronaut website](https://docs.micronaut.io/latest/guide/index#introduction). + +- [Set up your build automation system](#set-up-your-build-automation-system) + - [Specify the main class](#specify-the-main-class) + - [Define the output jar file](#define-the-output-jar-file) + - (Optional) [Create a shadow jar](#create-a-shadow-jar) + - [Start the application](#start-the-application) +- [Configure the Micronaut application](#configure-the-micronaut-application) + - [Add API ML configuration](#add-api-ml-configuration) + - [Add Micronaut configuration](#add-micronaut-configuration) + - [Set up logging configuration](#optional-set-up-logging-configuration) +- [Validate successful registration](#validate-successful-registration) + +## Set up your build automation system + +Currently, the only build automation system for use with onboarding a Micronaut based service is _Gradle_. + +1. Create a `gradle.properties` file in the root of your project if one does not already exist. + +2. In the `gradle.properties` file, set the URL of the specific Artifactory containing the _SpringEnabler_ artifact. + + ``` + # Repository URL for getting the enabler-java artifact + artifactoryMavenRepo=https://zowe.jfrog.io/zowe/libs-release/ + ``` + +3. Add the following _Gradle_ code block to the `repositories` section of your `build.gradle` file: + + ```gradle + repositories { + ... + + maven { + url artifactoryMavenRepo + } + } + ``` + +4. In the `build.gradle` file, add the micronaut enabler as a dependency: + + ```groovy + implementation "org.zowe.apiml.sdk:onboarding-enabler-micronaut:$zoweApimlVersion" + ``` +5. (Optional) Add a shadow plug-in to create a runnable jar file. Update the `gradle.build file` with a plugin: + + ``` + id 'com.github.johnrengelman.shadow' version '6.1.0' + ``` + +6. Specify the main class with the following script: + + ``` + mainClassName = '${your.packa.name.MainClassName}' #replace with your main class + ``` + +7. Define the output jar file. + + Add the following script to define the output of the jar file: + + ``` + shadowJar { + archiveBaseName.set('micronaut-enabler') + archiveClassifier.set('') + archiveVersion.set('1.0') + } + ``` + The following example shows a sample `gradle.build` file: + + **Example:** + ``` + plugins { + id "io.micronaut.application" version '1.0.5' + id 'com.github.johnrengelman.shadow' version '6.1.0' + } + mainClassName = 'org.zowe.apiml.Application' + + shadowJar { + archiveBaseName.set('micronaut-enabler') + archiveClassifier.set('') + archiveVersion.set('1.0') + } + version "0.1" + group "org.zowe.apiml" + + repositories { + url artifactoryMavenRepo + } + + micronaut { + version = "2.1.3" + runtime "netty" + testRuntime "junit5" + processing { + incremental true + annotations "org.zowe.apiml.*" + } + } + + dependencies { + implementation "org.zowe.apiml. sdk:onboarding-enabler-micronaut:$zoweApimlVersion" + } + + java { + sourceCompatibility = JavaVersion.toVersion('1.8') + targetCompatibility = JavaVersion.toVersion('1.8') + } + ``` + +8. (Optional) Create a shadow jar. + + To create a shadow jar, execute the gradle `shadowJar` task. For this sample, the plugin produces the jar `micronaut-enabler-1.0.jar` in `build/libs` directory. + + You can now run your application with the command `java -jar micronaut-enabler-1.0.jar`. + +9. Start the application. + + From the root directory of your project, start the application with the **`gradle run`** command. + +## Configure the Micronaut application + +Use a yaml file to configure your Micronaut application. +Create the following two sections in your yaml file: + +- `apiml` for API ML configuration +- `micronaut` for micronaut configuration + +### Add API ML configuration + +Use the following procedure to add API ML configuration to the application.yaml. + +**Follow these steps:** + +1. Add the following configuration to the `apiml` section in the yaml file: + + ```yaml + apiml: + enabled: true + service: + serviceId: ${fill.your.serviceId} # The symbolic name of the service + #rest of the configuration + ``` + + - **`fill.your.service`** + Specifies the ID of your service + +2. Add SSL-resolving properties as shown in the following example. Ensure that you structure the nested objects within `apiml.service` as arrays. Be sure to include `-` (hyphen) before `enabled` thereby indicating the first element of the array. + +**Example:** + +```yaml +apiml: + service: + ssl: + - enabled: true + verifySslCertificatesOfServices: true + protocol: TLSv1.2 + enabled-protocols: TLSv1.2 + keyStoreType: ${fill.your.keystoretype} + trustStoreType: ${fill.your.truststoretype} + + keyAlias: ${fill.your.keyAlias} + keyPassword: ${fill.your.keyPassword} + keyStore: ${fill.your..keyStore} + keyStorePassword: ${fill.your.keyStorePassword} + trustStore: ${fill.your.trustStore} + trustStorePassword: ${fill.your.trustStorePassword} + ciphers: ${fill.your.ciphers} + +``` +:::note +For a sample of this configuration, see [API ML Onboarding Configuration Sample](./onboard-spring-boot-enabler.md#api-ml-onboarding-configuration-sample). +::: + +The yaml now contains configuration to register to the API Mediation Layer. + +### Add Micronaut configuration +Once you complete API ML configuration, add configuration to provide correct mapping between API ML and micronaut parameters. + +1. Add the following yaml snippet with the micronaut configuration parameters: + + ```yaml + micronaut: + application: + name: ${apiml.service.serviceId} + server: + port: ${apiml.service.port} + context-path: /${apiml.service.serviceId} + ssl: + enabled: true + key-store: + password: ${apiml.service.ssl[0].keyPassword} + type: ${apiml.service.ssl[0].keyStoreType} + path: file:${apiml.service.ssl[0].keyStore} + key: + alias: ${apiml.service.ssl[0].keyAlias} + password: ${apiml.service.ssl[0].keyPassword} + trust-store: + password: ${apiml.service.ssl[0].trustStorePassword} + path: file:${apiml.service.ssl[0].trustStore} + type: ${apiml.service.ssl[0].trustStoreType} + port: ${apiml.service.port} + ciphers: ${apiml.service.ssl[0].ciphers} + protocol: ${apiml.service.ssl[0].protocol} + ``` + + - **`apiml.service.serviceId`** + Specifies the ID of your service + + - **`apiml.service.port`** + Specifies the port on which the service listens + + - **`apiml.service.ssl[0].keyPassword`** + Specifies the password that protects the key in keystore + + - **`apiml.service.ssl[0].keyStoreType`** + Specifies the type of the keystore, (Example: PKCS12) + + - **`apiml.service.ssl[0].keyStore`** + Specifies the location of the keystore + + - **`apiml.service.ssl[0].keyAlias`** + Specifies the alias under which the key is stored in the keystore + + - **`apiml.service.ssl[0].trustStorePassword`** + Specifies the password that protects the certificates in the truststore + + - **`apiml.service.ssl[0].trustStore`** + Specifies the location of the truststore + + - **`apiml.service.ssl[0].trustStoreType`** + Specifies the type of the truststore, (Example: PKCS12) + + - **`apiml.service.ssl[0].ciphers`** + Specifies the list of ciphers that user wants to enable for TLS communication + + - **`apiml.service.ssl[0].protocol`** + Specifies the type of SSL/TLS protocol (Example: TLSv1.2) + +### (Optional) Set up logging configuration + +Set up custom logging configuration to have more structured output and better control of logs. + +Create a `logback.xml` file in the `resources` folder and include the `application.yml`. Update the `logback.xml` file with the following configuration: + +```xml + + + + + 0 + + + + + %cyan(%d{yyyy-MM-dd HH:mm:ss.SSS,UTC}) %gray(<${logbackService:-${logbackServiceName}}:%thread:${PID:- }>){magenta} %X{userid:-} %highlight(%-5level) %magenta(\(%logger{15}\)){cyan} %msg%n + + + + + + + +``` + +## Validate successful registration + +After you complete the configuration, ensure that your application is visible within Zowe API ML. For more information, see [Validating the discoverability of your API service by the Discovery Service](./onboard-spring-boot-enabler.md#validating-the-discoverability-of-your-api-service-by-the-discovery-service), which describes the validation procedure common for all enablers. diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-nodejs-enabler.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-nodejs-enabler.md new file mode 100644 index 0000000000..e0c27ddbf0 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-nodejs-enabler.md @@ -0,0 +1,160 @@ +# Onboarding a Node.js based REST API service + +This article is part of a series of onboarding articles, which outline the process of onboarding REST API services to the Zowe API Mediation Layer (API ML). As a service developer, you can onboard a REST service based on NodeJS with the API ML with the Zowe API Mediation Layer using our Node.js Enabler. + +:::note +For more information about onboarding API services with the API ML, see the [Onboarding Overview](./onboard-overview.md). +::: + +## Introduction + +The [API ML onboarding Node.js enabler](https://www.npmjs.com/package/@zowe/apiml-onboarding-enabler-nodejs) is an NPM package which helps to simplify the process of onboarding a REST service written in Node.js with the API ML. + +For more information about how to utilize another API ML enablers, see the [Onboarding Overview](onboard-overview.md). +## Onboarding your Node.js service with API ML + +The following steps outline the overall process to onboard a REST service with the API ML using the onboarding Node.js enabler. Each step is described in further detail in this article. + +1. [Prerequisites](#prerequisites) + +2. [Install the npm dependency](#installing-the-npm-dependency) + +3. [Configure your service](#configuring-your-service) + +4. [Register your service with API ML](#registering-your-service-with-api-ml) + +5. (Optional) [Validate the discoverability of your API service by the Discovery Service](#validating-the-discoverability-of-your-api-service-by-the-discovery-service) + +## Prerequisites +Ensure that you meet the following prerequisites: + +* You satisfy the prerequisites from the [Onboarding Overview](onboard-overview.md). +* The REST API service to onboard is written in Node.js. +* The service is enabled to communicate with API ML Discovery Service over a TLS v1.2 secured connection. + +## Installing the npm dependency + +Install the onboarding Node.js enabler package as a dependency of your service. Run the following npm command from your project directory: +``` +npm i @zowe/apiml-onboarding-enabler-nodejs@latest --dev-save +``` +:::note +If you have a multi-module project, you have to run the npm command from the submodule where your Node.js project is located. +::: + +## Configuring your service + +Create a yaml file named `service-configuration.yml` inside a `/config` directory at the same level of your `index.js`, and add the following configuration properties. + +The following example shows a sample configuration. + + **Example:** + + ```yaml + serviceId: hwexpress + title: Hello World express REST API + eureka: + ssl: true + host: localhost + ipAddress: 127.0.0.1 + port: 10011 + servicePath: '/eureka/apps/' + maxRetries: 30 + requestRetryDelay: 1000 + registryFetchInterval: 5 + + + description: Hello World REST API Service implemented in Express and Node.js + baseUrl: https://localhost:10020/hwexpress + homePageRelativeUrl: https://localhost:10020/ + statusPageRelativeUrl: https://localhost:10020/info + healthCheckRelativeUrl: https://localhost:10020/status + discoveryServiceUrls: + - https://localhost:10011/eureka + routes: + - gatewayUrl: api/v1 + serviceRelativeUrl: /api/v1 + apiInfo: + - apiId: zowe.apiml.hwexpress + gatewayUrl: "api/v1" + swaggerUrl: https://localhost:10020/swagger.json + catalogUiTile: + id: cademoapps + title: Sample API Mediation Layer Applications + description: Applications which demonstrate how to make a service integrated to the API Mediation Layer ecosystem + version: 1.0.0 + instance: + app: hwexpress + vipAddress: hwexpress + instanceId: localhost:hwexpress:10020 + homePageUrl: https://localhost:10020/ + hostName: 'localhost' + ipAddr: '127.0.0.1' + secureVipAddress: hwexpress + port: + $: 10020 + '@enabled': false + securePort: + $: 10020 + '@enabled': "true" + + dataCenterInfo: + '@class': com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo + name: MyOwn + metadata: + apiml.catalog.tile.id: 'samplenodeservice' + apiml.catalog.tile.title: 'Zowe Sample Node Service' + apiml.catalog.tile.description: 'NodeJS Sample service running' + apiml.catalog.tile.version: '1.0.0' + apiml.routes.api_v1.gatewayUrl: "api/v1" + apiml.routes.api_v1.serviceUrl: "/api/v1" + apiml.apiInfo.0.apiId: zowe.apiml.hwexpress + apiml.apiInfo.0.gatewayUrl: "api/v1" + apiml.apiInfo.0.swaggerUrl: https://localhost:10020/swagger.json + apiml.service.title: 'Zowe Sample Node Service' + apiml.service.description: 'The Proxy Server is an HTTP HTTPS, and Websocket server built upon NodeJS and ExpressJS.' + + ssl: + certificate: ssl/localhost.keystore.cer + keystore: ssl/localhost.keystore.key + caFile: ssl/localhost.pem + keyPassword: password + + ``` + +## Registering your service with API ML + +To register your service with API ML, use the following procedure. + +1. Inside your Node.js service `index.js`, add the following code block to register your service with Eureka: + + ```js + const apiLayerService = require("@zowe/apiml-onboarding-enabler-nodejs"); + tlsOptions = apiLayerService.tlsOptions; + const httpsServer = https.createServer(tlsOptions, app); + httpsServer.listen(args.port, function () { + apiLayerService.connectToEureka(); + }); + + ``` +2. Start your Node.js service and verify that the service is registered to the Zowe API Mediation Layer. + +## Validating the discoverability of your API service by the Discovery Service + +Once you build and start your service successfully, you can use the option of validating that your service is registered correctly with the API ML Discovery Service. + + 1. [Validate successful onboarding](./onboard-overview.md#verify-successful-onboarding-to-the-api-ml) + + 2. Check that you can access your API service endpoints through the Gateway. + + 3. (Optional) Check that you can access your API service endpoints directly outside of the Gateway. + +Specific addresses and user credentials for the individual API ML components depend on your target runtime environment. + +:::note Notes: +* If you are working with a local installation of API ML, and you are using our dummy identity provider, enter `user` for both `username` and `password`. If API ML was installed by system administrators, ask them to provide you +with actual addresses of API ML components and the respective user credentials. +* Wait for the Discovery Service to fully register your service. This process may take a few minutes after your +service starts successfully. +::: + diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-overview.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-overview.md new file mode 100644 index 0000000000..1388776f0b --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-overview.md @@ -0,0 +1,203 @@ +# Onboarding Overview + +As an API developer, you can onboard a REST API service to the Zowe™ API Mediation Layer (API ML). Onboarding your REST service to the Zowe™ API Mediation Layer will make your service discoverable by the API ML Discovery Service, enable routing through the API Gateway, and make service information and API documentation available through the API Catalog. + +The specific method you use to onboard a REST API to the API ML depends on the programming language or framework used to build your REST service. + + +:::note +To streamline the process of onboarding new REST API services to the Zowe API Mediation Layer, see [Onboarding a REST API service with the YAML Wizard](../../user-guide/onboard-wizard.md) +::: + +This Onboarding Overview article addresses the following topics: + +- [Prerequisites](#prerequisites) +- [Service Onboarding Guides](#service-onboarding-guides) to onboard your REST service with the API ML +- [Verify successful onboarding to the API ML](#verify-successful-onboarding-to-the-api-ml) +- Using the [Sample REST API Service](#sample-rest-api-service) to learn how to onboard a REST service to the API ML + +## Prerequisites + +Meet the following prerequisites before you onboard your service: + +- Running instance of Zowe + + **Note**: For [static onboarding](onboard-static-definition.md), access to Zowe runtime is required to create the static service definition. + +- A certificate that is trusted by Zowe and certificate(s) to trust Zowe services + + Zowe uses secured communication over TLSv1.2. As such, the protocol version and the certificate is required. For more information, see [Certificate management in API Mediation Layer](../extend-apiml/certificate-management-in-zowe-apiml.md) and [Zowe API ML TLS requirements](./zowe-api-mediation-layer-security-overview.md#zowe-api-ml-tls-requirements) + +- A REST API-enabled service that you want to onboard + + If you do not have a specific REST API service, you can use the [sample service](#sample-rest-api-service). + + Your service should be documented in a valid `OpenApi 2.0/3.0` Swagger JSON format. + +- Access to the Zowe artifactory + + ``` + Repository URL: https://zowe.jfrog.io/zowe/libs-release + ``` + +- Either the _Gradle_ or _Maven_ build automation system + +## Service Onboarding Guides + +Services can be updated to support the API Mediation Layer natively by updating the service code. Use one of the following guides to onboard your REST service to the Zowe API Mediation Layer: + +### Recommended guides for services using Java + +- [Onboard a REST API service with the Plain Java Enabler (PJE)](onboard-plain-java-enabler.md) +- [Onboard a Spring Boot based REST API Service](onboard-spring-boot-enabler.md) +- [Onboard a Micronaut based REST API service](onboard-micronaut-enabler.md) + +### Recommended guides for services using Node.js + +- [Onboard a Node.js based REST API Service](onboard-nodejs-enabler.md) + +### Guides for Static Onboarding and Direct Call Onboarding + +Use one of the following guides if your service is not built with Java, or you do not want to change your codebase or use the previously mentioned libraries: + +- [Onboard a REST API using static definition without code changes](onboard-static-definition.md) +- [Onboard a REST API directly calling Zowe Discovery Service](onboard-direct-eureka-call.md) + +### Documentation for legacy enablers + +Enabler version 1.2 and previous versions are no longer supported. + +:::tip +We recommend you use the enabler version 1.3 or higher to onboard your REST API service to the Zowe API Medaition Layer. +::: + +## Verify successful onboarding to the API ML + +Verifying that your service was successfully onboraded to the API ML can be done by ensuring service registration in the API ML Discovery Service or visibility of the service in the API ML Catalog. + +### Verifying service discovery through Discovery Service + +Verify that your service is discovered by the Discovery Service with the following procedure. + + 1. Issue a HTTP GET request to the Discovery Service endpoint `/eureka/apps` to get service instance information: + + ``` + https://{zowe-hostname}:{discovery-service-port}/eureka/apps/{serviceId} + ``` + **Note:** The endpoint is protected by client certificate verification. A valid trusted certificate must be provided with the HTTP GET request. + + 2. Check your service metadata. + + **Response example:** + + ```xml + + {serviceId} + {hostname}:{serviceId}:{port} + {hostname} + {serviceId} + {ipAddress} + UP + {port} + {port} + {serviceId} + {serviceId} + + Sample API service showing how to onboard the service + api/v1 + 1.0.1 + /sampleclient/ws + ws/v1 + Applications which demonstrate how to make a service integrated to the API Mediation Layer ecosystem + Sample Service © + ui/v1 + zowe.apiml.sampleclient + api/v1 + https://www.zowe.org + samples + /sampleclient + /sampleclient/api/v1 + https://hostname/sampleclient/api-doc + Sample API Mediation Layer Applications + + + ``` + :::tip Tips: + - Ensure that addresses and user credentials for individual API ML components correspond to your target runtime environment. + - If you work with local installation of API ML and you use our dummy identity provider, enter `user` for both `username` and `password`. If API ML was installed by system administrators, ask them to provide you with actual addresses of API ML components and the respective user credentials. + ::: + +### Verifying service discovery through the API Catalog + + Services may not be immediately visible in the API Catalog. We recommend you wait for 2 minutes as it may take a moment for your service to be visible in the Catalog. If your service still does not appear in the Catalog, ensure that your configuration settings are correct. + + 1. Check to see that your API service is displayed in the API Catalog UI, and that all information including API documentation is correct. + + 2. Ensure that you can access your API service endpoints through the Gateway. + + +## Sample REST API Service + +To demonstrate the concepts that apply to REST API services, we use an [example of a Spring Boot REST API service](https://github.com/swagger-api/swagger-samples/tree/master/java/java-spring-boot). This example is used in the REST API onboarding guide [REST APIs without code changes required](onboard-static-definition.md) (static onboarding). + +You can build this service using instructions in the source code of the [Spring Boot REST API service example](https://github.com/swagger-api/swagger-samples/blob/master/java/java-spring-boot/README.md). + +The Sample REST API Service has a base URL. When you start this service on your computer, the _service base URL_ is: `http://localhost:8080`. + +:::note +If a service is deployed to a web application server, the base URL of the service (application) has the following format: `https://application-server-hostname:port/application-name`. +::: + +This sample service provides one API that has the base path `/v2`, which is represented in the base URL of the API as `http://localhost:8080/v2`. In this base URL, `/v2` is a qualifier of the base path that was chosen by the developer of this API. Each API has a base path depending on the particular implementation of the service. + +This sample API has only one single endpoint: + +- `/pets/{id}` - *Find pet by ID*. + +This endpoint in the sample service returns information about a pet when the `{id}` is between 0 and 10. If `{id}` is greater than 0 or a non-integer, an error is returned. These are conditions set in the sample service. + +:::tip +Access http://localhost:8080/v2/pets/1 to see what this REST API endpoint does. You should get the following response: + +```json +{ + "category": { + "id": 2, + "name": "Cats" + }, + "id": 1, + "name": "Cat 1", + "photoUrls": [ + "url1", + "url2" + ], + "status": "available", + "tags": [ + { + "id": 1, + "name": "tag1" + }, + { + "id": 2, + "name": "tag2" + } + ] +} +``` +::: + +:::note +The onboarding guides demonstrate how to add the Sample REST API Service to the API Mediation Layer to make the service available through the `petstore` service ID. +::: + +The following diagram shows the relations between the Sample REST API Service and its corresponding API, REST API endpoint, and API Gateway: + +![Sample REST API Components](../../user-guide/api-mediation/diagrams/rest-api-components-sample.svg) + +This sample service provides a Swagger document in JSON format at the following URL: + + ``` + http://localhost:8080/v2/swagger.json + ``` + +The Swagger document is used by the API Catalog to display API documentation. diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-plain-java-enabler-external-configuration.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-plain-java-enabler-external-configuration.md new file mode 100644 index 0000000000..3b7da4bf50 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-plain-java-enabler-external-configuration.md @@ -0,0 +1,222 @@ +# API Mediation Layer onboarding configuration + +This article describes the process of configuring a REST service to onboard with the Zowe API Mediation Layer using the API ML Plain Java Enabler. As a service developer, you can provide basic configuration of a service to onboard to the API ML. You can also externalize configuration parameters for subsequent customization by a systems administrator. + +* [Introduction](#introduction) +* [Configuring a REST service for API ML onboarding](#configuring-a-rest-service-for-api-ml-onboarding) +* [Plain Java Enabler service onboarding](#plain-java-enabler-service-onboarding-api) + * [Automatic initialization of the onboarding configuration by a single method call](#automatic-initialization-of-the-onboarding-configuration-by-a-single-method-call) +* [Validating successful onboarding with the API Mediation Layer](#Validating-successful-onboarding-with-the-API-Mediation-Layer) +* [Loading YAML configuration files](#loading-yaml-configuration-files) + * [Loading a single YAML configuration file](#loading-a-single-yaml-configuration-file) + * [Loading and merging two YAML configuration files](#loading-and-merging-two-yaml-configuration-files) + +## Introduction + +The API ML Plain Java Enabler (PJE) is a library which helps to simplify the process of onboarding a REST service with the API ML. +This article describes how to provide and externalize the Zowe API ML onboarding configuration of your REST service using the PJE. For detailed instructions about how to onboard your API service using the Plain Java Enabler, see [Onboarding a REST API service with the Plain Java Enabler (PJE)](./onboard-plain-java-enabler.md). + +The PJE is the most universal Zowe API ML enabler. This enabler uses only Java, and does not use advanced Inversion of Control (_IoC_) or Dependency Injection (_DI_) technologies. +The PJE enables you to onboard any REST service implemented in Java, avoiding dependencies, versions collisions, unexpected application behavior, and unnecessarily large service executables. + +Service developers provide onboarding configuration as part of the service source code. While this configuration is valid for the development system environment, it is likely to be different for an automated integration environment. Typically, system administrators need to deploy a service on multiple sites that have different system environments and requirements such as security. + +The PJE supports both the service developer and the system administrator with the functionality of externalizing the service onboarding configuration. + +The PJE provides a mechanism to load API ML onboarding service configuration from one or two _YAML_ files. + +## Configuring a REST service for API ML onboarding + +In most cases, the API ML Discovery Service, Gateway, and service endpoint addresses are not known at the time of building the service executables. +Similarly, security material such as certificates, private/public keys, and their corresponding passwords depend on the specific deployment environment, and are not intended to be publicly accessible. +Therefore, to provide a higher level of flexibility, the PJE implements routines to build service onboarding configuration by locating and loading one or two _YAML_ file sources: + +* **internal _service-configuration.yml_** + + The first configuration file is typically internal to the service deployment artifact. This file must be accessible on the service `classpath`. This file contains basic API ML configuration based on values known at development time. Usually, this basic API ML configuration is provided by the service developer and is located in the `/resources` folder of the Java project source tree. This file is usually found in the deployment artifacts under `/WEB-INF/classes`. The configuration contained in this file is provided by the service developer or builder. As such, the configuration will not match every possible production environment and the corresponding requirements of the environment. + +* **external or additional _service-configuration.yml_** + + The second configuration file is used to externalize the configuration. This file can be stored anywhere on the local file system, as long as that the service has access to that location. + This file is provided by the service deployer/system administrator and contains the correct parameter values for the specific production environment. + +At service start-up time, both _YAML_ configuration files are merged, where the externalized configuration (if provided) has higher priority. + +The values of parameters in both files can be rewritten by Java system properties or servlet context parameters that were defined during service installation/configuration, or at start-up time. + +In the _YAML_ file, standard rewriting placeholders for parameter values use the following format: + +`${apiml.parameter.key}` + +The actual values are taken from [key, value] pairs defined as Java system properties or servlet context parameters. The system properties can be provided directly on a command line. The servlet context parameters can be provided in the service `web.xml` or in an external file. + +The specific approach of how to provide the servlet context to the user service application depends on the application loading mechanism and the specific Java servlet container environment. + +**Example:** + +If the service is deployed in a Tomcat servlet container, you can configure the context by placing an _XML_ file with the same name +as the application deployment unit into `_$CATALINA_BASE/conf/[enginename]/[hostname]/_`. + +Other containers provide different mechanisms for the same purpose. + +## Plain Java Enabler service onboarding API + +You can initialize your service onboarding configuration using different methods of the Plain Java Enabler class `ApiMediationServiceConfigReader`: + +### Automatic initialization of the onboarding configuration by a single method call + +The following code block shows automatic initialization of the onboarding configuration by a single method call: + +``` +public ApiMediationServiceConfig initializeAPIMLConfiguration(ServletContext context); +``` + +This method receives the `ServletContext` parameter, which holds a map of parameters that provide all necessary information for building the onboarding configuration. +The following code block is an example of Java Servlet context configuration. + +**Example:** +``` + + + + + + + + + + + + + + + + + + + + +``` + + The two parameters corresponding to the location of the configuration files are: + + * `apiml.config.location` + is parameter describes the location of the basic configuration file. + + * `apiml.config.additional-location` + This parameter describes the location of the external configuration file. + + The method in this example uses the provided configuration file names in order to load them as _YAML_ files into the internal Java configuration object of type _ApiMediationServiceConfig_. + + The other context parameters with the _apiml_ prefix are used to rewrite values of properties in the configuration files. + +## Validating successful onboarding with the API Mediation Layer +To ensure that you successfully onboarded a service with the API Mediation Layer, follow these steps: + + 1. Validate successful onboarding. Follow the procedure described in [Verify successful onboarding to the API ML](./onboard-overview.md#verify-successful-onboarding-to-the-api-ml). + + 2. Check that you can access your API service endpoints through the Gateway. + + 3. (Optional) Check that you can access your API service endpoints directly outside of the Gateway. + + ## Loading YAML configuration files + +_YAML_ configuration files can be loaded either as a single _YAML_ file, or by merging two _YAML_ files. Use the `loadConfiguration` method described later in this article that corresponds to your service requirements. + +After successfully loading a configuration file, the loading method `loadConfiguration` uses Java system properties to substitute corresponding configuration properties. + +### Loading a single YAML configuration file + +To build your configuration from multiple sources, load a single configuration file, and then +rewrite parameters as needed using values from another configuration source. See: [Loading and merging two YAML configuration files](#Loading-and-merging-two-YAML-configuration-files) described later in this article. + +Use the following method to load a single _YAML_ configuration file: + +``` +public ApiMediationServiceConfig loadConfiguration(String configurationFileName); +``` + +This method receives a single _String_ parameter and can be used to load an internal or an external configuration file. + + +:::note +This method first attempts to load the configuration as a Java resource. If the file is not found, the method attempts to resolve the file name as an absolute. If the file name still cannot be found, this method attempts to resolve the file as a relative path. When the file is found, the method loads the contents of the file and maps them to internal data classes. After loading the configuration file, the method attempts to substitute/rewrite configuration property values with corresponding Java System properties. +::: + +### Loading and merging two YAML configuration files + +To load and merge two configuration files, use the following method: + ``` + public ApiMediationServiceConfig loadConfiguration(String internalConfigurationFileName, String externalizedConfigurationFileName) + ``` +where: + +* **String internalConfigurationFileName** +references the basic configuration file name. + +* **String externalizedConfigurationFileName** +references the external configuration file name. + +:::note +The external configuration file takes precedence over the basic configuration file in order to match the target deployment environment. +After loading and before merging, each configuration will be separately patched using Java System properties. +::: + +The following code block presents an example of how to load and merge onboarding configuration from _YAML_ files. + +**Example:** +``` +@Slf4j +public class ApiDiscoveryListener implements ServletContextListener { + + /** + * @{link ApiMediationClient} instance used to register and unregister the service with API ML Discovery service. + */ + private ApiMediationClient apiMediationClient; + + /** + * Creates {@link ApiMediationServiceConfig} + * Creates and initializes {@link ApiMediationClient} instance, which is then used to register this service + * with API ML discovery service. The registration method of ApiMediationClientImpl catches all RuntimeExceptions + * and only can throw {@link ServiceDefinitionException} checked exception. + * + * @param sce + */ + @Override + public void contextInitialized(ServletContextEvent sce) { + + ServletContext context = sce.getServletContext(); + + /* + * Call loadConfiguration method with both config file names initialized above. + */ + ApiMediationServiceConfig defaultConfig = new ApiMediationServiceConfigReader().initializeAPIMLConfiguration(context); + + /* + * Instantiate {@link ApiMediationClientImpl} which is used to un/register the service with API ML Discovery service. + */ + apiMediationClient = new ApiMediationClientImpl(); + + /* + * Call the {@link ApiMediationClient} instance to register your REST service with API ML Discovery service. + */ + try { + apiMediationClient.register(defaultConfig); + } catch (ServiceDefinitionException sde) { + log.error("Service configuration failed. Check log for previous errors: ", sde); + } + } + + /** + * If apiMediationClient is not null, attmpts to unregister this service from API ML registry. + */ + @Override + public void contextDestroyed(ServletContextEvent sce) { + if (apiMediationClient != null) { + apiMediationClient.unregister(); + } + } +} +``` diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-plain-java-enabler.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-plain-java-enabler.md new file mode 100644 index 0000000000..ea23f8be76 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-plain-java-enabler.md @@ -0,0 +1,864 @@ +# Onboarding a REST API service with the Plain Java Enabler (PJE) + +This article is part of a series of onboarding guides, which outline the process of onboarding REST API services to the Zowe API Mediation Layer (API ML). As a service developer, you can onboard a REST service with the API ML with the Zowe API Mediation Layer using our Plain Java Enabler (PJE). This enabler is built without a dependency on Spring Cloud, Spring Boot, or SpringFramework. + +:::tip +For more information about onboarding API services with the API ML, see the [Onboarding Overview](onboard-overview.md). +::: + +## Introduction + +Zowe API ML is a lightweight API management system based on the following Netflix components: + +* Eureka - a discovery service used for services registration and discovery +* Zuul - reverse proxy / API Gateway +* Ribbon - load balancer + +The API ML Discovery Service component uses Netflix/Eureka as a REST services registry. +Eureka endpoints are used to register a service with the API ML Discovery Service. + +The API ML provides onboarding enabler libraries. The libraries are JAR artifacts available through an artifactory. Using these libraries is the recommended approach to onboard a REST service with the API ML. + +The PJE library serves the needs of Java developers who are not using either [Spring Boot](https://spring.io/projects/spring-boot) or the [Spring Framework](https://spring.io/). If Spring Boot or the Spring framework are used in the project you would like to onboard, see the [Onboarding Overview](onboard-overview.md) for the corresponding enablers. + +Additionally, this enabler is not intended for use in projects that depend on [Spring Cloud Netflix](https://spring.io/projects/spring-cloud-netflix) components. Configuration settings in the PJE and Spring Cloud Netflix Eureka Client are different. Using the two configuration settings in combination makes the result state of the discovery registry unpredictable. + +:::tip +For more information about how to utilize another API ML enablers, see the documentation in +the [Onboarding Overview](onboard-overview.md). +::: + +## Onboarding your REST service with API ML + +The following steps outline the overall process to onboard a REST service with the API ML using the PJE. Each step is described in further detail in this article. + +1. [Prerequisites](#prerequisites) + +2. [Configuring your project](#configuring-your-project) + + * [Gradle build automation system](#gradle-build-automation-system) + * [Maven build automation system](#maven-build-automation-system) + +3. [Configuring your service](#configuring-your-service) + * [REST service identification](#rest-service-identification) + * [Administrative endpoints](#administrative-endpoints) + * [API info](#api-info) + * [API routing information](#api-routing-information) + * [API Catalog information](#api-catalog-information) + * [Authentication parameters](#authentication-parameters) + * [API Security](#api-security) + * [SAF Keyring configuration](#saf-keyring-configuration) + * [Eureka Discovery Service](#eureka-discovery-service) + +4. [Registering your service with API ML](#registering-your-service-with-api-ml) + +5. (Optional) [Validating the discoverability of your API service by the Discovery Service](#validating-the-discoverability-of-your-api-service-by-the-discovery-service) + +6. (Optional) [Troubleshooting](#troubleshooting) + * [Log messages during registration problems](#log-messages-during-registration-problems) + +## Prerequisites + +Ensure that the prerequisites from the [Onboarding Overview](onboard-overview.md) are met. + +* The REST API service to onboard is written in Java +* The service is enabled to communicate with API ML Discovery Service over a TLS v1.2 secured connection + +:::noteNotes: + +* This documentation is valid for API ML version `ZoweApimlVersion 1.3.0` and higher. We recommend that you check the [Zowe Artifactory](https://zowe.jfrog.io/zowe/libs-release/org/zowe/apiml/sdk/onboarding-enabler-java/) for the latest stable versions. + +* Following this guide enables REST services to be deployed on a z/OS environment. Deployment to a z/OS environment, however, is not required. As such, you can first develop on a local machine before you deploy on z/OS. + +* The API Mediation Layer provides the sample application using the Plain Java Enabler in the [api-layer repository](https://github.com/zowe/api-layer/tree/v2.x.x/onboarding-enabler-java-sample-app) +::: + +## Configuring your project + +Use either _Gradle_ or _Maven_ build automation systems to configure the project with the service to be onboarded. Use the appropriate configuration procedure that corresponds to your build automation system. + +:::note +You can use either the Zowe Artifactory or an artifactory of your choice. If you decide to build the API ML from source, you are required to publish the enabler artifact to your artifactory. Publish the enabler artifact by using the _Gradle_ tasks provided in the source code. +::: + +### Gradle build automation system +Use the following procedure to use _Gradle_ as your build automation system. + +**Follow these steps:** + +1. Create a `gradle.properties` file in the root of your project if one does not already exist. + +2. In the `gradle.properties` file, set the URL of the specific artifactory containing the PJE artifact. Provide the corresponding credentials to gain access to the Maven repository. + + ```ini + # Repository URL for getting the enabler-java artifact + artifactoryMavenRepo=https://zowe.jfrog.io/zowe/libs-release/ + ``` + +3. Add the following _Gradle_ code block to the `repositories` section of your `build.gradle` file: + + ```gradle + repositories { + ... + + maven { + url artifactoryMavenRepo + } + } + ``` +4. In the same `build.gradle` file, add the necessary dependencies for your service. If you use the Java enabler from the Zowe Artifactory, add the following code block to your `build.gradle` script. Replace the `$zoweApimlVersion` with the proper version of the enabler, for example: `1.3.0`: + + ```gradle + implementation "org.zowe.apiml.sdk:onboarding-enabler-java:$zoweApimlVersion" + implementation "org.zowe.apiml.sdk:common-service-core:$zoweApimlVersion" + ``` + The published artifact from the Zowe Artifactory also contains the enabler dependencies from other software packages. If you are using an artifactory other than Zowe, add also the following dependencies in your service `build.gradle` script: + + ```gradle + implementation "com.netflix.eureka:eureka-client:1.10.15" + implementation "org.apache.httpcomponents:httpcore:4.4.14" + implementation "com.fasterxml.jackson.core:jackson-databind:2.11.4" + implementation "com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.9.10" + + providedCompile "javax.servlet:javax.servlet-api:3.1.0" + compileOnly "org.projectlombok:lombok:1.18.20" + ``` + + **Notes:** + * You may need to add more dependencies as required by your service implementation. + * The information provided in this file is valid for `ZoweApimlVersion 1.3.0` and higher. + +5. In your project home directory, run the `gradle clean build` command to build your project. Alternatively, you can run `gradlew` to use the specific gradle version that is working with your project. + +### Maven build automation system + +Use the following procedure if you use _Maven_ as your build automation system. + +**Follow these steps:** + +1. Add the following _XML_ tags within the newly created `pom.xml` file: + ```xml + + + libs-release + libs-release + https://zowe.jfrog.io/zowe/libs-release/ + + false + + + + ``` + **Tip:** If you want to use snapshot version, replace `libs-release` with `libs-snapshot` in the repository url and change snapshots->enabled to `true`. + +2. Add the proper dependencies: + ```xml + + org.zowe.apiml.sdk + onboarding-enabler-java + $zoweApimlVersion + + + org.zowe.apiml.sdk + common-service-core + $zoweApimlVersion + + ``` + +3. In the directory of your project, run the `mvn clean package` command to build the project. + + +## Configuring your service + +To configure your service, create the configuration file `service-configuration.yml` in your service source tree resources directory. The default path for a java application is `src/main/resources`. The `service-configuration.yml` file is used to set the application properties and eureka metadata. Application properties are for your service runtime. For example, the `ssl` section specifies the keystore and trustore. The eureka metadata is used for registration with API Mediation Layer. + +:::note +To externalize service onboarding configuration, see: [Externalizing onboarding configuration](onboard-plain-java-enabler-external-configuration.md). +::: + +The following code snippet shows an example of `service-configuration.yml`. Some parameters which are specific for your service deployment +are in `${parameterValue}` format. For your service configuration file, provide actual values or externalize your onboarding configuration. + +**Example:** + + ```yaml + serviceId: sampleservice + title: Hello API ML + description: Sample API ML REST Service + baseUrl: https://${samplehost}:${sampleport}/${sampleservice} + serviceIpAddress: ${sampleHostIpAddress} + preferIpAddress: false + + homePageRelativeUrl: /application/home + statusPageRelativeUrl: /application/info + healthCheckRelativeUrl: /application/health + + discoveryServiceUrls: + - https://${discoveryServiceHost1}:${discoveryServicePort1}/eureka + - https://${discoveryServiceHost2}:${discoveryServicePort2}/eureka + + routes: + - gatewayUrl: api/v1 + serviceUrl: /sampleservice/api/v1 + +authentication: + scheme: httpBasicPassTicket + applid: ZOWEAPPL + + apiInfo: + - apiId: zowe.apiml.sampleservice + version: 1.0.0 + gatewayUrl: api/v1 + swaggerUrl: http://${sampleServiceSwaggerHost}:${sampleServiceSwaggerPort}/sampleservice/api-doc + doumentationUrl: http:// + - apiId: zowe.apiml.sampleservice + version: 2.0.0 + gatewayUrl: api/v2 + swaggerUrl: http://${sampleServiceSwaggerHost}:${sampleServiceSwaggerPort}/sampleservice/api-doc?group=api-v2 + documentationUrl: http:// + defaultApi: true + catalog: + tile: + id: sampleservice + title: Hello API ML + description: Sample application to demonstrate exposing a REST API in the ZOWE API ML + version: 1.0.0 + + ssl: + enabled: true + verifySslCertificatesOfServices: true + protocol: TLSv1.2 + keyAlias: localhost + keyPassword: password + keyStore: keystore/localhost.keystore.p12 + keyStoreType: PKCS12 + keyStorePassword: password + trustStore: keystore/localhost.truststore.p12 + trustStoreType: PKCS12 + trustStorePassword: password + ``` + +**Optional metadata section** + +The following snippet presents additional optional metadata that can be added. + +**Example:** + +```yaml +customMetadata: + yourqualifier: + key1: value1 + key2: value2 +``` +The onboarding configuration parameters are broken down into the following groups: + +- [REST service identification](#rest-service-identification) +- [Administrative endpoints](#administrative-endpoints) +- [API info](#api-info) +- [API routing information](#api-routing-information) +- [API catalog information](#api-catalog-information) +- [Authentication parameters](#authentication-parameters) +- [API security](#api-security) +- [SAF Keyring configuration](#saf-keyring-configuration) +- [Eureka Discovery Service](#eureka-discovery-service) +- [Custom Metadata](#custom-metadata) +- [Connection Timeout](#connection-timeout) + +### REST service identification + +* **serviceId** + + The `serviceId` uniquely identifies one or more instance of a microservice in the API ML and is used as part of the service URL path in the API ML Gateway address space. + Additionally, the API ML Gateway uses the `serviceId` for routing to the API service instances. + When two API services use the same `serviceId`, the API Gateway considers the services as clones of each other. + An incoming API request can be routed to either of them through utilized load balancing mechanism. + + **Important!** Ensure that the `serviceId` is set properly with the following considerations: + + * The same `servicedId` should only be set for multiple API service instances for API scalability. + * The `servicedId` value must only contain lowercase alphanumeric characters. + * The `servicedId` cannot contain more than 40 characters. + + **Example:** + * If the `serviceId` is `sampleservice`, the service URL in the API ML Gateway address space appears as the following path: + + ``` + https://gateway-host:gateway-port/sampleservice/api/v1/... + ``` + +* **title** + + This parameter specifies the human readable name of the API service instance. This value is displayed in the API Catalog when a specific API service instance is selected. + This parameter can be externalized and set by the customer system administrator. + + **Tip:** We recommend that service developer provides a default value of the `title`. Use a title that describes the service instance so that the end user knows the specific purpose of the service instance. + +* **description** + + This parameter is a short description of the API service. This value is displayed in the API Catalog when a specific API service instance is selected. This parameter can be externalized and set by the customer system administrator. + + **Tip:** Describe the service so that the end user understands the function of the service. + +* **baseUrl** + + This parameter specifies the base URL for the following administrative endpoints: + + * **homePageRelativeUrl** + * **statusPageRelativeUrl** + * **healthCheckRelativeUrl** + + Use the following format to include your service name in the URL path: + + `protocol://host:port/servicename` + + **Note:** Ensure that the `baseUrl` does not end with a trailing `/`. Inclusion of `/` causes a malformed URL if any of the above administrative endpoints begin with a `/`. It is expected that each administrative endpoint begins with a `/`. Warnings will be logged if this recommendation is not followed. + +* **serviceIpAddress** (Optional) + + This parameter specifies the service IP address and can be provided by a system administrator in the externalized service configuration. + If this parameter is not present in the configuration file or is not set as a service context parameter, it is resolved from the hostname part of the `baseUrl`. + +* **preferIpAddress** (Optional) + + Set the value of this parameter to `true` to advertise a service IP address instead of its hostname. + +### Administrative endpoints + + The following snippet presents the format of the administrative endpoint properties: + +```yaml +homePageRelativeUrl: +statusPageRelativeUrl: /application/info +healthCheckRelativeUrl: /application/health +``` + +* **homePageRelativeUrl** + + Specifies the relative path to the home page of your service. + + Start this path with `/`. If your service has no home page, leave this parameter blank. + + **Examples:** + * `homePageRelativeUrl: ` This service has no home page + * `homePageRelativeUrl: /` This service has a home page with URL `${baseUrl}/` + + +* **statusPageRelativeUrl** + + Specifies the relative path to the status page of your service. + + Start this path with `/`. + + **Example:** + + `statusPageRelativeUrl: /application/info` + + This results in the URL: + `${baseUrl}/application/info` + +* **healthCheckRelativeUrl** + + Specifies the relative path to the health check endpoint of your service. + + Start this path with `/`. + + **Example:** + + `healthCheckRelativeUrl: /application/health` + + This results in the URL: + `${baseUrl}/application/health` + +### API info + +REST services can provide multiple APIs. Add API info parameters for each API that your service wants to expose on the API ML. + +The following snippet presents the information properties of a single API: + +``` +apiInfo: + - apiId: zowe.apiml.sampleservice + version: 1.0.0 + gatewayUrl: api/v1 + swaggerUrl: http://localhost:10021/sampleservice/api-doc + documentationUrl: http://your.service.documentation.url + defaultApi: true + codeSnippet: + - endpoint: /endpoint1 + language: java + codeBlock: | + System.out.println("Greeting code snippet"); + - endpoint: /endpoint2 + language: javascript + codeBlock: | + console.log('hello'); +``` + +* **apiInfo.apiId** + + Specifies the API identifier that is registered in the API ML installation. + The API ID uniquely identifies the API in the API ML. + The `apiId` can be used to locate the same APIs that are provided by different service instances. The API developer defines this ID. + The `apiId` must be a string of up to 64 characters + that uses lowercase alphanumeric characters and a dot: `.` . + +* **apiInfo.version** + + Specifies the api `version`. This parameter is used to correctly retrieve the API documentation according to requested version of the API. + +* **apiInfo.gatewayUrl** + + specifies the base path at the API Gateway where the API is available. + Ensure that this value is the same path as the `gatewayUrl` value in the `routes` sections that apply to this API. + +* **apiInfo.swaggerUrl** (Optional) + + Specifies the Http or Https address where the Swagger JSON document is available. + +* **apiInfo.documentationUrl** (Optional) + + Specifies the link to the external documentation. A link to the external documentation can be included along with the Swagger documentation. + +* **apiInfo.defaultApi** (Optional) + + Specifies that this API is the default one shown in the API Catalog. If no apiInfo fields have `defaultApi` set to `true`, the default API is the one + with the highest API `version`. + +* **apiInfo.codeSnippet** (Optional) + + Specifies the customized code snippet for a specific endpoint (API operation). The snippet is displayed in the API Catalog under the specified operation, after executing + the request using the *Try it out* functionality. + When specifying this configuration, you need to provide the following parameters: + * **`endpoint`** + The endpoint that represents the API operation of the customized snippet + * **`language`** + The language of the snippet + * **`codeBlock`** + The content of the snippet to be displayed in the API Catalog + +### API routing information + +The API routing group provides the required routing information used by the API ML Gateway when routing incoming requests to the corresponding REST API service. +A single route can be used to direct REST calls to multiple resources or API endpoints. The route definition provides rules used by the API ML Gateway to rewrite the URL +in the Gateway address space. Currently, the routing information consists of two parameters per route: The `gatewayUrl` and `serviceUrl`. These two parameters together specify a rule for how the API service endpoints are mapped to the API Gateway endpoints. + +The following snippet is an example of the API routing information properties. + +**Example:** + +```yaml +routes: + - gatewayUrl: api + serviceUrl: /sampleservice-api + - gatewayUrl: api/v1 + serviceUrl: /sampleservice-api/ver1 + - gatewayUrl: api/v1/api-doc + serviceUrl: /sampleservice-api/api-doc +``` + +* **routes** + + Specifies the container element for the route. + +* **routes.gatewayUrl** + + The `gatewayUrl` parameter specifies the portion of the gateway URL which is replaced by the `serviceUrl` path part. + +* **routes.serviceUrl** + + The `serviceUrl` parameter provides a portion of the service instance URL path which replaces the `gatewayUrl` part. + +**Examples:** +* ``` + https://gateway:10010/sampleservice/api + ``` + is routed to: + ``` + https://service:10015/sampleservice-api + ``` +* API major version 1: + ``` + https://gateway:10010/sampleservice/api/v1 + ``` + is routed to: + ``` + https://service:10015/sampleservice-api/ver1 + ``` +* APIs docs major version 1: + ``` + https://gateway:10010/sampleservice/api/v1/api-doc + ``` + is routed to: + ``` + https://service:10015/sampleservice-api/api-doc + ``` + +### API Catalog information + +The API ML Catalog UI displays information about discoverable REST services registered with the API ML Discovery Service. +Information displayed in the Catalog is defined by the metadata provided by your service during registration. The following image is an example of a tile in the API Catalog: + + ![Tile](../../images/api-mediation/API-Catalog-Tile.png "Tile of a sample service in API Catalog") + +The Catalog groups correlated services in the same tile if these services are configured with the same `catalog.tile.id` metadata parameter. + +The following code block is an example of configuration of a service tile in the Catalog: + +**Example:** + +```yaml + catalog: + tile: + id: apimediationlayer + title: API Mediation Layer API + description: The API Mediation Layer for z/OS internal API services. + version: 1.0.0 +``` + +* **catalog.tile.id** + + Specifies the unique identifier for the product family of API services. + This is a value used by the API ML to group multiple API services into a single tile. + Each unique identifier represents a single API dashboard tile in the Catalog. + + **Tip:** Specify a value that does not interfere with API services from other products. We recommend that you use your company and product name as part of the ID. + +* **catalog.tile.title** + + Specifies the title of the product family of the API service. This value is displayed in the API Catalog dashboard as the tile title. + +* **catalog.tile.description** + + The detailed description of the API services product family. This value is displayed in the API Catalog UI dashboard as the tile description. + +* **catalog.tile.version** + + specifies the semantic version of this API Catalog tile. + + **Note:** Ensure that you increase the version number when you introduce changes to the API service product family details. + +### Authentication parameters + +These parameters are not required. Default values are used when parameters are not specified. For more information, see [Authentication Parameters for Onboarding REST API Services](./authentication-for-apiml-services.md#authentication-parameters). + + +### API Security + +REST services onboarded with the API ML act as both a client and a server. When communicating to API ML Discovery service, a REST service acts as a client. When the API ML Gateway is routing requests to a service, the REST service acts as a server. +These two roles have different requirements. +The Zowe API ML Discovery Service communicates with its clients in secure Https mode. As such, TLS/SSL configuration setup is required when a service is acting as a server. In this case, the system administrator decides if the service will communicate with its clients securely or not. + +Client services need to configure several TLS/SSL parameters in order to communicate with the API ML Discovery service. +When an enabler is used to onboard a service, the configuration is provided in the `ssl` section/group in the same _YAML_ file that is used to configure the Eureka parameters and the service metadata. + +For more information about API ML security, see [API ML security overview](https://github.com/zowe/api-layer/blob/v3.x.x/docs/api-ml-security-overview.md). + +TLS/SSL configuration consists of the following parameters: + +* **verifySslCertificatesOfServices** + + This parameter makes it possible to prevent server certificate validation. + + **Important!** Ensure that this parameter is set to `true` in production environments. Setting this parameter to `false` in production environments significantly degrades the overall security of the system. + +* **protocol** + + This parameter specifies the TLS protocol version currently used by Zowe API ML Discovery Service. + + **Tip:** We recommend you use `TLSv1.2` as your security protocol + +* **keyAlias** + + This parameter specifies the `alias` used to address the private key in the keystore. + +* **keyPassword** + + This parameter specifies the password associated with the private key. + +* **keyStore** + + This parameter specifies the keystore file used to store the private key. When using keyring, the value should be set to the SAF keyring location. For information about required certificates, see [Zowe API ML TLS requirements](https://github.com/zowe/api-layer/blob/v3.x.x/docs/api-ml-security-overview.md#zowe-api-ml-tls-requirements). + + + If you have an issue with loading the keystore file in your environment, try to provide the absolute path to the keystore file. The sample keystore file for local deployment is in [api-layer repository](https://github.com/zowe/api-layer/tree/master/keystore/localhost) + +* **keyStorePassword** + + This parameter specifies the password used to unlock the keystore. + +* **keyStoreType** + + This parameter specifies the type of the keystore. + +* **trustStore** + + This parameter specifies the truststore file used to keep other parties public keys and certificates. When using keyring, this value should be set to the SAF keyring location. For information about required certificates, see [Zowe API ML TLS requirements](https://github.com/zowe/api-layer/blob/v3.x.x/docs/api-ml-security-overview.md#zowe-api-ml-tls-requirements). + + If you have an issue with loading the truststore file in your environment, try to provide the absolute path to the truststore file. The sample truststore file for local deployment is in [api-layer repository](https://github.com/zowe/api-layer/tree/master/keystore/localhost) + +* **trustStorePassword: password** + + This parameter specifies the password used to unlock the truststore. + +* **trustStoreType: PKCS12** + + This parameter specifies the truststore type. The default for this parameter is PKCS12. + +**Note:** Ensure that you define both the keystore and the truststore even if your server is not using an Https port. + +### SAF Keyring configuration + +You can choose to use SAF keyring instead of keystore and truststore for storing certificates. +For information about required certificates, see [Zowe API ML TLS requirements](https://github.com/zowe/api-layer/blob/v3.x.x/docs/api-ml-security-overview.md#zowe-api-ml-tls-requirements). For information about running Java on z/OS with keyring, see [SAF Keyring](./certificate-management-in-zowe-apiml.md#api-ml-saf-keyring). + +Make sure that the enabler can access and read the keyring. Please refer to documentation of your security system for details. + +The following example shows enabler configuration with keyrings. + +**Example:** + +``` +ssl: + keyAlias: localhost + keyPassword: password + keyStore: safkeyring://my_racf_id/my_key_ring + keyStorePassword: password + keyStoreType: JCERACFKS + trustStore: safkeyring://my_racf_id/my_key_ring + trustStoreType: JCERACFKS + trustStorePassword: password +``` + +### Eureka Discovery Service + +The Eureka Discovery Service parameters group contains a single parameter used to address Eureka Discovery Service location. +An example is presented in the following snippet: + +**Example:** + +```yaml +discoveryServiceUrls: +- https://localhost:10011/eureka +- http://...... +``` + +* **discoveryServiceUrls** + + Specifies the public URL of the Discovery Service. The system administrator at the customer site defines this parameter. + It is possible to provide multiple values in order to utilize fail over and/or load balancing mechanisms. + +### Custom Metadata + +For information about custom metadata, see the topic [Custom Metadata](./custom-metadata.md). + +## Registering your service with API ML + +The following steps outline the process of registering your service with API ML. Each step is described in detail in this article. The process describes the integration with the usage of the Java application server. The guideline is tested with the Tomcat application server. The specific steps that apply for other application servers may differ. + +1. Add a web application context listener class +2. Register a web application context listener +3. Load service configuration +4. Register with Eureka discovery service +5. Unregister your service + +**Follow these steps:** + +1. Implement and add a web application context listener class: + + ```implements javax.servlet.ServletContextListener``` + + The web application context listener implements two methods to perform necessary actions at application start-up time as well as when the application context is destroyed: + + - The `contextInitialized` method invokes the `apiMediationClient.register(config)` method to register the application with API Mediation Layer when the application starts. + - The `contextDestroyed` method invokes the `apiMediationClient.unregister()` method when the application shuts down. This unregisters the application from the API Mediation Layer. + +2. Register a web application context listener. + + Add the following code block to the deployment descriptor `web.xml` to register a context listener: + + ```xml + + com.your.package.ApiDiscoveryListener + + ``` + +3. Load the service configuration. + + Load your service configuration from a file `service-configuration.yml` file. + The configuration parameters are described in the preceding section, [Configuring your service](#configuring-your-service). + + Use the following code as an example of how to load the service configuration. + + **Example:** + + ```java + @Override + public void contextInitialized(ServletContextEvent sce) { + ... + String configurationFile = "/service-configuration.yml"; + ApiMediationServiceConfig config = new ApiMediationServiceConfigReader().loadConfiguration(configurationFile); + ... + ``` + + **Note:** The `ApiMediationServiceConfigReader` class also provides other methods for loading the configuration from two files, `java.util.Map` instances, or directly from a string. Check the `ApiMediationServiceConfigReader` class JavaDoc for details. + +4. Register with Eureka Discovery Service. + + Use the following call to register your service instance with Eureka Discovery Service: + + **Example:** + + ```java + try { + apiMediationClient = new ApiMediationClientImpl() + apiMediationClient.register(config); + } catch (ServiceDefinitionException sde) { + log.error("Service configuration failed. Check log for previous errors: ", sde); + } + ``` + +5. Unregister your service. + + Use the `contextDestroyed` method to unregister your service instance from Eureka Discovery Service in the following format: + + **Example:** + + ```java + @Override + public void contextDestroyed(ServletContextEvent sce) { + if (apiMediationClient != null) { + apiMediationClient.unregister(); + } + + apiMediationClient = null; + } + ``` + +The following code block is a full example of a context listener class implementation. + +**Example:** +``` +import org.zowe.apiml.eurekaservice.client.ApiMediationClient; +import org.zowe.apiml.eurekaservice.client.config.ApiMediationServiceConfig; +import org.zowe.apiml.eurekaservice.client.impl.ApiMediationClientImpl; +import org.zowe.apiml.eurekaservice.client.util.ApiMediationServiceConfigReader; +import org.zowe.apiml.exception.ServiceDefinitionException; +import lombok.extern.slf4j.Slf4j; + +import javax.servlet.ServletContextEvent; +import javax.servlet.ServletContextListener; + +/** + * API ML Micro service implementation of ServletContextListener interface. + */ +@Slf4j +public class ApiDiscoveryListener implements ServletContextListener { + + /** + * @{link ApiMediationClient} instance used to register and unregister the service with API ML Discovery service. + */ + private ApiMediationClient apiMediationClient; + + /** + * Loads a {@link ApiMediationServiceConfig} using an instance of class ApiMediationServiceConfigReader + * and registers this micro service with API ML. + * + * {@link ApiMediationServiceConfigReader} has several methods for loading configuration from YAML file, + * {@link java.util.Map} or a string containing the configuration data. + * + * Here we use the most convenient method for our Java Servlet based service, + * i.e expecting all the necessary initialization information to be present + * in the {@link javax.servlet.ServletContext} init parameters. + + * After successful initialization, this method creates an {@link ApiMediationClient} instance, + * which is then used to register this service with API ML Discovery Service. + * + * The registration method of ApiMediationClientImpl catches all RuntimeExceptions + * and only can throw {@link ServiceDefinitionException} checked exception. + * + * @param sce + */ + @Override + public void contextInitialized(ServletContextEvent sce) { + try { + /* + * Load configuration method with ServletContext + */ + ApiMediationServiceConfig config = new ApiMediationServiceConfigReader().loadConfiguration(sce.getServletContext()); + if (config != null) { + /* + * Instantiate {@link ApiMediationClientImpl} which is used to un/register the service with API ML Discovery Service. + */ + apiMediationClient = new ApiMediationClientImpl(); + + /* + * Call the {@link ApiMediationClient} instance to register your micro service with API ML Discovery Service. + */ + apiMediationClient.register(config); + } + } catch (ServiceDefinitionException sde) { + log.error("Service configuration failed. Check log for previous errors: ", sde); + } + } + + /** + * If apiMediationClient is not null, attempt to unregister this service from API ML registry. + */ + @Override + public void contextDestroyed(ServletContextEvent sce) { + if (apiMediationClient != null) { + apiMediationClient.unregister(); + } + + apiMediationClient = null; + } +} +``` + +## Validating the discoverability of your API service by the Discovery Service +Once you are able to build and start your service successfully, you can use the option of validating that your service is registered correctly with the API ML Discovery Service. + +**Follow these steps:** + 1. [Validate successful onboarding](./onboard-overview.md#verify-successful-onboarding-to-the-api-ml). + + 2. Check that you can access your API service endpoints through the Gateway. + + 3. (Optional) Check that you can access your API service endpoints directly outside of the Gateway. + +Specific addresses and user credentials for the individual API ML components depend on your target runtime environment. + +:::note +If you are working with local installation of API ML and you are using our dummy identity provider, enter `user` +for both `username` and `password`. If API ML was installed by system administrators, ask them to provide you +with actual addresses of API ML components and the respective user credentials. +::: + +:::tip +Wait for the Discovery Service to discover your service. This process may take a few minutes after your service was successfully started. +::: + +## Troubleshooting + +#### Log messages during registration problems + +When an Enabler connects to the Discovery service and fails, an error message prints to the Enabler log. The default setting does not suppress these messages as they are useful to resolve problems during the Enabler registration. Possible reasons for failure include the location of Discovery service is not correct, the Discovery Service is down, or the TLS certificate is invalid. + +These messages continue to print to the Enabler log, while the Enabler retries to connect to the Discovery Service. +To fully suppress these messages in your logging framework, set the log levels to `OFF` on the following loggers: + + com.netflix.discovery.DiscoveryClient, com.netflix.discovery.shared.transport.decorator.RedirectingEurekaHttpClient + +Some logging frameworks provide other tools to suppress repeated messages. Consult the documentation of the logging framework you use to find out what tools are available. The following example demonstrates how the Logback framework can be used to suppress repeated messages. + +**Example:** + +Add the following code to your configuration file if you use XML configuration: +``` + + 0 + +``` + +:::note +For more information, see the [full configuration used in the Core Services](https://github.com/zowe/api-layer/blob/master/apiml-common/src/main/resources/logback.xml) in GitHub. +::: diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-spring-boot-enabler.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-spring-boot-enabler.md new file mode 100644 index 0000000000..09f9bb37e1 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-spring-boot-enabler.md @@ -0,0 +1,636 @@ +# Onboarding a Spring Boot based REST API Service + +This guide is part of a series of guides to onboard a REST API service with the Zowe API Mediation Layer. +As an API developer, you can onboard your REST API service built with the Spring Boot framework with the Zowe API Mediation Layer. + +:::note +Before API ML version 1.2, the API ML provided an integration enabler based on Spring Cloud Netflix components. From version 1.3 and later, the API ML uses a new implementation based on the Plain Java Enabler (PJE) that is not backwards compatible with the previous enabler versions. API ML core services (Discovery Service, Gateway, and API Catalog) support both the old and new enabler versions. +::: + +:::tip +For more information about how to utilize another onboarding method, see: + + * [Onboard a REST API service with the Plain Java Enabler (PJE)](onboard-plain-java-enabler.md) + * [Onboard a REST service directly calling eureka with xml configuration](onboard-direct-eureka-call.md) + * [Onboard an existing REST API service without code changes](onboard-static-definition.md) +::: + +## Outline of onboarding a REST service using Spring Boot + +The following steps outline the overall process to onboard a REST service with the API ML using a Spring Boot enabler. Each step is described in further detail in this article. + +1. [Selecting a Spring Boot Enabler](#selecting-a-spring-boot-enabler) + +2. [Configuring your project](#configuring-your-project) + + * [Gradle build automation system](#gradle-build-automation-system) + * [Maven build automation system](#maven-build-automation-system) + +3. [Configuring your Spring Boot based service to onboard with API ML](#configuring-your-spring-boot-based-service-to-onboard-with-api-ml) + + * [Sample API ML Onboarding Configuration](#sample-api-ml-onboarding-configuration) + * [Authentication properties](#authentication-properties) + * [API ML Onboarding Configuration Sample](#api-ml-onboarding-configuration-sample) + * [SAF Keyring configuration](#saf-keyring-configuration) + * [Custom Metadata](#custom-metadata) + * [Api Mediation Layer specific metadata](#api-mediation-layer-specific-metadata) + +4. [Registering and unregistering your service with API ML](#registering-and-unregistering-your-service-with-api-ml) + + * [Unregistering your service with API ML](#unregistering-your-service-with-api-ml) + * [Basic routing](#basic-routing) + +5. [Adding API documentation](#adding-api-documentation) + +6. (Optional) [Validating the discoverability of your API service by the Discovery Service](#validating-the-discoverability-of-your-api-service-by-the-discovery-service) + +7. (Optional) [Troubleshooting](#troubleshooting) + * [Log messages during registration problems](#log-messages-during-registration-problems) + +## Selecting a Spring Boot Enabler + +Add a dependency on the Spring Enabler version to your project build configuration that corresponds to the Spring Boot version that you use for the whole project: + + * onboarding-enabler-spring-v1 + * onboarding-enabler-spring-v2 + +:::note +The process of onboarding an API service is the same for both Spring Boot enabler versions. +::: + +## Configuring your project + +Use either _Gradle_ or _Maven_ as your build automation system to manage your project builds. + +:::note +You can download the selected enabler artifact from the [Zowe Artifactory](https://zowe.jfrog.io/zowe/libs-release/org/zowe/apiml/sdk/onboarding-enabler-java/) for latest stable versions.. Alternatively, if you decide to build the API ML from source, it is necessary to publish the enabler artifact to your Artifactory. Publish the enabler artifact by using the _Gradle_ tasks provided in the source code. +::: + +### Gradle build automation system +Use the following procedure to use _Gradle_ as your build automation system. + +**Follow these steps:** + +1. Create a `gradle.properties` file in the root of your project if one does not already exist. + +2. In the `gradle.properties` file, set the URL of the specific Artifactory containing the _SpringEnabler_ artifact. + + ``` + # Repository URL for getting the enabler-java artifact + artifactoryMavenRepo=https://zowe.jfrog.io/zowe/libs-release/ + ``` + +3. Add the following _Gradle_ code block to the `repositories` section of your `build.gradle` file: + + ```gradle + repositories { + ... + + maven { + url artifactoryMavenRepo + } + } + ``` + +4. In the same `build.gradle` file, add the necessary dependencies for your service. If you use the _SpringEnabler_ from the Zowe Artifactory, add the following code block to your `build.gradle` script: + + Use the corresponding artifact according to the Zowe APIML version you are using. + + - For Zowe APIML versions greater than 1.23.5 use the following artifact: + + ```groovy + implementation "org.zowe.apiml.sdk:onboarding-enabler-spring:$zoweApimlVersion" + ``` + + - For Zowe APIML version 1.23.5 use the following artifact: + + ```groovy + implementation "org.zowe.apiml.sdk:onboarding-enabler-spring-v2-springboot-2.3.12.RELEASE:$zoweApimlVersion" + ``` + + - For Zowe APIML versions 1.22.3, 1.22.4, and 1.23.0 - 1.23.4 use the following artifact: + + ```groovy + implementation "org.zowe.apiml.sdk:onboarding-enabler-spring-v2-springboot-2.3.11.RELEASE:$zoweApimlVersion" + ``` + + - For Zowe APIML versions 1.21.6 - 1.21.13 and 1.22.0 - 1.22.2 use the following artifact: + + ```groovy + implementation "org.zowe.apiml.sdk:onboarding-enabler-spring-v2-springboot-2.3.9.RELEASE:$zoweApimlVersion" + ``` + + - For Zowe APIML versions earlier than 1.21.6 that use Spring 2.1.1 use the following artifact: + + ```groovy + implementation "org.zowe.apiml.sdk:onboarding-enabler-spring-v2-springboot-2.1.1.RELEASE:$zoweApimlVersion" + ``` + + - For Zowe APIML versions earlier than 1.21.6 that use Spring 1.5.9 use the following artifact: + + ```groovy + implementation "org.zowe.apiml.sdk:onboarding-enabler-spring-v1-springboot-1.5.9.RELEASE:$zoweApimlVersion" + ``` + + **Notes:** + * You may need to add additional dependencies as required by your service implementation. + * The information provided in this file is valid for `ZoweApimlVersion 1.3.0` and above. + +5. In your project home directory, run the `gradle clean build` command to build your project. Alternatively, you can run `gradlew` to use the specific gradle version that is working with your project. + +### Maven build automation system + +Use the following procedure if you use _Maven_ as your build automation system. + +**Follow these steps:** + +1. Add the following _XML_ tags within the newly created `pom.xml` file: + ```xml + + + libs-release + libs-release + https://zowe.jfrog.io/zowe/libs-release/ + + false + + + + ``` + + **Tip:** If you want to use snapshot version, replace libs-release with libs-snapshot in the repository url and change snapshots->enabled to true. + +2. Add the proper dependencies + + - For Zowe APIML versions greater than 1.23.5 use the following artifact: + + ```XML + + org.zowe.apiml.sdk + onboarding-enabler-spring + $zoweApimlVersion + + ``` + + - For Zowe APIML version 1.23.5 use the following artifact: + + ```XML + + org.zowe.apiml.sdk + onboarding-enabler-spring-v2-springboot-2.3.12.RELEASE + $zoweApimlVersion + + ``` + + - For Zowe APIML versions 1.22.3, 1.22.4, and 1.23.0 - 1.23.4 use the following artifact: + + ```XML + + org.zowe.apiml.sdk + onboarding-enabler-spring-v2-springboot-2.3.11.RELEASE + $zoweApimlVersion + + ``` + + - For Zowe APIML versions 1.21.6 - 1.21.13 and 1.22.0 - 1.22.2 use the following artifact: + + ```XML + + org.zowe.apiml.sdk + onboarding-enabler-spring-v2-springboot-2.3.9.RELEASE + $zoweApimlVersion + + ``` + + - For Zowe APIML versions earlier than 1.21.6 that use Spring 2.1.1 use the following artifact: + + ```XML + + org.zowe.apiml.sdk + onboarding-enabler-spring-v2-springboot-2.1.1.RELEASE + $zoweApimlVersion + + ``` + + - For Zowe APIML versions earlier than 1.21.6 that use Spring 1.5.9 use the following artifact: + + ```XML + + org.zowe.apiml.sdk + onboarding-enabler-spring-v1-springboot-1.5.9.RELEASE + $zoweApimlVersion + + ``` + +3. In the directory of your project, run the `mvn clean package` command to build the project. + +## Configuring your Spring Boot based service to onboard with API ML + +To configure a Spring Boot based service, it is useful to first understand how API ML enabled service Spring Boot based configuration relates to configuration using the Plain Java Enabler. + +Spring Boot expects to find the default configuration of an application in an `application.yml` file that is placed on the classpath. Typically `application.yml` contains Spring Boot specific properties such as properties that are used to start a web application container including TLS security, different spring configuration profiles definitions, and other properties. This `application.yml` must contain the Plain Java Enabler API ML service configuration under the `apiml.service` prefix. The API ML configuration under this prefix is necessary to synchronize the configuration of `apiml.service` with the spring `server` configuration. + +Configuration properties belong to two categories: + + * Service related properties which include endpoints, relative paths, or API documentation definitions. + * Environment related properties which include host names, ports, context etc. + +Execution environment related properties should be provided by additional configuration mechanisms that are specific to the target execution environment. Execution environment related properties for development deployments on a local machine differ with those properties on a mainframe system. + + * In a development environment, provide execution environment related properties in an additional `YAML` file with the system property in the following format: + ``` + -Dspring.config.additional-location=PATH_TO_YAML_FILE + ``` + + * On the mainframe system, provide additional configuration properties and values for existing configuration properties through Java system properties. + + Execution environments for local development deployments and mainframe deployment are described in detail later in this article. + +**Follow these steps:** + +1. Provide a configuration section for onboarding with API ML in the `application.yml` file. + + * If you have already onboarded your service with API ML, copy and paste the contents of your existing API ML onboarding configuration file. The default of the API ML onboarding configuration file is the `service-configuration.yml` in the `application.yml` file under the `apiml.service` prefix. + + * If you have not yet onboarded your REST service with API ML, use the [Sample API Onboarding Configuration](#sample-api-ml-onboarding-configuration) to get started. + +2. If you are reusing your existing API ML onboarding configuration, modify the API ML related properties of the `application.yml` file. + + a) Remove certain properties under the `apiml.service` section, which must be externalized. Properties for removal are described in the following sample of API ML onboarding configuration. + + b) Provide the following additional properties under the `apiml` section: + + ``` + enabled: true # If true, the service will automatically register with API ML discovery service. + + enableUrlEncodedCharacters: true + ``` + + These additional properties are contained in the following sample. + + +### Sample API ML Onboarding Configuration + +In the following sample API ML onboarding configuration, properties prefixed with `###` (3 hashtags) indicate that their value must be provided as `-Dsystem.property.key=PROPERTY_VALUE` defined in the mainframe execution environment. +The `-Dsystem.property.key` must be the same as the flattened path of the YAML property which is commented out with `###`. +These properties must not be defined (uncommented) in your default service YAML configuration file. + +**Example:** + +```yaml + apiml: + service: + ### hostname: +``` + +In this example from the YAML configuration file, when the application service is run on the mainframe, provide your mainframe hostname value on the Java execution command line in the following format: +``` +-Dapiml.service.hostname=YOUR-MAINFRAME-HOSTNAME-VALUE +``` +Since this value is provided in the Java execution command line, leave the property commented out in the `application.yml`. + +For development purposes, you can replace or add any property by providing the same configuration structure in an external +YAML configuration file. When running your application, provide the name of the external/additional +configuration file on the command line in the following format: +``` +-Dspring.config.additional-location=PATH_TO_YOUR_EXTERNAL_CONFIG_FILE +``` + +A property notation provided in the format `-Dproperty.key=PROPERTY_VALUE` can be used for two purposes: + + * To provide a runtime value for any `YAML` property if + `${property.key}` is used as its value (after `:`) in the YAML configuration file + + **Example:** + + ```yaml + some_property_path: + property: + key: ${property.key} + ``` + + * To add a property to configuration if the property does not already exist + + **Example:** + + ```yaml + property: + key: PROPERTY_VALUE + ``` + +:::note +System properties provided with `-D` notation on the command line will not replace properties defined +in any of the YAML configuration files. +::: + +### Authentication properties +These parameters are not required. If a parameter is not specified, a default value is used. See [Authentication Parameters for Onboarding REST API Services](./authentication-for-apiml-services.md#authentication-parameters) for more details. + +### API ML Onboarding Configuration Sample + +Some parameters which are specific for your service deployment +are written in `${fill.your.parameterValue}` format. For your service configuration file, provide actual values or externalize your configuration using `-D` java commandline parameters. + +```yaml +spring: + application: + name: ${apiml.service.serviceId} # Has to be same as apiml.service.serviceId property + +apiml: + enabled: true # Decision if the service should automatically register with API ML discovery service + enableUrlEncodedCharacters: true # Decision if the service requests the API ML GW to receive encoded characters in the URL + service: # The root of API ML onboarding configuration + + serviceId: ${fill.your.serviceId} # The symbolic name of the service + title: ${fill.your.title} + description: ${fill.your.description} # API service description + + scheme: https + hostname: ${fill.your.hostname} # hostname can be externalized by specifying -Dapiml.service.hostname command line parameter + port: ${fill.your.port} # port can be externalized by specifying -Dapiml.service.port command line parameter + serviceIpAddress: ${fill.your.ipAddress} # serviceIpAddress can be externalized by specifying -Dapiml.service.ipAddress command line parameter + + baseUrl: ${apiml.service.scheme}://${apiml.service.hostname}:${apiml.service.port} + contextPath: /${apiml.service.serviceId} # By default the contextPath is set to be the same as apiml.service.serviceId, but doesn't have to be the same + + homePageRelativeUrl: ${apiml.service.contextPath} + statusPageRelativeUrl: ${apiml.service.contextPath}/application/info + healthCheckRelativeUrl: ${apiml.service.contextPath}/application/health + + discoveryServiceUrls: https://${fill.your.discoveryServiceHost1}:${fill.your.discoveryServicePort1}/eureka # discoveryServiceUrlscan be externalized by specifying -Dapiml.service.discoveryServiceUrls command line parameter + + routes: + - gateway-url: "ui/v1" + service-url: ${apiml.service.contextPath} + - gateway-url: "api/v1" + service-url: ${apiml.service.contextPath}/api/v1 + - gateway-url: "ws/v1" + service-url: ${apiml.service.contextPath}/ws + + authentication: + scheme: httpBasicPassTicket + applid: ZOWEAPPL + + apiInfo: + - apiId: zowe.apiml.sampleservice + version: 1.0.0 + gatewayUrl: api/v1 + swaggerUrl: ${apiml.service.scheme}://${apiml.service.hostname}:${apiml.service.port}${apiml.service.contextPath}/api-doc + documentationUrl: https://www.zowe.org + - apiId: zowe.apiml.sampleservice + version: 2.0.0 + gatewayUrl: api/v2 + swaggerUrl: ${apiml.service.scheme}://${apiml.service.hostname}:${apiml.service.port}${apiml.service.contextPath}/api-doc?group=apiv2 + documentationUrl: https://www.zowe.org + + catalog: + tile: + id: cademoapps # Provide ID for your service Catalog tile + title: Sample API Mediation Layer Applications + description: Applications which demonstrate how to make a service integrated to the API Mediation Layer ecosystem + version: 1.0.1 + + ssl: + ## This part configures the http client that connects to Discovery Service. You might reuse your server.ssl.xxx properties that configure your application's servlet. + enabled: true + verifySslCertificatesOfServices: true + protocol: TLSv1.2 + enabled-protocols: TLSv1.2 + keyStoreType: ${fill.your.keystoretype} + trustStoreType: ${fill.your.truststoretype} + + ### DEFINE FOLLOWING PROPERTIES IN EXTERNAL CONFIGURATION + keyAlias: ${fill.your.keyAlias} + keyPassword: ${fill.your.keyPassword} + keyStore: ${fill.your..keyStore} + keyStorePassword: ${fill.your.keyStorePassword} + trustStore: ${fill.your.trustStore} + trustStorePassword: ${fill.your.trustStorePassword} + + # Optional metadata section + customMetadata: + yourqualifier: + key1: value1 + key2: value2 + +# rest of your configuration +# server: .... +# yourApplicationConfiguration: .... +# and other properties +``` + +:::tip +To determine if your configuration is complete, set the logging level to `debug` and run your application. Setting the logging level to 'debug' enables you to troubleshoot issues with certificates for HTTPS and connections with other services. + +```yaml +logging: + level: + ROOT: INFO + org.zowe.apiml: DEBUG +``` +::: + +3. Provide the suitable parameter corresponding to your runtime environment: + + * For a local machine runtime environment, provide the following parameter on your command line: + + ``` + -Dspring.config.additional-location=PATH-TO_EXTERNAL-YAML-CONFIG-FILE + ``` + + At runtime, Spring will merge the two `YAML` configuration files, whereby the properties in the external file have higher priority. + + * For a mainframe execution environment, provide environment specific configuration properties. Define these configuration properties and provide them using Java System Properties on the application execution command line. + + **Important!** Ensure that the default configuration contains only properties which are not dependent on the deployment environment. + Do not include security sensitive data in the default configuration. + + **Note:** For details about the configuration properties, + see [Configuring your service](onboard-plain-java-enabler.md#configuring-your-service) + in the article _Onboarding a REST API service with the Plain Java Enabler (PJE)_. + +### SAF Keyring configuration + +You can choose to use a SAF keyring instead of keystore and truststore for storing certificates. +For information about required certificates, see [Zowe API ML TLS requirements](./zowe-api-mediation-layer-security-overview.md#zowe-api-ml-tls-requirements). For information about running Java on z/OS with a keyring, see [SAF Keyring](./certificate-management-in-zowe-apiml.md). Make sure that the enabler can access and read the keyring. Please refer to documentation of your security system for details. + +The following example shows enabler configuration with keyrings: +``` +ssl: + keyAlias: localhost + keyPassword: password + keyStore: safkeyring://my_racf_id/my_key_ring + keyStorePassword: password + keyStoreType: JCERACFKS + trustStore: safkeyring://my_racf_id/my_key_ring + trustStoreType: JCERACFKS + trustStorePassword: password +``` + +### Custom Metadata + +For information about customizing metadata to add to the instance information registered in the Discovery Service, see [Customizing Metadata](./custom-metadata.md). + +## Registering and unregistering your service with API ML + +Onboarding a REST service to the API ML means registering the service with the API ML Discovery Service. The registration is triggered automatically by Spring after the service application context is fully initialized by firing a `ContextRefreshed` event. + +To register your REST service with API ML using a Spring Boot enabler, annotate your application `main` class with `@EnableApiDiscovery`. + +### Unregistering your service with API ML + +Unregistering a service onboarded with API ML is done automatically at the end of the service application shutdown process in which Spring fires a `ContextClosed` event. The Spring onboarding enabler listens for this event and issues an `unregister` REST call to the API ML Discovery Service. + +### Basic routing + +For information about basic routing in the API ML, see [API ML Basic Routing](./api-mediation-routing.md) + +## Adding API documentation + +Use the following procedure to add Swagger API documentation to your project. + +**Follow these steps:** + +1. Add a SpringFox Swagger dependency. + + * For _Gradle_, add the following dependency in `build.gradle`: + + ```groovy + compile "io.springfox:springfox-swagger2:2.9.2" + ``` + + * For _Maven_, add the following dependency in `pom.xml`: + + ```xml + + io.springfox + springfox-swagger2 + 2.9.2 + + ``` + +2. Add a Spring configuration class to your project. + + **Example:** + + ```java + package org.zowe.apiml.sampleservice.configuration; + + import org.springframework.context.annotation.Bean; + import org.springframework.context.annotation.Configuration; + import org.springframework.web.servlet.config.annotation.EnableWebMvc; + import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter; + import springfox.documentation.builders.PathSelectors; + import springfox.documentation.builders.RequestHandlerSelectors; + import springfox.documentation.service.ApiInfo; + import springfox.documentation.service.Contact; + import springfox.documentation.spi.DocumentationType; + import springfox.documentation.spring.web.plugins.Docket; + import springfox.documentation.swagger2.annotations.EnableSwagger2; + + import java.util.ArrayList; + + @Configuration + @EnableSwagger2 + @EnableWebMvc + public class SwaggerConfiguration extends WebMvcConfigurerAdapter { + @Bean + public Docket api() { + return new Docket(DocumentationType.SWAGGER_2) + .select() + .apis(RequestHandlerSelectors.any()) + .paths(PathSelectors.ant("/api/v1/**")) + .build() + .apiInfo(new ApiInfo( + "Spring REST API", + "Example of REST API", + "1.0.0", + null, + null, + null, + null, + new ArrayList<>() + )); + } + + @Bean + public Docket apiv2() { + return new Docket(DocumentationType.SWAGGER_2) + .groupName("apiv2") + .select() + .apis(RequestHandlerSelectors.any()) + .paths(PathSelectors.ant("/api/v2/**")) + .build() + .apiInfo(new ApiInfo( + "Spring REST API", + "Example of REST API", + "1.0.0", + null, + null, + null, + null, + new ArrayList<>() + )); + } + } + ``` + +3. Customize this configuration according to your specifications. For more information about customization properties, +see [Springfox documentation](https://springfox.github.io/springfox/docs/snapshot/#configuring-springfox). + +:::note +The current SpringFox Version 2.9.2 does not support OpenAPI 3.0. +For more information about the open feature request see this [issue](https://github.com/springfox/springfox/issues/2022). +::: + +## Validating the discoverability of your API service by the Discovery Service + +Once you build and start your service successfully, you can use the option of validating that your service is registered correctly with the API ML Discovery Service. + +**Follow these steps:** + 1. [Validate successful onboarding](./onboard-overview.md#verify-successful-onboarding-to-the-api-ml) + + 2. Check that you can access your API service endpoints through the Gateway. + + 3. (Optional) Check that you can access your API service endpoints directly outside of the Gateway. + +Specific addresses and user credentials for the individual API ML components depend on your target runtime environment. + +:::note +If you are working with local installation of API ML and you are using our dummy identity provider, enter `user` +for both `username` and `password`. If API ML was installed by system administrators, ask them to provide you +with actual addresses of API ML components and the respective user credentials. +::: + +:::tip +Wait for the Discovery Service to fully register your service. This process may take a few minutes after your service was successfully started. +::: + + +## Troubleshooting + +#### Log messages during registration problems + +When an Enabler connects to the Discovery Service and fails, an error message prints to the Enabler log. The default setting does not suppress these messages as they are useful to resolve problems during the Enabler registration. Possible reasons for failure include the location of Discovery Service is not correct, the Discovery Service is down, or the TLS certificate is invalid. These messages continue to print to the Enabler log, while the Enabler retries to connect to the Discovery Service. + +To fully suppress these messages in your logging framework, set the log levels to `OFF` on the following loggers: + + ``` + com.netflix.discovery.DiscoveryClient, com.netflix.discovery.shared.transport.decorator.RedirectingEurekaHttpClient + ``` + +Some logging frameworks provide other tools to suppress repeated messages. Consult the documentation of the logging framework you use to find out what tools are available. The following example demonstrates how the Logback framework can be used to suppress repeated messages. + +**Example:** + +Add the following code to your configuration file if you use XML configuration: + +``` + + 0 + +``` + +:::note +For more information, see the [full configuration used in the Core Services](https://github.com/zowe/api-layer/blob/master/apiml-common/src/main/resources/logback.xml) in GitHub. +::: diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-static-definition.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-static-definition.md new file mode 100644 index 0000000000..3bac907fa8 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/onboard-static-definition.md @@ -0,0 +1,551 @@ +# Onboarding a REST API without code changes required + +As a user of Zowe™, onboard an existing REST API service to the Zowe™ API Mediation Layer without changing the code of the API service. This form of onboarding is also refered to as, "static onboarding". + +:::note +When developing a new service, it is not recommended to onboard a REST service using this method, as this method is non-native to the API Mediation Layer. For a complete list of methods to onboard a REST service natively to the API Mediation Layer, see the [Onboarding Overview](onboard-overview.md#service-onboarding-guides). +::: + +The following procedure outlines the steps to onboard an API service through the API Gateway in the API Mediation Layer without requiring code changes. + +* [Identify the API that you want to expose](#identify-the-api-that-you-want-to-expose) +* [Define your service and API in YAML format](#define-your-service-and-api-in-yaml-format) +* [Route your API](#route-your-api) +* [Customize configuration parameters](#customize-configuration-parameters) +* [Add and validate the definition in the API Mediation Layer running on your machine](#add-and-validate-the-definition-in-the-api-mediation-layer-running-on-your-machine) +* [Add a definition in the API Mediation Layer in the Zowe runtime](#add-a-definition-in-the-api-mediation-layer-in-the-zowe-runtime) +* [(Optional) Check the log of the API Mediation Layer](#optional-check-the-log-of-the-api-mediation-layer) +* [(Optional) Reload the services definition after the update when the API Mediation Layer is already started](#optional-reload-the-services-definition-after-the-update-when-the-api-mediation-layer-is-already-started) + +:::tip +For more information about the structure of APIs and which APIs to expose in the Zowe API Mediation Layer, see the [Onboarding Overview](onboard-overview.md). +::: + +## Identify the APIs that you want to expose + +The first step in API service onboarding is to identify the APIs that you want to expose. + +**Follow these steps:** + +1. Identify the following parameters of your API service: + * Hostname + * Port + * (Optional) base path where the service is available. + This URL is called the base URL of the service. + + **Example:** + + In the sample service described in the [Onboarding Overview](onboard-overview.md#sample-rest-api-service), the URL of the service is: `http://localhost:8080`. + +2. Identify the API of the service that you want to expose through the API Gateway. + + **Example:** + + The API provided by the sample service is a second version of the Pet Store API. All the endpoints to be onboarded are available + through `http://localhost:8080/v2/` URL. This REST API is therefore available at the path `/v2` relative to base URL of the service. + There is no version 1 in this case. + +3. Choose the `service ID` of your service. The `service ID` identifies the service uniquely in the API Gateway. The `service ID` is an alphanumeric string in lowercase ASCII. + + **Example:** + + In the sample service, the `service ID` is `petstore`. + +4. Decide which URL to use to make this API available in the API Gateway. This URL is referred to as the gateway URL and is composed of the API type and the major version. The usually used types are: `api`, `ui` and `ws` but you can use any valid URL element you want. + + **Example:** + + In the sample service, we provide a REST API. The first segment is `/api` as the service provides only one REST API. To indicate that this is version 2, the second segment is `/v2`. This version is required by the Gateway. If your service does not have a version, use `v1` on the Gateway. + +## Define your service and API in YAML format + +After you identify the APIs you want to expose, you need to define your service and API in YAML format as presented in the following sample `petstore` service example. + +**Example:** + +To define your service in YAML format, provide the following definition in a YAML file as in the following sample `petstore` service. +This configuration is the minimal configuration necessary for the Gateway to properly route the requests to the application and to show the Service in the Catalog UI. + +:::note +For more details about configuration, see [Customize configuration parameters](onboard-static-definition.md#customize-configuration-parameters). +::: + +```yaml +services: + - serviceId: petstore + catalogUiTileId: static + instanceBaseUrls: + - http://localhost:8080 + routes: + - gatewayUrl: api/v2 + serviceRelativeUrl: /v2 + authentication: + scheme: httpBasicPassTicket + applid: ZOWEAPPL + apiInfo: + - apiId: io.swagger.petstore + gatewayUrl: api/v2 + +catalogUiTiles: + static: + title: Static API services + description: Services which demonstrate how to make an API service discoverable in the APIML ecosystem using YAML definitions +``` + +In this example, a suitable name for the file is `petstore.yml`. + +:::note Notes: + +* The filename does not need to follow specific naming conventions but it requires the `.yml` extension. +* The file can contain one or more services defined under the `services:` node. +* Each service has a service ID. In this example, the service ID is `petstore`. The service id is used as a part of the request URL towards the Gateway. It is removed by the Gateway when forwarding the request to the service. +* The service can have one or more instances. In this case, only one instance `http://localhost:8080` is used. +* One API is provided and the requests with the relative base path `api/v2` at the API Gateway (full gateway URL: `https://gateway:port/serviceId/api/v2/...`) are routed to the relative base path `/v2` at the full URL of the service (`http://localhost:8080/v2/...`). +* The file on USS should be encoded in ASCII to be read correctly by the API Mediation Layer. + +:::tip Tips: + +* There are more examples of API definitions at this [link](https://github.com/zowe/api-layer/tree/master/config/local/api-defs). +* For more details about how to use YAML format, see this [link](https://learnxinyminutes.com/docs/yaml/). +::: + +## Route your API + +Routing is the process of sending requests from the API Gateway to a specific API service. Route your API by using the same format as in the following `petstore` example. The configuration parameters are explained in [Customize configuration parameters](#customize-configuration-parameters). +Gateway URL format: +``` +https://{gatewayHost}:{port}/api/v{majorVersion}/{serviceId}/{resource} +``` +:::note +The API Gateway differentiates major versions of an API. +::: + +**Example:** + +When the configuration parameters are: +``` +services: + serviceId: petstore + instanceBaseUrls: + - https://localhost:8080 + routes: + gatewayUrl: api/v2 + serviceRelativeUrl: /v2 +``` +To access API version 2 of the service `petstore`, gateway URL will be: +``` +https://gateway-host:port/petstore/api/v2 +``` +It will be routed to: +``` +https://localhost:8080/v2 +``` + +To access resource `pets` of the `petstore` version 2 API, gateway URL will be: +``` +https://gateway:port/petstore/api/v2/pets +``` +It will be routed to: + ``` + https://localhost:8080/v2/pets + ``` + +:::note +This method enables you to access the service through a stable URL, and move the service to another machine without changing the gateway URL. Accessing a service through the API Gateway also enables you to have multiple instances of the service running on different machines to achieve high-availability. +::: + +## Customize configuration parameters + +This part contains a more complex example of the configuration and an explanation of all the possible parameters: + +```yaml +services: + - serviceId: petstore + catalogUiTileId: static + title: Petstore Sample Service + description: This is a sample server Petstore service + instanceBaseUrls: + - http://localhost:8080 + homePageRelativeUrl: /home # Normally used for informational purposes for other services to use it as a landing page + statusPageRelativeUrl: /application/info # Appended to the instanceBaseUrl + healthCheckRelativeUrl: /application/health # Appended to the instanceBaseUrl + routes: + - gatewayUrl: api/v2 + serviceRelativeUrl: /v2 + authentication: + scheme: httpBasicPassTicket + applid: ZOWEAPPL + apiInfo: + - apiId: io.swagger.petstore + gatewayUrl: api/v2 + swaggerUrl: http://localhost:8080/v2/swagger.json + documentationUrl: https://petstore.swagger.io/ + version: 2.0.0 + defaultApi: true + customMetadata: + yourqualifier: + key1: value1 + key2: value2 + +catalogUiTiles: + static: + title: Static API services + description: Services which demonstrate how to make an API service discoverable in the APIML ecosystem using YAML definitions + +additionalServiceMetadata: + - serviceId: petstore + mode: UPDATE # How to update UPDATE=only missing, FORCE_UPDATE=update all set values + authentication: + scheme: bypass +``` + +* **serviceId** + + This parameter specifies the service instance identifier that is registered in the API Mediation Layer installation. + The service ID is used in the URL for routing to the API service through the Gateway. + The service ID uniquely identifies the service in the API Mediation Layer. + The system administrator at the customer site defines this parameter. + + :::caution + Ensure that the service ID is set properly with the following considerations: + ::: + + * When two API services use the same service ID, the API Gateway considers the services to be clones (i.e. two instances for the same service). An incoming API request can be routed to either of them. + * The same service ID should be set only for multiple API service instances for API scalability. + * The service ID value must contain only lowercase alphanumeric characters. + * The service ID cannot contain more than 40 characters. + * The service ID is linked to security resources. Changes to the service ID require an update of security resources. + + **Examples:** + * If the customer system administrator sets the service ID to `monitoringpr1`, + the API URL in the API Gateway appears as the following URL: + + `https://gateway:port/monitoringpr1/api/v1/...` + + * If customer system administrator sets the service ID to `authenticationprod1`, + the API URL in the API Gateway appears as the following URL: + + `http://gateway:port/authenticationprod1/api/v1/...` + + * **title** + + This parameter specifies the human readable name of the API service instance (for example, `Monitoring Prod` or `systemInfo LPAR1`). This value is displayed in the API catalog when a specific API service instance is selected. This parameter is externalized and set by the customer system administrator. + + **Tip:** We recommend that you provide a specific default value of the `title`. + Use a title that describes the service instance so that the end user knows the specific purpose of the service instance. + + * **description** + + This parameter specifies a short description of the API service. + + **Examples:** + + - `Monitoring Service - Production Instance` + - `System Info Service running on LPAR1` + + This value is displayed in the API Catalog when a specific API service instance is selected. This parameter is externalized and set by the customer system administrator. + + :::tip + Describe the service so that the end user knows the function of the service. + ::: + +* **instanceBaseUrls** + + This parameter specifies a list of base URLs to your service's REST resource. It will be the prefix for the following URLs: + + * **homePageRelativeUrl** + * **statusPageRelativeUrl** + * **healthCheckRelativeUrl** + + **Examples:** + * `- http://host:port/ftpservice` for an HTTP service + * `- https://host:port/source-code-mngmnt` for an HTTPS service + + You can provide one URL if your service has one instance. If your service provides multiple instances for the high-availability then you can provide URLs to these instances. + + **Examples:** + * `- https://host1:port1/source-code-mngmnt` + * `- https://host2:port2/source-code-mngmnt` + + +* **homePageRelativeUrl** + + This parameter specifies the relative path to the homepage of your service. The path should start with `/`. + If your service has no homepage, omit this parameter. The path is relative to the instanceBaseUrls. + + **Examples:** + * `homePageRelativeUrl: /` The service has homepage with URL `${baseUrl}/` + * `homePageRelativeUrl: /ui/` The service has homepage with URL `${baseUrl}/ui/` + * `homePageRelativeUrl: ` The service has homepage with URL `${baseUrl}` + +* **statusPageRelativeUrl** + + This parameter specifies the relative path to the status page of your service. + Start this path with `/`. If you service doesn't have a status page, omit this parameter. + The path is relative to the instanceBaseUrls. + + **Example:** + + `statusPageRelativeUrl: /application/info` + + the result URL will be: + + `${baseUrl}/application/info` + +* **healthCheckRelativeUrl** + + This parameter specifies the relative path to the health check endpoint of your service. + Start this URL with `/`. If your service does not have a health check endpoint, omit this parameter. + The path is relative to the instanceBaseUrls. + + **Example:** + + `healthCheckRelativeUrl: /application/health` + + This results in the URL: + + `${baseUrl}/application/health` + +* **routes** + + The following parameters specify the routing rules between the Gateway service and your service. Both specify how the API endpoints are mapped to the API Gateway endpoints. + + * **routes.gatewayUrl** + + The _gatewayUrl_ parameter sets the target endpoint on the Gateway. This is the portion of the final URL that is Gateway specific. + + **Example:** + + For the petstore example, the full Gateway URL would be: + + `https://gatewayUrl:1345/petstore/api/v2/pets/1` + + In this case, the URL that will be called on the service is: + + `http://localhost:8080/v2/pets/1` + + * **routes.serviceRelativeUrl** + + The _serviceRelativeUrl_ parameter points to the target endpoint on the service. This is the base path on the service called through the Gateway. + +* **authentication** + + The information about the possible ways to integrate authentication are available in [Single Sign On Integration for Extenders](./api-medation-sso-integration-extenders.md) article. + +* **apiInfo** + + This section defines APIs that are provided by the service. Currently, only one API is supported. + + * **apiInfo.apiId** + + This parameter specifies the API identifier that is registered in the API Mediation Layer installation. The API ID uniquely identifies the API in the API Mediation Layer. + The same API can be provided by multiple services. The API ID can be used to locate the same APIs that are provided by different services. + + The creator of the API defines this ID. + The API ID needs to be a string of up to 64 characters + that uses lowercase alphanumeric characters and a dot: `.`. + + **Tip:** We recommend that you use your organization as the prefix. + + **Examples:** + + - `zowe.file` + - `ca.sysview` + - `ibm.zosmf` + + * **apiInfo.gatewayUrl** + + This parameter specifies the base path at the API Gateway where the API is available. Ensure that this path is the same as the _gatewayUrl_ value in the _routes_ sections. + + * **apiInfo.swaggerUrl** + + (Optional) This parameter specifies the HTTP or HTTPS address where the Swagger JSON document is available. + + * **apiInfo.documentationUrl** + + (Optional) This parameter specifies a URL to a website where external documentation is provided. + This can be used when _swaggerUrl_ is not provided. + + * **apiInfo.version** + + (Optional) This parameter specifies the actual version of the API in [semantic versioning](https://semver.org/) format. This can be used when _swaggerUrl_ is not provided. + + * **apiInfo.defaultApi** + + (Optional) This parameter specifics that the API is the default one to show in the API Catalog. If this not set to true for any API, or multiple APIs have it set to true, + then the default API becomes the API with the highest major version as seen in `apiInfo.version`. + + * **apiInfo.codeSnippet** (Optional) + + specifies the customized code snippet for a specific endpoint (API operation). The snippet is displayed in the API Catalog under the specified operation, after executing + the request using the *Try it out* functionality. + When specifying this configuration, you need to provide the following parameters: + * **`endpoint`** + The endpoint that represents the API operation of the customized snippet + * **`language`** + The language of the snippet + * **`codeBlock`** + The content of the snippet to be displayed in the API Catalog + + +* **customMetadata** + + Custom metadata are described [here](custom-metadata.md). + +* **catalogUiTileId** + + This parameter specifies the unique identifier for the API services group. + This is the grouping value used by the API Mediation Layer to group multiple API services + together into "tiles". + Each unique identifier represents a single API Catalog UI dashboard tile. + Specify the value based on the ID of the defined tile. + +* **catalogUiTile** + + This section contains definitions of tiles. Each tile is defined in a section that has its tile ID as a key. + A tile can be used by multiple services. + + ```yaml + catalogUiTiles: + tile1: + title: Tile 1 + description: This is the first tile with ID tile1 + tile2: + title: Tile 2 + description: This is the second tile with ID tile2 + ``` + + * **catalogUiTile.\{tileId\}.title** + + This parameter specifies the title of the API services product family. This value is displayed in the API Catalog UI dashboard as the tile title. + + * **catalogUiTile.\{tileId\}.description** + + This parameter specifies the detailed description of the API Catalog UI dashboard tile. This value is displayed in the API Catalog UI dashboard as the tile description. + +* **additionalServiceMetadata** + + This section contains a list of changes that allows adding or modifying metadata parameters for the corresponding service. + + * **additionalServiceMetadata.serviceId** + + This parameter specifies the service identifier for which metadata is updated. + + * **additionalServiceMetadata.mode** + + This parameter specifies how the metadata are updated. The following modes are available: + + **UPDATE** + + Only missing parameters are added. Already existing parameters are ignored. + + **FORCE_UPDATE** + + All changes are applied. Existing parameters are overwritten. + + * **additionalServiceMetadata.\{updatedParameter\}** + + This parameter specifies any metadata parameters that are updated. + +## Add and validate the definition in the API Mediation Layer running on your machine + +After you define the service in YAML format, you are ready to add your service definition to the API Mediation Layer ecosystem. + +The following procedure describes how to add your service to the API Mediation Layer on your local machine. + +**Follow these steps:** + +1. Copy or move your YAML file to the `config/local/api-defs` directory in the directory with API Mediation Layer. + +2. Start the API Mediation Layer services. + + **Tip:** For more information about how to run the API Mediation Layer locally, see [Running the API Mediation Layer on Local Machine](https://github.com/zowe/api-layer/blob/master/docs/local-configuration.md). + +3. Run your Java application. + + **Tip:** Wait for the services to be ready. This process may take a few minutes. + +4. [Validate successful onboarding](./onboard-overview.md#verify-successful-onboarding-to-the-api-ml) + + You successfully defined your Java application if your service is running and you can access the service endpoints. The following example is the service endpoint for the sample application: + + `https://localhost:10010/petstore/api/v2/pets/1` + + +## Add a definition in the API Mediation Layer in the Zowe runtime + +After you define and validate the service in YAML format, you are ready to add your service definition to the API Mediation Layer running as part of the Zowe runtime installation on z/OS. + +**Follow these steps:** + +1. Locate the Zowe instance directory. The Zowe instance directory is the directory from which Zowe was launched, or else was passed as an argument to the SDSF command used to start Zowe. If you are unsure which instance directory a particular Zowe job is using, open the `JESJCL` spool file and navigate to the line that contains `STARTING EXEC ZWESLSTC,INSTANCE=`. This is the fully qualified path to the instance directory. + +:::note +The `${zoweInstanceDir}` symbol is used in following instructions. +::: + +2. Add the fully qualified zFS path of your YAML file to `ZWE_STATIC_DEFINITIONS_DIR` in `zowe.yaml`. + + - To hold your YAML file outside of the instance directory, add `ZWE_STATIC_DEFINITIONS_DIR` variable to the `zowe.environments` section of `zowe.yaml`. Append the fully qualified zFS path of the YAML file to the `ZWE_STATIC_DEFINITIONS_DIR` variable. You may specify multiple zFS paths, separating each path by a semicolon. + + - To place your YAML file within the instance directory, copy your YAML file to the `${zoweInstanceDir}/workspace/api-mediation/api-defs` directory. + + :::note Notes: + - The `${zoweInstanceDir}/workspace/api-mediation/api-defs` directory is created the first time that Zowe starts. If you have not yet started Zowe, this directory might be missing. + - The user ID `ZWESVUSR` that runs the Zowe started task must have permission to read the YAML file. + ::: + +3. Ensure that your application that provides the endpoints described in the YAML file is running. + +4. Restart Zowe runtime or follow steps in section [(Optional) Reload the services definition after the update when the API Mediation Layer is already started](#optional-reload-the-services-definition-after-the-update-when-the-api-mediation-layer-is-already-started) which allows you to add your static API service to an already running Zowe. + +5. [Validate successful onboarding](./onboard-overview.md#verify-successful-onboarding-to-the-api-ml) + +You successfully defined your Java application if your service is running and you can access its endpoints. The endpoint displayed for the sample application is: +``` +https://l${zoweHostname}:${gatewayHttpsPort}/petstore/api/v2/pets/1 +``` + +## (Optional) Check the log of the API Mediation Layer + +The API Mediation Layer log can contain messages based on the API ML configuration. The API ML prints the following messages to its log when the API definitions are processed: + +``` +Scanning directory with static services definition: config/local/api-defs +Static API definition file: /Users/user/workspace/api-layer/config/local/api-defs/petstore.yml +Adding static instance STATIC-localhost:petstore:8080 for service ID petstore mapped to URL http://localhost:8080 +``` + + :::note + If these messages are not displayed in the log, ensure that the [API ML debug mode](https://docs.zowe.org/stable/troubleshoot/troubleshoot-apiml#enable-api-ml-debug-mode) is active. + ::: + +## (Optional) Reload the services definition after the update when the API Mediation Layer is already started + +The following procedure enables you to refresh the API definitions after you change the definitions when the API Mediation Layer is already running. + +**Follow these steps:** + +1. Use a REST API client to issue a `POST` request to the Discovery Service (port 10011): + + `http://localhost:10011/discovery/api/v1/staticApi` + + The Discovery Service requires authentication by a client certificate. If the API Mediation Layer is running on your local machine, the certificate is stored at `keystore/localhost/localhost.pem`. + + This example uses the [HTTPie command-line HTTP client](https://httpie.org) and is run with Python 3 installed: + + ``` + httpie --cert=keystore/localhost/localhost.pem --verify=keystore/local_ca/localca.cer -j POST https://localhost:10011/discovery/api/v1/staticApi + ``` + + Alternatively, it is possible to use curl to issue the POST call if it is installed on your system: + + ``` + curl -X POST --cert keystore/localhost/localhost.pem --cacert keystore/localhost/localhost.keystore.cer https://localhost:10011/discovery/api/v1/staticApi + ``` + +2. Check if your updated definition is effective. + + :::note + It can take up to 30 seconds for the API Gateway to pick up the new routing. + ::: diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/quick-start-for-development.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/quick-start-for-development.md new file mode 100644 index 0000000000..29247fa6af --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/quick-start-for-development.md @@ -0,0 +1,14 @@ +# Quick Start for Development + +To validate that a service is working properly with the API Mediation Layer, you first need to have a running instance of API Mediation Layer. Choose from the following options: + +- Install Zowe and validate against a Zowe instance of API Mediation Layer + - For this setup you can either run Zowe without certificates, or preferably with certificates generated by installation in the keystore. +- Run API Mediation Layer in Codespace or on a local machine directly. + - The details are available in [API Mediation Layer repository](https://github.com/zowe/api-layer/) +- Run API Mediation Layer in containers. + - The details are available in [Docker for API Mediation Layer](https://github.com/zowe/api-layer/tree/v3.x.x/docker) +- Run API Mediation Layer as Java services on z/OS. + - This part is not documented but is possible. You would need to build the services first, then upload them to the mainframe + +To learn more about the certificate setup options for API Mediation Layer with respect to the Development purposes consult [Certificate Management in Zowe API Mediation Layer](./certificate-management-in-zowe-apiml.md). \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/websocket.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/websocket.md new file mode 100644 index 0000000000..7139fcd47b --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/websocket.md @@ -0,0 +1,27 @@ + +# Using WebSocket support in API Gateway + +The API Gateway includes a basic WebSocket proxy which enables the Gateway to access applications that use the WebSocket protocol together with a web UI and a REST API. + +The service defines which WebSocket endpoints are exposed by using Eureka metadata. + +**Example:** +``` +eureka: + instance: + metadata-map: + apiml: + routes: + ws_v1: + gatewayUrl: "ws/v1" + serviceUrl: /${serviceId}/ws +``` + +These metadata make it possible for requests from `wss://gatewayHost:gatewayPort/${serviceId}/ws/v1/path` to map to `wss://serviceHost:servicePort/${serviceId}/ws/v1/path`. + +* **`serviceId`** + Specifies the service ID of the service. + +* **`path`** + Specifies the remaining path segment in the URL. + diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/zaas-client.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/zaas-client.md new file mode 100644 index 0000000000..b3c78fe08a --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/zaas-client.md @@ -0,0 +1,264 @@ +# ZAAS Client + +The ZAAS client is a plain Java library that provides authentication through a simple unified interface without the need +for detailed knowledge of the REST API calls presented in this section. The Client function has only a few dependencies including Apache HTTP Client, Lombok, and their associated dependencies. The client contains methods to perform the following actions: + +- To obtain a JWT token +- To validate and get details from a JWT token +- To invalidate the JWT token +- To obtain a PassTicket + +This article contains the following topics: + +* [Pre-requisites](#pre-requisites) +* [API Documentation](#api-documentation) + * [Obtain a JWT token (`login`)](#obtain-a-jwt-token---login--) + * [Validate and get details from the token (`query`)](#validate-and-get-details-from-the-token---query--) + * [Invalidate a JWT token (`logout`)](#invalidate-a-jwt-token---logout--) + * [Obtain a PassTicket (`passTicket`)](#obtain-a-passticket---passticket--) +* [Getting Started (Step by Step Instructions)](#getting-started--step-by-step-instructions-) +## Pre-requisites + +- Java SDK version 1.8. +- An active instance of the API ML Gateway Service. +- A property file which defines the keystore or truststore certificates. + +## API Documentation + +The plain java library provides the `ZaasClient` interface with following public methods: + +```java +public interface ZaasClient { + String login(String userId, String password) throws ZaasClientException; + String login(String authorizationHeader) throws ZaasClientException; + ZaasToken query(String token) throws ZaasClientException; + ZaasToken query(HttpServletRequest request) throws ZaasClientException; + String passTicket(String jwtToken, String applicationId) throws ZaasClientException, ZaasConfigurationException; + void logout(String token) throws ZaasClientException, ZaasConfigurationException; +} +``` + +This Java code enables your application to add the following functions: + +- **Obtain a JWT token (`login`)** +- **Validate and get details from the token (`query`)** +- **Invalidate a JWT token (`logout`)** +- **Obtain a PassTicket (`passTicket`)** + +### Obtain a JWT token (`login`) + +To integrate login, call one of the following methods for login in the `ZaasClient` interface: + +- If the user provides credentials in the request body, call the following method from your API: + + ```java + String login(String userId, String password) throws ZaasClientException; + ``` + +- If the user provides credentials as Basic Auth, use the following method: + + ```java + String login(String authorizationHeader) throws ZaasClientException; + ``` + +These methods return the JWT token as a String. This token can then be used to authenticate the user in subsequent APIs. + +:::note +Both methods automatically use the truststore file to add a security layer, which requires configuration in the `ConfigProperties` class. +::: + +### Validate and get details from the token (`query`) + +Use the `query` method to get the details embedded in the token. These details include creation time of the token, expiration time of the token, and the user who the token is issued to. + +Call the `query` method from your API in the following format: + +```java +ZaasToken query(String token) throws ZaasClientException; +``` + +In return, you receive the `ZaasToken` Object in JSON format. + +This method automatically uses the truststore file to add a security layer, which you configured in the `ConfigProperties` class. + +The `query` method is overloaded, so you can provide the `HttpServletRequest` object that contains the token in the `apimlAuthenticationToken` +cookie or in an Authorization header. You then receive the `ZaasToken` Object in JSON format. + +```java +ZaasToken query(HttpServletRequest request) throws ZaasClientException; +``` + +### Invalidate a JWT token (`logout`) + +The `logout` method is used to invalidate the JWT token. The token must be provided in the Cookie header and must follow the format accepted by the API ML. + +Call the `logout` method from your API in the following format: + +```java +void logout(String token) throws ZaasClientException, ZaasConfigurationException; +``` + +If the token is successfully invalidated, you receive a `204` HTTP status code in return. + +### Obtain a PassTicket (`passTicket`) + +The `passTicket` method has an added layer of protection. To use this method, call the method of the interface, and provide +a valid APPLID of the application and JWT token as input. + +The APPLID is the name of the application (up to 8 characters) that is used by security products to differentiate certain security operations (like PassTickets) between applications. + +This method has an added layer of security, whereby you do not have to provide an input to the method since you already initialized the `ConfigProperties` class. As such, this method automatically fetches the truststore and keystore files as an input. + +In return, this method provides a valid pass ticket as a String to the authorized user. + +:::tip +For additional information about PassTickets in API ML see [Enabling single sign on for extending services via PassTicket configuration](../../user-guide/api-mediation/configuration-extender-passtickets.md). +::: + +## Getting Started (Step by Step Instructions) + +To use this library, use the procedure described in this section. + +**Follow these steps:** + +1. Add `zaas-client` as a dependency in your project. +You will need to specify the version of the `zaas-client` you want. `zaas-client` versioning following the semantic versioning format of `major.minor.patch`. For example, `1.22.0`. + + **Gradle:** + + 1. Create a `gradle.properties` file in the root of your project if one does not already exist. + + 2. In the `gradle.properties` file, set the URL of the specific Artifactory containing the _SpringEnabler_ artifact. + + ``` + # Repository URL for getting the enabler-java artifact + artifactoryMavenRepo=https://zowe.jfrog.io/zowe/libs-release/ + ``` + + 3. Add the following _Gradle_ code block to the `repositories` section of your `build.gradle` file: + + ```gradle + repositories { + ... + + maven { + url artifactoryMavenRepo + } + } + ``` + + 4. Add the following _Gradle_ dependency: + + ```groovy + dependencies { + compile 'org.zowe.apiml.sdk:zaas-client:{{version}}' + } + ``` + + **Maven:** + + 1. Add the following _XML_ tags within the newly created `pom.xml` file: + + ```xml + + + libs-release + libs-release + https://zowe.jfrog.io/zowe/libs-release/ + + false + + + + ``` + + **Tip:** If you want to use snapshot version, replace libs-release with libs-snapshot in the repository url and change snapshots->enabled to true. + + 2. Then add the following _Maven_ dependency: + + ```xml + + org.zowe.apiml.sdk + zaas-client + {{version}} + + ``` + +2. In your application, create your Java class which will be used to create an instance of `ZaasClient`, which enables you to use its method to login, query, and to issue a PassTicket. + +3. To use `zaas-client`, provide a property file for configuration. + + **Tip:** Check `org.zowe.apiml.zaasclient.config.ConfigProperites` to see which properties are required in the property file. + + **Configuration Properties:** + + ```java + public class ConfigProperties { + private String apimlHost; + private String apimlPort; + private String apimlBaseUrl; + private String keyStoreType; + private String keyStorePath; + private String keyStorePassword; + private String trustStoreType; + private String trustStorePath; + private String trustStorePassword; + private boolean httpOnly; + } + ``` + + **Note:** If `httpOnly` property is set to true, the ZAAS Client will access the API ML via HTTP protocol without TLS. + This meant for z/OS configuration with AT-TLS that will ensure that TLS and the required client certificates are used. + +4. Create an instance of `ZaasClient` in your class and provide the `configProperties` object. + + **Example:** + + ```java + ZaasClient zaasClient = new ZaasClientImpl(getConfigProperties()); + ``` + +You can now use any method from `ZaasClient` in your class. + +**Example:** + +For login, use the following code snippet: + +```java + String zaasClientToken = zaasClient.login("user", "user"); + ``` + +The following codeblock is an example of a `SampleZaasClientImplementation`. + +**Example:** + +```java +import org.zowe.apiml.zaasclient.config.ConfigProperties; +import org.zowe.apiml.zaasclient.exception.ZaasClientException; +import org.zowe.apiml.zaasclient.exception.ZaasConfigurationException; +import org.zowe.apiml.zaasclient.service.ZaasClient; + +public class SampleZaasClientImplementation { + + /** + * This method is used to fetch token from zaasClient + * @param username + * @param password + * @return valid JWT token returned from the authentication service + */ + public String login(String username, String password) { + try { + ZaasClient zaasClient = new ZaasClientImpl(getConfigProperties()); + String zaasClientToken = zaasClient.login(username, password); + //Use this token in subsequent calls + return zaasClientToken; + } catch (ZaasClientException | ZaasConfigurationException exception) { + exception.printStackTrace(); + } + } + + private ConfigProperties getConfigProperties() { + // Load the values for configuration properties + } +} +``` diff --git a/versioned_docs/version-v2.15.x/extend/extend-apiml/zowe-api-mediation-layer-security-overview.md b/versioned_docs/version-v2.15.x/extend/extend-apiml/zowe-api-mediation-layer-security-overview.md new file mode 100644 index 0000000000..95ef62dc11 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-apiml/zowe-api-mediation-layer-security-overview.md @@ -0,0 +1,158 @@ +# Zowe API Mediation Layer Security Overview + +Review this article to learn about topics which address security features in Zowe API Mediation Layer: + + - [How API ML transport security works](#how-api-ml-transport-security-works) + - [Transport layer security](#transport-layer-security) + - [Authentication](#authentication) + - [Zowe API ML services](#zowe-api-ml-services) + - [Zowe API ML TLS requirements](#zowe-api-ml-tls-requirements) + - [Setting ciphers for API ML services](#setting-ciphers-for-api-ml-services) + - [JSON Web Token(JWT)](#json-web-tokenjwt) + - [z/OSMF JSON Web Tokens Support](#zosmf-json-web-tokens-support) + +## How API ML transport security works + +Security within the API Mediation Layer (API ML) is performed on several levels. This article describes how API ML uses Transport Layer Security (TLS). As a system administrator or API developer, use this guide to familiarize yourself with the following security concepts: + +### Transport layer security + +The TLS protocol should be used to ensure secure data-transport for all connections to API Mediation Layer services. While it is possible to disable the TLS protocol for debugging purposes or other use-cases, the enabled TLS protocol is the default mode. + +### Authentication + +Authentication is how an entity, whether it be a user (API Client), or an application (API Service), proves its true identity. + +API ML uses the following authentication methods: + +- **User ID and password** + - The user ID and password are used to retrieve authentication tokens + - Requests originate from a user + - The user ID and password are validated by a z/OS security manager whereby + a token is issued that is then used to access the API service + +- **TLS client certificates** + - Certificates are used for service-only requests + +- **OIDC authentication** + + API ML is now able to authenticate mainframe users with an external/distributed Identity Provider (IDP) implemented by an OIDC/OAuth2 provider, such as OKTA, KeyCloak, Microsoft Entra ID (a.k.a. Azure Active Directory) and others. + Client applications can ask their users to log in at the authentication page of the OIDC provider, and then access APIs with the JWT Access Token that is provided by the external IDP. The following process outlines that basic flow: + - The client application intiates the OIDC authentication flow with the distributed OIDC provider. + - The user provides credentials as required at the provider's authentication page/end-point. + - The client application obtains authorization in the form of code that is exchanged for access JWT token (or an Identity JWT and Refresh JWT). + - The client application passes the access JWT token to the API ML Gateway with subsequent requests for mainframe resources. + - API ML federates the user identities and calls the requested resource with appropriate mainframe user credentials. + +For more information, see the detailed explanation of the [OIDC authentication and Identity Federation](api-mediation-oidc-authentication.md). + +### Zowe API ML services + +The following range of service types apply to the Zowe™ API ML: + +- **Zowe API ML services** + + - **Gateway Service (GW)** + The Gateway is the access point for API clients that require access to API services. + API services can be accessed through the Gateway by API Clients. The Gateway receives information about an API Service + from the Discovery Service. + + - **Discovery Service (DS)** + The Discovery Service collects information about API services and provides this information to the Gateway + and other services. API ML internal services also register to the Discovery Service. + + - **API Catalog (AC)** + The Catalog displays information about API services through a web UI. The Catalog receives information + about an API service from the Discovery Service. + +- **Authentication and Authorization Service (AAS)** + AAS provides authentication and authorization functionality to check user access to resources on z/OS. + The API ML uses z/OSMF API for authentication. + +- **API Clients** + API Clients are external applications, users, or other API services that access API services through the API Gateway + +- **API Services** + API services are applications that are accessed through the API Gateway. API services register themselves to the + Discovery Service and can access other services through the Gateway. If an API service is installed + so that direct access is possible, API services can access other services without the Gateway. + When APIs access other services, they can also function as API clients. + +### Zowe API ML TLS requirements + +The API ML TLS requires servers to provide HTTPS ports. Each API ML service has the following specific requirements: + +- **API Client** + - The API Client is not a server + - Requires trust of the API Gateway + - Has a truststore or SAF keyring that contains certificates required to trust the Gateway + +- **Gateway Service** + - Provides an HTTPS port + - Has a keystore or SAF keyring with a server certificate + - The certificate needs to be trusted by API Clients + - This certificate should be trusted by web browsers because the API Gateway can be used to display web UIs + - Has a truststore or SAF keyring that contains certificates needed to trust API Services + +- **API Catalog** + - Provides an HTTPS port + - Has a keystore or SAF keyring with a server certificate + - The certificate needs to be trusted by the API Gateway + - This certificate does not need to be trusted by anyone else + +- **Discovery Service** + - Provides an HTTPS port + - Has a keystore or SAF keyring with a server certificate + - Has a truststore or SAF keyring that contains certificates needed to trust API services + +- **API Service** + - Provides an HTTPS port + - Has a keystore or SAF keyring with a server and client certificate + - The server certificate needs to be trusted by the Gateway + - The client certificate needs to be trusted by the Discovery Service + - The client and server certificates can be the same + - These certificates do not need to be trusted by anyone else + - Has a truststore or SAF keyring that contains one or more certificates that are required to trust the Gateway and Discovery Service + +## Setting ciphers for API ML services + +You can override ciphers that are used by the HTTPS servers in API ML services by configuring properties of the Gateway, Discovery Service, and API Catalog. + +**Note:** You do not need to rebuild JAR files when you override the default values in shell scripts. + +The default value for each service can be found in the [application.yml](https://github.com/zowe/api-layer/blob/master/gateway-service/src/main/resources/application.yml) file. The default configuration is packed in .jar files. On z/OS, you can override the default configuration in `/components//bin/start.sh`. +Add the launch parameter of the shell script to set a cipher: + +``` +-Dapiml.security.ciphers= +``` + +On localhost, you can override the default configuration in [config/local/gateway-service.yml](https://github.com/zowe/api-layer/blob/master/config/local/gateway-service.yml) (including other YAML files for development purposes). + +The following list shows the default ciphers. API ML services use the following cipher order: + +**Note:** Ensure that the version of Java you use is compatible with the default cipherset. + +``` + TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, + TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, + TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384 +``` + +Only IANA ciphers names are supported. For more information, see [Cipher Suites](https://wiki.mozilla.org/Security/Server_Side_TLS#Cipher_suites) or [List of Ciphers](https://testssl.net/openssl-iana.mapping.html). + +## JSON Web Token (JWT) + +The API ML authentication token in the form of JWT is signed with an asymmetric private key that is generated during Zowe keystore configuration. The JWT is signed with the RS256 signature algorithm. + +You can find this private key under the alias `localhost`, in the PKCS12 keystore that is stored in `${KEYSTORE_DIRECTORY}/localhost/localhost.keystore.p12`. The public key necessary to validate the JWT signature is read from the keystore. + +You can also use the `/gateway/api/v1/auth/keys/public` endpoint to obtain a public key that can be used to verify the signature of the JWT in standard [JWK format](https://openid.net/specs/). + +## z/OSMF JSON Web Tokens Support + + +Your z/OSMF instance can be enabled to support JWTs as described in [Enabling JSON Web Token support](https://www.ibm.com/support/knowledgecenter/SSLTBW_2.4.0/com.ibm.zos.v2r4.izua300/izuconfig_EnableJSONWebTokens.htm). +In such cases, the Zowe API ML uses this JWT and does not generate its own Zowe JWT. All authentication APIs, such as `/gateway/api/v1/login` and `/gateway/api/v1/check` function in the same way as without z/OSMF JWT. +The Gateway service endpoint `/gateway/api/v1/auth/keys/public` serves the z/OSMF JWK that can be used for JWT signature validation. diff --git a/versioned_docs/version-v2.15.x/extend/extend-cli/cli-creating-plug-in-lifecycle-actions.md b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-creating-plug-in-lifecycle-actions.md new file mode 100644 index 0000000000..548a47f470 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-creating-plug-in-lifecycle-actions.md @@ -0,0 +1,40 @@ +# Creating plug-in lifecycle actions + +As a developer, you may want your plug-in to perform certain tasks immediately after install and just before uninstall. + +Many different types of tasks can make up these *plug-in lifecycle actions*, including the following examples: + +- Post-install actions: + - A sanity check + - Additional setup + - Adding the plug-in as an override of Zowe CLI Credential Manager + +- Pre-uninstall actions: + - Revert specialized setup + - Removing the plug-in as an override of Zowe CLI Credential Manager + +Creating and using lifecycle actions is optional, but they can be useful tools. Lifecycle actions can automate a manual process intended for the plug-in user to carry out. They can also avoid the need to create commands with uses limited to post-install and pre-uninstall tasks. + +**Note:** When creating a plug-in to override Zowe CLI Credential Manager, it is necessary to implement a post-install action to configure your plug-in as the credential manager. + +## Implenting lifeycyle actions + +Add the `pluginLifeCycle` property to your plug-in definition file and include a plug-in class to implement lifecycle functions. + +Follow these steps: + +1. Navigate to the plug-in definition file. + + This file is the value for the `configurationModule` property in the plug-in `package.json` file. + + See this [`IImperativeConfig.ts` file](https://github.com/zowe/imperative/blob/master/packages/imperative/src/doc/IImperativeConfig.ts) to view an example of the detailed format used in the plug-in definition file. + +2. In the plug-in definition file, use the `pluginLifeCycle` property to add the path to the javascript file the plug-in uses to implement the class containing lifecycle functions. + + This plug-in lifecycle functions class extends the `AbstractPluginLifeCycle` class [found in the Imperative package of utility functions](https://github.com/zowe/imperative/blob/master/packages/imperative/src/plugins/AbstractPluginLifeCycle.ts). + +3. In the plug-in lifecycle functions class you created, add instructions for both the `postInstall` and `preUninstall` functions. + + If implemented correctly, Zowe CLI calls the `postInstall` function of the plug-in immediately after the plug-in has been installed. Similarly, the `preUninstall` function is called immediately before the Zowe CLI uninstalls the plug-in. + +**Note:** If your plug-in needs to perform an operation at only post-install or pre-uninstall, implement the other action to simply return to Zowe CLI without taking any action. diff --git a/versioned_docs/version-v2.15.x/extend/extend-cli/cli-devTutorials.md b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-devTutorials.md new file mode 100644 index 0000000000..f253652c41 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-devTutorials.md @@ -0,0 +1,74 @@ +# Developing for Zowe CLI + +You can extend Zowe™ CLI by developing plug-ins and contributing code to the base Zowe CLI or existing plug-ins. + +## How to contribute +You can contribute to Zowe CLI in the following ways: +- Add new commands, options, or other improvements to the base CLI. +- Develop a Zowe CLI plug-in. + +You might want to contribute to Zowe CLI to accomplish the following objectives: +- Provide new scriptable functionality for yourself, your organization, or to a broader community. +- Make use of Zowe CLI infrastructure (profiles and programmatic APIs). +- Participate in the Zowe CLI community space. + +## Getting started +If you want to start working with the code immediately, review the Readme file in the [Zowe CLI core repository](https://github.com/zowe/zowe-cli#zowe-cli--) and the Zowe [contribution guidelines](https://github.com/zowe/zowe-cli/blob/master/CONTRIBUTING.md#contribution-guidelines). The [zowe-cli-sample-plugin GitHub repository](https://github.com/zowe/zowe-cli-sample-plugin#zowe-cli-sample-plug-in) is a sample plug-in that adheres to the guidelines for contributing to Zowe CLI projects. + +### Contribution guidelines +The Zowe CLI contribution guidelines contain standards and conventions for developing Zowe CLI plug-ins. + +The guidelines contain critical information about working with the code, running/writing/maintaining automated tests, developing consistent syntax in your plug-in, and ensuring that your plug-in integrates with Zowe CLI properly: + +| For more information about ... | See: | +| ------------------------------ | ----- | +| General guidelines that apply to contributing to Zowe CLI and Plug-ins | [Contribution Guidelines](https://github.com/zowe/zowe-cli/blob/master/CONTRIBUTING.md) | +| Conventions and best practices for creating packages and plug-ins for Zowe CLI | [Package and Plug-in Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/PackagesAndPluginGuidelines.md)| +| Guidelines for running tests on Zowe CLI | [Testing Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/TESTING.md) | +| Guidelines for running tests on the plug-ins that you build| [Plug-in Testing Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/PluginTESTINGGuidelines.md) | +Versioning conventions for Zowe CLI and Plug-ins| [Versioning Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/MaintainerVersioning.md) | + + +### Tutorials +Follow these tutorials to get started working with the sample plug-in: +1. [Setting up:](cli-setting-up.md) Clone the project and prepare your local environment. +2. [Installing a plug-in:](cli-installing-sample-plugin.md) Install the sample plug-in to Zowe CLI and run as-is. +3. [Extending a plug-in:](cli-extending-a-plugin.md) Extend the sample plug-in with a new by creating a programmatic API, definition, and handler. +4. [Creating a new plug-in:](cli-developing-a-plugin.md) Create a new CLI plug-in that uses Zowe CLI programmatic APIs and a diff package to compare two data sets. +5. [Implementing user profiles:](cli-implement-profiles.md) Implement user profiles with the plug-in. + +### Plug-in development overview +At a high level, a plug-in must have `imperative-framework` configuration [(sample here)](https://github.com/zowe/zowe-cli-sample-plugin/blob/master/src/pluginDef.ts). This configuration is discovered by `imperative-framework` through the [package.json](https://github.com/zowe/zowe-cli-sample-plugin/blob/master/package.json) `imperative` key. + +A Zowe CLI plug-in will minimally contain the following: +1. Programmatic API: Node.js programmatic APIs to be called by your handler or other Node.js applications. +2. Command definition: The syntax definition for your command. +3. Handler implementation: To invoke your programmatic API to display information in the format that you defined in the definition. + +The following guidelines and documentation will assist you during development: + +### Imperative CLI Framework documentation +[Imperative CLI Framework documentation](https://github.com/zowe/imperative/wiki) is a key source of information to learn about the features of Imperative CLI Framework (the code framework that you use to build plug-ins for Zowe CLI). Refer to these supplementary documents during development to learn about specific features such as: + +- Auto-generated help +- JSON responses +- User profiles +- Logging, progress bars, experimental commands, and more! +- Authentication mechanisms + +### Authentication mechanisms + +As an extender, you can change the way Zowe CLI uses various mechanisms of authentication when communicating with the mainframe. + +Zowe CLI accepts various methods, or mechanisms, of authentication when communicating with the mainframe, and the method that the CLI ultimately follows is based on the service it is communicating with. + +However, some services can accept multiple methods of authentication. When multiple methods are provided (in a profile or command) for a service, the CLI follows an *order of precedence* to determine which method to apply. Extenders can modify this order for their plug-in. + +To learn the authentication methods used for different services and their order of precedence, refer to the following table: + +service | Zowe V1 order of precedence | Zowe V2 order of precedence +|:--- |:--- |:--- | +API ML | 1. username, password
    2. API ML token | 1. username, password
    2. API ML token
    3. PEM certificate | +Db2,
    FTP,
    most other services | username, password | username, password +SSH | 1. SSH key
    2. username, password | 1. SSH key
    2. username, password + ZOSMF
    direct connection | username, password | 1. username, password
    2. PEM certificate diff --git a/versioned_docs/version-v2.15.x/extend/extend-cli/cli-developing-a-plugin.md b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-developing-a-plugin.md new file mode 100644 index 0000000000..290b098d52 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-developing-a-plugin.md @@ -0,0 +1,367 @@ +# Developing a new Zowe CLI plug-in +Before you begin this tutorial, complete the [Extending an existing plug-in](cli-extending-a-plugin.md) tutorial. + +## Overview +The advantage of Zowe CLI and of the CLI approach in mainframe development is that it allows for combining different developer tools for new and interesting uses. + +This tutorial demonstrates how to create a brand new Zowe CLI plug-in that uses Node.js to create a client-side API. + +After following all the steps, you will have created a data set diff utility plug-in called **Files Util Plug-in**. This plug-in takes in any two data sets, or files, and returns a plain text output in the terminal showing how they differ. This tutorial will also show you how you can integrate your new plug-in with a third-party utility to make your output colorful and easier to read, as shown in the image at the [bottom of this page](../extend-cli/cli-developing-a-plugin#bringing-together-new-tools). + +If you are ready to create your own unique Zowe CLI plug-in, refer to the notes at the end of each tutorial step for guidance. + +If you are interested in creating a credential manager plug-in, see the [Zowe CLI secrets for kubernetes plug-in](https://github.com/zowe/zowe-cli-secrets-for-kubernetes) repository. + +## Setting up the new sample plug-in project + Download the sample plug-in source and delete the irrelevant content to set up your plug-in project. + + Follow these steps: + +1. Open a terminal and run the command `mkdir zowe-tutorial`. + + :::note + All the files created through this tutorial are saved in this tutorial directory. + ::: +2. Enter `cd zowe-tutorial` to change directory into your `zowe-tutorial` folder. +3. Download the [source code zip file](https://github.com/zowe/zowe-cli-sample-plugin/archive/refs/heads/master.zip) from the Zowe CLI sample plug-in repository. +4. In your File Explorer, extract the zip file to the `zowe-tutorial` folder. +5. Rename the `zowe-cli-sample-plugin-master` directory to `files-util`. + + This is the project directory used throughout the rest of this tutorial. +6. Delete all content within the following folders: + - `src/api` + - `src/cli` + - `docs` folders + - `__tests__/__system__/api` + - `__tests__/__system__/cli` + - `__tests__/api` + - `__tests__/cli` +7. Return to your terminal and run `cd files-util` to enter the project directory. +8. Enter `git init` to set up a new Git repository. +9. Enter `git add --all` to *stage* (track) all files in the current directory with Git. + +10. Enter `git commit --message "Initial commit"` to save a snapshot of the staged files in your repository. +11. Run `npm install` to install third-party dependencies defined in the `package.json` file of your Node.js project. + + When successful, a progress bar displays. Once the plug-in is installed, a message displays the status of the packages in the `node_modules` directory. + + :::note + If vulnerabilities are found in any of the installed dependencies, refer to [npm Docs](https://docs.npmjs.com/cli/v9/commands/npm-audit) for how to fix them. + ::: + +**To create a unique plug-in:** Change the `files-util` directory to a name applicable for your project. + +## Updating `package.json` + +Change the name property in the `package.json` file to the plug-in name. + +Open the `package.json` file in a text editor and replace the name field with the following information: + +```typescript + "name": "@zowe/files-util", +``` + +This tutorial uses `@zowe/files-util` as the tutorial plug-in name. + +**To create a unique plug-in:** Replace `@zowe/files-util` with a unique plug-in name. This allows you to publish the plug-in under that name to the `npm` registry in the future. For information regarding npm scoping, see the [npm documentation](https://docs.npmjs.com/cli/v9/using-npm/scope). + +## Adjusting Imperative CLI Framework configuration + +Define json configurations for the plug-in to Imperative. + +Change the `src/pluginDef.ts` file to contain the following configurations: + +```typescript +import { IImperativeConfig } from "@zowe/imperative"; + +const config: IImperativeConfig = { + commandModuleGlobs: ["**/cli/*/*.definition!(.d).*s"], + rootCommandDescription: "Files utility plugin for Zowe CLI", + productDisplayName: "Files Util Plugin", + name: "files-util" +}; + +export = config; +``` + +When successful, the `src/pluginDef.ts` file contains the new configurations. + +**To create a unique plug-in:** Change the plug-in name, display name, and description according to your project. + +## Adding third-party packages + +Install third-party packages as dependencies for the plug-in's client-side API. + + Follow these steps: + +1. Run `npm install --save-exact diff` to install the diff package (which includes methods for comparing text). + +2. Run `npm install --save-dev @types/diff` to install the typescript type definitions for the diff package as a [development dependency](https://docs.npmjs.com/specifying-dependencies-and-devdependencies-in-a-package-json-file). + + When successful, the `diff` and `@types/diff` packages are added to the dependency list in the `package.json` file. + +**To create a unique plug-in:** Instead of the `diff` package, install the package(s) that are required for your API, if any. + +## Creating a Node.js client-side API +Create a client-side API that compares the contents of two data sets on the mainframe. + +Follow these steps: + +1. In the `src/api` directory, create a file named `DataSetDiff.ts`. + +2. Copy and paste the following code into the `DataSetDiff.ts` file: + + ```typescript + import { AbstractSession } from "@zowe/imperative"; + import { Download, IDownloadOptions, IZosFilesResponse } from "@zowe/cli"; + import * as diff from "diff"; + import { readFileSync } from "fs"; + + export class DataSetDiff { + + public static async diff(session: AbstractSession, oldDataSet: string, newDataSet: string) { + + let error; + let response: IZosFilesResponse; + + const options: IDownloadOptions = { + extension: "dat", + }; + + try { + response = await Download.dataSet(session, oldDataSet, options); + } catch (err) { + error = "oldDataSet: " + err; + throw error; + } + + try { + response = await Download.dataSet(session, newDataSet, options); + } catch (err) { + error = "newDataSet: " + err; + throw error; + } + + const regex = /\.|\(/gi; // Replace . and ( with / + const regex2 = /\)/gi; // Replace ) with . + + // convert the old data set name to use as a path/file + let file = oldDataSet.replace(regex, "/"); + file = file.replace(regex2, ".") + "dat"; + // Load the downloaded contents of 'oldDataSet' + const oldContent = readFileSync(`${file}`).toString(); + + // convert the new data set name to use as a path/file + file = newDataSet.replace(regex, "/"); + file = file.replace(regex2, ".") + "dat"; + // Load the downloaded contents of 'oldDataSet' + const newContent = readFileSync(`${file}`).toString(); + + return diff.createTwoFilesPatch(oldDataSet, newDataSet, oldContent, newContent, "Old", "New"); + } + } + ``` + +3. In the `src` directory, replace the contents of the `index.ts` file with the following code in order to make the API available for other developers to import: + + ```typescript + export * from "./api/DataSetDiff"; + ``` + + When successful, the `index.ts` file contains the new code. + +**To create a unique plug-in:** The file name and code in Step 2 may be entirely different if you want to implement an API to do something else. + +## Building your plug-in source + +To confirm that your project builds successfully: + +1. Due to missing license headers, you will come across linting errors. Run `npm run lint:fix` to resolve the errors automatically. + + When successful, no errors are returned, although an unrelated warning might display. Additionally, the `lib` directory contains the built javascript files. + +2. In the terminal, run `npm run build` to verify there are no errors. + + This command builds your typescript files by looking at the configuration details in `tsconfig.json` and placing the output javascript files in the `lib` directory. + + The `lib` directory is configurable by modifying [this value](https://github.com/zowe/zowe-cli-sample-plugin/blob/master/tsconfig.json#L12) in the `tsconfig.json` file. + +**To create a unique plug-in:** Follow these same steps. + +## Creating a Zowe CLI command + +To define the command that calls the client-side API: + +1. In `src/cli`, create a folder named `diff`. +2. In the `diff` directory, create a file named `Diff.definition.ts`. +3. Copy and paste the following code into the `Diff.definition.ts` file: + + ```typescript + import { ICommandDefinition } from "@zowe/imperative"; + import { DataSetsDefinition } from "./data-sets/DataSets.definition"; + const IssueDefinition: ICommandDefinition = { + name: "diff", + summary: "Diff two data sets content", + description: "Uses open source diff packages to diff two data sets content", + type: "group", + children: [DataSetsDefinition] + }; + + export = IssueDefinition; + ``` + +4. In the `diff` folder, create a folder named `data-sets`. +5. In the `data-sets` folder, create the following two files: + - `DataSets.definition.ts` + - `DataSets.handler.ts` + +6. Copy and paste the following code into the `DataSets.definition.ts` file: + ```typescript + import { ICommandDefinition } from "@zowe/imperative"; + + export const DataSetsDefinition: ICommandDefinition = { + name: "data-sets", + aliases: ["ds"], + summary: "data sets to diff", + description: "diff the first data set with the second", + type: "command", + handler: __dirname + "/DataSets.handler", + positionals: [ + { + name: "oldDataSet", + description: "The old data set", + type: "string" + }, + { + name: "newDataSet", + description: "The new data set", + type: "string" + } + ], + profile: { + optional: ["zosmf"] + } + }; + ``` + +7. Copy and paste the following code into the `DataSets.handler.ts` file: + ```typescript + import { ConnectionPropsForSessCfg, ICommandHandler, IHandlerParameters, ISession, Session } from "@zowe/imperative"; + import { DataSetDiff } from "../../../api/DataSetDiff"; + + export default class DataSetsDiffHandler implements ICommandHandler { + public async process(params: IHandlerParameters): Promise { + const sessCfg: ISession = { + hostname: params.arguments.host, + port: params.arguments.port, + basePath: params.arguments.basePath, + rejectUnauthorized: params.arguments.rejectUnauthorized, + protocol: params.arguments.protocol || "https" + }; + const sessCfgWithCreds = await ConnectionPropsForSessCfg.addPropsOrPrompt(sessCfg, params.arguments, + { doPrompting: true, parms: params }); + const session = new Session(sessCfgWithCreds); + + const resp = await DataSetDiff.diff(session, params.arguments.oldDataSet, params.arguments.newDataSet); + params.response.console.log(resp); + } + } + ``` + When successful, the `Diff.definition.ts`, `DataSets.definition.ts`, and `DataSets.handler.ts` files contain the new code. + +:::note + +If you are adding multiple commands to your CLI plug-in, consider moving the code that creates a session into a base handler class that can be shared across multiple commands. See the [sample plugin code](https://github.com/zowe/zowe-cli-sample-plugin/blob/master/src/cli/list/ListBaseHandler.ts) for an example of how this can be done. + +::: + +**To create a unique plug-in:** Refer to file names specific to your project. Your code likely follows the same structure, but command name, handler, definition, and other information would differ. + +## Trying your command + +Before you test your new command, confirm that you are able to connect to the mainframe. + +In order for the client-side API to reach the mainframe (to fetch data sets), Zowe CLI needs a z/OSMF profile for access. See [Using profiles](../../user-guide/cli-using-using-team-profiles/) for information. + +Once the connection between Zowe CLI and z/OSMF is confirmed, build and install the plug-in before running it for the first time. + +Follow these steps: + +1. Repeat the steps in [Building your plug-in source](../extend-cli/cli-developing-a-plugin#building-your-plug-in-source). + + As you make changes, repeat these steps to make sure the changes are reflected in the working plug-in. + +2. Issue the following command to install **Files Util Plug-in** into Zowe CLI: + + ``` + zowe plugins install . + ``` + + A success message displays if installed correctly. + + :::note + If you encounter installation errors due to conflicting profiles or command groups, uninstall the sample plug-in or modify the profile definition in the `src/pluginDef.ts` file. + ::: + +3. Replace the data set names with valid mainframe data set names on your system: + + ``` + zowe files-util diff data-sets "IBMUSER.REXX(TESTADD)" "IBMUSER.REXX(TESTSUB)" + ``` + The raw diff output displays as a command response: + + ``` + $ zowe files-util diff data-sets "IBMUSER.REXX(TESTADD)" "IBMUSER.REXX(TESTSUB)" + =================================================================== + --- IBMUSER.REXX(TESTADD) Old + +++ IBMUSER.REXX(TESTSUB) New + @@ -1,6 +1,6 @@ + /* REXX */ + -say add(3,2) + +say sub(3,2) + exit + -add: + +sub: + parse arg a,b + -return a + b + +return a - b + ``` + + When successful, the output displays plain text diffs of the entered data sets. + +**To create a unique plug-in:** Use Step 3 to run your new command. Note that the command is different based on the plug-in name in the `src/pluginDef.ts` file. + +## Bringing together new tools! + +You have created a simple CLI plug-in that provides plain text diffs of two data sets. But you may not want to end there. + +Depending on the complexity of your changes, it can be difficult to identify data set differences with plain text. + +To help fix this, you can extend **Files Util Plug-in** to create a more visual output. For this tutorial, use [diff2html](https://diff2html.xyz/) to generate side-by-side diffs that make it easier to compare changes, as seen in the image below. + +| ![Side by Side Diff](../../images/guides/CLI/htmlDiff2.png) | +|:--:| +| Diff to HTML by [rtfpessoa](https://github.com/rtfpessoa)| + +Follow these steps: + +1. Run `npm install --global diff2html-cli` to install `diff2html`. + + :::note + + Zowe is not associated with `diff2html-cli`. + + ::: + +2. To pipe your Zowe CLI plug-in output to `diff2html`, run the following command with your information: + + ``` + zowe files-util diff data-sets "IBMUSER.REXX(TESTADD)" "IBMUSER.REXX(TESTSUB)" | diff2html -i stdin + ``` + + When successful, this launches a web browser that displays side-by-side diffs using HTML. + +For a unique plug-in, consider integrating with more modern tools that make outputs easier to read or manage, or that can use outputs in scripts. + +## Next steps +Try the [Implementing profiles in a plug-in](cli-implement-profiles.md) tutorial to learn about defining new profiles with your plug-in. diff --git a/versioned_docs/version-v2.15.x/extend/extend-cli/cli-extending-a-plugin.md b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-extending-a-plugin.md new file mode 100644 index 0000000000..9aad0e9832 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-extending-a-plugin.md @@ -0,0 +1,184 @@ +# Extending a plug-in +Before you begin, be sure to complete the [Installing the sample plug-in](cli-installing-sample-plugin.md) tutorial. + +## Overview + +This tutorial demonstrates how to extend the plug-in that is bundled with this sample by: + +1. Creating a Typescript interface for the Typicode response data +2. Creating a programmatic API +3. Creating a command definition +4. Creating a command handler + +We'll do this by using `@zowe/imperative` infrastructure to surface REST API data on our Zowe™ CLI plug-in. + +Specifically, we're going to show data from [this URI](https://jsonplaceholder.typicode.com/todos) by [Typicode](https://jsonplaceholder.typicode.com/). +Typicode serves sample REST JSON data for testing purposes. + +At the end of this tutorial, you will be able to use a new command from the Zowe CLI interface: `zowe zowe-cli-sample list typicode-todos` + +Completed source for this tutorial can be found on the `typicode-todos` branch of the zowe-cli-sample-plugin repository. + +### Creating a Typescript interface for the Typicode response data + +First, we'll create a Typescript interface to map the response data from a server. + +Within `zowe-cli-sample-plugin/src/api`, create a folder named `doc` to contain our interface (sometimes referred to as a "document" or "doc"). Within the doc folder, create a file named `ITodo.ts`. + +The `ITodo.ts` file will contain the following: + +```typescript +export interface ITodo { + userId: number; + id: number; + title: string; + completed: boolean; +} +``` + +### Creating a programmatic API + +Next, we'll create a Node.js API that our command handler uses. This API can also be used in any Node.js application, because these Node.js APIs make use of REST APIs, Node.js APIs, other NPM packages, or custom logic to provide higher level functions than are served by any single API. + +Adjacent to the existing file named `zowe-cli-sample-plugin/src/api/Files.ts`, create a file `Typicode.ts`. + +`Typicode.ts`should contain the following: + +```typescript +import { ITodo } from "./doc/ITodo"; +import { RestClient, AbstractSession, ImperativeExpect, Logger } from "@zowe/imperative"; + +export class Typicode { + + public static readonly TODO_URI = "/todos"; + + public static getTodos(session: AbstractSession): Promise { + Logger.getAppLogger().trace("Typicode.getTodos() called"); + return RestClient.getExpectJSON(session, Typicode.TODO_URI); + } + + public static getTodo(session: AbstractSession, id: number): Promise { + Logger.getAppLogger().trace("Typicode.getTodos() called with id " + id); + ImperativeExpect.toNotBeNullOrUndefined(id, "id must be provided"); + const resource = Typicode.TODO_URI + "/" + id; + return RestClient.getExpectJSON(session, resource); + } +} + +``` + +The `Typicode` class provides two programmatic APIs, `getTodos` and `getTodo`, to get an array of `ITodo` objects or a specific +`ITodo` respectively. The Node.js APIs use `@zowe/imperative` infrastructure to provide logging, parameter validation, +and to call a REST API. See the [Imperative CLI Framework documentation](https://github.com/zowe/imperative/wiki) for more information. + +#### Exporting interface and programmatic API for other Node.js applications + +Update [zowe-cli-sample-plugin/src/index.ts](https://github.com/zowe/zowe-cli-sample-plugin/blob/master/src/index.ts) to contain the following: + +```typescript +export * from "./api/doc/ITodo"; +export * from "./api/Typicode"; +``` + +A sample invocation of your API might look similar to the following, if it were used by a separate, standalone Node.js application: +```typescript +import { Typicode } from "@zowe/zowe-cli-sample-plugin"; +import { Session, Imperative } from "@zowe/imperative"; +import { inspect } from "util"; + +const session = new Session({ hostname: "jsonplaceholder.typicode.com"}); +(async () => { + const firstTodo = await Typicode.getTodo(session, 1); + Imperative.console.debug("First todo was: " + inspect(firstTodo)); +})(); +``` + +### Checkpoint one + +Issue `npm run build` to verify a clean compilation and confirm that no lint errors are present. At this point in this tutorial, you have a programmatic API +that will be used by your handler or another Node.js application. Next you'll define the command syntax for the command that will use your programmatic Node.js APIs. + +### Creating a command definition + +Within Zowe CLI, the full command that we want to create is `zowe zowe-cli-sample list typicode-todos`. Navigate to `zowe-cli-sample-plugin/src/cli/list` and create a folder +`typicode-todos`. Within this folder, create `TypicodeTodos.definition.ts`. Its content should be as follows: +```typescript +import { ICommandDefinition } from "@zowe/imperative"; +export const TypicodeTodosDefinition: ICommandDefinition = { + name: "typicode-todos", + aliases: ["td"], + summary: "Lists typicode todos", + description: "List typicode REST sample data", + type: "command", + handler: __dirname + "/TypicodeTodos.handler", + options: [ + { + name: "id", + description: "The todo to list", + type: "number" + } + ] +}; +``` +This describes the syntax of your command. + +#### Defining command to list group + +Within the file `zowe-cli-sample-plugin/src/cli/list/List.definition.ts`, add the following code below other `import` statements near the top of the file: +```typescript +import { TypicodeTodosDefinition } from "./typicode-todos/TypicodeTodos.definition"; +``` + +Then add `TypicodeTodosDefinition` to the children array. For example: +``` +children: [DirectoryContentsDefinition, TypicodeTodosDefinition] +``` + +### Creating a command handler + +Also within the `typicode-todos` folder, create `TypicodeTodos.handler.ts`. Add the following code to the new file: +```typescript +import { ICommandHandler, IHandlerParameters, TextUtils, Session } from "@zowe/imperative"; +import { Typicode } from "../../../api/Typicode"; +export default class TypicodeTodosHandler implements ICommandHandler { + + public static readonly TYPICODE_HOST = "jsonplaceholder.typicode.com"; + public async process(params: IHandlerParameters): Promise { + + const session = new Session({ hostname: TypicodeTodosHandler.TYPICODE_HOST}); + if (params.arguments.id) { + const todo = await Typicode.getTodo(session, params.arguments.id); + params.response.data.setObj(todo); + params.response.console.log(TextUtils.prettyJson(todo)); + } else { + const todos = await Typicode.getTodos(session); + params.response.data.setObj(todos); + params.response.console.log(TextUtils.prettyJson(todos)); + } + } +} +``` +The `if` statement checks if a user provides an `--id` flag. If yes, we call `getTodo`. Otherwise, we call `getTodos`. If the +Typicode API throws an error, the `@zowe/imperative` infrastructure will automatically surface this. + +### Checkpoint two + +Issue `npm run build` to verify a clean compilation and confirm that no lint errors are present. You now have a handler, definition, and your command has been defined to the `list` group of the command. + +## Using the installed plug-in + +Issue the command: `zowe zowe-cli-sample list typicode-todos` + +Refer to `zowe zowe-cli-sample list typicode-todos --help` for more information about your command and to see how text in the command definition +is presented to the end user. You can also see how to use your optional `--id` flag: + +![output](../../images/guides/CLI/completedSample.png) + +## Summary + +You extended an existing Zowe CLI plug-in by introducing a Node.js programmatic API, and you created a command definition with a handler. +For an official plugin, you would also add [JSDoc](https://jsdoc.app/) to your code and create automated tests. + +## Next steps + +Try the [Developing a new plug-in](cli-developing-a-plugin.md) tutorial next to create a new plug-in for Zowe CLI. diff --git a/versioned_docs/version-v2.15.x/extend/extend-cli/cli-implement-profiles.md b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-implement-profiles.md new file mode 100644 index 0000000000..973becca3e --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-implement-profiles.md @@ -0,0 +1,74 @@ +# Implementing profiles in a plug-in +You can use this profile template to create a profile for your product. + +The profile definition is placed in the `imperative.ts` file. + +The `type: "someproduct"` property represents the profile name that you might require on various commands to have credentials loaded +from a secure credential manager and retain the host/port information, so that you can easily swap to different servers from the CLI. + + By default, if your plug-in that is installed into Zowe™ CLI contains a profile definition that is similar to the following example, a profile template is added automatically to team config JSON when you run the `zowe config init` command. Any properties for which `includeInTemplate` is true are included in the template. Additionally, commands that manage V1 profiles are created automatically under `zowe profiles`. For example, `create`, `validate`, `set-default`, `list`, and so on. + + +```typescript +profiles: [ + { + type: "someproduct", + schema: { + type: "object", + title: "Configuration profile for SOME PRODUCT", + description: "Configuration profile for SOME PRODUCT ", + properties: { + host: { + type: "string", + optionDefinition: { + type: "string", + name: "host", + alias:["H"], + description: "Host name of your SOME PRODUCT REST API server" + } + }, + port: { + type: "number", + optionDefinition: { + type: "number", + name: "port", + alias:["P"], + includeInTemplate: true, + description: "Port number of your SOME PRODUCT REST API server" + } + }, + user: { + type: "string", + optionDefinition: { + type: "string", + name: "user", + alias:["u"], + description: "User name to authenticate to your SOME PRODUCT REST API server" + }, + secure: true + }, + password: { + type: "string", + optionDefinition: { + type: "string", + name: "password", + alias:["p"], + description: "Password to authenticate to your SOME PRODUCT REST API server" + }, + secure: true + }, + }, + }, + createProfileExamples: [ + { + options: "spprofile --host zos123 --port 1234 --user ibmuser --password myp4ss", + description: "Create a SOME PRODUCT profile named 'spprofile' to connect to SOME PRODUCT at host zos123 and port 1234" + } + ] + } +] +``` + +**Next steps** + +If you completed all previous tutorials, you now understand the basics of extending and developing plug-ins for Zowe CLI. Next, we recommend reviewing the project [contribution guidelines](cli-devTutorials.md#contribution-guidelines) and [Imperative CLI Framework documentation](cli-devTutorials.md#imperative-cli-framework-documentation) to learn more. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/extend/extend-cli/cli-installing-sample-plugin.md b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-installing-sample-plugin.md new file mode 100644 index 0000000000..8f7ec4f5fb --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-installing-sample-plugin.md @@ -0,0 +1,36 @@ +# Installing the sample plug-in + +Before you begin, [set up](cli-setting-up.md) your local environment to install a plug-in. + +## Overview +This tutorial covers installing and running this bundled Zowe™ CLI plugin as-is (without modification), which adds a command to the CLI that lists the contents of a directory on your computer. + +## Installing the sample plug-in to Zowe CLI + +To begin, `cd` into your `zowe-tutorial` folder. (See [Initial setup](cli-setting-up.md#initial-setup) for instructions on creating the `zowe-tutorial` folder.) + +Issue the following commands to install the sample plug-in to Zowe CLI: + +`zowe plugins install ./zowe-cli-sample-plugin` + +## Viewing the installed plug-in +Issue `zowe --help` in the command line to return information for the installed `zowe-cli-sample` command group: + +![Installed](../../images/guides/CLI/InstalledSample.png "Installed Sample Plugin") + +## Using the installed plug-in +To use the plug-in functionality, issue: `zowe zowe-cli-sample list directory-contents`: + +![Output](../../images/guides/CLI/SampleOutput.png "Sample Plugin Output") + +## Testing the installed plug-in +To run automated tests against the plug-in, `cd` into your `zowe-tutorial/zowe-cli-sample-plugin` folder. + +Issue the following command: + +``` +npm run test +``` + +## Next steps +You successfully installed a plug-in to Zowe CLI! Next, try the [Extending a plug-in](cli-extending-a-plugin.md) tutorial to learn about developing new commands for this plug-in. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/extend/extend-cli/cli-setting-up.md b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-setting-up.md new file mode 100644 index 0000000000..e3fc70ec16 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-cli/cli-setting-up.md @@ -0,0 +1,47 @@ +# Setting up your development environment +Before you follow the development tutorials for creating a Zowe™ CLI plug-in, follow these steps to set up your environment. + +## Prerequisites +[Install Zowe CLI](../../user-guide/cli-installcli#methods-to-install-zowe-cli). + +## Initial setup +To create your development space, clone and build [zowe-cli-sample-plugin](https://github.com/zowe/zowe-cli-sample-plugin/#zowe-cli-sample-plug-in) from source. + +Before you clone the repository, create a local development folder named `zowe-tutorial`. You will clone and build all projects in this folder. + +## Branches + +There are two branches in the repository that correspond to different Zowe CLI versions. You can develop two branches of your plug-in so that users can install your plug-in into `@latest` or `@zowe-v2-lts` CLI. Developing for both versions will let you take advantage of new core features quickly and expose your plug-in to a wider range of users. + +The `master` branch of Sample Plug-in is compatible with the `@zowe-v2-lts` version of core CLI (Zowe LTS release). + +The `master` branch of Sample Plug-in is also compatible with the `@latest` version of core CLI (Zowe Active Development release) at this time. + +For more information about the versioning scheme, see [Maintainer Versioning](https://github.com/zowe/zowe-cli/blob/master/docs/MaintainerVersioning.md) in the Zowe CLI repository. + +### Clone zowe-cli-sample-plugin and build from source +Clone the repository into your development folder to match the following structure: +``` +zowe-tutorial +└── zowe-cli-sample-plugin +``` +**Follow these steps:** + +1. `cd` to your `zowe-tutorial` folder. +2. `git clone https://github.com/zowe/zowe-cli-sample-plugin` +3. `cd` to your `zowe-cli-sample-plugin` folder. +4. `git checkout master` +5. `npm install` +6. `npm run build` + +### (Optional) Run the automated tests +We recommend running automated tests on all code changes. Follow these steps: + +1. `cd` to the `__tests__/__resources__/properties` folder. +2. Copy `example_properties.yaml` to `custom_properties.yaml`. +3. Edit the properties within `custom_properties.yaml` to contain valid system information for your site. +4. `cd` to your `zowe-cli-sample-plugin` folder +5. `npm run test` + +## Next steps +After you complete your setup, follow the [Installing the sample plug-in](cli-installing-sample-plugin.md) tutorial to install this sample plug-in to Zowe CLI. diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-adding-log-ids.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-adding-log-ids.md new file mode 100644 index 0000000000..2c665bd872 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-adding-log-ids.md @@ -0,0 +1,56 @@ +The App framework's logger allows for messages to have IDs that can be used to find the right version of a message for foreign languages or to quickly find documentation for a message. More information about ID messages can be found here: + +https://github.com/zowe/zlux/wiki/Logging#logger-message-substitution-using-ids + +The IDs are per-logger, where loggers for plugins are automatically made and given to the plugin code at runtime. During that time, the messages that map to each ID is found in a JSON file relative to the plugin & part of the plugin. All router dataservices share a file, and the web code has another file. + +Logs always include the name of the plugin, but it is good practice to make the IDs unique relative to other software. For example, all of Zowe's own code has IDs starting with ZWE. These are documented here: + +https://github.com/zowe/zlc/blob/master/process/messageManagement.md + +# How to add new IDs to app framework code +All code in the app server or app framework must conform to the following formatting guidelines: + +- The code must start with ZWED +- The code must have 4 numbers +- The code must end with a letter that signifies the level of message. + +Therefore the format is ZWEDnnnnL where the n is number, and the L is level. Levels such as I for info, W for warning, and E for error are expected. + +Server-side code should have a number between **0000** and **4999**, whereas web code can be between **5000** and **9999**. This is to make it easier to prevent accidental duplication. + +Messages must be added in specific places relative to the part of the codebase, explained below. + +**NOTE: There should be no duplication of ZWED IDs among the framework because it will create inaccuracies in the documentation** + + + +## Adding messages to plugins +### Web +If you are editing web code (/web or /webClient), then at runtime the file must be located at + +`PLUGIN/web/assets/i18n/messages_LANG.json` + +Such as: /web/assets/i18n/messages_en.json for english. + +### Router Dataservice +Router (javascript) dataservices can have their message files at + +`PLUGIN/lib/assets/i18n/log/messages_LANG.json` + +Such as: +https://github.com/zowe/zlux-server-framework/blob/v2.x/master/plugins/config/lib/assets/i18n/log/messages_en.json + +## Adding messages to the app server +Since the app server is not a plugin, it has its logs in a specific place. +The message file is located here: + +https://github.com/zowe/zlux-server-framework/blob/v2.x/master/lib/assets/i18n/log/messages_en.json + +## Adding messages to the app manager +The app manager also has parts that are not plugins, such as the dispatcher code found in zlux-platform, or the bootstrap code. For these, we use the bootstrap plugin's web JSON files, such as the English one at + + `/zlux-app-manager/bootstrap/web/assets/i18n/messages_en.json` + +**NOTE: Plugins do not need to share the same ZWED prefix that the framework MUST share, but some parts of the framework are organized as plugins, such as `zlux-app-manager/virtual-desktop` being a plugin.** + diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-apptoappcommunication.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-apptoappcommunication.md new file mode 100644 index 0000000000..3f16615321 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-apptoappcommunication.md @@ -0,0 +1,277 @@ +# Application-to-application communication + +Zowe™ application plug-ins can opt-in to various application framework abilities, such as the ability to have a Logger, the ability to use a URI builder utility, and more. + +The ability for one appliccation plug-in to communicate with another is an ability that is unique to Zowe environments with multiple application plug-ins. The application framework provides constructs that facilitate this ability. + +The constructs are: the Dispatcher, Actions, Recognizers, Registry, and the features that utilize them such as the framework's Context menu. + +1. [Why use application-to-application communication?](#why-use-application-to-application-communication) +1. [Actions](#actions) +1. [Recognizers](#recognizers) +1. [Dispatcher](#dispatcher) +1. [URI Parameters](#uri-parameters) + +## Why use application-to-application communication? + +When working with computers, people often use multiple applications to accomplish a task. For example, a person might check their email before opening a bank statement in a browser. In many environments, the relationship between one application and another is not well defined. For example, you may open one program to learn of a situation, which is then resolved by opening a different program and typing in content. The application framework attempts to solve this problem by creating structured messages that can be sent from one application plug-in to another. + +An application plug-in has a context of the information that it contains. This context can be used to invoke an action on another application plug-in that is better suited to handle some of the information discovered in the first application plug-in. Well-structured messages facilitate the process of determining which application plug-in is best suited to handle a given situation, while also explaining, in detail, what that application plug-in should do. + +This way, rather than finding out that an attachment with the extension ".dat" was not meant for a text editor, but rather for an email client, one application plug-in may be able to invoke an action on an application plug-in that is capable of opening of an email. + +## Actions + +To manage communication from one application plug-in to another, a specific structure is needed. In the application framework, the unit of application-to-application communication is an Action. The typescript definition of an Action is as follows: +``` +export class Action implements ZLUX.Action { + id: string; // id of action itself. + i18nNameKey: string; // future proofing for I18N + defaultName: string; // default name for display purposes, w/o I18N + description: string; + targetMode: ActionTargetMode; + type: ActionType; // "launch", "message" + targetPluginID: string; + primaryArgument: any; + + constructor(id: string, + defaultName: string, + targetMode: ActionTargetMode, + type: ActionType, + targetPluginID: string, + primaryArgument:any) { + this.id = id; + this.defaultName = defaultName; + // proper name for ID/type + this.targetPluginID = targetPluginID; + this.targetMode = targetMode; + this.type = type; + this.primaryArgument = primaryArgument; + } + + getDefaultName():string { + return this.defaultName; + } +} +``` + +An Action has a specific structure of data that is passed, to be filled in with the context at runtime, and a specific target to receive the data. + +The Action is dispatched to the target in one of several modes, for example: to target a specific instance of an application plug-in, an instance, or to create a new instance. + +The Action can be less detailed than a message. It can be a request to minimize, maximize, close, launch, and more. Finally, all of this information is related to a unique ID and localization string such that it can be managed by the framework. + +### Action target modes + +When you request an Action on an application plug-in, the behavior is dependent on the instance of the application plug-in you are targeting. +You can instruct the framework to target the application plug-in with a target mode from the `ActionTargetMode` `enum`: +``` +export enum ActionTargetMode { + PluginCreate, // require pluginType + PluginFindUniqueOrCreate, // required AppInstance/ID + PluginFindAnyOrCreate, // plugin type + //TODO PluginFindAnyOrFail + System, // something that is always present +} +``` + +### Action types + +The application framework performs different operations on application plug-ins depending on the type of an Action. The behavior can be quite different, from simple messaging to requesting that an application plug-in be minimized. The types are defined by an `enum`: +``` +export enum ActionType { // not all actions are meaningful for all target modes + Launch, // essentially do nothing after target mode + Focus, // bring to fore, but nothing else + Route, // sub-navigate or "route" in target + Message, // "onMessage" style event to plugin + Method, // Method call on instance, more strongly typed + Minimize, + Maximize, + Close, // may need to call a "close handler" +} +``` + +### Loading actions + +Actions can be created dynamically at runtime, or saved and loaded by the system at login. + +### App2App via URL + +Another way the Zowe Application Framework invokes Actions is via URL Query Parameters, with parameters formatted in JSON. This feature enables users to bookmark a set of application-to-application communication actions (in the form of a URL) that will be executed when opening the webpage. Developers creating separate web apps can build a link that will open the Zowe Desktop and do specific actions in Apps, for example, opening a file in the Editor. + +The App2App via URL feature allows you to: + +1. Specify one or more actions that will be executed upon login, allowing you to bookmark a series of actions that you can share with someone else. + +2. Specify actions that are declared by plugins (when formatter is equal to a known action ID) or actions that you have custom-made (when formatter = 'data'). + +3. Customize the action type, mode, and target plugin (when the formatter is equal to an existing action ID). + +#### Samples + +``` +https://localhost:7556/ZLUX/plugins/org.zowe.zlux.bootstrap/web/?app2app=org.zowe.zlux.ng2desktop.webbrowser:launch:create:data:{"url":"https://github.com/zowe/zlux-app-manager/pull/234","enableProxy":true}&app2app=org.zowe.zlux.ng2desktop.webbrowser:message:create:data:{"url":"https://github.com/zowe/zlux-app-manager/pull/234","enableProxy":true}&app2app=org.zowe.zlux.ng2desktop.webbrowser:message:create:org.zowe.zlux.test.action:{"data": {"url":"https://github.com/zowe/zlux-app-manager/pull/234","enableProxy":true}} + +https://localhost:7556/ZLUX/plugins/org.zowe.zlux.bootstrap/web/?pluginId=org.zowe.terminal.tn3270&showLogin=true + +https://localhost:7556/ZLUX/plugins/org.zowe.zlux.bootstrap/web/?pluginId=org.zowe.editor:data:{"type":"openFile","name":"/u/yourhome/notes.txt"} +``` + +Query parameter format: + +``?app2app={pluginId}:{actionType}:{actionMode}:{formatter}:{contextData}&app2app={pluginId}:{actionType}:{actionMode}:{formatter}:{contextData}`` + +- `pluginId` - application identifier, e.g. `'org.zowe.zlux.ng2desktop.webbrowser'` +- `actionType` - `'launch' | 'message'` +- `actionMode` - `'create' | 'system'` +- `formatter` - `'data'` | actionId +- `contextData` - context data in form of JSON +- `windowManager` - `'MVD' | undefined` : (Optional) While in standalone mode, controls whether to use the Zowe (MVD) window manager or the deprecated simple window manager. Default is MVD. +- `showLogin` - `true | false` : (Optional) While in standalone mode, controls whether to show Zowe's login page if credentials are not retrieved from a previous Desktop session, or if to disable it and load the application anyway (ideal solution for apps with their own login experiences). Default is true. + +Note that some of these parameters are shared with single app mode, therefore, you may need to adjust pluginId and app2app parameters as follows + +(desktop mode) +``` +app2app=xxx.xxx.xxx:type:mode:formatter:{contextdata ...} +``` +(single app mode) +``` +pluginId=xxx.xxx.xxx:formatter:{"xxx":"xxx" ...} +``` + +### Dynamically + +You can create Actions by calling the following Dispatcher method: `makeAction(id: string, defaultName: string, targetMode: ActionTargetMode, type: ActionType, targetPluginID: string, primaryArgument: any):Action` + +### Saved on system + +Actions can be stored in JSON files that are loaded at login. The JSON structure is as follows: +``` +{ + "actions": [ + { + "id":"org.zowe.explorer.openmember", + "defaultName":"Edit PDS in MVS Explorer", + "type":"Launch", + "targetMode":"PluginCreate", + "targetId":"org.zowe.explorer", + "arg": { + "type": "edit_pds", + "pds": { + "op": "deref", + "source": "event", + "path": [ + "full_path" + ] + } + } + } + ] +} +``` + +## Recognizers + +Actions are meant to be invoked when certain conditions are met. For example, you do not need to open a messaging window if you have no one to message. Recognizers are objects within the application framework that use the context that the application plug-in provides to determine if there is a condition for which it makes sense to execute an Action. Each recognizer has statements about what condition to recognize, and when that statement is met, which Action can be executed at that time. The invocation of the Action is not handled by the Recognizer; it simply detects that an Action can be taken. + +### Recognition clauses + +Recognizers associate a clause of recognition with an action, as you can see from the following class: +``` +export class RecognitionRule { + predicate:RecognitionClause; + actionID:string; + + constructor(predicate:RecognitionClause, actionID:string){ + this.predicate = predicate; + this.actionID = actionID; + } +} +``` + +A clause, in turn, is associated with an operation, and the subclauses upon which the operation acts. The following operations are supported: +``` +export enum RecognitionOp { + AND, + OR, + NOT, + PROPERTY_EQ, + SOURCE_PLUGIN_TYPE, // syntactic sugar + MIME_TYPE, // ditto +} +``` + +### Loading Recognizers at runtime + +You can add a Recognizer to the application plug-in environment in one of two ways: by loading from Recognizers saved on the system, or by adding them dynamically. + +#### Dynamically + +You can call the Dispatcher method, `addRecognizer(predicate:RecognitionClause, actionID:string):void` + +#### Saved on system + +Recognizers can be stored in JSON files that are loaded at login. The JSON structure is as follows: + +``` +{ + "recognizers": [ + { + "id":"", + "clause": { + + } + } + ] +} + +``` + +**clause** can take on one of two shapes: +``` +"prop": ["", <"valueString">] +``` +Or, +``` +"op": "", +"args": [ + {} +] +``` +Where this one can again, have subclauses. + +### Recognizer example + +Recognizers can be as simple or complex as you write them to be, but here is an example to illustrate the mechanism: +``` +{ + "recognizers":[ + { + "id":"org.zowe.explorer.openmember", + "clause": { + "op": "AND", + "args": [ + {"prop":["sourcePluginID","org.zowe.terminal.tn3270"]},{"prop":["screenID","ISRUDSM"]} + ] + } + } + ] +} +``` + +In this case, the Recognizer detects whether it is possible to run the `org.zowe.explorer.openmember` Action when the TN3270 Terminal application plug-in is on the screen ISRUDSM (an ISPF panel for browsing PDS members). + + +## Dispatcher + +The dispatcher is a core component of the application framework that is accessible through the Global `ZLUX` Object at runtime. The Dispatcher interprets Recognizers and Actions that are added to it at runtime. You can register Actions and Recognizers on it, and later, invoke an Action through it. The dispatcher handles how the Action's effects should be carried out, acting in combination with the Window Manager and application plug-ins to provide a channel of communication. + +## Registry + +The Registry is a core component of the application framework, which is accessible through the Global `ZLUX` Object at runtime. It contains information about which application plug-ins are present in the environment, and the abilities of each application plug-in. This is important to application-to-application communication, because a target might not be a specific application plug-in, but rather an application plug-in of a specific category, or with a specific featureset, capable of responding to the type of Action requested. + +## Pulling it all together in an example + +The standard way to make use of application-to-application communication is by having Actions and Recognizers that are saved on the system. Actions and Recognizers are loaded at login, and then later, through a form of automation or by a user action, Recognizers can be polled to determine if there is an Action that can be executed. All of this is handled by the Dispatcher, but the description of the behavior lies in the Action and Recognizer that are used. In the Action and Recognizer descriptions above, there are two JSON definitions: One is a Recognizer that recognizes when the Terminal application plug-in is in a certain state, and another is an Action that instructs the MVS Explorer to load a PDS member for editing. When you put the two together, a practical application is that you can launch the MVS Explorer to edit a PDS member that you have selected within the Terminal application plug-in. + diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-auth-plugins.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-auth-plugins.md new file mode 100644 index 0000000000..362209f253 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-auth-plugins.md @@ -0,0 +1,44 @@ +ZLUX has a security system that can determine whether users should be permitted to do certain actions by running checks for user authenticity and authority that are relevant to the environment. It does this by providing an API such that security plugins can be installed to answer requests for authentication & authorization. This way, regardless of what security manager or operating system ZLUX is running on, the rules of that security manager can be respected & leveraged. + +An example of this is that in past releases of Zowe, ZLUX has been configured to utilize either ZSS, API Mediation Layer, or z/OSMF to determine if a user's credentials are valid and if they are able to call a given REST API. + +# Server Configuration +ZLUX will not run without a security plugin being configured. Within the server configuration file, a section `dataserviceAuthentication` exists which describes which plugin(s) to use, and which one is the default. Several can be used, as different plugins/services can be protected by different security plugins. + +`dataserviceAuthentication` has the following attributes within: + +* defaultAuthentication: The name of the security plugin type that should be used for all plugins unless otherwise specified. +* rbac: A boolean that security plugins can utilize to determine whether the configuration should use role-based authorization control. Currently the `org.zowe.zlux.auth.zss` plugin uses this. + + +## Example + +The following configuration for the server security can be added in zowe configuration file under `components.app-server`: + +``` +components: + app-server: + dataserviceAuthentication: + rbac: false + defaultAuthentication: zss +``` + + +# Security Plugin API +Security plugins are plugins which have nodeJS code that the server can call to delegate security operations. + +## Constructor +The constructor is currently given 4 parameters: +* pluginDefinition: The object describing the plugin's definition file +* pluginConf: An object that gives the plugin it's configuration from the [Config Service internal storage](https://github.com/zowe/zlux/wiki/Configuration-Dataservice#internal--bootstrapping-use) +* serverConfiguration: The object describing the server's current configuration +* context: An object holding contextual objects + * logger: A logger with the name of the plugin's ID + +### Constructor return object +The constructor should return a capabilities object, which helps the server to know what sort of security operations it can handle. Currently, the following properties are used in the capabilities object. +* canGetStatus: If the getStatus(sessionState) function exists +* canRefresh: If the refreshStatus(request, sessionState) function exists +* canAuthenticate: If the authenticate(request, sessionState):Promise function exists (Required, assumed) +* canAuthorized: If the *authorized(request, sessionState, options) function exists (Required, assumed) +* proxyAuthorizations: If the addProxyAuthorizations(req1, req2Options, sessionState) function exists diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-authentication-api.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-authentication-api.md new file mode 100644 index 0000000000..15205396c0 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-authentication-api.md @@ -0,0 +1,239 @@ +# Authentication API +This topic describes the web service API for user authentication. + +The authentication mechanism of the ZLUX server allows for an administrator to gate access to services by a given auth handler, while on the user side the authentication structure allows for a user to login to one or more endpoints at once provided they share the same credentials given. + +## Handlers + +The auth handlers are a type of zlux server plugin (type=nodeAuthentication) which are categorized by which kind of authentication they can provide. Whether it's to z/OS via `type=saf` or theoretical authentication such as Facebook or Amazon cloud, the handler API is abstract to handle different types of security needs. + +### Handler installation + +Auth handler plugins are installed like any other plugin. + +### Handler configuration + +The server top-level configuration attribute `dataserviceAuthentication` states properties about which plugins to use and how to use them. + +For example, +```json + "dataserviceAuthentication": { + "defaultAuthentication": "saf", + "rbac": true + } +``` + +The `dataserviceAuthentication` attribute has the following properties: + +* defaultAuthentication: Which authentication category to choose by default, in case multiple are installed. +* rbac: Whether or not the server should do authority checks in addition to authentication checks when requesting a dataservice. + + +### Handler context + +These plugins are given an object, `context`, in the constructor. +Context has attributes to help the plugin know about the server configuration, provide a named logger, and more. The parameters include: + +* pluginDefinition: The object describing the plugin's definition file +* pluginConf: An object that gives the plugin its configuration from the [Config Service internal storage](mvd-configdataservice.md#internal--bootstrapping-use) +* serverConfiguration: The object describing the server's current configuration +* context: An object holding contextual objects + * logger: A logger with the name of the plugin's ID + +### Handler capabilities + +A handler's constructor should return a capabilities object that states which capabilities the plugin has. +If a capabilities object is not returned, it is assumed that only the authenticate and authorize functions are implemented, for backward compatibility support. +The capabilities object should include: + +* canGetCategories: (true/false) If the getCategories() function exists, which returns a string array of categories of auth the plugin can support given the server context. This is useful if the plugin can support multiple categories conditionally. +* canLogout: (true/false) If the logout(request, sessionState) function exists. Used to clear state and cookies when a session should be ended. +* canGetStatus: (true/false) If the getStatus(sessionState) function exists +* canRefresh: (true/false) If the refreshStatus(request, sessionState) function exists, which is used to renew a session that has an expiration limit. +* canAuthenticate: (true/false) If the authenticate(request, sessionState):Promise function exists (Required, assumed) +* canAuthorized: (true/false) If the *authorized(request, sessionState, options) function exists (Required, assumed) +* haCompatible: (true/false) Used to be sure that a plugin has no state that would be lost in a high availibility environment. +* canGenerateHaSessionId: (true/false) If generateHaSessionId(request) exists, which is used to set the value used for an app-server session for a user. When not in a high availability environment, the app-server generates its own session ID. +* canResetPassword: (true/false) If passwordRest(request, sessionState) exists +* proxyAuthorizations: (true/false) If the addProxyAuthorizations(req1, req2Options, sessionState) function exists + +### Examples + +sso-auth, which conditionally implements the saf, zss, and apiml security types: https://github.com/zowe/zlux-server-framework/tree/v2.x/master/plugins/sso-auth + +### High availability (HA) + +Some auth handlers are not capable of working in a high availability environment. +In these environments, there can be multiple zlux servers and there may not be a safe and secure way to share session state data. +This extends to the zlux server cookie as well, which is not sharable between multiple servers by default. +Therefore, high availability has the following two requirements from an auth handler plugin: +1) The plugin must state that it is HA capable by setting the capability flag `haCompatible=true`, usually indicating that the plugin has no state data. +2) A plugin must have capability `canGenerateHaSessionId=true` so that the zlux server cookie is sharable between multiple zlux servers. + + +## REST API + +### Check status +Returns the current authentication status of the user to the caller. + +``` +GET /auth +``` + +Response example: + +``` +{ + "categories": { + "zss": { + "authenticated": true, + "plugins": { + "org.zowe.zlux.auth.safsso": { + "authenticated": true, + "username":"foo", + "expms": 60000 + } + } + }, + "zosmf": { + "authenticated": false, + "plugins": { + "org.zowe.zlux.auth.zosmf": { + "authenticated": false + } + } + } + } +} +``` + +Every key in the response object is a registered auth type. The value object is guaranteed to have a Boolean field named "authenticated" which indicates that at least one plugin in the category was able to authenticate the user. + +Each item also has a field called "plugins", where every property value is a plugin-specific object. + +## Authenticate +Authenticates the user against authentication back-ends. + +``` +POST /auth +``` + +Request body example: + +``` +{ + "categories": ["zosmf"], + "username": "foo", + "password": "1970-01-01" +} +``` +The categories parameter is optional. If omitted, all auth plugins are invoked with the username and password Response example: +``` +{ + "success": true, + "categories": { + "saf": { + "success": true, + "plugins": { + "org.zowe.zlux.auth.safsso": { + "success": true + "username":"foo", + "expms": 60000 + } + } + }, + "zosmf": { + "success": true, + "plugins": { + "org.zowe.zlux.auth.zosmf": { + "success": true + } + } + } + } +} +``` +First-level keys are authentication categories or types. "success" means that all of the types requested have been successful. For example typeA successful AND typeB successful AND ... + +Second-level keys are auth plugin IDs. "success" on this level means that there's at least one successful result in that auth type. For example, pluginA successful OR pluginB successful OR ... + +## User not authenticated or not authorized +The response received by the browser when calling any service, when the user is either not authenticated or not allowed to access the service. + +### Not authenticated +``` +HTTP 401 + +{ + "category": "saf", + "pluginID": "org.zowe.zlux.auth.safsso", + "result": { + "authenticated": false, + "authorized": false, + "reason": "a category of success or error may appear here", + "reasonseCode": "ZSS 401 or other codes may appear here", + "error": { + "message": "an error message may appear here" + } + } +} +``` +The client is supposed to address this by showing the user a login form which will later invoke the login service for the plugin mentioned and repeat the request. + +### Not authorized +``` +HTTP 403 + +{ + "category": "saf", + "pluginID": "org.zowe.zlux.auth.safsso", + "result": { + "authenticated": true, + "authorized": false + } +} +``` +There's no general way for the client to address this, except than show the user an error message. + + +### Refresh status +If you have an active session, some auth plugins may be able to renew the session. +Not all plugins support this action, so while the call may return successful, if there is an associated expiration time you may notice that the expiration time has not changed or been reset. + +``` +GET /auth-refresh +``` + +Response example: +``` +{ + "success": true, + "categories": { + "saf": { + "success": true, + "plugins": { + "org.zowe.zlux.auth.safsso": { + "success": true + "username":"foo", + "expms": 60000 + } + } + } + } +} +``` + +### Logout +When you have an active session, you can terminate it early with a logout. This should remove cookies and tell the server to clear any cache it had about a session. + +``` +POST /auth-logout +``` + + +### Password changes +Some auth plugins will allow you to change your password. Depending on the backing security (such as SAF), you may need to provide your current password to change it. + +``` +POST /auth-password +``` diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-buildingplugins.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-buildingplugins.md new file mode 100644 index 0000000000..0c95f7e0cb --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-buildingplugins.md @@ -0,0 +1,58 @@ +# Building plugin apps +You can build a plugin app by using the following steps as a model. Alternatively, you can follow the [Sample Angular App tutorial](https://github.com/zowe/sample-angular-app/blob/lab/step-1-hello-world/README.md). + +Plugins can have any build process desired as long as it doesn't conflict with the [packaging structure](https://github.com/zowe/zlux/wiki/ZLUX-App-filesystem-structure). +The basic requirement for a plugin app is that static web content must be in a `/web` directory, and server and other backend files must be in a `/lib` directory. + +Before you can build a plugin app you must install all [prerequisites](https://github.com/zowe/zlux-app-server#0-install-prerequisites). + +## Building web content +1. On the computer where the virtual desktop is installed, use the the following command to specify a value for the `MVD_DESKTOP_DIR` environment variable: + ``` + export MVD_DESKTOP_DIR=//zowe/zlux-app-manager/virtual-desktop + ``` + + Where `` is the install location of the virtual desktop. + +2. Navigate to `//webClient`. If there is no `/webClient` directory, proceed to the **Building server content** section below. + +3. Run the `npm install` command to install any application dependencies. Check for successful return code. + +4. Run one of the following commands to build the application code: + + - Run the `npm run build` command to generate static content in the `/web` directory. (You can ignore warnings as long as the build is successful.) + - Run the `npm run start` command to compile in real-time. Until you stop the script, it compiles code changes as you make them. + +## Building app server content +1. Navigate to the plugin directory. If there is no `/nodeServer` directory in the plugin directory, proceed to the **Building Javascript content (*.js files)** section below. + +2. Run the `npm install` command to install any application dependencies. Check for successful return code. + +4. Run one of the following commands to build the application code: + + - Run the `npm run build` command to generate static content in the `/lib` directory. + - Run the `npm run start` command to compile in real-time. Until you stop the script, it compiles code changes as you make them. + +## Building zss server content +1. Clone the [zss repository](https://github.com/zowe/zss) and its submodule zowe-common-c. + +2. Make a build script that compiles your C code with -Wc,dll and -Wl,dll, and other flags as seen in [this zowe example](https://github.com/zowe/explorer-ip/blob/master/dataService/build/build.sh) + +3. Include a ZSS .x file to link zss server APIs to your plugin, as seen in [this zowe example](https://github.com/zowe/explorer-ip/blob/master/dataService/build/pluginAPI.x) + +4. Ensure that the build output ends up in the /lib folder as a .so file that has the z/OS program control (`+p`) extended attribute. + +## Tagging plugin files on z/OS +When Zowe App Framework is installed on z/OS developers should tag their plugin files according to the file content. Tagging files helps programs on z/OS understand how to interpret those files, most importantly to know whether a file is encoded using EBCDIC (Extended Binary Coded Decimal Interchange Code). If you are unsure if a plugin you are using is tagged, it can be checked and set using the [`chtag` command](https://www.ibm.com/support/knowledgecenter/SSLTBW_2.2.0/com.ibm.zos.v2r2.bpxa500/chtag.htm). If you want to set the tags, it can be done in bulk with the help of these programs: + +- Autotag: This free, open-source application is not part of Zowe. You can download the binary from here for example https://anaconda.org/izoda/autotag. Source: https://github.com/RocketSoftware/autotag +- The Zowe tagging script: This script tags by file extension. It might not work for all cases, but can be altered to suit your needs. Source: https://github.com/zowe/zowe-install-packaging/blob/master/scripts/tag-files.sh + +## Building Javascript content (*.js files) +Unlike Typescript, Javascript is an interpreted language and does not need to be built. In most cases, reloading the page should build new code changes. For Iframes or other JS-based apps, close and open the app. + +## Installing +Follow the steps described in [Installing plugins](mvd-installplugins.md) to add your built plugin to the Zowe desktop. + +## Packaging +For more information on how to package your Zowe app, developers can see [Plugins definition and structure](mvd-plugindefandstruct.md). diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-conda.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-conda.md new file mode 100644 index 0000000000..1b54a532da --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-conda.md @@ -0,0 +1,197 @@ +# Using Conda to make and manage packages of Application Framework Plugins + +As Zowe is composed of components which can be extended by Plugins, +a standardized and simple way to find, install, upgrade, and list Plugins in your Zowe environment +is important to make it easy to get the most out of Zowe. + +Package management as a concept generally provides a way to find packages such as plugins, +check and possible co-install dependencies the package has, and ultimately install the desired package. +Post-install, management tasks such as upgrading and uninstalling are common. + +Conda is one such package manager, and if you are familiar with apt, yum, or npm, you will find +that using Conda is very similar. But, there are some important abilities that make Conda stand out: + +* Very cross platform: Conda is available, and acts very similar on z/OS, Windows, Linux, macOS, and various Unix. + Packages can state which platforms they support, so it easy to know what packages you can install. +* Tagging: On z/OS, Conda packages can contain tagging information, to avoid issues around the difference between EBCDIC & ASCII. +* Software neutrality: Language-specific package managers are becoming popular, but Conda does not assume the purpose of the package, so you can install almost anything. +* Environments: If desired, every user can have a different set of packages, because Conda can install & manage packages in personal folders instead of system ones. + A user can even have multiple such environments, and switch between them rapidly to work with different sets of related software without conflict. + + +## Initial Conda setup + +If you have not installed Conda yet, it can be downloaded as an all-in-one package that has no extra dependencies, known as "miniconda". +For Linux, Unix, macOS, and Windows, this can be downloaded at https://docs.conda.io/en/latest/miniconda.html +For z/OS, Conda can be downloaded from Rocket Software at https://www.rocketsoftware.com/zos-open-source + +Conda will prompt during the install for certain setup options, +and ultimately you'll want to put some Conda initialization content into your startup script +so that whenever you open your terminal, Conda will be ready for your use. + +Once you have Conda downloaded and installed, you'll want to create your first Conda "environment" +this can be done by providing a path or a nickname + +`conda create --prefix PATH` +`conda create --name ENVIRONMENT` + +Either will work, but path helps you better separate your content from content others use by placing it in a folder that you can have stricter permissions on. + +If you need to know more about certain commands, you can use the help command for any. + +`conda create --help` + +Or, check the official documentation: https://docs.conda.io/en/latest/index.html + +Once you have an environment, you should activate it so that the actions you do are on that environment, as opposed to the base one. + +`conda activate PATH_OR_NAME` + +Conda will detect whether the parameter is a path or a nickname, so this command works for both. + +Finally, you can view the Conda environment and other information by checking "info" + +`conda info` + +## Managing Conda channels + +When downloading a package, such as a Zowe Plugin, the place that you download from is configurable. +These are called "Channels", but are very similar to "Repositories" seen in other package managers. +With Conda, you can install from: + +* A network channel (Internet or company internal) +* A local channel (Collection of plugins on your computer) +* Just an individual package, without a channel + +You can have multiple of each, and if a package is present in more than one location, you can specify which one to use. + +## Searching for packages + +Conda has a search utility that searches for all Channels, + +`conda search anything_you_want` + +but it's important to note that because any type of software can be installed through Conda, you probably want to search through a detailed view to help identify which ones are meant for Zowe, or use Channels that are distinctly for Zowe so that you can get packages that are strictly for Zowe. + +`conda search --info anything_you_want` + +## Using Conda with Zowe + +Zowe is not yet available in the form of Conda packages yet, so it must be installed separately. +If you have Zowe installed on the same system as Conda, some Zowe Plugins installed through Conda will automatically register into Zowe. +In order to do this, the Plugins must be able to find Zowe. You should set environment variables before trying to install the Plugins: + +### Setting environment variables temporarily: + +z/OS, Linux, Unix: +``` +export ZOWE_INSTANCE_DIR=/path/to/zowe/instance +export ZOWE_ROOT_DIR=/path/to/zowe/installation +``` + +Windows cmd.exe: +``` +set ZOWE_INSTANCE_DIR=\path\to\zowe\instance +set ZOWE_ROOT_DIR=\path\to\zowe\installation +``` + +`INSTANCE_DIR` and `ROOT_DIR` are also supported, but the `ZOWE_` prefix helps distinguish its purpose. + +### Setting environment variables persistently + +z/OS, Linux, Unix: +You can put the `export` statements into the `.profile` file in your home directory to have them apply on login. + +Windows: +There is a UI to set variables, but it varies depending on Windows version. +Try typing 'environment variable' into the Windows search bar to get to the relevant menu. + +### Installing a Zowe plugin + +A Conda package could contain one or more Zowe Plugins, and a Conda package could contain non-Zowe code alongside Zowe Plugins. +This is left up to the program vendor and regardless the install process is the same: + +`conda install package_name` + +If the Zowe environment variables are set, such a package may automatically register Plugins into the Zowe instance of your choice. + +### Zowe plugin configuration + +Aside from possible automation during install and uninstall, Conda does not manage Zowe, its configuration, or configuration of the Plugins. +However, Conda does manage the package files, and therefore you can do additional Zowe tasks on the Plugins by going into the Conda environment. +Zowe Plugins are intended to be found in a standardized location in the Conda environment, + +`/opt/zowe/plugins` + +This folder contains Plugins, which in turn contain sub-folders that are the Zowe components that they utilize. +If a plugin uses multiple Zowe components, its contents could be found within multiple component folders. + +`/opt/zowe/plugins/my_plugin/app-server` +`/opt/zowe/plugins/my_plugin/cli` + +### Zowe package structure + +Zowe Plugins packaged into Conda follow the structure outlined here: https://github.com/zowe/zowe-install-packaging/issues/1569 +This structure allows for plugin to have content meant for one or more Zowe components. +The Conda packages extend this by allowing for more than one Plugin, or a mix of Zowe Plugins and other software to be within a single package. + +## Building Conda packages for Zowe + +This document is intended to be provided with example scripts by the Zowe community, which shows you how you can build a simple Zowe plugin into a Conda package. +You can find the example scripts on the [Zowe zlux-build github repository.](https://github.com/zowe/zlux-build/tree/master/conda) +This is not intended to be a one-size-fits-all set of scripts. If you have more advanced needs, you can use these scripts as a basis for writing your own scripts. + +To make a Conda package, you need conda-build, which you can install into a Conda environment: + +`conda install conda-build` + +Once you have it, you can build a package via + +`conda build path/to/build/scripts` + +However, first you must set up the build information. + +### Defining package properties + +Conda needs a metadata file, `meta.yaml` to state information about the package, such as dependencies, what OS it supports, its name and version. +This information can be programmatically found, and Zowe provides examples of how to do this by reading Zowe's own metadata files into this one. + +### Creating build step + +It's recommended not to build your code from scratch to put into Conda. +Rather, build your code however you want, and then just copy the contents into a Conda package. This keeps the Conda scripting small and simple. + +In the same folder as `meta.yaml`, Conda requires `build.sh` for building on Unix, Linux, or z/OS and `build.bat` for Windows. +Except for z/OS, this script does not determine where your package can be used, it's just about where you are building it. +z/OS is the exception because when you build on z/OS, unix file tagging information is preserved. +So, it's highly recommended that you tag your files so that users do not have to deal with encoding issues. +For code that works equally well on all platforms, a simple way to build for all is: +1. Build your code on Linux +1. Transfer the output to z/OS +1. Run a Conda build on the output on Linux +1. Run a Conda build on the output on z/OS +1. Deliver the Linux package as 'noarch' content, and the z/OS package as 'zos-z' content. + +### Lifecycle scripts + +When a Conda package is installed or uninstalled, a script from the package can be run. +For Zowe, the scripts `post-link.sh` and `pre-unlink.sh` can be important, and you must put them into the same folder as `meta.yaml` for building. + +#### Install automation + +`post-link.sh` runs at install, after Conda has put the package content onto the system. +At this time, registration into Zowe is recommended if the Plugin does not require any information from the user for configuration. +If the Plugin is okay to be automatically installed, we recommend putting a script into the package folder named `autoinstall.sh` +Zowe's provided Conda examples will utilize `autoinstall.sh` to do any install steps your package needs, and provides Zowe information to make install simple. +However, it's possible to do what you want in your own `post-link.sh` script instead. + +#### Uninstall automation + +`pre-unlink.sh` is the opposite of `post-link.sh`. It allows you to do anything you need to before the package is removed from the system. +This is a good time to remove any package information from Zowe, but you should be careful because users may uninstall and later re-install, +so you should not remove configuration information without consent. + +### Adding configuration to Conda packages + +As a package manager, Conda is not responsible for configuration. Your packages can include defaults to utilize, +but if configuration is needed you should alert the user to perform a post-install task. `post-link.sh` could be used to print such an alert. diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-configdataservice.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-configdataservice.md new file mode 100644 index 0000000000..0f92d510af --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-configdataservice.md @@ -0,0 +1,310 @@ +# Configuration Dataservice + +The Configuration Dataservice is an essential component of the Zowe™ Application Framework, which acts as a JSON resource storage service, and is accessible externally by REST API and internally to the server by dataservices. + +The Configuration Dataservice allows for saving preferences of applications, management of defaults and privileges within a Zowe ecosystem, and bootstrapping configuration of the server's dataservices. + +The fundamental element of extensibility of the Zowe Application Framework is a *plug-in*. The Configuration Dataservice works with data for plug-ins. Every resource that is stored in the Configuration Service is stored for a particular plug-in, and valid resources to be accessed are determined by the definition of each plug-in in how it uses the Configuration Dataservice. + +The behavior of the Configuration Dataservice is dependent upon the Resource structure for a plug-in. Each plug-in lists the valid resources, and the administrators can set permissions for the users who can view or modify these resources. + +1. [Resource Scope](#resource-scope) +1. [REST API](#rest-api) + 1. [REST Query Parameters](#rest-query-parameters) + 1. [REST HTTP Methods](#rest-http-methods) + 1. [GET](#get) + 1. [PUT](#put) + 1. [DELETE](#delete) + 1. [Administrative Access & Group](#administrative-access-group) +1. [App API](#application-api) +1. [Internal and Bootstrapping](#internal-and-bootstrapping) +1. [Packaging Defaults](#packaging-defaults) +1. [Plugin Definition](#plug-in-definition) +1. [Aggregation Policies](#aggregation-policies) +1. [Examples](#examples) + +## Resource Scope + +Data is stored within the Configuration Dataservice according to the selected *Scope*. The intent of *Scope* within the Dataservice is to facilitate company-wide administration and privilege management of Zowe data. + +When a user requests a resource, the resource that is retrieved is an override or an aggregation of the broader scopes that encompass the *Scope* from which they are viewing the data. + +When a user stores a resource, the resource is stored within a *Scope* but only if the user has access privilege to update within that *Scope*. + +*Scope* is one of the following: + +**Plugin** + +Configuration defaults that come with a plugin. Cannot be modified. + +**Product** + +Configuration defaults that come with the product. Cannot be modified. + +**Site** + +Data that can be used between multiple instances of the Zowe Application Server. + +**Instance** + +Data within an individual Zowe Application Server. + +**Group** + +Data that is shared between multiple users in a group.(Pending) + +**User** + +Data for an individual user.(Pending) + +**Note:** While Authorization tuning can allow for settings such as GET from Instance to work without login, *User* and *Group* scope queries will be rejected if not logged in due to the requirement to pull resources from a specific user. Because of this, *User* and *Group* scopes will not be functional until the Security Framework is merged into the mainline. + +Where *Plugin* is the broadest scope and *User* is the narrowest scope. + +When you specify *Scope* *User*, the service manages configuration for your particular username, using the authentication of the session. This way, the *User* scope is always mapped to your current username. + +Consider a case where a user wants to access preferences for their text editor. One way they could do this is to use the REST API to retrieve the settings resource from the *Instance* scope. + +The *Instance* scope might contain editor defaults set by the administrator. But, if there are no defaults in *Instance*, then the data in *Group* and *User* would be checked. + +Therefore, the data the user receives would be no broader than what is stored in the *Instance* scope, but might have only been the settings they saved within their own *User* scope (if the broader scopes do not have data for the resource). + +Later, the user might want to save changes, and they try to save them in the *Instance* scope. Most likely, this action will be rejected because of the preferences set by the administrator to disallow changes to the *Instance* scope by ordinary users. + +## REST API + +When you reach the Configuration Service through a REST API, HTTP methods are used to perform the desired operation. + +The HTTP URL scheme for the configuration dataservice is: + +`/plugins/com.rs.configjs/services/data////?` + +Where the resources are one or more levels deep, using as many layers of subresources as needed. + +Think of a resource as a collection of elements, or a directory. To access a single element, you must use the query parameter "name=" + +### REST query parameters + +**Name** (string) + +Get or put a single element rather than a collection. + +**Recursive** (boolean) + +When performing a DELETE, specifies whether to delete subresources too. + +**Listing** (boolean) + +When performing a GET against a resource with content subresources, `listing=true` will provide the names of the subresources rather than both the names and contents. + +### REST HTTP methods + +Below is an explanation of each type of REST call. + +Each API call includes an example request and response against a hypothetical application called the "code editor". + +#### GET + +GET `/plugins/com.rs.configjs/services/data///?name=` + + * This returns JSON with the attribute "content" being a JSON resource that is the entire configuration that was requested. For example: + + ```/plugins/com.rs.configjs/services/data/org.openmainframe.zowe.codeeditor/user/sessions/default?name=tabs``` + + The parts of the URL are: + + - Plugin: org.openmainframe.zowe.codeeditor + - Scope: user + - Resource: sessions + - Subresource: default + - Element = tabs + +The response body is a JSON config: +``` +{ + "_objectType" : "com.rs.config.resource", + "_metadataVersion" : "1.1", + "resource" : "org.openmainframe.zowe.codeeditor/USER/sessions/default", + "contents" : { + "_metadataVersion" : "1.1", + "_objectType" : "org.openmainframe.zowe.codeeditor.sessions.tabs", + "tabs" : [{ + "title" : "TSSPG.REXX.EXEC(ARCTEST2)", + "filePath" : "TSSPG.REXX.EXEC(ARCTEST2)", + "isDataset" : true + }, { + "title" : ".profile", + "filePath" : "/u/tsspg/.profile" + } + ] + } +} +``` + +GET `/plugins/com.rs.configjs/services/data///` + + This returns JSON with the attribute `content` being a JSON object that has each attribute being another JSON object, which is a single configuration element. + +GET `/plugins/com.rs.configjs/services/data///` + +(When subresources exist.) + + This returns a listing of subresources that can, in turn, be queried. + +#### PUT + +PUT `/plugins/com.rs.configjs/services/data///?name=` + +Stores a single element (must be a JSON object `{...}`) within the requested scope, ignoring aggregation policies, depending on the user privilege. For example: + + ```/plugins/com.rs.configjs/services/data/org.openmainframe.zowe.codeeditor/user/sessions/default?name=tabs``` + +Body: + +``` +{ + "_metadataVersion" : "1.1", + "_objectType" : "org.openmainframe.zowe.codeeditor.sessions.tabs", + "tabs" : [{ + "title" : ".profile", + "filePath" : "/u/tsspg/.profile" + }, { + "title" : "TSSPG.REXX.EXEC(ARCTEST2)", + "filePath" : "TSSPG.REXX.EXEC(ARCTEST2)", + "isDataset" : true + }, { + "title" : ".emacs", + "filePath" : "/u/tsspg/.emacs" + } + ] +} + +``` +Response: + +``` +{ + "_objectType" : "com.rs.config.resourceUpdate", + "_metadataVersion" : "1.1", + "resource" : "org.openmainframe.zowe.codeeditor/USER/sessions/default", + "result" : "Replaced item." +} +``` + +#### DELETE + +DELETE `/plugins/com.rs.configjs/services/data///?recursive=true` + + Deletes all files in all leaf resources below the resource specified. + +DELETE `/plugins/com.rs.configjs/services/data///?name=` + + Deletes a single file in a leaf resource. + +DELETE `/plugins/com.rs.configjs/services/data///` + + * Deletes all files in a leaf resource. + * Does not delete the directory on disk. + + +### Administrative access and group + +By means not discussed here, but instead handled by the server's authentication and authorization code, a user might be privileged to access or modify items that they do not own. + +In the simplest case, it might mean that the user is able to do a PUT, POST, or DELETE to a level above *User*, such as *Instance*. + +The more interesting case is in accessing another user's contents. In this case, the shape of the URL is different. Compare the following two commands: + +GET `/plugins/com.rs.configjs/services/data//user/` + +Gets the content for the current user. + +GET `/plugins/com.rs.configjs/services/data//users//` + +Gets the content for a specific user if authorized. + +This is the same structure that is used for the *Group* scope. When requesting content from the *Group* scope, the user is checked to see if they are authorized to make the request for the specific group. For example: + +GET `/plugins/com.rs.configjs/services/data//group//` + +Gets the content for the given group, if the user is authorized. + + +## Application API + +Retrieves and stores configuration information from specific scopes. + +**Note:** This API should only be used for configuration administration user interfaces. + +`ZLUX.UriBroker.pluginConfigForScopeUri(pluginDefinition: ZLUX.Plugin, scope: string, resourcePath:string, resourceName:string): string;` + +A shortcut for the preceding method, and the preferred method when you are retrieving configuration information, is simply to "consume" it. It "asks" for configurations using the *User* scope, and allows the configuration service to decide which configuration information to retrieve and how to aggregate it. (See below on how the configuration service evaluates what to return for this type of request). + +`ZLUX.UriBroker.pluginConfigUri(pluginDefinition: ZLUX.Plugin, resourcePath:string, resourceName:string): string;` + +## Internal and bootstrapping + +Some dataservices within plug-ins can take configuration that affects their behavior. This configuration is stored within the Configuration Dataservice structure, but it is not accessible through the REST API. + +Within the instance configuration directory of a zLUX installation, each plugin may optionally have an `_internal` directory. An example of such a path would be: + +`~/.zowe/workspace/app-server/ZLUX/pluginStorage//_internal` + +Within each `_internal` directory, the following directories might exist: + +* `services/`: Configuration resources for the specific service. +* `plugin`: Configuration resources that are visible to all services in the plug-in. + +The JSON contents within these directories are provided as Objects to dataservices through the dataservice context Object. + +## Packaging Defaults +The best way to provide default settings for a plugin is to include it as part of the plugin's package. +It's easy to distribute to users, requires no configuration steps, and is read-only from the server. +To package, all content must be stored within the `/config/storageDefaults` directory of your plugin. +Within, non-leaf resources are folders, and leaf resources are files, regardless of JSON or binary. +The `_internal` folder and content is also permitted. + +## Plug-in definition + +Because the Configuration Dataservices stores data on a per-plug-in basis, each plug-in must define their resource structure to make use of the Configuration Dataservice. The resource structure definition is included in the plug-in's `pluginDefinition.json` file. + +For each resource and subresource, you can define an `aggregationPolicy` to control how the data of a broader scope alters the resource data that is returned to a user when requesting a resource from a narrower Scope. + +For example: +``` + "configurationData": { //is a direct attribute of the pluginDefinition JSON + "resources": { //always required + "preferences": { + "locationType": "relative", //this is the only option for now, but later absolute paths may be accepted + "aggregationPolicy": "override" //override and none for now, but more in the future + }, + "sessions": { //the name at this level represents the name used within a URL, such as /plugins/com.rs.configjs/services/data/org.openmainframe.zowe.codeeditor/user/sessions + "aggregationPolicy": "none", + "subResources": { + "sessionName": { + "variable": true, //if variable=true is present, the resource must be the only one in that group but the name of the resource is substituted for the name given in the REST request, so it represents more than one + "aggregationPolicy": "none" + } + } + } + } + } +``` + +## Aggregation policies + +Aggregation policies determine how the Configuration Dataservice aggregates JSON objects from different Scopes together when a user requests a resource. If the user requests a resource from the *User* scope, the data from the User scope might replace or be merged with the data from a broader scope such as *Instance*, to make a combined resource object that is returned to the user. + +Aggregation policies are defined by a plug-in developer in the plug-in's definition for the Configuration Service, as the attribute `aggregationPolicy` within a resource. + +The following policies are currently implemented: + +* **NONE**: If the Configuration Dataservice is called for *Scope User*, only user-saved settings are sent, unless there are no user-saved settings for the query, in which case the dataservice attempts to send data that is found at a broader scope. + +* **OVERRIDE**: The Configuration Dataservice obtains data for the resource that is requested at the broadest level found, and joins the resource's properties from narrower scopes, overriding broader attributes with narrower ones, when found. + + +## Examples + + [zlux-app-manager](https://github.com/zowe/zlux-app-manager/tree/v2.x/master/bootstrap/src/uri/mvd-uri.ts) + [VT Terminal App](https://github.com/zowe/vt-ng2/blob/v2.x/master/webClient/src/app/app.component.ts) diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-core-loggers.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-core-loggers.md new file mode 100644 index 0000000000..49419eb25d --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-core-loggers.md @@ -0,0 +1,36 @@ +This is a list of core loggers (and descriptions of each) that you can enable and increase verbosity on within the logging framework. See [the logging utility](mvd-logutility.md) for more info. + +# Loggers for Zowe Application Server Core +The log prefix for the Zowe Application Server is _zsf, which is used by the server framework. (Applications and plug-ins that are attached to the server do not use the _zsf prefix.) +The following are the logger names that you can specify: +* **_zsf.bootstrap**: Logging that pertains to the startup of the server. +* **_zsf.auth**: Logging for network calls that must be checked for authentication and authorization purposes. +* **_zsf.static**: Logging of the serving of static files (such as images) from an application's /web folder. +* **_zsf.child**: Logging of child processes, if any. +* **_zsf.utils**: Logging for miscellaneous utilities that the server relies upon. +* **_zsf.proxy**: Logging for proxies that are set up in the server. +* **_zsf.install**: Logging for the installation of plug-ins. +* **_zsf.apiml**: Logging for communication with the api mediation layer. +* **_zsf.routing**: Logging for dispatching network requests to plug-in dataservices. +* **_zsf.network**: Logging for the HTTPS server status (connection, ports, IP, and so on) + +# Zowe App Server Log levels +* 0: SEVERE +* 1: WARNING +* 2 (Default): INFO +* 3: FINE +* 4: FINER +* 5: FINEST + + +# Loggers for ZSS Server Core +The log prefix for ZSS is _zss. The following are the logger names that you can specify: +* **_zss.traceLevel**: Controls general server logging verbosity. +* **_zss.fileTrace**: Logs file serving behavior (if file serving is enabled). +* **_zss.socketTrace**: Logs general TCP Socket behavior. +* **_zss.httpParseTrace**: Logs parsing of HTTP messages. +* **_zss.httpDispatchTrace**: Logs dispatching of HTTP messages to dataservices. +* **_zss.httpHeadersTrace**: logs parsing and setting of HTTP headers. +* **_zss.httpSocketTrace**: Logs TCP socket behavior for HTTP. +* **_zss.httpCloseConversationTrace**: Logs HTTP behavior for when an HTTP conversation ends. +* **_zss.httpAuthTrace**: Logs behavior for session security. diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-dataservices.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-dataservices.md new file mode 100644 index 0000000000..3ed45f3a36 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-dataservices.md @@ -0,0 +1,352 @@ +# Dataservices + +Dataservices are dynamic backend components of Zowe™ plug-in applications. You can optionally add them to your applications to make the application do more than receive static content from the proxy server. Each dataservice defines a URL space that the server can use to run extensible code from the application. Dataservices are mainly intended to create REST APIs and WebSocket channels. + +## Defining dataservices + +You define dataservices in the application's `pluginDefinition.json` file. Each application requires a definition file to specify how the server registers and uses the application's backend. You can see an example of a `pluginDefinition.json` file in the top directory of the [sample-angular-app](https://github.com/zowe/sample-angular-app). + +In the definition file is a top level attribute called `dataServices`, for example: +``` + "dataServices": [ + { + "type": "router", + "name": "hello", + "serviceLookupMethod": "external", + "fileName": "helloWorld.js", + "routerFactory": "helloWorldRouter", + "dependenciesIncluded": true + } + ] +``` + +To define your dataservice, create a set of keys and values for your dataservice in the `dataservices` array. + +## Schema + +The documentation on dataservice types and parameters for each are specified within the [pluginDefinition.json json-schema document](https://github.com/zowe/zlux/blob/v2.x/staging/schemas/plugindefinition-schema.json) + +## Defining Java dataservices +In addition to other types of dataservice, you can use Java (also called java-war) dataservices in your applications. Java dataservices are powered by Java Servlets. + +To use a Java dataservice you must meet the prerequisites, define the dataservice in your plug-in definition, and define the Java Application Server library to the Zowe Application Server. + +### Prerequisites + +- Install a Java Application Server library. In this release, Tomcat is the only supported library. +- Make sure your plug-in's compiled Java program is in the application's `/lib` directory, in either a `.war` archive file or a directory extracted from a `.war` archive file. Extracting your file is recommended for faster start-up time. + +### Defining Java dataservices + +To define the dataservice in the `pluginDefinition.json` file, specify the type as `java-war`, for example: + +``` +"dataServices": [ + { + "type": "java-war", + "name": "javaservlet", + "filename": "javaservlet.war", + "dependenciesIncluded": true, + "initializerLookupMethod": "external", + "version": "1.0.0" + } + ], +``` + +To access the service at runtime, the plug-in can use the Zowe dataservice URL standard: `/ZLUX/plugins/[PLUGINID]/services/[SERVICENAME]/[VERSIONNUMBER]` + +Using the example above, a request to get users might be: `/ZLUX/plugins/[PLUGINID]/services/javaservlet/1.0.0/users` + +**Note:** If you extracted your servlet contents from a `.war` file to a directory, the directory must have the same name as the file would have had. Using the example above, `javaservlet.war` must be extracted to a directory named `\javaservlet`. + +### Defining Java Application Server libraries + +In the `zlux-app-server/zluxserver.json` file, use the example below to specify Java Application Server library parameters: + +``` +"languages": { + "java": { + "runtimes": { + "name": { + "home": "" + } + } + "war": { + "defaultGrouping": "" + "pluginGrouping": [] + "javaAppServer": { + "type": "tomcat", + "path": "../../zlux-server-framework/lib/java/apache-tomcat", + "config": "../deploy/instance/ZLUX/serverConfig/tomcat.xml", + "https": { + "key": "../deploy/product/ZLUX/serverConfig/zlux.keystore.key", + "certificate": "../deploy/product/ZLUX/serverConfig/zlux.keystore.cer" + } + } + }, + "portRange": [7600,7650] + } + } + +``` + +Specify the following parameters in the `languages.java` object: + +- `runtimes` (object) - The name and location of a Java runtime that can be used by one or more services. Used to load a Tomcat instance. + - `name` (object) - The name of the runtime. + - `home` (string) - The path to the runtime root. Must include `/bin` and `/lib` directories. +- `ports` (array``````)(Optional) - An array of port numbers that can be used by instances of Java Application Servers or microservices. Must contain as many ports as distinct servers that will be spawned, which is defined by other configuration values within `languages.java`. Either `ports` or `portRange` is required, but `portRange` has a higher priority. +- `portRange` (array``````)(Optional) - An array of length 2, which contains a start number and end number to define a range of ports to be used by instances of application servers or microservices. You will need as many ports as distinct servers that will be spawned, which is defined by other configuration values within `languages.java`. Either `ports` or `portRange` is required, but `portRange` has a higher priority. +- `war` (object) - Defines how the Zowe Application Server should handle `java-war` dataservices. + - **defaultGrouping** (string)(Optional) - Defines how services should be grouped into instances of Java Application Servers. Valid values: `appserver` or `microservice`. Default: `appserver`. `appserver` means 1 server instance for all services. `microservice` means one server instance per service. + - **pluginGrouping** (array``````)(Optional) - Defines groups of plug-ins to have their `java-war` services put within a single Java Application Server instance. + - **plugins** (Array``````) - Lists the plugins by identifier which should be put into this group. Plug-ins with no `java-war` services are skipped. Being in a group excludes a plugin from being handled by `defaultGrouping`. + - **runtime** (string)(Optional) - States the runtime to be used by the Tomcat server instance, as defined in `languages.java.runtimes`. + - **javaAppServer** (object) - Java Application Server properties. + - **type** (string) - Type of server. In this release, `tomcat` is the only valid value. + - **path** (string) - Path of the server root, relative to `zlux-app-server/lib`. Must include `/bin` and `/lib` directories. + - **config** (string) - Path of the server configuration file, relative to `zlux-app-server/lib`. + - **https** (object) - HTTPS parameters. + - **key** (string) - Path of a private key, relative to `zlux-app-server/lib`. + - **certificate** (string) - Path of an HTTPS certificate, relative to `zlux-app-server/lib`. + +### Java dataservice logging + +The Zowe Application Server creates the Java Application Server instances required for the `java-war` dataservices, so it logs the stdout and stderr streams for those processes in its log file. Java Application Server logging is not managed by Zowe at this time. + +### Java dataservice limitations + +Using Java dataservices with a Zowe Application Server installed on a Windows computer, the source and Java dataservice code must be located on the same storage volume. + +To create multiple instances of Tomcat on non-Windows computers, the Zowe Application Server establishes symbolic links to the service logic. On Windows computers, symbolic links require administrative privilege, so the server establishes junctions instead. Junctions only work when the source and destination reside on the same volume. + +## Using dataservices with RBAC +If your administrator configures the Zowe Application Framework to use role-based access control (RBAC), then when you create a dataservice you must consider the length of its paths. + +To control access to dataservices, administrators can enable RBAC, then use a z/OS security product such as RACF to map roles and authorities to a System Authorization Facility (SAF) profile. For information on RBAC, see [Applying role-based access control to dataservices](../../user-guide/mvd-configuration.md#applying-role-based-access-control-to-dataservices). + +SAF profiles have the following format: + +`..SVC....` + +For example, to access this dataservice endpoint: + +`/ZLUX/plugins/org.zowe.foo/services/baz/_current/users/fred` + +Users must have READ access to the following profile: + +`ZLUX.DEFAULT.SVC.ORG_ZOWE_FOO.BAZ.POST.USERS.FRED` + +Profiles cannot contain more than 246 characters. If the path section of an endpoint URL makes the profile name exceed limit, the path is trimmed to only include elements that do not exceed the limit. For example, imagine that each path section in this endpoint URL contains 64 characters: + +`/ZLUX/plugins/org.zowe.zossystem.subsystems/services/data/_current/aa..a/bb..b/cc..c/dd..d` + +So `aa..a` is 64 "a" characters, `bb..b` is 64 "b" characters, and so on. The URL could then map to the following example profile: + +`ZLUX.DEFAULT.SVC.ORG_ZOWE_ZOSSYSTEM_SUBSYSTEMS.DATA.GET.AA..A.BB..B` + +The profile ends at the `BB..B` section because adding `CC..C` would put it over 246 characters. So in this example, all dataservice endpoints with paths that start with `AA..A.BB..B` are controlled by this one profile. + +To avoid this issue, we recommend that you maintain relatively short endpoint URL paths. + +## Dataservice APIs + +Dataservice APIs can be categorized as Router-based or ZSS-based, and either WebSocket or not. + +### Router-based dataservices + +Each Router dataservice can safely import Express, express-ws, and bluebird without requiring the modules to be present, because these modules exist in the proxy server's directory and the *NODE_MODULES* environment variable can include this directory. + +#### HTTP/REST Router dataservices + +Router-based dataservices must return a (bluebird) Promise that resolves to an ExpressJS router upon success. For more information, see the ExpressJS guide on use of Router middleware: [Using Router Middleware](http://expressjs.com/en/guide/using-middleware.html#middleware.router). + +Because of the nature of Router middleware, the dataservice need only specify URLs that stem from a root '/' path, as the paths specified in the router are later prepended with the unique URL space of the dataservice. + +The Promise for the Router can be within a Factory export function, as mentioned in the `pluginDefinition` specification for *routerFactory* above, or by the module constructor. + +An example is available in the [Sample Angular App.](https://github.com/zowe/sample-angular-app/blob/master/nodeServer/ts/helloWorld.ts) + +#### WebSocket Router dataservices + +ExpressJS routers are fairly flexible, so the contract to create the Router for WebSockets is not significantly different. + +Here, the express-ws package is used, which adds WebSockets through the ws package to ExpressJS. The two changes between a WebSocket-based router and a normal router are that the method is 'ws', as in `router.ws(,)`, and the callback provides the WebSocket on which you must define event listeners. + +See the ws and express-ws topics on [www.npmjs.com](https://www.npmjs.com) for more information about how they work, as the API for WebSocket router dataservices is primarily provided in these packages. + +An example is available in `zlux-server-framework/plugins/terminal-proxy/lib/terminalProxy.js` + +#### Router dataservice context + +Every router-based dataservice is provided with a `Context` object upon creation that provides definitions of its surroundings and the functions that are helpful. The following items are present in the `Context` object: + +**serviceDefinition** + +The dataservice definition, originally from the `pluginDefinition.json` file within a plug-in. + +**serviceConfiguration** + +An object that contains the contents of configuration files, if present. + +**logger** + +An instance of a Zowe Logger, which has its component name as the unique name of the dataservice within a plug-in. + +**makeSublogger** + +A function to create a Zowe Logger with a new name, which is appended to the unique name of the dataservice. + +**addBodyParseMiddleware** + +A function that provides common body parsers for HTTP bodies, such as JSON and plaintext. + +**plugin** + +An object that contains more context from the plug-in scope, including: + +- **pluginDef**: The contents of the `pluginDefinition.json` file that contains this dataservice. + +- **server**: An object that contains information about the server's configuration such as: + + - **app**: Information about the product, which includes the *productCode* (for example: `ZLUX`). + + - **user**: Configuration information of the server, such as the port on which it is listening. + +#### Router storage API + + + +### ZSS based dataservices + +ZSS dataservices much like zlux router services can be used to implement REST or websocket APIs. +Each service is associated with a URL which when requested will call a function to handle the request or websocket message event. + +#### HTTP/REST ZSS dataservices + +ZSS REST dataservices are registered into ZSS with a service installer function, where `initializerName` is the function name located in the dll `libraryName`. The `methods` list what HTTP methods are expected of this dataservice. +Example: + +``` +{ + "type": "service", + "name": "data", + "version": "1.0.0", + "initializerLookupMethod": "external", + "initializerName": "helloWorldDataServiceInstaller", + "libraryName": "helloWorld.so", + "methods": ["GET", "POST"], + "dependenciesIncluded": true +} +``` + +The service installer is given `DataService`, which includes context such as the above definition plus a `loggingIdentifier`. The service is also given `HttpServer`, a reference to ZSS and its configuration. +To register the dataservice, you must make an `HttpService` object like + +``` +HttpService *httpService = makeHttpDataService(dataService, server); +``` + +Then you must assign properties to the dataservice, such as + +* authType: What type of authentication and authorization checks should be done before calling this service. values such as `SERVICE_AUTH_NONE` when the service does not need securty or `SERVICE_AUTH_NATIVE_WITH_SESSION_TOKEN` when the service should be protected by ZSS's cookie are valid. +* serviceFunction: The function within this dataservice that will be called whenever a request is received. +* runInSubtask: (TRUE/FALSE) Whether to run the service function in a subtask or not whenever a request is received. +* doImpersonation: (TRUE/FALSE) When true, the service function will be ran as the authenticated user, rather than the server user. This is recommended whenever possible to keep permissions management in line with the users own permissions. + +Example of service installer: + +``` +void helloWorldDataServiceInstaller(DataService *dataService, HttpServer *server) { + HttpService *httpService = makeHttpDataService(dataService, server); + httpService->authType = SERVICE_AUTH_NATIVE_WITH_SESSION_TOKEN; + httpService->serviceFunction = serveHelloWorldDataService; + httpService->runInSubtask = TRUE; + httpService->doImpersonation = TRUE; + + HelloServiceData *serviceData = (HelloServiceData*)safeMalloc(sizeof(HelloServiceData), "HelloServiceData"); + serviceData->loggingId = dataService->loggingIdentifier; + + httpService->userPointer = serviceData; +} +``` + +When a request is received, the service function is called with the `HttpService` and `HttpResponse` objects. `HttpService` is used to store and retrieve cached data and access the storage API. `HttpRequest` is a pointer within the response object, and utilities exist to help with parsing it. + +Example of request handling: + +``` +static int serveHelloWorldDataService(HttpService *service, HttpResponse *response) { + HttpRequest *request = response->request; + char *routeFragment = stringListPrint(request->parsedFile, 1, 1000, "/", 0); + char *route = stringConcatenate(response->slh, "/", routeFragment); + + HelloServiceData *serviceData = service->userPointer; + serviceData->timesVisited++; + + zowelog(NULL, serviceData->loggingId, ZOWE_LOG_WARNING, + "Inside serveHelloWorldDataService\n"); + + if (!strcmp(request->method, methodGET)) { + jsonPrinter *p = respondWithJsonPrinter(response); + + setResponseStatus(response, 200, "OK"); + setDefaultJSONRESTHeaders(response); + writeHeader(response); + + jsonStart(p); + { + jsonAddString(p, "message", "Hello World!"); + jsonAddInt(p, "timesVisited", serviceData->timesVisited); + } + jsonEnd(p); + } + + finishResponse(response); + return 0; +} +``` + +#### ZSS dataservice context and structs + +Headers to important dataservice structs include +* [HttpResponse](https://github.com/zowe/zowe-common-c/blob/zss-v1.27.0/h/httpserver.h#L117) +* [HttpRequest](https://github.com/zowe/zowe-common-c/blob/zss-v1.27.0/h/http.h#L124) +* [HttpService](https://github.com/zowe/zowe-common-c/blob/zss-v1.27.0/h/httpserver.h#L173) +* [HttpServer](https://github.com/zowe/zowe-common-c/blob/zss-v1.27.0/h/httpserver.h#L223) +* [Json handling](https://github.com/zowe/zowe-common-c/blob/zss-v1.27.0/h/json.h) +* [DataService context](https://github.com/zowe/zowe-common-c/blob/zss-v1.27.0/h/dataservice.h#L57) +* [Utilities](https://github.com/zowe/zowe-common-c/blob/zss-v1.27.0/h/utils.h) +* [Data structures](https://github.com/zowe/zowe-common-c/blob/zss-v1.27.0/h/collections.h) + + +#### ZSS storage API + +The [DataService](https://github.com/zowe/zowe-common-c/blob/zss-v1.27.0/h/dataservice.h#L57) struct contains two [Storage structs](https://github.com/zowe/zowe-common-c/blob/zss-v1.27.0/h/storage.h#L22), `localStorage` and `remoteStorage`. They implement the same API for getting, setting, and removing data, but manage the data in different locations. `localStorage` stores data within the ZSS server, for high speed access. `remoteStorage` stores data in the Caching Service, for high availability state storage. + +Usage example: +Sample angular app storage test api: https://github.com/zowe/sample-angular-app/blob/v1.23.0-RC1/zssServer/src/storage.c + +## Documenting dataservices +It is recommended that you document your RESTful application dataservices in OpenAPI (Swagger) specification documents. The Zowe Application Server hosts Swagger files for users to view at runtime. + +To document a dataservice, take the following steps: + +1. Create a `.yaml` or `.json` file that describes the dataservice in valid [Swagger 2.0](https://swagger.io/specification/v2/) format. Zowe validates the file at runtime. + +2. Name the file with the same name as the dataservice. Optionally, you can include the dataservice version number in the format: `_`. For example, a Swagger file for a dataservice named `user` must be named either `users.yaml` or `users_1.1.0.yaml`. + +3. Place the Swagger file in the `/doc/swagger` directory below your application plug-in directory, for example: + + `/sample-angular-app/doc/swagger/hello.yaml` + + + +At runtime, the Zowe Application Server does the following: + +- Dynamically substitutes known values in the files, such as the hostname and whether the endpoint is accessible using HTTP or HTTPS. +- Builds documentation for each dataservice and for each application plug-in, in the following locations: + - Dataservice documentation: `/ZLUX/plugins//catalogs/swagger/servicename` + - Application plug-in documentation: `/ZLUX/plugins//catalogs/swagger` + +- In application plug-in documentation, displays only stubs for undocumented dataservices, stating that the dataservice exists but showing no details. Undocumented dataservices include non-REST dataservices such as WebSocket services. diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-desktopandwindowmgt.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-desktopandwindowmgt.md new file mode 100644 index 0000000000..e32f4a0950 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-desktopandwindowmgt.md @@ -0,0 +1,185 @@ +# Zowe Desktop and window management + +The Zowe™ Desktop is a web component of Zowe, which is an implementation of `MVDWindowManagement`, the interface that is used to create a window manager. + +The code for this software is in the `zlux-app-manager` repository. + +The interface for building an alternative window manager is in the `zlux-platform` repository. + + +Window Management acts upon Windows, which are visualizations of an instance of an application plug-in. Application plug-ins are plug-ins of the type "application", and therefore the Zowe Desktop operates around a collection of plug-ins. + +**Note:** Other objects and frameworks that can be utilized by application plug-ins, but not related to window management, such as application-to-application communication, Logging, URI lookup, and Auth are not described here. + + +## Loading and presenting application plug-ins + +Upon loading the Zowe Desktop, a GET call is made to ```/plugins?type=application```. +The GET call returns a JSON list of all application plug-ins that are on the server, which can be accessed by the user. Application plug-ins can be composed of dataservices, web content, or both. Application plug-ins that have web content are presented in the Zowe Desktop UI. + +The Zowe Desktop has a taskbar at the bottom of the page, where it displays each application plug-in as an icon with a description. The icon that is used, and the description that is presented are based on the application plug-in's `PluginDefinition`'s `webContent` attributes. + +## Plug-in management + +Application plug-ins can gain insight into the environment in which they were spawned through the Plugin Manager. Use the Plugin Manager to determine whether a plug-in is present before you act upon the existence of that plug-in. When the Zowe Desktop is running, you can access the Plugin Manager through ```ZoweZLUX.PluginManager``` + +The following are the functions you can use on the Plugin Manager: + +* getPlugin(pluginID: string) + * Accepts a string of a unique plug-in ID, and returns the Plugin Definition Object (DesktopPluginDefinition) that is associated with it, if found. + + +## Application management + +Application plug-ins within a Window Manager are created and acted upon in part by an Application Manager. The Application Manager can facilitate communication between application plug-ins, but formal application-to-application communication should be performed by calls to the Dispatcher. The Application Manager is not normally directly accessible by application plug-ins, instead used by the Window Manager. + +The following are functions of an Application Manager: + +| Function | Description +| --- | --- +`spawnApplication(plugin: DesktopPluginDefinition, launchMetadata: any): Promise;` | Opens an application instance into the Window Manager, with or without context on what actions it should perform after creation. +`killApplication(plugin:ZLUX.Plugin, appId:MVDHosting.InstanceId): void;` | Removes an application instance from the Window Manager. +`showApplicationWindow(plugin: DesktopPluginDefinitionImpl): void;` | Makes an open application instance visible within the Window Manager. +`isApplicationRunning(plugin: DesktopPluginDefinitionImpl): boolean;` | Determines if any instances of the application are open in the Window Manager. + +## Windows and Viewports + +When a user clicks an application plug-in's icon on the taskbar, an instance of the application plug-in is started and presented within a Viewport, which is encapsulated in a Window within the Zowe Desktop. +Every instance of an application plug-in's web content within Zowe is given context and can listen on events about the Viewport and Window it exists within, regardless of whether the Window Manager implementation utilizes these constructs visually. It is possible to create a Window Manager that only displays one application plug-in at a time, or to have a drawer-and-panel UI rather than a true windowed UI. + +When the Window is created, the application plug-in's web content is encapsulated dependent upon its framework type. The following are valid framework types: + +* *"angular2"*: The web content is written in Angular, and packaged with Webpack. Application plug-in framework objects are given through @injectables and imports. +* *"iframe"*: The web content can be written using any framework, but is included through an iframe tag. Application plug-ins within an iframe can access framework objects through *parent.RocketMVD* and callbacks. +* *"react"*: The web content is written in React, Typescript, and packaged with Webpack. App framework objects are provided via the [ReactMVDResources object](https://github.com/zowe/zlux-app-manager/blob/v2.x/master/virtual-desktop/src/pluginlib/react-inject-resources.ts) + +In the case of the Zowe Desktop, this framework-specific wrapping is handled by the Plugin Manager. + +## Viewport Manager + +Viewports encapsulate an instance of an application plug-in's web content, but otherwise do not add to the UI (they do not present Chrome as a Window does). +Each instance of an application plug-in is associated with a viewport, and operations to act upon a particular application plug-in instance should be done by specifying a viewport for an application plug-in, to differentiate which instance is the target of an action. Actions performed against viewports should be performed through the Viewport Manager. + +The following are functions of the Viewport Manager: + +| Function | Description +| --- | --- +`createViewport(providers: ResolvedReflectiveProvider[]): MVDHosting.ViewportId;` | Creates a viewport into which an application plug-in's webcontent can be embedded. +`registerViewport(viewportId: MVDHosting.ViewportId, instanceId: MVDHosting.InstanceId): void;` | Registers a previously created viewport to an application plug-in instance. +`destroyViewport(viewportId: MVDHosting.ViewportId): void;` | Removes a viewport from the Window Manager. +`getApplicationInstanceId(viewportId: MVDHosting.ViewportId): MVDHosting.InstanceId | null;` | Returns the ID of an application plug-in's instance from within a viewport within the Window Manager. + +## Injection Manager + +When you create Angular application plug-ins, they can use injectables to be informed of when an action occurs. iframe application plug-ins indirectly benefit from some of these hooks due to the wrapper acting upon them, but Angular application plug-ins have direct access. + +The following topics describe injectables that application plug-ins can use. + +### Plug-in definition + +``` +@Inject(Angular2InjectionTokens.PLUGIN_DEFINITION) private pluginDefinition: ZLUX.ContainerPluginDefinition +``` + +Provides the plug-in definition that is associated with this application plug-in. This injectable can be used to gain context about the application plug-in. It can also be used by the application plug-in with other application plug-in framework objects to perform a contextual action. + +### Logger + +``` +@Inject(Angular2InjectionTokens.LOGGER) private logger: ZLUX.ComponentLogger +``` + +Provides a logger that is named after the application plug-in's plugin definition ID. + +### Launch Metadata + +``` +@Inject(Angular2InjectionTokens.LAUNCH_METADATA) private launchMetadata: any +``` + +If present, this variable requests the application plug-in instance to initialize with some context, rather than the default view. + +### Viewport Events + +``` +@Inject(Angular2InjectionTokens.VIEWPORT_EVENTS) private viewportEvents: Angular2PluginViewportEvents +``` + +Presents hooks that can be subscribed to for event listening. Events include: + +`resized: Subject<{width: number, height: number}>` + +Fires when the viewport's size has changed. + +### Window Events + +``` +@Inject(Angular2InjectionTokens.WINDOW_ACTIONS) private windowActions: Angular2PluginWindowActions +``` + +Presents hooks that can be subscribed to for event listening. The events include: + +| Event | Description +| --- | --- +`maximized: Subject` | Fires when the Window is maximized. +`minimized: Subject` | Fires when the Window is minimized. +`restored: Subject` | Fires when the Window is restored from a minimized state. +`moved: Subject<{top: number, left: number}>` | Fires when the Window is moved. +`resized: Subject<{width: number, height: number}>` | Fires when the Window is resized. +`titleChanged: Subject` | Fires when the Window's title changes. + +### Window Actions + +``` +@Inject(Angular2InjectionTokens.WINDOW_ACTIONS) private windowActions: Angular2PluginWindowActions +``` + +An application plug-in can request actions to be performed on the Window through the following: + +| Item | Description +| --- | --- +`close(): void` | Closes the Window of the application plug-in instance. +`maximize(): void` | Maximizes the Window of the application plug-in instance. +`minimize(): void` | Minimizes the Window of the application plug-in instance. +`restore(): void` | Restores the Window of the application plug-in instance from a minimized state. +`setTitle(title: string):void` | Sets the title of the Window. +`setPosition(pos: {top: number, left: number, width: number, height: number}): void` | Sets the position of the Window on the page and the size of the window. +`spawnContextMenu(xPos: number, yPos: number, items: ContextMenuItem[]): void` | Opens a context menu on the application plug-in instance, which uses the Context Menu framework. +`registerCloseHandler(handler: () => Promise): void` | Registers a handler, which is called when the Window and application plug-in instance are closed. + +## Framework API examples + +The following are examples of how you would access the Window Actions API to begin an App in maximized mode upon start-up. + +**Angular** + +1. Import `Angular2InjectionTokens `from `'pluginlib/inject-resources'` +2. Within the constructor of your App, in the arguments, do +`@Optional() @Inject(Angular2InjectionTokens.WINDOW_ACTIONS) private windowActions: Angular2PluginWindowActions` +3. Then inside the constructor, check that window actions exist and then execute the action + ``` + if (this.windowActions) { + this.windowActions.maximize(); + } + ``` +4. Depending on your App layout, certain UI elements may not have loaded so to wait for them to load, one may want to use something like Angular's NgOnInit directive. + +**React** + +1. Similar to how we do things in Angular, except the Window Actions (& other Zowe resources) are located in the `resources` object. So if we were using a React.Component, we could have a constructor with +`constructor(props){ + super(props); + ... +}` + +2. Then accessing Window Actions would be as simple as `this.props.resources.windowActions` + +**IFrames** + +1. Iframes are similar to Angular & React, but require a different import step. Instead to use Window Actions (& other Zowe resources), we have to import the Iframe adapter. The Iframe adapter is located in `zlux-app-manager/bootstrap/web/iframe-adapter.js` so something like a relative path in my JS code will suffice, + +`` + +2. Then to use Window Actions would be as simple as `await windowActions.minimize();` + +NOTE: The Iframe adapter is not yet feature-complete. If you are attempting to use an event supported by Angular or React, but not yet supported in Iframes, try to use the `window.parent.ZoweZLUX` object instead. diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-embeddingplugins.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-embeddingplugins.md new file mode 100644 index 0000000000..6394dbc47f --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-embeddingplugins.md @@ -0,0 +1,116 @@ +# Embedding plugins +Add these imports to a component where you want to embed another plugin: +``` +app.component.ts +``` +``` +import {Inject, Injector, ViewChild, ViewContainerRef} from '@angular/core'; +import {Angular2InjectionTokens, Angular2PluginEmbedActions, EmbeddedInstance} from 'pluginlib/inject-resources'; +``` + +Inject Angular2PluginEmbedActions into your component constructor: +``` +app.component.ts +``` +``` + constructor(@Inject(Angular2InjectionTokens.PLUGIN_EMBED_ACTIONS) private embedActions: Angular2PluginEmbedActions) { + } +``` +In the component template prepare a container where you want to embed the plugin: +``` +app.component.html +``` +``` +
    + +
    +``` +In the component class add a reference to the container: +``` +app.component.ts +``` +``` + @ViewChild('embedded', {read: ViewContainerRef}) viewContainerRef: ViewContainerRef; +``` + +In the component class add a reference to the embedded instance: +``` +app.component.ts +``` +``` + private embeddedInstance: EmbeddedInstance; +``` +Everything is ready to start embedding, you just need to know the pluginId that you want to embed: +``` +app.component.ts +``` +``` + embedPlugin(): void { + const pluginId = 'org.zowe.zlux.sample.angular'; + const launchMetadata = null; + this.embedActions.createEmbeddedInstance(pluginId, launchMetadata, this.viewContainerRef) + .then(embeddedInstance => this.embeddedInstance = embeddedInstance) + .catch(e => console.error(`couldn't embed plugin ${pluginId} because ${e}`)); + } +``` +## How to interact with embedded plugin +If the main component of embedded plugin declares Input and Output properties then you can interact with it. ApplicationManager provides methods to set Input properties and get Output properties of the embedded plugin. Suppose, that the embedded plugin declares Input and Output properties like this: +``` +plugin.component.ts +``` +``` + @Input() sampleInput: string; + @Output() sampleOutput: EventEmitter = new EventEmitter(); +``` +Obtain a reference to ApplicationManager in your component constructor: +``` +app.component.ts +``` +``` + private applicationManager: MVDHosting.ApplicationManagerInterface; + constructor( + @Inject(Angular2InjectionTokens.PLUGIN_EMBED_ACTIONS) private embedActions: Angular2PluginEmbedActions, + // @Inject(MVDHosting.Tokens.ApplicationManagerToken) private applicationManager: MVDHosting.ApplicationManagerInterface + injector: Injector + ) { + this.applicationManager = this.injector.get(MVDHosting.Tokens.ApplicationManagerToken); + } +``` +*Note:* We are unable to inject `ApplicationManager` with `@Inject()` until an AoT-compiler issue with namespaces is resolved: [angular/angular#15613](https://github.com/angular/angular/issues/15613) + +Now you can set `sampleInput` property, obtain `sampleOutput` property and subscribe to it: +``` +app.component.ts +``` +``` +this.applicationManager.setEmbeddedInstanceInput(this.embeddedInstance, 'sampleInput', 'some value'); + + const sampleOutput: Observable = this.applicationManager.getEmbeddedInstanceOutput(this.embeddedInstance, 'sampleOutput'); + sampleOutput.subscribe(value => console.log(`get new value ${value} from sampleOutput`)); +``` +## How to destroy embedded plugin +There is no special API to destroy embedded plugin. If you want to destroy the embedded plugin just clear the container for the embedded plugin and set `embeddedInstance` to null: +``` +app.component.ts +``` +``` + this.viewContainerRef.clear(); + this.embeddedInstance = null; +``` +## How to style a container for the embedded plugin +It is hard to give a universal recipe for a container style. At least, the container needs `position: "relative"` because the embedded plugin may have absolutely positioned elements. Here is sample styles you can start with if your component utilizes flexbox layout: +``` +app.component.css +``` +``` + .container-for-embedded-window { + position: relative; + flex: 1 1 auto; + align-self: stretch; + display: flex; + flex-direction: column; + align-items: stretch; + } +``` +## Applications that use embedding +[Workflow app](https://github.com/zowe/zlux-workflow/blob/master/webClient/src/app/workflow-step-wizard/workflow-step-wizard.component.ts) demonstrates advanced usage. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-errorreportingui.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-errorreportingui.md new file mode 100644 index 0000000000..d432994a14 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-errorreportingui.md @@ -0,0 +1,106 @@ +# Error reporting UI + +The `zLUX Widgets` repository contains shared widget-like components of the Zowe™ Desktop, including Button, Checkbox, Paginator, various pop-ups, and others. To maintain consistency in desktop styling across all applications, use, reuse, and customize existing widgets to suit the purpose of the application's function and look. + +Ideally, a program should have little to no logic errors. Once in a while a few occur, but more commonly an error occurs from misconfigured user settings. A user might request an action or command that requires certain prerequisites, for example: a proper ZSS-Server configuration. If the program or method fails, the program should notify the user through the UI about the error and how to fix it. For the purposes of this discussion, we will use the Workflow application plug-in in the `zlux-workflow` repository. + + +## ZluxPopupManagerService + +The `ZluxPopupManagerService` is a standard popup widget that can, through its `reportError()` method, be used to display errors with attributes that specify the title or error code, severity, text, whether it should block the user from proceeding, whether it should output to the logger, and other options you want to add to the error dialog. `ZluxPopupManagerService` uses both `ZluxErrorSeverity` and `ErrorReportStruct`. +``` +`export declare class ZluxPopupManagerService {` + + eventsSubject: any; + listeners: any; + events: any; + logger: any; + constructor(); + setLogger(logger: any): void; + on(name: any, listener: any): void; + broadcast(name: any, ...args: any[]): void; + processButtons(buttons: any[]): any[]; + block(): void; + unblock(): void; + getLoggerSeverity(severity: ZluxErrorSeverity): any; + reportError(severity: ZluxErrorSeverity, title: string, text: string, options?: any): Rx.Observable; +`}` +``` +## ZluxErrorSeverity + +`ZluxErrorSeverity` classifies the type of report. Under the popup-manager, there are the following types: error, warning, and information. Each type has its own visual style. To accurately indicate the type of issue to the user, the error or pop-up should be classified accordingly. +``` +`export declare enum ZluxErrorSeverity {` + + ERROR = "error", + WARNING = "warning", + INFO = "info", +`}` +``` +## ErrorReportStruct + +`ErrorReportStruct` contains the main interface that brings the specified parameters of `reportError()` together. +``` +`export interface ErrorReportStruct {` + + severity: string; + modal: boolean; + text: string; + title: string; + buttons: string[]; +`}` +``` +## Implementation + +Import `ZluxPopupManagerService` and `ZluxErrorSeverity` from widgets. If you are using additional services with your error prompt, import those too (for example, `LoggerService` to print to the logger or `GlobalVeilService` to create a visible semi-transparent gray veil over the program and pause background tasks). Here, widgets is imported from `node_modules\@zlux\` so you must ensure zLUX widgets is used in your `package-lock.json` or `package.json` and you have run `npm install`. + +`import { ZluxPopupManagerService, ZluxErrorSeverity } from '@zlux/widgets';` + +### Declaration + +Create a member variable within the constructor of the class you want to use it for. For example, in the Workflow application plug-in under `\zlux-workflow\src\app\app\zosmf-server-config.component.ts` is a `ZosmfServerConfigComponent` class with the pop-up manager service variable. To automatically report the error to the console, you must set a logger. +``` +`export class ZosmfServerConfigComponent {` + + constructor( + private popupManager: ZluxPopupManagerService, ) + { popupManager.setLogger(logger); } //Optional +`}` +``` +### Usage + +Now that you have declared your variable within the scope of your program's class, you are ready to use the method. The following example describes an instance of the `reload()` method in Workflow that catches an error when the program attempts to retrieve a configuration from a `configService` and set it to the program's `this.config`. This method fails when the user has a faulty zss-Server configuration and the error is caught and then sent to the class' `popupManager` variable from the constructor above. +``` +`reload(): void {` + + this.globalVeilService.showVeil(); + this.configService + .getConfig() + .then(config => (this.config = config)) + .then(_ => setTimeout(() => this.test(), 0)) + .then(_ => this.globalVeilService.hideVeil()) + .catch(err => { + this.globalVeilService.hideVeil() + let errorTitle: string = "Error"; + let errorMessage: string = "Server configuration not found. Please check your zss server."; + const options = { + blocking: true + }; + this.popupManager.reportError(ZluxErrorSeverity.ERROR, errorTitle.toString()+": "+err.status.toString(), errorMessage+"\n"+err.toString(), options); + }); +`}` +``` +Here, the `errorMessage` clearly describes the error with a small degree of ambiguity as to account for all types of errors that might occur from that method. The specifics of the error are then generated dynamically and are printed with the `err.toString()`, which contains the more specific information that is used to pinpoint the problem. The `this.popupManager.report()` method triggers the error prompt to display. The error severity is set with `ZluxErrorSeverity.ERROR` and the `err.status.toString()` describes the status of the error (often classified by a code, for example: `404`). The optional parameters in `options` specify that this error will block the user from interacting with the application plug-in until the error is closed or it until goes away on its own. `globalVeilService` is optional and is used to create a gray veil on the outside of the program when the error is caused. You must import `globalVeilService` separately (see the `zlux-workflow` repository for more information). + +### HTML + +The final step is to have the recently created error dialog display in the application plug-in. If you do `this.popupManager.report()` without adding the component to your template, the error will not be displayed. Navigate to your component's `.html` file. On the Workflow application plug-in, this file will be in `\zlux-workflow\src\app\app\zosmf-server-config.component.html` and the only item left is to add the popup manager component alongside your other classes. + +`` + +So now when the error is called, the new UI element should resemble the following: + +![UI element](../../images/mvd/mvderrorreportui.png) + + +The order in which you place the pop-up manager determines how the error dialog will overlap in your UI. If you want the error dialog to overlap other UI elements, place it at the end of the `.html` file. You can also create custom styling through a CSS template, and add it within the scope of your application plug-in. diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-extendingzlux.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-extendingzlux.md new file mode 100644 index 0000000000..28eab82c7d --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-extendingzlux.md @@ -0,0 +1,102 @@ +# Zowe Application Framework overview + +You can create application plug-ins to extend the capabilities of the Zowe™ Application Framework. An application plug-in is an installable set of files that present resources in a web-based user interface, as a set of RESTful services, or in a web-based user interface and as a set of RESTful services. + +Read the following topics to get started with extending the Zowe Application Framework. + +## How Zowe Application Framework works + +Read the following topics to learn how Zowe Application Framework works: + +- [Creating application plug-ins](mvd-buildingplugins.md) +- [Plug-ins definition and structure](mvd-plugindefandstruct.md) +- [Dataservices](mvd-dataservices.md) +- [Zowe Desktop and window management](mvd-desktopandwindowmgt.md) +- [Configuration Dataservice](mvd-configdataservice.md) +- [URI Broker](mvd-uribroker.md) +- [Application-to-application communication](mvd-apptoappcommunication.md) +- [Error reporting UI](mvd-errorreportingui.md) +- [Logging utility](mvd-logutility.md) + +## Tutorials + +The following tutorials are available in Github. + +- **Stand up a local version of the Example Zowe Application Server** + + :::tip Github Repo: + [zlux-app-server](https://github.com/zowe/zlux-app-server/tree/staging/README.md) + ::: + +- **Internationalization in Angular Templates in Zowe Application Server** + + :::tip Github Sample Repo: + [sample-angular-app (Internationalization)](https://github.com/zowe/sample-angular-app/blob/lab/step-2-i18n-complete/README.md) + ::: + +- **App to app communication** + + :::tip Github Sample Repo : + [sample-angular-app (App to app communication)](https://github.com/zowe/sample-angular-app/blob/lab/step-3-app2app-complete/README.md) + ::: + +- **Using the Widgets Library** + + :::tip Github Sample Repo: + [sample-angular-app (Widgets)](https://github.com/zowe/sample-angular-app/blob/lab/step-4-widgets-complete/README.md) + ::: + +- **Configuring user preferences (configuration dataservice)** + + :::tip Github Sample Repo: + [sample-angular-app (configuration dataservice)](https://github.com/zowe/sample-angular-app/blob/lab/step-5-config-complete/README.md) + ::: + +## Samples + +Zowe allows extensions to be written in any UI framework through the use of an Iframe, or Angular and React natively. In this section, code samples of various use-cases will be provided with install instructions. + +:::warning Troubleshooting Suggestions: + +If you are running into issues, try these suggestions: + +- Restart the Zowe Server/ VM. +- Double check that the name in the plugins folder matches your identifier in `pluginDefinition.json` located in the Zowe root. +- After logging into the Zowe desktop, use the Chrome or Firefox developer tools and navigate to the "network" tab to see what errors you are getting. +- Check each file with `cat ` to be sure it wasn't corrupted while uploading. If files were corrupted, try uploading using a different method like SCP or SFTP. + +::: + +### Sample Iframe App + +:::tip Github Sample Repo: +[sample-iframe-app](https://github.com/zowe/sample-iframe-app) +::: + +### Sample Angular App + +:::tip Github Sample Repo: +[sample-angular-app](https://github.com/zowe/sample-angular-app/blob/lab/step-1-hello-world/README.md) +::: + +### Sample React App + +:::tip Github Sample Repo: +[sample-react-app](https://github.com/zowe/sample-react-app/blob/lab/step-1-hello-world/README.md) +::: + +### User Browser Workshop Starter App + +:::tip Github Sample Repo: +[workshop-starter-app](https://github.com/zowe/workshop-starter-app) +::: + +_This sample is included as the first part of a tutorial detailing communication between separate Zowe apps._ + +**It should be installed on your system before starting the [User Browser Workshop App Tutorial](https://github.com/zowe/workshop-user-browser-app/blob/master/README.md)** + +The App's scenario is that it has been opened to submit a task report to a set of users who can handle the task. +In this case, it is a bug report. We want to find engineers who can fix this bug, but this App does not contain a directory listing for engineers in the company, so we need to communicate with some App that does provide this information. +In this tutorial, you must build an App which is called by this App in order to list engineers, is able to be filtered by the office that they work from, and is able to submit a list of engineers which would be able to handle the task. + +After installing this app on your system, follow directions in the [User Browser Workshop App Tutorial](https://github.com/zowe/workshop-user-browser-app/blob/master/README.md) to enable app-to-app communication. diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-externals.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-externals.md new file mode 100644 index 0000000000..f672df67d5 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-externals.md @@ -0,0 +1,27 @@ +In the Zowe Desktop, multiple Apps can coexist but such Apps are treated as independent entities, and may be independently developed. To keep resources in check while allowing for Apps to depend on rich libraries, common libraries are deduplicated by having Apps refer to a collection of these libraries, considered the "Externals" bundle. This bundle is loaded on page load from `/ZLUX/plugins/org.zowe.zlux.ng2desktop/web/externals.js`. The current list of libraries that are present in this bundle is: + +| Library | Version | +|---------|---------| +| '@angular/animations' | 12.0.0 | +| '@angular/cdk' | 12.0.0 | +| '@angular/core' | 12.0.0 | +| '@angular/common' | 12.0.0 | +| '@angular/common/http' | 12.0.0 | +| '@angular/forms' | 12.0.0 | +| '@angular/platform-browser' | 12.0.0 | +| '@angular/cdk/portal' | 12.0.0 | +| '@angular/material' | 12.0.0 | +| '@angular/router' | 12.0.0 | +| 'angular-l10n' | 12.0.0 | +| 'bootstrap' | 4.3.1 | +| 'corejs' | 3.19.2 | +| 'jquery' | 3.6.0 | +| 'popper.js' | 1.14.7 | +| 'rxjs' | 6.6.0 | + +The above list is derived from 3 source files. Please consult them for up-to-date information: +1) [package-lock.json](https://github.com/zowe/zlux-app-manager/blob/v2.x/master/virtual-desktop/package-lock.json) for version information +2) [externals.ts](https://github.com/zowe/zlux-app-manager/blob/v2.x/master/virtual-desktop/src/externals.ts) which loads the libraries into the browser at page load +3) [externals-main.ts](https://github.com/zowe/zlux-app-manager/blob/v2.x/master/virtual-desktop/src/externals-main.ts) which imports libraries that were not loadable with the technique in #2 + +Apps that are not of type "iframe" should not use any other versions of these libraries, due to the chance for conflict to occur at runtime. diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-iframecomm.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-iframecomm.md new file mode 100644 index 0000000000..fba0d54281 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-iframecomm.md @@ -0,0 +1,28 @@ +# Configuring IFrame communication +The Zowe Application Framework provides the following shared resource functions through a [ZoweZLUX object](https://github.com/zowe/zlux-platform/blob/v2.x/master/interface/src/index.d.ts#L720): `pluginManager`, `uriBroker`, `dispatcher`, `logger`, `registry`, `notificationManager`, and `globalization` + +Like REACT and Angular apps, IFrame apps can use the ZoweZLUX object to communicate with the framework and other apps. To enable communication in an IFrame app, you must add the following javascript to your app, for example in your `index.html` file: + +```javascript + + + + +``` + +`logger.js` is the javascript version of `logger.ts` and is capable of the same functions, including access to the `Logger` and `ComponentLogger` classes. The `Logger` class determines the behavior of all the `ComponentLoggers` created from it. `ComponentLoggers` are what the user implements to perform logging. + +`Iframe-adapter.js` is designed to mimic the ZoweZLUX object that is available to apps within the virtual-desktop, and serves as the middle-man for communication between IFrame apps and the Zowe desktop. + +You can see an implementation of this functionality in the [sample IFrame app](https://github.com/zowe/sample-iframe-app). + +The version of ZoweZLUX adapted for IFrame apps is not complete and only implements the functions needed to allow the Sample IFrame App to function. The `notificationManager`, `logger`, `globalization`, `dispatcher`, `windowActions`, `windowEvents`, and `viewportEvents` are fully implemented. The `pluginManager` and `uriBroker` are only partially implemented. The `registry` is not implemented. + +Unlike REACT and Angular apps, in IFrame apps the ZoweZLUX and initialization objects communicate with Zowe using the browser's onmessage and postmessage APIs. That means that communication operations are asynchronous, and you must account for this in your app, for example by using [Promise objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) and `await` or `then` functions. + diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-installplugins.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-installplugins.md new file mode 100644 index 0000000000..d8da98a70b --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-installplugins.md @@ -0,0 +1,54 @@ +# Installing Plugins +Plugins can be added or removed from the Zowe App Server, as well as upgraded. There are two ways to do these actions: By REST API or by filesystem. The instructions below assume you have administrative permissions either to access the correct REST APIs or to have the necessary permissions to update server directories & files. + +**NOTE: Plugins must be [pre-built](mvd-buildingplugins.md), and follow the [directory structure](mvd-plugindefandstruct.md), and have all dependencies met to be successfully installed. Read the appServer or install-app log files within the Zowe instance's `` directory, (ex `~/.zowe/log/install-app.log`) if a plugin does not show in the Zowe desktop, but has been installed successfully.** + +## By filesystem +The App server uses directories of JSON files, described in the [server configuration document](mvd-server-config.md#deploy-configuration). Defaults are located in the folder `zlux-app-server/defaults/plugins`, but the server reads the list of plugins instead from the instance directory, at `/app-server/plugins` (for example, `~/.zowe/workspace/app-server/plugins` which includes JSON files describing where to find a plugin. Adding or removing JSONs from this folder will add or remove plugins upon server restart, or you can use REST APIs and cluster mode to add or remove plugins without restarting). + +### Adding/Installing +Plugins must be packaged as Components. You can install a plugin by running the component installer, `zwe components install`. For more information, try the help command `zwe components install --help`. + +### Removing +Plugins are hidden from the Desktop when a component is disabled. If a component is removed, the plugins from the component will be removed too. + +### Upgrading +Currently, only one version of a plugin can exist per server. So, to upgrade, you either upgrade the plugin within its pre-existing directory by rebuilding it (with more up to date code), or you alter the locator JSON of that app to point to the content of the upgraded version. + +### Modifying without server restart (Exercise to the reader) +The server's reading of the locator JSONs and initializing of plugins only happens during bootstrapping at startup. However, in cluster mode the bootstrapping happens once per worker process. Therefore, it is possible to manage plugins without a server restart by killing & respawning all worker processes without killing the cluster master process. This is what the REST API does, internally. To do this without the REST API, it may be possible to script knowing the parent process ID, and running a kill command on all child processes of the App server cluster process. + +## By REST API +The server REST APIs allow plugin management without restarting the server - you can add, remove, and upgrade plugins in real-time. However, removal or upgrade must be done carefully as it can disrupt users of those plugins. + +[This swagger file documents the REST API for plugin management](https://github.com/zowe/zlux-app-server/blob/master/doc/swagger/server-plugins-api.yaml) + +The API only works when RBAC is configured, and an RBAC-compatible security plugin is being used. An example of this is [zss-auth](https://github.com/zowe/zlux-server-framework/tree/v2.x/staging/plugins/sso-auth), and [use of RBAC](https://docs.zowe.org/stable/user-guide/mvd-configuration#enabling-rbac) is described in this documentation and in the [wiki](https://github.com/zowe/zlux/wiki/Auth-Plugin-Configuration). + + +*NOTE:* If you do not see your plugin in the Zowe desktop check the appServer and install-app log files within the Zowe instance's `` directory to troubleshoot the problem. If you are building your own desktop extension then you need to [pre-build](mvd-buildingplugins.md) your plugin with the correct [directory structure](mvd-plugindefandstruct.md), and meet all dependencies. + + +### Plugin management during development +Below are some tasks developers can do to work with plugins. These should not be done in production, as plugins are managed automatically at the component level. + +#### Installing +When running the app-server without zowe server infrastructure and tooling, it's still possible to install plugins directly. +To add or install a plugin, run the script `zlux-app-server/bin/install-app.sh` providing the location to a plugin folder. For example: + +`./install-app.sh /home/john/zowe/sample-angular-app` + +This will generate a JSON file `/app-server/plugins/org.zowe.zlux.sample.angular.json` that contains the plugin's ID and its location on disk. These JSON files tell the Desktop where to find apps and are the glue between the Zowe instance's desktop and the plugin code itself held in its directory. + +. For example, if we were to install the [sample angular-app](https://github.com/zowe/sample-angular-app) in the folder `/home/john/zowe/sample-angular-app`, then the JSON would be: +``` +{ + "identifier":"org.zowe.zlux.sample.angular", + "location": "/home/john/zowe/sample-angular-app" +} +``` + +#### Removing +To remove a plugin, locate the server's instance plugin directory `/app-server/plugins` (for example, `~/.zowe/workspace/app-server/plugins`) and remove the locator JSON that is associated with that plugin. Remove the plugin's content by deleting it from the file system if applicable. + + diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-internationalization.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-internationalization.md new file mode 100644 index 0000000000..47a8c08c44 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-internationalization.md @@ -0,0 +1,293 @@ +# Internationalizing applications +You can internationalize Zowe™ application plug-ins using Angular and React frameworks. Internationalized applications display in translated languages and include structures for ongoing translation updates. + +The steps below use the [Zowe Sample Angular Application](https://github.com/zowe/sample-angular-app/) and [Zowe Sample React Application](https://github.com/zowe/sample-react-app) as examples. Your applications might have slightly different requirements, for example the React Sample Application requires the react-i18next library, but your application might require a different React library. + +For detailed information on Angular or React, see their documentation. For detailed information on specific internationalization libraries, see their documentation. You can also reference the Sample Angular Application [internationalization tutorial](https://github.com/zowe/sample-angular-app/blob/lab/step-2-i18n-complete/README.md), and watch a video on how to [internationalize your Angular application](https://www.youtube.com/watch?v=kkCC2u1NQy4&feature=youtu.be). + +After you internationalize your application, you can view it by following steps in [Changing the desktop language](../../user-guide/mvd-using.md#changing-the-desktop-language). + +## Internationalizing Angular applications +Zowe applications that use the Angular framework depend on `.xlf` formatted files to store static translated content and `.json` files to store dynamic translated content. These files must be in the application's `web/assets/i18n` folder at runtime. Each translated language will have its own file. + +To internationalize an application, you must install Angular-compatible internationalization libraries. Be aware that libraries can be better suited to either static or dynamic HTML elements. The examples in this task use the ngx-i18nsupport library for static content and angular-l10n for dynamic content. + +To internationalize Zowe Angular applications, take the following steps: + +1. To install internationalization libraries, use the `npm` command, for example: + + ``` + npm install --save-dev ngx-i18nsupport + npm install --save-dev angular-l10n + ``` + **Note** `--save-dev` commits the library to the application's required libraries list for future use. + +2. To support the CLI tools and to control output, create a `webClient/tsconfig.i18n.json` typescript file and add the following content: + + ```json + { + "extends": "../../zlux-app-manager/virtual-desktop/plugin-config/tsconfig.ngx-i18n.json", + + "include": [ + "./src" + ], + + "compilerOptions": { + "outDir": "./src/assets/i18n", + "skipLibCheck": true + } + } + ``` + + For example, see this file in the [Sample Angular Application](https://github.com/zowe/sample-angular-app/blob/master/webClient/tsconfig.i18n.json). + +3. In the static elements in your HTML files, tag translatable content with the i18n attribute within an Angular template, for example: + + ```html +
    +

    Welcome

    +
    + ``` + The attribute should include a message ID, for example the `@@welcome` above. + +4. To configure static translation builds, take the following steps: + + a. In the `webClient/package.json` script, add the following line: + + ```json + "i18n": "ng-xi18n -p tsconfig.i18n.json --i18nFormat=xlf --outFile=messages.xlf && xliffmerge -p xliffmerge.json", + ``` + + b. In the in `webClient` directory, create a `xliffmerge.json` file, add the following content, and specify the codes for each language you will translate in the `languages` parameter: + + ```json + { + "xliffmergeOptions": { + "srcDir": "src/assets/i18n", + "genDir": "src/assets/i18n", + "i18nFile": "messages.xlf", + "i18nBaseFile": "messages", + "i18nFormat": "xlf", + "encoding": "UTF-8", + "defaultLanguage": "en", + "languages": ["fr","ru"], + "useSourceAsTarget": true + } + } + ``` + When you run the i18n script, it reads this file and generates a `messages.[lang].xlf` file in the `src/assets/i18n directory` for each language specified in the `languages` parameter. Each file contains the untranslated text from the i18n-tagged HTML elements. + +5. Run the following command to run the i18n script and extract i18n tagged HTML elements to `.xlf` files: + + ``` + npm run i18n + ``` + + **Note** If you change static translated content, you must run the `npm run build` command to build the application, and then re-run the `npm run i18n` command to extract the tagged content again. + +6. In each `.xlf` file, replace `target` element strings with translated versions of the `source` element strings. For example: + + ```xml + App Request Test + Test de Demande à l'App + ``` + +7. Run the following command to rebuild the application: + + ``` + npm run build + ``` + + When you [switch the Zowe Desktop](../../user-guide/mvd-using.md#changing-the-desktop-language) to one of the application's translated languages, the application displays the translated strings. + +9. For dynamic translated content, follow these steps: + + a. Import and utilize angular-l10n objects within an Angular component, for example: + + ```typescript + import { LocaleService, TranslationService, Language } from 'angular-l10n'; + Component({ + selector: 'app-root', + templateUrl: './app.component.html', + styleUrls: ['./app.component.css'], + providers: [HelloService] + }) + + export class AppComponent { + @Language() lang: string; + + public myDynamicMessage:string = ''; + + constructor( + public locale: LocaleService, + public translation: TranslationService) { } + + sayHello() { + this.myDynamicMessage = `${this.translation.translate('my_message')}`; + }); + } + } + ``` + + b. In the related Angular template, you can implement `myDynamicMessage` as an ordinary substitutable string, for example: + + ```html +
    + +
    + ``` + +10. Create logic to copy the translation files to the `web/assets` directory during the webpack process, for example in the sample application, the following JavaScript in the `copy-webpack-plugin` file copies the files: + + ```javascript + var config = { + 'entry': [ + path.resolve(__dirname, './src/plugin.ts') + ], + 'output': { + 'path': path.resolve(__dirname, '../web'), + 'filename': 'main.js', + }, + 'plugins': [ + new CopyWebpackPlugin([ + { + from: path.resolve(__dirname, './src/assets'), + to: path.resolve('../web/assets') + } + ]) + ] + }; + ``` + + **Note:** Do not edit files in the `web/assets/i18n` directory. They are overwritten by each build. + +## Internationalizing React applications + +To internationalize Zowe applications using the React framework, take the following steps: + +**Note:** These examples use the recommended react-i18next library, which does not differentiate between dynamic and static content, and unlike the Angular steps above does not require a separate build process. + +1. To install the React library, run the following command: + + `npm install --save-dev react-i18next` + +2. In the directory that contains your `index.js` file, create an `i18n.js` file and add the translated content, for example: + + ```javascript + import i18n from "i18next"; + import { initReactI18next } from "react-i18next"; + + // the translations + // (tip move them in a JSON file and import them) + const resources = { + en: { + translation: { + "Welcome to React": "Welcome to React and react-i18next" + } + } + }; + + i18n + .use(initReactI18next) // passes i18n down to react-i18next + .init({ + resources, + lng: "en", + + keySeparator: false, // we do not use keys in form messages.welcome + + interpolation: { + escapeValue: false // react already safes from xss + } + }); + + export default i18n; + ``` + +3. Import the `i18n` file from the previous step into `index.js` file so that you can use it elsewhere, for example: + + ```javascript + import React, { Component } from "react"; + import ReactDOM from "react-dom"; + import './i18n'; + import App from './App'; + + // append app to dom + ReactDOM.render( + , + document.getElementById("root") + ); + ``` + +4. To internationalize a component, include the `useTranslation` hook and reference it to substitute translation keys with their translated values. For example: + + ```javascript + import React from 'react'; + + // the hook + import { useTranslation } from 'react-i18next'; + + function MyComponent () { + const { t, i18n } = useTranslation(); // use + return

    {t('Welcome to React')}

    + } + ``` + + + +## Internationalizing application desktop titles + +To display the translated application name and description in the Desktop, take the following steps: + +1. For each language, create a `pluginDefinition.i18n..json` file. For example, for German create a `pluginDefinition.i18n.de.json` file. + +2. Place the `.json` files in the `web/assets/i18n` directory. + +3. Translate the `pluginShortNameKey` and `descriptionKey` values in the application's `pluginDefinition.json` file. For example, for the file below you would translate the values `"sampleangular"` and `"sampleangulardescription"`: + + ```json + { + "identifier": "org.zowe.zlux.sample.angular", + "apiVersion": "1.0.0", + "pluginVersion": "1.1.0", + "pluginType": "application", + "webContent": { + "framework": "angular2", + "launchDefinition": { + "pluginShortNameKey": "sampleangular", + "pluginShortNameDefault": "Angular Sample", + "imageSrc": "assets/icon.png" + }, + "descriptionKey": "sampleangulardescription", + "descriptionDefault": "Sample App Showcasing Angular Adapter", + ``` + +4. Add the translated values to the translation file. For example, the German translation file example, `pluginDefinition.i18n.de.json`, would look like this: + + ```json + { + "sampleangular": "Beispiel Angular", + "sampleangulardescription": "Beispiel Angular Anwendung" + } + ``` + +5. Create logic to copy the translation files to the `web/assets` directory during the webpack process. For example, in the [Sample Angular Application](https://github.com/zowe/sample-angular-app/blob/v2.x/master/webClient/webpack.config.js) the following JavaScript in the `webClient/webpack.config.js` file copies files to the `web/assets` directory: + + ```javascript + var config = { + 'entry': [ + path.resolve(__dirname, './src/plugin.ts') + ], + 'output': { + 'path': path.resolve(__dirname, '../web'), + 'filename': 'main.js', + }, + 'plugins': [ + new CopyWebpackPlugin([ + { + from: path.resolve(__dirname, './src/assets'), + to: path.resolve('../web/assets') + } + ]) + ] + }; + ``` diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-logutility.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-logutility.md new file mode 100644 index 0000000000..82f6a9bcc0 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-logutility.md @@ -0,0 +1,185 @@ +# Logging utility + +The `zlux-shared` repository provides a logging utility for use by dataservices and web content for an application plug-in. + +1. [Logging Objects](#logging-objects) +1. [Logger IDs](#logger-ids) +1. [Accessing Logger Objects](#accessing-logger-objects) + 1. [Logger](#logger) + 1. [App Server](#app-server) + 1. [Web](#web) + 1. [Component Logger](#component-logger) + 1. [App Server](#app-server-1) + 1. [Web](#web-1) +1. [Logger API](#logger-api) +1. [Component Logger API](#component-logger-api) +1. [Log Levels](#log-levels) +1. [Logging Verbosity](#logging-verbosity) + 1. [Configuring Logging Verbosity](#configuring-logging-verbosity) + 1. [Server Startup Logging Configuration](#server-startup-logging-configuration) +1. [Using log message IDs](#using-log-message-ids) + + +## Logging objects + +The logging utility is based on the following objects: + +* **Component Loggers**: Objects that log messages for an individual component of the environment, such as a REST API for an application plug-in or to log user access. +* **Destinations**: Objects that are called when a component logger requests a message to be logged. Destinations determine how something is logged, for example, to a file or to a console, and what formatting is applied. +* **Logger**: Central logging object, which can spawn component loggers and attach destinations. + +## Logger IDs + +Because Zowe™ application plug-ins have unique identifiers, both dataservices and an application plug-in's web content are provided with a component logger that knows this unique ID such that messages that are logged can be prefixed with the ID. With the association of logging to IDs, you can control verbosity of logs by setting log verbosity by ID. + +## Accessing logger objects + +### Logger + +The core logger object is attached as a global for low-level access. + +#### App Server + +NodeJS uses `global` as its global object, so the logger is attached to: +`global.COM_RS_COMMON_LOGGER` + +#### Web + +(Angular App Instance Injectible). See **Logger** in [Zowe Desktop and window management](mvd-desktopandwindowmgt.md). + +(others) Browsers use `window` as the global object, so the logger is attached to: +`window.COM_RS_COMMON_LOGGER` + +### Component logger + +Component loggers are created from the core logger object, but when working with an application plug-in, allow the application plug-in framework to create these loggers for you. An application plug-in's component logger is presented to dataservices or web content as follows. + +#### App Server + +See **Router Dataservice Context** in the topic [Dataservices](mvd-dataservices.md). + + +## Logger API + +The following constants and functions are available on the central logging object. + +| Attribute | Type | Description | Arguments | +|-----------|------|-------------|-----------| +| `makeComponentLogger` | function | Returns an existing logger of this name, or creates a new component logger if no logger of the specified name exists - Automatically done by the application framework for dataservices and web content | `componentIDString` | +| `setLogLevelForComponentName` | function | Sets the verbosity of an existing component logger | `componentIDString`, `logLevel` | + +## Component Logger API + +The following constants and functions are available to each component logger. + +| Attribute | Type | Description | Arguments +|-----------|------|-------------|---------- +| `CRITICAL` | const | Is a const for `logLevel` +| `SEVERE` | const | Is a const for `logLevel` +| `WARN` | const | Is a const for `logLevel` +| `WARNING` | const | Is a const for `logLevel` +| `INFO` | const | Is a const for `logLevel` +| `DEBUG` | const | Is a const for `logLevel` +| `FINE` | const | Is a const for `logLevel` +| `FINER` | const | Is a const for `logLevel` +| `TRACE` | const | Is a const for `logLevel` +| `FINEST` | const | Is a const for `logLevel` +| `log` | function | Used to write a log, specifying the log level | `logLevel`, `messageString` +| `critical` | function | Used to write a CRITICAL log. | `messageString` +| `severe` | function | Used to write a SEVERE log. | `messageString` +| `warn` | function | Used to write a WARNING log. | `messageString` +| `info` | function | Used to write an INFO log. | `messageString` +| `debug` | function | Used to write a FINE log. | `messageString` +| `trace` | function | Used to write a TRACE log. | `messageString` +| `makeSublogger` | function | Creates a new component logger with an ID appended by the string given | `componentNameSuffix` + +## Log Levels + +An enum, `LogLevel`, exists for specifying the verbosity level of a logger. The mapping is: + +| Level | Number +|-------|------- +| CRITICAL | 0 +| WARNING | 1 +| INFO | 2 +| DEBUG | 3 +| FINER | 4 +| TRACE | 5 + +**Note:** The default log level for a logger is **INFO**. + + +## Logging verbosity + +Using the component logger API, loggers can dictate at which level of verbosity a log message should be visible. +You can configure the server or client to show more or less verbose messages by using the core logger's API objects. + +Example: You want to set the verbosity of the org.zowe.foo application plug-in's dataservice, bar to show debugging information. + +`logger.setLogLevelForComponentName('org.zowe.foo.bar',LogLevel.DEBUG)` + +### Configuring logging verbosity + +The application plug-in framework provides ways to specify what component loggers you would like to set default verbosity for, such that you can easily turn logging on or off. + +#### Server startup logging configuration + +[The server configuration file](https://github.com/zowe/zlux/wiki/Configuration-for-zLUX-App-Server-&-ZSS) allows for specification of default log levels, as a top-level attribute `logLevel`, which takes key-value pairs where the key is a regex pattern for component IDs, and the value is an integer for the log levels. + +For example: +``` +"logLevel": { + "com.rs.configjs.data.access": 2, + //the string given is a regex pattern string, so .* at the end here will cover that service and its subloggers. + "com.rs.myplugin.myservice.*": 4 + // + // '_' char reserved, and '_' at beginning reserved for server. Just as we reserve + // '_internal' for plugin config data for config service. + // _unp = universal node proxy core logging + //"_unp.dsauth": 2 + }, +``` +For more information about the server configuration file, see [Zowe Application Framework (zLUX) configuration](../../user-guide/mvd-configuration#configuration-file). + +## Using log message IDs +To make technical support for your application easier, create IDs for common log messages and use substitution to generate them. When you use IDs, people fielding support calls can identify and solve problems more quickly. IDs are particularly helpful if your application is translated, because it avoids users having to explain problems using language that the tech support person might not understand. + +To use log message IDs, take the following steps: + +1. Depending on how your application is structured, create message files in the following locations: + - Web log messages: `{plugin}/web/assets/i18n/log/messages_{language}.json` + - App server log messages: `{plugin}/lib/assets/i18n/log/messages_{language}.json` + +2. In the files, create ID-message pairs using the following format: + + ``` + { "id1": "value1", "id2": "value2" [...] } + ``` + + Where "id#" is the message ID and "value#" is the text. For example: + + ``` + { "A001": "Application created.", "A002": "Application deleted." [...] } + ``` + +3. Reference the IDs in your code, for example: + + ``` + this.log.info("A001") + ``` + + Which compiles to: + + ``` + DATE TIME:TIME:TIME.TIME username INFO (org.zowe.app.name,:) A001 - Application created. + ``` + + Or in another supported language, such as Russian: + + ``` + DATE TIME:TIME:TIME.TIME username INFO (org.zowe.app.name,:) A001 - Приложение создано. + ``` + +### Message ID logging examples + +Server core: https://github.com/zowe/zlux-server-framework/blob/v2.x/master/plugins/config/lib/assets/i18n/log/messages_en.json diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-mvdandwindowmgt.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-mvdandwindowmgt.md new file mode 100644 index 0000000000..8405259e6d --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-mvdandwindowmgt.md @@ -0,0 +1,183 @@ +# Zowe Desktop and Window management + +The Zowe™ Desktop (MVD) is a web component of Zowe, which is an implementation of **MVDWindowManagement**, the interface that is used to create a window manager. + +The code for this software is in the `lux-app-manager` repository. + +The interface for building an alternative window manager is in the `zlux-platform` repository. + +Window Management acts upon Windows, which are visualizations of an instance of an application. Applications are plug-ins of type "application", and therefore the Zowe Desktop operates around a collection of plug-ins. + +**Note:** Other objects and frameworks that can be utilized by applications, but not related to Window Management, such as application-to-application communication, Logging, URI lookup, and Auth are not described here. + +# Loading and presenting applications + +Upon loading the Zowe Desktop, a GET call is made to `/plugins?type=application`. +The GET call returns a JSON list of all of the applications that are present on the server, which can be accessed by the user. Applications can be composed of dataservices, web content, or both. Applications that have web content are presented in the Zowe Desktop UI. + +The Zowe Desktop presents a taskbar at the bottom of the page, where it displays each application as an icon with a description. The icon that is used, and description that are presented are based on the applications's PluginDefinition's **webContent** attributes. + +# Plug-in management + +Applications can gain insight into the environment in which they have been spawned through the Plug-in Manager. Use the Plug-in Manager to determine whether a plug-in is present before acting upon the existence of the plug-in. When the Zowe Desktop is running, you can access the Plug-in Manager through `ZoweZLUX.PluginManager` + +The following are functions you can use on the Plug-in Manager: + +- getPlugin(pluginID: string) + - Accepts a string of a unique plugin ID, and returns the Plug-in Definition Object (DesktopPluginDefinition) associated with it, if found. + +# Application management + +Applications within a Window Manager are created and acted upon in part by an Application Manager. The Application Manager can facilitate communication between applications, but formal application-to-application communication should be performed by calls to the Dispatcher. The Application Manager is not normally accessible directly by applications, instead used by the Window Manager. + +The following are functions of an Application Manager: + +- `spawnApplication(plugin: DesktopPluginDefinition, launchMetadata: any): Promise;` + + - Opens an application instance into the Window Manager, with or without context on what actions it should perform after creation. + +- killApplication(plugin:ZLUX.Plugin, appId:MVDHosting.InstanceId): void; + + - Removes an application instance from the Window Manager. + +- showApplicationWindow(plugin: DesktopPluginDefinitionImpl): void; + + - Makes an open application instance visible within the Window Manager. + +- isApplicationRunning(plugin: DesktopPluginDefinitionImpl): boolean; + - Determines if instances of the application are open in the Window Manager. + +# Windows and Viewports + +When a user clicks on an application's icon on the taskbar, an instance of the application is started and presented within a Viewport, which is encapsulated in a Window within the Zowe Desktop. + +Every instance of an application's web content within Zowe is given context and can listen on events about the Viewport and Window it exists within, regardless of whether the Window Manager implementation uses these constructs visually. It is possible to create a Window Manager that only displays one application at a time, or to have a drawer-and-panel UI rather than a true windowed UI. + +When the Window is created, the application's web content is encapsulated dependent upon its framework type. The following are valid framework types: + +- "angular2": The web content is written in Angular, and packaged with Webpack. Application framework objects are given through @injectables and imports. + +- "iframe": The web content can be written using any framework, but is included through an iframe tag. Applications within an iframe can access framework objects through `parent.ZoweZLUX` and callbacks. + +In the case of the Zowe Desktop, this framework-specific wrapping is handled by the Plug-in Manager. + +# Viewport Manager + +Viewports encapsulate an instance of an application's web content, but otherwise do not add to the UI (they do not present Chrome as a Window does). +Each instance of an application is associated with a viewport, and operations to act upon a particular application instance should be done by specifying a viewport for an application, to differentiate which instance is the target of an action. Actions performed against viewports should be performed through the Viewport Manager. + +The following are functions of the Viewport Manager: + +- createViewport(providers: ResolvedReflectiveProvider[]): MVDHosting.ViewportId; + + - Creates a viewport into which you can embed an application's webcontent. + +- registerViewport(viewportId: MVDHosting.ViewportId, instanceId: MVDHosting.InstanceId): void; + + - Registers a previously created viewport to an application instance. + +- destroyViewport(viewportId: MVDHosting.ViewportId): void; + + - Removes a viewport from the Window Manager. + +- getApplicationInstanceId(viewportId: MVDHosting.ViewportId): MVDHosting.InstanceId | null; + - Returns the ID of an application's instance from within a viewport in the Window Manager. + +# Injection Manager + +When Angular applications are created, they can utilize injectables to be informed of when an action happens. iframe applications indirectly benefit from some of these hooks due to the wrapper acting upon them, but Angular applications have direct access. + +An application can utilize the following injectables: + +## Plugin Definition + +`@Inject(Angular2InjectionTokens.PLUGIN_DEFINITION) private pluginDefinition: ZLUX.ContainerPluginDefinition` + +Provides the Plug-in Definition associated with this application. It can be used to gain some context about the application and can also be used by the application with other application framework objects to perform a contextual action. + +## Logger + +`@Inject(Angular2InjectionTokens.LOGGER) private logger: ZLUX.ComponentLogger` + +Provides a logger that is named after the application's Plug-in Definition ID. + +## Launch Metadata + +`@Inject(Angular2InjectionTokens.LAUNCH_METADATA) private launchMetadata: any` + +If present, this variable requests the application instance to initialize with some context, rather than the default view. + +## Viewport Events + +`@Inject(Angular2InjectionTokens.VIEWPORT_EVENTS) private viewportEvents: Angular2PluginViewportEvents` + +Presents hooks that can be subscribed to for event listening. Events include: + +- resized: Subject`<{width: number, height: number}>` + - Starts when the viewport's size has changed. + +## Window Events + +`@Inject(Angular2InjectionTokens.WINDOW_ACTIONS) private windowActions: Angular2PluginWindowActions` + +Presents hooks that can be subscribed to for event listening. Events include the following: + +- maximized: Subject`` + + - Starts when the Window has been maximized. + +- minimized: Subject`` + + - Starts when the Window has been minimized. + +- restored: Subject`` + + - Starts when the Window has been restored from a minimized state. + +- moved: Subject`<{top: number, left: number}>` + + - Starts when the Window has been been moved. + +- resized: Subject`<{width: number, height: number}>` + + - Starts when the Window has been resized. + +- titleChanged: Subject`` + - Starts when the Window's title has changed. + +## Window Actions + +`@Inject(Angular2InjectionTokens.WINDOW_ACTIONS) private windowActions: Angular2PluginWindowActions` + +An application can request actions to be performed on the Window through the following: + +- close(): void + + - Closes the Window of the application instance. + +- maximize(): void + + - Maximizes the Window of the application instance. + +- minimize(): void + + - Minimizes the Window of the application instance. + +- restore(): void + + - Restores the Window of the application instance from a minimized state. + +- setTitle`(title: string)`: void + + - Sets the title of the Window. + +- setPosition`(pos: {top: number, left: number, width: number, height: number})`: void + + - Sets the position of the Window on the page and the size of the window. + +- spawnContextMenu`(xPos: number, yPos: number, items: ContextMenuItem[])`: void + + - Opens a context menu on the application instance. + +- registerCloseHandler`(handler: () => Promise)`: void + - Registers a handler, which is called when the Window and application instance are closed. diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-plugindefandstruct.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-plugindefandstruct.md new file mode 100644 index 0000000000..5ef56d143b --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-plugindefandstruct.md @@ -0,0 +1,85 @@ +# Plug-ins definition and structure + +The Zowe™ Application Server (`zlux-app-server`) enables extensiblity with application Plugins. Application Plugins are a subcategory of the unit of extensibility in the server called a *plugin*. + +The files that define a Plugin are located in the `pluginsDir` directory. + + +## pluginDefinition.json + +This file describes an application Plugin to the Zowe Application Server. (A Plugin is the unit of extensibility for the Zowe Application Server. An application Plugin is a Plugin of the type "Application", the most common and visible type of Plugin.) A definition file informs the server whether the application Plugin has server-side dataservices, client-side web content, or both. The attributes of this file are defined within the [pluginDefinition json-schema document](https://github.com/zowe/zlux/blob/v2.x/staging/schemas/plugindefinition-schema.json) + + +## Application Plugin filesystem structure + +An application Plugin can be loaded from a filesystem that is accessible to the Zowe Application Server, or it can be loaded dynamically at runtime. When accessed from a filesystem, there are important considerations for the developer and the user as to where to place the files for proper build, packaging, and operation. + +### Root files and directories + +The root of an application Plugin directory contains the pluginDefinition.json file, and the following other files and directories. + +### Dev and source content + +Aside from demonstration or open source application Plugins, the following directories should not be visible on a deployed server because the directories are used to build content and are not read by the server. + +#### nodeServer + +When an application Plugin has router-type dataservices, they are interpreted by the Zowe Application Server by attaching them as ExpressJS routers. It is recommended that you write application Plugins using [Typescript](http://www.typescriptlang.org/), because it facilitates well-structured code. Use of Typescript results in build steps because the pre-transpilation Typescript content is not to be consumed by NodeJS. Therefore, keep server-side source code in the `nodeServer` directory. At runtime, the server loads router dataservices from the [lib](#lib) directory. + +#### webClient + +When an application Plugin has the *webContent* attribute in its definition, the server serves static content for a client. To optimize loading of the application Plugin to the user, use Typescript to write the application Plugin and then package it using [Webpack](https://webpack.js.org/). Use of Typescript and Webpack result in build steps because the pre-transpilation Typescript and the pre-webpack content are not to be consumed by the browser. Therefore, separate the source code from the served content by placing source code in the `webClient` directory. + +### Runtime content + +At runtime, the following set of directories are used by the server and client. + +#### lib + +The `lib` directory is where router-type dataservices are loaded by use in the Zowe Application Server. If the JS files that are loaded from the `lib` directory require NodeJS modules, which are not provided by the server base (the modules `zlux-server-framework` requires are added to `NODE_PATH` at runtime), then you must include these modules in `lib/node_modules` for local directory lookup or ensure that they are found on the `NODE_PATH` environment variable. `nodeServer/node_modules` is not automatically accessed at runtime because it is a dev and build directory. + +#### web + +The `web` directory is where the server serves static content for an application Plugin that includes the *webContent* attribute in its definition. Typically, this directory contains the output of a webpack build. Anything you place in this directory can be accessed by a client, so only include content that is intended to be consumed by clients. + +#### Packaging applications as compressed files +Application Plugin files can be served to browsers as compressed files in brotli (.br) or gzip (.gz) format. The file must be below the application's `/web` directory, and the browser must support the compression method. If there are multiple compressed files in the `/web` directory, the Zowe Application Server and browser perform runtime negotiation to decide which file to use. + +### Default user configuration +[Configuration Dataservice](mvd-configdataservice) default settings for users can be packaged within a Plugin. +This is done by putting content within the `/config/storageDefaults` folder, and more on that subject can be [found here](mvd-configdataservice.md#packaging-defaults) + +### App-to-App Communication +App-to-App communication behaviors can be statically defined or dynamically created at runtime. Static definitions help as a form of documentation and to be able to depend upon them, so it is recommended that these be packaged with a Plugin if you wish other's to be able to use App-to-App communication on your App. +[This page describes the subject in more detail](mvd-apptoappcommunication.md#saved-on-system). +In summary, App-to-App Actions and Recognizers can be stored within an App's `/config/actions` and `/config/recognizers` folders, respectively, where the filenames much match the identifiers of Apps. + +### Documentation +In order for Zowe servers to pick up documentation to present to UIs, they must be in a uniform place. + +The **/doc** folder of any Plugin can contain at its root any READMEs or documents that an administrator or developer may care about when working with a Plugin for the first time. + +The **/doc/swagger** folder on the other hand, will be used to store .yaml extension Swagger 2.0 files that document the APIs of a Plugin's dataservices if they exist. + +Other folders may exist, such as **/doc/ui** to document help behavior that may be shown in a UI, but is not implemented at this time. + + +## Location of Plugin files + +The files that define a Plugin are located in the `plugins` directory. + +### pluginsDir directory + +At startup, the server reads from the `plugins` directory. The server loads the valid Plugins that are found by the information that is provided in the JSON files. + +Within the `pluginsDir` directory are a collection of JSON files. Each file has two attributes, which serve to locate a Plugin on disk: + +**location**: This is a directory path that is relative to the server's executable (such as `zlux-app-server/bin/start.sh`) at which a `pluginDefinition.json` file is expected to be found. + +**identifier**: The unique string (commonly styled as a Java resource) of a Plugin, which must match what is in the `pluginDefinition.json` file. + +## Application Dataservices +See [Dataservices](mvd-dataservices.md) + +## Application Configuration Data +The App server has a component for managing an App's configuration & user data, organized by scope such as user, group, and server instance. For more information, see [Configuration Dataservice Documentation.](mvd-configdataservice.md) diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-server-config.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-server-config.md new file mode 100644 index 0000000000..c5298224ae --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-server-config.md @@ -0,0 +1,159 @@ +The Zowe's App Server and ZSS rely on many required or optional parameters to run, which includes setting up networking, deployment directories, plugin locations, and more. +These parameters can be specified in multiple ways: configuration files, CLI arguments, or environment variables. + +Every configuration option and requirement is documented within the application framework [json-schema file](https://github.com/zowe/zlux/blob/v2.x/staging/schemas/zlux-config-schema.json) + +# Configuration file +In Zowe's server configuration file, app-server parameters can be specified within `components.app-server` as shown in the component [json-schema file](https://github.com/zowe/zlux/blob/v2.x/staging/schemas/zowe-schema.json), or `components.zss` for ZSS. + +# Environment variables +CLI arguments take precedence over the configuration file, but are overridden by the CLI arguments. +The format is `ZWED_key=value`, where "ZWED_" is a prefix for any configuration object. +The key maps to a YAML object attribute, so to set the value of a nested object, such as the https configuration, you need multiple values. +For example: +``` +node: + https: + ipAddresses: 0.0.0.0 + port: 7556 + //pfx (string), keys, certificates, certificateAuthorities, and certificateRevocationLists are all valid here. + keys: "../defaults/serverConfig/server.key" + certificates: "../defaults/serverConfig/server.cert" + + +logLevels: + _zsf.auth:1 + org.zowe.terminal.tn3270.*: 5 + +``` +In Environment variable format, this is specified as +``` +ZWED_node_https_ipAddresses=0.0.0.0 +ZWED_node_https_port=8554 +ZWED_node_https_keys="../defaults/serverConfig/server.key" +ZWED_node_https_certificates="../defaults/serverConfig/server.cert" +ZWED_logLevels__x5fzsf____auth:1 +ZWED_logLevels_org____zowe____terminal____tn3270_x2e_x2a:5 +``` + +**The key names are syntax sensitive.** +* They are case-sensitive +* All ascii characters except " are allowed in the object attribute names. + * An encoding scheme is used for many symbols because environment variables can only have names with the characters A-Z, a-z, 0-9, `_`, `.`, and `-` + * The scheme is _x followed by 2 hex numbers will be converted to the corresponding ASCII character, such as _x41 mapping to `A` +* _ is used as the object separator, so an escape sequence is used if `_` is actually needed for the key. + * Single leading and trailing _ are treated as literal `_` + * __ will be maps to literal `_` + * ___ maps to literal `-` + * ____ maps to literal `.` + +**The types of the values are syntax-sensitive.** +* Numbers are treated as numbers, not strings. +* false & true are treated as boolean. +* commas are for arrays. An array of length 1 has a comma at the end +* strings can have quotes, but otherwise everything that isnt an array, boolean, or number is a string +* objects are never values. They are the keys. + +## Friendly names for environment variables +Some common configuration options have names that do not follow the above special syntax. These options get mapped to the special syntax when the server runs, so the same behavior can be configured in more than one way. Many of these values are listed here https://docs.zowe.org/stable/user-guide/configure-zowe-zosmf-workflow/#configure-the-zowe-instance-directory. + + +Although overridden by both environment variables and CLI arguments, for convenience the App server and ZSS read from a configuration file with a common structure. ZSS reads this directly as a startup argument, while the App Server as defined in the [zlux-server-framework](https://github.com/zowe/zlux-server-framework) repository accepts several parameters which are intended to be read from a YAML file through an implementer of the server, such the default provided in the [zlux-app-server](https://github.com/zowe/zlux-app-server) repository, namely the [lib/zluxServer.js](https://github.com/zowe/zlux-app-server/blob/v2.x/master/lib/zluxServer.js) file. This file accepts a YAML file that specifies most if not all parameters needed, but some other parameters can be provided via flags if desired. + + +# CLI arguments (app-server only) +CLI arguments take precedence over environment variable and configuration files. +The format is `--key=value` +The key maps to a YAML object attribute, so to set the value of a nested object, such as the https configuration, you need multiple period-separated values. +For example: +``` +node: + https: + ipAddresses: 0.0.0.0 + port: 7556 + //pfx (string), keys, certificates, certificateAuthorities, and certificateRevocationLists are all valid here. + keys: "../defaults/serverConfig/server.key" + certificates: "../defaults/serverConfig/server.cert" + +``` +In CLI argument format, this is specified as +``` +node.https.ipAddresses=0.0.0.0 +node.https.port=8554 +node.https.keys="../defaults/serverConfig/server.key" +node.https.certificates="../defaults/serverConfig/server.cert" +``` + +**NOTE: ZSS does not support CLI arguments** + +**The key name is case-sensitive.** + +**The types of the values are syntax-sensitive.** +* Numbers are treated as numbers, not strings. +* false & true are treated as boolean. +* commas are for arrays. An array of length 1 has a comma at the end +* strings can have quotes, but otherwise everything that isnt an array, boolean, or number is a string +* objects are never values. They are the keys. + + +# Parameter Details +Below is some more detail on certain parameters than can be covered within the json-schema. + +## Configuration Directories +When running, the App Server will access the server's settings and read/modify the contents of its resource storage. +All of this data is stored within a heirarchy of a few folders, which is correspond to scopes: +- Product: The contents of this folder are not meant to be modified, but used as defaults for a product. +- Site: The contents of this folder are intended to be shared across multiple App Server instances, perhaps on a network drive. +- Instance: This folder represents the broadest scope of data within the given App Server instance. +- Group: Multiple users can be associated into one group, so that settings are shared among them. +- User: When authenticated, users have their own settings and storage for the Apps that they use. + +These directories dictate where the [Configuration Dataservice](https://github.com/zowe/zlux/wiki/Configuration-Dataservice) will store content. + +### Directories example +``` + "productDir":"../defaults", + "siteDir":"/home/myuser/.zowe/workspace/app-server/site", + "instanceDir":"/home/myuser/.zowe/workspace/app-server", + "groupsDir":"/home/myuser/.zowe/workspace/app-server/groups", + "usersDir":"/home/myuser/.zowe/workspace/app-server/users", + +``` + + +## App configuration +This section does not cover any dynamic runtime inclusion of Apps, but rather Apps defined in advance. +In the configuration file, a directory can be specified which contains JSON files which tell the server what App is to be included and where to find it on disk. The backend of these Apps use the Server's Plugin structure, so much of the server-side references to Apps use the term Plugin. + +To include Apps, be sure to define the location of the Plugins directory in the configuration file, via the top-level attribute *pluginsDir* + +**NOTE: In this example, the directory for these JSON files is [/defaults/plugins](https://github.com/zowe/zlux-app-server/tree/v2.x/master/defaults/plugins). Yet, in order to separate configuration files from runtime files, the App Server will initialize by copying the contents of this folder into the defined instance directory, of which the default is ~/.zowe/workspace/app-server. So, the example configuration file uses the latter directory.** + +### Plugins directory example +``` +// All paths relative to zlux-app-server/lib +// In real installations, these values will be configured during the install. +//... + "pluginsDir":"../defaults/plugins", +``` + +## Logging configuration + +For more information, see [Logging Utility](mvd-logutility.md). + +## ZSS Configuration +When running ZSS, it will require a configuration file similar or the same as the one used for the App Server. The attributes that are needed for ZSS, at minimum, are: *productDir*, *siteDir*, *instanceDir*, *groupsDir*, *usersDir*, *pluginsDir* and **agent**. All of these attributes have the same meaning as described above for the App server, but if the App server and ZSS are not run from the same location, then these directories may be different if desired. + +### ZSS Networking + +The attributes that control ZSS exclusively are within the **agent** object. ZSS uses HTTPS by default, but for those who wish to use AT-TLS instead of the built-in HTTPS support, ZSS can use HTTP as well. HTTP should never be used without [AT-TLS](../../user-guide/mvd-configuration#defining-the-at-tls-rule), as this is a security risk. The values `agent.https.port`, `agent.http.port` tell ZSS which ports to bind to, but also where the app-server can find ZSS. The values `agent.host` is used to tell app-server where to find ZSS as well, though `agent.https.ipAddresses` and `agent.http.ipAddresses` tell ZSS which addresses to bind to. For addresses, at this time only the first value of that array is used, and it may either be a hostname or an ipv4 address. + +Example of the agent body: +``` + agent: + host: localhost + https: + ipAddresses: 0.0.0.0 + port: 7557 + +``` diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-swagger.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-swagger.md new file mode 100644 index 0000000000..8a03049b8a --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-swagger.md @@ -0,0 +1,33 @@ +# Documenting your dataservices +Each REST dataservice in your application can and should be documented in OpenAPI spec, previously known as swagger. + +The Zowe Application Server can host swagger files per-dataservice such that users can view this documentation at runtime. + +To utilize this feature, note the following: + +​1. Each dataservice to be documented with swagger must have an individual `.yaml` or `.json` file with the same name as the dataservice, and optionally with the version number to distinguish between revisions of the dataservice. + +​2. In the case that a version number is supplied, the format is `name_version`. For example, to document a service named `users`, with version 1.1.0, a valid filename would be `users_1.1.0.yaml`. + +​3. The file contents must be valid [OpenAPI 2.0](https://swagger.io/specification/v2/) which defines that dataservice. Zowe validates the file at runtime. + +4. Place the swagger file within the `/doc/swagger` of your application directory. + +​5. In the event that multiple files are found that match a given dataservice, the server loads one of the swagger files by this order of preference: +* JSON with version +* JSON without version +* YAML with version +* YAML without version + + +6. At runtime, the server substitutes swagger fields that are known dynamically, such as the hostname and whether the endpoint is accessible via HTTP versus HTTPS. + +7. At runtime, the server aggregates together all the dataservices of a plugin such that the swagger documentation can be viewed either per-dataservice or per-plugin. + +8. At runtime, the swagger documentation is accessible in a read-only JSON format via two ways: + +- Per dataservice at `/ZLUX/plugins/pluginname/catalogs/swagger/servicename` + +- Per plugin at `/ZLUX/plugins/pluginname/catalogs/swagger` + +9. If any services are not documented, including non-REST services such as websocket services, viewing the per-plugin swagger output will show a stub for that dataservice, alerting users that it exists but without in-depth detail about its capabilities. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-uribroker.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-uribroker.md new file mode 100644 index 0000000000..664295b59f --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-uribroker.md @@ -0,0 +1,102 @@ +# URI Broker + +The URI Broker is an object in the application plug-in web framework, which facilitates calls to the Zowe™ Application Server by constructing URIs that use the context from the calling application plug-in. + +1. [Accessing the URI Broker](#accessing-the-uri-broker) + 1. [Natively](#natively) + 1. [In an iframe](#in-an-iframe) +1. [Functions](#functions) + 1. [Accessing an application plug-in's dataservices](#accessing-an-application-plug-ins-dataservices) + 1. [HTTP dataservice URI](#http-dataservice-uri) + 1. [Websocket dataservice URI](#websocket-dataservice-uri) + 1. [Accessing the application plug-in's configuration resources](#accessing-application-plug-ins-configuration-resources) + 1. [Standard configuration access](#standard-configuration-access) + 1. [Scoped configuration access](#scoped-configuration-access) + 1. [Accessing static content](#accessing-static-content) + 1. [Accessing the application plug-in's root](#accessing-the-application-plug-ins-root) + 1. [Server queries](#server-queries) + 1. [Accessing list of plugins](#accessing-list-of-plugins) + +## Accessing the URI Broker + +The URI Broker is accessible independent of other frameworks involved such as Angular, and is also accessible through iframe. This is because it is attached to a global when within the Zowe Desktop. For more information, see [Zowe Desktop and window management](mvd-desktopandwindowmgt.md). +Access the URI Broker through one of two locations: + +### Natively: + +`window.ZoweZLUX.uriBroker` + +### In an iframe: + +`window.parent.ZoweZLUX.uriBroker` + + +## Functions + +The URI Broker builds the following categories of URIs depending upon what the application plug-in is designed to call. + +### Accessing an application plug-in's dataservices + +Dataservices can be based on HTTP (REST) or Websocket. For more information, see [Dataservices](mvd-dataservices.md). + +#### HTTP Dataservice URI + + `pluginRESTUri(plugin:ZLUX.Plugin, serviceName: string, relativePath:string): string` + +Returns: A URI for making an HTTP service request. + + +#### Websocket Dataservice URI + +`pluginWSUri(plugin: ZLUX.Plugin, serviceName:string, relativePath:string): string` + +Returns: A URI for making a Websocket connection to the service. + + +### Accessing application plug-in's configuration resources + +Defaults and user storage might exist for an application plug-in such that they can be retrieved through the Configuration Dataservice. + +There are different scopes and actions to take with this service, and therefore there are a few URIs that can be built: + +#### Standard configuration access + +`pluginConfigUri(pluginDefinition: ZLUX.Plugin, resourcePath:string, resourceName?:string): string` + +Returns: A URI for accessing the requested resource under the user's storage. + + +#### Scoped configuration access + `pluginConfigForScopeUri(pluginDefinition: ZLUX.Plugin, scope: string, resourcePath:string, resourceName?:string): string` + +Returns: A URI for accessing a specific scope for a given resource. + + +### Accessing static content + +Content under an application plug-in's `web` directory is static content accessible by a browser. +This can be accessed through: + +`pluginResourceUri(pluginDefinition: ZLUX.Plugin, relativePath: string): string` + +Returns: A URI for getting static content. + +For more information about the `web` directory, see [Application plug-in filesystem structure](mvd-plugindefandstruct#application-plug-in-filesystem-structure). + +### Accessing the application plug-in's root + +Static content and services are accessed off of the root URI of an application plug-in. If there are other points that you must access on that application plug-in, you can get the root: + +`pluginRootUri(pluginDefinition: ZLUX.Plugin): string` + +Returns: A URI to the root of the application plug-in. + +### Server queries + +A client can find different information about a server's configuration or the configuration as seen by the current user by accessing specific APIs. + +#### Accessing a list of plug-ins + +`pluginListUri(pluginType: ZLUX.PluginType): string` + +Returns: A URI, which when accessed returns the list of existing plug-ins on the server by type, such as "Application" or "all". diff --git a/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-zluxdevenv.md b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-zluxdevenv.md new file mode 100644 index 0000000000..4e5d2b1dbb --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-desktop/mvd-zluxdevenv.md @@ -0,0 +1,2 @@ +# Creating an application framework development environment +The app-server and ZSS and Desktop can be installed on a Unix machine for development. The instructions to do so can be found on the [zlux github repository readme](https://github.com/zowe/zlux-app-server/) diff --git a/versioned_docs/version-v2.15.x/extend/extend-sdks.md b/versioned_docs/version-v2.15.x/extend/extend-sdks.md new file mode 100644 index 0000000000..686f7a15b3 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-sdks.md @@ -0,0 +1,9 @@ +# Developing for Zowe SDKs + +The Zowe SDKs are open source. You can contribute to add features, enhancements, and bug fixes to the source code. + +The functionality is currently limited to the interfaces provided by IBM z/OSMF. As a plug-in developer, you can enhance the SDK by creating a packages that exposes programmatic APIs for your service. + +For detailed contribution guidelines, see the following documents: +- [Node.js SDK guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/SDKGuidelines.md) +- **Coming soon! Python SDK guidelines** diff --git a/versioned_docs/version-v2.15.x/extend/extend-ze/ze-extensions.md b/versioned_docs/version-v2.15.x/extend/extend-ze/ze-extensions.md new file mode 100644 index 0000000000..c76d916e09 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-ze/ze-extensions.md @@ -0,0 +1,3 @@ +# Extending Zowe Explorer + +You can extend the possibilities of Zowe Explorer by creating you own extensions. For more information on how to create your own Zowe Explorer extension, see [Extensions for Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode/wiki/Extending-Zowe-Explorer). diff --git a/versioned_docs/version-v2.15.x/extend/extend-zowe-overview.md b/versioned_docs/version-v2.15.x/extend/extend-zowe-overview.md new file mode 100644 index 0000000000..db53b1d727 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/extend-zowe-overview.md @@ -0,0 +1,74 @@ +# Extending Zowe + +Zowe is designed as an extensible tools platform. One of the Zowe architecture goals is to provide consistent interoperability between all Zowe components including extensions. The Zowe Conformance Program defines the criteria to help accomplish the aforementioned goal. By satisfying the Zowe Conformance Program criteria, extension providers are assured that their software remains functional throughout the Zowe release cycle. For more information, see the [Zowe Conformance Program](zowe-conformance-program.md). + +Zowe can be extended in the following ways: + +**[Extending the server side](#extending-the-server-side)** + +- [Extend Zowe API Mediation Layer](#extend-zowe-api-mediation-layer) +- [Developing for Zowe Application Framework](#developing-for-zowe-application-framework) + +**[Extending the client side](#extending-the-client-side)** + +- [Extend Zowe CLI](#extend-zowe-cli) +- [Extend Zowe Explorer](#extend-zowe-explorer) +- [Add a plug-in to the Zowe Desktop](#add-a-plug-in-to-the-zowe-desktop) + +To assist with extension development, see the following [Sample extensions](#sample-extensions): + +- [Sample Zowe API and API Catalog extension](#sample-zowe-api-and-api-catalog-extension) +- [Sample Zowe Desktop extension](#sample-zowe-desktop-extension) + +## Extending the server side + +### Extending Zowe API Mediation Layer + +The API Mediation Layer extension primarily focuses on extending via onboarding services running as standalone services. These services are subsequently available in the API Catalog and can be accessed through the API Gateway. For more information about onboarding a service to the API Mediation Layer, see the [Onboarding Overview](./extend-apiml/onboard-overview.md). The API Mediation Layer squad also provides libraries to simplify the integration for multiple programming languages and different frameworks. + +### Developing for Zowe Application Framework + +You can create application plug-ins to extend the capabilities of the Zowe™ Application Framework. An application plug-in is an installable set of files that present resources in a web-based user interface, as a set of RESTful services, or in a web-based user interface and as a set of RESTful services. + +For more information about developing for Zowe Application Framework, see [Zowe Application Framework overview](./extend-desktop/mvd-extendingzlux.md). + +## Extending the client side + +### Extend Zowe CLI + +Zowe CLI extenders can build plug-ins that provide new commands. Zowe CLI is built using Node.js and is typically run on a machine other than z/OS, such as a PC, where the CLI can be driven through a terminal or command prompt, or on an automation machine such as a DevOps pipeline orchestrator. + +For more information about extending the Zowe CLI, see [Developing a new plug-in](extend-cli/cli-developing-a-plugin.md). This article includes a sample plug-in that is provided with the tutorial; see [Installing the sample plug-in](extend-cli/cli-installing-sample-plugin.md). + +### Extend Zowe Explorer + +Zowe Explorer provides extension APIs that assist third party extenders to create extensions that access Zowe Explorer resource entities to enrich the user experience. There are many ways Zowe Explorer can be extended to support many different use cases. + +For the kinds of extensions that are supported and how to get started with extending Zowe Explorer, see [Extensions for Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode/wiki/Extending-Zowe-Explorer). + +### Add a plug-in to the Zowe Desktop + +The Zowe Desktop allows a user to interact with z/OS applications through a web browser. The Desktop is served by the Zowe Application Framework Server on z/OS, also known as Z Lightweight User Experience (ZLUX). The Zowe desktop comes with a set of default applications. You can extend it to add new applications. For more information, see [Developing for Zowe Application Framework](extend-desktop/mvd-extendingzlux.md). + +The Zowe Desktop is an angular application that allows native plug-ins to be built that provide for a high level of interoperability with other desktop components. The React JavaScript toolkit is also supported. Additionally, you can include an existing web application in the Zowe Desktop using an iframe. + +**Notes:** For more information, see the following samples: + +- [Sample iframe App](extend-desktop/mvd-extendingzlux.md#sample-iframe-app). +- [Sample Angular App](extend-desktop/mvd-extendingzlux.md#sample-angular-app). +- [Sample React App](extend-desktop/mvd-extendingzlux.md#sample-react-app). + +## Sample extensions + +To help Zowe extenders better understand how extensions are developed and deployed, +we provide a set of sample. These sample extensions contain the necessary boilerplate project setup, application code, and installation scripts to jumpstart the extension development and deployment to Zowe. + +**Note:** For more information on the architecture of Zowe, see [Zowe Architecture](../getting-started/zowe-architecture.md). + +### Sample Zowe API and API Catalog onboarded service + +The service [Discoverable Client](https://github.com/zowe/api-layer/tree/v3.x.x/discoverable-client) within API Mediation Layer repository contains a sample Zowe onboarded service with a Spring Boot server providing sample Helo world APIs. For more information, see [discoverable-client](https://github.com/zowe/api-layer/blob/v3.x.x/discoverable-client/README.md). + +### Sample Zowe Desktop extension + +The repository [https://github.com/zowe/sample-trial-app](https://github.com/zowe/sample-trial-app) contains a sample Zowe extension with a node server providing a web page that gives a user interface to the APIs included with the API sample above. diff --git a/versioned_docs/version-v2.15.x/extend/k8s-conformance.md b/versioned_docs/version-v2.15.x/extend/k8s-conformance.md new file mode 100644 index 0000000000..90b09da96a --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/k8s-conformance.md @@ -0,0 +1,249 @@ +# Zowe Containerization Conformance Criteria + +These conformance criteria are applicable for all Zowe components intending to run in a containerized environment. The containerized environment could be Kubernetes or OpenShift running on Linux or Linux on Z. + +## Image + +In general, the image should follow [Best practices for writing Dockerfiles](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/). The below requirements are in addition to the list. + +### Base Image + +You are free to choose a base image based on your requirements. + +Here are our recommendations of base images: + +- Zowe base images: + * `ompzowe/base`: `zowe-docker-release.jfrog.io/ompzowe/base:latest-ubuntu` and `zowe-docker-release.jfrog.io/ompzowe/base:latest-ubi`. + * `ompzowe/base-node`: `zowe-docker-release.jfrog.io/ompzowe/base-node:latest-ubuntu` and `zowe-docker-release.jfrog.io/ompzowe/base-node:latest-ubi` has node.js LTS (v14) version pre-installed. + * `ompzowe/base-jdk`: `zowe-docker-release.jfrog.io/ompzowe/base-jdk:latest-ubuntu` and `zowe-docker-release.jfrog.io/ompzowe/base-jdk:latest-ubi` has JRE v8 pre-installed. +- [Red Hat Universal Base Image 8 Minimal](https://developers.redhat.com/articles/ubi-faq?redirect_fragment=resources#ubi_details) +- [Ubuntu](https://hub.docker.com/_/ubuntu) + +The image should contain as few software packages as possible for security and should be as small as possible such as by reducing package count and layers. + +Zowe base images, +- are based on both Ubuntu and Red Hat Universal Base Image, +- provide common dependencies including JDK and/or node.js, +- support both `amd64` and `s390x` CPU architecture. + +If you use your own base image other than Zowe base images, please check this list and make sure it is compatible with Zowe runtime: + +- The default shell `/bin/sh` must be `bash`. If it's not, you can fix it by installing and overwriting `/bin/sh` with the symbolic link of `/bin/bash`. +- These softwares must exist in the image: `date`, `awk`, `sed`, `xargs`. +- These softwares are optional but good to have: `ping`, `dig`, `netstat`. + +### Multi-CPU Architecture + +- Zowe core components must release images based on both `amd64` and `s390x` CPU architecture. +- Zowe core component images must use multiple manifests to define if the image supports multiple CPU architectures. + +### Image Label + +These descriptive labels are required in the Dockerfile: `name`, `maintainer`, `vendor`, `version`, `release`, `summary`, and `description`. + +Example line: + +``` +### Required Labels +LABEL name="APPLICATION NAME" \ + maintainer="EMAIL@ADDRESS" \ + vendor="COMPANY NAME" \ + version="VERSION NUMBER" \ + release="RELEASE NUMBER" \ + summary="APPLICATION SUMMARY" \ + description="APPLICATION DESCRIPTION" \ +``` + +### Tag + +Zowe core component image tags must be a combination of the following information in this format: `-[-][-sources][.]`. + +- **version**: must follow [semantic versioning](https://semver.org/) or partial semantic versioning with major or major + minor. It may also be `latest` or `lts`. For example, `1`, `1.23`, `1.23.0`, `lts`, `latest`, etc. +- **linux-distro**: for example, `ubi`, `ubuntu`, etc. +- **cpu-arch**: for example, `amd64`, `s390x`, etc. +- **customize-build**: string sanitized by converting non-letters and non-digits to dashes. For example, `pr-1234`, `users-john-fix123`, etc. +- **Source Build**: must be a string `-sources` appended to the end of the tag. + * If this is a source build, the tag must contain full version number (major+minor+patch) information. + * Linux Distro information is recommended. + * Must NOT contain customize build information. + * For example: `1.23.0-ubi-sources`. + +For example, these are valid image tags: + +- latest +- latest-ubuntu +- latest-ubuntu-sources +- latest-ubi +- latest-ubi-sources +- lts +- lts-ubuntu +- lts-ubi +- 1 +- 1-ubuntu +- 1-ubi +- 1.23 +- 1.23-ubuntu +- 1.23-ubi +- 1.23.0 +- 1.23.0-ubuntu +- 1.23.0-ubuntu-amd64 +- 1.23.0-ubuntu-sources +- 1.23.0-ubi +- 1.23.0-ubi-s390x +- 1.23.0-ubi-sources +- 1.23.0-ubuntu.pr-1234 +- 1.23.0-ubi.users-john-test1 + +The same image tag pattern is recommended for Zowe extensions. +### Files and Directories + +These file(s) and folder(s) are **REQUIRED** for all Zowe components: + +``` +├── licenses/ +└── component/ + ├── manifest.yaml, manifest.yml or manifest.json + ├── README.md +``` + +- `/licenses` folder holds all license-related files. It MUST include at least the license information for current application. It's recommended to include a license notice file for all pedigree dependencies. All licenses files must be in UTF-8 encoding. +- `/component/README.md` provides information about the application for end-user. +- `/component/manifest.(yaml|yml|json)` provides basic information of the component. The format of this file is defined at [Zowe component manifest](https://docs.zowe.org/stable/extend/packaging-zos-extensions/#zowe-component-manifest). Components must use the same manifest file as when it's running on z/OS. + +These file(s) and folder(s) are _recommended_: + +``` +└── component/ + ├── bin/ + │ ├── + ├── +``` + +- `/component/bin/` must remain the same as what it is when running on z/OS. + +### User `zowe` + +In the Dockerfile, a `zowe` user and group must be created. The `zowe` user `UID` and group `GID` must be defined as `ARG` and with default values of `UID=20000` and `GID=20000`. Example commands: + +``` +ARG UID=20000 +ARG GID=20000 +RUN groupadd -g $GID -r zowe && useradd --no-log-init -u $UID -d /home/zowe -r -g zowe zowe +``` + +`USER zowe` must be specified before the first `CMD` or `ENTRYPOINT`. + +If you use Zowe base images, `zowe` user and group are already created. + +### Multi-Stage Build + +A multi-stage build is recommended to keep images small and concise. Learn more from [Use multi-stage builds](https://docs.docker.com/develop/develop-images/multistage-build/). + +## Runtime + +This section is mainly for information. No actions are required for components except where it's specified explicitly. + +The below sections are mainly targeting Kubernetes or OpenShift environments. Starting Zowe containers in a Docker environment with `docker-compose` is in a planning stage and may change some of the requirements. + +### General rules + +**Components MUST:** + +- NOT be started as root user in the container. +- listen to only ONE port in the container except for API Mediation Layer Gateway. +- be cloud-vendor neutral and must NOT rely on features provided by a specific cloud vendor. +- NOT rely on host information such as `hostIP`, `hostPort`, `hostPath`, `hostNetwork`, `hostPID` and `hostIPC`. +- accept `zowe.yaml` as a configuration file, the same as when running on z/OS. + +### Persistent Volume(s) + +- This persistent volume MUST be created: + * `zowe-workspace` mounted to `/home/zowe/instance/workspace`. + +### Files and Directories + +In the runtime, the Zowe content is organized in this structure: + +``` +└── home/ + └── zowe/ + ├── runtime/ + │ ├── bin/ + │ ├── components/ + │ │ ├── / + ├── instance/ + │ ├── logs/ + │ ├── workspace/ + │ ├── zowe.yaml + ├── keystore/ +``` + +- `/home/zowe/runtime` is a shared volume initialized by the `zowe-launch-scripts` container. +- `/home/zowe/runtime/components/` is a symbolic link to the `/component` directory. `` is the `name` entry defined in `/component/manifest.(yaml|yml|json)`. +- `/home/zowe/instance/zowe.yaml` is a Zowe configuration file and MUST be mounted from a ConfigMap. +- `/home/zowe/instance/logs` is the logs directory of Zowe instance. This folder will be created automatically by `zowe-launch-scripts` container. +- `/home/zowe/instance/workspace` is the persistent volume mounted to every Zowe component container. + * Components writing to this directory should be aware of the potential conflicts of same-time writing by multiple instances of the same component. + * Components writing to this directory must NOT write container-specific information to this directory as it may potentially be overwritten by another container. +- `/home/zowe/keystore` is the directory where certificate is mounted. With a typical setup (by using `zwe migrate for kubernetes` command), this folder contains `keystore.p12`, `truststore.p12`, `keystore.key`, `keystore.cer` and `ca.cer`. +- Any confidential environment variables, for example, a Redis password, in `zowe.yaml` must be extracted and stored as Secrets. These configurations must be imported back as environment variables. + +### ConfigMap and Secrets + +- `zowe.yaml` must be stored in a ConfigMap and be mounted under `/home/zowe/instance` directory. +- All certificates must be stored in Secrets. Those files will be mounted under the `/home/zowe/keystore` directory. +- Secrets must be defined manually by a system administrator. Zowe Helm Chart and Zowe Operator do NOT define the content of Secrets. + +### `ompzowe/zowe-launch-scripts` Image and initContainers + +- The `zowe-docker-release.jfrog.io/ompzowe/zowe-launch-scripts:latest-ubuntu` or `zowe-docker-release.jfrog.io/ompzowe/zowe-launch-scripts:latest-ubi` image contains necessary scripts to start Zowe components in Zowe context. +- This image has a `/component` directory and it will be used to prepare `/home/zowe/runtime` and `/home/zowe/instance` volumes to help Zowe component start. +- In Kubernetes and OpenShift environments this step is defined with [`initContainers` specification](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/). + +### Command Override + +- Component `CMD` and `ENTRYPOINT` directives will be overwritten with the Zowe launch script used to start it in Zowe context. +- Components running in Zowe context requires to be started with `bash` with argument `/home/zowe/runtime/bin/internal/run-zowe.sh -c /home/zowe/instance`. Here is example start command: + ```yaml + command: ["/bin/bash", "-c"] + args: + - "/home/zowe/runtime/bin/zwe internal start -c /home/zowe/instance/zowe.yaml" + ``` + +### Environment Variables + +These runtime environment variable(s) are **REQUIRED** to start Zowe components. + +- `ZWE_POD_NAMESPACE`: holds the current Kubernetes namespace. This variable can be _optional_ if the service account `automountServiceAccountToken` attribute is `true`. The value of this variable can be assigned to `metadata.namespace` (which default value is `zowe`) in `Pod` `spec` section: + + ```yaml + env: + - name: ZWE_POD_NAMESPACE + valueFrom: + fieldRef: + apiVersion: v1 + fieldPath: metadata.namespace + ``` + +These runtime environment variable(s) are **OPTIONAL** to start Zowe components. + +- `ZWE_POD_CLUSTERNAME`: holds the Kubernetes cluster name. This variable has default value `cluster.local`. If your cluster name is not default value, you should pass the variable to all workloads. The value of this variable can be assigned in `Pod` `spec` section: + + ```yaml + env: + - name: ZWE_POD_CLUSTERNAME + value: "my.cluster.name" + ``` + +## CI/CD + +### Build, Test and Release + +- Zowe core component and extension images MUST be built, tested, and released on their own cadence. +- The component CI/CD pipeline MUST NOT rely on the Zowe level CI/CD pipeline and Zowe release schedule. +- Zowe core component images must be tested. This includes starting the component and verifying the runtime container works as expected. +- It is recommended to build snapshot images before release. Zowe core components MUST publish snapshot images to the `zowe-docker-snapshot.jfrog.io` registry with proper [tags](#tag). +- Zowe core component images MUST be released before Zowe is released. +- Zowe core components MUST publish release images to both `zowe-docker-release.jfrog.io` and [Docker Hub](https://hub.docker.com/) registry under `ompzowe/` prefix. +- Release images MUST also update relevant major/minor version tags and the `latest` tag. For example, when a component releases a `1.2.3` image, the component CI/CD pipeline MUST also tag the image as `1.2`, `1`, and `latest`. Update the `lts` tag when it is applicable. +- Zowe core component release images MUST be signed by Zowe committer(s). diff --git a/versioned_docs/version-v2.15.x/extend/k8s-extend.md b/versioned_docs/version-v2.15.x/extend/k8s-extend.md new file mode 100644 index 0000000000..d3308fa33a --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/k8s-extend.md @@ -0,0 +1,70 @@ +# Creating and adding Zowe extension containers + +Zowe extensions can be used within a Zowe container environment. To do this, you must deliver the extension as a container image that is compatible with Zowe containers. Zowe server extensions such as services or app framework plugins must be packaged as components to work in the container environment. You can follow Zowe's container conformance criteria to understand and achieve compatibility. + +**Note**: Container code may depend on z/OS code, and it is recommended that components state these dependencies in their [manifest](https://docs.zowe.org/stable/appendix/server-component-manifest). Users should verify these dependencies to ensure a correctly configured Zowe container environment. + +You can add extension containers to a Zowe container environment the same way as Zowe's core components by completing the following steps. + +1. Build and publish an extension image to a registry. For details, see [Build and publish an extension image to a registry](#1-build-and-publish-an-extension-image-to-a-registry). +2. Define a [deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) or [job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) object. For details, see [Define Deployment or Job object](#2-define-deployment-or-job-object). +3. Start the extension from the deployment or job definition. For details, see [Start your component](#3-start-your-component). + +## 1. Build and publish an extension image to a registry + +An extension must have a container image to run in a Zowe container environment. To create such images, you can use a Dockerfile and refer to the following examples of building images for Zowe core components. + +**Examples:** + +The core components define component Dockerfiles and use GitHub Actions to build images. For example, + +- `jobs-api` is a component which has built-in web service. To build the images, this component defines a Dockerfile at https://github.com/zowe/jobs/blob/v2.x/master/container/Dockerfile and defines a GitHub Actions workflow at https://github.com/zowe/jobs/tree/v2.x/master/.github/workflows. +- `explorer-jes` is a Zowe App Server Framework plug-in but does not have a built-in web service. It follows Zowe's [container conformance criteria](https://github.com/zowe/zowe-install-packaging/blob/v2.x/staging/containers/conformance.md). It defines a Dockerfile at https://github.com/zowe/explorer-jes/blob/v2.x/master/container/Dockerfile. Similar to `jobs-api`, it also defines a GitHub Actions workflow at https://github.com/zowe/explorer-jes/blob/v2.x/master/.github/workflows/build_test.yml to build the images. + +The following GitHub Actions are used by the core components to build conformant images. They might not be completely reusable for you, but are provided as an example. + +- [zowe-actions/shared-actions/docker-prepare](https://github.com/zowe-actions/shared-actions/blob/main/docker-prepare/action.yml) will prepare required environment variables used by following steps. +- [zowe-actions/shared-actions/docker-build-local](https://github.com/zowe-actions/shared-actions/blob/main/docker-build-local/action.yml) can build the Docker image directory on the GitHub Actions virtual machine. By default, the Docker image directory is `ubuntu-latest`. You can use this action to build images for `amd64` CPU architecture. +- [zowe-actions/shared-actions/docker-build-zlinux](https://github.com/zowe-actions/shared-actions/blob/main/docker-build-zlinux/action.yml) can build Docker image on a `Linux on Z` virtual machine. This is useful if you want to build images for `s390x` CPU architecture. +- [zowe-actions/shared-actions/docker-manifest](https://github.com/zowe-actions/shared-actions/blob/main/docker-manifest/action.yml) can collect all related images and define them as Docker manifests. This is useful for users to automatically pull the correct image based on cluster node CPU architecture, and also pull images based on popular tags such as `latest` and `latest-ubuntu`. + +After a component image is built, it is recommended that you publish it to a container registry before adding it to the Zowe container environment. Alternatively, you can use `docker save` and `docker load` commands to copy the offline images to your Kubernetes nodes. + +## 2. Define `Deployment` or `Job` object + +To start your component in Kubernetes, you must define a [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) if your extension has built-in web services, or a [Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) object if your extension is a Zowe Application Framework plug-in without built-in web services. + +To define `Deployment` for your component, you can copy from `samples/sample-deployment.yaml` and modify all occurrences of the following variables: + +- ``: this is your component name. For example, `sample-node-api`. +- ``: this is your component image described in [Build and publish an extension image to a registry](#build-and-publish-an-extension-image-to-a-registry). For example, `zowe-docker-release.jfrog.io/ompzowe/sample-node-api:latest-ubuntu`. +- ``: this is the port of your service. For example, `8080`. + +Continue to customize the specification to fit in your component requirements: + +- `spec.template.spec.containers[0].resources`: defines the memory and CPU resource required to start the container. +- `metadata.annotations`, `spec.template.spec.volumes` and `spec.template.spec.securityContext` and so on. + +To define `Job` for your component, you can also copy from `samples/sample-deployment.yaml`. Then, modify all entries mentioned above and make the following changes: + +- Change `kind: Deployment` to `kind: Job`, +- Add `restartPolicy: OnFailure` under `spec.template.spec` like this: + + ```yaml + kind: Job + spec: + template: + spec: + restartPolicy: OnFailure + securityContext: + ... + ``` + +## 3. Start your component + +After you define your component `Deployment` or `Job` object, you can run `kubectl apply -f /path/to/your/component.yaml` to apply it to the Kubernetes cluster that runs Zowe. + +- If it's a `Deployment`, you should be able to see that the component pod is started and eventually reached the `Running` status. +- If it's a `Job`, you should be able to see that the plug-in pod is started and eventually reached the `Completed` status. + +Now you can follow common Kubernetes practice to manage your component workload. diff --git a/versioned_docs/version-v2.15.x/extend/lifecycling-with-zwesvstc.md b/versioned_docs/version-v2.15.x/extend/lifecycling-with-zwesvstc.md new file mode 100644 index 0000000000..d6a155f901 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/lifecycling-with-zwesvstc.md @@ -0,0 +1,61 @@ +# Zowe server component runtime lifecycle + +## Zowe runtime lifecycle + +This topic describes the runtime lifecycle of Zowe core components and how an offering that provides a Zowe extension can set up runtime lifecycle for their component. + +The Zowe UNIX System Services (USS) components are run as part of the started task `ZWESLSTC`. There are two key USS directories that play different roles when launching Zowe. + +- The Zowe runtime directory `` that contains the executable files is an immutable set of directories and files that are replaced each time a new release is applied. The initial release or an upgrade is installed either with UNIX shell scripts (see [Installing Zowe runtime from a convenience build](../user-guide/install-zowe-zos-convenience-build.md)), or SMP/E where the runtime directory is laid down initially as FMID AZWE002 and then upgraded through rollup PTF builds (see [Installing Zowe SMP/E](../user-guide/install-zowe-smpe.md)). The Zowe runtime directory is not altered during operation of Zowe, so no data is written to it and no customization is performed on its contents. **Important**, any customizations to the original Zowe runtime directory are not recommended. This may include installing extensions to this directory, putting your `zowe.yaml` or Zowe workspace into this directory, or changing any of the files in it, etc. + +- The Zowe workspace directory `` contains information that is specific to a launch of Zowe. It contains temporary configuration settings that helps an instance of the Zowe server to be started, such as ports that are used or paths to dependent Java and Node.js runtimes. Zowe runtime user should have write permission to this directory. More than one Zowe workspace directories can be created to allow multiple launches of a Zowe runtime, each one isolated from each other and starting Zowe depending on how Zowe YAML configuration is configured. + +- The Zowe logs directory `` contains USS file logs when running Zowe. Some components like app-server and zss will always write USS log files. Some components like APIML Gateway will write log files to this directory if you enabled debug mode. Zowe runtime user should have write permission to this directory. + +To start Zowe, the command `zwe start` is run from a USS shell. This uses a program `ZWELNCH` to launch the started task `ZWESLSTC`, passing an optional `HAINST` parameter to define which Zowe HA instance will be started. It is the equivalent of using the TSO command `/S ZWESLSTC,HAINST='',JOBNAME=''`. The `ZWELNCH` program understands your Zowe YAML configuration and will start components enabled in the `` by executing `zwe internal start component` command. If you execute `zwe internal start` directly, the USS processes will not run as a started task and will run under the user ID of whoever ran the `zwe internal start` command rather than the Zowe user ID of `ZWESVUSR`, likely leading to permission errors accessing the contents of the `` as well as the Zowe certificate. For these reasons, the `zwe start` script launches Zowe's USS process beneath the started task `ZWESLSTC`. + +Zowe relies on `zowe.yaml` configuration file to know your customization for the instance. For more information, see [Zowe YAML Configuration File Reference](../appendix/zowe-yaml-configuration.md). + +**Note:** + +The scripts of core Zowe components and some extensions use the helper library `/bin/libs`. You can also use those functions but please keep away from functions marked as `internal` or `experimental`. + +## Zowe component runtime lifecycle + +Each Zowe component will be installed with its own USS directory, which contains its executable files. Within each component's USS directory, a manifest file is required to describe itself and a `bin` directory is recommended to contain scripts that are used for the lifecycle of the component. When Zowe is started, by reading components manifest `commands` definition, it identifies the components that are configured to launch and then execute the scripts of those components in the cycle of [validate](#validate), [configure](#configure), and [start](#start). All components are validated, then all are configured, and finally all are started. This technique is used as follows: +- Used for the base Zowe components that are included with the core Zowe runtime. +- Applies to extensions to allow vendor offerings to be able to have the lifecycle of their 'microservices' within the Zowe USS shell and be included as address spaces under the `ZWESLSTC` started task. + +**Note:** + +All lifecycle scripts are executed from the root directory of the component. This directory is usually where the component manifest is located. + +Check [Server Component Manifest File Reference](../appendix/server-component-manifest.md) to learn how to define lifecycle `commands` in component manifest file. + +### Validate + +Each component can optionally instruct Zowe runtime to validate itself with a USS command defined in manifest `commands.validate`. + +If present, the `validate` script performs tasks such as: +- Check that the shell has the correct prerequisites. +- Validate that ports are available. +- Perform other steps to ensure that the component is able to be launched successfully. + +During execution of the `validate` script, if an error is detected, then a component should echo a message that contains information to assist a user diagnosing the problem. + +### Configure + +Each component can optionally instruct Zowe runtime to configure itself with a USS command defined in manifest `commands.configure`. + +If the component has manifest defined, some configure actions will be performed automatically based on manifest definition: + +- `apimlServices.static`: Zowe runtime will automatically parse and add your static definition to API Mediation Layer. +- `appfwPlugins.[].path`: Zowe runtime will automatically parse and install/configure the component to Zowe App Framework. + +It's possible to export configuration variables from the `configure` step to the `start` step. Each component runs in separated shell space, which means that the variable of one component does not affect the same variable of another component. For example, when you run `export MY_VAR=val` in `/bin/configure.sh`, then the variable `${MY_VAR}` will be available in your `/bin/start.sh` script. However, `${MY_VAR}` will not be available in other components. + +### Start + +Each component can optionally instruct Zowe runtime to start itself with a USS command defined in manifest `commands.start`. If this is not defined, for backward compatible purpose, a call to its `/bin/start.sh` script will be executed if it exists. If your component is not supposed to be started by itself, for example, the component is a shared library, you can skip this instruction. + +It is up to each component to start itself based on how it has been written. We recommend that any variables that someone who configure Zowe may need to vary, such as timeout values, port numbers, or similar, are specified as variables in the `instance.env` file and then referenced as shell variables in the `start.sh` script to be passed into the component runtime. diff --git a/versioned_docs/version-v2.15.x/extend/migrate-extensions.md b/versioned_docs/version-v2.15.x/extend/migrate-extensions.md new file mode 100644 index 0000000000..65c71d362c --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/migrate-extensions.md @@ -0,0 +1,125 @@ +# Migrating Zowe server component from V1 to V2 + +This doc guides you through migrating an existing Zowe server component from version 1 to version 2. + +To make Zowe server component compatible with Zowe version 2, you must update the following configurations. + +- [Component manifest](#component-manifest) +- [Lifecycle scripts](#lifecycle-scripts) +- [Environment variables](#environment-variables) +- [Packaging one component deliverable for both Zowe v1 and v2](#packaging-one-component-deliverable-for-both-zowe-v1-and-v2) + +## Component manifest + +In Zowe v2, the component must define a manifest file and package it into the extension's root directory. This manifest file is used by Zowe to understand how this component should be installed, configured, and started. For detailed information of this file, see [Server Component Manifest File Reference](../appendix/server-component-manifest.md). + +## Lifecycle scripts + +In Zowe v2, lifecycle scripts can be located anywhere in your component directory. However, you must explicitly define them in the `commands` section of the component manifest file. + +## Environment variables + +Zowe v1 and v2 environment variables are not exact match. There are the following differences: + +- Some variables in Zowe v1 are removed in v2. +- Some are separated into two or more variables. +- Zowe v2 defines more configuration options than v1. + +Review the following table for a detailed mapping of Zowe v1 and v2 variables. + +| Zowe v1 Variable | Zowe v2 YAML Configuration | Zowe v2 Variable | Notes | +| --- | --- | --- | --- | +| `APIML_ALLOW_ENCODED_SLASHES` | `components.gateway.apiml.service.allowEncodedSlashes` | `ZWE_components_gateway_apiml_service_allowEncodedSlashes` | | +| `APIML_CORS_ENABLED` | `components.gateway.apiml.service.corsEnabled` | `ZWE_components_gateway_apiml_service_corsEnabled` | | +| `APIML_DEBUG_MODE_ENABLED` | `components.gateway.debug`, etc | `ZWE_components_gateway_debug`, etc | In v2, you can enable debug mode for APIML components separately. The `gateway` placeholder can be `discovery`, `api-catalog`, or `metrics-service`, and so on. | +| `APIML_ENABLE_SSO` | Removed in v2 | Removed in v2 | | +| `APIML_GATEWAY_EXTERNAL_MAPPER` | `components.gateway.apiml.security.x509.externalMapperUrl` | `ZWE_components_gateway_apiml_security_x509_externalMapperUrl` | | +| `APIML_GATEWAY_INTERNAL_HOST` | Not configurable in v2 | Not configurable in v2 | | +| `APIML_GATEWAY_INTERNAL_PORT` | `components.gateway.server.internal.port` | `ZWE_components_gateway_server_internal_port` | | +| `APIML_GATEWAY_TIMEOUT_MILLIS` | `components.gateway.apiml.gateway.timeoutMillis` | `ZWE_components_gateway_apiml_gateway_timeoutMillis` | | +| `APIML_MAX_CONNECTIONS_PER_ROUTE` | `components.gateway.server.maxConnectionsPerRoute` | `ZWE_components_gateway_server_maxConnectionsPerRoute` | | +| `APIML_MAX_TOTAL_CONNECTIONS` | `components.gateway.server.maxTotalConnections` | `ZWE_components_gateway_server_maxTotalConnections` | | +| `APIML_PREFER_IP_ADDRESS` | Removed in v2 | Removed in v2 | | +| `APIML_SECURITY_AUTH_PROVIDER` | `components.gateway.apiml.security.auth.provider` | `ZWE_components_gateway_apiml_security_auth_provider` | | +| `APIML_SECURITY_AUTHORIZATION_ENDPOINT_URL` | `components.gateway.apiml.security.authorization.endpoint.url` | `ZWE_components_gateway_apiml_security_authorization_endpoint_url` | | +| `APIML_SECURITY_X509_ENABLED` | `components.gateway.apiml.security.x509.enabled` | `ZWE_components_gateway_apiml_security_x509_enabled` | | +| `APIML_SECURITY_ZOSMF_APPLID` | `zOSMF.applId` | `ZOSMF_APPLID` | | +| `CATALOG_PORT` | `components.api-catalog.port` | `ZWE_components_api_catalog_port` | | +| `DISCOVERY_PORT` | `components.discovery.port` | `ZWE_components_discovery_port` | | +| `EXTERNAL_CERTIFICATE_AUTHORITIES` | `zowe.certificate.pem.certificateAuthorities` | `ZWE_zowe_certificate_pem_certificateAuthorities` | | +| `EXTERNAL_COMPONENTS` | Removed in v2 | Removed in v2 | Zowe v2 configuration does not distinguish core components and extensions on how to enable them. They use the same `components..enabled` configuration. | +| `FILES_API_PORT` | `components.files-api.port` | `ZWE_components_files_api_port` | | +| `GATEWAY_PORT` | `components.gateway.port` | `ZWE_components_gateway_port` | | +| `INSTANCE_DIR` | Removed in v2 | `ZWE_zowe_workspaceDirectory` or `ZWE_zowe_logDirectory` | The instance directory is split into workspace and logs directory in v2. | +| `JAVA_HOME` | `java.home` | `JAVA_HOME` | | +| `JES_EXPLORER_UI_PORT` | Removed in v2 | Removed in v2 | In v2, explorer-jes reuses the web server provided by App Server. It does not start independent web server. | +| `JOBS_API_PORT` | `components.jobs-api.port` | `ZWE_components_jobs_api_port` | | +| `KEY_ALIAS` | `zowe.certificate.keystore.alias` | `ZWE_zowe_certificate_keystore_alias` | | +| `KEYSTORE_CERTIFICATE_AUTHORITY` | `zowe.certificate.pem.certificateAuthorities` | `ZWE_zowe_certificate_pem_certificateAuthorities` | | +| `KEYSTORE_CERTIFICATE` | `zowe.certificate.pem.certificate` | `ZWE_zowe_certificate_pem_certificate` | | +| `KEYSTORE_DIRECTORY` | `zowe.setup.certificate.pkcs12.directory` | `ZWE_zowe_setup_certificate_pkcs12_directory` | This is a setup variable in v2. It is optional and may not have a value if you manually prepare keystores by yourself. | +| `KEYSTORE_KEY` | `zowe.certificate.pem.key` | `ZWE_zowe_certificate_pem_key` | | +| `KEYSTORE_PASSWORD` | `zowe.certificate.keystore.password` and `zowe.certificate.truststore.password` | `ZWE_zowe_certificate_keystore_password` and `ZWE_zowe_certificate_truststore_password` | | +| `KEYSTORE_TYPE` | `zowe.certificate.keystore.type` and `zowe.certificate.truststore.type` | `ZWE_zowe_certificate_keystore_type` and `ZWE_zowe_certificate_truststore_type` | | +| `KEYSTORE` | `zowe.certificate.keystore.file` | `ZWE_zowe_certificate_keystore_file` | | +| `LAUNCH_COMPONENT_GROUPS` | Removed in v2 | Removed in v2 | Zowe v2 doesn't group several components together. It us suggested that you enable or disable component individually. | +| `MVS_EXPLORER_UI_PORT` | Removed in v2 | Removed in v2 | In v2, explorer-mvs reuses web server provided by App Server. It will not start independent web server. | +| `PKCS11_TOKEN_LABEL` | Removed in v2 | Removed in v2 | | +| `PKCS11_TOKEN_NAME` | Removed in v2 | Removed in v2 | | +| `ROOT_DIR` | `zowe.runtimeDirectory` | `ZWE_zowe_runtimeDirectory` | | +| `SKIP_NODE` | Removed in v2 | Removed in v2 | | +| `STATIC_DEF_CONFIG_DIR` | - | `ZWE_STATIC_DEFINITIONS_DIR` | Value is always `${ZWE_zowe_workspaceDirectory}/api-mediation/api-defs`. | +| `TRUSTSTORE` | `zowe.certificate.truststore.file` | `ZWE_zowe_certificate_truststore_file` | | +| `USS_EXPLORER_UI_PORT` | Removed in v2 | Removed in v2 | In v2, explorer-uss reuses web server provided by App Server. It does not start independent web server. | +| `ZOSMF_HOST` | `zOSMF.host` | `ZOSMF_HOST` | | +| `ZOSMF_PORT` | `zOSMF.port` | `ZOSMF_PORT` | | +| `ZOWE_APIM_NONSTRICT_VERIFY_CERTIFICATES` | `zowe.verifyCertificates` | `ZWE_zowe_verifyCertificates` | `zowe.verifyCertificates` has 3 options: `STRICT`, `NONSTRICT`, and `DISABLED`. | +| `ZOWE_APIM_VERIFY_CERTIFICATES` | `zowe.verifyCertificates` | `ZWE_zowe_verifyCertificates` | `zowe.verifyCertificates` has 3 options: `STRICT`, `NONSTRICT`, and `DISABLED`. | +| `ZOWE_EXPLORER_FRAME_ANCESTORS` | Removed in v2 | Removed in v2 | | +| `ZOWE_EXPLORER_HOST` | `zowe.externalDomains` or `haInstances..hostname` | `ZWE_zowe_externalDomains`, `ZWE_zowe_externalDomains_0`, `ZWE_haInstance_hostname` or `ZWE_haInstances__hostname` | Zowe v2 separates external domain name from internal host name. Choose the appropriate variable by northbound or southbound facing. | +| `ZOWE_INSTANCE` | Removed in v2 | Removed in v2 | Use `ZWE_zowe_job_prefix` or `ZWE_zowe_job_name` instead. | +| `ZOWE_IP_ADDRESS` | Removed in v2 | Removed in v2 | If you don't have a hostname but use IP to access Zowe, you can put IP into `zowe.externalDomains` | +| `ZOWE_PREFIX` | `zowe.job.prefix` | `ZWE_zowe_job_prefix` | The meaning of this variable is changed in v2. In v1, this combines with `ZOWE_INSTANCE` as the job prefix. In v2, `ZOWE_INSTANCE` is removed and this affects only the address space names under Zowe job. V2 variable `ZWE_zowe_job_name` defines the full job name for Zowe. | +| `ZOWE_ZLUX_SECURITY_TYPE` | - | - | (Coming soon) | +| `ZOWE_ZLUX_SERVER_HTTPS_PORT` | - | - | (Coming soon) | +| `ZOWE_ZLUX_SSH_PORT` | - | - | (Coming soon) | +| `ZOWE_ZLUX_TELNET_PORT` | - | - | (Coming soon) | +| `ZOWE_ZSS_SERVER_PORT` | - | - | (Coming soon) | +| `ZOWE_ZSS_SERVER_TLS` | - | - | (Coming soon) | +| `ZOWE_ZSS_XMEM_SERVER_NAME` | - | - | (Coming soon) | +| `ZWE_CACHING_EVICTION_STRATEGY` | `components.caching-service.storage.evictionStrategy` | `ZWE_components_caching_service_storage_evictionStrategy` | | +| `ZWE_CACHING_SERVICE_PERSISTENT` | `components.caching-service.storage.mode` | `ZWE_components_caching_service_storage_mode` | | +| `ZWE_CACHING_SERVICE_PORT` | `components.caching-service.port` | `ZWE_components_caching_service_port` | | +| `ZWE_CACHING_SERVICE_VSAM_DATASET` | `components.caching-service.storage.vsam.name` | `ZWE_components_caching_service_storage_vsam_name` | | +| `ZWE_CACHING_STORAGE_SIZE` | `components.caching-service.storage.size` | `ZWE_components_caching_service_storage_size` | | +| `ZWE_DISCOVERY_SERVICES_LIST` | - | `ZWE_DISCOVERY_SERVICES_LIST` | | +| `ZWE_DISCOVERY_SERVICES_REPLICAS` | `components.discovery.replicas` | `ZWE_components_discovery_replicas` | This is only available for Zowe Kubernetes deployment. | +| `ZWE_EXTENSION_DIR` | `zowe.extensionDirectory` | `ZWE_zowe_extensionDirectory` | | +| `ZWE_EXTERNAL_HOSTS` | `zowe.externalDomains` | `ZWE_zowe_externalDomains` | | +| `ZWE_EXTERNAL_PORT` | `zowe.externalPort` | `ZWE_zowe_externalPort` | | +| `ZWE_LAUNCH_COMPONENTS` | Combined information of `components..enabled` with value of `true` | `ZWE_ENABLED_COMPONENTS` or `ZWE_LAUNCH_COMPONENTS` | Depends on the purpose, in v2, `ZWE_ENABLED_COMPONENTS` are list of components with `enabled` status `true`. `ZWE_LAUNCH_COMPONENTS` in v2 is a subset of `ZWE_ENABLED_COMPONENTS` which components also have `commands.start` lifecycle script. | +| `ZWE_LOG_LEVEL_ZWELS` | `zowe.launchScript.logLevel` | `ZWE_zowe_launchScript_logLevel` | | +| `ZWEAD_EXTERNAL_STATIC_DEF_DIRECTORIES` | Removed in v2 | Removed in v2 | Use `ZWE_STATIC_DEFINITIONS_DIR` instead. | +| `ZWES_ZIS_LOADLIB` | `zowe.setup.dataset.authLoadlib` | `ZWE_zowe_setup_dataset_authLoadlib` | | +| `ZWES_ZIS_PARMLIB_MEMBER` | - | - | | +| `ZWES_ZIS_PARMLIB` | `zowe.setup.dataset.parmlib` | `ZWE_zowe_setup_dataset_parmlib` | | +| `ZWES_ZIS_PLUGINLIB` | `zowe.setup.dataset.authPluginLib` | `ZWE_zowe_setup_dataset_authPluginLib` | | + + +## Packaging one component deliverable for both Zowe v1 and v2 + +It is recommended that you create a dedicated package of extensions for Zowe v2, which is the most straight-forward way to address all of the breaking changes introduced in v2. We understand that this method presents the challenge of maintaining two sets of packages. If you prefer not to maintain two sets of packages, it's still possible to maintain one version of an extension which works for both Zowe v1 and v2. However, the lifecycle code will be complicated and in this case, comprehensive testing should be performed. + +:::caution + +The Zowe v2 App Framework desktop is upgraded from Angular version 6 to angular version 12 for support and security - websites have a "1 version of a library" limitation. This means that plug-ins dependent upon Angular must be coded for either v6 or v12 [not both] thus the single version approach is not applicable. + +::: + +If the lifecycle scripts are the main concern, the following steps outline requirements and recommendations for the single version approach: + +- Packaging `manifest.yaml` is required. This is a hard requirement for Zowe v2. If you define lifecycle scripts with default names, for example, use `bin/start.sh` as `commands.start`, it should work for v1. +- Revisit all environment variables used in the lifecycle scripts and apply fallback variables. For example, if you use `$ROOT_DIR` in Zowe v1, this should be changed to `${ZWE_zowe_runtimeDirectory:-${ROOT_DIR}}` to make it compatible with both versions. Other variables like `$EXPLORER_HOST` should be changed to `${ZWE_haInstance_hostname:-${EXPLORER_HOST}}` or `${ZWE_externalDomains_0:-${EXPLORER_HOST}}` based on purpose. +- In Zowe v2, we recommend you to define extension configurations in the manifest.yaml `configs` section and use `${ZWE_configs_*}` variables to access them. This feature does not exist in Zowe v1. So if you use `${ZWE_configs_*}` variables, it should fall back to the matching environment variable used in v1. +- In Zowe v2, we recommend you to define a `commands.install` lifecycle script to handle extension installation. This lifecycle script will be executed by `zwe components install`. In v1, this also exists if you use the `zowe-install-components.sh` utility to install a Zowe extension. So if you want one extension package to work for both Zowe v1 and v2, this install lifecycle script should also be compatible with both v1 and v2. +- A new v2 variable `${ZWE_VERSION}` may help you determine the Zowe version number. This variable does not exist in Zowe v1. By knowing the Zowe version, the lifecycle scripts can implement logic to source v1 or v2 dedicated scripts to avoid handling fallbacks in the same script. This could help avoid complicated compatibility version checks, and it could be easier in the future if you decide to drop Zowe v1. diff --git a/versioned_docs/version-v2.15.x/extend/packaging-zos-extensions.md b/versioned_docs/version-v2.15.x/extend/packaging-zos-extensions.md new file mode 100644 index 0000000000..b180f78d18 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/packaging-zos-extensions.md @@ -0,0 +1,82 @@ +# Packaging z/OS extensions + +You can extend Zowe in multiple ways. You may extend Zowe with microservices, which may start a new service within Zowe. You can also create Zowe App Framework plug-ins to provide users with a UI. + +Before you start, review the following terms: + +- **component**: + + Component refers to the most generic way to describe a program which can work within Zowe. It can be a microservice, a Zowe App Framework plug-in, or even just a shared program to be used by other Zowe components. This is also the generic word when referring to both Zowe core components and extensions. In most of the cases described in this topic, this terminology does not include programs running on the client side, like Zowe CLI plug-in or Zowe Explorer (VSCode extension). +- **extension** + + Extension is similar to **component** but excludes Zowe core components. It is recommended that you install all Zowe extensions into a shared extension directory. + +## Zowe server component package format + +You can package Zowe components (extensions) into various formats. You can package them as a stand-alone PAX, ZIP, or TAR file. You can also bundle and ship your Zowe extension(s) within another product. + +A typical component package, for example, `jobs-api-package-1.0.4.zip`, consists of the following files and directories: + +``` ++-- manifest.yaml +|-- apiml-static-registration.yaml.template +|-- schema.json +|-- bin/ + |-- configure.sh + |-- jobs-api-server-1.0.4-boot.jar + |-- start.sh + |-- validate.sh +``` + + +- `manifest.yaml` + + Refers to the Zowe component manifest file. You can find detailed definition of manifest in [Server Component Manifest File Reference](../appendix/server-component-manifest.md). + +- `schema.json` + + An example filename of the [json schema](https://json-schema.org/) file specified by the manifest property `schemas.configs` as detailed in [Server Component Manifest File Reference](../appendix/server-component-manifest.md). The file details the parameters that are valid for the component's configuration within Zowe server configuration files. See documentation on [server component schema files](server-schemas.md) for more information. + +- `apiml-static-registration.yaml.template` + + Refers to a supporting file that instructs the Zowe launch script how to register this extension service to the API Mediation Layer Discovery service. In this case, this file is referred in the `manifest.yaml` `apimlServices.static[0].file` field. This file is optional depending on the function of the component and you can change and customize the file name in the manifest file. +- `bin/(configure|start|validate).sh` + + This file contains the Zowe component lifecycle scripts. You may not need these files depending on the function of the component. You can find detailed definition of lifecycle scripts in [Zowe component runtime lifecycle](lifecycling-with-zwesvstc.md#zowe-component-runtime-lifecycle). + +It is also suggested that you put the following files into the package: + +- `README.md` + + This file is a brief introduction to your extension in Markdown format, including how it should be installed, configured, verified, and so on. +- `LICENSE` + + This is the full license text file. + +If you decide to bundle and ship Zowe extensions within another product, you can put the whole directory structure presented previously into your product package as subdirectories. Take the following structure as an example. + +``` ++-- + |-- + |-- zowe-extension-A + |-- manifest.yaml + |-- bin/ + |-- start.sh + |-- zowe-extension-B + |-- manifest.yaml + |-- bin/ + |-- start.sh +``` + +## Zowe component manifest + +Zowe extensions, as well as core components, can use a manifest file to describe itself. Check [Server Component Manifest File Reference](../appendix/server-component-manifest.md) for details. + +## Sample manifests + +For examples of manifests thoughout Zowe GitHub repositories, see the following links: + +- [API Catalog manifest.yaml](https://github.com/zowe/api-layer/blob/v2.x.x/api-catalog-package/src/main/resources/manifest.yaml) +- [Jobs API manifest.yaml](https://github.com/zowe/jobs/blob/v2.x/master/jobs-zowe-server-package/src/main/resources/manifest.yaml) +- [Sample Node API and API Catalog extension manifest.yaml](https://github.com/zowe/sample-node-api/blob/master/manifest.yaml) +- [Sample Zowe App Framework extension manifest.yaml](https://github.com/zowe/sample-trial-app/blob/master/manifest.yaml) diff --git a/versioned_docs/version-v2.15.x/extend/server-schemas.md b/versioned_docs/version-v2.15.x/extend/server-schemas.md new file mode 100644 index 0000000000..eee8d60312 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/server-schemas.md @@ -0,0 +1,78 @@ +# Server component schemas + +Starting with Zowe v2.0, each Component in Zowe must contain a [json schema](https://json-schema.org/) describing the configuration parameters that are valid for its component section in Zowe's server configuration. If a component does not have anything that can be configured, this file can just be boilerplate specifying that it fully inherits generic Component parameters and nothing more. + +The server infrastructure will utilize each components' schema files to validate a Zowe instance configuration every startup, so this requirement is enforced by code. + +## Requirements + +* Server component json schema files must follow the json schema [spec 2019-09](https://json-schema.org/draft/2019-09/schema). +* Each component must state where its base schema file is located by the manifest parameter "schemas.configs" +* The schema file must use and/or extend the Zowe Component base schema by use of the "allOf" attribute. +* The schema must have an `$id` property which is a URI that has a domain related to the entity that developed the Component. +* The file should be tagged on z/OS but elsewhere must at least be encoded as ASCII-subset of UTF-8 + +## Additional information + +* The schema file can reference other schema files within the component if compartmentalization of definitions are desired + + +## Example + +Below is an example manifest and schema for a Component named "component1". The manifest file specifies the location of the schema file, and the schema file specifies the configuration parameters that are valid for this Component. + +### Example manifest + +``` +name: component1 +id: com.abcdef.component1 +title: component1 +description: An example component with a simple configuration. +license: ABCDEF Company License +schemas: + configs: schema.json +``` + + +### Example schema + +Below is an example of the "schema.json" file referenced above. In it, we have 1 special property, "my-custom-prop", which is just a boolean that can be true or false. + +``` +{ + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "https://abcdef.com/schemas/v2/component1", + "allOf": [ + { "$ref": "https://zowe.org/schemas/v2/server-base" }, + { "type": "object", + "properties": { + "components": { + "type": "object", + "additionalProperties": true, + "properties": { + "component1": { + "allOf": [ + { "$ref": "https://zowe.org/schemas/v2/server-base#zoweComponent"}, + { + "type": "object", + "properties": { + "my-custom-prop": { + "type": "boolean", + "default": true, + "description": "This is a property unique to this component, as opposed to the Zowe Component base that this schema extends" + } + } + } + ] + } + } + } + } + } + ] +} +``` + +## Validation + +Zowe server infrastructure will validate that a user's server configuration is correct by checking every schema file found in every component. If invalid, the servers will not start until the configuration is corrected. Developers may wish to confirm their schema and there are several tools available such as Microsoft Visual Studio Code for validating schema syntax is correct and jsonschemavalidator.net for testing a configuration against a schema. diff --git a/versioned_docs/version-v2.15.x/extend/zowe-conformance-program.md b/versioned_docs/version-v2.15.x/extend/zowe-conformance-program.md new file mode 100644 index 0000000000..dde08a2df8 --- /dev/null +++ b/versioned_docs/version-v2.15.x/extend/zowe-conformance-program.md @@ -0,0 +1,22 @@ +# Zowe Conformance Program + +## Introduction + +Administered by the Open Mainframe Project, the Zowe™ Conformance Program aims to give users the confidence that when they use a product, app, or distribution that leverages Zowe, they can expect a high level of common functionality, interoperability, and user experience. + +Conformance provides Independent Software Vendors (ISVs), System Integrators (SIs), and end users greater confidence that their software will behave as expected. Just like Zowe, the Zowe Conformance Program will continue to evolve and is being developed by committers and contributors in the Zowe community. + +As vendors, you are invited to submit conformance testing results for review and approval by the Open Mainframe Project. If your company provides software based on Zowe, you are encouraged to get certified today. + +## How to participate + +To participate in the Zowe Conformance Program, follow the process on the [Zowe Conformance Program website](https://openmainframeproject.org/our-projects/zowe-conformance-program/). You can also find a list of products that have earned Zowe Conformant status. + +To learn the criteria of achieving Zowe conformance for an offering, see [Zowe Conformance Criteria](https://github.com/openmainframeproject/foundation/tree/master/zowe_conformance). + +## How to suggest updates to the Zowe conformance program + +The Zowe conformance criteria is available as a table in [a Markdown file](https://github.com/openmainframeproject/foundation/blob/master/zowe_conformance/test_evaluation_guide_table.md) in the Open Mainframe Project's GitHub repo. If you find a mistake with the Zowe conformance documents, or you are a Zowe squad lead and want to make an amendment to the criteria, you can update that Markdown file. The same information is also held in another document [Zowe Conformance Test Evaluation Guide](https://github.com/openmainframeproject/foundation/blob/master/zowe_conformance/test_evaluation_guide.md) that has history going back to Zowe 2019 conformance and allows easy change history comparison. + +To submit a proposal to update the conformance criteria, fork the OMP's `foundation` repository at [https://github.com/openmainframeproject/foundation](https://github.com/openmainframeproject/foundation) and make a pull request. Flag the Pull Request to the attention of GitHub user ID `@mertic`, and also reach out to the Zowe onboarding squad in the [#zowe-onboarding](https://openmainframeproject.slack.com/archives/CC60ALD61) Slack channel. If you are not already signed up to Zowe Slack community, you can sign up at [https://slack.openmainframeproject.org](https://slack.openmainframeproject.org/) first. + diff --git a/versioned_docs/version-v2.15.x/getting-started/ZE-system-reqs.md b/versioned_docs/version-v2.15.x/getting-started/ZE-system-reqs.md new file mode 100644 index 0000000000..d78c252936 --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/ZE-system-reqs.md @@ -0,0 +1,35 @@ +# Zowe Explorer System Requirements + +Before installing Zowe Explorer, make sure that you meet the following requirements. + +## Client side requirements + +### Operating systems + + +- MacOS 10.15 (Catalina), 11 (Big Sur), 12 (Monterey) +- Unix-like: + - [CentOS](https://www.centos.org/) 8+ + - [RHEL](https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux) 8+ + - [Ubuntu](https://ubuntu.com/) 20.04+ +- Windows 10+ + +### Integrated development environments: + +- [VS Code](https://code.visualstudio.com/) 1.53.2+ +- [Eclipse Che](https://www.eclipse.org/che/) +- [Red Hat CodeReady Workspaces](https://www.redhat.com/en/technologies/jboss-middleware/codeready-workspaces) +- [Theia](https://theia-ide.org/) 1.18+ + + - Zowe Explorer is compatible with Theia 1.18.0 or higher. However, we recommend using a [Theia community release](https://theia-ide.org/releases/) as Zowe Explorer could experience possible unexpected behaviors with the latest Theia releases. + +## Server side requirements + +- IBM z/OSMF is configured and running. + - Minimally, an instance of IBM z/OSMF must be running on the mainframe before you can run Zowe Explorer successfully. + - z/OSMF enables the core capabilities, such as retrieving data sets, executing TSO commands, submitting jobs, and more. + +- Applicable plug-in services are configured and running on the mainframe. + - Plug-ins communicate with various mainframe services. The services must be configured and running on the mainframe before issuing plug-in commands. + * See [Zowe Explorer CICS Extension system requirements](../user-guide/ze-using-zowe-explorer-cics-ext#system-requirements). + * See [Zowe Explorer FTP Extension system requirements](../user-guide/ze-ftp-using-ze-ftp-ext#system-requirements). diff --git a/versioned_docs/version-v2.15.x/getting-started/cli-getting-started.md b/versioned_docs/version-v2.15.x/getting-started/cli-getting-started.md new file mode 100644 index 0000000000..55d60e748a --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/cli-getting-started.md @@ -0,0 +1,130 @@ +# Zowe CLI quick start + +Get started with Zowe™ CLI quickly and easily. + +This article presumes that your role is that of a systems administrator or you possess prerequisite knowledge of command-line tools and writing scripts. If you prefer more detailed instructions, see [Installing Zowe CLI](../user-guide/cli-installcli.md). + +## Installing + +The following topics describe the Zowe CLI system requirements and the various methods to use to install Zowe CLI. + +### Software Requirements + +Before you install Zowe CLI, download and install Node.js and npm. Use an LTS version of Node.js that is compatible with your version of npm. For a list of compatible versions, see [Node.js Previous Releases](https://nodejs.org/en/download/releases/). + +**(Linux only):** On headless Linux, follow the procedure documented in the [SCS plug-in Readme](https://github.com/zowe/zowe-cli-scs-plugin/blob/master/README.md#software-requirements). + +### Installing Zowe CLI core from public npm + +Issue the following command to install the core CLI. + +``` +npm install -g @zowe/cli@zowe-v2-lts +``` + +### Installing CLI plug-ins + +``` +zowe plugins install @zowe/cics-for-zowe-cli@zowe-v2-lts @zowe/db2-for-zowe-cli@zowe-v2-lts @zowe/ims-for-zowe-cli@zowe-v2-lts @zowe/mq-for-zowe-cli@zowe-v2-lts @zowe/zos-ftp-for-zowe-cli@zowe-v2-lts +``` + +The command installs most open-source plug-ins, but the IBM Db2 plug-in requires [additional configuration to install](../user-guide/cli-db2plugin.md#installing). + +For more information, see [Installing plug-ins](../user-guide/cli-installplugins.md). + +## Issuing your first commands + +Issue `zowe --help` to display full command help. Append `--help` (alias `-h`) to any command to see available command actions and options. + +*Optionally*, you can view the Zowe CLI web help in a browser window. For more information, see [Displaying help](../user-guide/cli-using-displaying-help.md). + +All Zowe CLI commands start with `zowe` followed by the name of the [core command group](../user-guide/cli-using-understanding-core-command-groups.md). For example, `zowe plugins -h`. To interact with the mainframe, type `zowe` followed by a command group, action, and object. Use options to specify your connection details such as password and system name. + +### Listing all data sets under a high-level qualifier (HLQ) + +**Example:** + +``` +zowe zos-files list data-set "MY.DATASET.*" --host my.company.com --port 123 --user myusername123 --pass mypassword123 +``` + +### Downloading a partitioned data-set (PDS) member to local file + +**Example:** + +``` +zowe zos-files download data-set "MY.DATA.SET(member)" -f "mylocalfile.txt" --host my.company.com --port 123 --user myusername123 --pass mypassword123 +``` + +See [Understanding core command groups](../user-guide/cli-using-understanding-core-command-groups.md) for a list of available functionality. + +## Team profiles + +Zowe CLI V2-LTS now supports **team** profiles. The process of setting up team profiles is simple and can be rolled out easily accross your organization. We highly recommend that you configure team profiles to support your Zowe CLI implementation. For more information, see [Using team profiles](../user-guide/cli-using-using-team-profiles.md). +## Using profiles + +Zowe profiles let you store configuration details such as username, password, host, and port for a mainframe system. Switch between profiles to quickly target different subsystems and avoid typing connection details on every command. + +### Profile types + +Most command groups require a `zosmf-profile`, but some plug-ins add their own profile types. For example, the CICS plug-in has a `cics-profile`. The profile type that a command requires is defined in the `PROFILE OPTIONS` section of the help response. + +**Tip:** The first `zosmf` profile that you create becomes your default profile. If you don't specify any options on a command, the default profile is used. Issue `zowe profiles -h` to learn about listing profiles and setting defaults. + +### Creating zosmf profiles + +``` +zowe profiles create zosmf-profile myprofile123 --host my.company.com --port 123 --user myusername123 --password mypassword123 +``` + +**Notes:** + +- The port defaults to 443 if you omit the `--port` option. Specify a different port if your host system does not use port 443. +- If z/OSMF is configured for high availability in Sysplex, create the CLI zosmf-profile with DVIPA address/hostname to ensure availability of REST services. For more information, see [Configuring z/OSMF high availability in Sysplex](../user-guide/systemrequirements-zosmf-ha.md). + +### Using zosmf profiles + +``` +zowe zos-files download data-set "MY.DATA.SET(member)" -f "mylocalfile.txt" --zosmf-profile myprofile123 +``` + +For detailed information about issuing commands, using profiles, and more, see [Using CLI](../user-guide/cli-using-usingcli.md). + +## Writing scripts + +You can write Zowe CLI scripts to streamline your daily development processes or conduct mainframe actions from an off-platform automation tool such as Jenkins or TravisCI. + +### Example: + +You want to delete a list of temporary datasets. Use Zowe CLI to download the list, loop through the list, and delete each data set using the `zowe zos-files delete` command. + +``` +#!/bin/bash + +set -e + +# Obtain the list of temporary project data sets +dslist=$(zowe zos-files list dataset "my.project.ds*") + +# Delete each data set in the list +IFS=$'\n' +for ds in $dslist +do + echo "Deleting Temporary Project Dataset: $ds" + zowe files delete ds "$ds" -f +done +``` + +For more information, see [Writing scripts](../user-guide/cli-using-writing-scripts.md). + +## Next steps + +You successfully installed Zowe CLI, issued your first commands, and wrote a simple script! Next, you might want to perform the following tasks: + +- Issue the `zowe --help` command to explore the product functionality, or review the online [web help](../user-guide/cli-using-displaying-help.md). +- Learn how to configure Zowe CLI [run Zowe CLI in daemon mode](../user-guide/cli-using-using-daemon-mode.md). **Daemon mode** significantly improves the performance of Zowe CLI commands by running Zowe CLI as a persistent background process. +- Learn about [configuring environment variables](../user-guide/cli-configuringcli-ev.md) to store configuration options. +- Learn about [integrating with API Mediation Layer](../user-guide/cli-using-integrating-apiml.md). +- Learn about how to [write scripts](../user-guide/cli-using-writing-scripts.md) and integrate them with automation server, such as Jenkins. +- See what [plug-ins are available](../user-guide/cli-extending.md) for the CLI. +- Learn about [developing for the CLI](../extend/extend-cli/cli-devTutorials.md) (contributing to core and developing plug-ins). diff --git a/versioned_docs/version-v2.15.x/getting-started/diagrams/apiml-architecture b/versioned_docs/version-v2.15.x/getting-started/diagrams/apiml-architecture new file mode 100644 index 0000000000..c9d6d723bf --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/diagrams/apiml-architecture @@ -0,0 +1 @@ +7Vttc9s2DP41vnUf1tO75Y+Jk7bZuluW3G5rv+xoiZbYyaKPot/66wdK1Lsc27NkJkuSO1sEQUnEA4AASI/M6WL7kaFl+Cv1cTQyNH87Mm9GhqE7YxO+BGWXUdyJkxECRnzJVBIeyXcsiZqkroiPkxojpzTiZFknejSOscdrNMQY3dTZ5jSqP3WJAtwiPHooalP/JD4PJVV3JmXHJ0yCUD7aNeT8FihnljNJQuTTTYVk3o7MKaOUZ1eL7RRHQni5XLJxH/b0Fi/GcMyPGWDh352b4JeF//fDnX+zmk1mD3c/6YZ8Ob7LZ4x9EIBsUsZDGtAYRbcl9ZrRVexjcVsNWiXPZ0qXQNSB+A1zvpNoohWnQAr5IpK9eEv4X2L4e1u2vlR6brbyzmljlzdiznbZIMPO21+qneW4tJUPzCYoZrVXcJKU0BXz8FPSkgqIWID5E3xWAS/YBaYLDO8D4xiOECfr+nsgqaBBwVdiCBcSxhMgNdRAWsBTw+a9fQCdBITJr4ShAiGmMc5pH4iYtioEDZUIyvuuUbSSTxoZTgSvez1jcBXwVCZNyh8JZi3kweksU8A8ThkwbULC8eMSpULagMuuozgHoU9pJFhhtOnb2PWtFBFG/8GVHteYmY5TYLPGjOPt0+i0pSkHmI70kHKJsGRzU/rbnBRWPG0+qn/xmy/QJ6pyicaLcIktg7q6vwPCNCJiwk2061ieaDIIu3Ovy2Qcz8WzeT8mY7kHTUY3LmkzZkvCNyTxKExSvPUjZmsC8utT0PM5drxOQfvjyUzT+hG00RC07qiWtG4p9U4V31R6qgPeSR+dFBL06J2sI72TqXS5d9UGbEOtHQel7pwpdTn0nhLhxHOTta26ybZukWmNHFViB0Eo2lXYloIhOf05pSpkdywVo5jjGSuZmthkwODeR0mYvpuuxvR17UwtPC8ysVV68/w6Q3N8pDsfQAm+rRbLfM6IeTkle/8xNGP6MxAkt0cXxHsm6jPpw4ed6nocu+F6NLuqiQf5bVsbDe+qnLNVuwr0QRU5K+fSXPO/ZF3jk5bOmiV4EUoS4jWMIX/yPWYEAMBMXUxkq9Bsa9LQbFt7UrPN8ZP8w2i2lGAl2fmION6goVKdy5RhmjnlM0h1lC6O9UKMdqxLqHkE/YBH6NGs7SPNWmmqY7csRxZiEEcRDXq1mrnr4e4Cwcy1LXugAkHRVmY1TlvGKx7CdIgHCNN4JN7GQSKaus4+gSJYKCPfc45kiIqNLf47S2PpnxhBY16hZ3/DuDf1QOnnB0iXruScGPr36N7GL8G9FVu9qio5xkmrz5HxqAIUz90t6KWgk8eW+2JPyz6PP/cs+/ht/Un+gbI2JeVllYWiY3VSbaFovCdyerlbK+09LNULcqEyz6IQ//y8t3ukpYxVGorbMpTvcJ/fHoF2z6i/8vrd771MltG0FdtQbSuT/WKOQCPhE6/To4BFJqG9+/ooukE+8AEZCfuxVyQus/PuPDsk8iihAsUUeSGJg6HKUUoErb4cZbTX4OzMlYY8DycJTkQina7KpdKvCSqonjxuor273ULmLbC4gtZXuhGc0893bYMA+fFmqFQVuoyVqghJEopIEIuVAR4pysjXAg3ioehKdiyI76crWBf6df0QablcvyY9OTStEdu2wXU7sLUGw7a9bBzAVhB4CHIKQrgqCsCvFL+Javza61H9iNcbjp04QohS97K6YiDN9mrWSHQ0D6UVSk4ZTr8BMnFXQTy88P1fgXQah2i7ypuXBbJ9irncJXuDsAvChk/VbdUQGi0IH3BAEpCd8Jri5ob2CUO+OcMoq6y9CqCai19XaNoFlDkYUO3jt29ACYGbdaDMianYotpHBx7oioMIxM/ainThtUUhVmPxMjvOs1/WoNob1W84dWRtR6Ztw+HU3uyepqEFSEwMLmpSEEP+IFwhXmPRvQnTL7aK4yzWoPN5hf2VwNk8FmgpDzj2Z+GHjzCg+hGGV4JhM4ErbK1/k4Rm+WvlbL+x/M23efsv \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/getting-started/diagrams/apiml-architecture.png b/versioned_docs/version-v2.15.x/getting-started/diagrams/apiml-architecture.png new file mode 100644 index 0000000000..772db8f111 Binary files /dev/null and b/versioned_docs/version-v2.15.x/getting-started/diagrams/apiml-architecture.png differ diff --git a/versioned_docs/version-v2.15.x/getting-started/diagrams/service-relationship-diagram.png b/versioned_docs/version-v2.15.x/getting-started/diagrams/service-relationship-diagram.png new file mode 100644 index 0000000000..ddf6741773 Binary files /dev/null and b/versioned_docs/version-v2.15.x/getting-started/diagrams/service-relationship-diagram.png differ diff --git a/versioned_docs/version-v2.15.x/getting-started/diagrams/zowe-chat-architecture.png b/versioned_docs/version-v2.15.x/getting-started/diagrams/zowe-chat-architecture.png new file mode 100644 index 0000000000..4887639e11 Binary files /dev/null and b/versioned_docs/version-v2.15.x/getting-started/diagrams/zowe-chat-architecture.png differ diff --git a/versioned_docs/version-v2.15.x/getting-started/diagrams/zowe-desktop-sample.png b/versioned_docs/version-v2.15.x/getting-started/diagrams/zowe-desktop-sample.png new file mode 100644 index 0000000000..4cc183c287 Binary files /dev/null and b/versioned_docs/version-v2.15.x/getting-started/diagrams/zowe-desktop-sample.png differ diff --git a/versioned_docs/version-v2.15.x/getting-started/migrate-cli.md b/versioned_docs/version-v2.15.x/getting-started/migrate-cli.md new file mode 100644 index 0000000000..3c62b2649e --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/migrate-cli.md @@ -0,0 +1,7 @@ +# Migrating Zowe CLI from V1 to V2 + +UNDER CONSTRUCTION + +Not sure if this article is required. There is a similar article here: [Updating Zowe CLI](../user-guide/cli-updatingcli.md) + +Before/after you install Zowe CLI V2, complete the migration tasks that are described in this article. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/getting-started/overview.md b/versioned_docs/version-v2.15.x/getting-started/overview.md new file mode 100644 index 0000000000..fade190c20 --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/overview.md @@ -0,0 +1,298 @@ +--- +meta: + - name: description + content: Zowe is an open source project within the Open Mainframe Project that is part of The Linux Foundation. Zowe is an extensible framework that simplifies and speeds application development, deployment, and operations on z/OS, and provides the ability for extension through CLI plug-ins, new applications to be added to the web desktop, and onboarding of REST APIs to the API Mediation Layer. It narrows the skills gap between new and legacy z/OS developers by offering the choice to work with z/OS either through a Command Line Interface, a Zowe Explorer Visual Studio extension, a web browser served from the Zowe Application Framework, or through REST APIs and web sockets served through the API Mediation Layer. +--- + +# Zowe overview + +Zowe™ is an open source software which provides both an extensible framework, and a set of tools that allow mainframe development and operation teams to securely manage, develop, and automate resources and services on z/OS family mainframes. +Zowe offers modern interfaces to interact with z/OS and allows users to interact with the mainframe system in a way that is similar to what they experience on cloud platforms today. +Users can work with these interfaces as delivered or through plug-ins and extensions created by customers or third-party vendors. +All members of the IBM Z platform community, including Independent Software Vendors (ISVs), System Integrators, and z/OS consumers, benefit from the modern and open approach to mainframe computing delivered by Zowe. + +Zowe is a member of the Open Mainframe Project governed by Linux Foundation™. + +## Zowe demo video + +Watch this [video](https://www.youtube.com/embed/NX20ZMRoTtk) to see a quick demo of Zowe. + + + +[Download the deck for this video](/Zowe_introduction_video_deck.pptx) | [Download the script](/Zowe_introduction_video_script.txt) + +## Component overview + +Zowe consists of the following components: + +- [Zowe Launcher](#zowe-launcher) +- [API Mediation Layer](#api-mediation-layer) +- [Zowe Application Framework](#zowe-application-framework) +- [Zowe CLI](#zowe-cli) +- [Zowe Explorer](#zowe-explorer) +- [Zowe Client Software Development Kits SDKs](#zowe-client-software-development-kits-sdks) +- [ZEBRA (Zowe Embedded Browser for RMF/SMF and APIs) - Incubator](#zebra-zowe-embedded-browser-for-rmfsmf-and-apis---incubator) + +### Zowe Launcher + +The Zowe Launcher makes it possible to launch Zowe z/OS server components in a high availability configuration, and performs the following operations: + +- Start all Zowe server components using the `START` (or `S`) operator command. +- Stop Zowe server components using the `STOP` (or `P`) operator command. +- Stop and start specific server components without restarting the entire Zowe instance using `MODIFY` (or `F`) operator command. + +### API Mediation Layer + +The API Mediation Layer provides a single point of access for APIs of mainframe services, and provides a [Single Sign On (SSO)](../user-guide/api-mediation-sso) capability for mainframe users. + +The API Mediation Layer (API ML) facilitates secure communication between loosely coupled clients and services through a variety of API types, such as REST, GraphQL or Web-Socket. +API ML consists of these core components: the API Gateway, the Discovery Service, the API Catalog, and the Caching service: + +- The API Gateway provides secure routing of API requests from clients to registered API services. +- The Discovery Service allows dynamic registration of microservices and enables their discoverability and status updates. +- The API Catalog provides a user-friendly interface to view and try out all registered services, read their associated APIs documentation in OpenAPI/Swagger format. +- The API ML Caching Service allows components to store, search and retrieve their state. The Caching service can be configured to store the cached data in-memory or using Redis, or VSAM storage. + +Core Zowe also provides out of the box services for working with MVS Data Sets, JES, as well as working with z/OSMF REST APIs. + +**Note:** The MVS datasets and JES services are deprecated and will not be available in Zowe V3. + +The API Mediation Layer offers enterprise, cloud-like features such as high-availability, scalability, dynamic API discovery, consistent security, a single sign-on experience, and API documentation. + +
    + Learn more + +#### Key features +* Consistent Access: API routing and standardization of API service URLs through the Gateway component provides users with a consistent way to access mainframe APIs at a predefined address. +* Dynamic Discovery: The Discovery Service automatically determines the location and status of API services. +* High-Availability: API Mediation Layer is designed with high-availability of services and scalability in mind. +* Caching Service: This feature is designed for Zowe components in a high availability configuration, and supports high availability of all components within Zowe. As such, components can remain stateless whereby the state of the component is offloaded to a location accessible by all instances of the service, including those which just started. +* Redundancy and Scalability: API service throughput is easily increased by starting multiple API service instances without the need to change configuration. +* Presentation of Services: The API Catalog component provides easy access to discovered API services and their associated documentation in a user-friendly manner. Access to the contents of the API Catalog is controlled through a z/OS security facility. +* Encrypted Communication: API ML facilitates secure and trusted communication across both internal components and discovered API services. + +#### API Mediation Layer structural architecture +The following diagram illustrates the single point of access through the Gateway, and the interactions between API ML components and services: + +![API Mediation Layer Architecture diagram](../images/api-mediation/api-ml-architecture.png) + +#### Components +The API Layer consists of the following key components: + +**API Gateway** + +Services that comprise the API ML service ecosystem are located behind a gateway (reverse proxy). All end users and API client applications interact through the Gateway. Each service is assigned a unique service ID that is used in the access URL. Based on the service ID, the Gateway forwards incoming API requests to the appropriate service. Multiple Gateway instances can be started to achieve high-availability. The Gateway access URL remains unchanged. The Gateway is built using Netflix Zuul and Spring Boot technologies. + +**Discovery Service** + +The Discovery Service is the central repository of active services in the API ML ecosystem. The Discovery Service continuously collects and aggregates service information and serves as a repository of active services. When a service is started, it sends its metadata, such as the original URL, assigned serviceId, and status information to the Discovery Service. Back-end microservices register with this service either directly or by using a Eureka client. Multiple enablers are available to help with service on-boarding of various application architectures including plain Java applications and Java applications that use the Spring Boot framework. The Discovery Service is built on Eureka and Spring Boot technology. + +**Discovery Service TLS/SSL** + +HTTPS protocol can be enabled during API ML configuration and is highly recommended. Beyond encrypting communication, the HTTPS configuration for the Discovery Service enables heightened security for service registration. Without HTTPS, services provide a username and password to register in the API ML ecosystem. When using HTTPS, only trusted services that provide HTTPS certificates signed by a trusted certificate authority can be registered. + +**API Catalog** + +The API Catalog is the catalog of published API services and their associated documentation. The Catalog provides both the REST APIs and a web user interface (UI) to access them. The web UI follows the industry standard Swagger UI component to visualize API documentation in OpenAPI JSON format for each service. A service can be implemented by one or more service instances, which provide exactly the same service for high-availability or scalability. + +**Catalog Security** + +Access to the API Catalog can be protected with an Enterprise z/OS Security Manager such as IBM RACF, ACF2, or Top Secret. Only users who provide proper mainframe credentials can access the Catalog. Client authentication is implemented through the z/OSMF API. + +**Caching Service** + +An API is provided in high-availability mode which offers the possibility to store, retrieve, and delete data associated with keys. The service can only be used by internal Zowe services and is not exposed to the internet. + +**Metrics Service (Technical Preview)** + +The Metrics Service provides a web user interface to visualize requests to API Mediation Layer services. HTTP metrics such as number of requests and error rates are displayed for +each API Mediation Layer service. This service is currently in technical preview and is not ready for production. + +#### Onboarding APIs +Essential to the API Mediation Layer ecosystem is the API services that expose their useful APIs. Use the following topics to discover more about adding new APIs to the API Mediation Layer and using the API Catalog: + +* [Onboarding Overview](../extend/extend-apiml/onboard-overview.md) +* [Onboard an existing Spring Boot REST API service using Zowe API Mediation Layer](../extend/extend-apiml/onboard-spring-boot-enabler.md) +* [Onboard an existing Node.js REST API service using Zowe API Mediation Layer](../extend/extend-apiml/onboard-nodejs-enabler.md) +* [Using API Mediation Layer](../user-guide/api-mediation/using-api-mediation-layer.md) + +To learn more about the architecture of Zowe, see [Zowe architecture](zowe-architecture.md). + +
    + +### Zowe Application Framework + +A web user interface (UI) that provides a virtual desktop containing a number of apps allowing access to z/OS function. Base Zowe includes apps for traditional access such as a 3270 terminal and a VT Terminal, as well as an editor and explorers for working with JES, MVS Data Sets and Unix System Services. + +
    + Learn more + +The Zowe Application Framework modernizes and simplifies working on the mainframe. With the Zowe Application Framework, you can create applications to suit your specific needs. The Zowe Application Framework contains a web UI that has the following features: + +- The web UI works with the underlying REST APIs for data, jobs, and subsystem, but presents the information in a full screen mode as compared to the command line interface. +- The web UI makes use of leading-edge web presentation technology and is also extensible through web UI plug-ins to capture and present a wide variety of information. +- The web UI facilitates common z/OS developer or system programmer tasks by providing an editor for common text-based files like REXX or JCL along with general purpose data set actions for both Unix System Services (USS) and Partitioned Data Sets (PDS) plus Job Entry System (JES) logs. + +The Zowe Application Framework consists of the following components: + +- **Zowe Desktop** + + The desktop, accessed through a browser. The desktop contains a number of applications, including a TN3270 emulator for traditional Telnet or TLS terminal access to z/OS, a VT Terminal for SSH commands, as well as rich web GUI applications including a JES Explorer for working with jobs and spool output, a File Editor for working with USS directories and files and MVS data sets and members. The Zowe desktop is extensible and allows vendors to provide their own applications to run within the desktop. See [Extending the Zowe Desktop](../extend/extend-desktop/mvd-extendingzlux.md). The following screen capture of a Zowe desktop shows some of its composition as well as the TN3270 app, the JES Explorer, and the File Editor open and in use. + + ![Zowe Desktop Screen Capture](./diagrams/zowe-desktop-sample.png) + +- **Zowe Application Server** + + The Zowe Application Server runs the Zowe Application Framework. It consists of the Node.js server plus the Express.js as a webservices framework, and the proxy applications that communicate with the z/OS services and components. + +- **ZSS Server** + + The ZSS Server provides secure REST services to support the Zowe Application Server. For services that need to run as APF authorized code, Zowe uses an angel process that the ZSS Server calls using cross memory communication. During installation and configuration of Zowe, you will see the steps needed to configure and launch the cross memory server. + +- **Application plug-ins** + + Several application-type plug-ins are provided. For more information, see [Using the Zowe Application Framework application plug-ins](../user-guide/mvd-using.md#zowe-desktop-application-plug-ins). + +
    + +### Zowe CLI +Zowe CLI is a command-line interface that lets you interact with the mainframe in a familiar, off-platform format. Zowe CLI helps to increase overall productivity, reduce the learning curve for developing mainframe applications, and exploit the ease-of-use of off-platform tools. Zowe CLI lets you use common tools such as Integrated Development Environments (IDEs), shell commands, bash scripts, and build tools for mainframe development. Though its ecosystem of plug-ins, you can automate actions on systems such as IBM Db2, IBM CICS, and more. It provides a set of utilities and services for users that want to become efficient in supporting and building z/OS applications quickly. + +
    + Learn more + +Zowe CLI provides the following benefits: + +- Enables and encourages developers with limited z/OS expertise to build, modify, and debug z/OS applications. +- Fosters the development of new and innovative tools from a computer that can interact with z/OS. Some Zowe extensions are powered by Zowe CLI, for example the [Visual Studio Code Extension for Zowe](../user-guide/ze-install.md). +- Ensure that business critical applications running on z/OS can be maintained and supported by existing and generally available software development resources. +- Provides a more streamlined way to build software that integrates with z/OS. + +**Note:** For information about software requirements, installing, and upgrading Zowe CLI, see +[Installing Zowe](../user-guide/installandconfig.md). + +#### Zowe CLI capabilities + +With Zowe CLI, you can interact with z/OS remotely in the following ways: + +- **Interact with mainframe files:** + Create, edit, download, and upload mainframe files (data sets) directly from Zowe CLI. +- **Submit jobs:** + Submit JCL from data sets or local storage, monitor the status, and view and download the output automatically. +- **Issue TSO and z/OS console commands:** + Issue TSO and console commands to the mainframe directly from Zowe CLI. +- **Integrate z/OS actions into scripts:** + Build local scripts that accomplish both mainframe and local tasks. +- **Produce responses as JSON documents:** + Return data in JSON format on request for consumption in other programming languages. + +For detailed information about the available functionality in Zowe CLI, see [Zowe CLI Command Groups](../user-guide/cli-using-understanding-core-command-groups.md). + +For information about extending the functionality of Zowe CLI by installing plug-ins, see [Extending Zowe CLI](../user-guide/cli-extending.md). + +**More Information:** + +- [System requirements for Zowe CLI](../user-guide/systemrequirements-cli.md) +- [Installing Zowe CLI](../user-guide/cli-installcli.md) + +
    + +### Zowe Explorer + +Zowe Explorer is a Visual Studio Code extension that modernizes the way developers and system administrators interact with z/OS mainframes. Zowe Explorer lets you interact with data sets, USS files, and jobs that are stored on z/OS. The extension complements your Zowe CLI experience and lets you use authentication services like API Mediation Layer. The extension provides the following benefits: + +- Enables you to create, modify, rename, copy, and upload data sets directly to a z/OS mainframe. +- Enables you to create, modify, rename, and upload USS files directly to a z/OS mainframe. +- Provides a more streamlined way to access data sets, uss files, and jobs. +- Letting you create, edit, and delete Zowe CLI `zosmf` compatible profiles. +- Lets you use the Secure Credential Store plug-in to store your credentials securely in the settings. +- Lets you leverage the API Mediation Layer token-based authentication to access z/OSMF. + +For more information, see [Information roadmap for Zowe Explorer](user-roadmap-zowe-explorer.md). + +### Zowe Client Software Development Kits (SDKs) + +The Zowe Client SDKs consist of programmatic APIs that you can use to build client applications or scripts that interact with z/OS. The following SDKs are available: + +- Zowe Node.js Client SDK +- Zowe Python Client SDK + +For more information, see [Using the Zowe SDKs](../user-guide/sdks-using.md). + +### Zowe Chat (Technical Preview) + +Zowe Chat is a chatbot that aims to enable a ChatOps collaboration model including z/OS resources and tools. Zowe Chat enables you to interact with the mainframe from chat clients such as Slack, Microsoft Teams, and Mattermost. Zowe Chat helps to increase your productivity by eliminating or minimizing the context switching between different tools and user interfaces. + +
    + Learn more + + +#### Zowe Chat key features + +- **Manage z/OS resource in chat tool channels** + Check your z/OS job, data set, and USS files status directly in chat tool channels. You can also issue z/OS console commands directly in the chat tool. You can drill down on a specific job, data set, error code, and so on to get more details through button or drop-down menu that Zowe Chat provides. + +- **Execute Zowe CLI commands in chat tool channels** + + You can also issue Zowe CLI commands to perform operations such as help and z/OS resource management including z/OS job, data set, USS file, error code, and console command. Theoretically, most of Zowe CLI commands are supported as long as it is executable with single-submit. + +- **Extensibility** + + Zowe Chat is extensible via plug-ins. You can extend Zowe Chat by developing plug-ins and contributing code to the base Zowe Chat or existing plug-ins. + +- **Security:** + + Zowe Chat makes use of z/OS SAF calls and supports the three main security management products on z/OS (RACF, Top Secret, ACF2). You can log in to the chat client via enterprise standards, including two factor authentication if required. The first time you issue a command to the Zowe Chat installed in the chat workspace, it prompts you to log in with the mainframe ID using a one-time URL. Once authenticated against the mainframe security, Zowe Chat securely caches in memory the relationship between your Chat tool ID and the mainframe ID. Zowe Chat’s Security Facility will generate credentials for downstream API requests. + +- **Display alerts:** + + Allows you to send alert or event to a channel in the chat tool in use. An event data model enables Zowe Chat extenders to send alerts to a channel in the chat through Zowe Chat. + +Read the following blogs to learn more about Zowe Chat: + +- [Zowe Gets Chatty](https://medium.com/zowe/zowe-gets-chatty-842e3b548902) +- [Zowe Chat can make you more productive: user scenarios](https://medium.com/zowe/zowe-chat-can-make-you-more-productive-user-scenarios-f52a9985dd50) + +#### Zowe Chat architecture + +Zowe Chat is based on the Common Bot framework, which is required for the chat platform Slack, Mattermost, and Microsoft Teams. + +![Zowe chat architecture](./diagrams/zowe-chat-architecture.png) + +
    + +For more information, see [Installing Zowe Chat](../user-guide/zowe-chat/chat_install_overview.md) and [Using Zowe Chat](../user-guide/zowe-chat/chat_use_interact_methods.md). + +### ZEBRA (Zowe Embedded Browser for RMF/SMF and APIs) - Incubator + +ZEBRA Provides re-usable and industry compliant JSON formatted RMF/SMF data records, so that many other ISV SW and users can exploit them using open-source SW for many ways. + +For more information, see the [ZEBRA documentation](https://github.com/zowe/zebra/tree/main/Documentation). + +### Zowe IntelliJ Plug-in + +Zowe IntelliJ plug-in for Intellij-based IDEs is a smart and interactive mainframe code editing tool that allows you to browse, edit, and create data on z/OS via z/OSMF REST API. + +Zowe IntelliJ plug-in helps you to: +- Start working with z/OS easily with no complex configurations. +- Organize datasets on z/OS, files on USS into working sets. +- Allocate datasets, create members, files and directories with different permissions. +- Perform operations like renaming, copying and moving data in a modern way. +- Edit datasets, files and members. Smart auto-save keeps your content both in the editor and on the mainframe in-sync. +- Create multiple connections to different z/OS systems. +- Perform all available operations with jobs. +- Highlight all IntelliJ supported languages automatically and recognize them once opened from the mainframe. + +For more information, see [Using Zowe IntelliJ plug-in](../user-guide/intellij-using.md). + +## Zowe Bill of Materials + + + +For information about the [Zowe Bill of Materials (BOM)](../appendix/bill-of-materials.md), see this link to the appendix. diff --git a/versioned_docs/version-v2.15.x/getting-started/user-roadmap-apiml.md b/versioned_docs/version-v2.15.x/getting-started/user-roadmap-apiml.md new file mode 100644 index 0000000000..f8b7aeff83 --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/user-roadmap-apiml.md @@ -0,0 +1,159 @@ +# Information roadmap for Zowe API Mediation Layer + +This roadmap outlines information resources that are applicable to the various user roles who are interested in Zowe API Mediation Layer. These resources provide information about various subject areas, such as learning basic skills, installation, developing, and troubleshooting for Zowe API Mediation Layer. + +The following definition of skill levels about Zowe assist you with gathering the most relevant resources for you. + +* Beginner: You're starting out and want to learn the fundamentals. +* Intermediate: You have some experience but want to learn more in-depth skills. +* Advanced: You have lots of experience and are looking to learn about specialized topics. + +## Fundamentals + +> Zowe skill level: Beginner + +- [**Zowe API Mediation Layer overview**](overview.md#api-mediation-layer) + + New to API Mediation Layer? This overview topic introduces the key features, main components, benefits, and architecture of the API Mediation Layer. + +- [**Architecture**](zowe-architecture.md#zowe-architecture) + + Review the Zowe architecture to understand how the API Mediation Layer works in the Zowe framework. + +## Installing + +> Zowe skill level: Beginner + +- [**System requirements**](../user-guide/systemrequirements-zos.md) + + Review this topic to ensure that your system meets the requirements for installing the API Mediation Layer. The API Mediation Layer is one of the server-side components. + +- [**Planning**](../user-guide/installandconfig.md#planning-the-installation-of-zowe-server-components) + + This article includes details about planning for installation, the Zowe z/OS launch process, and information about the Zowe runtime directory, instance directory, and keystore directory. + +- [**Installing API Mediation Layer**](../user-guide/install-zos.md#z-os-installation-roadmap) + + This article provides an overview of the essential steps involved in installing the API Mediation Layer. + +## Configuring and updating + +> Zowe skill level: Intermediate + +- **Configuring API Mediation Layer** + + - [Configuring the Zowe APIs](../user-guide/configure-data-sets-jobs-api.md) + + This article explains how to configure security for the Zowe API Mediation Layer. + + - [Advanced Gateway features configuration](../user-guide/advanced-apiml-configuration.md) + + This article is for system programmers who want to configure advanced Gateway features of the API Mediation Layer, such as the Gateway retry policy, connection limits, Gateway timeouts, and other advanced Gateway features. + +## Using Zowe API Mediation Layer + +> Zowe skill level: Intermediate + +- [**Using API Mediation Layer**](../user-guide/api-mediation/using-api-mediation-layer.md) + + Learn how to use the API Catalog to view what services are running in the API Mediation Layer. Through the API Catalog, you can also view associated API documentation corresponding to a service, descriptive information about the service, and the current state of the service. + +- [**Blog: Introducing “Try it out” functionality in the Zowe API Mediation Layer**](https://medium.com/zowe/introducing-try-it-out-functionality-in-the-zowe-api-mediation-layer-930aa9e947bd) + + This blog describes one key functionality of the Zowe API Mediation Layer to validate that services are returning the expected responses. + +- [**Docs: Zowe API reference guide**](../appendix/zowe-api-reference.md) + + Discover and learn about Zowe APIs that you can use. + +## Onboarding APIs + +> Zowe skill level: Advanced + +- [**Extend Zowe API Mediation Layer**](../extend/extend-zowe-overview.md#extend-zowe-api-mediation-layer) + + Learn how you can extend the Zowe API Mediation Layer. Extenders make it possible to build and onboard additional API services to the API ML microservices ecosystem. REST APIs can register to the API Mediation Layer, which makes them available in the API Catalog, and for routing through the API Gateway. + +- [**Onboarding overview**](../extend/extend-apiml/onboard-overview.md#prerequisites) + + This article provides details about onboarding a REST API service to the Zowe API Mediation Layer. + +- [**Zowe API ML repository**](https://github.com/zowe/api-layer) + + To start working with the code immediately, check out this code repository. + +## Security + +> Zowe skill level: Advanced + +- [**API Mediation Layer Security**](../extend/extend-apiml/zowe-api-mediation-layer-security-overview.md) + + This article describes how API ML uses Transport Layer Security (TLS). Use this guide to familiarize yourself with the API ML security concepts. + +- [**Zowe API Mediation Layer Single Sign On Overview**](../user-guide/api-mediation-sso) + + This article provides an overview of the API ML single-sign-on feature, the principle participants in the SSO process, and links to detailed Zowe SSO documentation. + +- [**Blog: The ZAAS Client: a library for the API Mediation Layer**](https://medium.com/zowe/the-zaas-client-a-library-for-the-api-mediation-layer-822ea2994388) + + This blog introduces you to Zowe Authentication and Authorization Service (ZAAS) Client — a library that contains methods for retrieval of JWT tokens, PassTickets, as well as verifying JTW token information. + +- [**Blog: Single-Sign-On to z/OS REST APIs with Zowe**](https://medium.com/zowe/single-sign-on-to-z-os-rest-apis-with-zowe-6e35fd022a95) + + This blog takes a deeper dive into the SSO feature of API ML. + +- [**Blog: Zowe client certificate authentication**](https://medium.com/zowe/zowe-client-certificate-authentication-5f1c7d4d579) + +## Contributing to Zowe API Mediation Layer + +> Zowe skill level: Advanced + +- [**Contributing guidelines**](https://github.com/zowe/api-layer/blob/master/CONTRIBUTING.md) + + This document is a summary of conventions and best practices for development within Zowe API Mediation Layer. + +- [**Conformance Program**](../extend/zowe-conformance-program.md) + + This topic introduces the Zowe Conformance Program. Conformance provides Independent Software Vendors (ISVs), System Integrators (SIs), and end users greater confidence that their software will behave as expected. As vendors, you are invited to submit conformance testing results for review and approval by the Open Mainframe Project. If your company provides software based on Zowe CLI, you are encouraged to get certified today. + +- [**Blog: Zowe Conformance Program Explained**](https://medium.com/zowe/zowe-conformance-program-7f1574ade8ea) + + This blog describes the Conformance Program in more details. + +## Troubleshooting and support + +- [**Troubleshooting API ML**](../troubleshoot/troubleshoot-apiml.md) + + Learn about the tools and techniques that are available to help you troubleshoot and resolve problems. You can also find a list of common issues about Zowe API ML. + +- [**Error Message Codes**](../troubleshoot/troubleshoot-apiml-error-codes.md) + + Use the message code references and the corresponding reasons and actions to help troubleshoot issues. + +- [**Sumit an issue**](https://github.com/zowe/api-layer/issues) + + If you have an issue that is specific to Zowe API Mediation Layer, you can submit an issue against the `api-layer` repo. + +## Community resources + +- [**Slack channel**](https://openmainframeproject.slack.com/) + + Join the #zowe-api Slack channel to ask questions about Zowe API ML, propose new ideas, and interact with the Zowe community. + +- [**Zowe API ML squad meetings**](https://lists.openmainframeproject.org/g/zowe-dev/calendar) + + You can join one of the Zowe API ML squad meetings to get involved. + +- [**Zowe Blogs on Medium**](https://medium.com/zowe) + + Read a series of blogs about Zowe on Medium to explore use cases, best practices, and more. + +- **Community Forums** + + Look for discussion on Zowe topics on the [Open Mainframe Project Community Forums](https://community.openmainframeproject.org/c/zowe). + + + + + + diff --git a/versioned_docs/version-v2.15.x/getting-started/user-roadmap-app-framework.md b/versioned_docs/version-v2.15.x/getting-started/user-roadmap-app-framework.md new file mode 100644 index 0000000000..f88617ea16 --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/user-roadmap-app-framework.md @@ -0,0 +1,133 @@ +# Information roadmap for Zowe Application Framework + +This roadmap outlines information resources that are applicable to the various user roles who are interested in Zowe Application Framework. These resources provide information about various subject areas, such as learning basic skills, installation, developing, and troubleshooting for Zowe Application Framework. + +The following definition of skill levels about Zowe will help you gather most relevant resources for you. + +* Beginner: You're starting out and want to learn the fundamentals. +* Intermediate: You have some experience but want to learn more in-depth skills. +* Advanced: You have lots of experience and are looking to learn about specialized topics. + +## Fundamentals + +> Zowe skill level: Beginner + +- [**Zowe Application Framework overview**](overview.md#zowe-application-framework) + + New to Zowe Application Framework? This overview topic introduces what is Zowe Application Framework and the main components and benefits. + +- [**Architecture**](zowe-architecture.md#zowe-architecture) + + Review the Zowe architecture to understand how Zowe Application Framework works in the Zowe framework. + +- [**An Introduction to the Zowe Virtual Desktop**](https://medium.com/zowe/an-introduction-to-the-zowe-virtual-desktop-6e0140644875) + + This blog gives you an overview of the Zowe Desktop. + +## Installing + +> Zowe skill level: Beginner + +- [**System requirements**](../user-guide/systemrequirements-zos.md) + + Review this topic to ensure that your system meets the requirements for installing the Zowe Application Framework. Zowe Application Framework is one of the server-side components. + +- [**Planning**](../user-guide/installandconfig.md#planning-the-installation-of-zowe-server-components) + + This article provides details about planning for the installation, the Zowe z/OS launch process, and so on. + +- [**Installing Zowe Application Framework**](../user-guide/install-zos.md#z-os-installation-roadmap) + + This article provides an overview of the essential steps involved in installing Zowe Application Framework. If you want to use Docker for the installation, instead follow the link below. + +## Configuring and updating + +> Zowe skill level: Intermediate + +- [Configuring Zowe Application Framework](../user-guide/mvd-configuration.md) + + This information describes how to configure the Zowe Application Framework as a Mediation Layer client, configure connections for the terminal application plug-ins, modify the Zowe Application Server and Zowe System Services (ZSS) configuration, and so on. + +## Using Zowe Application Framework + +> Zowe skill level: Intermediate + +- [**Using the Zowe Desktop**](../user-guide/mvd-using.md) + + Learn about how to navigate the Zowe Desktop and use a list of pre-installed application plug-ins. + +- [**Using the Editor**](../user-guide/mvd-editor.md) + + Learn how to use the Editor application plug-in. + +- [**Tutorial: Getting started tutorial**](../user-guide/zowe-getting-started-tutorial.md) + + This tutorial walks you through the Zowe Desktop with several simple tasks to help you get familiar with it. + +## Developing Zowe Desktop plug-ins + +> Zowe skill level: Advanced + +- [**Developing for Zowe Application Framework**](../extend/extend-desktop/mvd-extendingzlux.md) + + Learn how you can extend the Zowe Application Framework by adding a plug-in to the Zowe Desktop. + +- [**Zowe Application Framework repository**](https://github.com/zowe/zlux) + + If you want to start working with the code immediately, check out this code repository. + +- [**Zowe App Server scripts**](https://github.com/zowe/zlux-app-server) + + This is the default setup of the Zowe App Server, built upon the zLUX framework. Within, you will find a collection of build, deploy, and run scripts as well as configuration files that will help you to configure a simple App Server and add a few Apps. + +### Samples +- [Sample iframe App](https://github.com/zowe/sample-iframe-app) +- [Sample Angular App](https://github.com/zowe/sample-angular-app/blob/lab/step-1-hello-world/README.md) +- [Sample React App](https://github.com/zowe/sample-react-app/blob/lab/step-1-hello-world/README.md) + + +## Contributing to Zowe Application Framework + +> Zowe skill level: Advanced + +- [**Conformance Program**](../extend/zowe-conformance-program.md) + + This topic introduces the Zowe Conformance Program. Conformance provides Independent Software Vendors (ISVs), System Integrators (SIs), and end users greater confidence that their software will behave as expected. As vendors, you are invited to submit conformance testing results for review and approval by the Open Mainframe Project. If your company provides software based on Zowe CLI, you are encouraged to get certified today. + +- [**Blog: Zowe Conformance Program Explained**](https://medium.com/zowe/zowe-conformance-program-7f1574ade8ea) + + This blog describes the Conformance Program in more details. + +## Troubleshooting and support + +- [**Troubleshooting Zowe Application Framework**](../troubleshoot/app-framework/app-troubleshoot.md) + + Learn about the tools and techniques that are available to help you troubleshoot and resolve problems. You can also find a list of common issues about Zowe Application Framework. + +- [**Submit an issue**](https://github.com/zowe/zlux/issues) + + If you have an issue that is specific to Zowe Application Framework, you can submit an issue against the `zlux` repo. + +## Community resources + +- [**Slack channel**](https://openmainframeproject.slack.com/) + + Join the Slack channel to ask questions, propose new ideas, and interact with the Zowe community. + +- [**Zowe WebUI squad meetings**](https://lists.openmainframeproject.org/g/zowe-dev/calendar) + + You can join one of the Zowe WebUI squad meetings to get involved. + +- [**Zowe Blogs on Medium**](https://medium.com/zowe) + + Read a series of blogs about Zowe on Medium to explore use cases, best practices, and more. + +- **Community Forums** + + Look for discussion on Zowe topics on the [Open Mainframe Project Community Forums](https://community.openmainframeproject.org/c/zowe). + + + + + + diff --git a/versioned_docs/version-v2.15.x/getting-started/user-roadmap-client-sdk.md b/versioned_docs/version-v2.15.x/getting-started/user-roadmap-client-sdk.md new file mode 100644 index 0000000000..8f8940a47b --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/user-roadmap-client-sdk.md @@ -0,0 +1,105 @@ +# Information roadmap for Zowe Client SDKs + +This roadmap outlines information resources that are applicable to the various user roles who are interested in Zowe Client Software Development Kits (SDKs) which is a Zowe component still under development. These resources provide information about various subject areas, such as learning basic skills, installation, developing, and troubleshooting for Zowe Client SDKs. + +The following definition of skill levels about Zowe will help you gather most relevant resources for you. + +* Beginner: You are starting out and want to learn the fundamentals. +* Intermediate: You have some experience but want to learn more in-depth skills. +* Advanced: You have lots of experience and are looking to learn about specialized topics. + +## Fundamentals + +> Zowe skill level: Beginner + +- [**Zowe Client SDK overview**](overview.md#zowe-client-software-development-kits-sdks) + + New to Zowe Client SDKs? This overview topic briefly introduces what the SDK is. + +- [**Blog: Zowe SDKs - Build z/OS Connected Applications Faster**](https://medium.com/zowe/zowe-sdks-build-z-os-connected-applications-faster-b786ba7bb0d9) + + This blog introduces Zowe SDKs and their benefits. + +## Installing + +> Zowe skill level: Beginner + +- [**System requirements**](../user-guide/sdks-using.md#software-requirements) + + Review this topic to ensure that your system meets the requirements for installing Zowe Client SDKs. + +- [**Installing Zowe SDK**](../user-guide/sdks-using.md#getting-started) + + Follow the steps to install Zowe SDKs. You can pull the packages from an online registry, or download the packages from Zowe.org to install locally. + +## Using Zowe Client SDKs + +> Zowe skill level: Intermediate + +### Zowe Node.js SDK + +- [**Using Zowe Node.js SDKs**](../user-guide/sdks-using.md#using-node-js) + + This information provides links to different pakcage Readmes that describes how to use the Zowe Node SDK. + +- **Docs: Node.js SDK reference guide** + + Refer to the following Zowe Client SDK reference guides for information about the API endpoints: + - **[Browse Node SDK reference guide online](https://docs.zowe.org/stable/typedoc/index.html)** + - **[Download SDK reference guide in ZIP format](https://docs.zowe.org/stable/zowe-nodejs-sdk-typedoc.zip)** + +- [**Zowe SDK Sample Scripts**](https://github.com/zowe/zowe-sdk-sample-scripts/) + + This repository contains some sample scripts that utilize various components of the Zowe SDKs organized by use cases. + +### Zowe Python SDK + +- [**Using Zowe Python SDKs**](https://zowe-client-python-sdk.readthedocs.io/en/latest/) + + This information provides links to different pakcage Readmes that describes how to use the Zowe Python SDK. + +- **Docs: Python SDK reference guide** + + Refer to the following Zowe Client SDK reference guides for information about the API endpoints: + - **[Browse Python SDK reference guide online](https://zowe-client-python-sdk.readthedocs.io/en/latest/index.html)** + - **[Download SDK reference guide in PDF format](https://zowe-client-python-sdk.readthedocs.io/_/downloads/en/latest/pdf/)** + + +## Contributing to Zowe Client SDKs + +> Zowe skill level: Advanced + +- [**Contributing guidelines**](https://github.com/zowe/zowe-cli/blob/master/docs/SDKGuidelines.md) + + This document is a summary of guidelines for development within Zowe SDKs. You can contribute to add features, enhancements, and bug fixes to the source code. + +## Troubleshooting and support + +- [**Sumit an issue**](https://github.com/zowe/zowe-cli/issues/new) + + If you have an issue that is specific to Zowe SDKs, you can submit an issue against the `zowe-cli` repo. + + +## Community resources + +- [**Slack channel**](https://openmainframeproject.slack.com/) + + Join the #zowe-cli Slack channel to ask questions about Zowe CLI and Zowe SDKs, propose new ideas, and interact with the Zowe community. + +- [**Zowe CLI squad meetings**](https://lists.openmainframeproject.org/g/zowe-dev/calendar) + + You can join one of the Zowe CLI squad meetings to discuss Zowe SDKs issues and contibute to Zowe SDKs. + +- [**Zowe Blogs on Medium**](https://medium.com/zowe) + + Read a series of blogs about Zowe on Medium to explore use cases, best practices, and more. + +- **Community Forums** + + Look for discussion on Zowe topics on the [Open Mainframe Project Community Forums](https://community.openmainframeproject.org/c/zowe). + + + + + + diff --git a/versioned_docs/version-v2.15.x/getting-started/user-roadmap-zowe-explorer.md b/versioned_docs/version-v2.15.x/getting-started/user-roadmap-zowe-explorer.md new file mode 100644 index 0000000000..881262c106 --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/user-roadmap-zowe-explorer.md @@ -0,0 +1,121 @@ +# Zowe Explorer + +The resources here provide information about various Zowe Explorer subject areas, such as learning basic skills, installation, developing, and troubleshooting. + +:::tip + +To identify the resources most relevant for you, use the following definitions of Zowe Explorer skill levels. + +* Beginner: You're starting out and want to learn the fundamentals. +* Intermediate: You have some experience but want to learn more in-depth skills. +* Advanced: You have lots of experience and are looking to learn about specialized topics. +::: + +## Fundamentals + +> Zowe skill level: Beginner + +* [**Zowe Explorer overview**](../user-guide/ze-install.md) + + New to Zowe Explorer? This overview topic introduces the key features, main components, and benefits of Zowe Explorer. + +* [**Zowe Explorer FAQs**](../getting-started/zowe_faq.md#zowe-explorer-faq) + + If you have a question, review the FAQ, which answers the most commonly asked questions about Zowe Explorer. + +* [**Blog: Visual Studio Code for Mainframe Via the Zowe Explorer Extension**](https://medium.com/zowe/visual-studio-code-for-mainframe-via-the-zowe-explorer-extension-b679054ffaf7) + + This Medium article outlines the basics of Zowe Explorer, including Getting Started videos. + +## Installing and configuring + +> Zowe skill level: Beginner + +* [**Installing Zowe Explorer**](../user-guide/ze-install.md#installing-zowe-explorer) + + This page includes the system requirements and steps for installing the Zowe Explorer. + +* [**Video: Getting started with Zowe Explorer (Part 1)**](https://youtu.be/G_WCsFZIWt4) +* [**Video: Getting started with Zowe Explorer (Part 2)**](https://youtu.be/X4oSHrI4oN4) + + These videos help you to get started with Zowe Explorer and show the basic data set use cases. + +* [**Zowe Explorer Profiles**](../user-guide/ze-profiles.md) + + This page describes how to create and work with Zowe Explorer profiles. Having a profile enables you to use all functions of the extension, activate the Secure Credential Store plug-in to securely store credentials, and more. + +## Using Zowe Explorer + +> Zowe skill level: Intermediate + +* [**Using Zowe Explorer**](../user-guide/ze-usage.md) + + This page includes usage tips and sample use cases for data sets, USS files, JOBs, and TSO commands. Familiarize yourself with the extension and make the best use of available options and features. + +## Extending Zowe Explorer + +> Zowe skill level: Advanced + +* [**Extend Zowe Explorer**](https://github.com/zowe/zowe-explorer-vscode/wiki/Extending-Zowe-Explorer) + + Learn how to create extensions for Zowe Explorer to introduce new functionalities. + +- [**Zowe Explorer CICS Extension**](../user-guide/ze-using-zowe-explorer-cics-ext.md) + + Learn how to install the CICS extension. The extension adds CICS functionality to the Visual Studio Code extension, which lets you interact with CICS regions and programs. + +* [**Zowe Explorer FTP Extension**](../user-guide/ze-ftp.md) + + Learn how to install and use the FTP extension. The extension adds the FTP protocol to the Zowe Explorer VS Code extension, which lets use z/OS FTP Plug-in for Zowe CLI profiles to connect and interact with z/OS USS. + +* [**Zowe Explorer repository**](https://github.com/zowe/zowe-explorer-vscode) + + The GitHub repository of contains the source code of Zowe Explorer and other Zowe Explorer-related extensions. Check out the landing page README in the repository to find out how to contribute to the extension. + +* [**Developing for Eclipse Theia**](https://github.com/zowe/zowe-explorer-vscode/wiki/Developing-for-Theia) + + This article contains information on how to develop for Eclipse Theia. + +## Contributing to Zowe Explorer + +> Zowe skill level: Advanced + +* [**Contributing guidelines**](https://github.com/zowe/zowe-explorer-vscode/blob/master/CONTRIBUTING.md) + + This document is intended to be a living summary of conventions & best practices for development of the Visual Studio Code Extension for Zowe. + +* [**Conformance Program**](../extend/zowe-conformance-program.md) + + This topic introduces the Zowe Conformance Program. Conformance provides Independent Software Vendors (ISVs), System Integrators (SIs), and end users greater confidence that their software will behave as expected. As vendors, you are invited to submit conformance testing results for review and approval by the Open Mainframe Project. If your company provides software based on Zowe CLI, you are encouraged to get certified today. + +* [**Blog: Zowe Conformance Program Explained**](https://medium.com/zowe/zowe-conformance-program-7f1574ade8ea) + + This Medium article provide more details about the Conformance Program, including useful references. + +## Troubleshooting and support + +* [**Troubleshooting Zowe Explorer**](../troubleshoot/ze/troubleshoot-ze.md) + + Learn about the tools and techniques that are available to help you troubleshoot and resolve problems. You can also find the list of Zowe Explorer issues. + +* [**Submit an issue**](https://github.com/zowe/zowe-explorer-vscode/issues) + + If you have an issue that is specific to Zowe Explorer, you can submit an issue against the `vscode-extension-for-zowe` repository. + +## Community resources + +* [**Slack channel**](https://openmainframeproject.slack.com/) + + Join the `# zowe-explorer` Slack channel to ask questions, propose new ideas, and interact with the Zowe community. + +* [**Zowe Explorer squad meetings**](https://lists.openmainframeproject.org/g/zowe-dev/calendar) + + You can join one of the Zowe Explorer squad meetings to get involved. + +* [**Zowe Blogs on Medium**](https://medium.com/zowe) + + Read a series of blog articles about Zowe on Medium to explore use cases, best practices, and more. + +* **Community Forums** + + Look for discussion on Zowe topics on the [Open Mainframe Project Community Forums](https://community.openmainframeproject.org/c/zowe). diff --git a/versioned_docs/version-v2.15.x/getting-started/zowe-architecture.md b/versioned_docs/version-v2.15.x/getting-started/zowe-architecture.md new file mode 100644 index 0000000000..499269c73f --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/zowe-architecture.md @@ -0,0 +1,130 @@ +# Zowe architecture + +Zowe™ is a collection of components that together form a framework that makes Z-based functionality accessible across an organization. Zowe functionality includes exposing Z-based components, such as z/OSMF, as REST APIs. The Zowe framework provides an environment where other components can be included and exposed to a broader non-Z based audience. + +The following diagram illustrates the high-level Zowe architecture. + +![Zowe Architecture Diagram](../images/common/zowe-architecture.png) + +The diagram shows the default port numbers that are used by Zowe. These are dependent on each instance of Zowe and are held in the Zowe YAML configuration file. + +Zowe components can be categorized by location: server or client. While the client is always an end-user tool such as a PC, browser, or mobile device, the server components can be further categorized by what machine they run on. + +Zowe server components can be installed and run entirely on z/OS, but a subset of the components can alternatively run on Linux or z/Linux via Docker. While on z/OS, many of these components run under UNIX System Services (USS). The components that do not run under USS must remain on z/OS when using Docker in order to provide connectivity to the mainframe. + +## Zowe architecture with high availability enablement on Sysplex + +The following diagram illustrates the difference in locations of Zowe components when deploying Zowe into a Sysplex with high availability enabled as opposed to running all components on a single z/OS system. + +![Zowe Architecture Diagram with High Availability Enablement](../images/common/zowe-architecture-lpar.png) + +Zowe has a high availability feature built in. To enable this feature, you can define the `haInstances` section in your YAML configuration file. + +The preceding diagram shows that `ZWESLSTC` has started two Zowe instances running on two separate LPARs that can be on the same or different sysplexes. + +- Sysplex distributor port sharing enables the API Gateway 7554 ports to be shared so that incoming requests can be routed to either the Gateway on LPAR A or LPAR B. +- The discovery servers on each LPAR communicate with each other and share their registered instances, which allows the API Gateway on LPAR A to dispatch APIs to components either on its own LPAR, or alternatively to components on LPAR B. As indicated in the diagram, each component has two input lines: one from the API Gateway on its own LPAR and one from the Gateway on the other LPAR. When one of the LPARs goes down, the other LPAR remains operating within the Sysplex, thereby providing high availability to clients that connect through the shared port irrespective of which Zowe instance is serving the API requests. + +The `zowe.yaml` file can be configured to start Zowe instances on more than two LPARS, and also to start more than one Zowe instance on a single LPAR, thereby providing a grid cluster of Zowe components that can meet availability and scalability requirements. + +The configuration entries of each LPAR in the `zowe.yaml` file control which components are started. This configuration mechanism makes it possible to start just the desktop and API Mediation Layer on the first LPAR, and start all of the Zowe components on the second LPAR. Because the desktop on the first LPAR is available to the Gateway of the second LPAR, all desktop traffic is routed there. + +The caching services for each Zowe instance, whether on the same LPAR, or distributed across the sysplex, are connected to each other by the same shared VSAM data set. This arrangement allows state sharing so that each instance behaves similarly to the user irrespective of where their request is routed. + +For simplification of the preceding diagram, the Jobs and Files API servers are not shown as being started. If the user defines Jobs and Files API servers to be started in the `zowe.yaml` configuration file, these servers behave the same as the servers illustrated. In other words, these services register to their API discovery server which then communicates with other discovery servers on other Zowe instances on either the same or other LPARs. The API traffic received by any API Gateway on any Zowe instance is routed to any of the Jobs or Files API components that are available. + +To learn more about Zowe with high availability enablement, see [Configuring Sysplex for high availability](../user-guide/configure-sysplex.md). + +## Zowe architecture when running in Kubernetes cluster + +The following diagram illustrates the difference in locations of Zowe components when deploying Zowe into a Kubernetes cluster as opposed to running all components on a single z/OS system. + +![Zowe Architecture Diagram in Kubernetes](../images/common/zowe-architecture-k8s.png) + +When deploying other server components into container orchestration software like Kubernetes, Zowe follows standard Kubernetes practices. The cluster can be monitored and managed with common Kubernetes administration methods. + +- All Zowe workloads run on a dedicated namespace (`zowe` by default) to distinguish from other workloads in same Kubernetes cluster. +- Zowe has its own `ServiceAccount` to help with managing permissions. +- Server components use similar `zowe.yaml` on z/OS, which are stored in `ConfigMap` and `Secret`, to configure and start. +- Server components can be configured by using the same certificates used on z/OS components. +- Zowe claims its own `Persistent Volume` to share files across components. +- Each server component runs in separated containers. +- Components may register themselves to Discovery with their own `Pod` name within the cluster. +- Zowe workloads use the `zowe-launch-scripts` `initContainers` step to prepare required runtime directories. +- Only necessary components ports are exposed outside of Kubernetes with `Service`. + +## App Server + +The App Server is a portable, extensible HTTPS server written in node.js. It can be extended with expressjs routers to add REST or Websocket APIs. This server is responsible for the Zowe Application Framework, including the Desktop which is described later in this page. + +![Zowe Desktop Diagram](../images/mvd/zowe-desktop.png) + +When the API Gateway is running, this server and the Desktop are accessible at `https://:7554/zlux/ui/v1/`. +When the API Catalog is running, this server's API documentation is accessible at the API Catalog tile `Zowe Application Server`, which can be viewed at `https://:7554/apicatalog/ui/v1/#/tile/zlux/zlux`. +When running on z/OS, this server uses the jobname suffix of DS1. + +## ZSS + +Zowe System Services (ZSS) is a z/OS native, extensible HTTPS server which allows you to empower web programs with z/OS functionality due to ZSS' conveniences for writing REST and Websocket APIs around z/OS system calls. The Zowe desktop delegates a number of its services to the ZSS server. + +When the API Gateway is running, this server is accessible at `https://:7554/zss/api/v1`. +When the API Catalog is running, this server's API documentation is accessible at the API Catalog tile `Zowe System Services (ZSS)` which can be viewed at `https://:7554/apicatalog/ui/v1/#/tile/zss/zss` +When running on z/OS, the server uses the jobname suffix of SZ. + +## ZIS + +ZIS is a z/OS native, authorized cross-memory server that allows a secure and convenient way for Zowe programs, primarily ZSS, to build powerful APIs to handle z/OS data that would otherwise be unavailable or insecure to access from higher-level languages and software. As part of Zowe's security model, this server is not accessible over a network but rather empowers the less privileged servers. It runs as a separate STC, `ZWESISTC` to run the program `ZWESIS01` under its own user ID `ZWESIUSR`. + +Unlike all of the servers described above which run under the `ZWESLSTC` started task as address spaces for USS processes, the Cross Memory server has its own separate started task `ZWESISTC` and its own user ID `ZWESIUSR` that runs the program `ZWESIS01`. + +## API Gateway + +The API Gateway is a proxy server that routes requests from clients on its northbound or upstream edge, such as web browsers or the Zowe command line interface, to servers on its southbound (downstream) edge that are able to provide data to serve the request. The API Gateway is also responsible for generating the authentication token used to provide single sign-on (SSO) functionality. The API Gateway homepage is `https://:7554`. Following authentication, this URL enables users to navigate to the API Catalog. + +![Zowe API Mediation Layer](../images/api-mediation/api-mediationlayer.png) + +When the API Gateway is running, this server is accessible at `https://:7554/`. +When running on z/OS, the server uses the jobname suffix of AG. + +## API Catalog + +The API Catalog provides a list of the API services that have registered themselves as catalog tiles. These tiles make it possible to view the available APIs from Zowe's southbound (downstream) servers, as well as test REST API calls. + +![Zowe API Catalog](../images/api-mediation/api-catalog.png) + +When the API Gateway is running, this server is accessible at `https://:7554/apicatalog/ui/v1`. +When the API Catalog is running, this server's API documentation is accessible at the API Catalog tile `Zowe Applications` which can be viewed at `https://:7554/apicatalog/ui/v1/#/tile/apimediationlayer/apicatalog` +When running on z/OS, the server uses the jobname suffix of AC. + +## API Discovery + +The API Discovery server acts as the registration service broker between the API Gateway and its southbound (downstream) servers. This server can be accessed through the URL `https://:7552` making it possible to view a list of registered API services on the API discovery homepage. + +![Zowe API Discovery](../images/api-mediation/api-discovery.png) + +When running on z/OS, the server uses the jobname suffix of AD. + +## Caching service + +The Caching service aims to provide an API which offers the possibility to store, retrieve, and delete data associated with keys. The service is used only by internal Zowe applications and is not exposed to the internet. The Caching service URL is `https://:7555`. +For more information about the Caching service, see [Using the Caching Service](../user-guide/api-mediation/api-mediation-caching-service). + +When the API Gateway is running, this server is accessible at `https://:7554/cachingservice/api/v1`. +When the API Catalog is running, this server's API documentation is accessible at the API Catalog tile `Zowe Applications` which can be viewed at `https://:7554/apicatalog/ui/v1/#/tile/zowe/cachingservice`. +When running on z/OS, the server uses the jobname suffix of CS. + +## Desktop Apps + +Zowe provides a number of rich GUI web applications for working with z/OS. Such applications include the Editor for files and datasets, the JES Explorer for jobs, and the IP Explorer for the TCPIP stack. You can access them through the Zowe desktop. + +![Zowe Desktop Explorers](../images/mvd/desktop-explorers.png) + +### File API and JES API + +The File API server provides a set of REST APIs for working with z/OS data sets and Unix files. These APIs can be enabled in Zowe server configuration. + +The JES API server provides a set of REST APIs for working with JES. These APIs can be enabled in Zowe server configuration. + +Both the File API and JES API servers are registered as tiles in the API Catalog, so users can view the Swagger definition and test API requests and responses. + + diff --git a/versioned_docs/version-v2.15.x/getting-started/zowe-certificates-overview.md b/versioned_docs/version-v2.15.x/getting-started/zowe-certificates-overview.md new file mode 100644 index 0000000000..09c4c055a0 --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/zowe-certificates-overview.md @@ -0,0 +1,138 @@ +# Zowe Certificates overview + +In order to leverage certificates in Zowe, it is useful to review the key concepts of digital certificates-based security and how Zowe implements this technology. + +- [Digital certificates definition](#digital-certificates-definition) +- [Digital certificates usage](#digital-certificates-usage) +- [PKI (Public Key Infrastructure)](#public-key-infrastructure) +- [Transport Layer Security (TLS)](#transport-layer-security) +- [Digital certificates types](#digital-certificates-types) +- [Certificates storage](#certificates-storage) + +## Digital certificates definition +A Digital Certificate is an electronic file that is tied to a cryptographic (public and private) key pair and authenticates the identity of a website, individual, organization, user, device or server. +The de facto standard is the x.509 family type of certificates, which are the foundation behind [Public Key Infrastructure (PKI)](#public-key-infrastructure) security. + +An X.509 certificate binds an identity to a public key using a digital signature. +A certificate contains an identity (a hostname, or an organization, or an individual) and a public key (RSA, DSA, ECDSA, ed25519, etc.). + +Certificates can be self-signed or issued by a Certificate Authority (CA). A CA is an organization which provides infrastructure for the creation, validation, and revocation of certificates according to contemporary security standards. + +:::note +For testing purposes of Zowe, it is acceptable to use certificates issued and signed either by a company local CA, or certificates that are signed by a CA created by Zowe security tools specific for the target technology platform. Use of self-signed certificates is **not recommended** for production environments. +::: + +## Digital certificates usage + +Digital certificates according to x.509 standard specification are the cornerstone for securing communication channels between clients and servers. + +X.509 Digital certificates are primarly used to implement the following functions: +- Verification of the identity of a sender/receiver of an electronic message during TLS handshake. +- Encryption/Decryption of the messages between the sender and the receiver. +- Identification of client-service users. + +Zowe uses digital certificates as a foundational element for both communication and for identity security. +Additionally, Zowe provides a client identity validation functionality based on the ownership of the provided x.509 client certificate and the mainframe security authentication mechanism. + +For more information about how Zowe leverages certificates, see [Zowe certificate usage](../user-guide/use-certificates.md). + +To review the various Zowe certificate configuration options, see the [Zowe certificate configuration overview](../user-guide/configure-certificates.md). + +## Public key infrastructure +[Public Key Infrastructure (PKI)](https://en.wikipedia.org/wiki/Public_key_infrastructure) is a key element of internet security. PKI is both the technology and processes that make up the framework for encryption to protect and authenticate digital communications. +PKI includes software, hardware, policies, and procedures that are used to create, distribute, manage, store, and revoke digital certificates and manage public-key encryption. + +For detailed information about Public Key Infrastructure (PKI), see [How Does PKI Work?](https://www.keyfactor.com/education-center/what-is-pki/#section2) in the _Keyfactor_ documentation. + +Visit the following link to learn more about PKI in the context of the [z/OS Cryptographic Services](https://www.ibm.com/docs/en/zos/2.3.0?topic=planning-introducing-pki-services). + +## Transport Layer Security +[Transport Layer Security (TLS)](https://en.wikipedia.org/wiki/Transport_Layer_Security) is a networking cryptography protocol that provides authentication, privacy, and data integrity between two communicating computer applications. +TLS is a successor to Secure Socket Layer (SSL), which was deprecated in 2015. + +:::note +While the transition from SSL 3.0 to TLS 1.0 occurred in 1999, the term SSL continues to be in common usage. At the time of this publication, this technology is still oftentimes referred to as SSL/TLS. +::: + +TLS defines a client-server handshake mechanism to establish an encrypted and secure connection, to ensure the authenticity of the communication between parties. +During the handshake, the parties negotiate an exchange algorithm, cipher suites, and exchange key material to establish a stateful encrypted connection. +The exact steps of the TLS handshake depend on the protocol version/s supported by the client and the server. +The current version at the time of this publication is 1.3, while version 1.2 is widely supported. + +Being familiar with the key concepts and terms describing TLS security helps to properly set up the Zowe servers network security and to troubleshoot configuration issues. The following list presents some of the key concepts and terms: +- Cipher Suite +- Key Exchange +- Symmetric Encryption +- Asymmetric Encryption +- Authentication +- Basic vs mutually-authenticated handshake + + +The following diagram illustrates the TLS handshake steps: + +![TLS handshake v 1.2](../images/certificates/ssl-handshake-10-steps.png) + +The architecture of Zowe strictly relies on Transport Layer Security (TLS) to secure communication channels between Zowe components, +as well as between client applications and Zowe server components. + +For more information, see the [TLS requirements in Zowe API ML requirements](../extend/extend-apiml/zowe-api-mediation-layer-security-overview#zowe-api-ml-tls-requirements). + +:::note +When installed on a mainframe system, Zowe is able to utilize AT-TLS implementation if supported by the corresponding z/OS version/installation. For more information, see [Configuring AT-TLS for API Mediation Layer](../user-guide/api-mediation/configuration-at-tls.md). +::: + +## Digital certificates types +Zowe's architecture also distinguishes several aspects of PKI artifacts and their usage. Based on these artifacts and use-cases, users can determine which certificate type to use. +Some certificate types are specific for a given technology, while others are generic and applicable across a wider spectrum of platforms. + +Certificates come in various file formats and can be stored in different [certificates storage](#certificates-storage) types. + +Digital X.509 certificates can be issued in various file formats such as PEM, DER, PKCS#7 and PKCS#12. +PEM and PKCS#7 formats use Base64 ASCII encoding, while DER and PKCS#12 use binary encoding. + +The choice of certificate format depends on the technologies used in the implementation of the server components and on the certificate storage type. +For example, Java servers can use JKS and JCEKS keystores, which are specific for the platform. + +Zowe supports: +* **file-based PKCS12** + PKCS12 certificates are the most general and widely deployed certificate format. +* **z/OS keyring-based keystore (JKS/JCEKS)** + JKS/JCEKS certificates are specific types of certificates that depend on the Java environment. + +:::note +Java 9 and higher can also work with PKCS12 certificates. +::: + +## Certificates storage + +There are two options for the storage of certificates: + +* Keystore and Truststore combination +* SAF Keyrings + +### Keystore and Truststore + +Two key concepts to understand storage and verification of certificates are keystores and truststores. + +* **Keystores** are used to store certificates and the verification of these certificates. +* **Truststores** are used to store the verification. + +Zowe supports keystores and truststores that are either z/OS keyrings (when on z/OS) or PKCS12 files. By default, Zowe reads a PKCS12 keystore from `keystore` directory in zowe.yaml. This directory contains a server certificate, the Zowe generated certificate authority, and a `truststore` which holds intermediate certificates of servers that Zowe communicates with (for example z/OSMF). + +#### Keystores +Zowe can use PKCS12 certificates stored in USS to encrypt TLS communication between Zowe clients and Zowe z/OS servers, as well as intra z/OS Zowe server to Zowe server communication. Zowe uses a `keystore` directory to contain its external certificate, and a `truststore` directory to hold the public keys of servers which Zowe communicates with (for example z/OSMF). + +#### Truststores +Truststores are essential to provide secure communication with external services. The truststore serves as a secure repository for storing certificates and trust anchors. In the context of Zowe, the truststore establishes the trust relationships with external services as well as manages the relationship between Zowe's components and the certificates presented by the external services. + +In addition to utilizing the intra-address space of certificates, Zowe incorporates external services on z/OS to enhance the encryption of messages transmitted between its servers. These external services, such as z/OSMF or Zowe conformant extensions, have registered themselves with the API Mediation Layer. + +The API Mediation Layer, acting as an intermediary, validates these certificates. When the API ML receives a certificate from an external service, it examines each certificate in the certificate chain and compares it to the certificates in the truststore. + +By leveraging the truststore, Zowe ensures that only trusted and authorized external services can establish communication with its servers. + +### SAF Keyring + +An alternative to certificate storage with keystores and trustores is to use a SAF Keyring. Use of a SAF Keyring is more secure than PKCS12 files. This SAF keyring method also makes it possible to import an existing certificate or generate new certificates with Top Secret, ACF2, and RACF. + +For details about SAF Keyring, see the documentation [API ML SAF Keyring](../extend/extend-apiml/certificate-management-in-zowe-apiml.md#api-ml-saf-keyring) in the article **Certificate management in Zowe API Mediation Layer**. diff --git a/versioned_docs/version-v2.15.x/getting-started/zowe-high-availability.md b/versioned_docs/version-v2.15.x/getting-started/zowe-high-availability.md new file mode 100644 index 0000000000..e90cdaa827 --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/zowe-high-availability.md @@ -0,0 +1,40 @@ +# High Availability + +In order to deploy Zowe in high availability (HA) mode, it is necessary to set up a Parallel Sysplex® environment. A Parallel Sysplex is a cluster of z/OS® systems that cooperatively use certain hardware and software components to achieve a high-availability workload processing environment. A production instance with this High Availability setup is required to achieve the necessary availability. + +## Sysplex architecture and configuration + +A Sysplex is required to make sure multiple Zowe instances can work together. For more configuration details, see [Configuring Sysplex for high availability](../user-guide/configure-sysplex). + +To enable high availability when Zowe runs in a Sysplex, it is necessary to meet the following requirements: + +- The Zowe instance is installed on every LPAR. +- The API services are registered to each Zowe instance. +- A shared file system is created between LPARs in the Sysplex. For details, see [How to share file systems in a Sysplex](https://www.ibm.com/docs/en/zos/2.4.0?topic=planning-sharing-file-systems-in-sysplex). +- z/OSMF High Availability mode is configured. For details, see [Configuring z/OSMF high availability in Sysplex](../user-guide/systemrequirements-zosmf-ha). +- The instance on every LPAR is started. + +**Configuration with high availability** + +The configuration for the specific instance is composed of the defaults in the main section and the overrides in the `haInstances` section of the `zowe.yaml` configuration file. + +In this section, `ha-instance` represents any Zowe high availability instance ID. Every instance has an internal id and a section with overrides compared to the main configuration in the beginning of the `zowe.yaml` file. For more information, see [Zowe YAML configuration reference](../appendix/zowe-yaml-configuration#yaml-configurations---hainstances). + +## Caching service setup and configuration + +Zowe uses the Caching Service to centralize the state data persistent in high availability (HA) mode. This service can be used to share information between services. + +If you are running the Caching Service on z/OS, there are three storage methods with their own characteristics: + +- [Infinispan (*recommended*)](../extend/extend-apiml/api-mediation-infinispan.md#infinispan-configuration) + - Part of the Caching service + - Does not need separate processes + - Highly performant +- [VSAM](../user-guide/configure-caching-service-ha.md#vsam) + - Familiar to z/OS engineers + - Slow +- [Redis](../extend/extend-apiml/api-mediation-redis.md#redis-configuration) + - Needs to run in Distributed world separately + - Good for Kubernetes deployment + + diff --git a/versioned_docs/version-v2.15.x/getting-started/zowe-office-hours.md b/versioned_docs/version-v2.15.x/getting-started/zowe-office-hours.md new file mode 100644 index 0000000000..50d1915835 --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/zowe-office-hours.md @@ -0,0 +1,117 @@ +# Zowe V2 office hours videos + +Watch the series of Zowe office hours videos to learn more about the new features and enhancements in Zowe Version 2 release. + +## Office hours for Zowe extenders + +The following videos walk you through Zowe V2 updates from an extender's perspective. You can start with general information and dive deeper in other sections for more details. + +### General information + + + + + + + +
    +
    + + General information +
    +
    +
    + + Updates for extenders +
    +
    +
    + + Wrap-up session +
    +
    + +### Zowe component updates + + + + + + + + +
    +
    + + Zowe CLI +
    +
    +
    + + Zowe API Mediation Layer +
    +
    +
    + + Zowe Application Framework +
    +
    +
    + + Zowe Explorer +
    +
    + +### Installation and V2 conformance + + + + + + +
    +
    + + SSO and APIML SSO Conformance +
    +
    +
    + + Systems and installation +
    +
    + +## Office hours for Zowe consumers + +The following office hours walk you through Zowe V2 updates from a consumer's perspective. Watch these videos to learn more about the enhancements that are introduced to each core component. + +### Zowe component updates + + + + + + + + +
    +
    + + Zowe CLI +
    +
    +
    + + Zowe API Mediation Layer +
    +
    +
    + + Zowe Application Framework +
    +
    +
    + + Zowe Explorer +
    +
    diff --git a/versioned_docs/version-v2.15.x/getting-started/zowe-resources.md b/versioned_docs/version-v2.15.x/getting-started/zowe-resources.md new file mode 100644 index 0000000000..4e082d85d8 --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/zowe-resources.md @@ -0,0 +1,75 @@ +# Zowe learning resources + +Learn more about Zowe from these blog posts, videos, and other resources. + +## Blogs + +- [Zowe blogs on Medium](https://medium.com/zowe) +- [Zowe blogs on Open Mainframe Project website](https://www.openmainframeproject.org/category/blog/zowe) + +Want to contribute a blog? Details for how to contribute to the [Zowe blogs on Medium](https://medium.com/zowe) site are at [Zowe Blog Guidelines](https://github.com/zowe/community/blob/master/blogging/blog_guidelines.md). + +## Videos + + + +As well as [Zowe videos](https://www.youtube.com/embed?listType=playlist&list=PL8REpLGaY9QE_9d57tw3KQdwSVLKuTpUZ) owned and managed by the community, there are a number of external youtubers who host Zowe related content. + +- [Zowe Demos playlist from Bill Pereira](https://www.youtube.com/playlist?list=PLM85SdWDWtebJ13Kww8rxKlDlWe72D7b3) +- [Mainframe Bytes channel from Jessielaine Punongbayan](https://www.youtube.com/channel/UCZrvxFwT1GpvJuFRyqc5uWg) + + +## Webinars + +Find out what's happening with Zowe in the Zowe Quarterly Update Webinar Series. + +- [Zowe Quarterly Update Webinar: October 2021](https://youtu.be/b0Xo6WIy3vc) +- [Zowe Quarterly Update Webinar: July 2021](https://youtu.be/T3Z4hMwElII) +- [Zowe Quarterly Update Webinar: April 2021](https://youtu.be/9rQCcZGVDzQ) +- [Zowe Quarterly Update Webinar: January 2021](https://youtu.be/ZEwd8wZvbIw) +- [Zowe Quarterly Update Webinar: October 2020](https://youtu.be/GbAFO5vzBhw) + +The [OMP Youtube channel](https://www.youtube.com/channel/UC-WTXQQtz2m5iTflJLK59aw/videos) also offers other webinars about Zowe. +- [Treat Yourself to a Guided, Comprehensive Tour of Zowe Desktop Applications](https://youtu.be/cbEVbcsaGCs) +- [Zowe Webinar Feb. 22, 2019](https://youtu.be/XixEltbRmds) +- [Open Mainframe Project Webinar: Zowe Virtual Hackathon](https://youtu.be/zIPzaQK2bfU) + + +## Community + +**Join us on Slack** + +- [Slack invite link](https://slack.openmainframeproject.org/) +- [Introduction to Zowe Slack channels](https://github.com/zowe/community/blob/master/README.md#slack) + +**Learn more about the community** + +- [Zowe community GitHub repo](https://github.com/zowe/community/blob/master/README.md) + + Find out information about Zowe sub-projects, GitHub repos, mailing lists, community meeting minutes, contribution guidelines, and so on. + +**Connect with the community through meetings** + +- [Zowe meeting calendar](https://lists.openmainframeproject.org/g/zowe-dev/calendar) + + You can join one of the Zowe meetings to get latest Zowe updates and get involved in different squads and initiatives. + +## Training + +**Courses** + +- [Zowe Fundamentals](https://interskill.com/course/zowe-training/) + + Interskill Learning offers a free training course that introduces the components that comprise Zowe and the benefits of using Zowe and how its capabilities can be extended. + +**Trials** + +- [Zowe trial](https://early-access.ibm.com/software/support/trial/cst/welcomepage.wss?siteId=936&tabId=2216&w=1&mhsrc=ibmsearch_a&mhq=Zowe%20trial) + + The Zowe trial hosted by IBM is a fully configured z/OS environment with Zowe preinstalled and set up along with a set of integrated easy-to-follow tutorials that walk you through the basics of Zowe and gives you hands-on experience of extending Zowe. This no-charge trial is available in two hours for three days. + +- [Get started with the Zowe Web UI](https://developer.ibm.com/components/ibmz/tutorials/zowe-step-by-step-tutorial/) + + This online tutorial hosted by IBM guides you to add new apps to the Zowe Web UI. It provides a public hosted Zowe instance that allows you to perform the steps in a z/OS environment. + + diff --git a/versioned_docs/version-v2.15.x/getting-started/zowe-security-authentication.md b/versioned_docs/version-v2.15.x/getting-started/zowe-security-authentication.md new file mode 100644 index 0000000000..e38b6d6858 --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/zowe-security-authentication.md @@ -0,0 +1,53 @@ +# Zowe User Authentication +The API Mediation Layer provides multiple methods which clients can use to authenticate. + +* [Authentication with JSON Web Tokens (JWT)](#authentication-with-json-web-tokensjwt) +* [Authentication with client certificates](#authentication-with-client-certificates) +* [Authentication with Personal Access Token (PAT)](#authentication-with-personal-access-token-pat) +* [Authentication with SAF Identity Tokens](#authentication-with-saf-identity-tokens) +* [Multi-factor authentication (MFA)](#multi-factor-authentication-mfa) +* [Certificate Authority Advanced Authentication Mainframe (CA AAM)](#certificate-authority-advanced-authentication-mainframe-ca-aam) + +## Authentication with JSON Web Tokens(JWT) + +When the user successfully authenticates with the API ML, the client receives a JWT token in exchange. This token can be used by the client to access REST services behind the API ML Gateway and also for subsequent user authentication. The access JWT Token is signed with the private key that is configured in the Zowe Identity Provider's certificate store, regardless of whether the token is in a keystore or keyring. + +To utilize [Single-Sign-On (SSO)](../user-guide/api-mediation-sso.md), the Zowe API ML client needs to provide an access token to API services in the form of the cookie `apimlAuthenticationToken`, or in the `Authorization: Bearer` HTTP header as described in [this authenticated request example](https://github.com/zowe/sample-spring-boot-api-service/blob/master/zowe-rest-api-sample-spring/docs/api-client-authentication.md#authenticated-request). + +## Authentication with client certificates + +If the keyring or a truststore contains at least one valid certificate authority (CA) other than the CA of the API ML, it is possible to use client certificates issued by this CA to authenticate to the API ML. + +For more information, see the [Authentication for API ML services documentation](../extend/extend-apiml/authentication-for-apiml-services.md) + +## Authentication with Personal Access Token (PAT) + +A Personal Access Token (PAT) is a specific scoped JWT with a configurable validity duration. The PAT authentication method is an alternative to using a client certificate for authentication. It is disabled by default. To enable this functionality, see [Enabling single sign on for clients via personal access token configuration](../user-guide/api-mediation/configuration-personal-access-token.md). + +**Benefits of PAT** + +- Long-lived. The maximum validity is 90 days. +- Scoped. Users are required to provide a scope. It is only valid for the specified services. +- Secure. If a security breech is suspected, the security administrator can invalidate all the tokens based on criteria as established by rules. + +For more information about PAT, see [Authenticating with a Personal Access Token documentation](../user-guide/api-mediation/authenticating-with-personal-access-token.md). + +## Authentication with SAF Identity Tokens +The SAF Authentication Provider allows the API Gateway to authenticate the user directly with the z/OS SAF provider that is installed on the system. + +For more information about configuring the token, see [Configure signed SAF Identity tokens (IDT)](../user-guide/configure-zos-system.md#configure-signed-saf-identity-tokens-idt). + +## Multi-factor authentication (MFA) + +Multi-factor authentication is provided by third-party products which Zowe is compatible with. The following are known to work with Zowe: +- [CA Advanced Authentication Mainframe](https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-advanced-authentication-mainframe/2-0.html) +- [IBM Z Multi-Factor Authentication](https://www.ibm.com/products/ibm-multifactor-authentication-for-zos). + +Additionally, Zowe API ML can be configured to accept OIDC/OAuth2 user authentication tokens. In this particular case, MFA support is built into the OIDC provider system. +It does not rely on the mainframe MFA technology, but is equally secure. + +For details about multi-factor authentication, see [the MFA documentation here](../user-guide/mvd-configuration.md#multi-factor-authentication-configuration). + +## Certificate Authority Advanced Authentication Mainframe (CA AAM) + +To add a dynamic element to the authentication, you can configure the Certificate Authority Advanced Authentication Mainframe to enable multi-factor authentication. For more information about CA AAM, see the [Advanced Authentication Mainframe documentation](https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-advanced-authentication-mainframe/2-0.html). diff --git a/versioned_docs/version-v2.15.x/getting-started/zowe-security-overview.md b/versioned_docs/version-v2.15.x/getting-started/zowe-security-overview.md new file mode 100644 index 0000000000..e0ead2e71c --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/zowe-security-overview.md @@ -0,0 +1,77 @@ +# Zowe Security Overview + +Zowe implements comprehensive measures to secure mainframe services and data resources in transition and in rest: + +- Digital certificates are used by Zowe to facilitate secure electronic communication and data exchange between people, systems, and devices online. +- User identity is authenticated through modern authentication methods such as OIDC/Oauth2, Multi-Factor Authentication (MFA), JWT, or Personal Access Token (PAT). +- User access is authorized by System Authorization Facility (SAF) / External Security Manager (ESM). + +Before installation and use of Zowe server-side components, it is practical to first learn about the core security features built into the Zowe architecture. + +This document provides an overview of the security technologies and features implemented by Zowe and links to Zowe practical guides on how to achieve specific tasks and goals. + +**Note:** If you are familiar with security technologies and concepts such as digital certificates, authentication, authorization, and z/OS security, +you may prefer to skip the introductory sections, and see the [Additional resources section](#additional-resources) at the end of this article +to jump directly to the security related technical guidance provided on how to Set up Zowe, Use Zowe or Extend Zowe. + +Review the following sections to learn about how Zowe leverages modern security concepts and technologies: + - [Digital certificates](#digital-certificates) + - [User Authentication](#user-authentication) + - [Access Authorization](#access-authorization) + +## Digital certificates + +A Digital Certificate is an electronic file that is tied to a cryptographic (public and private) key pair and authenticates the identity of a website, individual, organization, user, device or server. +The de-facto standard is the x.509 family type of certificates, which are the foundation behind Public Key Infrastructure (PKI) security. +An X.509 certificate binds an identity to a public key using a digital signature. +A certificate contains an identity (a hostname, or an organization, or an individual) and a public key (RSA, DSA, ECDSA, ed25519, etc.). + +A certificate can be self-signed or issued by a Certificate Authority (CA). A CA is a trusted organization which provides infrastructure for creation, validation and revocation of the certificates according to the contemporary security standards. + +**Note:** +For testing purposes of Zowe, it is acceptable to use certificates issued and signed either by the company's local CA, or even self-signed certificates issued by Zowe security tools specific for the target technology platform. +Use of self-signed certificates, however, is not recommended for production environments. + +**Tip:** Review digital certificates terminology in the [Zowe security glossary](../appendix/zowe-security-glossary#certificate-concepts) before getting started with configuring certificates. + +### Digital certificates usage +Zowe uses digital certificates to secure the communication channel between Zowe components as well as between Zowe clients and Zowe services. Digital client certificates can also be used to validate that a client-user (the service user) identity is known to the mainframe security facility. + +**Next Steps:** +- Read more about digital certificates mechanics in the [Use certificates](../user-guide/use-certificates.md) in the Zowe documentation. +- Read the [Zowe certificate configuration overview](../user-guide/configure-certificates.md) article in the Zowe User Guide documentation to understand the various options for Zowe certificate configuration. + +## User Authentication +Zowe always authenticates the users accessing its interfaces and services. + +Zowe API ML implements a Singls-Sign-On feature which allows users to authenticate once, whereby users can access all mainframe resources that they are granted access rights to for the period in which the Zowe credentials remain valid. + +API ML uses multiple authentication methods - from Basic Auth (username-password), to external Multi-Factor Authentication providers, and modern authentication protocols, such as OIDC/OAuth2. + +**Next steps:** +- For more details on the authentication methods used by Zowe, see the dedicated [API ML User Authentication](./zowe-security-authentication) article. + +## Access Authorization +[Authorization](https://en.wikipedia.org/wiki/Authorization "Authorization refers to the mechanism of granting specific permissions to users for accessing particular resources or functions.") is the mechanism by which a security system grants or rejects access to protected resources. + +Zowe fully relies on the SAF/ESM for control on the user access to mainframe resources. Authorization is processed by SAF when a mainframe service attempts to access these services under the identity of the user authenticated by Zowe. + +**Tip:** +We recommend you review the core [Authorization](https://en.wikipedia.org/wiki/Authorization "Is any mechanism by which a system grants or revokes the right to access some data or perform some action.") concepts by reading the +related topics in the [Zowe Security Glossary](../appendix/zowe-security-glossary). + +### SAF resource check +In some cases Zowe API ML can check for the authorization of the user on certain endpoints even before the request is propagated to the target mainframe service. +Access to a SAF resource is checked with the installed z/OS External Security Manager (ESM). + +**Next steps:** +For detailed information, see the [SAF resource checking documentation](../user-guide/api-mediation/configuration-saf-resource-checking). + +## Additional resources +For more information about getting started with certificates including dertermining your certificate configuration use case, importing certificates, generating certificates and using certificates, see the following resources: + +- [Use-case based certificates configuration scenarios](../user-guide/certificate-configuration-scenarios.md) +- [Generate certificates for Zowe servers](../user-guide/generate-certificates.md) +- [Import certificates](../user-guide/import-certificates.md) +- [Configure Zowe to use certificates](../user-guide/configure-certificates.md) + diff --git a/versioned_docs/version-v2.15.x/getting-started/zowe_faq.md b/versioned_docs/version-v2.15.x/getting-started/zowe_faq.md new file mode 100644 index 0000000000..2c33ff02b7 --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/zowe_faq.md @@ -0,0 +1,562 @@ +# Zowe FAQ + +Check out the following FAQs to learn more about the purpose and function of Zowe™. + +- [Zowe FAQ](#zowe-faq) +- [Zowe CLI FAQ](#zowe-cli-faq) +- [Zowe Explorer FAQ](#zowe-explorer-faq) + +## Zowe FAQ + +### What is Zowe? + +
    + + + +Zowe is an open source project within the [Open Mainframe Project](https://www.openmainframeproject.org/) that is part of [The Linux Foundation](https://www.linuxfoundation.org). The Zowe project provides modern software interfaces on IBM z/OS to address the needs of a variety of modern users. These interfaces include a new web graphical user interface, a script-able command-line interface, extensions to existing REST APIs, and new REST APIs on z/OS. + +
    + +### Who is the target audience for using Zowe? + +
    + + + +Zowe technology can be used by a variety of mainframe IT and non-IT professionals. The target audience is primarily application developers and system programmers, but the Zowe Application Framework is the basis for developing web browser interactions with z/OS that can be used by anyone. + +
    + +### What language is Zowe written in? + +
    + + + +Zowe consists of several components. The primary languages are Java and JavaScript. Zowe CLI and Desktop are written in TypeScript. ZSS is written in C, while the cross memory server is written in metal C. + +
    + +### What is the licensing for Zowe? + +
    + + + +Zowe source code is licensed under EPL2.0. For license text click [here](https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt) and for additional information click [here](https://www.eclipse.org/legal/epl-2.0/faq.php). + +In the simplest terms (taken from the FAQs above) - "...if you have modified EPL-2.0 licensed source code and you distribute that code or binaries built from that code outside your company, you must make the source code available under the EPL-2.0." + +
    + +### Why is Zowe licensed using EPL2.0? + +
    + + + +The Open Mainframe Project wants to encourage adoption and innovation, and also let the community share new source code across the Zowe ecosystem. The open source code can be used by anyone, provided that they adhere to the licensing terms. + +
    + + +### What are some examples of how Zowe technology might be used by z/OS products and applications? + +
    + + + +The Zowe Desktop (web user interface) can be used in many ways, such as to provide custom graphical dashboards that monitor data for z/OS products and applications. + +Zowe CLI can also be used in many ways, such as for simple job submission, data set manipulation, or for writing complex scripts for use in mainframe-based DevOps pipelines. + +The increased capabilities of RESTful APIs on z/OS allows APIs to be used in programmable ways to interact with z/OS services. + +
    + + +### What is the best way to get started with Zowe? + +
    + + + +Zowe provides a convenience build that includes the components released-to-date, as well as IP being considered for contribution, in an easy to install package on [Zowe.org](https://zowe.org). The convenience build can be easily installed and the Zowe capabilities seen in action. + +To install the complete Zowe solution, see [Installing Zowe](../user-guide/installandconfig.md). + +To get up and running with the Zowe CLI component quickly, see [Zowe CLI quick start](cli-getting-started.md). + +
    + + +### What are the prerequisites for Zowe? + +
    + + + +Prerequisites vary by component used, but in most cases the primary prerequisites are Java and NodeJS on z/OS and the z/OS Management Facility enabled and configured. For a complete list of software requirements listed by component, see [System requirements for z/OS components](../user-guide/systemrequirements-zos.md) and [System requirements for Zowe CLI](../user-guide/systemrequirements-cli.md). + +
    + +### What's the difference between using Zowe with or without Docker? + + + +
    + + + +Docker is a download option for Zowe that allows you to run certain Zowe server components outside of z/OS. +The Docker image contains the Zowe components that do not have the requirement of having to run on z/OS: The App server, API Mediation Layer, and the USS/MVS/JES Explorers. + +Configurating components with Docker is similar to the procedures you would follow without Docker, however tasks such as installation and running with Docker are a bit different, as these tasks become Linux oriented, rather than utilizing Jobs and STCs. + +:::note + +z/OS is still required when using the Docker image. Depending on which components of Zowe you use, you'll still need to set up z/OS Management Facility as well as Zowe's ZSS and Cross memory servers. + +::: + +
    + +### Is the Zowe CLI packaged within the Zowe Docker download? + + + +
    + + + +At this time, the Docker image referred to in this documentation contains only Zowe server components. It is possible to make a Docker image that contains the Zowe CLI, so additional Zowe content, such as the CLI, may have Docker as a distribution option later. + +If you are interested in improvements such as this one, please be sure to express that interest to the Zowe community! + +
    + +### Does ZOWE support z/OS ZIIP processors? + +
    + + + +Only the parts of Zowe that involve Java code are ZIIP enabled. The API Mediation Layer composed of the API Gateway, Discovery and Catalog servers along with any Java-based services that work with them such as the Jobs and Datasets servers are ZIIP enabled. Also, the CLI and VSCode Explorer make large use of z/OSMF, which is Java so they are ZIIP enabled as well. More details on portions of Zowe which are Java (ZIIP) enabled can be found [here](https://docs.zowe.org/stable/getting-started/zowe-architecture#zowe-architecture). + +This leaves C and NodeJS code which are not ZIIP enabled, BUT, we have a [tech preview](https://www.zowe.org/download.html) available currently that allows execution of Java as well as NodeJS code, on Linux or zLinux via Docker. With the tech preview, only the C code remains on z/OS, which is not ZIIP enabled. + +
    + +### How is access security managed on z/OS? + +
    + + + +Zowe components use typical z/OS System authorization facility (SAF) calls for security. + +
    + + +### How is access to the Zowe open source managed? + +
    + + + +The source code for Zowe is maintained on an Open Mainframe Project GitHub server. Everyone has read access. "Committers" on the project have authority to alter the source code to make fixes or enhancements. A list of Committers is documented in [Committers to the Zowe project](https://github.com/zowe/community/blob/master/COMMITTERS.md). + +
    + + +### How do I get involved in the open source development? + +
    + + + +The best way to get started is to join a [Zowe Slack channel](https://slack.openmainframeproject.org/) and/or email distribution list and begin learning about the current capabilities, then contribute to future development. + +For more information about emailing lists, community calendar, meeting minutes, and more, see the [Zowe Community](https://github.com/zowe/community/blob/master/README.md) GitHub repo. + +For information and tutorials about extending Zowe with a new plug-in or application, see [Extending](../extend/extend-apiml/onboard-overview.md) on Zowe Docs. + +
    + + +### Where can I submit an idea for a future enhancement to Zowe? + +
    + + + +Go to the [Zowe Community ReadMe file](https://github.com/zowe/community#submit-an-issue) for information on requesting a bug fix or enhancement. Members of the Zowe community can then review your issue to post feedback or vote their support. Issues are continuously monitored by Zowe squads for improvement ideas. + +
    + + +### When will Zowe be completed? + +
    + + + +Zowe will continue to evolve in the coming years based on new ideas and new contributions from a growing community. + +
    + + +### Can I try Zowe without a z/OS instance? + +
    + + + +IBM has contributed a free hands-on tutorial for Zowe. Visit the [Zowe Tutorial page](https://developer.ibm.com/tutorials/zowe-step-by-step-tutorial/) to learn about adding new applications to the Zowe Desktop and and how to enable communication with other Zowe components. + +The Zowe community is also currently working to provide a vendor-neutral site for an open z/OS build and sandbox environment. + +Zowe is also compatible with IBM z/OSMF Lite for non-production use. For more information, see [Configuring z/OSMF Lite](../user-guide/systemrequirements-zosmf-lite.md) on Zowe Docs. + +
    + +## Zowe CLI FAQ + +### Why might I use Zowe CLI versus a traditional ISPF interface to perform mainframe tasks? + +
    + + + +For developers new to the mainframe, command-line interfaces might be more familiar than an ISPF interface. Zowe CLI lets developers be productive from day-one by using familiar tools. Zowe CLI also lets developers write scripts that automate a sequence of mainframe actions. The scripts can then be executed from off-platform automation tools such as Jenkins automation server, or manually during development. + +
    + + +### With what tools is Zowe CLI compatible? + +
    + + + +Zowe CLI is very flexible; developers can integrate with modern tools that work best for them. It can work in conjunction with popular build and testing tools such as Gulp, Gradle, Mocha, and Junit. Zowe CLI runs on a variety of operating systems, including Windows, macOS, and Linux. Zowe CLI scripts can be abstracted into automation tools such as Jenkins and TravisCI. + +
    + +### Where can I use the CLI? + +
    + + + +| **Usage Scenario** | **Example** | +|------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Interactive use, in a command prompt or bash terminal. | Perform one-off tasks such as submitting a batch job. | +| Interactive use, in an IDE terminal | Download a data set, make local changes in your editor, then upload the changed dataset back to the mainframe. | +| Scripting, to simplify repetitive tasks | Write a shell script that submits a job, waits for the job to complete, then returns the output. | +| Scripting, for use in automated pipelines | Add a script to your Jenkins (or other automation tool) pipeline to move artifacts from a mainframe development system to a test system. | + +
    + +### Which method should I use to install Zowe CLI? + +
    + + + +You can install Zowe CLI using the following methods: + +- **Local package installation:** The local package method lets you install Zowe CLI from a zipped file that contains the core application and all plug-ins. When you use the local package method, you can install Zowe CLI in an offline environment. We recommend that you download the package and distribute it internally if your site does not have internet access. + +- **Online NPM registry:** The online NPM (Node Package Manager) registry method unpacks all of the files that are necessary to install Zowe CLI using the command line. When you use the online registry method, you need an internet connection to install Zowe CLI + +
    + + +### How can I get Zowe CLI to run faster? + +
    + + + +- Zowe CLI runs significantly faster when you run it in daemon mode. Daemon mode significantly improves the performance of Zowe CLI commands by running Zowe CLI as a persistent background process. For more information, see [Using daemon mode](../user-guide/cli-using-using-daemon-mode.md). + +
    + +### How can I manage profiles for my projects and teams? + +
    + + + +- Zowe CLI V2 introduces **team** profiles. Using team profiles helps to improve the initial setup of Zowe CLI by making service connection details easier to share and easier to store within projects. For more information, see [Using team profiles](../user-guide/cli-using-using-team-profiles.md). + +
    + +### Does Zowe CLI support multi-factor authentication (MFA)? + +
    + + + +Yes, Zowe CLI supports MFA through the API Mediation Layer. Without the API ML, an MFA code can be used in place of a password for testing single requests, but storing the MFA code for future requests does not work because the code expires rapidly. + +When mainframe services are routed through the API ML, users can log in to the API ML gateway with an MFA code to obtain a long-lived API ML authentication token that can be stored for future requests. + +
    + +### How can I get help with using Zowe CLI? + +
    + + + +- You can get help for any command, action, or option in Zowe CLI by issuing the command 'zowe --help'. +- For information about the available commands in Zowe CLI, see [Command Groups](../user-guide/cli-using-understanding-core-command-groups). +- If you have questions, the [Zowe Slack space](https://openmainframeproject.slack.com/) is the place to ask our community! + +
    + +### How can I use Zowe CLI to automate mainframe actions? + +
    + + + +- You can automate a sequence of Zowe CLI commands by writing bash scripts. You can then run your scripts in an automation server such as Jenkins. For example, you might write a script that moves your Cobol code to a mainframe test system before another script runs the automated tests. +- Zowe CLI lets you manipulate data sets, submit jobs, provision test environments, and interact with mainframe systems and source control management, all of which can help you develop robust continuous integration/delivery. + +
    + + +### How can I contribute to Zowe CLI? + +
    + + + +As a developer, you can extend Zowe CLI in the following ways: + +- Build a plug-in for Zowe CLI + +- Contribute code to the core Zowe CLI + +- Fix bugs in Zowe CLI or plug-in code, submit enhancement requests via GitHub issues, and raise your ideas with the community in Slack. + + **Note:** For more information, see [Developing for Zowe CLI](../extend/extend-cli/cli-devTutorials.md#how-can-i-contribute). + +
    + +## Zowe Explorer FAQ + +### Why might I use Zowe Explorer versus a traditional ISPF interface to perform mainframe tasks? + +
    + + + +The Zowe Explorer VSCode extension provides developers new to the mainframe with a modern UI, allowing you to access and work with the data set, USS, and job functionalities in a fast and streamlined manner. In addition, Zowe Explorer enables you to work with Zowe CLI profiles and issue TSO/MVS commands. + +
    + +### How can I get started with Zowe Explorer? + +
    + + + +First of all, make sure you fulfill the following Zowe Explorer software requirements: + +- Get access to z/OSMF. +- Install [VSCode](https://code.visualstudio.com/). +- Configure TSO/E address space services, z/OS data set, file REST interface, and z/OS jobs REST interface. For more information, see [z/OS Requirements](https://docs.zowe.org/stable/user-guide/systemrequirements-zosmf#z-os-requirements). +- For development, install [Node.js](https://nodejs.org/en/download/) v14.0 or later. + +Once the software requirements are fulfilled, create a Zowe Explorer profile. + +**Follow these steps:** + +1. Navigate to the explorer tree. +2. Click the **+** button next to the **DATA SETS**, **USS**, or **JOBS** bar. +3. Select the **Create a New Connection to z/OS** option. +4. Follow the instructions, and enter all required information to complete the profile creation. + +You can also watch [Getting Started with Zowe Explorer](https://www.youtube.com/watch?v=G_WCsFZIWt4) to understand how to use the basic features of the extension. + +
    + +### Where can I use Zowe Explorer? + +
    + + + +You can use Zowe Explorer either in [VSCode](https://marketplace.visualstudio.com/items?itemName=Zowe.vscode-extension-for-zowe) or in Theia. For more information about Zowe Explorer in Theia, see [Developing for Theia](https://github.com/zowe/zowe-explorer-vscode/wiki/Developing-for-Theia). + +
    + +### How do I get help with using Zowe Explorer? + +
    + + + +- Use [the Zowe Explorer channel](https://openmainframeproject.slack.com/archives/CUVE37Z5F) in Slack to ask the Zowe Explorer community for help. +- Open a question or issue directly in [the Zowe Explorer GitHub repository](https://github.com/zowe/zowe-explorer-vscode/issues). + +
    + +### How can I use Secure Credential Storage for Zowe Explorer? + +
    + + + +The Secure Credential Store Plug-in is no longer required for Zowe Explorer. + +Secure credential storage functionality is now contained in the Zowe CLI core application, which stores credentials securely by default. + +
    + +### What if Secure Credential Storage does not work in my environment? + +
    + + + +When an environment does not support Secure Credential Storage, it is possible to disable it. See [Disabling Secure Credential Storage of credentials](../user-guide/ze-usage.md#disabling-secure-credential-storage-of-credentials) for more information. + +
    + +### What if I do not want Zowe Explorer to store my credentials? + +
    + + + +Although not recommended in all cases, it is possible to disable Zowe Explorer's credential management functionality. See [Preventing Zowe Explorer from storing credentials](../user-guide/ze-usage.md#preventing-zowe-explorer-from-storing-credentials) for more information. + +
    + +### What types of profiles can I create for Zowe Explorer? + +
    + + + +Zowe Explorer V2 supports using Service Profiles, Base Profiles, and Team Profiles. For more information, see [Using V1 profiles](../user-guide/cli-using-using-profiles-v1.md) and [Team configurations](../user-guide/cli-using-using-team-profiles.md) in the Using Zowe CLI section. + +
    + +### Does Zowe Explorer support multi-factor authentication (MFA)? + +
    + + + +Yes, Zowe Explorer supports MFA through the API Mediation Layer. Without the API ML, an MFA code can be used in place of a password for testing single requests, but storing the MFA code for future requests does not work because the code expires rapidly. + +When mainframe services are routed through the API ML, users can log in to the API ML gateway with an MFA code to obtain a long-lived API ML authentication token that can be stored for future requests. + +
    + +### Is it possible to change the detected language of a file or data set opened in Zowe Explorer? + +
    + + + +Yes, you can configure Visual Studio Code to use a specific language for a particular file extension or data set qualifier. To set file associations, see [Add a file extension to a language](https://code.visualstudio.com/docs/languages/overview#_add-a-file-extension-to-a-language). + +
    + +### How can I use FTP as my back-end service for Zowe Explorer? + +
    + + + +See the [Zowe FTP extension README](https://github.com/zowe/zowe-explorer-ftp-extension/#readme) in GitHub for information about how to install FTP from the Visual Studio Code Marketplace and use it as your back-end service for working with UNIX files. + +
    + +### How can I contribute to Zowe Explorer? + +
    + + + +As a developer, you may contribute to Zowe Explorer in the following ways: + +- Build a Zowe Explorer extension. + +- Contribute code to core Zowe Explorer. + +- Fix bugs in Zowe Explorer, submit enhancement requests via GitHub issues, and raise your ideas with the community in Slack. + + Note: For more information, see [Extending Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode/wiki/Extending-Zowe-Explorer). + +
    + +## Zowe IntelliJ plug-in FAQ + +### Why might I use Zowe IntelliJ plug-in versus a traditional ISPF interface to perform mainframe tasks? + +
    + + + +Zowe IntelliJ plug-in allows you to access and work with data sets, members and jobs directly from your IntelliJ-based IDE. + +
    + +### How can I get started with Zowe IntelliJ plug-in? + +
    + + + +Install the plug-in in your IntelliJ-based IDE directly from marketplace or download it from [here](https://plugins.jetbrains.com/plugin/18688-zowe-explorer). + +
    + +### Where can I use Zowe IntelliJ plug-in? + +
    + + + +You can use it in any IntelliJ-based IDE. + +
    + +### How do I get help with using Zowe IntelliJ plug-in? + +
    + + + +You can read detailed user guide and find any information you need [here](https://plugins.jetbrains.com/plugin/18688-zowe-explorer/user-guide). Also, you can ask any questions in the Zowe Slack channel [#zowe-explorer-intellij](https://openmainframeproject.slack.com/archives/C020BGPSU0M). + +
    + +### How can I create, edit and delete z/OSMF connection? + +
    + + + +To create a connection, expand plug-in panel on an IDE sidebar (on the right side of your screen) and press the "wrench" pictogram, or go to **File** -> **Settings** (CTRL+ALT+S), select **Zowe Explorer (Zowe IntelliJ plugin)** and then switch to the **z/OSMF connection** tab. Press the “+” button and fill inn all necessary fields. + +
    + +### How can I contribute to Zowe IntelliJ plug-in? + +
    + + + +If you have something to introduce but there is no related issue in the project repo, then you can either create the issue by yourself or contact us to help you with it. See more information in the [CONTRIBUTION.md](https://github.com/zowe/zowe-explorer-intellij/blob/main/CONTRIBUTING.md) file. + +
    diff --git a/versioned_docs/version-v2.15.x/getting-started/zowe_v2_faq.md b/versioned_docs/version-v2.15.x/getting-started/zowe_v2_faq.md new file mode 100644 index 0000000000..9ada80ef96 --- /dev/null +++ b/versioned_docs/version-v2.15.x/getting-started/zowe_v2_faq.md @@ -0,0 +1,31 @@ +# Zowe V2 FAQ + +## Where can I find the V1 and V2 LTS conformance criteria? + +The Zowe Squads have prepared XLS spreadsheets with conformance criteria for all Zowe extensions including: CLI, APIs, App Framework, and Explorer for VS Code. The spreadsheets clearly show the prior / V1 criteria alongside the new / V2 criteria. Please be aware, there are additions, deletions, and CHANGES to the criteria. In some cases the change is simply that a BEST PRACTICE has been deemed REQUIRED. Use the included fill color key to identify new changes for V2, reworded changes, or changes from V1 removed in V2. See the Changes to the [Conformance Criteria](https://www.zowe.org/vnext#conformance-changes) section at Zowe.org/vNext. + +## Whats the difference between "server.json" and "example-zowe.yaml"? + +The previous Zowe V1.x config, "server.json", has been removed from V2 and has been replaced with a new yaml configuration file. The app server will no longer support instances/workspaces which only contain a "server.json" config file and will fallback to a default configuration. In addition to the app server, ZSS will no longer support "server.json". + +The yaml Zowe configuration file contains configurations for the setup, install, and initialization of Zowe as well as for individual components. This file allows users to customize dataset names, security related configs, certificate setup/config, job name & job prefix, various runtime configs, high availability config, as well as individual component configurations. + +For more information on Zowe setup and the yaml configuration, run the following command in the command line: + +```zwe init --help``` + +## What are the new default ports? + +Four of the default Zowe ports have changed: the app server, zss, the jobs API, and the files API. The new default app server port is 7556 (previously 8544) and the new zss port is 7557 (previously 8542). The new jobs API port is 7558 (previously 8545) and the new files API is 7559 (previously 8547). The JES/USS/MVS Explorer UI servers have been removed and thus no longer require port configurations. + +## How do I access Zowe through the API Mediation Layer in V2? + +In pervious V1.X versions of Zowe, the desktop could be accessed via the API Medation Layer by navigating to `https://${zowe.externalDomains[0]}:{zowe.externalPort}//ui/v1/zlux`. In Zowe V2, the route to access the desktop has changed to `https://${zowe.externalDomains[0]}:{zowe.externalPort}/zlux/ui/v1`. Such routing structure is applicable to other clients connected to the API Gateway. For example, the API Catalog may be accessed via `https://${zowe.externalDomains[0]}:{zowe.externalPort}/apicatalog/ui/v1`. + +## What new frameworks are supported in V2? + +The Zowe app framework now supports the more modern Angular 12, Corejs 3 and Typescript 4. + +## Why aren't the explorers appearing on my desktop anymore? + +By default, the explorers will not longer appear on the desktop if the instance is not configured to use the API Mediation Layer. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/API Management Components.svg b/versioned_docs/version-v2.15.x/images/api-mediation/API Management Components.svg new file mode 100644 index 0000000000..bdc2acf2b5 --- /dev/null +++ b/versioned_docs/version-v2.15.x/images/api-mediation/API Management Components.svg @@ -0,0 +1 @@ +APICatalogInstance #1ESMMicroserviceInstance #1APIMediationLayer -APIGateway,Catalog,andDiscoveryUser /RESTAPIclientTCP/IPSysplexDistributorAPIGatewayInstance #1APIGatewayInstance #2APIGatewayInstance #nDiscoveryServiceInstance #1DiscoveryServiceInstance #2DiscoveryServiceInstance #nAPICatalogInstance #1ARESTAPIInstance #1ARESTAPIInstance #nAnotherRESTAPIESMMicroserviceInstance #1z/OSProductz/OSProductz/OSProductSecuritycalls (login,accesscheck,PassTicket)PeersynchronizationRegistertoDS,accessotherservicesviagatewayAccesstootherservicesviagatewayortoDiscoveryServiceHeartbeat/Ping \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/API-Catalog-Tile.png b/versioned_docs/version-v2.15.x/images/api-mediation/API-Catalog-Tile.png new file mode 100644 index 0000000000..9ed6fbb9ef Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/API-Catalog-Tile.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/API-Class-Diagram.png b/versioned_docs/version-v2.15.x/images/api-mediation/API-Class-Diagram.png new file mode 100644 index 0000000000..88f3e4c773 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/API-Class-Diagram.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/API-Versioning.png b/versioned_docs/version-v2.15.x/images/api-mediation/API-Versioning.png new file mode 100644 index 0000000000..e81388acd5 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/API-Versioning.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/Basic-Routing.png b/versioned_docs/version-v2.15.x/images/api-mediation/Basic-Routing.png new file mode 100644 index 0000000000..50f1a54938 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/Basic-Routing.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/Expanded-Catalog-Tile.png b/versioned_docs/version-v2.15.x/images/api-mediation/Expanded-Catalog-Tile.png new file mode 100644 index 0000000000..f1788e34c1 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/Expanded-Catalog-Tile.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/Service-Status.png b/versioned_docs/version-v2.15.x/images/api-mediation/Service-Status.png new file mode 100644 index 0000000000..d88ce18f6e Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/Service-Status.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/Service-detail.png b/versioned_docs/version-v2.15.x/images/api-mediation/Service-detail.png new file mode 100644 index 0000000000..8b0f16b222 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/Service-detail.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/api-catalog.png b/versioned_docs/version-v2.15.x/images/api-mediation/api-catalog.png new file mode 100644 index 0000000000..68032a4c36 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/api-catalog.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/api-catalog.pptx b/versioned_docs/version-v2.15.x/images/api-mediation/api-catalog.pptx new file mode 100644 index 0000000000..0580a2d555 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/api-catalog.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/api-discovery.png b/versioned_docs/version-v2.15.x/images/api-mediation/api-discovery.png new file mode 100644 index 0000000000..33731e4a14 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/api-discovery.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/api-discovery.pptx b/versioned_docs/version-v2.15.x/images/api-mediation/api-discovery.pptx new file mode 100644 index 0000000000..46347df415 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/api-discovery.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/api-mediationlayer.png b/versioned_docs/version-v2.15.x/images/api-mediation/api-mediationlayer.png new file mode 100644 index 0000000000..5614493c4a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/api-mediationlayer.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/api-mediationlayer.pptx b/versioned_docs/version-v2.15.x/images/api-mediation/api-mediationlayer.pptx new file mode 100644 index 0000000000..b9fa3f0977 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/api-mediationlayer.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/api-ml-architecture.png b/versioned_docs/version-v2.15.x/images/api-mediation/api-ml-architecture.png new file mode 100644 index 0000000000..272da7261f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/api-ml-architecture.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/api_refresh_button.png b/versioned_docs/version-v2.15.x/images/api-mediation/api_refresh_button.png new file mode 100644 index 0000000000..75866035c3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/api_refresh_button.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/api_refresh_error.png b/versioned_docs/version-v2.15.x/images/api-mediation/api_refresh_error.png new file mode 100644 index 0000000000..1eea5cc446 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/api_refresh_error.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/api_refresh_success.png b/versioned_docs/version-v2.15.x/images/api-mediation/api_refresh_success.png new file mode 100644 index 0000000000..4a52f3865b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/api_refresh_success.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/apiml-architecture.png b/versioned_docs/version-v2.15.x/images/api-mediation/apiml-architecture.png new file mode 100644 index 0000000000..202cf6767c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/apiml-architecture.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/apiml-components.plantuml b/versioned_docs/version-v2.15.x/images/api-mediation/apiml-components.plantuml new file mode 100644 index 0000000000..0f57d73b1b --- /dev/null +++ b/versioned_docs/version-v2.15.x/images/api-mediation/apiml-components.plantuml @@ -0,0 +1,23 @@ +@startuml +archimate #business "User" as user <> +archimate #application "API Client" as apiClient <> +archimate #technology "Gateway Service" as GW <> +archimate #orange "Discovery Service" as DS <> +archimate #technology "API Catalog" as AC <> +archimate #application "API Service" as apiService <> + +archimate #orange "Authentication Service" as AAS <> + +apiClient --> GW: accesses API service\n via GW +AC -up-> DS: registers +GW --> DS: registers +GW --> apiService: routes requests +GW --> AC: routes requests +apiService -up-> DS: registers +apiService -up-> GW: accesses API service\nvia GW +user --> GW: accesses API services\nand catalog via GW +user --> apiClient: user services via API clients + +apiService -> AAS: user authentication\nand authorization +AC -> AAS: user authentication\nand authorization +@enduml diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/apiml-components.svg b/versioned_docs/version-v2.15.x/images/api-mediation/apiml-components.svg new file mode 100644 index 0000000000..aed2fd4761 --- /dev/null +++ b/versioned_docs/version-v2.15.x/images/api-mediation/apiml-components.svg @@ -0,0 +1,37 @@ +UserAPI ClientGateway ServiceDiscovery ServiceAPI CatalogAPI ServiceAuthentication Serviceaccesses API servicevia GWregistersregistersroutes requestsaccesses API servicevia GWroutes requestsregistersaccesses API servicesand catalog via GWuser services via API clientsuser authenticationand authorizationuser authenticationand authorization \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/apiml-oidc-auth-seq.png b/versioned_docs/version-v2.15.x/images/api-mediation/apiml-oidc-auth-seq.png new file mode 100644 index 0000000000..b809022d83 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/apiml-oidc-auth-seq.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/apiml-started.png b/versioned_docs/version-v2.15.x/images/api-mediation/apiml-started.png new file mode 100644 index 0000000000..89ce535c40 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/apiml-started.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/apiml-startup.png b/versioned_docs/version-v2.15.x/images/api-mediation/apiml-startup.png new file mode 100644 index 0000000000..f88676bd68 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/apiml-startup.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/basic-code-snippets.png b/versioned_docs/version-v2.15.x/images/api-mediation/basic-code-snippets.png new file mode 100644 index 0000000000..22c0569b65 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/basic-code-snippets.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/caching-service.png b/versioned_docs/version-v2.15.x/images/api-mediation/caching-service.png new file mode 100644 index 0000000000..8ad397b90e Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/caching-service.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/catalog-new-pass-err.png b/versioned_docs/version-v2.15.x/images/api-mediation/catalog-new-pass-err.png new file mode 100644 index 0000000000..5287adc1d5 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/catalog-new-pass-err.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/catalog-pass-expired-warn.png b/versioned_docs/version-v2.15.x/images/api-mediation/catalog-pass-expired-warn.png new file mode 100644 index 0000000000..1204529555 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/catalog-pass-expired-warn.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/catalog-pass-update-ok.png b/versioned_docs/version-v2.15.x/images/api-mediation/catalog-pass-update-ok.png new file mode 100644 index 0000000000..f9033d6689 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/catalog-pass-update-ok.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/catalog_proctected_endpoints_swagger_auth.png b/versioned_docs/version-v2.15.x/images/api-mediation/catalog_proctected_endpoints_swagger_auth.png new file mode 100644 index 0000000000..c479d888a8 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/catalog_proctected_endpoints_swagger_auth.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/catalog_proctected_endpoints_swagger_lock.png b/versioned_docs/version-v2.15.x/images/api-mediation/catalog_proctected_endpoints_swagger_lock.png new file mode 100644 index 0000000000..6d3c7e31cc Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/catalog_proctected_endpoints_swagger_lock.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/customized-code-snippets.png b/versioned_docs/version-v2.15.x/images/api-mediation/customized-code-snippets.png new file mode 100644 index 0000000000..eb861dc691 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/customized-code-snippets.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/discoverable_clien_pet_swagger.png b/versioned_docs/version-v2.15.x/images/api-mediation/discoverable_clien_pet_swagger.png new file mode 100644 index 0000000000..169737c999 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/discoverable_clien_pet_swagger.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/discoverable_clien_pet_swagger_execute.png b/versioned_docs/version-v2.15.x/images/api-mediation/discoverable_clien_pet_swagger_execute.png new file mode 100644 index 0000000000..7a1a9618be Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/discoverable_clien_pet_swagger_execute.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/discoverable_clien_pet_swagger_expanded.png b/versioned_docs/version-v2.15.x/images/api-mediation/discoverable_clien_pet_swagger_expanded.png new file mode 100644 index 0000000000..a30dd387a3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/discoverable_clien_pet_swagger_expanded.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/discoverable_clien_pet_swagger_response.png b/versioned_docs/version-v2.15.x/images/api-mediation/discoverable_clien_pet_swagger_response.png new file mode 100644 index 0000000000..c636f9ad48 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/discoverable_clien_pet_swagger_response.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/discoverableclient-apiv1.png b/versioned_docs/version-v2.15.x/images/api-mediation/discoverableclient-apiv1.png new file mode 100644 index 0000000000..1f0c11bde2 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/discoverableclient-apiv1.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/discoverableclient-apiv2.png b/versioned_docs/version-v2.15.x/images/api-mediation/discoverableclient-apiv2.png new file mode 100644 index 0000000000..4b95d33b96 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/discoverableclient-apiv2.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/endpoint-detail.png b/versioned_docs/version-v2.15.x/images/api-mediation/endpoint-detail.png new file mode 100644 index 0000000000..22974aa968 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/endpoint-detail.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/envVarsJenkins.png b/versioned_docs/version-v2.15.x/images/api-mediation/envVarsJenkins.png new file mode 100644 index 0000000000..85776a51d1 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/envVarsJenkins.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/expanded.png b/versioned_docs/version-v2.15.x/images/api-mediation/expanded.png new file mode 100644 index 0000000000..8154c5022d Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/expanded.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/graphql-image.png b/versioned_docs/version-v2.15.x/images/api-mediation/graphql-image.png new file mode 100644 index 0000000000..ecaf911e43 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/graphql-image.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/metrics-service-dashboard.png b/versioned_docs/version-v2.15.x/images/api-mediation/metrics-service-dashboard.png new file mode 100644 index 0000000000..14d5a7a66b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/metrics-service-dashboard.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/newheader.png b/versioned_docs/version-v2.15.x/images/api-mediation/newheader.png new file mode 100644 index 0000000000..f2b7da970c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/newheader.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/newswagger.png b/versioned_docs/version-v2.15.x/images/api-mediation/newswagger.png new file mode 100644 index 0000000000..6bd9005ba1 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/newswagger.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/safidt-diagram.png b/versioned_docs/version-v2.15.x/images/api-mediation/safidt-diagram.png new file mode 100644 index 0000000000..e28c302e4c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/safidt-diagram.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/safidt-providers.png b/versioned_docs/version-v2.15.x/images/api-mediation/safidt-providers.png new file mode 100644 index 0000000000..b5374345c4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/safidt-providers.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/sso-diagram.jpeg b/versioned_docs/version-v2.15.x/images/api-mediation/sso-diagram.jpeg new file mode 100644 index 0000000000..1eadc0a174 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/sso-diagram.jpeg differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/wizard-categories.png b/versioned_docs/version-v2.15.x/images/api-mediation/wizard-categories.png new file mode 100644 index 0000000000..094d92c305 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/wizard-categories.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/wizard-enablers.png b/versioned_docs/version-v2.15.x/images/api-mediation/wizard-enablers.png new file mode 100644 index 0000000000..6c4d878d80 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/wizard-enablers.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/wizard-onboard-button.png b/versioned_docs/version-v2.15.x/images/api-mediation/wizard-onboard-button.png new file mode 100644 index 0000000000..28f0f389da Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/wizard-onboard-button.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/wizard-save-button.png b/versioned_docs/version-v2.15.x/images/api-mediation/wizard-save-button.png new file mode 100644 index 0000000000..ad1f8aaf7f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/wizard-save-button.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/wizard-validation.png b/versioned_docs/version-v2.15.x/images/api-mediation/wizard-validation.png new file mode 100644 index 0000000000..ae549bd8a3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/wizard-validation.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/wizard-yaml-prefill.png b/versioned_docs/version-v2.15.x/images/api-mediation/wizard-yaml-prefill.png new file mode 100644 index 0000000000..96f315f9ac Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/wizard-yaml-prefill.png differ diff --git a/versioned_docs/version-v2.15.x/images/api-mediation/zowe-client-cert-auth.png b/versioned_docs/version-v2.15.x/images/api-mediation/zowe-client-cert-auth.png new file mode 100644 index 0000000000..c83460cd22 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/api-mediation/zowe-client-cert-auth.png differ diff --git a/versioned_docs/version-v2.15.x/images/certificates/Full_TLS_1.2_Handshake.svg b/versioned_docs/version-v2.15.x/images/certificates/Full_TLS_1.2_Handshake.svg new file mode 100644 index 0000000000..88fc9eb6bd --- /dev/null +++ b/versioned_docs/version-v2.15.x/images/certificates/Full_TLS_1.2_Handshake.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/images/certificates/TLC-Handshake_Diagram.png b/versioned_docs/version-v2.15.x/images/certificates/TLC-Handshake_Diagram.png new file mode 100644 index 0000000000..d4259bb9f2 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/certificates/TLC-Handshake_Diagram.png differ diff --git a/versioned_docs/version-v2.15.x/images/certificates/connect-JCERACFKS.png b/versioned_docs/version-v2.15.x/images/certificates/connect-JCERACFKS.png new file mode 100644 index 0000000000..75f68a64e8 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/certificates/connect-JCERACFKS.png differ diff --git a/versioned_docs/version-v2.15.x/images/certificates/ssl-handshake-10-steps.png b/versioned_docs/version-v2.15.x/images/certificates/ssl-handshake-10-steps.png new file mode 100644 index 0000000000..eba40f478a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/certificates/ssl-handshake-10-steps.png differ diff --git a/versioned_docs/version-v2.15.x/images/certificates/tls-handshake-textual.webp b/versioned_docs/version-v2.15.x/images/certificates/tls-handshake-textual.webp new file mode 100644 index 0000000000..5315739b25 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/certificates/tls-handshake-textual.webp differ diff --git a/versioned_docs/version-v2.15.x/images/common/2-1.png b/versioned_docs/version-v2.15.x/images/common/2-1.png new file mode 100644 index 0000000000..9a3108e858 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/2-1.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/2-2.png b/versioned_docs/version-v2.15.x/images/common/2-2.png new file mode 100644 index 0000000000..3942796e34 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/2-2.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/2-3.png b/versioned_docs/version-v2.15.x/images/common/2-3.png new file mode 100644 index 0000000000..4abc9fe246 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/2-3.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/2-4.png b/versioned_docs/version-v2.15.x/images/common/2-4.png new file mode 100644 index 0000000000..bca13e0461 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/2-4.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/3-1.png b/versioned_docs/version-v2.15.x/images/common/3-1.png new file mode 100644 index 0000000000..478edda8b3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/3-1.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/Error.png b/versioned_docs/version-v2.15.x/images/common/Error.png new file mode 100644 index 0000000000..b225642fd2 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/Error.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/SampleMicroservesLook.png b/versioned_docs/version-v2.15.x/images/common/SampleMicroservesLook.png new file mode 100644 index 0000000000..409a12f3fc Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/SampleMicroservesLook.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/Zowe-HA-Architecture-View.pptx b/versioned_docs/version-v2.15.x/images/common/Zowe-HA-Architecture-View.pptx new file mode 100644 index 0000000000..7ebf17304a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/Zowe-HA-Architecture-View.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/common/cipher_mismatch.png b/versioned_docs/version-v2.15.x/images/common/cipher_mismatch.png new file mode 100644 index 0000000000..f67e1ea393 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/cipher_mismatch.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/cipher_overlap.png b/versioned_docs/version-v2.15.x/images/common/cipher_overlap.png new file mode 100644 index 0000000000..951e167a4c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/cipher_overlap.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/cli-config-file-table.jpg b/versioned_docs/version-v2.15.x/images/common/cli-config-file-table.jpg new file mode 100644 index 0000000000..3979f5e215 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/cli-config-file-table.jpg differ diff --git a/versioned_docs/version-v2.15.x/images/common/component.svg b/versioned_docs/version-v2.15.x/images/common/component.svg new file mode 100644 index 0000000000..92d1286f9b --- /dev/null +++ b/versioned_docs/version-v2.15.x/images/common/component.svg @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/versioned_docs/version-v2.15.x/images/common/icon_edit_this_file.png b/versioned_docs/version-v2.15.x/images/common/icon_edit_this_file.png new file mode 100644 index 0000000000..25e7fb5ca4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/icon_edit_this_file.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/objective.svg b/versioned_docs/version-v2.15.x/images/common/objective.svg new file mode 100644 index 0000000000..2220a1409a --- /dev/null +++ b/versioned_docs/version-v2.15.x/images/common/objective.svg @@ -0,0 +1,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/versioned_docs/version-v2.15.x/images/common/right-arrow.svg b/versioned_docs/version-v2.15.x/images/common/right-arrow.svg new file mode 100644 index 0000000000..a6ea92d614 --- /dev/null +++ b/versioned_docs/version-v2.15.x/images/common/right-arrow.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-cli-change-success.png b/versioned_docs/version-v2.15.x/images/common/scenario1-cli-change-success.png new file mode 100644 index 0000000000..e4a34e6203 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-cli-change-success.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-cli-downloaded.png b/versioned_docs/version-v2.15.x/images/common/scenario1-cli-downloaded.png new file mode 100644 index 0000000000..95f9db1a9a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-cli-downloaded.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-cli-list-dataset.png b/versioned_docs/version-v2.15.x/images/common/scenario1-cli-list-dataset.png new file mode 100644 index 0000000000..7ecd9f9ebb Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-cli-list-dataset.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-cli-second-change.jpg b/versioned_docs/version-v2.15.x/images/common/scenario1-cli-second-change.jpg new file mode 100644 index 0000000000..c1796a5136 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-cli-second-change.jpg differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-cli-uploaded.png b/versioned_docs/version-v2.15.x/images/common/scenario1-cli-uploaded.png new file mode 100644 index 0000000000..14fd942581 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-cli-uploaded.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-create-dataset-member.png b/versioned_docs/version-v2.15.x/images/common/scenario1-create-dataset-member.png new file mode 100644 index 0000000000..7dd122d5cf Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-create-dataset-member.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-displayed-content-tn3270.png b/versioned_docs/version-v2.15.x/images/common/scenario1-displayed-content-tn3270.png new file mode 100644 index 0000000000..9b68f45c31 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-displayed-content-tn3270.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-enter-5.png b/versioned_docs/version-v2.15.x/images/common/scenario1-enter-5.png new file mode 100644 index 0000000000..8e08db8761 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-enter-5.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-enter-da.png b/versioned_docs/version-v2.15.x/images/common/scenario1-enter-da.png new file mode 100644 index 0000000000..6f736fc890 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-enter-da.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-enter-dataset-name.png b/versioned_docs/version-v2.15.x/images/common/scenario1-enter-dataset-name.png new file mode 100644 index 0000000000..e02a46f52c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-enter-dataset-name.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-enter-ispf.png b/versioned_docs/version-v2.15.x/images/common/scenario1-enter-ispf.png new file mode 100644 index 0000000000..be3a980c37 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-enter-ispf.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-enter-m.png b/versioned_docs/version-v2.15.x/images/common/scenario1-enter-m.png new file mode 100644 index 0000000000..95a205a247 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-enter-m.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-enter-prefix.png b/versioned_docs/version-v2.15.x/images/common/scenario1-enter-prefix.png new file mode 100644 index 0000000000..4f82136f08 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-enter-prefix.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-jes-filter.gif b/versioned_docs/version-v2.15.x/images/common/scenario1-jes-filter.gif new file mode 100644 index 0000000000..b484b10796 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-jes-filter.gif differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-job-listed.png b/versioned_docs/version-v2.15.x/images/common/scenario1-job-listed.png new file mode 100644 index 0000000000..12b63a90f3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-job-listed.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-select-command-prompt.png b/versioned_docs/version-v2.15.x/images/common/scenario1-select-command-prompt.png new file mode 100644 index 0000000000..47d78654a8 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-select-command-prompt.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-tn3270-logon.png b/versioned_docs/version-v2.15.x/images/common/scenario1-tn3270-logon.png new file mode 100644 index 0000000000..dfb066deef Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-tn3270-logon.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/scenario1-view-content-tn3270.png b/versioned_docs/version-v2.15.x/images/common/scenario1-view-content-tn3270.png new file mode 100644 index 0000000000..32bfb3f416 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/scenario1-view-content-tn3270.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-architecture-docker.png b/versioned_docs/version-v2.15.x/images/common/zowe-architecture-docker.png new file mode 100644 index 0000000000..05079762d5 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-architecture-docker.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-architecture-ha.png b/versioned_docs/version-v2.15.x/images/common/zowe-architecture-ha.png new file mode 100644 index 0000000000..05ebdd4bd0 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-architecture-ha.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-architecture-k8s.png b/versioned_docs/version-v2.15.x/images/common/zowe-architecture-k8s.png new file mode 100644 index 0000000000..7a7ae39ce4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-architecture-k8s.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-architecture-lpar.png b/versioned_docs/version-v2.15.x/images/common/zowe-architecture-lpar.png new file mode 100644 index 0000000000..cfd9892e98 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-architecture-lpar.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-architecture.png b/versioned_docs/version-v2.15.x/images/common/zowe-architecture.png new file mode 100644 index 0000000000..5f11f0b012 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-architecture.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-architecture.pptx b/versioned_docs/version-v2.15.x/images/common/zowe-architecture.pptx new file mode 100644 index 0000000000..1378135378 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-architecture.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-desktop-login.png b/versioned_docs/version-v2.15.x/images/common/zowe-desktop-login.png new file mode 100644 index 0000000000..69ccf17a10 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-desktop-login.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-desktop-unable-to-logon.png b/versioned_docs/version-v2.15.x/images/common/zowe-desktop-unable-to-logon.png new file mode 100644 index 0000000000..6c5f012fdb Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-desktop-unable-to-logon.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-desktop-unable-to-logon.pptx b/versioned_docs/version-v2.15.x/images/common/zowe-desktop-unable-to-logon.pptx new file mode 100644 index 0000000000..5c04753679 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-desktop-unable-to-logon.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-directories-keys.png b/versioned_docs/version-v2.15.x/images/common/zowe-directories-keys.png new file mode 100644 index 0000000000..6375e2543c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-directories-keys.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-directories.png b/versioned_docs/version-v2.15.x/images/common/zowe-directories.png new file mode 100644 index 0000000000..be4750d142 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-directories.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-directories.pptx b/versioned_docs/version-v2.15.x/images/common/zowe-directories.pptx new file mode 100644 index 0000000000..7a21b82ee7 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-directories.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-docker-install-diagram.png b/versioned_docs/version-v2.15.x/images/common/zowe-docker-install-diagram.png new file mode 100644 index 0000000000..e073721181 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-docker-install-diagram.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-ha-install-roadmap.png b/versioned_docs/version-v2.15.x/images/common/zowe-ha-install-roadmap.png new file mode 100644 index 0000000000..8f3f28f1ff Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-ha-install-roadmap.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-ha-install-roadmap.pptx b/versioned_docs/version-v2.15.x/images/common/zowe-ha-install-roadmap.pptx new file mode 100644 index 0000000000..e776b9a78d Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-ha-install-roadmap.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-install-location.png b/versioned_docs/version-v2.15.x/images/common/zowe-install-location.png new file mode 100644 index 0000000000..91887f6a1b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-install-location.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-install-location.pptx b/versioned_docs/version-v2.15.x/images/common/zowe-install-location.pptx new file mode 100644 index 0000000000..27d765bfa4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-install-location.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-mvs-dataset-edit.png b/versioned_docs/version-v2.15.x/images/common/zowe-mvs-dataset-edit.png new file mode 100644 index 0000000000..0063780a31 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-mvs-dataset-edit.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-mvs-dataset-saved.png b/versioned_docs/version-v2.15.x/images/common/zowe-mvs-dataset-saved.png new file mode 100644 index 0000000000..0c4a3d9df3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-mvs-dataset-saved.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-mvs-filter.png b/versioned_docs/version-v2.15.x/images/common/zowe-mvs-filter.png new file mode 100644 index 0000000000..9151ff2a34 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-mvs-filter.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-ssl.png b/versioned_docs/version-v2.15.x/images/common/zowe-ssl.png new file mode 100644 index 0000000000..4de8ccaade Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-ssl.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-ssl.pptx b/versioned_docs/version-v2.15.x/images/common/zowe-ssl.pptx new file mode 100644 index 0000000000..115ed988cc Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-ssl.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-tn3270-logon.png b/versioned_docs/version-v2.15.x/images/common/zowe-tn3270-logon.png new file mode 100644 index 0000000000..250fd42557 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-tn3270-logon.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-tn3270-welcome.png b/versioned_docs/version-v2.15.x/images/common/zowe-tn3270-welcome.png new file mode 100644 index 0000000000..3452ef9b51 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-tn3270-welcome.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-zos-install-diagram.png b/versioned_docs/version-v2.15.x/images/common/zowe-zos-install-diagram.png new file mode 100644 index 0000000000..37336aa83e Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-zos-install-diagram.png differ diff --git a/versioned_docs/version-v2.15.x/images/common/zowe-zos-install-diagram.pptx b/versioned_docs/version-v2.15.x/images/common/zowe-zos-install-diagram.pptx new file mode 100644 index 0000000000..9e71dc0015 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/common/zowe-zos-install-diagram.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/configure/multiyaml.png b/versioned_docs/version-v2.15.x/images/configure/multiyaml.png new file mode 100644 index 0000000000..c2f9021fcb Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/configure/multiyaml.png differ diff --git a/versioned_docs/version-v2.15.x/images/configure/templating.png b/versioned_docs/version-v2.15.x/images/configure/templating.png new file mode 100644 index 0000000000..f6dd5d9b1d Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/configure/templating.png differ diff --git a/versioned_docs/version-v2.15.x/images/configure/workflow-four.jpg b/versioned_docs/version-v2.15.x/images/configure/workflow-four.jpg new file mode 100644 index 0000000000..cddcbc9b66 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/configure/workflow-four.jpg differ diff --git a/versioned_docs/version-v2.15.x/images/configure/workflow-one.jpg b/versioned_docs/version-v2.15.x/images/configure/workflow-one.jpg new file mode 100644 index 0000000000..b8586d476c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/configure/workflow-one.jpg differ diff --git a/versioned_docs/version-v2.15.x/images/configure/workflow-parameters.jpg b/versioned_docs/version-v2.15.x/images/configure/workflow-parameters.jpg new file mode 100644 index 0000000000..ac16f52b4f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/configure/workflow-parameters.jpg differ diff --git a/versioned_docs/version-v2.15.x/images/configure/workflow-three.jpg b/versioned_docs/version-v2.15.x/images/configure/workflow-three.jpg new file mode 100644 index 0000000000..47e74f4cff Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/configure/workflow-three.jpg differ diff --git a/versioned_docs/version-v2.15.x/images/configure/workflow-two.jpg b/versioned_docs/version-v2.15.x/images/configure/workflow-two.jpg new file mode 100644 index 0000000000..034e209925 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/configure/workflow-two.jpg differ diff --git a/versioned_docs/version-v2.15.x/images/extender/dark_palette.png b/versioned_docs/version-v2.15.x/images/extender/dark_palette.png new file mode 100644 index 0000000000..d7158b41b1 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/dark_palette.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/full_palette.png b/versioned_docs/version-v2.15.x/images/extender/full_palette.png new file mode 100644 index 0000000000..94e62da80f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/full_palette.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/grid_desktop-1024x780.png b/versioned_docs/version-v2.15.x/images/extender/grid_desktop-1024x780.png new file mode 100644 index 0000000000..e8953fb290 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/grid_desktop-1024x780.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/grid_mobile-1024x709.png b/versioned_docs/version-v2.15.x/images/extender/grid_mobile-1024x709.png new file mode 100644 index 0000000000..8dc29406b6 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/grid_mobile-1024x709.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/icon_sample1.png b/versioned_docs/version-v2.15.x/images/extender/icon_sample1.png new file mode 100644 index 0000000000..69ebecdea3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/icon_sample1.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/icon_sample2-1024x283.png b/versioned_docs/version-v2.15.x/images/extender/icon_sample2-1024x283.png new file mode 100644 index 0000000000..6c791fa818 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/icon_sample2-1024x283.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/icon_sample3.png b/versioned_docs/version-v2.15.x/images/extender/icon_sample3.png new file mode 100644 index 0000000000..0a3a0454a2 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/icon_sample3.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/icon_sample4.png b/versioned_docs/version-v2.15.x/images/extender/icon_sample4.png new file mode 100644 index 0000000000..dfbbf53aca Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/icon_sample4.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/icon_sample5.png b/versioned_docs/version-v2.15.x/images/extender/icon_sample5.png new file mode 100644 index 0000000000..e0abaa8b42 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/icon_sample5.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/icons_sample-1024x753.png b/versioned_docs/version-v2.15.x/images/extender/icons_sample-1024x753.png new file mode 100644 index 0000000000..cfc331c7d6 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/icons_sample-1024x753.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/light_palette.png b/versioned_docs/version-v2.15.x/images/extender/light_palette.png new file mode 100644 index 0000000000..c0a23f54c4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/light_palette.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/service.png b/versioned_docs/version-v2.15.x/images/extender/service.png new file mode 100644 index 0000000000..bce061b943 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/service.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/tile.png b/versioned_docs/version-v2.15.x/images/extender/tile.png new file mode 100644 index 0000000000..6873b6bfad Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/tile.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/type_bold_sample.png b/versioned_docs/version-v2.15.x/images/extender/type_bold_sample.png new file mode 100644 index 0000000000..e04f3f3a47 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/type_bold_sample.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/type_light_sample.png b/versioned_docs/version-v2.15.x/images/extender/type_light_sample.png new file mode 100644 index 0000000000..1c4f16824e Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/type_light_sample.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/type_regular_sample.png b/versioned_docs/version-v2.15.x/images/extender/type_regular_sample.png new file mode 100644 index 0000000000..f3e8da9912 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/type_regular_sample.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/type_sample.png b/versioned_docs/version-v2.15.x/images/extender/type_sample.png new file mode 100644 index 0000000000..027df77e5a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/type_sample.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/type_scale_desktop-1024x533.png b/versioned_docs/version-v2.15.x/images/extender/type_scale_desktop-1024x533.png new file mode 100644 index 0000000000..4b3fcda5ce Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/type_scale_desktop-1024x533.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/type_scale_mobile-1024x461.png b/versioned_docs/version-v2.15.x/images/extender/type_scale_mobile-1024x461.png new file mode 100644 index 0000000000..a13161b980 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/type_scale_mobile-1024x461.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/urzowe.png b/versioned_docs/version-v2.15.x/images/extender/urzowe.png new file mode 100644 index 0000000000..2a89ffa0a8 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/urzowe.png differ diff --git a/versioned_docs/version-v2.15.x/images/extender/zowefwk.png b/versioned_docs/version-v2.15.x/images/extender/zowefwk.png new file mode 100644 index 0000000000..b868ca4d6f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/extender/zowefwk.png differ diff --git a/versioned_docs/version-v2.15.x/images/guides/CLI/GetHelp.gif b/versioned_docs/version-v2.15.x/images/guides/CLI/GetHelp.gif new file mode 100644 index 0000000000..aede1694e0 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/guides/CLI/GetHelp.gif differ diff --git a/versioned_docs/version-v2.15.x/images/guides/CLI/InstalledSample.png b/versioned_docs/version-v2.15.x/images/guides/CLI/InstalledSample.png new file mode 100644 index 0000000000..7bb1fe9a24 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/guides/CLI/InstalledSample.png differ diff --git a/versioned_docs/version-v2.15.x/images/guides/CLI/SampleOutput.png b/versioned_docs/version-v2.15.x/images/guides/CLI/SampleOutput.png new file mode 100644 index 0000000000..235a40479f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/guides/CLI/SampleOutput.png differ diff --git a/versioned_docs/version-v2.15.x/images/guides/CLI/completedSample.png b/versioned_docs/version-v2.15.x/images/guides/CLI/completedSample.png new file mode 100644 index 0000000000..3f611a1277 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/guides/CLI/completedSample.png differ diff --git a/versioned_docs/version-v2.15.x/images/guides/CLI/diffOutput.png b/versioned_docs/version-v2.15.x/images/guides/CLI/diffOutput.png new file mode 100644 index 0000000000..06587784ab Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/guides/CLI/diffOutput.png differ diff --git a/versioned_docs/version-v2.15.x/images/guides/CLI/envVarsJenkins.png b/versioned_docs/version-v2.15.x/images/guides/CLI/envVarsJenkins.png new file mode 100644 index 0000000000..85776a51d1 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/guides/CLI/envVarsJenkins.png differ diff --git a/versioned_docs/version-v2.15.x/images/guides/CLI/htmlDiff.png b/versioned_docs/version-v2.15.x/images/guides/CLI/htmlDiff.png new file mode 100644 index 0000000000..cc2bf4cdb9 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/guides/CLI/htmlDiff.png differ diff --git a/versioned_docs/version-v2.15.x/images/guides/CLI/htmlDiff2.png b/versioned_docs/version-v2.15.x/images/guides/CLI/htmlDiff2.png new file mode 100644 index 0000000000..b1540a08a9 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/guides/CLI/htmlDiff2.png differ diff --git a/versioned_docs/version-v2.15.x/images/guides/CLI/pipeOutput.png b/versioned_docs/version-v2.15.x/images/guides/CLI/pipeOutput.png new file mode 100644 index 0000000000..74b037b53b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/guides/CLI/pipeOutput.png differ diff --git a/versioned_docs/version-v2.15.x/images/guides/libertyAPI/menu1.png b/versioned_docs/version-v2.15.x/images/guides/libertyAPI/menu1.png new file mode 100644 index 0000000000..d7d9adf60d Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/guides/libertyAPI/menu1.png differ diff --git a/versioned_docs/version-v2.15.x/images/guides/libertyAPI/struct1.png b/versioned_docs/version-v2.15.x/images/guides/libertyAPI/struct1.png new file mode 100644 index 0000000000..4370cd527b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/guides/libertyAPI/struct1.png differ diff --git a/versioned_docs/version-v2.15.x/images/guides/libertyAPI/swag.png b/versioned_docs/version-v2.15.x/images/guides/libertyAPI/swag.png new file mode 100644 index 0000000000..49dece87cb Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/guides/libertyAPI/swag.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/4-installation-methods.png b/versioned_docs/version-v2.15.x/images/install/4-installation-methods.png new file mode 100644 index 0000000000..b8ca32a2ff Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/4-installation-methods.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/Convenience-build-install.png b/versioned_docs/version-v2.15.x/images/install/Convenience-build-install.png new file mode 100644 index 0000000000..6c735194d8 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/Convenience-build-install.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/PSWI-install.png b/versioned_docs/version-v2.15.x/images/install/PSWI-install.png new file mode 100644 index 0000000000..b75b8e6b3c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/PSWI-install.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/SMPE-install.png b/versioned_docs/version-v2.15.x/images/install/SMPE-install.png new file mode 100644 index 0000000000..9458d78d74 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/SMPE-install.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/certificates-config-scenarios.png b/versioned_docs/version-v2.15.x/images/install/certificates-config-scenarios.png new file mode 100644 index 0000000000..f8569a5542 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/certificates-config-scenarios.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/config.png b/versioned_docs/version-v2.15.x/images/install/config.png new file mode 100644 index 0000000000..bbbe461747 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/config.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/container-install-1.png b/versioned_docs/version-v2.15.x/images/install/container-install-1.png new file mode 100644 index 0000000000..0e34cec899 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/container-install-1.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/container-install-2.png b/versioned_docs/version-v2.15.x/images/install/container-install-2.png new file mode 100644 index 0000000000..65151d2aea Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/container-install-2.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/container-install-34.png b/versioned_docs/version-v2.15.x/images/install/container-install-34.png new file mode 100644 index 0000000000..59f1f00dfd Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/container-install-34.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/container-install-5.png b/versioned_docs/version-v2.15.x/images/install/container-install-5.png new file mode 100644 index 0000000000..47cbe45716 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/container-install-5.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/container-install-6.png b/versioned_docs/version-v2.15.x/images/install/container-install-6.png new file mode 100644 index 0000000000..f68684c61c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/container-install-6.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/containerization-install.png b/versioned_docs/version-v2.15.x/images/install/containerization-install.png new file mode 100644 index 0000000000..ff3c70eda1 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/containerization-install.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/install.png b/versioned_docs/version-v2.15.x/images/install/install.png new file mode 100644 index 0000000000..9c99345c02 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/install.png differ diff --git a/versioned_docs/version-v2.15.x/images/install/zwe-install-datasets.png b/versioned_docs/version-v2.15.x/images/install/zwe-install-datasets.png new file mode 100644 index 0000000000..1bc864d2c4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/install/zwe-install-datasets.png differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/allocate_like.gif b/versioned_docs/version-v2.15.x/images/intellij/allocate_like.gif new file mode 100644 index 0000000000..cd6f5551bb Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/allocate_like.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/batch_size.gif b/versioned_docs/version-v2.15.x/images/intellij/batch_size.gif new file mode 100644 index 0000000000..e1edb6aa7f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/batch_size.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/connection_create.gif b/versioned_docs/version-v2.15.x/images/intellij/connection_create.gif new file mode 100644 index 0000000000..2ce0944f5d Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/connection_create.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/connection_zowe_config_v2.gif b/versioned_docs/version-v2.15.x/images/intellij/connection_zowe_config_v2.gif new file mode 100644 index 0000000000..999a7445e5 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/connection_zowe_config_v2.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/copy_mem_to_uss.gif b/versioned_docs/version-v2.15.x/images/intellij/copy_mem_to_uss.gif new file mode 100644 index 0000000000..6fbfd5ff88 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/copy_mem_to_uss.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/create_edit_rename_delete_ps.gif b/versioned_docs/version-v2.15.x/images/intellij/create_edit_rename_delete_ps.gif new file mode 100644 index 0000000000..468a383f22 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/create_edit_rename_delete_ps.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/create_files_working_set.gif b/versioned_docs/version-v2.15.x/images/intellij/create_files_working_set.gif new file mode 100644 index 0000000000..b65110d723 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/create_files_working_set.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/create_jes_working_set.gif b/versioned_docs/version-v2.15.x/images/intellij/create_jes_working_set.gif new file mode 100644 index 0000000000..622ad0dfea Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/create_jes_working_set.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/cross_system_copy.gif b/versioned_docs/version-v2.15.x/images/intellij/cross_system_copy.gif new file mode 100644 index 0000000000..156b4233ed Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/cross_system_copy.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/intellij-install.gif b/versioned_docs/version-v2.15.x/images/intellij/intellij-install.gif new file mode 100644 index 0000000000..10c06fb377 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/intellij-install.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/move_mem_to_ds.gif b/versioned_docs/version-v2.15.x/images/intellij/move_mem_to_ds.gif new file mode 100644 index 0000000000..5814436b3d Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/move_mem_to_ds.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/move_uss_folder_to_uss_folder.gif b/versioned_docs/version-v2.15.x/images/intellij/move_uss_folder_to_uss_folder.gif new file mode 100644 index 0000000000..cfe62346bf Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/move_uss_folder_to_uss_folder.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/move_uss_to_pds.gif b/versioned_docs/version-v2.15.x/images/intellij/move_uss_to_pds.gif new file mode 100644 index 0000000000..0633c186f8 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/move_uss_to_pds.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/pds_copy_move_ds.gif b/versioned_docs/version-v2.15.x/images/intellij/pds_copy_move_ds.gif new file mode 100644 index 0000000000..26d42b7d3c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/pds_copy_move_ds.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/pds_create_and_props.gif b/versioned_docs/version-v2.15.x/images/intellij/pds_create_and_props.gif new file mode 100644 index 0000000000..80a20b3d98 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/pds_create_and_props.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/pds_move_zos_to_uss.gif b/versioned_docs/version-v2.15.x/images/intellij/pds_move_zos_to_uss.gif new file mode 100644 index 0000000000..6cfedd82fd Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/pds_move_zos_to_uss.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/submit_jcl.gif b/versioned_docs/version-v2.15.x/images/intellij/submit_jcl.gif new file mode 100644 index 0000000000..e919b471ec Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/submit_jcl.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/sync_option.gif b/versioned_docs/version-v2.15.x/images/intellij/sync_option.gif new file mode 100644 index 0000000000..44fa70977a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/sync_option.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/tso_cli.gif b/versioned_docs/version-v2.15.x/images/intellij/tso_cli.gif new file mode 100644 index 0000000000..c7171ca53c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/tso_cli.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/work_with_jes_jobs.gif b/versioned_docs/version-v2.15.x/images/intellij/work_with_jes_jobs.gif new file mode 100644 index 0000000000..74aa2f535a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/work_with_jes_jobs.gif differ diff --git a/versioned_docs/version-v2.15.x/images/intellij/work_with_uss.gif b/versioned_docs/version-v2.15.x/images/intellij/work_with_uss.gif new file mode 100644 index 0000000000..f12cbdbce2 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/intellij/work_with_uss.gif differ diff --git a/versioned_docs/version-v2.15.x/images/licenses/EPL-2.0.txt b/versioned_docs/version-v2.15.x/images/licenses/EPL-2.0.txt new file mode 100644 index 0000000000..e23ece2c85 --- /dev/null +++ b/versioned_docs/version-v2.15.x/images/licenses/EPL-2.0.txt @@ -0,0 +1,277 @@ +Eclipse Public License - v 2.0 + + THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE + PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION + OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. + +1. DEFINITIONS + +"Contribution" means: + + a) in the case of the initial Contributor, the initial content + Distributed under this Agreement, and + + b) in the case of each subsequent Contributor: + i) changes to the Program, and + ii) additions to the Program; + where such changes and/or additions to the Program originate from + and are Distributed by that particular Contributor. A Contribution + "originates" from a Contributor if it was added to the Program by + such Contributor itself or anyone acting on such Contributor's behalf. + Contributions do not include changes or additions to the Program that + are not Modified Works. + +"Contributor" means any person or entity that Distributes the Program. + +"Licensed Patents" mean patent claims licensable by a Contributor which +are necessarily infringed by the use or sale of its Contribution alone +or when combined with the Program. + +"Program" means the Contributions Distributed in accordance with this +Agreement. + +"Recipient" means anyone who receives the Program under this Agreement +or any Secondary License (as applicable), including Contributors. + +"Derivative Works" shall mean any work, whether in Source Code or other +form, that is based on (or derived from) the Program and for which the +editorial revisions, annotations, elaborations, or other modifications +represent, as a whole, an original work of authorship. + +"Modified Works" shall mean any work in Source Code or other form that +results from an addition to, deletion from, or modification of the +contents of the Program, including, for purposes of clarity any new file +in Source Code form that contains any contents of the Program. Modified +Works shall not include works that contain only declarations, +interfaces, types, classes, structures, or files of the Program solely +in each case in order to link to, bind by name, or subclass the Program +or Modified Works thereof. + +"Distribute" means the acts of a) distributing or b) making available +in any manner that enables the transfer of a copy. + +"Source Code" means the form of a Program preferred for making +modifications, including but not limited to software source code, +documentation source, and configuration files. + +"Secondary License" means either the GNU General Public License, +Version 2.0, or any later versions of that license, including any +exceptions or additional permissions as identified by the initial +Contributor. + +2. GRANT OF RIGHTS + + a) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free copyright + license to reproduce, prepare Derivative Works of, publicly display, + publicly perform, Distribute and sublicense the Contribution of such + Contributor, if any, and such Derivative Works. + + b) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free patent + license under Licensed Patents to make, use, sell, offer to sell, + import and otherwise transfer the Contribution of such Contributor, + if any, in Source Code or other form. This patent license shall + apply to the combination of the Contribution and the Program if, at + the time the Contribution is added by the Contributor, such addition + of the Contribution causes such combination to be covered by the + Licensed Patents. The patent license shall not apply to any other + combinations which include the Contribution. No hardware per se is + licensed hereunder. + + c) Recipient understands that although each Contributor grants the + licenses to its Contributions set forth herein, no assurances are + provided by any Contributor that the Program does not infringe the + patent or other intellectual property rights of any other entity. + Each Contributor disclaims any liability to Recipient for claims + brought by any other entity based on infringement of intellectual + property rights or otherwise. As a condition to exercising the + rights and licenses granted hereunder, each Recipient hereby + assumes sole responsibility to secure any other intellectual + property rights needed, if any. For example, if a third party + patent license is required to allow Recipient to Distribute the + Program, it is Recipient's responsibility to acquire that license + before distributing the Program. + + d) Each Contributor represents that to its knowledge it has + sufficient copyright rights in its Contribution, if any, to grant + the copyright license set forth in this Agreement. + + e) Notwithstanding the terms of any Secondary License, no + Contributor makes additional grants to any Recipient (other than + those set forth in this Agreement) as a result of such Recipient's + receipt of the Program under the terms of a Secondary License + (if permitted under the terms of Section 3). + +3. REQUIREMENTS + +3.1 If a Contributor Distributes the Program in any form, then: + + a) the Program must also be made available as Source Code, in + accordance with section 3.2, and the Contributor must accompany + the Program with a statement that the Source Code for the Program + is available under this Agreement, and informs Recipients how to + obtain it in a reasonable manner on or through a medium customarily + used for software exchange; and + + b) the Contributor may Distribute the Program under a license + different than this Agreement, provided that such license: + i) effectively disclaims on behalf of all other Contributors all + warranties and conditions, express and implied, including + warranties or conditions of title and non-infringement, and + implied warranties or conditions of merchantability and fitness + for a particular purpose; + + ii) effectively excludes on behalf of all other Contributors all + liability for damages, including direct, indirect, special, + incidental and consequential damages, such as lost profits; + + iii) does not attempt to limit or alter the recipients' rights + in the Source Code under section 3.2; and + + iv) requires any subsequent distribution of the Program by any + party to be under a license that satisfies the requirements + of this section 3. + +3.2 When the Program is Distributed as Source Code: + + a) it must be made available under this Agreement, or if the + Program (i) is combined with other material in a separate file or + files made available under a Secondary License, and (ii) the initial + Contributor attached to the Source Code the notice described in + Exhibit A of this Agreement, then the Program may be made available + under the terms of such Secondary Licenses, and + + b) a copy of this Agreement must be included with each copy of + the Program. + +3.3 Contributors may not remove or alter any copyright, patent, +trademark, attribution notices, disclaimers of warranty, or limitations +of liability ("notices") contained within the Program from any copy of +the Program which they Distribute, provided that Contributors may add +their own appropriate notices. + +4. COMMERCIAL DISTRIBUTION + +Commercial distributors of software may accept certain responsibilities +with respect to end users, business partners and the like. While this +license is intended to facilitate the commercial use of the Program, +the Contributor who includes the Program in a commercial product +offering should do so in a manner which does not create potential +liability for other Contributors. Therefore, if a Contributor includes +the Program in a commercial product offering, such Contributor +("Commercial Contributor") hereby agrees to defend and indemnify every +other Contributor ("Indemnified Contributor") against any losses, +damages and costs (collectively "Losses") arising from claims, lawsuits +and other legal actions brought by a third party against the Indemnified +Contributor to the extent caused by the acts or omissions of such +Commercial Contributor in connection with its distribution of the Program +in a commercial product offering. The obligations in this section do not +apply to any claims or Losses relating to any actual or alleged +intellectual property infringement. In order to qualify, an Indemnified +Contributor must: a) promptly notify the Commercial Contributor in +writing of such claim, and b) allow the Commercial Contributor to control, +and cooperate with the Commercial Contributor in, the defense and any +related settlement negotiations. The Indemnified Contributor may +participate in any such claim at its own expense. + +For example, a Contributor might include the Program in a commercial +product offering, Product X. That Contributor is then a Commercial +Contributor. If that Commercial Contributor then makes performance +claims, or offers warranties related to Product X, those performance +claims and warranties are such Commercial Contributor's responsibility +alone. Under this section, the Commercial Contributor would have to +defend claims against the other Contributors related to those performance +claims and warranties, and if a court requires any other Contributor to +pay any damages as a result, the Commercial Contributor must pay +those damages. + +5. NO WARRANTY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT +PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS" +BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR +IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF +TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR +PURPOSE. Each Recipient is solely responsible for determining the +appropriateness of using and distributing the Program and assumes all +risks associated with its exercise of rights under this Agreement, +including but not limited to the risks and costs of program errors, +compliance with applicable laws, damage to or loss of data, programs +or equipment, and unavailability or interruption of operations. + +6. DISCLAIMER OF LIABILITY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT +PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS +SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST +PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE +EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + +7. GENERAL + +If any provision of this Agreement is invalid or unenforceable under +applicable law, it shall not affect the validity or enforceability of +the remainder of the terms of this Agreement, and without further +action by the parties hereto, such provision shall be reformed to the +minimum extent necessary to make such provision valid and enforceable. + +If Recipient institutes patent litigation against any entity +(including a cross-claim or counterclaim in a lawsuit) alleging that the +Program itself (excluding combinations of the Program with other software +or hardware) infringes such Recipient's patent(s), then such Recipient's +rights granted under Section 2(b) shall terminate as of the date such +litigation is filed. + +All Recipient's rights under this Agreement shall terminate if it +fails to comply with any of the material terms or conditions of this +Agreement and does not cure such failure in a reasonable period of +time after becoming aware of such noncompliance. If all Recipient's +rights under this Agreement terminate, Recipient agrees to cease use +and distribution of the Program as soon as reasonably practicable. +However, Recipient's obligations under this Agreement and any licenses +granted by Recipient relating to the Program shall continue and survive. + +Everyone is permitted to copy and distribute copies of this Agreement, +but in order to avoid inconsistency the Agreement is copyrighted and +may only be modified in the following manner. The Agreement Steward +reserves the right to publish new versions (including revisions) of +this Agreement from time to time. No one other than the Agreement +Steward has the right to modify this Agreement. The Eclipse Foundation +is the initial Agreement Steward. The Eclipse Foundation may assign the +responsibility to serve as the Agreement Steward to a suitable separate +entity. Each new version of the Agreement will be given a distinguishing +version number. The Program (including Contributions) may always be +Distributed subject to the version of the Agreement under which it was +received. In addition, after a new version of the Agreement is published, +Contributor may elect to Distribute the Program (including its +Contributions) under the new version. + +Except as expressly stated in Sections 2(a) and 2(b) above, Recipient +receives no rights or licenses to the intellectual property of any +Contributor under this Agreement, whether expressly, by implication, +estoppel or otherwise. All rights in the Program not expressly granted +under this Agreement are reserved. Nothing in this Agreement is intended +to be enforceable by any entity that is not a Contributor or Recipient. +No third-party beneficiary rights are created under this Agreement. + +Exhibit A - Form of Secondary Licenses Notice + +"This Source Code may also be made available under the following +Secondary Licenses when the conditions for such availability set forth +in the Eclipse Public License, v. 2.0 are satisfied: {name license(s), +version(s), and exceptions or additional permissions here}." + + Simply including a copy of this Agreement, including this Exhibit A + is not sufficient to license the Source Code under Secondary Licenses. + + If it is not possible or desirable to put the notice in a particular + file, then You may include the notice in a location (such as a LICENSE + file in a relevant directory) where a recipient would be likely to + look for such a notice. + + You may add additional accurate notices of copyright ownership. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/images/mvd/desktop-explorers.png b/versioned_docs/version-v2.15.x/images/mvd/desktop-explorers.png new file mode 100644 index 0000000000..9f54810136 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/mvd/desktop-explorers.png differ diff --git a/versioned_docs/version-v2.15.x/images/mvd/desktop-explorers.pptx b/versioned_docs/version-v2.15.x/images/mvd/desktop-explorers.pptx new file mode 100644 index 0000000000..42182bc425 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/mvd/desktop-explorers.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/mvd/mvd_workflow1.png b/versioned_docs/version-v2.15.x/images/mvd/mvd_workflow1.png new file mode 100644 index 0000000000..80dbe544c6 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/mvd/mvd_workflow1.png differ diff --git a/versioned_docs/version-v2.15.x/images/mvd/mvd_workflow2.png b/versioned_docs/version-v2.15.x/images/mvd/mvd_workflow2.png new file mode 100644 index 0000000000..8950465b88 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/mvd/mvd_workflow2.png differ diff --git a/versioned_docs/version-v2.15.x/images/mvd/mvd_workflow3.png b/versioned_docs/version-v2.15.x/images/mvd/mvd_workflow3.png new file mode 100644 index 0000000000..1ffdcb5b43 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/mvd/mvd_workflow3.png differ diff --git a/versioned_docs/version-v2.15.x/images/mvd/mvderrorreportui.png b/versioned_docs/version-v2.15.x/images/mvd/mvderrorreportui.png new file mode 100644 index 0000000000..6600756b62 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/mvd/mvderrorreportui.png differ diff --git a/versioned_docs/version-v2.15.x/images/mvd/person.png b/versioned_docs/version-v2.15.x/images/mvd/person.png new file mode 100644 index 0000000000..d4a1eb773a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/mvd/person.png differ diff --git a/versioned_docs/version-v2.15.x/images/mvd/personalization.png b/versioned_docs/version-v2.15.x/images/mvd/personalization.png new file mode 100644 index 0000000000..638f6d67bc Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/mvd/personalization.png differ diff --git a/versioned_docs/version-v2.15.x/images/mvd/settings.png b/versioned_docs/version-v2.15.x/images/mvd/settings.png new file mode 100644 index 0000000000..3ba0a5b964 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/mvd/settings.png differ diff --git a/versioned_docs/version-v2.15.x/images/mvd/zluxserverarchitecture.jpg b/versioned_docs/version-v2.15.x/images/mvd/zluxserverarchitecture.jpg new file mode 100644 index 0000000000..e7266112a3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/mvd/zluxserverarchitecture.jpg differ diff --git a/versioned_docs/version-v2.15.x/images/mvd/zowe-desktop.png b/versioned_docs/version-v2.15.x/images/mvd/zowe-desktop.png new file mode 100644 index 0000000000..6098c6fc2f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/mvd/zowe-desktop.png differ diff --git a/versioned_docs/version-v2.15.x/images/mvd/zowe-desktop.pptx b/versioned_docs/version-v2.15.x/images/mvd/zowe-desktop.pptx new file mode 100644 index 0000000000..aff2a144e7 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/mvd/zowe-desktop.pptx differ diff --git a/versioned_docs/version-v2.15.x/images/releasenotes/select-older-release-notes.gif b/versioned_docs/version-v2.15.x/images/releasenotes/select-older-release-notes.gif new file mode 100644 index 0000000000..0a25674804 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/releasenotes/select-older-release-notes.gif differ diff --git a/versioned_docs/version-v2.15.x/images/releasenotes/v17-sjdemo.gif b/versioned_docs/version-v2.15.x/images/releasenotes/v17-sjdemo.gif new file mode 100644 index 0000000000..796e3a1beb Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/releasenotes/v17-sjdemo.gif differ diff --git a/versioned_docs/version-v2.15.x/images/samples/reactjs/overview.png b/versioned_docs/version-v2.15.x/images/samples/reactjs/overview.png new file mode 100644 index 0000000000..a9ca417cd7 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/samples/reactjs/overview.png differ diff --git a/versioned_docs/version-v2.15.x/images/scenario/441193421 b/versioned_docs/version-v2.15.x/images/scenario/441193421 new file mode 100644 index 0000000000..8c784ba630 --- /dev/null +++ b/versioned_docs/version-v2.15.x/images/scenario/441193421 @@ -0,0 +1 @@ +{"contentType":"application/gliffy+json","version":"1.3","metadata":{"title":"untitled","revision":0,"exportBorder":false,"loadPosition":"default","libraries":["com.gliffy.libraries.network.network_v3.home","com.gliffy.libraries.network.network_v3.business","com.gliffy.libraries.network.network_v3.rack","com.gliffy.libraries.flowchart.flowchart_v1.default","com.gliffy.libraries.basic.basic_v1.default","com.gliffy.libraries.bpmn.bpmn_v1.events","com.gliffy.libraries.bpmn.bpmn_v1.activities","com.gliffy.libraries.bpmn.bpmn_v1.data_artifacts","com.gliffy.libraries.bpmn.bpmn_v1.gateways","com.gliffy.libraries.bpmn.bpmn_v1.connectors","com.gliffy.libraries.swimlanes.swimlanes_v1.default","com.gliffy.libraries.images"],"lastSerialized":1511194299884,"analyticsProduct":"Confluence"},"embeddedResources":{"index":0,"resources":[]},"stage":{"objects":[{"x":415.99998474121094,"y":660.8666534423828,"rotation":0,"id":129,"uid":"com.gliffy.shape.basic.basic_v1.default.line","width":232,"height":312,"lockAspectRatio":false,"lockShape":false,"order":45,"hidden":false,"graphic":{"type":"Line","Line":{"strokeWidth":2,"strokeColor":"#333333","fillColor":"none","dashStyle":null,"startArrow":0,"endArrow":2,"startArrowRotation":"auto","endArrowRotation":"auto","ortho":true,"interpolationType":"linear","cornerRadius":null,"controlPath":[[4.0000152587890625,-55.86665344238281],[194.00001525878906,-55.86665344238281],[194.00001525878906,-345.8666534423828],[64.00001525878906,-345.8666534423828]],"lockSegments":{"1":true}}},"children":null,"layerId":"8DmkvEaa6dFA","constraints":{"constraints":[],"startConstraint":{"type":"StartPositionConstraint","StartPositionConstraint":{"nodeId":109,"px":1,"py":0.5}},"endConstraint":{"type":"EndPositionConstraint","EndPositionConstraint":{"nodeId":89,"px":1,"py":0.5}}},"linkMap":[]},{"x":358,"y":721.8833312988281,"rotation":0,"id":125,"uid":"com.gliffy.shape.basic.basic_v1.default.line","width":4,"height":40,"lockAspectRatio":false,"lockShape":false,"order":41,"hidden":false,"graphic":{"type":"Line","Line":{"strokeWidth":2,"strokeColor":"#333333","fillColor":"none","dashStyle":null,"startArrow":0,"endArrow":2,"startArrowRotation":"auto","endArrowRotation":"auto","ortho":true,"interpolationType":"linear","cornerRadius":null,"controlPath":[[-3,-51.883331298828125],[-3,-38.58888753255212],[-3,-25.294443766276004],[-3,-12]],"lockSegments":{}}},"children":null,"layerId":"8DmkvEaa6dFA","constraints":{"constraints":[],"startConstraint":{"type":"StartPositionConstraint","StartPositionConstraint":{"nodeId":109,"px":0.5,"py":1}},"endConstraint":{"type":"EndPositionConstraint","EndPositionConstraint":{"nodeId":122,"px":0.5,"py":0}}},"linkMap":[]},{"x":330,"y":709.8833312988281,"rotation":0,"id":122,"uid":"com.gliffy.shape.flowchart.flowchart_v1.default.connector","width":50,"height":50,"lockAspectRatio":true,"lockShape":false,"order":40,"hidden":false,"graphic":{"type":"Shape","Shape":{"tid":"com.gliffy.stencil.ellipse.basic_v1","strokeWidth":2,"strokeColor":"#666666","fillColor":"#eeeeee","gradient":false,"dropShadow":false,"state":0,"shadowX":0,"shadowY":0,"opacity":1}},"children":[{"x":2,"y":0,"rotation":0,"id":124,"uid":null,"width":46,"height":28,"lockAspectRatio":false,"lockShape":false,"order":"auto","hidden":false,"graphic":{"type":"Text","Text":{"tid":null,"valign":"middle","overflow":"none","vposition":"none","hposition":"none","html":"

    Done!

    ","paddingLeft":8,"paddingRight":8,"paddingBottom":8,"paddingTop":8,"outerPaddingLeft":6,"outerPaddingRight":6,"outerPaddingBottom":2,"outerPaddingTop":6}},"children":null,"layerId":"8DmkvEaa6dFA"}],"layerId":"8DmkvEaa6dFA","linkMap":[]},{"x":354.6,"y":264.3766662597656,"rotation":0,"id":114,"uid":"com.gliffy.shape.basic.basic_v1.default.line","width":1,"height":28,"lockAspectRatio":false,"lockShape":false,"order":36,"hidden":false,"graphic":{"type":"Line","Line":{"strokeWidth":2,"strokeColor":"#333333","fillColor":"none","dashStyle":null,"startArrow":0,"endArrow":2,"startArrowRotation":"auto","endArrowRotation":"auto","ortho":true,"interpolationType":"linear","cornerRadius":null,"controlPath":[[0.4000000000000341,-0.37666625976561363],[0.4000000000000341,8.290000406901072],[0.4000000000000341,16.9566670735677],[0.4000000000000341,25.623333740234386]],"lockSegments":{}}},"children":null,"layerId":"8DmkvEaa6dFA","constraints":{"constraints":[],"startConstraint":{"type":"StartPositionConstraint","StartPositionConstraint":{"nodeId":66,"px":0.5,"py":1}},"endConstraint":{"type":"EndPositionConstraint","EndPositionConstraint":{"nodeId":89,"px":0.5,"py":0}}},"linkMap":[]},{"x":345,"y":565.8833312988281,"rotation":0,"id":111,"uid":"com.gliffy.shape.basic.basic_v1.default.line","width":6,"height":22,"lockAspectRatio":false,"lockShape":false,"order":35,"hidden":false,"graphic":{"type":"Line","Line":{"strokeWidth":2,"strokeColor":"#333333","fillColor":"none","dashStyle":null,"startArrow":0,"endArrow":2,"startArrowRotation":"auto","endArrowRotation":"auto","ortho":true,"interpolationType":"linear","cornerRadius":null,"controlPath":[[12.5,-65.88333129882812],[12.5,-52.52398168059358],[12.5,-39.164632062359146],[12.5,-25.8052824441246]],"lockSegments":{}}},"children":null,"layerId":"8DmkvEaa6dFA","constraints":{"constraints":[],"startConstraint":{"type":"StartPositionConstraint","StartPositionConstraint":{"nodeId":70,"px":0.5,"py":1}},"endConstraint":{"type":"EndPositionConstraint","EndPositionConstraint":{"nodeId":109,"px":0.5,"py":0}}},"linkMap":[]},{"x":49.999999999999886,"y":25.5,"rotation":0,"id":52,"uid":"com.gliffy.shape.basic.basic_v1.default.text","width":610,"height":19,"lockAspectRatio":false,"lockShape":false,"order":6,"hidden":false,"graphic":{"type":"Text","Text":{"tid":null,"valign":"middle","overflow":"none","vposition":"none","hposition":"none","html":"

    Submit a Job and Print the Job Output

    ","paddingLeft":2,"paddingRight":2,"paddingBottom":2,"paddingTop":2,"outerPaddingLeft":6,"outerPaddingRight":6,"outerPaddingBottom":2,"outerPaddingTop":6}},"children":[],"layerId":"8DmkvEaa6dFA","linkMap":[]},{"x":230.00000000000006,"y":70,"rotation":0,"id":6,"uid":"com.gliffy.shape.basic.basic_v1.default.rectangle","width":250,"height":50,"lockAspectRatio":false,"lockShape":false,"order":0,"hidden":false,"graphic":{"type":"Shape","Shape":{"tid":"com.gliffy.stencil.rectangle.basic_v1","strokeWidth":2,"strokeColor":"#333333","fillColor":"#EEEEEE","gradient":false,"dropShadow":false,"state":0,"shadowX":0,"shadowY":0,"opacity":1}},"children":[{"x":5.000000000000007,"y":0,"rotation":0,"id":7,"uid":null,"width":240.00000000000006,"height":14,"lockAspectRatio":false,"lockShape":false,"order":"auto","hidden":false,"graphic":{"type":"Text","Text":{"tid":null,"valign":"middle","overflow":"none","vposition":"none","hposition":"none","html":"

    Review Prerequisites

    ","paddingLeft":8,"paddingRight":8,"paddingBottom":8,"paddingTop":8,"outerPaddingLeft":6,"outerPaddingRight":6,"outerPaddingBottom":2,"outerPaddingTop":6}},"children":[],"layerId":"8DmkvEaa6dFA"}],"layerId":"8DmkvEaa6dFA","linkMap":[]},{"x":100.00000000000009,"y":60,"rotation":0,"id":57,"uid":"com.gliffy.shape.network.network_v3.business.user","width":39.08333333333333,"height":70,"lockAspectRatio":true,"lockShape":false,"order":7,"hidden":false,"graphic":{"type":"Shape","Shape":{"tid":"com.gliffy.stencil.user_3d.network_v3","strokeWidth":2,"strokeColor":"#000000","fillColor":"#003366","gradient":false,"dropShadow":false,"state":0,"shadowX":0,"shadowY":0,"opacity":1}},"children":[],"layerId":"8DmkvEaa6dFA","linkMap":[]},{"x":230.00000000000006,"y":142,"rotation":0,"id":64,"uid":"com.gliffy.shape.basic.basic_v1.default.rectangle","width":250,"height":50,"lockAspectRatio":false,"lockShape":false,"order":8,"hidden":false,"graphic":{"type":"Shape","Shape":{"tid":"com.gliffy.stencil.rectangle.basic_v1","strokeWidth":2,"strokeColor":"#333333","fillColor":"#EEEEEE","gradient":false,"dropShadow":false,"state":0,"shadowX":0,"shadowY":0,"opacity":1}},"children":[{"x":5.000000000000006,"y":0,"rotation":0,"id":65,"uid":null,"width":240.00000000000003,"height":14,"lockAspectRatio":false,"lockShape":false,"order":"auto","hidden":false,"graphic":{"type":"Text","Text":{"tid":null,"valign":"middle","overflow":"none","vposition":"none","hposition":"none","html":"

    List all Data Sets

    ","paddingLeft":8,"paddingRight":8,"paddingBottom":8,"paddingTop":8,"outerPaddingLeft":6,"outerPaddingRight":6,"outerPaddingBottom":2,"outerPaddingTop":6}},"children":[],"layerId":"8DmkvEaa6dFA"}],"layerId":"8DmkvEaa6dFA","linkMap":[]},{"x":227.50000000000006,"y":214,"rotation":0,"id":66,"uid":"com.gliffy.shape.basic.basic_v1.default.rectangle","width":254.99999999999997,"height":50,"lockAspectRatio":false,"lockShape":false,"order":11,"hidden":false,"graphic":{"type":"Shape","Shape":{"tid":"com.gliffy.stencil.rectangle.basic_v1","strokeWidth":2,"strokeColor":"#333333","fillColor":"#EEEEEE","gradient":false,"dropShadow":false,"state":0,"shadowX":0,"shadowY":0,"opacity":1}},"children":[{"x":1.4999999999999996,"y":0,"rotation":0,"id":84,"uid":null,"width":252.00000000000003,"height":14,"lockAspectRatio":false,"lockShape":false,"order":"auto","hidden":false,"graphic":{"type":"Text","Text":{"tid":null,"valign":"middle","overflow":"none","vposition":"none","hposition":"none","html":"

    List all Members in a Data Set

    ","paddingLeft":8,"paddingRight":8,"paddingBottom":8,"paddingTop":8,"outerPaddingLeft":6,"outerPaddingRight":6,"outerPaddingBottom":2,"outerPaddingTop":6}},"children":null,"layerId":"8DmkvEaa6dFA"}],"layerId":"8DmkvEaa6dFA","linkMap":[]},{"x":230,"y":370,"rotation":0,"id":68,"uid":"com.gliffy.shape.basic.basic_v1.default.rectangle","width":250,"height":50,"lockAspectRatio":false,"lockShape":false,"order":14,"hidden":false,"graphic":{"type":"Shape","Shape":{"tid":"com.gliffy.stencil.rectangle.basic_v1","strokeWidth":2,"strokeColor":"#333333","fillColor":"#EEEEEE","gradient":false,"dropShadow":false,"state":0,"shadowX":0,"shadowY":0,"opacity":1}},"children":[{"x":5.000000000000006,"y":0,"rotation":0,"id":69,"uid":null,"width":240.00000000000003,"height":14,"lockAspectRatio":false,"lockShape":false,"order":"auto","hidden":false,"graphic":{"type":"Text","Text":{"tid":null,"valign":"middle","overflow":"none","vposition":"none","hposition":"none","html":"

    Submit the Job

    ","paddingLeft":8,"paddingRight":8,"paddingBottom":8,"paddingTop":8,"outerPaddingLeft":6,"outerPaddingRight":6,"outerPaddingBottom":2,"outerPaddingTop":6}},"children":[],"layerId":"8DmkvEaa6dFA"}],"layerId":"8DmkvEaa6dFA","linkMap":[]},{"x":232.5,"y":450,"rotation":0,"id":70,"uid":"com.gliffy.shape.basic.basic_v1.default.rectangle","width":250,"height":50,"lockAspectRatio":false,"lockShape":false,"order":17,"hidden":false,"graphic":{"type":"Shape","Shape":{"tid":"com.gliffy.stencil.rectangle.basic_v1","strokeWidth":2,"strokeColor":"#333333","fillColor":"#EEEEEE","gradient":false,"dropShadow":false,"state":0,"shadowX":0,"shadowY":0,"opacity":1}},"children":[{"x":5.000000000000005,"y":0,"rotation":0,"id":71,"uid":null,"width":239.99999999999997,"height":14,"lockAspectRatio":false,"lockShape":false,"order":"auto","hidden":false,"graphic":{"type":"Text","Text":{"tid":null,"valign":"middle","overflow":"none","vposition":"none","hposition":"none","html":"

    Print the Job Log to Verify the Output

    ","paddingLeft":8,"paddingRight":8,"paddingBottom":8,"paddingTop":8,"outerPaddingLeft":6,"outerPaddingRight":6,"outerPaddingBottom":2,"outerPaddingTop":6}},"children":[],"layerId":"8DmkvEaa6dFA"}],"layerId":"8DmkvEaa6dFA","linkMap":[]},{"x":390.875,"y":133,"rotation":0,"id":72,"uid":"com.gliffy.shape.basic.basic_v1.default.line","width":100,"height":100,"lockAspectRatio":false,"lockShape":false,"order":20,"hidden":false,"graphic":{"type":"Line","Line":{"strokeWidth":2,"strokeColor":"#333333","fillColor":"none","dashStyle":null,"startArrow":0,"endArrow":2,"startArrowRotation":"auto","endArrowRotation":"auto","ortho":true,"interpolationType":"linear","cornerRadius":null,"controlPath":[[-35.87499999999994,-13],[-35.87499999999994,-5.666666666666671],[-35.87499999999994,1.6666666666666572],[-35.87499999999994,9]],"lockSegments":{}}},"children":[],"layerId":"8DmkvEaa6dFA","constraints":{"constraints":[],"startConstraint":{"type":"StartPositionConstraint","StartPositionConstraint":{"nodeId":6,"px":0.5,"py":1}},"endConstraint":{"type":"EndPositionConstraint","EndPositionConstraint":{"nodeId":64,"px":0.5,"py":0}}},"linkMap":[]},{"x":389.875,"y":252,"rotation":0,"id":74,"uid":"com.gliffy.shape.basic.basic_v1.default.line","width":100,"height":100,"lockAspectRatio":false,"lockShape":false,"order":21,"hidden":false,"graphic":{"type":"Line","Line":{"strokeWidth":2,"strokeColor":"#333333","fillColor":"none","dashStyle":null,"startArrow":0,"endArrow":2,"startArrowRotation":"auto","endArrowRotation":"auto","ortho":true,"interpolationType":"linear","cornerRadius":null,"controlPath":[[-34.87499999999994,-60],[-34.87499999999994,-52.66666666666666],[-34.87499999999994,-45.33333333333334],[-34.87499999999994,-38]],"lockSegments":{}}},"children":[],"layerId":"8DmkvEaa6dFA","constraints":{"constraints":[],"startConstraint":{"type":"StartPositionConstraint","StartPositionConstraint":{"nodeId":64,"px":0.5,"py":1}},"endConstraint":{"type":"EndPositionConstraint","EndPositionConstraint":{"nodeId":66,"px":0.5,"py":0}}},"linkMap":[]},{"x":394.875,"y":500,"rotation":0,"id":76,"uid":"com.gliffy.shape.basic.basic_v1.default.line","width":100,"height":100,"lockAspectRatio":false,"lockShape":false,"order":22,"hidden":false,"graphic":{"type":"Line","Line":{"strokeWidth":2,"strokeColor":"#333333","fillColor":"none","dashStyle":null,"startArrow":0,"endArrow":2,"startArrowRotation":"auto","endArrowRotation":"auto","ortho":true,"interpolationType":"linear","cornerRadius":null,"controlPath":[[-39.875,-80],[-39.875,-69.96533785100644],[-39.875,-59.93067570201282],[-39.875,-49.89601355301926]],"lockSegments":{}}},"children":[],"layerId":"8DmkvEaa6dFA","constraints":{"constraints":[],"startConstraint":{"type":"StartPositionConstraint","StartPositionConstraint":{"nodeId":68,"px":0.5,"py":1}},"endConstraint":{"type":"EndPositionConstraint","EndPositionConstraint":{"nodeId":70,"px":0.5,"py":0}}},"linkMap":[]},{"x":20.000000000000057,"y":153.5,"rotation":0,"id":78,"uid":"com.gliffy.shape.basic.basic_v1.default.text","width":200,"height":17,"lockAspectRatio":false,"lockShape":false,"order":23,"hidden":false,"graphic":{"type":"Text","Text":{"tid":null,"valign":"middle","overflow":"none","vposition":"none","hposition":"none","html":"

    Application Developer

    ","paddingLeft":2,"paddingRight":2,"paddingBottom":2,"paddingTop":2,"outerPaddingLeft":6,"outerPaddingRight":6,"outerPaddingBottom":2,"outerPaddingTop":6}},"children":[],"layerId":"8DmkvEaa6dFA","linkMap":[]},{"x":230,"y":290,"rotation":0,"id":89,"uid":"com.gliffy.shape.basic.basic_v1.default.rectangle","width":250,"height":50,"lockAspectRatio":false,"lockShape":false,"order":24,"hidden":false,"graphic":{"type":"Shape","Shape":{"tid":"com.gliffy.stencil.rectangle.basic_v1","strokeWidth":2,"strokeColor":"#333333","fillColor":"#EEEEEE","gradient":false,"dropShadow":false,"state":0,"shadowX":0,"shadowY":0,"opacity":1}},"children":[{"x":5.000000000000007,"y":0,"rotation":0,"id":90,"uid":null,"width":240.00000000000006,"height":14,"lockAspectRatio":false,"lockShape":false,"order":26,"hidden":false,"graphic":{"type":"Text","Text":{"tid":null,"valign":"middle","overflow":"none","vposition":"none","hposition":"none","html":"

    Update the JCL Using an Editor

    ","paddingLeft":8,"paddingRight":8,"paddingBottom":8,"paddingTop":8,"outerPaddingLeft":6,"outerPaddingRight":6,"outerPaddingBottom":2,"outerPaddingTop":6}},"children":[],"layerId":"8DmkvEaa6dFA"}],"layerId":"8DmkvEaa6dFA","linkMap":[]},{"x":749,"y":128.88333129882812,"rotation":0,"id":92,"uid":"com.gliffy.shape.basic.basic_v1.default.line","width":100,"height":100,"lockAspectRatio":false,"lockShape":false,"order":28,"hidden":false,"graphic":{"type":"Line","Line":{"strokeWidth":2,"strokeColor":"#333333","fillColor":"none","dashStyle":null,"startArrow":0,"endArrow":2,"startArrowRotation":"auto","endArrowRotation":"auto","ortho":true,"interpolationType":"linear","cornerRadius":null,"controlPath":[[-394,211.11666870117188],[-394,221.11666870117188],[-394,231.11666870117188],[-394,241.11666870117188]],"lockSegments":{}}},"children":[],"layerId":"8DmkvEaa6dFA","constraints":{"constraints":[],"startConstraint":{"type":"StartPositionConstraint","StartPositionConstraint":{"nodeId":89,"px":0.5,"py":1}},"endConstraint":{"type":"EndPositionConstraint","EndPositionConstraint":{"nodeId":68,"px":0.5,"py":0}}},"linkMap":[]},{"x":290,"y":540,"rotation":0,"id":109,"uid":"com.gliffy.shape.flowchart.flowchart_v1.default.decision","width":130,"height":130,"lockAspectRatio":false,"lockShape":false,"order":32,"hidden":false,"graphic":{"type":"Shape","Shape":{"tid":"com.gliffy.stencil.diamond.basic_v1","strokeWidth":2,"strokeColor":"#333333","fillColor":"#eeeeee","gradient":false,"dropShadow":false,"state":0,"shadowX":0,"shadowY":0,"opacity":1}},"children":[{"x":2.3636363636363638,"y":0,"rotation":0,"id":110,"uid":null,"width":125.27272727272728,"height":28,"lockAspectRatio":false,"lockShape":false,"order":34,"hidden":false,"graphic":{"type":"Text","Text":{"tid":null,"valign":"middle","overflow":"none","vposition":"none","hposition":"none","html":"

    Is the Output Correct?

    ","paddingLeft":8,"paddingRight":8,"paddingBottom":8,"paddingTop":8,"outerPaddingLeft":6,"outerPaddingRight":6,"outerPaddingBottom":2,"outerPaddingTop":6}},"children":null,"layerId":"8DmkvEaa6dFA"}],"layerId":"8DmkvEaa6dFA","linkMap":[]},{"x":420,"y":620,"rotation":0,"id":117,"uid":"com.gliffy.shape.basic.basic_v1.default.text","width":50,"height":15,"lockAspectRatio":false,"lockShape":false,"order":37,"hidden":false,"graphic":{"type":"Text","Text":{"tid":null,"valign":"middle","overflow":"none","vposition":"none","hposition":"none","html":"

    No

    ","paddingLeft":2,"paddingRight":2,"paddingBottom":2,"paddingTop":2,"outerPaddingLeft":6,"outerPaddingRight":6,"outerPaddingBottom":2,"outerPaddingTop":6}},"children":null,"layerId":"8DmkvEaa6dFA","linkMap":[]},{"x":290,"y":670,"rotation":0,"id":121,"uid":"com.gliffy.shape.basic.basic_v1.default.text","width":50,"height":15,"lockAspectRatio":false,"lockShape":false,"order":39,"hidden":false,"graphic":{"type":"Text","Text":{"tid":null,"valign":"middle","overflow":"none","vposition":"none","hposition":"none","html":"

    Yes

    ","paddingLeft":2,"paddingRight":2,"paddingBottom":2,"paddingTop":2,"outerPaddingLeft":6,"outerPaddingRight":6,"outerPaddingBottom":2,"outerPaddingTop":6}},"children":null,"layerId":"8DmkvEaa6dFA","linkMap":[]}],"imageCache":null,"background":"#FFFFFF","width":658,"height":760,"maxWidth":5000,"maxHeight":5000,"nodeIndex":131,"autoFit":true,"exportBorder":false,"gridOn":true,"snapToGrid":true,"drawingGuidesOn":true,"pageBreaksOn":false,"printGridOn":false,"printPaper":"LETTER","printShrinkToFit":false,"printPortrait":true,"shapeStyles":{"com.gliffy.shape.basic.basic_v1.default":{"fill":"#cfe2f3","stroke":"#000000","strokeWidth":2,"gradient":true},"com.gliffy.shape.network.network_v3.business":{"fill":"#003366","stroke":"#000000","strokeWidth":2}},"lineStyles":{"global":{"fill":"none","stroke":"#333333","strokeWidth":2,"endArrow":2,"orthoMode":0}},"textStyles":{"global":{"face":"Arial","size":"14px","color":"#000000"}},"themeData":{"uid":"com.gliffy.theme.daily_glyph","name":"The Daily Glyph","shape":{"primary":{"strokeWidth":2,"strokeColor":"#333333","fillColor":"#EEEEEE","gradient":false,"dropShadow":false,"opacity":1,"text":{"color":"#000000"}},"secondary":{"strokeWidth":2,"strokeColor":"#666666","fillColor":"#FFFFFF","gradient":false,"dropShadow":false,"opacity":1,"text":{"color":"#000000"}},"tertiary":{"strokeWidth":2,"strokeColor":"#333333","fillColor":"#CCCCCC","gradient":false,"dropShadow":false,"opacity":1,"text":{"color":"#000000"}},"highlight":{"strokeWidth":2,"strokeColor":"#333333","fillColor":"#333333","gradient":false,"dropShadow":false,"opacity":1,"text":{"color":"#FFFFFF"}}},"line":{"strokeWidth":2,"strokeColor":"#333333","fillColor":"none","arrowType":2,"interpolationType":"linear","cornerRadius":0,"text":{"color":"#000000"}},"text":{"color":"#000000"},"stage":{}},"viewportType":"default","layers":[{"guid":"8DmkvEaa6dFA","order":0,"name":"Layer 0","active":true,"locked":false,"visible":true,"nodeIndex":47}],"fitBB":{"min":{"x":22.000000000000057,"y":26},"max":{"x":657.9999999999999,"y":759.8833312988281}},"printModel":{"pageSize":"a4","portrait":false,"fitToOnePage":false,"displayPageBreaks":false}}} \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/images/scenario/441193422.png b/versioned_docs/version-v2.15.x/images/scenario/441193422.png new file mode 100644 index 0000000000..4cb111b71c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/scenario/441193422.png differ diff --git a/versioned_docs/version-v2.15.x/images/scenario/441193423.png b/versioned_docs/version-v2.15.x/images/scenario/441193423.png new file mode 100644 index 0000000000..8738722560 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/scenario/441193423.png differ diff --git a/versioned_docs/version-v2.15.x/images/scenario/441193424.png b/versioned_docs/version-v2.15.x/images/scenario/441193424.png new file mode 100644 index 0000000000..31a40e720c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/scenario/441193424.png differ diff --git a/versioned_docs/version-v2.15.x/images/troubleshoot/ZE/new-logs-folder-path.png b/versioned_docs/version-v2.15.x/images/troubleshoot/ZE/new-logs-folder-path.png new file mode 100644 index 0000000000..24555435bd Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/troubleshoot/ZE/new-logs-folder-path.png differ diff --git a/versioned_docs/version-v2.15.x/images/troubleshoot/ZE/new-temp-folder-path.png b/versioned_docs/version-v2.15.x/images/troubleshoot/ZE/new-temp-folder-path.png new file mode 100644 index 0000000000..7a760463b2 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/troubleshoot/ZE/new-temp-folder-path.png differ diff --git a/versioned_docs/version-v2.15.x/images/troubleshoot/ZE/write-access-error-logs-folder.png b/versioned_docs/version-v2.15.x/images/troubleshoot/ZE/write-access-error-logs-folder.png new file mode 100644 index 0000000000..6ee89b4941 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/troubleshoot/ZE/write-access-error-logs-folder.png differ diff --git a/versioned_docs/version-v2.15.x/images/troubleshoot/ZE/write-access-error-temp-folder.png b/versioned_docs/version-v2.15.x/images/troubleshoot/ZE/write-access-error-temp-folder.png new file mode 100644 index 0000000000..b07026658a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/troubleshoot/ZE/write-access-error-temp-folder.png differ diff --git a/versioned_docs/version-v2.15.x/images/troubleshoot/cli/home_struc.png b/versioned_docs/version-v2.15.x/images/troubleshoot/cli/home_struc.png new file mode 100644 index 0000000000..cb1a774e24 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/troubleshoot/cli/home_struc.png differ diff --git a/versioned_docs/version-v2.15.x/images/troubleshoot/cli/zowe_config_report_env_warn_message.jpg b/versioned_docs/version-v2.15.x/images/troubleshoot/cli/zowe_config_report_env_warn_message.jpg new file mode 100644 index 0000000000..34f6eb195e Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/troubleshoot/cli/zowe_config_report_env_warn_message.jpg differ diff --git a/versioned_docs/version-v2.15.x/images/troubleshoot/how-to-troubleshooting.gif b/versioned_docs/version-v2.15.x/images/troubleshoot/how-to-troubleshooting.gif new file mode 100644 index 0000000000..6d22eafb52 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/troubleshoot/how-to-troubleshooting.gif differ diff --git a/versioned_docs/version-v2.15.x/images/troubleshoot/search-bar-2.png b/versioned_docs/version-v2.15.x/images/troubleshoot/search-bar-2.png new file mode 100644 index 0000000000..f3ecc55e30 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/troubleshoot/search-bar-2.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/all-resources.gif b/versioned_docs/version-v2.15.x/images/ze-cics/all-resources.gif new file mode 100644 index 0000000000..af7786c63b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/all-resources.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/cics-latest-vsix.png b/versioned_docs/version-v2.15.x/images/ze-cics/cics-latest-vsix.png new file mode 100644 index 0000000000..04b1729e6f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/cics-latest-vsix.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/cics-tree-in-zowe-pane.png b/versioned_docs/version-v2.15.x/images/ze-cics/cics-tree-in-zowe-pane.png new file mode 100644 index 0000000000..8ab073d313 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/cics-tree-in-zowe-pane.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/create-profile-from-config.gif b/versioned_docs/version-v2.15.x/images/ze-cics/create-profile-from-config.gif new file mode 100644 index 0000000000..aad791d5ba Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/create-profile-from-config.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/create-profile.gif b/versioned_docs/version-v2.15.x/images/ze-cics/create-profile.gif new file mode 100644 index 0000000000..80f0dc580f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/create-profile.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/create-session.png b/versioned_docs/version-v2.15.x/images/ze-cics/create-session.png new file mode 100644 index 0000000000..bb8335ac8f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/create-session.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/delete-profile-from-config.gif b/versioned_docs/version-v2.15.x/images/ze-cics/delete-profile-from-config.gif new file mode 100644 index 0000000000..bfc847ea92 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/delete-profile-from-config.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/delete-profile.gif b/versioned_docs/version-v2.15.x/images/ze-cics/delete-profile.gif new file mode 100644 index 0000000000..e23905d049 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/delete-profile.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/disable-enable.gif b/versioned_docs/version-v2.15.x/images/ze-cics/disable-enable.gif new file mode 100644 index 0000000000..b4193c44c9 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/disable-enable.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/expand-error-cics.gif b/versioned_docs/version-v2.15.x/images/ze-cics/expand-error-cics.gif new file mode 100644 index 0000000000..df09380baf Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/expand-error-cics.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/filter-programs.gif b/versioned_docs/version-v2.15.x/images/ze-cics/filter-programs.gif new file mode 100644 index 0000000000..b140f85730 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/filter-programs.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/filter.gif b/versioned_docs/version-v2.15.x/images/ze-cics/filter.gif new file mode 100644 index 0000000000..27a64e4c20 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/filter.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/hide-profile.gif b/versioned_docs/version-v2.15.x/images/ze-cics/hide-profile.gif new file mode 100644 index 0000000000..e922e7e80c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/hide-profile.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/info-message-install-completed.png b/versioned_docs/version-v2.15.x/images/ze-cics/info-message-install-completed.png new file mode 100644 index 0000000000..5d2bd5ae4f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/info-message-install-completed.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/new-copy.gif b/versioned_docs/version-v2.15.x/images/ze-cics/new-copy.gif new file mode 100644 index 0000000000..2b66394901 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/new-copy.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/open-close.gif b/versioned_docs/version-v2.15.x/images/ze-cics/open-close.gif new file mode 100644 index 0000000000..076375ff73 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/open-close.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/plex-filter.gif b/versioned_docs/version-v2.15.x/images/ze-cics/plex-filter.gif new file mode 100644 index 0000000000..24570758a0 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/plex-filter.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/program-newcopy-action.png b/versioned_docs/version-v2.15.x/images/ze-cics/program-newcopy-action.png new file mode 100644 index 0000000000..3d15ecfd0e Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/program-newcopy-action.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/program-newcopy.gif b/versioned_docs/version-v2.15.x/images/ze-cics/program-newcopy.gif new file mode 100644 index 0000000000..59fa99749a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/program-newcopy.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/program-phasein-action.png b/versioned_docs/version-v2.15.x/images/ze-cics/program-phasein-action.png new file mode 100644 index 0000000000..7a30d9d385 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/program-phasein-action.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/programs-newcopycount.png b/versioned_docs/version-v2.15.x/images/ze-cics/programs-newcopycount.png new file mode 100644 index 0000000000..3f4bc0b687 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/programs-newcopycount.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/refresh-icon.png b/versioned_docs/version-v2.15.x/images/ze-cics/refresh-icon.png new file mode 100644 index 0000000000..6fa6fb2437 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/refresh-icon.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/region-filter.gif b/versioned_docs/version-v2.15.x/images/ze-cics/region-filter.gif new file mode 100644 index 0000000000..850eb91ece Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/region-filter.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/resource-filter-clear.png b/versioned_docs/version-v2.15.x/images/ze-cics/resource-filter-clear.png new file mode 100644 index 0000000000..49a6c71193 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/resource-filter-clear.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/resource-filter.png b/versioned_docs/version-v2.15.x/images/ze-cics/resource-filter.png new file mode 100644 index 0000000000..cab53b4413 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/resource-filter.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/resource-type-local-files.png b/versioned_docs/version-v2.15.x/images/ze-cics/resource-type-local-files.png new file mode 100644 index 0000000000..12730ca995 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/resource-type-local-files.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/resource-type-programs.png b/versioned_docs/version-v2.15.x/images/ze-cics/resource-type-programs.png new file mode 100644 index 0000000000..70d2d768fa Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/resource-type-programs.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/resource-type-transactions.png b/versioned_docs/version-v2.15.x/images/ze-cics/resource-type-transactions.png new file mode 100644 index 0000000000..4d7b3b2998 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/resource-type-transactions.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/running-in-debug-mode.gif b/versioned_docs/version-v2.15.x/images/ze-cics/running-in-debug-mode.gif new file mode 100644 index 0000000000..f57ccb5641 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/running-in-debug-mode.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/show-attributes.gif b/versioned_docs/version-v2.15.x/images/ze-cics/show-attributes.gif new file mode 100644 index 0000000000..65d17c0dfb Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/show-attributes.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/untrusted-cert.gif b/versioned_docs/version-v2.15.x/images/ze-cics/untrusted-cert.gif new file mode 100644 index 0000000000..e061872b5c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/untrusted-cert.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/update-profile-from-config.gif b/versioned_docs/version-v2.15.x/images/ze-cics/update-profile-from-config.gif new file mode 100644 index 0000000000..6dc5bdd7bb Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/update-profile-from-config.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/update-profile.gif b/versioned_docs/version-v2.15.x/images/ze-cics/update-profile.gif new file mode 100644 index 0000000000..b4a4c60102 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/update-profile.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze-cics/zowe-cics-explorer-install.gif b/versioned_docs/version-v2.15.x/images/ze-cics/zowe-cics-explorer-install.gif new file mode 100644 index 0000000000..8c6e8c1302 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze-cics/zowe-cics-explorer-install.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-Configuration.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-Configuration.gif new file mode 100644 index 0000000000..9cd8c7a596 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-Configuration.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-Configuration2.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-Configuration2.gif new file mode 100644 index 0000000000..0f74f96b35 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-Configuration2.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-CreateDelete.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-CreateDelete.gif new file mode 100644 index 0000000000..4e63a0962c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-CreateDelete.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-Jobs-Issue-TSO-Command.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-Jobs-Issue-TSO-Command.gif new file mode 100644 index 0000000000..fa91489ca0 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-Jobs-Issue-TSO-Command.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-Settings.jpg b/versioned_docs/version-v2.15.x/images/ze/ZE-Settings.jpg new file mode 100644 index 0000000000..5c2555149b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-Settings.jpg differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-SubmitJobConfirm.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-SubmitJobConfirm.gif new file mode 100644 index 0000000000..4e2510d251 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-SubmitJobConfirm.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-TSO-Command.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-TSO-Command.gif new file mode 100644 index 0000000000..d028d954b2 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-TSO-Command.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-allocate-like.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-allocate-like.gif new file mode 100644 index 0000000000..a4288919fa Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-allocate-like.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-allocate.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-allocate.gif new file mode 100644 index 0000000000..f1a02dde1f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-allocate.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-associate.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-associate.gif new file mode 100644 index 0000000000..3e9f654361 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-associate.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-basic.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-basic.gif new file mode 100644 index 0000000000..8032ebf2f2 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-basic.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-cancel-jobs.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-cancel-jobs.gif new file mode 100644 index 0000000000..4a6e1a9038 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-cancel-jobs.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-copy-member.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-copy-member.gif new file mode 100644 index 0000000000..38516a574b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-copy-member.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-copy.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-copy.gif new file mode 100644 index 0000000000..e5e1aed64f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-copy.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-cre-pds-member.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-cre-pds-member.gif new file mode 100644 index 0000000000..4c155c6d6e Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-cre-pds-member.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-del-pds-member.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-del-pds-member.gif new file mode 100644 index 0000000000..ee607491e4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-del-pds-member.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-delete-ds.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-delete-ds.gif new file mode 100644 index 0000000000..0c2609cde1 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-delete-ds.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-download-edit.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-download-edit.gif new file mode 100644 index 0000000000..f48f99515c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-download-edit.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-edit-upload.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-edit-upload.gif new file mode 100644 index 0000000000..0926bd578f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-edit-upload.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-edit-ze-profile.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-edit-ze-profile.gif new file mode 100644 index 0000000000..51e238f87b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-edit-ze-profile.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-editUSS.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-editUSS.gif new file mode 100644 index 0000000000..a074d8e804 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-editUSS.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-extend.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-extend.gif new file mode 100644 index 0000000000..b39186ce9c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-extend.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-filtering-a-specific-PDS.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-filtering-a-specific-PDS.gif new file mode 100644 index 0000000000..4c6b1b839f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-filtering-a-specific-PDS.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-filtering-profile-PDS-members.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-filtering-profile-PDS-members.gif new file mode 100644 index 0000000000..e4483375be Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-filtering-profile-PDS-members.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-ftp-find-source.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-ftp-find-source.gif new file mode 100644 index 0000000000..76964c223a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-ftp-find-source.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-jobs-download-spool.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-jobs-download-spool.gif new file mode 100644 index 0000000000..caf7dbfef6 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-jobs-download-spool.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-jobs-get-jcl.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-jobs-get-jcl.gif new file mode 100644 index 0000000000..05ec8a0cd6 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-jobs-get-jcl.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-member-filter-search.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-member-filter-search.gif new file mode 100644 index 0000000000..5ce713e216 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-member-filter-search.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-mult-profiles.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-mult-profiles.gif new file mode 100644 index 0000000000..1d2b2b8a7d Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-mult-profiles.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-multiple-search.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-multiple-search.gif new file mode 100644 index 0000000000..1dbdea0912 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-multiple-search.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-newProfiles.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-newProfiles.gif new file mode 100644 index 0000000000..a9f6a8c476 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-newProfiles.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-path.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-path.gif new file mode 100644 index 0000000000..e0dc03f576 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-path.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-prof-update.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-prof-update.gif new file mode 100644 index 0000000000..accb657bff Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-prof-update.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-profile-api.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-profile-api.gif new file mode 100644 index 0000000000..e82a5ab76d Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-profile-api.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-profile-links.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-profile-links.gif new file mode 100644 index 0000000000..da7cc20415 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-profile-links.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-profile2.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-profile2.gif new file mode 100644 index 0000000000..ae1028f333 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-profile2.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-proxy-support-off.png b/versioned_docs/version-v2.15.x/images/ze/ZE-proxy-support-off.png new file mode 100644 index 0000000000..779211ea9b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-proxy-support-off.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-refresh-all.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-refresh-all.gif new file mode 100644 index 0000000000..893e9c0389 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-refresh-all.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-refreshUSS.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-refreshUSS.gif new file mode 100644 index 0000000000..7a5bc277c9 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-refreshUSS.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-rename.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-rename.gif new file mode 100644 index 0000000000..9bbce6d4cd Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-rename.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-save.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-save.gif new file mode 100644 index 0000000000..34cebebc6b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-save.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-set-params.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-set-params.gif new file mode 100644 index 0000000000..948cfc7253 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-set-params.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-show-attributes.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-show-attributes.gif new file mode 100644 index 0000000000..eac4fcd1eb Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-show-attributes.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-show-config-button.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-show-config-button.gif new file mode 100644 index 0000000000..4b8ecf4a34 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-show-config-button.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-socket-connection-error.png b/versioned_docs/version-v2.15.x/images/ze/ZE-socket-connection-error.png new file mode 100644 index 0000000000..27b84b2bbc Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-socket-connection-error.png differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-sorting-a-specific-PDS.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-sorting-a-specific-PDS.gif new file mode 100644 index 0000000000..1e4fbe7804 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-sorting-a-specific-PDS.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-sorting-jobs-by-date-completed.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-sorting-jobs-by-date-completed.gif new file mode 100644 index 0000000000..3dde97db97 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-sorting-jobs-by-date-completed.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-sorting-jobs.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-sorting-jobs.gif new file mode 100644 index 0000000000..1861a96c1c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-sorting-jobs.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-sorting-profile-PDS-members.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-sorting-profile-PDS-members.gif new file mode 100644 index 0000000000..8f19f52d09 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-sorting-profile-PDS-members.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-start-polling-V2.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-start-polling-V2.gif new file mode 100644 index 0000000000..9b6248037a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-start-polling-V2.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-submit-jcl.gif b/versioned_docs/version-v2.15.x/images/ze/ZE-submit-jcl.gif new file mode 100644 index 0000000000..93f23b257d Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-submit-jcl.gif differ diff --git a/versioned_docs/version-v2.15.x/images/ze/ZE-zowe-explorer-result-item.jpg b/versioned_docs/version-v2.15.x/images/ze/ZE-zowe-explorer-result-item.jpg new file mode 100644 index 0000000000..a513314e55 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/ze/ZE-zowe-explorer-result-item.jpg differ diff --git a/versioned_docs/version-v2.15.x/images/zosmf/433363266.png b/versioned_docs/version-v2.15.x/images/zosmf/433363266.png new file mode 100644 index 0000000000..e8577ccfac Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zosmf/433363266.png differ diff --git a/versioned_docs/version-v2.15.x/images/zosmf/IZUG349I.png b/versioned_docs/version-v2.15.x/images/zosmf/IZUG349I.png new file mode 100644 index 0000000000..4ce82a5421 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zosmf/IZUG349I.png differ diff --git a/versioned_docs/version-v2.15.x/images/zosmf/IZUMKFS1.png b/versioned_docs/version-v2.15.x/images/zosmf/IZUMKFS1.png new file mode 100644 index 0000000000..1ef2c37392 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zosmf/IZUMKFS1.png differ diff --git a/versioned_docs/version-v2.15.x/images/zosmf/IZUMKFS2.png b/versioned_docs/version-v2.15.x/images/zosmf/IZUMKFS2.png new file mode 100644 index 0000000000..2fca3c8eb6 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zosmf/IZUMKFS2.png differ diff --git a/versioned_docs/version-v2.15.x/images/zosmf/IZUMKFS3.png b/versioned_docs/version-v2.15.x/images/zosmf/IZUMKFS3.png new file mode 100644 index 0000000000..e0bec23cf7 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zosmf/IZUMKFS3.png differ diff --git a/versioned_docs/version-v2.15.x/images/zosmf/Welcome.png b/versioned_docs/version-v2.15.x/images/zosmf/Welcome.png new file mode 100644 index 0000000000..cdacc0b46c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zosmf/Welcome.png differ diff --git a/versioned_docs/version-v2.15.x/images/zosmf/perform-workflows.jpg b/versioned_docs/version-v2.15.x/images/zosmf/perform-workflows.jpg new file mode 100644 index 0000000000..d03c33515f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zosmf/perform-workflows.jpg differ diff --git a/versioned_docs/version-v2.15.x/images/zosmf/zOSMF-HA.png b/versioned_docs/version-v2.15.x/images/zosmf/zOSMF-HA.png new file mode 100644 index 0000000000..55fb7be1d7 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zosmf/zOSMF-HA.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/add_account.png b/versioned_docs/version-v2.15.x/images/zowe-chat/add_account.png new file mode 100644 index 0000000000..0153c699f6 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/add_account.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/add_members.png b/versioned_docs/version-v2.15.x/images/zowe-chat/add_members.png new file mode 100644 index 0000000000..b67ba84d8b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/add_members.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/app_features.png b/versioned_docs/version-v2.15.x/images/zowe-chat/app_features.png new file mode 100644 index 0000000000..ff9e037f77 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/app_features.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/azure_bot_channel_registration.png b/versioned_docs/version-v2.15.x/images/zowe-chat/azure_bot_channel_registration.png new file mode 100644 index 0000000000..66666b272f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/azure_bot_channel_registration.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/azure_create.png b/versioned_docs/version-v2.15.x/images/zowe-chat/azure_create.png new file mode 100644 index 0000000000..aff60eb59d Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/azure_create.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/azure_registration_create.png b/versioned_docs/version-v2.15.x/images/zowe-chat/azure_registration_create.png new file mode 100644 index 0000000000..0247e8d4e0 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/azure_registration_create.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/bot_accounts.png b/versioned_docs/version-v2.15.x/images/zowe-chat/bot_accounts.png new file mode 100644 index 0000000000..0f4773182b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/bot_accounts.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/chat-HLA.png b/versioned_docs/version-v2.15.x/images/zowe-chat/chat-HLA.png new file mode 100644 index 0000000000..b3e322a5cb Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/chat-HLA.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/create_admin_account.png b/versioned_docs/version-v2.15.x/images/zowe-chat/create_admin_account.png new file mode 100644 index 0000000000..e9e68f631a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/create_admin_account.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/create_new_team.png b/versioned_docs/version-v2.15.x/images/zowe-chat/create_new_team.png new file mode 100644 index 0000000000..83560d0809 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/create_new_team.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/environment_web_server.png b/versioned_docs/version-v2.15.x/images/zowe-chat/environment_web_server.png new file mode 100644 index 0000000000..e2a271b047 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/environment_web_server.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/integrations_dialog.png b/versioned_docs/version-v2.15.x/images/zowe-chat/integrations_dialog.png new file mode 100644 index 0000000000..83b1a37adc Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/integrations_dialog.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_add.png b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_add.png new file mode 100644 index 0000000000..d9bf454b95 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_add.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_add_zowechat.png b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_add_zowechat.png new file mode 100644 index 0000000000..c87804b027 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_add_zowechat.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_channel_link.png b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_channel_link.png new file mode 100644 index 0000000000..2a12cb244c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_channel_link.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_channel_panel.png b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_channel_panel.png new file mode 100644 index 0000000000..be6dcecca3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_channel_panel.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_create_new.png b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_create_new.png new file mode 100644 index 0000000000..babf56bb35 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_create_new.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_integrations.png b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_integrations.png new file mode 100644 index 0000000000..4502b2c50c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_integrations.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_invite.png b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_invite.png new file mode 100644 index 0000000000..58ec0ba7aa Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_invite.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_invite_people.png b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_invite_people.png new file mode 100644 index 0000000000..d61c42e0f6 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_invite_people.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_invite_team.png b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_invite_team.png new file mode 100644 index 0000000000..ab6320442a Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_invite_team.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_invited.png b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_invited.png new file mode 100644 index 0000000000..5faa945e26 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_invited.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_members.png b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_members.png new file mode 100644 index 0000000000..7660d40f93 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_members.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_system_console.png b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_system_console.png new file mode 100644 index 0000000000..d91a0435da Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/mattermost_system_console.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/new_app_panel.png b/versioned_docs/version-v2.15.x/images/zowe-chat/new_app_panel.png new file mode 100644 index 0000000000..6bf4953ce0 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/new_app_panel.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/new_app_panel2.png b/versioned_docs/version-v2.15.x/images/zowe-chat/new_app_panel2.png new file mode 100644 index 0000000000..4bc07a8b3f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/new_app_panel2.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/slack_add.png b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_add.png new file mode 100644 index 0000000000..d5ce248ec4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_add.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/slack_addapp.png b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_addapp.png new file mode 100644 index 0000000000..9b8da5b7ab Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_addapp.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/slack_app_config.png b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_app_config.png new file mode 100644 index 0000000000..21c3c9a083 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_app_config.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/slack_channelhead.png b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_channelhead.png new file mode 100644 index 0000000000..ea90147b34 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_channelhead.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/slack_createApp.png b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_createApp.png new file mode 100644 index 0000000000..480c4c2e0c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_createApp.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/slack_invitebot.png b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_invitebot.png new file mode 100644 index 0000000000..1950800039 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_invitebot.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/slack_notification.png b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_notification.png new file mode 100644 index 0000000000..20b86d5eb1 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_notification.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/slack_signing.png b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_signing.png new file mode 100644 index 0000000000..daa41da446 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_signing.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/slack_signingsecret.png b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_signingsecret.png new file mode 100644 index 0000000000..57202bdbab Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_signingsecret.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/slack_slackbot.png b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_slackbot.png new file mode 100644 index 0000000000..2ceeb74426 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_slackbot.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/slack_socketmode.png b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_socketmode.png new file mode 100644 index 0000000000..5dbb0b7ffb Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/slack_socketmode.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/system_console_enable_connections.png b/versioned_docs/version-v2.15.x/images/zowe-chat/system_console_enable_connections.png new file mode 100644 index 0000000000..4f993f8982 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/system_console_enable_connections.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/system_console_environment.png b/versioned_docs/version-v2.15.x/images/zowe-chat/system_console_environment.png new file mode 100644 index 0000000000..26d822ce0b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/system_console_environment.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/system_console_integrations.png b/versioned_docs/version-v2.15.x/images/zowe-chat/system_console_integrations.png new file mode 100644 index 0000000000..efcbcee03e Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/system_console_integrations.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/system_console_menu.png b/versioned_docs/version-v2.15.x/images/zowe-chat/system_console_menu.png new file mode 100644 index 0000000000..2d7d7bc160 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/system_console_menu.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/team_name.png b/versioned_docs/version-v2.15.x/images/zowe-chat/team_name.png new file mode 100644 index 0000000000..a4d3f371d5 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/team_name.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/team_url.png b/versioned_docs/version-v2.15.x/images/zowe-chat/team_url.png new file mode 100644 index 0000000000..4a41684dc4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/team_url.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_add.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_add.png new file mode 100644 index 0000000000..3a35667fbf Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_add.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_add_app.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_add_app.png new file mode 100644 index 0000000000..2d25f3aa65 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_add_app.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_add_team.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_add_team.png new file mode 100644 index 0000000000..41a6666e78 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_add_team.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_add.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_add.png new file mode 100644 index 0000000000..90f332040c Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_add.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_add2.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_add2.png new file mode 100644 index 0000000000..b1ce1c4810 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_add2.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_catalog.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_catalog.png new file mode 100644 index 0000000000..b9e3f43efd Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_catalog.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_identification.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_identification.png new file mode 100644 index 0000000000..407837edf1 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_identification.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_names.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_names.png new file mode 100644 index 0000000000..663d3f9b4e Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_names.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_package.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_package.png new file mode 100644 index 0000000000..6a8ac2baf7 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_package.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_pane.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_pane.png new file mode 100644 index 0000000000..49b1eee43b Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_pane.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_panel.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_panel.png new file mode 100644 index 0000000000..e049babffb Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_panel.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_panel2.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_panel2.png new file mode 100644 index 0000000000..7b9f1ec4c4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_panel2.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_select.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_select.png new file mode 100644 index 0000000000..1c557e7121 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_select.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_studio.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_studio.png new file mode 100644 index 0000000000..26674656d3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_app_studio.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_bot_management.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_bot_management.png new file mode 100644 index 0000000000..ec8f6d6864 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_bot_management.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_bot_name.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_bot_name.png new file mode 100644 index 0000000000..173ed6f0d5 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_bot_name.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_bots_menu.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_bots_menu.png new file mode 100644 index 0000000000..abdf1f9bfd Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_bots_menu.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_create.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_create.png new file mode 100644 index 0000000000..4d484bb665 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_create.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_create_app.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_create_app.png new file mode 100644 index 0000000000..fdad8ad8f7 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_create_app.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_description.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_description.png new file mode 100644 index 0000000000..92a39e45f8 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_description.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_developer_icon.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_developer_icon.png new file mode 100644 index 0000000000..86a79e9da6 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_developer_icon.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_developer_portal_apps.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_developer_portal_apps.png new file mode 100644 index 0000000000..c44e7bebe4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_developer_portal_apps.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_developer_protal.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_developer_protal.png new file mode 100644 index 0000000000..af6254d001 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_developer_protal.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_download_app_package.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_download_app_package.png new file mode 100644 index 0000000000..dcdd876598 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_download_app_package.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_endpoint.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_endpoint.png new file mode 100644 index 0000000000..efbb09d8cf Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_endpoint.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_endpoint_address.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_endpoint_address.png new file mode 100644 index 0000000000..5f63d3b1e3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_endpoint_address.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_finish.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_finish.png new file mode 100644 index 0000000000..4b502ad6f2 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_finish.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_information.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_information.png new file mode 100644 index 0000000000..5ec078faff Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_information.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_install.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_install.png new file mode 100644 index 0000000000..7aa9178f24 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_install.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_manage_your_apps.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_manage_your_apps.png new file mode 100644 index 0000000000..ded3ce71f6 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_manage_your_apps.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_new_bot.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_new_bot.png new file mode 100644 index 0000000000..114b55874e Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_new_bot.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_publish.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_publish.png new file mode 100644 index 0000000000..74736f50e4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_publish.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_publish_org.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_publish_org.png new file mode 100644 index 0000000000..98049babe9 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_publish_org.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_secret.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_secret.png new file mode 100644 index 0000000000..128cd9af92 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_secret.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_setup.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_setup.png new file mode 100644 index 0000000000..2cb6da206d Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_setup.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_setup_bot.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_setup_bot.png new file mode 100644 index 0000000000..7ac91259db Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_setup_bot.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_setup_existing.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_setup_existing.png new file mode 100644 index 0000000000..17070df3a4 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_setup_existing.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_submit_org.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_submit_org.png new file mode 100644 index 0000000000..b5bfeed0f5 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_submit_org.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_tool_pane.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_tool_pane.png new file mode 100644 index 0000000000..6a75800f4f Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_tool_pane.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_upload_custom_app.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_upload_custom_app.png new file mode 100644 index 0000000000..7ebbe09ca3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_upload_custom_app.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/teams_yourbot.png b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_yourbot.png new file mode 100644 index 0000000000..36e61e4886 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/teams_yourbot.png differ diff --git a/versioned_docs/version-v2.15.x/images/zowe-chat/token.png b/versioned_docs/version-v2.15.x/images/zowe-chat/token.png new file mode 100644 index 0000000000..041cf98bc3 Binary files /dev/null and b/versioned_docs/version-v2.15.x/images/zowe-chat/token.png differ diff --git a/versioned_docs/version-v2.15.x/troubleshoot/app-framework/app-issue.md b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/app-issue.md new file mode 100644 index 0000000000..d5f8fa7ff2 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/app-issue.md @@ -0,0 +1,7 @@ +# Raising a Zowe Application Framework issue on GitHub + +When necessary, you can raise GitHub issues against the Zowe™ zlux core repository [here](https://github.com/zowe/zlux/issues). This issue tracker is for the Desktop, the apps, and the app-server component. It is suggested that you use the template that best matches what you want to talk about. + +If you need to open an issue about configmgr, ZSS, or ZIS you should instead open a ticket at the zss repository [here](https://github.com/zowe/zss/issues) + +If you have a general server install & configuration issue, you should instead open a ticket in the community repository [here](https://github.com/zowe/community/issues) diff --git a/versioned_docs/version-v2.15.x/troubleshoot/app-framework/app-mustgather.md b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/app-mustgather.md new file mode 100644 index 0000000000..4ac2843134 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/app-mustgather.md @@ -0,0 +1,14 @@ +# Gathering information to troubleshoot Zowe Application Framework + +If you need to contact a support group for Zowe, they will likely need a variety of information from you to help you. This page details a list of items you should gather to the best of your ability to provide to your support group. You may also find this list useful for independent troubleshooting. + +## Basic information + +Please review [the list of information needed for general server support](../servers/must-gather.md). + +## Javascript console output + +When the web UI such as the Zowe Desktop or Apps inside it have an issue, the root problem may originate from either server-side or browser-side behavior. +In addition to the server logs, the browser logs should be gathered. They can be accessed by opening a browser's web developer toolkit. Most browsers allow this via pressing F12. + +Read more about it [here](https://developers.google.com/web/tools/chrome-devtools/open). diff --git a/versioned_docs/version-v2.15.x/troubleshoot/app-framework/app-return-codes.md b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/app-return-codes.md new file mode 100644 index 0000000000..d9df47aef0 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/app-return-codes.md @@ -0,0 +1,11 @@ +# app-server Return Codes + +If the app-server abnormally ends with a return code, this may originate from the app-server itself or from the programs involved in starting the server. [Return codes from the startup process are documented here](../servers/return-codes), while the app-server specific codes are listed below. + +| Return code | Explanation | +|-------------|-------------| +| 2 | Generic cause, check logs for more information. | +| 3 | Insufficient authentication configuration. The server found no authentication plugins, or all of the plugins found failed to load, or no plugins were found for the specific default auth type requested, or the entire auth configuration was missing. More specific error messages will be found in the logs. | +| 4 | The server encountered an error when reading the PFX file requested in the HTTPS configuration. ZWED0070W in the logs will explain the error in more detail. | +| 5 | The server could not establish networking for one of several possible reasons, and a ZWED error message in the logs will explain the error in more detail. | +| 7 | The configuration requested loading a z/OS keyring when not running on z/OS. The error ZWED0145E is also logged. | diff --git a/versioned_docs/version-v2.15.x/troubleshoot/app-framework/app-troubleshoot.md b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/app-troubleshoot.md new file mode 100644 index 0000000000..65b3a26ebf --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/app-troubleshoot.md @@ -0,0 +1,330 @@ +# Troubleshooting Zowe Application Framework + +The following topics contain information that can help you troubleshoot problems when you encounter unexpected behavior installing and using Zowe™ Application Framework which includes the Zowe Desktop. + +Most of the solutions below identify issues by referring to the [Zowe logs](app-mustgather.md). To identify and resolve issues, you should be familiar with their names and locations. + +The Zowe Application Framework manages issues in GitHub. When you troubleshoot a problem, you can check whether a GitHub issue (open or closed) that covers the problem already exists. For a list of issues, see the [zlux repo](https://github.com/zowe/zlux/issues). + +## Desktop apps fail to load + +**Symptom:** + +When you open apps in the Zowe desktop, a page is displayed with the message "The plugin failed to load." + +**Solution:** + +This problem may occur due to file encoding. If this occurs in a Zowe extension, verify it is correctly encoded. + +## NODEJSAPP disables immediately + +**Symptom:** + +You receive the message `CEE5207E The signal SIGABRT was received in stderr`. + +**Solution:** + +You might have reached the limit for shared message queues on your LPAR. When Node.js applications are terminated by a SIGKILL signal, shared message queues might not be deallocated. For more information, see the **If the NODEJSAPP disables immediately** section in the [Troubleshooting Node.js applications](https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.5.0/troubleshooting/node/node-troubleshooting.html) topic on IBM Knowledge Center. + +## Cannot log in to the Zowe Desktop + +**Symptom:** + +When you attempt to log in to the Zowe Desktop, you receive the following error message that is displayed beneath the **Username** and **Password** fields. + +``` +Authentication failed for 3 types: Types: ["saf","apiml","zss"] +``` +The Zowe desktop attempts to authenticate the credentials using the types that have been configured, by default the three above of `["saf","apiml","zss"]`. If Zowe has been configured with the `LAUNCH_COMPONENT_GROUPS=DESKTOP` where `GATEWAY` is not a launch group, then the message will just include the types `["saf","zss"]`. + +**Solution:** + +This can be due to network disruption, a server not running, certificate issues, incorrect password, or a locked account. If the reason for failure isn't known, you should [gather information to contact support](../servers/must-gather) + +Below are some additional, possible reasons for the failure: + +For the Zowe Desktop to work, the node server that runs under the ZWESLSTC started task must be able to make cross memory calls to the ZWESIS01 load module running under the ZWESISTC started task. If this communication fails, you see the authentication error. + +There are three known problems that might cause this error. The [Zowe architecture diagram](../../getting-started/zowe-architecture.md) shows the following connections. One of these three connections likely failed. + +1. The zssServer connection to the `ZWESISTC` started task using cross memory communication. If this fails, see [zssServer unable to communicate with ](#zss-server-unable-to-communicate-with-zis). The architecture diagram below has been annotated with a (1) to show this connection. +2. The Zowe Desktop Application Framework server connection to the zssServer across the default port 7557. If this fails, see [Application Framework unable to communicate with zssServer](#zlux-unable-to-communicate-with-zssserver). The architecture diagram below has been annotated with a (2) to show this connection. +3. The Zowe Desktop Application Framework server cannot connect to API Mediation Layer for authentication. If this fails, see [Application Framework unable to communicate with API Mediation Layer](#zlux-unable-to-communicate-with-api-mediation-layer). + +Zowe Desktop Unable to logon.png + +### ZSS server unable to communicate with ZIS + +- Open the log file `zowe.logDirectory/zssServer-yyyy-mm-dd-hh-ss.log`. This file is created each time ZWESLSTC is started and only the last five files are kept. + +- Look for the message that starts with `ZIS status`. + + + + - If the communication works, the message includes `Ok`. For example: + + ``` + ZIS status - Ok (name='ZWESIS_STD ', cmsRC=0, description='Ok' + ``` + + If the communication works, the problem is likely that the Application Framework server is unable to communicate to the zssServer. For more information, see [Application Framework unable to communicate with zssServer](#zlux-unable-to-communicate-with-zssserver). + + - If the communication is not working, the message includes `Failure`. For example: + + ``` + ZIS status - Failure (name='ZWESIS_STD ', cmsRC=39, description='Cross-memory call ABENDed') + ``` + or + ``` + ZIS status - Failure (name='ZWESIS_STD ', cmsRC=64, description='N/A', clientVersion=`2`) + ``` + or + ``` + ZIS status - Failure (name='ZWESIS_STD ',cmsRC=47, description='N/A', clientVersion='2') + ``` + or + ``` + ZIS status - 'Failure' (name='ZWESI_STD ', cmsRC='12', description='N/A', clientVersion='2') + ``` + + In this case, check that the ZWESISTC started task is running. If not, start it with the TSO command `/S ZWESISTC` + + - If the problem cannot be easily fixed (such as the ZWESISTC task not running), then it is likely that the ZIS server is not running. To check whether the server is running, check the started task `ZWESISTC` log for any errors. + + - If the ZIS server `ZWESISTC` started task is running, check that the program name of the cross memory procedure matches between the `ZWESISTC` PROBLIB member and the `instance.env` file used to launch Zowe. + + By default the proc value is `ZWESIS_STD`, and if a new name is chosen then both files need to be updated for the handshake to be successful. + + The line in the `ZWESISTC` problib that defines the procedure name that ZIS will use is + ``` + //ZWESISTC PROC NAME='ZWESIS_STD',MEM=00,RGN=0M + ``` + The line in the `instance.env` that specifies the cross memory procedure that the zssServer will try to attach to is + ``` + ZWES_XMEM_SERVER_NAME=ZWESIS_STD + ``` + + - If this is the first time you set up Zowe, it is possible that the ZIS server configuration did not complete successfully. To set up and configure the ZIS server, follow steps as described in the topic [Installing and configuring the Zowe ZIS server (ZWESISTC)](../../user-guide/configure-xmem-server.md). Once `ZWESISTC` is started, if problems persist, check its log to ensure it has been able to correctly locate its load module ZWESIS01 as well as the parmlib ZWESIP00. + + - If there is an authorization problem, the message might include `Permission Denied`. For example: + + ``` + ZIS status - Failure (name='ZWESIS_STD ', cmsRC=33, description='Permission denied' + ``` + Check that the user ID of the ZWESLSTC started task is authorized to access the load module. Only authorized code can call ZWESIS01 because it is an APF-authorized load module. + + **Note:** If you are using RACF security manager, a common reason for seeing `Permission Denied` is that the user running the started task ZWESLSTC (typically ZWESVUSR) does not have READ access to the FACILITY class ZWES.IS. + + If the message includes the following text, the configuration of the Application Framework server may be incomplete: + + ``` + ZIS status - Failure read failed ret code 1121 reason 0x76650446 + ``` + If you are using AT/TLS, then the ```components.app-server.agent.http.attls=true``` statement might be missing from the server configuration file. For more information, see [Configuring Zowe App Server for HTTPS communication with ZSS](../../user-guide/mvd-configuration#configuring-zss-for-https). + + +### Application Framework unable to communicate with zssServer + +Follow these steps: + +- Open the log file `zowe.logDirectory/appServer-yyyy-mm-dd-hh-ss.log`. This file is created each time ZWESLSTC is started and only the last five files are kept. + +- Look for the message that starts with `GetAddrInfoReqWrap.onlookup` and the log messages below. + + ``` + yyyy-mm-dd hh:mm:ss.ms ZWESVUSR INFO (_zsf.apiml,apiml. + yyyy-mm-dd hh:mm:ss.ms ZWESVUSR INFO (_zsf.auth,webauth + yyyy-mm-dd hh:mm:ss.ms ZWESVUSR WARN (_zsf.proxy,proxy. + at GetAddrInfoReqWrap.onlookup Ýas oncomplete¨ (dns.js:64:26) { + errno: 'ENOTFOUND', + code: 'ENOTFOUND', + syscall: 'getaddrinfo', + hostname: 'localhost' + ``` + These messages show that the host name `localhost` cannot be reached between the Zowe desktop server and the zssServer because `localhost` has not been mapped to an IP address. + +- Map localhost to port 127.0.0.1. + + Create an entry in the file `/etc/hosts` that contains the line + + ``` + 127.0.0.1 localhost + ``` + +- Restart the `ZWESLSTC` address space. + + +### Slow performance of the VT terminal on SSH + +**Symptom:** + +When you try to use VT terminal on the Zowe Desktop to connect to the UNIX System Services through SSH, the VT terminal on node v12 slows down. Then, the connection fails because the connecting process can run into the 3-minute limit. + +**Solution:** + +To solve this issue, use Telnet through port 1023 to connect to the UNIX System Services. + +### Application Framework unable to communicate with API Mediation Layer + +Follow these steps: + +- Verify whether API Mediation Layer is started or not. If it is started, you can see a service status page with all green check marks by visiting `https://:`. If there are any red cross marks, follow the instructions in [Troubleshooting API ML](../troubleshoot-apiml.md) to identify and solve the issue. +- You may need to wait a little longer to allow API Mediation Layer Gateway to complete the environment test. + + +## Server startup problem ret=1115 + +**Symptom:** +When ZWESLSTC is restarted, the following message is returned in the output of the ZSS server log file, `zowe.logDirectory/zssServer-yyyy-mm-dd-hh-ss.log`: +``` +server startup problem ret=1115 +``` + +**Solution:** +This message means that some other process is already listening on port 7542, either at address 127.0.0.1 (localhost) or at 0.0.0.0 (all addresses). This prevents the ZSS server from starting. + +One possibility is that a previously running ZSS server did not shut down correctly, and either the operating system has not released the socket after the ZSS server shut down, or the ZSS server is still running. + +## Server error EACCESS on z/os + +**Symptoms:** +When you see messages like this in the server logs: +``` +Error: listen EACCES: permission denied 0.0.0.0:8548 + at Server.setupListenHandle [as _listen2] (net.js:1305:21) + at listenInCluster (net.js:1370:12) +``` +``` + ZWEUSER WARN (_zsf.network,webserver.js:233) ZWED0071W - Unexpected error on server 0.0.0.0:8544. E=bind EACCES 0.0.0.0:8544. Stack trace follows. + Error: bind EACCES 0.0.0.0:8544 + at listenOnMasterHandle (net.js:1389:18) +``` +It is a sign that a permission error is stopping Zowe servers from completing the action of binding to a TCP Port for listening for client connections. This can manifest in the servers being inaccessible. + +Network permissions control varies by OS, to resolve this we don't have a tip for users of containers, but for z/os, IBM has a guide on access control, for more details check +[Port Statement](https://www.ibm.com/docs/en/zos/2.4.0?topic=control-controlling-access-particular-ports) + +Also, there is a very important part troubleshooting step just for Zowe. +When you are setting a PORT statement, you can assign rules by jobname. +When FACILITY resource `BPX.JOBNAME` is granted for the zowe STC user (recommended!) then each server of zowe will have a different jobname. It will not be "ZWESLSTC" or "ZWESLSTC" as it would be when that resource is not granted. They'll instead be other names that start with "ZWE". + +**Note**: So, for a troubleshooting tip on the server error EACCESS on z/os, note that not only should an administrator check their PORT statements, they should probably set their jobname in the port statements to `ZWE` since it will catch all zowe components regardless of whether or not `BPX.JOBNAME` is granted. + + +## Application plug-in not in Zowe Desktop + +**Symptom:** +An application plug-in is not appearing in the Zowe Desktop. + +**Solution:** +To check whether the plug-in loaded successfully, enter the following URL in a browser to display all successfully loaded Zowe plug-ins: + +`https://my.mainframe.com:7556/plugins?type=application` + +You can also search the [node server logs](app-mustgather.md) for the plug-in identifier, for example `org.zowe.sample.app`. If the plug-in loaded successfully, you will find the following message: +``` +[2019-08-06 13:54:21.341 _zsf.bootstrap INFO] - Plugin org.zowe.sampleapp at path=zlux\org.zowe.sampleapp loaded. +``` +If the plug-in did not load successfully, you will find the following message: +``` +[2019-08-06 13:54:21.208 _zsf.bootstrap WARNING] - Error: org.zowe.sampleapp +``` +If the identifier is not in the logs, make sure the plug-in's locator file is in the `/zlux-app-server/deploy/instance/ZLUX/plugins/` directory. The plug-in locator is a `.json` file, usually with same name as the identifier, for example `org.zowe.sampleapp.json`. Open the file and make sure that the path that is defined with the `pluginLocation` attribute is correct. If the path is relative, make sure it is relative to the `zlux-app-server/bin` directory. + +For more information on loading plug-ins to the Desktop, see [Adding Your App to the Desktop](https://github.com/zowe/workshop-user-browser-app/blob/master/README.md). + +## Error: You must specify MVD_DESKTOP_DIR in your environment + +**Symptom:** + +A plug-in that is built in your local environment using `npm run start` or `npm run build` failed with an error message about a missing MVD_DESKTOP_DIR environment variable. + +**Solution:** +Add the Zowe Desktop directory path to the `MVD_DESKTOP_DIR` environment variable. To specify the path, run the following commands in your Windows console or Linux bash shell: + +- Windows + ``` + export MVD_DESKTOP_DIR=/zlux-app-manager/virtual-desktop + ``` + +- Mac Os/Linux + ``` + set MVD_DESKTOP_DIR=/zlux-app-manager/virtual-desktop + ``` + +## Error: Exception thrown when reading SAF keyring \{ZWED0148E\} + +**Symptom:** +The error message indicates that Zowe's local certificate authority (local CA) `ZoweCert`, the certificate `jwtsecret`, or the Zowe certificate `localhost` does not exist in the Zowe keyring. ZWED0148E contains the following messages. + +``` +2021-01-18 10:16:33.601 ZWESVUSR WARN (_zsf.bootstrap,webserver.js:156) ZWED0148E - Exception thrown when reading SAF keyring, e= TypeError: R_datalib call failed: function code: 01, SAF rc: 8, RACF rc: 8, RACF rsn: 44 +at Object.getPemEncodedData (/software/zowev15/1.15.0/components/app-server/share/zlux-server-framework/node_modules/keyring_js/index.js:21:26) +``` + +**Solution:** + +Zowe's local CA certificate has its default name `ZoweCert`, and the Zowe Desktop hardcodes this certificate in the configuration scripts. + +If you are using your own trusted CA certificate in the keyring and the name is different from the default one, this error will occur. To resolve the issue, you must match the names in the Zowe configuration. For more information, see [Configuring certificates overview](../../user-guide/configure-certificates). + +If you are using Zowe's local CA certificate but it still reports **ZWED0148E**, you may find the following message in the same log. + +``` + "https": { + "ipAddresses": [ + "0.0.0.0" + ], + "port": 8544, + "keys": [ + "safkeyring://ZWESVUSR/ring&Label A" + ], + "certificates": [ + "safkeyring://ZWESVUSR/ring&Label A" + ], + "certificateAuthorities": [ + "safkeyring://ZWESVUSR/ring&Label B", + "safkeyring://ZWESVUSR/ring&Label B" + ] + }, +``` + +In this case, you must make sure that the label names exactly match the names in TSO when looking up the keyring you own. Any difference in spaces, capitalization, or other places will cause the error. + +## Warning: Problem making eureka request \{ Error: connect ECONNREFUSED \} + +**Symptom:** +The Zowe started task `ZWESLSTC` log contains error messages reporting problems connecting + +``` +Problem making eureka request { Error: connect ECONNREFUSED 10.1.1.2:7553 +at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1195:14) +errno: 'ECONNREFUSED', +code: 'ECONNREFUSED', +syscall: 'connect', +address: '10.1.1.2', +port: 7553 } +``` + +**Solution:** +You can ignore these messages. These messages are timing-related where different Eureka servers come up, try to connect to each other, and warn that the endpoint they are trying to perform a handshake with is not available. When all of the Eurka services have started, these errors will stop being logged. + +## Warning: Zowe extensions access to ZSS security endpoints fail + +**Symptom:** + +Zowe extensions fail when accessing the ZSS APIs such as the `security-mgmt/classes/default-class/profiles` endpoint. The following error is written to the log. + +``` +BPXTLS failed: rc=-1, return code=163, reason code=0x0be80820 +``` + +**Solution:** + +Access to the ZSS endpoints are protected. To access the ZSS endpoints, the user must have `READ` access on the `OMVSAPPL` resource in the `APPL` class. + +To fix this permit access, issue the following TSO command, where `userID` is the started task ID of the requesting process. The vendor documentation describes which userID to use which might be `ZWESVUSR`. + +``` +PERMIT OMVSAPPL CLASS(APPL) ACCESS(READ) ID(userID) +``` diff --git a/versioned_docs/version-v2.15.x/troubleshoot/app-framework/appfw-tracing.md b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/appfw-tracing.md new file mode 100644 index 0000000000..0662e2aeb9 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/appfw-tracing.md @@ -0,0 +1,51 @@ +# Enabling tracing + +If you need to provide support with tracing information about the App Framework or a particular part of it, or need to debug a program you are developing that uses the App Framework, you can enable a variety of tracing within the Zowe YAML configuration file. + +If you are looking for basic troubleshooting and support, please see [Gathering Information for Support or Troubleshooting](../servers/must-gather.md). + +## Basic debugging + +Within the Zowe YAML file, the value `components.app-server.debug` can be set to `true` to turn on several debug loggers. + +This does not turn on every type of debugging but provides a basic set for debugging for the App Server. + +Enabling `components.app-server.debug` is equivalent to setting: + +```yaml +components: + app-server: + logLevels: + _zsf.*: 5 +``` + +## Advanced debugging for App Server + +The Zowe YAML file section `components.app-server.logLevels` controls the verbosity for every logger within the server. + +This includes core loggers, prefixed with `_zsf`, as well as plug-in loggers. + +A list of core loggers and their purpose is defined within [the App Server schema](https://github.com/zowe/zlux-app-server/blob/c22105381e129bd999c47e838b424679eba26aa6/schemas/app-server-config.json#L401) +Loggers, plug-in loggers, and log levels (such as 5 for highest debugging, or 2 for default) are defined in detail in the [Logging document](../../extend/extend-desktop/mvd-logutility). + +Attributes within `components.app-server.logLevels` can be exact names of loggers, or can be pattern matching of multiple loggers. + +For example, to enable minimum debug verbosity of the auth logger of the server core ("_zsf.auth"), and to enable maximum verbosity logging of all plug-ins made by company foo ("com.foo"), you could set the YAML configuration as: + +```yaml +components: + app-server: + logLevels: + _zsf.auth: 3 + com.foo.*: 5 +``` + +## Advanced debugging for ZSS + +The Zowe YAML file section `components.zss.logLevels` controls the verbosity for every logger within the server. + +This includes core loggers, prefixed with `_zss`. + +A list of core loggers and their purpose is defined within [the ZSS schema](https://github.com/zowe/zss/blob/c85e374f3d7a4a9b93d6f8337d474f384135744b/schemas/zss-config.json#L235). + +Unlike the App Server, the `components.zss.logLevels` section cannot take pattern matching for attribute names. The attribute names must exactly match the name of a logger. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/app-framework/appserver-cluster.md b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/appserver-cluster.md new file mode 100644 index 0000000000..10db9cf52c --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/appserver-cluster.md @@ -0,0 +1,21 @@ +# Managing Cluster Mode for app-server + +On the Zowe servers, the component "app-server" has an environment variable "ZLUX_NO_CLUSTER" which controls whether or not it uses cluster mode. Cluster mode is enabled by default. However, you might need to disable cluster mode under certain circumstances. When cluster mode is disabled, make sure you are aware of the potential drawbacks and benefit. + +When you **disable** cluster mode, you will lose the following benefits: + +1. **Performance under high user Count:** This is due to the absence of redundant workers, which can impact the system's efficiency when dealing with a large number of users. + +2. **Reduced downtime during unexpected exceptions:** The low-downtime characteristic, where only one request is interrupted compared to around 15 seconds of downtime, is compromised. + + +## To turn the cluster mode on + +- In Zowe V1, do NOT include the `ZLUX_NO_CLUSTER` environment variable in the `instance.env` configuration. +- In Zowe V2, do NOT include the `zowe.environments.ZLUX_NO_CLUSTER `in the `zowe.yaml` file. + +## To turn the cluster mode off + +- In Zowe V1, include `ZLUX_NO_CLUSTER=1` in the `instance.env` configuration. +- In Zowe V2, include `zowe.environments.ZLUX_NO_CLUSTER=1` in the `zowe.yaml` file. + diff --git a/versioned_docs/version-v2.15.x/troubleshoot/app-framework/appserver-error-codes.md b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/appserver-error-codes.md new file mode 100644 index 0000000000..181cf18e0f --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/appserver-error-codes.md @@ -0,0 +1,3374 @@ +# App-server Error Message Codes + +The following error message codes may appear on the app-server log. Use the following message code references and the corresponding reasons and actions to help troubleshoot issues. + +## App-server informational messages + +### ZWED0020I + + Registering at _discoveryUrl_ + + **Reason:** + + The app-server is registering its existence to the API ML discovery server, because `components.app-server.node.mediationLayer.enabled=true` is set in the zowe configuration. + + **Action:** + + No action required. + + + +### ZWED0021I + + Eureka Client Registered from _ipAddress_. Available at _discoveryUrl_. + + **Reason:** + + The registration attempt from ZWED0020I has succeeded. The server is known to the API ML discovery server from the address _ipAddress_. + + **Action:** + + No action required. + + + +### ZWED0022I + + Fork worker _workerId_ + + **Reason:** + + A new app-server worker process is starting. Workers are redundant execution contexts of the server and increase throughput and latency of requests when the server has a lot of concurrent client requests. Workers are started and stopped according to current server load and the minimum and maximum worker limits defined in environment variables ZLUX_MIN_WORKERS and ZLUX_MAX_WORKERS. + + **Action:** + + No action required. + + + +### ZWED0023I + + Restart worker _workerId_ + + **Reason:** + + An existing app-server worker process has exited with a status code that indicates it should be restarted rather than permenantly stopped. + + **Action:** + + Review the preceeding log messages as worker restart may be due to a caught error. + + + +### ZWED0024I + + Keys=_workerIds_ + + **Reason:** + + The server lists the worker IDs right before all workers are about to be reloaded. + + **Action:** + + No action required. + + + +### ZWED0025I + + Killing worker pid=_processId_ + + **Reason:** + + The server just issued the SIGTERM unix signal to the worker with the process ID listed. This is an expected action when reloading all workers of the server. + + **Action:** + + No action required. + + + +### ZWED0026I + + Fork _quantity_ workers. + + **Reason:** + + The server is starting up _quantity_ new workers. Workers are redundant execution contexts of the server and increase throughput and latency of requests when the server has a lot of concurrent client requests. This message appears at startup and the _quantity_ is determined by the environment variables ZLUX_MIN_WORKERS and ZLUX_MAX_WORKERS. + + **Action:** + + No action required. + + + +### ZWED0027I + + Close worker _workerId_ + + **Reason:** + + The server is removing an existing worker due to lack of recent client activity. Workers are added and removed according to average load of the server. Workers are redundant execution contexts of the server and increase throughput and latency of requests when the server has a lot of concurrent client requests. Workers may be removed down to the minimum count as defined by the environment variable ZLUX_MIN_WORKERS. + + **Action:** + + No action required. + + + +### ZWED0028I + + Master _processId_ is running. + + **Reason:** + + The server has started up and is printing its unix process ID in case the user needs to know for analysis or troubleshooting. + + **Action:** + + No action required. + + + +### ZWED0029I + + Worker _workerId_ pid _processId_ + + **Reason:** + + A worker has started and is listing its ID and unix process ID in case the user needs to know for analysis or troubleshooting. + + **Action:** + + No action required. + + + +### ZWED0031I + + Server is ready at _ipAddress_, Plugins successfully loaded: _percentage_% (_successful_/_total_) + + **Reason:** + + The server is ready to accept client requests. It can be found at the _ipAddress_ listed, and you can tell if it has loaded all plugins successfully by the _percentage_ listed. + + **Action:** + + If the percentage is less than expected, review the log for messages with IDs ZWED0159W or ZWED0027W. Those messages will tell you which plugins failed, and you can search for their plugin ID within the log to find out the reason they failed to load. + + + +### ZWED0033I + + The http port given to the APIML is: _tcpPort_ + The https port given to the APIML is: _tcpPort_ + The zlux-apiml config are: _jsonConfig_ + + **Reason:** + + The server lists the properties that will be used to connect to the APIML Discovery server to help with troubleshooting. + + **Action:** + + No action required. + + + +### ZWED0036I + + Plugin _pluginId_ will serve static files from _filePath_ + + **Reason:** + + The plugin _pluginId_ was loaded which has a webContent section defined in its pluginDefinition.json file. The server will serve the read-only content from the _filePath_. + + **Action:** + + No action required. + + + +### ZWED0037I + + _pluginId_: found proxied service _serviceName_ + + **Reason:** + + When the server was loading the plugin _pluginId_, it found that the plugin contains a service named _serviceName_ of type "service". + + **Action:** + + No action required. + + + +### ZWED0038I + + _pluginId_: importing service _sourceServiceName_ from _sourcePluginId_ as _serviceName_ + + **Reason:** + + When the server was loading the plugin _pluginId_, it found that the plugin contains a service named _serviceName_ of type "import". It then resolved the import to the service _sourceServiceName_ from plugin _sourcePluginId_. + + **Action:** + + No action required. + + + +### ZWED0039I + + _pluginId_: found router _serviceName_ + + **Reason:** + + When the server was loading the plugin _pluginId_, it found that the plugin contains a service named _serviceName_ of type "router". + + **Action:** + + No action required. + + + +### ZWED0040I + + _pluginId_: found legacy node service _serviceName_ + + **Reason:** + + When the server was loading the plugin _pluginId_, it found that the plugin contains a service named _serviceName_ of type "nodeService". + + **Action:** + + This type of service is deprecated and may not work on a future version of Zowe, so you should consider getting an upgraded version of the plugin that instead uses a service of an undeprecated type. + + + +### ZWED0041I + + _pluginId_: found external service _serviceName_ + + **Reason:** + + When the server was loading the plugin _pluginId_, it found that the plugin contains a service named _serviceName_ of type "external". + + **Action:** + + No action required. + + + +### ZWED0042I + + _pluginId_: found _serviceType_ service _serviceName_ + + **Reason:** + + When the server was loading the plugin _pluginId_, it found that the plugin contains a service named _serviceName_ of type "_serviceType_". + + **Action:** + + No action required. + + + +### ZWED0043I + + Plugin _pluginId_ is not requested skipping without error + + **Reason:** + + When the server was loading the "nodeAuthentication" type plugin _pluginId_, it determined that the plugin only handles security actions for a category that was not requested by the server configuration or any plugins. The plugin was skipped because it was not required. + + **Action:** + + No action required unless you need the plugin to be used. If you need the plugin, you can set an authentication category it implements as the default by configuration property `components.app-server.dataserviceAuthentication.defaultAuthentication`, or within a plugin's security configuration. + + + +### ZWED0044I + + Processing plugin reference _filePath_... + + **Reason:** + + The server is checking if the plugin definition file _filePath_ exists and will attempt to load it. + + **Action:** + + No action required. + + + +### ZWED0045I + + Reading plugins dir _pluginsDirectory_ + + **Reason:** + + The server is scanning the directory _pluginsDirectory_ as specified by the server configuration property `components.app-server.pluginsDir` so that it can locate each plugin in the instance. + + **Action:** + + No action required. + + + +### ZWED0046I + + Adding dynamic plugin _pluginIdentifier_ + + **Reason:** + + The server has added the plugin with _pluginIdentifier_ to its bootstrapped list of plugins. It also emits a `pluginAdded` event. + + **Action:** + + No action required. If you need it, you may check the list of plugins on the Desktop to see if the plugin was added successfully. + + + +### ZWED0047I + + [Path= _path_ stdout]: _data_ + + **Reason:** + + A child process from _path_ has received data of _data_ - usually done interally by ProcessManager. + + **Action:** + + No action required. + + + +### ZWED0048I + + [Path= _path_] exited, code: _code_ + + **Reason:** + + A process from _path_ has exited with a return _code_. + + **Action:** + + No action required. + + + +### ZWED0049I + + Stopping managers + + **Reason:** + + Begins ending all child processes. + + **Action:** + + No action required. + + + +### ZWED0050I + + Server shutting down, received signal=_signal_ + + **Reason:** + + Tells server to shutdown after receiving _signal_ by ending all child processes and then performing cleanup. + + **Action:** + + No action required. + + + +### ZWED0052I + + Deleting plugin due to request, id _pluginIdentifier_, path _path_ + + **Reason:** + + Notifies that the server is removing a plugin with _pluginIdentifier_ located in _path_. + + **Action:** + + No action required. Optionally, you could verify that the plugin was deleted using following options: + * doing a GET call to the list of the plugins, OR + * viewing the status code of the REST request if plugin was deleted by the network request. + + + +### ZWED0053I + + Setting up _type_ proxy (_pluginIdentifier_:_serviceName_) to destination=_destination_ + + **Reason:** + + Making an external proxy of _type_ (HTTP or HTTPS) for _pluginIdentifier_:_serviceName_ at the _destination_. + + **Action:** + + No action required. + + + +### ZWED0054I + + Installing root service at _url_ + + **Reason:** + + Attempting to install new root service at _url_. + + **Action:** + + No action required. + + + +### ZWED0055I + + Installing root service proxy at _url_ + + **Reason:** + + Attempting to install new root service proxy at _url_. + + **Action:** + + No action required. + + + +### ZWED0056I + + _pluginIdentifier_: installing websocket service + + **Reason:** + + Attempting to install new websocket service for _pluginIdentifier_. + + **Action:** + + No action required. + + + +### ZWED0059I + + Found connection info for _pluginIdentifier_:_service_=_info_ + + **Reason:** + + Connection info for _pluginIdentifier_:_service_ was found as _info_. + + **Action:** + + No action required. + + + +### ZWED0062I + + _pluginIdentifier_: installing router at _url_ + + **Reason:** + + For _pluginIdentifier_, the server is installing new router at _url_. + + **Action:** + + No action required. + + + +### ZWED0064I + + _pluginIdentifier_: installing import _sourcePlugin_:_name_ at _url_ + + **Reason:** + + For _pluginIdentifier_, the server is instaling import from _sourcePlugin_ with _name_ at _url_. + + **Action:** + + No action required. + + + +### ZWED0066I + + _pluginIdentifier_: serving static files at _url_ + + **Reason:** + + For _pluginIdentifier_, the server is serving static files and assets at _url_. + + **Action:** + + No action required. + + + +### ZWED0067I + + _pluginIdentifier_: serving library files at _url_ + + **Reason:** + + For _pluginIdentifier_, the server is serving libary files at _url_. + + **Action:** + + No action required. + + + +### ZWED0070I + + User=_user_ (_pluginId_): Session _authCapability_ successful. Plugin response: _httpResponse_ + + **Reason:** + + An authentication plugin ran successfully and received a valid HTTP response. + + **Action:** + + No action required. + + + +### ZWED0072I + + Using Certificate: _stringArray_ + + **Reason:** + + The app server has successfully loaded a certificate and added it to the certificates array. + + **Action:** + + No action required. + + + +### ZWED0086I + + _tomcatPID_ closed, code=_returnCode_ + + **Reason:** + + A running tomcat process with PID _tomcatPID_ was cloesd. + + **Action:** + + Refer to return code. + + + +### ZWED0087I + + _tomcatPID_ exited, code=_returnCode_ + + **Reason:** + + A running tomcat process with PID _tomcatPID_ was exited. + + **Action:** + + Refer to return code. + + + +### ZWED0090I + + _tomcatPID_ closed, code=_returnCode_ + + **Reason:** + + A running tomcat process with PID _tomcatPID_ was cloesd. + + **Action:** + + Refer to return code. + + + +### ZWED0091I + + _tomcatPID_ exited, code=_returnCode_ + + **Reason:** + + A running tomcat process with PID _tomcatPID_ was exited. + + **Action:** + + Refer to return code. + + + +### ZWED0092I + + Tomcat Manager ID=*_manager id_* stopping + + **Reason:** + + It specifies that Apache Tomcat Host Manager is stopping *_manager id_*. + + **Action:** + + No action required. + + + +### ZWED0093I + + Tomcat Manager ID=*_manager id_* cleanup successful + + **Reason:** + + It specifies that Apache Tomcat Host Manager successfully cleaned up the *_manager id_*. + + **Action:** + + No action required. + + + +### ZWED0094I + + Extracted war to *_destination path_* + + **Reason:** + + It specifies that it extracted the WAR directory successfully to the *_destination path_*. + + **Action:** + + No action required. + + + +### ZWED0095I + + Making junction from *_extracted war_* to *_appbase_* + + **Reason:** + + A junction link is a sort of subset or a variation of a symbolic link. + It creates a junction link between *_extracted war_* directory to *_appbase_* directory. + + **Action:** + + No action required. + + + +### ZWED0096I + + Making symlink from *_extracted war_* to *_appbase_* + + **Reason:** + + It creates a symbolic link between *_extracted war_* directory to *_appbase_* directory. + + + **Action:** + + No action required. + + + +### ZWED0109I + + Registering App (ID=*_plugin identifier_*) with App Server + + **Reason:** + The registration attempt from ZWED0109I has succeeded. + Before the server starts, it registers all the *_plugin identifier_* with the App server and installs them. + + **Action:** + + No action required. + + +### ZWED0110I + + App *_plugin identifier_* installed to *_appdir_* and registered with App Server + + **Reason:** + + App *_plugin identifier_* installed to *_appdir_* and registered with App Server successfully. + + **Action:** + + No action required. + + + +### ZWED0111I + + Authentication plugin *plugin identifier* added to category *authentication category* + + **Reason:** + + Auth plugin *plugin identifier* is being registered as a part of *authentication category*. + + **Action:** + + No action required. + + + +### ZWED0112I + + Auth enabled=false. Auth passthrough. + + **Reason:** + + This message alerts you whenever an authentication handler is requested but the dataservice has authentication disabled via configuration. This is not the default behavior of Zowe but a user may have configured it for a dataservice or a plugin may have shipped with this configuration. + + **Action:** + + Review dataservice configuration to determine if this is intentional and desired. Some dataservices do not require authentication, while others should have it. + + + +### ZWED0114I + + Adding plugin remotely + + **Reason:** + + A new plugin is detected and is being added. + + **Action:** + + No action required. + + + +### ZWED0115I + + Skip child processes spawning on worker *_workerId_* *_childProcessPath_* + + **Reason:** + The process listed as childProcessPath was not spawned under the specified worker + because it was listed as being a process that should only be started once. + Some child processes should be started per-worker for redundancy, + while others that need exclusive access to a resource such as + a network port are specified with the property *childProcess.once*, + and are skipped on all but one worker. The other workers print + this message to indicate this behavior. + + **Action:** + + No action required. + + + +### ZWED0116I + + The LOCATIONS are *_serverModuleLocation_* and *_clientModuleLocation_* + + **Reason:** + + The server has set the location *_serverModuleLocation_* and *_clientModuleLocation_*. + + **Action:** + + No action required. + + + +### ZWED0117I + + The fileLocation is *_lib_* + + **Reason:** + + Location of files will be in *_lib_* directory. + + **Action:** + + No action required. + + + +### ZWED0118I + + The NODE_PATH is *NODE_PATH* from environment variable. + + **Reason:** + The server recognizes the location of Node as *NODE_PATH* from environment variable. + + **Action:** + + No action required. + + + +### ZWED0119I + + Plugin *_plugin identifier_* will serve library data from directory *_dir location_* + + **Reason:** + + For plugins with type 'library', plugin *_plugin identifier_* has been registered and will be serving library data from *_dir location_* + + **Action:** + + No action required. + + + +### ZWED0120I + + Auth plugin *_plugin identifier_*: loading auth handler module *_app server_* + + **Reason:** + An auth category was requested as the default in the server configuration, or requested by a particular plugin, and because the auth plugin pluginId handles this category, it is being loaded by the app-server. + + **Action:** + + No action required. + + + +### ZWED0124I + + Plugin *_plugin identifier_* at path=*_plugin location_* loaded. + + **Reason:** + All the *_plugin identifier_* will be loaded at plugins directory at *path*. Plugins will be available in *_plugin location_*. + + **Action:** + + No action required. + + + +### ZWED0125I + + Plugin *_plugin identifier_* not loaded + + **Reason:** + A plugin object was not returned in the *makePlugin()* call of the app-server, and therefore the app-server did not load this plugin. The plugin will not be available in the server. + + **Action:** + + Check the log for references to *pluginId* to see other messages that indicate the cause + + + +### ZWED0129I + + (*HTTP or HTTPS*) Listening on *ip address:port* + + **Reason:** + *type* (HTTP or HTTPS) Listening on ip address:port. + + + **Action:** + + No action required. + + + +### ZWED0130I + + (*HTTP or HTTPS*) About to start listening on *app-server port* + + **Reason:** + About to start listening on *app-server port*. + + **Action:** + + No action required. + + + +### ZWED0154I + + Following link: _dependency_: _dependency importer_ + + **Reason:** + + Following the link formed by the _dependency_ and the _dependency importer_ in the graph. + + **Action:** + + No action required. + + + +### ZWED0158I + + *** pluginsSorted: + + **Reason:** + + The graph with the sorted plugins. + + **Action:** + + No action required. + + + +### ZWED0159E + + *** rejects: + + **Reason:** + + Removing the plugins with the broken dependencies from the graph. + + **Action:** + + No action required. + + + +### ZWED0160I + + Dep.valid: + + **Reason:** + + Checking if the dependency is valid. + + **Action:** + + No action required. + + + +### ZWED0205I + + User=_user_ (_pluginId_): User logout + + **Reason:** + + This message prints when the _user_ logs out of the Zowe Desktop. Logout is being handled by the _pluginId_ plugin. + + **Action:** + + If logout was intentional, message can be safely ignored. If logout was unintentional, keep in mind the Desktop logs out after inactivity. Incorrect logout behavior can be troubleshooted with + the authentication plugin. + + + +### ZWED0211I + + The number of processors is: _count_ + + **Reason:** + + Lists the _count_ of CPU cores on the system hosting the App server. + + **Action:** + + No action required. + + + +### ZWED0212I + + Environmental variable ZLUX_MIN_WORKERS was not a valid number therefore _count_ will be used as the minimum workers + + **Reason:** + + ZLUX_MIN_WORKERS environment variable is not valid, so the minimum number of workers as part of the cluster will be _count_ + + **Action:** + + By default, the App server runs in a cluster. You can specify minimum number of cluster workers. + + + +### ZWED0213I + + Environmental variable ZLUX_MAX_WORKERS was not a valid number therefore _count_ will be used as the maximum workers. + + **Reason:** + + ZLUX_MAX_WORKERS environment variable is not valid, so the maximum number of workers as part of the cluster will be _count_. + + **Action:** + + By default, the App server runs in a cluster. You can specify maximum number of cluster workers. + + + +### ZWED0214I + + Read _directory_: found plugin id = _identifier_, type = _type_ + + **Reason:** + + Reading in _directory_, found a plugin with _identifier_ of _type_ + + **Action:** + + No action required. + + + +### ZWED0287I + + JarMgr with id=_id_ invoked to startup with config=_object_ + + **Reason:** + + JarManager _id_ has been started with the configuration _object_ + + **Action:** + + No action required. + + + +### ZWED0290I + + Plugin (_pluginId_) loaded. Version: _pluginVersion_. Successful: _overallSuccess_% (_pluginsLoaded_/_pluginsTotal_) Attempted: _pluginsAttempted_% (_attemptedCount_/_pluginsTotal_) + + **Reason:** + + Plugin with _pluginId_ loaded, with version _pluginVersion_. The server attempted to load a total of _pluginsTotal_ with _pluginsLoaded_ plugins already successfully loaded. + + **Action:** + + No action Required. + + + +### ZWED0292I + + Plugin _identifier_ loaded. Version: _pluginVersion_. + + **Reason:** + + Plugin _identifier_ loaded successfully and the plugin version for the same is _pluginVersion_. + + **Action:** + + No action Required. + + + +### ZWED0294I + + Successfully loaded _recognizers length_ recognizers for _appId_ into config + + **Reason:** + + Successfully loaded _recognizers length_ for _appId_ into config at path workspace/app-server/ZLUX/pluginStorage/org.zowe.zlux.ng2desktop/. + + **Action:** + + No action Required. + + + +### ZWED0295I + + Successfully loaded _actions length_ actions for _appId_ into config + + **Reason:** + + Successfully loaded _actions length_ for _appId_ into config at path workspace/app-server/ZLUX/pluginStorage/org.zowe.zlux.ng2desktop/. + + **Action:** + + No action required. + + + +### ZWED0299I + + Loading remote iframe app _plugin_identifier_ located at _remoteUrl_. + + **Reason:** + + Loading remote iframe app _plugin_identifier_ which is located at _remoteUrl_. + + **Action:** + + No action Required. + + + +### ZWED0300I + + APIML Storage configured + + **Reason:** + + caching service/APML storage is configured + + **Action:** + + No action Required. + + + +### ZWED0301I + + Found _pre-existing recognizers_/_pre-existing actions_ in config for _appID_. + + **Reason:** + + Get _pre-existing recognizers_/_pre-existing actions_ in config, if any for _appID_. + + **Action:** + + No action Required. + + + +### ZWED0302I + + HA mode is enabled/disabled. + + **Reason:** + + High Availability mode is enabled/disabled. + + **Action:** + + No action Required. + + + +### ZWED0004W + + Tomcat for ID=_id_ not starting, no services succeeded loading + + **Reason:** + + A tomcat instance required for loading a set of java dataservices could not start, so none of the associated dataservices will be available either. + + **Action:** + + Review prior logs to determine the reason the tomcat server is not starting, and address the problem before restarting Zowe in order to access the missing dataservices. + + + +### ZWED0006W + + RBAC is disabled in the configuration. All authenticated users will have access to all services. Enable RBAC in the configuration to control users' access to individual services. + + **Reason:** + + RBAC can be used to permit and reject access to each URL of the app-server individually according to security rules such as those from SAF resources. Enabling RBAC is beneficial but requires configuration first so this message is often seen. + + **Action:** + + If you wish to learn more about RBAC and enable it, read [Application Framework Advanced Configuration](https://docs.zowe.org/stable/user-guide/mvd-configuration#controlling-access-to-apps) + + + +### ZWED0007W + + Dataservice authentication definition is not present in server configuration file, or malformed. + Correct the configuration file before restarting the server. + + **Reason:** + + The `components.app-server.dataserviceAuthentication` configuration section is missing or invalid, so the server cannot continue until it is fixed. [Authentication plugins for dataservices are described here](https://docs.zowe.org/stable/extend/extend-desktop/mvd-auth-plugins/) + + **Action:** + + Correct your zowe configuration for this section according to the [app-server schema](https://github.com/zowe/zlux-app-server/blob/v2.x/master/schemas/app-server-config.json) + + + +### ZWED0008W + + Error loading auth plugin _pluginIdentifier_: _error_ + + **Reason:** + + The plugin could not be loaded due to an error. This plugin may be required for the server to continue, but if it is non-essential then the server will continue to run without the ability to perform authentication against that particular plugin. + + **Action:** + + Review the error to determine the way to fix the plugin before restarting Zowe. + + + +### ZWED0013W + + Initializing was not complete for worker _workerId_ + + **Reason:** + + A cluster mode worker exited before it fully initialized. Another worker will be started soon to attempt again. + + **Action:** + + If this continues to happen, you should contact support. + + + +### ZWED0014W + + Error adding plugin: _error_ + + **Reason:** + + A dynamic plugin, or a plugin added post-startup was unable to be added to the server. The server continues to run, but this plugin was not added. + + **Action:** + + Check the _error_ and lines above in the log to determine the reason for the failure. + + + +### ZWED0015W + + Error reloading workers: _error_ + + **Reason:** + + The server was attempting to reload all workers, probably to complete a configuration change. An error occurred instead so some of the workers may not have been reloaded and could contain the old configuration. + + **Action:** + + If you were doing a configuration change, you should try again or restart the server if the error persists. You can check the _error_ to see the reason for the issue. + + + +### ZWED0016W + + Error setting override: _error_ + + **Reason:** + + The server attempted to load a new configuration, but failed when writing the configuration update to a file. + + **Action:** + + Check the _error_ to see the possible cause for the failure. Retry this operation but if the issue persists you should restart the server. + + + +### ZWED0017W + + Duplicate plugin identifier _pluginId_ found. + + **Reason:** + + A plugin was trying to be added to the server but it wasn't possible because another plugin with the same ID was already running within the server. + + **Action:** + + Plugin upgrades cannot be done through the add plugin operation. Instead, the server should be stopped to perform this upgrade. + + + +### ZWED0018W + + Could not initialize Java manager. Java services from Apps will not be able to load _stackTrace_ + + **Reason:** + + The Java manager is used to run Java services bundled into plugins. It could not start, so the server cannot load any Java services. Plugins that have Java services may fail to load, but the server will still run with the remaining plugins. + + **Action:** + + Check the _stackTrace_ output to determine the reason the Java manager could not run. + + + +### ZWED0019W + + Exception when setting log level for ID=_logId_. E: _stackTrace_ + + **Reason:** + + Log levels listed in the configuration file are set during startup. For some reason, the level for _logId_ could not be set, but the server will continue to run with that logger set to default verbosity. + + **Action:** + + Check the _stackTrace_ to determine the reason why _logId_ could not be set. Potentially the log id was an invalid name, or the log level was an invalid number. + + + +### ZWED0020W + + Could not spawn _childProcess_: _errorMessage_ + + **Reason:** + + The child process that was requested to run when the server started up could not run for some reason. _childProcess_ lists the parameters requested to start the process. + + **Action:** + + Check the _errorMessage_ to determine the reason of failure, and also verify that the information in _childProcess_ is valid. + + + +### ZWED0021W + + Missing one or more parameters required to run. + The server requires either HTTP or HTTPS. HTTP Port given: _httpPort_. HTTPS Port given: _httpsPort_ + HTTPS requires either a PFX file or Key & Certificate files. + Given PFX: _pfx_ + Given Key: _key_ + Given Certificate: _certificate_ + config was: _configuration_ + All but host server and config file parameters should be defined within the config file in JSON format. + + **Reason:** + + The server could not start because the configuration was not valid. When the server's HTTPS section is specified, _httpsPort_ must be a valid TCP port number and you must have a key and certificate. If the HTTPS section is not specified, the HTTP section must be specified and _httpPort_ must be a valid TCP port number. + + **Action:** + + Review the _configuration_ to see if there are corrections to be made before restarting the server. + + + +### ZWED0027W + + Plugin (_pluginId_) loading failed. Version: _versionNumber_. Message: "_errorMessage_" Successful: _percentSuccess_% (_pluginsLoaded_/_pluginsTotal_) Attempted: _percentAttempted_% (_pluginsAttempted_/_pluginsTotal_) + + **Reason:** + + An error prevented the plugin _pluginId_ from loading. Other plugins will still be attempted to be loaded, until _percentAttempted_ reaches 100%. The server will run if all auth plugins needed have successfully loaded. + + **Action:** + + Review _errorMessage_ to see if there is something you can do to fix the error. You may need to contact the plugin developer to find a solution. If you do not need this plugin, it is OK to continue. + + + +### ZWED0028W + + Encountered parse exception while reading _filename_ + + **Reason:** + + The server cannot read the JSON file _filename_. This might be a configuration file or a plugin file. In either case, the server may not be able to run or may run with less plugins than desired. + + **Action:** + + Review the file listed in _filename_. Check if it is in the right encoding for your platform. Tagging the file according to its encoding is recommended for z/OS. Also check if the file is valid JSON. The file may have a missing or extra comma, or missing quotes or brackets. + + + +### ZWED0029W + + Authentication plugin was found which was not requested in the server configuration file's dataserviceAuthentication object. Skipping load of this plugin + + **Reason:** + + The server will attempt to load every plugin given to it in the plugins directory. Authentication plugins are only needed if a plugin requests them or it implements the default authentication category. Because the server did not find a user of this plugin, it was not loaded. + + **Action:** + + No action is needed unless you believe that this plugin needed to be loaded. If so, check for plugins that require it to determine if there is missing or incorrect auth configuration. + + + +### ZWED0030W + + _location_ points to an invalid plugin definition, skipping + + **Reason:** + + The file specified at _location_ is not valid according to the [pluginDefinition schema](https://github.com/zowe/zlux-app-server/blob/v2.x/staging/schemas/plugindefinition-schema.json), so it cannot be loaded. The server will still start without the plugin if possible. + + **Action:** + + Correct the pluginDefinition.json file of the plugin to load the plugin on next server restart, or remove the plugin if not needed. + + + +### ZWED0032W + + Failed to load _filename_ + + **Reason:** + + The plugin definition located at _filename_ could not be read, so the plugin that referred to this cannot be loaded. The server may still run without the plugin if possible. + + **Action:** + + Check if the file exists and is readable to the user that is running the server. Also check that the file is in the right encoding for the OS the app-server is running on. On z/OS, it is recommended to have the file encoding tagged. + + + +### ZWED0033W + + Could not initialize plugin _pluginId_: _error_ + + **Reason:** + + The plugin _pluginId_ could not be loaded. This may be due to unsatisfied imports, where an import requested a version of something that was not available, or an entire plugin was not available. The server will still attempt to load if this plugin was not needed. + + **Action:** + + Check the _error_ message to determine the cause of error for correction. + + + +### ZWED0034W + + Skipping install of plugin due to existing plugin with same id=_identifier_ + + **Reason:** + + The plugin could not be loaded due to a plugin that is already loaded containing the same _identifier_ ID. Plugin IDs are unique, so the first plugin with that ID that is seen is the one that is loaded. + + **Action:** + + Check to see if you have 2 extensions that contain plugins with the same ID. Alternatively, an extension may have updated to have its name change without its ID changing, causing a duplicate to appear. You may need to clean up your extensions or the contents of the pluginsDir directory. + + + +### ZWED0035W + + Error thrown when installing plugin=_identifier_: _error_ + + **Reason:** + + The plugin with id _identifier_ could not be added to the server because of an error that occurred. The server will still attempt to run without the plugin if possible. + + **Action:** + + Check the _error_ message to see the reason for the error, and correct it before restarting the server in order to try loading the plugin again. + + + +### ZWED0036W + + Uncaught exception found. Error: _stackTrace_ + + **Reason:** + + The server encountered an unexpected error. If cluster mode is running, this will result in the worker crashing but the cluster starting a new worker to replace it. The client that initiated the request will need to retry the operation though other clients should not experience disruption. + + If cluster mode is not running, the process will end but the launcher will restart it. In this case, state may be lost unless the caching service was also being used. + + **Action:** + + The _stackTrace_ should be sent to developers so that the issue can be fixed. + + + +### ZWED0037W + + Ending server process due to uncaught exception. + + **Reason:** + + The server is stopping after encountering ZWED00036W. + + **Action:** + + The information within ZWED0036W should be sent to developers so that the issue can be fixed. + + + +### ZWED0038W + + [Path=_childProcessConfig.path_ stderr]: _data_ + + **Reason:** + + A child process with path _childProcessConfig.path_ encountered an error with receiving _data_. + + **Action:** + + Action depends on context of what _data_ is. May be useful in debugging an issue with internal ProcessManager. + + + +### ZWED0039W + + Exception at server cleanup function: + _stack_ + + **Reason:** + + An exception occurred when ending process, during the cleanup phase. + + **Action:** + + No action is needed, but _stack_ can be sent to developers if server processes are failing to end. + + + +### ZWED0040W + + Callservice: Service call to %s:%s%s failed. + + **Reason:** + + An HTTP request to _host_ with _port_ at _path_ failed. + + **Action:** + + Check the subsequent error message to see why it failed or Network log, if request originated from the browser. + + + +### ZWED0041W + + [Proxy URL: _urlPrefix_] Exception caught. Message=_message_ + + **Reason:** + + For _urlPrefix_ proxy, an exception was caught with content _message_ + + **Action:** + + No action needed usually, but message may be needed for debugging + + + +### ZWED0042W + + Stack trace follows + _stack_ + + **Reason:** + + For the exception from ZWED0041W, a _stack_ trace is printed + + **Action:** + + No action needed usually, but stack may be needed for debugging + + + +### ZWED0043W + + [Proxy URL: _urlPrefix_] proxyWS error: _error_ + + **Reason:** + + Proxy worker encountered an _error_ + + **Action:** + + No action needed usually except, debugging of the error. + + + +### ZWED0044W + + [Proxy URL: _urlPrefix_] WS error: _error_ + + **Reason:** + + Worker encountered an _error_ + + **Action:** + + No action needed usually except, debugging of the error. + + + +### ZWED0045W + + Failed to reach the auth services host for address _host_:_port_ + + **Reason:** + + Client encountered error when trying to connect to an agent _host_:_port_ + + **Action:** + + This usually means your agent (for example: ZSS) is unreachable or your configuration is pointing to an incorrect agent + + + +### ZWED0046W + + The auth services host system was not specified at startup, and defaulted to 127.0.0.1. + Verify that the auth services server is running, or specify at startup the remote host and port to connect to. See documentation for details. + + **Reason:** + + Client encountered an error when trying to connect to the agent from ZWED0045W + + **Action:** + + See ZWED0045W + + + +### ZWED0048W + + Invalid Swagger from file for service (_plugin identifier_:_service name_) + + **Reason:** + + N/A + + **Action:** + + Check validity of Swagger file + + + +### ZWED0049W" + + _error message_ _stack_ + + **Reason:** + + Prints the _error message_ and _stack_ from ZWED0048W + + **Action:** + + See ZWED0048W + + + +### ZWED0051W + + Failed to parse translation file _path_. File skipped + + **Reason:** + + Failed to parse the file _path_ as a valid translation file, most likely because it's not valid JSON + + **Action:** + + Check if the translation file is valid JSON and matches the structure of core translation files (i.e. Sample Apps) + + + +### ZWED0052W + + Error when reading file=_path_. Error=_message_ + + **Reason:** + + Failed to read certificates or keys _path_ with a returned _message_ + + **Action:** + + Review content of _message_ and correct + + + +### ZWED0053W + + Event handler failed: _error_ + + **Reason:** + + An asynchronous event listener handler failed + + **Action:** + + This isn't part of normal operation, if it causes issue, _error_ and any relevant context should be sent to developers + + + +### ZWED0054W + + Skipping invalid listener address=_hostname_ + + **Reason:** + + _hostname_ was deemed invalid when attempting a DNS lookup to find IP address + + **Action:** + + Compare with your configuration to see where the invalid _hostname_ is being picked up + + + +### ZWED0055W + + Skipping invalid listener address=_hostname_ + + **Reason:** + + _hostname_ is not a valid string + + **Action:** + + Compare with your configuration to see where the invalid _hostname_ is being referenced + + + +### ZWED0056W + + Couldn't process _address_ as IP + + **Reason:** + + The _address_ was not pointing a valid IP address by the ipaddr utility + + **Action:** + + Compare with your configuration to see where the invalid _address_ is being referenced + + + +### ZWED0057W + + Loopback calls: localhost equivalent address not found in the list _listenerAddresses_. Using first address _address_; Verify firewall will allow this. + + **Reason:** + + Unable to find a localhost equivalent from the _listenerAddresses_ list so the server considers the first address in the loop by default. + + **Action:** + + Verify if this is intended configuration (edit/define zowe.components.app-server.node.https.ipAddresses or check Zowe documenation) + + + +### ZWED0058W + + Log location for logger '_identifier_:_serviceDefinitionName_' is undefined + + **Reason:** + + Log location isn't being specified for this dataservice. + + **Action:** + + Check dataservice plugin definition to see if log location is being specified. + + + +### ZWED0059W + + Failed to add the plugin: _errorMessage_ + + **Reason:** + + Using the /plugins API to add a plugin, has failed + + **Action:** + + Review _errorMessage_ for explanation + + +### ZWED0060W + + _errorMessage_ + + **Reason:** + + Invalid JSON + + **Action:** + + Review _errorMessage_ + + +### ZWED0061W + + Callservice: Service call failed. + + **Reason:** + + A network request to this service failed. + + **Action:** + + Check Network log and review the error. + + + +### ZWED0062W + + [Service URL: _url_] Exception caught. Message=_errorMessage_ + + **Reason:** + + An error occurred calling _url_ with reason _errorMessage_ + + **Action:** + + Review correctness of _url_ and review _errorMessage_ + + + +### ZWED0063W + + Stack trace follows _stackTrace_ + + **Reason:** + + This exception originates from the web socket and the stack trace message handles the generated exception. + The stack trace for an exception helps in understanding the error and what went wrong with the code. + + **Action:** + + No action needed unless user is experiencing an interruption in the server service, then send the stack to developers. + + + +### ZWED0064W + + _plugin.identifier_: Invalid method _method_ + + **Reason:** + + It will throw the warning if _method_ is invalid (different from these methods: get|post|put|delete|ws) + + **Action:** + + Review the warning message and use correct method. + + + +### ZWED0065W + + Library plugin _plugin.identifier_ is missing libraryVersion attribute for hosting files. Skipping file hosting. + + **Reason:** + + Library plugin's plugin definition is missing the library version attribute. + + **Action:** + + Add the correct library version in the plugin definition. + + + +### ZWED0066W + + _pluginID_: getCapabilities() is not a function + + **Reason:** + + The handler for plugin _pluginID_ does not have a getCapabilities() method + + **Action:** + + No action required. If your desired authentication plugin isn't successfully authenticating a login, + please send the log and any relevant info to the developers. + + + +### ZWED0068W + + Failed to set proxy authorizations. Error=_errorMessage_ + + **Reason:** + + Failed to add proxy authorization with reason _errorMessage_. + + **Action:** + + No action required. If your desired authentication plugin isn't successfully authenticating a login, + please send the log and any relevant info to the developers. + + + +### ZWED0069W + + Returning null for cipher array because input had non-string: + + **Reason:** + + Returns null for cipher array if an array element is not a string type. + + **Action:** + + Please verify, if any custom cyphers present, that all cyphers are of type string. + + + +### ZWED0070W + + Error when reading PFX. The server cannot continue. Error=_errorMessage_ + + **Reason:** + + If we get an error while reading _config.https.pfx_ file then the server cannot continue + and throws _errorMessage_. + + **Action:** + + No action is needed, but the _errorMessage_ may be needed to debug + + + +### ZWED0071W + + Unexpected error on server _ipAddress_:_port_. E=_errorMessage_. Stack trace follows. _stack_ + + **Reason:** + + When we get an unexpected (anything except EACCES, EADDRINUSE, ENOTFOUND, EADDRNOTAVAIL) error + in the web server for _ipAddress_:_port_. + + **Action:** + + No action needed unless user is experiencing an interruption in server, then send error message and stack to developers + + + +### ZWED0072W + + Could not stop manager due to error _errorMessage_ + + **Reason:** + + If the server manager is unable to stop due to any reason it will throw an exception with an _errorMessage_. + + **Action:** + + If the Java manager (handles Jar and War) is unable to stop all servers, send _errorMessage_ to developers + + + +### ZWED0073W + + No server returned for group=_group_ + + **Reason:** + + If No server was found in this War _group_ then it will throw this warning message. + + **Action:** + + No action is required + + +### ZWED0074W + + Unknown default behavior=_defaultBehavior_ + + **Reason:** + + The default grouping behaviour in the config for this War is not of type 'microservice' or 'appserver' + + **Action:** + + No action is needed, but the warning may be needed to debug + + + +### ZWED0075W + + Services in plugin=_plugin_ war grouping skipped. Plugin missing or already grouped + + **Reason:** + + Server was not created for _plugin_ War grouping, because it was already made or plugin is missing. + + **Action:** + + No action is needed + + + +### ZWED0076W + + Skipping invalid plugin group=_plugins_ + + **Reason:** + + If _plugins_ is not an array and the size is less than zero, then it will log a warning message. + + **Action:** + + Make sure _plugins_ should be an array of size greater than zero. + + + +### ZWED0077W + + Could not extract war for service=_key-value_, error=_errorMessage_ + + **Reason:** + + If the service with the _key-value_ pair is unable to extract the war file then it throws the _errorMessage_ + + **Action:** + + Check if the war file exists and configured correctly. + + + +### ZWED0078W + + Could not access files to determine status for service=_key-value_, error=_errorMessage_ + + **Reason:** + + If we are unable to get the status of war extracted or not, then it throws _errorMessage_ in catch block. + + **Action:** + + Check if the war file exists. + + + +### ZWED0079W + + Cannot add servlet for service=_key-value_, error=_errorMessage_ + + **Reason:** + + If unable to add servlet for service _key-value_, then it logs a warning _errorMessage_. + + **Action:** + + No action is needed, but the warning may be needed to debug this War + + + +### ZWED0080W + + Cannot add servlet for service=_key-value_ + + **Reason:** + + When we are not able to get the directory to add servlet for service _key-value_. + + **Action:** + + Check if your directory exists and is valid. + + + +### ZWED0081W + + Could not start Tomcat, error=_errorMessage_ + + **Reason:** + + Tomcat manager is unable to start Tomcat with the Java option, due to an incorrect configuration with `components.app-server.node.https.port`, `components.app-server.node.https.key`, or `components.app-server.node.https.certificate`. + + **Action:** + + Verify configuration with `components.app-server.node.https.port`, `components.app-server.node.https.key`, or `components.app-server.node.https.certificate` is valid or not. + + + +### ZWED0082W + + Tomcat PID=_pid_: stderr=_error_ + + **Reason:** + + A Tomcat process with Tomcat _pid_ encountered an _error_ (stderr). + + **Action:** + + Action depends on what _error_ is and may be useful to debug. + + + +### ZWED0083W + + Tomcat could not start. Closing. code=_code_ + + **Reason:** + + If the Tomcat manager is unable to start itself, then it closes with _code_. + + **Action:** + + Review the message and if app server service is interrupted, send the message along with the log to support for troubleshooting. + + + +### ZWED0084W + + Tomcat could not start. Exiting. code=_code_ + + **Reason:** + + If the Tomcat manager is unable to start itself, then it exits with _code_. + + **Action:** + + Review the message and if app server service is interrupted, send the message along with the log to support for troubleshooting. + + + +### ZWED0085 + + Tomcat PID=_pid_ Error when stopping, error=_errorMessage_ + + **Reason:** + + If Tomcat manager is unable to stop the Tomcat process on Windows, then it logs _errorMessage_. + + **Action:** + + Review the _errorMessage_ and see if there is something you can do to fix the error + + + +### ZWED0086W + + Could not stop Tomcat, error=_errorMessage_ + + **Reason:** + + If Tomcat manager is unable to stop the Tomcat process on Unix, then it logs _errorMessage_. + + **Action:** + + Review the _errorMessage_ and if app server service is interrupted, send the message along with the log to support for troubleshooting. + + + +### ZWED0087W + + Tomcat PID=_pid_: stderr=_error_ + + **Reason:** + + While stopping Tomcat, Tomcat process with Tomcat _pid_ encountered an _error_ (stderr). + + **Action:** + + Review the _error_ and if app server service is interrupted, send the message along with the log to support for troubleshooting.. + + + +### ZWED0146W + + Could not stat destination or temp folder _path_. Error=_ErrorMsg_ + + **Reason:** + + Server was unable to use 'stat' command on folder _path_ and threw _ErrorMsg_. + + **Action:** + + No action is needed usually, however, need to debug the _ErrorMsg_. + + + +### ZWED0148W + + App extracted but not registered to App Server due to write fail. Error=_errorMessage_ + + **Reason:** + + App extracted successfully but not registered to App Server due to write fail. Error=_errorMessage_. + + **Action:** + + Go through the _errorMessage_ and undestand what to debug. + + + +### ZWED0149W + + Could not find pluginDefinition.json file in App (dir=_AppDir_). Error=_ErrorMsg_ + + **Reason:** + + Throws _ErrorMsg_ when its not able to find the pluginDefinition.json file in _AppDir_ location. + + **Action:** + + Check if pluginDefinition.json exists in _AppDir_. + + + +### ZWED0150W + + _identifier_ library path _location_ does not exist. + + **Reason:** + + Server throws warning when library plugin _identifier_ does not exist at path _location_. + + **Action:** + + Check if the library plugin exists in the path _location_. + + + +### ZWED0151W + + unhandledRejection _error_ + + **Reason:** + + When process experiences an unhandledRejection. + + **Action:** + + No action is needed usually, however, need to debug the _ErrorMsg_. + + + +### ZWED0152W + + Error at call sessionStore. _APIMethodname_: _Error Object_ + + **Reason:** + + There is a problem calling a sessionStore _APIMethodname_. + + **Action:** + + No action is needed usually, however, need to debug the _ErrorMsg_. + + + +### ZWED0153W + + WARNING: CLI Argument missing name or has unsupported type=_type_ + + **Reason:** + + The server throws a warning when the CLI argument is missing a name, or has an unsupported type (supported types: 1 - _flag_, 2 - _value_, 3 - _json_). + + **Action:** + + Check any missing argument or unsupported argument. + + + +### ZWED0154W + + WARNING: Unrecognized command: _args_ + + **Reason:** + + Throws warning when _args_ is unrecognized. + + **Action:** + + Check the command once again or check if the specified command is interpreted as intended. + + + +### ZWED0155W + + _ErrorMsg_ + + **Reason:** + + Server throws 500 code with _ErrorMsg_. + + **Action:** + + Go through the _ErrorMsg_ for context on what to debug. + + + +### ZWED0156W + + 1 function initLoggerMessages - ERROR - _Error_ + + **Reason:** + + Attempt to get log message for a language a user may have specified, has failed with _Error_. + + **Action:** + + Go through the _Error_ for details on what to debug. + + + +### ZWED0157W + + 2 function initLoggerMessages - ERROR - _Error_. + + **Reason:** + + Attempt to get log message for English has failed with _Error_. + + **Action:** + + Go through the _Error_ for details on what to debug. + + + +### ZWED0158W + + _ErrorMsg_ + + **Reason:** + + Server throws 500 code with _ErrorMsg_. + + **Action:** + + Go through the _ErrorMsg_ for details on what to debug. + + + +### ZWED0159W + + Plugin (_PluginIdentifier_) loading failed. Message: "_errorMessage_" Successful: _pluginsLoaded_% (_pluginsLoaded_/_eventCount_) Attempted: _pluginCount_% (_pluginCount_/_eventCount_) + + **Reason:** + + Plugin with _pluginId_ loaded failed with _errorMessage_. The server attempted to load a total of _pluginCount_ with _pluginsLoaded_ plugins already successfully loaded. + + **Action:** + + Review _errorMessage_ to see if there is something you can do to fix the error. You may need to contact the plugin developer to find a solution. If you do not need this plugin, it is OK to continue. + + + +### ZWED0166W + + Error updating the storage: _Error_ + + **Reason:** + + Throws warning _Error_ when it faced error while updating the storage. + + **Action:** + + Contact support if _Error_ is not clear. + + + +### ZWED0167W + + Error adding to the storage: _errorMessage_ + + **Reason:** + + Throws _errorMessage_ while adding to the storage. + + **Action:** + + If app server service is interrupted, go through the _errorMessage_ for details on what to debug or contact support if _errorMessage_ is not clear. + + + +### ZWED0168W + + Unable to retrieve storage value from cluster _Error_ + + **Reason:** + + Throws warning _Error_ when it is unable to retrieve storage value from cluster. + + **Action:** + + By default, the timeout for cluster method calls is 1000ms which should cause no issues. If service is interrupted, contact support and provide _Error_. + + + +### ZWED0169W + + Error deleting the storage with id: _deleteStorageByKey_ _Error_ + + **Reason:** + + when server tries deleting storage by key _deleteStorageByKey_. + + **Action:** + + Contact support if _Error_ is not clear. + + + +### ZWED0170W + + Plugin (_PluginIdentifier_) loading failed. Version: _PluginVersion_. Message: "_Error_" + + **Reason:** + + Plugin _PluginIdentifier_ with version _PluginVersion_ has failed to load with an _Error_. + + **Action:** + + Review _Error_ to see if there is something you can do to fix the error. You may need to contact the plugin developer to find a solution. If you do not need this plugin, it is OK to continue. + + + +### ZWED0171W + + Rejected undefined referrer for url=_originalUrl_, ip=_ip_ + + **Reason:** + + Throws 403 Forbidden when App server fails to honor a network request due to failed referrer check. + + **Action:** + + Double check the address. A possible reason for a 403 error is a misstyped _originalUrl_ or _ip_ or because loopback routing is not configured in the App server. + + + +### ZWED0172W + + Rejected bad referrer=_referrerHeaderValue_ for url=_accessedUrl_, ip=_clientIp_ + + **Reason:** + + The client from _clientIp_ tried to access _accessedUrl_ but due to having a referrer header value that didn't seem to originate from this server, a security violation was caused and the attempt to access the URL was rejected. + + **Action:** + + Review the values to determine if this was a valid attempt to access the server or not. If this access seems suspicious, then the server was correct in rejecting the access. However, if the access attempt seemed legitimate, then this points to the referrer configuration needing revision. You can customize which referrer header values are permitted using the environment variable ZWE_REFERRER_HOSTS and it should be set to match the external hostnames of the system the app-server is running on. + + + +### ZWED0173W + + Unable to decode P12 certificate (different password than keystore?). Attempting to use empty string as password. Decode error: _error_. + + **Reason:** + + The server tried to load the p12 file provided for the server certificate or certificate authorities, but encountered _error_. The server may not be accessible as a result of invalid TLS configuration. + + **Action:** + + Check the value of zowe.certificate.keystore.password and zowe.certificate.truststore.password, or the environment variable KEYSTORE_PASSWORD to see if they are valid for the p12 file provided, and adjust the configuration if needed. + + + +### ZWED0174W + + _componentName_ could not verify (_operatingSystem_) as a supported platform to install (_pluginId_). Proceeding anyway... + + **Reason:** + + The plugin _pluginId_ has a dependency which can only run on certain operating systems, and _operatingSystem_ is not on the list, but because the operating system is not explicitly forbidden, the server will attempt to load the plugin anyway. This may fail, but the server may continue to run without the plugin if possible. + + **Action:** + + Review the plugin dependencies as seen in the plugin's pluginDefinition.json file to see if your Zowe configuration or the plugin can be changed in order to match the requirements. Consult the plugin developer if you believe the plugin was able to run fine on the operating system, so they can explicitly add support in the future. + + + +### ZWED0175W + + _componentName_ could not verify (_systemArchitecture_) as a supported architecture to install (_pluginId_). Proceeding anyway... + + **Reason:** + + The plugin _pluginId_ has a dependency which can only run on certain system architectures, and _systemArchitecture_ is not on the list, but because the system architecture is not explicitly forbidden, the server will attempt to load the plugin anyway. This may fail, but the server may continue to run without the plugin if possible. + + **Action:** + + Review the plugin dependencies as seen in the plugin's pluginDefinition.json file to see if your Zowe configuration or the plugin can be changed in order to match the requirements. Consult the plugin developer if you believe the plugin was able to run fine on the system architecture, so they can explicitly add support in the future. + + + +### ZWED0177W + + Unable to load _actionOrRecognizer_ for '_pluginId_' into config + + **Reason:** + + The plugin _pluginId_ has an action or recognizer within its package and the plugin install process was trying to copy that into the workspace so it can be used, but encountered an error that prevented this. + + **Action:** + + Contact support if the reason cannot be determined. + + + +### ZWED0178W + + Skipping authentication plugin _pluginId_ because it's not HA compatible + + **Reason:** + + The server is setup for running in high availability (HA) mode which requires that plugins that have state, in particular authentication plugins, must be HA-compatible or else errors will occur. Therefore, the server skips over loading of this plugin nbecause its pluginDefinition.json did not state it was HA compatible. + + **Action:** + + Either the plugin must be updated to support and state its support for HA, or it must be removed, or HA mode disabled. To make a plugin support HA, the conformance program should be reviewed. When HA mode is supported, the plugin can be marked as compatible by setting capabilities.haCompatible=true within its initialization. + + + +### ZWED0179W + + Unable to retrieve the list of certificate authorities from the keyring=_keyringName_ owner=_username_ Error: _error_ + + **Reason:** + + The server could not automatically determine the certificate authorities (CA) from the z/OS keyring listed. This may cause the server to be unable to verify certificate chains from other servers or clients causing other errors later. + + **Action:** + + Review the error to resolve it and contact support if needed. It's also possible as a workaround to explicitly state the CAs within the keyring that you would like to load, rather than relying upon the server's attempt to automatically find all CAs within the keyring. + + + +### ZWED0001E + + Error: _error_ + + **Reason:** + + The server is running in cluster mode and the cluster manager has encountered an unexpected error. + + **Action:** + + Review the error to resolve it, and contact support if needed. + + + +### ZWED0002E + + Could not stop language manager for types=_languageNames_ + + **Reason:** + + A plugin had a service that needed a language manager to run. During shutdown, the language manager could not be stopped. + + **Action:** + + The language manager may continue to run after the app-server shuts down. Review the logs to determine the location of the language manager and try to stop the manager manually. + + + +### ZWED0003E + + Loopback configuration not valid, _loobackConfiguration_ + Loopback calls will fail! + + **Reason:** + + The loopback configuration that the server uses to contact itself over an internal network was missing a value for the network port, therefore no requests over the loopback address will be possible. + + **Action:** + + Review the configuration of `components.app-server.node.port` to see if it has a value and set one to fix the issue. + + + +### ZWED0004E + + Could not listen on address _ip_:_port_. It is already in use by another process. + + **Reason:** + + The server tried to start using the ip and port values shown which were from the zowe configuration. When trying to connect to this address, the server recieved an error telling it that the address was already in use. + + **Action:** + + Check the system's network port status to see what program could be using this address, and either stop that program or change the zowe configuration to use a different address before restarting zowe. + + + +### ZWED0005E + + Could not listen on address _ip_:_port_. Invalid IP for this system. + + **Reason:** + + When the app-server was binding to the address shown, it recieved the error EADDRNOTAVAIL or ENOTFOUND. In either case, the app-server was not able to bind to the address and so it will not run until the problem is solved. + + **Action:** + + Review the address and check if it is valid or if there is some lack of permissions that might explain why these errors were received by the server. + + + +### ZWED0006E + + Usage: --inputApp | -i INPUTAPP --pluginsDir | -p PLUGINSDIR --zluxConfig | -c ZLUXCONFIGPATH [--verbose | -v] + + **Reason:** + + This message appearas when you attempt app installation but have not provided enough of the mandatory arguments for the program to run. It is printing out what options are valid so that you can retry with different options. + + **Action:** + + Retry the operation after modifying the input arguments to be valid against the list shown. Or, if you are trying to do app installation, you should use `zwe components install` instead whenever possible. + + + +### ZWED0007E + + _serviceName_ invalid version _version_ + + **Reason:** + + The service mentioned was trying to be loaded by the server but failed validation due to the version number not being a a valid semver string. This service and therefore plugin will be skipped during loading. + + **Action:** + + Contact the developers so that they can revise the pluginDefinition.json of the plugin where the service is located to be semver-compatible. Details on semver version can be found at semver.org + + + +### ZWED0008E + + _localServiceName_: invalid version range _serviceName_: _versionRange_ + + **Reason:** + + When the _serviceName_ was trying to be imported into a plugin as _localServiceName_, the version range of acceptable versions for the service to be imported was not valid. Due to this, the import cannot be resolved and the plugin will be skipped in loading. + + **Action:** + + Contact the developers of the plugin this error occurred in as the pluginDefinition.json needs to be revised to have the version range given for this import service be a valid semver range string. + + + +### ZWED0009E + + _localServiceName_: invalid version range _versionRange_ + + **Reason:** + + When the a service was trying to be imported into a plugin as _localServiceName_, the version range of acceptable versions for the service to be imported was not valid. Due to this, the import cannot be resolved and the plugin will be skipped in loading. + + **Action:** + + Contact the developers of the plugin this error occurred in as the pluginDefinition.json needs to be revised to have the version range given for this import service be a valid semver range string. + + + +### ZWED0010E + + No file name for data service + + **Reason:** + + When the server was trying to load a service for a plugn, it couldn't identify the filename where the service is located within the plugin, so the service and therefore plugin have been skipped during loading. + + **Action:** + + Contact the plugin developer to fix that the service within the pluginDefinition.json is missing the "fileName" or "filename" property which must describe the path to the dataservice entry file, relative to the plugin's lib directory. + + + +### ZWED0011E + + Plugin _pluginId_ has web content but no web directory under _location_ + + **Reason:** + + The plugin definition of _pluginId_ stated that the plugin has web content to serve such as HTML files, but the required 'web' folder was missing, so the plugin cannot be loaded. + + **Action:** + + Check that the web folder within this plugin exists or not. If it does exist, then the server may not have had permission to read it. Otherwise, if it doesn't exist, try to reinstall the plugin in case it is corrupt. Or, contact the developers to fix the lack of web directory. + + + +### ZWED0012E + + _pluginId_::_serviceName_ Required local service missing: _localService_ + + **Reason:** + + The service _serviceName_ could not be loaded because of an unsatisfied version requirement upon another service. This causes the plugin _pluginId_ to be skipped during loading. + + **Action:** + + Review the plugin's definition to see why the version match could not be made. Either a required plugin is missing, or the pluginDefinition.json will need to be revised by the developer of the plugin to fix the version check failure. + + + +### ZWED0013E + + _pluginId_::_serviceName_ Could not find a version to satisfy local dependency _serviceName_@_requiredVersion_ + + **Reason:** + + The service _serviceName_ could not be loaded because of an unsatisfied version requirement upon another service. This causes the plugin _pluginId_ to be skipped during loading. + + **Action:** + + Review the plugin's definition to see why the version match could not be made. Either a required plugin is missing, or the pluginDefinition.json will need to be revised by the developer of the plugin to fix the version check failure. + + + +### ZWED0014E + + Plugin _pluginId_ invalid + + **Reason:** + + The plugin could not be loaded because the plugin definition was not valid in some way. There are fields that every plugin must define, such as type. Then, depending on type, there are more fields a plugin can and cannot have. When the server went to load the plugin, it found that the definition was not correct versus the requirements, so the loading of this plugin was skipped. + + **Action:** + + Contact the developers of this plugin so that they can fix the plugin to adhere to the [plugin schema](https://github.com/zowe/zlux-app-server/blob/v2.x/master/schemas/plugindefinition-schema.json) + + + +### ZWED0015E + + No plugin directory found at _pluginLocation_ + + **Reason:** + + The server finds plugins by reading JSON files within the "plugins" folder of its workspace directory. When it checked the JSON of this particular plugin, the JSON stated the plugin could be found at a folder _pluginLocation_ which either does not exist or could not be read by the server. + + **Action:** + + Check that the location shown exists. If it does exist, then there is some permission problem preventing the server from reading it. If it does not exist, determine whether this plugin is desired but has the wrong location, or if this plugin is not desired and should be removed. Contact support so they can assist in fixing the plugin location problem. + + + +### ZWED0016E + + No pluginDefinition.json found at _pluginLocation_ + + **Reason:** + + The server finds plugins by reading JSON files within the "plugins" folder of its workspace directory. When it checked the JSON of this particular plugin, it stated the plugin was located in a folder which the server determined did not contain the pluginDefinition.json file that every plugin requires. Due to this missing file, the loading of this plugin was skipped. + + **Action:** + + Check that a pluginDefinition.json exists at the location specified. If it does, then the server is missing permissions necessary to read the file. If the file does not exist, review if there is a problem with the plugin itself that should be resolved by contacting the plugin developers. If the plugin exists with a pluginDefinition.json file at a different location than the error suggests, contact Zowe support to resolve the location problem. + + + +### ZWED0017E + + Identifier doesn't match one found in pluginDefinition: _pluginIdentifier_ + + **Reason:** + + The identifier found in the plugin reference doesn't match the one specified in the pluginDefinition.json + + **Action:** + + Check if identifier found is the same one as intended (typo perhaps?). If not, delete the plugin identifier JSON (found in instance/workspace/app-server/plugins) and restart Zowe. If issue isn't resolved, increase app server debugging and send logs to the app developer + + + +### ZWED0018E + + No plugin type found, skipping + + **Reason:** + + The plugin definition for the plugin has no 'pluginType' property set + + **Action:** + + Contact app developers if you need plugin to be loaded and working + + + +### ZWED0019E + + Plugin already registered + + **Reason:** + + A plugin with this identifier has already been registered to the map of plugins + + **Action:** + + Check if you have multiple components sharing the same, or different versions, of the same plugin. This is not allowed + + + +### ZWED0020E + + "_pluginIdentifier_: pluginType _type_ is unknown + + **Reason:** + + The plugin _pluginIdentifier_ has in its plugin definition an invalid plugin _type_ + + **Action:** + + Accepted plugin types found in the schema (https://github.com/zowe/zlux-app-server/blob/v2.x/staging/schemas/plugindefinition-schema.json#L47) + + + +### ZWED0021E + + _pluginPath_ is missing + + **Reason:** + + App server tried to process the plugin reference from path _pluginPath_ + + **Action:** + + Check if _pluginPath_ is a real path or the App server (started task user of Zowe) has the permission to read it + + + +### ZWED0022E + + Module not found _moduleName_ + + **Reason:** + + App server, during a cluster/worker method call, tried to require a module _moduleName_ it couldn't find + + **Action:** + + Contact the plugin developer if plugin returns this error. + + + +### ZWED0023E + + Method not implemented _methodName_ + + **Reason:** + + App server, during a cluster/worker method call, tried to act on a method that isn't valid. + + **Action:** + + Contact the plugin developer if plugin returns this error. + + + +### ZWED0024E + + Object not exported _exportName_ + + **Reason:** + + App server, during a cluster/worker method call, tried and failed to export a module object. + + **Action:** + + Contact the plugin developer if plugin returns this error. + + + +### ZWED0025E + + .authenticate() missing + + **Reason:** + + Authentication plugin (which plugin includes looking at nearby log messages) is missing the .authenticate() method. + + **Action:** + + Contact the plugin developer if plugin is essential for authenticaiton. + + + +### ZWED0026E + + Circular dependency: _pluginIdentifier_ + + **Reason:** + + The App server encountered a circular dependency for plugin _pluginIdentifier_ (meaning it contains a dependency that imports itself). + + **Action:** + + Contact the plugin developer for troubleshooting help. This is a packaging issue. + + + +### ZWED0027E + + Circular dependency: _pluginIdentifier_ + + **Reason:** + + The App server encountered a circular dependency for plugin _pluginIdentifier_ (meaning it contains a dependency that imports itself). + + **Action:** + + Contact the plugin developer for troubleshooting help. This is a packaging issue. + + + +### ZWED0028E + + Config invalid + + **Reason:** + + The App server attempted to validate and process the server configuration and there was an issue. + + **Action:** + + Please consult the App server schema components.app-server.node section (https://github.com/zowe/zlux-app-server/blob/v2.x/staging/schemas/app-server-config.json#L9). You may also instead have a syntax issue. For a free, offline YAML validator, check out RedHat's VSCode YAML Extension + + + +### ZWED0038E + + JavaManager given port range beyond limits + + **Reason:** + + The Java manager was given a port outside the valid port range (0 < 65535). + + **Action:** + + Please check your configuration to see if any ports are out of bounds. + + + +### ZWED0039E + + JavaManager not given any ports with which to run servers. + + **Reason:** + + Configuration does not contain ports for Java manager to try to run the servers. + + **Action:** + + Please check your configuration to see if any ports are missing. + + + +### ZWED0040E + + Unknown java war grouping default=_grouping_ + + **Reason:** + + For this war, an unknown grouping default _grouping_ was encountered (types: 'microservice' or 'appserver' allowed). + + **Action:** + + Contact the plugin developer for troubleshooting. + + + +### ZWED0041E + + Could not find port to use for configuration, at config position=_portIndex_. + + **Reason:** + + The server was trying to determine a network port to use for a Java dataservice, but no available ports could be found, so the server cannot load that service. + + **Action:** + + Check your Zowe configuration to see if you have enough or any ports specified for the app-server to use when assigning ports to Java dataservices. + + + +### ZWED0042E + + Could not find runtime to satisfy group: _javaRuntime_ + + **Reason:** + + When trying to run a group of Java dataservices under a common java runtime, the _javaRuntime_ couldn't be found, so the dataservices cannot be run. + + **Action:** + + Check the configuration for this group of Java services to see if _javaRuntime_ is a good value, and resolve the Java issue before restarting the server. + + + +### ZWED0043E + + Unknown java app server type=_javaRuntimeTime_ specified in config. Cannot continue with java loading. + + **Reason:** + + The app-server can only handle Java dataservices if they run under certain types of Java server runtimes. The type chosen was not one of the types supported, so the server cannot continue with the loading. + + **Action:** + + Check if the version of the plugin you are using is compatible with the version of Zowe you are using. Check if you can change the "type" of java server to one that the app-server does work with, such as "tomcat". + + + +### ZWED0044E + + Java runtimes not specified, and no JAVA_HOME set + + **Reason:** + + The app-server cannot run the java dataservices because it doesn't know how to start any Java with the configuration specified. + + **Action:** + + Either define the environment variable JAVA_HOME to point to a valid Java runtime home, or specify a Java runtime within the app-server configuration as `components.app-server.languages.java.runtimes`. For more information, see the server schema https://github.com/zowe/zlux-app-server/blob/v2.x/master/schemas/app-server-config.json + + + +### ZWED0045E + + Java app server not defined in config + + **Reason:** + + A dataservice was configured to run from a WAR file but the configuration section `components.app-server.languages.java.war.javaAppServer` was missing, so the app-server could not run the dataservice. + + **Action:** + + Define the missing configuration section according to the app-server schema https://github.com/zowe/zlux-app-server/blob/v2.x/master/schemas/app-server-config.json or remove it and the plugin that required it. + + + +### ZWED0046E + + JavaManager not given either war or jar configuration options, nothing to do + + **Reason:** + + A java dataservice was requested but the `components.app-server.languages.java` configuration section of Zowe was missing either a `war` or `jar` subsection. Since one of the two is needed, the server could not continue with loading the java dataservices. + + **Action:** + + Review the app-server schema https://github.com/zowe/zlux-app-server/blob/v2.x/master/schemas/app-server-config.json and your Zowe configuration file to identify and correct the missing properties within `components.app-server`. + + + +### ZWED0047E + + Proxy (_pluginid_:_servicename_) setup failed. + Host & Port for proxy destination are required but were missing. + For information on how to configure a proxy service, see the Zowe wiki on dataservices (https://github.com/zowe/zlux/wiki/ZLUX-Dataservices) + + **Reason:** + + A proxy was requested by the service _pluginid_:_servicename_ but the service configuration or pluginDefinition did not specify what the proxy destination was, so the server is skipping the loading of that plugin. + + **Action:** + + Review the plugin's configuration or contact the developer of that plugin to correct the proxy configuration. + + + +### ZWED0049E + + Can't specify error metadata + + **Reason:** + + When a dataservice called the utility function makeErrorObject, it did not supply context of the `_objectType` and `_metaDataVersion`, which are required and caused the function to throw its own error about the lack of information. + + **Action:** + + Contact the developer of the plugin which caused this error. + + + +### ZWED0050E + + Root service _serviceName_ not found + + **Reason:** + + A dataservice tried to call a "root", or non-plugin service of the app-server or app-server's agent, and this root service _serviceName_ was not found on the server, so the request failed. + + **Action:** + + Verify that your version of Zowe works with the plugins that you have installed, and contact the developer of the plugin which tried to call this missing root service. + + + +### ZWED0051E + + Could not resolve service URL. Plugin=_pluginId_, service=_serviceName_ + + **Reason:** + + A dataservice _serviceName_ handled by a language manager could not be used because the URL in which to access this dataservice from its language manager could not be determined. + + **Action:** + + Check the logs to see if there was trouble installing the service or plugin, and contact the developers of _pluginId_ for more support. + + + +### ZWED0052E + + Could not load service _pluginId_:_serviceName_ due to unknown type=_serviceType_ + + **Reason:** + + The service from the plugin shown could not be loaded because the plugin declared the service to be of some type that the app-server does not handle. + + **Action:** + + Check to see if the version of Zowe you are using works with the version of the plugin you are using. Plugins must have dataservices only of types seen within the pluginDefinition schema https://github.com/zowe/zlux-app-server/blob/v2.x/staging/schemas/plugindefinition-schema.json + + + +### ZWED0053E + + Import _sourcePluginId_:_sourceServiceName_ can't be satisfied + + **Reason:** + + A plugin trying to load a dataservice from _sourcePluginId_:_sourceServiceName_ couldn't load that service, therefore the requesting plugin will fail to load. + + **Action:** + + Confirm that the source plugin and service exist. Check the logs to see if there was something that caused the source service to fail loading. Contact the developers of either source or target plugin for more assistance if the cause is not clear. + + + +### ZWED0111E + + SEVERE: Exception occurred trying to generate object from input: _error_ + + **Reason:** + + The server could not parse its input configuration due to the error shown, so the server cannot start. + + **Action:** + + Review the error to determine the cause, or contact support if the cause is unclear. + + + +### ZWED0112E + + The server found no plugin implementing the specified default authentication type of _type_. + + **Reason:** + + The value of `components.app-server.dataserviceAuthentication.defaultAuthentication` within the server configuration specified a type of authentication that some authentication plugin must implement in order for the server to run. Because no plugin that successfully loaded declared that it implemented this type, the server found no implementation and could not continue. + + **Action:** + + Review if any plugin you have implements the given type. If the type is incorrect, revise the configuration to choose a type that does exist in your system. If the type is correct, check if you are missing a required plugin. + + + +### ZWED0113E + + The server found no authentication types. Verify that the server configuration file defines server authentication. + + **Reason:** + + The server was unable to find any authentication plugins where at least one is required to run. + + **Action:** + + Review the list of plugins that are being used and see if any authentication plugins you needed have failed to load, and review their error messages. + + + +### ZWED0114E + + The server found no plugin implementing the specified default authentication type of _type_. + + **Reason:** + + The value of `components.app-server.dataserviceAuthentication.defaultAuthentication` within the server configuration specified a type of authentication that some authentication plugin must implement in order for the server to run. Because no plugin that successfully loaded declared that it implemented this type, the server found no implementation and could not continue. + + **Action:** + + Review if any plugin you have implements the given type. If the type is incorrect, revise the configuration to choose a type that does exist in your system. If the type is correct, check if you are missing a required plugin. + + + +### ZWED0115E + + Unable to retrieve storage object from cluster. This is probably due to a timeout. + You may change the default of '_storageTimeout_' ms by setting 'node.cluster.storageTimeout' within the config. + + **Reason:** + + The app-server was running in cluster mode and a service attempted to get content from the cluster storage but this failed. Because storage could not be read, its possible the service that requested the storage will have further errors. + + **Action:** + + If there was a network disruption or performance issue, a timeout could have occurred. Review the rest of the logs to see if there are other messages to explain the failure. You can attempt to avoid timeout-related failures by editing the configuration parameter `components.app-server.node.cluster.storageTimeout`. + + + +### ZWED0145E + + Cannot load SAF keyring content outside of z/OS + + **Reason:** + + The Zowe configuration of `zowe.certificate` or `components.app-server.node.https` specifies SAF keyrings as locations to find keystore and truststore data. SAF keyrings only exist on z/OS, and the server detected it was not running on z/OS so it cannot continue. + + **Action:** + + Modify the configuration to use a different keystore type, or migrate the server to z/OS. + + + +### ZWED0146E + + SAF keyring data had no attribute "_attribute_". Attributes=_attributeKeys_ + + **Reason:** + + Within the list of _attributeKeys_, _attribute_ could not be found. + + **Action:** + + Check the keystore configuration of the server such as in `zowe.certificate` or `components.app-server.node.https` to see if it is valid for Zowe. The SAF keyring Zowe was configured to use may be missing a key and certificate pair, or certificate authorities keychain. For more suggestions on configuring keyrings for Zowe, review the [install guide](../../user-guide/certificate-configuration-scenarios#scenario-4-use-a-zos-keyring-based-keystore-and-connect-to-an-existing-certificate) + + + +### ZWED0147E + + SAF keyring data was not found for "_keyName_" + + **Reason:** + + The server tried to read the SAF keyring specified within the Zowe configuration, but ran into an error where the server received no data instead. + + **Action:** + + Review the logs to see if a reason for the error is shown. Verify that the Zowe configuration points to a valid keyring that the Zowe server user has permissions to read. + + + +### ZWED0148E + + Exception thrown when reading SAF keyring, e=_error_ + + **Reason:** + + The SAF keyring which the app-server was configured to use could not be read due to an error. The server likely will not start or will be unable to do any network activity until this error is resolved. + + **Action:** + + Review the error message to determine the cause. Often, the error messages will originate from a system service where the documentation can be found here https://www.ibm.com/docs/en/zos/2.5.0?topic=library-return-reason-codes + + + +### ZWED0149E + + SAF keyring reference missing userId "_user_", keyringName "_name_", or label "_label_" + + **Reason:** + + The server configuration specified that the app-server should load keystore and truststore content from a SAF keyring, but the syntax in the configuration was incorrect, because _user_, _name_, or _label_ were not usable by the server. + + **Action:** + + Check the `zowe.certificate` or `components.app-server.node.https` sections of Zowe configuration to see if there are entries that start with `safkeyring://` and verify that they are in the format of `safkeyring://USERNAME:RINGNAME&LABEL`. Older versions of zowe will require that there be 4 slashes, such as `safkeyring:////`. The `&LABEL` suffix is only needed for specifying certificate authorities and should be omitted in other sections, for example it is only needed within `zowe.certificate.pem.certificateAuthorities` or `components.app-server.node.https.certificateAuthorities`. For more suggestions on configuring keyrings for Zowe, review the [install guide](../../user-guide/certificate-configuration-scenarios#scenario-4-use-a-zos-keyring-based-keystore-and-connect-to-an-existing-certificate) + + + +### ZWED0150E + + Cannot load SAF keyring due to missing keyring_js library + + **Reason:** + + The Zowe configuration specified that the app-server should load keystore and truststore information from a SAF keyring, which requires the nodejs library keyring_js. This library is defined within the package.json of zlux-server-framework and ships with Zowe installs, but could not be loaded for some reason and therefore the server could not load keyrings and will either stop or have issues with network communication. + + **Action:** + + Use the command `zwe support` to verify if the Zowe install has all files expected, as this message indicates the keyring_js library is missing and reinstalling Zowe may be required. + + + +### ZWED0151E + + Env var _variableName_ not found + + **Reason:** + + The server was loading plugins. It determines the location of each plugin via a plugin pointer file. The plugin referenced in the logs, it's location is dynamically determined by an environment variable _variableName_. Because the variable did not resolve to a value, the plugin could not be found and could not be loaded. + + **Action:** + + Review the documentation for the plugin that failed to load, check what the value of the variable should be, and contact support for that plugin if needed. + + + +### ZWED0152E + + Unable to locate server config instance location and INSTANCE_DIR environment variable does not exist. + + **Reason:** + + While installing a plugin, the server could not determine the location of the configuration dataservice's "instance" folder. Due to this, the plugin could not be completely installed. + + **Action:** + + Correct the error before reinstalling the plugin. This error could happen due to an incorrect value for `components.app-server.instanceDir` and normally defaults to `{{ zowe.workspaceDirectory }}/app-server`. + + + +### ZWED0153E + + (_operatingSystemName_) is not a supported platform for _componentName_. Skipping (_pluginid_)... Supported: _requiredOperatingSystem_ + + **Reason:** + + The Zowe host operating system _operatingSystemName_ is not supported by the component _componentName_. Supported platforms are defined in the component's pluginDefinition.json. + + **Action:** + + Refer to _componentName_ pluginDefinition.json for supported platforms. The installation of Zowe may also be moved to a supported platform. Lastly, contact the author of the component, or a system administrator. + + + +### ZWED0154E + + (_architectureName_) is not a supported architecture for _componentName_. Skipping (_pluginid_)... Supported: _requiredArchitecture_ + + **Reason:** + + The Zowe host architecture is not supported by _componentName_. Supported architectures are defined in the component's pluginDefintion.json. + + **Action:** + + Refer to _componentName_ pluginDefinition.json for supported architectures. The installation of Zowe may also be moved to a supported architecture. Lastly, contact the author of the component, or a system administrator. + + + +### ZWED0155E + + (_url_) is not a supported endpoint for _componentName_. Skipping (_pluginid_)... Supported: _urls_ + + **Reason:** + + The endpoint _url_ does not match any required endpoints of _componentName_. Supported endpoints may be viewd in the component's pluginDefinition.json. + + **Action:** + + Refer to _componentName_ pluginDefinition.json for supported endpoints. Optionally, remove _url_ from the required endpoints in pluginDefinition.json. Lastly, contact the author of the component, or a system administrator. + + + +### ZWED0156E + + Could not register default plugins into app-server. + + **Reason:** + + org.zowe.zlux.json is missing from app-server plugin directory. This error will cause the process to exit. + + **Action:** + + Verify integrity of Zowe installation, or contact system administrator. Please refer to https://docs.zowe.org/stable/appendix/zwe_server_command_reference/zwe/support/zwe-support for collecting Zowe runtime information. + + + +### ZWED0157E + + Could not register default plugin _pluginid_ into app-server. + + **Reason:** + + Could not register default plugin _pluginid_ into app-server due to plugin upgrade failure. + + **Action:** + + Verify integrity of plugin files, or contact system administrator. Please refer to https://docs.zowe.org/stable/appendix/zwe_server_command_reference/zwe/support/zwe-support for collecting Zowe runtime information. + + + +### ZWED0158E + + Could not listen on address _ipAddress_:_port_. Insufficient permissions to perform port bind. + + **Reason:** + + Server could not bind to port due to an EACCES error. User lacks privilege to perform port bind. This error will cause the process to exit. + + **Action:** + + Contact system administrator. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/app-framework/zis-error-codes.md b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/zis-error-codes.md new file mode 100644 index 0000000000..0316b54993 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/zis-error-codes.md @@ -0,0 +1,1981 @@ +# ZIS message codes + +The following codes can appear in either the ZIS SYSPRINT or JESMSGLG log, or +both. Use the following message code references and the corresponding reasons +and actions to help troubleshoot issues. + +## ZIS cross-memory server messages + +### ZWES0001I + +ZSS Cross-Memory Server starting, version is _major_._minor_._patch_+_datestamp_ + +**Reason:** + +The cross-memory server with the specified version is starting. + +**Action:** + +No action required. + +### ZWES0002I + +Input parameters at _address_: + +_hex_dump_ + +**Reason:** + +The message shows a hex dump of the parameters passed in the started task JCL. + +**Action:** + +No action required. + +### ZWES0003I + +Server name not provided, default value '_name_' will be used + +**Reason:** + +The user did not provide a server name. + +**Action:** + +The cross-memory server uses the indicated default value _name_. If needed, +specify a server name either via the `NAME` parameter in the JCL or via +the `ZWES.NAME` parameter in the PARMLIB member; the JCL parameter takes +precedence. + +### ZWES0004I + +Server name is '_name_' + +**Reason:** + +The message indicates this server's name. + +**Action:** + +No action required. + +### ZWES0005E + +ZSS Cross-Memory server not created, RSN = _reason_code_ + +**Reason:** + +The cross-memory server failed to create the cross-memory server's data +structure. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0006E + +ZSS Cross-Memory server resource not allocated (_resource_name_) + +**Reason:** + +The cross-memory server failed to allocate storage for a resource. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0007E + +ZSS Cross-Memory server PARMLIB member suffix is incorrect - '_suffix_' + +**Reason:** + +The cross-memory's PARMLIB member suffix is invalid. + +**Action:** + +The cross-memory server terminates. Ensure that the suffix consists +of two characters that are allowed in a member name. + +### ZWES0008E + +ZSS Cross-Memory server configuration not read, member = '_member_name_', RC = +_return_code_1_ (_return_code_2_, _reason_code_2_) + +**Reason:** + +The cross-memory server failed to read the specified PARMLIB member. + +**Action:** + +The cross-memory server terminates. Review the error codes and contact support +if you cannot resolve the issue. + +Possible return codes and the corresponding actions: + +| _return_code_1_ | _return_code_2_ | _reason_code_2_ | Action | +|-----------------------------------------|------------------------------------------------|------------------------------------------------|--------------------------------------------| +| RC_ZISPARM_MEMBER_NOT_FOUND(2) | N/A | N/A | Ensure the member exists | +| RC_ZISPARM_DDNAME_TOO_LONG(8) | N/A | N/A | Contact support | +| RC_ZISPARM_MEMBER_NAME_TOO_LONG(9) | N/A | N/A | Contact support | +| RC_ZISPARM_PARMLIB_ALLOC_FAILED(10) | Return code from `IEFPRMLB REQUEST=ALLOCATE` | Reason code from `IEFPRMLB REQUEST=ALLOCATE` | Review the IEFPMLB return and reason codes | +| RC_ZISPARM_READ_BUFFER_ALLOC_FAILED(11) | N/A | N/A | Contact support | +| RC_ZISPARM_PARMLIB_READ_FAILED(12) | Return code from `IEFPRMLB REQUEST=READMEMBER` | Reason code from `IEFPRMLB REQUEST=READMEMBER` | Review the IEFPMLB return and reason codes | +| RC_ZISPARM_PARMLIB_FREE_FAILED(13) | Return code from `IEFPRMLB REQUEST=FREE` | Reason code from `IEFPRMLB REQUEST=FREE` | Review the IEFPMLB return and reason codes | +| RC_ZISPARM_SLH_ALLOC_FAILED(16) | Start line number | End line number | Contact support | +| RC_ZISPARM_CONTINUATION_TOO_LONG(19) | Start line number | End line number | Review the lines and fix continuation | + +### ZWES0009E + +ZSS Cross-Memory server configuration not found, member = '_member_name_', RC = +_return_code_ + +**Reason:** + +The cross-memory server could not find the specified PARMLIB member. + +**Action:** + +The cross-memory server terminates. Ensure that the name is correct and the +member is available. + +### ZWES0010E + +ZSS Cross-Memory server configuration not loaded, RC = _return_code_, RSN = +_reason_code_ + +**Reason:** + +The cross-memory server failed to load the configuration. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0011E + +ZSS Cross-Memory server not started, RC = _return_code_ + +**Reason:** + +The cross-memory server could not start. + +**Action:** + +The cross-memory server terminates. Review the messages preceding this message. +If you cannot resolve the issue, contact support. + +### ZWES0012I + +ZSS Cross-Memory Server terminated + +**Reason:** + +The cross-memory server fully terminated. + +**Action:** + +No action required. + +### ZWES0013E + +ZSS Cross-Memory Server terminated due to an error, status = _status_code_ + +**Reason:** + +The cross-memory server terminated due to an error. + +**Action:** + +The cross-memory server terminates. Review the messages preceding this message. +If you cannot resolve the issue, contact support. + +### ZWES0014E + +Fatal config error - _details_, RC = _return_code_ + +**Reason:** + +A fatal error occurred during processing of the configuration. + +**Action:** + +The cross-memory server terminates. Review the messages preceding this message. +If you cannot resolve the issue, contact support. + +### ZWES0015E + +LPA _lpa_action_ failed for module _module_name_, RC = _csvdylpa_return_code_, +RSN = _csvdylpa_reason_code_ + +**Reason:** + +The cross-memory server failed to perform the specified link pack area (LPA) +action for a plug-in module. + +**Action:** + +The cross-memory server terminates. Review the provided CSVDYLPA return and +reason codes (see "z/OS MVS Programming: Authorized Assembler Services Reference +ALE-DYN") and contact support if you cannot resolve the issue. + +### ZWES0016I + +Service '_plug-in_name_':'_service_name_' _version_ has been added + +**Reason:** + +The cross-memory server successfully added the specified service. + +**Action:** + +No action required. + +### ZWES0017W + +Plug-in '_plug-in_name_' failure - _details_ + +**Reason:** + +One of the callbacks of a plug-in failed. + +**Action:** + +Depending on the stage, some of the plug-in functionality might be impacted. +Contact support if you cannot resolve the issue. + +### ZWES0018W + +Plug-in '_plug-in_name_' version _plug-in_version_ doesn't match anchor version +_anchor_version_, LPA module discarded + +**Reason:** + +The cross-memory server detected that a plug-in module was outdated; this +usually happens when a plug-in gets updated. + +**Action:** + +The cross-memory server discards the old module and loads the latest version to +the link pack area (LPA). + +### ZWES0019W + +Parameter '_parameter_name_' has an invalid value + +**Reason:** + +The cross-memory server detected an invalid parameter. + +**Action:** + +The cross-memory server uses the default parameter. Fix the reported parameter +and restart the cross-memory server. + +### ZWES0020E + +ZSS Cross-Memory server PARMLIB member name not determined, RC = _return_code_ + +**Reason:** + +The cross-memory server could not determine which PARMLIB member to use. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0021E + +ZSS Cross-Memory server module member name not determined, RC = +_csvquery_return_code_ + +**Reason:** + +The cross-memory server could not determine its module name. + +**Action:** + +The cross-memory server terminates. Review the provided CSVQUERY return code +(see "z/OS MVS Programming: Assembler Services Reference ABE-HSP") and +contact support if you cannot resolve the issue. + +### ZWES0098I + +_debug_message_ + +**Reason:** + +This is a debug message. + +**Action:** + +No action required. + +### ZWES0099I + +_hex_dump_ + +**Reason:** + +This is a debug hex dump. + +**Action:** + +No action required. + +## ZIS Auxiliary Server messages + +### ZWES0050I + +ZIS AUX Server starting, version is _major_._minor_._patch_+_datestamp_ + +**Reason:** + +The cross-memory auxiliary server with the specified version is starting. + +**Action:** + +No action required. + +### ZWES0051I + +ZIS AUX Server terminated + +**Reason:** + +The cross-memory auxiliary server fully terminated. + +**Action:** + +No action required. + +### ZWES0052I + +Input parameters at _address_: + +**Reason:** + +The message shows a dump of the parameters passed to this address space. + +**Action:** + +No action required. + +### ZWES0053E + +Not APF-authorized (_testauth_status_) + +**Reason:** + +One or more data sets in the STEPLIB concatenation is not APF-authorized. + +**Action:** + +The cross-memory auxiliary server terminates. Ensure that all the STEPLIB data +sets are APF-authorized. + +### ZWES0054E + +ZIS AUX Server started in wrong key _key_ + +**Reason:** + +The cross-memory auxiliary server detected that it was running in the wrong key. + +**Action:** + +The cross-memory auxiliary server terminates. Ensure that you have added the +correct PPT-entry +(see [the documentation](../../user-guide/configure-xmem-server.md)) +for the ZIS AUX module. + +### ZWES0055E + +ZIS AUX Server resource not allocated (_resource_name_) + +**Reason:** + +The cross-memory auxiliary server failed to allocate storage for a resource. + +**Action:** + +Depending on the location of the failure some functionality might be affected. +Contact support. + +### ZWES0056E + +RESMGR failed, RC = _return_code_, service RC = _resmgr_return_code_ + +**Reason:** + +The cross-memory auxiliary server failed to install the task resource manager. + +**Action:** + +The cross-memory auxiliary server terminates. Review the RESMGR ADD service +return code value in _resmgr_return_code_ (see "z/OS MVS Programming: Authorized +Assembler Services Reference LLA-SDU"). If you cannot resolve the issue, contact +support. + +### ZWES0057E + +PC not established, RC = _return_code_, RSN = _reason_code_ + +**Reason:** + +The cross-memory auxiliary server failed to set up the communication Program +Call (PC) routine. + +**Action:** + +The cross-memory auxiliary server terminates. Contact support. + +### ZWES0058E + +Communication area failure - _details_ + +**Reason:** + +The cross-memory auxiliary server could not establish the communication area. + +**Action:** + +The cross-memory auxiliary server terminates. Review the details. If you cannot +resolve the issue, contact support. + +### ZWES0059E + +Address space extract RC = _return_code_, RSN = _reason_code_ + +**Reason:** + +The cross-memory auxiliary server could not extract its address space +parameters. + +**Action:** + +Contact support. + +### ZWES0060E + +Fatal config error - _details_, RC = _return_code_ + +**Reason:** + +A fatal error occurred when processing the configuration. + +**Action:** + +The cross-memory auxiliary server terminates. Review the details. If you cannot +resolve the issue, contact support. + +### ZWES0061E + +ZIS AUX Server configuration not read, member = '_member_name_', RC = +_return_code_1_ (_return_code_2_, _reason_code_2_) + +**Reason:** + +The cross-memory auxiliary server failed to read the specified PARMLIB member. + +**Action:** + +The cross-memory auxiliary server terminates. Review the error codes and contact +support if you cannot resolve the issue. + +Possible return codes and the corresponding actions: + +| _return_code_1_ | _return_code_2_ | _reason_code_2_ | Action | +|-----------------------------------------|------------------------------------------------|------------------------------------------------|--------------------------------------------| +| RC_ZISPARM_MEMBER_NOT_FOUND(2) | N/A | N/A | Ensure the member exists | +| RC_ZISPARM_DDNAME_TOO_LONG(8) | N/A | N/A | Contact support | +| RC_ZISPARM_MEMBER_NAME_TOO_LONG(9) | N/A | N/A | Contact support | +| RC_ZISPARM_PARMLIB_ALLOC_FAILED(10) | Return code from `IEFPRMLB REQUEST=ALLOCATE` | Reason code from `IEFPRMLB REQUEST=ALLOCATE` | Review the IEFPMLB return and reason codes | +| RC_ZISPARM_READ_BUFFER_ALLOC_FAILED(11) | N/A | N/A | Contact support | +| RC_ZISPARM_PARMLIB_READ_FAILED(12) | Return code from `IEFPRMLB REQUEST=READMEMBER` | Reason code from `IEFPRMLB REQUEST=READMEMBER` | Review the IEFPMLB return and reason codes | +| RC_ZISPARM_PARMLIB_FREE_FAILED(13) | Return code from `IEFPRMLB REQUEST=FREE` | Reason code from `IEFPRMLB REQUEST=FREE` | Review the IEFPMLB return and reason codes | +| RC_ZISPARM_SLH_ALLOC_FAILED(16) | Start line number | End line number | Contact support | +| RC_ZISPARM_CONTINUATION_TOO_LONG(19) | Start line number | End line number | Review the lines and fix continuation | + +### ZWES0062E + +ZIS AUX Server configuration not found, member = '_member_name_', RC = +_return_code_ + +**Reason:** + +The cross-memory auxiliary server could not find the specified PARMLIB member. + +**Action:** + +The cross-memory auxiliary server terminates. Ensure that the name is correct +and the member is available. + +### ZWES0063E + +User module failure - _details_ + +**Reason:** + +One of the callbacks of the user module failed. + +**Action:** + +Depending on the stage, some of the user module functionality might be impacted. +Contact support if you cannot resolve the issue. + +### ZWES0064W + +Unsafe function _function_name_ failed, ABEND _abend_code_-_reason_code_ +(recovery RC = _recovery_return_code_) + +**Reason:** + +An abend occurred in one of the callbacks of the user module. + +**Action:** + +Depending on the stage, some of the user module functionality might be impacted. +Contact support if you cannot resolve the issue. + +### ZWES0065W + +Caller not released, RC = _return_code_ + +**Reason:** + +A synchronization error occurred when communicating with the parent address +space of this auxiliary address space. + +**Action:** + +Communication between the parent and auxiliary address spaces might be impacted. +Contact support. + +### ZWES0066E + +AUX host server ABEND _abend_code_-_reason_code_ (recovery RC = +_recovery_return_code_) + +**Reason:** + +An abend occurred in one of the components of the cross-memory auxiliary server. + +**Action:** + +The cross-memory auxiliary server terminates. Contact support. + +### ZWES0067E + +Main loop unexpectedly terminated + +**Reason:** + +The cross-memory auxiliary server detected an incorrect state in the main loop. + +**Action:** + +The cross-memory auxiliary server terminates. Contact support. + +### ZWES0068W + +Command too long (_length_) + +**Reason:** + +The provided modify command is too long. + +**Action:** + +The cross-memory auxiliary server ignores the command. + +### ZWES0069W + +Command not tokenized + +**Reason:** + +The cross-memory auxiliary server failed to tokenize the provided modify +command. + +**Action:** + +The cross-memory auxiliary server ignores the command. Review the messages +preceding this message and contact support if you cannot resolve the issue. + +### ZWES0070I + +Modify command '_command_' received + +**Reason:** + +The cross-memory auxiliary server received a modify command. + +**Action:** + +The cross-memory auxiliary server proceeds to handle the command. + +### ZWES0071I + +Termination command received + +**Reason:** + +An operator issued the termination command and the cross-memory auxiliary server +successfully received it. + +**Action:** + +The cross-memory auxiliary server starts the termination sequence. + +### ZWES0072I + +Modify command '_command_' accepted + +**Reason:** + +The cross-memory auxiliary server accepted a modify command. + +**Action:** + +No action required. + +### ZWES0073I + +Modify command '_command_' not recognized + +**Reason:** + +The cross-memory sever did not recognize a modify command. + +**Action:** + +The cross-memory auxiliary server ignores the command. + +### ZWES0074W + +Modify command '_command_' rejected + +**Reason:** + +The cross-memory auxiliary server rejected the provided modify command because +it was either incorrect or the server was not ready to process it. + +**Action:** + +The cross-memory auxiliary server ignores the command. + +### ZWES0075W + +'_command_' expects _expected_arg_number_ args, _provided_arg_number_ provided, +command ignored + +**Reason:** + +The modify command _command_ was used with an incorrect number of arguments. + +**Action:** + +The cross-memory auxiliary server ignores the command. + +### ZWES0076W + +Log component '_component_' not recognized, command ignored + +**Reason:** + +An operator passed an invalid log component in the LOG modify command. + +**Action:** + +The cross-memory auxiliary server ignores the command. + +### ZWES0077W + +Log level '_level_' not recognized, command ignored + +**Reason:** + +An operator passed an invalid log level in the LOG modify command. + +**Action:** + +The cross-memory auxiliary server ignores the command. + +### ZWES0078I + +_response_text_ + +**Reason:** + +This message contains the response of a DISPLAY modify command. + +**Action:** + +No action required. + +### ZWES0079I + +Response message - '_response_text_' + +**Reason:** + +This message contains the response of a modify command. + +**Action:** + +No action required. + +### ZWES0080I + +Termination signal received (_signal_) + +**Reason:** + +The parent address space issued a termination signal and the cross-memory +auxiliary server successfully received it. + +**Action:** + +The cross-memory auxiliary server starts the termination sequence. + +### ZWES0081E + +Bad dub status _bpx4qdb_status_ (_bpx4qdb_return_code_,_bpx4qdb_reason_code_), +verify that the started task user has an OMVS segment + +**Reason:** + +The cross-memory auxiliary server detected an invalid dub status. + +**Action:** + +The cross-memory auxiliary server terminates. Ensure that the user under which +the cross-memory auxiliary server's started task runs has an OMVS segment. + +### ZWES0082W + +Legacy API has been detected, some functionality may be limited + +**Reason:** + +The cross-memory auxiliary server detected a legacy communication area. + +**Action:** + +Some functionality might not be available. Update the parent address space to +use a more modern AUX API version. + +## Core cross-memory server messages + +### ZWES0100I + +_debug_message_ + +**Reason:** + +This is a debug message. + +**Action:** + +No action required. + +### ZWES0101I + +_hex_dump_ + +**Reason:** + +This is a debug hex dump. + +**Action:** + +No action required. + +### ZWES0102E + +Initialization step '_step_name_' failed, RC = _return_code_ + +**Reason:** + +A cross-memory server's initialization step failed. The initialization process +stops. + +**Action:** + +The cross-memory server terminates. Review the messages preceding this message. +If you cannot resolve the issue, contact support. + +### ZWES0103I + +Initialization step '_step_name_' successfully completed + +**Reason:** + +A cross-memory server's initialization step completed successfully. + +**Action:** + +No action required. + +### ZWES0104I + +About to start console task + +**Reason:** + +The cross-memory server is starting the console listener task which handles +operator commands. + +**Action:** + +No action required. + +### ZWES0105I + +Core server initialization started + +**Reason:** + +The cross-memory server is starting initialization. + +**Action:** + +No action required. + +### ZWES0106E + +Core server initialization failed, RC = _return_code_ + +**Reason:** + +The initialization process failed. + +**Action:** + +The cross-memory server terminates. Review the messages preceding this message. +If you cannot resolve the issue, contact support. + +### ZWES0107I + +Cold start initiated + +**Reason:** + +An operator started the server with the cold start option. + +**Action:** + +The cross-memory server discards its global resources and performs a clean +start. + +### ZWES0108W + +Global resources clean up RC = _return_code_ + +**Reason:** + +The global resource clean-up process failed. + +**Action:** + +The cross-memory server continues running. Review _return_code_ and contact +support if needed. + +Possible return codes: + +| _return_code_ | Action | +|------------------------------------|-----------------------------------------------| +| RC_CMS_GLOBAL_AREA_NULL(12) | Ignore if you have not run this ZIS after IPL | +| RC_CMS_ZVT_NULL(47) | Ignore if you have not run any ZIS after IPL | +| RC_CMS_ZVTE_CHAIN_LOOP(66) | Contact support | +| RC_CMS_ZVTE_CHAIN_NOT_LOCKED(67) | Contact support | +| RC_CMS_ZVTE_CHAIN_NOT_RELEASED(68) | Contact support | + +### ZWES0109I + +Core server ready + +**Reason:** + +The cross-memory server initialized and it is ready to accept program calls. + +**Action:** + +No action required. + +### ZWES0110E + +Main loop unexpectedly terminated + +**Reason:** + +The cross-memory server detected an incorrect state in the main loop. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0111I + +Main loop terminated + +**Reason:** + +The main loop of this cross-memory server successfully terminated upon shutdown. + +**Action:** + +No action required. + +### ZWES0112E + +Termination step '_step_name_' failed, RC = _return_code_ + +**Reason:** + +A cross-memory server's termination step failed. + +**Action:** + +The termination process continues. Review the messages preceding this message. +If you cannot resolve the issue, contact support. + +### ZWES0113I + +Termination step '_step_name_' successfully completed + +**Reason:** + +A cross-memory server's termination step completed successfully. + +**Action:** + +No action required. + +### ZWES0114I + +Core server stopped + +**Reason:** + +The cross-memory server successfully stopped. + +**Action:** + +No action required. + +### ZWES0115E + +Core server stopped with an error, status = _status_code_ + +**Reason:** + +The cross-memory server stopped with a non-zero status. + +**Action:** + +Review the messages preceding this message. Contact support if you cannot +resolve the issue. + +### ZWES0116E + +Core server is abnormally terminating + +**Reason:** + +An abend occurred in this cross-memory server. + +**Action:** + +Review any messages and errors preceding this message and contact support if you +cannot resolve the issue. + +### ZWES0117E + +Not APF-authorized (_testauth_status_) + +**Reason:** + +One or more data sets in the STEPLIB concatenation is not APF-authorized. + +**Action:** + +The cross-memory server terminates. Ensure that all the STEPLIB data sets are +APF-authorized. + +### ZWES0118E + +Core server started in wrong key _key_ + +**Reason:** + +The cross-memory server detected that it was running in the wrong key. + +**Action:** + +The cross-memory server terminates. Ensure that you have added the correct +PPT-entry +(see [the documentation](../../user-guide/configure-xmem-server.md)) +for the main ZIS module. + +### ZWES0200I + +_modify_commands_ + +**Reason:** + +This message lists the modify commands supported by this cross-memory server +(not including the plug-ins). + +**Action:** + +No action required. + +### ZWES0201E + +Service ID _service_id_ is out of range + +**Reason:** + +The cross-memory server detected an invalid service ID. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0202E + +A duplicate server is running + +**Reason:** + +A cross-memory server with the same server name is already running. + +**Action:** + +The cross-memory server terminates. Specify a different server name in the +cross-memory server's JCL or the PARMLIB member. + +### ZWES0203E + +Server not locked, ISGENQ RC = _return_code_, RSN = _reason_code_ + +**Reason:** + +An internal synchronization error occurred. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0204E + +Global area address in NULL + +**Reason:** + +The global anchor of this cross-memory server is zero. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0205E + +Relocation failed for _service_id_ (_function_address_ not in +[_module_start_address_, _module_end_address_]) + +**Reason:** + +An error occurred during the relocation of one of the services in the server +module. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0206E + +_parameter_name_ (_parameter_address_) has invalid eyecatcher + +**Reason:** + +The print or dump service received a request with an invalid eyecatcher. + +**Action:** + +The service ignores the request. Correct the parameter list if your application +initiated the request, otherwise contact support. + +### ZWES0207E + +_resource_name_ (_resource_size_) not allocated + +**Reason:** + +The cross-memory server failed to allocate storage for a resource. + +**Action:** + +Depending on the location of the failure some functionality might be affected. +Contact support. + +### ZWES0208E + +Module not loaded into LPA, RC = _csvdylpa_return_code_, RSN = +_csvdylpa_reason_code_ + +**Reason:** + +The cross-memory server failed to add its main module to the link pack area +(LPA). + +**Action:** + +The cross-memory server terminates. Review the provided CSVDYLPA return and +reason codes (see "z/OS MVS Programming: Authorized Assembler Services Reference +ALE-DYN") and contact support if you cannot resolve the issue. + +### ZWES0209E + +Module not deleted from LPA, RC = _csvdylpa_return_code_, RSN = +_csvdylpa_reason_code_ + +**Reason:** + +The cross-memory server failed to delete its main module from the link pack +area (LPA). + +**Action:** + +The cross-memory server terminates with a non-zero status. Review the provided +CSVDYLPA return and reason codes (see "z/OS MVS Programming: Authorized +Assembler Services Reference ALE-DYN") and contact support if you cannot resolve +the issue. + +### ZWES0210W + +No valid LPMEA in global area + +**Reason:** + +The cross-memory server detected an invalid LPMEA area for its main module. + +**Action:** + +The cross-memory server continues running. If the error occurred in the +development mode ignore it, otherwise contact support. + +### ZWES0211E + +Name/Token delete failed, RC = _ieantdl_return_code_ + +**Reason:** + +The cross-memory server failed to delete the cross-memory server's global area's +name/token. + +**Action:** + +The cross-memory server terminates with a non-zero status. Review the provided +IEANTDL return code (see "z/OS MVS Programming: Assembler Services Reference +IAR-XCT") and contact support if you cannot resolve the issue. + +### ZWES0212E + +RACROUTE LIST failed (_saf_return_code_, _racf_return_code_, _racf_reason_code_) + +**Reason:** + +The cross-memory server failed to perform RACROUTE LIST on the FACILITY class. + +**Action:** + +The cross-memory server terminates. The message contains the SAF return code, +RACF return and reason codes (see "z/OS Security Server RACROUTE Macro +Reference"); review the codes. If you cannot resolve the issue, contact support. + +### ZWES0213E + +ZVT not populated, RC = _return_code_ + +**Reason:** + +The cross-memory server failed to populate the Zowe vector table. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0214E + +Global area not set, RC = _return_code_ + +**Reason:** + +The cross-memory server could not set the cross-memory server's global area. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0215E + +Global area not retrieved, RC = _return_code_ + +**Reason:** + +The cross-memory server could not retrieve the cross-memory server's global +area. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0216E + +PC-_type_ not set, step = _step_name_ (_return_code_ _reason_code_) + +**Reason:** + +The cross-memory server failed to set up a Program Call (PC) routine. + +**Action:** + +Contact support. + +### ZWES0217E + +Too many tokens in command + +**Reason:** + +The provided modify command has too many tokens. + +**Action:** + +The cross-memory server ignores the command. + +### ZWES0218E + +Command too long (_command_length_) + +**Reason:** + +The provided modify command is too long. + +**Action:** + +The cross-memory server ignores the command. + +### ZWES0219E + +Command not tokenized + +**Reason:** + +The cross-memory server failed to tokenize the provided modify command. + +**Action:** + +The cross-memory server ignores the command. Review the messages preceding this +message and contact support if you cannot resolve the issue. + +### ZWES0220I + +Modify _command_verb_ command received + +**Reason:** + +The cross-memory server received a modify command with verb _command_verb_. + +**Action:** + +The cross-memory server proceeds to handle the command. + +### ZWES0221I + +Modify _command_verb_ command accepted + +**Reason:** + +The cross-memory server accepted a modify command with verb _command_verb_. + +**Action:** + +No action required. + +### ZWES0222I + +_response_text_ + +**Reason:** + +This message contains the response of a successful modify command. + +**Action:** + +No action required. + +### ZWES0223I + +Termination command received + +**Reason:** + +An operator issued the termination command and the cross-memory server +successfully received it. + +**Action:** + +The cross-memory server starts the termination sequence. + +### ZWES0224W + +_command_verb_ expects _expected_arg_number_ args, _provided_arg_number_ +provided, command ignored + +**Reason:** + +A modify command with verb _command_verb_ was used with an incorrect number of +arguments. + +**Action:** + +The cross-memory server ignores the command. + +### ZWES0225W + +Log component '_component_name_' not recognized, command ignored + +**Reason:** + +An operator passed an invalid log component in the LOG modify command. + +**Action:** + +The cross-memory server ignores the command. + +### ZWES0226W + +Log level '_level_' not recognized, command ignored + +**Reason:** + +An operator passed an invalid log level in the LOG modify command. + +**Action:** + +The cross-memory server ignores the command. + +### ZWES0227W + +Modify _command_verb_ command not recognized + +**Reason:** + +The cross-memory server did not recognize a modify command with verb +_command_verb_. + +**Action:** + +The cross-memory server ignores the command. + +### ZWES0228W + +Empty modify command received, command ignored + +**Reason:** + +The cross-memory server received an empty modify command. + +**Action:** + +The cross-memory server ignores the command. + +### ZWES0229W + +Server not ready for command _command_verb_ + +**Reason:** + +The cross-memory server is being either initialized or terminated and isn't +ready to accept the provided modify command. + +**Action:** + +The cross-memory server ignores the command. Re-issue the command later. + +### ZWES0230W + +Display option '_option_name_' not recognized, command ignored + +**Reason:** + +The cross-memory server did not recognize a DISPLAY modify command. + +**Action:** + +The cross-memory server ignores the command. + +### ZWES0231E + +RESMGR version _resource_manager_version_ not locked, ISGENQ RC = _return_code_, +RSN = _reason_code_ + +**Reason:** + +The cross-memory's address space resource manager serialization failed (lock not +acquired) + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0232E + +RESMGR version _resource_manager_version_ not released, ISGENQ RC = +_return_code_, RSN = _reason_code_ + +**Reason:** + +The cross-memory's address space resource manager serialization failed (lock not +released). + +**Action:** + +The cross-memory server continues running. Contact support. + +### ZWES0233E + +RESMGR ECSA storage not allocated, size = _requested_size_ + +**Reason:** + +The cross-memory server could not obtain common storage for the cross-memory +server's address space resource manager. + +**Action:** + +The cross-memory server terminates. Ensure that there is no shortage of the +extended common service area (ECSA) storage on your system. If you cannot +resolve the issue, contact support. + +### ZWES0234E + +RESMGR NAME/TOKEN not created, RC = _ieantcr_return_code_ + +**Reason:** + +The cross-memory server failed to create the resource manager name/token pair. + +**Action:** + +The cross-memory server terminates. Review the provided IEANTCR return code +(see "z/OS MVS Programming: Assembler Services Reference IAR-XCT") and +contact support if you cannot resolve the issue. + +### ZWES0235E + +RESMGR NAME/TOKEN not retrieved, RC = _ieantrt_return_code_ + +**Reason:** + +The cross-memory server failed to retrieve the resource manager name/token pair. + +**Action:** + +The cross-memory server terminates. Review the provided IEANTRT return and +reason (see "z/OS MVS Programming: Assembler Services Reference IAR-XCT") codes +and contact support if you cannot resolve the issue. + +### ZWES0236E + +RESMGR not added for ASID = _hex_asid_number_, RC = _return_code_, manager RC = +_resmgr_return_code_ + +**Reason:** + +The cross-memory server could not add the resource manager. + +**Action:** + +The cross-memory server terminates. Review the RESMGR ADD service return code +value in _resmgr_return_code_ (see "z/OS MVS Programming: Authorized Assembler +Services Reference LLA-SDU"). If you cannot resolve the issue, contact support. + +### ZWES0237E + +RESMGR not removed for ASID = _hex_asid_number_, RC = _return_code_, manager +RC = _resmgr_return_code_ + +**Reason:** + +The cross-memory server could not delete the resource manager. + +**Action:** + +The cross-memory server terminates with a non-zero status. Review the RESMGR +DELETE service return code in _resmgr_return_code_ (see "z/OS MVS Programming: +Authorized Assembler Services Reference LLA-SDU"). If you cannot resolve the +issue, contact support. + +### ZWES0238E + +_rname_value_ RNAME not created, _failure_reason_ + +**Reason:** + +The cross-memory server failed to create an RNAME. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0239E + +_nametoken_name_ NAME (NT) not created, _failure_reason_ + +**Reason:** + +The cross-memory server failed to create a name-token name. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0240W + +Discarding outdated LPA module at _module_address_ (_current_module_timestamp_ - +_new_module_timestamp_) + +**Reason:** + +The cross-memory server detected that the current link pack area (LPA) module +was outdated; this usually happens when the cross-memory server gets updated. + +**Action:** + +The cross-memory server discards the old module and loads the latest version to +LPA. + +### ZWES0241E + +Service with ID _service_id_ not relocated, _function_address_ not in range +[_module_start_address_, _module_end_address_] + +**Reason:** + +An error occurred during the relocation of a cross-memory service. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0242W + +Modify _command_verb_ command rejected + +**Reason:** + +The cross-memory server rejected the provided modify command because it was +either incorrect or the server was not ready to process it. + +**Action:** + +The cross-memory server ignores the command. + +### ZWES0243W + +Server busy, modify commands are rejected + +**Reason:** + +An operator issued too many commands in a short period and the cross-memory +server was not able to process the provided modify command. + +**Action:** + +The cross-memory server ignores the command. + +### ZWES0244E + +Resource '_resource_name_' not created, RC = _return_code_ + +**Reason:** + +The cross-memory server failed to create an internal resource. + +**Action:** + +Depending on the location either the cross-memory server terminates or some +functionality is impacted. Contact support. + +### ZWES0245E + +ABEND _abend_code_-_reason_code_ averted in step '_step_name_' (recovery RC = +_recovery_return_code_) + +**Reason:** + +An abend occurred in a component of the cross-memory server. + +**Action:** + +Depending on the location either the cross-memory server terminates or some +functionality is impacted. Contact support. + +### ZWES0246E + +Service entry _service_id_ is occupied + +**Reason:** + +The cross-memory server made an attempt to install a cross-memory service in an +already occupied slot. + +**Action:** + +The cross-memory server terminates. Contact support. + +### ZWES0247W + +Development mode is enabled + +**Reason:** + +The user enabled one or more of the development modes. + +**Action:** + +Ensure it was done intentionally, otherwise disable any development mode. + +### ZWES0248W + +Address space is not reusable, start with REUSASID=YES to prevent an ASID +shortage + +**Reason:** + +An operator started the cross-memory server's address space as a non-reusable +address space. + +**Action:** + +Use RESUASID=YES when starting the cross-memory server, otherwise starting it +without that parameter can cause an address space identifier (ASID) shortage. + +### ZWES0249E + +Module _module_name_ is loaded from common storage, ensure _module_name_ is +valid in the STEPLIB + +**Reason:** + +The cross-memory server detected that its module was located in common storage. + +**Action:** + +The cross-memory server terminates. Ensure that the module is in a STEPLIB data +set. + +### ZWES0250E + +Bad dub status _bpx4qdb_status_ (_bpx4qdb_return_code_,_bpx4qdb_reason_code_), +verify that the started task user has an OMVS segment + +**Reason:** + +The cross-memory server detected an invalid dub status. + +**Action:** + +The cross-memory server terminates. Ensure that the user under which the +cross-memory server's started task runs has an OMVS segment. + +### ZWES0251I + +Look-up routine anchor has been created at _address_ + +**Reason:** + +The cross-memory server created a cross-memory server look-up routine anchor. + +**Action:** + +No action required. + +### ZWES0252I + +Look-up routine anchor at _address_ has been reused + +**Reason:** + +The cross-memory server found and reused an existing look-up routine anchor. + +**Action:** + +No action required. + +### ZWES0253I + +Look-up routine anchor at _address_ has been deleted + +**Reason:** + +The cross-memory server deleted a look-up routine anchor. + +**Action:** + +No action required. + +### ZWES0254W + +Look-up routine anchor at _address_ has been discarded due to _reason_: + +**Reason:** + +The cross-memory server discarded a look-up routine anchor. + +**Action:** + +The cross-memory server creates a new anchor. Review the reason and contact +support if the reason is not one of the following: + +* Incompatible version +* Insufficient size +* Outdated look-up routine + +### ZWES0255E + +Look-up routine anchor has not been created + +**Reason:** + +The cross-memory server could not create a look-up routine anchor. + +**Action:** + +The cross-memory server terminates. Ensure there is no shortage of the extended +common service area (ECSA) storage on your system. Contact support if you cannot +resolve the issue. + +### ZWES0256I + +Look-up routine anchor at _address_ has been explicitly discarded + +**Reason:** + +The user forced the cross-memory server to discard the current look-up routine +anchor via a parameter. + +**Action:** + +No action required. + +### ZWES0257W + +Look-up routine anchor discard RC = _return_code_ + +**Reason:** + +The cross-memory server could not discard the current look-up routine anchor. + +**Action:** + +The cross-memory server continues running. Review _return_code_ and contact +support if needed. + +Possible return codes: + +| _return_code_ | Action | +|---------------------|----------------------------------------------| +| RC_CMS_ZVT_NULL(47) | Ignore if you have not run any ZIS after IPL | + +## ZIS Dynamic Linkage Base plug-in messages + +### ZWES0700I + +ZIS Dynamic Base plug-in starting, version _major_._minor_._patch_+_datestamp_, +stub version _stub_version_ + +**Reason:** + +The dynamic linkage base plug-in with the specified plug-in and stub versions is +starting. + +**Action:** + +No action required. + +### ZWES0701I + +ZIS Dynamic Base plug-in successfully started + +**Reason:** + +The dynamic linkage base plug-in successfully started. + +**Action:** + +No action required. + +### ZWES0702E + +ZIS Dynamic Base plug-in startup failed, status = _status_code_ + +**Reason:** + +The dynamic linkage base plug-in failed to start. + +**Action:** + +The dynamic linkage functionality will not be available. Review the messages +preceding this message and contact support if you cannot resolve the issue. + +### ZWES0703E + +ZIS Dynamic Base plug-in init error - _details_ + +**Reason:** + +The dynamic linkage base plug-in failed during initialization. + +**Action:** + +The dynamic linkage functionality will not be available. Review the details and +contact support if you cannot resolve the issue. + +### ZWES0704I + +ZIS Dynamic Base plug-in terminating + +**Reason:** + +The plug-in is terminating. + +**Action:** + +No action required. + +### ZWES0705I + +ZIS Dynamic Base plug-in successfully terminated + +**Reason:** + +The plug-in successfully terminated. + +**Action:** + +No action required. + +### ZWES0706E + +ZIS Dynamic Base plug-in terminated with error + +**Reason:** + +The dynamic linkage base plug-in terminated with errors. + +**Action:** + +Review the details and contact support if you cannot resolve the issue. + +### ZWES0707I + +_response_text_ + +**Reason:** + +This message contains a response from a modify command of the dynamic linkage +base plug-in. + +**Action:** + +No action required. + +### ZWES0708I + +Stub vector has been created at _address_ + +**Reason:** + +The dynamic linkage base plug-in created a new stub vector at the specified +address. + +**Action:** + +No action required. + +### ZWES0710I + +Stub vector at _address_ has been reused + +**Reason:** + +The dynamic linkage base plug-in reused the stub vector at the specified +address. + +**Action:** + +No action required. + +### ZWES0711I + +Stub vector at _address_ has been deleted + +**Reason:** + +The dynamic linkage base plug-in deleted the stub vector at the specified +address. + +**Action:** + +No action required. + +### ZWES0712W + +Stub vector at _address_ is discarded due to _reason_: + +**Reason:** + +The dynamic linkage base plug-in discarded an existing stub vector because it +was invalid. + +**Action:** + +The dynamic linkage base plug-in creates a new vector. Review the reason and +contact support if the reason is not one of the following: + +* Incompatible version +* Insufficient size + +### ZWES0713W + +ZIS Dynamic base plug-in development mode is enabled + +**Reason:** + +The user enabled the development mode. + +**Action:** + +Ensure it was done intentionally, otherwise disable any development mode. + +### ZWES0714E + +Bad cross-memory server version: expected [_min_major_._min_minor_._min_patch_, +_max_major_._max_minor_._max_patch_), found +_current_major_._current_minor_._current_patch_ + +**Reason:** + +The dynamic linkage base plug-in detected that it was running in an unsupported +cross-memory server. + +**Action:** + +The dynamic linkage functionality will not be available. Use a supported version of the cross-memory server. + diff --git a/versioned_docs/version-v2.15.x/troubleshoot/app-framework/zss-error-codes.md b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/zss-error-codes.md new file mode 100644 index 0000000000..4b2d9a382f --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/app-framework/zss-error-codes.md @@ -0,0 +1,741 @@ +# ZSS Error Message Codes + +The following error message codes may appear on ZSS log. Use the following message code references and the corresponding reasons and actions to help troubleshoot issues. + +## ZSS informational messages + +### ZWES1007I + + webContent was not found in plugin definition for '%s' + + **Reason:** + + The `webContent` was not found in plugin definition for ``. + + **Action:** + + No action required. + +### ZWES1008I + + libraryVersion was not found in plugin definition for '%s' + + **Reason:** + + The `libraryVersion` was not found in plugin definition for ``. + + **Action:** + + No action required. + +### ZWES1010I + + Plugin ID and/or location was not found in '%s' + + **Reason:** + + The plugin ID and/or location was not found in ``. + + **Action:** + + No action required. + +### ZWES1013I + + ZSS Server has started. Version '%s' '%s' + + **Reason:** + + ZSS Server has started. Version is `` ``. + + `` is either `31-bit` or `64-bit`. + + **Action:** + + No action required. + +### ZWES1014I + + ZIS status - '%s' (name='%.16s', cmsRC='%d', description='%s', clientVersion='%d') + + **Reason:** + + The message shows status of the connection to Privileged Server: ZIS status - `` (name=``, cmsRC=``, description=``) + + **Action:** + + if Status is `OK` then no action required. If Status is `Failure` see check `` and description. + In the cases listed below check that the ZWESISTC started task is running. If not, start it with the TSO command `/S ZWESISTC`: + - `cmsRC=12`, description=`'Global area address is NULL'` + - `cmsRC=39`, description=`'Cross-memory server abended'` + - `cmsRC=47`, description=`'ZVT is NULL'` + - `cmsRC=64`, description=`'PC is unavailable'` + +### ZWES1035I + + ZSS Server settings: Address='%s', port='%d', protocol='%s' + + **Reason:** + + Server is starting using Address=``, port=``, protocol=`http` or `https` + + **Action:** + + No action required. + +### ZWES1038I + + Server timeouts file '%s' either not found or invalid JSON. ZSS sessions will use the default length of one hour. + + **Reason:** + + The server timeouts file `` either was not found or is invalid JSON. ZSS sessions uses the default length of one hour. + + **Action:** + + No action required. + +### ZWES1039I + + Installing '%s' service... + + **Reason:** + + `` is about to install. + + **Action:** + + No action required. + +### ZWES1061I + + TLS settings: keyring '%s', label '%s', password '%s', stash '%s' + + **Reason:** + + ZSS uses TLS settings: keyring `` or ``, label ``, password `"****"` or `(no password)`, stash `` or `(no stash)`. + + **Action:** + + No action required. + +### ZWES1063I + + Caching Service settings: gateway host '%s', port %d + + **Reason:** + + Caching Service settings are gateway host ``, port ``. HA mode is enabled. + + **Action:** + + No action required. + +### ZWES1064I + + Caching Service not configured + + **Reason:** + + Caching Service not configured. HA mode is disabled. + + **Action:** + + No action required. + +### ZWES1100I + + Product Registration is enabled. + + **Reason:** + + Product Registration is enabled. + + **Action:** + + No action required. + +### ZWES1101I + + Product Registration is disabled. + + **Reason:** + + Product Registration is disabled. + + **Action:** + + No action required. + +### ZWES1102I + + Product Registration successful. + + **Reason:** + + Product Registration successful. + + **Action:** + + No action required. + +### ZWES1600I + + JWT will be configured using JWK URL '%s' + + **Reason:** + + JWT will be configured using JSON Web Key(JWK) at URL ``. + + **Action:** + + No action required. + +### ZWES1601I + + Server is ready to accept JWT `with`(or `without`) fallback to legacy tokens + + **Reason:** + + Server is ready to accept JWT `with` or `without` fallback to legacy tokens. + + **Action:** + + No action required. + +## ZSS error messages + +### ZWES1001E + + Log level '%d' is incorrect. + + **Reason:** + + The logging level `` is incorrect. + + **Action:** + + Verify the `` is in range `0..5`. + +### ZWES1002E + + Error in timeouts file: Could not parse config file as a JSON object. + + **Reason:** + + There is an error in timeouts file: could not parse config file as a JSON object. + + **Action:** + + Verify the timeouts file is a valid JSON. + +### ZWES1006E + + Error while parsing plugin definition file '%s': '%s'. + + **Reason:** + + An error occurred while parsing ``: ``. + + **Action:** + + If you are a plugin developer check `` and fix the error by editing ``, otherwise, report the error to the plugin vendor. + +### ZWES1011E + + Error while parsing: '%s' + + **Reason:** + + There is an error while parsing: ``. + + **Action:** + + Review the `` and correct it. + +### ZWES1016E + + Cannot validate file permission, path is not defined. + + **Reason:** + + Cannot validate the file permission, path is not defined. + +### ZWES1017E + + Could not get file info on config path='%s': Ret='%d', res='%d' + + **Reason:** + + Could not get the file information on config path=``: Ret=``, res=`` + + **Action:** + + Contact support. + +### ZWES1020E + + Skipping validation of file permissions: Disabled during compilation, using file '%s'. + + **Reason:** + + Skipping validation of file permissions: disabled during compilation, using the file ``. + + **Action:** + + Contact support. + +### ZWES1021E + + Cannot validate file permissions: Path is not defined. + + **Reason:** + + Cannot validate the file permissions: path is not defined. + +### ZWES1022E + + Cannot validate file permissions: Path is for a directory and not a file. + + **Reason:** + + Cannot validate the file permissions. Given path is a directory path only without a file. + +### ZWES1034E + + Server startup problem: Address '%s' not valid. + + **Reason:** + + IP address nor hostname is not valid. + + **Action:** + + Use valid IP address or hostname, e.g. `0.0.0.0`. + +### ZWES1036E + + Server startup problem: Ret='%d', res='0x%x' + + **Reason:** + + Server has failed to start. + + **Action:** + + If the next message is `ZWES1037E` then refer [ZWES1037E](###ZWES1037E). Otherwise, examine the reason code with [`bpxmtext`](https://www.ibm.com/docs/en/zos/2.4.0?topic=descriptions-bpxmtext-display-reason-code-text) command, e.g. use `bpxmtext 744c7247` if you got `res='0x744c7247'` + +### ZWES1037E + + This is usually because the server port '%d' is occupied. Is ZSS running twice? + + **Reason:** + + ZSS port number is already occupied. + + **Action:** + + Check if another ZSS instance is already running, or chose another free port number and restart Zowe. + +### ZWES1065E + + Failed to configure https server, check agent https settings + + **Reason:** + + Failed to configure https server. + + **Action:** + + Check agent https settings. + +### ZWES1500E + + Failed to generate PassTicket - userId='%s', applId='%s', %s + + **Reason:** + + Failed to generate the PassTicket for userId=``, applId=``, ``. + + **Action:** + + Review your security product to determine that it meets all passTickets requirements. + +## ZSS warning messages + +### ZWES1000W + + Privileged server name not provided, falling back to default. + + **Reason:** + + Privileged server name not defined in configuration file. + + **Action:** + + If your privileged server name is `ZWESIS_STD` then no action required. Otherwise set `components.zss.crossMemoryServerName` property in configuration to the correct name. + +### ZWES1004W + + Expected plugin ID '%s', instead received '%s' + + **Reason:** + + Expected plugin ID is ``, but it was received ``. + + **Action:** + + Verify the plugin JSON definition. + +### ZWES1005W + + Plugin ID was not found in '%s' + + **Reason:** + + `pluginId` property wasn't found in `` file. The plugin skipped. + + **Action:** + + If you are a plugin developer add the `pluginId` property to the `` file. Otherwise, contact the plugin vendor. + +### ZWES1009W + + Plugin ID '%s' is NULL and cannot be loaded. + + **Reason:** + + The plugin with `` was not succesfully created and cannot be loaded. + + **Action:** + + Verify the plugin JSON definition. + +### ZWES1012W + + Could not open pluginsDir '%s': Ret='%d', res='0x%x' + + **Reason:** + + Could not open ``: Ret=``, res=`` + + **Action:** + + Check that `` exists and allows reading. Examine the reason code with [`bpxmtext`](https://www.ibm.com/docs/en/zos/2.4.0?topic=descriptions-bpxmtext-display-reason-code-text) command for additional information. + +### ZWES1060W + + Failed to init TLS environment, rc=%d(%s) + + **Reason:** + + Failed to initialized TLS environment GSKit return code ``(``) + + **Action:** + + Ensure that the ZSS certificate is configured correctly. Check GSKit return code and description for additional information. + +### ZWES1103W + + Product Registration failed, RC = %d + + **Reason:** + + Failed to register ZSS. + + **Action:** + + Examine the return code at [https://www.ibm.com/docs/en/zos/2.2.0?topic=requeststatus-return-codes] and correct the error. + +### ZWES1200W + + Could not %s file '%s': Ret='%d', res='%d' + + **Reason:** + + Could not `` file ``, return code is ``, resason code is ``. + + `` specifies for which file operation a problem was detected. + + **Action:** + + No action required. + +### ZWES1201W + + Could not %s file '%s': Ret='%d', res='%d' + + **Reason:** + + Unixfile REST Service could not `` file ``: Ret=``, res=`` + + **Action:** + + Action depends on return/reason code. For additional information examine the reason code with the [`bpxmtext`](https://www.ibm.com/docs/en/zos/2.4.0?topic=descriptions-bpxmtext-display-reason-code-text) command. + +### ZWES1202W + + Transfer type has not been set. + + **Reason:** + + The transfer type was not set. + + **Action:** + + No action required. + +### ZWES1103W + + Could not get metadata for file '%s': Ret='%d', res='%d' + + **Reason:** + + Unixfile REST Service could not get metadata for file ``: Ret=``, res=`` + + **Action:** + + Action depends on return/reason code. For additional information examine the reason code with [`bpxmtext`](https://www.ibm.com/docs/en/zos/2.4.0?topic=descriptions-bpxmtext-display-reason-code-text) command. + +### ZWES1200W + + Could not %s file '%s': Ret='%d', res='%d' + + **Reason:** + + Could not `` file ``, return code is ``, resason code is ``. + + `` specifies for which file operation a problem was detected. + + **Action:** + + No action required. + +### ZWES1202W + + Transfer type has not been set. + + **Reason:** + + The transfer type was not set. + + **Action:** + + No action required. + +### ZWES1400W + + Non standard class provided for '%s' '%s', ending request... + + **Reason:** + + Non standard class was provided for `` ``, the request was ended. + +### ZWES1401W + + Profile not provided for profiles GET, ending request... + + **Reason:** + + The profile not provided for profiles GET, the request was ended. + +### ZWES1402W + + Profile name required for '%s' '%s' + + **Reason:** + + The profile name is required for `` `` + +### ZWES1403W + + User ID required for user POST/PUT + + **Reason:** + + The user ID is required for user POST or PUT. + +### ZWES1404W + + Body not provided for user POST/PUT, ending request... + + **Reason:** + + The body was not provided for user POST or PUT, the request was ended. + +### ZWES1406W + + Unknown access type '%d' provided for user POST/PUT, ending request... + + **Reason:** + + Unknown access type `` provided for user POST or PUT, the request was ended. + +### ZWES1407W + + Access list can only be retrieved in bulk, ending request... + + **Reason:** + + The access list can only be retrieved in bulk, the request was ended. + +### ZWES1408W + + Access list buffer with size '%u' not allocated, ending request... + + **Reason:** + + The access list buffer with size `` was not allocated, the request was ended. + +### ZWES1409W + + Access list size out of range '%u', ending request... + + **Reason:** + + The size of access list is out of range ``, the request was ended. + +### ZWES1410W + + Access list entry name required for access list DELETE + + **Reason:** + + The access list entry name is required for access list `DELETE`. + +### ZWES1411W + + Class-mgmt query string is invalid, ending request... + + **Reason:** + + `Class-mgmt`` query string is invalid, the request was ended. + +### ZWES1412W + + Group name required for '%s' '%s' + + **Reason:** + + The group name required for `` ``. + +### ZWES1413W + + Body not provided for group POST, ending request... + + **Reason:** + + The body was not provided for group `POST`, the request was ended. + + +### ZWES1414W + + Superior not provided for group POST, ending request... + + **Reason:** + + Superior not provided for group `POST`, the request was ended. + +### ZWES1415W + + Bad superior group provided for group POST, ending request... + + **Reason:** + + Bad superior group was provided for group `POST`, the request was ended. + +### ZWES1416W + + Access type not provided for user POST/PUT, ending request... + + **Reason:** + + The access type was not provided for user `POST` or `PUT`, the request was ended. + +### ZWES1417W + + Unknown access type, use [USE, CREATE, CONNECT, JOIN] + + **Reason:** + + Unknown access type, use `USE`, `CREATE`, `CONNECT` or `JOIN`. + +### ZWES1418W + + Access list will be re-allocated with capacity '%u' + + **Reason:** + + The access list will be re-allocated with capacity ``. + + **Action:** + + No action required. + +### ZWES1419W + + Group-mgmt query string is invalid, ending request... + + **Reason:** + + `` query string is invalid and the requested was ended. + +### ZWES1602W + + JWK is in unrecognized format + + **Reason:** + + JSON Web Key(JWK) is in unrecognized format. + + **Action:** + + Report an issue at [https://github.com/zowe/zlux/issues] + +### ZWES1603W + + Failed to construct public key using JWK + + **Reason:** + + JSON Web Key(JWK) has invalid public key info. + + **Action:** + + Report an issue at [https://github.com/zowe/zlux/issues] + +### ZWES1604W + + JWK: failed to init HTTP context, ensure that APIML and TLS settings are correct + + **Reason:** + + Failed to init HTTP context for requesting JSON Web Key(JWK). + + **Action:** + + Check the zowe keystore configuration and specification of it within the zowe server config. + +### ZWES1605W + + Server will not accept JWT + + **Reason:** + + ZSS Server will not accept JWT. + + **Action:** + + No action required. + +### ZWES1606W + + Failed to get JWK - %s, retry in %d seconds + + **Reason:** + + Failed to get JWK - ``, retry in `` seconds. ZSS Server was unable to get JSON Web Key(JWK), it will try to repeat the attempt in `` seconds. + + **Action:** + + No action required. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/cli/cli-issue.md b/versioned_docs/version-v2.15.x/troubleshoot/cli/cli-issue.md new file mode 100644 index 0000000000..557988016e --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/cli/cli-issue.md @@ -0,0 +1,11 @@ +# Raising a CLI issue on GitHub + +When necessary, you can raise GitHub issues against the Zowe™ CLI repository [here](https://github.com/zowe/zowe-cli/issues). It is suggested that you use either the bug or enhancement template. + +## Raising a bug report + +Please provide as much of the information listed on [Troubleshooting CLI](troubleshoot-cli.md) as is reasonable. Anyone working on the issue might need to request this and other information if it is not supplied initially. A description of the error and how it can be reproduced is the most important information. + +## Raising an enhancement report + +Enhancement reports are just as important to the Zowe project as bug reports. Enhancement reports should be clear and detailed requirements for a potential enhancement. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/troubleshoot/cli/cli-use-curl-to-troubleshoot.md b/versioned_docs/version-v2.15.x/troubleshoot/cli/cli-use-curl-to-troubleshoot.md new file mode 100644 index 0000000000..8fdf6175a7 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/cli/cli-use-curl-to-troubleshoot.md @@ -0,0 +1,186 @@ +# Using cURL to troubleshoot Zowe CLI + +When a REST API call fails on Zowe CLI, you can use cURL to troubleshoot. + +Run a command with cURL and compare its output with what is returned using Zowe CLI. This can help pinpoint whether the problem lies with z/OSMF or Zowe CLI, depending on which command returns an API error. + +## Installing cURL + +cURL is installed by default on Windows 10 V1803 and later, macOS, and most Linux distributions. + +If the cURL command is missing from your system, you can download it from the cURL [Releases and Downloads](https://curl.se/download.html) page. + +## Understanding cURL commands + +A cURL command using the `https` protocol follows the basic syntax `curl `. + +Add cURL options to establish communication between Zowe CLI and z/OSMF, as in the following example command: + +``` +curl --location --request "https://:/" --header "X-CSRF-ZOSMF-HEADER;" --insecure --user ":" +``` +**NOTE:** Some terminals may require single quotes rather than double quotes. + + +### `--location` + +Use `--location` to allow the server to redirect to a different URL, if needed. + +When the server attempts to redirect and `--location` is not included in the command, the server responds with a 3XX status code. + +### `--request ` + +Use `--request` to identify the API method (such as `POST`, `GET`, `PUT`, `DELETE`). Not necessary when the API method is `GET`. + +- ``: Specifies the API method used in the request. + +### `"https://:/"` + +Indicates the protocol and URL. + +- ``: Specifies the host name where the z/OSMF services are running. +- ``: Specifies the REST port number. If not specified, defaults to 443 for HTTPS. +- ``: Specifies the API endpoint used in the request. + +### `--header "X-CSRF-ZOSMF-HEADER;"` + +Required to establish communication with z/OSMF. Specifies that the client is sending a cross-site request to the REST interface. + +- `;`: Indicates that the header has no value. (Not all commands require a value.) + + To pass an additional header with a value, use a colon to separate the key and value. For example: `--header "X-IBM-Data-Type: binary"`. + +### `--insecure` + +Use `--insecure` with a trusted server that does not require verification before a data transfer. + +For example, this bypasses SSL certificate verification for servers with self-signed certificates. + +### `--user ":"` + +Required and displays as plain text. Also possible to [use an environment variable](../../user-guide/cli-using-using-environment-variables.md). + +- ``: Specifies the z/OSMF user identification. +- ``: Specifies the user password for z/OSMF. + +**NOTE:** To be prompted for a password instead of displaying it in plain text, omit the password from the command and enter `--user ""`. + +## Comparing commands + +To troubleshoot, run a Zowe API request with Zowe CLI and cURL commands, then compare responses. + +When both responses include the same error, that may indicate there could be a problem with z/OSMF. + +If an API call fails with the Zowe CLI command but not cURL, this can mean the problem lies with Zowe CLI. + +The following APIs illustrate some common examples of comparing commands that you can use to troubleshoot with cURL. + +### **z/OSMF Info API** + +The [`z/OSMF Info`](https://www.ibm.com/docs/en/zos/2.5.0?topic=service-retrieve-zosmf-information) API uses a `GET` request to obtain basic information from z/OSMF, such as the version, available services, and other details. + +#### Submitting the cURL command: + +Run the following example command using your information: + +``` +curl --location --request GET "https://lpar.hostname.net:443/zosmf/info" --header "X-CSRF-ZOSMF-HEADER;" --insecure --user "ibmuser:password" +``` +A successful cURL response follows the format below: +``` +{"zos_version":"04.28.00","zosmf_port":"443","zosmf_version":"28","zosmf_hostname":"lpar.hostname.net","plugins":{"msgId":"IZUG612E","msgText":"IZUG612E"},"zosmf_saf_realm":"SAFRealm","zosmf_full_version":"28.0","api_version":"1"} +``` + +#### Submitting the Zowe CLI command: + +Run the following example command using your information: + +``` +zowe zosmf check status --host lpar.hostname.net --port 443 --user ibmuser --password password --reject-unauthorized false +``` + +A successful Zowe CLI response follows the format below: + +``` +The user ibmuser successfully connected to z/OSMF on 'lpar.hostname.net'. +zosmf_port: 443 +zosmf_saf_realm: SAFRealm +zos_version: 04.28.00 +zosmf_full_version: 28.0 +api_version: 1 + +z/OSMF Plug-ins that are installed on 'lpar.hostname.net': +msgId: IZUG612E +msgText: IZUG612E +``` + +### **z/OSMF Files API** + +The [`z/OSMF Files`](https://www.ibm.com/docs/en/zos/2.5.0?topic=interface-write-data-zos-data-set-member) API uses a `PUT` request to upload a file to a data set via z/OSMF. + +#### Submitting the cURL command: + +Run the following example command using your information: + +``` +curl --location --request PUT "https://lpar.hostname.net:443/zosmf/restfiles/ds/IBMUSER.TEST.PDS(HELLO)" --header "X-CSRF-ZOSMF-HEADER;" --header "X-IBM-Data-Type: binary" --insecure --user "ibmuser:password" --data @hello.txt +``` +A successful cURL response is empty without any error messages. + +#### Submitting the Zowe CLI command: + +Run the following example command using your information: + +``` +zowe zos-files upload file-to-data-set hello.txt "IBMUSER.TEST.PDS(HELLO)" --binary --host lpar.hostname.net --port 443 --user ibmuser --password password --reject-unauthorized false +``` + +A successful Zowe CLI response follows the format below: + +``` +success: true +from: C:\Users\User\Desktop\hello.txt +to: IBMUSER.TEST.PDS(HELLO) + + +file_to_upload: 1 +success: 1 +error: 0 +skipped: 0 + + +Data set uploaded successfully. +``` + +### **z/OSMF Jobs API** + +The [`z/OSMF Jobs`](https://www.ibm.com/docs/en/zos/2.5.0?topic=interface-submit-job) API uses a `PUT` request to submit a job from a data set via z/OSMF. + +#### Submitting the cURL command: + +Run the following example command using your information: + +``` +curl --location --request PUT "https://lpar.hostname.net:443/zosmf/restjobs/jobs" --header "X-CSRF-ZOSMF-HEADER;" --insecure --user "ibmuser:password" --header "Content-Type: application/json" --data '{"file": "//''IBMUSER.TEST.IEFBR14''"}' +``` +A successful cURL response folllows the format below: +``` +{"owner":"IBMUSER","phase":14,"subsystem":"JES2","phase-name":"Job is actively executing","job-correlator":"J000...","type":"JOB","url":"https:\/\/lpar.hostname.net:443\/zosmf\/restjobs\/jobs\/J000...%3A","jobid":"JOB12345","class":"A","files-url":"https:\/\/lpar.hostname.net:443\/zosmf\/restjobs\/jobs\/J000...%3A\/files","jobname":"IEFBR14","status":"ACTIVE","retcode":null} +``` + +#### Submitting the Zowe CLI command: + +Run the following example command using your information: + +``` +zowe zos-jobs submit data-set "IBMUSER.TEST.IEFBR14" --host lpar.hostname.net --port 443 --user ibmuser --password password --reject-unauthorized false +``` + +A successful Zowe CLI response follows the format below: + +``` +jobid: JOB12345 +retcode: null +jobname: IEFBR14 +status: INPUT +``` diff --git a/versioned_docs/version-v2.15.x/troubleshoot/cli/known-cli.md b/versioned_docs/version-v2.15.x/troubleshoot/cli/known-cli.md new file mode 100644 index 0000000000..bd913e1565 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/cli/known-cli.md @@ -0,0 +1,216 @@ +# Known Zowe CLI issues + +The following topics contain information that can help you troubleshoot problems when you encounter unexpected behavior installing and using Zowe™ CLI. + +## Zowe commands fail with secure credential errors + +**Valid on Windows, macOS, and Linux** + +**Symptoms:** + +After you install Zowe CLI, and the installation appears to complete successfully, Zowe commands that load the secure credential store return error messages. For example, the following commands return error messages: + +- `zowe config init` +- `zowe config secure` +- `zowe profiles create` +- Most Zowe commands that access your mainframe environment + +This behavior occurs under the following conditions: + +- npm version 8.11.0 or 8.12.0 is running on your computer. +- The computer on which you installed Zowe CLI cannot access the Internet or it has limited access to the Internet. Your site does not allow connections to https://github.com/. +- You installed Zowe CLI from a local package or from an NPM public online registry + +**Solution:** + +1. Define the `npm_config_global` environment variable. Issue the command that corresponds with your operating system: + + - **Windows Command Prompt:** `set npm_config_global=true` + - **Windows PowerShell:** `$env:npm_config_global="true"` + - **macOS/Linux Bash:** `export npm_config_global=true` +2. Install or reinstall Zowe CLI using your preferred installation method. +3. After the Zowe CLI installation completes, reset the `npm_config_global` environment variable. Issue the command that corresponds with your operating system: + - **Windows Command Prompt:** `set npm_config_global=` + - **Windows PowerShell:** `$env:npm_config_global=""` + - **macOS/Linux Bash:** `export npm_config_global=` +4. Continue configuring Zowe CLI. Or, reissue a Zowe command that returned an error message. You should no longer get an error message. + +## Chain commands fail in a batch script + +**Valid on Windows** + +**Symptom:** When invoking Zowe CLI in a batch script (`.bat` or `.cmd` file), subsequent commands in the script do not run. + +**Solution:** + +To prevent the Zowe executable from taking control and stopping the execution of the script it is called from, add `call` in front of each Zowe CLI command. + +In the example below, the script never prints "hello" to the terminal: + +``` +zowe --version +echo hello +``` +To fix this, add `call` before the Zowe CLI command. + +``` +call zowe --version +echo hello +``` +For multiple Zowe CLI commands, see the following example: + +``` +call zowe --version +echo hello +call zowe --version +echo goodbye +``` + +## *Command not found* message displays when issuing `npm install` commands + +**Valid on all supported platforms** + +**Symptom:** + +When you issue NPM commands to install the CLI, the message *command not found* displays. The message indicates that Node.js and NPM are not installed on your computer, or that PATH does not contain the correct path to the NodeJS folder. + +**Solution:** + +To correct this behavior, verify the following: + +- Node.js and NPM are installed. +- PATH contains the correct path to the NodeJS folder. + +**More Information:** [System requirements for Zowe CLI](../../user-guide/systemrequirements-cli.md) + +## EACCESS error when issing `npm install` command + +**Valid on Windows, Mac, or Linux** + +**Symptom:** + +An `EACCESS` error is returned when you issue the `npm install -g` command to install a package from Zowe.org or npm. + +**Solution:** + +To resolve the issue, follow the steps described in [Resolving EACCESS permissions errors when installing packages globally](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally) in the npm documentation. + +## Installation fails on Oracle Linux 6 + +**Valid on Oracle Linux 6** + +**Symptom:** + +You receive error messages when you attempt to install the product on an +Oracle Linux 6 operating system. + +**Solution:** + +Install the product on Oracle Linux 7 or another Linux or Windows OS. Zowe CLI is not compatible with Oracle Linux 6. + +## Node.js commands do not respond as expected + +**Valid on Windows or Linux** + +**Symptom:** + +You attempt to issue node.js commands and you do not receive the expected output. + +**Solution:** + +There might be a program that is named *node* on your path. The Node.js installer automatically adds a program that is named *node* to your path. When there are pre-existing programs that are named *node* on your computer, the program that appears first in the path is used. To correct this behavior, change the order of the programs in the path so that Node.js appears first. + +## `npm install -g` command fails due to an EPERM error + +**Valid on Windows** + +**Symptom:** + +This behavior is due to a problem with Node Package Manager (npm). There +is an open issue on the npm GitHub repository to fix the defect. + +**Solution:** + +If you encounter this problem, some users report that repeatedly +attempting to install Zowe CLI yields success. Some users also +report success using the following workarounds: + + - Issue the `npm cache clean` command. + + - Uninstall and reinstall Zowe CLI. For more information, + see [Install Zowe CLI](../../user-guide/cli-installcli.md). + + - `Add the --no-optional` flag to the end of the `npm install` command. + +## `npm install -g` command fails due to `npm ERR! Cannot read property 'pause' of undefined` error + +**Valid on Windows or Linux** + +**Symptom:** + +You receive the error message `npm ERR! Cannot read property 'pause' of undefined` when you attempt to install the product. + +**Solution:** + +This behavior is due to a problem with Node Package Manager (npm). If +you encounter this problem, revert to a previous version of npm that +does not contain this defect. To revert to a previous version of npm, +issue the following command: +``` +npm install npm@5.3.0 -g +``` + +## Paths converting in Git Bash + +**Valid on Windows** + +**Symptom:** + +When issuing a command with an absolute directory path that begins with a forward slash, Git Bash converts it into an invalid path that does not exist. + +If a command includes a path similar to the following example: + + ``` + /a/ibmuser/my_dir + ``` + Git Bash can erroneously convert the root directory to a drive letter, as in the example below: + + ``` + A:/ibmuser/my_dir + ``` + **Note:** Depending on the root directory, the Git Bash conversion can add other directories it assumes to be included in the path. + +**Solutions:** + +- Replace the single slash in front of a path with double slashes (//). This stops Git Bash from remapping the path. + + To avoid conversion in the example above, edit the path in the following manner: + ``` + //a/ibmuser/my_dir + ``` + +- Set the environment variable `MSYS_NO_PATHCONV` to `1` in one of the following ways: + - Use the export command. + + While running commands in a terminal, run the export command once during that terminal session. If writing a script, run the command once at the top of the script. + + The export command is included in the following example: + ``` + export MSYS_NO_PATHCONV=1 + zowe zos-files upload dir-to-uss local_dir /a/ibmuser/my_dir + ``` + - Set the environment variable in your `~/.bashrc` file to define it permanently. + +The better option depends on particular circumstances. Using double forward slashes is a good choice when defining system-wide environment variables could cause problems with other applications. On the other hand, the environment variable helps avoid rewriting paths on every CLI command that uses them. + +## `Sudo` syntax required to complete some installations + +**Valid on Linux and macOS** + +**Symptom:** + +The installation fails on Linux or macOS. + +**Solution:** + +Depending on how you configured Node.js on Linux or macOS, you might need to add the prefix `sudo` before the `npm install -g` command or the `npm uninstall -g` command. This step gives Node.js write access to the installation directory. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/cli/mustgather-cli.md b/versioned_docs/version-v2.15.x/troubleshoot/cli/mustgather-cli.md new file mode 100644 index 0000000000..64bb039a42 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/cli/mustgather-cli.md @@ -0,0 +1,70 @@ +# Gathering information to troubleshoot Zowe CLI + +An important step in troubleshooting is confirming that your local environment is set up correctly. There are several Zowe CLI commands you can use to view the conditions for the following system settings: + +- Configurations +- Supported components +- Command property values + +These commands offer differing levels of information for analysis. Review this list to understand the outputs they provide and how to apply them for troubleshooting. + +## Generating a working environment report + +Issue the following command: + +``` +zowe config report-env +``` + +The output provides a granular view of key areas in the working environment on your terminal, including the following settings: + +- Node.js version, operating system path, environment variables + +- NPM information +- Zowe CLI version, profile names +- Installed plug-ins and their versions + +This detailed report helps provide insights as you troubleshoot. If it finds a problem with a setting, the report displays a warning message. + +![Warning Message](../../images/troubleshoot/cli/zowe_config_report_env_warn_message.jpg) + +Alternatively, the output can be saved as a text file that can be attached to an issue submitted to the [Zowe CLI issues list](https://github.com/zowe/zowe-cli/issues). Before filing an issue, confirm that it has not already been submitted. + +## Finding configuration file properties and locations + +Issue the following command: + +``` +zowe config list --locations +``` +The output provides a brief overview with the following information: + +- Configuration file locations + +- Profile names and types +- Profile type defaults +- All property values (host, port, etc.) + +This overview outlines configuration property values and where they are specified. + +## Finding configuration file locations + +Issue the following command: + +``` +zowe config list --locations --root +``` + +The output provides a list of configuration files that affect your Zowe commands in the directory from which this command is issued. + +## Finding property values used by a Zowe command + +Add the `--show-inputs-only` option to any Zowe command. + +For example, if you want to check the command to list a data set, you add the option to the following command: + +``` +zowe zos-files list data-set "SYS1.PARMLIB*" --show-inputs-only +``` + +The output provides the property values that are used by the specified command, which can help the user identify properties that might be incorrect. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/cli/troubleshoot-cli-credentials.md b/versioned_docs/version-v2.15.x/troubleshoot/cli/troubleshoot-cli-credentials.md new file mode 100644 index 0000000000..76e45c09e9 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/cli/troubleshoot-cli-credentials.md @@ -0,0 +1,62 @@ +--- +keywords: [troubleshooting pem certificates] +--- + +# Troubleshooting Zowe CLI credentials + +## Secure credentials + +### Authentication mechanisms + +You can troubleshoot a failed log-in to a mainframe service by reviewing the authentication mechanisms used by Zowe CLI. + +Zowe CLI accepts various methods, or mechanisms, of authentication when communicating with the mainframe, and the method that the CLI ultimately follows is based on the service it is communicating with. + +However, some services can accept multiple methods of authentication. When multiple methods are provided (in a profile or command) for a service, the CLI follows an *order of precedence* to determine which method to apply. + +To find the authentication methods used for different services and their order of precedence, see the table in [Authentication mechanisms](../../extend/extend-cli/cli-devTutorials.md#authentication-mechanisms). + +### PEM certificate files + +PEM certificate files are used by Zowe CLI to authenticate to the API Mediation Layer. To be accepted, these certificate files must first be recorded in the service's keyring/trust-store on the mainframe before they are used by Zowe CLI. + +Some users choose to secure PEM certificates by placing them in a password protected container, such as a PGP file, a ZIP file, or a password protected PKCS12 file (a.k.a. a PFX file). However, Zowe CLI does not currently support any certificate files that require a password for use. + +:::note + +These client certificate files are different from the certificates generated or imported during Zowe server configuration. For more information, see [Using Certificates](https://docs.zowe.org/stable/user-guide/use-certificates/). + +::: + +To log into the API Mediation Layer with a PEM certificate file, refer to this workaround. + +**Symptom:** + +When using a password protected certificate to log in to API ML, an error message displays. + +**Sample message:** + +``` +Unexpected Command Error: +Please review the message and stack below. +Contact the creator of handler: +"PATH-TO-INSTALLED-NPM\bin\npm\node_modules\@zowe\cli\lib/auth/ApimlAuthHandler" +Message: +error:1E08010C:DECODER routines::unsupported +Stack: +Error: error:1E08010C:DECODER routines::unsupported + at setKey (node:internal/tls/secure-context:92:11) + at configSecureContext (node:internal/tls/secure-context:174:7) + at Object.createSecureContext (node:_tls_common:117:3) + at Object.connect (node:_tls_wrap:1629:48) + at Agent.createConnection (node:https:150:22) + at Agent.createSocket (node:_http_agent:350:26) + at Agent.addRequest (node:_http_agent:297:10) + at new ClientRequest (node:_http_client:335:16) + at Object.request (node:https:360:10) + at PATH-TO-INSTALLED-NPM\bin\npm\node_modules\@zowe\cli\node_modules\@zowe\imperative\lib\rest\src\client\AbstractRestClient.js:117:39 +``` + +**Solution:** + +Create a new PEM certificate file with no password requirement to log in to API ML. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/cli/troubleshoot-cli-plugins.md b/versioned_docs/version-v2.15.x/troubleshoot/cli/troubleshoot-cli-plugins.md new file mode 100644 index 0000000000..911979ad54 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/cli/troubleshoot-cli-plugins.md @@ -0,0 +1,24 @@ +# Troubleshooting Zowe CLI plug-ins + +## When there is a problem + +If a plug-in for Zowe™ CLI is experiencing a problem, there are steps you can take to find a potential solution. + +### Error codes + +For help with error codes from a back-end vendor, refer to the vendor’s help documentation. + +### Reaching out for support + +1. Is there already a GitHub issue (open or closed) that covers the problem? Check the following repositories: + + - [IBM CICS Plug-in issues](https://github.com/zowe/cics-for-zowe-client/issues) + - [IBM Db2 Database Plug-in issues](https://github.com/zowe/zowe-cli-db2-plugin/issues) + - [IBM MQ Plug-in issues](https://github.com/zowe/zowe-cli-mq-plugin/issues) + - [IBM z/OS FTP Plug-in issues](https://github.com/zowe/zowe-cli-ftp-plugin/issues) + + If there is no issue on the problem, file an issue in the repository for the respective plug-in so the dev team can review it. + +2. Try searching for the issue using the [Zowe Docs](https://docs.zowe.org/) **Search** bar. + +3. Use the [Zowe CLI Slack channel](https://openmainframeproject.slack.com/archives/CC8AALGN6) to reach the Zowe CLI community for assistance. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/cli/troubleshoot-cli.md b/versioned_docs/version-v2.15.x/troubleshoot/cli/troubleshoot-cli.md new file mode 100644 index 0000000000..5170eea053 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/cli/troubleshoot-cli.md @@ -0,0 +1,33 @@ +# Troubleshooting Zowe CLI + +## When there is a problem + +If Zowe™ CLI is experiencing a problem, there are steps you can take to find a potential solution. + +### Applicable environments + +These instructions apply to Zowe CLI installed on Windows, Mac OS X, and Linux systems as a standalone installation via a Zowe download or an NPM registry. + +### Reaching out for support + +1. Is there already a GitHub issue (open or closed) that covers the problem? Check [CLI Issues](https://github.com/zowe/zowe-cli/issues). + +2. Review the current list of [Known Zowe CLI issues](known-cli.md) in documentation. Also try searching using the [Zowe Docs](https://docs.zowe.org/) **Search** bar. + +### Resolving the problem + +Collect the following information to help diagnose the issue: + +- Zowe CLI version installed. +- List of plug-ins installed and their version numbers. +- Node.js and NPM versions installed. +- List of environment variables in use. + +For instructions on using commands to collect this information, see [Gathering information to troubleshoot Zowe CLI](mustgather-cli.md) or [Using individual commands for troubleshooting](use-individual-troubleshoot-commands). + +The following information is also useful to collect: + +- If you are experiencing HTTP errors, see [z/OSMF troubleshooting](zosmf-cli.md) for information to collect. +- Is the CLI part of another Node application, such as VSCode, or is it a general installation? +- Which queue managers are you trying to administer, and on what systems are they located? +- Are the relevant API endpoints online and valid? diff --git a/versioned_docs/version-v2.15.x/troubleshoot/cli/troubleshoot-ibm-db2-database-plug-in.md b/versioned_docs/version-v2.15.x/troubleshoot/cli/troubleshoot-ibm-db2-database-plug-in.md new file mode 100644 index 0000000000..920107d837 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/cli/troubleshoot-ibm-db2-database-plug-in.md @@ -0,0 +1,98 @@ +# IBM Db2 Database Plug-in troubleshooting + +As part of the IBM Db2 Database Plug-in installation, the ODBC driver is automatically installed. The driver is required to connect to Db2, but installation can fail due to security restrictions. + +When the ODBC driver installation fails, Zowe CLI displays an error message. To resolve this, the user can manually download and install the driver. + +**Symptom:** + +The ODBC driver installation fails when installing the IBM Db2 Database Plug-in. + +**Sample:** + +The ODBC driver installation can fail due to several factors, displaying the following error when the `zowe plugins install` command is issued: + +``` +_______________________________________________________________ +Installed plugin name = '@zowe/db2-for-zowe-cli' + +_____ Validation results for plugin '@zowe/db2-for-zowe-cli' _____ + +*** CmdError: Failed to combine command definitions. Reason = Encountered an error loading one of the files (cli/call/Call.definition.js) that matched the provided command module glob for the glob **/cli/*/*.definition!(.d).*s: Could not locate the bindings file. Tried: +→ C:\Users\username\.zowe\plugins\installed\node_modules\@zowe\db2-for-zowe-cli\node_modules\ibm_db\build\odbc_bindings.node +→ C:\Users\username\.zowe\plugins\installed\node_modules\@zowe\db2-for-zowe-cli\node_modules\ibm_db\build\Debug\odbc_bindings.node +→ C:\Users\username\.zowe\plugins\installed\node_modules\@zowe\db2-for-zowe-cli\node_modules\ibm_db\build\Release\odbc_bindings.node +``` + +To identify the cause of the error and get more details to troubleshoot, run the following command: + +``` +npm install ibm_db --foreground-scripts true +``` + +The response includes an error message, which could specify a timeout or unpacking error. + +#### Timeout error + +Network restrictions can prevent the ODBC driver from downloading, resulting in a timeout error: + +``` +Downloading Db2 ODBC CLI Driver from https://public.dhe.ibm.com/ibmdl/export/pub/software/data/db2/drivers/odbc_cli/ntx64_odbc_cli.zip ... + +ETIMEDOUT : https://public.dhe.ibm.com/ibmdl/export/pub/software/data/db2/drivers/odbc_cli/ntx64_odbc_cli.zipbm_db/-/ibm_db-3.2.3.tgz 7210ms (cache miss) +Downloading Db2 ODBC CLI Driver from https://github.com/ibmdb/db2drivers/raw/main/clidriver/ntx64_odbc_cli.zip ... + +ETIMEDOUT : https://github.com/ibmdb/db2drivers/raw/main/clidriver/ntx64_odbc_cli.zipifactory/api/npm/npmjs/ibm_db/-/ibm_db-3.2.3.tgz 7210ms (cache miss) + +===================================== +Error: Installation of ibm_db failed. +===================================== +``` + +To troubleshoot a timeout error, see [Downloading the ODBC driver manually](#downloading-the-odbc-driver-manually). + +#### Unpacking error + +If the driver downloads successfully, security settings can still prompt an unpacking error. + +In the following example, the ODBC driver is downloaded manually and the environment variable `IBM_DB_INSTALLER_URL` is set. + +``` +Error: invalid distance too far back + at Zlib.zlibOnError [as onerror] (node:zlib:190:17) +Emitted 'error' event on InflateRaw instance at: + at emitErrorNT (node:internal/streams/destroy:157:8) + at emitErrorCloseNT (node:internal/streams/destroy:122:3) + at processTicksAndRejections (node:internal/process/task_queues:83:21) { + errno: -3, + code: 'Z_DATA_ERROR' +} +npm ERR! code 1 +npm ERR! path C:\Users\username\node_modules\ibm_db +npm ERR! command failed +npm ERR! command C:\WINDOWS\system32\cmd.exe /d /s /c node installer/driverInstall.js +``` + +To troubleshoot a packaging error, see [Fixing a failed extraction](#fixing-a-failed-extraction). + +**Solution:** + +#### Downloading the ODBC driver manually + +To manually download the ODBC driver, see instructions in [Downloading the ODBC driver](../../user-guide/cli-db2plugin.md#downloading-the-odbc-driver). + +#### Fixing a failed extraction + +1. Manually extract the ODBC driver binaries from the `build.zip` file which is bundled with the [ibm_db](https://www.npmjs.com/package/ibm_db) package. The `build.zip` archive can also be downloaded from [GitHub](https://github.com/ibmdb/node-ibm_db/blob/master/build.zip). + +2. Open the `build/Release` folder and copy the binary for your Node version (for example, `odbc_bindings.node.18.18.2` if you have Node 18) into the Db2 plug-in folder (`C:\Users\username\.zowe\plugins\installed\node_modules\@zowe\db2-for-zowe-cli\node_modules\ibm_db\build\Release`). + +3. Rename the file to `odbc_bindings.node`. This is the name used by the Db2 plug-in. + + You successfully extracted the ODBC driver. + +:::note + +The preceding steps extract the driver binary to fix a broken installation of the IBM Db2 Database Plug-in. When installing a new version of the plug-in, perform the workaround again to fix a failed extraction. + +::: diff --git a/versioned_docs/version-v2.15.x/troubleshoot/cli/use-individual-troubleshoot-commands.md b/versioned_docs/version-v2.15.x/troubleshoot/cli/use-individual-troubleshoot-commands.md new file mode 100644 index 0000000000..33462543fe --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/cli/use-individual-troubleshoot-commands.md @@ -0,0 +1,126 @@ +# Using individual commands for Zowe CLI troubleshooting + +Follow these instructions to gather specific pieces of information to help troubleshoot Zowe™ CLI issues. + +## Identify the currently installed CLI version + +Issue the following command: + +``` +zowe -V +``` + +The exact Zowe CLI version may vary depending upon if the `@latest` or `@zowe-v1-lts`, or `@zowe-v2-lts` version is installed. + +You can also display the version of your globally-installed Zowe CLI through the following NPM command: + +``` +npm list -g @zowe/cli +``` + +More information regarding versioning conventions for Zowe CLI and plug-ins is located in [Versioning Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/MaintainerVersioning.md). + +## Identify the currently installed versions of plug-ins + +Issue the following command: + +``` +zowe plugins list +``` + +The output describes version and the registry information. + +## Environment variables + +The following settings are configurable via environment variables: + +### Log levels + +Environment variables are available to specify logging level and the CLI home directory. + +**Important\!** Setting the log level to TRACE or ALL might result in "sensitive" data being logged. For example, command line arguments will be logged when TRACE is set. + +For more information about logging and environment variables, see [Setting CLI log levels](../../user-guide/cli-configuringcli-ev.md#setting-cli-log-levels). + +### CLI daemon mode + +By default, the CLI daemon mode binary creates or reuses a file in the user's home directory each time a Zowe CLI command runs. In some cases, this behavior might be undesirable. For example, the home directory resides on a network drive and has poor file performance. For information about how to change the location that the daemon uses, see [Setting CLI daemon mode properties](../../user-guide/cli-configuringcli-ev#setting-cli-daemon-mode-properties). + + +### Home directory + +You can set the location on your computer for the Zowe CLI home directory, which contains log files, profiles, and plug-ins for the product. + +The default `.zowe` folder is created when you issue your first Zowe CLI command. If you change the location of the folder, you must reinstall plug-ins and recreate or move profiles and log files that you want to retain. In some cases, you might want to maintain a different set of profiles in multiple folders, then switch between them using the environment variable. + +For information about setting an environment variable for the Zowe CLI home directory, see [Setting the CLI home directory](../../user-guide/cli-configuringcli-ev#setting-the-cli-home-directory). + +The values for these variables can be **echo**ed. + +## Home directory structure + +![Home Directory](../../images/troubleshoot/cli/home_struc.png) + +### Location of logs + +There are two sets of logs to be aware of: + +- Imperative CLI Framework log, which generally contains installation and configuration information. + +- Zowe CLI log, which contains information about interaction between CLI and the server endpoints. + +Analyze these logs for any information relevant to your issue. + +### Profile configuration + +The `profiles` folder stores connection information. + +**Important\!** The profile directory might contain "sensitive" information, such as your mainframe password. You should obfuscate any sensitive references before providing configuration files. + +**Note:** While the profile directory can still be used in Zowe CLI v2, it has been deprecated in favor of v2 [team configuration](https://docs.zowe.org/stable/user-guide/cli-using-using-team-profiles) files. + +## Node.js and npm +Zowe CLI is compatible with the currently supported Node.js LTS versions. For an up-to-date list of supported LTS versions, see [Node.js.org](https://nodejs.org/en/download/releases/). + +To gather the Node.js and npm versions installed on your computer, issue the following commands: + +``` +node --version +npm --version +``` + +### npm configuration +If you are having trouble installing Zowe CLI from an npm registry, gather your npm configuration to help identify issues with registry settings, global install paths, proxy settings, etc... + +``` +npm config ls -l +``` + +### npm log files +In case of errors, npm creates log files in the `npm_cache\_logs` location. To get the `npm_cache` location for a specific OS, run the following command: + +``` +npm config get cache +``` + +By default, npm keeps only 10 log files, but sometimes more are needed. Increase the log count by issuing the following command: + +``` +npm config set logs-max 50 +``` + +This command increases the log count to 50, so that more log files will be stored on the system. Now you can run tests multiple times and not lose the log files. The logs can be passed to Support for analysis. + +As the log files are created only when an npm command fails, but you are interested to see what is executed, you can increase the log level of npm. Issue the following command: + +``` +npm config set loglevel verbose +``` + +- With this change, you can see all actions taken by npm on the stdout. If the command is successful, it still does not generate a log file. + +- The available log levels are: +"silent", "error", "warn", "notice", "http", "timing", "info", "verbose", "silly", and "notice". "Notice" is the default. + + +- Alternatively, you can pass `--loglevel verbose` on the command line, but this only works with npm related commands. By setting log level in the config, it also works when you issue some `zowe` commands that use npm (for example, `zowe plugins install @zowe/cics`). diff --git a/versioned_docs/version-v2.15.x/troubleshoot/cli/zosmf-cli.md b/versioned_docs/version-v2.15.x/troubleshoot/cli/zosmf-cli.md new file mode 100644 index 0000000000..16c699ca7d --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/cli/zosmf-cli.md @@ -0,0 +1,17 @@ +# z/OSMF troubleshooting +The core command groups use the z/OSMF REST APIs which can experience any number of problems. + +If you encounter HTTP 500 errors with the CLI, consider gathering the following information: +1. The IZU* (IZUSVR and IZUANG) joblogs (z/OSMF server) +2. z/OSMF USS logs (default location: /global/zosmf/data/logs - but may change depending on installation) + +If you encounter HTTP 401 errors with the CLI, consider gathering the following information: +1. Any security violations for the TSO user in SYSLOG + +## Alternative methods +At times, it may be beneficial to test z/OSMF outside of the CLI. You can use the CLI tool `curl` or a REST tool such as "Postman" to isolate areas where the problem might be occurring (CLI configuration, server-side, etc.). + +Example `curl` command to `GET /zosmf/info`: +``` +curl -k -H "Accept: application/json" -H "X-CSRF-ZOSMF-HEADER: true" "https://zosmf.hostname.net:443/zosmf/info" +``` diff --git a/versioned_docs/version-v2.15.x/troubleshoot/faq.md b/versioned_docs/version-v2.15.x/troubleshoot/faq.md new file mode 100644 index 0000000000..c6c063c745 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/faq.md @@ -0,0 +1,62 @@ +# FAQ + +## Error Jobs search failing + +### Error: + +Search for jobs using SDSF failed for prefix {} and owner {}: exc.sdsf_invocation_failed 8 (Issue does not impace ZD&T boxes) + +### Solution: + +You must be authorized to use SDSF with REXX on your z/OS system. In order to do this, activate the SDSF RACF class and add the following 3 profiles to your system: + +- GROUP.ISFSORIG +- GROUP.ISFSPROG.SDSF +- ISF.CONNECT. + +Users must belong to a group that has READ access to these profiles. + +This is quite a complex area and you should ask your systems programmer for advice. On most systems, the GROUP.\* profiles are not required and it is sufficient to have the following ISF profile defined: + +class profile SDSF ISF.CONNECT.\*\* (G) + +## Services that are Not Running Appear to be Running + +### Error: + +Services that are not running appear to be running. The following message is displayed in the Discovery Service: + + **EMERGENCY! EUREKA MAY BE INCORRECTLY CLAIMING INSTANCES ARE UP WHEN THEY'RE NOT. RENEWALS ARE LESSER THAN THRESHOLD AND HENCE THE INSTANCES ARE NOT BEING EXPIRED JUST TO BE SAFE.** + +### Cause: + +This message is expected behavior of the discovery service. If a service is incorrectly terminated without properly unregistering from Eureka, it initially enters _eviction status_ for a brief timeframe before the service is deregistered. Failure to properly terminate occurs when a service fails to respond to three consecutive heartbeat renewals. After the three heartbeat renewals are returned without a response, the Eureka discovery service keeps the service in _eviction status_ for one additional minute. If the service does not respond within this minute, the Eureka service unregisters this unresponsive service. When more than 15 percent of currently registered services are in _eviction status_, _self preservation mode_ is enabled. In _self preservation mode_, no services in eviction status are deregistered. As a result, these services continue to appear to be running even though they are not running. + +### Solution: + +Use one of the following options to exit self preservation mode: + + - **Restart the services that appear to be running** + + Relaunch the services that appear to be registered. After the message disappears, close each of the services one at a time. Allow for a 3-minute period between closing each service. + + - **Restart the discovery service** + + Manually restart the discovery service. The new instance will not be in self preservation mode. In a few minutes, the running services re-register. + + - **Adjust the threshold of services in eviction status** + + Change the frequency of the discovery service from entering self preservation mode by adjusting the threshold of services in eviction status. + + **Note:** The default threshold is .85. This results in the discovery service entering self preservation mode when 15 percent of currently registered services are in _eviction status_. + + **Example:** + + ``` + eureka.renewalPercentThreshold=0.3 + ``` + + This threshold limit causes the discovery service to enter self preservation mode when less than 30 percent of services are not responding. + + + diff --git a/versioned_docs/version-v2.15.x/troubleshoot/k8s-troubleshoot.md b/versioned_docs/version-v2.15.x/troubleshoot/k8s-troubleshoot.md new file mode 100644 index 0000000000..dbe9fb3a49 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/k8s-troubleshoot.md @@ -0,0 +1,44 @@ +# Troubleshooting Kubernetes environments + +The following topics contain information that can help you troubleshoot problems when you encounter unexpected behavior installing and using Zowe™ containers in a Kubernetes environment. + +### ISSUE: Deployment and ReplicaSet failed to create pod + +**Problem:** + +If you are using OpenShift and see these error messages in `ReplicaSet` Events: + +``` +Generated from replicaset-controller +Error creating: pods "api-catalog-??????????-" is forbidden: unable to validate against any security context constraint: [] +``` + +That means the Zowe ServiceAccount `zowe-sa` doesn't have any SecurityContextConstraint attached. + +**Solution:** + +You can run this command to grant a certain level of permission, for example, `privileged`, to `zowe-sa` ServiceAccount: + +``` +oc admin policy add-scc-to-user privileged -z zowe-sa -n zowe +``` + +### ISSUE: Failed to create services + +**Problem:** + +If you are using OpenShift and apply services, you may see this error: + +``` +The Service "api-catalog-service" is invalid: spec.ports[0].appProtocol: Forbidden: This field can be enabled with the ServiceAppProtocol feature gate +``` + +**Solution:** + +To fix this issue, you can simply find and comment out this line in the `Service` definition files: + +``` +appProtocol: https +``` + +With OpenShift, you can define a `PassThrough` `Route` to let Zowe handle TLS connections. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/launcher/launcher-error-codes.md b/versioned_docs/version-v2.15.x/troubleshoot/launcher/launcher-error-codes.md new file mode 100644 index 0000000000..3b66fd5642 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/launcher/launcher-error-codes.md @@ -0,0 +1,141 @@ +# Error Message Codes + +The following error message codes may appear on Zowe Launcher SYSPRINT. Use the following message code references and the corresponding reasons and actions to help troubleshoot issues. + +## Zowe Launcher informational messages + +### ZWEL0001I + + component %s started + + **Reason:** + + Component `` started. + + **Action:** + + No action required. + +### ZWEL0002I + + component %s stopped + + **Reason:** + + Component `` stopped. + + **Action:** + + No action required. + +### ZWEL0003I + + new component initialized %s, restart_cnt=%d, min_uptime=%d seconds, share_as=%s + + **Reason:** + + Component `` initialized. + - `restart_cnt` - Number of attempts to restart the component in case of failure + - `min_uptime` - Minimum uptime that the component can be considered as successfully started + - `share_as` - One of `` which indicates whether child processes of the component start in the same address space. See documentation for [_BPX_SHAREAS](https://www.ibm.com/docs/en/zos/2.4.0?topic=shell-setting-bpx-shareas-bpx-spawn-script) for details. + + **Action:** + + No action required. + +### ZWEL0004I + + component %s\(%d\) terminated, status = %d + + **Reason:** + + Component ``(``) terminated with status ``. + + **Action:** + + No action required. + +### ZWEL0005I + + next attempt to restart component %s in %d seconds + + **Reason:** + + Component failure detected. + + **Action:** + + No action required. The component `` will be restarted in `` seconds. + +## Zowe Launcher error messages + +### ZWEL0030E + + failed to prepare Zowe instance + + **Reason:** + + Failed to prepare the Zowe high availability (HA) instance. + + **Action:** + + Check previous messages in the Zowe Launcher SYSPRINT to find the reason and correct it. + +### ZWEL0038E + + failed to restart component %s, max retries reached + + **Reason:** + + Maximum retries reached for restarting component `. + + **Action:** + + Check `` configuration and correct the maximum restart count via configuration attribute `restartIntervals` if needed, then restart the component by using z/OS MODIFY command `F ZWESLSTC,APPL=STOP()` + +### ZWEL0040E + + failed to start component %s + + **Reason:** + + Failed to start component ``. + + **Action:** + + Check `` configuration and correct if needed, then either 1) start the component manually by using z/OS MODIFY command `F ZWESLSTC,APPL=STOP()` or 2) restart the entire HA instance + +### ZWEL0047E + + failed to parse zowe.yaml - %s + + **Reason:** + + Failed to parse Zowe configuration file. + + **Action:** + + Validate the format of Zowe configuration file. It should be a valid YAML file following specifications defined in https://yaml.org/. + +### ZWEL0073E + + Launcher Could not load schemas, status=5 + + **Reason:** + + The Zowe Launcher was able to locate the runtime directory, but unable to find the /schemas directory. + + **Action:** + + Locate the runtimeDirectory from the `zowe.yaml` variable `runtimeDirectory: ""`. + + Check that there is a `/schemas` directory. This should contain four `.json` files shown below. + + ``` + manifest-schema.json + server-common-json + trivial-component-schema.json + zowe-yaml-schema.json + ``` + + On ocassion the error occurs because the `runtimeDirectory` is pointing to a valid directory, but one which doesn't contain a valid Zowe runtime environment is one of the first failures during a Zowe launch. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/launcher/launcher-troubleshoot.md b/versioned_docs/version-v2.15.x/troubleshoot/launcher/launcher-troubleshoot.md new file mode 100644 index 0000000000..85c9f75fab --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/launcher/launcher-troubleshoot.md @@ -0,0 +1,28 @@ +# Troubleshooting Zowe Launcher + +The following topics contain information that can help you troubleshoot problems when you encounter unexpected behavior using Zowe™ Launcher. + +Issues and development of the Zowe Launcher is managed in GitHub. When you troubleshoot a problem, you can check whether a GitHub issue (open or closed) that covers the problem already exists. For a list of issues, see the [launcher repo](https://github.com/zowe/launcher). + +[**Error Message Codes**](launcher-error-codes.md) +## Enable Zowe Launcher Debug Mode + +Use debug mode to display additional debug messages for Zowe Launcher. + +**Important:** We highly recommend that you enable debug mode only when you want to troubleshoot issues. +Disable debug mode when you are not troubleshooting. Running Zowe Launcher in debug mode can adversely affect its performance and consume a large amount of spool space. + +**Follow these steps:** + +1. Open the PROCLIB member ZWESLSTC + +2. Find STDENV DD inline statements + +3. Add a new line + + ``` + ZLDEBUG=ON + ``` + By default debug mode is disabled, so the `ZLDEBUG` is set to `OFF`. To disable debug mode remove the line or set `ZLDEBUG` to `OFF`. + +3. Restart ZWESLSTC Started Task. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/servers/must-gather.md b/versioned_docs/version-v2.15.x/troubleshoot/servers/must-gather.md new file mode 100644 index 0000000000..330519783c --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/servers/must-gather.md @@ -0,0 +1,68 @@ +# Gathering Information for Support or Troubleshooting + +If you need to contact a support group for Zowe, they will likely need a variety of information from you to help you. This page details a list of items you should gather to the best of your ability to provide to your support group. You may also find this list useful for independent troubleshooting. + +## Describe your environment + +* Zowe version number: +* Install method (pax, smpe, kubernetes, github clone): +* Operating system (z/OS, kubernetes, etc) and OS version: +* Node.js version number (Shown in logs, or via `node --version`): +* Java version number (Shown in logs, or via `java -version`): +* z/OSMF version: +* Browser: +* Are you accessing the Desktop from the APIML Gateway? (Recommended): +* What is the output of log message ZWES1014I: +* Environment variables in use: + +### Tips on gathering this information + +A lot of this information can be gathered automatically using the `zwe` command `zwe support`. +Otherwise, you can gather some of the information in the ways below. + +#### z/OS release level + +To find the z/OS release level, issue the following command in SDSF: + +``` +/D IPLINFO +``` + +#### Zowe version + +Locate the file manifest.json within the zowe installation directory. +At the top, you will find the version number. + + + +## Describe your issue + +Do you think your issue is a bug? If so, try to list the steps to reproduce it, and what you expect to happen instead. + +## Provide the logs + +When running Zowe servers on z/OS, the joblog has the most information. +Depending on what support group you are contacting, you may want to sanitize the logs as they can contain basic system information like hostnames, usernames, and network configuration. + +Ensure that your logs were captured with long enough record length to be read by support. Zowe commonly writes lines as long as 500 characters, especially when tracing. + +### Enabling debugging and tracing + +There are several debug modes in the Zowe servers, and support groups may ask for you to turn some on. +Below are some tracing you can turn on when needed: + +* When running a `zwe` command, you can run it with `--trace` to get the most output from it. +* `zwe` startup tracing can be set via the zowe configuration file property `zowe.launchScript.logLevel="trace"`. [You can see the property in the example file here](https://github.com/zowe/zowe-install-packaging/blob/677a607686e6ee7ecb349dc5925a6f58dd9e61da/example-zowe.yaml#L356) +* app-server tracing can be enabled by setting various loggers in the property `components.app-server.logLevels` in the zowe configuration file. [The full list is documented here](https://github.com/zowe/zlux-app-server/blob/v2.x/master/schemas/app-server-config.json#L378). [More information](../../user-guide/mvd-configuration#logging-configuration) +* zss-tracing tracing can be enabled by setting various loggers in the property `components.zss.logLevels` in the zowe configuration file. [The full list is documented here](https://github.com/zowe/zss/blob/v2.x/master/schemas/zss-config.json#L216). [More information](../../user-guide/mvd-configuration#logging-configuration) +* discovery, gateway, api-catalog and other servers can have tracing enabled by setting `debug: true` within their zowe configuration file section, such as `components.gateway.debug=true` + +You may find more detail within the Mediation Layer and Application Framework troubleshooting categories. + +## Screenshots + +If you have an issue in the browser, its often helpful to show the issue via screenshots. + + + + diff --git a/versioned_docs/version-v2.15.x/troubleshoot/servers/return-codes.md b/versioned_docs/version-v2.15.x/troubleshoot/servers/return-codes.md new file mode 100644 index 0000000000..53556f0b8d --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/servers/return-codes.md @@ -0,0 +1,13 @@ +# Diagnosing Return Codes + +If one of the Zowe servers ends abnormally with a return code, then this return code may be used as a clue to determine the cause of the failure. The meaning of a return code depends upon which program generated it; many return codes can originate from operating system utilities rather than from Zowe itself, but some may originate from Zowe too. Knowing which program generated the return code is important to finding the relevant documentation on the code. For example, if you tried to run the `app-server` and received a return code from a failure, it could have originated from, in order of execution, the Launcher, shell code and shell utilities such as `cat` or `mkdir`, `zwe`, and finally the app-server itself. + +Return codes that can arise from any of the servers due to the chain of events that start Zowe may be found in the following documentation: + +* [Zowe launcher error codes](../launcher/launcher-error-codes) +* The z/OS shell and programs called from the shell such as `cat`, `mkdir`, `node` or `java`: + * Return codes ("errno"): https://www.ibm.com/docs/en/zos/2.5.0?topic=codes-return-errnos + * Reason codes ("errnojr"): https://www.ibm.com/docs/en/zos/2.5.0?topic=codes-reason-errnojrs +* `zwe` error codes are documented specific to each `zwe` subcommand visible within the `--help` option of `zwe` or [on the zwe reference page](../../appendix/zwe_server_command_reference/zwe/zwe). Searching for "ZWEL" plus your error code in the search bar of the documentation website will likely bring you to the appropriate page. + +Error codes for the specific Zowe servers may be found in their own troubleshooting sections. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-apiml-error-codes.md b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-apiml-error-codes.md new file mode 100644 index 0000000000..40df62a0f0 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-apiml-error-codes.md @@ -0,0 +1,2030 @@ + +# Error Message Codes + +The following error message codes may appear on logs or API responses. Use the following message code references and the corresponding reasons and actions to help troubleshoot issues. + +## API mediation utility messages + +### ZWEAM000I + + %s started in %s seconds + + **Reason:** + + The service started. + + **Action:** + + No action required. + +## API mediation common messages + +### ZWEAO102E + + Gateway not yet discovered. The Transform service cannot perform the request + + **Reason:** + + The Transform service was requested to transform a url, but the Gateway instance was not discovered. + + **Action:** + + Do not begin performing requests until the API Mediation Layer fully initializes after startup. Check that your Discovery service is running and that all services (especially the Gateway) are discovered correctly. + +### ZWEAO104W + + GatewayInstanceInitializer has been stopped due to exception: %s + + **Reason:** + + An unexpected exception occurred while retrieving the Gateway service instance from the Discovery Service. + + **Action:** + + Check that both the service and the Gateway can register with Discovery. If the services are not registering, investigate the reason why. If no cause can be determined, create an issue. + +### ZWEAO105W + + Gateway HTTP Client per-route connection limit (maxConnectionsPerRoute) of %s has been reached for the '%s' route. + + **Reason:** + + Too many concurrent connection requests were made to the same route. + + **Action:** + + Further connections will be queued until there is room in the connection pool. You may also increase the per-route connection limit via the gateway start-up script by setting the Gateway configuration for maxConnectionsPerRoute. + +### ZWEAO106W + + Gateway HTTP Client total connection limit (maxTotalConnections) of %s has been reached. + + **Reason:** + + Too many concurrent connection requests were made. + + **Action:** + + Further connections will be queued until there is room in the connection pool. You may also increase the total connection limit via the gateway start-up script by setting the Gateway configuration for maxTotalConnections. + +### ZWEAO401E + + Unknown error in HTTPS configuration: '%s' + + **Reason:** + + An Unknown error occurred while setting up an HTTP client during service initialization, followed by a system exit. + + **Action:** + + Start the service again in debug mode to get a more descriptive message. This error indicates it is not a configuration issue. + +## Common service core messages + +### ZWEAM100E + + Could not read properties from: '%s' + + **Reason:** + + The Build Info properties file is empty or null. + + **Action:** + + The jar file is not packaged correctly. Please submit an issue. + +### ZWEAM101E + + I/O Error reading properties from: '%s' Details: '%s' + + **Reason:** + + I/O error reading `META-INF/build-info.properties` or `META-INF/git.properties`. + + **Action:** + + The jar file is not packaged correctly. Please submit an issue. + +### ZWEAM102E + + Internal error: Invalid message key '%s' is provided. Please create an issue with this message. + + **Reason:** + + Message service is requested to create a message with an invalid key. + + **Action:** + + Create an issue with this message. + +### ZWEAM103E + + Internal error: Invalid message text format. Please create an issue with this message. + + **Reason:** + + Message service is requested to create a message with an invalid text format. + + **Action:** + + Create an issue with this message. + +### ZWEAM104E + + The endpoint you are looking for '%s' could not be located + + **Reason:** + + The endpoint you are looking for could not be located. + + **Action:** + + Verify that the URL of the endpoint you are trying to reach is correct. + +### ZWEAG140E + + The 'applicationName' parameter name is missing. + + **Reason:** + + The application name is not provided. + + **Action:** + + Provide the 'applicationName' parameter. + +### ZWEAG141E + + The generation of the PassTicket failed. Reason: %s + + **Reason:** + + An error occurred in the SAF Auth Service. Review the reason in the error message. + + **Action:** + + Supply a valid user and application name, and check that corresponding permissions have been set up. + +### ZWEAM400E + + Error initializing SSL Context: '%s' + + **Reason:** + + An error occurred while initializing the SSL Context. + + **Action:** + + Refer to the specific message to identify the exact problem. + Possible causes include: + - Incorrect security algorithm + - The keystore is invalid or corrupted + - The certificate is invalid or corrupted + +### ZWEAM500W + + The service is not verifying the TLS/SSL certificates of the services + + **Reason:** + + This is a warning that the SSL Context will be created without verifying certificates. + + **Action:** + + Stop the service and set the verifySslCertificatesOfServices parameter to `true`, and then restart the service. Do not use this option in a production environment. + +### ZWEAM501W + + Service is connecting to Discovery service using the non-secure HTTP protocol. + + **Reason:** + + The service is connecting to the Discovery Service using the non-secure HTTP protocol. + + **Action:** + + For production use, start the Discovery Service in HTTPS mode and configure the services accordingly. + +### ZWEAM502E + + Error reading secret key: '%s' + + **Reason:** + + A key with the specified alias cannot be loaded from the keystore. + + **Action:** + + Ensure that the configured key is present, in the correct format, and not corrupt. + +### ZWEAM503E + + Error reading secret key: '%s' + + **Reason:** + + Error reading secret key. + + **Action:** + + Refer to the specific message to identify the exact problem. + Possible causes include: + - An incorrect security algorithm + - The keystore is invalid or corrupted + - The certificate is invalid or corrupted + +### ZWEAM504E + + Error reading public key: '%s' + + **Reason:** + + Error reading secret key. + + **Action:** + + Refer to the specific message to identify the exact problem. + Possible causes include: + - An incorrect security algorithm + - The keystore is invalid or corrupted + - The certificate is invalid or corrupted + +### ZWEAM505E + + Error initializing SSL/TLS context: '%s' + + **Reason:** + + Error initializing SSL/TLS context. + + **Action:** + + Refer to the specific message to identify the exact problem. + Possible causes include: + - An incorrect security algorithm + - The keystore is invalid or corrupted + - The certificate is invalid or corrupted + +### ZWEAM506E + + Truststore Password configuration parameter is not defined + + **Reason:** + + Your truststore password was not set in the configuration. + + **Action:** + + Ensure that the parameter server.ssl.trustStorePassword contains the correct password for your truststore. + +### ZWEAM507E + + Truststore configuration parameter is not defined but it is required + + **Reason:** + + The truststore usage is mandatory, but the truststore location is not provided. + + **Action:** + + If a truststore is required, define the truststore configuration parameter by editing the server.ssl.truststore, server.ssl.truststorePassword and server.ssl.truststoreType parameters with valid data. If you do not require a truststore, change the trustStoreRequired boolean parameter to `false`. + +### ZWEAM508E + + Keystore not found, server.ssl.keyStore configuration parameter is not defined + + **Reason:** + + Your keystore path was not set in the configuration. + + **Action:** + + Ensure that the correct path to your keystore is contained in the parameter server.ssl.keyStore in the properties or yaml file of your service. + +### ZWEAM509E + + Keystore password not found, server.ssl.keyStorePassword configuration parameter is not defined + + **Reason:** + + Your keystore password was not set in the configuration. + + **Action:** + + Ensure that the correct password to your keystore in the parameter server.ssl.keyStorePassword is contained in the properties or yaml file of your service. + +### ZWEAM510E + + Invalid key alias '%s' + + **Reason:** + + The key alias was not found. + + **Action:** + + Ensure that the key alias provided for the key exists in the provided keystore. + +### ZWEAM511E + + There was a TLS request error accessing the URL '%s': '%s' + + **Reason:** + + The Gateway refuses to communicate with the requested service. + + **Action:** + + Possible actions regarding to message content: + - Message: The certificate is not trusted by the API Gateway. + Action: Verify trust of the certificate is the issue by disabling certificate verification and retry the request. + - Message: Certificate does not match any of the subject alternative names. + Action: Verify that the hostname which the certificate is issued for matches the hostname of the service. + - Message: Unable to find the valid certification path to the requested target. + Action: Import the root CA that issued services' certificate to API Gateway truststore. + - Message: Verify the requested service supports TLS. + Action: Ensure the requested service is running with TLS enabled. + - Message: Review the APIML debug log for more information. + Action: Enable APIML debug mode and retry the request, then review the APIML log for TLS errors. + +### ZWEAM600W + + Invalid parameter in metadata: '%s' + + **Reason:** + + An invalid apiInfo parameter was found while parsing the service metadata. + + **Action:** + + Remove or fix the referenced metadata parameter. + +### ZWEAM700E + + No response received within the allowed time: %s + + **Reason:** + + No response was received within the allowed time. + + **Action:** + + Verify that the URL you are trying to reach is correct and all services are running. + +### ZWEAM701E + + The request to the URL '%s' has failed: %s caused by: %s + + **Reason:** + + The request failed because of an internal error. + + **Action:** + + Refer to specific exception details for troubleshooting. Create an issue with this message. + +## Security common messages + +### ZWEAT100E + + Token is expired for URL '%s' + + **Reason:** + + The validity of the token is expired. + + **Action:** + + Obtain a new token by performing an authentication request. + +### ZWEAT103E + + Could not write response: %s + + **Reason:** + + A message could not be written to the response. + + **Action:** + + Please submit an issue with this message. + +### ZWEAT403E + + The user is not authorized to the target resource: %s + + **Reason:** + + The service has accepted the authentication of the user but the user does not have access rights to the resource. + + **Action:** + + Contact your security administrator to give you access. + +### ZWEAT409E + + The platform returned error: %s + + **Reason:** + + The platform responded with unknown errno code. + + **Action:** + + Please submit an issue with this message. + +### ZWEAT410E + + The platform returned error: %s + + **Reason:** + + The specified password is incorrect. + + **Action:** + + Provide correct password. + +### ZWEAT411E + + The platform returned error: %s + + **Reason:** + + The platform returned error, specified in the error message. + + **Action:** + + Contact your security administrator with the message. + +### ZWEAT412E + + The platform returned error: %s + + **Reason:** + + The specified password is expired. + + **Action:** + + Contact your security administrator to reset your password. + +### ZWEAT413E + + The platform returned error: %s + + **Reason:** + + The new password is not valid. + + **Action:** + + Provide valid password. + +### ZWEAT414E + + The platform returned error: %s + + **Reason:** + + The user name access has been revoked. + + **Action:** + + Contact your security administrator to unsuspend your account. + +### ZWEAT415E + + The platform returned error: %s + + **Reason:** + + The user name does not exist in the system. + + **Action:** + + Provide correct user name. + +### ZWEAT416E + + The platform returned error: %s + + **Reason:** + + The specified user name or password is invalid. + + **Action:** + + Provide correct user name or password. + +### ZWEAT500E + + Failed to parse the client certificate forwarded from the central Gateway. Error message %s. The client certificate was %s + + **Reason:** + + The string sent by the central Gateway was not recognized as a valid DER-encoded certificate in the Base64 printable form. + + **Action:** + + Ensure that forwarding of the client certificate is also enabled in the central Gateway. Check for any error messages from the central Gateway. + +### ZWEAT501E + + Failed to get trusted certificates from the central Gateway. Unexpected response from %s endpoint. Status code: %s. Response body: %s + + **Reason:** + + The response status code is different from the expected 200 OK. + + **Action:** + + Ensure that the parameter apiml.security.x509.certificatesUrl is correctly configured with the complete URL to the central Gateway certificates endpoint. Test the URL manually. + +### ZWEAT502E + + Invalid URL specified to get trusted certificates from the central Gateway. Error message: %s + + **Reason:** + + The parameter apiml.security.x509.certificatesUrl is not correctly configured with the complete URL to the central Gateway certificates endpoint. + + **Action:** + + Ensure that the parameter apiml.security.x509.certificatesUrl is correctly configured. + +### ZWEAT503E + + An error occurred during retrieval of trusted certificates from the central Gateway. Error message: %s + + **Reason:** + + The communication with the cloud gateway got interrupted or an error occurred while processing the response. + + **Action:** + + Check the provided error message. Contact the support. + +### ZWEAT504E + + Failed to parse the trusted certificates provided by the central Gateway. Error message %s + + **Reason:** + + The string sent by the central Gateway was not recognized as valid DER-encoded certificates in the Base64 printable form. + + **Action:** + + Check that the URL configured in apiml.security.x509.certificatesUrl responds with valid DER-encoded certificates in the Base64 printable form. + +### ZWEAT505E + + Incoming request certificate is not one of the trusted certificates provided by the central Gateway. + + **Reason:** + + The Gateway performs an additional check of request certificates when the central Gateway forwards the incoming client certificate to the domain Gateway. This check may fail when the certificatesUrl parameter does not point to the proper central Gateway certificates endpoint. + + **Action:** + + Check that the URL configured in apiml.security.x509.certificatesUrl points to the central Gateway and it responds with valid DER-encoded certificates in the Base64 printable form. + +### ZWEAT601E + + z/OSMF service name not found. Set parameter apiml.security.auth.zosmf.serviceId to your service ID. + + **Reason:** + + The parameter zosmfserviceId was not configured correctly and could not be validated. + + **Action:** + + Ensure that the parameter apiml.security.auth.zosmf.serviceId is correctly entered with a valid z/OSMF service ID. + +### ZWEAT602E + + The SAF provider `endpoint` supports only the resource class 'ZOWE', but the current one is '%s' + + **Reason:** + + The parameter `apiml.security.authorization.provider` is set to `endpoint` + + **Action:** + + Change the SAF provider to another one to use this endpoint + +### ZWEAT603E + + Endpoint `%s` is not properly configured + + **Reason:** + + The application cannot call the endpoint to check the SAF resource of the user + + **Action:** + + Verify the state of ZSS and IZS, then check if parameters `apiml.security.authorization.endpoint.*` are matching. + +### ZWEAT604E + + Passwords do not match + + **Reason:** + + Re-entered password does not match for password update. + + **Action:** + + Enter the same value as the one entered for new password. + +### ZWEAT605E + + Invalid body provided in request to create personal access token + + **Reason:** + + The request body is not valid + + **Action:** + + Use a valid body in the request. Format of a message: `{validity: int , scopes: [string]}`. + +### ZWEAT606E + + Body in the HTTP request for Personal Access Token does not contain scopes + + **Reason:** + + The request body is not valid + + **Action:** + + Provide a list of services for which this token will be valid + +### ZWEAT607E + + Body in the revoke request is not valid. + + **Reason:** + + The request body is not valid + + **Action:** + + Use a valid body in the request. Format of a message: `{userId: string, (optional)timestamp: long}` or `{serviceId: string, (optional)timestamp: long}`. + +### ZWEAT608E + + Error mapping between distributed and mainframe identity. Reason: %s %s + + **Reason:** + + Unexpected error occurred when mapping between distributed and mainframe identity + + **Action:** + + Contact Broadcom support. + +### ZWEAT609W + + Mapping between distributed and mainframe identity failed. Reason: %s + + **Reason:** + + Mapping between distributed and mainframe identity failed. + + **Action:** + +## Security client messages + +### ZWEAS100E + + Authentication exception: '%s' for URL '%s' + + **Reason:** + + A generic failure occurred while authenticating. + + **Action:** + + Refer to the specific message to troubleshoot. + +### ZWEAS101E + + Authentication method '%s' is not supported for URL '%s' + + **Reason:** + + The HTTP request method is not supported for the URL. + + **Action:** + + Use the correct HTTP request method that is supported for the URL. + +### ZWEAS103E + + API Gateway Service is not available by URL '%s' (API Gateway is required because it provides the authentication functionality) + + **Reason:** + + The security client cannot find a Gateway instance to perform authentication. The API Gateway is required because it provides the authentication functionality. + + **Action:** + + Check that both the service and Gateway are correctly registered in the Discovery service. Allow some time after the services are discovered for the information to propagate to individual services. + +### ZWEAS104E + + Authentication service is not available by URL '%s' + + **Reason:** + + The Authentication service is not available. + + **Action:** + + Make sure that the Authentication service is running and is accessible by the URL provided in the message. + +### ZWEAS105E + + Authentication is required for URL '%s' + + **Reason:** + + Authentication is required. + + **Action:** + + Provide valid authentication. + +### ZWEAS120E + + Invalid username or password for URL '%s' + + **Reason:** + + The username or password is invalid. + + **Action:** + + Provide a valid username and password. + +### ZWEAS121E + + Authorization header is missing, or the request body is missing or invalid for URL '%s' + + **Reason:** + + The authorization header is missing, or the request body is missing or invalid. + + **Action:** + + Provide valid authentication. + +### ZWEAS123E + + Invalid token type in response from Authentication service. + + **Reason:** + + Could not retrieve the proper authentication token from the Authentication service response. + + **Action:** + + Review your APIML authentication provider configuration and ensure your Authentication service is working. + +### ZWEAS130E + + Token is not valid for URL '%s' + + **Reason:** + + The token is not valid. + + **Action:** + + Provide a valid token. + +### ZWEAS131E + + No authorization token provided for URL '%s' + + **Reason:** + + No authorization token is provided. + + **Action:** + + Provide a valid authorization token. + +## ZAAS client messages + +### ZWEAS100E + + Token is expired for URL + + **Reason:** + + The application using the token kept it for longer than the expiration time + + **Action:** + + When this error occurs it is necessary to get a new JWT token. + +### ZWEAS120E + + Invalid username or password + + **Reason:** + + Provided credentials weren't recognized + + **Action:** + + Try with different credentials + +### ZWEAS121E + + Empty or null username or password values provided + + **Reason:** + + One of the credentials was null or empty + + **Action:** + + Try with full set of credentials + +### ZWEAS122E + + Empty or null authorization header provided + + **Reason:** + + The authorization header was empty or null + + **Action:** + + Try again with a valid authorization header + +### ZWEAS170E + + An exception occurred while trying to get the token + + **Reason:** + + General exception. There are more pieces of information in the message + + **Action:** + + Log the message from the exception and then handle the exception based on the information provided there. + +### ZWEAS400E + + Unable to generate PassTicket. Verify that the secured signon (PassTicket) function and application ID is configured properly by referring to Using PassTickets in the guide for your security provider + + **Reason:** + + Unable to generate PassTicket. + + **Action:** + + Verify that the secured signon (PassTicket) function and application ID is configured properly by referring to Using PassTickets in the guide for your security provider + +### ZWEAS401E + + Token is not provided + + **Reason:** + + There was no JWT token provided for the generation of the PassTicket + + **Action:** + + Ensure that you are passing JWT token for PassTicker generation + +### ZWEAS404E + + Gateway service is unavailable + + **Reason:** + + Gateway service does not respond. + + **Action:** + + Ensure that the Gateway service is up and that the path to the gateway service is properly set. + +### ZWEAS417E + + The application name was not found + + **Reason:** + + The application id provided for the generation of the PassTicket was not recognized by the security provider + + **Action:** + + Ensure that the security provider recognized the application id. + +### ZWEAS130E + + Invalid token provided + + **Reason:** + + The JWT token is not valid + + **Action:** + + Provide a valid token. + +### ZWEAS500E + + There was no path to the trust store. + + **Reason:** + + The Zaas Client configuration does not contain the path to the trust store + + **Action:** + + Ensure that the configuration contains the trustStorePath and that it points to valid trust store. + +### ZWEAS501E + + There was no path to the key store. + + **Reason:** + + The Zaas Client configuration does not contain the path to the key store + + **Action:** + + Ensure that the configuration contains the keyStorePath and that it points to valid key store. + +### ZWEAS502E + + The configuration provided for SSL is invalid. + + **Reason:** + + The type of the keystore, truststore or the included keys/certs aren't considered valid + + **Action:** + + Ensure that the combination of the configuration is cryptographically valid. + +### ZWEAS503E + + The SSL configuration contained invalid path. + + **Reason:** + + There was an invalid path to either trust store or keystore + + **Action:** + + Ensure that both provided paths are resolved to valid trust store and valid key store + +## Discovery service messages + +### ZWEAD400E + + Cannot notify Gateway on '%s' about new instance '%s' + + **Reason:** + + The Discovery Service tried to notify the Gateway about an instance update, but the REST call failed. The purpose of this call is to update the Gateway caches. The Gateway might be down or a network problem occurred. + + **Action:** + + Ensure that there are no network issues and that the Gateway was not restarted. If the problem reoccurs, contact Broadcom support. + +### ZWEAD401E + + Cannot notify Gateway on '%s' about cancelled registration + + **Reason:** + + The Discovery Service tried to notify the Gateway about service un-registration, but the REST call failed. The purpose of this call is to update the Gateway caches. The Gateway might be down or a network problem occurred. + + **Action:** + + Ensure that there are no network issues and that the Gateway was not restarted. If the problem reoccurs, contact Broadcom support. + +### ZWEAD700W + + Static API definition directory '%s' is not a directory or does not exist + + **Reason:** + + One of the specified static API definition directories does not exist or is not a directory. + + **Action:** + + Review the static API definition directories and their setup. The static definition directories are specified as a launch parameter to a Discovery service jar. The property key is: `apiml.discovery.staticApiDefinitionsDirectories` + +### ZWEAD701E + + Error loading static API definition file '%s' + + **Reason:** + + A problem occurred while reading (IO operation) of a specific static API definition file. + + **Action:** + + Ensure that the file data is not corrupted or incorrectly encoded. + +### ZWEAD702W + + Unable to process static API definition data: '%s' - '%s' + + **Reason:** + + A problem occurred while parsing a static API definition file. + + **Action:** + + Review the mentioned static API definition file for errors. + Refer to the specific log message to determine the exact cause of the problem: + + - ServiceId is not defined in the file '%s'. The instance will not be created. Make sure to specify the ServiceId. + - The `instanceBaseUrls` parameter of %s is not defined. The instance will not be created. Make sure to specify the `InstanceBaseUrl` property. + - The API Catalog UI tile ID %s is invalid. The service %s will not have an API Catalog UI tile. Specify the correct catalog title ID. + - One of the instanceBaseUrl of %s is not defined. The instance will not be created. Make sure to specify the InstanceBaseUrl property. + - The URL %s does not contain a hostname. The instance of %s will not be created. The specified URL is malformed. Make sure to specify valid URL. + - The URL %s does not contain a port number. The instance of %s will not be created. + - The specified URL is missing a port number. Make sure to specify a valid URL. + - The URL %s is malformed. The instance of %s will not be created: The Specified URL is malformed. Make sure to specify a valid URL. + - The hostname of URL %s is unknown. The instance of %s will not be created: The specified hostname of the URL is invalid. Make sure to specify a valid hostname. + - Invalid protocol. The specified protocol of the URL is invalid. Make sure to specify valid protocol. + - Additional service metadata of %s in processing file %s could not be created: %s + +### ZWEAD703E + + A problem occurred during reading the static API definition directory: '%s' + + **Reason:** + + There are three possible causes of this error: + - The specified static API definition folder is empty. + - The definition does not denote a directory. + - An I/O error occurred while attempting to read the static API definition directory. + + **Action:** + + Review the static API definition directory definition and its contents on the storage. The static definition directories are specified as a parameter to launch a Discovery Service jar. The property key is: `apiml.discovery.staticApiDefinitionsDirectories` + +### ZWEAD704E + + Gateway Service is not available so it cannot be notified about changes in Discovery Service + + **Reason:** + + Gateway Service is probably mis-configured or failed to start from another reason. + + **Action:** + + Review the log of Gateway Service and its configuration. + +## Gateway service messages + +### ZWEAG500E + + Client certificate is missing in request. + + **Reason:** + + No client certificate is present in the HTTPS request. + + **Action:** + + Properly configure client to send client certificate. + +### ZWEAG700E + + No instance of the service '%s' found. Routing will not be available. + + **Reason:** + + The Gateway could not find an instance of the service from the Discovery Service. + + **Action:** + + Check that the service was successfully registered to the Discovery Service and wait for Spring Cloud to refresh the routes definitions. + +### ZWEAG701E + + Service '%s' does not allow encoded characters in the request path: '%s'. + + **Reason:** + + The request that was issued to the Gateway contains an encoded character in the URL path. The service that the request was addressing does not allow this pattern. + + **Action:** + + Contact the system administrator and request enablement of encoded characters in the service. + +### ZWEAG702E + + Gateway does not allow encoded slashes in request: '%s'. + + **Reason:** + + The request that was issued to the Gateway contains an encoded slash in the URL path. Gateway configuration does not allow this encoding in the URL. + + **Action:** + + Contact the system administrator and request enablement of encoded slashes in the Gateway. + +### ZWEAG704E + + Configuration error '%s' when trying to read the public and private key for signing JWT: %s + + **Reason:** + + A problem occurred while trying to read the certificate-key pair from the keystore. + + **Action:** + + Review the mandatory fields used in the configuration such as the keystore location path, the keystore and key password, and the keystore type. + +### ZWEAG705E + + Failed to load public or private key from key with alias '%s' in the keystore '%s'. Gateway is shutting down. + + **Reason:** + + Failed to load a public or private key from the keystore during JWT Token initialization. + + **Action:** + + Check that the key alias is specified and correct. Verify that the keys are present in the keystore. + +### ZWEAG706E + + RequestContext is not prepared for load balancing. + + **Reason:** + + Custom Ribbon load balancing is not in place before calling Ribbon. + + **Action:** + + Contact Broadcom support. + +### ZWEAG707E + + The request to the URL '%s' aborted without retrying on another instance. Caused by: %s + + **Reason:** + + The request to the server instance failed and will not be retried on another instance. + + **Action:** + + Refer to 'Caused by' details for troubleshooting. + +### ZWEAG708E + + The request to the URL '%s' failed after retrying on all known service instances. Caused by: %s + + **Reason:** + + Request to the server instance could not be executed on any known service instance. + + **Action:** + + Verify the status of the requested instance. + +### ZWEAG709E + + Service is not available at URL '%s'. Error returned: '%s' + + **Reason:** + + The service is not available. + + **Action:** + + Make sure that the service is running and is accessible by the URL provided in the message. + +### ZWEAG710E + + Load balancer does not have available server for client: %s + + **Reason:** + + The service is not available. It might be removed by the Circuit Breaker or by requesting specific instance that is not available. + + **Action:** + + Try the request later, or remove the request for the specific instance. + +### ZWEAG711E + + The principal '%s' is missing queried authorization. + + **Reason:** + + The principal does not have the queried access to the resource name within the resource class. + + **Action:** + + No action is needed. + +### ZWEAG712E + + The URI '%s' is an invalid format + + **Reason:** + + The URI does not follow the format `/{serviceId}/{type}/{version}/{endpoint}` or `/{type}/{version}/{serviceId}/{endpoint}`. + + **Action:** + + Use a properly formatted URI. + +### ZWEAG713E + + Configuration error when trying to establish JWT producer. Events: %s + + **Reason:** + + A problem occurred while trying to make sure that there is a valid JWT producer available. A possible cause of the problem is that API ML does not recognize the authentication type used by z/OSMF. + + **Action:** + + Based on the specific information in the message, verify that the key configuration is correct, or alternatively, that z/OSMF is available. If z/OSMF is available, specify the authentication type used by z/OSMF in your configuration settings. + + Use the following configuration format: + ``` + apiml: + security: + auth: + zosmf: + jwtAutoconfiguration: + ``` + Apply one of the following values: + + * **auto** + Signifies that API ML is enabled to resolve the JWT producer + + * **jwt** + Signifies that z/OSMF supports JWT (APAR PH12143 is applied) + + * **ltpa** + Signifies that z/OSMF does not support JWT + +### ZWEAG714E + + Unknown error occurred while retrieving the used public key + + **Reason:** + + An unknown problem occurred when retrieving the used public key. This should never occur. + + **Action:** + + Try again later. + +### ZWEAG715E + + The wrong amount of keys retrieved. The amount of retrieved keys is: %s + + **Reason:** + + There are too many keys in the JWK set. As such, it is not possible to choose the correct one. + + **Action:** + + Verify the configuration of the z/OSMF to make sure that z/OSMF provides only one used key. + +### ZWEAG716E + + The system does not know what key should be used. + + **Reason:** + + Typically z/OSMF is either unavailable or offline. + + **Action:** + + Verify that z/OSMF is available, accessible by the Gateway service, and online. + +### ZWEAG717E + + The service id provided is invalid: '%s' + + **Reason:** + + The provided id is not valid under the conformance criteria. + + **Action:** + + Verify the conformance criteria, provide valid service id. + +### ZWEAG718E + + Cannot retrieve metadata: '%s' + + **Reason:** + + Metadata are not accessible. + + **Action:** + + Verify that the metadata are accessible and not empty. + +### ZWEAG719I + + The service id provided is invalid: '%s' + + **Reason:** + + The provided service does not satisfy the conformance criteria and is therefore not valid. + + **Action:** + + Verify the conformance criteria, provide valid service id. + +### ZWEAG100E + + Authentication exception: '%s' for URL '%s' + + **Reason:** + + A generic failure occurred during authentication. + + **Action:** + + Refer to the specific authentication exception details for troubleshooting. + +### ZWEAG101E + + Authentication method '%s' is not supported for URL '%s' + + **Reason:** + + The HTTP request method is not supported by the URL. + + **Action:** + + Use the correct HTTP request method supported by the URL. + +### ZWEAG102E + + Token is not valid + + **Reason:** + + The JWT token is not valid. + + **Action:** + + Provide a valid token. + +### ZWEAG103E + + The token has expired + + **Reason:** + + The JWT token has expired. + + **Action:** + + Obtain a new token by performing an authentication request. + +### ZWEAG104E + + Authentication service is not available at URL '%s'. Error returned: '%s' + + **Reason:** + + The authentication service is not available. + + **Action:** + + Make sure that the authentication service is running and is accessible by the URL provided in the message. + +### ZWEAG105E + + Authentication is required for URL '%s' + + **Reason:** + + Authentication is required. + + **Action:** + + Provide valid authentication. + +### ZWEAG106W + + Login endpoint is running in dummy mode. Use credentials '%s'/'%s' to log in. Do not use this option in the production environment. + + **Reason:** + + The authentication is running in dummy mode. + + **Action:** + + Ensure that this option is not being used in a production environment. + +### ZWEAG107W + + Incorrect value: apiml.security.auth.provider = '%s'. The authentication provider is not set correctly. The default 'zosmf' authentication provider is being used. + + **Reason:** + + An incorrect value of the apiml.security.auth.provider parameter is set in the configuration. + + **Action:** + + Ensure that the value of apiml.security.auth.provider is set either to 'dummy' if you want to use dummy mode, or to 'zosmf' if you want to use the z/OSMF authentication provider. + +### ZWEAG108E + + z/OSMF instance '%s' not found or incorrectly configured. Gateway is shutting down. + + **Reason:** + + The Gateway could not find the z/OSMF instance from the Discovery Service or it could not communicate with the provided z/OSMF instance. + + **Action:** + + Ensure that the z/OSMF instance is configured correctly and that it is successfully registered to the Discovery Service and that the API Mediation Layer can communicate with the provided z/OSMF instance. The default timeout is 5 minutes. On a slower system, add the variable components.gateway.apiml.security.jwtInitializerTimeout:... and the value in minutes into Zowe's configuration to override this value. + +### ZWEAG109E + + z/OSMF response does not contain field '%s'. + + **Reason:** + + The z/OSMF domain cannot be read. + + **Action:** + + Review the z/OSMF domain value contained in the response received from the 'zosmf/info' REST endpoint. + +### ZWEAG110E + + Error parsing z/OSMF response. Error returned: '%s + + **Reason:** + + An error occurred while parsing the z/OSMF JSON response. + + **Action:** + + Check the JSON response received from the 'zosmf/info' REST endpoint. + +### ZWEAG120E + + Invalid username or password for URL '%s' + + **Reason:** + + The username and/or password are invalid. + + **Action:** + + Provide a valid username and password. + +### ZWEAG121E + + Authorization header is missing, or the request body is missing or invalid for URL '%s' + + **Reason:** + + The authorization header is missing, or the request body is missing or invalid. + + **Action:** + + Provide valid authentication. + +### ZWEAS123E + + Invalid token type in response from Authentication service. + + **Reason:** + + Could not retrieve the proper authentication token from the Authentication service response. + + **Action:** + + Review your APIML authentication provider configuration and ensure your Authentication service is working. + +### ZWEAG130E + + Token is not valid for URL '%s' + + **Reason:** + + The token is not valid. + + **Action:** + + Provide a valid token. + +### ZWEAG131E + + No authorization token provided for URL '%s' + + **Reason:** + + No authorization token is provided. + + **Action:** + + Provide a valid authorization token. + +### ZWEAG150E + + SAF IDT generation failed. Reason: %s + + **Reason:** + + An error occurred during SAF verification. Review the reason in the error message. + + **Action:** + + Verify the Identity Token configuration. + +### ZWEAG151E + + SAF IDT is not generated because authentication or authorization failed. Reason: %s + + **Reason:** + + The user credentials were rejected during SAF verification. Review the reason in the error message. + + **Action:** + + Provide a valid username and password. + +### ZWEAG160E + + No authentication provided in the request + + **Reason:** + + The JWT token or client certificate was not provided with the request + + **Action:** + + Configure your client to provide valid authentication. + +### ZWEAG161E + + No user was found + + **Reason:** + + It was not possible to map provided token or certificate to the mainframe identity. + + **Action:** + + Ask your security administrator to connect your token or client certificate with your mainframe user. + +### ZWEAG162E + + Gateway service failed to obtain token. + + **Reason:** + + Authentication request to get token failed. + + **Action:** + + Contact your administrator. + +### ZWEAG163E + + Error occurred while parsing X509 certificate. + + **Reason:** + + %s + + **Action:** + + Configure your client to provide valid x509 certificate. + +### ZWEAG164E + + Error occurred while validating X509 certificate. %s + + **Reason:** + + X509 certificate cannot be validated or the certificate cannot be used for client authentication. + + **Action:** + + Configure your client to provide valid x509 certificate. + +### ZWEAG165E + + X509 certificate is missing the client certificate extended usage definition + + **Reason:** + + X509 certificate cannot be used for client authentication. + + **Action:** + + Configure your client to provide valid x509 certificate. + +### ZWEAG166E + + ZOSMF authentication scheme is not supported for this API ML instance. + + **Reason:** + + z/OSMF is not used as security provider for API ML. + + **Action:** + + Contact your administrator. + +### ZWEAG167E + + No client certificate provided in the request + + **Reason:** + + The X509 client certificate was not provided with the request + + **Action:** + + Configure your client to provide valid certificate. + +### ZWEAG168E + + Invalid authentication provided in request + + **Reason:** + + The JWT token or client certificate is not valid + + **Action:** + + Configure your client to provide valid authentication. + +### ZWEAG169E + + Unexpected response from the external identity mapper. Status: %s body: %s + + **Reason:** + + The external identity mapper request failed with Internal Error + + **Action:** + + Verify that ZSS is responding. + +### ZWEAG170E + + Error occurred while trying to parse the response from the external identity mapper. Reason: %s + + **Reason:** + + The external identity mapper failed when trying to parse the response + + **Action:** + + Verify that the response is valid. + +### ZWEAG171E + + Configuration error. Failed to construct the external identity mapper URI. Reason: %s + + **Reason:** + + Failed to construct the external identity mapper URI + + **Action:** + + Verify that the external identity mapper URL specified in the configuration is valid. + +### ZWEAT607E + + Body in the revoke request is not valid. + + **Reason:** + + The request body is not valid + + **Action:** + + Use a valid body in the request. Format of a message: `{userId: string, (optional)timestamp: long}` or `{serviceId: string, (optional)timestamp: long}`. + +### ZWEAG180E + + There was an error while reading webfinger configuration + + **Reason:** + + Webfinger provider contains incorrect configuration. + + **Action:** + + Contact the administrator to validate webfinger configuration in gateway service. + +### ZWEAG181W + + z/OSMF service '%s' is either not registered or not online yet. + + **Reason:** + + z/OSMF service may not be properly onboarded to API ML. + + **Action:** + + Verify if z/OSMF is up and registered to Discovery Service. + +### ZWEAG182E + + SSL Misconfiguration, z/OSMF is not accessible. + Message: %s + Please verify the following: + - CN (Common Name) and z/OSMF hostname match. + - The certificate is valid + - TLS version matches + - z/OSMF server certificate is trusted in Zowe's truststore + Enable debugging to see further details in stack trace. + + **Reason:** + + The z/OSMF connection is incorrectly configured. + + **Action:** + + Verify z/OSMF connection details. Verify z/OSMF can be accessed with HTTPS. Configure sslDebug to see SSL debugging messages. + +### ZWEAG183E + + z/OSMF internal error + + **Reason:** + + z/OSMF returned HTTP Status %s. + + **Action:** + + Review z/OSMF status and availability. + +### ZWEAG184E + + Could not connect to z/OSMF: %s + + **Reason:** + + There was a connection issue between the API Mediation Layer instance and z/OSMF. + + **Action:** + + Verify z/OSMF is running. Verify connectivity to z/OSMF from this instance. + +### ZWEAG185W + + The change password endpoint has failed with code %s + + **Reason:** + + The change password endpoint was not found. + + **Action:** + + Ensure PTF for APAR PH34912 is applied. (https://www.ibm.com/support/pages/apar/PH34912) + +### ZWEAG186E + + z/OSMF internal error attempting password change: %s + + **Reason:** + + z/OSMF informed of an internal error. + + **Action:** + + Verify z/OSMF error log. + +### ZWEAG187W + + The check of z/OSMF JWT authentication endpoint has failed. Using z/OSMF info endpoint as backup. + + **Reason:** + + z/OSMF JWT endpoint was not found. + + **Action:** + + Ensure APAR PH12143 (https://www.ibm.com/support/pages/apar/PH12143) fix has been applied. + +### ZWEAG188W + + z/OSMF JWT builder endpoint call (%s) failed with %s + + **Reason:** + + z/OSMF returned an error code when calling JWT endpoint. + + **Action:** + + Review z/OSMF status. Contact your system administrator. + +## API Catalog messages + +### ZWEAC100W + + Could not retrieve information about service %s from the Discovery Service. Requested URL: %s. Response received: status code: %s, body: %s + + **Reason:** + + The response from The Discovery Service about the registered service instances returned an error or empty body. + + **Action:** + + Make sure the Discovery Service and requested service are up and running. If the HTTP response error code refers to a security issue, make sure that security configuration is correct. + +### ZWEAC101E + + Could not parse service info from discovery -- %s + + **Reason:** + + The response from the Discovery Service about the registered instances could not be parsed to extract applications. + + **Action:** + + Run debug mode and look at the Discovery Service potential issues while creating a response. If the Discovery Service does not indicate any error, create an issue. + +### ZWEAC102E + + Could not retrieve containers. Status: %s + + **Reason:** + + One or more containers could not be retrieved. + + **Action:** + + Check the status of the message for more information and the health of the Discovery Service. + +### ZWEAC103E + + API Documentation not retrieved, %s + + **Reason:** + + API documentation was not found. + + **Action:** + + Make sure the service documentation is configured correctly. + +### ZWEAC104E + + Could not retrieve container statuses, %s + + **Reason:** + + The status of one or more containers could not be retrieved. + + **Action:** + + Check the status of the message for more information and the health of the Discovery Service. + +### ZWEAC700E + + Failed to update cache with discovered services: '%s' + + **Reason:** + + Cache could not be updated. + + **Action:** + + Check the status of the Discovery Service. + +### ZWEAC701W + + API Catalog Instance not retrieved from Discovery service + + **Reason:** + + An error occurred while fetching containers information. + + **Action:** + + The jar file is not packaged correctly. Please submit an issue. + +### ZWEAC702E + + An unexpected exception occurred when trying to retrieve an API Catalog instance from the Discovery Service: %s + + **Reason:** + + An unexpected error occurred during API Catalog initialization. The API Catalog was trying to locate an instance of itself in the Discovery Service. + + **Action:** + + Review the specific message for more information. Verify if the Discovery Service and service registration work as expected. + +### ZWEAC703E + + Failed to initialize API Catalog with discovered services + + **Reason:** + + The API Catalog could not initialize running services after several retries. + + **Action:** + + Ensure services are started and discovered properly. + +### ZWEAC704E + + ApiDoc retrieval problem for '%s' service. %s + + **Reason:** + + ApiDoc for service could not be retrieved. + + **Action:** + + Verify that the service provides a valid ApiDoc. + +### ZWEAC705W + + The home page url for service %s was not transformed. %s + + **Reason:** + + The home page url for service was not transformed. The original url will be used. + + **Action:** + + Refer to the specific printed message. Possible causes include: + - The Gateway was not found. The Transform service cannot perform the request. Wait for the Gateway to be discovered. + - The URI is not valid. Ensure the service is providing a valid URL. + - Not able to select a route for the URL of the specific service. The original URL is used. If necessary, check the routing metadata of the service. + - The path of the service URL is not valid. Ensure the service is providing the correct path. + + +### ZWEAC706E + + Service not located, %s + + **Reason:** + + The service could not be found. + + **Action:** + + Check if the service is up and registered. If it is not registered, review the onboarding guide to ensure that all steps were completed. + +### ZWEAC707E + + Static API refresh failed, caused by exception: %s + + **Reason:** + + The Static API refresh could not be performed because of exception. + + **Action:** + + Check the specific exception for troubleshooting. + +### ZWEAC708E + + The API base path for service %s was not retrieved. %s + + **Reason:** + + The API base path for service was not retrieved. An empty path will be used. + + **Action:** + + Refer to the specific printed message. Possible causes include: + - The URI is not valid. Ensure the service is providing a valid URL. + - Not able to select a route for the URL of the specific service. The original URL is used. If necessary, check the routing metadata of the service. + - The path of the service URL is not valid. Ensure the service is providing the correct path. + + +### ZWEAC709E + + Static definition generation failed, caused by exception: %s + + **Reason:** + + The Static definition generation could not be performed because of exception. + + **Action:** + + Check the specific exception for troubleshooting. + diff --git a/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-apiml.md b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-apiml.md new file mode 100644 index 0000000000..782aa39bf9 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-apiml.md @@ -0,0 +1,363 @@ +# Troubleshooting Zowe API Mediation Layer + +As an API Mediation Layer user, you may encounter problems with how the API ML functions. This article presents known API ML issues and their solutions. + +:::note +To troubleshoot errors or warnings that can occur when configuring certificates, see the article [Troubleshooting certificate configuration](./troubleshoot-zos-certificate.md). +::: + +* [Install API ML without Certificate Setup](#install-api-ml-without-certificate-setup) +* [Enable API ML Debug Mode](#enable-api-ml-debug-mode) +* [Change the Log Level of Individual Code Components](#change-the-log-level-of-individual-code-components) +* [Debug and Fix Common Problems with SSL/TLS Setup](#debug-and-fix-common-problems-with-ssltls-setup) +* [Known Issues](#known-issues) + * [API ML stops accepting connections after z/OS TCP/IP stack is recycled](#api-ml-stops-accepting-connections-after-zos-tcpip-stack-is-recycled) + * [SEC0002 error when logging in to API Catalog](#sec0002-error-when-logging-in-to-api-catalog) + * [API ML throws I/O error on GET request and cannot connect to other services](#api-ml-throws-io-error-on-get-request-and-cannot-connect-to-other-services) + +## Install API ML without Certificate Setup + +For testing purposes, it is not necessary to set up certificates when configuring the API Mediation Layer. You can configure Zowe without certificate setup and run Zowe with `verify_certificates: DISABLED`. + +**Important:** For production environments, certificates are required. Ensure that certificates for each of the following services are issued by the Certificate Authority (CA) and that all keyrings contain the public part of the certificate for the relevant CA: +* z/OSMF +* Zowe +* The service that is onboarded to Zowe + +## Enable API ML Debug Mode + +Use debug mode to activate the following functions: + +- Display additional debug messages for API ML +- Enable changing log level for individual code components +- Gather atypical debug information + +When on z/OS, API ML log messages are written to the STC job log. + +**Important:** We highly recommend that you enable debug mode only when you want to troubleshoot issues. +Disable debug mode when you are not troubleshooting. Running in debug mode while operating API ML can adversely affect +its performance and create large log files that consume a large volume of disk space. + +**Follow these steps:** + +1. Open the file `zowe.yaml`. + +2. For each component, find the `components.*.debug` parameter and set the value to `true`: + + ``` + components.gateway.debug: true + ``` + By default, debug mode is disabled, and the `components.*.debug` is set to `false`. + +3. Restart Zowe™. + + You enabled debug mode for the API ML core services (API Catalog, API Gateway and Discovery Service). + +4. (Optional) Reproduce a bug that causes issues and review debug messages. If you are unable to resolve the issue, create an issue [here](https://github.com/zowe/api-layer/issues/). + +## Change the Log Level of Individual Code Components + +You can change the log level of a particular code component of the API ML internal service at run time. + +**Follow these steps:** + +1. Enable API ML Debug Mode as described in Enable API ML Debug Mode. +This activates the application/loggers endpoints in each API ML internal service (Gateway, Discovery Service, and Catalog). +2. List the available loggers of a service by issuing the **GET** request for the given service URL: + + ``` + GET scheme://hostname:port/application/loggers + ``` + - **scheme** + + Specifies the API ML service scheme (http or https) + + - **hostname** + + Specifies the API ML service hostname + + - **port** + + Specifies the TCP port where API ML service listens on. The port is defined by the configuration parameter MFS_GW_PORT for the Gateway, + MFS_DS_PORT for the Discovery Service (by default, set to gateway port + 1), and MFS_AC_PORT for the Catalog + (by default, set to gateway port + 2). + + **Note:** For the Catalog you can list the available loggers by issuing a **GET** request for the given service URL in the following format: + ``` + GET [gateway-scheme]://[gateway-hostname]:[gateway-port]/apicatalog/api/v1/application/loggers + ``` + + **Tip:** One way to issue REST calls is to use the http command in the free HTTPie tool: https://httpie.org/. + + **Example:** + + ``` + HTTPie command: + http GET https://lpar.ca.com:10000/application/loggers + + Output: + {"levels":["OFF","ERROR","WARN","INFO","DEBUG","TRACE"], + "loggers":{ + "ROOT":{"configuredLevel":"INFO","effectiveLevel":"INFO"}, + "com":{"configuredLevel":null,"effectiveLevel":"INFO"}, + "com.ca":{"configuredLevel":null,"effectiveLevel":"INFO"}, + ... + } + } + ``` + +3. Alternatively, extract the configuration of a specific logger using the extended **GET** request: + + ``` + GET scheme://hostname:port/application/loggers/{name} + ``` + + - **\{name\}** + + Specifies the logger name + +4. Change the log level of the given component of the API ML internal service. Use the **POST** request for the given service URL: + + ``` + POST scheme://hostname:port/application/loggers/{name} + ``` + The **POST** request requires a new log level parameter value that is provided in the request body: + ``` + { + + "configuredLevel": "level" + + } + ``` + + - **level** + + Specifies the new log level: **OFF**, **ERROR**, **WARN**, **INFO**, **DEBUG**, **TRACE** + + **Example:** + + ``` + http POST https://hostname:port/application/loggers/org.zowe.apiml.enable.model configuredLevel=WARN + ``` + +### Gather atypical debug informaiton + +* **ZWE_configs_debug** +This property can be used to unconditionally add active debug profiles. + +For more information, see [Adding active profiles](https://docs.spring.io/spring-boot/docs/1.2.0.M1/reference/html/boot-features-profiles.html#boot-features-adding-active-profiles) in the Spring documentation. + +* **ZWE_configs_sslDebug** +This property can be used to enable the SSL debugging. This property can also assist with determining what exactly is happening at the SSL layer. + +This property uses the `-Djavax.net.debug` Java parameter when starting the Gateway component. By setting `ZWE_configs_sslDebug` to `ssl`, all SSL debugging is turned on. The `ZWE_configs_sslDebug` parameter also accepts other values that can enable a different level of tracing. + +For more information, see the article **_Debugging Utilities_** in the IBM documentation. + +:::note +This property can also be enabled for other API ML components. +::: + +## Debug and Fix Common Problems with SSL/TLS Setup + +Review tips described in the blog post [Troubleshooting SSL/TLS setup with Zowe Certificate Analyzer](https://medium.com/zowe/troubleshooting-ssl-tls-setup-with-zowe-certificate-analyser-31aeec9e1144) to find out how you can use the Zowe Certificate Analyzer to address the following common issues with SSL/TLS setup: + +* How to verify if the API ML server certificate is trusted by your service +* How to get a CA certificate in the correct format +* How to perform a TLS handshake with debug logs +* How to debug remote services +* How to enable mutual authentication using a client certificate +* How to add a trusted certificate to a SAF Key ring + +## Known Issues + +### API ML stops accepting connections after z/OS TCP/IP stack is recycled + +**Symptom:** + +When z/OS TCP/IP stack is restarted, it is possible that the internal services of API Mediation Layer +(Gateway, Catalog, and Discovery Service) stop accepting all incoming connections, go into a continuous loop, +and write numerous error messages in the log. + +**Sample message:** + +The following message is a typical error message displayed in STDOUT: + +``` +2018-Sep-12 12:17:22.850. org.apache.tomcat.util.net.NioEndpoint -- Socket accept failed java.io.IOException: EDC5122I Input/output error. + +.at sun.nio.ch.ServerSocketChannelImpl.accept0(Native Method) ~.na:1.8.0. +.at sun.nio.ch.ServerSocketChannelImpl.accept(ServerSocketChannelImpl.java:478) ~.na:1.8.0. +.at sun.nio.ch.ServerSocketChannelImpl.accept(ServerSocketChannelImpl.java:287) ~.na:1.8.0. +.at org.apache.tomcat.util.net.NioEndpoint$Acceptor.run(NioEndpoint.java:455) ~.tomcat-coyote-8.5.29.jar!/:8.5.29. +.at java.lang.Thread.run(Thread.java:811) .na:2.9 (12-15-2017). +``` +**Solution:** + +Restart API Mediation Layer. + +**Tip:** To prevent this issue from occurring, it is strongly recommended not to restart the TCP/IP stack while API ML is running. + +### SEC0002 error when logging in to API Catalog + +SEC0002 error typically appears when users fail to log in to API Catalog. The following image shows the API Catalog login page with the SEC0002 error. + +SEC0002 Error + +The error is caused by failed z/OSMF authentication. To determine the reason authentication failed, open the ZWESLSTC joblog and look for a message that contains `ZosmfAuthenticationProvider`. The following is an example of the message that contains `ZosmfAuthenticationProvider`: + +``` +2019-08-05 11:25:03.431 ERROR 5 --- .0.0-7552-exec-3. c.c.m.s.l.ZosmfAuthenticationProvider : Can not access z/OSMF service. Uri 'https://ABC12.slv.broadcom.net:1443' returned: I/O error on GET request for "https://ABC12.slv.broadcom.net:1443/zosmf/info": ... +``` + +Check the rest of the message, and identify the cause of the problem. The following list provides the possible reasons and solutions for the z/OSMF authentication issue: + +- [Connection refused](#connection-refused) +- [Configure z/OSMF](#configure-zosmf) +- [Missing z/OSMF host name in subject alternative names](#missing-z-osmf-host-name-in-subject-alternative-names) +- [Invalid z/OSMF host name in subject alternative names](#invalid-z-osmf-host-name-in-subject-alternative-names) +- [Secure Fix](#secure-fix) +- [Insecure Fix](#insecure-fix) +- [Invalid z/OSMF host name in subject alternative names](#invalid-zosmf-host-name-in-subject-alternative-names) +- [Request a new certificate](#request-a-new-certificate) +- [Re-create the Zowe keystore](#re-create-the-zowe-keystore) + +#### Connection refused + +In the following message, failure to connect to API Catalog occurs when connection is refused: + +``` +Connect to ABC12.slv.broadcom.net:1443 .ABC12.slv.broadcom.net/127.0.0.1. failed: EDC8128I Connection refused.; nested exception is org.apache.http.conn.HttpHostConnectException: +``` +The reason for the refused connection message is either invalid z/OSMF configuration or z/OSMF being unavailable. The preceding message indicates that z/OSMF is not on the 127.0.0.1:1443 interface. + +**Solution:** + +#### Configure z/OSMF + +Make sure that z/OSMF is running and is on 127.0.0.1:1443 interface, and try to log in to API Catalog again. If you get the same error message, change z/OSMF configuration. + +**Follow these steps:** + +1. Locate the z/OSMF PARMLIB member IZUPRMxx. + + For example, locate IZUPRM00 member in SYS1.PARMLIB. + +2. Change the current `HOSTNAME` configuration to `HOSTNAME('*')`. +3. Change the current `HTTP_SSL_PORT` configuration to `HTTP_SSL_PORT('1443')`. + + **Important!** If you change the port in the z/OSMF configuration file, all your applications lose connection to z/OSMF. + +For more information, see [Syntax rules for IZUPRMxx](https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.izua300/izuconfig_IZUPRMxx.htm). + +If changing the z/OSMF configuration does not fix the issue, reconfigure Zowe. + +**Follow these steps:** + +1. Open `.zowe_profile` in the home directory of the user who installed Zowe. +2. Modify the value of the `ZOWE_ZOSMF_PORT` variable. +3. Reinstall Zowe. + + +#### Missing z/OSMF host name in subject alternative names + +In following message, failure to connect to API Catalog is caused by a missing z/OSMF host name in the subject alternative names: + +``` +Certificate for doesn't match any of the subject alternative names: ..; nested exception is javax.net.ssl.SSLPeerUnverifiedException: Certificate for doesn't match any of the subject alternative names: .. +``` + +**Solutions:** + +Fix the missing z/OSMF host name in subject alternative names using the following methods: + +**Note:** Apply the insecure fix only if you use API Catalog for testing purposes. + +- [Secure fix](#Secure-fix) +- [Insecure fix](#insecure-fix) + +#### Secure fix + +**Follow these steps:** + +1. Obtain a valid certificate for z/OSMF and place it in the z/OSMF keyring. For more information, see [Configure the z/OSMF Keyring and Certificate](https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.izua300/izuconfig_KeyringAndCertificate.htm). +2. Re-create the Zowe keystore by deleting it and re-creating it. For more information, see [Zowe certificate configuration overview](../user-guide/configure-certificates.md) and the corresponding sub-articles in this section. The Zowe keystore directory is the value of the `KEYSTORE_DIRECTORY` variable in the `zowe.yaml` file that is used to launch Zowe. + +#### Insecure fix + +**Follow these steps:** + +1. Re-create the Zowe keystore by deleting it and re-creating it. +2. In the `zowe-setup-certificates.env` file that is used to generate the keystore, ensure that the property `VERIFY_CERTIFICATES` and `NONSTRICT_VERIFY_CERTIFICATES` are set to `false`. + +**Important!** Disabling `VERIFY_CERTIFICATES` or `NONSTRICT_VERIFY_CERTIFICATES` may expose your server to security risks. Ensure that you contact your system administrator before disabling these certificates and use these options only for troubleshooting purposes. + +#### Invalid z/OSMF host name in subject alternative names + +In the following message, failure to connect to API Catalog is caused by an invalid z/OSMF host name in the subject alternative names: + +``` +Certificate for doesn't match any of the subject alternative names: [abc12.ca.com, abc12, localhost, abc12-slck, abc12-slck.ca.com, abc12-slck1, abc12-slck1.ca.com, abc12-slck2, abc12-slck2.ca.com, usilabc12, usilabc12.ca.com]; +nested exception is javax.net.ssl.SSLPeerUnverifiedException: Certificate for doesn't match any of the subject alternative names: [abc12.ca.com, abc12, localhost, abc12-slck, abc12-slck.ca.com, abc12-slck1, abc12-slck1.ca.com, abc12-slck2, abc12-slck2.ca.com, usilabc12, usilabc12.ca.com] +``` + +**Solutions:** + +Fix the invalid z/OSMF host name in the subject alternative names using the following methods: + +- [Request a new certificate](#request-a-new-certificate) +- [Re-create the Zowe keystore](#re-create-the-zowe-keystore) + +#### Request a new certificate + +Request a new certificate that contains a valid z/OSMF host name in the subject alternative names. + +#### Re-create the Zowe keystore + +Re-create the Zowe keystore by deleting it and re-creating it. For more information, see [Configuring PKCS12 certificates](../user-guide/configure-certificates.md/#pkcs12-certificates-in-a-keystore). The Zowe keystore directory is the value of the `KEYSTORE_DIRECTORY` variable in the `zowe.yaml` file that is used to launch Zowe. + +### API ML throws I/O error on GET request and cannot connect to other services + +**Symptom:** + +The API ML services are running but they are in the DOWN state and not working properly. The following exceptions can be found in the log: `java.net.UnknownHostException` and `java.net.NoRouteToHostException`. + +**Sample message:** + +See the following message for full exceptions. + +``` +org.springframework.web.client.ResourceAccessException: I/O error on GET request for "https://USILCA32.lvn.broadcom.net:7553/eureka/apps/apicatalog": USILCA32.lvn.broadcom.net; nested exception is java.net.UnknownHostException: USILCA32.lvn.broadcom.net + +.at org.springframework.web.client.RestTemplate.doExecute(RestTemplate.java:732) ~Ýspring-web-5.0.8.RELEASE.jar!/:5.0.8.RELEASE¨ + +.at org.springframework.web.client.RestTemplate.execute(RestTemplate.java:680) ~Ýspring-web-5.0.8.RELEASE.jar!/:5.0.8.RELEASE¨ + +.at org.springframework.web.client.RestTemplate.exchange(RestTemplate.java:600) ~Ýspring-web-5.0.8.RELEASE.jar!/:5.0.8.RELEASE¨ + +.at com.ca.mfaas.apicatalog.services.initialisation.InstanceRetrievalService.queryDiscoveryForInstances(InstanceRetrievalService.java:276) Ýclasses!/:na¨ + +.at com.ca.mfaas.apicatalog.services.initialisation.InstanceRetrievalService.getInstanceInfo(InstanceRetrievalService.java:158) Ýclasses!/:na¨ + +.at com.ca.mfaas.apicatalog.services.initialisation.InstanceRetrievalService.retrieveAndRegisterAllInstancesWithCatalog(InstanceRetrievalService.java:90) Ýclas + +…. + +main¨ o.a.http.impl.client.DefaultHttpClient : I/O exception (java.net.NoRouteToHostException) caught when connecting to {s}->https://localhost:7553: EDC8130I Host cannot be reached. (Host unreachable) + +main¨ o.a.http.impl.client.DefaultHttpClient : Retrying connect to {s}->https://localhost:7553 +``` + +**Solution:** + +The Zowe started task needs to run under a user with sufficient privileges. As a workaround, you can try to run the started task under the same user ID as z/OSMF (typically IZUSVR). + +The hostname that is displayed in the details of the exception is a valid hostname. You can validate that the hostname is valid by using `ping` command on the same mainframe system. For example, `ping USILCA32.lvn.broadcom.net`. If it is valid, then the problem can be caused by insufficient privileges of your started task that is not allowed to do network access. + +You can fix it by setting up the security environment as described in the [Zowe documentation](../user-guide/configure-zos-system#configure-security-environment-switching). + + + + + + diff --git a/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-check-your-zowe-version.md b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-check-your-zowe-version.md new file mode 100644 index 0000000000..c1bdb2b8b5 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-check-your-zowe-version.md @@ -0,0 +1,112 @@ +# Checking your Zowe version release number + +Once Zowe is installed and running, you will likely update Zowe and Zowe plug-ins regularly as new major and minor releases come out. + +To keep track of which release is running as you troubleshoot an issue, the commands and file listed here can help. + +## Server side + +To see the version of a Zowe release, run the `zwe version` command in USS: + +```shell +zwe version +``` + +The `zwe version` command returns a single line with the Zowe release number: +``` +Zowe v2.0.0 +``` +### Using other commands + +Add the `debug` or `trace` options to the `zwe version` command to show more information. + +Using the `debug` mode: + +``` +zwe version --debug +Zowe v2.9.0 +build and hash: v2.x/master#3248 (77fe6c5277e52474ebe9258c1b745949537dc398) +``` +The `debug` mode shows the unique build identifier for the installed version of Zowe. Run this when you want to replicate a bug for testing or troubleshooting. + +Using the `trace` mode: +``` +zwe version --trace +Zowe v2.9.0 +build and hash: v2.x/master#3248 (77fe6c5277e52474ebe9258c1b745949537dc398) +Zowe directory: /SYSTEM/zowe/runtime +``` +The `trace` mode shows the location where the convenience build was extracted (such as ``). Run this when you want to confirm the location of your Zowe runtime directory. + +### Using the `manifest` file + +Find the version number of your Zowe release in the `manifest.json` file. + +1. Extract the PAX file for the [Zowe convenience build](../user-guide/install-zowe-zos-convenience-build.md) to ``. +2. Navigate to `` to locate the `manifest.json` file. +3. Open the `manifest.json` file. + + The Zowe version is listed at the beginning of the file: + ``` + { + "name": "Zowe", + "version": "2.10.0", + "description": "Zowe is an open source project ... + ``` + +## Client side + +### Zowe CLI + +1. Open the Zowe CLI. + +2. Run the following command: + + ``` + zowe –-version + ``` + + The Zowe CLI version number is returned. + +### Zowe CLI plug-ins + +1. Open the Zowe CLI. + +2. Run the following command: + ``` + zowe plugins list –-short + ``` + + A list of the installed Zowe CLI plug-ins are returned, along with the version number for each plug-in. + +### Zowe Explorer for Visual Studio Code + +1. Open Visual Studio Code and click the **Extensions** icon. + + The **Extensions Side Bar** displays. +2. In the **Search** bar, enter `Zowe Explorer`. +3. In the **Side Bar**, select `Zowe Explorer` from the search results. + + An **Editor** tab displays the Zowe Explorer marketplace details. The version number is located next to the Zowe Explorer name. + +### Zowe Explorer for Visual Studio Code Extensions + +1. Open Visual Studio Code and click the **Extensions** icon. + + The **Extensions Side Bar** displays. +2. In the **Search** bar, enter the name of the Zowe Explorer extension. +3. In the **Side Bar**, select the entered Zowe Explorer extension from the search results. + + An **Editor** tab displays the Zowe Explorer extension's marketplace details. The version number is located next to the Zowe Explorer extension's name. + +### Zowe IntelliJ Plug-in + +1. Open the **File** menu and click **Settings**. + + The **Settings** window opens. +2. Click **Plugins**, then click **Installed** tab. + + A list of the installed extensions displays. +3. Search for, and select, `Zowe Explorer`. + + The Zowe Explorer marketplace details display on the right side of the window. The version number is located adjacent to the Zowe Explorer name. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-intellij.md b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-intellij.md new file mode 100644 index 0000000000..59f7107f2a --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-intellij.md @@ -0,0 +1,10 @@ +# Troubleshooting Zowe IntelliJ plug-in + +As a Zowe IntelliJ plug-in user, you may encounter problems with how the plug-in functions. + +Before reaching out for support, + +1. Is there already a GitHub issue (open or closed) that covers the problem? Check [Zowe IntelliJ plug-in Issues](https://github.com/zowe/zowe-explorer-intellij/issues). +2. Try searching using the Zowe Docs search bar. + +When necessary, you can use [the Slack channel](https://openmainframeproject.slack.com/archives/C020BGPSU0M) to reach the Zowe IntelliJ squad for assistance. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-zos-certificate.md b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-zos-certificate.md new file mode 100644 index 0000000000..2ba1a9a87f --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-zos-certificate.md @@ -0,0 +1,371 @@ +# Troubleshooting certificate configuration + +As an API Mediation Layer user, you may encounter problems when configuring certificates. Review the following article to troubleshoot errors or warnings that can occur when configuring certificates. + +* [PKCS12 server keystore generation fails in Java 8 SR7FP15, SR7 FP16, and SR7 FP20](#pkcs12-server-keystore-generation-fails-in-java-8-sr7fp15-sr7-fp16-and-sr7-fp20) +* [Eureka request failed when using entrusted signed z/OSMF certificate](#eureka-request-failed-when-using-entrusted-signed-zosmf-certificate) +* [Zowe startup fails with empty password field in the keyring setup](#zowe-startup-fails-with-empty-password-field-in-the-keyring-setup) +* [Certificate error when using both an external certificate and Single Sign-On to deploy Zowe](#certificate-error-when-using-both-an-external-certificate-and-single-sign-on-to-deploy-zowe) +* [Browser unable to connect due to a CIPHER error](#browser-unable-to-connect-due-to-a-cipher-error) +* [API Components unable to handshake](#api-components-unable-to-handshake) +* [Java z/OS components of Zowe unable to read certificates from keyring](#java-zos-components-of-zowe-unable-to-read-certificates-from-keyring) +* [Java z/OS components of Zowe cannot load the certificate private key pair from the keyring](#java-zos-components-of-zowe-cannot-load-the-certificate-private-key-pair-from-the-keyring) +* [Exception thrown when reading SAF keyring \{ZWED0148E\}](#exception-thrown-when-reading-saf-keyring-zwed0148e) +* [ZWEAM400E Error initializing SSL Context when using Java 11](#zweam400e-error-initializing-ssl-context-when-using-java-11) +* [Failed to load JCERACFKS keyring when using Java 11](#failed-to-load-jceracfks-keyring-when-using-java-11) + +## PKCS12 server keystore generation fails in Java 8 SR7FP15, SR7 FP16, and SR7 FP20 + +**Symptoms** + +Some Zowe Desktop applications do not work when Zowe creates a PKCS12 keystore. A message may appear in the log such as the following: +* ZWES1060W Failed to init TLS environment, rc=1(Handle is not valid) +* ZWES1065E Failed to configure https server. Check agent https setting. + +These messages indicate that ZSS cannot read the generated keystore. As such, parts of Zowe are not functional. + +**Solutions** + +This error results from the incompatibility between Java and GSK regarding cryptography. + +Try one of the following options if you are affected by this error: + +- Temporarily downgrade Java, for example to Java 8 SR7FP10, and generate the PKCS12 keystore again. + +- Upgrade Zowe to a later version 2.11.0 or a newer version in which this issue is fixed. + +:::note +* This error will not occur if you already have an existing keystore created with a proper Java version, or are using keyrings. +* If you do not plan to use Zowe Desktop, you can disable the ZSS component to avoid receiving ZSS component errors in the log. +::: + +## Eureka request failed when using entrusted signed z/OSMF certificate + +**Symptoms** + +A problem may occur when using the entrusted signed z/OSMF certificate, whereby the ZLUX AppServer cannot register with Eureka. Logs indicate that the cause is the self-signed certificate: + +``` + ZWESVUSR WARN (_zsf.bootstrap,webserver.js:156) ZWED0148E - Exception thrown when reading SAF keyring, e= Error: R_datalib call failed: function code: 01, SAF rc: 8, RACF rc: 8, RACF rsn: 44 +``` + +**Solution** + +The error indicates that the keyring does not exist or cannot be found. + +Review the keyring information and confirm the corresponding certificate authorities. Ensure that you specify the `certificateAuthorities` variable with the correct keyring label, and the label of the connected CA in the `zowe.certificate` section of your `zowe.yaml` file. + +For example, if the keyring label is `ZoweKeyring` and the LABLCERT of the connected CA is `CA Internal Cert`, the `certificateAuthorities` variable should be `certificateAuthorities: safkeyring://ZWESVUSR/ZoweKeyring&CA Internal Cert`. + +## Zowe startup fails with empty password field in the keyring setup + +**Symptoms** + +The certificate appears to be correct, but the Gateway and the Discovery Service fail during start. The setup of the keyring certificate does not require a value for `password` in the `zowe.certificate.keystore.password` and `zowe.certificate.truststore.password`. + +**Solution** + +The password is only used for USS PKCS12 certificate files. The keyring is protected by SAF permissions. Note that in some configurations, Zowe does not work if the password value is empty in the keyring configuration. We recommended that you assign a value to `password` as shown in the following example: + +**Example:** +``` +certificate: + keystore: + type: JCERACFKS + file: safkeyring:////ZWESVUSR/ZWEKeyring + password: password + alias: ZoweCert + truststore: + type: JCERACFKS + file: safkeyring:////ZWESVUSR/ZWEKeyring + password: password + pem: + key: + certificate: + certificateAuthorities: safkeyring:////ZWESVUSR/ZWEKeyring&zoweCA +``` + +## Certificate error when using both an external certificate and Single Sign-On to deploy Zowe + +**Symptom:** + +You used an external certificate and Single Sign-On to deploy Zowe. When you log in to the Zowe Desktop, you encounter an error similar to the following: + +``` +2020-07-28 02:13:43.203 IZUSVR WARN (org.zowe.zlux.auth.safsso,apimlHandler.js:263) APIML query error: self signed certificate in certificate chain +2020-07-28 02:13:43.288 IZUSVR WARN (org.zowe.zlux.auth.safsso,apimlHandler.js:337) APIML login has failed: +2020-07-28 02:13:43.288 IZUSVR WARN (org.zowe.zlux.auth.safsso,apimlHandler.js:338) Error: self signed certificate in certificate chain + at TLSSocket.onConnectSecure (_tls_wrap.js:1321:34) + at TLSSocket.emit (events.js:210:5) + at TLSSocket._finishInit (_tls_wrap.js:794:8) + at TLSWrap.ssl.onhandshakedone (_tls_wrap.js:608:12) { + code: 'SELF_SIGNED_CERT_IN_CHAIN' +} +``` + +**Solution:** + +This issue might occur when you use a Zowe version of 1.12.0 or later. To resolve the issue, you can download your external root certificate and intermediate certificates in PEM format. Then, add the following parameter in the `zowe.yaml` file. + +```environments.ZWED_node_https_certificateAuthorities: "/path/to/zowe/keystore/local_ca/localca.cer-ebcdic","/path/to/carootcert.pem","/path/to/caintermediatecert.pem"``` + +Recycle your Zowe server. You should be able to log in to the Zowe Desktop successfully now. + +## Browser unable to connect due to a CIPHER error + +**Symptom:** + +When connecting to the API Mediation Layer, the web browser throws an error saying that the site is unable to provide a secure connection because of an error with ciphers. + +The error shown varies depending on the browser. For example, + +- For Google Chrome: + + CIPHER_MISMATCH + +- For Mozilla Firefox: + + CIPHER_OVERLAP + +**Solution:** + +Remove `GCM` as a disabled `TLS` algorithm from the Java runtime being used by Zowe. + +To do this, first locate the `$JAVA_HOME/lib/security/java.security` file. You can find the value of `$JAVA_HOME` in one of the following ways. + +- Method 1: By looking at the `java.home` value in the `zowe.yaml` file used to start Zowe. + + For example, if the `zowe.yaml` file contains the following line, + + ``` + java.home: `/usr/lpp/java/J8.0_64/ + ``` + + then, the `$JAVA_HOME/lib/security/java.security` file will be `/usr/lpp/java/J8.0_64/lib/security/java.security`. + +- Method 2: By inspecting the `STDOUT` JES spool file for the `ZWESLSTC` started task that launches the API Mediation Layer. + + +In the `java.security` file, there is a parameter value for `jdk.tls.disabledAlgorithms`. + +**Example:** + +``` +jdk.tls.disabledAlgorithms=SSLv3, RC4, MD5withRSA, DH keySize < 1024, 3DES_EDE_CBC, DESede, EC keySize < 224, GCM +``` + +**Note:** This line may have a continuation character `\` and be split across two lines due to its length. + +Edit the parameter value for `jdk.tls.disabledAlgorithms` to remove `GCM`. If, as shown in the previous example, the line ends `<224, GCM`, remove the preceding comma so the values remain as a well-formed list of comma-separated algorithms: + +**Example:** + +``` +jdk.tls.disabledAlgorithms=SSLv3, RC4, MD5withRSA, DH keySize < 1024, 3DES_EDE_CBC, DESede, EC keySize < 224 +``` + +**Note:** The file permissions of `java.security` might be restricted for privileged users at most z/OS sites. + +After you remove `GCM`, restart the `ZWESLSTC` started task for the change to take effect. + +## API Components unable to handshake + +**Symptom:** + +The API Mediation Layer address spaces ZWE1AG, ZWE1AC and ZWE1AD start successfully and are visible in SDSF, +however they are unable to communicate with each other. + +Externally, the status of the API Gateway homepage displays **!** icons against the API Catalog, Discovery Service and Authentication Service (shown on the left side image below) + which do not progress to green tick icons as normally occurs during successful startup (shown on the right side image below). + +Zowe API Mediation Layer Startup + +The Zowe desktop is able to start but logon fails. + +The log contains messages to indicate that connections are being reset. For example, the following message shows that the API Gateway `ZWEAG` is unable to connect to the API Discovery service, by default 7553. + +``` + ZWESVUSR INFO (o.a.h.i.c.DefaultHttpClient) I/O exception (java.net.SocketException) caught when connecting to {s}->https://:: Connection reset +2021-01-26 15:21:43.302 ZWESVUSR DEBUG (o.a.h.i.c.DefaultHttpClient) Connection reset +java.net.SocketException: Connection reset +``` + +The Zowe desktop is able to be displayed in a browser but fails to logon. + +**Solution:** + +Check that the Zowe certificate has been configured as a client certificate, and not just as a server certificate. For more informtion, see More detail can be found in [Configuring certificates overview](../user-guide/configure-certificates). + +## Java z/OS components of Zowe unable to read certificates from keyring + +**Symptom:** + +Java z/OS components of Zowe are unable to read certificates from a keyring. This problem may appear as an error as in the following example where Java treats the SAF keyring as a file. + +**Example:** +``` +Caused by: java.io.FileNotFoundException: safkeyring:/ZWESVUSR/ZoweKeyring +at java.io.FileInputStream.open(FileInputStream.java:212) +at java.io.FileInputStream.(FileInputStream.java:152) +at java.io.FileInputStream.(FileInputStream.java:104) +at com.ibm.jsse2.be$p$a.a(be$p$a.java:1) +at com.ibm.jsse2.be$p$a.run(be$p$a.java:2) +``` + +**Solution:** + +Apply the following APAR to address this issue: + +* [APAR IJ31756](https://www.ibm.com/support/pages/apar/IJ31756) + +## Java z/OS components of Zowe cannot load the certificate private key pair from the keyring + +**Symptom:** + +API ML components configured with SAF keyring are not able to start due to an unrecoverable exception. The exception message notifies the user that the private key is not properly padded. + +**Example:** +``` +Caused by: java.security.UnrecoverableKeyException: Given final block not properly padded + at com.ibm.crypto.provider.I.a(Unknown Source) + at com.ibm.crypto.provider.JceRACFKeyStore.engineGetKey(Unknown Source) + at java.security.KeyStore.getKey(KeyStore.java:1034) + at org.apache.tomcat.util.net.SSLUtilBase.getKeyManagers(SSLUtilBase.java:354) + at org.apache.tomcat.util.net.SSLUtilBase.createSSLContext(SSLUtilBase.java:247) + at org.apache.tomcat.util.net.AbstractJsseEndpoint.createSSLContext(AbstractJsseEndpoint.java:105) +``` + +**Solution:** + +Make sure that the private key stored in the keyring is not encrypted by a password, or that the private key integrity is not protected by a password. This is not related to SAF keyrings themselves, which are not usually protected by password, but rather to is related to the concrete certificate private key pair stored in the SAF keyring. + +## Exception thrown when reading SAF keyring \{ZWED0148E\} + +**Symptom:** + +If you see one or more of the following messages in the logs, the cause is keyring configuration. + + +- ZWED0148E - Exception thrown when reading SAF keyring, e= Error: R_datalib call failed: function code: 01, SAF rc: `number`, RACF rc: `number`, RACF rsn: `number` + + +* java.io.IOException: R_datalib (IRRSDL00) error: profile for ring not found (`number`, `number`, `number`) + +You may also see the following log message: + +`ZWES1060W Failed to init TLS environment, rc=1(Handle is not valid)` + + **Note:** This log message can have other causes too, such as lack of READ permission to resources in the CRYPTOZ class. + +**Solution:** + +1. Refer to table 2 (DataGetFirst) of the [Return and Reason Codes](https://www.ibm.com/docs/en/zos/2.5.0?topic=library-return-reason-codes) to determine the specific problem. +2. Check your keyring (such as with a LISTRING command) and your zowe configuration file's `zowe.certificate` section to spot and resolve the issue. + +**Example:** + If ZWED0148E contains the following message, it indicates that Zowe's local certificate authority (local CA) `ZoweCert`, the certificate `jwtsecret`, or the Zowe certificate `localhost` does not exist in the Zowe keyring. + +``` +2021-01-18 10:16:33.601 ZWESVUSR WARN (_zsf.bootstrap,webserver.js:156) ZWED0148E - Exception thrown when reading SAF keyring, e= TypeError: R_datalib call failed: function code: 01, SAF rc: 8, RACF rc: 8, RACF rsn: 44 +at Object.getPemEncodedData (/software/zowev15/1.15.0/components/app-server/share/zlux-server-framework/node_modules/keyring_js/index.js:21:26) +``` + +Zowe's local CA certificate has its default name `ZoweCert`. Zowe Desktop hardcodes this certificate in the configuration scripts. + +If you are using your own trusted CA certificate in the keyring, and the name is different from the default one, this error will occur. To resolve the issue, you must match the names in the [Zowe configuration](../user-guide/configure-certificates). + +If you are using Zowe's local CA certificate and you still receive **ZWED0148E**, you may find the following message in the same log. + +``` + "https": { + "ipAddresses": [ + "0.0.0.0" + ], + "port": 8544, + "keys": [ + "safkeyring://ZWESVUSR/ring&Label A" + ], + "certificates": [ + "safkeyring://ZWESVUSR/ring&Label A" + ], + "certificateAuthorities": [ + "safkeyring://ZWESVUSR/ring&Label B", + "safkeyring://ZWESVUSR/ring&Label B" + ] + }, +``` + +In this case, ensure that the label names exactly match the names in TSO when confirming your keyring. Any difference in spaces, capitalization, or other places throw the error. + +## ZWEAM400E Error initializing SSL Context when using Java 11 + +**Symptom:** + +API ML components configured with SAF keyring are not able to start due to an unrecoverable exception. The message indicates that `safkeyring` is an unknown protocol. + +**Examples:** +``` +2023-06-27 13:07:04.493 ZWESVUSR ERROR (o.z.a.s.HttpsFactory) error java.net.MalformedURLException: unknown protocol: safkeyring +.at java.base/java.net.URL.(URL.java:652) +.at java.base/java.net.URL.(URL.java:541) +.at java.base/java.net.URL.(URL.java:488) +.at org.zowe.apiml.security.SecurityUtils.keyRingUrl(SecurityUtils.java:246) +... +``` +``` +2023-06-27 13:07:04.528 ZWESVUSR ERROR (o.z.a.s.HttpsFactory) ZWEAM400E Error initializing SSL Context: 'unknown protocol: safkeyring' +``` + +**Solution:** + +Starting with Java 11, the safkeyring URLs are dependent on the type of RACF keystore as presented in the following table. + +| URL | Keystore | +|------|---------| +| JCECCARACFKS | `safkeyringjcecca://ZWESVUSR/ZOWERING` | +| JCERACFKS | `safkeyringjce://ZWESVUSR/ZOWERING` | +| JCEHYBRIDRACFKS | `safkeyringjcehybrid://ZWESVUSR/ZOWERING` | + +## Failed to load JCERACFKS keyring when using Java 11 + +**Symptom:** + +API ML components do not start properly because they fail to load the JCERACFKS keyring. The exception message indicates that the keyring is not available. +The keyring, however, is configured correctly and the STC user can access it. + +**Examples:** +``` +2023-06-27 13:07:45.138 ..35m..0;39m APIMTST ..31mERROR..0;39m ..36m(o.a.t.u.n.SSLUtilBase)..0;39m Failed to load keystore type .JCERACFKS. with path .safkeyring://ZWESVUSR/ZOWERING. due to .JCERACFKS not found. +java.security.KeyStoreException: JCERACFKS not found +.at java.base/java.security.KeyStore.getInstance(KeyStore.java:878) +.at org.apache.tomcat.util.net.SSLUtilBase.getStore(SSLUtilBase.java:187) +.at org.apache.tomcat.util.net.SSLHostConfigCertificate.getCertificateKeystore(SSLHostConfigCertificate.java:207) +... +Caused by: java.security.NoSuchAlgorithmException: +JCERACFKS KeyStore not available +.at java.base/sun.security.jca.GetInstance.getInstance(GetInstance.java:159) +.at java.base/java.security.Security.getImpl(Security.java:725) +.at java.base/java.security.KeyStore.getInstance(KeyStore.java:875) +``` + +**Solution:** + +In Java 11 releases before 11.0.17.0, the `IBMZSecurity` security provider is not enabled by default. Locate the `java.security` configuration file in the `$JAVA_HOME/conf/security` USS directory +and open the file for editing. Modify the list of security providers and insert `IBMZSecurity` on second position. The list of enabled security providers should resemble the following series: +``` +security.provider.1=OpenJCEPlus +security.provider.2=IBMZSecurity +security.provider.3=SUN +security.provider.4=SunRsaSign +security.provider.5=SunEC +security.provider.6=SunJSSE +security.provider.7=SunJCE +security.provider.8=SunJGSS +security.provider.9=SunSASL +security.provider.10=XMLDSig +security.provider.11=SunPCSC +security.provider.12=JdkLDAP +security.provider.13=JdkSASL +security.provider.14=SunPKCS11 +``` +For more information see the steps in [Enabling the IBMZSecurity provider](https://www.ibm.com/docs/en/semeru-runtime-ce-z/11?topic=guide-ibmzsecurity#ibmzsecurity__enabling_z_provider__title__1). diff --git a/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-zos-startup.md b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-zos-startup.md new file mode 100644 index 0000000000..6df73654ef --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-zos-startup.md @@ -0,0 +1,76 @@ +# Troubleshooting startup of Zowe z/OS components + +The following topics contain information that can help you troubleshoot problems when you encounter unexpected behavior installing Zowe z/OS components or starting Zowe's `ZWESLSTC` started task. + + +## How to check if `ZWESLSTC` startup is successful + +The `ZWESLSTC` started task on z/OS brings up a number of address spaces. There is no single **Zowe has launched and is ready to run** message as the sequence of address spaces initialization is environment-dependent, although the message ID `ZWED0021I` is typically the last one that is logged. More details on each subsystem and their startup messages are described in the following sections. + +- [Check the startup of API Mediation Layer](#check-the-startup-of-api-mediation-layer) +- [Check the startup of Zowe Desktop](#check-the-startup-of-zowe-desktop) +- [Check the startup of Zowe Secure Services](#check-the-startup-of-zowe-secure-services) + +To check that Zowe has started successfully, the most complete way is to check that each component successfully completed its initialization. Each component writes messages to the JES `SYSPRINT` and writes severe errors to the `STDERR` job spool file. + +To learn more about the Zowe components and their role, see [Zowe Architecture](../getting-started/zowe-architecture.md). It is possible to configure Zowe to bring up only a subset of its components by using the `zowe.components..enabled: boolean` variables in the `zowe.yaml` file. + +### Check the startup of API Mediation Layer + +The API Mediation Layer has four address spaces: API Catalog, API Gateway, API Discovery and Caching Service. + +To check whether the API mediation layer is fully initialized, look for the `ZWEAM000I` message. Each component writes a successful startup message `ZWEAM000I` to JES as shown below. The message also indicates the CPU of seconds spent. In a normal startup of the APIML components each one will write a `ZWEAM00I` message similar to below: + +``` +2023-02-21 17:20:57.614 [35m[0;39m IBMUSER [32mINFO [0;39m [36m(o.z.a.p.s.ServiceStartupEventHandler) +[0;39m ZWEAM000I Caching Service started in 43.818 seconds +... +2023-02-21 17:21:03.924 IBMUSER INFO (o.z.a.p.s.ServiceStartupEventHandler) +ZWEAM000I API Catalog Service started in 53.75 seconds +... +2023-02-21 12:10:08.468 ZWESVUSR INFO (o.z.a.p.s.ServiceStartupEventHandler) ZWEAM000I API Catalog Service started in 37.025 seconds +... +2023-02-21 17:21:06.368 IBMUSER INFO (o.z.a.p.s.ServiceStartupEventHandler) ZWEAM000I Gateway Service started in 56.2 seconds +``` + +As well as looking for `ZWEAM00I` in the JES log, you can also log in to the gateway homepage and check the service status indicator. If there is a red or yellow tick beside one of its three services, the components are still starting. + +Zowe API Mediation Layer Startup + +When all services are fully initialized, there will be three green ticks. + +Zowe API Mediation Layer Startup + +### Check the startup of Zowe Desktop + +During startup of the the Zowe desktop loads its plug-ins and writes a message `ZWED0031I` when it is completed. + +``` +2023-02-21 12:10:12.824 ZWESVUSR INFO (_zsf.install,index.js:439) ZWED0031I - Server is ready at https://0.0.0.0:27556, Plugins successfully loaded: 100% (19/19) +``` + +The `ZWED0031I` message includes a count of the number of loaded plug-ins as well as the total number of plug-ins, for example `Plugins successfully loaded: 100% (19/19)`. A failed plug-in load will not abort the launch of the desktop. + +If the the Zowe desktop is started together with the API Gateway, the Zowe Desktop it will register itself with the API Gateway. This step must be completed before a user is able to successfully log in to the Zowe Desktop. The message that is written to indicate that the registration handshake between the Zowe Desktop and the API GAteway has been successful is `ZWED0021I`, for example + +``` +2023-02-21 12:10:12.226 ZWESVUSR INFO (_zsf.apiml,apiml.js:309) ZWED0021I - Eureka Client Registered from 127.0.0.1. Available at https://tvt5003.svl.ibm.com:27553/zlux/ui/v1/ +``` + +If you try to log into the Zowe desktop too early before the Eureka client registration has occurred you may get an **Authentication failed** message on the login page because the APIML handshake is incomplete. If this occurs wait for the registration to be complete as indiciated by the `ZWED0021I` message. + +As well as spooling to the JES `SYSPRINT` file for the Zowe `ZWESLSTC` task, the Zowe Desktop writes messages to `zowe.logDirectory/zssServer-yyyy-mm-dd-hh-ss.log`. + +### Check the startup of Zowe Secure Services + +The zssServer is used for secure services for the Zowe desktop. + +``` +ZWES1013I ZSS Server has started. Version '2.5.0+20221130' 31-bit +``` + +The zssServer will register itself with the cross memory server running under the address space `ZWESISTC`. You can use the attach message ID `ZWES1014I` to check that this has occurred successfully. If this message contains a nonzero return code in the `cmsRC=` value, then a failure occurred. For more information on how to diagnose these, see [ZSS server unable to communicate with X-MEM](./app-framework/app-troubleshoot.md#zss-server-unable-to-communicate-with-x-mem). + +``` +ZWES1014I ZIS status - 'Ok' (name='ZWESIS_STD ', cmsRC='0', description='Ok', clientVersion='2') +``` diff --git a/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-zowe-release.md b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-zowe-release.md new file mode 100644 index 0000000000..65d73f72ad --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/troubleshoot-zowe-release.md @@ -0,0 +1,29 @@ +# Understanding Zowe release versions +## Zowe releases + +Zowe uses semantic versioning for its releases, also known as SemVer. Each release has a unique ID made up of three numbers that are separated by periods. + +``` +.. +``` +Each time a new release is created, the release ID is incremented. Each number represents the content change since the previous release. For example: +- `2.5.0` represents the fifth minor release since the first major release. +- `2.5.1` represents the first patch to the `2.5.0` release. +- `2.6.0` is the first minor release to be created after `2.5.1`. + +### Major release +A major release is required if changes are made to the public API and the code is no longer compatible with an earlier version. + +When Zowe is version one, it is associated with the Zowe v1 [conformance program](../extend/zowe-conformance-program.md). Offerings that extend Zowe and achieve the Zowe v1 conformance badge will remain compatible with Zowe throughout its version 1 lifetime. A major release increment because of incompatibility is sometimes referred to as a "breaking" change. + +The first SMP/E build for Zowe v2 has a Functional Module ID (FMID) of AZWE002, which was created with content from the 2.0.0 release. Each major release will be its own SMP/E FMID where the last digit is updated, for example AZWE00V where V represents the major version. + +Subsequent minor and patch releases to V2 are delivered as SMP/E PTF SYSMODs. Because of the size of the content, two co-requisite PTFs are created for each Zowe release. + +While Major releases are required for a "breaking" change, they also can be used to indicate to the community a significant content update over and above what would be included in a minor release. + +### Minor release +A minor release indicates that new functionality is added but the code is compatible with an earlier version. The Zowe community works on two-week sprints and creates a minor release at the end of these, typically once per month although the frequency might vary. + +### Patch +A patch is usually reserved for a bug fix to a minor release. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/troubleshooting.md b/versioned_docs/version-v2.15.x/troubleshoot/troubleshooting.md new file mode 100644 index 0000000000..51b79229f5 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/troubleshooting.md @@ -0,0 +1,58 @@ +# Troubleshooting Zowe + +To isolate and resolve Zowe™ problems, you can use the troubleshooting and support information. + +## How to start troubleshooting + +When you run into some issues and are looking for troubleshooting tips, the following steps may help you. + +1. Search the error message or error code in your error log by using the Search bar in the [Zowe Docs site](https://docs.zowe.org/). If there is an existing solution, follow the instructions to troubleshoot. + +![A screenshot to show how to search in github repo](../images/troubleshoot/search-bar-2.png) + +2. If no solution is available or the existing solutions cannot apply to your problem, you could search the keywords, error messages, or error code in the [Zowe GitHub repository](https://github.com/zowe). If you find a closed issue or pull request, try troubleshooting by using the information shared in the item's Conversation section. If the issue is still open, post your question or comment to prompt a discussion on your problem. + +![A gif to show how to search in github repo](../images/troubleshoot/how-to-troubleshooting.gif) + +3. If your problem is not solved, try the following options: + +* Create an issue in the [Zowe GitHub repository](https://github.com/zowe) with a detailed description of the problem you have encountered. + +* Bring up your questions to the corresponding channels as shown below: + + - [Zowe CLI Slack channel](https://openmainframeproject.slack.com/archives/CC8AALGN6) + - [Zowe API ML Slack channel](https://openmainframeproject.slack.com/archives/CC5UUL005) + - [Zowe Chat Slack channel](https://openmainframeproject.slack.com/archives/C03NNABMN0J) + - [Zowe Documentation Slack channel](https://openmainframeproject.slack.com/archives/CC961JYMQ) + +* Reach out to your available Zowe support team for assistance. + +## Known problems and solutions + +Some common problems with Zowe are documented, along with their solutions or workarounds. If you have a problem with Zowe installation and components, review the problem-solution topics to determine whether a solution is available to the problem that you are experiencing. + +You can also find error messages and codes, must-gathers, and information about how to get community support in these topics. + +### Troubleshooting Zowe server-side components + +- [Troubleshooting Zowe Launcher](./launcher/launcher-troubleshoot.md) +- [Troubleshooting Zowe z/OS component startup](troubleshoot-zos-startup.md) +- [Troubleshooting API Mediation Layer](troubleshoot-apiml.md) +- [Troubleshooting Zowe Application Framework](./app-framework/app-troubleshoot.md) + + +### Troubleshooting Zowe client-side components + +- [Troubleshooting Zowe CLI](./cli/troubleshoot-cli.md) +- [Troubleshooting Zowe Explorer](./ze/troubleshoot-ze.md) +- [Troubleshooting Zowe Chat](./zowe-chat-troubleshoot/troubleshooting.md) +- [Troubleshooting Zowe IntelliJ plug-in](troubleshoot-intellij.md) + +## Verifying a Zowe release's integrity + +Following a successful install of a Zowe release, the Zowe runtime directory should contain the code needed to launch and run Zowe. If the contents of the Zowe runtime directory have been modified then this may result in unpredictable behavior. To assist with this Zowe provides the ability to validate the integrity of a Zowe runtime directory, see [Verify Zowe runtime directory](./verify-fingerprint.md) + +## Understanding the Zowe release + +Knowing which version of Zowe you are running might help you isolate the problem. Also, the Zowe community who helps you will need to know this information. For more information, see [Understanding the Zowe release](troubleshoot-zowe-release.md). + diff --git a/versioned_docs/version-v2.15.x/troubleshoot/verify-fingerprint.md b/versioned_docs/version-v2.15.x/troubleshoot/verify-fingerprint.md new file mode 100644 index 0000000000..354ea3db00 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/verify-fingerprint.md @@ -0,0 +1,27 @@ +# Verify Zowe runtime directory + +Zowe ships a [`zwe support verify-fingerprints` command](../appendix/zwe_server_command_reference/zwe/support/zwe-support-verify-fingerprints.md) to help you verify authenticity of your runtime directory. This command collects and calculates hashes for all files located in Zowe runtime directory and compare the hashes shipped with Zowe. With this utility, you are able to tell what files are modified, added, or deleted from original Zowe build. + +Here is an example for successful verification: + + +``` +#> zwe support verify-fingerprints +=============================================================================== +>> VERIFY ZOWE FILE FINGERPRINTS + +- Create Zowe directory file list +- Calculate hashes of Zowe files +- Find different files + * Number of different files: 0 +- Find extra files + * Number of extra files: 0 +- Find missing files + * Number of missing files: 0 +------------------------------------------------------------------------------- +>> Zowe file fingerprints verification passed. + +#> +``` + +If this verification fails, the script will exit with code 181 and display error messages like `Number of different files: 1`. You can optionally pass `--debug` or `-v` parameter to instruct this command to verbosely display which files are different. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/ze/known-ze.md b/versioned_docs/version-v2.15.x/troubleshoot/ze/known-ze.md new file mode 100644 index 0000000000..6c8554de48 --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/ze/known-ze.md @@ -0,0 +1,106 @@ +# Known Zowe Explorer issues + +The following topics contain information that can help you troubleshoot problems when you encounter unexpected behavior when using Zowe Explorer. + +## Bidirectional languages + +Files written in languages primarily read from right to left (Arabic, Hebrew, many Asian languages) can include portions of text that are written and read left to right, such as numbers. + +These bidirectional (BiDi) languages are not currently supported in Visual Studio Code. See [Issue #86667](https://github.com/microsoft/vscode/issues/86667) for more information. + +As a result, VS Code extensions like Zowe Explorer, Zowe Explorer CICS Extension, and Zowe Explorer FTP Extension are not able to support BiDi languages in files. + +## Client certificate support + +Some Zowe Explorer users prefer to use certificates to access the API Mediation Layer. This can be the case in sites that use credentials such as passwords and multifactor authentication, which might only be valid for a short period of time. On the other hand, certificates can be valid for much longer. + +Zowe Explorer does not support authenticating to the API ML using client certificates. However, it is possible to use Zowe CLI to authenticate to the API ML using client certificates and receive a token that Zowe Explorer can use for API ML access. + +To use a client certificate to generate an API ML token: + +1. Open a command line window and issue the following command: + + ``` + zowe auth login apiml --host --port --cert-file --cert-key-file + ``` + - `` + + Specifies the API ML host. + - `` + + Specifies the API ML port. + - `` + + Specifies the path for the PEM public certificate. + - `` + + Specifies the path to the PEM private certificate. + + Zowe CLI procures a security token from the API ML and adds that token to the base profile in the applicable configuration file. + +2. Open Zowe Explorer, or reload it if already open. + + Zowe Explorer can access the API ML token in the base profile for authentication. + + :::note + + If you have multiple types of configuration files and base profiles, see [How configuration files and profiles work together](../../user-guide/cli-using-understand-profiles-configs.md#how-configuration-files-and-profiles-work-together) to learn which configuration and profile would be used to store the API ML token. + + ::: + +## Data Set creation error + +**Symptom:** + +Data set creation fails. + +**Sample message:** + +Error running command zowe.createDataset: z/OSMF REST API Error: http(s) request error event called Error: self signed certificate in certificate chain. This is likely caused by the extension that contributes zowe.createDataset. + +**Solution:** + +Set the value of the Reject-Unauthorized parameter to `false`. Use the profile edit function to change profile's parameters. + +## Opening binary files error + +**Symptom:** + +When opening a binary file, an error message appears. + +**Sample messages:** + +``` +Cannot open file: +///Users/userID/.vscode/extensions/zowe-vs.code-extension-for-zowe-1.8.0/resources/temp/binaryfilename. +Detail: File seems to be binary and cannot be opened as text +``` + +``` +Error running command zowe.editMember: +cannot open file: +///Users/userID/.vscode/extensions/zowe-vs.code-extension-for-zowe-1.8.0/resources/temp/binaryfilename. +Detail: File seems to be binary and cannot be opened as text. This is likely caused by the extension that contributes zowe.editMember. +``` + +**Solution:** + +There is no solution or workaround at this time. + +## Theia mainframe connection error + +**Symptom:** + +When performing an action that requires a mainframe connection (such as searching for data sets), you get a proxy error. + +**Sample message:** + +"z/OSMF REST API Error" that includes the message `Failed to establish a socket connection to proxies`, as in the following image: + +![Proxy Support set to off](../../images/ze/ZE-socket-connection-error.png) + +**Solution:** + +In Theia settings, search for `proxy` and change the http.proxySupport setting to `off`, as in the following image: + +![Proxy Support set to off](../../images/ze/ZE-proxy-support-off.png) diff --git a/versioned_docs/version-v2.15.x/troubleshoot/ze/troubleshoot-ze.md b/versioned_docs/version-v2.15.x/troubleshoot/ze/troubleshoot-ze.md new file mode 100644 index 0000000000..78153daf1a --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/ze/troubleshoot-ze.md @@ -0,0 +1,103 @@ +# Troubleshooting Zowe Explorer + +As a Zowe Explorer user, you may encounter problems when using Visual Studio Code extension functions. Review Zowe Explorer known issues and troubleshooting solutions here. + +## Before reaching out for support + +1. Is there already a GitHub issue (open or closed) that covers the problem? Check [Zowe Explorer Issues](https://github.com/zowe/zowe-explorer-vscode/issues). +2. Review the current list of [Known issues](known-ze.md) in documentation. Also, try searching using the Zowe Docs search bar (keyboard shortcut `ctrl` + `k`). +3. Collect the following information to help diagnose the issue: + - The Zowe Explorer and Visual Studio Code versions installed + - See [Checking your Zowe version release number](../troubleshoot-check-your-zowe-version/#zowe-explorer-for-visual-studio-code) for information. + - Node.js and NPM versions installed + - Whether you have Zowe CLI and the Secure Credential Store (SCS) Zowe CLI plug-in installed + + :::note + Zowe CLI V2 does not require the SCS plug-in to manage security. Security is now managed by Zowe CLI core functionality. + ::: + + - Your operating system + - Zowe Logs, which usually can be found in `C:\Users\userID\.vscode\extensions\zowe.vscode-extension-for-zowe-X.Y.Z\logs` + + :::note + In some cases, this path can differ. On operating systems such Linux or Mac, the default path is `~/.vscode/extensions/zowe.vscode-extension-for-zowe-X.Y.Z/logs`. In a non-standard installation of Visual Studio Code, extensions could be stored under a different directory. + ::: + +Use [the Slack channel](https://app.slack.com/client/T1BAJVCTY/CUVE37Z5F) to reach the Zowe Explorer community for assistance. + +## Connection issues with Zowe Explorer + +If you’re using Zowe Explorer at a site that uses an Internet proxy but cannot connect to a mainframe, ensure that the **Proxy Support** setting in Visual Studio Code is properly configured. Your system administrator can provide information on which option works best for your network environment. + +Note that Zowe Explorer cannot bypass this setting as it would circumvent the VS Code setting applied to all other extensions. + +To access the **Proxy Support** setting in VS Code: + +1. Open VS Code and select the **Manage** icon on the **Side Bar**. +2. Select the **Settings** option from the context menu. +3. In the Settings view, open the **Application** menu and select **Proxy**. +4. Find the **Proxy Support** drop-down menu and select the appropriate option. + +In addition, VS Code allows users and administrators to configure proxy options on launch. See [Network Connections in Visual Studio Code](https://code.visualstudio.com/docs/setup/network#_proxy-server-support) for more information on proxy server support. + +System administrators can also add IP addresses, IP ranges, or DNS hostnames for each system inaccessible by proxy to the `NO_PROXY` environment variable. VS Code uses this variable for outgoing requests. + +## Resolving invalid profiles + +A problem with a configuration file can make Zowe Explorer unable to read your configurations. + +Zowe Explorer displays an error message advising it cannot read the configuration file when either: + +- A Zowe v1 profile is invalid. +- A Zowe v2 configuration file fails to load. + +Possible problems in the file could include a syntax error, or an invalid keyword or symbol. + +To fix the configuration file causing the error: + +1. Click the **Show Config** button in the message window. + + ![Show Config button](../../images/ze/ZE-show-config-button.gif) + + This opens the file in an **Editor** tab. + +2. Modify the file as needed and save the changes. +3. Reload Visual Studio Code to confirm that Zowe Explorer can read the updated file. + +## Missing write access to VS Code `extensions` folder + +In some environments, the path for VS Code extensions (typically `~/.vscode/extensions`) can be read-only. This can happen when an environment has developers sharing a common read-only extensions folder that is managed by an admin with write access. + +In these cases, Zowe Explorer fails to activate because it cannot write to the `logs` and `temp` folders in the extension path. When Zowe Explorer launches, an `EACCES: permission denied` error displays. See the following examples. + +`logs` folder write access error: + +![Logs folder write access error](../../images/troubleshoot/ZE/write-access-error-logs-folder.png) + +`temp` folder write access error: + +![Logs folder write access error](../../images/troubleshoot/ZE/write-access-error-temp-folder.png) + +To avoid this, change the `logs` and `temp` folder locations: + +1. In VS Code, select the **File menu**, select **Preferences**, and click on **Settings**. + +2. In either the **User** or **Workspace** tab, click on the **Extensions** option to open the menu. + +3. Select **Zowe Explorer**. + +4. Enter the new path in the **Logs Folder** or **Temporary Downloads Folder** fields. For examples: + + `logs` folder setting: + + ![Logs folder write access error](../../images/troubleshoot/ZE/new-logs-folder-path.png) + + - Log files include information about Zowe Explorer and connections it makes to the mainframe. These files can be used for troubleshooting and to analyze errors. + +
    `temp` folder setting: + + ![Temp folder write access error](../../images/troubleshoot/ZE/new-temp-folder-path.png) + + - Temporary files are local copies of data sets or USS files downloaded from the mainframe to edit in VS Code. These files last until VS Code closes and all changes have been uploaded to the mainframe. + +
    After a new path is entered, Zowe Explorer writes logs and temporary files using the corresponding path. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/ze/ze-issues.md b/versioned_docs/version-v2.15.x/troubleshoot/ze/ze-issues.md new file mode 100644 index 0000000000..064ef9cd2b --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/ze/ze-issues.md @@ -0,0 +1,11 @@ +# Raising a Zowe Explorer issue on GitHub + +You can raise GitHub issues against [the Zowe Explorer repository](https://github.com/zowe/zowe-explorer-vscode/issues). It is suggested that you use either the bug or feature request. + +## Raising a bug report + +Please provide as much of the information listed on [Troubleshooting Zowe Explorer](troubleshoot-ze.md) as is reasonable. Anyone working on the issue might need to request this and other information if it is not supplied initially. A description of the error and how it can be reproduced is the most important information. + +## Submitting a feature request + +Feature requests are just as important to the Zowe project as bug reports. Feature requests should contain clearly formulated ideas that can improve user experience. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/troubleshoot/ze/ze-known-limits.md b/versioned_docs/version-v2.15.x/troubleshoot/ze/ze-known-limits.md new file mode 100644 index 0000000000..e9e6fbd16b --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/ze/ze-known-limits.md @@ -0,0 +1,25 @@ +# Known Zowe Explorer limitations + +### Mismatched credentials when using Zowe Explorer and Zowe CLI + +#### **Limitation** + +Mismatching credentials can potentially lock you out from using Zowe CLI and Zowe Explorer in Visual Studio Code with either Windows Subsystem for Linux (WSL) or Remote Secure Shell (SSH). + +WSL allows developers to run a Linux environment on Windows without the need for a separate virtual machine or dual booting. When using Zowe Explorer with WSL, two parallel processes take place: VS Code runs on the Windows operating system, while code execution and tooling happen within the Linux environment. + +With Remote SSH, the network protocol provides users with a secure connection to a remote computer. When using this protocol with Zowe Explorer, you can securely connect to a remote machine or a remote development environment. + +Both WSL and Remote SSH provide more tools for mainframe developers, but they also have limitations when it comes to credentials. + +Authentication information used in Zowe Explorer — such as usernames and passwords, SSH keys, API Mediation Layer tokens — resides on the developer’s local machine, not the Linux environment or the remote server or virtual machine. This is because credential storage is managed by VS Code, which stores them using the host's operating system credential manager. + +Using the VS Code integrated terminal with virtual machines does not include access to the credentials stored by Zowe Explorer in the local machine. Zowe CLI, for example, is not able to retrieve credentials saved on a developer’s PC when accessing the mainframe. Instead, Zowe CLI attempts to use any credentials stored in the virtual machine. + +This can lead to confusion and inconsistencies when authenticating and accessing resources. + +#### **Workaround** + +It is crucial to ensure that credentials are carefully managed between the local machine and the remote server to maintain proper authentication. + +To avoid any potential issues (such as being locked out) caused by credential mismatch or discrepancies, credentials in both local and virtual/remote machines should match. diff --git a/versioned_docs/version-v2.15.x/troubleshoot/zowe-chat-troubleshoot/troubleshooting.md b/versioned_docs/version-v2.15.x/troubleshoot/zowe-chat-troubleshoot/troubleshooting.md new file mode 100644 index 0000000000..932425b32b --- /dev/null +++ b/versioned_docs/version-v2.15.x/troubleshoot/zowe-chat-troubleshoot/troubleshooting.md @@ -0,0 +1,17 @@ +# Troubleshooting Zowe Chat + +As a Zowe Chat user, you might encounter some issues with how Zowe Chat works. This section lists some solutions to help you. + +## Check the chatServer.log + +When you run into some errors, you can check the server log which can be found in `$ZOWE_CHAT_HOME/log/chatServer.log`. + +**Note**: You need to set `rejectUnauthorized` to `false` in `chatServer.yaml` to access the log. + +## Raising a Zowe Chat issue on GitHub + +When necessary, you can reach out for troubleshooting support via GitHub. You can raise GitHub issues against the [Zowe Chat repository](https://github.com/zowe/zowe-chat). You could either use it for a bug report or feature request. + +## Contacting support via Slack + +You can also reach out for support through the [Zowe Chat Slack channel](https://openmainframeproject.slack.com/archives/C03NNABMN0J). \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/Install roadmap V2.pptx b/versioned_docs/version-v2.15.x/user-guide/Install roadmap V2.pptx new file mode 100644 index 0000000000..25f621bfb8 Binary files /dev/null and b/versioned_docs/version-v2.15.x/user-guide/Install roadmap V2.pptx differ diff --git a/versioned_docs/version-v2.15.x/user-guide/_cli-using-creating-global-team-profiles.md b/versioned_docs/version-v2.15.x/user-guide/_cli-using-creating-global-team-profiles.md new file mode 100644 index 0000000000..0078200fd8 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/_cli-using-creating-global-team-profiles.md @@ -0,0 +1,211 @@ +# Creating team profiles + +As a Dev-Ops advocate or team leader, you can share team profiles with your team members so that they can easily access mainframe services. + +## Share team configurations + +As a team leader, you might want to share a configuration globally under the following scenarios: + +- You want to share profiles with developers so that they can work with a defined set of mainframe services. The recipient of the file manually places it in their local `~/.zowe` folder before issuing CLI commands. +- You want to add the profiles to your project directory in a software change management (SCM) tool, such as GitHub. When you store the profiles in an SCM, developers can pull the project to their local machine and use the defined configuration. Zowe CLI commands that you issue from within the project directory automatically use the project's configuration scheme. +- You want to enable test automation and CI/CD, which lets your pipelines make use of the project configuration. +you store the profiles in an SCM, developers can pull the project to their local machine and use the defined configuration. Zowe CLI commands that you issue from within the project directory automatically use the project's configuration scheme. +- You want to enable test automation and CI/CD, which lets your pipelines make use of the project configuration. + + +## Profile scenarios + +The following topics describe various profile scenarios that Dev-Ops advocates (team leaders) or application developers that function as DevOps advocates can create to share with their teams. + +### Access to one or more LPARs that contain multiple services that share the same username and password + +The following example illustrates that the settings are using nested profiles to access multiple services directly on multiple LPARs that share the same username and password. + +``` +{ + "$schema": "./zowe.schema.json", + "profiles": { + "lpar1": { + "properties": { + "host": "example1.com" + }, + "profiles": { + "zosmf": { + "type": "zosmf", + "properties": { + "port": 443 + } + }, + "tso": { + "type": "tso", + "properties": { + "account": "ACCT#", + "codePage": "1047", + "logonProcedure": "IZUFPROC" + } + }, + "ssh": { + "type": "ssh", + "properties": { + "port": 22 + } + } + } + }, + "lpar2": { + "properties": { + "host": "example2.com" + }, + "profiles": { + "zosmf": { + "type": "zosmf", + "properties": { + "port": 1443 + } + } + } + }, + "base": { + "type": "base", + "properties": { + "rejectUnauthorized": true + }, + "secure": [ + "user", + "password" + ] + } + }, + "defaults": { + "zosmf": "lpar2.zosmf", + "tso": "lpar1.tso", + "ssh": "lpar1.ssh", + "base": "base" + } +} +``` +### Access to one or more LPARs that contain multiple services where the username and password differ between LPAR services + +The following example: ***NEEDS WORK*** The settings are accessing multiple services directly on LPAR1 and LPAR2 where username and password varies between the LPAR1 and LPAR2 services. This example is identical to Example 1 except that LPAR1 and LPAR2 each contain a secure array, instead of just one secure array in the "base" profile. + +``` +{ + "$schema": "./zowe.schema.json", + "profiles": { + "lpar1": { + "properties": { + "host": "example1.com" + }, + "profiles": { + "zosmf": { + "type": "zosmf", + "properties": { + "port": 443 + } + }, + "tso": { + "type": "tso", + "properties": { + "account": "ACCT#", + "codePage": "1047", + "logonProcedure": "IZUFPROC" + } + }, + "ssh": { + "type": "ssh", + "properties": { + "port": 22 + } + } + }, + "secure": [ + "user", + "password" + ] + }, + "lpar2": { + "properties": { + "host": "example2.com" + }, + "profiles": { + "zosmf": { + "type": "zosmf", + "properties": { + "port": 1443 + } + } + }, + "secure": [ + "user", + "password" + ] + }, + "base": { + "type": "base", + "properties": { + "rejectUnauthorized": true + } + } + }, + "defaults": { + "zosmf": "lpar2.zosmf", + "tso": "lpar1.tso", + "ssh": "lpar1.ssh", + "base": "base" + }, + "autoStore": true +} +``` + +### Access LPARs containing multiple services through API Mediation Layer with token authentication + +The following example illustrates that the settings access multiple services using the API ML where multi-factor authentication (MFA) or single sign-on (SSO) is achievable using token-based authorization. + +``` +{ + "$schema": "./zowe.schema.json", + "profiles": { + "zosmf": { + "type": "zosmf", + "properties": { + "basePath": "api/v1" + } + }, + "cics": { + "type": "cics", + "properties": { + "basePath": "api/v1/cics" + } + }, + "db2": { + "type": "db2", + "properties": { + "basePath": "api/v1/db2" + } + }, + "base": { + "type": "base", + "properties": { + "host": "example.com", + "port": 443, + "rejectUnauthorized": true, + "tokenType": "apimlAuthenticationToken" + }, + "secure": [ + "tokenValue" + ] + } + }, + "defaults": { + "zosmf": "zosmf", + "cics": "cics", + "db2": "db2", + "base": "base" + }, + "autoStore": true +} +``` + +### Access LPARs containing multiple services through API Mediation Layer with certificate authentication + +The following example illustrates.... \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/address-authentication-requirements.md b/versioned_docs/version-v2.15.x/user-guide/address-authentication-requirements.md new file mode 100644 index 0000000000..48b2ba06f1 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/address-authentication-requirements.md @@ -0,0 +1,40 @@ +# (Recommended) Addressing authentication requirements + +The following features are not required, but are recommended with additional prerequisites. + +:::info Roles required: security administrator +::: + +## Multi-Factor Authentication (MFA) + +Multi-factor authentication (MFA) is supported for several Zowe components, including the Zowe Desktop, API Mediation Layer, and Zowe Application Framework. +Multi-factor authentication is provided by third-party products with which Zowe is compatible. The following MFA products are known to work with Zowe: + +- [Advanced Authentication Mainframe 2.0](https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-advanced-authentication-mainframe/2-0.html) +- [IBM Z Multi-Factor Authentication](https://www.ibm.com/products/ibm-multifactor-authentication-for-zos). + +To support the multi-factor authentication, it is necessary to apply z/OSMF APAR [PH39582](https://www.ibm.com/support/pages/apar/PH39582). + +For information about using MFA in Zowe Application Framework, see [Application Framework Multi-Factor Authentication](mvd-configuration.md#multi-factor-authentication-configuration). + + +:::important +Multi-factor authentication requires configuration with Single-Sign-On (SSO). Ensure that SSO is configured before you use MFA in Zowe. +::: + +## Single Sign On (SSO) + +Zowe has an SSO scheme with the goal that each time you use multiple Zowe components you should only be prompted to login once. + +Requirements: + +- IBM z/OS Management Facility (z/OSMF) + +For more information about single sign on (SSO), see [Zowe API Mediation Layer Single Sign On Overview](./api-mediation-sso). + + +## API Mediation Layer OIDC Authentication + +Zowe requires **ACF2 APAR LU01316** to be applied when using the ACF2 security manager. + +For more information about OIDC authentication, see [Zowe API Mediation Layer OIDC Authentication](../extend/extend-apiml/api-mediation-oidc-authentication.md). \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/address-browser-requirements.md b/versioned_docs/version-v2.15.x/user-guide/address-browser-requirements.md new file mode 100644 index 0000000000..2e4fbe4195 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/address-browser-requirements.md @@ -0,0 +1,19 @@ +# Addressing browser requirements + +Review the following browser requirements to avoid browser-specific issues when running particular server-side components. + +:::info Required role: system programmer +::: + +## Zowe Desktop requirements (client PC) + +The Zowe Desktop is powered by the Application Framework which has server prereqs depending on where it is installed. + +The Zowe Desktop runs inside of a browser. No browser extensions or plugins are required. +The Zowe Desktop supports Google Chrome, Mozilla Firefox, Apple Safari, and Microsoft Edge releases that are at most 1 year old, except when the newest release is older. For Firefox, both the regular and Extended Support Release (ESR) versions are supported under this rule. + +If you do not see your browser listed here, please contact the [Zowe community](https://github.com/zowe/community/blob/master/README.md#slack) so that it can be validated and included. + +## Browser limitations in API Catalog + +It is recommended to use Google Chrome when accessing the API Catalog of API Mediation Layer. Errors might occur if you access API Catalog with Firefox. diff --git a/versioned_docs/version-v2.15.x/user-guide/address-network-requirements.md b/versioned_docs/version-v2.15.x/user-guide/address-network-requirements.md new file mode 100644 index 0000000000..7ea8cd452a --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/address-network-requirements.md @@ -0,0 +1,26 @@ +# Addressing network requirements + +Review the following table during installation of Zowe server-side components to determine which TCP ports are required. +Values presented in the table are default values. You can change the values by updating variable values in the `zowe.yaml` file. + +:::info Required roles: network administrator, system programmer +::: + +For more information about variable names in the following table, see the [Zowe YAML configuration file reference](../appendix/zowe-yaml-configuration.md) in the References section. + +| Port number | zowe.yaml variable name | Purpose | +|------|------|------| +| 2157 | NA | The port at which the key server in Infinispan is listening. If the port is not available, the next port is probed, up to port+5. Used by the key server (server) to create an SSLServerSocket and by clients to connect to the key server. +| 7098 | zowe.components.caching-service.storage.infinispan.jgroups.port | Bind port for the socket that is used to form an Infinispan cluster. +| 7552 | zowe.components.api-catalog.port | Used to view API swagger / openAPI specifications for registered API services in the API Catalog. +| 7553 | zowe.components.discovery.port | Discovery server port which dynamic API services can issue APIs to register or unregister themselves. +| 7554 | zowe.components.gateway.port | The northbound edge of the API Gateway used to accept client requests before routing them to registered API services. This port must be exposed outside the z/OS network so clients (web browsers, VS Code, processes running the Zowe CLI) can reach the gateway. +| 7555 | zowe.components.caching-service.port | Port of the caching service that is used to share state between different Zowe instances in a high availability topology. +| 7556 | zowe.components.app-server.port | The Zowe Desktop (also known as ZLUX) port used to log in through web browsers. +| 7557 | zowe.components.zss.port | Z Secure Services (ZSS) provides REST API services to ZLUX, used by the File Editor application and other ZLUX applications in the Zowe Desktop. +| 7558 | zowe.components.jobs-api.port | Port of the service that provides REST APIs to z/OS jobs used by the JES Explorer. +| 7559 | zowe.components.files-api.port | Port of the service that provides REST APIs to MVS and USS file systems. +| N/A | zowe.components.explorer-jes | Port of the JES Explorer GUI for viewing and working with jobs in the Zowe Desktop. +| N/A | zowe.components.explorer-mvs | Port of the MVS Explorer GUI for working with data sets in the Zowe Desktop. +| N/A | zowe.components.explorer-uss | Port of the USS Explorer GUI for working with USS in the Zowe Desktop. + diff --git a/versioned_docs/version-v2.15.x/user-guide/address-security-requirements.md b/versioned_docs/version-v2.15.x/user-guide/address-security-requirements.md new file mode 100644 index 0000000000..9bd40a5aef --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/address-security-requirements.md @@ -0,0 +1,50 @@ +# Addressing security requirements + +:::info Roles required: security administrator +::: + +During configuration of server-side components, it is necessary to configure various system security settings. Your +organization may require your security administrator to complete steps to configure Zowe security. As a system +administrator/programmer, first consult with your security administrator before you start the installation process. + +:::note +This article addresses configuring Zowe security during the Zowe z/OS components installation process, and does not address security configuration to extend Zowe. For more information about security configuration to extend Zowe, see the following articles: + +- [Digital certificates](../getting-started/zowe-security-overview#digital-certificates) +- [User Authentication](../getting-started/zowe-security-overview#user-authentication) +- [Access Authorization](../getting-started/zowe-security-overview#access-authorization) +::: + +## Tasks performed by your security administrator + +To configure Zowe security, your organization's security administrator is required to +perform various tasks. Some of the tasks apply to general Zowe configuration, while other tasks are required during +installation if you plan to use specific Zowe components or features. + +The following required configuration tasks are performed by your organization's security administrator during the post-installation configuration: + +* [Initialize Zowe security configurations](../user-guide/initialize-security-configuration.md) +* [Perform APF authorization of load libraries](../user-guide/apf-authorize-load-library.md) +* [Configure the z/OS system for Zowe](./configure-zos-system.md#configure-user-ids-and-groups-for-the-zowe-started-tasks) +* [Configure address space job naming](../user-guide/configure-zos-system.md#configure-address-space-job-naming) +* [Assign security permissions of users](#assign-security-permissions-of-users) + +If your Zowe server-side installation includes the features listed in the following table, consult your +security administrator to perform the associated security tasks after installation: + +| Feature of a Zowe server-side component | Configuration Task | +|-------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| If using Top Secret as your security manager
    **Note:** No specific configuration is necessary for security managers other than Top Secret. | [Configuring multi-user address space (for TSS only)](../user-guide/configure-zos-system.md#configure-multi-user-address-space-for-tss-only) | +| High Availability | [Configuring ZWESLSTC to run Zowe high availability instances under ZWESVUSR user ID](../user-guide/configure-zos-system.md#configure-zweslstc-to-run-zowe-high-availability-instances-under-zwesvusr-user-id) | +| z/OSMF authentication or onboarding of z/OSMF service | [Granting users permission to access z/OSMF](./assign-security-permissions-to-users/#granting-users-permission-to-access-zosmf) | +| ZSS component enabled (required for API ML certificate and identity mapping) | [Configuring an ICSF cryptographic services environment](../user-guide/configure-zos-system.md#configure-an-icsf-cryptographic-services-environment)
    and
    [Configuring security environment switching](../user-guide/configure-zos-system.md#configure-security-environment-switching) | +| API Mediation Layer certificate mapping | [Configuring main Zowe server to use client certificate identity mapping](../user-guide/configure-zos-system.md#configure-main-zowe-server-to-use-client-certificate-identity-mapping) | +| API Mediation Layer identity mapping | [Configuring main Zowe server to use distributed identity mapping](../user-guide/configure-zos-system.md#configure-main-zowe-server-to-use-distributed-identity-mapping) | +| API Mediation Layer Identity Tokens (IDT) | [Configuring signed SAF Identity tokens (IDT)](../user-guide/configure-zos-system.md#configure-signed-saf-identity-tokens-idt) | +| Cross memory server (ZIS) | [Configuring the cross memory server for SAF](../user-guide/configure-zos-system.md#configure-the-cross-memory-server-for-saf)
    and
    [Configuring cross memory server load module](../user-guide/configure-xmem-server.md#load-module)
    and
    [Configuring cross-memory server SAF configuration](../user-guide/configure-xmem-server.md#saf-configuration) | + +### Assign security permissions to users + +As a security administrator, assign users (`ZWESVUSR` and `ZWESIUSR`) and the `ZWEADMIN` security group permissions required to perform specific tasks. + +For more information about assigning these permissions, see [Assigning security permissions to users](./assign-security-permissions-to-users). diff --git a/versioned_docs/version-v2.15.x/user-guide/address-storage-requirements.md b/versioned_docs/version-v2.15.x/user-guide/address-storage-requirements.md new file mode 100644 index 0000000000..8c2c3a42e2 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/address-storage-requirements.md @@ -0,0 +1,27 @@ +# Addressing storage requirements + +:::info Roles required: storage administrator, system programmer +::: + +Ensure that you have sufficient storage depending on the installation method. Review the storage requirements according to your installation method as presented in this article. + +## Installing with SMP/E + +Before installing Zowe SMP/E, review the [DASD storage requirements](../user-guide/install-zowe-smpe/#dasd-storage-requirements). + +## Installing Zowe runtime from a convenience build + +Before installing Zowe runtime from a convenience build, see the [storage requirements associated with MVS datasets](../user-guide/install-zowe-zos-convenience-build/#step-5-install-the-mvs-data-sets). + +### Memory requirements for API Mediation Layer + +Zowe API ML components have following memory requirements: + +Component name | Memory usage +---|--- +Gateway service | 256MB +Discovery service | 256MB +API Catalog | 512MB +Metrics service | 512MB +Caching service | 512MB + diff --git a/versioned_docs/version-v2.15.x/user-guide/advanced-apiml-configuration.md b/versioned_docs/version-v2.15.x/user-guide/advanced-apiml-configuration.md new file mode 100644 index 0000000000..1974d8e63d --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/advanced-apiml-configuration.md @@ -0,0 +1,14 @@ +# Advanced API Mediation Layer Configuration + +There are multiple options for customizing Zowe API Mediation Layer according to your specific use case. Review the various use cases presented in this section, and follow the links to the corresponding documentation that describes how to perform your specific customization. API ML customization can be performed in the following areas: + +* [Enabling Single Sign On for Clients](./api-mediation/configuration-single-sign-on-user) +* [Enabling Single Sign On for Extending Services](./api-mediation/configuration-enable-single-sign-on-extenders) +* [Customizing routing behavior](./api-mediation/configuration-routing) + * [Customizing management of API ML load limits](./api-mediation/configuration-customizing-management-of-apiml-load-limits) +* [Configuring authorization of API ML resources](./api-mediation/configuration-authorization) +* [Customizing the API Catalog UI](./api-mediation/configuration-customizing-the-api-catalog-ui) +* [Configuring SAF Resource Checking](./api-mediation/configuration-saf-resource-checking) +* [Retrieving a specific service within your environment](./api-mediation/configuration-access-specific-instance-of-service) +* [Setting a consistent service ID](./api-mediation/configuration-set-consistent-service-id) +* [Configuring Java heap size](./api-mediation/configuration-customizing-java-heap-sizes.md) diff --git a/versioned_docs/version-v2.15.x/user-guide/apf-authorize-load-library.md b/versioned_docs/version-v2.15.x/user-guide/apf-authorize-load-library.md new file mode 100644 index 0000000000..f95c51b891 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/apf-authorize-load-library.md @@ -0,0 +1,55 @@ +# Performing APF authorization of load libraries + +Review this article to learn how to perform APF authorization of Zowe load libraries to make privileged calls. Note that this procedure requires elevated permissions. + +:::info Required role: security administrator +::: + +Zowe contains load modules that require access to make privileged z/OS security manager calls. These load modules are held in two load libraries which must be APF authorized. The command `zwe init apfauth` reads the PDS names for the load libraries from `zowe.yaml` and performs the APF authority commands. + +- **zowe.setup.dataset.authLoadLib** + Specifies the user custom load library, containing the `ZWELNCH`, `ZWESIS01` and `ZWESAUX` load modules. These are the Zowe launcher, the ZIS cross memory server and the auxiliary server. +- **zowe.setup.dataset.authPluginLib** + References the load library for ZIS plugins. + +The following command presents an example of running `zwe init apfauth`: + +**Example:** +``` +#>zwe init apfauth -c ./zowe.yaml +------------------------------------------------------------------------------- +>> APF authorize load libraries + +APF authorize IBMUSER.ZWEV2.SZWEAUTH +APF authorize IBMUSER.ZWEV2.CUST.ZWESAPL + +>> Zowe load libraries are APF authorized successfully. +#> +``` +:::note +If you do not have permissions to update your security configurations, use `security-dry-run`. We recommend you inform your security administrator to review your job content. +::: + +Specify `--security-dry-run` to have the command echo the commands that need to be run without executing the command. + +``` + SETPROG APF,ADD,DSNAME=IBMUSER.ZWEV2.SZWEAUTH,SMS + SETPROG APF,ADD,DSNAME=IBMUSER.ZWEV2.CUST.ZWESAPL,SMS +``` + +### Making APF auth be part of the IPL + +Add one of the following to your active `PROGxx` PARMLIB member, for example `SYS1.PARMLIB(PROG00)`, to ensure that the APF authorization is added automatically after next IPL. The value of `DSNAME` is the name of the `SZWEAUTH` and `CUST.ZWESAPL` data sets, as created during Zowe installation: + +- If the load library is not SMS-managed, add the following lines, where `${volume}` is the name of the volume that holds the data set: + ``` + APF ADD DSNAME(IBMUSER.ZWEV2.SZWEAUTH) VOLUME(${volume}) + APF ADD DSNAME(IBMUSER.ZWEV2.CUST.ZWESAPL) VOLUME(${volume}) + ``` +- If the load library is SMS-managed, add the following line: + ``` + APF ADD DSNAME(IBMUSER.ZWEV2.SZWEAUTH) SMS + APF ADD DSNAME(IBMUSER.ZWEV2.CUST.ZWESAPL) SMS + ``` + +The PDS member `SZWESAMP(ZWESIPRG)` contains the SETPROG statement and PROGxx update for reference. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation-change-password-via-catalog.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation-change-password-via-catalog.md new file mode 100644 index 0000000000..c05cf3b24a --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation-change-password-via-catalog.md @@ -0,0 +1,18 @@ +# Changing an expired password via API Catalog + +In case of expiration of a mainframe password, the API Catalog offers the possibility to set a new password. When your password expires, you are prompted with a form and a warning message: + +api refresh error + +You can now insert a new password. In order to submit the request for password change, you need to repeat the new password to prevent the risk of a typo. +It is possible that your mainframe installation has specific rules for passwords, such as length, and special characters. When the submitted password does not meet these requirements, an error messag is issued with the chance to insert another new password. + +api refresh error + +After you repeat the new password, you are able to request the change again. The number of retries depends on the security manager setup of your zOS. + +api refresh error + +Once you successfully change the password, you are informed with a green pop-up message indicating `Your mainframe password was successfully changed`. You can now use the new password for authentication. + + diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation-metrics-service.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation-metrics-service.md new file mode 100644 index 0000000000..2dc6f192c0 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation-metrics-service.md @@ -0,0 +1,30 @@ +# Using Metrics Service (Technical Preview) + +As a system administrator, use the Metrics Service to view information about the acitivty of services running in the API Mediation Layer. +Currently, only HTTP metrics are displayed for core API Mediation Layer services. + +In order for the Metrics Service to run, you must set `components.metrics-service.enabled` in `zowe.yaml` to `true`. Additionally, for each APIML service you want to have metrics collected for, you must set `components..apiml.metrics.enabled` set to `true` in `zowe.yaml`, or `configs.apiml.metrics.enabled` set to `true` in the service's manifest. When metrics are enabled for the API Gateway, the Gateway homepage displays a link to the Metrics Service dashboard. The dashboard is available at `https://{gateway_host}:{gateway_port}/metrics-service/ui/v1`.` + +## API Mediation Layer Metrics Service Demo Video + +Watch this [video](https://youtu.be/KkuE6xADxPk) to see a demo of the Metrics Service. + + + +## View HTTP Metrics in the Metrics Service Dashboard + +Use the Metrics Service to view HTTP metrics such as number of requests, response times, and error rates. The below image describes the information provided in the Metrics Service dashboard. + +discoverable client api v1 + +To view the HTTP metrics for a service, select the corresponding tab in the Metrics Service dashboard. Metrics are displayed for each endpoint of a service, aggregated from all service instances. + +**Example:** + +discoverable client api v1 + +Metrics are provided on a near real-time basis, so the display shows the current activity of the selected service. At this time there is no persistence for this information. + +Service instances expose their HTTP metrics at `https://:/application/hystrix.stream` using the Server-Sent-Events protocol. The Metrics Service collects these streams and aggregates them across service instances before displaying. + +**Note:** At this time, the `/application/hystrix.stream` endpoint for a service does not require authentication if metrics are enabled for that service. If metrics for that service are not enabled, `/application/hystrix.stream` is protected by authentication. diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation-sso.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation-sso.md new file mode 100644 index 0000000000..f58e8a8c65 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation-sso.md @@ -0,0 +1,68 @@ +# Zowe API Mediation Layer Single Sign On Overview + +You can extend Zowe and utilize Zowe Single Sign On (SSO) provided by Zowe API Mediation Layer (API ML) to enhance system security and improve the user experience. + +:::info Required roles: system administrator, security administrator +::: + +This article provides an overview of the API ML single sign on feature, the principle participants in the SSO process, and links to detailed Zowe SSO documentation. Zowe Single Sign On is based on single-user authentication which produces an access token that represents the user in communication with z/OS services accessible through the API Mediation Layer. The access token is issued by the Zowe Authentication and Authorization Service (ZAAS), which is part of API ML. ZAAS issues an access token based on valid z/OS credentials. This token can be validated by any component participating in SSO. + +:::note +Currently, API ML can provide SSO only in a single security domain. +::: + +- [Zowe API ML client](#zowe-api-ml-client) +- [API service accessed via Zowe API ML](#api-service-accessed-via-zowe-api-ml) +- [Existing services that cannot be modified](#existing-services-that-cannot-be-modified) + +The following diagram describes the interactions between the general participants in the single sign on process. + +Zowe SSO Explanation + +There are two main types of components that participate in Zowe SSO through API ML: + +* Zowe API ML client + + - This type of component is user-facing and can obtain user credentials through a user interface (web, CLI, desktop). + - A Zowe API ML client calls API services through the API ML. + - An example of such clients are Zowe CLI or Zowe Desktop. + +* API service accessed via Zowe API ML + + - A service that is registered to API ML and is accessed through the API ML Gateway. + - Services are protected by an access token or PassTicket. + - The access token or PassTicket can be validated by the called API service. + +The following sections describe what is necessary to utilize SSO for both types of components. + +### Zowe API ML client + +* The Zowe API ML client needs to obtain an access token via the `/login` endpoint of ZAAS by providing z/OS credentials. +* A client can call the ZAAS `/query` endpoint to validate the token and get information from the token. This is useful when the API client has the token but does not store the associated data such as the user ID. +* The API client needs to provide the access token to API services in the form of a Secure HttpOnly cookie with the name `apimlAuthenticationToken`, or in the `Authorization: Bearer` HTTP header as described in [Authenticated Request](https://github.com/zowe/sample-spring-boot-api-service/blob/master/zowe-rest-api-sample-spring/docs/api-client-authentication.md#authenticated-request). + +### API service accessed via Zowe API ML + +This section describes the requirements that an API service needs to satisfy to adopt a Zowe SSO access token. + +* The token received by the API ML Gateway is first validated and then may be passed directly to the service. Alternatively, the API ML Gateway can exchange the token for a PassTicket if the API service is configured to expect a PassTicket. +* The API service should validate the token. It can use ZAAS Client or directly call the `query` endpoint. +* The API service can extract information about the user ID by calling the ZAAS `/query` endpoint. +* The alternative is to validate the signature of the JWT token using the public key of the token issuer (e.g. the API ML Gateway). The API service needs to have the API ML Gateway certificate along with the full CA certification chain in the API service truststore. + +:::note +The REST API of ZAAS can easily be called from a Java application using the [ZAAS Client](../extend/extend-apiml/zaas-client). +::: + +### Existing services that cannot be modified + +If you have a service that cannot be changed to adopt the Zowe authentication token, the service can utilize Zowe SSO if the API service is able to handle PassTickets. + +For more information, see [Enabling single sign on for extending services via PassTicket configuration](./api-mediation/configuration-extender-passtickets.md). + +## Further resources + +* [User guide for SSO in Zowe CLI](./cli-using-integrating-apiml/#accessing-multiple-services-with-sso) +* [System requirements for using web tokens for SSO in Zlux and ZSS](./systemrequirements) + + diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation-static-api-refresh.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation-static-api-refresh.md new file mode 100644 index 0000000000..c7c9d7697a --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation-static-api-refresh.md @@ -0,0 +1,25 @@ +# Using Static API services refresh in the API Catalog + +The API Catalog enables users to manually refresh static service APIs. Use the **Refresh Static APIs** option if you change a static service API and want these changes to be visible in the API Catalog without restarting the Discovery Service. + +**Example:** + +api refresh + +To refresh the status of a static service, click the **Refresh** option located in the upper right-hand side of the API Catalog UI. +Successful requests return a pop-up notification that displays the message, `The refresh of static APIs was successful!`. + +**Example:** + +api refresh success + + + If the request fails, a dialog appears with an error message that describes the cause of the fail. + +**Example:** + +api refresh error + +:::note +The manual **Refresh Static APIs** option applies only to static service APIs. Changes to the status of services that are onboarded to allow for dynamic discovery require a restart of the specific services where changes are applied. It is not necessary to restart the API Catalog or the Discovery Service. +::: \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation-swagger-code-snippets.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation-swagger-code-snippets.md new file mode 100644 index 0000000000..ea39e80f9a --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation-swagger-code-snippets.md @@ -0,0 +1,52 @@ +# Using Swagger Code Snippets in the API Catalog + +As part of the *Try it out* functionality, the API Catalog provides **Code Snippets** in different languages for each service API operation. The following languages are supported: + +* C +* C# +* Go +* Java +* JavaScript +* Node.js +* PHP +* Python +* cURL + +Each of these languages supports a specific HTTP Snippet library (i.e. Java Unirest, Java okhttp etc.). + +The basic code snippets provide REST API call samples. To show to the user the real usage of the SDKs, the service onboarder can specify a customized snippet as part of the service configuration: + +**Example:** +```yaml +apiInfo: + - apiId: zowe.apiml.discoverableclient.rest + version: 1.0.0 + gatewayUrl: api/v1 + swaggerUrl: ${apiml.service.scheme}://${apiml.service.hostname}:${apiml.service.port}${apiml.service.contextPath}/v3/api-docs/apiv1 + documentationUrl: https://www.zowe.org + defaultApi: true + codeSnippet: + - endpoint: /greeting + language: java + codeBlock: | + System.out.println("Greeting code snippet"); + - endpoint: /{yourName}/greeting + language: javascript + codeBlock: | + console.log("Your name greeting code snippet"); +``` + +**Example:** + +basic code snippets + +## Generate the code snippets + +Use the following procedure to generate code snippets: + +Click **Try it out** and execute the request, as described in the previous section. + +The API Catalog generates the basic code snippets, shown under the code snippet tab. If the service onboarder has also provided customized code snippets, these snippets are displayed in the snippet bar under a title prefixed with `Customized`. + +**Example:** +basic code snippets \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation-swagger-try-it-out.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation-swagger-try-it-out.md new file mode 100644 index 0000000000..a441431f76 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation-swagger-try-it-out.md @@ -0,0 +1,55 @@ +# Using Swagger "Try it out" in the API Catalog + +The API Catalog makes it possible for users to call service APIs through the **Try it out** functionality. There are 2 types of endpoints: + +- **Public endpoints** + + Endpoints that are accessible without entering user credentials. + +- **Protected endpoints** + + Endpoints that are only accessible by entering user credentials. These endpoints are marked with a lock icon. + + **Example:** + + endpoint detail + + Before making requests to protected endpoints, authorize your session by clicking the lock icon and complete the required information in the Authorization modal: + + **Example:** + + endpoint detail + +To demonstrate **Try it out**, we use the example of the Swagger Petstore. + +**Example:** + +endpoint detail + +## Make a request + +Follow this procedure to make a request. + +1. Expand the **POST Pet** endpoint. + +2. Click **Try it out**. + + **Example:** + + endpoint detail + + After you click **Try it out**, the example value in the **Request Body** field becomes editable. + +3. In the **Example Value** field, change the first `id` value to a random value. Change the second `name` value to a value of your choice, such as the name of a pet. + +4. Click **Execute**. + + **Example:** + + endpoint detail + + The API Catalog Swagger UI submits the request and shows the _curl_ that was submitted. The Responses section shows the response. + + **Example:** + + endpoint detail \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation-view-service-information-and-api-doc.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation-view-service-information-and-api-doc.md new file mode 100644 index 0000000000..0411f89d18 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation-view-service-information-and-api-doc.md @@ -0,0 +1,62 @@ +# Viewing Service Information and API Documentation in the API Catalog + +Use the API Catalog to view services, API documentation, descriptive information about the service, the current state of the service, service endpoints, and detailed descriptions of these endpoints. + +:::note +Verify that your service is running. At least one started and registered instance with the Discovery Service is needed for your service to be visible in the API Catalog. +::: + +**Follow these steps:** + +1. Use the search bar to find the service that you are looking for. +Services that belong to the same product family are displayed on the same tile. + + **Example:** `Sample Applications, Endevor, SDK Application` + +2. Click the tile to view header information, the registered services under that family ID, + and API documentation for that service. + + :::note Notes: + * The state of the service is indicated in the service tile on the dashboard page. + If no instances of the service are currently running, the tile displays a message that no services are running. + * At least one instance of a service must be started and registered with the Discovery Service for it to be visible + in the API Catalog. If the service that you are onboarding is running, and + the corresponding API documentation is displayed, this API documentation is cached and remains visible + even when the service and all service instances stop. + * Descriptive information about the service and a link to the home page of the service are displayed. + ::: + + **Example:** + + controller detail + +3. Select the version (**v1**, **v2**) to view the documentation of a specific API version. + + **Example:** + + discoverable client api v1 + + discoverable client api v2 + +4. Expand the endpoint panel to see a detailed summary with responses and parameters of each endpoint, + the endpoint description, and the full structure of the endpoint. + + **Example:** + + endpoint detail + + :::note Notes: + * If a lock icon is visible on the right side of the endpoint panel, the endpoint requires authentication. + * The structure of the endpoint is displayed relative to the base URL. + * The URL path of the abbreviated endpoint relative to the base URL is displayed in the following format: + ::: + + **Example:** + + `/{yourServiceId}/api/v1/{endpointName}` + + The path of the full URL that includes the base URL is also displayed in the following format: + + `https://hostName:basePort/{yourServiceId}/api/v1/{endpointName}` + + Both links target the same endpoint location. diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-gateway-rest-apis-documentation.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-gateway-rest-apis-documentation.md new file mode 100644 index 0000000000..97d9256a24 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-gateway-rest-apis-documentation.md @@ -0,0 +1,7 @@ +# API Gateway REST APIs + +The API Gateway provides different functionalities and implements several REST APIs to leverage these functionalities: + +* [Update User Password](api-mediation-update-password.md) +* [JWT token refresh endpoint](api-mediation-jwt-token-refresh.md) +* [Personal Access Tokens](../api-mediation/authenticating-with-personal-access-token) diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-caching-service.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-caching-service.md new file mode 100644 index 0000000000..4af56e5e27 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-caching-service.md @@ -0,0 +1,137 @@ +# Using the Caching Service + +As an API developer, you can use the Caching Service as a storage solution to enable resource sharing between service instances, thereby ensuring High Availability of services. The Caching Service makes it possible to store, retrieve, and delete data associated with keys. The Caching Service is designed to make resource sharing possible for services that cannot be made stateless in two ways: + +- Using VSAM to store key/value pairs for production + +- Using InMemory + +:::note +In the current implementation of the Caching Service, VSAM is required for the storage of key/value pairs for production, as VSAM is a native z/OS solution for storing key/value pairs. +::: + +The Caching Service is available only for internal Zowe applications, and is not exposed to the internet. The Caching service supports a hot-reload scenario in which a client service requests all available service data. + +- [Architecture](#architecture) +- [Storage methods](#storage-methods) + - [Infinispan](#infinispan) + - [VSAM](#vsam) + - [Redis](#redis) + - [InMemory](#inmemory) +- [How to start the service](#how-to-start-the-service) +- [Methods to use the Caching service API](#methods-to-use-the-caching-service-api) +- [Configuration properties](#configuration-properties) +- [Authentication](#authentication) + +## Architecture + +A precondition to provide for High Availability of all components within Zowe is the requirement that these components be either stateless, or for the resources of the service, to be offloaded to a location accessible by all instances of the service. This condition also applies to recently started instances. Some services, however, are not and cannot be stateless. The Caching Service is designed for these types of services. + +REST APIs make it possible to create, delete, and update key-value pairs in the cache. Other APIs read a specific key-value pair or all key-value pairs in the cache. + +Information from cached APIs is stored as a JSON in the following format: +```yml +{ + “key”: “keyValue”, + “value”: “valueValue” +} +``` +## Storage methods + +The Caching Service supports the following storage solutions, which provide the option to add custom implementation. + +For information about configuring your storage method for the Caching Service for high availability, see [Configuring the Caching Service for high availability](../../user-guide/configure-caching-service-ha.md). + +### Infinispan (recommended) + +Infinispan is a storage solution that can also run on the z/OS platform. It can store data structures in key-value pairs, has high-availability support, and is highly performant. + +For more information about the Infinispan storage access method, see [Using Infinispan as a storage solution through the Caching service](../../extend/extend-apiml/api-mediation-infinispan.md). + +### VSAM + +VSAM can be used to organize records into four types of data sets: key-sequenced, entry-sequenced, linear, or relative record. Use VSAM as the storage solution for production. VSAM is used primarily for applications and is not used for source programs, JCL, or executable modules. ISPF cannot be used to display or edit VSAM files. + +For more information about the VSAM storage access method, see [Using VSAM as a storage solution through the Caching Service](../../extend/extend-apiml/api-mediation-vsam.md) + +### Redis + +Redis is a common storage solution that runs outside of the z/OS platform. It can store data structures in key-value pairs, has high-availability support, and is highly performant. + +For more information about the Redis storage access method, see [Using Redis as a storage solution through the Caching Service](../../extend/extend-apiml/api-mediation-redis.md). + + +### InMemory + +The InMemory storage method is a method suitable for testing and integration verification. Be sure not to use InMemory storage in production. +The key/value pairs are stored only in the memory of a single instance of the service. As such, the key/value pairs do not persist. + +## How to start the Service + +By default, the Caching Service starts along with the other Zowe components. To prevent the Caching Service from starting, set +`components.caching-service.enabled` to `false` in `zowe.yaml`. + +## Methods to use the Caching Service API + +To apply a method to the Caching Service, use the following API path: + +`/cachingservice/api/v1/cache/${path-params-as-needed}` + +Use the following methods with the Caching Service API: + +- **`POST /cache`** +Creates a new key in the Cache + +- **`GET /cache`** +Returns all key/value pairs for specific service + +- **`PUT /cache/{key}`** +Updates the existing value for the given key + +- **`GET /cache/{key}`** +Returns the existing value for the given key + +- **`DELETE /cache/{key}`** +Deletes a key/value pair + +## Configuration properties + +The Caching Service uses the standard `application.yml` structure for configuration. The service is built on top of the Spring enabler. As such, it dynamically registers to the API Mediation Layer. The service appears in the API Catalog under the tile, "Zowe Applications". + +* **`caching.storage.size`** +This property limits the size of the Caching Service. In the VSAM and InMemory implementations, this property represents the number of records stored before the eviction strategy is initiated. The default value is `100`. +**Note:** Different implementations may implement this property differently. + +* **`caching.storage.evictionStrategy`** +This parameter specifies service behavior when the limit of records is reached. The default value is `Reject`. + + where: + + * **reject** + rejects the new item with the HTTP status code `507` when the service reaches the configured maximum number + + * **removeOldest** + removes the oldest item in the cache when the service reaches the configured maximum number + +:::note +- For more information about how to configure the Caching Service in the `application.yml`, see + [Add API Onboarding Configuration](../../extend/extend-apiml/onboard-spring-boot-enabler). +- When using VSAM, ensure that you set the additional configuration parameters. For more information about setting these parameters, see [Using VSAM as a storage solution through the Caching Service](../../extend/extend-apiml/api-mediation-vsam). +::: + +## Authentication + +### Direct calls +The Caching Service requires TLS mutual authentication. This verifies authenticity of the client. Calls without a valid client certificate generate a `403` response code: `Forbidden`. This requirement is disabled when `VERIFY_CERTIFICATES=false` in `zowe-certificates.env` configuration file. + +The call must have a header `X-Certificate-DistinguishedName` containing information about the certificate's distinguished name. This header is added by the API Gateway. For a direct call, this header needs to be added manually. Calls without this header produce a `401` response code: `Unauthorized`. + +### Routed calls through API Gateway +Caching service registers with the following authentication scheme to Discovery service: + +```yaml +apiml.service.authentication.scheme: x509 +apiml.service.authentication.headers: X-Certificate-Public,X-Certificate-DistinguishedName,X-Certificate-CommonName +``` + +The result is that the Gateway attempts mutual authentication with the Client. If authentication is succesful, the Client's certificate information is propogated to `X-Certificate-` headers. With this scheme, the Gateway uses its server/client certificate for the routed call to the Caching Service. diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-jwt-token-refresh.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-jwt-token-refresh.md new file mode 100644 index 0000000000..896641c1e8 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-jwt-token-refresh.md @@ -0,0 +1,14 @@ +# JWT token refresh endpoint + +The API Gateway allows for the generation of a new token for a user based on a valid JWT token, made possible through the `auth/refresh` REST endpoint. The full path of the `auth/refresh` endpoint appears as `https://{gatewayUrl}:{gatewayPort}/gateway/api/v1/auth/refresh`. The new token overwrites the old cookie with a `Set-Cookie` header. As part of the process, the old token is invalidated and is no longer usable. + +The refresh request requires the token in one of the following formats: + +- A cookie named `apimlAuthenticationToken`. +- Bearer authentication + +:::note Notes: +- The endpoint is disabled by default. For more information, see [Enable JWT token endpoint](configuration-jwt.md#enable-jwt-token-refresh-endpoint). +- The endpoint is protected by a client certificate. + For more information, see the OpenAPI documentation of the API Mediation Layer in the API Catalog. +::: \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-multi-tenancy.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-multi-tenancy.md new file mode 100644 index 0000000000..95dd248c9c --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-multi-tenancy.md @@ -0,0 +1,295 @@ +# Routing MultiTenancy Configuration + +Zowe supports management of multiple sysplexes whereby different sysplexes can serve different purposes or different customers. The use case for multi-sysplex support is when a service provider manages sysplexes for multiple customers. This configuration makes it possible to have a single access point for all customers, and properly route and authenticate across different sysplexes. + +## Component Layout example + +In the multi-tenancy environment, certain Zowe components may be enabled, while others may be disabled. The multi-tenancy environment expects one central API ML that handles the discovery and registration as well as routing to the API ML installed in specific sysplexes. As such, different setups are required for the V2 version of the API ML on the central node and on the specific customer environments. + +When using a multi-tenancy environment, ensure that the following Zowe components are either enabled or disabled: + +- Domain API ML + - Gateway and Discovery Service: **enabled** + - Cloud Gateway: **disabled** + +- Central API ML + - Cloud Gateway and Discovery Service: **enabled** + - Gateway: **disabled** + +## Onboarding Domain Gateways to the central Cloud Gateway + +The Cloud Gateway must onboard all domain Gateways. This can be done dynamically or by the static definition. We strongly recommend using dynamic onboarding as this onboarding method adapts better to the potentially changing environments of the customer. Static onboarding does not provide the functionality to actively monitor the health of the specific services (e.g. domain gateways). + +### Dynamic Onboarding (recommended) for domain Gateways + +To dynamically onboard to the Discovery Service in the central cluster, set the following property for all domain Gateways: + +`components.gateway.apiml.service.additionalRegistration` + +Use the following example as a template for how to set the value for this property in zowe.yml. + +**Example:** +``` +components.gateway.apiml.service.additionalRegistration: + # central API ML (in HA, for non-HA mode use only 1 hostname) + - discoveryServiceUrls: https://ca32.lvn.broadcom.net:27554/eureka/,https://ca32.lvn.broadcom.net:37554/eureka/ + routes: + - gatewayUrl: / + serviceUrl: / +``` + +:::note +It is not necessary for the Gateway service to provide different routing patterns for the central discovery service. These metadata can be the same for every cluster. +::: + +### Static Onboarding for domain Gateways (deprecated) + +Alternatively, you can statically onboard all domain Gateways on the Central Discovery service. Note that dynamic onboarding is the prefered method. + +For static onboarding, make sure that the following parameters are correctly specified in the static definition file: + +- **services.serviceId** + Specify this parameter to GATEWAY +- **services.instanceBaseUrls** + Specifies the URL of the Domain Gateway +- **services.customMetadata.apiml.service.apimlId** + Specifies the id of the API ML environment + +For static onboarding, be sure to use the [Gateway static definition example](#gateway-static-definition-example) presented at the end of this article. + +## Establishing a trust relationship between domain Gateways and the Cloud Gateway + +The following keytool commands are examples of establishing a trust relationship between domain Gateways and the Cloud Gateway. + +- Import the public key certificate of all domain Gateways into the truststore of the Cloud Gateway. + + Use the following example of the keytool command when the domain Gateways running on CA11 and CA32 import the certificate into the Cloud Gateway running on CA31: + + `keytool -import -file keystore/ca11/local_ca/local_ca.cer -alias gateway_ca11 -keystore keystore/ca31/localhost/localhost.truststore.p12` + + `keytool -import -file keystore/ca32/local_ca/local_ca.cer -alias gateway_ca32 -keystore keystore/ca31/localhost/localhost.truststore.p12` + +- Import a public key certificate of the Cloud Gateway into the truststore of all domain Gateways. + + Use the following example of the keytool command when the certificate of the Cloud Gateway running on CA31 is imported into the truststore of the domain Gateways running on CA11 and CA32: + + `keytool -import -file keystore/ca31/local_ca/local_ca.cer -alias gateway_ca31 -keystore keystore/ca11/localhost/localhost.truststore.p12` + + `keytool -import -file keystore/ca31/local_ca/local_ca.cer -alias gateway_ca31 -keystore keystore/ca32/localhost/localhost.truststore.p12` + +## Using the /registry endpoint in Cloud Gateway + +The `/registry` endpoint provides information about services onboarded to all domain Gateways and the Central Gateway. This section describes the configuration, authentication, authorization, example of requests, and responses when using the `/registry` endpoint. + +### Configuration for `/registry` + +The `/registry` endpoint is disabled by default. Use the following environment variable to enable this feature: + +`APIML_CLOUDGATEWAY_REGISTRY_ENABLED=TRUE` + +### Authentication for `/registry` +The `/registry` endpoint is authenticated by the client certificate. Cloud Gateway accepts certificates that are trusted. The user name is obtained from the common name of the client certificate. + +Unsuccessful authentication returns a 401 error code. + +### Authorization with `/registry` +Only users configured by the following environment variable are allowed to use the `/registry` endpoint. + +`APIML_SECURITY_X509_REGISTRY_ALLOWEDUSERS=USER1,user2,User3` + +This parameter makes it possible to set multiple users as a comma-separated list. + +Unsuccessful authorization returns a 403 error code. + +### Requests with `/registry` + +There are two endpoints that provide information about services registered to the API ML. One endpoint is for all domains, and the other endpoint is for the specific domain. Choose from the following **GET** calls: + +* `GET /cloud-gateway/api/v1/registry` +This request lists services in all domains. + +* `GET /cloud-gateway/api/v1/registry/{apimlId}` +This request lists services in the apimlId domain. + +### Response with `/registry` + +**Example:** + +``` +[ + { + "apimlId": "apiml1", + "services": [ + { + "status": "UP", + "customMetadata": {}, + "apiId": [ + "zowe.apiml.gateway" +], + "serviceId": "gateway" + } + ] + }, + { + "apimlId": "apiml2", + "services": [ + { + "status": "UP", + "customMetadata": {}, + "apiId": [ + "zowe.apiml.gateway" +], + "serviceId": "gateway" + } + ] +] +``` + +## Validate successful configuration with `/registry` + +Use the `/registry` endpoint to validate successful configuration. The response should contain all API ML domains represented by `apimlId`, and information about onboarded services. + +## Troubleshooting + +### ZWESG100W + +Cannot receive information about services on API Gateway with apimlId 'Gateway-CA32' because: Received fatal alert: certificate_unknown; nested exception is javax.net.ssl.SSLHandshakeException: Received fatal alert: certificate_unknown + +**Reason** +The trust between the domain and the Cloud Gateway was not established. + +**Action** +Review your certificate configuration. + +### No debug messages similar to Gateway-CA32 completed with onComplete are produced + + **Reason** + Domain Gateway is not correctly onboarded to Discovery Service in Central API ML. + + **Action** + Review Gateway static definition. Check the Central Discovery Service dashboard if the domain Gateway is displayed. + +## Onboarding a domain cloud-gateway service to central discovery service + +The central Cloud Gateway can onboard Cloud Gateways of all domains. This service onboarding can be achieved similar to additional registrations of the Gateway. This section describes the dynamic configuration of the yaml file and environment variables, and how to validate successful configuration. + +- Dynamic configuration via zowe.yaml +- Dynamic configuration via Environment variables + +### Dynamic Configurations to the central Discovery Service + +#### Dynamic configuration: YML + +Users must set the following property for the domain cloud-gateway to dynamically onboard to the central Discovery Service. + +`components.cloud-gateway.apiml.service.additionalRegistration` + +Use the following example as a template for how to set the value of this property in zowe.yml. + +**Example:** +``` +components.cloud-gateway.apiml.service.additionalRegistration: + # central API ML (in HA, for non-HA mode use only 1 hostname) + - discoveryServiceUrls: https://ca32.lvn.broadcom.net:27554/eureka/,https://ca32.lvn.broadcom.net:37554/eureka/ + routes: + - gatewayUrl: / + serviceUrl: / +``` + +#### Dynamic configuration: Environment variables + +The list of additional registrations is extracted from environment variables. You can define a list of objects by following YML->Environment translation rules. + +The previous example can be substituted with the following variables: + +``` +ZWE_CONFIGS_APIML_SERVICE_ADDITIONALREGISTRATION_0_DISCOVERYSERVICEURLS=https://ca32.lvn.broadcom.net:27554/eureka/,https://ca32.lvn.broadcom.net:37554/eureka/ +ZWE_CONFIGS_APIML_SERVICE_ADDITIONALREGISTRATION_0_ROUTES_0_GATEWAYURL=/ +ZWE_CONFIGS_APIML_SERVICE_ADDITIONALREGISTRATION_0_ROUTES_0_SERVICEURL=/ +``` + +This Zowe configuration transforms the zowe.yaml configuration file into the environment variables that are shown above. + +### Validating successful configuration + +The corresponding ‘Cloud-Gateway’ service should appear in the Eureka console of the central discovery service. + +To see details of all instances of the ‘CLOUD-GATEWAY’ application, perform a **GET** call on the following endpoint of the central discovery service: + +``` +/eureka/apps +``` + +## Gateway static definition example +This file should be stored together with other statically onboarded services. The default location is `/zowe/runtime/instance/workspace/api-mediation/api-defs/`. There is no naming restriction of the filename, but the file extension must be yml. + +**Example:** +``` +# +# Static definition of "discoverable-client" as "staticclient" +# +# This file provides static API service definition in YAML format. +# It is loaded by the Discovery Service during its startup. +# +services: + - serviceId: GATEWAY # unique lowercase ID of the service + catalogUiTileId: static # ID of the API Catalog UI tile (visual grouping of the services) + title: Statically Defined API Service # Title of the service in the API catalog + description: Sample to demonstrate how to add an API service with Swagger to API Catalog using a static YAML definition # Description of the service in the API catalog + instanceBaseUrls: # list of base URLs for each instance + - https://ca32.lvn.broadcom.net:27554/ # scheme://hostname:port/contextPath + homePageRelativeUrl: / # Normally used for informational purposes for other services to use it as a landing page + statusPageRelativeUrl: /application/info # Appended to the instanceBaseUrl + healthCheckRelativeUrl: /application/health # Appended to the instanceBaseUrl + routes: + - gatewayUrl: api/v1 # [api/ui/ws]/v{majorVersion} + serviceRelativeUrl: /api/v1 # relativePath that is added to baseUrl of an instance + - gatewayUrl: ui/v1 + serviceRelativeUrl: / + - gatewayUrl: ws/v1 + serviceRelativeUrl: /ws + # List of APIs provided by the service (currently only one is supported): + apiInfo: + - apiId: zowe.apiml.gateway + gatewayUrl: api/v1 + swaggerUrl: https://localhost:10012/discoverableclient/v2/api-docs + customMetadata: + apiml: + service.apimlId: Gateway-CA32 + okToRetryOnAllOperations: true + + + - serviceId: GATEWAY # unique lowercase ID of the service + catalogUiTileId: static # ID of the API Catalog UI tile (visual grouping of the services) + title: Statically Defined API Service # Title of the service in the API catalog + description: Sample to demonstrate how to add an API service with Swagger to API Catalog using a static YAML definition # Description of the service in the API catalog + instanceBaseUrls: # list of base URLs for each instance + - https://ca11.lvn.broadcom.net:27554/ # scheme://hostname:port/contextPath + homePageRelativeUrl: / # Normally used for informational purposes for other services to use it as a landing page + statusPageRelativeUrl: /application/info # Appended to the instanceBaseUrl + healthCheckRelativeUrl: /application/health # Appended to the instanceBaseUrl + routes: + - gatewayUrl: api/v1 # [api/ui/ws]/v{majorVersion} + serviceRelativeUrl: /api/v1 # relativePath that is added to baseUrl of an instance + - gatewayUrl: ui/v1 + serviceRelativeUrl: / + - gatewayUrl: ws/v1 + serviceRelativeUrl: /ws + # List of APIs provided by the service (currently only one is supported): + apiInfo: + - apiId: zowe.apiml.gateway + gatewayUrl: api/v1 + swaggerUrl: https://localhost:10012/discoverableclient/v2/api-docs + customMetadata: + apiml: + service.apimlId: Gateway-CA11 + okToRetryOnAllOperations: true + + +# List of tiles that can be used by services defined in the YAML file: +catalogUiTiles: + static: + title: Static API Services + description: Services which demonstrate how to make an API service discoverable in the APIML ecosystem using YAML definitions + +``` diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-overview.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-overview.md new file mode 100644 index 0000000000..5857138d42 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-overview.md @@ -0,0 +1,50 @@ +# API Mediation Layer + +The API Mediation Layer provides a single point of access for mainframe service REST APIs. The layer offers enterprise, cloud-like features such as high-availability, scalability, dynamic API discovery, consistent security, a single sign-on experience, and documentation. The API Mediation Layer facilitates secure communication across loosely coupled microservices through the API Gateway. The API Mediation Layer consists of three components: the Gateway, the Discovery Service, and the Catalog. The Gateway provides secure communication across loosely coupled API services. The Discovery Service enables you to determine the location and status of service instances running inside the API ML ecosystem. The Catalog provides an easy-to-use interface to view all discovered services, their associated APIs, and Swagger documentation in a user-friendly manner. + +## Key features +* Consistent Access: API routing and standardization of API service URLs through the Gateway component provides users with a consistent way to access mainframe APIs at a predefined address. +* Dynamic Discovery: The Discovery Service automatically determines the location and status of API services. +* High-Availability: API Mediation Layer is designed with high-availability of services and scalability in mind. +* Redundancy and Scalability: API service throughput is easily increased by starting multiple API service instances without the need to change configuration. +* Presentation of Services: The API Catalog component provides easy access to discovered API services and their associated documentation in a user-friendly manner. Access to the contents of the API Catalog is controlled through a z/OS security facility. +* Encrypted Communication: API ML facilitates secure and trusted communication across both internal components and discovered API services. + +## API Mediation Layer architecture +The following diagram illustrates the single point of access through the Gateway, and the interactions between API ML components and services: + +![API Mediation Layer Architecture diagram](./diagrams/service-relationship-diagram.png) + +## Components +The API Layer consists of the following key components: + +### API Gateway + +Services that comprise the API ML service ecosystem are located behind a gateway (reverse proxy). All end users and API client applications interact through the Gateway. Each service is assigned a unique service ID that is used in the access URL. Based on the service ID, the Gateway forwards incoming API requests to the appropriate service. Multiple Gateway instances can be started to achieve high-availability. The Gateway access URL remains unchanged. The Gateway is built using Netflix Zuul and Spring Boot technology. + +### Discovery Service + +The Discovery Service is the central repository of active services in the API ML ecosystem. The Discovery Service continuously collects and aggregates service information and serves as a repository of active services. When a service is started, it sends its metadata, such as the original URL, assigned serviceId, and status information to the Discovery Service. Back-end microservices register with this service either directly or by using a Eureka client. Multiple enablers are available to help with service on-boarding of various application architectures including plain Java applications and Java applications that use the Spring Boot framework. The Discovery Service is built on Eureka and Spring Boot technology. + +#### Discovery Service TLS/SSL + +HTTPS protocol can be enabled during API ML configuration and is highly recommended. Beyond encrypting communication, the HTTPS configuration for the Discovery Service enables hightened security for service registration. Without HTTPS, services provide a username and password to register in the API ML ecosystem. When using HTTPS, only trusted services that provide HTTPS certificates signed by a trusted certificate authority can be registered. + +### API Catalog + +The API Catalog is the catalog of published API services and their associated documentation. The Catalog provides both the REST APIs and a web user interface (UI) to access them. The web UI follows the industry standard Swagger UI component to visualize API documentation in OpenAPI JSON format for each service. A service can be implemented by one or more service instances, which provide exactly the same service for high-availability or scalability. + +#### Catalog Security + +Access to the API Catalog can be protected with an Enterprise z/OS Security Manager such as IBM RACF, ACF2, or Top Secret. Only users who provide proper mainframe credentials can access the Catalog. Client authentication is implemented through the zOSMF API. + +## Onboarding APIs +The most important part of the ecosystem are the real API services that provide useful APIs. Use the following topics to understand what options you have for adding new APIs to the Mediation Layer: + +* [Onboarding Overview](../../extend/extend-apiml/onboard-overview.md) + +## Caching service + +The Caching service aims to provide an API which offers the possibility to store, retrieve and delete data associated with keys. The service is used only by internal Zowe applications and is not exposed to the internet. The URL of the Caching service is `https://:7555`. +For more information, see [Using the Caching Service](../api-mediation/api-mediation-caching-service). + diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-personal-access-token.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-personal-access-token.md new file mode 100644 index 0000000000..5c78228a92 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-personal-access-token.md @@ -0,0 +1,3 @@ +# Personal Access Token + +The Personal access token documentation has been moved to: [Authenticating with a Personal Access Token](./authenticating-with-personal-access-token.md). \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-smf.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-smf.md new file mode 100644 index 0000000000..b9b99400e0 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-smf.md @@ -0,0 +1,89 @@ +# SMF records + +API Mediation Layer can issue SMF type 83, 230, or 231 security-related audit records. You can use SMF records to assist with auditing events when a Personal Access Token is created. + +To enable this functionality on your Zowe instance, see the [configuration procedure](#configure-the-main-zowe-server-to-issue-smf-records). + +It is possible to customize some predefined values in the SMF record. For more information, see the [full list of configurable parameters](#smf-record-configurable-parameters). + +**Note:** Record type 83 is a RACF processing record. This record type can be replaced by other SMF types depending on the ESM: +* ACF2 - SMF type 230 +* TSS - SMF type 231 + +## Configure the main Zowe server to issue SMF records + +This security configuration is necessary for API ML to be able to issue SMF records. A user running the API Gateway must have _read_ access to the RACF general resource `IRR.RAUDITX` in the `FACILITY` class. +To set up this security configuration, submit the `ZWESECUR` JCL member. For users upgrading from version 1.18 and lower, use the configuration steps that correspond to the ESM. + +To check whether you already have the auditing profile defined, issue the following command and review the output to confirm that the profile exists and that the user `ZWESVUSR` who runs the `ZWESLSTC` started task has `READ` access to this profile. + +- If you use RACF, issue the following command: + ``` + RLIST FACILITY IRR.RAUDITX AUTHUSER + ``` +- If you use Top Secret, issue the following command: + ``` + TSS WHOHAS IBMFAC(IRR.RAUDITX) + ``` +- If you use ACF2, issue the following commands: + ``` + SET RESOURCE(FAC) + ``` + ``` + LIST LIKE(IRR-) + ``` + +If the user `ZWESVUSR` who runs the `ZWESLSTC` started task does not have `READ` access to this profile, follow the procedure that corresponds to your ESM: + +- If you use RACF, update permission in the `FACILITY` class. + + **Follow these steps:** + + 1. Add user `ZWESVUSR` permission to `READ`. + ``` + PERMIT IRR.RAUDITX CLASS(FACILITY) ACCESS(READ) ID(ZWESVUSR) + ``` + 2. Activate changes. + ``` + SETROPTS RACLIST(FACILITY) REFRESH + ``` + +- If you use Top Secret, add user `ZWESVUSR` permission to `READ`. Issue the following command: + ``` + TSS PER(ZWESVUSR) IBMFAC(IRR.RAUDITX) ACCESS(READ) + ``` + +- If you use ACF2, add user `ZWESVUSR` permission to `READ`. Issue the following commands: + ``` + SET RESOURCE(FAC) + ``` + ``` + RECKEY IRR ADD(RAUDITX ROLE(&STCGRP.) SERVICE(READ) ALLOW) + ``` + ``` + F ACF2,REBUILD(FAC) + ``` + +## SMF record configurable parameters + +The following list of parameters can be used to modify the default SMF record values. Default values for these parameters can be overwritten in `zowe.yaml`. For more information, see [how to configure rauditx parameters](#configure-rauditx-parameters). + +| Parameter | Description | Type | Default value | +|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|:-------------:| +| rauditx.fmid | FMID of the product or component issuing the SMF record | string | AZWE001 | +| rauditx.component | Name of the product or component issuing the SMF record | string | ZOWE | +| rauditx.subtype | SMF type 83 record subtype assigned to the component. For more information, see [description of subtypes](https://www.ibm.com/docs/en/zos/2.5.0?topic=records-record-type-83-security-events) | integer | 2 | +| rauditx.event | Event code. For more information, see [description of event codes](https://www.ibm.com/docs/en/zos/2.5.0?topic=descriptions-event-codes-event-code-qualifiers) | integer | 2 | +| rauditx.qualifier.success | Event Code Qualifier for success. The value can be between 0 and 255 | integer | 0 | +| rauditx.qualifier.failed | Event Code Qualifier for failure. The value can be between 0 and 255 | integer | 1 | + +### Configure rauditx parameters + +Use the following procedure to change the `rauditx.fmid` parameter. This procedure can be applied to any SMF record configurable parameters. + +**Follow these steps:** + +1. Open the `zowe.yaml` configuration file. +2. Find or add the property `zowe.environments.RAUDITX_FMID` and set your desired value. +3. Restart Zowe. + diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-update-password.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-update-password.md new file mode 100644 index 0000000000..badd80e069 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/api-mediation-update-password.md @@ -0,0 +1,58 @@ +# Updating user password + +You can use the API ML to update a mainframe password. The Mainframe password change is possible through Gateway REST APIs and is supported by two authentication providers: + +* [Change password with SAF provider](#change-password-with-saf-provider) +* [Change password with z/OSMF provider](#change-password-with-zosmf-provider) + +:::note +This feature is also available in the API Catalog. For more information about how to update the mainframe password via API Catalog, see [Change expired password via API Catalog](../api-mediation-change-password-via-catalog.md). +::: + +## Changing password with SAF provider + +Update the user password using the SAF Authentication provider. To use this functionality, add the parameter `newPassword` on the login endpoint `/gateway/api/v1/auth/login` in a `POST` call to this endpoint. + +The Gateway service returns a valid JWT with the response code `204` as a result of successful password change. The user is then authenticated and can consume APIs through the Gateway. +A response code of `401` is thrown if it is not possible to change the password for any reason. + +Use the following request body format in the `POST` REST call against the URL `/gateway/api/v1/auth/login`: + + ``` + { + "username" : "", + "password" : "", + "newPassword" : "" +} +``` + +:::note +It is a common practice to set a limit to the number of password changes permissible in the ESM. This value is set by the parameter `MINCHANGE` for `PASSWORD`. The password can be changed once. Subsequently, it is necessary to wait the specified time period before the password can be changed again. +::: + +**Example:** + +`MINCHANGE=120` + +* **`120`** +Specifies the number of days before the password can be reset + +## Changing password with z/OSMF provider + +Update the user password using the z/OSMF Authentication provider. To use this functionality, add the parameter `newPassword` on the login endpoint `/gateway/api/v1/auth/login` in a `POST` call to this endpoint. + +The Gateway service returns a valid JWT with the response code `204` as a result of successful password change. The user is then authenticated and can consume APIs through the Gateway. A response code of `401` is thrown if it is not possible to change the password. + +Use the following request body format in the `POST` REST call against the URL `/gateway/api/v1/auth/login`: + + ``` + { + "username" : "", + "password" : "", + "newPassword" : "" +} +``` + +:::note +In order to use the password change functionality via z/OSMF, it is necessary to install the PTF for APAR PH34912. +::: \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/authenticating-with-personal-access-token.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/authenticating-with-personal-access-token.md new file mode 100644 index 0000000000..5ba6fa5850 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/authenticating-with-personal-access-token.md @@ -0,0 +1,275 @@ +# Authenticating with a Personal Access Token + +:::info Required roles: system programmer, security administrator +::: + +You can use API Mediation Layer to generate, validate, and invalidate a **Personal Access Token (PAT)** that can enable access to tools such as VCS without having to use credentials of a specific person. The use of PAT does not require storing mainframe credentials as part of the automation configuration on a server during application development on z/OS. +Additionally, using a PAT makes it possible to limit access to specific services and users by means of token revocation when using a token. + +Gateway APIs are available to both users as well as security administrators. +APIs for users can accomplish the following functions: + +[User APIs](#user-apis) + * [Generate a token](#generate-a-token) + * [Validate a token](#validate-a-token) + * [Invalidate a specific token](#invalidate-a-specific-token) + * [Invalidate all tokens](#invalidate-all-tokens) + +APIs for security administrators are protected by SAF resource checking and can accomplish the following functions: + +[Security Administrator APIs](#security-administrator-apis) + * [Invalidate all tokens for a user](#invalidate-all-tokens-for-a-user) + * [Invalidate all tokens for a service](#invalidate-all-tokens-for-a-service) + * [Evict non-relevant tokens and rules](#evict-non-relevant-tokens-and-rules) + +:::note +An SMF record can be issued when a Personal Access Token is generated. For more information, see [SMF records issued by API ML](api-mediation-smf.md) +::: + +For detailed information about using the Personal Access Token as part of single sign on, see the section [Using the Personal Access Token to authenticate](#using-the-personal-access-token-to-authenticate) later in this article. + +:::tip +For additional information, see the Medium blog post [Personal Access Tokens for the Zowe API Mediation Layer](https://medium.com/zowe/personal-access-tokens-for-the-zowe-api-mediation-layer-53e383ff1e61). +::: + +## User APIs + +### Generate a token + +A user can create the Personal Access Token by calling the following REST API endpoint through the Gateway: + +`POST /auth/access-token/generate` + +The full path of the `/auth/access-token/generate` endpoint appears as: +`https://{gatewayUrl}:{gatewayPort}/gateway/api/v1/auth/access-token/generate`. + +The request requires the body in the following format: + +```json +{ + "validity": 90, + "scopes": [","] +} +``` + +* **validity** +Specifies the expiration time of the token. The maximum threshold is 90 days. + +* **scopes** + Specifies the access limits on a service level. This parameter introduces a higher level of security in some aspects. Users are required to provide a scope. If no service is specified, it is not possible to authenticate using the token. + +When creation is successful, the response to the request is a body containing the PAT with a status code of `200`. When creation fails, the user receives a status code of `401`. + +### Validate a token + +The user can validate the Personal Access Token by calling the following REST API endpoint through the Gateway: + +`POST /auth/access-token/validate` + +The full path of the `/auth/access-token/validate` endpoint appears as `https://{gatewayUrl}:{gatewayPort}/gateway/api/v1/auth/access-token/validate`. + +The request requires the body in the following format: + +```json +{ + "token": "", + "serviceId": "" +} +``` + +:::note +The user has the option of calling this API to validate the token, however, validation is also automatically performed by the API ML. +::: + +When validation is successful, the response to the request is an empty body with a status code of `200`. When validation fails, the user receives a status code of `401`. + +### Invalidate a specific token + +The user can invalidate the Personal Access Token by calling the following REST API endpoint through the Gateway: + +`DELETE /auth/access-token/revoke` + +The full path of the `/auth/access-token/revoke` endpoint appears as `https://{gatewayUrl}:{gatewayPort}/gateway/api/v1/auth/access-token/revoke`. + +The request requires the body in the following format: + +```json +{ + "token": "" +} +``` + +When the `/auth/access-token/revoke` endpoint is called, the provided hash of the PAT is stored in the cache by the Caching Service under the `invalidTokens` key. As such, the token is invalidated. +Access to these entries is protected by the API ML client certificate. + +When invalidation is successful, the response to the request is an empty body with a status code of `200`. When invalidation fails, the user receives a status code of `401`. + +### Invalidate all tokens + +The user can invalidate all Personal Access Tokens by calling the following REST API endpoint through the Gateway: + +`DELETE /auth/access-token/revoke/tokens` + +The full path of the `/auth/access-token/revoke/tokens` endpoint appears as `https://{gatewayUrl}:{gatewayPort}/gateway/api/v1/auth/access-token/revoke/tokens`. + +The body can optionally provide a timestamp as part of the request. Use the following format for the body: + +```json +{ + "timestamp": "" +} +``` + +If the body is not provided, the timestamp value defaults to the current date. + +When the `/auth/access-token/revoke/tokens` endpoint is called, the provided user rule is stored in the cache by the Caching Service under the `invalidUsers` key. As such, all of the tokens of the user are invalidated. +Access to these entries is protected by the client certificate of the API ML. + +When invalidation is successful, the response to the request is an empty body with a status code of `200`. When invalidation fails, the user receives a status code of `401`. + +## Security Administrator APIs + +### Invalidate all tokens for a user + +If a security breech is suspected, the security administrator can invalidate all the tokens based on criteria as established by **rules**. +Such criteria define the level of access control and can restrict access in advance. Rule based access restriction can be applied by either user ID or service scopes. + +:::note +_Rules_ are entries used to revoke the tokens either by users or by services. Such rule entries for services appear in the following format: +::: +``` +{ + "serviceId": "", + "timestamp": "" +} +``` +Rule entries for users appear in the following format: +``` +{ + "userId": "", + "timestamp": "" +} +``` +The Security Administrator with specific access to SAF resources can invalidate all tokens bound to a specific user by calling the following REST API endpoint through the Gateway: + +`DELETE /auth/access-token/revoke/tokens/users` + +The full path of the `/auth/access-token/revoke/tokens/users` endpoint appears as `https://{gatewayUrl}:{gatewayPort}/gateway/api/v1/auth/access-token/revoke/tokens/users`. + +The request requires the body in the following format: + +```json +{ + "userId": "", + "timestamp": "" +} +``` +* **userId** +Specifies the user the revocation is applied to. + +* **timestamp** +Specifies the date of revocation (the default value is the current time) in milliseconds. The timestamp is +used to specify that tokens created before the date specified in the timestamp are invalidated. As such, any subsequent tokens created after that date are not affected by the user rule. + +By calling this endpoint, the user rule is stored in the cache by the Caching Service under the `invalidUsers` key. + +When invalidation is successful, the response to the request is an empty body with a status code of `200`. When invalidation fails, the user receives a status code of `401`. + +### Invalidate all tokens for a service + +A security administrator who has specific access to SAF resources can invalidate all tokens bound to a specific service by calling the following REST API endpoint through the Gateway: + +`DELETE /auth/access-token/revoke/tokens/scope` + +The full path of the `/auth/access-token/revoke/tokens/scope` endpoint appears as `https://{gatewayUrl}:{gatewayPort}/gateway/api/v1/auth/access-token/revoke/tokens/scope`. + +The request requires the body in the following format: + +```json +{ + "serviceId": "", + "timestamp": "" +} +``` + +Invalidation of all tokens is possible by using rules based on service scopes. + +* **serviceId** +Specifies the service to which the revocation should be applied (e.g. APPL IDs). + +* **timestamp** +Specifies the date of revocation (the default value is the current time) in milliseconds. A timestamp is +used to state that tokens created before the date specified in the timestamp are invalidated. As such, any subsequent tokens created +after that date are not affected by the service rule. + +Calling this endpoint stores the service rule in the cache by the Caching Service under the `invalidScopes` key. + +When invalidation is successful, the response to the request is an empty body with a status code of `200`. When invalidation fails, the user receives a status code of `401`. + +### Evict non-relevant tokens and rules + +The Security Administrator with specific access to SAF resources can evict non-relevant invalidated tokens and rules from the cache by calling the following REST API endpoint through the Gateway: + +`DELETE /auth/access-token/evict` + +The full path of the `/auth/access-token/evict` endpoint appears as `https://{gatewayUrl}:{gatewayPort}/gateway/api/v1/auth/access-token/evict`. + +The `/auth/access-token/evict` endpoint evicts all invalidated tokens which were expired and all the rules related to the expired tokens. + +The main purpose of the eviction API is to ensure that the size of the cache does not grow unbounded. The token verification process requires processing of all rules, including those which may no longer be applicable. As such, verification processing may result in needless associated costs if there are stored rules which are no longer relevant. + +When eviction is successful, the response to the request is an empty body with a status code of `204`. When eviction fails due to lack of permissions, the administrator receives a status code of `403`. + +## Using the Personal Access Token to authenticate + +There are four ways the API client can use the Personal Access Token to authenticate as part of the Single Sign On in which a service is specified in the scopes at the time when the token is issued: + +* Using the `Authorization: Bearer` request header. + + **Example:** + + ``` + GET //api/v1/request HTTP/1.1 + Authorization: Bearer eyJhbGciOiJSUzI1NiJ9... + + HTTP/1.1 200 + ... + ``` + +* Using a Secure HttpOnly cookie with the name `apimlAuthenticationToken`. + + **Example:** + + ``` + GET //api/v1/request HTTP/1.1 + Cookie: apimlAuthenticationToken=eyJhbGciOiJSUzI1NiJ9... + + HTTP/1.1 200 + ... + ``` + +* Using a Secure HttpOnly cookie with the name `personalAccessToken`. + + **Example:** + + ``` + GET //api/v1/request HTTP/1.1 + Cookie: personalAccessToken=eyJhbGciOiJSUzI1NiJ9... + + HTTP/1.1 200 + ... + ``` +* Using a request header with the name `PRIVATE-TOKEN`. + + **Example:** + + ``` + GET //api/v1/request HTTP/1.1 + PRIVATE-TOKEN: eyJhbGciOiJSUzI1NiJ9... + + HTTP/1.1 200 + ... + ``` +In these examples, the API client is authenticated. + +If the API client tries to authenticate with a service that is not defined in the token scopes, the `X-Zowe-Auth-Failure` error header is set and passed to the southbound service. The error message contains a message that the provided authentication is not valid. diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-access-specific-instance-of-service.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-access-specific-instance-of-service.md new file mode 100644 index 0000000000..ae9b335f09 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-access-specific-instance-of-service.md @@ -0,0 +1,16 @@ +# Retrieving a specific service within your environment + +:::info Roles: system programmer, system administrator +::: + +## Output a routed instance header + +The API Gateway can output a special header that contains the value of the instance ID of the API service that the request has been routed to. This is useful for understanding which service instance is being called. + +The header name is `X-InstanceId`, and the sample value is `discoverable-client:discoverableclient:10012`. This is identical to `instanceId` property in the registration of the Discovery service. + +Use the following procedure to output a special header that contains the value of the instance ID of the API service. + +1. Open the file `zowe.yaml`. +2. Find or add the property with value `components.gateway.apiml.routing.instanceIdHeader:true`. +3. Restart Zowe. diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-api-mediation-standalone.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-api-mediation-standalone.md new file mode 100644 index 0000000000..72943a5307 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-api-mediation-standalone.md @@ -0,0 +1,17 @@ +# Limit started Zowe services to API Mediation Layer + +As a Zowe user, follow the procedure in this article to start the API Mediation Layer independently of other Zowe components. +By default, the Gateway, Zowe System Services, and Virtual Desktop start when + Zowe runs. To limit consumed resources when the Virtual Desktop or Zowe System + Services are not required, it is possible to specify which components start in the + context of Zowe. No change is required during the installation process to + support this setup. + +Once Zowe is installed, use the following procedure to limit which components start. Keep in mind that Zowe System Services are needed +for some of the functionalities of the API Mediation Layer such as Client Certificates or OIDC + +**Follow these steps:** + +1. Open the file `zowe.yaml`. +2. Find or add the property `components.*.enabled` and set this property to `false` for all components that should not be started. +3. Restart `Zowe&trade`. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-at-tls.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-at-tls.md new file mode 100644 index 0000000000..ea5de0a577 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-at-tls.md @@ -0,0 +1,295 @@ +# Configuring AT-TLS for API Mediation Layer + +The communication server on z/OS provides a functionality to encrypt HTTP communication for on-platform running jobs. This functionality is refered to as Application Transparent Transport Layer Security (AT-TLS). + +Review this article for descriptions of the configuration parameters required to make the Zowe API Mediation Layer work with AT-TLS, and security recommendations. + +:::info Role: security administrator +::: + +- [AT-TLS configuration for Zowe](#at-tls-configuration-for-zowe) +- [AT-TLS rules](#at-tls-rules) + - [Inbound rules](#inbound-rules) + - [Outbound rules](#outbound-rules) + - [For z/OSMF](#for-zosmf) + - [For communication between API Gateway and other core services](#for-communication-between-api-gateway-and-other-core-services) + - [For communication between API Gateway and southbound services](#for-communication-between-api-gateway-and-southbound-services) + - [Ciphers](#ciphers) +- [Using AT-TLS for API ML in High Availability](#using-at-tls-for-api-ml-in-high-availability) +- [AT-TLS Troubleshooting](#at-tls-troubleshooting) + +## AT-TLS configuration for Zowe + +:::tip +Support for AT-TLS was introduced in Zowe v1.24. In this early version, startup was not possible in some versions of Zowe. For full support, we recommend that you upgrade to v2.13 or a later version of Zowe. +::: + +Follow these steps to configure Zowe to support AT-TLS: + +1. Enable the AT-TLS profile and disable the TLS application in API ML. +Update `zowe.yaml` with the following values under `gateway`, `discovery`, `api-catalog`, `caching-service` and `metrics-service` in the `zowe.components` section. + +**Example:** + +```yaml +zowe: + components: + gateway: + spring: + profiles: + active: attls + server: + ssl: + enabled: false + server: + internal: + ssl: + enabled: false + + discovery: + spring: + profiles: + active: attls + server: + ssl: + enabled: false +``` + +While API ML does not handle TLS on its own with AT-TLS enabled, API ML requires information about the server certificate that is defined in the AT-TLS rule. Esure that the server certificates provided by the AT-TLS layer are trusted in the configured Zowe keyring. Ideally, AT-TLS should be configured with the same Zowe keyring. + +2. If there is an outbound AT-TLS rule configured for the link between the API Gateway and z/OSMF, set the `zowe.zOSMF.scheme` property to `http`. + +:::note Notes +* Currently, AT-TLS is not supported in the API Cloud Gateway Mediation Layer component. + +* As the Gateway is a core component of API ML, other components that need to interact with the Gateway, such as Zowe ZLUX App Server, also require AT-TLS configuration. +::: + +:::caution Important security consideration + +Configuring AT-TLS for the Zowe API Mediation Layer requires careful consideration of security settings, specifically as these settings apply to the Client Certificate authentication feature in Zowe API Mediation Layer components, as well as for onboarded services that support the x.509 client certificates authentication scheme. + +Outbound AT-TLS rules (i.e. to make a transparent https call through http) that are configured to send the server certificate should be limited to the services that __require__ service to service authentication. If an API ML-onboarded southbound service needs to support x.509 client certificate authentication, we recommend to use the integrated TLS handshake capabilities of API ML. Do not configure an outbound AT-TLS rule for these services. + +The Discovery Service endpoints are not reachable by standard API Gateway routing by default. +::: + +## AT-TLS rules + +This section describes suggested AT-TLS settings, and serves as guidelines to set your AT-TLS rules. + +### Inbound rules + +A generic inbound rule can be set for all core API Mediation Layer services: + +```pagent +TTLSRule ApimlServerRule +{ + LocalAddr All + RemoteAddr All + LocalPortRange 10310-10320 + Jobname ZWE* + Direction Inbound + TTLSGroupActionRef ServerGroupAction + TTLSEnvironmentActionRef ApimlServerEnvironmentAction + TTLSConnectionActionRef ApimlServerConnectionAction +} + +TTLSGroupAction ServerGroupAction +{ + TTLSEnabled On +} + +TTLSEnvironmentAction ApimlServerEnvironmentAction +{ + HandshakeRole ServerWithClientAuth + EnvironmentUserInstance 0 + TTLSEnvironmentAdvancedParmsRef ServerEnvironmentAdvParms + TTLSKeyringParmsRef ApimlKeyring +} + +TTLSConnectionAction ApimlServerConnectionAction +{ + HandshakeRole ServerWithClientAuth + TTLSCipherParmsRef CipherParms + TTLSConnectionAdvancedParmsRef ApimlConnectionAdvParms +} +``` + +The `PortRange` of this inbound rule is taken from the list of API Mediation Layer components in the `zowe.yaml` file. The `PortRange` should cover the following components: + +- Gateway: default port 7554 +- Discovery: default port 7553 +- Caching Service: 7555 +- API Catalog: default port 7552 +- Metrics Service: default port 7551 + +Replace `ApimlKeyring` with the keyring configured for your installation. Follow [the SAF keyring instructions](../../getting-started/zowe-certificates-overview.md#saf-keyring) in the article _Zowe Certificates overview_ to configure keyrings for your Zowe instance. + +Note the setting `HandshakeRole`. This setting applies to core services which authenticate through certificates with each other. This setting allows the API Gateway to receive and accept X.509 client certificates from API Clients. + +### Outbound rules + +#### For z/OSMF + +```pagent +TTLSRule ApimlZosmfClientRule +{ + LocalAddr All + LocalPortRange 1024-65535 + RemoteAddr All + RemotePortRange 449 + Jobname ZWEAAG* + Direction Outbound + TTLSGroupActionRef ClientGroupAction + TTLSEnvironmentActionRef ApimlClientEnvironmentAction + TTLSConnectionActionRef ApimlNoX509ClientConnAction +} + +TTLSGroupAction ClientGroupAction +{ + TTLSEnabled ON +} + +TTLSEnvironmentAction ApimlClientEnvironmentAction +{ + HandshakeRole Client + TTLSKeyringParmsRef ApimlKeyring + TTLSCipherParmsRef CipherParms + TTLSEnvironmentAdvancedParmsRef ClientEnvironmentAdvParms +} +``` + +:::note +`Jobname` is defined explicitly for the API Gateway and is formed with the `zowe.job.prefix` setting from `zowe.yaml` plus `AG` as the Gateway identifier. +::: + +#### For communication between API Gateway and other core services + +```pagent +TTLSRule ApimlClientRule +{ + LocalAddr All + LocalPortRange 1024-65535 + RemoteAddr All + RemotePortRange 10310-10320 + Jobname ZWEA* + Direction Outbound + TTLSGroupActionRef ClientGroupAction + TTLSEnvironmentActionRef ApimlClientEnvironmentAction + TTLSConnectionActionRef ApimlX509ClientConnAction +} + +TTLSConnectionAction ApimlX509ClientConnAction +{ + HandshakeRole Client + TTLSCipherParmsRef CipherParms + TTLSConnectionAdvancedParmsRef ApimlClientX509ConnAdvParms +} + +TTLSConnectionAdvancedParms ApimlClientX509ConnAdvParms +{ + ApplicationControlled Off + CertificateLabel Zowe Server + SecondaryMap Off +} +``` + +#### For communication between API Gateway and southbound services + +```pagent +TTLSRule ApimlServiceClientRule +{ + LocalAddr All + LocalPortRange 1024-65535 + RemoteAddr All + RemotePortRange 40030 + Jobname ZWEAAG* + Direction Outbound + TTLSGroupActionRef ClientGroupAction + TTLSEnvironmentActionRef ApimlClientEnvironmentAction + TTLSConnectionActionRef ApimlNoX509ClientConnAction +} + +TTLSConnectionAction ApimlNoX509ClientConnAction +{ + HandshakeRole Client + TTLSCipherParmsRef CipherParms + TTLSConnectionAdvancedParmsRef ApimlClientNoX509ConnAdvParms +} + +TTLSConnectionAdvancedParms ApimlClientNoX509ConnAdvParms +{ + ApplicationControlled Off + SecondaryMap Off +} +``` +:::important +- The outbound connection from the Gateway Service to the Discovery Service must be configured without a `CertificateLabel`. Ensure that the certificate label is not included to avoid sending the certificate in case routing would be possible to the Discovery Service. Note that this route is disabled by default. + +- Outbound connections from the Gateway to southbound services (onboarded services) must not send the server certificate if the service accepts x.509 Client Certificate authentication. If the server certificate is sent, it is the server user who would be authenticated. +::: + +### Ciphers + +:::note +This list of ciphers is provided as an example only. Actual ciphers should be customized according to your specific configuration. +::: + +The list of supported ciphers should be constructed according to the TLS supported versions. +Ensure that the cipher list has matches with non-AT-TLS-aware clients. + +```pagent +TTLSCipherParms CipherParms +{ + V2CipherSuites TLS_RC4_128_WITH_MD5 + V2CipherSuites TLS_RC4_128_EXPORT40_WITH_MD5 + V2CipherSuites TLS_RC2_CBC_128_CBC_WITH_MD5 + V2CipherSuites TLS_RC2_CBC_128_CBC_EXPORT40_WITH_MD5 + V2CipherSuites TLS_RC2_CBC_128_CBC_EXPORT40_WITH_MD5 + V2CipherSuites TLS_DES_192_EDE3_CBC_WITH_MD5 + V3CipherSuites TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 + V3CipherSuites TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 + V3CipherSuites TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + V3CipherSuites TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 + V3CipherSuites TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + V3CipherSuites TLS_AES_128_GCM_SHA256 + V3CipherSuites TLS_AES_256_GCM_SHA384 + V3CipherSuites TLS_CHACHA20_POLY1305_SHA256 +} +``` + +## Using AT-TLS for API ML in High Availability + +AT-TLS settings for a Zowe API Mediation Layer installation configured in High Availability mode do not differ extensively. Changes need to be made to the previously described rules to allow for cross-lpar communication: + +Ensure that the `RemoteAddr` setting in the rules accounts for the following connections: + +- Discovery Service to Discovery Service. This is the replica request. +- Gateway Service to southbound services running in another LPAR. +- Southbound services to Discovery Service. This applies during onboarding. + +## AT-TLS Troubleshooting + +This section describes some common issues when using AT-TLS with API ML and how to resolve these issues. + +### The message `This combination of port requires SSL` is thrown + +Make sure the URL starts with `https://`. This message indicates that AT-TLS rules are in place and it is trying to connect on port 80 to the API Gateway, however the latter is still only listening on the secure port 443. + +**Solution:** +Review settings in the API Gateway. Ensure that the changes described in [AT-TLS configuration for Zowe](#at-tls-configuration-for-zowe) are applied. + +### AT-TLS rules are not applied + +If the application is responding in http, the application may not be properly configured to support http-only calls. AT-TLS is not correctly configured. + +**Solution:** +Ensure the rules are active and that the filters on port range and job names are properly set. + +### Non matching ciphers + +An error can occur if the [list of ciphers](#ciphers) does not match between the ones configured in the AT-TLS rules and the ones used by non AT-TLS-aware clients. + +**Solution:** +Review the supported TLS versions and ciphers used in both the client and the server. diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-authorization.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-authorization.md new file mode 100644 index 0000000000..2ce9c27fed --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-authorization.md @@ -0,0 +1,9 @@ +# Configuring authorization for API ML + +:::info Role: system administrator +::: + +In Zowe's API Mediation Layer, system administrators can limit access to services and information in the API Catalog by hiding sensitive data like service instance URLs, configurable via the apiml.catalog.hide.serviceInfo property in zowe.yaml. Additionally, SAF resource checking for user authorization on specific endpoints is facilitated through various providers, such as Endpoint, Native, and Dummy. These configurations, modifiable in the zowe.yaml file, enhance security by controlling service exposure and ensuring proper authorization checks within the Zowe ecosystem. + +- [Limiting access to information or services in the API Catalog](./configuration-limiting-access-to-info-or-services-in-api-catalog.md) +- [Configuring SAF resource checking](./configuration-saf-resource-checking.md) \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-client-certificates.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-client-certificates.md new file mode 100644 index 0000000000..b238779c38 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-client-certificates.md @@ -0,0 +1,57 @@ +# Enabling single sign on for clients via client certificate configuration + + +:::info Roles: system programmer, system administrator, security administrator +::: + +Use the following procedure to enable the zowe.yaml file to use a client certificate as the method of authentication for the API Mediation Layer Gateway. + +1. Open the `zowe.yaml` configuration file. +2. Configure the following properties: + + * **components.gateway.apiml.security.x509.enabled** + This property is the global feature toggle. Set the value to `true` to enable client certificate functionality. + + * **components.gateway.apiml.security.zosmf.applid** + When z/OSMF is used as an authentication provider, provide a valid `APPLID` to allow for client certificate authentication. The API ML generates a passticket for the specified `APPLID` and subsequently uses this passticket to authenticate to z/OSMF. The default value in the installation of z/OSMF is `IZUDFLT`. + + :::note + The following steps are only required if the ZSS hostname or default Zowe user name are altered: + ::: + +3. Change the following property if user mapping is provided by an external API: + + * **components.gateway.apiml.security.x509.externalMapperUrl** + + :::note + Skip this step if user mapping is not provided by an external API. + ::: + + The API Mediation Gateway uses an external API to map a certificate to the owner in SAF. This property informs the Gateway about the location of this API. ZSS is the default API provider in Zowe. You can provide your own API to perform the mapping. In this case, it is necessary to customize this value. + + The following URL is the default value for Zowe and ZSS: + + ``` + https://${ZWE_haInstance_hostname}:${GATEWAY_PORT}/zss/api/v1/certificate/x509/map + ``` + +4. Add the following property if the Zowe runtime userId is altered from the default `ZWESVUSR`: + +:::note +Skip this step if the Zowe runtime userId is not altered from the default `ZWESVUSR`. +::: + + * **components.gateway.apiml.security.x509.externalMapperUser** + + To authenticate to the mapping API, a JWT is sent with the request. The token represents the user that is configured with this property. The user authorization is required to use the `IRR.RUSERMAP` resource within the `FACILITY` class. The default value is `ZWESVUSR`. Permissions are set up during installation with the `ZWESECUR` JCL or workflow. + + If you customized the `ZWESECUR` JCL or workflow (the customization of zowe runtime user: `// SET ZOWEUSER=ZWESVUSR * userid for Zowe started task`) and changed the default USERID, create the `components.gateway.apiml.security.x509.externalMapperUser` property and set the value by adding a new line as in the following example: + + **Example:** + + ``` + components.gateway.apiml.security.x509.externalMapperUser: yournewuserid + ``` + +5. Restart Zowe. + diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-connection-limits.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-connection-limits.md new file mode 100644 index 0000000000..b3589d72dc --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-connection-limits.md @@ -0,0 +1,38 @@ +# Customizing connection limits + +:::info Role: system programmer +::: + +## TCP/IP Connection Limits + +By default, the API Gateway accepts up to 100 concurrent connections per route, and 1000 total concurrent connections. Any further concurrent requests are queued until the completion of an existing request. The API Gateway is built on top of Apache HTTP components that require these two connection limits for concurrent requests. + +Use the following procedure to change the number of concurrent connections: + +1. Open the file `zowe.yaml`. +2. Find or add the property `zowe.components.gateway.server.maxConnectionsPerRoute` and set the value to an appropriate positive integer. +3. Find or add the property `zowe.components.gateway.server.maxTotalConnections` and set the value to an appropriate positive integer. + +## Websocket Limits + +The API Mediation Layer supports Websocket connections. It is possible to configure the limits around timeouts. All the values are in milliseconds. Customizing this limit may be practical if you see problems such as with the usage of the TN32790 terminal in Virtual Desktop. + +``` +zowe: + components: + gateway: + server: + websocket: + connectTimeout: 15000 + stopTimeout: 30000 + asyncWriteTimeout: 60000 + maxIdleTimeout:3600000 +``` + +Use the following procedure to change the limits: + +1. Open the file `zowe.yaml`. +2. Find or add the property `zowe.components.gateway.server.websocket.connectTimeout`, and set the value to an appropriate positive integer. This timeout limits how long the API Gateway waits until it drops connection if it cannot reach the target server. The default is 15 seconds. +3. Find or add the property `zowe.components.gateway.server.websocket.stopTimeout`, and set the value to an appropriate positive integer. This timeout handles how long the API Gateway waits before it fails on stop message for the Websocket connection. The default is 30 seconds. +4. Find or add the property `zowe.components.gateway.server.websocket.asyncWriteTimeout`, and set the value to an appropriate positive integer. This timeout handles how long it takes before the server fails with unsuccessful response when trying to write message to the Websocket connection. The default is 60 seconds. +5. Find or add the property `zowe.components.gateway.server.websocket.maxIdleTimeout`, and set the value to an appropriate positive integer. This timeout handles how long the Websocket connection remains open if there is no communication happening over the open connection. The default is one hour. diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-cors.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-cors.md new file mode 100644 index 0000000000..96e64c9f87 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-cors.md @@ -0,0 +1,31 @@ +# Customizing Cross-Origin Resource Sharing (CORS) + +:::info Role: system programmer +::: + +As a system programmer, you can enable the Gateway to terminate CORS requests for itself and also for routed services. By default, Cross-Origin Resource Sharing (CORS) handling is disabled for Gateway routes `gateway/api/v1/**` and for individual services. After enabling the feature as stated in the following procedure, API Gateway endpoints start handling CORS requests. Individual services can control whether they want the Gateway to handle CORS for them through the [Custom Metadata](../../extend/extend-apiml/onboard-spring-boot-enabler/#custom-metadata.md) parameters. + +When the Gateway handles CORS on behalf of the service, the Gateway sanitizes the following defined headers from the communication (upstream and downstream) in the following comma -separated list: +``` +Access-Control-Request-Method,Access-Control-Request-Headers,Access-Control-Allow-Origin,Access-Control-Allow-Methods,Access-Control-Allow-Headers,Access-Control-Allow-Credentials,Origin +``` + +The resulting request to the service is not a CORS request. No additional specification of the service is required. The list can be overridden by specifying a different comma-separated list in the property `components.gateway.apiml.service.ignoredHeadersWhenCorsEnabled` in `zowe.yaml`. + +Additionally, the Gateway handles the preflight requests on behalf of the service when CORS is enabled in Custom Metadata, replying with CORS headers: +- `Access-Control-Allow-Methods: GET,HEAD,POST,DELETE,PUT,OPTIONS` +- `Access-Control-Allow-Headers: origin, x-requested-with` +- `Access-Control-Allow-Credentials: true` +- `Access-Control-Allow-Origin: *` + +Alternatively, list the origins as configured by the service, associated with the value **customMetadata.apiml.corsAllowedOrigins** in Custom Metadata. + +If CORS is enabled for Gateway routes but not in Custom Metadata, the Gateway does not set any of the previously listed CORS headers. As such, the Gateway rejects any CORS requests with an origin header for the Gateway routes. + +Use the following procedure to enable CORS handling. + +1. Open the file `zowe.yaml`. +2. Find or add the property `components.gateway.apiml.service.corsEnabled` and set the value to `true`. +3. Restart Zowe. + +Requests through the Gateway now contain a CORS header. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-customizing-java-heap-sizes.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-customizing-java-heap-sizes.md new file mode 100644 index 0000000000..1f167ab8c5 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-customizing-java-heap-sizes.md @@ -0,0 +1,35 @@ +# Customizing Java Heap sizes + +:::info Role: system programmer +::: + +The Zowe API Mediation Layer is a Java-based application. As such, one of the main performance considerations is the size of the Java memory heap, where all objects are stored. +The Java heap size has a direct impact on the available capacity of the applications. Aspects to consider when defining the size are, for example, how many concurrent requests the application should support, and the expected size of average requests. +As a systems programmer, you can customize the available Java memory heap size for API Mediation Layer components. + +By default, all services (Gateway, Discovery, API Catalog, Caching Service) have a Java heap size of 32 MB as the initial size, and a maximum heap size of 512 MB. + +To change the default settings, set `components..heap.init` and `components..heap.max` + +* `component` +Specifies one of the following services: + - `gateway` + - `discovery` + - `caching-service` + - `api-catalog` + +**Example with Gateway Service:** + +```yaml +components: + gateway: + heap: + init: 1024 + max: 1024 +``` + +The unit is megabytes and cannot be changed. The new values are 1 GB. + +## Recommendation + +It is recommended to have a fixed heap size in a production environment. diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-customizing-management-of-apiml-load-limits.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-customizing-management-of-apiml-load-limits.md new file mode 100644 index 0000000000..a2808c0e6a --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-customizing-management-of-apiml-load-limits.md @@ -0,0 +1,15 @@ +# Customizing management of API ML load limits + +:::info Role: system programmer +::: + +As a system programmer, you can customize your configuration for how API ML manages both northbound and southbound load limits in single instances: + + * To change the number of concurrent connections per route passing through the API Gateway, see [Customizing connection limits](./configuration-connection-limits.md). + + * To change the global Gateway timeout value for the API ML instance, see [Customizing Gateway timeouts](./configuration-gateway-timeouts.md). + + * Also see the following properties in API Gateway configuration parameters: + * `server.maxTotalConnections` + * `server.maxConnectionsPerRoute` + diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-customizing-the-api-catalog-ui.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-customizing-the-api-catalog-ui.md new file mode 100644 index 0000000000..e411f822ce --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-customizing-the-api-catalog-ui.md @@ -0,0 +1,87 @@ +# Customizing the API Catalog UI + +:::info Role: system administrator +::: + +As a system administrator, you can customize the API Catalog UI to have a similar interface to your organization's service, or with your existing visualization portal. + +* To customize the logotype and selected syle options in the zowe.yaml file, see [API Catalog branding](#api-catalog-branding). +* To replace or remove the API Catolog service from the Gateway home page and health checks, see [Replace or remove the Catalog with another service](../api-mediation/configuration-customizing-the-api-catalog-ui/#replace-or-remove-the-catalog-with-another-service). + +## API Catalog branding + +It is possible to customize the logotype and selected style options directly in `zowe.yaml`. + +1. Open the file `zowe.yaml`. +2. Configure the following properties by setting them under `ZWE_configs_apiml_catalog_customStyles`: + + - **logo** + Specifies the location of the logo that will replace the default Zowe logo in the API Catalog header. The supported image formats are: `svg`, `png` and `jpg/jpeg`. + - **titlesColor** + Specifies the title color. + - **fontFamily** + Specifies the font family to use across the API Catalog. + - **headerColor** + Specifies the HTML color of the header element in the API Catalog home page + - **backgroundColor** + Specifies the HTML color of the main background across the API Catalog + - **textColor** + Specifies the HTML color of the main text across the API Catalog + - **docLink** + Specifies a custom link to be displayed in the header. Use this property to refer to applicable documentation. The format is `|` + **Example:** `docLink: Custom Documentation|https://somedoc.com` + + Follow this example to define this parameter globally. + + **Example:** + + ```yaml + configs: + apiml: + catalog: + customStyles: + logo: /path/to/logo.png + titlesColor: #F7190E + fontFamily: Roboto + headerColor: grey + backgroundColor: #FFFFFF + textColor: blue + docLink: Custom Documentation|https://somedoc.com + ``` + + Properties in the example that are not set default to Zowe API Catalog css values. +3. Restart Zowe. + +## Replace or remove the Catalog with another service + +By default, the API Mediation Layer contains the API Catalog as a service showing available services. As the API Mediation Layer can be successfully run without this component it is possible to replace or remove the service from the Gateway home page and health checks. The following section describes the behavior of the Gateway home page and health checks. + +The default option displays the API Catalog. + +A value can also be applied to `components.gateway.apiml.catalog.serviceId`. + +**Examples:** + +- **none** +Nothing is displayed on the Gateway home page and the Catalog is removed from `/application/health` + +- **alternative-catalog** +An alternative to the API Catalog is displayed + +- **metrics-dashboard** + A possible dashboard that could appear in place of the API Catalog + +:::note Notes: +- If the application contains the `homePageUrl` and `statusPageRelativeUrl`, then the full set of information is displayed. +- If the application contains the `homePageUrl` the link is displayed without the `UP` information. +- If the application contains the `statusPageRelativeUrl` then `UP` or `DOWN` is displayed based on the `statusPage` without the link. +::: + +Use the following procedure to change or replace the Catalog service. + +1. Open the file `zowe.yaml`. +2. Find or add the property `components.gateway.apiml.catalog.serviceId`. Set the value with the following options: + + - Set the value to `none` to remove the Catalog service. + - Set the value to the ID of the service that is onboarded to the API Mediation Layer. +3. Restart Zowe. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-distributed-load-balancer-cache.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-distributed-load-balancer-cache.md new file mode 100644 index 0000000000..1a19517c58 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-distributed-load-balancer-cache.md @@ -0,0 +1,12 @@ +# Distributing the load balancer cache + +:::info Role: system programmer +::: + +You can choose to distribute the load balancer cache between instances of the API Gateway. To distribute the load balancer cache, it is necessary that the caching service is running. Gateway service instances are reuqired to have the same DN (Distinguished name) on the server certificate. This may be relevant for the HA setups. + +Use the following procedure to distribute the load balancer cache between instances of the API Gateway. + +1. Open the file `zowe.yaml`. +2. Find or add the property with value `components.gateway.apiml.loadBalancer.distribute: true`. +3. Restart Zowe. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-enable-single-sign-on-extenders.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-enable-single-sign-on-extenders.md new file mode 100644 index 0000000000..80a15d418b --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-enable-single-sign-on-extenders.md @@ -0,0 +1,12 @@ +# Enabling single sign on for extending services + +:::info Roles: system programmer, API service extender +::: + +Enabling Single Sign On (SSO) in Zowe involves configuring JWT tokens or PassTickets for secure authentication. The JWT token configuration requires setting up a custom HTTP header to store the token, thereby enhancing secure communication with southbound services. + +For more information, see [Enabling single sign on for extending services via JWT token configuration](./configuration-extender-jwt.md). + +PassTicket configuration, alternatively, allows services that do not natively support JWT tokens or client certificates to authenticate via the API Gateway. This authentication process requires the activation of PassTicket support, recording the APPLID, and configuring the Zowe started task user ID. Additionally, custom HTTP headers can be set up for PassTickets and user IDs, ensuring secure and streamlined access within the Zowe ecosystem. + +For more information, see [Enabling single sign on for extending services via PassTicket configuration](./configuration-extender-passtickets.md). \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-extender-jwt.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-extender-jwt.md new file mode 100644 index 0000000000..416c035edf --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-extender-jwt.md @@ -0,0 +1,17 @@ +# Enabling single sign on for extending services via JWT token configuration + +:::info Role: system programmer +::: + +## Adding a custom HTTP Auth header to store Zowe JWT token + +If a southbound service needs to consume the Zowe JWT token from an HTTP request header to participate in the Zowe SSO, you can define a custom HTTP header name as part of the Gateway configuration. +The southbound service must use the `zoweJwt` scheme in order to leverage this functionality. Once the HTTP header name is defined, each request to the southbound service contains the JWT token in the custom header. + +Use the following procedure to add the custom HTTP header. + +1. Open the file `zowe.yaml`. +2. Find or add the property `components.gateway.apiml.security.auth.jwt.customAuthHeader` and set the value which represents the header's name. +3. Restart Zowe. + +Requests through the Gateway towards the southbound service now contain the custom HTTP header with the JWT token. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-extender-passtickets.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-extender-passtickets.md new file mode 100644 index 0000000000..2f1f2e5f3c --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-extender-passtickets.md @@ -0,0 +1,111 @@ +# Enabling single sign on for extending services via PassTicket configuration + +As a system programmer, follow the procedures described in this article to configure Zowe to use PassTickets, and to enable Zowe to use PassTickets to authenticate towards specific extending services. + +:::info Roles: system programmer, security administrator +::: + +## Configuring Zowe to use PassTickets + +As system programmer, you can configure Zowe to use PassTickets for API services that are compatible to accept them to authenticate your service with the API Mediation Layer. + +### Overview of how PassTickets are used +API clients can use various supported methods such as Zowe JWT token or client certificate to access an API service even if the API service itself does not support the JWT token or client certificate. + +When an API client provides a valid authentication method to the API ML, the API Gateway then generates a valid PassTicket for any API service that supports PassTickets. +The API Gateway then uses the PassTicket to access that API service. +The API Gateway provides the user ID and password in the Authorization header of the HTTP requests using the +[Basic authentication scheme](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#Basic_authentication_scheme). + +- [Enabling PassTicket support](#enabling-passticket-support) +- [Security configuration that allows the Zowe API Gateway to generate PassTickets for an API service](#security-configuration-that-allows-the-zowe-api-gateway-to-generate-passtickets-for-an-api-service) + + - [ACF2](#acf2) + - [Top Secret](#top-secret) + - [RACF](#racf) + +### Enabling PassTicket support + +The following steps outline the procedure for enabling PassTicket Support: + +1. Follow the API service documentation that explains how to activate support for PassTickets. + + **Note:** PassTickets for the API service must have the replay protection switched off. + + **Example:** `APPLDATA('NO REPLAY PROTECTION') + + The PassTickets are exchanged between Zowe API Gateway and the API service in a secure mainframe environment. + +2. Record the value of the APPLID of the API service. +3. Enable the Zowe started task user ID to generate PassTickets for the API service. Grant `UPDATE` access to the Zowe started task by submitting commands in one of the three ESMs: ACF2, Top Secret, or RACF. +4. Enable PassTicket support in the API Gateway for your API service. + +### Security configuration that allows the Zowe API Gateway to generate PassTickets for an API service + +Consult with your security administrator to issue security commands to allow the Zowe started task user ID to generate PassTickets for the API service. + +Use the following variables to generate PassTickets for the API service to enable the Zowe started task user ID: + +- **``** +The APPLID value used by the API service for PassTicket support (e.g. `OMVSAPPL`) + +- **``** +The Zowe started task user ID used during the Zowe installation + +In the following examples of ESM configuration, replace these variables with actual values. + +Use the the configuration format in the following examples that corresponds to your ESM. + +#### ACF2 + +Grant the Zowe started task user ID permission to generate PassTickets for users of that API service. +The following code is an example of security commands that need to be issued. + +**Example:** + +```markup +ACF +SET RESOURCE(PTK) +RECKEY IRRPTAUTH ADD(.- UID() SERVICE(UPDATE,READ) ALLOW) +F ACF2,REBUILD(PTK),CLASS(P) +END +``` + +#### Top Secret + +Grant the Zowe started task user ID permission to generate PassTickets for users of that API service. + +**Example:** + +```markup +TSS PERMIT() PTKTDATA(IRRPTAUTH..) ACCESS(READ,UPDATE) +TSS REFRESH +``` + +#### RACF + +To enable PassTicket creation for API service users, define the profile `IRRPTAUTH..*` in the `PTKTDATA` class and set the universal access authority to `NONE`. + +Grant the Zowe started task user ID permission to generate PassTickets for users of that API service. + +**Example:** + +```markup +RDEFINE PTKTDATA IRRPTAUTH..* UACC(NONE) +PERMIT IRRPTAUTH..* CL(PTKTDATA) ID() ACCESS(UPDATE) +SETROPTS RACLIST(PTKTDATA) REFRESH +``` + +# Adding custom HTTP Auth headers to store user ID and PassTicket + +If a southbound service needs to consume the PassTicket and the user ID from custom headers to participate in the Zowe SSO, you can define the custom HTTP headers names as part of the Gateway configuration. +The southbound service must use the `httpBasicPassTicket` scheme in order to leverage this functionality. Once the HTTP headers names are defined, each request to the southbound service contains the PassTicket and the user ID in the custom headers. + +Use the following procedure to add the custom HTTP headers. + +1. Open the file `zowe.yaml`. +2. Find or add the property `components.gateway.apiml.security.auth.passticket.customAuthHeader` and set the value which represents the header's name. +3. Find or add the property `components.gateway.apiml.security.auth.passticket.customUserHeader` and set the value which represents the header's name. +4. Restart Zowe. + +Requests through the Gateway towards the southbound service now contain the custom HTTP headers with the PassTicket and the user ID. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-gateway-retry-policy.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-gateway-retry-policy.md new file mode 100644 index 0000000000..614dfb212a --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-gateway-retry-policy.md @@ -0,0 +1,31 @@ +# Customizing Gateway retry policy + +Use the following procedure to change the Gateway retry policy. + +:::info Role: system programmer +::: + +All requests are disabled as the default configuration for retry with one exception: the server retries `GET` requests that finish with status code `503`. + +1. Open the `zowe.yaml` configuration file. +2. Configure the following properties: + + * **components.gateway.ribbon.retryableStatusCodes** +This property provides a list of status codes, for which the server should retry the request. + + **Example:** `components.gateway.ribbon.retryableStatusCodes: "503, 404"` + + * **components.gateway.ribbon.OkToRetryOnAllOperations** +Specifies whether to retry all operations for this service. The default value is `false`. In this case, only `GET` requests are retried if they return a response code that is listed in `ribbon.retryableStatusCodes`. Setting this parameter to `true` enables retry requests for all methods which return a response code listed in `ribbon.retryableStatusCodes`. + +:::note +Enabling retry can impact server resources due to request body buffering. +::: + +* **components.gateway.ribbon.MaxAutoRetries** +Specifies the number of times a failed request is retried on the same server. This number is multiplied with `ribbon.MaxAutoRetriesNextServer`. The default value is `0`. + +* **components.gateway.ribbon.MaxAutoRetriesNextServer** +Specifies the number of additional servers that attempt to make the request. This number excludes the first server. The default value is `5`. + +3. Restart Zowe. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-gateway-timeouts.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-gateway-timeouts.md new file mode 100644 index 0000000000..20da024a14 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-gateway-timeouts.md @@ -0,0 +1,26 @@ +# Customizing Gateway timeouts + +:::info Role: system programmer +::: + +Use the following procedure to change the global timeout value for the API Mediation Layer instance. + +1. Open the file `zowe.yaml`. +2. Configure the following properties: + + * **components.gateway.apiml.gateway.timeoutmillis** + This property defines the global value for http/ws client timeout. + + :::note + Ribbon configures the client that connects to the routed services. + ::: + * **components.gateway.ribbon.connectTimeout** + Specifies the value in milliseconds which corresponds to the period in which API ML should establish a single, non-managed connection with the service. If omitted, the default value specified in the API ML Gateway service configuration is used. + + * **components.gateway.ribbon.readTimeout** + Specifies the time in milliseconds of inactivity between two packets in response from this service to API ML. If omitted, the default value specified in the API ML Gateway service configuration is used. + + * **components.gateway.ribbon.connectionManagerTimeout** + The HttpClient employs a special entity to manage access to HTTP connections called by the HTTP connection manager. The purpose of an HTTP connection manager is to serve as a factory for new HTTP connections, to manage the life cycle of persistent connections, and to synchronize access to persistent connections. Internally, the connections that are managed serve as proxies for real connections. `ConnectionManagerTimeout` specifies a period during which managed connections with API ML should be established. The value is in milliseconds. If omitted, the default value specified in the API ML Gateway service configuration is used. + +3. Restart Zowe. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-jwt.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-jwt.md new file mode 100644 index 0000000000..02caa0cc4d --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-jwt.md @@ -0,0 +1,89 @@ +# Enabling single sign on for clients via JWT token configuration + +:::info Roles: system programmer, system administrator, security administrator +::: + +As a system programmer, you can customize how JWT authentication is performed, the service that provides the JWT authentication token, whether it's possible to refresh JWT token and other characteristics of JWT for consumption. + +* [Using SAF as an authentication provider](#using-saf-as-an-authentication-provider) +* [Enabling a JWT token refresh endpoint](#enabling-a-jwt-token-refresh-endpoint) +* [Authorization](#authorization) +* [Additional customizable properties when using JWT tokens](#additional-customizable-properties-when-using-jwt-tokens) + +## Using SAF as an authentication provider + +By default, the API Gateway uses z/OSMF as an authentication provider. It is possible to switch to SAF as the authentication +provider instead of z/OSMF. The intended usage of SAF as an authentication provider is for systems without z/OSMF. +If SAF is used and the z/OSMF is available on the system, the created tokens are not accepted by z/OSMF. Use +the following procedure to switch to SAF. + +1. Open the `zowe.yaml` configuration file. +2. Find or add the following property, and set the value to `saf`: +``` +components.gateway.apiml.security.auth.provider +``` +3. Restart Zowe. + +Authentication requests now utilize SAF as the authentication provider. API ML can run without z/OSMF present on the system. + +## Enabling a JWT token refresh endpoint + +Enable the `/gateway/api/v1/auth/refresh` endpoint to exchange a valid JWT token for a new token with a new expiration date. Call the endpoint with a valid JWT token and trusted client certificate. When using the z/OSMF authentication provider, enable API Mediation Layer for PassTicket generation and configure the z/OSMF APPLID. + +For more information, see [Configure Passtickets](configuration-extender-passtickets.md). + +1. Open the file `zowe.yaml`. +2. Configure the following properties: + + * **components.gateway.apiml.security.allowtokenrefresh: true** + Add this property to enable the refresh endpoint. + + * **components.gateway.apiml.security.zosmf.applid** + If you use z/OSMF as an authentication provider, provide a valid `APPLID`. The API ML generates a PassTicket for the specified `APPLID` and subsequently uses this PassTicket to authenticate to z/OSMF. The default value in the installation of z/OSMF is `IZUDFLT`. + +:::note + +Problems have been noted with the functionality of the property `components.gateway.apiml.security.allowtokenrefresh`. For more information about the bug, see [issue #3468 in the api-layer repo](https://github.com/zowe/api-layer/issues/3468). + +We recommend you use the following workaround: + +1. Configure the following parameter in `environments`: + +``` +zowe: + environments: + APIML_SECURITY_ALLOWTOKENREFRESH: true +``` +::: + +2. Restart Zowe. + +## Authorization + +Authorization is used to set the access rights of an entity. + +In the API ML, authorization is performed by any of the following z/OS security managers: +* [ACF2](https://www.broadcom.com/products/mainframe/identity-access/acf2) +* [IBM RACF](https://www.ibm.com/support/knowledgecenter/zosbasics/com.ibm.zos.zsecurity/zsecc_042.htm) +* [Top Secret](https://www.broadcom.com/products/mainframe/identity-access/top-secret). + +An authentication token is used as proof of valid authentication. The authorization checks, however, are always performed by the z/OS security manager. + +## Additional customizable properties when using JWT tokens + +You can also customize the following properties when authenticating with a JWT token: + +* **components.gateway.apiml.security.auth.zosmf.ServiceId** + This parameter specifies the z/OSMF service id used as authentication provider. The service id is defined in the static definition of z/OSMF. The default value is `zosmf`. + +* **components.gateway.apiml.security.auth.tokenProperties.expirationInSeconds** + This property is relevant only when the JWT is generated by the API Mediation Layer and specifies to the time before expiration. + + API ML generation of the JWT occurs in the following cases: + + * z/OSMF is only available as an older version which does not support JWT tokens + * The SAF provider is used + + To use a custom configuration for z/OSMF which changes the expiration of the LTPA token, it is necessary to also set the expiration in this parameter. + + diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-limiting-access-to-info-or-services-in-api-catalog.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-limiting-access-to-info-or-services-in-api-catalog.md new file mode 100644 index 0000000000..45ceee7127 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-limiting-access-to-info-or-services-in-api-catalog.md @@ -0,0 +1,57 @@ +# Limiting access to information or services in the API Catalog + +:::info Role: system administrator +::: + +As a system administrator, you can limit access to information and/or services available within the API Catalog and through the API Mediation Layer and check for the authorization of the user on certain endpoints. + +Choose from the following use cases: + + +* Use the property `apiml.catalog.hide.serviceInfo` to hide the instance URL value of all services registered to the API ML in the API Catalog. + + See the section [Hide service information](#hide-service-information). + +* The API ML can check for the authorization of the user on certain endpoints. Access to a SAF resource is checked via an External Security Manager (ESM). + + See the article [SAF Resource Checking](./configuration-saf-resource-checking.md). + +## Hide service information + +1. Open the file `zowe.yaml`. +2. Configure the following properties: + + * **apiml.catalog.hide.serviceInfo** + + This parameter is used to hide the instance URL value of all services registered to the API ML in the API Catalog. This customization can be useful when the service owner does not want to expose sensitive information such as the hostname. + + Set the value of the `*apiml.catalog.hide.serviceInfo` parameter to `true` to hide the instance URL for all services registered to the API Catalog. + + In your Zowe YAML configuration (typically `zowe.yaml`), set this parameter by defining `configs.apiml.catalog.hide.serviceInfo`. + + Follow this example to define this parameter globally. + + **Example:** + + ```yaml + configs: + apiml: + catalog: + hide: + serviceInfo: true + ``` + + An alternative is to define this parameter only for a high availability instance on lpar1. + + **Example:** + + ```yaml + haInstances: + lpar1: + configs: + apiml: + catalog: + hide: + serviceInfo: true + ``` +3. Restart Zowe. diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-multi-tenancy-routing.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-multi-tenancy-routing.md new file mode 100644 index 0000000000..a9db5054e1 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-multi-tenancy-routing.md @@ -0,0 +1,30 @@ +# Configuring routing in a multi-tenant environment + +In addition to the domain-specific Discovery Service, which is typically in the same LPAR, in a multi-sysplex environment, the API Gateway may also need to register with a Central Discovery Service which gathers information about all installed API Gateways +in isolated sysplex environments. Data from the Central Discovery Service can then be used by the Central Gateway for routing to individual API Gateways. + +Follow these steps to register with additional Discovery Services: + +1. Open the `zowe.yaml` configuration file. +2. Add the property `components.gateway.apiml.service.additionalRegistration` and set the value to a list of Discovery service clusters to additional Disovery Services. + + **Example:** + ``` + components.gateway.apiml.service.additionalRegistration: + + - discoveryServiceUrls: https://sys1:10011/eureka/,https://sys1:10021/eureka/ + routes: + gatewayUrl: / + serviceUrl: / + + - discoveryServiceUrls: https://sys2:10011/eureka/,https://sys2:10021/eureka/ + routes: + gatewayUrl: / + serviceUrl: / + + - discoveryServiceUrls: https://sys3:10011/eureka/,https://sys3:10021/eureka/ + routes: + gatewayUrl: / + serviceUrl: / + ``` +3. Restart Zowe. diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-personal-access-token.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-personal-access-token.md new file mode 100644 index 0000000000..55474f4cf2 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-personal-access-token.md @@ -0,0 +1,13 @@ +# Enabling single sign on for clients via personal access token configuration + + +:::info Roles: system programmer, system administrator, security administrator +::: + +Use the following procedure to enable personal access tokens. + +1. Open the file `zowe.yaml`. +2. Find or add the property with the value `components.gateway.apiml.security.personalAccessToken.enabled: true`. +3. Restart Zowe. + +For more information about using personal access tokens, see [Authenticating with a Personal Access Token](./authenticating-with-personal-access-token.md). \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-routing.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-routing.md new file mode 100644 index 0000000000..f153cfde01 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-routing.md @@ -0,0 +1,38 @@ +# Customizing routing behavior + +:::info Roles: system programmer, system administrator, security administrator +::: + +The Zowe API Mediation Layer offers a range of routing configurations for enhanced functionality and security. + +You can customize your configuration for how API ML manages both northbound and southbound load limits in single instances, including changing the number of concurrent connections per route passing through the API Gateway, and changing the global Gateway timeout value for the API ML instance. + +To change the number of concurrent connections per route passing through the API Gateway, see [Customizing connection limits](./configuration-connection-limits.md). + +To change the global Gateway timeout value for the API ML instance, see [Customizing Gateway timeouts](./configuration-gateway-timeouts.md). + +Also see the following properties in API Gateway configuration parameters: +* `server.maxTotalConnections` +* `server.maxConnectionsPerRoute` + +Customizing CORS enables the Gateway to handle Cross-Origin Resource Sharing requests, while settings for encoded slashes and unique cookie names cater to specific operational needs of onboarding applications and multiple Zowe instances. + +For more information, see [Customizing Cross-Origin Resource Sharing (CORS)](./configuration-cors.md) + +To onboard applications which expose endpoints that expect encoded slashes, see [Using encoded slashes](./configuration-url-handling.md) + +The Gateway retry policy, customizable through zowe.yaml, optimizes request handling, which can be especially useful in high availability scenarios. + +To customize the Gateway retry policy, see [Customizing Gateway retry policy](./configuration-gateway-retry-policy.md). + +Additionally, API ML supports specific instance access and load balancer cache distribution, improving service identification and scalability. These configurations, including service ID adjustments for compatibility with Zowe v2, demonstrate Zowe's adaptability and robustness in API management. + +To configure a unique cookie name for each instance to prevent overwriting of the default cookie name in the case of multiple Zowe instances, or for more complex deployment strategies, see [Configuring a unique cookie name for a specific API ML instance](./configuration-unique-cookie-name-for-multiple-zowe-instances.md). + +To determine which service instance is being called, you can customize the Gateway to output a routed instance header. For more information, see [Retrieving a specific service within your environment](./configuration-access-specific-instance-of-service.md). + +To distribute the load balancer cache between instances of the API Gateway, see [Distributing the load balancer cache](./configuration-distributed-load-balancer-cache.md). + +To modify the service ID to ensure compatibility of services that use a non-conformant organization prefix with Zowe v2, see [Setting a consistent service ID](./configuration-set-consistent-service-id.md). + + diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-saf-resource-checking.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-saf-resource-checking.md new file mode 100644 index 0000000000..e94b50a7bc --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-saf-resource-checking.md @@ -0,0 +1,107 @@ +# Configuring SAF resource checking + +:::info Roles: system programmer, system administrator, security administrator +::: +You can use various SAF resource providers depending on your use case to handle the SAF authorization check. Follow the procedure in this article that applies to your specific configuration use case. + +## SAF Resource Checking Providers + +API ML can check for the authorization of the user on certain endpoints. Access to a SAF resource is checked with ESM. + +Verification of the SAF resource is provided by the following three providers: + +- **`endpoint`** +This is the highest priority provider, such as a REST endpoint call (ZSS or similar one). This option is disabled by default. In Zowe, ZSS has the API to check for SAF resource authorization. + +- **`native`** +The Native JZOS classes from Java are used to determine SAF resource access. This is the default provider. + +- **`dummy`** +This is the lowest priority provider. This is the dummy implementation and is defined in a file. + +:::note +Verification of the SAF resource uses the first available provider based on the specified priority. The default configuration resolves to the native provider. +::: + +You can select a specific provider by specifying the `components.gateway.apiml.security.authorization.provider` key in the `zowe.yaml` file. Use the parameter value to +strictly define a provider. If verification is disabled, select the `endpoint` option. + +1. Open the file `zowe.yaml`. +2. Find or add the property `components.gateway.apiml.security.authorization.provider` and set desired value. +3. Restart Zowe. + +**Examples:** +``` +components.gateway.apiml.security.authorization.endpoint.url: endpoint +``` + +To configure the `endpoint` provider, add the following additional property: +`components.gateway.apiml.security.authorization.endpoint.enabled: true` + +`components.gateway.apiml.security.authorization.provider: native` + +`components.gateway.apiml.security.authorization.provider: dummy` + + +To use the endpoint provider, customize the URL corresponding to the SAF resource authorization. By default, the ZSS API is configured and used. + +1. Open the file `zowe.yaml`. +2. Find or add the property `components.gateway.apiml.security.authorization.endpoint.url` and set desired value. + The default value for ZSS API is `https://${ZWE_haInstance_hostname}:${GATEWAY_PORT}/zss/api/v1/saf-auth` +3. Restart Zowe. + +## REST endpoint call + +The REST provider calls the external API to retrieve information about access rights. To enable the feature outside of the mainframe, such as when running in Docker, you can use a REST endpoint call using the `GET` method: + +- Method: `GET` +- URL: `{base path}/{userId}/{class}/{entity}/{level}` +- Response: +```json5 + { + "authorized": "{true|false}", + "error": "{true|false}", + "message": "{message}" + } +``` +:::note +For more information about this REST endpoint call, see [ZSS implementation](https://github.com/zowe/zss/blob/master/c/authService.c). +::: + +### Native + +The Native provider is the easiest approach to use the SAF resource checking feature on the mainframe. + +Enable this provider when classes `com.ibm.os390.security.PlatformAccessControl` and `com.ibm.os390.security.PlatformReturned` +are available on the classpath. This approach uses the following method described in the IBM documentation: [method](https://www.ibm.com/support/knowledgecenter/SSYKE2_8.0.0/com.ibm.java.zsecurity.api.80.doc/com.ibm.os390.security/com/ibm/os390/security/PlatformAccessControl.html?view=kc#checkPermission-java.lang.String-java.lang.String-java.lang.String-int-). + +:::note +Ensure that the version of Java on your system has the same version of classes and method signatures. +::: + +### Dummy implementation + +Use the Dummy provider for testing purpose outside of the mainframe. + +Create the file `saf.yml` and locate it in the folder, where is application running or create file `mock-saf.yml` in the +test module (root folder). The highest priority is to read the file outside of the JAR. A file (inner or outside) has to exist. + +The following YAML presents the structure of the file: + +```yaml + safAccess: + {CLASS}: + {RESOURCE}: + - {UserID} +``` + +:::note Notes +- Classes and resources are mapped into a map, user IDs into a list. +- The load method does not support formatting with dots, such as shown in the following example: + **Example:** `{CLASS}.{RESOURCE}` + Ensure that each element is separated. +- The field `safAccess` is not required to define an empty file without a definition. +- Classes and resources cannot be defined without the user ID list. +- When a user has multiple definitions of the same class and resource, only the most privileged access level loads. + + diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-set-consistent-service-id.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-set-consistent-service-id.md new file mode 100644 index 0000000000..59f962b5ac --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-set-consistent-service-id.md @@ -0,0 +1,11 @@ +# Setting a consistent service ID + +:::info Role: API service extender +::: + +As an API service extender you can modify the service ID to ensure compatibility of services that use a non-conformant organization prefix with Zowe v2. + +For more information, see the following parameter in the article Discovery Service configuration parameters: + +* **components.discovery.apiml.discovery.serviceIdPrefixReplacer** + This parameter is used to modify the service ID of a service instance, before it registers to API ML. Using this parameter ensures compatibility of services that use a non-conformant organization prefix with v2, based on Zowe v2 conformance. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-single-sign-on-user.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-single-sign-on-user.md new file mode 100644 index 0000000000..e61e9ee7db --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-single-sign-on-user.md @@ -0,0 +1,18 @@ +# Enabling single sign on for clients + +:::info Roles: system programmer, system administrator, security administrator +::: + +As a system programmer or system administrator, you can customize the way API ML handles authentication towards clients such as CLI and/or users. Each of the following methods limits the frequency the user is reqired to enter credentials to access API Mediation Layer: + +* One method to minimize the frequency of re-entering credentials is via Gateway client certificate authentication, whereby you can use a client certificate as the method of authentication for the API Mediation Layer Gateway. + + For more information, see [Enabling single sign on for clients via client certificate configuration](./configuration-client-certificates.md) + +* Another method to minimize the frequency of entering credentials is to use API Mediation Layer to generate, validate, and invalidate a Personal Access Token (PAT). This method enables access to tools such as VCS without having to use credentials of a specific person. The use of PAT does not require storing mainframe credentials as part of the automation configuration on a server during application development on z/OS. + + For more information, see [Enabling single sign on for clients via personal access token configuration](./configuration-personal-access-token.md). + + * Minimizing re-entering user credentials can also be performed via the JWT token refresh endpoint. Enabling the refresh endpoint allows you to exchange a valid JWT token for a new token with a new expiration date. + + For more information, see [Enabling single sign on for clients via JWT token configuration](./configuration-jwt.md). diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-unique-cookie-name-for-multiple-zowe-instances.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-unique-cookie-name-for-multiple-zowe-instances.md new file mode 100644 index 0000000000..f704fdc04a --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-unique-cookie-name-for-multiple-zowe-instances.md @@ -0,0 +1,18 @@ +# Configuring a unique cookie name for a specific API ML instance + +:::info Role: system programmer +::: + +By default, in the API Gateway, the cookie name is `apimlAuthenticationToken`. +To prevent overwriting of the default cookie name in the case of multiple Zowe instances, a unique cookie name can be configured for each instance. + +Follow this procedure to configure a unique cookie name for the instances: + +1. Open the `zowe.yaml` configuration file. +2. Find or add the property `components.gateway.apiml.security.auth.uniqueCookie`, and set it to `true`. A unique cookie name is generated as `apimlAuthenticationToken.cookieIdentifier`. + + **Example:** + If this parameter is set to `true`, and the cookieIdentifier is `1`, the name of the cookie transforms to `apimlAuthenticationToken.1`. + If this property is not set to `true`, the cookie name remains `apimlAuthenticationToken` by default. + +3. Restart Zowe. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-url-handling.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-url-handling.md new file mode 100644 index 0000000000..61cb745ed1 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/configuration-url-handling.md @@ -0,0 +1,14 @@ +# Using encoded slashes + +:::info Role: system programmer +::: + +By default, the API Mediation Layer accepts encoded slashes in the URL path of the request. If you are onboarding applications which expose endpoints that expect encoded slashes, it is necessary to keep the default configuration. We recommend that you change the property to `false` if you do not expect the applications to use the encoded slashes. + +Use the following procedure to reject encoded slashes. + +1. Open the file `zowe.yaml`. +2. Find or add the property `components.gateway.apiml.service.allowEncodedSlashes` and set the value to `false`. +3. Restart Zowe. + +Requests with encoded slashes are now rejected by the API Mediation Layer. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/API-Catalog-Tile.png b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/API-Catalog-Tile.png new file mode 100644 index 0000000000..66acdbac5e Binary files /dev/null and b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/API-Catalog-Tile.png differ diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/Expanded-Catalog-Tile.png b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/Expanded-Catalog-Tile.png new file mode 100644 index 0000000000..f1788e34c1 Binary files /dev/null and b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/Expanded-Catalog-Tile.png differ diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/Service-Status.png b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/Service-Status.png new file mode 100644 index 0000000000..d88ce18f6e Binary files /dev/null and b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/Service-Status.png differ diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/Service-detail.png b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/Service-detail.png new file mode 100644 index 0000000000..8b0f16b222 Binary files /dev/null and b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/Service-detail.png differ diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/cntrlr-detail.PNG b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/cntrlr-detail.PNG new file mode 100644 index 0000000000..d7daf9b04b Binary files /dev/null and b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/cntrlr-detail.PNG differ diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/endpoint-detail.PNG b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/endpoint-detail.PNG new file mode 100644 index 0000000000..89d0bad5a7 Binary files /dev/null and b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/endpoint-detail.PNG differ diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/green-check.jpg b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/green-check.jpg new file mode 100644 index 0000000000..1ebb8d8619 Binary files /dev/null and b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/green-check.jpg differ diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/image2018-2-26 14_53_46.png b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/image2018-2-26 14_53_46.png new file mode 100644 index 0000000000..856267cd5c Binary files /dev/null and b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/image2018-2-26 14_53_46.png differ diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/rest-api-components-sample.plantuml b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/rest-api-components-sample.plantuml new file mode 100644 index 0000000000..50d94af635 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/rest-api-components-sample.plantuml @@ -0,0 +1,29 @@ + +@startuml rest-api-components-sample + +skinparam rectangle { + roundCorner<> 25 + BackgroundColor<> LightBlue + BackgroundColor<> PaleGreen +} + +rectangle gateway [ +API Gateway +=== +/api/v2/petstore +] + +rectangle petstore <> { + rectangle petstore_api_v2 <> [ + /v2 + == + /pets + ] +} + +note right of gateway: API Gateway routes\nHTTP requests to /v2 of the API in the petstore service +note bottom of petstore: The petstore service provides one API (/v2)\nThis service runs in its own embedded web server + +gateway --> petstore_api_v2 + +@enduml \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/rest-api-components-sample.svg b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/rest-api-components-sample.svg new file mode 100644 index 0000000000..b5b41f9f00 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/rest-api-components-sample.svg @@ -0,0 +1,39 @@ +«Service»petstore«API»/v2/petsAPI Gateway/api/v2/petstoreAPI Gateway routesHTTP requests to /v2 of the API in the petstore serviceThe petstore service provides one API (/v2)This service runs in its own embedded web server \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/rest-api-components.plantuml b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/rest-api-components.plantuml new file mode 100644 index 0000000000..83e8287fdf --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/rest-api-components.plantuml @@ -0,0 +1,67 @@ +@startuml rest-api-components + +skinparam rectangle { + roundCorner<> 25 + BackgroundColor<> LightBlue + BackgroundColor<> PaleGreen +} + +rectangle gateway [ +API Gateway +=== +/api/v1/service1 +/api/v2/service1 +--- +/api/v2/service2 +--- +/api/v1/service3 +] + +rectangle service1 <> { + rectangle api1v1 <> [ + /v1 + == + /endpoint1 + /endpoint2 + ] +} + +node "Web Application Server" as server { + rectangle service3 <> { + rectangle api3v1 <> [ + /v1 + == + /endpoint1 + /endpoint2 + ] + } + + rectangle service2 <> { + rectangle api2v2 <> [ + /v2 + == + /endpoint1 + /endpoint2 + ] + + rectangle api2v1 <> [ + /v1 + == + /endpoint1 + /endpoint2 + ] + } + +} + +note bottom of server: A web server can host\none or more API services +note bottom of service1: A service usually provides one API\n\nA service can run\nin its own embedded web server +note bottom of service2: A service can provide\nmultiple versions of a REST API +note right of gateway: API Gateway routes\nHTTP requests to REST APIs + +gateway --> api1v1 +gateway --> api2v1 +gateway --> api2v2 +gateway --> api3v1 + +@enduml \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/rest-api-components.svg b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/rest-api-components.svg new file mode 100644 index 0000000000..80a33f936f --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/rest-api-components.svg @@ -0,0 +1,78 @@ +«Service»service1Web Application Server«Service»service3«Service»service2«API»/v1/endpoint1/endpoint2«API»/v1/endpoint1/endpoint2«API»/v2/endpoint1/endpoint2«API»/v1/endpoint1/endpoint2API Gateway/api/v1/service1/api/v2/service1/api/v2/service2/api/v1/service3A web server can hostone or more API servicesA service usually provides one APIA service can runin its own embedded web serverA service can providemultiple versions of a REST APIAPI Gateway routesHTTP requests to REST APIs \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/service-detail-info.PNG b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/service-detail-info.PNG new file mode 100644 index 0000000000..c62472664d Binary files /dev/null and b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/service-detail-info.PNG differ diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/service-relationship-diagram.png b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/service-relationship-diagram.png new file mode 100644 index 0000000000..ddf6741773 Binary files /dev/null and b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/service-relationship-diagram.png differ diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/x-graphic.jpg b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/x-graphic.jpg new file mode 100644 index 0000000000..b2a72f6c03 Binary files /dev/null and b/versioned_docs/version-v2.15.x/user-guide/api-mediation/diagrams/x-graphic.jpg differ diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/discovery-service-configuration.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/discovery-service-configuration.md new file mode 100644 index 0000000000..e5b50218e9 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/discovery-service-configuration.md @@ -0,0 +1,78 @@ +# Discovery Service configuration parameters + +## Zowe runtime configuration parameters + +As an application developer who wants to run Zowe, set the following parameters during the Zowe runtime configuration by modifying the `/components/discovery/bin/start.sh` file: + +* **[API ML configuration](#api-ml-configuration)** + +## API ML configuration + +**Follow these steps:** + +1. Open the file `zowe.yaml`. +2. Configure the following properties: + +* **apiml.service.hostname** + + This property is used to set the Discovery Service hostname. The value can be set by defining the `ZWE_haInstance_hostname` property in the `zowe.yaml` file. + +* **apiml.service.port** + + This property is used to set the Discovery Service port. The value can be set by defining the `ZWE_configs_port` property in the `zowe.yaml` file. + +* **apiml.discovery.staticApiDefinitionsDirectories** + + The value of `apiml.discovery.staticApiDefinitionsDirectories` can be set by defining the `ZWE_STATIC_DEFINITIONS_DIR` property in `zowe.yaml`. The static definition directories can be specified as a parameter at startup and will be scanned by the Discovery Service. These directories contain the definitions of static services. + **Example:** + ```yaml + ZWE_STATIC_DEFINITIONS_DIR: config/local/api-defs;config/local2/api-defs + ``` +* **apiml.discovery.allPeersUrls** + + The value of `apiml.discovery.allPeersUrls` can be set by defining the `ZWE_DISCOVERY_SERVICES_LIST` property in `zowe.yaml`. + This parameter contains the list of URLs of the Discovery Service in case of multiple instances of the service on different host. + **Example:** + ```yaml + ZWE_DISCOVERY_SERVICES_LIST: https://localhost2:10021/eureka/,https://localhost3:10031/eureka/ + ``` + **Note:** Each URL within the list must be separated by a comma.The directories can be specified as a parameter at startup and will be scanned by the Discovery Service. These directories contain the definitions of static services. + +* **components.discovery.apiml.security.ssl.verifySslCertificatesOfServices** + + This parameter makes it possible to prevent server certificate validation. + + **Important!** Ensure that this parameter is set to `true` in production environments. + Setting this parameter to `false` in production environments significantly degrades the overall security of the system. + +* **components.discovery.apiml.discovery.serviceIdPrefixReplacer** + + This parameter is used to modify the service ID of a service instance, before it registers to API ML. + Using this parameter ensures compatibility of services that use a non-conformant organization prefix with v2, based on Zowe v2 conformance. + The value of the `*apiml.discovery.serviceIdPrefixReplacer` parameter is represented as a tuple that contains two strings, separated by a comma. The format of this parameter contains the following two elements: + * First, the prefix that you want to replace in the service ID + * Second, the new prefix that will be replaced + + **Example:** + The value of the parameter has the following format: `oldServiceIdPrefix,newServiceIdPrefix` + + Set this parameter in your Zowe YAML configuration (typically `zowe.yaml`) by defining `configs.apiml.discovery.serviceIdPrefixReplacer`. For example, defining it globally: + + ```yaml + configs: + apiml: + discovery: + serviceIdPrefixReplacer: ca*,bcm + ``` + Or defining it only for lpar1 high availability instance: + + ```yaml + haInstances: + lpar1: + configs: + apiml: + discovery: + serviceIdPrefixReplacer: ca*,bcm + ``` + +3. Restart Zowe&trade. \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/routing-requests-to-rest-apis.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/routing-requests-to-rest-apis.md new file mode 100644 index 0000000000..ac3f0b9c08 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/routing-requests-to-rest-apis.md @@ -0,0 +1,117 @@ +# Routing requests to REST APIs + +API consumers can access any services onboarded to the API Mediation Layer through a single port. In this context, 'service' refers to one or more instances that share the same API and are onboarded under the same service Id. Some services provide versioned APIs, while other services provide an unversioned API. From the consumer side, the API Mediation Layer takes care of situations in which one instance is down and/or ditributing the load between different instances of a service. + +Types of services include both versioned and nonversioned services: + +* **Versioned services** +Routing with serviceId and version + +* **Nonversioned services** +Using only the service Id + +Under certain conditions it is possible to route to a specific instance of service. + +## Terminology + +* **Service** + + * A service provides one or more APIs, and is identified by a service ID. Note that sometimes the term "service name" is used to mean the service ID. + * The default service ID is provided by the service developer in the service configuration file. + * A system administrator can replace the service ID with a deployment environment specific name using additional configuration that is external to the service deployment unit. Most often, configuration is performed in a JAR or WAR file. + * Services are deployed using one or more service instances, which share the same service ID and implementation. + +* **URI (Uniform Resource Identifier)** + + The URI is a string of characters used to identify a resource. Each URI must point to a single corresponding resource that does not require any additional information, such as HTTP headers. + +## Basic Routing + +The basic method of routing is based on the service ID. For services that have multiple versions of an API, the secondary parameter is the version of the API that the user wants to reach. + +### API ML Routing to the Versioned service + +The URI identifies the resource, but does not identify the instance of the service as unique when multiple instances of the same service are provided, such as when a service is running in high-availability (HA) mode. To get to a specific instance, it is necessary to access the instance with a specific API ML configuration and header X-Instance-Id. + +In addition to the basic Zuul routing, the Zowe API Gateway supports versioning in which the user can specify a major version. The Gateway routes a request only to an instance that provides the specified major version of the API. + +* The `/api/` prefix is used for REST APIs. +* The prefix `/ui/` applies to web UIs +* The prefix `/ws/` applies to WebSockets +* The prefix `/graphql/` applies to the GraphQL API + +The URL expected by the API Gateway has the following format: + +`https://{gatewayHost}:{port}/{serviceId}/api/v{majorVersion}/{resource}` + +**Example:** + +The following address shows the original URL of a resource exposed by a service: + +``` +https://service:10015/enablerv1sampleapp/api/v1/samples +``` + +The following address shows the API Gateway URL of the resource: + +``` +https://gateway:10010/enablerv1sampleapp/api/v1/samples +``` + +The following diagram illustrates how basic routing works: + +![Zowe API Mediation basic routing](../../images/api-mediation/Basic-Routing.png) + +### Implementation details for routing + + +## Zowe architecture with high availability enablement on Sysplex + +The following diagram illustrates the difference in locations of Zowe components when deploying Zowe into a Sysplex with high availability enabled as opposed to running all components on a single z/OS system. + +![Zowe Architecture Diagram with High Availability Enablement](../../images/common/zowe-architecture-lpar.png) + +Zowe has a high availability feature built-in. To enable this feature, you can define the `haInstances` section in your YAML configuration file. + +The preceding diagram shows that `ZWESLSTC` started two Zowe instances running on two separate LPARs. These LPARs can be on the same or different sysplexes. + +- The Sysplex distributor port sharing enables the API Gateway 7554 ports to be shared, which makes it possible for incoming requests to be routed to either the gateway on LPAR A or LPAR B. +- The discovery servers on each LPAR communicate with each other and share their registered instances, which allows the API Gateway on LPAR A to dispatch APIs to components either on its own LPAR, or alternatively to components on LPAR B. As indicated in the diagram, each component has two input lines: one from the API Gateway on its own LPAR, and one from the Gateway on the other LPAR. When one of the LPARs goes down, the other LPAR remains operating within the sysplex thereby providing high availability to clients that connect through the shared port irrespective of which Zowe instance is serving the API requests. + +The `zowe.yaml` file can be configured to start Zowe instances on more than two LPARS, and also to start more than one Zowe instance on a single LPAR, thereby providing a grid cluster of Zowe components that can meet availability and scalability requirements. + +The configuration entries of each LPAR in the `zowe.yaml` file control which components are started. This configuration mechanism makes it possible to start just the desktop and API Mediation Layer on the first LPAR, and start all of the Zowe components on the second LPAR. Because the desktop on the first LPAR is available to the gateway of the second LPAR, all desktop traffic is routed to the second LPAR. + +The caching services for each Zowe instance, whether on the same LPAR, or distributed across the sysplex, are connected to each other by the same shared VSAM data set. This arrangement allows state sharing so that each instance behaves similarly to the user irrespective of where their request is routed. + +For simplification of the diagram above, the Jobs and Files API servers are not shown as being started. If the user defines Jobs and Files API servers to be started in the `zowe.yaml` configuration file, these servers behave the same as the servers illustrated. In other words, these services register to their API discovery server which then communicates with other discovery servers on other Zowe instances on either the same or other LPARs. The API traffic received by any API gateway on any Zowe instance is routed to any of the Jobs or Files API components that are available. + +To learn more about Zowe with high availability enablement, see [Configuring Sysplex for high availability](../configure-sysplex). + +## API Versioning + +Service instances provide one or more different API versions. This is based on the assumption that one service instance will not provide two versions with the same major version. No assumptions are made regarding which versions will be provided and how. As such, an instance can provide only one version and another +version will be provided by a different instance, and other services can have instances that provide multiple versions. + +The API user specifies only the major version in the URI. The API Catalog needs to differentiate between different _full versions_ internally and be able to return a specific full version or return documentation for the highest version of the specified major version that is supported by all running services. + +### Guidelines + +- The version of the API is not dependent on the product release. + +- Two last versions are supported. + + - **Major version** + This version is specified by the user of the API in the URI, and increased only when a backward incompatible change is introduced. This circumstance is rare because the REST APIs should be designed to allow extensibility. + + - **Minor version** + This version is not specified in the URI but the user should know what is it. It is important to display the correct level of documentation. The minor version is increased when the API is extended with a new feature (if you use a new resource available in v1.2, the request fails on v1.1). If there are multiple instances of the services that have different minor versions, the service together will state that the lowest minor version is available. + + **Example:** + + Instance A provide v1.3 and v2.2. Instance B was not yet upgraded and provides v1.2 and v2.1. Subsequently, the service provides v1.2 and v2.1. + + - **Patch version** + The Patch version is not specified in the URI and does not indicate a difference in the API. A patch version is used only when the API documentation is patched or a bug was fixed with no change in the API. + + ![API Versioning](../../images/api-mediation/API-Versioning.png) diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/upgrade-zowe-no-downtime.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/upgrade-zowe-no-downtime.md new file mode 100644 index 0000000000..b9d4d3445f --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/upgrade-zowe-no-downtime.md @@ -0,0 +1,120 @@ +# Upgrade Zowe server-side components in high availability + +As a systems programmer, it is necessary to upgrade Zowe server-side components regularly to ensure that you are using the latest features and the latest security patches. + +This article describes the requirements and procedure to perform an upgrade of a Zowe server-side components installation in high availability mode to a newer minor version with zero downtime. + +## Installation assumptions + +Review the following assumptions about the installation before you start the upgrade process. Other settings are supported with adapted instructions. + +- Zowe is installed in a single shared zFS. +- Zowe is configured in high availability mode with a sysplex distributor and two instances (A and B). +- The upgraded instance is intended to replace one of the existing instances. (For the purposes of this procedure the replaced instance is instance B.) +- Instances A and B run the same Zowe version. + +## Limitations + +There is a known limitation with balancing traffic between different versions of the UI components, in particular regarding the API Catalog. +Only one API Catalog instance can be active in an installation with multiple maintainance levels. + +## Pre-requisites before installation upgrade with HA + +When upgrading an installation in high availability mode, one or more instances run at different maintainance levels. As such, a few restrictions apply: + +- HA settings are the same across both installations. +- Each instance has its own configuration file (e.g. `zowe.yaml` file), and the HA and security settings are synchronized. +- Onboarded services must also be in high availability mode. + +## Upgrading installation with HA + +Upgrading installation to use high availability mode involves two general steps: + +1. Install a new Zowe instance with the upgraded version. +2. Switch traffic to the new instance to avoid downtime. + +### Installing a new Zowe instance + +Use the following procedure to install a new Zowe instance: + +1. Use one of the supported installation methods to perform a separate installation of the new version of Zowe. For more information about supported installation methods, see the [Installation roadmap](../install-zos.md). + + **Note:** When performing a separate installation of Zowe, ensure that datasets, STCs definitions, and the USS installation directory are distinct from the original installation. + +2. Replicate the configuration of instance A into instance B. + + The settings across both instances must be the same, except for properties pointing to datasets and z/OS USS filesystems which are now separated. + + Ensure that the following properties are different between instances: + + ```yaml + zowe.setup.datasets + zowe.setup.security + zowe.runtimeDirectory + zowe.logDirectory + zowe.workspaceDirectory + zowe.job + ``` + +3. Choose which instance you intend to run the UI services (API Catalog, Zowe Desktop), and disable these mentioned components in the other instance: + + ```yaml + api-catalog: + enabled: false + + app-server: + enabled: false + ``` + +You configured your installation for the two instances. + +### Switching traffic + +Switching traffic without incurring downtime involves the following general steps. Details of these steps are described later in this section. + +1. Disable an application instance (`QUIESCE`) from the DVIPA of the sysplex distributor. +2. Stop this original instance. +3. Start the new instance. +4. Verify service replication. +5. Resume traffic to the instance. + +**Note:** Only new connections can be re-routed to avoid the instance shutting down. A decision needs to be made on long-lived connections, such as long running requests and Web Socket sessions. These connections cannot be re-routed. As such, these connections are closed when the instance is stopped. + +1. Verify access by running the `VARY` command. `CONTROL` access to the `MVS.VARY.TCPIP.SYSPLEX` profile is required. +For more information, see the article _VARY TCPIP,,SYSPLEX_ in the IBM documentation. + +2. In the MVS console, run the `VARY TCPIP` MVS command to place instance B in quiescing mode. + + **Example:** + + ```mvs + VARY TCPIP,,SYSPLEX,QUIESCE,PORT= + ``` + +3. Stop instance B. + +4. Start the upgraded instance. + + **Note:** For more information about stopping and starting instances, see [Starting and stopping Zowe](./../start-zowe-zos.md). + +5. Wait until instance B is up and synchronized with instance A, wherein services are registered in all Discovery Services. To verify that instance B is up and sychronized with instance A, check the following accessibility conditions: + + - Access to API Gateway through the LPAR URL is possible. + - Access to the Discovery Service homepage in both instance A and instance B to compare registered services. + +6. Resume connections from Sysplex Distributor to instance B by running the `VARY TCPIP` MVS command in the MVS console. + + **Example:** + + ```mvs + VARY TCPIP,,SYSPLEX,RESUME,PORT= + ``` + +Successful completion of these steps enables Zowe to run in high availability mode, whereby traffic is balanced between instances running in different maintainance levels. + +### Verifying the new connection + +Use the following checks to verify Zowe is running correctly with the new configuration: + +- Verify that Discovery Services contain all of the registered services from both instances. +- Check that the API Gateway home page shows the number of instances running simultaneously. diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/use-graphql-api.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/use-graphql-api.md new file mode 100644 index 0000000000..f0c7f9d429 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/use-graphql-api.md @@ -0,0 +1,76 @@ +# Using GraphQL APIs + +GraphQL is a query language for APIs that provides descriptions of the data in your APIs, and allows for specific queries to facilitate API development. Routing for such APIs is possible within the Zowe ecosystem, however at the present time, Zowe itself does not provide any GraphQL APIs. + +For more information about configuring routing to API ML, see the following articles: +* [Implementing routing to the Gateway](../../extend/extend-apiml/implementing-routing-to-the-api-gateway) +* [Routing Requests to REST API](./routing-requests-to-rest-apis) + +:::tip +* For information about how to use GraphQL, see [GraphQL Best Practices](https://graphql.org/learn/best-practices/) in the GraphQL product documentation. + +* For information about how to use HTTP to deliver the GraphQL interface, see [Serving over HTTP](https://graphql.org/learn/serving-over-http/) in the GraphQL product documentation. +::: + +## Difference between GraphQL APIs and traditional REST APIs + +REST APIs operate on the principle of resource-based endpoints. Each endpoint in a REST API corresponds to a specific resource (like a user or product), and the type of request (`GET`, `POST`, `PUT`, `DELETE`) dictates the operation performed on that resource. This approach leads to a straightforward and uniform interface but often results in the over-fetching or under-fetching of data. Over-fetching occurs when the fixed data structure of an endpoint returns more information than the client needs, while under-fetching happens when the client must make additional requests to gather all the necessary data. Additionally, REST APIs rely heavily on HTTP status codes for error handling and utilize standard HTTP methods for caching and statelessness. + +By contrast, GraphQL offers a more flexible and efficient way of working with data. Unlike REST, which uses multiple endpoints, GraphQL uses a single endpoint through which clients can make versatile queries. These queries are tailored to retrieve exactly the data required, eliminating over-fetching and under-fetching issues inherent in REST. GraphQL's strongly typed system, defined by a schema, ensures that the data conforms to a specific structure, providing a contract between the server and client. This approach simplifies data retrieval for complex, nested data and allows for more precise error handling within the responses. However, GraphQL's flexibility can lead to more complex queries and demands careful consideration regarding performance, especially in designing how queries are resolved on the server side. + +## Routing to GraphQL example + +The following routing example applies only to services extending API ML that provide GraphQL APIs. + +Use the following format to map to a GraphQL API: + +**Example:** + + routes: + - gatewayUrl: "api/v1/graphql" + serviceUrl: "/graphql" + +In this example, the service has a service ID of `helloworldservice` that exposes the following endpoints: + +* **GraphQL** `https://gateway/helloworldservice/api/v1/graphql` routed to `https://hwServiceHost:port/graphql/` + +where: + +* The gatewayUrl is matched against the prefix of the URL path used at the Gateway `https://gateway/urlPath` + * `urlPath` is `serviceId/prefix/resourcePath`. +* The service ID is used to find the service host and port. +* The `serviceUrl` is used to prefix the `resourcePath` at the service host. + +:::note +The service ID is not included in the routing metadata. Instead, the service ID is in the basic Eureka metadata. +::: + +![Alt text](../../images/api-mediation/graphql-image.png) + +## How GraphQL Works + +GraphQL operates through the type system you define for your data and uses the following structure: + +- **Schema Definition** +Define a 'schema' or a model of the data that can be queried through the API. This schema acts as a contract between the client and the server. +- **Query** +Clients send queries to your GraphQL server. These queries specify what data the client needs. +- **Resolving Queries** +The server processes these queries according to the schema and returns the appropriate results. + +## Key Concepts of GraphQL + +- **Queries and Mutations** +In GraphQL, queries are used for reading data, while mutations are used for writing data. This clear separation makes understanding and maintaining the API simpler. +- **Real-time Data with Subscriptions** +GraphQL supports subscriptions, which allow clients to subscribe to real-time updates, essential for dynamic content applications. +- **Strongly Typed** +GraphQL APIs are strongly typed so that every operation is checked and validated against the schema, leading to more reliable and predictable APIs. + +## Limitations for the API Mediation Layer + +The documentation for the GraphQL is not provided via the standard OpenAPI protocol, but rather, for the most part are living as a sandbox environment within the GraphQL applications. + +:::tip +The API Catalog currently does not support visualization of GraphQL APIs. As such, we recommend that extenders provide a link to the GraphQL endpoint via the Open API for the API Catalog. +::: \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/using-api-mediation-layer.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/using-api-mediation-layer.md new file mode 100644 index 0000000000..467211c671 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/using-api-mediation-layer.md @@ -0,0 +1,73 @@ +# Using API Mediation Layer + +There are numerous ways you can use the API Mediation Layer. Review this topic and its child pages to learn more about the various ways to use the API Mediation Layer. +For information about the API versioning, see [API Catalog and Versioning](../../extend/extend-apiml/api-mediation-versioning.md). + +**Tip:** +For testing purposes, it is not necessary to set up certificates when configuring the API Mediation Layer. You can configure Zowe without certificate setup and run Zowe with `verify_certificates: DISABLED`. + +For production environments, certificates are required. Ensure that certificates for each of the following services are issued by the Certificate Authority (CA) and that all keyrings contain the public part of the certificate for the relevant CA. + +* z/OSMF +* Zowe +* The service that is onboarding to Zowe + +## API Mediation Layer Use Cases + +There are two primary use cases for using the API ML: + +* To access APIs which have already been onboarded to the Mediation Layer via the API Catalog, and leverage their associated Swagger documentation and code snippets. +* To onboard a REST API service to the API ML to contribute to the Zowe community. + +See the following topics for detailed information about how to use the API Mediation Layer: + +### Using Single Sign On (SSO) + +Three authentication methods can be used with single sign on: + +* [Authenticating with a JWT token](../authenticating-with-jwt-token) +* [Authenticating with client certificates](../authenticating-with-client-certificates) +* [Authenticating with a Personal Access Token](./authenticating-with-personal-access-token) + +### Using multi-factor authentication + +User identity verification can be performed by using multi-factor authentication. For more information, see [Using multi-factor authentication (MFA)](./using-multi-factor-authentication). + +### API Routing + +Various routing options can be used for APIs when using API Mediation Layer: + +* [Routing requests to REST APIs](./routing-requests-to-rest-apis) +* [Routing with WebSickets](../routing-with-websockets) +* [Using GraphQL APIs](use-graphql-api) +* [Routing MultiTenancy Configuration](./api-mediation-multi-tenancy) + +### Learning more about APIs + +API Mediation Layer makes it possible to view API information is a variety of ways: + +* [Obtaining information about API Services](../obtaining-information-about-api-services) +* [Using Swagger "Try it out" in the API Catalog](../api-mediation-swagger-try-it-out) +* [Using Swagger Code Snippets in the API Catalog](../api-mediation-swagger-code-snippets) + +### Administrating APIs + +* [Using Static API services refresh in the API Catalog](../api-mediation-static-api-refresh) +* [Onboarding a REST API service with the YAML Wizard](../onboard-wizard) + +### Using the Caching Service + +As an API developer, you can use the Caching Service as a storage solution to enable resource sharing between service instances, thereby ensuring High Availability of services. For details, see [Using the Caching service](./api-mediation-caching-service). + +### Using API Catalog + +There are various options for using the API Catalog: + +* [Viewing Service Information abd API Documentation in the API Catalog](../api-mediation-view-service-information-and-api-doc) +* [Changing an expired password via API Catalog](../api-mediation-change-password-via-catalog) + +### Additional use case when usig API Mediation Layer + +* [Using Metrics Service (Technical Preview)](../api-mediation-metrics-service) +* [SMF records](./api-mediation-smf) + diff --git a/versioned_docs/version-v2.15.x/user-guide/api-mediation/using-multi-factor-authentication.md b/versioned_docs/version-v2.15.x/user-guide/api-mediation/using-multi-factor-authentication.md new file mode 100644 index 0000000000..021216d115 --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/api-mediation/using-multi-factor-authentication.md @@ -0,0 +1,50 @@ +# Using multi-factor authentication (MFA) + +Zowe offers the option to use multi-factor authentication (MFA) systems, which require users to provide multiple authentication factors during logon to verify the user's identity. When using multi-factor authentication, it is necessary that each authentication factor be from a separate category of credential types. While multi-factor authentication is supported by Zowe, there are limitations for this feature to function properly. This topic explains the limitations of using MFA in Zowe and recommendations to address these limitations. + +The Zowe API Mediation Layer, Zowe App Framework, and all apps present in the SMP/E or convenience builds support out-of-band MFA. Users are required to enter an MFA assigned token or passcode into the password field of the Desktop login screen or authentication to the API Catalog. + +Alternatively, a user can access one of the authentication endpoints such as `/gateway/auth/login` within the API Mediation Layer or via App-servers `/auth` REST API endpoint. + +When using MFA with Zowe CLI or the API ML Catalog, users are required to log in with their mainframe user name and MFA token. + +## Prerequisite + +If you use z/OSMF as your authentication provider, ensure that you meet the following prerequisite to use MFA with Zowe CLI or API ML Catalog: + +* z/OSMF APAR for MFA must be installed on the system. For more information, see [this APAR](https://www.ibm.com/support/pages/apar/PH39582) in IBM Support. + +## Known Limitations and Recommendations + +### Unintentional Reuse of MFA Token + +When z/OSMF is used as a security provider, it is possible to reuse MFA tokens, whereby it is possible to receive a JWT token based on previously used MFA token. This presents a security risk. + +This issue can be resolved by configuring z/OSMF to work properly with API ML. +Update the z/OSMF configuration with the following parameter: +`allowBasicAuthLookup="false"` + +After applying this change, each authentication call results in generating a new JWT. +For more information, see [Configuring z/OSMF](../systemrequirements-zosmf.md) to properly work with API ML, and [Multi-factor authentication configuration](../mvd-configuration.md#multi-factor-authentication-configuration) in Configuring Zowe Application Framework. + +### No Notification when Additional Input is Required + +Neither Zowe CLI nor API Catalog issue a notification when a user is required to provide additional input. This can occur in cases such as when a user signon attempt triggers the requirements of a **New Pin** or **Next Token**. The user must resolve this situation outside of Zowe. Depending on the current authentication factor enabled (RSA SecurID or RADIUS), the user can use TSO console or MFA Self-service facilities. + +We recommend you first try to access self-service facilities and resolve the issue there. If you are unable to access your self-service facilities, contact your system administrator. + +:::tip Tips: +* For more information about how to manage multi-factor authentication credentials in AAM, see [Manage Multi-Factor Authentication Credentials (IBM RACF)](https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-advanced-authentication-mainframe/2-0/using-with-ibm-racf/manage-multi-factor-authentication-credentials-ibm-racf.html) in the Advanced Authentication Mainframe 2.0 Broadcom documentation. +* For more information about how to manage multi-factor authentication credentials in IBM Z MFA, see +[IBM Z Multi-Factor Authentication](https://www.ibm.com/products/ibm-multifactor-authentication-for-zos). +* Additionally, Zowe API ML can be configured to accept OIDC/OAuth2 user authentication tokens. In this particular case, MFA support is built into the OIDC provider system. This support alternative does not rely on the mainframe MFA technology, but is equally secure. +* For more information about how to resolve the RADIUS Access Challenge, see the sub-topic _RADIUS Access Challenge Considerations_ in the article [Manage Multi-Factor Authentication Credentials (IBM RACF)](https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-advanced-authentication-mainframe/2-0/using-with-ibm-racf/manage-multi-factor-authentication-credentials-ibm-racf.html). +::: + +### Token Expiration when Stored in the Authorization Dialog in "Try it out" + +When using the API Catalog, you have the option to use the "Try it out" functionality to test a protected endpoint. In this case, you are given the option to provide and store MFA credentials in the Authorization dialog. As the MFA token has a short lifetime, we do not recommend storing your MFA token when using this feature. + +You can, however, continue to use your credentials in the Authorization dialog when you set a fixed password, rather than using an MFA token. Alternatively, you can store your credentials in the Authorization dialog if your account is configured to bypass MFA mode. In this case, authentication is performed through the mainframe credentials of the user. + + diff --git a/versioned_docs/version-v2.15.x/user-guide/assign-security-permissions-to-users.md b/versioned_docs/version-v2.15.x/user-guide/assign-security-permissions-to-users.md new file mode 100644 index 0000000000..20323ddaac --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/assign-security-permissions-to-users.md @@ -0,0 +1,100 @@ +# Assigning security permissions to users + +Assign users (ZWESVUSR and ZWESIUSR) and the ZWEADMIN security group permissions required to perform specific tasks. Each TSO user ID that logs on to Zowe and uses Zowe services that use z/OSMF requires permission to access these z/OSMF services. + +:::info Required roles: security administrator +::: + +### Overview of user categories and roles + +Specific user IDs with sufficient permissions are required to run or access Zowe. +Your organization's security administrator is responsible to assign the following user IDs during Zowe z/OS component +configuration. + +The following user IDs run Zowe: + +* **ZWESVUSR** + This is the started task ID of the Zowe runtime user who runs most of the Zowe core + components. + To work with USS, this user ID must have a valid OMVS segment. For more information about OMVS segments, see the + article _The OMVS segment in user profiles_ in the IBM documentation. For detailed information about which permissions + are + required to run Zowe core services as well as specific individual components, see + the [Security Permissions Reference Table](#security-permissions-reference-table) in this article. +* **ZWESIUSR** + This user runs the cross memory server (ZIS). This is a started task ID used to run the PROCLIB `ZWESISTC` that + launches the [cross memory server (ZIS)](./configure-xmem-server.md). This started task ID must have a valid OMVS + segment. + +The security administrator also assigns permissions to the security group **ZWEADMIN**. `ZWEADMIN` is a group +consisting of `ZWESVUSR` and `ZWESIUSR`. This group must have a valid OMVS segment. + +Additionally, the security administrator assigns permissions to individual Zowe users. If z/OSMF is used for +authentication and serving REST APIs for Zowe CLI and Zowe Explorer users, the TSO user ID for end users must belong to +one or both of the groups `IZUUSER` or `IZUADMIN`. + +## Security Permissions Reference Table + +The following reference table describes which permissions are required for the user ID `ZWESVUSR` to run Zowe core +services and specific individual components. + +If you already successfully ran +the [`ZWESECUR`](/docs/user-guide/initialize-security-configuration.md#configuring-with-zwesecur-jcl) JCL either +separately or by running +the [`zwe init security`](/docs/user-guide/initialize-security-configuration.md#configuring-with-zwe-init-security-command) +command, you do not need to perform the steps described in this section. The TSO commands to create the user IDs and +groups are executed during the JCL sections of `ZWESECUR`. For more information about the `zwe init security` command, +see [zwe init security](../appendix/zwe_server_command_reference/zwe/init/zwe-init-security.md). + +| Feature of a Zowe server-side component | Resource class | Resource name | Type of access required | Reason | Actions | +|------------------------------------------------------------|----------------|-----------------------------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Core | FACILITY | `BPX.JOBNAME` | READ | Allow z/OS address spaces for unix processes to be renamed for [ease of identification](./configure-zos-system.md#configure-address-space-job-naming). | This parameter permits the Zowe main server to set the job name. Run the command that applies to your ESM.
    • [RACF](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L353)
    • [ACF2](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L586)
    • [Top Secret](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L801) | +| API Mediation Layer certificate mapping | FACILITY | `IRR.RUSERMAP` | READ | **Optional** Allow Zowe to [map an X.509 client certificate to a z/OS identity](./configure-zos-system.md#configure-main-zowe-server-to-use-client-certificate-identity-mapping). | This parameter permits the Zowe main server to use the client certificate mapping service. Run the command that applies to your ESM.
    • [RACF](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L369)
    • [ACF2](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L606)
    • [Top Secret](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L811) | +| API Mediation Layer identity mapping | FACILITY | `IRR.IDIDMAP.QUERY` | READ | **Optional** Allow Zowe to [map a distributed identity to a z/OS identity](./configure-zos-system.md#configure-main-zowe-server-to-use-distributed-identity-mapping). | This parameter permits the Zowe main server to use distributed identity mapping service. Run the command that applies to your ESM.
    • [RACF](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L374)
    • [ACF2](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L611)
    • [Top Secret](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L815) | +| API Mediation Layer SMF records | FACILITY | `IRR.RAUDITX` | READ | **Optional** Allow API Mediation Layer to issue [SMF 83 records](./api-mediation/api-mediation-smf) about activity of Personal Access Tokens. For more information about configuring MFA, see [Multi-Factor Authentication (MFA)](./address-authentication-requirements/#multi-factor-authentication-mfa) | This parameter permits the Zowe main server to cut SMF records. Run the command that applies to your ESM.
    • [RACF](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L381)
    • [ACF2](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L616)
    • [Top Secret](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L820) | +| ZSS (required for API ML certificate and identity mapping) | FACILITY | `BPX.SERVER` + `BPX.DAEMON` | UPDATE | Allow Zowe to run code on behalf of the API requester's TSO user ID. For more information, see [Security Environment Switching](./configure-zos-system.md#configure-security-environment-switching). | This parameter permits the Zowe main server to create a user's security environment. Run the command that applies to your ESM.
    • [RACF](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L333)
    • [ACF2](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L568)
    • [Top Secret](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L784) | +| ZSS (required for API ML certificate and identity mapping) | APPL | `OMVSAPPL` | READ | Allow Zowe to run code on behalf of the API requester's TSO user ID. This permission is also required from a requester's TSO user. You can skip this requirement when the resource `OMVSAPPL` in the `APPL` class is not defined. For more information, see [Security Environment Switching](./configure-zos-system.md#configure-security-environment-switching). | This parameter permits the Zowe main server to run the code on behalf of the user. Run the command that applies to your ESM.
    • [RACF](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L347)
    • [ACF2](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L579)
    • [Top Secret](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L796) | +| ZSS | FACILITY | `IRR.RADMIN.LISTUSER` | READ | Allow Zowe to obtain information about OMVS segment of the user profile using `LISTUSER` TSO command. | This parameter permits the Zowe main server to obtain information about OMVS segment of the user profile. Run the command that applies to your ESM.
    • RACF
    • ACF2
    • Top Secret | +| ZSS | CSFSERV | `Multiple` | READ | Generate symmetric keys using ICSF that is used by [Zowe Desktop cookies](./configure-zos-system.md#configure-an-icsf-cryptographic-services-environment). | The list of IDs to enable include `CSF1TRD` , `CSF1TRC` , `CSF1SKE` , `CSF1SKD`. The full list of IDs is described in the z/OS Cryptographic Services user guide for your z/OS release level: [2.2](https://www.ibm.com/docs/en/zos/2.2.0?topic=ssl-racf-csfserv-resource-requirements), [2.3](https://www.ibm.com/docs/en/zos/2.3.0?topic=ssl-racf-csfserv-resource-requirements), [2.4](https://www.ibm.com/docs/en/zos/2.4.0?topic=ssl-racf-csfserv-resource-requirements) and [2.5](https://www.ibm.com/docs/en/zos/2.5.0?topic=ssl-racf-csfserv-resource-requirements). | | | | | | +| Cross memory server (ZIS) | FACILITY | `ZWES.IS` | READ | Allow Zowe ZWESLSTC processes to access the Zowe ZIS cross memory server. | This parameter permits the Zowe main server to use ZIS cross memory server. Run the command that applies to your ESM.
    • [RACF](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L329)
    • [ACF2](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L560)
    • [Top Secret](https://github.com/zowe/zowe-install-packaging/blob/79527166f34e28c205c5f60bf4b4bb7b630bc6a1/workflows/templates/ZWESECUR.vtl#L780) | + + + +## Granting users permission to access z/OSMF + +Each TSO user ID that logs on to Zowe and uses Zowe services that use z/OSMF requires permission to access these z/OSMF services. It is necessary that every user ID be added to the group with the appropriate z/OSMF privileges, `IZUUSER` or `IZUADMIN` (default). + +:::info Required role: security administrator +::: + +This step is not included in the provided Zowe JCL because it must be done for every TSO user ID who wants to access Zowe's z/OS services. The list of those user IDs will typically be the operators, administrators, developers, or anyone else in the z/OS environment who is logging in to Zowe. + +:::note +You can skip this section if you use Zowe without z/OSMF. Zowe can operate without z/OSMF but services that use z/OSMF REST APIs will not be available, specifically the USS, MVS, and JES Explorers and the Zowe Command Line Interface files, jobs, workflows, tso, and console groups. +::: + +To grant permissions to the user ID to access z/OSMF, issue the command(s) that corresponds to your ESM. + +- If you use RACF, issue the following command: + + ``` + CONNECT (userid) GROUP(IZUUSER) + ``` + +- If you use ACF2, issue the following commands: + + ``` + ACFNRULE TYPE(TGR) KEY(IZUUSER) ADD(UID() ALLOW) + F ACF2,REBUILD(TGR) + ``` + +- If you use Top Secret, issue the following commands: + + ``` + TSS ADD(userid) PROFILE(IZUUSER) + TSS ADD(userid) GROUP(IZUUSRGP) + ``` + +## Next step + +After you complete assigning security permissions, the next step is to [configure certificates](./configure-certificates). \ No newline at end of file diff --git a/versioned_docs/version-v2.15.x/user-guide/authenticating-with-client-certificates.md b/versioned_docs/version-v2.15.x/user-guide/authenticating-with-client-certificates.md new file mode 100644 index 0000000000..ecba893ffc --- /dev/null +++ b/versioned_docs/version-v2.15.x/user-guide/authenticating-with-client-certificates.md @@ -0,0 +1,128 @@ +# Authenticating with client certificates + +:::info Required roles: system administrator, security administrator +::: + +Authentication for integration with API ML can also be performed by the client when the service endpoint is called through the API ML Gateway with client certificates. + +:::tip +There is a limitation with respect to performing authentication using Z Secure Services (ZSS) with ACF2 systems. If you are using ACF2, and are using Zowe v2.14 or a later version, use the recommended internal API ML mapper. +::: + +:::note Notes: +* When calling the login endpoint with basic authentication credentials as well as with client certificate, the basic authentication credentials take precedence and client certificate is ignored. + +* If you are calling a specific endpoint on one of the onboarded services, API Mediation Layer ignores Basic authentication. In this case, the Basic authentication is not part of the authenticated request. +::: + +## How the Gateway resolves authentication + +When sending a request to a service with a client certificate, the Gateway performs the following process to resolve authentication: + +1. The client calls the service endpoint through the API ML Gateway with the client certificate. +2. The client certificate is verified as a valid TLS client certificate against the trusted certificate authorities (CAs) of the Gateway. +3. The public key of the provided client certificate is verified against SAF. SAF subsequently returns a user ID that owns this certificate. As of Zowe version 2.14, the API for API ML can be provided by the internal API ML mapper if the mapper is enabled. Alternatively, you can use Z Secure Services (ZSS) to provide this API for API ML, although we recommend using the internal API ML mapper. +4. The Gateway then performs the login of the mapped user and provides valid authentication to the downstream service. + +:::note Notes: +* Currently, ZSS is the default API that provides this mapping between the public part of the client certificate and SAF user ID. However, the recommended method is to use the internal API ML mapper. For information about the internal API ML mapper, see [Enabling the internal API ML mapper](#enabling-the-internal-api-ml-mapper) described in this article. +* For information about ZSS, see the section Zowe runtime in the [Zowe server-side installation overview](./install-zos.md). +::: + +When sending a request to the login endpoint with a client certificate, the Gateway performs the following process to exchange the client certificate for an authentication token: + +1. The client calls the API ML Gateway login endpoint with the client certificate. +2. The client certificate is verified to ensure this is a valid TLS client certificate against the trusted CAs of the Gateway. +3. The public part of the provided client certificate is verified against SAF. SAF subsequently returns a user ID that owns this certificate. As of Zowe release 2.14, the internal API ML mapper can provide this API for API ML if enabled in the zowe.yaml file. Alternatively, ZSS can provide this API for API ML, with the noted exception when using ACF2. +4. The Gateway then performs the login of the mapped user and returns a valid JWT token. + +:::note +ZSS is currently the default API that provides this mapping between the public part of the client certificate and SAF user ID. Using the internal API ML mapper is, however, the recommended method. +::: + +![Zowe client certificate authentication diagram](../images/api-mediation/zowe-client-cert-auth.png) + +:::tip +For more information, see the Medium blog post [Zowe client certificate authentication](https://medium.com/zowe/zowe-client-certificate-authentication-5f1c7d4d579). +::: + +## Prerequisites when using ZSS + +When using ZSS for authentication, ensure that you satisfy the following prerequisites before you set up client certificate authentication. These prerequsites do not apply when using the internal API ML mapper. + +1. Set the password for the Zowe runtime user. The user is created with the `NOPASSWORD` parameter by the Zowe installer. It is necessary to change this password. + + For RACF, issue the following TSO command: + + `ALTUSER PASSWORD()` + + For other security systems, refer to the documentation for an equivalent command. + +2. Verify that the Zowe runtime user is allowed to log in to z/OSMF. (Check that the user is a member of the default `IZUUSER` group.) + +:::note +Ensure that you have the Issuer certificate imported in the truststore or in the SAF keyring. Alternatively, you can generate these certificates in SAF. +Ensure that the client certificate has the following `Extended Key Usage` metadata: +`OID: 1.3.6.1.5.5.7.3.2` +This metadata can be used for TLS client authentication. +::: + +## Configure your z/OS system to support client certificate authentication + +1. Register the client certificate with the user ID in your ESM. The following commands apply to both the internal API ML mapper and ZSS. + + **Example command in RACF:** + + `RACDCERT ADD() ID() WITHLABEL('